Documentation

ConsumerDisclosure
in package
implements ModelInterface, ArrayAccess

ConsumerDisclosure Class Doc Comment

Tags
category

Class

description

Details about consumer disclosures.

author

Swagger Codegen team apihelp@docusign.com

license

The Docusign PHP Client SDK is licensed under the MIT License.

link
https://github.com/swagger-api/swagger-codegen

Interfaces, Classes, Traits and Enums

ModelInterface
Interface abstracting model access.
ArrayAccess

Table of Contents

DISCRIMINATOR  = null
$attributeMap  : array<string|int, string>
Array of attributes where the key is the local name, and the value is the original name
$container  : array<string|int, mixed>
Associative array for storing property values
$getters  : array<string|int, string>
Array of attributes to getter functions (for serialization of requests)
$setters  : array<string|int, string>
Array of attributes to setter functions (for deserialization of responses)
$swaggerFormats  : array<string|int, string>
Array of property to format mappings. Used for (de)serialization
$swaggerModelName  : string
The original name of the model.
$swaggerTypes  : array<string|int, string>
Array of property to type mappings. Used for (de)serialization
__construct()  : mixed
Constructor
__toString()  : string
Gets the string presentation of the object
attributeMap()  : array<string|int, mixed>
Array of attributes where the key is the local name, and the value is the original name
getAccountEsignId()  : string|null
Gets account_esign_id
getAllowCdWithdraw()  : string|null
Gets allow_cd_withdraw
getAllowCdWithdrawMetadata()  : SettingsMetadata
Gets allow_cd_withdraw_metadata
getChangeEmail()  : string|null
Gets change_email
getChangeEmailOther()  : string|null
Gets change_email_other
getCompanyName()  : string|null
Gets company_name
getCompanyPhone()  : string|null
Gets company_phone
getCopyCostPerPage()  : string|null
Gets copy_cost_per_page
getCopyFeeCollectionMethod()  : string|null
Gets copy_fee_collection_method
getCopyRequestEmail()  : string|null
Gets copy_request_email
getCustom()  : string|null
Gets custom
getEnableEsign()  : string|null
Gets enable_esign
getEsignAgreement()  : string|null
Gets esign_agreement
getEsignText()  : string|null
Gets esign_text
getLanguageCode()  : string|null
Gets language_code
getModelName()  : string
The original name of the model.
getMustAgreeToEsign()  : string|null
Gets must_agree_to_esign
getPdfId()  : string|null
Gets pdf_id
getters()  : array<string|int, mixed>
Array of attributes to getter functions (for serialization of requests)
getUseBrand()  : string|null
Gets use_brand
getUseConsumerDisclosureWithinAccount()  : string|null
Gets use_consumer_disclosure_within_account
getUseConsumerDisclosureWithinAccountMetadata()  : SettingsMetadata
Gets use_consumer_disclosure_within_account_metadata
getWithdrawAddressLine1()  : string|null
Gets withdraw_address_line1
getWithdrawAddressLine2()  : string|null
Gets withdraw_address_line2
getWithdrawByEmail()  : string|null
Gets withdraw_by_email
getWithdrawByMail()  : string|null
Gets withdraw_by_mail
getWithdrawByPhone()  : string|null
Gets withdraw_by_phone
getWithdrawCity()  : string|null
Gets withdraw_city
getWithdrawConsequences()  : string|null
Gets withdraw_consequences
getWithdrawEmail()  : string|null
Gets withdraw_email
getWithdrawOther()  : string|null
Gets withdraw_other
getWithdrawPhone()  : string|null
Gets withdraw_phone
getWithdrawPostalCode()  : string|null
Gets withdraw_postal_code
getWithdrawState()  : string|null
Gets withdraw_state
listInvalidProperties()  : array<string|int, mixed>
Show all the invalid properties with reasons.
offsetExists()  : bool
Returns true if offset exists. False otherwise.
offsetGet()  : mixed
Gets offset.
offsetSet()  : void
Sets value based on offset.
offsetUnset()  : void
Unsets offset.
setAccountEsignId()  : $this
Sets account_esign_id
setAllowCdWithdraw()  : $this
Sets allow_cd_withdraw
setAllowCdWithdrawMetadata()  : $this
Sets allow_cd_withdraw_metadata
setChangeEmail()  : $this
Sets change_email
setChangeEmailOther()  : $this
Sets change_email_other
setCompanyName()  : $this
Sets company_name
setCompanyPhone()  : $this
Sets company_phone
setCopyCostPerPage()  : $this
Sets copy_cost_per_page
setCopyFeeCollectionMethod()  : $this
Sets copy_fee_collection_method
setCopyRequestEmail()  : $this
Sets copy_request_email
setCustom()  : $this
Sets custom
setEnableEsign()  : $this
Sets enable_esign
setEsignAgreement()  : $this
Sets esign_agreement
setEsignText()  : $this
Sets esign_text
setLanguageCode()  : $this
Sets language_code
setMustAgreeToEsign()  : $this
Sets must_agree_to_esign
setPdfId()  : $this
Sets pdf_id
setters()  : array<string|int, mixed>
Array of attributes to setter functions (for deserialization of responses)
setUseBrand()  : $this
Sets use_brand
setUseConsumerDisclosureWithinAccount()  : $this
Sets use_consumer_disclosure_within_account
setUseConsumerDisclosureWithinAccountMetadata()  : $this
Sets use_consumer_disclosure_within_account_metadata
setWithdrawAddressLine1()  : $this
Sets withdraw_address_line1
setWithdrawAddressLine2()  : $this
Sets withdraw_address_line2
setWithdrawByEmail()  : $this
Sets withdraw_by_email
setWithdrawByMail()  : $this
Sets withdraw_by_mail
setWithdrawByPhone()  : $this
Sets withdraw_by_phone
setWithdrawCity()  : $this
Sets withdraw_city
setWithdrawConsequences()  : $this
Sets withdraw_consequences
setWithdrawEmail()  : $this
Sets withdraw_email
setWithdrawOther()  : $this
Sets withdraw_other
setWithdrawPhone()  : $this
Sets withdraw_phone
setWithdrawPostalCode()  : $this
Sets withdraw_postal_code
setWithdrawState()  : $this
Sets withdraw_state
swaggerFormats()  : array<string|int, mixed>
Array of property to format mappings. Used for (de)serialization
swaggerTypes()  : array<string|int, mixed>
Array of property to type mappings. Used for (de)serialization
valid()  : bool
Validate all the properties in the model return true if all passed

Constants

Properties

$attributeMap

Array of attributes where the key is the local name, and the value is the original name

protected static array<string|int, string> $attributeMap = ['account_esign_id' => 'accountEsignId', 'allow_cd_withdraw' => 'allowCDWithdraw', 'allow_cd_withdraw_metadata' => 'allowCDWithdrawMetadata', 'change_email' => 'changeEmail', 'change_email_other' => 'changeEmailOther', 'company_name' => 'companyName', 'company_phone' => 'companyPhone', 'copy_cost_per_page' => 'copyCostPerPage', 'copy_fee_collection_method' => 'copyFeeCollectionMethod', 'copy_request_email' => 'copyRequestEmail', 'custom' => 'custom', 'enable_esign' => 'enableEsign', 'esign_agreement' => 'esignAgreement', 'esign_text' => 'esignText', 'language_code' => 'languageCode', 'must_agree_to_esign' => 'mustAgreeToEsign', 'pdf_id' => 'pdfId', 'use_brand' => 'useBrand', 'use_consumer_disclosure_within_account' => 'useConsumerDisclosureWithinAccount', 'use_consumer_disclosure_within_account_metadata' => 'useConsumerDisclosureWithinAccountMetadata', 'withdraw_address_line1' => 'withdrawAddressLine1', 'withdraw_address_line2' => 'withdrawAddressLine2', 'withdraw_by_email' => 'withdrawByEmail', 'withdraw_by_mail' => 'withdrawByMail', 'withdraw_by_phone' => 'withdrawByPhone', 'withdraw_city' => 'withdrawCity', 'withdraw_consequences' => 'withdrawConsequences', 'withdraw_email' => 'withdrawEmail', 'withdraw_other' => 'withdrawOther', 'withdraw_phone' => 'withdrawPhone', 'withdraw_postal_code' => 'withdrawPostalCode', 'withdraw_state' => 'withdrawState']

$container

Associative array for storing property values

protected array<string|int, mixed> $container = []

$getters

Array of attributes to getter functions (for serialization of requests)

protected static array<string|int, string> $getters = ['account_esign_id' => 'getAccountEsignId', 'allow_cd_withdraw' => 'getAllowCdWithdraw', 'allow_cd_withdraw_metadata' => 'getAllowCdWithdrawMetadata', 'change_email' => 'getChangeEmail', 'change_email_other' => 'getChangeEmailOther', 'company_name' => 'getCompanyName', 'company_phone' => 'getCompanyPhone', 'copy_cost_per_page' => 'getCopyCostPerPage', 'copy_fee_collection_method' => 'getCopyFeeCollectionMethod', 'copy_request_email' => 'getCopyRequestEmail', 'custom' => 'getCustom', 'enable_esign' => 'getEnableEsign', 'esign_agreement' => 'getEsignAgreement', 'esign_text' => 'getEsignText', 'language_code' => 'getLanguageCode', 'must_agree_to_esign' => 'getMustAgreeToEsign', 'pdf_id' => 'getPdfId', 'use_brand' => 'getUseBrand', 'use_consumer_disclosure_within_account' => 'getUseConsumerDisclosureWithinAccount', 'use_consumer_disclosure_within_account_metadata' => 'getUseConsumerDisclosureWithinAccountMetadata', 'withdraw_address_line1' => 'getWithdrawAddressLine1', 'withdraw_address_line2' => 'getWithdrawAddressLine2', 'withdraw_by_email' => 'getWithdrawByEmail', 'withdraw_by_mail' => 'getWithdrawByMail', 'withdraw_by_phone' => 'getWithdrawByPhone', 'withdraw_city' => 'getWithdrawCity', 'withdraw_consequences' => 'getWithdrawConsequences', 'withdraw_email' => 'getWithdrawEmail', 'withdraw_other' => 'getWithdrawOther', 'withdraw_phone' => 'getWithdrawPhone', 'withdraw_postal_code' => 'getWithdrawPostalCode', 'withdraw_state' => 'getWithdrawState']

$setters

Array of attributes to setter functions (for deserialization of responses)

protected static array<string|int, string> $setters = ['account_esign_id' => 'setAccountEsignId', 'allow_cd_withdraw' => 'setAllowCdWithdraw', 'allow_cd_withdraw_metadata' => 'setAllowCdWithdrawMetadata', 'change_email' => 'setChangeEmail', 'change_email_other' => 'setChangeEmailOther', 'company_name' => 'setCompanyName', 'company_phone' => 'setCompanyPhone', 'copy_cost_per_page' => 'setCopyCostPerPage', 'copy_fee_collection_method' => 'setCopyFeeCollectionMethod', 'copy_request_email' => 'setCopyRequestEmail', 'custom' => 'setCustom', 'enable_esign' => 'setEnableEsign', 'esign_agreement' => 'setEsignAgreement', 'esign_text' => 'setEsignText', 'language_code' => 'setLanguageCode', 'must_agree_to_esign' => 'setMustAgreeToEsign', 'pdf_id' => 'setPdfId', 'use_brand' => 'setUseBrand', 'use_consumer_disclosure_within_account' => 'setUseConsumerDisclosureWithinAccount', 'use_consumer_disclosure_within_account_metadata' => 'setUseConsumerDisclosureWithinAccountMetadata', 'withdraw_address_line1' => 'setWithdrawAddressLine1', 'withdraw_address_line2' => 'setWithdrawAddressLine2', 'withdraw_by_email' => 'setWithdrawByEmail', 'withdraw_by_mail' => 'setWithdrawByMail', 'withdraw_by_phone' => 'setWithdrawByPhone', 'withdraw_city' => 'setWithdrawCity', 'withdraw_consequences' => 'setWithdrawConsequences', 'withdraw_email' => 'setWithdrawEmail', 'withdraw_other' => 'setWithdrawOther', 'withdraw_phone' => 'setWithdrawPhone', 'withdraw_postal_code' => 'setWithdrawPostalCode', 'withdraw_state' => 'setWithdrawState']

$swaggerFormats

Array of property to format mappings. Used for (de)serialization

protected static array<string|int, string> $swaggerFormats = ['account_esign_id' => null, 'allow_cd_withdraw' => null, 'allow_cd_withdraw_metadata' => null, 'change_email' => null, 'change_email_other' => null, 'company_name' => null, 'company_phone' => null, 'copy_cost_per_page' => null, 'copy_fee_collection_method' => null, 'copy_request_email' => null, 'custom' => null, 'enable_esign' => null, 'esign_agreement' => null, 'esign_text' => null, 'language_code' => null, 'must_agree_to_esign' => null, 'pdf_id' => null, 'use_brand' => null, 'use_consumer_disclosure_within_account' => null, 'use_consumer_disclosure_within_account_metadata' => null, 'withdraw_address_line1' => null, 'withdraw_address_line2' => null, 'withdraw_by_email' => null, 'withdraw_by_mail' => null, 'withdraw_by_phone' => null, 'withdraw_city' => null, 'withdraw_consequences' => null, 'withdraw_email' => null, 'withdraw_other' => null, 'withdraw_phone' => null, 'withdraw_postal_code' => null, 'withdraw_state' => null]

$swaggerModelName

The original name of the model.

protected static string $swaggerModelName = 'consumerDisclosure'

$swaggerTypes

Array of property to type mappings. Used for (de)serialization

protected static array<string|int, string> $swaggerTypes = ['account_esign_id' => '?string', 'allow_cd_withdraw' => '?string', 'allow_cd_withdraw_metadata' => '\\DocuSign\\eSign\\Model\\SettingsMetadata', 'change_email' => '?string', 'change_email_other' => '?string', 'company_name' => '?string', 'company_phone' => '?string', 'copy_cost_per_page' => '?string', 'copy_fee_collection_method' => '?string', 'copy_request_email' => '?string', 'custom' => '?string', 'enable_esign' => '?string', 'esign_agreement' => '?string', 'esign_text' => '?string', 'language_code' => '?string', 'must_agree_to_esign' => '?string', 'pdf_id' => '?string', 'use_brand' => '?string', 'use_consumer_disclosure_within_account' => '?string', 'use_consumer_disclosure_within_account_metadata' => '\\DocuSign\\eSign\\Model\\SettingsMetadata', 'withdraw_address_line1' => '?string', 'withdraw_address_line2' => '?string', 'withdraw_by_email' => '?string', 'withdraw_by_mail' => '?string', 'withdraw_by_phone' => '?string', 'withdraw_city' => '?string', 'withdraw_consequences' => '?string', 'withdraw_email' => '?string', 'withdraw_other' => '?string', 'withdraw_phone' => '?string', 'withdraw_postal_code' => '?string', 'withdraw_state' => '?string']

Methods

__construct()

Constructor

public __construct([array<string|int, mixed> $data = null ]) : mixed
Parameters
$data : array<string|int, mixed> = null

Associated array of property values initializing the model

Return values
mixed —

__toString()

Gets the string presentation of the object

public __toString() : string
Return values
string —

attributeMap()

Array of attributes where the key is the local name, and the value is the original name

public static attributeMap() : array<string|int, mixed>
Return values
array<string|int, mixed> —

getAccountEsignId()

Gets account_esign_id

public getAccountEsignId() : string|null
Return values
string|null —

getAllowCdWithdraw()

Gets allow_cd_withdraw

public getAllowCdWithdraw() : string|null
Return values
string|null —

getChangeEmail()

Gets change_email

public getChangeEmail() : string|null
Return values
string|null —

getChangeEmailOther()

Gets change_email_other

public getChangeEmailOther() : string|null
Return values
string|null —

getCompanyName()

Gets company_name

public getCompanyName() : string|null
Return values
string|null —

getCompanyPhone()

Gets company_phone

public getCompanyPhone() : string|null
Return values
string|null —

getCopyCostPerPage()

Gets copy_cost_per_page

public getCopyCostPerPage() : string|null
Return values
string|null —

getCopyFeeCollectionMethod()

Gets copy_fee_collection_method

public getCopyFeeCollectionMethod() : string|null
Return values
string|null —

getCopyRequestEmail()

Gets copy_request_email

public getCopyRequestEmail() : string|null
Return values
string|null —

getCustom()

Gets custom

public getCustom() : string|null
Return values
string|null —

getEnableEsign()

Gets enable_esign

public getEnableEsign() : string|null
Return values
string|null —

getEsignAgreement()

Gets esign_agreement

public getEsignAgreement() : string|null
Return values
string|null —

getEsignText()

Gets esign_text

public getEsignText() : string|null
Return values
string|null —

getLanguageCode()

Gets language_code

public getLanguageCode() : string|null
Return values
string|null —

getModelName()

The original name of the model.

public getModelName() : string
Return values
string —

getMustAgreeToEsign()

Gets must_agree_to_esign

public getMustAgreeToEsign() : string|null
Return values
string|null —

getPdfId()

Gets pdf_id

public getPdfId() : string|null
Return values
string|null —

getters()

Array of attributes to getter functions (for serialization of requests)

public static getters() : array<string|int, mixed>
Return values
array<string|int, mixed> —

getUseBrand()

Gets use_brand

public getUseBrand() : string|null
Return values
string|null —

getUseConsumerDisclosureWithinAccount()

Gets use_consumer_disclosure_within_account

public getUseConsumerDisclosureWithinAccount() : string|null
Return values
string|null —

getWithdrawAddressLine1()

Gets withdraw_address_line1

public getWithdrawAddressLine1() : string|null
Return values
string|null —

getWithdrawAddressLine2()

Gets withdraw_address_line2

public getWithdrawAddressLine2() : string|null
Return values
string|null —

getWithdrawByEmail()

Gets withdraw_by_email

public getWithdrawByEmail() : string|null
Return values
string|null —

getWithdrawByMail()

Gets withdraw_by_mail

public getWithdrawByMail() : string|null
Return values
string|null —

getWithdrawByPhone()

Gets withdraw_by_phone

public getWithdrawByPhone() : string|null
Return values
string|null —

getWithdrawCity()

Gets withdraw_city

public getWithdrawCity() : string|null
Return values
string|null —

getWithdrawConsequences()

Gets withdraw_consequences

public getWithdrawConsequences() : string|null
Return values
string|null —

getWithdrawEmail()

Gets withdraw_email

public getWithdrawEmail() : string|null
Return values
string|null —

getWithdrawOther()

Gets withdraw_other

public getWithdrawOther() : string|null
Return values
string|null —

getWithdrawPhone()

Gets withdraw_phone

public getWithdrawPhone() : string|null
Return values
string|null —

getWithdrawPostalCode()

Gets withdraw_postal_code

public getWithdrawPostalCode() : string|null
Return values
string|null —

getWithdrawState()

Gets withdraw_state

public getWithdrawState() : string|null
Return values
string|null —

listInvalidProperties()

Show all the invalid properties with reasons.

public listInvalidProperties() : array<string|int, mixed>
Return values
array<string|int, mixed> —

invalid properties with reasons

offsetExists()

Returns true if offset exists. False otherwise.

public offsetExists(int $offset) : bool
Parameters
$offset : int

Offset

Return values
bool —

offsetGet()

Gets offset.

public offsetGet(int $offset) : mixed
Parameters
$offset : int

Offset

Return values
mixed —

offsetSet()

Sets value based on offset.

public offsetSet(int $offset, mixed $value) : void
Parameters
$offset : int

Offset

$value : mixed

Value to be set

Return values
void —

offsetUnset()

Unsets offset.

public offsetUnset(int $offset) : void
Parameters
$offset : int

Offset

Return values
void —

setAccountEsignId()

Sets account_esign_id

public setAccountEsignId(string|null $account_esign_id) : $this
Parameters
$account_esign_id : string|null

A GUID identifying the account associated with the consumer disclosure

Return values
$this —

setAllowCdWithdraw()

Sets allow_cd_withdraw

public setAllowCdWithdraw(string|null $allow_cd_withdraw) : $this
Parameters
$allow_cd_withdraw : string|null

Indicates whether the customer can withdraw their acceptance of the consumer disclosure.

Return values
$this —

setAllowCdWithdrawMetadata()

Sets allow_cd_withdraw_metadata

public setAllowCdWithdrawMetadata(SettingsMetadata $allow_cd_withdraw_metadata) : $this
Parameters
$allow_cd_withdraw_metadata : SettingsMetadata

Metadata that indicates whether the allowCDWithdraw property is editable.

Return values
$this —

setChangeEmail()

Sets change_email

public setChangeEmail(string|null $change_email) : $this
Parameters
$change_email : string|null
Return values
$this —

setChangeEmailOther()

Sets change_email_other

public setChangeEmailOther(string|null $change_email_other) : $this
Parameters
$change_email_other : string|null
Return values
$this —

setCompanyName()

Sets company_name

public setCompanyName(string|null $company_name) : $this
Parameters
$company_name : string|null

The name of the company associated with the consumer disclosure.

Return values
$this —

setCompanyPhone()

Sets company_phone

public setCompanyPhone(string|null $company_phone) : $this
Parameters
$company_phone : string|null

The phone number of the company associated with the consumer disclosure.

Return values
$this —

setCopyCostPerPage()

Sets copy_cost_per_page

public setCopyCostPerPage(string|null $copy_cost_per_page) : $this
Parameters
$copy_cost_per_page : string|null
Return values
$this —

setCopyFeeCollectionMethod()

Sets copy_fee_collection_method

public setCopyFeeCollectionMethod(string|null $copy_fee_collection_method) : $this
Parameters
$copy_fee_collection_method : string|null

Specifies the fee collection method for cases in which the customer requires paper copies of the document. Maximum Length: 255 characters

Return values
$this —

setCopyRequestEmail()

Sets copy_request_email

public setCopyRequestEmail(string|null $copy_request_email) : $this
Parameters
$copy_request_email : string|null
Return values
$this —

setCustom()

Sets custom

public setCustom(string|null $custom) : $this
Parameters
$custom : string|null
Return values
$this —

setEnableEsign()

Sets enable_esign

public setEnableEsign(string|null $enable_esign) : $this
Parameters
$enable_esign : string|null
Return values
$this —

setEsignAgreement()

Sets esign_agreement

public setEsignAgreement(string|null $esign_agreement) : $this
Parameters
$esign_agreement : string|null

The Electronic Record and Signature Disclosure text. The disclosure text includes the html formatting.

Return values
$this —

setEsignText()

Sets esign_text

public setEsignText(string|null $esign_text) : $this
Parameters
$esign_text : string|null
Return values
$this —

setLanguageCode()

Sets language_code

public setLanguageCode(string|null $language_code) : $this
Parameters
$language_code : string|null
Return values
$this —

setMustAgreeToEsign()

Sets must_agree_to_esign

public setMustAgreeToEsign(string|null $must_agree_to_esign) : $this
Parameters
$must_agree_to_esign : string|null
Return values
$this —

setPdfId()

Sets pdf_id

public setPdfId(string|null $pdf_id) : $this
Parameters
$pdf_id : string|null
Return values
$this —

setters()

Array of attributes to setter functions (for deserialization of responses)

public static setters() : array<string|int, mixed>
Return values
array<string|int, mixed> —

setUseBrand()

Sets use_brand

public setUseBrand(string|null $use_brand) : $this
Parameters
$use_brand : string|null
Return values
$this —

setUseConsumerDisclosureWithinAccount()

Sets use_consumer_disclosure_within_account

public setUseConsumerDisclosureWithinAccount(string|null $use_consumer_disclosure_within_account) : $this
Parameters
$use_consumer_disclosure_within_account : string|null
Return values
$this —

setUseConsumerDisclosureWithinAccountMetadata()

Sets use_consumer_disclosure_within_account_metadata

public setUseConsumerDisclosureWithinAccountMetadata(SettingsMetadata $use_consumer_disclosure_within_account_metadata) : $this
Parameters
$use_consumer_disclosure_within_account_metadata : SettingsMetadata

Metadata that indicates whether the useConsumerDisclosureWithinAccount property is editable.

Return values
$this —

setWithdrawAddressLine1()

Sets withdraw_address_line1

public setWithdrawAddressLine1(string|null $withdraw_address_line1) : $this
Parameters
$withdraw_address_line1 : string|null

Contains the first address line of the postal address to which a customer can send a consent withdrawal notification. Maximum length: 100 characters.

Return values
$this —

setWithdrawAddressLine2()

Sets withdraw_address_line2

public setWithdrawAddressLine2(string|null $withdraw_address_line2) : $this
Parameters
$withdraw_address_line2 : string|null

Contains the second address line of the postal address to which a customer can send a consent withdrawal notification. Maximum length: 100 characters.

Return values
$this —

setWithdrawByEmail()

Sets withdraw_by_email

public setWithdrawByEmail(string|null $withdraw_by_email) : $this
Parameters
$withdraw_by_email : string|null

Indicates whether the customer can withdraw consent by email.

Return values
$this —

setWithdrawByMail()

Sets withdraw_by_mail

public setWithdrawByMail(string|null $withdraw_by_mail) : $this
Parameters
$withdraw_by_mail : string|null

Indicates whether the customer can withdraw consent by postal mail.

Return values
$this —

setWithdrawByPhone()

Sets withdraw_by_phone

public setWithdrawByPhone(string|null $withdraw_by_phone) : $this
Parameters
$withdraw_by_phone : string|null

Indicates whether the customer can withdraw consent by phone.

Return values
$this —

setWithdrawCity()

Sets withdraw_city

public setWithdrawCity(string|null $withdraw_city) : $this
Parameters
$withdraw_city : string|null

Contains the city of the postal address to which a customer can send a consent withdrawal notification. Maximum length: 50 characters.

Return values
$this —

setWithdrawConsequences()

Sets withdraw_consequences

public setWithdrawConsequences(string|null $withdraw_consequences) : $this
Parameters
$withdraw_consequences : string|null

Indicates the consequences of withdrawing consent.

Return values
$this —

setWithdrawEmail()

Sets withdraw_email

public setWithdrawEmail(string|null $withdraw_email) : $this
Parameters
$withdraw_email : string|null

Contains the email address to which a customer can send a consent withdrawal notification. Maximum length: 100 characters.

Return values
$this —

setWithdrawOther()

Sets withdraw_other

public setWithdrawOther(string|null $withdraw_other) : $this
Parameters
$withdraw_other : string|null

Indicates other information need to withdraw consent. Maximum length: 255 characters.

Return values
$this —

setWithdrawPhone()

Sets withdraw_phone

public setWithdrawPhone(string|null $withdraw_phone) : $this
Parameters
$withdraw_phone : string|null

Contains the phone number which a customer can call to register consent withdrawal notification. Maximum length: 20 characters.

Return values
$this —

setWithdrawPostalCode()

Sets withdraw_postal_code

public setWithdrawPostalCode(string|null $withdraw_postal_code) : $this
Parameters
$withdraw_postal_code : string|null

Contains the postal code of the postal address to which a customer can send a consent withdrawal notification. Maximum length: 20 characters.

Return values
$this —

setWithdrawState()

Sets withdraw_state

public setWithdrawState(string|null $withdraw_state) : $this
Parameters
$withdraw_state : string|null

Contains the state of the postal address to which a customer can send a consent withdrawal notification.

Return values
$this —

swaggerFormats()

Array of property to format mappings. Used for (de)serialization

public static swaggerFormats() : array<string|int, mixed>
Return values
array<string|int, mixed> —

swaggerTypes()

Array of property to type mappings. Used for (de)serialization

public static swaggerTypes() : array<string|int, mixed>
Return values
array<string|int, mixed> —

valid()

Validate all the properties in the model return true if all passed

public valid() : bool
Return values
bool —

True if all properties are valid

Search results