ultracart_api 4.1.209 → 4.1.211

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e0c962b8931e0142a262e884bb6d133b3d99a87b303518b9dae0ca640a41819b
-  data.tar.gz: 2ae7fa35c9b3393aa512a70866239cc71481b84a86f28a5d4ef470be04cb349f
+  metadata.gz: 433a8aaea315101666d5b31ee8a8983cb95241f2421824d42d069e463e3cc94c
+  data.tar.gz: 90123646be6a6a72b2dbf8024107caf6d62b5881b6893e4f70f80e9ed2f3e116
 SHA512:
-  metadata.gz: c93fcf30f8484e75e27bfb3598ff5f92ef16618710fd5b94a6d653b3c73afc57b156d640dd197d5c9aeda21b0a14efb62bf16c892a3e4b9ec5bdaf0148e41f20
-  data.tar.gz: 6daf4f903bf2d574f2250efba9aefd9b5b866c0af8d4dd69789e9b80a5a709be7563247d4be5e4d075c4f82357f801e6ea336c4538c5958fefa6f28bb33e24a0
+  metadata.gz: e83035d699791416639d17e2443643057d38fc5b6bd6cce8b5dd5432afad09d2d06152f0b4c91909a5d98836ee8e1713ba1bdd7650ca8869ede586dccffdd46a
+  data.tar.gz: c74ca1fc0536aafdfc8010cc1055fce1464b8b965b73930d1f5fd1a68c5465a93a3dfbc3e51a10807fe5b239535f2fcfbdb625f4b185813ea285f35b27c6c3b2

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.209
+- Package version: 4.1.211
 - 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.209'
+gem 'ultracart_api', '4.1.211'
 ```
 
 install:
@@ -572,6 +572,7 @@ Class | Method | HTTP request | Description
 *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_sequence**](docs/SfvbApi.md#get_sfvb_sequence) | **GET** /sfvb/storefronts/{storefront_oid}/sequences/{sequence_uuid} | Get a campaign's or flow's steps as a tree
 *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
@@ -651,6 +652,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* | [**review_sfvb_email**](docs/SfvbApi.md#review_sfvb_email) | **POST** /sfvb/storefronts/{storefront_oid}/emails/{email_uuid}/review | Request a content review of a flow or campaign email
 *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
@@ -1945,6 +1947,7 @@ Class | Method | HTTP request | Description
  - [UltracartClient::SfvbEmail](docs/SfvbEmail.md)
  - [UltracartClient::SfvbEmailRenderRequest](docs/SfvbEmailRenderRequest.md)
  - [UltracartClient::SfvbEmailRenderResponse](docs/SfvbEmailRenderResponse.md)
+ - [UltracartClient::SfvbEmailReviewRequest](docs/SfvbEmailReviewRequest.md)
  - [UltracartClient::SfvbEmailUpdateRequest](docs/SfvbEmailUpdateRequest.md)
  - [UltracartClient::SfvbErrorDetail](docs/SfvbErrorDetail.md)
  - [UltracartClient::SfvbEvent](docs/SfvbEvent.md)
@@ -2104,6 +2107,9 @@ Class | Method | HTTP request | Description
  - [UltracartClient::SfvbSecretRequestCreate](docs/SfvbSecretRequestCreate.md)
  - [UltracartClient::SfvbSecretRequestsResponse](docs/SfvbSecretRequestsResponse.md)
  - [UltracartClient::SfvbSecretSink](docs/SfvbSecretSink.md)
+ - [UltracartClient::SfvbSequence](docs/SfvbSequence.md)
+ - [UltracartClient::SfvbSequenceBranch](docs/SfvbSequenceBranch.md)
+ - [UltracartClient::SfvbSequenceStep](docs/SfvbSequenceStep.md)
  - [UltracartClient::SfvbServerLog](docs/SfvbServerLog.md)
  - [UltracartClient::SfvbServerLogDetail](docs/SfvbServerLogDetail.md)
  - [UltracartClient::SfvbServerLogEntry](docs/SfvbServerLogEntry.md)
@@ -2321,6 +2327,8 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 4.1.211 | 10/27/2026 | sfvb internal testing |
+| 4.1.210 | 10/27/2026 | sfvb internal testing |
 | 4.1.209 | 10/27/2026 | sfvb internal testing |
 | 4.1.208 | 10/26/2026 | sfvb internal testing |
 | 4.1.207 | 10/16/2026 | sfvb internal testing |

data/docs/SfvbApi.md

@@ -100,6 +100,7 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
 | [**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_sequence**](SfvbApi.md#get_sfvb_sequence) | **GET** /sfvb/storefronts/{storefront_oid}/sequences/{sequence_uuid} | Get a campaign's or flow's steps as a tree |
 | [**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 |
@@ -179,6 +180,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 |
+| [**review_sfvb_email**](SfvbApi.md#review_sfvb_email) | **POST** /sfvb/storefronts/{storefront_oid}/emails/{email_uuid}/review | Request a content review of a flow or campaign email |
 | [**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 |
@@ -5414,6 +5416,61 @@ This endpoint does not need any parameter.
 - **Accept**: application/json
 
 
+## get_sfvb_sequence
+
+> <SfvbSequence> get_sfvb_sequence(storefront_oid, sequence_uuid, opts)
+
+Get a campaign's or flow's steps as a tree
+
+The communication sequence named by a campaign's or flow's communication_sequence_uuid, with its steps from the start in order.  Only condition, split and InboxGeek steps branch, and each holds its two sides in branches.  Each step has its type, the admin's label, its settings (a webhook's header and parameter values masked), its audience filter, and the emails, postcard, lists or items it names.  waiting adds how many customers are waiting on each step now.  Read only. 
+
+
+### Examples
+
+
+(No example for this operation).
+
+
+#### Using the get_sfvb_sequence_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<SfvbSequence>, Integer, Hash)> get_sfvb_sequence_with_http_info(storefront_oid, sequence_uuid, opts)
+
+```ruby
+begin
+  # Get a campaign's or flow's steps as a tree
+  data, status_code, headers = api_instance.get_sfvb_sequence_with_http_info(storefront_oid, sequence_uuid, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <SfvbSequence>
+rescue UltracartClient::ApiError => e
+  puts "Error when calling SfvbApi->get_sfvb_sequence_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **storefront_oid** | **Integer** |  |  |
+| **sequence_uuid** | **String** |  |  |
+| **waiting** | **Boolean** | Include how many customers are waiting on each step | [optional] |
+
+### Return type
+
+[**SfvbSequence**](SfvbSequence.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)
@@ -9760,6 +9817,61 @@ end
 - **Accept**: application/json
 
 
+## review_sfvb_email
+
+> <SfvbEmail> review_sfvb_email(storefront_oid, email_uuid, email_review_request)
+
+Request a content review of a flow or campaign email
+
+Starts a review the way the admin's Request Review does.  One test copy of the email goes to the signed-in user, and to no one else, and the review runs in the background, so read the email again for pending_review and then the ruling.  Refused with sfvb.review_not_needed when it doesn't need review, is already waiting for one, or was rejected and not changed since.  An email in a flow triggered by an order or an auto order needs order_id, a test order.  Needs a signed-in user, not an API key alone. 
+
+
+### Examples
+
+
+(No example for this operation).
+
+
+#### Using the review_sfvb_email_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<SfvbEmail>, Integer, Hash)> review_sfvb_email_with_http_info(storefront_oid, email_uuid, email_review_request)
+
+```ruby
+begin
+  # Request a content review of a flow or campaign email
+  data, status_code, headers = api_instance.review_sfvb_email_with_http_info(storefront_oid, email_uuid, email_review_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <SfvbEmail>
+rescue UltracartClient::ApiError => e
+  puts "Error when calling SfvbApi->review_sfvb_email_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **storefront_oid** | **Integer** |  |  |
+| **email_uuid** | **String** |  |  |
+| **email_review_request** | [**SfvbEmailReviewRequest**](SfvbEmailReviewRequest.md) | The test order, for an email in an order-triggered flow |  |
+
+### Return type
+
+[**SfvbEmail**](SfvbEmail.md)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
 ## revoke_sfvb_secret_request
 
 > <SfvbSecretRequest> revoke_sfvb_secret_request(request_id)

data/docs/SfvbEmail.md

@@ -8,6 +8,7 @@
 | **email_uuid** | **String** | The email uuid.  The same uuid the email container (owner type email) and the email render take. | [optional] |
 | **hash_sha256** | **String** | Hash of the subject and preview text.  Send it as If-Match when updating.  A change to the email body does not change it. | [optional] |
 | **live** | **Boolean** | True when the email is in a flow or campaign that is sending, so a change reaches customers and needs sfvb_publish.  An email in neither is reported live. | [optional] |
+| **notes** | **Array<String>** | What a write did beyond the fields asked for, such as a step label it could not refresh.  Only on a write. | [optional] |
 | **pending_review** | **Boolean** | True while a change waits for review.  An edit puts it back to needing review. | [optional] |
 | **preview_text** | **String** | The preview text an inbox shows after the subject. | [optional] |
 | **rejected** | **Boolean** | True when review rejected the email.  An edit puts it back to needing review. | [optional] |
@@ -27,6 +28,7 @@ instance = UltracartClient::SfvbEmail.new(
   email_uuid: null,
   hash_sha256: null,
   live: null,
+  notes: null,
   pending_review: null,
   preview_text: null,
   rejected: null,

data/docs/SfvbEmailReviewRequest.md

@@ -0,0 +1,18 @@
+# UltracartClient::SfvbEmailReviewRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **order_id** | **String** | A test order id.  Required for an email in a flow triggered by an order or an auto order, and refused otherwise. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbEmailReviewRequest.new(
+  order_id: null
+)
+```
+

data/docs/SfvbSequence.md

@@ -0,0 +1,34 @@
+# UltracartClient::SfvbSequence
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **communication_sequence_uuid** | **String** | The sequence uuid. | [optional] |
+| **live** | **Boolean** | True when its emails and postcards reach customers now. | [optional] |
+| **notes** | **Array<String>** | Anything the read could not do, such as waiting counts that were unavailable. | [optional] |
+| **owner_name** | **String** | The campaign or flow name. | [optional] |
+| **owner_status** | **String** | The campaign or flow status. | [optional] |
+| **owner_type** | **String** | campaign or flow. | [optional] |
+| **owner_uuid** | **String** | The campaign or flow uuid. | [optional] |
+| **steps** | [**Array<SfvbSequenceStep>**](SfvbSequenceStep.md) | The steps from the start, in order.  A branching step holds its sides in branches. | [optional] |
+| **waiting_included** | **Boolean** | True when number_waiting was filled in. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbSequence.new(
+  communication_sequence_uuid: null,
+  live: null,
+  notes: null,
+  owner_name: null,
+  owner_status: null,
+  owner_type: null,
+  owner_uuid: null,
+  steps: null,
+  waiting_included: null
+)
+```
+

data/docs/SfvbSequenceBranch.md

@@ -0,0 +1,20 @@
+# UltracartClient::SfvbSequenceBranch
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **label** | **String** | yes or no for a condition, left or right for a split or an InboxGeek step. | [optional] |
+| **steps** | [**Array<SfvbSequenceStep>**](SfvbSequenceStep.md) | The steps on this side, in order. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbSequenceBranch.new(
+  label: null,
+  steps: null
+)
+```
+

data/docs/SfvbSequenceStep.md

@@ -0,0 +1,50 @@
+# UltracartClient::SfvbSequenceStep
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **branches** | [**Array<SfvbSequenceBranch>**](SfvbSequenceBranch.md) | Its two sides, for a condition, split or InboxGeek step.  Absent for every other type. | [optional] |
+| **config_error** | **Boolean** | True when the step's settings could not be read. | [optional] |
+| **config_json** | **String** | The step's settings as the admin stores them.  A webhook's header and parameter values are masked. | [optional] |
+| **config_merchant_notes** | **String** | A note stored inside the step's settings, when there is one. | [optional] |
+| **disabled** | **Boolean** | True when the step is switched off in its settings. | [optional] |
+| **email_uuids** | **Array<String>** | The emails it sends.  One for an email step, one per variant for an experiment. | [optional] |
+| **filter_profile_equation_json** | **String** | The step's audience filter as stored, when it has one. | [optional] |
+| **item_ids** | **Array<String>** | The items it names, for a cart or rate limiter step. | [optional] |
+| **label** | **String** | The type as the admin names it, such as Time Delay.  The type itself for one it doesn't know. | [optional] |
+| **list_uuids** | **Array<String>** | The lists it subscribes or unsubscribes, for a list step. | [optional] |
+| **merchant_notes** | **String** | The note stored on the step. | [optional] |
+| **name** | **String** | The step's own display name from its settings, when it has one. | [optional] |
+| **number_waiting** | **Integer** | How many customers are waiting on this step now.  Only when waiting counts were asked for. | [optional] |
+| **postcard_uuid** | **String** | The postcard it sends, for a postcard step. | [optional] |
+| **step_uuid** | **String** | The step uuid. | [optional] |
+| **type** | **String** | The step type, such as email, wait, condition or webhook. | [optional] |
+| **unreachable** | **Boolean** | True for a step no branch leads to.  Listed at the end so nothing is hidden. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbSequenceStep.new(
+  branches: null,
+  config_error: null,
+  config_json: null,
+  config_merchant_notes: null,
+  disabled: null,
+  email_uuids: null,
+  filter_profile_equation_json: null,
+  item_ids: null,
+  label: null,
+  list_uuids: null,
+  merchant_notes: null,
+  name: null,
+  number_waiting: null,
+  postcard_uuid: null,
+  step_uuid: null,
+  type: null,
+  unreachable: null
+)
+```
+

data/lib/ultracart_api/api/sfvb_api.rb

@@ -6886,6 +6886,79 @@ module UltracartClient
       return data, status_code, headers
     end
 
+    # Get a campaign's or flow's steps as a tree
+    # The communication sequence named by a campaign's or flow's communication_sequence_uuid, with its steps from the start in order.  Only condition, split and InboxGeek steps branch, and each holds its two sides in branches.  Each step has its type, the admin's label, its settings (a webhook's header and parameter values masked), its audience filter, and the emails, postcard, lists or items it names.  waiting adds how many customers are waiting on each step now.  Read only. 
+    # @param storefront_oid [Integer] 
+    # @param sequence_uuid [String] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [Boolean] :waiting Include how many customers are waiting on each step
+    # @return [SfvbSequence]
+    def get_sfvb_sequence(storefront_oid, sequence_uuid, opts = {})
+      data, _status_code, _headers = get_sfvb_sequence_with_http_info(storefront_oid, sequence_uuid, opts)
+      data
+    end
+
+    # Get a campaign's or flow's steps as a tree
+    # The communication sequence named by a campaign's or flow's communication_sequence_uuid, with its steps from the start in order.  Only condition, split and InboxGeek steps branch, and each holds its two sides in branches.  Each step has its type, the admin's label, its settings (a webhook's header and parameter values masked), its audience filter, and the emails, postcard, lists or items it names.  waiting adds how many customers are waiting on each step now.  Read only. 
+    # @param storefront_oid [Integer] 
+    # @param sequence_uuid [String] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [Boolean] :waiting Include how many customers are waiting on each step
+    # @return [Array<(SfvbSequence, Integer, Hash)>] SfvbSequence data, response status code and response headers
+    def get_sfvb_sequence_with_http_info(storefront_oid, sequence_uuid, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: SfvbApi.get_sfvb_sequence ...'
+      end
+      # verify the required parameter 'storefront_oid' is set
+      if @api_client.config.client_side_validation && storefront_oid.nil?
+        fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling SfvbApi.get_sfvb_sequence"
+      end
+      # verify the required parameter 'sequence_uuid' is set
+      if @api_client.config.client_side_validation && sequence_uuid.nil?
+        fail ArgumentError, "Missing the required parameter 'sequence_uuid' when calling SfvbApi.get_sfvb_sequence"
+      end
+      # resource path
+      local_var_path = '/sfvb/storefronts/{storefront_oid}/sequences/{sequence_uuid}'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s)).sub('{' + 'sequence_uuid' + '}', CGI.escape(sequence_uuid.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'waiting'] = opts[:'waiting'] if !opts[:'waiting'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'SfvbSequence'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
+
+      new_options = opts.merge(
+        :operation => :"SfvbApi.get_sfvb_sequence",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: SfvbApi#get_sfvb_sequence\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Get one storefront render log
     # One render's server log with its lines, each with a level, a category such as VELOCITY or FLOW, and the message.  log_id comes from the list, or from the X-UltraCart-Storefront-Log-Id header a page sends inside an SFVB preview session.  min_level is debug, info, warn or error, default debug. 
     # @param storefront_oid [Integer] 
@@ -12883,6 +12956,87 @@ module UltracartClient
       return data, status_code, headers
     end
 
+    # Request a content review of a flow or campaign email
+    # Starts a review the way the admin's Request Review does.  One test copy of the email goes to the signed-in user, and to no one else, and the review runs in the background, so read the email again for pending_review and then the ruling.  Refused with sfvb.review_not_needed when it doesn't need review, is already waiting for one, or was rejected and not changed since.  An email in a flow triggered by an order or an auto order needs order_id, a test order.  Needs a signed-in user, not an API key alone. 
+    # @param storefront_oid [Integer] 
+    # @param email_uuid [String] 
+    # @param email_review_request [SfvbEmailReviewRequest] The test order, for an email in an order-triggered flow
+    # @param [Hash] opts the optional parameters
+    # @return [SfvbEmail]
+    def review_sfvb_email(storefront_oid, email_uuid, email_review_request, opts = {})
+      data, _status_code, _headers = review_sfvb_email_with_http_info(storefront_oid, email_uuid, email_review_request, opts)
+      data
+    end
+
+    # Request a content review of a flow or campaign email
+    # Starts a review the way the admin&#39;s Request Review does.  One test copy of the email goes to the signed-in user, and to no one else, and the review runs in the background, so read the email again for pending_review and then the ruling.  Refused with sfvb.review_not_needed when it doesn&#39;t need review, is already waiting for one, or was rejected and not changed since.  An email in a flow triggered by an order or an auto order needs order_id, a test order.  Needs a signed-in user, not an API key alone. 
+    # @param storefront_oid [Integer] 
+    # @param email_uuid [String] 
+    # @param email_review_request [SfvbEmailReviewRequest] The test order, for an email in an order-triggered flow
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(SfvbEmail, Integer, Hash)>] SfvbEmail data, response status code and response headers
+    def review_sfvb_email_with_http_info(storefront_oid, email_uuid, email_review_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: SfvbApi.review_sfvb_email ...'
+      end
+      # verify the required parameter 'storefront_oid' is set
+      if @api_client.config.client_side_validation && storefront_oid.nil?
+        fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling SfvbApi.review_sfvb_email"
+      end
+      # verify the required parameter 'email_uuid' is set
+      if @api_client.config.client_side_validation && email_uuid.nil?
+        fail ArgumentError, "Missing the required parameter 'email_uuid' when calling SfvbApi.review_sfvb_email"
+      end
+      # verify the required parameter 'email_review_request' is set
+      if @api_client.config.client_side_validation && email_review_request.nil?
+        fail ArgumentError, "Missing the required parameter 'email_review_request' when calling SfvbApi.review_sfvb_email"
+      end
+      # resource path
+      local_var_path = '/sfvb/storefronts/{storefront_oid}/emails/{email_uuid}/review'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s)).sub('{' + 'email_uuid' + '}', CGI.escape(email_uuid.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(email_review_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'SfvbEmail'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
+
+      new_options = opts.merge(
+        :operation => :"SfvbApi.review_sfvb_email",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: SfvbApi#review_sfvb_email\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # 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. 
     # @param request_id [String] 

data/lib/ultracart_api/models/sfvb_email.rb

@@ -27,6 +27,9 @@ module UltracartClient
     # True when the email is in a flow or campaign that is sending, so a change reaches customers and needs sfvb_publish.  An email in neither is reported live.
     attr_accessor :live
 
+    # What a write did beyond the fields asked for, such as a step label it could not refresh.  Only on a write.
+    attr_accessor :notes
+
     # True while a change waits for review.  An edit puts it back to needing review.
     attr_accessor :pending_review
 
@@ -58,6 +61,7 @@ module UltracartClient
         :'email_uuid' => :'email_uuid',
         :'hash_sha256' => :'hash_sha256',
         :'live' => :'live',
+        :'notes' => :'notes',
         :'pending_review' => :'pending_review',
         :'preview_text' => :'preview_text',
         :'rejected' => :'rejected',
@@ -81,6 +85,7 @@ module UltracartClient
         :'email_uuid' => :'String',
         :'hash_sha256' => :'String',
         :'live' => :'Boolean',
+        :'notes' => :'Array<String>',
         :'pending_review' => :'Boolean',
         :'preview_text' => :'String',
         :'rejected' => :'Boolean',
@@ -129,6 +134,12 @@ module UltracartClient
         self.live = attributes[:'live']
       end
 
+      if attributes.key?(:'notes')
+        if (value = attributes[:'notes']).is_a?(Array)
+          self.notes = value
+        end
+      end
+
       if attributes.key?(:'pending_review')
         self.pending_review = attributes[:'pending_review']
       end
@@ -184,6 +195,7 @@ module UltracartClient
           email_uuid == o.email_uuid &&
           hash_sha256 == o.hash_sha256 &&
           live == o.live &&
+          notes == o.notes &&
           pending_review == o.pending_review &&
           preview_text == o.preview_text &&
           rejected == o.rejected &&
@@ -203,7 +215,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [container_last_modified_dts, email_uuid, hash_sha256, live, pending_review, preview_text, rejected, requires_review, subject, suspended_for_spam, transactional, version].hash
+      [container_last_modified_dts, email_uuid, hash_sha256, live, notes, pending_review, preview_text, rejected, requires_review, subject, suspended_for_spam, transactional, version].hash
     end
 
     # Builds the object from hash