Package io.moov.sdk

Class Sweeps

java.lang.Object

io.moov.sdk.Sweeps

All Implemented Interfaces:

SDKMethodInterfaces.MethodCallCreateSweepConfig, SDKMethodInterfaces.MethodCallGetSweep, SDKMethodInterfaces.MethodCallGetSweepConfig, SDKMethodInterfaces.MethodCallListSweepConfigs, SDKMethodInterfaces.MethodCallListSweeps, SDKMethodInterfaces.MethodCallUpdateSweepConfig

public class Sweeps
extends java.lang.Object
implements SDKMethodInterfaces.MethodCallCreateSweepConfig, SDKMethodInterfaces.MethodCallListSweepConfigs, SDKMethodInterfaces.MethodCallGetSweepConfig, SDKMethodInterfaces.MethodCallUpdateSweepConfig, SDKMethodInterfaces.MethodCallListSweeps, SDKMethodInterfaces.MethodCallGetSweep

Method Summary

Modifier and Type	Method	Description
CreateSweepConfigRequestBuilder	createConfig()	Create a sweep config for a wallet.
CreateSweepConfigResponse	createConfig(java.lang.String accountID, CreateSweepConfig createSweepConfig)	Create a sweep config for a wallet.
CreateSweepConfigResponse	createConfig(java.util.Optional<java.lang.String> xMoovVersion, java.lang.String accountID, CreateSweepConfig createSweepConfig)	Create a sweep config for a wallet.
GetSweepRequestBuilder	get()	Get details on a specific sweep.
GetSweepResponse	get(java.lang.String accountID, java.lang.String walletID, java.lang.String sweepID)	Get details on a specific sweep.
GetSweepResponse	get(java.util.Optional<java.lang.String> xMoovVersion, java.lang.String accountID, java.lang.String walletID, java.lang.String sweepID)	Get details on a specific sweep.
GetSweepConfigRequestBuilder	getConfig()	Get a sweep config associated with a wallet.
GetSweepConfigResponse	getConfig(java.lang.String accountID, java.lang.String sweepConfigID)	Get a sweep config associated with a wallet.
GetSweepConfigResponse	getConfig(java.util.Optional<java.lang.String> xMoovVersion, java.lang.String accountID, java.lang.String sweepConfigID)	Get a sweep config associated with a wallet.
ListSweepsRequestBuilder	list()	List sweeps associated with a wallet.
ListSweepsResponse	list(ListSweepsRequest request)	List sweeps associated with a wallet.
ListSweepConfigsRequestBuilder	listConfigs()	List sweep configs associated with an account.
ListSweepConfigsResponse	listConfigs(java.lang.String accountID)	List sweep configs associated with an account.
ListSweepConfigsResponse	listConfigs(java.util.Optional<java.lang.String> xMoovVersion, java.lang.String accountID)	List sweep configs associated with an account.
UpdateSweepConfigRequestBuilder	updateConfig()	Update settings on a sweep config.
UpdateSweepConfigResponse	updateConfig(java.lang.String accountID, java.lang.String sweepConfigID, PatchSweepConfig patchSweepConfig)	Update settings on a sweep config.
UpdateSweepConfigResponse	updateConfig(java.util.Optional<java.lang.String> xMoovVersion, java.lang.String accountID, java.lang.String sweepConfigID, PatchSweepConfig patchSweepConfig)	Update settings on a sweep config.

Methods inherited from class java.lang.Object

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

Method Detail

createConfig

public CreateSweepConfigRequestBuilder createConfig()

Create a sweep config for a wallet.

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

Returns:

The call builder

createConfig

public CreateSweepConfigResponse createConfig(java.lang.String accountID,
                                              CreateSweepConfig createSweepConfig)
                                       throws java.lang.Exception

Create a sweep config for a wallet.

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

Parameters:

accountID -

createSweepConfig -

Returns:

The response from the API call

Throws:

java.lang.Exception - if the API call fails

createConfig

public CreateSweepConfigResponse createConfig(java.util.Optional<java.lang.String> xMoovVersion,
                                              java.lang.String accountID,
                                              CreateSweepConfig createSweepConfig)
                                       throws java.lang.Exception

Create a sweep config for a wallet.

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

Specified by:

createConfig in interface SDKMethodInterfaces.MethodCallCreateSweepConfig

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 -

createSweepConfig -

Returns:

The response from the API call

Throws:

java.lang.Exception - if the API call fails

listConfigs

public ListSweepConfigsRequestBuilder listConfigs()

List sweep configs associated with an 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}/wallets.read` scope.

Returns:

The call builder

listConfigs

public ListSweepConfigsResponse listConfigs(java.lang.String accountID)
                                     throws java.lang.Exception

List sweep configs associated with an 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}/wallets.read` scope.

Parameters:

accountID -

Returns:

The response from the API call

Throws:

java.lang.Exception - if the API call fails

listConfigs

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

List sweep configs associated with an 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}/wallets.read` scope.

Specified by:

listConfigs in interface SDKMethodInterfaces.MethodCallListSweepConfigs

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

getConfig

public GetSweepConfigRequestBuilder getConfig()

Get a sweep config associated with a wallet.

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

Returns:

The call builder

getConfig

public GetSweepConfigResponse getConfig(java.lang.String accountID,
                                        java.lang.String sweepConfigID)
                                 throws java.lang.Exception

Get a sweep config associated with a wallet.

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

Parameters:

accountID -

sweepConfigID -

Returns:

The response from the API call

Throws:

java.lang.Exception - if the API call fails

getConfig

public GetSweepConfigResponse getConfig(java.util.Optional<java.lang.String> xMoovVersion,
                                        java.lang.String accountID,
                                        java.lang.String sweepConfigID)
                                 throws java.lang.Exception

Get a sweep config associated with a wallet.

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

Specified by:

getConfig in interface SDKMethodInterfaces.MethodCallGetSweepConfig

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 -

sweepConfigID -

Returns:

The response from the API call

Throws:

java.lang.Exception - if the API call fails

updateConfig

public UpdateSweepConfigRequestBuilder updateConfig()

Update settings on a sweep config.

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

Returns:

The call builder

updateConfig

public UpdateSweepConfigResponse updateConfig(java.lang.String accountID,
                                              java.lang.String sweepConfigID,
                                              PatchSweepConfig patchSweepConfig)
                                       throws java.lang.Exception

Update settings on a sweep config.

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

Parameters:

accountID -

sweepConfigID -

patchSweepConfig -

Returns:

The response from the API call

Throws:

java.lang.Exception - if the API call fails

updateConfig

public UpdateSweepConfigResponse updateConfig(java.util.Optional<java.lang.String> xMoovVersion,
                                              java.lang.String accountID,
                                              java.lang.String sweepConfigID,
                                              PatchSweepConfig patchSweepConfig)
                                       throws java.lang.Exception

Update settings on a sweep config.

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

Specified by:

updateConfig in interface SDKMethodInterfaces.MethodCallUpdateSweepConfig

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 -

sweepConfigID -

patchSweepConfig -

Returns:

The response from the API call

Throws:

java.lang.Exception - if the API call fails

list

public ListSweepsRequestBuilder list()

List sweeps associated with a wallet.

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

Returns:

The call builder

list

public ListSweepsResponse list(ListSweepsRequest request)
                        throws java.lang.Exception

List sweeps associated with a wallet.

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

Specified by:

list in interface SDKMethodInterfaces.MethodCallListSweeps

Parameters:

request - The request object containing all of the parameters for the API call.

Returns:

The response from the API call

Throws:

java.lang.Exception - if the API call fails

get

public GetSweepRequestBuilder get()

Get details on a specific sweep.

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

Returns:

The call builder

get

public GetSweepResponse get(java.lang.String accountID,
                            java.lang.String walletID,
                            java.lang.String sweepID)
                     throws java.lang.Exception

Get details on a specific sweep.

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

Parameters:

accountID -

walletID -

sweepID -

Returns:

The response from the API call

Throws:

java.lang.Exception - if the API call fails

get

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

Get details on a specific sweep.

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

Specified by:

get in interface SDKMethodInterfaces.MethodCallGetSweep

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 -

walletID -

sweepID -

Returns:

The response from the API call

Throws:

java.lang.Exception - if the API call fails