ultracart_api 3.10.68 → 3.10.69

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ee1778c270b95f8ac3103b2cda7313d65885871e6b83100cc44b3e84dc6ad0be
-  data.tar.gz: a5ee2f282c48dc7532bfccff0153b7de9eeb455ec9983011a7ffa87dd25c5b96
+  metadata.gz: 1103c12b7948ddc60c291a1c814afd77b21e766db291075521acc3ec6a424a92
+  data.tar.gz: 5290aa17302e832dcbdf2c711f66b326a65a90c67878b93d597e950bd98b76b2
 SHA512:
-  metadata.gz: fd4ff25edbdc4d42e9f53a8d66a9aa10bd7a96bb4d1fbe0a6bfdd4184a720b2fccf94645f32d13278af9ead712b7aa01454cdcc9c850f8fb3618e8e4ff5a1fe2
-  data.tar.gz: c05d46142890fc1bed0eedeaaff9464869f2743f5f95a0f7ec0913d8d93463b0e77ad8c6475660fabada608c912e8cfe2489f897fe74f66b804fd87011cb5b7e
+  metadata.gz: 4bf2a66e41e019c7ddcb4af1633fd8ccfca0bfad8d1dd4cde816daa1c59ae2215b35a9b6c203524054b0b5d1cfd9365617fcfcf2f9cf158dc751abf7542d3f81
+  data.tar.gz: 6185b32a541b629ac87e3acd94a398ef485aab0e4769dd423a9a0dcea8dea2aec58b73a7857e17dc1a91d7940c324a4059899102a5d62832cbd5d0e53ba74527

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.68
+- Package version: 3.10.69
 - 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.68.gem
+gem install ./ultracart_api-3.10.69.gem
 ```
-(for development, run `gem install --dev ./ultracart_api-3.10.68.gem` to install the development dependencies)
+(for development, run `gem install --dev ./ultracart_api-3.10.69.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.68'
+    gem 'ultracart_api', '~> 3.10.69'
 
 ### Install from Git
 
@@ -128,6 +128,7 @@ Class | Method | HTTP request | Description
 *UltracartClient::ConversationApi* | [**get_agent_keep_alive**](docs/ConversationApi.md#get_agent_keep_alive) | **GET** /conversation/agent/keepalive | Agent keep alive
 *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_context**](docs/ConversationApi.md#get_conversation_context) | **PUT** /conversation/conversations/{conversation_uuid}/context | Get a webchat conversation context
 *UltracartClient::ConversationApi* | [**get_conversation_messages**](docs/ConversationApi.md#get_conversation_messages) | **GET** /conversation/conversations/{conversation_uuid}/messages/{since} | Retrieve conversation messages
 *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
@@ -600,6 +601,7 @@ Class | Method | HTTP request | Description
  - [UltracartClient::ConversationStartResponse](docs/ConversationStartResponse.md)
  - [UltracartClient::ConversationSummary](docs/ConversationSummary.md)
  - [UltracartClient::ConversationTwilioAccount](docs/ConversationTwilioAccount.md)
+ - [UltracartClient::ConversationWebchatContext](docs/ConversationWebchatContext.md)
  - [UltracartClient::ConversationWebchatQueueStatus](docs/ConversationWebchatQueueStatus.md)
  - [UltracartClient::ConversationWebchatQueueStatusAgent](docs/ConversationWebchatQueueStatusAgent.md)
  - [UltracartClient::ConversationWebchatQueueStatusQueueEntry](docs/ConversationWebchatQueueStatusQueueEntry.md)
@@ -852,6 +854,10 @@ Class | Method | HTTP request | Description
  - [UltracartClient::GroupUserMembership](docs/GroupUserMembership.md)
  - [UltracartClient::GroupsResponse](docs/GroupsResponse.md)
  - [UltracartClient::HTTPHeader](docs/HTTPHeader.md)
+ - [UltracartClient::HitPageView](docs/HitPageView.md)
+ - [UltracartClient::HitPageViewMetaData](docs/HitPageViewMetaData.md)
+ - [UltracartClient::HitSessionStart](docs/HitSessionStart.md)
+ - [UltracartClient::HitSessionUtm](docs/HitSessionUtm.md)
  - [UltracartClient::IntegrationLog](docs/IntegrationLog.md)
  - [UltracartClient::IntegrationLogFile](docs/IntegrationLogFile.md)
  - [UltracartClient::IntegrationLogLog](docs/IntegrationLogLog.md)
@@ -1218,6 +1224,7 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 3.10.69 | 11/21/2022 | conversation context method |
 | 3.10.68 | 11/21/2022 | adjusted conversation event model |
 | 3.10.67 | 11/15/2022 | conversation methods bug fix |
 | 3.10.66 | 11/15/2022 | conversations - enw events for add coupon and items |

data/docs/ConversationApi.md

@@ -7,6 +7,7 @@ Method | HTTP request | Description
 [**get_agent_keep_alive**](ConversationApi.md#get_agent_keep_alive) | **GET** /conversation/agent/keepalive | Agent keep alive
 [**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_context**](ConversationApi.md#get_conversation_context) | **PUT** /conversation/conversations/{conversation_uuid}/context | Get a webchat conversation context
 [**get_conversation_messages**](ConversationApi.md#get_conversation_messages) | **GET** /conversation/conversations/{conversation_uuid}/messages/{since} | Retrieve conversation messages
 [**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
@@ -160,6 +161,56 @@ Name | Type | Description  | Notes
 
 
 
+# **get_conversation_context**
+> ConversationWebchatContext get_conversation_context(conversation_uuid)
+
+Get a webchat conversation context
+
+Get a webchat conversation context 
+
+### 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)
+
+
+conversation_uuid = 'conversation_uuid_example' # String | 
+
+
+begin
+  #Get a webchat conversation context
+  result = api_instance.get_conversation_context(conversation_uuid)
+  p result
+rescue UltracartClient::ApiError => e
+  puts "Exception when calling ConversationApi->get_conversation_context: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **conversation_uuid** | **String**|  | 
+
+### Return type
+
+[**ConversationWebchatContext**](ConversationWebchatContext.md)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
 # **get_conversation_messages**
 > ConversationMessagesResponse get_conversation_messages(conversation_uuid, since, opts)
 

data/docs/ConversationWebchatContext.md

@@ -0,0 +1,12 @@
+# UltracartClient::ConversationWebchatContext
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**cart** | [**Cart**](Cart.md) |  | [optional] 
+**current_url** | **String** |  | [optional] 
+**page_view** | [**Array<HitPageView>**](HitPageView.md) |  | [optional] 
+**session_start** | [**HitSessionStart**](HitSessionStart.md) |  | [optional] 
+**session_utm** | [**HitSessionUtm**](HitSessionUtm.md) |  | [optional] 
+
+

data/docs/HitPageView.md

@@ -0,0 +1,18 @@
+# UltracartClient::HitPageView
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**bounce** | **BOOLEAN** |  | [optional] 
+**meta_data** | [**Array<HitPageViewMetaData>**](HitPageViewMetaData.md) |  | [optional] 
+**method** | **String** |  | [optional] 
+**prefetch** | **BOOLEAN** |  | [optional] 
+**query** | **String** |  | [optional] 
+**recording** | **BOOLEAN** |  | [optional] 
+**redirect** | **BOOLEAN** |  | [optional] 
+**referrer** | **String** |  | [optional] 
+**time_on_page** | **Float** |  | [optional] 
+**title** | **String** |  | [optional] 
+**url** | **String** |  | [optional] 
+
+

data/docs/HitPageViewMetaData.md

@@ -0,0 +1,9 @@
+# UltracartClient::HitPageViewMetaData
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**key** | **String** |  | [optional] 
+**value** | **String** |  | [optional] 
+
+

data/docs/HitSessionStart.md

@@ -0,0 +1,24 @@
+# UltracartClient::HitSessionStart
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**bot** | **BOOLEAN** |  | [optional] 
+**bounce** | **BOOLEAN** |  | [optional] 
+**channel** | **String** |  | [optional] 
+**device_switch_detected** | **BOOLEAN** |  | [optional] 
+**fake_bot** | **BOOLEAN** |  | [optional] 
+**geolocation_country** | **String** |  | [optional] 
+**geolocation_latitude** | **Float** |  | [optional] 
+**geolocation_longitude** | **Float** |  | [optional] 
+**geolocation_province** | **String** |  | [optional] 
+**no_cookie_support** | **BOOLEAN** |  | [optional] 
+**prefetch** | **BOOLEAN** |  | [optional] 
+**referrer** | **String** |  | [optional] 
+**screen_height** | **Integer** |  | [optional] 
+**screen_width** | **Integer** |  | [optional] 
+**time_on_site** | **Float** |  | [optional] 
+**user_agent** | **String** |  | [optional] 
+**user_ip** | **String** |  | [optional] 
+
+

data/docs/HitSessionUtm.md

@@ -0,0 +1,22 @@
+# UltracartClient::HitSessionUtm
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**fb_ad_id** | **String** |  | [optional] 
+**fbclid** | **String** |  | [optional] 
+**gbraid** | **String** |  | [optional] 
+**gclid** | **String** |  | [optional] 
+**msclkid** | **String** |  | [optional] 
+**ttclid** | **String** |  | [optional] 
+**uc_message_id** | **String** |  | [optional] 
+**utm_campaign** | **String** |  | [optional] 
+**utm_content** | **String** |  | [optional] 
+**utm_id** | **String** |  | [optional] 
+**utm_medium** | **String** |  | [optional] 
+**utm_source** | **String** |  | [optional] 
+**utm_term** | **String** |  | [optional] 
+**vmcid** | **String** |  | [optional] 
+**wbraid** | **String** |  | [optional] 
+
+

data/lib/ultracart_api/api/conversation_api.rb

@@ -187,6 +187,61 @@ module UltracartClient
       end
       return data, status_code, headers
     end
+    # Get a webchat conversation context
+    # Get a webchat conversation context 
+    # @param conversation_uuid 
+    # @param [Hash] opts the optional parameters
+    # @return [ConversationWebchatContext]
+    def get_conversation_context(conversation_uuid, opts = {})
+      data, _status_code, _headers = get_conversation_context_with_http_info(conversation_uuid, opts)
+      data
+    end
+
+    # Get a webchat conversation context
+    # Get a webchat conversation context 
+    # @param conversation_uuid 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(ConversationWebchatContext, Fixnum, Hash)>] ConversationWebchatContext data, response status code and response headers
+    def get_conversation_context_with_http_info(conversation_uuid, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ConversationApi.get_conversation_context ...'
+      end
+      # verify the required parameter 'conversation_uuid' is set
+      if @api_client.config.client_side_validation && conversation_uuid.nil?
+        fail ArgumentError, "Missing the required parameter 'conversation_uuid' when calling ConversationApi.get_conversation_context"
+      end
+      # resource path
+      local_var_path = '/conversation/conversations/{conversation_uuid}/context'.sub('{' + 'conversation_uuid' + '}', conversation_uuid.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 = nil
+      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 => 'ConversationWebchatContext')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ConversationApi#get_conversation_context\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
     # Retrieve conversation messages
     # Retrieve conversation messages since a particular time 
     # @param conversation_uuid 

data/lib/ultracart_api/models/conversation_webchat_context.rb

@@ -0,0 +1,222 @@
+=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 ConversationWebchatContext
+    attr_accessor :cart
+
+    attr_accessor :current_url
+
+    attr_accessor :page_view
+
+    attr_accessor :session_start
+
+    attr_accessor :session_utm
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'cart' => :'cart',
+        :'current_url' => :'current_url',
+        :'page_view' => :'page_view',
+        :'session_start' => :'session_start',
+        :'session_utm' => :'session_utm'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'cart' => :'Cart',
+        :'current_url' => :'String',
+        :'page_view' => :'Array<HitPageView>',
+        :'session_start' => :'HitSessionStart',
+        :'session_utm' => :'HitSessionUtm'
+      }
+    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?(:'cart')
+        self.cart = attributes[:'cart']
+      end
+
+      if attributes.has_key?(:'current_url')
+        self.current_url = attributes[:'current_url']
+      end
+
+      if attributes.has_key?(:'page_view')
+        if (value = attributes[:'page_view']).is_a?(Array)
+          self.page_view = value
+        end
+      end
+
+      if attributes.has_key?(:'session_start')
+        self.session_start = attributes[:'session_start']
+      end
+
+      if attributes.has_key?(:'session_utm')
+        self.session_utm = attributes[:'session_utm']
+      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 &&
+          cart == o.cart &&
+          current_url == o.current_url &&
+          page_view == o.page_view &&
+          session_start == o.session_start &&
+          session_utm == o.session_utm
+    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
+      [cart, current_url, page_view, session_start, session_utm].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

@@ -206,7 +206,7 @@ module UltracartClient
     # Check to see if the all the properties in the model are valid
     # @return true if the model is valid
     def valid?
-      event_type_validator = EnumAttributeValidator.new('String', ['queue position', 'webchat start conversation', 'conversation closed', 'new conversation', 'new message', 'updated message', 'queue status update', 'rrweb', 'participant update', 'read message', 'typing', 'add coupon', 'add item'])
+      event_type_validator = EnumAttributeValidator.new('String', ['queue position', 'webchat start conversation', 'conversation closed', 'new conversation', 'new message', 'updated message', 'queue status update', 'rrweb', 'participant update', 'read message', 'typing', 'add coupon', 'add item', 'webchat context'])
       return false unless event_type_validator.valid?(@event_type)
       type_validator = EnumAttributeValidator.new('String', ['message', 'event', 'ping', 'check queue position'])
       return false unless type_validator.valid?(@type)
@@ -216,7 +216,7 @@ module UltracartClient
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] event_type Object to be assigned
     def event_type=(event_type)
-      validator = EnumAttributeValidator.new('String', ['queue position', 'webchat start conversation', 'conversation closed', 'new conversation', 'new message', 'updated message', 'queue status update', 'rrweb', 'participant update', 'read message', 'typing', 'add coupon', 'add item'])
+      validator = EnumAttributeValidator.new('String', ['queue position', 'webchat start conversation', 'conversation closed', 'new conversation', 'new message', 'updated message', 'queue status update', 'rrweb', 'participant update', 'read message', 'typing', 'add coupon', 'add item', 'webchat context'])
       unless validator.valid?(event_type)
         fail ArgumentError, 'invalid value for "event_type", must be one of #{validator.allowable_values}.'
       end