Documentation

BulkSendEnvelopesInfo
in package
implements ModelInterface, ArrayAccess

BulkSendEnvelopesInfo 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
getAuthoritativeCopy()  : string|null
Gets authoritative_copy
getCompleted()  : string|null
Gets completed
getCorrect()  : string|null
Gets correct
getCreated()  : string|null
Gets created
getDeclined()  : string|null
Gets declined
getDeleted()  : string|null
Gets deleted
getDelivered()  : string|null
Gets delivered
getDigitalSignaturesPending()  : string|null
Gets digital_signatures_pending
getModelName()  : string
The original name of the model.
getSent()  : string|null
Gets sent
getSigned()  : string|null
Gets signed
getters()  : array<string|int, mixed>
Array of attributes to getter functions (for serialization of requests)
getTimedOut()  : string|null
Gets timed_out
getTransferCompleted()  : string|null
Gets transfer_completed
getVoided()  : string|null
Gets voided
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.
setAuthoritativeCopy()  : $this
Sets authoritative_copy
setCompleted()  : $this
Sets completed
setCorrect()  : $this
Sets correct
setCreated()  : $this
Sets created
setDeclined()  : $this
Sets declined
setDeleted()  : $this
Sets deleted
setDelivered()  : $this
Sets delivered
setDigitalSignaturesPending()  : $this
Sets digital_signatures_pending
setSent()  : $this
Sets sent
setSigned()  : $this
Sets signed
setters()  : array<string|int, mixed>
Array of attributes to setter functions (for deserialization of responses)
setTimedOut()  : $this
Sets timed_out
setTransferCompleted()  : $this
Sets transfer_completed
setVoided()  : $this
Sets voided
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 = ['authoritative_copy' => 'authoritativeCopy', 'completed' => 'completed', 'correct' => 'correct', 'created' => 'created', 'declined' => 'declined', 'deleted' => 'deleted', 'delivered' => 'delivered', 'digital_signatures_pending' => 'digitalSignaturesPending', 'sent' => 'sent', 'signed' => 'signed', 'timed_out' => 'timedOut', 'transfer_completed' => 'transferCompleted', 'voided' => 'voided']

$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 = ['authoritative_copy' => 'getAuthoritativeCopy', 'completed' => 'getCompleted', 'correct' => 'getCorrect', 'created' => 'getCreated', 'declined' => 'getDeclined', 'deleted' => 'getDeleted', 'delivered' => 'getDelivered', 'digital_signatures_pending' => 'getDigitalSignaturesPending', 'sent' => 'getSent', 'signed' => 'getSigned', 'timed_out' => 'getTimedOut', 'transfer_completed' => 'getTransferCompleted', 'voided' => 'getVoided']

$setters

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

protected static array<string|int, string> $setters = ['authoritative_copy' => 'setAuthoritativeCopy', 'completed' => 'setCompleted', 'correct' => 'setCorrect', 'created' => 'setCreated', 'declined' => 'setDeclined', 'deleted' => 'setDeleted', 'delivered' => 'setDelivered', 'digital_signatures_pending' => 'setDigitalSignaturesPending', 'sent' => 'setSent', 'signed' => 'setSigned', 'timed_out' => 'setTimedOut', 'transfer_completed' => 'setTransferCompleted', 'voided' => 'setVoided']

$swaggerFormats

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

protected static array<string|int, string> $swaggerFormats = ['authoritative_copy' => null, 'completed' => null, 'correct' => null, 'created' => null, 'declined' => null, 'deleted' => null, 'delivered' => null, 'digital_signatures_pending' => null, 'sent' => null, 'signed' => null, 'timed_out' => null, 'transfer_completed' => null, 'voided' => null]

$swaggerModelName

The original name of the model.

protected static string $swaggerModelName = 'bulkSendEnvelopesInfo'

$swaggerTypes

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

protected static array<string|int, string> $swaggerTypes = ['authoritative_copy' => '?string', 'completed' => '?string', 'correct' => '?string', 'created' => '?string', 'declined' => '?string', 'deleted' => '?string', 'delivered' => '?string', 'digital_signatures_pending' => '?string', 'sent' => '?string', 'signed' => '?string', 'timed_out' => '?string', 'transfer_completed' => '?string', 'voided' => '?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> —

getAuthoritativeCopy()

Gets authoritative_copy

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

getCompleted()

Gets completed

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

getDeclined()

Gets declined

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

getDelivered()

Gets delivered

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

getDigitalSignaturesPending()

Gets digital_signatures_pending

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

getModelName()

The original name of the model.

public getModelName() : string
Return values
string —

getters()

Array of attributes to getter functions (for serialization of requests)

public static getters() : array<string|int, mixed>
Return values
array<string|int, mixed> —

getTimedOut()

Gets timed_out

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

getTransferCompleted()

Gets transfer_completed

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

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 —

setAuthoritativeCopy()

Sets authoritative_copy

public setAuthoritativeCopy(string|null $authoritative_copy) : $this
Parameters
$authoritative_copy : string|null

Specifies the Authoritative copy feature. If set to true the Authoritative copy feature is enabled.

Return values
$this —

setCompleted()

Sets completed

public setCompleted(string|null $completed) : $this
Parameters
$completed : string|null
Return values
$this —

setCorrect()

Sets correct

public setCorrect(string|null $correct) : $this
Parameters
$correct : string|null
Return values
$this —

setCreated()

Sets created

public setCreated(string|null $created) : $this
Parameters
$created : string|null
Return values
$this —

setDeclined()

Sets declined

public setDeclined(string|null $declined) : $this
Parameters
$declined : string|null
Return values
$this —

setDeleted()

Sets deleted

public setDeleted(string|null $deleted) : $this
Parameters
$deleted : string|null
Return values
$this —

setDelivered()

Sets delivered

public setDelivered(string|null $delivered) : $this
Parameters
$delivered : string|null
Return values
$this —

setDigitalSignaturesPending()

Sets digital_signatures_pending

public setDigitalSignaturesPending(string|null $digital_signatures_pending) : $this
Parameters
$digital_signatures_pending : string|null
Return values
$this —

setSent()

Sets sent

public setSent(string|null $sent) : $this
Parameters
$sent : string|null
Return values
$this —

setSigned()

Sets signed

public setSigned(string|null $signed) : $this
Parameters
$signed : 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> —

setTimedOut()

Sets timed_out

public setTimedOut(string|null $timed_out) : $this
Parameters
$timed_out : string|null
Return values
$this —

setTransferCompleted()

Sets transfer_completed

public setTransferCompleted(string|null $transfer_completed) : $this
Parameters
$transfer_completed : string|null
Return values
$this —

setVoided()

Sets voided

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