class DocuSign_eSign::TemplateTabs

Attributes

approve_tabs[RW]

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.

checkbox_tabs[RW]

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

comment_thread_tabs[RW]
commission_county_tabs[RW]
commission_expiration_tabs[RW]
commission_number_tabs[RW]
commission_state_tabs[RW]
company_tabs[RW]

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.

date_signed_tabs[RW]

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

date_tabs[RW]

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.

decline_tabs[RW]

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.

draw_tabs[RW]
email_address_tabs[RW]

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

email_tabs[RW]

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.

envelope_id_tabs[RW]

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.

first_name_tabs[RW]

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.

formula_tabs[RW]

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.

full_name_tabs[RW]

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

initial_here_tabs[RW]

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.

last_name_tabs[RW]

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.

list_tabs[RW]

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

notarize_tabs[RW]
notary_seal_tabs[RW]
note_tabs[RW]

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

number_tabs[RW]

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.

numerical_tabs[RW]
phone_number_tabs[RW]
poly_line_overlay_tabs[RW]
prefill_tabs[RW]

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] describes how prefill tabs work in the web application. [Customize your envelopes with pre-fill fields] shows how to use prefill tabs in your application using the eSignature SDKs. [app]: support.docusign.com/en/guides/ndse-user-guide-prefill-fields [catblog]: www.docusign.com/blog/developers/common-api-tasks-customize-your-envelopes-pre-fill-fields

radio_group_tabs[RW]

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.

sign_here_tabs[RW]

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.

signer_attachment_tabs[RW]

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

smart_section_tabs[RW]
ssn_tabs[RW]

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.

tab_groups[RW]
text_tabs[RW]

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.

title_tabs[RW]

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.

view_tabs[RW]
zip_tabs[RW]

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.

Public Class Methods

attribute_map() click to toggle source

Attribute mapping from ruby-style variable name to JSON key.

# File lib/docusign_esign/models/template_tabs.rb, line 134
def self.attribute_map
  {
    :'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'
  }
end
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash

# File lib/docusign_esign/models/template_tabs.rb, line 225
def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  if attributes.has_key?(:'approveTabs')
    if (value = attributes[:'approveTabs']).is_a?(Array)
      self.approve_tabs = value
    end
  end

  if attributes.has_key?(:'checkboxTabs')
    if (value = attributes[:'checkboxTabs']).is_a?(Array)
      self.checkbox_tabs = value
    end
  end

  if attributes.has_key?(:'commentThreadTabs')
    if (value = attributes[:'commentThreadTabs']).is_a?(Array)
      self.comment_thread_tabs = value
    end
  end

  if attributes.has_key?(:'commissionCountyTabs')
    if (value = attributes[:'commissionCountyTabs']).is_a?(Array)
      self.commission_county_tabs = value
    end
  end

  if attributes.has_key?(:'commissionExpirationTabs')
    if (value = attributes[:'commissionExpirationTabs']).is_a?(Array)
      self.commission_expiration_tabs = value
    end
  end

  if attributes.has_key?(:'commissionNumberTabs')
    if (value = attributes[:'commissionNumberTabs']).is_a?(Array)
      self.commission_number_tabs = value
    end
  end

  if attributes.has_key?(:'commissionStateTabs')
    if (value = attributes[:'commissionStateTabs']).is_a?(Array)
      self.commission_state_tabs = value
    end
  end

  if attributes.has_key?(:'companyTabs')
    if (value = attributes[:'companyTabs']).is_a?(Array)
      self.company_tabs = value
    end
  end

  if attributes.has_key?(:'dateSignedTabs')
    if (value = attributes[:'dateSignedTabs']).is_a?(Array)
      self.date_signed_tabs = value
    end
  end

  if attributes.has_key?(:'dateTabs')
    if (value = attributes[:'dateTabs']).is_a?(Array)
      self.date_tabs = value
    end
  end

  if attributes.has_key?(:'declineTabs')
    if (value = attributes[:'declineTabs']).is_a?(Array)
      self.decline_tabs = value
    end
  end

  if attributes.has_key?(:'drawTabs')
    if (value = attributes[:'drawTabs']).is_a?(Array)
      self.draw_tabs = value
    end
  end

  if attributes.has_key?(:'emailAddressTabs')
    if (value = attributes[:'emailAddressTabs']).is_a?(Array)
      self.email_address_tabs = value
    end
  end

  if attributes.has_key?(:'emailTabs')
    if (value = attributes[:'emailTabs']).is_a?(Array)
      self.email_tabs = value
    end
  end

  if attributes.has_key?(:'envelopeIdTabs')
    if (value = attributes[:'envelopeIdTabs']).is_a?(Array)
      self.envelope_id_tabs = value
    end
  end

  if attributes.has_key?(:'firstNameTabs')
    if (value = attributes[:'firstNameTabs']).is_a?(Array)
      self.first_name_tabs = value
    end
  end

  if attributes.has_key?(:'formulaTabs')
    if (value = attributes[:'formulaTabs']).is_a?(Array)
      self.formula_tabs = value
    end
  end

  if attributes.has_key?(:'fullNameTabs')
    if (value = attributes[:'fullNameTabs']).is_a?(Array)
      self.full_name_tabs = value
    end
  end

  if attributes.has_key?(:'initialHereTabs')
    if (value = attributes[:'initialHereTabs']).is_a?(Array)
      self.initial_here_tabs = value
    end
  end

  if attributes.has_key?(:'lastNameTabs')
    if (value = attributes[:'lastNameTabs']).is_a?(Array)
      self.last_name_tabs = value
    end
  end

  if attributes.has_key?(:'listTabs')
    if (value = attributes[:'listTabs']).is_a?(Array)
      self.list_tabs = value
    end
  end

  if attributes.has_key?(:'notarizeTabs')
    if (value = attributes[:'notarizeTabs']).is_a?(Array)
      self.notarize_tabs = value
    end
  end

  if attributes.has_key?(:'notarySealTabs')
    if (value = attributes[:'notarySealTabs']).is_a?(Array)
      self.notary_seal_tabs = value
    end
  end

  if attributes.has_key?(:'noteTabs')
    if (value = attributes[:'noteTabs']).is_a?(Array)
      self.note_tabs = value
    end
  end

  if attributes.has_key?(:'numberTabs')
    if (value = attributes[:'numberTabs']).is_a?(Array)
      self.number_tabs = value
    end
  end

  if attributes.has_key?(:'numericalTabs')
    if (value = attributes[:'numericalTabs']).is_a?(Array)
      self.numerical_tabs = value
    end
  end

  if attributes.has_key?(:'phoneNumberTabs')
    if (value = attributes[:'phoneNumberTabs']).is_a?(Array)
      self.phone_number_tabs = value
    end
  end

  if attributes.has_key?(:'polyLineOverlayTabs')
    if (value = attributes[:'polyLineOverlayTabs']).is_a?(Array)
      self.poly_line_overlay_tabs = value
    end
  end

  if attributes.has_key?(:'prefillTabs')
    self.prefill_tabs = attributes[:'prefillTabs']
  end

  if attributes.has_key?(:'radioGroupTabs')
    if (value = attributes[:'radioGroupTabs']).is_a?(Array)
      self.radio_group_tabs = value
    end
  end

  if attributes.has_key?(:'signerAttachmentTabs')
    if (value = attributes[:'signerAttachmentTabs']).is_a?(Array)
      self.signer_attachment_tabs = value
    end
  end

  if attributes.has_key?(:'signHereTabs')
    if (value = attributes[:'signHereTabs']).is_a?(Array)
      self.sign_here_tabs = value
    end
  end

  if attributes.has_key?(:'smartSectionTabs')
    if (value = attributes[:'smartSectionTabs']).is_a?(Array)
      self.smart_section_tabs = value
    end
  end

  if attributes.has_key?(:'ssnTabs')
    if (value = attributes[:'ssnTabs']).is_a?(Array)
      self.ssn_tabs = value
    end
  end

  if attributes.has_key?(:'tabGroups')
    if (value = attributes[:'tabGroups']).is_a?(Array)
      self.tab_groups = value
    end
  end

  if attributes.has_key?(:'textTabs')
    if (value = attributes[:'textTabs']).is_a?(Array)
      self.text_tabs = value
    end
  end

  if attributes.has_key?(:'titleTabs')
    if (value = attributes[:'titleTabs']).is_a?(Array)
      self.title_tabs = value
    end
  end

  if attributes.has_key?(:'viewTabs')
    if (value = attributes[:'viewTabs']).is_a?(Array)
      self.view_tabs = value
    end
  end

  if attributes.has_key?(:'zipTabs')
    if (value = attributes[:'zipTabs']).is_a?(Array)
      self.zip_tabs = value
    end
  end
end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/docusign_esign/models/template_tabs.rb, line 179
def self.swagger_types
  {
    :'approve_tabs' => :'Array<Approve>',
    :'checkbox_tabs' => :'Array<Checkbox>',
    :'comment_thread_tabs' => :'Array<CommentThread>',
    :'commission_county_tabs' => :'Array<CommissionCounty>',
    :'commission_expiration_tabs' => :'Array<CommissionExpiration>',
    :'commission_number_tabs' => :'Array<CommissionNumber>',
    :'commission_state_tabs' => :'Array<CommissionState>',
    :'company_tabs' => :'Array<Company>',
    :'date_signed_tabs' => :'Array<DateSigned>',
    :'date_tabs' => :'Array<DocuSign_eSign::Date>',
    :'decline_tabs' => :'Array<Decline>',
    :'draw_tabs' => :'Array<Draw>',
    :'email_address_tabs' => :'Array<EmailAddress>',
    :'email_tabs' => :'Array<Email>',
    :'envelope_id_tabs' => :'Array<EnvelopeId>',
    :'first_name_tabs' => :'Array<FirstName>',
    :'formula_tabs' => :'Array<FormulaTab>',
    :'full_name_tabs' => :'Array<FullName>',
    :'initial_here_tabs' => :'Array<InitialHere>',
    :'last_name_tabs' => :'Array<LastName>',
    :'list_tabs' => :'Array<List>',
    :'notarize_tabs' => :'Array<Notarize>',
    :'notary_seal_tabs' => :'Array<NotarySeal>',
    :'note_tabs' => :'Array<Note>',
    :'number_tabs' => :'Array<Number>',
    :'numerical_tabs' => :'Array<Numerical>',
    :'phone_number_tabs' => :'Array<PhoneNumber>',
    :'poly_line_overlay_tabs' => :'Array<PolyLineOverlay>',
    :'prefill_tabs' => :'PrefillTabs',
    :'radio_group_tabs' => :'Array<RadioGroup>',
    :'signer_attachment_tabs' => :'Array<SignerAttachment>',
    :'sign_here_tabs' => :'Array<SignHere>',
    :'smart_section_tabs' => :'Array<SmartSection>',
    :'ssn_tabs' => :'Array<Ssn>',
    :'tab_groups' => :'Array<TabGroup>',
    :'text_tabs' => :'Array<Text>',
    :'title_tabs' => :'Array<Title>',
    :'view_tabs' => :'Array<View>',
    :'zip_tabs' => :'Array<Zip>'
  }
end

Public Instance Methods

==(o) click to toggle source

Checks equality by comparing each attribute. @param [Object] Object to be compared

# File lib/docusign_esign/models/template_tabs.rb, line 479
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      approve_tabs == o.approve_tabs &&
      checkbox_tabs == o.checkbox_tabs &&
      comment_thread_tabs == o.comment_thread_tabs &&
      commission_county_tabs == o.commission_county_tabs &&
      commission_expiration_tabs == o.commission_expiration_tabs &&
      commission_number_tabs == o.commission_number_tabs &&
      commission_state_tabs == o.commission_state_tabs &&
      company_tabs == o.company_tabs &&
      date_signed_tabs == o.date_signed_tabs &&
      date_tabs == o.date_tabs &&
      decline_tabs == o.decline_tabs &&
      draw_tabs == o.draw_tabs &&
      email_address_tabs == o.email_address_tabs &&
      email_tabs == o.email_tabs &&
      envelope_id_tabs == o.envelope_id_tabs &&
      first_name_tabs == o.first_name_tabs &&
      formula_tabs == o.formula_tabs &&
      full_name_tabs == o.full_name_tabs &&
      initial_here_tabs == o.initial_here_tabs &&
      last_name_tabs == o.last_name_tabs &&
      list_tabs == o.list_tabs &&
      notarize_tabs == o.notarize_tabs &&
      notary_seal_tabs == o.notary_seal_tabs &&
      note_tabs == o.note_tabs &&
      number_tabs == o.number_tabs &&
      numerical_tabs == o.numerical_tabs &&
      phone_number_tabs == o.phone_number_tabs &&
      poly_line_overlay_tabs == o.poly_line_overlay_tabs &&
      prefill_tabs == o.prefill_tabs &&
      radio_group_tabs == o.radio_group_tabs &&
      signer_attachment_tabs == o.signer_attachment_tabs &&
      sign_here_tabs == o.sign_here_tabs &&
      smart_section_tabs == o.smart_section_tabs &&
      ssn_tabs == o.ssn_tabs &&
      tab_groups == o.tab_groups &&
      text_tabs == o.text_tabs &&
      title_tabs == o.title_tabs &&
      view_tabs == o.view_tabs &&
      zip_tabs == o.zip_tabs
end
_deserialize(type, value) click to toggle source

Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data

# File lib/docusign_esign/models/template_tabs.rb, line 559
def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :BOOLEAN
    if value.to_s =~ /\A(true|t|yes|y|1)\z/i
      true
    else
      false
    end
  when :Object
    # generic object (usually a Hash), return directly
    value
  when /\AArray<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
    k_type = Regexp.last_match[:k_type]
    v_type = Regexp.last_match[:v_type]
    {}.tap do |hash|
      value.each do |k, v|
        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
      end
    end
  else # model
    temp_model = DocuSign_eSign.const_get(type).new
    temp_model.build_from_hash(value)
  end
end
_to_hash(value) click to toggle source

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash

# File lib/docusign_esign/models/template_tabs.rb, line 625
def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end
build_from_hash(attributes) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# File lib/docusign_esign/models/template_tabs.rb, line 538
def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    if type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end
eql?(o) click to toggle source

@see the `==` method @param [Object] Object to be compared

# File lib/docusign_esign/models/template_tabs.rb, line 525
def eql?(o)
  self == o
end
hash() click to toggle source

Calculates hash code according to all attributes. @return [Fixnum] Hash code

# File lib/docusign_esign/models/template_tabs.rb, line 531
def hash
  [approve_tabs, checkbox_tabs, comment_thread_tabs, commission_county_tabs, commission_expiration_tabs, commission_number_tabs, commission_state_tabs, company_tabs, date_signed_tabs, date_tabs, decline_tabs, draw_tabs, email_address_tabs, email_tabs, envelope_id_tabs, first_name_tabs, formula_tabs, full_name_tabs, initial_here_tabs, last_name_tabs, list_tabs, notarize_tabs, notary_seal_tabs, note_tabs, number_tabs, numerical_tabs, phone_number_tabs, poly_line_overlay_tabs, prefill_tabs, radio_group_tabs, signer_attachment_tabs, sign_here_tabs, smart_section_tabs, ssn_tabs, tab_groups, text_tabs, title_tabs, view_tabs, zip_tabs].hash
end
list_invalid_properties() click to toggle source

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons

# File lib/docusign_esign/models/template_tabs.rb, line 466
def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end
to_body() click to toggle source

to_body is an alias to to_hash (backward compatibility) @return [Hash] Returns the object in the form of hash

# File lib/docusign_esign/models/template_tabs.rb, line 605
def to_body
  to_hash
end
to_hash() click to toggle source

Returns the object in the form of hash @return [Hash] Returns the object in the form of hash

# File lib/docusign_esign/models/template_tabs.rb, line 611
def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    hash[param] = _to_hash(value)
  end
  hash
end
to_s() click to toggle source

Returns the string representation of the object @return [String] String presentation of the object

# File lib/docusign_esign/models/template_tabs.rb, line 599
def to_s
  to_hash.to_s
end
valid?() click to toggle source

Check to see if the all the properties in the model are valid @return true if the model is valid

# File lib/docusign_esign/models/template_tabs.rb, line 473
def valid?
  true
end