Class: HappyCo::V1Inspection

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

Overview

  • Inspection represents an inspection in its 3 states: scheduled, in_progress and completed.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ V1Inspection

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
 
# File 'lib/happyco_json/models/v1_inspection.rb', line 99

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?(:'account_id')
    self. = attributes[:'account_id']
  end

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

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

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

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

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

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

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

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

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

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

end

Instance Attribute Details

#account_id ⇒ Object

  • Account ID that the inspection belongs to.



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

def 
  @account_id
end

#asset_id ⇒ Object

  • Asset is the parent that inspection is attached to. This field must reference a non archived asset in the same folder as the template referenced below.



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

def asset_id
  @asset_id
end

#assigned_to_id ⇒ Object

  • Inspector ID is an optional field that specifies the user assigned to perform the inspection.



58
59
60
 
# File 'lib/happyco_json/models/v1_inspection.rb', line 58

def assigned_to_id
  @assigned_to_id
end

#completed ⇒ Object

Returns the value of attribute completed.



50
51
52
 
# File 'lib/happyco_json/models/v1_inspection.rb', line 50

def completed
  @completed
end

#folder_id ⇒ Object

Returns the value of attribute folder_id.



35
36
37
 
# File 'lib/happyco_json/models/v1_inspection.rb', line 35

def folder_id
  @folder_id
end

#id ⇒ Object

  • ID of inspection.



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

def id
  @id
end

#in_progress ⇒ Object

Returns the value of attribute in_progress.



48
49
50
 
# File 'lib/happyco_json/models/v1_inspection.rb', line 48

def in_progress
  @in_progress
end

#photo_quality ⇒ Object

  • Photo Quality is an override setting sent to clients that informs them what level of Photo Quality they should enforce, regardless of user settings on the client. The default value is 0 which denotes that the client should use the user’s settings, otherwise the higher the value the higher Photo Quality should be enforced by the client.



55
56
57
 
# File 'lib/happyco_json/models/v1_inspection.rb', line 55

def photo_quality
  @photo_quality
end

#scheduled ⇒ Object

Returns the value of attribute scheduled.



46
47
48
 
# File 'lib/happyco_json/models/v1_inspection.rb', line 46

def scheduled
  @scheduled
end

#template_id ⇒ Object

  • Template is the prototype of an inspection thats allow it to be configured on the fly. This field must reference a non archived template in the same folder as the parent asset referenced above.



41
42
43
 
# File 'lib/happyco_json/models/v1_inspection.rb', line 41

def template_id
  @template_id
end

#template_outline ⇒ Object

  • Template outline when set on a scheduled inspection forces a different outline prototype to be used when the inspection moves from scheduled to in_progress.



44
45
46
 
# File 'lib/happyco_json/models/v1_inspection.rb', line 44

def template_outline
  @template_outline
end

#update_time ⇒ Object

Returns the value of attribute update_time.



52
53
54
 
# File 'lib/happyco_json/models/v1_inspection.rb', line 52

def update_time
  @update_time
end

Class Method Details

.attribute_map ⇒ Object

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



62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/happyco_json/models/v1_inspection.rb', line 62

def self.attribute_map
  {
    :'id' => :'id',
    :'account_id' => :'account_id',
    :'folder_id' => :'folder_id',
    :'asset_id' => :'asset_id',
    :'template_id' => :'template_id',
    :'template_outline' => :'template_outline',
    :'scheduled' => :'scheduled',
    :'in_progress' => :'in_progress',
    :'completed' => :'completed',
    :'update_time' => :'update_time',
    :'photo_quality' => :'photo_quality',
    :'assigned_to_id' => :'assigned_to_id'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/happyco_json/models/v1_inspection.rb', line 80

def self.swagger_types
  {
    :'id' => :'V1IntegrationID',
    :'account_id' => :'V1IntegrationID',
    :'folder_id' => :'V1IntegrationID',
    :'asset_id' => :'V1IntegrationID',
    :'template_id' => :'V1IntegrationID',
    :'template_outline' => :'String',
    :'scheduled' => :'V1ScheduledInspection',
    :'in_progress' => :'V1InspectionData',
    :'completed' => :'V1InspectionData',
    :'update_time' => :'V1DateTime',
    :'photo_quality' => :'Integer',
    :'assigned_to_id' => :'V1IntegrationID'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
 
# File 'lib/happyco_json/models/v1_inspection.rb', line 170

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
       == o. &&
      folder_id == o.folder_id &&
      asset_id == o.asset_id &&
      template_id == o.template_id &&
      template_outline == o.template_outline &&
      scheduled == o.scheduled &&
      in_progress == o.in_progress &&
      completed == o.completed &&
      update_time == o.update_time &&
      photo_quality == o.photo_quality &&
      assigned_to_id == o.assigned_to_id
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



223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
 
# File 'lib/happyco_json/models/v1_inspection.rb', line 223

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



289
290
291
292
293
294
295
296
297
298
299
300
301
 
# File 'lib/happyco_json/models/v1_inspection.rb', line 289

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



202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
 
# File 'lib/happyco_json/models/v1_inspection.rb', line 202

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


189
190
191
 
# File 'lib/happyco_json/models/v1_inspection.rb', line 189

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



195
196
197
 
# File 'lib/happyco_json/models/v1_inspection.rb', line 195

def hash
  [id, , folder_id, asset_id, template_id, template_outline, scheduled, in_progress, completed, update_time, photo_quality, assigned_to_id].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



157
158
159
160
 
# File 'lib/happyco_json/models/v1_inspection.rb', line 157

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



269
270
271
 
# File 'lib/happyco_json/models/v1_inspection.rb', line 269

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



275
276
277
278
279
280
281
282
283
 
# File 'lib/happyco_json/models/v1_inspection.rb', line 275

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



263
264
265
 
# File 'lib/happyco_json/models/v1_inspection.rb', line 263

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



164
165
166
 
# File 'lib/happyco_json/models/v1_inspection.rb', line 164

def valid?
  return true
end