class DocuSign_eSign::ListCustomField

This object represents a list custom field from which envelope creators and senders can select custom data.

Attributes

configuration_type[RW]

If merge field's are being used, specifies the type of the merge field. The only supported value is *salesforce*.

error_details[RW]

Array or errors.

field_id[RW]

An ID used to specify a custom field.

list_items[RW]

name[RW]

The name of the custom field.

required[RW]

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

show[RW]

A boolean indicating if the value should be displayed.

value[RW]

The value of the custom field. Maximum Length: 100 characters.

Public Class Methods

attribute_map() click to toggle source

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

# File lib/docusign_esign/models/list_custom_field.rb, line 42
def self.attribute_map
  {
    :'configuration_type' => :'configurationType',
    :'error_details' => :'errorDetails',
    :'field_id' => :'fieldId',
    :'list_items' => :'listItems',
    :'name' => :'name',
    :'required' => :'required',
    :'show' => :'show',
    :'value' => :'value'
  }
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/list_custom_field.rb, line 71
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?(:'configurationType')
    self.configuration_type = attributes[:'configurationType']
  end

  if attributes.has_key?(:'errorDetails')
    self.error_details = attributes[:'errorDetails']
  end

  if attributes.has_key?(:'fieldId')
    self.field_id = attributes[:'fieldId']
  end

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

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

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

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

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

swagger_types() click to toggle source

Attribute type mapping.

# File lib/docusign_esign/models/list_custom_field.rb, line 56
def self.swagger_types
  {
    :'configuration_type' => :'String',
    :'error_details' => :'ErrorDetails',
    :'field_id' => :'String',
    :'list_items' => :'Array<String>',
    :'name' => :'String',
    :'required' => :'String',
    :'show' => :'String',
    :'value' => :'String'
  }
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/list_custom_field.rb, line 127
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      configuration_type == o.configuration_type &&
      error_details == o.error_details &&
      field_id == o.field_id &&
      list_items == o.list_items &&
      name == o.name &&
      required == o.required &&
      show == o.show &&
      value == o.value
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/list_custom_field.rb, line 176
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/list_custom_field.rb, line 242
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/list_custom_field.rb, line 155
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/list_custom_field.rb, line 142
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/list_custom_field.rb, line 148
def hash
  [configuration_type, error_details, field_id, list_items, name, required, show, value].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/list_custom_field.rb, line 114
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/list_custom_field.rb, line 222
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/list_custom_field.rb, line 228
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/list_custom_field.rb, line 216
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/list_custom_field.rb, line 121
def valid?
  true
end