LinkedExternalPrimaryAccount
in package
implements
ModelInterface, ArrayAccess
LinkedExternalPrimaryAccount 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
- getAccountName() : string|null
- Gets account_name
- getConfigurationId() : string|null
- Gets configuration_id
- getEmail() : string|null
- Gets email
- getExemptMembersOfSameAccountFromAuth() : string|null
- Gets exempt_members_of_same_account_from_auth
- getLinkId() : string|null
- Gets link_id
- getModelName() : string
- The original name of the model.
- getPdfFieldHandlingOption() : string|null
- Gets pdf_field_handling_option
- getPdfFieldHandlingPrefillTabPermission() : string|null
- Gets pdf_field_handling_prefill_tab_permission
- getPdfFieldHandlingStandardInputTabPermission() : string|null
- Gets pdf_field_handling_standard_input_tab_permission
- getPdfFieldHandlingStandardTabPermission() : string|null
- Gets pdf_field_handling_standard_tab_permission
- getRecipientAuthRequirements() : ExternalPrimaryAccountRecipientAuthRequirements
- Gets recipient_auth_requirements
- getStatus() : string|null
- Gets status
- getters() : array<string|int, mixed>
- Array of attributes to getter functions (for serialization of requests)
- getUserId() : string|null
- Gets user_id
- 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.
- setAccountName() : $this
- Sets account_name
- setConfigurationId() : $this
- Sets configuration_id
- setEmail() : $this
- Sets email
- setExemptMembersOfSameAccountFromAuth() : $this
- Sets exempt_members_of_same_account_from_auth
- setLinkId() : $this
- Sets link_id
- setPdfFieldHandlingOption() : $this
- Sets pdf_field_handling_option
- setPdfFieldHandlingPrefillTabPermission() : $this
- Sets pdf_field_handling_prefill_tab_permission
- setPdfFieldHandlingStandardInputTabPermission() : $this
- Sets pdf_field_handling_standard_input_tab_permission
- setPdfFieldHandlingStandardTabPermission() : $this
- Sets pdf_field_handling_standard_tab_permission
- setRecipientAuthRequirements() : $this
- Sets recipient_auth_requirements
- setStatus() : $this
- Sets status
- setters() : array<string|int, mixed>
- Array of attributes to setter functions (for deserialization of responses)
- setUserId() : $this
- Sets user_id
- 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
= ['account_name' => 'accountName', 'configuration_id' => 'configurationId', 'email' => 'email', 'exempt_members_of_same_account_from_auth' => 'exemptMembersOfSameAccountFromAuth', 'link_id' => 'linkId', 'pdf_field_handling_option' => 'pdfFieldHandlingOption', 'pdf_field_handling_prefill_tab_permission' => 'pdfFieldHandlingPrefillTabPermission', 'pdf_field_handling_standard_input_tab_permission' => 'pdfFieldHandlingStandardInputTabPermission', 'pdf_field_handling_standard_tab_permission' => 'pdfFieldHandlingStandardTabPermission', 'recipient_auth_requirements' => 'recipientAuthRequirements', 'status' => 'status', 'user_id' => 'userId']
$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
= ['account_name' => 'getAccountName', 'configuration_id' => 'getConfigurationId', 'email' => 'getEmail', 'exempt_members_of_same_account_from_auth' => 'getExemptMembersOfSameAccountFromAuth', 'link_id' => 'getLinkId', 'pdf_field_handling_option' => 'getPdfFieldHandlingOption', 'pdf_field_handling_prefill_tab_permission' => 'getPdfFieldHandlingPrefillTabPermission', 'pdf_field_handling_standard_input_tab_permission' => 'getPdfFieldHandlingStandardInputTabPermission', 'pdf_field_handling_standard_tab_permission' => 'getPdfFieldHandlingStandardTabPermission', 'recipient_auth_requirements' => 'getRecipientAuthRequirements', 'status' => 'getStatus', 'user_id' => 'getUserId']
$setters
Array of attributes to setter functions (for deserialization of responses)
protected
static array<string|int, string>
$setters
= ['account_name' => 'setAccountName', 'configuration_id' => 'setConfigurationId', 'email' => 'setEmail', 'exempt_members_of_same_account_from_auth' => 'setExemptMembersOfSameAccountFromAuth', 'link_id' => 'setLinkId', 'pdf_field_handling_option' => 'setPdfFieldHandlingOption', 'pdf_field_handling_prefill_tab_permission' => 'setPdfFieldHandlingPrefillTabPermission', 'pdf_field_handling_standard_input_tab_permission' => 'setPdfFieldHandlingStandardInputTabPermission', 'pdf_field_handling_standard_tab_permission' => 'setPdfFieldHandlingStandardTabPermission', 'recipient_auth_requirements' => 'setRecipientAuthRequirements', 'status' => 'setStatus', 'user_id' => 'setUserId']
$swaggerFormats
Array of property to format mappings. Used for (de)serialization
protected
static array<string|int, string>
$swaggerFormats
= ['account_name' => null, 'configuration_id' => null, 'email' => null, 'exempt_members_of_same_account_from_auth' => null, 'link_id' => null, 'pdf_field_handling_option' => null, 'pdf_field_handling_prefill_tab_permission' => null, 'pdf_field_handling_standard_input_tab_permission' => null, 'pdf_field_handling_standard_tab_permission' => null, 'recipient_auth_requirements' => null, 'status' => null, 'user_id' => null]
$swaggerModelName
The original name of the model.
protected
static string
$swaggerModelName
= 'linkedExternalPrimaryAccount'
$swaggerTypes
Array of property to type mappings. Used for (de)serialization
protected
static array<string|int, string>
$swaggerTypes
= ['account_name' => '?string', 'configuration_id' => '?string', 'email' => '?string', 'exempt_members_of_same_account_from_auth' => '?string', 'link_id' => '?string', 'pdf_field_handling_option' => '?string', 'pdf_field_handling_prefill_tab_permission' => '?string', 'pdf_field_handling_standard_input_tab_permission' => '?string', 'pdf_field_handling_standard_tab_permission' => '?string', 'recipient_auth_requirements' => '\\DocuSign\\eSign\\Model\\ExternalPrimaryAccountRecipientAuthRequirements', 'status' => '?string', 'user_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> —getAccountName()
Gets account_name
public
getAccountName() : string|null
Return values
string|null —getConfigurationId()
Gets configuration_id
public
getConfigurationId() : string|null
Return values
string|null —getEmail()
Gets email
public
getEmail() : string|null
Return values
string|null —getExemptMembersOfSameAccountFromAuth()
Gets exempt_members_of_same_account_from_auth
public
getExemptMembersOfSameAccountFromAuth() : string|null
Return values
string|null —getLinkId()
Gets link_id
public
getLinkId() : string|null
Return values
string|null —getModelName()
The original name of the model.
public
getModelName() : string
Return values
string —getPdfFieldHandlingOption()
Gets pdf_field_handling_option
public
getPdfFieldHandlingOption() : string|null
Return values
string|null —getPdfFieldHandlingPrefillTabPermission()
Gets pdf_field_handling_prefill_tab_permission
public
getPdfFieldHandlingPrefillTabPermission() : string|null
Return values
string|null —getPdfFieldHandlingStandardInputTabPermission()
Gets pdf_field_handling_standard_input_tab_permission
public
getPdfFieldHandlingStandardInputTabPermission() : string|null
Return values
string|null —getPdfFieldHandlingStandardTabPermission()
Gets pdf_field_handling_standard_tab_permission
public
getPdfFieldHandlingStandardTabPermission() : string|null
Return values
string|null —getRecipientAuthRequirements()
Gets recipient_auth_requirements
public
getRecipientAuthRequirements() : ExternalPrimaryAccountRecipientAuthRequirements
Return values
ExternalPrimaryAccountRecipientAuthRequirements —getStatus()
Gets status
public
getStatus() : 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> —getUserId()
Gets user_id
public
getUserId() : 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 —setAccountName()
Sets account_name
public
setAccountName(string|null $account_name) : $this
Parameters
- $account_name : string|null
Return values
$this —setConfigurationId()
Sets configuration_id
public
setConfigurationId(string|null $configuration_id) : $this
Parameters
- $configuration_id : string|null
Return values
$this —setEmail()
Sets email
public
setEmail(string|null $email) : $this
Parameters
- $email : string|null
Return values
$this —setExemptMembersOfSameAccountFromAuth()
Sets exempt_members_of_same_account_from_auth
public
setExemptMembersOfSameAccountFromAuth(string|null $exempt_members_of_same_account_from_auth) : $this
Parameters
- $exempt_members_of_same_account_from_auth : string|null
Return values
$this —setLinkId()
Sets link_id
public
setLinkId(string|null $link_id) : $this
Parameters
- $link_id : string|null
Return values
$this —setPdfFieldHandlingOption()
Sets pdf_field_handling_option
public
setPdfFieldHandlingOption(string|null $pdf_field_handling_option) : $this
Parameters
- $pdf_field_handling_option : string|null
Return values
$this —setPdfFieldHandlingPrefillTabPermission()
Sets pdf_field_handling_prefill_tab_permission
public
setPdfFieldHandlingPrefillTabPermission(string|null $pdf_field_handling_prefill_tab_permission) : $this
Parameters
- $pdf_field_handling_prefill_tab_permission : string|null
Return values
$this —setPdfFieldHandlingStandardInputTabPermission()
Sets pdf_field_handling_standard_input_tab_permission
public
setPdfFieldHandlingStandardInputTabPermission(string|null $pdf_field_handling_standard_input_tab_permission) : $this
Parameters
- $pdf_field_handling_standard_input_tab_permission : string|null
Return values
$this —setPdfFieldHandlingStandardTabPermission()
Sets pdf_field_handling_standard_tab_permission
public
setPdfFieldHandlingStandardTabPermission(string|null $pdf_field_handling_standard_tab_permission) : $this
Parameters
- $pdf_field_handling_standard_tab_permission : string|null
Return values
$this —setRecipientAuthRequirements()
Sets recipient_auth_requirements
public
setRecipientAuthRequirements(ExternalPrimaryAccountRecipientAuthRequirements $recipient_auth_requirements) : $this
Parameters
- $recipient_auth_requirements : ExternalPrimaryAccountRecipientAuthRequirements
Return values
$this —setStatus()
Sets status
public
setStatus(string|null $status) : $this
Parameters
- $status : string|null
-
Indicates the envelope status. Valid values are: * sent - The envelope is sent to the recipients. * created - The envelope is saved as a draft and can be modified and sent later.
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> —setUserId()
Sets user_id
public
setUserId(string|null $user_id) : $this
Parameters
- $user_id : 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