Documentation

Document
in package
implements ModelInterface, ArrayAccess

Document Class Doc Comment

Tags
category

Class

description

A document object.

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
getApplyAnchorTabs()  : string|null
Gets apply_anchor_tabs
getAssignTabsToRecipientId()  : string|null
Gets assign_tabs_to_recipient_id
getDisplay()  : string|null
Gets display
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
getEncryptedWithKeyManager()  : string|null
Gets encrypted_with_key_manager
getFileExtension()  : string|null
Gets file_extension
getFileFormatHint()  : string|null
Gets file_format_hint
getHtmlDefinition()  : DocumentHtmlDefinition
Gets html_definition
getIncludeInDownload()  : string|null
Gets include_in_download
getIsDocGenDocument()  : string|null
Gets is_doc_gen_document
getMatchBoxes()  : array<string|int, MatchBox>
Gets match_boxes
getModelName()  : string
The original name of the model.
getName()  : string|null
Gets name
getOrder()  : string|null
Gets order
getPages()  : string|null
Gets pages
getPassword()  : string|null
Gets password
getPdfFormFieldOption()  : string|null
Gets pdf_form_field_option
getRemoteUrl()  : string|null
Gets remote_url
getSignerMustAcknowledge()  : string|null
Gets signer_must_acknowledge
getSignerMustAcknowledgeUseAccountDefault()  : bool|null
Gets signer_must_acknowledge_use_account_default
getTabs()  : Tabs
Gets tabs
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)
getTransformPdfFields()  : string|null
Gets transform_pdf_fields
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.
setApplyAnchorTabs()  : $this
Sets apply_anchor_tabs
setAssignTabsToRecipientId()  : $this
Sets assign_tabs_to_recipient_id
setDisplay()  : $this
Sets display
setDocGenFormFields()  : $this
Sets doc_gen_form_fields
setDocumentBase64()  : $this
Sets document_base64
setDocumentFields()  : $this
Sets document_fields
setDocumentId()  : $this
Sets document_id
setEncryptedWithKeyManager()  : $this
Sets encrypted_with_key_manager
setFileExtension()  : $this
Sets file_extension
setFileFormatHint()  : $this
Sets file_format_hint
setHtmlDefinition()  : $this
Sets html_definition
setIncludeInDownload()  : $this
Sets include_in_download
setIsDocGenDocument()  : $this
Sets is_doc_gen_document
setMatchBoxes()  : $this
Sets match_boxes
setName()  : $this
Sets name
setOrder()  : $this
Sets order
setPages()  : $this
Sets pages
setPassword()  : $this
Sets password
setPdfFormFieldOption()  : $this
Sets pdf_form_field_option
setRemoteUrl()  : $this
Sets remote_url
setSignerMustAcknowledge()  : $this
Sets signer_must_acknowledge
setSignerMustAcknowledgeUseAccountDefault()  : $this
Sets signer_must_acknowledge_use_account_default
setTabs()  : $this
Sets tabs
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)
setTransformPdfFields()  : $this
Sets transform_pdf_fields
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

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 = ['apply_anchor_tabs' => 'applyAnchorTabs', 'assign_tabs_to_recipient_id' => 'assignTabsToRecipientId', 'display' => 'display', 'doc_gen_form_fields' => 'docGenFormFields', 'document_base64' => 'documentBase64', 'document_fields' => 'documentFields', 'document_id' => 'documentId', 'encrypted_with_key_manager' => 'encryptedWithKeyManager', 'file_extension' => 'fileExtension', 'file_format_hint' => 'fileFormatHint', 'html_definition' => 'htmlDefinition', 'include_in_download' => 'includeInDownload', 'is_doc_gen_document' => 'isDocGenDocument', 'match_boxes' => 'matchBoxes', 'name' => 'name', 'order' => 'order', 'pages' => 'pages', 'password' => 'password', 'pdf_form_field_option' => 'pdfFormFieldOption', 'remote_url' => 'remoteUrl', 'signer_must_acknowledge' => 'signerMustAcknowledge', 'signer_must_acknowledge_use_account_default' => 'signerMustAcknowledgeUseAccountDefault', 'tabs' => 'tabs', 'template_locked' => 'templateLocked', 'template_required' => 'templateRequired', 'transform_pdf_fields' => 'transformPdfFields', '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 = ['apply_anchor_tabs' => 'getApplyAnchorTabs', 'assign_tabs_to_recipient_id' => 'getAssignTabsToRecipientId', 'display' => 'getDisplay', 'doc_gen_form_fields' => 'getDocGenFormFields', 'document_base64' => 'getDocumentBase64', 'document_fields' => 'getDocumentFields', 'document_id' => 'getDocumentId', 'encrypted_with_key_manager' => 'getEncryptedWithKeyManager', 'file_extension' => 'getFileExtension', 'file_format_hint' => 'getFileFormatHint', 'html_definition' => 'getHtmlDefinition', 'include_in_download' => 'getIncludeInDownload', 'is_doc_gen_document' => 'getIsDocGenDocument', 'match_boxes' => 'getMatchBoxes', 'name' => 'getName', 'order' => 'getOrder', 'pages' => 'getPages', 'password' => 'getPassword', 'pdf_form_field_option' => 'getPdfFormFieldOption', 'remote_url' => 'getRemoteUrl', 'signer_must_acknowledge' => 'getSignerMustAcknowledge', 'signer_must_acknowledge_use_account_default' => 'getSignerMustAcknowledgeUseAccountDefault', 'tabs' => 'getTabs', 'template_locked' => 'getTemplateLocked', 'template_required' => 'getTemplateRequired', 'transform_pdf_fields' => 'getTransformPdfFields', 'uri' => 'getUri']

$setters

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

protected static array<string|int, string> $setters = ['apply_anchor_tabs' => 'setApplyAnchorTabs', 'assign_tabs_to_recipient_id' => 'setAssignTabsToRecipientId', 'display' => 'setDisplay', 'doc_gen_form_fields' => 'setDocGenFormFields', 'document_base64' => 'setDocumentBase64', 'document_fields' => 'setDocumentFields', 'document_id' => 'setDocumentId', 'encrypted_with_key_manager' => 'setEncryptedWithKeyManager', 'file_extension' => 'setFileExtension', 'file_format_hint' => 'setFileFormatHint', 'html_definition' => 'setHtmlDefinition', 'include_in_download' => 'setIncludeInDownload', 'is_doc_gen_document' => 'setIsDocGenDocument', 'match_boxes' => 'setMatchBoxes', 'name' => 'setName', 'order' => 'setOrder', 'pages' => 'setPages', 'password' => 'setPassword', 'pdf_form_field_option' => 'setPdfFormFieldOption', 'remote_url' => 'setRemoteUrl', 'signer_must_acknowledge' => 'setSignerMustAcknowledge', 'signer_must_acknowledge_use_account_default' => 'setSignerMustAcknowledgeUseAccountDefault', 'tabs' => 'setTabs', 'template_locked' => 'setTemplateLocked', 'template_required' => 'setTemplateRequired', 'transform_pdf_fields' => 'setTransformPdfFields', 'uri' => 'setUri']

$swaggerFormats

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

protected static array<string|int, string> $swaggerFormats = ['apply_anchor_tabs' => null, 'assign_tabs_to_recipient_id' => null, 'display' => null, 'doc_gen_form_fields' => null, 'document_base64' => null, 'document_fields' => null, 'document_id' => null, 'encrypted_with_key_manager' => null, 'file_extension' => null, 'file_format_hint' => null, 'html_definition' => null, 'include_in_download' => null, 'is_doc_gen_document' => null, 'match_boxes' => null, 'name' => null, 'order' => null, 'pages' => null, 'password' => null, 'pdf_form_field_option' => null, 'remote_url' => null, 'signer_must_acknowledge' => null, 'signer_must_acknowledge_use_account_default' => null, 'tabs' => null, 'template_locked' => null, 'template_required' => null, 'transform_pdf_fields' => null, 'uri' => null]

$swaggerModelName

The original name of the model.

protected static string $swaggerModelName = 'document'

$swaggerTypes

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

protected static array<string|int, string> $swaggerTypes = ['apply_anchor_tabs' => '?string', 'assign_tabs_to_recipient_id' => '?string', 'display' => '?string', 'doc_gen_form_fields' => '\\DocuSign\\eSign\\Model\\DocGenFormField[]', 'document_base64' => '?string', 'document_fields' => '\\DocuSign\\eSign\\Model\\NameValue[]', 'document_id' => '?string', 'encrypted_with_key_manager' => '?string', 'file_extension' => '?string', 'file_format_hint' => '?string', 'html_definition' => '\\DocuSign\\eSign\\Model\\DocumentHtmlDefinition', 'include_in_download' => '?string', 'is_doc_gen_document' => '?string', 'match_boxes' => '\\DocuSign\\eSign\\Model\\MatchBox[]', 'name' => '?string', 'order' => '?string', 'pages' => '?string', 'password' => '?string', 'pdf_form_field_option' => '?string', 'remote_url' => '?string', 'signer_must_acknowledge' => '?string', 'signer_must_acknowledge_use_account_default' => '?bool', 'tabs' => '\\DocuSign\\eSign\\Model\\Tabs', 'template_locked' => '?string', 'template_required' => '?string', 'transform_pdf_fields' => '?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> —

getApplyAnchorTabs()

Gets apply_anchor_tabs

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

getAssignTabsToRecipientId()

Gets assign_tabs_to_recipient_id

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

getDisplay()

Gets display

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

getDocumentBase64()

Gets document_base64

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

getDocumentFields()

Gets document_fields

public getDocumentFields() : array<string|int, NameValue>
Return values
array<string|int, NameValue> —

getDocumentId()

Gets document_id

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

getEncryptedWithKeyManager()

Gets encrypted_with_key_manager

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

getFileExtension()

Gets file_extension

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

getFileFormatHint()

Gets file_format_hint

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

getIncludeInDownload()

Gets include_in_download

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

getIsDocGenDocument()

Gets is_doc_gen_document

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

getMatchBoxes()

Gets match_boxes

public getMatchBoxes() : array<string|int, MatchBox>
Return values
array<string|int, MatchBox> —

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 —

getPages()

Gets pages

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

getPassword()

Gets password

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

getPdfFormFieldOption()

Gets pdf_form_field_option

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

getRemoteUrl()

Gets remote_url

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

getSignerMustAcknowledge()

Gets signer_must_acknowledge

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

getSignerMustAcknowledgeUseAccountDefault()

Gets signer_must_acknowledge_use_account_default

public getSignerMustAcknowledgeUseAccountDefault() : bool|null
Return values
bool|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> —

getTransformPdfFields()

Gets transform_pdf_fields

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

setApplyAnchorTabs()

Sets apply_anchor_tabs

public setApplyAnchorTabs(string|null $apply_anchor_tabs) : $this
Parameters
$apply_anchor_tabs : string|null

Reserved: TBD

Return values
$this —

setAssignTabsToRecipientId()

Sets assign_tabs_to_recipient_id

public setAssignTabsToRecipientId(string|null $assign_tabs_to_recipient_id) : $this
Parameters
$assign_tabs_to_recipient_id : string|null
Return values
$this —

setDisplay()

Sets display

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

The document's bytes. This field can be used to include a base64 version of the document bytes within an envelope definition instead of sending the document using a multi-part HTTP request. The maximum document size is smaller if this field is used due to the overhead of the base64 encoding.

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 —

setEncryptedWithKeyManager()

Sets encrypted_with_key_manager

public setEncryptedWithKeyManager(string|null $encrypted_with_key_manager) : $this
Parameters
$encrypted_with_key_manager : string|null

When set to true, the document is been already encrypted by the sender for use with the DocuSign Key Manager Security Appliance.

Return values
$this —

setFileExtension()

Sets file_extension

public setFileExtension(string|null $file_extension) : $this
Parameters
$file_extension : string|null

The file extension type of the document. If the document is not a PDF it is converted to a PDF.

Return values
$this —

setFileFormatHint()

Sets file_format_hint

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

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 —

setMatchBoxes()

Sets match_boxes

public setMatchBoxes(array<string|int, MatchBox> $match_boxes) : $this
Parameters
$match_boxes : array<string|int, MatchBox>

Matchboxes define areas in a document for document matching when you are creating envelopes. They are only used when you upload and edit a template. A matchbox consists of 5 elements: * pageNumber - The document page number on which the matchbox will appear. * xPosition - The x position of the matchbox on a page. * yPosition - The y position of the matchbox on a page. * width - The width of the matchbox. * height - The height of the matchbox.

Return values
$this —

setName()

Sets name

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

setOrder()

Sets order

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

setPages()

Sets pages

public setPages(string|null $pages) : $this
Parameters
$pages : string|null
Return values
$this —

setPassword()

Sets password

public setPassword(string|null $password) : $this
Parameters
$password : string|null
Return values
$this —

setPdfFormFieldOption()

Sets pdf_form_field_option

public setPdfFormFieldOption(string|null $pdf_form_field_option) : $this
Parameters
$pdf_form_field_option : string|null
Return values
$this —

setRemoteUrl()

Sets remote_url

public setRemoteUrl(string|null $remote_url) : $this
Parameters
$remote_url : string|null

The file id from the cloud storage service where the document is located. This information is returned using [ML:GET /folders] or [ML:/folders/{folderid}].

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 —

setSignerMustAcknowledgeUseAccountDefault()

Sets signer_must_acknowledge_use_account_default

public setSignerMustAcknowledgeUseAccountDefault(bool|null $signer_must_acknowledge_use_account_default) : $this
Parameters
$signer_must_acknowledge_use_account_default : bool|null
Return values
$this —

setTabs()

Sets tabs

public setTabs(Tabs $tabs) : $this
Parameters
$tabs : Tabs

A list of tabs, which are represented graphically as symbols on documents at the time of signing. Tabs show recipients where to sign, initial, or enter data. They may also display data to the recipients.

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

setTransformPdfFields()

Sets transform_pdf_fields

public setTransformPdfFields(string|null $transform_pdf_fields) : $this
Parameters
$transform_pdf_fields : string|null

When set to true, PDF form field data is transformed into document tab values when the PDF form field name matches the DocuSign custom tab tabLabel. The resulting PDF form data is also returned in the PDF meta data when requesting the document PDF. See the [ML:Transform PDF Fields] section for more information about how fields are transformed into DocuSign tabs.

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