Documentation

DisplayApplianceRecipient
in package
implements ArrayAccess

DisplayApplianceRecipient Class Doc Comment

Tags
category

Class

author

Swagger Codegen team

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

Interfaces, Classes, Traits and Enums

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)
$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()  : mixed
getCfrPart11()  : bool
Gets cfr_part11
getCompany()  : string
Gets company
getDigitalSignatureBase64()  : string
Gets digital_signature_base64
getEmail()  : string
Gets email
getFullName()  : string
Gets full_name
getInitialsBase64()  : string
Gets initials_base64
getInPersonEmail()  : string
Gets in_person_email
getIsNotary()  : bool
Gets is_notary
getNotarySealBase64()  : string
Gets notary_seal_base64
getPhoneNumber()  : string
Gets phone_number
getRecipientCompleteCount()  : int
Gets recipient_complete_count
getRecipientGuidId()  : string
Gets recipient_guid_id
getRecipientId()  : string
Gets recipient_id
getRecipientStatus()  : string
Gets recipient_status
getRecipientType()  : string
Gets recipient_type
getRowState()  : string
Gets row_state
getSignatureBase64()  : string
Gets signature_base64
getSigned()  : bool
Gets signed
getSignerApplyTabs()  : bool
Gets signer_apply_tabs
getSignerAttachmentBase64()  : string
Gets signer_attachment_base64
getters()  : mixed
getUserName()  : string
Gets user_name
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.
setCfrPart11()  : $this
Sets cfr_part11
setCompany()  : $this
Sets company
setDigitalSignatureBase64()  : $this
Sets digital_signature_base64
setEmail()  : $this
Sets email
setFullName()  : $this
Sets full_name
setInitialsBase64()  : $this
Sets initials_base64
setInPersonEmail()  : $this
Sets in_person_email
setIsNotary()  : $this
Sets is_notary
setNotarySealBase64()  : $this
Sets notary_seal_base64
setPhoneNumber()  : $this
Sets phone_number
setRecipientCompleteCount()  : $this
Sets recipient_complete_count
setRecipientGuidId()  : $this
Sets recipient_guid_id
setRecipientId()  : $this
Sets recipient_id
setRecipientStatus()  : $this
Sets recipient_status
setRecipientType()  : $this
Sets recipient_type
setRowState()  : $this
Sets row_state
setSignatureBase64()  : $this
Sets signature_base64
setSigned()  : $this
Sets signed
setSignerApplyTabs()  : $this
Sets signer_apply_tabs
setSignerAttachmentBase64()  : $this
Sets signer_attachment_base64
setters()  : mixed
setUserName()  : $this
Sets user_name
swaggerTypes()  : mixed
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 = ['cfr_part11' => 'cfrPart11', 'company' => 'company', 'digital_signature_base64' => 'digitalSignatureBase64', 'email' => 'email', 'full_name' => 'fullName', 'initials_base64' => 'initialsBase64', 'in_person_email' => 'inPersonEmail', 'is_notary' => 'isNotary', 'notary_seal_base64' => 'notarySealBase64', 'phone_number' => 'phoneNumber', 'recipient_complete_count' => 'recipientCompleteCount', 'recipient_guid_id' => 'recipientGuidId', 'recipient_id' => 'recipientId', 'recipient_status' => 'recipientStatus', 'recipient_type' => 'recipientType', 'row_state' => 'rowState', 'signature_base64' => 'signatureBase64', 'signed' => 'signed', 'signer_apply_tabs' => 'signerApplyTabs', 'signer_attachment_base64' => 'signerAttachmentBase64', 'user_name' => 'userName']

$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 = ['cfr_part11' => 'getCfrPart11', 'company' => 'getCompany', 'digital_signature_base64' => 'getDigitalSignatureBase64', 'email' => 'getEmail', 'full_name' => 'getFullName', 'initials_base64' => 'getInitialsBase64', 'in_person_email' => 'getInPersonEmail', 'is_notary' => 'getIsNotary', 'notary_seal_base64' => 'getNotarySealBase64', 'phone_number' => 'getPhoneNumber', 'recipient_complete_count' => 'getRecipientCompleteCount', 'recipient_guid_id' => 'getRecipientGuidId', 'recipient_id' => 'getRecipientId', 'recipient_status' => 'getRecipientStatus', 'recipient_type' => 'getRecipientType', 'row_state' => 'getRowState', 'signature_base64' => 'getSignatureBase64', 'signed' => 'getSigned', 'signer_apply_tabs' => 'getSignerApplyTabs', 'signer_attachment_base64' => 'getSignerAttachmentBase64', 'user_name' => 'getUserName']

$setters

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

protected static array<string|int, string> $setters = ['cfr_part11' => 'setCfrPart11', 'company' => 'setCompany', 'digital_signature_base64' => 'setDigitalSignatureBase64', 'email' => 'setEmail', 'full_name' => 'setFullName', 'initials_base64' => 'setInitialsBase64', 'in_person_email' => 'setInPersonEmail', 'is_notary' => 'setIsNotary', 'notary_seal_base64' => 'setNotarySealBase64', 'phone_number' => 'setPhoneNumber', 'recipient_complete_count' => 'setRecipientCompleteCount', 'recipient_guid_id' => 'setRecipientGuidId', 'recipient_id' => 'setRecipientId', 'recipient_status' => 'setRecipientStatus', 'recipient_type' => 'setRecipientType', 'row_state' => 'setRowState', 'signature_base64' => 'setSignatureBase64', 'signed' => 'setSigned', 'signer_apply_tabs' => 'setSignerApplyTabs', 'signer_attachment_base64' => 'setSignerAttachmentBase64', 'user_name' => 'setUserName']

$swaggerModelName

The original name of the model.

protected static string $swaggerModelName = 'displayApplianceRecipient'

$swaggerTypes

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

protected static array<string|int, string> $swaggerTypes = ['cfr_part11' => 'bool', 'company' => 'string', 'digital_signature_base64' => 'string', 'email' => 'string', 'full_name' => 'string', 'initials_base64' => 'string', 'in_person_email' => 'string', 'is_notary' => 'bool', 'notary_seal_base64' => 'string', 'phone_number' => 'string', 'recipient_complete_count' => 'int', 'recipient_guid_id' => 'string', 'recipient_id' => 'string', 'recipient_status' => 'string', 'recipient_type' => 'string', 'row_state' => 'string', 'signature_base64' => 'string', 'signed' => 'bool', 'signer_apply_tabs' => 'bool', 'signer_attachment_base64' => 'string', 'user_name' => '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 —

getDigitalSignatureBase64()

Gets digital_signature_base64

public getDigitalSignatureBase64() : string
Return values
string —

getNotarySealBase64()

Gets notary_seal_base64

public getNotarySealBase64() : string
Return values
string —

getRecipientCompleteCount()

Gets recipient_complete_count

public getRecipientCompleteCount() : int
Return values
int —

getSignerAttachmentBase64()

Gets signer_attachment_base64

public getSignerAttachmentBase64() : string
Return values
string —

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 —

setCfrPart11()

Sets cfr_part11

public setCfrPart11(bool $cfr_part11) : $this
Parameters
$cfr_part11 : bool
Return values
$this —

setCompany()

Sets company

public setCompany(string $company) : $this
Parameters
$company : string
Return values
$this —

setDigitalSignatureBase64()

Sets digital_signature_base64

public setDigitalSignatureBase64(string $digital_signature_base64) : $this
Parameters
$digital_signature_base64 : string
Return values
$this —

setEmail()

Sets email

public setEmail(string $email) : $this
Parameters
$email : string
Return values
$this —

setFullName()

Sets full_name

public setFullName(string $full_name) : $this
Parameters
$full_name : string
Return values
$this —

setInitialsBase64()

Sets initials_base64

public setInitialsBase64(string $initials_base64) : $this
Parameters
$initials_base64 : string
Return values
$this —

setInPersonEmail()

Sets in_person_email

public setInPersonEmail(string $in_person_email) : $this
Parameters
$in_person_email : string
Return values
$this —

setIsNotary()

Sets is_notary

public setIsNotary(bool $is_notary) : $this
Parameters
$is_notary : bool
Return values
$this —

setNotarySealBase64()

Sets notary_seal_base64

public setNotarySealBase64(string $notary_seal_base64) : $this
Parameters
$notary_seal_base64 : string
Return values
$this —

setPhoneNumber()

Sets phone_number

public setPhoneNumber(string $phone_number) : $this
Parameters
$phone_number : string
Return values
$this —

setRecipientCompleteCount()

Sets recipient_complete_count

public setRecipientCompleteCount(int $recipient_complete_count) : $this
Parameters
$recipient_complete_count : int
Return values
$this —

setRecipientGuidId()

Sets recipient_guid_id

public setRecipientGuidId(string $recipient_guid_id) : $this
Parameters
$recipient_guid_id : string
Return values
$this —

setRecipientId()

Sets recipient_id

public setRecipientId(string $recipient_id) : $this
Parameters
$recipient_id : string

Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.

Return values
$this —

setRecipientStatus()

Sets recipient_status

public setRecipientStatus(string $recipient_status) : $this
Parameters
$recipient_status : string
Return values
$this —

setRecipientType()

Sets recipient_type

public setRecipientType(string $recipient_type) : $this
Parameters
$recipient_type : string
Return values
$this —

setRowState()

Sets row_state

public setRowState(string $row_state) : $this
Parameters
$row_state : string
Return values
$this —

setSignatureBase64()

Sets signature_base64

public setSignatureBase64(string $signature_base64) : $this
Parameters
$signature_base64 : string
Return values
$this —

setSigned()

Sets signed

public setSigned(bool $signed) : $this
Parameters
$signed : bool
Return values
$this —

setSignerApplyTabs()

Sets signer_apply_tabs

public setSignerApplyTabs(bool $signer_apply_tabs) : $this
Parameters
$signer_apply_tabs : bool
Return values
$this —

setSignerAttachmentBase64()

Sets signer_attachment_base64

public setSignerAttachmentBase64(string $signer_attachment_base64) : $this
Parameters
$signer_attachment_base64 : string
Return values
$this —

setUserName()

Sets user_name

public setUserName(string $user_name) : $this
Parameters
$user_name : string
Return values
$this —

valid()

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

public valid() : bool
Return values
bool —

True if all properteis are valid

Search results