SignHashDocument
in package
implements
ModelInterface, ArrayAccess
SignHashDocument 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
- getData() : string|null
- Gets data
- getDocumentId() : string|null
- Gets document_id
- getFormat() : string|null
- Gets format
- getModelName() : string
- The original name of the model.
- getName() : string|null
- Gets name
- getRemainingSignatures() : int
- Gets remaining_signatures
- getRevisions() : array<string|int, Revision>
- Gets revisions
- getSignatureProperties() : SignatureProperties
- Gets signature_properties
- getSignatureType() : string|null
- Gets signature_type
- 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.
- setData() : $this
- Sets data
- setDocumentId() : $this
- Sets document_id
- setFormat() : $this
- Sets format
- setName() : $this
- Sets name
- setRemainingSignatures() : $this
- Sets remaining_signatures
- setRevisions() : $this
- Sets revisions
- setSignatureProperties() : $this
- Sets signature_properties
- setSignatureType() : $this
- Sets signature_type
- 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
= ['data' => 'data', 'document_id' => 'documentId', 'format' => 'format', 'name' => 'name', 'remaining_signatures' => 'remainingSignatures', 'revisions' => 'revisions', 'signature_properties' => 'signatureProperties', 'signature_type' => 'signatureType']
$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', 'format' => 'getFormat', 'name' => 'getName', 'remaining_signatures' => 'getRemainingSignatures', 'revisions' => 'getRevisions', 'signature_properties' => 'getSignatureProperties', 'signature_type' => 'getSignatureType']
$setters
Array of attributes to setter functions (for deserialization of responses)
protected
static array<string|int, string>
$setters
= ['data' => 'setData', 'document_id' => 'setDocumentId', 'format' => 'setFormat', 'name' => 'setName', 'remaining_signatures' => 'setRemainingSignatures', 'revisions' => 'setRevisions', 'signature_properties' => 'setSignatureProperties', 'signature_type' => 'setSignatureType']
$swaggerFormats
Array of property to format mappings. Used for (de)serialization
protected
static array<string|int, string>
$swaggerFormats
= ['data' => null, 'document_id' => null, 'format' => null, 'name' => null, 'remaining_signatures' => 'int64', 'revisions' => null, 'signature_properties' => null, 'signature_type' => null]
$swaggerModelName
The original name of the model.
protected
static string
$swaggerModelName
= 'signHashDocument'
$swaggerTypes
Array of property to type mappings. Used for (de)serialization
protected
static array<string|int, string>
$swaggerTypes
= ['data' => '?string', 'document_id' => '?string', 'format' => '?string', 'name' => '?string', 'remaining_signatures' => 'int', 'revisions' => '\\DocuSign\\eSign\\Model\\Revision[]', 'signature_properties' => '\\DocuSign\\eSign\\Model\\SignatureProperties', 'signature_type' => '?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> —getData()
Gets data
public
getData() : string|null
Return values
string|null —getDocumentId()
Gets document_id
public
getDocumentId() : string|null
Return values
string|null —getFormat()
Gets format
public
getFormat() : 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 —getRemainingSignatures()
Gets remaining_signatures
public
getRemainingSignatures() : int
Return values
int —getRevisions()
Gets revisions
public
getRevisions() : array<string|int, Revision>
Return values
array<string|int, Revision> —getSignatureProperties()
Gets signature_properties
public
getSignatureProperties() : SignatureProperties
Return values
SignatureProperties —getSignatureType()
Gets signature_type
public
getSignatureType() : 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 —setFormat()
Sets format
public
setFormat(string|null $format) : $this
Parameters
- $format : string|null
Return values
$this —setName()
Sets name
public
setName(string|null $name) : $this
Parameters
- $name : string|null
Return values
$this —setRemainingSignatures()
Sets remaining_signatures
public
setRemainingSignatures(int $remaining_signatures) : $this
Parameters
- $remaining_signatures : int
Return values
$this —setRevisions()
Sets revisions
public
setRevisions(array<string|int, Revision> $revisions) : $this
Parameters
- $revisions : array<string|int, Revision>
Return values
$this —setSignatureProperties()
Sets signature_properties
public
setSignatureProperties(SignatureProperties $signature_properties) : $this
Parameters
- $signature_properties : SignatureProperties
-
signature_properties
Return values
$this —setSignatureType()
Sets signature_type
public
setSignatureType(string|null $signature_type) : $this
Parameters
- $signature_type : 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