Documentation

RecipientTokenClientURLs
in package
implements ModelInterface, ArrayAccess

RecipientTokenClientURLs 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
getModelName()  : string
The original name of the model.
getOnAccessCodeFailed()  : string|null
Gets on_access_code_failed
getOnCancel()  : string|null
Gets on_cancel
getOnDecline()  : string|null
Gets on_decline
getOnException()  : string|null
Gets on_exception
getOnFaxPending()  : string|null
Gets on_fax_pending
getOnIdCheckFailed()  : string|null
Gets on_id_check_failed
getOnSessionTimeout()  : string|null
Gets on_session_timeout
getOnSigningComplete()  : string|null
Gets on_signing_complete
getOnTtlExpired()  : string|null
Gets on_ttl_expired
getOnViewingComplete()  : string|null
Gets on_viewing_complete
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.
setOnAccessCodeFailed()  : $this
Sets on_access_code_failed
setOnCancel()  : $this
Sets on_cancel
setOnDecline()  : $this
Sets on_decline
setOnException()  : $this
Sets on_exception
setOnFaxPending()  : $this
Sets on_fax_pending
setOnIdCheckFailed()  : $this
Sets on_id_check_failed
setOnSessionTimeout()  : $this
Sets on_session_timeout
setOnSigningComplete()  : $this
Sets on_signing_complete
setOnTtlExpired()  : $this
Sets on_ttl_expired
setOnViewingComplete()  : $this
Sets on_viewing_complete
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 = ['on_access_code_failed' => 'onAccessCodeFailed', 'on_cancel' => 'onCancel', 'on_decline' => 'onDecline', 'on_exception' => 'onException', 'on_fax_pending' => 'onFaxPending', 'on_id_check_failed' => 'onIdCheckFailed', 'on_session_timeout' => 'onSessionTimeout', 'on_signing_complete' => 'onSigningComplete', 'on_ttl_expired' => 'onTTLExpired', 'on_viewing_complete' => 'onViewingComplete']

$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 = ['on_access_code_failed' => 'getOnAccessCodeFailed', 'on_cancel' => 'getOnCancel', 'on_decline' => 'getOnDecline', 'on_exception' => 'getOnException', 'on_fax_pending' => 'getOnFaxPending', 'on_id_check_failed' => 'getOnIdCheckFailed', 'on_session_timeout' => 'getOnSessionTimeout', 'on_signing_complete' => 'getOnSigningComplete', 'on_ttl_expired' => 'getOnTtlExpired', 'on_viewing_complete' => 'getOnViewingComplete']

$setters

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

protected static array<string|int, string> $setters = ['on_access_code_failed' => 'setOnAccessCodeFailed', 'on_cancel' => 'setOnCancel', 'on_decline' => 'setOnDecline', 'on_exception' => 'setOnException', 'on_fax_pending' => 'setOnFaxPending', 'on_id_check_failed' => 'setOnIdCheckFailed', 'on_session_timeout' => 'setOnSessionTimeout', 'on_signing_complete' => 'setOnSigningComplete', 'on_ttl_expired' => 'setOnTtlExpired', 'on_viewing_complete' => 'setOnViewingComplete']

$swaggerFormats

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

protected static array<string|int, string> $swaggerFormats = ['on_access_code_failed' => null, 'on_cancel' => null, 'on_decline' => null, 'on_exception' => null, 'on_fax_pending' => null, 'on_id_check_failed' => null, 'on_session_timeout' => null, 'on_signing_complete' => null, 'on_ttl_expired' => null, 'on_viewing_complete' => null]

$swaggerModelName

The original name of the model.

protected static string $swaggerModelName = 'recipientTokenClientURLs'

$swaggerTypes

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

protected static array<string|int, string> $swaggerTypes = ['on_access_code_failed' => '?string', 'on_cancel' => '?string', 'on_decline' => '?string', 'on_exception' => '?string', 'on_fax_pending' => '?string', 'on_id_check_failed' => '?string', 'on_session_timeout' => '?string', 'on_signing_complete' => '?string', 'on_ttl_expired' => '?string', 'on_viewing_complete' => '?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>

getOnAccessCodeFailed()

Gets on_access_code_failed

public getOnAccessCodeFailed() : string|null
Return values
string|null

getOnFaxPending()

Gets on_fax_pending

public getOnFaxPending() : string|null
Return values
string|null

getOnIdCheckFailed()

Gets on_id_check_failed

public getOnIdCheckFailed() : string|null
Return values
string|null

getOnSessionTimeout()

Gets on_session_timeout

public getOnSessionTimeout() : string|null
Return values
string|null

getOnSigningComplete()

Gets on_signing_complete

public getOnSigningComplete() : string|null
Return values
string|null

getOnTtlExpired()

Gets on_ttl_expired

public getOnTtlExpired() : string|null
Return values
string|null

getOnViewingComplete()

Gets on_viewing_complete

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

setOnAccessCodeFailed()

Sets on_access_code_failed

public setOnAccessCodeFailed(string|null $on_access_code_failed) : $this
Parameters
$on_access_code_failed : string|null
Return values
$this

setOnCancel()

Sets on_cancel

public setOnCancel(string|null $on_cancel) : $this
Parameters
$on_cancel : string|null
Return values
$this

setOnDecline()

Sets on_decline

public setOnDecline(string|null $on_decline) : $this
Parameters
$on_decline : string|null
Return values
$this

setOnException()

Sets on_exception

public setOnException(string|null $on_exception) : $this
Parameters
$on_exception : string|null
Return values
$this

setOnFaxPending()

Sets on_fax_pending

public setOnFaxPending(string|null $on_fax_pending) : $this
Parameters
$on_fax_pending : string|null
Return values
$this

setOnIdCheckFailed()

Sets on_id_check_failed

public setOnIdCheckFailed(string|null $on_id_check_failed) : $this
Parameters
$on_id_check_failed : string|null
Return values
$this

setOnSessionTimeout()

Sets on_session_timeout

public setOnSessionTimeout(string|null $on_session_timeout) : $this
Parameters
$on_session_timeout : string|null
Return values
$this

setOnSigningComplete()

Sets on_signing_complete

public setOnSigningComplete(string|null $on_signing_complete) : $this
Parameters
$on_signing_complete : string|null
Return values
$this

setOnTtlExpired()

Sets on_ttl_expired

public setOnTtlExpired(string|null $on_ttl_expired) : $this
Parameters
$on_ttl_expired : string|null
Return values
$this

setOnViewingComplete()

Sets on_viewing_complete

public setOnViewingComplete(string|null $on_viewing_complete) : $this
Parameters
$on_viewing_complete : 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