Documentation

EnvelopeDocument
in package
implements ModelInterface, ArrayAccess

EnvelopeDocument Class Doc Comment

Tags
category

Class

description

This object contains details about the envelope document.

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
getAddedRecipientIds()  : array<string|int, ?string>
Gets added_recipient_ids
getAttachmentTabId()  : string|null
Gets attachment_tab_id
getAuthoritativeCopy()  : string|null
Gets authoritative_copy
getAuthoritativeCopyMetadata()  : PropertyMetadata
Gets authoritative_copy_metadata
getAvailableDocumentTypes()  : array<string|int, SignatureType>
Gets available_document_types
getContainsPdfFormFields()  : string|null
Gets contains_pdf_form_fields
getDisplay()  : string|null
Gets display
getDisplayMetadata()  : PropertyMetadata
Gets display_metadata
getDocGenDocumentStatus()  : string|null
Gets doc_gen_document_status
getDocGenErrors()  : array<string|int, DocGenSyntaxError>
Gets doc_gen_errors
getDocGenFormFields()  : array<string|int, DocGenFormField>
Gets doc_gen_form_fields
getDocumentBase64()  : string|null
Gets document_base64
getDocumentFields()  : array<string|int, NameValue>
Gets document_fields
getDocumentId()  : string|null
Gets document_id
getDocumentIdGuid()  : string|null
Gets document_id_guid
getErrorDetails()  : ErrorDetails
Gets error_details
getIncludeInDownload()  : string|null
Gets include_in_download
getIncludeInDownloadMetadata()  : PropertyMetadata
Gets include_in_download_metadata
getIsAceGenDocument()  : string|null
Gets is_ace_gen_document
getIsDocGenDocument()  : string|null
Gets is_doc_gen_document
getModelName()  : string
The original name of the model.
getName()  : string|null
Gets name
getNameMetadata()  : PropertyMetadata
Gets name_metadata
getOrder()  : string|null
Gets order
getPages()  : array<string|int, Page>
Gets pages
getSignerMustAcknowledge()  : string|null
Gets signer_must_acknowledge
getSignerMustAcknowledgeMetadata()  : PropertyMetadata
Gets signer_must_acknowledge_metadata
getSizeBytes()  : string|null
Gets size_bytes
getTemplateLocked()  : string|null
Gets template_locked
getTemplateRequired()  : string|null
Gets template_required
getters()  : array<string|int, mixed>
Array of attributes to getter functions (for serialization of requests)
getType()  : string|null
Gets type
getUri()  : string|null
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.
setAddedRecipientIds()  : $this
Sets added_recipient_ids
setAttachmentTabId()  : $this
Sets attachment_tab_id
setAuthoritativeCopy()  : $this
Sets authoritative_copy
setAuthoritativeCopyMetadata()  : $this
Sets authoritative_copy_metadata
setAvailableDocumentTypes()  : $this
Sets available_document_types
setContainsPdfFormFields()  : $this
Sets contains_pdf_form_fields
setDisplay()  : $this
Sets display
setDisplayMetadata()  : $this
Sets display_metadata
setDocGenDocumentStatus()  : $this
Sets doc_gen_document_status
setDocGenErrors()  : $this
Sets doc_gen_errors
setDocGenFormFields()  : $this
Sets doc_gen_form_fields
setDocumentBase64()  : $this
Sets document_base64
setDocumentFields()  : $this
Sets document_fields
setDocumentId()  : $this
Sets document_id
setDocumentIdGuid()  : $this
Sets document_id_guid
setErrorDetails()  : $this
Sets error_details
setIncludeInDownload()  : $this
Sets include_in_download
setIncludeInDownloadMetadata()  : $this
Sets include_in_download_metadata
setIsAceGenDocument()  : $this
Sets is_ace_gen_document
setIsDocGenDocument()  : $this
Sets is_doc_gen_document
setName()  : $this
Sets name
setNameMetadata()  : $this
Sets name_metadata
setOrder()  : $this
Sets order
setPages()  : $this
Sets pages
setSignerMustAcknowledge()  : $this
Sets signer_must_acknowledge
setSignerMustAcknowledgeMetadata()  : $this
Sets signer_must_acknowledge_metadata
setSizeBytes()  : $this
Sets size_bytes
setTemplateLocked()  : $this
Sets template_locked
setTemplateRequired()  : $this
Sets template_required
setters()  : array<string|int, mixed>
Array of attributes to setter functions (for deserialization of responses)
setType()  : $this
Sets type
setUri()  : $this
Sets uri
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 = ['added_recipient_ids' => 'addedRecipientIds', 'attachment_tab_id' => 'attachmentTabId', 'authoritative_copy' => 'authoritativeCopy', 'authoritative_copy_metadata' => 'authoritativeCopyMetadata', 'available_document_types' => 'availableDocumentTypes', 'contains_pdf_form_fields' => 'containsPdfFormFields', 'display' => 'display', 'display_metadata' => 'displayMetadata', 'doc_gen_document_status' => 'docGenDocumentStatus', 'doc_gen_errors' => 'docGenErrors', 'doc_gen_form_fields' => 'docGenFormFields', 'document_base64' => 'documentBase64', 'document_fields' => 'documentFields', 'document_id' => 'documentId', 'document_id_guid' => 'documentIdGuid', 'error_details' => 'errorDetails', 'include_in_download' => 'includeInDownload', 'include_in_download_metadata' => 'includeInDownloadMetadata', 'is_ace_gen_document' => 'isAceGenDocument', 'is_doc_gen_document' => 'isDocGenDocument', 'name' => 'name', 'name_metadata' => 'nameMetadata', 'order' => 'order', 'pages' => 'pages', 'signer_must_acknowledge' => 'signerMustAcknowledge', 'signer_must_acknowledge_metadata' => 'signerMustAcknowledgeMetadata', 'size_bytes' => 'sizeBytes', 'template_locked' => 'templateLocked', 'template_required' => 'templateRequired', 'type' => 'type', '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 = ['added_recipient_ids' => 'getAddedRecipientIds', 'attachment_tab_id' => 'getAttachmentTabId', 'authoritative_copy' => 'getAuthoritativeCopy', 'authoritative_copy_metadata' => 'getAuthoritativeCopyMetadata', 'available_document_types' => 'getAvailableDocumentTypes', 'contains_pdf_form_fields' => 'getContainsPdfFormFields', 'display' => 'getDisplay', 'display_metadata' => 'getDisplayMetadata', 'doc_gen_document_status' => 'getDocGenDocumentStatus', 'doc_gen_errors' => 'getDocGenErrors', 'doc_gen_form_fields' => 'getDocGenFormFields', 'document_base64' => 'getDocumentBase64', 'document_fields' => 'getDocumentFields', 'document_id' => 'getDocumentId', 'document_id_guid' => 'getDocumentIdGuid', 'error_details' => 'getErrorDetails', 'include_in_download' => 'getIncludeInDownload', 'include_in_download_metadata' => 'getIncludeInDownloadMetadata', 'is_ace_gen_document' => 'getIsAceGenDocument', 'is_doc_gen_document' => 'getIsDocGenDocument', 'name' => 'getName', 'name_metadata' => 'getNameMetadata', 'order' => 'getOrder', 'pages' => 'getPages', 'signer_must_acknowledge' => 'getSignerMustAcknowledge', 'signer_must_acknowledge_metadata' => 'getSignerMustAcknowledgeMetadata', 'size_bytes' => 'getSizeBytes', 'template_locked' => 'getTemplateLocked', 'template_required' => 'getTemplateRequired', 'type' => 'getType', 'uri' => 'getUri']

$setters

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

protected static array<string|int, string> $setters = ['added_recipient_ids' => 'setAddedRecipientIds', 'attachment_tab_id' => 'setAttachmentTabId', 'authoritative_copy' => 'setAuthoritativeCopy', 'authoritative_copy_metadata' => 'setAuthoritativeCopyMetadata', 'available_document_types' => 'setAvailableDocumentTypes', 'contains_pdf_form_fields' => 'setContainsPdfFormFields', 'display' => 'setDisplay', 'display_metadata' => 'setDisplayMetadata', 'doc_gen_document_status' => 'setDocGenDocumentStatus', 'doc_gen_errors' => 'setDocGenErrors', 'doc_gen_form_fields' => 'setDocGenFormFields', 'document_base64' => 'setDocumentBase64', 'document_fields' => 'setDocumentFields', 'document_id' => 'setDocumentId', 'document_id_guid' => 'setDocumentIdGuid', 'error_details' => 'setErrorDetails', 'include_in_download' => 'setIncludeInDownload', 'include_in_download_metadata' => 'setIncludeInDownloadMetadata', 'is_ace_gen_document' => 'setIsAceGenDocument', 'is_doc_gen_document' => 'setIsDocGenDocument', 'name' => 'setName', 'name_metadata' => 'setNameMetadata', 'order' => 'setOrder', 'pages' => 'setPages', 'signer_must_acknowledge' => 'setSignerMustAcknowledge', 'signer_must_acknowledge_metadata' => 'setSignerMustAcknowledgeMetadata', 'size_bytes' => 'setSizeBytes', 'template_locked' => 'setTemplateLocked', 'template_required' => 'setTemplateRequired', 'type' => 'setType', 'uri' => 'setUri']

$swaggerFormats

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

protected static array<string|int, string> $swaggerFormats = ['added_recipient_ids' => null, 'attachment_tab_id' => null, 'authoritative_copy' => null, 'authoritative_copy_metadata' => null, 'available_document_types' => null, 'contains_pdf_form_fields' => null, 'display' => null, 'display_metadata' => null, 'doc_gen_document_status' => null, 'doc_gen_errors' => null, 'doc_gen_form_fields' => null, 'document_base64' => null, 'document_fields' => null, 'document_id' => null, 'document_id_guid' => null, 'error_details' => null, 'include_in_download' => null, 'include_in_download_metadata' => null, 'is_ace_gen_document' => null, 'is_doc_gen_document' => null, 'name' => null, 'name_metadata' => null, 'order' => null, 'pages' => null, 'signer_must_acknowledge' => null, 'signer_must_acknowledge_metadata' => null, 'size_bytes' => null, 'template_locked' => null, 'template_required' => null, 'type' => null, 'uri' => null]

$swaggerModelName

The original name of the model.

protected static string $swaggerModelName = 'envelopeDocument'

$swaggerTypes

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

protected static array<string|int, string> $swaggerTypes = ['added_recipient_ids' => '?string[]', 'attachment_tab_id' => '?string', 'authoritative_copy' => '?string', 'authoritative_copy_metadata' => '\\DocuSign\\eSign\\Model\\PropertyMetadata', 'available_document_types' => '\\DocuSign\\eSign\\Model\\SignatureType[]', 'contains_pdf_form_fields' => '?string', 'display' => '?string', 'display_metadata' => '\\DocuSign\\eSign\\Model\\PropertyMetadata', 'doc_gen_document_status' => '?string', 'doc_gen_errors' => '\\DocuSign\\eSign\\Model\\DocGenSyntaxError[]', 'doc_gen_form_fields' => '\\DocuSign\\eSign\\Model\\DocGenFormField[]', 'document_base64' => '?string', 'document_fields' => '\\DocuSign\\eSign\\Model\\NameValue[]', 'document_id' => '?string', 'document_id_guid' => '?string', 'error_details' => '\\DocuSign\\eSign\\Model\\ErrorDetails', 'include_in_download' => '?string', 'include_in_download_metadata' => '\\DocuSign\\eSign\\Model\\PropertyMetadata', 'is_ace_gen_document' => '?string', 'is_doc_gen_document' => '?string', 'name' => '?string', 'name_metadata' => '\\DocuSign\\eSign\\Model\\PropertyMetadata', 'order' => '?string', 'pages' => '\\DocuSign\\eSign\\Model\\Page[]', 'signer_must_acknowledge' => '?string', 'signer_must_acknowledge_metadata' => '\\DocuSign\\eSign\\Model\\PropertyMetadata', 'size_bytes' => '?string', 'template_locked' => '?string', 'template_required' => '?string', 'type' => '?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()

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

getAddedRecipientIds()

Gets added_recipient_ids

public getAddedRecipientIds() : array<string|int, ?string>
Return values
array<string|int, ?string> —

getAttachmentTabId()

Gets attachment_tab_id

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

getAuthoritativeCopy()

Gets authoritative_copy

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

getContainsPdfFormFields()

Gets contains_pdf_form_fields

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

getDisplay()

Gets display

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

getDocGenDocumentStatus()

Gets doc_gen_document_status

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

getDocumentBase64()

Gets document_base64

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

getDocumentId()

Gets document_id

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

getDocumentIdGuid()

Gets document_id_guid

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

getIncludeInDownload()

Gets include_in_download

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

getIsAceGenDocument()

Gets is_ace_gen_document

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

getIsDocGenDocument()

Gets is_doc_gen_document

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

getOrder()

Gets order

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

getSignerMustAcknowledge()

Gets signer_must_acknowledge

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

getSizeBytes()

Gets size_bytes

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

getTemplateLocked()

Gets template_locked

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

getTemplateRequired()

Gets template_required

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

getType()

Gets type

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

getUri()

Gets uri

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

setAddedRecipientIds()

Sets added_recipient_ids

public setAddedRecipientIds(array<string|int, ?string> $added_recipient_ids) : $this
Parameters
$added_recipient_ids : array<string|int, ?string>
Return values
$this —

setAttachmentTabId()

Sets attachment_tab_id

public setAttachmentTabId(string|null $attachment_tab_id) : $this
Parameters
$attachment_tab_id : string|null
Return values
$this —

setAuthoritativeCopy()

Sets authoritative_copy

public setAuthoritativeCopy(string|null $authoritative_copy) : $this
Parameters
$authoritative_copy : string|null

Specifies the Authoritative copy feature. If set to true the Authoritative copy feature is enabled.

Return values
$this —

setAuthoritativeCopyMetadata()

Sets authoritative_copy_metadata

public setAuthoritativeCopyMetadata(PropertyMetadata $authoritative_copy_metadata) : $this
Parameters
$authoritative_copy_metadata : PropertyMetadata

Metadata that indicates if the sender can edit the authoritativeCopy property. Not applicable for template documents.

Return values
$this —

setAvailableDocumentTypes()

Sets available_document_types

public setAvailableDocumentTypes(array<string|int, SignatureType> $available_document_types) : $this
Parameters
$available_document_types : array<string|int, SignatureType>
Return values
$this —

setContainsPdfFormFields()

Sets contains_pdf_form_fields

public setContainsPdfFormFields(string|null $contains_pdf_form_fields) : $this
Parameters
$contains_pdf_form_fields : string|null
Return values
$this —

setDisplay()

Sets display

public setDisplay(string|null $display) : $this
Parameters
$display : string|null
Return values
$this —

setDisplayMetadata()

Sets display_metadata

public setDisplayMetadata(PropertyMetadata $display_metadata) : $this
Parameters
$display_metadata : PropertyMetadata

Metadata that indicates if the sender can edit the display property. Not applicable for template documents.

Return values
$this —

setDocGenDocumentStatus()

Sets doc_gen_document_status

public setDocGenDocumentStatus(string|null $doc_gen_document_status) : $this
Parameters
$doc_gen_document_status : string|null
Return values
$this —

setDocGenFormFields()

Sets doc_gen_form_fields

public setDocGenFormFields(array<string|int, DocGenFormField> $doc_gen_form_fields) : $this
Parameters
$doc_gen_form_fields : array<string|int, DocGenFormField>
Return values
$this —

setDocumentBase64()

Sets document_base64

public setDocumentBase64(string|null $document_base64) : $this
Parameters
$document_base64 : string|null
Return values
$this —

setDocumentFields()

Sets document_fields

public setDocumentFields(array<string|int, NameValue> $document_fields) : $this
Parameters
$document_fields : array<string|int, NameValue>
Return values
$this —

setDocumentId()

Sets document_id

public setDocumentId(string|null $document_id) : $this
Parameters
$document_id : string|null

Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.

Return values
$this —

setDocumentIdGuid()

Sets document_id_guid

public setDocumentIdGuid(string|null $document_id_guid) : $this
Parameters
$document_id_guid : string|null
Return values
$this —

setIncludeInDownload()

Sets include_in_download

public setIncludeInDownload(string|null $include_in_download) : $this
Parameters
$include_in_download : string|null
Return values
$this —

setIncludeInDownloadMetadata()

Sets include_in_download_metadata

public setIncludeInDownloadMetadata(PropertyMetadata $include_in_download_metadata) : $this
Parameters
$include_in_download_metadata : PropertyMetadata

Metadata that indicates if the sender can edit the includeInDownload property. Not applicable for template documents.

Return values
$this —

setIsAceGenDocument()

Sets is_ace_gen_document

public setIsAceGenDocument(string|null $is_ace_gen_document) : $this
Parameters
$is_ace_gen_document : string|null
Return values
$this —

setIsDocGenDocument()

Sets is_doc_gen_document

public setIsDocGenDocument(string|null $is_doc_gen_document) : $this
Parameters
$is_doc_gen_document : string|null
Return values
$this —

setName()

Sets name

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

setNameMetadata()

Sets name_metadata

public setNameMetadata(PropertyMetadata $name_metadata) : $this
Parameters
$name_metadata : PropertyMetadata

Metadata that indicates if the sender can edit the name property. Not applicable for template documents.

Return values
$this —

setOrder()

Sets order

public setOrder(string|null $order) : $this
Parameters
$order : string|null
Return values
$this —

setPages()

Sets pages

public setPages(array<string|int, Page> $pages) : $this
Parameters
$pages : array<string|int, Page>
Return values
$this —

setSignerMustAcknowledge()

Sets signer_must_acknowledge

public setSignerMustAcknowledge(string|null $signer_must_acknowledge) : $this
Parameters
$signer_must_acknowledge : string|null
Return values
$this —

setSignerMustAcknowledgeMetadata()

Sets signer_must_acknowledge_metadata

public setSignerMustAcknowledgeMetadata(PropertyMetadata $signer_must_acknowledge_metadata) : $this
Parameters
$signer_must_acknowledge_metadata : PropertyMetadata

Metadata that indicates if the sender can edit the signerMustAcknowledge property. Not applicable for template documents.

Return values
$this —

setSizeBytes()

Sets size_bytes

public setSizeBytes(string|null $size_bytes) : $this
Parameters
$size_bytes : string|null
Return values
$this —

setTemplateLocked()

Sets template_locked

public setTemplateLocked(string|null $template_locked) : $this
Parameters
$template_locked : string|null

When set to true, the sender cannot change any attributes of the recipient. Used only when working with template recipients.

Return values
$this —

setTemplateRequired()

Sets template_required

public setTemplateRequired(string|null $template_required) : $this
Parameters
$template_required : string|null

When set to true, the sender may not remove the recipient. Used only when working with template recipients.

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

setType()

Sets type

public setType(string|null $type) : $this
Parameters
$type : string|null
Return values
$this —

setUri()

Sets uri

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