Documentation

TemplateRecipients
in package
implements ModelInterface, ArrayAccess

TemplateRecipients 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
getAgents()  : array<string|int, Agent>
Gets agents
getCarbonCopies()  : array<string|int, CarbonCopy>
Gets carbon_copies
getCertifiedDeliveries()  : array<string|int, CertifiedDelivery>
Gets certified_deliveries
getCurrentRoutingOrder()  : string|null
Gets current_routing_order
getEditors()  : array<string|int, Editor>
Gets editors
getErrorDetails()  : ErrorDetails
Gets error_details
getInPersonSigners()  : array<string|int, InPersonSigner>
Gets in_person_signers
getIntermediaries()  : array<string|int, Intermediary>
Gets intermediaries
getModelName()  : string
The original name of the model.
getNotaries()  : array<string|int, NotaryRecipient>
Gets notaries
getParticipants()  : array<string|int, Participant>
Gets participants
getRecipientCount()  : string|null
Gets recipient_count
getSeals()  : array<string|int, SealSign>
Gets seals
getSigners()  : array<string|int, Signer>
Gets signers
getters()  : array<string|int, mixed>
Array of attributes to getter functions (for serialization of requests)
getWitnesses()  : array<string|int, Witness>
Gets witnesses
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.
setAgents()  : $this
Sets agents
setCarbonCopies()  : $this
Sets carbon_copies
setCertifiedDeliveries()  : $this
Sets certified_deliveries
setCurrentRoutingOrder()  : $this
Sets current_routing_order
setEditors()  : $this
Sets editors
setErrorDetails()  : $this
Sets error_details
setInPersonSigners()  : $this
Sets in_person_signers
setIntermediaries()  : $this
Sets intermediaries
setNotaries()  : $this
Sets notaries
setParticipants()  : $this
Sets participants
setRecipientCount()  : $this
Sets recipient_count
setSeals()  : $this
Sets seals
setSigners()  : $this
Sets signers
setters()  : array<string|int, mixed>
Array of attributes to setter functions (for deserialization of responses)
setWitnesses()  : $this
Sets witnesses
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 = ['agents' => 'agents', 'carbon_copies' => 'carbonCopies', 'certified_deliveries' => 'certifiedDeliveries', 'current_routing_order' => 'currentRoutingOrder', 'editors' => 'editors', 'error_details' => 'errorDetails', 'in_person_signers' => 'inPersonSigners', 'intermediaries' => 'intermediaries', 'notaries' => 'notaries', 'participants' => 'participants', 'recipient_count' => 'recipientCount', 'seals' => 'seals', 'signers' => 'signers', 'witnesses' => 'witnesses']

$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 = ['agents' => 'getAgents', 'carbon_copies' => 'getCarbonCopies', 'certified_deliveries' => 'getCertifiedDeliveries', 'current_routing_order' => 'getCurrentRoutingOrder', 'editors' => 'getEditors', 'error_details' => 'getErrorDetails', 'in_person_signers' => 'getInPersonSigners', 'intermediaries' => 'getIntermediaries', 'notaries' => 'getNotaries', 'participants' => 'getParticipants', 'recipient_count' => 'getRecipientCount', 'seals' => 'getSeals', 'signers' => 'getSigners', 'witnesses' => 'getWitnesses']

$setters

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

protected static array<string|int, string> $setters = ['agents' => 'setAgents', 'carbon_copies' => 'setCarbonCopies', 'certified_deliveries' => 'setCertifiedDeliveries', 'current_routing_order' => 'setCurrentRoutingOrder', 'editors' => 'setEditors', 'error_details' => 'setErrorDetails', 'in_person_signers' => 'setInPersonSigners', 'intermediaries' => 'setIntermediaries', 'notaries' => 'setNotaries', 'participants' => 'setParticipants', 'recipient_count' => 'setRecipientCount', 'seals' => 'setSeals', 'signers' => 'setSigners', 'witnesses' => 'setWitnesses']

$swaggerFormats

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

protected static array<string|int, string> $swaggerFormats = ['agents' => null, 'carbon_copies' => null, 'certified_deliveries' => null, 'current_routing_order' => null, 'editors' => null, 'error_details' => null, 'in_person_signers' => null, 'intermediaries' => null, 'notaries' => null, 'participants' => null, 'recipient_count' => null, 'seals' => null, 'signers' => null, 'witnesses' => null]

$swaggerModelName

The original name of the model.

protected static string $swaggerModelName = 'templateRecipients'

$swaggerTypes

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

protected static array<string|int, string> $swaggerTypes = ['agents' => '\\DocuSign\\eSign\\Model\\Agent[]', 'carbon_copies' => '\\DocuSign\\eSign\\Model\\CarbonCopy[]', 'certified_deliveries' => '\\DocuSign\\eSign\\Model\\CertifiedDelivery[]', 'current_routing_order' => '?string', 'editors' => '\\DocuSign\\eSign\\Model\\Editor[]', 'error_details' => '\\DocuSign\\eSign\\Model\\ErrorDetails', 'in_person_signers' => '\\DocuSign\\eSign\\Model\\InPersonSigner[]', 'intermediaries' => '\\DocuSign\\eSign\\Model\\Intermediary[]', 'notaries' => '\\DocuSign\\eSign\\Model\\NotaryRecipient[]', 'participants' => '\\DocuSign\\eSign\\Model\\Participant[]', 'recipient_count' => '?string', 'seals' => '\\DocuSign\\eSign\\Model\\SealSign[]', 'signers' => '\\DocuSign\\eSign\\Model\\Signer[]', 'witnesses' => '\\DocuSign\\eSign\\Model\\Witness[]']

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

getCurrentRoutingOrder()

Gets current_routing_order

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

getModelName()

The original name of the model.

public getModelName() : string
Return values
string —

getRecipientCount()

Gets recipient_count

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

setAgents()

Sets agents

public setAgents(array<string|int, Agent> $agents) : $this
Parameters
$agents : array<string|int, Agent>

A complex type defining the management and access rights of a recipient assigned assigned as an agent on the document.

Return values
$this —

setCarbonCopies()

Sets carbon_copies

public setCarbonCopies(array<string|int, CarbonCopy> $carbon_copies) : $this
Parameters
$carbon_copies : array<string|int, CarbonCopy>

A complex type containing information about recipients who should receive a copy of the envelope, but does not need to sign it.

Return values
$this —

setCertifiedDeliveries()

Sets certified_deliveries

public setCertifiedDeliveries(array<string|int, CertifiedDelivery> $certified_deliveries) : $this
Parameters
$certified_deliveries : array<string|int, CertifiedDelivery>

A complex type containing information on a recipient the must receive the completed documents for the envelope to be completed, but the recipient does not need to sign, initial, date, or add information to any of the documents.

Return values
$this —

setCurrentRoutingOrder()

Sets current_routing_order

public setCurrentRoutingOrder(string|null $current_routing_order) : $this
Parameters
$current_routing_order : string|null
Return values
$this —

setEditors()

Sets editors

public setEditors(array<string|int, Editor> $editors) : $this
Parameters
$editors : array<string|int, Editor>
Return values
$this —

setInPersonSigners()

Sets in_person_signers

public setInPersonSigners(array<string|int, InPersonSigner> $in_person_signers) : $this
Parameters
$in_person_signers : array<string|int, InPersonSigner>

Specifies a signer that is in the same physical location as a DocuSign user who will act as a Signing Host for the transaction. The recipient added is the Signing Host and new separate Signer Name field appears after Sign in person is selected.

Return values
$this —

setIntermediaries()

Sets intermediaries

public setIntermediaries(array<string|int, Intermediary> $intermediaries) : $this
Parameters
$intermediaries : array<string|int, Intermediary>

Identifies a recipient that can, but is not required to, add name and email information for recipients at the same or subsequent level in the routing order (until subsequent Agents, Editors or Intermediaries recipient types are added).

Return values
$this —

setParticipants()

Sets participants

public setParticipants(array<string|int, Participant> $participants) : $this
Parameters
$participants : array<string|int, Participant>
Return values
$this —

setRecipientCount()

Sets recipient_count

public setRecipientCount(string|null $recipient_count) : $this
Parameters
$recipient_count : string|null

The list of recipient event statuses that will trigger Connect to send updates to the url. It can be a two-part list with: * recipientEventStatusCode - The recipient status, this can be Sent, Delivered, Completed, Declined, AuthenticationFailed, and AutoResponded. * includeDocuments - When set to true, the envelope time zone information is included in the message.

Return values
$this —

setSigners()

Sets signers

public setSigners(array<string|int, Signer> $signers) : $this
Parameters
$signers : array<string|int, Signer>

A complex type containing information about the Signer recipient.

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

setWitnesses()

Sets witnesses

public setWitnesses(array<string|int, Witness> $witnesses) : $this
Parameters
$witnesses : array<string|int, Witness>
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