ultracart_api 4.1.245 → 4.1.247
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 +4 -2
- data/docs/SfvbApi.md +4 -4
- data/docs/SfvbApprovalCreateRequest.md +1 -1
- data/docs/SfvbApprovalParams.md +3 -3
- data/docs/SfvbContainerVersion.md +6 -2
- data/docs/SfvbThemeDuplicateRequest.md +1 -1
- data/lib/ultracart_api/api/sfvb_api.rb +8 -8
- data/lib/ultracart_api/models/sfvb_approval_create_request.rb +3 -3
- data/lib/ultracart_api/models/sfvb_approval_params.rb +3 -3
- data/lib/ultracart_api/models/sfvb_container_version.rb +23 -3
- data/lib/ultracart_api/models/sfvb_theme_duplicate_request.rb +1 -1
- data/lib/ultracart_api/version.rb +1 -1
- metadata +2 -2
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: e300f6bf0b8638272290eec0d6fb3a7b70cd1d7f25787761a111b88f2a0b2f1c
|
|
4
|
+
data.tar.gz: 37182faebb890d633d130501268fd5549cc547fb89f0049a95968e8932dae3ad
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 50319a1021d6172afefb46e3d2208a96eda8b6d9743440ca303a18ffbac01611f49b0dcaed2d182c6360c6213be2a960e282a189ad5b3580fbef620765097b12
|
|
7
|
+
data.tar.gz: 7339caa35de83db7f0ec308c2be2d5ffb23230721c0bd2ca2a14ce2eef7880c55988e6fe780ba4eb276b607f812f08dc0ddcc570f6657b9b84f753557719c0f6
|
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.
|
|
10
|
+
- Package version: 4.1.247
|
|
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.
|
|
19
|
+
gem 'ultracart_api', '4.1.247'
|
|
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.247 | 11/12/2026 | sfvb internal testing |
|
|
2589
|
+
| 4.1.246 | 11/11/2026 | sfvb internal testing |
|
|
2588
2590
|
| 4.1.245 | 11/11/2026 | sfvb internal testing |
|
|
2589
2591
|
| 4.1.244 | 11/11/2026 | sfvb internal testing |
|
|
2590
2592
|
| 4.1.243 | 11/11/2026 | sfvb internal testing |
|
data/docs/SfvbApi.md
CHANGED
|
@@ -3159,7 +3159,7 @@ end
|
|
|
3159
3159
|
|
|
3160
3160
|
Duplicate a theme
|
|
3161
3161
|
|
|
3162
|
-
Copies a theme into a new one and returns a job handle to poll. Asynchronous, because copying a theme copies every file in it. Needs sfvb_write rather than sfvb_publish, because the job explicitly does not activate what it creates, so the worst outcome of a mistaken call is a spare theme. This is how you get somewhere safe to work - duplicate, edit the copy with an ordinary write scope, and let a human promote it. Set upgrade_to_version to also upgrade the copy to a newer theme version, as the admin's Duplicate and Upgrade does - only the copy is upgraded. Run getSfvbThemeUpgradeCheck first to see the available versions and the merge conflicts the upgrade will leave, then resolve those in the copy before anyone activates it. Refused with sfvb.theme_limit_reached at the storefront's theme limit, sfvb.theme_upgrade_unavailable for a version that can't be used, and sfvb.theme_merge_conflicts while the source theme has unresolved conflicts.
|
|
3162
|
+
Copies a theme into a new one and returns a job handle to poll. Asynchronous, because copying a theme copies every file in it. Needs sfvb_write rather than sfvb_publish, because the job explicitly does not activate what it creates, so the worst outcome of a mistaken call is a spare theme. This is how you get somewhere safe to work - duplicate, edit the copy with an ordinary write scope, and let a human promote it. The copy is named by its settings.json themeName, like every theme, so theme_name is ignored - edit themeName in the copy's settings.json to rename it. Set upgrade_to_version to also upgrade the copy to a newer theme version, as the admin's Duplicate and Upgrade does - only the copy is upgraded. Run getSfvbThemeUpgradeCheck first to see the available versions and the merge conflicts the upgrade will leave, then resolve those in the copy before anyone activates it. Refused with sfvb.theme_limit_reached at the storefront's theme limit, sfvb.theme_upgrade_unavailable for a version that can't be used, and sfvb.theme_merge_conflicts while the source theme has unresolved conflicts.
|
|
3163
3163
|
|
|
3164
3164
|
|
|
3165
3165
|
### Examples
|
|
@@ -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 send the
|
|
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.
|
|
9605
9605
|
|
|
9606
9606
|
|
|
9607
9607
|
### Examples
|
|
@@ -12161,7 +12161,7 @@ end
|
|
|
12161
12161
|
| **if_match** | **String** | Content hash from the last read. Required; 428 when absent, 412 when stale. | |
|
|
12162
12162
|
| **file_write_request** | [**SfvbFileWriteRequest**](SfvbFileWriteRequest.md) | File content to write | |
|
|
12163
12163
|
| **path** | **String** | | [optional] |
|
|
12164
|
-
| **approval_id** | **String** | For a .js or .mjs file, the approval_id of an approved file.put_script request for exactly these bytes. Required for scripts. See POST /sfvb/approvals. | [optional] |
|
|
12164
|
+
| **approval_id** | **String** | For a .js or .mjs file, the approval_id of an approved file.put_script request for exactly these bytes, and for a .vm or .html file inside a theme, of an approved file.put_template request. Required for scripts and templates. See POST /sfvb/approvals. | [optional] |
|
|
12165
12165
|
|
|
12166
12166
|
### Return type
|
|
12167
12167
|
|
|
@@ -14215,7 +14215,7 @@ end
|
|
|
14215
14215
|
| **storefront_oid** | **Integer** | | |
|
|
14216
14216
|
| **if_match** | **String** | Content hash of the file being reverted. Required; 428 when absent, 412 when stale. | |
|
|
14217
14217
|
| **file_revert_request** | [**SfvbFileRevertRequest**](SfvbFileRevertRequest.md) | Version to revert the file to | |
|
|
14218
|
-
| **approval_id** | **String** | For a .js or .mjs file, the approval_id of an approved file.put_script request naming this version. Required for scripts. See POST /sfvb/approvals. | [optional] |
|
|
14218
|
+
| **approval_id** | **String** | For a .js or .mjs file, the approval_id of an approved file.put_script request naming this version, and for a .vm or .html file inside a theme, of an approved file.put_template request. Required for scripts and templates. See POST /sfvb/approvals. | [optional] |
|
|
14219
14219
|
|
|
14220
14220
|
### Return type
|
|
14221
14221
|
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
| **affiliate_network** | [**SfvbAffiliateNetworkRequest**](SfvbAffiliateNetworkRequest.md) | | [optional] |
|
|
9
9
|
| **comms_list_import** | [**SfvbCommsProviderImportRequest**](SfvbCommsProviderImportRequest.md) | | [optional] |
|
|
10
10
|
| **comms_settings** | [**SfvbCommsSettingsUpdateRequest**](SfvbCommsSettingsUpdateRequest.md) | | [optional] |
|
|
11
|
-
| **content** | **String** | For a file.put_script write, the exact script to be written, at most 256 KB. 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] |
|
|
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
12
|
| **experiment_start** | [**SfvbExperimentStartRequest**](SfvbExperimentStartRequest.md) | | [optional] |
|
|
13
13
|
| **flow_backfill** | [**SfvbFlowBackfillRequest**](SfvbFlowBackfillRequest.md) | | [optional] |
|
|
14
14
|
| **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] |
|
data/docs/SfvbApprovalParams.md
CHANGED
|
@@ -9,13 +9,13 @@
|
|
|
9
9
|
| **attribute_names** | **Array<String>** | For item.attribute_batch, the attributes the batch would change. Set by the server. | [optional] |
|
|
10
10
|
| **blog_post_oid** | **Integer** | The blog post, for blog_post.delete. | [optional] |
|
|
11
11
|
| **branch_step_uuid** | **String** | For sequence_step.move, the condition, split or inboxgeek step it moves to the start of a side of. | [optional] |
|
|
12
|
-
| **content_sha256** | **String** | For file.put_script and tracking_html.put, the SHA-256 of the exact bytes approved, and for affiliate_network.change the SHA-256 of the conversion pixel. Set by the server, never by the caller. The write must send bytes with this hash. | [optional] |
|
|
12
|
+
| **content_sha256** | **String** | For file.put_script, file.put_template and tracking_html.put, the SHA-256 of the exact bytes approved, and for affiliate_network.change the SHA-256 of the conversion pixel. Set by the server, never by the caller. The write must send bytes with this hash. | [optional] |
|
|
13
13
|
| **domain** | **String** | For sending_domain.delete, the sending domain. | [optional] |
|
|
14
14
|
| **esp_twilio_uuid** | **String** | For twilio_account.delete, the Twilio account's esp_twilio_uuid, as GET comms/twilio_account returns it. | [optional] |
|
|
15
15
|
| **experiment_oid** | **Integer** | For experiment.end, the experiment to end. | [optional] |
|
|
16
16
|
| **item_count** | **Integer** | For item.attribute_batch, how many items the batch would change when it was requested. Set by the server. | [optional] |
|
|
17
17
|
| **merchant_item_oid** | **Integer** | For item.pricing, the item whose pricing changes. | [optional] |
|
|
18
|
-
| **path** | **String** | The file path, for file.delete and file.
|
|
18
|
+
| **path** | **String** | The file path, for file.delete, file.put_script and file.put_template, or the page path for experiment.start of a page experiment. Exactly as the gated call will send it. | [optional] |
|
|
19
19
|
| **request_sha256** | **String** | For experiment.start of a url experiment, the hash of the checked experiment approved, for item.pricing, tracking_provider.change and affiliate_network.change the hash of the change, and for smart_attribution.change the hash of the configuration the change would store. Set by the server. The gated call must send the same. | [optional] |
|
|
20
20
|
| **rows_sha256** | **String** | For redirect.delete_batch and item.attribute_batch, the plan_hash of the exact rows approved. Set by the server. The batch must send rows with this hash. | [optional] |
|
|
21
21
|
| **rule_count** | **Integer** | For redirect.delete_batch, how many rules the batch would delete when it was requested. Set by the server. | [optional] |
|
|
@@ -27,7 +27,7 @@
|
|
|
27
27
|
| **tracking_provider** | **String** | The tracking provider key, for tracking_provider.change and tracking_provider.clear. | [optional] |
|
|
28
28
|
| **upsell_kind** | **String** | For upsell.enable, what to switch on. | [optional] |
|
|
29
29
|
| **upsell_oid** | **Integer** | For upsell.enable, the oid of the offer or path to switch on. | [optional] |
|
|
30
|
-
| **version** | **Integer** | For file.put_script, the history version a revert restores. Leave it out, and send content instead, for a write. | [optional] |
|
|
30
|
+
| **version** | **Integer** | For file.put_script and file.put_template, the history version a revert restores. Leave it out, and send content instead, for a write. | [optional] |
|
|
31
31
|
| **widget_id** | **String** | For experiment.start of a page experiment, the id of the experiment element. | [optional] |
|
|
32
32
|
| **winner_variation_number** | **Integer** | For experiment.end, the winning variation. Leave it out to end without a winner, and leave it out of the end call too. | [optional] |
|
|
33
33
|
|
|
@@ -8,9 +8,11 @@
|
|
|
8
8
|
| **comment** | **String** | Comment recorded with the write that replaced this version. | [optional] |
|
|
9
9
|
| **container_history_oid** | **Integer** | History record oid. Pass to the revert operation on the owning container. Absent on the entry marked current, which holds the value stored right now, has no history row of its own, and so cannot be fetched or reverted to. | [optional] |
|
|
10
10
|
| **container_name** | **String** | Container name, where the owner has more than one container. | [optional] |
|
|
11
|
-
| **
|
|
11
|
+
| **content_created_dts** | **String** | When this version's content was written, ISO 8601 UTC. Same source and limits as content_edited_by. | [optional] |
|
|
12
|
+
| **content_edited_by** | **String** | Login of whoever wrote this version's content, taken from the write recorded on the next older entry. Absent on a create entry and on the oldest entry kept, such as a template body that was in place before any history. Saves made outside this API, in the admin visual builder, are not recorded, so after one this names the previous API write. | [optional] |
|
|
13
|
+
| **created_dts** | **String** | When the write that replaced this version happened, ISO 8601 UTC. On the current entry, when it was written. | [optional] |
|
|
12
14
|
| **current** | **Boolean** | True for the value currently stored. | [optional] |
|
|
13
|
-
| **edited_by** | **String** | Login of whoever
|
|
15
|
+
| **edited_by** | **String** | Login of whoever made the write that replaced this version. On the current entry, whoever wrote it. See content_edited_by for who wrote a history entry's content. | [optional] |
|
|
14
16
|
| **hash_sha256** | **String** | SHA-256 of this version's CJSON. | [optional] |
|
|
15
17
|
| **operation** | **String** | What the container was before the write this entry precedes. create means it did not exist, so reverting to this entry removes it again; update means it held the cjson recorded here. | [optional] |
|
|
16
18
|
| **owner_object_id** | **String** | Owner object identifier. | [optional] |
|
|
@@ -27,6 +29,8 @@ instance = UltracartClient::SfvbContainerVersion.new(
|
|
|
27
29
|
comment: null,
|
|
28
30
|
container_history_oid: null,
|
|
29
31
|
container_name: null,
|
|
32
|
+
content_created_dts: null,
|
|
33
|
+
content_edited_by: null,
|
|
30
34
|
created_dts: null,
|
|
31
35
|
current: null,
|
|
32
36
|
edited_by: null,
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
7
|
| **folder** | **String** | Directory name for the new theme under /themes/. Letters and numbers, one path segment. Used verbatim - anything that is not already a valid directory name is refused rather than adjusted, because this call does not return the new theme's oid and you find your copy by matching the target_path you asked for. Must not already exist - a collision is refused rather than resolved, because silently creating a differently named theme leaves you unsure what you made. | [optional] |
|
|
8
8
|
| **target_storefront_oid** | **Integer** | Storefront to create the copy on. Defaults to the storefront in the path. Supply it only when copying a theme between storefronts you own. | [optional] |
|
|
9
|
-
| **theme_name** | **String** |
|
|
9
|
+
| **theme_name** | **String** | Ignored. A theme is named by its settings.json themeName, which the copy keeps from the source, so the copy has the source's name. Edit themeName in the copy's settings.json to rename it. Kept so existing callers still work. | [optional] |
|
|
10
10
|
| **upgrade_to_version** | **String** | Upgrade the copy to this theme version after copying it, as the admin's Duplicate and Upgrade does. Only the copy is upgraded - the source theme is never touched. Must be one of the available_versions from getSfvbThemeUpgradeCheck, which also predicts the merge conflicts. Omit for a plain copy. | [optional] |
|
|
11
11
|
|
|
12
12
|
## Example
|
|
@@ -3939,7 +3939,7 @@ module UltracartClient
|
|
|
3939
3939
|
end
|
|
3940
3940
|
|
|
3941
3941
|
# Duplicate a theme
|
|
3942
|
-
# Copies a theme into a new one and returns a job handle to poll. Asynchronous, because copying a theme copies every file in it. Needs sfvb_write rather than sfvb_publish, because the job explicitly does not activate what it creates, so the worst outcome of a mistaken call is a spare theme. This is how you get somewhere safe to work - duplicate, edit the copy with an ordinary write scope, and let a human promote it. Set upgrade_to_version to also upgrade the copy to a newer theme version, as the admin's Duplicate and Upgrade does - only the copy is upgraded. Run getSfvbThemeUpgradeCheck first to see the available versions and the merge conflicts the upgrade will leave, then resolve those in the copy before anyone activates it. Refused with sfvb.theme_limit_reached at the storefront's theme limit, sfvb.theme_upgrade_unavailable for a version that can't be used, and sfvb.theme_merge_conflicts while the source theme has unresolved conflicts.
|
|
3942
|
+
# Copies a theme into a new one and returns a job handle to poll. Asynchronous, because copying a theme copies every file in it. Needs sfvb_write rather than sfvb_publish, because the job explicitly does not activate what it creates, so the worst outcome of a mistaken call is a spare theme. This is how you get somewhere safe to work - duplicate, edit the copy with an ordinary write scope, and let a human promote it. The copy is named by its settings.json themeName, like every theme, so theme_name is ignored - edit themeName in the copy's settings.json to rename it. Set upgrade_to_version to also upgrade the copy to a newer theme version, as the admin's Duplicate and Upgrade does - only the copy is upgraded. Run getSfvbThemeUpgradeCheck first to see the available versions and the merge conflicts the upgrade will leave, then resolve those in the copy before anyone activates it. Refused with sfvb.theme_limit_reached at the storefront's theme limit, sfvb.theme_upgrade_unavailable for a version that can't be used, and sfvb.theme_merge_conflicts while the source theme has unresolved conflicts.
|
|
3943
3943
|
# @param storefront_oid [Integer]
|
|
3944
3944
|
# @param theme_oid [Integer]
|
|
3945
3945
|
# @param duplicate_request [SfvbThemeDuplicateRequest] Theme duplication details
|
|
@@ -3951,7 +3951,7 @@ module UltracartClient
|
|
|
3951
3951
|
end
|
|
3952
3952
|
|
|
3953
3953
|
# Duplicate a theme
|
|
3954
|
-
# Copies a theme into a new one and returns a job handle to poll. Asynchronous, because copying a theme copies every file in it. Needs sfvb_write rather than sfvb_publish, because the job explicitly does not activate what it creates, so the worst outcome of a mistaken call is a spare theme. This is how you get somewhere safe to work - duplicate, edit the copy with an ordinary write scope, and let a human promote it. Set upgrade_to_version to also upgrade the copy to a newer theme version, as the admin's Duplicate and Upgrade does - only the copy is upgraded. Run getSfvbThemeUpgradeCheck first to see the available versions and the merge conflicts the upgrade will leave, then resolve those in the copy before anyone activates it. Refused with sfvb.theme_limit_reached at the storefront's theme limit, sfvb.theme_upgrade_unavailable for a version that can't be used, and sfvb.theme_merge_conflicts while the source theme has unresolved conflicts.
|
|
3954
|
+
# Copies a theme into a new one and returns a job handle to poll. Asynchronous, because copying a theme copies every file in it. Needs sfvb_write rather than sfvb_publish, because the job explicitly does not activate what it creates, so the worst outcome of a mistaken call is a spare theme. This is how you get somewhere safe to work - duplicate, edit the copy with an ordinary write scope, and let a human promote it. The copy is named by its settings.json themeName, like every theme, so theme_name is ignored - edit themeName in the copy's settings.json to rename it. Set upgrade_to_version to also upgrade the copy to a newer theme version, as the admin's Duplicate and Upgrade does - only the copy is upgraded. Run getSfvbThemeUpgradeCheck first to see the available versions and the merge conflicts the upgrade will leave, then resolve those in the copy before anyone activates it. Refused with sfvb.theme_limit_reached at the storefront's theme limit, sfvb.theme_upgrade_unavailable for a version that can't be used, and sfvb.theme_merge_conflicts while the source theme has unresolved conflicts.
|
|
3955
3955
|
# @param storefront_oid [Integer]
|
|
3956
3956
|
# @param theme_oid [Integer]
|
|
3957
3957
|
# @param duplicate_request [SfvbThemeDuplicateRequest] Theme duplication details
|
|
@@ -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 send the
|
|
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.
|
|
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 send the
|
|
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.
|
|
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.
|
|
@@ -15663,7 +15663,7 @@ module UltracartClient
|
|
|
15663
15663
|
# @param file_write_request [SfvbFileWriteRequest] File content to write
|
|
15664
15664
|
# @param [Hash] opts the optional parameters
|
|
15665
15665
|
# @option opts [String] :path
|
|
15666
|
-
# @option opts [String] :approval_id For a .js or .mjs file, the approval_id of an approved file.put_script request for exactly these bytes. Required for scripts. See POST /sfvb/approvals.
|
|
15666
|
+
# @option opts [String] :approval_id For a .js or .mjs file, the approval_id of an approved file.put_script request for exactly these bytes, and for a .vm or .html file inside a theme, of an approved file.put_template request. Required for scripts and templates. See POST /sfvb/approvals.
|
|
15667
15667
|
# @return [SfvbFileWriteResponse]
|
|
15668
15668
|
def put_sfvb_file_content(storefront_oid, if_match, file_write_request, opts = {})
|
|
15669
15669
|
data, _status_code, _headers = put_sfvb_file_content_with_http_info(storefront_oid, if_match, file_write_request, opts)
|
|
@@ -15677,7 +15677,7 @@ module UltracartClient
|
|
|
15677
15677
|
# @param file_write_request [SfvbFileWriteRequest] File content to write
|
|
15678
15678
|
# @param [Hash] opts the optional parameters
|
|
15679
15679
|
# @option opts [String] :path
|
|
15680
|
-
# @option opts [String] :approval_id For a .js or .mjs file, the approval_id of an approved file.put_script request for exactly these bytes. Required for scripts. See POST /sfvb/approvals.
|
|
15680
|
+
# @option opts [String] :approval_id For a .js or .mjs file, the approval_id of an approved file.put_script request for exactly these bytes, and for a .vm or .html file inside a theme, of an approved file.put_template request. Required for scripts and templates. See POST /sfvb/approvals.
|
|
15681
15681
|
# @return [Array<(SfvbFileWriteResponse, Integer, Hash)>] SfvbFileWriteResponse data, response status code and response headers
|
|
15682
15682
|
def put_sfvb_file_content_with_http_info(storefront_oid, if_match, file_write_request, opts = {})
|
|
15683
15683
|
if @api_client.config.debugging
|
|
@@ -18664,7 +18664,7 @@ module UltracartClient
|
|
|
18664
18664
|
# @param if_match [String] Content hash of the file being reverted. Required; 428 when absent, 412 when stale.
|
|
18665
18665
|
# @param file_revert_request [SfvbFileRevertRequest] Version to revert the file to
|
|
18666
18666
|
# @param [Hash] opts the optional parameters
|
|
18667
|
-
# @option opts [String] :approval_id For a .js or .mjs file, the approval_id of an approved file.put_script request naming this version. Required for scripts. See POST /sfvb/approvals.
|
|
18667
|
+
# @option opts [String] :approval_id For a .js or .mjs file, the approval_id of an approved file.put_script request naming this version, and for a .vm or .html file inside a theme, of an approved file.put_template request. Required for scripts and templates. See POST /sfvb/approvals.
|
|
18668
18668
|
# @return [SfvbFileWriteResponse]
|
|
18669
18669
|
def revert_sfvb_file(storefront_oid, if_match, file_revert_request, opts = {})
|
|
18670
18670
|
data, _status_code, _headers = revert_sfvb_file_with_http_info(storefront_oid, if_match, file_revert_request, opts)
|
|
@@ -18677,7 +18677,7 @@ module UltracartClient
|
|
|
18677
18677
|
# @param if_match [String] Content hash of the file being reverted. Required; 428 when absent, 412 when stale.
|
|
18678
18678
|
# @param file_revert_request [SfvbFileRevertRequest] Version to revert the file to
|
|
18679
18679
|
# @param [Hash] opts the optional parameters
|
|
18680
|
-
# @option opts [String] :approval_id For a .js or .mjs file, the approval_id of an approved file.put_script request naming this version. Required for scripts. See POST /sfvb/approvals.
|
|
18680
|
+
# @option opts [String] :approval_id For a .js or .mjs file, the approval_id of an approved file.put_script request naming this version, and for a .vm or .html file inside a theme, of an approved file.put_template request. Required for scripts and templates. See POST /sfvb/approvals.
|
|
18681
18681
|
# @return [Array<(SfvbFileWriteResponse, Integer, Hash)>] SfvbFileWriteResponse data, response status code and response headers
|
|
18682
18682
|
def revert_sfvb_file_with_http_info(storefront_oid, if_match, file_revert_request, opts = {})
|
|
18683
18683
|
if @api_client.config.debugging
|
|
@@ -24,7 +24,7 @@ module UltracartClient
|
|
|
24
24
|
|
|
25
25
|
attr_accessor :comms_settings
|
|
26
26
|
|
|
27
|
-
# For a file.put_script write, the exact script to be written, at most 256 KB. 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.
|
|
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
30
|
attr_accessor :experiment_start
|
|
@@ -274,7 +274,7 @@ module UltracartClient
|
|
|
274
274
|
# Check to see if the all the properties in the model are valid
|
|
275
275
|
# @return true if the model is valid
|
|
276
276
|
def valid?
|
|
277
|
-
action_validator = EnumAttributeValidator.new('String', ["file.delete", "blog_post.delete", "file.put_script", "redirect.delete_batch", "experiment.start", "experiment.end", "upsell.enable", "item.attribute_batch", "item.pricing", "item.preorder", "item.variations", "item.default_page", "twilio_account.delete", "sending_domain.delete", "sequence_step.delete", "sequence_step.move", "sequence_step.enable_postcard", "segment.update", "smart_attribution.change", "smart_attribution.delete", "tracking_provider.change", "tracking_provider.clear", "tracking_html.put", "affiliate_network.change", "affiliate_network.delete", "site_seo.change", "transactional_email.update", "comms_settings.update", "comms_list.import", "postcard.test_mail", "flow.backfill"])
|
|
277
|
+
action_validator = EnumAttributeValidator.new('String', ["file.delete", "blog_post.delete", "file.put_script", "file.put_template", "redirect.delete_batch", "experiment.start", "experiment.end", "upsell.enable", "item.attribute_batch", "item.pricing", "item.preorder", "item.variations", "item.default_page", "twilio_account.delete", "sending_domain.delete", "sequence_step.delete", "sequence_step.move", "sequence_step.enable_postcard", "segment.update", "smart_attribution.change", "smart_attribution.delete", "tracking_provider.change", "tracking_provider.clear", "tracking_html.put", "affiliate_network.change", "affiliate_network.delete", "site_seo.change", "transactional_email.update", "comms_settings.update", "comms_list.import", "postcard.test_mail", "flow.backfill"])
|
|
278
278
|
return false unless action_validator.valid?(@action)
|
|
279
279
|
true
|
|
280
280
|
end
|
|
@@ -282,7 +282,7 @@ module UltracartClient
|
|
|
282
282
|
# Custom attribute writer method checking allowed values (enum).
|
|
283
283
|
# @param [Object] action Object to be assigned
|
|
284
284
|
def action=(action)
|
|
285
|
-
validator = EnumAttributeValidator.new('String', ["file.delete", "blog_post.delete", "file.put_script", "redirect.delete_batch", "experiment.start", "experiment.end", "upsell.enable", "item.attribute_batch", "item.pricing", "item.preorder", "item.variations", "item.default_page", "twilio_account.delete", "sending_domain.delete", "sequence_step.delete", "sequence_step.move", "sequence_step.enable_postcard", "segment.update", "smart_attribution.change", "smart_attribution.delete", "tracking_provider.change", "tracking_provider.clear", "tracking_html.put", "affiliate_network.change", "affiliate_network.delete", "site_seo.change", "transactional_email.update", "comms_settings.update", "comms_list.import", "postcard.test_mail", "flow.backfill"])
|
|
285
|
+
validator = EnumAttributeValidator.new('String', ["file.delete", "blog_post.delete", "file.put_script", "file.put_template", "redirect.delete_batch", "experiment.start", "experiment.end", "upsell.enable", "item.attribute_batch", "item.pricing", "item.preorder", "item.variations", "item.default_page", "twilio_account.delete", "sending_domain.delete", "sequence_step.delete", "sequence_step.move", "sequence_step.enable_postcard", "segment.update", "smart_attribution.change", "smart_attribution.delete", "tracking_provider.change", "tracking_provider.clear", "tracking_html.put", "affiliate_network.change", "affiliate_network.delete", "site_seo.change", "transactional_email.update", "comms_settings.update", "comms_list.import", "postcard.test_mail", "flow.backfill"])
|
|
286
286
|
unless validator.valid?(action)
|
|
287
287
|
fail ArgumentError, "invalid value for \"action\", must be one of #{validator.allowable_values}."
|
|
288
288
|
end
|
|
@@ -30,7 +30,7 @@ module UltracartClient
|
|
|
30
30
|
# For sequence_step.move, the condition, split or inboxgeek step it moves to the start of a side of.
|
|
31
31
|
attr_accessor :branch_step_uuid
|
|
32
32
|
|
|
33
|
-
# For file.put_script and tracking_html.put, the SHA-256 of the exact bytes approved, and for affiliate_network.change the SHA-256 of the conversion pixel. Set by the server, never by the caller. The write must send bytes with this hash.
|
|
33
|
+
# For file.put_script, file.put_template and tracking_html.put, the SHA-256 of the exact bytes approved, and for affiliate_network.change the SHA-256 of the conversion pixel. Set by the server, never by the caller. The write must send bytes with this hash.
|
|
34
34
|
attr_accessor :content_sha256
|
|
35
35
|
|
|
36
36
|
# For sending_domain.delete, the sending domain.
|
|
@@ -48,7 +48,7 @@ module UltracartClient
|
|
|
48
48
|
# For item.pricing, the item whose pricing changes.
|
|
49
49
|
attr_accessor :merchant_item_oid
|
|
50
50
|
|
|
51
|
-
# The file path, for file.delete and file.
|
|
51
|
+
# The file path, for file.delete, file.put_script and file.put_template, or the page path for experiment.start of a page experiment. Exactly as the gated call will send it.
|
|
52
52
|
attr_accessor :path
|
|
53
53
|
|
|
54
54
|
# For experiment.start of a url experiment, the hash of the checked experiment approved, for item.pricing, tracking_provider.change and affiliate_network.change the hash of the change, and for smart_attribution.change the hash of the configuration the change would store. Set by the server. The gated call must send the same.
|
|
@@ -84,7 +84,7 @@ module UltracartClient
|
|
|
84
84
|
# For upsell.enable, the oid of the offer or path to switch on.
|
|
85
85
|
attr_accessor :upsell_oid
|
|
86
86
|
|
|
87
|
-
# For file.put_script, the history version a revert restores. Leave it out, and send content instead, for a write.
|
|
87
|
+
# For file.put_script and file.put_template, the history version a revert restores. Leave it out, and send content instead, for a write.
|
|
88
88
|
attr_accessor :version
|
|
89
89
|
|
|
90
90
|
# For experiment.start of a page experiment, the id of the experiment element.
|
|
@@ -27,13 +27,19 @@ module UltracartClient
|
|
|
27
27
|
# Container name, where the owner has more than one container.
|
|
28
28
|
attr_accessor :container_name
|
|
29
29
|
|
|
30
|
-
# When this
|
|
30
|
+
# When this version's content was written, ISO 8601 UTC. Same source and limits as content_edited_by.
|
|
31
|
+
attr_accessor :content_created_dts
|
|
32
|
+
|
|
33
|
+
# Login of whoever wrote this version's content, taken from the write recorded on the next older entry. Absent on a create entry and on the oldest entry kept, such as a template body that was in place before any history. Saves made outside this API, in the admin visual builder, are not recorded, so after one this names the previous API write.
|
|
34
|
+
attr_accessor :content_edited_by
|
|
35
|
+
|
|
36
|
+
# When the write that replaced this version happened, ISO 8601 UTC. On the current entry, when it was written.
|
|
31
37
|
attr_accessor :created_dts
|
|
32
38
|
|
|
33
39
|
# True for the value currently stored.
|
|
34
40
|
attr_accessor :current
|
|
35
41
|
|
|
36
|
-
# Login of whoever
|
|
42
|
+
# Login of whoever made the write that replaced this version. On the current entry, whoever wrote it. See content_edited_by for who wrote a history entry's content.
|
|
37
43
|
attr_accessor :edited_by
|
|
38
44
|
|
|
39
45
|
# SHA-256 of this version's CJSON.
|
|
@@ -80,6 +86,8 @@ module UltracartClient
|
|
|
80
86
|
:'comment' => :'comment',
|
|
81
87
|
:'container_history_oid' => :'container_history_oid',
|
|
82
88
|
:'container_name' => :'container_name',
|
|
89
|
+
:'content_created_dts' => :'content_created_dts',
|
|
90
|
+
:'content_edited_by' => :'content_edited_by',
|
|
83
91
|
:'created_dts' => :'created_dts',
|
|
84
92
|
:'current' => :'current',
|
|
85
93
|
:'edited_by' => :'edited_by',
|
|
@@ -103,6 +111,8 @@ module UltracartClient
|
|
|
103
111
|
:'comment' => :'String',
|
|
104
112
|
:'container_history_oid' => :'Integer',
|
|
105
113
|
:'container_name' => :'String',
|
|
114
|
+
:'content_created_dts' => :'String',
|
|
115
|
+
:'content_edited_by' => :'String',
|
|
106
116
|
:'created_dts' => :'String',
|
|
107
117
|
:'current' => :'Boolean',
|
|
108
118
|
:'edited_by' => :'String',
|
|
@@ -151,6 +161,14 @@ module UltracartClient
|
|
|
151
161
|
self.container_name = attributes[:'container_name']
|
|
152
162
|
end
|
|
153
163
|
|
|
164
|
+
if attributes.key?(:'content_created_dts')
|
|
165
|
+
self.content_created_dts = attributes[:'content_created_dts']
|
|
166
|
+
end
|
|
167
|
+
|
|
168
|
+
if attributes.key?(:'content_edited_by')
|
|
169
|
+
self.content_edited_by = attributes[:'content_edited_by']
|
|
170
|
+
end
|
|
171
|
+
|
|
154
172
|
if attributes.key?(:'created_dts')
|
|
155
173
|
self.created_dts = attributes[:'created_dts']
|
|
156
174
|
end
|
|
@@ -230,6 +248,8 @@ module UltracartClient
|
|
|
230
248
|
comment == o.comment &&
|
|
231
249
|
container_history_oid == o.container_history_oid &&
|
|
232
250
|
container_name == o.container_name &&
|
|
251
|
+
content_created_dts == o.content_created_dts &&
|
|
252
|
+
content_edited_by == o.content_edited_by &&
|
|
233
253
|
created_dts == o.created_dts &&
|
|
234
254
|
current == o.current &&
|
|
235
255
|
edited_by == o.edited_by &&
|
|
@@ -249,7 +269,7 @@ module UltracartClient
|
|
|
249
269
|
# Calculates hash code according to all attributes.
|
|
250
270
|
# @return [Integer] Hash code
|
|
251
271
|
def hash
|
|
252
|
-
[cjson, comment, container_history_oid, container_name, created_dts, current, edited_by, hash_sha256, operation, owner_object_id, owner_type, size].hash
|
|
272
|
+
[cjson, comment, container_history_oid, container_name, content_created_dts, content_edited_by, created_dts, current, edited_by, hash_sha256, operation, owner_object_id, owner_type, size].hash
|
|
253
273
|
end
|
|
254
274
|
|
|
255
275
|
# Builds the object from hash
|
|
@@ -21,7 +21,7 @@ module UltracartClient
|
|
|
21
21
|
# Storefront to create the copy on. Defaults to the storefront in the path. Supply it only when copying a theme between storefronts you own.
|
|
22
22
|
attr_accessor :target_storefront_oid
|
|
23
23
|
|
|
24
|
-
#
|
|
24
|
+
# Ignored. A theme is named by its settings.json themeName, which the copy keeps from the source, so the copy has the source's name. Edit themeName in the copy's settings.json to rename it. Kept so existing callers still work.
|
|
25
25
|
attr_accessor :theme_name
|
|
26
26
|
|
|
27
27
|
# Upgrade the copy to this theme version after copying it, as the admin's Duplicate and Upgrade does. Only the copy is upgraded - the source theme is never touched. Must be one of the available_versions from getSfvbThemeUpgradeCheck, which also predicts the merge conflicts. Omit for a plain copy.
|
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.
|
|
4
|
+
version: 4.1.247
|
|
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-
|
|
11
|
+
date: 2026-11-12 00:00:00.000000000 Z
|
|
12
12
|
dependencies:
|
|
13
13
|
- !ruby/object:Gem::Dependency
|
|
14
14
|
name: typhoeus
|