ultracart_api 3.10.23 → 3.10.26
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 +14 -4
- data/docs/Conversation.md +1 -0
- data/docs/ConversationApi.md +99 -0
- data/docs/ConversationEventQueuePosition.md +2 -0
- data/docs/ConversationSummary.md +1 -0
- data/docs/ConversationWebchatQueueStatus.md +18 -0
- data/docs/ConversationWebchatQueueStatusAgent.md +12 -0
- data/docs/ConversationWebchatQueueStatusQueueEntry.md +11 -0
- data/docs/ConversationWebchatQueueStatusUpdateRequest.md +8 -0
- data/docs/ConversationWebchatQueueStatusesResponse.md +12 -0
- data/docs/ConversationWebsocketMessage.md +4 -3
- data/lib/ultracart_api/api/conversation_api.rb +109 -0
- data/lib/ultracart_api/models/conversation.rb +10 -1
- data/lib/ultracart_api/models/conversation_event_queue_position.rb +22 -2
- data/lib/ultracart_api/models/conversation_summary.rb +10 -1
- data/lib/ultracart_api/models/conversation_webchat_queue_status.rb +279 -0
- data/lib/ultracart_api/models/conversation_webchat_queue_status_agent.rb +221 -0
- data/lib/ultracart_api/models/conversation_webchat_queue_status_queue_entry.rb +212 -0
- data/lib/ultracart_api/models/conversation_webchat_queue_status_update_request.rb +184 -0
- data/lib/ultracart_api/models/conversation_webchat_queue_statuses_response.rb +223 -0
- data/lib/ultracart_api/models/conversation_websocket_message.rb +15 -6
- data/lib/ultracart_api/version.rb +1 -1
- data/lib/ultracart_api.rb +5 -0
- metadata +12 -2
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: '080a1090cb029f3ee4489f4fe2c6b2d95a7b1fae616073ed1fab7834d7dc5361'
|
|
4
|
+
data.tar.gz: 8e7eb7f63d3089381afb6e57ef59983d1989b2855f3b54b8236d37c4ccda81ec
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 94b7bb58f35e426e164631c5767b0b54caf91c9d21d6b25fbfec6e0e48fead239ba2e9cd14d657ebe8bd1f751fd4507f589e4478caaa88669ee47600c4658905
|
|
7
|
+
data.tar.gz: a845367dfdd240afa7de6cfa764fde437e2b212694d189ec8ace5580ff95bd098e62893db9c31ba02687430ef1a85f65e18388f1e776f9ae30eb227e98260841
|
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.26
|
|
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.26.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.26.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.26'
|
|
36
36
|
|
|
37
37
|
### Install from Git
|
|
38
38
|
|
|
@@ -128,10 +128,12 @@ Class | Method | HTTP request | Description
|
|
|
128
128
|
*UltracartClient::ConversationApi* | [**get_agent_websocket_authorization**](docs/ConversationApi.md#get_agent_websocket_authorization) | **PUT** /conversation/agent/auth | Get agent websocket authorization
|
|
129
129
|
*UltracartClient::ConversationApi* | [**get_conversation**](docs/ConversationApi.md#get_conversation) | **GET** /conversation/conversations/{conversation_uuid} | Retrieve a conversation
|
|
130
130
|
*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
|
|
131
|
+
*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
|
|
131
132
|
*UltracartClient::ConversationApi* | [**get_conversations**](docs/ConversationApi.md#get_conversations) | **GET** /conversation/conversations | Retrieve a list of conversation summaries newest to oldest
|
|
132
133
|
*UltracartClient::ConversationApi* | [**join_conversation**](docs/ConversationApi.md#join_conversation) | **PUT** /conversation/conversations/{conversation_uuid}/join | Join a conversation
|
|
133
134
|
*UltracartClient::ConversationApi* | [**leave_conversation**](docs/ConversationApi.md#leave_conversation) | **DELETE** /conversation/conversations/{conversation_uuid}/leave | Leave a conversation
|
|
134
135
|
*UltracartClient::ConversationApi* | [**start_conversation**](docs/ConversationApi.md#start_conversation) | **PUT** /conversation/conversations | Start a conversation
|
|
136
|
+
*UltracartClient::ConversationApi* | [**update_conversation_webchat_queue_status**](docs/ConversationApi.md#update_conversation_webchat_queue_status) | **PUT** /conversation/conversations/queues/{queue_name}/status | Update status within the queue
|
|
135
137
|
*UltracartClient::CouponApi* | [**delete_coupon**](docs/CouponApi.md#delete_coupon) | **DELETE** /coupon/coupons/{coupon_oid} | Delete a coupon
|
|
136
138
|
*UltracartClient::CouponApi* | [**delete_coupons_by_code**](docs/CouponApi.md#delete_coupons_by_code) | **DELETE** /coupon/coupons/by_code | Deletes multiple coupons
|
|
137
139
|
*UltracartClient::CouponApi* | [**delete_coupons_by_oid**](docs/CouponApi.md#delete_coupons_by_oid) | **DELETE** /coupon/coupons/by_oid | Deletes multiple coupons
|
|
@@ -569,6 +571,11 @@ Class | Method | HTTP request | Description
|
|
|
569
571
|
- [UltracartClient::ConversationStartRequest](docs/ConversationStartRequest.md)
|
|
570
572
|
- [UltracartClient::ConversationStartResponse](docs/ConversationStartResponse.md)
|
|
571
573
|
- [UltracartClient::ConversationSummary](docs/ConversationSummary.md)
|
|
574
|
+
- [UltracartClient::ConversationWebchatQueueStatus](docs/ConversationWebchatQueueStatus.md)
|
|
575
|
+
- [UltracartClient::ConversationWebchatQueueStatusAgent](docs/ConversationWebchatQueueStatusAgent.md)
|
|
576
|
+
- [UltracartClient::ConversationWebchatQueueStatusQueueEntry](docs/ConversationWebchatQueueStatusQueueEntry.md)
|
|
577
|
+
- [UltracartClient::ConversationWebchatQueueStatusUpdateRequest](docs/ConversationWebchatQueueStatusUpdateRequest.md)
|
|
578
|
+
- [UltracartClient::ConversationWebchatQueueStatusesResponse](docs/ConversationWebchatQueueStatusesResponse.md)
|
|
572
579
|
- [UltracartClient::ConversationWebsocketMessage](docs/ConversationWebsocketMessage.md)
|
|
573
580
|
- [UltracartClient::ConversationsResponse](docs/ConversationsResponse.md)
|
|
574
581
|
- [UltracartClient::CountriesResponse](docs/CountriesResponse.md)
|
|
@@ -1159,6 +1166,9 @@ Not every change is committed to every SDK.
|
|
|
1159
1166
|
|
|
1160
1167
|
| Version | Date | Comments |
|
|
1161
1168
|
| --: | :-: | --- |
|
|
1169
|
+
| 3.10.26 | 07/26/2022 | conversations - queue statistics |
|
|
1170
|
+
| 3.10.25 | 07/25/2022 | conversation development |
|
|
1171
|
+
| 3.10.24 | 07/25/2022 | conversations bug fixes |
|
|
1162
1172
|
| 3.10.23 | 07/25/2022 | conversations - add a websocket message model |
|
|
1163
1173
|
| 3.10.22 | 07/20/2022 | conversation participant name added |
|
|
1164
1174
|
| 3.10.21 | 07/18/2022 | twilio dev |
|
data/docs/Conversation.md
CHANGED
|
@@ -3,6 +3,7 @@
|
|
|
3
3
|
## Properties
|
|
4
4
|
Name | Type | Description | Notes
|
|
5
5
|
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**closed** | **BOOLEAN** | | [optional]
|
|
6
7
|
**conversation_arn** | **String** | | [optional]
|
|
7
8
|
**conversation_uuid** | **String** | | [optional]
|
|
8
9
|
**merchant_id** | **String** | | [optional]
|
data/docs/ConversationApi.md
CHANGED
|
@@ -7,10 +7,12 @@ Method | HTTP request | Description
|
|
|
7
7
|
[**get_agent_websocket_authorization**](ConversationApi.md#get_agent_websocket_authorization) | **PUT** /conversation/agent/auth | Get agent websocket authorization
|
|
8
8
|
[**get_conversation**](ConversationApi.md#get_conversation) | **GET** /conversation/conversations/{conversation_uuid} | Retrieve a conversation
|
|
9
9
|
[**get_conversation_multimedia_upload_url**](ConversationApi.md#get_conversation_multimedia_upload_url) | **GET** /conversation/upload_url/{extension} | Get a presigned conersation multimedia upload URL
|
|
10
|
+
[**get_conversation_webchat_queue_statuses**](ConversationApi.md#get_conversation_webchat_queue_statuses) | **GET** /conversation/conversations/queues/statuses | Retrieve a conversation webchat queue statuses
|
|
10
11
|
[**get_conversations**](ConversationApi.md#get_conversations) | **GET** /conversation/conversations | Retrieve a list of conversation summaries newest to oldest
|
|
11
12
|
[**join_conversation**](ConversationApi.md#join_conversation) | **PUT** /conversation/conversations/{conversation_uuid}/join | Join a conversation
|
|
12
13
|
[**leave_conversation**](ConversationApi.md#leave_conversation) | **DELETE** /conversation/conversations/{conversation_uuid}/leave | Leave a conversation
|
|
13
14
|
[**start_conversation**](ConversationApi.md#start_conversation) | **PUT** /conversation/conversations | Start a conversation
|
|
15
|
+
[**update_conversation_webchat_queue_status**](ConversationApi.md#update_conversation_webchat_queue_status) | **PUT** /conversation/conversations/queues/{queue_name}/status | Update status within the queue
|
|
14
16
|
|
|
15
17
|
|
|
16
18
|
# **get_agent_websocket_authorization**
|
|
@@ -158,6 +160,51 @@ Name | Type | Description | Notes
|
|
|
158
160
|
|
|
159
161
|
|
|
160
162
|
|
|
163
|
+
# **get_conversation_webchat_queue_statuses**
|
|
164
|
+
> ConversationWebchatQueueStatusesResponse get_conversation_webchat_queue_statuses
|
|
165
|
+
|
|
166
|
+
Retrieve a conversation webchat queue statuses
|
|
167
|
+
|
|
168
|
+
Retrieve a conversation webchat queue statuses including agent status and queue entries
|
|
169
|
+
|
|
170
|
+
### Example
|
|
171
|
+
```ruby
|
|
172
|
+
# load the gem
|
|
173
|
+
require 'ultracart_api'
|
|
174
|
+
|
|
175
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
|
176
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
|
177
|
+
api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
|
|
178
|
+
|
|
179
|
+
|
|
180
|
+
|
|
181
|
+
begin
|
|
182
|
+
#Retrieve a conversation webchat queue statuses
|
|
183
|
+
result = api_instance.get_conversation_webchat_queue_statuses
|
|
184
|
+
p result
|
|
185
|
+
rescue UltracartClient::ApiError => e
|
|
186
|
+
puts "Exception when calling ConversationApi->get_conversation_webchat_queue_statuses: #{e}"
|
|
187
|
+
end
|
|
188
|
+
```
|
|
189
|
+
|
|
190
|
+
### Parameters
|
|
191
|
+
This endpoint does not need any parameter.
|
|
192
|
+
|
|
193
|
+
### Return type
|
|
194
|
+
|
|
195
|
+
[**ConversationWebchatQueueStatusesResponse**](ConversationWebchatQueueStatusesResponse.md)
|
|
196
|
+
|
|
197
|
+
### Authorization
|
|
198
|
+
|
|
199
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
200
|
+
|
|
201
|
+
### HTTP request headers
|
|
202
|
+
|
|
203
|
+
- **Content-Type**: application/json
|
|
204
|
+
- **Accept**: application/json
|
|
205
|
+
|
|
206
|
+
|
|
207
|
+
|
|
161
208
|
# **get_conversations**
|
|
162
209
|
> ConversationsResponse get_conversations(opts)
|
|
163
210
|
|
|
@@ -359,3 +406,55 @@ Name | Type | Description | Notes
|
|
|
359
406
|
|
|
360
407
|
|
|
361
408
|
|
|
409
|
+
# **update_conversation_webchat_queue_status**
|
|
410
|
+
> update_conversation_webchat_queue_status(queue_name, status_request)
|
|
411
|
+
|
|
412
|
+
Update status within the queue
|
|
413
|
+
|
|
414
|
+
Update status within the queue
|
|
415
|
+
|
|
416
|
+
### Example
|
|
417
|
+
```ruby
|
|
418
|
+
# load the gem
|
|
419
|
+
require 'ultracart_api'
|
|
420
|
+
|
|
421
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
|
422
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
|
423
|
+
api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
|
|
424
|
+
|
|
425
|
+
|
|
426
|
+
queue_name = 'queue_name_example' # String |
|
|
427
|
+
|
|
428
|
+
status_request = UltracartClient::ConversationWebchatQueueStatusUpdateRequest.new # ConversationWebchatQueueStatusUpdateRequest | Status request
|
|
429
|
+
|
|
430
|
+
|
|
431
|
+
begin
|
|
432
|
+
#Update status within the queue
|
|
433
|
+
api_instance.update_conversation_webchat_queue_status(queue_name, status_request)
|
|
434
|
+
rescue UltracartClient::ApiError => e
|
|
435
|
+
puts "Exception when calling ConversationApi->update_conversation_webchat_queue_status: #{e}"
|
|
436
|
+
end
|
|
437
|
+
```
|
|
438
|
+
|
|
439
|
+
### Parameters
|
|
440
|
+
|
|
441
|
+
Name | Type | Description | Notes
|
|
442
|
+
------------- | ------------- | ------------- | -------------
|
|
443
|
+
**queue_name** | **String**| |
|
|
444
|
+
**status_request** | [**ConversationWebchatQueueStatusUpdateRequest**](ConversationWebchatQueueStatusUpdateRequest.md)| Status request |
|
|
445
|
+
|
|
446
|
+
### Return type
|
|
447
|
+
|
|
448
|
+
nil (empty response body)
|
|
449
|
+
|
|
450
|
+
### Authorization
|
|
451
|
+
|
|
452
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
453
|
+
|
|
454
|
+
### HTTP request headers
|
|
455
|
+
|
|
456
|
+
- **Content-Type**: application/json
|
|
457
|
+
- **Accept**: application/json
|
|
458
|
+
|
|
459
|
+
|
|
460
|
+
|
|
@@ -3,5 +3,7 @@
|
|
|
3
3
|
## Properties
|
|
4
4
|
Name | Type | Description | Notes
|
|
5
5
|
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**available** | **BOOLEAN** | True if agents are logged into the queue | [optional]
|
|
7
|
+
**position** | **Integer** | Position in the queue. Value will be -1 if they cant be found in the queue. | [optional]
|
|
6
8
|
|
|
7
9
|
|
data/docs/ConversationSummary.md
CHANGED
|
@@ -3,6 +3,7 @@
|
|
|
3
3
|
## Properties
|
|
4
4
|
Name | Type | Description | Notes
|
|
5
5
|
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**closed** | **BOOLEAN** | | [optional]
|
|
6
7
|
**conversation_arn** | **String** | | [optional]
|
|
7
8
|
**conversation_uuid** | **String** | | [optional]
|
|
8
9
|
**last_conversation_message_body** | **String** | | [optional]
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# UltracartClient::ConversationWebchatQueueStatus
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**agent_available_count** | **Integer** | | [optional]
|
|
7
|
+
**agent_busy_count** | **Integer** | | [optional]
|
|
8
|
+
**agent_count** | **Integer** | | [optional]
|
|
9
|
+
**agent_unavailable_count** | **Integer** | | [optional]
|
|
10
|
+
**agents** | [**Array<ConversationWebchatQueueStatusAgent>**](ConversationWebchatQueueStatusAgent.md) | | [optional]
|
|
11
|
+
**customer_abandon_count** | **Integer** | | [optional]
|
|
12
|
+
**customer_active_count** | **Integer** | | [optional]
|
|
13
|
+
**customer_waiting_count** | **Integer** | | [optional]
|
|
14
|
+
**customer_waiting_join_dts** | **String** | Date/time that the oldest person joined the queue | [optional]
|
|
15
|
+
**queue_entries** | [**Array<ConversationWebchatQueueStatusQueueEntry>**](ConversationWebchatQueueStatusQueueEntry.md) | | [optional]
|
|
16
|
+
**queue_name** | **String** | | [optional]
|
|
17
|
+
|
|
18
|
+
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
# UltracartClient::ConversationWebchatQueueStatusAgent
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**agent_status** | **String** | | [optional]
|
|
7
|
+
**conversation_participant_arn** | **String** | | [optional]
|
|
8
|
+
**conversation_participant_name** | **String** | | [optional]
|
|
9
|
+
**last_chat_dts** | **String** | Date/time that this agent took their last chat | [optional]
|
|
10
|
+
**next_round_robin** | **BOOLEAN** | | [optional]
|
|
11
|
+
|
|
12
|
+
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
# UltracartClient::ConversationWebchatQueueStatusQueueEntry
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**conversation_participant_arn** | **String** | | [optional]
|
|
7
|
+
**conversation_participant_name** | **String** | | [optional]
|
|
8
|
+
**conversation_webchat_queue_uuid** | **String** | | [optional]
|
|
9
|
+
**join_dts** | **String** | Date/time the customer joined the queue | [optional]
|
|
10
|
+
|
|
11
|
+
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
# UltracartClient::ConversationWebchatQueueStatusesResponse
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**error** | [**Error**](Error.md) | | [optional]
|
|
7
|
+
**metadata** | [**ResponseMetadata**](ResponseMetadata.md) | | [optional]
|
|
8
|
+
**queue_statuses** | [**Array<ConversationWebchatQueueStatus>**](ConversationWebchatQueueStatus.md) | | [optional]
|
|
9
|
+
**success** | **BOOLEAN** | Indicates if API call was successful | [optional]
|
|
10
|
+
**warning** | [**Warning**](Warning.md) | | [optional]
|
|
11
|
+
|
|
12
|
+
|
|
@@ -4,10 +4,11 @@
|
|
|
4
4
|
Name | Type | Description | Notes
|
|
5
5
|
------------ | ------------- | ------------- | -------------
|
|
6
6
|
**conversation_uuid** | **String** | Conversation UUID if the websocket message is tied to a specific conversation | [optional]
|
|
7
|
-
**event_conversation_closed** | [**
|
|
8
|
-
**event_new_conversation** | [**
|
|
9
|
-
**event_new_message** | [**
|
|
7
|
+
**event_conversation_closed** | [**ConversationSummary**](ConversationSummary.md) | | [optional]
|
|
8
|
+
**event_new_conversation** | [**ConversationSummary**](ConversationSummary.md) | | [optional]
|
|
9
|
+
**event_new_message** | [**ConversationSummary**](ConversationSummary.md) | | [optional]
|
|
10
10
|
**event_queue_position** | [**ConversationEventQueuePosition**](ConversationEventQueuePosition.md) | | [optional]
|
|
11
|
+
**event_queue_status_update** | [**ConversationWebchatQueueStatus**](ConversationWebchatQueueStatus.md) | | [optional]
|
|
11
12
|
**event_type** | **String** | Type of event | [optional]
|
|
12
13
|
**event_updated_message** | [**ConversationMessage**](ConversationMessage.md) | | [optional]
|
|
13
14
|
**message** | [**ConversationMessage**](ConversationMessage.md) | | [optional]
|
|
@@ -191,6 +191,55 @@ module UltracartClient
|
|
|
191
191
|
end
|
|
192
192
|
return data, status_code, headers
|
|
193
193
|
end
|
|
194
|
+
# Retrieve a conversation webchat queue statuses
|
|
195
|
+
# Retrieve a conversation webchat queue statuses including agent status and queue entries
|
|
196
|
+
# @param [Hash] opts the optional parameters
|
|
197
|
+
# @return [ConversationWebchatQueueStatusesResponse]
|
|
198
|
+
def get_conversation_webchat_queue_statuses(opts = {})
|
|
199
|
+
data, _status_code, _headers = get_conversation_webchat_queue_statuses_with_http_info(opts)
|
|
200
|
+
data
|
|
201
|
+
end
|
|
202
|
+
|
|
203
|
+
# Retrieve a conversation webchat queue statuses
|
|
204
|
+
# Retrieve a conversation webchat queue statuses including agent status and queue entries
|
|
205
|
+
# @param [Hash] opts the optional parameters
|
|
206
|
+
# @return [Array<(ConversationWebchatQueueStatusesResponse, Fixnum, Hash)>] ConversationWebchatQueueStatusesResponse data, response status code and response headers
|
|
207
|
+
def get_conversation_webchat_queue_statuses_with_http_info(opts = {})
|
|
208
|
+
if @api_client.config.debugging
|
|
209
|
+
@api_client.config.logger.debug 'Calling API: ConversationApi.get_conversation_webchat_queue_statuses ...'
|
|
210
|
+
end
|
|
211
|
+
# resource path
|
|
212
|
+
local_var_path = '/conversation/conversations/queues/statuses'
|
|
213
|
+
|
|
214
|
+
# query parameters
|
|
215
|
+
query_params = {}
|
|
216
|
+
|
|
217
|
+
# header parameters
|
|
218
|
+
header_params = {}
|
|
219
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
|
220
|
+
# HTTP header 'Accept' (if needed)
|
|
221
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
222
|
+
# HTTP header 'Content-Type'
|
|
223
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
|
224
|
+
|
|
225
|
+
# form parameters
|
|
226
|
+
form_params = {}
|
|
227
|
+
|
|
228
|
+
# http body (model)
|
|
229
|
+
post_body = nil
|
|
230
|
+
auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
|
231
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
|
232
|
+
:header_params => header_params,
|
|
233
|
+
:query_params => query_params,
|
|
234
|
+
:form_params => form_params,
|
|
235
|
+
:body => post_body,
|
|
236
|
+
:auth_names => auth_names,
|
|
237
|
+
:return_type => 'ConversationWebchatQueueStatusesResponse')
|
|
238
|
+
if @api_client.config.debugging
|
|
239
|
+
@api_client.config.logger.debug "API called: ConversationApi#get_conversation_webchat_queue_statuses\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
240
|
+
end
|
|
241
|
+
return data, status_code, headers
|
|
242
|
+
end
|
|
194
243
|
# Retrieve a list of conversation summaries newest to oldest
|
|
195
244
|
# Retrieve a list of conversation summaries that are ordered newest to oldest, include the most recent message and whether its been read.
|
|
196
245
|
# @param [Hash] opts the optional parameters
|
|
@@ -409,5 +458,65 @@ module UltracartClient
|
|
|
409
458
|
end
|
|
410
459
|
return data, status_code, headers
|
|
411
460
|
end
|
|
461
|
+
# Update status within the queue
|
|
462
|
+
# Update status within the queue
|
|
463
|
+
# @param queue_name
|
|
464
|
+
# @param status_request Status request
|
|
465
|
+
# @param [Hash] opts the optional parameters
|
|
466
|
+
# @return [nil]
|
|
467
|
+
def update_conversation_webchat_queue_status(queue_name, status_request, opts = {})
|
|
468
|
+
update_conversation_webchat_queue_status_with_http_info(queue_name, status_request, opts)
|
|
469
|
+
nil
|
|
470
|
+
end
|
|
471
|
+
|
|
472
|
+
# Update status within the queue
|
|
473
|
+
# Update status within the queue
|
|
474
|
+
# @param queue_name
|
|
475
|
+
# @param status_request Status request
|
|
476
|
+
# @param [Hash] opts the optional parameters
|
|
477
|
+
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
|
478
|
+
def update_conversation_webchat_queue_status_with_http_info(queue_name, status_request, opts = {})
|
|
479
|
+
if @api_client.config.debugging
|
|
480
|
+
@api_client.config.logger.debug 'Calling API: ConversationApi.update_conversation_webchat_queue_status ...'
|
|
481
|
+
end
|
|
482
|
+
# verify the required parameter 'queue_name' is set
|
|
483
|
+
if @api_client.config.client_side_validation && queue_name.nil?
|
|
484
|
+
fail ArgumentError, "Missing the required parameter 'queue_name' when calling ConversationApi.update_conversation_webchat_queue_status"
|
|
485
|
+
end
|
|
486
|
+
# verify the required parameter 'status_request' is set
|
|
487
|
+
if @api_client.config.client_side_validation && status_request.nil?
|
|
488
|
+
fail ArgumentError, "Missing the required parameter 'status_request' when calling ConversationApi.update_conversation_webchat_queue_status"
|
|
489
|
+
end
|
|
490
|
+
# resource path
|
|
491
|
+
local_var_path = '/conversation/conversations/queues/{queue_name}/status'.sub('{' + 'queue_name' + '}', queue_name.to_s)
|
|
492
|
+
|
|
493
|
+
# query parameters
|
|
494
|
+
query_params = {}
|
|
495
|
+
|
|
496
|
+
# header parameters
|
|
497
|
+
header_params = {}
|
|
498
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
|
499
|
+
# HTTP header 'Accept' (if needed)
|
|
500
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
501
|
+
# HTTP header 'Content-Type'
|
|
502
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
|
503
|
+
|
|
504
|
+
# form parameters
|
|
505
|
+
form_params = {}
|
|
506
|
+
|
|
507
|
+
# http body (model)
|
|
508
|
+
post_body = @api_client.object_to_http_body(status_request)
|
|
509
|
+
auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
|
510
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
|
|
511
|
+
:header_params => header_params,
|
|
512
|
+
:query_params => query_params,
|
|
513
|
+
:form_params => form_params,
|
|
514
|
+
:body => post_body,
|
|
515
|
+
:auth_names => auth_names)
|
|
516
|
+
if @api_client.config.debugging
|
|
517
|
+
@api_client.config.logger.debug "API called: ConversationApi#update_conversation_webchat_queue_status\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
518
|
+
end
|
|
519
|
+
return data, status_code, headers
|
|
520
|
+
end
|
|
412
521
|
end
|
|
413
522
|
end
|
|
@@ -14,6 +14,8 @@ require 'date'
|
|
|
14
14
|
|
|
15
15
|
module UltracartClient
|
|
16
16
|
class Conversation
|
|
17
|
+
attr_accessor :closed
|
|
18
|
+
|
|
17
19
|
attr_accessor :conversation_arn
|
|
18
20
|
|
|
19
21
|
attr_accessor :conversation_uuid
|
|
@@ -27,6 +29,7 @@ module UltracartClient
|
|
|
27
29
|
# Attribute mapping from ruby-style variable name to JSON key.
|
|
28
30
|
def self.attribute_map
|
|
29
31
|
{
|
|
32
|
+
:'closed' => :'closed',
|
|
30
33
|
:'conversation_arn' => :'conversation_arn',
|
|
31
34
|
:'conversation_uuid' => :'conversation_uuid',
|
|
32
35
|
:'merchant_id' => :'merchant_id',
|
|
@@ -38,6 +41,7 @@ module UltracartClient
|
|
|
38
41
|
# Attribute type mapping.
|
|
39
42
|
def self.swagger_types
|
|
40
43
|
{
|
|
44
|
+
:'closed' => :'BOOLEAN',
|
|
41
45
|
:'conversation_arn' => :'String',
|
|
42
46
|
:'conversation_uuid' => :'String',
|
|
43
47
|
:'merchant_id' => :'String',
|
|
@@ -54,6 +58,10 @@ module UltracartClient
|
|
|
54
58
|
# convert string to symbol for hash key
|
|
55
59
|
attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
|
|
56
60
|
|
|
61
|
+
if attributes.has_key?(:'closed')
|
|
62
|
+
self.closed = attributes[:'closed']
|
|
63
|
+
end
|
|
64
|
+
|
|
57
65
|
if attributes.has_key?(:'conversation_arn')
|
|
58
66
|
self.conversation_arn = attributes[:'conversation_arn']
|
|
59
67
|
end
|
|
@@ -97,6 +105,7 @@ module UltracartClient
|
|
|
97
105
|
def ==(o)
|
|
98
106
|
return true if self.equal?(o)
|
|
99
107
|
self.class == o.class &&
|
|
108
|
+
closed == o.closed &&
|
|
100
109
|
conversation_arn == o.conversation_arn &&
|
|
101
110
|
conversation_uuid == o.conversation_uuid &&
|
|
102
111
|
merchant_id == o.merchant_id &&
|
|
@@ -113,7 +122,7 @@ module UltracartClient
|
|
|
113
122
|
# Calculates hash code according to all attributes.
|
|
114
123
|
# @return [Fixnum] Hash code
|
|
115
124
|
def hash
|
|
116
|
-
[conversation_arn, conversation_uuid, merchant_id, messages, participants].hash
|
|
125
|
+
[closed, conversation_arn, conversation_uuid, merchant_id, messages, participants].hash
|
|
117
126
|
end
|
|
118
127
|
|
|
119
128
|
# Builds the object from hash
|
|
@@ -14,15 +14,25 @@ require 'date'
|
|
|
14
14
|
|
|
15
15
|
module UltracartClient
|
|
16
16
|
class ConversationEventQueuePosition
|
|
17
|
+
# True if agents are logged into the queue
|
|
18
|
+
attr_accessor :available
|
|
19
|
+
|
|
20
|
+
# Position in the queue. Value will be -1 if they cant be found in the queue.
|
|
21
|
+
attr_accessor :position
|
|
22
|
+
|
|
17
23
|
# Attribute mapping from ruby-style variable name to JSON key.
|
|
18
24
|
def self.attribute_map
|
|
19
25
|
{
|
|
26
|
+
:'available' => :'available',
|
|
27
|
+
:'position' => :'position'
|
|
20
28
|
}
|
|
21
29
|
end
|
|
22
30
|
|
|
23
31
|
# Attribute type mapping.
|
|
24
32
|
def self.swagger_types
|
|
25
33
|
{
|
|
34
|
+
:'available' => :'BOOLEAN',
|
|
35
|
+
:'position' => :'Integer'
|
|
26
36
|
}
|
|
27
37
|
end
|
|
28
38
|
|
|
@@ -33,6 +43,14 @@ module UltracartClient
|
|
|
33
43
|
|
|
34
44
|
# convert string to symbol for hash key
|
|
35
45
|
attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
|
|
46
|
+
|
|
47
|
+
if attributes.has_key?(:'available')
|
|
48
|
+
self.available = attributes[:'available']
|
|
49
|
+
end
|
|
50
|
+
|
|
51
|
+
if attributes.has_key?(:'position')
|
|
52
|
+
self.position = attributes[:'position']
|
|
53
|
+
end
|
|
36
54
|
end
|
|
37
55
|
|
|
38
56
|
# Show invalid properties with the reasons. Usually used together with valid?
|
|
@@ -52,7 +70,9 @@ module UltracartClient
|
|
|
52
70
|
# @param [Object] Object to be compared
|
|
53
71
|
def ==(o)
|
|
54
72
|
return true if self.equal?(o)
|
|
55
|
-
self.class == o.class
|
|
73
|
+
self.class == o.class &&
|
|
74
|
+
available == o.available &&
|
|
75
|
+
position == o.position
|
|
56
76
|
end
|
|
57
77
|
|
|
58
78
|
# @see the `==` method
|
|
@@ -64,7 +84,7 @@ module UltracartClient
|
|
|
64
84
|
# Calculates hash code according to all attributes.
|
|
65
85
|
# @return [Fixnum] Hash code
|
|
66
86
|
def hash
|
|
67
|
-
[].hash
|
|
87
|
+
[available, position].hash
|
|
68
88
|
end
|
|
69
89
|
|
|
70
90
|
# Builds the object from hash
|
|
@@ -14,6 +14,8 @@ require 'date'
|
|
|
14
14
|
|
|
15
15
|
module UltracartClient
|
|
16
16
|
class ConversationSummary
|
|
17
|
+
attr_accessor :closed
|
|
18
|
+
|
|
17
19
|
attr_accessor :conversation_arn
|
|
18
20
|
|
|
19
21
|
attr_accessor :conversation_uuid
|
|
@@ -36,6 +38,7 @@ module UltracartClient
|
|
|
36
38
|
# Attribute mapping from ruby-style variable name to JSON key.
|
|
37
39
|
def self.attribute_map
|
|
38
40
|
{
|
|
41
|
+
:'closed' => :'closed',
|
|
39
42
|
:'conversation_arn' => :'conversation_arn',
|
|
40
43
|
:'conversation_uuid' => :'conversation_uuid',
|
|
41
44
|
:'last_conversation_message_body' => :'last_conversation_message_body',
|
|
@@ -51,6 +54,7 @@ module UltracartClient
|
|
|
51
54
|
# Attribute type mapping.
|
|
52
55
|
def self.swagger_types
|
|
53
56
|
{
|
|
57
|
+
:'closed' => :'BOOLEAN',
|
|
54
58
|
:'conversation_arn' => :'String',
|
|
55
59
|
:'conversation_uuid' => :'String',
|
|
56
60
|
:'last_conversation_message_body' => :'String',
|
|
@@ -71,6 +75,10 @@ module UltracartClient
|
|
|
71
75
|
# convert string to symbol for hash key
|
|
72
76
|
attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
|
|
73
77
|
|
|
78
|
+
if attributes.has_key?(:'closed')
|
|
79
|
+
self.closed = attributes[:'closed']
|
|
80
|
+
end
|
|
81
|
+
|
|
74
82
|
if attributes.has_key?(:'conversation_arn')
|
|
75
83
|
self.conversation_arn = attributes[:'conversation_arn']
|
|
76
84
|
end
|
|
@@ -126,6 +134,7 @@ module UltracartClient
|
|
|
126
134
|
def ==(o)
|
|
127
135
|
return true if self.equal?(o)
|
|
128
136
|
self.class == o.class &&
|
|
137
|
+
closed == o.closed &&
|
|
129
138
|
conversation_arn == o.conversation_arn &&
|
|
130
139
|
conversation_uuid == o.conversation_uuid &&
|
|
131
140
|
last_conversation_message_body == o.last_conversation_message_body &&
|
|
@@ -146,7 +155,7 @@ module UltracartClient
|
|
|
146
155
|
# Calculates hash code according to all attributes.
|
|
147
156
|
# @return [Fixnum] Hash code
|
|
148
157
|
def hash
|
|
149
|
-
[conversation_arn, conversation_uuid, last_conversation_message_body, last_conversation_participant_arn, last_conversation_participant_name, last_message_dts, merchant_id, message_count, unread_messages].hash
|
|
158
|
+
[closed, conversation_arn, conversation_uuid, last_conversation_message_body, last_conversation_participant_arn, last_conversation_participant_name, last_message_dts, merchant_id, message_count, unread_messages].hash
|
|
150
159
|
end
|
|
151
160
|
|
|
152
161
|
# Builds the object from hash
|