sentdm 0.38.1 → 0.40.0

data/rbi/sentdm/models/voice/calls/participant_remove_params.rbi

@@ -0,0 +1,63 @@
+# typed: strong
+
+module Sentdm
+  module Models
+    module Voice
+      module Calls
+        class ParticipantRemoveParams < Sentdm::Models::MutationRequest
+          extend Sentdm::Internal::Type::RequestParameters::Converter
+          include Sentdm::Internal::Type::RequestParameters
+
+          OrHash =
+            T.type_alias do
+              T.any(
+                Sentdm::Voice::Calls::ParticipantRemoveParams,
+                Sentdm::Internal::AnyHash
+              )
+            end
+
+          sig { returns(String) }
+          attr_accessor :id
+
+          sig { returns(String) }
+          attr_accessor :participant_id
+
+          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(
+              id: String,
+              participant_id: String,
+              x_profile_id: String,
+              request_options: Sentdm::RequestOptions::OrHash
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            id:,
+            participant_id:,
+            x_profile_id: nil,
+            request_options: {}
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                id: String,
+                participant_id: String,
+                x_profile_id: String,
+                request_options: Sentdm::RequestOptions
+              }
+            )
+          end
+          def to_hash
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/sentdm/models/voice/calls/participant_update_params.rbi

@@ -0,0 +1,96 @@
+# typed: strong
+
+module Sentdm
+  module Models
+    module Voice
+      module Calls
+        class ParticipantUpdateParams < Sentdm::Internal::Type::BaseModel
+          extend Sentdm::Internal::Type::RequestParameters::Converter
+          include Sentdm::Internal::Type::RequestParameters
+
+          OrHash =
+            T.type_alias do
+              T.any(
+                Sentdm::Voice::Calls::ParticipantUpdateParams,
+                Sentdm::Internal::AnyHash
+              )
+            end
+
+          sig { returns(String) }
+          attr_accessor :id
+
+          sig { returns(String) }
+          attr_accessor :participant_id
+
+          # true to mute the participant, false to unmute them
+          sig { returns(T.nilable(T::Boolean)) }
+          attr_reader :muted
+
+          sig { params(muted: T::Boolean).void }
+          attr_writer :muted
+
+          # Sandbox flag - when true, the operation is simulated without side effects Useful
+          # for testing integrations without actual execution
+          sig { returns(T.nilable(T::Boolean)) }
+          attr_reader :sandbox
+
+          sig { params(sandbox: T::Boolean).void }
+          attr_writer :sandbox
+
+          sig { returns(T.nilable(String)) }
+          attr_reader :idempotency_key
+
+          sig { params(idempotency_key: String).void }
+          attr_writer :idempotency_key
+
+          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(
+              id: String,
+              participant_id: String,
+              muted: T::Boolean,
+              sandbox: T::Boolean,
+              idempotency_key: String,
+              x_profile_id: String,
+              request_options: Sentdm::RequestOptions::OrHash
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            id:,
+            participant_id:,
+            # true to mute the participant, false to unmute them
+            muted: nil,
+            # Sandbox flag - when true, the operation is simulated without side effects Useful
+            # for testing integrations without actual execution
+            sandbox: nil,
+            idempotency_key: nil,
+            x_profile_id: nil,
+            request_options: {}
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                id: String,
+                participant_id: String,
+                muted: T::Boolean,
+                sandbox: T::Boolean,
+                idempotency_key: String,
+                x_profile_id: String,
+                request_options: Sentdm::RequestOptions
+              }
+            )
+          end
+          def to_hash
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/sentdm/models/voice/calls_list.rbi

@@ -0,0 +1,54 @@
+# typed: strong
+
+module Sentdm
+  module Models
+    module Voice
+      class CallsList < Sentdm::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(Sentdm::Voice::CallsList, Sentdm::Internal::AnyHash)
+          end
+
+        # The calls on this page, most recent first
+        sig { returns(T.nilable(T::Array[Sentdm::Voice::Call])) }
+        attr_reader :calls
+
+        sig { params(calls: T::Array[Sentdm::Voice::Call::OrHash]).void }
+        attr_writer :calls
+
+        # Pagination metadata for list responses
+        sig { returns(T.nilable(Sentdm::PaginationMeta)) }
+        attr_reader :pagination
+
+        sig { params(pagination: Sentdm::PaginationMeta::OrHash).void }
+        attr_writer :pagination
+
+        # Paginated list of calls
+        sig do
+          params(
+            calls: T::Array[Sentdm::Voice::Call::OrHash],
+            pagination: Sentdm::PaginationMeta::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The calls on this page, most recent first
+          calls: nil,
+          # Pagination metadata for list responses
+          pagination: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              calls: T::Array[Sentdm::Voice::Call],
+              pagination: Sentdm::PaginationMeta
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

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/{channels/voice_create_token_params.rbi → voice/token_create_params.rbi}

@@ -2,17 +2,14 @@
 
 module Sentdm
   module Models
-    module Channels
-      class VoiceCreateTokenParams < Sentdm::Internal::Type::BaseModel
+    module Voice
+      class TokenCreateParams < Sentdm::Internal::Type::BaseModel
         extend Sentdm::Internal::Type::RequestParameters::Converter
         include Sentdm::Internal::Type::RequestParameters
 
         OrHash =
           T.type_alias do
-            T.any(
-              Sentdm::Channels::VoiceCreateTokenParams,
-              Sentdm::Internal::AnyHash
-            )
+            T.any(Sentdm::Voice::TokenCreateParams, Sentdm::Internal::AnyHash)
           end
 
         # Your identifier for the app user, such as an agent or account id. Letters,

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

data/rbi/sentdm/models/voice/voice_agent_limits_spec.rbi

@@ -0,0 +1,62 @@
+# typed: strong
+
+module Sentdm
+  module Models
+    VoiceAgentLimitsSpec = Voice::VoiceAgentLimitsSpec
+
+    module Voice
+      class VoiceAgentLimitsSpec < Sentdm::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Sentdm::Voice::VoiceAgentLimitsSpec,
+              Sentdm::Internal::AnyHash
+            )
+          end
+
+        # ISO 3166-1 alpha-2 codes of the countries the agent may call or transfer to.
+        # Omit it to allow every country. Stored now, applied when the agent places calls.
+        sig { returns(T.nilable(T::Array[String])) }
+        attr_accessor :allowed_countries
+
+        # The longest a call may last, 60 to 14,400 seconds. Default 3,600.
+        sig { returns(T.nilable(Integer)) }
+        attr_accessor :max_call_seconds
+
+        # How many calls the agent may have going at once, from 1. Default 10.
+        sig { returns(T.nilable(Integer)) }
+        attr_accessor :max_concurrent_calls
+
+        sig do
+          params(
+            allowed_countries: T.nilable(T::Array[String]),
+            max_call_seconds: T.nilable(Integer),
+            max_concurrent_calls: T.nilable(Integer)
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # ISO 3166-1 alpha-2 codes of the countries the agent may call or transfer to.
+          # Omit it to allow every country. Stored now, applied when the agent places calls.
+          allowed_countries: nil,
+          # The longest a call may last, 60 to 14,400 seconds. Default 3,600.
+          max_call_seconds: nil,
+          # How many calls the agent may have going at once, from 1. Default 10.
+          max_concurrent_calls: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              allowed_countries: T.nilable(T::Array[String]),
+              max_call_seconds: T.nilable(Integer),
+              max_concurrent_calls: T.nilable(Integer)
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/sentdm/models/voice/voice_agent_party.rbi

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