FolderItem
in package
implements
ArrayAccess
FolderItem Class Doc Comment
Tags
Interfaces, Classes, Traits and Enums
- 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)
- $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() : mixed
- getCompletedDateTime() : string
- Gets completed_date_time
- getCreatedDateTime() : string
- Gets created_date_time
- getCustomFields() : array<string|int, CustomFieldV2>
- Gets custom_fields
- getDescription() : string
- Gets description
- getEnvelopeId() : string
- Gets envelope_id
- getEnvelopeUri() : string
- Gets envelope_uri
- getIs21CfrPart11() : string
- Gets is21_cfr_part11
- getIsSignatureProviderEnvelope() : string
- Gets is_signature_provider_envelope
- getLastModified() : string
- Gets last_modified
- getName() : string
- Gets name
- getOwnerName() : string
- Gets owner_name
- getPageCount() : int
- Gets page_count
- getPassword() : string
- Gets password
- getSenderEmail() : string
- Gets sender_email
- getSenderName() : string
- Gets sender_name
- getSentDateTime() : string
- Gets sent_date_time
- getShared() : string
- Gets shared
- getStatus() : string
- Gets status
- getSubject() : string
- Gets subject
- getTemplateId() : string
- Gets template_id
- getters() : mixed
- getUri() : string
- Gets uri
- 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.
- setCompletedDateTime() : $this
- Sets completed_date_time
- setCreatedDateTime() : $this
- Sets created_date_time
- setCustomFields() : $this
- Sets custom_fields
- setDescription() : $this
- Sets description
- setEnvelopeId() : $this
- Sets envelope_id
- setEnvelopeUri() : $this
- Sets envelope_uri
- setIs21CfrPart11() : $this
- Sets is21_cfr_part11
- setIsSignatureProviderEnvelope() : $this
- Sets is_signature_provider_envelope
- setLastModified() : $this
- Sets last_modified
- setName() : $this
- Sets name
- setOwnerName() : $this
- Sets owner_name
- setPageCount() : $this
- Sets page_count
- setPassword() : $this
- Sets password
- setSenderEmail() : $this
- Sets sender_email
- setSenderName() : $this
- Sets sender_name
- setSentDateTime() : $this
- Sets sent_date_time
- setShared() : $this
- Sets shared
- setStatus() : $this
- Sets status
- setSubject() : $this
- Sets subject
- setTemplateId() : $this
- Sets template_id
- setters() : mixed
- setUri() : $this
- Sets uri
- swaggerTypes() : mixed
- 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
= ['completed_date_time' => 'completedDateTime', 'created_date_time' => 'createdDateTime', 'custom_fields' => 'customFields', 'description' => 'description', 'envelope_id' => 'envelopeId', 'envelope_uri' => 'envelopeUri', 'is21_cfr_part11' => 'is21CFRPart11', 'is_signature_provider_envelope' => 'isSignatureProviderEnvelope', 'last_modified' => 'lastModified', 'name' => 'name', 'owner_name' => 'ownerName', 'page_count' => 'pageCount', 'password' => 'password', 'sender_email' => 'senderEmail', 'sender_name' => 'senderName', 'sent_date_time' => 'sentDateTime', 'shared' => 'shared', 'status' => 'status', 'subject' => 'subject', 'template_id' => 'templateId', 'uri' => 'uri']
$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
= ['completed_date_time' => 'getCompletedDateTime', 'created_date_time' => 'getCreatedDateTime', 'custom_fields' => 'getCustomFields', 'description' => 'getDescription', 'envelope_id' => 'getEnvelopeId', 'envelope_uri' => 'getEnvelopeUri', 'is21_cfr_part11' => 'getIs21CfrPart11', 'is_signature_provider_envelope' => 'getIsSignatureProviderEnvelope', 'last_modified' => 'getLastModified', 'name' => 'getName', 'owner_name' => 'getOwnerName', 'page_count' => 'getPageCount', 'password' => 'getPassword', 'sender_email' => 'getSenderEmail', 'sender_name' => 'getSenderName', 'sent_date_time' => 'getSentDateTime', 'shared' => 'getShared', 'status' => 'getStatus', 'subject' => 'getSubject', 'template_id' => 'getTemplateId', 'uri' => 'getUri']
$setters
Array of attributes to setter functions (for deserialization of responses)
protected
static array<string|int, string>
$setters
= ['completed_date_time' => 'setCompletedDateTime', 'created_date_time' => 'setCreatedDateTime', 'custom_fields' => 'setCustomFields', 'description' => 'setDescription', 'envelope_id' => 'setEnvelopeId', 'envelope_uri' => 'setEnvelopeUri', 'is21_cfr_part11' => 'setIs21CfrPart11', 'is_signature_provider_envelope' => 'setIsSignatureProviderEnvelope', 'last_modified' => 'setLastModified', 'name' => 'setName', 'owner_name' => 'setOwnerName', 'page_count' => 'setPageCount', 'password' => 'setPassword', 'sender_email' => 'setSenderEmail', 'sender_name' => 'setSenderName', 'sent_date_time' => 'setSentDateTime', 'shared' => 'setShared', 'status' => 'setStatus', 'subject' => 'setSubject', 'template_id' => 'setTemplateId', 'uri' => 'setUri']
$swaggerModelName
The original name of the model.
protected
static string
$swaggerModelName
= 'folderItem'
$swaggerTypes
Array of property to type mappings. Used for (de)serialization
protected
static array<string|int, string>
$swaggerTypes
= ['completed_date_time' => 'string', 'created_date_time' => 'string', 'custom_fields' => '\\DocuSign\\eSign\\Model\\CustomFieldV2[]', 'description' => 'string', 'envelope_id' => 'string', 'envelope_uri' => 'string', 'is21_cfr_part11' => 'string', 'is_signature_provider_envelope' => 'string', 'last_modified' => 'string', 'name' => 'string', 'owner_name' => 'string', 'page_count' => 'int', 'password' => 'string', 'sender_email' => 'string', 'sender_name' => 'string', 'sent_date_time' => 'string', 'shared' => 'string', 'status' => 'string', 'subject' => 'string', 'template_id' => 'string', 'uri' => '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()
public
static attributeMap() : mixed
Return values
mixed —getCompletedDateTime()
Gets completed_date_time
public
getCompletedDateTime() : string
Return values
string —getCreatedDateTime()
Gets created_date_time
public
getCreatedDateTime() : string
Return values
string —getCustomFields()
Gets custom_fields
public
getCustomFields() : array<string|int, CustomFieldV2>
Return values
array<string|int, CustomFieldV2> —getDescription()
Gets description
public
getDescription() : string
Return values
string —getEnvelopeId()
Gets envelope_id
public
getEnvelopeId() : string
Return values
string —getEnvelopeUri()
Gets envelope_uri
public
getEnvelopeUri() : string
Return values
string —getIs21CfrPart11()
Gets is21_cfr_part11
public
getIs21CfrPart11() : string
Return values
string —getIsSignatureProviderEnvelope()
Gets is_signature_provider_envelope
public
getIsSignatureProviderEnvelope() : string
Return values
string —getLastModified()
Gets last_modified
public
getLastModified() : string
Return values
string —getName()
Gets name
public
getName() : string
Return values
string —getOwnerName()
Gets owner_name
public
getOwnerName() : string
Return values
string —getPageCount()
Gets page_count
public
getPageCount() : int
Return values
int —getPassword()
Gets password
public
getPassword() : string
Return values
string —getSenderEmail()
Gets sender_email
public
getSenderEmail() : string
Return values
string —getSenderName()
Gets sender_name
public
getSenderName() : string
Return values
string —getSentDateTime()
Gets sent_date_time
public
getSentDateTime() : string
Return values
string —getShared()
Gets shared
public
getShared() : string
Return values
string —getStatus()
Gets status
public
getStatus() : string
Return values
string —getSubject()
Gets subject
public
getSubject() : string
Return values
string —getTemplateId()
Gets template_id
public
getTemplateId() : string
Return values
string —getters()
public
static getters() : mixed
Return values
mixed —getUri()
Gets uri
public
getUri() : string
Return values
string —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 —setCompletedDateTime()
Sets completed_date_time
public
setCompletedDateTime(string $completed_date_time) : $this
Parameters
- $completed_date_time : string
-
Specifies the date and time this item was completed.
Return values
$this —setCreatedDateTime()
Sets created_date_time
public
setCreatedDateTime(string $created_date_time) : $this
Parameters
- $created_date_time : string
-
Indicates the date and time the item was created.
Return values
$this —setCustomFields()
Sets custom_fields
public
setCustomFields(array<string|int, CustomFieldV2> $custom_fields) : $this
Parameters
- $custom_fields : array<string|int, CustomFieldV2>
-
An optional array of strings that allows the sender to provide custom data about the recipient. This information is returned in the envelope status but otherwise not used by DocuSign. Each customField string can be a maximum of 100 characters.
Return values
$this —setDescription()
Sets description
public
setDescription(string $description) : $this
Parameters
- $description : string
Return values
$this —setEnvelopeId()
Sets envelope_id
public
setEnvelopeId(string $envelope_id) : $this
Parameters
- $envelope_id : string
-
The envelope ID of the envelope status that failed to post.
Return values
$this —setEnvelopeUri()
Sets envelope_uri
public
setEnvelopeUri(string $envelope_uri) : $this
Parameters
- $envelope_uri : string
-
Contains a URI for an endpoint that you can use to retrieve the envelope or envelopes.
Return values
$this —setIs21CfrPart11()
Sets is21_cfr_part11
public
setIs21CfrPart11(string $is21_cfr_part11) : $this
Parameters
- $is21_cfr_part11 : string
-
When set to true, indicates that this module is enabled on the account.
Return values
$this —setIsSignatureProviderEnvelope()
Sets is_signature_provider_envelope
public
setIsSignatureProviderEnvelope(string $is_signature_provider_envelope) : $this
Parameters
- $is_signature_provider_envelope : string
Return values
$this —setLastModified()
Sets last_modified
public
setLastModified(string $last_modified) : $this
Parameters
- $last_modified : string
Return values
$this —setName()
Sets name
public
setName(string $name) : $this
Parameters
- $name : string
Return values
$this —setOwnerName()
Sets owner_name
public
setOwnerName(string $owner_name) : $this
Parameters
- $owner_name : string
-
Name of the envelope owner.
Return values
$this —setPageCount()
Sets page_count
public
setPageCount(int $page_count) : $this
Parameters
- $page_count : int
Return values
$this —setPassword()
Sets password
public
setPassword(string $password) : $this
Parameters
- $password : string
Return values
$this —setSenderEmail()
Sets sender_email
public
setSenderEmail(string $sender_email) : $this
Parameters
- $sender_email : string
Return values
$this —setSenderName()
Sets sender_name
public
setSenderName(string $sender_name) : $this
Parameters
- $sender_name : string
-
Name of the envelope sender.
Return values
$this —setSentDateTime()
Sets sent_date_time
public
setSentDateTime(string $sent_date_time) : $this
Parameters
- $sent_date_time : string
-
The date and time the envelope was sent.
Return values
$this —setShared()
Sets shared
public
setShared(string $shared) : $this
Parameters
- $shared : string
-
When set to true, this custom tab is shared.
Return values
$this —setStatus()
Sets status
public
setStatus(string $status) : $this
Parameters
- $status : string
-
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 —setSubject()
Sets subject
public
setSubject(string $subject) : $this
Parameters
- $subject : string
Return values
$this —setTemplateId()
Sets template_id
public
setTemplateId(string $template_id) : $this
Parameters
- $template_id : string
-
The unique identifier of the template. If this is not provided, DocuSign will generate a value.
Return values
$this —setters()
public
static setters() : mixed
Return values
mixed —setUri()
Sets uri
public
setUri(string $uri) : $this
Parameters
- $uri : string
Return values
$this —swaggerTypes()
public
static swaggerTypes() : mixed
Return values
mixed —valid()
validate all the properties in the model return true if all passed
public
valid() : bool
Return values
bool —True if all properteis are valid