Class: Buildium::CreateResourceRequest

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateResourceRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
210
211
212
213
214
215
216
217
218
219
 
# File 'lib/buildium-ruby/models/create_resource_request.rb', line 147

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

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

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

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

  if attributes.key?(:'requested_by_entity_id')
    self.requested_by_entity_id = attributes[:'requested_by_entity_id']
  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?(:'is_entry_permitted_by_resident')
    self.is_entry_permitted_by_resident = attributes[:'is_entry_permitted_by_resident']
  end

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

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

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

  if attributes.key?(:'share_with_board_members')
    self.share_with_board_members = attributes[:'share_with_board_members']
  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. If not provided, assignment rules in the resident center settings (if configured) will be used for assignment.



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

def assigned_to_user_id
  @assigned_to_user_id
end

#category_id ⇒ Object

The category identifier to assign the request.



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

def category_id
  @category_id
end

#description ⇒ Object

Request description. The description can not exceed 65500 characters.



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

def description
  @description
end

#does_resident_have_pets ⇒ Object

Indicates whether the resident has pets. Set this value to null if the resident has not provided a response.



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

def does_resident_have_pets
  @does_resident_have_pets
end

#due_date ⇒ Object

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



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

def due_date
  @due_date
end

#is_entry_permitted_by_resident ⇒ Object

Indicates whether the resident has explicitly granted permission to enter the unit. Set this value to null if the resident has not provided a response.



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

def is_entry_permitted_by_resident
  @is_entry_permitted_by_resident
end

#priority ⇒ Object

Request priority.



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

def priority
  @priority
end

#requested_by_entity_id ⇒ Object

The unique identifier of the resident that submitted the request.



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

def requested_by_entity_id
  @requested_by_entity_id
end

#resident_entry_notes ⇒ Object

Notes provided by the resident specific to entering the premises. The value cannot exceed 65535 characters.



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

def resident_entry_notes
  @resident_entry_notes
end

#share_with_board_members ⇒ Object

Indicates whether the request is shared with board members (applies to requests for associations only). Defaults to False if not set or for rental requests.



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

def share_with_board_members
  @share_with_board_members
end

#share_with_rental_owners ⇒ Object

Indicates whether the request is shared with rental owners (applies to requests for rentals only). Defaults to False if not set or for association requests.



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

def share_with_rental_owners
  @share_with_rental_owners
end

#sub_category_id ⇒ Object

The subcategory identifier to assign the request.



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

def sub_category_id
  @sub_category_id
end

#task_status ⇒ Object

Request status.



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

def task_status
  @task_status
end

#title ⇒ Object

Request title. The title can not exceed 127 characters.



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

def title
  @title
end

#unit_agreement_id ⇒ Object

The unique identifier of the unit agreement associated with the request.



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

def unit_agreement_id
  @unit_agreement_id
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



107
108
109
 
# File 'lib/buildium-ruby/models/create_resource_request.rb', line 107

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
 
# File 'lib/buildium-ruby/models/create_resource_request.rb', line 86

def self.attribute_map
  {
    :'title' => :'Title',
    :'description' => :'Description',
    :'category_id' => :'CategoryId',
    :'sub_category_id' => :'SubCategoryId',
    :'unit_agreement_id' => :'UnitAgreementId',
    :'requested_by_entity_id' => :'RequestedByEntityId',
    :'assigned_to_user_id' => :'AssignedToUserId',
    :'task_status' => :'TaskStatus',
    :'priority' => :'Priority',
    :'due_date' => :'DueDate',
    :'is_entry_permitted_by_resident' => :'IsEntryPermittedByResident',
    :'does_resident_have_pets' => :'DoesResidentHavePets',
    :'resident_entry_notes' => :'ResidentEntryNotes',
    :'share_with_rental_owners' => :'ShareWithRentalOwners',
    :'share_with_board_members' => :'ShareWithBoardMembers'
  }
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
 
# File 'lib/buildium-ruby/models/create_resource_request.rb', line 339

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

.openapi_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



139
140
141
142
143
 
# File 'lib/buildium-ruby/models/create_resource_request.rb', line 139

def self.openapi_all_of
  [
  :'ResidentRequestTaskPostMessage'
  ]
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



133
134
135
136
 
# File 'lib/buildium-ruby/models/create_resource_request.rb', line 133

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

.openapi_types ⇒ Object

Attribute type mapping.



112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
 
# File 'lib/buildium-ruby/models/create_resource_request.rb', line 112

def self.openapi_types
  {
    :'title' => :'String',
    :'description' => :'String',
    :'category_id' => :'Integer',
    :'sub_category_id' => :'Integer',
    :'unit_agreement_id' => :'Integer',
    :'requested_by_entity_id' => :'Integer',
    :'assigned_to_user_id' => :'Integer',
    :'task_status' => :'String',
    :'priority' => :'String',
    :'due_date' => :'Date',
    :'is_entry_permitted_by_resident' => :'Boolean',
    :'does_resident_have_pets' => :'Boolean',
    :'resident_entry_notes' => :'String',
    :'share_with_rental_owners' => :'Boolean',
    :'share_with_board_members' => :'Boolean'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      title == o.title &&
      description == o.description &&
      category_id == o.category_id &&
      sub_category_id == o.sub_category_id &&
      unit_agreement_id == o.unit_agreement_id &&
      requested_by_entity_id == o.requested_by_entity_id &&
      assigned_to_user_id == o.assigned_to_user_id &&
      task_status == o.task_status &&
      priority == o.priority &&
      due_date == o.due_date &&
      is_entry_permitted_by_resident == o.is_entry_permitted_by_resident &&
      does_resident_have_pets == o.does_resident_have_pets &&
      resident_entry_notes == o.resident_entry_notes &&
      share_with_rental_owners == o.share_with_rental_owners &&
      share_with_board_members == o.share_with_board_members
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



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
405
406
407
 
# File 'lib/buildium-ruby/models/create_resource_request.rb', line 370

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



441
442
443
444
445
446
447
448
449
450
451
452
453
 
# File 'lib/buildium-ruby/models/create_resource_request.rb', line 441

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



346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
 
# File 'lib/buildium-ruby/models/create_resource_request.rb', line 346

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


326
327
328
 
# File 'lib/buildium-ruby/models/create_resource_request.rb', line 326

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



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

def hash
  [title, description, category_id, sub_category_id, unit_agreement_id, requested_by_entity_id, assigned_to_user_id, task_status, priority, due_date, is_entry_permitted_by_resident, does_resident_have_pets, resident_entry_notes, share_with_rental_owners, share_with_board_members].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



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

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 @unit_agreement_id.nil?
    invalid_properties.push('invalid value for "unit_agreement_id", unit_agreement_id cannot be nil.')
  end

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

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

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



417
418
419
 
# File 'lib/buildium-ruby/models/create_resource_request.rb', line 417

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



423
424
425
426
427
428
429
430
431
432
433
434
435
 
# File 'lib/buildium-ruby/models/create_resource_request.rb', line 423

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



411
412
413
 
# File 'lib/buildium-ruby/models/create_resource_request.rb', line 411

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



254
255
256
257
258
259
260
261
262
263
264
265
266
 
# File 'lib/buildium-ruby/models/create_resource_request.rb', line 254

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