RecipientOption
in package
implements
ModelInterface, ArrayAccess
RecipientOption 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
- getEmail() : string|null
- Gets email
- getModelName() : string
- The original name of the model.
- getName() : string|null
- Gets name
- getRecipientLabel() : string|null
- Gets recipient_label
- getRoleName() : string|null
- Gets role_name
- getSigningGroupId() : string|null
- Gets signing_group_id
- 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.
- setEmail() : $this
- Sets email
- setName() : $this
- Sets name
- setRecipientLabel() : $this
- Sets recipient_label
- setRoleName() : $this
- Sets role_name
- setSigningGroupId() : $this
- Sets signing_group_id
- 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
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
= ['email' => 'email', 'name' => 'name', 'recipient_label' => 'recipientLabel', 'role_name' => 'roleName', 'signing_group_id' => 'signingGroupId']
$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
= ['email' => 'getEmail', 'name' => 'getName', 'recipient_label' => 'getRecipientLabel', 'role_name' => 'getRoleName', 'signing_group_id' => 'getSigningGroupId']
$setters
Array of attributes to setter functions (for deserialization of responses)
protected
static array<string|int, string>
$setters
= ['email' => 'setEmail', 'name' => 'setName', 'recipient_label' => 'setRecipientLabel', 'role_name' => 'setRoleName', 'signing_group_id' => 'setSigningGroupId']
$swaggerFormats
Array of property to format mappings. Used for (de)serialization
protected
static array<string|int, string>
$swaggerFormats
= ['email' => null, 'name' => null, 'recipient_label' => null, 'role_name' => null, 'signing_group_id' => null]
$swaggerModelName
The original name of the model.
protected
static string
$swaggerModelName
= 'recipientOption'
$swaggerTypes
Array of property to type mappings. Used for (de)serialization
protected
static array<string|int, string>
$swaggerTypes
= ['email' => '?string', 'name' => '?string', 'recipient_label' => '?string', 'role_name' => '?string', 'signing_group_id' => '?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> —getEmail()
Gets email
public
getEmail() : string|null
Return values
string|null —getModelName()
The original name of the model.
public
getModelName() : string
Return values
string —getName()
Gets name
public
getName() : string|null
Return values
string|null —getRecipientLabel()
Gets recipient_label
public
getRecipientLabel() : string|null
Return values
string|null —getRoleName()
Gets role_name
public
getRoleName() : string|null
Return values
string|null —getSigningGroupId()
Gets signing_group_id
public
getSigningGroupId() : 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 —setEmail()
Sets email
public
setEmail(string|null $email) : $this
Parameters
- $email : string|null
Return values
$this —setName()
Sets name
public
setName(string|null $name) : $this
Parameters
- $name : string|null
Return values
$this —setRecipientLabel()
Sets recipient_label
public
setRecipientLabel(string|null $recipient_label) : $this
Parameters
- $recipient_label : string|null
Return values
$this —setRoleName()
Sets role_name
public
setRoleName(string|null $role_name) : $this
Parameters
- $role_name : string|null
-
Optional element. Specifies the role name associated with the recipient.
This is required when working with template recipients.
Return values
$this —setSigningGroupId()
Sets signing_group_id
public
setSigningGroupId(string|null $signing_group_id) : $this
Parameters
- $signing_group_id : string|null
-
When set to true and the feature is enabled in the sender's account, the signing recipient is required to draw signatures and initials at each signature/initial tab ( instead of adopting a signature/initial style or only drawing a signature/initial once).
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