ultracart_api 4.1.228 → 4.1.230

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 (51) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +35 -2
  3. data/docs/ItemAutoOrder.md +6 -0
  4. data/docs/SfvbApi.md +946 -4
  5. data/docs/SfvbApprovalCreateRequest.md +2 -0
  6. data/docs/SfvbCommsFolder.md +28 -0
  7. data/docs/SfvbCommsFolderItem.md +22 -0
  8. data/docs/SfvbCommsFolderResponse.md +22 -0
  9. data/docs/SfvbCommsFolderWriteRequest.md +18 -0
  10. data/docs/SfvbCommsFoldersResponse.md +18 -0
  11. data/docs/SfvbCommsListDetail.md +34 -0
  12. data/docs/SfvbCommsListResponse.md +20 -0
  13. data/docs/SfvbCommsListWriteRequest.md +24 -0
  14. data/docs/SfvbFlowWriteRequest.md +2 -2
  15. data/docs/SfvbNotFoundEntry.md +2 -0
  16. data/docs/SfvbNotFoundSummary.md +28 -0
  17. data/docs/SfvbRedirectImportRow.md +2 -0
  18. data/docs/SfvbRedirectRequest.md +2 -0
  19. data/docs/SfvbRedirectResolveBatchRequest.md +18 -0
  20. data/docs/SfvbRedirectResolveBatchResponse.md +24 -0
  21. data/docs/SfvbSequenceStep.md +1 -1
  22. data/docs/SfvbSiteSeo.md +40 -0
  23. data/docs/SfvbSiteSeoChange.md +26 -0
  24. data/docs/SfvbSiteSeoRequest.md +24 -0
  25. data/docs/SfvbStepCounts.md +1 -1
  26. data/lib/ultracart_api/api/sfvb_api.rb +1306 -47
  27. data/lib/ultracart_api/models/item_auto_order.rb +35 -1
  28. data/lib/ultracart_api/models/sfvb_approval_create_request.rb +12 -3
  29. data/lib/ultracart_api/models/sfvb_comms_folder.rb +270 -0
  30. data/lib/ultracart_api/models/sfvb_comms_folder_item.rb +240 -0
  31. data/lib/ultracart_api/models/sfvb_comms_folder_response.rb +243 -0
  32. data/lib/ultracart_api/models/sfvb_comms_folder_write_request.rb +220 -0
  33. data/lib/ultracart_api/models/sfvb_comms_folders_response.rb +222 -0
  34. data/lib/ultracart_api/models/sfvb_comms_list_detail.rb +302 -0
  35. data/lib/ultracart_api/models/sfvb_comms_list_response.rb +231 -0
  36. data/lib/ultracart_api/models/sfvb_comms_list_write_request.rb +250 -0
  37. data/lib/ultracart_api/models/sfvb_flow_write_request.rb +2 -2
  38. data/lib/ultracart_api/models/sfvb_not_found_entry.rb +11 -1
  39. data/lib/ultracart_api/models/sfvb_not_found_summary.rb +280 -0
  40. data/lib/ultracart_api/models/sfvb_redirect_import_row.rb +11 -1
  41. data/lib/ultracart_api/models/sfvb_redirect_request.rb +11 -1
  42. data/lib/ultracart_api/models/sfvb_redirect_resolve_batch_request.rb +222 -0
  43. data/lib/ultracart_api/models/sfvb_redirect_resolve_batch_response.rb +252 -0
  44. data/lib/ultracart_api/models/sfvb_sequence_step.rb +1 -1
  45. data/lib/ultracart_api/models/sfvb_site_seo.rb +334 -0
  46. data/lib/ultracart_api/models/sfvb_site_seo_change.rb +260 -0
  47. data/lib/ultracart_api/models/sfvb_site_seo_request.rb +250 -0
  48. data/lib/ultracart_api/models/sfvb_step_counts.rb +1 -1
  49. data/lib/ultracart_api/version.rb +1 -1
  50. data/lib/ultracart_api.rb +14 -0
  51. metadata +30 -2
@@ -0,0 +1,250 @@
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 SfvbSiteSeoRequest
18
+ # True to turn Canonical Links on. Turning them off needs an approved site_seo.change request.
19
+ attr_accessor :canonical
20
+
21
+ # True to check the change and report it without saving.
22
+ attr_accessor :dry_run
23
+
24
+ # True to tell search engines not to index any page. Either direction needs an approved site_seo.change request, and turning it on needs a fresh authenticator code.
25
+ attr_accessor :prevent_indexing
26
+
27
+ # True to turn Schema.org structured data on. Turning it off needs an approved site_seo.change request.
28
+ attr_accessor :schema_org
29
+
30
+ # Attribute mapping from ruby-style variable name to JSON key.
31
+ def self.attribute_map
32
+ {
33
+ :'canonical' => :'canonical',
34
+ :'dry_run' => :'dry_run',
35
+ :'prevent_indexing' => :'prevent_indexing',
36
+ :'schema_org' => :'schema_org'
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
+ :'canonical' => :'Boolean',
49
+ :'dry_run' => :'Boolean',
50
+ :'prevent_indexing' => :'Boolean',
51
+ :'schema_org' => :'Boolean'
52
+ }
53
+ end
54
+
55
+ # List of attributes with nullable: true
56
+ def self.openapi_nullable
57
+ Set.new([
58
+ ])
59
+ end
60
+
61
+ # Initializes the object
62
+ # @param [Hash] attributes Model attributes in the form of hash
63
+ def initialize(attributes = {})
64
+ if (!attributes.is_a?(Hash))
65
+ fail ArgumentError, "The input argument (attributes) must be a hash in `UltracartClient::SfvbSiteSeoRequest` initialize method"
66
+ end
67
+
68
+ # check to see if the attribute exists and convert string to symbol for hash key
69
+ attributes = attributes.each_with_object({}) { |(k, v), h|
70
+ if (!self.class.attribute_map.key?(k.to_sym))
71
+ fail ArgumentError, "`#{k}` is not a valid attribute in `UltracartClient::SfvbSiteSeoRequest`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
72
+ end
73
+ h[k.to_sym] = v
74
+ }
75
+
76
+ if attributes.key?(:'canonical')
77
+ self.canonical = attributes[:'canonical']
78
+ end
79
+
80
+ if attributes.key?(:'dry_run')
81
+ self.dry_run = attributes[:'dry_run']
82
+ end
83
+
84
+ if attributes.key?(:'prevent_indexing')
85
+ self.prevent_indexing = attributes[:'prevent_indexing']
86
+ end
87
+
88
+ if attributes.key?(:'schema_org')
89
+ self.schema_org = attributes[:'schema_org']
90
+ end
91
+ end
92
+
93
+ # Show invalid properties with the reasons. Usually used together with valid?
94
+ # @return Array for valid properties with the reasons
95
+ def list_invalid_properties
96
+ invalid_properties = Array.new
97
+ invalid_properties
98
+ end
99
+
100
+ # Check to see if the all the properties in the model are valid
101
+ # @return true if the model is valid
102
+ def valid?
103
+ true
104
+ end
105
+
106
+ # Checks equality by comparing each attribute.
107
+ # @param [Object] Object to be compared
108
+ def ==(o)
109
+ return true if self.equal?(o)
110
+ self.class == o.class &&
111
+ canonical == o.canonical &&
112
+ dry_run == o.dry_run &&
113
+ prevent_indexing == o.prevent_indexing &&
114
+ schema_org == o.schema_org
115
+ end
116
+
117
+ # @see the `==` method
118
+ # @param [Object] Object to be compared
119
+ def eql?(o)
120
+ self == o
121
+ end
122
+
123
+ # Calculates hash code according to all attributes.
124
+ # @return [Integer] Hash code
125
+ def hash
126
+ [canonical, dry_run, prevent_indexing, schema_org].hash
127
+ end
128
+
129
+ # Builds the object from hash
130
+ # @param [Hash] attributes Model attributes in the form of hash
131
+ # @return [Object] Returns the model itself
132
+ def self.build_from_hash(attributes)
133
+ new.build_from_hash(attributes)
134
+ end
135
+
136
+ # Builds the object from hash
137
+ # @param [Hash] attributes Model attributes in the form of hash
138
+ # @return [Object] Returns the model itself
139
+ def build_from_hash(attributes)
140
+ return nil unless attributes.is_a?(Hash)
141
+ attributes = attributes.transform_keys(&:to_sym)
142
+ self.class.openapi_types.each_pair do |key, type|
143
+ if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
144
+ self.send("#{key}=", nil)
145
+ elsif type =~ /\AArray<(.*)>/i
146
+ # check to ensure the input is an array given that the attribute
147
+ # is documented as an array but the input is not
148
+ if attributes[self.class.attribute_map[key]].is_a?(Array)
149
+ self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
150
+ end
151
+ elsif !attributes[self.class.attribute_map[key]].nil?
152
+ self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
153
+ end
154
+ end
155
+
156
+ self
157
+ end
158
+
159
+ # Deserializes the data based on type
160
+ # @param string type Data type
161
+ # @param string value Value to be deserialized
162
+ # @return [Object] Deserialized data
163
+ def _deserialize(type, value)
164
+ case type.to_sym
165
+ when :Time
166
+ Time.parse(value)
167
+ when :Date
168
+ Date.parse(value)
169
+ when :String
170
+ value.to_s
171
+ when :Integer
172
+ value.to_i
173
+ when :Float
174
+ value.to_f
175
+ when :Boolean
176
+ if value.to_s =~ /\A(true|t|yes|y|1)\z/i
177
+ true
178
+ else
179
+ false
180
+ end
181
+ when :Object
182
+ # generic object (usually a Hash), return directly
183
+ value
184
+ when /\AArray<(?<inner_type>.+)>\z/
185
+ inner_type = Regexp.last_match[:inner_type]
186
+ value.map { |v| _deserialize(inner_type, v) }
187
+ when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
188
+ k_type = Regexp.last_match[:k_type]
189
+ v_type = Regexp.last_match[:v_type]
190
+ {}.tap do |hash|
191
+ value.each do |k, v|
192
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
193
+ end
194
+ end
195
+ else # model
196
+ # models (e.g. Pet) or oneOf
197
+ klass = UltracartClient.const_get(type)
198
+ klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
199
+ end
200
+ end
201
+
202
+ # Returns the string representation of the object
203
+ # @return [String] String presentation of the object
204
+ def to_s
205
+ to_hash.to_s
206
+ end
207
+
208
+ # to_body is an alias to to_hash (backward compatibility)
209
+ # @return [Hash] Returns the object in the form of hash
210
+ def to_body
211
+ to_hash
212
+ end
213
+
214
+ # Returns the object in the form of hash
215
+ # @return [Hash] Returns the object in the form of hash
216
+ def to_hash
217
+ hash = {}
218
+ self.class.attribute_map.each_pair do |attr, param|
219
+ value = self.send(attr)
220
+ if value.nil?
221
+ is_nullable = self.class.openapi_nullable.include?(attr)
222
+ next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
223
+ end
224
+
225
+ hash[param] = _to_hash(value)
226
+ end
227
+ hash
228
+ end
229
+
230
+ # Outputs non-array value in the form of hash
231
+ # For object, use to_hash. Otherwise, just return the value
232
+ # @param [Object] value Any valid value
233
+ # @return [Hash] Returns the value in the form of hash
234
+ def _to_hash(value)
235
+ if value.is_a?(Array)
236
+ value.compact.map { |v| _to_hash(v) }
237
+ elsif value.is_a?(Hash)
238
+ {}.tap do |hash|
239
+ value.each { |k, v| hash[k] = _to_hash(v) }
240
+ end
241
+ elsif value.respond_to? :to_hash
242
+ value.to_hash
243
+ else
244
+ value
245
+ end
246
+ end
247
+
248
+ end
249
+
250
+ end
@@ -33,7 +33,7 @@ module UltracartClient
33
33
  # Customers who reached the step and were not sent anything. The dispatch log says why.
34
34
  attr_accessor :skipped
35
35
 
36
- # email (the step's email, all time) or step (this step, the last 90 days).
36
+ # email (the step's email, all time), sequence (the begin step, customers who started the sequence, all time) or step (this step, the last 90 days).
37
37
  attr_accessor :source
38
38
 
39
39
  # Spam complaints.
@@ -11,5 +11,5 @@ OpenAPI Generator version: 6.0.1-SNAPSHOT
11
11
  =end
12
12
 
13
13
  module UltracartClient
14
- VERSION = '4.1.228'
14
+ VERSION = '4.1.230'
15
15
  end
data/lib/ultracart_api.rb CHANGED
@@ -1008,7 +1008,15 @@ require 'ultracart_api/models/sfvb_code_library_email'
1008
1008
  require 'ultracart_api/models/sfvb_code_library_emails_response'
1009
1009
  require 'ultracart_api/models/sfvb_comms_dns_record'
1010
1010
  require 'ultracart_api/models/sfvb_comms_email'
1011
+ require 'ultracart_api/models/sfvb_comms_folder'
1012
+ require 'ultracart_api/models/sfvb_comms_folder_item'
1013
+ require 'ultracart_api/models/sfvb_comms_folder_response'
1014
+ require 'ultracart_api/models/sfvb_comms_folder_write_request'
1015
+ require 'ultracart_api/models/sfvb_comms_folders_response'
1011
1016
  require 'ultracart_api/models/sfvb_comms_list'
1017
+ require 'ultracart_api/models/sfvb_comms_list_detail'
1018
+ require 'ultracart_api/models/sfvb_comms_list_response'
1019
+ require 'ultracart_api/models/sfvb_comms_list_write_request'
1012
1020
  require 'ultracart_api/models/sfvb_comms_lists_response'
1013
1021
  require 'ultracart_api/models/sfvb_comms_postcard'
1014
1022
  require 'ultracart_api/models/sfvb_comms_segment'
@@ -1135,6 +1143,7 @@ require 'ultracart_api/models/sfvb_not_found_entry_response'
1135
1143
  require 'ultracart_api/models/sfvb_not_found_hit'
1136
1144
  require 'ultracart_api/models/sfvb_not_found_page'
1137
1145
  require 'ultracart_api/models/sfvb_not_found_response'
1146
+ require 'ultracart_api/models/sfvb_not_found_summary'
1138
1147
  require 'ultracart_api/models/sfvb_page_attribute'
1139
1148
  require 'ultracart_api/models/sfvb_page_attribute_update'
1140
1149
  require 'ultracart_api/models/sfvb_page_attribute_update_request'
@@ -1184,6 +1193,8 @@ require 'ultracart_api/models/sfvb_redirect_import_response'
1184
1193
  require 'ultracart_api/models/sfvb_redirect_import_row'
1185
1194
  require 'ultracart_api/models/sfvb_redirect_import_row_result'
1186
1195
  require 'ultracart_api/models/sfvb_redirect_request'
1196
+ require 'ultracart_api/models/sfvb_redirect_resolve_batch_request'
1197
+ require 'ultracart_api/models/sfvb_redirect_resolve_batch_response'
1187
1198
  require 'ultracart_api/models/sfvb_redirect_resolve_response'
1188
1199
  require 'ultracart_api/models/sfvb_redirect_resolve_step'
1189
1200
  require 'ultracart_api/models/sfvb_redirect_response'
@@ -1216,6 +1227,9 @@ require 'ultracart_api/models/sfvb_site_attribute'
1216
1227
  require 'ultracart_api/models/sfvb_site_attribute_update'
1217
1228
  require 'ultracart_api/models/sfvb_site_attribute_update_request'
1218
1229
  require 'ultracart_api/models/sfvb_site_attributes_response'
1230
+ require 'ultracart_api/models/sfvb_site_seo'
1231
+ require 'ultracart_api/models/sfvb_site_seo_change'
1232
+ require 'ultracart_api/models/sfvb_site_seo_request'
1219
1233
  require 'ultracart_api/models/sfvb_sitemap'
1220
1234
  require 'ultracart_api/models/sfvb_sitemap_file'
1221
1235
  require 'ultracart_api/models/sfvb_sitemaps_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.228
4
+ version: 4.1.230
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-04 00:00:00.000000000 Z
11
+ date: 2026-11-05 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: typhoeus
@@ -1070,7 +1070,15 @@ files:
1070
1070
  - docs/SfvbCodeLibraryEmailsResponse.md
1071
1071
  - docs/SfvbCommsDnsRecord.md
1072
1072
  - docs/SfvbCommsEmail.md
1073
+ - docs/SfvbCommsFolder.md
1074
+ - docs/SfvbCommsFolderItem.md
1075
+ - docs/SfvbCommsFolderResponse.md
1076
+ - docs/SfvbCommsFolderWriteRequest.md
1077
+ - docs/SfvbCommsFoldersResponse.md
1073
1078
  - docs/SfvbCommsList.md
1079
+ - docs/SfvbCommsListDetail.md
1080
+ - docs/SfvbCommsListResponse.md
1081
+ - docs/SfvbCommsListWriteRequest.md
1074
1082
  - docs/SfvbCommsListsResponse.md
1075
1083
  - docs/SfvbCommsPostcard.md
1076
1084
  - docs/SfvbCommsSegment.md
@@ -1197,6 +1205,7 @@ files:
1197
1205
  - docs/SfvbNotFoundHit.md
1198
1206
  - docs/SfvbNotFoundPage.md
1199
1207
  - docs/SfvbNotFoundResponse.md
1208
+ - docs/SfvbNotFoundSummary.md
1200
1209
  - docs/SfvbPageAttribute.md
1201
1210
  - docs/SfvbPageAttributeUpdate.md
1202
1211
  - docs/SfvbPageAttributeUpdateRequest.md
@@ -1246,6 +1255,8 @@ files:
1246
1255
  - docs/SfvbRedirectImportRow.md
1247
1256
  - docs/SfvbRedirectImportRowResult.md
1248
1257
  - docs/SfvbRedirectRequest.md
1258
+ - docs/SfvbRedirectResolveBatchRequest.md
1259
+ - docs/SfvbRedirectResolveBatchResponse.md
1249
1260
  - docs/SfvbRedirectResolveResponse.md
1250
1261
  - docs/SfvbRedirectResolveStep.md
1251
1262
  - docs/SfvbRedirectResponse.md
@@ -1278,6 +1289,9 @@ files:
1278
1289
  - docs/SfvbSiteAttributeUpdate.md
1279
1290
  - docs/SfvbSiteAttributeUpdateRequest.md
1280
1291
  - docs/SfvbSiteAttributesResponse.md
1292
+ - docs/SfvbSiteSeo.md
1293
+ - docs/SfvbSiteSeoChange.md
1294
+ - docs/SfvbSiteSeoRequest.md
1281
1295
  - docs/SfvbSitemap.md
1282
1296
  - docs/SfvbSitemapFile.md
1283
1297
  - docs/SfvbSitemapsResponse.md
@@ -2466,7 +2480,15 @@ files:
2466
2480
  - lib/ultracart_api/models/sfvb_code_library_emails_response.rb
2467
2481
  - lib/ultracart_api/models/sfvb_comms_dns_record.rb
2468
2482
  - lib/ultracart_api/models/sfvb_comms_email.rb
2483
+ - lib/ultracart_api/models/sfvb_comms_folder.rb
2484
+ - lib/ultracart_api/models/sfvb_comms_folder_item.rb
2485
+ - lib/ultracart_api/models/sfvb_comms_folder_response.rb
2486
+ - lib/ultracart_api/models/sfvb_comms_folder_write_request.rb
2487
+ - lib/ultracart_api/models/sfvb_comms_folders_response.rb
2469
2488
  - lib/ultracart_api/models/sfvb_comms_list.rb
2489
+ - lib/ultracart_api/models/sfvb_comms_list_detail.rb
2490
+ - lib/ultracart_api/models/sfvb_comms_list_response.rb
2491
+ - lib/ultracart_api/models/sfvb_comms_list_write_request.rb
2470
2492
  - lib/ultracart_api/models/sfvb_comms_lists_response.rb
2471
2493
  - lib/ultracart_api/models/sfvb_comms_postcard.rb
2472
2494
  - lib/ultracart_api/models/sfvb_comms_segment.rb
@@ -2593,6 +2615,7 @@ files:
2593
2615
  - lib/ultracart_api/models/sfvb_not_found_hit.rb
2594
2616
  - lib/ultracart_api/models/sfvb_not_found_page.rb
2595
2617
  - lib/ultracart_api/models/sfvb_not_found_response.rb
2618
+ - lib/ultracart_api/models/sfvb_not_found_summary.rb
2596
2619
  - lib/ultracart_api/models/sfvb_page_attribute.rb
2597
2620
  - lib/ultracart_api/models/sfvb_page_attribute_update.rb
2598
2621
  - lib/ultracart_api/models/sfvb_page_attribute_update_request.rb
@@ -2642,6 +2665,8 @@ files:
2642
2665
  - lib/ultracart_api/models/sfvb_redirect_import_row.rb
2643
2666
  - lib/ultracart_api/models/sfvb_redirect_import_row_result.rb
2644
2667
  - lib/ultracart_api/models/sfvb_redirect_request.rb
2668
+ - lib/ultracart_api/models/sfvb_redirect_resolve_batch_request.rb
2669
+ - lib/ultracart_api/models/sfvb_redirect_resolve_batch_response.rb
2645
2670
  - lib/ultracart_api/models/sfvb_redirect_resolve_response.rb
2646
2671
  - lib/ultracart_api/models/sfvb_redirect_resolve_step.rb
2647
2672
  - lib/ultracart_api/models/sfvb_redirect_response.rb
@@ -2674,6 +2699,9 @@ files:
2674
2699
  - lib/ultracart_api/models/sfvb_site_attribute_update.rb
2675
2700
  - lib/ultracart_api/models/sfvb_site_attribute_update_request.rb
2676
2701
  - lib/ultracart_api/models/sfvb_site_attributes_response.rb
2702
+ - lib/ultracart_api/models/sfvb_site_seo.rb
2703
+ - lib/ultracart_api/models/sfvb_site_seo_change.rb
2704
+ - lib/ultracart_api/models/sfvb_site_seo_request.rb
2677
2705
  - lib/ultracart_api/models/sfvb_sitemap.rb
2678
2706
  - lib/ultracart_api/models/sfvb_sitemap_file.rb
2679
2707
  - lib/ultracart_api/models/sfvb_sitemaps_response.rb