Package io.moov.sdk

Class Branding

java.lang.Object

io.moov.sdk.Branding

All Implemented Interfaces:

SDKMethodInterfaces.MethodCallCreateBrand, SDKMethodInterfaces.MethodCallGetBrand, SDKMethodInterfaces.MethodCallUpdateBrand, SDKMethodInterfaces.MethodCallUpsertBrand

public class Branding
extends java.lang.Object
implements SDKMethodInterfaces.MethodCallCreateBrand, SDKMethodInterfaces.MethodCallUpsertBrand, SDKMethodInterfaces.MethodCallGetBrand, SDKMethodInterfaces.MethodCallUpdateBrand

Method Summary

Modifier and Type	Method	Description
CreateBrandRequestBuilder	create()	Create brand properties for the specified account.
CreateBrandResponse	create(java.lang.String accountID, BrandProperties brandProperties)	Create brand properties for the specified account.
CreateBrandResponse	create(java.util.Optional<java.lang.String> xMoovVersion, java.lang.String accountID, BrandProperties brandProperties)	Create brand properties for the specified account.
GetBrandRequestBuilder	get()	Get brand properties for the specified account.
GetBrandResponse	get(java.lang.String accountID)	Get brand properties for the specified account.
GetBrandResponse	get(java.util.Optional<java.lang.String> xMoovVersion, java.lang.String accountID)	Get brand properties for the specified account.
UpdateBrandRequestBuilder	update()	Updates the brand properties for the specified account.
UpdateBrandResponse	update(java.lang.String accountID, UpdateBrand updateBrand)	Updates the brand properties for the specified account.
UpdateBrandResponse	update(java.util.Optional<java.lang.String> xMoovVersion, java.lang.String accountID, UpdateBrand updateBrand)	Updates the brand properties for the specified account.
UpsertBrandRequestBuilder	upsert()	Create or replace brand properties for the specified account.
UpsertBrandResponse	upsert(java.lang.String accountID, BrandProperties brandProperties)	Create or replace brand properties for the specified account.
UpsertBrandResponse	upsert(java.util.Optional<java.lang.String> xMoovVersion, java.lang.String accountID, BrandProperties brandProperties)	Create or replace brand properties for the specified account.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

create

public CreateBrandRequestBuilder create()

Create brand properties for the specified account.

To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/) you'll need to specify the `/accounts/{accountID}/branding.write` scope.

Returns:

The call builder

create

public CreateBrandResponse create(java.lang.String accountID,
                                  BrandProperties brandProperties)
                           throws java.lang.Exception

Create brand properties for the specified account.

To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/) you'll need to specify the `/accounts/{accountID}/branding.write` scope.

Parameters:

accountID -

brandProperties -

Returns:

The response from the API call

Throws:

java.lang.Exception - if the API call fails

create

public CreateBrandResponse create(java.util.Optional<java.lang.String> xMoovVersion,
                                  java.lang.String accountID,
                                  BrandProperties brandProperties)
                           throws java.lang.Exception

Create brand properties for the specified account.

To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/) you'll need to specify the `/accounts/{accountID}/branding.write` scope.

Specified by:

create in interface SDKMethodInterfaces.MethodCallCreateBrand

Parameters:

xMoovVersion - Specify an API version. API versioning follows the format `vYYYY.QQ.BB`, where - `YYYY` is the year - `QQ` is the two-digit month for the first month of the quarter (e.g., 01, 04, 07, 10) - `BB` is the build number, starting at `.01`, for subsequent builds in the same quarter. - For example, `v2024.01.00` is the initial release of the first quarter of 2024. The `latest` version represents the most recent development state. It may include breaking changes and should be treated as a beta release.

accountID -

brandProperties -

Returns:

The response from the API call

Throws:

java.lang.Exception - if the API call fails

upsert

public UpsertBrandRequestBuilder upsert()

Create or replace brand properties for the specified account.

To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/) you'll need to specify the `/accounts/{accountID}/branding.write` scope.

Returns:

The call builder

upsert

public UpsertBrandResponse upsert(java.lang.String accountID,
                                  BrandProperties brandProperties)
                           throws java.lang.Exception

Create or replace brand properties for the specified account.

To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/) you'll need to specify the `/accounts/{accountID}/branding.write` scope.

Parameters:

accountID -

brandProperties -

Returns:

The response from the API call

Throws:

java.lang.Exception - if the API call fails

upsert

public UpsertBrandResponse upsert(java.util.Optional<java.lang.String> xMoovVersion,
                                  java.lang.String accountID,
                                  BrandProperties brandProperties)
                           throws java.lang.Exception

Create or replace brand properties for the specified account.

To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/) you'll need to specify the `/accounts/{accountID}/branding.write` scope.

Specified by:

upsert in interface SDKMethodInterfaces.MethodCallUpsertBrand

Parameters:

xMoovVersion - Specify an API version. API versioning follows the format `vYYYY.QQ.BB`, where - `YYYY` is the year - `QQ` is the two-digit month for the first month of the quarter (e.g., 01, 04, 07, 10) - `BB` is the build number, starting at `.01`, for subsequent builds in the same quarter. - For example, `v2024.01.00` is the initial release of the first quarter of 2024. The `latest` version represents the most recent development state. It may include breaking changes and should be treated as a beta release.

accountID -

brandProperties -

Returns:

The response from the API call

Throws:

java.lang.Exception - if the API call fails

get

public GetBrandRequestBuilder get()

Get brand properties for the specified account.

To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/) you'll need to specify the `/accounts/{accountID}/branding.read` scope.

Returns:

The call builder

get

public GetBrandResponse get(java.lang.String accountID)
                     throws java.lang.Exception

Get brand properties for the specified account.

To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/) you'll need to specify the `/accounts/{accountID}/branding.read` scope.

Parameters:

accountID -

Returns:

The response from the API call

Throws:

java.lang.Exception - if the API call fails

get

public GetBrandResponse get(java.util.Optional<java.lang.String> xMoovVersion,
                            java.lang.String accountID)
                     throws java.lang.Exception

Get brand properties for the specified account.

To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/) you'll need to specify the `/accounts/{accountID}/branding.read` scope.

Specified by:

get in interface SDKMethodInterfaces.MethodCallGetBrand

Parameters:

xMoovVersion - Specify an API version. API versioning follows the format `vYYYY.QQ.BB`, where - `YYYY` is the year - `QQ` is the two-digit month for the first month of the quarter (e.g., 01, 04, 07, 10) - `BB` is the build number, starting at `.01`, for subsequent builds in the same quarter. - For example, `v2024.01.00` is the initial release of the first quarter of 2024. The `latest` version represents the most recent development state. It may include breaking changes and should be treated as a beta release.

accountID -

Returns:

The response from the API call

Throws:

java.lang.Exception - if the API call fails

update

public UpdateBrandRequestBuilder update()

Updates the brand properties for the specified account.

To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/) you'll need to specify the `/accounts/{accountID}/branding.write` scope.

Returns:

The call builder

update

public UpdateBrandResponse update(java.lang.String accountID,
                                  UpdateBrand updateBrand)
                           throws java.lang.Exception

Updates the brand properties for the specified account.

To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/) you'll need to specify the `/accounts/{accountID}/branding.write` scope.

Parameters:

accountID -

updateBrand -

Returns:

The response from the API call

Throws:

java.lang.Exception - if the API call fails

update

public UpdateBrandResponse update(java.util.Optional<java.lang.String> xMoovVersion,
                                  java.lang.String accountID,
                                  UpdateBrand updateBrand)
                           throws java.lang.Exception

Updates the brand properties for the specified account.

To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/) you'll need to specify the `/accounts/{accountID}/branding.write` scope.

Specified by:

update in interface SDKMethodInterfaces.MethodCallUpdateBrand

Parameters:

xMoovVersion - Specify an API version. API versioning follows the format `vYYYY.QQ.BB`, where - `YYYY` is the year - `QQ` is the two-digit month for the first month of the quarter (e.g., 01, 04, 07, 10) - `BB` is the build number, starting at `.01`, for subsequent builds in the same quarter. - For example, `v2024.01.00` is the initial release of the first quarter of 2024. The `latest` version represents the most recent development state. It may include breaking changes and should be treated as a beta release.

accountID -

updateBrand -

Returns:

The response from the API call

Throws:

java.lang.Exception - if the API call fails