EnvelopeSummary
in package
implements
ModelInterface, ArrayAccess
EnvelopeSummary 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
- getBulkEnvelopeStatus() : BulkEnvelopeStatus
- Gets bulk_envelope_status
- getEnvelopeId() : string|null
- Gets envelope_id
- getErrorDetails() : ErrorDetails
- Gets error_details
- getModelName() : string
- The original name of the model.
- getRecipientSigningUri() : string|null
- Gets recipient_signing_uri
- getRecipientSigningUriError() : string|null
- Gets recipient_signing_uri_error
- getStatus() : string|null
- Gets status
- getStatusDateTime() : string|null
- Gets status_date_time
- 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.
- setBulkEnvelopeStatus() : $this
- Sets bulk_envelope_status
- setEnvelopeId() : $this
- Sets envelope_id
- setErrorDetails() : $this
- Sets error_details
- setRecipientSigningUri() : $this
- Sets recipient_signing_uri
- setRecipientSigningUriError() : $this
- Sets recipient_signing_uri_error
- setStatus() : $this
- Sets status
- setStatusDateTime() : $this
- Sets status_date_time
- 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
= ['bulk_envelope_status' => 'bulkEnvelopeStatus', 'envelope_id' => 'envelopeId', 'error_details' => 'errorDetails', 'recipient_signing_uri' => 'recipientSigningUri', 'recipient_signing_uri_error' => 'recipientSigningUriError', 'status' => 'status', 'status_date_time' => 'statusDateTime', '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
= ['bulk_envelope_status' => 'getBulkEnvelopeStatus', 'envelope_id' => 'getEnvelopeId', 'error_details' => 'getErrorDetails', 'recipient_signing_uri' => 'getRecipientSigningUri', 'recipient_signing_uri_error' => 'getRecipientSigningUriError', 'status' => 'getStatus', 'status_date_time' => 'getStatusDateTime', 'uri' => 'getUri']
$setters
Array of attributes to setter functions (for deserialization of responses)
protected
static array<string|int, string>
$setters
= ['bulk_envelope_status' => 'setBulkEnvelopeStatus', 'envelope_id' => 'setEnvelopeId', 'error_details' => 'setErrorDetails', 'recipient_signing_uri' => 'setRecipientSigningUri', 'recipient_signing_uri_error' => 'setRecipientSigningUriError', 'status' => 'setStatus', 'status_date_time' => 'setStatusDateTime', 'uri' => 'setUri']
$swaggerFormats
Array of property to format mappings. Used for (de)serialization
protected
static array<string|int, string>
$swaggerFormats
= ['bulk_envelope_status' => null, 'envelope_id' => null, 'error_details' => null, 'recipient_signing_uri' => null, 'recipient_signing_uri_error' => null, 'status' => null, 'status_date_time' => null, 'uri' => null]
$swaggerModelName
The original name of the model.
protected
static string
$swaggerModelName
= 'envelopeSummary'
$swaggerTypes
Array of property to type mappings. Used for (de)serialization
protected
static array<string|int, string>
$swaggerTypes
= ['bulk_envelope_status' => '\\DocuSign\\eSign\\Model\\BulkEnvelopeStatus', 'envelope_id' => '?string', 'error_details' => '\\DocuSign\\eSign\\Model\\ErrorDetails', 'recipient_signing_uri' => '?string', 'recipient_signing_uri_error' => '?string', 'status' => '?string', 'status_date_time' => '?string', '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> —getBulkEnvelopeStatus()
Gets bulk_envelope_status
public
getBulkEnvelopeStatus() : BulkEnvelopeStatus
Return values
BulkEnvelopeStatus —getEnvelopeId()
Gets envelope_id
public
getEnvelopeId() : 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 —getRecipientSigningUri()
Gets recipient_signing_uri
public
getRecipientSigningUri() : string|null
Return values
string|null —getRecipientSigningUriError()
Gets recipient_signing_uri_error
public
getRecipientSigningUriError() : string|null
Return values
string|null —getStatus()
Gets status
public
getStatus() : string|null
Return values
string|null —getStatusDateTime()
Gets status_date_time
public
getStatusDateTime() : 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> —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 —setBulkEnvelopeStatus()
Sets bulk_envelope_status
public
setBulkEnvelopeStatus(BulkEnvelopeStatus $bulk_envelope_status) : $this
Parameters
- $bulk_envelope_status : BulkEnvelopeStatus
-
An object that describes the status of the bulk send envelopes.
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 —setErrorDetails()
Sets error_details
public
setErrorDetails(ErrorDetails $error_details) : $this
Parameters
- $error_details : ErrorDetails
-
Array or errors.
Return values
$this —setRecipientSigningUri()
Sets recipient_signing_uri
public
setRecipientSigningUri(string|null $recipient_signing_uri) : $this
Parameters
- $recipient_signing_uri : string|null
Return values
$this —setRecipientSigningUriError()
Sets recipient_signing_uri_error
public
setRecipientSigningUriError(string|null $recipient_signing_uri_error) : $this
Parameters
- $recipient_signing_uri_error : string|null
Return values
$this —setStatus()
Sets status
public
setStatus(string|null $status) : $this
Parameters
- $status : string|null
-
Indicates the envelope status. Valid values are: * sent - The envelope is sent to the recipients. * created - The envelope is saved as a draft and can be modified and sent later.
Return values
$this —setStatusDateTime()
Sets status_date_time
public
setStatusDateTime(string|null $status_date_time) : $this
Parameters
- $status_date_time : string|null
-
The DateTime that the envelope changed status (i.e. was created or sent.)
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