ultracart_api 4.0.40.rc → 4.0.43.rc

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 76013e5a63e089f1e40ed70b618beb58c0ecfb27836590c30970a63081b50541
4
- data.tar.gz: b976780adb3bb8a80f81f0d5a73d07532edd764997e66b944488ea56c0ca6cf3
3
+ metadata.gz: ecce2637eed2be458ecc28244b97ef976f97ca082e5fa5b7d2f76895d73655d2
4
+ data.tar.gz: 560139155bfdca37c2c151b6101736655c87eeee53e0d6fe4c3e83ea57d5da60
5
5
  SHA512:
6
- metadata.gz: 19040f00897b6b9b015f78a3ae05f5894367f688cb2f1ab38c4a388edd46959c2172a494c254ef2fc5008999b523fe7f8dffe90a9fa92c8fd262529634dd536c
7
- data.tar.gz: 1c694c816b9df21260ca6b9267b81d0bf2f3b39311025ac3cf89a56212e7345bead4799eabcbc465b505f8d1e0163c13cc64dd365740f7fa57b1f2b3e19b5532
6
+ metadata.gz: 3eed05542e98dd7a0eea8f7f80ad936e06b133bde1fe3697274e06a8d4d74677ab35814f291a6cc2abd52724ba3d5ece3a4b254e846c0e9085404f35823e37b3
7
+ data.tar.gz: 4a78067cd058c9ad6098c8f75bf2ed8ab2afb1b9644071e891b7c25104dc4110d1548e21b1a156ede98d1e238761c6c038d81ec6031e906a8399072cdcadeac9
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.40.rc
10
+ - Package version: 4.0.43.rc
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.40.rc.gem
27
+ gem install ./ultracart_api-4.0.43.rc.gem
28
28
  ```
29
29
 
30
- (for development, run `gem install --dev ./ultracart_api-4.0.40.rc.gem` to install the development dependencies)
30
+ (for development, run `gem install --dev ./ultracart_api-4.0.43.rc.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.40.rc'
36
+ gem 'ultracart_api', '~> 4.0.43.rc'
37
37
 
38
38
  ### Install from Git
39
39
 
@@ -134,10 +134,12 @@ Class | Method | HTTP request | Description
134
134
  *UltracartClient::ConversationApi* | [**get_agent_websocket_authorization**](docs/ConversationApi.md#get_agent_websocket_authorization) | **PUT** /conversation/agent/auth | Get agent websocket authorization
135
135
  *UltracartClient::ConversationApi* | [**get_conversation**](docs/ConversationApi.md#get_conversation) | **GET** /conversation/conversations/{conversation_uuid} | Retrieve a conversation
136
136
  *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
137
+ *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
137
138
  *UltracartClient::ConversationApi* | [**get_conversations**](docs/ConversationApi.md#get_conversations) | **GET** /conversation/conversations | Retrieve a list of conversation summaries newest to oldest
138
139
  *UltracartClient::ConversationApi* | [**join_conversation**](docs/ConversationApi.md#join_conversation) | **PUT** /conversation/conversations/{conversation_uuid}/join | Join a conversation
139
140
  *UltracartClient::ConversationApi* | [**leave_conversation**](docs/ConversationApi.md#leave_conversation) | **DELETE** /conversation/conversations/{conversation_uuid}/leave | Leave a conversation
140
141
  *UltracartClient::ConversationApi* | [**start_conversation**](docs/ConversationApi.md#start_conversation) | **PUT** /conversation/conversations | Start a conversation
142
+ *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
141
143
  *UltracartClient::CouponApi* | [**delete_coupon**](docs/CouponApi.md#delete_coupon) | **DELETE** /coupon/coupons/{coupon_oid} | Delete a coupon
142
144
  *UltracartClient::CouponApi* | [**delete_coupons_by_code**](docs/CouponApi.md#delete_coupons_by_code) | **DELETE** /coupon/coupons/by_code | Deletes multiple coupons
143
145
  *UltracartClient::CouponApi* | [**delete_coupons_by_oid**](docs/CouponApi.md#delete_coupons_by_oid) | **DELETE** /coupon/coupons/by_oid | Deletes multiple coupons
@@ -565,6 +567,7 @@ Class | Method | HTTP request | Description
565
567
  - [UltracartClient::Conversation](docs/Conversation.md)
566
568
  - [UltracartClient::ConversationAgentAuth](docs/ConversationAgentAuth.md)
567
569
  - [UltracartClient::ConversationAgentAuthResponse](docs/ConversationAgentAuthResponse.md)
570
+ - [UltracartClient::ConversationEventQueuePosition](docs/ConversationEventQueuePosition.md)
568
571
  - [UltracartClient::ConversationMessage](docs/ConversationMessage.md)
569
572
  - [UltracartClient::ConversationMessageTransportStatus](docs/ConversationMessageTransportStatus.md)
570
573
  - [UltracartClient::ConversationMultimediaUploadUrl](docs/ConversationMultimediaUploadUrl.md)
@@ -574,6 +577,11 @@ Class | Method | HTTP request | Description
574
577
  - [UltracartClient::ConversationStartRequest](docs/ConversationStartRequest.md)
575
578
  - [UltracartClient::ConversationStartResponse](docs/ConversationStartResponse.md)
576
579
  - [UltracartClient::ConversationSummary](docs/ConversationSummary.md)
580
+ - [UltracartClient::ConversationWebchatQueueStatus](docs/ConversationWebchatQueueStatus.md)
581
+ - [UltracartClient::ConversationWebchatQueueStatusAgent](docs/ConversationWebchatQueueStatusAgent.md)
582
+ - [UltracartClient::ConversationWebchatQueueStatusQueueEntry](docs/ConversationWebchatQueueStatusQueueEntry.md)
583
+ - [UltracartClient::ConversationWebchatQueueStatusUpdateRequest](docs/ConversationWebchatQueueStatusUpdateRequest.md)
584
+ - [UltracartClient::ConversationWebchatQueueStatusesResponse](docs/ConversationWebchatQueueStatusesResponse.md)
577
585
  - [UltracartClient::ConversationWebsocketMessage](docs/ConversationWebsocketMessage.md)
578
586
  - [UltracartClient::ConversationsResponse](docs/ConversationsResponse.md)
579
587
  - [UltracartClient::CountriesResponse](docs/CountriesResponse.md)
@@ -1166,6 +1174,9 @@ Not every change is committed to every SDK.
1166
1174
 
1167
1175
  | Version | Date | Comments |
1168
1176
  | --: | :-: | --- |
1177
+ | 4.0.43-RC | 07/26/2022 | conversations - queue statistics |
1178
+ | 4.0.42-RC | 07/25/2022 | conversation development |
1179
+ | 4.0.41-RC | 07/25/2022 | conversations bug fixes |
1169
1180
  | 4.0.40-RC | 07/25/2022 | conversations - add a websocket message model |
1170
1181
  | 4.0.39-RC | 07/21/2022 | conversation response types improvements |
1171
1182
  | 4.0.38-RC | 07/21/2022 | conversation bugfix for poor response objects |
data/docs/Conversation.md CHANGED
@@ -4,6 +4,7 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
+ | **closed** | **Boolean** | | [optional] |
7
8
  | **conversation_arn** | **String** | | [optional] |
8
9
  | **conversation_uuid** | **String** | | [optional] |
9
10
  | **merchant_id** | **String** | | [optional] |
@@ -16,6 +17,7 @@
16
17
  require 'ultracart_api'
17
18
 
18
19
  instance = UltracartClient::Conversation.new(
20
+ closed: null,
19
21
  conversation_arn: null,
20
22
  conversation_uuid: null,
21
23
  merchant_id: null,
@@ -7,10 +7,12 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
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
@@ -223,6 +225,74 @@ end
223
225
  - **Accept**: application/json
224
226
 
225
227
 
228
+ ## get_conversation_webchat_queue_statuses
229
+
230
+ > <ConversationWebchatQueueStatusesResponse> get_conversation_webchat_queue_statuses
231
+
232
+ Retrieve a conversation webchat queue statuses
233
+
234
+ Retrieve a conversation webchat queue statuses including agent status and queue entries
235
+
236
+ ### Examples
237
+
238
+ ```ruby
239
+ require 'time'
240
+ require 'ultracart_api'
241
+ require 'json'
242
+ require 'yaml'
243
+ require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
244
+
245
+ # This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
246
+ # As such, this might not be the best way to use this object.
247
+ # Please see https://github.com/UltraCart/sdk_samples for working examples.
248
+
249
+ api = UltracartClient::ConversationApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
250
+
251
+ begin
252
+ # Retrieve a conversation webchat queue statuses
253
+ result = api_instance.get_conversation_webchat_queue_statuses
254
+ p result
255
+ rescue UltracartClient::ApiError => e
256
+ puts "Error when calling ConversationApi->get_conversation_webchat_queue_statuses: #{e}"
257
+ end
258
+ ```
259
+
260
+ #### Using the get_conversation_webchat_queue_statuses_with_http_info variant
261
+
262
+ This returns an Array which contains the response data, status code and headers.
263
+
264
+ > <Array(<ConversationWebchatQueueStatusesResponse>, Integer, Hash)> get_conversation_webchat_queue_statuses_with_http_info
265
+
266
+ ```ruby
267
+ begin
268
+ # Retrieve a conversation webchat queue statuses
269
+ data, status_code, headers = api_instance.get_conversation_webchat_queue_statuses_with_http_info
270
+ p status_code # => 2xx
271
+ p headers # => { ... }
272
+ p data # => <ConversationWebchatQueueStatusesResponse>
273
+ rescue UltracartClient::ApiError => e
274
+ puts "Error when calling ConversationApi->get_conversation_webchat_queue_statuses_with_http_info: #{e}"
275
+ end
276
+ ```
277
+
278
+ ### Parameters
279
+
280
+ This endpoint does not need any parameter.
281
+
282
+ ### Return type
283
+
284
+ [**ConversationWebchatQueueStatusesResponse**](ConversationWebchatQueueStatusesResponse.md)
285
+
286
+ ### Authorization
287
+
288
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
289
+
290
+ ### HTTP request headers
291
+
292
+ - **Content-Type**: Not defined
293
+ - **Accept**: application/json
294
+
295
+
226
296
  ## get_conversations
227
297
 
228
298
  > <ConversationsResponse> get_conversations(opts)
@@ -508,3 +578,75 @@ end
508
578
  - **Content-Type**: application/json
509
579
  - **Accept**: application/json
510
580
 
581
+
582
+ ## update_conversation_webchat_queue_status
583
+
584
+ > update_conversation_webchat_queue_status(queue_name, status_request)
585
+
586
+ Update status within the queue
587
+
588
+ Update status within the queue
589
+
590
+ ### Examples
591
+
592
+ ```ruby
593
+ require 'time'
594
+ require 'ultracart_api'
595
+ require 'json'
596
+ require 'yaml'
597
+ require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
598
+
599
+ # This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
600
+ # As such, this might not be the best way to use this object.
601
+ # Please see https://github.com/UltraCart/sdk_samples for working examples.
602
+
603
+ api = UltracartClient::ConversationApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
604
+ queue_name = 'queue_name_example' # String |
605
+ status_request = UltracartClient::ConversationWebchatQueueStatusUpdateRequest.new # ConversationWebchatQueueStatusUpdateRequest | Status request
606
+
607
+ begin
608
+ # Update status within the queue
609
+ api_instance.update_conversation_webchat_queue_status(queue_name, status_request)
610
+ rescue UltracartClient::ApiError => e
611
+ puts "Error when calling ConversationApi->update_conversation_webchat_queue_status: #{e}"
612
+ end
613
+ ```
614
+
615
+ #### Using the update_conversation_webchat_queue_status_with_http_info variant
616
+
617
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
618
+
619
+ > <Array(nil, Integer, Hash)> update_conversation_webchat_queue_status_with_http_info(queue_name, status_request)
620
+
621
+ ```ruby
622
+ begin
623
+ # Update status within the queue
624
+ data, status_code, headers = api_instance.update_conversation_webchat_queue_status_with_http_info(queue_name, status_request)
625
+ p status_code # => 2xx
626
+ p headers # => { ... }
627
+ p data # => nil
628
+ rescue UltracartClient::ApiError => e
629
+ puts "Error when calling ConversationApi->update_conversation_webchat_queue_status_with_http_info: #{e}"
630
+ end
631
+ ```
632
+
633
+ ### Parameters
634
+
635
+ | Name | Type | Description | Notes |
636
+ | ---- | ---- | ----------- | ----- |
637
+ | **queue_name** | **String** | | |
638
+ | **status_request** | [**ConversationWebchatQueueStatusUpdateRequest**](ConversationWebchatQueueStatusUpdateRequest.md) | Status request | |
639
+
640
+ ### Return type
641
+
642
+ nil (empty response body)
643
+
644
+ ### Authorization
645
+
646
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
647
+
648
+ ### HTTP request headers
649
+
650
+ - **Content-Type**: application/json
651
+ - **Accept**: application/json
652
+
@@ -0,0 +1,20 @@
1
+ # UltracartClient::ConversationEventQueuePosition
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **available** | **Boolean** | True if agents are logged into the queue | [optional] |
8
+ | **position** | **Integer** | Position in the queue. Value will be -1 if they cant be found in the queue. | [optional] |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'ultracart_api'
14
+
15
+ instance = UltracartClient::ConversationEventQueuePosition.new(
16
+ available: null,
17
+ position: null
18
+ )
19
+ ```
20
+
@@ -4,6 +4,7 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
+ | **closed** | **Boolean** | | [optional] |
7
8
  | **conversation_arn** | **String** | | [optional] |
8
9
  | **conversation_uuid** | **String** | | [optional] |
9
10
  | **last_conversation_message_body** | **String** | | [optional] |
@@ -20,6 +21,7 @@
20
21
  require 'ultracart_api'
21
22
 
22
23
  instance = UltracartClient::ConversationSummary.new(
24
+ closed: null,
23
25
  conversation_arn: null,
24
26
  conversation_uuid: null,
25
27
  last_conversation_message_body: null,
@@ -0,0 +1,38 @@
1
+ # UltracartClient::ConversationWebchatQueueStatus
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **agent_available_count** | **Integer** | | [optional] |
8
+ | **agent_busy_count** | **Integer** | | [optional] |
9
+ | **agent_count** | **Integer** | | [optional] |
10
+ | **agent_unavailable_count** | **Integer** | | [optional] |
11
+ | **agents** | [**Array&lt;ConversationWebchatQueueStatusAgent&gt;**](ConversationWebchatQueueStatusAgent.md) | | [optional] |
12
+ | **customer_abandon_count** | **Integer** | | [optional] |
13
+ | **customer_active_count** | **Integer** | | [optional] |
14
+ | **customer_waiting_count** | **Integer** | | [optional] |
15
+ | **customer_waiting_join_dts** | **String** | Date/time that the oldest person joined the queue | [optional] |
16
+ | **queue_entries** | [**Array&lt;ConversationWebchatQueueStatusQueueEntry&gt;**](ConversationWebchatQueueStatusQueueEntry.md) | | [optional] |
17
+ | **queue_name** | **String** | | [optional] |
18
+
19
+ ## Example
20
+
21
+ ```ruby
22
+ require 'ultracart_api'
23
+
24
+ instance = UltracartClient::ConversationWebchatQueueStatus.new(
25
+ agent_available_count: null,
26
+ agent_busy_count: null,
27
+ agent_count: null,
28
+ agent_unavailable_count: null,
29
+ agents: null,
30
+ customer_abandon_count: null,
31
+ customer_active_count: null,
32
+ customer_waiting_count: null,
33
+ customer_waiting_join_dts: null,
34
+ queue_entries: null,
35
+ queue_name: null
36
+ )
37
+ ```
38
+
@@ -0,0 +1,26 @@
1
+ # UltracartClient::ConversationWebchatQueueStatusAgent
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **agent_status** | **String** | | [optional] |
8
+ | **conversation_participant_arn** | **String** | | [optional] |
9
+ | **conversation_participant_name** | **String** | | [optional] |
10
+ | **last_chat_dts** | **String** | Date/time that this agent took their last chat | [optional] |
11
+ | **next_round_robin** | **Boolean** | | [optional] |
12
+
13
+ ## Example
14
+
15
+ ```ruby
16
+ require 'ultracart_api'
17
+
18
+ instance = UltracartClient::ConversationWebchatQueueStatusAgent.new(
19
+ agent_status: null,
20
+ conversation_participant_arn: null,
21
+ conversation_participant_name: null,
22
+ last_chat_dts: null,
23
+ next_round_robin: null
24
+ )
25
+ ```
26
+
@@ -0,0 +1,24 @@
1
+ # UltracartClient::ConversationWebchatQueueStatusQueueEntry
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **conversation_participant_arn** | **String** | | [optional] |
8
+ | **conversation_participant_name** | **String** | | [optional] |
9
+ | **conversation_webchat_queue_uuid** | **String** | | [optional] |
10
+ | **join_dts** | **String** | Date/time the customer joined the queue | [optional] |
11
+
12
+ ## Example
13
+
14
+ ```ruby
15
+ require 'ultracart_api'
16
+
17
+ instance = UltracartClient::ConversationWebchatQueueStatusQueueEntry.new(
18
+ conversation_participant_arn: null,
19
+ conversation_participant_name: null,
20
+ conversation_webchat_queue_uuid: null,
21
+ join_dts: null
22
+ )
23
+ ```
24
+
@@ -0,0 +1,18 @@
1
+ # UltracartClient::ConversationWebchatQueueStatusUpdateRequest
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **agent_status** | **String** | | [optional] |
8
+
9
+ ## Example
10
+
11
+ ```ruby
12
+ require 'ultracart_api'
13
+
14
+ instance = UltracartClient::ConversationWebchatQueueStatusUpdateRequest.new(
15
+ agent_status: null
16
+ )
17
+ ```
18
+
@@ -0,0 +1,26 @@
1
+ # UltracartClient::ConversationWebchatQueueStatusesResponse
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **error** | [**Error**](Error.md) | | [optional] |
8
+ | **metadata** | [**ResponseMetadata**](ResponseMetadata.md) | | [optional] |
9
+ | **queue_statuses** | [**Array&lt;ConversationWebchatQueueStatus&gt;**](ConversationWebchatQueueStatus.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::ConversationWebchatQueueStatusesResponse.new(
19
+ error: null,
20
+ metadata: null,
21
+ queue_statuses: null,
22
+ success: null,
23
+ warning: null
24
+ )
25
+ ```
26
+
@@ -5,10 +5,11 @@
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **conversation_uuid** | **String** | Conversation UUID if the websocket message is tied to a specific conversation | [optional] |
8
- | **event_conversation_closed** | [**Conversation**](Conversation.md) | | [optional] |
9
- | **event_new_conversation** | [**Conversation**](Conversation.md) | | [optional] |
10
- | **event_new_message** | [**ConversationMessage**](ConversationMessage.md) | | [optional] |
11
- | **event_queue_position** | **Object** | | [optional] |
8
+ | **event_conversation_closed** | [**ConversationSummary**](ConversationSummary.md) | | [optional] |
9
+ | **event_new_conversation** | [**ConversationSummary**](ConversationSummary.md) | | [optional] |
10
+ | **event_new_message** | [**ConversationSummary**](ConversationSummary.md) | | [optional] |
11
+ | **event_queue_position** | [**ConversationEventQueuePosition**](ConversationEventQueuePosition.md) | | [optional] |
12
+ | **event_queue_status_update** | [**ConversationWebchatQueueStatus**](ConversationWebchatQueueStatus.md) | | [optional] |
12
13
  | **event_type** | **String** | Type of event | [optional] |
13
14
  | **event_updated_message** | [**ConversationMessage**](ConversationMessage.md) | | [optional] |
14
15
  | **message** | [**ConversationMessage**](ConversationMessage.md) | | [optional] |
@@ -25,6 +26,7 @@ instance = UltracartClient::ConversationWebsocketMessage.new(
25
26
  event_new_conversation: null,
26
27
  event_new_message: null,
27
28
  event_queue_position: null,
29
+ event_queue_status_update: null,
28
30
  event_type: null,
29
31
  event_updated_message: null,
30
32
  message: null,
@@ -218,6 +218,64 @@ module UltracartClient
218
218
  return data, status_code, headers
219
219
  end
220
220
 
221
+ # Retrieve a conversation webchat queue statuses
222
+ # Retrieve a conversation webchat queue statuses including agent status and queue entries
223
+ # @param [Hash] opts the optional parameters
224
+ # @return [ConversationWebchatQueueStatusesResponse]
225
+ def get_conversation_webchat_queue_statuses(opts = {})
226
+ data, _status_code, _headers = get_conversation_webchat_queue_statuses_with_http_info(opts)
227
+ data
228
+ end
229
+
230
+ # Retrieve a conversation webchat queue statuses
231
+ # Retrieve a conversation webchat queue statuses including agent status and queue entries
232
+ # @param [Hash] opts the optional parameters
233
+ # @return [Array<(ConversationWebchatQueueStatusesResponse, Integer, Hash)>] ConversationWebchatQueueStatusesResponse data, response status code and response headers
234
+ def get_conversation_webchat_queue_statuses_with_http_info(opts = {})
235
+ if @api_client.config.debugging
236
+ @api_client.config.logger.debug 'Calling API: ConversationApi.get_conversation_webchat_queue_statuses ...'
237
+ end
238
+ # resource path
239
+ local_var_path = '/conversation/conversations/queues/statuses'
240
+
241
+ # query parameters
242
+ query_params = opts[:query_params] || {}
243
+
244
+ # header parameters
245
+ header_params = opts[:header_params] || {}
246
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
247
+ # HTTP header 'Accept' (if needed)
248
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
249
+
250
+ # form parameters
251
+ form_params = opts[:form_params] || {}
252
+
253
+ # http body (model)
254
+ post_body = opts[:debug_body]
255
+
256
+ # return_type
257
+ return_type = opts[:debug_return_type] || 'ConversationWebchatQueueStatusesResponse'
258
+
259
+ # auth_names
260
+ auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
261
+
262
+ new_options = opts.merge(
263
+ :operation => :"ConversationApi.get_conversation_webchat_queue_statuses",
264
+ :header_params => header_params,
265
+ :query_params => query_params,
266
+ :form_params => form_params,
267
+ :body => post_body,
268
+ :auth_names => auth_names,
269
+ :return_type => return_type
270
+ )
271
+
272
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
273
+ if @api_client.config.debugging
274
+ @api_client.config.logger.debug "API called: ConversationApi#get_conversation_webchat_queue_statuses\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
275
+ end
276
+ return data, status_code, headers
277
+ end
278
+
221
279
  # Retrieve a list of conversation summaries newest to oldest
222
280
  # Retrieve a list of conversation summaries that are ordered newest to oldest, include the most recent message and whether its been read.
223
281
  # @param [Hash] opts the optional parameters
@@ -478,5 +536,80 @@ module UltracartClient
478
536
  end
479
537
  return data, status_code, headers
480
538
  end
539
+
540
+ # Update status within the queue
541
+ # Update status within the queue
542
+ # @param queue_name [String]
543
+ # @param status_request [ConversationWebchatQueueStatusUpdateRequest] Status request
544
+ # @param [Hash] opts the optional parameters
545
+ # @return [nil]
546
+ def update_conversation_webchat_queue_status(queue_name, status_request, opts = {})
547
+ update_conversation_webchat_queue_status_with_http_info(queue_name, status_request, opts)
548
+ nil
549
+ end
550
+
551
+ # Update status within the queue
552
+ # Update status within the queue
553
+ # @param queue_name [String]
554
+ # @param status_request [ConversationWebchatQueueStatusUpdateRequest] Status request
555
+ # @param [Hash] opts the optional parameters
556
+ # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
557
+ def update_conversation_webchat_queue_status_with_http_info(queue_name, status_request, opts = {})
558
+ if @api_client.config.debugging
559
+ @api_client.config.logger.debug 'Calling API: ConversationApi.update_conversation_webchat_queue_status ...'
560
+ end
561
+ # verify the required parameter 'queue_name' is set
562
+ if @api_client.config.client_side_validation && queue_name.nil?
563
+ fail ArgumentError, "Missing the required parameter 'queue_name' when calling ConversationApi.update_conversation_webchat_queue_status"
564
+ end
565
+ # verify the required parameter 'status_request' is set
566
+ if @api_client.config.client_side_validation && status_request.nil?
567
+ fail ArgumentError, "Missing the required parameter 'status_request' when calling ConversationApi.update_conversation_webchat_queue_status"
568
+ end
569
+ # resource path
570
+ local_var_path = '/conversation/conversations/queues/{queue_name}/status'.sub('{' + 'queue_name' + '}', CGI.escape(queue_name.to_s))
571
+
572
+ # query parameters
573
+ query_params = opts[:query_params] || {}
574
+
575
+ # header parameters
576
+ header_params = opts[:header_params] || {}
577
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
578
+ # HTTP header 'Accept' (if needed)
579
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
580
+ # HTTP header 'Content-Type'
581
+ content_type = @api_client.select_header_content_type(['application/json'])
582
+ if !content_type.nil?
583
+ header_params['Content-Type'] = content_type
584
+ end
585
+
586
+ # form parameters
587
+ form_params = opts[:form_params] || {}
588
+
589
+ # http body (model)
590
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(status_request)
591
+
592
+ # return_type
593
+ return_type = opts[:debug_return_type]
594
+
595
+ # auth_names
596
+ auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
597
+
598
+ new_options = opts.merge(
599
+ :operation => :"ConversationApi.update_conversation_webchat_queue_status",
600
+ :header_params => header_params,
601
+ :query_params => query_params,
602
+ :form_params => form_params,
603
+ :body => post_body,
604
+ :auth_names => auth_names,
605
+ :return_type => return_type
606
+ )
607
+
608
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
609
+ if @api_client.config.debugging
610
+ @api_client.config.logger.debug "API called: ConversationApi#update_conversation_webchat_queue_status\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
611
+ end
612
+ return data, status_code, headers
613
+ end
481
614
  end
482
615
  end
@@ -15,6 +15,8 @@ require 'time'
15
15
 
16
16
  module UltracartClient
17
17
  class Conversation
18
+ attr_accessor :closed
19
+
18
20
  attr_accessor :conversation_arn
19
21
 
20
22
  attr_accessor :conversation_uuid
@@ -28,6 +30,7 @@ module UltracartClient
28
30
  # Attribute mapping from ruby-style variable name to JSON key.
29
31
  def self.attribute_map
30
32
  {
33
+ :'closed' => :'closed',
31
34
  :'conversation_arn' => :'conversation_arn',
32
35
  :'conversation_uuid' => :'conversation_uuid',
33
36
  :'merchant_id' => :'merchant_id',
@@ -44,6 +47,7 @@ module UltracartClient
44
47
  # Attribute type mapping.
45
48
  def self.openapi_types
46
49
  {
50
+ :'closed' => :'Boolean',
47
51
  :'conversation_arn' => :'String',
48
52
  :'conversation_uuid' => :'String',
49
53
  :'merchant_id' => :'String',
@@ -73,6 +77,10 @@ module UltracartClient
73
77
  h[k.to_sym] = v
74
78
  }
75
79
 
80
+ if attributes.key?(:'closed')
81
+ self.closed = attributes[:'closed']
82
+ end
83
+
76
84
  if attributes.key?(:'conversation_arn')
77
85
  self.conversation_arn = attributes[:'conversation_arn']
78
86
  end
@@ -116,6 +124,7 @@ module UltracartClient
116
124
  def ==(o)
117
125
  return true if self.equal?(o)
118
126
  self.class == o.class &&
127
+ closed == o.closed &&
119
128
  conversation_arn == o.conversation_arn &&
120
129
  conversation_uuid == o.conversation_uuid &&
121
130
  merchant_id == o.merchant_id &&
@@ -132,7 +141,7 @@ module UltracartClient
132
141
  # Calculates hash code according to all attributes.
133
142
  # @return [Integer] Hash code
134
143
  def hash
135
- [conversation_arn, conversation_uuid, merchant_id, messages, participants].hash
144
+ [closed, conversation_arn, conversation_uuid, merchant_id, messages, participants].hash
136
145
  end
137
146
 
138
147
  # Builds the object from hash