Class UpdateCompanyWebhookRequest


  • public class UpdateCompanyWebhookRequest
    extends Object
    UpdateCompanyWebhookRequest
    • Constructor Detail

      • UpdateCompanyWebhookRequest

        public UpdateCompanyWebhookRequest()
    • Method Detail

      • acceptsExpiredCertificate

        public UpdateCompanyWebhookRequest acceptsExpiredCertificate​(Boolean acceptsExpiredCertificate)
        Indicates if expired SSL certificates are accepted. Default value: **false**.
        Parameters:
        acceptsExpiredCertificate -
        Returns:
        the current UpdateCompanyWebhookRequest instance, allowing for method chaining
      • getAcceptsExpiredCertificate

        public Boolean getAcceptsExpiredCertificate()
        Indicates if expired SSL certificates are accepted. Default value: **false**.
        Returns:
        acceptsExpiredCertificate
      • setAcceptsExpiredCertificate

        public void setAcceptsExpiredCertificate​(Boolean acceptsExpiredCertificate)
        Indicates if expired SSL certificates are accepted. Default value: **false**.
        Parameters:
        acceptsExpiredCertificate -
      • acceptsSelfSignedCertificate

        public UpdateCompanyWebhookRequest acceptsSelfSignedCertificate​(Boolean acceptsSelfSignedCertificate)
        Indicates if self-signed SSL certificates are accepted. Default value: **false**.
        Parameters:
        acceptsSelfSignedCertificate -
        Returns:
        the current UpdateCompanyWebhookRequest instance, allowing for method chaining
      • getAcceptsSelfSignedCertificate

        public Boolean getAcceptsSelfSignedCertificate()
        Indicates if self-signed SSL certificates are accepted. Default value: **false**.
        Returns:
        acceptsSelfSignedCertificate
      • setAcceptsSelfSignedCertificate

        public void setAcceptsSelfSignedCertificate​(Boolean acceptsSelfSignedCertificate)
        Indicates if self-signed SSL certificates are accepted. Default value: **false**.
        Parameters:
        acceptsSelfSignedCertificate -
      • acceptsUntrustedRootCertificate

        public UpdateCompanyWebhookRequest acceptsUntrustedRootCertificate​(Boolean acceptsUntrustedRootCertificate)
        Indicates if untrusted SSL certificates are accepted. Default value: **false**.
        Parameters:
        acceptsUntrustedRootCertificate -
        Returns:
        the current UpdateCompanyWebhookRequest instance, allowing for method chaining
      • getAcceptsUntrustedRootCertificate

        public Boolean getAcceptsUntrustedRootCertificate()
        Indicates if untrusted SSL certificates are accepted. Default value: **false**.
        Returns:
        acceptsUntrustedRootCertificate
      • setAcceptsUntrustedRootCertificate

        public void setAcceptsUntrustedRootCertificate​(Boolean acceptsUntrustedRootCertificate)
        Indicates if untrusted SSL certificates are accepted. Default value: **false**.
        Parameters:
        acceptsUntrustedRootCertificate -
      • active

        public UpdateCompanyWebhookRequest active​(Boolean active)
        Indicates if the webhook configuration is active. The field must be **true** for us to send webhooks about events related an account.
        Parameters:
        active -
        Returns:
        the current UpdateCompanyWebhookRequest instance, allowing for method chaining
      • getActive

        public Boolean getActive()
        Indicates if the webhook configuration is active. The field must be **true** for us to send webhooks about events related an account.
        Returns:
        active
      • setActive

        public void setActive​(Boolean active)
        Indicates if the webhook configuration is active. The field must be **true** for us to send webhooks about events related an account.
        Parameters:
        active -
      • additionalSettings

        public UpdateCompanyWebhookRequest additionalSettings​(AdditionalSettings additionalSettings)
        additionalSettings
        Parameters:
        additionalSettings -
        Returns:
        the current UpdateCompanyWebhookRequest instance, allowing for method chaining
      • getAdditionalSettings

        public AdditionalSettings getAdditionalSettings()
        additionalSettings
        Returns:
        additionalSettings
      • setAdditionalSettings

        public void setAdditionalSettings​(AdditionalSettings additionalSettings)
        additionalSettings
        Parameters:
        additionalSettings -
      • setCommunicationFormat

        public void setCommunicationFormat​(UpdateCompanyWebhookRequest.CommunicationFormatEnum communicationFormat)
        Format or protocol for receiving webhooks. Possible values: * **soap** * **http** * **json**
        Parameters:
        communicationFormat -
      • description

        public UpdateCompanyWebhookRequest description​(String description)
        Your description for this webhook configuration.
        Parameters:
        description -
        Returns:
        the current UpdateCompanyWebhookRequest instance, allowing for method chaining
      • getDescription

        public String getDescription()
        Your description for this webhook configuration.
        Returns:
        description
      • setDescription

        public void setDescription​(String description)
        Your description for this webhook configuration.
        Parameters:
        description -
      • encryptionProtocol

        public UpdateCompanyWebhookRequest encryptionProtocol​(UpdateCompanyWebhookRequest.EncryptionProtocolEnum encryptionProtocol)
        SSL version to access the public webhook URL specified in the `url` field. Possible values: * **TLSv1.3** * **TLSv1.2** * **HTTP** - Only allowed on Test environment. If not specified, the webhook will use `sslVersion`: **TLSv1.2**.
        Parameters:
        encryptionProtocol -
        Returns:
        the current UpdateCompanyWebhookRequest instance, allowing for method chaining
      • getEncryptionProtocol

        public UpdateCompanyWebhookRequest.EncryptionProtocolEnum getEncryptionProtocol()
        SSL version to access the public webhook URL specified in the `url` field. Possible values: * **TLSv1.3** * **TLSv1.2** * **HTTP** - Only allowed on Test environment. If not specified, the webhook will use `sslVersion`: **TLSv1.2**.
        Returns:
        encryptionProtocol
      • setEncryptionProtocol

        public void setEncryptionProtocol​(UpdateCompanyWebhookRequest.EncryptionProtocolEnum encryptionProtocol)
        SSL version to access the public webhook URL specified in the `url` field. Possible values: * **TLSv1.3** * **TLSv1.2** * **HTTP** - Only allowed on Test environment. If not specified, the webhook will use `sslVersion`: **TLSv1.2**.
        Parameters:
        encryptionProtocol -
      • filterMerchantAccountType

        public UpdateCompanyWebhookRequest filterMerchantAccountType​(UpdateCompanyWebhookRequest.FilterMerchantAccountTypeEnum filterMerchantAccountType)
        Shows how merchant accounts are filtered when configuring the webhook. Possible values: * **includeAccounts**: The webhook is configured for the merchant accounts listed in `filterMerchantAccounts`. * **excludeAccounts**: The webhook is not configured for the merchant accounts listed in `filterMerchantAccounts`. * **allAccounts**: Includes all merchant accounts, and does not require specifying `filterMerchantAccounts`.
        Parameters:
        filterMerchantAccountType -
        Returns:
        the current UpdateCompanyWebhookRequest instance, allowing for method chaining
      • getFilterMerchantAccountType

        public UpdateCompanyWebhookRequest.FilterMerchantAccountTypeEnum getFilterMerchantAccountType()
        Shows how merchant accounts are filtered when configuring the webhook. Possible values: * **includeAccounts**: The webhook is configured for the merchant accounts listed in `filterMerchantAccounts`. * **excludeAccounts**: The webhook is not configured for the merchant accounts listed in `filterMerchantAccounts`. * **allAccounts**: Includes all merchant accounts, and does not require specifying `filterMerchantAccounts`.
        Returns:
        filterMerchantAccountType
      • setFilterMerchantAccountType

        public void setFilterMerchantAccountType​(UpdateCompanyWebhookRequest.FilterMerchantAccountTypeEnum filterMerchantAccountType)
        Shows how merchant accounts are filtered when configuring the webhook. Possible values: * **includeAccounts**: The webhook is configured for the merchant accounts listed in `filterMerchantAccounts`. * **excludeAccounts**: The webhook is not configured for the merchant accounts listed in `filterMerchantAccounts`. * **allAccounts**: Includes all merchant accounts, and does not require specifying `filterMerchantAccounts`.
        Parameters:
        filterMerchantAccountType -
      • filterMerchantAccounts

        public UpdateCompanyWebhookRequest filterMerchantAccounts​(List<String> filterMerchantAccounts)
        A list of merchant account names that are included or excluded from receiving the webhook. Inclusion or exclusion is based on the value defined for `filterMerchantAccountType`. Required if `filterMerchantAccountType` is either: * **includeAccounts** * **excludeAccounts** Not needed for `filterMerchantAccountType`: **allAccounts**.
        Parameters:
        filterMerchantAccounts -
        Returns:
        the current UpdateCompanyWebhookRequest instance, allowing for method chaining
      • getFilterMerchantAccounts

        public List<String> getFilterMerchantAccounts()
        A list of merchant account names that are included or excluded from receiving the webhook. Inclusion or exclusion is based on the value defined for `filterMerchantAccountType`. Required if `filterMerchantAccountType` is either: * **includeAccounts** * **excludeAccounts** Not needed for `filterMerchantAccountType`: **allAccounts**.
        Returns:
        filterMerchantAccounts
      • setFilterMerchantAccounts

        public void setFilterMerchantAccounts​(List<String> filterMerchantAccounts)
        A list of merchant account names that are included or excluded from receiving the webhook. Inclusion or exclusion is based on the value defined for `filterMerchantAccountType`. Required if `filterMerchantAccountType` is either: * **includeAccounts** * **excludeAccounts** Not needed for `filterMerchantAccountType`: **allAccounts**.
        Parameters:
        filterMerchantAccounts -
      • networkType

        public UpdateCompanyWebhookRequest networkType​(UpdateCompanyWebhookRequest.NetworkTypeEnum networkType)
        Network type for Terminal API notification webhooks. Possible values: * **public** * **local** Default Value: **public**.
        Parameters:
        networkType -
        Returns:
        the current UpdateCompanyWebhookRequest instance, allowing for method chaining
      • getNetworkType

        public UpdateCompanyWebhookRequest.NetworkTypeEnum getNetworkType()
        Network type for Terminal API notification webhooks. Possible values: * **public** * **local** Default Value: **public**.
        Returns:
        networkType
      • setNetworkType

        public void setNetworkType​(UpdateCompanyWebhookRequest.NetworkTypeEnum networkType)
        Network type for Terminal API notification webhooks. Possible values: * **public** * **local** Default Value: **public**.
        Parameters:
        networkType -
      • password

        public UpdateCompanyWebhookRequest password​(String password)
        Password to access the webhook URL.
        Parameters:
        password -
        Returns:
        the current UpdateCompanyWebhookRequest instance, allowing for method chaining
      • getPassword

        public String getPassword()
        Password to access the webhook URL.
        Returns:
        password
      • setPassword

        public void setPassword​(String password)
        Password to access the webhook URL.
        Parameters:
        password -
      • populateSoapActionHeader

        public UpdateCompanyWebhookRequest populateSoapActionHeader​(Boolean populateSoapActionHeader)
        Indicates if the SOAP action header needs to be populated. Default value: **false**. Only applies if `communicationFormat`: **soap**.
        Parameters:
        populateSoapActionHeader -
        Returns:
        the current UpdateCompanyWebhookRequest instance, allowing for method chaining
      • getPopulateSoapActionHeader

        public Boolean getPopulateSoapActionHeader()
        Indicates if the SOAP action header needs to be populated. Default value: **false**. Only applies if `communicationFormat`: **soap**.
        Returns:
        populateSoapActionHeader
      • setPopulateSoapActionHeader

        public void setPopulateSoapActionHeader​(Boolean populateSoapActionHeader)
        Indicates if the SOAP action header needs to be populated. Default value: **false**. Only applies if `communicationFormat`: **soap**.
        Parameters:
        populateSoapActionHeader -
      • url

        public UpdateCompanyWebhookRequest url​(String url)
        Public URL where webhooks will be sent, for example **https://www.domain.com/webhook-endpoint**.
        Parameters:
        url -
        Returns:
        the current UpdateCompanyWebhookRequest instance, allowing for method chaining
      • getUrl

        public String getUrl()
        Public URL where webhooks will be sent, for example **https://www.domain.com/webhook-endpoint**.
        Returns:
        url
      • setUrl

        public void setUrl​(String url)
        Public URL where webhooks will be sent, for example **https://www.domain.com/webhook-endpoint**.
        Parameters:
        url -
      • username

        public UpdateCompanyWebhookRequest username​(String username)
        Username to access the webhook URL.
        Parameters:
        username -
        Returns:
        the current UpdateCompanyWebhookRequest instance, allowing for method chaining
      • getUsername

        public String getUsername()
        Username to access the webhook URL.
        Returns:
        username
      • setUsername

        public void setUsername​(String username)
        Username to access the webhook URL.
        Parameters:
        username -
      • equals

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

        public int hashCode()
        Overrides:
        hashCode in class Object
      • fromJson

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

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