Class: HappyCo::V1RatingDropDownOption

Inherits:
Object
  • Object
show all
Defined in:
lib/happyco_json/models/v1_rating_drop_down_option.rb

Overview

  • Rating drop down options represent one of the selectable options in a drop down.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ V1RatingDropDownOption

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
 
# File 'lib/happyco_json/models/v1_rating_drop_down_option.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?(:'label')
    self.label = attributes[:'label']
  end

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

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

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

  if attributes.has_key?(:'image')
    self.image = attributes[:'image']
  else
    self.image = "UNDEFINED"
  end

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

end

Instance Attribute Details

#color ⇒ Object

Returns the value of attribute color.



38
39
40
 
# File 'lib/happyco_json/models/v1_rating_drop_down_option.rb', line 38

def color
  @color
end

#image ⇒ Object

Returns the value of attribute image.



40
41
42
 
# File 'lib/happyco_json/models/v1_rating_drop_down_option.rb', line 40

def image
  @image
end

#label ⇒ Object

  • Label is an optional field that will override the value as the defaul option to be displayed to the user for this option. This is useful for localization of inspections.



30
31
32
 
# File 'lib/happyco_json/models/v1_rating_drop_down_option.rb', line 30

def label
  @label
end

#minimum_photos ⇒ Object

  • Minimum Photos is the minimum number of photos required to fulfil an item that has this drop down option selected.



43
44
45
 
# File 'lib/happyco_json/models/v1_rating_drop_down_option.rb', line 43

def minimum_photos
  @minimum_photos
end

#score ⇒ Object

  • Score is an optional field that will be inserted into the item and can be shown on reports if this drop down option is selected.



36
37
38
 
# File 'lib/happyco_json/models/v1_rating_drop_down_option.rb', line 36

def score
  @score
end

#value ⇒ Object

  • Value is a required field that will be inserted into the item and shown on reports if this radio option is selected. No two options in the same drop down can have the same value.



33
34
35
 
# File 'lib/happyco_json/models/v1_rating_drop_down_option.rb', line 33

def value
  @value
end

Class Method Details

.attribute_map ⇒ Object

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



68
69
70
71
72
73
74
75
76
77
 
# File 'lib/happyco_json/models/v1_rating_drop_down_option.rb', line 68

def self.attribute_map
  {
    :'label' => :'label',
    :'value' => :'value',
    :'score' => :'score',
    :'color' => :'color',
    :'image' => :'image',
    :'minimum_photos' => :'minimum_photos'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



80
81
82
83
84
85
86
87
88
89
 
# File 'lib/happyco_json/models/v1_rating_drop_down_option.rb', line 80

def self.swagger_types
  {
    :'label' => :'String',
    :'value' => :'String',
    :'score' => :'Float',
    :'color' => :'String',
    :'image' => :'String',
    :'minimum_photos' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



154
155
156
157
158
159
160
161
162
163
 
# File 'lib/happyco_json/models/v1_rating_drop_down_option.rb', line 154

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      label == o.label &&
      value == o.value &&
      score == o.score &&
      color == o.color &&
      image == o.image &&
      minimum_photos == o.minimum_photos
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
 
# File 'lib/happyco_json/models/v1_rating_drop_down_option.rb', line 201

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

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



267
268
269
270
271
272
273
274
275
276
277
278
279
 
# File 'lib/happyco_json/models/v1_rating_drop_down_option.rb', line 267

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

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
 
# File 'lib/happyco_json/models/v1_rating_drop_down_option.rb', line 180

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

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


167
168
169
 
# File 'lib/happyco_json/models/v1_rating_drop_down_option.rb', line 167

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



173
174
175
 
# File 'lib/happyco_json/models/v1_rating_drop_down_option.rb', line 173

def hash
  [label, value, score, color, image, minimum_photos].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properies with the reasons



129
130
131
132
 
# File 'lib/happyco_json/models/v1_rating_drop_down_option.rb', line 129

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)

Returns:

  • (Hash) —

    Returns the object in the form of hash



247
248
249
 
# File 'lib/happyco_json/models/v1_rating_drop_down_option.rb', line 247

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



253
254
255
256
257
258
259
260
261
 
# File 'lib/happyco_json/models/v1_rating_drop_down_option.rb', line 253

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

Returns:

  • (String) —

    String presentation of the object



241
242
243
 
# File 'lib/happyco_json/models/v1_rating_drop_down_option.rb', line 241

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



136
137
138
139
140
 
# File 'lib/happyco_json/models/v1_rating_drop_down_option.rb', line 136

def valid?
  image_validator = EnumAttributeValidator.new('String', ["UNDEFINED", "STAR_FULL", "STAR_HALF", "STAR_EMPTY", "TICK_ROUND", "CLEAN", "SCRATCHES", "SPLAT", "BROKEN", "TICK", "CROSS", "A", "B", "C", "D", "E", "F", "G", "H", "I", "J", "K", "L", "M", "N", "O", "P", "Q", "R", "S", "T", "U", "V", "W", "X", "Y", "Z", "DIGIT_0", "DIGIT_1", "DIGIT_2", "DIGIT_3", "DIGIT_4", "DIGIT_5", "DIGIT_6", "DIGIT_7", "DIGIT_8", "DIGIT_9", "EXCLAMATION", "QUESTION", "EXCLAMATION_QUESTION", "DOUBLE_EXCLAMATION", "DOLLAR", "POUND", "CENTS", "THUMBS_UP", "THUMBS_DOWN", "AWARD", "FEMALE", "MALE", "CALENDAR", "BUILDINGS", "BUILDING", "HOUSE", "NO_ENTRY", "DOG", "CAT", "RAT", "CIGARETTE", "NO_SMOKING", "POOP", "WEED", "GUN", "BROKEN_GLASS", "CRACKED", "DEAD_FACE", "HANDICAP", "BROKEN_HEART", "HEART", "SYRINGE", "CLOCK", "MUSIC_NOTE", "PLANT", "NOSE", "DROPLET", "ELECTRIC", "BUG", "ARROW_RIGHT", "ARROW_LEFT", "ARROW_UP", "ARROW_DOWN", "RECYCLE", "TRASH", "KEY", "LOCK", "UNLOCK", "CLOUD", "SUNSHINE", "PLUS", "MINUS", "TEXTFIELD", "METER", "CAR", "CHART", "WRENCH", "CALCULATOR", "CREDIT_CARD", "PAINTBRUSH", "ROLLER", "MOBILE", "FLAG", "DOOR_OPEN", "DOOR_SHUT", "BED", "SHOWER", "SMOKE_ALARM", "LIGHT_BULB", "SMILEY_HAPPY", "SMILEY_SAD"])
  return false unless image_validator.valid?(@image)
  return true
end