ultracart_api 4.0.180 → 4.0.182

Sign up to get free protection for your applications and to get access to all the features.
Files changed (35) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +30 -5
  3. data/docs/ConversationApi.md +5 -5
  4. data/docs/WorkflowApi.md +603 -0
  5. data/docs/WorkflowAttachment.md +26 -0
  6. data/docs/WorkflowAttachmentUploadUrl.md +20 -0
  7. data/docs/WorkflowAttachmentUploadUrlResponse.md +26 -0
  8. data/docs/WorkflowGroup.md +20 -0
  9. data/docs/WorkflowGroupsResponse.md +26 -0
  10. data/docs/WorkflowNote.md +28 -0
  11. data/docs/WorkflowTask.md +60 -0
  12. data/docs/WorkflowTaskHistory.md +24 -0
  13. data/docs/WorkflowTaskResponse.md +26 -0
  14. data/docs/WorkflowTasksRequest.md +48 -0
  15. data/docs/WorkflowTasksResponse.md +26 -0
  16. data/docs/WorkflowUser.md +22 -0
  17. data/docs/WorkflowUsersResponse.md +26 -0
  18. data/lib/ultracart_api/api/conversation_api.rb +4 -4
  19. data/lib/ultracart_api/api/workflow_api.rb +583 -0
  20. data/lib/ultracart_api/models/workflow_attachment.rb +260 -0
  21. data/lib/ultracart_api/models/workflow_attachment_upload_url.rb +228 -0
  22. data/lib/ultracart_api/models/workflow_attachment_upload_url_response.rb +256 -0
  23. data/lib/ultracart_api/models/workflow_group.rb +230 -0
  24. data/lib/ultracart_api/models/workflow_groups_response.rb +259 -0
  25. data/lib/ultracart_api/models/workflow_note.rb +271 -0
  26. data/lib/ultracart_api/models/workflow_task.rb +493 -0
  27. data/lib/ultracart_api/models/workflow_task_history.rb +249 -0
  28. data/lib/ultracart_api/models/workflow_task_response.rb +256 -0
  29. data/lib/ultracart_api/models/workflow_tasks_request.rb +427 -0
  30. data/lib/ultracart_api/models/workflow_tasks_response.rb +259 -0
  31. data/lib/ultracart_api/models/workflow_user.rb +240 -0
  32. data/lib/ultracart_api/models/workflow_users_response.rb +259 -0
  33. data/lib/ultracart_api/version.rb +1 -1
  34. data/lib/ultracart_api.rb +14 -0
  35. metadata +30 -2
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 39c4cbaacb99003a56d90f6737e6426864fc58425a2d73d4fe21d5ae1d1ea862
4
- data.tar.gz: '09b01607d00a1c5b5c73f3807c9b7c0d7567050e8016a07a74a2f917b306a813'
3
+ metadata.gz: 91197ce8d33447d32ca5c417cd8040e6dbdac700fd986162dc763d3d90c97dd1
4
+ data.tar.gz: d155cec55d05a1ad64ce2cd7b610a8cc94efbff1f9ab876077159247a9581dd9
5
5
  SHA512:
6
- metadata.gz: 6134c3492a3fab18ee243ebe4528b07abee4d1f96d0443fdd72ecf464190f36f38c7979495219eb4c75afe1423521b009b48db74caf7f0ced7a1b444b0ca626a
7
- data.tar.gz: 9dd33939d18ed9d5e67138d9c2f3898b23164b1b9b4f6a222279574d61459a8ca92d28b467f7d32a9f98737c0f3d02f97faf2d673c8beadccba473843e8fe6af
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.180
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.180.gem
27
+ gem install ./ultracart_api-4.0.182.gem
28
28
  ```
29
29
 
30
- (for development, run `gem install --dev ./ultracart_api-4.0.180.gem` to install the development dependencies)
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.180'
36
+ gem 'ultracart_api', '~> 4.0.182'
37
37
 
38
38
  ### Install from Git
39
39
 
@@ -152,7 +152,7 @@ Class | Method | HTTP request | Description
152
152
  *UltracartClient::ConversationApi* | [**get_conversation_engagement**](docs/ConversationApi.md#get_conversation_engagement) | **GET** /conversation/engagements/{conversation_engagement_oid} | Retrieve an engagement
153
153
  *UltracartClient::ConversationApi* | [**get_conversation_engagements**](docs/ConversationApi.md#get_conversation_engagements) | **GET** /conversation/engagements | Retrieve a list of engagements ordered by name
154
154
  *UltracartClient::ConversationApi* | [**get_conversation_messages**](docs/ConversationApi.md#get_conversation_messages) | **GET** /conversation/conversations/{conversation_uuid}/messages/{since} | Retrieve conversation messages
155
- *UltracartClient::ConversationApi* | [**get_conversation_multimedia_upload_url**](docs/ConversationApi.md#get_conversation_multimedia_upload_url) | **GET** /conversation/upload_url/{extension} | Get a presigned conersation multimedia upload URL
155
+ *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
156
156
  *UltracartClient::ConversationApi* | [**get_conversation_permissions**](docs/ConversationApi.md#get_conversation_permissions) | **GET** /conversation/permissions | Retrieve conversation permissions
157
157
  *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
158
158
  *UltracartClient::ConversationApi* | [**get_conversations**](docs/ConversationApi.md#get_conversations) | **GET** /conversation/conversations | Retrieve a list of conversation summaries newest to oldest
@@ -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
@@ -1355,6 +1376,8 @@ Class | Method | HTTP request | Description
1355
1376
  - ultrabooks_write: 2 of 2 required to use UltraBooks
1356
1377
  - user_read: Allows you to read user information.
1357
1378
  - user_write: Allows you to write user information.
1379
+ - workflow_read: Allows you to read workflow information.
1380
+ - workflow_write: Allows you to write workflow information.
1358
1381
 
1359
1382
  ### ultraCartSimpleApiKey
1360
1383
 
@@ -1371,6 +1394,8 @@ Not every change is committed to every SDK.
1371
1394
 
1372
1395
  | Version | Date | Comments |
1373
1396
  | --: | :-: | --- |
1397
+ | 4.0.182 | 10/23/2023 | workflow tasks api |
1398
+ | 4.0.181 | 10/23/2023 | workflow tasks api |
1374
1399
  | 4.0.180 | 10/16/2023 | CartSettingsPaymentCreditCard - add collect_credit_card_verification_number_minimum |
1375
1400
  | 4.0.179 | 09/28/2023 | dw bi - add aggregation constant of none |
1376
1401
  | 4.0.178 | 09/22/2023 | dwbi - new option to control order-by of result set |
@@ -18,7 +18,7 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
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 conersation multimedia upload URL |
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 |
@@ -1024,9 +1024,9 @@ end
1024
1024
 
1025
1025
  > <ConversationMultimediaUploadUrlResponse> get_conversation_multimedia_upload_url(extension)
1026
1026
 
1027
- Get a presigned conersation multimedia upload URL
1027
+ Get a presigned conversation multimedia upload URL
1028
1028
 
1029
- Get a presigned conersation multimedia upload URL
1029
+ Get a presigned conversation multimedia upload URL
1030
1030
 
1031
1031
  ### Examples
1032
1032
 
@@ -1045,7 +1045,7 @@ api = UltracartClient::ConversationApi.new_using_api_key(Constants::API_KEY, Con
1045
1045
  extension = 'extension_example' # String |
1046
1046
 
1047
1047
  begin
1048
- # Get a presigned conersation multimedia upload URL
1048
+ # Get a presigned conversation multimedia upload URL
1049
1049
  result = api_instance.get_conversation_multimedia_upload_url(extension)
1050
1050
  p result
1051
1051
  rescue UltracartClient::ApiError => e
@@ -1061,7 +1061,7 @@ This returns an Array which contains the response data, status code and headers.
1061
1061
 
1062
1062
  ```ruby
1063
1063
  begin
1064
- # Get a presigned conersation multimedia upload URL
1064
+ # Get a presigned conversation multimedia upload URL
1065
1065
  data, status_code, headers = api_instance.get_conversation_multimedia_upload_url_with_http_info(extension)
1066
1066
  p status_code # => 2xx
1067
1067
  p headers # => { ... }