CompleteSignRequest
in package
implements
ModelInterface, ArrayAccess
CompleteSignRequest 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
- getCertificate() : string|null
- Gets certificate
- getCorrelationId() : string|null
- Gets correlation_id
- getDocumentUpdateInfos() : array<string|int, DocumentUpdateInfo>
- Gets document_update_infos
- getMaxSignatureLength() : string|null
- Gets max_signature_length
- getModelName() : string
- The original name of the model.
- getSigningLocation() : string|null
- Gets signing_location
- getters() : array<string|int, mixed>
- Array of attributes to getter functions (for serialization of requests)
- getTransactionId() : string|null
- Gets transaction_id
- 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.
- setCertificate() : $this
- Sets certificate
- setCorrelationId() : $this
- Sets correlation_id
- setDocumentUpdateInfos() : $this
- Sets document_update_infos
- setMaxSignatureLength() : $this
- Sets max_signature_length
- setSigningLocation() : $this
- Sets signing_location
- setters() : array<string|int, mixed>
- Array of attributes to setter functions (for deserialization of responses)
- setTransactionId() : $this
- Sets transaction_id
- 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
= ['certificate' => 'certificate', 'correlation_id' => 'correlationId', 'document_update_infos' => 'documentUpdateInfos', 'max_signature_length' => 'maxSignatureLength', 'signing_location' => 'signingLocation', 'transaction_id' => 'transactionId']
$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
= ['certificate' => 'getCertificate', 'correlation_id' => 'getCorrelationId', 'document_update_infos' => 'getDocumentUpdateInfos', 'max_signature_length' => 'getMaxSignatureLength', 'signing_location' => 'getSigningLocation', 'transaction_id' => 'getTransactionId']
$setters
Array of attributes to setter functions (for deserialization of responses)
protected
static array<string|int, string>
$setters
= ['certificate' => 'setCertificate', 'correlation_id' => 'setCorrelationId', 'document_update_infos' => 'setDocumentUpdateInfos', 'max_signature_length' => 'setMaxSignatureLength', 'signing_location' => 'setSigningLocation', 'transaction_id' => 'setTransactionId']
$swaggerFormats
Array of property to format mappings. Used for (de)serialization
protected
static array<string|int, string>
$swaggerFormats
= ['certificate' => null, 'correlation_id' => null, 'document_update_infos' => null, 'max_signature_length' => null, 'signing_location' => null, 'transaction_id' => null]
$swaggerModelName
The original name of the model.
protected
static string
$swaggerModelName
= 'completeSignRequest'
$swaggerTypes
Array of property to type mappings. Used for (de)serialization
protected
static array<string|int, string>
$swaggerTypes
= ['certificate' => '?string', 'correlation_id' => '?string', 'document_update_infos' => '\\DocuSign\\eSign\\Model\\DocumentUpdateInfo[]', 'max_signature_length' => '?string', 'signing_location' => '?string', 'transaction_id' => '?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> —getCertificate()
Gets certificate
public
getCertificate() : string|null
Return values
string|null —getCorrelationId()
Gets correlation_id
public
getCorrelationId() : string|null
Return values
string|null —getDocumentUpdateInfos()
Gets document_update_infos
public
getDocumentUpdateInfos() : array<string|int, DocumentUpdateInfo>
Return values
array<string|int, DocumentUpdateInfo> —getMaxSignatureLength()
Gets max_signature_length
public
getMaxSignatureLength() : string|null
Return values
string|null —getModelName()
The original name of the model.
public
getModelName() : string
Return values
string —getSigningLocation()
Gets signing_location
public
getSigningLocation() : 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> —getTransactionId()
Gets transaction_id
public
getTransactionId() : 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 —setCertificate()
Sets certificate
public
setCertificate(string|null $certificate) : $this
Parameters
- $certificate : string|null
Return values
$this —setCorrelationId()
Sets correlation_id
public
setCorrelationId(string|null $correlation_id) : $this
Parameters
- $correlation_id : string|null
Return values
$this —setDocumentUpdateInfos()
Sets document_update_infos
public
setDocumentUpdateInfos(array<string|int, DocumentUpdateInfo> $document_update_infos) : $this
Parameters
- $document_update_infos : array<string|int, DocumentUpdateInfo>
Return values
$this —setMaxSignatureLength()
Sets max_signature_length
public
setMaxSignatureLength(string|null $max_signature_length) : $this
Parameters
- $max_signature_length : string|null
Return values
$this —setSigningLocation()
Sets signing_location
public
setSigningLocation(string|null $signing_location) : $this
Parameters
- $signing_location : string|null
-
Specifies the physical location where the signing takes place. It can have two enumeration values; InPerson and Online. The default value is Online.
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> —setTransactionId()
Sets transaction_id
public
setTransactionId(string|null $transaction_id) : $this
Parameters
- $transaction_id : string|null
-
Used to identify an envelope. The id is a sender-generated value and is valid in the DocuSign system for 7 days. It is recommended that a transaction ID is used for offline signing to ensure that an envelope is not sent multiple times. The
transactionIdproperty can be used determine an envelope's status (i.e. was it created or not) in cases where the internet connection was lost before the envelope status was returned.
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