ultracart_api 4.0.85.rc → 4.0.87.rc

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 723d0ab84f7c853d3cef91943efa454e50b0c41ebe17bc04b1ec1bbeca68d8d3
-  data.tar.gz: f0270981b9ecd0fa99d1a31485816d2c166314d9ffd5f07d87cc994a7745e59f
+  metadata.gz: dc219066ac586692df1300754f45595fffa03ab2734801bd0950156d5b64d3ab
+  data.tar.gz: bea4eee612019ac116e992d5c68ecc4844ee051ce97ff6d7ec37150c1753f67a
 SHA512:
-  metadata.gz: 97b09e707acd5f31e89e0b0d6ca64ac0fce768a82c4cb33a5d7cf4d059e94bbb3f3493e630b3e3d7f9e638ab1d5b85a4ea4c64171e488cddf6cc2591f31649ba
-  data.tar.gz: 0d3e0fd392d2aff7b71b0c3173b13764f569a99249f32269a46759756f0760a7ec676ba6f18c2795140582e873a339000e9803adfa3fab6a79be881a6cf2bcff
+  metadata.gz: 3fb52576a7a509c0664f5b0c51db4679150841c357c003e35feeed6f1c4174f9ca32228c2ad97a7c51877ff550adf7526860682ec2e58ba2e27d68416420cebd
+  data.tar.gz: cc957623034627e837c4a660c9c52c349a82d22527f7aac85bc54cdb1187257119559dfbf1bcf81861562d8a9b7ae960986ca78d5c46cc55d0611f302d137c39

data/README.md

@@ -7,7 +7,7 @@ UltraCart REST API Version 2
 This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
 
 - API version: 2.0.0
-- Package version: 4.0.85.rc
+- Package version: 4.0.87.rc
 - Build package: org.openapitools.codegen.languages.RubyClientCodegen
 For more information, please visit [http://www.ultracart.com](http://www.ultracart.com)
 
@@ -24,16 +24,16 @@ gem build ultracart_api.gemspec
 Then either install the gem locally:
 
 ```shell
-gem install ./ultracart_api-4.0.85.rc.gem
+gem install ./ultracart_api-4.0.87.rc.gem
 ```
 
-(for development, run `gem install --dev ./ultracart_api-4.0.85.rc.gem` to install the development dependencies)
+(for development, run `gem install --dev ./ultracart_api-4.0.87.rc.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', '~> 4.0.85.rc'
+    gem 'ultracart_api', '~> 4.0.87.rc'
 
 ### Install from Git
 
@@ -134,6 +134,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
@@ -606,6 +607,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)
@@ -858,6 +860,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)
@@ -1227,6 +1233,8 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 4.0.87-RC | 11/21/2022 | coupon - addl optional minimums for percent off msrp items coupon |
+| 4.0.86-RC | 11/21/2022 | conversation context method |
 | 4.0.85-RC | 11/21/2022 | adjusted conversation event model |
 | 4.0.84-RC | 11/15/2022 | conversation methods bug fix |
 | 4.0.83-RC | 11/15/2022 | conversations - enw events for add coupon and items |

data/docs/ConversationApi.md

@@ -7,6 +7,7 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
 | [**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 |
@@ -227,6 +228,77 @@ end
 - **Accept**: application/json
 
 
+## get_conversation_context
+
+> <ConversationWebchatContext> get_conversation_context(conversation_uuid)
+
+Get a webchat conversation context
+
+Get a webchat conversation context 
+
+### Examples
+
+```ruby
+require 'time'
+require 'ultracart_api'
+require 'json'
+require 'yaml'
+require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
+
+# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
+# As such, this might not be the best way to use this object.
+# Please see https://github.com/UltraCart/sdk_samples for working examples.
+
+api = UltracartClient::ConversationApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
+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 "Error when calling ConversationApi->get_conversation_context: #{e}"
+end
+```
+
+#### Using the get_conversation_context_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ConversationWebchatContext>, Integer, Hash)> get_conversation_context_with_http_info(conversation_uuid)
+
+```ruby
+begin
+  # Get a webchat conversation context
+  data, status_code, headers = api_instance.get_conversation_context_with_http_info(conversation_uuid)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ConversationWebchatContext>
+rescue UltracartClient::ApiError => e
+  puts "Error when calling ConversationApi->get_conversation_context_with_http_info: #{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**: Not defined
+- **Accept**: application/json
+
+
 ## get_conversation_messages
 
 > <ConversationMessagesResponse> get_conversation_messages(conversation_uuid, since, opts)

data/docs/ConversationWebchatContext.md

@@ -0,0 +1,26 @@
+# 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] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::ConversationWebchatContext.new(
+  cart: null,
+  current_url: null,
+  page_view: null,
+  session_start: null,
+  session_utm: null
+)
+```
+

data/docs/CouponPercentOffMsrpItems.md

@@ -8,6 +8,8 @@
 | **excluded_items** | **Array<String>** | A list of items which cannot be discounted. | [optional] |
 | **items** | **Array<String>** | An list of items which will receive a discount. | [optional] |
 | **limit** | **Integer** | The (optional) maximum quantity of discounted items. | [optional] |
+| **minimum_cumulative_msrp** | **Float** | The (optional) minimum cumulative msrp of qualifying items. | [optional] |
+| **minimum_subtotal** | **Float** | The (optional) minimum subtotal of qualifying items. | [optional] |
 
 ## Example
 
@@ -18,7 +20,9 @@ instance = UltracartClient::CouponPercentOffMsrpItems.new(
   discount_percent: null,
   excluded_items: null,
   items: null,
-  limit: null
+  limit: null,
+  minimum_cumulative_msrp: null,
+  minimum_subtotal: null
 )
 ```
 

data/docs/HitPageView.md

@@ -0,0 +1,38 @@
+# 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] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::HitPageView.new(
+  bounce: null,
+  meta_data: null,
+  method: null,
+  prefetch: null,
+  query: null,
+  recording: null,
+  redirect: null,
+  referrer: null,
+  time_on_page: null,
+  title: null,
+  url: null
+)
+```
+

data/docs/HitPageViewMetaData.md

@@ -0,0 +1,20 @@
+# UltracartClient::HitPageViewMetaData
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **key** | **String** |  | [optional] |
+| **value** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::HitPageViewMetaData.new(
+  key: null,
+  value: null
+)
+```
+

data/docs/HitSessionStart.md

@@ -0,0 +1,50 @@
+# 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] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::HitSessionStart.new(
+  bot: null,
+  bounce: null,
+  channel: null,
+  device_switch_detected: null,
+  fake_bot: null,
+  geolocation_country: null,
+  geolocation_latitude: null,
+  geolocation_longitude: null,
+  geolocation_province: null,
+  no_cookie_support: null,
+  prefetch: null,
+  referrer: null,
+  screen_height: null,
+  screen_width: null,
+  time_on_site: null,
+  user_agent: null,
+  user_ip: null
+)
+```
+

data/docs/HitSessionUtm.md

@@ -0,0 +1,46 @@
+# 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] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::HitSessionUtm.new(
+  fb_ad_id: null,
+  fbclid: null,
+  gbraid: null,
+  gclid: null,
+  msclkid: null,
+  ttclid: null,
+  uc_message_id: null,
+  utm_campaign: null,
+  utm_content: null,
+  utm_id: null,
+  utm_medium: null,
+  utm_source: null,
+  utm_term: null,
+  vmcid: null,
+  wbraid: null
+)
+```
+

data/lib/ultracart_api/api/conversation_api.rb

@@ -215,6 +215,70 @@ module UltracartClient
       return data, status_code, headers
     end
 
+    # Get a webchat conversation context
+    # Get a webchat conversation context 
+    # @param conversation_uuid [String] 
+    # @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 [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(ConversationWebchatContext, Integer, 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' + '}', CGI.escape(conversation_uuid.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[: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'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'ConversationWebchatContext'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
+
+      new_options = opts.merge(
+        :operation => :"ConversationApi.get_conversation_context",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
+      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 [String]