Class: Buildium::WorkOrderSearchMessage

Inherits:
Object
  • Object
show all
Defined in:
lib/buildium-ruby/models/work_order_search_message.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ WorkOrderSearchMessage

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
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
 
# File 'lib/buildium-ruby/models/work_order_search_message.rb', line 160

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#amount_from ⇒ Object

Filters results to any work orders whose total amounts are equal or greater than the specified amount.



61
62
63
 
# File 'lib/buildium-ruby/models/work_order_search_message.rb', line 61

def amount_from
  @amount_from
end

#amount_to ⇒ Object

Filters results to any work orders whose total amounts are equal or less than the specified amount.



64
65
66
 
# File 'lib/buildium-ruby/models/work_order_search_message.rb', line 64

def amount_to
  @amount_to
end

#assigned_to_id ⇒ Object

Filters results to any work orders that have been assigned to the specified staff user identifier.



55
56
57
 
# File 'lib/buildium-ruby/models/work_order_search_message.rb', line 55

def assigned_to_id
  @assigned_to_id
end

#due_date_from ⇒ Object

Filters results to any work orders with a due date on or after the specified date. The value must be formatted as YYYY-MM-DD.



43
44
45
 
# File 'lib/buildium-ruby/models/work_order_search_message.rb', line 43

def due_date_from
  @due_date_from
end

#due_date_to ⇒ Object

Filters results to any work orders with a due date on or before the specified date. The value must be formatted as YYYY-MM-DD.



46
47
48
 
# File 'lib/buildium-ruby/models/work_order_search_message.rb', line 46

def due_date_to
  @due_date_to
end

#entity_id ⇒ Object

Filters results to any work order associated with the specified entity id value. The value must be of the type specified in the ‘EntityType` field.



22
23
24
 
# File 'lib/buildium-ruby/models/work_order_search_message.rb', line 22

def entity_id
  @entity_id
end

#entity_type ⇒ Object

Specifies the type of entity that the ‘EntityId` field refers to. This field is required if the `EntityId` field is populated.



19
20
21
 
# File 'lib/buildium-ruby/models/work_order_search_message.rb', line 19

def entity_type
  @entity_type
end

#is_billed ⇒ Object

Filters results to work orders that have an associated bill.



67
68
69
 
# File 'lib/buildium-ruby/models/work_order_search_message.rb', line 67

def is_billed
  @is_billed
end

#last_updated_from ⇒ Object

Filters results to any work orders were updated on or after the specified date. The value must be formatted as YYYY-MM-DD.



37
38
39
 
# File 'lib/buildium-ruby/models/work_order_search_message.rb', line 37

def last_updated_from
  @last_updated_from
end

#last_updated_to ⇒ Object

Filters results to any work orders were updated on or before the specified date. The value must be formatted as YYYY-MM-DD.



40
41
42
 
# File 'lib/buildium-ruby/models/work_order_search_message.rb', line 40

def last_updated_to
  @last_updated_to
end

#priorities ⇒ Object

Filters results to any work orders that have been assigned to the specified staff user identifier.



52
53
54
 
# File 'lib/buildium-ruby/models/work_order_search_message.rb', line 52

def priorities
  @priorities
end

#statuses ⇒ Object

Filters results by the status of the task associated with the work order. If no status is specified, work orders with any status will be returned.



25
26
27
 
# File 'lib/buildium-ruby/models/work_order_search_message.rb', line 25

def statuses
  @statuses
end

#task_category_id ⇒ Object

Filters results to any work orders whose priority matches the specified values. If no priority is specified, tasks with any priority will be returned.



49
50
51
 
# File 'lib/buildium-ruby/models/work_order_search_message.rb', line 49

def task_category_id
  @task_category_id
end

#task_ids ⇒ Object

Filters results to work orders that have an associated to a task in the specified list.



73
74
75
 
# File 'lib/buildium-ruby/models/work_order_search_message.rb', line 73

def task_ids
  @task_ids
end

#title ⇒ Object

Filters results to any work orders whose title contains the specified value.



70
71
72
 
# File 'lib/buildium-ruby/models/work_order_search_message.rb', line 70

def title
  @title
end

#type ⇒ Object

Filters results to any work order with an associated task with the task type specified.



28
29
30
 
# File 'lib/buildium-ruby/models/work_order_search_message.rb', line 28

def type
  @type
end

#unit_agreement_id ⇒ Object

Filters results to any work order associated with the unit agreement identifier specified.



34
35
36
 
# File 'lib/buildium-ruby/models/work_order_search_message.rb', line 34

def unit_agreement_id
  @unit_agreement_id
end

#unit_id ⇒ Object

Filters results to any work order associated with the unit identifier.



31
32
33
 
# File 'lib/buildium-ruby/models/work_order_search_message.rb', line 31

def unit_id
  @unit_id
end

#vendor_ids ⇒ Object

Filters results to any work orders that have been assigned to the specified vendor identifier.



58
59
60
 
# File 'lib/buildium-ruby/models/work_order_search_message.rb', line 58

def vendor_ids
  @vendor_ids
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



123
124
125
 
# File 'lib/buildium-ruby/models/work_order_search_message.rb', line 123

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
 
# File 'lib/buildium-ruby/models/work_order_search_message.rb', line 98

def self.attribute_map
  {
    :'entity_type' => :'EntityType',
    :'entity_id' => :'EntityId',
    :'statuses' => :'Statuses',
    :'type' => :'Type',
    :'unit_id' => :'UnitId',
    :'unit_agreement_id' => :'UnitAgreementId',
    :'last_updated_from' => :'LastUpdatedFrom',
    :'last_updated_to' => :'LastUpdatedTo',
    :'due_date_from' => :'DueDateFrom',
    :'due_date_to' => :'DueDateTo',
    :'task_category_id' => :'TaskCategoryId',
    :'priorities' => :'Priorities',
    :'assigned_to_id' => :'AssignedToId',
    :'vendor_ids' => :'VendorIds',
    :'amount_from' => :'AmountFrom',
    :'amount_to' => :'AmountTo',
    :'is_billed' => :'IsBilled',
    :'title' => :'Title',
    :'task_ids' => :'TaskIds'
  }
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



336
337
338
 
# File 'lib/buildium-ruby/models/work_order_search_message.rb', line 336

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



153
154
155
156
 
# File 'lib/buildium-ruby/models/work_order_search_message.rb', line 153

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

.openapi_types ⇒ Object

Attribute type mapping.



128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
 
# File 'lib/buildium-ruby/models/work_order_search_message.rb', line 128

def self.openapi_types
  {
    :'entity_type' => :'String',
    :'entity_id' => :'Integer',
    :'statuses' => :'Array<String>',
    :'type' => :'String',
    :'unit_id' => :'Integer',
    :'unit_agreement_id' => :'Integer',
    :'last_updated_from' => :'Date',
    :'last_updated_to' => :'Date',
    :'due_date_from' => :'Date',
    :'due_date_to' => :'Date',
    :'task_category_id' => :'Integer',
    :'priorities' => :'Array<String>',
    :'assigned_to_id' => :'Integer',
    :'vendor_ids' => :'Array<Integer>',
    :'amount_from' => :'Float',
    :'amount_to' => :'Float',
    :'is_billed' => :'Boolean',
    :'title' => :'String',
    :'task_ids' => :'Array<Integer>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
 
# File 'lib/buildium-ruby/models/work_order_search_message.rb', line 297

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      entity_type == o.entity_type &&
      entity_id == o.entity_id &&
      statuses == o.statuses &&
      type == o.type &&
      unit_id == o.unit_id &&
      unit_agreement_id == o.unit_agreement_id &&
      last_updated_from == o.last_updated_from &&
      last_updated_to == o.last_updated_to &&
      due_date_from == o.due_date_from &&
      due_date_to == o.due_date_to &&
      task_category_id == o.task_category_id &&
      priorities == o.priorities &&
      assigned_to_id == o.assigned_to_id &&
      vendor_ids == o.vendor_ids &&
      amount_from == o.amount_from &&
      amount_to == o.amount_to &&
      is_billed == o.is_billed &&
      title == o.title &&
      task_ids == o.task_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



367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
 
# File 'lib/buildium-ruby/models/work_order_search_message.rb', line 367

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 = Buildium.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



438
439
440
441
442
443
444
445
446
447
448
449
450
 
# File 'lib/buildium-ruby/models/work_order_search_message.rb', line 438

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



343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
 
# File 'lib/buildium-ruby/models/work_order_search_message.rb', line 343

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


323
324
325
 
# File 'lib/buildium-ruby/models/work_order_search_message.rb', line 323

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



329
330
331
 
# File 'lib/buildium-ruby/models/work_order_search_message.rb', line 329

def hash
  [entity_type, entity_id, statuses, type, unit_id, unit_agreement_id, last_updated_from, last_updated_to, due_date_from, due_date_to, task_category_id, priorities, assigned_to_id, vendor_ids, amount_from, amount_to, is_billed, title, task_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



260
261
262
263
 
# File 'lib/buildium-ruby/models/work_order_search_message.rb', line 260

def list_invalid_properties
  invalid_properties = Array.new
  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



414
415
416
 
# File 'lib/buildium-ruby/models/work_order_search_message.rb', line 414

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



420
421
422
423
424
425
426
427
428
429
430
431
432
 
# File 'lib/buildium-ruby/models/work_order_search_message.rb', line 420

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



408
409
410
 
# File 'lib/buildium-ruby/models/work_order_search_message.rb', line 408

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



267
268
269
270
271
272
273
 
# File 'lib/buildium-ruby/models/work_order_search_message.rb', line 267

def valid?
  entity_type_validator = EnumAttributeValidator.new('String', ["Rental", "RentalOwner", "Association"])
  return false unless entity_type_validator.valid?(@entity_type)
  type_validator = EnumAttributeValidator.new('String', ["ContactRequest", "ResidentRequest", "Todo", "RentalOwnerRequest"])
  return false unless type_validator.valid?(@type)
  true
end