ultracart_api 3.1.37 → 3.1.43

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b5690416d00c2d70b1415240f127834c4705c6ab8ae1f351ff0d9855426a07d5
-  data.tar.gz: 9a71e679a3452d63c397fc6ab6073e889c4fd8e3ff2ea993fc5768132690250e
+  metadata.gz: 9a584bb7f1b5227ef69f544f4ec4def7c4ca7ea7518df56e6c5eafc0a49a4ed7
+  data.tar.gz: 07d1a2187132a73f168b8148ecb48fd9c4c2270643682ea453b089203f789698
 SHA512:
-  metadata.gz: 96d5977c4a8311cedd2b1f18b3f59c46a4e573940325ebbc16d00610f647be5d79d0e679aabf7b0e099b38ab3317af5f3c5a522906bfce6b53207bb3f88b8841
-  data.tar.gz: e5af30079d2bcd2baf84594a8a0e5e1d8f0bc7d059e8c49496a4d1f5c4dc8cc33f1c425ca85fdb7393ed2919b24a3d2f9fcbcd960834a5c9fd18b375258d2752
+  metadata.gz: 137591dbcaf512304fc96557366f1fafcbd513dd4f51279eedb45b6416bcb5cfb09a12c6658d5545f455fa6ae1c2e58441f53748c66475bc05dcbd7118a33d05
+  data.tar.gz: 786156668460d885e03803fdc77a28238d8a67d54b8c8013025827db8c170bbd5ad07ed8be1b72fbfce30e59c659cb99a537f18623e082ba4508a74f33631aae

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.37
+- Package version: 3.1.43
 - 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.37.gem
+gem install ./ultracart_api-3.1.43.gem
 ```
-(for development, run `gem install --dev ./ultracart_api-3.1.37.gem` to install the development dependencies)
+(for development, run `gem install --dev ./ultracart_api-3.1.43.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.37'
+    gem 'ultracart_api', '~> 3.1.43'
 
 ### 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)
@@ -1002,3 +1011,99 @@ Class | Method | HTTP request | Description
 - **API key parameter name**: x-ultracart-simple-key
 - **Location**: HTTP header
 
+
+
+
+# CHANGE LOG
+Not every change is committed to every SDK.
+
+| Version | Date | Comments |
+| --: | :-: | --- |
+| 3.1.43 | 06/01/2021 | one of us cannot spell, not saying who  | 
+| 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. | 
+| 3.1.35 | 05/14/2021 | screen recording histogram data  | 
+| 3.1.34 | 05/12/2021 | screen recording preferred language, last x days filter, referrer domain | 
+| 3.1.33 | 05/11/2021 | creen recording filter for affiliate id and email | 
+| 3.1.32 | 05/06/2021 | customer profile pending loyalty points  | 
+| 3.1.31 | 05/06/2021 | Added email domian field to screen recordings for filtering  | 
+| 3.1.30 | 04/27/2021 | OrderApi.processPayment now allows a specific amount to be billed  | 
+| 3.1.29 | 04/26/2021 | screen recording language iso code | 
+| 3.1.28 | 04/26/2021 | screen recording statistics on the setting object | 
+| 3.1.27 | 04/20/2021 | bug fix - annotation misspell on new email campaign property |
+| 3.1.26 | 04/20/2021 | StoreFront Connumications - flag to end campaign or flow once purchase happens anywhere |
+| 3.1.25 | 04/19/2021 | Screen recording UTM campaign and source fields |
+| 3.1.24 | 04/16/2021 | Screen recording aggregations on communications campaign/flows |
+| 3.1.22 | 04/09/2021 | Move URL filter values into page level view for screen recordings |
+| 3.1.18 | 03/17/2021 | Added order query by ship on date |
+| 3.1.17 | 03/17/2021 | New coupon - percent off MSRP item |
+| 3.1.16 | 03/16/2021 | screen recording filter page parameter names |
+| 3.1.15 | 03/15/2021 | fix response from deleteScreenRecordingSegment that should have been void |
+| 3.1.14 | 03/15/2021 | sort screen recordings by favorite flag |
+| 3.1.13 | 03/02/2021 | new webhook order_payment_failed |
+| 3.1.12 | 02/25/2021 | added screen recording visitor_first_seen property |
+| 3.1.11 | 02/24/2021 | Added Screen recording visitor number |
+| 3.1.10 | 02/24/2021 | Added Screen recording merchant notes |
+| 3.1.9 | 02/24/2021 | Allow coupons to be configured as unique with expiration on cart step within StoreFront Communications |
+| 3.1.8 | 02/24/2021 | Add flag: screen recording missing event boolean |
+| 3.1.5 | 02/12/2021 | Bug Fix: PHP retry logic missing a closing brace. Also screen recording page view data response refactor |
+| 3.1.3 | 02/11/2021 | Bug Fix: wrong return type on CustomerApi.validateEmailVerificationToken |
+| 3.1.2 | 02/11/2021 | CustomerApi.getEmailVerificationToken, CustomerApi.validateEmailVerificationToken added to allow for custom email verification.  Also added favorite flag to screen recording object |
+| 3.1.1 | 02/10/2021 | CustomerApi.getCustomerByEmail() method added |
+| 3.1.0 | 02/10/2021 | Minor revision jump.  Added new convenience methods for simple_key use to all api calls.  Updated docs |
+| 3.0.75 | 02/01/2021 | StoreFront Communication plan revision (internal use) |
+| 3.0.71 | 01/28/2021 | BugFix: PHP SDK retry logic NPE |
+| 3.0.70 | 01/26/2021 | Checkout return URL support |
+| 3.0.66 | 01/22/2021 | code library attributes (mostly internal dev) |
+| 3.0.65 | 01/22/2021 | Added folder support for email campaigns and flows |
+| 3.0.64 | 01/20/2021 | Bug fix on revenue per customer field incorrectly named. |
+| 3.0.63 | 01/20/2021 | CouponAPI: bug fixes and new method doesCouponCodeExist |
+| 3.0.62 | 01/19/2021 | Added retry ability when rate limit is triggered (PHP SDK only) only) Other sdk to follow. |
+| 3.0.60 | 01/14/2021 | Working with Ruby SDK |
+| 3.0.57 | 12/17/2020 | CouponAPI: Added Buy one get one free coupon |
+| 3.0.53 | 12/14/2020 | StoreFrontAPI: added a duplicate method to load the pricing tiers on the StoreFront |
+| 3.0.51 | 12/09/2020 | UserAPI: internal bug preventing proper usage of user group creation |
+| 3.0.45 | 12/03/2020 | CouponAPI: added partial searches to getCoupon params, added deleteCoupons method, fixed bugs |
+| 3.0.44 | 12/03/2020 | Code library updates, intended for internal use |
+| 3.0.43 | 12/02/2020 | Added fields to code library to handle versions of published items |
+| 3.0.42 | 12/02/2020 | Added display values to CouponApi.getEditorValues to make type dropdowns easy |
+| 3.0.41 | 11/17/2020 | New modify cart step option for StoreFront communications |
+| 3.0.39 | 11/12/2020 | Added Customer.tax_codes.taxjar_exemption_type |
+| 3.0.38 | 11/09/2020 | Added TaxProviderTaxJar.configuration.send_outside_nexus flag |
+| 3.0.37 | 11/06/2020 | Added transactional email screenshots for code library |
+| 3.0.36 | 11/03/2020 | Added missing constant for pre-order stage |
+| 3.0.34 | 10/26/2020 | UserAPI initial release |
+| 3.0.33 | 10/23/2020 | Added library_item_oid to StoreFront Communications email object for upcoming code library |
+| 3.0.32 | 10/21/2020 | Added new StoreFrontApi.search method that takes a POST instead of a GET |
+| 3.0.31 | 10/16/2020 | more dev work on code library (internal) |
+| 3.0.30 | 10/08/2020 | development work on code library (internal), first version of UserAPI.  The UserAPI is not live yet. |
+| 3.0.29 | 09/29/2020 | new boolean field on coupon: bug fix |
+| 3.0.28 | 09/29/2020 | new boolean field on coupon: free item with purchase of another item |
+| 3.0.27 | 09/29/2020 | Refactored the code library applyToStoreFront to provide support for marketing emails |
+| 3.0.26 | 09/25/2020 | Expose actual shipping and fulfillment costs in the order summary object |
+| 3.0.25 | 09/16/2020 | New method: OrderApi.adjustOrderTotal |
+| 3.0.24 | 09/10/2020 | Bugfix: incorrect response type on CheckoutAPI.registerAffiliateClick |
+| 3.0.23 | 09/02/2020 | Added flag to email plan object.  allow_tracking_emails |
+| 3.0.22 | 09/02/2020 | Order object - added tracking details |
+| 3.0.21 | 09/01/2020 | break fix in php sdk due to bad namespace |
+| 3.0.20 | 09/01/2020 | Added OrderApi.processPayment method |
+| 3.0.19 | 08/28/2020 | Code Library development: added kraken parameters for thumbnail image generation. |
+| 3.0.17 | 08/26/2020 | cont. development work on Code Library |
+| 3.0.14 | 08/19/2020 | development work on Code Library |
+| 3.0.13 | 08/18/2020 | development work on Code Library |
+| 3.0.12 | 08/13/2020 | screenshot urls for campaigns and flows (storefront communications) |
+| 3.0.11 | 08/12/2020 | Refactoring and development for Code Library (not released yet) |
+| 3.0.10 | 08/10/2020 | Method for registering an affliate click via the SDK, found within CheckoutAPI |
+| 3.0.8 | 08/05/2020 | stub for code library 'getLibraryFilterValues' for populating drop down lists |
+| 3.0.4 | 08/05/2020 | fixed misspell of 'version' in LibraryItem object. |
+| 3.0.3 | 08/04/2020 | added description to addToLibrary call to allow for initial description |
+| 3.0.2 | 08/03/2020 | added option on email render step config to allow override of subject, added flow/campaign flag to end once customer purchases |
+| 3.0.1 | 07/27/2020 | added init_json to storefront communication email objects |
+| 3.0.0 | 07/01/2020 | upgraded our swagger-codegen fork to the latest swagger source code. this was a major changes so we jumped version numbers.  please test all code. |
+
+Some changes jump version numbers due to multiple commits for bug fixes, omissions, and errors.
+At UltraCart, we eat our own dog food, and we increment the version number for every commit in order
+to generate a new javascript npm.  For this reason, version gaps will be found in the change log above.

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/LibraryItemAttribute.md

@@ -3,6 +3,7 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
+**library_item_oid** | **Integer** |  | [optional] 
 **name** | **String** |  | [optional] 
 **value** | **String** |  | [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)