ultracart_api 3.10.163 → 3.10.165
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +30 -5
- data/docs/ConversationApi.md +4 -4
- data/docs/WorkflowApi.md +436 -0
- data/docs/WorkflowAttachment.md +12 -0
- data/docs/WorkflowAttachmentUploadUrl.md +9 -0
- data/docs/WorkflowAttachmentUploadUrlResponse.md +12 -0
- data/docs/WorkflowGroup.md +9 -0
- data/docs/WorkflowGroupsResponse.md +12 -0
- data/docs/WorkflowNote.md +13 -0
- data/docs/WorkflowTask.md +29 -0
- data/docs/WorkflowTaskHistory.md +11 -0
- data/docs/WorkflowTaskResponse.md +12 -0
- data/docs/WorkflowTasksRequest.md +23 -0
- data/docs/WorkflowTasksResponse.md +12 -0
- data/docs/WorkflowUser.md +10 -0
- data/docs/WorkflowUsersResponse.md +12 -0
- data/lib/ultracart_api/api/conversation_api.rb +4 -4
- data/lib/ultracart_api/api/workflow_api.rb +497 -0
- data/lib/ultracart_api/models/workflow_attachment.rb +225 -0
- data/lib/ultracart_api/models/workflow_attachment_upload_url.rb +193 -0
- data/lib/ultracart_api/models/workflow_attachment_upload_url_response.rb +221 -0
- data/lib/ultracart_api/models/workflow_group.rb +195 -0
- data/lib/ultracart_api/models/workflow_groups_response.rb +224 -0
- data/lib/ultracart_api/models/workflow_note.rb +236 -0
- data/lib/ultracart_api/models/workflow_task.rb +458 -0
- data/lib/ultracart_api/models/workflow_task_history.rb +214 -0
- data/lib/ultracart_api/models/workflow_task_response.rb +221 -0
- data/lib/ultracart_api/models/workflow_tasks_request.rb +392 -0
- data/lib/ultracart_api/models/workflow_tasks_response.rb +224 -0
- data/lib/ultracart_api/models/workflow_user.rb +205 -0
- data/lib/ultracart_api/models/workflow_users_response.rb +224 -0
- data/lib/ultracart_api/version.rb +1 -1
- data/lib/ultracart_api.rb +14 -0
- metadata +30 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 7e356c6b6d5cca18c2446d11738ddb8261f01cafec6dc402bf730754eff97636
|
4
|
+
data.tar.gz: 5d8739254538f67793bdf0a705a61a544cb802f8e3e7f61294a8b3e1cf6c8769
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 7eb7757469f28d0f0c6dc6edcf86f4bd991fdfbf188c4ebe3341dd4bbf0139c14411d8d41d14868a23716788bf9a3734d6b591933b7e87f87469742b0d446fa9
|
7
|
+
data.tar.gz: 367f1f9800e19b7829b1ef19f1112a1750504090c4fe04ff403d4b748dd642a66cdb2143c03eb270f632ba94532a6cb6be00424382a5d63e8313937467613130
|
data/README.md
CHANGED
@@ -7,7 +7,7 @@ UltraCart REST API Version 2
|
|
7
7
|
This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
|
8
8
|
|
9
9
|
- API version: 2.0.0
|
10
|
-
- Package version: 3.10.
|
10
|
+
- Package version: 3.10.165
|
11
11
|
- Build package: io.swagger.codegen.languages.RubyClientCodegen
|
12
12
|
For more information, please visit [http://www.ultracart.com](http://www.ultracart.com)
|
13
13
|
|
@@ -24,15 +24,15 @@ gem build ultracart_api.gemspec
|
|
24
24
|
Then either install the gem locally:
|
25
25
|
|
26
26
|
```shell
|
27
|
-
gem install ./ultracart_api-3.10.
|
27
|
+
gem install ./ultracart_api-3.10.165.gem
|
28
28
|
```
|
29
|
-
(for development, run `gem install --dev ./ultracart_api-3.10.
|
29
|
+
(for development, run `gem install --dev ./ultracart_api-3.10.165.gem` to install the development dependencies)
|
30
30
|
|
31
31
|
or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
|
32
32
|
|
33
33
|
Finally add this to the Gemfile:
|
34
34
|
|
35
|
-
gem 'ultracart_api', '~> 3.10.
|
35
|
+
gem 'ultracart_api', '~> 3.10.165'
|
36
36
|
|
37
37
|
### Install from Git
|
38
38
|
|
@@ -146,7 +146,7 @@ Class | Method | HTTP request | Description
|
|
146
146
|
*UltracartClient::ConversationApi* | [**get_conversation_engagement**](docs/ConversationApi.md#get_conversation_engagement) | **GET** /conversation/engagements/{conversation_engagement_oid} | Retrieve an engagement
|
147
147
|
*UltracartClient::ConversationApi* | [**get_conversation_engagements**](docs/ConversationApi.md#get_conversation_engagements) | **GET** /conversation/engagements | Retrieve a list of engagements ordered by name
|
148
148
|
*UltracartClient::ConversationApi* | [**get_conversation_messages**](docs/ConversationApi.md#get_conversation_messages) | **GET** /conversation/conversations/{conversation_uuid}/messages/{since} | Retrieve conversation messages
|
149
|
-
*UltracartClient::ConversationApi* | [**get_conversation_multimedia_upload_url**](docs/ConversationApi.md#get_conversation_multimedia_upload_url) | **GET** /conversation/upload_url/{extension} | Get a presigned
|
149
|
+
*UltracartClient::ConversationApi* | [**get_conversation_multimedia_upload_url**](docs/ConversationApi.md#get_conversation_multimedia_upload_url) | **GET** /conversation/upload_url/{extension} | Get a presigned conversation multimedia upload URL
|
150
150
|
*UltracartClient::ConversationApi* | [**get_conversation_permissions**](docs/ConversationApi.md#get_conversation_permissions) | **GET** /conversation/permissions | Retrieve conversation permissions
|
151
151
|
*UltracartClient::ConversationApi* | [**get_conversation_webchat_queue_statuses**](docs/ConversationApi.md#get_conversation_webchat_queue_statuses) | **GET** /conversation/conversations/queues/statuses | Retrieve a conversation webchat queue statuses
|
152
152
|
*UltracartClient::ConversationApi* | [**get_conversations**](docs/ConversationApi.md#get_conversations) | **GET** /conversation/conversations | Retrieve a list of conversation summaries newest to oldest
|
@@ -507,6 +507,14 @@ Class | Method | HTTP request | Description
|
|
507
507
|
*UltracartClient::WebhookApi* | [**insert_webhook**](docs/WebhookApi.md#insert_webhook) | **POST** /webhook/webhooks | Add a webhook
|
508
508
|
*UltracartClient::WebhookApi* | [**resend_event**](docs/WebhookApi.md#resend_event) | **POST** /webhook/webhooks/{webhookOid}/reflow/{eventName} | Resend events to the webhook endpoint.
|
509
509
|
*UltracartClient::WebhookApi* | [**update_webhook**](docs/WebhookApi.md#update_webhook) | **PUT** /webhook/webhooks/{webhookOid} | Update a webhook
|
510
|
+
*UltracartClient::WorkflowApi* | [**get_workflow_assignment_groups**](docs/WorkflowApi.md#get_workflow_assignment_groups) | **GET** /workflow/assignment_groups | Retrieve a list of groups that workflow tasks can be assigned to
|
511
|
+
*UltracartClient::WorkflowApi* | [**get_workflow_assignment_users**](docs/WorkflowApi.md#get_workflow_assignment_users) | **GET** /workflow/assignment_users | Retrieve a list of users that workflow tasks can be assigned to
|
512
|
+
*UltracartClient::WorkflowApi* | [**get_workflow_task**](docs/WorkflowApi.md#get_workflow_task) | **GET** /workflow/tasks/{task_uuid} | Retrieve a workflow task
|
513
|
+
*UltracartClient::WorkflowApi* | [**get_workflow_task_attachment_upload_url**](docs/WorkflowApi.md#get_workflow_task_attachment_upload_url) | **GET** /workflow/tasks/attachments/{extension} | Get a presigned workflow task attachment upload URL
|
514
|
+
*UltracartClient::WorkflowApi* | [**get_workflow_task_by_object_type**](docs/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
|
515
|
+
*UltracartClient::WorkflowApi* | [**get_workflow_tasks**](docs/WorkflowApi.md#get_workflow_tasks) | **POST** /workflow/tasks/search | Search workflow tasks
|
516
|
+
*UltracartClient::WorkflowApi* | [**insert_workflow_task**](docs/WorkflowApi.md#insert_workflow_task) | **POST** /workflow/tasks | Insert a workflow task
|
517
|
+
*UltracartClient::WorkflowApi* | [**update_workflow_task**](docs/WorkflowApi.md#update_workflow_task) | **PUT** /workflow/tasks/{task_uuid} | Update a workflow task
|
510
518
|
|
511
519
|
|
512
520
|
## Documentation for Models
|
@@ -1293,6 +1301,19 @@ Class | Method | HTTP request | Description
|
|
1293
1301
|
- [UltracartClient::WebhookSampleRequestResponse](docs/WebhookSampleRequestResponse.md)
|
1294
1302
|
- [UltracartClient::WebhooksResponse](docs/WebhooksResponse.md)
|
1295
1303
|
- [UltracartClient::Weight](docs/Weight.md)
|
1304
|
+
- [UltracartClient::WorkflowAttachment](docs/WorkflowAttachment.md)
|
1305
|
+
- [UltracartClient::WorkflowAttachmentUploadUrl](docs/WorkflowAttachmentUploadUrl.md)
|
1306
|
+
- [UltracartClient::WorkflowAttachmentUploadUrlResponse](docs/WorkflowAttachmentUploadUrlResponse.md)
|
1307
|
+
- [UltracartClient::WorkflowGroup](docs/WorkflowGroup.md)
|
1308
|
+
- [UltracartClient::WorkflowGroupsResponse](docs/WorkflowGroupsResponse.md)
|
1309
|
+
- [UltracartClient::WorkflowNote](docs/WorkflowNote.md)
|
1310
|
+
- [UltracartClient::WorkflowTask](docs/WorkflowTask.md)
|
1311
|
+
- [UltracartClient::WorkflowTaskHistory](docs/WorkflowTaskHistory.md)
|
1312
|
+
- [UltracartClient::WorkflowTaskResponse](docs/WorkflowTaskResponse.md)
|
1313
|
+
- [UltracartClient::WorkflowTasksRequest](docs/WorkflowTasksRequest.md)
|
1314
|
+
- [UltracartClient::WorkflowTasksResponse](docs/WorkflowTasksResponse.md)
|
1315
|
+
- [UltracartClient::WorkflowUser](docs/WorkflowUser.md)
|
1316
|
+
- [UltracartClient::WorkflowUsersResponse](docs/WorkflowUsersResponse.md)
|
1296
1317
|
|
1297
1318
|
|
1298
1319
|
## Documentation for Authorization
|
@@ -1348,6 +1369,8 @@ Class | Method | HTTP request | Description
|
|
1348
1369
|
- ultrabooks_write: 2 of 2 required to use UltraBooks
|
1349
1370
|
- user_read: Allows you to read user information.
|
1350
1371
|
- user_write: Allows you to write user information.
|
1372
|
+
- workflow_read: Allows you to read workflow information.
|
1373
|
+
- workflow_write: Allows you to write workflow information.
|
1351
1374
|
|
1352
1375
|
### ultraCartSimpleApiKey
|
1353
1376
|
|
@@ -1363,6 +1386,8 @@ Not every change is committed to every SDK.
|
|
1363
1386
|
|
1364
1387
|
| Version | Date | Comments |
|
1365
1388
|
| --: | :-: | --- |
|
1389
|
+
| 3.10.165 | 10/23/2023 | workflow tasks api |
|
1390
|
+
| 3.10.164 | 10/23/2023 | workflow tasks api |
|
1366
1391
|
| 3.10.163 | 10/16/2023 | CartSettingsPaymentCreditCard - add collect_credit_card_verification_number_minimum |
|
1367
1392
|
| 3.10.162 | 09/28/2023 | dw bi - add aggregation constant of none |
|
1368
1393
|
| 3.10.161 | 09/22/2023 | dwbi - new option to control order-by of result set |
|
data/docs/ConversationApi.md
CHANGED
@@ -18,7 +18,7 @@ Method | HTTP request | Description
|
|
18
18
|
[**get_conversation_engagement**](ConversationApi.md#get_conversation_engagement) | **GET** /conversation/engagements/{conversation_engagement_oid} | Retrieve an engagement
|
19
19
|
[**get_conversation_engagements**](ConversationApi.md#get_conversation_engagements) | **GET** /conversation/engagements | Retrieve a list of engagements ordered by name
|
20
20
|
[**get_conversation_messages**](ConversationApi.md#get_conversation_messages) | **GET** /conversation/conversations/{conversation_uuid}/messages/{since} | Retrieve conversation messages
|
21
|
-
[**get_conversation_multimedia_upload_url**](ConversationApi.md#get_conversation_multimedia_upload_url) | **GET** /conversation/upload_url/{extension} | Get a presigned
|
21
|
+
[**get_conversation_multimedia_upload_url**](ConversationApi.md#get_conversation_multimedia_upload_url) | **GET** /conversation/upload_url/{extension} | Get a presigned conversation multimedia upload URL
|
22
22
|
[**get_conversation_permissions**](ConversationApi.md#get_conversation_permissions) | **GET** /conversation/permissions | Retrieve conversation permissions
|
23
23
|
[**get_conversation_webchat_queue_statuses**](ConversationApi.md#get_conversation_webchat_queue_statuses) | **GET** /conversation/conversations/queues/statuses | Retrieve a conversation webchat queue statuses
|
24
24
|
[**get_conversations**](ConversationApi.md#get_conversations) | **GET** /conversation/conversations | Retrieve a list of conversation summaries newest to oldest
|
@@ -716,9 +716,9 @@ Name | Type | Description | Notes
|
|
716
716
|
# **get_conversation_multimedia_upload_url**
|
717
717
|
> ConversationMultimediaUploadUrlResponse get_conversation_multimedia_upload_url(extension)
|
718
718
|
|
719
|
-
Get a presigned
|
719
|
+
Get a presigned conversation multimedia upload URL
|
720
720
|
|
721
|
-
Get a presigned
|
721
|
+
Get a presigned conversation multimedia upload URL
|
722
722
|
|
723
723
|
### Example
|
724
724
|
```ruby
|
@@ -734,7 +734,7 @@ extension = 'extension_example' # String |
|
|
734
734
|
|
735
735
|
|
736
736
|
begin
|
737
|
-
#Get a presigned
|
737
|
+
#Get a presigned conversation multimedia upload URL
|
738
738
|
result = api_instance.get_conversation_multimedia_upload_url(extension)
|
739
739
|
p result
|
740
740
|
rescue UltracartClient::ApiError => e
|
data/docs/WorkflowApi.md
ADDED
@@ -0,0 +1,436 @@
|
|
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_assignment_groups**](WorkflowApi.md#get_workflow_assignment_groups) | **GET** /workflow/assignment_groups | Retrieve a list of groups that workflow tasks can be assigned to
|
8
|
+
[**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
|
9
|
+
[**get_workflow_task**](WorkflowApi.md#get_workflow_task) | **GET** /workflow/tasks/{task_uuid} | Retrieve a workflow task
|
10
|
+
[**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
|
11
|
+
[**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
|
12
|
+
[**get_workflow_tasks**](WorkflowApi.md#get_workflow_tasks) | **POST** /workflow/tasks/search | Search workflow tasks
|
13
|
+
[**insert_workflow_task**](WorkflowApi.md#insert_workflow_task) | **POST** /workflow/tasks | Insert a workflow task
|
14
|
+
[**update_workflow_task**](WorkflowApi.md#update_workflow_task) | **PUT** /workflow/tasks/{task_uuid} | Update a workflow task
|
15
|
+
|
16
|
+
|
17
|
+
# **get_workflow_assignment_groups**
|
18
|
+
> WorkflowGroupsResponse get_workflow_assignment_groups(opts)
|
19
|
+
|
20
|
+
Retrieve a list of groups that workflow tasks can be assigned to
|
21
|
+
|
22
|
+
Retrieve a list of groups that workflow tasks can be assigned to
|
23
|
+
|
24
|
+
### Example
|
25
|
+
```ruby
|
26
|
+
# load the gem
|
27
|
+
require 'ultracart_api'
|
28
|
+
|
29
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
30
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
31
|
+
api_instance = UltracartClient::WorkflowApi.new_using_api_key(simple_key, false, false)
|
32
|
+
|
33
|
+
|
34
|
+
opts = {
|
35
|
+
_limit: 100, # Integer | The maximum number of records to return on this one API call. (Max 200)
|
36
|
+
_offset: 0 # Integer | Pagination of the record set. Offset is a zero based index.
|
37
|
+
}
|
38
|
+
|
39
|
+
begin
|
40
|
+
#Retrieve a list of groups that workflow tasks can be assigned to
|
41
|
+
result = api_instance.get_workflow_assignment_groups(opts)
|
42
|
+
p result
|
43
|
+
rescue UltracartClient::ApiError => e
|
44
|
+
puts "Exception when calling WorkflowApi->get_workflow_assignment_groups: #{e}"
|
45
|
+
end
|
46
|
+
```
|
47
|
+
|
48
|
+
### Parameters
|
49
|
+
|
50
|
+
Name | Type | Description | Notes
|
51
|
+
------------- | ------------- | ------------- | -------------
|
52
|
+
**_limit** | **Integer**| The maximum number of records to return on this one API call. (Max 200) | [optional] [default to 100]
|
53
|
+
**_offset** | **Integer**| Pagination of the record set. Offset is a zero based index. | [optional] [default to 0]
|
54
|
+
|
55
|
+
### Return type
|
56
|
+
|
57
|
+
[**WorkflowGroupsResponse**](WorkflowGroupsResponse.md)
|
58
|
+
|
59
|
+
### Authorization
|
60
|
+
|
61
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
62
|
+
|
63
|
+
### HTTP request headers
|
64
|
+
|
65
|
+
- **Content-Type**: application/json
|
66
|
+
- **Accept**: application/json
|
67
|
+
|
68
|
+
|
69
|
+
|
70
|
+
# **get_workflow_assignment_users**
|
71
|
+
> WorkflowUsersResponse get_workflow_assignment_users(opts)
|
72
|
+
|
73
|
+
Retrieve a list of users that workflow tasks can be assigned to
|
74
|
+
|
75
|
+
Retrieve a list of users that workflow tasks can be assigned to
|
76
|
+
|
77
|
+
### Example
|
78
|
+
```ruby
|
79
|
+
# load the gem
|
80
|
+
require 'ultracart_api'
|
81
|
+
|
82
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
83
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
84
|
+
api_instance = UltracartClient::WorkflowApi.new_using_api_key(simple_key, false, false)
|
85
|
+
|
86
|
+
|
87
|
+
opts = {
|
88
|
+
_limit: 100, # Integer | The maximum number of records to return on this one API call. (Max 200)
|
89
|
+
_offset: 0 # Integer | Pagination of the record set. Offset is a zero based index.
|
90
|
+
}
|
91
|
+
|
92
|
+
begin
|
93
|
+
#Retrieve a list of users that workflow tasks can be assigned to
|
94
|
+
result = api_instance.get_workflow_assignment_users(opts)
|
95
|
+
p result
|
96
|
+
rescue UltracartClient::ApiError => e
|
97
|
+
puts "Exception when calling WorkflowApi->get_workflow_assignment_users: #{e}"
|
98
|
+
end
|
99
|
+
```
|
100
|
+
|
101
|
+
### Parameters
|
102
|
+
|
103
|
+
Name | Type | Description | Notes
|
104
|
+
------------- | ------------- | ------------- | -------------
|
105
|
+
**_limit** | **Integer**| The maximum number of records to return on this one API call. (Max 200) | [optional] [default to 100]
|
106
|
+
**_offset** | **Integer**| Pagination of the record set. Offset is a zero based index. | [optional] [default to 0]
|
107
|
+
|
108
|
+
### Return type
|
109
|
+
|
110
|
+
[**WorkflowUsersResponse**](WorkflowUsersResponse.md)
|
111
|
+
|
112
|
+
### Authorization
|
113
|
+
|
114
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
115
|
+
|
116
|
+
### HTTP request headers
|
117
|
+
|
118
|
+
- **Content-Type**: application/json
|
119
|
+
- **Accept**: application/json
|
120
|
+
|
121
|
+
|
122
|
+
|
123
|
+
# **get_workflow_task**
|
124
|
+
> WorkflowTaskResponse get_workflow_task(task_uuid)
|
125
|
+
|
126
|
+
Retrieve a workflow task
|
127
|
+
|
128
|
+
Retrieve a workflow task
|
129
|
+
|
130
|
+
### Example
|
131
|
+
```ruby
|
132
|
+
# load the gem
|
133
|
+
require 'ultracart_api'
|
134
|
+
|
135
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
136
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
137
|
+
api_instance = UltracartClient::WorkflowApi.new_using_api_key(simple_key, false, false)
|
138
|
+
|
139
|
+
|
140
|
+
task_uuid = 'task_uuid_example' # String |
|
141
|
+
|
142
|
+
|
143
|
+
begin
|
144
|
+
#Retrieve a workflow task
|
145
|
+
result = api_instance.get_workflow_task(task_uuid)
|
146
|
+
p result
|
147
|
+
rescue UltracartClient::ApiError => e
|
148
|
+
puts "Exception when calling WorkflowApi->get_workflow_task: #{e}"
|
149
|
+
end
|
150
|
+
```
|
151
|
+
|
152
|
+
### Parameters
|
153
|
+
|
154
|
+
Name | Type | Description | Notes
|
155
|
+
------------- | ------------- | ------------- | -------------
|
156
|
+
**task_uuid** | **String**| |
|
157
|
+
|
158
|
+
### Return type
|
159
|
+
|
160
|
+
[**WorkflowTaskResponse**](WorkflowTaskResponse.md)
|
161
|
+
|
162
|
+
### Authorization
|
163
|
+
|
164
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
165
|
+
|
166
|
+
### HTTP request headers
|
167
|
+
|
168
|
+
- **Content-Type**: application/json
|
169
|
+
- **Accept**: application/json
|
170
|
+
|
171
|
+
|
172
|
+
|
173
|
+
# **get_workflow_task_attachment_upload_url**
|
174
|
+
> WorkflowAttachmentUploadUrlResponse get_workflow_task_attachment_upload_url(extension)
|
175
|
+
|
176
|
+
Get a presigned workflow task attachment upload URL
|
177
|
+
|
178
|
+
Get a presigned workflow task attachment upload URL
|
179
|
+
|
180
|
+
### Example
|
181
|
+
```ruby
|
182
|
+
# load the gem
|
183
|
+
require 'ultracart_api'
|
184
|
+
|
185
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
186
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
187
|
+
api_instance = UltracartClient::WorkflowApi.new_using_api_key(simple_key, false, false)
|
188
|
+
|
189
|
+
|
190
|
+
extension = 'extension_example' # String |
|
191
|
+
|
192
|
+
|
193
|
+
begin
|
194
|
+
#Get a presigned workflow task attachment upload URL
|
195
|
+
result = api_instance.get_workflow_task_attachment_upload_url(extension)
|
196
|
+
p result
|
197
|
+
rescue UltracartClient::ApiError => e
|
198
|
+
puts "Exception when calling WorkflowApi->get_workflow_task_attachment_upload_url: #{e}"
|
199
|
+
end
|
200
|
+
```
|
201
|
+
|
202
|
+
### Parameters
|
203
|
+
|
204
|
+
Name | Type | Description | Notes
|
205
|
+
------------- | ------------- | ------------- | -------------
|
206
|
+
**extension** | **String**| |
|
207
|
+
|
208
|
+
### Return type
|
209
|
+
|
210
|
+
[**WorkflowAttachmentUploadUrlResponse**](WorkflowAttachmentUploadUrlResponse.md)
|
211
|
+
|
212
|
+
### Authorization
|
213
|
+
|
214
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
215
|
+
|
216
|
+
### HTTP request headers
|
217
|
+
|
218
|
+
- **Content-Type**: application/json
|
219
|
+
- **Accept**: application/json
|
220
|
+
|
221
|
+
|
222
|
+
|
223
|
+
# **get_workflow_task_by_object_type**
|
224
|
+
> WorkflowTaskResponse get_workflow_task_by_object_type(object_type, object_id)
|
225
|
+
|
226
|
+
Retrieve a workflow task by object type and id
|
227
|
+
|
228
|
+
Retrieve a workflow task by object type and id
|
229
|
+
|
230
|
+
### Example
|
231
|
+
```ruby
|
232
|
+
# load the gem
|
233
|
+
require 'ultracart_api'
|
234
|
+
|
235
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
236
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
237
|
+
api_instance = UltracartClient::WorkflowApi.new_using_api_key(simple_key, false, false)
|
238
|
+
|
239
|
+
|
240
|
+
object_type = 'object_type_example' # String |
|
241
|
+
|
242
|
+
object_id = 'object_id_example' # String |
|
243
|
+
|
244
|
+
|
245
|
+
begin
|
246
|
+
#Retrieve a workflow task by object type and id
|
247
|
+
result = api_instance.get_workflow_task_by_object_type(object_type, object_id)
|
248
|
+
p result
|
249
|
+
rescue UltracartClient::ApiError => e
|
250
|
+
puts "Exception when calling WorkflowApi->get_workflow_task_by_object_type: #{e}"
|
251
|
+
end
|
252
|
+
```
|
253
|
+
|
254
|
+
### Parameters
|
255
|
+
|
256
|
+
Name | Type | Description | Notes
|
257
|
+
------------- | ------------- | ------------- | -------------
|
258
|
+
**object_type** | **String**| |
|
259
|
+
**object_id** | **String**| |
|
260
|
+
|
261
|
+
### Return type
|
262
|
+
|
263
|
+
[**WorkflowTaskResponse**](WorkflowTaskResponse.md)
|
264
|
+
|
265
|
+
### Authorization
|
266
|
+
|
267
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
268
|
+
|
269
|
+
### HTTP request headers
|
270
|
+
|
271
|
+
- **Content-Type**: application/json
|
272
|
+
- **Accept**: application/json
|
273
|
+
|
274
|
+
|
275
|
+
|
276
|
+
# **get_workflow_tasks**
|
277
|
+
> WorkflowTasksResponse get_workflow_tasks(workflow_tasks_query, opts)
|
278
|
+
|
279
|
+
Search workflow tasks
|
280
|
+
|
281
|
+
Retrieves a set of workflow tasks from the account based on a query object.
|
282
|
+
|
283
|
+
### Example
|
284
|
+
```ruby
|
285
|
+
# load the gem
|
286
|
+
require 'ultracart_api'
|
287
|
+
|
288
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
289
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
290
|
+
api_instance = UltracartClient::WorkflowApi.new_using_api_key(simple_key, false, false)
|
291
|
+
|
292
|
+
|
293
|
+
workflow_tasks_query = UltracartClient::WorkflowTasksRequest.new # WorkflowTasksRequest | Workflow tasks query
|
294
|
+
|
295
|
+
opts = {
|
296
|
+
_limit: 100, # Integer | The maximum number of records to return on this one API call. (Default 100, Max 500)
|
297
|
+
_offset: 0, # Integer | Pagination of the record set. Offset is a zero based index.
|
298
|
+
_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.
|
299
|
+
}
|
300
|
+
|
301
|
+
begin
|
302
|
+
#Search workflow tasks
|
303
|
+
result = api_instance.get_workflow_tasks(workflow_tasks_query, opts)
|
304
|
+
p result
|
305
|
+
rescue UltracartClient::ApiError => e
|
306
|
+
puts "Exception when calling WorkflowApi->get_workflow_tasks: #{e}"
|
307
|
+
end
|
308
|
+
```
|
309
|
+
|
310
|
+
### Parameters
|
311
|
+
|
312
|
+
Name | Type | Description | Notes
|
313
|
+
------------- | ------------- | ------------- | -------------
|
314
|
+
**workflow_tasks_query** | [**WorkflowTasksRequest**](WorkflowTasksRequest.md)| Workflow tasks query |
|
315
|
+
**_limit** | **Integer**| The maximum number of records to return on this one API call. (Default 100, Max 500) | [optional] [default to 100]
|
316
|
+
**_offset** | **Integer**| Pagination of the record set. Offset is a zero based index. | [optional] [default to 0]
|
317
|
+
**_sort** | **String**| The sort order of the items. See Sorting documentation for examples of using multiple values and sorting by ascending and descending. | [optional]
|
318
|
+
|
319
|
+
### Return type
|
320
|
+
|
321
|
+
[**WorkflowTasksResponse**](WorkflowTasksResponse.md)
|
322
|
+
|
323
|
+
### Authorization
|
324
|
+
|
325
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
326
|
+
|
327
|
+
### HTTP request headers
|
328
|
+
|
329
|
+
- **Content-Type**: application/json
|
330
|
+
- **Accept**: application/json
|
331
|
+
|
332
|
+
|
333
|
+
|
334
|
+
# **insert_workflow_task**
|
335
|
+
> WorkflowTaskResponse insert_workflow_task(workflow_task)
|
336
|
+
|
337
|
+
Insert a workflow task
|
338
|
+
|
339
|
+
Insert a workflow task
|
340
|
+
|
341
|
+
### Example
|
342
|
+
```ruby
|
343
|
+
# load the gem
|
344
|
+
require 'ultracart_api'
|
345
|
+
|
346
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
347
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
348
|
+
api_instance = UltracartClient::WorkflowApi.new_using_api_key(simple_key, false, false)
|
349
|
+
|
350
|
+
|
351
|
+
workflow_task = UltracartClient::WorkflowTask.new # WorkflowTask | workflow task
|
352
|
+
|
353
|
+
|
354
|
+
begin
|
355
|
+
#Insert a workflow task
|
356
|
+
result = api_instance.insert_workflow_task(workflow_task)
|
357
|
+
p result
|
358
|
+
rescue UltracartClient::ApiError => e
|
359
|
+
puts "Exception when calling WorkflowApi->insert_workflow_task: #{e}"
|
360
|
+
end
|
361
|
+
```
|
362
|
+
|
363
|
+
### Parameters
|
364
|
+
|
365
|
+
Name | Type | Description | Notes
|
366
|
+
------------- | ------------- | ------------- | -------------
|
367
|
+
**workflow_task** | [**WorkflowTask**](WorkflowTask.md)| workflow task |
|
368
|
+
|
369
|
+
### Return type
|
370
|
+
|
371
|
+
[**WorkflowTaskResponse**](WorkflowTaskResponse.md)
|
372
|
+
|
373
|
+
### Authorization
|
374
|
+
|
375
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
376
|
+
|
377
|
+
### HTTP request headers
|
378
|
+
|
379
|
+
- **Content-Type**: application/json
|
380
|
+
- **Accept**: application/json
|
381
|
+
|
382
|
+
|
383
|
+
|
384
|
+
# **update_workflow_task**
|
385
|
+
> WorkflowTaskResponse update_workflow_task(task_uuid, workflow_task)
|
386
|
+
|
387
|
+
Update a workflow task
|
388
|
+
|
389
|
+
Update a workflow task
|
390
|
+
|
391
|
+
### Example
|
392
|
+
```ruby
|
393
|
+
# load the gem
|
394
|
+
require 'ultracart_api'
|
395
|
+
|
396
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
397
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
398
|
+
api_instance = UltracartClient::WorkflowApi.new_using_api_key(simple_key, false, false)
|
399
|
+
|
400
|
+
|
401
|
+
task_uuid = 'task_uuid_example' # String |
|
402
|
+
|
403
|
+
workflow_task = UltracartClient::WorkflowTask.new # WorkflowTask | Workflow task
|
404
|
+
|
405
|
+
|
406
|
+
begin
|
407
|
+
#Update a workflow task
|
408
|
+
result = api_instance.update_workflow_task(task_uuid, workflow_task)
|
409
|
+
p result
|
410
|
+
rescue UltracartClient::ApiError => e
|
411
|
+
puts "Exception when calling WorkflowApi->update_workflow_task: #{e}"
|
412
|
+
end
|
413
|
+
```
|
414
|
+
|
415
|
+
### Parameters
|
416
|
+
|
417
|
+
Name | Type | Description | Notes
|
418
|
+
------------- | ------------- | ------------- | -------------
|
419
|
+
**task_uuid** | **String**| |
|
420
|
+
**workflow_task** | [**WorkflowTask**](WorkflowTask.md)| Workflow task |
|
421
|
+
|
422
|
+
### Return type
|
423
|
+
|
424
|
+
[**WorkflowTaskResponse**](WorkflowTaskResponse.md)
|
425
|
+
|
426
|
+
### Authorization
|
427
|
+
|
428
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
429
|
+
|
430
|
+
### HTTP request headers
|
431
|
+
|
432
|
+
- **Content-Type**: application/json
|
433
|
+
- **Accept**: application/json
|
434
|
+
|
435
|
+
|
436
|
+
|
@@ -0,0 +1,12 @@
|
|
1
|
+
# UltracartClient::WorkflowAttachment
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**download_key** | **String** | Temporary download URL | [optional]
|
7
|
+
**file_name** | **String** | File name | [optional]
|
8
|
+
**file_uuid** | **String** | File UUID | [optional]
|
9
|
+
**mime_type** | **String** | Mime Type | [optional]
|
10
|
+
**upload_key** | **String** | Temporary upload key | [optional]
|
11
|
+
|
12
|
+
|
@@ -0,0 +1,12 @@
|
|
1
|
+
# UltracartClient::WorkflowAttachmentUploadUrlResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**error** | [**Error**](Error.md) | | [optional]
|
7
|
+
**metadata** | [**ResponseMetadata**](ResponseMetadata.md) | | [optional]
|
8
|
+
**success** | **BOOLEAN** | Indicates if API call was successful | [optional]
|
9
|
+
**warning** | [**Warning**](Warning.md) | | [optional]
|
10
|
+
**workflow_attachment_upload_url** | [**WorkflowAttachmentUploadUrl**](WorkflowAttachmentUploadUrl.md) | | [optional]
|
11
|
+
|
12
|
+
|
@@ -0,0 +1,12 @@
|
|
1
|
+
# UltracartClient::WorkflowGroupsResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**error** | [**Error**](Error.md) | | [optional]
|
7
|
+
**groups** | [**Array<WorkflowGroup>**](WorkflowGroup.md) | groups | [optional]
|
8
|
+
**metadata** | [**ResponseMetadata**](ResponseMetadata.md) | | [optional]
|
9
|
+
**success** | **BOOLEAN** | Indicates if API call was successful | [optional]
|
10
|
+
**warning** | [**Warning**](Warning.md) | | [optional]
|
11
|
+
|
12
|
+
|
@@ -0,0 +1,13 @@
|
|
1
|
+
# UltracartClient::WorkflowNote
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**attachments** | [**Array<WorkflowAttachment>**](WorkflowAttachment.md) | Attachments to the Workflow Task | [optional]
|
7
|
+
**edit_dts** | **String** | Date/time that the note was edited | [optional]
|
8
|
+
**note** | **String** | Note | [optional]
|
9
|
+
**note_dts** | **String** | Date/time that the note was written | [optional]
|
10
|
+
**original_note** | **String** | Note originally written before any edits | [optional]
|
11
|
+
**user** | [**WorkflowUser**](WorkflowUser.md) | | [optional]
|
12
|
+
|
13
|
+
|
@@ -0,0 +1,29 @@
|
|
1
|
+
# UltracartClient::WorkflowTask
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**assigned_to_group** | **String** | Assigned to group | [optional]
|
7
|
+
**assigned_to_group_id** | **Integer** | Assigned to group ID | [optional]
|
8
|
+
**assigned_to_user** | **String** | Assigned to user | [optional]
|
9
|
+
**assigned_to_user_id** | **Integer** | Assigned to user ID | [optional]
|
10
|
+
**attachments** | [**Array<WorkflowAttachment>**](WorkflowAttachment.md) | Attachments to the Workflow Task | [optional]
|
11
|
+
**created_by** | [**WorkflowUser**](WorkflowUser.md) | | [optional]
|
12
|
+
**created_dts** | **String** | Date/time that the workflow task was created | [optional]
|
13
|
+
**delay_until_dts** | **String** | Date/time that the workflow task should delay until | [optional]
|
14
|
+
**due_dts** | **String** | Date/time that the workflow task is due | [optional]
|
15
|
+
**histories** | [**Array<WorkflowTaskHistory>**](WorkflowTaskHistory.md) | Array of history records for the task | [optional]
|
16
|
+
**last_update_dts** | **String** | Date/time that the workflow task was last updated | [optional]
|
17
|
+
**merchant_id** | **String** | Merchant ID | [optional]
|
18
|
+
**notes** | [**Array<WorkflowNote>**](WorkflowNote.md) | Notes on the Workflow Task | [optional]
|
19
|
+
**object_email** | **String** | Object is associated with customer email | [optional]
|
20
|
+
**object_id** | **String** | Object ID | [optional]
|
21
|
+
**object_type** | **String** | Object Type | [optional]
|
22
|
+
**object_url** | **String** | Object URL | [optional]
|
23
|
+
**priority** | **String** | Priority | [optional]
|
24
|
+
**status** | **String** | Status of the workflow task | [optional]
|
25
|
+
**task_details** | **String** | Task Details | [optional]
|
26
|
+
**task_name** | **String** | Task Name | [optional]
|
27
|
+
**workflow_task_uuid** | **String** | Workflow Task UUID | [optional]
|
28
|
+
|
29
|
+
|