ultracart_api 4.0.181 → 4.0.183

Sign up to get free protection for your applications and to get access to all the features.
Files changed (41) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +29 -4
  3. data/docs/CartPayment.md +2 -0
  4. data/docs/CartPaymentHealthBenefitCard.md +28 -0
  5. data/docs/OrderPayment.md +2 -0
  6. data/docs/OrderPaymentHealthBenefitCard.md +28 -0
  7. data/docs/WorkflowApi.md +603 -0
  8. data/docs/WorkflowAttachment.md +26 -0
  9. data/docs/WorkflowAttachmentUploadUrl.md +20 -0
  10. data/docs/WorkflowAttachmentUploadUrlResponse.md +26 -0
  11. data/docs/WorkflowGroup.md +20 -0
  12. data/docs/WorkflowGroupsResponse.md +26 -0
  13. data/docs/WorkflowNote.md +28 -0
  14. data/docs/WorkflowTask.md +60 -0
  15. data/docs/WorkflowTaskHistory.md +24 -0
  16. data/docs/WorkflowTaskResponse.md +26 -0
  17. data/docs/WorkflowTasksRequest.md +50 -0
  18. data/docs/WorkflowTasksResponse.md +26 -0
  19. data/docs/WorkflowUser.md +22 -0
  20. data/docs/WorkflowUsersResponse.md +26 -0
  21. data/lib/ultracart_api/api/workflow_api.rb +583 -0
  22. data/lib/ultracart_api/models/cart_payment.rb +10 -1
  23. data/lib/ultracart_api/models/cart_payment_health_benefit_card.rb +270 -0
  24. data/lib/ultracart_api/models/order_payment.rb +12 -3
  25. data/lib/ultracart_api/models/order_payment_health_benefit_card.rb +270 -0
  26. data/lib/ultracart_api/models/workflow_attachment.rb +260 -0
  27. data/lib/ultracart_api/models/workflow_attachment_upload_url.rb +228 -0
  28. data/lib/ultracart_api/models/workflow_attachment_upload_url_response.rb +256 -0
  29. data/lib/ultracart_api/models/workflow_group.rb +230 -0
  30. data/lib/ultracart_api/models/workflow_groups_response.rb +259 -0
  31. data/lib/ultracart_api/models/workflow_note.rb +271 -0
  32. data/lib/ultracart_api/models/workflow_task.rb +493 -0
  33. data/lib/ultracart_api/models/workflow_task_history.rb +249 -0
  34. data/lib/ultracart_api/models/workflow_task_response.rb +256 -0
  35. data/lib/ultracart_api/models/workflow_tasks_request.rb +437 -0
  36. data/lib/ultracart_api/models/workflow_tasks_response.rb +259 -0
  37. data/lib/ultracart_api/models/workflow_user.rb +240 -0
  38. data/lib/ultracart_api/models/workflow_users_response.rb +259 -0
  39. data/lib/ultracart_api/version.rb +1 -1
  40. data/lib/ultracart_api.rb +16 -0
  41. metadata +34 -2
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: d59ca2c1ca5ead917ba7c39fa6ca1f12f1a65ff75fba92e372dc344dc60632a8
4
- data.tar.gz: a2a0a5df40829bab73de56dbf3517db095bde4bea820ee42b21d69362319461f
3
+ metadata.gz: c91734129f42411892cd3b1c0c4bcc0f5b518ebc223122c480eaabc0caafec5f
4
+ data.tar.gz: a964d10de48ee5001cbcc8b196e7a62a3b8a7b8abac065c728845d4a2d262af6
5
5
  SHA512:
6
- metadata.gz: 6374a6319ddcc074aa614d682414aea22694941afa834c9cf18f903c61fb7a7b31394121bc5e2505486a3acc1c313d4550d6f35914b1f2f967a44d4205e3bddd
7
- data.tar.gz: 0c4b59412611bda988d444ef8034684de04566fa9303c9ecbbc19427bbec8d5c1fc3c4eef57530d2827a8da07eb65914e749c462d686f5b5b60d9200c4c49acb
6
+ metadata.gz: 46887a4eacf2d6b6534225b1a4f532c70a1a77b28eec183e0e2f059fc98c38b8d73677f7bb0a500820d65c1a81feb755950a1ab4eba2d90922819054e43efb52
7
+ data.tar.gz: 53b238a94093bdc608242b6aaf48c787ee5cda168e08ba3ac76bc9838de79ebf63863663ff2d7438ab74cff0d365d63193951e232e35d060ca3a07fb2bde586b
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.181
10
+ - Package version: 4.0.183
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.181.gem
27
+ gem install ./ultracart_api-4.0.183.gem
28
28
  ```
29
29
 
30
- (for development, run `gem install --dev ./ultracart_api-4.0.181.gem` to install the development dependencies)
30
+ (for development, run `gem install --dev ./ultracart_api-4.0.183.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.181'
36
+ gem 'ultracart_api', '~> 4.0.183'
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
@@ -591,6 +599,7 @@ Class | Method | HTTP request | Description
591
599
  - [UltracartClient::CartPaymentAmazon](docs/CartPaymentAmazon.md)
592
600
  - [UltracartClient::CartPaymentCheck](docs/CartPaymentCheck.md)
593
601
  - [UltracartClient::CartPaymentCreditCard](docs/CartPaymentCreditCard.md)
602
+ - [UltracartClient::CartPaymentHealthBenefitCard](docs/CartPaymentHealthBenefitCard.md)
594
603
  - [UltracartClient::CartPaymentPurchaseOrder](docs/CartPaymentPurchaseOrder.md)
595
604
  - [UltracartClient::CartProfileLoginRequest](docs/CartProfileLoginRequest.md)
596
605
  - [UltracartClient::CartProfileLoginResponse](docs/CartProfileLoginResponse.md)
@@ -1110,6 +1119,7 @@ Class | Method | HTTP request | Description
1110
1119
  - [UltracartClient::OrderPaymentCreditCardDualVaulted](docs/OrderPaymentCreditCardDualVaulted.md)
1111
1120
  - [UltracartClient::OrderPaymentCreditCardDualVaultedProperty](docs/OrderPaymentCreditCardDualVaultedProperty.md)
1112
1121
  - [UltracartClient::OrderPaymentECheck](docs/OrderPaymentECheck.md)
1122
+ - [UltracartClient::OrderPaymentHealthBenefitCard](docs/OrderPaymentHealthBenefitCard.md)
1113
1123
  - [UltracartClient::OrderPaymentInsurance](docs/OrderPaymentInsurance.md)
1114
1124
  - [UltracartClient::OrderPaymentPurchaseOrder](docs/OrderPaymentPurchaseOrder.md)
1115
1125
  - [UltracartClient::OrderPaymentTransaction](docs/OrderPaymentTransaction.md)
@@ -1298,6 +1308,19 @@ Class | Method | HTTP request | Description
1298
1308
  - [UltracartClient::WebhookSampleRequestResponse](docs/WebhookSampleRequestResponse.md)
1299
1309
  - [UltracartClient::WebhooksResponse](docs/WebhooksResponse.md)
1300
1310
  - [UltracartClient::Weight](docs/Weight.md)
1311
+ - [UltracartClient::WorkflowAttachment](docs/WorkflowAttachment.md)
1312
+ - [UltracartClient::WorkflowAttachmentUploadUrl](docs/WorkflowAttachmentUploadUrl.md)
1313
+ - [UltracartClient::WorkflowAttachmentUploadUrlResponse](docs/WorkflowAttachmentUploadUrlResponse.md)
1314
+ - [UltracartClient::WorkflowGroup](docs/WorkflowGroup.md)
1315
+ - [UltracartClient::WorkflowGroupsResponse](docs/WorkflowGroupsResponse.md)
1316
+ - [UltracartClient::WorkflowNote](docs/WorkflowNote.md)
1317
+ - [UltracartClient::WorkflowTask](docs/WorkflowTask.md)
1318
+ - [UltracartClient::WorkflowTaskHistory](docs/WorkflowTaskHistory.md)
1319
+ - [UltracartClient::WorkflowTaskResponse](docs/WorkflowTaskResponse.md)
1320
+ - [UltracartClient::WorkflowTasksRequest](docs/WorkflowTasksRequest.md)
1321
+ - [UltracartClient::WorkflowTasksResponse](docs/WorkflowTasksResponse.md)
1322
+ - [UltracartClient::WorkflowUser](docs/WorkflowUser.md)
1323
+ - [UltracartClient::WorkflowUsersResponse](docs/WorkflowUsersResponse.md)
1301
1324
 
1302
1325
 
1303
1326
  ## Documentation for Authorization
@@ -1373,6 +1396,8 @@ Not every change is committed to every SDK.
1373
1396
 
1374
1397
  | Version | Date | Comments |
1375
1398
  | --: | :-: | --- |
1399
+ | 4.0.183 | 10/27/2023 | workflow task object model refinement |
1400
+ | 4.0.182 | 10/23/2023 | workflow tasks api |
1376
1401
  | 4.0.181 | 10/23/2023 | workflow tasks api |
1377
1402
  | 4.0.180 | 10/16/2023 | CartSettingsPaymentCreditCard - add collect_credit_card_verification_number_minimum |
1378
1403
  | 4.0.179 | 09/28/2023 | dw bi - add aggregation constant of none |
data/docs/CartPayment.md CHANGED
@@ -8,6 +8,7 @@
8
8
  | **amazon** | [**CartPaymentAmazon**](CartPaymentAmazon.md) | | [optional] |
9
9
  | **check** | [**CartPaymentCheck**](CartPaymentCheck.md) | | [optional] |
10
10
  | **credit_card** | [**CartPaymentCreditCard**](CartPaymentCreditCard.md) | | [optional] |
11
+ | **health_benefit_card** | [**CartPaymentHealthBenefitCard**](CartPaymentHealthBenefitCard.md) | | [optional] |
11
12
  | **payment_method** | **String** | Payment method | [optional] |
12
13
  | **purchase_order** | [**CartPaymentPurchaseOrder**](CartPaymentPurchaseOrder.md) | | [optional] |
13
14
  | **rtg_code** | **String** | Rotating transaction gateway code | [optional] |
@@ -22,6 +23,7 @@ instance = UltracartClient::CartPayment.new(
22
23
  amazon: null,
23
24
  check: null,
24
25
  credit_card: null,
26
+ health_benefit_card: null,
25
27
  payment_method: null,
26
28
  purchase_order: null,
27
29
  rtg_code: null
@@ -0,0 +1,28 @@
1
+ # UltracartClient::CartPaymentHealthBenefitCard
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **health_benefit_card_expiration_month** | **Integer** | Health benefit expiration month (1-12) | [optional] |
8
+ | **health_benefit_card_expiration_year** | **Integer** | Health benefit card expiration year (four digit year) | [optional] |
9
+ | **health_benefit_card_number** | **String** | Health benefit card number (masked to the last 4) | [optional] |
10
+ | **health_benefit_card_number_token** | **String** | Hosted field token for the card number | [optional] |
11
+ | **health_benefit_card_verification_number** | **String** | Health benefit card verification number (masked) | [optional] |
12
+ | **health_benefit_card_verification_number_token** | **String** | Hosted field token for the health benefit card verification number | [optional] |
13
+
14
+ ## Example
15
+
16
+ ```ruby
17
+ require 'ultracart_api'
18
+
19
+ instance = UltracartClient::CartPaymentHealthBenefitCard.new(
20
+ health_benefit_card_expiration_month: null,
21
+ health_benefit_card_expiration_year: null,
22
+ health_benefit_card_number: null,
23
+ health_benefit_card_number_token: null,
24
+ health_benefit_card_verification_number: null,
25
+ health_benefit_card_verification_number_token: null
26
+ )
27
+ ```
28
+
data/docs/OrderPayment.md CHANGED
@@ -7,6 +7,7 @@
7
7
  | **check** | [**OrderPaymentCheck**](OrderPaymentCheck.md) | | [optional] |
8
8
  | **credit_card** | [**OrderPaymentCreditCard**](OrderPaymentCreditCard.md) | | [optional] |
9
9
  | **echeck** | [**OrderPaymentECheck**](OrderPaymentECheck.md) | | [optional] |
10
+ | **health_benefit_card** | [**OrderPaymentHealthBenefitCard**](OrderPaymentHealthBenefitCard.md) | | [optional] |
10
11
  | **hold_for_fraud_review** | **Boolean** | True if order has been held for fraud review | [optional] |
11
12
  | **insurance** | [**OrderPaymentInsurance**](OrderPaymentInsurance.md) | | [optional] |
12
13
  | **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] |
@@ -32,6 +33,7 @@ instance = UltracartClient::OrderPayment.new(
32
33
  check: null,
33
34
  credit_card: null,
34
35
  echeck: null,
36
+ health_benefit_card: null,
35
37
  hold_for_fraud_review: null,
36
38
  insurance: null,
37
39
  payment_dts: null,
@@ -0,0 +1,28 @@
1
+ # UltracartClient::OrderPaymentHealthBenefitCard
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **health_benefit_card_expiration_month** | **Integer** | Health benefit card expiration month (1-12) | [optional] |
8
+ | **health_benefit_card_expiration_year** | **Integer** | Health benefit card expiration year (Four digit year) | [optional] |
9
+ | **health_benefit_card_number** | **String** | Health benefit card number (masked to last 4) | [optional] |
10
+ | **health_benefit_card_number_token** | **String** | Health benefit card number token from hosted fields used to update the health benefit card number | [optional] |
11
+ | **health_benefit_card_number_truncated** | **Boolean** | True if the health benefit card has been truncated | [optional] |
12
+ | **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] |
13
+
14
+ ## Example
15
+
16
+ ```ruby
17
+ require 'ultracart_api'
18
+
19
+ instance = UltracartClient::OrderPaymentHealthBenefitCard.new(
20
+ health_benefit_card_expiration_month: null,
21
+ health_benefit_card_expiration_year: null,
22
+ health_benefit_card_number: null,
23
+ health_benefit_card_number_token: null,
24
+ health_benefit_card_number_truncated: null,
25
+ health_benefit_card_verification_number_token: null
26
+ )
27
+ ```
28
+