ultracart_api 3.11.16 → 3.11.18
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +23 -4
- data/docs/CustomDashboard.md +11 -0
- data/docs/CustomDashboardPage.md +10 -0
- data/docs/CustomDashboardPageReport.md +12 -0
- data/docs/CustomDashboardResponse.md +12 -0
- data/docs/CustomDashboardsResponse.md +12 -0
- data/docs/CustomReportExecutionResponse.md +15 -0
- data/docs/CustomReportsExecutionReportData.md +10 -0
- data/docs/CustomReportsExecutionRequest.md +9 -0
- data/docs/CustomReportsExecutionResponse.md +13 -0
- data/docs/DatawarehouseApi.md +305 -2
- data/docs/EmailEditorValuesResponse.md +12 -0
- data/docs/StorefrontApi.md +49 -0
- data/lib/ultracart_api/api/datawarehouse_api.rb +332 -3
- data/lib/ultracart_api/api/storefront_api.rb +53 -0
- data/lib/ultracart_api/models/custom_dashboard.rb +213 -0
- data/lib/ultracart_api/models/custom_dashboard_page.rb +204 -0
- data/lib/ultracart_api/models/custom_dashboard_page_report.rb +220 -0
- data/lib/ultracart_api/models/custom_dashboard_response.rb +221 -0
- data/lib/ultracart_api/models/custom_dashboards_response.rb +224 -0
- data/lib/ultracart_api/models/custom_report_execution_response.rb +250 -0
- data/lib/ultracart_api/models/custom_reports_execution_report_data.rb +202 -0
- data/lib/ultracart_api/models/custom_reports_execution_request.rb +197 -0
- data/lib/ultracart_api/models/custom_reports_execution_response.rb +234 -0
- data/lib/ultracart_api/models/email_editor_values_response.rb +223 -0
- data/lib/ultracart_api/version.rb +1 -1
- data/lib/ultracart_api.rb +10 -0
- metadata +22 -2
@@ -0,0 +1,223 @@
|
|
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 EmailEditorValuesResponse
|
17
|
+
attr_accessor :error
|
18
|
+
|
19
|
+
attr_accessor :loyalty_tiers
|
20
|
+
|
21
|
+
attr_accessor :metadata
|
22
|
+
|
23
|
+
# Indicates if API call was successful
|
24
|
+
attr_accessor :success
|
25
|
+
|
26
|
+
attr_accessor :warning
|
27
|
+
|
28
|
+
# Attribute mapping from ruby-style variable name to JSON key.
|
29
|
+
def self.attribute_map
|
30
|
+
{
|
31
|
+
:'error' => :'error',
|
32
|
+
:'loyalty_tiers' => :'loyalty_tiers',
|
33
|
+
:'metadata' => :'metadata',
|
34
|
+
:'success' => :'success',
|
35
|
+
:'warning' => :'warning'
|
36
|
+
}
|
37
|
+
end
|
38
|
+
|
39
|
+
# Attribute type mapping.
|
40
|
+
def self.swagger_types
|
41
|
+
{
|
42
|
+
:'error' => :'Error',
|
43
|
+
:'loyalty_tiers' => :'Array<String>',
|
44
|
+
:'metadata' => :'ResponseMetadata',
|
45
|
+
:'success' => :'BOOLEAN',
|
46
|
+
:'warning' => :'Warning'
|
47
|
+
}
|
48
|
+
end
|
49
|
+
|
50
|
+
# Initializes the object
|
51
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
52
|
+
def initialize(attributes = {})
|
53
|
+
return unless attributes.is_a?(Hash)
|
54
|
+
|
55
|
+
# convert string to symbol for hash key
|
56
|
+
attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
|
57
|
+
|
58
|
+
if attributes.has_key?(:'error')
|
59
|
+
self.error = attributes[:'error']
|
60
|
+
end
|
61
|
+
|
62
|
+
if attributes.has_key?(:'loyalty_tiers')
|
63
|
+
if (value = attributes[:'loyalty_tiers']).is_a?(Array)
|
64
|
+
self.loyalty_tiers = value
|
65
|
+
end
|
66
|
+
end
|
67
|
+
|
68
|
+
if attributes.has_key?(:'metadata')
|
69
|
+
self.metadata = attributes[:'metadata']
|
70
|
+
end
|
71
|
+
|
72
|
+
if attributes.has_key?(:'success')
|
73
|
+
self.success = attributes[:'success']
|
74
|
+
end
|
75
|
+
|
76
|
+
if attributes.has_key?(:'warning')
|
77
|
+
self.warning = attributes[:'warning']
|
78
|
+
end
|
79
|
+
end
|
80
|
+
|
81
|
+
# Show invalid properties with the reasons. Usually used together with valid?
|
82
|
+
# @return Array for valid properties with the reasons
|
83
|
+
def list_invalid_properties
|
84
|
+
invalid_properties = Array.new
|
85
|
+
invalid_properties
|
86
|
+
end
|
87
|
+
|
88
|
+
# Check to see if the all the properties in the model are valid
|
89
|
+
# @return true if the model is valid
|
90
|
+
def valid?
|
91
|
+
true
|
92
|
+
end
|
93
|
+
|
94
|
+
# Checks equality by comparing each attribute.
|
95
|
+
# @param [Object] Object to be compared
|
96
|
+
def ==(o)
|
97
|
+
return true if self.equal?(o)
|
98
|
+
self.class == o.class &&
|
99
|
+
error == o.error &&
|
100
|
+
loyalty_tiers == o.loyalty_tiers &&
|
101
|
+
metadata == o.metadata &&
|
102
|
+
success == o.success &&
|
103
|
+
warning == o.warning
|
104
|
+
end
|
105
|
+
|
106
|
+
# @see the `==` method
|
107
|
+
# @param [Object] Object to be compared
|
108
|
+
def eql?(o)
|
109
|
+
self == o
|
110
|
+
end
|
111
|
+
|
112
|
+
# Calculates hash code according to all attributes.
|
113
|
+
# @return [Fixnum] Hash code
|
114
|
+
def hash
|
115
|
+
[error, loyalty_tiers, metadata, success, warning].hash
|
116
|
+
end
|
117
|
+
|
118
|
+
# Builds the object from hash
|
119
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
120
|
+
# @return [Object] Returns the model itself
|
121
|
+
def build_from_hash(attributes)
|
122
|
+
return nil unless attributes.is_a?(Hash)
|
123
|
+
self.class.swagger_types.each_pair do |key, type|
|
124
|
+
if type =~ /\AArray<(.*)>/i
|
125
|
+
# check to ensure the input is an array given that the attribute
|
126
|
+
# is documented as an array but the input is not
|
127
|
+
if attributes[self.class.attribute_map[key]].is_a?(Array)
|
128
|
+
self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
|
129
|
+
end
|
130
|
+
elsif !attributes[self.class.attribute_map[key]].nil?
|
131
|
+
self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
|
132
|
+
end # or else data not found in attributes(hash), not an issue as the data can be optional
|
133
|
+
end
|
134
|
+
|
135
|
+
self
|
136
|
+
end
|
137
|
+
|
138
|
+
# Deserializes the data based on type
|
139
|
+
# @param string type Data type
|
140
|
+
# @param string value Value to be deserialized
|
141
|
+
# @return [Object] Deserialized data
|
142
|
+
def _deserialize(type, value)
|
143
|
+
case type.to_sym
|
144
|
+
when :DateTime
|
145
|
+
DateTime.parse(value)
|
146
|
+
when :Date
|
147
|
+
Date.parse(value)
|
148
|
+
when :String
|
149
|
+
value.to_s
|
150
|
+
when :Integer
|
151
|
+
value.to_i
|
152
|
+
when :Float
|
153
|
+
value.to_f
|
154
|
+
when :BOOLEAN
|
155
|
+
if value.to_s =~ /\A(true|t|yes|y|1)\z/i
|
156
|
+
true
|
157
|
+
else
|
158
|
+
false
|
159
|
+
end
|
160
|
+
when :Object
|
161
|
+
# generic object (usually a Hash), return directly
|
162
|
+
value
|
163
|
+
when /\AArray<(?<inner_type>.+)>\z/
|
164
|
+
inner_type = Regexp.last_match[:inner_type]
|
165
|
+
value.map { |v| _deserialize(inner_type, v) }
|
166
|
+
when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
|
167
|
+
k_type = Regexp.last_match[:k_type]
|
168
|
+
v_type = Regexp.last_match[:v_type]
|
169
|
+
{}.tap do |hash|
|
170
|
+
value.each do |k, v|
|
171
|
+
hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
|
172
|
+
end
|
173
|
+
end
|
174
|
+
else # model
|
175
|
+
temp_model = UltracartClient.const_get(type).new
|
176
|
+
temp_model.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
|
+
next if value.nil?
|
199
|
+
hash[param] = _to_hash(value)
|
200
|
+
end
|
201
|
+
hash
|
202
|
+
end
|
203
|
+
|
204
|
+
# Outputs non-array value in the form of hash
|
205
|
+
# For object, use to_hash. Otherwise, just return the value
|
206
|
+
# @param [Object] value Any valid value
|
207
|
+
# @return [Hash] Returns the value in the form of hash
|
208
|
+
def _to_hash(value)
|
209
|
+
if value.is_a?(Array)
|
210
|
+
value.compact.map { |v| _to_hash(v) }
|
211
|
+
elsif value.is_a?(Hash)
|
212
|
+
{}.tap do |hash|
|
213
|
+
value.each { |k, v| hash[k] = _to_hash(v) }
|
214
|
+
end
|
215
|
+
elsif value.respond_to? :to_hash
|
216
|
+
value.to_hash
|
217
|
+
else
|
218
|
+
value
|
219
|
+
end
|
220
|
+
end
|
221
|
+
|
222
|
+
end
|
223
|
+
end
|
data/lib/ultracart_api.rb
CHANGED
@@ -322,16 +322,25 @@ 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_dashboard'
|
326
|
+
require 'ultracart_api/models/custom_dashboard_page'
|
327
|
+
require 'ultracart_api/models/custom_dashboard_page_report'
|
328
|
+
require 'ultracart_api/models/custom_dashboard_response'
|
329
|
+
require 'ultracart_api/models/custom_dashboards_response'
|
325
330
|
require 'ultracart_api/models/custom_report'
|
326
331
|
require 'ultracart_api/models/custom_report_account_config'
|
327
332
|
require 'ultracart_api/models/custom_report_account_config_response'
|
328
333
|
require 'ultracart_api/models/custom_report_execution_parameter'
|
329
334
|
require 'ultracart_api/models/custom_report_execution_request'
|
335
|
+
require 'ultracart_api/models/custom_report_execution_response'
|
330
336
|
require 'ultracart_api/models/custom_report_parameter'
|
331
337
|
require 'ultracart_api/models/custom_report_parameter_option'
|
332
338
|
require 'ultracart_api/models/custom_report_query'
|
333
339
|
require 'ultracart_api/models/custom_report_response'
|
334
340
|
require 'ultracart_api/models/custom_report_tooltip'
|
341
|
+
require 'ultracart_api/models/custom_reports_execution_report_data'
|
342
|
+
require 'ultracart_api/models/custom_reports_execution_request'
|
343
|
+
require 'ultracart_api/models/custom_reports_execution_response'
|
335
344
|
require 'ultracart_api/models/custom_reports_response'
|
336
345
|
require 'ultracart_api/models/customer'
|
337
346
|
require 'ultracart_api/models/customer_activity'
|
@@ -415,6 +424,7 @@ require 'ultracart_api/models/email_dashboard_activity_response'
|
|
415
424
|
require 'ultracart_api/models/email_dashboard_stats_response'
|
416
425
|
require 'ultracart_api/models/email_domain'
|
417
426
|
require 'ultracart_api/models/email_editor_token_response'
|
427
|
+
require 'ultracart_api/models/email_editor_values_response'
|
418
428
|
require 'ultracart_api/models/email_flow'
|
419
429
|
require 'ultracart_api/models/email_flow_back_populate_request'
|
420
430
|
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: 3.11.
|
4
|
+
version: 3.11.18
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- UltraCart
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2025-
|
11
|
+
date: 2025-08-04 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: typhoeus
|
@@ -533,16 +533,25 @@ files:
|
|
533
533
|
- docs/CouponsRequest.md
|
534
534
|
- docs/CouponsResponse.md
|
535
535
|
- docs/Currency.md
|
536
|
+
- docs/CustomDashboard.md
|
537
|
+
- docs/CustomDashboardPage.md
|
538
|
+
- docs/CustomDashboardPageReport.md
|
539
|
+
- docs/CustomDashboardResponse.md
|
540
|
+
- docs/CustomDashboardsResponse.md
|
536
541
|
- docs/CustomReport.md
|
537
542
|
- docs/CustomReportAccountConfig.md
|
538
543
|
- docs/CustomReportAccountConfigResponse.md
|
539
544
|
- docs/CustomReportExecutionParameter.md
|
540
545
|
- docs/CustomReportExecutionRequest.md
|
546
|
+
- docs/CustomReportExecutionResponse.md
|
541
547
|
- docs/CustomReportParameter.md
|
542
548
|
- docs/CustomReportParameterOption.md
|
543
549
|
- docs/CustomReportQuery.md
|
544
550
|
- docs/CustomReportResponse.md
|
545
551
|
- docs/CustomReportTooltip.md
|
552
|
+
- docs/CustomReportsExecutionReportData.md
|
553
|
+
- docs/CustomReportsExecutionRequest.md
|
554
|
+
- docs/CustomReportsExecutionResponse.md
|
546
555
|
- docs/CustomReportsResponse.md
|
547
556
|
- docs/Customer.md
|
548
557
|
- docs/CustomerActivity.md
|
@@ -628,6 +637,7 @@ files:
|
|
628
637
|
- docs/EmailDashboardStatsResponse.md
|
629
638
|
- docs/EmailDomain.md
|
630
639
|
- docs/EmailEditorTokenResponse.md
|
640
|
+
- docs/EmailEditorValuesResponse.md
|
631
641
|
- docs/EmailFlow.md
|
632
642
|
- docs/EmailFlowBackPopulateRequest.md
|
633
643
|
- docs/EmailFlowBackPopulateResponse.md
|
@@ -1448,16 +1458,25 @@ files:
|
|
1448
1458
|
- lib/ultracart_api/models/coupons_request.rb
|
1449
1459
|
- lib/ultracart_api/models/coupons_response.rb
|
1450
1460
|
- lib/ultracart_api/models/currency.rb
|
1461
|
+
- lib/ultracart_api/models/custom_dashboard.rb
|
1462
|
+
- lib/ultracart_api/models/custom_dashboard_page.rb
|
1463
|
+
- lib/ultracart_api/models/custom_dashboard_page_report.rb
|
1464
|
+
- lib/ultracart_api/models/custom_dashboard_response.rb
|
1465
|
+
- lib/ultracart_api/models/custom_dashboards_response.rb
|
1451
1466
|
- lib/ultracart_api/models/custom_report.rb
|
1452
1467
|
- lib/ultracart_api/models/custom_report_account_config.rb
|
1453
1468
|
- lib/ultracart_api/models/custom_report_account_config_response.rb
|
1454
1469
|
- lib/ultracart_api/models/custom_report_execution_parameter.rb
|
1455
1470
|
- lib/ultracart_api/models/custom_report_execution_request.rb
|
1471
|
+
- lib/ultracart_api/models/custom_report_execution_response.rb
|
1456
1472
|
- lib/ultracart_api/models/custom_report_parameter.rb
|
1457
1473
|
- lib/ultracart_api/models/custom_report_parameter_option.rb
|
1458
1474
|
- lib/ultracart_api/models/custom_report_query.rb
|
1459
1475
|
- lib/ultracart_api/models/custom_report_response.rb
|
1460
1476
|
- lib/ultracart_api/models/custom_report_tooltip.rb
|
1477
|
+
- lib/ultracart_api/models/custom_reports_execution_report_data.rb
|
1478
|
+
- lib/ultracart_api/models/custom_reports_execution_request.rb
|
1479
|
+
- lib/ultracart_api/models/custom_reports_execution_response.rb
|
1461
1480
|
- lib/ultracart_api/models/custom_reports_response.rb
|
1462
1481
|
- lib/ultracart_api/models/customer.rb
|
1463
1482
|
- lib/ultracart_api/models/customer_activity.rb
|
@@ -1541,6 +1560,7 @@ files:
|
|
1541
1560
|
- lib/ultracart_api/models/email_dashboard_stats_response.rb
|
1542
1561
|
- lib/ultracart_api/models/email_domain.rb
|
1543
1562
|
- lib/ultracart_api/models/email_editor_token_response.rb
|
1563
|
+
- lib/ultracart_api/models/email_editor_values_response.rb
|
1544
1564
|
- lib/ultracart_api/models/email_flow.rb
|
1545
1565
|
- lib/ultracart_api/models/email_flow_back_populate_request.rb
|
1546
1566
|
- lib/ultracart_api/models/email_flow_back_populate_response.rb
|