Documentation

Workflow
in package
implements ModelInterface, ArrayAccess

Workflow Class Doc Comment

Tags
category

Class

description

Describes the workflow for an envelope.

author

Swagger Codegen team apihelp@docusign.com

license

The DocuSign PHP Client SDK is licensed under the MIT License.

link
https://github.com/swagger-api/swagger-codegen

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
getCurrentWorkflowStepId()  : string|null
Gets current_workflow_step_id
getModelName()  : string
The original name of the model.
getOverwriteUpdateMode()  : string|null
Gets overwrite_update_mode
getResumeDate()  : string|null
Gets resume_date
getScheduledSending()  : ScheduledSending
Gets scheduled_sending
getters()  : array<string|int, mixed>
Array of attributes to getter functions (for serialization of requests)
getWorkflowStatus()  : string|null
Gets workflow_status
getWorkflowSteps()  : array<string|int, WorkflowStep>
Gets workflow_steps
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.
setCurrentWorkflowStepId()  : $this
Sets current_workflow_step_id
setOverwriteUpdateMode()  : $this
Sets overwrite_update_mode
setResumeDate()  : $this
Sets resume_date
setScheduledSending()  : $this
Sets scheduled_sending
setters()  : array<string|int, mixed>
Array of attributes to setter functions (for deserialization of responses)
setWorkflowStatus()  : $this
Sets workflow_status
setWorkflowSteps()  : $this
Sets workflow_steps
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 = ['current_workflow_step_id' => 'currentWorkflowStepId', 'overwrite_update_mode' => 'overwriteUpdateMode', 'resume_date' => 'resumeDate', 'scheduled_sending' => 'scheduledSending', 'workflow_status' => 'workflowStatus', 'workflow_steps' => 'workflowSteps']

$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 = ['current_workflow_step_id' => 'getCurrentWorkflowStepId', 'overwrite_update_mode' => 'getOverwriteUpdateMode', 'resume_date' => 'getResumeDate', 'scheduled_sending' => 'getScheduledSending', 'workflow_status' => 'getWorkflowStatus', 'workflow_steps' => 'getWorkflowSteps']

$setters

Array of attributes to setter functions (for deserialization of responses)

protected static array<string|int, string> $setters = ['current_workflow_step_id' => 'setCurrentWorkflowStepId', 'overwrite_update_mode' => 'setOverwriteUpdateMode', 'resume_date' => 'setResumeDate', 'scheduled_sending' => 'setScheduledSending', 'workflow_status' => 'setWorkflowStatus', 'workflow_steps' => 'setWorkflowSteps']

$swaggerFormats

Array of property to format mappings. Used for (de)serialization

protected static array<string|int, string> $swaggerFormats = ['current_workflow_step_id' => null, 'overwrite_update_mode' => null, 'resume_date' => null, 'scheduled_sending' => null, 'workflow_status' => null, 'workflow_steps' => null]

$swaggerModelName

The original name of the model.

protected static string $swaggerModelName = 'workflow'

$swaggerTypes

Array of property to type mappings. Used for (de)serialization

protected static array<string|int, string> $swaggerTypes = ['current_workflow_step_id' => '?string', 'overwrite_update_mode' => '?string', 'resume_date' => '?string', 'scheduled_sending' => '\\DocuSign\\eSign\\Model\\ScheduledSending', 'workflow_status' => '?string', 'workflow_steps' => '\\DocuSign\\eSign\\Model\\WorkflowStep[]']

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> —

getCurrentWorkflowStepId()

Gets current_workflow_step_id

public getCurrentWorkflowStepId() : string|null
Return values
string|null —

getModelName()

The original name of the model.

public getModelName() : string
Return values
string —

getOverwriteUpdateMode()

Gets overwrite_update_mode

public getOverwriteUpdateMode() : string|null
Return values
string|null —

getResumeDate()

Gets resume_date

public getResumeDate() : 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> —

getWorkflowStatus()

Gets workflow_status

public getWorkflowStatus() : 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 —

setCurrentWorkflowStepId()

Sets current_workflow_step_id

public setCurrentWorkflowStepId(string|null $current_workflow_step_id) : $this
Parameters
$current_workflow_step_id : string|null
Return values
$this —

setOverwriteUpdateMode()

Sets overwrite_update_mode

public setOverwriteUpdateMode(string|null $overwrite_update_mode) : $this
Parameters
$overwrite_update_mode : string|null
Return values
$this —

setResumeDate()

Sets resume_date

public setResumeDate(string|null $resume_date) : $this
Parameters
$resume_date : string|null
Return values
$this —

setScheduledSending()

Sets scheduled_sending

public setScheduledSending(ScheduledSending $scheduled_sending) : $this
Parameters
$scheduled_sending : ScheduledSending

An object that describes the settings for scheduled sending.

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> —

setWorkflowStatus()

Sets workflow_status

public setWorkflowStatus(string|null $workflow_status) : $this
Parameters
$workflow_status : string|null
Return values
$this —

setWorkflowSteps()

Sets workflow_steps

public setWorkflowSteps(array<string|int, WorkflowStep> $workflow_steps) : $this
Parameters
$workflow_steps : array<string|int, WorkflowStep>
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

Search results