ultracart_api 4.0.181 → 4.0.182
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +26 -4
- data/docs/WorkflowApi.md +603 -0
- data/docs/WorkflowAttachment.md +26 -0
- data/docs/WorkflowAttachmentUploadUrl.md +20 -0
- data/docs/WorkflowAttachmentUploadUrlResponse.md +26 -0
- data/docs/WorkflowGroup.md +20 -0
- data/docs/WorkflowGroupsResponse.md +26 -0
- data/docs/WorkflowNote.md +28 -0
- data/docs/WorkflowTask.md +60 -0
- data/docs/WorkflowTaskHistory.md +24 -0
- data/docs/WorkflowTaskResponse.md +26 -0
- data/docs/WorkflowTasksRequest.md +48 -0
- data/docs/WorkflowTasksResponse.md +26 -0
- data/docs/WorkflowUser.md +22 -0
- data/docs/WorkflowUsersResponse.md +26 -0
- data/lib/ultracart_api/api/workflow_api.rb +583 -0
- data/lib/ultracart_api/models/workflow_attachment.rb +260 -0
- data/lib/ultracart_api/models/workflow_attachment_upload_url.rb +228 -0
- data/lib/ultracart_api/models/workflow_attachment_upload_url_response.rb +256 -0
- data/lib/ultracart_api/models/workflow_group.rb +230 -0
- data/lib/ultracart_api/models/workflow_groups_response.rb +259 -0
- data/lib/ultracart_api/models/workflow_note.rb +271 -0
- data/lib/ultracart_api/models/workflow_task.rb +493 -0
- data/lib/ultracart_api/models/workflow_task_history.rb +249 -0
- data/lib/ultracart_api/models/workflow_task_response.rb +256 -0
- data/lib/ultracart_api/models/workflow_tasks_request.rb +427 -0
- data/lib/ultracart_api/models/workflow_tasks_response.rb +259 -0
- data/lib/ultracart_api/models/workflow_user.rb +240 -0
- data/lib/ultracart_api/models/workflow_users_response.rb +259 -0
- data/lib/ultracart_api/version.rb +1 -1
- data/lib/ultracart_api.rb +14 -0
- metadata +29 -1
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 91197ce8d33447d32ca5c417cd8040e6dbdac700fd986162dc763d3d90c97dd1
|
4
|
+
data.tar.gz: d155cec55d05a1ad64ce2cd7b610a8cc94efbff1f9ab876077159247a9581dd9
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: a80e75cbc812475fba9847472b0bebf29a584e58721c1845521f1c7bf96ecd68d5a986c0c51b22c17c6f8ad9e7861feb897833d4e8244ec33ed303959c72093e
|
7
|
+
data.tar.gz: 3668dc68fa57b3bcdd3a6481ce72e878e5e0d4928efd5d0eb26ed1e8688b298db89f39cb1347bc7b968ec18e80ba9cdc6bf8c58b87060958034d09ffea34327b
|
data/README.md
CHANGED
@@ -7,7 +7,7 @@ UltraCart REST API Version 2
|
|
7
7
|
This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
8
8
|
|
9
9
|
- API version: 2.0.0
|
10
|
-
- Package version: 4.0.
|
10
|
+
- Package version: 4.0.182
|
11
11
|
- Build package: org.openapitools.codegen.languages.RubyClientCodegen
|
12
12
|
For more information, please visit [http://www.ultracart.com](http://www.ultracart.com)
|
13
13
|
|
@@ -24,16 +24,16 @@ gem build ultracart_api.gemspec
|
|
24
24
|
Then either install the gem locally:
|
25
25
|
|
26
26
|
```shell
|
27
|
-
gem install ./ultracart_api-4.0.
|
27
|
+
gem install ./ultracart_api-4.0.182.gem
|
28
28
|
```
|
29
29
|
|
30
|
-
(for development, run `gem install --dev ./ultracart_api-4.0.
|
30
|
+
(for development, run `gem install --dev ./ultracart_api-4.0.182.gem` to install the development dependencies)
|
31
31
|
|
32
32
|
or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
|
33
33
|
|
34
34
|
Finally add this to the Gemfile:
|
35
35
|
|
36
|
-
gem 'ultracart_api', '~> 4.0.
|
36
|
+
gem 'ultracart_api', '~> 4.0.182'
|
37
37
|
|
38
38
|
### Install from Git
|
39
39
|
|
@@ -513,6 +513,14 @@ Class | Method | HTTP request | Description
|
|
513
513
|
*UltracartClient::WebhookApi* | [**insert_webhook**](docs/WebhookApi.md#insert_webhook) | **POST** /webhook/webhooks | Add a webhook
|
514
514
|
*UltracartClient::WebhookApi* | [**resend_event**](docs/WebhookApi.md#resend_event) | **POST** /webhook/webhooks/{webhookOid}/reflow/{eventName} | Resend events to the webhook endpoint.
|
515
515
|
*UltracartClient::WebhookApi* | [**update_webhook**](docs/WebhookApi.md#update_webhook) | **PUT** /webhook/webhooks/{webhookOid} | Update a webhook
|
516
|
+
*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
|
517
|
+
*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
|
518
|
+
*UltracartClient::WorkflowApi* | [**get_workflow_task**](docs/WorkflowApi.md#get_workflow_task) | **GET** /workflow/tasks/{task_uuid} | Retrieve a workflow task
|
519
|
+
*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
|
520
|
+
*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
|
521
|
+
*UltracartClient::WorkflowApi* | [**get_workflow_tasks**](docs/WorkflowApi.md#get_workflow_tasks) | **POST** /workflow/tasks/search | Search workflow tasks
|
522
|
+
*UltracartClient::WorkflowApi* | [**insert_workflow_task**](docs/WorkflowApi.md#insert_workflow_task) | **POST** /workflow/tasks | Insert a workflow task
|
523
|
+
*UltracartClient::WorkflowApi* | [**update_workflow_task**](docs/WorkflowApi.md#update_workflow_task) | **PUT** /workflow/tasks/{task_uuid} | Update a workflow task
|
516
524
|
|
517
525
|
|
518
526
|
## Documentation for Models
|
@@ -1298,6 +1306,19 @@ Class | Method | HTTP request | Description
|
|
1298
1306
|
- [UltracartClient::WebhookSampleRequestResponse](docs/WebhookSampleRequestResponse.md)
|
1299
1307
|
- [UltracartClient::WebhooksResponse](docs/WebhooksResponse.md)
|
1300
1308
|
- [UltracartClient::Weight](docs/Weight.md)
|
1309
|
+
- [UltracartClient::WorkflowAttachment](docs/WorkflowAttachment.md)
|
1310
|
+
- [UltracartClient::WorkflowAttachmentUploadUrl](docs/WorkflowAttachmentUploadUrl.md)
|
1311
|
+
- [UltracartClient::WorkflowAttachmentUploadUrlResponse](docs/WorkflowAttachmentUploadUrlResponse.md)
|
1312
|
+
- [UltracartClient::WorkflowGroup](docs/WorkflowGroup.md)
|
1313
|
+
- [UltracartClient::WorkflowGroupsResponse](docs/WorkflowGroupsResponse.md)
|
1314
|
+
- [UltracartClient::WorkflowNote](docs/WorkflowNote.md)
|
1315
|
+
- [UltracartClient::WorkflowTask](docs/WorkflowTask.md)
|
1316
|
+
- [UltracartClient::WorkflowTaskHistory](docs/WorkflowTaskHistory.md)
|
1317
|
+
- [UltracartClient::WorkflowTaskResponse](docs/WorkflowTaskResponse.md)
|
1318
|
+
- [UltracartClient::WorkflowTasksRequest](docs/WorkflowTasksRequest.md)
|
1319
|
+
- [UltracartClient::WorkflowTasksResponse](docs/WorkflowTasksResponse.md)
|
1320
|
+
- [UltracartClient::WorkflowUser](docs/WorkflowUser.md)
|
1321
|
+
- [UltracartClient::WorkflowUsersResponse](docs/WorkflowUsersResponse.md)
|
1301
1322
|
|
1302
1323
|
|
1303
1324
|
## Documentation for Authorization
|
@@ -1373,6 +1394,7 @@ Not every change is committed to every SDK.
|
|
1373
1394
|
|
1374
1395
|
| Version | Date | Comments |
|
1375
1396
|
| --: | :-: | --- |
|
1397
|
+
| 4.0.182 | 10/23/2023 | workflow tasks api |
|
1376
1398
|
| 4.0.181 | 10/23/2023 | workflow tasks api |
|
1377
1399
|
| 4.0.180 | 10/16/2023 | CartSettingsPaymentCreditCard - add collect_credit_card_verification_number_minimum |
|
1378
1400
|
| 4.0.179 | 09/28/2023 | dw bi - add aggregation constant of none |
|
data/docs/WorkflowApi.md
ADDED
@@ -0,0 +1,603 @@
|
|
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
|
+
|
19
|
+
> <WorkflowGroupsResponse> get_workflow_assignment_groups(opts)
|
20
|
+
|
21
|
+
Retrieve a list of groups that workflow tasks can be assigned to
|
22
|
+
|
23
|
+
Retrieve a list of groups that workflow tasks can be assigned to
|
24
|
+
|
25
|
+
### Examples
|
26
|
+
|
27
|
+
```ruby
|
28
|
+
require 'time'
|
29
|
+
require 'ultracart_api'
|
30
|
+
require 'json'
|
31
|
+
require 'yaml'
|
32
|
+
require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
|
33
|
+
|
34
|
+
# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
|
35
|
+
# As such, this might not be the best way to use this object.
|
36
|
+
# Please see https://github.com/UltraCart/sdk_samples for working examples.
|
37
|
+
|
38
|
+
api = UltracartClient::WorkflowApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
|
39
|
+
opts = {
|
40
|
+
_limit: 56, # Integer | The maximum number of records to return on this one API call. (Max 200)
|
41
|
+
_offset: 56 # Integer | Pagination of the record set. Offset is a zero based index.
|
42
|
+
}
|
43
|
+
|
44
|
+
begin
|
45
|
+
# Retrieve a list of groups that workflow tasks can be assigned to
|
46
|
+
result = api_instance.get_workflow_assignment_groups(opts)
|
47
|
+
p result
|
48
|
+
rescue UltracartClient::ApiError => e
|
49
|
+
puts "Error when calling WorkflowApi->get_workflow_assignment_groups: #{e}"
|
50
|
+
end
|
51
|
+
```
|
52
|
+
|
53
|
+
#### Using the get_workflow_assignment_groups_with_http_info variant
|
54
|
+
|
55
|
+
This returns an Array which contains the response data, status code and headers.
|
56
|
+
|
57
|
+
> <Array(<WorkflowGroupsResponse>, Integer, Hash)> get_workflow_assignment_groups_with_http_info(opts)
|
58
|
+
|
59
|
+
```ruby
|
60
|
+
begin
|
61
|
+
# Retrieve a list of groups that workflow tasks can be assigned to
|
62
|
+
data, status_code, headers = api_instance.get_workflow_assignment_groups_with_http_info(opts)
|
63
|
+
p status_code # => 2xx
|
64
|
+
p headers # => { ... }
|
65
|
+
p data # => <WorkflowGroupsResponse>
|
66
|
+
rescue UltracartClient::ApiError => e
|
67
|
+
puts "Error when calling WorkflowApi->get_workflow_assignment_groups_with_http_info: #{e}"
|
68
|
+
end
|
69
|
+
```
|
70
|
+
|
71
|
+
### Parameters
|
72
|
+
|
73
|
+
| Name | Type | Description | Notes |
|
74
|
+
| ---- | ---- | ----------- | ----- |
|
75
|
+
| **_limit** | **Integer** | The maximum number of records to return on this one API call. (Max 200) | [optional][default to 100] |
|
76
|
+
| **_offset** | **Integer** | Pagination of the record set. Offset is a zero based index. | [optional][default to 0] |
|
77
|
+
|
78
|
+
### Return type
|
79
|
+
|
80
|
+
[**WorkflowGroupsResponse**](WorkflowGroupsResponse.md)
|
81
|
+
|
82
|
+
### Authorization
|
83
|
+
|
84
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
85
|
+
|
86
|
+
### HTTP request headers
|
87
|
+
|
88
|
+
- **Content-Type**: Not defined
|
89
|
+
- **Accept**: application/json
|
90
|
+
|
91
|
+
|
92
|
+
## get_workflow_assignment_users
|
93
|
+
|
94
|
+
> <WorkflowUsersResponse> get_workflow_assignment_users(opts)
|
95
|
+
|
96
|
+
Retrieve a list of users that workflow tasks can be assigned to
|
97
|
+
|
98
|
+
Retrieve a list of users that workflow tasks can be assigned to
|
99
|
+
|
100
|
+
### Examples
|
101
|
+
|
102
|
+
```ruby
|
103
|
+
require 'time'
|
104
|
+
require 'ultracart_api'
|
105
|
+
require 'json'
|
106
|
+
require 'yaml'
|
107
|
+
require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
|
108
|
+
|
109
|
+
# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
|
110
|
+
# As such, this might not be the best way to use this object.
|
111
|
+
# Please see https://github.com/UltraCart/sdk_samples for working examples.
|
112
|
+
|
113
|
+
api = UltracartClient::WorkflowApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
|
114
|
+
opts = {
|
115
|
+
_limit: 56, # Integer | The maximum number of records to return on this one API call. (Max 200)
|
116
|
+
_offset: 56 # Integer | Pagination of the record set. Offset is a zero based index.
|
117
|
+
}
|
118
|
+
|
119
|
+
begin
|
120
|
+
# Retrieve a list of users that workflow tasks can be assigned to
|
121
|
+
result = api_instance.get_workflow_assignment_users(opts)
|
122
|
+
p result
|
123
|
+
rescue UltracartClient::ApiError => e
|
124
|
+
puts "Error when calling WorkflowApi->get_workflow_assignment_users: #{e}"
|
125
|
+
end
|
126
|
+
```
|
127
|
+
|
128
|
+
#### Using the get_workflow_assignment_users_with_http_info variant
|
129
|
+
|
130
|
+
This returns an Array which contains the response data, status code and headers.
|
131
|
+
|
132
|
+
> <Array(<WorkflowUsersResponse>, Integer, Hash)> get_workflow_assignment_users_with_http_info(opts)
|
133
|
+
|
134
|
+
```ruby
|
135
|
+
begin
|
136
|
+
# Retrieve a list of users that workflow tasks can be assigned to
|
137
|
+
data, status_code, headers = api_instance.get_workflow_assignment_users_with_http_info(opts)
|
138
|
+
p status_code # => 2xx
|
139
|
+
p headers # => { ... }
|
140
|
+
p data # => <WorkflowUsersResponse>
|
141
|
+
rescue UltracartClient::ApiError => e
|
142
|
+
puts "Error when calling WorkflowApi->get_workflow_assignment_users_with_http_info: #{e}"
|
143
|
+
end
|
144
|
+
```
|
145
|
+
|
146
|
+
### Parameters
|
147
|
+
|
148
|
+
| Name | Type | Description | Notes |
|
149
|
+
| ---- | ---- | ----------- | ----- |
|
150
|
+
| **_limit** | **Integer** | The maximum number of records to return on this one API call. (Max 200) | [optional][default to 100] |
|
151
|
+
| **_offset** | **Integer** | Pagination of the record set. Offset is a zero based index. | [optional][default to 0] |
|
152
|
+
|
153
|
+
### Return type
|
154
|
+
|
155
|
+
[**WorkflowUsersResponse**](WorkflowUsersResponse.md)
|
156
|
+
|
157
|
+
### Authorization
|
158
|
+
|
159
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
160
|
+
|
161
|
+
### HTTP request headers
|
162
|
+
|
163
|
+
- **Content-Type**: Not defined
|
164
|
+
- **Accept**: application/json
|
165
|
+
|
166
|
+
|
167
|
+
## get_workflow_task
|
168
|
+
|
169
|
+
> <WorkflowTaskResponse> get_workflow_task(task_uuid)
|
170
|
+
|
171
|
+
Retrieve a workflow task
|
172
|
+
|
173
|
+
Retrieve a workflow task
|
174
|
+
|
175
|
+
### Examples
|
176
|
+
|
177
|
+
```ruby
|
178
|
+
require 'time'
|
179
|
+
require 'ultracart_api'
|
180
|
+
require 'json'
|
181
|
+
require 'yaml'
|
182
|
+
require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
|
183
|
+
|
184
|
+
# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
|
185
|
+
# As such, this might not be the best way to use this object.
|
186
|
+
# Please see https://github.com/UltraCart/sdk_samples for working examples.
|
187
|
+
|
188
|
+
api = UltracartClient::WorkflowApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
|
189
|
+
task_uuid = 'task_uuid_example' # String |
|
190
|
+
|
191
|
+
begin
|
192
|
+
# Retrieve a workflow task
|
193
|
+
result = api_instance.get_workflow_task(task_uuid)
|
194
|
+
p result
|
195
|
+
rescue UltracartClient::ApiError => e
|
196
|
+
puts "Error when calling WorkflowApi->get_workflow_task: #{e}"
|
197
|
+
end
|
198
|
+
```
|
199
|
+
|
200
|
+
#### Using the get_workflow_task_with_http_info variant
|
201
|
+
|
202
|
+
This returns an Array which contains the response data, status code and headers.
|
203
|
+
|
204
|
+
> <Array(<WorkflowTaskResponse>, Integer, Hash)> get_workflow_task_with_http_info(task_uuid)
|
205
|
+
|
206
|
+
```ruby
|
207
|
+
begin
|
208
|
+
# Retrieve a workflow task
|
209
|
+
data, status_code, headers = api_instance.get_workflow_task_with_http_info(task_uuid)
|
210
|
+
p status_code # => 2xx
|
211
|
+
p headers # => { ... }
|
212
|
+
p data # => <WorkflowTaskResponse>
|
213
|
+
rescue UltracartClient::ApiError => e
|
214
|
+
puts "Error when calling WorkflowApi->get_workflow_task_with_http_info: #{e}"
|
215
|
+
end
|
216
|
+
```
|
217
|
+
|
218
|
+
### Parameters
|
219
|
+
|
220
|
+
| Name | Type | Description | Notes |
|
221
|
+
| ---- | ---- | ----------- | ----- |
|
222
|
+
| **task_uuid** | **String** | | |
|
223
|
+
|
224
|
+
### Return type
|
225
|
+
|
226
|
+
[**WorkflowTaskResponse**](WorkflowTaskResponse.md)
|
227
|
+
|
228
|
+
### Authorization
|
229
|
+
|
230
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
231
|
+
|
232
|
+
### HTTP request headers
|
233
|
+
|
234
|
+
- **Content-Type**: Not defined
|
235
|
+
- **Accept**: application/json
|
236
|
+
|
237
|
+
|
238
|
+
## get_workflow_task_attachment_upload_url
|
239
|
+
|
240
|
+
> <WorkflowAttachmentUploadUrlResponse> get_workflow_task_attachment_upload_url(extension)
|
241
|
+
|
242
|
+
Get a presigned workflow task attachment upload URL
|
243
|
+
|
244
|
+
Get a presigned workflow task attachment upload URL
|
245
|
+
|
246
|
+
### Examples
|
247
|
+
|
248
|
+
```ruby
|
249
|
+
require 'time'
|
250
|
+
require 'ultracart_api'
|
251
|
+
require 'json'
|
252
|
+
require 'yaml'
|
253
|
+
require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
|
254
|
+
|
255
|
+
# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
|
256
|
+
# As such, this might not be the best way to use this object.
|
257
|
+
# Please see https://github.com/UltraCart/sdk_samples for working examples.
|
258
|
+
|
259
|
+
api = UltracartClient::WorkflowApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
|
260
|
+
extension = 'extension_example' # String |
|
261
|
+
|
262
|
+
begin
|
263
|
+
# Get a presigned workflow task attachment upload URL
|
264
|
+
result = api_instance.get_workflow_task_attachment_upload_url(extension)
|
265
|
+
p result
|
266
|
+
rescue UltracartClient::ApiError => e
|
267
|
+
puts "Error when calling WorkflowApi->get_workflow_task_attachment_upload_url: #{e}"
|
268
|
+
end
|
269
|
+
```
|
270
|
+
|
271
|
+
#### Using the get_workflow_task_attachment_upload_url_with_http_info variant
|
272
|
+
|
273
|
+
This returns an Array which contains the response data, status code and headers.
|
274
|
+
|
275
|
+
> <Array(<WorkflowAttachmentUploadUrlResponse>, Integer, Hash)> get_workflow_task_attachment_upload_url_with_http_info(extension)
|
276
|
+
|
277
|
+
```ruby
|
278
|
+
begin
|
279
|
+
# Get a presigned workflow task attachment upload URL
|
280
|
+
data, status_code, headers = api_instance.get_workflow_task_attachment_upload_url_with_http_info(extension)
|
281
|
+
p status_code # => 2xx
|
282
|
+
p headers # => { ... }
|
283
|
+
p data # => <WorkflowAttachmentUploadUrlResponse>
|
284
|
+
rescue UltracartClient::ApiError => e
|
285
|
+
puts "Error when calling WorkflowApi->get_workflow_task_attachment_upload_url_with_http_info: #{e}"
|
286
|
+
end
|
287
|
+
```
|
288
|
+
|
289
|
+
### Parameters
|
290
|
+
|
291
|
+
| Name | Type | Description | Notes |
|
292
|
+
| ---- | ---- | ----------- | ----- |
|
293
|
+
| **extension** | **String** | | |
|
294
|
+
|
295
|
+
### Return type
|
296
|
+
|
297
|
+
[**WorkflowAttachmentUploadUrlResponse**](WorkflowAttachmentUploadUrlResponse.md)
|
298
|
+
|
299
|
+
### Authorization
|
300
|
+
|
301
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
302
|
+
|
303
|
+
### HTTP request headers
|
304
|
+
|
305
|
+
- **Content-Type**: Not defined
|
306
|
+
- **Accept**: application/json
|
307
|
+
|
308
|
+
|
309
|
+
## get_workflow_task_by_object_type
|
310
|
+
|
311
|
+
> <WorkflowTaskResponse> get_workflow_task_by_object_type(object_type, object_id)
|
312
|
+
|
313
|
+
Retrieve a workflow task by object type and id
|
314
|
+
|
315
|
+
Retrieve a workflow task by object type and id
|
316
|
+
|
317
|
+
### Examples
|
318
|
+
|
319
|
+
```ruby
|
320
|
+
require 'time'
|
321
|
+
require 'ultracart_api'
|
322
|
+
require 'json'
|
323
|
+
require 'yaml'
|
324
|
+
require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
|
325
|
+
|
326
|
+
# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
|
327
|
+
# As such, this might not be the best way to use this object.
|
328
|
+
# Please see https://github.com/UltraCart/sdk_samples for working examples.
|
329
|
+
|
330
|
+
api = UltracartClient::WorkflowApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
|
331
|
+
object_type = 'object_type_example' # String |
|
332
|
+
object_id = 'object_id_example' # String |
|
333
|
+
|
334
|
+
begin
|
335
|
+
# Retrieve a workflow task by object type and id
|
336
|
+
result = api_instance.get_workflow_task_by_object_type(object_type, object_id)
|
337
|
+
p result
|
338
|
+
rescue UltracartClient::ApiError => e
|
339
|
+
puts "Error when calling WorkflowApi->get_workflow_task_by_object_type: #{e}"
|
340
|
+
end
|
341
|
+
```
|
342
|
+
|
343
|
+
#### Using the get_workflow_task_by_object_type_with_http_info variant
|
344
|
+
|
345
|
+
This returns an Array which contains the response data, status code and headers.
|
346
|
+
|
347
|
+
> <Array(<WorkflowTaskResponse>, Integer, Hash)> get_workflow_task_by_object_type_with_http_info(object_type, object_id)
|
348
|
+
|
349
|
+
```ruby
|
350
|
+
begin
|
351
|
+
# Retrieve a workflow task by object type and id
|
352
|
+
data, status_code, headers = api_instance.get_workflow_task_by_object_type_with_http_info(object_type, object_id)
|
353
|
+
p status_code # => 2xx
|
354
|
+
p headers # => { ... }
|
355
|
+
p data # => <WorkflowTaskResponse>
|
356
|
+
rescue UltracartClient::ApiError => e
|
357
|
+
puts "Error when calling WorkflowApi->get_workflow_task_by_object_type_with_http_info: #{e}"
|
358
|
+
end
|
359
|
+
```
|
360
|
+
|
361
|
+
### Parameters
|
362
|
+
|
363
|
+
| Name | Type | Description | Notes |
|
364
|
+
| ---- | ---- | ----------- | ----- |
|
365
|
+
| **object_type** | **String** | | |
|
366
|
+
| **object_id** | **String** | | |
|
367
|
+
|
368
|
+
### Return type
|
369
|
+
|
370
|
+
[**WorkflowTaskResponse**](WorkflowTaskResponse.md)
|
371
|
+
|
372
|
+
### Authorization
|
373
|
+
|
374
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
375
|
+
|
376
|
+
### HTTP request headers
|
377
|
+
|
378
|
+
- **Content-Type**: Not defined
|
379
|
+
- **Accept**: application/json
|
380
|
+
|
381
|
+
|
382
|
+
## get_workflow_tasks
|
383
|
+
|
384
|
+
> <WorkflowTasksResponse> get_workflow_tasks(workflow_tasks_query, opts)
|
385
|
+
|
386
|
+
Search workflow tasks
|
387
|
+
|
388
|
+
Retrieves a set of workflow tasks from the account based on a query object.
|
389
|
+
|
390
|
+
### Examples
|
391
|
+
|
392
|
+
```ruby
|
393
|
+
require 'time'
|
394
|
+
require 'ultracart_api'
|
395
|
+
require 'json'
|
396
|
+
require 'yaml'
|
397
|
+
require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
|
398
|
+
|
399
|
+
# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
|
400
|
+
# As such, this might not be the best way to use this object.
|
401
|
+
# Please see https://github.com/UltraCart/sdk_samples for working examples.
|
402
|
+
|
403
|
+
api = UltracartClient::WorkflowApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
|
404
|
+
workflow_tasks_query = UltracartClient::WorkflowTasksRequest.new # WorkflowTasksRequest | Workflow tasks query
|
405
|
+
opts = {
|
406
|
+
_limit: 56, # Integer | The maximum number of records to return on this one API call. (Default 100, Max 500)
|
407
|
+
_offset: 56, # Integer | Pagination of the record set. Offset is a zero based index.
|
408
|
+
_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.
|
409
|
+
}
|
410
|
+
|
411
|
+
begin
|
412
|
+
# Search workflow tasks
|
413
|
+
result = api_instance.get_workflow_tasks(workflow_tasks_query, opts)
|
414
|
+
p result
|
415
|
+
rescue UltracartClient::ApiError => e
|
416
|
+
puts "Error when calling WorkflowApi->get_workflow_tasks: #{e}"
|
417
|
+
end
|
418
|
+
```
|
419
|
+
|
420
|
+
#### Using the get_workflow_tasks_with_http_info variant
|
421
|
+
|
422
|
+
This returns an Array which contains the response data, status code and headers.
|
423
|
+
|
424
|
+
> <Array(<WorkflowTasksResponse>, Integer, Hash)> get_workflow_tasks_with_http_info(workflow_tasks_query, opts)
|
425
|
+
|
426
|
+
```ruby
|
427
|
+
begin
|
428
|
+
# Search workflow tasks
|
429
|
+
data, status_code, headers = api_instance.get_workflow_tasks_with_http_info(workflow_tasks_query, opts)
|
430
|
+
p status_code # => 2xx
|
431
|
+
p headers # => { ... }
|
432
|
+
p data # => <WorkflowTasksResponse>
|
433
|
+
rescue UltracartClient::ApiError => e
|
434
|
+
puts "Error when calling WorkflowApi->get_workflow_tasks_with_http_info: #{e}"
|
435
|
+
end
|
436
|
+
```
|
437
|
+
|
438
|
+
### Parameters
|
439
|
+
|
440
|
+
| Name | Type | Description | Notes |
|
441
|
+
| ---- | ---- | ----------- | ----- |
|
442
|
+
| **workflow_tasks_query** | [**WorkflowTasksRequest**](WorkflowTasksRequest.md) | Workflow tasks query | |
|
443
|
+
| **_limit** | **Integer** | The maximum number of records to return on this one API call. (Default 100, Max 500) | [optional][default to 100] |
|
444
|
+
| **_offset** | **Integer** | Pagination of the record set. Offset is a zero based index. | [optional][default to 0] |
|
445
|
+
| **_sort** | **String** | The sort order of the items. See Sorting documentation for examples of using multiple values and sorting by ascending and descending. | [optional] |
|
446
|
+
|
447
|
+
### Return type
|
448
|
+
|
449
|
+
[**WorkflowTasksResponse**](WorkflowTasksResponse.md)
|
450
|
+
|
451
|
+
### Authorization
|
452
|
+
|
453
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
454
|
+
|
455
|
+
### HTTP request headers
|
456
|
+
|
457
|
+
- **Content-Type**: application/json
|
458
|
+
- **Accept**: application/json
|
459
|
+
|
460
|
+
|
461
|
+
## insert_workflow_task
|
462
|
+
|
463
|
+
> <WorkflowTaskResponse> insert_workflow_task(workflow_task)
|
464
|
+
|
465
|
+
Insert a workflow task
|
466
|
+
|
467
|
+
Insert a workflow task
|
468
|
+
|
469
|
+
### Examples
|
470
|
+
|
471
|
+
```ruby
|
472
|
+
require 'time'
|
473
|
+
require 'ultracart_api'
|
474
|
+
require 'json'
|
475
|
+
require 'yaml'
|
476
|
+
require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
|
477
|
+
|
478
|
+
# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
|
479
|
+
# As such, this might not be the best way to use this object.
|
480
|
+
# Please see https://github.com/UltraCart/sdk_samples for working examples.
|
481
|
+
|
482
|
+
api = UltracartClient::WorkflowApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
|
483
|
+
workflow_task = UltracartClient::WorkflowTask.new # WorkflowTask | workflow task
|
484
|
+
|
485
|
+
begin
|
486
|
+
# Insert a workflow task
|
487
|
+
result = api_instance.insert_workflow_task(workflow_task)
|
488
|
+
p result
|
489
|
+
rescue UltracartClient::ApiError => e
|
490
|
+
puts "Error when calling WorkflowApi->insert_workflow_task: #{e}"
|
491
|
+
end
|
492
|
+
```
|
493
|
+
|
494
|
+
#### Using the insert_workflow_task_with_http_info variant
|
495
|
+
|
496
|
+
This returns an Array which contains the response data, status code and headers.
|
497
|
+
|
498
|
+
> <Array(<WorkflowTaskResponse>, Integer, Hash)> insert_workflow_task_with_http_info(workflow_task)
|
499
|
+
|
500
|
+
```ruby
|
501
|
+
begin
|
502
|
+
# Insert a workflow task
|
503
|
+
data, status_code, headers = api_instance.insert_workflow_task_with_http_info(workflow_task)
|
504
|
+
p status_code # => 2xx
|
505
|
+
p headers # => { ... }
|
506
|
+
p data # => <WorkflowTaskResponse>
|
507
|
+
rescue UltracartClient::ApiError => e
|
508
|
+
puts "Error when calling WorkflowApi->insert_workflow_task_with_http_info: #{e}"
|
509
|
+
end
|
510
|
+
```
|
511
|
+
|
512
|
+
### Parameters
|
513
|
+
|
514
|
+
| Name | Type | Description | Notes |
|
515
|
+
| ---- | ---- | ----------- | ----- |
|
516
|
+
| **workflow_task** | [**WorkflowTask**](WorkflowTask.md) | workflow task | |
|
517
|
+
|
518
|
+
### Return type
|
519
|
+
|
520
|
+
[**WorkflowTaskResponse**](WorkflowTaskResponse.md)
|
521
|
+
|
522
|
+
### Authorization
|
523
|
+
|
524
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
525
|
+
|
526
|
+
### HTTP request headers
|
527
|
+
|
528
|
+
- **Content-Type**: application/json
|
529
|
+
- **Accept**: application/json
|
530
|
+
|
531
|
+
|
532
|
+
## update_workflow_task
|
533
|
+
|
534
|
+
> <WorkflowTaskResponse> update_workflow_task(task_uuid, workflow_task)
|
535
|
+
|
536
|
+
Update a workflow task
|
537
|
+
|
538
|
+
Update a workflow task
|
539
|
+
|
540
|
+
### Examples
|
541
|
+
|
542
|
+
```ruby
|
543
|
+
require 'time'
|
544
|
+
require 'ultracart_api'
|
545
|
+
require 'json'
|
546
|
+
require 'yaml'
|
547
|
+
require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
|
548
|
+
|
549
|
+
# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
|
550
|
+
# As such, this might not be the best way to use this object.
|
551
|
+
# Please see https://github.com/UltraCart/sdk_samples for working examples.
|
552
|
+
|
553
|
+
api = UltracartClient::WorkflowApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
|
554
|
+
task_uuid = 'task_uuid_example' # String |
|
555
|
+
workflow_task = UltracartClient::WorkflowTask.new # WorkflowTask | Workflow task
|
556
|
+
|
557
|
+
begin
|
558
|
+
# Update a workflow task
|
559
|
+
result = api_instance.update_workflow_task(task_uuid, workflow_task)
|
560
|
+
p result
|
561
|
+
rescue UltracartClient::ApiError => e
|
562
|
+
puts "Error when calling WorkflowApi->update_workflow_task: #{e}"
|
563
|
+
end
|
564
|
+
```
|
565
|
+
|
566
|
+
#### Using the update_workflow_task_with_http_info variant
|
567
|
+
|
568
|
+
This returns an Array which contains the response data, status code and headers.
|
569
|
+
|
570
|
+
> <Array(<WorkflowTaskResponse>, Integer, Hash)> update_workflow_task_with_http_info(task_uuid, workflow_task)
|
571
|
+
|
572
|
+
```ruby
|
573
|
+
begin
|
574
|
+
# Update a workflow task
|
575
|
+
data, status_code, headers = api_instance.update_workflow_task_with_http_info(task_uuid, workflow_task)
|
576
|
+
p status_code # => 2xx
|
577
|
+
p headers # => { ... }
|
578
|
+
p data # => <WorkflowTaskResponse>
|
579
|
+
rescue UltracartClient::ApiError => e
|
580
|
+
puts "Error when calling WorkflowApi->update_workflow_task_with_http_info: #{e}"
|
581
|
+
end
|
582
|
+
```
|
583
|
+
|
584
|
+
### Parameters
|
585
|
+
|
586
|
+
| Name | Type | Description | Notes |
|
587
|
+
| ---- | ---- | ----------- | ----- |
|
588
|
+
| **task_uuid** | **String** | | |
|
589
|
+
| **workflow_task** | [**WorkflowTask**](WorkflowTask.md) | Workflow task | |
|
590
|
+
|
591
|
+
### Return type
|
592
|
+
|
593
|
+
[**WorkflowTaskResponse**](WorkflowTaskResponse.md)
|
594
|
+
|
595
|
+
### Authorization
|
596
|
+
|
597
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
598
|
+
|
599
|
+
### HTTP request headers
|
600
|
+
|
601
|
+
- **Content-Type**: application/json
|
602
|
+
- **Accept**: application/json
|
603
|
+
|