ultracart_api 4.1.248 → 4.1.250

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 CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: ee14f6669622cd015794a180874856bdf9c64710e82800e7d9f6a1f010ebc685
4
- data.tar.gz: 328328e44c07a90cde553f86fb044fc52f1128d148e39cd00d08f3acf5a775d8
3
+ metadata.gz: b018df0eef944764b4f22c4a95b4c2f06b3df6f0d2503423a95f26568febe073
4
+ data.tar.gz: 0a471099b6157ac297aeb92d7435fb2d65c8cbad4196ae923d7ca5f87532b82f
5
5
  SHA512:
6
- metadata.gz: a853c22c7a42dd545a544d63e720e70edd0e29c99834611ca8405462da05e531180b0ffdadbc0cee1e86950eca9f1532eb6792139d822350abce66a4704c6b38
7
- data.tar.gz: e62b9d617960b5b52fc936adce17e7ca8e0267a32b023f03e68ad4b6ce27666428e34d4bd1af8c369a5b4100d6616b8a121806fffba5306e6148ceb7953375ab
6
+ metadata.gz: 221f79438fc8e9236f9ae3ed8a08628bc09d27178b8c2bf43d4488e9472e0125637827ab58964fc8254b31b6e8b58801d3b88ba7c3ce5cb7a4f2e1a00e358494
7
+ data.tar.gz: 8703c8136350eaa6e5cde050a88b8451289d24bb2271d09a37b038cbac3bd024a700481d783588be637d015e7b3d0185e3fbd12cd7a2410dfa43ed58f6abf43b
data/README.md CHANGED
@@ -7,7 +7,7 @@ Note: Every method has a sample for every language. See https://github.com/Ultr
7
7
  This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
8
8
 
9
9
  - API version: 2.0.0
10
- - Package version: 4.1.248
10
+ - Package version: 4.1.250
11
11
  - Build package: org.openapitools.codegen.languages.RubyClientCodegen
12
12
  - For more information, please visit [http://www.ultracart.com/api/](http://www.ultracart.com/api/)
13
13
 
@@ -16,7 +16,7 @@ This SDK is automatically generated by the [OpenAPI Generator](https://openapi-g
16
16
  gemfile:
17
17
 
18
18
  ```shell
19
- gem 'ultracart_api', '4.1.248'
19
+ gem 'ultracart_api', '4.1.250'
20
20
  ```
21
21
 
22
22
  install:
@@ -2585,6 +2585,8 @@ Not every change is committed to every SDK.
2585
2585
 
2586
2586
  | Version | Date | Comments |
2587
2587
  | --: | :-: | --- |
2588
+ | 4.1.250 | 11/12/2026 | sfvb internal testing |
2589
+ | 4.1.249 | 11/12/2026 | sfvb internal testing |
2588
2590
  | 4.1.248 | 11/12/2026 | sfvb internal testing |
2589
2591
  | 4.1.247 | 11/12/2026 | sfvb internal testing |
2590
2592
  | 4.1.246 | 11/11/2026 | sfvb internal testing |
data/docs/SfvbApi.md CHANGED
@@ -9601,7 +9601,7 @@ end
9601
9601
 
9602
9602
  Request a human approval
9603
9603
 
9604
- Asks the person who signed in the CLI to approve one gated action on one exact target. Name the storefront with the storefront_oid query parameter. The target is checked the way the action will check it, so nobody is asked to approve a call that would fail. Show the person approval_url and user_code, poll GET approvals/{approval_id} every interval_seconds, and once it is approved repeat the gated call with the approval_id in the Approval-Id header. Asking again for the same thing returns the pending request (200) rather than a new one (201). A request lapses after 10 minutes. Requires a token that resolves to a user, so use the device authorization flow. For file.put_script and file.put_template send the file as content, or params.version for a revert; for tracking_html.put send the HTML as content and params.slot; for affiliate_network.change send affiliate_network. These four start as reviewing while UltraCart's scanner and two AI models read the content, then become pending with the review attached, or refused. Keep polling, and show approval_url only once it is pending. Only the hash is kept, so the write must send the same content.
9604
+ Asks the person who signed in the CLI to approve one gated action on one exact target, or with delegate_email a colleague on the account who holds a permission covering the action. Name the storefront with the storefront_oid query parameter. The target is checked the way the action will check it, so nobody is asked to approve a call that would fail. Show the person approval_url and user_code, poll GET approvals/{approval_id} every interval_seconds, and once it is approved repeat the gated call with the approval_id in the Approval-Id header. Asking again for the same thing returns the pending request (200) rather than a new one (201). A request lapses after 10 minutes. Requires a token that resolves to a user, so use the device authorization flow. For file.put_script and file.put_template send the file as content, or params.version for a revert; for tracking_html.put send the HTML as content and params.slot; for affiliate_network.change send affiliate_network. These four start as reviewing while UltraCart's scanner and two AI models read the content, then become pending with the review attached, or refused. Keep polling, and show approval_url only once it is pending. Only the hash is kept, so the write must send the same content.
9605
9605
 
9606
9606
 
9607
9607
  ### Examples
data/docs/SfvbApproval.md CHANGED
@@ -8,6 +8,9 @@
8
8
  | **approval_id** | **String** | Send this as the Approval-Id header on the gated call once status is approved. | [optional] |
9
9
  | **approval_url** | **String** | The page where the person approves or denies. Show it to them. Never open or fill it in yourself. | [optional] |
10
10
  | **created_at** | **String** | When the request was made, ISO 8601 UTC. | [optional] |
11
+ | **decided_by** | **String** | Who decided the request, once decided. | [optional] |
12
+ | **delegate_name** | **String** | The name of the colleague the request was handed to, while it is. Tell the person who is now deciding. | [optional] |
13
+ | **delegated** | **Boolean** | True when the request was handed to a colleague to decide. | [optional] |
11
14
  | **description** | **String** | The sentence the person reads before approving. Written by the server, not the agent. | [optional] |
12
15
  | **expires_at** | **String** | When this approval stops being usable, ISO 8601 UTC. For a pending request, when it lapses undecided. For an approved one, when it must have been used by. | [optional] |
13
16
  | **expires_in_seconds** | **Integer** | Seconds until expires_at. Zero once passed. | [optional] |
@@ -35,6 +38,9 @@ instance = UltracartClient::SfvbApproval.new(
35
38
  approval_id: null,
36
39
  approval_url: null,
37
40
  created_at: null,
41
+ decided_by: null,
42
+ delegate_name: null,
43
+ delegated: null,
38
44
  description: null,
39
45
  expires_at: null,
40
46
  expires_in_seconds: null,
@@ -9,6 +9,7 @@
9
9
  | **comms_list_import** | [**SfvbCommsProviderImportRequest**](SfvbCommsProviderImportRequest.md) | | [optional] |
10
10
  | **comms_settings** | [**SfvbCommsSettingsUpdateRequest**](SfvbCommsSettingsUpdateRequest.md) | | [optional] |
11
11
  | **content** | **String** | For a file.put_script write, the exact script to be written, at most 256 KB, and for a file.put_template write the exact template. For tracking_html.put, the exact HTML the write will send, at most 256 KB. UltraCart reviews it and keeps only its hash, so send the same bytes again on the write. Leave it out for a revert, which names params.version. | [optional] |
12
+ | **delegate_email** | **String** | Optional. The email of a colleague on this account who should decide the request instead of the person who signed in. They must hold an admin permission that covers the action; they get an email with a link and decide with their own authenticator code. Any colleague who can't be used is refused with sfvb.delegate_not_allowed, for every reason alike. The approval stays yours to poll and use. | [optional] |
12
13
  | **experiment_start** | [**SfvbExperimentStartRequest**](SfvbExperimentStartRequest.md) | | [optional] |
13
14
  | **flow_backfill** | [**SfvbFlowBackfillRequest**](SfvbFlowBackfillRequest.md) | | [optional] |
14
15
  | **item_attribute_rows** | [**Array<SfvbItemAttributeBatchRow>**](SfvbItemAttributeBatchRow.md) | For item.attribute_batch, exactly the rows the batch will send - the dry run's change rows, each with merchant_item_oid and current_sha256. UltraCart keeps only their hash. | [optional] |
@@ -38,6 +39,7 @@ instance = UltracartClient::SfvbApprovalCreateRequest.new(
38
39
  comms_list_import: null,
39
40
  comms_settings: null,
40
41
  content: null,
42
+ delegate_email: null,
41
43
  experiment_start: null,
42
44
  flow_backfill: null,
43
45
  item_attribute_rows: null,
@@ -12215,7 +12215,7 @@ module UltracartClient
12215
12215
  end
12216
12216
 
12217
12217
  # Request a human approval
12218
- # Asks the person who signed in the CLI to approve one gated action on one exact target. Name the storefront with the storefront_oid query parameter. The target is checked the way the action will check it, so nobody is asked to approve a call that would fail. Show the person approval_url and user_code, poll GET approvals/{approval_id} every interval_seconds, and once it is approved repeat the gated call with the approval_id in the Approval-Id header. Asking again for the same thing returns the pending request (200) rather than a new one (201). A request lapses after 10 minutes. Requires a token that resolves to a user, so use the device authorization flow. For file.put_script and file.put_template send the file as content, or params.version for a revert; for tracking_html.put send the HTML as content and params.slot; for affiliate_network.change send affiliate_network. These four start as reviewing while UltraCart's scanner and two AI models read the content, then become pending with the review attached, or refused. Keep polling, and show approval_url only once it is pending. Only the hash is kept, so the write must send the same content.
12218
+ # Asks the person who signed in the CLI to approve one gated action on one exact target, or with delegate_email a colleague on the account who holds a permission covering the action. Name the storefront with the storefront_oid query parameter. The target is checked the way the action will check it, so nobody is asked to approve a call that would fail. Show the person approval_url and user_code, poll GET approvals/{approval_id} every interval_seconds, and once it is approved repeat the gated call with the approval_id in the Approval-Id header. Asking again for the same thing returns the pending request (200) rather than a new one (201). A request lapses after 10 minutes. Requires a token that resolves to a user, so use the device authorization flow. For file.put_script and file.put_template send the file as content, or params.version for a revert; for tracking_html.put send the HTML as content and params.slot; for affiliate_network.change send affiliate_network. These four start as reviewing while UltraCart's scanner and two AI models read the content, then become pending with the review attached, or refused. Keep polling, and show approval_url only once it is pending. Only the hash is kept, so the write must send the same content.
12219
12219
  # @param approval_request [SfvbApprovalCreateRequest] The request
12220
12220
  # @param [Hash] opts the optional parameters
12221
12221
  # @option opts [Integer] :storefront_oid The storefront the action runs on. Required for storefront actions, left out for account-wide ones.
@@ -12226,7 +12226,7 @@ module UltracartClient
12226
12226
  end
12227
12227
 
12228
12228
  # Request a human approval
12229
- # Asks the person who signed in the CLI to approve one gated action on one exact target. Name the storefront with the storefront_oid query parameter. The target is checked the way the action will check it, so nobody is asked to approve a call that would fail. Show the person approval_url and user_code, poll GET approvals/{approval_id} every interval_seconds, and once it is approved repeat the gated call with the approval_id in the Approval-Id header. Asking again for the same thing returns the pending request (200) rather than a new one (201). A request lapses after 10 minutes. Requires a token that resolves to a user, so use the device authorization flow. For file.put_script and file.put_template send the file as content, or params.version for a revert; for tracking_html.put send the HTML as content and params.slot; for affiliate_network.change send affiliate_network. These four start as reviewing while UltraCart's scanner and two AI models read the content, then become pending with the review attached, or refused. Keep polling, and show approval_url only once it is pending. Only the hash is kept, so the write must send the same content.
12229
+ # Asks the person who signed in the CLI to approve one gated action on one exact target, or with delegate_email a colleague on the account who holds a permission covering the action. Name the storefront with the storefront_oid query parameter. The target is checked the way the action will check it, so nobody is asked to approve a call that would fail. Show the person approval_url and user_code, poll GET approvals/{approval_id} every interval_seconds, and once it is approved repeat the gated call with the approval_id in the Approval-Id header. Asking again for the same thing returns the pending request (200) rather than a new one (201). A request lapses after 10 minutes. Requires a token that resolves to a user, so use the device authorization flow. For file.put_script and file.put_template send the file as content, or params.version for a revert; for tracking_html.put send the HTML as content and params.slot; for affiliate_network.change send affiliate_network. These four start as reviewing while UltraCart's scanner and two AI models read the content, then become pending with the review attached, or refused. Keep polling, and show approval_url only once it is pending. Only the hash is kept, so the write must send the same content.
12230
12230
  # @param approval_request [SfvbApprovalCreateRequest] The request
12231
12231
  # @param [Hash] opts the optional parameters
12232
12232
  # @option opts [Integer] :storefront_oid The storefront the action runs on. Required for storefront actions, left out for account-wide ones.
@@ -27,6 +27,15 @@ module UltracartClient
27
27
  # When the request was made, ISO 8601 UTC.
28
28
  attr_accessor :created_at
29
29
 
30
+ # Who decided the request, once decided.
31
+ attr_accessor :decided_by
32
+
33
+ # The name of the colleague the request was handed to, while it is. Tell the person who is now deciding.
34
+ attr_accessor :delegate_name
35
+
36
+ # True when the request was handed to a colleague to decide.
37
+ attr_accessor :delegated
38
+
30
39
  # The sentence the person reads before approving. Written by the server, not the agent.
31
40
  attr_accessor :description
32
41
 
@@ -102,6 +111,9 @@ module UltracartClient
102
111
  :'approval_id' => :'approval_id',
103
112
  :'approval_url' => :'approval_url',
104
113
  :'created_at' => :'created_at',
114
+ :'decided_by' => :'decided_by',
115
+ :'delegate_name' => :'delegate_name',
116
+ :'delegated' => :'delegated',
105
117
  :'description' => :'description',
106
118
  :'expires_at' => :'expires_at',
107
119
  :'expires_in_seconds' => :'expires_in_seconds',
@@ -133,6 +145,9 @@ module UltracartClient
133
145
  :'approval_id' => :'String',
134
146
  :'approval_url' => :'String',
135
147
  :'created_at' => :'String',
148
+ :'decided_by' => :'String',
149
+ :'delegate_name' => :'String',
150
+ :'delegated' => :'Boolean',
136
151
  :'description' => :'String',
137
152
  :'expires_at' => :'String',
138
153
  :'expires_in_seconds' => :'Integer',
@@ -189,6 +204,18 @@ module UltracartClient
189
204
  self.created_at = attributes[:'created_at']
190
205
  end
191
206
 
207
+ if attributes.key?(:'decided_by')
208
+ self.decided_by = attributes[:'decided_by']
209
+ end
210
+
211
+ if attributes.key?(:'delegate_name')
212
+ self.delegate_name = attributes[:'delegate_name']
213
+ end
214
+
215
+ if attributes.key?(:'delegated')
216
+ self.delegated = attributes[:'delegated']
217
+ end
218
+
192
219
  if attributes.key?(:'description')
193
220
  self.description = attributes[:'description']
194
221
  end
@@ -264,6 +291,8 @@ module UltracartClient
264
291
  # Check to see if the all the properties in the model are valid
265
292
  # @return true if the model is valid
266
293
  def valid?
294
+ decided_by_validator = EnumAttributeValidator.new('String', ["requester", "delegate"])
295
+ return false unless decided_by_validator.valid?(@decided_by)
267
296
  outcome_validator = EnumAttributeValidator.new('String', ["succeeded", "failed"])
268
297
  return false unless outcome_validator.valid?(@outcome)
269
298
  status_validator = EnumAttributeValidator.new('String', ["reviewing", "pending", "approved", "denied", "cancelled", "expired", "used", "refused"])
@@ -271,6 +300,16 @@ module UltracartClient
271
300
  true
272
301
  end
273
302
 
303
+ # Custom attribute writer method checking allowed values (enum).
304
+ # @param [Object] decided_by Object to be assigned
305
+ def decided_by=(decided_by)
306
+ validator = EnumAttributeValidator.new('String', ["requester", "delegate"])
307
+ unless validator.valid?(decided_by)
308
+ fail ArgumentError, "invalid value for \"decided_by\", must be one of #{validator.allowable_values}."
309
+ end
310
+ @decided_by = decided_by
311
+ end
312
+
274
313
  # Custom attribute writer method checking allowed values (enum).
275
314
  # @param [Object] outcome Object to be assigned
276
315
  def outcome=(outcome)
@@ -300,6 +339,9 @@ module UltracartClient
300
339
  approval_id == o.approval_id &&
301
340
  approval_url == o.approval_url &&
302
341
  created_at == o.created_at &&
342
+ decided_by == o.decided_by &&
343
+ delegate_name == o.delegate_name &&
344
+ delegated == o.delegated &&
303
345
  description == o.description &&
304
346
  expires_at == o.expires_at &&
305
347
  expires_in_seconds == o.expires_in_seconds &&
@@ -327,7 +369,7 @@ module UltracartClient
327
369
  # Calculates hash code according to all attributes.
328
370
  # @return [Integer] Hash code
329
371
  def hash
330
- [action, approval_id, approval_url, created_at, description, expires_at, expires_in_seconds, fresh_code_required, interval_seconds, outcome, outcome_code, outcome_http_status, params, reason, review, scope, status, storefront_oid, used_at, user_code].hash
372
+ [action, approval_id, approval_url, created_at, decided_by, delegate_name, delegated, description, expires_at, expires_in_seconds, fresh_code_required, interval_seconds, outcome, outcome_code, outcome_http_status, params, reason, review, scope, status, storefront_oid, used_at, user_code].hash
331
373
  end
332
374
 
333
375
  # Builds the object from hash
@@ -27,6 +27,9 @@ module UltracartClient
27
27
  # For a file.put_script write, the exact script to be written, at most 256 KB, and for a file.put_template write the exact template. For tracking_html.put, the exact HTML the write will send, at most 256 KB. UltraCart reviews it and keeps only its hash, so send the same bytes again on the write. Leave it out for a revert, which names params.version.
28
28
  attr_accessor :content
29
29
 
30
+ # Optional. The email of a colleague on this account who should decide the request instead of the person who signed in. They must hold an admin permission that covers the action; they get an email with a link and decide with their own authenticator code. Any colleague who can't be used is refused with sfvb.delegate_not_allowed, for every reason alike. The approval stays yours to poll and use.
31
+ attr_accessor :delegate_email
32
+
30
33
  attr_accessor :experiment_start
31
34
 
32
35
  attr_accessor :flow_backfill
@@ -95,6 +98,7 @@ module UltracartClient
95
98
  :'comms_list_import' => :'comms_list_import',
96
99
  :'comms_settings' => :'comms_settings',
97
100
  :'content' => :'content',
101
+ :'delegate_email' => :'delegate_email',
98
102
  :'experiment_start' => :'experiment_start',
99
103
  :'flow_backfill' => :'flow_backfill',
100
104
  :'item_attribute_rows' => :'item_attribute_rows',
@@ -128,6 +132,7 @@ module UltracartClient
128
132
  :'comms_list_import' => :'SfvbCommsProviderImportRequest',
129
133
  :'comms_settings' => :'SfvbCommsSettingsUpdateRequest',
130
134
  :'content' => :'String',
135
+ :'delegate_email' => :'String',
131
136
  :'experiment_start' => :'SfvbExperimentStartRequest',
132
137
  :'flow_backfill' => :'SfvbFlowBackfillRequest',
133
138
  :'item_attribute_rows' => :'Array<SfvbItemAttributeBatchRow>',
@@ -189,6 +194,10 @@ module UltracartClient
189
194
  self.content = attributes[:'content']
190
195
  end
191
196
 
197
+ if attributes.key?(:'delegate_email')
198
+ self.delegate_email = attributes[:'delegate_email']
199
+ end
200
+
192
201
  if attributes.key?(:'experiment_start')
193
202
  self.experiment_start = attributes[:'experiment_start']
194
203
  end
@@ -299,6 +308,7 @@ module UltracartClient
299
308
  comms_list_import == o.comms_list_import &&
300
309
  comms_settings == o.comms_settings &&
301
310
  content == o.content &&
311
+ delegate_email == o.delegate_email &&
302
312
  experiment_start == o.experiment_start &&
303
313
  flow_backfill == o.flow_backfill &&
304
314
  item_attribute_rows == o.item_attribute_rows &&
@@ -327,7 +337,7 @@ module UltracartClient
327
337
  # Calculates hash code according to all attributes.
328
338
  # @return [Integer] Hash code
329
339
  def hash
330
- [action, affiliate_network, comms_list_import, comms_settings, content, experiment_start, flow_backfill, item_attribute_rows, item_default_page_rows, item_preorder, item_preorder_children, item_pricing, item_variations, params, postcard_test_mail, reason, redirect_rows, segment_update, site_seo, smart_attribution, tracking_provider, transactional_email].hash
340
+ [action, affiliate_network, comms_list_import, comms_settings, content, delegate_email, experiment_start, flow_backfill, item_attribute_rows, item_default_page_rows, item_preorder, item_preorder_children, item_pricing, item_variations, params, postcard_test_mail, reason, redirect_rows, segment_update, site_seo, smart_attribution, tracking_provider, transactional_email].hash
331
341
  end
332
342
 
333
343
  # Builds the object from hash
@@ -11,5 +11,5 @@ OpenAPI Generator version: 6.0.1-SNAPSHOT
11
11
  =end
12
12
 
13
13
  module UltracartClient
14
- VERSION = '4.1.248'
14
+ VERSION = '4.1.250'
15
15
  end
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: ultracart_api
3
3
  version: !ruby/object:Gem::Version
4
- version: 4.1.248
4
+ version: 4.1.250
5
5
  platform: ruby
6
6
  authors:
7
7
  - UltraCart