ultracart_api 4.1.202 → 4.1.203

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c8e2a0df2a48694c297eccac324214153614a364647f403482a52863732a8d42
-  data.tar.gz: 6391ca2c7f7f14054a3c351fb22165e8e8f793c0685af64e4deefd5c33dd3928
+  metadata.gz: 00666a9bf01ef4230812762f575d67f10482bba350bd40952ba485c405ebde29
+  data.tar.gz: b2a50501d6cad4f28cb8f98beaeb379f19df30d8185bfad75d7775ffd5478205
 SHA512:
-  metadata.gz: d2f086140b99df10e1fc950f74e5bb323b83289356a330c6ea78499c271c73a5a1b1085ae108a30d1a089c622ed65cde9fbf170521c97a91cbd2ee853f5e6ac3
-  data.tar.gz: 53ec4581fefb66a0b5021744599a789c9e4e634b9b017b4dd1980e118ee46fabaf7f31272e815ca39e06fd7369eadd8f2df00acd0b861f59fb84c9898bb51d25
+  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.202
+- 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.202'
+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
@@ -622,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
@@ -2037,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)
@@ -2252,6 +2265,7 @@ 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 |

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 |
@@ -150,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 |
@@ -612,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
@@ -1265,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)
@@ -4418,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)
@@ -5284,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)
@@ -8169,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/SfvbSecretHandle.md

@@ -0,0 +1,32 @@
+# UltracartClient::SfvbSecretHandle
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **expires_at** | **String** | When it stops being usable, ISO 8601 UTC. | [optional] |
+| **fingerprint** | **String** | The last few characters of the value, as a mask shows them, so the person can tell values apart.  Empty until entered. | [optional] |
+| **handle** | **String** | The handle.  Safe to log and keep in plans.  It works only for the sign-in that requested it. | [optional] |
+| **key** | **String** | The bulk key it is for, or empty. | [optional] |
+| **sink** | **String** | The secret field it can be written to. | [optional] |
+| **status** | **String** | pending (no value yet), ready, in_use (a write holds it), consumed, revoked or expired. | [optional] |
+| **target_id** | **String** | The object it can be written to, or empty when the request named none. | [optional] |
+| **uses_left** | **Integer** | Writes left.  Empty once the handle is gone. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbSecretHandle.new(
+  expires_at: null,
+  fingerprint: null,
+  handle: null,
+  key: null,
+  sink: null,
+  status: null,
+  target_id: null,
+  uses_left: null
+)
+```
+

data/docs/SfvbSecretKind.md

@@ -0,0 +1,30 @@
+# UltracartClient::SfvbSecretKind
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **description** | **String** | Where the value comes from. | [optional] |
+| **format_hint** | **String** | What the value looks like.  The request page checks it as it is typed, and the server again. | [optional] |
+| **id** | **String** | The kind id. | [optional] |
+| **label** | **String** | What the person is told they are entering. | [optional] |
+| **mask_suffix** | **Integer** | How many trailing characters a mask shows at most. | [optional] |
+| **max_length** | **Integer** | Longest value accepted. | [optional] |
+| **min_length** | **Integer** | Shortest value accepted, after surrounding whitespace is removed. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbSecretKind.new(
+  description: null,
+  format_hint: null,
+  id: null,
+  label: null,
+  mask_suffix: null,
+  max_length: null,
+  min_length: null
+)
+```
+

data/docs/SfvbSecretKindsResponse.md

@@ -0,0 +1,20 @@
+# UltracartClient::SfvbSecretKindsResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **kinds** | [**Array<SfvbSecretKind>**](SfvbSecretKind.md) | Every kind of secret this server collects. | [optional] |
+| **sinks** | [**Array<SfvbSecretSink>**](SfvbSecretSink.md) | Every secret field a handle can be written to. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbSecretKindsResponse.new(
+  kinds: null,
+  sinks: null
+)
+```
+

data/docs/SfvbSecretRequest.md

@@ -0,0 +1,54 @@
+# UltracartClient::SfvbSecretRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **created_at** | **String** | When the request was made, ISO 8601 UTC. | [optional] |
+| **delegated** | **Boolean** | True when the requester handed it to a colleague to fill in. | [optional] |
+| **description** | **String** | The sentence the person reads.  Written by the server, not the agent. | [optional] |
+| **expires_at** | **String** | When a pending request lapses, ISO 8601 UTC. | [optional] |
+| **expires_in_seconds** | **Integer** | Seconds until expires_at.  Zero once passed. | [optional] |
+| **fulfilled_at** | **String** | When the values were entered, ISO 8601 UTC. | [optional] |
+| **handle_count** | **Integer** | How many handles the request made. | [optional] |
+| **handles** | [**Array<SfvbSecretHandle>**](SfvbSecretHandle.md) | Every handle with its status.  Left out of the list endpoint; read one request for them. | [optional] |
+| **interval_seconds** | **Integer** | Poll no more often than this. | [optional] |
+| **keys** | **Array<String>** | The bulk keys, or empty. | [optional] |
+| **label** | **String** | The label the agent sent, as stored and shown. | [optional] |
+| **reason** | **String** | The reason the agent sent, as stored and shown. | [optional] |
+| **request_id** | **String** | The request id. | [optional] |
+| **request_url** | **String** | The page where the person enters the values.  Show it to them.  Never open or fill it in yourself. | [optional] |
+| **requires_totp** | **Boolean** | True when the person must enter a code from their authenticator app. | [optional] |
+| **sinks** | **Array<String>** | The secret fields being collected. | [optional] |
+| **status** | **String** | pending, fulfilled, cancelled or expired. | [optional] |
+| **target_id** | **String** | The object the values are for, or empty for a bulk request or an open one. | [optional] |
+| **user_code** | **String** | Short matching code.  Print it next to request_url so the person can check the page shows the same code. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbSecretRequest.new(
+  created_at: null,
+  delegated: null,
+  description: null,
+  expires_at: null,
+  expires_in_seconds: null,
+  fulfilled_at: null,
+  handle_count: null,
+  handles: null,
+  interval_seconds: null,
+  keys: null,
+  label: null,
+  reason: null,
+  request_id: null,
+  request_url: null,
+  requires_totp: null,
+  sinks: null,
+  status: null,
+  target_id: null,
+  user_code: null
+)
+```
+

data/docs/SfvbSecretRequestCreate.md

@@ -0,0 +1,30 @@
+# UltracartClient::SfvbSecretRequestCreate
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **keys** | **Array<String>** | Bulk.  One handle per key and sink, and each key is that handle's target, such as one sending domain per key.  At most 500 handles in all. | [optional] |
+| **label** | **String** | A short name the person sees, marked as unverified.  At most 120 characters. | [optional] |
+| **reason** | **String** | Why the agent needs it.  Shown to the person, marked as unverified.  At most 500 characters. | [optional] |
+| **sinks** | **Array<String>** | The secret fields to collect, by sink id.  GET secrets/kinds lists them.  All must take the same kind of target. | [optional] |
+| **target_id** | **String** | The object the values are for, such as a Twilio account uuid.  Required for sinks that need an authenticator code, unless keys names the targets.  Leave it out when keys is sent. | [optional] |
+| **ttl_seconds** | **Integer** | How long each handle stays usable once the values are entered.  60 to 86400, default 3600. | [optional] |
+| **uses** | **Integer** | How many writes each handle may make.  1 to 100, default 1. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbSecretRequestCreate.new(
+  keys: null,
+  label: null,
+  reason: null,
+  sinks: null,
+  target_id: null,
+  ttl_seconds: null,
+  uses: null
+)
+```
+