ultracart_api 3.1.17 → 3.1.41

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 73ab4c834ab8a23e2eed548475b1b8028ce7e88e0fcce48124cbfd182bc653a7
-  data.tar.gz: c4ce953a77aae9325c9a80e954810a069e82bd8796d62c29056938392694eb8a
+  metadata.gz: 748803f413463ae4065591e7feb19331b167d644f3b41246877fd777129bc14e
+  data.tar.gz: 45a56affd788578bc18b1038fd50bfe81f423a7a7928e7c69ca9f5134fc51e9d
 SHA512:
-  metadata.gz: 1ea1e5422d0aa76786848d12718a0fe99afe9bd0486e2528a64b41346782d284247991551172cc8608bfb0fea5533638fe9f0b098500d6e0fd1b83e6a7054489
-  data.tar.gz: f8a0cf76b26e52c1ed87cffa09986ebfa66c7a6e62b17788c908dae65abea1e20138771fb609fb967e1e07458db6e4e6bf6cd4f39a34d17cb442b83f8a1e11b7
+  metadata.gz: c07af4bde282a2d562b5b0f7a7d015aed94aaa3f6eccecaf8285ce45b1fd022bc5918287e76e5988212831776a0aa1178ab22fc7820fcaf60532653e44923432
+  data.tar.gz: ca25b886fc27695d175c5093b91ebb9e752c285c950ca2000e1a0844eafe8151409809ae1b18fda6180cc47d4fec5789ff7bceb80a3360931dcf245ffd34e952

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.17
+- Package version: 3.1.41
 - 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.17.gem
+gem install ./ultracart_api-3.1.41.gem
 ```
-(for development, run `gem install --dev ./ultracart_api-3.1.17.gem` to install the development dependencies)
+(for development, run `gem install --dev ./ultracart_api-3.1.41.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.17'
+    gem 'ultracart_api', '~> 3.1.41'
 
 ### 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.
@@ -852,6 +855,7 @@ Class | Method | HTTP request | Description
  - [UltracartClient::ResponseMetadata](docs/ResponseMetadata.md)
  - [UltracartClient::ResultSet](docs/ResultSet.md)
  - [UltracartClient::ScreenRecording](docs/ScreenRecording.md)
+ - [UltracartClient::ScreenRecordingAdPlatform](docs/ScreenRecordingAdPlatform.md)
  - [UltracartClient::ScreenRecordingFilter](docs/ScreenRecordingFilter.md)
  - [UltracartClient::ScreenRecordingFilterGeoDistance](docs/ScreenRecordingFilterGeoDistance.md)
  - [UltracartClient::ScreenRecordingFilterIpSearch](docs/ScreenRecordingFilterIpSearch.md)
@@ -868,6 +872,13 @@ Class | Method | HTTP request | Description
  - [UltracartClient::ScreenRecordingFilterValuesEvent](docs/ScreenRecordingFilterValuesEvent.md)
  - [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)
@@ -1008,6 +1019,24 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 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 |

data/docs/CouponPercentOffMsrpItems.md

@@ -5,7 +5,7 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **discount_percent** | **Float** | The percentage of subtotal discount | [optional] 
 **excluded_items** | **Array<String>** | A list of items which cannot be discounted. | [optional] 
-**items** | **Array<String>** | An optional list of items which will receive a discount.  If blank, discount applies to all items except excluded items. | [optional] 
+**items** | **Array<String>** | An list of items which will receive a discount. | [optional] 
 **limit** | **Integer** | The (optional) maximum quantity of discounted items. | [optional] 
 
 

data/docs/CustomerLoyalty.md

@@ -5,6 +5,7 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **current_points** | **Integer** | Current Points | [optional] 
 **ledger_entries** | [**Array<CustomerLoyaltyLedger>**](CustomerLoyaltyLedger.md) | Ledger entries | [optional] 
+**pending_points** | **Integer** | Pending Points | [optional] 
 **redemptions** | [**Array<CustomerLoyaltyRedemption>**](CustomerLoyaltyRedemption.md) | Redemptions | [optional] 
 
 

data/docs/EmailCampaign.md

@@ -8,7 +8,8 @@ Name | Type | Description | Notes
 **deleted** | **BOOLEAN** | True if this campaign was deleted | [optional] 
 **email_campaign_uuid** | **String** | Email campaign UUID | [optional] 
 **email_communication_sequence_uuid** | **String** | Email communication sequence UUID | [optional] 
-**end_once_customer_purchases** | **BOOLEAN** | True if the customer should end the flow once they purchase | [optional] 
+**end_once_customer_purchases** | **BOOLEAN** | True if the customer should end the flow once they purchase from this campaign | [optional] 
+**end_once_customer_purchases_anywhere** | **BOOLEAN** | True if the customer should end the flow once they purchase from anywhere | [optional] 
 **esp_campaign_folder_uuid** | **String** | Campaign folder UUID.  Null for uncategorized | [optional] 
 **esp_domain_user** | **String** | User of the sending address | [optional] 
 **esp_domain_uuid** | **String** | UUID of the sending domain | [optional] 

data/docs/EmailFlow.md

@@ -10,7 +10,8 @@ Name | Type | Description | Notes
 **deleted** | **BOOLEAN** | True if this campaign was deleted | [optional] 
 **email_communication_sequence_uuid** | **String** | Email communication sequence UUID | [optional] 
 **email_flow_uuid** | **String** | Email flow UUID | [optional] 
-**end_once_customer_purchases** | **BOOLEAN** | True if the customer should end the flow once they purchase | [optional] 
+**end_once_customer_purchases** | **BOOLEAN** | True if the customer should end the flow once they purchase from an email on this flow | [optional] 
+**end_once_customer_purchases_anywhere** | **BOOLEAN** | True if the customer should end the flow once they purchase from any source | [optional] 
 **enrolled_customers** | **Integer** | Number of enrolled customers. | [optional] 
 **esp_domain_user** | **String** | Username of sending email | [optional] 
 **esp_domain_uuid** | **String** | UUID of sending domain | [optional] 

data/docs/LibraryItemAttribute.md

@@ -3,7 +3,6 @@
 ## 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
@@ -542,6 +542,8 @@ opts = {
   custom_field_5: 'custom_field_5_example', # String | 
   custom_field_6: 'custom_field_6_example', # String | 
   custom_field_7: 'custom_field_7_example', # String | 
+  ship_on_date_begin: 'ship_on_date_begin_example', # String | 
+  ship_on_date_end: 'ship_on_date_end_example', # String | 
   _limit: 100, # Integer | The maximum number of records to return on this one API call. (Maximum 200)
   _offset: 0, # Integer | Pagination of the record set.  Offset is a zero based index.
   _sort: '_sort_example', # String | The sort order of the orders.  See Sorting documentation for examples of using multiple values and sorting by ascending and descending.
@@ -598,6 +600,8 @@ Name | Type | Description  | Notes
  **custom_field_5** | **String**|  | [optional] 
  **custom_field_6** | **String**|  | [optional] 
  **custom_field_7** | **String**|  | [optional] 
+ **ship_on_date_begin** | **String**|  | [optional] 
+ **ship_on_date_end** | **String**|  | [optional] 
  **_limit** | **Integer**| The maximum number of records to return on this one API call. (Maximum 200) | [optional] [default to 100]
  **_offset** | **Integer**| Pagination of the record set.  Offset is a zero based index. | [optional] [default to 0]
  **_sort** | **String**| The sort order of the orders.  See Sorting documentation for examples of using multiple values and sorting by ascending and descending. | [optional] 

data/docs/OrderProcessPaymentRequest.md

@@ -3,6 +3,7 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
+**amount** | **Float** | Specific amount to bill (optional).  If not specified the total of the order is billed. | [optional] 
 **card_verification_number_token** | **String** | Card verification number token from hosted fields used during credit card transaction processing (optional) | [optional] 
 
 

data/docs/OrderQuery.md

@@ -35,8 +35,10 @@ Name | Type | Description | Notes
 **refund_date_end** | **String** | Date/time that the order was refunded | [optional] 
 **rma** | **String** | RMA number | [optional] 
 **screen_branding_theme_code** | **String** | Screen branding theme code associated with the order (legacy checkout) | [optional] 
-**shipment_date_begin** | **String** | Date/time that the order was shipping | [optional] 
+**shipment_date_begin** | **String** | Date/time that the order was shipped | [optional] 
 **shipment_date_end** | **String** | Date/time that the order was shipped | [optional] 
+**shipped_on_date_begin** | **String** | Date/time that the order should ship on | [optional] 
+**shipped_on_date_end** | **String** | Date/time that the order should ship on | [optional] 
 **state_region** | **String** | State for United States otherwise region or province for other countries | [optional] 
 **storefront_host_name** | **String** | StoreFront host name associated with the order | [optional] 
 **total** | **Float** | Total | [optional] 

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

@@ -3,10 +3,18 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
+**ad_platform** | [**ScreenRecordingAdPlatform**](ScreenRecordingAdPlatform.md) |  | [optional] 
 **analytics_client_oid** | **Integer** |  | [optional] 
 **analytics_session_dts** | **Integer** |  | [optional] 
 **analytics_session_oid** | **Integer** |  | [optional] 
+**communications_campaign_name** | **String** | Campaign Name | [optional] 
+**communications_campaign_uuid** | **String** | Campaign UUID | [optional] 
+**communications_email_subject** | **String** | Email subject | [optional] 
+**communications_email_uuid** | **String** | Email UUID | [optional] 
+**communications_flow_name** | **String** | Flow Name | [optional] 
+**communications_flow_uuid** | **String** | Flow UUID | [optional] 
 **email** | **String** |  | [optional] 
+**email_domain** | **String** |  | [optional] 
 **end_timestamp** | **String** | Ending timestamp | [optional] 
 **esp_customer_uuid** | **String** |  | [optional] 
 **events_gz_size** | **Integer** |  | [optional] 
@@ -16,11 +24,14 @@ Name | Type | Description | Notes
 **geolocation** | [**GeoPoint**](GeoPoint.md) |  | [optional] 
 **geolocation_country** | **String** |  | [optional] 
 **geolocation_state** | **String** |  | [optional] 
+**language_iso_code** | **String** | Language ISO code | [optional] 
 **merchant_id** | **String** |  | [optional] 
 **merchant_notes** | **String** |  | [optional] 
 **order_id** | **String** |  | [optional] 
 **page_view_count** | **Integer** |  | [optional] 
 **page_views** | [**Array<ScreenRecordingPageView>**](ScreenRecordingPageView.md) |  | [optional] 
+**preferred_language** | **String** | ISO 3 Letter language code that the customer would prefer | [optional] 
+**referrer_domain** | **String** |  | [optional] 
 **rrweb_version** | **String** |  | [optional] 
 **screen_recording_uuid** | **String** |  | [optional] 
 **signed_download_url** | **String** |  | [optional] 
@@ -34,6 +45,8 @@ Name | Type | Description | Notes
 **user_agent_raw** | **String** |  | [optional] 
 **user_ip** | **String** |  | [optional] 
 **user_properties** | [**Array<ScreenRecordingUserProperty>**](ScreenRecordingUserProperty.md) |  | [optional] 
+**utm_campaign** | **String** | UTM Campaign | [optional] 
+**utm_source** | **String** | UTM Source | [optional] 
 **visitor_first_seen** | **String** | Timestamp this visitor was first seen | [optional] 
 **visitor_number** | **Integer** |  | [optional] 
 **watched** | **BOOLEAN** |  | [optional] 

data/docs/ScreenRecordingAdPlatform.md

@@ -0,0 +1,13 @@
+# UltracartClient::ScreenRecordingAdPlatform
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**fbc** | **String** | Facebook Click Id (Cookie) | [optional] 
+**fbclid** | **String** | Facebook Click Id Parameter (Parameter) | [optional] 
+**fbp** | **String** | Facebook Browser Id (Cookie) | [optional] 
+**gacid** | **String** | Google Analytics CID (Cookie) | [optional] 
+**glcid** | **String** | Google Adwords Click Id (Parameter) | [optional] 
+**msclkid** | **String** | Bing Click Id (Parameter | [optional] 
+
+

data/docs/ScreenRecordingFilter.md

@@ -3,7 +3,13 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
+**affiliate_email** | **String** |  | [optional] 
+**affiliate_id** | **Integer** |  | [optional] 
+**communications_campaign_name** | **String** |  | [optional] 
+**communications_email_subject** | **String** |  | [optional] 
+**communications_flow_name** | **String** |  | [optional] 
 **email** | [**ScreenRecordingFilterStringSearch**](ScreenRecordingFilterStringSearch.md) |  | [optional] 
+**email_domain** | **String** |  | [optional] 
 **email_identified** | **BOOLEAN** |  | [optional] 
 **end_timestamp** | [**ScreenRecordingFilterRangeDate**](ScreenRecordingFilterRangeDate.md) |  | [optional] 
 **esp_customer_uuid** | **String** |  | [optional] 
@@ -11,11 +17,15 @@ Name | Type | Description | Notes
 **geolocation** | [**ScreenRecordingFilterGeoDistance**](ScreenRecordingFilterGeoDistance.md) |  | [optional] 
 **geolocation_country** | [**ScreenRecordingFilterStringSearch**](ScreenRecordingFilterStringSearch.md) |  | [optional] 
 **geolocation_state** | [**ScreenRecordingFilterStringSearch**](ScreenRecordingFilterStringSearch.md) |  | [optional] 
+**language_iso_code** | [**ScreenRecordingFilterStringSearch**](ScreenRecordingFilterStringSearch.md) |  | [optional] 
+**last_x_days** | **Integer** |  | [optional] 
 **max_filter_values** | **Integer** |  | [optional] 
 **order_id** | [**ScreenRecordingFilterStringSearch**](ScreenRecordingFilterStringSearch.md) |  | [optional] 
 **page_view_count** | [**ScreenRecordingFilterRangeInteger**](ScreenRecordingFilterRangeInteger.md) |  | [optional] 
 **page_views** | [**Array<ScreenRecordingFilterPageView>**](ScreenRecordingFilterPageView.md) |  | [optional] 
 **placed_order** | **BOOLEAN** |  | [optional] 
+**preferred_language** | [**ScreenRecordingFilterStringSearch**](ScreenRecordingFilterStringSearch.md) |  | [optional] 
+**referrer_domain** | **String** |  | [optional] 
 **screen_recording_uuids** | **Array<String>** |  | [optional] 
 **screen_sizes** | **Array<String>** |  | [optional] 
 **skip_filter_values** | **BOOLEAN** |  | [optional] 
@@ -29,6 +39,8 @@ Name | Type | Description | Notes
 **user_agent_os_name** | **String** |  | [optional] 
 **user_agent_os_version** | **String** |  | [optional] 
 **user_ip** | [**ScreenRecordingFilterIpSearch**](ScreenRecordingFilterIpSearch.md) |  | [optional] 
+**utm_campaign** | **String** |  | [optional] 
+**utm_source** | **String** |  | [optional] 
 **visitor_number** | **Integer** |  | [optional] 
 **watched** | **BOOLEAN** |  | [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/ScreenRecordingFilterValues.md

@@ -3,16 +3,26 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**events** | [**Array<ScreenRecordingFilterValuesEvent>**](ScreenRecordingFilterValuesEvent.md) |  | [optional] 
+**communications_campaign_names** | **Array<String>** |  | [optional] 
+**communications_email_subjects** | **Array<String>** |  | [optional] 
+**communications_flow_names** | **Array<String>** |  | [optional] 
+**email_domains** | **Array<String>** |  | [optional] 
 **geolocation_countries** | **Array<String>** |  | [optional] 
 **geolocation_states** | **Array<String>** |  | [optional] 
+**language_iso_codes** | **Array<String>** |  | [optional] 
 **max_values** | **Integer** |  | [optional] 
-**page_params** | [**Array<ScreenRecordingFilterValuesPageParam>**](ScreenRecordingFilterValuesPageParam.md) |  | [optional] 
+**page_views** | [**Array<ScreenRecordingFilterValuesPageView>**](ScreenRecordingFilterValuesPageView.md) |  | [optional] 
+**preferred_languages** | **Array<String>** |  | [optional] 
+**referrer_domains** | **Array<String>** |  | [optional] 
+**time_on_site_max** | **Integer** |  | [optional] 
+**time_on_site_min** | **Integer** |  | [optional] 
 **urls** | **Array<String>** |  | [optional] 
 **user_agent_device_names** | **Array<String>** |  | [optional] 
 **user_agent_device_os_names** | **Array<String>** |  | [optional] 
 **user_agent_device_os_versions** | **Array<String>** |  | [optional] 
 **user_agent_names** | **Array<String>** |  | [optional] 
 **user_agent_originals** | **Array<String>** |  | [optional] 
+**utm_campaigns** | **Array<String>** |  | [optional] 
+**utm_sources** | **Array<String>** |  | [optional] 
 
 

data/docs/ScreenRecordingFilterValuesPageView.md

@@ -0,0 +1,13 @@
+# UltracartClient::ScreenRecordingFilterValuesPageView
+
+## 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] 
+**time_on_page_min** | **Integer** |  | [optional] 
+**urls** | **Array<String>** |  | [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] 
+
+