Package com.adyen.model.management

Class CreateApiCredentialResponse

  • public class CreateApiCredentialResponse
extends Object
    CreateApiCredentialResponse

    • Constructor Detail

      • CreateApiCredentialResponse

        public CreateApiCredentialResponse()

    • Method Detail

      • active

        public CreateApiCredentialResponse active​(Boolean active)
        Indicates if the API credential is enabled. Must be set to **true** to use the credential in your integration.
        Parameters:
        active -
        Returns:
        the current CreateApiCredentialResponse instance, allowing for method chaining

      • 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)
        Indicates if the API credential is enabled. Must be set to **true** to use the credential in your integration.
        Parameters:
        active -

      • allowedIpAddresses

        public CreateApiCredentialResponse allowedIpAddresses​(List<String> allowedIpAddresses)
        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.
        Parameters:
        allowedIpAddresses -
        Returns:
        the current CreateApiCredentialResponse instance, allowing for method chaining

      • 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)
        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.
        Parameters:
        allowedIpAddresses -

      • allowedOrigins

        public CreateApiCredentialResponse allowedOrigins​(List<AllowedOrigin> allowedOrigins)
        List containing the [allowed origins](https://docs.adyen.com/development-resources/client-side-authentication#allowed-origins) linked to the API credential.
        Parameters:
        allowedOrigins -
        Returns:
        the current CreateApiCredentialResponse instance, allowing for method chaining

      • 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)
        List containing the [allowed origins](https://docs.adyen.com/development-resources/client-side-authentication#allowed-origins) linked to the API credential.
        Parameters:
        allowedOrigins -

      • apiKey

        public CreateApiCredentialResponse apiKey​(String apiKey)
        The API key for the API credential that was created.
        Parameters:
        apiKey -
        Returns:
        the current CreateApiCredentialResponse instance, allowing for method chaining

      • getApiKey

        public String getApiKey()
        The API key for the API credential that was created.
        Returns:
        apiKey

      • setApiKey

        public void setApiKey​(String apiKey)
        The API key for the API credential that was created.
        Parameters:
        apiKey -

      • clientKey

        public CreateApiCredentialResponse clientKey​(String clientKey)
        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.
        Parameters:
        clientKey -
        Returns:
        the current CreateApiCredentialResponse instance, allowing for method chaining

      • 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)
        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.
        Parameters:
        clientKey -

      • description

        public CreateApiCredentialResponse description​(String description)
        Description of the API credential.
        Parameters:
        description -
        Returns:
        the current CreateApiCredentialResponse instance, allowing for method chaining

      • getDescription

        public String getDescription()
        Description of the API credential.
        Returns:
        description

      • setDescription

        public void setDescription​(String description)
        Description of the API credential.
        Parameters:
        description -

      • id

        public CreateApiCredentialResponse id​(String id)
        Unique identifier of the API credential.
        Parameters:
        id -
        Returns:
        the current CreateApiCredentialResponse instance, allowing for method chaining

      • getId

        public String getId()
        Unique identifier of the API credential.
        Returns:
        id

      • setId

        public void setId​(String id)
        Unique identifier of the API credential.
        Parameters:
        id -

      • password

        public CreateApiCredentialResponse password​(String password)
        The password for the API credential that was created.
        Parameters:
        password -
        Returns:
        the current CreateApiCredentialResponse instance, allowing for method chaining

      • getPassword

        public String getPassword()
        The password for the API credential that was created.
        Returns:
        password

      • setPassword

        public void setPassword​(String password)
        The password for the API credential that was created.
        Parameters:
        password -

      • roles

        public CreateApiCredentialResponse roles​(List<String> roles)
        List of [roles](https://docs.adyen.com/development-resources/api-credentials#roles-1) for the API credential.
        Parameters:
        roles -
        Returns:
        the current CreateApiCredentialResponse instance, allowing for method chaining

      • 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)
        List of [roles](https://docs.adyen.com/development-resources/api-credentials#roles-1) for the API credential.
        Parameters:
        roles -

      • username

        public CreateApiCredentialResponse username​(String username)
        The name of the [API credential](https://docs.adyen.com/development-resources/api-credentials), for example **ws@Company.TestCompany**.
        Parameters:
        username -
        Returns:
        the current CreateApiCredentialResponse instance, allowing for method chaining

      • 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)
        The name of the [API credential](https://docs.adyen.com/development-resources/api-credentials), for example **ws@Company.TestCompany**.
        Parameters:
        username -

      • equals

        public boolean equals​(Object o)
        Return true if this CreateApiCredentialResponse object is equal to o.
        Overrides:
        equals in class Object

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object

      • fromJson

        public static CreateApiCredentialResponse fromJson​(String jsonString)
                                            throws com.fasterxml.jackson.core.JsonProcessingException
        Create an instance of CreateApiCredentialResponse given an JSON string
        Parameters:
        jsonString - JSON string
        Returns:
        An instance of CreateApiCredentialResponse
        Throws:
        com.fasterxml.jackson.core.JsonProcessingException - if the JSON string is invalid with respect to CreateApiCredentialResponse

      • toJson

        public String toJson()
              throws com.fasterxml.jackson.core.JsonProcessingException
        Convert an instance of CreateApiCredentialResponse to an JSON string
        Returns:
        JSON string
        Throws:
        com.fasterxml.jackson.core.JsonProcessingException