ultracart_api 4.0.42.rc → 4.0.45.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: 2b1f122135fbc76270b2a27c45e56a8362bcf5b55f831967479862d1b14147fb
4
- data.tar.gz: b116767c0f15772031876f7aeb21c1879374775cf4069764f588e43c7115f5f3
3
+ metadata.gz: d3170e8927d8e030dbc1dba868ca03222e18145e16f5d2889a1a9bb0da90a24b
4
+ data.tar.gz: e87e3ffa36d18c3173c3081d6e9b87a4e9b8b94d57e89fe38d7f5487cd75eada
5
5
  SHA512:
6
- metadata.gz: eca54d9804f18ffc46ce49e0461cd6f7ab80fe755cd932b3927f7bdd6b14fb7f3574c028319a907c8fa18f48b2827e5af0d1781e640c026deedcb33d09c4a058
7
- data.tar.gz: 5cb89ab94dee75f60d4875ecb8b0666c9f6664c762d7b2f8d93efced51725aac44c7d9e0df739470f8099b188b22fa5106bf95b1e5d8559bea59b5d1f5e828b1
6
+ metadata.gz: e899c1803a077222dfbb1748f16d530c49b97dd6c9d1c906455832b240061878ef2a42f13a3a17977d66de542d539ac1c47520101f4b7925ef919e77536db631
7
+ data.tar.gz: f8fc9bde07d1a32f600f578883b60353df2aa9cbb4d6e8df97041aeaa601a5d310ea6eaf8ada99349b91068283a90a398259a5e4af7b2f34a4ea3dff46b48d1d
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.42.rc
10
+ - Package version: 4.0.45.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.42.rc.gem
27
+ gem install ./ultracart_api-4.0.45.rc.gem
28
28
  ```
29
29
 
30
- (for development, run `gem install --dev ./ultracart_api-4.0.42.rc.gem` to install the development dependencies)
30
+ (for development, run `gem install --dev ./ultracart_api-4.0.45.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.42.rc'
36
+ gem 'ultracart_api', '~> 4.0.45.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
@@ -575,6 +577,11 @@ Class | Method | HTTP request | Description
575
577
  - [UltracartClient::ConversationStartRequest](docs/ConversationStartRequest.md)
576
578
  - [UltracartClient::ConversationStartResponse](docs/ConversationStartResponse.md)
577
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)
578
585
  - [UltracartClient::ConversationWebsocketMessage](docs/ConversationWebsocketMessage.md)
579
586
  - [UltracartClient::ConversationsResponse](docs/ConversationsResponse.md)
580
587
  - [UltracartClient::CountriesResponse](docs/CountriesResponse.md)
@@ -1167,6 +1174,9 @@ Not every change is committed to every SDK.
1167
1174
 
1168
1175
  | Version | Date | Comments |
1169
1176
  | --: | :-: | --- |
1177
+ | 4.0.45-RC | 07/28/2022 | conversation bug fixes |
1178
+ | 4.0.44-RC | 07/28/2022 | conversation message upload keys property |
1179
+ | 4.0.43-RC | 07/26/2022 | conversations - queue statistics |
1170
1180
  | 4.0.42-RC | 07/25/2022 | conversation development |
1171
1181
  | 4.0.41-RC | 07/25/2022 | conversations bug fixes |
1172
1182
  | 4.0.40-RC | 07/25/2022 | conversations - add a websocket message model |
@@ -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
+
@@ -10,6 +10,7 @@
10
10
  | **media_urls** | **Array&lt;String&gt;** | | [optional] |
11
11
  | **message_dts** | **String** | Message date/time | [optional] |
12
12
  | **transport_statuses** | [**Array&lt;ConversationMessageTransportStatus&gt;**](ConversationMessageTransportStatus.md) | | [optional] |
13
+ | **upload_keys** | **Array&lt;String&gt;** | | [optional] |
13
14
 
14
15
  ## Example
15
16
 
@@ -22,7 +23,8 @@ instance = UltracartClient::ConversationMessage.new(
22
23
  body: null,
23
24
  media_urls: null,
24
25
  message_dts: null,
25
- transport_statuses: null
26
+ transport_statuses: null,
27
+ upload_keys: null
26
28
  )
27
29
  ```
28
30
 
@@ -0,0 +1,46 @@
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_average_abandon_time_seconds** | **Integer** | | [optional] |
15
+ | **customer_average_chat_time_seconds** | **Integer** | | [optional] |
16
+ | **customer_average_hold_time_seconds** | **Integer** | | [optional] |
17
+ | **customer_chat_count** | **Integer** | | [optional] |
18
+ | **customer_waiting_count** | **Integer** | | [optional] |
19
+ | **customer_waiting_join_dts** | **String** | Date/time that the oldest person joined the queue | [optional] |
20
+ | **queue_entries** | [**Array&lt;ConversationWebchatQueueStatusQueueEntry&gt;**](ConversationWebchatQueueStatusQueueEntry.md) | | [optional] |
21
+ | **queue_name** | **String** | | [optional] |
22
+
23
+ ## Example
24
+
25
+ ```ruby
26
+ require 'ultracart_api'
27
+
28
+ instance = UltracartClient::ConversationWebchatQueueStatus.new(
29
+ agent_available_count: null,
30
+ agent_busy_count: null,
31
+ agent_count: null,
32
+ agent_unavailable_count: null,
33
+ agents: null,
34
+ customer_abandon_count: null,
35
+ customer_active_count: null,
36
+ customer_average_abandon_time_seconds: null,
37
+ customer_average_chat_time_seconds: null,
38
+ customer_average_hold_time_seconds: null,
39
+ customer_chat_count: null,
40
+ customer_waiting_count: null,
41
+ customer_waiting_join_dts: null,
42
+ queue_entries: null,
43
+ queue_name: null
44
+ )
45
+ ```
46
+
@@ -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,28 @@
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
+ | **email** | **String** | | [optional] |
11
+ | **join_dts** | **String** | Date/time the customer joined the queue | [optional] |
12
+ | **question** | **String** | | [optional] |
13
+
14
+ ## Example
15
+
16
+ ```ruby
17
+ require 'ultracart_api'
18
+
19
+ instance = UltracartClient::ConversationWebchatQueueStatusQueueEntry.new(
20
+ conversation_participant_arn: null,
21
+ conversation_participant_name: null,
22
+ conversation_webchat_queue_uuid: null,
23
+ email: null,
24
+ join_dts: null,
25
+ question: null
26
+ )
27
+ ```
28
+
@@ -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
+
@@ -9,6 +9,7 @@
9
9
  | **event_new_conversation** | [**ConversationSummary**](ConversationSummary.md) | | [optional] |
10
10
  | **event_new_message** | [**ConversationSummary**](ConversationSummary.md) | | [optional] |
11
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
@@ -28,6 +28,8 @@ module UltracartClient
28
28
 
29
29
  attr_accessor :transport_statuses
30
30
 
31
+ attr_accessor :upload_keys
32
+
31
33
  # Attribute mapping from ruby-style variable name to JSON key.
32
34
  def self.attribute_map
33
35
  {
@@ -36,7 +38,8 @@ module UltracartClient
36
38
  :'body' => :'body',
37
39
  :'media_urls' => :'media_urls',
38
40
  :'message_dts' => :'message_dts',
39
- :'transport_statuses' => :'transport_statuses'
41
+ :'transport_statuses' => :'transport_statuses',
42
+ :'upload_keys' => :'upload_keys'
40
43
  }
41
44
  end
42
45
 
@@ -53,7 +56,8 @@ module UltracartClient
53
56
  :'body' => :'String',
54
57
  :'media_urls' => :'Array<String>',
55
58
  :'message_dts' => :'String',
56
- :'transport_statuses' => :'Array<ConversationMessageTransportStatus>'
59
+ :'transport_statuses' => :'Array<ConversationMessageTransportStatus>',
60
+ :'upload_keys' => :'Array<String>'
57
61
  }
58
62
  end
59
63
 
@@ -105,6 +109,12 @@ module UltracartClient
105
109
  self.transport_statuses = value
106
110
  end
107
111
  end
112
+
113
+ if attributes.key?(:'upload_keys')
114
+ if (value = attributes[:'upload_keys']).is_a?(Array)
115
+ self.upload_keys = value
116
+ end
117
+ end
108
118
  end
109
119
 
110
120
  # Show invalid properties with the reasons. Usually used together with valid?
@@ -130,7 +140,8 @@ module UltracartClient
130
140
  body == o.body &&
131
141
  media_urls == o.media_urls &&
132
142
  message_dts == o.message_dts &&
133
- transport_statuses == o.transport_statuses
143
+ transport_statuses == o.transport_statuses &&
144
+ upload_keys == o.upload_keys
134
145
  end
135
146
 
136
147
  # @see the `==` method
@@ -142,7 +153,7 @@ module UltracartClient
142
153
  # Calculates hash code according to all attributes.
143
154
  # @return [Integer] Hash code
144
155
  def hash
145
- [author_conversation_participant_arn, author_conversation_participant_name, body, media_urls, message_dts, transport_statuses].hash
156
+ [author_conversation_participant_arn, author_conversation_participant_name, body, media_urls, message_dts, transport_statuses, upload_keys].hash
146
157
  end
147
158
 
148
159
  # Builds the object from hash