telnyx 5.160.0 → 5.162.0

data/rbi/telnyx/models/web_search_contents_response.rbi

@@ -0,0 +1,232 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    class WebSearchContentsResponse < Telnyx::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            Telnyx::Models::WebSearchContentsResponse,
+            Telnyx::Internal::AnyHash
+          )
+        end
+
+      sig do
+        returns(T.nilable(Telnyx::Models::WebSearchContentsResponse::Data))
+      end
+      attr_reader :data
+
+      sig do
+        params(
+          data: Telnyx::Models::WebSearchContentsResponse::Data::OrHash
+        ).void
+      end
+      attr_writer :data
+
+      sig do
+        params(
+          data: Telnyx::Models::WebSearchContentsResponse::Data::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(data: nil)
+      end
+
+      sig do
+        override.returns(
+          { data: Telnyx::Models::WebSearchContentsResponse::Data }
+        )
+      end
+      def to_hash
+      end
+
+      class Data < Telnyx::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Telnyx::Models::WebSearchContentsResponse::Data,
+              Telnyx::Internal::AnyHash
+            )
+          end
+
+        sig do
+          returns(
+            T.nilable(
+              T::Array[Telnyx::Models::WebSearchContentsResponse::Data::Result]
+            )
+          )
+        end
+        attr_reader :results
+
+        sig do
+          params(
+            results:
+              T::Array[
+                Telnyx::Models::WebSearchContentsResponse::Data::Result::OrHash
+              ]
+          ).void
+        end
+        attr_writer :results
+
+        sig do
+          params(
+            results:
+              T::Array[
+                Telnyx::Models::WebSearchContentsResponse::Data::Result::OrHash
+              ]
+          ).returns(T.attached_class)
+        end
+        def self.new(results: nil)
+        end
+
+        sig do
+          override.returns(
+            {
+              results:
+                T::Array[
+                  Telnyx::Models::WebSearchContentsResponse::Data::Result
+                ]
+            }
+          )
+        end
+        def to_hash
+        end
+
+        class Result < Telnyx::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Telnyx::Models::WebSearchContentsResponse::Data::Result,
+                Telnyx::Internal::AnyHash
+              )
+            end
+
+          # The source URL.
+          sig { returns(String) }
+          attr_accessor :url
+
+          # Cleaned HTML content (if `html` format requested; may also be present on freshly
+          # crawled pages).
+          sig { returns(T.nilable(String)) }
+          attr_reader :html
+
+          sig { params(html: String).void }
+          attr_writer :html
+
+          # Markdown content (if `markdown` format requested).
+          sig { returns(T.nilable(String)) }
+          attr_reader :markdown
+
+          sig { params(markdown: String).void }
+          attr_writer :markdown
+
+          # Page metadata (if `metadata` format requested).
+          sig do
+            returns(
+              T.nilable(
+                Telnyx::Models::WebSearchContentsResponse::Data::Result::Metadata
+              )
+            )
+          end
+          attr_reader :metadata
+
+          sig do
+            params(
+              metadata:
+                Telnyx::Models::WebSearchContentsResponse::Data::Result::Metadata::OrHash
+            ).void
+          end
+          attr_writer :metadata
+
+          # Page title (if available).
+          sig { returns(T.nilable(String)) }
+          attr_reader :title
+
+          sig { params(title: String).void }
+          attr_writer :title
+
+          sig do
+            params(
+              url: String,
+              html: String,
+              markdown: String,
+              metadata:
+                Telnyx::Models::WebSearchContentsResponse::Data::Result::Metadata::OrHash,
+              title: String
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # The source URL.
+            url:,
+            # Cleaned HTML content (if `html` format requested; may also be present on freshly
+            # crawled pages).
+            html: nil,
+            # Markdown content (if `markdown` format requested).
+            markdown: nil,
+            # Page metadata (if `metadata` format requested).
+            metadata: nil,
+            # Page title (if available).
+            title: nil
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                url: String,
+                html: String,
+                markdown: String,
+                metadata:
+                  Telnyx::Models::WebSearchContentsResponse::Data::Result::Metadata,
+                title: String
+              }
+            )
+          end
+          def to_hash
+          end
+
+          class Metadata < Telnyx::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  Telnyx::Models::WebSearchContentsResponse::Data::Result::Metadata,
+                  Telnyx::Internal::AnyHash
+                )
+              end
+
+            # Favicon URL (if available).
+            sig { returns(T.nilable(String)) }
+            attr_reader :favicon_url
+
+            sig { params(favicon_url: String).void }
+            attr_writer :favicon_url
+
+            # Site name. Often empty.
+            sig { returns(T.nilable(String)) }
+            attr_reader :site_name
+
+            sig { params(site_name: String).void }
+            attr_writer :site_name
+
+            # Page metadata (if `metadata` format requested).
+            sig do
+              params(favicon_url: String, site_name: String).returns(
+                T.attached_class
+              )
+            end
+            def self.new(
+              # Favicon URL (if available).
+              favicon_url: nil,
+              # Site name. Often empty.
+              site_name: nil
+            )
+            end
+
+            sig { override.returns({ favicon_url: String, site_name: String }) }
+            def to_hash
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/models/web_search_create_params.rbi

@@ -0,0 +1,162 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    class WebSearchCreateParams < Telnyx::Internal::Type::BaseModel
+      extend Telnyx::Internal::Type::RequestParameters::Converter
+      include Telnyx::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(Telnyx::WebSearchCreateParams, Telnyx::Internal::AnyHash)
+        end
+
+      # The search query text.
+      sig { returns(String) }
+      attr_accessor :query
+
+      # Number of results to return (1-100).
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :count
+
+      sig { params(count: Integer).void }
+      attr_writer :count
+
+      # Two-letter country code (ISO 3166-1 alpha-2) to bias results.
+      sig { returns(T.nilable(String)) }
+      attr_reader :country
+
+      sig { params(country: String).void }
+      attr_writer :country
+
+      # Exclude results from these domains (bare hostnames, e.g. `pinterest.com`).
+      sig { returns(T.nilable(T::Array[String])) }
+      attr_reader :exclude_domains
+
+      sig { params(exclude_domains: T::Array[String]).void }
+      attr_writer :exclude_domains
+
+      # Time-based filter for results. Common values: `day`, `week`, `month`, `year`.
+      sig { returns(T.nilable(String)) }
+      attr_reader :freshness
+
+      sig { params(freshness: String).void }
+      attr_writer :freshness
+
+      # Restrict results to these domains (bare hostnames, e.g. `arxiv.org`).
+      sig { returns(T.nilable(T::Array[String])) }
+      attr_reader :include_domains
+
+      sig { params(include_domains: T::Array[String]).void }
+      attr_writer :include_domains
+
+      # When true, the provider crawls pages in real-time for fresh content. The boolean
+      # is translated to the provider's internal enum internally; callers always pass
+      # `true` or `false`.
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :livecrawl
+
+      sig { params(livecrawl: T::Boolean).void }
+      attr_writer :livecrawl
+
+      # Safe search filter level.
+      sig do
+        returns(T.nilable(Telnyx::WebSearchCreateParams::Safesearch::OrSymbol))
+      end
+      attr_reader :safesearch
+
+      sig do
+        params(
+          safesearch: Telnyx::WebSearchCreateParams::Safesearch::OrSymbol
+        ).void
+      end
+      attr_writer :safesearch
+
+      sig do
+        params(
+          query: String,
+          count: Integer,
+          country: String,
+          exclude_domains: T::Array[String],
+          freshness: String,
+          include_domains: T::Array[String],
+          livecrawl: T::Boolean,
+          safesearch: Telnyx::WebSearchCreateParams::Safesearch::OrSymbol,
+          request_options: Telnyx::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The search query text.
+        query:,
+        # Number of results to return (1-100).
+        count: nil,
+        # Two-letter country code (ISO 3166-1 alpha-2) to bias results.
+        country: nil,
+        # Exclude results from these domains (bare hostnames, e.g. `pinterest.com`).
+        exclude_domains: nil,
+        # Time-based filter for results. Common values: `day`, `week`, `month`, `year`.
+        freshness: nil,
+        # Restrict results to these domains (bare hostnames, e.g. `arxiv.org`).
+        include_domains: nil,
+        # When true, the provider crawls pages in real-time for fresh content. The boolean
+        # is translated to the provider's internal enum internally; callers always pass
+        # `true` or `false`.
+        livecrawl: nil,
+        # Safe search filter level.
+        safesearch: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            query: String,
+            count: Integer,
+            country: String,
+            exclude_domains: T::Array[String],
+            freshness: String,
+            include_domains: T::Array[String],
+            livecrawl: T::Boolean,
+            safesearch: Telnyx::WebSearchCreateParams::Safesearch::OrSymbol,
+            request_options: Telnyx::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+
+      # Safe search filter level.
+      module Safesearch
+        extend Telnyx::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, Telnyx::WebSearchCreateParams::Safesearch)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        OFF =
+          T.let(:off, Telnyx::WebSearchCreateParams::Safesearch::TaggedSymbol)
+        MODERATE =
+          T.let(
+            :moderate,
+            Telnyx::WebSearchCreateParams::Safesearch::TaggedSymbol
+          )
+        STRICT =
+          T.let(
+            :strict,
+            Telnyx::WebSearchCreateParams::Safesearch::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[Telnyx::WebSearchCreateParams::Safesearch::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/models/web_search_create_response.rbi

@@ -0,0 +1,127 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    class WebSearchCreateResponse < Telnyx::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            Telnyx::Models::WebSearchCreateResponse,
+            Telnyx::Internal::AnyHash
+          )
+        end
+
+      sig { returns(T.nilable(Telnyx::Models::WebSearchCreateResponse::Data)) }
+      attr_reader :data
+
+      sig do
+        params(data: Telnyx::Models::WebSearchCreateResponse::Data::OrHash).void
+      end
+      attr_writer :data
+
+      sig do
+        params(
+          data: Telnyx::Models::WebSearchCreateResponse::Data::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(data: nil)
+      end
+
+      sig do
+        override.returns(
+          { data: Telnyx::Models::WebSearchCreateResponse::Data }
+        )
+      end
+      def to_hash
+      end
+
+      class Data < Telnyx::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Telnyx::Models::WebSearchCreateResponse::Data,
+              Telnyx::Internal::AnyHash
+            )
+          end
+
+        sig do
+          returns(
+            T.nilable(Telnyx::Models::WebSearchCreateResponse::Data::Results)
+          )
+        end
+        attr_reader :results
+
+        sig do
+          params(
+            results:
+              Telnyx::Models::WebSearchCreateResponse::Data::Results::OrHash
+          ).void
+        end
+        attr_writer :results
+
+        sig do
+          params(
+            results:
+              Telnyx::Models::WebSearchCreateResponse::Data::Results::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(results: nil)
+        end
+
+        sig do
+          override.returns(
+            { results: Telnyx::Models::WebSearchCreateResponse::Data::Results }
+          )
+        end
+        def to_hash
+        end
+
+        class Results < Telnyx::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Telnyx::Models::WebSearchCreateResponse::Data::Results,
+                Telnyx::Internal::AnyHash
+              )
+            end
+
+          # Web search results.
+          sig { returns(T::Array[Telnyx::WebSearchResult]) }
+          attr_accessor :web
+
+          # News search results. Present only when the query surfaces news results.
+          sig { returns(T.nilable(T::Array[Telnyx::WebSearchResult])) }
+          attr_reader :news
+
+          sig { params(news: T::Array[Telnyx::WebSearchResult::OrHash]).void }
+          attr_writer :news
+
+          sig do
+            params(
+              web: T::Array[Telnyx::WebSearchResult::OrHash],
+              news: T::Array[Telnyx::WebSearchResult::OrHash]
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # Web search results.
+            web:,
+            # News search results. Present only when the query surfaces news results.
+            news: nil
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                web: T::Array[Telnyx::WebSearchResult],
+                news: T::Array[Telnyx::WebSearchResult]
+              }
+            )
+          end
+          def to_hash
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/models/web_search_result.rbi

@@ -0,0 +1,83 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    class WebSearchResult < Telnyx::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Telnyx::WebSearchResult, Telnyx::Internal::AnyHash)
+        end
+
+      # Short description or excerpt.
+      sig { returns(String) }
+      attr_accessor :description
+
+      # Relevant text snippets from the page.
+      sig { returns(T::Array[String]) }
+      attr_accessor :snippets
+
+      # Result title.
+      sig { returns(String) }
+      attr_accessor :title
+
+      # Result URL.
+      sig { returns(String) }
+      attr_accessor :url
+
+      # Favicon URL (if available).
+      sig { returns(T.nilable(String)) }
+      attr_reader :favicon_url
+
+      sig { params(favicon_url: String).void }
+      attr_writer :favicon_url
+
+      # Thumbnail image URL (if available).
+      sig { returns(T.nilable(String)) }
+      attr_reader :thumbnail_url
+
+      sig { params(thumbnail_url: String).void }
+      attr_writer :thumbnail_url
+
+      sig do
+        params(
+          description: String,
+          snippets: T::Array[String],
+          title: String,
+          url: String,
+          favicon_url: String,
+          thumbnail_url: String
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Short description or excerpt.
+        description:,
+        # Relevant text snippets from the page.
+        snippets:,
+        # Result title.
+        title:,
+        # Result URL.
+        url:,
+        # Favicon URL (if available).
+        favicon_url: nil,
+        # Thumbnail image URL (if available).
+        thumbnail_url: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            description: String,
+            snippets: T::Array[String],
+            title: String,
+            url: String,
+            favicon_url: String,
+            thumbnail_url: String
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/telnyx/models.rbi

@@ -71,6 +71,10 @@ module Telnyx
 
   APIError = Telnyx::Models::APIError
 
+  ArtifactCompletedWebhookEvent = Telnyx::Models::ArtifactCompletedWebhookEvent
+
+  ArtifactFailedWebhookEvent = Telnyx::Models::ArtifactFailedWebhookEvent
+
   AttachmentRequest = Telnyx::Models::AttachmentRequest
 
   Attempt = Telnyx::Models::Attempt
@@ -1136,6 +1140,34 @@ module Telnyx
 
   MediaUploadParams = Telnyx::Models::MediaUploadParams
 
+  MeetingSession = Telnyx::Models::MeetingSession
+
+  MeetingSessionCreateParams = Telnyx::Models::MeetingSessionCreateParams
+
+  MeetingSessionDeleteParams = Telnyx::Models::MeetingSessionDeleteParams
+
+  MeetingSessionDeleteRecordingMediaParams =
+    Telnyx::Models::MeetingSessionDeleteRecordingMediaParams
+
+  MeetingSessionListParams = Telnyx::Models::MeetingSessionListParams
+
+  MeetingSessionResponse = Telnyx::Models::MeetingSessionResponse
+
+  MeetingSessionRetrieveEventsParams =
+    Telnyx::Models::MeetingSessionRetrieveEventsParams
+
+  MeetingSessionRetrieveParams = Telnyx::Models::MeetingSessionRetrieveParams
+
+  MeetingSessionRetrieveRecordingsParams =
+    Telnyx::Models::MeetingSessionRetrieveRecordingsParams
+
+  MeetingSessionRetrieveTranscriptParams =
+    Telnyx::Models::MeetingSessionRetrieveTranscriptParams
+
+  MeetingSessions = Telnyx::Models::MeetingSessions
+
+  MeetingSessionUpdateParams = Telnyx::Models::MeetingSessionUpdateParams
+
   MessageCancelScheduledParams = Telnyx::Models::MessageCancelScheduledParams
 
   MessageEvent = Telnyx::Models::MessageEvent
@@ -1748,6 +1780,9 @@ module Telnyx
 
   Record = Telnyx::Models::Record
 
+  RecordingAvailableWebhookEvent =
+    Telnyx::Models::RecordingAvailableWebhookEvent
+
   RecordingDeleteParams = Telnyx::Models::RecordingDeleteParams
 
   RecordingListParams = Telnyx::Models::RecordingListParams
@@ -1874,6 +1909,9 @@ module Telnyx
 
   SessionAnalysisRetrieveParams = Telnyx::Models::SessionAnalysisRetrieveParams
 
+  SessionStatusChangedWebhookEvent =
+    Telnyx::Models::SessionStatusChangedWebhookEvent
+
   SetiRetrieveBlackBoxTestResultsParams =
     Telnyx::Models::SetiRetrieveBlackBoxTestResultsParams
 
@@ -2112,6 +2150,9 @@ module Telnyx
 
   TrafficType = Telnyx::Models::TrafficType
 
+  TranscriptCompletedWebhookEvent =
+    Telnyx::Models::TranscriptCompletedWebhookEvent
+
   Transcription = Telnyx::Models::Transcription
 
   TranscriptionWebhookEvent = Telnyx::Models::TranscriptionWebhookEvent
@@ -2323,6 +2364,14 @@ module Telnyx
 
   WebhookUnwrapParams = Telnyx::Models::WebhookUnwrapParams
 
+  WebSearch = Telnyx::Models::WebSearch
+
+  WebSearchContentsParams = Telnyx::Models::WebSearchContentsParams
+
+  WebSearchCreateParams = Telnyx::Models::WebSearchCreateParams
+
+  WebSearchResult = Telnyx::Models::WebSearchResult
+
   WellKnownRetrieveAuthorizationServerMetadataParams =
     Telnyx::Models::WellKnownRetrieveAuthorizationServerMetadataParams