Class: Buildium::AllTasksMessage

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

Overview

This object represents a task.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ AllTasksMessage

Initializes the object

Parameters:

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

    Model attributes in the form of hash



137
138
139
140
141
142
143
144
145
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
 
# File 'lib/buildium-ruby/models/all_tasks_message.rb', line 137

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#assigned_to_user_id ⇒ Object

The unique identifier of the staff user assigned to the task.



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

def assigned_to_user_id
  @assigned_to_user_id
end

#category ⇒ Object

Returns the value of attribute category.



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

def category
  @category
end

#created_date_time ⇒ Object

The date and time the task was created.



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

def created_date_time
  @created_date_time
end

#description ⇒ Object

Task description.



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

def description
  @description
end

#due_date ⇒ Object

Task due date.



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

def due_date
  @due_date
end

#id ⇒ Object

Task unique identifier.



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

def id
  @id
end

#last_updated_date_time ⇒ Object

The date and time the task was last updated.



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

def last_updated_date_time
  @last_updated_date_time
end

#priority ⇒ Object

Task priority.



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

def priority
  @priority
end

#property ⇒ Object

Returns the value of attribute property.



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

def property
  @property
end

#requested_by_user_entity ⇒ Object

Returns the value of attribute requested_by_user_entity.



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

def requested_by_user_entity
  @requested_by_user_entity
end

#task_status ⇒ Object

Task status.



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

def task_status
  @task_status
end

#task_type ⇒ Object

The task type.



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

def task_type
  @task_type
end

#title ⇒ Object

Task title.



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

def title
  @title
end

#unit_agreement ⇒ Object

Returns the value of attribute unit_agreement.



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

def unit_agreement
  @unit_agreement
end

#unit_id ⇒ Object

The unit unique identifier associated with the task.



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

def unit_id
  @unit_id
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



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

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
 
# File 'lib/buildium-ruby/models/all_tasks_message.rb', line 83

def self.attribute_map
  {
    :'id' => :'Id',
    :'task_type' => :'TaskType',
    :'category' => :'Category',
    :'title' => :'Title',
    :'description' => :'Description',
    :'property' => :'Property',
    :'unit_id' => :'UnitId',
    :'unit_agreement' => :'UnitAgreement',
    :'requested_by_user_entity' => :'RequestedByUserEntity',
    :'assigned_to_user_id' => :'AssignedToUserId',
    :'task_status' => :'TaskStatus',
    :'priority' => :'Priority',
    :'due_date' => :'DueDate',
    :'created_date_time' => :'CreatedDateTime',
    :'last_updated_date_time' => :'LastUpdatedDateTime'
  }
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



297
298
299
 
# File 'lib/buildium-ruby/models/all_tasks_message.rb', line 297

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



130
131
132
133
 
# File 'lib/buildium-ruby/models/all_tasks_message.rb', line 130

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

.openapi_types ⇒ Object

Attribute type mapping.



109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
 
# File 'lib/buildium-ruby/models/all_tasks_message.rb', line 109

def self.openapi_types
  {
    :'id' => :'Integer',
    :'task_type' => :'String',
    :'category' => :'TaskCategoryResponseMessage',
    :'title' => :'String',
    :'description' => :'String',
    :'property' => :'PropertyMessage',
    :'unit_id' => :'Integer',
    :'unit_agreement' => :'UnitAgreementMessage',
    :'requested_by_user_entity' => :'RequestedByUserEntityMessage',
    :'assigned_to_user_id' => :'Integer',
    :'task_status' => :'String',
    :'priority' => :'String',
    :'due_date' => :'Date',
    :'created_date_time' => :'Time',
    :'last_updated_date_time' => :'Time'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      task_type == o.task_type &&
      category == o.category &&
      title == o.title &&
      description == o.description &&
      property == o.property &&
      unit_id == o.unit_id &&
      unit_agreement == o.unit_agreement &&
      requested_by_user_entity == o.requested_by_user_entity &&
      assigned_to_user_id == o.assigned_to_user_id &&
      task_status == o.task_status &&
      priority == o.priority &&
      due_date == o.due_date &&
      created_date_time == o.created_date_time &&
      last_updated_date_time == o.last_updated_date_time
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



328
329
330
331
332
333
334
335
336
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
 
# File 'lib/buildium-ruby/models/all_tasks_message.rb', line 328

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



399
400
401
402
403
404
405
406
407
408
409
410
411
 
# File 'lib/buildium-ruby/models/all_tasks_message.rb', line 399

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



304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
 
# File 'lib/buildium-ruby/models/all_tasks_message.rb', line 304

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


284
285
286
 
# File 'lib/buildium-ruby/models/all_tasks_message.rb', line 284

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



290
291
292
 
# File 'lib/buildium-ruby/models/all_tasks_message.rb', line 290

def hash
  [id, task_type, category, title, description, property, unit_id, unit_agreement, requested_by_user_entity, assigned_to_user_id, task_status, priority, due_date, created_date_time, last_updated_date_time].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



213
214
215
216
 
# File 'lib/buildium-ruby/models/all_tasks_message.rb', line 213

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



375
376
377
 
# File 'lib/buildium-ruby/models/all_tasks_message.rb', line 375

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



381
382
383
384
385
386
387
388
389
390
391
392
393
 
# File 'lib/buildium-ruby/models/all_tasks_message.rb', line 381

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



369
370
371
 
# File 'lib/buildium-ruby/models/all_tasks_message.rb', line 369

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



220
221
222
223
224
225
226
227
228
 
# File 'lib/buildium-ruby/models/all_tasks_message.rb', line 220

def valid?
  task_type_validator = EnumAttributeValidator.new('String', ["ContactRequest", "ResidentRequest", "Todo", "RentalOwnerRequest"])
  return false unless task_type_validator.valid?(@task_type)
  task_status_validator = EnumAttributeValidator.new('String', ["New", "InProgress", "Completed", "Deferred", "Closed"])
  return false unless task_status_validator.valid?(@task_status)
  priority_validator = EnumAttributeValidator.new('String', ["Low", "Normal", "High"])
  return false unless priority_validator.valid?(@priority)
  true
end