ultracart_api 4.1.252 → 4.1.254

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 (38) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +17 -2
  3. data/docs/SfvbApi.md +238 -12
  4. data/docs/SfvbApprovalParams.md +6 -0
  5. data/docs/SfvbFileContentResult.md +22 -0
  6. data/docs/SfvbFilesContentRequest.md +18 -0
  7. data/docs/SfvbFilesContentResponse.md +20 -0
  8. data/docs/SfvbMenusResponse.md +1 -1
  9. data/docs/SfvbPageListResponse.md +5 -1
  10. data/docs/SfvbPageMoveRequest.md +26 -0
  11. data/docs/SfvbPageMoveResponse.md +32 -0
  12. data/docs/SfvbPageResponse.md +6 -0
  13. data/docs/SfvbPageSettingsRequest.md +6 -0
  14. data/docs/SfvbPageSummary.md +4 -0
  15. data/docs/SfvbSearchFacet.md +26 -0
  16. data/docs/SfvbSearchFacetUpdate.md +24 -0
  17. data/docs/SfvbSearchFacetsRequest.md +22 -0
  18. data/docs/SfvbSearchFacetsResponse.md +30 -0
  19. data/lib/ultracart_api/api/sfvb_api.rb +326 -20
  20. data/lib/ultracart_api/models/sfvb_approval_create_request.rb +2 -2
  21. data/lib/ultracart_api/models/sfvb_approval_params.rb +31 -1
  22. data/lib/ultracart_api/models/sfvb_file_content_result.rb +238 -0
  23. data/lib/ultracart_api/models/sfvb_files_content_request.rb +222 -0
  24. data/lib/ultracart_api/models/sfvb_files_content_response.rb +234 -0
  25. data/lib/ultracart_api/models/sfvb_menus_response.rb +1 -1
  26. data/lib/ultracart_api/models/sfvb_page_list_response.rb +24 -4
  27. data/lib/ultracart_api/models/sfvb_page_move_request.rb +294 -0
  28. data/lib/ultracart_api/models/sfvb_page_move_response.rb +290 -0
  29. data/lib/ultracart_api/models/sfvb_page_response.rb +32 -1
  30. data/lib/ultracart_api/models/sfvb_page_settings_request.rb +65 -1
  31. data/lib/ultracart_api/models/sfvb_page_summary.rb +20 -1
  32. data/lib/ultracart_api/models/sfvb_search_facet.rb +260 -0
  33. data/lib/ultracart_api/models/sfvb_search_facet_update.rb +250 -0
  34. data/lib/ultracart_api/models/sfvb_search_facets_request.rb +244 -0
  35. data/lib/ultracart_api/models/sfvb_search_facets_response.rb +286 -0
  36. data/lib/ultracart_api/version.rb +1 -1
  37. data/lib/ultracart_api.rb +9 -0
  38. metadata +20 -2
@@ -0,0 +1,286 @@
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 SfvbSearchFacetsResponse
18
+ # After a change, the facets it changed.
19
+ attr_accessor :changed_facets
20
+
21
+ # The Cost facet price breaks, smallest first.
22
+ attr_accessor :cost_price_points
23
+
24
+ # True when nothing was saved.
25
+ attr_accessor :dry_run
26
+
27
+ # Every facet the storefront can offer, in the fixed order shoppers see them.
28
+ attr_accessor :facets
29
+
30
+ # Hash of the facets and price points. Send it as If-Match on a change.
31
+ attr_accessor :hash_sha256
32
+
33
+ # After a change, true when the price points changed.
34
+ attr_accessor :price_points_changed
35
+
36
+ # After a change, the search index rebuild it started. none, quick (minutes, small catalogs), slow (the regular rebuild cycle) or failed (the change is saved but the rebuild could not be started; save again or contact support).
37
+ attr_accessor :rebuild
38
+
39
+ # Attribute mapping from ruby-style variable name to JSON key.
40
+ def self.attribute_map
41
+ {
42
+ :'changed_facets' => :'changed_facets',
43
+ :'cost_price_points' => :'cost_price_points',
44
+ :'dry_run' => :'dry_run',
45
+ :'facets' => :'facets',
46
+ :'hash_sha256' => :'hash_sha256',
47
+ :'price_points_changed' => :'price_points_changed',
48
+ :'rebuild' => :'rebuild'
49
+ }
50
+ end
51
+
52
+ # Returns all the JSON keys this model knows about
53
+ def self.acceptable_attributes
54
+ attribute_map.values
55
+ end
56
+
57
+ # Attribute type mapping.
58
+ def self.openapi_types
59
+ {
60
+ :'changed_facets' => :'Array<String>',
61
+ :'cost_price_points' => :'Array<Integer>',
62
+ :'dry_run' => :'Boolean',
63
+ :'facets' => :'Array<SfvbSearchFacet>',
64
+ :'hash_sha256' => :'String',
65
+ :'price_points_changed' => :'Boolean',
66
+ :'rebuild' => :'String'
67
+ }
68
+ end
69
+
70
+ # List of attributes with nullable: true
71
+ def self.openapi_nullable
72
+ Set.new([
73
+ ])
74
+ end
75
+
76
+ # Initializes the object
77
+ # @param [Hash] attributes Model attributes in the form of hash
78
+ def initialize(attributes = {})
79
+ if (!attributes.is_a?(Hash))
80
+ fail ArgumentError, "The input argument (attributes) must be a hash in `UltracartClient::SfvbSearchFacetsResponse` initialize method"
81
+ end
82
+
83
+ # check to see if the attribute exists and convert string to symbol for hash key
84
+ attributes = attributes.each_with_object({}) { |(k, v), h|
85
+ if (!self.class.attribute_map.key?(k.to_sym))
86
+ fail ArgumentError, "`#{k}` is not a valid attribute in `UltracartClient::SfvbSearchFacetsResponse`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
87
+ end
88
+ h[k.to_sym] = v
89
+ }
90
+
91
+ if attributes.key?(:'changed_facets')
92
+ if (value = attributes[:'changed_facets']).is_a?(Array)
93
+ self.changed_facets = value
94
+ end
95
+ end
96
+
97
+ if attributes.key?(:'cost_price_points')
98
+ if (value = attributes[:'cost_price_points']).is_a?(Array)
99
+ self.cost_price_points = value
100
+ end
101
+ end
102
+
103
+ if attributes.key?(:'dry_run')
104
+ self.dry_run = attributes[:'dry_run']
105
+ end
106
+
107
+ if attributes.key?(:'facets')
108
+ if (value = attributes[:'facets']).is_a?(Array)
109
+ self.facets = value
110
+ end
111
+ end
112
+
113
+ if attributes.key?(:'hash_sha256')
114
+ self.hash_sha256 = attributes[:'hash_sha256']
115
+ end
116
+
117
+ if attributes.key?(:'price_points_changed')
118
+ self.price_points_changed = attributes[:'price_points_changed']
119
+ end
120
+
121
+ if attributes.key?(:'rebuild')
122
+ self.rebuild = attributes[:'rebuild']
123
+ end
124
+ end
125
+
126
+ # Show invalid properties with the reasons. Usually used together with valid?
127
+ # @return Array for valid properties with the reasons
128
+ def list_invalid_properties
129
+ invalid_properties = Array.new
130
+ invalid_properties
131
+ end
132
+
133
+ # Check to see if the all the properties in the model are valid
134
+ # @return true if the model is valid
135
+ def valid?
136
+ true
137
+ end
138
+
139
+ # Checks equality by comparing each attribute.
140
+ # @param [Object] Object to be compared
141
+ def ==(o)
142
+ return true if self.equal?(o)
143
+ self.class == o.class &&
144
+ changed_facets == o.changed_facets &&
145
+ cost_price_points == o.cost_price_points &&
146
+ dry_run == o.dry_run &&
147
+ facets == o.facets &&
148
+ hash_sha256 == o.hash_sha256 &&
149
+ price_points_changed == o.price_points_changed &&
150
+ rebuild == o.rebuild
151
+ end
152
+
153
+ # @see the `==` method
154
+ # @param [Object] Object to be compared
155
+ def eql?(o)
156
+ self == o
157
+ end
158
+
159
+ # Calculates hash code according to all attributes.
160
+ # @return [Integer] Hash code
161
+ def hash
162
+ [changed_facets, cost_price_points, dry_run, facets, hash_sha256, price_points_changed, rebuild].hash
163
+ end
164
+
165
+ # Builds the object from hash
166
+ # @param [Hash] attributes Model attributes in the form of hash
167
+ # @return [Object] Returns the model itself
168
+ def self.build_from_hash(attributes)
169
+ new.build_from_hash(attributes)
170
+ end
171
+
172
+ # Builds the object from hash
173
+ # @param [Hash] attributes Model attributes in the form of hash
174
+ # @return [Object] Returns the model itself
175
+ def build_from_hash(attributes)
176
+ return nil unless attributes.is_a?(Hash)
177
+ attributes = attributes.transform_keys(&:to_sym)
178
+ self.class.openapi_types.each_pair do |key, type|
179
+ if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
180
+ self.send("#{key}=", nil)
181
+ elsif type =~ /\AArray<(.*)>/i
182
+ # check to ensure the input is an array given that the attribute
183
+ # is documented as an array but the input is not
184
+ if attributes[self.class.attribute_map[key]].is_a?(Array)
185
+ self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
186
+ end
187
+ elsif !attributes[self.class.attribute_map[key]].nil?
188
+ self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
189
+ end
190
+ end
191
+
192
+ self
193
+ end
194
+
195
+ # Deserializes the data based on type
196
+ # @param string type Data type
197
+ # @param string value Value to be deserialized
198
+ # @return [Object] Deserialized data
199
+ def _deserialize(type, value)
200
+ case type.to_sym
201
+ when :Time
202
+ Time.parse(value)
203
+ when :Date
204
+ Date.parse(value)
205
+ when :String
206
+ value.to_s
207
+ when :Integer
208
+ value.to_i
209
+ when :Float
210
+ value.to_f
211
+ when :Boolean
212
+ if value.to_s =~ /\A(true|t|yes|y|1)\z/i
213
+ true
214
+ else
215
+ false
216
+ end
217
+ when :Object
218
+ # generic object (usually a Hash), return directly
219
+ value
220
+ when /\AArray<(?<inner_type>.+)>\z/
221
+ inner_type = Regexp.last_match[:inner_type]
222
+ value.map { |v| _deserialize(inner_type, v) }
223
+ when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
224
+ k_type = Regexp.last_match[:k_type]
225
+ v_type = Regexp.last_match[:v_type]
226
+ {}.tap do |hash|
227
+ value.each do |k, v|
228
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
229
+ end
230
+ end
231
+ else # model
232
+ # models (e.g. Pet) or oneOf
233
+ klass = UltracartClient.const_get(type)
234
+ klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
235
+ end
236
+ end
237
+
238
+ # Returns the string representation of the object
239
+ # @return [String] String presentation of the object
240
+ def to_s
241
+ to_hash.to_s
242
+ end
243
+
244
+ # to_body is an alias to to_hash (backward compatibility)
245
+ # @return [Hash] Returns the object in the form of hash
246
+ def to_body
247
+ to_hash
248
+ end
249
+
250
+ # Returns the object in the form of hash
251
+ # @return [Hash] Returns the object in the form of hash
252
+ def to_hash
253
+ hash = {}
254
+ self.class.attribute_map.each_pair do |attr, param|
255
+ value = self.send(attr)
256
+ if value.nil?
257
+ is_nullable = self.class.openapi_nullable.include?(attr)
258
+ next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
259
+ end
260
+
261
+ hash[param] = _to_hash(value)
262
+ end
263
+ hash
264
+ end
265
+
266
+ # Outputs non-array value in the form of hash
267
+ # For object, use to_hash. Otherwise, just return the value
268
+ # @param [Object] value Any valid value
269
+ # @return [Hash] Returns the value in the form of hash
270
+ def _to_hash(value)
271
+ if value.is_a?(Array)
272
+ value.compact.map { |v| _to_hash(v) }
273
+ elsif value.is_a?(Hash)
274
+ {}.tap do |hash|
275
+ value.each { |k, v| hash[k] = _to_hash(v) }
276
+ end
277
+ elsif value.respond_to? :to_hash
278
+ value.to_hash
279
+ else
280
+ value
281
+ end
282
+ end
283
+
284
+ end
285
+
286
+ 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.252'
14
+ VERSION = '4.1.254'
15
15
  end
data/lib/ultracart_api.rb CHANGED
@@ -1104,6 +1104,7 @@ require 'ultracart_api/models/sfvb_experiment_start_variation'
1104
1104
  require 'ultracart_api/models/sfvb_experiment_variation_update_request'
1105
1105
  require 'ultracart_api/models/sfvb_experiments_response'
1106
1106
  require 'ultracart_api/models/sfvb_file_content_response'
1107
+ require 'ultracart_api/models/sfvb_file_content_result'
1107
1108
  require 'ultracart_api/models/sfvb_file_entry'
1108
1109
  require 'ultracart_api/models/sfvb_file_revert_request'
1109
1110
  require 'ultracart_api/models/sfvb_file_search_request'
@@ -1114,6 +1115,8 @@ require 'ultracart_api/models/sfvb_file_version'
1114
1115
  require 'ultracart_api/models/sfvb_file_versions_response'
1115
1116
  require 'ultracart_api/models/sfvb_file_write_request'
1116
1117
  require 'ultracart_api/models/sfvb_file_write_response'
1118
+ require 'ultracart_api/models/sfvb_files_content_request'
1119
+ require 'ultracart_api/models/sfvb_files_content_response'
1117
1120
  require 'ultracart_api/models/sfvb_files_response'
1118
1121
  require 'ultracart_api/models/sfvb_flow'
1119
1122
  require 'ultracart_api/models/sfvb_flow_backfill_request'
@@ -1231,6 +1234,8 @@ require 'ultracart_api/models/sfvb_page_items_add_request'
1231
1234
  require 'ultracart_api/models/sfvb_page_items_remove_request'
1232
1235
  require 'ultracart_api/models/sfvb_page_items_response'
1233
1236
  require 'ultracart_api/models/sfvb_page_list_response'
1237
+ require 'ultracart_api/models/sfvb_page_move_request'
1238
+ require 'ultracart_api/models/sfvb_page_move_response'
1234
1239
  require 'ultracart_api/models/sfvb_page_multimedia'
1235
1240
  require 'ultracart_api/models/sfvb_page_multimedia_request'
1236
1241
  require 'ultracart_api/models/sfvb_page_refresh_request'
@@ -1279,6 +1284,10 @@ require 'ultracart_api/models/sfvb_redirects_response'
1279
1284
  require 'ultracart_api/models/sfvb_render_request'
1280
1285
  require 'ultracart_api/models/sfvb_render_response'
1281
1286
  require 'ultracart_api/models/sfvb_robots_txt'
1287
+ require 'ultracart_api/models/sfvb_search_facet'
1288
+ require 'ultracart_api/models/sfvb_search_facet_update'
1289
+ require 'ultracart_api/models/sfvb_search_facets_request'
1290
+ require 'ultracart_api/models/sfvb_search_facets_response'
1282
1291
  require 'ultracart_api/models/sfvb_secret_handle'
1283
1292
  require 'ultracart_api/models/sfvb_secret_kind'
1284
1293
  require 'ultracart_api/models/sfvb_secret_kinds_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.252
4
+ version: 4.1.254
5
5
  platform: ruby
6
6
  authors:
7
7
  - UltraCart
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2026-11-12 00:00:00.000000000 Z
11
+ date: 2026-11-15 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: typhoeus
@@ -1166,6 +1166,7 @@ files:
1166
1166
  - docs/SfvbExperimentVariationUpdateRequest.md
1167
1167
  - docs/SfvbExperimentsResponse.md
1168
1168
  - docs/SfvbFileContentResponse.md
1169
+ - docs/SfvbFileContentResult.md
1169
1170
  - docs/SfvbFileEntry.md
1170
1171
  - docs/SfvbFileRevertRequest.md
1171
1172
  - docs/SfvbFileSearchRequest.md
@@ -1176,6 +1177,8 @@ files:
1176
1177
  - docs/SfvbFileVersionsResponse.md
1177
1178
  - docs/SfvbFileWriteRequest.md
1178
1179
  - docs/SfvbFileWriteResponse.md
1180
+ - docs/SfvbFilesContentRequest.md
1181
+ - docs/SfvbFilesContentResponse.md
1179
1182
  - docs/SfvbFilesResponse.md
1180
1183
  - docs/SfvbFlow.md
1181
1184
  - docs/SfvbFlowBackfillRequest.md
@@ -1293,6 +1296,8 @@ files:
1293
1296
  - docs/SfvbPageItemsRemoveRequest.md
1294
1297
  - docs/SfvbPageItemsResponse.md
1295
1298
  - docs/SfvbPageListResponse.md
1299
+ - docs/SfvbPageMoveRequest.md
1300
+ - docs/SfvbPageMoveResponse.md
1296
1301
  - docs/SfvbPageMultimedia.md
1297
1302
  - docs/SfvbPageMultimediaRequest.md
1298
1303
  - docs/SfvbPageRefreshRequest.md
@@ -1341,6 +1346,10 @@ files:
1341
1346
  - docs/SfvbRenderRequest.md
1342
1347
  - docs/SfvbRenderResponse.md
1343
1348
  - docs/SfvbRobotsTxt.md
1349
+ - docs/SfvbSearchFacet.md
1350
+ - docs/SfvbSearchFacetUpdate.md
1351
+ - docs/SfvbSearchFacetsRequest.md
1352
+ - docs/SfvbSearchFacetsResponse.md
1344
1353
  - docs/SfvbSecretHandle.md
1345
1354
  - docs/SfvbSecretKind.md
1346
1355
  - docs/SfvbSecretKindsResponse.md
@@ -2670,6 +2679,7 @@ files:
2670
2679
  - lib/ultracart_api/models/sfvb_experiment_variation_update_request.rb
2671
2680
  - lib/ultracart_api/models/sfvb_experiments_response.rb
2672
2681
  - lib/ultracart_api/models/sfvb_file_content_response.rb
2682
+ - lib/ultracart_api/models/sfvb_file_content_result.rb
2673
2683
  - lib/ultracart_api/models/sfvb_file_entry.rb
2674
2684
  - lib/ultracart_api/models/sfvb_file_revert_request.rb
2675
2685
  - lib/ultracart_api/models/sfvb_file_search_request.rb
@@ -2680,6 +2690,8 @@ files:
2680
2690
  - lib/ultracart_api/models/sfvb_file_versions_response.rb
2681
2691
  - lib/ultracart_api/models/sfvb_file_write_request.rb
2682
2692
  - lib/ultracart_api/models/sfvb_file_write_response.rb
2693
+ - lib/ultracart_api/models/sfvb_files_content_request.rb
2694
+ - lib/ultracart_api/models/sfvb_files_content_response.rb
2683
2695
  - lib/ultracart_api/models/sfvb_files_response.rb
2684
2696
  - lib/ultracart_api/models/sfvb_flow.rb
2685
2697
  - lib/ultracart_api/models/sfvb_flow_backfill_request.rb
@@ -2797,6 +2809,8 @@ files:
2797
2809
  - lib/ultracart_api/models/sfvb_page_items_remove_request.rb
2798
2810
  - lib/ultracart_api/models/sfvb_page_items_response.rb
2799
2811
  - lib/ultracart_api/models/sfvb_page_list_response.rb
2812
+ - lib/ultracart_api/models/sfvb_page_move_request.rb
2813
+ - lib/ultracart_api/models/sfvb_page_move_response.rb
2800
2814
  - lib/ultracart_api/models/sfvb_page_multimedia.rb
2801
2815
  - lib/ultracart_api/models/sfvb_page_multimedia_request.rb
2802
2816
  - lib/ultracart_api/models/sfvb_page_refresh_request.rb
@@ -2845,6 +2859,10 @@ files:
2845
2859
  - lib/ultracart_api/models/sfvb_render_request.rb
2846
2860
  - lib/ultracart_api/models/sfvb_render_response.rb
2847
2861
  - lib/ultracart_api/models/sfvb_robots_txt.rb
2862
+ - lib/ultracart_api/models/sfvb_search_facet.rb
2863
+ - lib/ultracart_api/models/sfvb_search_facet_update.rb
2864
+ - lib/ultracart_api/models/sfvb_search_facets_request.rb
2865
+ - lib/ultracart_api/models/sfvb_search_facets_response.rb
2848
2866
  - lib/ultracart_api/models/sfvb_secret_handle.rb
2849
2867
  - lib/ultracart_api/models/sfvb_secret_kind.rb
2850
2868
  - lib/ultracart_api/models/sfvb_secret_kinds_response.rb