ultracart_api 4.1.15 → 4.1.17

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (35) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +25 -5
  3. data/docs/CustomDashboard.md +24 -0
  4. data/docs/CustomDashboardPage.md +22 -0
  5. data/docs/CustomDashboardPageReport.md +26 -0
  6. data/docs/CustomDashboardResponse.md +26 -0
  7. data/docs/CustomDashboardsResponse.md +26 -0
  8. data/docs/CustomReportExecutionResponse.md +32 -0
  9. data/docs/CustomReportsExecutionReportData.md +22 -0
  10. data/docs/CustomReportsExecutionRequest.md +20 -0
  11. data/docs/CustomReportsExecutionResponse.md +28 -0
  12. data/docs/CustomReportsResponse.md +26 -0
  13. data/docs/DatawarehouseApi.md +379 -4
  14. data/docs/EmailEditorValuesResponse.md +26 -0
  15. data/docs/OrderApi.md +32 -67
  16. data/docs/StorefrontApi.md +52 -0
  17. data/docs/WebhookApi.md +0 -8
  18. data/lib/ultracart_api/api/datawarehouse_api.rb +460 -3
  19. data/lib/ultracart_api/api/order_api.rb +2 -93
  20. data/lib/ultracart_api/api/storefront_api.rb +62 -0
  21. data/lib/ultracart_api/api/webhook_api.rb +0 -24
  22. data/lib/ultracart_api/models/custom_dashboard.rb +248 -0
  23. data/lib/ultracart_api/models/custom_dashboard_page.rb +239 -0
  24. data/lib/ultracart_api/models/custom_dashboard_page_report.rb +255 -0
  25. data/lib/ultracart_api/models/custom_dashboard_response.rb +256 -0
  26. data/lib/ultracart_api/models/custom_dashboards_response.rb +259 -0
  27. data/lib/ultracart_api/models/custom_report_execution_response.rb +285 -0
  28. data/lib/ultracart_api/models/custom_reports_execution_report_data.rb +237 -0
  29. data/lib/ultracart_api/models/custom_reports_execution_request.rb +232 -0
  30. data/lib/ultracart_api/models/custom_reports_execution_response.rb +269 -0
  31. data/lib/ultracart_api/models/custom_reports_response.rb +259 -0
  32. data/lib/ultracart_api/models/email_editor_values_response.rb +258 -0
  33. data/lib/ultracart_api/version.rb +1 -1
  34. data/lib/ultracart_api.rb +11 -0
  35. metadata +24 -2
@@ -0,0 +1,258 @@
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 EmailEditorValuesResponse
18
+ attr_accessor :error
19
+
20
+ attr_accessor :loyalty_tiers
21
+
22
+ attr_accessor :metadata
23
+
24
+ # Indicates if API call was successful
25
+ attr_accessor :success
26
+
27
+ attr_accessor :warning
28
+
29
+ # Attribute mapping from ruby-style variable name to JSON key.
30
+ def self.attribute_map
31
+ {
32
+ :'error' => :'error',
33
+ :'loyalty_tiers' => :'loyalty_tiers',
34
+ :'metadata' => :'metadata',
35
+ :'success' => :'success',
36
+ :'warning' => :'warning'
37
+ }
38
+ end
39
+
40
+ # Returns all the JSON keys this model knows about
41
+ def self.acceptable_attributes
42
+ attribute_map.values
43
+ end
44
+
45
+ # Attribute type mapping.
46
+ def self.openapi_types
47
+ {
48
+ :'error' => :'Error',
49
+ :'loyalty_tiers' => :'Array<String>',
50
+ :'metadata' => :'ResponseMetadata',
51
+ :'success' => :'Boolean',
52
+ :'warning' => :'Warning'
53
+ }
54
+ end
55
+
56
+ # List of attributes with nullable: true
57
+ def self.openapi_nullable
58
+ Set.new([
59
+ ])
60
+ end
61
+
62
+ # Initializes the object
63
+ # @param [Hash] attributes Model attributes in the form of hash
64
+ def initialize(attributes = {})
65
+ if (!attributes.is_a?(Hash))
66
+ fail ArgumentError, "The input argument (attributes) must be a hash in `UltracartClient::EmailEditorValuesResponse` initialize method"
67
+ end
68
+
69
+ # check to see if the attribute exists and convert string to symbol for hash key
70
+ attributes = attributes.each_with_object({}) { |(k, v), h|
71
+ if (!self.class.attribute_map.key?(k.to_sym))
72
+ fail ArgumentError, "`#{k}` is not a valid attribute in `UltracartClient::EmailEditorValuesResponse`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
73
+ end
74
+ h[k.to_sym] = v
75
+ }
76
+
77
+ if attributes.key?(:'error')
78
+ self.error = attributes[:'error']
79
+ end
80
+
81
+ if attributes.key?(:'loyalty_tiers')
82
+ if (value = attributes[:'loyalty_tiers']).is_a?(Array)
83
+ self.loyalty_tiers = value
84
+ end
85
+ end
86
+
87
+ if attributes.key?(:'metadata')
88
+ self.metadata = attributes[:'metadata']
89
+ end
90
+
91
+ if attributes.key?(:'success')
92
+ self.success = attributes[:'success']
93
+ end
94
+
95
+ if attributes.key?(:'warning')
96
+ self.warning = attributes[:'warning']
97
+ end
98
+ end
99
+
100
+ # Show invalid properties with the reasons. Usually used together with valid?
101
+ # @return Array for valid properties with the reasons
102
+ def list_invalid_properties
103
+ invalid_properties = Array.new
104
+ invalid_properties
105
+ end
106
+
107
+ # Check to see if the all the properties in the model are valid
108
+ # @return true if the model is valid
109
+ def valid?
110
+ true
111
+ end
112
+
113
+ # Checks equality by comparing each attribute.
114
+ # @param [Object] Object to be compared
115
+ def ==(o)
116
+ return true if self.equal?(o)
117
+ self.class == o.class &&
118
+ error == o.error &&
119
+ loyalty_tiers == o.loyalty_tiers &&
120
+ metadata == o.metadata &&
121
+ success == o.success &&
122
+ warning == o.warning
123
+ end
124
+
125
+ # @see the `==` method
126
+ # @param [Object] Object to be compared
127
+ def eql?(o)
128
+ self == o
129
+ end
130
+
131
+ # Calculates hash code according to all attributes.
132
+ # @return [Integer] Hash code
133
+ def hash
134
+ [error, loyalty_tiers, metadata, success, warning].hash
135
+ end
136
+
137
+ # Builds the object from hash
138
+ # @param [Hash] attributes Model attributes in the form of hash
139
+ # @return [Object] Returns the model itself
140
+ def self.build_from_hash(attributes)
141
+ new.build_from_hash(attributes)
142
+ end
143
+
144
+ # Builds the object from hash
145
+ # @param [Hash] attributes Model attributes in the form of hash
146
+ # @return [Object] Returns the model itself
147
+ def build_from_hash(attributes)
148
+ return nil unless attributes.is_a?(Hash)
149
+ attributes = attributes.transform_keys(&:to_sym)
150
+ self.class.openapi_types.each_pair do |key, type|
151
+ if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
152
+ self.send("#{key}=", nil)
153
+ elsif type =~ /\AArray<(.*)>/i
154
+ # check to ensure the input is an array given that the attribute
155
+ # is documented as an array but the input is not
156
+ if attributes[self.class.attribute_map[key]].is_a?(Array)
157
+ self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
158
+ end
159
+ elsif !attributes[self.class.attribute_map[key]].nil?
160
+ self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
161
+ end
162
+ end
163
+
164
+ self
165
+ end
166
+
167
+ # Deserializes the data based on type
168
+ # @param string type Data type
169
+ # @param string value Value to be deserialized
170
+ # @return [Object] Deserialized data
171
+ def _deserialize(type, value)
172
+ case type.to_sym
173
+ when :Time
174
+ Time.parse(value)
175
+ when :Date
176
+ Date.parse(value)
177
+ when :String
178
+ value.to_s
179
+ when :Integer
180
+ value.to_i
181
+ when :Float
182
+ value.to_f
183
+ when :Boolean
184
+ if value.to_s =~ /\A(true|t|yes|y|1)\z/i
185
+ true
186
+ else
187
+ false
188
+ end
189
+ when :Object
190
+ # generic object (usually a Hash), return directly
191
+ value
192
+ when /\AArray<(?<inner_type>.+)>\z/
193
+ inner_type = Regexp.last_match[:inner_type]
194
+ value.map { |v| _deserialize(inner_type, v) }
195
+ when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
196
+ k_type = Regexp.last_match[:k_type]
197
+ v_type = Regexp.last_match[:v_type]
198
+ {}.tap do |hash|
199
+ value.each do |k, v|
200
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
201
+ end
202
+ end
203
+ else # model
204
+ # models (e.g. Pet) or oneOf
205
+ klass = UltracartClient.const_get(type)
206
+ klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
207
+ end
208
+ end
209
+
210
+ # Returns the string representation of the object
211
+ # @return [String] String presentation of the object
212
+ def to_s
213
+ to_hash.to_s
214
+ end
215
+
216
+ # to_body is an alias to to_hash (backward compatibility)
217
+ # @return [Hash] Returns the object in the form of hash
218
+ def to_body
219
+ to_hash
220
+ end
221
+
222
+ # Returns the object in the form of hash
223
+ # @return [Hash] Returns the object in the form of hash
224
+ def to_hash
225
+ hash = {}
226
+ self.class.attribute_map.each_pair do |attr, param|
227
+ value = self.send(attr)
228
+ if value.nil?
229
+ is_nullable = self.class.openapi_nullable.include?(attr)
230
+ next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
231
+ end
232
+
233
+ hash[param] = _to_hash(value)
234
+ end
235
+ hash
236
+ end
237
+
238
+ # Outputs non-array value in the form of hash
239
+ # For object, use to_hash. Otherwise, just return the value
240
+ # @param [Object] value Any valid value
241
+ # @return [Hash] Returns the value in the form of hash
242
+ def _to_hash(value)
243
+ if value.is_a?(Array)
244
+ value.compact.map { |v| _to_hash(v) }
245
+ elsif value.is_a?(Hash)
246
+ {}.tap do |hash|
247
+ value.each { |k, v| hash[k] = _to_hash(v) }
248
+ end
249
+ elsif value.respond_to? :to_hash
250
+ value.to_hash
251
+ else
252
+ value
253
+ end
254
+ end
255
+
256
+ end
257
+
258
+ end
@@ -11,5 +11,5 @@ OpenAPI Generator version: 6.0.1-SNAPSHOT
11
11
  =end
12
12
 
13
13
  module UltracartClient
14
- VERSION = '4.1.15'
14
+ VERSION = '4.1.17'
15
15
  end
data/lib/ultracart_api.rb CHANGED
@@ -321,16 +321,26 @@ require 'ultracart_api/models/coupon_type'
321
321
  require 'ultracart_api/models/coupons_request'
322
322
  require 'ultracart_api/models/coupons_response'
323
323
  require 'ultracart_api/models/currency'
324
+ require 'ultracart_api/models/custom_dashboard'
325
+ require 'ultracart_api/models/custom_dashboard_page'
326
+ require 'ultracart_api/models/custom_dashboard_page_report'
327
+ require 'ultracart_api/models/custom_dashboard_response'
328
+ require 'ultracart_api/models/custom_dashboards_response'
324
329
  require 'ultracart_api/models/custom_report'
325
330
  require 'ultracart_api/models/custom_report_account_config'
326
331
  require 'ultracart_api/models/custom_report_account_config_response'
327
332
  require 'ultracart_api/models/custom_report_execution_parameter'
328
333
  require 'ultracart_api/models/custom_report_execution_request'
334
+ require 'ultracart_api/models/custom_report_execution_response'
329
335
  require 'ultracart_api/models/custom_report_parameter'
330
336
  require 'ultracart_api/models/custom_report_parameter_option'
331
337
  require 'ultracart_api/models/custom_report_query'
332
338
  require 'ultracart_api/models/custom_report_response'
333
339
  require 'ultracart_api/models/custom_report_tooltip'
340
+ require 'ultracart_api/models/custom_reports_execution_report_data'
341
+ require 'ultracart_api/models/custom_reports_execution_request'
342
+ require 'ultracart_api/models/custom_reports_execution_response'
343
+ require 'ultracart_api/models/custom_reports_response'
334
344
  require 'ultracart_api/models/customer'
335
345
  require 'ultracart_api/models/customer_activity'
336
346
  require 'ultracart_api/models/customer_affiliate'
@@ -413,6 +423,7 @@ require 'ultracart_api/models/email_dashboard_activity_response'
413
423
  require 'ultracart_api/models/email_dashboard_stats_response'
414
424
  require 'ultracart_api/models/email_domain'
415
425
  require 'ultracart_api/models/email_editor_token_response'
426
+ require 'ultracart_api/models/email_editor_values_response'
416
427
  require 'ultracart_api/models/email_flow'
417
428
  require 'ultracart_api/models/email_flow_back_populate_request'
418
429
  require 'ultracart_api/models/email_flow_back_populate_response'
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.1.15
4
+ version: 4.1.17
5
5
  platform: ruby
6
6
  authors:
7
7
  - UltraCart
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2025-07-28 00:00:00.000000000 Z
11
+ date: 2025-08-04 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: typhoeus
@@ -372,16 +372,26 @@ files:
372
372
  - docs/CouponsRequest.md
373
373
  - docs/CouponsResponse.md
374
374
  - docs/Currency.md
375
+ - docs/CustomDashboard.md
376
+ - docs/CustomDashboardPage.md
377
+ - docs/CustomDashboardPageReport.md
378
+ - docs/CustomDashboardResponse.md
379
+ - docs/CustomDashboardsResponse.md
375
380
  - docs/CustomReport.md
376
381
  - docs/CustomReportAccountConfig.md
377
382
  - docs/CustomReportAccountConfigResponse.md
378
383
  - docs/CustomReportExecutionParameter.md
379
384
  - docs/CustomReportExecutionRequest.md
385
+ - docs/CustomReportExecutionResponse.md
380
386
  - docs/CustomReportParameter.md
381
387
  - docs/CustomReportParameterOption.md
382
388
  - docs/CustomReportQuery.md
383
389
  - docs/CustomReportResponse.md
384
390
  - docs/CustomReportTooltip.md
391
+ - docs/CustomReportsExecutionReportData.md
392
+ - docs/CustomReportsExecutionRequest.md
393
+ - docs/CustomReportsExecutionResponse.md
394
+ - docs/CustomReportsResponse.md
385
395
  - docs/Customer.md
386
396
  - docs/CustomerActivity.md
387
397
  - docs/CustomerAffiliate.md
@@ -466,6 +476,7 @@ files:
466
476
  - docs/EmailDashboardStatsResponse.md
467
477
  - docs/EmailDomain.md
468
478
  - docs/EmailEditorTokenResponse.md
479
+ - docs/EmailEditorValuesResponse.md
469
480
  - docs/EmailFlow.md
470
481
  - docs/EmailFlowBackPopulateRequest.md
471
482
  - docs/EmailFlowBackPopulateResponse.md
@@ -1285,16 +1296,26 @@ files:
1285
1296
  - lib/ultracart_api/models/coupons_request.rb
1286
1297
  - lib/ultracart_api/models/coupons_response.rb
1287
1298
  - lib/ultracart_api/models/currency.rb
1299
+ - lib/ultracart_api/models/custom_dashboard.rb
1300
+ - lib/ultracart_api/models/custom_dashboard_page.rb
1301
+ - lib/ultracart_api/models/custom_dashboard_page_report.rb
1302
+ - lib/ultracart_api/models/custom_dashboard_response.rb
1303
+ - lib/ultracart_api/models/custom_dashboards_response.rb
1288
1304
  - lib/ultracart_api/models/custom_report.rb
1289
1305
  - lib/ultracart_api/models/custom_report_account_config.rb
1290
1306
  - lib/ultracart_api/models/custom_report_account_config_response.rb
1291
1307
  - lib/ultracart_api/models/custom_report_execution_parameter.rb
1292
1308
  - lib/ultracart_api/models/custom_report_execution_request.rb
1309
+ - lib/ultracart_api/models/custom_report_execution_response.rb
1293
1310
  - lib/ultracart_api/models/custom_report_parameter.rb
1294
1311
  - lib/ultracart_api/models/custom_report_parameter_option.rb
1295
1312
  - lib/ultracart_api/models/custom_report_query.rb
1296
1313
  - lib/ultracart_api/models/custom_report_response.rb
1297
1314
  - lib/ultracart_api/models/custom_report_tooltip.rb
1315
+ - lib/ultracart_api/models/custom_reports_execution_report_data.rb
1316
+ - lib/ultracart_api/models/custom_reports_execution_request.rb
1317
+ - lib/ultracart_api/models/custom_reports_execution_response.rb
1318
+ - lib/ultracart_api/models/custom_reports_response.rb
1298
1319
  - lib/ultracart_api/models/customer.rb
1299
1320
  - lib/ultracart_api/models/customer_activity.rb
1300
1321
  - lib/ultracart_api/models/customer_affiliate.rb
@@ -1377,6 +1398,7 @@ files:
1377
1398
  - lib/ultracart_api/models/email_dashboard_stats_response.rb
1378
1399
  - lib/ultracart_api/models/email_domain.rb
1379
1400
  - lib/ultracart_api/models/email_editor_token_response.rb
1401
+ - lib/ultracart_api/models/email_editor_values_response.rb
1380
1402
  - lib/ultracart_api/models/email_flow.rb
1381
1403
  - lib/ultracart_api/models/email_flow_back_populate_request.rb
1382
1404
  - lib/ultracart_api/models/email_flow_back_populate_response.rb