ultracart_api 3.1.18 → 3.1.42

Sign up to get free protection for your applications and to get access to all the features.
Files changed (69) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +33 -4
  3. data/docs/CouponPercentOffMsrpItems.md +1 -1
  4. data/docs/CouponTierAmount.md +1 -0
  5. data/docs/CouponTierPercent.md +1 -0
  6. data/docs/CouponTierQuantityAmount.md +1 -0
  7. data/docs/CouponTierQuantityPercent.md +1 -0
  8. data/docs/CouponTieredPercentOffShipping.md +1 -0
  9. data/docs/CustomerLoyalty.md +1 -0
  10. data/docs/EmailCampaign.md +2 -1
  11. data/docs/EmailFlow.md +2 -1
  12. data/docs/LibraryItemAttribute.md +0 -1
  13. data/docs/OrderApi.md +1 -1
  14. data/docs/OrderProcessPaymentRequest.md +1 -0
  15. data/docs/OrderSummary.md +1 -0
  16. data/docs/ScreenRecording.md +13 -0
  17. data/docs/ScreenRecordingAdPlatform.md +13 -0
  18. data/docs/ScreenRecordingFilter.md +12 -0
  19. data/docs/ScreenRecordingFilterPageView.md +1 -0
  20. data/docs/ScreenRecordingFilterValues.md +12 -2
  21. data/docs/ScreenRecordingFilterValuesPageView.md +13 -0
  22. data/docs/ScreenRecordingHeatmap.md +19 -0
  23. data/docs/ScreenRecordingHeatmapIndexResponse.md +12 -0
  24. data/docs/ScreenRecordingHeatmapRequest.md +9 -0
  25. data/docs/ScreenRecordingHeatmapReset.md +8 -0
  26. data/docs/ScreenRecordingHeatmapResponse.md +12 -0
  27. data/docs/ScreenRecordingHeatmapUrl.md +12 -0
  28. data/docs/ScreenRecordingPageView.md +3 -0
  29. data/docs/ScreenRecordingPageViewEvent.md +1 -0
  30. data/docs/ScreenRecordingQueryResponse.md +3 -0
  31. data/docs/ScreenRecordingSegment.md +3 -0
  32. data/docs/ScreenRecordingSettings.md +5 -0
  33. data/docs/StorefrontApi.md +158 -0
  34. data/docs/WebhookLog.md +1 -0
  35. data/lib/ultracart_api.rb +8 -0
  36. data/lib/ultracart_api/api/order_api.rb +2 -2
  37. data/lib/ultracart_api/api/storefront_api.rb +176 -0
  38. data/lib/ultracart_api/models/coupon_percent_off_msrp_items.rb +1 -1
  39. data/lib/ultracart_api/models/coupon_tier_amount.rb +26 -1
  40. data/lib/ultracart_api/models/coupon_tier_percent.rb +26 -1
  41. data/lib/ultracart_api/models/coupon_tier_quantity_amount.rb +29 -4
  42. data/lib/ultracart_api/models/coupon_tier_quantity_percent.rb +29 -4
  43. data/lib/ultracart_api/models/coupon_tiered_percent_off_shipping.rb +26 -1
  44. data/lib/ultracart_api/models/customer_loyalty.rb +11 -1
  45. data/lib/ultracart_api/models/email_campaign.rb +12 -2
  46. data/lib/ultracart_api/models/email_flow.rb +12 -2
  47. data/lib/ultracart_api/models/library_item_attribute.rb +1 -10
  48. data/lib/ultracart_api/models/order_process_payment_request.rb +11 -1
  49. data/lib/ultracart_api/models/order_summary.rb +10 -1
  50. data/lib/ultracart_api/models/screen_recording.rb +128 -1
  51. data/lib/ultracart_api/models/screen_recording_ad_platform.rb +235 -0
  52. data/lib/ultracart_api/models/screen_recording_filter.rb +109 -1
  53. data/lib/ultracart_api/models/screen_recording_filter_page_view.rb +10 -1
  54. data/lib/ultracart_api/models/screen_recording_filter_values.rb +124 -18
  55. data/lib/ultracart_api/models/screen_recording_filter_values_page_view.rb +237 -0
  56. data/lib/ultracart_api/models/screen_recording_heatmap.rb +283 -0
  57. data/lib/ultracart_api/models/screen_recording_heatmap_index_response.rb +223 -0
  58. data/lib/ultracart_api/models/screen_recording_heatmap_request.rb +193 -0
  59. data/lib/ultracart_api/models/screen_recording_heatmap_reset.rb +184 -0
  60. data/lib/ultracart_api/models/screen_recording_heatmap_response.rb +221 -0
  61. data/lib/ultracart_api/models/screen_recording_heatmap_url.rb +222 -0
  62. data/lib/ultracart_api/models/screen_recording_page_view.rb +30 -1
  63. data/lib/ultracart_api/models/screen_recording_page_view_event.rb +10 -1
  64. data/lib/ultracart_api/models/screen_recording_query_response.rb +30 -1
  65. data/lib/ultracart_api/models/screen_recording_segment.rb +30 -1
  66. data/lib/ultracart_api/models/screen_recording_settings.rb +49 -4
  67. data/lib/ultracart_api/models/webhook_log.rb +11 -1
  68. data/lib/ultracart_api/version.rb +1 -1
  69. metadata +18 -2
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 4ec877eeac5aebf27faca2f70559c977a0a530048e7869d317322e54a0d8ab37
4
- data.tar.gz: 4a3a15da646aff74261ff92d6d89af41033fe2ff24a95911eb28e5dbcae86151
3
+ metadata.gz: 25381645bc503673706150a6ad3f5e2aebfad380d39266f51582ee78bcd46659
4
+ data.tar.gz: 93a03208efd7a6a27617f91de4ff8765271f593c161a8deda70e687b9ba15433
5
5
  SHA512:
6
- metadata.gz: 762401de2c3d75f779ab20e60c01a463a31133234d2099ef31bbf5cdc73711e90e4565c644d1306f1fdb63266e4c1215513e804f424e28af54d7d5bdcc25f57d
7
- data.tar.gz: d06e75abf6bae59074d849cc0b05187db96ff3b9eb262f053834a18cb75272c80e7eea51a0460a55cda5dfb1eff106b5b2efcad8d5adbaff5ae78943b7a6d310
6
+ metadata.gz: 8a6e5d0fcaf87a9e7d79429f8cc0792dca98907b43481f1a853b3b28299fac3165d4f437638115629c63aca90e75e6bb3de203175117332a761adf91a0675814
7
+ data.tar.gz: 1644403544aadbc2ee6dee29e067db14b22b72ed73d339d3a767a2cf132e45a7cb0ec58c965b52b50676693b8f2bc22f5b01a42a415e43374525d92c8c061c1d
data/README.md CHANGED
@@ -7,7 +7,7 @@ UltraCart REST API Version 2
7
7
  This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
8
8
 
9
9
  - API version: 2.0.0
10
- - Package version: 3.1.18
10
+ - Package version: 3.1.42
11
11
  - Build package: io.swagger.codegen.languages.RubyClientCodegen
12
12
  For more information, please visit [http://www.ultracart.com](http://www.ultracart.com)
13
13
 
@@ -24,15 +24,15 @@ gem build ultracart_api.gemspec
24
24
  Then either install the gem locally:
25
25
 
26
26
  ```shell
27
- gem install ./ultracart_api-3.1.18.gem
27
+ gem install ./ultracart_api-3.1.42.gem
28
28
  ```
29
- (for development, run `gem install --dev ./ultracart_api-3.1.18.gem` to install the development dependencies)
29
+ (for development, run `gem install --dev ./ultracart_api-3.1.42.gem` to install the development dependencies)
30
30
 
31
31
  or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
32
32
 
33
33
  Finally add this to the Gemfile:
34
34
 
35
- gem 'ultracart_api', '~> 3.1.18'
35
+ gem 'ultracart_api', '~> 3.1.42'
36
36
 
37
37
  ### Install from Git
38
38
 
@@ -205,6 +205,7 @@ Class | Method | HTTP request | Description
205
205
  *UltracartClient::StorefrontApi* | [**delete_email_postcard**](docs/StorefrontApi.md#delete_email_postcard) | **DELETE** /storefront/{storefront_oid}/email/postcards/{commseq_postcard_uuid} | Delete email postcard
206
206
  *UltracartClient::StorefrontApi* | [**delete_email_sending_domain**](docs/StorefrontApi.md#delete_email_sending_domain) | **DELETE** /storefront/email/sending_domains/{domain} | delete email campaign
207
207
  *UltracartClient::StorefrontApi* | [**delete_experiment**](docs/StorefrontApi.md#delete_experiment) | **DELETE** /storefront/{storefront_oid}/experiments/{storefront_experiment_oid} | Delete experiment
208
+ *UltracartClient::StorefrontApi* | [**delete_heatmap**](docs/StorefrontApi.md#delete_heatmap) | **DELETE** /storefront/{storefront_oid}/screen_recordings/heatmap | Delete screen recording heatmap
208
209
  *UltracartClient::StorefrontApi* | [**delete_library_item**](docs/StorefrontApi.md#delete_library_item) | **DELETE** /storefront/code_library/{library_item_oid} | Delete library item
209
210
  *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.
210
211
  *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
264
265
  *UltracartClient::StorefrontApi* | [**get_email_templates**](docs/StorefrontApi.md#get_email_templates) | **GET** /storefront/{storefront_oid}/email/templates | Get email templates
265
266
  *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
266
267
  *UltracartClient::StorefrontApi* | [**get_experiments**](docs/StorefrontApi.md#get_experiments) | **GET** /storefront/{storefront_oid}/experiments | Get experiments
268
+ *UltracartClient::StorefrontApi* | [**get_heatmap**](docs/StorefrontApi.md#get_heatmap) | **POST** /storefront/{storefront_oid}/screen_recordings/heatmap | Get screen recording heatmap
269
+ *UltracartClient::StorefrontApi* | [**get_heatmap_index**](docs/StorefrontApi.md#get_heatmap_index) | **POST** /storefront/{storefront_oid}/screen_recordings/heatmap/index | Get screen recording heatmap index
267
270
  *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
268
271
  *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
269
272
  *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
852
855
  - [UltracartClient::ResponseMetadata](docs/ResponseMetadata.md)
853
856
  - [UltracartClient::ResultSet](docs/ResultSet.md)
854
857
  - [UltracartClient::ScreenRecording](docs/ScreenRecording.md)
858
+ - [UltracartClient::ScreenRecordingAdPlatform](docs/ScreenRecordingAdPlatform.md)
855
859
  - [UltracartClient::ScreenRecordingFilter](docs/ScreenRecordingFilter.md)
856
860
  - [UltracartClient::ScreenRecordingFilterGeoDistance](docs/ScreenRecordingFilterGeoDistance.md)
857
861
  - [UltracartClient::ScreenRecordingFilterIpSearch](docs/ScreenRecordingFilterIpSearch.md)
@@ -868,6 +872,13 @@ Class | Method | HTTP request | Description
868
872
  - [UltracartClient::ScreenRecordingFilterValuesEvent](docs/ScreenRecordingFilterValuesEvent.md)
869
873
  - [UltracartClient::ScreenRecordingFilterValuesEventParams](docs/ScreenRecordingFilterValuesEventParams.md)
870
874
  - [UltracartClient::ScreenRecordingFilterValuesPageParam](docs/ScreenRecordingFilterValuesPageParam.md)
875
+ - [UltracartClient::ScreenRecordingFilterValuesPageView](docs/ScreenRecordingFilterValuesPageView.md)
876
+ - [UltracartClient::ScreenRecordingHeatmap](docs/ScreenRecordingHeatmap.md)
877
+ - [UltracartClient::ScreenRecordingHeatmapIndexResponse](docs/ScreenRecordingHeatmapIndexResponse.md)
878
+ - [UltracartClient::ScreenRecordingHeatmapRequest](docs/ScreenRecordingHeatmapRequest.md)
879
+ - [UltracartClient::ScreenRecordingHeatmapReset](docs/ScreenRecordingHeatmapReset.md)
880
+ - [UltracartClient::ScreenRecordingHeatmapResponse](docs/ScreenRecordingHeatmapResponse.md)
881
+ - [UltracartClient::ScreenRecordingHeatmapUrl](docs/ScreenRecordingHeatmapUrl.md)
871
882
  - [UltracartClient::ScreenRecordingMerchantNotesRequest](docs/ScreenRecordingMerchantNotesRequest.md)
872
883
  - [UltracartClient::ScreenRecordingMultifield](docs/ScreenRecordingMultifield.md)
873
884
  - [UltracartClient::ScreenRecordingPageView](docs/ScreenRecordingPageView.md)
@@ -1008,6 +1019,24 @@ Not every change is committed to every SDK.
1008
1019
 
1009
1020
  | Version | Date | Comments |
1010
1021
  | --: | :-: | --- |
1022
+ | 3.1.42 | 01/01/2021 | added quickbooks accounting codes at the tiered level for tiered coupons |
1023
+ | 3.1.41 | 05/21/2021 | screen recording heatmap methods |
1024
+ | 3.1.40 | 05/20/2021 | Order.summary.actual_payment_processing field added |
1025
+ | 3.1.39 | 05/19/2021 | full deployment to ensure all language SDKs are up to date |
1026
+ | 3.1.37 | 05/18/2021 | removed php sdk dependency on ext-mbstring by generating sdk with polyfill requirement. sdk is more portable now. |
1027
+ | 3.1.35 | 05/14/2021 | screen recording histogram data |
1028
+ | 3.1.34 | 05/12/2021 | screen recording preferred language, last x days filter, referrer domain |
1029
+ | 3.1.33 | 05/11/2021 | creen recording filter for affiliate id and email |
1030
+ | 3.1.32 | 05/06/2021 | customer profile pending loyalty points |
1031
+ | 3.1.31 | 05/06/2021 | Added email domian field to screen recordings for filtering |
1032
+ | 3.1.30 | 04/27/2021 | OrderApi.processPayment now allows a specific amount to be billed |
1033
+ | 3.1.29 | 04/26/2021 | screen recording language iso code |
1034
+ | 3.1.28 | 04/26/2021 | screen recording statistics on the setting object |
1035
+ | 3.1.27 | 04/20/2021 | bug fix - annotation misspell on new email campaign property |
1036
+ | 3.1.26 | 04/20/2021 | StoreFront Connumications - flag to end campaign or flow once purchase happens anywhere |
1037
+ | 3.1.25 | 04/19/2021 | Screen recording UTM campaign and source fields |
1038
+ | 3.1.24 | 04/16/2021 | Screen recording aggregations on communications campaign/flows |
1039
+ | 3.1.22 | 04/09/2021 | Move URL filter values into page level view for screen recordings |
1011
1040
  | 3.1.18 | 03/17/2021 | Added order query by ship on date |
1012
1041
  | 3.1.17 | 03/17/2021 | New coupon - percent off MSRP item |
1013
1042
  | 3.1.16 | 03/16/2021 | screen recording filter page parameter names |
@@ -5,7 +5,7 @@ Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
6
  **discount_percent** | **Float** | The percentage of subtotal discount | [optional]
7
7
  **excluded_items** | **Array<String>** | A list of items which cannot be discounted. | [optional]
8
- **items** | **Array<String>** | An optional list of items which will receive a discount. If blank, discount applies to all items except excluded items. | [optional]
8
+ **items** | **Array<String>** | An list of items which will receive a discount. | [optional]
9
9
  **limit** | **Integer** | The (optional) maximum quantity of discounted items. | [optional]
10
10
 
11
11
 
@@ -4,6 +4,7 @@
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
6
  **discount_amount** | **Float** | The amount of subtotal discount | [optional]
7
+ **quickbooks_code** | **String** | Quickbooks accounting code. | [optional]
7
8
  **subtotal_amount** | **Float** | The amount of subtotal required to receive the discount amount | [optional]
8
9
 
9
10
 
@@ -4,6 +4,7 @@
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
6
  **discount_percent** | **Float** | The percent of subtotal discount | [optional]
7
+ **quickbooks_code** | **String** | Quickbooks accounting code. | [optional]
7
8
  **subtotal_amount** | **Float** | The amount of subtotal required to receive the discount percent | [optional]
8
9
 
9
10
 
@@ -5,5 +5,6 @@ Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
6
  **discount_amount** | **Float** | The amount of discount per item. | [optional]
7
7
  **item_quantity** | **Integer** | The quantity of item purchased (in units) | [optional]
8
+ **quickbooks_code** | **String** | Quickbooks accounting code. | [optional]
8
9
 
9
10
 
@@ -5,5 +5,6 @@ Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
6
  **discount_percent** | **Float** | The percent of discount per item. | [optional]
7
7
  **item_quantity** | **Integer** | The quantity of item purchased (in units) | [optional]
8
+ **quickbooks_code** | **String** | Quickbooks accounting code. | [optional]
8
9
 
9
10
 
@@ -3,6 +3,7 @@
3
3
  ## Properties
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
+ **quickbooks_code** | **String** | Quickbooks accounting code. | [optional]
6
7
  **shipping_methods** | **Array<String>** | One or more shipping methods that may receive this discount | [optional]
7
8
  **tiers** | [**Array<CouponTierPercent>**](CouponTierPercent.md) | A list of discount tiers. | [optional]
8
9
 
@@ -5,6 +5,7 @@ Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
6
  **current_points** | **Integer** | Current Points | [optional]
7
7
  **ledger_entries** | [**Array<CustomerLoyaltyLedger>**](CustomerLoyaltyLedger.md) | Ledger entries | [optional]
8
+ **pending_points** | **Integer** | Pending Points | [optional]
8
9
  **redemptions** | [**Array<CustomerLoyaltyRedemption>**](CustomerLoyaltyRedemption.md) | Redemptions | [optional]
9
10
 
10
11
 
@@ -8,7 +8,8 @@ Name | Type | Description | Notes
8
8
  **deleted** | **BOOLEAN** | True if this campaign was deleted | [optional]
9
9
  **email_campaign_uuid** | **String** | Email campaign UUID | [optional]
10
10
  **email_communication_sequence_uuid** | **String** | Email communication sequence UUID | [optional]
11
- **end_once_customer_purchases** | **BOOLEAN** | True if the customer should end the flow once they purchase | [optional]
11
+ **end_once_customer_purchases** | **BOOLEAN** | True if the customer should end the flow once they purchase from this campaign | [optional]
12
+ **end_once_customer_purchases_anywhere** | **BOOLEAN** | True if the customer should end the flow once they purchase from anywhere | [optional]
12
13
  **esp_campaign_folder_uuid** | **String** | Campaign folder UUID. Null for uncategorized | [optional]
13
14
  **esp_domain_user** | **String** | User of the sending address | [optional]
14
15
  **esp_domain_uuid** | **String** | UUID of the sending domain | [optional]
data/docs/EmailFlow.md CHANGED
@@ -10,7 +10,8 @@ Name | Type | Description | Notes
10
10
  **deleted** | **BOOLEAN** | True if this campaign was deleted | [optional]
11
11
  **email_communication_sequence_uuid** | **String** | Email communication sequence UUID | [optional]
12
12
  **email_flow_uuid** | **String** | Email flow UUID | [optional]
13
- **end_once_customer_purchases** | **BOOLEAN** | True if the customer should end the flow once they purchase | [optional]
13
+ **end_once_customer_purchases** | **BOOLEAN** | True if the customer should end the flow once they purchase from an email on this flow | [optional]
14
+ **end_once_customer_purchases_anywhere** | **BOOLEAN** | True if the customer should end the flow once they purchase from any source | [optional]
14
15
  **enrolled_customers** | **Integer** | Number of enrolled customers. | [optional]
15
16
  **esp_domain_user** | **String** | Username of sending email | [optional]
16
17
  **esp_domain_uuid** | **String** | UUID of sending domain | [optional]
@@ -3,7 +3,6 @@
3
3
  ## Properties
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
- **library_item_oid** | **Integer** | | [optional]
7
6
  **name** | **String** | | [optional]
8
7
  **value** | **String** | | [optional]
9
8
 
data/docs/OrderApi.md CHANGED
@@ -31,7 +31,7 @@ Method | HTTP request | Description
31
31
 
32
32
  Adjusts an order total
33
33
 
34
- 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.
34
+ 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.
35
35
 
36
36
  ### Example
37
37
  ```ruby
@@ -3,6 +3,7 @@
3
3
  ## Properties
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
+ **amount** | **Float** | Specific amount to bill (optional). If not specified the total of the order is billed. | [optional]
6
7
  **card_verification_number_token** | **String** | Card verification number token from hosted fields used during credit card transaction processing (optional) | [optional]
7
8
 
8
9
 
data/docs/OrderSummary.md CHANGED
@@ -4,6 +4,7 @@
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
6
  **actual_fulfillment** | [**Currency**](Currency.md) | | [optional]
7
+ **actual_payment_processing** | [**Currency**](Currency.md) | | [optional]
7
8
  **actual_shipping** | [**Currency**](Currency.md) | | [optional]
8
9
  **arbitrary_shipping_handling_total** | [**Currency**](Currency.md) | | [optional]
9
10
  **other_refunded** | [**Currency**](Currency.md) | | [optional]
@@ -3,10 +3,18 @@
3
3
  ## Properties
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
+ **ad_platform** | [**ScreenRecordingAdPlatform**](ScreenRecordingAdPlatform.md) | | [optional]
6
7
  **analytics_client_oid** | **Integer** | | [optional]
7
8
  **analytics_session_dts** | **Integer** | | [optional]
8
9
  **analytics_session_oid** | **Integer** | | [optional]
10
+ **communications_campaign_name** | **String** | Campaign Name | [optional]
11
+ **communications_campaign_uuid** | **String** | Campaign UUID | [optional]
12
+ **communications_email_subject** | **String** | Email subject | [optional]
13
+ **communications_email_uuid** | **String** | Email UUID | [optional]
14
+ **communications_flow_name** | **String** | Flow Name | [optional]
15
+ **communications_flow_uuid** | **String** | Flow UUID | [optional]
9
16
  **email** | **String** | | [optional]
17
+ **email_domain** | **String** | | [optional]
10
18
  **end_timestamp** | **String** | Ending timestamp | [optional]
11
19
  **esp_customer_uuid** | **String** | | [optional]
12
20
  **events_gz_size** | **Integer** | | [optional]
@@ -16,11 +24,14 @@ Name | Type | Description | Notes
16
24
  **geolocation** | [**GeoPoint**](GeoPoint.md) | | [optional]
17
25
  **geolocation_country** | **String** | | [optional]
18
26
  **geolocation_state** | **String** | | [optional]
27
+ **language_iso_code** | **String** | Language ISO code | [optional]
19
28
  **merchant_id** | **String** | | [optional]
20
29
  **merchant_notes** | **String** | | [optional]
21
30
  **order_id** | **String** | | [optional]
22
31
  **page_view_count** | **Integer** | | [optional]
23
32
  **page_views** | [**Array<ScreenRecordingPageView>**](ScreenRecordingPageView.md) | | [optional]
33
+ **preferred_language** | **String** | ISO 3 Letter language code that the customer would prefer | [optional]
34
+ **referrer_domain** | **String** | | [optional]
24
35
  **rrweb_version** | **String** | | [optional]
25
36
  **screen_recording_uuid** | **String** | | [optional]
26
37
  **signed_download_url** | **String** | | [optional]
@@ -34,6 +45,8 @@ Name | Type | Description | Notes
34
45
  **user_agent_raw** | **String** | | [optional]
35
46
  **user_ip** | **String** | | [optional]
36
47
  **user_properties** | [**Array<ScreenRecordingUserProperty>**](ScreenRecordingUserProperty.md) | | [optional]
48
+ **utm_campaign** | **String** | UTM Campaign | [optional]
49
+ **utm_source** | **String** | UTM Source | [optional]
37
50
  **visitor_first_seen** | **String** | Timestamp this visitor was first seen | [optional]
38
51
  **visitor_number** | **Integer** | | [optional]
39
52
  **watched** | **BOOLEAN** | | [optional]
@@ -0,0 +1,13 @@
1
+ # UltracartClient::ScreenRecordingAdPlatform
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **fbc** | **String** | Facebook Click Id (Cookie) | [optional]
7
+ **fbclid** | **String** | Facebook Click Id Parameter (Parameter) | [optional]
8
+ **fbp** | **String** | Facebook Browser Id (Cookie) | [optional]
9
+ **gacid** | **String** | Google Analytics CID (Cookie) | [optional]
10
+ **glcid** | **String** | Google Adwords Click Id (Parameter) | [optional]
11
+ **msclkid** | **String** | Bing Click Id (Parameter | [optional]
12
+
13
+
@@ -3,7 +3,13 @@
3
3
  ## Properties
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
+ **affiliate_email** | **String** | | [optional]
7
+ **affiliate_id** | **Integer** | | [optional]
8
+ **communications_campaign_name** | **String** | | [optional]
9
+ **communications_email_subject** | **String** | | [optional]
10
+ **communications_flow_name** | **String** | | [optional]
6
11
  **email** | [**ScreenRecordingFilterStringSearch**](ScreenRecordingFilterStringSearch.md) | | [optional]
12
+ **email_domain** | **String** | | [optional]
7
13
  **email_identified** | **BOOLEAN** | | [optional]
8
14
  **end_timestamp** | [**ScreenRecordingFilterRangeDate**](ScreenRecordingFilterRangeDate.md) | | [optional]
9
15
  **esp_customer_uuid** | **String** | | [optional]
@@ -11,11 +17,15 @@ Name | Type | Description | Notes
11
17
  **geolocation** | [**ScreenRecordingFilterGeoDistance**](ScreenRecordingFilterGeoDistance.md) | | [optional]
12
18
  **geolocation_country** | [**ScreenRecordingFilterStringSearch**](ScreenRecordingFilterStringSearch.md) | | [optional]
13
19
  **geolocation_state** | [**ScreenRecordingFilterStringSearch**](ScreenRecordingFilterStringSearch.md) | | [optional]
20
+ **language_iso_code** | [**ScreenRecordingFilterStringSearch**](ScreenRecordingFilterStringSearch.md) | | [optional]
21
+ **last_x_days** | **Integer** | | [optional]
14
22
  **max_filter_values** | **Integer** | | [optional]
15
23
  **order_id** | [**ScreenRecordingFilterStringSearch**](ScreenRecordingFilterStringSearch.md) | | [optional]
16
24
  **page_view_count** | [**ScreenRecordingFilterRangeInteger**](ScreenRecordingFilterRangeInteger.md) | | [optional]
17
25
  **page_views** | [**Array<ScreenRecordingFilterPageView>**](ScreenRecordingFilterPageView.md) | | [optional]
18
26
  **placed_order** | **BOOLEAN** | | [optional]
27
+ **preferred_language** | [**ScreenRecordingFilterStringSearch**](ScreenRecordingFilterStringSearch.md) | | [optional]
28
+ **referrer_domain** | **String** | | [optional]
19
29
  **screen_recording_uuids** | **Array<String>** | | [optional]
20
30
  **screen_sizes** | **Array<String>** | | [optional]
21
31
  **skip_filter_values** | **BOOLEAN** | | [optional]
@@ -29,6 +39,8 @@ Name | Type | Description | Notes
29
39
  **user_agent_os_name** | **String** | | [optional]
30
40
  **user_agent_os_version** | **String** | | [optional]
31
41
  **user_ip** | [**ScreenRecordingFilterIpSearch**](ScreenRecordingFilterIpSearch.md) | | [optional]
42
+ **utm_campaign** | **String** | | [optional]
43
+ **utm_source** | **String** | | [optional]
32
44
  **visitor_number** | **Integer** | | [optional]
33
45
  **watched** | **BOOLEAN** | | [optional]
34
46
 
@@ -3,6 +3,7 @@
3
3
  ## Properties
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
+ **domain** | [**ScreenRecordingFilterStringSearch**](ScreenRecordingFilterStringSearch.md) | | [optional]
6
7
  **events** | [**Array<ScreenRecordingFilterPageViewEvent>**](ScreenRecordingFilterPageViewEvent.md) | | [optional]
7
8
  **params** | [**Array<ScreenRecordingFilterPageViewParam>**](ScreenRecordingFilterPageViewParam.md) | | [optional]
8
9
  **referrer** | [**ScreenRecordingFilterStringSearch**](ScreenRecordingFilterStringSearch.md) | | [optional]
@@ -3,16 +3,26 @@
3
3
  ## Properties
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
- **events** | [**Array<ScreenRecordingFilterValuesEvent>**](ScreenRecordingFilterValuesEvent.md) | | [optional]
6
+ **communications_campaign_names** | **Array<String>** | | [optional]
7
+ **communications_email_subjects** | **Array<String>** | | [optional]
8
+ **communications_flow_names** | **Array<String>** | | [optional]
9
+ **email_domains** | **Array<String>** | | [optional]
7
10
  **geolocation_countries** | **Array<String>** | | [optional]
8
11
  **geolocation_states** | **Array<String>** | | [optional]
12
+ **language_iso_codes** | **Array<String>** | | [optional]
9
13
  **max_values** | **Integer** | | [optional]
10
- **page_params** | [**Array<ScreenRecordingFilterValuesPageParam>**](ScreenRecordingFilterValuesPageParam.md) | | [optional]
14
+ **page_views** | [**Array<ScreenRecordingFilterValuesPageView>**](ScreenRecordingFilterValuesPageView.md) | | [optional]
15
+ **preferred_languages** | **Array<String>** | | [optional]
16
+ **referrer_domains** | **Array<String>** | | [optional]
17
+ **time_on_site_max** | **Integer** | | [optional]
18
+ **time_on_site_min** | **Integer** | | [optional]
11
19
  **urls** | **Array<String>** | | [optional]
12
20
  **user_agent_device_names** | **Array<String>** | | [optional]
13
21
  **user_agent_device_os_names** | **Array<String>** | | [optional]
14
22
  **user_agent_device_os_versions** | **Array<String>** | | [optional]
15
23
  **user_agent_names** | **Array<String>** | | [optional]
16
24
  **user_agent_originals** | **Array<String>** | | [optional]
25
+ **utm_campaigns** | **Array<String>** | | [optional]
26
+ **utm_sources** | **Array<String>** | | [optional]
17
27
 
18
28
 
@@ -0,0 +1,13 @@
1
+ # UltracartClient::ScreenRecordingFilterValuesPageView
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **domains** | **Array<String>** | | [optional]
7
+ **events** | [**Array<ScreenRecordingFilterValuesEvent>**](ScreenRecordingFilterValuesEvent.md) | | [optional]
8
+ **page_params** | [**Array<ScreenRecordingFilterValuesPageParam>**](ScreenRecordingFilterValuesPageParam.md) | | [optional]
9
+ **time_on_page_max** | **Integer** | | [optional]
10
+ **time_on_page_min** | **Integer** | | [optional]
11
+ **urls** | **Array<String>** | | [optional]
12
+
13
+
@@ -0,0 +1,19 @@
1
+ # UltracartClient::ScreenRecordingHeatmap
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **large_click_url** | **String** | | [optional]
7
+ **large_movement_url** | **String** | | [optional]
8
+ **large_regular_url** | **String** | | [optional]
9
+ **large_scroll_url** | **String** | | [optional]
10
+ **medium_click_url** | **String** | | [optional]
11
+ **medium_movement_url** | **String** | | [optional]
12
+ **medium_regular_url** | **String** | | [optional]
13
+ **medium_scroll_url** | **String** | | [optional]
14
+ **small_click_url** | **String** | | [optional]
15
+ **small_movement_url** | **String** | | [optional]
16
+ **small_regular_url** | **String** | | [optional]
17
+ **small_scroll_url** | **String** | | [optional]
18
+
19
+
@@ -0,0 +1,12 @@
1
+ # UltracartClient::ScreenRecordingHeatmapIndexResponse
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **error** | [**Error**](Error.md) | | [optional]
7
+ **heatmap_urls** | [**Array<ScreenRecordingHeatmapUrl>**](ScreenRecordingHeatmapUrl.md) | | [optional]
8
+ **metadata** | [**ResponseMetadata**](ResponseMetadata.md) | | [optional]
9
+ **success** | **BOOLEAN** | Indicates if API call was successful | [optional]
10
+ **warning** | [**Warning**](Warning.md) | | [optional]
11
+
12
+
@@ -0,0 +1,9 @@
1
+ # UltracartClient::ScreenRecordingHeatmapRequest
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **range** | [**ScreenRecordingFilterRangeDate**](ScreenRecordingFilterRangeDate.md) | | [optional]
7
+ **url** | **String** | | [optional]
8
+
9
+
@@ -0,0 +1,8 @@
1
+ # UltracartClient::ScreenRecordingHeatmapReset
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **url** | **String** | | [optional]
7
+
8
+
@@ -0,0 +1,12 @@
1
+ # UltracartClient::ScreenRecordingHeatmapResponse
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **error** | [**Error**](Error.md) | | [optional]
7
+ **heatmap** | [**ScreenRecordingHeatmap**](ScreenRecordingHeatmap.md) | | [optional]
8
+ **metadata** | [**ResponseMetadata**](ResponseMetadata.md) | | [optional]
9
+ **success** | **BOOLEAN** | Indicates if API call was successful | [optional]
10
+ **warning** | [**Warning**](Warning.md) | | [optional]
11
+
12
+