ultracart_api 3.10.25 → 3.10.28

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 62018a5360eca7ec5b4486ada8cd994c8ac49961de2dd9573647be2813a19d23
-  data.tar.gz: 1c75d92c474562d84e62b756679b2053a6abc61cc85142e556aff0a8ffc9b74b
+  metadata.gz: 318716e3c951f48123d5680ccb6eeaaae0d1730abdce2e8331d3147870e4e257
+  data.tar.gz: c36d17549fb0f6a52b7367e4f26278fc18052af5d08e529c2b2d00fb390a1b7c
 SHA512:
-  metadata.gz: 3113af69817554808e0e47baa6300d832d3821b7f5bc9527533a786182bd064ad286808cc0bca36ad91f4a6438a0b1bc9831aa0497118d010e8946bd93a4523a
-  data.tar.gz: 1e1de9bde6fde313c13a5ca9c9185f74dfd203ecba9d58aca6f3f920b34802c697e62fe720c8d6e2fa5be233fa332343f273019023dcb10db44f5e8077961ff9
+  metadata.gz: d1bc988c0d76418ab36b3cb64f395b1c7f79558c837e0511746b3b0365aa186cd01b04608aca5dd36243c16d437f8b9f589e068e4249458d3045127b3b5bdf2b
+  data.tar.gz: 9590096f203eceed86560be5a2599a595e15c21917ec3f9c9b04eefd270f72489e235eb8de0b10d0cd32a95a83cf71442124113a7ed4fce657faf43bddfb5c5a

data/README.md

@@ -7,7 +7,7 @@ UltraCart REST API Version 2
 This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
 
 - API version: 2.0.0
-- Package version: 3.10.25
+- Package version: 3.10.28
 - Build package: io.swagger.codegen.languages.RubyClientCodegen
 For more information, please visit [http://www.ultracart.com](http://www.ultracart.com)
 
@@ -24,15 +24,15 @@ gem build ultracart_api.gemspec
 Then either install the gem locally:
 
 ```shell
-gem install ./ultracart_api-3.10.25.gem
+gem install ./ultracart_api-3.10.28.gem
 ```
-(for development, run `gem install --dev ./ultracart_api-3.10.25.gem` to install the development dependencies)
+(for development, run `gem install --dev ./ultracart_api-3.10.28.gem` to install the development dependencies)
 
 or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
 
 Finally add this to the Gemfile:
 
-    gem 'ultracart_api', '~> 3.10.25'
+    gem 'ultracart_api', '~> 3.10.28'
 
 ### Install from Git
 
@@ -128,10 +128,12 @@ Class | Method | HTTP request | Description
 *UltracartClient::ConversationApi* | [**get_agent_websocket_authorization**](docs/ConversationApi.md#get_agent_websocket_authorization) | **PUT** /conversation/agent/auth | Get agent websocket authorization
 *UltracartClient::ConversationApi* | [**get_conversation**](docs/ConversationApi.md#get_conversation) | **GET** /conversation/conversations/{conversation_uuid} | Retrieve a conversation
 *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
+*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
 *UltracartClient::ConversationApi* | [**get_conversations**](docs/ConversationApi.md#get_conversations) | **GET** /conversation/conversations | Retrieve a list of conversation summaries newest to oldest
 *UltracartClient::ConversationApi* | [**join_conversation**](docs/ConversationApi.md#join_conversation) | **PUT** /conversation/conversations/{conversation_uuid}/join | Join a conversation
 *UltracartClient::ConversationApi* | [**leave_conversation**](docs/ConversationApi.md#leave_conversation) | **DELETE** /conversation/conversations/{conversation_uuid}/leave | Leave a conversation
 *UltracartClient::ConversationApi* | [**start_conversation**](docs/ConversationApi.md#start_conversation) | **PUT** /conversation/conversations | Start a conversation
+*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
 *UltracartClient::CouponApi* | [**delete_coupon**](docs/CouponApi.md#delete_coupon) | **DELETE** /coupon/coupons/{coupon_oid} | Delete a coupon
 *UltracartClient::CouponApi* | [**delete_coupons_by_code**](docs/CouponApi.md#delete_coupons_by_code) | **DELETE** /coupon/coupons/by_code | Deletes multiple coupons
 *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
  - [UltracartClient::ConversationStartRequest](docs/ConversationStartRequest.md)
  - [UltracartClient::ConversationStartResponse](docs/ConversationStartResponse.md)
  - [UltracartClient::ConversationSummary](docs/ConversationSummary.md)
+ - [UltracartClient::ConversationWebchatQueueStatus](docs/ConversationWebchatQueueStatus.md)
+ - [UltracartClient::ConversationWebchatQueueStatusAgent](docs/ConversationWebchatQueueStatusAgent.md)
+ - [UltracartClient::ConversationWebchatQueueStatusQueueEntry](docs/ConversationWebchatQueueStatusQueueEntry.md)
+ - [UltracartClient::ConversationWebchatQueueStatusUpdateRequest](docs/ConversationWebchatQueueStatusUpdateRequest.md)
+ - [UltracartClient::ConversationWebchatQueueStatusesResponse](docs/ConversationWebchatQueueStatusesResponse.md)
  - [UltracartClient::ConversationWebsocketMessage](docs/ConversationWebsocketMessage.md)
  - [UltracartClient::ConversationsResponse](docs/ConversationsResponse.md)
  - [UltracartClient::CountriesResponse](docs/CountriesResponse.md)
@@ -1159,6 +1166,9 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 3.10.28 | 07/28/2022 | conversation bug fixes |
+| 3.10.27 | 07/28/2022 | conversation message upload keys property |
+| 3.10.26 | 07/26/2022 | conversations - queue statistics |
 | 3.10.25 | 07/25/2022 | conversation development |
 | 3.10.24 | 07/25/2022 | conversations bug fixes |
 | 3.10.23 | 07/25/2022 | conversations - add a websocket message model |

data/docs/ConversationApi.md

@@ -7,10 +7,12 @@ Method | HTTP request | Description
 [**get_agent_websocket_authorization**](ConversationApi.md#get_agent_websocket_authorization) | **PUT** /conversation/agent/auth | Get agent websocket authorization
 [**get_conversation**](ConversationApi.md#get_conversation) | **GET** /conversation/conversations/{conversation_uuid} | Retrieve a conversation
 [**get_conversation_multimedia_upload_url**](ConversationApi.md#get_conversation_multimedia_upload_url) | **GET** /conversation/upload_url/{extension} | Get a presigned conersation multimedia upload URL
+[**get_conversation_webchat_queue_statuses**](ConversationApi.md#get_conversation_webchat_queue_statuses) | **GET** /conversation/conversations/queues/statuses | Retrieve a conversation webchat queue statuses
 [**get_conversations**](ConversationApi.md#get_conversations) | **GET** /conversation/conversations | Retrieve a list of conversation summaries newest to oldest
 [**join_conversation**](ConversationApi.md#join_conversation) | **PUT** /conversation/conversations/{conversation_uuid}/join | Join a conversation
 [**leave_conversation**](ConversationApi.md#leave_conversation) | **DELETE** /conversation/conversations/{conversation_uuid}/leave | Leave a conversation
 [**start_conversation**](ConversationApi.md#start_conversation) | **PUT** /conversation/conversations | Start a conversation
+[**update_conversation_webchat_queue_status**](ConversationApi.md#update_conversation_webchat_queue_status) | **PUT** /conversation/conversations/queues/{queue_name}/status | Update status within the queue
 
 
 # **get_agent_websocket_authorization**
@@ -158,6 +160,51 @@ Name | Type | Description  | Notes
 
 
 
+# **get_conversation_webchat_queue_statuses**
+> ConversationWebchatQueueStatusesResponse get_conversation_webchat_queue_statuses
+
+Retrieve a conversation webchat queue statuses
+
+Retrieve a conversation webchat queue statuses including agent status and queue entries 
+
+### Example
+```ruby
+# load the gem
+require 'ultracart_api'
+
+# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
+simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
+api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
+
+
+
+begin
+  #Retrieve a conversation webchat queue statuses
+  result = api_instance.get_conversation_webchat_queue_statuses
+  p result
+rescue UltracartClient::ApiError => e
+  puts "Exception when calling ConversationApi->get_conversation_webchat_queue_statuses: #{e}"
+end
+```
+
+### Parameters
+This endpoint does not need any parameter.
+
+### Return type
+
+[**ConversationWebchatQueueStatusesResponse**](ConversationWebchatQueueStatusesResponse.md)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
 # **get_conversations**
 > ConversationsResponse get_conversations(opts)
 
@@ -359,3 +406,55 @@ Name | Type | Description  | Notes
 
 
 
+# **update_conversation_webchat_queue_status**
+> update_conversation_webchat_queue_status(queue_name, status_request)
+
+Update status within the queue
+
+Update status within the queue 
+
+### Example
+```ruby
+# load the gem
+require 'ultracart_api'
+
+# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
+simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
+api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
+
+
+queue_name = 'queue_name_example' # String | 
+
+status_request = UltracartClient::ConversationWebchatQueueStatusUpdateRequest.new # ConversationWebchatQueueStatusUpdateRequest | Status request
+
+
+begin
+  #Update status within the queue
+  api_instance.update_conversation_webchat_queue_status(queue_name, status_request)
+rescue UltracartClient::ApiError => e
+  puts "Exception when calling ConversationApi->update_conversation_webchat_queue_status: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **queue_name** | **String**|  | 
+ **status_request** | [**ConversationWebchatQueueStatusUpdateRequest**](ConversationWebchatQueueStatusUpdateRequest.md)| Status request | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+

data/docs/ConversationMessage.md

@@ -9,5 +9,6 @@ Name | Type | Description | Notes
 **media_urls** | **Array<String>** |  | [optional] 
 **message_dts** | **String** | Message date/time | [optional] 
 **transport_statuses** | [**Array<ConversationMessageTransportStatus>**](ConversationMessageTransportStatus.md) |  | [optional] 
+**upload_keys** | **Array<String>** |  | [optional] 
 
 

data/docs/ConversationWebchatQueueStatus.md

@@ -0,0 +1,22 @@
+# UltracartClient::ConversationWebchatQueueStatus
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**agent_available_count** | **Integer** |  | [optional] 
+**agent_busy_count** | **Integer** |  | [optional] 
+**agent_count** | **Integer** |  | [optional] 
+**agent_unavailable_count** | **Integer** |  | [optional] 
+**agents** | [**Array<ConversationWebchatQueueStatusAgent>**](ConversationWebchatQueueStatusAgent.md) |  | [optional] 
+**customer_abandon_count** | **Integer** |  | [optional] 
+**customer_active_count** | **Integer** |  | [optional] 
+**customer_average_abandon_time_seconds** | **Integer** |  | [optional] 
+**customer_average_chat_time_seconds** | **Integer** |  | [optional] 
+**customer_average_hold_time_seconds** | **Integer** |  | [optional] 
+**customer_chat_count** | **Integer** |  | [optional] 
+**customer_waiting_count** | **Integer** |  | [optional] 
+**customer_waiting_join_dts** | **String** | Date/time that the oldest person joined the queue | [optional] 
+**queue_entries** | [**Array<ConversationWebchatQueueStatusQueueEntry>**](ConversationWebchatQueueStatusQueueEntry.md) |  | [optional] 
+**queue_name** | **String** |  | [optional] 
+
+

data/docs/ConversationWebchatQueueStatusAgent.md

@@ -0,0 +1,12 @@
+# UltracartClient::ConversationWebchatQueueStatusAgent
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**agent_status** | **String** |  | [optional] 
+**conversation_participant_arn** | **String** |  | [optional] 
+**conversation_participant_name** | **String** |  | [optional] 
+**last_chat_dts** | **String** | Date/time that this agent took their last chat | [optional] 
+**next_round_robin** | **BOOLEAN** |  | [optional] 
+
+

data/docs/ConversationWebchatQueueStatusQueueEntry.md

@@ -0,0 +1,13 @@
+# UltracartClient::ConversationWebchatQueueStatusQueueEntry
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**conversation_participant_arn** | **String** |  | [optional] 
+**conversation_participant_name** | **String** |  | [optional] 
+**conversation_webchat_queue_uuid** | **String** |  | [optional] 
+**email** | **String** |  | [optional] 
+**join_dts** | **String** | Date/time the customer joined the queue | [optional] 
+**question** | **String** |  | [optional] 
+
+

data/docs/ConversationWebchatQueueStatusUpdateRequest.md

@@ -0,0 +1,8 @@
+# UltracartClient::ConversationWebchatQueueStatusUpdateRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**agent_status** | **String** |  | [optional] 
+
+

data/docs/ConversationWebchatQueueStatusesResponse.md

@@ -0,0 +1,12 @@
+# UltracartClient::ConversationWebchatQueueStatusesResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**error** | [**Error**](Error.md) |  | [optional] 
+**metadata** | [**ResponseMetadata**](ResponseMetadata.md) |  | [optional] 
+**queue_statuses** | [**Array<ConversationWebchatQueueStatus>**](ConversationWebchatQueueStatus.md) |  | [optional] 
+**success** | **BOOLEAN** | Indicates if API call was successful | [optional] 
+**warning** | [**Warning**](Warning.md) |  | [optional] 
+
+

data/docs/ConversationWebsocketMessage.md

@@ -8,6 +8,7 @@ Name | Type | Description | Notes
 **event_new_conversation** | [**ConversationSummary**](ConversationSummary.md) |  | [optional] 
 **event_new_message** | [**ConversationSummary**](ConversationSummary.md) |  | [optional] 
 **event_queue_position** | [**ConversationEventQueuePosition**](ConversationEventQueuePosition.md) |  | [optional] 
+**event_queue_status_update** | [**ConversationWebchatQueueStatus**](ConversationWebchatQueueStatus.md) |  | [optional] 
 **event_type** | **String** | Type of event | [optional] 
 **event_updated_message** | [**ConversationMessage**](ConversationMessage.md) |  | [optional] 
 **message** | [**ConversationMessage**](ConversationMessage.md) |  | [optional] 

data/lib/ultracart_api/api/conversation_api.rb

@@ -191,6 +191,55 @@ module UltracartClient
       end
       return data, status_code, headers
     end
+    # Retrieve a conversation webchat queue statuses
+    # Retrieve a conversation webchat queue statuses including agent status and queue entries 
+    # @param [Hash] opts the optional parameters
+    # @return [ConversationWebchatQueueStatusesResponse]
+    def get_conversation_webchat_queue_statuses(opts = {})
+      data, _status_code, _headers = get_conversation_webchat_queue_statuses_with_http_info(opts)
+      data
+    end
+
+    # Retrieve a conversation webchat queue statuses
+    # Retrieve a conversation webchat queue statuses including agent status and queue entries 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(ConversationWebchatQueueStatusesResponse, Fixnum, Hash)>] ConversationWebchatQueueStatusesResponse data, response status code and response headers
+    def get_conversation_webchat_queue_statuses_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ConversationApi.get_conversation_webchat_queue_statuses ...'
+      end
+      # resource path
+      local_var_path = '/conversation/conversations/queues/statuses'
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+      header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'ConversationWebchatQueueStatusesResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ConversationApi#get_conversation_webchat_queue_statuses\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
     # Retrieve a list of conversation summaries newest to oldest
     # Retrieve a list of conversation summaries that are ordered newest to oldest, include the most recent message and whether its been read. 
     # @param [Hash] opts the optional parameters
@@ -409,5 +458,65 @@ module UltracartClient
       end
       return data, status_code, headers
     end
+    # Update status within the queue
+    # Update status within the queue 
+    # @param queue_name 
+    # @param status_request Status request
+    # @param [Hash] opts the optional parameters
+    # @return [nil]
+    def update_conversation_webchat_queue_status(queue_name, status_request, opts = {})
+      update_conversation_webchat_queue_status_with_http_info(queue_name, status_request, opts)
+      nil
+    end
+
+    # Update status within the queue
+    # Update status within the queue 
+    # @param queue_name 
+    # @param status_request Status request
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
+    def update_conversation_webchat_queue_status_with_http_info(queue_name, status_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ConversationApi.update_conversation_webchat_queue_status ...'
+      end
+      # verify the required parameter 'queue_name' is set
+      if @api_client.config.client_side_validation && queue_name.nil?
+        fail ArgumentError, "Missing the required parameter 'queue_name' when calling ConversationApi.update_conversation_webchat_queue_status"
+      end
+      # verify the required parameter 'status_request' is set
+      if @api_client.config.client_side_validation && status_request.nil?
+        fail ArgumentError, "Missing the required parameter 'status_request' when calling ConversationApi.update_conversation_webchat_queue_status"
+      end
+      # resource path
+      local_var_path = '/conversation/conversations/queues/{queue_name}/status'.sub('{' + 'queue_name' + '}', queue_name.to_s)
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+      header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = @api_client.object_to_http_body(status_request)
+      auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
+      data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ConversationApi#update_conversation_webchat_queue_status\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
   end
 end

data/lib/ultracart_api/models/conversation_message.rb

@@ -27,6 +27,8 @@ module UltracartClient
 
     attr_accessor :transport_statuses
 
+    attr_accessor :upload_keys
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -35,7 +37,8 @@ module UltracartClient
         :'body' => :'body',
         :'media_urls' => :'media_urls',
         :'message_dts' => :'message_dts',
-        :'transport_statuses' => :'transport_statuses'
+        :'transport_statuses' => :'transport_statuses',
+        :'upload_keys' => :'upload_keys'
       }
     end
 
@@ -47,7 +50,8 @@ module UltracartClient
         :'body' => :'String',
         :'media_urls' => :'Array<String>',
         :'message_dts' => :'String',
-        :'transport_statuses' => :'Array<ConversationMessageTransportStatus>'
+        :'transport_statuses' => :'Array<ConversationMessageTransportStatus>',
+        :'upload_keys' => :'Array<String>'
       }
     end
 
@@ -86,6 +90,12 @@ module UltracartClient
           self.transport_statuses = value
         end
       end
+
+      if attributes.has_key?(:'upload_keys')
+        if (value = attributes[:'upload_keys']).is_a?(Array)
+          self.upload_keys = value
+        end
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -111,7 +121,8 @@ module UltracartClient
           body == o.body &&
           media_urls == o.media_urls &&
           message_dts == o.message_dts &&
-          transport_statuses == o.transport_statuses
+          transport_statuses == o.transport_statuses &&
+          upload_keys == o.upload_keys
     end
 
     # @see the `==` method
@@ -123,7 +134,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [author_conversation_participant_arn, author_conversation_participant_name, body, media_urls, message_dts, transport_statuses].hash
+      [author_conversation_participant_arn, author_conversation_participant_name, body, media_urls, message_dts, transport_statuses, upload_keys].hash
     end
 
     # Builds the object from hash