ultracart_api 3.11.14 → 3.11.16

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 (39) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +27 -5
  3. data/docs/CartUpsellAfter.md +3 -1
  4. data/docs/ConversationVirtualAgentCapabilities.md +2 -0
  5. data/docs/CustomReport.md +17 -0
  6. data/docs/CustomReportAccountConfig.md +16 -0
  7. data/docs/CustomReportAccountConfigResponse.md +12 -0
  8. data/docs/CustomReportExecutionParameter.md +10 -0
  9. data/docs/CustomReportExecutionRequest.md +8 -0
  10. data/docs/CustomReportParameter.md +13 -0
  11. data/docs/CustomReportParameterOption.md +9 -0
  12. data/docs/CustomReportQuery.md +13 -0
  13. data/docs/CustomReportResponse.md +12 -0
  14. data/docs/CustomReportTooltip.md +9 -0
  15. data/docs/CustomReportsResponse.md +12 -0
  16. data/docs/DatawarehouseApi.md +403 -0
  17. data/docs/Item.md +1 -1
  18. data/docs/OrderApi.md +98 -65
  19. data/docs/WebhookApi.md +0 -16
  20. data/lib/ultracart_api/api/datawarehouse_api.rb +439 -0
  21. data/lib/ultracart_api/api/order_api.rb +111 -82
  22. data/lib/ultracart_api/api/webhook_api.rb +0 -24
  23. data/lib/ultracart_api/models/cart_upsell_after.rb +25 -5
  24. data/lib/ultracart_api/models/conversation_virtual_agent_capabilities.rb +55 -1
  25. data/lib/ultracart_api/models/custom_report.rb +271 -0
  26. data/lib/ultracart_api/models/custom_report_account_config.rb +261 -0
  27. data/lib/ultracart_api/models/custom_report_account_config_response.rb +221 -0
  28. data/lib/ultracart_api/models/custom_report_execution_parameter.rb +202 -0
  29. data/lib/ultracart_api/models/custom_report_execution_request.rb +186 -0
  30. data/lib/ultracart_api/models/custom_report_parameter.rb +231 -0
  31. data/lib/ultracart_api/models/custom_report_parameter_option.rb +193 -0
  32. data/lib/ultracart_api/models/custom_report_query.rb +231 -0
  33. data/lib/ultracart_api/models/custom_report_response.rb +221 -0
  34. data/lib/ultracart_api/models/custom_report_tooltip.rb +193 -0
  35. data/lib/ultracart_api/models/custom_reports_response.rb +224 -0
  36. data/lib/ultracart_api/models/item.rb +1 -1
  37. data/lib/ultracart_api/version.rb +1 -1
  38. data/lib/ultracart_api.rb +11 -0
  39. metadata +24 -2
@@ -0,0 +1,224 @@
1
+ =begin
2
+ #UltraCart Rest API V2
3
+
4
+ #UltraCart REST API Version 2
5
+
6
+ OpenAPI spec version: 2.0.0
7
+ Contact: support@ultracart.com
8
+ Generated by: https://github.com/swagger-api/swagger-codegen.git
9
+ Swagger Codegen version: 2.4.15-SNAPSHOT
10
+
11
+ =end
12
+
13
+ require 'date'
14
+
15
+ module UltracartClient
16
+ class CustomReportsResponse
17
+ attr_accessor :error
18
+
19
+ attr_accessor :metadata
20
+
21
+ # reports
22
+ attr_accessor :reports
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
+ :'metadata' => :'metadata',
34
+ :'reports' => :'reports',
35
+ :'success' => :'success',
36
+ :'warning' => :'warning'
37
+ }
38
+ end
39
+
40
+ # Attribute type mapping.
41
+ def self.swagger_types
42
+ {
43
+ :'error' => :'Error',
44
+ :'metadata' => :'ResponseMetadata',
45
+ :'reports' => :'Array<CustomReport>',
46
+ :'success' => :'BOOLEAN',
47
+ :'warning' => :'Warning'
48
+ }
49
+ end
50
+
51
+ # Initializes the object
52
+ # @param [Hash] attributes Model attributes in the form of hash
53
+ def initialize(attributes = {})
54
+ return unless attributes.is_a?(Hash)
55
+
56
+ # convert string to symbol for hash key
57
+ attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
58
+
59
+ if attributes.has_key?(:'error')
60
+ self.error = attributes[:'error']
61
+ end
62
+
63
+ if attributes.has_key?(:'metadata')
64
+ self.metadata = attributes[:'metadata']
65
+ end
66
+
67
+ if attributes.has_key?(:'reports')
68
+ if (value = attributes[:'reports']).is_a?(Array)
69
+ self.reports = value
70
+ end
71
+ end
72
+
73
+ if attributes.has_key?(:'success')
74
+ self.success = attributes[:'success']
75
+ end
76
+
77
+ if attributes.has_key?(:'warning')
78
+ self.warning = attributes[:'warning']
79
+ end
80
+ end
81
+
82
+ # Show invalid properties with the reasons. Usually used together with valid?
83
+ # @return Array for valid properties with the reasons
84
+ def list_invalid_properties
85
+ invalid_properties = Array.new
86
+ invalid_properties
87
+ end
88
+
89
+ # Check to see if the all the properties in the model are valid
90
+ # @return true if the model is valid
91
+ def valid?
92
+ true
93
+ end
94
+
95
+ # Checks equality by comparing each attribute.
96
+ # @param [Object] Object to be compared
97
+ def ==(o)
98
+ return true if self.equal?(o)
99
+ self.class == o.class &&
100
+ error == o.error &&
101
+ metadata == o.metadata &&
102
+ reports == o.reports &&
103
+ success == o.success &&
104
+ warning == o.warning
105
+ end
106
+
107
+ # @see the `==` method
108
+ # @param [Object] Object to be compared
109
+ def eql?(o)
110
+ self == o
111
+ end
112
+
113
+ # Calculates hash code according to all attributes.
114
+ # @return [Fixnum] Hash code
115
+ def hash
116
+ [error, metadata, reports, success, warning].hash
117
+ end
118
+
119
+ # Builds the object from hash
120
+ # @param [Hash] attributes Model attributes in the form of hash
121
+ # @return [Object] Returns the model itself
122
+ def build_from_hash(attributes)
123
+ return nil unless attributes.is_a?(Hash)
124
+ self.class.swagger_types.each_pair do |key, type|
125
+ if type =~ /\AArray<(.*)>/i
126
+ # check to ensure the input is an array given that the attribute
127
+ # is documented as an array but the input is not
128
+ if attributes[self.class.attribute_map[key]].is_a?(Array)
129
+ self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
130
+ end
131
+ elsif !attributes[self.class.attribute_map[key]].nil?
132
+ self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
133
+ end # or else data not found in attributes(hash), not an issue as the data can be optional
134
+ end
135
+
136
+ self
137
+ end
138
+
139
+ # Deserializes the data based on type
140
+ # @param string type Data type
141
+ # @param string value Value to be deserialized
142
+ # @return [Object] Deserialized data
143
+ def _deserialize(type, value)
144
+ case type.to_sym
145
+ when :DateTime
146
+ DateTime.parse(value)
147
+ when :Date
148
+ Date.parse(value)
149
+ when :String
150
+ value.to_s
151
+ when :Integer
152
+ value.to_i
153
+ when :Float
154
+ value.to_f
155
+ when :BOOLEAN
156
+ if value.to_s =~ /\A(true|t|yes|y|1)\z/i
157
+ true
158
+ else
159
+ false
160
+ end
161
+ when :Object
162
+ # generic object (usually a Hash), return directly
163
+ value
164
+ when /\AArray<(?<inner_type>.+)>\z/
165
+ inner_type = Regexp.last_match[:inner_type]
166
+ value.map { |v| _deserialize(inner_type, v) }
167
+ when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
168
+ k_type = Regexp.last_match[:k_type]
169
+ v_type = Regexp.last_match[:v_type]
170
+ {}.tap do |hash|
171
+ value.each do |k, v|
172
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
173
+ end
174
+ end
175
+ else # model
176
+ temp_model = UltracartClient.const_get(type).new
177
+ temp_model.build_from_hash(value)
178
+ end
179
+ end
180
+
181
+ # Returns the string representation of the object
182
+ # @return [String] String presentation of the object
183
+ def to_s
184
+ to_hash.to_s
185
+ end
186
+
187
+ # to_body is an alias to to_hash (backward compatibility)
188
+ # @return [Hash] Returns the object in the form of hash
189
+ def to_body
190
+ to_hash
191
+ end
192
+
193
+ # Returns the object in the form of hash
194
+ # @return [Hash] Returns the object in the form of hash
195
+ def to_hash
196
+ hash = {}
197
+ self.class.attribute_map.each_pair do |attr, param|
198
+ value = self.send(attr)
199
+ next if value.nil?
200
+ hash[param] = _to_hash(value)
201
+ end
202
+ hash
203
+ end
204
+
205
+ # Outputs non-array value in the form of hash
206
+ # For object, use to_hash. Otherwise, just return the value
207
+ # @param [Object] value Any valid value
208
+ # @return [Hash] Returns the value in the form of hash
209
+ def _to_hash(value)
210
+ if value.is_a?(Array)
211
+ value.compact.map { |v| _to_hash(v) }
212
+ elsif value.is_a?(Hash)
213
+ {}.tap do |hash|
214
+ value.each { |k, v| hash[k] = _to_hash(v) }
215
+ end
216
+ elsif value.respond_to? :to_hash
217
+ value.to_hash
218
+ else
219
+ value
220
+ end
221
+ end
222
+
223
+ end
224
+ end
@@ -90,7 +90,7 @@ module UltracartClient
90
90
  # Parent category of the item. Zero indicates the root folder.
91
91
  attr_accessor :parent_category_id
92
92
 
93
- # Parent category path. / indicates the root folder.
93
+ # Parent category path. / indicates the root folder. This is the folder structure within item management.
94
94
  attr_accessor :parent_category_path
95
95
 
96
96
  attr_accessor :payment_processing
@@ -11,5 +11,5 @@ Swagger Codegen version: 2.4.15-SNAPSHOT
11
11
  =end
12
12
 
13
13
  module UltracartClient
14
- VERSION = '3.11.14'
14
+ VERSION = '3.11.16'
15
15
  end
data/lib/ultracart_api.rb CHANGED
@@ -322,6 +322,17 @@ require 'ultracart_api/models/coupon_type'
322
322
  require 'ultracart_api/models/coupons_request'
323
323
  require 'ultracart_api/models/coupons_response'
324
324
  require 'ultracart_api/models/currency'
325
+ require 'ultracart_api/models/custom_report'
326
+ require 'ultracart_api/models/custom_report_account_config'
327
+ require 'ultracart_api/models/custom_report_account_config_response'
328
+ require 'ultracart_api/models/custom_report_execution_parameter'
329
+ require 'ultracart_api/models/custom_report_execution_request'
330
+ require 'ultracart_api/models/custom_report_parameter'
331
+ require 'ultracart_api/models/custom_report_parameter_option'
332
+ require 'ultracart_api/models/custom_report_query'
333
+ require 'ultracart_api/models/custom_report_response'
334
+ require 'ultracart_api/models/custom_report_tooltip'
335
+ require 'ultracart_api/models/custom_reports_response'
325
336
  require 'ultracart_api/models/customer'
326
337
  require 'ultracart_api/models/customer_activity'
327
338
  require 'ultracart_api/models/customer_affiliate'
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: ultracart_api
3
3
  version: !ruby/object:Gem::Version
4
- version: 3.11.14
4
+ version: 3.11.16
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-10 00:00:00.000000000 Z
11
+ date: 2025-07-28 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: typhoeus
@@ -533,6 +533,17 @@ files:
533
533
  - docs/CouponsRequest.md
534
534
  - docs/CouponsResponse.md
535
535
  - docs/Currency.md
536
+ - docs/CustomReport.md
537
+ - docs/CustomReportAccountConfig.md
538
+ - docs/CustomReportAccountConfigResponse.md
539
+ - docs/CustomReportExecutionParameter.md
540
+ - docs/CustomReportExecutionRequest.md
541
+ - docs/CustomReportParameter.md
542
+ - docs/CustomReportParameterOption.md
543
+ - docs/CustomReportQuery.md
544
+ - docs/CustomReportResponse.md
545
+ - docs/CustomReportTooltip.md
546
+ - docs/CustomReportsResponse.md
536
547
  - docs/Customer.md
537
548
  - docs/CustomerActivity.md
538
549
  - docs/CustomerAffiliate.md
@@ -1437,6 +1448,17 @@ files:
1437
1448
  - lib/ultracart_api/models/coupons_request.rb
1438
1449
  - lib/ultracart_api/models/coupons_response.rb
1439
1450
  - lib/ultracart_api/models/currency.rb
1451
+ - lib/ultracart_api/models/custom_report.rb
1452
+ - lib/ultracart_api/models/custom_report_account_config.rb
1453
+ - lib/ultracart_api/models/custom_report_account_config_response.rb
1454
+ - lib/ultracart_api/models/custom_report_execution_parameter.rb
1455
+ - lib/ultracart_api/models/custom_report_execution_request.rb
1456
+ - lib/ultracart_api/models/custom_report_parameter.rb
1457
+ - lib/ultracart_api/models/custom_report_parameter_option.rb
1458
+ - lib/ultracart_api/models/custom_report_query.rb
1459
+ - lib/ultracart_api/models/custom_report_response.rb
1460
+ - lib/ultracart_api/models/custom_report_tooltip.rb
1461
+ - lib/ultracart_api/models/custom_reports_response.rb
1440
1462
  - lib/ultracart_api/models/customer.rb
1441
1463
  - lib/ultracart_api/models/customer_activity.rb
1442
1464
  - lib/ultracart_api/models/customer_affiliate.rb