Documentation

DocumentUpdateInfo
in package
implements ModelInterface, ArrayAccess

DocumentUpdateInfo Class Doc Comment

Tags
category

Class

author

Swagger Codegen team

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
getData()  : string|null
Gets data
getDocumentId()  : string|null
Gets document_id
getDocumentSecurityStore()  : DocumentSecurityStore
Gets document_security_store
getModelName()  : string
The original name of the model.
getName()  : string|null
Gets name
getReturnFormat()  : string|null
Gets return_format
getSignatureDataInfos()  : array<string|int, SignatureDataInfo>
Gets signature_data_infos
getters()  : array<string|int, mixed>
Array of attributes to getter functions (for serialization of requests)
getTimeStampField()  : TimeStampField
Gets time_stamp_field
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.
setData()  : $this
Sets data
setDocumentId()  : $this
Sets document_id
setDocumentSecurityStore()  : $this
Sets document_security_store
setName()  : $this
Sets name
setReturnFormat()  : $this
Sets return_format
setSignatureDataInfos()  : $this
Sets signature_data_infos
setters()  : array<string|int, mixed>
Array of attributes to setter functions (for deserialization of responses)
setTimeStampField()  : $this
Sets time_stamp_field
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 = ['data' => 'data', 'document_id' => 'documentId', 'document_security_store' => 'documentSecurityStore', 'name' => 'name', 'return_format' => 'returnFormat', 'signature_data_infos' => 'signatureDataInfos', 'time_stamp_field' => 'timeStampField']

$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 = ['data' => 'getData', 'document_id' => 'getDocumentId', 'document_security_store' => 'getDocumentSecurityStore', 'name' => 'getName', 'return_format' => 'getReturnFormat', 'signature_data_infos' => 'getSignatureDataInfos', 'time_stamp_field' => 'getTimeStampField']

$setters

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

protected static array<string|int, string> $setters = ['data' => 'setData', 'document_id' => 'setDocumentId', 'document_security_store' => 'setDocumentSecurityStore', 'name' => 'setName', 'return_format' => 'setReturnFormat', 'signature_data_infos' => 'setSignatureDataInfos', 'time_stamp_field' => 'setTimeStampField']

$swaggerFormats

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

protected static array<string|int, string> $swaggerFormats = ['data' => null, 'document_id' => null, 'document_security_store' => null, 'name' => null, 'return_format' => null, 'signature_data_infos' => null, 'time_stamp_field' => null]

$swaggerModelName

The original name of the model.

protected static string $swaggerModelName = 'documentUpdateInfo'

$swaggerTypes

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

protected static array<string|int, string> $swaggerTypes = ['data' => '?string', 'document_id' => '?string', 'document_security_store' => '\\DocuSign\\eSign\\Model\\DocumentSecurityStore', 'name' => '?string', 'return_format' => '?string', 'signature_data_infos' => '\\DocuSign\\eSign\\Model\\SignatureDataInfo[]', 'time_stamp_field' => '\\DocuSign\\eSign\\Model\\TimeStampField']

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> —

getData()

Gets data

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

getDocumentId()

Gets document_id

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

getModelName()

The original name of the model.

public getModelName() : string
Return values
string —

getName()

Gets name

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

getReturnFormat()

Gets return_format

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

setData()

Sets data

public setData(string|null $data) : $this
Parameters
$data : string|null
Return values
$this —

setDocumentId()

Sets document_id

public setDocumentId(string|null $document_id) : $this
Parameters
$document_id : string|null

Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.

Return values
$this —

setName()

Sets name

public setName(string|null $name) : $this
Parameters
$name : string|null
Return values
$this —

setReturnFormat()

Sets return_format

public setReturnFormat(string|null $return_format) : $this
Parameters
$return_format : 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

Search results