Documentation

BulkEnvelope
in package
implements ModelInterface, ArrayAccess

BulkEnvelope Class Doc Comment

Tags
category

Class

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
getBulkRecipientRow()  : string|null
Gets bulk_recipient_row
getBulkStatus()  : string|null
Gets bulk_status
getEmail()  : string|null
Gets email
getEnvelopeId()  : string|null
Gets envelope_id
getEnvelopeUri()  : string|null
Gets envelope_uri
getErrorDetails()  : ErrorDetails
Gets error_details
getModelName()  : string
The original name of the model.
getName()  : string|null
Gets name
getSubmittedDateTime()  : string|null
Gets submitted_date_time
getters()  : array<string|int, mixed>
Array of attributes to getter functions (for serialization of requests)
getTransactionId()  : string|null
Gets transaction_id
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.
setBulkRecipientRow()  : $this
Sets bulk_recipient_row
setBulkStatus()  : $this
Sets bulk_status
setEmail()  : $this
Sets email
setEnvelopeId()  : $this
Sets envelope_id
setEnvelopeUri()  : $this
Sets envelope_uri
setErrorDetails()  : $this
Sets error_details
setName()  : $this
Sets name
setSubmittedDateTime()  : $this
Sets submitted_date_time
setters()  : array<string|int, mixed>
Array of attributes to setter functions (for deserialization of responses)
setTransactionId()  : $this
Sets transaction_id
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 = ['bulk_recipient_row' => 'bulkRecipientRow', 'bulk_status' => 'bulkStatus', 'email' => 'email', 'envelope_id' => 'envelopeId', 'envelope_uri' => 'envelopeUri', 'error_details' => 'errorDetails', 'name' => 'name', 'submitted_date_time' => 'submittedDateTime', 'transaction_id' => 'transactionId']

$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 = ['bulk_recipient_row' => 'getBulkRecipientRow', 'bulk_status' => 'getBulkStatus', 'email' => 'getEmail', 'envelope_id' => 'getEnvelopeId', 'envelope_uri' => 'getEnvelopeUri', 'error_details' => 'getErrorDetails', 'name' => 'getName', 'submitted_date_time' => 'getSubmittedDateTime', 'transaction_id' => 'getTransactionId']

$setters

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

protected static array<string|int, string> $setters = ['bulk_recipient_row' => 'setBulkRecipientRow', 'bulk_status' => 'setBulkStatus', 'email' => 'setEmail', 'envelope_id' => 'setEnvelopeId', 'envelope_uri' => 'setEnvelopeUri', 'error_details' => 'setErrorDetails', 'name' => 'setName', 'submitted_date_time' => 'setSubmittedDateTime', 'transaction_id' => 'setTransactionId']

$swaggerFormats

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

protected static array<string|int, string> $swaggerFormats = ['bulk_recipient_row' => null, 'bulk_status' => null, 'email' => null, 'envelope_id' => null, 'envelope_uri' => null, 'error_details' => null, 'name' => null, 'submitted_date_time' => null, 'transaction_id' => null]

$swaggerModelName

The original name of the model.

protected static string $swaggerModelName = 'bulkEnvelope'

$swaggerTypes

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

protected static array<string|int, string> $swaggerTypes = ['bulk_recipient_row' => '?string', 'bulk_status' => '?string', 'email' => '?string', 'envelope_id' => '?string', 'envelope_uri' => '?string', 'error_details' => '\\DocuSign\\eSign\\Model\\ErrorDetails', 'name' => '?string', 'submitted_date_time' => '?string', 'transaction_id' => '?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> —

getBulkRecipientRow()

Gets bulk_recipient_row

public getBulkRecipientRow() : string|null
Return values
string|null —

getBulkStatus()

Gets bulk_status

public getBulkStatus() : string|null
Return values
string|null —

getEmail()

Gets email

public getEmail() : string|null
Return values
string|null —

getEnvelopeId()

Gets envelope_id

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

getEnvelopeUri()

Gets envelope_uri

public getEnvelopeUri() : string|null
Return values
string|null —

getModelName()

The original name of the model.

public getModelName() : string
Return values
string —

getName()

Gets name

public getName() : string|null
Return values
string|null —

getSubmittedDateTime()

Gets submitted_date_time

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

getTransactionId()

Gets transaction_id

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

setBulkRecipientRow()

Sets bulk_recipient_row

public setBulkRecipientRow(string|null $bulk_recipient_row) : $this
Parameters
$bulk_recipient_row : string|null

Reserved: TBD

Return values
$this —

setBulkStatus()

Sets bulk_status

public setBulkStatus(string|null $bulk_status) : $this
Parameters
$bulk_status : string|null

Indicates the status of the bulk send operation. Returned values can be: * queued * processing * sent * failed

Return values
$this —

setEmail()

Sets email

public setEmail(string|null $email) : $this
Parameters
$email : 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 —

setEnvelopeUri()

Sets envelope_uri

public setEnvelopeUri(string|null $envelope_uri) : $this
Parameters
$envelope_uri : string|null

Contains a URI for an endpoint that you can use to retrieve the envelope or envelopes.

Return values
$this —

setErrorDetails()

Sets error_details

public setErrorDetails(ErrorDetails $error_details) : $this
Parameters
$error_details : ErrorDetails

Array or errors.

Return values
$this —

setName()

Sets name

public setName(string|null $name) : $this
Parameters
$name : string|null
Return values
$this —

setSubmittedDateTime()

Sets submitted_date_time

public setSubmittedDateTime(string|null $submitted_date_time) : $this
Parameters
$submitted_date_time : 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> —

setTransactionId()

Sets transaction_id

public setTransactionId(string|null $transaction_id) : $this
Parameters
$transaction_id : string|null

Used to identify an envelope. The id is a sender-generated value and is valid in the DocuSign system for 7 days. It is recommended that a transaction ID is used for offline signing to ensure that an envelope is not sent multiple times. The transactionId property can be used determine an envelope's status (i.e. was it created or not) in cases where the internet connection was lost before the envelope status was returned.

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