Package com.adyen.service.management

Class ApiCredentialsCompanyLevelApi

java.lang.Object

com.adyen.Service

com.adyen.service.management.ApiCredentialsCompanyLevelApi

public class ApiCredentialsCompanyLevelApi
extends Service

Field Summary

Fields

Modifier and Type	Field	Description
static String	API_VERSION
protected String	baseURL

Constructor Summary

Constructors

Constructor	Description
ApiCredentialsCompanyLevelApi(Client client)	API credentials - company level constructor in package.
ApiCredentialsCompanyLevelApi(Client client, String baseURL)	API credentials - company level constructor in package.

Method Summary

Modifier and Type	Method	Description
CreateCompanyApiCredentialResponse	createApiCredential(String companyId, CreateCompanyApiCredentialRequest createCompanyApiCredentialRequest)	Create an API credential.
CreateCompanyApiCredentialResponse	createApiCredential(String companyId, CreateCompanyApiCredentialRequest createCompanyApiCredentialRequest, RequestOptions requestOptions)	Create an API credential.
CompanyApiCredential	getApiCredential(String companyId, String apiCredentialId)	Get an API credential
CompanyApiCredential	getApiCredential(String companyId, String apiCredentialId, RequestOptions requestOptions)	Get an API credential
ListCompanyApiCredentialsResponse	listApiCredentials(String companyId)	Get a list of API credentials
ListCompanyApiCredentialsResponse	listApiCredentials(String companyId, Integer pageNumber, Integer pageSize, RequestOptions requestOptions)	Get a list of API credentials
CompanyApiCredential	updateApiCredential(String companyId, String apiCredentialId, UpdateCompanyApiCredentialRequest updateCompanyApiCredentialRequest)	Update an API credential.
CompanyApiCredential	updateApiCredential(String companyId, String apiCredentialId, UpdateCompanyApiCredentialRequest updateCompanyApiCredentialRequest, RequestOptions requestOptions)	Update an API credential.

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

ApiCredentialsCompanyLevelApi

public ApiCredentialsCompanyLevelApi(Client client)

API credentials - company level constructor in package.

Parameters:

client - Client (required)

ApiCredentialsCompanyLevelApi

public ApiCredentialsCompanyLevelApi(Client client,
                                     String baseURL)

API credentials - 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

createApiCredential

public CreateCompanyApiCredentialResponse createApiCredential(String companyId,
                                                              CreateCompanyApiCredentialRequest createCompanyApiCredentialRequest)
                                                       throws ApiException,
                                                              IOException

Create an API credential.

Parameters:

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

createCompanyApiCredentialRequest - CreateCompanyApiCredentialRequest (required)

Returns:

CreateCompanyApiCredentialResponse

Throws:

ApiException - if fails to make API call

IOException

createApiCredential

public CreateCompanyApiCredentialResponse createApiCredential(String companyId,
                                                              CreateCompanyApiCredentialRequest createCompanyApiCredentialRequest,
                                                              RequestOptions requestOptions)
                                                       throws ApiException,
                                                              IOException

Create an API credential.

Parameters:

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

createCompanyApiCredentialRequest - CreateCompanyApiCredentialRequest (required)

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

Returns:

CreateCompanyApiCredentialResponse

Throws:

ApiException - if fails to make API call

IOException

getApiCredential

public CompanyApiCredential getApiCredential(String companyId,
                                             String apiCredentialId)
                                      throws ApiException,
                                             IOException

Get an API credential

Parameters:

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

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

Returns:

CompanyApiCredential

Throws:

ApiException - if fails to make API call

IOException

getApiCredential

public CompanyApiCredential getApiCredential(String companyId,
                                             String apiCredentialId,
                                             RequestOptions requestOptions)
                                      throws ApiException,
                                             IOException

Get an API credential

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:

CompanyApiCredential

Throws:

ApiException - if fails to make API call

IOException

listApiCredentials

public ListCompanyApiCredentialsResponse listApiCredentials(String companyId)
                                                     throws ApiException,
                                                            IOException

Get a list of API credentials

Parameters:

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

Returns:

ListCompanyApiCredentialsResponse

Throws:

ApiException - if fails to make API call

IOException

listApiCredentials

public ListCompanyApiCredentialsResponse listApiCredentials(String companyId,
                                                            Integer pageNumber,
                                                            Integer pageSize,
                                                            RequestOptions requestOptions)
                                                     throws ApiException,
                                                            IOException

Get a list of API credentials

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 10 items on a page. (optional)

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

Returns:

ListCompanyApiCredentialsResponse

Throws:

ApiException - if fails to make API call

IOException

updateApiCredential

public CompanyApiCredential updateApiCredential(String companyId,
                                                String apiCredentialId,
                                                UpdateCompanyApiCredentialRequest updateCompanyApiCredentialRequest)
                                         throws ApiException,
                                                IOException

Update an API credential.

Parameters:

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

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

updateCompanyApiCredentialRequest - UpdateCompanyApiCredentialRequest (required)

Returns:

CompanyApiCredential

Throws:

ApiException - if fails to make API call

IOException

updateApiCredential

public CompanyApiCredential updateApiCredential(String companyId,
                                                String apiCredentialId,
                                                UpdateCompanyApiCredentialRequest updateCompanyApiCredentialRequest,
                                                RequestOptions requestOptions)
                                         throws ApiException,
                                                IOException

Update an API credential.

Parameters:

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

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

updateCompanyApiCredentialRequest - UpdateCompanyApiCredentialRequest (required)

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

Returns:

CompanyApiCredential

Throws:

ApiException - if fails to make API call

IOException