Class: Buildium::TasksApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ TasksApi

Returns a new instance of TasksApi.



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

def api_client
  @api_client
end

Instance Method Details

#create_task_category(task_category_save_message, opts = {}) ⇒ TaskCategoryMessage

Create a task category Create a task category. <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/tasks_api.rb', line 27

def create_task_category(task_category_save_message, opts = {})
  data, _status_code, _headers = create_task_category_with_http_info(task_category_save_message, opts)
  data
end

#create_task_category_with_http_info(task_category_save_message, opts = {}) ⇒ Array<(TaskCategoryMessage, Integer, Hash)>

Create a task category Create a task category. &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:

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

    TaskCategoryMessage 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/tasks_api.rb', line 37

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

  # 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(task_category_save_message)

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

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

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

#delete_task_history_file(task_id, task_history_id, file_id, opts = {}) ⇒ nil

Delete task history file Deletes a specific file from a task history record. The file will be permanently deleted from the Buildium platform an can not be recovered. <br /><br />This endpoint can be used for any task type - contact requests, rental owner requests, resident requests or to do’s. <br /><br /><h4>Required permission(s):</h4><span class="permissionBlock">Tasks &gt; Tasks</span> - ‘View` `Edit` `Delete`

Parameters:

  • task_id (Integer)
  • task_history_id (Integer)
  • file_id (Integer)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (nil) 


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

def delete_task_history_file(task_id, task_history_id, file_id, opts = {})
  delete_task_history_file_with_http_info(task_id, task_history_id, file_id, opts)
  nil
end

#delete_task_history_file_with_http_info(task_id, task_history_id, file_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete task history file Deletes a specific file from a task history record. The file will be permanently deleted from the Buildium platform an can not be recovered. &lt;br /&gt;&lt;br /&gt;This endpoint can be used for any task type - contact requests, rental owner requests, resident requests or to do&#39;s. &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; &#x60;Delete&#x60;

Parameters:

  • task_id (Integer)
  • task_history_id (Integer)
  • file_id (Integer)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

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

    nil, response status code and response headers



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

def delete_task_history_file_with_http_info(task_id, task_history_id, file_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TasksApi.delete_task_history_file ...'
  end
  # verify the required parameter 'task_id' is set
  if @api_client.config.client_side_validation && task_id.nil?
    fail ArgumentError, "Missing the required parameter 'task_id' when calling TasksApi.delete_task_history_file"
  end
  # verify the required parameter 'task_history_id' is set
  if @api_client.config.client_side_validation && task_history_id.nil?
    fail ArgumentError, "Missing the required parameter 'task_history_id' when calling TasksApi.delete_task_history_file"
  end
  # verify the required parameter 'file_id' is set
  if @api_client.config.client_side_validation && file_id.nil?
    fail ArgumentError, "Missing the required parameter 'file_id' when calling TasksApi.delete_task_history_file"
  end
  # resource path
  local_var_path = '/v1/tasks/{taskId}/history/{taskHistoryId}/files/{fileId}'.sub('{' + 'taskId' + '}', CGI.escape(task_id.to_s)).sub('{' + 'taskHistoryId' + '}', CGI.escape(task_history_id.to_s)).sub('{' + 'fileId' + '}', CGI.escape(file_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 => :"TasksApi.delete_task_history_file",
    :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: TasksApi#delete_task_history_file\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_all_task_categories(opts = {}) ⇒ Array<TaskCategoryMessage>

Retrieve all task categories Retrieves a list of task categories. <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):

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



172
173
174
175
 
# File 'lib/buildium-ruby/api/tasks_api.rb', line 172

def get_all_task_categories(opts = {})
  data, _status_code, _headers = get_all_task_categories_with_http_info(opts)
  data
end

#get_all_task_categories_with_http_info(opts = {}) ⇒ Array<(Array<TaskCategoryMessage>, Integer, Hash)>

Retrieve all task categories Retrieves a list of task categories. &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):

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

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



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
226
227
228
229
 
# File 'lib/buildium-ruby/api/tasks_api.rb', line 184

def get_all_task_categories_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TasksApi.get_all_task_categories ...'
  end
  # resource path
  local_var_path = '/v1/tasks/categories'

  # 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<TaskCategoryMessage>'

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

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

#get_all_task_history_files(task_id, task_history_id, opts = {}) ⇒ Array<TaskHistoryFileMessage>

Retrieve all task history files Retrieves the metadata for all files associated with a task history record. <br /><br />This endpoint can be used for any task type - contact requests, rental owner requests, resident requests or to do’s. <br /><br /><h4>Required permission(s):</h4><span class="permissionBlock">Tasks &gt; Tasks</span> - ‘View`

Parameters:

  • task_id (Integer)
  • task_history_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:



240
241
242
243
 
# File 'lib/buildium-ruby/api/tasks_api.rb', line 240

def get_all_task_history_files(task_id, task_history_id, opts = {})
  data, _status_code, _headers = get_all_task_history_files_with_http_info(task_id, task_history_id, opts)
  data
end

#get_all_task_history_files_with_http_info(task_id, task_history_id, opts = {}) ⇒ Array<(Array<TaskHistoryFileMessage>, Integer, Hash)>

Retrieve all task history files Retrieves the metadata for all files associated with a task history record. &lt;br /&gt;&lt;br /&gt;This endpoint can be used for any task type - contact requests, rental owner requests, resident requests or to do&#39;s. &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:

  • task_id (Integer)
  • task_history_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:

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

    Array<TaskHistoryFileMessage> 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
301
302
303
304
305
306
307
 
# File 'lib/buildium-ruby/api/tasks_api.rb', line 254

def get_all_task_history_files_with_http_info(task_id, task_history_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TasksApi.get_all_task_history_files ...'
  end
  # verify the required parameter 'task_id' is set
  if @api_client.config.client_side_validation && task_id.nil?
    fail ArgumentError, "Missing the required parameter 'task_id' when calling TasksApi.get_all_task_history_files"
  end
  # verify the required parameter 'task_history_id' is set
  if @api_client.config.client_side_validation && task_history_id.nil?
    fail ArgumentError, "Missing the required parameter 'task_history_id' when calling TasksApi.get_all_task_history_files"
  end
  # resource path
  local_var_path = '/v1/tasks/{taskId}/history/{taskHistoryId}/files'.sub('{' + 'taskId' + '}', CGI.escape(task_id.to_s)).sub('{' + 'taskHistoryId' + '}', CGI.escape(task_history_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<TaskHistoryFileMessage>'

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

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

#get_all_tasks(opts = {}) ⇒ Array<AllTasksMessage>

Retrieve all tasks Retrieves a list of all task/request types (Contact, Owner, Resident and To Do). Note, the response payload only contains fields common across all of the request types. To retrieve the full details of the task query the retrieve endpoint specific to the task type. <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.

  • :type (String) —

    Filters results to any task associated with the task type specified.

  • :unitid (Integer) —

    Filters results to any task associated with the unit identifier.

  • :unitagreementid (Integer) —

    Filters results to any task associated with the unit agreement identifier specified.

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



330
331
332
333
 
# File 'lib/buildium-ruby/api/tasks_api.rb', line 330

def get_all_tasks(opts = {})
  data, _status_code, _headers = get_all_tasks_with_http_info(opts)
  data
end

#get_all_tasks_with_http_info(opts = {}) ⇒ Array<(Array<AllTasksMessage>, Integer, Hash)>

Retrieve all tasks Retrieves a list of all task/request types (Contact, Owner, Resident and To Do). Note, the response payload only contains fields common across all of the request types. To retrieve the full details of the task query the retrieve endpoint specific to the task type. &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.

  • :type (String) —

    Filters results to any task associated with the task type specified.

  • :unitid (Integer) —

    Filters results to any task associated with the unit identifier.

  • :unitagreementid (Integer) —

    Filters results to any task associated with the unit agreement identifier specified.

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

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



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

def get_all_tasks_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TasksApi.get_all_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 = ["ContactRequest", "ResidentRequest", "Todo", "RentalOwnerRequest"]
  if @api_client.config.client_side_validation && opts[:'type'] && !allowable_values.include?(opts[:'type'])
    fail ArgumentError, "invalid value for \"type\", must be 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'

  # 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[:'type'] = opts[:'type'] if !opts[:'type'].nil?
  query_params[:'unitid'] = opts[:'unitid'] if !opts[:'unitid'].nil?
  query_params[:'unitagreementid'] = opts[:'unitagreementid'] if !opts[:'unitagreementid'].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<AllTasksMessage>'

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

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

#get_file_download_request(task_id, task_history_id, file_id, opts = {}) ⇒ FileDownloadMessage

Download a task history file Downloads a specific file associated to the task history record. <br /><br />This endpoint can be used for any task type - contact requests, rental owner requests, resident requests or to do’s. <br /><br /><h4>Required permission(s):</h4><span class="permissionBlock">Tasks &gt; Tasks</span> - ‘View`

Parameters:

  • task_id (Integer)
  • task_history_id (Integer)
  • file_id (Integer)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



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

def get_file_download_request(task_id, task_history_id, file_id, opts = {})
  data, _status_code, _headers = get_file_download_request_with_http_info(task_id, task_history_id, file_id, opts)
  data
end

#get_file_download_request_with_http_info(task_id, task_history_id, file_id, opts = {}) ⇒ Array<(FileDownloadMessage, Integer, Hash)>

Download a task history file Downloads a specific file associated to the task history record. &lt;br /&gt;&lt;br /&gt;This endpoint can be used for any task type - contact requests, rental owner requests, resident requests or to do&#39;s. &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:

  • task_id (Integer)
  • task_history_id (Integer)
  • file_id (Integer)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

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

    FileDownloadMessage data, response status code and response headers



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

def get_file_download_request_with_http_info(task_id, task_history_id, file_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TasksApi.get_file_download_request ...'
  end
  # verify the required parameter 'task_id' is set
  if @api_client.config.client_side_validation && task_id.nil?
    fail ArgumentError, "Missing the required parameter 'task_id' when calling TasksApi.get_file_download_request"
  end
  # verify the required parameter 'task_history_id' is set
  if @api_client.config.client_side_validation && task_history_id.nil?
    fail ArgumentError, "Missing the required parameter 'task_history_id' when calling TasksApi.get_file_download_request"
  end
  # verify the required parameter 'file_id' is set
  if @api_client.config.client_side_validation && file_id.nil?
    fail ArgumentError, "Missing the required parameter 'file_id' when calling TasksApi.get_file_download_request"
  end
  # resource path
  local_var_path = '/v1/tasks/{taskId}/history/{taskHistoryId}/files/{fileId}/downloadrequest'.sub('{' + 'taskId' + '}', CGI.escape(task_id.to_s)).sub('{' + 'taskHistoryId' + '}', CGI.escape(task_history_id.to_s)).sub('{' + 'fileId' + '}', CGI.escape(file_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] || 'FileDownloadMessage'

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

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

#get_task_by_id(task_id, opts = {}) ⇒ AllTasksMessage

Retrieve a task Retrieves a specific task. This endpoint can be used for any task type - contact requests, rental owner requests, resident requests or to do’s. Note, the response payload only contains fields common across all of the request types. To retrieve the full details of the task query the retrieve endpoint specific to the task type. <br /><br /><h4>Required permission(s):</h4><span class="permissionBlock">Tasks &gt; Tasks</span> - ‘View`

Parameters:

  • task_id (Integer) —

    The task identifier

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

    the optional parameters

Returns:



513
514
515
516
 
# File 'lib/buildium-ruby/api/tasks_api.rb', line 513

def get_task_by_id(task_id, opts = {})
  data, _status_code, _headers = get_task_by_id_with_http_info(task_id, opts)
  data
end

#get_task_by_id_with_http_info(task_id, opts = {}) ⇒ Array<(AllTasksMessage, Integer, Hash)>

Retrieve a task Retrieves a specific task. This endpoint can be used for any task type - contact requests, rental owner requests, resident requests or to do&#39;s. Note, the response payload only contains fields common across all of the request types. To retrieve the full details of the task query the retrieve endpoint specific to the task type. &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:

  • task_id (Integer) —

    The task identifier

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

    the optional parameters

Returns:

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

    AllTasksMessage data, response status code and response headers



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

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

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

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

#get_task_category_by_id(task_category_id, opts = {}) ⇒ TaskCategoryMessage

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

Parameters:

  • task_category_id (Integer) —

    The task category identifier.

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

    the optional parameters

Returns:



576
577
578
579
 
# File 'lib/buildium-ruby/api/tasks_api.rb', line 576

def get_task_category_by_id(task_category_id, opts = {})
  data, _status_code, _headers = get_task_category_by_id_with_http_info(task_category_id, opts)
  data
end

#get_task_category_by_id_with_http_info(task_category_id, opts = {}) ⇒ Array<(TaskCategoryMessage, Integer, Hash)>

Retrieve a task category Retrieves a specific task category. &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:

  • task_category_id (Integer) —

    The task category identifier.

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

    the optional parameters

Returns:

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

    TaskCategoryMessage data, response status code and response headers



586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
 
# File 'lib/buildium-ruby/api/tasks_api.rb', line 586

def get_task_category_by_id_with_http_info(task_category_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TasksApi.get_task_category_by_id ...'
  end
  # verify the required parameter 'task_category_id' is set
  if @api_client.config.client_side_validation && task_category_id.nil?
    fail ArgumentError, "Missing the required parameter 'task_category_id' when calling TasksApi.get_task_category_by_id"
  end
  # resource path
  local_var_path = '/v1/tasks/categories/{taskCategoryId}'.sub('{' + 'taskCategoryId' + '}', CGI.escape(task_category_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] || 'TaskCategoryMessage'

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

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

#get_task_histories(task_id, opts = {}) ⇒ Array<TaskHistoryMessage>

Retrieve all task history Retrieves all task history records for a specific task. <br /><br />This endpoint can be used for any task type - contact requests, rental owner requests, resident requests or to do’s. <br /><br /><h4>Required permission(s):</h4><span class="permissionBlock">Tasks &gt; Tasks</span> - ‘View`

Parameters:

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



642
643
644
645
 
# File 'lib/buildium-ruby/api/tasks_api.rb', line 642

def get_task_histories(task_id, opts = {})
  data, _status_code, _headers = get_task_histories_with_http_info(task_id, opts)
  data
end

#get_task_histories_with_http_info(task_id, opts = {}) ⇒ Array<(Array<TaskHistoryMessage>, Integer, Hash)>

Retrieve all task history Retrieves all task history records for a specific task. &lt;br /&gt;&lt;br /&gt;This endpoint can be used for any task type - contact requests, rental owner requests, resident requests or to do&#39;s. &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:

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

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

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



655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
 
# File 'lib/buildium-ruby/api/tasks_api.rb', line 655

def get_task_histories_with_http_info(task_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TasksApi.get_task_histories ...'
  end
  # verify the required parameter 'task_id' is set
  if @api_client.config.client_side_validation && task_id.nil?
    fail ArgumentError, "Missing the required parameter 'task_id' when calling TasksApi.get_task_histories"
  end
  # resource path
  local_var_path = '/v1/tasks/{taskId}/history'.sub('{' + 'taskId' + '}', CGI.escape(task_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<TaskHistoryMessage>'

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

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

#get_task_history_by_id(task_id, task_history_id, opts = {}) ⇒ TaskHistoryMessage

Retrieve a task history Retrieves a specific task history record for a task. <br /><br />This endpoint can be used for any task type - contact requests, rental owner requests, resident requests or to do’s. <br /><br /><h4>Required permission(s):</h4><span class="permissionBlock">Tasks &gt; Tasks</span> - ‘View`

Parameters:

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

    the optional parameters

Returns:



712
713
714
715
 
# File 'lib/buildium-ruby/api/tasks_api.rb', line 712

def get_task_history_by_id(task_id, task_history_id, opts = {})
  data, _status_code, _headers = get_task_history_by_id_with_http_info(task_id, task_history_id, opts)
  data
end

#get_task_history_by_id_with_http_info(task_id, task_history_id, opts = {}) ⇒ Array<(TaskHistoryMessage, Integer, Hash)>

Retrieve a task history Retrieves a specific task history record for a task. &lt;br /&gt;&lt;br /&gt;This endpoint can be used for any task type - contact requests, rental owner requests, resident requests or to do&#39;s. &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:

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

    the optional parameters

Returns:

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

    TaskHistoryMessage data, response status code and response headers



723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
 
# File 'lib/buildium-ruby/api/tasks_api.rb', line 723

def get_task_history_by_id_with_http_info(task_id, task_history_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TasksApi.get_task_history_by_id ...'
  end
  # verify the required parameter 'task_id' is set
  if @api_client.config.client_side_validation && task_id.nil?
    fail ArgumentError, "Missing the required parameter 'task_id' when calling TasksApi.get_task_history_by_id"
  end
  # verify the required parameter 'task_history_id' is set
  if @api_client.config.client_side_validation && task_history_id.nil?
    fail ArgumentError, "Missing the required parameter 'task_history_id' when calling TasksApi.get_task_history_by_id"
  end
  # resource path
  local_var_path = '/v1/tasks/{taskId}/history/{taskHistoryId}'.sub('{' + 'taskId' + '}', CGI.escape(task_id.to_s)).sub('{' + 'taskHistoryId' + '}', CGI.escape(task_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] || 'TaskHistoryMessage'

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

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

#get_task_history_file_by_id(task_id, task_history_id, file_id, opts = {}) ⇒ TaskHistoryFileMessage

Retrieve a task history file Retrieves the metadata for a specific file associated with a task history record. <br /><br />This endpoint can be used for any task type - contact requests, rental owner requests, resident requests or to do’s. <br /><br /><h4>Required permission(s):</h4><span class="permissionBlock">Tasks &gt; Tasks</span> - ‘View`

Parameters:

  • task_id (Integer)
  • task_history_id (Integer)
  • file_id (Integer)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



782
783
784
785
 
# File 'lib/buildium-ruby/api/tasks_api.rb', line 782

def get_task_history_file_by_id(task_id, task_history_id, file_id, opts = {})
  data, _status_code, _headers = get_task_history_file_by_id_with_http_info(task_id, task_history_id, file_id, opts)
  data
end

#get_task_history_file_by_id_with_http_info(task_id, task_history_id, file_id, opts = {}) ⇒ Array<(TaskHistoryFileMessage, Integer, Hash)>

Retrieve a task history file Retrieves the metadata for a specific file associated with a task history record. &lt;br /&gt;&lt;br /&gt;This endpoint can be used for any task type - contact requests, rental owner requests, resident requests or to do&#39;s. &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:

  • task_id (Integer)
  • task_history_id (Integer)
  • file_id (Integer)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

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

    TaskHistoryFileMessage data, response status code and response headers



794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
 
# File 'lib/buildium-ruby/api/tasks_api.rb', line 794

def get_task_history_file_by_id_with_http_info(task_id, task_history_id, file_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TasksApi.get_task_history_file_by_id ...'
  end
  # verify the required parameter 'task_id' is set
  if @api_client.config.client_side_validation && task_id.nil?
    fail ArgumentError, "Missing the required parameter 'task_id' when calling TasksApi.get_task_history_file_by_id"
  end
  # verify the required parameter 'task_history_id' is set
  if @api_client.config.client_side_validation && task_history_id.nil?
    fail ArgumentError, "Missing the required parameter 'task_history_id' when calling TasksApi.get_task_history_file_by_id"
  end
  # verify the required parameter 'file_id' is set
  if @api_client.config.client_side_validation && file_id.nil?
    fail ArgumentError, "Missing the required parameter 'file_id' when calling TasksApi.get_task_history_file_by_id"
  end
  # resource path
  local_var_path = '/v1/tasks/{taskId}/history/{taskHistoryId}/files/{fileId}'.sub('{' + 'taskId' + '}', CGI.escape(task_id.to_s)).sub('{' + 'taskHistoryId' + '}', CGI.escape(task_history_id.to_s)).sub('{' + 'fileId' + '}', CGI.escape(file_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] || 'TaskHistoryFileMessage'

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

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

#update_task_category(task_category_id, task_category_put_message, opts = {}) ⇒ TaskCategoryMessage

Update a task category Updates a task category. <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:

  • task_category_id (Integer) —

    The task category identifier.

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

    the optional parameters

Returns:



856
857
858
859
 
# File 'lib/buildium-ruby/api/tasks_api.rb', line 856

def update_task_category(task_category_id, task_category_put_message, opts = {})
  data, _status_code, _headers = update_task_category_with_http_info(task_category_id, task_category_put_message, opts)
  data
end

#update_task_category_with_http_info(task_category_id, task_category_put_message, opts = {}) ⇒ Array<(TaskCategoryMessage, Integer, Hash)>

Update a task category Updates a task category. &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:

  • task_category_id (Integer) —

    The task category identifier.

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

    the optional parameters

Returns:

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

    TaskCategoryMessage data, response status code and response headers



867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
 
# File 'lib/buildium-ruby/api/tasks_api.rb', line 867

def update_task_category_with_http_info(task_category_id, task_category_put_message, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TasksApi.update_task_category ...'
  end
  # verify the required parameter 'task_category_id' is set
  if @api_client.config.client_side_validation && task_category_id.nil?
    fail ArgumentError, "Missing the required parameter 'task_category_id' when calling TasksApi.update_task_category"
  end
  # verify the required parameter 'task_category_put_message' is set
  if @api_client.config.client_side_validation && task_category_put_message.nil?
    fail ArgumentError, "Missing the required parameter 'task_category_put_message' when calling TasksApi.update_task_category"
  end
  # resource path
  local_var_path = '/v1/tasks/categories/{taskCategoryId}'.sub('{' + 'taskCategoryId' + '}', CGI.escape(task_category_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(task_category_put_message)

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

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

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

#update_task_history(task_id, task_history_id, task_history_put_message, opts = {}) ⇒ TaskHistoryMessage

Update a task history Updates a specific task history record for a task. <br /><br />This endpoint can be used for any task type - contact requests, rental owner requests, resident requests or to do’s. <br /><br /><h4>Required permission(s):</h4><span class="permissionBlock">Tasks &gt; Tasks</span> - ‘View` `Edit`

Parameters:

  • task_id (Integer)
  • task_history_id (Integer)
  • task_history_put_message (TaskHistoryPutMessage)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



931
932
933
934
 
# File 'lib/buildium-ruby/api/tasks_api.rb', line 931

def update_task_history(task_id, task_history_id, task_history_put_message, opts = {})
  data, _status_code, _headers = update_task_history_with_http_info(task_id, task_history_id, task_history_put_message, opts)
  data
end

#update_task_history_with_http_info(task_id, task_history_id, task_history_put_message, opts = {}) ⇒ Array<(TaskHistoryMessage, Integer, Hash)>

Update a task history Updates a specific task history record for a task. &lt;br /&gt;&lt;br /&gt;This endpoint can be used for any task type - contact requests, rental owner requests, resident requests or to do&#39;s. &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:

  • task_id (Integer)
  • task_history_id (Integer)
  • task_history_put_message (TaskHistoryPutMessage)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

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

    TaskHistoryMessage data, response status code and response headers



943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
 
# File 'lib/buildium-ruby/api/tasks_api.rb', line 943

def update_task_history_with_http_info(task_id, task_history_id, task_history_put_message, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TasksApi.update_task_history ...'
  end
  # verify the required parameter 'task_id' is set
  if @api_client.config.client_side_validation && task_id.nil?
    fail ArgumentError, "Missing the required parameter 'task_id' when calling TasksApi.update_task_history"
  end
  # verify the required parameter 'task_history_id' is set
  if @api_client.config.client_side_validation && task_history_id.nil?
    fail ArgumentError, "Missing the required parameter 'task_history_id' when calling TasksApi.update_task_history"
  end
  # verify the required parameter 'task_history_put_message' is set
  if @api_client.config.client_side_validation && task_history_put_message.nil?
    fail ArgumentError, "Missing the required parameter 'task_history_put_message' when calling TasksApi.update_task_history"
  end
  # resource path
  local_var_path = '/v1/tasks/{taskId}/history/{taskHistoryId}'.sub('{' + 'taskId' + '}', CGI.escape(task_id.to_s)).sub('{' + 'taskHistoryId' + '}', CGI.escape(task_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'])
  # 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(task_history_put_message)

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

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

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

#upload_task_history_file_request_async(task_id, task_history_id, task_history_file_upload_post_message, opts = {}) ⇒ FileUploadTicketMessage

Upload a task history file Uploads a file and associates it to the specified task history record. <br /><br />This endpoint can be used for any task type - contact requests, rental owner requests, resident requests or to do’s. <br /><br />Uploading a file requires making two API requests. Each step is outlined below. <br /><br /><strong>Step 1 - Save file metadata</strong><br /> The first step in the file upload process is to submit the file metadata to ‘/v1/tasks/taskId/history/taskHistoryId/files/uploadrequests`. The response of this call will contain a URL and a collection of form data that will be used in step 2 to generate the request for the file binary upload. <br /><br /><strong>NOTE:</strong> The response data will expire after 5 minutes. The file metadata will not be saved in the Buildium system if step 2 of this process is not completed successfully. <br /><br /><strong>Step 2 - Upload the file binary</strong><br /> Uploading the file binary will require using the response from step 1 to form a POST request to the Buildium file provider. Follow these steps to create the request: <br /> 1. Form a POST request using the value of the `BucketUrl` property as the URL. <br /><br /> 2. Set the `Content-Type` header to `multipart/form-data`. <br /><br /> 3. Copy the fields from the `FormData` property to this request as form-data key/value pairs. <br /><strong>NOTE:</strong> These values must added to the request form-data in the order they were received in the response. <br /><br /> 4. Lastly create a form-data key named `file` and set the value to the file binary. <br /><strong>NOTE:</strong> This must be the last field in the form-data list. <br /><br />This image shows what the POST request should look like if you’re using Postman: <img src="file-upload-example.png" /><br /><br /> 5. Send the POST request! A successful request will return with a ‘204 - NO CONTENT` HTTP response code. For any failure responses, please refer to <a target="_blank" href="docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#RESTErrorResponses">AWS documentation</a> on REST error responses. <br /><br /><strong>NOTE:</strong> The file identifier is not generated in this response. To retrieve the file identifier, call `/v1/files` and pass the `PhysicalFileName` value received from the response of this endpoint into the `physicalfilenames` query parameter. <br /><br /><h4>Required permission(s):</h4><span class="permissionBlock">Tasks &gt; Tasks</span> - `View` `Edit`

Parameters:

  • task_id (Integer)
  • task_history_id (Integer)
  • task_history_file_upload_post_message (TaskHistoryFileUploadPostMessage)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



1011
1012
1013
1014
 
# File 'lib/buildium-ruby/api/tasks_api.rb', line 1011

def upload_task_history_file_request_async(task_id, task_history_id, task_history_file_upload_post_message, opts = {})
  data, _status_code, _headers = upload_task_history_file_request_async_with_http_info(task_id, task_history_id, task_history_file_upload_post_message, opts)
  data
end

#upload_task_history_file_request_async_with_http_info(task_id, task_history_id, task_history_file_upload_post_message, opts = {}) ⇒ Array<(FileUploadTicketMessage, Integer, Hash)>

Upload a task history file Uploads a file and associates it to the specified task history record. &lt;br /&gt;&lt;br /&gt;This endpoint can be used for any task type - contact requests, rental owner requests, resident requests or to do&#39;s. &lt;br /&gt;&lt;br /&gt;Uploading a file requires making two API requests. Each step is outlined below. &lt;br /&gt;&lt;br /&gt;&lt;strong&gt;Step 1 - Save file metadata&lt;/strong&gt;&lt;br /&gt; The first step in the file upload process is to submit the file metadata to &#x60;/v1/tasks/taskId/history/taskHistoryId/files/uploadrequests&#x60;. The response of this call will contain a URL and a collection of form data that will be used in step 2 to generate the request for the file binary upload. &lt;br /&gt;&lt;br /&gt;&lt;strong&gt;NOTE:&lt;/strong&gt; The response data will expire after 5 minutes. The file metadata will not be saved in the Buildium system if step 2 of this process is not completed successfully. &lt;br /&gt;&lt;br /&gt;&lt;strong&gt;Step 2 - Upload the file binary&lt;/strong&gt;&lt;br /&gt; Uploading the file binary will require using the response from step 1 to form a POST request to the Buildium file provider. Follow these steps to create the request: &lt;br /&gt; 1. Form a POST request using the value of the &#x60;BucketUrl&#x60; property as the URL. &lt;br /&gt;&lt;br /&gt; 2. Set the &#x60;Content-Type&#x60; header to &#x60;multipart/form-data&#x60;. &lt;br /&gt;&lt;br /&gt; 3. Copy the fields from the &#x60;FormData&#x60; property to this request as form-data key/value pairs. &lt;br /&gt;&lt;strong&gt;NOTE:&lt;/strong&gt; These values must added to the request form-data in the order they were received in the response. &lt;br /&gt;&lt;br /&gt; 4. Lastly create a form-data key named &#x60;file&#x60; and set the value to the file binary. &lt;br /&gt;&lt;strong&gt;NOTE:&lt;/strong&gt; This must be the last field in the form-data list. &lt;br /&gt;&lt;br /&gt;This image shows what the POST request should look like if you&#39;re using Postman: &lt;img src&#x3D;&quot;file-upload-example.png&quot; /&gt;&lt;br /&gt;&lt;br /&gt; 5. Send the POST request! A successful request will return with a &#x60;204 - NO CONTENT&#x60; HTTP response code. For any failure responses, please refer to &lt;a target&#x3D;&quot;_blank&quot; href&#x3D;&quot;docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#RESTErrorResponses&quot;&gt;AWS documentation&lt;/a&gt; on REST error responses. &lt;br /&gt;&lt;br /&gt;&lt;strong&gt;NOTE:&lt;/strong&gt; The file identifier is not generated in this response. To retrieve the file identifier, call &#x60;/v1/files&#x60; and pass the &#x60;PhysicalFileName&#x60; value received from the response of this endpoint into the &#x60;physicalfilenames&#x60; query parameter. &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:

  • task_id (Integer)
  • task_history_id (Integer)
  • task_history_file_upload_post_message (TaskHistoryFileUploadPostMessage)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

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

    FileUploadTicketMessage data, response status code and response headers



1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
 
# File 'lib/buildium-ruby/api/tasks_api.rb', line 1023

def upload_task_history_file_request_async_with_http_info(task_id, task_history_id, task_history_file_upload_post_message, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TasksApi.upload_task_history_file_request_async ...'
  end
  # verify the required parameter 'task_id' is set
  if @api_client.config.client_side_validation && task_id.nil?
    fail ArgumentError, "Missing the required parameter 'task_id' when calling TasksApi.upload_task_history_file_request_async"
  end
  # verify the required parameter 'task_history_id' is set
  if @api_client.config.client_side_validation && task_history_id.nil?
    fail ArgumentError, "Missing the required parameter 'task_history_id' when calling TasksApi.upload_task_history_file_request_async"
  end
  # verify the required parameter 'task_history_file_upload_post_message' is set
  if @api_client.config.client_side_validation && task_history_file_upload_post_message.nil?
    fail ArgumentError, "Missing the required parameter 'task_history_file_upload_post_message' when calling TasksApi.upload_task_history_file_request_async"
  end
  # resource path
  local_var_path = '/v1/tasks/{taskId}/history/{taskHistoryId}/files/uploadrequests'.sub('{' + 'taskId' + '}', CGI.escape(task_id.to_s)).sub('{' + 'taskHistoryId' + '}', CGI.escape(task_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'])
  # 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(task_history_file_upload_post_message)

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

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

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