AccountIdentityVerificationWorkflow
in package
implements
ModelInterface, ArrayAccess
AccountIdentityVerificationWorkflow 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
- getDefaultDescription() : string|null
- Gets default_description
- getDefaultName() : string|null
- Gets default_name
- getDisplayOrder() : string|null
- Gets display_order
- getInputOptions() : array<string|int, AccountIdentityInputOption>
- Gets input_options
- getIsDisabled() : string|null
- Gets is_disabled
- getModelName() : string
- The original name of the model.
- getOwnerType() : string|null
- Gets owner_type
- getSignatureProvider() : AccountSignatureProvider
- Gets signature_provider
- getSteps() : array<string|int, AccountIdentityVerificationStep>
- Gets steps
- getters() : array<string|int, mixed>
- Array of attributes to getter functions (for serialization of requests)
- getWorkflowId() : string|null
- Gets workflow_id
- getWorkflowLabel() : string|null
- Gets workflow_label
- getWorkflowResourceKey() : string|null
- Gets workflow_resource_key
- 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.
- setDefaultDescription() : $this
- Sets default_description
- setDefaultName() : $this
- Sets default_name
- setDisplayOrder() : $this
- Sets display_order
- setInputOptions() : $this
- Sets input_options
- setIsDisabled() : $this
- Sets is_disabled
- setOwnerType() : $this
- Sets owner_type
- setSignatureProvider() : $this
- Sets signature_provider
- setSteps() : $this
- Sets steps
- setters() : array<string|int, mixed>
- Array of attributes to setter functions (for deserialization of responses)
- setWorkflowId() : $this
- Sets workflow_id
- setWorkflowLabel() : $this
- Sets workflow_label
- setWorkflowResourceKey() : $this
- Sets workflow_resource_key
- 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
= ['default_description' => 'defaultDescription', 'default_name' => 'defaultName', 'display_order' => 'displayOrder', 'input_options' => 'inputOptions', 'is_disabled' => 'isDisabled', 'owner_type' => 'ownerType', 'signature_provider' => 'signatureProvider', 'steps' => 'steps', 'workflow_id' => 'workflowId', 'workflow_label' => 'workflowLabel', 'workflow_resource_key' => 'workflowResourceKey']
$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
= ['default_description' => 'getDefaultDescription', 'default_name' => 'getDefaultName', 'display_order' => 'getDisplayOrder', 'input_options' => 'getInputOptions', 'is_disabled' => 'getIsDisabled', 'owner_type' => 'getOwnerType', 'signature_provider' => 'getSignatureProvider', 'steps' => 'getSteps', 'workflow_id' => 'getWorkflowId', 'workflow_label' => 'getWorkflowLabel', 'workflow_resource_key' => 'getWorkflowResourceKey']
$setters
Array of attributes to setter functions (for deserialization of responses)
protected
static array<string|int, string>
$setters
= ['default_description' => 'setDefaultDescription', 'default_name' => 'setDefaultName', 'display_order' => 'setDisplayOrder', 'input_options' => 'setInputOptions', 'is_disabled' => 'setIsDisabled', 'owner_type' => 'setOwnerType', 'signature_provider' => 'setSignatureProvider', 'steps' => 'setSteps', 'workflow_id' => 'setWorkflowId', 'workflow_label' => 'setWorkflowLabel', 'workflow_resource_key' => 'setWorkflowResourceKey']
$swaggerFormats
Array of property to format mappings. Used for (de)serialization
protected
static array<string|int, string>
$swaggerFormats
= ['default_description' => null, 'default_name' => null, 'display_order' => 'int32', 'input_options' => null, 'is_disabled' => null, 'owner_type' => null, 'signature_provider' => null, 'steps' => null, 'workflow_id' => null, 'workflow_label' => null, 'workflow_resource_key' => null]
$swaggerModelName
The original name of the model.
protected
static string
$swaggerModelName
= 'accountIdentityVerificationWorkflow'
$swaggerTypes
Array of property to type mappings. Used for (de)serialization
protected
static array<string|int, string>
$swaggerTypes
= ['default_description' => '?string', 'default_name' => '?string', 'display_order' => '?string', 'input_options' => '\\DocuSign\\eSign\\Model\\AccountIdentityInputOption[]', 'is_disabled' => '?string', 'owner_type' => '?string', 'signature_provider' => '\\DocuSign\\eSign\\Model\\AccountSignatureProvider', 'steps' => '\\DocuSign\\eSign\\Model\\AccountIdentityVerificationStep[]', 'workflow_id' => '?string', 'workflow_label' => '?string', 'workflow_resource_key' => '?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> —getDefaultDescription()
Gets default_description
public
getDefaultDescription() : string|null
Return values
string|null —getDefaultName()
Gets default_name
public
getDefaultName() : string|null
Return values
string|null —getDisplayOrder()
Gets display_order
public
getDisplayOrder() : string|null
Return values
string|null —getInputOptions()
Gets input_options
public
getInputOptions() : array<string|int, AccountIdentityInputOption>
Return values
array<string|int, AccountIdentityInputOption> —getIsDisabled()
Gets is_disabled
public
getIsDisabled() : string|null
Return values
string|null —getModelName()
The original name of the model.
public
getModelName() : string
Return values
string —getOwnerType()
Gets owner_type
public
getOwnerType() : string|null
Return values
string|null —getSignatureProvider()
Gets signature_provider
public
getSignatureProvider() : AccountSignatureProvider
Return values
AccountSignatureProvider —getSteps()
Gets steps
public
getSteps() : array<string|int, AccountIdentityVerificationStep>
Return values
array<string|int, AccountIdentityVerificationStep> —getters()
Array of attributes to getter functions (for serialization of requests)
public
static getters() : array<string|int, mixed>
Return values
array<string|int, mixed> —getWorkflowId()
Gets workflow_id
public
getWorkflowId() : string|null
Return values
string|null —getWorkflowLabel()
Gets workflow_label
public
getWorkflowLabel() : string|null
Return values
string|null —getWorkflowResourceKey()
Gets workflow_resource_key
public
getWorkflowResourceKey() : 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 —setDefaultDescription()
Sets default_description
public
setDefaultDescription(string|null $default_description) : $this
Parameters
- $default_description : string|null
Return values
$this —setDefaultName()
Sets default_name
public
setDefaultName(string|null $default_name) : $this
Parameters
- $default_name : string|null
Return values
$this —setDisplayOrder()
Sets display_order
public
setDisplayOrder(string|null $display_order) : $this
Parameters
- $display_order : string|null
Return values
$this —setInputOptions()
Sets input_options
public
setInputOptions(array<string|int, AccountIdentityInputOption> $input_options) : $this
Parameters
- $input_options : array<string|int, AccountIdentityInputOption>
Return values
$this —setIsDisabled()
Sets is_disabled
public
setIsDisabled(string|null $is_disabled) : $this
Parameters
- $is_disabled : string|null
Return values
$this —setOwnerType()
Sets owner_type
public
setOwnerType(string|null $owner_type) : $this
Parameters
- $owner_type : string|null
Return values
$this —setSignatureProvider()
Sets signature_provider
public
setSignatureProvider(AccountSignatureProvider $signature_provider) : $this
Parameters
- $signature_provider : AccountSignatureProvider
-
The signature provider associated with the Identity Verification workflow.
Return values
$this —setSteps()
Sets steps
public
setSteps(array<string|int, AccountIdentityVerificationStep> $steps) : $this
Parameters
- $steps : array<string|int, AccountIdentityVerificationStep>
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> —setWorkflowId()
Sets workflow_id
public
setWorkflowId(string|null $workflow_id) : $this
Parameters
- $workflow_id : string|null
Return values
$this —setWorkflowLabel()
Sets workflow_label
public
setWorkflowLabel(string|null $workflow_label) : $this
Parameters
- $workflow_label : string|null
Return values
$this —setWorkflowResourceKey()
Sets workflow_resource_key
public
setWorkflowResourceKey(string|null $workflow_resource_key) : $this
Parameters
- $workflow_resource_key : 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