Package com.adyen.service.management

Class TerminalSettingsCompanyLevelApi

java.lang.Object

com.adyen.Service

com.adyen.service.management.TerminalSettingsCompanyLevelApi

public class TerminalSettingsCompanyLevelApi
extends Service

Field Summary

Fields

Modifier and Type	Field	Description
static String	API_VERSION
protected String	baseURL

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
Logo	getTerminalLogo(String companyId, String model)	Get the terminal logo
Logo	getTerminalLogo(String companyId, String model, RequestOptions requestOptions)	Get the terminal logo
TerminalSettings	getTerminalSettings(String companyId)	Get terminal settings
TerminalSettings	getTerminalSettings(String companyId, RequestOptions requestOptions)	Get terminal settings
Logo	updateTerminalLogo(String companyId, String model, Logo logo)	Update the terminal logo
Logo	updateTerminalLogo(String companyId, String model, Logo logo, RequestOptions requestOptions)	Update the terminal logo
TerminalSettings	updateTerminalSettings(String companyId, TerminalSettings terminalSettings)	Update terminal settings
TerminalSettings	updateTerminalSettings(String companyId, TerminalSettings terminalSettings, RequestOptions requestOptions)	Update terminal settings

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

TerminalSettingsCompanyLevelApi

public TerminalSettingsCompanyLevelApi(Client client)

Terminal settings - company level constructor in package.

Parameters:

client - Client (required)

TerminalSettingsCompanyLevelApi

public TerminalSettingsCompanyLevelApi(Client client,
                                       String baseURL)

Terminal settings - 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

getTerminalLogo

public Logo getTerminalLogo(String companyId,
                            String model)
                     throws ApiException,
                            IOException

Get the terminal logo

Parameters:

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

model - String The terminal model. Possible values: E355, VX675WIFIBT, VX680, VX690, VX700, VX820, M400, MX925, P400Plus, UX300, UX410, V200cPlus, V240mPlus, V400cPlus, V400m, e280, e285, e285p, S1E, S1EL, S1F2, S1L, S1U, S7T. (required)

Returns:

Logo

Throws:

ApiException - if fails to make API call

IOException

getTerminalLogo

public Logo getTerminalLogo(String companyId,
                            String model,
                            RequestOptions requestOptions)
                     throws ApiException,
                            IOException

Get the terminal logo

Parameters:

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

model - String Query: The terminal model. Possible values: E355, VX675WIFIBT, VX680, VX690, VX700, VX820, M400, MX925, P400Plus, UX300, UX410, V200cPlus, V240mPlus, V400cPlus, V400m, e280, e285, e285p, S1E, S1EL, S1F2, S1L, S1U, S7T. (required)

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

Returns:

Logo

Throws:

ApiException - if fails to make API call

IOException

getTerminalSettings

public TerminalSettings getTerminalSettings(String companyId)
                                     throws ApiException,
                                            IOException

Get terminal settings

Parameters:

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

Returns:

TerminalSettings

Throws:

ApiException - if fails to make API call

IOException

getTerminalSettings

public TerminalSettings getTerminalSettings(String companyId,
                                            RequestOptions requestOptions)
                                     throws ApiException,
                                            IOException

Get terminal settings

Parameters:

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

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

Returns:

TerminalSettings

Throws:

ApiException - if fails to make API call

IOException

updateTerminalLogo

public Logo updateTerminalLogo(String companyId,
                               String model,
                               Logo logo)
                        throws ApiException,
                               IOException

Update the terminal logo

Parameters:

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

model - String The terminal model. Possible values: E355, VX675WIFIBT, VX680, VX690, VX700, VX820, M400, MX925, P400Plus, UX300, UX410, V200cPlus, V240mPlus, V400cPlus, V400m, e280, e285, e285p, S1E, S1EL, S1F2, S1L, S1U, S7T. (required)

logo - Logo (required)

Returns:

Logo

Throws:

ApiException - if fails to make API call

IOException

updateTerminalLogo

public Logo updateTerminalLogo(String companyId,
                               String model,
                               Logo logo,
                               RequestOptions requestOptions)
                        throws ApiException,
                               IOException

Update the terminal logo

Parameters:

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

logo - Logo (required)

model - String Query: The terminal model. Possible values: E355, VX675WIFIBT, VX680, VX690, VX700, VX820, M400, MX925, P400Plus, UX300, UX410, V200cPlus, V240mPlus, V400cPlus, V400m, e280, e285, e285p, S1E, S1EL, S1F2, S1L, S1U, S7T. (required)

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

Returns:

Logo

Throws:

ApiException - if fails to make API call

IOException

updateTerminalSettings

public TerminalSettings updateTerminalSettings(String companyId,
                                               TerminalSettings terminalSettings)
                                        throws ApiException,
                                               IOException

Update terminal settings

Parameters:

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

terminalSettings - TerminalSettings (required)

Returns:

TerminalSettings

Throws:

ApiException - if fails to make API call

IOException

updateTerminalSettings

public TerminalSettings updateTerminalSettings(String companyId,
                                               TerminalSettings terminalSettings,
                                               RequestOptions requestOptions)
                                        throws ApiException,
                                               IOException

Update terminal settings

Parameters:

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

terminalSettings - TerminalSettings (required)

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

Returns:

TerminalSettings

Throws:

ApiException - if fails to make API call

IOException