sentdm 0.38.1 → 0.40.0

data/rbi/sentdm/models/voice/agent_create_params.rbi

@@ -0,0 +1,215 @@
+# typed: strong
+
+module Sentdm
+  module Models
+    module Voice
+      class AgentCreateParams < Sentdm::Internal::Type::BaseModel
+        extend Sentdm::Internal::Type::RequestParameters::Converter
+        include Sentdm::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(Sentdm::Voice::AgentCreateParams, Sentdm::Internal::AnyHash)
+          end
+
+        # Audio sessions only: the sound format.
+        sig { returns(T.nilable(Sentdm::Voice::VoiceAgentAudioSpec)) }
+        attr_reader :audio
+
+        sig do
+          params(
+            audio: T.nilable(Sentdm::Voice::VoiceAgentAudioSpec::OrHash)
+          ).void
+        end
+        attr_writer :audio
+
+        # Who takes the call when the agent cannot: a phone number (kind: number). Omit it
+        # and such a call hangs up.
+        sig { returns(T.nilable(Sentdm::Voice::VoiceAgentPartySpec)) }
+        attr_reader :fallback
+
+        sig do
+          params(
+            fallback: T.nilable(Sentdm::Voice::VoiceAgentPartySpec::OrHash)
+          ).void
+        end
+        attr_writer :fallback
+
+        # Text sessions only: what the caller hears as soon as the call is answered,
+        # before the agent's first turn. 1 to 4,096 characters. Omit it and the agent
+        # speaks first.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :greeting
+
+        sig { returns(T.nilable(Sentdm::Voice::VoiceAgentLimitsSpec)) }
+        attr_reader :limits
+
+        sig do
+          params(
+            limits: T.nilable(Sentdm::Voice::VoiceAgentLimitsSpec::OrHash)
+          ).void
+        end
+        attr_writer :limits
+
+        # A name for your own reference, 1 to 100 characters.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :name
+
+        # 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
+
+        # text: Sent turns the caller's speech into text and the agent's text into speech,
+        # so the agent exchanges text frames. audio: the agent receives and sends the
+        # sound itself.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :session_type
+
+        # Text sessions only: how the caller is spoken to and listened to.
+        sig { returns(T.nilable(Sentdm::Voice::VoiceAgentSpeechSpec)) }
+        attr_reader :speech
+
+        sig do
+          params(
+            speech: T.nilable(Sentdm::Voice::VoiceAgentSpeechSpec::OrHash)
+          ).void
+        end
+        attr_writer :speech
+
+        # What the agent may do to the call: any of transfer, hangup, send_dtmf and hold.
+        # Default ["hangup"]. transfer needs at least one transfer_targets entry.
+        sig { returns(T.nilable(T::Array[String])) }
+        attr_accessor :tools
+
+        sig { returns(T.nilable(Sentdm::Voice::VoiceAgentTranscriptsSpec)) }
+        attr_reader :transcripts
+
+        sig do
+          params(
+            transcripts:
+              T.nilable(Sentdm::Voice::VoiceAgentTranscriptsSpec::OrHash)
+          ).void
+        end
+        attr_writer :transcripts
+
+        # Where the agent may transfer a call to, up to 20 parties: a phone number (kind:
+        # number, E.164), one of your app users (kind: user, the identity) or another of
+        # your agents (kind: agent, its id). The agent can only transfer to a party listed
+        # here.
+        sig { returns(T.nilable(T::Array[Sentdm::Voice::VoiceAgentPartySpec])) }
+        attr_accessor :transfer_targets
+
+        # Where the gateway connects to the agent for each call: an absolute wss:// URL on
+        # a public host, at most 2,048 characters. The handshake is signed with the
+        # agent's signing_secret. Leave it out and the agent dials in instead, connecting
+        # to the gateway with your API key.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :websocket_url
+
+        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(
+            audio: T.nilable(Sentdm::Voice::VoiceAgentAudioSpec::OrHash),
+            fallback: T.nilable(Sentdm::Voice::VoiceAgentPartySpec::OrHash),
+            greeting: T.nilable(String),
+            limits: T.nilable(Sentdm::Voice::VoiceAgentLimitsSpec::OrHash),
+            name: T.nilable(String),
+            sandbox: T::Boolean,
+            session_type: T.nilable(String),
+            speech: T.nilable(Sentdm::Voice::VoiceAgentSpeechSpec::OrHash),
+            tools: T.nilable(T::Array[String]),
+            transcripts:
+              T.nilable(Sentdm::Voice::VoiceAgentTranscriptsSpec::OrHash),
+            transfer_targets:
+              T.nilable(T::Array[Sentdm::Voice::VoiceAgentPartySpec::OrHash]),
+            websocket_url: T.nilable(String),
+            idempotency_key: String,
+            x_profile_id: String,
+            request_options: Sentdm::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Audio sessions only: the sound format.
+          audio: nil,
+          # Who takes the call when the agent cannot: a phone number (kind: number). Omit it
+          # and such a call hangs up.
+          fallback: nil,
+          # Text sessions only: what the caller hears as soon as the call is answered,
+          # before the agent's first turn. 1 to 4,096 characters. Omit it and the agent
+          # speaks first.
+          greeting: nil,
+          limits: nil,
+          # A name for your own reference, 1 to 100 characters.
+          name: nil,
+          # Sandbox flag - when true, the operation is simulated without side effects Useful
+          # for testing integrations without actual execution
+          sandbox: nil,
+          # text: Sent turns the caller's speech into text and the agent's text into speech,
+          # so the agent exchanges text frames. audio: the agent receives and sends the
+          # sound itself.
+          session_type: nil,
+          # Text sessions only: how the caller is spoken to and listened to.
+          speech: nil,
+          # What the agent may do to the call: any of transfer, hangup, send_dtmf and hold.
+          # Default ["hangup"]. transfer needs at least one transfer_targets entry.
+          tools: nil,
+          transcripts: nil,
+          # Where the agent may transfer a call to, up to 20 parties: a phone number (kind:
+          # number, E.164), one of your app users (kind: user, the identity) or another of
+          # your agents (kind: agent, its id). The agent can only transfer to a party listed
+          # here.
+          transfer_targets: nil,
+          # Where the gateway connects to the agent for each call: an absolute wss:// URL on
+          # a public host, at most 2,048 characters. The handshake is signed with the
+          # agent's signing_secret. Leave it out and the agent dials in instead, connecting
+          # to the gateway with your API key.
+          websocket_url: nil,
+          idempotency_key: nil,
+          x_profile_id: nil,
+          request_options: {}
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              audio: T.nilable(Sentdm::Voice::VoiceAgentAudioSpec),
+              fallback: T.nilable(Sentdm::Voice::VoiceAgentPartySpec),
+              greeting: T.nilable(String),
+              limits: T.nilable(Sentdm::Voice::VoiceAgentLimitsSpec),
+              name: T.nilable(String),
+              sandbox: T::Boolean,
+              session_type: T.nilable(String),
+              speech: T.nilable(Sentdm::Voice::VoiceAgentSpeechSpec),
+              tools: T.nilable(T::Array[String]),
+              transcripts: T.nilable(Sentdm::Voice::VoiceAgentTranscriptsSpec),
+              transfer_targets:
+                T.nilable(T::Array[Sentdm::Voice::VoiceAgentPartySpec]),
+              websocket_url: T.nilable(String),
+              idempotency_key: String,
+              x_profile_id: String,
+              request_options: Sentdm::RequestOptions
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/sentdm/models/{calls/participant_remove_all_params.rbi → voice/agent_delete_params.rbi}

@@ -2,17 +2,14 @@
 
 module Sentdm
   module Models
-    module Calls
-      class ParticipantRemoveAllParams < Sentdm::Models::MutationRequest
+    module Voice
+      class AgentDeleteParams < Sentdm::Models::MutationRequest
         extend Sentdm::Internal::Type::RequestParameters::Converter
         include Sentdm::Internal::Type::RequestParameters
 
         OrHash =
           T.type_alias do
-            T.any(
-              Sentdm::Calls::ParticipantRemoveAllParams,
-              Sentdm::Internal::AnyHash
-            )
+            T.any(Sentdm::Voice::AgentDeleteParams, Sentdm::Internal::AnyHash)
           end
 
         sig { returns(String) }

data/rbi/sentdm/models/voice/agent_list_params.rbi

@@ -0,0 +1,66 @@
+# typed: strong
+
+module Sentdm
+  module Models
+    module Voice
+      class AgentListParams < Sentdm::Internal::Type::BaseModel
+        extend Sentdm::Internal::Type::RequestParameters::Converter
+        include Sentdm::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(Sentdm::Voice::AgentListParams, Sentdm::Internal::AnyHash)
+          end
+
+        # Page number, from 1
+        sig { returns(T.nilable(Integer)) }
+        attr_reader :page
+
+        sig { params(page: Integer).void }
+        attr_writer :page
+
+        sig { returns(T.nilable(Integer)) }
+        attr_reader :page_size
+
+        sig { params(page_size: Integer).void }
+        attr_writer :page_size
+
+        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(
+            page: Integer,
+            page_size: Integer,
+            x_profile_id: String,
+            request_options: Sentdm::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Page number, from 1
+          page: nil,
+          page_size: nil,
+          x_profile_id: nil,
+          request_options: {}
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              page: Integer,
+              page_size: Integer,
+              x_profile_id: String,
+              request_options: Sentdm::RequestOptions
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/sentdm/models/voice/agent_retrieve_params.rbi

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

data/rbi/sentdm/models/{calls/participant_remove_params.rbi → voice/agent_rotate_secret_params.rbi}

@@ -2,15 +2,15 @@
 
 module Sentdm
   module Models
-    module Calls
-      class ParticipantRemoveParams < Sentdm::Models::MutationRequest
+    module Voice
+      class AgentRotateSecretParams < Sentdm::Models::MutationRequest
         extend Sentdm::Internal::Type::RequestParameters::Converter
         include Sentdm::Internal::Type::RequestParameters
 
         OrHash =
           T.type_alias do
             T.any(
-              Sentdm::Calls::ParticipantRemoveParams,
+              Sentdm::Voice::AgentRotateSecretParams,
               Sentdm::Internal::AnyHash
             )
           end
@@ -18,8 +18,11 @@ module Sentdm
         sig { returns(String) }
         attr_accessor :id
 
-        sig { returns(String) }
-        attr_accessor :participant_id
+        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
@@ -30,14 +33,14 @@ module Sentdm
         sig do
           params(
             id: String,
-            participant_id: String,
+            idempotency_key: String,
             x_profile_id: String,
             request_options: Sentdm::RequestOptions::OrHash
           ).returns(T.attached_class)
         end
         def self.new(
           id:,
-          participant_id:,
+          idempotency_key: nil,
           x_profile_id: nil,
           request_options: {}
         )
@@ -47,7 +50,7 @@ module Sentdm
           override.returns(
             {
               id: String,
-              participant_id: String,
+              idempotency_key: String,
               x_profile_id: String,
               request_options: Sentdm::RequestOptions
             }

data/rbi/sentdm/models/voice/agent_update_params.rbi

@@ -0,0 +1,211 @@
+# typed: strong
+
+module Sentdm
+  module Models
+    module Voice
+      class AgentUpdateParams < Sentdm::Internal::Type::BaseModel
+        extend Sentdm::Internal::Type::RequestParameters::Converter
+        include Sentdm::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(Sentdm::Voice::AgentUpdateParams, Sentdm::Internal::AnyHash)
+          end
+
+        sig { returns(String) }
+        attr_accessor :id
+
+        # Audio sessions: { sample_rate }; null restores the default.
+        sig { returns(T.nilable(Sentdm::Voice::VoiceAgentAudioSpec)) }
+        attr_reader :audio
+
+        sig do
+          params(
+            audio: T.nilable(Sentdm::Voice::VoiceAgentAudioSpec::OrHash)
+          ).void
+        end
+        attr_writer :audio
+
+        # A new fallback party, or null for none.
+        sig { returns(T.nilable(Sentdm::Voice::VoiceAgentPartySpec)) }
+        attr_reader :fallback
+
+        sig do
+          params(
+            fallback: T.nilable(Sentdm::Voice::VoiceAgentPartySpec::OrHash)
+          ).void
+        end
+        attr_writer :fallback
+
+        # A new greeting, or null for none.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :greeting
+
+        # The whole limits object; null restores the defaults.
+        sig { returns(T.nilable(Sentdm::Voice::VoiceAgentLimitsSpec)) }
+        attr_reader :limits
+
+        sig do
+          params(
+            limits: T.nilable(Sentdm::Voice::VoiceAgentLimitsSpec::OrHash)
+          ).void
+        end
+        attr_writer :limits
+
+        # A new name, 1 to 100 characters.
+        sig { returns(T.nilable(String)) }
+        attr_reader :name
+
+        sig { params(name: String).void }
+        attr_writer :name
+
+        # 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
+
+        # text or audio. Changing it drops the settings the other type cannot have
+        # (speech, audio, greeting) unless the body sends them.
+        sig { returns(T.nilable(String)) }
+        attr_reader :session_type
+
+        sig { params(session_type: String).void }
+        attr_writer :session_type
+
+        # Text sessions: { setting, voice, language }, replaced whole; null restores the
+        # defaults.
+        sig { returns(T.nilable(Sentdm::Voice::VoiceAgentSpeechSpec)) }
+        attr_reader :speech
+
+        sig do
+          params(
+            speech: T.nilable(Sentdm::Voice::VoiceAgentSpeechSpec::OrHash)
+          ).void
+        end
+        attr_writer :speech
+
+        # The whole list of tools; null restores the default.
+        sig { returns(T.nilable(T::Array[String])) }
+        attr_accessor :tools
+
+        # The whole transcripts object; null restores the defaults.
+        sig { returns(T.nilable(Sentdm::Voice::VoiceAgentTranscriptsSpec)) }
+        attr_reader :transcripts
+
+        sig do
+          params(
+            transcripts:
+              T.nilable(Sentdm::Voice::VoiceAgentTranscriptsSpec::OrHash)
+          ).void
+        end
+        attr_writer :transcripts
+
+        # The whole list of parties; null clears it.
+        sig { returns(T.nilable(T::Array[Sentdm::Voice::VoiceAgentPartySpec])) }
+        attr_accessor :transfer_targets
+
+        # A new wss:// URL, or null for an agent that dials in.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :websocket_url
+
+        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,
+            audio: T.nilable(Sentdm::Voice::VoiceAgentAudioSpec::OrHash),
+            fallback: T.nilable(Sentdm::Voice::VoiceAgentPartySpec::OrHash),
+            greeting: T.nilable(String),
+            limits: T.nilable(Sentdm::Voice::VoiceAgentLimitsSpec::OrHash),
+            name: String,
+            sandbox: T::Boolean,
+            session_type: String,
+            speech: T.nilable(Sentdm::Voice::VoiceAgentSpeechSpec::OrHash),
+            tools: T.nilable(T::Array[String]),
+            transcripts:
+              T.nilable(Sentdm::Voice::VoiceAgentTranscriptsSpec::OrHash),
+            transfer_targets:
+              T.nilable(T::Array[Sentdm::Voice::VoiceAgentPartySpec::OrHash]),
+            websocket_url: T.nilable(String),
+            idempotency_key: String,
+            x_profile_id: String,
+            request_options: Sentdm::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          id:,
+          # Audio sessions: { sample_rate }; null restores the default.
+          audio: nil,
+          # A new fallback party, or null for none.
+          fallback: nil,
+          # A new greeting, or null for none.
+          greeting: nil,
+          # The whole limits object; null restores the defaults.
+          limits: nil,
+          # A new name, 1 to 100 characters.
+          name: nil,
+          # Sandbox flag - when true, the operation is simulated without side effects Useful
+          # for testing integrations without actual execution
+          sandbox: nil,
+          # text or audio. Changing it drops the settings the other type cannot have
+          # (speech, audio, greeting) unless the body sends them.
+          session_type: nil,
+          # Text sessions: { setting, voice, language }, replaced whole; null restores the
+          # defaults.
+          speech: nil,
+          # The whole list of tools; null restores the default.
+          tools: nil,
+          # The whole transcripts object; null restores the defaults.
+          transcripts: nil,
+          # The whole list of parties; null clears it.
+          transfer_targets: nil,
+          # A new wss:// URL, or null for an agent that dials in.
+          websocket_url: nil,
+          idempotency_key: nil,
+          x_profile_id: nil,
+          request_options: {}
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              id: String,
+              audio: T.nilable(Sentdm::Voice::VoiceAgentAudioSpec),
+              fallback: T.nilable(Sentdm::Voice::VoiceAgentPartySpec),
+              greeting: T.nilable(String),
+              limits: T.nilable(Sentdm::Voice::VoiceAgentLimitsSpec),
+              name: String,
+              sandbox: T::Boolean,
+              session_type: String,
+              speech: T.nilable(Sentdm::Voice::VoiceAgentSpeechSpec),
+              tools: T.nilable(T::Array[String]),
+              transcripts: T.nilable(Sentdm::Voice::VoiceAgentTranscriptsSpec),
+              transfer_targets:
+                T.nilable(T::Array[Sentdm::Voice::VoiceAgentPartySpec]),
+              websocket_url: T.nilable(String),
+              idempotency_key: String,
+              x_profile_id: String,
+              request_options: Sentdm::RequestOptions
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/sentdm/models/voice/api_response_of_call.rbi

@@ -0,0 +1,76 @@
+# typed: strong
+
+module Sentdm
+  module Models
+    module Voice
+      class APIResponseOfCall < Sentdm::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(Sentdm::Voice::APIResponseOfCall, Sentdm::Internal::AnyHash)
+          end
+
+        # A call record
+        sig { returns(T.nilable(Sentdm::Voice::Call)) }
+        attr_reader :data
+
+        sig { params(data: T.nilable(Sentdm::Voice::Call::OrHash)).void }
+        attr_writer :data
+
+        # Error information
+        sig { returns(T.nilable(Sentdm::ErrorDetail)) }
+        attr_reader :error
+
+        sig { params(error: T.nilable(Sentdm::ErrorDetail::OrHash)).void }
+        attr_writer :error
+
+        # Request and response metadata
+        sig { returns(T.nilable(Sentdm::APIMeta)) }
+        attr_reader :meta
+
+        sig { params(meta: Sentdm::APIMeta::OrHash).void }
+        attr_writer :meta
+
+        # Indicates whether the request was successful
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_reader :success
+
+        sig { params(success: T::Boolean).void }
+        attr_writer :success
+
+        # Standard API response envelope for all v3 endpoints
+        sig do
+          params(
+            data: T.nilable(Sentdm::Voice::Call::OrHash),
+            error: T.nilable(Sentdm::ErrorDetail::OrHash),
+            meta: Sentdm::APIMeta::OrHash,
+            success: T::Boolean
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # A call record
+          data: nil,
+          # Error information
+          error: nil,
+          # Request and response metadata
+          meta: nil,
+          # Indicates whether the request was successful
+          success: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              data: T.nilable(Sentdm::Voice::Call),
+              error: T.nilable(Sentdm::ErrorDetail),
+              meta: Sentdm::APIMeta,
+              success: T::Boolean
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end