Documentation

RecipientSignatureProvider
in package
implements ModelInterface, ArrayAccess

RecipientSignatureProvider Class Doc Comment

Tags
category

Class

description

An Electronic or Standards Based Signature (digital signature) provider for the signer to use. More information.

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
getModelName()  : string
The original name of the model.
getSealDocumentsWithTabsOnly()  : string|null
Gets seal_documents_with_tabs_only
getSealName()  : string|null
Gets seal_name
getSignatureProviderName()  : string|null
Gets signature_provider_name
getSignatureProviderNameMetadata()  : PropertyMetadata
Gets signature_provider_name_metadata
getSignatureProviderOptions()  : RecipientSignatureProviderOptions
Gets signature_provider_options
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.
setSealDocumentsWithTabsOnly()  : $this
Sets seal_documents_with_tabs_only
setSealName()  : $this
Sets seal_name
setSignatureProviderName()  : $this
Sets signature_provider_name
setSignatureProviderNameMetadata()  : $this
Sets signature_provider_name_metadata
setSignatureProviderOptions()  : $this
Sets signature_provider_options
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 = ['seal_documents_with_tabs_only' => 'sealDocumentsWithTabsOnly', 'seal_name' => 'sealName', 'signature_provider_name' => 'signatureProviderName', 'signature_provider_name_metadata' => 'signatureProviderNameMetadata', 'signature_provider_options' => 'signatureProviderOptions']

$getters

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

protected static array<string|int, string> $getters = ['seal_documents_with_tabs_only' => 'getSealDocumentsWithTabsOnly', 'seal_name' => 'getSealName', 'signature_provider_name' => 'getSignatureProviderName', 'signature_provider_name_metadata' => 'getSignatureProviderNameMetadata', 'signature_provider_options' => 'getSignatureProviderOptions']

$setters

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

protected static array<string|int, string> $setters = ['seal_documents_with_tabs_only' => 'setSealDocumentsWithTabsOnly', 'seal_name' => 'setSealName', 'signature_provider_name' => 'setSignatureProviderName', 'signature_provider_name_metadata' => 'setSignatureProviderNameMetadata', 'signature_provider_options' => 'setSignatureProviderOptions']

$swaggerFormats

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

protected static array<string|int, string> $swaggerFormats = ['seal_documents_with_tabs_only' => null, 'seal_name' => null, 'signature_provider_name' => null, 'signature_provider_name_metadata' => null, 'signature_provider_options' => null]

$swaggerModelName

The original name of the model.

protected static string $swaggerModelName = 'recipientSignatureProvider'

$swaggerTypes

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

protected static array<string|int, string> $swaggerTypes = ['seal_documents_with_tabs_only' => '?string', 'seal_name' => '?string', 'signature_provider_name' => '?string', 'signature_provider_name_metadata' => '\\DocuSign\\eSign\\Model\\PropertyMetadata', 'signature_provider_options' => '\\DocuSign\\eSign\\Model\\RecipientSignatureProviderOptions']

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

getSealDocumentsWithTabsOnly()

Gets seal_documents_with_tabs_only

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

getSignatureProviderName()

Gets signature_provider_name

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

setSealDocumentsWithTabsOnly()

Sets seal_documents_with_tabs_only

public setSealDocumentsWithTabsOnly(string|null $seal_documents_with_tabs_only) : $this
Parameters
$seal_documents_with_tabs_only : string|null
Return values
$this —

setSealName()

Sets seal_name

public setSealName(string|null $seal_name) : $this
Parameters
$seal_name : string|null
Return values
$this —

setSignatureProviderName()

Sets signature_provider_name

public setSignatureProviderName(string|null $signature_provider_name) : $this
Parameters
$signature_provider_name : string|null
Return values
$this —

setSignatureProviderNameMetadata()

Sets signature_provider_name_metadata

public setSignatureProviderNameMetadata(PropertyMetadata $signature_provider_name_metadata) : $this
Parameters
$signature_provider_name_metadata : PropertyMetadata

Metadata that indicates whether the signatureProviderName property is editable.

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