Documentation

PowerForm
in package
implements ModelInterface, ArrayAccess

PowerForm Class Doc Comment

Tags
category

Class

description

Contains details about a PowerForm.

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
getCreatedBy()  : string|null
Gets created_by
getCreatedDateTime()  : string|null
Gets created_date_time
getEmailBody()  : string|null
Gets email_body
getEmailSubject()  : string|null
Gets email_subject
getEnvelopes()  : array<string|int, Envelope>
Gets envelopes
getErrorDetails()  : ErrorDetails
Gets error_details
getInstructions()  : string|null
Gets instructions
getIsActive()  : string|null
Gets is_active
getLastUsed()  : string|null
Gets last_used
getLimitUseInterval()  : string|null
Gets limit_use_interval
getLimitUseIntervalEnabled()  : string|null
Gets limit_use_interval_enabled
getLimitUseIntervalUnits()  : string|null
Gets limit_use_interval_units
getMaxUseEnabled()  : string|null
Gets max_use_enabled
getModelName()  : string
The original name of the model.
getName()  : string|null
Gets name
getPowerFormId()  : string|null
Gets power_form_id
getPowerFormUrl()  : string|null
Gets power_form_url
getRecipients()  : array<string|int, PowerFormRecipient>
Gets recipients
getSenderName()  : string|null
Gets sender_name
getSenderUserId()  : string|null
Gets sender_user_id
getSigningMode()  : string|null
Gets signing_mode
getTemplateId()  : string|null
Gets template_id
getTemplateName()  : string|null
Gets template_name
getters()  : array<string|int, mixed>
Array of attributes to getter functions (for serialization of requests)
getTimesUsed()  : string|null
Gets times_used
getUri()  : string|null
Gets uri
getUsesRemaining()  : string|null
Gets uses_remaining
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.
setCreatedBy()  : $this
Sets created_by
setCreatedDateTime()  : $this
Sets created_date_time
setEmailBody()  : $this
Sets email_body
setEmailSubject()  : $this
Sets email_subject
setEnvelopes()  : $this
Sets envelopes
setErrorDetails()  : $this
Sets error_details
setInstructions()  : $this
Sets instructions
setIsActive()  : $this
Sets is_active
setLastUsed()  : $this
Sets last_used
setLimitUseInterval()  : $this
Sets limit_use_interval
setLimitUseIntervalEnabled()  : $this
Sets limit_use_interval_enabled
setLimitUseIntervalUnits()  : $this
Sets limit_use_interval_units
setMaxUseEnabled()  : $this
Sets max_use_enabled
setName()  : $this
Sets name
setPowerFormId()  : $this
Sets power_form_id
setPowerFormUrl()  : $this
Sets power_form_url
setRecipients()  : $this
Sets recipients
setSenderName()  : $this
Sets sender_name
setSenderUserId()  : $this
Sets sender_user_id
setSigningMode()  : $this
Sets signing_mode
setTemplateId()  : $this
Sets template_id
setTemplateName()  : $this
Sets template_name
setters()  : array<string|int, mixed>
Array of attributes to setter functions (for deserialization of responses)
setTimesUsed()  : $this
Sets times_used
setUri()  : $this
Sets uri
setUsesRemaining()  : $this
Sets uses_remaining
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 = ['created_by' => 'createdBy', 'created_date_time' => 'createdDateTime', 'email_body' => 'emailBody', 'email_subject' => 'emailSubject', 'envelopes' => 'envelopes', 'error_details' => 'errorDetails', 'instructions' => 'instructions', 'is_active' => 'isActive', 'last_used' => 'lastUsed', 'limit_use_interval' => 'limitUseInterval', 'limit_use_interval_enabled' => 'limitUseIntervalEnabled', 'limit_use_interval_units' => 'limitUseIntervalUnits', 'max_use_enabled' => 'maxUseEnabled', 'name' => 'name', 'power_form_id' => 'powerFormId', 'power_form_url' => 'powerFormUrl', 'recipients' => 'recipients', 'sender_name' => 'senderName', 'sender_user_id' => 'senderUserId', 'signing_mode' => 'signingMode', 'template_id' => 'templateId', 'template_name' => 'templateName', 'times_used' => 'timesUsed', 'uri' => 'uri', 'uses_remaining' => 'usesRemaining']

$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 = ['created_by' => 'getCreatedBy', 'created_date_time' => 'getCreatedDateTime', 'email_body' => 'getEmailBody', 'email_subject' => 'getEmailSubject', 'envelopes' => 'getEnvelopes', 'error_details' => 'getErrorDetails', 'instructions' => 'getInstructions', 'is_active' => 'getIsActive', 'last_used' => 'getLastUsed', 'limit_use_interval' => 'getLimitUseInterval', 'limit_use_interval_enabled' => 'getLimitUseIntervalEnabled', 'limit_use_interval_units' => 'getLimitUseIntervalUnits', 'max_use_enabled' => 'getMaxUseEnabled', 'name' => 'getName', 'power_form_id' => 'getPowerFormId', 'power_form_url' => 'getPowerFormUrl', 'recipients' => 'getRecipients', 'sender_name' => 'getSenderName', 'sender_user_id' => 'getSenderUserId', 'signing_mode' => 'getSigningMode', 'template_id' => 'getTemplateId', 'template_name' => 'getTemplateName', 'times_used' => 'getTimesUsed', 'uri' => 'getUri', 'uses_remaining' => 'getUsesRemaining']

$setters

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

protected static array<string|int, string> $setters = ['created_by' => 'setCreatedBy', 'created_date_time' => 'setCreatedDateTime', 'email_body' => 'setEmailBody', 'email_subject' => 'setEmailSubject', 'envelopes' => 'setEnvelopes', 'error_details' => 'setErrorDetails', 'instructions' => 'setInstructions', 'is_active' => 'setIsActive', 'last_used' => 'setLastUsed', 'limit_use_interval' => 'setLimitUseInterval', 'limit_use_interval_enabled' => 'setLimitUseIntervalEnabled', 'limit_use_interval_units' => 'setLimitUseIntervalUnits', 'max_use_enabled' => 'setMaxUseEnabled', 'name' => 'setName', 'power_form_id' => 'setPowerFormId', 'power_form_url' => 'setPowerFormUrl', 'recipients' => 'setRecipients', 'sender_name' => 'setSenderName', 'sender_user_id' => 'setSenderUserId', 'signing_mode' => 'setSigningMode', 'template_id' => 'setTemplateId', 'template_name' => 'setTemplateName', 'times_used' => 'setTimesUsed', 'uri' => 'setUri', 'uses_remaining' => 'setUsesRemaining']

$swaggerFormats

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

protected static array<string|int, string> $swaggerFormats = ['created_by' => null, 'created_date_time' => null, 'email_body' => null, 'email_subject' => null, 'envelopes' => null, 'error_details' => null, 'instructions' => null, 'is_active' => null, 'last_used' => null, 'limit_use_interval' => null, 'limit_use_interval_enabled' => null, 'limit_use_interval_units' => null, 'max_use_enabled' => null, 'name' => null, 'power_form_id' => null, 'power_form_url' => null, 'recipients' => null, 'sender_name' => null, 'sender_user_id' => null, 'signing_mode' => null, 'template_id' => null, 'template_name' => null, 'times_used' => null, 'uri' => null, 'uses_remaining' => null]

$swaggerModelName

The original name of the model.

protected static string $swaggerModelName = 'powerForm'

$swaggerTypes

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

protected static array<string|int, string> $swaggerTypes = ['created_by' => '?string', 'created_date_time' => '?string', 'email_body' => '?string', 'email_subject' => '?string', 'envelopes' => '\\DocuSign\\eSign\\Model\\Envelope[]', 'error_details' => '\\DocuSign\\eSign\\Model\\ErrorDetails', 'instructions' => '?string', 'is_active' => '?string', 'last_used' => '?string', 'limit_use_interval' => '?string', 'limit_use_interval_enabled' => '?string', 'limit_use_interval_units' => '?string', 'max_use_enabled' => '?string', 'name' => '?string', 'power_form_id' => '?string', 'power_form_url' => '?string', 'recipients' => '\\DocuSign\\eSign\\Model\\PowerFormRecipient[]', 'sender_name' => '?string', 'sender_user_id' => '?string', 'signing_mode' => '?string', 'template_id' => '?string', 'template_name' => '?string', 'times_used' => '?string', 'uri' => '?string', 'uses_remaining' => '?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> —

getCreatedBy()

Gets created_by

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

getCreatedDateTime()

Gets created_date_time

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

getEmailBody()

Gets email_body

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

getEmailSubject()

Gets email_subject

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

getEnvelopes()

Gets envelopes

public getEnvelopes() : array<string|int, Envelope>
Return values
array<string|int, Envelope> —

getInstructions()

Gets instructions

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

getIsActive()

Gets is_active

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

getLastUsed()

Gets last_used

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

getLimitUseInterval()

Gets limit_use_interval

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

getLimitUseIntervalEnabled()

Gets limit_use_interval_enabled

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

getLimitUseIntervalUnits()

Gets limit_use_interval_units

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

getMaxUseEnabled()

Gets max_use_enabled

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

getPowerFormId()

Gets power_form_id

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

getPowerFormUrl()

Gets power_form_url

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

getSenderName()

Gets sender_name

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

getSenderUserId()

Gets sender_user_id

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

getSigningMode()

Gets signing_mode

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

getTemplateId()

Gets template_id

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

getTemplateName()

Gets template_name

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

getTimesUsed()

Gets times_used

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

getUri()

Gets uri

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

getUsesRemaining()

Gets uses_remaining

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

setCreatedBy()

Sets created_by

public setCreatedBy(string|null $created_by) : $this
Parameters
$created_by : string|null
Return values
$this —

setCreatedDateTime()

Sets created_date_time

public setCreatedDateTime(string|null $created_date_time) : $this
Parameters
$created_date_time : string|null

Indicates the date and time the item was created.

Return values
$this —

setEmailBody()

Sets email_body

public setEmailBody(string|null $email_body) : $this
Parameters
$email_body : string|null

Specifies the email body of the message sent to the recipient. Maximum length: 10000 characters.

Return values
$this —

setEmailSubject()

Sets email_subject

public setEmailSubject(string|null $email_subject) : $this
Parameters
$email_subject : string|null

Specifies the subject of the email that is sent to all recipients. See [ML:Template Email Subject Merge Fields] for information about adding merge field information to the email subject.

Return values
$this —

setEnvelopes()

Sets envelopes

public setEnvelopes(array<string|int, Envelope> $envelopes) : $this
Parameters
$envelopes : array<string|int, Envelope>
Return values
$this —

setErrorDetails()

Sets error_details

public setErrorDetails(ErrorDetails $error_details) : $this
Parameters
$error_details : ErrorDetails

Array or errors.

Return values
$this —

setInstructions()

Sets instructions

public setInstructions(string|null $instructions) : $this
Parameters
$instructions : string|null
Return values
$this —

setIsActive()

Sets is_active

public setIsActive(string|null $is_active) : $this
Parameters
$is_active : string|null
Return values
$this —

setLastUsed()

Sets last_used

public setLastUsed(string|null $last_used) : $this
Parameters
$last_used : string|null
Return values
$this —

setLimitUseInterval()

Sets limit_use_interval

public setLimitUseInterval(string|null $limit_use_interval) : $this
Parameters
$limit_use_interval : string|null
Return values
$this —

setLimitUseIntervalEnabled()

Sets limit_use_interval_enabled

public setLimitUseIntervalEnabled(string|null $limit_use_interval_enabled) : $this
Parameters
$limit_use_interval_enabled : string|null
Return values
$this —

setLimitUseIntervalUnits()

Sets limit_use_interval_units

public setLimitUseIntervalUnits(string|null $limit_use_interval_units) : $this
Parameters
$limit_use_interval_units : string|null
Return values
$this —

setMaxUseEnabled()

Sets max_use_enabled

public setMaxUseEnabled(string|null $max_use_enabled) : $this
Parameters
$max_use_enabled : string|null
Return values
$this —

setName()

Sets name

public setName(string|null $name) : $this
Parameters
$name : string|null
Return values
$this —

setPowerFormId()

Sets power_form_id

public setPowerFormId(string|null $power_form_id) : $this
Parameters
$power_form_id : string|null
Return values
$this —

setPowerFormUrl()

Sets power_form_url

public setPowerFormUrl(string|null $power_form_url) : $this
Parameters
$power_form_url : string|null
Return values
$this —

setRecipients()

Sets recipients

public setRecipients(array<string|int, PowerFormRecipient> $recipients) : $this
Parameters
$recipients : array<string|int, PowerFormRecipient>

An array of powerform recipients.

Return values
$this —

setSenderName()

Sets sender_name

public setSenderName(string|null $sender_name) : $this
Parameters
$sender_name : string|null
Return values
$this —

setSenderUserId()

Sets sender_user_id

public setSenderUserId(string|null $sender_user_id) : $this
Parameters
$sender_user_id : string|null
Return values
$this —

setSigningMode()

Sets signing_mode

public setSigningMode(string|null $signing_mode) : $this
Parameters
$signing_mode : string|null
Return values
$this —

setTemplateId()

Sets template_id

public setTemplateId(string|null $template_id) : $this
Parameters
$template_id : string|null

The unique identifier of the template. If this is not provided, DocuSign will generate a value.

Return values
$this —

setTemplateName()

Sets template_name

public setTemplateName(string|null $template_name) : $this
Parameters
$template_name : 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> —

setTimesUsed()

Sets times_used

public setTimesUsed(string|null $times_used) : $this
Parameters
$times_used : string|null
Return values
$this —

setUri()

Sets uri

public setUri(string|null $uri) : $this
Parameters
$uri : string|null
Return values
$this —

setUsesRemaining()

Sets uses_remaining

public setUsesRemaining(string|null $uses_remaining) : $this
Parameters
$uses_remaining : 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

Search results