CaptiveRecipient
in package
implements
ModelInterface, ArrayAccess
CaptiveRecipient Class Doc Comment
Tags
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
- getClientUserId() : string|null
- Gets client_user_id
- getEmail() : string|null
- Gets email
- getErrorDetails() : ErrorDetails
- Gets error_details
- getModelName() : string
- The original name of the model.
- getters() : array<string|int, mixed>
- Array of attributes to getter functions (for serialization of requests)
- getUserName() : string|null
- Gets user_name
- 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.
- setClientUserId() : $this
- Sets client_user_id
- setEmail() : $this
- Sets email
- setErrorDetails() : $this
- Sets error_details
- setters() : array<string|int, mixed>
- Array of attributes to setter functions (for deserialization of responses)
- setUserName() : $this
- Sets user_name
- 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
DISCRIMINATOR
public
mixed
DISCRIMINATOR
= null
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
= ['client_user_id' => 'clientUserId', 'email' => 'email', 'error_details' => 'errorDetails', 'user_name' => 'userName']
$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
= ['client_user_id' => 'getClientUserId', 'email' => 'getEmail', 'error_details' => 'getErrorDetails', 'user_name' => 'getUserName']
$setters
Array of attributes to setter functions (for deserialization of responses)
protected
static array<string|int, string>
$setters
= ['client_user_id' => 'setClientUserId', 'email' => 'setEmail', 'error_details' => 'setErrorDetails', 'user_name' => 'setUserName']
$swaggerFormats
Array of property to format mappings. Used for (de)serialization
protected
static array<string|int, string>
$swaggerFormats
= ['client_user_id' => null, 'email' => null, 'error_details' => null, 'user_name' => null]
$swaggerModelName
The original name of the model.
protected
static string
$swaggerModelName
= 'captiveRecipient'
$swaggerTypes
Array of property to type mappings. Used for (de)serialization
protected
static array<string|int, string>
$swaggerTypes
= ['client_user_id' => '?string', 'email' => '?string', 'error_details' => '\\DocuSign\\eSign\\Model\\ErrorDetails', 'user_name' => '?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> —getClientUserId()
Gets client_user_id
public
getClientUserId() : string|null
Return values
string|null —getEmail()
Gets email
public
getEmail() : string|null
Return values
string|null —getErrorDetails()
Gets error_details
public
getErrorDetails() : ErrorDetails
Return values
ErrorDetails —getModelName()
The original name of the model.
public
getModelName() : string
Return values
string —getters()
Array of attributes to getter functions (for serialization of requests)
public
static getters() : array<string|int, mixed>
Return values
array<string|int, mixed> —getUserName()
Gets user_name
public
getUserName() : string|null
Return values
string|null —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 —setClientUserId()
Sets client_user_id
public
setClientUserId(string|null $client_user_id) : $this
Parameters
- $client_user_id : string|null
-
Specifies whether the recipient is embedded or remote. If the
clientUserIdproperty is not null then the recipient is embedded. Note that if theClientUserIdproperty is set and eitherSignerMustHaveAccountorSignerMustLoginToSignproperty of the account settings is set to true, an error is generated on sending.ng. Maximum length: 100 characters.
Return values
$this —setEmail()
Sets email
public
setEmail(string|null $email) : $this
Parameters
- $email : string|null
-
Specifies the email address associated with the captive recipient.
Return values
$this —setErrorDetails()
Sets error_details
public
setErrorDetails(ErrorDetails $error_details) : $this
Parameters
- $error_details : ErrorDetails
-
Array or errors.
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> —setUserName()
Sets user_name
public
setUserName(string|null $user_name) : $this
Parameters
- $user_name : string|null
-
Specifies the user name associated with the captive recipient.
Return values
$this —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