PowerFormRecipient
in package
implements
ModelInterface, ArrayAccess
PowerFormRecipient 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
- getAccessCode() : string|null
- Gets access_code
- getAccessCodeLocked() : string|null
- Gets access_code_locked
- getAccessCodeRequired() : string|null
- Gets access_code_required
- getEmail() : string|null
- Gets email
- getEmailLocked() : string|null
- Gets email_locked
- getIdCheckConfigurationName() : string|null
- Gets id_check_configuration_name
- getIdCheckRequired() : string|null
- Gets id_check_required
- getModelName() : string
- The original name of the model.
- getName() : string|null
- Gets name
- getRecipientType() : string|null
- Gets recipient_type
- getRoleName() : string|null
- Gets role_name
- getRoutingOrder() : string|null
- Gets routing_order
- getTemplateRequiresIdLookup() : string|null
- Gets template_requires_id_lookup
- getters() : array<string|int, mixed>
- Array of attributes to getter functions (for serialization of requests)
- getUserNameLocked() : string|null
- Gets user_name_locked
- 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.
- setAccessCode() : $this
- Sets access_code
- setAccessCodeLocked() : $this
- Sets access_code_locked
- setAccessCodeRequired() : $this
- Sets access_code_required
- setEmail() : $this
- Sets email
- setEmailLocked() : $this
- Sets email_locked
- setIdCheckConfigurationName() : $this
- Sets id_check_configuration_name
- setIdCheckRequired() : $this
- Sets id_check_required
- setName() : $this
- Sets name
- setRecipientType() : $this
- Sets recipient_type
- setRoleName() : $this
- Sets role_name
- setRoutingOrder() : $this
- Sets routing_order
- setTemplateRequiresIdLookup() : $this
- Sets template_requires_id_lookup
- setters() : array<string|int, mixed>
- Array of attributes to setter functions (for deserialization of responses)
- setUserNameLocked() : $this
- Sets user_name_locked
- 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
= ['access_code' => 'accessCode', 'access_code_locked' => 'accessCodeLocked', 'access_code_required' => 'accessCodeRequired', 'email' => 'email', 'email_locked' => 'emailLocked', 'id_check_configuration_name' => 'idCheckConfigurationName', 'id_check_required' => 'idCheckRequired', 'name' => 'name', 'recipient_type' => 'recipientType', 'role_name' => 'roleName', 'routing_order' => 'routingOrder', 'template_requires_id_lookup' => 'templateRequiresIdLookup', 'user_name_locked' => 'userNameLocked']
$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
= ['access_code' => 'getAccessCode', 'access_code_locked' => 'getAccessCodeLocked', 'access_code_required' => 'getAccessCodeRequired', 'email' => 'getEmail', 'email_locked' => 'getEmailLocked', 'id_check_configuration_name' => 'getIdCheckConfigurationName', 'id_check_required' => 'getIdCheckRequired', 'name' => 'getName', 'recipient_type' => 'getRecipientType', 'role_name' => 'getRoleName', 'routing_order' => 'getRoutingOrder', 'template_requires_id_lookup' => 'getTemplateRequiresIdLookup', 'user_name_locked' => 'getUserNameLocked']
$setters
Array of attributes to setter functions (for deserialization of responses)
protected
static array<string|int, string>
$setters
= ['access_code' => 'setAccessCode', 'access_code_locked' => 'setAccessCodeLocked', 'access_code_required' => 'setAccessCodeRequired', 'email' => 'setEmail', 'email_locked' => 'setEmailLocked', 'id_check_configuration_name' => 'setIdCheckConfigurationName', 'id_check_required' => 'setIdCheckRequired', 'name' => 'setName', 'recipient_type' => 'setRecipientType', 'role_name' => 'setRoleName', 'routing_order' => 'setRoutingOrder', 'template_requires_id_lookup' => 'setTemplateRequiresIdLookup', 'user_name_locked' => 'setUserNameLocked']
$swaggerFormats
Array of property to format mappings. Used for (de)serialization
protected
static array<string|int, string>
$swaggerFormats
= ['access_code' => null, 'access_code_locked' => null, 'access_code_required' => null, 'email' => null, 'email_locked' => null, 'id_check_configuration_name' => null, 'id_check_required' => null, 'name' => null, 'recipient_type' => null, 'role_name' => null, 'routing_order' => null, 'template_requires_id_lookup' => null, 'user_name_locked' => null]
$swaggerModelName
The original name of the model.
protected
static string
$swaggerModelName
= 'powerFormRecipient'
$swaggerTypes
Array of property to type mappings. Used for (de)serialization
protected
static array<string|int, string>
$swaggerTypes
= ['access_code' => '?string', 'access_code_locked' => '?string', 'access_code_required' => '?string', 'email' => '?string', 'email_locked' => '?string', 'id_check_configuration_name' => '?string', 'id_check_required' => '?string', 'name' => '?string', 'recipient_type' => '?string', 'role_name' => '?string', 'routing_order' => '?string', 'template_requires_id_lookup' => '?string', 'user_name_locked' => '?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> —getAccessCode()
Gets access_code
public
getAccessCode() : string|null
Return values
string|null —getAccessCodeLocked()
Gets access_code_locked
public
getAccessCodeLocked() : string|null
Return values
string|null —getAccessCodeRequired()
Gets access_code_required
public
getAccessCodeRequired() : string|null
Return values
string|null —getEmail()
Gets email
public
getEmail() : string|null
Return values
string|null —getEmailLocked()
Gets email_locked
public
getEmailLocked() : string|null
Return values
string|null —getIdCheckConfigurationName()
Gets id_check_configuration_name
public
getIdCheckConfigurationName() : string|null
Return values
string|null —getIdCheckRequired()
Gets id_check_required
public
getIdCheckRequired() : 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 —getRecipientType()
Gets recipient_type
public
getRecipientType() : string|null
Return values
string|null —getRoleName()
Gets role_name
public
getRoleName() : string|null
Return values
string|null —getRoutingOrder()
Gets routing_order
public
getRoutingOrder() : string|null
Return values
string|null —getTemplateRequiresIdLookup()
Gets template_requires_id_lookup
public
getTemplateRequiresIdLookup() : 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> —getUserNameLocked()
Gets user_name_locked
public
getUserNameLocked() : 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 —setAccessCode()
Sets access_code
public
setAccessCode(string|null $access_code) : $this
Parameters
- $access_code : string|null
-
If a value is provided, the recipient must enter the value as the access code to view and sign the envelope. Maximum Length: 50 characters and it must conform to the account's access code format setting. If blank, but the signer
accessCodeproperty is set in the envelope, then that value is used. If blank and the signeraccessCodeproperty is not set, then the access code is not required.
Return values
$this —setAccessCodeLocked()
Sets access_code_locked
public
setAccessCodeLocked(string|null $access_code_locked) : $this
Parameters
- $access_code_locked : string|null
Return values
$this —setAccessCodeRequired()
Sets access_code_required
public
setAccessCodeRequired(string|null $access_code_required) : $this
Parameters
- $access_code_required : string|null
Return values
$this —setEmail()
Sets email
public
setEmail(string|null $email) : $this
Parameters
- $email : string|null
Return values
$this —setEmailLocked()
Sets email_locked
public
setEmailLocked(string|null $email_locked) : $this
Parameters
- $email_locked : string|null
Return values
$this —setIdCheckConfigurationName()
Sets id_check_configuration_name
public
setIdCheckConfigurationName(string|null $id_check_configuration_name) : $this
Parameters
- $id_check_configuration_name : string|null
-
Specifies authentication check by name. The names used here must be the same as the authentication type names used by the account (these name can also be found in the web console sending interface in the Identify list for a recipient,) This overrides any default authentication setting. Example: Your account has ID Check and SMS Authentication available and in the web console Identify list these appear as 'ID Check $' and 'SMS Auth $'. To use ID check in an envelope, the idCheckConfigurationName should be 'ID Check '. If you wanted to use SMS, it would be 'SMS Auth $' and you would need to add you would need to add phone number information to the
smsAuthenticationnode.
Return values
$this —setIdCheckRequired()
Sets id_check_required
public
setIdCheckRequired(string|null $id_check_required) : $this
Parameters
- $id_check_required : string|null
Return values
$this —setName()
Sets name
public
setName(string|null $name) : $this
Parameters
- $name : string|null
Return values
$this —setRecipientType()
Sets recipient_type
public
setRecipientType(string|null $recipient_type) : $this
Parameters
- $recipient_type : 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 —setRoutingOrder()
Sets routing_order
public
setRoutingOrder(string|null $routing_order) : $this
Parameters
- $routing_order : string|null
-
Specifies the routing order of the recipient in the envelope.
Return values
$this —setTemplateRequiresIdLookup()
Sets template_requires_id_lookup
public
setTemplateRequiresIdLookup(string|null $template_requires_id_lookup) : $this
Parameters
- $template_requires_id_lookup : 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> —setUserNameLocked()
Sets user_name_locked
public
setUserNameLocked(string|null $user_name_locked) : $this
Parameters
- $user_name_locked : string|null
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