Class GetTermsOfServiceDocumentResponse
- java.lang.Object
-
- com.adyen.model.legalentitymanagement.GetTermsOfServiceDocumentResponse
-
public class GetTermsOfServiceDocumentResponse extends Object
GetTermsOfServiceDocumentResponse
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classGetTermsOfServiceDocumentResponse.TypeEnumThe type of Terms of Service.
-
Field Summary
Fields Modifier and Type Field Description static StringJSON_PROPERTY_DOCUMENTstatic StringJSON_PROPERTY_IDstatic StringJSON_PROPERTY_LANGUAGEstatic StringJSON_PROPERTY_TERMS_OF_SERVICE_DOCUMENT_FORMATstatic StringJSON_PROPERTY_TERMS_OF_SERVICE_DOCUMENT_IDstatic StringJSON_PROPERTY_TYPE
-
Constructor Summary
Constructors Constructor Description GetTermsOfServiceDocumentResponse()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description GetTermsOfServiceDocumentResponsedocument(byte[] document)The Terms of Service document in Base64-encoded format.booleanequals(Object o)Return true if this GetTermsOfServiceDocumentResponse object is equal to o.static GetTermsOfServiceDocumentResponsefromJson(String jsonString)Create an instance of GetTermsOfServiceDocumentResponse given an JSON stringbyte[]getDocument()The Terms of Service document in Base64-encoded format.Map<String,Object>getExplicitNulls()Returns a map of properties to be merged into the JSON payload as explicit null values.StringgetId()The unique identifier of the legal entity.StringgetLanguage()The language used for the Terms of Service document, specified by the two-letter [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) language code.StringgetTermsOfServiceDocumentFormat()The format of the Terms of Service document.StringgetTermsOfServiceDocumentId()The unique identifier of the Terms of Service document.GetTermsOfServiceDocumentResponse.TypeEnumgetType()The type of Terms of Service.inthashCode()GetTermsOfServiceDocumentResponseid(String id)The unique identifier of the legal entity.GetTermsOfServiceDocumentResponseincludeNullValues(boolean includeNullValues)Configures whether null values are explicitly serialized in the JSON payload.booleanisIncludeNullValues()Returns whether null values are explicitly serialized in the JSON payload.GetTermsOfServiceDocumentResponselanguage(String language)The language used for the Terms of Service document, specified by the two-letter [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) language code.voidsetDocument(byte[] document)The Terms of Service document in Base64-encoded format.voidsetId(String id)The unique identifier of the legal entity.voidsetIncludeNullValues(boolean includeNullValues)Sets whether null values should be explicitly serialized in the JSON payload.voidsetLanguage(String language)The language used for the Terms of Service document, specified by the two-letter [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) language code.voidsetTermsOfServiceDocumentFormat(String termsOfServiceDocumentFormat)The format of the Terms of Service document.voidsetTermsOfServiceDocumentId(String termsOfServiceDocumentId)The unique identifier of the Terms of Service document.voidsetType(GetTermsOfServiceDocumentResponse.TypeEnum type)The type of Terms of Service.GetTermsOfServiceDocumentResponsetermsOfServiceDocumentFormat(String termsOfServiceDocumentFormat)The format of the Terms of Service document.GetTermsOfServiceDocumentResponsetermsOfServiceDocumentId(String termsOfServiceDocumentId)The unique identifier of the Terms of Service document.StringtoJson()Convert an instance of GetTermsOfServiceDocumentResponse to an JSON stringStringtoString()GetTermsOfServiceDocumentResponsetype(GetTermsOfServiceDocumentResponse.TypeEnum type)The type of Terms of Service.
-
-
-
Field Detail
-
JSON_PROPERTY_DOCUMENT
public static final String JSON_PROPERTY_DOCUMENT
- See Also:
- Constant Field Values
-
JSON_PROPERTY_ID
public static final String JSON_PROPERTY_ID
- See Also:
- Constant Field Values
-
JSON_PROPERTY_LANGUAGE
public static final String JSON_PROPERTY_LANGUAGE
- See Also:
- Constant Field Values
-
JSON_PROPERTY_TERMS_OF_SERVICE_DOCUMENT_FORMAT
public static final String JSON_PROPERTY_TERMS_OF_SERVICE_DOCUMENT_FORMAT
- See Also:
- Constant Field Values
-
JSON_PROPERTY_TERMS_OF_SERVICE_DOCUMENT_ID
public static final String JSON_PROPERTY_TERMS_OF_SERVICE_DOCUMENT_ID
- See Also:
- Constant Field Values
-
JSON_PROPERTY_TYPE
public static final String JSON_PROPERTY_TYPE
- See Also:
- Constant Field Values
-
-
Method Detail
-
document
public GetTermsOfServiceDocumentResponse document(byte[] document)
The Terms of Service document in Base64-encoded format.- Parameters:
document- The Terms of Service document in Base64-encoded format.- Returns:
- the current
GetTermsOfServiceDocumentResponseinstance, allowing for method chaining
-
getDocument
public byte[] getDocument()
The Terms of Service document in Base64-encoded format.- Returns:
- document The Terms of Service document in Base64-encoded format.
-
setDocument
public void setDocument(byte[] document)
The Terms of Service document in Base64-encoded format.- Parameters:
document- The Terms of Service document in Base64-encoded format.
-
id
public GetTermsOfServiceDocumentResponse id(String id)
The unique identifier of the legal entity.- Parameters:
id- The unique identifier of the legal entity.- Returns:
- the current
GetTermsOfServiceDocumentResponseinstance, allowing for method chaining
-
getId
public String getId()
The unique identifier of the legal entity.- Returns:
- id The unique identifier of the legal entity.
-
setId
public void setId(String id)
The unique identifier of the legal entity.- Parameters:
id- The unique identifier of the legal entity.
-
language
public GetTermsOfServiceDocumentResponse language(String language)
The language used for the Terms of Service document, specified by the two-letter [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) language code. Possible value: **en** for English or **fr** for French. Note that French is only available for some integration types in certain countries/regions. Reach out to your Adyen contact for more information.- Parameters:
language- The language used for the Terms of Service document, specified by the two-letter [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) language code. Possible value: **en** for English or **fr** for French. Note that French is only available for some integration types in certain countries/regions. Reach out to your Adyen contact for more information.- Returns:
- the current
GetTermsOfServiceDocumentResponseinstance, allowing for method chaining
-
getLanguage
public String getLanguage()
The language used for the Terms of Service document, specified by the two-letter [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) language code. Possible value: **en** for English or **fr** for French. Note that French is only available for some integration types in certain countries/regions. Reach out to your Adyen contact for more information.- Returns:
- language The language used for the Terms of Service document, specified by the two-letter [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) language code. Possible value: **en** for English or **fr** for French. Note that French is only available for some integration types in certain countries/regions. Reach out to your Adyen contact for more information.
-
setLanguage
public void setLanguage(String language)
The language used for the Terms of Service document, specified by the two-letter [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) language code. Possible value: **en** for English or **fr** for French. Note that French is only available for some integration types in certain countries/regions. Reach out to your Adyen contact for more information.- Parameters:
language- The language used for the Terms of Service document, specified by the two-letter [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) language code. Possible value: **en** for English or **fr** for French. Note that French is only available for some integration types in certain countries/regions. Reach out to your Adyen contact for more information.
-
termsOfServiceDocumentFormat
public GetTermsOfServiceDocumentResponse termsOfServiceDocumentFormat(String termsOfServiceDocumentFormat)
The format of the Terms of Service document.- Parameters:
termsOfServiceDocumentFormat- The format of the Terms of Service document.- Returns:
- the current
GetTermsOfServiceDocumentResponseinstance, allowing for method chaining
-
getTermsOfServiceDocumentFormat
public String getTermsOfServiceDocumentFormat()
The format of the Terms of Service document.- Returns:
- termsOfServiceDocumentFormat The format of the Terms of Service document.
-
setTermsOfServiceDocumentFormat
public void setTermsOfServiceDocumentFormat(String termsOfServiceDocumentFormat)
The format of the Terms of Service document.- Parameters:
termsOfServiceDocumentFormat- The format of the Terms of Service document.
-
termsOfServiceDocumentId
public GetTermsOfServiceDocumentResponse termsOfServiceDocumentId(String termsOfServiceDocumentId)
The unique identifier of the Terms of Service document.- Parameters:
termsOfServiceDocumentId- The unique identifier of the Terms of Service document.- Returns:
- the current
GetTermsOfServiceDocumentResponseinstance, allowing for method chaining
-
getTermsOfServiceDocumentId
public String getTermsOfServiceDocumentId()
The unique identifier of the Terms of Service document.- Returns:
- termsOfServiceDocumentId The unique identifier of the Terms of Service document.
-
setTermsOfServiceDocumentId
public void setTermsOfServiceDocumentId(String termsOfServiceDocumentId)
The unique identifier of the Terms of Service document.- Parameters:
termsOfServiceDocumentId- The unique identifier of the Terms of Service document.
-
type
public GetTermsOfServiceDocumentResponse type(GetTermsOfServiceDocumentResponse.TypeEnum type)
The type of Terms of Service. Possible values: * **adyenForPlatformsManage** * **adyenIssuing** * **adyenForPlatformsAdvanced** * **adyenCapital** * **adyenAccount** * **adyenCard** * **adyenFranchisee** * **adyenPccr** * **adyenChargeCard** * **kycOnInvite**- Parameters:
type- The type of Terms of Service. Possible values: * **adyenForPlatformsManage** * **adyenIssuing** * **adyenForPlatformsAdvanced** * **adyenCapital** * **adyenAccount** * **adyenCard** * **adyenFranchisee** * **adyenPccr** * **adyenChargeCard** * **kycOnInvite**- Returns:
- the current
GetTermsOfServiceDocumentResponseinstance, allowing for method chaining
-
getType
public GetTermsOfServiceDocumentResponse.TypeEnum getType()
The type of Terms of Service. Possible values: * **adyenForPlatformsManage** * **adyenIssuing** * **adyenForPlatformsAdvanced** * **adyenCapital** * **adyenAccount** * **adyenCard** * **adyenFranchisee** * **adyenPccr** * **adyenChargeCard** * **kycOnInvite**- Returns:
- type The type of Terms of Service. Possible values: * **adyenForPlatformsManage** * **adyenIssuing** * **adyenForPlatformsAdvanced** * **adyenCapital** * **adyenAccount** * **adyenCard** * **adyenFranchisee** * **adyenPccr** * **adyenChargeCard** * **kycOnInvite**
-
setType
public void setType(GetTermsOfServiceDocumentResponse.TypeEnum type)
The type of Terms of Service. Possible values: * **adyenForPlatformsManage** * **adyenIssuing** * **adyenForPlatformsAdvanced** * **adyenCapital** * **adyenAccount** * **adyenCard** * **adyenFranchisee** * **adyenPccr** * **adyenChargeCard** * **kycOnInvite**- Parameters:
type- The type of Terms of Service. Possible values: * **adyenForPlatformsManage** * **adyenIssuing** * **adyenForPlatformsAdvanced** * **adyenCapital** * **adyenAccount** * **adyenCard** * **adyenFranchisee** * **adyenPccr** * **adyenChargeCard** * **kycOnInvite**
-
includeNullValues
public GetTermsOfServiceDocumentResponse includeNullValues(boolean includeNullValues)
Configures whether null values are explicitly serialized in the JSON payload. Default is false.
-
isIncludeNullValues
public boolean isIncludeNullValues()
Returns whether null values are explicitly serialized in the JSON payload.
-
setIncludeNullValues
public void setIncludeNullValues(boolean includeNullValues)
Sets whether null values should be explicitly serialized in the JSON payload. Default is false.
-
equals
public boolean equals(Object o)
Return true if this GetTermsOfServiceDocumentResponse object is equal to o.
-
getExplicitNulls
public Map<String,Object> getExplicitNulls()
Returns a map of properties to be merged into the JSON payload as explicit null values.
-
fromJson
public static GetTermsOfServiceDocumentResponse fromJson(String jsonString) throws com.fasterxml.jackson.core.JsonProcessingException
Create an instance of GetTermsOfServiceDocumentResponse given an JSON string- Parameters:
jsonString- JSON string- Returns:
- An instance of GetTermsOfServiceDocumentResponse
- Throws:
com.fasterxml.jackson.core.JsonProcessingException- if the JSON string is invalid with respect to GetTermsOfServiceDocumentResponse
-
toJson
public String toJson() throws com.fasterxml.jackson.core.JsonProcessingException
Convert an instance of GetTermsOfServiceDocumentResponse to an JSON string- Returns:
- JSON string
- Throws:
com.fasterxml.jackson.core.JsonProcessingException
-
-