Package com.adyen.model.management

Class CompanyApiCredential

  • public class CompanyApiCredential
extends Object
    CompanyApiCredential

    • Constructor Detail

      • CompanyApiCredential

        public CompanyApiCredential()

    • Method Detail

      • active

        public CompanyApiCredential 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 CompanyApiCredential 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 CompanyApiCredential 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 CompanyApiCredential 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 CompanyApiCredential 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 CompanyApiCredential 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 -

      • associatedMerchantAccounts

        public CompanyApiCredential associatedMerchantAccounts​(List<String> associatedMerchantAccounts)
        List of merchant accounts that the API credential has explicit access to. If the credential has access to a company, this implies access to all merchant accounts and no merchants for that company will be included.
        Parameters:
        associatedMerchantAccounts -
        Returns:
        the current CompanyApiCredential instance, allowing for method chaining

      • addAssociatedMerchantAccountsItem

        public CompanyApiCredential addAssociatedMerchantAccountsItem​(String associatedMerchantAccountsItem)

      • getAssociatedMerchantAccounts

        public List<String> getAssociatedMerchantAccounts()
        List of merchant accounts that the API credential has explicit access to. If the credential has access to a company, this implies access to all merchant accounts and no merchants for that company will be included.
        Returns:
        associatedMerchantAccounts

      • setAssociatedMerchantAccounts

        public void setAssociatedMerchantAccounts​(List<String> associatedMerchantAccounts)
        List of merchant accounts that the API credential has explicit access to. If the credential has access to a company, this implies access to all merchant accounts and no merchants for that company will be included.
        Parameters:
        associatedMerchantAccounts -

      • clientKey

        public CompanyApiCredential 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 CompanyApiCredential 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 CompanyApiCredential description​(String description)
        Description of the API credential.
        Parameters:
        description -
        Returns:
        the current CompanyApiCredential 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 CompanyApiCredential id​(String id)
        Unique identifier of the API credential.
        Parameters:
        id -
        Returns:
        the current CompanyApiCredential 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 -

      • roles

        public CompanyApiCredential 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 CompanyApiCredential 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 CompanyApiCredential 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 CompanyApiCredential 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 CompanyApiCredential object is equal to o.
        Overrides:
        equals in class Object

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object

      • fromJson

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

      • toJson

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