ultracart_api 4.1.212 → 4.1.214

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: daa7439a4c2c9d9b5c10024beb9d848a7b728c9ff5d057a22923f9381802cf38
-  data.tar.gz: 5acd544d65144e915ecf68e29428ec9fd3ba8012fecbe54a992afa54b8fae08c
+  metadata.gz: c76d90feaffed5fdc1c86aaba08b05bcc3f21163982b7c26bdee0a8a9372fa9c
+  data.tar.gz: 0d64bbcea0beeff37dce23844c396733ee231506092bebb786dd05e3140b2fac
 SHA512:
-  metadata.gz: 9137149162a374efa7ab54e06cd729eae0046b7d82d08248d3e8fbfbb368098e57469ae74ce9a2cf3428e19acdddefe24c902a827c78abda8f0f89f0cb37ec91
-  data.tar.gz: 05c4be8139c905ef860a89b6c19ff9b3ed2557eef3975b3298a4720f538b37cda040b24861a92f5f3e9aea5270814ee6323f698b961c58af95f10119da73bae8
+  metadata.gz: 38e136135c74082c50fbadd078a84b4f3a14ff5746337a40eced51f7be9c013b53eb571e4da5a370a8c61621a7f7deafeacad36e379ca84a968fdf065609c476
+  data.tar.gz: 7710a60f4a7e92d619af5f0bd9e34d2a9ef75874704215f991b0c5c9d7f7e8707d2518e3cf242c3fc30b5c859e1379133c3af6535ee9d86bb85d9d5c5dc30f93

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.212
+- Package version: 4.1.214
 - 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.212'
+gem 'ultracart_api', '4.1.214'
 ```
 
 install:
@@ -674,6 +674,7 @@ Class | Method | HTTP request | Description
 *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
+*UltracartClient::SfvbApi* | [**update_sfvb_sequence_step**](docs/SfvbApi.md#update_sfvb_sequence_step) | **PUT** /sfvb/storefronts/{storefront_oid}/sequences/{sequence_uuid}/steps/{step_uuid} | Change one step's settings or audience filter
 *UltracartClient::SfvbApi* | [**update_sfvb_upsell_offer**](docs/SfvbApi.md#update_sfvb_upsell_offer) | **PUT** /sfvb/storefronts/{storefront_oid}/upsell_offers/{upsell_offer_oid} | Update an upsell offer
 *UltracartClient::SfvbApi* | [**update_sfvb_upsell_path**](docs/SfvbApi.md#update_sfvb_upsell_path) | **PUT** /sfvb/storefronts/{storefront_oid}/upsell_paths/{upsell_path_oid} | Update an upsell path
 *UltracartClient::SfvbApi* | [**upload_sfvb_file**](docs/SfvbApi.md#upload_sfvb_file) | **POST** /sfvb/storefronts/{storefront_oid}/files/upload | Store a binary asset that was already uploaded
@@ -2110,6 +2111,8 @@ Class | Method | HTTP request | Description
  - [UltracartClient::SfvbSequence](docs/SfvbSequence.md)
  - [UltracartClient::SfvbSequenceBranch](docs/SfvbSequenceBranch.md)
  - [UltracartClient::SfvbSequenceStep](docs/SfvbSequenceStep.md)
+ - [UltracartClient::SfvbSequenceStepUpdateRequest](docs/SfvbSequenceStepUpdateRequest.md)
+ - [UltracartClient::SfvbSequenceStepUpdateResponse](docs/SfvbSequenceStepUpdateResponse.md)
  - [UltracartClient::SfvbServerLog](docs/SfvbServerLog.md)
  - [UltracartClient::SfvbServerLogDetail](docs/SfvbServerLogDetail.md)
  - [UltracartClient::SfvbServerLogEntry](docs/SfvbServerLogEntry.md)
@@ -2327,6 +2330,8 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 4.1.214 | 10/28/2026 | sfvb internal testing |
+| 4.1.213 | 10/28/2026 | auto order - improve item field descriptions |
 | 4.1.212 | 10/27/2026 | conversation - pbx agent startup activity |
 | 4.1.211 | 10/27/2026 | sfvb internal testing |
 | 4.1.210 | 10/27/2026 | sfvb internal testing |

data/docs/AutoOrderItem.md

@@ -7,9 +7,9 @@
 | **add_ons** | [**Array<AutoOrderAddonItem>**](AutoOrderAddonItem.md) | Array of addon objects instructing which items to add to auto order and how many times they should be added. | [optional] |
 | **arbitrary_item_id** | **String** | Arbitrary item id that should be rebilled instead of the normal schedule | [optional] |
 | **arbitrary_percentage_discount** | **Float** | An arbitrary percentage discount to provide on future rebills | [optional] |
-| **arbitrary_quantity** | **Float** | Arbitrary quantity to rebill | [optional] |
+| **arbitrary_quantity** | **Float** | Quantity to rebill.  When set, every rebill uses this quantity instead of original_quantity.  Set this field to change the quantity on an active auto order; the merchant auto order editor updates this same field.  Each rebill charges the unit price multiplied by this quantity. | [optional] |
 | **arbitrary_schedule_days** | **Integer** | The number of days to rebill if the frequency is set to an arbitrary number of days | [optional] |
-| **arbitrary_unit_cost** | **Float** | Arbitrary unit cost that rebills of this item should occur at | [optional] |
+| **arbitrary_unit_cost** | **Float** | Arbitrary unit cost that rebills of this item should occur at.  This is a price per unit.  Each rebill charges it multiplied by the rebill quantity (arbitrary_quantity, or original_quantity when arbitrary_quantity is null). | [optional] |
 | **arbitrary_unit_cost_remaining_orders** | **Integer** | The number of rebills to give the arbitrary unit cost on before reverting to normal pricing. | [optional] |
 | **auto_order_item_oid** | **Integer** | Primary key of AutoOrderItem | [optional] |
 | **calculated_next_shipment_dts** | **String** | Calculated Date/time that this item is scheduled to rebill.  Will be null if no more shipments are going to occur on this item | [optional] |
@@ -27,7 +27,7 @@
 | **number_of_rebills** | **Integer** | The number of times this item has rebilled | [optional] |
 | **options** | [**Array<AutoOrderItemOption>**](AutoOrderItemOption.md) | Options associated with this item | [optional] |
 | **original_item_id** | **String** | The original item id purchased.  This item controls scheduling.  If you wish to modify a schedule, for example, from monthly to yearly, change this item from your monthly item to your yearly item, and then change the next_shipment_dts to your desired date. | [optional] |
-| **original_quantity** | **Float** | The original quantity purchased | [optional] |
+| **original_quantity** | **Float** | The quantity purchased on the original order.  Rebills use this quantity only when arbitrary_quantity is null.  To change the quantity on future rebills, set arbitrary_quantity instead. | [optional] |
 | **paused** | **Boolean** | True if paused.  This field is an object instead of a primitive for backwards compatibility. | [optional] |
 | **paypal_payer_id** | **String** | The PayPal Payer ID tied to this item | [optional] |
 | **paypal_recurring_payment_profile_id** | **String** | The PayPal Profile ID tied to this item | [optional] |

data/docs/SfvbApi.md

@@ -202,6 +202,7 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
 | [**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 |
+| [**update_sfvb_sequence_step**](SfvbApi.md#update_sfvb_sequence_step) | **PUT** /sfvb/storefronts/{storefront_oid}/sequences/{sequence_uuid}/steps/{step_uuid} | Change one step's settings or audience filter |
 | [**update_sfvb_upsell_offer**](SfvbApi.md#update_sfvb_upsell_offer) | **PUT** /sfvb/storefronts/{storefront_oid}/upsell_offers/{upsell_offer_oid} | Update an upsell offer |
 | [**update_sfvb_upsell_path**](SfvbApi.md#update_sfvb_upsell_path) | **PUT** /sfvb/storefronts/{storefront_oid}/upsell_paths/{upsell_path_oid} | Update an upsell path |
 | [**upload_sfvb_file**](SfvbApi.md#upload_sfvb_file) | **POST** /sfvb/storefronts/{storefront_oid}/files/upload | Store a binary asset that was already uploaded |
@@ -5422,7 +5423,7 @@ This endpoint does not need any parameter.
 
 Get a campaign's or flow's steps as a tree
 
-The communication sequence named by a campaign's or flow's communication_sequence_uuid, with its steps from the start in order.  Only condition, split and InboxGeek steps branch, and each holds its two sides in branches.  Each step has its type, the admin's label, its settings (a webhook's header and parameter values masked), its audience filter, and the emails, postcard, lists or items it names.  waiting adds how many customers are waiting on each step now.  Read only. 
+The communication sequence named by a campaign's or flow's communication_sequence_uuid, with its steps from the start in order.  Only condition, split and InboxGeek steps branch, and each holds its two sides in branches.  Each step has its type, the admin's label, its settings (a webhook's header and parameter values masked), its audience filter, the emails, postcard, lists or items it names, and the hash_sha256 to send as If-Match when changing it.  waiting adds how many customers are waiting on each step now.  Read only. 
 
 
 ### Examples
@@ -9823,7 +9824,7 @@ end
 
 Request a content review of a flow or campaign email
 
-Starts a review the way the admin's Request Review does.  One test copy of the email goes to the signed-in user, and to no one else, and the review runs in the background, so read the email again for pending_review and then the ruling.  Refused with sfvb.review_not_needed when it doesn't need review, is already waiting for one, or was rejected and not changed since.  An email in a flow triggered by an order or an auto order needs order_id, a test order.  Needs a signed-in user, not an API key alone. 
+Starts a review the way the admin's Request Review does.  The review runs in the background and no test copy is sent.  The email is marked pending_review at once, and the signed-in user gets the approved or rejected notice, so read the email again for the ruling.  Refused with sfvb.review_not_needed when it doesn't need review, is already waiting for one, or was rejected and not changed since.  An email in a flow triggered by an order or an auto order needs order_id, a test order.  Needs a signed-in user, not an API key alone. 
 
 
 ### Examples
@@ -11027,6 +11028,63 @@ end
 - **Accept**: application/json
 
 
+## update_sfvb_sequence_step
+
+> <SfvbSequenceStepUpdateResponse> update_sfvb_sequence_step(storefront_oid, sequence_uuid, step_uuid, if_match, sequence_step_update_request)
+
+Change one step's settings or audience filter
+
+Replaces the step's settings (config_json), its audience filter (filter_profile_equation_json), or both.  Nothing else about the step or the sequence changes.  Send the step's hash_sha256 as If-Match; the write only lands if the step is still what you read.  Email, postcard, experiment, resend, webhook, begin, end, continue and merge steps are refused.  A sequence whose campaign or flow is live needs sfvb_publish. 
+
+
+### Examples
+
+
+(No example for this operation).
+
+
+#### Using the update_sfvb_sequence_step_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<SfvbSequenceStepUpdateResponse>, Integer, Hash)> update_sfvb_sequence_step_with_http_info(storefront_oid, sequence_uuid, step_uuid, if_match, sequence_step_update_request)
+
+```ruby
+begin
+  # Change one step's settings or audience filter
+  data, status_code, headers = api_instance.update_sfvb_sequence_step_with_http_info(storefront_oid, sequence_uuid, step_uuid, if_match, sequence_step_update_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <SfvbSequenceStepUpdateResponse>
+rescue UltracartClient::ApiError => e
+  puts "Error when calling SfvbApi->update_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. |  |
+| **sequence_step_update_request** | [**SfvbSequenceStepUpdateRequest**](SfvbSequenceStepUpdateRequest.md) | The settings, the filter, or both |  |
+
+### Return type
+
+[**SfvbSequenceStepUpdateResponse**](SfvbSequenceStepUpdateResponse.md)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
 ## update_sfvb_upsell_offer
 
 > <SfvbUpsellOffer> update_sfvb_upsell_offer(storefront_oid, upsell_offer_oid, if_match, upsell_offer)

data/docs/SfvbSequenceStep.md

@@ -11,6 +11,7 @@
 | **disabled** | **Boolean** | True when the step is switched off in its settings. | [optional] |
 | **email_uuids** | **Array<String>** | The emails it sends.  One for an email step, one per variant for an experiment. | [optional] |
 | **filter_profile_equation_json** | **String** | The step's audience filter as stored, when it has one. | [optional] |
+| **hash_sha256** | **String** | The hash of the step's type, stored settings and audience filter.  Send it back as If-Match when changing the step. | [optional] |
 | **item_ids** | **Array<String>** | The items it names, for a cart or rate limiter step. | [optional] |
 | **label** | **String** | The type as the admin names it, such as Time Delay.  The type itself for one it doesn't know. | [optional] |
 | **list_uuids** | **Array<String>** | The lists it subscribes or unsubscribes, for a list step. | [optional] |
@@ -35,6 +36,7 @@ instance = UltracartClient::SfvbSequenceStep.new(
   disabled: null,
   email_uuids: null,
   filter_profile_equation_json: null,
+  hash_sha256: null,
   item_ids: null,
   label: null,
   list_uuids: null,

data/docs/SfvbSequenceStepUpdateRequest.md

@@ -0,0 +1,20 @@
+# UltracartClient::SfvbSequenceStepUpdateRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **config_json** | **String** | The step's new settings, as a JSON object in the admin's own shape.  Replaces the stored settings. | [optional] |
+| **filter_profile_equation_json** | **String** | The step's new audience filter, as a JSON object.  Replaces the stored filter. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbSequenceStepUpdateRequest.new(
+  config_json: null,
+  filter_profile_equation_json: null
+)
+```
+

data/docs/SfvbSequenceStepUpdateResponse.md

@@ -0,0 +1,20 @@
+# UltracartClient::SfvbSequenceStepUpdateResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **notes** | **Array<String>** | Anything worth knowing about the change, such as customers already waiting on the step. | [optional] |
+| **step** | [**SfvbSequenceStep**](SfvbSequenceStep.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbSequenceStepUpdateResponse.new(
+  notes: null,
+  step: null
+)
+```
+

data/lib/ultracart_api/api/sfvb_api.rb

@@ -6887,7 +6887,7 @@ module UltracartClient
     end
 
     # Get a campaign's or flow's steps as a tree
-    # The communication sequence named by a campaign's or flow's communication_sequence_uuid, with its steps from the start in order.  Only condition, split and InboxGeek steps branch, and each holds its two sides in branches.  Each step has its type, the admin's label, its settings (a webhook's header and parameter values masked), its audience filter, and the emails, postcard, lists or items it names.  waiting adds how many customers are waiting on each step now.  Read only. 
+    # The communication sequence named by a campaign's or flow's communication_sequence_uuid, with its steps from the start in order.  Only condition, split and InboxGeek steps branch, and each holds its two sides in branches.  Each step has its type, the admin's label, its settings (a webhook's header and parameter values masked), its audience filter, the emails, postcard, lists or items it names, and the hash_sha256 to send as If-Match when changing it.  waiting adds how many customers are waiting on each step now.  Read only. 
     # @param storefront_oid [Integer] 
     # @param sequence_uuid [String] 
     # @param [Hash] opts the optional parameters
@@ -6899,7 +6899,7 @@ module UltracartClient
     end
 
     # Get a campaign's or flow's steps as a tree
-    # The communication sequence named by a campaign's or flow's communication_sequence_uuid, with its steps from the start in order.  Only condition, split and InboxGeek steps branch, and each holds its two sides in branches.  Each step has its type, the admin's label, its settings (a webhook's header and parameter values masked), its audience filter, and the emails, postcard, lists or items it names.  waiting adds how many customers are waiting on each step now.  Read only. 
+    # The communication sequence named by a campaign's or flow's communication_sequence_uuid, with its steps from the start in order.  Only condition, split and InboxGeek steps branch, and each holds its two sides in branches.  Each step has its type, the admin's label, its settings (a webhook's header and parameter values masked), its audience filter, the emails, postcard, lists or items it names, and the hash_sha256 to send as If-Match when changing it.  waiting adds how many customers are waiting on each step now.  Read only. 
     # @param storefront_oid [Integer] 
     # @param sequence_uuid [String] 
     # @param [Hash] opts the optional parameters
@@ -12957,7 +12957,7 @@ module UltracartClient
     end
 
     # Request a content review of a flow or campaign email
-    # Starts a review the way the admin's Request Review does.  One test copy of the email goes to the signed-in user, and to no one else, and the review runs in the background, so read the email again for pending_review and then the ruling.  Refused with sfvb.review_not_needed when it doesn't need review, is already waiting for one, or was rejected and not changed since.  An email in a flow triggered by an order or an auto order needs order_id, a test order.  Needs a signed-in user, not an API key alone. 
+    # Starts a review the way the admin's Request Review does.  The review runs in the background and no test copy is sent.  The email is marked pending_review at once, and the signed-in user gets the approved or rejected notice, so read the email again for the ruling.  Refused with sfvb.review_not_needed when it doesn't need review, is already waiting for one, or was rejected and not changed since.  An email in a flow triggered by an order or an auto order needs order_id, a test order.  Needs a signed-in user, not an API key alone. 
     # @param storefront_oid [Integer] 
     # @param email_uuid [String] 
     # @param email_review_request [SfvbEmailReviewRequest] The test order, for an email in an order-triggered flow
@@ -12969,7 +12969,7 @@ module UltracartClient
     end
 
     # Request a content review of a flow or campaign email
-    # Starts a review the way the admin's Request Review does.  One test copy of the email goes to the signed-in user, and to no one else, and the review runs in the background, so read the email again for pending_review and then the ruling.  Refused with sfvb.review_not_needed when it doesn't need review, is already waiting for one, or was rejected and not changed since.  An email in a flow triggered by an order or an auto order needs order_id, a test order.  Needs a signed-in user, not an API key alone. 
+    # Starts a review the way the admin's Request Review does.  The review runs in the background and no test copy is sent.  The email is marked pending_review at once, and the signed-in user gets the approved or rejected notice, so read the email again for the ruling.  Refused with sfvb.review_not_needed when it doesn't need review, is already waiting for one, or was rejected and not changed since.  An email in a flow triggered by an order or an auto order needs order_id, a test order.  Needs a signed-in user, not an API key alone. 
     # @param storefront_oid [Integer] 
     # @param email_uuid [String] 
     # @param email_review_request [SfvbEmailReviewRequest] The test order, for an email in an order-triggered flow
@@ -14697,6 +14697,100 @@ module UltracartClient
       return data, status_code, headers
     end
 
+    # Change one step's settings or audience filter
+    # Replaces the step's settings (config_json), its audience filter (filter_profile_equation_json), or both.  Nothing else about the step or the sequence changes.  Send the step's hash_sha256 as If-Match; the write only lands if the step is still what you read.  Email, postcard, experiment, resend, webhook, begin, end, continue and merge steps are refused.  A sequence whose campaign or flow is live needs sfvb_publish. 
+    # @param storefront_oid [Integer] 
+    # @param sequence_uuid [String] 
+    # @param step_uuid [String] 
+    # @param if_match [String] The step's hash_sha256 from the last read.  Required; 428 when absent, 412 when stale.
+    # @param sequence_step_update_request [SfvbSequenceStepUpdateRequest] The settings, the filter, or both
+    # @param [Hash] opts the optional parameters
+    # @return [SfvbSequenceStepUpdateResponse]
+    def update_sfvb_sequence_step(storefront_oid, sequence_uuid, step_uuid, if_match, sequence_step_update_request, opts = {})
+      data, _status_code, _headers = update_sfvb_sequence_step_with_http_info(storefront_oid, sequence_uuid, step_uuid, if_match, sequence_step_update_request, opts)
+      data
+    end
+
+    # Change one step's settings or audience filter
+    # Replaces the step's settings (config_json), its audience filter (filter_profile_equation_json), or both.  Nothing else about the step or the sequence changes.  Send the step's hash_sha256 as If-Match; the write only lands if the step is still what you read.  Email, postcard, experiment, resend, webhook, begin, end, continue and merge steps are refused.  A sequence whose campaign or flow is live needs sfvb_publish. 
+    # @param storefront_oid [Integer] 
+    # @param sequence_uuid [String] 
+    # @param step_uuid [String] 
+    # @param if_match [String] The step's hash_sha256 from the last read.  Required; 428 when absent, 412 when stale.
+    # @param sequence_step_update_request [SfvbSequenceStepUpdateRequest] The settings, the filter, or both
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(SfvbSequenceStepUpdateResponse, Integer, Hash)>] SfvbSequenceStepUpdateResponse data, response status code and response headers
+    def update_sfvb_sequence_step_with_http_info(storefront_oid, sequence_uuid, step_uuid, if_match, sequence_step_update_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: SfvbApi.update_sfvb_sequence_step ...'
+      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_sequence_step"
+      end
+      # verify the required parameter 'sequence_uuid' is set
+      if @api_client.config.client_side_validation && sequence_uuid.nil?
+        fail ArgumentError, "Missing the required parameter 'sequence_uuid' when calling SfvbApi.update_sfvb_sequence_step"
+      end
+      # verify the required parameter 'step_uuid' is set
+      if @api_client.config.client_side_validation && step_uuid.nil?
+        fail ArgumentError, "Missing the required parameter 'step_uuid' when calling SfvbApi.update_sfvb_sequence_step"
+      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_sequence_step"
+      end
+      # verify the required parameter 'sequence_step_update_request' is set
+      if @api_client.config.client_side_validation && sequence_step_update_request.nil?
+        fail ArgumentError, "Missing the required parameter 'sequence_step_update_request' when calling SfvbApi.update_sfvb_sequence_step"
+      end
+      # resource path
+      local_var_path = '/sfvb/storefronts/{storefront_oid}/sequences/{sequence_uuid}/steps/{step_uuid}'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s)).sub('{' + 'sequence_uuid' + '}', CGI.escape(sequence_uuid.to_s)).sub('{' + 'step_uuid' + '}', CGI.escape(step_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(sequence_step_update_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'SfvbSequenceStepUpdateResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
+
+      new_options = opts.merge(
+        :operation => :"SfvbApi.update_sfvb_sequence_step",
+        :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_sequence_step\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Update an upsell offer
     # A full replace.  Send back the whole offer you read, changed, with its hash_sha256 in If-Match.  Read only fields are ignored and a writable field left out is cleared.  Changing an offer that is switched on, or changing upsell_item_id_javascript or offsite_content_url, needs sfvb_publish.  An update cannot switch an offer on; that is the enable call, which needs approval.  Settings the API does not show, such as the offer's screenshots, are kept. 
     # @param storefront_oid [Integer] 

data/lib/ultracart_api/models/auto_order_item.rb

@@ -24,13 +24,13 @@ module UltracartClient
     # An arbitrary percentage discount to provide on future rebills
     attr_accessor :arbitrary_percentage_discount
 
-    # Arbitrary quantity to rebill
+    # Quantity to rebill.  When set, every rebill uses this quantity instead of original_quantity.  Set this field to change the quantity on an active auto order; the merchant auto order editor updates this same field.  Each rebill charges the unit price multiplied by this quantity.
     attr_accessor :arbitrary_quantity
 
     # The number of days to rebill if the frequency is set to an arbitrary number of days
     attr_accessor :arbitrary_schedule_days
 
-    # Arbitrary unit cost that rebills of this item should occur at
+    # Arbitrary unit cost that rebills of this item should occur at.  This is a price per unit.  Each rebill charges it multiplied by the rebill quantity (arbitrary_quantity, or original_quantity when arbitrary_quantity is null).
     attr_accessor :arbitrary_unit_cost
 
     # The number of rebills to give the arbitrary unit cost on before reverting to normal pricing.
@@ -84,7 +84,7 @@ module UltracartClient
     # The original item id purchased.  This item controls scheduling.  If you wish to modify a schedule, for example, from monthly to yearly, change this item from your monthly item to your yearly item, and then change the next_shipment_dts to your desired date.
     attr_accessor :original_item_id
 
-    # The original quantity purchased
+    # The quantity purchased on the original order.  Rebills use this quantity only when arbitrary_quantity is null.  To change the quantity on future rebills, set arbitrary_quantity instead.
     attr_accessor :original_quantity
 
     # True if paused.  This field is an object instead of a primitive for backwards compatibility.

data/lib/ultracart_api/models/sfvb_sequence_step.rb

@@ -36,6 +36,9 @@ module UltracartClient
     # The step's audience filter as stored, when it has one.
     attr_accessor :filter_profile_equation_json
 
+    # The hash of the step's type, stored settings and audience filter.  Send it back as If-Match when changing the step.
+    attr_accessor :hash_sha256
+
     # The items it names, for a cart or rate limiter step.
     attr_accessor :item_ids
 
@@ -76,6 +79,7 @@ module UltracartClient
         :'disabled' => :'disabled',
         :'email_uuids' => :'email_uuids',
         :'filter_profile_equation_json' => :'filter_profile_equation_json',
+        :'hash_sha256' => :'hash_sha256',
         :'item_ids' => :'item_ids',
         :'label' => :'label',
         :'list_uuids' => :'list_uuids',
@@ -104,6 +108,7 @@ module UltracartClient
         :'disabled' => :'Boolean',
         :'email_uuids' => :'Array<String>',
         :'filter_profile_equation_json' => :'String',
+        :'hash_sha256' => :'String',
         :'item_ids' => :'Array<String>',
         :'label' => :'String',
         :'list_uuids' => :'Array<String>',
@@ -170,6 +175,10 @@ module UltracartClient
         self.filter_profile_equation_json = attributes[:'filter_profile_equation_json']
       end
 
+      if attributes.key?(:'hash_sha256')
+        self.hash_sha256 = attributes[:'hash_sha256']
+      end
+
       if attributes.key?(:'item_ids')
         if (value = attributes[:'item_ids']).is_a?(Array)
           self.item_ids = value
@@ -240,6 +249,7 @@ module UltracartClient
           disabled == o.disabled &&
           email_uuids == o.email_uuids &&
           filter_profile_equation_json == o.filter_profile_equation_json &&
+          hash_sha256 == o.hash_sha256 &&
           item_ids == o.item_ids &&
           label == o.label &&
           list_uuids == o.list_uuids &&
@@ -261,7 +271,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [branches, config_error, config_json, config_merchant_notes, disabled, email_uuids, filter_profile_equation_json, item_ids, label, list_uuids, merchant_notes, name, number_waiting, postcard_uuid, step_uuid, type, unreachable].hash
+      [branches, config_error, config_json, config_merchant_notes, disabled, email_uuids, filter_profile_equation_json, hash_sha256, item_ids, label, list_uuids, merchant_notes, name, number_waiting, postcard_uuid, step_uuid, type, unreachable].hash
     end
 
     # Builds the object from hash

data/lib/ultracart_api/models/sfvb_sequence_step_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 SfvbSequenceStepUpdateRequest
+    # The step's new settings, as a JSON object in the admin's own shape.  Replaces the stored settings.
+    attr_accessor :config_json
+
+    # The step's new audience filter, as a JSON object.  Replaces the stored filter.
+    attr_accessor :filter_profile_equation_json
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'config_json' => :'config_json',
+        :'filter_profile_equation_json' => :'filter_profile_equation_json'
+      }
+    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
+      {
+        :'config_json' => :'String',
+        :'filter_profile_equation_json' => :'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::SfvbSequenceStepUpdateRequest` 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::SfvbSequenceStepUpdateRequest`. 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?(:'config_json')
+        self.config_json = attributes[:'config_json']
+      end
+
+      if attributes.key?(:'filter_profile_equation_json')
+        self.filter_profile_equation_json = attributes[:'filter_profile_equation_json']
+      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 &&
+          config_json == o.config_json &&
+          filter_profile_equation_json == o.filter_profile_equation_json
+    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
+      [config_json, filter_profile_equation_json].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_sequence_step_update_response.rb

@@ -0,0 +1,231 @@
+=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 SfvbSequenceStepUpdateResponse
+    # Anything worth knowing about the change, such as customers already waiting on the step.
+    attr_accessor :notes
+
+    attr_accessor :step
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'notes' => :'notes',
+        :'step' => :'step'
+      }
+    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
+      {
+        :'notes' => :'Array<String>',
+        :'step' => :'SfvbSequenceStep'
+      }
+    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::SfvbSequenceStepUpdateResponse` 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::SfvbSequenceStepUpdateResponse`. 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?(:'notes')
+        if (value = attributes[:'notes']).is_a?(Array)
+          self.notes = value
+        end
+      end
+
+      if attributes.key?(:'step')
+        self.step = attributes[:'step']
+      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 &&
+          notes == o.notes &&
+          step == o.step
+    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
+      [notes, step].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.212'
+  VERSION = '4.1.214'
 end

data/lib/ultracart_api.rb

@@ -1188,6 +1188,8 @@ require 'ultracart_api/models/sfvb_secret_sink'
 require 'ultracart_api/models/sfvb_sequence'
 require 'ultracart_api/models/sfvb_sequence_branch'
 require 'ultracart_api/models/sfvb_sequence_step'
+require 'ultracart_api/models/sfvb_sequence_step_update_request'
+require 'ultracart_api/models/sfvb_sequence_step_update_response'
 require 'ultracart_api/models/sfvb_server_log'
 require 'ultracart_api/models/sfvb_server_log_detail'
 require 'ultracart_api/models/sfvb_server_log_entry'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ultracart_api
 version: !ruby/object:Gem::Version
-  version: 4.1.212
+  version: 4.1.214
 platform: ruby
 authors:
 - UltraCart
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-10-27 00:00:00.000000000 Z
+date: 2026-10-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus
@@ -1250,6 +1250,8 @@ files:
 - docs/SfvbSequence.md
 - docs/SfvbSequenceBranch.md
 - docs/SfvbSequenceStep.md
+- docs/SfvbSequenceStepUpdateRequest.md
+- docs/SfvbSequenceStepUpdateResponse.md
 - docs/SfvbServerLog.md
 - docs/SfvbServerLogDetail.md
 - docs/SfvbServerLogEntry.md
@@ -2596,6 +2598,8 @@ files:
 - lib/ultracart_api/models/sfvb_sequence.rb
 - lib/ultracart_api/models/sfvb_sequence_branch.rb
 - lib/ultracart_api/models/sfvb_sequence_step.rb
+- lib/ultracart_api/models/sfvb_sequence_step_update_request.rb
+- lib/ultracart_api/models/sfvb_sequence_step_update_response.rb
 - lib/ultracart_api/models/sfvb_server_log.rb
 - lib/ultracart_api/models/sfvb_server_log_detail.rb
 - lib/ultracart_api/models/sfvb_server_log_entry.rb