Class: HappyCo::V1RatingControl
- Inherits:
-
Object
- Object
- HappyCo::V1RatingControl
- Defined in:
- lib/happyco_json/models/v1_rating_control.rb
Overview
Rating control describe a single control that a user can use to rate an item. There are currently 3 controls; a checkbox, radio group, and drop down.
Instance Attribute Summary collapse
-
#checkbox ⇒ Object
Returns the value of attribute checkbox.
-
#drop_down ⇒ Object
Returns the value of attribute drop_down.
-
#key ⇒ Object
-
Key is a required field.
-
-
#radio_group ⇒ Object
Returns the value of attribute radio_group.
Class Method Summary collapse
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.swagger_types ⇒ Object
Attribute type mapping.
Instance Method Summary collapse
-
#==(o) ⇒ Object
Checks equality by comparing each attribute.
-
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type.
-
#_to_hash(value) ⇒ Hash
Outputs non-array value in the form of hash For object, use to_hash.
-
#build_from_hash(attributes) ⇒ Object
Builds the object from hash.
- #eql?(o) ⇒ Boolean
-
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ V1RatingControl
constructor
Initializes the object.
-
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons.
-
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility).
-
#to_hash ⇒ Hash
Returns the object in the form of hash.
-
#to_s ⇒ String
Returns the string representation of the object.
-
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid.
Constructor Details
#initialize(attributes = {}) ⇒ V1RatingControl
Initializes the object
61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 |
# File 'lib/happyco_json/models/v1_rating_control.rb', line 61 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?(:'key') self.key = attributes[:'key'] end if attributes.has_key?(:'checkbox') self.checkbox = attributes[:'checkbox'] end if attributes.has_key?(:'radio_group') self.radio_group = attributes[:'radio_group'] end if attributes.has_key?(:'drop_down') self.drop_down = attributes[:'drop_down'] end end |
Instance Attribute Details
#checkbox ⇒ Object
Returns the value of attribute checkbox.
32 33 34 |
# File 'lib/happyco_json/models/v1_rating_control.rb', line 32 def checkbox @checkbox end |
#drop_down ⇒ Object
Returns the value of attribute drop_down.
36 37 38 |
# File 'lib/happyco_json/models/v1_rating_control.rb', line 36 def drop_down @drop_down end |
#key ⇒ Object
-
Key is a required field. It is used when a control has a selected value. The key and its selected value(s) will be inserted into an item’s values map field and the key and the selected score(s) will be inserted into the item’s scores map field. It is also the default string displayed to the user unless custom label(s) are set (see each control type).
30 31 32 |
# File 'lib/happyco_json/models/v1_rating_control.rb', line 30 def key @key end |
#radio_group ⇒ Object
Returns the value of attribute radio_group.
34 35 36 |
# File 'lib/happyco_json/models/v1_rating_control.rb', line 34 def radio_group @radio_group end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
40 41 42 43 44 45 46 47 |
# File 'lib/happyco_json/models/v1_rating_control.rb', line 40 def self.attribute_map { :'key' => :'key', :'checkbox' => :'checkbox', :'radio_group' => :'radio_group', :'drop_down' => :'drop_down' } end |
.swagger_types ⇒ Object
Attribute type mapping.
50 51 52 53 54 55 56 57 |
# File 'lib/happyco_json/models/v1_rating_control.rb', line 50 def self.swagger_types { :'key' => :'String', :'checkbox' => :'V1RatingCheckbox', :'radio_group' => :'V1RatingRadioGroup', :'drop_down' => :'V1RatingDropDown' } end |
Instance Method Details
#==(o) ⇒ Object
Checks equality by comparing each attribute.
100 101 102 103 104 105 106 107 |
# File 'lib/happyco_json/models/v1_rating_control.rb', line 100 def ==(o) return true if self.equal?(o) self.class == o.class && key == o.key && checkbox == o.checkbox && radio_group == o.radio_group && drop_down == o.drop_down end |
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type
145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 |
# File 'lib/happyco_json/models/v1_rating_control.rb', line 145 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 =~ /^(true|t|yes|y|1)$/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 = HappyCo.const_get(type).new temp_model.build_from_hash(value) end end |
#_to_hash(value) ⇒ Hash
Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value
211 212 213 214 215 216 217 218 219 220 221 222 223 |
# File 'lib/happyco_json/models/v1_rating_control.rb', line 211 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) ⇒ Object
Builds the object from hash
124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 |
# File 'lib/happyco_json/models/v1_rating_control.rb', line 124 def build_from_hash(attributes) return nil unless attributes.is_a?(Hash) self.class.swagger_types.each_pair do |key, type| if type =~ /^Array<(.*)>/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 |
#eql?(o) ⇒ Boolean
111 112 113 |
# File 'lib/happyco_json/models/v1_rating_control.rb', line 111 def eql?(o) self == o end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
117 118 119 |
# File 'lib/happyco_json/models/v1_rating_control.rb', line 117 def hash [key, checkbox, radio_group, drop_down].hash end |
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons. Usually used together with valid?
87 88 89 90 |
# File 'lib/happyco_json/models/v1_rating_control.rb', line 87 def list_invalid_properties invalid_properties = Array.new return invalid_properties end |
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility)
191 192 193 |
# File 'lib/happyco_json/models/v1_rating_control.rb', line 191 def to_body to_hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
197 198 199 200 201 202 203 204 205 |
# File 'lib/happyco_json/models/v1_rating_control.rb', line 197 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 ⇒ String
Returns the string representation of the object
185 186 187 |
# File 'lib/happyco_json/models/v1_rating_control.rb', line 185 def to_s to_hash.to_s end |
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
94 95 96 |
# File 'lib/happyco_json/models/v1_rating_control.rb', line 94 def valid? return true end |