RecipientFormData
in package
implements
ModelInterface, ArrayAccess
RecipientFormData Class Doc Comment
Tags
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
- getDeclinedTime() : string|null
- Gets declined_time
- getDeliveredTime() : string|null
- Gets delivered_time
- getEmail() : string|null
- Gets email
- getFormData() : array<string|int, FormDataItem>
- Gets form_data
- getModelName() : string
- The original name of the model.
- getName() : string|null
- Gets name
- getRecipientId() : string|null
- Gets recipient_id
- getSentTime() : string|null
- Gets sent_time
- getSignedTime() : string|null
- Gets signed_time
- getters() : array<string|int, mixed>
- Array of attributes to getter functions (for serialization of requests)
- 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.
- setDeclinedTime() : $this
- Sets declined_time
- setDeliveredTime() : $this
- Sets delivered_time
- setEmail() : $this
- Sets email
- setFormData() : $this
- Sets form_data
- setName() : $this
- Sets name
- setRecipientId() : $this
- Sets recipient_id
- setSentTime() : $this
- Sets sent_time
- setSignedTime() : $this
- Sets signed_time
- setters() : array<string|int, mixed>
- Array of attributes to setter functions (for deserialization of responses)
- 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
DISCRIMINATOR
public
mixed
DISCRIMINATOR
= null
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
= ['declined_time' => 'DeclinedTime', 'delivered_time' => 'DeliveredTime', 'email' => 'email', 'form_data' => 'formData', 'name' => 'name', 'recipient_id' => 'recipientId', 'sent_time' => 'SentTime', 'signed_time' => 'SignedTime']
$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
= ['declined_time' => 'getDeclinedTime', 'delivered_time' => 'getDeliveredTime', 'email' => 'getEmail', 'form_data' => 'getFormData', 'name' => 'getName', 'recipient_id' => 'getRecipientId', 'sent_time' => 'getSentTime', 'signed_time' => 'getSignedTime']
$setters
Array of attributes to setter functions (for deserialization of responses)
protected
static array<string|int, string>
$setters
= ['declined_time' => 'setDeclinedTime', 'delivered_time' => 'setDeliveredTime', 'email' => 'setEmail', 'form_data' => 'setFormData', 'name' => 'setName', 'recipient_id' => 'setRecipientId', 'sent_time' => 'setSentTime', 'signed_time' => 'setSignedTime']
$swaggerFormats
Array of property to format mappings. Used for (de)serialization
protected
static array<string|int, string>
$swaggerFormats
= ['declined_time' => null, 'delivered_time' => null, 'email' => null, 'form_data' => null, 'name' => null, 'recipient_id' => null, 'sent_time' => null, 'signed_time' => null]
$swaggerModelName
The original name of the model.
protected
static string
$swaggerModelName
= 'recipientFormData'
$swaggerTypes
Array of property to type mappings. Used for (de)serialization
protected
static array<string|int, string>
$swaggerTypes
= ['declined_time' => '?string', 'delivered_time' => '?string', 'email' => '?string', 'form_data' => '\\DocuSign\\eSign\\Model\\FormDataItem[]', 'name' => '?string', 'recipient_id' => '?string', 'sent_time' => '?string', 'signed_time' => '?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> —getDeclinedTime()
Gets declined_time
public
getDeclinedTime() : string|null
Return values
string|null —getDeliveredTime()
Gets delivered_time
public
getDeliveredTime() : string|null
Return values
string|null —getEmail()
Gets email
public
getEmail() : string|null
Return values
string|null —getFormData()
Gets form_data
public
getFormData() : array<string|int, FormDataItem>
Return values
array<string|int, FormDataItem> —getModelName()
The original name of the model.
public
getModelName() : string
Return values
string —getName()
Gets name
public
getName() : string|null
Return values
string|null —getRecipientId()
Gets recipient_id
public
getRecipientId() : string|null
Return values
string|null —getSentTime()
Gets sent_time
public
getSentTime() : string|null
Return values
string|null —getSignedTime()
Gets signed_time
public
getSignedTime() : 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> —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 —setDeclinedTime()
Sets declined_time
public
setDeclinedTime(string|null $declined_time) : $this
Parameters
- $declined_time : string|null
Return values
$this —setDeliveredTime()
Sets delivered_time
public
setDeliveredTime(string|null $delivered_time) : $this
Parameters
- $delivered_time : string|null
Return values
$this —setEmail()
Sets email
public
setEmail(string|null $email) : $this
Parameters
- $email : string|null
Return values
$this —setFormData()
Sets form_data
public
setFormData(array<string|int, FormDataItem> $form_data) : $this
Parameters
- $form_data : array<string|int, FormDataItem>
Return values
$this —setName()
Sets name
public
setName(string|null $name) : $this
Parameters
- $name : string|null
Return values
$this —setRecipientId()
Sets recipient_id
public
setRecipientId(string|null $recipient_id) : $this
Parameters
- $recipient_id : string|null
-
Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.
Return values
$this —setSentTime()
Sets sent_time
public
setSentTime(string|null $sent_time) : $this
Parameters
- $sent_time : string|null
Return values
$this —setSignedTime()
Sets signed_time
public
setSignedTime(string|null $signed_time) : $this
Parameters
- $signed_time : 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> —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