Documentation

FolderItemV2
in package
implements ModelInterface, ArrayAccess

FolderItemV2 Class Doc Comment

Tags
category

Class

description

Information about folder item results.

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
getCompletedDateTime()  : string|null
Gets completed_date_time
getCreatedDateTime()  : string|null
Gets created_date_time
getEnvelopeId()  : string|null
Gets envelope_id
getEnvelopeUri()  : string|null
Gets envelope_uri
getExpireDateTime()  : string|null
Gets expire_date_time
getFolderId()  : string|null
Gets folder_id
getFolderUri()  : string|null
Gets folder_uri
getIs21CfrPart11()  : string|null
Gets is21_cfr_part11
getLastModifiedDateTime()  : string|null
Gets last_modified_date_time
getModelName()  : string
The original name of the model.
getOwnerName()  : string|null
Gets owner_name
getRecipients()  : Recipients
Gets recipients
getRecipientsUri()  : string|null
Gets recipients_uri
getSenderCompany()  : string|null
Gets sender_company
getSenderEmail()  : string|null
Gets sender_email
getSenderName()  : string|null
Gets sender_name
getSenderUserId()  : string|null
Gets sender_user_id
getSentDateTime()  : string|null
Gets sent_date_time
getStatus()  : string|null
Gets status
getSubject()  : string|null
Gets subject
getTemplateId()  : string|null
Gets template_id
getTemplateUri()  : string|null
Gets template_uri
getters()  : array<string|int, mixed>
Array of attributes to getter functions (for serialization of requests)
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
setEnvelopeId()  : $this
Sets envelope_id
setEnvelopeUri()  : $this
Sets envelope_uri
setExpireDateTime()  : $this
Sets expire_date_time
setFolderId()  : $this
Sets folder_id
setFolderUri()  : $this
Sets folder_uri
setIs21CfrPart11()  : $this
Sets is21_cfr_part11
setLastModifiedDateTime()  : $this
Sets last_modified_date_time
setOwnerName()  : $this
Sets owner_name
setRecipients()  : $this
Sets recipients
setRecipientsUri()  : $this
Sets recipients_uri
setSenderCompany()  : $this
Sets sender_company
setSenderEmail()  : $this
Sets sender_email
setSenderName()  : $this
Sets sender_name
setSenderUserId()  : $this
Sets sender_user_id
setSentDateTime()  : $this
Sets sent_date_time
setStatus()  : $this
Sets status
setSubject()  : $this
Sets subject
setTemplateId()  : $this
Sets template_id
setTemplateUri()  : $this
Sets template_uri
setters()  : array<string|int, mixed>
Array of attributes to setter functions (for deserialization of responses)
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

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', 'envelope_id' => 'envelopeId', 'envelope_uri' => 'envelopeUri', 'expire_date_time' => 'expireDateTime', 'folder_id' => 'folderId', 'folder_uri' => 'folderUri', 'is21_cfr_part11' => 'is21CFRPart11', 'last_modified_date_time' => 'lastModifiedDateTime', 'owner_name' => 'ownerName', 'recipients' => 'recipients', 'recipients_uri' => 'recipientsUri', 'sender_company' => 'senderCompany', 'sender_email' => 'senderEmail', 'sender_name' => 'senderName', 'sender_user_id' => 'senderUserId', 'sent_date_time' => 'sentDateTime', 'status' => 'status', 'subject' => 'subject', 'template_id' => 'templateId', 'template_uri' => 'templateUri']

$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', 'envelope_id' => 'getEnvelopeId', 'envelope_uri' => 'getEnvelopeUri', 'expire_date_time' => 'getExpireDateTime', 'folder_id' => 'getFolderId', 'folder_uri' => 'getFolderUri', 'is21_cfr_part11' => 'getIs21CfrPart11', 'last_modified_date_time' => 'getLastModifiedDateTime', 'owner_name' => 'getOwnerName', 'recipients' => 'getRecipients', 'recipients_uri' => 'getRecipientsUri', 'sender_company' => 'getSenderCompany', 'sender_email' => 'getSenderEmail', 'sender_name' => 'getSenderName', 'sender_user_id' => 'getSenderUserId', 'sent_date_time' => 'getSentDateTime', 'status' => 'getStatus', 'subject' => 'getSubject', 'template_id' => 'getTemplateId', 'template_uri' => 'getTemplateUri']

$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', 'envelope_id' => 'setEnvelopeId', 'envelope_uri' => 'setEnvelopeUri', 'expire_date_time' => 'setExpireDateTime', 'folder_id' => 'setFolderId', 'folder_uri' => 'setFolderUri', 'is21_cfr_part11' => 'setIs21CfrPart11', 'last_modified_date_time' => 'setLastModifiedDateTime', 'owner_name' => 'setOwnerName', 'recipients' => 'setRecipients', 'recipients_uri' => 'setRecipientsUri', 'sender_company' => 'setSenderCompany', 'sender_email' => 'setSenderEmail', 'sender_name' => 'setSenderName', 'sender_user_id' => 'setSenderUserId', 'sent_date_time' => 'setSentDateTime', 'status' => 'setStatus', 'subject' => 'setSubject', 'template_id' => 'setTemplateId', 'template_uri' => 'setTemplateUri']

$swaggerFormats

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

protected static array<string|int, string> $swaggerFormats = ['completed_date_time' => null, 'created_date_time' => null, 'envelope_id' => null, 'envelope_uri' => null, 'expire_date_time' => null, 'folder_id' => null, 'folder_uri' => null, 'is21_cfr_part11' => null, 'last_modified_date_time' => null, 'owner_name' => null, 'recipients' => null, 'recipients_uri' => null, 'sender_company' => null, 'sender_email' => null, 'sender_name' => null, 'sender_user_id' => null, 'sent_date_time' => null, 'status' => null, 'subject' => null, 'template_id' => null, 'template_uri' => null]

$swaggerModelName

The original name of the model.

protected static string $swaggerModelName = 'folderItem_v2'

$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', 'envelope_id' => '?string', 'envelope_uri' => '?string', 'expire_date_time' => '?string', 'folder_id' => '?string', 'folder_uri' => '?string', 'is21_cfr_part11' => '?string', 'last_modified_date_time' => '?string', 'owner_name' => '?string', 'recipients' => '\\DocuSign\\eSign\\Model\\Recipients', 'recipients_uri' => '?string', 'sender_company' => '?string', 'sender_email' => '?string', 'sender_name' => '?string', 'sender_user_id' => '?string', 'sent_date_time' => '?string', 'status' => '?string', 'subject' => '?string', 'template_id' => '?string', 'template_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()

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

getCompletedDateTime()

Gets completed_date_time

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

getCreatedDateTime()

Gets created_date_time

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

getEnvelopeId()

Gets envelope_id

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

getEnvelopeUri()

Gets envelope_uri

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

getExpireDateTime()

Gets expire_date_time

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

getFolderId()

Gets folder_id

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

getFolderUri()

Gets folder_uri

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

getIs21CfrPart11()

Gets is21_cfr_part11

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

getLastModifiedDateTime()

Gets last_modified_date_time

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

getModelName()

The original name of the model.

public getModelName() : string
Return values
string —

getOwnerName()

Gets owner_name

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

getRecipientsUri()

Gets recipients_uri

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

getSenderCompany()

Gets sender_company

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

getSenderEmail()

Gets sender_email

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

getSentDateTime()

Gets sent_date_time

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

getStatus()

Gets status

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

getSubject()

Gets subject

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

getTemplateId()

Gets template_id

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

getTemplateUri()

Gets template_uri

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

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|null $completed_date_time) : $this
Parameters
$completed_date_time : string|null

Specifies the date and time this item was completed.

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 —

setEnvelopeId()

Sets envelope_id

public setEnvelopeId(string|null $envelope_id) : $this
Parameters
$envelope_id : string|null

The envelope ID of the envelope status that failed to post.

Return values
$this —

setEnvelopeUri()

Sets envelope_uri

public setEnvelopeUri(string|null $envelope_uri) : $this
Parameters
$envelope_uri : string|null

Contains a URI for an endpoint that you can use to retrieve the envelope or envelopes.

Return values
$this —

setExpireDateTime()

Sets expire_date_time

public setExpireDateTime(string|null $expire_date_time) : $this
Parameters
$expire_date_time : string|null

The date and time the envelope is set to expire.

Return values
$this —

setFolderId()

Sets folder_id

public setFolderId(string|null $folder_id) : $this
Parameters
$folder_id : string|null
Return values
$this —

setFolderUri()

Sets folder_uri

public setFolderUri(string|null $folder_uri) : $this
Parameters
$folder_uri : string|null
Return values
$this —

setIs21CfrPart11()

Sets is21_cfr_part11

public setIs21CfrPart11(string|null $is21_cfr_part11) : $this
Parameters
$is21_cfr_part11 : string|null

When set to true, indicates that this module is enabled on the account.

Return values
$this —

setLastModifiedDateTime()

Sets last_modified_date_time

public setLastModifiedDateTime(string|null $last_modified_date_time) : $this
Parameters
$last_modified_date_time : string|null

The date and time the item was last modified.

Return values
$this —

setOwnerName()

Sets owner_name

public setOwnerName(string|null $owner_name) : $this
Parameters
$owner_name : string|null
Return values
$this —

setRecipients()

Sets recipients

public setRecipients(Recipients $recipients) : $this
Parameters
$recipients : Recipients

An array of powerform recipients.

Return values
$this —

setRecipientsUri()

Sets recipients_uri

public setRecipientsUri(string|null $recipients_uri) : $this
Parameters
$recipients_uri : string|null

Contains a URI for an endpoint that you can use to retrieve the recipients.

Return values
$this —

setSenderCompany()

Sets sender_company

public setSenderCompany(string|null $sender_company) : $this
Parameters
$sender_company : string|null
Return values
$this —

setSenderEmail()

Sets sender_email

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

setSentDateTime()

Sets sent_date_time

public setSentDateTime(string|null $sent_date_time) : $this
Parameters
$sent_date_time : string|null

The date and time the envelope was sent.

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 —

setSubject()

Sets subject

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

setTemplateUri()

Sets template_uri

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

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