Class: Buildium::RentalUnitsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/buildium-ruby/api/rental_units_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ RentalUnitsApi

Returns a new instance of RentalUnitsApi.



19
20
21
 
# File 'lib/buildium-ruby/api/rental_units_api.rb', line 19

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/buildium-ruby/api/rental_units_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#create_rental_unit(rental_units_post_message, opts = {}) ⇒ RentalUnitMessage

Create a unit Creates a rental unit. <br /><br /><h4>Required permission(s):</h4><span class="permissionBlock">Rentals &gt; Rental properties and units</span> - ‘View` `Edit`

Parameters:

  • rental_units_post_message (RentalUnitsPostMessage)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



27
28
29
30
 
# File 'lib/buildium-ruby/api/rental_units_api.rb', line 27

def create_rental_unit(rental_units_post_message, opts = {})
  data, _status_code, _headers = create_rental_unit_with_http_info(rental_units_post_message, opts)
  data
end

#create_rental_unit_note(unit_id, note_post_message, opts = {}) ⇒ NoteMessage

Create a note Creates a rental unit note. <br /><br /><h4>Required permission(s):</h4><span class="permissionBlock">Rentals &gt; Rental properties and units</span> - ‘View` `Edit`

Parameters:

  • unit_id (Integer)
  • note_post_message (NotePostMessage)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



96
97
98
99
 
# File 'lib/buildium-ruby/api/rental_units_api.rb', line 96

def create_rental_unit_note(unit_id, note_post_message, opts = {})
  data, _status_code, _headers = create_rental_unit_note_with_http_info(unit_id, note_post_message, opts)
  data
end

#create_rental_unit_note_with_http_info(unit_id, note_post_message, opts = {}) ⇒ Array<(NoteMessage, Integer, Hash)>

Create a note Creates a rental unit note. &lt;br /&gt;&lt;br /&gt;&lt;h4&gt;Required permission(s):&lt;/h4&gt;&lt;span class&#x3D;&quot;permissionBlock&quot;&gt;Rentals &amp;gt; Rental properties and units&lt;/span&gt; - &#x60;View&#x60; &#x60;Edit&#x60;

Parameters:

  • unit_id (Integer)
  • note_post_message (NotePostMessage)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(NoteMessage, Integer, Hash)>) —

    NoteMessage data, response status code and response headers



107
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
149
150
151
152
153
154
155
156
157
158
159
160
161
162
 
# File 'lib/buildium-ruby/api/rental_units_api.rb', line 107

def create_rental_unit_note_with_http_info(unit_id, note_post_message, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RentalUnitsApi.create_rental_unit_note ...'
  end
  # verify the required parameter 'unit_id' is set
  if @api_client.config.client_side_validation && unit_id.nil?
    fail ArgumentError, "Missing the required parameter 'unit_id' when calling RentalUnitsApi.create_rental_unit_note"
  end
  # verify the required parameter 'note_post_message' is set
  if @api_client.config.client_side_validation && note_post_message.nil?
    fail ArgumentError, "Missing the required parameter 'note_post_message' when calling RentalUnitsApi.create_rental_unit_note"
  end
  # resource path
  local_var_path = '/v1/rentals/units/{unitId}/notes'.sub('{' + 'unitId' + '}', CGI.escape(unit_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
    header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(note_post_message)

  # return_type
  return_type = opts[:debug_return_type] || 'NoteMessage'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'clientSecret']

  new_options = opts.merge(
    :operation => :"RentalUnitsApi.create_rental_unit_note",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RentalUnitsApi#create_rental_unit_note\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_rental_unit_with_http_info(rental_units_post_message, opts = {}) ⇒ Array<(RentalUnitMessage, Integer, Hash)>

Create a unit Creates a rental unit. &lt;br /&gt;&lt;br /&gt;&lt;h4&gt;Required permission(s):&lt;/h4&gt;&lt;span class&#x3D;&quot;permissionBlock&quot;&gt;Rentals &amp;gt; Rental properties and units&lt;/span&gt; - &#x60;View&#x60; &#x60;Edit&#x60;

Parameters:

  • rental_units_post_message (RentalUnitsPostMessage)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(RentalUnitMessage, Integer, Hash)>) —

    RentalUnitMessage data, response status code and response headers



37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/buildium-ruby/api/rental_units_api.rb', line 37

def create_rental_unit_with_http_info(rental_units_post_message, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RentalUnitsApi.create_rental_unit ...'
  end
  # verify the required parameter 'rental_units_post_message' is set
  if @api_client.config.client_side_validation && rental_units_post_message.nil?
    fail ArgumentError, "Missing the required parameter 'rental_units_post_message' when calling RentalUnitsApi.create_rental_unit"
  end
  # resource path
  local_var_path = '/v1/rentals/units'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
    header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(rental_units_post_message)

  # return_type
  return_type = opts[:debug_return_type] || 'RentalUnitMessage'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'clientSecret']

  new_options = opts.merge(
    :operation => :"RentalUnitsApi.create_rental_unit",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RentalUnitsApi#create_rental_unit\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_all_rental_units(opts = {}) ⇒ Array<RentalUnitMessage>

Retrieve all units Retrieves a list of rental property units. <br /><br /><h4>Required permission(s):</h4><span class="permissionBlock">Rentals &gt; Rental properties and units</span> - ‘View`

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :propertyids (Array<Integer>) —

    Filters results to rental units that belong to the specified set of property ids.

  • :lastupdatedfrom (Time) —

    Filters results to any rental units that were updated on or after the specified date. The value must be in UTC and formatted as YYYY-MM-DDTHH:MM:SSZ.

  • :lastupdatedto (Time) —

    Filters results to any rental units that were updated on or before the specified date. The value must be in UTC and formatted as YYYY-MM-DDTHH:MM:SSZ.

  • :orderby (String) —

    &#x60;orderby&#x60; indicates the field(s) and direction to sort the results in the response. See &lt;a href&#x3D;&quot;#section/API-Overview/Bulk-Request-Options&quot;&gt;Bulk Request Options&lt;/a&gt; for more information.

  • :offset (Integer) —

    &#x60;offset&#x60; indicates the position of the first record to return. The &#x60;offset&#x60; is zero-based and the default is 0.

  • :limit (Integer) —

    &#x60;limit&#x60; indicates the maximum number of results to be returned in the response. &#x60;limit&#x60; can range between 1 and 1000 and the default is 50.

Returns:



174
175
176
177
 
# File 'lib/buildium-ruby/api/rental_units_api.rb', line 174

def get_all_rental_units(opts = {})
  data, _status_code, _headers = get_all_rental_units_with_http_info(opts)
  data
end

#get_all_rental_units_with_http_info(opts = {}) ⇒ Array<(Array<RentalUnitMessage>, Integer, Hash)>

Retrieve all units Retrieves a list of rental property units. &lt;br /&gt;&lt;br /&gt;&lt;h4&gt;Required permission(s):&lt;/h4&gt;&lt;span class&#x3D;&quot;permissionBlock&quot;&gt;Rentals &amp;gt; Rental properties and units&lt;/span&gt; - &#x60;View&#x60;

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :propertyids (Array<Integer>) —

    Filters results to rental units that belong to the specified set of property ids.

  • :lastupdatedfrom (Time) —

    Filters results to any rental units that were updated on or after the specified date. The value must be in UTC and formatted as YYYY-MM-DDTHH:MM:SSZ.

  • :lastupdatedto (Time) —

    Filters results to any rental units that were updated on or before the specified date. The value must be in UTC and formatted as YYYY-MM-DDTHH:MM:SSZ.

  • :orderby (String) —

    &#x60;orderby&#x60; indicates the field(s) and direction to sort the results in the response. See &lt;a href&#x3D;&quot;#section/API-Overview/Bulk-Request-Options&quot;&gt;Bulk Request Options&lt;/a&gt; for more information.

  • :offset (Integer) —

    &#x60;offset&#x60; indicates the position of the first record to return. The &#x60;offset&#x60; is zero-based and the default is 0.

  • :limit (Integer) —

    &#x60;limit&#x60; indicates the maximum number of results to be returned in the response. &#x60;limit&#x60; can range between 1 and 1000 and the default is 50.

Returns:

  • (Array<(Array<RentalUnitMessage>, Integer, Hash)>) —

    Array<RentalUnitMessage> data, response status code and response headers



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
 
# File 'lib/buildium-ruby/api/rental_units_api.rb', line 189

def get_all_rental_units_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RentalUnitsApi.get_all_rental_units ...'
  end
  # resource path
  local_var_path = '/v1/rentals/units'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'propertyids'] = @api_client.build_collection_param(opts[:'propertyids'], :multi) if !opts[:'propertyids'].nil?
  query_params[:'lastupdatedfrom'] = opts[:'lastupdatedfrom'] if !opts[:'lastupdatedfrom'].nil?
  query_params[:'lastupdatedto'] = opts[:'lastupdatedto'] if !opts[:'lastupdatedto'].nil?
  query_params[:'orderby'] = opts[:'orderby'] if !opts[:'orderby'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Array<RentalUnitMessage>'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'clientSecret']

  new_options = opts.merge(
    :operation => :"RentalUnitsApi.get_all_rental_units",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RentalUnitsApi#get_all_rental_units\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_features_for_rental_unit_by_id(unit_id, opts = {}) ⇒ RentalUnitFeaturesMessage

Retrieve all amenities Retrieves all amenities for a rental unit. <br /><br /><h4>Required permission(s):</h4><span class="permissionBlock">Rentals &gt; Rental properties and units</span> - ‘View`

Parameters:

  • unit_id (Integer)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



244
245
246
247
 
# File 'lib/buildium-ruby/api/rental_units_api.rb', line 244

def get_features_for_rental_unit_by_id(unit_id, opts = {})
  data, _status_code, _headers = get_features_for_rental_unit_by_id_with_http_info(unit_id, opts)
  data
end

#get_features_for_rental_unit_by_id_with_http_info(unit_id, opts = {}) ⇒ Array<(RentalUnitFeaturesMessage, Integer, Hash)>

Retrieve all amenities Retrieves all amenities for a rental unit. &lt;br /&gt;&lt;br /&gt;&lt;h4&gt;Required permission(s):&lt;/h4&gt;&lt;span class&#x3D;&quot;permissionBlock&quot;&gt;Rentals &amp;gt; Rental properties and units&lt;/span&gt; - &#x60;View&#x60;

Parameters:

  • unit_id (Integer)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(RentalUnitFeaturesMessage, Integer, Hash)>) —

    RentalUnitFeaturesMessage data, response status code and response headers



254
255
256
257
258
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
297
298
299
300
 
# File 'lib/buildium-ruby/api/rental_units_api.rb', line 254

def get_features_for_rental_unit_by_id_with_http_info(unit_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RentalUnitsApi.get_features_for_rental_unit_by_id ...'
  end
  # verify the required parameter 'unit_id' is set
  if @api_client.config.client_side_validation && unit_id.nil?
    fail ArgumentError, "Missing the required parameter 'unit_id' when calling RentalUnitsApi.get_features_for_rental_unit_by_id"
  end
  # resource path
  local_var_path = '/v1/rentals/units/{unitId}/amenities'.sub('{' + 'unitId' + '}', CGI.escape(unit_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'RentalUnitFeaturesMessage'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'clientSecret']

  new_options = opts.merge(
    :operation => :"RentalUnitsApi.get_features_for_rental_unit_by_id",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RentalUnitsApi#get_features_for_rental_unit_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_rental_unit_by_id(unit_id, opts = {}) ⇒ RentalUnitMessage

Retrieve a unit Retrieves a specific rental property unit. <br /><br /><h4>Required permission(s):</h4><span class="permissionBlock">Rentals &gt; Rental properties and units</span> - ‘View`

Parameters:

  • unit_id (Integer) —

    The rental unit identifier.

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

    the optional parameters

Returns:



307
308
309
310
 
# File 'lib/buildium-ruby/api/rental_units_api.rb', line 307

def get_rental_unit_by_id(unit_id, opts = {})
  data, _status_code, _headers = get_rental_unit_by_id_with_http_info(unit_id, opts)
  data
end

#get_rental_unit_by_id_with_http_info(unit_id, opts = {}) ⇒ Array<(RentalUnitMessage, Integer, Hash)>

Retrieve a unit Retrieves a specific rental property unit. &lt;br /&gt;&lt;br /&gt;&lt;h4&gt;Required permission(s):&lt;/h4&gt;&lt;span class&#x3D;&quot;permissionBlock&quot;&gt;Rentals &amp;gt; Rental properties and units&lt;/span&gt; - &#x60;View&#x60;

Parameters:

  • unit_id (Integer) —

    The rental unit identifier.

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

    the optional parameters

Returns:

  • (Array<(RentalUnitMessage, Integer, Hash)>) —

    RentalUnitMessage data, response status code and response headers



317
318
319
320
321
322
323
324
325
326
327
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
 
# File 'lib/buildium-ruby/api/rental_units_api.rb', line 317

def get_rental_unit_by_id_with_http_info(unit_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RentalUnitsApi.get_rental_unit_by_id ...'
  end
  # verify the required parameter 'unit_id' is set
  if @api_client.config.client_side_validation && unit_id.nil?
    fail ArgumentError, "Missing the required parameter 'unit_id' when calling RentalUnitsApi.get_rental_unit_by_id"
  end
  # resource path
  local_var_path = '/v1/rentals/units/{unitId}'.sub('{' + 'unitId' + '}', CGI.escape(unit_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'RentalUnitMessage'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'clientSecret']

  new_options = opts.merge(
    :operation => :"RentalUnitsApi.get_rental_unit_by_id",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RentalUnitsApi#get_rental_unit_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_rental_unit_note_by_note_id(unit_id, note_id, opts = {}) ⇒ NoteMessage

Retrieve a note Retrieves a rental unit note. <br /><br /><h4>Required permission(s):</h4><span class="permissionBlock">Rentals &gt; Rental properties and units</span> - ‘View`

Parameters:

  • unit_id (Integer)
  • note_id (Integer)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



371
372
373
374
 
# File 'lib/buildium-ruby/api/rental_units_api.rb', line 371

def get_rental_unit_note_by_note_id(unit_id, note_id, opts = {})
  data, _status_code, _headers = get_rental_unit_note_by_note_id_with_http_info(unit_id, note_id, opts)
  data
end

#get_rental_unit_note_by_note_id_with_http_info(unit_id, note_id, opts = {}) ⇒ Array<(NoteMessage, Integer, Hash)>

Retrieve a note Retrieves a rental unit note. &lt;br /&gt;&lt;br /&gt;&lt;h4&gt;Required permission(s):&lt;/h4&gt;&lt;span class&#x3D;&quot;permissionBlock&quot;&gt;Rentals &amp;gt; Rental properties and units&lt;/span&gt; - &#x60;View&#x60;

Parameters:

  • unit_id (Integer)
  • note_id (Integer)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(NoteMessage, Integer, Hash)>) —

    NoteMessage data, response status code and response headers



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
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
 
# File 'lib/buildium-ruby/api/rental_units_api.rb', line 382

def get_rental_unit_note_by_note_id_with_http_info(unit_id, note_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RentalUnitsApi.get_rental_unit_note_by_note_id ...'
  end
  # verify the required parameter 'unit_id' is set
  if @api_client.config.client_side_validation && unit_id.nil?
    fail ArgumentError, "Missing the required parameter 'unit_id' when calling RentalUnitsApi.get_rental_unit_note_by_note_id"
  end
  # verify the required parameter 'note_id' is set
  if @api_client.config.client_side_validation && note_id.nil?
    fail ArgumentError, "Missing the required parameter 'note_id' when calling RentalUnitsApi.get_rental_unit_note_by_note_id"
  end
  # resource path
  local_var_path = '/v1/rentals/units/{unitId}/notes/{noteId}'.sub('{' + 'unitId' + '}', CGI.escape(unit_id.to_s)).sub('{' + 'noteId' + '}', CGI.escape(note_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'NoteMessage'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'clientSecret']

  new_options = opts.merge(
    :operation => :"RentalUnitsApi.get_rental_unit_note_by_note_id",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RentalUnitsApi#get_rental_unit_note_by_note_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_rental_unit_notes(unit_id, opts = {}) ⇒ Array<NoteMessage>

Retrieve all notes Retrieves all rental unit notes. <br /><br /><h4>Required permission(s):</h4><span class="permissionBlock">Rentals &gt; Rental properties and units</span> - ‘View`

Parameters:

  • unit_id (Integer)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :updateddatetimefrom (Time) —

    Filters results to any note whose updated date and time are greater than or equal to the specified value. The value must be formatted as YYYY-MM-DD HH:MM:SS.

  • :updateddatetimeto (Time) —

    Filters results to any note whose updated date and time are less than or equal to the specified value. The value must be formatted as YYYY-MM-DD HH:MM:SS.

  • :lastupdatedbyuserid (Integer) —

    Filters results to only notes that were last updated by the specified user identifier.

  • :orderby (String) —

    &#x60;orderby&#x60; indicates the field(s) and direction to sort the results in the response. See &lt;a href&#x3D;&quot;#section/API-Overview/Bulk-Request-Options&quot;&gt;Bulk Request Options&lt;/a&gt; for more information.

  • :offset (Integer) —

    &#x60;offset&#x60; indicates the position of the first record to return. The &#x60;offset&#x60; is zero-based and the default is 0.

  • :limit (Integer) —

    &#x60;limit&#x60; indicates the maximum number of results to be returned in the response. &#x60;limit&#x60; can range between 1 and 1000 and the default is 50.

Returns:



445
446
447
448
 
# File 'lib/buildium-ruby/api/rental_units_api.rb', line 445

def get_rental_unit_notes(unit_id, opts = {})
  data, _status_code, _headers = get_rental_unit_notes_with_http_info(unit_id, opts)
  data
end

#get_rental_unit_notes_with_http_info(unit_id, opts = {}) ⇒ Array<(Array<NoteMessage>, Integer, Hash)>

Retrieve all notes Retrieves all rental unit notes. &lt;br /&gt;&lt;br /&gt;&lt;h4&gt;Required permission(s):&lt;/h4&gt;&lt;span class&#x3D;&quot;permissionBlock&quot;&gt;Rentals &amp;gt; Rental properties and units&lt;/span&gt; - &#x60;View&#x60;

Parameters:

  • unit_id (Integer)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :updateddatetimefrom (Time) —

    Filters results to any note whose updated date and time are greater than or equal to the specified value. The value must be formatted as YYYY-MM-DD HH:MM:SS.

  • :updateddatetimeto (Time) —

    Filters results to any note whose updated date and time are less than or equal to the specified value. The value must be formatted as YYYY-MM-DD HH:MM:SS.

  • :lastupdatedbyuserid (Integer) —

    Filters results to only notes that were last updated by the specified user identifier.

  • :orderby (String) —

    &#x60;orderby&#x60; indicates the field(s) and direction to sort the results in the response. See &lt;a href&#x3D;&quot;#section/API-Overview/Bulk-Request-Options&quot;&gt;Bulk Request Options&lt;/a&gt; for more information.

  • :offset (Integer) —

    &#x60;offset&#x60; indicates the position of the first record to return. The &#x60;offset&#x60; is zero-based and the default is 0.

  • :limit (Integer) —

    &#x60;limit&#x60; indicates the maximum number of results to be returned in the response. &#x60;limit&#x60; can range between 1 and 1000 and the default is 50.

Returns:

  • (Array<(Array<NoteMessage>, Integer, Hash)>) —

    Array<NoteMessage> data, response status code and response headers



461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
 
# File 'lib/buildium-ruby/api/rental_units_api.rb', line 461

def get_rental_unit_notes_with_http_info(unit_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RentalUnitsApi.get_rental_unit_notes ...'
  end
  # verify the required parameter 'unit_id' is set
  if @api_client.config.client_side_validation && unit_id.nil?
    fail ArgumentError, "Missing the required parameter 'unit_id' when calling RentalUnitsApi.get_rental_unit_notes"
  end
  # resource path
  local_var_path = '/v1/rentals/units/{unitId}/notes'.sub('{' + 'unitId' + '}', CGI.escape(unit_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'updateddatetimefrom'] = opts[:'updateddatetimefrom'] if !opts[:'updateddatetimefrom'].nil?
  query_params[:'updateddatetimeto'] = opts[:'updateddatetimeto'] if !opts[:'updateddatetimeto'].nil?
  query_params[:'lastupdatedbyuserid'] = opts[:'lastupdatedbyuserid'] if !opts[:'lastupdatedbyuserid'].nil?
  query_params[:'orderby'] = opts[:'orderby'] if !opts[:'orderby'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Array<NoteMessage>'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'clientSecret']

  new_options = opts.merge(
    :operation => :"RentalUnitsApi.get_rental_unit_notes",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RentalUnitsApi#get_rental_unit_notes\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_note_for_rental_unit(unit_id, note_id, note_put_message, opts = {}) ⇒ NoteMessage

Update a note Updates a rental unit note. <br /><br /><strong>NOTE:</strong> Any field not included in the update request will be set to either an empty string or ‘null` in the database depending on the field definition. <br />The recommended workflow to ensure no data is inadvertently overwritten is to execute a `GET` request for the resource you’re about to update and then use this response to fill any of the fields that are not being updated. <br /><br /><h4>Required permission(s):</h4><span class="permissionBlock">Rentals &gt; Rental properties and units</span> - ‘View` `Edit`

Parameters:

  • unit_id (Integer)
  • note_id (Integer)
  • note_put_message (NotePutMessage)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



522
523
524
525
 
# File 'lib/buildium-ruby/api/rental_units_api.rb', line 522

def update_note_for_rental_unit(unit_id, note_id, note_put_message, opts = {})
  data, _status_code, _headers = update_note_for_rental_unit_with_http_info(unit_id, note_id, note_put_message, opts)
  data
end

#update_note_for_rental_unit_with_http_info(unit_id, note_id, note_put_message, opts = {}) ⇒ Array<(NoteMessage, Integer, Hash)>

Update a note Updates a rental unit note. &lt;br /&gt;&lt;br /&gt;&lt;strong&gt;NOTE:&lt;/strong&gt; Any field not included in the update request will be set to either an empty string or &#x60;null&#x60; in the database depending on the field definition. &lt;br /&gt;The recommended workflow to ensure no data is inadvertently overwritten is to execute a &#x60;GET&#x60; request for the resource you&#39;re about to update and then use this response to fill any of the fields that are not being updated. &lt;br /&gt;&lt;br /&gt;&lt;h4&gt;Required permission(s):&lt;/h4&gt;&lt;span class&#x3D;&quot;permissionBlock&quot;&gt;Rentals &amp;gt; Rental properties and units&lt;/span&gt; - &#x60;View&#x60; &#x60;Edit&#x60;

Parameters:

  • unit_id (Integer)
  • note_id (Integer)
  • note_put_message (NotePutMessage)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(NoteMessage, Integer, Hash)>) —

    NoteMessage data, response status code and response headers



534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
 
# File 'lib/buildium-ruby/api/rental_units_api.rb', line 534

def update_note_for_rental_unit_with_http_info(unit_id, note_id, note_put_message, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RentalUnitsApi.update_note_for_rental_unit ...'
  end
  # verify the required parameter 'unit_id' is set
  if @api_client.config.client_side_validation && unit_id.nil?
    fail ArgumentError, "Missing the required parameter 'unit_id' when calling RentalUnitsApi.update_note_for_rental_unit"
  end
  # verify the required parameter 'note_id' is set
  if @api_client.config.client_side_validation && note_id.nil?
    fail ArgumentError, "Missing the required parameter 'note_id' when calling RentalUnitsApi.update_note_for_rental_unit"
  end
  # verify the required parameter 'note_put_message' is set
  if @api_client.config.client_side_validation && note_put_message.nil?
    fail ArgumentError, "Missing the required parameter 'note_put_message' when calling RentalUnitsApi.update_note_for_rental_unit"
  end
  # resource path
  local_var_path = '/v1/rentals/units/{unitId}/notes/{noteId}'.sub('{' + 'unitId' + '}', CGI.escape(unit_id.to_s)).sub('{' + 'noteId' + '}', CGI.escape(note_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
    header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(note_put_message)

  # return_type
  return_type = opts[:debug_return_type] || 'NoteMessage'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'clientSecret']

  new_options = opts.merge(
    :operation => :"RentalUnitsApi.update_note_for_rental_unit",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RentalUnitsApi#update_note_for_rental_unit\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_rental_unit(unit_id, rental_unit_put_message, opts = {}) ⇒ RentalUnitMessage

Update a unit Updates a rental unit. <br /><br /><strong>NOTE:</strong> Any field not included in the update request will be set to either an empty string or ‘null` in the database depending on the field definition. <br />The recommended workflow to ensure no data is inadvertently overwritten is to execute a `GET` request for the resource you’re about to update and then use this response to fill any of the fields that are not being updated. <br /><br /><h4>Required permission(s):</h4><span class="permissionBlock">Rentals &gt; Rental properties and units</span> - ‘View` `Edit`

Parameters:

  • unit_id (Integer) —

    The identifier of the unit to update.

  • rental_unit_put_message (RentalUnitPutMessage)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



601
602
603
604
 
# File 'lib/buildium-ruby/api/rental_units_api.rb', line 601

def update_rental_unit(unit_id, rental_unit_put_message, opts = {})
  data, _status_code, _headers = update_rental_unit_with_http_info(unit_id, rental_unit_put_message, opts)
  data
end

#update_rental_unit_features(unit_id, rental_unit_features_put_message, opts = {}) ⇒ RentalUnitFeaturesMessage

Update amenities Updates the amenities for a rental unit. <br /><br /><strong>NOTE:</strong> Any field not included in the update request will be set to either an empty string or ‘null` in the database depending on the field definition. <br />The recommended workflow to ensure no data is inadvertently overwritten is to execute a `GET` request for the resource you’re about to update and then use this response to fill any of the fields that are not being updated. <br /><br /><h4>Required permission(s):</h4><span class="permissionBlock">Rentals &gt; Rental properties and units</span> - ‘View` `Edit`

Parameters:

  • unit_id (Integer)
  • rental_unit_features_put_message (RentalUnitFeaturesPutMessage)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



675
676
677
678
 
# File 'lib/buildium-ruby/api/rental_units_api.rb', line 675

def update_rental_unit_features(unit_id, rental_unit_features_put_message, opts = {})
  data, _status_code, _headers = update_rental_unit_features_with_http_info(unit_id, rental_unit_features_put_message, opts)
  data
end

#update_rental_unit_features_with_http_info(unit_id, rental_unit_features_put_message, opts = {}) ⇒ Array<(RentalUnitFeaturesMessage, Integer, Hash)>

Update amenities Updates the amenities for a rental unit. &lt;br /&gt;&lt;br /&gt;&lt;strong&gt;NOTE:&lt;/strong&gt; Any field not included in the update request will be set to either an empty string or &#x60;null&#x60; in the database depending on the field definition. &lt;br /&gt;The recommended workflow to ensure no data is inadvertently overwritten is to execute a &#x60;GET&#x60; request for the resource you&#39;re about to update and then use this response to fill any of the fields that are not being updated. &lt;br /&gt;&lt;br /&gt;&lt;h4&gt;Required permission(s):&lt;/h4&gt;&lt;span class&#x3D;&quot;permissionBlock&quot;&gt;Rentals &amp;gt; Rental properties and units&lt;/span&gt; - &#x60;View&#x60; &#x60;Edit&#x60;

Parameters:

  • unit_id (Integer)
  • rental_unit_features_put_message (RentalUnitFeaturesPutMessage)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(RentalUnitFeaturesMessage, Integer, Hash)>) —

    RentalUnitFeaturesMessage data, response status code and response headers



686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
 
# File 'lib/buildium-ruby/api/rental_units_api.rb', line 686

def update_rental_unit_features_with_http_info(unit_id, rental_unit_features_put_message, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RentalUnitsApi.update_rental_unit_features ...'
  end
  # verify the required parameter 'unit_id' is set
  if @api_client.config.client_side_validation && unit_id.nil?
    fail ArgumentError, "Missing the required parameter 'unit_id' when calling RentalUnitsApi.update_rental_unit_features"
  end
  # verify the required parameter 'rental_unit_features_put_message' is set
  if @api_client.config.client_side_validation && rental_unit_features_put_message.nil?
    fail ArgumentError, "Missing the required parameter 'rental_unit_features_put_message' when calling RentalUnitsApi.update_rental_unit_features"
  end
  # resource path
  local_var_path = '/v1/rentals/units/{unitId}/amenities'.sub('{' + 'unitId' + '}', CGI.escape(unit_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
    header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(rental_unit_features_put_message)

  # return_type
  return_type = opts[:debug_return_type] || 'RentalUnitFeaturesMessage'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'clientSecret']

  new_options = opts.merge(
    :operation => :"RentalUnitsApi.update_rental_unit_features",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RentalUnitsApi#update_rental_unit_features\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_rental_unit_with_http_info(unit_id, rental_unit_put_message, opts = {}) ⇒ Array<(RentalUnitMessage, Integer, Hash)>

Update a unit Updates a rental unit. &lt;br /&gt;&lt;br /&gt;&lt;strong&gt;NOTE:&lt;/strong&gt; Any field not included in the update request will be set to either an empty string or &#x60;null&#x60; in the database depending on the field definition. &lt;br /&gt;The recommended workflow to ensure no data is inadvertently overwritten is to execute a &#x60;GET&#x60; request for the resource you&#39;re about to update and then use this response to fill any of the fields that are not being updated. &lt;br /&gt;&lt;br /&gt;&lt;h4&gt;Required permission(s):&lt;/h4&gt;&lt;span class&#x3D;&quot;permissionBlock&quot;&gt;Rentals &amp;gt; Rental properties and units&lt;/span&gt; - &#x60;View&#x60; &#x60;Edit&#x60;

Parameters:

  • unit_id (Integer) —

    The identifier of the unit to update.

  • rental_unit_put_message (RentalUnitPutMessage)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(RentalUnitMessage, Integer, Hash)>) —

    RentalUnitMessage data, response status code and response headers



612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
 
# File 'lib/buildium-ruby/api/rental_units_api.rb', line 612

def update_rental_unit_with_http_info(unit_id, rental_unit_put_message, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RentalUnitsApi.update_rental_unit ...'
  end
  # verify the required parameter 'unit_id' is set
  if @api_client.config.client_side_validation && unit_id.nil?
    fail ArgumentError, "Missing the required parameter 'unit_id' when calling RentalUnitsApi.update_rental_unit"
  end
  # verify the required parameter 'rental_unit_put_message' is set
  if @api_client.config.client_side_validation && rental_unit_put_message.nil?
    fail ArgumentError, "Missing the required parameter 'rental_unit_put_message' when calling RentalUnitsApi.update_rental_unit"
  end
  # resource path
  local_var_path = '/v1/rentals/units/{unitId}'.sub('{' + 'unitId' + '}', CGI.escape(unit_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
    header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(rental_unit_put_message)

  # return_type
  return_type = opts[:debug_return_type] || 'RentalUnitMessage'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'clientSecret']

  new_options = opts.merge(
    :operation => :"RentalUnitsApi.update_rental_unit",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RentalUnitsApi#update_rental_unit\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end