Package com.adyen.service.management

Class AllowedOriginsCompanyLevelApi

java.lang.Object

com.adyen.Service

com.adyen.service.management.AllowedOriginsCompanyLevelApi

public class AllowedOriginsCompanyLevelApi
extends Service

Field Summary

Fields

Modifier and Type	Field	Description
static String	API_VERSION
protected String	baseURL

Constructor Summary

Constructors

Constructor	Description
AllowedOriginsCompanyLevelApi(Client client)	Allowed origins - company level constructor in package.
AllowedOriginsCompanyLevelApi(Client client, String baseURL)	Allowed origins - company level constructor in package.

Method Summary

Modifier and Type	Method	Description
AllowedOrigin	createAllowedOrigin(String companyId, String apiCredentialId, AllowedOrigin allowedOrigin)	Create an allowed origin
AllowedOrigin	createAllowedOrigin(String companyId, String apiCredentialId, AllowedOrigin allowedOrigin, RequestOptions requestOptions)	Create an allowed origin
void	deleteAllowedOrigin(String companyId, String apiCredentialId, String originId)	Delete an allowed origin
void	deleteAllowedOrigin(String companyId, String apiCredentialId, String originId, RequestOptions requestOptions)	Delete an allowed origin
AllowedOrigin	getAllowedOrigin(String companyId, String apiCredentialId, String originId)	Get an allowed origin
AllowedOrigin	getAllowedOrigin(String companyId, String apiCredentialId, String originId, RequestOptions requestOptions)	Get an allowed origin
AllowedOriginsResponse	listAllowedOrigins(String companyId, String apiCredentialId)	Get a list of allowed origins
AllowedOriginsResponse	listAllowedOrigins(String companyId, String apiCredentialId, RequestOptions requestOptions)	Get a list of allowed origins

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

AllowedOriginsCompanyLevelApi

public AllowedOriginsCompanyLevelApi(Client client)

Allowed origins - company level constructor in package.

Parameters:

client - Client (required)

AllowedOriginsCompanyLevelApi

public AllowedOriginsCompanyLevelApi(Client client,
                                     String baseURL)

Allowed origins - 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

createAllowedOrigin

public AllowedOrigin createAllowedOrigin(String companyId,
                                         String apiCredentialId,
                                         AllowedOrigin allowedOrigin)
                                  throws ApiException,
                                         IOException

Create an allowed origin

Parameters:

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

apiCredentialId - String Unique identifier of the API credential. (required)

allowedOrigin - AllowedOrigin (required)

Returns:

AllowedOrigin

Throws:

ApiException - if fails to make API call

IOException

createAllowedOrigin

public AllowedOrigin createAllowedOrigin(String companyId,
                                         String apiCredentialId,
                                         AllowedOrigin allowedOrigin,
                                         RequestOptions requestOptions)
                                  throws ApiException,
                                         IOException

Create an allowed origin

Parameters:

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

apiCredentialId - String Unique identifier of the API credential. (required)

allowedOrigin - AllowedOrigin (required)

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

Returns:

AllowedOrigin

Throws:

ApiException - if fails to make API call

IOException

deleteAllowedOrigin

public void deleteAllowedOrigin(String companyId,
                                String apiCredentialId,
                                String originId)
                         throws ApiException,
                                IOException

Delete an allowed origin

Parameters:

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

apiCredentialId - String Unique identifier of the API credential. (required)

originId - String Unique identifier of the allowed origin. (required)

Throws:

ApiException - if fails to make API call

IOException

deleteAllowedOrigin

public void deleteAllowedOrigin(String companyId,
                                String apiCredentialId,
                                String originId,
                                RequestOptions requestOptions)
                         throws ApiException,
                                IOException

Delete an allowed origin

Parameters:

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

apiCredentialId - String Unique identifier of the API credential. (required)

originId - String Unique identifier of the allowed origin. (required)

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

Throws:

ApiException - if fails to make API call

IOException

getAllowedOrigin

public AllowedOrigin getAllowedOrigin(String companyId,
                                      String apiCredentialId,
                                      String originId)
                               throws ApiException,
                                      IOException

Get an allowed origin

Parameters:

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

apiCredentialId - String Unique identifier of the API credential. (required)

originId - String Unique identifier of the allowed origin. (required)

Returns:

AllowedOrigin

Throws:

ApiException - if fails to make API call

IOException

getAllowedOrigin

public AllowedOrigin getAllowedOrigin(String companyId,
                                      String apiCredentialId,
                                      String originId,
                                      RequestOptions requestOptions)
                               throws ApiException,
                                      IOException

Get an allowed origin

Parameters:

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

apiCredentialId - String Unique identifier of the API credential. (required)

originId - String Unique identifier of the allowed origin. (required)

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

Returns:

AllowedOrigin

Throws:

ApiException - if fails to make API call

IOException

listAllowedOrigins

public AllowedOriginsResponse listAllowedOrigins(String companyId,
                                                 String apiCredentialId)
                                          throws ApiException,
                                                 IOException

Get a list of allowed origins

Parameters:

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

apiCredentialId - String Unique identifier of the API credential. (required)

Returns:

AllowedOriginsResponse

Throws:

ApiException - if fails to make API call

IOException

listAllowedOrigins

public AllowedOriginsResponse listAllowedOrigins(String companyId,
                                                 String apiCredentialId,
                                                 RequestOptions requestOptions)
                                          throws ApiException,
                                                 IOException

Get a list of allowed origins

Parameters:

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

apiCredentialId - String Unique identifier of the API credential. (required)

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

Returns:

AllowedOriginsResponse

Throws:

ApiException - if fails to make API call

IOException