Class: Buildium::WorkOrderPutMessage

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ WorkOrderPutMessage

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
154
155
156
157
158
159
160
 
# File 'lib/buildium-ruby/models/work_order_put_message.rb', line 110

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

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

Instance Attribute Details

#chargeable_to ⇒ Object

A description of the entity that will be charged for the work. The value cannot exceed 100 characters.



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

def chargeable_to
  @chargeable_to
end

#entry_allowed ⇒ Object

Indicates whether entry has been allowed to the unit.



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

def entry_allowed
  @entry_allowed
end

#entry_contact_id ⇒ Object

Contact user unique identifier. The user type must be one of the following types: ‘RentalTenant`, `AssociationOwner`, `Staff`, `RentalOwner`.



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

def entry_contact_id
  @entry_contact_id
end

#entry_notes ⇒ Object

Notes specific to entering the unit. The value cannot exceed 65,535 characters.



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

def entry_notes
  @entry_notes
end

#invoice_number ⇒ Object

The invoice or reference number that the vendor assigned to the invoice. The value cannot exceed 50 characters.



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

def invoice_number
  @invoice_number
end

#line_items ⇒ Object

Work order line items. Note that all existing work order line items will be removed and replaced with this list of line items.



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

def line_items
  @line_items
end

#vendor_id ⇒ Object

Vendor unique identifier.



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

def vendor_id
  @vendor_id
end

#vendor_notes ⇒ Object

Notes specific to the vendor. The value cannot exceed 65,535 characters.



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

def vendor_notes
  @vendor_notes
end

#work_details ⇒ Object

Description of the work order. The value cannot exceed 65,535 characters.



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

def work_details
  @work_details
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



83
84
85
 
# File 'lib/buildium-ruby/models/work_order_put_message.rb', line 83

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



68
69
70
71
72
73
74
75
76
77
78
79
80
 
# File 'lib/buildium-ruby/models/work_order_put_message.rb', line 68

def self.attribute_map
  {
    :'work_details' => :'WorkDetails',
    :'invoice_number' => :'InvoiceNumber',
    :'chargeable_to' => :'ChargeableTo',
    :'entry_allowed' => :'EntryAllowed',
    :'entry_notes' => :'EntryNotes',
    :'vendor_id' => :'VendorId',
    :'vendor_notes' => :'VendorNotes',
    :'entry_contact_id' => :'EntryContactId',
    :'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



228
229
230
 
# File 'lib/buildium-ruby/models/work_order_put_message.rb', line 228

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



103
104
105
106
 
# File 'lib/buildium-ruby/models/work_order_put_message.rb', line 103

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

.openapi_types ⇒ Object

Attribute type mapping.



88
89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'lib/buildium-ruby/models/work_order_put_message.rb', line 88

def self.openapi_types
  {
    :'work_details' => :'String',
    :'invoice_number' => :'String',
    :'chargeable_to' => :'String',
    :'entry_allowed' => :'String',
    :'entry_notes' => :'String',
    :'vendor_id' => :'Integer',
    :'vendor_notes' => :'String',
    :'entry_contact_id' => :'Integer',
    :'line_items' => :'Array<WorkOrderLineItemSaveMessage>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



199
200
201
202
203
204
205
206
207
208
209
210
211
 
# File 'lib/buildium-ruby/models/work_order_put_message.rb', line 199

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      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_id == o.entry_contact_id &&
      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



259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
 
# File 'lib/buildium-ruby/models/work_order_put_message.rb', line 259

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



330
331
332
333
334
335
336
337
338
339
340
341
342
 
# File 'lib/buildium-ruby/models/work_order_put_message.rb', line 330

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



235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
 
# File 'lib/buildium-ruby/models/work_order_put_message.rb', line 235

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


215
216
217
 
# File 'lib/buildium-ruby/models/work_order_put_message.rb', line 215

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



221
222
223
 
# File 'lib/buildium-ruby/models/work_order_put_message.rb', line 221

def hash
  [work_details, invoice_number, chargeable_to, entry_allowed, entry_notes, vendor_id, vendor_notes, entry_contact_id, 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



164
165
166
167
168
169
170
171
172
173
174
175
 
# File 'lib/buildium-ruby/models/work_order_put_message.rb', line 164

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

  if @vendor_id.nil?
    invalid_properties.push('invalid value for "vendor_id", vendor_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



306
307
308
 
# File 'lib/buildium-ruby/models/work_order_put_message.rb', line 306

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



312
313
314
315
316
317
318
319
320
321
322
323
324
 
# File 'lib/buildium-ruby/models/work_order_put_message.rb', line 312

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



300
301
302
 
# File 'lib/buildium-ruby/models/work_order_put_message.rb', line 300

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



179
180
181
182
183
184
185
 
# File 'lib/buildium-ruby/models/work_order_put_message.rb', line 179

def valid?
  return false if @entry_allowed.nil?
  entry_allowed_validator = EnumAttributeValidator.new('String', ["Unknown", "Yes", "No"])
  return false unless entry_allowed_validator.valid?(@entry_allowed)
  return false if @vendor_id.nil?
  true
end