ultracart_api 4.1.198 → 4.1.199
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 +11 -2
- data/docs/SfvbApi.md +117 -4
- data/docs/SfvbApproval.md +3 -1
- data/docs/SfvbApprovalCreateRequest.md +5 -1
- data/docs/SfvbApprovalParams.md +10 -2
- data/docs/SfvbApprovalReview.md +36 -0
- data/docs/SfvbApprovalReviewFinding.md +24 -0
- data/docs/SfvbRedirectDeleteRequest.md +20 -0
- data/docs/SfvbRedirectDeleteResponse.md +36 -0
- data/docs/SfvbRedirectDeleteRow.md +20 -0
- data/docs/SfvbRedirectDeleteRowResult.md +32 -0
- data/lib/ultracart_api/api/sfvb_api.rb +161 -2
- data/lib/ultracart_api/models/sfvb_approval.rb +13 -4
- data/lib/ultracart_api/models/sfvb_approval_create_request.rb +28 -6
- data/lib/ultracart_api/models/sfvb_approval_params.rb +45 -5
- data/lib/ultracart_api/models/sfvb_approval_review.rb +354 -0
- data/lib/ultracart_api/models/sfvb_approval_review_finding.rb +250 -0
- data/lib/ultracart_api/models/sfvb_redirect_delete_request.rb +232 -0
- data/lib/ultracart_api/models/sfvb_redirect_delete_response.rb +312 -0
- data/lib/ultracart_api/models/sfvb_redirect_delete_row.rb +230 -0
- data/lib/ultracart_api/models/sfvb_redirect_delete_row_result.rb +324 -0
- data/lib/ultracart_api/version.rb +1 -1
- data/lib/ultracart_api.rb +6 -0
- metadata +13 -1
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: d95de013c9ab7e1151605f84c7995427c70aa11790c4e563719ac58f6bd4b695
|
|
4
|
+
data.tar.gz: e4bc905c2cefc4b9a6080bec11e8f7bc009b1c41703dd60503cfa50bb043796d
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 4397790970afae515da118632a2d5c33996d67d0a1181d72657fd8f8164738df76f92d7b2f8a3566b5b0670e202dc4f49950c58689587e55a9ec2121bda7403e
|
|
7
|
+
data.tar.gz: 608984de6049e97e3deb782a8f0a4a9b34f0288479b29ce02ce0059126bdaaea670b701936fc25823d67cfa3910d3c8f573d94d36720c381cf132d35005b4010
|
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.199
|
|
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.199'
|
|
20
20
|
```
|
|
21
21
|
|
|
22
22
|
install:
|
|
@@ -495,11 +495,13 @@ Class | Method | HTTP request | Description
|
|
|
495
495
|
*UltracartClient::SfvbApi* | [**delete_sfvb_page_multimedia**](docs/SfvbApi.md#delete_sfvb_page_multimedia) | **DELETE** /sfvb/storefronts/{storefront_oid}/pages/multimedia | Detach an image from a page
|
|
496
496
|
*UltracartClient::SfvbApi* | [**delete_sfvb_preview_session**](docs/SfvbApi.md#delete_sfvb_preview_session) | **DELETE** /sfvb/storefronts/{storefront_oid}/preview_sessions/{preview_session_id} | Delete a preview session
|
|
497
497
|
*UltracartClient::SfvbApi* | [**delete_sfvb_redirect**](docs/SfvbApi.md#delete_sfvb_redirect) | **DELETE** /sfvb/storefronts/{storefront_oid}/redirects/{redirect_id} | Delete a redirect rule
|
|
498
|
+
*UltracartClient::SfvbApi* | [**delete_sfvb_redirects**](docs/SfvbApi.md#delete_sfvb_redirects) | **POST** /sfvb/storefronts/{storefront_oid}/redirects/delete | Delete up to 5,000 redirect rules in one call
|
|
498
499
|
*UltracartClient::SfvbApi* | [**detach_sfvb_blog_post_image**](docs/SfvbApi.md#detach_sfvb_blog_post_image) | **POST** /sfvb/storefronts/{storefront_oid}/blog_posts/{blog_post_oid}/images/detach | Detach an image from a blog post
|
|
499
500
|
*UltracartClient::SfvbApi* | [**disable_sfvb_i18n_language**](docs/SfvbApi.md#disable_sfvb_i18n_language) | **POST** /sfvb/storefronts/{storefront_oid}/i18n/languages/{code}/disable | Disable a language
|
|
500
501
|
*UltracartClient::SfvbApi* | [**disable_sfvb_upsell_offer**](docs/SfvbApi.md#disable_sfvb_upsell_offer) | **POST** /sfvb/storefronts/{storefront_oid}/upsell_offers/{upsell_offer_oid}/disable | Disable an upsell offer
|
|
501
502
|
*UltracartClient::SfvbApi* | [**disable_sfvb_upsell_path**](docs/SfvbApi.md#disable_sfvb_upsell_path) | **POST** /sfvb/storefronts/{storefront_oid}/upsell_paths/{upsell_path_oid}/disable | Disable an upsell path
|
|
502
503
|
*UltracartClient::SfvbApi* | [**download_sfvb_file**](docs/SfvbApi.md#download_sfvb_file) | **GET** /sfvb/storefronts/{storefront_oid}/files/download | Read a storefront file's raw bytes
|
|
504
|
+
*UltracartClient::SfvbApi* | [**dry_run_sfvb_redirect_delete**](docs/SfvbApi.md#dry_run_sfvb_redirect_delete) | **POST** /sfvb/storefronts/{storefront_oid}/redirects/delete/dry_run | Check a batch delete of redirect rules without writing it
|
|
503
505
|
*UltracartClient::SfvbApi* | [**dry_run_sfvb_redirect_import**](docs/SfvbApi.md#dry_run_sfvb_redirect_import) | **POST** /sfvb/storefronts/{storefront_oid}/redirects/import/dry_run | Check a redirect import without writing it
|
|
504
506
|
*UltracartClient::SfvbApi* | [**duplicate_sfvb_library_entry**](docs/SfvbApi.md#duplicate_sfvb_library_entry) | **POST** /sfvb/storefronts/{storefront_oid}/library/{library_oid}/duplicate | Copy a library entry into a new private entry
|
|
505
507
|
*UltracartClient::SfvbApi* | [**duplicate_sfvb_page**](docs/SfvbApi.md#duplicate_sfvb_page) | **POST** /sfvb/storefronts/{storefront_oid}/pages/duplicate | Copy a page to a new path
|
|
@@ -1858,6 +1860,8 @@ Class | Method | HTTP request | Description
|
|
|
1858
1860
|
- [UltracartClient::SfvbApproval](docs/SfvbApproval.md)
|
|
1859
1861
|
- [UltracartClient::SfvbApprovalCreateRequest](docs/SfvbApprovalCreateRequest.md)
|
|
1860
1862
|
- [UltracartClient::SfvbApprovalParams](docs/SfvbApprovalParams.md)
|
|
1863
|
+
- [UltracartClient::SfvbApprovalReview](docs/SfvbApprovalReview.md)
|
|
1864
|
+
- [UltracartClient::SfvbApprovalReviewFinding](docs/SfvbApprovalReviewFinding.md)
|
|
1861
1865
|
- [UltracartClient::SfvbApprovalsResponse](docs/SfvbApprovalsResponse.md)
|
|
1862
1866
|
- [UltracartClient::SfvbBlogPost](docs/SfvbBlogPost.md)
|
|
1863
1867
|
- [UltracartClient::SfvbBlogPostDetail](docs/SfvbBlogPostDetail.md)
|
|
@@ -1992,6 +1996,10 @@ Class | Method | HTTP request | Description
|
|
|
1992
1996
|
- [UltracartClient::SfvbRecordingSettingsResponse](docs/SfvbRecordingSettingsResponse.md)
|
|
1993
1997
|
- [UltracartClient::SfvbRedirect](docs/SfvbRedirect.md)
|
|
1994
1998
|
- [UltracartClient::SfvbRedirectCheckResponse](docs/SfvbRedirectCheckResponse.md)
|
|
1999
|
+
- [UltracartClient::SfvbRedirectDeleteRequest](docs/SfvbRedirectDeleteRequest.md)
|
|
2000
|
+
- [UltracartClient::SfvbRedirectDeleteResponse](docs/SfvbRedirectDeleteResponse.md)
|
|
2001
|
+
- [UltracartClient::SfvbRedirectDeleteRow](docs/SfvbRedirectDeleteRow.md)
|
|
2002
|
+
- [UltracartClient::SfvbRedirectDeleteRowResult](docs/SfvbRedirectDeleteRowResult.md)
|
|
1995
2003
|
- [UltracartClient::SfvbRedirectImportRequest](docs/SfvbRedirectImportRequest.md)
|
|
1996
2004
|
- [UltracartClient::SfvbRedirectImportResponse](docs/SfvbRedirectImportResponse.md)
|
|
1997
2005
|
- [UltracartClient::SfvbRedirectImportRow](docs/SfvbRedirectImportRow.md)
|
|
@@ -2218,6 +2226,7 @@ Not every change is committed to every SDK.
|
|
|
2218
2226
|
|
|
2219
2227
|
| Version | Date | Comments |
|
|
2220
2228
|
| --: | :-: | --- |
|
|
2229
|
+
| 4.1.199 | 10/08/2026 | sfvb internal testing |
|
|
2221
2230
|
| 4.1.198 | 10/08/2026 | sfvb internal testing |
|
|
2222
2231
|
| 4.1.197 | 10/08/2026 | sfvb internal testing |
|
|
2223
2232
|
| 4.1.196 | 10/08/2026 | sfvb internal testing |
|
data/docs/SfvbApi.md
CHANGED
|
@@ -23,11 +23,13 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
|
|
|
23
23
|
| [**delete_sfvb_page_multimedia**](SfvbApi.md#delete_sfvb_page_multimedia) | **DELETE** /sfvb/storefronts/{storefront_oid}/pages/multimedia | Detach an image from a page |
|
|
24
24
|
| [**delete_sfvb_preview_session**](SfvbApi.md#delete_sfvb_preview_session) | **DELETE** /sfvb/storefronts/{storefront_oid}/preview_sessions/{preview_session_id} | Delete a preview session |
|
|
25
25
|
| [**delete_sfvb_redirect**](SfvbApi.md#delete_sfvb_redirect) | **DELETE** /sfvb/storefronts/{storefront_oid}/redirects/{redirect_id} | Delete a redirect rule |
|
|
26
|
+
| [**delete_sfvb_redirects**](SfvbApi.md#delete_sfvb_redirects) | **POST** /sfvb/storefronts/{storefront_oid}/redirects/delete | Delete up to 5,000 redirect rules in one call |
|
|
26
27
|
| [**detach_sfvb_blog_post_image**](SfvbApi.md#detach_sfvb_blog_post_image) | **POST** /sfvb/storefronts/{storefront_oid}/blog_posts/{blog_post_oid}/images/detach | Detach an image from a blog post |
|
|
27
28
|
| [**disable_sfvb_i18n_language**](SfvbApi.md#disable_sfvb_i18n_language) | **POST** /sfvb/storefronts/{storefront_oid}/i18n/languages/{code}/disable | Disable a language |
|
|
28
29
|
| [**disable_sfvb_upsell_offer**](SfvbApi.md#disable_sfvb_upsell_offer) | **POST** /sfvb/storefronts/{storefront_oid}/upsell_offers/{upsell_offer_oid}/disable | Disable an upsell offer |
|
|
29
30
|
| [**disable_sfvb_upsell_path**](SfvbApi.md#disable_sfvb_upsell_path) | **POST** /sfvb/storefronts/{storefront_oid}/upsell_paths/{upsell_path_oid}/disable | Disable an upsell path |
|
|
30
31
|
| [**download_sfvb_file**](SfvbApi.md#download_sfvb_file) | **GET** /sfvb/storefronts/{storefront_oid}/files/download | Read a storefront file's raw bytes |
|
|
32
|
+
| [**dry_run_sfvb_redirect_delete**](SfvbApi.md#dry_run_sfvb_redirect_delete) | **POST** /sfvb/storefronts/{storefront_oid}/redirects/delete/dry_run | Check a batch delete of redirect rules without writing it |
|
|
31
33
|
| [**dry_run_sfvb_redirect_import**](SfvbApi.md#dry_run_sfvb_redirect_import) | **POST** /sfvb/storefronts/{storefront_oid}/redirects/import/dry_run | Check a redirect import without writing it |
|
|
32
34
|
| [**duplicate_sfvb_library_entry**](SfvbApi.md#duplicate_sfvb_library_entry) | **POST** /sfvb/storefronts/{storefront_oid}/library/{library_oid}/duplicate | Copy a library entry into a new private entry |
|
|
33
35
|
| [**duplicate_sfvb_page**](SfvbApi.md#duplicate_sfvb_page) | **POST** /sfvb/storefronts/{storefront_oid}/pages/duplicate | Copy a page to a new path |
|
|
@@ -1197,6 +1199,61 @@ nil (empty response body)
|
|
|
1197
1199
|
- **Accept**: application/json
|
|
1198
1200
|
|
|
1199
1201
|
|
|
1202
|
+
## delete_sfvb_redirects
|
|
1203
|
+
|
|
1204
|
+
> <SfvbRedirectDeleteResponse> delete_sfvb_redirects(storefront_oid, redirect_delete_request, opts)
|
|
1205
|
+
|
|
1206
|
+
Delete up to 5,000 redirect rules in one call
|
|
1207
|
+
|
|
1208
|
+
Deletes exactly the rows of a dry run, given its plan_hash, in one transaction. Every row needs its hash_sha256. A rule changed since its hash was read is skipped and reported as stale, and a missing one as not_found; the other rows still go through. Needs the approval of the person who signed in the CLI, as an approved redirect.delete_batch request for exactly these rows in the Approval-Id header, and sfvb_publish. Deleting rules lets add and import work again once the storefront is back under 5,000 rules.
|
|
1209
|
+
|
|
1210
|
+
|
|
1211
|
+
### Examples
|
|
1212
|
+
|
|
1213
|
+
|
|
1214
|
+
(No example for this operation).
|
|
1215
|
+
|
|
1216
|
+
|
|
1217
|
+
#### Using the delete_sfvb_redirects_with_http_info variant
|
|
1218
|
+
|
|
1219
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1220
|
+
|
|
1221
|
+
> <Array(<SfvbRedirectDeleteResponse>, Integer, Hash)> delete_sfvb_redirects_with_http_info(storefront_oid, redirect_delete_request, opts)
|
|
1222
|
+
|
|
1223
|
+
```ruby
|
|
1224
|
+
begin
|
|
1225
|
+
# Delete up to 5,000 redirect rules in one call
|
|
1226
|
+
data, status_code, headers = api_instance.delete_sfvb_redirects_with_http_info(storefront_oid, redirect_delete_request, opts)
|
|
1227
|
+
p status_code # => 2xx
|
|
1228
|
+
p headers # => { ... }
|
|
1229
|
+
p data # => <SfvbRedirectDeleteResponse>
|
|
1230
|
+
rescue UltracartClient::ApiError => e
|
|
1231
|
+
puts "Error when calling SfvbApi->delete_sfvb_redirects_with_http_info: #{e}"
|
|
1232
|
+
end
|
|
1233
|
+
```
|
|
1234
|
+
|
|
1235
|
+
### Parameters
|
|
1236
|
+
|
|
1237
|
+
| Name | Type | Description | Notes |
|
|
1238
|
+
| ---- | ---- | ----------- | ----- |
|
|
1239
|
+
| **storefront_oid** | **Integer** | | |
|
|
1240
|
+
| **redirect_delete_request** | [**SfvbRedirectDeleteRequest**](SfvbRedirectDeleteRequest.md) | The request | |
|
|
1241
|
+
| **approval_id** | **String** | The approval_id of an approved redirect.delete_batch request for exactly these rows. Required. See POST /sfvb/approvals. | [optional] |
|
|
1242
|
+
|
|
1243
|
+
### Return type
|
|
1244
|
+
|
|
1245
|
+
[**SfvbRedirectDeleteResponse**](SfvbRedirectDeleteResponse.md)
|
|
1246
|
+
|
|
1247
|
+
### Authorization
|
|
1248
|
+
|
|
1249
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
1250
|
+
|
|
1251
|
+
### HTTP request headers
|
|
1252
|
+
|
|
1253
|
+
- **Content-Type**: application/json; charset=UTF-8
|
|
1254
|
+
- **Accept**: application/json
|
|
1255
|
+
|
|
1256
|
+
|
|
1200
1257
|
## detach_sfvb_blog_post_image
|
|
1201
1258
|
|
|
1202
1259
|
> <SfvbBlogPostDetail> detach_sfvb_blog_post_image(storefront_oid, blog_post_oid, blog_post_image_request)
|
|
@@ -1469,6 +1526,60 @@ nil (empty response body)
|
|
|
1469
1526
|
- **Accept**: application/octet-stream
|
|
1470
1527
|
|
|
1471
1528
|
|
|
1529
|
+
## dry_run_sfvb_redirect_delete
|
|
1530
|
+
|
|
1531
|
+
> <SfvbRedirectDeleteResponse> dry_run_sfvb_redirect_delete(storefront_oid, redirect_delete_request)
|
|
1532
|
+
|
|
1533
|
+
Check a batch delete of redirect rules without writing it
|
|
1534
|
+
|
|
1535
|
+
Checks up to 5,000 rules by redirect_id and returns each one as deletable, stale (its hash_sha256 differs from the one sent) or not_found, with its current hash, source, target, status, type and note, and a plan_hash. Writes nothing. Rows may leave out hash_sha256; the result carries the current one to send when deleting.
|
|
1536
|
+
|
|
1537
|
+
|
|
1538
|
+
### Examples
|
|
1539
|
+
|
|
1540
|
+
|
|
1541
|
+
(No example for this operation).
|
|
1542
|
+
|
|
1543
|
+
|
|
1544
|
+
#### Using the dry_run_sfvb_redirect_delete_with_http_info variant
|
|
1545
|
+
|
|
1546
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1547
|
+
|
|
1548
|
+
> <Array(<SfvbRedirectDeleteResponse>, Integer, Hash)> dry_run_sfvb_redirect_delete_with_http_info(storefront_oid, redirect_delete_request)
|
|
1549
|
+
|
|
1550
|
+
```ruby
|
|
1551
|
+
begin
|
|
1552
|
+
# Check a batch delete of redirect rules without writing it
|
|
1553
|
+
data, status_code, headers = api_instance.dry_run_sfvb_redirect_delete_with_http_info(storefront_oid, redirect_delete_request)
|
|
1554
|
+
p status_code # => 2xx
|
|
1555
|
+
p headers # => { ... }
|
|
1556
|
+
p data # => <SfvbRedirectDeleteResponse>
|
|
1557
|
+
rescue UltracartClient::ApiError => e
|
|
1558
|
+
puts "Error when calling SfvbApi->dry_run_sfvb_redirect_delete_with_http_info: #{e}"
|
|
1559
|
+
end
|
|
1560
|
+
```
|
|
1561
|
+
|
|
1562
|
+
### Parameters
|
|
1563
|
+
|
|
1564
|
+
| Name | Type | Description | Notes |
|
|
1565
|
+
| ---- | ---- | ----------- | ----- |
|
|
1566
|
+
| **storefront_oid** | **Integer** | | |
|
|
1567
|
+
| **redirect_delete_request** | [**SfvbRedirectDeleteRequest**](SfvbRedirectDeleteRequest.md) | The request | |
|
|
1568
|
+
|
|
1569
|
+
### Return type
|
|
1570
|
+
|
|
1571
|
+
[**SfvbRedirectDeleteResponse**](SfvbRedirectDeleteResponse.md)
|
|
1572
|
+
|
|
1573
|
+
### Authorization
|
|
1574
|
+
|
|
1575
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
1576
|
+
|
|
1577
|
+
### HTTP request headers
|
|
1578
|
+
|
|
1579
|
+
- **Content-Type**: application/json; charset=UTF-8
|
|
1580
|
+
- **Accept**: application/json
|
|
1581
|
+
|
|
1582
|
+
|
|
1472
1583
|
## dry_run_sfvb_redirect_import
|
|
1473
1584
|
|
|
1474
1585
|
> <SfvbRedirectImportResponse> dry_run_sfvb_redirect_import(storefront_oid, redirect_import_request)
|
|
@@ -4568,7 +4679,7 @@ end
|
|
|
4568
4679
|
|
|
4569
4680
|
Request a human approval
|
|
4570
4681
|
|
|
4571
|
-
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.
|
|
4682
|
+
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 script as content, or params.version for a revert. The request starts as reviewing while UltraCart's scanner and two AI models read it, then becomes 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 bytes.
|
|
4572
4683
|
|
|
4573
4684
|
|
|
4574
4685
|
### Examples
|
|
@@ -6093,6 +6204,7 @@ end
|
|
|
6093
6204
|
| **if_match** | **String** | Content hash from the last read. Required; 428 when absent, 412 when stale. | |
|
|
6094
6205
|
| **file_write_request** | [**SfvbFileWriteRequest**](SfvbFileWriteRequest.md) | File content to write | |
|
|
6095
6206
|
| **path** | **String** | | [optional] |
|
|
6207
|
+
| **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] |
|
|
6096
6208
|
|
|
6097
6209
|
### Return type
|
|
6098
6210
|
|
|
@@ -7437,7 +7549,7 @@ end
|
|
|
7437
7549
|
|
|
7438
7550
|
## revert_sfvb_file
|
|
7439
7551
|
|
|
7440
|
-
> <SfvbFileWriteResponse> revert_sfvb_file(storefront_oid, if_match, file_revert_request)
|
|
7552
|
+
> <SfvbFileWriteResponse> revert_sfvb_file(storefront_oid, if_match, file_revert_request, opts)
|
|
7441
7553
|
|
|
7442
7554
|
Revert a storefront file to an earlier version
|
|
7443
7555
|
|
|
@@ -7454,12 +7566,12 @@ The revert lands as a new version, so it is itself undoable.
|
|
|
7454
7566
|
|
|
7455
7567
|
This returns an Array which contains the response data, status code and headers.
|
|
7456
7568
|
|
|
7457
|
-
> <Array(<SfvbFileWriteResponse>, Integer, Hash)> revert_sfvb_file_with_http_info(storefront_oid, if_match, file_revert_request)
|
|
7569
|
+
> <Array(<SfvbFileWriteResponse>, Integer, Hash)> revert_sfvb_file_with_http_info(storefront_oid, if_match, file_revert_request, opts)
|
|
7458
7570
|
|
|
7459
7571
|
```ruby
|
|
7460
7572
|
begin
|
|
7461
7573
|
# Revert a storefront file to an earlier version
|
|
7462
|
-
data, status_code, headers = api_instance.revert_sfvb_file_with_http_info(storefront_oid, if_match, file_revert_request)
|
|
7574
|
+
data, status_code, headers = api_instance.revert_sfvb_file_with_http_info(storefront_oid, if_match, file_revert_request, opts)
|
|
7463
7575
|
p status_code # => 2xx
|
|
7464
7576
|
p headers # => { ... }
|
|
7465
7577
|
p data # => <SfvbFileWriteResponse>
|
|
@@ -7475,6 +7587,7 @@ end
|
|
|
7475
7587
|
| **storefront_oid** | **Integer** | | |
|
|
7476
7588
|
| **if_match** | **String** | Content hash of the file being reverted. Required; 428 when absent, 412 when stale. | |
|
|
7477
7589
|
| **file_revert_request** | [**SfvbFileRevertRequest**](SfvbFileRevertRequest.md) | Version to revert the file to | |
|
|
7590
|
+
| **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] |
|
|
7478
7591
|
|
|
7479
7592
|
### Return type
|
|
7480
7593
|
|
data/docs/SfvbApproval.md
CHANGED
|
@@ -18,8 +18,9 @@
|
|
|
18
18
|
| **outcome_http_status** | **Integer** | The HTTP status the gated call answered with. | [optional] |
|
|
19
19
|
| **params** | [**SfvbApprovalParams**](SfvbApprovalParams.md) | | [optional] |
|
|
20
20
|
| **reason** | **String** | The reason the agent sent, as stored and shown (cleaned and capped). | [optional] |
|
|
21
|
+
| **review** | [**SfvbApprovalReview**](SfvbApprovalReview.md) | | [optional] |
|
|
21
22
|
| **scope** | **String** | Where the action applies. The storefront host name, or account for account-wide actions. | [optional] |
|
|
22
|
-
| **status** | **String** | pending, approved, denied, cancelled, expired or
|
|
23
|
+
| **status** | **String** | reviewing, pending, approved, denied, cancelled, expired, used or refused. Only approved may be sent with the gated call. A script write starts as reviewing while UltraCart reviews it; keep polling, and show approval_url only once it is pending. refused means the review refused the script; outcome_code and review say why. | [optional] |
|
|
23
24
|
| **storefront_oid** | **Integer** | The storefront the action runs on. Absent for account-wide actions. | [optional] |
|
|
24
25
|
| **used_at** | **String** | When the gated call used this approval, ISO 8601 UTC. | [optional] |
|
|
25
26
|
| **user_code** | **String** | Short matching code. Print it next to approval_url so the person can check the page shows the same code. | [optional] |
|
|
@@ -44,6 +45,7 @@ instance = UltracartClient::SfvbApproval.new(
|
|
|
44
45
|
outcome_http_status: null,
|
|
45
46
|
params: null,
|
|
46
47
|
reason: null,
|
|
48
|
+
review: null,
|
|
47
49
|
scope: null,
|
|
48
50
|
status: null,
|
|
49
51
|
storefront_oid: null,
|
|
@@ -5,8 +5,10 @@
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
7
|
| **action** | **String** | The gated action to approve. | [optional] |
|
|
8
|
+
| **content** | **String** | For a file.put_script write, the exact script to be written, 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] |
|
|
8
9
|
| **params** | [**SfvbApprovalParams**](SfvbApprovalParams.md) | | [optional] |
|
|
9
10
|
| **reason** | **String** | Why the agent wants to do this, in a sentence. Shown to the person as unverified text, capped at 500 characters. | [optional] |
|
|
11
|
+
| **redirect_rows** | [**Array<SfvbRedirectDeleteRow>**](SfvbRedirectDeleteRow.md) | For redirect.delete_batch, exactly the rows the batch delete will send, up to 5,000, each with its hash_sha256. UltraCart keeps only their hash. | [optional] |
|
|
10
12
|
|
|
11
13
|
## Example
|
|
12
14
|
|
|
@@ -15,8 +17,10 @@ require 'ultracart_api'
|
|
|
15
17
|
|
|
16
18
|
instance = UltracartClient::SfvbApprovalCreateRequest.new(
|
|
17
19
|
action: null,
|
|
20
|
+
content: null,
|
|
18
21
|
params: null,
|
|
19
|
-
reason: null
|
|
22
|
+
reason: null,
|
|
23
|
+
redirect_rows: null
|
|
20
24
|
)
|
|
21
25
|
```
|
|
22
26
|
|
data/docs/SfvbApprovalParams.md
CHANGED
|
@@ -5,7 +5,11 @@
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
7
|
| **blog_post_oid** | **Integer** | The blog post, for blog_post.delete. | [optional] |
|
|
8
|
-
| **
|
|
8
|
+
| **content_sha256** | **String** | For file.put_script, the SHA-256 of the exact bytes approved. Set by the server, never by the caller. The write must send bytes with this hash. | [optional] |
|
|
9
|
+
| **path** | **String** | The file path, for file.delete and file.put_script. Exactly as the gated call will send it. | [optional] |
|
|
10
|
+
| **rows_sha256** | **String** | For redirect.delete_batch, the plan_hash of the exact rows approved. Set by the server. The batch delete must send rows with this hash. | [optional] |
|
|
11
|
+
| **rule_count** | **Integer** | For redirect.delete_batch, how many rules the batch would delete when it was requested. Set by the server. | [optional] |
|
|
12
|
+
| **version** | **Integer** | For file.put_script, the history version a revert restores. Leave it out, and send content instead, for a write. | [optional] |
|
|
9
13
|
|
|
10
14
|
## Example
|
|
11
15
|
|
|
@@ -14,7 +18,11 @@ require 'ultracart_api'
|
|
|
14
18
|
|
|
15
19
|
instance = UltracartClient::SfvbApprovalParams.new(
|
|
16
20
|
blog_post_oid: null,
|
|
17
|
-
|
|
21
|
+
content_sha256: null,
|
|
22
|
+
path: null,
|
|
23
|
+
rows_sha256: null,
|
|
24
|
+
rule_count: null,
|
|
25
|
+
version: null
|
|
18
26
|
)
|
|
19
27
|
```
|
|
20
28
|
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
# UltracartClient::SfvbApprovalReview
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **apis** | **Array<String>** | Browser features the script uses that matter for safety, such as network calls, cookies, storage and dynamic code. | [optional] |
|
|
8
|
+
| **domains** | **Array<String>** | Every host the script names, found by UltraCart's scanner rather than the AI. | [optional] |
|
|
9
|
+
| **findings** | [**Array<SfvbApprovalReviewFinding>**](SfvbApprovalReviewFinding.md) | What the reviewers flagged, each with the line and the quoted code. | [optional] |
|
|
10
|
+
| **new_domains** | **Array<String>** | Hosts the current version of the file does not name. | [optional] |
|
|
11
|
+
| **prompt_version** | **String** | Version of the review policy that produced this. | [optional] |
|
|
12
|
+
| **reviewed_at** | **String** | When the review ran, ISO 8601 UTC. | [optional] |
|
|
13
|
+
| **signals** | **Array<String>** | Obfuscation, card field and credential signals the scanner found. Credentials are named by kind, never by value. | [optional] |
|
|
14
|
+
| **size_bytes** | **Integer** | Size of the reviewed script in bytes. | [optional] |
|
|
15
|
+
| **summary** | **String** | What the script does, in plain words, as the reviewers read it. | [optional] |
|
|
16
|
+
| **verdict** | **String** | approve when both reviewers found nothing, human when the person should look closely. On a refused request, block when both reviewers found a clear violation, error when the review could not finish. | [optional] |
|
|
17
|
+
|
|
18
|
+
## Example
|
|
19
|
+
|
|
20
|
+
```ruby
|
|
21
|
+
require 'ultracart_api'
|
|
22
|
+
|
|
23
|
+
instance = UltracartClient::SfvbApprovalReview.new(
|
|
24
|
+
apis: null,
|
|
25
|
+
domains: null,
|
|
26
|
+
findings: null,
|
|
27
|
+
new_domains: null,
|
|
28
|
+
prompt_version: null,
|
|
29
|
+
reviewed_at: null,
|
|
30
|
+
signals: null,
|
|
31
|
+
size_bytes: null,
|
|
32
|
+
summary: null,
|
|
33
|
+
verdict: null
|
|
34
|
+
)
|
|
35
|
+
```
|
|
36
|
+
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# UltracartClient::SfvbApprovalReviewFinding
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **category** | **String** | What kind of problem, such as data_exfiltration or third_party_tracking. | [optional] |
|
|
8
|
+
| **clear_violation** | **Boolean** | True when this alone would justify refusing the script. | [optional] |
|
|
9
|
+
| **evidence** | **String** | The code quoted from the script, at most 500 characters. | [optional] |
|
|
10
|
+
| **line** | **Integer** | The line of the script the evidence is on, when the reviewer named one. | [optional] |
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```ruby
|
|
15
|
+
require 'ultracart_api'
|
|
16
|
+
|
|
17
|
+
instance = UltracartClient::SfvbApprovalReviewFinding.new(
|
|
18
|
+
category: null,
|
|
19
|
+
clear_violation: null,
|
|
20
|
+
evidence: null,
|
|
21
|
+
line: null
|
|
22
|
+
)
|
|
23
|
+
```
|
|
24
|
+
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# UltracartClient::SfvbRedirectDeleteRequest
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **plan_hash** | **String** | From the dry run of exactly these rows. Required to delete. | [optional] |
|
|
8
|
+
| **rows** | [**Array<SfvbRedirectDeleteRow>**](SfvbRedirectDeleteRow.md) | The rules, up to 5,000. Each redirect_id at most once. | [optional] |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'ultracart_api'
|
|
14
|
+
|
|
15
|
+
instance = UltracartClient::SfvbRedirectDeleteRequest.new(
|
|
16
|
+
plan_hash: null,
|
|
17
|
+
rows: null
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
# UltracartClient::SfvbRedirectDeleteResponse
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **applied** | **Boolean** | True when this call deleted rules. | [optional] |
|
|
8
|
+
| **deletable** | **Integer** | Rows that can be, or on an apply could be, deleted. | [optional] |
|
|
9
|
+
| **deleted** | **Integer** | Rules deleted. Zero on a dry run. | [optional] |
|
|
10
|
+
| **limit** | **Integer** | The most rules a storefront can have for add and import to work. | [optional] |
|
|
11
|
+
| **not_found** | **Integer** | Rows naming no rule on this storefront. Skipped. | [optional] |
|
|
12
|
+
| **plan_hash** | **String** | Send this to apply exactly these rows. Also what an approval for them is bound to. | [optional] |
|
|
13
|
+
| **rows** | [**Array<SfvbRedirectDeleteRowResult>**](SfvbRedirectDeleteRowResult.md) | One result per row, in request order. | [optional] |
|
|
14
|
+
| **rule_count** | **Integer** | The storefront's redirect rules now. After an apply, after the delete. | [optional] |
|
|
15
|
+
| **stale** | **Integer** | Rows whose rule changed since its hash was read. Skipped. | [optional] |
|
|
16
|
+
| **total** | **Integer** | Rows in the request. | [optional] |
|
|
17
|
+
|
|
18
|
+
## Example
|
|
19
|
+
|
|
20
|
+
```ruby
|
|
21
|
+
require 'ultracart_api'
|
|
22
|
+
|
|
23
|
+
instance = UltracartClient::SfvbRedirectDeleteResponse.new(
|
|
24
|
+
applied: null,
|
|
25
|
+
deletable: null,
|
|
26
|
+
deleted: null,
|
|
27
|
+
limit: null,
|
|
28
|
+
not_found: null,
|
|
29
|
+
plan_hash: null,
|
|
30
|
+
rows: null,
|
|
31
|
+
rule_count: null,
|
|
32
|
+
stale: null,
|
|
33
|
+
total: null
|
|
34
|
+
)
|
|
35
|
+
```
|
|
36
|
+
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# UltracartClient::SfvbRedirectDeleteRow
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **hash_sha256** | **String** | The hash_sha256 you read. Optional on a dry run, which reports the current one. Required to delete. | [optional] |
|
|
8
|
+
| **redirect_id** | **Integer** | The rule. | [optional] |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'ultracart_api'
|
|
14
|
+
|
|
15
|
+
instance = UltracartClient::SfvbRedirectDeleteRow.new(
|
|
16
|
+
hash_sha256: null,
|
|
17
|
+
redirect_id: null
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
# UltracartClient::SfvbRedirectDeleteRowResult
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **hash_sha256** | **String** | The rule's current hash. Absent when not_found. | [optional] |
|
|
8
|
+
| **note** | **String** | The rule's note. | [optional] |
|
|
9
|
+
| **redirect_id** | **Integer** | The rule. | [optional] |
|
|
10
|
+
| **result** | **String** | deletable, stale (the rule changed since its hash was read), not_found, or deleted after an apply. | [optional] |
|
|
11
|
+
| **source** | **String** | The rule's source, for a backup. | [optional] |
|
|
12
|
+
| **status** | **String** | The rule's status (301, 302 or rewrite). | [optional] |
|
|
13
|
+
| **target** | **String** | The rule's target, for a backup. | [optional] |
|
|
14
|
+
| **type** | **String** | exact or pattern. | [optional] |
|
|
15
|
+
|
|
16
|
+
## Example
|
|
17
|
+
|
|
18
|
+
```ruby
|
|
19
|
+
require 'ultracart_api'
|
|
20
|
+
|
|
21
|
+
instance = UltracartClient::SfvbRedirectDeleteRowResult.new(
|
|
22
|
+
hash_sha256: null,
|
|
23
|
+
note: null,
|
|
24
|
+
redirect_id: null,
|
|
25
|
+
result: null,
|
|
26
|
+
source: null,
|
|
27
|
+
status: null,
|
|
28
|
+
target: null,
|
|
29
|
+
type: null
|
|
30
|
+
)
|
|
31
|
+
```
|
|
32
|
+
|