telnyx 5.160.0 → 5.161.0

data/rbi/telnyx/models/storage/sqldbs/action_query_response.rbi

@@ -0,0 +1,226 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    module Storage
+      module Sqldbs
+        class ActionQueryResponse < Telnyx::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Telnyx::Models::Storage::Sqldbs::ActionQueryResponse,
+                Telnyx::Internal::AnyHash
+              )
+            end
+
+          sig do
+            returns(
+              T.nilable(
+                Telnyx::Models::Storage::Sqldbs::ActionQueryResponse::Data
+              )
+            )
+          end
+          attr_reader :data
+
+          sig do
+            params(
+              data:
+                Telnyx::Models::Storage::Sqldbs::ActionQueryResponse::Data::OrHash
+            ).void
+          end
+          attr_writer :data
+
+          sig do
+            params(
+              data:
+                Telnyx::Models::Storage::Sqldbs::ActionQueryResponse::Data::OrHash
+            ).returns(T.attached_class)
+          end
+          def self.new(data: nil)
+          end
+
+          sig do
+            override.returns(
+              {
+                data: Telnyx::Models::Storage::Sqldbs::ActionQueryResponse::Data
+              }
+            )
+          end
+          def to_hash
+          end
+
+          class Data < Telnyx::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  Telnyx::Models::Storage::Sqldbs::ActionQueryResponse::Data,
+                  Telnyx::Internal::AnyHash
+                )
+              end
+
+            # Number of rows returned.
+            sig { returns(T.nilable(Integer)) }
+            attr_reader :count
+
+            sig { params(count: Integer).void }
+            attr_writer :count
+
+            # Wall-clock duration of the request, in milliseconds.
+            sig { returns(T.nilable(Float)) }
+            attr_reader :duration
+
+            sig { params(duration: Float).void }
+            attr_writer :duration
+
+            sig do
+              returns(
+                T.nilable(
+                  Telnyx::Models::Storage::Sqldbs::ActionQueryResponse::Data::Meta
+                )
+              )
+            end
+            attr_reader :meta
+
+            sig do
+              params(
+                meta:
+                  Telnyx::Models::Storage::Sqldbs::ActionQueryResponse::Data::Meta::OrHash
+              ).void
+            end
+            attr_writer :meta
+
+            # The result rows, each a map of column name to value. Empty for statements that
+            # return no rows.
+            sig { returns(T.nilable(T::Array[T::Hash[Symbol, T.anything]])) }
+            attr_reader :results
+
+            sig { params(results: T::Array[T::Hash[Symbol, T.anything]]).void }
+            attr_writer :results
+
+            sig { returns(T.nilable(T::Boolean)) }
+            attr_reader :success
+
+            sig { params(success: T::Boolean).void }
+            attr_writer :success
+
+            sig do
+              params(
+                count: Integer,
+                duration: Float,
+                meta:
+                  Telnyx::Models::Storage::Sqldbs::ActionQueryResponse::Data::Meta::OrHash,
+                results: T::Array[T::Hash[Symbol, T.anything]],
+                success: T::Boolean
+              ).returns(T.attached_class)
+            end
+            def self.new(
+              # Number of rows returned.
+              count: nil,
+              # Wall-clock duration of the request, in milliseconds.
+              duration: nil,
+              meta: nil,
+              # The result rows, each a map of column name to value. Empty for statements that
+              # return no rows.
+              results: nil,
+              success: nil
+            )
+            end
+
+            sig do
+              override.returns(
+                {
+                  count: Integer,
+                  duration: Float,
+                  meta:
+                    Telnyx::Models::Storage::Sqldbs::ActionQueryResponse::Data::Meta,
+                  results: T::Array[T::Hash[Symbol, T.anything]],
+                  success: T::Boolean
+                }
+              )
+            end
+            def to_hash
+            end
+
+            class Meta < Telnyx::Internal::Type::BaseModel
+              OrHash =
+                T.type_alias do
+                  T.any(
+                    Telnyx::Models::Storage::Sqldbs::ActionQueryResponse::Data::Meta,
+                    Telnyx::Internal::AnyHash
+                  )
+                end
+
+              # Number of rows added, changed, or removed by the statement.
+              sig { returns(T.nilable(Integer)) }
+              attr_reader :changes
+
+              sig { params(changes: Integer).void }
+              attr_writer :changes
+
+              # Wall-clock duration of the statement, in milliseconds.
+              sig { returns(T.nilable(Float)) }
+              attr_reader :duration
+
+              sig { params(duration: Float).void }
+              attr_writer :duration
+
+              # Rowid of the last inserted row, when applicable.
+              sig { returns(T.nilable(Integer)) }
+              attr_reader :last_row_id
+
+              sig { params(last_row_id: Integer).void }
+              attr_writer :last_row_id
+
+              sig { returns(T.nilable(Integer)) }
+              attr_reader :rows_read
+
+              sig { params(rows_read: Integer).void }
+              attr_writer :rows_read
+
+              sig { returns(T.nilable(Integer)) }
+              attr_reader :rows_written
+
+              sig { params(rows_written: Integer).void }
+              attr_writer :rows_written
+
+              sig do
+                params(
+                  changes: Integer,
+                  duration: Float,
+                  last_row_id: Integer,
+                  rows_read: Integer,
+                  rows_written: Integer
+                ).returns(T.attached_class)
+              end
+              def self.new(
+                # Number of rows added, changed, or removed by the statement.
+                changes: nil,
+                # Wall-clock duration of the statement, in milliseconds.
+                duration: nil,
+                # Rowid of the last inserted row, when applicable.
+                last_row_id: nil,
+                rows_read: nil,
+                rows_written: nil
+              )
+              end
+
+              sig do
+                override.returns(
+                  {
+                    changes: Integer,
+                    duration: Float,
+                    last_row_id: Integer,
+                    rows_read: Integer,
+                    rows_written: Integer
+                  }
+                )
+              end
+              def to_hash
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/models/transcript_completed_webhook_event.rbi

@@ -0,0 +1,166 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    class TranscriptCompletedWebhookEvent < Telnyx::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            Telnyx::TranscriptCompletedWebhookEvent,
+            Telnyx::Internal::AnyHash
+          )
+        end
+
+      # Unique event id; deduplicate deliveries on it.
+      sig { returns(String) }
+      attr_accessor :id
+
+      # Finalized transcript details.
+      sig { returns(Telnyx::TranscriptCompletedWebhookEvent::Data) }
+      attr_reader :data
+
+      sig do
+        params(data: Telnyx::TranscriptCompletedWebhookEvent::Data::OrHash).void
+      end
+      attr_writer :data
+
+      # Event type.
+      sig do
+        returns(Telnyx::TranscriptCompletedWebhookEvent::Event::TaggedSymbol)
+      end
+      attr_accessor :event
+
+      # When the event occurred.
+      sig { returns(Time) }
+      attr_accessor :occurred_at
+
+      # Envelope version.
+      sig { returns(String) }
+      attr_accessor :version
+
+      sig do
+        params(
+          id: String,
+          data: Telnyx::TranscriptCompletedWebhookEvent::Data::OrHash,
+          event: Telnyx::TranscriptCompletedWebhookEvent::Event::OrSymbol,
+          occurred_at: Time,
+          version: String
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Unique event id; deduplicate deliveries on it.
+        id:,
+        # Finalized transcript details.
+        data:,
+        # Event type.
+        event:,
+        # When the event occurred.
+        occurred_at:,
+        # Envelope version.
+        version:
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            id: String,
+            data: Telnyx::TranscriptCompletedWebhookEvent::Data,
+            event: Telnyx::TranscriptCompletedWebhookEvent::Event::TaggedSymbol,
+            occurred_at: Time,
+            version: String
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class Data < Telnyx::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Telnyx::TranscriptCompletedWebhookEvent::Data,
+              Telnyx::Internal::AnyHash
+            )
+          end
+
+        # Session end time, or null when unavailable.
+        sig { returns(T.nilable(Time)) }
+        attr_accessor :ended_at
+
+        # Last transcript segment sequence number, or null for an empty transcript.
+        sig { returns(T.nilable(Integer)) }
+        attr_accessor :last_seq
+
+        # Number of transcript segments observed during finalization.
+        sig { returns(Integer) }
+        attr_accessor :segment_count
+
+        # The meeting session this event belongs to.
+        sig { returns(String) }
+        attr_accessor :session_id
+
+        # Finalized transcript details.
+        sig do
+          params(
+            ended_at: T.nilable(Time),
+            last_seq: T.nilable(Integer),
+            segment_count: Integer,
+            session_id: String
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Session end time, or null when unavailable.
+          ended_at:,
+          # Last transcript segment sequence number, or null for an empty transcript.
+          last_seq:,
+          # Number of transcript segments observed during finalization.
+          segment_count:,
+          # The meeting session this event belongs to.
+          session_id:
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              ended_at: T.nilable(Time),
+              last_seq: T.nilable(Integer),
+              segment_count: Integer,
+              session_id: String
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+
+      # Event type.
+      module Event
+        extend Telnyx::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, Telnyx::TranscriptCompletedWebhookEvent::Event)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        TRANSCRIPT_COMPLETED =
+          T.let(
+            :"transcript.completed",
+            Telnyx::TranscriptCompletedWebhookEvent::Event::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              Telnyx::TranscriptCompletedWebhookEvent::Event::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/models/unsafe_unwrap_webhook_event.rbi

@@ -11,6 +11,8 @@ module Telnyx
             Telnyx::CallAIGatherEndedWebhookEvent,
             Telnyx::CallAIGatherMessageHistoryUpdatedWebhookEvent,
             Telnyx::CallAIGatherPartialResultsWebhookEvent,
+            Telnyx::ArtifactCompletedWebhookEvent,
+            Telnyx::ArtifactFailedWebhookEvent,
             Telnyx::CallAnsweredWebhookEvent,
             Telnyx::CallBridgedWebhookEvent,
             Telnyx::CallConversationEndedWebhookEvent,
@@ -74,7 +76,10 @@ module Telnyx
             Telnyx::HostedNumberOrderEventWebhookEvent,
             Telnyx::InboundMessageWebhookEvent,
             Telnyx::NumberOrderStatusUpdateWebhookEvent,
+            Telnyx::RecordingAvailableWebhookEvent,
             Telnyx::ReplacedLinkClickWebhookEvent,
+            Telnyx::SessionStatusChangedWebhookEvent,
+            Telnyx::TranscriptCompletedWebhookEvent,
             Telnyx::TranscriptionWebhookEvent
           )
         end

data/rbi/telnyx/models/unwrap_webhook_event.rbi

@@ -11,6 +11,8 @@ module Telnyx
             Telnyx::CallAIGatherEndedWebhookEvent,
             Telnyx::CallAIGatherMessageHistoryUpdatedWebhookEvent,
             Telnyx::CallAIGatherPartialResultsWebhookEvent,
+            Telnyx::ArtifactCompletedWebhookEvent,
+            Telnyx::ArtifactFailedWebhookEvent,
             Telnyx::CallAnsweredWebhookEvent,
             Telnyx::CallBridgedWebhookEvent,
             Telnyx::CallConversationEndedWebhookEvent,
@@ -74,7 +76,10 @@ module Telnyx
             Telnyx::HostedNumberOrderEventWebhookEvent,
             Telnyx::InboundMessageWebhookEvent,
             Telnyx::NumberOrderStatusUpdateWebhookEvent,
+            Telnyx::RecordingAvailableWebhookEvent,
             Telnyx::ReplacedLinkClickWebhookEvent,
+            Telnyx::SessionStatusChangedWebhookEvent,
+            Telnyx::TranscriptCompletedWebhookEvent,
             Telnyx::TranscriptionWebhookEvent
           )
         end

data/rbi/telnyx/models/web_search/research_citation.rbi

@@ -0,0 +1,53 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    module WebSearch
+      class ResearchCitation < Telnyx::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Telnyx::WebSearch::ResearchCitation,
+              Telnyx::Internal::AnyHash
+            )
+          end
+
+        # Title of the source page.
+        sig { returns(String) }
+        attr_accessor :title
+
+        # Source URL.
+        sig { returns(String) }
+        attr_accessor :url
+
+        # Relevant excerpt from the source (if available).
+        sig { returns(T.nilable(String)) }
+        attr_reader :snippet
+
+        sig { params(snippet: String).void }
+        attr_writer :snippet
+
+        sig do
+          params(title: String, url: String, snippet: String).returns(
+            T.attached_class
+          )
+        end
+        def self.new(
+          # Title of the source page.
+          title:,
+          # Source URL.
+          url:,
+          # Relevant excerpt from the source (if available).
+          snippet: nil
+        )
+        end
+
+        sig do
+          override.returns({ title: String, url: String, snippet: String })
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/models/web_search/research_create_params.rbi

@@ -0,0 +1,138 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    module WebSearch
+      class ResearchCreateParams < Telnyx::Internal::Type::BaseModel
+        extend Telnyx::Internal::Type::RequestParameters::Converter
+        include Telnyx::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              Telnyx::WebSearch::ResearchCreateParams,
+              Telnyx::Internal::AnyHash
+            )
+          end
+
+        # The research question or topic.
+        sig { returns(String) }
+        attr_accessor :query
+
+        # When `true`, the research runs asynchronously. The response returns a `task_id`
+        # immediately instead of waiting for the result. Poll
+        # `GET /web_search/research/{task_id}` to check status.
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_reader :background
+
+        sig { params(background: T::Boolean).void }
+        attr_writer :background
+
+        # Maximum number of sources to use.
+        sig { returns(T.nilable(Integer)) }
+        attr_reader :max_sources
+
+        sig { params(max_sources: Integer).void }
+        attr_writer :max_sources
+
+        # Research depth level. `lite` is fastest, `deep` is most thorough.
+        sig do
+          returns(
+            T.nilable(
+              Telnyx::WebSearch::ResearchCreateParams::ResearchEffort::OrSymbol
+            )
+          )
+        end
+        attr_reader :research_effort
+
+        sig do
+          params(
+            research_effort:
+              Telnyx::WebSearch::ResearchCreateParams::ResearchEffort::OrSymbol
+          ).void
+        end
+        attr_writer :research_effort
+
+        sig do
+          params(
+            query: String,
+            background: T::Boolean,
+            max_sources: Integer,
+            research_effort:
+              Telnyx::WebSearch::ResearchCreateParams::ResearchEffort::OrSymbol,
+            request_options: Telnyx::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The research question or topic.
+          query:,
+          # When `true`, the research runs asynchronously. The response returns a `task_id`
+          # immediately instead of waiting for the result. Poll
+          # `GET /web_search/research/{task_id}` to check status.
+          background: nil,
+          # Maximum number of sources to use.
+          max_sources: nil,
+          # Research depth level. `lite` is fastest, `deep` is most thorough.
+          research_effort: nil,
+          request_options: {}
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              query: String,
+              background: T::Boolean,
+              max_sources: Integer,
+              research_effort:
+                Telnyx::WebSearch::ResearchCreateParams::ResearchEffort::OrSymbol,
+              request_options: Telnyx::RequestOptions
+            }
+          )
+        end
+        def to_hash
+        end
+
+        # Research depth level. `lite` is fastest, `deep` is most thorough.
+        module ResearchEffort
+          extend Telnyx::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                Telnyx::WebSearch::ResearchCreateParams::ResearchEffort
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          LITE =
+            T.let(
+              :lite,
+              Telnyx::WebSearch::ResearchCreateParams::ResearchEffort::TaggedSymbol
+            )
+          STANDARD =
+            T.let(
+              :standard,
+              Telnyx::WebSearch::ResearchCreateParams::ResearchEffort::TaggedSymbol
+            )
+          DEEP =
+            T.let(
+              :deep,
+              Telnyx::WebSearch::ResearchCreateParams::ResearchEffort::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                Telnyx::WebSearch::ResearchCreateParams::ResearchEffort::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+    end
+  end
+end