sentdm 0.38.1 → 0.40.0

data/rbi/sentdm/models/voice/voice_agent_party_spec.rbi

@@ -0,0 +1,45 @@
+# typed: strong
+
+module Sentdm
+  module Models
+    VoiceAgentPartySpec = Voice::VoiceAgentPartySpec
+
+    module Voice
+      class VoiceAgentPartySpec < Sentdm::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(Sentdm::Voice::VoiceAgentPartySpec, Sentdm::Internal::AnyHash)
+          end
+
+        # number, user or agent.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :kind
+
+        # The E.164 number, the app user's identity, or the agent id (agent\_…).
+        sig { returns(T.nilable(String)) }
+        attr_accessor :value
+
+        sig do
+          params(kind: T.nilable(String), value: T.nilable(String)).returns(
+            T.attached_class
+          )
+        end
+        def self.new(
+          # number, user or agent.
+          kind: nil,
+          # The E.164 number, the app user's identity, or the agent id (agent\_…).
+          value: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            { kind: T.nilable(String), value: T.nilable(String) }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/sentdm/models/voice/voice_agent_secret.rbi

@@ -0,0 +1,37 @@
+# typed: strong
+
+module Sentdm
+  module Models
+    VoiceAgentSecret = Voice::VoiceAgentSecret
+
+    module Voice
+      class VoiceAgentSecret < Sentdm::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(Sentdm::Voice::VoiceAgentSecret, Sentdm::Internal::AnyHash)
+          end
+
+        # The new whsec\_ secret. The previous one stopped signing the moment this was
+        # returned. Shown once.
+        sig { returns(T.nilable(String)) }
+        attr_reader :signing_secret
+
+        sig { params(signing_secret: String).void }
+        attr_writer :signing_secret
+
+        # A freshly rotated signing secret.
+        sig { params(signing_secret: String).returns(T.attached_class) }
+        def self.new(
+          # The new whsec\_ secret. The previous one stopped signing the moment this was
+          # returned. Shown once.
+          signing_secret: nil
+        )
+        end
+
+        sig { override.returns({ signing_secret: String }) }
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/sentdm/models/voice/voice_agent_speech.rbi

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

data/rbi/sentdm/models/voice/voice_agent_speech_spec.rbi

@@ -0,0 +1,62 @@
+# typed: strong
+
+module Sentdm
+  module Models
+    VoiceAgentSpeechSpec = Voice::VoiceAgentSpeechSpec
+
+    module Voice
+      class VoiceAgentSpeechSpec < Sentdm::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Sentdm::Voice::VoiceAgentSpeechSpec,
+              Sentdm::Internal::AnyHash
+            )
+          end
+
+        # The language spoken and listened for, a BCP 47 tag from GET /v3/voice/voices.
+        # Default en-US.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :language
+
+        # standard, Sent's speech. Other settings are not available yet.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :setting
+
+        # A voice name from GET /v3/voice/voices. Default: the catalogue's default voice.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :voice
+
+        sig do
+          params(
+            language: T.nilable(String),
+            setting: T.nilable(String),
+            voice: T.nilable(String)
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The language spoken and listened for, a BCP 47 tag from GET /v3/voice/voices.
+          # Default en-US.
+          language: nil,
+          # standard, Sent's speech. Other settings are not available yet.
+          setting: nil,
+          # A voice name from GET /v3/voice/voices. Default: the catalogue's default voice.
+          voice: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              language: T.nilable(String),
+              setting: T.nilable(String),
+              voice: T.nilable(String)
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/sentdm/models/voice/voice_agent_transcripts.rbi

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

data/rbi/sentdm/models/voice/voice_agent_transcripts_spec.rbi

@@ -0,0 +1,51 @@
+# typed: strong
+
+module Sentdm
+  module Models
+    VoiceAgentTranscriptsSpec = Voice::VoiceAgentTranscriptsSpec
+
+    module Voice
+      class VoiceAgentTranscriptsSpec < Sentdm::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Sentdm::Voice::VoiceAgentTranscriptsSpec,
+              Sentdm::Internal::AnyHash
+            )
+          end
+
+        # How long a stored transcript is kept, 1 to 365 days. Default 30.
+        sig { returns(T.nilable(Integer)) }
+        attr_accessor :retention_days
+
+        # Whether Sent keeps the call's transcript. Default false. Stored now, applied
+        # when transcripts land.
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_accessor :store
+
+        sig do
+          params(
+            retention_days: T.nilable(Integer),
+            store: T.nilable(T::Boolean)
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # How long a stored transcript is kept, 1 to 365 days. Default 30.
+          retention_days: nil,
+          # Whether Sent keeps the call's transcript. Default false. Stored now, applied
+          # when transcripts land.
+          store: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            { retention_days: T.nilable(Integer), store: T.nilable(T::Boolean) }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/sentdm/models/voice/voice_agents_list.rbi

@@ -0,0 +1,55 @@
+# typed: strong
+
+module Sentdm
+  module Models
+    VoiceAgentsList = Voice::VoiceAgentsList
+
+    module Voice
+      class VoiceAgentsList < Sentdm::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(Sentdm::Voice::VoiceAgentsList, Sentdm::Internal::AnyHash)
+          end
+
+        sig { returns(T.nilable(T::Array[Sentdm::Voice::VoiceAgent])) }
+        attr_reader :agents
+
+        sig { params(agents: T::Array[Sentdm::Voice::VoiceAgent::OrHash]).void }
+        attr_writer :agents
+
+        # Pagination metadata for list responses
+        sig { returns(T.nilable(Sentdm::PaginationMeta)) }
+        attr_reader :pagination
+
+        sig { params(pagination: Sentdm::PaginationMeta::OrHash).void }
+        attr_writer :pagination
+
+        # A page of the account's agents. The agent itself is VoiceAgentResponse, shared
+        # with the admin API.
+        sig do
+          params(
+            agents: T::Array[Sentdm::Voice::VoiceAgent::OrHash],
+            pagination: Sentdm::PaginationMeta::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          agents: nil,
+          # Pagination metadata for list responses
+          pagination: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              agents: T::Array[Sentdm::Voice::VoiceAgent],
+              pagination: Sentdm::PaginationMeta
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/sentdm/models/voice/voice_catalogue.rbi

@@ -0,0 +1,59 @@
+# typed: strong
+
+module Sentdm
+  module Models
+    VoiceCatalogue = Voice::VoiceCatalogue
+
+    module Voice
+      class VoiceCatalogue < Sentdm::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(Sentdm::Voice::VoiceCatalogue, Sentdm::Internal::AnyHash)
+          end
+
+        # BCP 47 tags accepted as speech.language.
+        sig { returns(T.nilable(T::Array[String])) }
+        attr_reader :languages
+
+        sig { params(languages: T::Array[String]).void }
+        attr_writer :languages
+
+        sig { returns(T.nilable(T::Array[Sentdm::Voice::VoiceCatalogueVoice])) }
+        attr_reader :voices
+
+        sig do
+          params(
+            voices: T::Array[Sentdm::Voice::VoiceCatalogueVoice::OrHash]
+          ).void
+        end
+        attr_writer :voices
+
+        # The voices and languages a text-session agent may name in its speech settings:
+        # what GET /v3/voice/voices and the admin GET /voice/voices answer, in one shape.
+        sig do
+          params(
+            languages: T::Array[String],
+            voices: T::Array[Sentdm::Voice::VoiceCatalogueVoice::OrHash]
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # BCP 47 tags accepted as speech.language.
+          languages: nil,
+          voices: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              languages: T::Array[String],
+              voices: T::Array[Sentdm::Voice::VoiceCatalogueVoice]
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/sentdm/models/voice/voice_catalogue_voice.rbi

@@ -0,0 +1,75 @@
+# typed: strong
+
+module Sentdm
+  module Models
+    VoiceCatalogueVoice = Voice::VoiceCatalogueVoice
+
+    module Voice
+      class VoiceCatalogueVoice < Sentdm::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(Sentdm::Voice::VoiceCatalogueVoice, Sentdm::Internal::AnyHash)
+          end
+
+        # Whether this is the voice used when an agent names none.
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_reader :default
+
+        sig { params(default: T::Boolean).void }
+        attr_writer :default
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :description
+
+        sig { params(description: String).void }
+        attr_writer :description
+
+        # The language the voice speaks.
+        sig { returns(T.nilable(String)) }
+        attr_reader :language
+
+        sig { params(language: String).void }
+        attr_writer :language
+
+        # The value to send as speech.voice.
+        sig { returns(T.nilable(String)) }
+        attr_reader :name
+
+        sig { params(name: String).void }
+        attr_writer :name
+
+        sig do
+          params(
+            default: T::Boolean,
+            description: String,
+            language: String,
+            name: String
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Whether this is the voice used when an agent names none.
+          default: nil,
+          description: nil,
+          # The language the voice speaks.
+          language: nil,
+          # The value to send as speech.voice.
+          name: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              default: T::Boolean,
+              description: String,
+              language: String,
+              name: String
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/sentdm/models/{channels → voice}/voice_token.rbi

@@ -2,14 +2,17 @@
 
 module Sentdm
   module Models
-    module Channels
+    VoiceToken = Voice::VoiceToken
+
+    module Voice
       class VoiceToken < Sentdm::Internal::Type::BaseModel
         OrHash =
           T.type_alias do
-            T.any(Sentdm::Channels::VoiceToken, Sentdm::Internal::AnyHash)
+            T.any(Sentdm::Voice::VoiceToken, Sentdm::Internal::AnyHash)
           end
 
-        # The signed token. Hand it to the client SDK unchanged.
+        # The signed token. Hand it to the client SDK unchanged. Treat it as opaque: read
+        # the identity, number, and expiry from this response, not from the token.
         sig { returns(T.nilable(String)) }
         attr_reader :token
 
@@ -47,7 +50,8 @@ module Sentdm
           ).returns(T.attached_class)
         end
         def self.new(
-          # The signed token. Hand it to the client SDK unchanged.
+          # The signed token. Hand it to the client SDK unchanged. Treat it as opaque: read
+          # the identity, number, and expiry from this response, not from the token.
           token: nil,
           # When the token expires (UTC)
           expires_at: nil,

data/rbi/sentdm/models/webhook_create_params.rbi

@@ -32,6 +32,18 @@ module Sentdm
       sig { params(event_types: T::Array[String]).void }
       attr_writer :event_types
 
+      # Also delivers every sender profile's events to this webhook, at the same URL and
+      # with the same signing secret, and lets each profile see the webhook and read the
+      # events about itself. Off by default: the organization's own events only. Only an
+      # organization's version 2 webhook can set it.
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :is_inheritable
+
+      sig { params(is_inheritable: T::Boolean).void }
+      attr_writer :is_inheritable
+
+      # Delivery retries. Applies to version 1 only: Svix retries a version 2 webhook on
+      # its own schedule.
       sig { returns(T.nilable(Integer)) }
       attr_reader :retry_count
 
@@ -47,7 +59,8 @@ module Sentdm
       attr_writer :sandbox
 
       # Request-only: the events an organization webhook's sender profile clones
-      # receive, one clone per existing and future profile. Responses never return it.
+      # receive, one clone per existing and future profile. A version 1 webhook's
+      # responses report it as WebhookSenderProfileV3Response.
       sig { returns(T.nilable(Sentdm::WebhookCreateParams::SenderProfile)) }
       attr_reader :sender_profile
 
@@ -59,12 +72,19 @@ module Sentdm
       end
       attr_writer :sender_profile
 
+      # Delivery timeout. Applies to version 1 only.
       sig { returns(T.nilable(Integer)) }
       attr_reader :timeout_seconds
 
       sig { params(timeout_seconds: Integer).void }
       attr_writer :timeout_seconds
 
+      # Who delivers the webhook: 2, the default, is delivered by Svix and signed with
+      # the webhook-id, webhook-timestamp and webhook-signature headers; 1 is the older
+      # delivery, signed with the X-Webhook-\* headers, which will be retired.
+      sig { returns(T.nilable(Integer)) }
+      attr_accessor :webhook_version
+
       sig { returns(T.nilable(String)) }
       attr_reader :idempotency_key
 
@@ -83,11 +103,13 @@ module Sentdm
           endpoint_url: String,
           event_filters: T.nilable(T::Hash[Symbol, T::Array[String]]),
           event_types: T::Array[String],
+          is_inheritable: T::Boolean,
           retry_count: Integer,
           sandbox: T::Boolean,
           sender_profile:
             T.nilable(Sentdm::WebhookCreateParams::SenderProfile::OrHash),
           timeout_seconds: Integer,
+          webhook_version: T.nilable(Integer),
           idempotency_key: String,
           x_profile_id: String,
           request_options: Sentdm::RequestOptions::OrHash
@@ -98,14 +120,27 @@ module Sentdm
         endpoint_url: nil,
         event_filters: nil,
         event_types: nil,
+        # Also delivers every sender profile's events to this webhook, at the same URL and
+        # with the same signing secret, and lets each profile see the webhook and read the
+        # events about itself. Off by default: the organization's own events only. Only an
+        # organization's version 2 webhook can set it.
+        is_inheritable: nil,
+        # Delivery retries. Applies to version 1 only: Svix retries a version 2 webhook on
+        # its own schedule.
         retry_count: nil,
         # Sandbox flag - when true, the operation is simulated without side effects Useful
         # for testing integrations without actual execution
         sandbox: nil,
         # Request-only: the events an organization webhook's sender profile clones
-        # receive, one clone per existing and future profile. Responses never return it.
+        # receive, one clone per existing and future profile. A version 1 webhook's
+        # responses report it as WebhookSenderProfileV3Response.
         sender_profile: nil,
+        # Delivery timeout. Applies to version 1 only.
         timeout_seconds: nil,
+        # Who delivers the webhook: 2, the default, is delivered by Svix and signed with
+        # the webhook-id, webhook-timestamp and webhook-signature headers; 1 is the older
+        # delivery, signed with the X-Webhook-\* headers, which will be retired.
+        webhook_version: nil,
         idempotency_key: nil,
         x_profile_id: nil,
         request_options: {}
@@ -119,11 +154,13 @@ module Sentdm
             endpoint_url: String,
             event_filters: T.nilable(T::Hash[Symbol, T::Array[String]]),
             event_types: T::Array[String],
+            is_inheritable: T::Boolean,
             retry_count: Integer,
             sandbox: T::Boolean,
             sender_profile:
               T.nilable(Sentdm::WebhookCreateParams::SenderProfile),
             timeout_seconds: Integer,
+            webhook_version: T.nilable(Integer),
             idempotency_key: String,
             x_profile_id: String,
             request_options: Sentdm::RequestOptions
@@ -152,7 +189,8 @@ module Sentdm
         attr_writer :event_types
 
         # Request-only: the events an organization webhook's sender profile clones
-        # receive, one clone per existing and future profile. Responses never return it.
+        # receive, one clone per existing and future profile. A version 1 webhook's
+        # responses report it as WebhookSenderProfileV3Response.
         sig do
           params(
             event_filters: T.nilable(T::Hash[Symbol, T::Array[String]]),