WorkflowStep
in package
implements
ModelInterface, ArrayAccess
WorkflowStep 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
- getAction() : string|null
- Gets action
- getCompletedDate() : string|null
- Gets completed_date
- getDelayedRouting() : DelayedRouting
- Gets delayed_routing
- getItemId() : string|null
- Gets item_id
- getModelName() : string
- The original name of the model.
- getRecipientRouting() : RecipientRouting
- Gets recipient_routing
- getStatus() : string|null
- Gets status
- getters() : array<string|int, mixed>
- Array of attributes to getter functions (for serialization of requests)
- getTriggeredDate() : string|null
- Gets triggered_date
- getTriggerOnItem() : string|null
- Gets trigger_on_item
- getWorkflowStepId() : string|null
- Gets workflow_step_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.
- setAction() : $this
- Sets action
- setCompletedDate() : $this
- Sets completed_date
- setDelayedRouting() : $this
- Sets delayed_routing
- setItemId() : $this
- Sets item_id
- setRecipientRouting() : $this
- Sets recipient_routing
- setStatus() : $this
- Sets status
- setters() : array<string|int, mixed>
- Array of attributes to setter functions (for deserialization of responses)
- setTriggeredDate() : $this
- Sets triggered_date
- setTriggerOnItem() : $this
- Sets trigger_on_item
- setWorkflowStepId() : $this
- Sets workflow_step_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
= ['action' => 'action', 'completed_date' => 'completedDate', 'delayed_routing' => 'delayedRouting', 'item_id' => 'itemId', 'recipient_routing' => 'recipientRouting', 'status' => 'status', 'triggered_date' => 'triggeredDate', 'trigger_on_item' => 'triggerOnItem', 'workflow_step_id' => 'workflowStepId']
$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
= ['action' => 'getAction', 'completed_date' => 'getCompletedDate', 'delayed_routing' => 'getDelayedRouting', 'item_id' => 'getItemId', 'recipient_routing' => 'getRecipientRouting', 'status' => 'getStatus', 'triggered_date' => 'getTriggeredDate', 'trigger_on_item' => 'getTriggerOnItem', 'workflow_step_id' => 'getWorkflowStepId']
$setters
Array of attributes to setter functions (for deserialization of responses)
protected
static array<string|int, string>
$setters
= ['action' => 'setAction', 'completed_date' => 'setCompletedDate', 'delayed_routing' => 'setDelayedRouting', 'item_id' => 'setItemId', 'recipient_routing' => 'setRecipientRouting', 'status' => 'setStatus', 'triggered_date' => 'setTriggeredDate', 'trigger_on_item' => 'setTriggerOnItem', 'workflow_step_id' => 'setWorkflowStepId']
$swaggerFormats
Array of property to format mappings. Used for (de)serialization
protected
static array<string|int, string>
$swaggerFormats
= ['action' => null, 'completed_date' => null, 'delayed_routing' => null, 'item_id' => null, 'recipient_routing' => null, 'status' => null, 'triggered_date' => null, 'trigger_on_item' => null, 'workflow_step_id' => null]
$swaggerModelName
The original name of the model.
protected
static string
$swaggerModelName
= 'workflowStep'
$swaggerTypes
Array of property to type mappings. Used for (de)serialization
protected
static array<string|int, string>
$swaggerTypes
= ['action' => '?string', 'completed_date' => '?string', 'delayed_routing' => '\\DocuSign\\eSign\\Model\\DelayedRouting', 'item_id' => '?string', 'recipient_routing' => '\\DocuSign\\eSign\\Model\\RecipientRouting', 'status' => '?string', 'triggered_date' => '?string', 'trigger_on_item' => '?string', 'workflow_step_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> —getAction()
Gets action
public
getAction() : string|null
Return values
string|null —getCompletedDate()
Gets completed_date
public
getCompletedDate() : string|null
Return values
string|null —getDelayedRouting()
Gets delayed_routing
public
getDelayedRouting() : DelayedRouting
Return values
DelayedRouting —getItemId()
Gets item_id
public
getItemId() : string|null
Return values
string|null —getModelName()
The original name of the model.
public
getModelName() : string
Return values
string —getRecipientRouting()
Gets recipient_routing
public
getRecipientRouting() : RecipientRouting
Return values
RecipientRouting —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> —getTriggeredDate()
Gets triggered_date
public
getTriggeredDate() : string|null
Return values
string|null —getTriggerOnItem()
Gets trigger_on_item
public
getTriggerOnItem() : string|null
Return values
string|null —getWorkflowStepId()
Gets workflow_step_id
public
getWorkflowStepId() : 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 —setAction()
Sets action
public
setAction(string|null $action) : $this
Parameters
- $action : string|null
Return values
$this —setCompletedDate()
Sets completed_date
public
setCompletedDate(string|null $completed_date) : $this
Parameters
- $completed_date : string|null
Return values
$this —setDelayedRouting()
Sets delayed_routing
public
setDelayedRouting(DelayedRouting $delayed_routing) : $this
Parameters
- $delayed_routing : DelayedRouting
-
A complex element that specifies the delayed routing settings for the workflow step.
Return values
$this —setItemId()
Sets item_id
public
setItemId(string|null $item_id) : $this
Parameters
- $item_id : string|null
Return values
$this —setRecipientRouting()
Sets recipient_routing
public
setRecipientRouting(RecipientRouting $recipient_routing) : $this
Parameters
- $recipient_routing : RecipientRouting
-
The rules for recipient routing.
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> —setTriggeredDate()
Sets triggered_date
public
setTriggeredDate(string|null $triggered_date) : $this
Parameters
- $triggered_date : string|null
Return values
$this —setTriggerOnItem()
Sets trigger_on_item
public
setTriggerOnItem(string|null $trigger_on_item) : $this
Parameters
- $trigger_on_item : string|null
Return values
$this —setWorkflowStepId()
Sets workflow_step_id
public
setWorkflowStepId(string|null $workflow_step_id) : $this
Parameters
- $workflow_step_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