ultracart_api 4.1.12 → 4.1.14

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
data/docs/WorkflowApi.md CHANGED
@@ -1,879 +1,666 @@
1
- # UltracartClient::WorkflowApi
2
-
3
- All URIs are relative to *https://secure.ultracart.com/rest/v2*
4
-
5
- | Method | HTTP request | Description |
6
- | ------ | ------------ | ----------- |
7
- | [**get_workflow_agent_websocket_authorization**](WorkflowApi.md#get_workflow_agent_websocket_authorization) | **PUT** /workflow/agent/auth | Get agent websocket authorization |
8
- | [**get_workflow_assignment_groups**](WorkflowApi.md#get_workflow_assignment_groups) | **GET** /workflow/assignment_groups | Retrieve a list of groups that workflow tasks can be assigned to |
9
- | [**get_workflow_assignment_users**](WorkflowApi.md#get_workflow_assignment_users) | **GET** /workflow/assignment_users | Retrieve a list of users that workflow tasks can be assigned to |
10
- | [**get_workflow_me**](WorkflowApi.md#get_workflow_me) | **GET** /workflow/me | Retrieve a user object for myself |
11
- | [**get_workflow_task**](WorkflowApi.md#get_workflow_task) | **GET** /workflow/tasks/{task_uuid} | Retrieve a workflow task |
12
- | [**get_workflow_task_attachment_upload_url**](WorkflowApi.md#get_workflow_task_attachment_upload_url) | **GET** /workflow/tasks/attachments/{extension} | Get a presigned workflow task attachment upload URL |
13
- | [**get_workflow_task_by_object_type**](WorkflowApi.md#get_workflow_task_by_object_type) | **GET** /workflow/tasks/by/{object_type}/{object_id} | Retrieve a workflow task by object type and id |
14
- | [**get_workflow_task_open_count**](WorkflowApi.md#get_workflow_task_open_count) | **GET** /workflow/tasks/open_count | Retrieve workflow task open count |
15
- | [**get_workflow_task_tags**](WorkflowApi.md#get_workflow_task_tags) | **GET** /workflow/tasks/tags | Get a list of existing workflow task tags |
16
- | [**get_workflow_tasks**](WorkflowApi.md#get_workflow_tasks) | **POST** /workflow/tasks/search | Search workflow tasks |
17
- | [**insert_workflow_task**](WorkflowApi.md#insert_workflow_task) | **POST** /workflow/tasks | Insert a workflow task |
18
- | [**update_workflow_task**](WorkflowApi.md#update_workflow_task) | **PUT** /workflow/tasks/{task_uuid} | Update a workflow task |
19
-
20
-
21
- ## get_workflow_agent_websocket_authorization
22
-
23
- > <WorkflowAgentAuthResponse> get_workflow_agent_websocket_authorization
24
-
25
- Get agent websocket authorization
26
-
27
- Retrieve a JWT to authorize an agent to make a websocket connection.
28
-
29
- ### Examples
30
-
31
- ```ruby
32
- require 'time'
33
- require 'ultracart_api'
34
- require 'json'
35
- require 'yaml'
36
- require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
37
-
38
- # This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
39
- # As such, this might not be the best way to use this object.
40
- # Please see https://github.com/UltraCart/sdk_samples for working examples.
41
-
42
- api = UltracartClient::WorkflowApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
43
-
44
- begin
45
- # Get agent websocket authorization
46
- result = api_instance.get_workflow_agent_websocket_authorization
47
- p result
48
- rescue UltracartClient::ApiError => e
49
- puts "Error when calling WorkflowApi->get_workflow_agent_websocket_authorization: #{e}"
50
- end
51
- ```
52
-
53
- #### Using the get_workflow_agent_websocket_authorization_with_http_info variant
54
-
55
- This returns an Array which contains the response data, status code and headers.
56
-
57
- > <Array(<WorkflowAgentAuthResponse>, Integer, Hash)> get_workflow_agent_websocket_authorization_with_http_info
58
-
59
- ```ruby
60
- begin
61
- # Get agent websocket authorization
62
- data, status_code, headers = api_instance.get_workflow_agent_websocket_authorization_with_http_info
63
- p status_code # => 2xx
64
- p headers # => { ... }
65
- p data # => <WorkflowAgentAuthResponse>
66
- rescue UltracartClient::ApiError => e
67
- puts "Error when calling WorkflowApi->get_workflow_agent_websocket_authorization_with_http_info: #{e}"
68
- end
69
- ```
70
-
71
- ### Parameters
72
-
73
- This endpoint does not need any parameter.
74
-
75
- ### Return type
76
-
77
- [**WorkflowAgentAuthResponse**](WorkflowAgentAuthResponse.md)
78
-
79
- ### Authorization
80
-
81
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
82
-
83
- ### HTTP request headers
84
-
85
- - **Content-Type**: Not defined
86
- - **Accept**: application/json
87
-
88
-
89
- ## get_workflow_assignment_groups
90
-
91
- > <WorkflowGroupsResponse> get_workflow_assignment_groups(opts)
92
-
93
- Retrieve a list of groups that workflow tasks can be assigned to
94
-
95
- Retrieve a list of groups that workflow tasks can be assigned to
96
-
97
- ### Examples
98
-
99
- ```ruby
100
- require 'time'
101
- require 'ultracart_api'
102
- require 'json'
103
- require 'yaml'
104
- require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
105
-
106
- # This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
107
- # As such, this might not be the best way to use this object.
108
- # Please see https://github.com/UltraCart/sdk_samples for working examples.
109
-
110
- api = UltracartClient::WorkflowApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
111
- opts = {
112
- _limit: 56, # Integer | The maximum number of records to return on this one API call. (Max 200)
113
- _offset: 56 # Integer | Pagination of the record set. Offset is a zero based index.
114
- }
115
-
116
- begin
117
- # Retrieve a list of groups that workflow tasks can be assigned to
118
- result = api_instance.get_workflow_assignment_groups(opts)
119
- p result
120
- rescue UltracartClient::ApiError => e
121
- puts "Error when calling WorkflowApi->get_workflow_assignment_groups: #{e}"
122
- end
123
- ```
124
-
125
- #### Using the get_workflow_assignment_groups_with_http_info variant
126
-
127
- This returns an Array which contains the response data, status code and headers.
128
-
129
- > <Array(<WorkflowGroupsResponse>, Integer, Hash)> get_workflow_assignment_groups_with_http_info(opts)
130
-
131
- ```ruby
132
- begin
133
- # Retrieve a list of groups that workflow tasks can be assigned to
134
- data, status_code, headers = api_instance.get_workflow_assignment_groups_with_http_info(opts)
135
- p status_code # => 2xx
136
- p headers # => { ... }
137
- p data # => <WorkflowGroupsResponse>
138
- rescue UltracartClient::ApiError => e
139
- puts "Error when calling WorkflowApi->get_workflow_assignment_groups_with_http_info: #{e}"
140
- end
141
- ```
142
-
143
- ### Parameters
144
-
145
- | Name | Type | Description | Notes |
146
- | ---- | ---- | ----------- | ----- |
147
- | **_limit** | **Integer** | The maximum number of records to return on this one API call. (Max 200) | [optional][default to 100] |
148
- | **_offset** | **Integer** | Pagination of the record set. Offset is a zero based index. | [optional][default to 0] |
149
-
150
- ### Return type
151
-
152
- [**WorkflowGroupsResponse**](WorkflowGroupsResponse.md)
153
-
154
- ### Authorization
155
-
156
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
157
-
158
- ### HTTP request headers
159
-
160
- - **Content-Type**: Not defined
161
- - **Accept**: application/json
162
-
163
-
164
- ## get_workflow_assignment_users
165
-
166
- > <WorkflowUsersResponse> get_workflow_assignment_users(opts)
167
-
168
- Retrieve a list of users that workflow tasks can be assigned to
169
-
170
- Retrieve a list of users that workflow tasks can be assigned to
171
-
172
- ### Examples
173
-
174
- ```ruby
175
- require 'time'
176
- require 'ultracart_api'
177
- require 'json'
178
- require 'yaml'
179
- require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
180
-
181
- # This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
182
- # As such, this might not be the best way to use this object.
183
- # Please see https://github.com/UltraCart/sdk_samples for working examples.
184
-
185
- api = UltracartClient::WorkflowApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
186
- opts = {
187
- _limit: 56, # Integer | The maximum number of records to return on this one API call. (Max 200)
188
- _offset: 56 # Integer | Pagination of the record set. Offset is a zero based index.
189
- }
190
-
191
- begin
192
- # Retrieve a list of users that workflow tasks can be assigned to
193
- result = api_instance.get_workflow_assignment_users(opts)
194
- p result
195
- rescue UltracartClient::ApiError => e
196
- puts "Error when calling WorkflowApi->get_workflow_assignment_users: #{e}"
197
- end
198
- ```
199
-
200
- #### Using the get_workflow_assignment_users_with_http_info variant
201
-
202
- This returns an Array which contains the response data, status code and headers.
203
-
204
- > <Array(<WorkflowUsersResponse>, Integer, Hash)> get_workflow_assignment_users_with_http_info(opts)
205
-
206
- ```ruby
207
- begin
208
- # Retrieve a list of users that workflow tasks can be assigned to
209
- data, status_code, headers = api_instance.get_workflow_assignment_users_with_http_info(opts)
210
- p status_code # => 2xx
211
- p headers # => { ... }
212
- p data # => <WorkflowUsersResponse>
213
- rescue UltracartClient::ApiError => e
214
- puts "Error when calling WorkflowApi->get_workflow_assignment_users_with_http_info: #{e}"
215
- end
216
- ```
217
-
218
- ### Parameters
219
-
220
- | Name | Type | Description | Notes |
221
- | ---- | ---- | ----------- | ----- |
222
- | **_limit** | **Integer** | The maximum number of records to return on this one API call. (Max 200) | [optional][default to 100] |
223
- | **_offset** | **Integer** | Pagination of the record set. Offset is a zero based index. | [optional][default to 0] |
224
-
225
- ### Return type
226
-
227
- [**WorkflowUsersResponse**](WorkflowUsersResponse.md)
228
-
229
- ### Authorization
230
-
231
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
232
-
233
- ### HTTP request headers
234
-
235
- - **Content-Type**: Not defined
236
- - **Accept**: application/json
237
-
238
-
239
- ## get_workflow_me
240
-
241
- > <WorkflowUserResponse> get_workflow_me
242
-
243
- Retrieve a user object for myself
244
-
245
- Retrieve a user object for myself
246
-
247
- ### Examples
248
-
249
- ```ruby
250
- require 'time'
251
- require 'ultracart_api'
252
- require 'json'
253
- require 'yaml'
254
- require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
255
-
256
- # This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
257
- # As such, this might not be the best way to use this object.
258
- # Please see https://github.com/UltraCart/sdk_samples for working examples.
259
-
260
- api = UltracartClient::WorkflowApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
261
-
262
- begin
263
- # Retrieve a user object for myself
264
- result = api_instance.get_workflow_me
265
- p result
266
- rescue UltracartClient::ApiError => e
267
- puts "Error when calling WorkflowApi->get_workflow_me: #{e}"
268
- end
269
- ```
270
-
271
- #### Using the get_workflow_me_with_http_info variant
272
-
273
- This returns an Array which contains the response data, status code and headers.
274
-
275
- > <Array(<WorkflowUserResponse>, Integer, Hash)> get_workflow_me_with_http_info
276
-
277
- ```ruby
278
- begin
279
- # Retrieve a user object for myself
280
- data, status_code, headers = api_instance.get_workflow_me_with_http_info
281
- p status_code # => 2xx
282
- p headers # => { ... }
283
- p data # => <WorkflowUserResponse>
284
- rescue UltracartClient::ApiError => e
285
- puts "Error when calling WorkflowApi->get_workflow_me_with_http_info: #{e}"
286
- end
287
- ```
288
-
289
- ### Parameters
290
-
291
- This endpoint does not need any parameter.
292
-
293
- ### Return type
294
-
295
- [**WorkflowUserResponse**](WorkflowUserResponse.md)
296
-
297
- ### Authorization
298
-
299
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
300
-
301
- ### HTTP request headers
302
-
303
- - **Content-Type**: Not defined
304
- - **Accept**: application/json
305
-
306
-
307
- ## get_workflow_task
308
-
309
- > <WorkflowTaskResponse> get_workflow_task(task_uuid)
310
-
311
- Retrieve a workflow task
312
-
313
- Retrieve a workflow task
314
-
315
- ### Examples
316
-
317
- ```ruby
318
- require 'time'
319
- require 'ultracart_api'
320
- require 'json'
321
- require 'yaml'
322
- require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
323
-
324
- # This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
325
- # As such, this might not be the best way to use this object.
326
- # Please see https://github.com/UltraCart/sdk_samples for working examples.
327
-
328
- api = UltracartClient::WorkflowApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
329
- task_uuid = 'task_uuid_example' # String |
330
-
331
- begin
332
- # Retrieve a workflow task
333
- result = api_instance.get_workflow_task(task_uuid)
334
- p result
335
- rescue UltracartClient::ApiError => e
336
- puts "Error when calling WorkflowApi->get_workflow_task: #{e}"
337
- end
338
- ```
339
-
340
- #### Using the get_workflow_task_with_http_info variant
341
-
342
- This returns an Array which contains the response data, status code and headers.
343
-
344
- > <Array(<WorkflowTaskResponse>, Integer, Hash)> get_workflow_task_with_http_info(task_uuid)
345
-
346
- ```ruby
347
- begin
348
- # Retrieve a workflow task
349
- data, status_code, headers = api_instance.get_workflow_task_with_http_info(task_uuid)
350
- p status_code # => 2xx
351
- p headers # => { ... }
352
- p data # => <WorkflowTaskResponse>
353
- rescue UltracartClient::ApiError => e
354
- puts "Error when calling WorkflowApi->get_workflow_task_with_http_info: #{e}"
355
- end
356
- ```
357
-
358
- ### Parameters
359
-
360
- | Name | Type | Description | Notes |
361
- | ---- | ---- | ----------- | ----- |
362
- | **task_uuid** | **String** | | |
363
-
364
- ### Return type
365
-
366
- [**WorkflowTaskResponse**](WorkflowTaskResponse.md)
367
-
368
- ### Authorization
369
-
370
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
371
-
372
- ### HTTP request headers
373
-
374
- - **Content-Type**: Not defined
375
- - **Accept**: application/json
376
-
377
-
378
- ## get_workflow_task_attachment_upload_url
379
-
380
- > <WorkflowAttachmentUploadUrlResponse> get_workflow_task_attachment_upload_url(extension)
381
-
382
- Get a presigned workflow task attachment upload URL
383
-
384
- Get a presigned workflow task attachment upload URL
385
-
386
- ### Examples
387
-
388
- ```ruby
389
- require 'time'
390
- require 'ultracart_api'
391
- require 'json'
392
- require 'yaml'
393
- require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
394
-
395
- # This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
396
- # As such, this might not be the best way to use this object.
397
- # Please see https://github.com/UltraCart/sdk_samples for working examples.
398
-
399
- api = UltracartClient::WorkflowApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
400
- extension = 'extension_example' # String |
401
-
402
- begin
403
- # Get a presigned workflow task attachment upload URL
404
- result = api_instance.get_workflow_task_attachment_upload_url(extension)
405
- p result
406
- rescue UltracartClient::ApiError => e
407
- puts "Error when calling WorkflowApi->get_workflow_task_attachment_upload_url: #{e}"
408
- end
409
- ```
410
-
411
- #### Using the get_workflow_task_attachment_upload_url_with_http_info variant
412
-
413
- This returns an Array which contains the response data, status code and headers.
414
-
415
- > <Array(<WorkflowAttachmentUploadUrlResponse>, Integer, Hash)> get_workflow_task_attachment_upload_url_with_http_info(extension)
416
-
417
- ```ruby
418
- begin
419
- # Get a presigned workflow task attachment upload URL
420
- data, status_code, headers = api_instance.get_workflow_task_attachment_upload_url_with_http_info(extension)
421
- p status_code # => 2xx
422
- p headers # => { ... }
423
- p data # => <WorkflowAttachmentUploadUrlResponse>
424
- rescue UltracartClient::ApiError => e
425
- puts "Error when calling WorkflowApi->get_workflow_task_attachment_upload_url_with_http_info: #{e}"
426
- end
427
- ```
428
-
429
- ### Parameters
430
-
431
- | Name | Type | Description | Notes |
432
- | ---- | ---- | ----------- | ----- |
433
- | **extension** | **String** | | |
434
-
435
- ### Return type
436
-
437
- [**WorkflowAttachmentUploadUrlResponse**](WorkflowAttachmentUploadUrlResponse.md)
438
-
439
- ### Authorization
440
-
441
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
442
-
443
- ### HTTP request headers
444
-
445
- - **Content-Type**: Not defined
446
- - **Accept**: application/json
447
-
448
-
449
- ## get_workflow_task_by_object_type
450
-
451
- > <WorkflowTasksResponse> get_workflow_task_by_object_type(object_type, object_id)
452
-
453
- Retrieve a workflow task by object type and id
454
-
455
- Retrieve a workflow task by object type and id
456
-
457
- ### Examples
458
-
459
- ```ruby
460
- require 'time'
461
- require 'ultracart_api'
462
- require 'json'
463
- require 'yaml'
464
- require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
465
-
466
- # This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
467
- # As such, this might not be the best way to use this object.
468
- # Please see https://github.com/UltraCart/sdk_samples for working examples.
469
-
470
- api = UltracartClient::WorkflowApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
471
- object_type = 'object_type_example' # String |
472
- object_id = 'object_id_example' # String |
473
-
474
- begin
475
- # Retrieve a workflow task by object type and id
476
- result = api_instance.get_workflow_task_by_object_type(object_type, object_id)
477
- p result
478
- rescue UltracartClient::ApiError => e
479
- puts "Error when calling WorkflowApi->get_workflow_task_by_object_type: #{e}"
480
- end
481
- ```
482
-
483
- #### Using the get_workflow_task_by_object_type_with_http_info variant
484
-
485
- This returns an Array which contains the response data, status code and headers.
486
-
487
- > <Array(<WorkflowTasksResponse>, Integer, Hash)> get_workflow_task_by_object_type_with_http_info(object_type, object_id)
488
-
489
- ```ruby
490
- begin
491
- # Retrieve a workflow task by object type and id
492
- data, status_code, headers = api_instance.get_workflow_task_by_object_type_with_http_info(object_type, object_id)
493
- p status_code # => 2xx
494
- p headers # => { ... }
495
- p data # => <WorkflowTasksResponse>
496
- rescue UltracartClient::ApiError => e
497
- puts "Error when calling WorkflowApi->get_workflow_task_by_object_type_with_http_info: #{e}"
498
- end
499
- ```
500
-
501
- ### Parameters
502
-
503
- | Name | Type | Description | Notes |
504
- | ---- | ---- | ----------- | ----- |
505
- | **object_type** | **String** | | |
506
- | **object_id** | **String** | | |
507
-
508
- ### Return type
509
-
510
- [**WorkflowTasksResponse**](WorkflowTasksResponse.md)
511
-
512
- ### Authorization
513
-
514
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
515
-
516
- ### HTTP request headers
517
-
518
- - **Content-Type**: Not defined
519
- - **Accept**: application/json
520
-
521
-
522
- ## get_workflow_task_open_count
523
-
524
- > <WorkflowTaskOpenCountResponse> get_workflow_task_open_count
525
-
526
- Retrieve workflow task open count
527
-
528
- Retrieve workflow task open count
529
-
530
- ### Examples
531
-
532
- ```ruby
533
- require 'time'
534
- require 'ultracart_api'
535
- require 'json'
536
- require 'yaml'
537
- require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
538
-
539
- # This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
540
- # As such, this might not be the best way to use this object.
541
- # Please see https://github.com/UltraCart/sdk_samples for working examples.
542
-
543
- api = UltracartClient::WorkflowApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
544
-
545
- begin
546
- # Retrieve workflow task open count
547
- result = api_instance.get_workflow_task_open_count
548
- p result
549
- rescue UltracartClient::ApiError => e
550
- puts "Error when calling WorkflowApi->get_workflow_task_open_count: #{e}"
551
- end
552
- ```
553
-
554
- #### Using the get_workflow_task_open_count_with_http_info variant
555
-
556
- This returns an Array which contains the response data, status code and headers.
557
-
558
- > <Array(<WorkflowTaskOpenCountResponse>, Integer, Hash)> get_workflow_task_open_count_with_http_info
559
-
560
- ```ruby
561
- begin
562
- # Retrieve workflow task open count
563
- data, status_code, headers = api_instance.get_workflow_task_open_count_with_http_info
564
- p status_code # => 2xx
565
- p headers # => { ... }
566
- p data # => <WorkflowTaskOpenCountResponse>
567
- rescue UltracartClient::ApiError => e
568
- puts "Error when calling WorkflowApi->get_workflow_task_open_count_with_http_info: #{e}"
569
- end
570
- ```
571
-
572
- ### Parameters
573
-
574
- This endpoint does not need any parameter.
575
-
576
- ### Return type
577
-
578
- [**WorkflowTaskOpenCountResponse**](WorkflowTaskOpenCountResponse.md)
579
-
580
- ### Authorization
581
-
582
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
583
-
584
- ### HTTP request headers
585
-
586
- - **Content-Type**: Not defined
587
- - **Accept**: application/json
588
-
589
-
590
- ## get_workflow_task_tags
591
-
592
- > <WorkflowTaskTagsResponse> get_workflow_task_tags
593
-
594
- Get a list of existing workflow task tags
595
-
596
- Retrieves a unique list of all the existing workflow task tags.
597
-
598
- ### Examples
599
-
600
- ```ruby
601
- require 'time'
602
- require 'ultracart_api'
603
- require 'json'
604
- require 'yaml'
605
- require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
606
-
607
- # This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
608
- # As such, this might not be the best way to use this object.
609
- # Please see https://github.com/UltraCart/sdk_samples for working examples.
610
-
611
- api = UltracartClient::WorkflowApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
612
-
613
- begin
614
- # Get a list of existing workflow task tags
615
- result = api_instance.get_workflow_task_tags
616
- p result
617
- rescue UltracartClient::ApiError => e
618
- puts "Error when calling WorkflowApi->get_workflow_task_tags: #{e}"
619
- end
620
- ```
621
-
622
- #### Using the get_workflow_task_tags_with_http_info variant
623
-
624
- This returns an Array which contains the response data, status code and headers.
625
-
626
- > <Array(<WorkflowTaskTagsResponse>, Integer, Hash)> get_workflow_task_tags_with_http_info
627
-
628
- ```ruby
629
- begin
630
- # Get a list of existing workflow task tags
631
- data, status_code, headers = api_instance.get_workflow_task_tags_with_http_info
632
- p status_code # => 2xx
633
- p headers # => { ... }
634
- p data # => <WorkflowTaskTagsResponse>
635
- rescue UltracartClient::ApiError => e
636
- puts "Error when calling WorkflowApi->get_workflow_task_tags_with_http_info: #{e}"
637
- end
638
- ```
639
-
640
- ### Parameters
641
-
642
- This endpoint does not need any parameter.
643
-
644
- ### Return type
645
-
646
- [**WorkflowTaskTagsResponse**](WorkflowTaskTagsResponse.md)
647
-
648
- ### Authorization
649
-
650
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
651
-
652
- ### HTTP request headers
653
-
654
- - **Content-Type**: Not defined
655
- - **Accept**: application/json
656
-
657
-
658
- ## get_workflow_tasks
659
-
660
- > <WorkflowTasksResponse> get_workflow_tasks(workflow_tasks_query, opts)
661
-
662
- Search workflow tasks
663
-
664
- Retrieves a set of workflow tasks from the account based on a query object.
665
-
666
- ### Examples
667
-
668
- ```ruby
669
- require 'time'
670
- require 'ultracart_api'
671
- require 'json'
672
- require 'yaml'
673
- require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
674
-
675
- # This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
676
- # As such, this might not be the best way to use this object.
677
- # Please see https://github.com/UltraCart/sdk_samples for working examples.
678
-
679
- api = UltracartClient::WorkflowApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
680
- workflow_tasks_query = UltracartClient::WorkflowTasksRequest.new # WorkflowTasksRequest | Workflow tasks query
681
- opts = {
682
- _limit: 56, # Integer | The maximum number of records to return on this one API call. (Default 100, Max 500)
683
- _offset: 56, # Integer | Pagination of the record set. Offset is a zero based index.
684
- _sort: '_sort_example' # String | The sort order of the items. See Sorting documentation for examples of using multiple values and sorting by ascending and descending.
685
- }
686
-
687
- begin
688
- # Search workflow tasks
689
- result = api_instance.get_workflow_tasks(workflow_tasks_query, opts)
690
- p result
691
- rescue UltracartClient::ApiError => e
692
- puts "Error when calling WorkflowApi->get_workflow_tasks: #{e}"
693
- end
694
- ```
695
-
696
- #### Using the get_workflow_tasks_with_http_info variant
697
-
698
- This returns an Array which contains the response data, status code and headers.
699
-
700
- > <Array(<WorkflowTasksResponse>, Integer, Hash)> get_workflow_tasks_with_http_info(workflow_tasks_query, opts)
701
-
702
- ```ruby
703
- begin
704
- # Search workflow tasks
705
- data, status_code, headers = api_instance.get_workflow_tasks_with_http_info(workflow_tasks_query, opts)
706
- p status_code # => 2xx
707
- p headers # => { ... }
708
- p data # => <WorkflowTasksResponse>
709
- rescue UltracartClient::ApiError => e
710
- puts "Error when calling WorkflowApi->get_workflow_tasks_with_http_info: #{e}"
711
- end
712
- ```
713
-
714
- ### Parameters
715
-
716
- | Name | Type | Description | Notes |
717
- | ---- | ---- | ----------- | ----- |
718
- | **workflow_tasks_query** | [**WorkflowTasksRequest**](WorkflowTasksRequest.md) | Workflow tasks query | |
719
- | **_limit** | **Integer** | The maximum number of records to return on this one API call. (Default 100, Max 500) | [optional][default to 100] |
720
- | **_offset** | **Integer** | Pagination of the record set. Offset is a zero based index. | [optional][default to 0] |
721
- | **_sort** | **String** | The sort order of the items. See Sorting documentation for examples of using multiple values and sorting by ascending and descending. | [optional] |
722
-
723
- ### Return type
724
-
725
- [**WorkflowTasksResponse**](WorkflowTasksResponse.md)
726
-
727
- ### Authorization
728
-
729
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
730
-
731
- ### HTTP request headers
732
-
733
- - **Content-Type**: application/json
734
- - **Accept**: application/json
735
-
736
-
737
- ## insert_workflow_task
738
-
739
- > <WorkflowTaskResponse> insert_workflow_task(workflow_task)
740
-
741
- Insert a workflow task
742
-
743
- Insert a workflow task
744
-
745
- ### Examples
746
-
747
- ```ruby
748
- require 'time'
749
- require 'ultracart_api'
750
- require 'json'
751
- require 'yaml'
752
- require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
753
-
754
- # This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
755
- # As such, this might not be the best way to use this object.
756
- # Please see https://github.com/UltraCart/sdk_samples for working examples.
757
-
758
- api = UltracartClient::WorkflowApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
759
- workflow_task = UltracartClient::WorkflowTask.new # WorkflowTask | workflow task
760
-
761
- begin
762
- # Insert a workflow task
763
- result = api_instance.insert_workflow_task(workflow_task)
764
- p result
765
- rescue UltracartClient::ApiError => e
766
- puts "Error when calling WorkflowApi->insert_workflow_task: #{e}"
767
- end
768
- ```
769
-
770
- #### Using the insert_workflow_task_with_http_info variant
771
-
772
- This returns an Array which contains the response data, status code and headers.
773
-
774
- > <Array(<WorkflowTaskResponse>, Integer, Hash)> insert_workflow_task_with_http_info(workflow_task)
775
-
776
- ```ruby
777
- begin
778
- # Insert a workflow task
779
- data, status_code, headers = api_instance.insert_workflow_task_with_http_info(workflow_task)
780
- p status_code # => 2xx
781
- p headers # => { ... }
782
- p data # => <WorkflowTaskResponse>
783
- rescue UltracartClient::ApiError => e
784
- puts "Error when calling WorkflowApi->insert_workflow_task_with_http_info: #{e}"
785
- end
786
- ```
787
-
788
- ### Parameters
789
-
790
- | Name | Type | Description | Notes |
791
- | ---- | ---- | ----------- | ----- |
792
- | **workflow_task** | [**WorkflowTask**](WorkflowTask.md) | workflow task | |
793
-
794
- ### Return type
795
-
796
- [**WorkflowTaskResponse**](WorkflowTaskResponse.md)
797
-
798
- ### Authorization
799
-
800
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
801
-
802
- ### HTTP request headers
803
-
804
- - **Content-Type**: application/json
805
- - **Accept**: application/json
806
-
807
-
808
- ## update_workflow_task
809
-
810
- > <WorkflowTaskResponse> update_workflow_task(task_uuid, workflow_task)
811
-
812
- Update a workflow task
813
-
814
- Update a workflow task
815
-
816
- ### Examples
817
-
818
- ```ruby
819
- require 'time'
820
- require 'ultracart_api'
821
- require 'json'
822
- require 'yaml'
823
- require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
824
-
825
- # This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
826
- # As such, this might not be the best way to use this object.
827
- # Please see https://github.com/UltraCart/sdk_samples for working examples.
828
-
829
- api = UltracartClient::WorkflowApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
830
- task_uuid = 'task_uuid_example' # String |
831
- workflow_task = UltracartClient::WorkflowTask.new # WorkflowTask | Workflow task
832
-
833
- begin
834
- # Update a workflow task
835
- result = api_instance.update_workflow_task(task_uuid, workflow_task)
836
- p result
837
- rescue UltracartClient::ApiError => e
838
- puts "Error when calling WorkflowApi->update_workflow_task: #{e}"
839
- end
840
- ```
841
-
842
- #### Using the update_workflow_task_with_http_info variant
843
-
844
- This returns an Array which contains the response data, status code and headers.
845
-
846
- > <Array(<WorkflowTaskResponse>, Integer, Hash)> update_workflow_task_with_http_info(task_uuid, workflow_task)
847
-
848
- ```ruby
849
- begin
850
- # Update a workflow task
851
- data, status_code, headers = api_instance.update_workflow_task_with_http_info(task_uuid, workflow_task)
852
- p status_code # => 2xx
853
- p headers # => { ... }
854
- p data # => <WorkflowTaskResponse>
855
- rescue UltracartClient::ApiError => e
856
- puts "Error when calling WorkflowApi->update_workflow_task_with_http_info: #{e}"
857
- end
858
- ```
859
-
860
- ### Parameters
861
-
862
- | Name | Type | Description | Notes |
863
- | ---- | ---- | ----------- | ----- |
864
- | **task_uuid** | **String** | | |
865
- | **workflow_task** | [**WorkflowTask**](WorkflowTask.md) | Workflow task | |
866
-
867
- ### Return type
868
-
869
- [**WorkflowTaskResponse**](WorkflowTaskResponse.md)
870
-
871
- ### Authorization
872
-
873
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
874
-
875
- ### HTTP request headers
876
-
877
- - **Content-Type**: application/json
878
- - **Accept**: application/json
879
-
1
+ # UltracartClient::WorkflowApi
2
+
3
+ All URIs are relative to *https://secure.ultracart.com/rest/v2*
4
+
5
+ | Method | HTTP request | Description |
6
+ | ------ | ------------ | ----------- |
7
+ | [**get_workflow_agent_websocket_authorization**](WorkflowApi.md#get_workflow_agent_websocket_authorization) | **PUT** /workflow/agent/auth | Get agent websocket authorization |
8
+ | [**get_workflow_assignment_groups**](WorkflowApi.md#get_workflow_assignment_groups) | **GET** /workflow/assignment_groups | Retrieve a list of groups that workflow tasks can be assigned to |
9
+ | [**get_workflow_assignment_users**](WorkflowApi.md#get_workflow_assignment_users) | **GET** /workflow/assignment_users | Retrieve a list of users that workflow tasks can be assigned to |
10
+ | [**get_workflow_me**](WorkflowApi.md#get_workflow_me) | **GET** /workflow/me | Retrieve a user object for myself |
11
+ | [**get_workflow_task**](WorkflowApi.md#get_workflow_task) | **GET** /workflow/tasks/{task_uuid} | Retrieve a workflow task |
12
+ | [**get_workflow_task_attachment_upload_url**](WorkflowApi.md#get_workflow_task_attachment_upload_url) | **GET** /workflow/tasks/attachments/{extension} | Get a presigned workflow task attachment upload URL |
13
+ | [**get_workflow_task_by_object_type**](WorkflowApi.md#get_workflow_task_by_object_type) | **GET** /workflow/tasks/by/{object_type}/{object_id} | Retrieve a workflow task by object type and id |
14
+ | [**get_workflow_task_open_count**](WorkflowApi.md#get_workflow_task_open_count) | **GET** /workflow/tasks/open_count | Retrieve workflow task open count |
15
+ | [**get_workflow_task_tags**](WorkflowApi.md#get_workflow_task_tags) | **GET** /workflow/tasks/tags | Get a list of existing workflow task tags |
16
+ | [**get_workflow_tasks**](WorkflowApi.md#get_workflow_tasks) | **POST** /workflow/tasks/search | Search workflow tasks |
17
+ | [**insert_workflow_task**](WorkflowApi.md#insert_workflow_task) | **POST** /workflow/tasks | Insert a workflow task |
18
+ | [**update_workflow_task**](WorkflowApi.md#update_workflow_task) | **PUT** /workflow/tasks/{task_uuid} | Update a workflow task |
19
+
20
+
21
+ ## get_workflow_agent_websocket_authorization
22
+
23
+ > <WorkflowAgentAuthResponse> get_workflow_agent_websocket_authorization
24
+
25
+ Get agent websocket authorization
26
+
27
+ Retrieve a JWT to authorize an agent to make a websocket connection.
28
+
29
+
30
+ ### Examples
31
+
32
+ ```ruby
33
+ # Internal API. No samples are provided as merchants will never need this api method
34
+ ```
35
+
36
+
37
+ #### Using the get_workflow_agent_websocket_authorization_with_http_info variant
38
+
39
+ This returns an Array which contains the response data, status code and headers.
40
+
41
+ > <Array(<WorkflowAgentAuthResponse>, Integer, Hash)> get_workflow_agent_websocket_authorization_with_http_info
42
+
43
+ ```ruby
44
+ begin
45
+ # Get agent websocket authorization
46
+ data, status_code, headers = api_instance.get_workflow_agent_websocket_authorization_with_http_info
47
+ p status_code # => 2xx
48
+ p headers # => { ... }
49
+ p data # => <WorkflowAgentAuthResponse>
50
+ rescue UltracartClient::ApiError => e
51
+ puts "Error when calling WorkflowApi->get_workflow_agent_websocket_authorization_with_http_info: #{e}"
52
+ end
53
+ ```
54
+
55
+ ### Parameters
56
+
57
+ This endpoint does not need any parameter.
58
+
59
+ ### Return type
60
+
61
+ [**WorkflowAgentAuthResponse**](WorkflowAgentAuthResponse.md)
62
+
63
+ ### Authorization
64
+
65
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
66
+
67
+ ### HTTP request headers
68
+
69
+ - **Content-Type**: Not defined
70
+ - **Accept**: application/json
71
+
72
+
73
+ ## get_workflow_assignment_groups
74
+
75
+ > <WorkflowGroupsResponse> get_workflow_assignment_groups(opts)
76
+
77
+ Retrieve a list of groups that workflow tasks can be assigned to
78
+
79
+ Retrieve a list of groups that workflow tasks can be assigned to
80
+
81
+
82
+ ### Examples
83
+
84
+ ```ruby
85
+ # Internal API. No samples are provided as merchants will never need this api method
86
+ ```
87
+
88
+
89
+ #### Using the get_workflow_assignment_groups_with_http_info variant
90
+
91
+ This returns an Array which contains the response data, status code and headers.
92
+
93
+ > <Array(<WorkflowGroupsResponse>, Integer, Hash)> get_workflow_assignment_groups_with_http_info(opts)
94
+
95
+ ```ruby
96
+ begin
97
+ # Retrieve a list of groups that workflow tasks can be assigned to
98
+ data, status_code, headers = api_instance.get_workflow_assignment_groups_with_http_info(opts)
99
+ p status_code # => 2xx
100
+ p headers # => { ... }
101
+ p data # => <WorkflowGroupsResponse>
102
+ rescue UltracartClient::ApiError => e
103
+ puts "Error when calling WorkflowApi->get_workflow_assignment_groups_with_http_info: #{e}"
104
+ end
105
+ ```
106
+
107
+ ### Parameters
108
+
109
+ | Name | Type | Description | Notes |
110
+ | ---- | ---- | ----------- | ----- |
111
+ | **_limit** | **Integer** | The maximum number of records to return on this one API call. (Max 200) | [optional][default to 100] |
112
+ | **_offset** | **Integer** | Pagination of the record set. Offset is a zero based index. | [optional][default to 0] |
113
+
114
+ ### Return type
115
+
116
+ [**WorkflowGroupsResponse**](WorkflowGroupsResponse.md)
117
+
118
+ ### Authorization
119
+
120
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
121
+
122
+ ### HTTP request headers
123
+
124
+ - **Content-Type**: Not defined
125
+ - **Accept**: application/json
126
+
127
+
128
+ ## get_workflow_assignment_users
129
+
130
+ > <WorkflowUsersResponse> get_workflow_assignment_users(opts)
131
+
132
+ Retrieve a list of users that workflow tasks can be assigned to
133
+
134
+ Retrieve a list of users that workflow tasks can be assigned to
135
+
136
+
137
+ ### Examples
138
+
139
+ ```ruby
140
+ # Internal API. No samples are provided as merchants will never need this api method
141
+ ```
142
+
143
+
144
+ #### Using the get_workflow_assignment_users_with_http_info variant
145
+
146
+ This returns an Array which contains the response data, status code and headers.
147
+
148
+ > <Array(<WorkflowUsersResponse>, Integer, Hash)> get_workflow_assignment_users_with_http_info(opts)
149
+
150
+ ```ruby
151
+ begin
152
+ # Retrieve a list of users that workflow tasks can be assigned to
153
+ data, status_code, headers = api_instance.get_workflow_assignment_users_with_http_info(opts)
154
+ p status_code # => 2xx
155
+ p headers # => { ... }
156
+ p data # => <WorkflowUsersResponse>
157
+ rescue UltracartClient::ApiError => e
158
+ puts "Error when calling WorkflowApi->get_workflow_assignment_users_with_http_info: #{e}"
159
+ end
160
+ ```
161
+
162
+ ### Parameters
163
+
164
+ | Name | Type | Description | Notes |
165
+ | ---- | ---- | ----------- | ----- |
166
+ | **_limit** | **Integer** | The maximum number of records to return on this one API call. (Max 200) | [optional][default to 100] |
167
+ | **_offset** | **Integer** | Pagination of the record set. Offset is a zero based index. | [optional][default to 0] |
168
+
169
+ ### Return type
170
+
171
+ [**WorkflowUsersResponse**](WorkflowUsersResponse.md)
172
+
173
+ ### Authorization
174
+
175
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
176
+
177
+ ### HTTP request headers
178
+
179
+ - **Content-Type**: Not defined
180
+ - **Accept**: application/json
181
+
182
+
183
+ ## get_workflow_me
184
+
185
+ > <WorkflowUserResponse> get_workflow_me
186
+
187
+ Retrieve a user object for myself
188
+
189
+ Retrieve a user object for myself
190
+
191
+
192
+ ### Examples
193
+
194
+ ```ruby
195
+ # Internal API. No samples are provided as merchants will never need this api method
196
+ ```
197
+
198
+
199
+ #### Using the get_workflow_me_with_http_info variant
200
+
201
+ This returns an Array which contains the response data, status code and headers.
202
+
203
+ > <Array(<WorkflowUserResponse>, Integer, Hash)> get_workflow_me_with_http_info
204
+
205
+ ```ruby
206
+ begin
207
+ # Retrieve a user object for myself
208
+ data, status_code, headers = api_instance.get_workflow_me_with_http_info
209
+ p status_code # => 2xx
210
+ p headers # => { ... }
211
+ p data # => <WorkflowUserResponse>
212
+ rescue UltracartClient::ApiError => e
213
+ puts "Error when calling WorkflowApi->get_workflow_me_with_http_info: #{e}"
214
+ end
215
+ ```
216
+
217
+ ### Parameters
218
+
219
+ This endpoint does not need any parameter.
220
+
221
+ ### Return type
222
+
223
+ [**WorkflowUserResponse**](WorkflowUserResponse.md)
224
+
225
+ ### Authorization
226
+
227
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
228
+
229
+ ### HTTP request headers
230
+
231
+ - **Content-Type**: Not defined
232
+ - **Accept**: application/json
233
+
234
+
235
+ ## get_workflow_task
236
+
237
+ > <WorkflowTaskResponse> get_workflow_task(task_uuid)
238
+
239
+ Retrieve a workflow task
240
+
241
+ Retrieve a workflow task
242
+
243
+
244
+ ### Examples
245
+
246
+ ```ruby
247
+ # Internal API. No samples are provided as merchants will never need this api method
248
+ ```
249
+
250
+
251
+ #### Using the get_workflow_task_with_http_info variant
252
+
253
+ This returns an Array which contains the response data, status code and headers.
254
+
255
+ > <Array(<WorkflowTaskResponse>, Integer, Hash)> get_workflow_task_with_http_info(task_uuid)
256
+
257
+ ```ruby
258
+ begin
259
+ # Retrieve a workflow task
260
+ data, status_code, headers = api_instance.get_workflow_task_with_http_info(task_uuid)
261
+ p status_code # => 2xx
262
+ p headers # => { ... }
263
+ p data # => <WorkflowTaskResponse>
264
+ rescue UltracartClient::ApiError => e
265
+ puts "Error when calling WorkflowApi->get_workflow_task_with_http_info: #{e}"
266
+ end
267
+ ```
268
+
269
+ ### Parameters
270
+
271
+ | Name | Type | Description | Notes |
272
+ | ---- | ---- | ----------- | ----- |
273
+ | **task_uuid** | **String** | | |
274
+
275
+ ### Return type
276
+
277
+ [**WorkflowTaskResponse**](WorkflowTaskResponse.md)
278
+
279
+ ### Authorization
280
+
281
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
282
+
283
+ ### HTTP request headers
284
+
285
+ - **Content-Type**: Not defined
286
+ - **Accept**: application/json
287
+
288
+
289
+ ## get_workflow_task_attachment_upload_url
290
+
291
+ > <WorkflowAttachmentUploadUrlResponse> get_workflow_task_attachment_upload_url(extension)
292
+
293
+ Get a presigned workflow task attachment upload URL
294
+
295
+ Get a presigned workflow task attachment upload URL
296
+
297
+
298
+ ### Examples
299
+
300
+ ```ruby
301
+ # Internal API. No samples are provided as merchants will never need this api method
302
+ ```
303
+
304
+
305
+ #### Using the get_workflow_task_attachment_upload_url_with_http_info variant
306
+
307
+ This returns an Array which contains the response data, status code and headers.
308
+
309
+ > <Array(<WorkflowAttachmentUploadUrlResponse>, Integer, Hash)> get_workflow_task_attachment_upload_url_with_http_info(extension)
310
+
311
+ ```ruby
312
+ begin
313
+ # Get a presigned workflow task attachment upload URL
314
+ data, status_code, headers = api_instance.get_workflow_task_attachment_upload_url_with_http_info(extension)
315
+ p status_code # => 2xx
316
+ p headers # => { ... }
317
+ p data # => <WorkflowAttachmentUploadUrlResponse>
318
+ rescue UltracartClient::ApiError => e
319
+ puts "Error when calling WorkflowApi->get_workflow_task_attachment_upload_url_with_http_info: #{e}"
320
+ end
321
+ ```
322
+
323
+ ### Parameters
324
+
325
+ | Name | Type | Description | Notes |
326
+ | ---- | ---- | ----------- | ----- |
327
+ | **extension** | **String** | | |
328
+
329
+ ### Return type
330
+
331
+ [**WorkflowAttachmentUploadUrlResponse**](WorkflowAttachmentUploadUrlResponse.md)
332
+
333
+ ### Authorization
334
+
335
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
336
+
337
+ ### HTTP request headers
338
+
339
+ - **Content-Type**: Not defined
340
+ - **Accept**: application/json
341
+
342
+
343
+ ## get_workflow_task_by_object_type
344
+
345
+ > <WorkflowTasksResponse> get_workflow_task_by_object_type(object_type, object_id)
346
+
347
+ Retrieve a workflow task by object type and id
348
+
349
+ Retrieve a workflow task by object type and id
350
+
351
+
352
+ ### Examples
353
+
354
+ ```ruby
355
+ # Internal API. No samples are provided as merchants will never need this api method
356
+ ```
357
+
358
+
359
+ #### Using the get_workflow_task_by_object_type_with_http_info variant
360
+
361
+ This returns an Array which contains the response data, status code and headers.
362
+
363
+ > <Array(<WorkflowTasksResponse>, Integer, Hash)> get_workflow_task_by_object_type_with_http_info(object_type, object_id)
364
+
365
+ ```ruby
366
+ begin
367
+ # Retrieve a workflow task by object type and id
368
+ data, status_code, headers = api_instance.get_workflow_task_by_object_type_with_http_info(object_type, object_id)
369
+ p status_code # => 2xx
370
+ p headers # => { ... }
371
+ p data # => <WorkflowTasksResponse>
372
+ rescue UltracartClient::ApiError => e
373
+ puts "Error when calling WorkflowApi->get_workflow_task_by_object_type_with_http_info: #{e}"
374
+ end
375
+ ```
376
+
377
+ ### Parameters
378
+
379
+ | Name | Type | Description | Notes |
380
+ | ---- | ---- | ----------- | ----- |
381
+ | **object_type** | **String** | | |
382
+ | **object_id** | **String** | | |
383
+
384
+ ### Return type
385
+
386
+ [**WorkflowTasksResponse**](WorkflowTasksResponse.md)
387
+
388
+ ### Authorization
389
+
390
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
391
+
392
+ ### HTTP request headers
393
+
394
+ - **Content-Type**: Not defined
395
+ - **Accept**: application/json
396
+
397
+
398
+ ## get_workflow_task_open_count
399
+
400
+ > <WorkflowTaskOpenCountResponse> get_workflow_task_open_count
401
+
402
+ Retrieve workflow task open count
403
+
404
+ Retrieve workflow task open count
405
+
406
+
407
+ ### Examples
408
+
409
+ ```ruby
410
+ # Internal API. No samples are provided as merchants will never need this api method
411
+ ```
412
+
413
+
414
+ #### Using the get_workflow_task_open_count_with_http_info variant
415
+
416
+ This returns an Array which contains the response data, status code and headers.
417
+
418
+ > <Array(<WorkflowTaskOpenCountResponse>, Integer, Hash)> get_workflow_task_open_count_with_http_info
419
+
420
+ ```ruby
421
+ begin
422
+ # Retrieve workflow task open count
423
+ data, status_code, headers = api_instance.get_workflow_task_open_count_with_http_info
424
+ p status_code # => 2xx
425
+ p headers # => { ... }
426
+ p data # => <WorkflowTaskOpenCountResponse>
427
+ rescue UltracartClient::ApiError => e
428
+ puts "Error when calling WorkflowApi->get_workflow_task_open_count_with_http_info: #{e}"
429
+ end
430
+ ```
431
+
432
+ ### Parameters
433
+
434
+ This endpoint does not need any parameter.
435
+
436
+ ### Return type
437
+
438
+ [**WorkflowTaskOpenCountResponse**](WorkflowTaskOpenCountResponse.md)
439
+
440
+ ### Authorization
441
+
442
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
443
+
444
+ ### HTTP request headers
445
+
446
+ - **Content-Type**: Not defined
447
+ - **Accept**: application/json
448
+
449
+
450
+ ## get_workflow_task_tags
451
+
452
+ > <WorkflowTaskTagsResponse> get_workflow_task_tags
453
+
454
+ Get a list of existing workflow task tags
455
+
456
+ Retrieves a unique list of all the existing workflow task tags.
457
+
458
+
459
+ ### Examples
460
+
461
+ ```ruby
462
+ # Internal API. No samples are provided as merchants will never need this api method
463
+ ```
464
+
465
+
466
+ #### Using the get_workflow_task_tags_with_http_info variant
467
+
468
+ This returns an Array which contains the response data, status code and headers.
469
+
470
+ > <Array(<WorkflowTaskTagsResponse>, Integer, Hash)> get_workflow_task_tags_with_http_info
471
+
472
+ ```ruby
473
+ begin
474
+ # Get a list of existing workflow task tags
475
+ data, status_code, headers = api_instance.get_workflow_task_tags_with_http_info
476
+ p status_code # => 2xx
477
+ p headers # => { ... }
478
+ p data # => <WorkflowTaskTagsResponse>
479
+ rescue UltracartClient::ApiError => e
480
+ puts "Error when calling WorkflowApi->get_workflow_task_tags_with_http_info: #{e}"
481
+ end
482
+ ```
483
+
484
+ ### Parameters
485
+
486
+ This endpoint does not need any parameter.
487
+
488
+ ### Return type
489
+
490
+ [**WorkflowTaskTagsResponse**](WorkflowTaskTagsResponse.md)
491
+
492
+ ### Authorization
493
+
494
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
495
+
496
+ ### HTTP request headers
497
+
498
+ - **Content-Type**: Not defined
499
+ - **Accept**: application/json
500
+
501
+
502
+ ## get_workflow_tasks
503
+
504
+ > <WorkflowTasksResponse> get_workflow_tasks(workflow_tasks_query, opts)
505
+
506
+ Search workflow tasks
507
+
508
+ Retrieves a set of workflow tasks from the account based on a query object.
509
+
510
+
511
+ ### Examples
512
+
513
+ ```ruby
514
+ # Internal API. No samples are provided as merchants will never need this api method
515
+ ```
516
+
517
+
518
+ #### Using the get_workflow_tasks_with_http_info variant
519
+
520
+ This returns an Array which contains the response data, status code and headers.
521
+
522
+ > <Array(<WorkflowTasksResponse>, Integer, Hash)> get_workflow_tasks_with_http_info(workflow_tasks_query, opts)
523
+
524
+ ```ruby
525
+ begin
526
+ # Search workflow tasks
527
+ data, status_code, headers = api_instance.get_workflow_tasks_with_http_info(workflow_tasks_query, opts)
528
+ p status_code # => 2xx
529
+ p headers # => { ... }
530
+ p data # => <WorkflowTasksResponse>
531
+ rescue UltracartClient::ApiError => e
532
+ puts "Error when calling WorkflowApi->get_workflow_tasks_with_http_info: #{e}"
533
+ end
534
+ ```
535
+
536
+ ### Parameters
537
+
538
+ | Name | Type | Description | Notes |
539
+ | ---- | ---- | ----------- | ----- |
540
+ | **workflow_tasks_query** | [**WorkflowTasksRequest**](WorkflowTasksRequest.md) | Workflow tasks query | |
541
+ | **_limit** | **Integer** | The maximum number of records to return on this one API call. (Default 100, Max 500) | [optional][default to 100] |
542
+ | **_offset** | **Integer** | Pagination of the record set. Offset is a zero based index. | [optional][default to 0] |
543
+ | **_sort** | **String** | The sort order of the items. See Sorting documentation for examples of using multiple values and sorting by ascending and descending. | [optional] |
544
+
545
+ ### Return type
546
+
547
+ [**WorkflowTasksResponse**](WorkflowTasksResponse.md)
548
+
549
+ ### Authorization
550
+
551
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
552
+
553
+ ### HTTP request headers
554
+
555
+ - **Content-Type**: application/json
556
+ - **Accept**: application/json
557
+
558
+
559
+ ## insert_workflow_task
560
+
561
+ > <WorkflowTaskResponse> insert_workflow_task(workflow_task)
562
+
563
+ Insert a workflow task
564
+
565
+ Insert a workflow task
566
+
567
+
568
+ ### Examples
569
+
570
+ ```ruby
571
+ # Internal API. No samples are provided as merchants will never need this api method
572
+ ```
573
+
574
+
575
+ #### Using the insert_workflow_task_with_http_info variant
576
+
577
+ This returns an Array which contains the response data, status code and headers.
578
+
579
+ > <Array(<WorkflowTaskResponse>, Integer, Hash)> insert_workflow_task_with_http_info(workflow_task)
580
+
581
+ ```ruby
582
+ begin
583
+ # Insert a workflow task
584
+ data, status_code, headers = api_instance.insert_workflow_task_with_http_info(workflow_task)
585
+ p status_code # => 2xx
586
+ p headers # => { ... }
587
+ p data # => <WorkflowTaskResponse>
588
+ rescue UltracartClient::ApiError => e
589
+ puts "Error when calling WorkflowApi->insert_workflow_task_with_http_info: #{e}"
590
+ end
591
+ ```
592
+
593
+ ### Parameters
594
+
595
+ | Name | Type | Description | Notes |
596
+ | ---- | ---- | ----------- | ----- |
597
+ | **workflow_task** | [**WorkflowTask**](WorkflowTask.md) | workflow task | |
598
+
599
+ ### Return type
600
+
601
+ [**WorkflowTaskResponse**](WorkflowTaskResponse.md)
602
+
603
+ ### Authorization
604
+
605
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
606
+
607
+ ### HTTP request headers
608
+
609
+ - **Content-Type**: application/json
610
+ - **Accept**: application/json
611
+
612
+
613
+ ## update_workflow_task
614
+
615
+ > <WorkflowTaskResponse> update_workflow_task(task_uuid, workflow_task)
616
+
617
+ Update a workflow task
618
+
619
+ Update a workflow task
620
+
621
+
622
+ ### Examples
623
+
624
+ ```ruby
625
+ # Internal API. No samples are provided as merchants will never need this api method
626
+ ```
627
+
628
+
629
+ #### Using the update_workflow_task_with_http_info variant
630
+
631
+ This returns an Array which contains the response data, status code and headers.
632
+
633
+ > <Array(<WorkflowTaskResponse>, Integer, Hash)> update_workflow_task_with_http_info(task_uuid, workflow_task)
634
+
635
+ ```ruby
636
+ begin
637
+ # Update a workflow task
638
+ data, status_code, headers = api_instance.update_workflow_task_with_http_info(task_uuid, workflow_task)
639
+ p status_code # => 2xx
640
+ p headers # => { ... }
641
+ p data # => <WorkflowTaskResponse>
642
+ rescue UltracartClient::ApiError => e
643
+ puts "Error when calling WorkflowApi->update_workflow_task_with_http_info: #{e}"
644
+ end
645
+ ```
646
+
647
+ ### Parameters
648
+
649
+ | Name | Type | Description | Notes |
650
+ | ---- | ---- | ----------- | ----- |
651
+ | **task_uuid** | **String** | | |
652
+ | **workflow_task** | [**WorkflowTask**](WorkflowTask.md) | Workflow task | |
653
+
654
+ ### Return type
655
+
656
+ [**WorkflowTaskResponse**](WorkflowTaskResponse.md)
657
+
658
+ ### Authorization
659
+
660
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
661
+
662
+ ### HTTP request headers
663
+
664
+ - **Content-Type**: application/json
665
+ - **Accept**: application/json
666
+