Documentation

BulkSendResponse
in package
implements ModelInterface, ArrayAccess

BulkSendResponse Class Doc Comment

Tags
category

Class

description

The object contains the response to a bulk send request.

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
getBatchId()  : string|null
Gets batch_id
getBatchName()  : string|null
Gets batch_name
getBatchSize()  : string|null
Gets batch_size
getEnvelopeOrTemplateId()  : string|null
Gets envelope_or_template_id
getErrorDetails()  : array<string|int, ?string>
Gets error_details
getErrors()  : array<string|int, ?string>
Gets errors
getModelName()  : string
The original name of the model.
getQueueLimit()  : string|null
Gets queue_limit
getters()  : array<string|int, mixed>
Array of attributes to getter functions (for serialization of requests)
getTotalQueued()  : string|null
Gets total_queued
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
setBatchName()  : $this
Sets batch_name
setBatchSize()  : $this
Sets batch_size
setEnvelopeOrTemplateId()  : $this
Sets envelope_or_template_id
setErrorDetails()  : $this
Sets error_details
setErrors()  : $this
Sets errors
setQueueLimit()  : $this
Sets queue_limit
setters()  : array<string|int, mixed>
Array of attributes to setter functions (for deserialization of responses)
setTotalQueued()  : $this
Sets total_queued
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 = ['batch_id' => 'batchId', 'batch_name' => 'batchName', 'batch_size' => 'batchSize', 'envelope_or_template_id' => 'envelopeOrTemplateId', 'error_details' => 'errorDetails', 'errors' => 'errors', 'queue_limit' => 'queueLimit', 'total_queued' => 'totalQueued']

$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_name' => 'getBatchName', 'batch_size' => 'getBatchSize', 'envelope_or_template_id' => 'getEnvelopeOrTemplateId', 'error_details' => 'getErrorDetails', 'errors' => 'getErrors', 'queue_limit' => 'getQueueLimit', 'total_queued' => 'getTotalQueued']

$setters

Array of attributes to setter functions (for deserialization of responses)

protected static array<string|int, string> $setters = ['batch_id' => 'setBatchId', 'batch_name' => 'setBatchName', 'batch_size' => 'setBatchSize', 'envelope_or_template_id' => 'setEnvelopeOrTemplateId', 'error_details' => 'setErrorDetails', 'errors' => 'setErrors', 'queue_limit' => 'setQueueLimit', 'total_queued' => 'setTotalQueued']

$swaggerFormats

Array of property to format mappings. Used for (de)serialization

protected static array<string|int, string> $swaggerFormats = ['batch_id' => null, 'batch_name' => null, 'batch_size' => null, 'envelope_or_template_id' => null, 'error_details' => null, 'errors' => null, 'queue_limit' => null, 'total_queued' => null]

$swaggerModelName

The original name of the model.

protected static string $swaggerModelName = 'bulkSendResponse'

$swaggerTypes

Array of property to type mappings. Used for (de)serialization

protected static array<string|int, string> $swaggerTypes = ['batch_id' => '?string', 'batch_name' => '?string', 'batch_size' => '?string', 'envelope_or_template_id' => '?string', 'error_details' => '?string[]', 'errors' => '?string[]', 'queue_limit' => '?string', 'total_queued' => '?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

getBatchName()

Gets batch_name

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

getBatchSize()

Gets batch_size

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

getEnvelopeOrTemplateId()

Gets envelope_or_template_id

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

getErrorDetails()

Gets error_details

public getErrorDetails() : array<string|int, ?string>
Return values
array<string|int, ?string>

getErrors()

Gets errors

public getErrors() : array<string|int, ?string>
Return values
array<string|int, ?string>

getModelName()

The original name of the model.

public getModelName() : string
Return values
string

getQueueLimit()

Gets queue_limit

public getQueueLimit() : 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>

getTotalQueued()

Gets total_queued

public getTotalQueued() : 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
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

setEnvelopeOrTemplateId()

Sets envelope_or_template_id

public setEnvelopeOrTemplateId(string|null $envelope_or_template_id) : $this
Parameters
$envelope_or_template_id : string|null
Return values
$this

setErrorDetails()

Sets error_details

public setErrorDetails(array<string|int, ?string> $error_details) : $this
Parameters
$error_details : array<string|int, ?string>

Array or errors.

Return values
$this

setErrors()

Sets errors

public setErrors(array<string|int, ?string> $errors) : $this
Parameters
$errors : array<string|int, ?string>
Return values
$this

setQueueLimit()

Sets queue_limit

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

setTotalQueued()

Sets total_queued

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

Search results