Package com.adyen.model.management
Class CreateCompanyWebhookRequest
- java.lang.Object
-
- com.adyen.model.management.CreateCompanyWebhookRequest
-
public class CreateCompanyWebhookRequest extends Object
CreateCompanyWebhookRequest
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classCreateCompanyWebhookRequest.CommunicationFormatEnumFormat or protocol for receiving webhooks.static classCreateCompanyWebhookRequest.CustomTypeAdapterFactorystatic classCreateCompanyWebhookRequest.FilterMerchantAccountTypeEnumShows how merchant accounts are filtered when configuring the webhook.static classCreateCompanyWebhookRequest.NetworkTypeEnumNetwork type for Terminal API notification webhooks.static classCreateCompanyWebhookRequest.SslVersionEnumSSL version to access the public webhook URL specified in the `url` field.
-
Field Summary
Fields Modifier and Type Field Description static HashSet<String>openapiFieldsstatic HashSet<String>openapiRequiredFieldsstatic StringSERIALIZED_NAME_ACCEPTS_EXPIRED_CERTIFICATEstatic StringSERIALIZED_NAME_ACCEPTS_SELF_SIGNED_CERTIFICATEstatic StringSERIALIZED_NAME_ACCEPTS_UNTRUSTED_ROOT_CERTIFICATEstatic StringSERIALIZED_NAME_ACTIVEstatic StringSERIALIZED_NAME_ADDITIONAL_SETTINGSstatic StringSERIALIZED_NAME_COMMUNICATION_FORMATstatic StringSERIALIZED_NAME_DESCRIPTIONstatic StringSERIALIZED_NAME_FILTER_MERCHANT_ACCOUNT_TYPEstatic StringSERIALIZED_NAME_FILTER_MERCHANT_ACCOUNTSstatic StringSERIALIZED_NAME_NETWORK_TYPEstatic StringSERIALIZED_NAME_PASSWORDstatic StringSERIALIZED_NAME_POPULATE_SOAP_ACTION_HEADERstatic StringSERIALIZED_NAME_SSL_VERSIONstatic StringSERIALIZED_NAME_TYPEstatic StringSERIALIZED_NAME_URLstatic StringSERIALIZED_NAME_USERNAME
-
Constructor Summary
Constructors Constructor Description CreateCompanyWebhookRequest()
-
Method Summary
-
-
-
Field Detail
-
SERIALIZED_NAME_ACCEPTS_EXPIRED_CERTIFICATE
public static final String SERIALIZED_NAME_ACCEPTS_EXPIRED_CERTIFICATE
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_ACCEPTS_SELF_SIGNED_CERTIFICATE
public static final String SERIALIZED_NAME_ACCEPTS_SELF_SIGNED_CERTIFICATE
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_ACCEPTS_UNTRUSTED_ROOT_CERTIFICATE
public static final String SERIALIZED_NAME_ACCEPTS_UNTRUSTED_ROOT_CERTIFICATE
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_ACTIVE
public static final String SERIALIZED_NAME_ACTIVE
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_ADDITIONAL_SETTINGS
public static final String SERIALIZED_NAME_ADDITIONAL_SETTINGS
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_COMMUNICATION_FORMAT
public static final String SERIALIZED_NAME_COMMUNICATION_FORMAT
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_DESCRIPTION
public static final String SERIALIZED_NAME_DESCRIPTION
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_FILTER_MERCHANT_ACCOUNT_TYPE
public static final String SERIALIZED_NAME_FILTER_MERCHANT_ACCOUNT_TYPE
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_FILTER_MERCHANT_ACCOUNTS
public static final String SERIALIZED_NAME_FILTER_MERCHANT_ACCOUNTS
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_NETWORK_TYPE
public static final String SERIALIZED_NAME_NETWORK_TYPE
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_PASSWORD
public static final String SERIALIZED_NAME_PASSWORD
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_POPULATE_SOAP_ACTION_HEADER
public static final String SERIALIZED_NAME_POPULATE_SOAP_ACTION_HEADER
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_SSL_VERSION
public static final String SERIALIZED_NAME_SSL_VERSION
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_TYPE
public static final String SERIALIZED_NAME_TYPE
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_URL
public static final String SERIALIZED_NAME_URL
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_USERNAME
public static final String SERIALIZED_NAME_USERNAME
- See Also:
- Constant Field Values
-
-
Method Detail
-
acceptsExpiredCertificate
public CreateCompanyWebhookRequest acceptsExpiredCertificate(Boolean acceptsExpiredCertificate)
-
getAcceptsExpiredCertificate
public Boolean getAcceptsExpiredCertificate()
Indicates if expired SSL certificates are accepted. Default value: **false**.- Returns:
- acceptsExpiredCertificate
-
setAcceptsExpiredCertificate
public void setAcceptsExpiredCertificate(Boolean acceptsExpiredCertificate)
-
acceptsSelfSignedCertificate
public CreateCompanyWebhookRequest acceptsSelfSignedCertificate(Boolean acceptsSelfSignedCertificate)
-
getAcceptsSelfSignedCertificate
public Boolean getAcceptsSelfSignedCertificate()
Indicates if self-signed SSL certificates are accepted. Default value: **false**.- Returns:
- acceptsSelfSignedCertificate
-
setAcceptsSelfSignedCertificate
public void setAcceptsSelfSignedCertificate(Boolean acceptsSelfSignedCertificate)
-
acceptsUntrustedRootCertificate
public CreateCompanyWebhookRequest acceptsUntrustedRootCertificate(Boolean acceptsUntrustedRootCertificate)
-
getAcceptsUntrustedRootCertificate
public Boolean getAcceptsUntrustedRootCertificate()
Indicates if untrusted SSL certificates are accepted. Default value: **false**.- Returns:
- acceptsUntrustedRootCertificate
-
setAcceptsUntrustedRootCertificate
public void setAcceptsUntrustedRootCertificate(Boolean acceptsUntrustedRootCertificate)
-
active
public CreateCompanyWebhookRequest active(Boolean active)
-
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)
-
additionalSettings
public CreateCompanyWebhookRequest additionalSettings(AdditionalSettings additionalSettings)
-
getAdditionalSettings
public AdditionalSettings getAdditionalSettings()
Get additionalSettings- Returns:
- additionalSettings
-
setAdditionalSettings
public void setAdditionalSettings(AdditionalSettings additionalSettings)
-
communicationFormat
public CreateCompanyWebhookRequest communicationFormat(CreateCompanyWebhookRequest.CommunicationFormatEnum communicationFormat)
-
getCommunicationFormat
public CreateCompanyWebhookRequest.CommunicationFormatEnum getCommunicationFormat()
Format or protocol for receiving webhooks. Possible values: * **soap** * **http** * **json**- Returns:
- communicationFormat
-
setCommunicationFormat
public void setCommunicationFormat(CreateCompanyWebhookRequest.CommunicationFormatEnum communicationFormat)
-
description
public CreateCompanyWebhookRequest description(String description)
-
getDescription
public String getDescription()
Your description for this webhook configuration.- Returns:
- description
-
setDescription
public void setDescription(String description)
-
filterMerchantAccountType
public CreateCompanyWebhookRequest filterMerchantAccountType(CreateCompanyWebhookRequest.FilterMerchantAccountTypeEnum filterMerchantAccountType)
-
getFilterMerchantAccountType
public CreateCompanyWebhookRequest.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(CreateCompanyWebhookRequest.FilterMerchantAccountTypeEnum filterMerchantAccountType)
-
filterMerchantAccounts
public CreateCompanyWebhookRequest filterMerchantAccounts(List<String> filterMerchantAccounts)
-
addFilterMerchantAccountsItem
public CreateCompanyWebhookRequest addFilterMerchantAccountsItem(String filterMerchantAccountsItem)
-
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)
-
networkType
public CreateCompanyWebhookRequest networkType(CreateCompanyWebhookRequest.NetworkTypeEnum networkType)
-
getNetworkType
public CreateCompanyWebhookRequest.NetworkTypeEnum getNetworkType()
Network type for Terminal API notification webhooks. Possible values: * **public** * **local** Default Value: **public**.- Returns:
- networkType
-
setNetworkType
public void setNetworkType(CreateCompanyWebhookRequest.NetworkTypeEnum networkType)
-
password
public CreateCompanyWebhookRequest password(String password)
-
getPassword
public String getPassword()
Password to access the webhook URL.- Returns:
- password
-
setPassword
public void setPassword(String password)
-
populateSoapActionHeader
public CreateCompanyWebhookRequest populateSoapActionHeader(Boolean populateSoapActionHeader)
-
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)
-
sslVersion
public CreateCompanyWebhookRequest sslVersion(CreateCompanyWebhookRequest.SslVersionEnum sslVersion)
-
getSslVersion
public CreateCompanyWebhookRequest.SslVersionEnum getSslVersion()
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:
- sslVersion
-
setSslVersion
public void setSslVersion(CreateCompanyWebhookRequest.SslVersionEnum sslVersion)
-
type
public CreateCompanyWebhookRequest type(String type)
-
getType
public String getType()
The type of webhook that is being created. Possible values are: - **standard** - **account-settings-notification** - **banktransfer-notification** - **boletobancario-notification** - **directdebit-notification** - **pending-notification** - **ideal-notification** - **ideal-pending-notification** - **report-notification** - **rreq-notification** Find out more about [standard notification webhooks](https://docs.adyen.com/development-resources/webhooks/understand-notifications#event-codes) and [other types of notifications](https://docs.adyen.com/development-resources/webhooks/understand-notifications#other-notifications).- Returns:
- type
-
setType
public void setType(String type)
-
url
public CreateCompanyWebhookRequest url(String url)
-
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)
-
username
public CreateCompanyWebhookRequest username(String username)
-
getUsername
public String getUsername()
Username to access the webhook URL.- 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 CreateCompanyWebhookRequest
-
fromJson
public static CreateCompanyWebhookRequest fromJson(String jsonString) throws IOException
Create an instance of CreateCompanyWebhookRequest given an JSON string- Parameters:
jsonString- JSON string- Returns:
- An instance of CreateCompanyWebhookRequest
- Throws:
IOException- if the JSON string is invalid with respect to CreateCompanyWebhookRequest
-
toJson
public String toJson()
Convert an instance of CreateCompanyWebhookRequest to an JSON string- Returns:
- JSON string
-
-