Documentation

Text
in package
implements ModelInterface, ArrayAccess

Text Class Doc Comment

Tags
category

Class

description

A tab that allows the recipient to enter any type of text.

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
getAnchorAllowWhiteSpaceInCharacters()  : string|null
Gets anchor_allow_white_space_in_characters
getAnchorAllowWhiteSpaceInCharactersMetadata()  : PropertyMetadata
Gets anchor_allow_white_space_in_characters_metadata
getAnchorCaseSensitive()  : string|null
Gets anchor_case_sensitive
getAnchorCaseSensitiveMetadata()  : PropertyMetadata
Gets anchor_case_sensitive_metadata
getAnchorHorizontalAlignment()  : string|null
Gets anchor_horizontal_alignment
getAnchorHorizontalAlignmentMetadata()  : PropertyMetadata
Gets anchor_horizontal_alignment_metadata
getAnchorIgnoreIfNotPresent()  : string|null
Gets anchor_ignore_if_not_present
getAnchorIgnoreIfNotPresentMetadata()  : PropertyMetadata
Gets anchor_ignore_if_not_present_metadata
getAnchorMatchWholeWord()  : string|null
Gets anchor_match_whole_word
getAnchorMatchWholeWordMetadata()  : PropertyMetadata
Gets anchor_match_whole_word_metadata
getAnchorString()  : string|null
Gets anchor_string
getAnchorStringMetadata()  : PropertyMetadata
Gets anchor_string_metadata
getAnchorTabProcessorVersion()  : string|null
Gets anchor_tab_processor_version
getAnchorTabProcessorVersionMetadata()  : PropertyMetadata
Gets anchor_tab_processor_version_metadata
getAnchorUnits()  : string|null
Gets anchor_units
getAnchorUnitsMetadata()  : PropertyMetadata
Gets anchor_units_metadata
getAnchorXOffset()  : string|null
Gets anchor_x_offset
getAnchorXOffsetMetadata()  : PropertyMetadata
Gets anchor_x_offset_metadata
getAnchorYOffset()  : string|null
Gets anchor_y_offset
getAnchorYOffsetMetadata()  : PropertyMetadata
Gets anchor_y_offset_metadata
getBold()  : string|null
Gets bold
getBoldMetadata()  : PropertyMetadata
Gets bold_metadata
getCaption()  : string|null
Gets caption
getCaptionMetadata()  : PropertyMetadata
Gets caption_metadata
getConcealValueOnDocument()  : string|null
Gets conceal_value_on_document
getConcealValueOnDocumentMetadata()  : PropertyMetadata
Gets conceal_value_on_document_metadata
getConditionalParentLabel()  : string|null
Gets conditional_parent_label
getConditionalParentLabelMetadata()  : PropertyMetadata
Gets conditional_parent_label_metadata
getConditionalParentValue()  : string|null
Gets conditional_parent_value
getConditionalParentValueMetadata()  : PropertyMetadata
Gets conditional_parent_value_metadata
getCustomTabId()  : string|null
Gets custom_tab_id
getCustomTabIdMetadata()  : PropertyMetadata
Gets custom_tab_id_metadata
getDisableAutoSize()  : string|null
Gets disable_auto_size
getDisableAutoSizeMetadata()  : PropertyMetadata
Gets disable_auto_size_metadata
getDocumentId()  : string|null
Gets document_id
getDocumentIdMetadata()  : PropertyMetadata
Gets document_id_metadata
getErrorDetails()  : ErrorDetails
Gets error_details
getFont()  : string|null
Gets font
getFontColor()  : string|null
Gets font_color
getFontColorMetadata()  : PropertyMetadata
Gets font_color_metadata
getFontMetadata()  : PropertyMetadata
Gets font_metadata
getFontSize()  : string|null
Gets font_size
getFontSizeMetadata()  : PropertyMetadata
Gets font_size_metadata
getFormOrder()  : string|null
Gets form_order
getFormOrderMetadata()  : PropertyMetadata
Gets form_order_metadata
getFormPageLabel()  : string|null
Gets form_page_label
getFormPageLabelMetadata()  : PropertyMetadata
Gets form_page_label_metadata
getFormPageNumber()  : string|null
Gets form_page_number
getFormPageNumberMetadata()  : PropertyMetadata
Gets form_page_number_metadata
getFormula()  : string|null
Gets formula
getFormulaMetadata()  : PropertyMetadata
Gets formula_metadata
getHeight()  : string|null
Gets height
getHeightMetadata()  : PropertyMetadata
Gets height_metadata
getIsPaymentAmount()  : string|null
Gets is_payment_amount
getIsPaymentAmountMetadata()  : PropertyMetadata
Gets is_payment_amount_metadata
getItalic()  : string|null
Gets italic
getItalicMetadata()  : PropertyMetadata
Gets italic_metadata
getLocalePolicy()  : LocalePolicyTab
Gets locale_policy
getLocked()  : string|null
Gets locked
getLockedMetadata()  : PropertyMetadata
Gets locked_metadata
getMaxLength()  : string|null
Gets max_length
getMaxLengthMetadata()  : PropertyMetadata
Gets max_length_metadata
getMergeField()  : MergeField
Gets merge_field
getMergeFieldXml()  : string|null
Gets merge_field_xml
getModelName()  : string
The original name of the model.
getName()  : string|null
Gets name
getNameMetadata()  : PropertyMetadata
Gets name_metadata
getOriginalValue()  : string|null
Gets original_value
getOriginalValueMetadata()  : PropertyMetadata
Gets original_value_metadata
getPageNumber()  : string|null
Gets page_number
getPageNumberMetadata()  : PropertyMetadata
Gets page_number_metadata
getRecipientId()  : string|null
Gets recipient_id
getRecipientIdGuid()  : string|null
Gets recipient_id_guid
getRecipientIdGuidMetadata()  : PropertyMetadata
Gets recipient_id_guid_metadata
getRecipientIdMetadata()  : PropertyMetadata
Gets recipient_id_metadata
getRequireAll()  : string|null
Gets require_all
getRequireAllMetadata()  : PropertyMetadata
Gets require_all_metadata
getRequired()  : string|null
Gets required
getRequiredMetadata()  : PropertyMetadata
Gets required_metadata
getRequireInitialOnSharedChange()  : string|null
Gets require_initial_on_shared_change
getRequireInitialOnSharedChangeMetadata()  : PropertyMetadata
Gets require_initial_on_shared_change_metadata
getSenderRequired()  : string|null
Gets sender_required
getSenderRequiredMetadata()  : PropertyMetadata
Gets sender_required_metadata
getShared()  : string|null
Gets shared
getSharedMetadata()  : PropertyMetadata
Gets shared_metadata
getShareToRecipients()  : string|null
Gets share_to_recipients
getShareToRecipientsMetadata()  : PropertyMetadata
Gets share_to_recipients_metadata
getSmartContractInformation()  : SmartContractInformation
Gets smart_contract_information
getSource()  : string|null
Gets source
getStatus()  : string|null
Gets status
getStatusMetadata()  : PropertyMetadata
Gets status_metadata
getTabGroupLabels()  : array<string|int, ?string>
Gets tab_group_labels
getTabGroupLabelsMetadata()  : PropertyMetadata
Gets tab_group_labels_metadata
getTabId()  : string|null
Gets tab_id
getTabIdMetadata()  : PropertyMetadata
Gets tab_id_metadata
getTabLabel()  : string|null
Gets tab_label
getTabLabelMetadata()  : PropertyMetadata
Gets tab_label_metadata
getTabOrder()  : string|null
Gets tab_order
getTabOrderMetadata()  : PropertyMetadata
Gets tab_order_metadata
getTabType()  : string|null
Gets tab_type
getTabTypeMetadata()  : PropertyMetadata
Gets tab_type_metadata
getTemplateLocked()  : string|null
Gets template_locked
getTemplateLockedMetadata()  : PropertyMetadata
Gets template_locked_metadata
getTemplateRequired()  : string|null
Gets template_required
getTemplateRequiredMetadata()  : PropertyMetadata
Gets template_required_metadata
getters()  : array<string|int, mixed>
Array of attributes to getter functions (for serialization of requests)
getTooltip()  : string|null
Gets tooltip
getToolTipMetadata()  : PropertyMetadata
Gets tool_tip_metadata
getUnderline()  : string|null
Gets underline
getUnderlineMetadata()  : PropertyMetadata
Gets underline_metadata
getValidationMessage()  : string|null
Gets validation_message
getValidationMessageMetadata()  : PropertyMetadata
Gets validation_message_metadata
getValidationPattern()  : string|null
Gets validation_pattern
getValidationPatternMetadata()  : PropertyMetadata
Gets validation_pattern_metadata
getValue()  : string|null
Gets value
getValueMetadata()  : PropertyMetadata
Gets value_metadata
getWidth()  : string|null
Gets width
getWidthMetadata()  : PropertyMetadata
Gets width_metadata
getXPosition()  : string|null
Gets x_position
getXPositionMetadata()  : PropertyMetadata
Gets x_position_metadata
getYPosition()  : string|null
Gets y_position
getYPositionMetadata()  : PropertyMetadata
Gets y_position_metadata
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.
setAnchorAllowWhiteSpaceInCharacters()  : $this
Sets anchor_allow_white_space_in_characters
setAnchorAllowWhiteSpaceInCharactersMetadata()  : $this
Sets anchor_allow_white_space_in_characters_metadata
setAnchorCaseSensitive()  : $this
Sets anchor_case_sensitive
setAnchorCaseSensitiveMetadata()  : $this
Sets anchor_case_sensitive_metadata
setAnchorHorizontalAlignment()  : $this
Sets anchor_horizontal_alignment
setAnchorHorizontalAlignmentMetadata()  : $this
Sets anchor_horizontal_alignment_metadata
setAnchorIgnoreIfNotPresent()  : $this
Sets anchor_ignore_if_not_present
setAnchorIgnoreIfNotPresentMetadata()  : $this
Sets anchor_ignore_if_not_present_metadata
setAnchorMatchWholeWord()  : $this
Sets anchor_match_whole_word
setAnchorMatchWholeWordMetadata()  : $this
Sets anchor_match_whole_word_metadata
setAnchorString()  : $this
Sets anchor_string
setAnchorStringMetadata()  : $this
Sets anchor_string_metadata
setAnchorTabProcessorVersion()  : $this
Sets anchor_tab_processor_version
setAnchorTabProcessorVersionMetadata()  : $this
Sets anchor_tab_processor_version_metadata
setAnchorUnits()  : $this
Sets anchor_units
setAnchorUnitsMetadata()  : $this
Sets anchor_units_metadata
setAnchorXOffset()  : $this
Sets anchor_x_offset
setAnchorXOffsetMetadata()  : $this
Sets anchor_x_offset_metadata
setAnchorYOffset()  : $this
Sets anchor_y_offset
setAnchorYOffsetMetadata()  : $this
Sets anchor_y_offset_metadata
setBold()  : $this
Sets bold
setBoldMetadata()  : $this
Sets bold_metadata
setCaption()  : $this
Sets caption
setCaptionMetadata()  : $this
Sets caption_metadata
setConcealValueOnDocument()  : $this
Sets conceal_value_on_document
setConcealValueOnDocumentMetadata()  : $this
Sets conceal_value_on_document_metadata
setConditionalParentLabel()  : $this
Sets conditional_parent_label
setConditionalParentLabelMetadata()  : $this
Sets conditional_parent_label_metadata
setConditionalParentValue()  : $this
Sets conditional_parent_value
setConditionalParentValueMetadata()  : $this
Sets conditional_parent_value_metadata
setCustomTabId()  : $this
Sets custom_tab_id
setCustomTabIdMetadata()  : $this
Sets custom_tab_id_metadata
setDisableAutoSize()  : $this
Sets disable_auto_size
setDisableAutoSizeMetadata()  : $this
Sets disable_auto_size_metadata
setDocumentId()  : $this
Sets document_id
setDocumentIdMetadata()  : $this
Sets document_id_metadata
setErrorDetails()  : $this
Sets error_details
setFont()  : $this
Sets font
setFontColor()  : $this
Sets font_color
setFontColorMetadata()  : $this
Sets font_color_metadata
setFontMetadata()  : $this
Sets font_metadata
setFontSize()  : $this
Sets font_size
setFontSizeMetadata()  : $this
Sets font_size_metadata
setFormOrder()  : $this
Sets form_order
setFormOrderMetadata()  : $this
Sets form_order_metadata
setFormPageLabel()  : $this
Sets form_page_label
setFormPageLabelMetadata()  : $this
Sets form_page_label_metadata
setFormPageNumber()  : $this
Sets form_page_number
setFormPageNumberMetadata()  : $this
Sets form_page_number_metadata
setFormula()  : $this
Sets formula
setFormulaMetadata()  : $this
Sets formula_metadata
setHeight()  : $this
Sets height
setHeightMetadata()  : $this
Sets height_metadata
setIsPaymentAmount()  : $this
Sets is_payment_amount
setIsPaymentAmountMetadata()  : $this
Sets is_payment_amount_metadata
setItalic()  : $this
Sets italic
setItalicMetadata()  : $this
Sets italic_metadata
setLocalePolicy()  : $this
Sets locale_policy
setLocked()  : $this
Sets locked
setLockedMetadata()  : $this
Sets locked_metadata
setMaxLength()  : $this
Sets max_length
setMaxLengthMetadata()  : $this
Sets max_length_metadata
setMergeField()  : $this
Sets merge_field
setMergeFieldXml()  : $this
Sets merge_field_xml
setName()  : $this
Sets name
setNameMetadata()  : $this
Sets name_metadata
setOriginalValue()  : $this
Sets original_value
setOriginalValueMetadata()  : $this
Sets original_value_metadata
setPageNumber()  : $this
Sets page_number
setPageNumberMetadata()  : $this
Sets page_number_metadata
setRecipientId()  : $this
Sets recipient_id
setRecipientIdGuid()  : $this
Sets recipient_id_guid
setRecipientIdGuidMetadata()  : $this
Sets recipient_id_guid_metadata
setRecipientIdMetadata()  : $this
Sets recipient_id_metadata
setRequireAll()  : $this
Sets require_all
setRequireAllMetadata()  : $this
Sets require_all_metadata
setRequired()  : $this
Sets required
setRequiredMetadata()  : $this
Sets required_metadata
setRequireInitialOnSharedChange()  : $this
Sets require_initial_on_shared_change
setRequireInitialOnSharedChangeMetadata()  : $this
Sets require_initial_on_shared_change_metadata
setSenderRequired()  : $this
Sets sender_required
setSenderRequiredMetadata()  : $this
Sets sender_required_metadata
setShared()  : $this
Sets shared
setSharedMetadata()  : $this
Sets shared_metadata
setShareToRecipients()  : $this
Sets share_to_recipients
setShareToRecipientsMetadata()  : $this
Sets share_to_recipients_metadata
setSmartContractInformation()  : $this
Sets smart_contract_information
setSource()  : $this
Sets source
setStatus()  : $this
Sets status
setStatusMetadata()  : $this
Sets status_metadata
setTabGroupLabels()  : $this
Sets tab_group_labels
setTabGroupLabelsMetadata()  : $this
Sets tab_group_labels_metadata
setTabId()  : $this
Sets tab_id
setTabIdMetadata()  : $this
Sets tab_id_metadata
setTabLabel()  : $this
Sets tab_label
setTabLabelMetadata()  : $this
Sets tab_label_metadata
setTabOrder()  : $this
Sets tab_order
setTabOrderMetadata()  : $this
Sets tab_order_metadata
setTabType()  : $this
Sets tab_type
setTabTypeMetadata()  : $this
Sets tab_type_metadata
setTemplateLocked()  : $this
Sets template_locked
setTemplateLockedMetadata()  : $this
Sets template_locked_metadata
setTemplateRequired()  : $this
Sets template_required
setTemplateRequiredMetadata()  : $this
Sets template_required_metadata
setters()  : array<string|int, mixed>
Array of attributes to setter functions (for deserialization of responses)
setTooltip()  : $this
Sets tooltip
setToolTipMetadata()  : $this
Sets tool_tip_metadata
setUnderline()  : $this
Sets underline
setUnderlineMetadata()  : $this
Sets underline_metadata
setValidationMessage()  : $this
Sets validation_message
setValidationMessageMetadata()  : $this
Sets validation_message_metadata
setValidationPattern()  : $this
Sets validation_pattern
setValidationPatternMetadata()  : $this
Sets validation_pattern_metadata
setValue()  : $this
Sets value
setValueMetadata()  : $this
Sets value_metadata
setWidth()  : $this
Sets width
setWidthMetadata()  : $this
Sets width_metadata
setXPosition()  : $this
Sets x_position
setXPositionMetadata()  : $this
Sets x_position_metadata
setYPosition()  : $this
Sets y_position
setYPositionMetadata()  : $this
Sets y_position_metadata
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 = ['anchor_allow_white_space_in_characters' => 'anchorAllowWhiteSpaceInCharacters', 'anchor_allow_white_space_in_characters_metadata' => 'anchorAllowWhiteSpaceInCharactersMetadata', 'anchor_case_sensitive' => 'anchorCaseSensitive', 'anchor_case_sensitive_metadata' => 'anchorCaseSensitiveMetadata', 'anchor_horizontal_alignment' => 'anchorHorizontalAlignment', 'anchor_horizontal_alignment_metadata' => 'anchorHorizontalAlignmentMetadata', 'anchor_ignore_if_not_present' => 'anchorIgnoreIfNotPresent', 'anchor_ignore_if_not_present_metadata' => 'anchorIgnoreIfNotPresentMetadata', 'anchor_match_whole_word' => 'anchorMatchWholeWord', 'anchor_match_whole_word_metadata' => 'anchorMatchWholeWordMetadata', 'anchor_string' => 'anchorString', 'anchor_string_metadata' => 'anchorStringMetadata', 'anchor_tab_processor_version' => 'anchorTabProcessorVersion', 'anchor_tab_processor_version_metadata' => 'anchorTabProcessorVersionMetadata', 'anchor_units' => 'anchorUnits', 'anchor_units_metadata' => 'anchorUnitsMetadata', 'anchor_x_offset' => 'anchorXOffset', 'anchor_x_offset_metadata' => 'anchorXOffsetMetadata', 'anchor_y_offset' => 'anchorYOffset', 'anchor_y_offset_metadata' => 'anchorYOffsetMetadata', 'bold' => 'bold', 'bold_metadata' => 'boldMetadata', 'caption' => 'caption', 'caption_metadata' => 'captionMetadata', 'conceal_value_on_document' => 'concealValueOnDocument', 'conceal_value_on_document_metadata' => 'concealValueOnDocumentMetadata', 'conditional_parent_label' => 'conditionalParentLabel', 'conditional_parent_label_metadata' => 'conditionalParentLabelMetadata', 'conditional_parent_value' => 'conditionalParentValue', 'conditional_parent_value_metadata' => 'conditionalParentValueMetadata', 'custom_tab_id' => 'customTabId', 'custom_tab_id_metadata' => 'customTabIdMetadata', 'disable_auto_size' => 'disableAutoSize', 'disable_auto_size_metadata' => 'disableAutoSizeMetadata', 'document_id' => 'documentId', 'document_id_metadata' => 'documentIdMetadata', 'error_details' => 'errorDetails', 'font' => 'font', 'font_color' => 'fontColor', 'font_color_metadata' => 'fontColorMetadata', 'font_metadata' => 'fontMetadata', 'font_size' => 'fontSize', 'font_size_metadata' => 'fontSizeMetadata', 'form_order' => 'formOrder', 'form_order_metadata' => 'formOrderMetadata', 'form_page_label' => 'formPageLabel', 'form_page_label_metadata' => 'formPageLabelMetadata', 'form_page_number' => 'formPageNumber', 'form_page_number_metadata' => 'formPageNumberMetadata', 'formula' => 'formula', 'formula_metadata' => 'formulaMetadata', 'height' => 'height', 'height_metadata' => 'heightMetadata', 'is_payment_amount' => 'isPaymentAmount', 'is_payment_amount_metadata' => 'isPaymentAmountMetadata', 'italic' => 'italic', 'italic_metadata' => 'italicMetadata', 'locale_policy' => 'localePolicy', 'locked' => 'locked', 'locked_metadata' => 'lockedMetadata', 'max_length' => 'maxLength', 'max_length_metadata' => 'maxLengthMetadata', 'merge_field' => 'mergeField', 'merge_field_xml' => 'mergeFieldXml', 'name' => 'name', 'name_metadata' => 'nameMetadata', 'original_value' => 'originalValue', 'original_value_metadata' => 'originalValueMetadata', 'page_number' => 'pageNumber', 'page_number_metadata' => 'pageNumberMetadata', 'recipient_id' => 'recipientId', 'recipient_id_guid' => 'recipientIdGuid', 'recipient_id_guid_metadata' => 'recipientIdGuidMetadata', 'recipient_id_metadata' => 'recipientIdMetadata', 'require_all' => 'requireAll', 'require_all_metadata' => 'requireAllMetadata', 'required' => 'required', 'required_metadata' => 'requiredMetadata', 'require_initial_on_shared_change' => 'requireInitialOnSharedChange', 'require_initial_on_shared_change_metadata' => 'requireInitialOnSharedChangeMetadata', 'sender_required' => 'senderRequired', 'sender_required_metadata' => 'senderRequiredMetadata', 'shared' => 'shared', 'shared_metadata' => 'sharedMetadata', 'share_to_recipients' => 'shareToRecipients', 'share_to_recipients_metadata' => 'shareToRecipientsMetadata', 'smart_contract_information' => 'smartContractInformation', 'source' => 'source', 'status' => 'status', 'status_metadata' => 'statusMetadata', 'tab_group_labels' => 'tabGroupLabels', 'tab_group_labels_metadata' => 'tabGroupLabelsMetadata', 'tab_id' => 'tabId', 'tab_id_metadata' => 'tabIdMetadata', 'tab_label' => 'tabLabel', 'tab_label_metadata' => 'tabLabelMetadata', 'tab_order' => 'tabOrder', 'tab_order_metadata' => 'tabOrderMetadata', 'tab_type' => 'tabType', 'tab_type_metadata' => 'tabTypeMetadata', 'template_locked' => 'templateLocked', 'template_locked_metadata' => 'templateLockedMetadata', 'template_required' => 'templateRequired', 'template_required_metadata' => 'templateRequiredMetadata', 'tooltip' => 'tooltip', 'tool_tip_metadata' => 'toolTipMetadata', 'underline' => 'underline', 'underline_metadata' => 'underlineMetadata', 'validation_message' => 'validationMessage', 'validation_message_metadata' => 'validationMessageMetadata', 'validation_pattern' => 'validationPattern', 'validation_pattern_metadata' => 'validationPatternMetadata', 'value' => 'value', 'value_metadata' => 'valueMetadata', 'width' => 'width', 'width_metadata' => 'widthMetadata', 'x_position' => 'xPosition', 'x_position_metadata' => 'xPositionMetadata', 'y_position' => 'yPosition', 'y_position_metadata' => 'yPositionMetadata']

$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 = ['anchor_allow_white_space_in_characters' => 'getAnchorAllowWhiteSpaceInCharacters', 'anchor_allow_white_space_in_characters_metadata' => 'getAnchorAllowWhiteSpaceInCharactersMetadata', 'anchor_case_sensitive' => 'getAnchorCaseSensitive', 'anchor_case_sensitive_metadata' => 'getAnchorCaseSensitiveMetadata', 'anchor_horizontal_alignment' => 'getAnchorHorizontalAlignment', 'anchor_horizontal_alignment_metadata' => 'getAnchorHorizontalAlignmentMetadata', 'anchor_ignore_if_not_present' => 'getAnchorIgnoreIfNotPresent', 'anchor_ignore_if_not_present_metadata' => 'getAnchorIgnoreIfNotPresentMetadata', 'anchor_match_whole_word' => 'getAnchorMatchWholeWord', 'anchor_match_whole_word_metadata' => 'getAnchorMatchWholeWordMetadata', 'anchor_string' => 'getAnchorString', 'anchor_string_metadata' => 'getAnchorStringMetadata', 'anchor_tab_processor_version' => 'getAnchorTabProcessorVersion', 'anchor_tab_processor_version_metadata' => 'getAnchorTabProcessorVersionMetadata', 'anchor_units' => 'getAnchorUnits', 'anchor_units_metadata' => 'getAnchorUnitsMetadata', 'anchor_x_offset' => 'getAnchorXOffset', 'anchor_x_offset_metadata' => 'getAnchorXOffsetMetadata', 'anchor_y_offset' => 'getAnchorYOffset', 'anchor_y_offset_metadata' => 'getAnchorYOffsetMetadata', 'bold' => 'getBold', 'bold_metadata' => 'getBoldMetadata', 'caption' => 'getCaption', 'caption_metadata' => 'getCaptionMetadata', 'conceal_value_on_document' => 'getConcealValueOnDocument', 'conceal_value_on_document_metadata' => 'getConcealValueOnDocumentMetadata', 'conditional_parent_label' => 'getConditionalParentLabel', 'conditional_parent_label_metadata' => 'getConditionalParentLabelMetadata', 'conditional_parent_value' => 'getConditionalParentValue', 'conditional_parent_value_metadata' => 'getConditionalParentValueMetadata', 'custom_tab_id' => 'getCustomTabId', 'custom_tab_id_metadata' => 'getCustomTabIdMetadata', 'disable_auto_size' => 'getDisableAutoSize', 'disable_auto_size_metadata' => 'getDisableAutoSizeMetadata', 'document_id' => 'getDocumentId', 'document_id_metadata' => 'getDocumentIdMetadata', 'error_details' => 'getErrorDetails', 'font' => 'getFont', 'font_color' => 'getFontColor', 'font_color_metadata' => 'getFontColorMetadata', 'font_metadata' => 'getFontMetadata', 'font_size' => 'getFontSize', 'font_size_metadata' => 'getFontSizeMetadata', 'form_order' => 'getFormOrder', 'form_order_metadata' => 'getFormOrderMetadata', 'form_page_label' => 'getFormPageLabel', 'form_page_label_metadata' => 'getFormPageLabelMetadata', 'form_page_number' => 'getFormPageNumber', 'form_page_number_metadata' => 'getFormPageNumberMetadata', 'formula' => 'getFormula', 'formula_metadata' => 'getFormulaMetadata', 'height' => 'getHeight', 'height_metadata' => 'getHeightMetadata', 'is_payment_amount' => 'getIsPaymentAmount', 'is_payment_amount_metadata' => 'getIsPaymentAmountMetadata', 'italic' => 'getItalic', 'italic_metadata' => 'getItalicMetadata', 'locale_policy' => 'getLocalePolicy', 'locked' => 'getLocked', 'locked_metadata' => 'getLockedMetadata', 'max_length' => 'getMaxLength', 'max_length_metadata' => 'getMaxLengthMetadata', 'merge_field' => 'getMergeField', 'merge_field_xml' => 'getMergeFieldXml', 'name' => 'getName', 'name_metadata' => 'getNameMetadata', 'original_value' => 'getOriginalValue', 'original_value_metadata' => 'getOriginalValueMetadata', 'page_number' => 'getPageNumber', 'page_number_metadata' => 'getPageNumberMetadata', 'recipient_id' => 'getRecipientId', 'recipient_id_guid' => 'getRecipientIdGuid', 'recipient_id_guid_metadata' => 'getRecipientIdGuidMetadata', 'recipient_id_metadata' => 'getRecipientIdMetadata', 'require_all' => 'getRequireAll', 'require_all_metadata' => 'getRequireAllMetadata', 'required' => 'getRequired', 'required_metadata' => 'getRequiredMetadata', 'require_initial_on_shared_change' => 'getRequireInitialOnSharedChange', 'require_initial_on_shared_change_metadata' => 'getRequireInitialOnSharedChangeMetadata', 'sender_required' => 'getSenderRequired', 'sender_required_metadata' => 'getSenderRequiredMetadata', 'shared' => 'getShared', 'shared_metadata' => 'getSharedMetadata', 'share_to_recipients' => 'getShareToRecipients', 'share_to_recipients_metadata' => 'getShareToRecipientsMetadata', 'smart_contract_information' => 'getSmartContractInformation', 'source' => 'getSource', 'status' => 'getStatus', 'status_metadata' => 'getStatusMetadata', 'tab_group_labels' => 'getTabGroupLabels', 'tab_group_labels_metadata' => 'getTabGroupLabelsMetadata', 'tab_id' => 'getTabId', 'tab_id_metadata' => 'getTabIdMetadata', 'tab_label' => 'getTabLabel', 'tab_label_metadata' => 'getTabLabelMetadata', 'tab_order' => 'getTabOrder', 'tab_order_metadata' => 'getTabOrderMetadata', 'tab_type' => 'getTabType', 'tab_type_metadata' => 'getTabTypeMetadata', 'template_locked' => 'getTemplateLocked', 'template_locked_metadata' => 'getTemplateLockedMetadata', 'template_required' => 'getTemplateRequired', 'template_required_metadata' => 'getTemplateRequiredMetadata', 'tooltip' => 'getTooltip', 'tool_tip_metadata' => 'getToolTipMetadata', 'underline' => 'getUnderline', 'underline_metadata' => 'getUnderlineMetadata', 'validation_message' => 'getValidationMessage', 'validation_message_metadata' => 'getValidationMessageMetadata', 'validation_pattern' => 'getValidationPattern', 'validation_pattern_metadata' => 'getValidationPatternMetadata', 'value' => 'getValue', 'value_metadata' => 'getValueMetadata', 'width' => 'getWidth', 'width_metadata' => 'getWidthMetadata', 'x_position' => 'getXPosition', 'x_position_metadata' => 'getXPositionMetadata', 'y_position' => 'getYPosition', 'y_position_metadata' => 'getYPositionMetadata']

$setters

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

protected static array<string|int, string> $setters = ['anchor_allow_white_space_in_characters' => 'setAnchorAllowWhiteSpaceInCharacters', 'anchor_allow_white_space_in_characters_metadata' => 'setAnchorAllowWhiteSpaceInCharactersMetadata', 'anchor_case_sensitive' => 'setAnchorCaseSensitive', 'anchor_case_sensitive_metadata' => 'setAnchorCaseSensitiveMetadata', 'anchor_horizontal_alignment' => 'setAnchorHorizontalAlignment', 'anchor_horizontal_alignment_metadata' => 'setAnchorHorizontalAlignmentMetadata', 'anchor_ignore_if_not_present' => 'setAnchorIgnoreIfNotPresent', 'anchor_ignore_if_not_present_metadata' => 'setAnchorIgnoreIfNotPresentMetadata', 'anchor_match_whole_word' => 'setAnchorMatchWholeWord', 'anchor_match_whole_word_metadata' => 'setAnchorMatchWholeWordMetadata', 'anchor_string' => 'setAnchorString', 'anchor_string_metadata' => 'setAnchorStringMetadata', 'anchor_tab_processor_version' => 'setAnchorTabProcessorVersion', 'anchor_tab_processor_version_metadata' => 'setAnchorTabProcessorVersionMetadata', 'anchor_units' => 'setAnchorUnits', 'anchor_units_metadata' => 'setAnchorUnitsMetadata', 'anchor_x_offset' => 'setAnchorXOffset', 'anchor_x_offset_metadata' => 'setAnchorXOffsetMetadata', 'anchor_y_offset' => 'setAnchorYOffset', 'anchor_y_offset_metadata' => 'setAnchorYOffsetMetadata', 'bold' => 'setBold', 'bold_metadata' => 'setBoldMetadata', 'caption' => 'setCaption', 'caption_metadata' => 'setCaptionMetadata', 'conceal_value_on_document' => 'setConcealValueOnDocument', 'conceal_value_on_document_metadata' => 'setConcealValueOnDocumentMetadata', 'conditional_parent_label' => 'setConditionalParentLabel', 'conditional_parent_label_metadata' => 'setConditionalParentLabelMetadata', 'conditional_parent_value' => 'setConditionalParentValue', 'conditional_parent_value_metadata' => 'setConditionalParentValueMetadata', 'custom_tab_id' => 'setCustomTabId', 'custom_tab_id_metadata' => 'setCustomTabIdMetadata', 'disable_auto_size' => 'setDisableAutoSize', 'disable_auto_size_metadata' => 'setDisableAutoSizeMetadata', 'document_id' => 'setDocumentId', 'document_id_metadata' => 'setDocumentIdMetadata', 'error_details' => 'setErrorDetails', 'font' => 'setFont', 'font_color' => 'setFontColor', 'font_color_metadata' => 'setFontColorMetadata', 'font_metadata' => 'setFontMetadata', 'font_size' => 'setFontSize', 'font_size_metadata' => 'setFontSizeMetadata', 'form_order' => 'setFormOrder', 'form_order_metadata' => 'setFormOrderMetadata', 'form_page_label' => 'setFormPageLabel', 'form_page_label_metadata' => 'setFormPageLabelMetadata', 'form_page_number' => 'setFormPageNumber', 'form_page_number_metadata' => 'setFormPageNumberMetadata', 'formula' => 'setFormula', 'formula_metadata' => 'setFormulaMetadata', 'height' => 'setHeight', 'height_metadata' => 'setHeightMetadata', 'is_payment_amount' => 'setIsPaymentAmount', 'is_payment_amount_metadata' => 'setIsPaymentAmountMetadata', 'italic' => 'setItalic', 'italic_metadata' => 'setItalicMetadata', 'locale_policy' => 'setLocalePolicy', 'locked' => 'setLocked', 'locked_metadata' => 'setLockedMetadata', 'max_length' => 'setMaxLength', 'max_length_metadata' => 'setMaxLengthMetadata', 'merge_field' => 'setMergeField', 'merge_field_xml' => 'setMergeFieldXml', 'name' => 'setName', 'name_metadata' => 'setNameMetadata', 'original_value' => 'setOriginalValue', 'original_value_metadata' => 'setOriginalValueMetadata', 'page_number' => 'setPageNumber', 'page_number_metadata' => 'setPageNumberMetadata', 'recipient_id' => 'setRecipientId', 'recipient_id_guid' => 'setRecipientIdGuid', 'recipient_id_guid_metadata' => 'setRecipientIdGuidMetadata', 'recipient_id_metadata' => 'setRecipientIdMetadata', 'require_all' => 'setRequireAll', 'require_all_metadata' => 'setRequireAllMetadata', 'required' => 'setRequired', 'required_metadata' => 'setRequiredMetadata', 'require_initial_on_shared_change' => 'setRequireInitialOnSharedChange', 'require_initial_on_shared_change_metadata' => 'setRequireInitialOnSharedChangeMetadata', 'sender_required' => 'setSenderRequired', 'sender_required_metadata' => 'setSenderRequiredMetadata', 'shared' => 'setShared', 'shared_metadata' => 'setSharedMetadata', 'share_to_recipients' => 'setShareToRecipients', 'share_to_recipients_metadata' => 'setShareToRecipientsMetadata', 'smart_contract_information' => 'setSmartContractInformation', 'source' => 'setSource', 'status' => 'setStatus', 'status_metadata' => 'setStatusMetadata', 'tab_group_labels' => 'setTabGroupLabels', 'tab_group_labels_metadata' => 'setTabGroupLabelsMetadata', 'tab_id' => 'setTabId', 'tab_id_metadata' => 'setTabIdMetadata', 'tab_label' => 'setTabLabel', 'tab_label_metadata' => 'setTabLabelMetadata', 'tab_order' => 'setTabOrder', 'tab_order_metadata' => 'setTabOrderMetadata', 'tab_type' => 'setTabType', 'tab_type_metadata' => 'setTabTypeMetadata', 'template_locked' => 'setTemplateLocked', 'template_locked_metadata' => 'setTemplateLockedMetadata', 'template_required' => 'setTemplateRequired', 'template_required_metadata' => 'setTemplateRequiredMetadata', 'tooltip' => 'setTooltip', 'tool_tip_metadata' => 'setToolTipMetadata', 'underline' => 'setUnderline', 'underline_metadata' => 'setUnderlineMetadata', 'validation_message' => 'setValidationMessage', 'validation_message_metadata' => 'setValidationMessageMetadata', 'validation_pattern' => 'setValidationPattern', 'validation_pattern_metadata' => 'setValidationPatternMetadata', 'value' => 'setValue', 'value_metadata' => 'setValueMetadata', 'width' => 'setWidth', 'width_metadata' => 'setWidthMetadata', 'x_position' => 'setXPosition', 'x_position_metadata' => 'setXPositionMetadata', 'y_position' => 'setYPosition', 'y_position_metadata' => 'setYPositionMetadata']

$swaggerFormats

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

protected static array<string|int, string> $swaggerFormats = ['anchor_allow_white_space_in_characters' => null, 'anchor_allow_white_space_in_characters_metadata' => null, 'anchor_case_sensitive' => null, 'anchor_case_sensitive_metadata' => null, 'anchor_horizontal_alignment' => null, 'anchor_horizontal_alignment_metadata' => null, 'anchor_ignore_if_not_present' => null, 'anchor_ignore_if_not_present_metadata' => null, 'anchor_match_whole_word' => null, 'anchor_match_whole_word_metadata' => null, 'anchor_string' => null, 'anchor_string_metadata' => null, 'anchor_tab_processor_version' => null, 'anchor_tab_processor_version_metadata' => null, 'anchor_units' => null, 'anchor_units_metadata' => null, 'anchor_x_offset' => null, 'anchor_x_offset_metadata' => null, 'anchor_y_offset' => null, 'anchor_y_offset_metadata' => null, 'bold' => null, 'bold_metadata' => null, 'caption' => null, 'caption_metadata' => null, 'conceal_value_on_document' => null, 'conceal_value_on_document_metadata' => null, 'conditional_parent_label' => null, 'conditional_parent_label_metadata' => null, 'conditional_parent_value' => null, 'conditional_parent_value_metadata' => null, 'custom_tab_id' => null, 'custom_tab_id_metadata' => null, 'disable_auto_size' => null, 'disable_auto_size_metadata' => null, 'document_id' => null, 'document_id_metadata' => null, 'error_details' => null, 'font' => null, 'font_color' => null, 'font_color_metadata' => null, 'font_metadata' => null, 'font_size' => null, 'font_size_metadata' => null, 'form_order' => null, 'form_order_metadata' => null, 'form_page_label' => null, 'form_page_label_metadata' => null, 'form_page_number' => null, 'form_page_number_metadata' => null, 'formula' => null, 'formula_metadata' => null, 'height' => null, 'height_metadata' => null, 'is_payment_amount' => null, 'is_payment_amount_metadata' => null, 'italic' => null, 'italic_metadata' => null, 'locale_policy' => null, 'locked' => null, 'locked_metadata' => null, 'max_length' => null, 'max_length_metadata' => null, 'merge_field' => null, 'merge_field_xml' => null, 'name' => null, 'name_metadata' => null, 'original_value' => null, 'original_value_metadata' => null, 'page_number' => null, 'page_number_metadata' => null, 'recipient_id' => null, 'recipient_id_guid' => null, 'recipient_id_guid_metadata' => null, 'recipient_id_metadata' => null, 'require_all' => null, 'require_all_metadata' => null, 'required' => null, 'required_metadata' => null, 'require_initial_on_shared_change' => null, 'require_initial_on_shared_change_metadata' => null, 'sender_required' => null, 'sender_required_metadata' => null, 'shared' => null, 'shared_metadata' => null, 'share_to_recipients' => null, 'share_to_recipients_metadata' => null, 'smart_contract_information' => null, 'source' => null, 'status' => null, 'status_metadata' => null, 'tab_group_labels' => null, 'tab_group_labels_metadata' => null, 'tab_id' => null, 'tab_id_metadata' => null, 'tab_label' => null, 'tab_label_metadata' => null, 'tab_order' => null, 'tab_order_metadata' => null, 'tab_type' => null, 'tab_type_metadata' => null, 'template_locked' => null, 'template_locked_metadata' => null, 'template_required' => null, 'template_required_metadata' => null, 'tooltip' => null, 'tool_tip_metadata' => null, 'underline' => null, 'underline_metadata' => null, 'validation_message' => null, 'validation_message_metadata' => null, 'validation_pattern' => null, 'validation_pattern_metadata' => null, 'value' => null, 'value_metadata' => null, 'width' => null, 'width_metadata' => null, 'x_position' => null, 'x_position_metadata' => null, 'y_position' => null, 'y_position_metadata' => null]

$swaggerModelName

The original name of the model.

protected static string $swaggerModelName = 'text'

$swaggerTypes

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

protected static array<string|int, string> $swaggerTypes = ['anchor_allow_white_space_in_characters' => '?string', 'anchor_allow_white_space_in_characters_metadata' => '\\DocuSign\\eSign\\Model\\PropertyMetadata', 'anchor_case_sensitive' => '?string', 'anchor_case_sensitive_metadata' => '\\DocuSign\\eSign\\Model\\PropertyMetadata', 'anchor_horizontal_alignment' => '?string', 'anchor_horizontal_alignment_metadata' => '\\DocuSign\\eSign\\Model\\PropertyMetadata', 'anchor_ignore_if_not_present' => '?string', 'anchor_ignore_if_not_present_metadata' => '\\DocuSign\\eSign\\Model\\PropertyMetadata', 'anchor_match_whole_word' => '?string', 'anchor_match_whole_word_metadata' => '\\DocuSign\\eSign\\Model\\PropertyMetadata', 'anchor_string' => '?string', 'anchor_string_metadata' => '\\DocuSign\\eSign\\Model\\PropertyMetadata', 'anchor_tab_processor_version' => '?string', 'anchor_tab_processor_version_metadata' => '\\DocuSign\\eSign\\Model\\PropertyMetadata', 'anchor_units' => '?string', 'anchor_units_metadata' => '\\DocuSign\\eSign\\Model\\PropertyMetadata', 'anchor_x_offset' => '?string', 'anchor_x_offset_metadata' => '\\DocuSign\\eSign\\Model\\PropertyMetadata', 'anchor_y_offset' => '?string', 'anchor_y_offset_metadata' => '\\DocuSign\\eSign\\Model\\PropertyMetadata', 'bold' => '?string', 'bold_metadata' => '\\DocuSign\\eSign\\Model\\PropertyMetadata', 'caption' => '?string', 'caption_metadata' => '\\DocuSign\\eSign\\Model\\PropertyMetadata', 'conceal_value_on_document' => '?string', 'conceal_value_on_document_metadata' => '\\DocuSign\\eSign\\Model\\PropertyMetadata', 'conditional_parent_label' => '?string', 'conditional_parent_label_metadata' => '\\DocuSign\\eSign\\Model\\PropertyMetadata', 'conditional_parent_value' => '?string', 'conditional_parent_value_metadata' => '\\DocuSign\\eSign\\Model\\PropertyMetadata', 'custom_tab_id' => '?string', 'custom_tab_id_metadata' => '\\DocuSign\\eSign\\Model\\PropertyMetadata', 'disable_auto_size' => '?string', 'disable_auto_size_metadata' => '\\DocuSign\\eSign\\Model\\PropertyMetadata', 'document_id' => '?string', 'document_id_metadata' => '\\DocuSign\\eSign\\Model\\PropertyMetadata', 'error_details' => '\\DocuSign\\eSign\\Model\\ErrorDetails', 'font' => '?string', 'font_color' => '?string', 'font_color_metadata' => '\\DocuSign\\eSign\\Model\\PropertyMetadata', 'font_metadata' => '\\DocuSign\\eSign\\Model\\PropertyMetadata', 'font_size' => '?string', 'font_size_metadata' => '\\DocuSign\\eSign\\Model\\PropertyMetadata', 'form_order' => '?string', 'form_order_metadata' => '\\DocuSign\\eSign\\Model\\PropertyMetadata', 'form_page_label' => '?string', 'form_page_label_metadata' => '\\DocuSign\\eSign\\Model\\PropertyMetadata', 'form_page_number' => '?string', 'form_page_number_metadata' => '\\DocuSign\\eSign\\Model\\PropertyMetadata', 'formula' => '?string', 'formula_metadata' => '\\DocuSign\\eSign\\Model\\PropertyMetadata', 'height' => '?string', 'height_metadata' => '\\DocuSign\\eSign\\Model\\PropertyMetadata', 'is_payment_amount' => '?string', 'is_payment_amount_metadata' => '\\DocuSign\\eSign\\Model\\PropertyMetadata', 'italic' => '?string', 'italic_metadata' => '\\DocuSign\\eSign\\Model\\PropertyMetadata', 'locale_policy' => '\\DocuSign\\eSign\\Model\\LocalePolicyTab', 'locked' => '?string', 'locked_metadata' => '\\DocuSign\\eSign\\Model\\PropertyMetadata', 'max_length' => '?string', 'max_length_metadata' => '\\DocuSign\\eSign\\Model\\PropertyMetadata', 'merge_field' => '\\DocuSign\\eSign\\Model\\MergeField', 'merge_field_xml' => '?string', 'name' => '?string', 'name_metadata' => '\\DocuSign\\eSign\\Model\\PropertyMetadata', 'original_value' => '?string', 'original_value_metadata' => '\\DocuSign\\eSign\\Model\\PropertyMetadata', 'page_number' => '?string', 'page_number_metadata' => '\\DocuSign\\eSign\\Model\\PropertyMetadata', 'recipient_id' => '?string', 'recipient_id_guid' => '?string', 'recipient_id_guid_metadata' => '\\DocuSign\\eSign\\Model\\PropertyMetadata', 'recipient_id_metadata' => '\\DocuSign\\eSign\\Model\\PropertyMetadata', 'require_all' => '?string', 'require_all_metadata' => '\\DocuSign\\eSign\\Model\\PropertyMetadata', 'required' => '?string', 'required_metadata' => '\\DocuSign\\eSign\\Model\\PropertyMetadata', 'require_initial_on_shared_change' => '?string', 'require_initial_on_shared_change_metadata' => '\\DocuSign\\eSign\\Model\\PropertyMetadata', 'sender_required' => '?string', 'sender_required_metadata' => '\\DocuSign\\eSign\\Model\\PropertyMetadata', 'shared' => '?string', 'shared_metadata' => '\\DocuSign\\eSign\\Model\\PropertyMetadata', 'share_to_recipients' => '?string', 'share_to_recipients_metadata' => '\\DocuSign\\eSign\\Model\\PropertyMetadata', 'smart_contract_information' => '\\DocuSign\\eSign\\Model\\SmartContractInformation', 'source' => '?string', 'status' => '?string', 'status_metadata' => '\\DocuSign\\eSign\\Model\\PropertyMetadata', 'tab_group_labels' => '?string[]', 'tab_group_labels_metadata' => '\\DocuSign\\eSign\\Model\\PropertyMetadata', 'tab_id' => '?string', 'tab_id_metadata' => '\\DocuSign\\eSign\\Model\\PropertyMetadata', 'tab_label' => '?string', 'tab_label_metadata' => '\\DocuSign\\eSign\\Model\\PropertyMetadata', 'tab_order' => '?string', 'tab_order_metadata' => '\\DocuSign\\eSign\\Model\\PropertyMetadata', 'tab_type' => '?string', 'tab_type_metadata' => '\\DocuSign\\eSign\\Model\\PropertyMetadata', 'template_locked' => '?string', 'template_locked_metadata' => '\\DocuSign\\eSign\\Model\\PropertyMetadata', 'template_required' => '?string', 'template_required_metadata' => '\\DocuSign\\eSign\\Model\\PropertyMetadata', 'tooltip' => '?string', 'tool_tip_metadata' => '\\DocuSign\\eSign\\Model\\PropertyMetadata', 'underline' => '?string', 'underline_metadata' => '\\DocuSign\\eSign\\Model\\PropertyMetadata', 'validation_message' => '?string', 'validation_message_metadata' => '\\DocuSign\\eSign\\Model\\PropertyMetadata', 'validation_pattern' => '?string', 'validation_pattern_metadata' => '\\DocuSign\\eSign\\Model\\PropertyMetadata', 'value' => '?string', 'value_metadata' => '\\DocuSign\\eSign\\Model\\PropertyMetadata', 'width' => '?string', 'width_metadata' => '\\DocuSign\\eSign\\Model\\PropertyMetadata', 'x_position' => '?string', 'x_position_metadata' => '\\DocuSign\\eSign\\Model\\PropertyMetadata', 'y_position' => '?string', 'y_position_metadata' => '\\DocuSign\\eSign\\Model\\PropertyMetadata']

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>

getAnchorAllowWhiteSpaceInCharacters()

Gets anchor_allow_white_space_in_characters

public getAnchorAllowWhiteSpaceInCharacters() : string|null
Return values
string|null

getAnchorAllowWhiteSpaceInCharactersMetadata()

Gets anchor_allow_white_space_in_characters_metadata

public getAnchorAllowWhiteSpaceInCharactersMetadata() : PropertyMetadata
Return values
PropertyMetadata

getAnchorCaseSensitive()

Gets anchor_case_sensitive

public getAnchorCaseSensitive() : string|null
Return values
string|null

getAnchorHorizontalAlignment()

Gets anchor_horizontal_alignment

public getAnchorHorizontalAlignment() : string|null
Return values
string|null

getAnchorIgnoreIfNotPresent()

Gets anchor_ignore_if_not_present

public getAnchorIgnoreIfNotPresent() : string|null
Return values
string|null

getAnchorMatchWholeWord()

Gets anchor_match_whole_word

public getAnchorMatchWholeWord() : string|null
Return values
string|null

getAnchorString()

Gets anchor_string

public getAnchorString() : string|null
Return values
string|null

getAnchorTabProcessorVersion()

Gets anchor_tab_processor_version

public getAnchorTabProcessorVersion() : string|null
Return values
string|null

getAnchorUnits()

Gets anchor_units

public getAnchorUnits() : string|null
Return values
string|null

getAnchorXOffset()

Gets anchor_x_offset

public getAnchorXOffset() : string|null
Return values
string|null

getAnchorYOffset()

Gets anchor_y_offset

public getAnchorYOffset() : string|null
Return values
string|null

getBold()

Gets bold

public getBold() : string|null
Return values
string|null

getCaption()

Gets caption

public getCaption() : string|null
Return values
string|null

getConcealValueOnDocument()

Gets conceal_value_on_document

public getConcealValueOnDocument() : string|null
Return values
string|null

getConditionalParentLabel()

Gets conditional_parent_label

public getConditionalParentLabel() : string|null
Return values
string|null

getConditionalParentValue()

Gets conditional_parent_value

public getConditionalParentValue() : string|null
Return values
string|null

getCustomTabId()

Gets custom_tab_id

public getCustomTabId() : string|null
Return values
string|null

getDisableAutoSize()

Gets disable_auto_size

public getDisableAutoSize() : string|null
Return values
string|null

getDocumentId()

Gets document_id

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

getFont()

Gets font

public getFont() : string|null
Return values
string|null

getFontColor()

Gets font_color

public getFontColor() : string|null
Return values
string|null

getFontSize()

Gets font_size

public getFontSize() : string|null
Return values
string|null

getFormOrder()

Gets form_order

public getFormOrder() : string|null
Return values
string|null

getFormPageLabel()

Gets form_page_label

public getFormPageLabel() : string|null
Return values
string|null

getFormPageNumber()

Gets form_page_number

public getFormPageNumber() : string|null
Return values
string|null

getFormula()

Gets formula

public getFormula() : string|null
Return values
string|null

getHeight()

Gets height

public getHeight() : string|null
Return values
string|null

getIsPaymentAmount()

Gets is_payment_amount

public getIsPaymentAmount() : string|null
Return values
string|null

getItalic()

Gets italic

public getItalic() : string|null
Return values
string|null

getLocked()

Gets locked

public getLocked() : string|null
Return values
string|null

getMaxLength()

Gets max_length

public getMaxLength() : string|null
Return values
string|null

getMergeFieldXml()

Gets merge_field_xml

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

getOriginalValue()

Gets original_value

public getOriginalValue() : string|null
Return values
string|null

getPageNumber()

Gets page_number

public getPageNumber() : string|null
Return values
string|null

getRecipientId()

Gets recipient_id

public getRecipientId() : string|null
Return values
string|null

getRecipientIdGuid()

Gets recipient_id_guid

public getRecipientIdGuid() : string|null
Return values
string|null

getRequireAll()

Gets require_all

public getRequireAll() : string|null
Return values
string|null

getRequired()

Gets required

public getRequired() : string|null
Return values
string|null

getRequireInitialOnSharedChange()

Gets require_initial_on_shared_change

public getRequireInitialOnSharedChange() : string|null
Return values
string|null

getRequireInitialOnSharedChangeMetadata()

Gets require_initial_on_shared_change_metadata

public getRequireInitialOnSharedChangeMetadata() : PropertyMetadata
Return values
PropertyMetadata

getSenderRequired()

Gets sender_required

public getSenderRequired() : string|null
Return values
string|null

getShared()

Gets shared

public getShared() : string|null
Return values
string|null

getShareToRecipients()

Gets share_to_recipients

public getShareToRecipients() : string|null
Return values
string|null

getSource()

Gets source

public getSource() : string|null
Return values
string|null

getStatus()

Gets status

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

getTabGroupLabels()

Gets tab_group_labels

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

getTabId()

Gets tab_id

public getTabId() : string|null
Return values
string|null

getTabLabel()

Gets tab_label

public getTabLabel() : string|null
Return values
string|null

getTabOrder()

Gets tab_order

public getTabOrder() : string|null
Return values
string|null

getTabType()

Gets tab_type

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

getTooltip()

Gets tooltip

public getTooltip() : string|null
Return values
string|null

getUnderline()

Gets underline

public getUnderline() : string|null
Return values
string|null

getValidationMessage()

Gets validation_message

public getValidationMessage() : string|null
Return values
string|null

getValidationPattern()

Gets validation_pattern

public getValidationPattern() : string|null
Return values
string|null

getValue()

Gets value

public getValue() : string|null
Return values
string|null

getWidth()

Gets width

public getWidth() : string|null
Return values
string|null

getXPosition()

Gets x_position

public getXPosition() : string|null
Return values
string|null

getYPosition()

Gets y_position

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

setAnchorAllowWhiteSpaceInCharacters()

Sets anchor_allow_white_space_in_characters

public setAnchorAllowWhiteSpaceInCharacters(string|null $anchor_allow_white_space_in_characters) : $this
Parameters
$anchor_allow_white_space_in_characters : string|null
Return values
$this

setAnchorAllowWhiteSpaceInCharactersMetadata()

Sets anchor_allow_white_space_in_characters_metadata

public setAnchorAllowWhiteSpaceInCharactersMetadata(PropertyMetadata $anchor_allow_white_space_in_characters_metadata) : $this
Parameters
$anchor_allow_white_space_in_characters_metadata : PropertyMetadata

Metadata that indicates whether the anchorAllowWhiteSpaceInCharacters property is editable.

Return values
$this

setAnchorCaseSensitive()

Sets anchor_case_sensitive

public setAnchorCaseSensitive(string|null $anchor_case_sensitive) : $this
Parameters
$anchor_case_sensitive : string|null

When set to true, the anchor string does not consider case when matching strings in the document. The default value is true.

Return values
$this

setAnchorCaseSensitiveMetadata()

Sets anchor_case_sensitive_metadata

public setAnchorCaseSensitiveMetadata(PropertyMetadata $anchor_case_sensitive_metadata) : $this
Parameters
$anchor_case_sensitive_metadata : PropertyMetadata

Metadata that indicates whether the anchorCaseSensitive property is editable.

Return values
$this

setAnchorHorizontalAlignment()

Sets anchor_horizontal_alignment

public setAnchorHorizontalAlignment(string|null $anchor_horizontal_alignment) : $this
Parameters
$anchor_horizontal_alignment : string|null

Specifies the alignment of anchor tabs with anchor strings. Possible values are left or right. The default value is left.

Return values
$this

setAnchorHorizontalAlignmentMetadata()

Sets anchor_horizontal_alignment_metadata

public setAnchorHorizontalAlignmentMetadata(PropertyMetadata $anchor_horizontal_alignment_metadata) : $this
Parameters
$anchor_horizontal_alignment_metadata : PropertyMetadata

Metadata that indicates whether the anchorHorizontalAlignment property is editable.

Return values
$this

setAnchorIgnoreIfNotPresent()

Sets anchor_ignore_if_not_present

public setAnchorIgnoreIfNotPresent(string|null $anchor_ignore_if_not_present) : $this
Parameters
$anchor_ignore_if_not_present : string|null

When set to true, this tab is ignored if anchorString is not found in the document.

Return values
$this

setAnchorIgnoreIfNotPresentMetadata()

Sets anchor_ignore_if_not_present_metadata

public setAnchorIgnoreIfNotPresentMetadata(PropertyMetadata $anchor_ignore_if_not_present_metadata) : $this
Parameters
$anchor_ignore_if_not_present_metadata : PropertyMetadata

Metadata that indicates whether the anchorIgnoreIfNotPresent property is editable.

Return values
$this

setAnchorMatchWholeWord()

Sets anchor_match_whole_word

public setAnchorMatchWholeWord(string|null $anchor_match_whole_word) : $this
Parameters
$anchor_match_whole_word : string|null

When set to true, the anchor string in this tab matches whole words only (strings embedded in other strings are ignored.) The default value is true.

Return values
$this

setAnchorMatchWholeWordMetadata()

Sets anchor_match_whole_word_metadata

public setAnchorMatchWholeWordMetadata(PropertyMetadata $anchor_match_whole_word_metadata) : $this
Parameters
$anchor_match_whole_word_metadata : PropertyMetadata

Metadata that indicates whether the anchorMatchWholeWord property is editable.

Return values
$this

setAnchorString()

Sets anchor_string

public setAnchorString(string|null $anchor_string) : $this
Parameters
$anchor_string : string|null

Anchor text information for a radio button.

Return values
$this

setAnchorStringMetadata()

Sets anchor_string_metadata

public setAnchorStringMetadata(PropertyMetadata $anchor_string_metadata) : $this
Parameters
$anchor_string_metadata : PropertyMetadata

Metadata that indicates whether the anchorString property is editable.

Return values
$this

setAnchorTabProcessorVersion()

Sets anchor_tab_processor_version

public setAnchorTabProcessorVersion(string|null $anchor_tab_processor_version) : $this
Parameters
$anchor_tab_processor_version : string|null
Return values
$this

setAnchorTabProcessorVersionMetadata()

Sets anchor_tab_processor_version_metadata

public setAnchorTabProcessorVersionMetadata(PropertyMetadata $anchor_tab_processor_version_metadata) : $this
Parameters
$anchor_tab_processor_version_metadata : PropertyMetadata

Reserved for DocuSign.

Return values
$this

setAnchorUnits()

Sets anchor_units

public setAnchorUnits(string|null $anchor_units) : $this
Parameters
$anchor_units : string|null

Specifies units of the X and Y offset. Units could be pixels, millimeters, centimeters, or inches.

Return values
$this

setAnchorUnitsMetadata()

Sets anchor_units_metadata

public setAnchorUnitsMetadata(PropertyMetadata $anchor_units_metadata) : $this
Parameters
$anchor_units_metadata : PropertyMetadata

Metadata that indicates whether the anchorUnits property is editable.

Return values
$this

setAnchorXOffset()

Sets anchor_x_offset

public setAnchorXOffset(string|null $anchor_x_offset) : $this
Parameters
$anchor_x_offset : string|null

Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString.

Return values
$this

setAnchorXOffsetMetadata()

Sets anchor_x_offset_metadata

public setAnchorXOffsetMetadata(PropertyMetadata $anchor_x_offset_metadata) : $this
Parameters
$anchor_x_offset_metadata : PropertyMetadata

Metadata that indicates whether the anchorXOffset property is editable.

Return values
$this

setAnchorYOffset()

Sets anchor_y_offset

public setAnchorYOffset(string|null $anchor_y_offset) : $this
Parameters
$anchor_y_offset : string|null

Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString.

Return values
$this

setAnchorYOffsetMetadata()

Sets anchor_y_offset_metadata

public setAnchorYOffsetMetadata(PropertyMetadata $anchor_y_offset_metadata) : $this
Parameters
$anchor_y_offset_metadata : PropertyMetadata

Metadata that indicates whether the anchorYOffset property is editable.

Return values
$this

setBold()

Sets bold

public setBold(string|null $bold) : $this
Parameters
$bold : string|null

When set to true, the information in the tab is bold.

Return values
$this

setBoldMetadata()

Sets bold_metadata

public setBoldMetadata(PropertyMetadata $bold_metadata) : $this
Parameters
$bold_metadata : PropertyMetadata

Metadata that indicates whether the bold property is editable.

Return values
$this

setCaption()

Sets caption

public setCaption(string|null $caption) : $this
Parameters
$caption : string|null
Return values
$this

setCaptionMetadata()

Sets caption_metadata

public setCaptionMetadata(PropertyMetadata $caption_metadata) : $this
Parameters
$caption_metadata : PropertyMetadata
Return values
$this

setConcealValueOnDocument()

Sets conceal_value_on_document

public setConcealValueOnDocument(string|null $conceal_value_on_document) : $this
Parameters
$conceal_value_on_document : string|null

When set to true, the field appears normally while the recipient is adding or modifying the information in the field, but the data is not visible (the characters are hidden by asterisks) to any other signer or the sender. When an envelope is completed the information is available to the sender through the Form Data link in the DocuSign Console. This setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes.

Return values
$this

setConcealValueOnDocumentMetadata()

Sets conceal_value_on_document_metadata

public setConcealValueOnDocumentMetadata(PropertyMetadata $conceal_value_on_document_metadata) : $this
Parameters
$conceal_value_on_document_metadata : PropertyMetadata

Metadata that indicates whether the concealValueOnDocument property is editable.

Return values
$this

setConditionalParentLabel()

Sets conditional_parent_label

public setConditionalParentLabel(string|null $conditional_parent_label) : $this
Parameters
$conditional_parent_label : string|null

For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.

Return values
$this

setConditionalParentLabelMetadata()

Sets conditional_parent_label_metadata

public setConditionalParentLabelMetadata(PropertyMetadata $conditional_parent_label_metadata) : $this
Parameters
$conditional_parent_label_metadata : PropertyMetadata

Metadata that indicates whether the conditionalParentLabel property is editable.

Return values
$this

setConditionalParentValue()

Sets conditional_parent_value

public setConditionalParentValue(string|null $conditional_parent_value) : $this
Parameters
$conditional_parent_value : string|null

For conditional fields, this is the value of the parent tab that controls the tab's visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use "on" as the value to show that the parent tab is active.

Return values
$this

setConditionalParentValueMetadata()

Sets conditional_parent_value_metadata

public setConditionalParentValueMetadata(PropertyMetadata $conditional_parent_value_metadata) : $this
Parameters
$conditional_parent_value_metadata : PropertyMetadata

Metadata that indicates whether the conditionalParentValue property is editable.

Return values
$this

setCustomTabId()

Sets custom_tab_id

public setCustomTabId(string|null $custom_tab_id) : $this
Parameters
$custom_tab_id : string|null

The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties.

Return values
$this

setCustomTabIdMetadata()

Sets custom_tab_id_metadata

public setCustomTabIdMetadata(PropertyMetadata $custom_tab_id_metadata) : $this
Parameters
$custom_tab_id_metadata : PropertyMetadata

Metadata that indicates whether the customTabId property is editable.

Return values
$this

setDisableAutoSize()

Sets disable_auto_size

public setDisableAutoSize(string|null $disable_auto_size) : $this
Parameters
$disable_auto_size : string|null

When set to true, disables the auto sizing of single line text boxes in the signing screen when the signer enters data. If disabled users will only be able enter as much data as the text box can hold. By default this is false. This property only affects single line text boxes.

Return values
$this

setDisableAutoSizeMetadata()

Sets disable_auto_size_metadata

public setDisableAutoSizeMetadata(PropertyMetadata $disable_auto_size_metadata) : $this
Parameters
$disable_auto_size_metadata : PropertyMetadata

Metadata that indicates whether the disableAutoSize property is editable.

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

setDocumentIdMetadata()

Sets document_id_metadata

public setDocumentIdMetadata(PropertyMetadata $document_id_metadata) : $this
Parameters
$document_id_metadata : PropertyMetadata

Metadata that indicates whether the documentId property is editable.

Return values
$this

setErrorDetails()

Sets error_details

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

Array or errors.

Return values
$this

setFont()

Sets font

public setFont(string|null $font) : $this
Parameters
$font : string|null

The font to be used for the tab value. Supported Fonts: Arial, Arial, ArialNarrow, Calibri, CourierNew, Garamond, Georgia, Helvetica, LucidaConsole, Tahoma, TimesNewRoman, Trebuchet, Verdana, MSGothic, MSMincho, Default.

Return values
$this

setFontColor()

Sets font_color

public setFontColor(string|null $font_color) : $this
Parameters
$font_color : string|null

The font color used for the information in the tab. Possible values are: Black, BrightBlue, BrightRed, DarkGreen, DarkRed, Gold, Green, NavyBlue, Purple, or White.

Return values
$this

setFontColorMetadata()

Sets font_color_metadata

public setFontColorMetadata(PropertyMetadata $font_color_metadata) : $this
Parameters
$font_color_metadata : PropertyMetadata

Metadata that indicates whether the fontColor property is editable.

Return values
$this

setFontMetadata()

Sets font_metadata

public setFontMetadata(PropertyMetadata $font_metadata) : $this
Parameters
$font_metadata : PropertyMetadata

Metadata that indicates whether the font property is editable.

Return values
$this

setFontSize()

Sets font_size

public setFontSize(string|null $font_size) : $this
Parameters
$font_size : string|null

The font size used for the information in the tab. Possible values are: Size7, Size8, Size9, Size10, Size11, Size12, Size14, Size16, Size18, Size20, Size22, Size24, Size26, Size28, Size36, Size48, or Size72.

Return values
$this

setFontSizeMetadata()

Sets font_size_metadata

public setFontSizeMetadata(PropertyMetadata $font_size_metadata) : $this
Parameters
$font_size_metadata : PropertyMetadata

Metadata that indicates whether the fontSize property is editable.

Return values
$this

setFormOrder()

Sets form_order

public setFormOrder(string|null $form_order) : $this
Parameters
$form_order : string|null
Return values
$this

setFormOrderMetadata()

Sets form_order_metadata

public setFormOrderMetadata(PropertyMetadata $form_order_metadata) : $this
Parameters
$form_order_metadata : PropertyMetadata

Metadata that indicates whether the formOrder property is editable.

Return values
$this

setFormPageLabel()

Sets form_page_label

public setFormPageLabel(string|null $form_page_label) : $this
Parameters
$form_page_label : string|null
Return values
$this

setFormPageLabelMetadata()

Sets form_page_label_metadata

public setFormPageLabelMetadata(PropertyMetadata $form_page_label_metadata) : $this
Parameters
$form_page_label_metadata : PropertyMetadata

Metadata that indicates whether the formPageLabel property is editable.

Return values
$this

setFormPageNumber()

Sets form_page_number

public setFormPageNumber(string|null $form_page_number) : $this
Parameters
$form_page_number : string|null
Return values
$this

setFormPageNumberMetadata()

Sets form_page_number_metadata

public setFormPageNumberMetadata(PropertyMetadata $form_page_number_metadata) : $this
Parameters
$form_page_number_metadata : PropertyMetadata

Metadata that indicates whether the fromPageNumber property is editable.

Return values
$this

setFormula()

Sets formula

public setFormula(string|null $formula) : $this
Parameters
$formula : string|null

The Formula string contains the TabLabel for the reference tabs used in the formula and calculation operators. Each TabLabel must be contained in brackets. Maximum Length: 2000 characters. Example: Three tabs (TabLabels: Line1, Line2, and Tax) need to be added together. The formula string would be: [Line1]+[Line2]+[Tax]

Return values
$this

setFormulaMetadata()

Sets formula_metadata

public setFormulaMetadata(PropertyMetadata $formula_metadata) : $this
Parameters
$formula_metadata : PropertyMetadata

Metadata indicating if the sender can edit the formula property.

Return values
$this

setHeight()

Sets height

public setHeight(string|null $height) : $this
Parameters
$height : string|null

Height of the tab in pixels.

Return values
$this

setHeightMetadata()

Sets height_metadata

public setHeightMetadata(PropertyMetadata $height_metadata) : $this
Parameters
$height_metadata : PropertyMetadata

Metadata that indicates whether the height property is editable.

Return values
$this

setIsPaymentAmount()

Sets is_payment_amount

public setIsPaymentAmount(string|null $is_payment_amount) : $this
Parameters
$is_payment_amount : string|null

When set to true, sets this as a payment tab. Can only be used with Text, Number, Formula, or List tabs. The value of the tab must be a number.

Return values
$this

setIsPaymentAmountMetadata()

Sets is_payment_amount_metadata

public setIsPaymentAmountMetadata(PropertyMetadata $is_payment_amount_metadata) : $this
Parameters
$is_payment_amount_metadata : PropertyMetadata

Reserved for DocuSign.

Return values
$this

setItalic()

Sets italic

public setItalic(string|null $italic) : $this
Parameters
$italic : string|null

When set to true, the information in the tab is italic.

Return values
$this

setItalicMetadata()

Sets italic_metadata

public setItalicMetadata(PropertyMetadata $italic_metadata) : $this
Parameters
$italic_metadata : PropertyMetadata

Metadata that indicates whether the italic property is editable.

Return values
$this

setLocalePolicy()

Sets locale_policy

public setLocalePolicy(LocalePolicyTab $locale_policy) : $this
Parameters
$locale_policy : LocalePolicyTab

Reserved for DocuSign.

Return values
$this

setLocked()

Sets locked

public setLocked(string|null $locked) : $this
Parameters
$locked : string|null

When set to true, the signer cannot change the data of the custom tab.

Return values
$this

setLockedMetadata()

Sets locked_metadata

public setLockedMetadata(PropertyMetadata $locked_metadata) : $this
Parameters
$locked_metadata : PropertyMetadata

Metadata that indicates whether the locked property is editable.

Return values
$this

setMaxLength()

Sets max_length

public setMaxLength(string|null $max_length) : $this
Parameters
$max_length : string|null

An optional value that describes the maximum length of the property when the property is a string.

Return values
$this

setMaxLengthMetadata()

Sets max_length_metadata

public setMaxLengthMetadata(PropertyMetadata $max_length_metadata) : $this
Parameters
$max_length_metadata : PropertyMetadata

Metadata that indicates whether the maxLength property is editable.

Return values
$this

setMergeField()

Sets merge_field

public setMergeField(MergeField $merge_field) : $this
Parameters
$merge_field : MergeField

Contains the information necessary to map the tab to a field in SalesForce.

Return values
$this

setMergeFieldXml()

Sets merge_field_xml

public setMergeFieldXml(string|null $merge_field_xml) : $this
Parameters
$merge_field_xml : string|null
Return values
$this

setName()

Sets name

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

Specifies the tool tip text for the tab.

Return values
$this

setNameMetadata()

Sets name_metadata

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

Metadata that indicates whether the name property is editable. This property is read-only.

Return values
$this

setOriginalValue()

Sets original_value

public setOriginalValue(string|null $original_value) : $this
Parameters
$original_value : string|null

The initial value of the tab when it was sent to the recipient.

Return values
$this

setOriginalValueMetadata()

Sets original_value_metadata

public setOriginalValueMetadata(PropertyMetadata $original_value_metadata) : $this
Parameters
$original_value_metadata : PropertyMetadata

Metadata that indicates whether the originalValue property is editable.

Return values
$this

setPageNumber()

Sets page_number

public setPageNumber(string|null $page_number) : $this
Parameters
$page_number : string|null

Specifies the page number on which the tab is located.

Return values
$this

setPageNumberMetadata()

Sets page_number_metadata

public setPageNumberMetadata(PropertyMetadata $page_number_metadata) : $this
Parameters
$page_number_metadata : PropertyMetadata

Metadata that indicates whether the pageNumber property is editable.

Return values
$this

setRecipientId()

Sets recipient_id

public setRecipientId(string|null $recipient_id) : $this
Parameters
$recipient_id : string|null

Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.

Return values
$this

setRecipientIdGuid()

Sets recipient_id_guid

public setRecipientIdGuid(string|null $recipient_id_guid) : $this
Parameters
$recipient_id_guid : string|null
Return values
$this

setRecipientIdGuidMetadata()

Sets recipient_id_guid_metadata

public setRecipientIdGuidMetadata(PropertyMetadata $recipient_id_guid_metadata) : $this
Parameters
$recipient_id_guid_metadata : PropertyMetadata

Metadata that indicates whether the recipientIdGuid property is editable.

Return values
$this

setRecipientIdMetadata()

Sets recipient_id_metadata

public setRecipientIdMetadata(PropertyMetadata $recipient_id_metadata) : $this
Parameters
$recipient_id_metadata : PropertyMetadata

Metadata that indicates whether the recipientId property is editable.

Return values
$this

setRequireAll()

Sets require_all

public setRequireAll(string|null $require_all) : $this
Parameters
$require_all : string|null

When set to true and shared is true, information must be entered in this field to complete the envelope.

Return values
$this

setRequireAllMetadata()

Sets require_all_metadata

public setRequireAllMetadata(PropertyMetadata $require_all_metadata) : $this
Parameters
$require_all_metadata : PropertyMetadata

Metadata that indicates whether the requireAll property is editable.

Return values
$this

setRequired()

Sets required

public setRequired(string|null $required) : $this
Parameters
$required : string|null

When set to true, the signer is required to fill out this tab

Return values
$this

setRequiredMetadata()

Sets required_metadata

public setRequiredMetadata(PropertyMetadata $required_metadata) : $this
Parameters
$required_metadata : PropertyMetadata

Metadata that indicates whether the required property is editable.

Return values
$this

setRequireInitialOnSharedChange()

Sets require_initial_on_shared_change

public setRequireInitialOnSharedChange(string|null $require_initial_on_shared_change) : $this
Parameters
$require_initial_on_shared_change : string|null

Optional element for field markup. When set to true, the signer is required to initial when they modify a shared field.

Return values
$this

setRequireInitialOnSharedChangeMetadata()

Sets require_initial_on_shared_change_metadata

public setRequireInitialOnSharedChangeMetadata(PropertyMetadata $require_initial_on_shared_change_metadata) : $this
Parameters
$require_initial_on_shared_change_metadata : PropertyMetadata

Metadata that indicates whether the requireInitialOnSharedChange property is editable.

Return values
$this

setSenderRequired()

Sets sender_required

public setSenderRequired(string|null $sender_required) : $this
Parameters
$sender_required : string|null

When set to true, the sender must populate the tab before an envelope can be sent using the template. This value tab can only be changed by modifying (PUT) the template. Tabs with a senderRequired value of true cannot be deleted from an envelope.

Return values
$this

setSenderRequiredMetadata()

Sets sender_required_metadata

public setSenderRequiredMetadata(PropertyMetadata $sender_required_metadata) : $this
Parameters
$sender_required_metadata : PropertyMetadata

Metadata that indicates whether the senderRequired property is editable.

Return values
$this

setShared()

Sets shared

public setShared(string|null $shared) : $this
Parameters
$shared : string|null

When set to true, this custom tab is shared.

Return values
$this

setSharedMetadata()

Sets shared_metadata

public setSharedMetadata(PropertyMetadata $shared_metadata) : $this
Parameters
$shared_metadata : PropertyMetadata

Metadata that indicates whether the shared property is editable.

Return values
$this

setShareToRecipients()

Sets share_to_recipients

public setShareToRecipients(string|null $share_to_recipients) : $this
Parameters
$share_to_recipients : string|null
Return values
$this

setShareToRecipientsMetadata()

Sets share_to_recipients_metadata

public setShareToRecipientsMetadata(PropertyMetadata $share_to_recipients_metadata) : $this
Parameters
$share_to_recipients_metadata : PropertyMetadata

Reserved for DocuSign.

Return values
$this

setSmartContractInformation()

Sets smart_contract_information

public setSmartContractInformation(SmartContractInformation $smart_contract_information) : $this
Parameters
$smart_contract_information : SmartContractInformation

Reserved for DocuSign.

Return values
$this

setSource()

Sets source

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

setStatusMetadata()

Sets status_metadata

public setStatusMetadata(PropertyMetadata $status_metadata) : $this
Parameters
$status_metadata : PropertyMetadata

Metadata that indicates whether the status property is editable.

Return values
$this

setTabGroupLabels()

Sets tab_group_labels

public setTabGroupLabels(array<string|int, ?string> $tab_group_labels) : $this
Parameters
$tab_group_labels : array<string|int, ?string>
Return values
$this

setTabGroupLabelsMetadata()

Sets tab_group_labels_metadata

public setTabGroupLabelsMetadata(PropertyMetadata $tab_group_labels_metadata) : $this
Parameters
$tab_group_labels_metadata : PropertyMetadata

Metadata that indicates whether the tabGroupLabels property is editable.

Return values
$this

setTabId()

Sets tab_id

public setTabId(string|null $tab_id) : $this
Parameters
$tab_id : string|null

The unique identifier for the tab. The tabid can be retrieved with the [ML:GET call].

Return values
$this

setTabIdMetadata()

Sets tab_id_metadata

public setTabIdMetadata(PropertyMetadata $tab_id_metadata) : $this
Parameters
$tab_id_metadata : PropertyMetadata

Metadata that indicates whether the tabId property is editable.

Return values
$this

setTabLabel()

Sets tab_label

public setTabLabel(string|null $tab_label) : $this
Parameters
$tab_label : string|null

The label string associated with the tab.

Return values
$this

setTabLabelMetadata()

Sets tab_label_metadata

public setTabLabelMetadata(PropertyMetadata $tab_label_metadata) : $this
Parameters
$tab_label_metadata : PropertyMetadata

Metadata that indicates whether the tabLabel property is editable.

Return values
$this

setTabOrder()

Sets tab_order

public setTabOrder(string|null $tab_order) : $this
Parameters
$tab_order : string|null
Return values
$this

setTabOrderMetadata()

Sets tab_order_metadata

public setTabOrderMetadata(PropertyMetadata $tab_order_metadata) : $this
Parameters
$tab_order_metadata : PropertyMetadata

Metadata that indicates whether the tabOrder property is editable.

Return values
$this

setTabType()

Sets tab_type

public setTabType(string|null $tab_type) : $this
Parameters
$tab_type : string|null
Return values
$this

setTabTypeMetadata()

Sets tab_type_metadata

public setTabTypeMetadata(PropertyMetadata $tab_type_metadata) : $this
Parameters
$tab_type_metadata : PropertyMetadata

Metadata that indicates whether the tabType property is editable.

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

setTemplateLockedMetadata()

Sets template_locked_metadata

public setTemplateLockedMetadata(PropertyMetadata $template_locked_metadata) : $this
Parameters
$template_locked_metadata : PropertyMetadata

Metadata that indicates whether the templateLocked property is editable.

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

setTemplateRequiredMetadata()

Sets template_required_metadata

public setTemplateRequiredMetadata(PropertyMetadata $template_required_metadata) : $this
Parameters
$template_required_metadata : PropertyMetadata

Metadata that indicates whether the templateRequired property is editable.

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>

setTooltip()

Sets tooltip

public setTooltip(string|null $tooltip) : $this
Parameters
$tooltip : string|null
Return values
$this

setToolTipMetadata()

Sets tool_tip_metadata

public setToolTipMetadata(PropertyMetadata $tool_tip_metadata) : $this
Parameters
$tool_tip_metadata : PropertyMetadata

Metadata that indicates whether the toolTip property is editable.

Return values
$this

setUnderline()

Sets underline

public setUnderline(string|null $underline) : $this
Parameters
$underline : string|null

When set to true, the information in the tab is underlined.

Return values
$this

setUnderlineMetadata()

Sets underline_metadata

public setUnderlineMetadata(PropertyMetadata $underline_metadata) : $this
Parameters
$underline_metadata : PropertyMetadata

Metadata that indicates whether the underline property is editable.

Return values
$this

setValidationMessage()

Sets validation_message

public setValidationMessage(string|null $validation_message) : $this
Parameters
$validation_message : string|null

The message displayed if the custom tab fails input validation (either custom of embedded).

Return values
$this

setValidationMessageMetadata()

Sets validation_message_metadata

public setValidationMessageMetadata(PropertyMetadata $validation_message_metadata) : $this
Parameters
$validation_message_metadata : PropertyMetadata

Metadata that indicates whether the validationMessage property is editable.

Return values
$this

setValidationPattern()

Sets validation_pattern

public setValidationPattern(string|null $validation_pattern) : $this
Parameters
$validation_pattern : string|null

A regular expression used to validate input for the tab.

Return values
$this

setValidationPatternMetadata()

Sets validation_pattern_metadata

public setValidationPatternMetadata(PropertyMetadata $validation_pattern_metadata) : $this
Parameters
$validation_pattern_metadata : PropertyMetadata

Metadata that indicates whether the validationPattern property is editable.

Return values
$this

setValue()

Sets value

public setValue(string|null $value) : $this
Parameters
$value : string|null

Specifies the value of the tab.

Return values
$this

setValueMetadata()

Sets value_metadata

public setValueMetadata(PropertyMetadata $value_metadata) : $this
Parameters
$value_metadata : PropertyMetadata

Metadata that indicates whether the value property is editable.

Return values
$this

setWidth()

Sets width

public setWidth(string|null $width) : $this
Parameters
$width : string|null

Width of the tab in pixels.

Return values
$this

setWidthMetadata()

Sets width_metadata

public setWidthMetadata(PropertyMetadata $width_metadata) : $this
Parameters
$width_metadata : PropertyMetadata

Metadata that indicates whether the width property is editable.

Return values
$this

setXPosition()

Sets x_position

public setXPosition(string|null $x_position) : $this
Parameters
$x_position : string|null

This indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position.

Return values
$this

setXPositionMetadata()

Sets x_position_metadata

public setXPositionMetadata(PropertyMetadata $x_position_metadata) : $this
Parameters
$x_position_metadata : PropertyMetadata

Metadata that indicates whether the xPosition property is editable.

Return values
$this

setYPosition()

Sets y_position

public setYPosition(string|null $y_position) : $this
Parameters
$y_position : string|null

This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position.

Return values
$this

setYPositionMetadata()

Sets y_position_metadata

public setYPositionMetadata(PropertyMetadata $y_position_metadata) : $this
Parameters
$y_position_metadata : PropertyMetadata

Metadata that indicates whether the yPosition property is editable.

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