Class: Propertyware::SaveWorkOrder

Inherits:
Object
  • Object
show all
Defined in:
lib/propertyware/models/save_work_order.rb

Overview

Work Order for Request

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SaveWorkOrder

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
 
# File 'lib/propertyware/models/save_work_order.rb', line 146

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Propertyware::SaveWorkOrder` 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 `Propertyware::SaveWorkOrder`. 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?(:'authorize_enter')
    self.authorize_enter = attributes[:'authorize_enter']
  end

  if attributes.key?(:'building_id')
    self.building_id = attributes[:'building_id']
  end

  if attributes.key?(:'category')
    self.category = attributes[:'category']
  end

  if attributes.key?(:'cost_estimate')
    self.cost_estimate = attributes[:'cost_estimate']
  end

  if attributes.key?(:'date_to_enter')
    self.date_to_enter = attributes[:'date_to_enter']
  end

  if attributes.key?(:'description')
    self.description = attributes[:'description']
  end

  if attributes.key?(:'hour_estimate')
    self.hour_estimate = attributes[:'hour_estimate']
  end

  if attributes.key?(:'hour_to_enter')
    self.hour_to_enter = attributes[:'hour_to_enter']
  end

  if attributes.key?(:'minute_to_enter')
    self.minute_to_enter = attributes[:'minute_to_enter']
  end

  if attributes.key?(:'priority')
    self.priority = attributes[:'priority']
  end

  if attributes.key?(:'requested_by')
    self.requested_by = attributes[:'requested_by']
  end

  if attributes.key?(:'scheduled_end_date')
    self.scheduled_end_date = attributes[:'scheduled_end_date']
  end

  if attributes.key?(:'search_tag')
    self.search_tag = attributes[:'search_tag']
  end

  if attributes.key?(:'start_date')
    self.start_date = attributes[:'start_date']
  end

  if attributes.key?(:'type')
    self.type = attributes[:'type']
  end

  if attributes.key?(:'unit_ids')
    if (value = attributes[:'unit_ids']).is_a?(Array)
      self.unit_ids = value
    end
  end
end

Instance Attribute Details

#authorize_enter ⇒ Object

This field indicates if the tenant has granted the maintenance staff permission to enter the unit.



20
21
22
 
# File 'lib/propertyware/models/save_work_order.rb', line 20

def authorize_enter
  @authorize_enter
end

#building_id ⇒ Object

Id of the building associated with this work order.



23
24
25
 
# File 'lib/propertyware/models/save_work_order.rb', line 23

def building_id
  @building_id
end

#category ⇒ Object

Category of the work order.



26
27
28
 
# File 'lib/propertyware/models/save_work_order.rb', line 26

def category
  @category
end

#cost_estimate ⇒ Object

Enter an estimate of the cost for performing the work outlined in the work order.



29
30
31
 
# File 'lib/propertyware/models/save_work_order.rb', line 29

def cost_estimate
  @cost_estimate
end

#date_to_enter ⇒ Object

Authorized date to enter unit.



32
33
34
 
# File 'lib/propertyware/models/save_work_order.rb', line 32

def date_to_enter
  @date_to_enter
end

#description ⇒ Object

Description of the work order.



35
36
37
 
# File 'lib/propertyware/models/save_work_order.rb', line 35

def description
  @description
end

#hour_estimate ⇒ Object

Estimated number of hours to complete the work order.



38
39
40
 
# File 'lib/propertyware/models/save_work_order.rb', line 38

def hour_estimate
  @hour_estimate
end

#hour_to_enter ⇒ Object

Hour to enter. Allowed Value : 0 , 1, 2 … 23



41
42
43
 
# File 'lib/propertyware/models/save_work_order.rb', line 41

def hour_to_enter
  @hour_to_enter
end

#minute_to_enter ⇒ Object

Minute to enter. Allowed Value : 0, 10, 20, 30, 40, 50



44
45
46
 
# File 'lib/propertyware/models/save_work_order.rb', line 44

def minute_to_enter
  @minute_to_enter
end

#priority ⇒ Object

Priority of the work order.



47
48
49
 
# File 'lib/propertyware/models/save_work_order.rb', line 47

def priority
  @priority
end

#requested_by ⇒ Object

Id of the person that reported the problem, typically the tenant or owner associated with the buildings or units.



50
51
52
 
# File 'lib/propertyware/models/save_work_order.rb', line 50

def requested_by
  @requested_by
end

#scheduled_end_date ⇒ Object

Date on which the work is scheduled to be completed.



53
54
55
 
# File 'lib/propertyware/models/save_work_order.rb', line 53

def scheduled_end_date
  @scheduled_end_date
end

#search_tag ⇒ Object

Enter a key term to allow you to quickly locate the work order.



56
57
58
 
# File 'lib/propertyware/models/save_work_order.rb', line 56

def search_tag
  @search_tag
end

#start_date ⇒ Object

Date on which the work was started.



59
60
61
 
# File 'lib/propertyware/models/save_work_order.rb', line 59

def start_date
  @start_date
end

#type ⇒ Object

This classifies the work order into one of the following types: General, Service Request, Turnover, Inspection, Estimate etc.



62
63
64
 
# File 'lib/propertyware/models/save_work_order.rb', line 62

def type
  @type
end

#unit_ids ⇒ Object

List of unit Ids that are attached to the building.



65
66
67
 
# File 'lib/propertyware/models/save_work_order.rb', line 65

def unit_ids
  @unit_ids
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



112
113
114
 
# File 'lib/propertyware/models/save_work_order.rb', line 112

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
 
# File 'lib/propertyware/models/save_work_order.rb', line 90

def self.attribute_map
  {
    :'authorize_enter' => :'authorizeEnter',
    :'building_id' => :'buildingID',
    :'category' => :'category',
    :'cost_estimate' => :'costEstimate',
    :'date_to_enter' => :'dateToEnter',
    :'description' => :'description',
    :'hour_estimate' => :'hourEstimate',
    :'hour_to_enter' => :'hourToEnter',
    :'minute_to_enter' => :'minuteToEnter',
    :'priority' => :'priority',
    :'requested_by' => :'requestedBy',
    :'scheduled_end_date' => :'scheduledEndDate',
    :'search_tag' => :'searchTag',
    :'start_date' => :'startDate',
    :'type' => :'type',
    :'unit_ids' => :'unitIDs'
  }
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



306
307
308
 
# File 'lib/propertyware/models/save_work_order.rb', line 306

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



139
140
141
142
 
# File 'lib/propertyware/models/save_work_order.rb', line 139

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
 
# File 'lib/propertyware/models/save_work_order.rb', line 117

def self.openapi_types
  {
    :'authorize_enter' => :'String',
    :'building_id' => :'Integer',
    :'category' => :'String',
    :'cost_estimate' => :'Float',
    :'date_to_enter' => :'Date',
    :'description' => :'String',
    :'hour_estimate' => :'Float',
    :'hour_to_enter' => :'Integer',
    :'minute_to_enter' => :'Integer',
    :'priority' => :'String',
    :'requested_by' => :'Integer',
    :'scheduled_end_date' => :'Date',
    :'search_tag' => :'String',
    :'start_date' => :'Date',
    :'type' => :'String',
    :'unit_ids' => :'Array<Integer>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
 
# File 'lib/propertyware/models/save_work_order.rb', line 270

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      authorize_enter == o.authorize_enter &&
      building_id == o.building_id &&
      category == o.category &&
      cost_estimate == o.cost_estimate &&
      date_to_enter == o.date_to_enter &&
      description == o.description &&
      hour_estimate == o.hour_estimate &&
      hour_to_enter == o.hour_to_enter &&
      minute_to_enter == o.minute_to_enter &&
      priority == o.priority &&
      requested_by == o.requested_by &&
      scheduled_end_date == o.scheduled_end_date &&
      search_tag == o.search_tag &&
      start_date == o.start_date &&
      type == o.type &&
      unit_ids == o.unit_ids
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



337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
 
# File 'lib/propertyware/models/save_work_order.rb', line 337

def _deserialize(type, value)
  case type.to_sym
  when :Time
    Time.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
    # models (e.g. Pet) or oneOf
    klass = Propertyware.const_get(type)
    klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.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



408
409
410
411
412
413
414
415
416
417
418
419
420
 
# File 'lib/propertyware/models/save_work_order.rb', line 408

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



313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
 
# File 'lib/propertyware/models/save_work_order.rb', line 313

def build_from_hash(attributes)
  return unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  self.class.openapi_types.each_pair do |key, type|
    if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      self.send("#{key}=", nil)
    elsif 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
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


293
294
295
 
# File 'lib/propertyware/models/save_work_order.rb', line 293

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



299
300
301
 
# File 'lib/propertyware/models/save_work_order.rb', line 299

def hash
  [authorize_enter, building_id, category, cost_estimate, date_to_enter, description, hour_estimate, hour_to_enter, minute_to_enter, priority, requested_by, scheduled_end_date, search_tag, start_date, type, unit_ids].hash
end

#list_invalid_properties ⇒ Object

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

Returns:

  • Array for valid properties with the reasons



228
229
230
231
232
233
234
235
 
# File 'lib/propertyware/models/save_work_order.rb', line 228

def list_invalid_properties
  invalid_properties = Array.new
  if @building_id.nil?
    invalid_properties.push('invalid value for "building_id", building_id cannot be nil.')
  end

  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



384
385
386
 
# File 'lib/propertyware/models/save_work_order.rb', line 384

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



390
391
392
393
394
395
396
397
398
399
400
401
402
 
# File 'lib/propertyware/models/save_work_order.rb', line 390

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

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



378
379
380
 
# File 'lib/propertyware/models/save_work_order.rb', line 378

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



239
240
241
242
243
244
245
246
 
# File 'lib/propertyware/models/save_work_order.rb', line 239

def valid?
  authorize_enter_validator = EnumAttributeValidator.new('String', ["NO", "ANYTIME", "SPECIFIEDTIME"])
  return false unless authorize_enter_validator.valid?(@authorize_enter)
  return false if @building_id.nil?
  priority_validator = EnumAttributeValidator.new('String', ["HIGH", "MEDIUM", "LOW"])
  return false unless priority_validator.valid?(@priority)
  true
end