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.
- checksums.yaml +4 -4
- data/README.md +4 -2
- data/docs/AffiliateApi.md +123 -167
- data/docs/AutoOrderApi.md +1250 -903
- data/docs/ChannelPartnerApi.md +1678 -1121
- data/docs/ChargebackApi.md +297 -405
- data/docs/CheckoutApi.md +1622 -1424
- data/docs/Conversation.md +4 -0
- data/docs/ConversationApi.md +4820 -6315
- data/docs/CouponApi.md +1522 -1443
- data/docs/CustomerApi.md +2570 -1845
- data/docs/DatawarehouseApi.md +555 -723
- data/docs/FulfillmentApi.md +567 -441
- data/docs/GiftCertificateApi.md +617 -598
- data/docs/IntegrationLogApi.md +290 -385
- data/docs/ItemApi.md +2174 -1746
- data/docs/ItemRestriction.md +2 -0
- data/docs/OauthApi.md +203 -163
- data/docs/OrderApi.md +2774 -2177
- data/docs/SsoApi.md +223 -288
- data/docs/StorefrontApi.md +9692 -12967
- data/docs/TaxApi.md +1541 -2017
- data/docs/UserApi.md +606 -790
- data/docs/WebhookApi.md +787 -628
- data/docs/WorkflowApi.md +666 -879
- data/lib/ultracart_api/models/conversation.rb +21 -1
- data/lib/ultracart_api/models/item_restriction.rb +11 -1
- data/lib/ultracart_api/version.rb +1 -1
- metadata +2 -2
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
|
-
|
30
|
-
|
31
|
-
|
32
|
-
|
33
|
-
|
34
|
-
|
35
|
-
|
36
|
-
|
37
|
-
|
38
|
-
|
39
|
-
|
40
|
-
|
41
|
-
|
42
|
-
|
43
|
-
|
44
|
-
begin
|
45
|
-
# Get agent websocket authorization
|
46
|
-
|
47
|
-
p
|
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
|
-
|
89
|
-
|
90
|
-
|
91
|
-
|
92
|
-
|
93
|
-
|
94
|
-
|
95
|
-
|
96
|
-
|
97
|
-
|
98
|
-
|
99
|
-
|
100
|
-
|
101
|
-
|
102
|
-
|
103
|
-
|
104
|
-
|
105
|
-
|
106
|
-
|
107
|
-
|
108
|
-
|
109
|
-
|
110
|
-
|
111
|
-
|
112
|
-
|
113
|
-
|
114
|
-
|
115
|
-
|
116
|
-
|
117
|
-
|
118
|
-
|
119
|
-
|
120
|
-
|
121
|
-
|
122
|
-
|
123
|
-
|
124
|
-
|
125
|
-
|
126
|
-
|
127
|
-
|
128
|
-
|
129
|
-
|
130
|
-
|
131
|
-
|
132
|
-
|
133
|
-
|
134
|
-
|
135
|
-
|
136
|
-
|
137
|
-
|
138
|
-
|
139
|
-
|
140
|
-
|
141
|
-
```
|
142
|
-
|
143
|
-
|
144
|
-
|
145
|
-
|
146
|
-
|
147
|
-
|
148
|
-
|
149
|
-
|
150
|
-
|
151
|
-
|
152
|
-
|
153
|
-
|
154
|
-
|
155
|
-
|
156
|
-
|
157
|
-
|
158
|
-
|
159
|
-
|
160
|
-
|
161
|
-
|
162
|
-
|
163
|
-
|
164
|
-
|
165
|
-
|
166
|
-
|
167
|
-
|
168
|
-
|
169
|
-
|
170
|
-
|
171
|
-
|
172
|
-
|
173
|
-
|
174
|
-
|
175
|
-
|
176
|
-
|
177
|
-
|
178
|
-
|
179
|
-
|
180
|
-
|
181
|
-
|
182
|
-
|
183
|
-
|
184
|
-
|
185
|
-
|
186
|
-
|
187
|
-
|
188
|
-
|
189
|
-
|
190
|
-
|
191
|
-
|
192
|
-
|
193
|
-
|
194
|
-
|
195
|
-
|
196
|
-
|
197
|
-
|
198
|
-
|
199
|
-
|
200
|
-
|
201
|
-
|
202
|
-
|
203
|
-
|
204
|
-
|
205
|
-
|
206
|
-
|
207
|
-
|
208
|
-
|
209
|
-
|
210
|
-
p
|
211
|
-
p
|
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
|
-
|
249
|
-
|
250
|
-
|
251
|
-
|
252
|
-
|
253
|
-
|
254
|
-
|
255
|
-
|
256
|
-
|
257
|
-
|
258
|
-
|
259
|
-
|
260
|
-
|
261
|
-
|
262
|
-
|
263
|
-
|
264
|
-
|
265
|
-
|
266
|
-
|
267
|
-
|
268
|
-
|
269
|
-
|
270
|
-
|
271
|
-
|
272
|
-
|
273
|
-
|
274
|
-
|
275
|
-
|
276
|
-
|
277
|
-
|
278
|
-
|
279
|
-
|
280
|
-
|
281
|
-
|
282
|
-
|
283
|
-
|
284
|
-
|
285
|
-
|
286
|
-
|
287
|
-
|
288
|
-
|
289
|
-
|
290
|
-
|
291
|
-
|
292
|
-
|
293
|
-
|
294
|
-
|
295
|
-
|
296
|
-
|
297
|
-
|
298
|
-
|
299
|
-
|
300
|
-
|
301
|
-
|
302
|
-
|
303
|
-
|
304
|
-
|
305
|
-
|
306
|
-
|
307
|
-
|
308
|
-
|
309
|
-
> <
|
310
|
-
|
311
|
-
|
312
|
-
|
313
|
-
|
314
|
-
|
315
|
-
|
316
|
-
|
317
|
-
|
318
|
-
|
319
|
-
|
320
|
-
|
321
|
-
|
322
|
-
|
323
|
-
|
324
|
-
|
325
|
-
|
326
|
-
|
327
|
-
|
328
|
-
|
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
|
-
|
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
|
-
|
432
|
-
|
433
|
-
|
434
|
-
|
435
|
-
|
436
|
-
|
437
|
-
|
438
|
-
|
439
|
-
|
440
|
-
|
441
|
-
|
442
|
-
|
443
|
-
|
444
|
-
|
445
|
-
|
446
|
-
- **
|
447
|
-
|
448
|
-
|
449
|
-
|
450
|
-
|
451
|
-
|
452
|
-
|
453
|
-
|
454
|
-
|
455
|
-
|
456
|
-
|
457
|
-
|
458
|
-
|
459
|
-
|
460
|
-
|
461
|
-
|
462
|
-
|
463
|
-
|
464
|
-
|
465
|
-
|
466
|
-
|
467
|
-
|
468
|
-
|
469
|
-
|
470
|
-
|
471
|
-
|
472
|
-
|
473
|
-
|
474
|
-
|
475
|
-
|
476
|
-
|
477
|
-
p
|
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
|
-
|
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
|
-
|
545
|
-
|
546
|
-
|
547
|
-
|
548
|
-
|
549
|
-
|
550
|
-
|
551
|
-
|
552
|
-
|
553
|
-
|
554
|
-
|
555
|
-
|
556
|
-
|
557
|
-
|
558
|
-
|
559
|
-
|
560
|
-
|
561
|
-
|
562
|
-
|
563
|
-
|
564
|
-
|
565
|
-
|
566
|
-
|
567
|
-
|
568
|
-
|
569
|
-
|
570
|
-
```
|
571
|
-
|
572
|
-
|
573
|
-
|
574
|
-
|
575
|
-
|
576
|
-
|
577
|
-
|
578
|
-
|
579
|
-
|
580
|
-
|
581
|
-
|
582
|
-
|
583
|
-
|
584
|
-
|
585
|
-
|
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
|
-
|
633
|
-
|
634
|
-
|
635
|
-
|
636
|
-
|
637
|
-
|
638
|
-
|
639
|
-
|
640
|
-
|
641
|
-
|
642
|
-
|
643
|
-
|
644
|
-
|
645
|
-
|
646
|
-
|
647
|
-
|
648
|
-
|
649
|
-
|
650
|
-
|
651
|
-
|
652
|
-
|
653
|
-
|
654
|
-
|
655
|
-
|
656
|
-
|
657
|
-
|
658
|
-
|
659
|
-
|
660
|
-
|
661
|
-
|
662
|
-
|
663
|
-
|
664
|
-
|
665
|
-
|
666
|
-
|
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
|
+
|