ultracart_api 3.1.15 → 3.1.39
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +26 -4
- data/docs/Coupon.md +1 -0
- data/docs/CouponPercentOffMsrpItems.md +11 -0
- data/docs/CustomerLoyalty.md +1 -0
- data/docs/EmailCampaign.md +2 -1
- data/docs/EmailFlow.md +2 -1
- data/docs/LibraryItemAttribute.md +0 -1
- data/docs/OrderApi.md +4 -0
- data/docs/OrderProcessPaymentRequest.md +1 -0
- data/docs/OrderQuery.md +3 -1
- data/docs/ScreenRecording.md +13 -0
- data/docs/ScreenRecordingAdPlatform.md +13 -0
- data/docs/ScreenRecordingFilter.md +12 -0
- data/docs/ScreenRecordingFilterValues.md +12 -1
- data/docs/ScreenRecordingFilterValuesPageParam.md +9 -0
- data/docs/ScreenRecordingFilterValuesPageView.md +12 -0
- data/docs/ScreenRecordingPageView.md +2 -0
- data/docs/ScreenRecordingPageViewEvent.md +1 -0
- data/docs/ScreenRecordingQueryResponse.md +3 -0
- data/docs/ScreenRecordingSegment.md +3 -0
- data/docs/ScreenRecordingSettings.md +5 -0
- data/docs/TaxJarConfig.md +1 -0
- data/lib/ultracart_api.rb +4 -0
- data/lib/ultracart_api/api/order_api.rb +6 -0
- data/lib/ultracart_api/models/coupon.rb +10 -1
- data/lib/ultracart_api/models/coupon_percent_off_msrp_items.rb +219 -0
- data/lib/ultracart_api/models/customer_loyalty.rb +11 -1
- data/lib/ultracart_api/models/email_campaign.rb +12 -2
- data/lib/ultracart_api/models/email_flow.rb +12 -2
- data/lib/ultracart_api/models/library_item_attribute.rb +1 -10
- data/lib/ultracart_api/models/order_process_payment_request.rb +11 -1
- data/lib/ultracart_api/models/order_query.rb +22 -2
- data/lib/ultracart_api/models/screen_recording.rb +128 -1
- data/lib/ultracart_api/models/screen_recording_ad_platform.rb +235 -0
- data/lib/ultracart_api/models/screen_recording_filter.rb +109 -1
- data/lib/ultracart_api/models/screen_recording_filter_values.rb +128 -11
- data/lib/ultracart_api/models/screen_recording_filter_values_page_param.rb +195 -0
- data/lib/ultracart_api/models/screen_recording_filter_values_page_view.rb +226 -0
- data/lib/ultracart_api/models/screen_recording_page_view.rb +21 -1
- data/lib/ultracart_api/models/screen_recording_page_view_event.rb +10 -1
- data/lib/ultracart_api/models/screen_recording_query_response.rb +30 -1
- data/lib/ultracart_api/models/screen_recording_segment.rb +30 -1
- data/lib/ultracart_api/models/screen_recording_settings.rb +49 -4
- data/lib/ultracart_api/models/tax_jar_config.rb +11 -1
- data/lib/ultracart_api/version.rb +1 -1
- metadata +10 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 9735697d7aab57448da701353265f282d10c6ce4ccb88234845d3e2487515576
|
4
|
+
data.tar.gz: 37c49a26bb20fcd094a25a1c5b1799eaeaafe8f4ce612a726fc28dde4284d7eb
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 1dbdaac522165f7636524a8201bed5e289e270888a80e573f9e69d566b9a80405f811881faaaa4ad9af77eb8e662fde58c80386878c488d59ecc431579743c4a
|
7
|
+
data.tar.gz: fc1a27b1c5a4e53319221d9a11b2dde41051bf5d7a5c703e70e12923c254e28459fa0b9a7156a2ade9481594a63dfe00d6484452bba38a854eb85a2f1675347a
|
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.
|
10
|
+
- Package version: 3.1.39
|
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.
|
27
|
+
gem install ./ultracart_api-3.1.39.gem
|
28
28
|
```
|
29
|
-
(for development, run `gem install --dev ./ultracart_api-3.1.
|
29
|
+
(for development, run `gem install --dev ./ultracart_api-3.1.39.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.
|
35
|
+
gem 'ultracart_api', '~> 3.1.39'
|
36
36
|
|
37
37
|
### Install from Git
|
38
38
|
|
@@ -522,6 +522,7 @@ Class | Method | HTTP request | Description
|
|
522
522
|
- [UltracartClient::CouponPercentOffItems](docs/CouponPercentOffItems.md)
|
523
523
|
- [UltracartClient::CouponPercentOffItemsAndFreeShipping](docs/CouponPercentOffItemsAndFreeShipping.md)
|
524
524
|
- [UltracartClient::CouponPercentOffItemsWithItemsPurchase](docs/CouponPercentOffItemsWithItemsPurchase.md)
|
525
|
+
- [UltracartClient::CouponPercentOffMsrpItems](docs/CouponPercentOffMsrpItems.md)
|
525
526
|
- [UltracartClient::CouponPercentOffRetailPriceItems](docs/CouponPercentOffRetailPriceItems.md)
|
526
527
|
- [UltracartClient::CouponPercentOffShipping](docs/CouponPercentOffShipping.md)
|
527
528
|
- [UltracartClient::CouponPercentOffSubtotal](docs/CouponPercentOffSubtotal.md)
|
@@ -851,6 +852,7 @@ Class | Method | HTTP request | Description
|
|
851
852
|
- [UltracartClient::ResponseMetadata](docs/ResponseMetadata.md)
|
852
853
|
- [UltracartClient::ResultSet](docs/ResultSet.md)
|
853
854
|
- [UltracartClient::ScreenRecording](docs/ScreenRecording.md)
|
855
|
+
- [UltracartClient::ScreenRecordingAdPlatform](docs/ScreenRecordingAdPlatform.md)
|
854
856
|
- [UltracartClient::ScreenRecordingFilter](docs/ScreenRecordingFilter.md)
|
855
857
|
- [UltracartClient::ScreenRecordingFilterGeoDistance](docs/ScreenRecordingFilterGeoDistance.md)
|
856
858
|
- [UltracartClient::ScreenRecordingFilterIpSearch](docs/ScreenRecordingFilterIpSearch.md)
|
@@ -866,6 +868,8 @@ Class | Method | HTTP request | Description
|
|
866
868
|
- [UltracartClient::ScreenRecordingFilterValues](docs/ScreenRecordingFilterValues.md)
|
867
869
|
- [UltracartClient::ScreenRecordingFilterValuesEvent](docs/ScreenRecordingFilterValuesEvent.md)
|
868
870
|
- [UltracartClient::ScreenRecordingFilterValuesEventParams](docs/ScreenRecordingFilterValuesEventParams.md)
|
871
|
+
- [UltracartClient::ScreenRecordingFilterValuesPageParam](docs/ScreenRecordingFilterValuesPageParam.md)
|
872
|
+
- [UltracartClient::ScreenRecordingFilterValuesPageView](docs/ScreenRecordingFilterValuesPageView.md)
|
869
873
|
- [UltracartClient::ScreenRecordingMerchantNotesRequest](docs/ScreenRecordingMerchantNotesRequest.md)
|
870
874
|
- [UltracartClient::ScreenRecordingMultifield](docs/ScreenRecordingMultifield.md)
|
871
875
|
- [UltracartClient::ScreenRecordingPageView](docs/ScreenRecordingPageView.md)
|
@@ -1006,6 +1010,24 @@ Not every change is committed to every SDK.
|
|
1006
1010
|
|
1007
1011
|
| Version | Date | Comments |
|
1008
1012
|
| --: | :-: | --- |
|
1013
|
+
| 3.1.39 | 05/19/2021 | full deployment to ensure all language SDKs are up to date |
|
1014
|
+
| 3.1.37 | 05/18/2021 | removed php sdk dependency on ext-mbstring by generating sdk with polyfill requirement. sdk is more portable now. |
|
1015
|
+
| 3.1.35 | 05/14/2021 | screen recording histogram data |
|
1016
|
+
| 3.1.34 | 05/12/2021 | screen recording preferred language, last x days filter, referrer domain |
|
1017
|
+
| 3.1.33 | 05/11/2021 | creen recording filter for affiliate id and email |
|
1018
|
+
| 3.1.32 | 05/06/2021 | customer profile pending loyalty points |
|
1019
|
+
| 3.1.31 | 05/06/2021 | Added email domian field to screen recordings for filtering |
|
1020
|
+
| 3.1.30 | 04/27/2021 | OrderApi.processPayment now allows a specific amount to be billed |
|
1021
|
+
| 3.1.29 | 04/26/2021 | screen recording language iso code |
|
1022
|
+
| 3.1.28 | 04/26/2021 | screen recording statistics on the setting object |
|
1023
|
+
| 3.1.27 | 04/20/2021 | bug fix - annotation misspell on new email campaign property |
|
1024
|
+
| 3.1.26 | 04/20/2021 | StoreFront Connumications - flag to end campaign or flow once purchase happens anywhere |
|
1025
|
+
| 3.1.25 | 04/19/2021 | Screen recording UTM campaign and source fields |
|
1026
|
+
| 3.1.24 | 04/16/2021 | Screen recording aggregations on communications campaign/flows |
|
1027
|
+
| 3.1.22 | 04/09/2021 | Move URL filter values into page level view for screen recordings |
|
1028
|
+
| 3.1.18 | 03/17/2021 | Added order query by ship on date |
|
1029
|
+
| 3.1.17 | 03/17/2021 | New coupon - percent off MSRP item |
|
1030
|
+
| 3.1.16 | 03/16/2021 | screen recording filter page parameter names |
|
1009
1031
|
| 3.1.15 | 03/15/2021 | fix response from deleteScreenRecordingSegment that should have been void |
|
1010
1032
|
| 3.1.14 | 03/15/2021 | sort screen recordings by favorite flag |
|
1011
1033
|
| 3.1.13 | 03/02/2021 | new webhook order_payment_failed |
|
data/docs/Coupon.md
CHANGED
@@ -41,6 +41,7 @@ Name | Type | Description | Notes
|
|
41
41
|
**percent_off_items** | [**CouponPercentOffItems**](CouponPercentOffItems.md) | | [optional]
|
42
42
|
**percent_off_items_and_free_shipping** | [**CouponPercentOffItemsAndFreeShipping**](CouponPercentOffItemsAndFreeShipping.md) | | [optional]
|
43
43
|
**percent_off_items_with_items_purchase** | [**CouponPercentOffItemsWithItemsPurchase**](CouponPercentOffItemsWithItemsPurchase.md) | | [optional]
|
44
|
+
**percent_off_msrp_items** | [**CouponPercentOffMsrpItems**](CouponPercentOffMsrpItems.md) | | [optional]
|
44
45
|
**percent_off_retail_price_items** | [**CouponPercentOffRetailPriceItems**](CouponPercentOffRetailPriceItems.md) | | [optional]
|
45
46
|
**percent_off_shipping** | [**CouponPercentOffShipping**](CouponPercentOffShipping.md) | | [optional]
|
46
47
|
**percent_off_subtotal** | [**CouponPercentOffSubtotal**](CouponPercentOffSubtotal.md) | | [optional]
|
@@ -0,0 +1,11 @@
|
|
1
|
+
# UltracartClient::CouponPercentOffMsrpItems
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**discount_percent** | **Float** | The percentage of subtotal discount | [optional]
|
7
|
+
**excluded_items** | **Array<String>** | A list of items which cannot be discounted. | [optional]
|
8
|
+
**items** | **Array<String>** | An list of items which will receive a discount. | [optional]
|
9
|
+
**limit** | **Integer** | The (optional) maximum quantity of discounted items. | [optional]
|
10
|
+
|
11
|
+
|
data/docs/CustomerLoyalty.md
CHANGED
@@ -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
|
|
data/docs/EmailCampaign.md
CHANGED
@@ -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]
|
data/docs/OrderApi.md
CHANGED
@@ -542,6 +542,8 @@ opts = {
|
|
542
542
|
custom_field_5: 'custom_field_5_example', # String |
|
543
543
|
custom_field_6: 'custom_field_6_example', # String |
|
544
544
|
custom_field_7: 'custom_field_7_example', # String |
|
545
|
+
ship_on_date_begin: 'ship_on_date_begin_example', # String |
|
546
|
+
ship_on_date_end: 'ship_on_date_end_example', # String |
|
545
547
|
_limit: 100, # Integer | The maximum number of records to return on this one API call. (Maximum 200)
|
546
548
|
_offset: 0, # Integer | Pagination of the record set. Offset is a zero based index.
|
547
549
|
_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
|
|
598
600
|
**custom_field_5** | **String**| | [optional]
|
599
601
|
**custom_field_6** | **String**| | [optional]
|
600
602
|
**custom_field_7** | **String**| | [optional]
|
603
|
+
**ship_on_date_begin** | **String**| | [optional]
|
604
|
+
**ship_on_date_end** | **String**| | [optional]
|
601
605
|
**_limit** | **Integer**| The maximum number of records to return on this one API call. (Maximum 200) | [optional] [default to 100]
|
602
606
|
**_offset** | **Integer**| Pagination of the record set. Offset is a zero based index. | [optional] [default to 0]
|
603
607
|
**_sort** | **String**| The sort order of the orders. See Sorting documentation for examples of using multiple values and sorting by ascending and descending. | [optional]
|
@@ -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/OrderQuery.md
CHANGED
@@ -35,8 +35,10 @@ Name | Type | Description | Notes
|
|
35
35
|
**refund_date_end** | **String** | Date/time that the order was refunded | [optional]
|
36
36
|
**rma** | **String** | RMA number | [optional]
|
37
37
|
**screen_branding_theme_code** | **String** | Screen branding theme code associated with the order (legacy checkout) | [optional]
|
38
|
-
**shipment_date_begin** | **String** | Date/time that the order was
|
38
|
+
**shipment_date_begin** | **String** | Date/time that the order was shipped | [optional]
|
39
39
|
**shipment_date_end** | **String** | Date/time that the order was shipped | [optional]
|
40
|
+
**shipped_on_date_begin** | **String** | Date/time that the order should ship on | [optional]
|
41
|
+
**shipped_on_date_end** | **String** | Date/time that the order should ship on | [optional]
|
40
42
|
**state_region** | **String** | State for United States otherwise region or province for other countries | [optional]
|
41
43
|
**storefront_host_name** | **String** | StoreFront host name associated with the order | [optional]
|
42
44
|
**total** | **Float** | Total | [optional]
|
data/docs/ScreenRecording.md
CHANGED
@@ -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,15 +3,26 @@
|
|
3
3
|
## Properties
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
|
-
**
|
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]
|
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]
|
10
19
|
**urls** | **Array<String>** | | [optional]
|
11
20
|
**user_agent_device_names** | **Array<String>** | | [optional]
|
12
21
|
**user_agent_device_os_names** | **Array<String>** | | [optional]
|
13
22
|
**user_agent_device_os_versions** | **Array<String>** | | [optional]
|
14
23
|
**user_agent_names** | **Array<String>** | | [optional]
|
15
24
|
**user_agent_originals** | **Array<String>** | | [optional]
|
25
|
+
**utm_campaigns** | **Array<String>** | | [optional]
|
26
|
+
**utm_sources** | **Array<String>** | | [optional]
|
16
27
|
|
17
28
|
|
@@ -0,0 +1,9 @@
|
|
1
|
+
# UltracartClient::ScreenRecordingFilterValuesPageParam
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**name** | **String** | | [optional]
|
7
|
+
**values** | **Array<String>** | | [optional]
|
8
|
+
|
9
|
+
|
@@ -0,0 +1,12 @@
|
|
1
|
+
# UltracartClient::ScreenRecordingFilterValuesPageView
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**events** | [**Array<ScreenRecordingFilterValuesEvent>**](ScreenRecordingFilterValuesEvent.md) | | [optional]
|
7
|
+
**page_params** | [**Array<ScreenRecordingFilterValuesPageParam>**](ScreenRecordingFilterValuesPageParam.md) | | [optional]
|
8
|
+
**time_on_page_max** | **Integer** | | [optional]
|
9
|
+
**time_on_page_min** | **Integer** | | [optional]
|
10
|
+
**urls** | **Array<String>** | | [optional]
|
11
|
+
|
12
|
+
|
@@ -16,6 +16,8 @@ Name | Type | Description | Notes
|
|
16
16
|
**referrer_raw** | **String** | | [optional]
|
17
17
|
**screen_recording_page_view_uuid** | **String** | | [optional]
|
18
18
|
**time_on_page** | **Integer** | | [optional]
|
19
|
+
**timing_dom_content_loaded** | **Integer** | Amount of time for DOMContentLoaded event to fire (milliseconds) | [optional]
|
20
|
+
**timing_loaded** | **Integer** | Amount of time for loaded event to fire (milliseconds) | [optional]
|
19
21
|
**truncated_events** | **BOOLEAN** | | [optional]
|
20
22
|
**ucapv** | **String** | | [optional]
|
21
23
|
**url** | **String** | | [optional]
|
@@ -5,6 +5,7 @@ Name | Type | Description | Notes
|
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
6
|
**name** | **String** | | [optional]
|
7
7
|
**params** | [**Array<ScreenRecordingPageViewEventParameter>**](ScreenRecordingPageViewEventParameter.md) | | [optional]
|
8
|
+
**prior_page_view** | **BOOLEAN** | | [optional]
|
8
9
|
**timestamp** | **String** | Timestamp of the event | [optional]
|
9
10
|
**ts** | **Integer** | | [optional]
|
10
11
|
|
@@ -6,6 +6,9 @@ Name | Type | Description | Notes
|
|
6
6
|
**error** | [**Error**](Error.md) | | [optional]
|
7
7
|
**filter** | [**ScreenRecordingFilter**](ScreenRecordingFilter.md) | | [optional]
|
8
8
|
**filter_values** | [**ScreenRecordingFilterValues**](ScreenRecordingFilterValues.md) | | [optional]
|
9
|
+
**histogram_data** | **Array<Integer>** | | [optional]
|
10
|
+
**histogram_interval** | **String** | | [optional]
|
11
|
+
**histogram_start_dts** | **String** | | [optional]
|
9
12
|
**metadata** | [**ResponseMetadata**](ResponseMetadata.md) | | [optional]
|
10
13
|
**screen_recordings** | [**Array<ScreenRecording>**](ScreenRecording.md) | | [optional]
|
11
14
|
**success** | **BOOLEAN** | Indicates if API call was successful | [optional]
|
@@ -6,6 +6,9 @@ Name | Type | Description | Notes
|
|
6
6
|
**create_dts** | **String** | | [optional]
|
7
7
|
**description** | **String** | | [optional]
|
8
8
|
**filter** | [**ScreenRecordingFilter**](ScreenRecordingFilter.md) | | [optional]
|
9
|
+
**histogram_data** | **Array<Integer>** | | [optional]
|
10
|
+
**histogram_interval** | **String** | | [optional]
|
11
|
+
**histogram_start_dts** | **String** | | [optional]
|
9
12
|
**name** | **String** | | [optional]
|
10
13
|
**screen_recording_segment_oid** | **Integer** | | [optional]
|
11
14
|
**session_count** | **Integer** | | [optional]
|
@@ -4,5 +4,10 @@
|
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
6
|
**enabled** | **BOOLEAN** | | [optional]
|
7
|
+
**sessions_current_billing_period** | **Integer** | | [optional]
|
8
|
+
**sessions_last_billing_period** | **Integer** | | [optional]
|
9
|
+
**sessions_trial_billing_period** | **Integer** | | [optional]
|
10
|
+
**trial_expiration** | **String** | | [optional]
|
11
|
+
**trial_expired** | **BOOLEAN** | | [optional]
|
7
12
|
|
8
13
|
|
data/docs/TaxJarConfig.md
CHANGED
@@ -8,6 +8,7 @@ Name | Type | Description | Notes
|
|
8
8
|
**estimate_only** | **BOOLEAN** | True if this TaxJar configuration is to estimate taxes only and not report placed orders to TaxJar | [optional]
|
9
9
|
**send_outside_nexus** | **BOOLEAN** | Send orders outside your nexus TaxJar. The default is to not transmit outside orders to TaxJar to reduce API calls. However, this will prevent TaxJar from dynamically creating new Nexus when thresholds are exceeded for a state. | [optional]
|
10
10
|
**send_test_orders** | **BOOLEAN** | Send test orders through to TaxJar. The default is to not transmit test orders to TaxJar. | [optional]
|
11
|
+
**skip_channel_orders** | **BOOLEAN** | Do not send channel partner orders to TaxJar. Set this to true if your channel partner reports tax on their own. | [optional]
|
11
12
|
**use_distribution_center_from** | **BOOLEAN** | Use distribution center from address | [optional]
|
12
13
|
|
13
14
|
|
data/lib/ultracart_api.rb
CHANGED
@@ -156,6 +156,7 @@ require 'ultracart_api/models/coupon_percent_off_item_with_items_quantity_purcha
|
|
156
156
|
require 'ultracart_api/models/coupon_percent_off_items'
|
157
157
|
require 'ultracart_api/models/coupon_percent_off_items_and_free_shipping'
|
158
158
|
require 'ultracart_api/models/coupon_percent_off_items_with_items_purchase'
|
159
|
+
require 'ultracart_api/models/coupon_percent_off_msrp_items'
|
159
160
|
require 'ultracart_api/models/coupon_percent_off_retail_price_items'
|
160
161
|
require 'ultracart_api/models/coupon_percent_off_shipping'
|
161
162
|
require 'ultracart_api/models/coupon_percent_off_subtotal'
|
@@ -485,6 +486,7 @@ require 'ultracart_api/models/register_affiliate_click_response'
|
|
485
486
|
require 'ultracart_api/models/response_metadata'
|
486
487
|
require 'ultracart_api/models/result_set'
|
487
488
|
require 'ultracart_api/models/screen_recording'
|
489
|
+
require 'ultracart_api/models/screen_recording_ad_platform'
|
488
490
|
require 'ultracart_api/models/screen_recording_filter'
|
489
491
|
require 'ultracart_api/models/screen_recording_filter_geo_distance'
|
490
492
|
require 'ultracart_api/models/screen_recording_filter_ip_search'
|
@@ -500,6 +502,8 @@ require 'ultracart_api/models/screen_recording_filter_string_search'
|
|
500
502
|
require 'ultracart_api/models/screen_recording_filter_values'
|
501
503
|
require 'ultracart_api/models/screen_recording_filter_values_event'
|
502
504
|
require 'ultracart_api/models/screen_recording_filter_values_event_params'
|
505
|
+
require 'ultracart_api/models/screen_recording_filter_values_page_param'
|
506
|
+
require 'ultracart_api/models/screen_recording_filter_values_page_view'
|
503
507
|
require 'ultracart_api/models/screen_recording_merchant_notes_request'
|
504
508
|
require 'ultracart_api/models/screen_recording_multifield'
|
505
509
|
require 'ultracart_api/models/screen_recording_page_view'
|
@@ -578,6 +578,8 @@ module UltracartClient
|
|
578
578
|
# @option opts [String] :custom_field_5
|
579
579
|
# @option opts [String] :custom_field_6
|
580
580
|
# @option opts [String] :custom_field_7
|
581
|
+
# @option opts [String] :ship_on_date_begin
|
582
|
+
# @option opts [String] :ship_on_date_end
|
581
583
|
# @option opts [Integer] :_limit The maximum number of records to return on this one API call. (Maximum 200) (default to 100)
|
582
584
|
# @option opts [Integer] :_offset Pagination of the record set. Offset is a zero based index. (default to 0)
|
583
585
|
# @option opts [String] :_sort The sort order of the orders. See Sorting documentation for examples of using multiple values and sorting by ascending and descending.
|
@@ -628,6 +630,8 @@ module UltracartClient
|
|
628
630
|
# @option opts [String] :custom_field_5
|
629
631
|
# @option opts [String] :custom_field_6
|
630
632
|
# @option opts [String] :custom_field_7
|
633
|
+
# @option opts [String] :ship_on_date_begin
|
634
|
+
# @option opts [String] :ship_on_date_end
|
631
635
|
# @option opts [Integer] :_limit The maximum number of records to return on this one API call. (Maximum 200)
|
632
636
|
# @option opts [Integer] :_offset Pagination of the record set. Offset is a zero based index.
|
633
637
|
# @option opts [String] :_sort The sort order of the orders. See Sorting documentation for examples of using multiple values and sorting by ascending and descending.
|
@@ -679,6 +683,8 @@ module UltracartClient
|
|
679
683
|
query_params[:'Custom Field 5'] = opts[:'custom_field_5'] if !opts[:'custom_field_5'].nil?
|
680
684
|
query_params[:'Custom Field 6'] = opts[:'custom_field_6'] if !opts[:'custom_field_6'].nil?
|
681
685
|
query_params[:'Custom Field 7'] = opts[:'custom_field_7'] if !opts[:'custom_field_7'].nil?
|
686
|
+
query_params[:'ship_on_date_begin'] = opts[:'ship_on_date_begin'] if !opts[:'ship_on_date_begin'].nil?
|
687
|
+
query_params[:'ship_on_date_end'] = opts[:'ship_on_date_end'] if !opts[:'ship_on_date_end'].nil?
|
682
688
|
query_params[:'_limit'] = opts[:'_limit'] if !opts[:'_limit'].nil?
|
683
689
|
query_params[:'_offset'] = opts[:'_offset'] if !opts[:'_offset'].nil?
|
684
690
|
query_params[:'_sort'] = opts[:'_sort'] if !opts[:'_sort'].nil?
|