ultracart_api 4.1.207 → 4.1.209

data/docs/SfvbApi.md

@@ -6,11 +6,17 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
 | ------ | ------------ | ----------- |
 | [**add_sfvb_page_blog_posts**](SfvbApi.md#add_sfvb_page_blog_posts) | **POST** /sfvb/storefronts/{storefront_oid}/pages/blog_posts/add | Assign blog posts to a page |
 | [**add_sfvb_page_items**](SfvbApi.md#add_sfvb_page_items) | **POST** /sfvb/storefronts/{storefront_oid}/pages/items/add | Assign items to a page |
+| [**archive_sfvb_campaign**](SfvbApi.md#archive_sfvb_campaign) | **PUT** /sfvb/storefronts/{storefront_oid}/campaigns/{campaign_uuid}/archive | Archive or unarchive a campaign |
+| [**archive_sfvb_flow**](SfvbApi.md#archive_sfvb_flow) | **PUT** /sfvb/storefronts/{storefront_oid}/flows/{flow_uuid}/archive | Archive or unarchive a flow |
 | [**archive_sfvb_upsell_path**](SfvbApi.md#archive_sfvb_upsell_path) | **POST** /sfvb/storefronts/{storefront_oid}/upsell_paths/{upsell_path_oid}/archive | Archive an upsell path |
 | [**attach_sfvb_blog_post_image**](SfvbApi.md#attach_sfvb_blog_post_image) | **POST** /sfvb/storefronts/{storefront_oid}/blog_posts/{blog_post_oid}/images/attach | Attach an image to a blog post |
 | [**check_sfvb_redirect**](SfvbApi.md#check_sfvb_redirect) | **POST** /sfvb/storefronts/{storefront_oid}/redirects/check | Check a redirect rule without creating it |
 | [**clear_sfvb_library_screenshot**](SfvbApi.md#clear_sfvb_library_screenshot) | **DELETE** /sfvb/storefronts/{storefront_oid}/library/{library_oid}/screenshot | Remove a library entry's screenshot |
+| [**clone_sfvb_campaign**](SfvbApi.md#clone_sfvb_campaign) | **POST** /sfvb/storefronts/{storefront_oid}/campaigns/{campaign_uuid}/clone | Copy a campaign on the same storefront |
+| [**clone_sfvb_flow**](SfvbApi.md#clone_sfvb_flow) | **POST** /sfvb/storefronts/{storefront_oid}/flows/{flow_uuid}/clone | Copy a flow on the same storefront |
 | [**compile_sfvb_cjson**](SfvbApi.md#compile_sfvb_cjson) | **POST** /sfvb/cjson/compile | Compile CJSON to Velocity |
+| [**create_sfvb_campaign**](SfvbApi.md#create_sfvb_campaign) | **POST** /sfvb/storefronts/{storefront_oid}/campaigns | Create a draft campaign |
+| [**create_sfvb_flow**](SfvbApi.md#create_sfvb_flow) | **POST** /sfvb/storefronts/{storefront_oid}/flows | Create a draft flow |
 | [**create_sfvb_library_entry**](SfvbApi.md#create_sfvb_library_entry) | **POST** /sfvb/storefronts/{storefront_oid}/library | Save a fragment to the library |
 | [**create_sfvb_preview_access**](SfvbApi.md#create_sfvb_preview_access) | **POST** /sfvb/storefronts/{storefront_oid}/preview_access | One time link that opens a preview in a browser with no UltraCart login |
 | [**create_sfvb_preview_session**](SfvbApi.md#create_sfvb_preview_session) | **POST** /sfvb/storefronts/{storefront_oid}/preview_sessions | Create a preview session |
@@ -56,6 +62,7 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
 | [**get_sfvb_container**](SfvbApi.md#get_sfvb_container) | **GET** /sfvb/storefronts/{storefront_oid}/containers/{owner_type}/{owner_object_id} | Read a container stored outside the file system |
 | [**get_sfvb_container_version**](SfvbApi.md#get_sfvb_container_version) | **GET** /sfvb/storefronts/{storefront_oid}/container_versions/{container_history_oid} | Read the CJSON stored in one container history entry |
 | [**get_sfvb_element**](SfvbApi.md#get_sfvb_element) | **GET** /sfvb/elements/{element_type} | Configuration schema and field card for one element type |
+| [**get_sfvb_email**](SfvbApi.md#get_sfvb_email) | **GET** /sfvb/storefronts/{storefront_oid}/emails/{email_uuid} | Get a flow or campaign email's subject and preview text |
 | [**get_sfvb_events**](SfvbApi.md#get_sfvb_events) | **GET** /sfvb/events | Replay events |
 | [**get_sfvb_events_authorization**](SfvbApi.md#get_sfvb_events_authorization) | **PUT** /sfvb/events/auth | Open the event stream |
 | [**get_sfvb_experiment**](SfvbApi.md#get_sfvb_experiment) | **GET** /sfvb/storefronts/{storefront_oid}/experiments/{experiment_oid} | Read one experiment and its statistics |
@@ -118,6 +125,8 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
 | [**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_comms_lists**](SfvbApi.md#list_sfvb_comms_lists) | **GET** /sfvb/storefronts/{storefront_oid}/lists | List the storefront's email lists |
+| [**list_sfvb_comms_segments**](SfvbApi.md#list_sfvb_comms_segments) | **GET** /sfvb/storefronts/{storefront_oid}/segments | List the storefront's segments |
 | [**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 |
@@ -182,8 +191,12 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
 | [**unpublish_sfvb_library_entry**](SfvbApi.md#unpublish_sfvb_library_entry) | **POST** /sfvb/storefronts/{storefront_oid}/library/{library_oid}/unpublish | Narrow who can see a library entry |
 | [**unshare_sfvb_library_entry**](SfvbApi.md#unshare_sfvb_library_entry) | **DELETE** /sfvb/storefronts/{storefront_oid}/library/{library_oid}/shares/{merchant_id} | Stop sharing a library entry with an account |
 | [**update_sfvb_blog_post**](SfvbApi.md#update_sfvb_blog_post) | **PUT** /sfvb/storefronts/{storefront_oid}/blog_posts/{blog_post_oid} | Change a blog post |
+| [**update_sfvb_campaign**](SfvbApi.md#update_sfvb_campaign) | **PUT** /sfvb/storefronts/{storefront_oid}/campaigns/{campaign_uuid} | Change a campaign |
 | [**update_sfvb_comms_sending_domain**](SfvbApi.md#update_sfvb_comms_sending_domain) | **PUT** /sfvb/comms/sending_domains/{domain} | Update a sending domain |
 | [**update_sfvb_comms_twilio_account**](SfvbApi.md#update_sfvb_comms_twilio_account) | **PUT** /sfvb/comms/twilio_account | Update the Twilio account |
+| [**update_sfvb_email**](SfvbApi.md#update_sfvb_email) | **PUT** /sfvb/storefronts/{storefront_oid}/emails/{email_uuid} | Change a flow or campaign email's subject or preview text |
+| [**update_sfvb_flow**](SfvbApi.md#update_sfvb_flow) | **PUT** /sfvb/storefronts/{storefront_oid}/flows/{flow_uuid} | Change a flow |
+| [**update_sfvb_flow_status**](SfvbApi.md#update_sfvb_flow_status) | **PUT** /sfvb/storefronts/{storefront_oid}/flows/{flow_uuid}/status | Turn a flow on or off |
 | [**update_sfvb_item_attribute_batch**](SfvbApi.md#update_sfvb_item_attribute_batch) | **POST** /sfvb/storefronts/{storefront_oid}/items/attributes/batch | Change attributes across many items in one call |
 | [**update_sfvb_library_entry**](SfvbApi.md#update_sfvb_library_entry) | **PUT** /sfvb/storefronts/{storefront_oid}/library/{library_oid} | Update a library entry's draft |
 | [**update_sfvb_redirect**](SfvbApi.md#update_sfvb_redirect) | **PUT** /sfvb/storefronts/{storefront_oid}/redirects/{redirect_id} | Change a redirect rule |
@@ -304,6 +317,118 @@ end
 - **Accept**: application/json
 
 
+## archive_sfvb_campaign
+
+> <SfvbCampaign> archive_sfvb_campaign(storefront_oid, campaign_uuid, if_match, archive_request)
+
+Archive or unarchive a campaign
+
+Archiving alone never stops a send, so archiving a scheduled campaign also sets it back to draft, and notes says so.  A campaign whose send is under way is refused with sfvb.campaign_sending.  Send the hash_sha256 you read as If-Match.  A scheduled, sending or sent campaign needs sfvb_publish. 
+
+
+### Examples
+
+
+(No example for this operation).
+
+
+#### Using the archive_sfvb_campaign_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<SfvbCampaign>, Integer, Hash)> archive_sfvb_campaign_with_http_info(storefront_oid, campaign_uuid, if_match, archive_request)
+
+```ruby
+begin
+  # Archive or unarchive a campaign
+  data, status_code, headers = api_instance.archive_sfvb_campaign_with_http_info(storefront_oid, campaign_uuid, if_match, archive_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <SfvbCampaign>
+rescue UltracartClient::ApiError => e
+  puts "Error when calling SfvbApi->archive_sfvb_campaign_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **storefront_oid** | **Integer** |  |  |
+| **campaign_uuid** | **String** |  |  |
+| **if_match** | **String** | hash_sha256 from the last read.  Required; 428 when absent, 412 when stale. |  |
+| **archive_request** | [**SfvbArchiveRequest**](SfvbArchiveRequest.md) | Whether to archive |  |
+
+### Return type
+
+[**SfvbCampaign**](SfvbCampaign.md)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## archive_sfvb_flow
+
+> <SfvbFlow> archive_sfvb_flow(storefront_oid, flow_uuid, if_match, archive_request)
+
+Archive or unarchive a flow
+
+A flow that is still enrolling customers is refused, because archiving would only hide it.  Set its status to inactive first.  Send the hash_sha256 you read as If-Match. 
+
+
+### Examples
+
+
+(No example for this operation).
+
+
+#### Using the archive_sfvb_flow_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<SfvbFlow>, Integer, Hash)> archive_sfvb_flow_with_http_info(storefront_oid, flow_uuid, if_match, archive_request)
+
+```ruby
+begin
+  # Archive or unarchive a flow
+  data, status_code, headers = api_instance.archive_sfvb_flow_with_http_info(storefront_oid, flow_uuid, if_match, archive_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <SfvbFlow>
+rescue UltracartClient::ApiError => e
+  puts "Error when calling SfvbApi->archive_sfvb_flow_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **storefront_oid** | **Integer** |  |  |
+| **flow_uuid** | **String** |  |  |
+| **if_match** | **String** | hash_sha256 from the last read.  Required; 428 when absent, 412 when stale. |  |
+| **archive_request** | [**SfvbArchiveRequest**](SfvbArchiveRequest.md) | Whether to archive |  |
+
+### Return type
+
+[**SfvbFlow**](SfvbFlow.md)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
 ## archive_sfvb_upsell_path
 
 > <SfvbUpsellPath> archive_sfvb_upsell_path(storefront_oid, upsell_path_oid)
@@ -522,6 +647,114 @@ end
 - **Accept**: application/json
 
 
+## clone_sfvb_campaign
+
+> <SfvbCampaign> clone_sfvb_campaign(storefront_oid, campaign_uuid)
+
+Copy a campaign on the same storefront
+
+A draft copy with copies of its emails and postcards, named Copy of and the original name, never archived and never scheduled.  Steps keep their settings, including a paused rate limiter or an experiment winner, and notes names each one. 
+
+
+### Examples
+
+
+(No example for this operation).
+
+
+#### Using the clone_sfvb_campaign_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<SfvbCampaign>, Integer, Hash)> clone_sfvb_campaign_with_http_info(storefront_oid, campaign_uuid)
+
+```ruby
+begin
+  # Copy a campaign on the same storefront
+  data, status_code, headers = api_instance.clone_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->clone_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
+
+
+## clone_sfvb_flow
+
+> <SfvbFlow> clone_sfvb_flow(storefront_oid, flow_uuid)
+
+Copy a flow on the same storefront
+
+A draft copy with copies of its emails and postcards, named Copy of and the original name, never archived.  It enrolls nobody until it is turned on.  Steps keep their settings, including a paused rate limiter or an experiment winner, and notes names each one. 
+
+
+### Examples
+
+
+(No example for this operation).
+
+
+#### Using the clone_sfvb_flow_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<SfvbFlow>, Integer, Hash)> clone_sfvb_flow_with_http_info(storefront_oid, flow_uuid)
+
+```ruby
+begin
+  # Copy a flow on the same storefront
+  data, status_code, headers = api_instance.clone_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->clone_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
+
+
 ## compile_sfvb_cjson
 
 > <SfvbCompileResponse> compile_sfvb_cjson(compile_request)
@@ -575,6 +808,114 @@ end
 - **Accept**: application/json
 
 
+## create_sfvb_campaign
+
+> <SfvbCampaign> create_sfvb_campaign(storefront_oid, campaign_write_request)
+
+Create a draft campaign
+
+A new draft campaign with an empty communication sequence.  name is required.  The sender defaults to the storefront's marketing sending settings.  Nothing here starts a campaign. 
+
+
+### Examples
+
+
+(No example for this operation).
+
+
+#### Using the create_sfvb_campaign_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<SfvbCampaign>, Integer, Hash)> create_sfvb_campaign_with_http_info(storefront_oid, campaign_write_request)
+
+```ruby
+begin
+  # Create a draft campaign
+  data, status_code, headers = api_instance.create_sfvb_campaign_with_http_info(storefront_oid, campaign_write_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <SfvbCampaign>
+rescue UltracartClient::ApiError => e
+  puts "Error when calling SfvbApi->create_sfvb_campaign_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **storefront_oid** | **Integer** |  |  |
+| **campaign_write_request** | [**SfvbCampaignWriteRequest**](SfvbCampaignWriteRequest.md) | The campaign to create |  |
+
+### Return type
+
+[**SfvbCampaign**](SfvbCampaign.md)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## create_sfvb_flow
+
+> <SfvbFlow> create_sfvb_flow(storefront_oid, flow_write_request)
+
+Create a draft flow
+
+A new draft flow with an empty communication sequence.  name and trigger_type are required.  A list or segment trigger needs trigger_parameter, the uuid of a list or segment on this storefront.  The sender defaults to the storefront's marketing sending settings.  A draft flow enrolls nobody until it is turned on. 
+
+
+### Examples
+
+
+(No example for this operation).
+
+
+#### Using the create_sfvb_flow_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<SfvbFlow>, Integer, Hash)> create_sfvb_flow_with_http_info(storefront_oid, flow_write_request)
+
+```ruby
+begin
+  # Create a draft flow
+  data, status_code, headers = api_instance.create_sfvb_flow_with_http_info(storefront_oid, flow_write_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <SfvbFlow>
+rescue UltracartClient::ApiError => e
+  puts "Error when calling SfvbApi->create_sfvb_flow_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **storefront_oid** | **Integer** |  |  |
+| **flow_write_request** | [**SfvbFlowWriteRequest**](SfvbFlowWriteRequest.md) | The flow to create |  |
+
+### Return type
+
+[**SfvbFlow**](SfvbFlow.md)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
 ## create_sfvb_library_entry
 
 > <SfvbLibraryEntry> create_sfvb_library_entry(storefront_oid, library_entry)
@@ -3015,6 +3356,60 @@ end
 - **Accept**: application/json
 
 
+## get_sfvb_email
+
+> <SfvbEmail> get_sfvb_email(storefront_oid, email_uuid)
+
+Get a flow or campaign email's subject and preview text
+
+The subject, preview text and hash_sha256 to send as If-Match when updating them, with whether the email is live and its review state.  The body is the email container (owner type email).  Find the uuid in the storefront's campaigns and flows. 
+
+
+### Examples
+
+
+(No example for this operation).
+
+
+#### Using the get_sfvb_email_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<SfvbEmail>, Integer, Hash)> get_sfvb_email_with_http_info(storefront_oid, email_uuid)
+
+```ruby
+begin
+  # Get a flow or campaign email's subject and preview text
+  data, status_code, headers = api_instance.get_sfvb_email_with_http_info(storefront_oid, email_uuid)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <SfvbEmail>
+rescue UltracartClient::ApiError => e
+  puts "Error when calling SfvbApi->get_sfvb_email_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **storefront_oid** | **Integer** |  |  |
+| **email_uuid** | **String** |  |  |
+
+### Return type
+
+[**SfvbEmail**](SfvbEmail.md)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
 ## get_sfvb_events
 
 > <SfvbEventsResponse> get_sfvb_events(opts)
@@ -6178,9 +6573,118 @@ begin
   data, status_code, headers = api_instance.insert_sfvb_upsell_path_with_http_info(storefront_oid, upsell_path)
   p status_code # => 2xx
   p headers # => { ... }
-  p data # => <SfvbUpsellPath>
+  p data # => <SfvbUpsellPath>
+rescue UltracartClient::ApiError => e
+  puts "Error when calling SfvbApi->insert_sfvb_upsell_path_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **storefront_oid** | **Integer** |  |  |
+| **upsell_path** | [**SfvbUpsellPath**](SfvbUpsellPath.md) | The path to create |  |
+
+### Return type
+
+[**SfvbUpsellPath**](SfvbUpsellPath.md)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: application/json; charset=UTF-8
+- **Accept**: application/json
+
+
+## install_sfvb_library_entry
+
+> <SfvbLibraryInstallReceipt> install_sfvb_library_entry(storefront_oid, library_oid, opts)
+
+Install a library entry into a storefront
+
+Copies the fragment's referenced files into the storefront file system and returns a receipt with the CJSON's paths resolved, ready to place.  It never places the CJSON.  Read content_manifest first; executable content needs acknowledge_executable true.  A file that already exists with different content is a conflict - on_conflict fail (the default) refuses with 409 and writes nothing, skip keeps the existing file, overwrite replaces it.  A recipient installs a published revision.  This writes, which is why it is a POST, and it requires sfvb_publish because the files land in the shared storefront file system, which is served to shoppers whichever theme is active. 
+
+
+### Examples
+
+
+(No example for this operation).
+
+
+#### Using the install_sfvb_library_entry_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<SfvbLibraryInstallReceipt>, Integer, Hash)> install_sfvb_library_entry_with_http_info(storefront_oid, library_oid, opts)
+
+```ruby
+begin
+  # Install a library entry into a storefront
+  data, status_code, headers = api_instance.install_sfvb_library_entry_with_http_info(storefront_oid, library_oid, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <SfvbLibraryInstallReceipt>
+rescue UltracartClient::ApiError => e
+  puts "Error when calling SfvbApi->install_sfvb_library_entry_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **storefront_oid** | **Integer** |  |  |
+| **library_oid** | **Integer** |  |  |
+| **install_request** | [**SfvbLibraryInstallRequest**](SfvbLibraryInstallRequest.md) | Revision, conflict handling and acknowledgement | [optional] |
+
+### Return type
+
+[**SfvbLibraryInstallReceipt**](SfvbLibraryInstallReceipt.md)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: application/json; charset=UTF-8
+- **Accept**: application/json
+
+
+## list_sfvb_blog_posts
+
+> <SfvbBlogPostsResponse> list_sfvb_blog_posts(storefront_oid, opts)
+
+List the storefront's blog posts
+
+One page of blog posts, newest first, without their bodies.  search matches the title, body, excerpt, url part or author, or a tag exactly.  unassigned marks posts no page shows yet.  Use a post's blog_post_oid to assign it to a page. 
+
+
+### Examples
+
+
+(No example for this operation).
+
+
+#### Using the list_sfvb_blog_posts_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<SfvbBlogPostsResponse>, Integer, Hash)> list_sfvb_blog_posts_with_http_info(storefront_oid, opts)
+
+```ruby
+begin
+  # List the storefront's blog posts
+  data, status_code, headers = api_instance.list_sfvb_blog_posts_with_http_info(storefront_oid, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <SfvbBlogPostsResponse>
 rescue UltracartClient::ApiError => e
-  puts "Error when calling SfvbApi->insert_sfvb_upsell_path_with_http_info: #{e}"
+  puts "Error when calling SfvbApi->list_sfvb_blog_posts_with_http_info: #{e}"
 end
 ```
 
@@ -6189,11 +6693,13 @@ end
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **storefront_oid** | **Integer** |  |  |
-| **upsell_path** | [**SfvbUpsellPath**](SfvbUpsellPath.md) | The path to create |  |
+| **search** | **String** | Text to search for | [optional] |
+| **page** | **Integer** | Page number, starting at 1 | [optional] |
+| **page_size** | **Integer** | Posts per page, 1 to 100, default 50 | [optional] |
 
 ### Return type
 
-[**SfvbUpsellPath**](SfvbUpsellPath.md)
+[**SfvbBlogPostsResponse**](SfvbBlogPostsResponse.md)
 
 ### Authorization
 
@@ -6201,17 +6707,17 @@ end
 
 ### HTTP request headers
 
-- **Content-Type**: application/json; charset=UTF-8
+- **Content-Type**: Not defined
 - **Accept**: application/json
 
 
-## install_sfvb_library_entry
+## list_sfvb_campaigns
 
-> <SfvbLibraryInstallReceipt> install_sfvb_library_entry(storefront_oid, library_oid, opts)
+> <SfvbCampaignsResponse> list_sfvb_campaigns(storefront_oid, opts)
 
-Install a library entry into a storefront
+List the storefront's campaigns
 
-Copies the fragment's referenced files into the storefront file system and returns a receipt with the CJSON's paths resolved, ready to place.  It never places the CJSON.  Read content_manifest first; executable content needs acknowledge_executable true.  A file that already exists with different content is a conflict - on_conflict fail (the default) refuses with 409 and writes nothing, skip keeps the existing file, overwrite replaces it.  A recipient installs a published revision.  This writes, which is why it is a POST, and it requires sfvb_publish because the files land in the shared storefront file system, which is served to shoppers whichever theme is active. 
+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
@@ -6220,21 +6726,21 @@ Copies the fragment's referenced files into the storefront file system and retur
 (No example for this operation).
 
 
-#### Using the install_sfvb_library_entry_with_http_info variant
+#### Using the list_sfvb_campaigns_with_http_info variant
 
 This returns an Array which contains the response data, status code and headers.
 
-> <Array(<SfvbLibraryInstallReceipt>, Integer, Hash)> install_sfvb_library_entry_with_http_info(storefront_oid, library_oid, opts)
+> <Array(<SfvbCampaignsResponse>, Integer, Hash)> list_sfvb_campaigns_with_http_info(storefront_oid, opts)
 
 ```ruby
 begin
-  # Install a library entry into a storefront
-  data, status_code, headers = api_instance.install_sfvb_library_entry_with_http_info(storefront_oid, library_oid, opts)
+  # 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 # => <SfvbLibraryInstallReceipt>
+  p data # => <SfvbCampaignsResponse>
 rescue UltracartClient::ApiError => e
-  puts "Error when calling SfvbApi->install_sfvb_library_entry_with_http_info: #{e}"
+  puts "Error when calling SfvbApi->list_sfvb_campaigns_with_http_info: #{e}"
 end
 ```
 
@@ -6243,12 +6749,14 @@ end
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **storefront_oid** | **Integer** |  |  |
-| **library_oid** | **Integer** |  |  |
-| **install_request** | [**SfvbLibraryInstallRequest**](SfvbLibraryInstallRequest.md) | Revision, conflict handling and acknowledgement | [optional] |
+| **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
 
-[**SfvbLibraryInstallReceipt**](SfvbLibraryInstallReceipt.md)
+[**SfvbCampaignsResponse**](SfvbCampaignsResponse.md)
 
 ### Authorization
 
@@ -6256,17 +6764,17 @@ end
 
 ### HTTP request headers
 
-- **Content-Type**: application/json; charset=UTF-8
+- **Content-Type**: Not defined
 - **Accept**: application/json
 
 
-## list_sfvb_blog_posts
+## list_sfvb_comms_lists
 
-> <SfvbBlogPostsResponse> list_sfvb_blog_posts(storefront_oid, opts)
+> <SfvbCommsListsResponse> list_sfvb_comms_lists(storefront_oid)
 
-List the storefront's blog posts
+List the storefront's email lists
 
-One page of blog posts, newest first, without their bodies.  search matches the title, body, excerpt, url part or author, or a tag exactly.  unassigned marks posts no page shows yet.  Use a post's blog_post_oid to assign it to a page. 
+Each list's uuid, name and member count, by name, for a campaign's memberships or a list trigger.  Never its members.  Archived lists are left out. 
 
 
 ### Examples
@@ -6275,21 +6783,21 @@ One page of blog posts, newest first, without their bodies.  search matches the
 (No example for this operation).
 
 
-#### Using the list_sfvb_blog_posts_with_http_info variant
+#### Using the list_sfvb_comms_lists_with_http_info variant
 
 This returns an Array which contains the response data, status code and headers.
 
-> <Array(<SfvbBlogPostsResponse>, Integer, Hash)> list_sfvb_blog_posts_with_http_info(storefront_oid, opts)
+> <Array(<SfvbCommsListsResponse>, Integer, Hash)> list_sfvb_comms_lists_with_http_info(storefront_oid)
 
 ```ruby
 begin
-  # List the storefront's blog posts
-  data, status_code, headers = api_instance.list_sfvb_blog_posts_with_http_info(storefront_oid, opts)
+  # List the storefront's email lists
+  data, status_code, headers = api_instance.list_sfvb_comms_lists_with_http_info(storefront_oid)
   p status_code # => 2xx
   p headers # => { ... }
-  p data # => <SfvbBlogPostsResponse>
+  p data # => <SfvbCommsListsResponse>
 rescue UltracartClient::ApiError => e
-  puts "Error when calling SfvbApi->list_sfvb_blog_posts_with_http_info: #{e}"
+  puts "Error when calling SfvbApi->list_sfvb_comms_lists_with_http_info: #{e}"
 end
 ```
 
@@ -6298,13 +6806,10 @@ end
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **storefront_oid** | **Integer** |  |  |
-| **search** | **String** | Text to search for | [optional] |
-| **page** | **Integer** | Page number, starting at 1 | [optional] |
-| **page_size** | **Integer** | Posts per page, 1 to 100, default 50 | [optional] |
 
 ### Return type
 
-[**SfvbBlogPostsResponse**](SfvbBlogPostsResponse.md)
+[**SfvbCommsListsResponse**](SfvbCommsListsResponse.md)
 
 ### Authorization
 
@@ -6316,13 +6821,13 @@ end
 - **Accept**: application/json
 
 
-## list_sfvb_campaigns
+## list_sfvb_comms_segments
 
-> <SfvbCampaignsResponse> list_sfvb_campaigns(storefront_oid, opts)
+> <SfvbCommsSegmentsResponse> list_sfvb_comms_segments(storefront_oid)
 
-List the storefront's campaigns
+List the storefront's segments
 
-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. 
+Each segment's uuid, name and member count at its last rebuild, by name, for a campaign's memberships or a segment trigger.  Never its members or its rule.  Archived segments are left out. 
 
 
 ### Examples
@@ -6331,21 +6836,21 @@ One page of campaigns, newest first, each with its emails and postcards in step
 (No example for this operation).
 
 
-#### Using the list_sfvb_campaigns_with_http_info variant
+#### Using the list_sfvb_comms_segments_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)
+> <Array(<SfvbCommsSegmentsResponse>, Integer, Hash)> list_sfvb_comms_segments_with_http_info(storefront_oid)
 
 ```ruby
 begin
-  # List the storefront's campaigns
-  data, status_code, headers = api_instance.list_sfvb_campaigns_with_http_info(storefront_oid, opts)
+  # List the storefront's segments
+  data, status_code, headers = api_instance.list_sfvb_comms_segments_with_http_info(storefront_oid)
   p status_code # => 2xx
   p headers # => { ... }
-  p data # => <SfvbCampaignsResponse>
+  p data # => <SfvbCommsSegmentsResponse>
 rescue UltracartClient::ApiError => e
-  puts "Error when calling SfvbApi->list_sfvb_campaigns_with_http_info: #{e}"
+  puts "Error when calling SfvbApi->list_sfvb_comms_segments_with_http_info: #{e}"
 end
 ```
 
@@ -6354,14 +6859,10 @@ end
 | 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)
+[**SfvbCommsSegmentsResponse**](SfvbCommsSegmentsResponse.md)
 
 ### Authorization
 
@@ -9916,6 +10417,62 @@ end
 - **Accept**: application/json
 
 
+## update_sfvb_campaign
+
+> <SfvbCampaign> update_sfvb_campaign(storefront_oid, campaign_uuid, if_match, campaign_write_request)
+
+Change a campaign
+
+A field left out keeps its value; memberships replaces the whole set.  The status is never changed here.  Send the hash_sha256 you read as If-Match.  A scheduled, sending or sent campaign needs sfvb_publish, and a change to a scheduled one applies to the send that is coming.  notes lists any emails a sending domain change put back to needing review. 
+
+
+### Examples
+
+
+(No example for this operation).
+
+
+#### Using the update_sfvb_campaign_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<SfvbCampaign>, Integer, Hash)> update_sfvb_campaign_with_http_info(storefront_oid, campaign_uuid, if_match, campaign_write_request)
+
+```ruby
+begin
+  # Change a campaign
+  data, status_code, headers = api_instance.update_sfvb_campaign_with_http_info(storefront_oid, campaign_uuid, if_match, campaign_write_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <SfvbCampaign>
+rescue UltracartClient::ApiError => e
+  puts "Error when calling SfvbApi->update_sfvb_campaign_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **storefront_oid** | **Integer** |  |  |
+| **campaign_uuid** | **String** |  |  |
+| **if_match** | **String** | hash_sha256 from the last read.  Required; 428 when absent, 412 when stale. |  |
+| **campaign_write_request** | [**SfvbCampaignWriteRequest**](SfvbCampaignWriteRequest.md) | The fields to change |  |
+
+### Return type
+
+[**SfvbCampaign**](SfvbCampaign.md)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
 ## update_sfvb_comms_sending_domain
 
 > <SfvbCommsSendingDomain> update_sfvb_comms_sending_domain(domain, sending_domain)
@@ -10023,6 +10580,174 @@ end
 - **Accept**: application/json
 
 
+## update_sfvb_email
+
+> <SfvbEmail> update_sfvb_email(storefront_oid, email_uuid, if_match, email_update_request)
+
+Change a flow or campaign email's subject or preview text
+
+A field left out keeps its value.  Each is 5 to 150 characters on one line.  Send the hash_sha256 you read as If-Match.  An email in a sending flow or campaign needs sfvb_publish, as a body push does.  The merchant's content review rule applies, so an email waiting for review or rejected goes back to needing review.  An email suspended for spam is refused with sfvb.email_suspended. 
+
+
+### Examples
+
+
+(No example for this operation).
+
+
+#### Using the update_sfvb_email_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<SfvbEmail>, Integer, Hash)> update_sfvb_email_with_http_info(storefront_oid, email_uuid, if_match, email_update_request)
+
+```ruby
+begin
+  # Change a flow or campaign email's subject or preview text
+  data, status_code, headers = api_instance.update_sfvb_email_with_http_info(storefront_oid, email_uuid, if_match, email_update_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <SfvbEmail>
+rescue UltracartClient::ApiError => e
+  puts "Error when calling SfvbApi->update_sfvb_email_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **storefront_oid** | **Integer** |  |  |
+| **email_uuid** | **String** |  |  |
+| **if_match** | **String** | hash_sha256 from the last read.  Required; 428 when absent, 412 when stale. |  |
+| **email_update_request** | [**SfvbEmailUpdateRequest**](SfvbEmailUpdateRequest.md) | The subject or preview text to change |  |
+
+### Return type
+
+[**SfvbEmail**](SfvbEmail.md)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## update_sfvb_flow
+
+> <SfvbFlow> update_sfvb_flow(storefront_oid, flow_uuid, if_match, flow_write_request)
+
+Change a flow
+
+A field left out keeps its value.  The trigger and the status are never changed here.  Send the hash_sha256 you read as If-Match.  A flow that is enrolling customers needs sfvb_publish. 
+
+
+### Examples
+
+
+(No example for this operation).
+
+
+#### Using the update_sfvb_flow_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<SfvbFlow>, Integer, Hash)> update_sfvb_flow_with_http_info(storefront_oid, flow_uuid, if_match, flow_write_request)
+
+```ruby
+begin
+  # Change a flow
+  data, status_code, headers = api_instance.update_sfvb_flow_with_http_info(storefront_oid, flow_uuid, if_match, flow_write_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <SfvbFlow>
+rescue UltracartClient::ApiError => e
+  puts "Error when calling SfvbApi->update_sfvb_flow_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **storefront_oid** | **Integer** |  |  |
+| **flow_uuid** | **String** |  |  |
+| **if_match** | **String** | hash_sha256 from the last read.  Required; 428 when absent, 412 when stale. |  |
+| **flow_write_request** | [**SfvbFlowWriteRequest**](SfvbFlowWriteRequest.md) | The fields to change |  |
+
+### Return type
+
+[**SfvbFlow**](SfvbFlow.md)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## update_sfvb_flow_status
+
+> <SfvbFlow> update_sfvb_flow_status(storefront_oid, flow_uuid, if_match, flow_status_request)
+
+Turn a flow on or off
+
+active enrolls customers as they trigger the flow from now on, and they receive its emails.  inactive stops new enrollments.  Always needs sfvb_publish.  Send the hash_sha256 you read as If-Match. 
+
+
+### Examples
+
+
+(No example for this operation).
+
+
+#### Using the update_sfvb_flow_status_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<SfvbFlow>, Integer, Hash)> update_sfvb_flow_status_with_http_info(storefront_oid, flow_uuid, if_match, flow_status_request)
+
+```ruby
+begin
+  # Turn a flow on or off
+  data, status_code, headers = api_instance.update_sfvb_flow_status_with_http_info(storefront_oid, flow_uuid, if_match, flow_status_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <SfvbFlow>
+rescue UltracartClient::ApiError => e
+  puts "Error when calling SfvbApi->update_sfvb_flow_status_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **storefront_oid** | **Integer** |  |  |
+| **flow_uuid** | **String** |  |  |
+| **if_match** | **String** | hash_sha256 from the last read.  Required; 428 when absent, 412 when stale. |  |
+| **flow_status_request** | [**SfvbFlowStatusRequest**](SfvbFlowStatusRequest.md) | The status to set |  |
+
+### Return type
+
+[**SfvbFlow**](SfvbFlow.md)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
 ## update_sfvb_item_attribute_batch
 
 > <SfvbItemAttributeBatchResponse> update_sfvb_item_attribute_batch(storefront_oid, item_attribute_batch_request, opts)