SignHashSessionInfoResponse
in package
implements
ModelInterface, ArrayAccess
SignHashSessionInfoResponse 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
- getDocuments() : array<string|int, SignHashDocument>
- Gets documents
- getEnvelopeId() : string|null
- Gets envelope_id
- getLanguage() : string|null
- Gets language
- getModelName() : string
- The original name of the model.
- getRedirectionUrl() : string|null
- Gets redirection_url
- getRemainingSignatureRequests() : int
- Gets remaining_signature_requests
- getSeal() : Seal
- Gets seal
- getSender() : Sender
- Gets sender
- getters() : array<string|int, mixed>
- Array of attributes to getter functions (for serialization of requests)
- getUser() : User
- Gets user
- 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.
- setDocuments() : $this
- Sets documents
- setEnvelopeId() : $this
- Sets envelope_id
- setLanguage() : $this
- Sets language
- setRedirectionUrl() : $this
- Sets redirection_url
- setRemainingSignatureRequests() : $this
- Sets remaining_signature_requests
- setSeal() : $this
- Sets seal
- setSender() : $this
- Sets sender
- setters() : array<string|int, mixed>
- Array of attributes to setter functions (for deserialization of responses)
- setUser() : $this
- Sets user
- 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
= ['documents' => 'documents', 'envelope_id' => 'envelopeId', 'language' => 'language', 'redirection_url' => 'redirectionUrl', 'remaining_signature_requests' => 'remainingSignatureRequests', 'seal' => 'seal', 'sender' => 'sender', 'user' => 'user']
$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
= ['documents' => 'getDocuments', 'envelope_id' => 'getEnvelopeId', 'language' => 'getLanguage', 'redirection_url' => 'getRedirectionUrl', 'remaining_signature_requests' => 'getRemainingSignatureRequests', 'seal' => 'getSeal', 'sender' => 'getSender', 'user' => 'getUser']
$setters
Array of attributes to setter functions (for deserialization of responses)
protected
static array<string|int, string>
$setters
= ['documents' => 'setDocuments', 'envelope_id' => 'setEnvelopeId', 'language' => 'setLanguage', 'redirection_url' => 'setRedirectionUrl', 'remaining_signature_requests' => 'setRemainingSignatureRequests', 'seal' => 'setSeal', 'sender' => 'setSender', 'user' => 'setUser']
$swaggerFormats
Array of property to format mappings. Used for (de)serialization
protected
static array<string|int, string>
$swaggerFormats
= ['documents' => null, 'envelope_id' => null, 'language' => null, 'redirection_url' => null, 'remaining_signature_requests' => 'int64', 'seal' => null, 'sender' => null, 'user' => null]
$swaggerModelName
The original name of the model.
protected
static string
$swaggerModelName
= 'signHashSessionInfoResponse'
$swaggerTypes
Array of property to type mappings. Used for (de)serialization
protected
static array<string|int, string>
$swaggerTypes
= ['documents' => '\\DocuSign\\eSign\\Model\\SignHashDocument[]', 'envelope_id' => '?string', 'language' => '?string', 'redirection_url' => '?string', 'remaining_signature_requests' => 'int', 'seal' => '\\DocuSign\\eSign\\Model\\Seal', 'sender' => '\\DocuSign\\eSign\\Model\\Sender', 'user' => '\\DocuSign\\eSign\\Model\\User']
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> —getDocuments()
Gets documents
public
getDocuments() : array<string|int, SignHashDocument>
Return values
array<string|int, SignHashDocument> —getEnvelopeId()
Gets envelope_id
public
getEnvelopeId() : string|null
Return values
string|null —getLanguage()
Gets language
public
getLanguage() : string|null
Return values
string|null —getModelName()
The original name of the model.
public
getModelName() : string
Return values
string —getRedirectionUrl()
Gets redirection_url
public
getRedirectionUrl() : string|null
Return values
string|null —getRemainingSignatureRequests()
Gets remaining_signature_requests
public
getRemainingSignatureRequests() : int
Return values
int —getSeal()
Gets seal
public
getSeal() : Seal
Return values
Seal —getSender()
Gets sender
public
getSender() : Sender
Return values
Sender —getters()
Array of attributes to getter functions (for serialization of requests)
public
static getters() : array<string|int, mixed>
Return values
array<string|int, mixed> —getUser()
Gets user
public
getUser() : User
Return values
User —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 —setDocuments()
Sets documents
public
setDocuments(array<string|int, SignHashDocument> $documents) : $this
Parameters
- $documents : array<string|int, SignHashDocument>
-
Complex element contains the details on the documents in the envelope.
Return values
$this —setEnvelopeId()
Sets envelope_id
public
setEnvelopeId(string|null $envelope_id) : $this
Parameters
- $envelope_id : string|null
-
The envelope ID of the envelope status that failed to post.
Return values
$this —setLanguage()
Sets language
public
setLanguage(string|null $language) : $this
Parameters
- $language : string|null
Return values
$this —setRedirectionUrl()
Sets redirection_url
public
setRedirectionUrl(string|null $redirection_url) : $this
Parameters
- $redirection_url : string|null
Return values
$this —setRemainingSignatureRequests()
Sets remaining_signature_requests
public
setRemainingSignatureRequests(int $remaining_signature_requests) : $this
Parameters
- $remaining_signature_requests : int
Return values
$this —setSeal()
Sets seal
public
setSeal(Seal $seal) : $this
Parameters
- $seal : Seal
-
seal
Return values
$this —setSender()
Sets sender
public
setSender(Sender $sender) : $this
Parameters
- $sender : Sender
-
sender
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> —setUser()
Sets user
public
setUser(User $user) : $this
Parameters
- $user : User
-
user
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