InlineTemplate
in package
implements
ModelInterface, ArrayAccess
InlineTemplate Class Doc Comment
Tags
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
- getCustomFields() : CustomFields
- Gets custom_fields
- getDocuments() : array<string|int, Document>
- Gets documents
- getEnvelope() : Envelope
- Gets envelope
- getModelName() : string
- The original name of the model.
- getRecipients() : Recipients
- Gets recipients
- getSequence() : string|null
- Gets sequence
- 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.
- setCustomFields() : $this
- Sets custom_fields
- setDocuments() : $this
- Sets documents
- setEnvelope() : $this
- Sets envelope
- setRecipients() : $this
- Sets recipients
- setSequence() : $this
- Sets sequence
- 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
DISCRIMINATOR
public
mixed
DISCRIMINATOR
= null
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
= ['custom_fields' => 'customFields', 'documents' => 'documents', 'envelope' => 'envelope', 'recipients' => 'recipients', 'sequence' => 'sequence']
$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
= ['custom_fields' => 'getCustomFields', 'documents' => 'getDocuments', 'envelope' => 'getEnvelope', 'recipients' => 'getRecipients', 'sequence' => 'getSequence']
$setters
Array of attributes to setter functions (for deserialization of responses)
protected
static array<string|int, string>
$setters
= ['custom_fields' => 'setCustomFields', 'documents' => 'setDocuments', 'envelope' => 'setEnvelope', 'recipients' => 'setRecipients', 'sequence' => 'setSequence']
$swaggerFormats
Array of property to format mappings. Used for (de)serialization
protected
static array<string|int, string>
$swaggerFormats
= ['custom_fields' => null, 'documents' => null, 'envelope' => null, 'recipients' => null, 'sequence' => null]
$swaggerModelName
The original name of the model.
protected
static string
$swaggerModelName
= 'inlineTemplate'
$swaggerTypes
Array of property to type mappings. Used for (de)serialization
protected
static array<string|int, string>
$swaggerTypes
= ['custom_fields' => '\\DocuSign\\eSign\\Model\\CustomFields', 'documents' => '\\DocuSign\\eSign\\Model\\Document[]', 'envelope' => '\\DocuSign\\eSign\\Model\\Envelope', 'recipients' => '\\DocuSign\\eSign\\Model\\Recipients', 'sequence' => '?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> —getCustomFields()
Gets custom_fields
public
getCustomFields() : CustomFields
Return values
CustomFields —getDocuments()
Gets documents
public
getDocuments() : array<string|int, Document>
Return values
array<string|int, Document> —getEnvelope()
Gets envelope
public
getEnvelope() : Envelope
Return values
Envelope —getModelName()
The original name of the model.
public
getModelName() : string
Return values
string —getRecipients()
Gets recipients
public
getRecipients() : Recipients
Return values
Recipients —getSequence()
Gets sequence
public
getSequence() : 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 —setCustomFields()
Sets custom_fields
public
setCustomFields(CustomFields $custom_fields) : $this
Parameters
- $custom_fields : CustomFields
-
An optional array of strings that allows the sender to provide custom data about the recipient. This information is returned in the envelope status but otherwise not used by DocuSign. Each customField string can be a maximum of 100 characters.
Return values
$this —setDocuments()
Sets documents
public
setDocuments(array<string|int, Document> $documents) : $this
Parameters
- $documents : array<string|int, Document>
-
Complex element contains the details on the documents in the envelope.
Return values
$this —setEnvelope()
Sets envelope
public
setEnvelope(Envelope $envelope) : $this
Parameters
- $envelope : Envelope
-
A container used to send documents to recipients. The envelope carries information about the sender and timestamps to indicate the progress of the delivery procedure. It can contain collections of Documents, Tabs and Recipients.
Return values
$this —setRecipients()
Sets recipients
public
setRecipients(Recipients $recipients) : $this
Parameters
- $recipients : Recipients
-
An array of powerform recipients.
Return values
$this —setSequence()
Sets sequence
public
setSequence(string|null $sequence) : $this
Parameters
- $sequence : string|null
-
Specifies the order in which templates are overlaid.
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