Class: Buildium::WorkOrderMessage

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ WorkOrderMessage

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
 
# File 'lib/buildium-ruby/models/work_order_message.rb', line 153

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#amount ⇒ Object

The total amount of the work order.



65
66
67
 
# File 'lib/buildium-ruby/models/work_order_message.rb', line 65

def amount
  @amount
end

#bill_transaction_id ⇒ Object

Unique identifier for the bill related to this work order. This field will be ‘null` if no bill is related to this work order. If the BillTransactionIds field is available, please refer to that field instead of this one going forward.



62
63
64
 
# File 'lib/buildium-ruby/models/work_order_message.rb', line 62

def bill_transaction_id
  @bill_transaction_id
end

#chargeable_to ⇒ Object

A description of the entity that will be charged for the work.



42
43
44
 
# File 'lib/buildium-ruby/models/work_order_message.rb', line 42

def chargeable_to
  @chargeable_to
end

#due_date ⇒ Object

Work order due date.



27
28
29
 
# File 'lib/buildium-ruby/models/work_order_message.rb', line 27

def due_date
  @due_date
end

#entry_allowed ⇒ Object

Indicates whether entry has been allowed to the unit.



45
46
47
 
# File 'lib/buildium-ruby/models/work_order_message.rb', line 45

def entry_allowed
  @entry_allowed
end

#entry_contact ⇒ Object

Returns the value of attribute entry_contact.



56
57
58
 
# File 'lib/buildium-ruby/models/work_order_message.rb', line 56

def entry_contact
  @entry_contact
end

#entry_contacts ⇒ Object

A collection of all entry contacts for the work order



59
60
61
 
# File 'lib/buildium-ruby/models/work_order_message.rb', line 59

def entry_contacts
  @entry_contacts
end

#entry_notes ⇒ Object

Notes specific to entering the unit.



48
49
50
 
# File 'lib/buildium-ruby/models/work_order_message.rb', line 48

def entry_notes
  @entry_notes
end

#id ⇒ Object

Work order unique identifier.



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

def id
  @id
end

#invoice_number ⇒ Object

The invoice or reference number that the vendor assigned to the invoice.



39
40
41
 
# File 'lib/buildium-ruby/models/work_order_message.rb', line 39

def invoice_number
  @invoice_number
end

#line_items ⇒ Object

A collection of line items associated with the work order.



68
69
70
 
# File 'lib/buildium-ruby/models/work_order_message.rb', line 68

def line_items
  @line_items
end

#priority ⇒ Object

Work order priority.



30
31
32
 
# File 'lib/buildium-ruby/models/work_order_message.rb', line 30

def priority
  @priority
end

#status ⇒ Object

Work order status.



33
34
35
 
# File 'lib/buildium-ruby/models/work_order_message.rb', line 33

def status
  @status
end

#task ⇒ Object

Returns the value of attribute task.



21
22
23
 
# File 'lib/buildium-ruby/models/work_order_message.rb', line 21

def task
  @task
end

#title ⇒ Object

Work order title.



24
25
26
 
# File 'lib/buildium-ruby/models/work_order_message.rb', line 24

def title
  @title
end

#vendor_id ⇒ Object

Vendor unique identifier.



51
52
53
 
# File 'lib/buildium-ruby/models/work_order_message.rb', line 51

def vendor_id
  @vendor_id
end

#vendor_notes ⇒ Object

Notes specific to the vendor.



54
55
56
 
# File 'lib/buildium-ruby/models/work_order_message.rb', line 54

def vendor_notes
  @vendor_notes
end

#work_details ⇒ Object

Description of the work order.



36
37
38
 
# File 'lib/buildium-ruby/models/work_order_message.rb', line 36

def work_details
  @work_details
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



117
118
119
 
# File 'lib/buildium-ruby/models/work_order_message.rb', line 117

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
 
# File 'lib/buildium-ruby/models/work_order_message.rb', line 93

def self.attribute_map
  {
    :'id' => :'Id',
    :'task' => :'Task',
    :'title' => :'Title',
    :'due_date' => :'DueDate',
    :'priority' => :'Priority',
    :'status' => :'Status',
    :'work_details' => :'WorkDetails',
    :'invoice_number' => :'InvoiceNumber',
    :'chargeable_to' => :'ChargeableTo',
    :'entry_allowed' => :'EntryAllowed',
    :'entry_notes' => :'EntryNotes',
    :'vendor_id' => :'VendorId',
    :'vendor_notes' => :'VendorNotes',
    :'entry_contact' => :'EntryContact',
    :'entry_contacts' => :'EntryContacts',
    :'bill_transaction_id' => :'BillTransactionId',
    :'amount' => :'Amount',
    :'line_items' => :'LineItems'
  }
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



332
333
334
 
# File 'lib/buildium-ruby/models/work_order_message.rb', line 332

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



146
147
148
149
 
# File 'lib/buildium-ruby/models/work_order_message.rb', line 146

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

.openapi_types ⇒ Object

Attribute type mapping.



122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
 
# File 'lib/buildium-ruby/models/work_order_message.rb', line 122

def self.openapi_types
  {
    :'id' => :'Integer',
    :'task' => :'WorkOrderMessageTask',
    :'title' => :'String',
    :'due_date' => :'Date',
    :'priority' => :'String',
    :'status' => :'String',
    :'work_details' => :'String',
    :'invoice_number' => :'String',
    :'chargeable_to' => :'String',
    :'entry_allowed' => :'String',
    :'entry_notes' => :'String',
    :'vendor_id' => :'Integer',
    :'vendor_notes' => :'String',
    :'entry_contact' => :'WorkOrderMessageEntryContact',
    :'entry_contacts' => :'Array<WorkOrderEntryContactMessage>',
    :'bill_transaction_id' => :'Integer',
    :'amount' => :'Float',
    :'line_items' => :'Array<WorkOrderLineItemMessage>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
 
# File 'lib/buildium-ruby/models/work_order_message.rb', line 294

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      task == o.task &&
      title == o.title &&
      due_date == o.due_date &&
      priority == o.priority &&
      status == o.status &&
      work_details == o.work_details &&
      invoice_number == o.invoice_number &&
      chargeable_to == o.chargeable_to &&
      entry_allowed == o.entry_allowed &&
      entry_notes == o.entry_notes &&
      vendor_id == o.vendor_id &&
      vendor_notes == o.vendor_notes &&
      entry_contact == o.entry_contact &&
      entry_contacts == o.entry_contacts &&
      bill_transaction_id == o.bill_transaction_id &&
      amount == o.amount &&
      line_items == o.line_items
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



363
364
365
366
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
 
# File 'lib/buildium-ruby/models/work_order_message.rb', line 363

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



434
435
436
437
438
439
440
441
442
443
444
445
446
 
# File 'lib/buildium-ruby/models/work_order_message.rb', line 434

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



339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
 
# File 'lib/buildium-ruby/models/work_order_message.rb', line 339

def build_from_hash(attributes)
  return nil 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


319
320
321
 
# File 'lib/buildium-ruby/models/work_order_message.rb', line 319

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



325
326
327
 
# File 'lib/buildium-ruby/models/work_order_message.rb', line 325

def hash
  [id, task, title, due_date, priority, status, work_details, invoice_number, chargeable_to, entry_allowed, entry_notes, vendor_id, vendor_notes, entry_contact, entry_contacts, bill_transaction_id, amount, line_items].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



245
246
247
248
 
# File 'lib/buildium-ruby/models/work_order_message.rb', line 245

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



410
411
412
 
# File 'lib/buildium-ruby/models/work_order_message.rb', line 410

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



416
417
418
419
420
421
422
423
424
425
426
427
428
 
# File 'lib/buildium-ruby/models/work_order_message.rb', line 416

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



404
405
406
 
# File 'lib/buildium-ruby/models/work_order_message.rb', line 404

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



252
253
254
255
256
257
258
259
260
 
# File 'lib/buildium-ruby/models/work_order_message.rb', line 252

def valid?
  priority_validator = EnumAttributeValidator.new('String', ["Unknown", "Low", "Normal", "High"])
  return false unless priority_validator.valid?(@priority)
  status_validator = EnumAttributeValidator.new('String', ["Unknown", "New", "InProgress", "Completed", "Deferred", "Closed"])
  return false unless status_validator.valid?(@status)
  entry_allowed_validator = EnumAttributeValidator.new('String', ["Unknown", "Yes", "No"])
  return false unless entry_allowed_validator.valid?(@entry_allowed)
  true
end