Documentation

TemplateUpdateSummary
in package
implements ModelInterface, ArrayAccess

TemplateUpdateSummary Class Doc Comment

Tags
category

Class

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
getBulkEnvelopeStatus()  : BulkEnvelopeStatus
Gets bulk_envelope_status
getEnvelopeId()  : string|null
Gets envelope_id
getErrorDetails()  : ErrorDetails
Gets error_details
getListCustomFieldUpdateResults()  : array<string|int, ListCustomField>
Gets list_custom_field_update_results
getLockInformation()  : LockInformation
Gets lock_information
getModelName()  : string
The original name of the model.
getPurgeState()  : string|null
Gets purge_state
getRecipientUpdateResults()  : array<string|int, RecipientUpdateResponse>
Gets recipient_update_results
getTabUpdateResults()  : Tabs
Gets tab_update_results
getters()  : array<string|int, mixed>
Array of attributes to getter functions (for serialization of requests)
getTextCustomFieldUpdateResults()  : array<string|int, TextCustomField>
Gets text_custom_field_update_results
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.
setBulkEnvelopeStatus()  : $this
Sets bulk_envelope_status
setEnvelopeId()  : $this
Sets envelope_id
setErrorDetails()  : $this
Sets error_details
setListCustomFieldUpdateResults()  : $this
Sets list_custom_field_update_results
setLockInformation()  : $this
Sets lock_information
setPurgeState()  : $this
Sets purge_state
setRecipientUpdateResults()  : $this
Sets recipient_update_results
setTabUpdateResults()  : $this
Sets tab_update_results
setters()  : array<string|int, mixed>
Array of attributes to setter functions (for deserialization of responses)
setTextCustomFieldUpdateResults()  : $this
Sets text_custom_field_update_results
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 = ['bulk_envelope_status' => 'bulkEnvelopeStatus', 'envelope_id' => 'envelopeId', 'error_details' => 'errorDetails', 'list_custom_field_update_results' => 'listCustomFieldUpdateResults', 'lock_information' => 'lockInformation', 'purge_state' => 'purgeState', 'recipient_update_results' => 'recipientUpdateResults', 'tab_update_results' => 'tabUpdateResults', 'text_custom_field_update_results' => 'textCustomFieldUpdateResults']

$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 = ['bulk_envelope_status' => 'getBulkEnvelopeStatus', 'envelope_id' => 'getEnvelopeId', 'error_details' => 'getErrorDetails', 'list_custom_field_update_results' => 'getListCustomFieldUpdateResults', 'lock_information' => 'getLockInformation', 'purge_state' => 'getPurgeState', 'recipient_update_results' => 'getRecipientUpdateResults', 'tab_update_results' => 'getTabUpdateResults', 'text_custom_field_update_results' => 'getTextCustomFieldUpdateResults']

$setters

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

protected static array<string|int, string> $setters = ['bulk_envelope_status' => 'setBulkEnvelopeStatus', 'envelope_id' => 'setEnvelopeId', 'error_details' => 'setErrorDetails', 'list_custom_field_update_results' => 'setListCustomFieldUpdateResults', 'lock_information' => 'setLockInformation', 'purge_state' => 'setPurgeState', 'recipient_update_results' => 'setRecipientUpdateResults', 'tab_update_results' => 'setTabUpdateResults', 'text_custom_field_update_results' => 'setTextCustomFieldUpdateResults']

$swaggerFormats

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

protected static array<string|int, string> $swaggerFormats = ['bulk_envelope_status' => null, 'envelope_id' => null, 'error_details' => null, 'list_custom_field_update_results' => null, 'lock_information' => null, 'purge_state' => null, 'recipient_update_results' => null, 'tab_update_results' => null, 'text_custom_field_update_results' => null]

$swaggerModelName

The original name of the model.

protected static string $swaggerModelName = 'templateUpdateSummary'

$swaggerTypes

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

protected static array<string|int, string> $swaggerTypes = ['bulk_envelope_status' => '\\DocuSign\\eSign\\Model\\BulkEnvelopeStatus', 'envelope_id' => '?string', 'error_details' => '\\DocuSign\\eSign\\Model\\ErrorDetails', 'list_custom_field_update_results' => '\\DocuSign\\eSign\\Model\\ListCustomField[]', 'lock_information' => '\\DocuSign\\eSign\\Model\\LockInformation', 'purge_state' => '?string', 'recipient_update_results' => '\\DocuSign\\eSign\\Model\\RecipientUpdateResponse[]', 'tab_update_results' => '\\DocuSign\\eSign\\Model\\Tabs', 'text_custom_field_update_results' => '\\DocuSign\\eSign\\Model\\TextCustomField[]']

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>

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

getPurgeState()

Gets purge_state

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

setBulkEnvelopeStatus()

Sets bulk_envelope_status

public setBulkEnvelopeStatus(BulkEnvelopeStatus $bulk_envelope_status) : $this
Parameters
$bulk_envelope_status : BulkEnvelopeStatus

An object that describes the status of the bulk send envelopes.

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

setListCustomFieldUpdateResults()

Sets list_custom_field_update_results

public setListCustomFieldUpdateResults(array<string|int, ListCustomField$list_custom_field_update_results) : $this
Parameters
$list_custom_field_update_results : array<string|int, ListCustomField>
Return values
$this

setLockInformation()

Sets lock_information

public setLockInformation(LockInformation $lock_information) : $this
Parameters
$lock_information : LockInformation

Provides lock information about an envelope that a user has locked.

Return values
$this

setPurgeState()

Sets purge_state

public setPurgeState(string|null $purge_state) : $this
Parameters
$purge_state : string|null
Return values
$this

setTabUpdateResults()

Sets tab_update_results

public setTabUpdateResults(Tabs $tab_update_results) : $this
Parameters
$tab_update_results : Tabs
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>

setTextCustomFieldUpdateResults()

Sets text_custom_field_update_results

public setTextCustomFieldUpdateResults(array<string|int, TextCustomField$text_custom_field_update_results) : $this
Parameters
$text_custom_field_update_results : array<string|int, TextCustomField>
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