Documentation

BulkSendingCopy
in package
implements ModelInterface, ArrayAccess

BulkSendingCopy Class Doc Comment

Tags
category

Class

description

This object contains the details to use for a specific copy, or instance, of the envelope. When you send an envelope by using a bulk send list, you can customize these properties for each instance.

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
getCustomFields()  : array<string|int, BulkSendingCopyCustomField>
Gets custom_fields
getDocGenFormFields()  : array<string|int, BulksendingCopyDocGenFormField>
Gets doc_gen_form_fields
getEmailBlurb()  : string|null
Gets email_blurb
getEmailSubject()  : string|null
Gets email_subject
getModelName()  : string
The original name of the model.
getRecipients()  : array<string|int, BulkSendingCopyRecipient>
Gets recipients
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.
setCustomFields()  : $this
Sets custom_fields
setDocGenFormFields()  : $this
Sets doc_gen_form_fields
setEmailBlurb()  : $this
Sets email_blurb
setEmailSubject()  : $this
Sets email_subject
setRecipients()  : $this
Sets recipients
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 = ['custom_fields' => 'customFields', 'doc_gen_form_fields' => 'docGenFormFields', 'email_blurb' => 'emailBlurb', 'email_subject' => 'emailSubject', 'recipients' => 'recipients']

$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 = ['custom_fields' => 'getCustomFields', 'doc_gen_form_fields' => 'getDocGenFormFields', 'email_blurb' => 'getEmailBlurb', 'email_subject' => 'getEmailSubject', 'recipients' => 'getRecipients']

$setters

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

protected static array<string|int, string> $setters = ['custom_fields' => 'setCustomFields', 'doc_gen_form_fields' => 'setDocGenFormFields', 'email_blurb' => 'setEmailBlurb', 'email_subject' => 'setEmailSubject', 'recipients' => 'setRecipients']

$swaggerFormats

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

protected static array<string|int, string> $swaggerFormats = ['custom_fields' => null, 'doc_gen_form_fields' => null, 'email_blurb' => null, 'email_subject' => null, 'recipients' => null]

$swaggerModelName

The original name of the model.

protected static string $swaggerModelName = 'bulkSendingCopy'

$swaggerTypes

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

protected static array<string|int, string> $swaggerTypes = ['custom_fields' => '\\DocuSign\\eSign\\Model\\BulkSendingCopyCustomField[]', 'doc_gen_form_fields' => '\\DocuSign\\eSign\\Model\\BulksendingCopyDocGenFormField[]', 'email_blurb' => '?string', 'email_subject' => '?string', 'recipients' => '\\DocuSign\\eSign\\Model\\BulkSendingCopyRecipient[]']

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> —

getEmailBlurb()

Gets email_blurb

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

getEmailSubject()

Gets email_subject

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

getModelName()

The original name of the model.

public getModelName() : string
Return values
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 —

setCustomFields()

Sets custom_fields

public setCustomFields(array<string|int, BulkSendingCopyCustomField> $custom_fields) : $this
Parameters
$custom_fields : array<string|int, BulkSendingCopyCustomField>

An optional array of strings that allows the sender to provide custom data about the recipient. This information is returned in the envelope status but otherwise not used by DocuSign. Each customField string can be a maximum of 100 characters.

Return values
$this —

setEmailBlurb()

Sets email_blurb

public setEmailBlurb(string|null $email_blurb) : $this
Parameters
$email_blurb : string|null
Return values
$this —

setEmailSubject()

Sets email_subject

public setEmailSubject(string|null $email_subject) : $this
Parameters
$email_subject : string|null

Specifies the subject of the email that is sent to all recipients. See [ML:Template Email Subject Merge Fields] for information about adding merge field information to the email subject.

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