Documentation

RecipientUpdateResponse
in package
implements ModelInterface, ArrayAccess

RecipientUpdateResponse Class Doc Comment

Tags
category

Class

description

The recipient details that are returned after you update the recipient.

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
getCombined()  : string|null
Gets combined
getErrorDetails()  : ErrorDetails
Gets error_details
getModelName()  : string
The original name of the model.
getRecipientId()  : string|null
Gets recipient_id
getRecipientIdGuid()  : string|null
Gets recipient_id_guid
getTabs()  : Tabs
Gets tabs
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.
setCombined()  : $this
Sets combined
setErrorDetails()  : $this
Sets error_details
setRecipientId()  : $this
Sets recipient_id
setRecipientIdGuid()  : $this
Sets recipient_id_guid
setTabs()  : $this
Sets tabs
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 = ['combined' => 'combined', 'error_details' => 'errorDetails', 'recipient_id' => 'recipientId', 'recipient_id_guid' => 'recipientIdGuid', 'tabs' => 'tabs']

$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 = ['combined' => 'getCombined', 'error_details' => 'getErrorDetails', 'recipient_id' => 'getRecipientId', 'recipient_id_guid' => 'getRecipientIdGuid', 'tabs' => 'getTabs']

$setters

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

protected static array<string|int, string> $setters = ['combined' => 'setCombined', 'error_details' => 'setErrorDetails', 'recipient_id' => 'setRecipientId', 'recipient_id_guid' => 'setRecipientIdGuid', 'tabs' => 'setTabs']

$swaggerFormats

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

protected static array<string|int, string> $swaggerFormats = ['combined' => null, 'error_details' => null, 'recipient_id' => null, 'recipient_id_guid' => null, 'tabs' => null]

$swaggerModelName

The original name of the model.

protected static string $swaggerModelName = 'recipientUpdateResponse'

$swaggerTypes

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

protected static array<string|int, string> $swaggerTypes = ['combined' => '?string', 'error_details' => '\\DocuSign\\eSign\\Model\\ErrorDetails', 'recipient_id' => '?string', 'recipient_id_guid' => '?string', 'tabs' => '\\DocuSign\\eSign\\Model\\Tabs']

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>

getModelName()

The original name of the model.

public getModelName() : string
Return values
string

getRecipientId()

Gets recipient_id

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

getRecipientIdGuid()

Gets recipient_id_guid

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

setCombined()

Sets combined

public setCombined(string|null $combined) : $this
Parameters
$combined : string|null
Return values
$this

setRecipientId()

Sets recipient_id

public setRecipientId(string|null $recipient_id) : $this
Parameters
$recipient_id : string|null

Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.

Return values
$this

setRecipientIdGuid()

Sets recipient_id_guid

public setRecipientIdGuid(string|null $recipient_id_guid) : $this
Parameters
$recipient_id_guid : string|null
Return values
$this

setTabs()

Sets tabs

public setTabs(Tabs $tabs) : $this
Parameters
$tabs : Tabs

All of the tabs associated with the recipient.

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