ultracart_api 3.1.17 → 3.1.41

data/docs/ScreenRecordingPageView.md

@@ -3,6 +3,7 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
+**domain** | **String** |  | [optional] 
 **events** | [**Array<ScreenRecordingPageViewEvent>**](ScreenRecordingPageViewEvent.md) |  | [optional] 
 **first_event_timestamp** | **String** | First event timestamp | [optional] 
 **http_post** | **BOOLEAN** |  | [optional] 
@@ -16,6 +17,8 @@ Name | Type | Description | Notes
 **referrer_raw** | **String** |  | [optional] 
 **screen_recording_page_view_uuid** | **String** |  | [optional] 
 **time_on_page** | **Integer** |  | [optional] 
+**timing_dom_content_loaded** | **Integer** | Amount of time for DOMContentLoaded event to fire (milliseconds) | [optional] 
+**timing_loaded** | **Integer** | Amount of time for loaded event to fire (milliseconds) | [optional] 
 **truncated_events** | **BOOLEAN** |  | [optional] 
 **ucapv** | **String** |  | [optional] 
 **url** | **String** |  | [optional] 

data/docs/ScreenRecordingPageViewEvent.md

@@ -5,6 +5,7 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **name** | **String** |  | [optional] 
 **params** | [**Array<ScreenRecordingPageViewEventParameter>**](ScreenRecordingPageViewEventParameter.md) |  | [optional] 
+**prior_page_view** | **BOOLEAN** |  | [optional] 
 **timestamp** | **String** | Timestamp of the event | [optional] 
 **ts** | **Integer** |  | [optional] 
 

data/docs/ScreenRecordingQueryResponse.md

@@ -6,6 +6,9 @@ Name | Type | Description | Notes
 **error** | [**Error**](Error.md) |  | [optional] 
 **filter** | [**ScreenRecordingFilter**](ScreenRecordingFilter.md) |  | [optional] 
 **filter_values** | [**ScreenRecordingFilterValues**](ScreenRecordingFilterValues.md) |  | [optional] 
+**histogram_data** | **Array<Integer>** |  | [optional] 
+**histogram_interval** | **String** |  | [optional] 
+**histogram_start_dts** | **String** |  | [optional] 
 **metadata** | [**ResponseMetadata**](ResponseMetadata.md) |  | [optional] 
 **screen_recordings** | [**Array<ScreenRecording>**](ScreenRecording.md) |  | [optional] 
 **success** | **BOOLEAN** | Indicates if API call was successful | [optional] 

data/docs/ScreenRecordingSegment.md

@@ -6,6 +6,9 @@ Name | Type | Description | Notes
 **create_dts** | **String** |  | [optional] 
 **description** | **String** |  | [optional] 
 **filter** | [**ScreenRecordingFilter**](ScreenRecordingFilter.md) |  | [optional] 
+**histogram_data** | **Array<Integer>** |  | [optional] 
+**histogram_interval** | **String** |  | [optional] 
+**histogram_start_dts** | **String** |  | [optional] 
 **name** | **String** |  | [optional] 
 **screen_recording_segment_oid** | **Integer** |  | [optional] 
 **session_count** | **Integer** |  | [optional] 

data/docs/ScreenRecordingSettings.md

@@ -4,5 +4,10 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **enabled** | **BOOLEAN** |  | [optional] 
+**sessions_current_billing_period** | **Integer** |  | [optional] 
+**sessions_last_billing_period** | **Integer** |  | [optional] 
+**sessions_trial_billing_period** | **Integer** |  | [optional] 
+**trial_expiration** | **String** |  | [optional] 
+**trial_expired** | **BOOLEAN** |  | [optional] 
 
 

data/docs/StorefrontApi.md

@@ -21,6 +21,7 @@ Method | HTTP request | Description
 [**delete_email_postcard**](StorefrontApi.md#delete_email_postcard) | **DELETE** /storefront/{storefront_oid}/email/postcards/{commseq_postcard_uuid} | Delete email postcard
 [**delete_email_sending_domain**](StorefrontApi.md#delete_email_sending_domain) | **DELETE** /storefront/email/sending_domains/{domain} | delete email campaign
 [**delete_experiment**](StorefrontApi.md#delete_experiment) | **DELETE** /storefront/{storefront_oid}/experiments/{storefront_experiment_oid} | Delete experiment
+[**delete_heatmap**](StorefrontApi.md#delete_heatmap) | **DELETE** /storefront/{storefront_oid}/screen_recordings/heatmap | Delete screen recording heatmap
 [**delete_library_item**](StorefrontApi.md#delete_library_item) | **DELETE** /storefront/code_library/{library_item_oid} | Delete library item
 [**delete_library_item_published_versions**](StorefrontApi.md#delete_library_item_published_versions) | **DELETE** /storefront/code_library/{library_item_oid}/published_versions | Delete all published versions for a library item, including anything in review.
 [**delete_screen_recording_segment**](StorefrontApi.md#delete_screen_recording_segment) | **DELETE** /storefront/{storefront_oid}/screen_recordings/segments/{screen_recording_segment_oid} | Delete screen recording segment
@@ -80,6 +81,8 @@ Method | HTTP request | Description
 [**get_email_templates**](StorefrontApi.md#get_email_templates) | **GET** /storefront/{storefront_oid}/email/templates | Get email templates
 [**get_email_third_party_providers**](StorefrontApi.md#get_email_third_party_providers) | **GET** /storefront/{storefront_oid}/email/third_party_providers | Get a list of third party email providers
 [**get_experiments**](StorefrontApi.md#get_experiments) | **GET** /storefront/{storefront_oid}/experiments | Get experiments
+[**get_heatmap**](StorefrontApi.md#get_heatmap) | **POST** /storefront/{storefront_oid}/screen_recordings/heatmap | Get screen recording heatmap
+[**get_heatmap_index**](StorefrontApi.md#get_heatmap_index) | **POST** /storefront/{storefront_oid}/screen_recordings/heatmap/index | Get screen recording heatmap index
 [**get_histogram_property_names**](StorefrontApi.md#get_histogram_property_names) | **GET** /storefront/{storefront_oid}/email/histogram/property_names | Get histogram property names
 [**get_histogram_property_values**](StorefrontApi.md#get_histogram_property_values) | **GET** /storefront/{storefront_oid}/email/histogram/property_values | Get histogram property values
 [**get_library_filter_values**](StorefrontApi.md#get_library_filter_values) | **GET** /storefront/code_library/filter_values | Get library values used to populate drop down boxes for filtering.
@@ -1020,6 +1023,58 @@ nil (empty response body)
 
 
 
+# **delete_heatmap**
+> delete_heatmap(storefront_oid, query)
+
+Delete screen recording heatmap
+
+Delete screen recording heatmap 
+
+### 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::StorefrontApi.new_using_api_key(simple_key, false, false)
+
+
+storefront_oid = 56 # Integer | 
+
+query = UltracartClient::ScreenRecordingHeatmapReset.new # ScreenRecordingHeatmapReset | Query
+
+
+begin
+  #Delete screen recording heatmap
+  api_instance.delete_heatmap(storefront_oid, query)
+rescue UltracartClient::ApiError => e
+  puts "Exception when calling StorefrontApi->delete_heatmap: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **storefront_oid** | **Integer**|  | 
+ **query** | [**ScreenRecordingHeatmapReset**](ScreenRecordingHeatmapReset.md)| Query | 
+
+### 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
+
+
+
 # **delete_library_item**
 > delete_library_item(library_item_oid)
 
@@ -4010,6 +4065,109 @@ Name | Type | Description  | Notes
 
 
 
+# **get_heatmap**
+> ScreenRecordingHeatmapResponse get_heatmap(storefront_oid, query)
+
+Get screen recording heatmap
+
+Get screen recording heatmap 
+
+### 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::StorefrontApi.new_using_api_key(simple_key, false, false)
+
+
+storefront_oid = 56 # Integer | 
+
+query = UltracartClient::ScreenRecordingHeatmapRequest.new # ScreenRecordingHeatmapRequest | Query
+
+
+begin
+  #Get screen recording heatmap
+  result = api_instance.get_heatmap(storefront_oid, query)
+  p result
+rescue UltracartClient::ApiError => e
+  puts "Exception when calling StorefrontApi->get_heatmap: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **storefront_oid** | **Integer**|  | 
+ **query** | [**ScreenRecordingHeatmapRequest**](ScreenRecordingHeatmapRequest.md)| Query | 
+
+### Return type
+
+[**ScreenRecordingHeatmapResponse**](ScreenRecordingHeatmapResponse.md)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **get_heatmap_index**
+> ScreenRecordingHeatmapIndexResponse get_heatmap_index(storefront_oid)
+
+Get screen recording heatmap index
+
+Get screen recording heatmap index 
+
+### 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::StorefrontApi.new_using_api_key(simple_key, false, false)
+
+
+storefront_oid = 56 # Integer | 
+
+
+begin
+  #Get screen recording heatmap index
+  result = api_instance.get_heatmap_index(storefront_oid)
+  p result
+rescue UltracartClient::ApiError => e
+  puts "Exception when calling StorefrontApi->get_heatmap_index: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **storefront_oid** | **Integer**|  | 
+
+### Return type
+
+[**ScreenRecordingHeatmapIndexResponse**](ScreenRecordingHeatmapIndexResponse.md)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
 # **get_histogram_property_names**
 > EmailHistogramPropertyNamesResponse get_histogram_property_names(storefront_oid, opts)
 

data/docs/TaxJarConfig.md

@@ -8,6 +8,7 @@ Name | Type | Description | Notes
 **estimate_only** | **BOOLEAN** | True if this TaxJar configuration is to estimate taxes only and not report placed orders to TaxJar | [optional] 
 **send_outside_nexus** | **BOOLEAN** | Send orders outside your nexus TaxJar.  The default is to not transmit outside orders to TaxJar to reduce API calls.  However, this will prevent TaxJar from dynamically creating new Nexus when thresholds are exceeded for a state. | [optional] 
 **send_test_orders** | **BOOLEAN** | Send test orders through to TaxJar.  The default is to not transmit test orders to TaxJar. | [optional] 
+**skip_channel_orders** | **BOOLEAN** | Do not send channel partner orders to TaxJar.  Set this to true if your channel partner reports tax on their own. | [optional] 
 **use_distribution_center_from** | **BOOLEAN** | Use distribution center from address | [optional] 
 
 

data/lib/ultracart_api.rb

@@ -486,6 +486,7 @@ require 'ultracart_api/models/register_affiliate_click_response'
 require 'ultracart_api/models/response_metadata'
 require 'ultracart_api/models/result_set'
 require 'ultracart_api/models/screen_recording'
+require 'ultracart_api/models/screen_recording_ad_platform'
 require 'ultracart_api/models/screen_recording_filter'
 require 'ultracart_api/models/screen_recording_filter_geo_distance'
 require 'ultracart_api/models/screen_recording_filter_ip_search'
@@ -502,6 +503,13 @@ require 'ultracart_api/models/screen_recording_filter_values'
 require 'ultracart_api/models/screen_recording_filter_values_event'
 require 'ultracart_api/models/screen_recording_filter_values_event_params'
 require 'ultracart_api/models/screen_recording_filter_values_page_param'
+require 'ultracart_api/models/screen_recording_filter_values_page_view'
+require 'ultracart_api/models/screen_recording_heatmap'
+require 'ultracart_api/models/screen_recording_heatmap_index_response'
+require 'ultracart_api/models/screen_recording_heatmap_request'
+require 'ultracart_api/models/screen_recording_heatmap_reset'
+require 'ultracart_api/models/screen_recording_heatmap_response'
+require 'ultracart_api/models/screen_recording_heatmap_url'
 require 'ultracart_api/models/screen_recording_merchant_notes_request'
 require 'ultracart_api/models/screen_recording_multifield'
 require 'ultracart_api/models/screen_recording_page_view'

data/lib/ultracart_api/api/order_api.rb

@@ -33,7 +33,7 @@ module UltracartClient
     end
 
     # Adjusts an order total
-    # Adjusts an order total.  Adjusts individual items appropriately and considers taxes.  Desired total should be provided in the same currency as the order.  Returns true if successful. 
+    # Adjusts an order total.  Adjusts individual items appropriately and considers taxes.  Desired total should be provided in the same currency as the order and must be less than the current total and greater than zero.  This call will change the order total.  It returns true if the desired total is achieved.  If the goal seeking algorithm falls short (usually by pennies), this method returns back false.  View the merchant notes for the order for further details. 
     # @param order_id The order id to cancel.
     # @param desired_total The desired total with no formatting. example 123.45
     # @param [Hash] opts the optional parameters
@@ -44,7 +44,7 @@ module UltracartClient
     end
 
     # Adjusts an order total
-    # Adjusts an order total.  Adjusts individual items appropriately and considers taxes.  Desired total should be provided in the same currency as the order.  Returns true if successful. 
+    # Adjusts an order total.  Adjusts individual items appropriately and considers taxes.  Desired total should be provided in the same currency as the order and must be less than the current total and greater than zero.  This call will change the order total.  It returns true if the desired total is achieved.  If the goal seeking algorithm falls short (usually by pennies), this method returns back false.  View the merchant notes for the order for further details. 
     # @param order_id The order id to cancel.
     # @param desired_total The desired total with no formatting. example 123.45
     # @param [Hash] opts the optional parameters
@@ -578,6 +578,8 @@ module UltracartClient
     # @option opts [String] :custom_field_5 
     # @option opts [String] :custom_field_6 
     # @option opts [String] :custom_field_7 
+    # @option opts [String] :ship_on_date_begin 
+    # @option opts [String] :ship_on_date_end 
     # @option opts [Integer] :_limit The maximum number of records to return on this one API call. (Maximum 200) (default to 100)
     # @option opts [Integer] :_offset Pagination of the record set.  Offset is a zero based index. (default to 0)
     # @option opts [String] :_sort The sort order of the orders.  See Sorting documentation for examples of using multiple values and sorting by ascending and descending.
@@ -628,6 +630,8 @@ module UltracartClient
     # @option opts [String] :custom_field_5 
     # @option opts [String] :custom_field_6 
     # @option opts [String] :custom_field_7 
+    # @option opts [String] :ship_on_date_begin 
+    # @option opts [String] :ship_on_date_end 
     # @option opts [Integer] :_limit The maximum number of records to return on this one API call. (Maximum 200)
     # @option opts [Integer] :_offset Pagination of the record set.  Offset is a zero based index.
     # @option opts [String] :_sort The sort order of the orders.  See Sorting documentation for examples of using multiple values and sorting by ascending and descending.
@@ -679,6 +683,8 @@ module UltracartClient
       query_params[:'Custom Field 5'] = opts[:'custom_field_5'] if !opts[:'custom_field_5'].nil?
       query_params[:'Custom Field 6'] = opts[:'custom_field_6'] if !opts[:'custom_field_6'].nil?
       query_params[:'Custom Field 7'] = opts[:'custom_field_7'] if !opts[:'custom_field_7'].nil?
+      query_params[:'ship_on_date_begin'] = opts[:'ship_on_date_begin'] if !opts[:'ship_on_date_begin'].nil?
+      query_params[:'ship_on_date_end'] = opts[:'ship_on_date_end'] if !opts[:'ship_on_date_end'].nil?
       query_params[:'_limit'] = opts[:'_limit'] if !opts[:'_limit'].nil?
       query_params[:'_offset'] = opts[:'_offset'] if !opts[:'_offset'].nil?
       query_params[:'_sort'] = opts[:'_sort'] if !opts[:'_sort'].nil?

data/lib/ultracart_api/api/storefront_api.rb

@@ -1033,6 +1033,66 @@ module UltracartClient
       end
       return data, status_code, headers
     end
+    # Delete screen recording heatmap
+    # Delete screen recording heatmap 
+    # @param storefront_oid 
+    # @param query Query
+    # @param [Hash] opts the optional parameters
+    # @return [nil]
+    def delete_heatmap(storefront_oid, query, opts = {})
+      delete_heatmap_with_http_info(storefront_oid, query, opts)
+      nil
+    end
+
+    # Delete screen recording heatmap
+    # Delete screen recording heatmap 
+    # @param storefront_oid 
+    # @param query Query
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
+    def delete_heatmap_with_http_info(storefront_oid, query, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: StorefrontApi.delete_heatmap ...'
+      end
+      # verify the required parameter 'storefront_oid' is set
+      if @api_client.config.client_side_validation && storefront_oid.nil?
+        fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling StorefrontApi.delete_heatmap"
+      end
+      # verify the required parameter 'query' is set
+      if @api_client.config.client_side_validation && query.nil?
+        fail ArgumentError, "Missing the required parameter 'query' when calling StorefrontApi.delete_heatmap"
+      end
+      # resource path
+      local_var_path = '/storefront/{storefront_oid}/screen_recordings/heatmap'.sub('{' + 'storefront_oid' + '}', storefront_oid.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(query)
+      auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
+      data, status_code, headers = @api_client.call_api(:DELETE, 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: StorefrontApi#delete_heatmap\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
     # Delete library item
     # @param library_item_oid 
     # @param [Hash] opts the optional parameters
@@ -4438,6 +4498,122 @@ module UltracartClient
       end
       return data, status_code, headers
     end
+    # Get screen recording heatmap
+    # Get screen recording heatmap 
+    # @param storefront_oid 
+    # @param query Query
+    # @param [Hash] opts the optional parameters
+    # @return [ScreenRecordingHeatmapResponse]
+    def get_heatmap(storefront_oid, query, opts = {})
+      data, _status_code, _headers = get_heatmap_with_http_info(storefront_oid, query, opts)
+      data
+    end
+
+    # Get screen recording heatmap
+    # Get screen recording heatmap 
+    # @param storefront_oid 
+    # @param query Query
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(ScreenRecordingHeatmapResponse, Fixnum, Hash)>] ScreenRecordingHeatmapResponse data, response status code and response headers
+    def get_heatmap_with_http_info(storefront_oid, query, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: StorefrontApi.get_heatmap ...'
+      end
+      # verify the required parameter 'storefront_oid' is set
+      if @api_client.config.client_side_validation && storefront_oid.nil?
+        fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling StorefrontApi.get_heatmap"
+      end
+      # verify the required parameter 'query' is set
+      if @api_client.config.client_side_validation && query.nil?
+        fail ArgumentError, "Missing the required parameter 'query' when calling StorefrontApi.get_heatmap"
+      end
+      # resource path
+      local_var_path = '/storefront/{storefront_oid}/screen_recordings/heatmap'.sub('{' + 'storefront_oid' + '}', storefront_oid.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(query)
+      auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'ScreenRecordingHeatmapResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: StorefrontApi#get_heatmap\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+    # Get screen recording heatmap index
+    # Get screen recording heatmap index 
+    # @param storefront_oid 
+    # @param [Hash] opts the optional parameters
+    # @return [ScreenRecordingHeatmapIndexResponse]
+    def get_heatmap_index(storefront_oid, opts = {})
+      data, _status_code, _headers = get_heatmap_index_with_http_info(storefront_oid, opts)
+      data
+    end
+
+    # Get screen recording heatmap index
+    # Get screen recording heatmap index 
+    # @param storefront_oid 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(ScreenRecordingHeatmapIndexResponse, Fixnum, Hash)>] ScreenRecordingHeatmapIndexResponse data, response status code and response headers
+    def get_heatmap_index_with_http_info(storefront_oid, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: StorefrontApi.get_heatmap_index ...'
+      end
+      # verify the required parameter 'storefront_oid' is set
+      if @api_client.config.client_side_validation && storefront_oid.nil?
+        fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling StorefrontApi.get_heatmap_index"
+      end
+      # resource path
+      local_var_path = '/storefront/{storefront_oid}/screen_recordings/heatmap/index'.sub('{' + 'storefront_oid' + '}', storefront_oid.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(:POST, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'ScreenRecordingHeatmapIndexResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: StorefrontApi#get_heatmap_index\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
     # Get histogram property names
     # Obtain a list of property names for a given property type 
     # @param storefront_oid