Documentation

BulkSendErrorStatus
in package
implements ModelInterface, ArrayAccess

BulkSendErrorStatus Class Doc Comment

Tags
category

Class

description

A single bulk send error report.

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
getCreated()  : string|null
Gets created
getEnvelopeId()  : string|null
Gets envelope_id
getErrorMessage()  : string|null
Gets error_message
getModelName()  : string
The original name of the model.
getRecipientEmails()  : array<string|int, ?string>
Gets recipient_emails
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.
setCreated()  : $this
Sets created
setEnvelopeId()  : $this
Sets envelope_id
setErrorMessage()  : $this
Sets error_message
setRecipientEmails()  : $this
Sets recipient_emails
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 = ['created' => 'created', 'envelope_id' => 'envelopeId', 'error_message' => 'errorMessage', 'recipient_emails' => 'recipientEmails']

$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 = ['created' => 'getCreated', 'envelope_id' => 'getEnvelopeId', 'error_message' => 'getErrorMessage', 'recipient_emails' => 'getRecipientEmails']

$setters

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

protected static array<string|int, string> $setters = ['created' => 'setCreated', 'envelope_id' => 'setEnvelopeId', 'error_message' => 'setErrorMessage', 'recipient_emails' => 'setRecipientEmails']

$swaggerFormats

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

protected static array<string|int, string> $swaggerFormats = ['created' => null, 'envelope_id' => null, 'error_message' => null, 'recipient_emails' => null]

$swaggerModelName

The original name of the model.

protected static string $swaggerModelName = 'bulkSendErrorStatus'

$swaggerTypes

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

protected static array<string|int, string> $swaggerTypes = ['created' => '?string', 'envelope_id' => '?string', 'error_message' => '?string', 'recipient_emails' => '?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>

getCreated()

Gets created

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

getEnvelopeId()

Gets envelope_id

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

getErrorMessage()

Gets error_message

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

getModelName()

The original name of the model.

public getModelName() : string
Return values
string

getRecipientEmails()

Gets recipient_emails

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

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

setCreated()

Sets created

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

setErrorMessage()

Sets error_message

public setErrorMessage(string|null $error_message) : $this
Parameters
$error_message : string|null
Return values
$this

setRecipientEmails()

Sets recipient_emails

public setRecipientEmails(array<string|int, ?string> $recipient_emails) : $this
Parameters
$recipient_emails : array<string|int, ?string>
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