Documentation

BulkRecipient
in package
implements ModelInterface, ArrayAccess

BulkRecipient 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
getAccessCode()  : string|null
Gets access_code
getEmail()  : string|null
Gets email
getErrorDetails()  : array<string|int, ErrorDetails>
Gets error_details
getIdentification()  : string|null
Gets identification
getModelName()  : string
The original name of the model.
getName()  : string|null
Gets name
getNote()  : string|null
Gets note
getPhoneNumber()  : string|null
Gets phone_number
getRecipientSignatureProviderInfo()  : array<string|int, BulkRecipientSignatureProvider>
Gets recipient_signature_provider_info
getRowNumber()  : string|null
Gets row_number
getTabLabels()  : array<string|int, BulkRecipientTabLabel>
Gets tab_labels
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.
setAccessCode()  : $this
Sets access_code
setEmail()  : $this
Sets email
setErrorDetails()  : $this
Sets error_details
setIdentification()  : $this
Sets identification
setName()  : $this
Sets name
setNote()  : $this
Sets note
setPhoneNumber()  : $this
Sets phone_number
setRecipientSignatureProviderInfo()  : $this
Sets recipient_signature_provider_info
setRowNumber()  : $this
Sets row_number
setTabLabels()  : $this
Sets tab_labels
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 = ['access_code' => 'accessCode', 'email' => 'email', 'error_details' => 'errorDetails', 'identification' => 'identification', 'name' => 'name', 'note' => 'note', 'phone_number' => 'phoneNumber', 'recipient_signature_provider_info' => 'recipientSignatureProviderInfo', 'row_number' => 'rowNumber', 'tab_labels' => 'tabLabels']

$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 = ['access_code' => 'getAccessCode', 'email' => 'getEmail', 'error_details' => 'getErrorDetails', 'identification' => 'getIdentification', 'name' => 'getName', 'note' => 'getNote', 'phone_number' => 'getPhoneNumber', 'recipient_signature_provider_info' => 'getRecipientSignatureProviderInfo', 'row_number' => 'getRowNumber', 'tab_labels' => 'getTabLabels']

$setters

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

protected static array<string|int, string> $setters = ['access_code' => 'setAccessCode', 'email' => 'setEmail', 'error_details' => 'setErrorDetails', 'identification' => 'setIdentification', 'name' => 'setName', 'note' => 'setNote', 'phone_number' => 'setPhoneNumber', 'recipient_signature_provider_info' => 'setRecipientSignatureProviderInfo', 'row_number' => 'setRowNumber', 'tab_labels' => 'setTabLabels']

$swaggerFormats

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

protected static array<string|int, string> $swaggerFormats = ['access_code' => null, 'email' => null, 'error_details' => null, 'identification' => null, 'name' => null, 'note' => null, 'phone_number' => null, 'recipient_signature_provider_info' => null, 'row_number' => null, 'tab_labels' => null]

$swaggerModelName

The original name of the model.

protected static string $swaggerModelName = 'bulkRecipient'

$swaggerTypes

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

protected static array<string|int, string> $swaggerTypes = ['access_code' => '?string', 'email' => '?string', 'error_details' => '\\DocuSign\\eSign\\Model\\ErrorDetails[]', 'identification' => '?string', 'name' => '?string', 'note' => '?string', 'phone_number' => '?string', 'recipient_signature_provider_info' => '\\DocuSign\\eSign\\Model\\BulkRecipientSignatureProvider[]', 'row_number' => '?string', 'tab_labels' => '\\DocuSign\\eSign\\Model\\BulkRecipientTabLabel[]']

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

getAccessCode()

Gets access_code

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

getEmail()

Gets email

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

getIdentification()

Gets identification

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

getNote()

Gets note

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

getPhoneNumber()

Gets phone_number

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

getRowNumber()

Gets row_number

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

setAccessCode()

Sets access_code

public setAccessCode(string|null $access_code) : $this
Parameters
$access_code : string|null

If a value is provided, the recipient must enter the value as the access code to view and sign the envelope. Maximum Length: 50 characters and it must conform to the account's access code format setting. If blank, but the signer accessCode property is set in the envelope, then that value is used. If blank and the signer accessCode property is not set, then the access code is not required.

Return values
$this —

setEmail()

Sets email

public setEmail(string|null $email) : $this
Parameters
$email : string|null

Specifies the recipient's email address. Maximum length: 100 characters.

Return values
$this —

setErrorDetails()

Sets error_details

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

Array or errors.

Return values
$this —

setIdentification()

Sets identification

public setIdentification(string|null $identification) : $this
Parameters
$identification : string|null

Specifies the authentication check used for the signer. If blank then no authentication check is required for the signer. Only one value can be used in this field. The acceptable values are: * KBA: Enables the normal ID check authentication set up for your account. * Phone: Enables phone authentication. * SMS: Enables SMS authentication.

Return values
$this —

setName()

Sets name

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

Specifies the recipient's name. Maximum length: 50 characters.

Return values
$this —

setNote()

Sets note

public setNote(string|null $note) : $this
Parameters
$note : string|null

Specifies a note that is unique to this recipient. This note is sent to the recipient via the signing email. The note displays in the signing UI near the upper left corner of the document on the signing screen. Maximum Length: 1000 characters.

Return values
$this —

setPhoneNumber()

Sets phone_number

public setPhoneNumber(string|null $phone_number) : $this
Parameters
$phone_number : string|null

This is only used if the Identification field value is Phone or SMS. The value for this field can be a valid telephone number or, if Phone, usersupplied (SMS authentication cannot use a user supplied number). Parenthesis and dashes can be used in the telephone number. If usersupplied is used, the signer supplies his or her own telephone number.

Return values
$this —

setRowNumber()

Sets row_number

public setRowNumber(string|null $row_number) : $this
Parameters
$row_number : string|null
Return values
$this —

setTabLabels()

Sets tab_labels

public setTabLabels(array<string|int, BulkRecipientTabLabel> $tab_labels) : $this
Parameters
$tab_labels : array<string|int, BulkRecipientTabLabel>

Specifies values used to populate recipient tabs with information. This allows each bulk recipient signer to have different values for their associated tabs. Any number of tabLabel columns can be added to the bulk recipient file. The information used in the bulk recipient file header must be the same as the tabLabel for the tab. The values entered in this column are automatically inserted into the corresponding tab for the recipient in the same row. Note that this option cannot be used for tabs that do not have data or that are automatically populated data such as Signature, Full Name, Email Address, Company, Title, and Date Signed tabs.

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