ultracart_api 3.1.9 → 3.1.14
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +11 -4
- data/docs/CouponApi.md +2 -2
- data/docs/EmailCommseqEmail.md +1 -0
- data/docs/OrderApi.md +14 -0
- data/docs/OrderQuery.md +7 -0
- data/docs/ScreenRecording.md +3 -0
- data/docs/ScreenRecordingFilter.md +1 -0
- data/docs/ScreenRecordingMerchantNotesRequest.md +8 -0
- data/docs/StorefrontApi.md +56 -0
- data/lib/ultracart_api.rb +1 -0
- data/lib/ultracart_api/api/coupon_api.rb +2 -2
- data/lib/ultracart_api/api/order_api.rb +21 -0
- data/lib/ultracart_api/api/storefront_api.rb +66 -0
- data/lib/ultracart_api/models/email_commseq_email.rb +11 -1
- data/lib/ultracart_api/models/order_query.rb +71 -1
- data/lib/ultracart_api/models/screen_recording.rb +29 -1
- data/lib/ultracart_api/models/screen_recording_filter.rb +10 -1
- data/lib/ultracart_api/models/screen_recording_merchant_notes_request.rb +184 -0
- data/lib/ultracart_api/version.rb +1 -1
- metadata +4 -2
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: ef1b046aadb89beed9acf48ad09a4d2d7e7acbcd233cb98f5786cb66a842e009
|
|
4
|
+
data.tar.gz: b96255c07ae2ba530ac1861e5facb5a16e4e99c3847411aa01c0954ae25df59d
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: eba5db20276ecc1f01fc965a04629f9aa54e632c6fa88860da89429652783b5d949bb5eed6c2156d629d3b1a9224277461bb0c9105c2939820b8f8493b728eea
|
|
7
|
+
data.tar.gz: 5b569aa51718fd3f9c1af6d86c3955dd4478919f784f0d689b71fa7e1abc554627c8a68c2d1a2e94a8b0ad4073e43071b13b19cfd06c13895f6a13766b21c2c7
|
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.14
|
|
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.14.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.14.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.14'
|
|
36
36
|
|
|
37
37
|
### Install from Git
|
|
38
38
|
|
|
@@ -327,6 +327,7 @@ Class | Method | HTTP request | Description
|
|
|
327
327
|
*UltracartClient::StorefrontApi* | [**update_email_settings**](docs/StorefrontApi.md#update_email_settings) | **POST** /storefront/{storefront_oid}/email/settings | Update email settings
|
|
328
328
|
*UltracartClient::StorefrontApi* | [**update_experiment**](docs/StorefrontApi.md#update_experiment) | **PUT** /storefront/{storefront_oid}/experiments/{storefront_experiment_oid} | Update experiment
|
|
329
329
|
*UltracartClient::StorefrontApi* | [**update_library_item**](docs/StorefrontApi.md#update_library_item) | **PUT** /storefront/code_library/{library_item_oid} | Update library item. Note that only certain fields may be updated via this method.
|
|
330
|
+
*UltracartClient::StorefrontApi* | [**update_screen_recording_merchant_notes**](docs/StorefrontApi.md#update_screen_recording_merchant_notes) | **POST** /storefront/{storefront_oid}/screen_recordings/{screen_recording_uuid}/merchant_notes | Update merchant notes on a screen recording
|
|
330
331
|
*UltracartClient::StorefrontApi* | [**update_screen_recording_segment**](docs/StorefrontApi.md#update_screen_recording_segment) | **POST** /storefront/{storefront_oid}/screen_recordings/segments/{screen_recording_segment_oid} | Update screen recording segment
|
|
331
332
|
*UltracartClient::StorefrontApi* | [**update_screen_recording_settings**](docs/StorefrontApi.md#update_screen_recording_settings) | **POST** /storefront/{storefront_oid}/screen_recordings/settings | Update screen recording settings
|
|
332
333
|
*UltracartClient::StorefrontApi* | [**update_screen_recording_tags**](docs/StorefrontApi.md#update_screen_recording_tags) | **POST** /storefront/{storefront_oid}/screen_recordings/{screen_recording_uuid}/tags | Update tags on a screen recording
|
|
@@ -865,6 +866,7 @@ Class | Method | HTTP request | Description
|
|
|
865
866
|
- [UltracartClient::ScreenRecordingFilterValues](docs/ScreenRecordingFilterValues.md)
|
|
866
867
|
- [UltracartClient::ScreenRecordingFilterValuesEvent](docs/ScreenRecordingFilterValuesEvent.md)
|
|
867
868
|
- [UltracartClient::ScreenRecordingFilterValuesEventParams](docs/ScreenRecordingFilterValuesEventParams.md)
|
|
869
|
+
- [UltracartClient::ScreenRecordingMerchantNotesRequest](docs/ScreenRecordingMerchantNotesRequest.md)
|
|
868
870
|
- [UltracartClient::ScreenRecordingMultifield](docs/ScreenRecordingMultifield.md)
|
|
869
871
|
- [UltracartClient::ScreenRecordingPageView](docs/ScreenRecordingPageView.md)
|
|
870
872
|
- [UltracartClient::ScreenRecordingPageViewDataResponse](docs/ScreenRecordingPageViewDataResponse.md)
|
|
@@ -1004,6 +1006,11 @@ Not every change is committed to every SDK.
|
|
|
1004
1006
|
|
|
1005
1007
|
| Version | Date | Comments |
|
|
1006
1008
|
| --: | :-: | --- |
|
|
1009
|
+
| 3.1.14 | 03/15/2021 | sort screen recordings by favorite flag |
|
|
1010
|
+
| 3.1.13 | 03/02/2021 | new webhook order_payment_failed |
|
|
1011
|
+
| 3.1.12 | 02/25/2021 | added screen recording visitor_first_seen property |
|
|
1012
|
+
| 3.1.11 | 02/24/2021 | Added Screen recording visitor number |
|
|
1013
|
+
| 3.1.10 | 02/24/2021 | Added Screen recording merchant notes |
|
|
1007
1014
|
| 3.1.9 | 02/24/2021 | Allow coupons to be configured as unique with expiration on cart step within StoreFront Communications |
|
|
1008
1015
|
| 3.1.8 | 02/24/2021 | Add flag: screen recording missing event boolean |
|
|
1009
1016
|
| 3.1.5 | 02/12/2021 | Bug Fix: PHP retry logic missing a closing brace. Also screen recording page view data response refactor |
|
data/docs/CouponApi.md
CHANGED
|
@@ -732,7 +732,7 @@ simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
|
|
732
732
|
api_instance = UltracartClient::CouponApi.new_using_api_key(simple_key, false, false)
|
|
733
733
|
|
|
734
734
|
|
|
735
|
-
coupons_request = UltracartClient::CouponsRequest.new # CouponsRequest | Coupons to insert (maximum
|
|
735
|
+
coupons_request = UltracartClient::CouponsRequest.new # CouponsRequest | Coupons to insert (maximum 50)
|
|
736
736
|
|
|
737
737
|
opts = {
|
|
738
738
|
_expand: '_expand_example', # String | The object expansion to perform on the result. See documentation for examples
|
|
@@ -752,7 +752,7 @@ end
|
|
|
752
752
|
|
|
753
753
|
Name | Type | Description | Notes
|
|
754
754
|
------------- | ------------- | ------------- | -------------
|
|
755
|
-
**coupons_request** | [**CouponsRequest**](CouponsRequest.md)| Coupons to insert (maximum
|
|
755
|
+
**coupons_request** | [**CouponsRequest**](CouponsRequest.md)| Coupons to insert (maximum 50) |
|
|
756
756
|
**_expand** | **String**| The object expansion to perform on the result. See documentation for examples | [optional]
|
|
757
757
|
**_placeholders** | **BOOLEAN**| Whether or not placeholder values should be returned in the result. Useful for UIs that consume this REST API. | [optional]
|
|
758
758
|
|
data/docs/EmailCommseqEmail.md
CHANGED
|
@@ -25,6 +25,7 @@ Name | Type | Description | Notes
|
|
|
25
25
|
**smart_sending** | **BOOLEAN** | Smart sending | [optional]
|
|
26
26
|
**storefront_oid** | **Integer** | Storefront oid | [optional]
|
|
27
27
|
**subject** | **String** | Subject | [optional]
|
|
28
|
+
**suspended_for_spam** | **BOOLEAN** | True if the email was suspended for too high of a spam rate. | [optional]
|
|
28
29
|
**transactional_email** | **BOOLEAN** | Transactional email | [optional]
|
|
29
30
|
**version** | **Integer** | Version | [optional]
|
|
30
31
|
|
data/docs/OrderApi.md
CHANGED
|
@@ -535,6 +535,13 @@ opts = {
|
|
|
535
535
|
customer_profile_oid: 56, # Integer |
|
|
536
536
|
refund_date_begin: 'refund_date_begin_example', # String |
|
|
537
537
|
refund_date_end: 'refund_date_end_example', # String |
|
|
538
|
+
custom_field_1: 'custom_field_1_example', # String |
|
|
539
|
+
custom_field_2: 'custom_field_2_example', # String |
|
|
540
|
+
custom_field_3: 'custom_field_3_example', # String |
|
|
541
|
+
custom_field_4: 'custom_field_4_example', # String |
|
|
542
|
+
custom_field_5: 'custom_field_5_example', # String |
|
|
543
|
+
custom_field_6: 'custom_field_6_example', # String |
|
|
544
|
+
custom_field_7: 'custom_field_7_example', # String |
|
|
538
545
|
_limit: 100, # Integer | The maximum number of records to return on this one API call. (Maximum 200)
|
|
539
546
|
_offset: 0, # Integer | Pagination of the record set. Offset is a zero based index.
|
|
540
547
|
_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.
|
|
@@ -584,6 +591,13 @@ Name | Type | Description | Notes
|
|
|
584
591
|
**customer_profile_oid** | **Integer**| | [optional]
|
|
585
592
|
**refund_date_begin** | **String**| | [optional]
|
|
586
593
|
**refund_date_end** | **String**| | [optional]
|
|
594
|
+
**custom_field_1** | **String**| | [optional]
|
|
595
|
+
**custom_field_2** | **String**| | [optional]
|
|
596
|
+
**custom_field_3** | **String**| | [optional]
|
|
597
|
+
**custom_field_4** | **String**| | [optional]
|
|
598
|
+
**custom_field_5** | **String**| | [optional]
|
|
599
|
+
**custom_field_6** | **String**| | [optional]
|
|
600
|
+
**custom_field_7** | **String**| | [optional]
|
|
587
601
|
**_limit** | **Integer**| The maximum number of records to return on this one API call. (Maximum 200) | [optional] [default to 100]
|
|
588
602
|
**_offset** | **Integer**| Pagination of the record set. Offset is a zero based index. | [optional] [default to 0]
|
|
589
603
|
**_sort** | **String**| The sort order of the orders. See Sorting documentation for examples of using multiple values and sorting by ascending and descending. | [optional]
|
data/docs/OrderQuery.md
CHANGED
|
@@ -12,6 +12,13 @@ Name | Type | Description | Notes
|
|
|
12
12
|
**creation_date_begin** | **String** | Date/time that the order was created | [optional]
|
|
13
13
|
**creation_date_end** | **String** | Date/time that the order was created | [optional]
|
|
14
14
|
**current_stage** | **String** | Current stage that the order is in. | [optional]
|
|
15
|
+
**custom_field_1** | **String** | Custom field 1 | [optional]
|
|
16
|
+
**custom_field_2** | **String** | Custom field 2 | [optional]
|
|
17
|
+
**custom_field_3** | **String** | Custom field 3 | [optional]
|
|
18
|
+
**custom_field_4** | **String** | Custom field 4 | [optional]
|
|
19
|
+
**custom_field_5** | **String** | Custom field 5 | [optional]
|
|
20
|
+
**custom_field_6** | **String** | Custom field 6 | [optional]
|
|
21
|
+
**custom_field_7** | **String** | Custom field 7 | [optional]
|
|
15
22
|
**customer_profile_oid** | **Integer** | The customer profile to find associated orders for | [optional]
|
|
16
23
|
**email** | **String** | Email | [optional]
|
|
17
24
|
**first_name** | **String** | First name | [optional]
|
data/docs/ScreenRecording.md
CHANGED
|
@@ -17,6 +17,7 @@ Name | Type | Description | Notes
|
|
|
17
17
|
**geolocation_country** | **String** | | [optional]
|
|
18
18
|
**geolocation_state** | **String** | | [optional]
|
|
19
19
|
**merchant_id** | **String** | | [optional]
|
|
20
|
+
**merchant_notes** | **String** | | [optional]
|
|
20
21
|
**order_id** | **String** | | [optional]
|
|
21
22
|
**page_view_count** | **Integer** | | [optional]
|
|
22
23
|
**page_views** | [**Array<ScreenRecordingPageView>**](ScreenRecordingPageView.md) | | [optional]
|
|
@@ -33,6 +34,8 @@ Name | Type | Description | Notes
|
|
|
33
34
|
**user_agent_raw** | **String** | | [optional]
|
|
34
35
|
**user_ip** | **String** | | [optional]
|
|
35
36
|
**user_properties** | [**Array<ScreenRecordingUserProperty>**](ScreenRecordingUserProperty.md) | | [optional]
|
|
37
|
+
**visitor_first_seen** | **String** | Timestamp this visitor was first seen | [optional]
|
|
38
|
+
**visitor_number** | **Integer** | | [optional]
|
|
36
39
|
**watched** | **BOOLEAN** | | [optional]
|
|
37
40
|
**window_height** | **Integer** | | [optional]
|
|
38
41
|
**window_width** | **Integer** | | [optional]
|
|
@@ -29,6 +29,7 @@ Name | Type | Description | Notes
|
|
|
29
29
|
**user_agent_os_name** | **String** | | [optional]
|
|
30
30
|
**user_agent_os_version** | **String** | | [optional]
|
|
31
31
|
**user_ip** | [**ScreenRecordingFilterIpSearch**](ScreenRecordingFilterIpSearch.md) | | [optional]
|
|
32
|
+
**visitor_number** | **Integer** | | [optional]
|
|
32
33
|
**watched** | **BOOLEAN** | | [optional]
|
|
33
34
|
|
|
34
35
|
|
data/docs/StorefrontApi.md
CHANGED
|
@@ -143,6 +143,7 @@ Method | HTTP request | Description
|
|
|
143
143
|
[**update_email_settings**](StorefrontApi.md#update_email_settings) | **POST** /storefront/{storefront_oid}/email/settings | Update email settings
|
|
144
144
|
[**update_experiment**](StorefrontApi.md#update_experiment) | **PUT** /storefront/{storefront_oid}/experiments/{storefront_experiment_oid} | Update experiment
|
|
145
145
|
[**update_library_item**](StorefrontApi.md#update_library_item) | **PUT** /storefront/code_library/{library_item_oid} | Update library item. Note that only certain fields may be updated via this method.
|
|
146
|
+
[**update_screen_recording_merchant_notes**](StorefrontApi.md#update_screen_recording_merchant_notes) | **POST** /storefront/{storefront_oid}/screen_recordings/{screen_recording_uuid}/merchant_notes | Update merchant notes on a screen recording
|
|
146
147
|
[**update_screen_recording_segment**](StorefrontApi.md#update_screen_recording_segment) | **POST** /storefront/{storefront_oid}/screen_recordings/segments/{screen_recording_segment_oid} | Update screen recording segment
|
|
147
148
|
[**update_screen_recording_settings**](StorefrontApi.md#update_screen_recording_settings) | **POST** /storefront/{storefront_oid}/screen_recordings/settings | Update screen recording settings
|
|
148
149
|
[**update_screen_recording_tags**](StorefrontApi.md#update_screen_recording_tags) | **POST** /storefront/{storefront_oid}/screen_recordings/{screen_recording_uuid}/tags | Update tags on a screen recording
|
|
@@ -7320,6 +7321,61 @@ Name | Type | Description | Notes
|
|
|
7320
7321
|
|
|
7321
7322
|
|
|
7322
7323
|
|
|
7324
|
+
# **update_screen_recording_merchant_notes**
|
|
7325
|
+
> update_screen_recording_merchant_notes(storefront_oid, screen_recording_uuid, merchant_notes_request)
|
|
7326
|
+
|
|
7327
|
+
Update merchant notes on a screen recording
|
|
7328
|
+
|
|
7329
|
+
Update merchant notes on a screen recording
|
|
7330
|
+
|
|
7331
|
+
### Example
|
|
7332
|
+
```ruby
|
|
7333
|
+
# load the gem
|
|
7334
|
+
require 'ultracart_api'
|
|
7335
|
+
|
|
7336
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
|
7337
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
|
7338
|
+
api_instance = UltracartClient::StorefrontApi.new_using_api_key(simple_key, false, false)
|
|
7339
|
+
|
|
7340
|
+
|
|
7341
|
+
storefront_oid = 56 # Integer |
|
|
7342
|
+
|
|
7343
|
+
screen_recording_uuid = 'screen_recording_uuid_example' # String |
|
|
7344
|
+
|
|
7345
|
+
merchant_notes_request = UltracartClient::ScreenRecordingMerchantNotesRequest.new # ScreenRecordingMerchantNotesRequest | Merchant Notes
|
|
7346
|
+
|
|
7347
|
+
|
|
7348
|
+
begin
|
|
7349
|
+
#Update merchant notes on a screen recording
|
|
7350
|
+
api_instance.update_screen_recording_merchant_notes(storefront_oid, screen_recording_uuid, merchant_notes_request)
|
|
7351
|
+
rescue UltracartClient::ApiError => e
|
|
7352
|
+
puts "Exception when calling StorefrontApi->update_screen_recording_merchant_notes: #{e}"
|
|
7353
|
+
end
|
|
7354
|
+
```
|
|
7355
|
+
|
|
7356
|
+
### Parameters
|
|
7357
|
+
|
|
7358
|
+
Name | Type | Description | Notes
|
|
7359
|
+
------------- | ------------- | ------------- | -------------
|
|
7360
|
+
**storefront_oid** | **Integer**| |
|
|
7361
|
+
**screen_recording_uuid** | **String**| |
|
|
7362
|
+
**merchant_notes_request** | [**ScreenRecordingMerchantNotesRequest**](ScreenRecordingMerchantNotesRequest.md)| Merchant Notes |
|
|
7363
|
+
|
|
7364
|
+
### Return type
|
|
7365
|
+
|
|
7366
|
+
nil (empty response body)
|
|
7367
|
+
|
|
7368
|
+
### Authorization
|
|
7369
|
+
|
|
7370
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
7371
|
+
|
|
7372
|
+
### HTTP request headers
|
|
7373
|
+
|
|
7374
|
+
- **Content-Type**: application/json
|
|
7375
|
+
- **Accept**: application/json
|
|
7376
|
+
|
|
7377
|
+
|
|
7378
|
+
|
|
7323
7379
|
# **update_screen_recording_segment**
|
|
7324
7380
|
> ScreenRecordingSegmentResponse update_screen_recording_segment(storefront_oid, screen_recording_segment_oid, segment)
|
|
7325
7381
|
|
data/lib/ultracart_api.rb
CHANGED
|
@@ -500,6 +500,7 @@ require 'ultracart_api/models/screen_recording_filter_string_search'
|
|
|
500
500
|
require 'ultracart_api/models/screen_recording_filter_values'
|
|
501
501
|
require 'ultracart_api/models/screen_recording_filter_values_event'
|
|
502
502
|
require 'ultracart_api/models/screen_recording_filter_values_event_params'
|
|
503
|
+
require 'ultracart_api/models/screen_recording_merchant_notes_request'
|
|
503
504
|
require 'ultracart_api/models/screen_recording_multifield'
|
|
504
505
|
require 'ultracart_api/models/screen_recording_page_view'
|
|
505
506
|
require 'ultracart_api/models/screen_recording_page_view_data_response'
|
|
@@ -800,7 +800,7 @@ module UltracartClient
|
|
|
800
800
|
end
|
|
801
801
|
# Insert multiple coupons
|
|
802
802
|
# Insert multiple coupon on the UltraCart account.
|
|
803
|
-
# @param coupons_request Coupons to insert (maximum
|
|
803
|
+
# @param coupons_request Coupons to insert (maximum 50)
|
|
804
804
|
# @param [Hash] opts the optional parameters
|
|
805
805
|
# @option opts [String] :_expand The object expansion to perform on the result. See documentation for examples
|
|
806
806
|
# @option opts [BOOLEAN] :_placeholders Whether or not placeholder values should be returned in the result. Useful for UIs that consume this REST API.
|
|
@@ -812,7 +812,7 @@ module UltracartClient
|
|
|
812
812
|
|
|
813
813
|
# Insert multiple coupons
|
|
814
814
|
# Insert multiple coupon on the UltraCart account.
|
|
815
|
-
# @param coupons_request Coupons to insert (maximum
|
|
815
|
+
# @param coupons_request Coupons to insert (maximum 50)
|
|
816
816
|
# @param [Hash] opts the optional parameters
|
|
817
817
|
# @option opts [String] :_expand The object expansion to perform on the result. See documentation for examples
|
|
818
818
|
# @option opts [BOOLEAN] :_placeholders Whether or not placeholder values should be returned in the result. Useful for UIs that consume this REST API.
|
|
@@ -571,6 +571,13 @@ module UltracartClient
|
|
|
571
571
|
# @option opts [Integer] :customer_profile_oid
|
|
572
572
|
# @option opts [String] :refund_date_begin
|
|
573
573
|
# @option opts [String] :refund_date_end
|
|
574
|
+
# @option opts [String] :custom_field_1
|
|
575
|
+
# @option opts [String] :custom_field_2
|
|
576
|
+
# @option opts [String] :custom_field_3
|
|
577
|
+
# @option opts [String] :custom_field_4
|
|
578
|
+
# @option opts [String] :custom_field_5
|
|
579
|
+
# @option opts [String] :custom_field_6
|
|
580
|
+
# @option opts [String] :custom_field_7
|
|
574
581
|
# @option opts [Integer] :_limit The maximum number of records to return on this one API call. (Maximum 200) (default to 100)
|
|
575
582
|
# @option opts [Integer] :_offset Pagination of the record set. Offset is a zero based index. (default to 0)
|
|
576
583
|
# @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.
|
|
@@ -614,6 +621,13 @@ module UltracartClient
|
|
|
614
621
|
# @option opts [Integer] :customer_profile_oid
|
|
615
622
|
# @option opts [String] :refund_date_begin
|
|
616
623
|
# @option opts [String] :refund_date_end
|
|
624
|
+
# @option opts [String] :custom_field_1
|
|
625
|
+
# @option opts [String] :custom_field_2
|
|
626
|
+
# @option opts [String] :custom_field_3
|
|
627
|
+
# @option opts [String] :custom_field_4
|
|
628
|
+
# @option opts [String] :custom_field_5
|
|
629
|
+
# @option opts [String] :custom_field_6
|
|
630
|
+
# @option opts [String] :custom_field_7
|
|
617
631
|
# @option opts [Integer] :_limit The maximum number of records to return on this one API call. (Maximum 200)
|
|
618
632
|
# @option opts [Integer] :_offset Pagination of the record set. Offset is a zero based index.
|
|
619
633
|
# @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.
|
|
@@ -658,6 +672,13 @@ module UltracartClient
|
|
|
658
672
|
query_params[:'customer_profile_oid'] = opts[:'customer_profile_oid'] if !opts[:'customer_profile_oid'].nil?
|
|
659
673
|
query_params[:'Refund Date Begin'] = opts[:'refund_date_begin'] if !opts[:'refund_date_begin'].nil?
|
|
660
674
|
query_params[:'Refund Date End'] = opts[:'refund_date_end'] if !opts[:'refund_date_end'].nil?
|
|
675
|
+
query_params[:'Custom Field 1'] = opts[:'custom_field_1'] if !opts[:'custom_field_1'].nil?
|
|
676
|
+
query_params[:'Custom Field 2'] = opts[:'custom_field_2'] if !opts[:'custom_field_2'].nil?
|
|
677
|
+
query_params[:'Custom Field 3'] = opts[:'custom_field_3'] if !opts[:'custom_field_3'].nil?
|
|
678
|
+
query_params[:'Custom Field 4'] = opts[:'custom_field_4'] if !opts[:'custom_field_4'].nil?
|
|
679
|
+
query_params[:'Custom Field 5'] = opts[:'custom_field_5'] if !opts[:'custom_field_5'].nil?
|
|
680
|
+
query_params[:'Custom Field 6'] = opts[:'custom_field_6'] if !opts[:'custom_field_6'].nil?
|
|
681
|
+
query_params[:'Custom Field 7'] = opts[:'custom_field_7'] if !opts[:'custom_field_7'].nil?
|
|
661
682
|
query_params[:'_limit'] = opts[:'_limit'] if !opts[:'_limit'].nil?
|
|
662
683
|
query_params[:'_offset'] = opts[:'_offset'] if !opts[:'_offset'].nil?
|
|
663
684
|
query_params[:'_sort'] = opts[:'_sort'] if !opts[:'_sort'].nil?
|
|
@@ -8245,6 +8245,72 @@ module UltracartClient
|
|
|
8245
8245
|
end
|
|
8246
8246
|
return data, status_code, headers
|
|
8247
8247
|
end
|
|
8248
|
+
# Update merchant notes on a screen recording
|
|
8249
|
+
# Update merchant notes on a screen recording
|
|
8250
|
+
# @param storefront_oid
|
|
8251
|
+
# @param screen_recording_uuid
|
|
8252
|
+
# @param merchant_notes_request Merchant Notes
|
|
8253
|
+
# @param [Hash] opts the optional parameters
|
|
8254
|
+
# @return [nil]
|
|
8255
|
+
def update_screen_recording_merchant_notes(storefront_oid, screen_recording_uuid, merchant_notes_request, opts = {})
|
|
8256
|
+
update_screen_recording_merchant_notes_with_http_info(storefront_oid, screen_recording_uuid, merchant_notes_request, opts)
|
|
8257
|
+
nil
|
|
8258
|
+
end
|
|
8259
|
+
|
|
8260
|
+
# Update merchant notes on a screen recording
|
|
8261
|
+
# Update merchant notes on a screen recording
|
|
8262
|
+
# @param storefront_oid
|
|
8263
|
+
# @param screen_recording_uuid
|
|
8264
|
+
# @param merchant_notes_request Merchant Notes
|
|
8265
|
+
# @param [Hash] opts the optional parameters
|
|
8266
|
+
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
|
8267
|
+
def update_screen_recording_merchant_notes_with_http_info(storefront_oid, screen_recording_uuid, merchant_notes_request, opts = {})
|
|
8268
|
+
if @api_client.config.debugging
|
|
8269
|
+
@api_client.config.logger.debug 'Calling API: StorefrontApi.update_screen_recording_merchant_notes ...'
|
|
8270
|
+
end
|
|
8271
|
+
# verify the required parameter 'storefront_oid' is set
|
|
8272
|
+
if @api_client.config.client_side_validation && storefront_oid.nil?
|
|
8273
|
+
fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling StorefrontApi.update_screen_recording_merchant_notes"
|
|
8274
|
+
end
|
|
8275
|
+
# verify the required parameter 'screen_recording_uuid' is set
|
|
8276
|
+
if @api_client.config.client_side_validation && screen_recording_uuid.nil?
|
|
8277
|
+
fail ArgumentError, "Missing the required parameter 'screen_recording_uuid' when calling StorefrontApi.update_screen_recording_merchant_notes"
|
|
8278
|
+
end
|
|
8279
|
+
# verify the required parameter 'merchant_notes_request' is set
|
|
8280
|
+
if @api_client.config.client_side_validation && merchant_notes_request.nil?
|
|
8281
|
+
fail ArgumentError, "Missing the required parameter 'merchant_notes_request' when calling StorefrontApi.update_screen_recording_merchant_notes"
|
|
8282
|
+
end
|
|
8283
|
+
# resource path
|
|
8284
|
+
local_var_path = '/storefront/{storefront_oid}/screen_recordings/{screen_recording_uuid}/merchant_notes'.sub('{' + 'storefront_oid' + '}', storefront_oid.to_s).sub('{' + 'screen_recording_uuid' + '}', screen_recording_uuid.to_s)
|
|
8285
|
+
|
|
8286
|
+
# query parameters
|
|
8287
|
+
query_params = {}
|
|
8288
|
+
|
|
8289
|
+
# header parameters
|
|
8290
|
+
header_params = {}
|
|
8291
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
|
8292
|
+
# HTTP header 'Accept' (if needed)
|
|
8293
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
8294
|
+
# HTTP header 'Content-Type'
|
|
8295
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
|
8296
|
+
|
|
8297
|
+
# form parameters
|
|
8298
|
+
form_params = {}
|
|
8299
|
+
|
|
8300
|
+
# http body (model)
|
|
8301
|
+
post_body = @api_client.object_to_http_body(merchant_notes_request)
|
|
8302
|
+
auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
|
8303
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
|
8304
|
+
:header_params => header_params,
|
|
8305
|
+
:query_params => query_params,
|
|
8306
|
+
:form_params => form_params,
|
|
8307
|
+
:body => post_body,
|
|
8308
|
+
:auth_names => auth_names)
|
|
8309
|
+
if @api_client.config.debugging
|
|
8310
|
+
@api_client.config.logger.debug "API called: StorefrontApi#update_screen_recording_merchant_notes\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
8311
|
+
end
|
|
8312
|
+
return data, status_code, headers
|
|
8313
|
+
end
|
|
8248
8314
|
# Update screen recording segment
|
|
8249
8315
|
# @param storefront_oid
|
|
8250
8316
|
# @param screen_recording_segment_oid
|
|
@@ -80,6 +80,9 @@ module UltracartClient
|
|
|
80
80
|
# Subject
|
|
81
81
|
attr_accessor :subject
|
|
82
82
|
|
|
83
|
+
# True if the email was suspended for too high of a spam rate.
|
|
84
|
+
attr_accessor :suspended_for_spam
|
|
85
|
+
|
|
83
86
|
# Transactional email
|
|
84
87
|
attr_accessor :transactional_email
|
|
85
88
|
|
|
@@ -111,6 +114,7 @@ module UltracartClient
|
|
|
111
114
|
:'smart_sending' => :'smart_sending',
|
|
112
115
|
:'storefront_oid' => :'storefront_oid',
|
|
113
116
|
:'subject' => :'subject',
|
|
117
|
+
:'suspended_for_spam' => :'suspended_for_spam',
|
|
114
118
|
:'transactional_email' => :'transactional_email',
|
|
115
119
|
:'version' => :'version'
|
|
116
120
|
}
|
|
@@ -141,6 +145,7 @@ module UltracartClient
|
|
|
141
145
|
:'smart_sending' => :'BOOLEAN',
|
|
142
146
|
:'storefront_oid' => :'Integer',
|
|
143
147
|
:'subject' => :'String',
|
|
148
|
+
:'suspended_for_spam' => :'BOOLEAN',
|
|
144
149
|
:'transactional_email' => :'BOOLEAN',
|
|
145
150
|
:'version' => :'Integer'
|
|
146
151
|
}
|
|
@@ -242,6 +247,10 @@ module UltracartClient
|
|
|
242
247
|
self.subject = attributes[:'subject']
|
|
243
248
|
end
|
|
244
249
|
|
|
250
|
+
if attributes.has_key?(:'suspended_for_spam')
|
|
251
|
+
self.suspended_for_spam = attributes[:'suspended_for_spam']
|
|
252
|
+
end
|
|
253
|
+
|
|
245
254
|
if attributes.has_key?(:'transactional_email')
|
|
246
255
|
self.transactional_email = attributes[:'transactional_email']
|
|
247
256
|
end
|
|
@@ -291,6 +300,7 @@ module UltracartClient
|
|
|
291
300
|
smart_sending == o.smart_sending &&
|
|
292
301
|
storefront_oid == o.storefront_oid &&
|
|
293
302
|
subject == o.subject &&
|
|
303
|
+
suspended_for_spam == o.suspended_for_spam &&
|
|
294
304
|
transactional_email == o.transactional_email &&
|
|
295
305
|
version == o.version
|
|
296
306
|
end
|
|
@@ -304,7 +314,7 @@ module UltracartClient
|
|
|
304
314
|
# Calculates hash code according to all attributes.
|
|
305
315
|
# @return [Fixnum] Hash code
|
|
306
316
|
def hash
|
|
307
|
-
[deleted, edited_by_user, email_communication_sequence_email_uuid, email_communication_sequence_uuid, email_container_cjson, email_container_cjson_last_modified_dts, email_template_vm_path, filter_profile_equation_json, individually_render, library_item_oid, merchant_id, pending_review, preview_text, rejected, requires_review, screenshot_large_full_url, screenshot_large_viewport_url, screenshot_small_full_url, screenshot_small_viewport_url, smart_sending, storefront_oid, subject, transactional_email, version].hash
|
|
317
|
+
[deleted, edited_by_user, email_communication_sequence_email_uuid, email_communication_sequence_uuid, email_container_cjson, email_container_cjson_last_modified_dts, email_template_vm_path, filter_profile_equation_json, individually_render, library_item_oid, merchant_id, pending_review, preview_text, rejected, requires_review, screenshot_large_full_url, screenshot_large_viewport_url, screenshot_small_full_url, screenshot_small_viewport_url, smart_sending, storefront_oid, subject, suspended_for_spam, transactional_email, version].hash
|
|
308
318
|
end
|
|
309
319
|
|
|
310
320
|
# Builds the object from hash
|
|
@@ -41,6 +41,27 @@ module UltracartClient
|
|
|
41
41
|
# Current stage that the order is in.
|
|
42
42
|
attr_accessor :current_stage
|
|
43
43
|
|
|
44
|
+
# Custom field 1
|
|
45
|
+
attr_accessor :custom_field_1
|
|
46
|
+
|
|
47
|
+
# Custom field 2
|
|
48
|
+
attr_accessor :custom_field_2
|
|
49
|
+
|
|
50
|
+
# Custom field 3
|
|
51
|
+
attr_accessor :custom_field_3
|
|
52
|
+
|
|
53
|
+
# Custom field 4
|
|
54
|
+
attr_accessor :custom_field_4
|
|
55
|
+
|
|
56
|
+
# Custom field 5
|
|
57
|
+
attr_accessor :custom_field_5
|
|
58
|
+
|
|
59
|
+
# Custom field 6
|
|
60
|
+
attr_accessor :custom_field_6
|
|
61
|
+
|
|
62
|
+
# Custom field 7
|
|
63
|
+
attr_accessor :custom_field_7
|
|
64
|
+
|
|
44
65
|
# The customer profile to find associated orders for
|
|
45
66
|
attr_accessor :customer_profile_oid
|
|
46
67
|
|
|
@@ -138,6 +159,13 @@ module UltracartClient
|
|
|
138
159
|
:'creation_date_begin' => :'creation_date_begin',
|
|
139
160
|
:'creation_date_end' => :'creation_date_end',
|
|
140
161
|
:'current_stage' => :'current_stage',
|
|
162
|
+
:'custom_field_1' => :'custom_field_1',
|
|
163
|
+
:'custom_field_2' => :'custom_field_2',
|
|
164
|
+
:'custom_field_3' => :'custom_field_3',
|
|
165
|
+
:'custom_field_4' => :'custom_field_4',
|
|
166
|
+
:'custom_field_5' => :'custom_field_5',
|
|
167
|
+
:'custom_field_6' => :'custom_field_6',
|
|
168
|
+
:'custom_field_7' => :'custom_field_7',
|
|
141
169
|
:'customer_profile_oid' => :'customer_profile_oid',
|
|
142
170
|
:'email' => :'email',
|
|
143
171
|
:'first_name' => :'first_name',
|
|
@@ -174,6 +202,13 @@ module UltracartClient
|
|
|
174
202
|
:'creation_date_begin' => :'String',
|
|
175
203
|
:'creation_date_end' => :'String',
|
|
176
204
|
:'current_stage' => :'String',
|
|
205
|
+
:'custom_field_1' => :'String',
|
|
206
|
+
:'custom_field_2' => :'String',
|
|
207
|
+
:'custom_field_3' => :'String',
|
|
208
|
+
:'custom_field_4' => :'String',
|
|
209
|
+
:'custom_field_5' => :'String',
|
|
210
|
+
:'custom_field_6' => :'String',
|
|
211
|
+
:'custom_field_7' => :'String',
|
|
177
212
|
:'customer_profile_oid' => :'Integer',
|
|
178
213
|
:'email' => :'String',
|
|
179
214
|
:'first_name' => :'String',
|
|
@@ -242,6 +277,34 @@ module UltracartClient
|
|
|
242
277
|
self.current_stage = attributes[:'current_stage']
|
|
243
278
|
end
|
|
244
279
|
|
|
280
|
+
if attributes.has_key?(:'custom_field_1')
|
|
281
|
+
self.custom_field_1 = attributes[:'custom_field_1']
|
|
282
|
+
end
|
|
283
|
+
|
|
284
|
+
if attributes.has_key?(:'custom_field_2')
|
|
285
|
+
self.custom_field_2 = attributes[:'custom_field_2']
|
|
286
|
+
end
|
|
287
|
+
|
|
288
|
+
if attributes.has_key?(:'custom_field_3')
|
|
289
|
+
self.custom_field_3 = attributes[:'custom_field_3']
|
|
290
|
+
end
|
|
291
|
+
|
|
292
|
+
if attributes.has_key?(:'custom_field_4')
|
|
293
|
+
self.custom_field_4 = attributes[:'custom_field_4']
|
|
294
|
+
end
|
|
295
|
+
|
|
296
|
+
if attributes.has_key?(:'custom_field_5')
|
|
297
|
+
self.custom_field_5 = attributes[:'custom_field_5']
|
|
298
|
+
end
|
|
299
|
+
|
|
300
|
+
if attributes.has_key?(:'custom_field_6')
|
|
301
|
+
self.custom_field_6 = attributes[:'custom_field_6']
|
|
302
|
+
end
|
|
303
|
+
|
|
304
|
+
if attributes.has_key?(:'custom_field_7')
|
|
305
|
+
self.custom_field_7 = attributes[:'custom_field_7']
|
|
306
|
+
end
|
|
307
|
+
|
|
245
308
|
if attributes.has_key?(:'customer_profile_oid')
|
|
246
309
|
self.customer_profile_oid = attributes[:'customer_profile_oid']
|
|
247
310
|
end
|
|
@@ -558,6 +621,13 @@ module UltracartClient
|
|
|
558
621
|
creation_date_begin == o.creation_date_begin &&
|
|
559
622
|
creation_date_end == o.creation_date_end &&
|
|
560
623
|
current_stage == o.current_stage &&
|
|
624
|
+
custom_field_1 == o.custom_field_1 &&
|
|
625
|
+
custom_field_2 == o.custom_field_2 &&
|
|
626
|
+
custom_field_3 == o.custom_field_3 &&
|
|
627
|
+
custom_field_4 == o.custom_field_4 &&
|
|
628
|
+
custom_field_5 == o.custom_field_5 &&
|
|
629
|
+
custom_field_6 == o.custom_field_6 &&
|
|
630
|
+
custom_field_7 == o.custom_field_7 &&
|
|
561
631
|
customer_profile_oid == o.customer_profile_oid &&
|
|
562
632
|
email == o.email &&
|
|
563
633
|
first_name == o.first_name &&
|
|
@@ -590,7 +660,7 @@ module UltracartClient
|
|
|
590
660
|
# Calculates hash code according to all attributes.
|
|
591
661
|
# @return [Fixnum] Hash code
|
|
592
662
|
def hash
|
|
593
|
-
[cc_email, channel_partner_code, channel_partner_order_id, city, company, country_code, creation_date_begin, creation_date_end, current_stage, customer_profile_oid, email, first_name, item_id, last_name, order_id, payment_date_begin, payment_date_end, payment_method, phone, postal_code, purchase_order_number, refund_date_begin, refund_date_end, rma, screen_branding_theme_code, shipment_date_begin, shipment_date_end, state_region, storefront_host_name, total].hash
|
|
663
|
+
[cc_email, channel_partner_code, channel_partner_order_id, city, company, country_code, creation_date_begin, creation_date_end, current_stage, custom_field_1, custom_field_2, custom_field_3, custom_field_4, custom_field_5, custom_field_6, custom_field_7, customer_profile_oid, email, first_name, item_id, last_name, order_id, payment_date_begin, payment_date_end, payment_method, phone, postal_code, purchase_order_number, refund_date_begin, refund_date_end, rma, screen_branding_theme_code, shipment_date_begin, shipment_date_end, state_region, storefront_host_name, total].hash
|
|
594
664
|
end
|
|
595
665
|
|
|
596
666
|
# Builds the object from hash
|
|
@@ -45,6 +45,8 @@ module UltracartClient
|
|
|
45
45
|
|
|
46
46
|
attr_accessor :merchant_id
|
|
47
47
|
|
|
48
|
+
attr_accessor :merchant_notes
|
|
49
|
+
|
|
48
50
|
attr_accessor :order_id
|
|
49
51
|
|
|
50
52
|
attr_accessor :page_view_count
|
|
@@ -78,6 +80,11 @@ module UltracartClient
|
|
|
78
80
|
|
|
79
81
|
attr_accessor :user_properties
|
|
80
82
|
|
|
83
|
+
# Timestamp this visitor was first seen
|
|
84
|
+
attr_accessor :visitor_first_seen
|
|
85
|
+
|
|
86
|
+
attr_accessor :visitor_number
|
|
87
|
+
|
|
81
88
|
attr_accessor :watched
|
|
82
89
|
|
|
83
90
|
attr_accessor :window_height
|
|
@@ -101,6 +108,7 @@ module UltracartClient
|
|
|
101
108
|
:'geolocation_country' => :'geolocation_country',
|
|
102
109
|
:'geolocation_state' => :'geolocation_state',
|
|
103
110
|
:'merchant_id' => :'merchant_id',
|
|
111
|
+
:'merchant_notes' => :'merchant_notes',
|
|
104
112
|
:'order_id' => :'order_id',
|
|
105
113
|
:'page_view_count' => :'page_view_count',
|
|
106
114
|
:'page_views' => :'page_views',
|
|
@@ -117,6 +125,8 @@ module UltracartClient
|
|
|
117
125
|
:'user_agent_raw' => :'user_agent_raw',
|
|
118
126
|
:'user_ip' => :'user_ip',
|
|
119
127
|
:'user_properties' => :'user_properties',
|
|
128
|
+
:'visitor_first_seen' => :'visitor_first_seen',
|
|
129
|
+
:'visitor_number' => :'visitor_number',
|
|
120
130
|
:'watched' => :'watched',
|
|
121
131
|
:'window_height' => :'window_height',
|
|
122
132
|
:'window_width' => :'window_width'
|
|
@@ -140,6 +150,7 @@ module UltracartClient
|
|
|
140
150
|
:'geolocation_country' => :'String',
|
|
141
151
|
:'geolocation_state' => :'String',
|
|
142
152
|
:'merchant_id' => :'String',
|
|
153
|
+
:'merchant_notes' => :'String',
|
|
143
154
|
:'order_id' => :'String',
|
|
144
155
|
:'page_view_count' => :'Integer',
|
|
145
156
|
:'page_views' => :'Array<ScreenRecordingPageView>',
|
|
@@ -156,6 +167,8 @@ module UltracartClient
|
|
|
156
167
|
:'user_agent_raw' => :'String',
|
|
157
168
|
:'user_ip' => :'String',
|
|
158
169
|
:'user_properties' => :'Array<ScreenRecordingUserProperty>',
|
|
170
|
+
:'visitor_first_seen' => :'String',
|
|
171
|
+
:'visitor_number' => :'Integer',
|
|
159
172
|
:'watched' => :'BOOLEAN',
|
|
160
173
|
:'window_height' => :'Integer',
|
|
161
174
|
:'window_width' => :'Integer'
|
|
@@ -228,6 +241,10 @@ module UltracartClient
|
|
|
228
241
|
self.merchant_id = attributes[:'merchant_id']
|
|
229
242
|
end
|
|
230
243
|
|
|
244
|
+
if attributes.has_key?(:'merchant_notes')
|
|
245
|
+
self.merchant_notes = attributes[:'merchant_notes']
|
|
246
|
+
end
|
|
247
|
+
|
|
231
248
|
if attributes.has_key?(:'order_id')
|
|
232
249
|
self.order_id = attributes[:'order_id']
|
|
233
250
|
end
|
|
@@ -302,6 +319,14 @@ module UltracartClient
|
|
|
302
319
|
end
|
|
303
320
|
end
|
|
304
321
|
|
|
322
|
+
if attributes.has_key?(:'visitor_first_seen')
|
|
323
|
+
self.visitor_first_seen = attributes[:'visitor_first_seen']
|
|
324
|
+
end
|
|
325
|
+
|
|
326
|
+
if attributes.has_key?(:'visitor_number')
|
|
327
|
+
self.visitor_number = attributes[:'visitor_number']
|
|
328
|
+
end
|
|
329
|
+
|
|
305
330
|
if attributes.has_key?(:'watched')
|
|
306
331
|
self.watched = attributes[:'watched']
|
|
307
332
|
end
|
|
@@ -347,6 +372,7 @@ module UltracartClient
|
|
|
347
372
|
geolocation_country == o.geolocation_country &&
|
|
348
373
|
geolocation_state == o.geolocation_state &&
|
|
349
374
|
merchant_id == o.merchant_id &&
|
|
375
|
+
merchant_notes == o.merchant_notes &&
|
|
350
376
|
order_id == o.order_id &&
|
|
351
377
|
page_view_count == o.page_view_count &&
|
|
352
378
|
page_views == o.page_views &&
|
|
@@ -363,6 +389,8 @@ module UltracartClient
|
|
|
363
389
|
user_agent_raw == o.user_agent_raw &&
|
|
364
390
|
user_ip == o.user_ip &&
|
|
365
391
|
user_properties == o.user_properties &&
|
|
392
|
+
visitor_first_seen == o.visitor_first_seen &&
|
|
393
|
+
visitor_number == o.visitor_number &&
|
|
366
394
|
watched == o.watched &&
|
|
367
395
|
window_height == o.window_height &&
|
|
368
396
|
window_width == o.window_width
|
|
@@ -377,7 +405,7 @@ module UltracartClient
|
|
|
377
405
|
# Calculates hash code according to all attributes.
|
|
378
406
|
# @return [Fixnum] Hash code
|
|
379
407
|
def hash
|
|
380
|
-
[analytics_client_oid, analytics_session_dts, analytics_session_oid, email, end_timestamp, esp_customer_uuid, events_gz_size, events_json_key, favorite, favorites, geolocation, geolocation_country, geolocation_state, merchant_id, order_id, page_view_count, page_views, rrweb_version, screen_recording_uuid, signed_download_url, start_timestamp, storefront_oids, storefronts, tags, time_on_site, ucacid, user_agent, user_agent_raw, user_ip, user_properties, watched, window_height, window_width].hash
|
|
408
|
+
[analytics_client_oid, analytics_session_dts, analytics_session_oid, email, end_timestamp, esp_customer_uuid, events_gz_size, events_json_key, favorite, favorites, geolocation, geolocation_country, geolocation_state, merchant_id, merchant_notes, order_id, page_view_count, page_views, rrweb_version, screen_recording_uuid, signed_download_url, start_timestamp, storefront_oids, storefronts, tags, time_on_site, ucacid, user_agent, user_agent_raw, user_ip, user_properties, visitor_first_seen, visitor_number, watched, window_height, window_width].hash
|
|
381
409
|
end
|
|
382
410
|
|
|
383
411
|
# Builds the object from hash
|
|
@@ -66,6 +66,8 @@ module UltracartClient
|
|
|
66
66
|
|
|
67
67
|
attr_accessor :user_ip
|
|
68
68
|
|
|
69
|
+
attr_accessor :visitor_number
|
|
70
|
+
|
|
69
71
|
attr_accessor :watched
|
|
70
72
|
|
|
71
73
|
# Attribute mapping from ruby-style variable name to JSON key.
|
|
@@ -97,6 +99,7 @@ module UltracartClient
|
|
|
97
99
|
:'user_agent_os_name' => :'user_agent_os_name',
|
|
98
100
|
:'user_agent_os_version' => :'user_agent_os_version',
|
|
99
101
|
:'user_ip' => :'user_ip',
|
|
102
|
+
:'visitor_number' => :'visitor_number',
|
|
100
103
|
:'watched' => :'watched'
|
|
101
104
|
}
|
|
102
105
|
end
|
|
@@ -130,6 +133,7 @@ module UltracartClient
|
|
|
130
133
|
:'user_agent_os_name' => :'String',
|
|
131
134
|
:'user_agent_os_version' => :'String',
|
|
132
135
|
:'user_ip' => :'ScreenRecordingFilterIpSearch',
|
|
136
|
+
:'visitor_number' => :'Integer',
|
|
133
137
|
:'watched' => :'BOOLEAN'
|
|
134
138
|
}
|
|
135
139
|
end
|
|
@@ -254,6 +258,10 @@ module UltracartClient
|
|
|
254
258
|
self.user_ip = attributes[:'user_ip']
|
|
255
259
|
end
|
|
256
260
|
|
|
261
|
+
if attributes.has_key?(:'visitor_number')
|
|
262
|
+
self.visitor_number = attributes[:'visitor_number']
|
|
263
|
+
end
|
|
264
|
+
|
|
257
265
|
if attributes.has_key?(:'watched')
|
|
258
266
|
self.watched = attributes[:'watched']
|
|
259
267
|
end
|
|
@@ -303,6 +311,7 @@ module UltracartClient
|
|
|
303
311
|
user_agent_os_name == o.user_agent_os_name &&
|
|
304
312
|
user_agent_os_version == o.user_agent_os_version &&
|
|
305
313
|
user_ip == o.user_ip &&
|
|
314
|
+
visitor_number == o.visitor_number &&
|
|
306
315
|
watched == o.watched
|
|
307
316
|
end
|
|
308
317
|
|
|
@@ -315,7 +324,7 @@ module UltracartClient
|
|
|
315
324
|
# Calculates hash code according to all attributes.
|
|
316
325
|
# @return [Fixnum] Hash code
|
|
317
326
|
def hash
|
|
318
|
-
[email, email_identified, end_timestamp, esp_customer_uuid, favorite, geolocation, geolocation_country, geolocation_state, max_filter_values, order_id, page_view_count, page_views, placed_order, screen_recording_uuids, screen_sizes, skip_filter_values, skip_hits, start_timestamp, tags, time_on_site, user_agent_device_name, user_agent_name, user_agent_original, user_agent_os_name, user_agent_os_version, user_ip, watched].hash
|
|
327
|
+
[email, email_identified, end_timestamp, esp_customer_uuid, favorite, geolocation, geolocation_country, geolocation_state, max_filter_values, order_id, page_view_count, page_views, placed_order, screen_recording_uuids, screen_sizes, skip_filter_values, skip_hits, start_timestamp, tags, time_on_site, user_agent_device_name, user_agent_name, user_agent_original, user_agent_os_name, user_agent_os_version, user_ip, visitor_number, watched].hash
|
|
319
328
|
end
|
|
320
329
|
|
|
321
330
|
# Builds the object from hash
|
|
@@ -0,0 +1,184 @@
|
|
|
1
|
+
=begin
|
|
2
|
+
#UltraCart Rest API V2
|
|
3
|
+
|
|
4
|
+
#UltraCart REST API Version 2
|
|
5
|
+
|
|
6
|
+
OpenAPI spec version: 2.0.0
|
|
7
|
+
Contact: support@ultracart.com
|
|
8
|
+
Generated by: https://github.com/swagger-api/swagger-codegen.git
|
|
9
|
+
Swagger Codegen version: 2.4.15-SNAPSHOT
|
|
10
|
+
|
|
11
|
+
=end
|
|
12
|
+
|
|
13
|
+
require 'date'
|
|
14
|
+
|
|
15
|
+
module UltracartClient
|
|
16
|
+
class ScreenRecordingMerchantNotesRequest
|
|
17
|
+
attr_accessor :merchant_notes
|
|
18
|
+
|
|
19
|
+
# Attribute mapping from ruby-style variable name to JSON key.
|
|
20
|
+
def self.attribute_map
|
|
21
|
+
{
|
|
22
|
+
:'merchant_notes' => :'merchant_notes'
|
|
23
|
+
}
|
|
24
|
+
end
|
|
25
|
+
|
|
26
|
+
# Attribute type mapping.
|
|
27
|
+
def self.swagger_types
|
|
28
|
+
{
|
|
29
|
+
:'merchant_notes' => :'String'
|
|
30
|
+
}
|
|
31
|
+
end
|
|
32
|
+
|
|
33
|
+
# Initializes the object
|
|
34
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
|
35
|
+
def initialize(attributes = {})
|
|
36
|
+
return unless attributes.is_a?(Hash)
|
|
37
|
+
|
|
38
|
+
# convert string to symbol for hash key
|
|
39
|
+
attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
|
|
40
|
+
|
|
41
|
+
if attributes.has_key?(:'merchant_notes')
|
|
42
|
+
self.merchant_notes = attributes[:'merchant_notes']
|
|
43
|
+
end
|
|
44
|
+
end
|
|
45
|
+
|
|
46
|
+
# Show invalid properties with the reasons. Usually used together with valid?
|
|
47
|
+
# @return Array for valid properties with the reasons
|
|
48
|
+
def list_invalid_properties
|
|
49
|
+
invalid_properties = Array.new
|
|
50
|
+
invalid_properties
|
|
51
|
+
end
|
|
52
|
+
|
|
53
|
+
# Check to see if the all the properties in the model are valid
|
|
54
|
+
# @return true if the model is valid
|
|
55
|
+
def valid?
|
|
56
|
+
true
|
|
57
|
+
end
|
|
58
|
+
|
|
59
|
+
# Checks equality by comparing each attribute.
|
|
60
|
+
# @param [Object] Object to be compared
|
|
61
|
+
def ==(o)
|
|
62
|
+
return true if self.equal?(o)
|
|
63
|
+
self.class == o.class &&
|
|
64
|
+
merchant_notes == o.merchant_notes
|
|
65
|
+
end
|
|
66
|
+
|
|
67
|
+
# @see the `==` method
|
|
68
|
+
# @param [Object] Object to be compared
|
|
69
|
+
def eql?(o)
|
|
70
|
+
self == o
|
|
71
|
+
end
|
|
72
|
+
|
|
73
|
+
# Calculates hash code according to all attributes.
|
|
74
|
+
# @return [Fixnum] Hash code
|
|
75
|
+
def hash
|
|
76
|
+
[merchant_notes].hash
|
|
77
|
+
end
|
|
78
|
+
|
|
79
|
+
# Builds the object from hash
|
|
80
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
|
81
|
+
# @return [Object] Returns the model itself
|
|
82
|
+
def build_from_hash(attributes)
|
|
83
|
+
return nil unless attributes.is_a?(Hash)
|
|
84
|
+
self.class.swagger_types.each_pair do |key, type|
|
|
85
|
+
if type =~ /\AArray<(.*)>/i
|
|
86
|
+
# check to ensure the input is an array given that the attribute
|
|
87
|
+
# is documented as an array but the input is not
|
|
88
|
+
if attributes[self.class.attribute_map[key]].is_a?(Array)
|
|
89
|
+
self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
|
|
90
|
+
end
|
|
91
|
+
elsif !attributes[self.class.attribute_map[key]].nil?
|
|
92
|
+
self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
|
|
93
|
+
end # or else data not found in attributes(hash), not an issue as the data can be optional
|
|
94
|
+
end
|
|
95
|
+
|
|
96
|
+
self
|
|
97
|
+
end
|
|
98
|
+
|
|
99
|
+
# Deserializes the data based on type
|
|
100
|
+
# @param string type Data type
|
|
101
|
+
# @param string value Value to be deserialized
|
|
102
|
+
# @return [Object] Deserialized data
|
|
103
|
+
def _deserialize(type, value)
|
|
104
|
+
case type.to_sym
|
|
105
|
+
when :DateTime
|
|
106
|
+
DateTime.parse(value)
|
|
107
|
+
when :Date
|
|
108
|
+
Date.parse(value)
|
|
109
|
+
when :String
|
|
110
|
+
value.to_s
|
|
111
|
+
when :Integer
|
|
112
|
+
value.to_i
|
|
113
|
+
when :Float
|
|
114
|
+
value.to_f
|
|
115
|
+
when :BOOLEAN
|
|
116
|
+
if value.to_s =~ /\A(true|t|yes|y|1)\z/i
|
|
117
|
+
true
|
|
118
|
+
else
|
|
119
|
+
false
|
|
120
|
+
end
|
|
121
|
+
when :Object
|
|
122
|
+
# generic object (usually a Hash), return directly
|
|
123
|
+
value
|
|
124
|
+
when /\AArray<(?<inner_type>.+)>\z/
|
|
125
|
+
inner_type = Regexp.last_match[:inner_type]
|
|
126
|
+
value.map { |v| _deserialize(inner_type, v) }
|
|
127
|
+
when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
|
|
128
|
+
k_type = Regexp.last_match[:k_type]
|
|
129
|
+
v_type = Regexp.last_match[:v_type]
|
|
130
|
+
{}.tap do |hash|
|
|
131
|
+
value.each do |k, v|
|
|
132
|
+
hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
|
|
133
|
+
end
|
|
134
|
+
end
|
|
135
|
+
else # model
|
|
136
|
+
temp_model = UltracartClient.const_get(type).new
|
|
137
|
+
temp_model.build_from_hash(value)
|
|
138
|
+
end
|
|
139
|
+
end
|
|
140
|
+
|
|
141
|
+
# Returns the string representation of the object
|
|
142
|
+
# @return [String] String presentation of the object
|
|
143
|
+
def to_s
|
|
144
|
+
to_hash.to_s
|
|
145
|
+
end
|
|
146
|
+
|
|
147
|
+
# to_body is an alias to to_hash (backward compatibility)
|
|
148
|
+
# @return [Hash] Returns the object in the form of hash
|
|
149
|
+
def to_body
|
|
150
|
+
to_hash
|
|
151
|
+
end
|
|
152
|
+
|
|
153
|
+
# Returns the object in the form of hash
|
|
154
|
+
# @return [Hash] Returns the object in the form of hash
|
|
155
|
+
def to_hash
|
|
156
|
+
hash = {}
|
|
157
|
+
self.class.attribute_map.each_pair do |attr, param|
|
|
158
|
+
value = self.send(attr)
|
|
159
|
+
next if value.nil?
|
|
160
|
+
hash[param] = _to_hash(value)
|
|
161
|
+
end
|
|
162
|
+
hash
|
|
163
|
+
end
|
|
164
|
+
|
|
165
|
+
# Outputs non-array value in the form of hash
|
|
166
|
+
# For object, use to_hash. Otherwise, just return the value
|
|
167
|
+
# @param [Object] value Any valid value
|
|
168
|
+
# @return [Hash] Returns the value in the form of hash
|
|
169
|
+
def _to_hash(value)
|
|
170
|
+
if value.is_a?(Array)
|
|
171
|
+
value.compact.map { |v| _to_hash(v) }
|
|
172
|
+
elsif value.is_a?(Hash)
|
|
173
|
+
{}.tap do |hash|
|
|
174
|
+
value.each { |k, v| hash[k] = _to_hash(v) }
|
|
175
|
+
end
|
|
176
|
+
elsif value.respond_to? :to_hash
|
|
177
|
+
value.to_hash
|
|
178
|
+
else
|
|
179
|
+
value
|
|
180
|
+
end
|
|
181
|
+
end
|
|
182
|
+
|
|
183
|
+
end
|
|
184
|
+
end
|
metadata
CHANGED
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: ultracart_api
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 3.1.
|
|
4
|
+
version: 3.1.14
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- UltraCart
|
|
8
8
|
autorequire:
|
|
9
9
|
bindir: bin
|
|
10
10
|
cert_chain: []
|
|
11
|
-
date: 2021-
|
|
11
|
+
date: 2021-03-15 00:00:00.000000000 Z
|
|
12
12
|
dependencies:
|
|
13
13
|
- !ruby/object:Gem::Dependency
|
|
14
14
|
name: typhoeus
|
|
@@ -694,6 +694,7 @@ files:
|
|
|
694
694
|
- docs/ScreenRecordingFilterValues.md
|
|
695
695
|
- docs/ScreenRecordingFilterValuesEvent.md
|
|
696
696
|
- docs/ScreenRecordingFilterValuesEventParams.md
|
|
697
|
+
- docs/ScreenRecordingMerchantNotesRequest.md
|
|
697
698
|
- docs/ScreenRecordingMultifield.md
|
|
698
699
|
- docs/ScreenRecordingPageView.md
|
|
699
700
|
- docs/ScreenRecordingPageViewDataResponse.md
|
|
@@ -1279,6 +1280,7 @@ files:
|
|
|
1279
1280
|
- lib/ultracart_api/models/screen_recording_filter_values.rb
|
|
1280
1281
|
- lib/ultracart_api/models/screen_recording_filter_values_event.rb
|
|
1281
1282
|
- lib/ultracart_api/models/screen_recording_filter_values_event_params.rb
|
|
1283
|
+
- lib/ultracart_api/models/screen_recording_merchant_notes_request.rb
|
|
1282
1284
|
- lib/ultracart_api/models/screen_recording_multifield.rb
|
|
1283
1285
|
- lib/ultracart_api/models/screen_recording_page_view.rb
|
|
1284
1286
|
- lib/ultracart_api/models/screen_recording_page_view_data_response.rb
|