ultracart_api 4.1.49 → 4.1.50

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bb9316fd7a346b3fe288aca2ee2b49e61423850e5a44c2c9798574e6a41b7d22
-  data.tar.gz: af49c28c5b99f6371019d5f4c3338c7097448cc66e3a7f3f87095e3d52e7aaec
+  metadata.gz: 6008651fba053b35bc6ebf074cc95b83dd8d5c267b0a126dfc3579b9e0a21db7
+  data.tar.gz: 60403b638cb2c4d7a14a3d47cb5b2bb651021909b1d2003d8d344690ea02ca02
 SHA512:
-  metadata.gz: fcab2faed4fce886e4906c775e2e3a874d88c1318bd6434c7d626d63dd12b5caea7c04427bb7ee941717adc962f24193b773956992cd5618eb06017439e901e9
-  data.tar.gz: ca259eaee7819bd5b4863702767626b9960d14dc48bbbf82764ad39983613566d047d2afd27ec505be3f4e91819fe07b7c707e1a8779840540c0bfa44075e592
+  metadata.gz: fd0e49bd14d61fc32c339e1fba8f3af8ad23bba957d8cc22fcda4de4337d6b6443a459e9d9d39be4c3815c2ef39b8d69a541b7bf283aeb5431af67794a83b5c8
+  data.tar.gz: 73fa68122628a1f3ade947f5a293d71ccec86cf7466f922d9182ef1438bf32e23e555f266a91d46f1b82f5e3b6b81614c100decd34660fa0dac677003e257a9c

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.49
+- Package version: 4.1.50
 - 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.49'
+gem 'ultracart_api', '4.1.50'
 ```
 
 install:
@@ -1635,6 +1635,7 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 4.1.50 | 01/27/2026 | conversations - refinements to support hardware phones |
 | 4.1.49 | 01/26/2026 | no changes - testing changes to build automation |
 | 4.1.48 | 01/26/2026 | conversation - hardware phone methods and objects |
 | 4.1.47 | 01/26/2026 | conversation - agent auth object chat admin/user properties |

data/docs/ConversationPbxAgent.md

@@ -5,14 +5,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] |
@@ -29,14 +31,16 @@ require 'ultracart_api'
 
 instance = UltracartClient::ConversationPbxAgent.new(
   ai: null,
+  call_routing_preference: null,
   cellphone: null,
   conversation_pbx_agent_uuid: null,
   extension: null,
-  forward_calls_to_cellphone: null,
   full_name: null,
+  hardware_phone_uuids: null,
   login: null,
   merchant_id: null,
   personal_conversation_pbx_voicemail_mailbox_uuid: null,
+  preferred_hardware_phone_uuid: null,
   record_outgoing_automatically: null,
   shared_conversation_pbx_voicemail_mailbox_uuid: null,
   twilio_taskrouter_worker_id: null,

data/docs/ConversationPbxHardwarePhone.md

@@ -4,6 +4,8 @@
 
 | 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] |
@@ -14,8 +16,10 @@
 | **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] |
 
 ## Example
@@ -24,6 +28,8 @@
 require 'ultracart_api'
 
 instance = UltracartClient::ConversationPbxHardwarePhone.new(
+  admin_username: null,
+  conversation_pbx_agent_uuid: null,
   conversation_pbx_hardware_phone_uuid: null,
   created_at: null,
   description: null,
@@ -34,8 +40,10 @@ instance = UltracartClient::ConversationPbxHardwarePhone.new(
   name: null,
   provisioning_url: null,
   sip_domain: null,
+  sip_edge_location: null,
   sip_password: null,
   sip_username: null,
+  twilio_credential_sid: null,
   updated_at: null
 )
 ```

data/lib/ultracart_api/models/conversation_pbx_agent.rb

@@ -18,6 +18,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
 
@@ -27,12 +30,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
 
@@ -42,6 +45,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
 
@@ -66,18 +72,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',
@@ -98,14 +128,16 @@ module UltracartClient
     def self.openapi_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',
@@ -142,6 +174,10 @@ module UltracartClient
         self.ai = attributes[:'ai']
       end
 
+      if attributes.key?(:'call_routing_preference')
+        self.call_routing_preference = attributes[:'call_routing_preference']
+      end
+
       if attributes.key?(:'cellphone')
         self.cellphone = attributes[:'cellphone']
       end
@@ -154,14 +190,16 @@ module UltracartClient
         self.extension = attributes[:'extension']
       end
 
-      if attributes.key?(:'forward_calls_to_cellphone')
-        self.forward_calls_to_cellphone = attributes[:'forward_calls_to_cellphone']
-      end
-
       if attributes.key?(:'full_name')
         self.full_name = attributes[:'full_name']
       end
 
+      if attributes.key?(:'hardware_phone_uuids')
+        if (value = attributes[:'hardware_phone_uuids']).is_a?(Array)
+          self.hardware_phone_uuids = value
+        end
+      end
+
       if attributes.key?(:'login')
         self.login = attributes[:'login']
       end
@@ -174,6 +212,10 @@ module UltracartClient
         self.personal_conversation_pbx_voicemail_mailbox_uuid = attributes[:'personal_conversation_pbx_voicemail_mailbox_uuid']
       end
 
+      if attributes.key?(:'preferred_hardware_phone_uuid')
+        self.preferred_hardware_phone_uuid = attributes[:'preferred_hardware_phone_uuid']
+      end
+
       if attributes.key?(:'record_outgoing_automatically')
         self.record_outgoing_automatically = attributes[:'record_outgoing_automatically']
       end
@@ -245,6 +287,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
@@ -255,6 +299,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)
@@ -331,14 +385,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 &&
@@ -358,7 +414,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Integer] 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

@@ -15,6 +15,12 @@ require 'time'
 
 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
 
@@ -45,18 +51,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',
@@ -67,8 +81,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
@@ -81,6 +97,8 @@ module UltracartClient
     # Attribute type mapping.
     def self.openapi_types
       {
+        :'admin_username' => :'String',
+        :'conversation_pbx_agent_uuid' => :'String',
         :'conversation_pbx_hardware_phone_uuid' => :'String',
         :'created_at' => :'Object',
         :'description' => :'String',
@@ -91,8 +109,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
@@ -118,6 +138,14 @@ module UltracartClient
         h[k.to_sym] = v
       }
 
+      if attributes.key?(:'admin_username')
+        self.admin_username = attributes[:'admin_username']
+      end
+
+      if attributes.key?(:'conversation_pbx_agent_uuid')
+        self.conversation_pbx_agent_uuid = attributes[:'conversation_pbx_agent_uuid']
+      end
+
       if attributes.key?(:'conversation_pbx_hardware_phone_uuid')
         self.conversation_pbx_hardware_phone_uuid = attributes[:'conversation_pbx_hardware_phone_uuid']
       end
@@ -158,6 +186,10 @@ module UltracartClient
         self.sip_domain = attributes[:'sip_domain']
       end
 
+      if attributes.key?(:'sip_edge_location')
+        self.sip_edge_location = attributes[:'sip_edge_location']
+      end
+
       if attributes.key?(:'sip_password')
         self.sip_password = attributes[:'sip_password']
       end
@@ -166,6 +198,10 @@ module UltracartClient
         self.sip_username = attributes[:'sip_username']
       end
 
+      if attributes.key?(:'twilio_credential_sid')
+        self.twilio_credential_sid = attributes[:'twilio_credential_sid']
+      end
+
       if attributes.key?(:'updated_at')
         self.updated_at = attributes[:'updated_at']
       end
@@ -207,6 +243,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
@@ -229,6 +269,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
@@ -314,6 +355,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)
@@ -339,6 +390,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 &&
@@ -349,8 +402,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
 
@@ -363,7 +418,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Integer] 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 @@ OpenAPI Generator version: 6.0.1-SNAPSHOT
 =end
 
 module UltracartClient
-  VERSION = '4.1.49'
+  VERSION = '4.1.50'
 end

metadata

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