Package io.moov.sdk

Class TerminalApplications

java.lang.Object

io.moov.sdk.TerminalApplications

All Implemented Interfaces:

SDKMethodInterfaces.MethodCallCreateTerminalApplication, SDKMethodInterfaces.MethodCallDeleteTerminalApplication, SDKMethodInterfaces.MethodCallGetTerminalApplication, SDKMethodInterfaces.MethodCallListTerminalApplications

public class TerminalApplications
extends java.lang.Object
implements SDKMethodInterfaces.MethodCallCreateTerminalApplication, SDKMethodInterfaces.MethodCallListTerminalApplications, SDKMethodInterfaces.MethodCallGetTerminalApplication, SDKMethodInterfaces.MethodCallDeleteTerminalApplication

Method Summary

Modifier and Type	Method	Description
CreateTerminalApplicationRequestBuilder	create()	Create a new terminal application.
CreateTerminalApplicationResponse	create(CreateTerminalApplication createTerminalApplication)	Create a new terminal application.
CreateTerminalApplicationResponse	create(java.util.Optional<java.lang.String> xMoovVersion, CreateTerminalApplication createTerminalApplication)	Create a new terminal application.
DeleteTerminalApplicationRequestBuilder	delete()	Delete a specific terminal application.
DeleteTerminalApplicationResponse	delete(java.lang.String terminalApplicationID)	Delete a specific terminal application.
DeleteTerminalApplicationResponse	delete(java.util.Optional<java.lang.String> xMoovVersion, java.lang.String terminalApplicationID)	Delete a specific terminal application.
GetTerminalApplicationRequestBuilder	get()	Fetch a specific terminal application.
GetTerminalApplicationResponse	get(java.lang.String terminalApplicationID)	Fetch a specific terminal application.
GetTerminalApplicationResponse	get(java.util.Optional<java.lang.String> xMoovVersion, java.lang.String terminalApplicationID)	Fetch a specific terminal application.
ListTerminalApplicationsRequestBuilder	list()	List all the terminal applications for a Moov Account.
ListTerminalApplicationsResponse	list(java.util.Optional<java.lang.String> xMoovVersion)	List all the terminal applications for a Moov Account.
ListTerminalApplicationsResponse	listDirect()	List all the terminal applications for a Moov Account.

Methods inherited from class java.lang.Object

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

Method Detail

create

public CreateTerminalApplicationRequestBuilder create()

Create a new terminal application.

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

Returns:

The call builder

create

public CreateTerminalApplicationResponse create(CreateTerminalApplication createTerminalApplication)
                                         throws java.lang.Exception

Create a new terminal application.

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

Parameters:

createTerminalApplication - Describes a create terminal application request.

Returns:

The response from the API call

Throws:

java.lang.Exception - if the API call fails

create

public CreateTerminalApplicationResponse create(java.util.Optional<java.lang.String> xMoovVersion,
                                                CreateTerminalApplication createTerminalApplication)
                                         throws java.lang.Exception

Create a new terminal application.

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

Specified by:

create in interface SDKMethodInterfaces.MethodCallCreateTerminalApplication

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.

createTerminalApplication - Describes a create terminal application request.

Returns:

The response from the API call

Throws:

java.lang.Exception - if the API call fails

list

public ListTerminalApplicationsRequestBuilder list()

List all the terminal applications for a Moov Account.

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

Returns:

The call builder

listDirect

public ListTerminalApplicationsResponse listDirect()
                                            throws java.lang.Exception

List all the terminal applications for a Moov Account.

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

Returns:

The response from the API call

Throws:

java.lang.Exception - if the API call fails

list

public ListTerminalApplicationsResponse list(java.util.Optional<java.lang.String> xMoovVersion)
                                      throws java.lang.Exception

List all the terminal applications for a Moov Account.

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

Specified by:

list in interface SDKMethodInterfaces.MethodCallListTerminalApplications

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.

Returns:

The response from the API call

Throws:

java.lang.Exception - if the API call fails

get

public GetTerminalApplicationRequestBuilder get()

Fetch a specific terminal application.

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

Returns:

The call builder

get

public GetTerminalApplicationResponse get(java.lang.String terminalApplicationID)
                                   throws java.lang.Exception

Fetch a specific terminal application.

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

Parameters:

terminalApplicationID -

Returns:

The response from the API call

Throws:

java.lang.Exception - if the API call fails

get

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

Fetch a specific terminal application.

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

Specified by:

get in interface SDKMethodInterfaces.MethodCallGetTerminalApplication

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.

terminalApplicationID -

Returns:

The response from the API call

Throws:

java.lang.Exception - if the API call fails

delete

public DeleteTerminalApplicationRequestBuilder delete()

Delete a specific terminal application.

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

Returns:

The call builder

delete

public DeleteTerminalApplicationResponse delete(java.lang.String terminalApplicationID)
                                         throws java.lang.Exception

Delete a specific terminal application.

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

Parameters:

terminalApplicationID -

Returns:

The response from the API call

Throws:

java.lang.Exception - if the API call fails

delete

public DeleteTerminalApplicationResponse delete(java.util.Optional<java.lang.String> xMoovVersion,
                                                java.lang.String terminalApplicationID)
                                         throws java.lang.Exception

Delete a specific terminal application.

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

Specified by:

delete in interface SDKMethodInterfaces.MethodCallDeleteTerminalApplication

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.

terminalApplicationID -

Returns:

The response from the API call

Throws:

java.lang.Exception - if the API call fails