class SmoochApi::Field
Attributes
The email response to an email field. Required for email fields in form response messages.
The field ID, generated automatically.
The label to be displayed with the field.
The maximum possible length of the response. Defaults to 128 if not specified. Only for text fields in form messages.
The minimum possible length of the response. Defaults to 1 if not specified. Only for text fields in form messages.
The name of the field. Each field name must be unique per form.
The field options that can be selected. The array is limited to 20 options. Only for select fields in form messages.
The placeholder text of the field that will be rendered. Only for form messages
The options selected as a response to a select field. Required for select fields in form response messages.
The select size, generated automatically. Only for select fields in form messages.
The text response to a text field. Required for text fields in form response messages.
The field type. See [FieldTypeEnum](Enums.md#FieldTypeEnum) for available values.
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/smooch-api/models/field.rb, line 56 def self.attribute_map { :'id' => :'_id', :'type' => :'type', :'name' => :'name', :'label' => :'label', :'placeholder' => :'placeholder', :'minSize' => :'minSize', :'maxSize' => :'maxSize', :'options' => :'options', :'selectSize' => :'selectSize', :'text' => :'text', :'email' => :'email', :'select' => :'select' } end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/smooch-api/models/field.rb, line 93 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?(:'_id') self.id = attributes[:'_id'] end if attributes.has_key?(:'type') self.type = attributes[:'type'] end if attributes.has_key?(:'name') self.name = attributes[:'name'] end if attributes.has_key?(:'label') self.label = attributes[:'label'] end if attributes.has_key?(:'placeholder') self.placeholder = attributes[:'placeholder'] end if attributes.has_key?(:'minSize') self.minSize = attributes[:'minSize'] end if attributes.has_key?(:'maxSize') self.maxSize = attributes[:'maxSize'] end if attributes.has_key?(:'options') if (value = attributes[:'options']).is_a?(Array) self.options = value end end if attributes.has_key?(:'selectSize') self.selectSize = attributes[:'selectSize'] end if attributes.has_key?(:'text') self.text = attributes[:'text'] end if attributes.has_key?(:'email') self.email = attributes[:'email'] end if attributes.has_key?(:'select') if (value = attributes[:'select']).is_a?(Array) self.select = value end end end
Attribute type mapping.
# File lib/smooch-api/models/field.rb, line 74 def self.swagger_types { :'id' => :'String', :'type' => :'String', :'name' => :'String', :'label' => :'String', :'placeholder' => :'String', :'minSize' => :'Integer', :'maxSize' => :'Integer', :'options' => :'Array<Option>', :'selectSize' => :'Integer', :'text' => :'String', :'email' => :'String', :'select' => :'Array<Select>' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/smooch-api/models/field.rb, line 183 def ==(o) return true if self.equal?(o) self.class == o.class && id == o.id && type == o.type && name == o.name && label == o.label && placeholder == o.placeholder && minSize == o.minSize && maxSize == o.maxSize && options == o.options && selectSize == o.selectSize && text == o.text && email == o.email && select == o.select end
Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data
# File lib/smooch-api/models/field.rb, line 236 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 = SmoochApi.const_get(type).new temp_model.build_from_hash(value) end end
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/smooch-api/models/field.rb, line 302 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
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
# File lib/smooch-api/models/field.rb, line 215 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 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
@see the `==` method @param [Object] Object to be compared
# File lib/smooch-api/models/field.rb, line 202 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/smooch-api/models/field.rb, line 208 def hash [id, type, name, label, placeholder, minSize, maxSize, options, selectSize, text, email, select].hash end
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properies with the reasons
# File lib/smooch-api/models/field.rb, line 155 def list_invalid_properties invalid_properties = Array.new if @type.nil? invalid_properties.push("invalid value for 'type', type cannot be nil.") end if @name.nil? invalid_properties.push("invalid value for 'name', name cannot be nil.") end if @label.nil? invalid_properties.push("invalid value for 'label', label cannot be nil.") end return invalid_properties end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/smooch-api/models/field.rb, line 288 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
Returns the string representation of the object @return [String] String presentation of the object
# File lib/smooch-api/models/field.rb, line 276 def to_s to_hash.to_s end
Check to see if the all the properties in the model are valid @return true if the model is valid
# File lib/smooch-api/models/field.rb, line 174 def valid? return false if @type.nil? return false if @name.nil? return false if @label.nil? return true end