Package com.adyen.model.management
Class CreateApiCredentialResponse
- java.lang.Object
-
- com.adyen.model.management.CreateApiCredentialResponse
-
public class CreateApiCredentialResponse extends Object
CreateApiCredentialResponse
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classCreateApiCredentialResponse.CustomTypeAdapterFactory
-
Field Summary
Fields Modifier and Type Field Description static HashSet<String>openapiFieldsstatic HashSet<String>openapiRequiredFieldsstatic StringSERIALIZED_NAME_ACTIVEstatic StringSERIALIZED_NAME_ALLOWED_IP_ADDRESSESstatic StringSERIALIZED_NAME_ALLOWED_ORIGINSstatic StringSERIALIZED_NAME_API_KEYstatic StringSERIALIZED_NAME_CLIENT_KEYstatic StringSERIALIZED_NAME_DESCRIPTIONstatic StringSERIALIZED_NAME_IDstatic StringSERIALIZED_NAME_LINKSstatic StringSERIALIZED_NAME_PASSWORDstatic StringSERIALIZED_NAME_ROLESstatic StringSERIALIZED_NAME_USERNAME
-
Constructor Summary
Constructors Constructor Description CreateApiCredentialResponse()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description CreateApiCredentialResponseactive(Boolean active)CreateApiCredentialResponseaddAllowedIpAddressesItem(String allowedIpAddressesItem)CreateApiCredentialResponseaddAllowedOriginsItem(AllowedOrigin allowedOriginsItem)CreateApiCredentialResponseaddRolesItem(String rolesItem)CreateApiCredentialResponseallowedIpAddresses(List<String> allowedIpAddresses)CreateApiCredentialResponseallowedOrigins(List<AllowedOrigin> allowedOrigins)CreateApiCredentialResponseapiKey(String apiKey)CreateApiCredentialResponseclientKey(String clientKey)CreateApiCredentialResponsedescription(String description)booleanequals(Object o)static CreateApiCredentialResponsefromJson(String jsonString)Create an instance of CreateApiCredentialResponse given an JSON stringBooleangetActive()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.StringgetApiKey()The API key for the API credential that was created.StringgetClientKey()Public key used for [client-side authentication](https://docs.adyen.com/development-resources/client-side-authentication).StringgetDescription()Description of the API credential.StringgetId()Unique identifier of the API credential.ApiCredentialLinksgetLinks()Get linksStringgetPassword()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.StringgetUsername()The name of the [API credential](https://docs.adyen.com/development-resources/api-credentials), for example **ws@Company.TestCompany**.inthashCode()CreateApiCredentialResponseid(String id)CreateApiCredentialResponselinks(ApiCredentialLinks links)CreateApiCredentialResponsepassword(String password)CreateApiCredentialResponseroles(List<String> roles)voidsetActive(Boolean active)voidsetAllowedIpAddresses(List<String> allowedIpAddresses)voidsetAllowedOrigins(List<AllowedOrigin> allowedOrigins)voidsetApiKey(String apiKey)voidsetClientKey(String clientKey)voidsetDescription(String description)voidsetId(String id)voidsetLinks(ApiCredentialLinks links)voidsetPassword(String password)voidsetRoles(List<String> roles)voidsetUsername(String username)StringtoJson()Convert an instance of CreateApiCredentialResponse to an JSON stringStringtoString()CreateApiCredentialResponseusername(String username)static voidvalidateJsonObject(com.google.gson.JsonObject jsonObj)Validates the JSON Object and throws an exception if issues found
-
-
-
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_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
-
-
Method Detail
-
links
public CreateApiCredentialResponse links(ApiCredentialLinks links)
-
getLinks
public ApiCredentialLinks getLinks()
Get links- Returns:
- links
-
setLinks
public void setLinks(ApiCredentialLinks links)
-
active
public CreateApiCredentialResponse 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 CreateApiCredentialResponse allowedIpAddresses(List<String> allowedIpAddresses)
-
addAllowedIpAddressesItem
public CreateApiCredentialResponse 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
-
allowedOrigins
public CreateApiCredentialResponse allowedOrigins(List<AllowedOrigin> allowedOrigins)
-
addAllowedOriginsItem
public CreateApiCredentialResponse 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 CreateApiCredentialResponse 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)
-
clientKey
public CreateApiCredentialResponse 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 CreateApiCredentialResponse description(String description)
-
getDescription
public String getDescription()
Description of the API credential.- Returns:
- description
-
setDescription
public void setDescription(String description)
-
id
public CreateApiCredentialResponse id(String id)
-
getId
public String getId()
Unique identifier of the API credential.- Returns:
- id
-
setId
public void setId(String id)
-
password
public CreateApiCredentialResponse 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 CreateApiCredentialResponse roles(List<String> roles)
-
addRolesItem
public CreateApiCredentialResponse 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
-
username
public CreateApiCredentialResponse 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)
-
validateJsonObject
public static void validateJsonObject(com.google.gson.JsonObject jsonObj) throws IOExceptionValidates 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 CreateApiCredentialResponse
-
fromJson
public static CreateApiCredentialResponse fromJson(String jsonString) throws IOException
Create an instance of CreateApiCredentialResponse given an JSON string- Parameters:
jsonString- JSON string- Returns:
- An instance of CreateApiCredentialResponse
- Throws:
IOException- if the JSON string is invalid with respect to CreateApiCredentialResponse
-
toJson
public String toJson()
Convert an instance of CreateApiCredentialResponse to an JSON string- Returns:
- JSON string
-
-