Documentation

Tabs
in package
implements ModelInterface, ArrayAccess

Tabs Class Doc Comment

Tags
category

Class

description

Tabs indicate to recipients where they should sign, initial, or enter data on a document. They are represented graphically as symbols on documents at the time of signing. Tabs can also display data to the recipients.

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
getApproveTabs()  : array<string|int, Approve>
Gets approve_tabs
getCheckboxTabs()  : array<string|int, Checkbox>
Gets checkbox_tabs
getCommentThreadTabs()  : array<string|int, CommentThread>
Gets comment_thread_tabs
getCommissionCountyTabs()  : array<string|int, CommissionCounty>
Gets commission_county_tabs
getCommissionExpirationTabs()  : array<string|int, CommissionExpiration>
Gets commission_expiration_tabs
getCommissionNumberTabs()  : array<string|int, CommissionNumber>
Gets commission_number_tabs
getCommissionStateTabs()  : array<string|int, CommissionState>
Gets commission_state_tabs
getCompanyTabs()  : array<string|int, Company>
Gets company_tabs
getDateSignedTabs()  : array<string|int, DateSigned>
Gets date_signed_tabs
getDateTabs()  : array<string|int, Date>
Gets date_tabs
getDeclineTabs()  : array<string|int, Decline>
Gets decline_tabs
getDrawTabs()  : array<string|int, Draw>
Gets draw_tabs
getEmailAddressTabs()  : array<string|int, EmailAddress>
Gets email_address_tabs
getEmailTabs()  : array<string|int, Email>
Gets email_tabs
getEnvelopeIdTabs()  : array<string|int, EnvelopeId>
Gets envelope_id_tabs
getFirstNameTabs()  : array<string|int, FirstName>
Gets first_name_tabs
getFormulaTabs()  : array<string|int, FormulaTab>
Gets formula_tabs
getFullNameTabs()  : array<string|int, FullName>
Gets full_name_tabs
getInitialHereTabs()  : array<string|int, InitialHere>
Gets initial_here_tabs
getLastNameTabs()  : array<string|int, LastName>
Gets last_name_tabs
getListTabs()  : array<string|int, ModelList>
Gets list_tabs
getModelName()  : string
The original name of the model.
getNotarizeTabs()  : array<string|int, Notarize>
Gets notarize_tabs
getNotarySealTabs()  : array<string|int, NotarySeal>
Gets notary_seal_tabs
getNoteTabs()  : array<string|int, Note>
Gets note_tabs
getNumberTabs()  : array<string|int, Number>
Gets number_tabs
getNumericalTabs()  : array<string|int, Numerical>
Gets numerical_tabs
getPhoneNumberTabs()  : array<string|int, PhoneNumber>
Gets phone_number_tabs
getPolyLineOverlayTabs()  : array<string|int, PolyLineOverlay>
Gets poly_line_overlay_tabs
getPrefillTabs()  : PrefillTabs
Gets prefill_tabs
getRadioGroupTabs()  : array<string|int, RadioGroup>
Gets radio_group_tabs
getSignerAttachmentTabs()  : array<string|int, SignerAttachment>
Gets signer_attachment_tabs
getSignHereTabs()  : array<string|int, SignHere>
Gets sign_here_tabs
getSmartSectionTabs()  : array<string|int, SmartSection>
Gets smart_section_tabs
getSsnTabs()  : array<string|int, Ssn>
Gets ssn_tabs
getTabGroups()  : array<string|int, TabGroup>
Gets tab_groups
getters()  : array<string|int, mixed>
Array of attributes to getter functions (for serialization of requests)
getTextTabs()  : array<string|int, Text>
Gets text_tabs
getTitleTabs()  : array<string|int, Title>
Gets title_tabs
getViewTabs()  : array<string|int, View>
Gets view_tabs
getZipTabs()  : array<string|int, Zip>
Gets zip_tabs
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.
setApproveTabs()  : $this
Sets approve_tabs
setCheckboxTabs()  : $this
Sets checkbox_tabs
setCommentThreadTabs()  : $this
Sets comment_thread_tabs
setCommissionCountyTabs()  : $this
Sets commission_county_tabs
setCommissionExpirationTabs()  : $this
Sets commission_expiration_tabs
setCommissionNumberTabs()  : $this
Sets commission_number_tabs
setCommissionStateTabs()  : $this
Sets commission_state_tabs
setCompanyTabs()  : $this
Sets company_tabs
setDateSignedTabs()  : $this
Sets date_signed_tabs
setDateTabs()  : $this
Sets date_tabs
setDeclineTabs()  : $this
Sets decline_tabs
setDrawTabs()  : $this
Sets draw_tabs
setEmailAddressTabs()  : $this
Sets email_address_tabs
setEmailTabs()  : $this
Sets email_tabs
setEnvelopeIdTabs()  : $this
Sets envelope_id_tabs
setFirstNameTabs()  : $this
Sets first_name_tabs
setFormulaTabs()  : $this
Sets formula_tabs
setFullNameTabs()  : $this
Sets full_name_tabs
setInitialHereTabs()  : $this
Sets initial_here_tabs
setLastNameTabs()  : $this
Sets last_name_tabs
setListTabs()  : $this
Sets list_tabs
setNotarizeTabs()  : $this
Sets notarize_tabs
setNotarySealTabs()  : $this
Sets notary_seal_tabs
setNoteTabs()  : $this
Sets note_tabs
setNumberTabs()  : $this
Sets number_tabs
setNumericalTabs()  : $this
Sets numerical_tabs
setPhoneNumberTabs()  : $this
Sets phone_number_tabs
setPolyLineOverlayTabs()  : $this
Sets poly_line_overlay_tabs
setPrefillTabs()  : $this
Sets prefill_tabs
setRadioGroupTabs()  : $this
Sets radio_group_tabs
setSignerAttachmentTabs()  : $this
Sets signer_attachment_tabs
setSignHereTabs()  : $this
Sets sign_here_tabs
setSmartSectionTabs()  : $this
Sets smart_section_tabs
setSsnTabs()  : $this
Sets ssn_tabs
setTabGroups()  : $this
Sets tab_groups
setters()  : array<string|int, mixed>
Array of attributes to setter functions (for deserialization of responses)
setTextTabs()  : $this
Sets text_tabs
setTitleTabs()  : $this
Sets title_tabs
setViewTabs()  : $this
Sets view_tabs
setZipTabs()  : $this
Sets zip_tabs
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 = ['approve_tabs' => 'approveTabs', 'checkbox_tabs' => 'checkboxTabs', 'comment_thread_tabs' => 'commentThreadTabs', 'commission_county_tabs' => 'commissionCountyTabs', 'commission_expiration_tabs' => 'commissionExpirationTabs', 'commission_number_tabs' => 'commissionNumberTabs', 'commission_state_tabs' => 'commissionStateTabs', 'company_tabs' => 'companyTabs', 'date_signed_tabs' => 'dateSignedTabs', 'date_tabs' => 'dateTabs', 'decline_tabs' => 'declineTabs', 'draw_tabs' => 'drawTabs', 'email_address_tabs' => 'emailAddressTabs', 'email_tabs' => 'emailTabs', 'envelope_id_tabs' => 'envelopeIdTabs', 'first_name_tabs' => 'firstNameTabs', 'formula_tabs' => 'formulaTabs', 'full_name_tabs' => 'fullNameTabs', 'initial_here_tabs' => 'initialHereTabs', 'last_name_tabs' => 'lastNameTabs', 'list_tabs' => 'listTabs', 'notarize_tabs' => 'notarizeTabs', 'notary_seal_tabs' => 'notarySealTabs', 'note_tabs' => 'noteTabs', 'number_tabs' => 'numberTabs', 'numerical_tabs' => 'numericalTabs', 'phone_number_tabs' => 'phoneNumberTabs', 'poly_line_overlay_tabs' => 'polyLineOverlayTabs', 'prefill_tabs' => 'prefillTabs', 'radio_group_tabs' => 'radioGroupTabs', 'signer_attachment_tabs' => 'signerAttachmentTabs', 'sign_here_tabs' => 'signHereTabs', 'smart_section_tabs' => 'smartSectionTabs', 'ssn_tabs' => 'ssnTabs', 'tab_groups' => 'tabGroups', 'text_tabs' => 'textTabs', 'title_tabs' => 'titleTabs', 'view_tabs' => 'viewTabs', 'zip_tabs' => 'zipTabs']

$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 = ['approve_tabs' => 'getApproveTabs', 'checkbox_tabs' => 'getCheckboxTabs', 'comment_thread_tabs' => 'getCommentThreadTabs', 'commission_county_tabs' => 'getCommissionCountyTabs', 'commission_expiration_tabs' => 'getCommissionExpirationTabs', 'commission_number_tabs' => 'getCommissionNumberTabs', 'commission_state_tabs' => 'getCommissionStateTabs', 'company_tabs' => 'getCompanyTabs', 'date_signed_tabs' => 'getDateSignedTabs', 'date_tabs' => 'getDateTabs', 'decline_tabs' => 'getDeclineTabs', 'draw_tabs' => 'getDrawTabs', 'email_address_tabs' => 'getEmailAddressTabs', 'email_tabs' => 'getEmailTabs', 'envelope_id_tabs' => 'getEnvelopeIdTabs', 'first_name_tabs' => 'getFirstNameTabs', 'formula_tabs' => 'getFormulaTabs', 'full_name_tabs' => 'getFullNameTabs', 'initial_here_tabs' => 'getInitialHereTabs', 'last_name_tabs' => 'getLastNameTabs', 'list_tabs' => 'getListTabs', 'notarize_tabs' => 'getNotarizeTabs', 'notary_seal_tabs' => 'getNotarySealTabs', 'note_tabs' => 'getNoteTabs', 'number_tabs' => 'getNumberTabs', 'numerical_tabs' => 'getNumericalTabs', 'phone_number_tabs' => 'getPhoneNumberTabs', 'poly_line_overlay_tabs' => 'getPolyLineOverlayTabs', 'prefill_tabs' => 'getPrefillTabs', 'radio_group_tabs' => 'getRadioGroupTabs', 'signer_attachment_tabs' => 'getSignerAttachmentTabs', 'sign_here_tabs' => 'getSignHereTabs', 'smart_section_tabs' => 'getSmartSectionTabs', 'ssn_tabs' => 'getSsnTabs', 'tab_groups' => 'getTabGroups', 'text_tabs' => 'getTextTabs', 'title_tabs' => 'getTitleTabs', 'view_tabs' => 'getViewTabs', 'zip_tabs' => 'getZipTabs']

$setters

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

protected static array<string|int, string> $setters = ['approve_tabs' => 'setApproveTabs', 'checkbox_tabs' => 'setCheckboxTabs', 'comment_thread_tabs' => 'setCommentThreadTabs', 'commission_county_tabs' => 'setCommissionCountyTabs', 'commission_expiration_tabs' => 'setCommissionExpirationTabs', 'commission_number_tabs' => 'setCommissionNumberTabs', 'commission_state_tabs' => 'setCommissionStateTabs', 'company_tabs' => 'setCompanyTabs', 'date_signed_tabs' => 'setDateSignedTabs', 'date_tabs' => 'setDateTabs', 'decline_tabs' => 'setDeclineTabs', 'draw_tabs' => 'setDrawTabs', 'email_address_tabs' => 'setEmailAddressTabs', 'email_tabs' => 'setEmailTabs', 'envelope_id_tabs' => 'setEnvelopeIdTabs', 'first_name_tabs' => 'setFirstNameTabs', 'formula_tabs' => 'setFormulaTabs', 'full_name_tabs' => 'setFullNameTabs', 'initial_here_tabs' => 'setInitialHereTabs', 'last_name_tabs' => 'setLastNameTabs', 'list_tabs' => 'setListTabs', 'notarize_tabs' => 'setNotarizeTabs', 'notary_seal_tabs' => 'setNotarySealTabs', 'note_tabs' => 'setNoteTabs', 'number_tabs' => 'setNumberTabs', 'numerical_tabs' => 'setNumericalTabs', 'phone_number_tabs' => 'setPhoneNumberTabs', 'poly_line_overlay_tabs' => 'setPolyLineOverlayTabs', 'prefill_tabs' => 'setPrefillTabs', 'radio_group_tabs' => 'setRadioGroupTabs', 'signer_attachment_tabs' => 'setSignerAttachmentTabs', 'sign_here_tabs' => 'setSignHereTabs', 'smart_section_tabs' => 'setSmartSectionTabs', 'ssn_tabs' => 'setSsnTabs', 'tab_groups' => 'setTabGroups', 'text_tabs' => 'setTextTabs', 'title_tabs' => 'setTitleTabs', 'view_tabs' => 'setViewTabs', 'zip_tabs' => 'setZipTabs']

$swaggerFormats

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

protected static array<string|int, string> $swaggerFormats = ['approve_tabs' => null, 'checkbox_tabs' => null, 'comment_thread_tabs' => null, 'commission_county_tabs' => null, 'commission_expiration_tabs' => null, 'commission_number_tabs' => null, 'commission_state_tabs' => null, 'company_tabs' => null, 'date_signed_tabs' => null, 'date_tabs' => null, 'decline_tabs' => null, 'draw_tabs' => null, 'email_address_tabs' => null, 'email_tabs' => null, 'envelope_id_tabs' => null, 'first_name_tabs' => null, 'formula_tabs' => null, 'full_name_tabs' => null, 'initial_here_tabs' => null, 'last_name_tabs' => null, 'list_tabs' => null, 'notarize_tabs' => null, 'notary_seal_tabs' => null, 'note_tabs' => null, 'number_tabs' => null, 'numerical_tabs' => null, 'phone_number_tabs' => null, 'poly_line_overlay_tabs' => null, 'prefill_tabs' => null, 'radio_group_tabs' => null, 'signer_attachment_tabs' => null, 'sign_here_tabs' => null, 'smart_section_tabs' => null, 'ssn_tabs' => null, 'tab_groups' => null, 'text_tabs' => null, 'title_tabs' => null, 'view_tabs' => null, 'zip_tabs' => null]

$swaggerModelName

The original name of the model.

protected static string $swaggerModelName = 'tabs'

$swaggerTypes

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

protected static array<string|int, string> $swaggerTypes = ['approve_tabs' => '\\DocuSign\\eSign\\Model\\Approve[]', 'checkbox_tabs' => '\\DocuSign\\eSign\\Model\\Checkbox[]', 'comment_thread_tabs' => '\\DocuSign\\eSign\\Model\\CommentThread[]', 'commission_county_tabs' => '\\DocuSign\\eSign\\Model\\CommissionCounty[]', 'commission_expiration_tabs' => '\\DocuSign\\eSign\\Model\\CommissionExpiration[]', 'commission_number_tabs' => '\\DocuSign\\eSign\\Model\\CommissionNumber[]', 'commission_state_tabs' => '\\DocuSign\\eSign\\Model\\CommissionState[]', 'company_tabs' => '\\DocuSign\\eSign\\Model\\Company[]', 'date_signed_tabs' => '\\DocuSign\\eSign\\Model\\DateSigned[]', 'date_tabs' => '\\DocuSign\\eSign\\Model\\Date[]', 'decline_tabs' => '\\DocuSign\\eSign\\Model\\Decline[]', 'draw_tabs' => '\\DocuSign\\eSign\\Model\\Draw[]', 'email_address_tabs' => '\\DocuSign\\eSign\\Model\\EmailAddress[]', 'email_tabs' => '\\DocuSign\\eSign\\Model\\Email[]', 'envelope_id_tabs' => '\\DocuSign\\eSign\\Model\\EnvelopeId[]', 'first_name_tabs' => '\\DocuSign\\eSign\\Model\\FirstName[]', 'formula_tabs' => '\\DocuSign\\eSign\\Model\\FormulaTab[]', 'full_name_tabs' => '\\DocuSign\\eSign\\Model\\FullName[]', 'initial_here_tabs' => '\\DocuSign\\eSign\\Model\\InitialHere[]', 'last_name_tabs' => '\\DocuSign\\eSign\\Model\\LastName[]', 'list_tabs' => '\\DocuSign\\eSign\\Model\\ModelList[]', 'notarize_tabs' => '\\DocuSign\\eSign\\Model\\Notarize[]', 'notary_seal_tabs' => '\\DocuSign\\eSign\\Model\\NotarySeal[]', 'note_tabs' => '\\DocuSign\\eSign\\Model\\Note[]', 'number_tabs' => '\\DocuSign\\eSign\\Model\\Number[]', 'numerical_tabs' => '\\DocuSign\\eSign\\Model\\Numerical[]', 'phone_number_tabs' => '\\DocuSign\\eSign\\Model\\PhoneNumber[]', 'poly_line_overlay_tabs' => '\\DocuSign\\eSign\\Model\\PolyLineOverlay[]', 'prefill_tabs' => '\\DocuSign\\eSign\\Model\\PrefillTabs', 'radio_group_tabs' => '\\DocuSign\\eSign\\Model\\RadioGroup[]', 'signer_attachment_tabs' => '\\DocuSign\\eSign\\Model\\SignerAttachment[]', 'sign_here_tabs' => '\\DocuSign\\eSign\\Model\\SignHere[]', 'smart_section_tabs' => '\\DocuSign\\eSign\\Model\\SmartSection[]', 'ssn_tabs' => '\\DocuSign\\eSign\\Model\\Ssn[]', 'tab_groups' => '\\DocuSign\\eSign\\Model\\TabGroup[]', 'text_tabs' => '\\DocuSign\\eSign\\Model\\Text[]', 'title_tabs' => '\\DocuSign\\eSign\\Model\\Title[]', 'view_tabs' => '\\DocuSign\\eSign\\Model\\View[]', 'zip_tabs' => '\\DocuSign\\eSign\\Model\\Zip[]']

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>

getApproveTabs()

Gets approve_tabs

public getApproveTabs() : array<string|int, Approve>
Return values
array<string|int, Approve>

getCheckboxTabs()

Gets checkbox_tabs

public getCheckboxTabs() : array<string|int, Checkbox>
Return values
array<string|int, Checkbox>

getCommentThreadTabs()

Gets comment_thread_tabs

public getCommentThreadTabs() : array<string|int, CommentThread>
Return values
array<string|int, CommentThread>

getCommissionStateTabs()

Gets commission_state_tabs

public getCommissionStateTabs() : array<string|int, CommissionState>
Return values
array<string|int, CommissionState>

getCompanyTabs()

Gets company_tabs

public getCompanyTabs() : array<string|int, Company>
Return values
array<string|int, Company>

getDateSignedTabs()

Gets date_signed_tabs

public getDateSignedTabs() : array<string|int, DateSigned>
Return values
array<string|int, DateSigned>

getDateTabs()

Gets date_tabs

public getDateTabs() : array<string|int, Date>
Return values
array<string|int, Date>

getDeclineTabs()

Gets decline_tabs

public getDeclineTabs() : array<string|int, Decline>
Return values
array<string|int, Decline>

getDrawTabs()

Gets draw_tabs

public getDrawTabs() : array<string|int, Draw>
Return values
array<string|int, Draw>

getEmailAddressTabs()

Gets email_address_tabs

public getEmailAddressTabs() : array<string|int, EmailAddress>
Return values
array<string|int, EmailAddress>

getEmailTabs()

Gets email_tabs

public getEmailTabs() : array<string|int, Email>
Return values
array<string|int, Email>

getEnvelopeIdTabs()

Gets envelope_id_tabs

public getEnvelopeIdTabs() : array<string|int, EnvelopeId>
Return values
array<string|int, EnvelopeId>

getFirstNameTabs()

Gets first_name_tabs

public getFirstNameTabs() : array<string|int, FirstName>
Return values
array<string|int, FirstName>

getFormulaTabs()

Gets formula_tabs

public getFormulaTabs() : array<string|int, FormulaTab>
Return values
array<string|int, FormulaTab>

getFullNameTabs()

Gets full_name_tabs

public getFullNameTabs() : array<string|int, FullName>
Return values
array<string|int, FullName>

getInitialHereTabs()

Gets initial_here_tabs

public getInitialHereTabs() : array<string|int, InitialHere>
Return values
array<string|int, InitialHere>

getLastNameTabs()

Gets last_name_tabs

public getLastNameTabs() : array<string|int, LastName>
Return values
array<string|int, LastName>

getListTabs()

Gets list_tabs

public getListTabs() : array<string|int, ModelList>
Return values
array<string|int, ModelList>

getModelName()

The original name of the model.

public getModelName() : string
Return values
string

getNotarizeTabs()

Gets notarize_tabs

public getNotarizeTabs() : array<string|int, Notarize>
Return values
array<string|int, Notarize>

getNotarySealTabs()

Gets notary_seal_tabs

public getNotarySealTabs() : array<string|int, NotarySeal>
Return values
array<string|int, NotarySeal>

getNoteTabs()

Gets note_tabs

public getNoteTabs() : array<string|int, Note>
Return values
array<string|int, Note>

getNumberTabs()

Gets number_tabs

public getNumberTabs() : array<string|int, Number>
Return values
array<string|int, Number>

getNumericalTabs()

Gets numerical_tabs

public getNumericalTabs() : array<string|int, Numerical>
Return values
array<string|int, Numerical>

getPhoneNumberTabs()

Gets phone_number_tabs

public getPhoneNumberTabs() : array<string|int, PhoneNumber>
Return values
array<string|int, PhoneNumber>

getPolyLineOverlayTabs()

Gets poly_line_overlay_tabs

public getPolyLineOverlayTabs() : array<string|int, PolyLineOverlay>
Return values
array<string|int, PolyLineOverlay>

getRadioGroupTabs()

Gets radio_group_tabs

public getRadioGroupTabs() : array<string|int, RadioGroup>
Return values
array<string|int, RadioGroup>

getSignHereTabs()

Gets sign_here_tabs

public getSignHereTabs() : array<string|int, SignHere>
Return values
array<string|int, SignHere>

getSmartSectionTabs()

Gets smart_section_tabs

public getSmartSectionTabs() : array<string|int, SmartSection>
Return values
array<string|int, SmartSection>

getSsnTabs()

Gets ssn_tabs

public getSsnTabs() : array<string|int, Ssn>
Return values
array<string|int, Ssn>

getTabGroups()

Gets tab_groups

public getTabGroups() : array<string|int, TabGroup>
Return values
array<string|int, TabGroup>

getters()

Array of attributes to getter functions (for serialization of requests)

public static getters() : array<string|int, mixed>
Return values
array<string|int, mixed>

getTextTabs()

Gets text_tabs

public getTextTabs() : array<string|int, Text>
Return values
array<string|int, Text>

getTitleTabs()

Gets title_tabs

public getTitleTabs() : array<string|int, Title>
Return values
array<string|int, Title>

getViewTabs()

Gets view_tabs

public getViewTabs() : array<string|int, View>
Return values
array<string|int, View>

getZipTabs()

Gets zip_tabs

public getZipTabs() : array<string|int, Zip>
Return values
array<string|int, Zip>

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

setApproveTabs()

Sets approve_tabs

public setApproveTabs(array<string|int, Approve$approve_tabs) : $this
Parameters
$approve_tabs : array<string|int, Approve>

Specifies a tag on the document where you want the recipient to approve documents in an envelope without placing a signature or initials on the document. If the recipient clicks the Approve tag during the signing process, the recipient is considered to have signed the document. No information is shown on the document for the approval, but it is recorded as a signature in the envelope history.

Return values
$this

setCheckboxTabs()

Sets checkbox_tabs

public setCheckboxTabs(array<string|int, Checkbox$checkbox_tabs) : $this
Parameters
$checkbox_tabs : array<string|int, Checkbox>

Specifies a tag on the document in a location where the recipient can select an option.

Return values
$this

setCommentThreadTabs()

Sets comment_thread_tabs

public setCommentThreadTabs(array<string|int, CommentThread$comment_thread_tabs) : $this
Parameters
$comment_thread_tabs : array<string|int, CommentThread>
Return values
$this

setCommissionCountyTabs()

Sets commission_county_tabs

public setCommissionCountyTabs(array<string|int, CommissionCounty$commission_county_tabs) : $this
Parameters
$commission_county_tabs : array<string|int, CommissionCounty>
Return values
$this

setCommissionExpirationTabs()

Sets commission_expiration_tabs

public setCommissionExpirationTabs(array<string|int, CommissionExpiration$commission_expiration_tabs) : $this
Parameters
$commission_expiration_tabs : array<string|int, CommissionExpiration>
Return values
$this

setCommissionNumberTabs()

Sets commission_number_tabs

public setCommissionNumberTabs(array<string|int, CommissionNumber$commission_number_tabs) : $this
Parameters
$commission_number_tabs : array<string|int, CommissionNumber>
Return values
$this

setCommissionStateTabs()

Sets commission_state_tabs

public setCommissionStateTabs(array<string|int, CommissionState$commission_state_tabs) : $this
Parameters
$commission_state_tabs : array<string|int, CommissionState>
Return values
$this

setCompanyTabs()

Sets company_tabs

public setCompanyTabs(array<string|int, Company$company_tabs) : $this
Parameters
$company_tabs : array<string|int, Company>

Specifies a tag on the document where you want the recipient's company name to appear. When getting information that includes this tab type, the original value of the tab when the associated envelope was sent is included in the response.

Return values
$this

setDateSignedTabs()

Sets date_signed_tabs

public setDateSignedTabs(array<string|int, DateSigned$date_signed_tabs) : $this
Parameters
$date_signed_tabs : array<string|int, DateSigned>

Specifies a tab on the document where the date the document was signed will automatically appear.

Return values
$this

setDateTabs()

Sets date_tabs

public setDateTabs(array<string|int, Date$date_tabs) : $this
Parameters
$date_tabs : array<string|int, Date>

Specifies a tab on the document where you want the recipient to enter a date. Date tabs are single-line fields that allow date information to be entered in any format. The tooltip for this tab recommends entering the date as MM/DD/YYYY, but this is not enforced. The format entered by the signer is retained. If you need a particular date format enforced, DocuSign recommends using a Text tab with a Validation Pattern and Validation Message to enforce the format.

Return values
$this

setDeclineTabs()

Sets decline_tabs

public setDeclineTabs(array<string|int, Decline$decline_tabs) : $this
Parameters
$decline_tabs : array<string|int, Decline>

Specifies a tag on the document where you want to give the recipient the option of declining an envelope. If the recipient clicks the Decline tag during the signing process, the envelope is voided.

Return values
$this

setDrawTabs()

Sets draw_tabs

public setDrawTabs(array<string|int, Draw$draw_tabs) : $this
Parameters
$draw_tabs : array<string|int, Draw>
Return values
$this

setEmailAddressTabs()

Sets email_address_tabs

public setEmailAddressTabs(array<string|int, EmailAddress$email_address_tabs) : $this
Parameters
$email_address_tabs : array<string|int, EmailAddress>

Specifies a location on the document where you want where you want the recipient's email, as entered in the recipient information, to display.

Return values
$this

setEmailTabs()

Sets email_tabs

public setEmailTabs(array<string|int, Email$email_tabs) : $this
Parameters
$email_tabs : array<string|int, Email>

Specifies a tag on the document where you want the recipient to enter an email. Email tags are single-line fields that accept any characters. The system checks that a valid email format (i.e. xxx@yyy.zzz) is entered in the tag. It uses the same parameters as a Text tab, with the validation message and pattern set for email information. When getting information that includes this tab type, the original value of the tab when the associated envelope was sent is included in the response.

Return values
$this

setEnvelopeIdTabs()

Sets envelope_id_tabs

public setEnvelopeIdTabs(array<string|int, EnvelopeId$envelope_id_tabs) : $this
Parameters
$envelope_id_tabs : array<string|int, EnvelopeId>

Specifies a tag on the document where you want the envelope ID for to appear. Recipients cannot enter or change the information in this tab, it is for informational purposes only.

Return values
$this

setFirstNameTabs()

Sets first_name_tabs

public setFirstNameTabs(array<string|int, FirstName$first_name_tabs) : $this
Parameters
$first_name_tabs : array<string|int, FirstName>

Specifies tag on a document where you want the recipient's first name to appear. This tag takes the recipient's name, as entered in the recipient information, splits it into sections based on spaces and uses the first section as the first name.

Return values
$this

setFormulaTabs()

Sets formula_tabs

public setFormulaTabs(array<string|int, FormulaTab$formula_tabs) : $this
Parameters
$formula_tabs : array<string|int, FormulaTab>

Specifies a tag that is used to add a calculated field to a document. Envelope recipients cannot directly enter information into the tag; the formula tab calculates and displays a new value when changes are made to the reference tag values. The reference tag information and calculation operations are entered in the "formula" element. See the [ML:Using the Calculated Fields Feature] quick start guide or [ML:DocuSign Service User Guide] for more information about formulas.

Return values
$this

setFullNameTabs()

Sets full_name_tabs

public setFullNameTabs(array<string|int, FullName$full_name_tabs) : $this
Parameters
$full_name_tabs : array<string|int, FullName>

Specifies a tag on the document where you want the recipient's name to appear.

Return values
$this

setInitialHereTabs()

Sets initial_here_tabs

public setInitialHereTabs(array<string|int, InitialHere$initial_here_tabs) : $this
Parameters
$initial_here_tabs : array<string|int, InitialHere>

Specifies a tag location in the document at which a recipient will place their initials. The optional parameter specifies whether the initials are required or optional.

Return values
$this

setLastNameTabs()

Sets last_name_tabs

public setLastNameTabs(array<string|int, LastName$last_name_tabs) : $this
Parameters
$last_name_tabs : array<string|int, LastName>

Specifies a tag on a document where you want the recipient's last name to appear. This tag takes the recipient's name, as entered in the recipient information, splits it into sections based on spaces and uses the last section as the last name.

Return values
$this

setListTabs()

Sets list_tabs

public setListTabs(array<string|int, ModelList$list_tabs) : $this
Parameters
$list_tabs : array<string|int, ModelList>

Specify this tag to give your recipient a list of options, presented as a drop-down list, from which they can select.

Return values
$this

setNotarizeTabs()

Sets notarize_tabs

public setNotarizeTabs(array<string|int, Notarize$notarize_tabs) : $this
Parameters
$notarize_tabs : array<string|int, Notarize>
Return values
$this

setNotarySealTabs()

Sets notary_seal_tabs

public setNotarySealTabs(array<string|int, NotarySeal$notary_seal_tabs) : $this
Parameters
$notary_seal_tabs : array<string|int, NotarySeal>
Return values
$this

setNoteTabs()

Sets note_tabs

public setNoteTabs(array<string|int, Note$note_tabs) : $this
Parameters
$note_tabs : array<string|int, Note>

Specifies a location on the document where you want to place additional information, in the form of a note, for a recipient.

Return values
$this

setNumberTabs()

Sets number_tabs

public setNumberTabs(array<string|int, Number$number_tabs) : $this
Parameters
$number_tabs : array<string|int, Number>

Specifies a tag on the document where you want the recipient to enter a number. It uses the same parameters as a Text tab, with the validation message and pattern set for number information. When getting information that includes this tab type, the original value of the tab when the associated envelope was sent is included in the response.

Return values
$this

setNumericalTabs()

Sets numerical_tabs

public setNumericalTabs(array<string|int, Numerical$numerical_tabs) : $this
Parameters
$numerical_tabs : array<string|int, Numerical>
Return values
$this

setPhoneNumberTabs()

Sets phone_number_tabs

public setPhoneNumberTabs(array<string|int, PhoneNumber$phone_number_tabs) : $this
Parameters
$phone_number_tabs : array<string|int, PhoneNumber>
Return values
$this

setPolyLineOverlayTabs()

Sets poly_line_overlay_tabs

public setPolyLineOverlayTabs(array<string|int, PolyLineOverlay$poly_line_overlay_tabs) : $this
Parameters
$poly_line_overlay_tabs : array<string|int, PolyLineOverlay>
Return values
$this

setPrefillTabs()

Sets prefill_tabs

public setPrefillTabs(PrefillTabs $prefill_tabs) : $this
Parameters
$prefill_tabs : PrefillTabs

Prefill tabs are tabs that the sender can fill in before the envelope is sent. They are sometimes called sender tags or pre-fill fields. [Pre-Fill Your Own Document Fields][app] describes how prefill tabs work in the web application. [Customize your envelopes with pre-fill fields][catblog] shows how to use prefill tabs in your application using the eSignature SDKs. [app]: https://support.docusign.com/en/guides/ndse-user-guide-prefill-fields [catblog]: https://www.docusign.com/blog/developers/common-api-tasks-customize-your-envelopes-pre-fill-fields

Return values
$this

setRadioGroupTabs()

Sets radio_group_tabs

public setRadioGroupTabs(array<string|int, RadioGroup$radio_group_tabs) : $this
Parameters
$radio_group_tabs : array<string|int, RadioGroup>

Specifies a tag on the document in a location where the recipient can select one option from a group of options using a radio button. The radio buttons do not have to be on the same page in a document.

Return values
$this

setSignerAttachmentTabs()

Sets signer_attachment_tabs

public setSignerAttachmentTabs(array<string|int, SignerAttachment$signer_attachment_tabs) : $this
Parameters
$signer_attachment_tabs : array<string|int, SignerAttachment>

Specifies a tag on the document when you want the recipient to add supporting documents to an envelope.

Return values
$this

setSignHereTabs()

Sets sign_here_tabs

public setSignHereTabs(array<string|int, SignHere$sign_here_tabs) : $this
Parameters
$sign_here_tabs : array<string|int, SignHere>

A complex type the contains information about the tag that specifies where the recipient places their signature in the document. The "optional" parameter sets if the signature is required or optional.

Return values
$this

setSmartSectionTabs()

Sets smart_section_tabs

public setSmartSectionTabs(array<string|int, SmartSection$smart_section_tabs) : $this
Parameters
$smart_section_tabs : array<string|int, SmartSection>
Return values
$this

setSsnTabs()

Sets ssn_tabs

public setSsnTabs(array<string|int, Ssn$ssn_tabs) : $this
Parameters
$ssn_tabs : array<string|int, Ssn>

Specifies a tag on the document where you want the recipient to enter a Social Security Number (SSN). A SSN can be typed with or without dashes. It uses the same parameters as a Text tab, with the validation message and pattern set for SSN information. When getting information that includes this tab type, the original value of the tab when the associated envelope was sent is included in the response.

Return values
$this

setTabGroups()

Sets tab_groups

public setTabGroups(array<string|int, TabGroup$tab_groups) : $this
Parameters
$tab_groups : array<string|int, TabGroup>
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>

setTextTabs()

Sets text_tabs

public setTextTabs(array<string|int, Text$text_tabs) : $this
Parameters
$text_tabs : array<string|int, Text>

Specifies a that that is an adaptable field that allows the recipient to enter different text information. When getting information that includes this tab type, the original value of the tab when the associated envelope was sent is included in the response.

Return values
$this

setTitleTabs()

Sets title_tabs

public setTitleTabs(array<string|int, Title$title_tabs) : $this
Parameters
$title_tabs : array<string|int, Title>

Specifies a tag on the document where you want the recipient's title to appear. When getting information that includes this tab type, the original value of the tab when the associated envelope was sent is included in the response.

Return values
$this

setViewTabs()

Sets view_tabs

public setViewTabs(array<string|int, View$view_tabs) : $this
Parameters
$view_tabs : array<string|int, View>
Return values
$this

setZipTabs()

Sets zip_tabs

public setZipTabs(array<string|int, Zip$zip_tabs) : $this
Parameters
$zip_tabs : array<string|int, Zip>

Specifies a tag on the document where you want the recipient to enter a ZIP code. The ZIP code can be a five numbers or the ZIP+4 format with nine numbers. The zip code can be typed with or without dashes. It uses the same parameters as a Text tab, with the validation message and pattern set for ZIP code information. When getting information that includes this tab type, the original value of the tab when the associated envelope was sent is included in the response.

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