Class: Buildium::RentalAppliancesApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ RentalAppliancesApi

Returns a new instance of RentalAppliancesApi.



19
20
21
 
# File 'lib/buildium-ruby/api/rental_appliances_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_appliances_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#create_rental_appliance(rental_appliance_post_message, opts = {}) ⇒ RentalApplianceMessage

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

Parameters:

Returns:



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

def create_rental_appliance(rental_appliance_post_message, opts = {})
  data, _status_code, _headers = create_rental_appliance_with_http_info(rental_appliance_post_message, opts)
  data
end

#create_rental_appliance_service_history(appliance_id, rental_appliance_service_history_post_message, opts = {}) ⇒ RentalApplianceServiceHistoryMessage

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

Parameters:

Returns:



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

def create_rental_appliance_service_history(appliance_id, rental_appliance_service_history_post_message, opts = {})
  data, _status_code, _headers = create_rental_appliance_service_history_with_http_info(appliance_id, rental_appliance_service_history_post_message, opts)
  data
end

#create_rental_appliance_service_history_with_http_info(appliance_id, rental_appliance_service_history_post_message, opts = {}) ⇒ Array<(RentalApplianceServiceHistoryMessage, Integer, Hash)>

Create a service history Creates a service history record for an appliance. &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:

Returns:



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_appliances_api.rb', line 107

def create_rental_appliance_service_history_with_http_info(appliance_id, rental_appliance_service_history_post_message, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RentalAppliancesApi.create_rental_appliance_service_history ...'
  end
  # verify the required parameter 'appliance_id' is set
  if @api_client.config.client_side_validation && appliance_id.nil?
    fail ArgumentError, "Missing the required parameter 'appliance_id' when calling RentalAppliancesApi.create_rental_appliance_service_history"
  end
  # verify the required parameter 'rental_appliance_service_history_post_message' is set
  if @api_client.config.client_side_validation && rental_appliance_service_history_post_message.nil?
    fail ArgumentError, "Missing the required parameter 'rental_appliance_service_history_post_message' when calling RentalAppliancesApi.create_rental_appliance_service_history"
  end
  # resource path
  local_var_path = '/v1/rentals/appliances/{applianceId}/servicehistory'.sub('{' + 'applianceId' + '}', CGI.escape(appliance_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_appliance_service_history_post_message)

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

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

  new_options = opts.merge(
    :operation => :"RentalAppliancesApi.create_rental_appliance_service_history",
    :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: RentalAppliancesApi#create_rental_appliance_service_history\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_rental_appliance_with_http_info(rental_appliance_post_message, opts = {}) ⇒ Array<(RentalApplianceMessage, Integer, Hash)>

Create an appliance Creates a rental property appliance. &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:

Returns:

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

    RentalApplianceMessage 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_appliances_api.rb', line 37

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

  # 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_appliance_post_message)

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

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

  new_options = opts.merge(
    :operation => :"RentalAppliancesApi.create_rental_appliance",
    :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: RentalAppliancesApi#create_rental_appliance\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_rental_appliances(appliance_id, opts = {}) ⇒ nil

Delete an appliance Deletes an appliance. <br /><br /><h4>Required permission(s):</h4><span class="permissionBlock">Rentals &gt; Rental properties and units</span> - ‘View` `Edit`

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


169
170
171
172
 
# File 'lib/buildium-ruby/api/rental_appliances_api.rb', line 169

def delete_rental_appliances(appliance_id, opts = {})
  delete_rental_appliances_with_http_info(appliance_id, opts)
  nil
end

#delete_rental_appliances_with_http_info(appliance_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete an appliance Deletes an appliance. &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:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
220
221
222
223
224
225
 
# File 'lib/buildium-ruby/api/rental_appliances_api.rb', line 179

def delete_rental_appliances_with_http_info(appliance_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RentalAppliancesApi.delete_rental_appliances ...'
  end
  # verify the required parameter 'appliance_id' is set
  if @api_client.config.client_side_validation && appliance_id.nil?
    fail ArgumentError, "Missing the required parameter 'appliance_id' when calling RentalAppliancesApi.delete_rental_appliances"
  end
  # resource path
  local_var_path = '/v1/rentals/appliances/{applianceId}'.sub('{' + 'applianceId' + '}', CGI.escape(appliance_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]

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

  new_options = opts.merge(
    :operation => :"RentalAppliancesApi.delete_rental_appliances",
    :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(:DELETE, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RentalAppliancesApi#delete_rental_appliances\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_rental_appliance_by_id(appliance_id, opts = {}) ⇒ RentalApplianceMessage

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

Parameters:

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

    the optional parameters

Returns:



232
233
234
235
 
# File 'lib/buildium-ruby/api/rental_appliances_api.rb', line 232

def get_rental_appliance_by_id(appliance_id, opts = {})
  data, _status_code, _headers = get_rental_appliance_by_id_with_http_info(appliance_id, opts)
  data
end

#get_rental_appliance_by_id_with_http_info(appliance_id, opts = {}) ⇒ Array<(RentalApplianceMessage, Integer, Hash)>

Retrieve an appliance Retrieves a rental appliance. &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:

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

    the optional parameters

Returns:

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

    RentalApplianceMessage data, response status code and response headers



242
243
244
245
246
247
248
249
250
251
252
253
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
 
# File 'lib/buildium-ruby/api/rental_appliances_api.rb', line 242

def get_rental_appliance_by_id_with_http_info(appliance_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RentalAppliancesApi.get_rental_appliance_by_id ...'
  end
  # verify the required parameter 'appliance_id' is set
  if @api_client.config.client_side_validation && appliance_id.nil?
    fail ArgumentError, "Missing the required parameter 'appliance_id' when calling RentalAppliancesApi.get_rental_appliance_by_id"
  end
  # resource path
  local_var_path = '/v1/rentals/appliances/{applianceId}'.sub('{' + 'applianceId' + '}', CGI.escape(appliance_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] || 'RentalApplianceMessage'

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

  new_options = opts.merge(
    :operation => :"RentalAppliancesApi.get_rental_appliance_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: RentalAppliancesApi#get_rental_appliance_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_rental_appliance_service_history(appliance_id, opts = {}) ⇒ Array<RentalApplianceServiceHistoryMessage>

Retrieve all service history Retrieves all of the service history records for an appliance. <br /><br /><h4>Required permission(s):</h4><span class="permissionBlock">Rentals &gt; Rental properties and units</span> - ‘View`

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :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:



298
299
300
301
 
# File 'lib/buildium-ruby/api/rental_appliances_api.rb', line 298

def get_rental_appliance_service_history(appliance_id, opts = {})
  data, _status_code, _headers = get_rental_appliance_service_history_with_http_info(appliance_id, opts)
  data
end

#get_rental_appliance_service_history_by_id(appliance_id, service_history_id, opts = {}) ⇒ RentalApplianceServiceHistoryMessage

Retrieve a service history Retrieves a specific service history record for a given appliance. <br /><br /><h4>Required permission(s):</h4><span class="permissionBlock">Rentals &gt; Rental properties and units</span> - ‘View`

Parameters:

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

    the optional parameters

Returns:



368
369
370
371
 
# File 'lib/buildium-ruby/api/rental_appliances_api.rb', line 368

def get_rental_appliance_service_history_by_id(appliance_id, service_history_id, opts = {})
  data, _status_code, _headers = get_rental_appliance_service_history_by_id_with_http_info(appliance_id, service_history_id, opts)
  data
end

#get_rental_appliance_service_history_by_id_with_http_info(appliance_id, service_history_id, opts = {}) ⇒ Array<(RentalApplianceServiceHistoryMessage, Integer, Hash)>

Retrieve a service history Retrieves a specific service history record for a given appliance. &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:

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

    the optional parameters

Returns:



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

def get_rental_appliance_service_history_by_id_with_http_info(appliance_id, service_history_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RentalAppliancesApi.get_rental_appliance_service_history_by_id ...'
  end
  # verify the required parameter 'appliance_id' is set
  if @api_client.config.client_side_validation && appliance_id.nil?
    fail ArgumentError, "Missing the required parameter 'appliance_id' when calling RentalAppliancesApi.get_rental_appliance_service_history_by_id"
  end
  # verify the required parameter 'service_history_id' is set
  if @api_client.config.client_side_validation && service_history_id.nil?
    fail ArgumentError, "Missing the required parameter 'service_history_id' when calling RentalAppliancesApi.get_rental_appliance_service_history_by_id"
  end
  # resource path
  local_var_path = '/v1/rentals/appliances/{applianceId}/servicehistory/{serviceHistoryId}'.sub('{' + 'applianceId' + '}', CGI.escape(appliance_id.to_s)).sub('{' + 'serviceHistoryId' + '}', CGI.escape(service_history_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] || 'RentalApplianceServiceHistoryMessage'

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

  new_options = opts.merge(
    :operation => :"RentalAppliancesApi.get_rental_appliance_service_history_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: RentalAppliancesApi#get_rental_appliance_service_history_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_rental_appliance_service_history_with_http_info(appliance_id, opts = {}) ⇒ Array<(Array<RentalApplianceServiceHistoryMessage>, Integer, Hash)>

Retrieve all service history Retrieves all of the service history records for an appliance. &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:

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

    the optional parameters

Options Hash (opts):

  • :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:



311
312
313
314
315
316
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
 
# File 'lib/buildium-ruby/api/rental_appliances_api.rb', line 311

def get_rental_appliance_service_history_with_http_info(appliance_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RentalAppliancesApi.get_rental_appliance_service_history ...'
  end
  # verify the required parameter 'appliance_id' is set
  if @api_client.config.client_side_validation && appliance_id.nil?
    fail ArgumentError, "Missing the required parameter 'appliance_id' when calling RentalAppliancesApi.get_rental_appliance_service_history"
  end
  # resource path
  local_var_path = '/v1/rentals/appliances/{applianceId}/servicehistory'.sub('{' + 'applianceId' + '}', CGI.escape(appliance_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  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<RentalApplianceServiceHistoryMessage>'

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

  new_options = opts.merge(
    :operation => :"RentalAppliancesApi.get_rental_appliance_service_history",
    :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: RentalAppliancesApi#get_rental_appliance_service_history\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_rental_appliances(opts = {}) ⇒ Array<RentalApplianceMessage>

Retrieve all appliances Retrieves all rental appliances. <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 appliances associated to any of the specified rental property identifiers.

  • :unitids (Array<Integer>) —

    Filters results to appliances associated to any of the specified rental unit identifiers.

  • :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:



440
441
442
443
 
# File 'lib/buildium-ruby/api/rental_appliances_api.rb', line 440

def get_rental_appliances(opts = {})
  data, _status_code, _headers = get_rental_appliances_with_http_info(opts)
  data
end

#get_rental_appliances_with_http_info(opts = {}) ⇒ Array<(Array<RentalApplianceMessage>, Integer, Hash)>

Retrieve all appliances Retrieves all rental appliances. &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 appliances associated to any of the specified rental property identifiers.

  • :unitids (Array<Integer>) —

    Filters results to appliances associated to any of the specified rental unit identifiers.

  • :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<RentalApplianceMessage>, Integer, Hash)>) —

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



454
455
456
457
458
459
460
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
 
# File 'lib/buildium-ruby/api/rental_appliances_api.rb', line 454

def get_rental_appliances_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RentalAppliancesApi.get_rental_appliances ...'
  end
  # resource path
  local_var_path = '/v1/rentals/appliances'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'propertyids'] = @api_client.build_collection_param(opts[:'propertyids'], :multi) if !opts[:'propertyids'].nil?
  query_params[:'unitids'] = @api_client.build_collection_param(opts[:'unitids'], :multi) if !opts[:'unitids'].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<RentalApplianceMessage>'

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

  new_options = opts.merge(
    :operation => :"RentalAppliancesApi.get_rental_appliances",
    :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: RentalAppliancesApi#get_rental_appliances\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_rental_appliance(appliance_id, rental_appliance_put_message, opts = {}) ⇒ RentalApplianceMessage

Update an appliance Updates a rental appliance. <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:

  • appliance_id (Integer)
  • rental_appliance_put_message (RentalAppliancePutMessage)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



509
510
511
512
 
# File 'lib/buildium-ruby/api/rental_appliances_api.rb', line 509

def update_rental_appliance(appliance_id, rental_appliance_put_message, opts = {})
  data, _status_code, _headers = update_rental_appliance_with_http_info(appliance_id, rental_appliance_put_message, opts)
  data
end

#update_rental_appliance_with_http_info(appliance_id, rental_appliance_put_message, opts = {}) ⇒ Array<(RentalApplianceMessage, Integer, Hash)>

Update an appliance Updates a rental appliance. &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:

  • appliance_id (Integer)
  • rental_appliance_put_message (RentalAppliancePutMessage)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

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

    RentalApplianceMessage data, response status code and response headers



520
521
522
523
524
525
526
527
528
529
530
531
532
533
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
 
# File 'lib/buildium-ruby/api/rental_appliances_api.rb', line 520

def update_rental_appliance_with_http_info(appliance_id, rental_appliance_put_message, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RentalAppliancesApi.update_rental_appliance ...'
  end
  # verify the required parameter 'appliance_id' is set
  if @api_client.config.client_side_validation && appliance_id.nil?
    fail ArgumentError, "Missing the required parameter 'appliance_id' when calling RentalAppliancesApi.update_rental_appliance"
  end
  # verify the required parameter 'rental_appliance_put_message' is set
  if @api_client.config.client_side_validation && rental_appliance_put_message.nil?
    fail ArgumentError, "Missing the required parameter 'rental_appliance_put_message' when calling RentalAppliancesApi.update_rental_appliance"
  end
  # resource path
  local_var_path = '/v1/rentals/appliances/{applianceId}'.sub('{' + 'applianceId' + '}', CGI.escape(appliance_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_appliance_put_message)

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

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

  new_options = opts.merge(
    :operation => :"RentalAppliancesApi.update_rental_appliance",
    :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: RentalAppliancesApi#update_rental_appliance\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end