ultracart_api 3.1.14 → 3.1.37

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ef1b046aadb89beed9acf48ad09a4d2d7e7acbcd233cb98f5786cb66a842e009
-  data.tar.gz: b96255c07ae2ba530ac1861e5facb5a16e4e99c3847411aa01c0954ae25df59d
+  metadata.gz: b5690416d00c2d70b1415240f127834c4705c6ab8ae1f351ff0d9855426a07d5
+  data.tar.gz: 9a71e679a3452d63c397fc6ab6073e889c4fd8e3ff2ea993fc5768132690250e
 SHA512:
-  metadata.gz: eba5db20276ecc1f01fc965a04629f9aa54e632c6fa88860da89429652783b5d949bb5eed6c2156d629d3b1a9224277461bb0c9105c2939820b8f8493b728eea
-  data.tar.gz: 5b569aa51718fd3f9c1af6d86c3955dd4478919f784f0d689b71fa7e1abc554627c8a68c2d1a2e94a8b0ad4073e43071b13b19cfd06c13895f6a13766b21c2c7
+  metadata.gz: 96d5977c4a8311cedd2b1f18b3f59c46a4e573940325ebbc16d00610f647be5d79d0e679aabf7b0e099b38ab3317af5f3c5a522906bfce6b53207bb3f88b8841
+  data.tar.gz: e5af30079d2bcd2baf84594a8a0e5e1d8f0bc7d059e8c49496a4d1f5c4dc8cc33f1c425ca85fdb7393ed2919b24a3d2f9fcbcd960834a5c9fd18b375258d2752

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.14
+- Package version: 3.1.37
 - 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.14.gem
+gem install ./ultracart_api-3.1.37.gem
 ```
-(for development, run `gem install --dev ./ultracart_api-3.1.14.gem` to install the development dependencies)
+(for development, run `gem install --dev ./ultracart_api-3.1.37.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.14'
+    gem 'ultracart_api', '~> 3.1.37'
 
 ### Install from Git
 
@@ -522,6 +522,7 @@ Class | Method | HTTP request | Description
  - [UltracartClient::CouponPercentOffItems](docs/CouponPercentOffItems.md)
  - [UltracartClient::CouponPercentOffItemsAndFreeShipping](docs/CouponPercentOffItemsAndFreeShipping.md)
  - [UltracartClient::CouponPercentOffItemsWithItemsPurchase](docs/CouponPercentOffItemsWithItemsPurchase.md)
+ - [UltracartClient::CouponPercentOffMsrpItems](docs/CouponPercentOffMsrpItems.md)
  - [UltracartClient::CouponPercentOffRetailPriceItems](docs/CouponPercentOffRetailPriceItems.md)
  - [UltracartClient::CouponPercentOffShipping](docs/CouponPercentOffShipping.md)
  - [UltracartClient::CouponPercentOffSubtotal](docs/CouponPercentOffSubtotal.md)
@@ -851,6 +852,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)
@@ -866,6 +868,8 @@ Class | Method | HTTP request | Description
  - [UltracartClient::ScreenRecordingFilterValues](docs/ScreenRecordingFilterValues.md)
  - [UltracartClient::ScreenRecordingFilterValuesEvent](docs/ScreenRecordingFilterValuesEvent.md)
  - [UltracartClient::ScreenRecordingFilterValuesEventParams](docs/ScreenRecordingFilterValuesEventParams.md)
+ - [UltracartClient::ScreenRecordingFilterValuesPageParam](docs/ScreenRecordingFilterValuesPageParam.md)
+ - [UltracartClient::ScreenRecordingFilterValuesPageView](docs/ScreenRecordingFilterValuesPageView.md)
  - [UltracartClient::ScreenRecordingMerchantNotesRequest](docs/ScreenRecordingMerchantNotesRequest.md)
  - [UltracartClient::ScreenRecordingMultifield](docs/ScreenRecordingMultifield.md)
  - [UltracartClient::ScreenRecordingPageView](docs/ScreenRecordingPageView.md)
@@ -998,76 +1002,3 @@ 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.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/Coupon.md

@@ -41,6 +41,7 @@ Name | Type | Description | Notes
 **percent_off_items** | [**CouponPercentOffItems**](CouponPercentOffItems.md) |  | [optional] 
 **percent_off_items_and_free_shipping** | [**CouponPercentOffItemsAndFreeShipping**](CouponPercentOffItemsAndFreeShipping.md) |  | [optional] 
 **percent_off_items_with_items_purchase** | [**CouponPercentOffItemsWithItemsPurchase**](CouponPercentOffItemsWithItemsPurchase.md) |  | [optional] 
+**percent_off_msrp_items** | [**CouponPercentOffMsrpItems**](CouponPercentOffMsrpItems.md) |  | [optional] 
 **percent_off_retail_price_items** | [**CouponPercentOffRetailPriceItems**](CouponPercentOffRetailPriceItems.md) |  | [optional] 
 **percent_off_shipping** | [**CouponPercentOffShipping**](CouponPercentOffShipping.md) |  | [optional] 
 **percent_off_subtotal** | [**CouponPercentOffSubtotal**](CouponPercentOffSubtotal.md) |  | [optional] 

data/docs/CouponPercentOffMsrpItems.md

@@ -0,0 +1,11 @@
+# UltracartClient::CouponPercentOffMsrpItems
+
+## Properties
+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 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

@@ -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/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/ScreenRecordingFilterValues.md

@@ -3,15 +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_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/ScreenRecordingFilterValuesPageParam.md

@@ -0,0 +1,9 @@
+# UltracartClient::ScreenRecordingFilterValuesPageParam
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** |  | [optional] 
+**values** | **Array<String>** |  | [optional] 
+
+

data/docs/ScreenRecordingFilterValuesPageView.md

@@ -0,0 +1,12 @@
+# UltracartClient::ScreenRecordingFilterValuesPageView
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**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/ScreenRecordingPageView.md

@@ -16,6 +16,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]