Package io.moov.sdk

Class Capabilities

java.lang.Object

io.moov.sdk.Capabilities

All Implemented Interfaces:

SDKMethodInterfaces.MethodCallDisableCapability, SDKMethodInterfaces.MethodCallGetCapability, SDKMethodInterfaces.MethodCallListCapabilities, SDKMethodInterfaces.MethodCallRequestCapabilities

public class Capabilities
extends java.lang.Object
implements SDKMethodInterfaces.MethodCallListCapabilities, SDKMethodInterfaces.MethodCallRequestCapabilities, SDKMethodInterfaces.MethodCallGetCapability, SDKMethodInterfaces.MethodCallDisableCapability

Method Summary

Modifier and Type	Method	Description
DisableCapabilityRequestBuilder	disable()	Disable a specific capability that an account has requested.
DisableCapabilityResponse	disable(java.lang.String accountID, CapabilityID capabilityID)	Disable a specific capability that an account has requested.
DisableCapabilityResponse	disable(java.util.Optional<java.lang.String> xMoovVersion, java.lang.String accountID, CapabilityID capabilityID)	Disable a specific capability that an account has requested.
GetCapabilityRequestBuilder	get()	Retrieve a specific capability that an account has requested.
GetCapabilityResponse	get(java.lang.String accountID, CapabilityID capabilityID)	Retrieve a specific capability that an account has requested.
GetCapabilityResponse	get(java.util.Optional<java.lang.String> xMoovVersion, java.lang.String accountID, CapabilityID capabilityID)	Retrieve a specific capability that an account has requested.
ListCapabilitiesRequestBuilder	list()	Retrieve all the capabilities an account has requested.
ListCapabilitiesResponse	list(java.lang.String accountID)	Retrieve all the capabilities an account has requested.
ListCapabilitiesResponse	list(java.util.Optional<java.lang.String> xMoovVersion, java.lang.String accountID)	Retrieve all the capabilities an account has requested.
RequestCapabilitiesRequestBuilder	request()	Request capabilities for a specific account.
RequestCapabilitiesResponse	request(java.lang.String accountID, AddCapabilities addCapabilities)	Request capabilities for a specific account.
RequestCapabilitiesResponse	request(java.util.Optional<java.lang.String> xMoovVersion, java.lang.String accountID, AddCapabilities addCapabilities)	Request capabilities for a specific account.

Methods inherited from class java.lang.Object

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

Method Detail

list

public ListCapabilitiesRequestBuilder list()

Retrieve all the capabilities an account has requested.

Read our [capabilities guide](https://docs.moov.io/guides/accounts/capabilities/) to learn more.

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

Returns:

The call builder

list

public ListCapabilitiesResponse list(java.lang.String accountID)
                              throws java.lang.Exception

Retrieve all the capabilities an account has requested.

Read our [capabilities guide](https://docs.moov.io/guides/accounts/capabilities/) to learn more.

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

Parameters:

accountID -

Returns:

The response from the API call

Throws:

java.lang.Exception - if the API call fails

list

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

Retrieve all the capabilities an account has requested.

Read our [capabilities guide](https://docs.moov.io/guides/accounts/capabilities/) to learn more.

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

Specified by:

list in interface SDKMethodInterfaces.MethodCallListCapabilities

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

request

public RequestCapabilitiesRequestBuilder request()

Request capabilities for a specific account. Read our [capabilities guide](https://docs.moov.io/guides/accounts/capabilities/) to learn more.

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

Returns:

The call builder

request

public RequestCapabilitiesResponse request(java.lang.String accountID,
                                           AddCapabilities addCapabilities)
                                    throws java.lang.Exception

Request capabilities for a specific account. Read our [capabilities guide](https://docs.moov.io/guides/accounts/capabilities/) to learn more.

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

Parameters:

accountID -

addCapabilities -

Returns:

The response from the API call

Throws:

java.lang.Exception - if the API call fails

request

public RequestCapabilitiesResponse request(java.util.Optional<java.lang.String> xMoovVersion,
                                           java.lang.String accountID,
                                           AddCapabilities addCapabilities)
                                    throws java.lang.Exception

Request capabilities for a specific account. Read our [capabilities guide](https://docs.moov.io/guides/accounts/capabilities/) to learn more.

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

Specified by:

request in interface SDKMethodInterfaces.MethodCallRequestCapabilities

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 -

addCapabilities -

Returns:

The response from the API call

Throws:

java.lang.Exception - if the API call fails

get

public GetCapabilityRequestBuilder get()

Retrieve a specific capability that an account has requested. Read our [capabilities guide](https://docs.moov.io/guides/accounts/capabilities/) to learn more.

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

Returns:

The call builder

get

public GetCapabilityResponse get(java.lang.String accountID,
                                 CapabilityID capabilityID)
                          throws java.lang.Exception

Retrieve a specific capability that an account has requested. Read our [capabilities guide](https://docs.moov.io/guides/accounts/capabilities/) to learn more.

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

Parameters:

accountID -

capabilityID - Moov account capabilities. The `production-app` capability might appear in your list. This is a read-only capability that Moov requests and uses for account verification purposes. The capability remains active with your account and requires no additional action.

Returns:

The response from the API call

Throws:

java.lang.Exception - if the API call fails

get

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

Retrieve a specific capability that an account has requested. Read our [capabilities guide](https://docs.moov.io/guides/accounts/capabilities/) to learn more.

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

Specified by:

get in interface SDKMethodInterfaces.MethodCallGetCapability

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 -

capabilityID - Moov account capabilities. The `production-app` capability might appear in your list. This is a read-only capability that Moov requests and uses for account verification purposes. The capability remains active with your account and requires no additional action.

Returns:

The response from the API call

Throws:

java.lang.Exception - if the API call fails

disable

public DisableCapabilityRequestBuilder disable()

Disable a specific capability that an account has requested. Read our [capabilities guide](https://docs.moov.io/guides/accounts/capabilities/) to learn more.

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

Returns:

The call builder

disable

public DisableCapabilityResponse disable(java.lang.String accountID,
                                         CapabilityID capabilityID)
                                  throws java.lang.Exception

Disable a specific capability that an account has requested. Read our [capabilities guide](https://docs.moov.io/guides/accounts/capabilities/) to learn more.

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

Parameters:

accountID -

capabilityID - Moov account capabilities. The `production-app` capability might appear in your list. This is a read-only capability that Moov requests and uses for account verification purposes. The capability remains active with your account and requires no additional action.

Returns:

The response from the API call

Throws:

java.lang.Exception - if the API call fails

disable

public DisableCapabilityResponse disable(java.util.Optional<java.lang.String> xMoovVersion,
                                         java.lang.String accountID,
                                         CapabilityID capabilityID)
                                  throws java.lang.Exception

Disable a specific capability that an account has requested. Read our [capabilities guide](https://docs.moov.io/guides/accounts/capabilities/) to learn more.

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

Specified by:

disable in interface SDKMethodInterfaces.MethodCallDisableCapability

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 -

capabilityID - Moov account capabilities. The `production-app` capability might appear in your list. This is a read-only capability that Moov requests and uses for account verification purposes. The capability remains active with your account and requires no additional action.

Returns:

The response from the API call

Throws:

java.lang.Exception - if the API call fails