Class: Buildium::RentalOwnerRequestsApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ RentalOwnerRequestsApi

Returns a new instance of RentalOwnerRequestsApi.



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

def api_client
  @api_client
end

Instance Method Details

#create_rental_owner_request_task(rental_owner_request_task_post_message, opts = {}) ⇒ RentalOwnerRequestTaskMessage

Create a rental owner request Creates a rental owner request. <br /><br /><h4>Required permission(s):</h4><span class="permissionBlock">Tasks &gt; Tasks</span> - ‘View` `Edit`

Parameters:

Returns:



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

def create_rental_owner_request_task(rental_owner_request_task_post_message, opts = {})
  data, _status_code, _headers = create_rental_owner_request_task_with_http_info(rental_owner_request_task_post_message, opts)
  data
end

#create_rental_owner_request_task_with_http_info(rental_owner_request_task_post_message, opts = {}) ⇒ Array<(RentalOwnerRequestTaskMessage, Integer, Hash)>

Create a rental owner request Creates a rental owner request. &lt;br /&gt;&lt;br /&gt;&lt;h4&gt;Required permission(s):&lt;/h4&gt;&lt;span class&#x3D;&quot;permissionBlock&quot;&gt;Tasks &amp;gt; Tasks&lt;/span&gt; - &#x60;View&#x60; &#x60;Edit&#x60;

Parameters:

Returns:



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

def create_rental_owner_request_task_with_http_info(rental_owner_request_task_post_message, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RentalOwnerRequestsApi.create_rental_owner_request_task ...'
  end
  # verify the required parameter 'rental_owner_request_task_post_message' is set
  if @api_client.config.client_side_validation && rental_owner_request_task_post_message.nil?
    fail ArgumentError, "Missing the required parameter 'rental_owner_request_task_post_message' when calling RentalOwnerRequestsApi.create_rental_owner_request_task"
  end
  # resource path
  local_var_path = '/v1/tasks/rentalownerrequests'

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

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

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

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

#get_all_rental_owner_request_tasks(opts = {}) ⇒ Array<RentalOwnerRequestTaskMessage>

Retrieve all rental owner requests Retrieves all rental owner requests. <br /><br /><h4>Required permission(s):</h4><span class="permissionBlock">Tasks &gt; Tasks</span> - ‘View`

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :entitytype (String) —

    Specifies the type of entity that the &#x60;EntityId&#x60; field refers to. This field is required if the &#x60;EntityId&#x60; field is populated.

  • :entityid (Integer) —

    Filters results to any task associated with the specified entity id value. The value must be of the type specified in the &#x60;EntityType&#x60; field.

  • :statuses (Array<String>) —

    Filters results by the status of the task. If no status is specified, tasks with any status will be returned.

  • :unitid (Integer) —

    Filters results to any task associated with the unit identifier.

  • :lastupdatedfrom (Date) —

    Filters results to any tasks were updated on or after the specified date. The value must be formatted as YYYY-MM-DD.

  • :lastupdatedto (Date) —

    Filters results to any tasks were updated on or before the specified date. The value must be formatted as YYYY-MM-DD.

  • :duedatefrom (Date) —

    Filters results to any tasks with a due date on or after the specified date. The value must be formatted as YYYY-MM-DD.

  • :duedateto (Date) —

    Filters results to any tasks with a due date on or before the specified date. The value must be formatted as YYYY-MM-DD.

  • :taskcategoryid (Integer) —

    Filters results to any tasks with the specified category identifier.

  • :priorities (Array<String>) —

    Filters results to any tasks whose priority matches the specified values. If no priority is specified, tasks with any priority will be returned.

  • :assignedtoid (Integer) —

    Filters results to any tasks that have been assigned to the specified staff user identifier.

  • :tasktitle (String) —

    Filters results to any task whose title contains the specified value.

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



109
110
111
112
 
# File 'lib/buildium-ruby/api/rental_owner_requests_api.rb', line 109

def get_all_rental_owner_request_tasks(opts = {})
  data, _status_code, _headers = get_all_rental_owner_request_tasks_with_http_info(opts)
  data
end

#get_all_rental_owner_request_tasks_with_http_info(opts = {}) ⇒ Array<(Array<RentalOwnerRequestTaskMessage>, Integer, Hash)>

Retrieve all rental owner requests Retrieves all rental owner requests. &lt;br /&gt;&lt;br /&gt;&lt;h4&gt;Required permission(s):&lt;/h4&gt;&lt;span class&#x3D;&quot;permissionBlock&quot;&gt;Tasks &amp;gt; Tasks&lt;/span&gt; - &#x60;View&#x60;

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :entitytype (String) —

    Specifies the type of entity that the &#x60;EntityId&#x60; field refers to. This field is required if the &#x60;EntityId&#x60; field is populated.

  • :entityid (Integer) —

    Filters results to any task associated with the specified entity id value. The value must be of the type specified in the &#x60;EntityType&#x60; field.

  • :statuses (Array<String>) —

    Filters results by the status of the task. If no status is specified, tasks with any status will be returned.

  • :unitid (Integer) —

    Filters results to any task associated with the unit identifier.

  • :lastupdatedfrom (Date) —

    Filters results to any tasks were updated on or after the specified date. The value must be formatted as YYYY-MM-DD.

  • :lastupdatedto (Date) —

    Filters results to any tasks were updated on or before the specified date. The value must be formatted as YYYY-MM-DD.

  • :duedatefrom (Date) —

    Filters results to any tasks with a due date on or after the specified date. The value must be formatted as YYYY-MM-DD.

  • :duedateto (Date) —

    Filters results to any tasks with a due date on or before the specified date. The value must be formatted as YYYY-MM-DD.

  • :taskcategoryid (Integer) —

    Filters results to any tasks with the specified category identifier.

  • :priorities (Array<String>) —

    Filters results to any tasks whose priority matches the specified values. If no priority is specified, tasks with any priority will be returned.

  • :assignedtoid (Integer) —

    Filters results to any tasks that have been assigned to the specified staff user identifier.

  • :tasktitle (String) —

    Filters results to any task whose title contains the specified value.

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

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



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

def get_all_rental_owner_request_tasks_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RentalOwnerRequestsApi.get_all_rental_owner_request_tasks ...'
  end
  allowable_values = ["Rental", "RentalOwner", "Association"]
  if @api_client.config.client_side_validation && opts[:'entitytype'] && !allowable_values.include?(opts[:'entitytype'])
    fail ArgumentError, "invalid value for \"entitytype\", must be one of #{allowable_values}"
  end
  allowable_values = ["New", "InProgress", "Completed", "Deferred", "Closed"]
  if @api_client.config.client_side_validation && opts[:'statuses'] && !opts[:'statuses'].all? { |item| allowable_values.include?(item) }
    fail ArgumentError, "invalid value for \"statuses\", must include one of #{allowable_values}"
  end
  allowable_values = ["Low", "Normal", "High"]
  if @api_client.config.client_side_validation && opts[:'priorities'] && !opts[:'priorities'].all? { |item| allowable_values.include?(item) }
    fail ArgumentError, "invalid value for \"priorities\", must include one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/v1/tasks/rentalownerrequests'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'entitytype'] = opts[:'entitytype'] if !opts[:'entitytype'].nil?
  query_params[:'entityid'] = opts[:'entityid'] if !opts[:'entityid'].nil?
  query_params[:'statuses'] = @api_client.build_collection_param(opts[:'statuses'], :multi) if !opts[:'statuses'].nil?
  query_params[:'unitid'] = opts[:'unitid'] if !opts[:'unitid'].nil?
  query_params[:'lastupdatedfrom'] = opts[:'lastupdatedfrom'] if !opts[:'lastupdatedfrom'].nil?
  query_params[:'lastupdatedto'] = opts[:'lastupdatedto'] if !opts[:'lastupdatedto'].nil?
  query_params[:'duedatefrom'] = opts[:'duedatefrom'] if !opts[:'duedatefrom'].nil?
  query_params[:'duedateto'] = opts[:'duedateto'] if !opts[:'duedateto'].nil?
  query_params[:'taskcategoryid'] = opts[:'taskcategoryid'] if !opts[:'taskcategoryid'].nil?
  query_params[:'priorities'] = @api_client.build_collection_param(opts[:'priorities'], :multi) if !opts[:'priorities'].nil?
  query_params[:'assignedtoid'] = opts[:'assignedtoid'] if !opts[:'assignedtoid'].nil?
  query_params[:'tasktitle'] = opts[:'tasktitle'] if !opts[:'tasktitle'].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<RentalOwnerRequestTaskMessage>'

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

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

#get_rental_owner_request_task_by_id(rental_owner_request_task_id, opts = {}) ⇒ RentalOwnerRequestTaskMessage

Retrieve a rental owner request Retrieves a specific rental owner request. <br /><br /><h4>Required permission(s):</h4><span class="permissionBlock">Tasks &gt; Tasks</span> - ‘View`

Parameters:

  • rental_owner_request_task_id (Integer) —

    The rental owner request identifier.

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

    the optional parameters

Returns:



209
210
211
212
 
# File 'lib/buildium-ruby/api/rental_owner_requests_api.rb', line 209

def get_rental_owner_request_task_by_id(rental_owner_request_task_id, opts = {})
  data, _status_code, _headers = get_rental_owner_request_task_by_id_with_http_info(rental_owner_request_task_id, opts)
  data
end

#get_rental_owner_request_task_by_id_with_http_info(rental_owner_request_task_id, opts = {}) ⇒ Array<(RentalOwnerRequestTaskMessage, Integer, Hash)>

Retrieve a rental owner request Retrieves a specific rental owner request. &lt;br /&gt;&lt;br /&gt;&lt;h4&gt;Required permission(s):&lt;/h4&gt;&lt;span class&#x3D;&quot;permissionBlock&quot;&gt;Tasks &amp;gt; Tasks&lt;/span&gt; - &#x60;View&#x60;

Parameters:

  • rental_owner_request_task_id (Integer) —

    The rental owner request identifier.

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

    the optional parameters

Returns:



219
220
221
222
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
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
 
# File 'lib/buildium-ruby/api/rental_owner_requests_api.rb', line 219

def get_rental_owner_request_task_by_id_with_http_info(rental_owner_request_task_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RentalOwnerRequestsApi.get_rental_owner_request_task_by_id ...'
  end
  # verify the required parameter 'rental_owner_request_task_id' is set
  if @api_client.config.client_side_validation && rental_owner_request_task_id.nil?
    fail ArgumentError, "Missing the required parameter 'rental_owner_request_task_id' when calling RentalOwnerRequestsApi.get_rental_owner_request_task_by_id"
  end
  # resource path
  local_var_path = '/v1/tasks/rentalownerrequests/{rentalOwnerRequestTaskId}'.sub('{' + 'rentalOwnerRequestTaskId' + '}', CGI.escape(rental_owner_request_task_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] || 'RentalOwnerRequestTaskMessage'

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

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

#get_rental_owner_request_task_contribution_data(rental_owner_request_task_id, opts = {}) ⇒ RentalOwnerContributionDataMessage

Retrieve rental owner contribution request Retrieves the contribution details for a rental owner contribution request. <br /><br /><h4>Required permission(s):</h4><span class="permissionBlock">Tasks &gt; Tasks</span> - ‘View`

Parameters:

  • rental_owner_request_task_id (Integer) —

    The rental owner request identifier.

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

    the optional parameters

Returns:



272
273
274
275
 
# File 'lib/buildium-ruby/api/rental_owner_requests_api.rb', line 272

def get_rental_owner_request_task_contribution_data(rental_owner_request_task_id, opts = {})
  data, _status_code, _headers = get_rental_owner_request_task_contribution_data_with_http_info(rental_owner_request_task_id, opts)
  data
end

#get_rental_owner_request_task_contribution_data_with_http_info(rental_owner_request_task_id, opts = {}) ⇒ Array<(RentalOwnerContributionDataMessage, Integer, Hash)>

Retrieve rental owner contribution request Retrieves the contribution details for a rental owner contribution request. &lt;br /&gt;&lt;br /&gt;&lt;h4&gt;Required permission(s):&lt;/h4&gt;&lt;span class&#x3D;&quot;permissionBlock&quot;&gt;Tasks &amp;gt; Tasks&lt;/span&gt; - &#x60;View&#x60;

Parameters:

  • rental_owner_request_task_id (Integer) —

    The rental owner request identifier.

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

    the optional parameters

Returns:



282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
 
# File 'lib/buildium-ruby/api/rental_owner_requests_api.rb', line 282

def get_rental_owner_request_task_contribution_data_with_http_info(rental_owner_request_task_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RentalOwnerRequestsApi.get_rental_owner_request_task_contribution_data ...'
  end
  # verify the required parameter 'rental_owner_request_task_id' is set
  if @api_client.config.client_side_validation && rental_owner_request_task_id.nil?
    fail ArgumentError, "Missing the required parameter 'rental_owner_request_task_id' when calling RentalOwnerRequestsApi.get_rental_owner_request_task_contribution_data"
  end
  # resource path
  local_var_path = '/v1/tasks/rentalownerrequests/{rentalOwnerRequestTaskId}/contributiondata'.sub('{' + 'rentalOwnerRequestTaskId' + '}', CGI.escape(rental_owner_request_task_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] || 'RentalOwnerContributionDataMessage'

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

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

#update_rental_owner_request_task(rental_owner_request_task_id, rental_owner_request_task_put_message, opts = {}) ⇒ RentalOwnerRequestTaskMessage

Update a rental owner request Updates a rental owner request. <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">Tasks &gt; Tasks</span> - ‘View` `Edit`

Parameters:

  • rental_owner_request_task_id (Integer) —

    The rental owner request identifier.

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

    the optional parameters

Returns:



336
337
338
339
 
# File 'lib/buildium-ruby/api/rental_owner_requests_api.rb', line 336

def update_rental_owner_request_task(rental_owner_request_task_id, rental_owner_request_task_put_message, opts = {})
  data, _status_code, _headers = update_rental_owner_request_task_with_http_info(rental_owner_request_task_id, rental_owner_request_task_put_message, opts)
  data
end

#update_rental_owner_request_task_contribution_data(rental_owner_request_task_id, rental_owner_contribution_data_put_message, opts = {}) ⇒ RentalOwnerContributionDataMessage

Update a rental owner contribution request Updates the contribution details for a rental owner contribution request. <br /><br /><h4>Required permission(s):</h4><span class="permissionBlock">Tasks &gt; Tasks</span> - ‘View` `Edit`

Parameters:

  • rental_owner_request_task_id (Integer) —

    The rental owner request identifier.

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

    the optional parameters

Returns:



410
411
412
413
 
# File 'lib/buildium-ruby/api/rental_owner_requests_api.rb', line 410

def update_rental_owner_request_task_contribution_data(rental_owner_request_task_id, rental_owner_contribution_data_put_message, opts = {})
  data, _status_code, _headers = update_rental_owner_request_task_contribution_data_with_http_info(rental_owner_request_task_id, rental_owner_contribution_data_put_message, opts)
  data
end

#update_rental_owner_request_task_contribution_data_with_http_info(rental_owner_request_task_id, rental_owner_contribution_data_put_message, opts = {}) ⇒ Array<(RentalOwnerContributionDataMessage, Integer, Hash)>

Update a rental owner contribution request Updates the contribution details for a rental owner contribution request. &lt;br /&gt;&lt;br /&gt;&lt;h4&gt;Required permission(s):&lt;/h4&gt;&lt;span class&#x3D;&quot;permissionBlock&quot;&gt;Tasks &amp;gt; Tasks&lt;/span&gt; - &#x60;View&#x60; &#x60;Edit&#x60;

Parameters:

  • rental_owner_request_task_id (Integer) —

    The rental owner request identifier.

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

    the optional parameters

Returns:



421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
 
# File 'lib/buildium-ruby/api/rental_owner_requests_api.rb', line 421

def update_rental_owner_request_task_contribution_data_with_http_info(rental_owner_request_task_id, rental_owner_contribution_data_put_message, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RentalOwnerRequestsApi.update_rental_owner_request_task_contribution_data ...'
  end
  # verify the required parameter 'rental_owner_request_task_id' is set
  if @api_client.config.client_side_validation && rental_owner_request_task_id.nil?
    fail ArgumentError, "Missing the required parameter 'rental_owner_request_task_id' when calling RentalOwnerRequestsApi.update_rental_owner_request_task_contribution_data"
  end
  # verify the required parameter 'rental_owner_contribution_data_put_message' is set
  if @api_client.config.client_side_validation && rental_owner_contribution_data_put_message.nil?
    fail ArgumentError, "Missing the required parameter 'rental_owner_contribution_data_put_message' when calling RentalOwnerRequestsApi.update_rental_owner_request_task_contribution_data"
  end
  # resource path
  local_var_path = '/v1/tasks/rentalownerrequests/{rentalOwnerRequestTaskId}/contributiondata'.sub('{' + 'rentalOwnerRequestTaskId' + '}', CGI.escape(rental_owner_request_task_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_owner_contribution_data_put_message)

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

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

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

#update_rental_owner_request_task_with_http_info(rental_owner_request_task_id, rental_owner_request_task_put_message, opts = {}) ⇒ Array<(RentalOwnerRequestTaskMessage, Integer, Hash)>

Update a rental owner request Updates a rental owner request. &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;Tasks &amp;gt; Tasks&lt;/span&gt; - &#x60;View&#x60; &#x60;Edit&#x60;

Parameters:

  • rental_owner_request_task_id (Integer) —

    The rental owner request identifier.

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

    the optional parameters

Returns:



347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
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
 
# File 'lib/buildium-ruby/api/rental_owner_requests_api.rb', line 347

def update_rental_owner_request_task_with_http_info(rental_owner_request_task_id, rental_owner_request_task_put_message, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RentalOwnerRequestsApi.update_rental_owner_request_task ...'
  end
  # verify the required parameter 'rental_owner_request_task_id' is set
  if @api_client.config.client_side_validation && rental_owner_request_task_id.nil?
    fail ArgumentError, "Missing the required parameter 'rental_owner_request_task_id' when calling RentalOwnerRequestsApi.update_rental_owner_request_task"
  end
  # verify the required parameter 'rental_owner_request_task_put_message' is set
  if @api_client.config.client_side_validation && rental_owner_request_task_put_message.nil?
    fail ArgumentError, "Missing the required parameter 'rental_owner_request_task_put_message' when calling RentalOwnerRequestsApi.update_rental_owner_request_task"
  end
  # resource path
  local_var_path = '/v1/tasks/rentalownerrequests/{rentalOwnerRequestTaskId}'.sub('{' + 'rentalOwnerRequestTaskId' + '}', CGI.escape(rental_owner_request_task_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_owner_request_task_put_message)

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

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

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