Class: UltracartClient::WorkflowApi

Inherits:
Object
  • Object
show all
Defined in:
lib/ultracart_api/api/workflow_api.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ WorkflowApi

Returns a new instance of WorkflowApi.



19
20
21
 
# File 'lib/ultracart_api/api/workflow_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/ultracart_api/api/workflow_api.rb', line 17

def api_client
  @api_client
end

Class Method Details

.new_using_api_key(simple_key, verify_ssl = true, debugging = false) ⇒ Object 



23
24
25
26
27
28
29
30
31
32
33
 
# File 'lib/ultracart_api/api/workflow_api.rb', line 23

def self.new_using_api_key(simple_key, verify_ssl = true, debugging = false)
  api_config = Configuration.new
  api_config.api_key_prefix['x-ultracart-simple-key'] = simple_key
  api_config.api_version = '2017-03-01'
  api_config.verify_ssl = verify_ssl

  api_client = ApiClient.new(api_config)
  api_client.config.debugging = debugging

  UltracartClient::WorkflowApi.new(api_client)
end

Instance Method Details

#get_workflow_assignment_groups(opts = {}) ⇒ WorkflowGroupsResponse

Retrieve a list of groups that workflow tasks can be assigned to Retrieve a list of groups that workflow tasks can be assigned to

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :_limit (Integer) —

    The maximum number of records to return on this one API call. (Max 200) (default to 100)

  • :_offset (Integer) —

    Pagination of the record set. Offset is a zero based index. (default to 0)

Returns:



41
42
43
44
 
# File 'lib/ultracart_api/api/workflow_api.rb', line 41

def get_workflow_assignment_groups(opts = {})
  data, _status_code, _headers = get_workflow_assignment_groups_with_http_info(opts)
  data
end

#get_workflow_assignment_groups_with_http_info(opts = {}) ⇒ Array<(WorkflowGroupsResponse, Fixnum, Hash)>

Retrieve a list of groups that workflow tasks can be assigned to Retrieve a list of groups that workflow tasks can be assigned to

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :_limit (Integer) —

    The maximum number of records to return on this one API call. (Max 200)

  • :_offset (Integer) —

    Pagination of the record set. Offset is a zero based index.

Returns:

  • (Array<(WorkflowGroupsResponse, Fixnum, Hash)>) —

    WorkflowGroupsResponse data, response status code and response headers



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
89
 
# File 'lib/ultracart_api/api/workflow_api.rb', line 52

def get_workflow_assignment_groups_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WorkflowApi.get_workflow_assignment_groups ...'
  end
  # resource path
  local_var_path = '/workflow/assignment_groups'

  # query parameters
  query_params = {}
  query_params[:'_limit'] = opts[:'_limit'] if !opts[:'_limit'].nil?
  query_params[:'_offset'] = opts[:'_offset'] if !opts[:'_offset'].nil?

  # header parameters
  header_params = {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'WorkflowGroupsResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkflowApi#get_workflow_assignment_groups\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_workflow_assignment_users(opts = {}) ⇒ WorkflowUsersResponse

Retrieve a list of users that workflow tasks can be assigned to Retrieve a list of users that workflow tasks can be assigned to

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :_limit (Integer) —

    The maximum number of records to return on this one API call. (Max 200) (default to 100)

  • :_offset (Integer) —

    Pagination of the record set. Offset is a zero based index. (default to 0)

Returns:



96
97
98
99
 
# File 'lib/ultracart_api/api/workflow_api.rb', line 96

def get_workflow_assignment_users(opts = {})
  data, _status_code, _headers = get_workflow_assignment_users_with_http_info(opts)
  data
end

#get_workflow_assignment_users_with_http_info(opts = {}) ⇒ Array<(WorkflowUsersResponse, Fixnum, Hash)>

Retrieve a list of users that workflow tasks can be assigned to Retrieve a list of users that workflow tasks can be assigned to

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :_limit (Integer) —

    The maximum number of records to return on this one API call. (Max 200)

  • :_offset (Integer) —

    Pagination of the record set. Offset is a zero based index.

Returns:

  • (Array<(WorkflowUsersResponse, Fixnum, Hash)>) —

    WorkflowUsersResponse data, response status code and response headers



107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
 
# File 'lib/ultracart_api/api/workflow_api.rb', line 107

def get_workflow_assignment_users_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WorkflowApi.get_workflow_assignment_users ...'
  end
  # resource path
  local_var_path = '/workflow/assignment_users'

  # query parameters
  query_params = {}
  query_params[:'_limit'] = opts[:'_limit'] if !opts[:'_limit'].nil?
  query_params[:'_offset'] = opts[:'_offset'] if !opts[:'_offset'].nil?

  # header parameters
  header_params = {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'WorkflowUsersResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkflowApi#get_workflow_assignment_users\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_workflow_me(opts = {}) ⇒ WorkflowUserResponse

Retrieve a user object for myself Retrieve a user object for myself

Parameters:

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

    the optional parameters

Returns:



149
150
151
152
 
# File 'lib/ultracart_api/api/workflow_api.rb', line 149

def get_workflow_me(opts = {})
  data, _status_code, _headers = get_workflow_me_with_http_info(opts)
  data
end

#get_workflow_me_with_http_info(opts = {}) ⇒ Array<(WorkflowUserResponse, Fixnum, Hash)>

Retrieve a user object for myself Retrieve a user object for myself

Parameters:

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

    the optional parameters

Returns:

  • (Array<(WorkflowUserResponse, Fixnum, Hash)>) —

    WorkflowUserResponse data, response status code and response headers



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
 
# File 'lib/ultracart_api/api/workflow_api.rb', line 158

def get_workflow_me_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WorkflowApi.get_workflow_me ...'
  end
  # resource path
  local_var_path = '/workflow/me'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'WorkflowUserResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkflowApi#get_workflow_me\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_workflow_task(task_uuid, opts = {}) ⇒ WorkflowTaskResponse

Retrieve a workflow task Retrieve a workflow task

Parameters:

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

    the optional parameters

Returns:



199
200
201
202
 
# File 'lib/ultracart_api/api/workflow_api.rb', line 199

def get_workflow_task(task_uuid, opts = {})
  data, _status_code, _headers = get_workflow_task_with_http_info(task_uuid, opts)
  data
end

#get_workflow_task_attachment_upload_url(extension, opts = {}) ⇒ WorkflowAttachmentUploadUrlResponse

Get a presigned workflow task attachment upload URL Get a presigned workflow task attachment upload URL

Parameters:

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

    the optional parameters

Returns:



254
255
256
257
 
# File 'lib/ultracart_api/api/workflow_api.rb', line 254

def get_workflow_task_attachment_upload_url(extension, opts = {})
  data, _status_code, _headers = get_workflow_task_attachment_upload_url_with_http_info(extension, opts)
  data
end

#get_workflow_task_attachment_upload_url_with_http_info(extension, opts = {}) ⇒ Array<(WorkflowAttachmentUploadUrlResponse, Fixnum, Hash)>

Get a presigned workflow task attachment upload URL Get a presigned workflow task attachment upload URL

Parameters:

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

    the optional parameters

Returns:



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
 
# File 'lib/ultracart_api/api/workflow_api.rb', line 264

def get_workflow_task_attachment_upload_url_with_http_info(extension, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WorkflowApi.get_workflow_task_attachment_upload_url ...'
  end
  # verify the required parameter 'extension' is set
  if @api_client.config.client_side_validation && extension.nil?
    fail ArgumentError, "Missing the required parameter 'extension' when calling WorkflowApi.get_workflow_task_attachment_upload_url"
  end
  # resource path
  local_var_path = '/workflow/tasks/attachments/{extension}'.sub('{' + 'extension' + '}', extension.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'WorkflowAttachmentUploadUrlResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkflowApi#get_workflow_task_attachment_upload_url\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_workflow_task_by_object_type(object_type, object_id, opts = {}) ⇒ WorkflowTasksResponse

Retrieve a workflow task by object type and id Retrieve a workflow task by object type and id

Parameters:

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

    the optional parameters

Returns:



310
311
312
313
 
# File 'lib/ultracart_api/api/workflow_api.rb', line 310

def get_workflow_task_by_object_type(object_type, object_id, opts = {})
  data, _status_code, _headers = get_workflow_task_by_object_type_with_http_info(object_type, object_id, opts)
  data
end

#get_workflow_task_by_object_type_with_http_info(object_type, object_id, opts = {}) ⇒ Array<(WorkflowTasksResponse, Fixnum, Hash)>

Retrieve a workflow task by object type and id Retrieve a workflow task by object type and id

Parameters:

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

    the optional parameters

Returns:

  • (Array<(WorkflowTasksResponse, Fixnum, Hash)>) —

    WorkflowTasksResponse data, response status code and response headers



321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
 
# File 'lib/ultracart_api/api/workflow_api.rb', line 321

def get_workflow_task_by_object_type_with_http_info(object_type, object_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WorkflowApi.get_workflow_task_by_object_type ...'
  end
  # verify the required parameter 'object_type' is set
  if @api_client.config.client_side_validation && object_type.nil?
    fail ArgumentError, "Missing the required parameter 'object_type' when calling WorkflowApi.get_workflow_task_by_object_type"
  end
  # verify the required parameter 'object_id' is set
  if @api_client.config.client_side_validation && object_id.nil?
    fail ArgumentError, "Missing the required parameter 'object_id' when calling WorkflowApi.get_workflow_task_by_object_type"
  end
  # resource path
  local_var_path = '/workflow/tasks/by/{object_type}/{object_id}'.sub('{' + 'object_type' + '}', object_type.to_s).sub('{' + 'object_id' + '}', object_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'WorkflowTasksResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkflowApi#get_workflow_task_by_object_type\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_workflow_task_with_http_info(task_uuid, opts = {}) ⇒ Array<(WorkflowTaskResponse, Fixnum, Hash)>

Retrieve a workflow task Retrieve a workflow task

Parameters:

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

    the optional parameters

Returns:

  • (Array<(WorkflowTaskResponse, Fixnum, Hash)>) —

    WorkflowTaskResponse data, response status code and response headers



209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
 
# File 'lib/ultracart_api/api/workflow_api.rb', line 209

def get_workflow_task_with_http_info(task_uuid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WorkflowApi.get_workflow_task ...'
  end
  # verify the required parameter 'task_uuid' is set
  if @api_client.config.client_side_validation && task_uuid.nil?
    fail ArgumentError, "Missing the required parameter 'task_uuid' when calling WorkflowApi.get_workflow_task"
  end
  # resource path
  local_var_path = '/workflow/tasks/{task_uuid}'.sub('{' + 'task_uuid' + '}', task_uuid.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'WorkflowTaskResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkflowApi#get_workflow_task\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_workflow_tasks(workflow_tasks_query, opts = {}) ⇒ WorkflowTasksResponse

Search workflow tasks Retrieves a set of workflow tasks from the account based on a query object.

Parameters:

  • workflow_tasks_query —

    Workflow tasks query

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

    the optional parameters

Options Hash (opts):

  • :_limit (Integer) —

    The maximum number of records to return on this one API call. (Default 100, Max 500) (default to 100)

  • :_offset (Integer) —

    Pagination of the record set. Offset is a zero based index. (default to 0)

  • :_sort (String) —

    The sort order of the items. See Sorting documentation for examples of using multiple values and sorting by ascending and descending.

Returns:



373
374
375
376
 
# File 'lib/ultracart_api/api/workflow_api.rb', line 373

def get_workflow_tasks(workflow_tasks_query, opts = {})
  data, _status_code, _headers = get_workflow_tasks_with_http_info(workflow_tasks_query, opts)
  data
end

#get_workflow_tasks_with_http_info(workflow_tasks_query, opts = {}) ⇒ Array<(WorkflowTasksResponse, Fixnum, Hash)>

Search workflow tasks Retrieves a set of workflow tasks from the account based on a query object.

Parameters:

  • workflow_tasks_query —

    Workflow tasks query

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

    the optional parameters

Options Hash (opts):

  • :_limit (Integer) —

    The maximum number of records to return on this one API call. (Default 100, Max 500)

  • :_offset (Integer) —

    Pagination of the record set. Offset is a zero based index.

  • :_sort (String) —

    The sort order of the items. See Sorting documentation for examples of using multiple values and sorting by ascending and descending.

Returns:

  • (Array<(WorkflowTasksResponse, Fixnum, Hash)>) —

    WorkflowTasksResponse data, response status code and response headers



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
 
# File 'lib/ultracart_api/api/workflow_api.rb', line 386

def get_workflow_tasks_with_http_info(workflow_tasks_query, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WorkflowApi.get_workflow_tasks ...'
  end
  # verify the required parameter 'workflow_tasks_query' is set
  if @api_client.config.client_side_validation && workflow_tasks_query.nil?
    fail ArgumentError, "Missing the required parameter 'workflow_tasks_query' when calling WorkflowApi.get_workflow_tasks"
  end
  # resource path
  local_var_path = '/workflow/tasks/search'

  # query parameters
  query_params = {}
  query_params[:'_limit'] = opts[:'_limit'] if !opts[:'_limit'].nil?
  query_params[:'_offset'] = opts[:'_offset'] if !opts[:'_offset'].nil?
  query_params[:'_sort'] = opts[:'_sort'] if !opts[:'_sort'].nil?

  # header parameters
  header_params = {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(workflow_tasks_query)
  auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'WorkflowTasksResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkflowApi#get_workflow_tasks\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#insert_workflow_task(workflow_task, opts = {}) ⇒ WorkflowTaskResponse

Insert a workflow task Insert a workflow task

Parameters:

  • workflow_task —

    workflow task

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

    the optional parameters

Returns:



434
435
436
437
 
# File 'lib/ultracart_api/api/workflow_api.rb', line 434

def insert_workflow_task(workflow_task, opts = {})
  data, _status_code, _headers = insert_workflow_task_with_http_info(workflow_task, opts)
  data
end

#insert_workflow_task_with_http_info(workflow_task, opts = {}) ⇒ Array<(WorkflowTaskResponse, Fixnum, Hash)>

Insert a workflow task Insert a workflow task

Parameters:

  • workflow_task —

    workflow task

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

    the optional parameters

Returns:

  • (Array<(WorkflowTaskResponse, Fixnum, Hash)>) —

    WorkflowTaskResponse data, response status code and response headers



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
477
478
479
480
481
482
483
 
# File 'lib/ultracart_api/api/workflow_api.rb', line 444

def insert_workflow_task_with_http_info(workflow_task, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WorkflowApi.insert_workflow_task ...'
  end
  # verify the required parameter 'workflow_task' is set
  if @api_client.config.client_side_validation && workflow_task.nil?
    fail ArgumentError, "Missing the required parameter 'workflow_task' when calling WorkflowApi.insert_workflow_task"
  end
  # resource path
  local_var_path = '/workflow/tasks'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(workflow_task)
  auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'WorkflowTaskResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkflowApi#insert_workflow_task\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_workflow_task(task_uuid, workflow_task, opts = {}) ⇒ WorkflowTaskResponse

Update a workflow task Update a workflow task

Parameters:

  • task_uuid
  • workflow_task —

    Workflow task

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

    the optional parameters

Returns:



490
491
492
493
 
# File 'lib/ultracart_api/api/workflow_api.rb', line 490

def update_workflow_task(task_uuid, workflow_task, opts = {})
  data, _status_code, _headers = update_workflow_task_with_http_info(task_uuid, workflow_task, opts)
  data
end

#update_workflow_task_with_http_info(task_uuid, workflow_task, opts = {}) ⇒ Array<(WorkflowTaskResponse, Fixnum, Hash)>

Update a workflow task Update a workflow task

Parameters:

  • task_uuid
  • workflow_task —

    Workflow task

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

    the optional parameters

Returns:

  • (Array<(WorkflowTaskResponse, Fixnum, Hash)>) —

    WorkflowTaskResponse data, response status code and response headers



501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
 
# File 'lib/ultracart_api/api/workflow_api.rb', line 501

def update_workflow_task_with_http_info(task_uuid, workflow_task, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WorkflowApi.update_workflow_task ...'
  end
  # verify the required parameter 'task_uuid' is set
  if @api_client.config.client_side_validation && task_uuid.nil?
    fail ArgumentError, "Missing the required parameter 'task_uuid' when calling WorkflowApi.update_workflow_task"
  end
  # verify the required parameter 'workflow_task' is set
  if @api_client.config.client_side_validation && workflow_task.nil?
    fail ArgumentError, "Missing the required parameter 'workflow_task' when calling WorkflowApi.update_workflow_task"
  end
  # resource path
  local_var_path = '/workflow/tasks/{task_uuid}'.sub('{' + 'task_uuid' + '}', task_uuid.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(workflow_task)
  auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'WorkflowTaskResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkflowApi#update_workflow_task\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end