ultracart_api 4.1.201 → 4.1.203

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8eb0f77a073bc3b2d2b66f254190227539e919cfcae97ee88d4844a410922d84
-  data.tar.gz: 936959c530a9c85860e0c5e45d2a7ab24e85a101580f77dbd957ec0806923ccf
+  metadata.gz: 00666a9bf01ef4230812762f575d67f10482bba350bd40952ba485c405ebde29
+  data.tar.gz: b2a50501d6cad4f28cb8f98beaeb379f19df30d8185bfad75d7775ffd5478205
 SHA512:
-  metadata.gz: 492a6776f33223e9f198c4c8185a67b60f67ce0b13d3557b0d4d82b3c8aad2b36994799103b5026676701fbde6703284558280e42aa1ea47cf745fbf0788e62d
-  data.tar.gz: 5bcb498157c133ff90e73a6df2cbfe3d3ee2cd508a374df95d2322d21266477df836b3d6957a12c4b13993f7aad4cb119e0a49295488b4adaef669be521bb45b
+  metadata.gz: eab1417ea0f102c391989bbf39a7356175d9070c18b710474f09c911ce9fcb12086e38de37b1f343f897afeab6a2fc2fb3861e0224fa18248d14b5f7eb08c862
+  data.tar.gz: 25d9f4c87f0d91cec8b10f02f15db07e10c408700c1a62f5563374ab436cfc74e1d1e207996132bf7122c2a4af04da0fcf626c8307183ecccea7853268e1f5cb

data/README.md

@@ -7,7 +7,7 @@ Note: Every method has a sample for every language.  See https://github.com/Ultr
 This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
 
 - API version: 2.0.0
-- Package version: 4.1.201
+- Package version: 4.1.203
 - Build package: org.openapitools.codegen.languages.RubyClientCodegen
 - For more information, please visit [http://www.ultracart.com/api/](http://www.ultracart.com/api/)
 
@@ -16,7 +16,7 @@ This SDK is automatically generated by the [OpenAPI Generator](https://openapi-g
 gemfile:
 
 ```shell
-gem 'ultracart_api', '4.1.201'
+gem 'ultracart_api', '4.1.203'
 ```
 
 install:
@@ -496,6 +496,7 @@ Class | Method | HTTP request | Description
 *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
 *UltracartClient::SfvbApi* | [**delete_sfvb_redirect**](docs/SfvbApi.md#delete_sfvb_redirect) | **DELETE** /sfvb/storefronts/{storefront_oid}/redirects/{redirect_id} | Delete a redirect rule
 *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
+*UltracartClient::SfvbApi* | [**delete_sfvb_secret_request**](docs/SfvbApi.md#delete_sfvb_secret_request) | **DELETE** /sfvb/secrets/{request_id} | Cancel a pending secret request
 *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
 *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
 *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
@@ -554,6 +555,9 @@ Class | Method | HTTP request | Description
 *UltracartClient::SfvbApi* | [**get_sfvb_recording_settings**](docs/SfvbApi.md#get_sfvb_recording_settings) | **GET** /sfvb/storefronts/{storefront_oid}/recording_settings | Get the storefront's screen recording settings
 *UltracartClient::SfvbApi* | [**get_sfvb_redirect**](docs/SfvbApi.md#get_sfvb_redirect) | **GET** /sfvb/storefronts/{storefront_oid}/redirects/{redirect_id} | Read one redirect rule
 *UltracartClient::SfvbApi* | [**get_sfvb_redirects**](docs/SfvbApi.md#get_sfvb_redirects) | **GET** /sfvb/storefronts/{storefront_oid}/redirects | List the storefront's redirect rules
+*UltracartClient::SfvbApi* | [**get_sfvb_secret_kinds**](docs/SfvbApi.md#get_sfvb_secret_kinds) | **GET** /sfvb/secrets/kinds | List the secrets this server collects
+*UltracartClient::SfvbApi* | [**get_sfvb_secret_request**](docs/SfvbApi.md#get_sfvb_secret_request) | **GET** /sfvb/secrets/{request_id} | Read one secret request
+*UltracartClient::SfvbApi* | [**get_sfvb_secret_requests**](docs/SfvbApi.md#get_sfvb_secret_requests) | **GET** /sfvb/secrets | List this sign-in's secret requests
 *UltracartClient::SfvbApi* | [**get_sfvb_server_log**](docs/SfvbApi.md#get_sfvb_server_log) | **GET** /sfvb/storefronts/{storefront_oid}/logs/{log_id} | Get one storefront render log
 *UltracartClient::SfvbApi* | [**get_sfvb_site_attributes**](docs/SfvbApi.md#get_sfvb_site_attributes) | **GET** /sfvb/storefronts/{storefront_oid}/attributes | Read a storefront's site attributes
 *UltracartClient::SfvbApi* | [**get_sfvb_test_orders**](docs/SfvbApi.md#get_sfvb_test_orders) | **GET** /sfvb/storefronts/{storefront_oid}/test_orders | List recent test orders
@@ -570,6 +574,7 @@ Class | Method | HTTP request | Description
 *UltracartClient::SfvbApi* | [**insert_sfvb_blog_post**](docs/SfvbApi.md#insert_sfvb_blog_post) | **POST** /sfvb/storefronts/{storefront_oid}/blog_posts | Create a blog post
 *UltracartClient::SfvbApi* | [**insert_sfvb_page**](docs/SfvbApi.md#insert_sfvb_page) | **POST** /sfvb/storefronts/{storefront_oid}/pages | Create a page
 *UltracartClient::SfvbApi* | [**insert_sfvb_redirect**](docs/SfvbApi.md#insert_sfvb_redirect) | **POST** /sfvb/storefronts/{storefront_oid}/redirects | Create a 301 redirect rule
+*UltracartClient::SfvbApi* | [**insert_sfvb_secret_request**](docs/SfvbApi.md#insert_sfvb_secret_request) | **POST** /sfvb/secrets | Ask a person to enter secret values
 *UltracartClient::SfvbApi* | [**insert_sfvb_upsell_offer**](docs/SfvbApi.md#insert_sfvb_upsell_offer) | **POST** /sfvb/storefronts/{storefront_oid}/upsell_offers | Create an upsell offer
 *UltracartClient::SfvbApi* | [**insert_sfvb_upsell_path**](docs/SfvbApi.md#insert_sfvb_upsell_path) | **POST** /sfvb/storefronts/{storefront_oid}/upsell_paths | Create an upsell path
 *UltracartClient::SfvbApi* | [**install_sfvb_library_entry**](docs/SfvbApi.md#install_sfvb_library_entry) | **POST** /sfvb/storefronts/{storefront_oid}/library/{library_oid}/install | Install a library entry into a storefront
@@ -599,6 +604,7 @@ Class | Method | HTTP request | Description
 *UltracartClient::SfvbApi* | [**put_sfvb_item_attributes**](docs/SfvbApi.md#put_sfvb_item_attributes) | **PUT** /sfvb/storefronts/{storefront_oid}/items/attributes | Change some of an item's attributes
 *UltracartClient::SfvbApi* | [**put_sfvb_item_content**](docs/SfvbApi.md#put_sfvb_item_content) | **PUT** /sfvb/storefronts/{storefront_oid}/items/content | Change an item's title or long description
 *UltracartClient::SfvbApi* | [**put_sfvb_item_multimedia**](docs/SfvbApi.md#put_sfvb_item_multimedia) | **PUT** /sfvb/storefronts/{storefront_oid}/items/multimedia | Attach an image to an item
+*UltracartClient::SfvbApi* | [**put_sfvb_item_multimedia_description**](docs/SfvbApi.md#put_sfvb_item_multimedia_description) | **PUT** /sfvb/storefronts/{storefront_oid}/items/multimedia/description | Change an item image's description
 *UltracartClient::SfvbApi* | [**put_sfvb_item_pricing**](docs/SfvbApi.md#put_sfvb_item_pricing) | **PUT** /sfvb/storefronts/{storefront_oid}/items/pricing | Change what an item charges
 *UltracartClient::SfvbApi* | [**put_sfvb_item_related**](docs/SfvbApi.md#put_sfvb_item_related) | **PUT** /sfvb/storefronts/{storefront_oid}/items/related | Replace an item's related items
 *UltracartClient::SfvbApi* | [**put_sfvb_item_seo**](docs/SfvbApi.md#put_sfvb_item_seo) | **PUT** /sfvb/storefronts/{storefront_oid}/items/seo | Change an item's search metadata
@@ -621,6 +627,7 @@ Class | Method | HTTP request | Description
 *UltracartClient::SfvbApi* | [**resolve_sfvb_template**](docs/SfvbApi.md#resolve_sfvb_template) | **GET** /sfvb/storefronts/{storefront_oid}/templates/resolve | Resolve a template name to the file a page renders
 *UltracartClient::SfvbApi* | [**revert_sfvb_container**](docs/SfvbApi.md#revert_sfvb_container) | **POST** /sfvb/storefronts/{storefront_oid}/containers/{owner_type}/{owner_object_id}/revert | Revert a container stored outside the file system
 *UltracartClient::SfvbApi* | [**revert_sfvb_file**](docs/SfvbApi.md#revert_sfvb_file) | **POST** /sfvb/storefronts/{storefront_oid}/files/revert | Revert a storefront file to an earlier version
+*UltracartClient::SfvbApi* | [**revoke_sfvb_secret_request**](docs/SfvbApi.md#revoke_sfvb_secret_request) | **POST** /sfvb/secrets/{request_id}/revoke | Revoke a fulfilled request's unused handles
 *UltracartClient::SfvbApi* | [**search_sfvb_files**](docs/SfvbApi.md#search_sfvb_files) | **POST** /sfvb/storefronts/{storefront_oid}/files/search | Search storefront files
 *UltracartClient::SfvbApi* | [**search_sfvb_library**](docs/SfvbApi.md#search_sfvb_library) | **GET** /sfvb/storefronts/{storefront_oid}/library | Search the element library
 *UltracartClient::SfvbApi* | [**set_sfvb_library_screenshot**](docs/SfvbApi.md#set_sfvb_library_screenshot) | **PUT** /sfvb/storefronts/{storefront_oid}/library/{library_oid}/screenshot | Set a library entry's screenshot
@@ -1937,6 +1944,7 @@ Class | Method | HTTP request | Description
  - [UltracartClient::SfvbItemContainersResponse](docs/SfvbItemContainersResponse.md)
  - [UltracartClient::SfvbItemContentRequest](docs/SfvbItemContentRequest.md)
  - [UltracartClient::SfvbItemMultimedia](docs/SfvbItemMultimedia.md)
+ - [UltracartClient::SfvbItemMultimediaDescriptionRequest](docs/SfvbItemMultimediaDescriptionRequest.md)
  - [UltracartClient::SfvbItemMultimediaRequest](docs/SfvbItemMultimediaRequest.md)
  - [UltracartClient::SfvbItemPricing](docs/SfvbItemPricing.md)
  - [UltracartClient::SfvbItemPricingRequest](docs/SfvbItemPricingRequest.md)
@@ -2035,6 +2043,13 @@ Class | Method | HTTP request | Description
  - [UltracartClient::SfvbRedirectsResponse](docs/SfvbRedirectsResponse.md)
  - [UltracartClient::SfvbRenderRequest](docs/SfvbRenderRequest.md)
  - [UltracartClient::SfvbRenderResponse](docs/SfvbRenderResponse.md)
+ - [UltracartClient::SfvbSecretHandle](docs/SfvbSecretHandle.md)
+ - [UltracartClient::SfvbSecretKind](docs/SfvbSecretKind.md)
+ - [UltracartClient::SfvbSecretKindsResponse](docs/SfvbSecretKindsResponse.md)
+ - [UltracartClient::SfvbSecretRequest](docs/SfvbSecretRequest.md)
+ - [UltracartClient::SfvbSecretRequestCreate](docs/SfvbSecretRequestCreate.md)
+ - [UltracartClient::SfvbSecretRequestsResponse](docs/SfvbSecretRequestsResponse.md)
+ - [UltracartClient::SfvbSecretSink](docs/SfvbSecretSink.md)
  - [UltracartClient::SfvbServerLog](docs/SfvbServerLog.md)
  - [UltracartClient::SfvbServerLogDetail](docs/SfvbServerLogDetail.md)
  - [UltracartClient::SfvbServerLogEntry](docs/SfvbServerLogEntry.md)
@@ -2250,6 +2265,8 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 4.1.203 | 10/15/2026 | sfvb internal testing |
+| 4.1.202 | 10/13/2026 | sfvb internal testing |
 | 4.1.201 | 10/12/2026 | sfvb internal testing |
 | 4.1.200 | 10/09/2026 | sfvb internal testing |
 | 4.1.199 | 10/08/2026 | sfvb internal testing |

data/docs/OauthApi.md

@@ -294,7 +294,7 @@ end
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **client_id** | **String** | The OAuth application client_id. |  |
-| **token** | **String** | The OAuth access token that is to be revoked.. |  |
+| **token** | **String** | The OAuth access token or refresh token that is to be revoked. |  |
 
 ### Return type
 

data/docs/SfvbApi.md

@@ -24,6 +24,7 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
 | [**delete_sfvb_preview_session**](SfvbApi.md#delete_sfvb_preview_session) | **DELETE** /sfvb/storefronts/{storefront_oid}/preview_sessions/{preview_session_id} | Delete a preview session |
 | [**delete_sfvb_redirect**](SfvbApi.md#delete_sfvb_redirect) | **DELETE** /sfvb/storefronts/{storefront_oid}/redirects/{redirect_id} | Delete a redirect rule |
 | [**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 |
+| [**delete_sfvb_secret_request**](SfvbApi.md#delete_sfvb_secret_request) | **DELETE** /sfvb/secrets/{request_id} | Cancel a pending secret request |
 | [**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 |
 | [**disable_sfvb_i18n_language**](SfvbApi.md#disable_sfvb_i18n_language) | **POST** /sfvb/storefronts/{storefront_oid}/i18n/languages/{code}/disable | Disable a language |
 | [**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 |
@@ -82,6 +83,9 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
 | [**get_sfvb_recording_settings**](SfvbApi.md#get_sfvb_recording_settings) | **GET** /sfvb/storefronts/{storefront_oid}/recording_settings | Get the storefront's screen recording settings |
 | [**get_sfvb_redirect**](SfvbApi.md#get_sfvb_redirect) | **GET** /sfvb/storefronts/{storefront_oid}/redirects/{redirect_id} | Read one redirect rule |
 | [**get_sfvb_redirects**](SfvbApi.md#get_sfvb_redirects) | **GET** /sfvb/storefronts/{storefront_oid}/redirects | List the storefront's redirect rules |
+| [**get_sfvb_secret_kinds**](SfvbApi.md#get_sfvb_secret_kinds) | **GET** /sfvb/secrets/kinds | List the secrets this server collects |
+| [**get_sfvb_secret_request**](SfvbApi.md#get_sfvb_secret_request) | **GET** /sfvb/secrets/{request_id} | Read one secret request |
+| [**get_sfvb_secret_requests**](SfvbApi.md#get_sfvb_secret_requests) | **GET** /sfvb/secrets | List this sign-in's secret requests |
 | [**get_sfvb_server_log**](SfvbApi.md#get_sfvb_server_log) | **GET** /sfvb/storefronts/{storefront_oid}/logs/{log_id} | Get one storefront render log |
 | [**get_sfvb_site_attributes**](SfvbApi.md#get_sfvb_site_attributes) | **GET** /sfvb/storefronts/{storefront_oid}/attributes | Read a storefront's site attributes |
 | [**get_sfvb_test_orders**](SfvbApi.md#get_sfvb_test_orders) | **GET** /sfvb/storefronts/{storefront_oid}/test_orders | List recent test orders |
@@ -98,6 +102,7 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
 | [**insert_sfvb_blog_post**](SfvbApi.md#insert_sfvb_blog_post) | **POST** /sfvb/storefronts/{storefront_oid}/blog_posts | Create a blog post |
 | [**insert_sfvb_page**](SfvbApi.md#insert_sfvb_page) | **POST** /sfvb/storefronts/{storefront_oid}/pages | Create a page |
 | [**insert_sfvb_redirect**](SfvbApi.md#insert_sfvb_redirect) | **POST** /sfvb/storefronts/{storefront_oid}/redirects | Create a 301 redirect rule |
+| [**insert_sfvb_secret_request**](SfvbApi.md#insert_sfvb_secret_request) | **POST** /sfvb/secrets | Ask a person to enter secret values |
 | [**insert_sfvb_upsell_offer**](SfvbApi.md#insert_sfvb_upsell_offer) | **POST** /sfvb/storefronts/{storefront_oid}/upsell_offers | Create an upsell offer |
 | [**insert_sfvb_upsell_path**](SfvbApi.md#insert_sfvb_upsell_path) | **POST** /sfvb/storefronts/{storefront_oid}/upsell_paths | Create an upsell path |
 | [**install_sfvb_library_entry**](SfvbApi.md#install_sfvb_library_entry) | **POST** /sfvb/storefronts/{storefront_oid}/library/{library_oid}/install | Install a library entry into a storefront |
@@ -127,6 +132,7 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
 | [**put_sfvb_item_attributes**](SfvbApi.md#put_sfvb_item_attributes) | **PUT** /sfvb/storefronts/{storefront_oid}/items/attributes | Change some of an item's attributes |
 | [**put_sfvb_item_content**](SfvbApi.md#put_sfvb_item_content) | **PUT** /sfvb/storefronts/{storefront_oid}/items/content | Change an item's title or long description |
 | [**put_sfvb_item_multimedia**](SfvbApi.md#put_sfvb_item_multimedia) | **PUT** /sfvb/storefronts/{storefront_oid}/items/multimedia | Attach an image to an item |
+| [**put_sfvb_item_multimedia_description**](SfvbApi.md#put_sfvb_item_multimedia_description) | **PUT** /sfvb/storefronts/{storefront_oid}/items/multimedia/description | Change an item image's description |
 | [**put_sfvb_item_pricing**](SfvbApi.md#put_sfvb_item_pricing) | **PUT** /sfvb/storefronts/{storefront_oid}/items/pricing | Change what an item charges |
 | [**put_sfvb_item_related**](SfvbApi.md#put_sfvb_item_related) | **PUT** /sfvb/storefronts/{storefront_oid}/items/related | Replace an item's related items |
 | [**put_sfvb_item_seo**](SfvbApi.md#put_sfvb_item_seo) | **PUT** /sfvb/storefronts/{storefront_oid}/items/seo | Change an item's search metadata |
@@ -149,6 +155,7 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
 | [**resolve_sfvb_template**](SfvbApi.md#resolve_sfvb_template) | **GET** /sfvb/storefronts/{storefront_oid}/templates/resolve | Resolve a template name to the file a page renders |
 | [**revert_sfvb_container**](SfvbApi.md#revert_sfvb_container) | **POST** /sfvb/storefronts/{storefront_oid}/containers/{owner_type}/{owner_object_id}/revert | Revert a container stored outside the file system |
 | [**revert_sfvb_file**](SfvbApi.md#revert_sfvb_file) | **POST** /sfvb/storefronts/{storefront_oid}/files/revert | Revert a storefront file to an earlier version |
+| [**revoke_sfvb_secret_request**](SfvbApi.md#revoke_sfvb_secret_request) | **POST** /sfvb/secrets/{request_id}/revoke | Revoke a fulfilled request's unused handles |
 | [**search_sfvb_files**](SfvbApi.md#search_sfvb_files) | **POST** /sfvb/storefronts/{storefront_oid}/files/search | Search storefront files |
 | [**search_sfvb_library**](SfvbApi.md#search_sfvb_library) | **GET** /sfvb/storefronts/{storefront_oid}/library | Search the element library |
 | [**set_sfvb_library_screenshot**](SfvbApi.md#set_sfvb_library_screenshot) | **PUT** /sfvb/storefronts/{storefront_oid}/library/{library_oid}/screenshot | Set a library entry's screenshot |
@@ -611,7 +618,7 @@ end
 
 One time link that opens a preview in a browser with no UltraCart login
 
-The preview URL only works in a browser already signed in to UltraCart on the storefront's own host, and an agent's built in browser never is.  This returns a single use access_url on the storefront host instead.  Opening it gets past the storefront lock, shows the requested theme and applies the requested preview session for the rest of that browser session, then redirects to path.  It expires two minutes after issue or on first use.  Pages opened afterwards carry an X-UltraCart-Preview header of applied or not-applied.  Requires a token that resolves to a user, so use the device authorization flow. 
+The preview URL only works in a browser already signed in to UltraCart on the storefront's own host, and an agent's built in browser never is.  This returns a single use access_url on the storefront host instead.  Opening it gets past the storefront lock, shows the requested theme and applies the requested preview session for the rest of that browser session, then redirects to path.  It expires two minutes after issue or on first use.  With a preview session, pages opened afterwards carry an X-UltraCart-Preview header of applied or not-applied.  Without one, the pages are the live content and carry no X-UltraCart-Preview header.  Requires a token that resolves to a user, so use the device authorization flow. 
 
 
 ### Examples
@@ -1264,6 +1271,59 @@ end
 - **Accept**: application/json
 
 
+## delete_sfvb_secret_request
+
+> <SfvbSecretRequest> delete_sfvb_secret_request(request_id)
+
+Cancel a pending secret request
+
+Withdraws a request nobody has filled in yet, with its handles, which frees one of the five pending slots a sign-in has.  A fulfilled request cannot be cancelled; revoke its handles instead. 
+
+
+### Examples
+
+
+(No example for this operation).
+
+
+#### Using the delete_sfvb_secret_request_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<SfvbSecretRequest>, Integer, Hash)> delete_sfvb_secret_request_with_http_info(request_id)
+
+```ruby
+begin
+  # Cancel a pending secret request
+  data, status_code, headers = api_instance.delete_sfvb_secret_request_with_http_info(request_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <SfvbSecretRequest>
+rescue UltracartClient::ApiError => e
+  puts "Error when calling SfvbApi->delete_sfvb_secret_request_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **request_id** | **String** |  |  |
+
+### Return type
+
+[**SfvbSecretRequest**](SfvbSecretRequest.md)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
 ## detach_sfvb_blog_post_image
 
 > <SfvbBlogPostDetail> detach_sfvb_blog_post_image(storefront_oid, blog_post_oid, blog_post_image_request)
@@ -4417,6 +4477,161 @@ end
 - **Accept**: application/json
 
 
+## get_sfvb_secret_kinds
+
+> <SfvbSecretKindsResponse> get_sfvb_secret_kinds
+
+List the secrets this server collects
+
+The kinds of secret value, with what each looks like, and the secret fields (sinks) a handle can be written to.  Request a handle for a sink with POST secrets. 
+
+
+### Examples
+
+
+(No example for this operation).
+
+
+#### Using the get_sfvb_secret_kinds_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<SfvbSecretKindsResponse>, Integer, Hash)> get_sfvb_secret_kinds_with_http_info
+
+```ruby
+begin
+  # List the secrets this server collects
+  data, status_code, headers = api_instance.get_sfvb_secret_kinds_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <SfvbSecretKindsResponse>
+rescue UltracartClient::ApiError => e
+  puts "Error when calling SfvbApi->get_sfvb_secret_kinds_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**SfvbSecretKindsResponse**](SfvbSecretKindsResponse.md)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_sfvb_secret_request
+
+> <SfvbSecretRequest> get_sfvb_secret_request(request_id)
+
+Read one secret request
+
+Poll this every interval_seconds after making a request.  status is pending until a person enters the values, then fulfilled, and expired if nobody does within 24 hours.  handles lists each handle with its own status, and a fingerprint (the last few characters as a mask shows them) once its value is entered.  Never a value. 
+
+
+### Examples
+
+
+(No example for this operation).
+
+
+#### Using the get_sfvb_secret_request_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<SfvbSecretRequest>, Integer, Hash)> get_sfvb_secret_request_with_http_info(request_id)
+
+```ruby
+begin
+  # Read one secret request
+  data, status_code, headers = api_instance.get_sfvb_secret_request_with_http_info(request_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <SfvbSecretRequest>
+rescue UltracartClient::ApiError => e
+  puts "Error when calling SfvbApi->get_sfvb_secret_request_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **request_id** | **String** |  |  |
+
+### Return type
+
+[**SfvbSecretRequest**](SfvbSecretRequest.md)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_sfvb_secret_requests
+
+> <SfvbSecretRequestsResponse> get_sfvb_secret_requests
+
+List this sign-in's secret requests
+
+Requests made with this sign-in in the last 24 hours, newest first, at most 50, without their handles.  Read one request for its handles. 
+
+
+### Examples
+
+
+(No example for this operation).
+
+
+#### Using the get_sfvb_secret_requests_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<SfvbSecretRequestsResponse>, Integer, Hash)> get_sfvb_secret_requests_with_http_info
+
+```ruby
+begin
+  # List this sign-in's secret requests
+  data, status_code, headers = api_instance.get_sfvb_secret_requests_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <SfvbSecretRequestsResponse>
+rescue UltracartClient::ApiError => e
+  puts "Error when calling SfvbApi->get_sfvb_secret_requests_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**SfvbSecretRequestsResponse**](SfvbSecretRequestsResponse.md)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
 ## get_sfvb_server_log
 
 > <SfvbServerLogDetail> get_sfvb_server_log(storefront_oid, log_id, opts)
@@ -5283,6 +5498,59 @@ end
 - **Accept**: application/json
 
 
+## insert_sfvb_secret_request
+
+> <SfvbSecretRequest> insert_sfvb_secret_request(secret_request)
+
+Ask a person to enter secret values
+
+Never ask for a credential in the conversation.  This makes a handle for each sink (and each key, for a bulk request) at once, pending until a person enters the values on request_url.  Show the person request_url and user_code and never open or fill in the page yourself.  Poll GET secrets/{request_id} every interval_seconds until status is fulfilled, then send each handle in its secret field.  The server writes the value in its place.  A handle works only for this sign-in, its sink and its target, for ttl_seconds and uses writes.  A request lapses after 24 hours, and shares the five pending requests a sign-in has with approvals.  Asking again for the same thing returns the pending request (200) rather than a new one (201).  Requires a token that resolves to a user, so use the device authorization flow.  A secret request is never an approval. 
+
+
+### Examples
+
+
+(No example for this operation).
+
+
+#### Using the insert_sfvb_secret_request_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<SfvbSecretRequest>, Integer, Hash)> insert_sfvb_secret_request_with_http_info(secret_request)
+
+```ruby
+begin
+  # Ask a person to enter secret values
+  data, status_code, headers = api_instance.insert_sfvb_secret_request_with_http_info(secret_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <SfvbSecretRequest>
+rescue UltracartClient::ApiError => e
+  puts "Error when calling SfvbApi->insert_sfvb_secret_request_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **secret_request** | [**SfvbSecretRequestCreate**](SfvbSecretRequestCreate.md) | The request |  |
+
+### Return type
+
+[**SfvbSecretRequest**](SfvbSecretRequest.md)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: application/json; charset=UTF-8
+- **Accept**: application/json
+
+
 ## insert_sfvb_upsell_offer
 
 > <SfvbUpsellOffer> insert_sfvb_upsell_offer(storefront_oid, upsell_offer)
@@ -6894,6 +7162,62 @@ end
 - **Accept**: application/json
 
 
+## put_sfvb_item_multimedia_description
+
+> <SfvbItemResponse> put_sfvb_item_multimedia_description(storefront_oid, item_multimedia_description_request, opts)
+
+Change an item image's description
+
+Changes the description (alt text) of one image already attached to the item, in place.  The image is not touched.  Name it by merchant_item_multimedia_oid, or by exactly one of code or default; gallery images often have no code.  An empty description clears it, so the render falls back again.  Send the description_sha256 you read as current_sha256 so a change made since is not overwritten.  A description written here takes the place of the machine description, and image recognition never overwrites it. 
+
+
+### Examples
+
+
+(No example for this operation).
+
+
+#### Using the put_sfvb_item_multimedia_description_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<SfvbItemResponse>, Integer, Hash)> put_sfvb_item_multimedia_description_with_http_info(storefront_oid, item_multimedia_description_request, opts)
+
+```ruby
+begin
+  # Change an item image's description
+  data, status_code, headers = api_instance.put_sfvb_item_multimedia_description_with_http_info(storefront_oid, item_multimedia_description_request, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <SfvbItemResponse>
+rescue UltracartClient::ApiError => e
+  puts "Error when calling SfvbApi->put_sfvb_item_multimedia_description_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **storefront_oid** | **Integer** |  |  |
+| **item_multimedia_description_request** | [**SfvbItemMultimediaDescriptionRequest**](SfvbItemMultimediaDescriptionRequest.md) | The image and its new description |  |
+| **merchant_item_id** | **String** |  | [optional] |
+| **merchant_item_oid** | **Integer** |  | [optional] |
+
+### Return type
+
+[**SfvbItemResponse**](SfvbItemResponse.md)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
 ## put_sfvb_item_pricing
 
 > <SfvbItemPricing> put_sfvb_item_pricing(storefront_oid, if_match, item_pricing_request, opts)
@@ -8112,6 +8436,59 @@ end
 - **Accept**: application/json
 
 
+## revoke_sfvb_secret_request
+
+> <SfvbSecretRequest> revoke_sfvb_secret_request(request_id)
+
+Revoke a fulfilled request's unused handles
+
+Every handle of the request that no write has used up stops working at once, and its value is deleted.  A handle a write is using right now is left to that write.  Use it when the plan changed, or a handle may have leaked. 
+
+
+### Examples
+
+
+(No example for this operation).
+
+
+#### Using the revoke_sfvb_secret_request_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<SfvbSecretRequest>, Integer, Hash)> revoke_sfvb_secret_request_with_http_info(request_id)
+
+```ruby
+begin
+  # Revoke a fulfilled request's unused handles
+  data, status_code, headers = api_instance.revoke_sfvb_secret_request_with_http_info(request_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <SfvbSecretRequest>
+rescue UltracartClient::ApiError => e
+  puts "Error when calling SfvbApi->revoke_sfvb_secret_request_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **request_id** | **String** |  |  |
+
+### Return type
+
+[**SfvbSecretRequest**](SfvbSecretRequest.md)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
 ## search_sfvb_files
 
 > <SfvbFileSearchResponse> search_sfvb_files(storefront_oid, search_request)

data/docs/SfvbEvent.md

@@ -7,9 +7,9 @@
 | **event_dts** | **String** | When it happened, ISO 8601. | [optional] |
 | **event_id** | **String** | Time-ordered id.  Pass the last one seen as after to replay what came since. | [optional] |
 | **object_id** | **String** | The id of what changed, such as the approval_id. | [optional] |
-| **object_type** | **String** | What changed, such as approval. | [optional] |
+| **object_type** | **String** | What changed, such as approval or secret_sink. | [optional] |
 | **storefront_oid** | **Integer** | The storefront it concerns.  Empty for merchant-level objects. | [optional] |
-| **type** | **String** | approval.decided (approved, denied, cancelled or refused by the script review) or approval.ready (the review finished and the person can decide). | [optional] |
+| **type** | **String** | approval.decided (approved, denied, cancelled or refused by the script review), approval.ready (the review finished and the person can decide) or secret_sink.completed (a person entered the values of a secret request; object_id is the request id). | [optional] |
 
 ## Example
 

data/docs/SfvbItemMultimedia.md

@@ -7,10 +7,14 @@
 | **code** | **String** | The image code, which is what an itemimage element's itemImageCode refers to.  Empty for the default image. | [optional] |
 | **declared** | **Boolean** | True when a template declares this code.  A slot that is attached but not declared is an image nothing on the page is asking for. | [optional] |
 | **default** | **Boolean** | True for the image an itemimage element with no code renders.  Default is per media type, so an item may have one default image and one default PDF at the same time. | [optional] |
-| **description** | **String** | Stored with the image and rendered as its alt text.  When it is empty the render falls back to the item's own description, so an empty value here is not an empty alt attribute. | [optional] |
+| **description** | **String** | The merchant's description, stored with the image and rendered as its alt text.  When it is empty the render falls back to rekognition_description or to text built from the item's title, depending on the element, so an empty value here is not an empty alt attribute. | [optional] |
+| **description_sha256** | **String** | SHA-256 of description (empty when there is none).  Send it as current_sha256 when changing the description so a change made since you read it is not overwritten. | [optional] |
+| **description_source** | **String** | Where the alt text comes from now.  merchant when description is set, rekognition when only rekognition_description is, none otherwise. | [optional] |
 | **dimensions** | **String** | Width x height in pixels, when the storage measured the file. | [optional] |
 | **exclude_from_gallery** | **Boolean** | True when the storage marks this image as kept out of the item gallery. | [optional] |
 | **filename** | **String** | The stored file's name.  Empty when the slot is declared and nothing is attached. | [optional] |
+| **merchant_item_multimedia_oid** | **Integer** | The stored image's id.  Name it to change this image's description when it has no code. | [optional] |
+| **rekognition_description** | **String** | The machine description image recognition produced for the stored image, if any.  It is used only while description is empty, and a description written here or in the admin always takes its place. | [optional] |
 | **type** | **String** | The media type the storage recorded. | [optional] |
 | **view_url** | **String** | Where the stored image is served.  Absent when nothing is attached to the slot. | [optional] |
 
@@ -24,9 +28,13 @@ instance = UltracartClient::SfvbItemMultimedia.new(
   declared: null,
   default: null,
   description: null,
+  description_sha256: null,
+  description_source: null,
   dimensions: null,
   exclude_from_gallery: null,
   filename: null,
+  merchant_item_multimedia_oid: null,
+  rekognition_description: null,
   type: null,
   view_url: null
 )

data/docs/SfvbItemMultimediaDescriptionRequest.md

@@ -0,0 +1,26 @@
+# UltracartClient::SfvbItemMultimediaDescriptionRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **code** | **String** | The image code, the value an itemimage element's itemImageCode names. | [optional] |
+| **current_sha256** | **String** | The description_sha256 you read.  When it is sent and the description has changed since, nothing is written and the call fails with a version conflict. | [optional] |
+| **default** | **Boolean** | The item's default image, which an itemimage element with no code renders. | [optional] |
+| **description** | **String** | The new description, rendered as the image's alt text.  An empty string clears it, so the image falls back to the machine description or the element's own fallback.  Longer text is cut to 500 characters. | [optional] |
+| **merchant_item_multimedia_oid** | **Integer** | The stored image's id, as an item read reports it.  Name this, or one of code or default. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbItemMultimediaDescriptionRequest.new(
+  code: null,
+  current_sha256: null,
+  default: null,
+  description: null,
+  merchant_item_multimedia_oid: null
+)
+```
+