ultracart_api 4.1.206 → 4.1.207

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1638ad5a22ad0b7a0ce44e1f017f1e40103a9c4db1ac10f15da5879db5ebf33b
-  data.tar.gz: 3504a98078386689aa662e9a773d47e6f1e851ff7b2a678a58faf761a71136f4
+  metadata.gz: 6744f4e0dacef9815b35ba7d361ad6c3a004b2082087fe5dd2bf8a9080a39b7b
+  data.tar.gz: 736cbe24406af15bbc288eb879458f7164de9bbf7be7eb91f03d3cc033636ceb
 SHA512:
-  metadata.gz: 273ce57a125e2ce1adeedce19ea2afe4a0f582177d561c64282e2135dacfcb5ea096966c1df8742826d4debe207e300f56d792534a02a8d15fc5e9bc93ddc163
-  data.tar.gz: d5773e5ecf276f1aecc47166ed237223c4b5319e04d3e8fa558caed7d8271e9a735bb70b1bdb8bc8dc24c88c7a19ca2b983ad9a22bfd1acceaff8d13d76b2991
+  metadata.gz: 971ad17902b7469aa50522e4493d8f50f6fd9e47c9ab76aeef4e4e6980317142dd04f8ad0e244267b278eafedc0c8d3fa62fddbcaf1cf19f497a60662b739389
+  data.tar.gz: a418834642c184d169ae942a84c4c1096bb191de93afa545eb8b7dafd704f423293a2079cbac1e137999827c578048d366d30a63b1c82b7348868ad8a6dbeeff

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.206
+- Package version: 4.1.207
 - 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.206'
+gem 'ultracart_api', '4.1.207'
 ```
 
 install:
@@ -520,6 +520,7 @@ Class | Method | HTTP request | Description
 *UltracartClient::SfvbApi* | [**get_sfvb_approval**](docs/SfvbApi.md#get_sfvb_approval) | **GET** /sfvb/approvals/{approval_id} | Read one approval request
 *UltracartClient::SfvbApi* | [**get_sfvb_approvals**](docs/SfvbApi.md#get_sfvb_approvals) | **GET** /sfvb/approvals | List this sign-in's approval requests
 *UltracartClient::SfvbApi* | [**get_sfvb_blog_post**](docs/SfvbApi.md#get_sfvb_blog_post) | **GET** /sfvb/storefronts/{storefront_oid}/blog_posts/{blog_post_oid} | Read a blog post
+*UltracartClient::SfvbApi* | [**get_sfvb_campaign**](docs/SfvbApi.md#get_sfvb_campaign) | **GET** /sfvb/storefronts/{storefront_oid}/campaigns/{campaign_uuid} | Get a campaign
 *UltracartClient::SfvbApi* | [**get_sfvb_cjson_used_elements**](docs/SfvbApi.md#get_sfvb_cjson_used_elements) | **POST** /sfvb/cjson/elements | Element types used by a container
 *UltracartClient::SfvbApi* | [**get_sfvb_comms_sending_domain**](docs/SfvbApi.md#get_sfvb_comms_sending_domain) | **GET** /sfvb/comms/sending_domains/{domain} | Read a sending domain
 *UltracartClient::SfvbApi* | [**get_sfvb_comms_sending_domains**](docs/SfvbApi.md#get_sfvb_comms_sending_domains) | **GET** /sfvb/comms/sending_domains | List the sending domains
@@ -533,6 +534,7 @@ Class | Method | HTTP request | Description
 *UltracartClient::SfvbApi* | [**get_sfvb_experiment_objectives**](docs/SfvbApi.md#get_sfvb_experiment_objectives) | **GET** /sfvb/storefronts/{storefront_oid}/experiments/objectives | List the objectives an experiment can optimize
 *UltracartClient::SfvbApi* | [**get_sfvb_file_content**](docs/SfvbApi.md#get_sfvb_file_content) | **GET** /sfvb/storefronts/{storefront_oid}/files/content | Read a storefront file
 *UltracartClient::SfvbApi* | [**get_sfvb_file_upload_url**](docs/SfvbApi.md#get_sfvb_file_upload_url) | **GET** /sfvb/storefronts/{storefront_oid}/files/upload_url/{extension} | Get a URL to upload a binary asset to
+*UltracartClient::SfvbApi* | [**get_sfvb_flow**](docs/SfvbApi.md#get_sfvb_flow) | **GET** /sfvb/storefronts/{storefront_oid}/flows/{flow_uuid} | Get a flow
 *UltracartClient::SfvbApi* | [**get_sfvb_i18n_glossary**](docs/SfvbApi.md#get_sfvb_i18n_glossary) | **GET** /sfvb/storefronts/{storefront_oid}/i18n/glossary | Read the storefront's translation glossary
 *UltracartClient::SfvbApi* | [**get_sfvb_i18n_languages**](docs/SfvbApi.md#get_sfvb_i18n_languages) | **GET** /sfvb/storefronts/{storefront_oid}/i18n/languages | List a storefront's languages
 *UltracartClient::SfvbApi* | [**get_sfvb_i18n_machine_translations**](docs/SfvbApi.md#get_sfvb_i18n_machine_translations) | **GET** /sfvb/storefronts/{storefront_oid}/i18n/machine_translations | Read where a widget setting's translations come from
@@ -587,11 +589,13 @@ Class | Method | HTTP request | Description
 *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
 *UltracartClient::SfvbApi* | [**list_sfvb_blog_posts**](docs/SfvbApi.md#list_sfvb_blog_posts) | **GET** /sfvb/storefronts/{storefront_oid}/blog_posts | List the storefront's blog posts
+*UltracartClient::SfvbApi* | [**list_sfvb_campaigns**](docs/SfvbApi.md#list_sfvb_campaigns) | **GET** /sfvb/storefronts/{storefront_oid}/campaigns | List the storefront's campaigns
 *UltracartClient::SfvbApi* | [**list_sfvb_container_versions**](docs/SfvbApi.md#list_sfvb_container_versions) | **GET** /sfvb/storefronts/{storefront_oid}/container_versions | Version history for a container stored outside the file system
 *UltracartClient::SfvbApi* | [**list_sfvb_elements**](docs/SfvbApi.md#list_sfvb_elements) | **GET** /sfvb/elements | List every SFVB element type
 *UltracartClient::SfvbApi* | [**list_sfvb_experiments**](docs/SfvbApi.md#list_sfvb_experiments) | **GET** /sfvb/storefronts/{storefront_oid}/experiments | List the storefront's experiments
 *UltracartClient::SfvbApi* | [**list_sfvb_file_versions**](docs/SfvbApi.md#list_sfvb_file_versions) | **GET** /sfvb/storefronts/{storefront_oid}/files/versions | Version history for a storefront file
 *UltracartClient::SfvbApi* | [**list_sfvb_files**](docs/SfvbApi.md#list_sfvb_files) | **GET** /sfvb/storefronts/{storefront_oid}/files | List a storefront directory
+*UltracartClient::SfvbApi* | [**list_sfvb_flows**](docs/SfvbApi.md#list_sfvb_flows) | **GET** /sfvb/storefronts/{storefront_oid}/flows | List the storefront's flows
 *UltracartClient::SfvbApi* | [**list_sfvb_i18n_messages**](docs/SfvbApi.md#list_sfvb_i18n_messages) | **GET** /sfvb/storefronts/{storefront_oid}/i18n/messages | List built-in messages
 *UltracartClient::SfvbApi* | [**list_sfvb_item_containers**](docs/SfvbApi.md#list_sfvb_item_containers) | **GET** /sfvb/storefronts/{storefront_oid}/item_containers | List the item containers on the account
 *UltracartClient::SfvbApi* | [**list_sfvb_library_installs**](docs/SfvbApi.md#list_sfvb_library_installs) | **GET** /sfvb/storefronts/{storefront_oid}/library/installs | List the library entries installed on a storefront
@@ -1899,7 +1903,11 @@ Class | Method | HTTP request | Description
  - [UltracartClient::SfvbBlogPostImageRequest](docs/SfvbBlogPostImageRequest.md)
  - [UltracartClient::SfvbBlogPostRequest](docs/SfvbBlogPostRequest.md)
  - [UltracartClient::SfvbBlogPostsResponse](docs/SfvbBlogPostsResponse.md)
+ - [UltracartClient::SfvbCampaign](docs/SfvbCampaign.md)
+ - [UltracartClient::SfvbCampaignsResponse](docs/SfvbCampaignsResponse.md)
  - [UltracartClient::SfvbCommsDnsRecord](docs/SfvbCommsDnsRecord.md)
+ - [UltracartClient::SfvbCommsEmail](docs/SfvbCommsEmail.md)
+ - [UltracartClient::SfvbCommsPostcard](docs/SfvbCommsPostcard.md)
  - [UltracartClient::SfvbCommsSendingDomain](docs/SfvbCommsSendingDomain.md)
  - [UltracartClient::SfvbCommsSendingDomainsResponse](docs/SfvbCommsSendingDomainsResponse.md)
  - [UltracartClient::SfvbCommsTwilioAccount](docs/SfvbCommsTwilioAccount.md)
@@ -1941,6 +1949,8 @@ Class | Method | HTTP request | Description
  - [UltracartClient::SfvbFileWriteRequest](docs/SfvbFileWriteRequest.md)
  - [UltracartClient::SfvbFileWriteResponse](docs/SfvbFileWriteResponse.md)
  - [UltracartClient::SfvbFilesResponse](docs/SfvbFilesResponse.md)
+ - [UltracartClient::SfvbFlow](docs/SfvbFlow.md)
+ - [UltracartClient::SfvbFlowsResponse](docs/SfvbFlowsResponse.md)
  - [UltracartClient::SfvbI18nGlossary](docs/SfvbI18nGlossary.md)
  - [UltracartClient::SfvbI18nGlossaryRequest](docs/SfvbI18nGlossaryRequest.md)
  - [UltracartClient::SfvbI18nLanguage](docs/SfvbI18nLanguage.md)
@@ -2287,6 +2297,7 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 4.1.207 | 10/16/2026 | sfvb internal testing |
 | 4.1.206 | 10/16/2026 | sfvb internal testing |
 | 4.1.205 | 10/15/2026 | sfvb internal testing |
 | 4.1.204 | 10/15/2026 | sfvb internal testing |

data/docs/SfvbApi.md

@@ -48,6 +48,7 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
 | [**get_sfvb_approval**](SfvbApi.md#get_sfvb_approval) | **GET** /sfvb/approvals/{approval_id} | Read one approval request |
 | [**get_sfvb_approvals**](SfvbApi.md#get_sfvb_approvals) | **GET** /sfvb/approvals | List this sign-in's approval requests |
 | [**get_sfvb_blog_post**](SfvbApi.md#get_sfvb_blog_post) | **GET** /sfvb/storefronts/{storefront_oid}/blog_posts/{blog_post_oid} | Read a blog post |
+| [**get_sfvb_campaign**](SfvbApi.md#get_sfvb_campaign) | **GET** /sfvb/storefronts/{storefront_oid}/campaigns/{campaign_uuid} | Get a campaign |
 | [**get_sfvb_cjson_used_elements**](SfvbApi.md#get_sfvb_cjson_used_elements) | **POST** /sfvb/cjson/elements | Element types used by a container |
 | [**get_sfvb_comms_sending_domain**](SfvbApi.md#get_sfvb_comms_sending_domain) | **GET** /sfvb/comms/sending_domains/{domain} | Read a sending domain |
 | [**get_sfvb_comms_sending_domains**](SfvbApi.md#get_sfvb_comms_sending_domains) | **GET** /sfvb/comms/sending_domains | List the sending domains |
@@ -61,6 +62,7 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
 | [**get_sfvb_experiment_objectives**](SfvbApi.md#get_sfvb_experiment_objectives) | **GET** /sfvb/storefronts/{storefront_oid}/experiments/objectives | List the objectives an experiment can optimize |
 | [**get_sfvb_file_content**](SfvbApi.md#get_sfvb_file_content) | **GET** /sfvb/storefronts/{storefront_oid}/files/content | Read a storefront file |
 | [**get_sfvb_file_upload_url**](SfvbApi.md#get_sfvb_file_upload_url) | **GET** /sfvb/storefronts/{storefront_oid}/files/upload_url/{extension} | Get a URL to upload a binary asset to |
+| [**get_sfvb_flow**](SfvbApi.md#get_sfvb_flow) | **GET** /sfvb/storefronts/{storefront_oid}/flows/{flow_uuid} | Get a flow |
 | [**get_sfvb_i18n_glossary**](SfvbApi.md#get_sfvb_i18n_glossary) | **GET** /sfvb/storefronts/{storefront_oid}/i18n/glossary | Read the storefront's translation glossary |
 | [**get_sfvb_i18n_languages**](SfvbApi.md#get_sfvb_i18n_languages) | **GET** /sfvb/storefronts/{storefront_oid}/i18n/languages | List a storefront's languages |
 | [**get_sfvb_i18n_machine_translations**](SfvbApi.md#get_sfvb_i18n_machine_translations) | **GET** /sfvb/storefronts/{storefront_oid}/i18n/machine_translations | Read where a widget setting's translations come from |
@@ -115,11 +117,13 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
 | [**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 |
 | [**list_sfvb_blog_posts**](SfvbApi.md#list_sfvb_blog_posts) | **GET** /sfvb/storefronts/{storefront_oid}/blog_posts | List the storefront's blog posts |
+| [**list_sfvb_campaigns**](SfvbApi.md#list_sfvb_campaigns) | **GET** /sfvb/storefronts/{storefront_oid}/campaigns | List the storefront's campaigns |
 | [**list_sfvb_container_versions**](SfvbApi.md#list_sfvb_container_versions) | **GET** /sfvb/storefronts/{storefront_oid}/container_versions | Version history for a container stored outside the file system |
 | [**list_sfvb_elements**](SfvbApi.md#list_sfvb_elements) | **GET** /sfvb/elements | List every SFVB element type |
 | [**list_sfvb_experiments**](SfvbApi.md#list_sfvb_experiments) | **GET** /sfvb/storefronts/{storefront_oid}/experiments | List the storefront's experiments |
 | [**list_sfvb_file_versions**](SfvbApi.md#list_sfvb_file_versions) | **GET** /sfvb/storefronts/{storefront_oid}/files/versions | Version history for a storefront file |
 | [**list_sfvb_files**](SfvbApi.md#list_sfvb_files) | **GET** /sfvb/storefronts/{storefront_oid}/files | List a storefront directory |
+| [**list_sfvb_flows**](SfvbApi.md#list_sfvb_flows) | **GET** /sfvb/storefronts/{storefront_oid}/flows | List the storefront's flows |
 | [**list_sfvb_i18n_messages**](SfvbApi.md#list_sfvb_i18n_messages) | **GET** /sfvb/storefronts/{storefront_oid}/i18n/messages | List built-in messages |
 | [**list_sfvb_item_containers**](SfvbApi.md#list_sfvb_item_containers) | **GET** /sfvb/storefronts/{storefront_oid}/item_containers | List the item containers on the account |
 | [**list_sfvb_library_installs**](SfvbApi.md#list_sfvb_library_installs) | **GET** /sfvb/storefronts/{storefront_oid}/library/installs | List the library entries installed on a storefront |
@@ -2585,6 +2589,60 @@ end
 - **Accept**: application/json
 
 
+## get_sfvb_campaign
+
+> <SfvbCampaign> get_sfvb_campaign(storefront_oid, campaign_uuid)
+
+Get a campaign
+
+One campaign, the same object as its list entry, with its emails and postcards in step order.  A deleted campaign is returned with deleted true. 
+
+
+### Examples
+
+
+(No example for this operation).
+
+
+#### Using the get_sfvb_campaign_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<SfvbCampaign>, Integer, Hash)> get_sfvb_campaign_with_http_info(storefront_oid, campaign_uuid)
+
+```ruby
+begin
+  # Get a campaign
+  data, status_code, headers = api_instance.get_sfvb_campaign_with_http_info(storefront_oid, campaign_uuid)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <SfvbCampaign>
+rescue UltracartClient::ApiError => e
+  puts "Error when calling SfvbApi->get_sfvb_campaign_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **storefront_oid** | **Integer** |  |  |
+| **campaign_uuid** | **String** |  |  |
+
+### Return type
+
+[**SfvbCampaign**](SfvbCampaign.md)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
 ## get_sfvb_cjson_used_elements
 
 > <SfvbElementsResponse> get_sfvb_cjson_used_elements(compile_request)
@@ -3282,6 +3340,60 @@ end
 - **Accept**: application/json
 
 
+## get_sfvb_flow
+
+> <SfvbFlow> get_sfvb_flow(storefront_oid, flow_uuid)
+
+Get a flow
+
+One flow, the same object as its list entry, with its emails and postcards in step order.  A deleted flow is returned with deleted true. 
+
+
+### Examples
+
+
+(No example for this operation).
+
+
+#### Using the get_sfvb_flow_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<SfvbFlow>, Integer, Hash)> get_sfvb_flow_with_http_info(storefront_oid, flow_uuid)
+
+```ruby
+begin
+  # Get a flow
+  data, status_code, headers = api_instance.get_sfvb_flow_with_http_info(storefront_oid, flow_uuid)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <SfvbFlow>
+rescue UltracartClient::ApiError => e
+  puts "Error when calling SfvbApi->get_sfvb_flow_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **storefront_oid** | **Integer** |  |  |
+| **flow_uuid** | **String** |  |  |
+
+### Return type
+
+[**SfvbFlow**](SfvbFlow.md)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
 ## get_sfvb_i18n_glossary
 
 > <SfvbI18nGlossary> get_sfvb_i18n_glossary(storefront_oid)
@@ -6204,6 +6316,63 @@ end
 - **Accept**: application/json
 
 
+## list_sfvb_campaigns
+
+> <SfvbCampaignsResponse> list_sfvb_campaigns(storefront_oid, opts)
+
+List the storefront's campaigns
+
+One page of campaigns, newest first, each with its emails and postcards in step order, without their container JSON.  search matches the campaign name.  Deleted campaigns are left out unless include_deleted is true.  live is true unless the status sends nothing (draft or archived), so a change to one of its emails reaches customers at once. 
+
+
+### Examples
+
+
+(No example for this operation).
+
+
+#### Using the list_sfvb_campaigns_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<SfvbCampaignsResponse>, Integer, Hash)> list_sfvb_campaigns_with_http_info(storefront_oid, opts)
+
+```ruby
+begin
+  # List the storefront's campaigns
+  data, status_code, headers = api_instance.list_sfvb_campaigns_with_http_info(storefront_oid, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <SfvbCampaignsResponse>
+rescue UltracartClient::ApiError => e
+  puts "Error when calling SfvbApi->list_sfvb_campaigns_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **storefront_oid** | **Integer** |  |  |
+| **search** | **String** | Text to search for in the name | [optional] |
+| **page** | **Integer** | Page number, starting at 1 | [optional] |
+| **page_size** | **Integer** | Campaigns per page, 1 to 100, default 50 | [optional] |
+| **include_deleted** | **Boolean** | Include deleted campaigns | [optional] |
+
+### Return type
+
+[**SfvbCampaignsResponse**](SfvbCampaignsResponse.md)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
 ## list_sfvb_container_versions
 
 > <SfvbContainerVersionsResponse> list_sfvb_container_versions(storefront_oid, opts)
@@ -6478,6 +6647,63 @@ end
 - **Accept**: application/json
 
 
+## list_sfvb_flows
+
+> <SfvbFlowsResponse> list_sfvb_flows(storefront_oid, opts)
+
+List the storefront's flows
+
+One page of flows, newest first, each with its trigger and its emails and postcards in step order, without their container JSON.  search matches the flow name.  Deleted flows are left out unless include_deleted is true.  live is true unless the status sends nothing (draft or inactive); a paused flow still holds enrolled customers, so it counts as live. 
+
+
+### Examples
+
+
+(No example for this operation).
+
+
+#### Using the list_sfvb_flows_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<SfvbFlowsResponse>, Integer, Hash)> list_sfvb_flows_with_http_info(storefront_oid, opts)
+
+```ruby
+begin
+  # List the storefront's flows
+  data, status_code, headers = api_instance.list_sfvb_flows_with_http_info(storefront_oid, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <SfvbFlowsResponse>
+rescue UltracartClient::ApiError => e
+  puts "Error when calling SfvbApi->list_sfvb_flows_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **storefront_oid** | **Integer** |  |  |
+| **search** | **String** | Text to search for in the name | [optional] |
+| **page** | **Integer** | Page number, starting at 1 | [optional] |
+| **page_size** | **Integer** | Flows per page, 1 to 100, default 50 | [optional] |
+| **include_deleted** | **Boolean** | Include deleted flows | [optional] |
+
+### Return type
+
+[**SfvbFlowsResponse**](SfvbFlowsResponse.md)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
 ## list_sfvb_i18n_messages
 
 > <SfvbI18nMessagesResponse> list_sfvb_i18n_messages(storefront_oid, opts)

data/docs/SfvbCampaign.md

@@ -0,0 +1,38 @@
+# UltracartClient::SfvbCampaign
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **campaign_uuid** | **String** | The campaign uuid. | [optional] |
+| **communication_sequence_uuid** | **String** | The communication sequence the steps belong to. | [optional] |
+| **created_dts** | **String** | When the campaign was created (ISO 8601, UTC). | [optional] |
+| **deleted** | **Boolean** | True when the campaign was deleted. | [optional] |
+| **emails** | [**Array<SfvbCommsEmail>**](SfvbCommsEmail.md) | Its emails, in step order. | [optional] |
+| **live** | **Boolean** | True when the emails and postcards reach customers now, so a change to one shows at once.  False only in a status that sends nothing. | [optional] |
+| **name** | **String** | The campaign name. | [optional] |
+| **postcards** | [**Array<SfvbCommsPostcard>**](SfvbCommsPostcard.md) | Its postcards, in step order. | [optional] |
+| **scheduled_dts** | **String** | When the campaign is scheduled to send (ISO 8601, UTC), when it is. | [optional] |
+| **status** | **String** | The status, such as draft, scheduled, sending, sent or archived. | [optional] |
+| **status_dts** | **String** | When the status last changed (ISO 8601, UTC). | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbCampaign.new(
+  campaign_uuid: null,
+  communication_sequence_uuid: null,
+  created_dts: null,
+  deleted: null,
+  emails: null,
+  live: null,
+  name: null,
+  postcards: null,
+  scheduled_dts: null,
+  status: null,
+  status_dts: null
+)
+```
+

data/docs/SfvbCampaignsResponse.md

@@ -0,0 +1,24 @@
+# UltracartClient::SfvbCampaignsResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **campaigns** | [**Array<SfvbCampaign>**](SfvbCampaign.md) | The campaigns on this page, newest first. | [optional] |
+| **page** | **Integer** | This page number, starting at 1. | [optional] |
+| **page_size** | **Integer** | The page size. | [optional] |
+| **total** | **Integer** | How many match, across every page. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbCampaignsResponse.new(
+  campaigns: null,
+  page: null,
+  page_size: null,
+  total: null
+)
+```
+

data/docs/SfvbCommsEmail.md

@@ -0,0 +1,38 @@
+# UltracartClient::SfvbCommsEmail
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **container_last_modified_dts** | **String** | When the email container was last changed (ISO 8601, UTC). | [optional] |
+| **deleted** | **Boolean** | True when the email was deleted. | [optional] |
+| **email_uuid** | **String** | The email uuid.  Use it with the email container (owner type email) and with the email render endpoint. | [optional] |
+| **pending_review** | **Boolean** | True while a change waits for review. | [optional] |
+| **preview_text** | **String** | The preview text an inbox shows after the subject. | [optional] |
+| **rejected** | **Boolean** | True when review rejected the email.  Don't edit it without the merchant. | [optional] |
+| **requires_review** | **Boolean** | True when a change to this email must be reviewed before it sends. | [optional] |
+| **step_uuid** | **String** | The step that sends this email. | [optional] |
+| **subject** | **String** | The subject line. | [optional] |
+| **transactional** | **Boolean** | True for a transactional email, which skips the marketing footer rules. | [optional] |
+| **version** | **Integer** | The email version. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbCommsEmail.new(
+  container_last_modified_dts: null,
+  deleted: null,
+  email_uuid: null,
+  pending_review: null,
+  preview_text: null,
+  rejected: null,
+  requires_review: null,
+  step_uuid: null,
+  subject: null,
+  transactional: null,
+  version: null
+)
+```
+

data/docs/SfvbCommsPostcard.md

@@ -0,0 +1,28 @@
+# UltracartClient::SfvbCommsPostcard
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **back_container_uuid** | **String** | The back side container uuid (owner type postcardback). | [optional] |
+| **container_last_modified_dts** | **String** | When either side was last changed (ISO 8601, UTC). | [optional] |
+| **deleted** | **Boolean** | True when the postcard was deleted. | [optional] |
+| **front_container_uuid** | **String** | The front side container uuid (owner type postcardfront). | [optional] |
+| **postcard_uuid** | **String** | The postcard uuid. | [optional] |
+| **step_uuid** | **String** | The step that sends this postcard. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbCommsPostcard.new(
+  back_container_uuid: null,
+  container_last_modified_dts: null,
+  deleted: null,
+  front_container_uuid: null,
+  postcard_uuid: null,
+  step_uuid: null
+)
+```
+

data/docs/SfvbFlow.md

@@ -0,0 +1,40 @@
+# UltracartClient::SfvbFlow
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **communication_sequence_uuid** | **String** | The communication sequence the steps belong to. | [optional] |
+| **created_dts** | **String** | When the flow was created (ISO 8601, UTC). | [optional] |
+| **deleted** | **Boolean** | True when the flow was deleted. | [optional] |
+| **emails** | [**Array<SfvbCommsEmail>**](SfvbCommsEmail.md) | Its emails, in step order. | [optional] |
+| **flow_uuid** | **String** | The flow uuid. | [optional] |
+| **live** | **Boolean** | True when the emails and postcards reach customers now, so a change to one shows at once.  False only in a status that sends nothing. | [optional] |
+| **name** | **String** | The flow name. | [optional] |
+| **postcards** | [**Array<SfvbCommsPostcard>**](SfvbCommsPostcard.md) | Its postcards, in step order. | [optional] |
+| **status** | **String** | The status, such as draft, active, paused, draining or inactive. | [optional] |
+| **status_dts** | **String** | When the status last changed (ISO 8601, UTC). | [optional] |
+| **trigger_parameter_name** | **String** | The name of the trigger parameter, when the trigger takes one. | [optional] |
+| **trigger_type** | **String** | What starts the flow, such as cart abandon or an order. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbFlow.new(
+  communication_sequence_uuid: null,
+  created_dts: null,
+  deleted: null,
+  emails: null,
+  flow_uuid: null,
+  live: null,
+  name: null,
+  postcards: null,
+  status: null,
+  status_dts: null,
+  trigger_parameter_name: null,
+  trigger_type: null
+)
+```
+

data/docs/SfvbFlowsResponse.md

@@ -0,0 +1,24 @@
+# UltracartClient::SfvbFlowsResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **flows** | [**Array<SfvbFlow>**](SfvbFlow.md) | The flows on this page, newest first. | [optional] |
+| **page** | **Integer** | This page number, starting at 1. | [optional] |
+| **page_size** | **Integer** | The page size. | [optional] |
+| **total** | **Integer** | How many match, across every page. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbFlowsResponse.new(
+  flows: null,
+  page: null,
+  page_size: null,
+  total: null
+)
+```
+