ultracart_api 3.1.40 → 3.1.45

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: baf7217672db682182fbbbe109f11bcdcd06fe001e7335dcd76ceedfe4a684a3
-  data.tar.gz: 52fe8ee2c3762f0ae0b2c8e3ab4e13913db34cc83a94b407aad75199ae1b0a42
+  metadata.gz: cd77cb75fad4da0b0e7b5ef78f9048948deb626ef99428e350f8869829e8543e
+  data.tar.gz: 147362bfa974364b763ecdd7923356473a34239958c4a375dc895665c7b8522d
 SHA512:
-  metadata.gz: b43845133d36b59c6a3c87fffc1a949f794375ec0ec95f900b7d6da6592c7ac5b97fd8098b808f30200aa867f226c9349e1cb790881f0eefb69dac3d79b597c2
-  data.tar.gz: 58379d2c79ec36c5557d3bbe615d45907002ade8564327318914171495dc3a5f0879b017295a74cd74e722b273f94b675dbf6ce9a24905ef54b8cd1faa6bdbee
+  metadata.gz: ab897091c8c8b2e4a85897530c5d7fc1e56e9bc818393514edf28819b04d9e40a1ff768ff8fcdfd6750670ddbfbf5bd6fad4e5f62b781f4a11b1bd2c87fc4297
+  data.tar.gz: 254dc500ef049ffe61c9747feaa6599a22c5eed25f0d5bfa59bb03b2aeeaffaebcc6932d0683a63411235df9a26363e61163f461de2e7632428d77368380b6d7

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.1.40
+- Package version: 3.1.45
 - 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.1.40.gem
+gem install ./ultracart_api-3.1.45.gem
 ```
-(for development, run `gem install --dev ./ultracart_api-3.1.40.gem` to install the development dependencies)
+(for development, run `gem install --dev ./ultracart_api-3.1.45.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.1.40'
+    gem 'ultracart_api', '~> 3.1.45'
 
 ### Install from Git
 
@@ -205,6 +205,7 @@ Class | Method | HTTP request | Description
 *UltracartClient::StorefrontApi* | [**delete_email_postcard**](docs/StorefrontApi.md#delete_email_postcard) | **DELETE** /storefront/{storefront_oid}/email/postcards/{commseq_postcard_uuid} | Delete email postcard
 *UltracartClient::StorefrontApi* | [**delete_email_sending_domain**](docs/StorefrontApi.md#delete_email_sending_domain) | **DELETE** /storefront/email/sending_domains/{domain} | delete email campaign
 *UltracartClient::StorefrontApi* | [**delete_experiment**](docs/StorefrontApi.md#delete_experiment) | **DELETE** /storefront/{storefront_oid}/experiments/{storefront_experiment_oid} | Delete experiment
+*UltracartClient::StorefrontApi* | [**delete_heatmap**](docs/StorefrontApi.md#delete_heatmap) | **DELETE** /storefront/{storefront_oid}/screen_recordings/heatmap | Delete screen recording heatmap
 *UltracartClient::StorefrontApi* | [**delete_library_item**](docs/StorefrontApi.md#delete_library_item) | **DELETE** /storefront/code_library/{library_item_oid} | Delete library item
 *UltracartClient::StorefrontApi* | [**delete_library_item_published_versions**](docs/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.
 *UltracartClient::StorefrontApi* | [**delete_screen_recording_segment**](docs/StorefrontApi.md#delete_screen_recording_segment) | **DELETE** /storefront/{storefront_oid}/screen_recordings/segments/{screen_recording_segment_oid} | Delete screen recording segment
@@ -264,6 +265,8 @@ Class | Method | HTTP request | Description
 *UltracartClient::StorefrontApi* | [**get_email_templates**](docs/StorefrontApi.md#get_email_templates) | **GET** /storefront/{storefront_oid}/email/templates | Get email templates
 *UltracartClient::StorefrontApi* | [**get_email_third_party_providers**](docs/StorefrontApi.md#get_email_third_party_providers) | **GET** /storefront/{storefront_oid}/email/third_party_providers | Get a list of third party email providers
 *UltracartClient::StorefrontApi* | [**get_experiments**](docs/StorefrontApi.md#get_experiments) | **GET** /storefront/{storefront_oid}/experiments | Get experiments
+*UltracartClient::StorefrontApi* | [**get_heatmap**](docs/StorefrontApi.md#get_heatmap) | **POST** /storefront/{storefront_oid}/screen_recordings/heatmap | Get screen recording heatmap
+*UltracartClient::StorefrontApi* | [**get_heatmap_index**](docs/StorefrontApi.md#get_heatmap_index) | **POST** /storefront/{storefront_oid}/screen_recordings/heatmap/index | Get screen recording heatmap index
 *UltracartClient::StorefrontApi* | [**get_histogram_property_names**](docs/StorefrontApi.md#get_histogram_property_names) | **GET** /storefront/{storefront_oid}/email/histogram/property_names | Get histogram property names
 *UltracartClient::StorefrontApi* | [**get_histogram_property_values**](docs/StorefrontApi.md#get_histogram_property_values) | **GET** /storefront/{storefront_oid}/email/histogram/property_values | Get histogram property values
 *UltracartClient::StorefrontApi* | [**get_library_filter_values**](docs/StorefrontApi.md#get_library_filter_values) | **GET** /storefront/code_library/filter_values | Get library values used to populate drop down boxes for filtering.
@@ -870,6 +873,12 @@ Class | Method | HTTP request | Description
  - [UltracartClient::ScreenRecordingFilterValuesEventParams](docs/ScreenRecordingFilterValuesEventParams.md)
  - [UltracartClient::ScreenRecordingFilterValuesPageParam](docs/ScreenRecordingFilterValuesPageParam.md)
  - [UltracartClient::ScreenRecordingFilterValuesPageView](docs/ScreenRecordingFilterValuesPageView.md)
+ - [UltracartClient::ScreenRecordingHeatmap](docs/ScreenRecordingHeatmap.md)
+ - [UltracartClient::ScreenRecordingHeatmapIndexResponse](docs/ScreenRecordingHeatmapIndexResponse.md)
+ - [UltracartClient::ScreenRecordingHeatmapRequest](docs/ScreenRecordingHeatmapRequest.md)
+ - [UltracartClient::ScreenRecordingHeatmapReset](docs/ScreenRecordingHeatmapReset.md)
+ - [UltracartClient::ScreenRecordingHeatmapResponse](docs/ScreenRecordingHeatmapResponse.md)
+ - [UltracartClient::ScreenRecordingHeatmapUrl](docs/ScreenRecordingHeatmapUrl.md)
  - [UltracartClient::ScreenRecordingMerchantNotesRequest](docs/ScreenRecordingMerchantNotesRequest.md)
  - [UltracartClient::ScreenRecordingMultifield](docs/ScreenRecordingMultifield.md)
  - [UltracartClient::ScreenRecordingPageView](docs/ScreenRecordingPageView.md)
@@ -1010,6 +1019,10 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 3.1.44 | 06/02/2021 | new boolean flag on items object to allow sharing of reviews between items   | 
+| 3.1.43 | 06/01/2021 | fix item serialized name of item serialized name for channel partner item mappings  | 
+| 3.1.42 | 06/01/2021 | added quickbooks accounting codes at the tiered level for tiered coupons  | 
+| 3.1.41 | 05/21/2021 | screen recording heatmap methods | 
 | 3.1.40 | 05/20/2021 | Order.summary.actual_payment_processing field added | 
 | 3.1.39 | 05/19/2021 | full deployment to ensure all language SDKs are up to date | 
 | 3.1.37 | 05/18/2021 | removed php sdk dependency on ext-mbstring by generating sdk with polyfill requirement.  sdk is more portable now. | 

data/docs/CouponTierAmount.md

@@ -4,6 +4,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **discount_amount** | **Float** | The amount of subtotal discount | [optional] 
+**quickbooks_code** | **String** | Quickbooks accounting code. | [optional] 
 **subtotal_amount** | **Float** | The amount of subtotal required to receive the discount amount | [optional] 
 
 

data/docs/CouponTierPercent.md

@@ -4,6 +4,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **discount_percent** | **Float** | The percent of subtotal discount | [optional] 
+**quickbooks_code** | **String** | Quickbooks accounting code. | [optional] 
 **subtotal_amount** | **Float** | The amount of subtotal required to receive the discount percent | [optional] 
 
 

data/docs/CouponTierQuantityAmount.md

@@ -5,5 +5,6 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **discount_amount** | **Float** | The amount of discount per item. | [optional] 
 **item_quantity** | **Integer** | The quantity of item purchased (in units) | [optional] 
+**quickbooks_code** | **String** | Quickbooks accounting code. | [optional] 
 
 

data/docs/CouponTierQuantityPercent.md

@@ -5,5 +5,6 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **discount_percent** | **Float** | The percent of discount per item. | [optional] 
 **item_quantity** | **Integer** | The quantity of item purchased (in units) | [optional] 
+**quickbooks_code** | **String** | Quickbooks accounting code. | [optional] 
 
 

data/docs/CouponTieredPercentOffShipping.md

@@ -3,6 +3,7 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
+**quickbooks_code** | **String** | Quickbooks accounting code. | [optional] 
 **shipping_methods** | **Array<String>** | One or more shipping methods that may receive this discount | [optional] 
 **tiers** | [**Array<CouponTierPercent>**](CouponTierPercent.md) | A list of discount tiers. | [optional] 
 

data/docs/Item.md

@@ -7,7 +7,7 @@ Name | Type | Description | Notes
 **amember** | [**ItemAmember**](ItemAmember.md) |  | [optional] 
 **auto_order** | [**ItemAutoOrder**](ItemAutoOrder.md) |  | [optional] 
 **ccbill** | [**ItemCCBill**](ItemCCBill.md) |  | [optional] 
-**channel_partner_mappings** | [**Array<ItemChannelPartnerMapping>**](ItemChannelPartnerMapping.md) | Channel Partner Item Mapping | [optional] 
+**channel_partner_item_mappings** | [**Array<ItemChannelPartnerMapping>**](ItemChannelPartnerMapping.md) | Channel Partner Item Mapping | [optional] 
 **chargeback** | [**ItemChargeback**](ItemChargeback.md) |  | [optional] 
 **checkout** | [**ItemCheckout**](ItemCheckout.md) |  | [optional] 
 **content** | [**ItemContent**](ItemContent.md) |  | [optional] 

data/docs/ItemReviews.md

@@ -10,5 +10,7 @@ Name | Type | Description | Notes
 **review_template_name** | **String** | Review template name | [optional] 
 **review_template_oid** | **Integer** | Review template object identifier | [optional] 
 **reviewable** | **BOOLEAN** | True if the item is reviewable | [optional] 
+**share_reviews_with_merchant_item_id** | **String** | Share reviews with item id.  To set, use the share_reviews_with_merchant_item_oid field. | [optional] 
+**share_reviews_with_merchant_item_oid** | **Integer** | Share reviews with item oid.  To null out this field, set teh value to zero. | [optional] 
 
 

data/docs/OrderApi.md

@@ -31,7 +31,7 @@ Method | HTTP request | Description
 
 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. 
 
 ### Example
 ```ruby

data/docs/OrderSummary.md

@@ -4,6 +4,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **actual_fulfillment** | [**Currency**](Currency.md) |  | [optional] 
+**actual_payment_processing** | [**Currency**](Currency.md) |  | [optional] 
 **actual_shipping** | [**Currency**](Currency.md) |  | [optional] 
 **arbitrary_shipping_handling_total** | [**Currency**](Currency.md) |  | [optional] 
 **other_refunded** | [**Currency**](Currency.md) |  | [optional] 

data/docs/ScreenRecordingFilterPageView.md

@@ -3,6 +3,7 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
+**domain** | [**ScreenRecordingFilterStringSearch**](ScreenRecordingFilterStringSearch.md) |  | [optional] 
 **events** | [**Array<ScreenRecordingFilterPageViewEvent>**](ScreenRecordingFilterPageViewEvent.md) |  | [optional] 
 **params** | [**Array<ScreenRecordingFilterPageViewParam>**](ScreenRecordingFilterPageViewParam.md) |  | [optional] 
 **referrer** | [**ScreenRecordingFilterStringSearch**](ScreenRecordingFilterStringSearch.md) |  | [optional] 

data/docs/ScreenRecordingFilterValuesPageView.md

@@ -3,6 +3,7 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
+**domains** | **Array<String>** |  | [optional] 
 **events** | [**Array<ScreenRecordingFilterValuesEvent>**](ScreenRecordingFilterValuesEvent.md) |  | [optional] 
 **page_params** | [**Array<ScreenRecordingFilterValuesPageParam>**](ScreenRecordingFilterValuesPageParam.md) |  | [optional] 
 **time_on_page_max** | **Integer** |  | [optional] 

data/docs/ScreenRecordingHeatmap.md

@@ -0,0 +1,19 @@
+# UltracartClient::ScreenRecordingHeatmap
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**large_click_url** | **String** |  | [optional] 
+**large_movement_url** | **String** |  | [optional] 
+**large_regular_url** | **String** |  | [optional] 
+**large_scroll_url** | **String** |  | [optional] 
+**medium_click_url** | **String** |  | [optional] 
+**medium_movement_url** | **String** |  | [optional] 
+**medium_regular_url** | **String** |  | [optional] 
+**medium_scroll_url** | **String** |  | [optional] 
+**small_click_url** | **String** |  | [optional] 
+**small_movement_url** | **String** |  | [optional] 
+**small_regular_url** | **String** |  | [optional] 
+**small_scroll_url** | **String** |  | [optional] 
+
+

data/docs/ScreenRecordingHeatmapIndexResponse.md

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

data/docs/ScreenRecordingHeatmapRequest.md

@@ -0,0 +1,9 @@
+# UltracartClient::ScreenRecordingHeatmapRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**range** | [**ScreenRecordingFilterRangeDate**](ScreenRecordingFilterRangeDate.md) |  | [optional] 
+**url** | **String** |  | [optional] 
+
+

data/docs/ScreenRecordingHeatmapReset.md

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

data/docs/ScreenRecordingHeatmapResponse.md

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

data/docs/ScreenRecordingHeatmapUrl.md

@@ -0,0 +1,12 @@
+# UltracartClient::ScreenRecordingHeatmapUrl
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**histogram_data** | **Array<Integer>** |  | [optional] 
+**histogram_interval** | **String** |  | [optional] 
+**histogram_start_dts** | **String** |  | [optional] 
+**session_count** | **Integer** |  | [optional] 
+**url** | **String** |  | [optional] 
+
+

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] 

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)