Class: Buildium::WorkOrderPostMessageTask

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

Overview

Task information to create and associate with the work order.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ WorkOrderPostMessageTask

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

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

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

Instance Attribute Details

#assigned_to_user_id ⇒ Object

The unique identifier of the staff user assigned to the request. The user must be a ‘Staff` user type.



38
39
40
 
# File 'lib/buildium-ruby/models/work_order_post_message_task.rb', line 38

def assigned_to_user_id
  @assigned_to_user_id
end

#due_date ⇒ Object

Task due date. The date must be formatted as YYYY-MM-DD.



23
24
25
 
# File 'lib/buildium-ruby/models/work_order_post_message_task.rb', line 23

def due_date
  @due_date
end

#priority ⇒ Object

Task priority.



26
27
28
 
# File 'lib/buildium-ruby/models/work_order_post_message_task.rb', line 26

def priority
  @priority
end

#property_id ⇒ Object

The unique identifier of property associated with the request. The assigned property must be active.



32
33
34
 
# File 'lib/buildium-ruby/models/work_order_post_message_task.rb', line 32

def property_id
  @property_id
end

#status ⇒ Object

Task status.



29
30
31
 
# File 'lib/buildium-ruby/models/work_order_post_message_task.rb', line 29

def status
  @status
end

#title ⇒ Object

Task title. The title can not exceed 127 characters.



20
21
22
 
# File 'lib/buildium-ruby/models/work_order_post_message_task.rb', line 20

def title
  @title
end

#unit_id ⇒ Object

The unique identifier of the unit associated with the request. The unit must be associated with the ‘PropertyId` specified.



35
36
37
 
# File 'lib/buildium-ruby/models/work_order_post_message_task.rb', line 35

def unit_id
  @unit_id
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



76
77
78
 
# File 'lib/buildium-ruby/models/work_order_post_message_task.rb', line 76

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/buildium-ruby/models/work_order_post_message_task.rb', line 63

def self.attribute_map
  {
    :'title' => :'Title',
    :'due_date' => :'DueDate',
    :'priority' => :'Priority',
    :'status' => :'Status',
    :'property_id' => :'PropertyId',
    :'unit_id' => :'UnitId',
    :'assigned_to_user_id' => :'AssignedToUserId'
  }
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



255
256
257
 
# File 'lib/buildium-ruby/models/work_order_post_message_task.rb', line 255

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

.openapi_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



100
101
102
103
104
 
# File 'lib/buildium-ruby/models/work_order_post_message_task.rb', line 100

def self.openapi_all_of
  [
  :'WorkOrderTaskPostMessage'
  ]
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



94
95
96
97
 
# File 'lib/buildium-ruby/models/work_order_post_message_task.rb', line 94

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

.openapi_types ⇒ Object

Attribute type mapping.



81
82
83
84
85
86
87
88
89
90
91
 
# File 'lib/buildium-ruby/models/work_order_post_message_task.rb', line 81

def self.openapi_types
  {
    :'title' => :'String',
    :'due_date' => :'Date',
    :'priority' => :'String',
    :'status' => :'String',
    :'property_id' => :'Integer',
    :'unit_id' => :'Integer',
    :'assigned_to_user_id' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



228
229
230
231
232
233
234
235
236
237
238
 
# File 'lib/buildium-ruby/models/work_order_post_message_task.rb', line 228

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      title == o.title &&
      due_date == o.due_date &&
      priority == o.priority &&
      status == o.status &&
      property_id == o.property_id &&
      unit_id == o.unit_id &&
      assigned_to_user_id == o.assigned_to_user_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



286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
 
# File 'lib/buildium-ruby/models/work_order_post_message_task.rb', line 286

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



357
358
359
360
361
362
363
364
365
366
367
368
369
 
# File 'lib/buildium-ruby/models/work_order_post_message_task.rb', line 357

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



262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
 
# File 'lib/buildium-ruby/models/work_order_post_message_task.rb', line 262

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


242
243
244
 
# File 'lib/buildium-ruby/models/work_order_post_message_task.rb', line 242

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



248
249
250
 
# File 'lib/buildium-ruby/models/work_order_post_message_task.rb', line 248

def hash
  [title, due_date, priority, status, property_id, unit_id, assigned_to_user_id].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



152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
 
# File 'lib/buildium-ruby/models/work_order_post_message_task.rb', line 152

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

  if @title.to_s.length < 1
    invalid_properties.push('invalid value for "title", the character length must be great than or equal to 1.')
  end

  if @priority.nil?
    invalid_properties.push('invalid value for "priority", priority cannot be nil.')
  end

  if @status.nil?
    invalid_properties.push('invalid value for "status", status cannot be nil.')
  end

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



333
334
335
 
# File 'lib/buildium-ruby/models/work_order_post_message_task.rb', line 333

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



339
340
341
342
343
344
345
346
347
348
349
350
351
 
# File 'lib/buildium-ruby/models/work_order_post_message_task.rb', line 339

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



327
328
329
 
# File 'lib/buildium-ruby/models/work_order_post_message_task.rb', line 327

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
186
187
188
189
190
 
# File 'lib/buildium-ruby/models/work_order_post_message_task.rb', line 179

def valid?
  return false if @title.nil?
  return false if @title.to_s.length < 1
  return false if @priority.nil?
  priority_validator = EnumAttributeValidator.new('String', ["Low", "Normal", "High"])
  return false unless priority_validator.valid?(@priority)
  return false if @status.nil?
  status_validator = EnumAttributeValidator.new('String', ["New", "InProgress", "Completed", "Deferred", "Closed"])
  return false unless status_validator.valid?(@status)
  return false if @assigned_to_user_id.nil?
  true
end