ultracart_api 4.1.69 → 4.1.70

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e481d72fdb9738e46385d225e85885a2f5eef1d5adf3184d9c0c91bcfe7ce5e6
-  data.tar.gz: a8c6c2a8e07465c0f7fca61546290144b22ff43825955a96a2ade115ceb88bee
+  metadata.gz: 69b88c8f377abe4c258f2596ea4e535308b97fbf6efe2a717f755140d765c197
+  data.tar.gz: ba05247f4eb23b62b456e53830b11027d47abae099fbe46928fc364fcbe22a95
 SHA512:
-  metadata.gz: c93744277b4d469e168a557f7f4681bee3e084c9658c5ead3895b1d3f9b309a5e234fcb7fcca259fb55a5dbd73c9fe8ac603f2a14ea45b31fc0a5312c691623f
-  data.tar.gz: dfb4dc33f05e7d93b7c7a87150aa99fb540c004c7a0784726b1187689e40f459e06efe8cdd86e548cad160945d0dc4c3d7b64e26c3d109bf01c6da89423c5d50
+  metadata.gz: 23f47bd84edce36c0bf5f724a8e381facaec5a8be8124fe4894decd8af81c4fc41a735ff5c8f26fdc77d987b207b691ccef5f722acbf9879112f697cc7669cd5
+  data.tar.gz: 5305bc35dcf40acdacd65a5a92e69c3a5655258415381130d96abcd018d67b9fcdf84fbca54c016d11a8f63edc682d50b865f5fcecb160e6e48f9ef8f5373a3c

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.69
+- Package version: 4.1.70
 - 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.69'
+gem 'ultracart_api', '4.1.70'
 ```
 
 install:
@@ -1686,6 +1686,7 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 4.1.70 | 04/03/2026 | conversation pbx - queue callback settings |
 | 4.1.69 | 03/31/2026 | conversations - user specific audio methods |
 | 4.1.68 | 03/31/2026 | oauth - device support |
 | 4.1.67 | 02/24/2026 | customer activity - sms and sms_stop fields added |

data/docs/ConversationPbxQueue.md

@@ -8,6 +8,18 @@
 | **ai_timeout_seconds** | **Integer** | AI timeout seconds | [optional] |
 | **announce_queue_position** | **Boolean** | If true, the customer is told their queue position upon entering the queue | [optional] |
 | **automatic_coach_agent_uuid** | **String** | AI Agent UUID to automatically engage to provide coaching | [optional] |
+| **callback_announce_audio_uuid** | **String** | Custom audio file UUID for the callback offer prompt | [optional] |
+| **callback_announce_say** | **String** | Custom TTS text for the callback offer prompt | [optional] |
+| **callback_confirm_audio_uuid** | **String** | Custom audio file UUID for the callback confirmation message | [optional] |
+| **callback_confirm_say** | **String** | Custom TTS text for the callback confirmation message | [optional] |
+| **callback_enabled** | **Boolean** | If true, the callback option is enabled for this queue | [optional] |
+| **callback_hours_only** | **Boolean** | When true, only offer callbacks during business hours | [optional] |
+| **callback_max_attempts** | **Integer** | Maximum number of times the system will attempt to call the customer back | [optional] |
+| **callback_max_offers** | **Integer** | Maximum number of times the callback option is offered to a caller per call | [optional] |
+| **callback_max_pending** | **Integer** | Maximum number of pending callbacks allowed per queue | [optional] |
+| **callback_offer_after_seconds** | **Integer** | Seconds a caller must wait in queue before the callback option is offered | [optional] |
+| **callback_offer_interval_seconds** | **Integer** | Seconds between repeat callback offers to the same caller | [optional] |
+| **callback_retry_delay_seconds** | **Integer** | Delay in seconds between callback retry attempts | [optional] |
 | **conversation_pbx_queue_uuid** | **String** | Conversation Pbx Queue unique identifier | [optional] |
 | **conversation_voicemail_mailbox_uuid** | **String** | The voicemail mailbox associated with this queue | [optional] |
 | **hold_conversation_pbx_audio_uuid** | **String** | The audio to play while holding in a queue | [optional] |
@@ -39,6 +51,18 @@ instance = UltracartClient::ConversationPbxQueue.new(
   ai_timeout_seconds: null,
   announce_queue_position: null,
   automatic_coach_agent_uuid: null,
+  callback_announce_audio_uuid: null,
+  callback_announce_say: null,
+  callback_confirm_audio_uuid: null,
+  callback_confirm_say: null,
+  callback_enabled: null,
+  callback_hours_only: null,
+  callback_max_attempts: null,
+  callback_max_offers: null,
+  callback_max_pending: null,
+  callback_offer_after_seconds: null,
+  callback_offer_interval_seconds: null,
+  callback_retry_delay_seconds: null,
   conversation_pbx_queue_uuid: null,
   conversation_voicemail_mailbox_uuid: null,
   hold_conversation_pbx_audio_uuid: null,

data/lib/ultracart_api/models/conversation_pbx_queue.rb

@@ -27,6 +27,42 @@ module UltracartClient
     # AI Agent UUID to automatically engage to provide coaching
     attr_accessor :automatic_coach_agent_uuid
 
+    # Custom audio file UUID for the callback offer prompt
+    attr_accessor :callback_announce_audio_uuid
+
+    # Custom TTS text for the callback offer prompt
+    attr_accessor :callback_announce_say
+
+    # Custom audio file UUID for the callback confirmation message
+    attr_accessor :callback_confirm_audio_uuid
+
+    # Custom TTS text for the callback confirmation message
+    attr_accessor :callback_confirm_say
+
+    # If true, the callback option is enabled for this queue
+    attr_accessor :callback_enabled
+
+    # When true, only offer callbacks during business hours
+    attr_accessor :callback_hours_only
+
+    # Maximum number of times the system will attempt to call the customer back
+    attr_accessor :callback_max_attempts
+
+    # Maximum number of times the callback option is offered to a caller per call
+    attr_accessor :callback_max_offers
+
+    # Maximum number of pending callbacks allowed per queue
+    attr_accessor :callback_max_pending
+
+    # Seconds a caller must wait in queue before the callback option is offered
+    attr_accessor :callback_offer_after_seconds
+
+    # Seconds between repeat callback offers to the same caller
+    attr_accessor :callback_offer_interval_seconds
+
+    # Delay in seconds between callback retry attempts
+    attr_accessor :callback_retry_delay_seconds
+
     # Conversation Pbx Queue unique identifier
     attr_accessor :conversation_pbx_queue_uuid
 
@@ -115,6 +151,18 @@ module UltracartClient
         :'ai_timeout_seconds' => :'ai_timeout_seconds',
         :'announce_queue_position' => :'announce_queue_position',
         :'automatic_coach_agent_uuid' => :'automatic_coach_agent_uuid',
+        :'callback_announce_audio_uuid' => :'callback_announce_audio_uuid',
+        :'callback_announce_say' => :'callback_announce_say',
+        :'callback_confirm_audio_uuid' => :'callback_confirm_audio_uuid',
+        :'callback_confirm_say' => :'callback_confirm_say',
+        :'callback_enabled' => :'callback_enabled',
+        :'callback_hours_only' => :'callback_hours_only',
+        :'callback_max_attempts' => :'callback_max_attempts',
+        :'callback_max_offers' => :'callback_max_offers',
+        :'callback_max_pending' => :'callback_max_pending',
+        :'callback_offer_after_seconds' => :'callback_offer_after_seconds',
+        :'callback_offer_interval_seconds' => :'callback_offer_interval_seconds',
+        :'callback_retry_delay_seconds' => :'callback_retry_delay_seconds',
         :'conversation_pbx_queue_uuid' => :'conversation_pbx_queue_uuid',
         :'conversation_voicemail_mailbox_uuid' => :'conversation_voicemail_mailbox_uuid',
         :'hold_conversation_pbx_audio_uuid' => :'hold_conversation_pbx_audio_uuid',
@@ -150,6 +198,18 @@ module UltracartClient
         :'ai_timeout_seconds' => :'Integer',
         :'announce_queue_position' => :'Boolean',
         :'automatic_coach_agent_uuid' => :'String',
+        :'callback_announce_audio_uuid' => :'String',
+        :'callback_announce_say' => :'String',
+        :'callback_confirm_audio_uuid' => :'String',
+        :'callback_confirm_say' => :'String',
+        :'callback_enabled' => :'Boolean',
+        :'callback_hours_only' => :'Boolean',
+        :'callback_max_attempts' => :'Integer',
+        :'callback_max_offers' => :'Integer',
+        :'callback_max_pending' => :'Integer',
+        :'callback_offer_after_seconds' => :'Integer',
+        :'callback_offer_interval_seconds' => :'Integer',
+        :'callback_retry_delay_seconds' => :'Integer',
         :'conversation_pbx_queue_uuid' => :'String',
         :'conversation_voicemail_mailbox_uuid' => :'String',
         :'hold_conversation_pbx_audio_uuid' => :'String',
@@ -210,6 +270,54 @@ module UltracartClient
         self.automatic_coach_agent_uuid = attributes[:'automatic_coach_agent_uuid']
       end
 
+      if attributes.key?(:'callback_announce_audio_uuid')
+        self.callback_announce_audio_uuid = attributes[:'callback_announce_audio_uuid']
+      end
+
+      if attributes.key?(:'callback_announce_say')
+        self.callback_announce_say = attributes[:'callback_announce_say']
+      end
+
+      if attributes.key?(:'callback_confirm_audio_uuid')
+        self.callback_confirm_audio_uuid = attributes[:'callback_confirm_audio_uuid']
+      end
+
+      if attributes.key?(:'callback_confirm_say')
+        self.callback_confirm_say = attributes[:'callback_confirm_say']
+      end
+
+      if attributes.key?(:'callback_enabled')
+        self.callback_enabled = attributes[:'callback_enabled']
+      end
+
+      if attributes.key?(:'callback_hours_only')
+        self.callback_hours_only = attributes[:'callback_hours_only']
+      end
+
+      if attributes.key?(:'callback_max_attempts')
+        self.callback_max_attempts = attributes[:'callback_max_attempts']
+      end
+
+      if attributes.key?(:'callback_max_offers')
+        self.callback_max_offers = attributes[:'callback_max_offers']
+      end
+
+      if attributes.key?(:'callback_max_pending')
+        self.callback_max_pending = attributes[:'callback_max_pending']
+      end
+
+      if attributes.key?(:'callback_offer_after_seconds')
+        self.callback_offer_after_seconds = attributes[:'callback_offer_after_seconds']
+      end
+
+      if attributes.key?(:'callback_offer_interval_seconds')
+        self.callback_offer_interval_seconds = attributes[:'callback_offer_interval_seconds']
+      end
+
+      if attributes.key?(:'callback_retry_delay_seconds')
+        self.callback_retry_delay_seconds = attributes[:'callback_retry_delay_seconds']
+      end
+
       if attributes.key?(:'conversation_pbx_queue_uuid')
         self.conversation_pbx_queue_uuid = attributes[:'conversation_pbx_queue_uuid']
       end
@@ -295,6 +403,14 @@ module UltracartClient
     # @return Array for valid properties with the reasons
     def list_invalid_properties
       invalid_properties = Array.new
+      if !@callback_announce_audio_uuid.nil? && @callback_announce_audio_uuid.to_s.length > 50
+        invalid_properties.push('invalid value for "callback_announce_audio_uuid", the character length must be smaller than or equal to 50.')
+      end
+
+      if !@callback_confirm_audio_uuid.nil? && @callback_confirm_audio_uuid.to_s.length > 50
+        invalid_properties.push('invalid value for "callback_confirm_audio_uuid", the character length must be smaller than or equal to 50.')
+      end
+
       if !@conversation_voicemail_mailbox_uuid.nil? && @conversation_voicemail_mailbox_uuid.to_s.length > 50
         invalid_properties.push('invalid value for "conversation_voicemail_mailbox_uuid", the character length must be smaller than or equal to 50.')
       end
@@ -343,6 +459,8 @@ module UltracartClient
     def valid?
       ai_priority_validator = EnumAttributeValidator.new('String', ["neutral", "first", "backup"])
       return false unless ai_priority_validator.valid?(@ai_priority)
+      return false if !@callback_announce_audio_uuid.nil? && @callback_announce_audio_uuid.to_s.length > 50
+      return false if !@callback_confirm_audio_uuid.nil? && @callback_confirm_audio_uuid.to_s.length > 50
       return false if !@conversation_voicemail_mailbox_uuid.nil? && @conversation_voicemail_mailbox_uuid.to_s.length > 50
       return false if !@hold_conversation_pbx_audio_uuid.nil? && @hold_conversation_pbx_audio_uuid.to_s.length > 50
       return false if !@merchant_id.nil? && @merchant_id.to_s.length > 5
@@ -370,6 +488,26 @@ module UltracartClient
       @ai_priority = ai_priority
     end
 
+    # Custom attribute writer method with validation
+    # @param [Object] callback_announce_audio_uuid Value to be assigned
+    def callback_announce_audio_uuid=(callback_announce_audio_uuid)
+      if !callback_announce_audio_uuid.nil? && callback_announce_audio_uuid.to_s.length > 50
+        fail ArgumentError, 'invalid value for "callback_announce_audio_uuid", the character length must be smaller than or equal to 50.'
+      end
+
+      @callback_announce_audio_uuid = callback_announce_audio_uuid
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] callback_confirm_audio_uuid Value to be assigned
+    def callback_confirm_audio_uuid=(callback_confirm_audio_uuid)
+      if !callback_confirm_audio_uuid.nil? && callback_confirm_audio_uuid.to_s.length > 50
+        fail ArgumentError, 'invalid value for "callback_confirm_audio_uuid", the character length must be smaller than or equal to 50.'
+      end
+
+      @callback_confirm_audio_uuid = callback_confirm_audio_uuid
+    end
+
     # Custom attribute writer method with validation
     # @param [Object] conversation_voicemail_mailbox_uuid Value to be assigned
     def conversation_voicemail_mailbox_uuid=(conversation_voicemail_mailbox_uuid)
@@ -479,6 +617,18 @@ module UltracartClient
           ai_timeout_seconds == o.ai_timeout_seconds &&
           announce_queue_position == o.announce_queue_position &&
           automatic_coach_agent_uuid == o.automatic_coach_agent_uuid &&
+          callback_announce_audio_uuid == o.callback_announce_audio_uuid &&
+          callback_announce_say == o.callback_announce_say &&
+          callback_confirm_audio_uuid == o.callback_confirm_audio_uuid &&
+          callback_confirm_say == o.callback_confirm_say &&
+          callback_enabled == o.callback_enabled &&
+          callback_hours_only == o.callback_hours_only &&
+          callback_max_attempts == o.callback_max_attempts &&
+          callback_max_offers == o.callback_max_offers &&
+          callback_max_pending == o.callback_max_pending &&
+          callback_offer_after_seconds == o.callback_offer_after_seconds &&
+          callback_offer_interval_seconds == o.callback_offer_interval_seconds &&
+          callback_retry_delay_seconds == o.callback_retry_delay_seconds &&
           conversation_pbx_queue_uuid == o.conversation_pbx_queue_uuid &&
           conversation_voicemail_mailbox_uuid == o.conversation_voicemail_mailbox_uuid &&
           hold_conversation_pbx_audio_uuid == o.hold_conversation_pbx_audio_uuid &&
@@ -510,7 +660,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [ai_priority, ai_timeout_seconds, announce_queue_position, automatic_coach_agent_uuid, conversation_pbx_queue_uuid, conversation_voicemail_mailbox_uuid, hold_conversation_pbx_audio_uuid, max_hold_seconds, members, merchant_id, name, no_agent_available_play_audio_uuid, no_agent_available_say, no_agent_available_say_voice, play_audio_uuid, record_call, say, say_voice, twilio_taskrouter_workflow_sid, twilio_workspace_queue_sid, voicemail, wait_critical_seconds, wait_warning_seconds, wrap_up_seconds].hash
+      [ai_priority, ai_timeout_seconds, announce_queue_position, automatic_coach_agent_uuid, callback_announce_audio_uuid, callback_announce_say, callback_confirm_audio_uuid, callback_confirm_say, callback_enabled, callback_hours_only, callback_max_attempts, callback_max_offers, callback_max_pending, callback_offer_after_seconds, callback_offer_interval_seconds, callback_retry_delay_seconds, conversation_pbx_queue_uuid, conversation_voicemail_mailbox_uuid, hold_conversation_pbx_audio_uuid, max_hold_seconds, members, merchant_id, name, no_agent_available_play_audio_uuid, no_agent_available_say, no_agent_available_say_voice, play_audio_uuid, record_call, say, say_voice, twilio_taskrouter_workflow_sid, twilio_workspace_queue_sid, voicemail, wait_critical_seconds, wait_warning_seconds, wrap_up_seconds].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.69'
+  VERSION = '4.1.70'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ultracart_api
 version: !ruby/object:Gem::Version
-  version: 4.1.69
+  version: 4.1.70
 platform: ruby
 authors:
 - UltraCart
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-03-31 00:00:00.000000000 Z
+date: 2026-04-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus