telnyx 5.160.0 → 5.161.0

data/rbi/telnyx/models/web_search/research_create_response.rbi

@@ -0,0 +1,235 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    module WebSearch
+      class ResearchCreateResponse < Telnyx::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Telnyx::Models::WebSearch::ResearchCreateResponse,
+              Telnyx::Internal::AnyHash
+            )
+          end
+
+        # Synchronous research response (when `background` is false or unset).
+        sig do
+          returns(
+            T.nilable(
+              Telnyx::Models::WebSearch::ResearchCreateResponse::Data::Variants
+            )
+          )
+        end
+        attr_reader :data
+
+        sig do
+          params(
+            data:
+              T.any(
+                Telnyx::Models::WebSearch::ResearchCreateResponse::Data::ResearchResponseSync::OrHash,
+                Telnyx::Models::WebSearch::ResearchCreateResponse::Data::ResearchResponseAsync::OrHash
+              )
+          ).void
+        end
+        attr_writer :data
+
+        sig do
+          params(
+            data:
+              T.any(
+                Telnyx::Models::WebSearch::ResearchCreateResponse::Data::ResearchResponseSync::OrHash,
+                Telnyx::Models::WebSearch::ResearchCreateResponse::Data::ResearchResponseAsync::OrHash
+              )
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Synchronous research response (when `background` is false or unset).
+          data: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              data:
+                Telnyx::Models::WebSearch::ResearchCreateResponse::Data::Variants
+            }
+          )
+        end
+        def to_hash
+        end
+
+        # Synchronous research response (when `background` is false or unset).
+        module Data
+          extend Telnyx::Internal::Type::Union
+
+          Variants =
+            T.type_alias do
+              T.any(
+                Telnyx::Models::WebSearch::ResearchCreateResponse::Data::ResearchResponseSync,
+                Telnyx::Models::WebSearch::ResearchCreateResponse::Data::ResearchResponseAsync
+              )
+            end
+
+          class ResearchResponseSync < Telnyx::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  Telnyx::Models::WebSearch::ResearchCreateResponse::Data::ResearchResponseSync,
+                  Telnyx::Internal::AnyHash
+                )
+              end
+
+            # The synthesized research answer.
+            sig { returns(String) }
+            attr_accessor :answer
+
+            # Sources cited in the answer.
+            sig do
+              returns(T.nilable(T::Array[Telnyx::WebSearch::ResearchCitation]))
+            end
+            attr_reader :citations
+
+            sig do
+              params(
+                citations: T::Array[Telnyx::WebSearch::ResearchCitation::OrHash]
+              ).void
+            end
+            attr_writer :citations
+
+            # Synchronous research response (when `background` is false or unset).
+            sig do
+              params(
+                answer: String,
+                citations: T::Array[Telnyx::WebSearch::ResearchCitation::OrHash]
+              ).returns(T.attached_class)
+            end
+            def self.new(
+              # The synthesized research answer.
+              answer:,
+              # Sources cited in the answer.
+              citations: nil
+            )
+            end
+
+            sig do
+              override.returns(
+                {
+                  answer: String,
+                  citations: T::Array[Telnyx::WebSearch::ResearchCitation]
+                }
+              )
+            end
+            def to_hash
+            end
+          end
+
+          class ResearchResponseAsync < Telnyx::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  Telnyx::Models::WebSearch::ResearchCreateResponse::Data::ResearchResponseAsync,
+                  Telnyx::Internal::AnyHash
+                )
+              end
+
+            # Current status of the research task.
+            sig do
+              returns(
+                Telnyx::Models::WebSearch::ResearchCreateResponse::Data::ResearchResponseAsync::Status::TaggedSymbol
+              )
+            end
+            attr_accessor :status
+
+            # Unique identifier for the research task. Use this to poll the status.
+            sig { returns(String) }
+            attr_accessor :task_id
+
+            # Asynchronous research response (when `background` is true).
+            sig do
+              params(
+                status:
+                  Telnyx::Models::WebSearch::ResearchCreateResponse::Data::ResearchResponseAsync::Status::OrSymbol,
+                task_id: String
+              ).returns(T.attached_class)
+            end
+            def self.new(
+              # Current status of the research task.
+              status:,
+              # Unique identifier for the research task. Use this to poll the status.
+              task_id:
+            )
+            end
+
+            sig do
+              override.returns(
+                {
+                  status:
+                    Telnyx::Models::WebSearch::ResearchCreateResponse::Data::ResearchResponseAsync::Status::TaggedSymbol,
+                  task_id: String
+                }
+              )
+            end
+            def to_hash
+            end
+
+            # Current status of the research task.
+            module Status
+              extend Telnyx::Internal::Type::Enum
+
+              TaggedSymbol =
+                T.type_alias do
+                  T.all(
+                    Symbol,
+                    Telnyx::Models::WebSearch::ResearchCreateResponse::Data::ResearchResponseAsync::Status
+                  )
+                end
+              OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+              PENDING =
+                T.let(
+                  :pending,
+                  Telnyx::Models::WebSearch::ResearchCreateResponse::Data::ResearchResponseAsync::Status::TaggedSymbol
+                )
+              RUNNING =
+                T.let(
+                  :running,
+                  Telnyx::Models::WebSearch::ResearchCreateResponse::Data::ResearchResponseAsync::Status::TaggedSymbol
+                )
+              COMPLETED =
+                T.let(
+                  :completed,
+                  Telnyx::Models::WebSearch::ResearchCreateResponse::Data::ResearchResponseAsync::Status::TaggedSymbol
+                )
+              FAILED =
+                T.let(
+                  :failed,
+                  Telnyx::Models::WebSearch::ResearchCreateResponse::Data::ResearchResponseAsync::Status::TaggedSymbol
+                )
+
+              sig do
+                override.returns(
+                  T::Array[
+                    Telnyx::Models::WebSearch::ResearchCreateResponse::Data::ResearchResponseAsync::Status::TaggedSymbol
+                  ]
+                )
+              end
+              def self.values
+              end
+            end
+          end
+
+          sig do
+            override.returns(
+              T::Array[
+                Telnyx::Models::WebSearch::ResearchCreateResponse::Data::Variants
+              ]
+            )
+          end
+          def self.variants
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/models/web_search/research_retrieve_params.rbi

@@ -0,0 +1,40 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    module WebSearch
+      class ResearchRetrieveParams < Telnyx::Internal::Type::BaseModel
+        extend Telnyx::Internal::Type::RequestParameters::Converter
+        include Telnyx::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              Telnyx::WebSearch::ResearchRetrieveParams,
+              Telnyx::Internal::AnyHash
+            )
+          end
+
+        sig { returns(String) }
+        attr_accessor :task_id
+
+        sig do
+          params(
+            task_id: String,
+            request_options: Telnyx::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(task_id:, request_options: {})
+        end
+
+        sig do
+          override.returns(
+            { task_id: String, request_options: Telnyx::RequestOptions }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/models/web_search/research_retrieve_response.rbi

@@ -0,0 +1,179 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    module WebSearch
+      class ResearchRetrieveResponse < Telnyx::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Telnyx::Models::WebSearch::ResearchRetrieveResponse,
+              Telnyx::Internal::AnyHash
+            )
+          end
+
+        sig do
+          returns(
+            T.nilable(Telnyx::Models::WebSearch::ResearchRetrieveResponse::Data)
+          )
+        end
+        attr_reader :data
+
+        sig do
+          params(
+            data:
+              Telnyx::Models::WebSearch::ResearchRetrieveResponse::Data::OrHash
+          ).void
+        end
+        attr_writer :data
+
+        sig do
+          params(
+            data:
+              Telnyx::Models::WebSearch::ResearchRetrieveResponse::Data::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(data: nil)
+        end
+
+        sig do
+          override.returns(
+            { data: Telnyx::Models::WebSearch::ResearchRetrieveResponse::Data }
+          )
+        end
+        def to_hash
+        end
+
+        class Data < Telnyx::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Telnyx::Models::WebSearch::ResearchRetrieveResponse::Data,
+                Telnyx::Internal::AnyHash
+              )
+            end
+
+          # Current status of the research task.
+          sig do
+            returns(
+              Telnyx::Models::WebSearch::ResearchRetrieveResponse::Data::Status::TaggedSymbol
+            )
+          end
+          attr_accessor :status
+
+          # The research task identifier.
+          sig { returns(String) }
+          attr_accessor :task_id
+
+          # The synthesized research answer (present when status is `completed`).
+          sig { returns(T.nilable(String)) }
+          attr_reader :answer
+
+          sig { params(answer: String).void }
+          attr_writer :answer
+
+          # Sources cited in the answer (present when status is `completed`).
+          sig do
+            returns(T.nilable(T::Array[Telnyx::WebSearch::ResearchCitation]))
+          end
+          attr_reader :citations
+
+          sig do
+            params(
+              citations: T::Array[Telnyx::WebSearch::ResearchCitation::OrHash]
+            ).void
+          end
+          attr_writer :citations
+
+          # Always present in poll responses; `null` unless the task failed.
+          sig { returns(T.nilable(String)) }
+          attr_accessor :error
+
+          sig do
+            params(
+              status:
+                Telnyx::Models::WebSearch::ResearchRetrieveResponse::Data::Status::OrSymbol,
+              task_id: String,
+              answer: String,
+              citations: T::Array[Telnyx::WebSearch::ResearchCitation::OrHash],
+              error: T.nilable(String)
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # Current status of the research task.
+            status:,
+            # The research task identifier.
+            task_id:,
+            # The synthesized research answer (present when status is `completed`).
+            answer: nil,
+            # Sources cited in the answer (present when status is `completed`).
+            citations: nil,
+            # Always present in poll responses; `null` unless the task failed.
+            error: nil
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                status:
+                  Telnyx::Models::WebSearch::ResearchRetrieveResponse::Data::Status::TaggedSymbol,
+                task_id: String,
+                answer: String,
+                citations: T::Array[Telnyx::WebSearch::ResearchCitation],
+                error: T.nilable(String)
+              }
+            )
+          end
+          def to_hash
+          end
+
+          # Current status of the research task.
+          module Status
+            extend Telnyx::Internal::Type::Enum
+
+            TaggedSymbol =
+              T.type_alias do
+                T.all(
+                  Symbol,
+                  Telnyx::Models::WebSearch::ResearchRetrieveResponse::Data::Status
+                )
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            PENDING =
+              T.let(
+                :pending,
+                Telnyx::Models::WebSearch::ResearchRetrieveResponse::Data::Status::TaggedSymbol
+              )
+            RUNNING =
+              T.let(
+                :running,
+                Telnyx::Models::WebSearch::ResearchRetrieveResponse::Data::Status::TaggedSymbol
+              )
+            COMPLETED =
+              T.let(
+                :completed,
+                Telnyx::Models::WebSearch::ResearchRetrieveResponse::Data::Status::TaggedSymbol
+              )
+            FAILED =
+              T.let(
+                :failed,
+                Telnyx::Models::WebSearch::ResearchRetrieveResponse::Data::Status::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  Telnyx::Models::WebSearch::ResearchRetrieveResponse::Data::Status::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/models/web_search_contents_params.rbi

@@ -0,0 +1,119 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    class WebSearchContentsParams < Telnyx::Internal::Type::BaseModel
+      extend Telnyx::Internal::Type::RequestParameters::Converter
+      include Telnyx::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(Telnyx::WebSearchContentsParams, Telnyx::Internal::AnyHash)
+        end
+
+      # List of URLs to retrieve content from (max 20 for public API).
+      sig { returns(T::Array[String]) }
+      attr_accessor :urls
+
+      # Timeout for crawling each URL, in seconds (1-60).
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :crawl_timeout
+
+      sig { params(crawl_timeout: Integer).void }
+      attr_writer :crawl_timeout
+
+      # Content formats to return. If omitted, `html` and `metadata` are returned by
+      # default. Retrieval is best-effort per URL: a format field appears only when that
+      # content could be produced, and a freshly crawled page may also include `html`
+      # even when not requested.
+      sig do
+        returns(
+          T.nilable(T::Array[Telnyx::WebSearchContentsParams::Format::OrSymbol])
+        )
+      end
+      attr_reader :formats
+
+      sig do
+        params(
+          formats: T::Array[Telnyx::WebSearchContentsParams::Format::OrSymbol]
+        ).void
+      end
+      attr_writer :formats
+
+      # Maximum age of cached content in seconds. `null` means no limit.
+      sig { returns(T.nilable(Integer)) }
+      attr_accessor :max_age
+
+      sig do
+        params(
+          urls: T::Array[String],
+          crawl_timeout: Integer,
+          formats: T::Array[Telnyx::WebSearchContentsParams::Format::OrSymbol],
+          max_age: T.nilable(Integer),
+          request_options: Telnyx::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # List of URLs to retrieve content from (max 20 for public API).
+        urls:,
+        # Timeout for crawling each URL, in seconds (1-60).
+        crawl_timeout: nil,
+        # Content formats to return. If omitted, `html` and `metadata` are returned by
+        # default. Retrieval is best-effort per URL: a format field appears only when that
+        # content could be produced, and a freshly crawled page may also include `html`
+        # even when not requested.
+        formats: nil,
+        # Maximum age of cached content in seconds. `null` means no limit.
+        max_age: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            urls: T::Array[String],
+            crawl_timeout: Integer,
+            formats:
+              T::Array[Telnyx::WebSearchContentsParams::Format::OrSymbol],
+            max_age: T.nilable(Integer),
+            request_options: Telnyx::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+
+      module Format
+        extend Telnyx::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, Telnyx::WebSearchContentsParams::Format)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        HTML =
+          T.let(:html, Telnyx::WebSearchContentsParams::Format::TaggedSymbol)
+        MARKDOWN =
+          T.let(
+            :markdown,
+            Telnyx::WebSearchContentsParams::Format::TaggedSymbol
+          )
+        METADATA =
+          T.let(
+            :metadata,
+            Telnyx::WebSearchContentsParams::Format::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[Telnyx::WebSearchContentsParams::Format::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end