ultracart_api 3.11.49 → 3.11.50

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7416774596baba1e1589f6fd64c6e61df41c77a849dbe3804ce75c9d627b39b2
-  data.tar.gz: af003dd3a33193f3aae93be6da4719b91e4114793a9bc4eb6517f135d26dca08
+  metadata.gz: e3372c4eb65673c14a350a2decd1c1348939e81d255eedb7b26069256651db5c
+  data.tar.gz: ab8dbc82c4983071f22b8da3c7262989e456279ac939372da186f4e458d6e4d7
 SHA512:
-  metadata.gz: 8445f8bd3c9b8381ef51561bc4dee40351e062ed8afb04867411af8a4d9afce9d67d0850091910a15357ba0464d901b3247f7a148f52a635f18db78756e17bd1
-  data.tar.gz: 0d8f6b9890599eaf4f87dd2f3db1bd253f43e629bdacd2b68a79df4a312e1841ced6c05c4ac120b79501e1417213928fbe462725c94e95918fc17f4acfec080a
+  metadata.gz: 8a98fbdfb7c8baae5c186ec90a9d6fe54dcdd6aacf812e49bd72e8ed9beae839eb94f9e53460d7264451771f1a94b29e1d047555b82b585c1d92e6cfa955810e
+  data.tar.gz: 4ccfd0cdd727ece5f4a46adbf354f08a6e9cdf03276343245dc84af7aa3efab85fe89b9ac728aab2b1d75e05321551043507a837c7e9690a5dc214d56a925d9c

data/README.md

@@ -7,7 +7,7 @@ UltraCart REST API Version 2
 This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
 
 - API version: 2.0.0
-- Package version: 3.11.49
+- Package version: 3.11.50
 - Build package: io.swagger.codegen.languages.RubyClientCodegen
 For more information, please visit [http://www.ultracart.com/api/](http://www.ultracart.com/api/)
 
@@ -24,15 +24,15 @@ gem build ultracart_api.gemspec
 Then either install the gem locally:
 
 ```shell
-gem install ./ultracart_api-3.11.49.gem
+gem install ./ultracart_api-3.11.50.gem
 ```
-(for development, run `gem install --dev ./ultracart_api-3.11.49.gem` to install the development dependencies)
+(for development, run `gem install --dev ./ultracart_api-3.11.50.gem` to install the development dependencies)
 
 or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
 
 Finally add this to the Gemfile:
 
-    gem 'ultracart_api', '~> 3.11.49'
+    gem 'ultracart_api', '~> 3.11.50'
 
 ### Install from Git
 
@@ -1637,6 +1637,7 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 3.11.50 | 01/27/2026 | conversations - refinements to support hardware phones |
 | 3.11.49 | 01/26/2026 | no changes - testing changes to build automation |
 | 3.11.48 | 01/26/2026 | conversation - hardware phone methods and objects |
 | 3.11.47 | 01/26/2026 | conversation - agent auth object chat admin/user properties |

data/docs/ConversationPbxAgent.md

@@ -4,14 +4,16 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **ai** | **BOOLEAN** | Flag to indicate if the agent is AI | [optional] 
+**call_routing_preference** | **String** | The call routing preference | [optional] 
 **cellphone** | **String** | Cellphone number of agent in E.164 format | [optional] 
 **conversation_pbx_agent_uuid** | **String** | Conversation Pbx Agent unique identifier | [optional] 
 **extension** | **Integer** | Extension | [optional] 
-**forward_calls_to_cellphone** | **BOOLEAN** | True if calls to this agent should be forwarded to their cellphone | [optional] 
 **full_name** | **String** | Full name | [optional] 
+**hardware_phone_uuids** | **Array<String>** | Array of hardware phones UUIDs associated with this agent | [optional] 
 **login** | **String** | Agent login | [optional] 
 **merchant_id** | **String** | Merchant Id | [optional] 
 **personal_conversation_pbx_voicemail_mailbox_uuid** | **String** | Personal Conversation Pbx Voicemail Mailbox UUID | [optional] 
+**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] 
 **twilio_taskrouter_worker_id** | **String** | Twilio taskrouter worker Id | [optional] 

data/docs/ConversationPbxHardwarePhone.md

@@ -3,6 +3,8 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
+**admin_username** | **String** | Admin Username | [optional] 
+**conversation_pbx_agent_uuid** | **String** | Associated Agent UUID | [optional] 
 **conversation_pbx_hardware_phone_uuid** | **String** | Conversation Pbx Hardware Phone UUID | [optional] 
 **created_at** | **Object** | Created At | [optional] 
 **description** | **String** | Description | [optional] 
@@ -13,8 +15,10 @@ Name | Type | Description | Notes
 **name** | **String** | Name | [optional] 
 **provisioning_url** | **String** | Auto-provisioning URL for phone configuration | [optional] 
 **sip_domain** | **String** | SIP Domain | [optional] 
-**sip_password** | **String** | SIP Password | [optional] 
+**sip_edge_location** | **String** | SIP Edge Location | [optional] 
+**sip_password** | **String** | SIP Password (only on create or regenerate password requests) | [optional] 
 **sip_username** | **String** | SIP Username | [optional] 
+**twilio_credential_sid** | **String** | Twilio Credential SID | [optional] 
 **updated_at** | **Object** | Updated At | [optional] 
 
 

data/lib/ultracart_api/models/conversation_pbx_agent.rb

@@ -17,6 +17,9 @@ module UltracartClient
     # Flag to indicate if the agent is AI
     attr_accessor :ai
 
+    # The call routing preference
+    attr_accessor :call_routing_preference
+
     # Cellphone number of agent in E.164 format
     attr_accessor :cellphone
 
@@ -26,12 +29,12 @@ module UltracartClient
     # Extension
     attr_accessor :extension
 
-    # True if calls to this agent should be forwarded to their cellphone
-    attr_accessor :forward_calls_to_cellphone
-
     # Full name
     attr_accessor :full_name
 
+    # Array of hardware phones UUIDs associated with this agent
+    attr_accessor :hardware_phone_uuids
+
     # Agent login
     attr_accessor :login
 
@@ -41,6 +44,9 @@ module UltracartClient
     # Personal Conversation Pbx Voicemail Mailbox UUID
     attr_accessor :personal_conversation_pbx_voicemail_mailbox_uuid
 
+    # The hardware phone that will be dialed on an incoming call if routing preference is hardware_phone
+    attr_accessor :preferred_hardware_phone_uuid
+
     # True if outgoing calls should be automatically recorded
     attr_accessor :record_outgoing_automatically
 
@@ -65,18 +71,42 @@ module UltracartClient
     # True if this agent has voicemail configured
     attr_accessor :voicemail
 
+    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
       {
         :'ai' => :'ai',
+        :'call_routing_preference' => :'call_routing_preference',
         :'cellphone' => :'cellphone',
         :'conversation_pbx_agent_uuid' => :'conversation_pbx_agent_uuid',
         :'extension' => :'extension',
-        :'forward_calls_to_cellphone' => :'forward_calls_to_cellphone',
         :'full_name' => :'full_name',
+        :'hardware_phone_uuids' => :'hardware_phone_uuids',
         :'login' => :'login',
         :'merchant_id' => :'merchant_id',
         :'personal_conversation_pbx_voicemail_mailbox_uuid' => :'personal_conversation_pbx_voicemail_mailbox_uuid',
+        :'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',
         :'twilio_taskrouter_worker_id' => :'twilio_taskrouter_worker_id',
@@ -92,14 +122,16 @@ module UltracartClient
     def self.swagger_types
       {
         :'ai' => :'BOOLEAN',
+        :'call_routing_preference' => :'String',
         :'cellphone' => :'String',
         :'conversation_pbx_agent_uuid' => :'String',
         :'extension' => :'Integer',
-        :'forward_calls_to_cellphone' => :'BOOLEAN',
         :'full_name' => :'String',
+        :'hardware_phone_uuids' => :'Array<String>',
         :'login' => :'String',
         :'merchant_id' => :'String',
         :'personal_conversation_pbx_voicemail_mailbox_uuid' => :'String',
+        :'preferred_hardware_phone_uuid' => :'String',
         :'record_outgoing_automatically' => :'BOOLEAN',
         :'shared_conversation_pbx_voicemail_mailbox_uuid' => :'String',
         :'twilio_taskrouter_worker_id' => :'String',
@@ -123,6 +155,10 @@ module UltracartClient
         self.ai = attributes[:'ai']
       end
 
+      if attributes.has_key?(:'call_routing_preference')
+        self.call_routing_preference = attributes[:'call_routing_preference']
+      end
+
       if attributes.has_key?(:'cellphone')
         self.cellphone = attributes[:'cellphone']
       end
@@ -135,14 +171,16 @@ module UltracartClient
         self.extension = attributes[:'extension']
       end
 
-      if attributes.has_key?(:'forward_calls_to_cellphone')
-        self.forward_calls_to_cellphone = attributes[:'forward_calls_to_cellphone']
-      end
-
       if attributes.has_key?(:'full_name')
         self.full_name = attributes[:'full_name']
       end
 
+      if attributes.has_key?(:'hardware_phone_uuids')
+        if (value = attributes[:'hardware_phone_uuids']).is_a?(Array)
+          self.hardware_phone_uuids = value
+        end
+      end
+
       if attributes.has_key?(:'login')
         self.login = attributes[:'login']
       end
@@ -155,6 +193,10 @@ module UltracartClient
         self.personal_conversation_pbx_voicemail_mailbox_uuid = attributes[:'personal_conversation_pbx_voicemail_mailbox_uuid']
       end
 
+      if attributes.has_key?(:'preferred_hardware_phone_uuid')
+        self.preferred_hardware_phone_uuid = attributes[:'preferred_hardware_phone_uuid']
+      end
+
       if attributes.has_key?(:'record_outgoing_automatically')
         self.record_outgoing_automatically = attributes[:'record_outgoing_automatically']
       end
@@ -226,6 +268,8 @@ module UltracartClient
     # Check to see if the all the properties in the model are valid
     # @return true if the model is valid
     def valid?
+      call_routing_preference_validator = EnumAttributeValidator.new('String', ['softphone', 'hardware_phone', 'cellphone'])
+      return false unless call_routing_preference_validator.valid?(@call_routing_preference)
       return false if !@cellphone.nil? && @cellphone.to_s.length > 50
       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
@@ -236,6 +280,16 @@ module UltracartClient
       true
     end
 
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] call_routing_preference Object to be assigned
+    def call_routing_preference=(call_routing_preference)
+      validator = EnumAttributeValidator.new('String', ['softphone', 'hardware_phone', 'cellphone'])
+      unless validator.valid?(call_routing_preference)
+        fail ArgumentError, 'invalid value for "call_routing_preference", must be one of #{validator.allowable_values}.'
+      end
+      @call_routing_preference = call_routing_preference
+    end
+
     # Custom attribute writer method with validation
     # @param [Object] cellphone Value to be assigned
     def cellphone=(cellphone)
@@ -312,14 +366,16 @@ module UltracartClient
       return true if self.equal?(o)
       self.class == o.class &&
           ai == o.ai &&
+          call_routing_preference == o.call_routing_preference &&
           cellphone == o.cellphone &&
           conversation_pbx_agent_uuid == o.conversation_pbx_agent_uuid &&
           extension == o.extension &&
-          forward_calls_to_cellphone == o.forward_calls_to_cellphone &&
           full_name == o.full_name &&
+          hardware_phone_uuids == o.hardware_phone_uuids &&
           login == o.login &&
           merchant_id == o.merchant_id &&
           personal_conversation_pbx_voicemail_mailbox_uuid == o.personal_conversation_pbx_voicemail_mailbox_uuid &&
+          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 &&
           twilio_taskrouter_worker_id == o.twilio_taskrouter_worker_id &&
@@ -339,7 +395,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [ai, cellphone, conversation_pbx_agent_uuid, extension, forward_calls_to_cellphone, full_name, login, merchant_id, personal_conversation_pbx_voicemail_mailbox_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].hash
+      [ai, call_routing_preference, cellphone, conversation_pbx_agent_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].hash
     end
 
     # Builds the object from hash

data/lib/ultracart_api/models/conversation_pbx_hardware_phone.rb

@@ -14,6 +14,12 @@ require 'date'
 
 module UltracartClient
   class ConversationPbxHardwarePhone
+    # Admin Username
+    attr_accessor :admin_username
+
+    # Associated Agent UUID
+    attr_accessor :conversation_pbx_agent_uuid
+
     # Conversation Pbx Hardware Phone UUID
     attr_accessor :conversation_pbx_hardware_phone_uuid
 
@@ -44,18 +50,26 @@ module UltracartClient
     # SIP Domain
     attr_accessor :sip_domain
 
-    # SIP Password
+    # SIP Edge Location
+    attr_accessor :sip_edge_location
+
+    # SIP Password (only on create or regenerate password requests)
     attr_accessor :sip_password
 
     # SIP Username
     attr_accessor :sip_username
 
+    # Twilio Credential SID
+    attr_accessor :twilio_credential_sid
+
     # Updated At
     attr_accessor :updated_at
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
+        :'admin_username' => :'admin_username',
+        :'conversation_pbx_agent_uuid' => :'conversation_pbx_agent_uuid',
         :'conversation_pbx_hardware_phone_uuid' => :'conversation_pbx_hardware_phone_uuid',
         :'created_at' => :'created_at',
         :'description' => :'description',
@@ -66,8 +80,10 @@ module UltracartClient
         :'name' => :'name',
         :'provisioning_url' => :'provisioning_url',
         :'sip_domain' => :'sip_domain',
+        :'sip_edge_location' => :'sip_edge_location',
         :'sip_password' => :'sip_password',
         :'sip_username' => :'sip_username',
+        :'twilio_credential_sid' => :'twilio_credential_sid',
         :'updated_at' => :'updated_at'
       }
     end
@@ -75,6 +91,8 @@ module UltracartClient
     # Attribute type mapping.
     def self.swagger_types
       {
+        :'admin_username' => :'String',
+        :'conversation_pbx_agent_uuid' => :'String',
         :'conversation_pbx_hardware_phone_uuid' => :'String',
         :'created_at' => :'Object',
         :'description' => :'String',
@@ -85,8 +103,10 @@ module UltracartClient
         :'name' => :'String',
         :'provisioning_url' => :'String',
         :'sip_domain' => :'String',
+        :'sip_edge_location' => :'String',
         :'sip_password' => :'String',
         :'sip_username' => :'String',
+        :'twilio_credential_sid' => :'String',
         :'updated_at' => :'Object'
       }
     end
@@ -99,6 +119,14 @@ module UltracartClient
       # convert string to symbol for hash key
       attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
 
+      if attributes.has_key?(:'admin_username')
+        self.admin_username = attributes[:'admin_username']
+      end
+
+      if attributes.has_key?(:'conversation_pbx_agent_uuid')
+        self.conversation_pbx_agent_uuid = attributes[:'conversation_pbx_agent_uuid']
+      end
+
       if attributes.has_key?(:'conversation_pbx_hardware_phone_uuid')
         self.conversation_pbx_hardware_phone_uuid = attributes[:'conversation_pbx_hardware_phone_uuid']
       end
@@ -139,6 +167,10 @@ module UltracartClient
         self.sip_domain = attributes[:'sip_domain']
       end
 
+      if attributes.has_key?(:'sip_edge_location')
+        self.sip_edge_location = attributes[:'sip_edge_location']
+      end
+
       if attributes.has_key?(:'sip_password')
         self.sip_password = attributes[:'sip_password']
       end
@@ -147,6 +179,10 @@ module UltracartClient
         self.sip_username = attributes[:'sip_username']
       end
 
+      if attributes.has_key?(:'twilio_credential_sid')
+        self.twilio_credential_sid = attributes[:'twilio_credential_sid']
+      end
+
       if attributes.has_key?(:'updated_at')
         self.updated_at = attributes[:'updated_at']
       end
@@ -188,6 +224,10 @@ module UltracartClient
         invalid_properties.push('invalid value for "sip_domain", the character length must be smaller than or equal to 200.')
       end
 
+      if !@sip_edge_location.nil? && @sip_edge_location.to_s.length > 50
+        invalid_properties.push('invalid value for "sip_edge_location", the character length must be smaller than or equal to 50.')
+      end
+
       if !@sip_password.nil? && @sip_password.to_s.length > 100
         invalid_properties.push('invalid value for "sip_password", the character length must be smaller than or equal to 100.')
       end
@@ -210,6 +250,7 @@ module UltracartClient
       return false if !@model.nil? && @model.to_s.length > 100
       return false if !@name.nil? && @name.to_s.length > 100
       return false if !@sip_domain.nil? && @sip_domain.to_s.length > 200
+      return false if !@sip_edge_location.nil? && @sip_edge_location.to_s.length > 50
       return false if !@sip_password.nil? && @sip_password.to_s.length > 100
       return false if !@sip_username.nil? && @sip_username.to_s.length > 100
       true
@@ -295,6 +336,16 @@ module UltracartClient
       @sip_domain = sip_domain
     end
 
+    # Custom attribute writer method with validation
+    # @param [Object] sip_edge_location Value to be assigned
+    def sip_edge_location=(sip_edge_location)
+      if !sip_edge_location.nil? && sip_edge_location.to_s.length > 50
+        fail ArgumentError, 'invalid value for "sip_edge_location", the character length must be smaller than or equal to 50.'
+      end
+
+      @sip_edge_location = sip_edge_location
+    end
+
     # Custom attribute writer method with validation
     # @param [Object] sip_password Value to be assigned
     def sip_password=(sip_password)
@@ -320,6 +371,8 @@ module UltracartClient
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
+          admin_username == o.admin_username &&
+          conversation_pbx_agent_uuid == o.conversation_pbx_agent_uuid &&
           conversation_pbx_hardware_phone_uuid == o.conversation_pbx_hardware_phone_uuid &&
           created_at == o.created_at &&
           description == o.description &&
@@ -330,8 +383,10 @@ module UltracartClient
           name == o.name &&
           provisioning_url == o.provisioning_url &&
           sip_domain == o.sip_domain &&
+          sip_edge_location == o.sip_edge_location &&
           sip_password == o.sip_password &&
           sip_username == o.sip_username &&
+          twilio_credential_sid == o.twilio_credential_sid &&
           updated_at == o.updated_at
     end
 
@@ -344,7 +399,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [conversation_pbx_hardware_phone_uuid, created_at, description, mac_address, manufacturer, merchant_id, model, name, provisioning_url, sip_domain, sip_password, sip_username, updated_at].hash
+      [admin_username, conversation_pbx_agent_uuid, conversation_pbx_hardware_phone_uuid, created_at, description, mac_address, manufacturer, merchant_id, model, name, provisioning_url, sip_domain, sip_edge_location, sip_password, sip_username, twilio_credential_sid, updated_at].hash
     end
 
     # Builds the object from hash

data/lib/ultracart_api/version.rb

@@ -11,5 +11,5 @@ Swagger Codegen version: 2.4.15-SNAPSHOT
 =end
 
 module UltracartClient
-  VERSION = '3.11.49'
+  VERSION = '3.11.50'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ultracart_api
 version: !ruby/object:Gem::Version
-  version: 3.11.49
+  version: 3.11.50
 platform: ruby
 authors:
 - UltraCart
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-01-26 00:00:00.000000000 Z
+date: 2026-01-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus