Package com.adyen.model.management

Class CreateCompanyApiCredentialResponse

java.lang.Object

com.adyen.model.management.CreateCompanyApiCredentialResponse

public class CreateCompanyApiCredentialResponse
extends Object

CreateCompanyApiCredentialResponse

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CreateCompanyApiCredentialResponse.CustomTypeAdapterFactory

Field Summary

Fields

Modifier and Type	Field	Description
static HashSet<String>	openapiFields
static HashSet<String>	openapiRequiredFields
static String	SERIALIZED_NAME_ACTIVE
static String	SERIALIZED_NAME_ALLOWED_IP_ADDRESSES
static String	SERIALIZED_NAME_ALLOWED_ORIGINS
static String	SERIALIZED_NAME_API_KEY
static String	SERIALIZED_NAME_ASSOCIATED_MERCHANT_ACCOUNTS
static String	SERIALIZED_NAME_CLIENT_KEY
static String	SERIALIZED_NAME_DESCRIPTION
static String	SERIALIZED_NAME_ID
static String	SERIALIZED_NAME_LINKS
static String	SERIALIZED_NAME_PASSWORD
static String	SERIALIZED_NAME_ROLES
static String	SERIALIZED_NAME_USERNAME

Constructor Summary

Constructors

Constructor	Description
CreateCompanyApiCredentialResponse()

Method Summary

Modifier and Type	Method	Description
CreateCompanyApiCredentialResponse	active(Boolean active)
CreateCompanyApiCredentialResponse	addAllowedIpAddressesItem(String allowedIpAddressesItem)
CreateCompanyApiCredentialResponse	addAllowedOriginsItem(AllowedOrigin allowedOriginsItem)
CreateCompanyApiCredentialResponse	addAssociatedMerchantAccountsItem(String associatedMerchantAccountsItem)
CreateCompanyApiCredentialResponse	addRolesItem(String rolesItem)
CreateCompanyApiCredentialResponse	allowedIpAddresses(List<String> allowedIpAddresses)
CreateCompanyApiCredentialResponse	allowedOrigins(List<AllowedOrigin> allowedOrigins)
CreateCompanyApiCredentialResponse	apiKey(String apiKey)
CreateCompanyApiCredentialResponse	associatedMerchantAccounts(List<String> associatedMerchantAccounts)
CreateCompanyApiCredentialResponse	clientKey(String clientKey)
CreateCompanyApiCredentialResponse	description(String description)
boolean	equals(Object o)
static CreateCompanyApiCredentialResponse	fromJson(String jsonString)	Create an instance of CreateCompanyApiCredentialResponse given an JSON string
Boolean	getActive()	Indicates if the API credential is enabled.
List<String>	getAllowedIpAddresses()	List of IP addresses from which your client can make requests.
List<AllowedOrigin>	getAllowedOrigins()	List containing the [allowed origins](https://docs.adyen.com/development-resources/client-side-authentication#allowed-origins) linked to the API credential.
String	getApiKey()	The API key for the API credential that was created.
List<String>	getAssociatedMerchantAccounts()	List of merchant accounts that the API credential has access to.
String	getClientKey()	Public key used for [client-side authentication](https://docs.adyen.com/development-resources/client-side-authentication).
String	getDescription()	Description of the API credential.
String	getId()	Unique identifier of the API credential.
ApiCredentialLinks	getLinks()	Get links
String	getPassword()	The password for the API credential that was created.
List<String>	getRoles()	List of [roles](https://docs.adyen.com/development-resources/api-credentials#roles-1) for the API credential.
String	getUsername()	The name of the [API credential](https://docs.adyen.com/development-resources/api-credentials), for example **ws@Company.TestCompany**.
int	hashCode()
CreateCompanyApiCredentialResponse	id(String id)
CreateCompanyApiCredentialResponse	links(ApiCredentialLinks links)
CreateCompanyApiCredentialResponse	password(String password)
CreateCompanyApiCredentialResponse	roles(List<String> roles)
void	setActive(Boolean active)
void	setAllowedIpAddresses(List<String> allowedIpAddresses)
void	setAllowedOrigins(List<AllowedOrigin> allowedOrigins)
void	setApiKey(String apiKey)
void	setAssociatedMerchantAccounts(List<String> associatedMerchantAccounts)
void	setClientKey(String clientKey)
void	setDescription(String description)
void	setId(String id)
void	setLinks(ApiCredentialLinks links)
void	setPassword(String password)
void	setRoles(List<String> roles)
void	setUsername(String username)
String	toJson()	Convert an instance of CreateCompanyApiCredentialResponse to an JSON string
String	toString()
CreateCompanyApiCredentialResponse	username(String username)
static void	validateJsonObject(com.google.gson.JsonObject jsonObj)	Validates the JSON Object and throws an exception if issues found

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

SERIALIZED_NAME_LINKS

public static final String SERIALIZED_NAME_LINKS

See Also:

Constant Field Values

SERIALIZED_NAME_ACTIVE

public static final String SERIALIZED_NAME_ACTIVE

See Also:

Constant Field Values

SERIALIZED_NAME_ALLOWED_IP_ADDRESSES

public static final String SERIALIZED_NAME_ALLOWED_IP_ADDRESSES

See Also:

Constant Field Values

SERIALIZED_NAME_ALLOWED_ORIGINS

public static final String SERIALIZED_NAME_ALLOWED_ORIGINS

See Also:

Constant Field Values

SERIALIZED_NAME_API_KEY

public static final String SERIALIZED_NAME_API_KEY

See Also:

Constant Field Values

SERIALIZED_NAME_ASSOCIATED_MERCHANT_ACCOUNTS

public static final String SERIALIZED_NAME_ASSOCIATED_MERCHANT_ACCOUNTS

See Also:

Constant Field Values

SERIALIZED_NAME_CLIENT_KEY

public static final String SERIALIZED_NAME_CLIENT_KEY

See Also:

Constant Field Values

SERIALIZED_NAME_DESCRIPTION

public static final String SERIALIZED_NAME_DESCRIPTION

See Also:

Constant Field Values

SERIALIZED_NAME_ID

public static final String SERIALIZED_NAME_ID

See Also:

Constant Field Values

SERIALIZED_NAME_PASSWORD

public static final String SERIALIZED_NAME_PASSWORD

See Also:

Constant Field Values

SERIALIZED_NAME_ROLES

public static final String SERIALIZED_NAME_ROLES

See Also:

Constant Field Values

SERIALIZED_NAME_USERNAME

public static final String SERIALIZED_NAME_USERNAME

See Also:

Constant Field Values

openapiFields

public static HashSet<String> openapiFields

openapiRequiredFields

public static HashSet<String> openapiRequiredFields

Constructor Detail

CreateCompanyApiCredentialResponse

public CreateCompanyApiCredentialResponse()

Method Detail

links

public CreateCompanyApiCredentialResponse links(ApiCredentialLinks links)

getLinks

public ApiCredentialLinks getLinks()

Get links

Returns:

links

setLinks

public void setLinks(ApiCredentialLinks links)

active

public CreateCompanyApiCredentialResponse active(Boolean active)

getActive

public Boolean getActive()

Indicates if the API credential is enabled. Must be set to **true** to use the credential in your integration.

Returns:

active

setActive

public void setActive(Boolean active)

allowedIpAddresses

public CreateCompanyApiCredentialResponse allowedIpAddresses(List<String> allowedIpAddresses)

addAllowedIpAddressesItem

public CreateCompanyApiCredentialResponse addAllowedIpAddressesItem(String allowedIpAddressesItem)

getAllowedIpAddresses

public List<String> getAllowedIpAddresses()

List of IP addresses from which your client can make requests. If the list is empty, we allow requests from any IP. If the list is not empty and we get a request from an IP which is not on the list, you get a security error.

Returns:

allowedIpAddresses

setAllowedIpAddresses

public void setAllowedIpAddresses(List<String> allowedIpAddresses)

allowedOrigins

public CreateCompanyApiCredentialResponse allowedOrigins(List<AllowedOrigin> allowedOrigins)

addAllowedOriginsItem

public CreateCompanyApiCredentialResponse addAllowedOriginsItem(AllowedOrigin allowedOriginsItem)

getAllowedOrigins

public List<AllowedOrigin> getAllowedOrigins()

List containing the [allowed origins](https://docs.adyen.com/development-resources/client-side-authentication#allowed-origins) linked to the API credential.

Returns:

allowedOrigins

setAllowedOrigins

public void setAllowedOrigins(List<AllowedOrigin> allowedOrigins)

apiKey

public CreateCompanyApiCredentialResponse apiKey(String apiKey)

getApiKey

public String getApiKey()

The API key for the API credential that was created.

Returns:

apiKey

setApiKey

public void setApiKey(String apiKey)

associatedMerchantAccounts

public CreateCompanyApiCredentialResponse associatedMerchantAccounts(List<String> associatedMerchantAccounts)

addAssociatedMerchantAccountsItem

public CreateCompanyApiCredentialResponse addAssociatedMerchantAccountsItem(String associatedMerchantAccountsItem)

getAssociatedMerchantAccounts

public List<String> getAssociatedMerchantAccounts()

List of merchant accounts that the API credential has access to.

Returns:

associatedMerchantAccounts

setAssociatedMerchantAccounts

public void setAssociatedMerchantAccounts(List<String> associatedMerchantAccounts)

clientKey

public CreateCompanyApiCredentialResponse clientKey(String clientKey)

getClientKey

public String getClientKey()

Public key used for [client-side authentication](https://docs.adyen.com/development-resources/client-side-authentication). The client key is required for Drop-in and Components integrations.

Returns:

clientKey

setClientKey

public void setClientKey(String clientKey)

description

public CreateCompanyApiCredentialResponse description(String description)

getDescription

public String getDescription()

Description of the API credential.

Returns:

description

setDescription

public void setDescription(String description)

id

public CreateCompanyApiCredentialResponse id(String id)

getId

public String getId()

Unique identifier of the API credential.

Returns:

id

setId

public void setId(String id)

password

public CreateCompanyApiCredentialResponse password(String password)

getPassword

public String getPassword()

The password for the API credential that was created.

Returns:

password

setPassword

public void setPassword(String password)

roles

public CreateCompanyApiCredentialResponse roles(List<String> roles)

addRolesItem

public CreateCompanyApiCredentialResponse addRolesItem(String rolesItem)

getRoles

public List<String> getRoles()

List of [roles](https://docs.adyen.com/development-resources/api-credentials#roles-1) for the API credential.

Returns:

roles

setRoles

public void setRoles(List<String> roles)

username

public CreateCompanyApiCredentialResponse username(String username)

getUsername

public String getUsername()

The name of the [API credential](https://docs.adyen.com/development-resources/api-credentials), for example **ws@Company.TestCompany**.

Returns:

username

setUsername

public void setUsername(String username)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

validateJsonObject

public static void validateJsonObject(com.google.gson.JsonObject jsonObj)
                               throws IOException

Validates the JSON Object and throws an exception if issues found

Parameters:

jsonObj - JSON Object

Throws:

IOException - if the JSON Object is invalid with respect to CreateCompanyApiCredentialResponse

fromJson

public static CreateCompanyApiCredentialResponse fromJson(String jsonString)
                                                   throws IOException

Create an instance of CreateCompanyApiCredentialResponse given an JSON string

Parameters:

jsonString - JSON string

Returns:

An instance of CreateCompanyApiCredentialResponse

Throws:

IOException - if the JSON string is invalid with respect to CreateCompanyApiCredentialResponse

toJson

public String toJson()

Convert an instance of CreateCompanyApiCredentialResponse to an JSON string

Returns:

JSON string