class DocuSign_Rooms::FieldConfiguration

Attributes

depends_on[RW]
is_publisher[RW]
max_length[RW]
max_value[RW]
min_length[RW]
min_value[RW]
multiple_of[RW]
options[RW]
pattern[RW]

Public Class Methods

attribute_map() click to toggle source

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

# File lib/docusign_rooms/models/field_configuration.rb, line 35
def self.attribute_map
  {
    :'max_value' => :'maxValue',
    :'min_value' => :'minValue',
    :'multiple_of' => :'multipleOf',
    :'max_length' => :'maxLength',
    :'min_length' => :'minLength',
    :'pattern' => :'pattern',
    :'is_publisher' => :'isPublisher',
    :'depends_on' => :'dependsOn',
    :'options' => :'options'
  }
end
new(attributes = {}) click to toggle source

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

# File lib/docusign_rooms/models/field_configuration.rb, line 66
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?(:'maxValue')
    self.max_value = attributes[:'maxValue']
  end

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

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

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

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

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

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

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

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

Attribute type mapping.

# File lib/docusign_rooms/models/field_configuration.rb, line 50
def self.swagger_types
  {
    :'max_value' => :'Float',
    :'min_value' => :'Float',
    :'multiple_of' => :'Float',
    :'max_length' => :'Integer',
    :'min_length' => :'Integer',
    :'pattern' => :'String',
    :'is_publisher' => :'BOOLEAN',
    :'depends_on' => :'Array<DependsOn>',
    :'options' => :'Array<SelectListFieldOption>'
  }
end

Public Instance Methods

==(o) click to toggle source

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

# File lib/docusign_rooms/models/field_configuration.rb, line 128
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      max_value == o.max_value &&
      min_value == o.min_value &&
      multiple_of == o.multiple_of &&
      max_length == o.max_length &&
      min_length == o.min_length &&
      pattern == o.pattern &&
      is_publisher == o.is_publisher &&
      depends_on == o.depends_on &&
      options == o.options
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_rooms/models/field_configuration.rb, line 178
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_Rooms.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_rooms/models/field_configuration.rb, line 244
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_rooms/models/field_configuration.rb, line 157
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_rooms/models/field_configuration.rb, line 144
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_rooms/models/field_configuration.rb, line 150
def hash
  [max_value, min_value, multiple_of, max_length, min_length, pattern, is_publisher, depends_on, options].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_rooms/models/field_configuration.rb, line 115
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_rooms/models/field_configuration.rb, line 224
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_rooms/models/field_configuration.rb, line 230
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_rooms/models/field_configuration.rb, line 218
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_rooms/models/field_configuration.rb, line 122
def valid?
  true
end