Documentation

BulkSendBatchSummary
in package
implements ModelInterface, ArrayAccess

BulkSendBatchSummary Class Doc Comment

Tags
category

Class

description

Summary status of a single batch.

author

Swagger Codegen team apihelp@docusign.com

license

The Docusign PHP Client SDK is licensed under the MIT License.

link
https://github.com/swagger-api/swagger-codegen

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
getBatchUri()  : string|null
Gets batch_uri
getFailed()  : string|null
Gets failed
getModelName()  : string
The original name of the model.
getQueued()  : string|null
Gets queued
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
setBatchUri()  : $this
Sets batch_uri
setFailed()  : $this
Sets failed
setQueued()  : $this
Sets queued
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

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', 'batch_uri' => 'batchUri', 'failed' => 'failed', 'queued' => 'queued', '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', 'batch_uri' => 'getBatchUri', 'failed' => 'getFailed', 'queued' => 'getQueued', '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', 'batch_uri' => 'setBatchUri', 'failed' => 'setFailed', 'queued' => 'setQueued', '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, 'batch_uri' => null, 'failed' => null, 'queued' => null, 'sent' => null, 'submitted_date' => null]

$swaggerModelName

The original name of the model.

protected static string $swaggerModelName = 'bulkSendBatchSummary'

$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', 'batch_uri' => '?string', 'failed' => '?string', 'queued' => '?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>

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

getBatchUri()

Gets batch_uri

public getBatchUri() : string|null
Return values
string|null

getModelName()

The original name of the model.

public getModelName() : string
Return values
string

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

setBatchUri()

Sets batch_uri

public setBatchUri(string|null $batch_uri) : $this
Parameters
$batch_uri : string|null
Return values
$this

setFailed()

Sets failed

public setFailed(string|null $failed) : $this
Parameters
$failed : string|null
Return values
$this

setQueued()

Sets queued

public setQueued(string|null $queued) : $this
Parameters
$queued : 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

Search results