ultracart_api 3.10.110 → 3.10.112

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5db5747b55451d230c39fbaf8d39e27ae438f6de418dee65fbd289199cc45df5
-  data.tar.gz: 0f905b2afdbdd8c4e1018e6597726381c00e4d3a0ec409523d1b404562717bf1
+  metadata.gz: 9d478126dcf8d78557310703d92f65e13e1ef35f7b9ee413ff5b585001a6be78
+  data.tar.gz: 75fd2e621b8abd3778cb21a0eb24781350cadd545d8ceb52fd66637e2f4b52ee
 SHA512:
-  metadata.gz: 84fef32a36c7344e961f359ce2b9db75b1d08bb068c777cb5bb52fd635d7f89f0f4a31c0158661ea8667e15c93f194480200db15829c384212a7c1df43d196a2
-  data.tar.gz: 050d75c0cd10fc190f45656df35cda65280c7598caa90e28f3d1ee5ea64183b07e5dff7edf697e48d4d970330c1014bade3fba72bdecadf580f289b4890ac29e
+  metadata.gz: 04aeceb86cf35d50d76e274496353871ad08587b34331828dcd4e25d0ac31f078f28475ad75338b4d0a1928ee6627e918fba385feeab5ffcb6119c22c405b9dd
+  data.tar.gz: 12ec7862c79f823ea8c49a4244bd0407ed6fd1d7e07bc22faa8c5c1102c67dc333af9d90d15d5d620f94b0c05dcbd94fa29288b6d2d4bb1491158eb4551b40cb

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.110
+- Package version: 3.10.112
 - 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.110.gem
+gem install ./ultracart_api-3.10.112.gem
 ```
-(for development, run `gem install --dev ./ultracart_api-3.10.110.gem` to install the development dependencies)
+(for development, run `gem install --dev ./ultracart_api-3.10.112.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.110'
+    gem 'ultracart_api', '~> 3.10.112'
 
 ### Install from Git
 
@@ -135,6 +135,7 @@ Class | Method | HTTP request | Description
 *UltracartClient::ConversationApi* | [**delete_department**](docs/ConversationApi.md#delete_department) | **DELETE** /conversation/departments/{conversation_department_oid} | Delete a conversation department
 *UltracartClient::ConversationApi* | [**delete_engagement**](docs/ConversationApi.md#delete_engagement) | **DELETE** /conversation/engagements/{conversation_engagement_oid} | Delete a conversation engagement
 *UltracartClient::ConversationApi* | [**get_agent_keep_alive**](docs/ConversationApi.md#get_agent_keep_alive) | **GET** /conversation/agent/keepalive | Agent keep alive
+*UltracartClient::ConversationApi* | [**get_agent_profile**](docs/ConversationApi.md#get_agent_profile) | **GET** /conversation/agent/profile | Get agent profile
 *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_canned_messages**](docs/ConversationApi.md#get_conversation_canned_messages) | **GET** /conversation/canned_messages | Retrieve a list of canned messages ordered by short_code
@@ -159,6 +160,7 @@ Class | Method | HTTP request | Description
 *UltracartClient::ConversationApi* | [**mark_read_conversation**](docs/ConversationApi.md#mark_read_conversation) | **PUT** /conversation/conversations/{conversation_uuid}/markread | Mark a conversation as read
 *UltracartClient::ConversationApi* | [**search_conversation_canned_messages**](docs/ConversationApi.md#search_conversation_canned_messages) | **POST** /conversation/canned_messages/search | Search for canned messages by short_code
 *UltracartClient::ConversationApi* | [**start_conversation**](docs/ConversationApi.md#start_conversation) | **PUT** /conversation/conversations | Start a conversation
+*UltracartClient::ConversationApi* | [**update_agent_profile**](docs/ConversationApi.md#update_agent_profile) | **PUT** /conversation/agent/profile | Update agent profile
 *UltracartClient::ConversationApi* | [**update_conversation_canned_message**](docs/ConversationApi.md#update_conversation_canned_message) | **PUT** /conversation/canned_messages/{conversation_canned_message_oid} | Update a canned message
 *UltracartClient::ConversationApi* | [**update_conversation_department**](docs/ConversationApi.md#update_conversation_department) | **PUT** /conversation/departments/{conversation_department_oid} | Update a department
 *UltracartClient::ConversationApi* | [**update_conversation_engagement**](docs/ConversationApi.md#update_conversation_engagement) | **PUT** /conversation/engagements/{conversation_engagement_oid} | Update a engagement
@@ -616,6 +618,8 @@ Class | Method | HTTP request | Description
  - [UltracartClient::Conversation](docs/Conversation.md)
  - [UltracartClient::ConversationAgentAuth](docs/ConversationAgentAuth.md)
  - [UltracartClient::ConversationAgentAuthResponse](docs/ConversationAgentAuthResponse.md)
+ - [UltracartClient::ConversationAgentProfile](docs/ConversationAgentProfile.md)
+ - [UltracartClient::ConversationAgentProfileResponse](docs/ConversationAgentProfileResponse.md)
  - [UltracartClient::ConversationAutocompleteRequest](docs/ConversationAutocompleteRequest.md)
  - [UltracartClient::ConversationAutocompleteResponse](docs/ConversationAutocompleteResponse.md)
  - [UltracartClient::ConversationAutocompleteValue](docs/ConversationAutocompleteValue.md)
@@ -1296,6 +1300,8 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 3.10.112 | 02/01/2023 | convo - agent profile get/update methods |
+| 3.10.111 | 01/27/2023 | convo - added event_engage_customer property to message |
 | 3.10.110 | 01/27/2023 | conversations - getLocationsForEngagement method |
 | 3.10.109 | 01/26/2023 | typo in ConversationWebsocketMessage |
 | 3.10.108 | 01/25/2023 | conversation - added message type of engagement prompt |

data/docs/ConversationAgentProfile.md

@@ -0,0 +1,14 @@
+# UltracartClient::ConversationAgentProfile
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**chat_limit** | **Integer** | The number of engagement chats that can be pushed on them at any given time. | [optional] 
+**default_language_iso_code** | **String** | The default language the agent is chatting in | [optional] 
+**default_status** | **String** | Default status when the agent loads conversations app. | [optional] 
+**display_name** | **String** | An alternate name that the agent wants to use in chat. | [optional] 
+**name** | **String** | Their actual user name for profile settings display as placeholder test | [optional] 
+**profile_image_upload_key** | **String** | An upload key used to update the profile image. | [optional] 
+**profile_image_url** | **String** | Their current profile image URL | [optional] 
+
+

data/docs/ConversationAgentProfileResponse.md

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

data/docs/ConversationApi.md

@@ -8,6 +8,7 @@ Method | HTTP request | Description
 [**delete_department**](ConversationApi.md#delete_department) | **DELETE** /conversation/departments/{conversation_department_oid} | Delete a conversation department
 [**delete_engagement**](ConversationApi.md#delete_engagement) | **DELETE** /conversation/engagements/{conversation_engagement_oid} | Delete a conversation engagement
 [**get_agent_keep_alive**](ConversationApi.md#get_agent_keep_alive) | **GET** /conversation/agent/keepalive | Agent keep alive
+[**get_agent_profile**](ConversationApi.md#get_agent_profile) | **GET** /conversation/agent/profile | Get agent profile
 [**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_canned_messages**](ConversationApi.md#get_conversation_canned_messages) | **GET** /conversation/canned_messages | Retrieve a list of canned messages ordered by short_code
@@ -32,6 +33,7 @@ Method | HTTP request | Description
 [**mark_read_conversation**](ConversationApi.md#mark_read_conversation) | **PUT** /conversation/conversations/{conversation_uuid}/markread | Mark a conversation as read
 [**search_conversation_canned_messages**](ConversationApi.md#search_conversation_canned_messages) | **POST** /conversation/canned_messages/search | Search for canned messages by short_code
 [**start_conversation**](ConversationApi.md#start_conversation) | **PUT** /conversation/conversations | Start a conversation
+[**update_agent_profile**](ConversationApi.md#update_agent_profile) | **PUT** /conversation/agent/profile | Update agent profile
 [**update_conversation_canned_message**](ConversationApi.md#update_conversation_canned_message) | **PUT** /conversation/canned_messages/{conversation_canned_message_oid} | Update a canned message
 [**update_conversation_department**](ConversationApi.md#update_conversation_department) | **PUT** /conversation/departments/{conversation_department_oid} | Update a department
 [**update_conversation_engagement**](ConversationApi.md#update_conversation_engagement) | **PUT** /conversation/engagements/{conversation_engagement_oid} | Update a engagement
@@ -229,6 +231,51 @@ nil (empty response body)
 
 
 
+# **get_agent_profile**
+> ConversationAgentProfileResponse get_agent_profile
+
+Get agent profile
+
+Retrieve the agents profile 
+
+### 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
+  #Get agent profile
+  result = api_instance.get_agent_profile
+  p result
+rescue UltracartClient::ApiError => e
+  puts "Exception when calling ConversationApi->get_agent_profile: #{e}"
+end
+```
+
+### Parameters
+This endpoint does not need any parameter.
+
+### Return type
+
+[**ConversationAgentProfileResponse**](ConversationAgentProfileResponse.md)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
 # **get_agent_websocket_authorization**
 > ConversationAgentAuthResponse get_agent_websocket_authorization
 
@@ -1408,6 +1455,56 @@ Name | Type | Description  | Notes
 
 
 
+# **update_agent_profile**
+> ConversationAgentProfileResponse update_agent_profile(profile_request)
+
+Update agent profile
+
+Update agent profile 
+
+### 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)
+
+
+profile_request = UltracartClient::ConversationAgentProfile.new # ConversationAgentProfile | Profile request
+
+
+begin
+  #Update agent profile
+  result = api_instance.update_agent_profile(profile_request)
+  p result
+rescue UltracartClient::ApiError => e
+  puts "Exception when calling ConversationApi->update_agent_profile: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **profile_request** | [**ConversationAgentProfile**](ConversationAgentProfile.md)| Profile request | 
+
+### Return type
+
+[**ConversationAgentProfileResponse**](ConversationAgentProfileResponse.md)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
 # **update_conversation_canned_message**
 > ConversationCannedMessageResponse update_conversation_canned_message(conversation_canned_message_oid, canned_message)
 

data/docs/ConversationWebsocketMessage.md

@@ -7,6 +7,7 @@ Name | Type | Description | Notes
 **event_add_coupon** | [**ConversationEventAddCoupon**](ConversationEventAddCoupon.md) |  | [optional] 
 **event_add_item** | [**ConversationEventAddItem**](ConversationEventAddItem.md) |  | [optional] 
 **event_conversation_closed** | [**ConversationSummary**](ConversationSummary.md) |  | [optional] 
+**event_engage_customer** | [**ConversationWebchatQueueStatusQueueEntry**](ConversationWebchatQueueStatusQueueEntry.md) |  | [optional] 
 **event_new_conversation** | [**ConversationSummary**](ConversationSummary.md) |  | [optional] 
 **event_new_message** | [**ConversationSummary**](ConversationSummary.md) |  | [optional] 
 **event_participant_join** | [**ConversationSummary**](ConversationSummary.md) |  | [optional] 

data/lib/ultracart_api/api/conversation_api.rb

@@ -242,6 +242,55 @@ module UltracartClient
       end
       return data, status_code, headers
     end
+    # Get agent profile
+    # Retrieve the agents profile 
+    # @param [Hash] opts the optional parameters
+    # @return [ConversationAgentProfileResponse]
+    def get_agent_profile(opts = {})
+      data, _status_code, _headers = get_agent_profile_with_http_info(opts)
+      data
+    end
+
+    # Get agent profile
+    # Retrieve the agents profile 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(ConversationAgentProfileResponse, Fixnum, Hash)>] ConversationAgentProfileResponse data, response status code and response headers
+    def get_agent_profile_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ConversationApi.get_agent_profile ...'
+      end
+      # resource path
+      local_var_path = '/conversation/agent/profile'
+
+      # 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 => 'ConversationAgentProfileResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ConversationApi#get_agent_profile\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
     # Get agent websocket authorization
     # Retrieve a JWT to authorize an agent to make a websocket connection. 
     # @param [Hash] opts the optional parameters
@@ -1531,6 +1580,61 @@ module UltracartClient
       end
       return data, status_code, headers
     end
+    # Update agent profile
+    # Update agent profile 
+    # @param profile_request Profile request
+    # @param [Hash] opts the optional parameters
+    # @return [ConversationAgentProfileResponse]
+    def update_agent_profile(profile_request, opts = {})
+      data, _status_code, _headers = update_agent_profile_with_http_info(profile_request, opts)
+      data
+    end
+
+    # Update agent profile
+    # Update agent profile 
+    # @param profile_request Profile request
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(ConversationAgentProfileResponse, Fixnum, Hash)>] ConversationAgentProfileResponse data, response status code and response headers
+    def update_agent_profile_with_http_info(profile_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ConversationApi.update_agent_profile ...'
+      end
+      # verify the required parameter 'profile_request' is set
+      if @api_client.config.client_side_validation && profile_request.nil?
+        fail ArgumentError, "Missing the required parameter 'profile_request' when calling ConversationApi.update_agent_profile"
+      end
+      # resource path
+      local_var_path = '/conversation/agent/profile'
+
+      # 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(profile_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,
+        :return_type => 'ConversationAgentProfileResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ConversationApi#update_agent_profile\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
     # Update a canned message
     # Update a canned message 
     # @param conversation_canned_message_oid 

data/lib/ultracart_api/models/conversation_agent_profile.rb

@@ -0,0 +1,279 @@
+=begin
+#UltraCart Rest API V2
+
+#UltraCart REST API Version 2
+
+OpenAPI spec version: 2.0.0
+Contact: support@ultracart.com
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.4.15-SNAPSHOT
+
+=end
+
+require 'date'
+
+module UltracartClient
+  class ConversationAgentProfile
+    # The number of engagement chats that can be pushed on them at any given time.
+    attr_accessor :chat_limit
+
+    # The default language the agent is chatting in
+    attr_accessor :default_language_iso_code
+
+    # Default status when the agent loads conversations app.
+    attr_accessor :default_status
+
+    # An alternate name that the agent wants to use in chat.
+    attr_accessor :display_name
+
+    # Their actual user name for profile settings display as placeholder test
+    attr_accessor :name
+
+    # An upload key used to update the profile image.
+    attr_accessor :profile_image_upload_key
+
+    # Their current profile image URL
+    attr_accessor :profile_image_url
+
+    class EnumAttributeValidator
+      attr_reader :datatype
+      attr_reader :allowable_values
+
+      def initialize(datatype, allowable_values)
+        @allowable_values = allowable_values.map do |value|
+          case datatype.to_s
+          when /Integer/i
+            value.to_i
+          when /Float/i
+            value.to_f
+          else
+            value
+          end
+        end
+      end
+
+      def valid?(value)
+        !value || allowable_values.include?(value)
+      end
+    end
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'chat_limit' => :'chat_limit',
+        :'default_language_iso_code' => :'default_language_iso_code',
+        :'default_status' => :'default_status',
+        :'display_name' => :'display_name',
+        :'name' => :'name',
+        :'profile_image_upload_key' => :'profile_image_upload_key',
+        :'profile_image_url' => :'profile_image_url'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'chat_limit' => :'Integer',
+        :'default_language_iso_code' => :'String',
+        :'default_status' => :'String',
+        :'display_name' => :'String',
+        :'name' => :'String',
+        :'profile_image_upload_key' => :'String',
+        :'profile_image_url' => :'String'
+      }
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      return unless attributes.is_a?(Hash)
+
+      # convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
+
+      if attributes.has_key?(:'chat_limit')
+        self.chat_limit = attributes[:'chat_limit']
+      end
+
+      if attributes.has_key?(:'default_language_iso_code')
+        self.default_language_iso_code = attributes[:'default_language_iso_code']
+      end
+
+      if attributes.has_key?(:'default_status')
+        self.default_status = attributes[:'default_status']
+      end
+
+      if attributes.has_key?(:'display_name')
+        self.display_name = attributes[:'display_name']
+      end
+
+      if attributes.has_key?(:'name')
+        self.name = attributes[:'name']
+      end
+
+      if attributes.has_key?(:'profile_image_upload_key')
+        self.profile_image_upload_key = attributes[:'profile_image_upload_key']
+      end
+
+      if attributes.has_key?(:'profile_image_url')
+        self.profile_image_url = attributes[:'profile_image_url']
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      default_status_validator = EnumAttributeValidator.new('String', ['available', 'busy', 'unavailable'])
+      return false unless default_status_validator.valid?(@default_status)
+      true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] default_status Object to be assigned
+    def default_status=(default_status)
+      validator = EnumAttributeValidator.new('String', ['available', 'busy', 'unavailable'])
+      unless validator.valid?(default_status)
+        fail ArgumentError, 'invalid value for "default_status", must be one of #{validator.allowable_values}.'
+      end
+      @default_status = default_status
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          chat_limit == o.chat_limit &&
+          default_language_iso_code == o.default_language_iso_code &&
+          default_status == o.default_status &&
+          display_name == o.display_name &&
+          name == o.name &&
+          profile_image_upload_key == o.profile_image_upload_key &&
+          profile_image_url == o.profile_image_url
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Fixnum] Hash code
+    def hash
+      [chat_limit, default_language_iso_code, default_status, display_name, name, profile_image_upload_key, profile_image_url].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      self.class.swagger_types.each_pair do |key, type|
+        if type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[self.class.attribute_map[key]].is_a?(Array)
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        end # or else data not found in attributes(hash), not an issue as the data can be optional
+      end
+
+      self
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def _deserialize(type, value)
+      case type.to_sym
+      when :DateTime
+        DateTime.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :BOOLEAN
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        temp_model = UltracartClient.const_get(type).new
+        temp_model.build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        next if value.nil?
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+
+  end
+end

data/lib/ultracart_api/models/conversation_agent_profile_response.rb

@@ -0,0 +1,221 @@
+=begin
+#UltraCart Rest API V2
+
+#UltraCart REST API Version 2
+
+OpenAPI spec version: 2.0.0
+Contact: support@ultracart.com
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.4.15-SNAPSHOT
+
+=end
+
+require 'date'
+
+module UltracartClient
+  class ConversationAgentProfileResponse
+    attr_accessor :agent_profile
+
+    attr_accessor :error
+
+    attr_accessor :metadata
+
+    # Indicates if API call was successful
+    attr_accessor :success
+
+    attr_accessor :warning
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'agent_profile' => :'agent_profile',
+        :'error' => :'error',
+        :'metadata' => :'metadata',
+        :'success' => :'success',
+        :'warning' => :'warning'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'agent_profile' => :'ConversationAgentProfile',
+        :'error' => :'Error',
+        :'metadata' => :'ResponseMetadata',
+        :'success' => :'BOOLEAN',
+        :'warning' => :'Warning'
+      }
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      return unless attributes.is_a?(Hash)
+
+      # convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
+
+      if attributes.has_key?(:'agent_profile')
+        self.agent_profile = attributes[:'agent_profile']
+      end
+
+      if attributes.has_key?(:'error')
+        self.error = attributes[:'error']
+      end
+
+      if attributes.has_key?(:'metadata')
+        self.metadata = attributes[:'metadata']
+      end
+
+      if attributes.has_key?(:'success')
+        self.success = attributes[:'success']
+      end
+
+      if attributes.has_key?(:'warning')
+        self.warning = attributes[:'warning']
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      true
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          agent_profile == o.agent_profile &&
+          error == o.error &&
+          metadata == o.metadata &&
+          success == o.success &&
+          warning == o.warning
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Fixnum] Hash code
+    def hash
+      [agent_profile, error, metadata, success, warning].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      self.class.swagger_types.each_pair do |key, type|
+        if type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[self.class.attribute_map[key]].is_a?(Array)
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        end # or else data not found in attributes(hash), not an issue as the data can be optional
+      end
+
+      self
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def _deserialize(type, value)
+      case type.to_sym
+      when :DateTime
+        DateTime.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :BOOLEAN
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        temp_model = UltracartClient.const_get(type).new
+        temp_model.build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        next if value.nil?
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+
+  end
+end

data/lib/ultracart_api/models/conversation_websocket_message.rb

@@ -23,6 +23,8 @@ module UltracartClient
 
     attr_accessor :event_conversation_closed
 
+    attr_accessor :event_engage_customer
+
     attr_accessor :event_new_conversation
 
     attr_accessor :event_new_message
@@ -88,6 +90,7 @@ module UltracartClient
         :'event_add_coupon' => :'event_add_coupon',
         :'event_add_item' => :'event_add_item',
         :'event_conversation_closed' => :'event_conversation_closed',
+        :'event_engage_customer' => :'event_engage_customer',
         :'event_new_conversation' => :'event_new_conversation',
         :'event_new_message' => :'event_new_message',
         :'event_participant_join' => :'event_participant_join',
@@ -115,6 +118,7 @@ module UltracartClient
         :'event_add_coupon' => :'ConversationEventAddCoupon',
         :'event_add_item' => :'ConversationEventAddItem',
         :'event_conversation_closed' => :'ConversationSummary',
+        :'event_engage_customer' => :'ConversationWebchatQueueStatusQueueEntry',
         :'event_new_conversation' => :'ConversationSummary',
         :'event_new_message' => :'ConversationSummary',
         :'event_participant_join' => :'ConversationSummary',
@@ -159,6 +163,10 @@ module UltracartClient
         self.event_conversation_closed = attributes[:'event_conversation_closed']
       end
 
+      if attributes.has_key?(:'event_engage_customer')
+        self.event_engage_customer = attributes[:'event_engage_customer']
+      end
+
       if attributes.has_key?(:'event_new_conversation')
         self.event_new_conversation = attributes[:'event_new_conversation']
       end
@@ -274,6 +282,7 @@ module UltracartClient
           event_add_coupon == o.event_add_coupon &&
           event_add_item == o.event_add_item &&
           event_conversation_closed == o.event_conversation_closed &&
+          event_engage_customer == o.event_engage_customer &&
           event_new_conversation == o.event_new_conversation &&
           event_new_message == o.event_new_message &&
           event_participant_join == o.event_participant_join &&
@@ -302,7 +311,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [conversation_uuid, event_add_coupon, event_add_item, event_conversation_closed, event_new_conversation, event_new_message, event_participant_join, event_participant_join_participant, event_participant_left, event_participant_left_participant, event_participant_update, event_queue_position, event_queue_status_update, event_read_message, event_rrweb, event_type, event_typing, event_updated_message, event_webchat_context, message, type].hash
+      [conversation_uuid, event_add_coupon, event_add_item, event_conversation_closed, event_engage_customer, event_new_conversation, event_new_message, event_participant_join, event_participant_join_participant, event_participant_left, event_participant_left_participant, event_participant_update, event_queue_position, event_queue_status_update, event_read_message, event_rrweb, event_type, event_typing, event_updated_message, event_webchat_context, message, type].hash
     end
 
     # Builds the object from hash

data/lib/ultracart_api/version.rb

@@ -11,5 +11,5 @@ Swagger Codegen version: 2.4.15-SNAPSHOT
 =end
 
 module UltracartClient
-  VERSION = '3.10.110'
+  VERSION = '3.10.112'
 end

data/lib/ultracart_api.rb

@@ -143,6 +143,8 @@ require 'ultracart_api/models/city_state_zip'
 require 'ultracart_api/models/conversation'
 require 'ultracart_api/models/conversation_agent_auth'
 require 'ultracart_api/models/conversation_agent_auth_response'
+require 'ultracart_api/models/conversation_agent_profile'
+require 'ultracart_api/models/conversation_agent_profile_response'
 require 'ultracart_api/models/conversation_autocomplete_request'
 require 'ultracart_api/models/conversation_autocomplete_response'
 require 'ultracart_api/models/conversation_autocomplete_value'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ultracart_api
 version: !ruby/object:Gem::Version
-  version: 3.10.110
+  version: 3.10.112
 platform: ruby
 authors:
 - UltraCart
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-01-27 00:00:00.000000000 Z
+date: 2023-02-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus
@@ -352,6 +352,8 @@ files:
 - docs/Conversation.md
 - docs/ConversationAgentAuth.md
 - docs/ConversationAgentAuthResponse.md
+- docs/ConversationAgentProfile.md
+- docs/ConversationAgentProfileResponse.md
 - docs/ConversationApi.md
 - docs/ConversationAutocompleteRequest.md
 - docs/ConversationAutocompleteResponse.md
@@ -1126,6 +1128,8 @@ files:
 - lib/ultracart_api/models/conversation.rb
 - lib/ultracart_api/models/conversation_agent_auth.rb
 - lib/ultracart_api/models/conversation_agent_auth_response.rb
+- lib/ultracart_api/models/conversation_agent_profile.rb
+- lib/ultracart_api/models/conversation_agent_profile_response.rb
 - lib/ultracart_api/models/conversation_autocomplete_request.rb
 - lib/ultracart_api/models/conversation_autocomplete_response.rb
 - lib/ultracart_api/models/conversation_autocomplete_value.rb