sentdm 0.38.1 → 0.40.0

data/rbi/sentdm/models/voice/api_response_of_call_recordings.rbi

@@ -0,0 +1,81 @@
+# typed: strong
+
+module Sentdm
+  module Models
+    module Voice
+      class APIResponseOfCallRecordings < Sentdm::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Sentdm::Voice::APIResponseOfCallRecordings,
+              Sentdm::Internal::AnyHash
+            )
+          end
+
+        # The recordings of a call, each as a short-lived download link
+        sig { returns(T.nilable(Sentdm::Voice::CallRecordings)) }
+        attr_reader :data
+
+        sig do
+          params(data: T.nilable(Sentdm::Voice::CallRecordings::OrHash)).void
+        end
+        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::CallRecordings::OrHash),
+            error: T.nilable(Sentdm::ErrorDetail::OrHash),
+            meta: Sentdm::APIMeta::OrHash,
+            success: T::Boolean
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The recordings of a call, each as a short-lived download link
+          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::CallRecordings),
+              error: T.nilable(Sentdm::ErrorDetail),
+              meta: Sentdm::APIMeta,
+              success: T::Boolean
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/sentdm/models/{calls/api_response_of_list_of_call_participant.rbi → voice/api_response_of_calls_list.rbi}

@@ -2,19 +2,22 @@
 
 module Sentdm
   module Models
-    module Calls
-      class APIResponseOfListOfCallParticipant < Sentdm::Internal::Type::BaseModel
+    module Voice
+      class APIResponseOfCallsList < Sentdm::Internal::Type::BaseModel
         OrHash =
           T.type_alias do
             T.any(
-              Sentdm::Calls::APIResponseOfListOfCallParticipant,
+              Sentdm::Voice::APIResponseOfCallsList,
               Sentdm::Internal::AnyHash
             )
           end
 
-        # The response data (null if error)
-        sig { returns(T.nilable(T::Array[Sentdm::Calls::CallParticipant])) }
-        attr_accessor :data
+        # Paginated list of calls
+        sig { returns(T.nilable(Sentdm::Voice::CallsList)) }
+        attr_reader :data
+
+        sig { params(data: T.nilable(Sentdm::Voice::CallsList::OrHash)).void }
+        attr_writer :data
 
         # Error information
         sig { returns(T.nilable(Sentdm::ErrorDetail)) }
@@ -40,14 +43,14 @@ module Sentdm
         # Standard API response envelope for all v3 endpoints
         sig do
           params(
-            data: T.nilable(T::Array[Sentdm::Calls::CallParticipant::OrHash]),
+            data: T.nilable(Sentdm::Voice::CallsList::OrHash),
             error: T.nilable(Sentdm::ErrorDetail::OrHash),
             meta: Sentdm::APIMeta::OrHash,
             success: T::Boolean
           ).returns(T.attached_class)
         end
         def self.new(
-          # The response data (null if error)
+          # Paginated list of calls
           data: nil,
           # Error information
           error: nil,
@@ -61,7 +64,7 @@ module Sentdm
         sig do
           override.returns(
             {
-              data: T.nilable(T::Array[Sentdm::Calls::CallParticipant]),
+              data: T.nilable(Sentdm::Voice::CallsList),
               error: T.nilable(Sentdm::ErrorDetail),
               meta: Sentdm::APIMeta,
               success: T::Boolean

data/rbi/sentdm/models/voice/api_response_of_voice_agent.rbi

@@ -0,0 +1,85 @@
+# typed: strong
+
+module Sentdm
+  module Models
+    module Voice
+      class APIResponseOfVoiceAgent < Sentdm::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Sentdm::Voice::APIResponseOfVoiceAgent,
+              Sentdm::Internal::AnyHash
+            )
+          end
+
+        # 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 { returns(T.nilable(Sentdm::Voice::VoiceAgent)) }
+        attr_reader :data
+
+        sig { params(data: T.nilable(Sentdm::Voice::VoiceAgent::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::VoiceAgent::OrHash),
+            error: T.nilable(Sentdm::ErrorDetail::OrHash),
+            meta: Sentdm::APIMeta::OrHash,
+            success: T::Boolean
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # 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.
+          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::VoiceAgent),
+              error: T.nilable(Sentdm::ErrorDetail),
+              meta: Sentdm::APIMeta,
+              success: T::Boolean
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/sentdm/models/voice/api_response_of_voice_agent_secret.rbi

@@ -0,0 +1,81 @@
+# typed: strong
+
+module Sentdm
+  module Models
+    module Voice
+      class APIResponseOfVoiceAgentSecret < Sentdm::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Sentdm::Voice::APIResponseOfVoiceAgentSecret,
+              Sentdm::Internal::AnyHash
+            )
+          end
+
+        # A freshly rotated signing secret.
+        sig { returns(T.nilable(Sentdm::Voice::VoiceAgentSecret)) }
+        attr_reader :data
+
+        sig do
+          params(data: T.nilable(Sentdm::Voice::VoiceAgentSecret::OrHash)).void
+        end
+        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::VoiceAgentSecret::OrHash),
+            error: T.nilable(Sentdm::ErrorDetail::OrHash),
+            meta: Sentdm::APIMeta::OrHash,
+            success: T::Boolean
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # A freshly rotated signing secret.
+          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::VoiceAgentSecret),
+              error: T.nilable(Sentdm::ErrorDetail),
+              meta: Sentdm::APIMeta,
+              success: T::Boolean
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/sentdm/models/voice/api_response_of_voice_agents_list.rbi

@@ -0,0 +1,83 @@
+# typed: strong
+
+module Sentdm
+  module Models
+    module Voice
+      class APIResponseOfVoiceAgentsList < Sentdm::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Sentdm::Voice::APIResponseOfVoiceAgentsList,
+              Sentdm::Internal::AnyHash
+            )
+          end
+
+        # A page of the account's agents. The agent itself is VoiceAgentResponse, shared
+        # with the admin API.
+        sig { returns(T.nilable(Sentdm::Voice::VoiceAgentsList)) }
+        attr_reader :data
+
+        sig do
+          params(data: T.nilable(Sentdm::Voice::VoiceAgentsList::OrHash)).void
+        end
+        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::VoiceAgentsList::OrHash),
+            error: T.nilable(Sentdm::ErrorDetail::OrHash),
+            meta: Sentdm::APIMeta::OrHash,
+            success: T::Boolean
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # A page of the account's agents. The agent itself is VoiceAgentResponse, shared
+          # with the admin API.
+          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::VoiceAgentsList),
+              error: T.nilable(Sentdm::ErrorDetail),
+              meta: Sentdm::APIMeta,
+              success: T::Boolean
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/sentdm/models/voice/api_response_of_voice_catalogue.rbi

@@ -0,0 +1,83 @@
+# typed: strong
+
+module Sentdm
+  module Models
+    module Voice
+      class APIResponseOfVoiceCatalogue < Sentdm::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Sentdm::Voice::APIResponseOfVoiceCatalogue,
+              Sentdm::Internal::AnyHash
+            )
+          end
+
+        # 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 { returns(T.nilable(Sentdm::Voice::VoiceCatalogue)) }
+        attr_reader :data
+
+        sig do
+          params(data: T.nilable(Sentdm::Voice::VoiceCatalogue::OrHash)).void
+        end
+        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::VoiceCatalogue::OrHash),
+            error: T.nilable(Sentdm::ErrorDetail::OrHash),
+            meta: Sentdm::APIMeta::OrHash,
+            success: T::Boolean
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # 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.
+          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::VoiceCatalogue),
+              error: T.nilable(Sentdm::ErrorDetail),
+              meta: Sentdm::APIMeta,
+              success: T::Boolean
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

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

@@ -2,23 +2,21 @@
 
 module Sentdm
   module Models
-    module Channels
+    module Voice
       class APIResponseOfVoiceToken < Sentdm::Internal::Type::BaseModel
         OrHash =
           T.type_alias do
             T.any(
-              Sentdm::Channels::APIResponseOfVoiceToken,
+              Sentdm::Voice::APIResponseOfVoiceToken,
               Sentdm::Internal::AnyHash
             )
           end
 
         # A short-lived token your app passes to the voice client SDK to register
-        sig { returns(T.nilable(Sentdm::Channels::VoiceToken)) }
+        sig { returns(T.nilable(Sentdm::Voice::VoiceToken)) }
         attr_reader :data
 
-        sig do
-          params(data: T.nilable(Sentdm::Channels::VoiceToken::OrHash)).void
-        end
+        sig { params(data: T.nilable(Sentdm::Voice::VoiceToken::OrHash)).void }
         attr_writer :data
 
         # Error information
@@ -45,7 +43,7 @@ module Sentdm
         # Standard API response envelope for all v3 endpoints
         sig do
           params(
-            data: T.nilable(Sentdm::Channels::VoiceToken::OrHash),
+            data: T.nilable(Sentdm::Voice::VoiceToken::OrHash),
             error: T.nilable(Sentdm::ErrorDetail::OrHash),
             meta: Sentdm::APIMeta::OrHash,
             success: T::Boolean
@@ -66,7 +64,7 @@ module Sentdm
         sig do
           override.returns(
             {
-              data: T.nilable(Sentdm::Channels::VoiceToken),
+              data: T.nilable(Sentdm::Voice::VoiceToken),
               error: T.nilable(Sentdm::ErrorDetail),
               meta: Sentdm::APIMeta,
               success: T::Boolean