class SunshineConversationsClient::Field
Properties that can be expected to receive inside a form or formResponse message field.
Attributes
Specifies the response for a email field.
The maximum allowed length for the response for a field of type text. form message only.
The minimum allowed length for the response for a field of type text. form message only.
The name of the field. Must be unique per form or formResponse.
Array of objects representing options for a field of type select.
Placeholder text for the field. form message only.
Array of objects representing the response for a field of type select. form and formResponse messages only.
Specifies the response for a text field.
The field type.
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/sunshine-conversations-client/models/field.rb, line 68 def self.attribute_map { :'type' => :'type', :'name' => :'name', :'label' => :'label', :'placeholder' => :'placeholder', :'min_size' => :'minSize', :'max_size' => :'maxSize', :'text' => :'text', :'email' => :'email', :'select' => :'select', :'options' => :'options' } end
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
# File lib/sunshine-conversations-client/models/field.rb, line 411 def self.build_from_hash(attributes) new.build_from_hash(attributes) end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/sunshine-conversations-client/models/field.rb, line 107 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `SunshineConversationsClient::Field` initialize method" end # check to see if the attribute exists and convert string to symbol for hash key attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.attribute_map.key?(k.to_sym)) fail ArgumentError, "`#{k}` is not a valid attribute in `SunshineConversationsClient::Field`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect end h[k.to_sym] = v } if attributes.key?(:'type') self.type = attributes[:'type'] end if attributes.key?(:'name') self.name = attributes[:'name'] end if attributes.key?(:'label') self.label = attributes[:'label'] end if attributes.key?(:'placeholder') self.placeholder = attributes[:'placeholder'] end if attributes.key?(:'min_size') self.min_size = attributes[:'min_size'] else self.min_size = 1 end if attributes.key?(:'max_size') self.max_size = attributes[:'max_size'] else self.max_size = 128 end if attributes.key?(:'text') self.text = attributes[:'text'] end if attributes.key?(:'email') self.email = attributes[:'email'] end if attributes.key?(:'select') end if attributes.key?(:'options') end end
List of attributes with nullable: true
# File lib/sunshine-conversations-client/models/field.rb, line 100 def self.openapi_nullable Set.new([ ]) end
Attribute type mapping.
# File lib/sunshine-conversations-client/models/field.rb, line 84 def self.openapi_types { :'type' => :'String', :'name' => :'String', :'label' => :'String', :'placeholder' => :'String', :'min_size' => :'Integer', :'max_size' => :'Integer', :'text' => :'String', :'email' => :'String', :'select' => :'Array<Object>', :'options' => :'Array<Object>' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/sunshine-conversations-client/models/field.rb, line 381 def ==(o) return true if self.equal?(o) self.class == o.class && type == o.type && name == o.name && label == o.label && placeholder == o.placeholder && min_size == o.min_size && max_size == o.max_size && text == o.text && email == o.email && select == o.select && options == o.options 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/sunshine-conversations-client/models/field.rb, line 439 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 SunshineConversationsClient.const_get(type).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/sunshine-conversations-client/models/field.rb, line 508 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/sunshine-conversations-client/models/field.rb, line 418 def build_from_hash(attributes) return nil unless attributes.is_a?(Hash) self.class.openapi_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
Custom
attribute writer method with validation @param [Object] email Value to be assigned
# File lib/sunshine-conversations-client/models/field.rb, line 367 def email=(email) if !email.nil? && email.to_s.length > 128 fail ArgumentError, 'invalid value for "email", the character length must be smaller than or equal to 128.' end if !email.nil? && email.to_s.length < 1 fail ArgumentError, 'invalid value for "email", the character length must be great than or equal to 1.' end @email = email end
@see the `==` method @param [Object] Object to be compared
# File lib/sunshine-conversations-client/models/field.rb, line 398 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Integer] Hash code
# File lib/sunshine-conversations-client/models/field.rb, line 404 def hash [type, name, label, placeholder, min_size, max_size, text, email, select, options].hash end
Custom
attribute writer method with validation @param [Object] label Value to be assigned
# File lib/sunshine-conversations-client/models/field.rb, line 293 def label=(label) if label.nil? fail ArgumentError, 'label cannot be nil' end if label.to_s.length > 128 fail ArgumentError, 'invalid value for "label", the character length must be smaller than or equal to 128.' end if label.to_s.length < 1 fail ArgumentError, 'invalid value for "label", the character length must be great than or equal to 1.' end @label = label end
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons
# File lib/sunshine-conversations-client/models/field.rb, line 165 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 @name.to_s.length > 128 invalid_properties.push('invalid value for "name", the character length must be smaller than or equal to 128.') end if @name.to_s.length < 1 invalid_properties.push('invalid value for "name", the character length must be great than or equal to 1.') end if @label.nil? invalid_properties.push('invalid value for "label", label cannot be nil.') end if @label.to_s.length > 128 invalid_properties.push('invalid value for "label", the character length must be smaller than or equal to 128.') end if @label.to_s.length < 1 invalid_properties.push('invalid value for "label", the character length must be great than or equal to 1.') end if !@placeholder.nil? && @placeholder.to_s.length > 128 invalid_properties.push('invalid value for "placeholder", the character length must be smaller than or equal to 128.') end if !@placeholder.nil? && @placeholder.to_s.length < 1 invalid_properties.push('invalid value for "placeholder", the character length must be great than or equal to 1.') end if !@min_size.nil? && @min_size > 128 invalid_properties.push('invalid value for "min_size", must be smaller than or equal to 128.') end if !@min_size.nil? && @min_size < 1 invalid_properties.push('invalid value for "min_size", must be greater than or equal to 1.') end if !@max_size.nil? && @max_size > 128 invalid_properties.push('invalid value for "max_size", must be smaller than or equal to 128.') end if !@max_size.nil? && @max_size < 1 invalid_properties.push('invalid value for "max_size", must be greater than or equal to 1.') end if !@text.nil? && @text.to_s.length > 128 invalid_properties.push('invalid value for "text", the character length must be smaller than or equal to 128.') end if !@text.nil? && @text.to_s.length < 1 invalid_properties.push('invalid value for "text", the character length must be great than or equal to 1.') end if !@email.nil? && @email.to_s.length > 128 invalid_properties.push('invalid value for "email", the character length must be smaller than or equal to 128.') end if !@email.nil? && @email.to_s.length < 1 invalid_properties.push('invalid value for "email", the character length must be great than or equal to 1.') end invalid_properties end
Custom
attribute writer method with validation @param [Object] max_size
Value to be assigned
# File lib/sunshine-conversations-client/models/field.rb, line 339 def max_size=(max_size) if !max_size.nil? && max_size > 128 fail ArgumentError, 'invalid value for "max_size", must be smaller than or equal to 128.' end if !max_size.nil? && max_size < 1 fail ArgumentError, 'invalid value for "max_size", must be greater than or equal to 1.' end @max_size = max_size end
Custom
attribute writer method with validation @param [Object] min_size
Value to be assigned
# File lib/sunshine-conversations-client/models/field.rb, line 325 def min_size=(min_size) if !min_size.nil? && min_size > 128 fail ArgumentError, 'invalid value for "min_size", must be smaller than or equal to 128.' end if !min_size.nil? && min_size < 1 fail ArgumentError, 'invalid value for "min_size", must be greater than or equal to 1.' end @min_size = min_size end
Custom
attribute writer method with validation @param [Object] name Value to be assigned
# File lib/sunshine-conversations-client/models/field.rb, line 275 def name=(name) if name.nil? fail ArgumentError, 'name cannot be nil' end if name.to_s.length > 128 fail ArgumentError, 'invalid value for "name", the character length must be smaller than or equal to 128.' end if name.to_s.length < 1 fail ArgumentError, 'invalid value for "name", the character length must be great than or equal to 1.' end @name = name end
Custom
attribute writer method with validation @param [Object] placeholder Value to be assigned
# File lib/sunshine-conversations-client/models/field.rb, line 311 def placeholder=(placeholder) if !placeholder.nil? && placeholder.to_s.length > 128 fail ArgumentError, 'invalid value for "placeholder", the character length must be smaller than or equal to 128.' end if !placeholder.nil? && placeholder.to_s.length < 1 fail ArgumentError, 'invalid value for "placeholder", the character length must be great than or equal to 1.' end @placeholder = placeholder end
Custom
attribute writer method with validation @param [Object] text Value to be assigned
# File lib/sunshine-conversations-client/models/field.rb, line 353 def text=(text) if !text.nil? && text.to_s.length > 128 fail ArgumentError, 'invalid value for "text", the character length must be smaller than or equal to 128.' end if !text.nil? && text.to_s.length < 1 fail ArgumentError, 'invalid value for "text", the character length must be great than or equal to 1.' end @text = text end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/sunshine-conversations-client/models/field.rb, line 490 def to_hash hash = {} self.class.attribute_map.each_pair do |attr, param| value = self.send(attr) if value.nil? is_nullable = self.class.openapi_nullable.include?(attr) next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}")) end hash[param] = _to_hash(value) end hash end
Returns the string representation of the object @return [String] String presentation of the object
# File lib/sunshine-conversations-client/models/field.rb, line 478 def to_s to_hash.to_s end
Custom
attribute writer method checking allowed values (enum). @param [Object] type Object to be assigned
# File lib/sunshine-conversations-client/models/field.rb, line 265 def type=(type) validator = EnumAttributeValidator.new('String', ["email", "select", "text"]) unless validator.valid?(type) fail ArgumentError, "invalid value for \"type\", must be one of #{validator.allowable_values}." end @type = type end
Check to see if the all the properties in the model are valid @return true if the model is valid
# File lib/sunshine-conversations-client/models/field.rb, line 240 def valid? return false if @type.nil? type_validator = EnumAttributeValidator.new('String', ["email", "select", "text"]) return false unless type_validator.valid?(@type) return false if @name.nil? return false if @name.to_s.length > 128 return false if @name.to_s.length < 1 return false if @label.nil? return false if @label.to_s.length > 128 return false if @label.to_s.length < 1 return false if !@placeholder.nil? && @placeholder.to_s.length > 128 return false if !@placeholder.nil? && @placeholder.to_s.length < 1 return false if !@min_size.nil? && @min_size > 128 return false if !@min_size.nil? && @min_size < 1 return false if !@max_size.nil? && @max_size > 128 return false if !@max_size.nil? && @max_size < 1 return false if !@text.nil? && @text.to_s.length > 128 return false if !@text.nil? && @text.to_s.length < 1 return false if !@email.nil? && @email.to_s.length > 128 return false if !@email.nil? && @email.to_s.length < 1 true end