ultracart_api 4.1.51 → 4.1.54

data/docs/ConversationPbxCallSearchRequest.md

@@ -0,0 +1,48 @@
+# UltracartClient::ConversationPbxCallSearchRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **agent_ids** | **Array<String>** | Filter by agent IDs | [optional] |
+| **customer_name** | **String** | Filter by customer name | [optional] |
+| **direction** | **String** | Filter by call direction (inbound/outbound) | [optional] |
+| **disposition** | **String** | Filter by call disposition | [optional] |
+| **end_date** | **String** | Filter calls created on or before this date (ISO 8601) | [optional] |
+| **has_ai_engagement** | **Boolean** | Filter to calls with AI agent engagement | [optional] |
+| **has_recording** | **Boolean** | Filter to calls that have a recording | [optional] |
+| **has_transcript** | **Boolean** | Filter to calls that have a transcript | [optional] |
+| **max_duration_seconds** | **Integer** | Filter by maximum call duration in seconds | [optional] |
+| **min_duration_seconds** | **Integer** | Filter by minimum call duration in seconds | [optional] |
+| **phone_number** | **String** | Filter by phone number (partial match supported) | [optional] |
+| **queue_uuids** | **Array<String>** | Filter by queue UUIDs | [optional] |
+| **search_term** | **String** | Free text search term - smart-routed based on content (phone, email, UUID, or general text) | [optional] |
+| **start_date** | **String** | Filter calls created on or after this date (ISO 8601) | [optional] |
+| **statuses** | **Array<String>** | Filter by call statuses | [optional] |
+| **transcript_search** | **String** | Search within transcript text | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::ConversationPbxCallSearchRequest.new(
+  agent_ids: null,
+  customer_name: null,
+  direction: null,
+  disposition: null,
+  end_date: null,
+  has_ai_engagement: null,
+  has_recording: null,
+  has_transcript: null,
+  max_duration_seconds: null,
+  min_duration_seconds: null,
+  phone_number: null,
+  queue_uuids: null,
+  search_term: null,
+  start_date: null,
+  statuses: null,
+  transcript_search: null
+)
+```
+

data/docs/ConversationPbxCallSearchResponse.md

@@ -0,0 +1,26 @@
+# UltracartClient::ConversationPbxCallSearchResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **calls** | [**Array<ConversationPbxCall>**](ConversationPbxCall.md) | calls | [optional] |
+| **error** | [**Error**](Error.md) |  | [optional] |
+| **metadata** | [**ResponseMetadata**](ResponseMetadata.md) |  | [optional] |
+| **success** | **Boolean** | Indicates if API call was successful | [optional] |
+| **warning** | [**Warning**](Warning.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::ConversationPbxCallSearchResponse.new(
+  calls: null,
+  error: null,
+  metadata: null,
+  success: null,
+  warning: null
+)
+```
+

data/docs/ConversationPbxCallTimeline.md

@@ -0,0 +1,28 @@
+# UltracartClient::ConversationPbxCallTimeline
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **answer_dts** | **String** | Timestamp when the call was answered | [optional] |
+| **created_dts** | **String** | Timestamp when the call was created/initiated | [optional] |
+| **end_dts** | **String** | Timestamp when the call ended | [optional] |
+| **queue_wait_seconds** | **Integer** | Time spent waiting in queue in seconds | [optional] |
+| **talk_time_seconds** | **Integer** | Actual talk time in seconds (excluding hold time and queue wait) | [optional] |
+| **total_duration_seconds** | **Integer** | Total duration of the call in seconds from creation to end | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::ConversationPbxCallTimeline.new(
+  answer_dts: null,
+  created_dts: null,
+  end_dts: null,
+  queue_wait_seconds: null,
+  talk_time_seconds: null,
+  total_duration_seconds: null
+)
+```
+

data/docs/ConversationPbxCallTranscript.md

@@ -0,0 +1,30 @@
+# UltracartClient::ConversationPbxCallTranscript
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **full_transcript_s3_key** | **String** | S3 key for the full transcript text file | [optional] |
+| **job_name** | **String** | AWS Transcribe job name | [optional] |
+| **language_code** | **String** | Language code for transcription | [optional] |
+| **provider** | **String** | Transcription service provider | [optional] |
+| **segments** | [**Array<ConversationPbxCallTranscriptSegment>**](ConversationPbxCallTranscriptSegment.md) | Transcript segments with speaker labels and timestamps | [optional] |
+| **status** | **String** | Status of the transcription | [optional] |
+| **transcript_json_s3_key** | **String** | S3 key for the detailed transcript JSON with speaker diarization | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::ConversationPbxCallTranscript.new(
+  full_transcript_s3_key: null,
+  job_name: null,
+  language_code: null,
+  provider: null,
+  segments: null,
+  status: null,
+  transcript_json_s3_key: null
+)
+```
+

data/docs/ConversationPbxCallTranscriptSegment.md

@@ -0,0 +1,30 @@
+# UltracartClient::ConversationPbxCallTranscriptSegment
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **agent_id** | **String** | Agent ID if speaker is an agent | [optional] |
+| **channel** | **String** | Audio channel identifier (e.g. ch_0, ch_1) | [optional] |
+| **confidence** | **Float** | Transcription confidence score (0-1) | [optional] |
+| **end_time** | **Float** | End time in seconds from beginning of recording | [optional] |
+| **speaker** | **String** | Speaker role | [optional] |
+| **start_time** | **Float** | Start time in seconds from beginning of recording | [optional] |
+| **text** | **String** | Transcribed text for this segment | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::ConversationPbxCallTranscriptSegment.new(
+  agent_id: null,
+  channel: null,
+  confidence: null,
+  end_time: null,
+  speaker: null,
+  start_time: null,
+  text: null
+)
+```
+

data/docs/ConversationPbxCallTransfer.md

@@ -0,0 +1,26 @@
+# UltracartClient::ConversationPbxCallTransfer
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **transfer_reason** | **String** | Reason provided for the transfer | [optional] |
+| **transfer_type** | **String** | Type of transfer performed | [optional] |
+| **transferred_at_dts** | **String** | Timestamp when the transfer occurred | [optional] |
+| **transferred_by_agent_id** | **String** | ID of the agent who initiated the transfer | [optional] |
+| **transferred_to** | **String** | Destination of the transfer (agent ID, queue name, or phone number) | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::ConversationPbxCallTransfer.new(
+  transfer_reason: null,
+  transfer_type: null,
+  transferred_at_dts: null,
+  transferred_by_agent_id: null,
+  transferred_to: null
+)
+```
+

data/docs/ConversationPbxPhoneNumber.md

@@ -8,6 +8,7 @@
 | **action_target** | **String** | Action target.  This is the UUID associated with the configuration object of that particular type. | [optional] |
 | **address_sid** | **String** | Twilio Address SID linked to this phone number for regulatory compliance | [optional] |
 | **conversation_pbx_phone_number_uuid** | **String** | Conversation Pbx Phone Number UUID | [optional] |
+| **default_phone_number** | **Boolean** | Default phone number for outbound calling. | [optional] |
 | **deletion_protected** | **Boolean** | If true, this phone number cannot be deleted through the API. It must be deleted via the Twilio console. | [optional] |
 | **merchant_id** | **String** | Merchant Id | [optional] |
 | **phone_number** | **String** | Phone number | [optional] |
@@ -22,6 +23,7 @@ instance = UltracartClient::ConversationPbxPhoneNumber.new(
   action_target: null,
   address_sid: null,
   conversation_pbx_phone_number_uuid: null,
+  default_phone_number: null,
   deletion_protected: null,
   merchant_id: null,
   phone_number: null

data/lib/ultracart_api/api/conversation_api.rb

@@ -3275,6 +3275,70 @@ module UltracartClient
       return data, status_code, headers
     end
 
+    # Get pbx call record
+    # Retrieve a single PBX call record with full details 
+    # @param call_uuid [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [ConversationPbxCallResponse]
+    def get_pbx_call(call_uuid, opts = {})
+      data, _status_code, _headers = get_pbx_call_with_http_info(call_uuid, opts)
+      data
+    end
+
+    # Get pbx call record
+    # Retrieve a single PBX call record with full details 
+    # @param call_uuid [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(ConversationPbxCallResponse, Integer, Hash)>] ConversationPbxCallResponse data, response status code and response headers
+    def get_pbx_call_with_http_info(call_uuid, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ConversationApi.get_pbx_call ...'
+      end
+      # verify the required parameter 'call_uuid' is set
+      if @api_client.config.client_side_validation && call_uuid.nil?
+        fail ArgumentError, "Missing the required parameter 'call_uuid' when calling ConversationApi.get_pbx_call"
+      end
+      # resource path
+      local_var_path = '/conversation/pbx/call/{callUuid}'.sub('{' + 'callUuid' + '}', CGI.escape(call_uuid.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'ConversationPbxCallResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
+
+      new_options = opts.merge(
+        :operation => :"ConversationApi.get_pbx_call",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ConversationApi#get_pbx_call\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Get pbx hardware phone
     # Retrieve a pbx hardware phone 
     # @param conversation_pbx_hardware_phone_uuid [String] 
@@ -6103,6 +6167,84 @@ module UltracartClient
       return data, status_code, headers
     end
 
+    # Search pbx call records
+    # Search and list PBX call records with filtering, sorting, and pagination 
+    # @param search_request [ConversationPbxCallSearchRequest] Search Request
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :_limit The maximum number of records to return on this one API call. (Maximum 200) (default to 100)
+    # @option opts [Integer] :_offset Pagination of the record set.  Offset is a zero based index. (default to 0)
+    # @option opts [String] :_sort The sort order of the calls.
+    # @return [ConversationPbxCallSearchResponse]
+    def search_pbx_calls(search_request, opts = {})
+      data, _status_code, _headers = search_pbx_calls_with_http_info(search_request, opts)
+      data
+    end
+
+    # Search pbx call records
+    # Search and list PBX call records with filtering, sorting, and pagination 
+    # @param search_request [ConversationPbxCallSearchRequest] Search Request
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :_limit The maximum number of records to return on this one API call. (Maximum 200) (default to 100)
+    # @option opts [Integer] :_offset Pagination of the record set.  Offset is a zero based index. (default to 0)
+    # @option opts [String] :_sort The sort order of the calls.
+    # @return [Array<(ConversationPbxCallSearchResponse, Integer, Hash)>] ConversationPbxCallSearchResponse data, response status code and response headers
+    def search_pbx_calls_with_http_info(search_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ConversationApi.search_pbx_calls ...'
+      end
+      # verify the required parameter 'search_request' is set
+      if @api_client.config.client_side_validation && search_request.nil?
+        fail ArgumentError, "Missing the required parameter 'search_request' when calling ConversationApi.search_pbx_calls"
+      end
+      # resource path
+      local_var_path = '/conversation/pbx/call/search'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'_limit'] = opts[:'_limit'] if !opts[:'_limit'].nil?
+      query_params[:'_offset'] = opts[:'_offset'] if !opts[:'_offset'].nil?
+      query_params[:'_sort'] = opts[:'_sort'] if !opts[:'_sort'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(search_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'ConversationPbxCallSearchResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
+
+      new_options = opts.merge(
+        :operation => :"ConversationApi.search_pbx_calls",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ConversationApi#search_pbx_calls\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Unsubscribe any SMS participants in this conversation
     # Unsubscribe any SMS participants in this conversation 
     # @param conversation_uuid [String] 

data/lib/ultracart_api/models/conversation_pbx_agent.rb

@@ -27,6 +27,9 @@ module UltracartClient
     # Conversation Pbx Agent unique identifier
     attr_accessor :conversation_pbx_agent_uuid
 
+    # The default phone number that this agent should dial out to the PSTN with.
+    attr_accessor :default_phone_number_uuid
+
     # Extension
     attr_accessor :extension
 
@@ -101,6 +104,7 @@ module UltracartClient
         :'call_routing_preference' => :'call_routing_preference',
         :'cellphone' => :'cellphone',
         :'conversation_pbx_agent_uuid' => :'conversation_pbx_agent_uuid',
+        :'default_phone_number_uuid' => :'default_phone_number_uuid',
         :'extension' => :'extension',
         :'full_name' => :'full_name',
         :'hardware_phone_uuids' => :'hardware_phone_uuids',
@@ -131,6 +135,7 @@ module UltracartClient
         :'call_routing_preference' => :'String',
         :'cellphone' => :'String',
         :'conversation_pbx_agent_uuid' => :'String',
+        :'default_phone_number_uuid' => :'String',
         :'extension' => :'Integer',
         :'full_name' => :'String',
         :'hardware_phone_uuids' => :'Array<String>',
@@ -186,6 +191,10 @@ module UltracartClient
         self.conversation_pbx_agent_uuid = attributes[:'conversation_pbx_agent_uuid']
       end
 
+      if attributes.key?(:'default_phone_number_uuid')
+        self.default_phone_number_uuid = attributes[:'default_phone_number_uuid']
+      end
+
       if attributes.key?(:'extension')
         self.extension = attributes[:'extension']
       end
@@ -388,6 +397,7 @@ module UltracartClient
           call_routing_preference == o.call_routing_preference &&
           cellphone == o.cellphone &&
           conversation_pbx_agent_uuid == o.conversation_pbx_agent_uuid &&
+          default_phone_number_uuid == o.default_phone_number_uuid &&
           extension == o.extension &&
           full_name == o.full_name &&
           hardware_phone_uuids == o.hardware_phone_uuids &&
@@ -414,7 +424,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, 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
+      [ai, call_routing_preference, cellphone, conversation_pbx_agent_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].hash
     end
 
     # Builds the object from hash