ultracart_api 3.10.164 → 3.10.166
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 +29 -4
- data/docs/CartPayment.md +1 -0
- data/docs/CartPaymentHealthBenefitCard.md +13 -0
- data/docs/OrderPayment.md +1 -0
- data/docs/OrderPaymentHealthBenefitCard.md +13 -0
- 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 +24 -0
- data/docs/WorkflowTasksResponse.md +12 -0
- data/docs/WorkflowUser.md +10 -0
- data/docs/WorkflowUsersResponse.md +12 -0
- data/lib/ultracart_api/api/workflow_api.rb +497 -0
- data/lib/ultracart_api/models/cart_payment.rb +10 -1
- data/lib/ultracart_api/models/cart_payment_health_benefit_card.rb +235 -0
- data/lib/ultracart_api/models/order_payment.rb +12 -3
- data/lib/ultracart_api/models/order_payment_health_benefit_card.rb +235 -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 +402 -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 +16 -0
- metadata +34 -2
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 325b3fb7ef2598216a534880dac8d783c7c5a6b8eeb2f25886fd1c6fb447c7cb
|
|
4
|
+
data.tar.gz: 8c259818b2b70168168d6f90da133eef0aa8d682e8e8bd63405c47742da39837
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 6ee3a17478aaff15e4f2d9574321de97f24bb443748154ec6dc0b90067913154f6001ecb7f3b960ece1da797f81e2efe8484d9c9ab16dbcd3bf0dee925d0296c
|
|
7
|
+
data.tar.gz: 60be9ae2c63cd31ac96d2301c69c0ec3e0ca9b66aff84fe9326347acf7252601df9ee7c0e3928c342ecb7058414b973cc168fe77ca801bae7460deb4568ea054
|
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.166
|
|
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.166.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.166.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.166'
|
|
36
36
|
|
|
37
37
|
### Install from Git
|
|
38
38
|
|
|
@@ -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
|
|
@@ -585,6 +593,7 @@ Class | Method | HTTP request | Description
|
|
|
585
593
|
- [UltracartClient::CartPaymentAmazon](docs/CartPaymentAmazon.md)
|
|
586
594
|
- [UltracartClient::CartPaymentCheck](docs/CartPaymentCheck.md)
|
|
587
595
|
- [UltracartClient::CartPaymentCreditCard](docs/CartPaymentCreditCard.md)
|
|
596
|
+
- [UltracartClient::CartPaymentHealthBenefitCard](docs/CartPaymentHealthBenefitCard.md)
|
|
588
597
|
- [UltracartClient::CartPaymentPurchaseOrder](docs/CartPaymentPurchaseOrder.md)
|
|
589
598
|
- [UltracartClient::CartProfileLoginRequest](docs/CartProfileLoginRequest.md)
|
|
590
599
|
- [UltracartClient::CartProfileLoginResponse](docs/CartProfileLoginResponse.md)
|
|
@@ -1105,6 +1114,7 @@ Class | Method | HTTP request | Description
|
|
|
1105
1114
|
- [UltracartClient::OrderPaymentCreditCardDualVaulted](docs/OrderPaymentCreditCardDualVaulted.md)
|
|
1106
1115
|
- [UltracartClient::OrderPaymentCreditCardDualVaultedProperty](docs/OrderPaymentCreditCardDualVaultedProperty.md)
|
|
1107
1116
|
- [UltracartClient::OrderPaymentECheck](docs/OrderPaymentECheck.md)
|
|
1117
|
+
- [UltracartClient::OrderPaymentHealthBenefitCard](docs/OrderPaymentHealthBenefitCard.md)
|
|
1108
1118
|
- [UltracartClient::OrderPaymentInsurance](docs/OrderPaymentInsurance.md)
|
|
1109
1119
|
- [UltracartClient::OrderPaymentPurchaseOrder](docs/OrderPaymentPurchaseOrder.md)
|
|
1110
1120
|
- [UltracartClient::OrderPaymentTransaction](docs/OrderPaymentTransaction.md)
|
|
@@ -1293,6 +1303,19 @@ Class | Method | HTTP request | Description
|
|
|
1293
1303
|
- [UltracartClient::WebhookSampleRequestResponse](docs/WebhookSampleRequestResponse.md)
|
|
1294
1304
|
- [UltracartClient::WebhooksResponse](docs/WebhooksResponse.md)
|
|
1295
1305
|
- [UltracartClient::Weight](docs/Weight.md)
|
|
1306
|
+
- [UltracartClient::WorkflowAttachment](docs/WorkflowAttachment.md)
|
|
1307
|
+
- [UltracartClient::WorkflowAttachmentUploadUrl](docs/WorkflowAttachmentUploadUrl.md)
|
|
1308
|
+
- [UltracartClient::WorkflowAttachmentUploadUrlResponse](docs/WorkflowAttachmentUploadUrlResponse.md)
|
|
1309
|
+
- [UltracartClient::WorkflowGroup](docs/WorkflowGroup.md)
|
|
1310
|
+
- [UltracartClient::WorkflowGroupsResponse](docs/WorkflowGroupsResponse.md)
|
|
1311
|
+
- [UltracartClient::WorkflowNote](docs/WorkflowNote.md)
|
|
1312
|
+
- [UltracartClient::WorkflowTask](docs/WorkflowTask.md)
|
|
1313
|
+
- [UltracartClient::WorkflowTaskHistory](docs/WorkflowTaskHistory.md)
|
|
1314
|
+
- [UltracartClient::WorkflowTaskResponse](docs/WorkflowTaskResponse.md)
|
|
1315
|
+
- [UltracartClient::WorkflowTasksRequest](docs/WorkflowTasksRequest.md)
|
|
1316
|
+
- [UltracartClient::WorkflowTasksResponse](docs/WorkflowTasksResponse.md)
|
|
1317
|
+
- [UltracartClient::WorkflowUser](docs/WorkflowUser.md)
|
|
1318
|
+
- [UltracartClient::WorkflowUsersResponse](docs/WorkflowUsersResponse.md)
|
|
1296
1319
|
|
|
1297
1320
|
|
|
1298
1321
|
## Documentation for Authorization
|
|
@@ -1365,6 +1388,8 @@ Not every change is committed to every SDK.
|
|
|
1365
1388
|
|
|
1366
1389
|
| Version | Date | Comments |
|
|
1367
1390
|
| --: | :-: | --- |
|
|
1391
|
+
| 3.10.166 | 10/27/2023 | workflow task object model refinement |
|
|
1392
|
+
| 3.10.165 | 10/23/2023 | workflow tasks api |
|
|
1368
1393
|
| 3.10.164 | 10/23/2023 | workflow tasks api |
|
|
1369
1394
|
| 3.10.163 | 10/16/2023 | CartSettingsPaymentCreditCard - add collect_credit_card_verification_number_minimum |
|
|
1370
1395
|
| 3.10.162 | 09/28/2023 | dw bi - add aggregation constant of none |
|
data/docs/CartPayment.md
CHANGED
|
@@ -7,6 +7,7 @@ Name | Type | Description | Notes
|
|
|
7
7
|
**amazon** | [**CartPaymentAmazon**](CartPaymentAmazon.md) | | [optional]
|
|
8
8
|
**check** | [**CartPaymentCheck**](CartPaymentCheck.md) | | [optional]
|
|
9
9
|
**credit_card** | [**CartPaymentCreditCard**](CartPaymentCreditCard.md) | | [optional]
|
|
10
|
+
**health_benefit_card** | [**CartPaymentHealthBenefitCard**](CartPaymentHealthBenefitCard.md) | | [optional]
|
|
10
11
|
**payment_method** | **String** | Payment method | [optional]
|
|
11
12
|
**purchase_order** | [**CartPaymentPurchaseOrder**](CartPaymentPurchaseOrder.md) | | [optional]
|
|
12
13
|
**rtg_code** | **String** | Rotating transaction gateway code | [optional]
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
# UltracartClient::CartPaymentHealthBenefitCard
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**health_benefit_card_expiration_month** | **Integer** | Health benefit expiration month (1-12) | [optional]
|
|
7
|
+
**health_benefit_card_expiration_year** | **Integer** | Health benefit card expiration year (four digit year) | [optional]
|
|
8
|
+
**health_benefit_card_number** | **String** | Health benefit card number (masked to the last 4) | [optional]
|
|
9
|
+
**health_benefit_card_number_token** | **String** | Hosted field token for the card number | [optional]
|
|
10
|
+
**health_benefit_card_verification_number** | **String** | Health benefit card verification number (masked) | [optional]
|
|
11
|
+
**health_benefit_card_verification_number_token** | **String** | Hosted field token for the health benefit card verification number | [optional]
|
|
12
|
+
|
|
13
|
+
|
data/docs/OrderPayment.md
CHANGED
|
@@ -6,6 +6,7 @@ Name | Type | Description | Notes
|
|
|
6
6
|
**check** | [**OrderPaymentCheck**](OrderPaymentCheck.md) | | [optional]
|
|
7
7
|
**credit_card** | [**OrderPaymentCreditCard**](OrderPaymentCreditCard.md) | | [optional]
|
|
8
8
|
**echeck** | [**OrderPaymentECheck**](OrderPaymentECheck.md) | | [optional]
|
|
9
|
+
**health_benefit_card** | [**OrderPaymentHealthBenefitCard**](OrderPaymentHealthBenefitCard.md) | | [optional]
|
|
9
10
|
**hold_for_fraud_review** | **BOOLEAN** | True if order has been held for fraud review | [optional]
|
|
10
11
|
**insurance** | [**OrderPaymentInsurance**](OrderPaymentInsurance.md) | | [optional]
|
|
11
12
|
**payment_dts** | **String** | Date/time that the payment was successfully processed, for new orders, this field is only considered if channel_partner.skip_payment_processing is true | [optional]
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
# UltracartClient::OrderPaymentHealthBenefitCard
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**health_benefit_card_expiration_month** | **Integer** | Health benefit card expiration month (1-12) | [optional]
|
|
7
|
+
**health_benefit_card_expiration_year** | **Integer** | Health benefit card expiration year (Four digit year) | [optional]
|
|
8
|
+
**health_benefit_card_number** | **String** | Health benefit card number (masked to last 4) | [optional]
|
|
9
|
+
**health_benefit_card_number_token** | **String** | Health benefit card number token from hosted fields used to update the health benefit card number | [optional]
|
|
10
|
+
**health_benefit_card_number_truncated** | **BOOLEAN** | True if the health benefit card has been truncated | [optional]
|
|
11
|
+
**health_benefit_card_verification_number_token** | **String** | Health benefit card verification number token from hosted fields, only for import/insert of new orders, completely ignored for updates, and always null/empty for queries | [optional]
|
|
12
|
+
|
|
13
|
+
|
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
|
+
|