BulkSendBatchStatus
in package
implements
ModelInterface, ArrayAccess
BulkSendBatchStatus 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
- getAction() : string|null
- Gets action
- getActionStatus() : string|null
- Gets action_status
- getBatchId() : string|null
- Gets batch_id
- getBatchName() : string|null
- Gets batch_name
- getBatchSize() : string|null
- Gets batch_size
- getBulkErrors() : array<string|int, BulkSendErrorStatus>
- Gets bulk_errors
- getEnvelopeIdOrTemplateId() : string|null
- Gets envelope_id_or_template_id
- getEnvelopesInfo() : BulkSendEnvelopesInfo
- Gets envelopes_info
- getEnvelopesUri() : string|null
- Gets envelopes_uri
- getFailed() : string|null
- Gets failed
- getMailingListId() : string|null
- Gets mailing_list_id
- getMailingListName() : string|null
- Gets mailing_list_name
- getModelName() : string
- The original name of the model.
- getOwnerUserId() : string|null
- Gets owner_user_id
- getQueued() : string|null
- Gets queued
- getResendsRemaining() : string|null
- Gets resends_remaining
- getSenderUserId() : string|null
- Gets sender_user_id
- getSent() : string|null
- Gets sent
- getSubmittedDate() : string|null
- Gets submitted_date
- 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.
- setAction() : $this
- Sets action
- setActionStatus() : $this
- Sets action_status
- setBatchId() : $this
- Sets batch_id
- setBatchName() : $this
- Sets batch_name
- setBatchSize() : $this
- Sets batch_size
- setBulkErrors() : $this
- Sets bulk_errors
- setEnvelopeIdOrTemplateId() : $this
- Sets envelope_id_or_template_id
- setEnvelopesInfo() : $this
- Sets envelopes_info
- setEnvelopesUri() : $this
- Sets envelopes_uri
- setFailed() : $this
- Sets failed
- setMailingListId() : $this
- Sets mailing_list_id
- setMailingListName() : $this
- Sets mailing_list_name
- setOwnerUserId() : $this
- Sets owner_user_id
- setQueued() : $this
- Sets queued
- setResendsRemaining() : $this
- Sets resends_remaining
- setSenderUserId() : $this
- Sets sender_user_id
- setSent() : $this
- Sets sent
- setSubmittedDate() : $this
- Sets submitted_date
- 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
= ['action' => 'action', 'action_status' => 'actionStatus', 'batch_id' => 'batchId', 'batch_name' => 'batchName', 'batch_size' => 'batchSize', 'bulk_errors' => 'bulkErrors', 'envelope_id_or_template_id' => 'envelopeIdOrTemplateId', 'envelopes_info' => 'envelopesInfo', 'envelopes_uri' => 'envelopesUri', 'failed' => 'failed', 'mailing_list_id' => 'mailingListId', 'mailing_list_name' => 'mailingListName', 'owner_user_id' => 'ownerUserId', 'queued' => 'queued', 'resends_remaining' => 'resendsRemaining', 'sender_user_id' => 'senderUserId', 'sent' => 'sent', 'submitted_date' => 'submittedDate']
$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
= ['action' => 'getAction', 'action_status' => 'getActionStatus', 'batch_id' => 'getBatchId', 'batch_name' => 'getBatchName', 'batch_size' => 'getBatchSize', 'bulk_errors' => 'getBulkErrors', 'envelope_id_or_template_id' => 'getEnvelopeIdOrTemplateId', 'envelopes_info' => 'getEnvelopesInfo', 'envelopes_uri' => 'getEnvelopesUri', 'failed' => 'getFailed', 'mailing_list_id' => 'getMailingListId', 'mailing_list_name' => 'getMailingListName', 'owner_user_id' => 'getOwnerUserId', 'queued' => 'getQueued', 'resends_remaining' => 'getResendsRemaining', 'sender_user_id' => 'getSenderUserId', 'sent' => 'getSent', 'submitted_date' => 'getSubmittedDate']
$setters
Array of attributes to setter functions (for deserialization of responses)
protected
static array<string|int, string>
$setters
= ['action' => 'setAction', 'action_status' => 'setActionStatus', 'batch_id' => 'setBatchId', 'batch_name' => 'setBatchName', 'batch_size' => 'setBatchSize', 'bulk_errors' => 'setBulkErrors', 'envelope_id_or_template_id' => 'setEnvelopeIdOrTemplateId', 'envelopes_info' => 'setEnvelopesInfo', 'envelopes_uri' => 'setEnvelopesUri', 'failed' => 'setFailed', 'mailing_list_id' => 'setMailingListId', 'mailing_list_name' => 'setMailingListName', 'owner_user_id' => 'setOwnerUserId', 'queued' => 'setQueued', 'resends_remaining' => 'setResendsRemaining', 'sender_user_id' => 'setSenderUserId', 'sent' => 'setSent', 'submitted_date' => 'setSubmittedDate']
$swaggerFormats
Array of property to format mappings. Used for (de)serialization
protected
static array<string|int, string>
$swaggerFormats
= ['action' => null, 'action_status' => null, 'batch_id' => null, 'batch_name' => null, 'batch_size' => null, 'bulk_errors' => null, 'envelope_id_or_template_id' => null, 'envelopes_info' => null, 'envelopes_uri' => null, 'failed' => null, 'mailing_list_id' => null, 'mailing_list_name' => null, 'owner_user_id' => null, 'queued' => null, 'resends_remaining' => null, 'sender_user_id' => null, 'sent' => null, 'submitted_date' => null]
$swaggerModelName
The original name of the model.
protected
static string
$swaggerModelName
= 'bulkSendBatchStatus'
$swaggerTypes
Array of property to type mappings. Used for (de)serialization
protected
static array<string|int, string>
$swaggerTypes
= ['action' => '?string', 'action_status' => '?string', 'batch_id' => '?string', 'batch_name' => '?string', 'batch_size' => '?string', 'bulk_errors' => '\\DocuSign\\eSign\\Model\\BulkSendErrorStatus[]', 'envelope_id_or_template_id' => '?string', 'envelopes_info' => '\\DocuSign\\eSign\\Model\\BulkSendEnvelopesInfo', 'envelopes_uri' => '?string', 'failed' => '?string', 'mailing_list_id' => '?string', 'mailing_list_name' => '?string', 'owner_user_id' => '?string', 'queued' => '?string', 'resends_remaining' => '?string', 'sender_user_id' => '?string', 'sent' => '?string', 'submitted_date' => '?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> —getAction()
Gets action
public
getAction() : string|null
Return values
string|null —getActionStatus()
Gets action_status
public
getActionStatus() : string|null
Return values
string|null —getBatchId()
Gets batch_id
public
getBatchId() : string|null
Return values
string|null —getBatchName()
Gets batch_name
public
getBatchName() : string|null
Return values
string|null —getBatchSize()
Gets batch_size
public
getBatchSize() : string|null
Return values
string|null —getBulkErrors()
Gets bulk_errors
public
getBulkErrors() : array<string|int, BulkSendErrorStatus>
Return values
array<string|int, BulkSendErrorStatus> —getEnvelopeIdOrTemplateId()
Gets envelope_id_or_template_id
public
getEnvelopeIdOrTemplateId() : string|null
Return values
string|null —getEnvelopesInfo()
Gets envelopes_info
public
getEnvelopesInfo() : BulkSendEnvelopesInfo
Return values
BulkSendEnvelopesInfo —getEnvelopesUri()
Gets envelopes_uri
public
getEnvelopesUri() : string|null
Return values
string|null —getFailed()
Gets failed
public
getFailed() : string|null
Return values
string|null —getMailingListId()
Gets mailing_list_id
public
getMailingListId() : string|null
Return values
string|null —getMailingListName()
Gets mailing_list_name
public
getMailingListName() : string|null
Return values
string|null —getModelName()
The original name of the model.
public
getModelName() : string
Return values
string —getOwnerUserId()
Gets owner_user_id
public
getOwnerUserId() : string|null
Return values
string|null —getQueued()
Gets queued
public
getQueued() : string|null
Return values
string|null —getResendsRemaining()
Gets resends_remaining
public
getResendsRemaining() : string|null
Return values
string|null —getSenderUserId()
Gets sender_user_id
public
getSenderUserId() : string|null
Return values
string|null —getSent()
Gets sent
public
getSent() : 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> —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 —setAction()
Sets action
public
setAction(string|null $action) : $this
Parameters
- $action : string|null
Return values
$this —setActionStatus()
Sets action_status
public
setActionStatus(string|null $action_status) : $this
Parameters
- $action_status : string|null
Return values
$this —setBatchId()
Sets batch_id
public
setBatchId(string|null $batch_id) : $this
Parameters
- $batch_id : string|null
Return values
$this —setBatchName()
Sets batch_name
public
setBatchName(string|null $batch_name) : $this
Parameters
- $batch_name : string|null
Return values
$this —setBatchSize()
Sets batch_size
public
setBatchSize(string|null $batch_size) : $this
Parameters
- $batch_size : string|null
Return values
$this —setBulkErrors()
Sets bulk_errors
public
setBulkErrors(array<string|int, BulkSendErrorStatus> $bulk_errors) : $this
Parameters
- $bulk_errors : array<string|int, BulkSendErrorStatus>
Return values
$this —setEnvelopeIdOrTemplateId()
Sets envelope_id_or_template_id
public
setEnvelopeIdOrTemplateId(string|null $envelope_id_or_template_id) : $this
Parameters
- $envelope_id_or_template_id : string|null
Return values
$this —setEnvelopesInfo()
Sets envelopes_info
public
setEnvelopesInfo(BulkSendEnvelopesInfo $envelopes_info) : $this
Parameters
- $envelopes_info : BulkSendEnvelopesInfo
Return values
$this —setEnvelopesUri()
Sets envelopes_uri
public
setEnvelopesUri(string|null $envelopes_uri) : $this
Parameters
- $envelopes_uri : string|null
Return values
$this —setFailed()
Sets failed
public
setFailed(string|null $failed) : $this
Parameters
- $failed : string|null
Return values
$this —setMailingListId()
Sets mailing_list_id
public
setMailingListId(string|null $mailing_list_id) : $this
Parameters
- $mailing_list_id : string|null
Return values
$this —setMailingListName()
Sets mailing_list_name
public
setMailingListName(string|null $mailing_list_name) : $this
Parameters
- $mailing_list_name : string|null
Return values
$this —setOwnerUserId()
Sets owner_user_id
public
setOwnerUserId(string|null $owner_user_id) : $this
Parameters
- $owner_user_id : string|null
Return values
$this —setQueued()
Sets queued
public
setQueued(string|null $queued) : $this
Parameters
- $queued : string|null
Return values
$this —setResendsRemaining()
Sets resends_remaining
public
setResendsRemaining(string|null $resends_remaining) : $this
Parameters
- $resends_remaining : string|null
Return values
$this —setSenderUserId()
Sets sender_user_id
public
setSenderUserId(string|null $sender_user_id) : $this
Parameters
- $sender_user_id : string|null
Return values
$this —setSent()
Sets sent
public
setSent(string|null $sent) : $this
Parameters
- $sent : string|null
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> —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