ultracart_api 4.1.216 → 4.1.218

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c9d982114341675667b756d95ce82f8b73da11be370ae3be33c299498d979890
-  data.tar.gz: '018a0ed9d2b4b54698c322ffabf20ae0ba0eb71d5f00ca98e46cbf90d7b2a301'
+  metadata.gz: 225b3a66b4962c176ba067201c29121f79950832381cc717c214340000aafb3a
+  data.tar.gz: d43f8d8d977bd11ec459d11310ebfa2bdf9b87528be139eb01dc1bb2de82ab1b
 SHA512:
-  metadata.gz: 5cbd5537546c75260f4c6717a22f811552d27b7e99ccc18d5d34a38f97140f23a3169dcf66d165fd1c22816d34cc0bc094102e0fd66a60c199d01f79e306f5bd
-  data.tar.gz: f67506e1c0f8f1ac33c90e2e6d31d7abcc376f8d642814c6e51c7504bdd8b8ec48c97e0346e9ae6f3cc1f55fe7cb4e2468d34042a9c160b3704ce5587311d2f7
+  metadata.gz: 994f2227e6c61cc94015703d5403606720a5ca118b240f846267089ecdcb93a2b8bb4aad39585ec184c09611e2f9675414cc798b205bd5c800c9a4eda3c2c07a
+  data.tar.gz: ef3e3d00348397e4a86d1c29df56588681e4772346341d73e16d0e534de06edcc19c43aef6fa0fffbe0000fe1fef81888cb80ebcf499fc31fd89435ac797eefa

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.216
+- Package version: 4.1.218
 - 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.216'
+gem 'ultracart_api', '4.1.218'
 ```
 
 install:
@@ -505,6 +505,7 @@ Class | Method | HTTP request | Description
 *UltracartClient::SfvbApi* | [**delete_sfvb_redirect**](docs/SfvbApi.md#delete_sfvb_redirect) | **DELETE** /sfvb/storefronts/{storefront_oid}/redirects/{redirect_id} | Delete a redirect rule
 *UltracartClient::SfvbApi* | [**delete_sfvb_redirects**](docs/SfvbApi.md#delete_sfvb_redirects) | **POST** /sfvb/storefronts/{storefront_oid}/redirects/delete | Delete up to 5,000 redirect rules in one call
 *UltracartClient::SfvbApi* | [**delete_sfvb_secret_request**](docs/SfvbApi.md#delete_sfvb_secret_request) | **DELETE** /sfvb/secrets/{request_id} | Cancel a pending secret request
+*UltracartClient::SfvbApi* | [**delete_sfvb_sequence_step**](docs/SfvbApi.md#delete_sfvb_sequence_step) | **DELETE** /sfvb/storefronts/{storefront_oid}/sequences/{sequence_uuid}/steps/{step_uuid} | Remove one step
 *UltracartClient::SfvbApi* | [**detach_sfvb_blog_post_image**](docs/SfvbApi.md#detach_sfvb_blog_post_image) | **POST** /sfvb/storefronts/{storefront_oid}/blog_posts/{blog_post_oid}/images/detach | Detach an image from a blog post
 *UltracartClient::SfvbApi* | [**disable_sfvb_i18n_language**](docs/SfvbApi.md#disable_sfvb_i18n_language) | **POST** /sfvb/storefronts/{storefront_oid}/i18n/languages/{code}/disable | Disable a language
 *UltracartClient::SfvbApi* | [**disable_sfvb_upsell_offer**](docs/SfvbApi.md#disable_sfvb_upsell_offer) | **POST** /sfvb/storefronts/{storefront_oid}/upsell_offers/{upsell_offer_oid}/disable | Disable an upsell offer
@@ -528,6 +529,7 @@ Class | Method | HTTP request | Description
 *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_segment**](docs/SfvbApi.md#get_sfvb_comms_segment) | **GET** /sfvb/storefronts/{storefront_oid}/segments/{segment_uuid} | Read one segment, with its rule
 *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
 *UltracartClient::SfvbApi* | [**get_sfvb_comms_twilio_account**](docs/SfvbApi.md#get_sfvb_comms_twilio_account) | **GET** /sfvb/comms/twilio_account | Read the Twilio account
@@ -588,6 +590,7 @@ Class | Method | HTTP request | Description
 *UltracartClient::SfvbApi* | [**import_sfvb_redirects**](docs/SfvbApi.md#import_sfvb_redirects) | **POST** /sfvb/storefronts/{storefront_oid}/redirects/import | Apply a reviewed redirect import
 *UltracartClient::SfvbApi* | [**insert_sfvb_approval**](docs/SfvbApi.md#insert_sfvb_approval) | **POST** /sfvb/approvals | Request a human approval
 *UltracartClient::SfvbApi* | [**insert_sfvb_blog_post**](docs/SfvbApi.md#insert_sfvb_blog_post) | **POST** /sfvb/storefronts/{storefront_oid}/blog_posts | Create a blog post
+*UltracartClient::SfvbApi* | [**insert_sfvb_comms_segment**](docs/SfvbApi.md#insert_sfvb_comms_segment) | **POST** /sfvb/storefronts/{storefront_oid}/segments | Create a segment
 *UltracartClient::SfvbApi* | [**insert_sfvb_comms_sending_domain**](docs/SfvbApi.md#insert_sfvb_comms_sending_domain) | **POST** /sfvb/comms/sending_domains | Add a sending domain
 *UltracartClient::SfvbApi* | [**insert_sfvb_comms_twilio_account**](docs/SfvbApi.md#insert_sfvb_comms_twilio_account) | **POST** /sfvb/comms/twilio_account | Connect the Twilio account
 *UltracartClient::SfvbApi* | [**insert_sfvb_page**](docs/SfvbApi.md#insert_sfvb_page) | **POST** /sfvb/storefronts/{storefront_oid}/pages | Create a page
@@ -667,6 +670,7 @@ Class | Method | HTTP request | Description
 *UltracartClient::SfvbApi* | [**unshare_sfvb_library_entry**](docs/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
 *UltracartClient::SfvbApi* | [**update_sfvb_blog_post**](docs/SfvbApi.md#update_sfvb_blog_post) | **PUT** /sfvb/storefronts/{storefront_oid}/blog_posts/{blog_post_oid} | Change a blog post
 *UltracartClient::SfvbApi* | [**update_sfvb_campaign**](docs/SfvbApi.md#update_sfvb_campaign) | **PUT** /sfvb/storefronts/{storefront_oid}/campaigns/{campaign_uuid} | Change a campaign
+*UltracartClient::SfvbApi* | [**update_sfvb_comms_segment**](docs/SfvbApi.md#update_sfvb_comms_segment) | **PUT** /sfvb/storefronts/{storefront_oid}/segments/{segment_uuid} | Change a segment's name, rule or folder
 *UltracartClient::SfvbApi* | [**update_sfvb_comms_sending_domain**](docs/SfvbApi.md#update_sfvb_comms_sending_domain) | **PUT** /sfvb/comms/sending_domains/{domain} | Update a sending domain
 *UltracartClient::SfvbApi* | [**update_sfvb_comms_twilio_account**](docs/SfvbApi.md#update_sfvb_comms_twilio_account) | **PUT** /sfvb/comms/twilio_account | Update the Twilio account
 *UltracartClient::SfvbApi* | [**update_sfvb_email**](docs/SfvbApi.md#update_sfvb_email) | **PUT** /sfvb/storefronts/{storefront_oid}/emails/{email_uuid} | Change a flow or campaign email's subject or preview text
@@ -1931,6 +1935,10 @@ Class | Method | HTTP request | Description
  - [UltracartClient::SfvbCommsListsResponse](docs/SfvbCommsListsResponse.md)
  - [UltracartClient::SfvbCommsPostcard](docs/SfvbCommsPostcard.md)
  - [UltracartClient::SfvbCommsSegment](docs/SfvbCommsSegment.md)
+ - [UltracartClient::SfvbCommsSegmentDetail](docs/SfvbCommsSegmentDetail.md)
+ - [UltracartClient::SfvbCommsSegmentResponse](docs/SfvbCommsSegmentResponse.md)
+ - [UltracartClient::SfvbCommsSegmentUsedBy](docs/SfvbCommsSegmentUsedBy.md)
+ - [UltracartClient::SfvbCommsSegmentWriteRequest](docs/SfvbCommsSegmentWriteRequest.md)
  - [UltracartClient::SfvbCommsSegmentsResponse](docs/SfvbCommsSegmentsResponse.md)
  - [UltracartClient::SfvbCommsSendingDomain](docs/SfvbCommsSendingDomain.md)
  - [UltracartClient::SfvbCommsSendingDomainsResponse](docs/SfvbCommsSendingDomainsResponse.md)
@@ -2115,6 +2123,7 @@ Class | Method | HTTP request | Description
  - [UltracartClient::SfvbSequenceStep](docs/SfvbSequenceStep.md)
  - [UltracartClient::SfvbSequenceStepCreateRequest](docs/SfvbSequenceStepCreateRequest.md)
  - [UltracartClient::SfvbSequenceStepCreateResponse](docs/SfvbSequenceStepCreateResponse.md)
+ - [UltracartClient::SfvbSequenceStepDeleteResponse](docs/SfvbSequenceStepDeleteResponse.md)
  - [UltracartClient::SfvbSequenceStepUpdateRequest](docs/SfvbSequenceStepUpdateRequest.md)
  - [UltracartClient::SfvbSequenceStepUpdateResponse](docs/SfvbSequenceStepUpdateResponse.md)
  - [UltracartClient::SfvbServerLog](docs/SfvbServerLog.md)
@@ -2334,6 +2343,8 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 4.1.218 | 10/30/2026 | svfb internal testing |
+| 4.1.217 | 10/29/2026 | sfvb internal testing |
 | 4.1.216 | 10/29/2026 | sfvb internal testing |
 | 4.1.215 | 10/28/2026 | sfvb internal testing |
 | 4.1.214 | 10/28/2026 | sfvb internal testing |

data/docs/SfvbApi.md

@@ -33,6 +33,7 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
 | [**delete_sfvb_redirect**](SfvbApi.md#delete_sfvb_redirect) | **DELETE** /sfvb/storefronts/{storefront_oid}/redirects/{redirect_id} | Delete a redirect rule |
 | [**delete_sfvb_redirects**](SfvbApi.md#delete_sfvb_redirects) | **POST** /sfvb/storefronts/{storefront_oid}/redirects/delete | Delete up to 5,000 redirect rules in one call |
 | [**delete_sfvb_secret_request**](SfvbApi.md#delete_sfvb_secret_request) | **DELETE** /sfvb/secrets/{request_id} | Cancel a pending secret request |
+| [**delete_sfvb_sequence_step**](SfvbApi.md#delete_sfvb_sequence_step) | **DELETE** /sfvb/storefronts/{storefront_oid}/sequences/{sequence_uuid}/steps/{step_uuid} | Remove one step |
 | [**detach_sfvb_blog_post_image**](SfvbApi.md#detach_sfvb_blog_post_image) | **POST** /sfvb/storefronts/{storefront_oid}/blog_posts/{blog_post_oid}/images/detach | Detach an image from a blog post |
 | [**disable_sfvb_i18n_language**](SfvbApi.md#disable_sfvb_i18n_language) | **POST** /sfvb/storefronts/{storefront_oid}/i18n/languages/{code}/disable | Disable a language |
 | [**disable_sfvb_upsell_offer**](SfvbApi.md#disable_sfvb_upsell_offer) | **POST** /sfvb/storefronts/{storefront_oid}/upsell_offers/{upsell_offer_oid}/disable | Disable an upsell offer |
@@ -56,6 +57,7 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
 | [**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_segment**](SfvbApi.md#get_sfvb_comms_segment) | **GET** /sfvb/storefronts/{storefront_oid}/segments/{segment_uuid} | Read one segment, with its rule |
 | [**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 |
 | [**get_sfvb_comms_twilio_account**](SfvbApi.md#get_sfvb_comms_twilio_account) | **GET** /sfvb/comms/twilio_account | Read the Twilio account |
@@ -116,6 +118,7 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
 | [**import_sfvb_redirects**](SfvbApi.md#import_sfvb_redirects) | **POST** /sfvb/storefronts/{storefront_oid}/redirects/import | Apply a reviewed redirect import |
 | [**insert_sfvb_approval**](SfvbApi.md#insert_sfvb_approval) | **POST** /sfvb/approvals | Request a human approval |
 | [**insert_sfvb_blog_post**](SfvbApi.md#insert_sfvb_blog_post) | **POST** /sfvb/storefronts/{storefront_oid}/blog_posts | Create a blog post |
+| [**insert_sfvb_comms_segment**](SfvbApi.md#insert_sfvb_comms_segment) | **POST** /sfvb/storefronts/{storefront_oid}/segments | Create a segment |
 | [**insert_sfvb_comms_sending_domain**](SfvbApi.md#insert_sfvb_comms_sending_domain) | **POST** /sfvb/comms/sending_domains | Add a sending domain |
 | [**insert_sfvb_comms_twilio_account**](SfvbApi.md#insert_sfvb_comms_twilio_account) | **POST** /sfvb/comms/twilio_account | Connect the Twilio account |
 | [**insert_sfvb_page**](SfvbApi.md#insert_sfvb_page) | **POST** /sfvb/storefronts/{storefront_oid}/pages | Create a page |
@@ -195,6 +198,7 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
 | [**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_segment**](SfvbApi.md#update_sfvb_comms_segment) | **PUT** /sfvb/storefronts/{storefront_oid}/segments/{segment_uuid} | Change a segment's name, rule or folder |
 | [**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 |
@@ -1793,6 +1797,63 @@ end
 - **Accept**: application/json
 
 
+## delete_sfvb_sequence_step
+
+> <SfvbSequenceStepDeleteResponse> delete_sfvb_sequence_step(storefront_oid, sequence_uuid, step_uuid, if_match, opts)
+
+Remove one step
+
+Removes the step from its list and links the step before it to the step after it, in one transaction.  An email, experiment or postcard step's email or postcard is archived with it.  Refused while any customer is waiting on the step, for the begin, end, continue and merge markers, for a condition, split or inboxgeek step with steps on a side, and for a step whose email a resend step re-sends.  Send the step's hash_sha256 as If-Match.  A sequence whose campaign or flow is live needs sfvb_publish and an approved sequence_step.delete approval (Approval-Id); a draft or inactive one needs neither.  An email or postcard another step still uses is left as it is. 
+
+
+### Examples
+
+
+(No example for this operation).
+
+
+#### Using the delete_sfvb_sequence_step_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<SfvbSequenceStepDeleteResponse>, Integer, Hash)> delete_sfvb_sequence_step_with_http_info(storefront_oid, sequence_uuid, step_uuid, if_match, opts)
+
+```ruby
+begin
+  # Remove one step
+  data, status_code, headers = api_instance.delete_sfvb_sequence_step_with_http_info(storefront_oid, sequence_uuid, step_uuid, if_match, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <SfvbSequenceStepDeleteResponse>
+rescue UltracartClient::ApiError => e
+  puts "Error when calling SfvbApi->delete_sfvb_sequence_step_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **storefront_oid** | **Integer** |  |  |
+| **sequence_uuid** | **String** |  |  |
+| **step_uuid** | **String** |  |  |
+| **if_match** | **String** | The step&#39;s hash_sha256 from the last read.  Required; 428 when absent, 412 when stale. |  |
+| **approval_id** | **String** | When the sequence is live, the approval_id of an approved sequence_step.delete request for this step.  See POST /sfvb/approvals. | [optional] |
+
+### Return type
+
+[**SfvbSequenceStepDeleteResponse**](SfvbSequenceStepDeleteResponse.md)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
 ## detach_sfvb_blog_post_image
 
 > <SfvbBlogPostDetail> detach_sfvb_blog_post_image(storefront_oid, blog_post_oid, blog_post_image_request)
@@ -3039,6 +3100,60 @@ end
 - **Accept**: application/json
 
 
+## get_sfvb_comms_segment
+
+> <SfvbCommsSegmentResponse> get_sfvb_comms_segment(storefront_oid, segment_uuid)
+
+Read one segment, with its rule
+
+The segment's name, folder, rule, member count at its last rebuild, whether a rebuild is still due, and the campaigns and flows that use it, each with whether it is live.  hash_sha256 is the If-Match for an update.  Never its members, its Facebook audience, its ranking or its third party sync settings. 
+
+
+### Examples
+
+
+(No example for this operation).
+
+
+#### Using the get_sfvb_comms_segment_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<SfvbCommsSegmentResponse>, Integer, Hash)> get_sfvb_comms_segment_with_http_info(storefront_oid, segment_uuid)
+
+```ruby
+begin
+  # Read one segment, with its rule
+  data, status_code, headers = api_instance.get_sfvb_comms_segment_with_http_info(storefront_oid, segment_uuid)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <SfvbCommsSegmentResponse>
+rescue UltracartClient::ApiError => e
+  puts "Error when calling SfvbApi->get_sfvb_comms_segment_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **storefront_oid** | **Integer** |  |  |
+| **segment_uuid** | **String** |  |  |
+
+### Return type
+
+[**SfvbCommsSegmentResponse**](SfvbCommsSegmentResponse.md)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
 ## get_sfvb_comms_sending_domain
 
 > <SfvbCommsSendingDomain> get_sfvb_comms_sending_domain(domain)
@@ -6284,6 +6399,60 @@ end
 - **Accept**: application/json
 
 
+## insert_sfvb_comms_segment
+
+> <SfvbCommsSegmentResponse> insert_sfvb_comms_segment(storefront_oid, segment_write_request)
+
+Create a segment
+
+A new segment with the name, rule and folder given.  The rule needs at least one group, each with at least one function of a rule type the segment rebuild knows, and any list or segment it names must be on this storefront.  The segment starts empty and rebuilds in the background; member_count is out of date until rebuild_required is false. 
+
+
+### Examples
+
+
+(No example for this operation).
+
+
+#### Using the insert_sfvb_comms_segment_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<SfvbCommsSegmentResponse>, Integer, Hash)> insert_sfvb_comms_segment_with_http_info(storefront_oid, segment_write_request)
+
+```ruby
+begin
+  # Create a segment
+  data, status_code, headers = api_instance.insert_sfvb_comms_segment_with_http_info(storefront_oid, segment_write_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <SfvbCommsSegmentResponse>
+rescue UltracartClient::ApiError => e
+  puts "Error when calling SfvbApi->insert_sfvb_comms_segment_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **storefront_oid** | **Integer** |  |  |
+| **segment_write_request** | [**SfvbCommsSegmentWriteRequest**](SfvbCommsSegmentWriteRequest.md) | The new segment&#39;s name, rule and folder |  |
+
+### Return type
+
+[**SfvbCommsSegmentResponse**](SfvbCommsSegmentResponse.md)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
 ## insert_sfvb_comms_sending_domain
 
 > <SfvbCommsSendingDomain> insert_sfvb_comms_sending_domain(sending_domain)
@@ -6557,7 +6726,7 @@ end
 
 Add an email step, with its new email
 
-Creates a new email with the subject and preview text and adds the email step that sends it, together, so a failure leaves neither.  It goes right after after_step_uuid, or first on one side of a condition, split or inboxgeek step (branch_step_uuid with side).  Send that step's hash_sha256 as If-Match.  The email has no body yet, and gets the content review flags the admin gives a new email here.  A sequence whose campaign or flow is live needs sfvb_publish. 
+Creates a new email with the subject and preview text and adds the email step that sends it, together, so a failure leaves neither.  It goes right after after_step_uuid, or first on one side of a condition, split or inboxgeek step (branch_step_uuid with side).  Send that step's hash_sha256 as If-Match.  A sequence with no steps yet takes neither place and If-Match *, and gets begin and end steps around the email, as the admin's editor adds them.  The email has no body yet, and gets the content review flags the admin gives a new email here.  A sequence whose campaign or flow is live needs sfvb_publish. 
 
 
 ### Examples
@@ -6590,7 +6759,7 @@ end
 | ---- | ---- | ----------- | ----- |
 | **storefront_oid** | **Integer** |  |  |
 | **sequence_uuid** | **String** |  |  |
-| **if_match** | **String** | The hash_sha256 of the step it goes after, or of the branching step.  Required; 428 when absent, 412 when stale. |  |
+| **if_match** | **String** | The hash_sha256 of the step it goes after, or of the branching step, or * for the first step of a sequence with no steps.  Required; 428 when absent, 412 when stale. |  |
 | **sequence_step_create_request** | [**SfvbSequenceStepCreateRequest**](SfvbSequenceStepCreateRequest.md) | Where the step goes, and the new email&#39;s subject and preview text |  |
 
 ### Return type
@@ -10643,6 +10812,63 @@ end
 - **Accept**: application/json
 
 
+## update_sfvb_comms_segment
+
+> <SfvbCommsSegmentResponse> update_sfvb_comms_segment(storefront_oid, segment_uuid, if_match, segment_write_request, opts)
+
+Change a segment's name, rule or folder
+
+A field left out stays as it is.  Send the segment's hash_sha256 as If-Match; the change applies only while the name, rule and folder are still what was read.  A changed rule is checked as on a create and starts a rebuild.  Changing the rule of a segment a live campaign or flow uses needs sfvb_publish and an approved segment.update approval (Approval-Id); a name or folder change, or a segment nothing live uses, needs neither. 
+
+
+### Examples
+
+
+(No example for this operation).
+
+
+#### Using the update_sfvb_comms_segment_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<SfvbCommsSegmentResponse>, Integer, Hash)> update_sfvb_comms_segment_with_http_info(storefront_oid, segment_uuid, if_match, segment_write_request, opts)
+
+```ruby
+begin
+  # Change a segment's name, rule or folder
+  data, status_code, headers = api_instance.update_sfvb_comms_segment_with_http_info(storefront_oid, segment_uuid, if_match, segment_write_request, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <SfvbCommsSegmentResponse>
+rescue UltracartClient::ApiError => e
+  puts "Error when calling SfvbApi->update_sfvb_comms_segment_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **storefront_oid** | **Integer** |  |  |
+| **segment_uuid** | **String** |  |  |
+| **if_match** | **String** | The segment&#39;s hash_sha256 from the last read.  Required; 428 when absent, 412 when stale. |  |
+| **segment_write_request** | [**SfvbCommsSegmentWriteRequest**](SfvbCommsSegmentWriteRequest.md) | The fields to change |  |
+| **approval_id** | **String** | When the rule changes and a live campaign or flow uses the segment, the approval_id of an approved segment.update request for this change.  See POST /sfvb/approvals. | [optional] |
+
+### Return type
+
+[**SfvbCommsSegmentResponse**](SfvbCommsSegmentResponse.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)

data/docs/SfvbApprovalCreateRequest.md

@@ -12,6 +12,7 @@
 | **params** | [**SfvbApprovalParams**](SfvbApprovalParams.md) |  | [optional] |
 | **reason** | **String** | Why the agent wants to do this, in a sentence.  Shown to the person as unverified text, capped at 500 characters. | [optional] |
 | **redirect_rows** | [**Array<SfvbRedirectDeleteRow>**](SfvbRedirectDeleteRow.md) | For redirect.delete_batch, exactly the rows the batch delete will send, up to 5,000, each with its hash_sha256.  UltraCart keeps only their hash. | [optional] |
+| **segment_update** | [**SfvbCommsSegmentWriteRequest**](SfvbCommsSegmentWriteRequest.md) |  | [optional] |
 
 ## Example
 
@@ -26,7 +27,8 @@ instance = UltracartClient::SfvbApprovalCreateRequest.new(
   item_pricing: null,
   params: null,
   reason: null,
-  redirect_rows: null
+  redirect_rows: null,
+  segment_update: null
 )
 ```
 

data/docs/SfvbApprovalParams.md

@@ -16,7 +16,10 @@
 | **request_sha256** | **String** | For experiment.start of a url experiment, the hash of the checked experiment approved, and for item.pricing the hash of the change.  Set by the server.  The gated call must send the same. | [optional] |
 | **rows_sha256** | **String** | For redirect.delete_batch and item.attribute_batch, the plan_hash of the exact rows approved.  Set by the server.  The batch must send rows with this hash. | [optional] |
 | **rule_count** | **Integer** | For redirect.delete_batch, how many rules the batch would delete when it was requested.  Set by the server. | [optional] |
+| **segment_uuid** | **String** | The segment whose rule changes, for segment.update. | [optional] |
+| **sequence_uuid** | **String** | The communication sequence, for sequence_step.delete. | [optional] |
 | **slot** | **String** | For experiment.start of a page experiment, the page body name.  Defaults to body. | [optional] |
+| **step_uuid** | **String** | The step to remove, for sequence_step.delete. | [optional] |
 | **upsell_kind** | **String** | For upsell.enable, what to switch on. | [optional] |
 | **upsell_oid** | **Integer** | For upsell.enable, the oid of the offer or path to switch on. | [optional] |
 | **version** | **Integer** | For file.put_script, the history version a revert restores.  Leave it out, and send content instead, for a write. | [optional] |
@@ -41,7 +44,10 @@ instance = UltracartClient::SfvbApprovalParams.new(
   request_sha256: null,
   rows_sha256: null,
   rule_count: null,
+  segment_uuid: null,
+  sequence_uuid: null,
   slot: null,
+  step_uuid: null,
   upsell_kind: null,
   upsell_oid: null,
   version: null,

data/docs/SfvbCommsSegmentDetail.md

@@ -0,0 +1,38 @@
+# UltracartClient::SfvbCommsSegmentDetail
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **created_dts** | **String** | When it was created (ISO 8601, UTC). | [optional] |
+| **filter_profile_equation_json** | **String** | The rule, as JSON text in the admin editor's shape.  Every entry in groups must hold, and inside a group one function is enough. | [optional] |
+| **folder_uuid** | **String** | The list and segment folder it is filed in, or absent. | [optional] |
+| **hash_sha256** | **String** | Send as If-Match on an update.  Covers the name, the rule and the folder. | [optional] |
+| **member_count** | **Integer** | How many customers it held at its last rebuild.  Out of date while rebuild_required is true. | [optional] |
+| **name** | **String** | The segment name. | [optional] |
+| **rebuild_nightly** | **Boolean** | True when the rule has a date range, so the segment is also rebuilt every night. | [optional] |
+| **rebuild_percentage** | **Float** | How far the current rebuild has got, when one is running. | [optional] |
+| **rebuild_required** | **Boolean** | True when the rule changed and the segment has not finished rebuilding. | [optional] |
+| **segment_uuid** | **String** | The segment uuid. | [optional] |
+| **used_by** | [**Array<SfvbCommsSegmentUsedBy>**](SfvbCommsSegmentUsedBy.md) | The campaigns that send to it and the flows it starts. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbCommsSegmentDetail.new(
+  created_dts: null,
+  filter_profile_equation_json: null,
+  folder_uuid: null,
+  hash_sha256: null,
+  member_count: null,
+  name: null,
+  rebuild_nightly: null,
+  rebuild_percentage: null,
+  rebuild_required: null,
+  segment_uuid: null,
+  used_by: null
+)
+```
+

data/docs/SfvbCommsSegmentResponse.md

@@ -0,0 +1,20 @@
+# UltracartClient::SfvbCommsSegmentResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **notes** | **Array<String>** | What happens next, such as the rebuild a changed rule starts. | [optional] |
+| **segment** | [**SfvbCommsSegmentDetail**](SfvbCommsSegmentDetail.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbCommsSegmentResponse.new(
+  notes: null,
+  segment: null
+)
+```
+

data/docs/SfvbCommsSegmentUsedBy.md

@@ -0,0 +1,24 @@
+# UltracartClient::SfvbCommsSegmentUsedBy
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **live** | **Boolean** | True when the campaign or flow reaches customers now, so a change to the rule changes who gets its mail. | [optional] |
+| **name** | **String** | The campaign or flow name. | [optional] |
+| **type** | **String** | campaign or flow. | [optional] |
+| **uuid** | **String** | The campaign or flow uuid. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbCommsSegmentUsedBy.new(
+  live: null,
+  name: null,
+  type: null,
+  uuid: null
+)
+```
+

data/docs/SfvbCommsSegmentWriteRequest.md

@@ -0,0 +1,22 @@
+# UltracartClient::SfvbCommsSegmentWriteRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **filter_profile_equation_json** | **String** | The rule, as JSON text in the admin editor's shape.  Required on a create.  At least one group, each with at least one function, each of a rule type the segment rebuild knows. | [optional] |
+| **folder_uuid** | **String** | A list and segment folder on this storefront.  An empty string takes the segment out of its folder. | [optional] |
+| **name** | **String** | The segment name.  Required on a create. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbCommsSegmentWriteRequest.new(
+  filter_profile_equation_json: null,
+  folder_uuid: null,
+  name: null
+)
+```
+

data/docs/SfvbSequenceStepDeleteResponse.md

@@ -0,0 +1,24 @@
+# UltracartClient::SfvbSequenceStepDeleteResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **archived_email_uuids** | **Array<String>** | The emails the step sent, now archived. | [optional] |
+| **archived_postcard_uuids** | **Array<String>** | The postcard the step sent, now archived. | [optional] |
+| **notes** | **Array<String>** | What was removed and archived, in words. | [optional] |
+| **removed_step_uuids** | **Array<String>** | The step removed, then any end, continue or merge markers that were on its sides. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbSequenceStepDeleteResponse.new(
+  archived_email_uuids: null,
+  archived_postcard_uuids: null,
+  notes: null,
+  removed_step_uuids: null
+)
+```
+