Package io.moov.sdk

Class AccountTerminalApplications

java.lang.Object

io.moov.sdk.AccountTerminalApplications

All Implemented Interfaces:

SDKMethodInterfaces.MethodCallGetAccountTerminalApplication, SDKMethodInterfaces.MethodCallGetTerminalConfiguration, SDKMethodInterfaces.MethodCallLinkAccountTerminalApplication, SDKMethodInterfaces.MethodCallListAccountTerminalApplications

public class AccountTerminalApplications
extends java.lang.Object
implements SDKMethodInterfaces.MethodCallLinkAccountTerminalApplication, SDKMethodInterfaces.MethodCallListAccountTerminalApplications, SDKMethodInterfaces.MethodCallGetAccountTerminalApplication, SDKMethodInterfaces.MethodCallGetTerminalConfiguration

Method Summary

Modifier and Type	Method	Description
GetAccountTerminalApplicationRequestBuilder	get()	Verifies if a specific Terminal Application is linked to an Account.
GetAccountTerminalApplicationResponse	get(java.lang.String accountID, java.lang.String terminalApplicationID)	Verifies if a specific Terminal Application is linked to an Account.
GetAccountTerminalApplicationResponse	get(java.util.Optional<java.lang.String> xMoovVersion, java.lang.String accountID, java.lang.String terminalApplicationID)	Verifies if a specific Terminal Application is linked to an Account.
GetTerminalConfigurationRequestBuilder	getConfiguration()	Fetch the configuration for a given Terminal Application linked to a specific Account.
GetTerminalConfigurationResponse	getConfiguration(java.lang.String accountID, java.lang.String terminalApplicationID)	Fetch the configuration for a given Terminal Application linked to a specific Account.
GetTerminalConfigurationResponse	getConfiguration(java.util.Optional<java.lang.String> xMoovVersion, java.lang.String accountID, java.lang.String terminalApplicationID)	Fetch the configuration for a given Terminal Application linked to a specific Account.
LinkAccountTerminalApplicationRequestBuilder	link()	Link an account with a terminal application.
LinkAccountTerminalApplicationResponse	link(java.lang.String accountID, LinkAccountTerminalApplication linkAccountTerminalApplication)	Link an account with a terminal application.
LinkAccountTerminalApplicationResponse	link(java.util.Optional<java.lang.String> xMoovVersion, java.lang.String accountID, LinkAccountTerminalApplication linkAccountTerminalApplication)	Link an account with a terminal application.
ListAccountTerminalApplicationsRequestBuilder	list()	Retrieve all terminal applications linked to a specific account.
ListAccountTerminalApplicationsResponse	list(java.lang.String accountID)	Retrieve all terminal applications linked to a specific account.
ListAccountTerminalApplicationsResponse	list(java.util.Optional<java.lang.String> xMoovVersion, java.lang.String accountID)	Retrieve all terminal applications linked to a specific account.

Methods inherited from class java.lang.Object

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

Method Detail

link

public LinkAccountTerminalApplicationRequestBuilder link()

Link an account with a terminal application.

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

Returns:

The call builder

link

public LinkAccountTerminalApplicationResponse link(java.lang.String accountID,
                                                   LinkAccountTerminalApplication linkAccountTerminalApplication)
                                            throws java.lang.Exception

Link an account with a terminal application.

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

Parameters:

accountID -

linkAccountTerminalApplication - Describes a request to link an account with a terminal application.

Returns:

The response from the API call

Throws:

java.lang.Exception - if the API call fails

link

public LinkAccountTerminalApplicationResponse link(java.util.Optional<java.lang.String> xMoovVersion,
                                                   java.lang.String accountID,
                                                   LinkAccountTerminalApplication linkAccountTerminalApplication)
                                            throws java.lang.Exception

Link an account with a terminal application.

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

Specified by:

link in interface SDKMethodInterfaces.MethodCallLinkAccountTerminalApplication

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 -

linkAccountTerminalApplication - Describes a request to link an account with a terminal application.

Returns:

The response from the API call

Throws:

java.lang.Exception - if the API call fails

list

public ListAccountTerminalApplicationsRequestBuilder list()

Retrieve all terminal applications linked to a specific 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}/terminal-applications.read` scope.

Returns:

The call builder

list

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

Retrieve all terminal applications linked to a specific 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}/terminal-applications.read` scope.

Parameters:

accountID -

Returns:

The response from the API call

Throws:

java.lang.Exception - if the API call fails

list

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

Retrieve all terminal applications linked to a specific 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}/terminal-applications.read` scope.

Specified by:

list in interface SDKMethodInterfaces.MethodCallListAccountTerminalApplications

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

get

public GetAccountTerminalApplicationRequestBuilder get()

Verifies if a specific Terminal Application is linked to an Account. This endpoint acts as a validation check for the link's existence.

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

Returns:

The call builder

get

public GetAccountTerminalApplicationResponse get(java.lang.String accountID,
                                                 java.lang.String terminalApplicationID)
                                          throws java.lang.Exception

Verifies if a specific Terminal Application is linked to an Account. This endpoint acts as a validation check for the link's existence.

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

Parameters:

accountID -

terminalApplicationID -

Returns:

The response from the API call

Throws:

java.lang.Exception - if the API call fails

get

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

Verifies if a specific Terminal Application is linked to an Account. This endpoint acts as a validation check for the link's existence.

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

Specified by:

get in interface SDKMethodInterfaces.MethodCallGetAccountTerminalApplication

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 -

terminalApplicationID -

Returns:

The response from the API call

Throws:

java.lang.Exception - if the API call fails

getConfiguration

public GetTerminalConfigurationRequestBuilder getConfiguration()

Fetch the configuration for a given Terminal Application linked to a specific 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}/terminal-configuration.read` scope.

Returns:

The call builder

getConfiguration

public GetTerminalConfigurationResponse getConfiguration(java.lang.String accountID,
                                                         java.lang.String terminalApplicationID)
                                                  throws java.lang.Exception

Fetch the configuration for a given Terminal Application linked to a specific 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}/terminal-configuration.read` scope.

Parameters:

accountID -

terminalApplicationID -

Returns:

The response from the API call

Throws:

java.lang.Exception - if the API call fails

getConfiguration

public GetTerminalConfigurationResponse getConfiguration(java.util.Optional<java.lang.String> xMoovVersion,
                                                         java.lang.String accountID,
                                                         java.lang.String terminalApplicationID)
                                                  throws java.lang.Exception

Fetch the configuration for a given Terminal Application linked to a specific 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}/terminal-configuration.read` scope.

Specified by:

getConfiguration in interface SDKMethodInterfaces.MethodCallGetTerminalConfiguration

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 -

terminalApplicationID -

Returns:

The response from the API call

Throws:

java.lang.Exception - if the API call fails