Documentation

RecipientSignatureProviderOptions
in package
implements ModelInterface, ArrayAccess

RecipientSignatureProviderOptions Class Doc Comment

Tags
category

Class

description

Option settings for the signature provider. Different providers require or use different options. The current provider list and the options they require.

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
getCpfNumber()  : string|null
Gets cpf_number
getCpfNumberMetadata()  : PropertyMetadata
Gets cpf_number_metadata
getModelName()  : string
The original name of the model.
getOneTimePassword()  : string|null
Gets one_time_password
getOneTimePasswordMetadata()  : PropertyMetadata
Gets one_time_password_metadata
getSignerRole()  : string|null
Gets signer_role
getSignerRoleMetadata()  : PropertyMetadata
Gets signer_role_metadata
getSms()  : string|null
Gets sms
getSmsMetadata()  : PropertyMetadata
Gets sms_metadata
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.
setCpfNumber()  : $this
Sets cpf_number
setCpfNumberMetadata()  : $this
Sets cpf_number_metadata
setOneTimePassword()  : $this
Sets one_time_password
setOneTimePasswordMetadata()  : $this
Sets one_time_password_metadata
setSignerRole()  : $this
Sets signer_role
setSignerRoleMetadata()  : $this
Sets signer_role_metadata
setSms()  : $this
Sets sms
setSmsMetadata()  : $this
Sets sms_metadata
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 = ['cpf_number' => 'cpfNumber', 'cpf_number_metadata' => 'cpfNumberMetadata', 'one_time_password' => 'oneTimePassword', 'one_time_password_metadata' => 'oneTimePasswordMetadata', 'signer_role' => 'signerRole', 'signer_role_metadata' => 'signerRoleMetadata', 'sms' => 'sms', 'sms_metadata' => 'smsMetadata']

$getters

Array of attributes to getter functions (for serialization of requests)

protected static array<string|int, string> $getters = ['cpf_number' => 'getCpfNumber', 'cpf_number_metadata' => 'getCpfNumberMetadata', 'one_time_password' => 'getOneTimePassword', 'one_time_password_metadata' => 'getOneTimePasswordMetadata', 'signer_role' => 'getSignerRole', 'signer_role_metadata' => 'getSignerRoleMetadata', 'sms' => 'getSms', 'sms_metadata' => 'getSmsMetadata']

$setters

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

protected static array<string|int, string> $setters = ['cpf_number' => 'setCpfNumber', 'cpf_number_metadata' => 'setCpfNumberMetadata', 'one_time_password' => 'setOneTimePassword', 'one_time_password_metadata' => 'setOneTimePasswordMetadata', 'signer_role' => 'setSignerRole', 'signer_role_metadata' => 'setSignerRoleMetadata', 'sms' => 'setSms', 'sms_metadata' => 'setSmsMetadata']

$swaggerFormats

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

protected static array<string|int, string> $swaggerFormats = ['cpf_number' => null, 'cpf_number_metadata' => null, 'one_time_password' => null, 'one_time_password_metadata' => null, 'signer_role' => null, 'signer_role_metadata' => null, 'sms' => null, 'sms_metadata' => null]

$swaggerTypes

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

protected static array<string|int, string> $swaggerTypes = ['cpf_number' => '?string', 'cpf_number_metadata' => '\\DocuSign\\eSign\\Model\\PropertyMetadata', 'one_time_password' => '?string', 'one_time_password_metadata' => '\\DocuSign\\eSign\\Model\\PropertyMetadata', 'signer_role' => '?string', 'signer_role_metadata' => '\\DocuSign\\eSign\\Model\\PropertyMetadata', 'sms' => '?string', 'sms_metadata' => '\\DocuSign\\eSign\\Model\\PropertyMetadata']

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 —

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

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 —

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 —

setCpfNumber()

Sets cpf_number

public setCpfNumber(string|null $cpf_number) : $this
Parameters
$cpf_number : string|null
Return values
$this —

setOneTimePassword()

Sets one_time_password

public setOneTimePassword(string|null $one_time_password) : $this
Parameters
$one_time_password : string|null
Return values
$this —

setOneTimePasswordMetadata()

Sets one_time_password_metadata

public setOneTimePasswordMetadata(PropertyMetadata $one_time_password_metadata) : $this
Parameters
$one_time_password_metadata : PropertyMetadata

Metadata that indicates whether the oneTimePassword property is editable.

Return values
$this —

setSignerRole()

Sets signer_role

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

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