Documentation

EnvelopeFormData
in package
implements ModelInterface, ArrayAccess

EnvelopeFormData Class Doc Comment

Tags
category

Class

description

Describes the form data of the envelope.

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
getEmailSubject()  : string|null
Gets email_subject
getEnvelopeId()  : string|null
Gets envelope_id
getFormData()  : array<string|int, FormDataItem>
Gets form_data
getModelName()  : string
The original name of the model.
getPrefillFormData()  : PrefillFormData
Gets prefill_form_data
getRecipientFormData()  : array<string|int, RecipientFormData>
Gets recipient_form_data
getSentDateTime()  : string|null
Gets sent_date_time
getStatus()  : string|null
Gets status
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.
setEmailSubject()  : $this
Sets email_subject
setEnvelopeId()  : $this
Sets envelope_id
setFormData()  : $this
Sets form_data
setPrefillFormData()  : $this
Sets prefill_form_data
setRecipientFormData()  : $this
Sets recipient_form_data
setSentDateTime()  : $this
Sets sent_date_time
setStatus()  : $this
Sets status
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

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 = ['email_subject' => 'emailSubject', 'envelope_id' => 'envelopeId', 'form_data' => 'formData', 'prefill_form_data' => 'prefillFormData', 'recipient_form_data' => 'recipientFormData', 'sent_date_time' => 'sentDateTime', 'status' => 'status']

$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 = ['email_subject' => 'getEmailSubject', 'envelope_id' => 'getEnvelopeId', 'form_data' => 'getFormData', 'prefill_form_data' => 'getPrefillFormData', 'recipient_form_data' => 'getRecipientFormData', 'sent_date_time' => 'getSentDateTime', 'status' => 'getStatus']

$setters

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

protected static array<string|int, string> $setters = ['email_subject' => 'setEmailSubject', 'envelope_id' => 'setEnvelopeId', 'form_data' => 'setFormData', 'prefill_form_data' => 'setPrefillFormData', 'recipient_form_data' => 'setRecipientFormData', 'sent_date_time' => 'setSentDateTime', 'status' => 'setStatus']

$swaggerFormats

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

protected static array<string|int, string> $swaggerFormats = ['email_subject' => null, 'envelope_id' => null, 'form_data' => null, 'prefill_form_data' => null, 'recipient_form_data' => null, 'sent_date_time' => null, 'status' => null]

$swaggerModelName

The original name of the model.

protected static string $swaggerModelName = 'envelopeFormData'

$swaggerTypes

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

protected static array<string|int, string> $swaggerTypes = ['email_subject' => '?string', 'envelope_id' => '?string', 'form_data' => '\\DocuSign\\eSign\\Model\\FormDataItem[]', 'prefill_form_data' => '\\DocuSign\\eSign\\Model\\PrefillFormData', 'recipient_form_data' => '\\DocuSign\\eSign\\Model\\RecipientFormData[]', 'sent_date_time' => '?string', 'status' => '?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> —

getEmailSubject()

Gets email_subject

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

getEnvelopeId()

Gets envelope_id

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

getModelName()

The original name of the model.

public getModelName() : string
Return values
string —

getSentDateTime()

Gets sent_date_time

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

getStatus()

Gets status

public getStatus() : 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 —

setEmailSubject()

Sets email_subject

public setEmailSubject(string|null $email_subject) : $this
Parameters
$email_subject : string|null

Specifies the subject of the email that is sent to all recipients. See [ML:Template Email Subject Merge Fields] for information about adding merge field information to the email subject.

Return values
$this —

setEnvelopeId()

Sets envelope_id

public setEnvelopeId(string|null $envelope_id) : $this
Parameters
$envelope_id : string|null

The envelope ID of the envelope status that failed to post.

Return values
$this —

setSentDateTime()

Sets sent_date_time

public setSentDateTime(string|null $sent_date_time) : $this
Parameters
$sent_date_time : string|null

The date and time the envelope was sent.

Return values
$this —

setStatus()

Sets status

public setStatus(string|null $status) : $this
Parameters
$status : string|null

Indicates the envelope status. Valid values are: * sent - The envelope is sent to the recipients. * created - The envelope is saved as a draft and can be modified and sent later.

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

Search results