ultracart_api 3.1.40 → 3.1.41
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +14 -4
- data/docs/OrderApi.md +1 -1
- data/docs/OrderSummary.md +1 -0
- data/docs/ScreenRecordingFilterPageView.md +1 -0
- data/docs/ScreenRecordingFilterValuesPageView.md +1 -0
- data/docs/ScreenRecordingHeatmap.md +19 -0
- data/docs/ScreenRecordingHeatmapIndexResponse.md +12 -0
- data/docs/ScreenRecordingHeatmapRequest.md +9 -0
- data/docs/ScreenRecordingHeatmapReset.md +8 -0
- data/docs/ScreenRecordingHeatmapResponse.md +12 -0
- data/docs/ScreenRecordingHeatmapUrl.md +12 -0
- data/docs/ScreenRecordingPageView.md +1 -0
- data/docs/StorefrontApi.md +158 -0
- data/lib/ultracart_api.rb +6 -0
- data/lib/ultracart_api/api/order_api.rb +2 -2
- data/lib/ultracart_api/api/storefront_api.rb +176 -0
- data/lib/ultracart_api/models/order_summary.rb +10 -1
- data/lib/ultracart_api/models/screen_recording_filter_page_view.rb +10 -1
- data/lib/ultracart_api/models/screen_recording_filter_values_page_view.rb +12 -1
- data/lib/ultracart_api/models/screen_recording_heatmap.rb +283 -0
- data/lib/ultracart_api/models/screen_recording_heatmap_index_response.rb +223 -0
- data/lib/ultracart_api/models/screen_recording_heatmap_request.rb +193 -0
- data/lib/ultracart_api/models/screen_recording_heatmap_reset.rb +184 -0
- data/lib/ultracart_api/models/screen_recording_heatmap_response.rb +221 -0
- data/lib/ultracart_api/models/screen_recording_heatmap_url.rb +222 -0
- data/lib/ultracart_api/models/screen_recording_page_view.rb +10 -1
- data/lib/ultracart_api/version.rb +1 -1
- metadata +14 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 748803f413463ae4065591e7feb19331b167d644f3b41246877fd777129bc14e
|
4
|
+
data.tar.gz: 45a56affd788578bc18b1038fd50bfe81f423a7a7928e7c69ca9f5134fc51e9d
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: c07af4bde282a2d562b5b0f7a7d015aed94aaa3f6eccecaf8285ce45b1fd022bc5918287e76e5988212831776a0aa1178ab22fc7820fcaf60532653e44923432
|
7
|
+
data.tar.gz: ca25b886fc27695d175c5093b91ebb9e752c285c950ca2000e1a0844eafe8151409809ae1b18fda6180cc47d4fec5789ff7bceb80a3360931dcf245ffd34e952
|
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.41
|
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.41.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.41.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.41'
|
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.
|
@@ -870,6 +873,12 @@ Class | Method | HTTP request | Description
|
|
870
873
|
- [UltracartClient::ScreenRecordingFilterValuesEventParams](docs/ScreenRecordingFilterValuesEventParams.md)
|
871
874
|
- [UltracartClient::ScreenRecordingFilterValuesPageParam](docs/ScreenRecordingFilterValuesPageParam.md)
|
872
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)
|
873
882
|
- [UltracartClient::ScreenRecordingMerchantNotesRequest](docs/ScreenRecordingMerchantNotesRequest.md)
|
874
883
|
- [UltracartClient::ScreenRecordingMultifield](docs/ScreenRecordingMultifield.md)
|
875
884
|
- [UltracartClient::ScreenRecordingPageView](docs/ScreenRecordingPageView.md)
|
@@ -1010,6 +1019,7 @@ Not every change is committed to every SDK.
|
|
1010
1019
|
|
1011
1020
|
| Version | Date | Comments |
|
1012
1021
|
| --: | :-: | --- |
|
1022
|
+
| 3.1.41 | 05/21/2021 | screen recording heatmap methods |
|
1013
1023
|
| 3.1.40 | 05/20/2021 | Order.summary.actual_payment_processing field added |
|
1014
1024
|
| 3.1.39 | 05/19/2021 | full deployment to ensure all language SDKs are up to date |
|
1015
1025
|
| 3.1.37 | 05/18/2021 | removed php sdk dependency on ext-mbstring by generating sdk with polyfill requirement. sdk is more portable now. |
|
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.
|
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
|
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,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,6 +3,7 @@
|
|
3
3
|
## Properties
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
|
+
**domains** | **Array<String>** | | [optional]
|
6
7
|
**events** | [**Array<ScreenRecordingFilterValuesEvent>**](ScreenRecordingFilterValuesEvent.md) | | [optional]
|
7
8
|
**page_params** | [**Array<ScreenRecordingFilterValuesPageParam>**](ScreenRecordingFilterValuesPageParam.md) | | [optional]
|
8
9
|
**time_on_page_max** | **Integer** | | [optional]
|
@@ -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,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
|
+
|
@@ -0,0 +1,12 @@
|
|
1
|
+
# UltracartClient::ScreenRecordingHeatmapUrl
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**histogram_data** | **Array<Integer>** | | [optional]
|
7
|
+
**histogram_interval** | **String** | | [optional]
|
8
|
+
**histogram_start_dts** | **String** | | [optional]
|
9
|
+
**session_count** | **Integer** | | [optional]
|
10
|
+
**url** | **String** | | [optional]
|
11
|
+
|
12
|
+
|
@@ -3,6 +3,7 @@
|
|
3
3
|
## Properties
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
|
+
**domain** | **String** | | [optional]
|
6
7
|
**events** | [**Array<ScreenRecordingPageViewEvent>**](ScreenRecordingPageViewEvent.md) | | [optional]
|
7
8
|
**first_event_timestamp** | **String** | First event timestamp | [optional]
|
8
9
|
**http_post** | **BOOLEAN** | | [optional]
|
data/docs/StorefrontApi.md
CHANGED
@@ -21,6 +21,7 @@ Method | HTTP request | Description
|
|
21
21
|
[**delete_email_postcard**](StorefrontApi.md#delete_email_postcard) | **DELETE** /storefront/{storefront_oid}/email/postcards/{commseq_postcard_uuid} | Delete email postcard
|
22
22
|
[**delete_email_sending_domain**](StorefrontApi.md#delete_email_sending_domain) | **DELETE** /storefront/email/sending_domains/{domain} | delete email campaign
|
23
23
|
[**delete_experiment**](StorefrontApi.md#delete_experiment) | **DELETE** /storefront/{storefront_oid}/experiments/{storefront_experiment_oid} | Delete experiment
|
24
|
+
[**delete_heatmap**](StorefrontApi.md#delete_heatmap) | **DELETE** /storefront/{storefront_oid}/screen_recordings/heatmap | Delete screen recording heatmap
|
24
25
|
[**delete_library_item**](StorefrontApi.md#delete_library_item) | **DELETE** /storefront/code_library/{library_item_oid} | Delete library item
|
25
26
|
[**delete_library_item_published_versions**](StorefrontApi.md#delete_library_item_published_versions) | **DELETE** /storefront/code_library/{library_item_oid}/published_versions | Delete all published versions for a library item, including anything in review.
|
26
27
|
[**delete_screen_recording_segment**](StorefrontApi.md#delete_screen_recording_segment) | **DELETE** /storefront/{storefront_oid}/screen_recordings/segments/{screen_recording_segment_oid} | Delete screen recording segment
|
@@ -80,6 +81,8 @@ Method | HTTP request | Description
|
|
80
81
|
[**get_email_templates**](StorefrontApi.md#get_email_templates) | **GET** /storefront/{storefront_oid}/email/templates | Get email templates
|
81
82
|
[**get_email_third_party_providers**](StorefrontApi.md#get_email_third_party_providers) | **GET** /storefront/{storefront_oid}/email/third_party_providers | Get a list of third party email providers
|
82
83
|
[**get_experiments**](StorefrontApi.md#get_experiments) | **GET** /storefront/{storefront_oid}/experiments | Get experiments
|
84
|
+
[**get_heatmap**](StorefrontApi.md#get_heatmap) | **POST** /storefront/{storefront_oid}/screen_recordings/heatmap | Get screen recording heatmap
|
85
|
+
[**get_heatmap_index**](StorefrontApi.md#get_heatmap_index) | **POST** /storefront/{storefront_oid}/screen_recordings/heatmap/index | Get screen recording heatmap index
|
83
86
|
[**get_histogram_property_names**](StorefrontApi.md#get_histogram_property_names) | **GET** /storefront/{storefront_oid}/email/histogram/property_names | Get histogram property names
|
84
87
|
[**get_histogram_property_values**](StorefrontApi.md#get_histogram_property_values) | **GET** /storefront/{storefront_oid}/email/histogram/property_values | Get histogram property values
|
85
88
|
[**get_library_filter_values**](StorefrontApi.md#get_library_filter_values) | **GET** /storefront/code_library/filter_values | Get library values used to populate drop down boxes for filtering.
|
@@ -1020,6 +1023,58 @@ nil (empty response body)
|
|
1020
1023
|
|
1021
1024
|
|
1022
1025
|
|
1026
|
+
# **delete_heatmap**
|
1027
|
+
> delete_heatmap(storefront_oid, query)
|
1028
|
+
|
1029
|
+
Delete screen recording heatmap
|
1030
|
+
|
1031
|
+
Delete screen recording heatmap
|
1032
|
+
|
1033
|
+
### Example
|
1034
|
+
```ruby
|
1035
|
+
# load the gem
|
1036
|
+
require 'ultracart_api'
|
1037
|
+
|
1038
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
1039
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
1040
|
+
api_instance = UltracartClient::StorefrontApi.new_using_api_key(simple_key, false, false)
|
1041
|
+
|
1042
|
+
|
1043
|
+
storefront_oid = 56 # Integer |
|
1044
|
+
|
1045
|
+
query = UltracartClient::ScreenRecordingHeatmapReset.new # ScreenRecordingHeatmapReset | Query
|
1046
|
+
|
1047
|
+
|
1048
|
+
begin
|
1049
|
+
#Delete screen recording heatmap
|
1050
|
+
api_instance.delete_heatmap(storefront_oid, query)
|
1051
|
+
rescue UltracartClient::ApiError => e
|
1052
|
+
puts "Exception when calling StorefrontApi->delete_heatmap: #{e}"
|
1053
|
+
end
|
1054
|
+
```
|
1055
|
+
|
1056
|
+
### Parameters
|
1057
|
+
|
1058
|
+
Name | Type | Description | Notes
|
1059
|
+
------------- | ------------- | ------------- | -------------
|
1060
|
+
**storefront_oid** | **Integer**| |
|
1061
|
+
**query** | [**ScreenRecordingHeatmapReset**](ScreenRecordingHeatmapReset.md)| Query |
|
1062
|
+
|
1063
|
+
### Return type
|
1064
|
+
|
1065
|
+
nil (empty response body)
|
1066
|
+
|
1067
|
+
### Authorization
|
1068
|
+
|
1069
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
1070
|
+
|
1071
|
+
### HTTP request headers
|
1072
|
+
|
1073
|
+
- **Content-Type**: application/json
|
1074
|
+
- **Accept**: application/json
|
1075
|
+
|
1076
|
+
|
1077
|
+
|
1023
1078
|
# **delete_library_item**
|
1024
1079
|
> delete_library_item(library_item_oid)
|
1025
1080
|
|
@@ -4010,6 +4065,109 @@ Name | Type | Description | Notes
|
|
4010
4065
|
|
4011
4066
|
|
4012
4067
|
|
4068
|
+
# **get_heatmap**
|
4069
|
+
> ScreenRecordingHeatmapResponse get_heatmap(storefront_oid, query)
|
4070
|
+
|
4071
|
+
Get screen recording heatmap
|
4072
|
+
|
4073
|
+
Get screen recording heatmap
|
4074
|
+
|
4075
|
+
### Example
|
4076
|
+
```ruby
|
4077
|
+
# load the gem
|
4078
|
+
require 'ultracart_api'
|
4079
|
+
|
4080
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
4081
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
4082
|
+
api_instance = UltracartClient::StorefrontApi.new_using_api_key(simple_key, false, false)
|
4083
|
+
|
4084
|
+
|
4085
|
+
storefront_oid = 56 # Integer |
|
4086
|
+
|
4087
|
+
query = UltracartClient::ScreenRecordingHeatmapRequest.new # ScreenRecordingHeatmapRequest | Query
|
4088
|
+
|
4089
|
+
|
4090
|
+
begin
|
4091
|
+
#Get screen recording heatmap
|
4092
|
+
result = api_instance.get_heatmap(storefront_oid, query)
|
4093
|
+
p result
|
4094
|
+
rescue UltracartClient::ApiError => e
|
4095
|
+
puts "Exception when calling StorefrontApi->get_heatmap: #{e}"
|
4096
|
+
end
|
4097
|
+
```
|
4098
|
+
|
4099
|
+
### Parameters
|
4100
|
+
|
4101
|
+
Name | Type | Description | Notes
|
4102
|
+
------------- | ------------- | ------------- | -------------
|
4103
|
+
**storefront_oid** | **Integer**| |
|
4104
|
+
**query** | [**ScreenRecordingHeatmapRequest**](ScreenRecordingHeatmapRequest.md)| Query |
|
4105
|
+
|
4106
|
+
### Return type
|
4107
|
+
|
4108
|
+
[**ScreenRecordingHeatmapResponse**](ScreenRecordingHeatmapResponse.md)
|
4109
|
+
|
4110
|
+
### Authorization
|
4111
|
+
|
4112
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
4113
|
+
|
4114
|
+
### HTTP request headers
|
4115
|
+
|
4116
|
+
- **Content-Type**: application/json
|
4117
|
+
- **Accept**: application/json
|
4118
|
+
|
4119
|
+
|
4120
|
+
|
4121
|
+
# **get_heatmap_index**
|
4122
|
+
> ScreenRecordingHeatmapIndexResponse get_heatmap_index(storefront_oid)
|
4123
|
+
|
4124
|
+
Get screen recording heatmap index
|
4125
|
+
|
4126
|
+
Get screen recording heatmap index
|
4127
|
+
|
4128
|
+
### Example
|
4129
|
+
```ruby
|
4130
|
+
# load the gem
|
4131
|
+
require 'ultracart_api'
|
4132
|
+
|
4133
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
4134
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
4135
|
+
api_instance = UltracartClient::StorefrontApi.new_using_api_key(simple_key, false, false)
|
4136
|
+
|
4137
|
+
|
4138
|
+
storefront_oid = 56 # Integer |
|
4139
|
+
|
4140
|
+
|
4141
|
+
begin
|
4142
|
+
#Get screen recording heatmap index
|
4143
|
+
result = api_instance.get_heatmap_index(storefront_oid)
|
4144
|
+
p result
|
4145
|
+
rescue UltracartClient::ApiError => e
|
4146
|
+
puts "Exception when calling StorefrontApi->get_heatmap_index: #{e}"
|
4147
|
+
end
|
4148
|
+
```
|
4149
|
+
|
4150
|
+
### Parameters
|
4151
|
+
|
4152
|
+
Name | Type | Description | Notes
|
4153
|
+
------------- | ------------- | ------------- | -------------
|
4154
|
+
**storefront_oid** | **Integer**| |
|
4155
|
+
|
4156
|
+
### Return type
|
4157
|
+
|
4158
|
+
[**ScreenRecordingHeatmapIndexResponse**](ScreenRecordingHeatmapIndexResponse.md)
|
4159
|
+
|
4160
|
+
### Authorization
|
4161
|
+
|
4162
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
4163
|
+
|
4164
|
+
### HTTP request headers
|
4165
|
+
|
4166
|
+
- **Content-Type**: application/json
|
4167
|
+
- **Accept**: application/json
|
4168
|
+
|
4169
|
+
|
4170
|
+
|
4013
4171
|
# **get_histogram_property_names**
|
4014
4172
|
> EmailHistogramPropertyNamesResponse get_histogram_property_names(storefront_oid, opts)
|
4015
4173
|
|
data/lib/ultracart_api.rb
CHANGED
@@ -504,6 +504,12 @@ require 'ultracart_api/models/screen_recording_filter_values_event'
|
|
504
504
|
require 'ultracart_api/models/screen_recording_filter_values_event_params'
|
505
505
|
require 'ultracart_api/models/screen_recording_filter_values_page_param'
|
506
506
|
require 'ultracart_api/models/screen_recording_filter_values_page_view'
|
507
|
+
require 'ultracart_api/models/screen_recording_heatmap'
|
508
|
+
require 'ultracart_api/models/screen_recording_heatmap_index_response'
|
509
|
+
require 'ultracart_api/models/screen_recording_heatmap_request'
|
510
|
+
require 'ultracart_api/models/screen_recording_heatmap_reset'
|
511
|
+
require 'ultracart_api/models/screen_recording_heatmap_response'
|
512
|
+
require 'ultracart_api/models/screen_recording_heatmap_url'
|
507
513
|
require 'ultracart_api/models/screen_recording_merchant_notes_request'
|
508
514
|
require 'ultracart_api/models/screen_recording_multifield'
|
509
515
|
require 'ultracart_api/models/screen_recording_page_view'
|
@@ -33,7 +33,7 @@ module UltracartClient
|
|
33
33
|
end
|
34
34
|
|
35
35
|
# Adjusts an order total
|
36
|
-
# Adjusts an order total. Adjusts individual items appropriately and considers taxes. Desired total should be provided in the same currency as the order.
|
36
|
+
# 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.
|
37
37
|
# @param order_id The order id to cancel.
|
38
38
|
# @param desired_total The desired total with no formatting. example 123.45
|
39
39
|
# @param [Hash] opts the optional parameters
|
@@ -44,7 +44,7 @@ module UltracartClient
|
|
44
44
|
end
|
45
45
|
|
46
46
|
# Adjusts an order total
|
47
|
-
# Adjusts an order total. Adjusts individual items appropriately and considers taxes. Desired total should be provided in the same currency as the order.
|
47
|
+
# 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.
|
48
48
|
# @param order_id The order id to cancel.
|
49
49
|
# @param desired_total The desired total with no formatting. example 123.45
|
50
50
|
# @param [Hash] opts the optional parameters
|
@@ -1033,6 +1033,66 @@ module UltracartClient
|
|
1033
1033
|
end
|
1034
1034
|
return data, status_code, headers
|
1035
1035
|
end
|
1036
|
+
# Delete screen recording heatmap
|
1037
|
+
# Delete screen recording heatmap
|
1038
|
+
# @param storefront_oid
|
1039
|
+
# @param query Query
|
1040
|
+
# @param [Hash] opts the optional parameters
|
1041
|
+
# @return [nil]
|
1042
|
+
def delete_heatmap(storefront_oid, query, opts = {})
|
1043
|
+
delete_heatmap_with_http_info(storefront_oid, query, opts)
|
1044
|
+
nil
|
1045
|
+
end
|
1046
|
+
|
1047
|
+
# Delete screen recording heatmap
|
1048
|
+
# Delete screen recording heatmap
|
1049
|
+
# @param storefront_oid
|
1050
|
+
# @param query Query
|
1051
|
+
# @param [Hash] opts the optional parameters
|
1052
|
+
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
1053
|
+
def delete_heatmap_with_http_info(storefront_oid, query, opts = {})
|
1054
|
+
if @api_client.config.debugging
|
1055
|
+
@api_client.config.logger.debug 'Calling API: StorefrontApi.delete_heatmap ...'
|
1056
|
+
end
|
1057
|
+
# verify the required parameter 'storefront_oid' is set
|
1058
|
+
if @api_client.config.client_side_validation && storefront_oid.nil?
|
1059
|
+
fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling StorefrontApi.delete_heatmap"
|
1060
|
+
end
|
1061
|
+
# verify the required parameter 'query' is set
|
1062
|
+
if @api_client.config.client_side_validation && query.nil?
|
1063
|
+
fail ArgumentError, "Missing the required parameter 'query' when calling StorefrontApi.delete_heatmap"
|
1064
|
+
end
|
1065
|
+
# resource path
|
1066
|
+
local_var_path = '/storefront/{storefront_oid}/screen_recordings/heatmap'.sub('{' + 'storefront_oid' + '}', storefront_oid.to_s)
|
1067
|
+
|
1068
|
+
# query parameters
|
1069
|
+
query_params = {}
|
1070
|
+
|
1071
|
+
# header parameters
|
1072
|
+
header_params = {}
|
1073
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
1074
|
+
# HTTP header 'Accept' (if needed)
|
1075
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1076
|
+
# HTTP header 'Content-Type'
|
1077
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
1078
|
+
|
1079
|
+
# form parameters
|
1080
|
+
form_params = {}
|
1081
|
+
|
1082
|
+
# http body (model)
|
1083
|
+
post_body = @api_client.object_to_http_body(query)
|
1084
|
+
auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
1085
|
+
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
|
1086
|
+
:header_params => header_params,
|
1087
|
+
:query_params => query_params,
|
1088
|
+
:form_params => form_params,
|
1089
|
+
:body => post_body,
|
1090
|
+
:auth_names => auth_names)
|
1091
|
+
if @api_client.config.debugging
|
1092
|
+
@api_client.config.logger.debug "API called: StorefrontApi#delete_heatmap\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1093
|
+
end
|
1094
|
+
return data, status_code, headers
|
1095
|
+
end
|
1036
1096
|
# Delete library item
|
1037
1097
|
# @param library_item_oid
|
1038
1098
|
# @param [Hash] opts the optional parameters
|
@@ -4438,6 +4498,122 @@ module UltracartClient
|
|
4438
4498
|
end
|
4439
4499
|
return data, status_code, headers
|
4440
4500
|
end
|
4501
|
+
# Get screen recording heatmap
|
4502
|
+
# Get screen recording heatmap
|
4503
|
+
# @param storefront_oid
|
4504
|
+
# @param query Query
|
4505
|
+
# @param [Hash] opts the optional parameters
|
4506
|
+
# @return [ScreenRecordingHeatmapResponse]
|
4507
|
+
def get_heatmap(storefront_oid, query, opts = {})
|
4508
|
+
data, _status_code, _headers = get_heatmap_with_http_info(storefront_oid, query, opts)
|
4509
|
+
data
|
4510
|
+
end
|
4511
|
+
|
4512
|
+
# Get screen recording heatmap
|
4513
|
+
# Get screen recording heatmap
|
4514
|
+
# @param storefront_oid
|
4515
|
+
# @param query Query
|
4516
|
+
# @param [Hash] opts the optional parameters
|
4517
|
+
# @return [Array<(ScreenRecordingHeatmapResponse, Fixnum, Hash)>] ScreenRecordingHeatmapResponse data, response status code and response headers
|
4518
|
+
def get_heatmap_with_http_info(storefront_oid, query, opts = {})
|
4519
|
+
if @api_client.config.debugging
|
4520
|
+
@api_client.config.logger.debug 'Calling API: StorefrontApi.get_heatmap ...'
|
4521
|
+
end
|
4522
|
+
# verify the required parameter 'storefront_oid' is set
|
4523
|
+
if @api_client.config.client_side_validation && storefront_oid.nil?
|
4524
|
+
fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling StorefrontApi.get_heatmap"
|
4525
|
+
end
|
4526
|
+
# verify the required parameter 'query' is set
|
4527
|
+
if @api_client.config.client_side_validation && query.nil?
|
4528
|
+
fail ArgumentError, "Missing the required parameter 'query' when calling StorefrontApi.get_heatmap"
|
4529
|
+
end
|
4530
|
+
# resource path
|
4531
|
+
local_var_path = '/storefront/{storefront_oid}/screen_recordings/heatmap'.sub('{' + 'storefront_oid' + '}', storefront_oid.to_s)
|
4532
|
+
|
4533
|
+
# query parameters
|
4534
|
+
query_params = {}
|
4535
|
+
|
4536
|
+
# header parameters
|
4537
|
+
header_params = {}
|
4538
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
4539
|
+
# HTTP header 'Accept' (if needed)
|
4540
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
4541
|
+
# HTTP header 'Content-Type'
|
4542
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
4543
|
+
|
4544
|
+
# form parameters
|
4545
|
+
form_params = {}
|
4546
|
+
|
4547
|
+
# http body (model)
|
4548
|
+
post_body = @api_client.object_to_http_body(query)
|
4549
|
+
auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
4550
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
4551
|
+
:header_params => header_params,
|
4552
|
+
:query_params => query_params,
|
4553
|
+
:form_params => form_params,
|
4554
|
+
:body => post_body,
|
4555
|
+
:auth_names => auth_names,
|
4556
|
+
:return_type => 'ScreenRecordingHeatmapResponse')
|
4557
|
+
if @api_client.config.debugging
|
4558
|
+
@api_client.config.logger.debug "API called: StorefrontApi#get_heatmap\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
4559
|
+
end
|
4560
|
+
return data, status_code, headers
|
4561
|
+
end
|
4562
|
+
# Get screen recording heatmap index
|
4563
|
+
# Get screen recording heatmap index
|
4564
|
+
# @param storefront_oid
|
4565
|
+
# @param [Hash] opts the optional parameters
|
4566
|
+
# @return [ScreenRecordingHeatmapIndexResponse]
|
4567
|
+
def get_heatmap_index(storefront_oid, opts = {})
|
4568
|
+
data, _status_code, _headers = get_heatmap_index_with_http_info(storefront_oid, opts)
|
4569
|
+
data
|
4570
|
+
end
|
4571
|
+
|
4572
|
+
# Get screen recording heatmap index
|
4573
|
+
# Get screen recording heatmap index
|
4574
|
+
# @param storefront_oid
|
4575
|
+
# @param [Hash] opts the optional parameters
|
4576
|
+
# @return [Array<(ScreenRecordingHeatmapIndexResponse, Fixnum, Hash)>] ScreenRecordingHeatmapIndexResponse data, response status code and response headers
|
4577
|
+
def get_heatmap_index_with_http_info(storefront_oid, opts = {})
|
4578
|
+
if @api_client.config.debugging
|
4579
|
+
@api_client.config.logger.debug 'Calling API: StorefrontApi.get_heatmap_index ...'
|
4580
|
+
end
|
4581
|
+
# verify the required parameter 'storefront_oid' is set
|
4582
|
+
if @api_client.config.client_side_validation && storefront_oid.nil?
|
4583
|
+
fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling StorefrontApi.get_heatmap_index"
|
4584
|
+
end
|
4585
|
+
# resource path
|
4586
|
+
local_var_path = '/storefront/{storefront_oid}/screen_recordings/heatmap/index'.sub('{' + 'storefront_oid' + '}', storefront_oid.to_s)
|
4587
|
+
|
4588
|
+
# query parameters
|
4589
|
+
query_params = {}
|
4590
|
+
|
4591
|
+
# header parameters
|
4592
|
+
header_params = {}
|
4593
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
4594
|
+
# HTTP header 'Accept' (if needed)
|
4595
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
4596
|
+
# HTTP header 'Content-Type'
|
4597
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
4598
|
+
|
4599
|
+
# form parameters
|
4600
|
+
form_params = {}
|
4601
|
+
|
4602
|
+
# http body (model)
|
4603
|
+
post_body = nil
|
4604
|
+
auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
4605
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
4606
|
+
:header_params => header_params,
|
4607
|
+
:query_params => query_params,
|
4608
|
+
:form_params => form_params,
|
4609
|
+
:body => post_body,
|
4610
|
+
:auth_names => auth_names,
|
4611
|
+
:return_type => 'ScreenRecordingHeatmapIndexResponse')
|
4612
|
+
if @api_client.config.debugging
|
4613
|
+
@api_client.config.logger.debug "API called: StorefrontApi#get_heatmap_index\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
4614
|
+
end
|
4615
|
+
return data, status_code, headers
|
4616
|
+
end
|
4441
4617
|
# Get histogram property names
|
4442
4618
|
# Obtain a list of property names for a given property type
|
4443
4619
|
# @param storefront_oid
|