ultracart_api 4.0.132 → 4.0.134
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +7 -4
- data/docs/CartCheckout.md +6 -0
- data/docs/LookupRequest.md +2 -0
- data/docs/Order.md +3 -1
- data/docs/OrderCheckout.md +6 -0
- data/docs/OrderUtm.md +64 -0
- data/docs/PricingTier.md +2 -0
- data/lib/ultracart_api/models/cart_checkout.rb +76 -1
- data/lib/ultracart_api/models/lookup_request.rb +10 -1
- data/lib/ultracart_api/models/order.rb +16 -4
- data/lib/ultracart_api/models/order_checkout.rb +76 -1
- data/lib/ultracart_api/models/order_utm.rb +427 -0
- data/lib/ultracart_api/models/pricing_tier.rb +11 -1
- data/lib/ultracart_api/version.rb +1 -1
- data/lib/ultracart_api.rb +1 -0
- 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: c33c30bbb3cea460a12eb5c0167c32f8d367e69680ee7264c49045d03787cdae
|
4
|
+
data.tar.gz: 95f7b040b08ddb0de71590f33a3786cee2dfdd96aaea936192e28f0996061de2
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: ef89abdb620d7c3bc286b5f4e37d4bcab5ac3d50662ddbf867facaad07223fa4568f007d65cc355f3c5f9f065ba301bbb15ce2b3bd221e16cff28181e42b4277
|
7
|
+
data.tar.gz: 2c85560b053dc45986acd4eaf05dd9cfa5e85684bb9bdbf88aa7e26d253738697cafbfc4f3ab3c7bebd324a94c2cc3e614f79425cb3eedc24306982590618d74
|
data/README.md
CHANGED
@@ -7,7 +7,7 @@ UltraCart REST API Version 2
|
|
7
7
|
This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
8
8
|
|
9
9
|
- API version: 2.0.0
|
10
|
-
- Package version: 4.0.
|
10
|
+
- Package version: 4.0.134
|
11
11
|
- Build package: org.openapitools.codegen.languages.RubyClientCodegen
|
12
12
|
For more information, please visit [http://www.ultracart.com](http://www.ultracart.com)
|
13
13
|
|
@@ -24,16 +24,16 @@ gem build ultracart_api.gemspec
|
|
24
24
|
Then either install the gem locally:
|
25
25
|
|
26
26
|
```shell
|
27
|
-
gem install ./ultracart_api-4.0.
|
27
|
+
gem install ./ultracart_api-4.0.134.gem
|
28
28
|
```
|
29
29
|
|
30
|
-
(for development, run `gem install --dev ./ultracart_api-4.0.
|
30
|
+
(for development, run `gem install --dev ./ultracart_api-4.0.134.gem` to install the development dependencies)
|
31
31
|
|
32
32
|
or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
|
33
33
|
|
34
34
|
Finally add this to the Gemfile:
|
35
35
|
|
36
|
-
gem 'ultracart_api', '~> 4.0.
|
36
|
+
gem 'ultracart_api', '~> 4.0.134'
|
37
37
|
|
38
38
|
### Install from Git
|
39
39
|
|
@@ -1104,6 +1104,7 @@ Class | Method | HTTP request | Description
|
|
1104
1104
|
- [UltracartClient::OrderTrackingNumberDetail](docs/OrderTrackingNumberDetail.md)
|
1105
1105
|
- [UltracartClient::OrderTrackingNumberDetails](docs/OrderTrackingNumberDetails.md)
|
1106
1106
|
- [UltracartClient::OrderTransactionalMerchantNote](docs/OrderTransactionalMerchantNote.md)
|
1107
|
+
- [UltracartClient::OrderUtm](docs/OrderUtm.md)
|
1107
1108
|
- [UltracartClient::OrdersResponse](docs/OrdersResponse.md)
|
1108
1109
|
- [UltracartClient::Permission](docs/Permission.md)
|
1109
1110
|
- [UltracartClient::PointOfSaleLocation](docs/PointOfSaleLocation.md)
|
@@ -1308,6 +1309,8 @@ Not every change is committed to every SDK.
|
|
1308
1309
|
|
1309
1310
|
| Version | Date | Comments |
|
1310
1311
|
| --: | :-: | --- |
|
1312
|
+
| 4.0.134 | 02/15/2023 | added auto order sorting by next_shipment_dts |
|
1313
|
+
| 4.0.133 | 02/10/2023 | convo - add storefront_host_name to search request |
|
1311
1314
|
| 4.0.132 | 02/07/2023 | convo - new event for when a customer joins a queue |
|
1312
1315
|
| 4.0.131 | 02/07/2023 | convo - new event for when a customer joins a queue |
|
1313
1316
|
| 4.0.130 | 02/06/2023 | convo - add conversation_arn to ConversationWebsocketMessage |
|
data/docs/CartCheckout.md
CHANGED
@@ -6,12 +6,15 @@
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
7
|
| **comments** | **String** | Comments from the customer. Rarely used on the single page checkout. | [optional] |
|
8
8
|
| **custom_field1** | **String** | Custom field 1 | [optional] |
|
9
|
+
| **custom_field10** | **String** | Custom field 10 | [optional] |
|
9
10
|
| **custom_field2** | **String** | Custom field 2 | [optional] |
|
10
11
|
| **custom_field3** | **String** | Custom field 3 | [optional] |
|
11
12
|
| **custom_field4** | **String** | Custom field 4 | [optional] |
|
12
13
|
| **custom_field5** | **String** | Custom field 5 | [optional] |
|
13
14
|
| **custom_field6** | **String** | Custom field 6 | [optional] |
|
14
15
|
| **custom_field7** | **String** | Custom field 7 | [optional] |
|
16
|
+
| **custom_field8** | **String** | Custom field 8 | [optional] |
|
17
|
+
| **custom_field9** | **String** | Custom field 9 | [optional] |
|
15
18
|
| **ip_address** | **String** | IP Address (read only unless non-browser key authenticated) | [optional] |
|
16
19
|
| **return_code** | **String** | Return code assigned for send return email operation | [optional] |
|
17
20
|
| **return_url** | **String** | The URL to redirect the customer to when they return from an abandon cart email. Must be https protocol. | [optional] |
|
@@ -27,12 +30,15 @@ require 'ultracart_api'
|
|
27
30
|
instance = UltracartClient::CartCheckout.new(
|
28
31
|
comments: null,
|
29
32
|
custom_field1: null,
|
33
|
+
custom_field10: null,
|
30
34
|
custom_field2: null,
|
31
35
|
custom_field3: null,
|
32
36
|
custom_field4: null,
|
33
37
|
custom_field5: null,
|
34
38
|
custom_field6: null,
|
35
39
|
custom_field7: null,
|
40
|
+
custom_field8: null,
|
41
|
+
custom_field9: null,
|
36
42
|
ip_address: null,
|
37
43
|
return_code: null,
|
38
44
|
return_url: null,
|
data/docs/LookupRequest.md
CHANGED
@@ -7,6 +7,7 @@
|
|
7
7
|
| **category** | **String** | | [optional] |
|
8
8
|
| **matches** | **String** | | [optional] |
|
9
9
|
| **max_hits** | **Integer** | | [optional] |
|
10
|
+
| **storefront_host_name** | **String** | | [optional] |
|
10
11
|
| **storefront_oid** | **Integer** | | [optional] |
|
11
12
|
| **subcategory** | **String** | | [optional] |
|
12
13
|
|
@@ -19,6 +20,7 @@ instance = UltracartClient::LookupRequest.new(
|
|
19
20
|
category: null,
|
20
21
|
matches: null,
|
21
22
|
max_hits: null,
|
23
|
+
storefront_host_name: null,
|
22
24
|
storefront_oid: null,
|
23
25
|
subcategory: null
|
24
26
|
)
|
data/docs/Order.md
CHANGED
@@ -39,6 +39,7 @@
|
|
39
39
|
| **summary** | [**OrderSummary**](OrderSummary.md) | | [optional] |
|
40
40
|
| **tags** | [**Array<OrderTag>**](OrderTag.md) | tags, available only through update, not through insert due to the nature of how tags are handled internally | [optional] |
|
41
41
|
| **taxes** | [**OrderTaxes**](OrderTaxes.md) | | [optional] |
|
42
|
+
| **utms** | [**Array<OrderUtm>**](OrderUtm.md) | UTM clicks. The zero index is the most recent (last) UTM click | [optional] |
|
42
43
|
|
43
44
|
## Example
|
44
45
|
|
@@ -80,7 +81,8 @@ instance = UltracartClient::Order.new(
|
|
80
81
|
shipping: null,
|
81
82
|
summary: null,
|
82
83
|
tags: null,
|
83
|
-
taxes: null
|
84
|
+
taxes: null,
|
85
|
+
utms: null
|
84
86
|
)
|
85
87
|
```
|
86
88
|
|
data/docs/OrderCheckout.md
CHANGED
@@ -7,12 +7,15 @@
|
|
7
7
|
| **browser** | [**Browser**](Browser.md) | | [optional] |
|
8
8
|
| **comments** | **String** | Comments from the customer. Rarely used on the single page checkout. | [optional] |
|
9
9
|
| **custom_field1** | **String** | Custom field 1 | [optional] |
|
10
|
+
| **custom_field10** | **String** | Custom field 10 | [optional] |
|
10
11
|
| **custom_field2** | **String** | Custom field 2 | [optional] |
|
11
12
|
| **custom_field3** | **String** | Custom field 3 | [optional] |
|
12
13
|
| **custom_field4** | **String** | Custom field 4 | [optional] |
|
13
14
|
| **custom_field5** | **String** | Custom field 5 | [optional] |
|
14
15
|
| **custom_field6** | **String** | Custom field 6 | [optional] |
|
15
16
|
| **custom_field7** | **String** | Custom field 7 | [optional] |
|
17
|
+
| **custom_field8** | **String** | Custom field 8 | [optional] |
|
18
|
+
| **custom_field9** | **String** | Custom field 9 | [optional] |
|
16
19
|
| **customer_ip_address** | **String** | IP address of the customer when placing the order | [optional] |
|
17
20
|
| **screen_branding_theme_code** | **String** | Screen branding theme code associated with the order (legacy checkout) | [optional] |
|
18
21
|
| **screen_size** | **String** | Screen size small, medium or large | [optional] |
|
@@ -28,12 +31,15 @@ instance = UltracartClient::OrderCheckout.new(
|
|
28
31
|
browser: null,
|
29
32
|
comments: null,
|
30
33
|
custom_field1: null,
|
34
|
+
custom_field10: null,
|
31
35
|
custom_field2: null,
|
32
36
|
custom_field3: null,
|
33
37
|
custom_field4: null,
|
34
38
|
custom_field5: null,
|
35
39
|
custom_field6: null,
|
36
40
|
custom_field7: null,
|
41
|
+
custom_field8: null,
|
42
|
+
custom_field9: null,
|
37
43
|
customer_ip_address: null,
|
38
44
|
screen_branding_theme_code: null,
|
39
45
|
screen_size: null,
|
data/docs/OrderUtm.md
ADDED
@@ -0,0 +1,64 @@
|
|
1
|
+
# UltracartClient::OrderUtm
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **attribution_first_click_subtotal** | **Float** | | [optional] |
|
8
|
+
| **attribution_first_click_total** | **Float** | | [optional] |
|
9
|
+
| **attribution_last_click_subtotal** | **Float** | | [optional] |
|
10
|
+
| **attribution_last_click_total** | **Float** | | [optional] |
|
11
|
+
| **attribution_linear_subtotal** | **Float** | | [optional] |
|
12
|
+
| **attribution_linear_total** | **Float** | | [optional] |
|
13
|
+
| **attribution_position_based_subtotal** | **Float** | | [optional] |
|
14
|
+
| **attribution_position_based_total** | **Float** | | [optional] |
|
15
|
+
| **click_dts** | **String** | Date/time that the click happened | [optional] |
|
16
|
+
| **facebook_ad_id** | **String** | | [optional] |
|
17
|
+
| **fbclid** | **String** | | [optional] |
|
18
|
+
| **gbraid** | **String** | | [optional] |
|
19
|
+
| **glcid** | **String** | | [optional] |
|
20
|
+
| **msclkid** | **String** | | [optional] |
|
21
|
+
| **ttclid** | **String** | | [optional] |
|
22
|
+
| **uc_message_id** | **String** | | [optional] |
|
23
|
+
| **utm_campaign** | **String** | | [optional] |
|
24
|
+
| **utm_content** | **String** | | [optional] |
|
25
|
+
| **utm_id** | **String** | | [optional] |
|
26
|
+
| **utm_medium** | **String** | | [optional] |
|
27
|
+
| **utm_source** | **String** | | [optional] |
|
28
|
+
| **utm_term** | **String** | | [optional] |
|
29
|
+
| **vmcid** | **String** | | [optional] |
|
30
|
+
| **wbraid** | **String** | | [optional] |
|
31
|
+
|
32
|
+
## Example
|
33
|
+
|
34
|
+
```ruby
|
35
|
+
require 'ultracart_api'
|
36
|
+
|
37
|
+
instance = UltracartClient::OrderUtm.new(
|
38
|
+
attribution_first_click_subtotal: null,
|
39
|
+
attribution_first_click_total: null,
|
40
|
+
attribution_last_click_subtotal: null,
|
41
|
+
attribution_last_click_total: null,
|
42
|
+
attribution_linear_subtotal: null,
|
43
|
+
attribution_linear_total: null,
|
44
|
+
attribution_position_based_subtotal: null,
|
45
|
+
attribution_position_based_total: null,
|
46
|
+
click_dts: null,
|
47
|
+
facebook_ad_id: null,
|
48
|
+
fbclid: null,
|
49
|
+
gbraid: null,
|
50
|
+
glcid: null,
|
51
|
+
msclkid: null,
|
52
|
+
ttclid: null,
|
53
|
+
uc_message_id: null,
|
54
|
+
utm_campaign: null,
|
55
|
+
utm_content: null,
|
56
|
+
utm_id: null,
|
57
|
+
utm_medium: null,
|
58
|
+
utm_source: null,
|
59
|
+
utm_term: null,
|
60
|
+
vmcid: null,
|
61
|
+
wbraid: null
|
62
|
+
)
|
63
|
+
```
|
64
|
+
|
data/docs/PricingTier.md
CHANGED
@@ -31,6 +31,7 @@
|
|
31
31
|
| **not_valid_when_coupon_present** | **Boolean** | Not valid when coupon present | [optional] |
|
32
32
|
| **pricing_tier_oid** | **Integer** | Pricing Tier Oid | [optional] |
|
33
33
|
| **realtime_percentage_discount** | **Float** | Realtime percentage discount | [optional] |
|
34
|
+
| **restrict_to_distribution_center_oid** | **Integer** | Restrict inventory to this distribution center oid | [optional] |
|
34
35
|
| **signup_notification** | [**PricingTierNotification**](PricingTierNotification.md) | | [optional] |
|
35
36
|
| **suppress_buysafe** | **Boolean** | Suppress buySAFE (deprecated) | [optional] |
|
36
37
|
| **suppress_mailing_list** | **Boolean** | Suppress mailing list | [optional] |
|
@@ -70,6 +71,7 @@ instance = UltracartClient::PricingTier.new(
|
|
70
71
|
not_valid_when_coupon_present: null,
|
71
72
|
pricing_tier_oid: null,
|
72
73
|
realtime_percentage_discount: null,
|
74
|
+
restrict_to_distribution_center_oid: null,
|
73
75
|
signup_notification: null,
|
74
76
|
suppress_buysafe: null,
|
75
77
|
suppress_mailing_list: null,
|
@@ -21,6 +21,9 @@ module UltracartClient
|
|
21
21
|
# Custom field 1
|
22
22
|
attr_accessor :custom_field1
|
23
23
|
|
24
|
+
# Custom field 10
|
25
|
+
attr_accessor :custom_field10
|
26
|
+
|
24
27
|
# Custom field 2
|
25
28
|
attr_accessor :custom_field2
|
26
29
|
|
@@ -39,6 +42,12 @@ module UltracartClient
|
|
39
42
|
# Custom field 7
|
40
43
|
attr_accessor :custom_field7
|
41
44
|
|
45
|
+
# Custom field 8
|
46
|
+
attr_accessor :custom_field8
|
47
|
+
|
48
|
+
# Custom field 9
|
49
|
+
attr_accessor :custom_field9
|
50
|
+
|
42
51
|
# IP Address (read only unless non-browser key authenticated)
|
43
52
|
attr_accessor :ip_address
|
44
53
|
|
@@ -62,12 +71,15 @@ module UltracartClient
|
|
62
71
|
{
|
63
72
|
:'comments' => :'comments',
|
64
73
|
:'custom_field1' => :'custom_field1',
|
74
|
+
:'custom_field10' => :'custom_field10',
|
65
75
|
:'custom_field2' => :'custom_field2',
|
66
76
|
:'custom_field3' => :'custom_field3',
|
67
77
|
:'custom_field4' => :'custom_field4',
|
68
78
|
:'custom_field5' => :'custom_field5',
|
69
79
|
:'custom_field6' => :'custom_field6',
|
70
80
|
:'custom_field7' => :'custom_field7',
|
81
|
+
:'custom_field8' => :'custom_field8',
|
82
|
+
:'custom_field9' => :'custom_field9',
|
71
83
|
:'ip_address' => :'ip_address',
|
72
84
|
:'return_code' => :'return_code',
|
73
85
|
:'return_url' => :'return_url',
|
@@ -87,12 +99,15 @@ module UltracartClient
|
|
87
99
|
{
|
88
100
|
:'comments' => :'String',
|
89
101
|
:'custom_field1' => :'String',
|
102
|
+
:'custom_field10' => :'String',
|
90
103
|
:'custom_field2' => :'String',
|
91
104
|
:'custom_field3' => :'String',
|
92
105
|
:'custom_field4' => :'String',
|
93
106
|
:'custom_field5' => :'String',
|
94
107
|
:'custom_field6' => :'String',
|
95
108
|
:'custom_field7' => :'String',
|
109
|
+
:'custom_field8' => :'String',
|
110
|
+
:'custom_field9' => :'String',
|
96
111
|
:'ip_address' => :'String',
|
97
112
|
:'return_code' => :'String',
|
98
113
|
:'return_url' => :'String',
|
@@ -131,6 +146,10 @@ module UltracartClient
|
|
131
146
|
self.custom_field1 = attributes[:'custom_field1']
|
132
147
|
end
|
133
148
|
|
149
|
+
if attributes.key?(:'custom_field10')
|
150
|
+
self.custom_field10 = attributes[:'custom_field10']
|
151
|
+
end
|
152
|
+
|
134
153
|
if attributes.key?(:'custom_field2')
|
135
154
|
self.custom_field2 = attributes[:'custom_field2']
|
136
155
|
end
|
@@ -155,6 +174,14 @@ module UltracartClient
|
|
155
174
|
self.custom_field7 = attributes[:'custom_field7']
|
156
175
|
end
|
157
176
|
|
177
|
+
if attributes.key?(:'custom_field8')
|
178
|
+
self.custom_field8 = attributes[:'custom_field8']
|
179
|
+
end
|
180
|
+
|
181
|
+
if attributes.key?(:'custom_field9')
|
182
|
+
self.custom_field9 = attributes[:'custom_field9']
|
183
|
+
end
|
184
|
+
|
158
185
|
if attributes.key?(:'ip_address')
|
159
186
|
self.ip_address = attributes[:'ip_address']
|
160
187
|
end
|
@@ -192,6 +219,10 @@ module UltracartClient
|
|
192
219
|
invalid_properties.push('invalid value for "custom_field1", the character length must be smaller than or equal to 50.')
|
193
220
|
end
|
194
221
|
|
222
|
+
if !@custom_field10.nil? && @custom_field10.to_s.length > 200
|
223
|
+
invalid_properties.push('invalid value for "custom_field10", the character length must be smaller than or equal to 200.')
|
224
|
+
end
|
225
|
+
|
195
226
|
if !@custom_field2.nil? && @custom_field2.to_s.length > 50
|
196
227
|
invalid_properties.push('invalid value for "custom_field2", the character length must be smaller than or equal to 50.')
|
197
228
|
end
|
@@ -216,6 +247,14 @@ module UltracartClient
|
|
216
247
|
invalid_properties.push('invalid value for "custom_field7", the character length must be smaller than or equal to 50.')
|
217
248
|
end
|
218
249
|
|
250
|
+
if !@custom_field8.nil? && @custom_field8.to_s.length > 200
|
251
|
+
invalid_properties.push('invalid value for "custom_field8", the character length must be smaller than or equal to 200.')
|
252
|
+
end
|
253
|
+
|
254
|
+
if !@custom_field9.nil? && @custom_field9.to_s.length > 200
|
255
|
+
invalid_properties.push('invalid value for "custom_field9", the character length must be smaller than or equal to 200.')
|
256
|
+
end
|
257
|
+
|
219
258
|
if !@return_url.nil? && @return_url.to_s.length > 2048
|
220
259
|
invalid_properties.push('invalid value for "return_url", the character length must be smaller than or equal to 2048.')
|
221
260
|
end
|
@@ -232,12 +271,15 @@ module UltracartClient
|
|
232
271
|
def valid?
|
233
272
|
return false if !@comments.nil? && @comments.to_s.length > 2000
|
234
273
|
return false if !@custom_field1.nil? && @custom_field1.to_s.length > 50
|
274
|
+
return false if !@custom_field10.nil? && @custom_field10.to_s.length > 200
|
235
275
|
return false if !@custom_field2.nil? && @custom_field2.to_s.length > 50
|
236
276
|
return false if !@custom_field3.nil? && @custom_field3.to_s.length > 50
|
237
277
|
return false if !@custom_field4.nil? && @custom_field4.to_s.length > 50
|
238
278
|
return false if !@custom_field5.nil? && @custom_field5.to_s.length > 75
|
239
279
|
return false if !@custom_field6.nil? && @custom_field6.to_s.length > 50
|
240
280
|
return false if !@custom_field7.nil? && @custom_field7.to_s.length > 50
|
281
|
+
return false if !@custom_field8.nil? && @custom_field8.to_s.length > 200
|
282
|
+
return false if !@custom_field9.nil? && @custom_field9.to_s.length > 200
|
241
283
|
return false if !@return_url.nil? && @return_url.to_s.length > 2048
|
242
284
|
return false if !@screen_branding_theme_code.nil? && @screen_branding_theme_code.to_s.length > 10
|
243
285
|
true
|
@@ -263,6 +305,16 @@ module UltracartClient
|
|
263
305
|
@custom_field1 = custom_field1
|
264
306
|
end
|
265
307
|
|
308
|
+
# Custom attribute writer method with validation
|
309
|
+
# @param [Object] custom_field10 Value to be assigned
|
310
|
+
def custom_field10=(custom_field10)
|
311
|
+
if !custom_field10.nil? && custom_field10.to_s.length > 200
|
312
|
+
fail ArgumentError, 'invalid value for "custom_field10", the character length must be smaller than or equal to 200.'
|
313
|
+
end
|
314
|
+
|
315
|
+
@custom_field10 = custom_field10
|
316
|
+
end
|
317
|
+
|
266
318
|
# Custom attribute writer method with validation
|
267
319
|
# @param [Object] custom_field2 Value to be assigned
|
268
320
|
def custom_field2=(custom_field2)
|
@@ -323,6 +375,26 @@ module UltracartClient
|
|
323
375
|
@custom_field7 = custom_field7
|
324
376
|
end
|
325
377
|
|
378
|
+
# Custom attribute writer method with validation
|
379
|
+
# @param [Object] custom_field8 Value to be assigned
|
380
|
+
def custom_field8=(custom_field8)
|
381
|
+
if !custom_field8.nil? && custom_field8.to_s.length > 200
|
382
|
+
fail ArgumentError, 'invalid value for "custom_field8", the character length must be smaller than or equal to 200.'
|
383
|
+
end
|
384
|
+
|
385
|
+
@custom_field8 = custom_field8
|
386
|
+
end
|
387
|
+
|
388
|
+
# Custom attribute writer method with validation
|
389
|
+
# @param [Object] custom_field9 Value to be assigned
|
390
|
+
def custom_field9=(custom_field9)
|
391
|
+
if !custom_field9.nil? && custom_field9.to_s.length > 200
|
392
|
+
fail ArgumentError, 'invalid value for "custom_field9", the character length must be smaller than or equal to 200.'
|
393
|
+
end
|
394
|
+
|
395
|
+
@custom_field9 = custom_field9
|
396
|
+
end
|
397
|
+
|
326
398
|
# Custom attribute writer method with validation
|
327
399
|
# @param [Object] return_url Value to be assigned
|
328
400
|
def return_url=(return_url)
|
@@ -350,12 +422,15 @@ module UltracartClient
|
|
350
422
|
self.class == o.class &&
|
351
423
|
comments == o.comments &&
|
352
424
|
custom_field1 == o.custom_field1 &&
|
425
|
+
custom_field10 == o.custom_field10 &&
|
353
426
|
custom_field2 == o.custom_field2 &&
|
354
427
|
custom_field3 == o.custom_field3 &&
|
355
428
|
custom_field4 == o.custom_field4 &&
|
356
429
|
custom_field5 == o.custom_field5 &&
|
357
430
|
custom_field6 == o.custom_field6 &&
|
358
431
|
custom_field7 == o.custom_field7 &&
|
432
|
+
custom_field8 == o.custom_field8 &&
|
433
|
+
custom_field9 == o.custom_field9 &&
|
359
434
|
ip_address == o.ip_address &&
|
360
435
|
return_code == o.return_code &&
|
361
436
|
return_url == o.return_url &&
|
@@ -373,7 +448,7 @@ module UltracartClient
|
|
373
448
|
# Calculates hash code according to all attributes.
|
374
449
|
# @return [Integer] Hash code
|
375
450
|
def hash
|
376
|
-
[comments, custom_field1, custom_field2, custom_field3, custom_field4, custom_field5, custom_field6, custom_field7, ip_address, return_code, return_url, screen_branding_theme_code, storefront_host_name, user_agent].hash
|
451
|
+
[comments, custom_field1, custom_field10, custom_field2, custom_field3, custom_field4, custom_field5, custom_field6, custom_field7, custom_field8, custom_field9, ip_address, return_code, return_url, screen_branding_theme_code, storefront_host_name, user_agent].hash
|
377
452
|
end
|
378
453
|
|
379
454
|
# Builds the object from hash
|
@@ -21,6 +21,8 @@ module UltracartClient
|
|
21
21
|
|
22
22
|
attr_accessor :max_hits
|
23
23
|
|
24
|
+
attr_accessor :storefront_host_name
|
25
|
+
|
24
26
|
attr_accessor :storefront_oid
|
25
27
|
|
26
28
|
attr_accessor :subcategory
|
@@ -31,6 +33,7 @@ module UltracartClient
|
|
31
33
|
:'category' => :'category',
|
32
34
|
:'matches' => :'matches',
|
33
35
|
:'max_hits' => :'max_hits',
|
36
|
+
:'storefront_host_name' => :'storefront_host_name',
|
34
37
|
:'storefront_oid' => :'storefront_oid',
|
35
38
|
:'subcategory' => :'subcategory'
|
36
39
|
}
|
@@ -47,6 +50,7 @@ module UltracartClient
|
|
47
50
|
:'category' => :'String',
|
48
51
|
:'matches' => :'String',
|
49
52
|
:'max_hits' => :'Integer',
|
53
|
+
:'storefront_host_name' => :'String',
|
50
54
|
:'storefront_oid' => :'Integer',
|
51
55
|
:'subcategory' => :'String'
|
52
56
|
}
|
@@ -85,6 +89,10 @@ module UltracartClient
|
|
85
89
|
self.max_hits = attributes[:'max_hits']
|
86
90
|
end
|
87
91
|
|
92
|
+
if attributes.key?(:'storefront_host_name')
|
93
|
+
self.storefront_host_name = attributes[:'storefront_host_name']
|
94
|
+
end
|
95
|
+
|
88
96
|
if attributes.key?(:'storefront_oid')
|
89
97
|
self.storefront_oid = attributes[:'storefront_oid']
|
90
98
|
end
|
@@ -115,6 +123,7 @@ module UltracartClient
|
|
115
123
|
category == o.category &&
|
116
124
|
matches == o.matches &&
|
117
125
|
max_hits == o.max_hits &&
|
126
|
+
storefront_host_name == o.storefront_host_name &&
|
118
127
|
storefront_oid == o.storefront_oid &&
|
119
128
|
subcategory == o.subcategory
|
120
129
|
end
|
@@ -128,7 +137,7 @@ module UltracartClient
|
|
128
137
|
# Calculates hash code according to all attributes.
|
129
138
|
# @return [Integer] Hash code
|
130
139
|
def hash
|
131
|
-
[category, matches, max_hits, storefront_oid, subcategory].hash
|
140
|
+
[category, matches, max_hits, storefront_host_name, storefront_oid, subcategory].hash
|
132
141
|
end
|
133
142
|
|
134
143
|
# Builds the object from hash
|
@@ -99,6 +99,9 @@ module UltracartClient
|
|
99
99
|
|
100
100
|
attr_accessor :taxes
|
101
101
|
|
102
|
+
# UTM clicks. The zero index is the most recent (last) UTM click
|
103
|
+
attr_accessor :utms
|
104
|
+
|
102
105
|
class EnumAttributeValidator
|
103
106
|
attr_reader :datatype
|
104
107
|
attr_reader :allowable_values
|
@@ -158,7 +161,8 @@ module UltracartClient
|
|
158
161
|
:'shipping' => :'shipping',
|
159
162
|
:'summary' => :'summary',
|
160
163
|
:'tags' => :'Tags',
|
161
|
-
:'taxes' => :'taxes'
|
164
|
+
:'taxes' => :'taxes',
|
165
|
+
:'utms' => :'utms'
|
162
166
|
}
|
163
167
|
end
|
164
168
|
|
@@ -204,7 +208,8 @@ module UltracartClient
|
|
204
208
|
:'shipping' => :'OrderShipping',
|
205
209
|
:'summary' => :'OrderSummary',
|
206
210
|
:'tags' => :'Array<OrderTag>',
|
207
|
-
:'taxes' => :'OrderTaxes'
|
211
|
+
:'taxes' => :'OrderTaxes',
|
212
|
+
:'utms' => :'Array<OrderUtm>'
|
208
213
|
}
|
209
214
|
end
|
210
215
|
|
@@ -378,6 +383,12 @@ module UltracartClient
|
|
378
383
|
if attributes.key?(:'taxes')
|
379
384
|
self.taxes = attributes[:'taxes']
|
380
385
|
end
|
386
|
+
|
387
|
+
if attributes.key?(:'utms')
|
388
|
+
if (value = attributes[:'utms']).is_a?(Array)
|
389
|
+
self.utms = value
|
390
|
+
end
|
391
|
+
end
|
381
392
|
end
|
382
393
|
|
383
394
|
# Show invalid properties with the reasons. Usually used together with valid?
|
@@ -474,7 +485,8 @@ module UltracartClient
|
|
474
485
|
shipping == o.shipping &&
|
475
486
|
summary == o.summary &&
|
476
487
|
tags == o.tags &&
|
477
|
-
taxes == o.taxes
|
488
|
+
taxes == o.taxes &&
|
489
|
+
utms == o.utms
|
478
490
|
end
|
479
491
|
|
480
492
|
# @see the `==` method
|
@@ -486,7 +498,7 @@ module UltracartClient
|
|
486
498
|
# Calculates hash code according to all attributes.
|
487
499
|
# @return [Integer] Hash code
|
488
500
|
def hash
|
489
|
-
[affiliates, auto_order, billing, buysafe, channel_partner, checkout, coupons, creation_dts, currency_code, current_stage, customer_profile, digital_order, edi, exchange_rate, fraud_score, gift, gift_certificate, internal, items, language_iso_code, linked_shipment, marketing, merchant_id, order_id, payment, point_of_sale, properties, quote, refund_dts, reject_dts, salesforce, shipping, summary, tags, taxes].hash
|
501
|
+
[affiliates, auto_order, billing, buysafe, channel_partner, checkout, coupons, creation_dts, currency_code, current_stage, customer_profile, digital_order, edi, exchange_rate, fraud_score, gift, gift_certificate, internal, items, language_iso_code, linked_shipment, marketing, merchant_id, order_id, payment, point_of_sale, properties, quote, refund_dts, reject_dts, salesforce, shipping, summary, tags, taxes, utms].hash
|
490
502
|
end
|
491
503
|
|
492
504
|
# Builds the object from hash
|
@@ -23,6 +23,9 @@ module UltracartClient
|
|
23
23
|
# Custom field 1
|
24
24
|
attr_accessor :custom_field1
|
25
25
|
|
26
|
+
# Custom field 10
|
27
|
+
attr_accessor :custom_field10
|
28
|
+
|
26
29
|
# Custom field 2
|
27
30
|
attr_accessor :custom_field2
|
28
31
|
|
@@ -41,6 +44,12 @@ module UltracartClient
|
|
41
44
|
# Custom field 7
|
42
45
|
attr_accessor :custom_field7
|
43
46
|
|
47
|
+
# Custom field 8
|
48
|
+
attr_accessor :custom_field8
|
49
|
+
|
50
|
+
# Custom field 9
|
51
|
+
attr_accessor :custom_field9
|
52
|
+
|
44
53
|
# IP address of the customer when placing the order
|
45
54
|
attr_accessor :customer_ip_address
|
46
55
|
|
@@ -62,12 +71,15 @@ module UltracartClient
|
|
62
71
|
:'browser' => :'browser',
|
63
72
|
:'comments' => :'comments',
|
64
73
|
:'custom_field1' => :'custom_field1',
|
74
|
+
:'custom_field10' => :'custom_field10',
|
65
75
|
:'custom_field2' => :'custom_field2',
|
66
76
|
:'custom_field3' => :'custom_field3',
|
67
77
|
:'custom_field4' => :'custom_field4',
|
68
78
|
:'custom_field5' => :'custom_field5',
|
69
79
|
:'custom_field6' => :'custom_field6',
|
70
80
|
:'custom_field7' => :'custom_field7',
|
81
|
+
:'custom_field8' => :'custom_field8',
|
82
|
+
:'custom_field9' => :'custom_field9',
|
71
83
|
:'customer_ip_address' => :'customer_ip_address',
|
72
84
|
:'screen_branding_theme_code' => :'screen_branding_theme_code',
|
73
85
|
:'screen_size' => :'screen_size',
|
@@ -87,12 +99,15 @@ module UltracartClient
|
|
87
99
|
:'browser' => :'Browser',
|
88
100
|
:'comments' => :'String',
|
89
101
|
:'custom_field1' => :'String',
|
102
|
+
:'custom_field10' => :'String',
|
90
103
|
:'custom_field2' => :'String',
|
91
104
|
:'custom_field3' => :'String',
|
92
105
|
:'custom_field4' => :'String',
|
93
106
|
:'custom_field5' => :'String',
|
94
107
|
:'custom_field6' => :'String',
|
95
108
|
:'custom_field7' => :'String',
|
109
|
+
:'custom_field8' => :'String',
|
110
|
+
:'custom_field9' => :'String',
|
96
111
|
:'customer_ip_address' => :'String',
|
97
112
|
:'screen_branding_theme_code' => :'String',
|
98
113
|
:'screen_size' => :'String',
|
@@ -134,6 +149,10 @@ module UltracartClient
|
|
134
149
|
self.custom_field1 = attributes[:'custom_field1']
|
135
150
|
end
|
136
151
|
|
152
|
+
if attributes.key?(:'custom_field10')
|
153
|
+
self.custom_field10 = attributes[:'custom_field10']
|
154
|
+
end
|
155
|
+
|
137
156
|
if attributes.key?(:'custom_field2')
|
138
157
|
self.custom_field2 = attributes[:'custom_field2']
|
139
158
|
end
|
@@ -158,6 +177,14 @@ module UltracartClient
|
|
158
177
|
self.custom_field7 = attributes[:'custom_field7']
|
159
178
|
end
|
160
179
|
|
180
|
+
if attributes.key?(:'custom_field8')
|
181
|
+
self.custom_field8 = attributes[:'custom_field8']
|
182
|
+
end
|
183
|
+
|
184
|
+
if attributes.key?(:'custom_field9')
|
185
|
+
self.custom_field9 = attributes[:'custom_field9']
|
186
|
+
end
|
187
|
+
|
161
188
|
if attributes.key?(:'customer_ip_address')
|
162
189
|
self.customer_ip_address = attributes[:'customer_ip_address']
|
163
190
|
end
|
@@ -187,6 +214,10 @@ module UltracartClient
|
|
187
214
|
invalid_properties.push('invalid value for "custom_field1", the character length must be smaller than or equal to 50.')
|
188
215
|
end
|
189
216
|
|
217
|
+
if !@custom_field10.nil? && @custom_field10.to_s.length > 200
|
218
|
+
invalid_properties.push('invalid value for "custom_field10", the character length must be smaller than or equal to 200.')
|
219
|
+
end
|
220
|
+
|
190
221
|
if !@custom_field2.nil? && @custom_field2.to_s.length > 50
|
191
222
|
invalid_properties.push('invalid value for "custom_field2", the character length must be smaller than or equal to 50.')
|
192
223
|
end
|
@@ -211,6 +242,14 @@ module UltracartClient
|
|
211
242
|
invalid_properties.push('invalid value for "custom_field7", the character length must be smaller than or equal to 50.')
|
212
243
|
end
|
213
244
|
|
245
|
+
if !@custom_field8.nil? && @custom_field8.to_s.length > 200
|
246
|
+
invalid_properties.push('invalid value for "custom_field8", the character length must be smaller than or equal to 200.')
|
247
|
+
end
|
248
|
+
|
249
|
+
if !@custom_field9.nil? && @custom_field9.to_s.length > 200
|
250
|
+
invalid_properties.push('invalid value for "custom_field9", the character length must be smaller than or equal to 200.')
|
251
|
+
end
|
252
|
+
|
214
253
|
if !@screen_branding_theme_code.nil? && @screen_branding_theme_code.to_s.length > 10
|
215
254
|
invalid_properties.push('invalid value for "screen_branding_theme_code", the character length must be smaller than or equal to 10.')
|
216
255
|
end
|
@@ -222,12 +261,15 @@ module UltracartClient
|
|
222
261
|
# @return true if the model is valid
|
223
262
|
def valid?
|
224
263
|
return false if !@custom_field1.nil? && @custom_field1.to_s.length > 50
|
264
|
+
return false if !@custom_field10.nil? && @custom_field10.to_s.length > 200
|
225
265
|
return false if !@custom_field2.nil? && @custom_field2.to_s.length > 50
|
226
266
|
return false if !@custom_field3.nil? && @custom_field3.to_s.length > 50
|
227
267
|
return false if !@custom_field4.nil? && @custom_field4.to_s.length > 50
|
228
268
|
return false if !@custom_field5.nil? && @custom_field5.to_s.length > 75
|
229
269
|
return false if !@custom_field6.nil? && @custom_field6.to_s.length > 50
|
230
270
|
return false if !@custom_field7.nil? && @custom_field7.to_s.length > 50
|
271
|
+
return false if !@custom_field8.nil? && @custom_field8.to_s.length > 200
|
272
|
+
return false if !@custom_field9.nil? && @custom_field9.to_s.length > 200
|
231
273
|
return false if !@screen_branding_theme_code.nil? && @screen_branding_theme_code.to_s.length > 10
|
232
274
|
true
|
233
275
|
end
|
@@ -242,6 +284,16 @@ module UltracartClient
|
|
242
284
|
@custom_field1 = custom_field1
|
243
285
|
end
|
244
286
|
|
287
|
+
# Custom attribute writer method with validation
|
288
|
+
# @param [Object] custom_field10 Value to be assigned
|
289
|
+
def custom_field10=(custom_field10)
|
290
|
+
if !custom_field10.nil? && custom_field10.to_s.length > 200
|
291
|
+
fail ArgumentError, 'invalid value for "custom_field10", the character length must be smaller than or equal to 200.'
|
292
|
+
end
|
293
|
+
|
294
|
+
@custom_field10 = custom_field10
|
295
|
+
end
|
296
|
+
|
245
297
|
# Custom attribute writer method with validation
|
246
298
|
# @param [Object] custom_field2 Value to be assigned
|
247
299
|
def custom_field2=(custom_field2)
|
@@ -302,6 +354,26 @@ module UltracartClient
|
|
302
354
|
@custom_field7 = custom_field7
|
303
355
|
end
|
304
356
|
|
357
|
+
# Custom attribute writer method with validation
|
358
|
+
# @param [Object] custom_field8 Value to be assigned
|
359
|
+
def custom_field8=(custom_field8)
|
360
|
+
if !custom_field8.nil? && custom_field8.to_s.length > 200
|
361
|
+
fail ArgumentError, 'invalid value for "custom_field8", the character length must be smaller than or equal to 200.'
|
362
|
+
end
|
363
|
+
|
364
|
+
@custom_field8 = custom_field8
|
365
|
+
end
|
366
|
+
|
367
|
+
# Custom attribute writer method with validation
|
368
|
+
# @param [Object] custom_field9 Value to be assigned
|
369
|
+
def custom_field9=(custom_field9)
|
370
|
+
if !custom_field9.nil? && custom_field9.to_s.length > 200
|
371
|
+
fail ArgumentError, 'invalid value for "custom_field9", the character length must be smaller than or equal to 200.'
|
372
|
+
end
|
373
|
+
|
374
|
+
@custom_field9 = custom_field9
|
375
|
+
end
|
376
|
+
|
305
377
|
# Custom attribute writer method with validation
|
306
378
|
# @param [Object] screen_branding_theme_code Value to be assigned
|
307
379
|
def screen_branding_theme_code=(screen_branding_theme_code)
|
@@ -320,12 +392,15 @@ module UltracartClient
|
|
320
392
|
browser == o.browser &&
|
321
393
|
comments == o.comments &&
|
322
394
|
custom_field1 == o.custom_field1 &&
|
395
|
+
custom_field10 == o.custom_field10 &&
|
323
396
|
custom_field2 == o.custom_field2 &&
|
324
397
|
custom_field3 == o.custom_field3 &&
|
325
398
|
custom_field4 == o.custom_field4 &&
|
326
399
|
custom_field5 == o.custom_field5 &&
|
327
400
|
custom_field6 == o.custom_field6 &&
|
328
401
|
custom_field7 == o.custom_field7 &&
|
402
|
+
custom_field8 == o.custom_field8 &&
|
403
|
+
custom_field9 == o.custom_field9 &&
|
329
404
|
customer_ip_address == o.customer_ip_address &&
|
330
405
|
screen_branding_theme_code == o.screen_branding_theme_code &&
|
331
406
|
screen_size == o.screen_size &&
|
@@ -342,7 +417,7 @@ module UltracartClient
|
|
342
417
|
# Calculates hash code according to all attributes.
|
343
418
|
# @return [Integer] Hash code
|
344
419
|
def hash
|
345
|
-
[browser, comments, custom_field1, custom_field2, custom_field3, custom_field4, custom_field5, custom_field6, custom_field7, customer_ip_address, screen_branding_theme_code, screen_size, storefront_host_name, upsell_path_code].hash
|
420
|
+
[browser, comments, custom_field1, custom_field10, custom_field2, custom_field3, custom_field4, custom_field5, custom_field6, custom_field7, custom_field8, custom_field9, customer_ip_address, screen_branding_theme_code, screen_size, storefront_host_name, upsell_path_code].hash
|
346
421
|
end
|
347
422
|
|
348
423
|
# Builds the object from hash
|
@@ -0,0 +1,427 @@
|
|
1
|
+
=begin
|
2
|
+
#UltraCart Rest API V2
|
3
|
+
|
4
|
+
#UltraCart REST API Version 2
|
5
|
+
|
6
|
+
The version of the OpenAPI document: 2.0.0
|
7
|
+
Contact: support@ultracart.com
|
8
|
+
Generated by: https://openapi-generator.tech
|
9
|
+
OpenAPI Generator version: 6.0.1-SNAPSHOT
|
10
|
+
|
11
|
+
=end
|
12
|
+
|
13
|
+
require 'date'
|
14
|
+
require 'time'
|
15
|
+
|
16
|
+
module UltracartClient
|
17
|
+
class OrderUtm
|
18
|
+
attr_accessor :attribution_first_click_subtotal
|
19
|
+
|
20
|
+
attr_accessor :attribution_first_click_total
|
21
|
+
|
22
|
+
attr_accessor :attribution_last_click_subtotal
|
23
|
+
|
24
|
+
attr_accessor :attribution_last_click_total
|
25
|
+
|
26
|
+
attr_accessor :attribution_linear_subtotal
|
27
|
+
|
28
|
+
attr_accessor :attribution_linear_total
|
29
|
+
|
30
|
+
attr_accessor :attribution_position_based_subtotal
|
31
|
+
|
32
|
+
attr_accessor :attribution_position_based_total
|
33
|
+
|
34
|
+
# Date/time that the click happened
|
35
|
+
attr_accessor :click_dts
|
36
|
+
|
37
|
+
attr_accessor :facebook_ad_id
|
38
|
+
|
39
|
+
attr_accessor :fbclid
|
40
|
+
|
41
|
+
attr_accessor :gbraid
|
42
|
+
|
43
|
+
attr_accessor :glcid
|
44
|
+
|
45
|
+
attr_accessor :msclkid
|
46
|
+
|
47
|
+
attr_accessor :ttclid
|
48
|
+
|
49
|
+
attr_accessor :uc_message_id
|
50
|
+
|
51
|
+
attr_accessor :utm_campaign
|
52
|
+
|
53
|
+
attr_accessor :utm_content
|
54
|
+
|
55
|
+
attr_accessor :utm_id
|
56
|
+
|
57
|
+
attr_accessor :utm_medium
|
58
|
+
|
59
|
+
attr_accessor :utm_source
|
60
|
+
|
61
|
+
attr_accessor :utm_term
|
62
|
+
|
63
|
+
attr_accessor :vmcid
|
64
|
+
|
65
|
+
attr_accessor :wbraid
|
66
|
+
|
67
|
+
# Attribute mapping from ruby-style variable name to JSON key.
|
68
|
+
def self.attribute_map
|
69
|
+
{
|
70
|
+
:'attribution_first_click_subtotal' => :'attribution_first_click_subtotal',
|
71
|
+
:'attribution_first_click_total' => :'attribution_first_click_total',
|
72
|
+
:'attribution_last_click_subtotal' => :'attribution_last_click_subtotal',
|
73
|
+
:'attribution_last_click_total' => :'attribution_last_click_total',
|
74
|
+
:'attribution_linear_subtotal' => :'attribution_linear_subtotal',
|
75
|
+
:'attribution_linear_total' => :'attribution_linear_total',
|
76
|
+
:'attribution_position_based_subtotal' => :'attribution_position_based_subtotal',
|
77
|
+
:'attribution_position_based_total' => :'attribution_position_based_total',
|
78
|
+
:'click_dts' => :'click_dts',
|
79
|
+
:'facebook_ad_id' => :'facebook_ad_id',
|
80
|
+
:'fbclid' => :'fbclid',
|
81
|
+
:'gbraid' => :'gbraid',
|
82
|
+
:'glcid' => :'glcid',
|
83
|
+
:'msclkid' => :'msclkid',
|
84
|
+
:'ttclid' => :'ttclid',
|
85
|
+
:'uc_message_id' => :'uc_message_id',
|
86
|
+
:'utm_campaign' => :'utm_campaign',
|
87
|
+
:'utm_content' => :'utm_content',
|
88
|
+
:'utm_id' => :'utm_id',
|
89
|
+
:'utm_medium' => :'utm_medium',
|
90
|
+
:'utm_source' => :'utm_source',
|
91
|
+
:'utm_term' => :'utm_term',
|
92
|
+
:'vmcid' => :'vmcid',
|
93
|
+
:'wbraid' => :'wbraid'
|
94
|
+
}
|
95
|
+
end
|
96
|
+
|
97
|
+
# Returns all the JSON keys this model knows about
|
98
|
+
def self.acceptable_attributes
|
99
|
+
attribute_map.values
|
100
|
+
end
|
101
|
+
|
102
|
+
# Attribute type mapping.
|
103
|
+
def self.openapi_types
|
104
|
+
{
|
105
|
+
:'attribution_first_click_subtotal' => :'Float',
|
106
|
+
:'attribution_first_click_total' => :'Float',
|
107
|
+
:'attribution_last_click_subtotal' => :'Float',
|
108
|
+
:'attribution_last_click_total' => :'Float',
|
109
|
+
:'attribution_linear_subtotal' => :'Float',
|
110
|
+
:'attribution_linear_total' => :'Float',
|
111
|
+
:'attribution_position_based_subtotal' => :'Float',
|
112
|
+
:'attribution_position_based_total' => :'Float',
|
113
|
+
:'click_dts' => :'String',
|
114
|
+
:'facebook_ad_id' => :'String',
|
115
|
+
:'fbclid' => :'String',
|
116
|
+
:'gbraid' => :'String',
|
117
|
+
:'glcid' => :'String',
|
118
|
+
:'msclkid' => :'String',
|
119
|
+
:'ttclid' => :'String',
|
120
|
+
:'uc_message_id' => :'String',
|
121
|
+
:'utm_campaign' => :'String',
|
122
|
+
:'utm_content' => :'String',
|
123
|
+
:'utm_id' => :'String',
|
124
|
+
:'utm_medium' => :'String',
|
125
|
+
:'utm_source' => :'String',
|
126
|
+
:'utm_term' => :'String',
|
127
|
+
:'vmcid' => :'String',
|
128
|
+
:'wbraid' => :'String'
|
129
|
+
}
|
130
|
+
end
|
131
|
+
|
132
|
+
# List of attributes with nullable: true
|
133
|
+
def self.openapi_nullable
|
134
|
+
Set.new([
|
135
|
+
])
|
136
|
+
end
|
137
|
+
|
138
|
+
# Initializes the object
|
139
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
140
|
+
def initialize(attributes = {})
|
141
|
+
if (!attributes.is_a?(Hash))
|
142
|
+
fail ArgumentError, "The input argument (attributes) must be a hash in `UltracartClient::OrderUtm` initialize method"
|
143
|
+
end
|
144
|
+
|
145
|
+
# check to see if the attribute exists and convert string to symbol for hash key
|
146
|
+
attributes = attributes.each_with_object({}) { |(k, v), h|
|
147
|
+
if (!self.class.attribute_map.key?(k.to_sym))
|
148
|
+
fail ArgumentError, "`#{k}` is not a valid attribute in `UltracartClient::OrderUtm`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
|
149
|
+
end
|
150
|
+
h[k.to_sym] = v
|
151
|
+
}
|
152
|
+
|
153
|
+
if attributes.key?(:'attribution_first_click_subtotal')
|
154
|
+
self.attribution_first_click_subtotal = attributes[:'attribution_first_click_subtotal']
|
155
|
+
end
|
156
|
+
|
157
|
+
if attributes.key?(:'attribution_first_click_total')
|
158
|
+
self.attribution_first_click_total = attributes[:'attribution_first_click_total']
|
159
|
+
end
|
160
|
+
|
161
|
+
if attributes.key?(:'attribution_last_click_subtotal')
|
162
|
+
self.attribution_last_click_subtotal = attributes[:'attribution_last_click_subtotal']
|
163
|
+
end
|
164
|
+
|
165
|
+
if attributes.key?(:'attribution_last_click_total')
|
166
|
+
self.attribution_last_click_total = attributes[:'attribution_last_click_total']
|
167
|
+
end
|
168
|
+
|
169
|
+
if attributes.key?(:'attribution_linear_subtotal')
|
170
|
+
self.attribution_linear_subtotal = attributes[:'attribution_linear_subtotal']
|
171
|
+
end
|
172
|
+
|
173
|
+
if attributes.key?(:'attribution_linear_total')
|
174
|
+
self.attribution_linear_total = attributes[:'attribution_linear_total']
|
175
|
+
end
|
176
|
+
|
177
|
+
if attributes.key?(:'attribution_position_based_subtotal')
|
178
|
+
self.attribution_position_based_subtotal = attributes[:'attribution_position_based_subtotal']
|
179
|
+
end
|
180
|
+
|
181
|
+
if attributes.key?(:'attribution_position_based_total')
|
182
|
+
self.attribution_position_based_total = attributes[:'attribution_position_based_total']
|
183
|
+
end
|
184
|
+
|
185
|
+
if attributes.key?(:'click_dts')
|
186
|
+
self.click_dts = attributes[:'click_dts']
|
187
|
+
end
|
188
|
+
|
189
|
+
if attributes.key?(:'facebook_ad_id')
|
190
|
+
self.facebook_ad_id = attributes[:'facebook_ad_id']
|
191
|
+
end
|
192
|
+
|
193
|
+
if attributes.key?(:'fbclid')
|
194
|
+
self.fbclid = attributes[:'fbclid']
|
195
|
+
end
|
196
|
+
|
197
|
+
if attributes.key?(:'gbraid')
|
198
|
+
self.gbraid = attributes[:'gbraid']
|
199
|
+
end
|
200
|
+
|
201
|
+
if attributes.key?(:'glcid')
|
202
|
+
self.glcid = attributes[:'glcid']
|
203
|
+
end
|
204
|
+
|
205
|
+
if attributes.key?(:'msclkid')
|
206
|
+
self.msclkid = attributes[:'msclkid']
|
207
|
+
end
|
208
|
+
|
209
|
+
if attributes.key?(:'ttclid')
|
210
|
+
self.ttclid = attributes[:'ttclid']
|
211
|
+
end
|
212
|
+
|
213
|
+
if attributes.key?(:'uc_message_id')
|
214
|
+
self.uc_message_id = attributes[:'uc_message_id']
|
215
|
+
end
|
216
|
+
|
217
|
+
if attributes.key?(:'utm_campaign')
|
218
|
+
self.utm_campaign = attributes[:'utm_campaign']
|
219
|
+
end
|
220
|
+
|
221
|
+
if attributes.key?(:'utm_content')
|
222
|
+
self.utm_content = attributes[:'utm_content']
|
223
|
+
end
|
224
|
+
|
225
|
+
if attributes.key?(:'utm_id')
|
226
|
+
self.utm_id = attributes[:'utm_id']
|
227
|
+
end
|
228
|
+
|
229
|
+
if attributes.key?(:'utm_medium')
|
230
|
+
self.utm_medium = attributes[:'utm_medium']
|
231
|
+
end
|
232
|
+
|
233
|
+
if attributes.key?(:'utm_source')
|
234
|
+
self.utm_source = attributes[:'utm_source']
|
235
|
+
end
|
236
|
+
|
237
|
+
if attributes.key?(:'utm_term')
|
238
|
+
self.utm_term = attributes[:'utm_term']
|
239
|
+
end
|
240
|
+
|
241
|
+
if attributes.key?(:'vmcid')
|
242
|
+
self.vmcid = attributes[:'vmcid']
|
243
|
+
end
|
244
|
+
|
245
|
+
if attributes.key?(:'wbraid')
|
246
|
+
self.wbraid = attributes[:'wbraid']
|
247
|
+
end
|
248
|
+
end
|
249
|
+
|
250
|
+
# Show invalid properties with the reasons. Usually used together with valid?
|
251
|
+
# @return Array for valid properties with the reasons
|
252
|
+
def list_invalid_properties
|
253
|
+
invalid_properties = Array.new
|
254
|
+
invalid_properties
|
255
|
+
end
|
256
|
+
|
257
|
+
# Check to see if the all the properties in the model are valid
|
258
|
+
# @return true if the model is valid
|
259
|
+
def valid?
|
260
|
+
true
|
261
|
+
end
|
262
|
+
|
263
|
+
# Checks equality by comparing each attribute.
|
264
|
+
# @param [Object] Object to be compared
|
265
|
+
def ==(o)
|
266
|
+
return true if self.equal?(o)
|
267
|
+
self.class == o.class &&
|
268
|
+
attribution_first_click_subtotal == o.attribution_first_click_subtotal &&
|
269
|
+
attribution_first_click_total == o.attribution_first_click_total &&
|
270
|
+
attribution_last_click_subtotal == o.attribution_last_click_subtotal &&
|
271
|
+
attribution_last_click_total == o.attribution_last_click_total &&
|
272
|
+
attribution_linear_subtotal == o.attribution_linear_subtotal &&
|
273
|
+
attribution_linear_total == o.attribution_linear_total &&
|
274
|
+
attribution_position_based_subtotal == o.attribution_position_based_subtotal &&
|
275
|
+
attribution_position_based_total == o.attribution_position_based_total &&
|
276
|
+
click_dts == o.click_dts &&
|
277
|
+
facebook_ad_id == o.facebook_ad_id &&
|
278
|
+
fbclid == o.fbclid &&
|
279
|
+
gbraid == o.gbraid &&
|
280
|
+
glcid == o.glcid &&
|
281
|
+
msclkid == o.msclkid &&
|
282
|
+
ttclid == o.ttclid &&
|
283
|
+
uc_message_id == o.uc_message_id &&
|
284
|
+
utm_campaign == o.utm_campaign &&
|
285
|
+
utm_content == o.utm_content &&
|
286
|
+
utm_id == o.utm_id &&
|
287
|
+
utm_medium == o.utm_medium &&
|
288
|
+
utm_source == o.utm_source &&
|
289
|
+
utm_term == o.utm_term &&
|
290
|
+
vmcid == o.vmcid &&
|
291
|
+
wbraid == o.wbraid
|
292
|
+
end
|
293
|
+
|
294
|
+
# @see the `==` method
|
295
|
+
# @param [Object] Object to be compared
|
296
|
+
def eql?(o)
|
297
|
+
self == o
|
298
|
+
end
|
299
|
+
|
300
|
+
# Calculates hash code according to all attributes.
|
301
|
+
# @return [Integer] Hash code
|
302
|
+
def hash
|
303
|
+
[attribution_first_click_subtotal, attribution_first_click_total, attribution_last_click_subtotal, attribution_last_click_total, attribution_linear_subtotal, attribution_linear_total, attribution_position_based_subtotal, attribution_position_based_total, click_dts, facebook_ad_id, fbclid, gbraid, glcid, msclkid, ttclid, uc_message_id, utm_campaign, utm_content, utm_id, utm_medium, utm_source, utm_term, vmcid, wbraid].hash
|
304
|
+
end
|
305
|
+
|
306
|
+
# Builds the object from hash
|
307
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
308
|
+
# @return [Object] Returns the model itself
|
309
|
+
def self.build_from_hash(attributes)
|
310
|
+
new.build_from_hash(attributes)
|
311
|
+
end
|
312
|
+
|
313
|
+
# Builds the object from hash
|
314
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
315
|
+
# @return [Object] Returns the model itself
|
316
|
+
def build_from_hash(attributes)
|
317
|
+
return nil unless attributes.is_a?(Hash)
|
318
|
+
attributes = attributes.transform_keys(&:to_sym)
|
319
|
+
self.class.openapi_types.each_pair do |key, type|
|
320
|
+
if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
|
321
|
+
self.send("#{key}=", nil)
|
322
|
+
elsif type =~ /\AArray<(.*)>/i
|
323
|
+
# check to ensure the input is an array given that the attribute
|
324
|
+
# is documented as an array but the input is not
|
325
|
+
if attributes[self.class.attribute_map[key]].is_a?(Array)
|
326
|
+
self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
|
327
|
+
end
|
328
|
+
elsif !attributes[self.class.attribute_map[key]].nil?
|
329
|
+
self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
|
330
|
+
end
|
331
|
+
end
|
332
|
+
|
333
|
+
self
|
334
|
+
end
|
335
|
+
|
336
|
+
# Deserializes the data based on type
|
337
|
+
# @param string type Data type
|
338
|
+
# @param string value Value to be deserialized
|
339
|
+
# @return [Object] Deserialized data
|
340
|
+
def _deserialize(type, value)
|
341
|
+
case type.to_sym
|
342
|
+
when :Time
|
343
|
+
Time.parse(value)
|
344
|
+
when :Date
|
345
|
+
Date.parse(value)
|
346
|
+
when :String
|
347
|
+
value.to_s
|
348
|
+
when :Integer
|
349
|
+
value.to_i
|
350
|
+
when :Float
|
351
|
+
value.to_f
|
352
|
+
when :Boolean
|
353
|
+
if value.to_s =~ /\A(true|t|yes|y|1)\z/i
|
354
|
+
true
|
355
|
+
else
|
356
|
+
false
|
357
|
+
end
|
358
|
+
when :Object
|
359
|
+
# generic object (usually a Hash), return directly
|
360
|
+
value
|
361
|
+
when /\AArray<(?<inner_type>.+)>\z/
|
362
|
+
inner_type = Regexp.last_match[:inner_type]
|
363
|
+
value.map { |v| _deserialize(inner_type, v) }
|
364
|
+
when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
|
365
|
+
k_type = Regexp.last_match[:k_type]
|
366
|
+
v_type = Regexp.last_match[:v_type]
|
367
|
+
{}.tap do |hash|
|
368
|
+
value.each do |k, v|
|
369
|
+
hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
|
370
|
+
end
|
371
|
+
end
|
372
|
+
else # model
|
373
|
+
# models (e.g. Pet) or oneOf
|
374
|
+
klass = UltracartClient.const_get(type)
|
375
|
+
klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
|
376
|
+
end
|
377
|
+
end
|
378
|
+
|
379
|
+
# Returns the string representation of the object
|
380
|
+
# @return [String] String presentation of the object
|
381
|
+
def to_s
|
382
|
+
to_hash.to_s
|
383
|
+
end
|
384
|
+
|
385
|
+
# to_body is an alias to to_hash (backward compatibility)
|
386
|
+
# @return [Hash] Returns the object in the form of hash
|
387
|
+
def to_body
|
388
|
+
to_hash
|
389
|
+
end
|
390
|
+
|
391
|
+
# Returns the object in the form of hash
|
392
|
+
# @return [Hash] Returns the object in the form of hash
|
393
|
+
def to_hash
|
394
|
+
hash = {}
|
395
|
+
self.class.attribute_map.each_pair do |attr, param|
|
396
|
+
value = self.send(attr)
|
397
|
+
if value.nil?
|
398
|
+
is_nullable = self.class.openapi_nullable.include?(attr)
|
399
|
+
next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
|
400
|
+
end
|
401
|
+
|
402
|
+
hash[param] = _to_hash(value)
|
403
|
+
end
|
404
|
+
hash
|
405
|
+
end
|
406
|
+
|
407
|
+
# Outputs non-array value in the form of hash
|
408
|
+
# For object, use to_hash. Otherwise, just return the value
|
409
|
+
# @param [Object] value Any valid value
|
410
|
+
# @return [Hash] Returns the value in the form of hash
|
411
|
+
def _to_hash(value)
|
412
|
+
if value.is_a?(Array)
|
413
|
+
value.compact.map { |v| _to_hash(v) }
|
414
|
+
elsif value.is_a?(Hash)
|
415
|
+
{}.tap do |hash|
|
416
|
+
value.each { |k, v| hash[k] = _to_hash(v) }
|
417
|
+
end
|
418
|
+
elsif value.respond_to? :to_hash
|
419
|
+
value.to_hash
|
420
|
+
else
|
421
|
+
value
|
422
|
+
end
|
423
|
+
end
|
424
|
+
|
425
|
+
end
|
426
|
+
|
427
|
+
end
|
@@ -95,6 +95,9 @@ module UltracartClient
|
|
95
95
|
# Realtime percentage discount
|
96
96
|
attr_accessor :realtime_percentage_discount
|
97
97
|
|
98
|
+
# Restrict inventory to this distribution center oid
|
99
|
+
attr_accessor :restrict_to_distribution_center_oid
|
100
|
+
|
98
101
|
attr_accessor :signup_notification
|
99
102
|
|
100
103
|
# Suppress buySAFE (deprecated)
|
@@ -139,6 +142,7 @@ module UltracartClient
|
|
139
142
|
:'not_valid_when_coupon_present' => :'not_valid_when_coupon_present',
|
140
143
|
:'pricing_tier_oid' => :'pricing_tier_oid',
|
141
144
|
:'realtime_percentage_discount' => :'realtime_percentage_discount',
|
145
|
+
:'restrict_to_distribution_center_oid' => :'restrict_to_distribution_center_oid',
|
142
146
|
:'signup_notification' => :'signup_notification',
|
143
147
|
:'suppress_buysafe' => :'suppress_buysafe',
|
144
148
|
:'suppress_mailing_list' => :'suppress_mailing_list',
|
@@ -182,6 +186,7 @@ module UltracartClient
|
|
182
186
|
:'not_valid_when_coupon_present' => :'Boolean',
|
183
187
|
:'pricing_tier_oid' => :'Integer',
|
184
188
|
:'realtime_percentage_discount' => :'Float',
|
189
|
+
:'restrict_to_distribution_center_oid' => :'Integer',
|
185
190
|
:'signup_notification' => :'PricingTierNotification',
|
186
191
|
:'suppress_buysafe' => :'Boolean',
|
187
192
|
:'suppress_mailing_list' => :'Boolean',
|
@@ -319,6 +324,10 @@ module UltracartClient
|
|
319
324
|
self.realtime_percentage_discount = attributes[:'realtime_percentage_discount']
|
320
325
|
end
|
321
326
|
|
327
|
+
if attributes.key?(:'restrict_to_distribution_center_oid')
|
328
|
+
self.restrict_to_distribution_center_oid = attributes[:'restrict_to_distribution_center_oid']
|
329
|
+
end
|
330
|
+
|
322
331
|
if attributes.key?(:'signup_notification')
|
323
332
|
self.signup_notification = attributes[:'signup_notification']
|
324
333
|
end
|
@@ -400,6 +409,7 @@ module UltracartClient
|
|
400
409
|
not_valid_when_coupon_present == o.not_valid_when_coupon_present &&
|
401
410
|
pricing_tier_oid == o.pricing_tier_oid &&
|
402
411
|
realtime_percentage_discount == o.realtime_percentage_discount &&
|
412
|
+
restrict_to_distribution_center_oid == o.restrict_to_distribution_center_oid &&
|
403
413
|
signup_notification == o.signup_notification &&
|
404
414
|
suppress_buysafe == o.suppress_buysafe &&
|
405
415
|
suppress_mailing_list == o.suppress_mailing_list &&
|
@@ -416,7 +426,7 @@ module UltracartClient
|
|
416
426
|
# Calculates hash code according to all attributes.
|
417
427
|
# @return [Integer] Hash code
|
418
428
|
def hash
|
419
|
-
[allow_3rd_party_billing, allow_cod, allow_purchase_order, allow_quote_request, approval_notification, auto_approve_cod, auto_approve_purchase_order, default_on_wholesale_signup, default_percentage_discount, default_shipping_method_oid, default_tier, display_on_wholesale_signup, exclude_from_free_promotion, exempt_loyalty_rewards, exempt_shipping_handling_charge, free_shipping, free_shipping_minimum, maximum_item_count, minimum_item_count, minimum_subtotal, name, no_coupons, no_free_shipping, no_realtime_charge, not_valid_when_coupon_present, pricing_tier_oid, realtime_percentage_discount, signup_notification, suppress_buysafe, suppress_mailing_list, tax_exempt, track_separately].hash
|
429
|
+
[allow_3rd_party_billing, allow_cod, allow_purchase_order, allow_quote_request, approval_notification, auto_approve_cod, auto_approve_purchase_order, default_on_wholesale_signup, default_percentage_discount, default_shipping_method_oid, default_tier, display_on_wholesale_signup, exclude_from_free_promotion, exempt_loyalty_rewards, exempt_shipping_handling_charge, free_shipping, free_shipping_minimum, maximum_item_count, minimum_item_count, minimum_subtotal, name, no_coupons, no_free_shipping, no_realtime_charge, not_valid_when_coupon_present, pricing_tier_oid, realtime_percentage_discount, restrict_to_distribution_center_oid, signup_notification, suppress_buysafe, suppress_mailing_list, tax_exempt, track_separately].hash
|
420
430
|
end
|
421
431
|
|
422
432
|
# Builds the object from hash
|
data/lib/ultracart_api.rb
CHANGED
@@ -623,6 +623,7 @@ require 'ultracart_api/models/order_token_response'
|
|
623
623
|
require 'ultracart_api/models/order_tracking_number_detail'
|
624
624
|
require 'ultracart_api/models/order_tracking_number_details'
|
625
625
|
require 'ultracart_api/models/order_transactional_merchant_note'
|
626
|
+
require 'ultracart_api/models/order_utm'
|
626
627
|
require 'ultracart_api/models/orders_response'
|
627
628
|
require 'ultracart_api/models/permission'
|
628
629
|
require 'ultracart_api/models/point_of_sale_location'
|
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: 4.0.
|
4
|
+
version: 4.0.134
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- UltraCart
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2023-02-
|
11
|
+
date: 2023-02-15 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: typhoeus
|
@@ -681,6 +681,7 @@ files:
|
|
681
681
|
- docs/OrderTrackingNumberDetail.md
|
682
682
|
- docs/OrderTrackingNumberDetails.md
|
683
683
|
- docs/OrderTransactionalMerchantNote.md
|
684
|
+
- docs/OrderUtm.md
|
684
685
|
- docs/OrdersResponse.md
|
685
686
|
- docs/Permission.md
|
686
687
|
- docs/PointOfSaleLocation.md
|
@@ -1447,6 +1448,7 @@ files:
|
|
1447
1448
|
- lib/ultracart_api/models/order_tracking_number_detail.rb
|
1448
1449
|
- lib/ultracart_api/models/order_tracking_number_details.rb
|
1449
1450
|
- lib/ultracart_api/models/order_transactional_merchant_note.rb
|
1451
|
+
- lib/ultracart_api/models/order_utm.rb
|
1450
1452
|
- lib/ultracart_api/models/orders_response.rb
|
1451
1453
|
- lib/ultracart_api/models/permission.rb
|
1452
1454
|
- lib/ultracart_api/models/point_of_sale_location.rb
|