ultracart_api 4.0.202 → 4.0.204
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 +10 -4
- data/docs/ConversationApi.md +71 -0
- data/docs/ConversationPbxQueue.md +5 -1
- data/docs/WorkflowAgentAuth.md +22 -0
- data/docs/WorkflowAgentAuthResponse.md +26 -0
- data/docs/WorkflowApi.md +69 -0
- data/docs/WorkflowTask.md +4 -0
- data/lib/ultracart_api/api/conversation_api.rb +64 -0
- data/lib/ultracart_api/api/workflow_api.rb +58 -0
- data/lib/ultracart_api/models/conversation_pbx_queue.rb +24 -4
- data/lib/ultracart_api/models/workflow_agent_auth.rb +237 -0
- data/lib/ultracart_api/models/workflow_agent_auth_response.rb +256 -0
- data/lib/ultracart_api/models/workflow_task.rb +35 -3
- data/lib/ultracart_api/version.rb +1 -1
- data/lib/ultracart_api.rb +2 -0
- metadata +6 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: cdcbb03fdcded697195997c256609bdb9d663f40b6f9df73b2d414d25596491d
|
4
|
+
data.tar.gz: '09c586cf32123cd87bfac438ca903c0f2d8e0cd3da4e2aa9a82d1c0c689fada2'
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 28dc158ef75f566e72e87a7b754c7275575eb5f196d4069b12df18903806870ecc4c65ec11f47ecea437551507f62d4f99e5776fb022ee01089d15dbf21217da
|
7
|
+
data.tar.gz: d938415376be7ff6108688521b9447560a8be3f93220c2f40e781a5631cbd9b90323ae62d1f1cf24130fec5f931af2885783fa5af77c0fafebc5aaa662e1c121
|
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.204
|
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.204.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.204.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.204'
|
37
37
|
|
38
38
|
### Install from Git
|
39
39
|
|
@@ -199,6 +199,7 @@ Class | Method | HTTP request | Description
|
|
199
199
|
*UltracartClient::ConversationApi* | [**join_conversation**](docs/ConversationApi.md#join_conversation) | **PUT** /conversation/conversations/{conversation_uuid}/join | Join a conversation
|
200
200
|
*UltracartClient::ConversationApi* | [**leave_conversation**](docs/ConversationApi.md#leave_conversation) | **DELETE** /conversation/conversations/{conversation_uuid}/leave | Leave a conversation
|
201
201
|
*UltracartClient::ConversationApi* | [**mark_read_conversation**](docs/ConversationApi.md#mark_read_conversation) | **PUT** /conversation/conversations/{conversation_uuid}/markread | Mark a conversation as read
|
202
|
+
*UltracartClient::ConversationApi* | [**reset_conversation_pbx_queue_statistics**](docs/ConversationApi.md#reset_conversation_pbx_queue_statistics) | **POST** /conversation/pbx/queues/{queue_uuid}/reset_statistics | reset statistics within the queue
|
202
203
|
*UltracartClient::ConversationApi* | [**search_conversation_canned_messages**](docs/ConversationApi.md#search_conversation_canned_messages) | **POST** /conversation/canned_messages/search | Search for canned messages by short_code
|
203
204
|
*UltracartClient::ConversationApi* | [**sms_unsubscribe_conversation**](docs/ConversationApi.md#sms_unsubscribe_conversation) | **PUT** /conversation/conversations/{conversation_uuid}/sms_unsubscribe | Unsubscribe any SMS participants in this conversation
|
204
205
|
*UltracartClient::ConversationApi* | [**start_conversation**](docs/ConversationApi.md#start_conversation) | **PUT** /conversation/conversations | Start a conversation
|
@@ -562,6 +563,7 @@ Class | Method | HTTP request | Description
|
|
562
563
|
*UltracartClient::WebhookApi* | [**insert_webhook**](docs/WebhookApi.md#insert_webhook) | **POST** /webhook/webhooks | Add a webhook
|
563
564
|
*UltracartClient::WebhookApi* | [**resend_event**](docs/WebhookApi.md#resend_event) | **POST** /webhook/webhooks/{webhookOid}/reflow/{eventName} | Resend events to the webhook endpoint.
|
564
565
|
*UltracartClient::WebhookApi* | [**update_webhook**](docs/WebhookApi.md#update_webhook) | **PUT** /webhook/webhooks/{webhookOid} | Update a webhook
|
566
|
+
*UltracartClient::WorkflowApi* | [**get_workflow_agent_websocket_authorization**](docs/WorkflowApi.md#get_workflow_agent_websocket_authorization) | **PUT** /workflow/agent/auth | Get agent websocket authorization
|
565
567
|
*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
|
566
568
|
*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
|
567
569
|
*UltracartClient::WorkflowApi* | [**get_workflow_me**](docs/WorkflowApi.md#get_workflow_me) | **GET** /workflow/me | Retrieve a user object for myself
|
@@ -1398,6 +1400,8 @@ Class | Method | HTTP request | Description
|
|
1398
1400
|
- [UltracartClient::WebhookSampleRequestResponse](docs/WebhookSampleRequestResponse.md)
|
1399
1401
|
- [UltracartClient::WebhooksResponse](docs/WebhooksResponse.md)
|
1400
1402
|
- [UltracartClient::Weight](docs/Weight.md)
|
1403
|
+
- [UltracartClient::WorkflowAgentAuth](docs/WorkflowAgentAuth.md)
|
1404
|
+
- [UltracartClient::WorkflowAgentAuthResponse](docs/WorkflowAgentAuthResponse.md)
|
1401
1405
|
- [UltracartClient::WorkflowAttachment](docs/WorkflowAttachment.md)
|
1402
1406
|
- [UltracartClient::WorkflowAttachmentUploadUrl](docs/WorkflowAttachmentUploadUrl.md)
|
1403
1407
|
- [UltracartClient::WorkflowAttachmentUploadUrlResponse](docs/WorkflowAttachmentUploadUrlResponse.md)
|
@@ -1488,6 +1492,8 @@ Not every change is committed to every SDK.
|
|
1488
1492
|
|
1489
1493
|
| Version | Date | Comments |
|
1490
1494
|
| --: | :-: | --- |
|
1495
|
+
| 4.0.204 | 03/19/2024 | workflow task - addl status values, expiration_dts, and system task type |
|
1496
|
+
| 4.0.203 | 03/15/2024 | workflow - getWorkflowAgentWebsocketAuthorization method added |
|
1491
1497
|
| 4.0.202 | 03/08/2024 | added getWorkflowTaskTags method |
|
1492
1498
|
| 4.0.201 | 02/27/2024 | esp - sms statistic layer |
|
1493
1499
|
| 4.0.200 | 02/20/2024 | Add tag support to CouponAmountOffItems, CouponBuyOneGetOneLimit, CouponDiscountItemWithItemPurchase, CouponFreeItemWithItemPurchase, CouponPercentOffItemsWithItemsPurchase |
|
data/docs/ConversationApi.md
CHANGED
@@ -65,6 +65,7 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
|
|
65
65
|
| [**join_conversation**](ConversationApi.md#join_conversation) | **PUT** /conversation/conversations/{conversation_uuid}/join | Join a conversation |
|
66
66
|
| [**leave_conversation**](ConversationApi.md#leave_conversation) | **DELETE** /conversation/conversations/{conversation_uuid}/leave | Leave a conversation |
|
67
67
|
| [**mark_read_conversation**](ConversationApi.md#mark_read_conversation) | **PUT** /conversation/conversations/{conversation_uuid}/markread | Mark a conversation as read |
|
68
|
+
| [**reset_conversation_pbx_queue_statistics**](ConversationApi.md#reset_conversation_pbx_queue_statistics) | **POST** /conversation/pbx/queues/{queue_uuid}/reset_statistics | reset statistics within the queue |
|
68
69
|
| [**search_conversation_canned_messages**](ConversationApi.md#search_conversation_canned_messages) | **POST** /conversation/canned_messages/search | Search for canned messages by short_code |
|
69
70
|
| [**sms_unsubscribe_conversation**](ConversationApi.md#sms_unsubscribe_conversation) | **PUT** /conversation/conversations/{conversation_uuid}/sms_unsubscribe | Unsubscribe any SMS participants in this conversation |
|
70
71
|
| [**start_conversation**](ConversationApi.md#start_conversation) | **PUT** /conversation/conversations | Start a conversation |
|
@@ -4375,6 +4376,76 @@ nil (empty response body)
|
|
4375
4376
|
- **Accept**: application/json
|
4376
4377
|
|
4377
4378
|
|
4379
|
+
## reset_conversation_pbx_queue_statistics
|
4380
|
+
|
4381
|
+
> reset_conversation_pbx_queue_statistics(queue_uuid)
|
4382
|
+
|
4383
|
+
reset statistics within the queue
|
4384
|
+
|
4385
|
+
reset statistics within the queue
|
4386
|
+
|
4387
|
+
### Examples
|
4388
|
+
|
4389
|
+
```ruby
|
4390
|
+
require 'time'
|
4391
|
+
require 'ultracart_api'
|
4392
|
+
require 'json'
|
4393
|
+
require 'yaml'
|
4394
|
+
require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
|
4395
|
+
|
4396
|
+
# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
|
4397
|
+
# As such, this might not be the best way to use this object.
|
4398
|
+
# Please see https://github.com/UltraCart/sdk_samples for working examples.
|
4399
|
+
|
4400
|
+
api = UltracartClient::ConversationApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
|
4401
|
+
queue_uuid = 'queue_uuid_example' # String |
|
4402
|
+
|
4403
|
+
begin
|
4404
|
+
# reset statistics within the queue
|
4405
|
+
api_instance.reset_conversation_pbx_queue_statistics(queue_uuid)
|
4406
|
+
rescue UltracartClient::ApiError => e
|
4407
|
+
puts "Error when calling ConversationApi->reset_conversation_pbx_queue_statistics: #{e}"
|
4408
|
+
end
|
4409
|
+
```
|
4410
|
+
|
4411
|
+
#### Using the reset_conversation_pbx_queue_statistics_with_http_info variant
|
4412
|
+
|
4413
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
4414
|
+
|
4415
|
+
> <Array(nil, Integer, Hash)> reset_conversation_pbx_queue_statistics_with_http_info(queue_uuid)
|
4416
|
+
|
4417
|
+
```ruby
|
4418
|
+
begin
|
4419
|
+
# reset statistics within the queue
|
4420
|
+
data, status_code, headers = api_instance.reset_conversation_pbx_queue_statistics_with_http_info(queue_uuid)
|
4421
|
+
p status_code # => 2xx
|
4422
|
+
p headers # => { ... }
|
4423
|
+
p data # => nil
|
4424
|
+
rescue UltracartClient::ApiError => e
|
4425
|
+
puts "Error when calling ConversationApi->reset_conversation_pbx_queue_statistics_with_http_info: #{e}"
|
4426
|
+
end
|
4427
|
+
```
|
4428
|
+
|
4429
|
+
### Parameters
|
4430
|
+
|
4431
|
+
| Name | Type | Description | Notes |
|
4432
|
+
| ---- | ---- | ----------- | ----- |
|
4433
|
+
| **queue_uuid** | **String** | | |
|
4434
|
+
|
4435
|
+
### Return type
|
4436
|
+
|
4437
|
+
nil (empty response body)
|
4438
|
+
|
4439
|
+
### Authorization
|
4440
|
+
|
4441
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
4442
|
+
|
4443
|
+
### HTTP request headers
|
4444
|
+
|
4445
|
+
- **Content-Type**: Not defined
|
4446
|
+
- **Accept**: application/json
|
4447
|
+
|
4448
|
+
|
4378
4449
|
## search_conversation_canned_messages
|
4379
4450
|
|
4380
4451
|
> <ConversationCannedMessagesResponse> search_conversation_canned_messages(search_request)
|
@@ -22,6 +22,8 @@
|
|
22
22
|
| **twilio_taskrouter_workflow_sid** | **String** | Twilio taskrouter workflow sid | [optional] |
|
23
23
|
| **twilio_workspace_queue_sid** | **String** | Twilio workspace queue sid | [optional] |
|
24
24
|
| **voicemail** | **Boolean** | If true, this queue has a voicemail associated with it | [optional] |
|
25
|
+
| **wait_critical_seconds** | **Integer** | Wait time in seconds before critical | [optional] |
|
26
|
+
| **wait_warning_seconds** | **Integer** | Wait time in seconds before warning | [optional] |
|
25
27
|
|
26
28
|
## Example
|
27
29
|
|
@@ -46,7 +48,9 @@ instance = UltracartClient::ConversationPbxQueue.new(
|
|
46
48
|
say_voice: null,
|
47
49
|
twilio_taskrouter_workflow_sid: null,
|
48
50
|
twilio_workspace_queue_sid: null,
|
49
|
-
voicemail: null
|
51
|
+
voicemail: null,
|
52
|
+
wait_critical_seconds: null,
|
53
|
+
wait_warning_seconds: null
|
50
54
|
)
|
51
55
|
```
|
52
56
|
|
@@ -0,0 +1,22 @@
|
|
1
|
+
# UltracartClient::WorkflowAgentAuth
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **jwt** | **String** | | [optional] |
|
8
|
+
| **merchant_id** | **String** | | [optional] |
|
9
|
+
| **websocket_url** | **String** | | [optional] |
|
10
|
+
|
11
|
+
## Example
|
12
|
+
|
13
|
+
```ruby
|
14
|
+
require 'ultracart_api'
|
15
|
+
|
16
|
+
instance = UltracartClient::WorkflowAgentAuth.new(
|
17
|
+
jwt: null,
|
18
|
+
merchant_id: null,
|
19
|
+
websocket_url: null
|
20
|
+
)
|
21
|
+
```
|
22
|
+
|
@@ -0,0 +1,26 @@
|
|
1
|
+
# UltracartClient::WorkflowAgentAuthResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **agent_auth** | [**WorkflowAgentAuth**](WorkflowAgentAuth.md) | | [optional] |
|
8
|
+
| **error** | [**Error**](Error.md) | | [optional] |
|
9
|
+
| **metadata** | [**ResponseMetadata**](ResponseMetadata.md) | | [optional] |
|
10
|
+
| **success** | **Boolean** | Indicates if API call was successful | [optional] |
|
11
|
+
| **warning** | [**Warning**](Warning.md) | | [optional] |
|
12
|
+
|
13
|
+
## Example
|
14
|
+
|
15
|
+
```ruby
|
16
|
+
require 'ultracart_api'
|
17
|
+
|
18
|
+
instance = UltracartClient::WorkflowAgentAuthResponse.new(
|
19
|
+
agent_auth: null,
|
20
|
+
error: null,
|
21
|
+
metadata: null,
|
22
|
+
success: null,
|
23
|
+
warning: null
|
24
|
+
)
|
25
|
+
```
|
26
|
+
|
data/docs/WorkflowApi.md
CHANGED
@@ -4,6 +4,7 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
|
|
4
4
|
|
5
5
|
| Method | HTTP request | Description |
|
6
6
|
| ------ | ------------ | ----------- |
|
7
|
+
| [**get_workflow_agent_websocket_authorization**](WorkflowApi.md#get_workflow_agent_websocket_authorization) | **PUT** /workflow/agent/auth | Get agent websocket authorization |
|
7
8
|
| [**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
9
|
| [**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
10
|
| [**get_workflow_me**](WorkflowApi.md#get_workflow_me) | **GET** /workflow/me | Retrieve a user object for myself |
|
@@ -16,6 +17,74 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
|
|
16
17
|
| [**update_workflow_task**](WorkflowApi.md#update_workflow_task) | **PUT** /workflow/tasks/{task_uuid} | Update a workflow task |
|
17
18
|
|
18
19
|
|
20
|
+
## get_workflow_agent_websocket_authorization
|
21
|
+
|
22
|
+
> <WorkflowAgentAuthResponse> get_workflow_agent_websocket_authorization
|
23
|
+
|
24
|
+
Get agent websocket authorization
|
25
|
+
|
26
|
+
Retrieve a JWT to authorize an agent to make a websocket connection.
|
27
|
+
|
28
|
+
### Examples
|
29
|
+
|
30
|
+
```ruby
|
31
|
+
require 'time'
|
32
|
+
require 'ultracart_api'
|
33
|
+
require 'json'
|
34
|
+
require 'yaml'
|
35
|
+
require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
|
36
|
+
|
37
|
+
# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
|
38
|
+
# As such, this might not be the best way to use this object.
|
39
|
+
# Please see https://github.com/UltraCart/sdk_samples for working examples.
|
40
|
+
|
41
|
+
api = UltracartClient::WorkflowApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
|
42
|
+
|
43
|
+
begin
|
44
|
+
# Get agent websocket authorization
|
45
|
+
result = api_instance.get_workflow_agent_websocket_authorization
|
46
|
+
p result
|
47
|
+
rescue UltracartClient::ApiError => e
|
48
|
+
puts "Error when calling WorkflowApi->get_workflow_agent_websocket_authorization: #{e}"
|
49
|
+
end
|
50
|
+
```
|
51
|
+
|
52
|
+
#### Using the get_workflow_agent_websocket_authorization_with_http_info variant
|
53
|
+
|
54
|
+
This returns an Array which contains the response data, status code and headers.
|
55
|
+
|
56
|
+
> <Array(<WorkflowAgentAuthResponse>, Integer, Hash)> get_workflow_agent_websocket_authorization_with_http_info
|
57
|
+
|
58
|
+
```ruby
|
59
|
+
begin
|
60
|
+
# Get agent websocket authorization
|
61
|
+
data, status_code, headers = api_instance.get_workflow_agent_websocket_authorization_with_http_info
|
62
|
+
p status_code # => 2xx
|
63
|
+
p headers # => { ... }
|
64
|
+
p data # => <WorkflowAgentAuthResponse>
|
65
|
+
rescue UltracartClient::ApiError => e
|
66
|
+
puts "Error when calling WorkflowApi->get_workflow_agent_websocket_authorization_with_http_info: #{e}"
|
67
|
+
end
|
68
|
+
```
|
69
|
+
|
70
|
+
### Parameters
|
71
|
+
|
72
|
+
This endpoint does not need any parameter.
|
73
|
+
|
74
|
+
### Return type
|
75
|
+
|
76
|
+
[**WorkflowAgentAuthResponse**](WorkflowAgentAuthResponse.md)
|
77
|
+
|
78
|
+
### Authorization
|
79
|
+
|
80
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
81
|
+
|
82
|
+
### HTTP request headers
|
83
|
+
|
84
|
+
- **Content-Type**: Not defined
|
85
|
+
- **Accept**: application/json
|
86
|
+
|
87
|
+
|
19
88
|
## get_workflow_assignment_groups
|
20
89
|
|
21
90
|
> <WorkflowGroupsResponse> get_workflow_assignment_groups(opts)
|
data/docs/WorkflowTask.md
CHANGED
@@ -14,6 +14,7 @@
|
|
14
14
|
| **delay_until_dts** | **String** | Date/time that the workflow task should delay until | [optional] |
|
15
15
|
| **dependant_workflow_task_uuid** | **String** | Dependant Workflow Task UUID (must be completed before this task can be completed) | [optional] |
|
16
16
|
| **due_dts** | **String** | Date/time that the workflow task is due | [optional] |
|
17
|
+
| **expiration_dts** | **String** | Date/time that the workflow task will expire and be closed. This is set by system generated tasks. | [optional] |
|
17
18
|
| **histories** | [**Array<WorkflowTaskHistory>**](WorkflowTaskHistory.md) | Array of history records for the task | [optional] |
|
18
19
|
| **last_update_dts** | **String** | Date/time that the workflow task was last updated | [optional] |
|
19
20
|
| **merchant_id** | **String** | Merchant ID | [optional] |
|
@@ -26,6 +27,7 @@
|
|
26
27
|
| **properties** | [**Array<Property>**](Property.md) | Properties | [optional] |
|
27
28
|
| **related_workflow_task_uuid** | **String** | Related Workflow Task UUID | [optional] |
|
28
29
|
| **status** | **String** | Status of the workflow task | [optional] |
|
30
|
+
| **system_task_type** | **String** | Constant for the type of system generated task | [optional] |
|
29
31
|
| **tags** | **Array<String>** | Tags | [optional] |
|
30
32
|
| **task_context** | **String** | User friendly string of the task context | [optional] |
|
31
33
|
| **task_details** | **String** | Task Details | [optional] |
|
@@ -48,6 +50,7 @@ instance = UltracartClient::WorkflowTask.new(
|
|
48
50
|
delay_until_dts: null,
|
49
51
|
dependant_workflow_task_uuid: null,
|
50
52
|
due_dts: null,
|
53
|
+
expiration_dts: null,
|
51
54
|
histories: null,
|
52
55
|
last_update_dts: null,
|
53
56
|
merchant_id: null,
|
@@ -60,6 +63,7 @@ instance = UltracartClient::WorkflowTask.new(
|
|
60
63
|
properties: null,
|
61
64
|
related_workflow_task_uuid: null,
|
62
65
|
status: null,
|
66
|
+
system_task_type: null,
|
63
67
|
tags: null,
|
64
68
|
task_context: null,
|
65
69
|
task_details: null,
|
@@ -3923,6 +3923,70 @@ module UltracartClient
|
|
3923
3923
|
return data, status_code, headers
|
3924
3924
|
end
|
3925
3925
|
|
3926
|
+
# reset statistics within the queue
|
3927
|
+
# reset statistics within the queue
|
3928
|
+
# @param queue_uuid [String]
|
3929
|
+
# @param [Hash] opts the optional parameters
|
3930
|
+
# @return [nil]
|
3931
|
+
def reset_conversation_pbx_queue_statistics(queue_uuid, opts = {})
|
3932
|
+
reset_conversation_pbx_queue_statistics_with_http_info(queue_uuid, opts)
|
3933
|
+
nil
|
3934
|
+
end
|
3935
|
+
|
3936
|
+
# reset statistics within the queue
|
3937
|
+
# reset statistics within the queue
|
3938
|
+
# @param queue_uuid [String]
|
3939
|
+
# @param [Hash] opts the optional parameters
|
3940
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
3941
|
+
def reset_conversation_pbx_queue_statistics_with_http_info(queue_uuid, opts = {})
|
3942
|
+
if @api_client.config.debugging
|
3943
|
+
@api_client.config.logger.debug 'Calling API: ConversationApi.reset_conversation_pbx_queue_statistics ...'
|
3944
|
+
end
|
3945
|
+
# verify the required parameter 'queue_uuid' is set
|
3946
|
+
if @api_client.config.client_side_validation && queue_uuid.nil?
|
3947
|
+
fail ArgumentError, "Missing the required parameter 'queue_uuid' when calling ConversationApi.reset_conversation_pbx_queue_statistics"
|
3948
|
+
end
|
3949
|
+
# resource path
|
3950
|
+
local_var_path = '/conversation/pbx/queues/{queue_uuid}/reset_statistics'.sub('{' + 'queue_uuid' + '}', CGI.escape(queue_uuid.to_s))
|
3951
|
+
|
3952
|
+
# query parameters
|
3953
|
+
query_params = opts[:query_params] || {}
|
3954
|
+
|
3955
|
+
# header parameters
|
3956
|
+
header_params = opts[:header_params] || {}
|
3957
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
3958
|
+
# HTTP header 'Accept' (if needed)
|
3959
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
3960
|
+
|
3961
|
+
# form parameters
|
3962
|
+
form_params = opts[:form_params] || {}
|
3963
|
+
|
3964
|
+
# http body (model)
|
3965
|
+
post_body = opts[:debug_body]
|
3966
|
+
|
3967
|
+
# return_type
|
3968
|
+
return_type = opts[:debug_return_type]
|
3969
|
+
|
3970
|
+
# auth_names
|
3971
|
+
auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
3972
|
+
|
3973
|
+
new_options = opts.merge(
|
3974
|
+
:operation => :"ConversationApi.reset_conversation_pbx_queue_statistics",
|
3975
|
+
:header_params => header_params,
|
3976
|
+
:query_params => query_params,
|
3977
|
+
:form_params => form_params,
|
3978
|
+
:body => post_body,
|
3979
|
+
:auth_names => auth_names,
|
3980
|
+
:return_type => return_type
|
3981
|
+
)
|
3982
|
+
|
3983
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
3984
|
+
if @api_client.config.debugging
|
3985
|
+
@api_client.config.logger.debug "API called: ConversationApi#reset_conversation_pbx_queue_statistics\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
3986
|
+
end
|
3987
|
+
return data, status_code, headers
|
3988
|
+
end
|
3989
|
+
|
3926
3990
|
# Search for canned messages by short_code
|
3927
3991
|
# Search for canned messages by short_code
|
3928
3992
|
# @param search_request [ConversationCannedMessagesSearch] Search request
|
@@ -32,6 +32,64 @@ module UltracartClient
|
|
32
32
|
UltracartClient::WorkflowApi.new(api_client)
|
33
33
|
end
|
34
34
|
|
35
|
+
# Get agent websocket authorization
|
36
|
+
# Retrieve a JWT to authorize an agent to make a websocket connection.
|
37
|
+
# @param [Hash] opts the optional parameters
|
38
|
+
# @return [WorkflowAgentAuthResponse]
|
39
|
+
def get_workflow_agent_websocket_authorization(opts = {})
|
40
|
+
data, _status_code, _headers = get_workflow_agent_websocket_authorization_with_http_info(opts)
|
41
|
+
data
|
42
|
+
end
|
43
|
+
|
44
|
+
# Get agent websocket authorization
|
45
|
+
# Retrieve a JWT to authorize an agent to make a websocket connection.
|
46
|
+
# @param [Hash] opts the optional parameters
|
47
|
+
# @return [Array<(WorkflowAgentAuthResponse, Integer, Hash)>] WorkflowAgentAuthResponse data, response status code and response headers
|
48
|
+
def get_workflow_agent_websocket_authorization_with_http_info(opts = {})
|
49
|
+
if @api_client.config.debugging
|
50
|
+
@api_client.config.logger.debug 'Calling API: WorkflowApi.get_workflow_agent_websocket_authorization ...'
|
51
|
+
end
|
52
|
+
# resource path
|
53
|
+
local_var_path = '/workflow/agent/auth'
|
54
|
+
|
55
|
+
# query parameters
|
56
|
+
query_params = opts[:query_params] || {}
|
57
|
+
|
58
|
+
# header parameters
|
59
|
+
header_params = opts[:header_params] || {}
|
60
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
61
|
+
# HTTP header 'Accept' (if needed)
|
62
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
63
|
+
|
64
|
+
# form parameters
|
65
|
+
form_params = opts[:form_params] || {}
|
66
|
+
|
67
|
+
# http body (model)
|
68
|
+
post_body = opts[:debug_body]
|
69
|
+
|
70
|
+
# return_type
|
71
|
+
return_type = opts[:debug_return_type] || 'WorkflowAgentAuthResponse'
|
72
|
+
|
73
|
+
# auth_names
|
74
|
+
auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
75
|
+
|
76
|
+
new_options = opts.merge(
|
77
|
+
:operation => :"WorkflowApi.get_workflow_agent_websocket_authorization",
|
78
|
+
:header_params => header_params,
|
79
|
+
:query_params => query_params,
|
80
|
+
:form_params => form_params,
|
81
|
+
:body => post_body,
|
82
|
+
:auth_names => auth_names,
|
83
|
+
:return_type => return_type
|
84
|
+
)
|
85
|
+
|
86
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
|
87
|
+
if @api_client.config.debugging
|
88
|
+
@api_client.config.logger.debug "API called: WorkflowApi#get_workflow_agent_websocket_authorization\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
89
|
+
end
|
90
|
+
return data, status_code, headers
|
91
|
+
end
|
92
|
+
|
35
93
|
# Retrieve a list of groups that workflow tasks can be assigned to
|
36
94
|
# Retrieve a list of groups that workflow tasks can be assigned to
|
37
95
|
# @param [Hash] opts the optional parameters
|
@@ -68,6 +68,12 @@ module UltracartClient
|
|
68
68
|
# If true, this queue has a voicemail associated with it
|
69
69
|
attr_accessor :voicemail
|
70
70
|
|
71
|
+
# Wait time in seconds before critical
|
72
|
+
attr_accessor :wait_critical_seconds
|
73
|
+
|
74
|
+
# Wait time in seconds before warning
|
75
|
+
attr_accessor :wait_warning_seconds
|
76
|
+
|
71
77
|
# Attribute mapping from ruby-style variable name to JSON key.
|
72
78
|
def self.attribute_map
|
73
79
|
{
|
@@ -88,7 +94,9 @@ module UltracartClient
|
|
88
94
|
:'say_voice' => :'say_voice',
|
89
95
|
:'twilio_taskrouter_workflow_sid' => :'twilio_taskrouter_workflow_sid',
|
90
96
|
:'twilio_workspace_queue_sid' => :'twilio_workspace_queue_sid',
|
91
|
-
:'voicemail' => :'voicemail'
|
97
|
+
:'voicemail' => :'voicemail',
|
98
|
+
:'wait_critical_seconds' => :'wait_critical_seconds',
|
99
|
+
:'wait_warning_seconds' => :'wait_warning_seconds'
|
92
100
|
}
|
93
101
|
end
|
94
102
|
|
@@ -117,7 +125,9 @@ module UltracartClient
|
|
117
125
|
:'say_voice' => :'String',
|
118
126
|
:'twilio_taskrouter_workflow_sid' => :'String',
|
119
127
|
:'twilio_workspace_queue_sid' => :'String',
|
120
|
-
:'voicemail' => :'Boolean'
|
128
|
+
:'voicemail' => :'Boolean',
|
129
|
+
:'wait_critical_seconds' => :'Integer',
|
130
|
+
:'wait_warning_seconds' => :'Integer'
|
121
131
|
}
|
122
132
|
end
|
123
133
|
|
@@ -213,6 +223,14 @@ module UltracartClient
|
|
213
223
|
if attributes.key?(:'voicemail')
|
214
224
|
self.voicemail = attributes[:'voicemail']
|
215
225
|
end
|
226
|
+
|
227
|
+
if attributes.key?(:'wait_critical_seconds')
|
228
|
+
self.wait_critical_seconds = attributes[:'wait_critical_seconds']
|
229
|
+
end
|
230
|
+
|
231
|
+
if attributes.key?(:'wait_warning_seconds')
|
232
|
+
self.wait_warning_seconds = attributes[:'wait_warning_seconds']
|
233
|
+
end
|
216
234
|
end
|
217
235
|
|
218
236
|
# Show invalid properties with the reasons. Usually used together with valid?
|
@@ -400,7 +418,9 @@ module UltracartClient
|
|
400
418
|
say_voice == o.say_voice &&
|
401
419
|
twilio_taskrouter_workflow_sid == o.twilio_taskrouter_workflow_sid &&
|
402
420
|
twilio_workspace_queue_sid == o.twilio_workspace_queue_sid &&
|
403
|
-
voicemail == o.voicemail
|
421
|
+
voicemail == o.voicemail &&
|
422
|
+
wait_critical_seconds == o.wait_critical_seconds &&
|
423
|
+
wait_warning_seconds == o.wait_warning_seconds
|
404
424
|
end
|
405
425
|
|
406
426
|
# @see the `==` method
|
@@ -412,7 +432,7 @@ module UltracartClient
|
|
412
432
|
# Calculates hash code according to all attributes.
|
413
433
|
# @return [Integer] Hash code
|
414
434
|
def hash
|
415
|
-
[announce_queue_position, conversation_pbx_queue_uuid, conversation_voicemail_mailbox_uuid, hold_conversation_pbx_audio_uuid, max_hold_seconds, members, merchant_id, name, no_agent_available_play_audio_uuid, no_agent_available_say, no_agent_available_say_voice, play_audio_uuid, record_call, say, say_voice, twilio_taskrouter_workflow_sid, twilio_workspace_queue_sid, voicemail].hash
|
435
|
+
[announce_queue_position, conversation_pbx_queue_uuid, conversation_voicemail_mailbox_uuid, hold_conversation_pbx_audio_uuid, max_hold_seconds, members, merchant_id, name, no_agent_available_play_audio_uuid, no_agent_available_say, no_agent_available_say_voice, play_audio_uuid, record_call, say, say_voice, twilio_taskrouter_workflow_sid, twilio_workspace_queue_sid, voicemail, wait_critical_seconds, wait_warning_seconds].hash
|
416
436
|
end
|
417
437
|
|
418
438
|
# Builds the object from hash
|
@@ -0,0 +1,237 @@
|
|
1
|
+
=begin
|
2
|
+
#UltraCart Rest API V2
|
3
|
+
|
4
|
+
#UltraCart REST API Version 2
|
5
|
+
|
6
|
+
The version of the OpenAPI document: 2.0.0
|
7
|
+
Contact: support@ultracart.com
|
8
|
+
Generated by: https://openapi-generator.tech
|
9
|
+
OpenAPI Generator version: 6.0.1-SNAPSHOT
|
10
|
+
|
11
|
+
=end
|
12
|
+
|
13
|
+
require 'date'
|
14
|
+
require 'time'
|
15
|
+
|
16
|
+
module UltracartClient
|
17
|
+
class WorkflowAgentAuth
|
18
|
+
attr_accessor :jwt
|
19
|
+
|
20
|
+
attr_accessor :merchant_id
|
21
|
+
|
22
|
+
attr_accessor :websocket_url
|
23
|
+
|
24
|
+
# Attribute mapping from ruby-style variable name to JSON key.
|
25
|
+
def self.attribute_map
|
26
|
+
{
|
27
|
+
:'jwt' => :'jwt',
|
28
|
+
:'merchant_id' => :'merchant_id',
|
29
|
+
:'websocket_url' => :'websocket_url'
|
30
|
+
}
|
31
|
+
end
|
32
|
+
|
33
|
+
# Returns all the JSON keys this model knows about
|
34
|
+
def self.acceptable_attributes
|
35
|
+
attribute_map.values
|
36
|
+
end
|
37
|
+
|
38
|
+
# Attribute type mapping.
|
39
|
+
def self.openapi_types
|
40
|
+
{
|
41
|
+
:'jwt' => :'String',
|
42
|
+
:'merchant_id' => :'String',
|
43
|
+
:'websocket_url' => :'String'
|
44
|
+
}
|
45
|
+
end
|
46
|
+
|
47
|
+
# List of attributes with nullable: true
|
48
|
+
def self.openapi_nullable
|
49
|
+
Set.new([
|
50
|
+
])
|
51
|
+
end
|
52
|
+
|
53
|
+
# Initializes the object
|
54
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
55
|
+
def initialize(attributes = {})
|
56
|
+
if (!attributes.is_a?(Hash))
|
57
|
+
fail ArgumentError, "The input argument (attributes) must be a hash in `UltracartClient::WorkflowAgentAuth` initialize method"
|
58
|
+
end
|
59
|
+
|
60
|
+
# check to see if the attribute exists and convert string to symbol for hash key
|
61
|
+
attributes = attributes.each_with_object({}) { |(k, v), h|
|
62
|
+
if (!self.class.attribute_map.key?(k.to_sym))
|
63
|
+
fail ArgumentError, "`#{k}` is not a valid attribute in `UltracartClient::WorkflowAgentAuth`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
|
64
|
+
end
|
65
|
+
h[k.to_sym] = v
|
66
|
+
}
|
67
|
+
|
68
|
+
if attributes.key?(:'jwt')
|
69
|
+
self.jwt = attributes[:'jwt']
|
70
|
+
end
|
71
|
+
|
72
|
+
if attributes.key?(:'merchant_id')
|
73
|
+
self.merchant_id = attributes[:'merchant_id']
|
74
|
+
end
|
75
|
+
|
76
|
+
if attributes.key?(:'websocket_url')
|
77
|
+
self.websocket_url = attributes[:'websocket_url']
|
78
|
+
end
|
79
|
+
end
|
80
|
+
|
81
|
+
# Show invalid properties with the reasons. Usually used together with valid?
|
82
|
+
# @return Array for valid properties with the reasons
|
83
|
+
def list_invalid_properties
|
84
|
+
invalid_properties = Array.new
|
85
|
+
invalid_properties
|
86
|
+
end
|
87
|
+
|
88
|
+
# Check to see if the all the properties in the model are valid
|
89
|
+
# @return true if the model is valid
|
90
|
+
def valid?
|
91
|
+
true
|
92
|
+
end
|
93
|
+
|
94
|
+
# Checks equality by comparing each attribute.
|
95
|
+
# @param [Object] Object to be compared
|
96
|
+
def ==(o)
|
97
|
+
return true if self.equal?(o)
|
98
|
+
self.class == o.class &&
|
99
|
+
jwt == o.jwt &&
|
100
|
+
merchant_id == o.merchant_id &&
|
101
|
+
websocket_url == o.websocket_url
|
102
|
+
end
|
103
|
+
|
104
|
+
# @see the `==` method
|
105
|
+
# @param [Object] Object to be compared
|
106
|
+
def eql?(o)
|
107
|
+
self == o
|
108
|
+
end
|
109
|
+
|
110
|
+
# Calculates hash code according to all attributes.
|
111
|
+
# @return [Integer] Hash code
|
112
|
+
def hash
|
113
|
+
[jwt, merchant_id, websocket_url].hash
|
114
|
+
end
|
115
|
+
|
116
|
+
# Builds the object from hash
|
117
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
118
|
+
# @return [Object] Returns the model itself
|
119
|
+
def self.build_from_hash(attributes)
|
120
|
+
new.build_from_hash(attributes)
|
121
|
+
end
|
122
|
+
|
123
|
+
# Builds the object from hash
|
124
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
125
|
+
# @return [Object] Returns the model itself
|
126
|
+
def build_from_hash(attributes)
|
127
|
+
return nil unless attributes.is_a?(Hash)
|
128
|
+
attributes = attributes.transform_keys(&:to_sym)
|
129
|
+
self.class.openapi_types.each_pair do |key, type|
|
130
|
+
if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
|
131
|
+
self.send("#{key}=", nil)
|
132
|
+
elsif type =~ /\AArray<(.*)>/i
|
133
|
+
# check to ensure the input is an array given that the attribute
|
134
|
+
# is documented as an array but the input is not
|
135
|
+
if attributes[self.class.attribute_map[key]].is_a?(Array)
|
136
|
+
self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
|
137
|
+
end
|
138
|
+
elsif !attributes[self.class.attribute_map[key]].nil?
|
139
|
+
self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
|
140
|
+
end
|
141
|
+
end
|
142
|
+
|
143
|
+
self
|
144
|
+
end
|
145
|
+
|
146
|
+
# Deserializes the data based on type
|
147
|
+
# @param string type Data type
|
148
|
+
# @param string value Value to be deserialized
|
149
|
+
# @return [Object] Deserialized data
|
150
|
+
def _deserialize(type, value)
|
151
|
+
case type.to_sym
|
152
|
+
when :Time
|
153
|
+
Time.parse(value)
|
154
|
+
when :Date
|
155
|
+
Date.parse(value)
|
156
|
+
when :String
|
157
|
+
value.to_s
|
158
|
+
when :Integer
|
159
|
+
value.to_i
|
160
|
+
when :Float
|
161
|
+
value.to_f
|
162
|
+
when :Boolean
|
163
|
+
if value.to_s =~ /\A(true|t|yes|y|1)\z/i
|
164
|
+
true
|
165
|
+
else
|
166
|
+
false
|
167
|
+
end
|
168
|
+
when :Object
|
169
|
+
# generic object (usually a Hash), return directly
|
170
|
+
value
|
171
|
+
when /\AArray<(?<inner_type>.+)>\z/
|
172
|
+
inner_type = Regexp.last_match[:inner_type]
|
173
|
+
value.map { |v| _deserialize(inner_type, v) }
|
174
|
+
when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
|
175
|
+
k_type = Regexp.last_match[:k_type]
|
176
|
+
v_type = Regexp.last_match[:v_type]
|
177
|
+
{}.tap do |hash|
|
178
|
+
value.each do |k, v|
|
179
|
+
hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
|
180
|
+
end
|
181
|
+
end
|
182
|
+
else # model
|
183
|
+
# models (e.g. Pet) or oneOf
|
184
|
+
klass = UltracartClient.const_get(type)
|
185
|
+
klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
|
186
|
+
end
|
187
|
+
end
|
188
|
+
|
189
|
+
# Returns the string representation of the object
|
190
|
+
# @return [String] String presentation of the object
|
191
|
+
def to_s
|
192
|
+
to_hash.to_s
|
193
|
+
end
|
194
|
+
|
195
|
+
# to_body is an alias to to_hash (backward compatibility)
|
196
|
+
# @return [Hash] Returns the object in the form of hash
|
197
|
+
def to_body
|
198
|
+
to_hash
|
199
|
+
end
|
200
|
+
|
201
|
+
# Returns the object in the form of hash
|
202
|
+
# @return [Hash] Returns the object in the form of hash
|
203
|
+
def to_hash
|
204
|
+
hash = {}
|
205
|
+
self.class.attribute_map.each_pair do |attr, param|
|
206
|
+
value = self.send(attr)
|
207
|
+
if value.nil?
|
208
|
+
is_nullable = self.class.openapi_nullable.include?(attr)
|
209
|
+
next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
|
210
|
+
end
|
211
|
+
|
212
|
+
hash[param] = _to_hash(value)
|
213
|
+
end
|
214
|
+
hash
|
215
|
+
end
|
216
|
+
|
217
|
+
# Outputs non-array value in the form of hash
|
218
|
+
# For object, use to_hash. Otherwise, just return the value
|
219
|
+
# @param [Object] value Any valid value
|
220
|
+
# @return [Hash] Returns the value in the form of hash
|
221
|
+
def _to_hash(value)
|
222
|
+
if value.is_a?(Array)
|
223
|
+
value.compact.map { |v| _to_hash(v) }
|
224
|
+
elsif value.is_a?(Hash)
|
225
|
+
{}.tap do |hash|
|
226
|
+
value.each { |k, v| hash[k] = _to_hash(v) }
|
227
|
+
end
|
228
|
+
elsif value.respond_to? :to_hash
|
229
|
+
value.to_hash
|
230
|
+
else
|
231
|
+
value
|
232
|
+
end
|
233
|
+
end
|
234
|
+
|
235
|
+
end
|
236
|
+
|
237
|
+
end
|
@@ -0,0 +1,256 @@
|
|
1
|
+
=begin
|
2
|
+
#UltraCart Rest API V2
|
3
|
+
|
4
|
+
#UltraCart REST API Version 2
|
5
|
+
|
6
|
+
The version of the OpenAPI document: 2.0.0
|
7
|
+
Contact: support@ultracart.com
|
8
|
+
Generated by: https://openapi-generator.tech
|
9
|
+
OpenAPI Generator version: 6.0.1-SNAPSHOT
|
10
|
+
|
11
|
+
=end
|
12
|
+
|
13
|
+
require 'date'
|
14
|
+
require 'time'
|
15
|
+
|
16
|
+
module UltracartClient
|
17
|
+
class WorkflowAgentAuthResponse
|
18
|
+
attr_accessor :agent_auth
|
19
|
+
|
20
|
+
attr_accessor :error
|
21
|
+
|
22
|
+
attr_accessor :metadata
|
23
|
+
|
24
|
+
# Indicates if API call was successful
|
25
|
+
attr_accessor :success
|
26
|
+
|
27
|
+
attr_accessor :warning
|
28
|
+
|
29
|
+
# Attribute mapping from ruby-style variable name to JSON key.
|
30
|
+
def self.attribute_map
|
31
|
+
{
|
32
|
+
:'agent_auth' => :'agent_auth',
|
33
|
+
:'error' => :'error',
|
34
|
+
:'metadata' => :'metadata',
|
35
|
+
:'success' => :'success',
|
36
|
+
:'warning' => :'warning'
|
37
|
+
}
|
38
|
+
end
|
39
|
+
|
40
|
+
# Returns all the JSON keys this model knows about
|
41
|
+
def self.acceptable_attributes
|
42
|
+
attribute_map.values
|
43
|
+
end
|
44
|
+
|
45
|
+
# Attribute type mapping.
|
46
|
+
def self.openapi_types
|
47
|
+
{
|
48
|
+
:'agent_auth' => :'WorkflowAgentAuth',
|
49
|
+
:'error' => :'Error',
|
50
|
+
:'metadata' => :'ResponseMetadata',
|
51
|
+
:'success' => :'Boolean',
|
52
|
+
:'warning' => :'Warning'
|
53
|
+
}
|
54
|
+
end
|
55
|
+
|
56
|
+
# List of attributes with nullable: true
|
57
|
+
def self.openapi_nullable
|
58
|
+
Set.new([
|
59
|
+
])
|
60
|
+
end
|
61
|
+
|
62
|
+
# Initializes the object
|
63
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
64
|
+
def initialize(attributes = {})
|
65
|
+
if (!attributes.is_a?(Hash))
|
66
|
+
fail ArgumentError, "The input argument (attributes) must be a hash in `UltracartClient::WorkflowAgentAuthResponse` initialize method"
|
67
|
+
end
|
68
|
+
|
69
|
+
# check to see if the attribute exists and convert string to symbol for hash key
|
70
|
+
attributes = attributes.each_with_object({}) { |(k, v), h|
|
71
|
+
if (!self.class.attribute_map.key?(k.to_sym))
|
72
|
+
fail ArgumentError, "`#{k}` is not a valid attribute in `UltracartClient::WorkflowAgentAuthResponse`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
|
73
|
+
end
|
74
|
+
h[k.to_sym] = v
|
75
|
+
}
|
76
|
+
|
77
|
+
if attributes.key?(:'agent_auth')
|
78
|
+
self.agent_auth = attributes[:'agent_auth']
|
79
|
+
end
|
80
|
+
|
81
|
+
if attributes.key?(:'error')
|
82
|
+
self.error = attributes[:'error']
|
83
|
+
end
|
84
|
+
|
85
|
+
if attributes.key?(:'metadata')
|
86
|
+
self.metadata = attributes[:'metadata']
|
87
|
+
end
|
88
|
+
|
89
|
+
if attributes.key?(:'success')
|
90
|
+
self.success = attributes[:'success']
|
91
|
+
end
|
92
|
+
|
93
|
+
if attributes.key?(:'warning')
|
94
|
+
self.warning = attributes[:'warning']
|
95
|
+
end
|
96
|
+
end
|
97
|
+
|
98
|
+
# Show invalid properties with the reasons. Usually used together with valid?
|
99
|
+
# @return Array for valid properties with the reasons
|
100
|
+
def list_invalid_properties
|
101
|
+
invalid_properties = Array.new
|
102
|
+
invalid_properties
|
103
|
+
end
|
104
|
+
|
105
|
+
# Check to see if the all the properties in the model are valid
|
106
|
+
# @return true if the model is valid
|
107
|
+
def valid?
|
108
|
+
true
|
109
|
+
end
|
110
|
+
|
111
|
+
# Checks equality by comparing each attribute.
|
112
|
+
# @param [Object] Object to be compared
|
113
|
+
def ==(o)
|
114
|
+
return true if self.equal?(o)
|
115
|
+
self.class == o.class &&
|
116
|
+
agent_auth == o.agent_auth &&
|
117
|
+
error == o.error &&
|
118
|
+
metadata == o.metadata &&
|
119
|
+
success == o.success &&
|
120
|
+
warning == o.warning
|
121
|
+
end
|
122
|
+
|
123
|
+
# @see the `==` method
|
124
|
+
# @param [Object] Object to be compared
|
125
|
+
def eql?(o)
|
126
|
+
self == o
|
127
|
+
end
|
128
|
+
|
129
|
+
# Calculates hash code according to all attributes.
|
130
|
+
# @return [Integer] Hash code
|
131
|
+
def hash
|
132
|
+
[agent_auth, error, metadata, success, warning].hash
|
133
|
+
end
|
134
|
+
|
135
|
+
# Builds the object from hash
|
136
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
137
|
+
# @return [Object] Returns the model itself
|
138
|
+
def self.build_from_hash(attributes)
|
139
|
+
new.build_from_hash(attributes)
|
140
|
+
end
|
141
|
+
|
142
|
+
# Builds the object from hash
|
143
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
144
|
+
# @return [Object] Returns the model itself
|
145
|
+
def build_from_hash(attributes)
|
146
|
+
return nil unless attributes.is_a?(Hash)
|
147
|
+
attributes = attributes.transform_keys(&:to_sym)
|
148
|
+
self.class.openapi_types.each_pair do |key, type|
|
149
|
+
if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
|
150
|
+
self.send("#{key}=", nil)
|
151
|
+
elsif type =~ /\AArray<(.*)>/i
|
152
|
+
# check to ensure the input is an array given that the attribute
|
153
|
+
# is documented as an array but the input is not
|
154
|
+
if attributes[self.class.attribute_map[key]].is_a?(Array)
|
155
|
+
self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
|
156
|
+
end
|
157
|
+
elsif !attributes[self.class.attribute_map[key]].nil?
|
158
|
+
self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
|
159
|
+
end
|
160
|
+
end
|
161
|
+
|
162
|
+
self
|
163
|
+
end
|
164
|
+
|
165
|
+
# Deserializes the data based on type
|
166
|
+
# @param string type Data type
|
167
|
+
# @param string value Value to be deserialized
|
168
|
+
# @return [Object] Deserialized data
|
169
|
+
def _deserialize(type, value)
|
170
|
+
case type.to_sym
|
171
|
+
when :Time
|
172
|
+
Time.parse(value)
|
173
|
+
when :Date
|
174
|
+
Date.parse(value)
|
175
|
+
when :String
|
176
|
+
value.to_s
|
177
|
+
when :Integer
|
178
|
+
value.to_i
|
179
|
+
when :Float
|
180
|
+
value.to_f
|
181
|
+
when :Boolean
|
182
|
+
if value.to_s =~ /\A(true|t|yes|y|1)\z/i
|
183
|
+
true
|
184
|
+
else
|
185
|
+
false
|
186
|
+
end
|
187
|
+
when :Object
|
188
|
+
# generic object (usually a Hash), return directly
|
189
|
+
value
|
190
|
+
when /\AArray<(?<inner_type>.+)>\z/
|
191
|
+
inner_type = Regexp.last_match[:inner_type]
|
192
|
+
value.map { |v| _deserialize(inner_type, v) }
|
193
|
+
when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
|
194
|
+
k_type = Regexp.last_match[:k_type]
|
195
|
+
v_type = Regexp.last_match[:v_type]
|
196
|
+
{}.tap do |hash|
|
197
|
+
value.each do |k, v|
|
198
|
+
hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
|
199
|
+
end
|
200
|
+
end
|
201
|
+
else # model
|
202
|
+
# models (e.g. Pet) or oneOf
|
203
|
+
klass = UltracartClient.const_get(type)
|
204
|
+
klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
|
205
|
+
end
|
206
|
+
end
|
207
|
+
|
208
|
+
# Returns the string representation of the object
|
209
|
+
# @return [String] String presentation of the object
|
210
|
+
def to_s
|
211
|
+
to_hash.to_s
|
212
|
+
end
|
213
|
+
|
214
|
+
# to_body is an alias to to_hash (backward compatibility)
|
215
|
+
# @return [Hash] Returns the object in the form of hash
|
216
|
+
def to_body
|
217
|
+
to_hash
|
218
|
+
end
|
219
|
+
|
220
|
+
# Returns the object in the form of hash
|
221
|
+
# @return [Hash] Returns the object in the form of hash
|
222
|
+
def to_hash
|
223
|
+
hash = {}
|
224
|
+
self.class.attribute_map.each_pair do |attr, param|
|
225
|
+
value = self.send(attr)
|
226
|
+
if value.nil?
|
227
|
+
is_nullable = self.class.openapi_nullable.include?(attr)
|
228
|
+
next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
|
229
|
+
end
|
230
|
+
|
231
|
+
hash[param] = _to_hash(value)
|
232
|
+
end
|
233
|
+
hash
|
234
|
+
end
|
235
|
+
|
236
|
+
# Outputs non-array value in the form of hash
|
237
|
+
# For object, use to_hash. Otherwise, just return the value
|
238
|
+
# @param [Object] value Any valid value
|
239
|
+
# @return [Hash] Returns the value in the form of hash
|
240
|
+
def _to_hash(value)
|
241
|
+
if value.is_a?(Array)
|
242
|
+
value.compact.map { |v| _to_hash(v) }
|
243
|
+
elsif value.is_a?(Hash)
|
244
|
+
{}.tap do |hash|
|
245
|
+
value.each { |k, v| hash[k] = _to_hash(v) }
|
246
|
+
end
|
247
|
+
elsif value.respond_to? :to_hash
|
248
|
+
value.to_hash
|
249
|
+
else
|
250
|
+
value
|
251
|
+
end
|
252
|
+
end
|
253
|
+
|
254
|
+
end
|
255
|
+
|
256
|
+
end
|
@@ -44,6 +44,9 @@ module UltracartClient
|
|
44
44
|
# Date/time that the workflow task is due
|
45
45
|
attr_accessor :due_dts
|
46
46
|
|
47
|
+
# Date/time that the workflow task will expire and be closed. This is set by system generated tasks.
|
48
|
+
attr_accessor :expiration_dts
|
49
|
+
|
47
50
|
# Array of history records for the task
|
48
51
|
attr_accessor :histories
|
49
52
|
|
@@ -80,6 +83,9 @@ module UltracartClient
|
|
80
83
|
# Status of the workflow task
|
81
84
|
attr_accessor :status
|
82
85
|
|
86
|
+
# Constant for the type of system generated task
|
87
|
+
attr_accessor :system_task_type
|
88
|
+
|
83
89
|
# Tags
|
84
90
|
attr_accessor :tags
|
85
91
|
|
@@ -130,6 +136,7 @@ module UltracartClient
|
|
130
136
|
:'delay_until_dts' => :'delay_until_dts',
|
131
137
|
:'dependant_workflow_task_uuid' => :'dependant_workflow_task_uuid',
|
132
138
|
:'due_dts' => :'due_dts',
|
139
|
+
:'expiration_dts' => :'expiration_dts',
|
133
140
|
:'histories' => :'histories',
|
134
141
|
:'last_update_dts' => :'last_update_dts',
|
135
142
|
:'merchant_id' => :'merchant_id',
|
@@ -142,6 +149,7 @@ module UltracartClient
|
|
142
149
|
:'properties' => :'properties',
|
143
150
|
:'related_workflow_task_uuid' => :'related_workflow_task_uuid',
|
144
151
|
:'status' => :'status',
|
152
|
+
:'system_task_type' => :'system_task_type',
|
145
153
|
:'tags' => :'tags',
|
146
154
|
:'task_context' => :'task_context',
|
147
155
|
:'task_details' => :'task_details',
|
@@ -168,6 +176,7 @@ module UltracartClient
|
|
168
176
|
:'delay_until_dts' => :'String',
|
169
177
|
:'dependant_workflow_task_uuid' => :'String',
|
170
178
|
:'due_dts' => :'String',
|
179
|
+
:'expiration_dts' => :'String',
|
171
180
|
:'histories' => :'Array<WorkflowTaskHistory>',
|
172
181
|
:'last_update_dts' => :'String',
|
173
182
|
:'merchant_id' => :'String',
|
@@ -180,6 +189,7 @@ module UltracartClient
|
|
180
189
|
:'properties' => :'Array<Property>',
|
181
190
|
:'related_workflow_task_uuid' => :'String',
|
182
191
|
:'status' => :'String',
|
192
|
+
:'system_task_type' => :'String',
|
183
193
|
:'tags' => :'Array<String>',
|
184
194
|
:'task_context' => :'String',
|
185
195
|
:'task_details' => :'String',
|
@@ -251,6 +261,10 @@ module UltracartClient
|
|
251
261
|
self.due_dts = attributes[:'due_dts']
|
252
262
|
end
|
253
263
|
|
264
|
+
if attributes.key?(:'expiration_dts')
|
265
|
+
self.expiration_dts = attributes[:'expiration_dts']
|
266
|
+
end
|
267
|
+
|
254
268
|
if attributes.key?(:'histories')
|
255
269
|
if (value = attributes[:'histories']).is_a?(Array)
|
256
270
|
self.histories = value
|
@@ -305,6 +319,10 @@ module UltracartClient
|
|
305
319
|
self.status = attributes[:'status']
|
306
320
|
end
|
307
321
|
|
322
|
+
if attributes.key?(:'system_task_type')
|
323
|
+
self.system_task_type = attributes[:'system_task_type']
|
324
|
+
end
|
325
|
+
|
308
326
|
if attributes.key?(:'tags')
|
309
327
|
if (value = attributes[:'tags']).is_a?(Array)
|
310
328
|
self.tags = value
|
@@ -342,8 +360,10 @@ module UltracartClient
|
|
342
360
|
return false unless object_type_validator.valid?(@object_type)
|
343
361
|
priority_validator = EnumAttributeValidator.new('String', ["1 - low", "2 - medium", "3 - high", "4 - critical"])
|
344
362
|
return false unless priority_validator.valid?(@priority)
|
345
|
-
status_validator = EnumAttributeValidator.new('String', ["open", "closed", "delayed", "awaiting customer feedback"])
|
363
|
+
status_validator = EnumAttributeValidator.new('String', ["open", "closed", "delayed", "awaiting customer feedback", "closed - system", "closed - customer", "closed - expiration"])
|
346
364
|
return false unless status_validator.valid?(@status)
|
365
|
+
system_task_type_validator = EnumAttributeValidator.new('String', ["order_accounts_receivable", "order_fraud_review", "auto_order_card_update_issue", "auto_order_canceled_payment", "item_low_stock", "item_out_of_stock"])
|
366
|
+
return false unless system_task_type_validator.valid?(@system_task_type)
|
347
367
|
true
|
348
368
|
end
|
349
369
|
|
@@ -370,13 +390,23 @@ module UltracartClient
|
|
370
390
|
# Custom attribute writer method checking allowed values (enum).
|
371
391
|
# @param [Object] status Object to be assigned
|
372
392
|
def status=(status)
|
373
|
-
validator = EnumAttributeValidator.new('String', ["open", "closed", "delayed", "awaiting customer feedback"])
|
393
|
+
validator = EnumAttributeValidator.new('String', ["open", "closed", "delayed", "awaiting customer feedback", "closed - system", "closed - customer", "closed - expiration"])
|
374
394
|
unless validator.valid?(status)
|
375
395
|
fail ArgumentError, "invalid value for \"status\", must be one of #{validator.allowable_values}."
|
376
396
|
end
|
377
397
|
@status = status
|
378
398
|
end
|
379
399
|
|
400
|
+
# Custom attribute writer method checking allowed values (enum).
|
401
|
+
# @param [Object] system_task_type Object to be assigned
|
402
|
+
def system_task_type=(system_task_type)
|
403
|
+
validator = EnumAttributeValidator.new('String', ["order_accounts_receivable", "order_fraud_review", "auto_order_card_update_issue", "auto_order_canceled_payment", "item_low_stock", "item_out_of_stock"])
|
404
|
+
unless validator.valid?(system_task_type)
|
405
|
+
fail ArgumentError, "invalid value for \"system_task_type\", must be one of #{validator.allowable_values}."
|
406
|
+
end
|
407
|
+
@system_task_type = system_task_type
|
408
|
+
end
|
409
|
+
|
380
410
|
# Checks equality by comparing each attribute.
|
381
411
|
# @param [Object] Object to be compared
|
382
412
|
def ==(o)
|
@@ -392,6 +422,7 @@ module UltracartClient
|
|
392
422
|
delay_until_dts == o.delay_until_dts &&
|
393
423
|
dependant_workflow_task_uuid == o.dependant_workflow_task_uuid &&
|
394
424
|
due_dts == o.due_dts &&
|
425
|
+
expiration_dts == o.expiration_dts &&
|
395
426
|
histories == o.histories &&
|
396
427
|
last_update_dts == o.last_update_dts &&
|
397
428
|
merchant_id == o.merchant_id &&
|
@@ -404,6 +435,7 @@ module UltracartClient
|
|
404
435
|
properties == o.properties &&
|
405
436
|
related_workflow_task_uuid == o.related_workflow_task_uuid &&
|
406
437
|
status == o.status &&
|
438
|
+
system_task_type == o.system_task_type &&
|
407
439
|
tags == o.tags &&
|
408
440
|
task_context == o.task_context &&
|
409
441
|
task_details == o.task_details &&
|
@@ -420,7 +452,7 @@ module UltracartClient
|
|
420
452
|
# Calculates hash code according to all attributes.
|
421
453
|
# @return [Integer] Hash code
|
422
454
|
def hash
|
423
|
-
[assigned_to_group, assigned_to_group_id, assigned_to_user, assigned_to_user_id, attachments, created_by, created_dts, delay_until_dts, dependant_workflow_task_uuid, due_dts, histories, last_update_dts, merchant_id, notes, object_email, object_id, object_type, object_url, priority, properties, related_workflow_task_uuid, status, tags, task_context, task_details, task_name, workflow_task_uuid].hash
|
455
|
+
[assigned_to_group, assigned_to_group_id, assigned_to_user, assigned_to_user_id, attachments, created_by, created_dts, delay_until_dts, dependant_workflow_task_uuid, due_dts, expiration_dts, histories, last_update_dts, merchant_id, notes, object_email, object_id, object_type, object_url, priority, properties, related_workflow_task_uuid, status, system_task_type, tags, task_context, task_details, task_name, workflow_task_uuid].hash
|
424
456
|
end
|
425
457
|
|
426
458
|
# Builds the object from hash
|
data/lib/ultracart_api.rb
CHANGED
@@ -839,6 +839,8 @@ require 'ultracart_api/models/webhook_sample_request'
|
|
839
839
|
require 'ultracart_api/models/webhook_sample_request_response'
|
840
840
|
require 'ultracart_api/models/webhooks_response'
|
841
841
|
require 'ultracart_api/models/weight'
|
842
|
+
require 'ultracart_api/models/workflow_agent_auth'
|
843
|
+
require 'ultracart_api/models/workflow_agent_auth_response'
|
842
844
|
require 'ultracart_api/models/workflow_attachment'
|
843
845
|
require 'ultracart_api/models/workflow_attachment_upload_url'
|
844
846
|
require 'ultracart_api/models/workflow_attachment_upload_url_response'
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: ultracart_api
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 4.0.
|
4
|
+
version: 4.0.204
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- UltraCart
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2024-03-
|
11
|
+
date: 2024-03-19 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: typhoeus
|
@@ -903,6 +903,8 @@ files:
|
|
903
903
|
- docs/WebhookSampleRequestResponse.md
|
904
904
|
- docs/WebhooksResponse.md
|
905
905
|
- docs/Weight.md
|
906
|
+
- docs/WorkflowAgentAuth.md
|
907
|
+
- docs/WorkflowAgentAuthResponse.md
|
906
908
|
- docs/WorkflowApi.md
|
907
909
|
- docs/WorkflowAttachment.md
|
908
910
|
- docs/WorkflowAttachmentUploadUrl.md
|
@@ -1767,6 +1769,8 @@ files:
|
|
1767
1769
|
- lib/ultracart_api/models/webhook_sample_request_response.rb
|
1768
1770
|
- lib/ultracart_api/models/webhooks_response.rb
|
1769
1771
|
- lib/ultracart_api/models/weight.rb
|
1772
|
+
- lib/ultracart_api/models/workflow_agent_auth.rb
|
1773
|
+
- lib/ultracart_api/models/workflow_agent_auth_response.rb
|
1770
1774
|
- lib/ultracart_api/models/workflow_attachment.rb
|
1771
1775
|
- lib/ultracart_api/models/workflow_attachment_upload_url.rb
|
1772
1776
|
- lib/ultracart_api/models/workflow_attachment_upload_url_response.rb
|