ultracart_api 4.1.211 → 4.1.212

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 433a8aaea315101666d5b31ee8a8983cb95241f2421824d42d069e463e3cc94c
-  data.tar.gz: 90123646be6a6a72b2dbf8024107caf6d62b5881b6893e4f70f80e9ed2f3e116
+  metadata.gz: daa7439a4c2c9d9b5c10024beb9d848a7b728c9ff5d057a22923f9381802cf38
+  data.tar.gz: 5acd544d65144e915ecf68e29428ec9fd3ba8012fecbe54a992afa54b8fae08c
 SHA512:
-  metadata.gz: e83035d699791416639d17e2443643057d38fc5b6bd6cce8b5dd5432afad09d2d06152f0b4c91909a5d98836ee8e1713ba1bdd7650ca8869ede586dccffdd46a
-  data.tar.gz: c74ca1fc0536aafdfc8010cc1055fce1464b8b965b73930d1f5fd1a68c5465a93a3dfbc3e51a10807fe5b239535f2fcfbdb625f4b185813ea285f35b27c6c3b2
+  metadata.gz: 9137149162a374efa7ab54e06cd729eae0046b7d82d08248d3e8fbfbb368098e57469ae74ce9a2cf3428e19acdddefe24c902a827c78abda8f0f89f0cb37ec91
+  data.tar.gz: 05c4be8139c905ef860a89b6c19ff9b3ed2557eef3975b3298a4720f538b37cda040b24861a92f5f3e9aea5270814ee6323f698b961c58af95f10119da73bae8

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ultracart_api
 version: !ruby/object:Gem::Version
-  version: 4.1.211
+  version: 4.1.212
 platform: ruby
 authors:
 - UltraCart