ultracart_api 4.1.207 → 4.1.208

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6744f4e0dacef9815b35ba7d361ad6c3a004b2082087fe5dd2bf8a9080a39b7b
-  data.tar.gz: 736cbe24406af15bbc288eb879458f7164de9bbf7be7eb91f03d3cc033636ceb
+  metadata.gz: 62fd7064999430105ea3b09ae20d62424894503c5c05d5cbc581fc37bf6a1436
+  data.tar.gz: 9cd9c6fed78ad9ea47e21e1e4749f0f44ce6b11f04090e3c2e615fe4958c0b95
 SHA512:
-  metadata.gz: 971ad17902b7469aa50522e4493d8f50f6fd9e47c9ab76aeef4e4e6980317142dd04f8ad0e244267b278eafedc0c8d3fa62fddbcaf1cf19f497a60662b739389
-  data.tar.gz: a418834642c184d169ae942a84c4c1096bb191de93afa545eb8b7dafd704f423293a2079cbac1e137999827c578048d366d30a63b1c82b7348868ad8a6dbeeff
+  metadata.gz: '099e55cb7722932b2cfcaa08420ea5ef89679facce8d0c52b3c3532d0297eb866923a830d997589e4b59f22d86b62766ecadcfaa2e33cbc804a18fdfe1064dee'
+  data.tar.gz: 45f76315807bc93a073ff2caf262a6508eea9e56629d730726ec514027d75d8557b921f76ba1cd3f9d51275b358daa7397d3915e8a8d00ee8193e0472ed1ff45

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.207
+- Package version: 4.1.208
 - 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.207'
+gem 'ultracart_api', '4.1.208'
 ```
 
 install:
@@ -528,6 +528,7 @@ Class | Method | HTTP request | Description
 *UltracartClient::SfvbApi* | [**get_sfvb_container**](docs/SfvbApi.md#get_sfvb_container) | **GET** /sfvb/storefronts/{storefront_oid}/containers/{owner_type}/{owner_object_id} | Read a container stored outside the file system
 *UltracartClient::SfvbApi* | [**get_sfvb_container_version**](docs/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
 *UltracartClient::SfvbApi* | [**get_sfvb_element**](docs/SfvbApi.md#get_sfvb_element) | **GET** /sfvb/elements/{element_type} | Configuration schema and field card for one element type
+*UltracartClient::SfvbApi* | [**get_sfvb_email**](docs/SfvbApi.md#get_sfvb_email) | **GET** /sfvb/storefronts/{storefront_oid}/emails/{email_uuid} | Get a flow or campaign email's subject and preview text
 *UltracartClient::SfvbApi* | [**get_sfvb_events**](docs/SfvbApi.md#get_sfvb_events) | **GET** /sfvb/events | Replay events
 *UltracartClient::SfvbApi* | [**get_sfvb_events_authorization**](docs/SfvbApi.md#get_sfvb_events_authorization) | **PUT** /sfvb/events/auth | Open the event stream
 *UltracartClient::SfvbApi* | [**get_sfvb_experiment**](docs/SfvbApi.md#get_sfvb_experiment) | **GET** /sfvb/storefronts/{storefront_oid}/experiments/{experiment_oid} | Read one experiment and its statistics
@@ -656,6 +657,7 @@ Class | Method | HTTP request | Description
 *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_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
 *UltracartClient::SfvbApi* | [**update_sfvb_item_attribute_batch**](docs/SfvbApi.md#update_sfvb_item_attribute_batch) | **POST** /sfvb/storefronts/{storefront_oid}/items/attributes/batch | Change attributes across many items in one call
 *UltracartClient::SfvbApi* | [**update_sfvb_library_entry**](docs/SfvbApi.md#update_sfvb_library_entry) | **PUT** /sfvb/storefronts/{storefront_oid}/library/{library_oid} | Update a library entry's draft
 *UltracartClient::SfvbApi* | [**update_sfvb_redirect**](docs/SfvbApi.md#update_sfvb_redirect) | **PUT** /sfvb/storefronts/{storefront_oid}/redirects/{redirect_id} | Change a redirect rule
@@ -1922,8 +1924,10 @@ Class | Method | HTTP request | Description
  - [UltracartClient::SfvbElement](docs/SfvbElement.md)
  - [UltracartClient::SfvbElementSchemaResponse](docs/SfvbElementSchemaResponse.md)
  - [UltracartClient::SfvbElementsResponse](docs/SfvbElementsResponse.md)
+ - [UltracartClient::SfvbEmail](docs/SfvbEmail.md)
  - [UltracartClient::SfvbEmailRenderRequest](docs/SfvbEmailRenderRequest.md)
  - [UltracartClient::SfvbEmailRenderResponse](docs/SfvbEmailRenderResponse.md)
+ - [UltracartClient::SfvbEmailUpdateRequest](docs/SfvbEmailUpdateRequest.md)
  - [UltracartClient::SfvbErrorDetail](docs/SfvbErrorDetail.md)
  - [UltracartClient::SfvbEvent](docs/SfvbEvent.md)
  - [UltracartClient::SfvbEventsAuthRequest](docs/SfvbEventsAuthRequest.md)
@@ -2297,6 +2301,7 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 4.1.208 | 10/26/2026 | sfvb internal testing |
 | 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 |

data/docs/SfvbApi.md

@@ -56,6 +56,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 |
@@ -184,6 +185,7 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
 | [**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_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_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 |
@@ -3015,6 +3017,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)
@@ -10023,6 +10079,62 @@ 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_item_attribute_batch
 
 > <SfvbItemAttributeBatchResponse> update_sfvb_item_attribute_batch(storefront_oid, item_attribute_batch_request, opts)

data/docs/SfvbEmail.md

@@ -0,0 +1,40 @@
+# UltracartClient::SfvbEmail
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **container_last_modified_dts** | **String** | When the email container was last changed (ISO 8601, UTC). | [optional] |
+| **email_uuid** | **String** | The email uuid.  The same uuid the email container (owner type email) and the email render take. | [optional] |
+| **hash_sha256** | **String** | Hash of the subject and preview text.  Send it as If-Match when updating.  A change to the email body does not change it. | [optional] |
+| **live** | **Boolean** | True when the email is in a flow or campaign that is sending, so a change reaches customers and needs sfvb_publish.  An email in neither is reported live. | [optional] |
+| **pending_review** | **Boolean** | True while a change waits for review.  An edit puts it back to needing review. | [optional] |
+| **preview_text** | **String** | The preview text an inbox shows after the subject. | [optional] |
+| **rejected** | **Boolean** | True when review rejected the email.  An edit puts it back to needing review. | [optional] |
+| **requires_review** | **Boolean** | True when a change to this email must be reviewed before it sends. | [optional] |
+| **subject** | **String** | The subject line.  Merge tokens such as firstName are filled in at send. | [optional] |
+| **suspended_for_spam** | **Boolean** | True when UltraCart suspended the email for spam.  Edits are refused until the merchant resolves it with UltraCart support. | [optional] |
+| **transactional** | **Boolean** | True for a transactional email, which skips the marketing footer rules. | [optional] |
+| **version** | **Integer** | The email version.  Every save adds one. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbEmail.new(
+  container_last_modified_dts: null,
+  email_uuid: null,
+  hash_sha256: null,
+  live: null,
+  pending_review: null,
+  preview_text: null,
+  rejected: null,
+  requires_review: null,
+  subject: null,
+  suspended_for_spam: null,
+  transactional: null,
+  version: null
+)
+```
+

data/docs/SfvbEmailUpdateRequest.md

@@ -0,0 +1,20 @@
+# UltracartClient::SfvbEmailUpdateRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **preview_text** | **String** | The new preview text, 5 to 150 characters on one line. | [optional] |
+| **subject** | **String** | The new subject line, 5 to 150 characters on one line.  Merge tokens such as firstName are filled in at send. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbEmailUpdateRequest.new(
+  preview_text: null,
+  subject: null
+)
+```
+

data/lib/ultracart_api/api/sfvb_api.rb

@@ -3797,6 +3797,76 @@ module UltracartClient
       return data, status_code, headers
     end
 
+    # 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. 
+    # @param storefront_oid [Integer] 
+    # @param email_uuid [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [SfvbEmail]
+    def get_sfvb_email(storefront_oid, email_uuid, opts = {})
+      data, _status_code, _headers = get_sfvb_email_with_http_info(storefront_oid, email_uuid, opts)
+      data
+    end
+
+    # 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. 
+    # @param storefront_oid [Integer] 
+    # @param email_uuid [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(SfvbEmail, Integer, Hash)>] SfvbEmail data, response status code and response headers
+    def get_sfvb_email_with_http_info(storefront_oid, email_uuid, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: SfvbApi.get_sfvb_email ...'
+      end
+      # verify the required parameter 'storefront_oid' is set
+      if @api_client.config.client_side_validation && storefront_oid.nil?
+        fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling SfvbApi.get_sfvb_email"
+      end
+      # verify the required parameter 'email_uuid' is set
+      if @api_client.config.client_side_validation && email_uuid.nil?
+        fail ArgumentError, "Missing the required parameter 'email_uuid' when calling SfvbApi.get_sfvb_email"
+      end
+      # resource path
+      local_var_path = '/sfvb/storefronts/{storefront_oid}/emails/{email_uuid}'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s)).sub('{' + 'email_uuid' + '}', CGI.escape(email_uuid.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'SfvbEmail'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
+
+      new_options = opts.merge(
+        :operation => :"SfvbApi.get_sfvb_email",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: SfvbApi#get_sfvb_email\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Replay events
     # The signed-in person's events after the cursor, oldest first.  Events are kept 72 hours; an older cursor returns resync_required, and then the caller re-lists what it was waiting on.  Events about one sign-in's requests, such as approvals, are only returned to that sign-in.  limit is 1 to 500, default 100. 
     # @param [Hash] opts the optional parameters
@@ -13273,6 +13343,94 @@ module UltracartClient
       return data, status_code, headers
     end
 
+    # 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. 
+    # @param storefront_oid [Integer] 
+    # @param email_uuid [String] 
+    # @param if_match [String] hash_sha256 from the last read.  Required; 428 when absent, 412 when stale.
+    # @param email_update_request [SfvbEmailUpdateRequest] The subject or preview text to change
+    # @param [Hash] opts the optional parameters
+    # @return [SfvbEmail]
+    def update_sfvb_email(storefront_oid, email_uuid, if_match, email_update_request, opts = {})
+      data, _status_code, _headers = update_sfvb_email_with_http_info(storefront_oid, email_uuid, if_match, email_update_request, opts)
+      data
+    end
+
+    # Change a flow or campaign email&#39;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&#39;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. 
+    # @param storefront_oid [Integer] 
+    # @param email_uuid [String] 
+    # @param if_match [String] hash_sha256 from the last read.  Required; 428 when absent, 412 when stale.
+    # @param email_update_request [SfvbEmailUpdateRequest] The subject or preview text to change
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(SfvbEmail, Integer, Hash)>] SfvbEmail data, response status code and response headers
+    def update_sfvb_email_with_http_info(storefront_oid, email_uuid, if_match, email_update_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: SfvbApi.update_sfvb_email ...'
+      end
+      # verify the required parameter 'storefront_oid' is set
+      if @api_client.config.client_side_validation && storefront_oid.nil?
+        fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling SfvbApi.update_sfvb_email"
+      end
+      # verify the required parameter 'email_uuid' is set
+      if @api_client.config.client_side_validation && email_uuid.nil?
+        fail ArgumentError, "Missing the required parameter 'email_uuid' when calling SfvbApi.update_sfvb_email"
+      end
+      # verify the required parameter 'if_match' is set
+      if @api_client.config.client_side_validation && if_match.nil?
+        fail ArgumentError, "Missing the required parameter 'if_match' when calling SfvbApi.update_sfvb_email"
+      end
+      # verify the required parameter 'email_update_request' is set
+      if @api_client.config.client_side_validation && email_update_request.nil?
+        fail ArgumentError, "Missing the required parameter 'email_update_request' when calling SfvbApi.update_sfvb_email"
+      end
+      # resource path
+      local_var_path = '/sfvb/storefronts/{storefront_oid}/emails/{email_uuid}'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s)).sub('{' + 'email_uuid' + '}', CGI.escape(email_uuid.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+      header_params[:'If-Match'] = if_match
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(email_update_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'SfvbEmail'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
+
+      new_options = opts.merge(
+        :operation => :"SfvbApi.update_sfvb_email",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: SfvbApi#update_sfvb_email\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Change attributes across many items in one call
     # Applies exactly the change rows of a dry run, given its plan_hash, each with its merchant_item_oid and current_sha256.  Each item is saved once with all of its rows; a row whose value changed since the dry run is skipped as stale and never overwritten, and an item that cannot be saved does not stop the others.  Only the named attributes change.  Needs sfvb_publish and the approval of the person who signed in the CLI, an approved item.attribute_batch request for exactly these rows in the Approval-Id header. 
     # @param storefront_oid [Integer] 

data/lib/ultracart_api/models/item_third_party_email_marketing.rb

@@ -139,7 +139,7 @@ module UltracartClient
     # Check to see if the all the properties in the model are valid
     # @return true if the model is valid
     def valid?
-      provider_name_validator = EnumAttributeValidator.new('String', ["ActiveCampaign", "AWeber", "Campaign Monitor", "ConstantContact", "Emma", "GetResponse", "iContact", "Klaviyo", "Lyris", "LyrisHQ", "MailChimp"])
+      provider_name_validator = EnumAttributeValidator.new('String', ["ActiveCampaign", "AWeber", "Campaign Monitor", "ConstantContact", "Emma", "GetResponse", "iContact", "Klaviyo", "MailChimp"])
       return false unless provider_name_validator.valid?(@provider_name)
       true
     end
@@ -147,7 +147,7 @@ module UltracartClient
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] provider_name Object to be assigned
     def provider_name=(provider_name)
-      validator = EnumAttributeValidator.new('String', ["ActiveCampaign", "AWeber", "Campaign Monitor", "ConstantContact", "Emma", "GetResponse", "iContact", "Klaviyo", "Lyris", "LyrisHQ", "MailChimp"])
+      validator = EnumAttributeValidator.new('String', ["ActiveCampaign", "AWeber", "Campaign Monitor", "ConstantContact", "Emma", "GetResponse", "iContact", "Klaviyo", "MailChimp"])
       unless validator.valid?(provider_name)
         fail ArgumentError, "invalid value for \"provider_name\", must be one of #{validator.allowable_values}."
       end

data/lib/ultracart_api/models/sfvb_email.rb

@@ -0,0 +1,330 @@
+=begin
+#UltraCart Rest API V2
+
+#UltraCart REST API Version 2
+
+The version of the OpenAPI document: 2.0.0
+Contact: support@ultracart.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 6.0.1-SNAPSHOT
+
+=end
+
+require 'date'
+require 'time'
+
+module UltracartClient
+  class SfvbEmail
+    # When the email container was last changed (ISO 8601, UTC).
+    attr_accessor :container_last_modified_dts
+
+    # The email uuid.  The same uuid the email container (owner type email) and the email render take.
+    attr_accessor :email_uuid
+
+    # Hash of the subject and preview text.  Send it as If-Match when updating.  A change to the email body does not change it.
+    attr_accessor :hash_sha256
+
+    # True when the email is in a flow or campaign that is sending, so a change reaches customers and needs sfvb_publish.  An email in neither is reported live.
+    attr_accessor :live
+
+    # True while a change waits for review.  An edit puts it back to needing review.
+    attr_accessor :pending_review
+
+    # The preview text an inbox shows after the subject.
+    attr_accessor :preview_text
+
+    # True when review rejected the email.  An edit puts it back to needing review.
+    attr_accessor :rejected
+
+    # True when a change to this email must be reviewed before it sends.
+    attr_accessor :requires_review
+
+    # The subject line.  Merge tokens such as firstName are filled in at send.
+    attr_accessor :subject
+
+    # True when UltraCart suspended the email for spam.  Edits are refused until the merchant resolves it with UltraCart support.
+    attr_accessor :suspended_for_spam
+
+    # True for a transactional email, which skips the marketing footer rules.
+    attr_accessor :transactional
+
+    # The email version.  Every save adds one.
+    attr_accessor :version
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'container_last_modified_dts' => :'container_last_modified_dts',
+        :'email_uuid' => :'email_uuid',
+        :'hash_sha256' => :'hash_sha256',
+        :'live' => :'live',
+        :'pending_review' => :'pending_review',
+        :'preview_text' => :'preview_text',
+        :'rejected' => :'rejected',
+        :'requires_review' => :'requires_review',
+        :'subject' => :'subject',
+        :'suspended_for_spam' => :'suspended_for_spam',
+        :'transactional' => :'transactional',
+        :'version' => :'version'
+      }
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'container_last_modified_dts' => :'String',
+        :'email_uuid' => :'String',
+        :'hash_sha256' => :'String',
+        :'live' => :'Boolean',
+        :'pending_review' => :'Boolean',
+        :'preview_text' => :'String',
+        :'rejected' => :'Boolean',
+        :'requires_review' => :'Boolean',
+        :'subject' => :'String',
+        :'suspended_for_spam' => :'Boolean',
+        :'transactional' => :'Boolean',
+        :'version' => :'Integer'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `UltracartClient::SfvbEmail` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!self.class.attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `UltracartClient::SfvbEmail`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'container_last_modified_dts')
+        self.container_last_modified_dts = attributes[:'container_last_modified_dts']
+      end
+
+      if attributes.key?(:'email_uuid')
+        self.email_uuid = attributes[:'email_uuid']
+      end
+
+      if attributes.key?(:'hash_sha256')
+        self.hash_sha256 = attributes[:'hash_sha256']
+      end
+
+      if attributes.key?(:'live')
+        self.live = attributes[:'live']
+      end
+
+      if attributes.key?(:'pending_review')
+        self.pending_review = attributes[:'pending_review']
+      end
+
+      if attributes.key?(:'preview_text')
+        self.preview_text = attributes[:'preview_text']
+      end
+
+      if attributes.key?(:'rejected')
+        self.rejected = attributes[:'rejected']
+      end
+
+      if attributes.key?(:'requires_review')
+        self.requires_review = attributes[:'requires_review']
+      end
+
+      if attributes.key?(:'subject')
+        self.subject = attributes[:'subject']
+      end
+
+      if attributes.key?(:'suspended_for_spam')
+        self.suspended_for_spam = attributes[:'suspended_for_spam']
+      end
+
+      if attributes.key?(:'transactional')
+        self.transactional = attributes[:'transactional']
+      end
+
+      if attributes.key?(:'version')
+        self.version = attributes[:'version']
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      true
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          container_last_modified_dts == o.container_last_modified_dts &&
+          email_uuid == o.email_uuid &&
+          hash_sha256 == o.hash_sha256 &&
+          live == o.live &&
+          pending_review == o.pending_review &&
+          preview_text == o.preview_text &&
+          rejected == o.rejected &&
+          requires_review == o.requires_review &&
+          subject == o.subject &&
+          suspended_for_spam == o.suspended_for_spam &&
+          transactional == o.transactional &&
+          version == o.version
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [container_last_modified_dts, email_uuid, hash_sha256, live, pending_review, preview_text, rejected, requires_review, subject, suspended_for_spam, transactional, version].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      new.build_from_hash(attributes)
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      attributes = attributes.transform_keys(&:to_sym)
+      self.class.openapi_types.each_pair do |key, type|
+        if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
+          self.send("#{key}=", nil)
+        elsif type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[self.class.attribute_map[key]].is_a?(Array)
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        end
+      end
+
+      self
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def _deserialize(type, value)
+      case type.to_sym
+      when :Time
+        Time.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :Boolean
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        # models (e.g. Pet) or oneOf
+        klass = UltracartClient.const_get(type)
+        klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+
+  end
+
+end

data/lib/ultracart_api/models/sfvb_email_update_request.rb

@@ -0,0 +1,230 @@
+=begin
+#UltraCart Rest API V2
+
+#UltraCart REST API Version 2
+
+The version of the OpenAPI document: 2.0.0
+Contact: support@ultracart.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 6.0.1-SNAPSHOT
+
+=end
+
+require 'date'
+require 'time'
+
+module UltracartClient
+  class SfvbEmailUpdateRequest
+    # The new preview text, 5 to 150 characters on one line.
+    attr_accessor :preview_text
+
+    # The new subject line, 5 to 150 characters on one line.  Merge tokens such as firstName are filled in at send.
+    attr_accessor :subject
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'preview_text' => :'preview_text',
+        :'subject' => :'subject'
+      }
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'preview_text' => :'String',
+        :'subject' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `UltracartClient::SfvbEmailUpdateRequest` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!self.class.attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `UltracartClient::SfvbEmailUpdateRequest`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'preview_text')
+        self.preview_text = attributes[:'preview_text']
+      end
+
+      if attributes.key?(:'subject')
+        self.subject = attributes[:'subject']
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      true
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          preview_text == o.preview_text &&
+          subject == o.subject
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [preview_text, subject].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      new.build_from_hash(attributes)
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      attributes = attributes.transform_keys(&:to_sym)
+      self.class.openapi_types.each_pair do |key, type|
+        if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
+          self.send("#{key}=", nil)
+        elsif type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[self.class.attribute_map[key]].is_a?(Array)
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        end
+      end
+
+      self
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def _deserialize(type, value)
+      case type.to_sym
+      when :Time
+        Time.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :Boolean
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        # models (e.g. Pet) or oneOf
+        klass = UltracartClient.const_get(type)
+        klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+
+  end
+
+end

data/lib/ultracart_api/version.rb

@@ -11,5 +11,5 @@ OpenAPI Generator version: 6.0.1-SNAPSHOT
 =end
 
 module UltracartClient
-  VERSION = '4.1.207'
+  VERSION = '4.1.208'
 end

data/lib/ultracart_api.rb

@@ -1015,8 +1015,10 @@ require 'ultracart_api/models/sfvb_container_write_request'
 require 'ultracart_api/models/sfvb_element'
 require 'ultracart_api/models/sfvb_element_schema_response'
 require 'ultracart_api/models/sfvb_elements_response'
+require 'ultracart_api/models/sfvb_email'
 require 'ultracart_api/models/sfvb_email_render_request'
 require 'ultracart_api/models/sfvb_email_render_response'
+require 'ultracart_api/models/sfvb_email_update_request'
 require 'ultracart_api/models/sfvb_error_detail'
 require 'ultracart_api/models/sfvb_event'
 require 'ultracart_api/models/sfvb_events_auth_request'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ultracart_api
 version: !ruby/object:Gem::Version
-  version: 4.1.207
+  version: 4.1.208
 platform: ruby
 authors:
 - UltraCart
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-10-16 00:00:00.000000000 Z
+date: 2026-10-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus
@@ -1077,8 +1077,10 @@ files:
 - docs/SfvbElement.md
 - docs/SfvbElementSchemaResponse.md
 - docs/SfvbElementsResponse.md
+- docs/SfvbEmail.md
 - docs/SfvbEmailRenderRequest.md
 - docs/SfvbEmailRenderResponse.md
+- docs/SfvbEmailUpdateRequest.md
 - docs/SfvbErrorDetail.md
 - docs/SfvbEvent.md
 - docs/SfvbEventsAuthRequest.md
@@ -2408,8 +2410,10 @@ files:
 - lib/ultracart_api/models/sfvb_element.rb
 - lib/ultracart_api/models/sfvb_element_schema_response.rb
 - lib/ultracart_api/models/sfvb_elements_response.rb
+- lib/ultracart_api/models/sfvb_email.rb
 - lib/ultracart_api/models/sfvb_email_render_request.rb
 - lib/ultracart_api/models/sfvb_email_render_response.rb
+- lib/ultracart_api/models/sfvb_email_update_request.rb
 - lib/ultracart_api/models/sfvb_error_detail.rb
 - lib/ultracart_api/models/sfvb_event.rb
 - lib/ultracart_api/models/sfvb_events_auth_request.rb