class DocuSign_eSign::TabAccountSettings

Attributes

allow_tab_order[RW]

allow_tab_order_metadata[RW]

approve_decline_tabs_enabled[RW]

approve_decline_tabs_metadata[RW]

calculated_fields_enabled[RW]

calculated_fields_metadata[RW]

check_box_tabs_metadata[RW]

checkbox_tabs_enabled[RW]

currency_tabs_enabled[RW]

currency_tabs_metadata[RW]

data_field_regex_enabled[RW]

data_field_regex_metadata[RW]

data_field_size_enabled[RW]

data_field_size_metadata[RW]

draw_tabs_enabled[RW]

draw_tabs_metadata[RW]

first_last_email_tabs_enabled[RW]

first_last_email_tabs_metadata[RW]

list_tabs_enabled[RW]

list_tabs_metadata[RW]

note_tabs_enabled[RW]

note_tabs_metadata[RW]

prefill_tabs_enabled[RW]

prefill_tabs_metadata[RW]

radio_tabs_enabled[RW]

radio_tabs_metadata[RW]

saving_custom_tabs_enabled[RW]

saving_custom_tabs_metadata[RW]

sender_to_change_tab_assignments_enabled[RW]

sender_to_change_tab_assignments_metadata[RW]

shared_custom_tabs_enabled[RW]

shared_custom_tabs_metadata[RW]

tab_data_label_enabled[RW]

tab_data_label_metadata[RW]

tab_location_enabled[RW]

tab_location_metadata[RW]

tab_locking_enabled[RW]

tab_locking_metadata[RW]

tab_scale_enabled[RW]

tab_scale_metadata[RW]

tab_text_formatting_enabled[RW]

tab_text_formatting_metadata[RW]

text_tabs_enabled[RW]

text_tabs_metadata[RW]

Public Class Methods

attribute_map() click to toggle source

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

# File lib/docusign_esign/models/tab_account_settings.rb, line 127
def self.attribute_map
  {
    :'allow_tab_order' => :'allowTabOrder',
    :'allow_tab_order_metadata' => :'allowTabOrderMetadata',
    :'approve_decline_tabs_enabled' => :'approveDeclineTabsEnabled',
    :'approve_decline_tabs_metadata' => :'approveDeclineTabsMetadata',
    :'calculated_fields_enabled' => :'calculatedFieldsEnabled',
    :'calculated_fields_metadata' => :'calculatedFieldsMetadata',
    :'checkbox_tabs_enabled' => :'checkboxTabsEnabled',
    :'check_box_tabs_metadata' => :'checkBoxTabsMetadata',
    :'currency_tabs_enabled' => :'currencyTabsEnabled',
    :'currency_tabs_metadata' => :'currencyTabsMetadata',
    :'data_field_regex_enabled' => :'dataFieldRegexEnabled',
    :'data_field_regex_metadata' => :'dataFieldRegexMetadata',
    :'data_field_size_enabled' => :'dataFieldSizeEnabled',
    :'data_field_size_metadata' => :'dataFieldSizeMetadata',
    :'draw_tabs_enabled' => :'drawTabsEnabled',
    :'draw_tabs_metadata' => :'drawTabsMetadata',
    :'first_last_email_tabs_enabled' => :'firstLastEmailTabsEnabled',
    :'first_last_email_tabs_metadata' => :'firstLastEmailTabsMetadata',
    :'list_tabs_enabled' => :'listTabsEnabled',
    :'list_tabs_metadata' => :'listTabsMetadata',
    :'note_tabs_enabled' => :'noteTabsEnabled',
    :'note_tabs_metadata' => :'noteTabsMetadata',
    :'prefill_tabs_enabled' => :'prefillTabsEnabled',
    :'prefill_tabs_metadata' => :'prefillTabsMetadata',
    :'radio_tabs_enabled' => :'radioTabsEnabled',
    :'radio_tabs_metadata' => :'radioTabsMetadata',
    :'saving_custom_tabs_enabled' => :'savingCustomTabsEnabled',
    :'saving_custom_tabs_metadata' => :'savingCustomTabsMetadata',
    :'sender_to_change_tab_assignments_enabled' => :'senderToChangeTabAssignmentsEnabled',
    :'sender_to_change_tab_assignments_metadata' => :'senderToChangeTabAssignmentsMetadata',
    :'shared_custom_tabs_enabled' => :'sharedCustomTabsEnabled',
    :'shared_custom_tabs_metadata' => :'sharedCustomTabsMetadata',
    :'tab_data_label_enabled' => :'tabDataLabelEnabled',
    :'tab_data_label_metadata' => :'tabDataLabelMetadata',
    :'tab_location_enabled' => :'tabLocationEnabled',
    :'tab_location_metadata' => :'tabLocationMetadata',
    :'tab_locking_enabled' => :'tabLockingEnabled',
    :'tab_locking_metadata' => :'tabLockingMetadata',
    :'tab_scale_enabled' => :'tabScaleEnabled',
    :'tab_scale_metadata' => :'tabScaleMetadata',
    :'tab_text_formatting_enabled' => :'tabTextFormattingEnabled',
    :'tab_text_formatting_metadata' => :'tabTextFormattingMetadata',
    :'text_tabs_enabled' => :'textTabsEnabled',
    :'text_tabs_metadata' => :'textTabsMetadata'
  }
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/tab_account_settings.rb, line 228
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?(:'allowTabOrder')
    self.allow_tab_order = attributes[:'allowTabOrder']
  end

  if attributes.has_key?(:'allowTabOrderMetadata')
    self.allow_tab_order_metadata = attributes[:'allowTabOrderMetadata']
  end

  if attributes.has_key?(:'approveDeclineTabsEnabled')
    self.approve_decline_tabs_enabled = attributes[:'approveDeclineTabsEnabled']
  end

  if attributes.has_key?(:'approveDeclineTabsMetadata')
    self.approve_decline_tabs_metadata = attributes[:'approveDeclineTabsMetadata']
  end

  if attributes.has_key?(:'calculatedFieldsEnabled')
    self.calculated_fields_enabled = attributes[:'calculatedFieldsEnabled']
  end

  if attributes.has_key?(:'calculatedFieldsMetadata')
    self.calculated_fields_metadata = attributes[:'calculatedFieldsMetadata']
  end

  if attributes.has_key?(:'checkboxTabsEnabled')
    self.checkbox_tabs_enabled = attributes[:'checkboxTabsEnabled']
  end

  if attributes.has_key?(:'checkBoxTabsMetadata')
    self.check_box_tabs_metadata = attributes[:'checkBoxTabsMetadata']
  end

  if attributes.has_key?(:'currencyTabsEnabled')
    self.currency_tabs_enabled = attributes[:'currencyTabsEnabled']
  end

  if attributes.has_key?(:'currencyTabsMetadata')
    self.currency_tabs_metadata = attributes[:'currencyTabsMetadata']
  end

  if attributes.has_key?(:'dataFieldRegexEnabled')
    self.data_field_regex_enabled = attributes[:'dataFieldRegexEnabled']
  end

  if attributes.has_key?(:'dataFieldRegexMetadata')
    self.data_field_regex_metadata = attributes[:'dataFieldRegexMetadata']
  end

  if attributes.has_key?(:'dataFieldSizeEnabled')
    self.data_field_size_enabled = attributes[:'dataFieldSizeEnabled']
  end

  if attributes.has_key?(:'dataFieldSizeMetadata')
    self.data_field_size_metadata = attributes[:'dataFieldSizeMetadata']
  end

  if attributes.has_key?(:'drawTabsEnabled')
    self.draw_tabs_enabled = attributes[:'drawTabsEnabled']
  end

  if attributes.has_key?(:'drawTabsMetadata')
    self.draw_tabs_metadata = attributes[:'drawTabsMetadata']
  end

  if attributes.has_key?(:'firstLastEmailTabsEnabled')
    self.first_last_email_tabs_enabled = attributes[:'firstLastEmailTabsEnabled']
  end

  if attributes.has_key?(:'firstLastEmailTabsMetadata')
    self.first_last_email_tabs_metadata = attributes[:'firstLastEmailTabsMetadata']
  end

  if attributes.has_key?(:'listTabsEnabled')
    self.list_tabs_enabled = attributes[:'listTabsEnabled']
  end

  if attributes.has_key?(:'listTabsMetadata')
    self.list_tabs_metadata = attributes[:'listTabsMetadata']
  end

  if attributes.has_key?(:'noteTabsEnabled')
    self.note_tabs_enabled = attributes[:'noteTabsEnabled']
  end

  if attributes.has_key?(:'noteTabsMetadata')
    self.note_tabs_metadata = attributes[:'noteTabsMetadata']
  end

  if attributes.has_key?(:'prefillTabsEnabled')
    self.prefill_tabs_enabled = attributes[:'prefillTabsEnabled']
  end

  if attributes.has_key?(:'prefillTabsMetadata')
    self.prefill_tabs_metadata = attributes[:'prefillTabsMetadata']
  end

  if attributes.has_key?(:'radioTabsEnabled')
    self.radio_tabs_enabled = attributes[:'radioTabsEnabled']
  end

  if attributes.has_key?(:'radioTabsMetadata')
    self.radio_tabs_metadata = attributes[:'radioTabsMetadata']
  end

  if attributes.has_key?(:'savingCustomTabsEnabled')
    self.saving_custom_tabs_enabled = attributes[:'savingCustomTabsEnabled']
  end

  if attributes.has_key?(:'savingCustomTabsMetadata')
    self.saving_custom_tabs_metadata = attributes[:'savingCustomTabsMetadata']
  end

  if attributes.has_key?(:'senderToChangeTabAssignmentsEnabled')
    self.sender_to_change_tab_assignments_enabled = attributes[:'senderToChangeTabAssignmentsEnabled']
  end

  if attributes.has_key?(:'senderToChangeTabAssignmentsMetadata')
    self.sender_to_change_tab_assignments_metadata = attributes[:'senderToChangeTabAssignmentsMetadata']
  end

  if attributes.has_key?(:'sharedCustomTabsEnabled')
    self.shared_custom_tabs_enabled = attributes[:'sharedCustomTabsEnabled']
  end

  if attributes.has_key?(:'sharedCustomTabsMetadata')
    self.shared_custom_tabs_metadata = attributes[:'sharedCustomTabsMetadata']
  end

  if attributes.has_key?(:'tabDataLabelEnabled')
    self.tab_data_label_enabled = attributes[:'tabDataLabelEnabled']
  end

  if attributes.has_key?(:'tabDataLabelMetadata')
    self.tab_data_label_metadata = attributes[:'tabDataLabelMetadata']
  end

  if attributes.has_key?(:'tabLocationEnabled')
    self.tab_location_enabled = attributes[:'tabLocationEnabled']
  end

  if attributes.has_key?(:'tabLocationMetadata')
    self.tab_location_metadata = attributes[:'tabLocationMetadata']
  end

  if attributes.has_key?(:'tabLockingEnabled')
    self.tab_locking_enabled = attributes[:'tabLockingEnabled']
  end

  if attributes.has_key?(:'tabLockingMetadata')
    self.tab_locking_metadata = attributes[:'tabLockingMetadata']
  end

  if attributes.has_key?(:'tabScaleEnabled')
    self.tab_scale_enabled = attributes[:'tabScaleEnabled']
  end

  if attributes.has_key?(:'tabScaleMetadata')
    self.tab_scale_metadata = attributes[:'tabScaleMetadata']
  end

  if attributes.has_key?(:'tabTextFormattingEnabled')
    self.tab_text_formatting_enabled = attributes[:'tabTextFormattingEnabled']
  end

  if attributes.has_key?(:'tabTextFormattingMetadata')
    self.tab_text_formatting_metadata = attributes[:'tabTextFormattingMetadata']
  end

  if attributes.has_key?(:'textTabsEnabled')
    self.text_tabs_enabled = attributes[:'textTabsEnabled']
  end

  if attributes.has_key?(:'textTabsMetadata')
    self.text_tabs_metadata = attributes[:'textTabsMetadata']
  end
end

swagger_types() click to toggle source

Attribute type mapping.

# File lib/docusign_esign/models/tab_account_settings.rb, line 177
def self.swagger_types
  {
    :'allow_tab_order' => :'String',
    :'allow_tab_order_metadata' => :'SettingsMetadata',
    :'approve_decline_tabs_enabled' => :'String',
    :'approve_decline_tabs_metadata' => :'SettingsMetadata',
    :'calculated_fields_enabled' => :'String',
    :'calculated_fields_metadata' => :'SettingsMetadata',
    :'checkbox_tabs_enabled' => :'String',
    :'check_box_tabs_metadata' => :'SettingsMetadata',
    :'currency_tabs_enabled' => :'String',
    :'currency_tabs_metadata' => :'SettingsMetadata',
    :'data_field_regex_enabled' => :'String',
    :'data_field_regex_metadata' => :'SettingsMetadata',
    :'data_field_size_enabled' => :'String',
    :'data_field_size_metadata' => :'SettingsMetadata',
    :'draw_tabs_enabled' => :'String',
    :'draw_tabs_metadata' => :'SettingsMetadata',
    :'first_last_email_tabs_enabled' => :'String',
    :'first_last_email_tabs_metadata' => :'SettingsMetadata',
    :'list_tabs_enabled' => :'String',
    :'list_tabs_metadata' => :'SettingsMetadata',
    :'note_tabs_enabled' => :'String',
    :'note_tabs_metadata' => :'SettingsMetadata',
    :'prefill_tabs_enabled' => :'String',
    :'prefill_tabs_metadata' => :'SettingsMetadata',
    :'radio_tabs_enabled' => :'String',
    :'radio_tabs_metadata' => :'SettingsMetadata',
    :'saving_custom_tabs_enabled' => :'String',
    :'saving_custom_tabs_metadata' => :'SettingsMetadata',
    :'sender_to_change_tab_assignments_enabled' => :'String',
    :'sender_to_change_tab_assignments_metadata' => :'SettingsMetadata',
    :'shared_custom_tabs_enabled' => :'String',
    :'shared_custom_tabs_metadata' => :'SettingsMetadata',
    :'tab_data_label_enabled' => :'String',
    :'tab_data_label_metadata' => :'SettingsMetadata',
    :'tab_location_enabled' => :'String',
    :'tab_location_metadata' => :'SettingsMetadata',
    :'tab_locking_enabled' => :'String',
    :'tab_locking_metadata' => :'SettingsMetadata',
    :'tab_scale_enabled' => :'String',
    :'tab_scale_metadata' => :'SettingsMetadata',
    :'tab_text_formatting_enabled' => :'String',
    :'tab_text_formatting_metadata' => :'SettingsMetadata',
    :'text_tabs_enabled' => :'String',
    :'text_tabs_metadata' => :'SettingsMetadata'
  }
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/tab_account_settings.rb, line 426
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      allow_tab_order == o.allow_tab_order &&
      allow_tab_order_metadata == o.allow_tab_order_metadata &&
      approve_decline_tabs_enabled == o.approve_decline_tabs_enabled &&
      approve_decline_tabs_metadata == o.approve_decline_tabs_metadata &&
      calculated_fields_enabled == o.calculated_fields_enabled &&
      calculated_fields_metadata == o.calculated_fields_metadata &&
      checkbox_tabs_enabled == o.checkbox_tabs_enabled &&
      check_box_tabs_metadata == o.check_box_tabs_metadata &&
      currency_tabs_enabled == o.currency_tabs_enabled &&
      currency_tabs_metadata == o.currency_tabs_metadata &&
      data_field_regex_enabled == o.data_field_regex_enabled &&
      data_field_regex_metadata == o.data_field_regex_metadata &&
      data_field_size_enabled == o.data_field_size_enabled &&
      data_field_size_metadata == o.data_field_size_metadata &&
      draw_tabs_enabled == o.draw_tabs_enabled &&
      draw_tabs_metadata == o.draw_tabs_metadata &&
      first_last_email_tabs_enabled == o.first_last_email_tabs_enabled &&
      first_last_email_tabs_metadata == o.first_last_email_tabs_metadata &&
      list_tabs_enabled == o.list_tabs_enabled &&
      list_tabs_metadata == o.list_tabs_metadata &&
      note_tabs_enabled == o.note_tabs_enabled &&
      note_tabs_metadata == o.note_tabs_metadata &&
      prefill_tabs_enabled == o.prefill_tabs_enabled &&
      prefill_tabs_metadata == o.prefill_tabs_metadata &&
      radio_tabs_enabled == o.radio_tabs_enabled &&
      radio_tabs_metadata == o.radio_tabs_metadata &&
      saving_custom_tabs_enabled == o.saving_custom_tabs_enabled &&
      saving_custom_tabs_metadata == o.saving_custom_tabs_metadata &&
      sender_to_change_tab_assignments_enabled == o.sender_to_change_tab_assignments_enabled &&
      sender_to_change_tab_assignments_metadata == o.sender_to_change_tab_assignments_metadata &&
      shared_custom_tabs_enabled == o.shared_custom_tabs_enabled &&
      shared_custom_tabs_metadata == o.shared_custom_tabs_metadata &&
      tab_data_label_enabled == o.tab_data_label_enabled &&
      tab_data_label_metadata == o.tab_data_label_metadata &&
      tab_location_enabled == o.tab_location_enabled &&
      tab_location_metadata == o.tab_location_metadata &&
      tab_locking_enabled == o.tab_locking_enabled &&
      tab_locking_metadata == o.tab_locking_metadata &&
      tab_scale_enabled == o.tab_scale_enabled &&
      tab_scale_metadata == o.tab_scale_metadata &&
      tab_text_formatting_enabled == o.tab_text_formatting_enabled &&
      tab_text_formatting_metadata == o.tab_text_formatting_metadata &&
      text_tabs_enabled == o.text_tabs_enabled &&
      text_tabs_metadata == o.text_tabs_metadata
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/tab_account_settings.rb, line 511
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/tab_account_settings.rb, line 577
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/tab_account_settings.rb, line 490
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/tab_account_settings.rb, line 477
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/tab_account_settings.rb, line 483
def hash
  [allow_tab_order, allow_tab_order_metadata, approve_decline_tabs_enabled, approve_decline_tabs_metadata, calculated_fields_enabled, calculated_fields_metadata, checkbox_tabs_enabled, check_box_tabs_metadata, currency_tabs_enabled, currency_tabs_metadata, data_field_regex_enabled, data_field_regex_metadata, data_field_size_enabled, data_field_size_metadata, draw_tabs_enabled, draw_tabs_metadata, first_last_email_tabs_enabled, first_last_email_tabs_metadata, list_tabs_enabled, list_tabs_metadata, note_tabs_enabled, note_tabs_metadata, prefill_tabs_enabled, prefill_tabs_metadata, radio_tabs_enabled, radio_tabs_metadata, saving_custom_tabs_enabled, saving_custom_tabs_metadata, sender_to_change_tab_assignments_enabled, sender_to_change_tab_assignments_metadata, shared_custom_tabs_enabled, shared_custom_tabs_metadata, tab_data_label_enabled, tab_data_label_metadata, tab_location_enabled, tab_location_metadata, tab_locking_enabled, tab_locking_metadata, tab_scale_enabled, tab_scale_metadata, tab_text_formatting_enabled, tab_text_formatting_metadata, text_tabs_enabled, text_tabs_metadata].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/tab_account_settings.rb, line 413
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/tab_account_settings.rb, line 557
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/tab_account_settings.rb, line 563
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/tab_account_settings.rb, line 551
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/tab_account_settings.rb, line 420
def valid?
  true
end