sentdm 0.39.0 → 0.40.0

data/rbi/sentdm/models/voice/call.rbi

@@ -15,11 +15,28 @@ module Sentdm
         sig { params(id: String).void }
         attr_writer :id
 
+        # The voice agent that answered the call, such as
+        # agent_9f2ab000-0000-4000-8000-000000000001. Null for an inapp call
+        sig { returns(T.nilable(String)) }
+        attr_accessor :agent_id
+
         # When the call was answered (UTC). Null until then, and always null for a call
         # between two of your app users
         sig { returns(T.nilable(Time)) }
         attr_accessor :answered_at
 
+        # The caller id shown on the phone leg, in E.164 format: the one your answer
+        # chose, or the owning number when it chose none. Null for a call with no phone
+        # leg
+        sig { returns(T.nilable(String)) }
+        attr_accessor :caller_id_used
+
+        # The phone number the call was connected to, in E.164 format: the number your
+        # answer dialed, or the fallback number a call to one of your voice agents
+        # reached. Null when the call was not connected to a phone number
+        sig { returns(T.nilable(String)) }
+        attr_accessor :connected_number
+
         # outbound for a call placed from your app, inbound for a call to one of your
         # numbers
         sig { returns(T.nilable(String)) }
@@ -37,9 +54,9 @@ module Sentdm
         attr_accessor :ended_at
 
         # Why the call did not complete: callback_timeout, invalid_answer,
-        # insufficient_balance, destination_blocked, callback_not_configured, rejected or
-        # no_answer. Null while the call is live, when it completed, and when it failed
-        # without a recorded reason
+        # insufficient_balance, destination_blocked, callback_not_configured, rejected,
+        # no_answer, or for an agent call agent_busy or agent_unreachable. Null while the
+        # call is live, when it completed, and when it failed without a recorded reason
         sig { returns(T.nilable(String)) }
         attr_accessor :failure_reason
 
@@ -50,8 +67,16 @@ module Sentdm
         sig { params(from: Sentdm::Voice::CallParty::OrHash).void }
         attr_writer :from
 
+        # The legs the price covers, one entry per billed leg, each with its own cost: a
+        # call your answer connected to a phone number ran the caller's leg to your number
+        # and the leg to the connected number at once, and both are billed. Null until the
+        # call has been priced
+        sig { returns(T.nilable(T::Array[Sentdm::Voice::Call::Leg])) }
+        attr_accessor :legs
+
         # The calling mode: inapp for a call between people in your app and phone numbers,
-        # routed by your number's callback URL
+        # routed by your number's callback URL; agent for a call one of your voice agents
+        # answered
         sig { returns(T.nilable(String)) }
         attr_reader :mode
 
@@ -107,12 +132,16 @@ module Sentdm
         sig do
           params(
             id: String,
+            agent_id: T.nilable(String),
             answered_at: T.nilable(Time),
+            caller_id_used: T.nilable(String),
+            connected_number: T.nilable(String),
             direction: String,
             duration_seconds: T.nilable(Integer),
             ended_at: T.nilable(Time),
             failure_reason: T.nilable(String),
             from: Sentdm::Voice::CallParty::OrHash,
+            legs: T.nilable(T::Array[Sentdm::Voice::Call::Leg::OrHash]),
             mode: String,
             number: String,
             price: T.nilable(Float),
@@ -128,9 +157,20 @@ module Sentdm
           # The call id, the same one carried by the call.request question and every call
           # webhook
           id: nil,
+          # The voice agent that answered the call, such as
+          # agent_9f2ab000-0000-4000-8000-000000000001. Null for an inapp call
+          agent_id: nil,
           # When the call was answered (UTC). Null until then, and always null for a call
           # between two of your app users
           answered_at: nil,
+          # The caller id shown on the phone leg, in E.164 format: the one your answer
+          # chose, or the owning number when it chose none. Null for a call with no phone
+          # leg
+          caller_id_used: nil,
+          # The phone number the call was connected to, in E.164 format: the number your
+          # answer dialed, or the fallback number a call to one of your voice agents
+          # reached. Null when the call was not connected to a phone number
+          connected_number: nil,
           # outbound for a call placed from your app, inbound for a call to one of your
           # numbers
           direction: nil,
@@ -139,14 +179,20 @@ module Sentdm
           # When the call ended (UTC). Null while the call is live
           ended_at: nil,
           # Why the call did not complete: callback_timeout, invalid_answer,
-          # insufficient_balance, destination_blocked, callback_not_configured, rejected or
-          # no_answer. Null while the call is live, when it completed, and when it failed
-          # without a recorded reason
+          # insufficient_balance, destination_blocked, callback_not_configured, rejected,
+          # no_answer, or for an agent call agent_busy or agent_unreachable. Null while the
+          # call is live, when it completed, and when it failed without a recorded reason
           failure_reason: nil,
           # One end of a call
           from: nil,
+          # The legs the price covers, one entry per billed leg, each with its own cost: a
+          # call your answer connected to a phone number ran the caller's leg to your number
+          # and the leg to the connected number at once, and both are billed. Null until the
+          # call has been priced
+          legs: nil,
           # The calling mode: inapp for a call between people in your app and phone numbers,
-          # routed by your number's callback URL
+          # routed by your number's callback URL; agent for a call one of your voice agents
+          # answered
           mode: nil,
           # Your number that owns the call, in E.164 format: the dialed number for an
           # inbound call, the caller's bound number for a call placed from your app
@@ -171,12 +217,16 @@ module Sentdm
           override.returns(
             {
               id: String,
+              agent_id: T.nilable(String),
               answered_at: T.nilable(Time),
+              caller_id_used: T.nilable(String),
+              connected_number: T.nilable(String),
               direction: String,
               duration_seconds: T.nilable(Integer),
               ended_at: T.nilable(Time),
               failure_reason: T.nilable(String),
               from: Sentdm::Voice::CallParty,
+              legs: T.nilable(T::Array[Sentdm::Voice::Call::Leg]),
               mode: String,
               number: String,
               price: T.nilable(Float),
@@ -190,6 +240,89 @@ module Sentdm
         end
         def to_hash
         end
+
+        class Leg < Sentdm::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(Sentdm::Voice::Call::Leg, Sentdm::Internal::AnyHash)
+            end
+
+          # The whole minutes the leg was billed for
+          sig { returns(T.nilable(Integer)) }
+          attr_reader :billed_minutes
+
+          sig { params(billed_minutes: Integer).void }
+          attr_writer :billed_minutes
+
+          # What the leg cost, in the same unit as the call's price
+          sig { returns(T.nilable(Float)) }
+          attr_reader :cost
+
+          sig { params(cost: Float).void }
+          attr_writer :cost
+
+          # The currency of the cost: USD
+          sig { returns(T.nilable(String)) }
+          attr_reader :currency
+
+          sig { params(currency: String).void }
+          attr_writer :currency
+
+          # inbound for the caller's leg to your number, outbound for a leg placed on your
+          # behalf
+          sig { returns(T.nilable(String)) }
+          attr_reader :direction
+
+          sig { params(direction: String).void }
+          attr_writer :direction
+
+          # The phone number the leg reached, in E.164 format: your number for the inbound
+          # leg, the number dialed for an outbound one. Null for a leg to one of your app
+          # users or a room
+          sig { returns(T.nilable(String)) }
+          attr_accessor :number
+
+          # One leg of a call the price covers
+          sig do
+            params(
+              billed_minutes: Integer,
+              cost: Float,
+              currency: String,
+              direction: String,
+              number: T.nilable(String)
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # The whole minutes the leg was billed for
+            billed_minutes: nil,
+            # What the leg cost, in the same unit as the call's price
+            cost: nil,
+            # The currency of the cost: USD
+            currency: nil,
+            # inbound for the caller's leg to your number, outbound for a leg placed on your
+            # behalf
+            direction: nil,
+            # The phone number the leg reached, in E.164 format: your number for the inbound
+            # leg, the number dialed for an outbound one. Null for a leg to one of your app
+            # users or a room
+            number: nil
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                billed_minutes: Integer,
+                cost: Float,
+                currency: String,
+                direction: String,
+                number: T.nilable(String)
+              }
+            )
+          end
+          def to_hash
+          end
+        end
       end
     end
   end

data/rbi/sentdm/models/voice/call_list_params.rbi

@@ -12,6 +12,11 @@ module Sentdm
             T.any(Sentdm::Voice::CallListParams, Sentdm::Internal::AnyHash)
           end
 
+        # Optional filter on the voice agent that answered the call, such as
+        # agent_9f2ab000-0000-4000-8000-000000000001
+        sig { returns(T.nilable(String)) }
+        attr_accessor :agent_id
+
         # Optional direction filter: outbound for calls placed from your app, inbound for
         # calls to one of your numbers
         sig { returns(T.nilable(String)) }
@@ -21,6 +26,11 @@ module Sentdm
         sig { returns(T.nilable(Time)) }
         attr_accessor :from
 
+        # Optional mode filter: inapp for calls routed by your number's callback URL,
+        # agent for calls one of your voice agents answered
+        sig { returns(T.nilable(String)) }
+        attr_accessor :mode
+
         # Optional filter on the number that owns the call, one of your voice-enabled
         # numbers in E.164 format
         sig { returns(T.nilable(String)) }
@@ -57,8 +67,10 @@ module Sentdm
 
         sig do
           params(
+            agent_id: T.nilable(String),
             direction: T.nilable(String),
             from: T.nilable(Time),
+            mode: T.nilable(String),
             number: T.nilable(String),
             page: Integer,
             page_size: Integer,
@@ -69,11 +81,17 @@ module Sentdm
           ).returns(T.attached_class)
         end
         def self.new(
+          # Optional filter on the voice agent that answered the call, such as
+          # agent_9f2ab000-0000-4000-8000-000000000001
+          agent_id: nil,
           # Optional direction filter: outbound for calls placed from your app, inbound for
           # calls to one of your numbers
           direction: nil,
           # Only calls started at or after this time (ISO 8601)
           from: nil,
+          # Optional mode filter: inapp for calls routed by your number's callback URL,
+          # agent for calls one of your voice agents answered
+          mode: nil,
           # Optional filter on the number that owns the call, one of your voice-enabled
           # numbers in E.164 format
           number: nil,
@@ -94,8 +112,10 @@ module Sentdm
         sig do
           override.returns(
             {
+              agent_id: T.nilable(String),
               direction: T.nilable(String),
               from: T.nilable(Time),
+              mode: T.nilable(String),
               number: T.nilable(String),
               page: Integer,
               page_size: Integer,

data/rbi/sentdm/models/voice/catalogue_list_params.rbi

@@ -0,0 +1,40 @@
+# typed: strong
+
+module Sentdm
+  module Models
+    module Voice
+      class CatalogueListParams < Sentdm::Internal::Type::BaseModel
+        extend Sentdm::Internal::Type::RequestParameters::Converter
+        include Sentdm::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(Sentdm::Voice::CatalogueListParams, Sentdm::Internal::AnyHash)
+          end
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :x_profile_id
+
+        sig { params(x_profile_id: String).void }
+        attr_writer :x_profile_id
+
+        sig do
+          params(
+            x_profile_id: String,
+            request_options: Sentdm::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(x_profile_id: nil, request_options: {})
+        end
+
+        sig do
+          override.returns(
+            { x_profile_id: String, request_options: Sentdm::RequestOptions }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/sentdm/models/voice/voice_agent.rbi

@@ -0,0 +1,196 @@
+# typed: strong
+
+module Sentdm
+  module Models
+    VoiceAgent = Voice::VoiceAgent
+
+    module Voice
+      class VoiceAgent < Sentdm::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(Sentdm::Voice::VoiceAgent, Sentdm::Internal::AnyHash)
+          end
+
+        # The agent's id, agent\_ and a UUID. It is also what the agent connects to the
+        # gateway as.
+        sig { returns(T.nilable(String)) }
+        attr_reader :id
+
+        sig { params(id: String).void }
+        attr_writer :id
+
+        # Audio sessions: the sample rate in use.
+        sig { returns(T.nilable(Sentdm::Voice::VoiceAgentAudio)) }
+        attr_reader :audio
+
+        sig do
+          params(audio: T.nilable(Sentdm::Voice::VoiceAgentAudio::OrHash)).void
+        end
+        attr_writer :audio
+
+        sig { returns(T.nilable(Time)) }
+        attr_reader :created_at
+
+        sig { params(created_at: Time).void }
+        attr_writer :created_at
+
+        sig { returns(T.nilable(Sentdm::Voice::VoiceAgentParty)) }
+        attr_reader :fallback
+
+        sig do
+          params(
+            fallback: T.nilable(Sentdm::Voice::VoiceAgentParty::OrHash)
+          ).void
+        end
+        attr_writer :fallback
+
+        sig { returns(T.nilable(String)) }
+        attr_accessor :greeting
+
+        sig { returns(T.nilable(Sentdm::Voice::VoiceAgentLimits)) }
+        attr_reader :limits
+
+        sig { params(limits: Sentdm::Voice::VoiceAgentLimits::OrHash).void }
+        attr_writer :limits
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :name
+
+        sig { params(name: String).void }
+        attr_writer :name
+
+        # text or audio.
+        sig { returns(T.nilable(String)) }
+        attr_reader :session_type
+
+        sig { params(session_type: String).void }
+        attr_writer :session_type
+
+        # The whsec\_ secret the gateway signs its handshake to websocket_url with.
+        # Present on create and after a rotate-secret; absent on every other read. Store
+        # it now.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :signing_secret
+
+        # Text sessions: the speech setting, voice and language in use.
+        sig { returns(T.nilable(Sentdm::Voice::VoiceAgentSpeech)) }
+        attr_reader :speech
+
+        sig do
+          params(
+            speech: T.nilable(Sentdm::Voice::VoiceAgentSpeech::OrHash)
+          ).void
+        end
+        attr_writer :speech
+
+        sig { returns(T.nilable(T::Array[String])) }
+        attr_reader :tools
+
+        sig { params(tools: T::Array[String]).void }
+        attr_writer :tools
+
+        sig { returns(T.nilable(Sentdm::Voice::VoiceAgentTranscripts)) }
+        attr_reader :transcripts
+
+        sig do
+          params(transcripts: Sentdm::Voice::VoiceAgentTranscripts::OrHash).void
+        end
+        attr_writer :transcripts
+
+        sig { returns(T.nilable(T::Array[Sentdm::Voice::VoiceAgentParty])) }
+        attr_reader :transfer_targets
+
+        sig do
+          params(
+            transfer_targets: T::Array[Sentdm::Voice::VoiceAgentParty::OrHash]
+          ).void
+        end
+        attr_writer :transfer_targets
+
+        sig { returns(T.nilable(Time)) }
+        attr_accessor :updated_at
+
+        # Where the gateway dials the agent; null when the agent dials in with your API
+        # key.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :websocket_url
+
+        # A voice agent as stored: what was written with every default filled in, plus the
+        # signing secret the one time it is shown (on create, and on rotate). The one
+        # shape every read of an agent answers with, on /v3/voice/agents and on the admin
+        # API the dashboard uses, so the two cannot drift.
+        sig do
+          params(
+            id: String,
+            audio: T.nilable(Sentdm::Voice::VoiceAgentAudio::OrHash),
+            created_at: Time,
+            fallback: T.nilable(Sentdm::Voice::VoiceAgentParty::OrHash),
+            greeting: T.nilable(String),
+            limits: Sentdm::Voice::VoiceAgentLimits::OrHash,
+            name: String,
+            session_type: String,
+            signing_secret: T.nilable(String),
+            speech: T.nilable(Sentdm::Voice::VoiceAgentSpeech::OrHash),
+            tools: T::Array[String],
+            transcripts: Sentdm::Voice::VoiceAgentTranscripts::OrHash,
+            transfer_targets: T::Array[Sentdm::Voice::VoiceAgentParty::OrHash],
+            updated_at: T.nilable(Time),
+            websocket_url: T.nilable(String)
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The agent's id, agent\_ and a UUID. It is also what the agent connects to the
+          # gateway as.
+          id: nil,
+          # Audio sessions: the sample rate in use.
+          audio: nil,
+          created_at: nil,
+          fallback: nil,
+          greeting: nil,
+          limits: nil,
+          name: nil,
+          # text or audio.
+          session_type: nil,
+          # The whsec\_ secret the gateway signs its handshake to websocket_url with.
+          # Present on create and after a rotate-secret; absent on every other read. Store
+          # it now.
+          signing_secret: nil,
+          # Text sessions: the speech setting, voice and language in use.
+          speech: nil,
+          tools: nil,
+          transcripts: nil,
+          transfer_targets: nil,
+          updated_at: nil,
+          # Where the gateway dials the agent; null when the agent dials in with your API
+          # key.
+          websocket_url: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              id: String,
+              audio: T.nilable(Sentdm::Voice::VoiceAgentAudio),
+              created_at: Time,
+              fallback: T.nilable(Sentdm::Voice::VoiceAgentParty),
+              greeting: T.nilable(String),
+              limits: Sentdm::Voice::VoiceAgentLimits,
+              name: String,
+              session_type: String,
+              signing_secret: T.nilable(String),
+              speech: T.nilable(Sentdm::Voice::VoiceAgentSpeech),
+              tools: T::Array[String],
+              transcripts: Sentdm::Voice::VoiceAgentTranscripts,
+              transfer_targets: T::Array[Sentdm::Voice::VoiceAgentParty],
+              updated_at: T.nilable(Time),
+              websocket_url: T.nilable(String)
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/sentdm/models/voice/voice_agent_audio.rbi

@@ -0,0 +1,30 @@
+# typed: strong
+
+module Sentdm
+  module Models
+    VoiceAgentAudio = Voice::VoiceAgentAudio
+
+    module Voice
+      class VoiceAgentAudio < Sentdm::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(Sentdm::Voice::VoiceAgentAudio, Sentdm::Internal::AnyHash)
+          end
+
+        sig { returns(T.nilable(Integer)) }
+        attr_reader :sample_rate
+
+        sig { params(sample_rate: Integer).void }
+        attr_writer :sample_rate
+
+        sig { params(sample_rate: Integer).returns(T.attached_class) }
+        def self.new(sample_rate: nil)
+        end
+
+        sig { override.returns({ sample_rate: Integer }) }
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/sentdm/models/voice/voice_agent_audio_spec.rbi

@@ -0,0 +1,33 @@
+# typed: strong
+
+module Sentdm
+  module Models
+    VoiceAgentAudioSpec = Voice::VoiceAgentAudioSpec
+
+    module Voice
+      class VoiceAgentAudioSpec < Sentdm::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(Sentdm::Voice::VoiceAgentAudioSpec, Sentdm::Internal::AnyHash)
+          end
+
+        # Samples per second of the audio exchanged: 8000, 16000 or 24000. Default 16000.
+        sig { returns(T.nilable(Integer)) }
+        attr_accessor :sample_rate
+
+        sig do
+          params(sample_rate: T.nilable(Integer)).returns(T.attached_class)
+        end
+        def self.new(
+          # Samples per second of the audio exchanged: 8000, 16000 or 24000. Default 16000.
+          sample_rate: nil
+        )
+        end
+
+        sig { override.returns({ sample_rate: T.nilable(Integer) }) }
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/sentdm/models/voice/voice_agent_limits.rbi

@@ -0,0 +1,57 @@
+# typed: strong
+
+module Sentdm
+  module Models
+    VoiceAgentLimits = Voice::VoiceAgentLimits
+
+    module Voice
+      class VoiceAgentLimits < Sentdm::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(Sentdm::Voice::VoiceAgentLimits, Sentdm::Internal::AnyHash)
+          end
+
+        sig { returns(T.nilable(T::Array[String])) }
+        attr_accessor :allowed_countries
+
+        sig { returns(T.nilable(Integer)) }
+        attr_reader :max_call_seconds
+
+        sig { params(max_call_seconds: Integer).void }
+        attr_writer :max_call_seconds
+
+        sig { returns(T.nilable(Integer)) }
+        attr_reader :max_concurrent_calls
+
+        sig { params(max_concurrent_calls: Integer).void }
+        attr_writer :max_concurrent_calls
+
+        sig do
+          params(
+            allowed_countries: T.nilable(T::Array[String]),
+            max_call_seconds: Integer,
+            max_concurrent_calls: Integer
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          allowed_countries: nil,
+          max_call_seconds: nil,
+          max_concurrent_calls: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              allowed_countries: T.nilable(T::Array[String]),
+              max_call_seconds: Integer,
+              max_concurrent_calls: Integer
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end