Package com.adyen.service.management

Class MyApiCredentialApi

java.lang.Object

com.adyen.Service

com.adyen.service.management.MyApiCredentialApi

public class MyApiCredentialApi
extends Service

Field Summary

Fields

Modifier and Type	Field	Description
static String	API_VERSION
protected String	baseURL

Constructor Summary

Constructors

Constructor	Description
MyApiCredentialApi(Client client)	My API credential constructor in package.
MyApiCredentialApi(Client client, String baseURL)	My API credential constructor in package.

Method Summary

Modifier and Type	Method	Description
AllowedOrigin	addAllowedOrigin(CreateAllowedOriginRequest createAllowedOriginRequest)	Add allowed origin
AllowedOrigin	addAllowedOrigin(CreateAllowedOriginRequest createAllowedOriginRequest, RequestOptions requestOptions)	Add allowed origin
GenerateClientKeyResponse	generateClientKey()	Generate a client key
GenerateClientKeyResponse	generateClientKey(RequestOptions requestOptions)	Generate a client key
AllowedOrigin	getAllowedOriginDetails(String originId)	Get allowed origin details
AllowedOrigin	getAllowedOriginDetails(String originId, RequestOptions requestOptions)	Get allowed origin details
AllowedOriginsResponse	getAllowedOrigins()	Get allowed origins
AllowedOriginsResponse	getAllowedOrigins(RequestOptions requestOptions)	Get allowed origins
MeApiCredential	getApiCredentialDetails()	Get API credential details
MeApiCredential	getApiCredentialDetails(RequestOptions requestOptions)	Get API credential details
void	removeAllowedOrigin(String originId)	Remove allowed origin
void	removeAllowedOrigin(String originId, RequestOptions requestOptions)	Remove allowed origin

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

MyApiCredentialApi

public MyApiCredentialApi(Client client)

My API credential constructor in package.

Parameters:

client - Client (required)

MyApiCredentialApi

public MyApiCredentialApi(Client client,
                          String baseURL)

My API credential 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

addAllowedOrigin

public AllowedOrigin addAllowedOrigin(CreateAllowedOriginRequest createAllowedOriginRequest)
                               throws ApiException,
                                      IOException

Add allowed origin

Parameters:

createAllowedOriginRequest - CreateAllowedOriginRequest (required)

Returns:

AllowedOrigin

Throws:

ApiException - if fails to make API call

IOException

addAllowedOrigin

public AllowedOrigin addAllowedOrigin(CreateAllowedOriginRequest createAllowedOriginRequest,
                                      RequestOptions requestOptions)
                               throws ApiException,
                                      IOException

Add allowed origin

Parameters:

createAllowedOriginRequest - CreateAllowedOriginRequest (required)

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

Returns:

AllowedOrigin

Throws:

ApiException - if fails to make API call

IOException

generateClientKey

public GenerateClientKeyResponse generateClientKey()
                                            throws ApiException,
                                                   IOException

Generate a client key

Returns:

GenerateClientKeyResponse

Throws:

ApiException - if fails to make API call

IOException

generateClientKey

public GenerateClientKeyResponse generateClientKey(RequestOptions requestOptions)
                                            throws ApiException,
                                                   IOException

Generate a client key

Parameters:

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

Returns:

GenerateClientKeyResponse

Throws:

ApiException - if fails to make API call

IOException

getAllowedOriginDetails

public AllowedOrigin getAllowedOriginDetails(String originId)
                                      throws ApiException,
                                             IOException

Get allowed origin details

Parameters:

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

Returns:

AllowedOrigin

Throws:

ApiException - if fails to make API call

IOException

getAllowedOriginDetails

public AllowedOrigin getAllowedOriginDetails(String originId,
                                             RequestOptions requestOptions)
                                      throws ApiException,
                                             IOException

Get allowed origin details

Parameters:

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

getAllowedOrigins

public AllowedOriginsResponse getAllowedOrigins()
                                         throws ApiException,
                                                IOException

Get allowed origins

Returns:

AllowedOriginsResponse

Throws:

ApiException - if fails to make API call

IOException

getAllowedOrigins

public AllowedOriginsResponse getAllowedOrigins(RequestOptions requestOptions)
                                         throws ApiException,
                                                IOException

Get allowed origins

Parameters:

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

Returns:

AllowedOriginsResponse

Throws:

ApiException - if fails to make API call

IOException

getApiCredentialDetails

public MeApiCredential getApiCredentialDetails()
                                        throws ApiException,
                                               IOException

Get API credential details

Returns:

MeApiCredential

Throws:

ApiException - if fails to make API call

IOException

getApiCredentialDetails

public MeApiCredential getApiCredentialDetails(RequestOptions requestOptions)
                                        throws ApiException,
                                               IOException

Get API credential details

Parameters:

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

Returns:

MeApiCredential

Throws:

ApiException - if fails to make API call

IOException

removeAllowedOrigin

public void removeAllowedOrigin(String originId)
                         throws ApiException,
                                IOException

Remove allowed origin

Parameters:

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

Throws:

ApiException - if fails to make API call

IOException

removeAllowedOrigin

public void removeAllowedOrigin(String originId,
                                RequestOptions requestOptions)
                         throws ApiException,
                                IOException

Remove allowed origin

Parameters:

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