ultracart_api 4.0.176 → 4.0.178
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/ItemIdentifiers.md +8 -0
- data/docs/OrderItem.md +8 -0
- data/docs/ReportDataSetQuery.md +2 -0
- data/docs/ReportDataSetQueryOrderByColumn.md +20 -0
- data/lib/ultracart_api/models/item_identifiers.rb +101 -1
- data/lib/ultracart_api/models/order_item.rb +101 -1
- data/lib/ultracart_api/models/report_data_set_query.rb +13 -1
- data/lib/ultracart_api/models/report_data_set_query_order_by_column.rb +228 -0
- 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: 7f08dbaed916a79d9f3d50cd1dae8ae1ed32fb2b6bc1ae14dc2d0e358a9fe75f
|
4
|
+
data.tar.gz: d209c2c2a7d7da973e67be58867eb9cf7332be7a770bb32f697486cceeea1519
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 7584893c53896afdd240a8b48330c99e59f2a85d1ac681a5fbdc2877ad3f00f0eb3b9cebe33163e1f62d7920fd185de8d210f8e50e3720b3f50fd350c8c7ae05
|
7
|
+
data.tar.gz: bbe29dae890bb926b858a721f919e0830c221da3bd82ebdeea4fd664698502d43450129fa140a2e4f877820ae841cd2d81224e49f87c1b7b21a2c03cc65e52ff
|
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.178
|
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.178.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.178.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.178'
|
37
37
|
|
38
38
|
### Install from Git
|
39
39
|
|
@@ -1159,6 +1159,7 @@ Class | Method | HTTP request | Description
|
|
1159
1159
|
- [UltracartClient::ReportDataSetPage](docs/ReportDataSetPage.md)
|
1160
1160
|
- [UltracartClient::ReportDataSetPageResponse](docs/ReportDataSetPageResponse.md)
|
1161
1161
|
- [UltracartClient::ReportDataSetQuery](docs/ReportDataSetQuery.md)
|
1162
|
+
- [UltracartClient::ReportDataSetQueryOrderByColumn](docs/ReportDataSetQueryOrderByColumn.md)
|
1162
1163
|
- [UltracartClient::ReportDataSetResponse](docs/ReportDataSetResponse.md)
|
1163
1164
|
- [UltracartClient::ReportDataSetRow](docs/ReportDataSetRow.md)
|
1164
1165
|
- [UltracartClient::ReportDataSetSchema](docs/ReportDataSetSchema.md)
|
@@ -1370,6 +1371,8 @@ Not every change is committed to every SDK.
|
|
1370
1371
|
|
1371
1372
|
| Version | Date | Comments |
|
1372
1373
|
| --: | :-: | --- |
|
1374
|
+
| 4.0.178 | 09/22/2023 | dwbi - new option to control order-by of result set |
|
1375
|
+
| 4.0.177 | 09/15/2023 | new item fields for additional barcodes |
|
1373
1376
|
| 4.0.176 | 09/12/2023 | added oids to customer properties |
|
1374
1377
|
| 4.0.175 | 09/06/2023 | esp condition for survey trigger |
|
1375
1378
|
| 4.0.174 | 09/05/2023 | auto order schedule - add intervals for 4 6 and 8 weeks |
|
data/docs/ItemIdentifiers.md
CHANGED
@@ -5,6 +5,10 @@
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
7
|
| **barcode** | **String** | Barcode | [optional] |
|
8
|
+
| **barcode_gtin12** | **String** | Barcode - GTIN 12 | [optional] |
|
9
|
+
| **barcode_gtin14** | **String** | Barcode - GTIN 14 | [optional] |
|
10
|
+
| **barcode_upc11** | **String** | Barcode - UPC 11 | [optional] |
|
11
|
+
| **barcode_upc12** | **String** | Barcode - UPC 12 | [optional] |
|
8
12
|
| **manufacturer_name** | **String** | Manufacturer Name | [optional] |
|
9
13
|
| **manufacturer_sku** | **String** | Manufacturer SKU | [optional] |
|
10
14
|
| **unspsc** | **String** | UNSPSC | [optional] |
|
@@ -16,6 +20,10 @@ require 'ultracart_api'
|
|
16
20
|
|
17
21
|
instance = UltracartClient::ItemIdentifiers.new(
|
18
22
|
barcode: null,
|
23
|
+
barcode_gtin12: null,
|
24
|
+
barcode_gtin14: null,
|
25
|
+
barcode_upc11: null,
|
26
|
+
barcode_upc12: null,
|
19
27
|
manufacturer_name: null,
|
20
28
|
manufacturer_sku: null,
|
21
29
|
unspsc: null
|
data/docs/OrderItem.md
CHANGED
@@ -10,6 +10,10 @@
|
|
10
10
|
| **auto_order_last_rebill_dts** | **String** | Date/time of the last rebill, used only during order insert to help project future rebills | [optional] |
|
11
11
|
| **auto_order_schedule** | **String** | Auto order schedule, used only during inserts supplying the recurring schedule | [optional] |
|
12
12
|
| **barcode** | **String** | Barcode | [optional] |
|
13
|
+
| **barcode_gtin12** | **String** | Barcode - GTIN 12 | [optional] |
|
14
|
+
| **barcode_gtin14** | **String** | Barcode - GTIN 14 | [optional] |
|
15
|
+
| **barcode_upc11** | **String** | Barcode - UPC 11 | [optional] |
|
16
|
+
| **barcode_upc12** | **String** | Barcode - UPC 12 | [optional] |
|
13
17
|
| **channel_partner_item_id** | **String** | Channel partner item id if this order came through a channel partner and the channel partner item id was mapped to an internal item id | [optional] |
|
14
18
|
| **cogs** | **Float** | Cost of goods sold | [optional] |
|
15
19
|
| **component_unit_value** | **Float** | Value of the kit component item | [optional] |
|
@@ -78,6 +82,10 @@ instance = UltracartClient::OrderItem.new(
|
|
78
82
|
auto_order_last_rebill_dts: null,
|
79
83
|
auto_order_schedule: null,
|
80
84
|
barcode: null,
|
85
|
+
barcode_gtin12: null,
|
86
|
+
barcode_gtin14: null,
|
87
|
+
barcode_upc11: null,
|
88
|
+
barcode_upc12: null,
|
81
89
|
channel_partner_item_id: null,
|
82
90
|
cogs: null,
|
83
91
|
component_unit_value: null,
|
data/docs/ReportDataSetQuery.md
CHANGED
@@ -12,6 +12,7 @@
|
|
12
12
|
| **for_object_id** | **String** | An identifier that can be used to help match up the returned data set | [optional] |
|
13
13
|
| **for_object_type** | **String** | The type of object this data set is for | [optional] |
|
14
14
|
| **metrics** | [**Array<ReportPageVisualizationMetric>**](ReportPageVisualizationMetric.md) | | [optional] |
|
15
|
+
| **order_by_columns** | [**Array<ReportDataSetQueryOrderByColumn>**](ReportDataSetQueryOrderByColumn.md) | The columns to order by in the final result. If not specified the dimensions will be used | [optional] |
|
15
16
|
| **page_size** | **Integer** | Result set page size. The default value is 200 records. Max is 10000. | [optional] |
|
16
17
|
| **selected_filters** | [**Array<ReportFilter>**](ReportFilter.md) | | [optional] |
|
17
18
|
| **skip_cache** | **Boolean** | True if the 15 minute cache should be skipped. | [optional] |
|
@@ -31,6 +32,7 @@ instance = UltracartClient::ReportDataSetQuery.new(
|
|
31
32
|
for_object_id: null,
|
32
33
|
for_object_type: null,
|
33
34
|
metrics: null,
|
35
|
+
order_by_columns: null,
|
34
36
|
page_size: null,
|
35
37
|
selected_filters: null,
|
36
38
|
skip_cache: null,
|
@@ -0,0 +1,20 @@
|
|
1
|
+
# UltracartClient::ReportDataSetQueryOrderByColumn
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **ascending** | **Boolean** | | [optional] |
|
8
|
+
| **column_name** | **String** | | [optional] |
|
9
|
+
|
10
|
+
## Example
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'ultracart_api'
|
14
|
+
|
15
|
+
instance = UltracartClient::ReportDataSetQueryOrderByColumn.new(
|
16
|
+
ascending: null,
|
17
|
+
column_name: null
|
18
|
+
)
|
19
|
+
```
|
20
|
+
|
@@ -18,6 +18,18 @@ module UltracartClient
|
|
18
18
|
# Barcode
|
19
19
|
attr_accessor :barcode
|
20
20
|
|
21
|
+
# Barcode - GTIN 12
|
22
|
+
attr_accessor :barcode_gtin12
|
23
|
+
|
24
|
+
# Barcode - GTIN 14
|
25
|
+
attr_accessor :barcode_gtin14
|
26
|
+
|
27
|
+
# Barcode - UPC 11
|
28
|
+
attr_accessor :barcode_upc11
|
29
|
+
|
30
|
+
# Barcode - UPC 12
|
31
|
+
attr_accessor :barcode_upc12
|
32
|
+
|
21
33
|
# Manufacturer Name
|
22
34
|
attr_accessor :manufacturer_name
|
23
35
|
|
@@ -31,6 +43,10 @@ module UltracartClient
|
|
31
43
|
def self.attribute_map
|
32
44
|
{
|
33
45
|
:'barcode' => :'barcode',
|
46
|
+
:'barcode_gtin12' => :'barcode_gtin12',
|
47
|
+
:'barcode_gtin14' => :'barcode_gtin14',
|
48
|
+
:'barcode_upc11' => :'barcode_upc11',
|
49
|
+
:'barcode_upc12' => :'barcode_upc12',
|
34
50
|
:'manufacturer_name' => :'manufacturer_name',
|
35
51
|
:'manufacturer_sku' => :'manufacturer_sku',
|
36
52
|
:'unspsc' => :'unspsc'
|
@@ -46,6 +62,10 @@ module UltracartClient
|
|
46
62
|
def self.openapi_types
|
47
63
|
{
|
48
64
|
:'barcode' => :'String',
|
65
|
+
:'barcode_gtin12' => :'String',
|
66
|
+
:'barcode_gtin14' => :'String',
|
67
|
+
:'barcode_upc11' => :'String',
|
68
|
+
:'barcode_upc12' => :'String',
|
49
69
|
:'manufacturer_name' => :'String',
|
50
70
|
:'manufacturer_sku' => :'String',
|
51
71
|
:'unspsc' => :'String'
|
@@ -77,6 +97,22 @@ module UltracartClient
|
|
77
97
|
self.barcode = attributes[:'barcode']
|
78
98
|
end
|
79
99
|
|
100
|
+
if attributes.key?(:'barcode_gtin12')
|
101
|
+
self.barcode_gtin12 = attributes[:'barcode_gtin12']
|
102
|
+
end
|
103
|
+
|
104
|
+
if attributes.key?(:'barcode_gtin14')
|
105
|
+
self.barcode_gtin14 = attributes[:'barcode_gtin14']
|
106
|
+
end
|
107
|
+
|
108
|
+
if attributes.key?(:'barcode_upc11')
|
109
|
+
self.barcode_upc11 = attributes[:'barcode_upc11']
|
110
|
+
end
|
111
|
+
|
112
|
+
if attributes.key?(:'barcode_upc12')
|
113
|
+
self.barcode_upc12 = attributes[:'barcode_upc12']
|
114
|
+
end
|
115
|
+
|
80
116
|
if attributes.key?(:'manufacturer_name')
|
81
117
|
self.manufacturer_name = attributes[:'manufacturer_name']
|
82
118
|
end
|
@@ -98,6 +134,22 @@ module UltracartClient
|
|
98
134
|
invalid_properties.push('invalid value for "barcode", the character length must be smaller than or equal to 30.')
|
99
135
|
end
|
100
136
|
|
137
|
+
if !@barcode_gtin12.nil? && @barcode_gtin12.to_s.length > 12
|
138
|
+
invalid_properties.push('invalid value for "barcode_gtin12", the character length must be smaller than or equal to 12.')
|
139
|
+
end
|
140
|
+
|
141
|
+
if !@barcode_gtin14.nil? && @barcode_gtin14.to_s.length > 14
|
142
|
+
invalid_properties.push('invalid value for "barcode_gtin14", the character length must be smaller than or equal to 14.')
|
143
|
+
end
|
144
|
+
|
145
|
+
if !@barcode_upc11.nil? && @barcode_upc11.to_s.length > 11
|
146
|
+
invalid_properties.push('invalid value for "barcode_upc11", the character length must be smaller than or equal to 11.')
|
147
|
+
end
|
148
|
+
|
149
|
+
if !@barcode_upc12.nil? && @barcode_upc12.to_s.length > 12
|
150
|
+
invalid_properties.push('invalid value for "barcode_upc12", the character length must be smaller than or equal to 12.')
|
151
|
+
end
|
152
|
+
|
101
153
|
if !@manufacturer_name.nil? && @manufacturer_name.to_s.length > 50
|
102
154
|
invalid_properties.push('invalid value for "manufacturer_name", the character length must be smaller than or equal to 50.')
|
103
155
|
end
|
@@ -117,6 +169,10 @@ module UltracartClient
|
|
117
169
|
# @return true if the model is valid
|
118
170
|
def valid?
|
119
171
|
return false if !@barcode.nil? && @barcode.to_s.length > 30
|
172
|
+
return false if !@barcode_gtin12.nil? && @barcode_gtin12.to_s.length > 12
|
173
|
+
return false if !@barcode_gtin14.nil? && @barcode_gtin14.to_s.length > 14
|
174
|
+
return false if !@barcode_upc11.nil? && @barcode_upc11.to_s.length > 11
|
175
|
+
return false if !@barcode_upc12.nil? && @barcode_upc12.to_s.length > 12
|
120
176
|
return false if !@manufacturer_name.nil? && @manufacturer_name.to_s.length > 50
|
121
177
|
return false if !@manufacturer_sku.nil? && @manufacturer_sku.to_s.length > 25
|
122
178
|
return false if !@unspsc.nil? && @unspsc.to_s.length > 20
|
@@ -133,6 +189,46 @@ module UltracartClient
|
|
133
189
|
@barcode = barcode
|
134
190
|
end
|
135
191
|
|
192
|
+
# Custom attribute writer method with validation
|
193
|
+
# @param [Object] barcode_gtin12 Value to be assigned
|
194
|
+
def barcode_gtin12=(barcode_gtin12)
|
195
|
+
if !barcode_gtin12.nil? && barcode_gtin12.to_s.length > 12
|
196
|
+
fail ArgumentError, 'invalid value for "barcode_gtin12", the character length must be smaller than or equal to 12.'
|
197
|
+
end
|
198
|
+
|
199
|
+
@barcode_gtin12 = barcode_gtin12
|
200
|
+
end
|
201
|
+
|
202
|
+
# Custom attribute writer method with validation
|
203
|
+
# @param [Object] barcode_gtin14 Value to be assigned
|
204
|
+
def barcode_gtin14=(barcode_gtin14)
|
205
|
+
if !barcode_gtin14.nil? && barcode_gtin14.to_s.length > 14
|
206
|
+
fail ArgumentError, 'invalid value for "barcode_gtin14", the character length must be smaller than or equal to 14.'
|
207
|
+
end
|
208
|
+
|
209
|
+
@barcode_gtin14 = barcode_gtin14
|
210
|
+
end
|
211
|
+
|
212
|
+
# Custom attribute writer method with validation
|
213
|
+
# @param [Object] barcode_upc11 Value to be assigned
|
214
|
+
def barcode_upc11=(barcode_upc11)
|
215
|
+
if !barcode_upc11.nil? && barcode_upc11.to_s.length > 11
|
216
|
+
fail ArgumentError, 'invalid value for "barcode_upc11", the character length must be smaller than or equal to 11.'
|
217
|
+
end
|
218
|
+
|
219
|
+
@barcode_upc11 = barcode_upc11
|
220
|
+
end
|
221
|
+
|
222
|
+
# Custom attribute writer method with validation
|
223
|
+
# @param [Object] barcode_upc12 Value to be assigned
|
224
|
+
def barcode_upc12=(barcode_upc12)
|
225
|
+
if !barcode_upc12.nil? && barcode_upc12.to_s.length > 12
|
226
|
+
fail ArgumentError, 'invalid value for "barcode_upc12", the character length must be smaller than or equal to 12.'
|
227
|
+
end
|
228
|
+
|
229
|
+
@barcode_upc12 = barcode_upc12
|
230
|
+
end
|
231
|
+
|
136
232
|
# Custom attribute writer method with validation
|
137
233
|
# @param [Object] manufacturer_name Value to be assigned
|
138
234
|
def manufacturer_name=(manufacturer_name)
|
@@ -169,6 +265,10 @@ module UltracartClient
|
|
169
265
|
return true if self.equal?(o)
|
170
266
|
self.class == o.class &&
|
171
267
|
barcode == o.barcode &&
|
268
|
+
barcode_gtin12 == o.barcode_gtin12 &&
|
269
|
+
barcode_gtin14 == o.barcode_gtin14 &&
|
270
|
+
barcode_upc11 == o.barcode_upc11 &&
|
271
|
+
barcode_upc12 == o.barcode_upc12 &&
|
172
272
|
manufacturer_name == o.manufacturer_name &&
|
173
273
|
manufacturer_sku == o.manufacturer_sku &&
|
174
274
|
unspsc == o.unspsc
|
@@ -183,7 +283,7 @@ module UltracartClient
|
|
183
283
|
# Calculates hash code according to all attributes.
|
184
284
|
# @return [Integer] Hash code
|
185
285
|
def hash
|
186
|
-
[barcode, manufacturer_name, manufacturer_sku, unspsc].hash
|
286
|
+
[barcode, barcode_gtin12, barcode_gtin14, barcode_upc11, barcode_upc12, manufacturer_name, manufacturer_sku, unspsc].hash
|
187
287
|
end
|
188
288
|
|
189
289
|
# Builds the object from hash
|
@@ -32,6 +32,18 @@ module UltracartClient
|
|
32
32
|
# Barcode
|
33
33
|
attr_accessor :barcode
|
34
34
|
|
35
|
+
# Barcode - GTIN 12
|
36
|
+
attr_accessor :barcode_gtin12
|
37
|
+
|
38
|
+
# Barcode - GTIN 14
|
39
|
+
attr_accessor :barcode_gtin14
|
40
|
+
|
41
|
+
# Barcode - UPC 11
|
42
|
+
attr_accessor :barcode_upc11
|
43
|
+
|
44
|
+
# Barcode - UPC 12
|
45
|
+
attr_accessor :barcode_upc12
|
46
|
+
|
35
47
|
# Channel partner item id if this order came through a channel partner and the channel partner item id was mapped to an internal item id
|
36
48
|
attr_accessor :channel_partner_item_id
|
37
49
|
|
@@ -216,6 +228,10 @@ module UltracartClient
|
|
216
228
|
:'auto_order_last_rebill_dts' => :'auto_order_last_rebill_dts',
|
217
229
|
:'auto_order_schedule' => :'auto_order_schedule',
|
218
230
|
:'barcode' => :'barcode',
|
231
|
+
:'barcode_gtin12' => :'barcode_gtin12',
|
232
|
+
:'barcode_gtin14' => :'barcode_gtin14',
|
233
|
+
:'barcode_upc11' => :'barcode_upc11',
|
234
|
+
:'barcode_upc12' => :'barcode_upc12',
|
219
235
|
:'channel_partner_item_id' => :'channel_partner_item_id',
|
220
236
|
:'cogs' => :'cogs',
|
221
237
|
:'component_unit_value' => :'component_unit_value',
|
@@ -288,6 +304,10 @@ module UltracartClient
|
|
288
304
|
:'auto_order_last_rebill_dts' => :'String',
|
289
305
|
:'auto_order_schedule' => :'String',
|
290
306
|
:'barcode' => :'String',
|
307
|
+
:'barcode_gtin12' => :'String',
|
308
|
+
:'barcode_gtin14' => :'String',
|
309
|
+
:'barcode_upc11' => :'String',
|
310
|
+
:'barcode_upc12' => :'String',
|
291
311
|
:'channel_partner_item_id' => :'String',
|
292
312
|
:'cogs' => :'Float',
|
293
313
|
:'component_unit_value' => :'Float',
|
@@ -393,6 +413,22 @@ module UltracartClient
|
|
393
413
|
self.barcode = attributes[:'barcode']
|
394
414
|
end
|
395
415
|
|
416
|
+
if attributes.key?(:'barcode_gtin12')
|
417
|
+
self.barcode_gtin12 = attributes[:'barcode_gtin12']
|
418
|
+
end
|
419
|
+
|
420
|
+
if attributes.key?(:'barcode_gtin14')
|
421
|
+
self.barcode_gtin14 = attributes[:'barcode_gtin14']
|
422
|
+
end
|
423
|
+
|
424
|
+
if attributes.key?(:'barcode_upc11')
|
425
|
+
self.barcode_upc11 = attributes[:'barcode_upc11']
|
426
|
+
end
|
427
|
+
|
428
|
+
if attributes.key?(:'barcode_upc12')
|
429
|
+
self.barcode_upc12 = attributes[:'barcode_upc12']
|
430
|
+
end
|
431
|
+
|
396
432
|
if attributes.key?(:'channel_partner_item_id')
|
397
433
|
self.channel_partner_item_id = attributes[:'channel_partner_item_id']
|
398
434
|
end
|
@@ -624,6 +660,22 @@ module UltracartClient
|
|
624
660
|
# @return Array for valid properties with the reasons
|
625
661
|
def list_invalid_properties
|
626
662
|
invalid_properties = Array.new
|
663
|
+
if !@barcode_gtin12.nil? && @barcode_gtin12.to_s.length > 12
|
664
|
+
invalid_properties.push('invalid value for "barcode_gtin12", the character length must be smaller than or equal to 12.')
|
665
|
+
end
|
666
|
+
|
667
|
+
if !@barcode_gtin14.nil? && @barcode_gtin14.to_s.length > 14
|
668
|
+
invalid_properties.push('invalid value for "barcode_gtin14", the character length must be smaller than or equal to 14.')
|
669
|
+
end
|
670
|
+
|
671
|
+
if !@barcode_upc11.nil? && @barcode_upc11.to_s.length > 11
|
672
|
+
invalid_properties.push('invalid value for "barcode_upc11", the character length must be smaller than or equal to 11.')
|
673
|
+
end
|
674
|
+
|
675
|
+
if !@barcode_upc12.nil? && @barcode_upc12.to_s.length > 12
|
676
|
+
invalid_properties.push('invalid value for "barcode_upc12", the character length must be smaller than or equal to 12.')
|
677
|
+
end
|
678
|
+
|
627
679
|
if !@channel_partner_item_id.nil? && @channel_partner_item_id.to_s.length > 30
|
628
680
|
invalid_properties.push('invalid value for "channel_partner_item_id", the character length must be smaller than or equal to 30.')
|
629
681
|
end
|
@@ -658,6 +710,10 @@ module UltracartClient
|
|
658
710
|
# Check to see if the all the properties in the model are valid
|
659
711
|
# @return true if the model is valid
|
660
712
|
def valid?
|
713
|
+
return false if !@barcode_gtin12.nil? && @barcode_gtin12.to_s.length > 12
|
714
|
+
return false if !@barcode_gtin14.nil? && @barcode_gtin14.to_s.length > 14
|
715
|
+
return false if !@barcode_upc11.nil? && @barcode_upc11.to_s.length > 11
|
716
|
+
return false if !@barcode_upc12.nil? && @barcode_upc12.to_s.length > 12
|
661
717
|
return false if !@channel_partner_item_id.nil? && @channel_partner_item_id.to_s.length > 30
|
662
718
|
return false if !@country_code_of_origin.nil? && @country_code_of_origin.to_s.length > 2
|
663
719
|
return false if !@description.nil? && @description.to_s.length > 2000
|
@@ -670,6 +726,46 @@ module UltracartClient
|
|
670
726
|
true
|
671
727
|
end
|
672
728
|
|
729
|
+
# Custom attribute writer method with validation
|
730
|
+
# @param [Object] barcode_gtin12 Value to be assigned
|
731
|
+
def barcode_gtin12=(barcode_gtin12)
|
732
|
+
if !barcode_gtin12.nil? && barcode_gtin12.to_s.length > 12
|
733
|
+
fail ArgumentError, 'invalid value for "barcode_gtin12", the character length must be smaller than or equal to 12.'
|
734
|
+
end
|
735
|
+
|
736
|
+
@barcode_gtin12 = barcode_gtin12
|
737
|
+
end
|
738
|
+
|
739
|
+
# Custom attribute writer method with validation
|
740
|
+
# @param [Object] barcode_gtin14 Value to be assigned
|
741
|
+
def barcode_gtin14=(barcode_gtin14)
|
742
|
+
if !barcode_gtin14.nil? && barcode_gtin14.to_s.length > 14
|
743
|
+
fail ArgumentError, 'invalid value for "barcode_gtin14", the character length must be smaller than or equal to 14.'
|
744
|
+
end
|
745
|
+
|
746
|
+
@barcode_gtin14 = barcode_gtin14
|
747
|
+
end
|
748
|
+
|
749
|
+
# Custom attribute writer method with validation
|
750
|
+
# @param [Object] barcode_upc11 Value to be assigned
|
751
|
+
def barcode_upc11=(barcode_upc11)
|
752
|
+
if !barcode_upc11.nil? && barcode_upc11.to_s.length > 11
|
753
|
+
fail ArgumentError, 'invalid value for "barcode_upc11", the character length must be smaller than or equal to 11.'
|
754
|
+
end
|
755
|
+
|
756
|
+
@barcode_upc11 = barcode_upc11
|
757
|
+
end
|
758
|
+
|
759
|
+
# Custom attribute writer method with validation
|
760
|
+
# @param [Object] barcode_upc12 Value to be assigned
|
761
|
+
def barcode_upc12=(barcode_upc12)
|
762
|
+
if !barcode_upc12.nil? && barcode_upc12.to_s.length > 12
|
763
|
+
fail ArgumentError, 'invalid value for "barcode_upc12", the character length must be smaller than or equal to 12.'
|
764
|
+
end
|
765
|
+
|
766
|
+
@barcode_upc12 = barcode_upc12
|
767
|
+
end
|
768
|
+
|
673
769
|
# Custom attribute writer method with validation
|
674
770
|
# @param [Object] channel_partner_item_id Value to be assigned
|
675
771
|
def channel_partner_item_id=(channel_partner_item_id)
|
@@ -761,6 +857,10 @@ module UltracartClient
|
|
761
857
|
auto_order_last_rebill_dts == o.auto_order_last_rebill_dts &&
|
762
858
|
auto_order_schedule == o.auto_order_schedule &&
|
763
859
|
barcode == o.barcode &&
|
860
|
+
barcode_gtin12 == o.barcode_gtin12 &&
|
861
|
+
barcode_gtin14 == o.barcode_gtin14 &&
|
862
|
+
barcode_upc11 == o.barcode_upc11 &&
|
863
|
+
barcode_upc12 == o.barcode_upc12 &&
|
764
864
|
channel_partner_item_id == o.channel_partner_item_id &&
|
765
865
|
cogs == o.cogs &&
|
766
866
|
component_unit_value == o.component_unit_value &&
|
@@ -827,7 +927,7 @@ module UltracartClient
|
|
827
927
|
# Calculates hash code according to all attributes.
|
828
928
|
# @return [Integer] Hash code
|
829
929
|
def hash
|
830
|
-
[accounting_code, activation_codes, arbitrary_unit_cost, auto_order_last_rebill_dts, auto_order_schedule, barcode, channel_partner_item_id, cogs, component_unit_value, cost, country_code_of_origin, customs_description, description, discount, discount_quantity, discount_shipping_weight, distribution_center_code, edi, exclude_coupon, free_shipping, hazmat, height, item_index, item_reference_oid, kit, kit_component, length, manufacturer_sku, max_days_time_in_transit, merchant_item_id, mix_and_match_group_name, mix_and_match_group_oid, no_shipping_discount, options, packed_by_user, parent_item_index, parent_merchant_item_id, perishable_class, pricing_tier_name, properties, quantity, quantity_refunded, quickbooks_class, refund_reason, return_reason, ship_separately, shipped_by_user, shipped_dts, shipping_status, special_product_type, tags, tax_free, tax_product_type, taxable_cost, total_cost_with_discount, total_refunded, transmitted_to_distribution_center_dts, unit_cost_with_discount, upsell, weight, width].hash
|
930
|
+
[accounting_code, activation_codes, arbitrary_unit_cost, auto_order_last_rebill_dts, auto_order_schedule, barcode, barcode_gtin12, barcode_gtin14, barcode_upc11, barcode_upc12, channel_partner_item_id, cogs, component_unit_value, cost, country_code_of_origin, customs_description, description, discount, discount_quantity, discount_shipping_weight, distribution_center_code, edi, exclude_coupon, free_shipping, hazmat, height, item_index, item_reference_oid, kit, kit_component, length, manufacturer_sku, max_days_time_in_transit, merchant_item_id, mix_and_match_group_name, mix_and_match_group_oid, no_shipping_discount, options, packed_by_user, parent_item_index, parent_merchant_item_id, perishable_class, pricing_tier_name, properties, quantity, quantity_refunded, quickbooks_class, refund_reason, return_reason, ship_separately, shipped_by_user, shipped_dts, shipping_status, special_product_type, tags, tax_free, tax_product_type, taxable_cost, total_cost_with_discount, total_refunded, transmitted_to_distribution_center_dts, unit_cost_with_discount, upsell, weight, width].hash
|
831
931
|
end
|
832
932
|
|
833
933
|
# Builds the object from hash
|
@@ -35,6 +35,9 @@ module UltracartClient
|
|
35
35
|
|
36
36
|
attr_accessor :metrics
|
37
37
|
|
38
|
+
# The columns to order by in the final result. If not specified the dimensions will be used
|
39
|
+
attr_accessor :order_by_columns
|
40
|
+
|
38
41
|
# Result set page size. The default value is 200 records. Max is 10000.
|
39
42
|
attr_accessor :page_size
|
40
43
|
|
@@ -79,6 +82,7 @@ module UltracartClient
|
|
79
82
|
:'for_object_id' => :'for_object_id',
|
80
83
|
:'for_object_type' => :'for_object_type',
|
81
84
|
:'metrics' => :'metrics',
|
85
|
+
:'order_by_columns' => :'order_by_columns',
|
82
86
|
:'page_size' => :'page_size',
|
83
87
|
:'selected_filters' => :'selected_filters',
|
84
88
|
:'skip_cache' => :'skip_cache',
|
@@ -102,6 +106,7 @@ module UltracartClient
|
|
102
106
|
:'for_object_id' => :'String',
|
103
107
|
:'for_object_type' => :'String',
|
104
108
|
:'metrics' => :'Array<ReportPageVisualizationMetric>',
|
109
|
+
:'order_by_columns' => :'Array<ReportDataSetQueryOrderByColumn>',
|
105
110
|
:'page_size' => :'Integer',
|
106
111
|
:'selected_filters' => :'Array<ReportFilter>',
|
107
112
|
:'skip_cache' => :'Boolean',
|
@@ -166,6 +171,12 @@ module UltracartClient
|
|
166
171
|
end
|
167
172
|
end
|
168
173
|
|
174
|
+
if attributes.key?(:'order_by_columns')
|
175
|
+
if (value = attributes[:'order_by_columns']).is_a?(Array)
|
176
|
+
self.order_by_columns = value
|
177
|
+
end
|
178
|
+
end
|
179
|
+
|
169
180
|
if attributes.key?(:'page_size')
|
170
181
|
self.page_size = attributes[:'page_size']
|
171
182
|
end
|
@@ -223,6 +234,7 @@ module UltracartClient
|
|
223
234
|
for_object_id == o.for_object_id &&
|
224
235
|
for_object_type == o.for_object_type &&
|
225
236
|
metrics == o.metrics &&
|
237
|
+
order_by_columns == o.order_by_columns &&
|
226
238
|
page_size == o.page_size &&
|
227
239
|
selected_filters == o.selected_filters &&
|
228
240
|
skip_cache == o.skip_cache &&
|
@@ -238,7 +250,7 @@ module UltracartClient
|
|
238
250
|
# Calculates hash code according to all attributes.
|
239
251
|
# @return [Integer] Hash code
|
240
252
|
def hash
|
241
|
-
[comparison_results, data_set_query_uuid, data_source, dimensions, filter, for_object_id, for_object_type, metrics, page_size, selected_filters, skip_cache, user_data].hash
|
253
|
+
[comparison_results, data_set_query_uuid, data_source, dimensions, filter, for_object_id, for_object_type, metrics, order_by_columns, page_size, selected_filters, skip_cache, user_data].hash
|
242
254
|
end
|
243
255
|
|
244
256
|
# Builds the object from hash
|
@@ -0,0 +1,228 @@
|
|
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 ReportDataSetQueryOrderByColumn
|
18
|
+
attr_accessor :ascending
|
19
|
+
|
20
|
+
attr_accessor :column_name
|
21
|
+
|
22
|
+
# Attribute mapping from ruby-style variable name to JSON key.
|
23
|
+
def self.attribute_map
|
24
|
+
{
|
25
|
+
:'ascending' => :'ascending',
|
26
|
+
:'column_name' => :'column_name'
|
27
|
+
}
|
28
|
+
end
|
29
|
+
|
30
|
+
# Returns all the JSON keys this model knows about
|
31
|
+
def self.acceptable_attributes
|
32
|
+
attribute_map.values
|
33
|
+
end
|
34
|
+
|
35
|
+
# Attribute type mapping.
|
36
|
+
def self.openapi_types
|
37
|
+
{
|
38
|
+
:'ascending' => :'Boolean',
|
39
|
+
:'column_name' => :'String'
|
40
|
+
}
|
41
|
+
end
|
42
|
+
|
43
|
+
# List of attributes with nullable: true
|
44
|
+
def self.openapi_nullable
|
45
|
+
Set.new([
|
46
|
+
])
|
47
|
+
end
|
48
|
+
|
49
|
+
# Initializes the object
|
50
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
51
|
+
def initialize(attributes = {})
|
52
|
+
if (!attributes.is_a?(Hash))
|
53
|
+
fail ArgumentError, "The input argument (attributes) must be a hash in `UltracartClient::ReportDataSetQueryOrderByColumn` initialize method"
|
54
|
+
end
|
55
|
+
|
56
|
+
# check to see if the attribute exists and convert string to symbol for hash key
|
57
|
+
attributes = attributes.each_with_object({}) { |(k, v), h|
|
58
|
+
if (!self.class.attribute_map.key?(k.to_sym))
|
59
|
+
fail ArgumentError, "`#{k}` is not a valid attribute in `UltracartClient::ReportDataSetQueryOrderByColumn`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
|
60
|
+
end
|
61
|
+
h[k.to_sym] = v
|
62
|
+
}
|
63
|
+
|
64
|
+
if attributes.key?(:'ascending')
|
65
|
+
self.ascending = attributes[:'ascending']
|
66
|
+
end
|
67
|
+
|
68
|
+
if attributes.key?(:'column_name')
|
69
|
+
self.column_name = attributes[:'column_name']
|
70
|
+
end
|
71
|
+
end
|
72
|
+
|
73
|
+
# Show invalid properties with the reasons. Usually used together with valid?
|
74
|
+
# @return Array for valid properties with the reasons
|
75
|
+
def list_invalid_properties
|
76
|
+
invalid_properties = Array.new
|
77
|
+
invalid_properties
|
78
|
+
end
|
79
|
+
|
80
|
+
# Check to see if the all the properties in the model are valid
|
81
|
+
# @return true if the model is valid
|
82
|
+
def valid?
|
83
|
+
true
|
84
|
+
end
|
85
|
+
|
86
|
+
# Checks equality by comparing each attribute.
|
87
|
+
# @param [Object] Object to be compared
|
88
|
+
def ==(o)
|
89
|
+
return true if self.equal?(o)
|
90
|
+
self.class == o.class &&
|
91
|
+
ascending == o.ascending &&
|
92
|
+
column_name == o.column_name
|
93
|
+
end
|
94
|
+
|
95
|
+
# @see the `==` method
|
96
|
+
# @param [Object] Object to be compared
|
97
|
+
def eql?(o)
|
98
|
+
self == o
|
99
|
+
end
|
100
|
+
|
101
|
+
# Calculates hash code according to all attributes.
|
102
|
+
# @return [Integer] Hash code
|
103
|
+
def hash
|
104
|
+
[ascending, column_name].hash
|
105
|
+
end
|
106
|
+
|
107
|
+
# Builds the object from hash
|
108
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
109
|
+
# @return [Object] Returns the model itself
|
110
|
+
def self.build_from_hash(attributes)
|
111
|
+
new.build_from_hash(attributes)
|
112
|
+
end
|
113
|
+
|
114
|
+
# Builds the object from hash
|
115
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
116
|
+
# @return [Object] Returns the model itself
|
117
|
+
def build_from_hash(attributes)
|
118
|
+
return nil unless attributes.is_a?(Hash)
|
119
|
+
attributes = attributes.transform_keys(&:to_sym)
|
120
|
+
self.class.openapi_types.each_pair do |key, type|
|
121
|
+
if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
|
122
|
+
self.send("#{key}=", nil)
|
123
|
+
elsif type =~ /\AArray<(.*)>/i
|
124
|
+
# check to ensure the input is an array given that the attribute
|
125
|
+
# is documented as an array but the input is not
|
126
|
+
if attributes[self.class.attribute_map[key]].is_a?(Array)
|
127
|
+
self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
|
128
|
+
end
|
129
|
+
elsif !attributes[self.class.attribute_map[key]].nil?
|
130
|
+
self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
|
131
|
+
end
|
132
|
+
end
|
133
|
+
|
134
|
+
self
|
135
|
+
end
|
136
|
+
|
137
|
+
# Deserializes the data based on type
|
138
|
+
# @param string type Data type
|
139
|
+
# @param string value Value to be deserialized
|
140
|
+
# @return [Object] Deserialized data
|
141
|
+
def _deserialize(type, value)
|
142
|
+
case type.to_sym
|
143
|
+
when :Time
|
144
|
+
Time.parse(value)
|
145
|
+
when :Date
|
146
|
+
Date.parse(value)
|
147
|
+
when :String
|
148
|
+
value.to_s
|
149
|
+
when :Integer
|
150
|
+
value.to_i
|
151
|
+
when :Float
|
152
|
+
value.to_f
|
153
|
+
when :Boolean
|
154
|
+
if value.to_s =~ /\A(true|t|yes|y|1)\z/i
|
155
|
+
true
|
156
|
+
else
|
157
|
+
false
|
158
|
+
end
|
159
|
+
when :Object
|
160
|
+
# generic object (usually a Hash), return directly
|
161
|
+
value
|
162
|
+
when /\AArray<(?<inner_type>.+)>\z/
|
163
|
+
inner_type = Regexp.last_match[:inner_type]
|
164
|
+
value.map { |v| _deserialize(inner_type, v) }
|
165
|
+
when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
|
166
|
+
k_type = Regexp.last_match[:k_type]
|
167
|
+
v_type = Regexp.last_match[:v_type]
|
168
|
+
{}.tap do |hash|
|
169
|
+
value.each do |k, v|
|
170
|
+
hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
|
171
|
+
end
|
172
|
+
end
|
173
|
+
else # model
|
174
|
+
# models (e.g. Pet) or oneOf
|
175
|
+
klass = UltracartClient.const_get(type)
|
176
|
+
klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
|
177
|
+
end
|
178
|
+
end
|
179
|
+
|
180
|
+
# Returns the string representation of the object
|
181
|
+
# @return [String] String presentation of the object
|
182
|
+
def to_s
|
183
|
+
to_hash.to_s
|
184
|
+
end
|
185
|
+
|
186
|
+
# to_body is an alias to to_hash (backward compatibility)
|
187
|
+
# @return [Hash] Returns the object in the form of hash
|
188
|
+
def to_body
|
189
|
+
to_hash
|
190
|
+
end
|
191
|
+
|
192
|
+
# Returns the object in the form of hash
|
193
|
+
# @return [Hash] Returns the object in the form of hash
|
194
|
+
def to_hash
|
195
|
+
hash = {}
|
196
|
+
self.class.attribute_map.each_pair do |attr, param|
|
197
|
+
value = self.send(attr)
|
198
|
+
if value.nil?
|
199
|
+
is_nullable = self.class.openapi_nullable.include?(attr)
|
200
|
+
next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
|
201
|
+
end
|
202
|
+
|
203
|
+
hash[param] = _to_hash(value)
|
204
|
+
end
|
205
|
+
hash
|
206
|
+
end
|
207
|
+
|
208
|
+
# Outputs non-array value in the form of hash
|
209
|
+
# For object, use to_hash. Otherwise, just return the value
|
210
|
+
# @param [Object] value Any valid value
|
211
|
+
# @return [Hash] Returns the value in the form of hash
|
212
|
+
def _to_hash(value)
|
213
|
+
if value.is_a?(Array)
|
214
|
+
value.compact.map { |v| _to_hash(v) }
|
215
|
+
elsif value.is_a?(Hash)
|
216
|
+
{}.tap do |hash|
|
217
|
+
value.each { |k, v| hash[k] = _to_hash(v) }
|
218
|
+
end
|
219
|
+
elsif value.respond_to? :to_hash
|
220
|
+
value.to_hash
|
221
|
+
else
|
222
|
+
value
|
223
|
+
end
|
224
|
+
end
|
225
|
+
|
226
|
+
end
|
227
|
+
|
228
|
+
end
|
data/lib/ultracart_api.rb
CHANGED
@@ -659,6 +659,7 @@ require 'ultracart_api/models/report_data_set_column'
|
|
659
659
|
require 'ultracart_api/models/report_data_set_page'
|
660
660
|
require 'ultracart_api/models/report_data_set_page_response'
|
661
661
|
require 'ultracart_api/models/report_data_set_query'
|
662
|
+
require 'ultracart_api/models/report_data_set_query_order_by_column'
|
662
663
|
require 'ultracart_api/models/report_data_set_response'
|
663
664
|
require 'ultracart_api/models/report_data_set_row'
|
664
665
|
require 'ultracart_api/models/report_data_set_schema'
|
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.178
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- UltraCart
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2023-09-
|
11
|
+
date: 2023-09-22 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: typhoeus
|
@@ -718,6 +718,7 @@ files:
|
|
718
718
|
- docs/ReportDataSetPage.md
|
719
719
|
- docs/ReportDataSetPageResponse.md
|
720
720
|
- docs/ReportDataSetQuery.md
|
721
|
+
- docs/ReportDataSetQueryOrderByColumn.md
|
721
722
|
- docs/ReportDataSetResponse.md
|
722
723
|
- docs/ReportDataSetRow.md
|
723
724
|
- docs/ReportDataSetSchema.md
|
@@ -1528,6 +1529,7 @@ files:
|
|
1528
1529
|
- lib/ultracart_api/models/report_data_set_page.rb
|
1529
1530
|
- lib/ultracart_api/models/report_data_set_page_response.rb
|
1530
1531
|
- lib/ultracart_api/models/report_data_set_query.rb
|
1532
|
+
- lib/ultracart_api/models/report_data_set_query_order_by_column.rb
|
1531
1533
|
- lib/ultracart_api/models/report_data_set_response.rb
|
1532
1534
|
- lib/ultracart_api/models/report_data_set_row.rb
|
1533
1535
|
- lib/ultracart_api/models/report_data_set_schema.rb
|