ultracart_api 4.1.212 → 4.1.213

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: daa7439a4c2c9d9b5c10024beb9d848a7b728c9ff5d057a22923f9381802cf38
-  data.tar.gz: 5acd544d65144e915ecf68e29428ec9fd3ba8012fecbe54a992afa54b8fae08c
+  metadata.gz: 177eb26f4dc8564426113a71b6e12506f76fd71c4f8fdbbc3d391c7bcd488a8e
+  data.tar.gz: 65114d9f5207372850c78fa170be7ab44a24625e1cc84b557067ee7c73418964
 SHA512:
-  metadata.gz: 9137149162a374efa7ab54e06cd729eae0046b7d82d08248d3e8fbfbb368098e57469ae74ce9a2cf3428e19acdddefe24c902a827c78abda8f0f89f0cb37ec91
-  data.tar.gz: 05c4be8139c905ef860a89b6c19ff9b3ed2557eef3975b3298a4720f538b37cda040b24861a92f5f3e9aea5270814ee6323f698b961c58af95f10119da73bae8
+  metadata.gz: 5e917b0943f053bc53a12ce302fc03cb021f32d59eeba867fd378ad764a1252c8e0304c70c4c3b34c085c6fe7a7c8f29fa1cd78ebfa6043588841c271f849d6f
+  data.tar.gz: d1e25329285bca936f10bd2f5273de09b8a6cb6f851c54cc78259ee9da8080d0f62860b669cdf1e19b5283c4d3ffd6a1c5c661e7032d9a84553e812da4a98599

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.213
 - 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.213'
 ```
 
 install:
@@ -2327,6 +2327,7 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 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

@@ -9823,7 +9823,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

data/lib/ultracart_api/api/sfvb_api.rb

@@ -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

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/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ultracart_api
 version: !ruby/object:Gem::Version
-  version: 4.1.212
+  version: 4.1.213
 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