Package com.adyen.service.management

Class TerminalActionsCompanyLevelApi

java.lang.Object

com.adyen.Service

com.adyen.service.management.TerminalActionsCompanyLevelApi

public class TerminalActionsCompanyLevelApi
extends Service

Field Summary

Fields

Modifier and Type	Field	Description
static String	API_VERSION
protected String	baseURL

Constructor Summary

Constructors

Constructor	Description
TerminalActionsCompanyLevelApi(Client client)	Terminal actions - company level constructor in package.
TerminalActionsCompanyLevelApi(Client client, String baseURL)	Terminal actions - company level constructor in package.

Method Summary

Modifier and Type	Method	Description
ExternalTerminalAction	getTerminalAction(String companyId, String actionId)	Get terminal action
ExternalTerminalAction	getTerminalAction(String companyId, String actionId, RequestOptions requestOptions)	Get terminal action
ListExternalTerminalActionsResponse	listTerminalActions(String companyId)	Get a list of terminal actions
ListExternalTerminalActionsResponse	listTerminalActions(String companyId, Integer pageNumber, Integer pageSize, String status, String type, RequestOptions requestOptions)	Get a list of terminal actions

Methods inherited from class com.adyen.Service

createBaseURL, getClient, isApiKeyRequired, setApiKeyRequired, setClient

Methods inherited from class java.lang.Object

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

Field Detail

API_VERSION

public static final String API_VERSION

See Also:

Constant Field Values

baseURL

protected String baseURL

Constructor Detail

TerminalActionsCompanyLevelApi

public TerminalActionsCompanyLevelApi(Client client)

Terminal actions - company level constructor in package.

Parameters:

client - Client (required)

TerminalActionsCompanyLevelApi

public TerminalActionsCompanyLevelApi(Client client,
                                      String baseURL)

Terminal actions - company level constructor in package. Please use this constructor only if you would like to pass along your own url for routing or testing purposes. The latest API version is defined in this class as a constant.

Parameters:

client - Client (required)

baseURL - String (required)

Method Detail

getTerminalAction

public ExternalTerminalAction getTerminalAction(String companyId,
                                                String actionId)
                                         throws ApiException,
                                                IOException

Get terminal action

Parameters:

companyId - String The unique identifier of the company account. (required)

actionId - String The unique identifier of the terminal action. (required)

Returns:

ExternalTerminalAction

Throws:

ApiException - if fails to make API call

IOException

getTerminalAction

public ExternalTerminalAction getTerminalAction(String companyId,
                                                String actionId,
                                                RequestOptions requestOptions)
                                         throws ApiException,
                                                IOException

Get terminal action

Parameters:

companyId - String The unique identifier of the company account. (required)

actionId - String The unique identifier of the terminal action. (required)

requestOptions - RequestOptions Object to store additional data such as idempotency-keys (optional)

Returns:

ExternalTerminalAction

Throws:

ApiException - if fails to make API call

IOException

listTerminalActions

public ListExternalTerminalActionsResponse listTerminalActions(String companyId)
                                                        throws ApiException,
                                                               IOException

Get a list of terminal actions

Parameters:

companyId - String The unique identifier of the company account. (required)

Returns:

ListExternalTerminalActionsResponse

Throws:

ApiException - if fails to make API call

IOException

listTerminalActions

public ListExternalTerminalActionsResponse listTerminalActions(String companyId,
                                                               Integer pageNumber,
                                                               Integer pageSize,
                                                               String status,
                                                               String type,
                                                               RequestOptions requestOptions)
                                                        throws ApiException,
                                                               IOException

Get a list of terminal actions

Parameters:

companyId - String The unique identifier of the company account. (required)

pageNumber - Integer Query: The number of the page to fetch. (optional)

pageSize - Integer Query: The number of items to have on a page, maximum 100. The default is 20 items on a page. (optional)

status - String Query: Returns terminal actions with the specified status. Allowed values: **pending**, **successful**, **failed**, **cancelled**, **tryLater**. (optional)

type - String Query: Returns terminal actions of the specified type. Allowed values: **InstallAndroidApp**, **UninstallAndroidApp**, **InstallAndroidCertificate**, **UninstallAndroidCertificate**. (optional)

requestOptions - RequestOptions Object to store additional data such as idempotency-keys (optional)

Returns:

ListExternalTerminalActionsResponse

Throws:

ApiException - if fails to make API call

IOException