ultracart_api 4.1.211 → 4.1.213

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 433a8aaea315101666d5b31ee8a8983cb95241f2421824d42d069e463e3cc94c
-  data.tar.gz: 90123646be6a6a72b2dbf8024107caf6d62b5881b6893e4f70f80e9ed2f3e116
+  metadata.gz: 177eb26f4dc8564426113a71b6e12506f76fd71c4f8fdbbc3d391c7bcd488a8e
+  data.tar.gz: 65114d9f5207372850c78fa170be7ab44a24625e1cc84b557067ee7c73418964
 SHA512:
-  metadata.gz: e83035d699791416639d17e2443643057d38fc5b6bd6cce8b5dd5432afad09d2d06152f0b4c91909a5d98836ee8e1713ba1bdd7650ca8869ede586dccffdd46a
-  data.tar.gz: c74ca1fc0536aafdfc8010cc1055fce1464b8b965b73930d1f5fd1a68c5465a93a3dfbc3e51a10807fe5b239535f2fcfbdb625f4b185813ea285f35b27c6c3b2
+  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.211
+- 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.211'
+gem 'ultracart_api', '4.1.213'
 ```
 
 install:
@@ -2327,6 +2327,8 @@ 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 |
 | 4.1.209 | 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/ConversationAgentAuth.md

@@ -17,6 +17,7 @@
 | **parent_merchant_id** | **String** | The parent merchant ID for PBX. For non-linked merchants, equals merchant_id. | [optional] |
 | **pbx_admin** | **Boolean** |  | [optional] |
 | **pbx_jwt** | **String** |  | [optional] |
+| **pbx_startup_activity** | **String** | Status the agent starts in when the CRM loads | [optional] |
 | **pbx_supervisor** | **Boolean** |  | [optional] |
 | **pbx_user** | **Boolean** |  | [optional] |
 | **pbx_voice_identity** | **String** |  | [optional] |
@@ -46,6 +47,7 @@ instance = UltracartClient::ConversationAgentAuth.new(
   parent_merchant_id: null,
   pbx_admin: null,
   pbx_jwt: null,
+  pbx_startup_activity: null,
   pbx_supervisor: null,
   pbx_user: null,
   pbx_voice_identity: null,

data/docs/ConversationPbxAgent.md

@@ -19,6 +19,7 @@
 | **preferred_hardware_phone_uuid** | **String** | The hardware phone that will be dialed on an incoming call if routing preference is hardware_phone | [optional] |
 | **record_outgoing_automatically** | **Boolean** | True if outgoing calls should be automatically recorded | [optional] |
 | **shared_conversation_pbx_voicemail_mailbox_uuid** | **String** | Shared Conversation Pbx Voicemail Mailbox UUID | [optional] |
+| **startup_activity** | **String** | Status the agent starts in when the CRM loads. Missing means available. | [optional] |
 | **twilio_taskrouter_worker_id** | **String** | Twilio taskrouter worker Id | [optional] |
 | **unavailable_play_audio_uuid** | **String** | Unavailable play audio UUID | [optional] |
 | **unavailable_say** | **String** | Unavailable say | [optional] |
@@ -49,6 +50,7 @@ instance = UltracartClient::ConversationPbxAgent.new(
   preferred_hardware_phone_uuid: null,
   record_outgoing_automatically: null,
   shared_conversation_pbx_voicemail_mailbox_uuid: null,
+  startup_activity: null,
   twilio_taskrouter_worker_id: null,
   unavailable_play_audio_uuid: null,
   unavailable_say: null,

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/models/conversation_agent_auth.rb

@@ -45,6 +45,9 @@ module UltracartClient
 
     attr_accessor :pbx_jwt
 
+    # Status the agent starts in when the CRM loads
+    attr_accessor :pbx_startup_activity
+
     attr_accessor :pbx_supervisor
 
     attr_accessor :pbx_user
@@ -64,6 +67,28 @@ module UltracartClient
 
     attr_accessor :websocket_url
 
+    class EnumAttributeValidator
+      attr_reader :datatype
+      attr_reader :allowable_values
+
+      def initialize(datatype, allowable_values)
+        @allowable_values = allowable_values.map do |value|
+          case datatype.to_s
+          when /Integer/i
+            value.to_i
+          when /Float/i
+            value.to_f
+          else
+            value
+          end
+        end
+      end
+
+      def valid?(value)
+        !value || allowable_values.include?(value)
+      end
+    end
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -80,6 +105,7 @@ module UltracartClient
         :'parent_merchant_id' => :'parent_merchant_id',
         :'pbx_admin' => :'pbx_admin',
         :'pbx_jwt' => :'pbx_jwt',
+        :'pbx_startup_activity' => :'pbx_startup_activity',
         :'pbx_supervisor' => :'pbx_supervisor',
         :'pbx_user' => :'pbx_user',
         :'pbx_voice_identity' => :'pbx_voice_identity',
@@ -113,6 +139,7 @@ module UltracartClient
         :'parent_merchant_id' => :'String',
         :'pbx_admin' => :'Boolean',
         :'pbx_jwt' => :'String',
+        :'pbx_startup_activity' => :'String',
         :'pbx_supervisor' => :'Boolean',
         :'pbx_user' => :'Boolean',
         :'pbx_voice_identity' => :'String',
@@ -202,6 +229,10 @@ module UltracartClient
         self.pbx_jwt = attributes[:'pbx_jwt']
       end
 
+      if attributes.key?(:'pbx_startup_activity')
+        self.pbx_startup_activity = attributes[:'pbx_startup_activity']
+      end
+
       if attributes.key?(:'pbx_supervisor')
         self.pbx_supervisor = attributes[:'pbx_supervisor']
       end
@@ -251,9 +282,21 @@ module UltracartClient
     # Check to see if the all the properties in the model are valid
     # @return true if the model is valid
     def valid?
+      pbx_startup_activity_validator = EnumAttributeValidator.new('String', ["available", "unavailable"])
+      return false unless pbx_startup_activity_validator.valid?(@pbx_startup_activity)
       true
     end
 
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] pbx_startup_activity Object to be assigned
+    def pbx_startup_activity=(pbx_startup_activity)
+      validator = EnumAttributeValidator.new('String', ["available", "unavailable"])
+      unless validator.valid?(pbx_startup_activity)
+        fail ArgumentError, "invalid value for \"pbx_startup_activity\", must be one of #{validator.allowable_values}."
+      end
+      @pbx_startup_activity = pbx_startup_activity
+    end
+
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)
@@ -272,6 +315,7 @@ module UltracartClient
           parent_merchant_id == o.parent_merchant_id &&
           pbx_admin == o.pbx_admin &&
           pbx_jwt == o.pbx_jwt &&
+          pbx_startup_activity == o.pbx_startup_activity &&
           pbx_supervisor == o.pbx_supervisor &&
           pbx_user == o.pbx_user &&
           pbx_voice_identity == o.pbx_voice_identity &&
@@ -292,7 +336,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [chat_admin, chat_user, conversation_participant_arn, conversation_participant_name, customer_profile, default_phone_number, group_ids, jwt, merchant_id, merchants, parent_merchant_id, pbx_admin, pbx_jwt, pbx_supervisor, pbx_user, pbx_voice_identity, pbx_voice_token, pbx_worker_token, pbx_worker_token_v2, twilio_accounts, user_id, websocket_url].hash
+      [chat_admin, chat_user, conversation_participant_arn, conversation_participant_name, customer_profile, default_phone_number, group_ids, jwt, merchant_id, merchants, parent_merchant_id, pbx_admin, pbx_jwt, pbx_startup_activity, pbx_supervisor, pbx_user, pbx_voice_identity, pbx_voice_token, pbx_worker_token, pbx_worker_token_v2, twilio_accounts, user_id, websocket_url].hash
     end
 
     # Builds the object from hash

data/lib/ultracart_api/models/conversation_pbx_agent.rb

@@ -60,6 +60,9 @@ module UltracartClient
     # Shared Conversation Pbx Voicemail Mailbox UUID
     attr_accessor :shared_conversation_pbx_voicemail_mailbox_uuid
 
+    # Status the agent starts in when the CRM loads. Missing means available.
+    attr_accessor :startup_activity
+
     # Twilio taskrouter worker Id
     attr_accessor :twilio_taskrouter_worker_id
 
@@ -124,6 +127,7 @@ module UltracartClient
         :'preferred_hardware_phone_uuid' => :'preferred_hardware_phone_uuid',
         :'record_outgoing_automatically' => :'record_outgoing_automatically',
         :'shared_conversation_pbx_voicemail_mailbox_uuid' => :'shared_conversation_pbx_voicemail_mailbox_uuid',
+        :'startup_activity' => :'startup_activity',
         :'twilio_taskrouter_worker_id' => :'twilio_taskrouter_worker_id',
         :'unavailable_play_audio_uuid' => :'unavailable_play_audio_uuid',
         :'unavailable_say' => :'unavailable_say',
@@ -158,6 +162,7 @@ module UltracartClient
         :'preferred_hardware_phone_uuid' => :'String',
         :'record_outgoing_automatically' => :'Boolean',
         :'shared_conversation_pbx_voicemail_mailbox_uuid' => :'String',
+        :'startup_activity' => :'String',
         :'twilio_taskrouter_worker_id' => :'String',
         :'unavailable_play_audio_uuid' => :'String',
         :'unavailable_say' => :'String',
@@ -252,6 +257,10 @@ module UltracartClient
         self.shared_conversation_pbx_voicemail_mailbox_uuid = attributes[:'shared_conversation_pbx_voicemail_mailbox_uuid']
       end
 
+      if attributes.key?(:'startup_activity')
+        self.startup_activity = attributes[:'startup_activity']
+      end
+
       if attributes.key?(:'twilio_taskrouter_worker_id')
         self.twilio_taskrouter_worker_id = attributes[:'twilio_taskrouter_worker_id']
       end
@@ -333,6 +342,8 @@ module UltracartClient
       return false if !@merchant_id.nil? && @merchant_id.to_s.length > 5
       return false if !@personal_conversation_pbx_voicemail_mailbox_uuid.nil? && @personal_conversation_pbx_voicemail_mailbox_uuid.to_s.length > 50
       return false if !@shared_conversation_pbx_voicemail_mailbox_uuid.nil? && @shared_conversation_pbx_voicemail_mailbox_uuid.to_s.length > 50
+      startup_activity_validator = EnumAttributeValidator.new('String', ["available", "unavailable"])
+      return false unless startup_activity_validator.valid?(@startup_activity)
       return false if !@twilio_taskrouter_worker_id.nil? && @twilio_taskrouter_worker_id.to_s.length > 100
       return false if !@unavailable_play_audio_uuid.nil? && @unavailable_play_audio_uuid.to_s.length > 50
       unavailable_say_voice_validator = EnumAttributeValidator.new('String', ["man", "woman"])
@@ -392,6 +403,16 @@ module UltracartClient
       @shared_conversation_pbx_voicemail_mailbox_uuid = shared_conversation_pbx_voicemail_mailbox_uuid
     end
 
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] startup_activity Object to be assigned
+    def startup_activity=(startup_activity)
+      validator = EnumAttributeValidator.new('String', ["available", "unavailable"])
+      unless validator.valid?(startup_activity)
+        fail ArgumentError, "invalid value for \"startup_activity\", must be one of #{validator.allowable_values}."
+      end
+      @startup_activity = startup_activity
+    end
+
     # Custom attribute writer method with validation
     # @param [Object] twilio_taskrouter_worker_id Value to be assigned
     def twilio_taskrouter_worker_id=(twilio_taskrouter_worker_id)
@@ -452,6 +473,7 @@ module UltracartClient
           preferred_hardware_phone_uuid == o.preferred_hardware_phone_uuid &&
           record_outgoing_automatically == o.record_outgoing_automatically &&
           shared_conversation_pbx_voicemail_mailbox_uuid == o.shared_conversation_pbx_voicemail_mailbox_uuid &&
+          startup_activity == o.startup_activity &&
           twilio_taskrouter_worker_id == o.twilio_taskrouter_worker_id &&
           unavailable_play_audio_uuid == o.unavailable_play_audio_uuid &&
           unavailable_say == o.unavailable_say &&
@@ -471,7 +493,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [ai, call_routing_preference, cellphone, conversation_pbx_agent_uuid, cos_uuid, default_phone_number_uuid, extension, full_name, hardware_phone_uuids, login, merchant_id, personal_conversation_pbx_voicemail_mailbox_uuid, preferred_hardware_phone_uuid, record_outgoing_automatically, shared_conversation_pbx_voicemail_mailbox_uuid, twilio_taskrouter_worker_id, unavailable_play_audio_uuid, unavailable_say, unavailable_say_voice, user_id, voicemail, zoho_desk_outbound_department_id, zoho_desk_outbound_ticket_enabled].hash
+      [ai, call_routing_preference, cellphone, conversation_pbx_agent_uuid, cos_uuid, default_phone_number_uuid, extension, full_name, hardware_phone_uuids, login, merchant_id, personal_conversation_pbx_voicemail_mailbox_uuid, preferred_hardware_phone_uuid, record_outgoing_automatically, shared_conversation_pbx_voicemail_mailbox_uuid, startup_activity, twilio_taskrouter_worker_id, unavailable_play_audio_uuid, unavailable_say, unavailable_say_voice, user_id, voicemail, zoho_desk_outbound_department_id, zoho_desk_outbound_ticket_enabled].hash
     end
 
     # Builds the object from hash

data/lib/ultracart_api/version.rb

@@ -11,5 +11,5 @@ OpenAPI Generator version: 6.0.1-SNAPSHOT
 =end
 
 module UltracartClient
-  VERSION = '4.1.211'
+  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.211
+  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