TemplateSummary
in package
implements
ModelInterface, ArrayAccess
TemplateSummary 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
- getApplied() : string|null
- Gets applied
- getDocumentId() : string|null
- Gets document_id
- getDocumentName() : string|null
- Gets document_name
- getErrorDetails() : ErrorDetails
- Gets error_details
- getModelName() : string
- The original name of the model.
- getName() : string|null
- Gets name
- getTemplateId() : string|null
- Gets template_id
- getTemplateMatch() : TemplateMatch
- Gets template_match
- getters() : array<string|int, mixed>
- Array of attributes to getter functions (for serialization of requests)
- getUri() : string|null
- Gets uri
- 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.
- setApplied() : $this
- Sets applied
- setDocumentId() : $this
- Sets document_id
- setDocumentName() : $this
- Sets document_name
- setErrorDetails() : $this
- Sets error_details
- setName() : $this
- Sets name
- setTemplateId() : $this
- Sets template_id
- setTemplateMatch() : $this
- Sets template_match
- setters() : array<string|int, mixed>
- Array of attributes to setter functions (for deserialization of responses)
- setUri() : $this
- Sets uri
- 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
= ['applied' => 'applied', 'document_id' => 'documentId', 'document_name' => 'documentName', 'error_details' => 'errorDetails', 'name' => 'name', 'template_id' => 'templateId', 'template_match' => 'templateMatch', 'uri' => 'uri']
$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
= ['applied' => 'getApplied', 'document_id' => 'getDocumentId', 'document_name' => 'getDocumentName', 'error_details' => 'getErrorDetails', 'name' => 'getName', 'template_id' => 'getTemplateId', 'template_match' => 'getTemplateMatch', 'uri' => 'getUri']
$setters
Array of attributes to setter functions (for deserialization of responses)
protected
static array<string|int, string>
$setters
= ['applied' => 'setApplied', 'document_id' => 'setDocumentId', 'document_name' => 'setDocumentName', 'error_details' => 'setErrorDetails', 'name' => 'setName', 'template_id' => 'setTemplateId', 'template_match' => 'setTemplateMatch', 'uri' => 'setUri']
$swaggerFormats
Array of property to format mappings. Used for (de)serialization
protected
static array<string|int, string>
$swaggerFormats
= ['applied' => null, 'document_id' => null, 'document_name' => null, 'error_details' => null, 'name' => null, 'template_id' => null, 'template_match' => null, 'uri' => null]
$swaggerModelName
The original name of the model.
protected
static string
$swaggerModelName
= 'templateSummary'
$swaggerTypes
Array of property to type mappings. Used for (de)serialization
protected
static array<string|int, string>
$swaggerTypes
= ['applied' => '?string', 'document_id' => '?string', 'document_name' => '?string', 'error_details' => '\\DocuSign\\eSign\\Model\\ErrorDetails', 'name' => '?string', 'template_id' => '?string', 'template_match' => '\\DocuSign\\eSign\\Model\\TemplateMatch', 'uri' => '?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> —getApplied()
Gets applied
public
getApplied() : string|null
Return values
string|null —getDocumentId()
Gets document_id
public
getDocumentId() : string|null
Return values
string|null —getDocumentName()
Gets document_name
public
getDocumentName() : string|null
Return values
string|null —getErrorDetails()
Gets error_details
public
getErrorDetails() : ErrorDetails
Return values
ErrorDetails —getModelName()
The original name of the model.
public
getModelName() : string
Return values
string —getName()
Gets name
public
getName() : string|null
Return values
string|null —getTemplateId()
Gets template_id
public
getTemplateId() : string|null
Return values
string|null —getTemplateMatch()
Gets template_match
public
getTemplateMatch() : TemplateMatch
Return values
TemplateMatch —getters()
Array of attributes to getter functions (for serialization of requests)
public
static getters() : array<string|int, mixed>
Return values
array<string|int, mixed> —getUri()
Gets uri
public
getUri() : 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 —setApplied()
Sets applied
public
setApplied(string|null $applied) : $this
Parameters
- $applied : string|null
-
Reserved: TBD
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 —setDocumentName()
Sets document_name
public
setDocumentName(string|null $document_name) : $this
Parameters
- $document_name : string|null
Return values
$this —setErrorDetails()
Sets error_details
public
setErrorDetails(ErrorDetails $error_details) : $this
Parameters
- $error_details : ErrorDetails
-
Array or errors.
Return values
$this —setName()
Sets name
public
setName(string|null $name) : $this
Parameters
- $name : string|null
Return values
$this —setTemplateId()
Sets template_id
public
setTemplateId(string|null $template_id) : $this
Parameters
- $template_id : string|null
-
The unique identifier of the template. If this is not provided, DocuSign will generate a value.
Return values
$this —setTemplateMatch()
Sets template_match
public
setTemplateMatch(TemplateMatch $template_match) : $this
Parameters
- $template_match : TemplateMatch
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> —setUri()
Sets uri
public
setUri(string|null $uri) : $this
Parameters
- $uri : 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