BulkEnvelopeStatus
in package
implements
ModelInterface, ArrayAccess
BulkEnvelopeStatus 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
- getBatchId() : string|null
- Gets batch_id
- getBatchSize() : string|null
- Gets batch_size
- getBulkEnvelopes() : array<string|int, BulkEnvelope>
- Gets bulk_envelopes
- getBulkEnvelopesBatchUri() : string|null
- Gets bulk_envelopes_batch_uri
- getEndPosition() : string|null
- Gets end_position
- getFailed() : string|null
- Gets failed
- getModelName() : string
- The original name of the model.
- getNextUri() : string|null
- Gets next_uri
- getPreviousUri() : string|null
- Gets previous_uri
- getQueued() : string|null
- Gets queued
- getResultSetSize() : string|null
- Gets result_set_size
- getSent() : string|null
- Gets sent
- getStartPosition() : string|null
- Gets start_position
- getSubmittedDate() : string|null
- Gets submitted_date
- getters() : array<string|int, mixed>
- Array of attributes to getter functions (for serialization of requests)
- getTotalSetSize() : string|null
- Gets total_set_size
- 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.
- setBatchId() : $this
- Sets batch_id
- setBatchSize() : $this
- Sets batch_size
- setBulkEnvelopes() : $this
- Sets bulk_envelopes
- setBulkEnvelopesBatchUri() : $this
- Sets bulk_envelopes_batch_uri
- setEndPosition() : $this
- Sets end_position
- setFailed() : $this
- Sets failed
- setNextUri() : $this
- Sets next_uri
- setPreviousUri() : $this
- Sets previous_uri
- setQueued() : $this
- Sets queued
- setResultSetSize() : $this
- Sets result_set_size
- setSent() : $this
- Sets sent
- setStartPosition() : $this
- Sets start_position
- setSubmittedDate() : $this
- Sets submitted_date
- setters() : array<string|int, mixed>
- Array of attributes to setter functions (for deserialization of responses)
- setTotalSetSize() : $this
- Sets total_set_size
- 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
= ['batch_id' => 'batchId', 'batch_size' => 'batchSize', 'bulk_envelopes' => 'bulkEnvelopes', 'bulk_envelopes_batch_uri' => 'bulkEnvelopesBatchUri', 'end_position' => 'endPosition', 'failed' => 'failed', 'next_uri' => 'nextUri', 'previous_uri' => 'previousUri', 'queued' => 'queued', 'result_set_size' => 'resultSetSize', 'sent' => 'sent', 'start_position' => 'startPosition', 'submitted_date' => 'submittedDate', 'total_set_size' => 'totalSetSize']
$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
= ['batch_id' => 'getBatchId', 'batch_size' => 'getBatchSize', 'bulk_envelopes' => 'getBulkEnvelopes', 'bulk_envelopes_batch_uri' => 'getBulkEnvelopesBatchUri', 'end_position' => 'getEndPosition', 'failed' => 'getFailed', 'next_uri' => 'getNextUri', 'previous_uri' => 'getPreviousUri', 'queued' => 'getQueued', 'result_set_size' => 'getResultSetSize', 'sent' => 'getSent', 'start_position' => 'getStartPosition', 'submitted_date' => 'getSubmittedDate', 'total_set_size' => 'getTotalSetSize']
$setters
Array of attributes to setter functions (for deserialization of responses)
protected
static array<string|int, string>
$setters
= ['batch_id' => 'setBatchId', 'batch_size' => 'setBatchSize', 'bulk_envelopes' => 'setBulkEnvelopes', 'bulk_envelopes_batch_uri' => 'setBulkEnvelopesBatchUri', 'end_position' => 'setEndPosition', 'failed' => 'setFailed', 'next_uri' => 'setNextUri', 'previous_uri' => 'setPreviousUri', 'queued' => 'setQueued', 'result_set_size' => 'setResultSetSize', 'sent' => 'setSent', 'start_position' => 'setStartPosition', 'submitted_date' => 'setSubmittedDate', 'total_set_size' => 'setTotalSetSize']
$swaggerFormats
Array of property to format mappings. Used for (de)serialization
protected
static array<string|int, string>
$swaggerFormats
= ['batch_id' => null, 'batch_size' => null, 'bulk_envelopes' => null, 'bulk_envelopes_batch_uri' => null, 'end_position' => null, 'failed' => null, 'next_uri' => null, 'previous_uri' => null, 'queued' => null, 'result_set_size' => null, 'sent' => null, 'start_position' => null, 'submitted_date' => null, 'total_set_size' => null]
$swaggerModelName
The original name of the model.
protected
static string
$swaggerModelName
= 'bulkEnvelopeStatus'
$swaggerTypes
Array of property to type mappings. Used for (de)serialization
protected
static array<string|int, string>
$swaggerTypes
= ['batch_id' => '?string', 'batch_size' => '?string', 'bulk_envelopes' => '\\DocuSign\\eSign\\Model\\BulkEnvelope[]', 'bulk_envelopes_batch_uri' => '?string', 'end_position' => '?string', 'failed' => '?string', 'next_uri' => '?string', 'previous_uri' => '?string', 'queued' => '?string', 'result_set_size' => '?string', 'sent' => '?string', 'start_position' => '?string', 'submitted_date' => '?string', 'total_set_size' => '?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> —getBatchId()
Gets batch_id
public
getBatchId() : string|null
Return values
string|null —getBatchSize()
Gets batch_size
public
getBatchSize() : string|null
Return values
string|null —getBulkEnvelopes()
Gets bulk_envelopes
public
getBulkEnvelopes() : array<string|int, BulkEnvelope>
Return values
array<string|int, BulkEnvelope> —getBulkEnvelopesBatchUri()
Gets bulk_envelopes_batch_uri
public
getBulkEnvelopesBatchUri() : string|null
Return values
string|null —getEndPosition()
Gets end_position
public
getEndPosition() : string|null
Return values
string|null —getFailed()
Gets failed
public
getFailed() : string|null
Return values
string|null —getModelName()
The original name of the model.
public
getModelName() : string
Return values
string —getNextUri()
Gets next_uri
public
getNextUri() : string|null
Return values
string|null —getPreviousUri()
Gets previous_uri
public
getPreviousUri() : string|null
Return values
string|null —getQueued()
Gets queued
public
getQueued() : string|null
Return values
string|null —getResultSetSize()
Gets result_set_size
public
getResultSetSize() : string|null
Return values
string|null —getSent()
Gets sent
public
getSent() : string|null
Return values
string|null —getStartPosition()
Gets start_position
public
getStartPosition() : string|null
Return values
string|null —getSubmittedDate()
Gets submitted_date
public
getSubmittedDate() : 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> —getTotalSetSize()
Gets total_set_size
public
getTotalSetSize() : 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 —setBatchId()
Sets batch_id
public
setBatchId(string|null $batch_id) : $this
Parameters
- $batch_id : string|null
-
Specifies an identifier which can be used to retrieve a more detailed status of individual bulk recipient batches.
Return values
$this —setBatchSize()
Sets batch_size
public
setBatchSize(string|null $batch_size) : $this
Parameters
- $batch_size : string|null
-
The number of items returned in this response.
Return values
$this —setBulkEnvelopes()
Sets bulk_envelopes
public
setBulkEnvelopes(array<string|int, BulkEnvelope> $bulk_envelopes) : $this
Parameters
- $bulk_envelopes : array<string|int, BulkEnvelope>
-
Reserved: TBD
Return values
$this —setBulkEnvelopesBatchUri()
Sets bulk_envelopes_batch_uri
public
setBulkEnvelopesBatchUri(string|null $bulk_envelopes_batch_uri) : $this
Parameters
- $bulk_envelopes_batch_uri : string|null
-
Reserved: TBD
Return values
$this —setEndPosition()
Sets end_position
public
setEndPosition(string|null $end_position) : $this
Parameters
- $end_position : string|null
-
The last position in the result set.
Return values
$this —setFailed()
Sets failed
public
setFailed(string|null $failed) : $this
Parameters
- $failed : string|null
-
The number of entries with a status of failed.
Return values
$this —setNextUri()
Sets next_uri
public
setNextUri(string|null $next_uri) : $this
Parameters
- $next_uri : string|null
-
The URI to the next chunk of records based on the search request. If the endPosition is the entire results of the search, this is null.
Return values
$this —setPreviousUri()
Sets previous_uri
public
setPreviousUri(string|null $previous_uri) : $this
Parameters
- $previous_uri : string|null
-
The postal code for the billing address.
Return values
$this —setQueued()
Sets queued
public
setQueued(string|null $queued) : $this
Parameters
- $queued : string|null
-
The number of entries with a status of queued.
Return values
$this —setResultSetSize()
Sets result_set_size
public
setResultSetSize(string|null $result_set_size) : $this
Parameters
- $result_set_size : string|null
-
The number of results returned in this response.
Return values
$this —setSent()
Sets sent
public
setSent(string|null $sent) : $this
Parameters
- $sent : string|null
-
The number of entries with a status of sent.
Return values
$this —setStartPosition()
Sets start_position
public
setStartPosition(string|null $start_position) : $this
Parameters
- $start_position : string|null
-
Starting position of the current result set.
Return values
$this —setSubmittedDate()
Sets submitted_date
public
setSubmittedDate(string|null $submitted_date) : $this
Parameters
- $submitted_date : 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> —setTotalSetSize()
Sets total_set_size
public
setTotalSetSize(string|null $total_set_size) : $this
Parameters
- $total_set_size : string|null
-
The total number of items available in the result set. This will always be greater than or equal to the value of the property returning the results in the in the response.
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