telnyx 5.159.0 → 5.161.0

data/lib/telnyx/models/user_addresses_user_address.rb

@@ -0,0 +1,153 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    # @see Telnyx::Resources::UserAddresses#list
+    class UserAddressesUserAddress < Telnyx::Internal::Type::BaseModel
+      # @!attribute id
+      #   Uniquely identifies the user address.
+      #
+      #   @return [String, nil]
+      optional :id, String
+
+      # @!attribute administrative_area
+      #   The locality of the user address. For US addresses, this corresponds to the
+      #   state of the address.
+      #
+      #   @return [String, nil]
+      optional :administrative_area, String
+
+      # @!attribute borough
+      #   The borough of the user address. This field is not used for addresses in the US
+      #   but is used for some international addresses.
+      #
+      #   @return [String, nil]
+      optional :borough, String
+
+      # @!attribute business_name
+      #   The business name associated with the user address.
+      #
+      #   @return [String, nil]
+      optional :business_name, String
+
+      # @!attribute country_code
+      #   The two-character (ISO 3166-1 alpha-2) country code of the user address.
+      #
+      #   @return [String, nil]
+      optional :country_code, String
+
+      # @!attribute created_at
+      #   ISO 8601 formatted date indicating when the resource was created.
+      #
+      #   @return [String, nil]
+      optional :created_at, String
+
+      # @!attribute customer_reference
+      #   A customer reference string for customer look ups.
+      #
+      #   @return [String, nil]
+      optional :customer_reference, String
+
+      # @!attribute extended_address
+      #   Additional street address information about the user address such as, but not
+      #   limited to, unit number or apartment number.
+      #
+      #   @return [String, nil]
+      optional :extended_address, String
+
+      # @!attribute first_name
+      #   The first name associated with the user address.
+      #
+      #   @return [String, nil]
+      optional :first_name, String
+
+      # @!attribute last_name
+      #   The last name associated with the user address.
+      #
+      #   @return [String, nil]
+      optional :last_name, String
+
+      # @!attribute locality
+      #   The locality of the user address. For US addresses, this corresponds to the city
+      #   of the address.
+      #
+      #   @return [String, nil]
+      optional :locality, String
+
+      # @!attribute neighborhood
+      #   The neighborhood of the user address. This field is not used for addresses in
+      #   the US but is used for some international addresses.
+      #
+      #   @return [String, nil]
+      optional :neighborhood, String
+
+      # @!attribute phone_number
+      #   The phone number associated with the user address.
+      #
+      #   @return [String, nil]
+      optional :phone_number, String
+
+      # @!attribute postal_code
+      #   The postal code of the user address.
+      #
+      #   @return [String, nil]
+      optional :postal_code, String
+
+      # @!attribute record_type
+      #   Identifies the type of the resource.
+      #
+      #   @return [String, nil]
+      optional :record_type, String
+
+      # @!attribute street_address
+      #   The primary street address information about the user address.
+      #
+      #   @return [String, nil]
+      optional :street_address, String
+
+      # @!attribute updated_at
+      #   ISO 8601 formatted date indicating when the resource was updated.
+      #
+      #   @return [String, nil]
+      optional :updated_at, String
+
+      # @!method initialize(id: nil, administrative_area: nil, borough: nil, business_name: nil, country_code: nil, created_at: nil, customer_reference: nil, extended_address: nil, first_name: nil, last_name: nil, locality: nil, neighborhood: nil, phone_number: nil, postal_code: nil, record_type: nil, street_address: nil, updated_at: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Telnyx::Models::UserAddressesUserAddress} for more details.
+      #
+      #   @param id [String] Uniquely identifies the user address.
+      #
+      #   @param administrative_area [String] The locality of the user address. For US addresses, this corresponds to the stat
+      #
+      #   @param borough [String] The borough of the user address. This field is not used for addresses in the US
+      #
+      #   @param business_name [String] The business name associated with the user address.
+      #
+      #   @param country_code [String] The two-character (ISO 3166-1 alpha-2) country code of the user address.
+      #
+      #   @param created_at [String] ISO 8601 formatted date indicating when the resource was created.
+      #
+      #   @param customer_reference [String] A customer reference string for customer look ups.
+      #
+      #   @param extended_address [String] Additional street address information about the user address such as, but not li
+      #
+      #   @param first_name [String] The first name associated with the user address.
+      #
+      #   @param last_name [String] The last name associated with the user address.
+      #
+      #   @param locality [String] The locality of the user address. For US addresses, this corresponds to the city
+      #
+      #   @param neighborhood [String] The neighborhood of the user address. This field is not used for addresses in th
+      #
+      #   @param phone_number [String] The phone number associated with the user address.
+      #
+      #   @param postal_code [String] The postal code of the user address.
+      #
+      #   @param record_type [String] Identifies the type of the resource.
+      #
+      #   @param street_address [String] The primary street address information about the user address.
+      #
+      #   @param updated_at [String] ISO 8601 formatted date indicating when the resource was updated.
+    end
+  end
+end

data/lib/telnyx/models/virtual_cross_connects_coverage_list_response.rb

@@ -29,8 +29,8 @@ module Telnyx
 
       # @!attribute location
       #
-      #   @return [Telnyx::Models::NetappsLocation, nil]
-      optional :location, -> { Telnyx::NetappsLocation }
+      #   @return [Telnyx::Models::NetappsLocation17904fcfbc, nil]
+      optional :location, -> { Telnyx::NetappsLocation17904fcfbc }
 
       response_only do
         # @!attribute record_type
@@ -50,7 +50,7 @@ module Telnyx
       #
       #   @param cloud_provider_region [String] The region where your Virtual Private Cloud hosts are located. Should be identic
       #
-      #   @param location [Telnyx::Models::NetappsLocation]
+      #   @param location [Telnyx::Models::NetappsLocation17904fcfbc]
       #
       #   @param record_type [String] Identifies the type of the resource.
 

data/lib/telnyx/models/web_search/research_citation.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module WebSearch
+      class ResearchCitation < Telnyx::Internal::Type::BaseModel
+        # @!attribute title
+        #   Title of the source page.
+        #
+        #   @return [String]
+        required :title, String
+
+        # @!attribute url
+        #   Source URL.
+        #
+        #   @return [String]
+        required :url, String
+
+        # @!attribute snippet
+        #   Relevant excerpt from the source (if available).
+        #
+        #   @return [String, nil]
+        optional :snippet, String
+
+        # @!method initialize(title:, url:, snippet: nil)
+        #   @param title [String] Title of the source page.
+        #
+        #   @param url [String] Source URL.
+        #
+        #   @param snippet [String] Relevant excerpt from the source (if available).
+      end
+    end
+  end
+end

data/lib/telnyx/models/web_search/research_create_params.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module WebSearch
+      # @see Telnyx::Resources::WebSearch::Research#create
+      class ResearchCreateParams < Telnyx::Internal::Type::BaseModel
+        extend Telnyx::Internal::Type::RequestParameters::Converter
+        include Telnyx::Internal::Type::RequestParameters
+
+        # @!attribute query
+        #   The research question or topic.
+        #
+        #   @return [String]
+        required :query, String
+
+        # @!attribute background
+        #   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.
+        #
+        #   @return [Boolean, nil]
+        optional :background, Telnyx::Internal::Type::Boolean
+
+        # @!attribute max_sources
+        #   Maximum number of sources to use.
+        #
+        #   @return [Integer, nil]
+        optional :max_sources, Integer
+
+        # @!attribute research_effort
+        #   Research depth level. `lite` is fastest, `deep` is most thorough.
+        #
+        #   @return [Symbol, Telnyx::Models::WebSearch::ResearchCreateParams::ResearchEffort, nil]
+        optional :research_effort, enum: -> { Telnyx::WebSearch::ResearchCreateParams::ResearchEffort }
+
+        # @!method initialize(query:, background: nil, max_sources: nil, research_effort: nil, request_options: {})
+        #   Some parameter documentations has been truncated, see
+        #   {Telnyx::Models::WebSearch::ResearchCreateParams} for more details.
+        #
+        #   @param query [String] The research question or topic.
+        #
+        #   @param background [Boolean] When `true`, the research runs asynchronously. The response returns a `task_id`
+        #
+        #   @param max_sources [Integer] Maximum number of sources to use.
+        #
+        #   @param research_effort [Symbol, Telnyx::Models::WebSearch::ResearchCreateParams::ResearchEffort] Research depth level. `lite` is fastest, `deep` is most thorough.
+        #
+        #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
+
+        # Research depth level. `lite` is fastest, `deep` is most thorough.
+        module ResearchEffort
+          extend Telnyx::Internal::Type::Enum
+
+          LITE = :lite
+          STANDARD = :standard
+          DEEP = :deep
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

data/lib/telnyx/models/web_search/research_create_response.rb

@@ -0,0 +1,93 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module WebSearch
+      # @see Telnyx::Resources::WebSearch::Research#create
+      class ResearchCreateResponse < Telnyx::Internal::Type::BaseModel
+        # @!attribute data
+        #   Synchronous research response (when `background` is false or unset).
+        #
+        #   @return [Telnyx::Models::WebSearch::ResearchCreateResponse::Data::ResearchResponseSync, Telnyx::Models::WebSearch::ResearchCreateResponse::Data::ResearchResponseAsync, nil]
+        optional :data, union: -> { Telnyx::Models::WebSearch::ResearchCreateResponse::Data }
+
+        # @!method initialize(data: nil)
+        #   @param data [Telnyx::Models::WebSearch::ResearchCreateResponse::Data::ResearchResponseSync, Telnyx::Models::WebSearch::ResearchCreateResponse::Data::ResearchResponseAsync] Synchronous research response (when `background` is false or unset).
+
+        # Synchronous research response (when `background` is false or unset).
+        #
+        # @see Telnyx::Models::WebSearch::ResearchCreateResponse#data
+        module Data
+          extend Telnyx::Internal::Type::Union
+
+          # Synchronous research response (when `background` is false or unset).
+          variant -> { Telnyx::Models::WebSearch::ResearchCreateResponse::Data::ResearchResponseSync }
+
+          # Asynchronous research response (when `background` is true).
+          variant -> { Telnyx::Models::WebSearch::ResearchCreateResponse::Data::ResearchResponseAsync }
+
+          class ResearchResponseSync < Telnyx::Internal::Type::BaseModel
+            # @!attribute answer
+            #   The synthesized research answer.
+            #
+            #   @return [String]
+            required :answer, String
+
+            # @!attribute citations
+            #   Sources cited in the answer.
+            #
+            #   @return [Array<Telnyx::Models::WebSearch::ResearchCitation>, nil]
+            optional :citations, -> { Telnyx::Internal::Type::ArrayOf[Telnyx::WebSearch::ResearchCitation] }
+
+            # @!method initialize(answer:, citations: nil)
+            #   Synchronous research response (when `background` is false or unset).
+            #
+            #   @param answer [String] The synthesized research answer.
+            #
+            #   @param citations [Array<Telnyx::Models::WebSearch::ResearchCitation>] Sources cited in the answer.
+          end
+
+          class ResearchResponseAsync < Telnyx::Internal::Type::BaseModel
+            # @!attribute status
+            #   Current status of the research task.
+            #
+            #   @return [Symbol, Telnyx::Models::WebSearch::ResearchCreateResponse::Data::ResearchResponseAsync::Status]
+            required :status,
+                     enum: -> { Telnyx::Models::WebSearch::ResearchCreateResponse::Data::ResearchResponseAsync::Status }
+
+            # @!attribute task_id
+            #   Unique identifier for the research task. Use this to poll the status.
+            #
+            #   @return [String]
+            required :task_id, String
+
+            # @!method initialize(status:, task_id:)
+            #   Asynchronous research response (when `background` is true).
+            #
+            #   @param status [Symbol, Telnyx::Models::WebSearch::ResearchCreateResponse::Data::ResearchResponseAsync::Status] Current status of the research task.
+            #
+            #   @param task_id [String] Unique identifier for the research task. Use this to poll the status.
+
+            # Current status of the research task.
+            #
+            # @see Telnyx::Models::WebSearch::ResearchCreateResponse::Data::ResearchResponseAsync#status
+            module Status
+              extend Telnyx::Internal::Type::Enum
+
+              PENDING = :pending
+              RUNNING = :running
+              COMPLETED = :completed
+              FAILED = :failed
+
+              # @!method self.values
+              #   @return [Array<Symbol>]
+            end
+          end
+
+          # @!method self.variants
+          #   @return [Array(Telnyx::Models::WebSearch::ResearchCreateResponse::Data::ResearchResponseSync, Telnyx::Models::WebSearch::ResearchCreateResponse::Data::ResearchResponseAsync)]
+        end
+      end
+    end
+  end
+end

data/lib/telnyx/models/web_search/research_retrieve_params.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module WebSearch
+      # @see Telnyx::Resources::WebSearch::Research#retrieve
+      class ResearchRetrieveParams < Telnyx::Internal::Type::BaseModel
+        extend Telnyx::Internal::Type::RequestParameters::Converter
+        include Telnyx::Internal::Type::RequestParameters
+
+        # @!attribute task_id
+        #
+        #   @return [String]
+        required :task_id, String
+
+        # @!method initialize(task_id:, request_options: {})
+        #   @param task_id [String]
+        #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/telnyx/models/web_search/research_retrieve_response.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module WebSearch
+      # @see Telnyx::Resources::WebSearch::Research#retrieve
+      class ResearchRetrieveResponse < Telnyx::Internal::Type::BaseModel
+        # @!attribute data
+        #
+        #   @return [Telnyx::Models::WebSearch::ResearchRetrieveResponse::Data, nil]
+        optional :data, -> { Telnyx::Models::WebSearch::ResearchRetrieveResponse::Data }
+
+        # @!method initialize(data: nil)
+        #   @param data [Telnyx::Models::WebSearch::ResearchRetrieveResponse::Data]
+
+        # @see Telnyx::Models::WebSearch::ResearchRetrieveResponse#data
+        class Data < Telnyx::Internal::Type::BaseModel
+          # @!attribute status
+          #   Current status of the research task.
+          #
+          #   @return [Symbol, Telnyx::Models::WebSearch::ResearchRetrieveResponse::Data::Status]
+          required :status, enum: -> { Telnyx::Models::WebSearch::ResearchRetrieveResponse::Data::Status }
+
+          # @!attribute task_id
+          #   The research task identifier.
+          #
+          #   @return [String]
+          required :task_id, String
+
+          # @!attribute answer
+          #   The synthesized research answer (present when status is `completed`).
+          #
+          #   @return [String, nil]
+          optional :answer, String
+
+          # @!attribute citations
+          #   Sources cited in the answer (present when status is `completed`).
+          #
+          #   @return [Array<Telnyx::Models::WebSearch::ResearchCitation>, nil]
+          optional :citations, -> { Telnyx::Internal::Type::ArrayOf[Telnyx::WebSearch::ResearchCitation] }
+
+          # @!attribute error
+          #   Always present in poll responses; `null` unless the task failed.
+          #
+          #   @return [String, nil]
+          optional :error, String, nil?: true
+
+          # @!method initialize(status:, task_id:, answer: nil, citations: nil, error: nil)
+          #   @param status [Symbol, Telnyx::Models::WebSearch::ResearchRetrieveResponse::Data::Status] Current status of the research task.
+          #
+          #   @param task_id [String] The research task identifier.
+          #
+          #   @param answer [String] The synthesized research answer (present when status is `completed`).
+          #
+          #   @param citations [Array<Telnyx::Models::WebSearch::ResearchCitation>] Sources cited in the answer (present when status is `completed`).
+          #
+          #   @param error [String, nil] Always present in poll responses; `null` unless the task failed.
+
+          # Current status of the research task.
+          #
+          # @see Telnyx::Models::WebSearch::ResearchRetrieveResponse::Data#status
+          module Status
+            extend Telnyx::Internal::Type::Enum
+
+            PENDING = :pending
+            RUNNING = :running
+            COMPLETED = :completed
+            FAILED = :failed
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/telnyx/models/web_search_contents_params.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    # @see Telnyx::Resources::WebSearch#contents
+    class WebSearchContentsParams < Telnyx::Internal::Type::BaseModel
+      extend Telnyx::Internal::Type::RequestParameters::Converter
+      include Telnyx::Internal::Type::RequestParameters
+
+      # @!attribute urls
+      #   List of URLs to retrieve content from (max 20 for public API).
+      #
+      #   @return [Array<String>]
+      required :urls, Telnyx::Internal::Type::ArrayOf[String]
+
+      # @!attribute crawl_timeout
+      #   Timeout for crawling each URL, in seconds (1-60).
+      #
+      #   @return [Integer, nil]
+      optional :crawl_timeout, Integer
+
+      # @!attribute formats
+      #   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.
+      #
+      #   @return [Array<Symbol, Telnyx::Models::WebSearchContentsParams::Format>, nil]
+      optional :formats, -> { Telnyx::Internal::Type::ArrayOf[enum: Telnyx::WebSearchContentsParams::Format] }
+
+      # @!attribute max_age
+      #   Maximum age of cached content in seconds. `null` means no limit.
+      #
+      #   @return [Integer, nil]
+      optional :max_age, Integer, nil?: true
+
+      # @!method initialize(urls:, crawl_timeout: nil, formats: nil, max_age: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Telnyx::Models::WebSearchContentsParams} for more details.
+      #
+      #   @param urls [Array<String>] List of URLs to retrieve content from (max 20 for public API).
+      #
+      #   @param crawl_timeout [Integer] Timeout for crawling each URL, in seconds (1-60).
+      #
+      #   @param formats [Array<Symbol, Telnyx::Models::WebSearchContentsParams::Format>] Content formats to return. If omitted, `html` and `metadata` are returned by def
+      #
+      #   @param max_age [Integer, nil] Maximum age of cached content in seconds. `null` means no limit.
+      #
+      #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
+
+      module Format
+        extend Telnyx::Internal::Type::Enum
+
+        HTML = :html
+        MARKDOWN = :markdown
+        METADATA = :metadata
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/telnyx/models/web_search_contents_response.rb

@@ -0,0 +1,97 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    # @see Telnyx::Resources::WebSearch#contents
+    class WebSearchContentsResponse < Telnyx::Internal::Type::BaseModel
+      # @!attribute data
+      #
+      #   @return [Telnyx::Models::WebSearchContentsResponse::Data, nil]
+      optional :data, -> { Telnyx::Models::WebSearchContentsResponse::Data }
+
+      # @!method initialize(data: nil)
+      #   @param data [Telnyx::Models::WebSearchContentsResponse::Data]
+
+      # @see Telnyx::Models::WebSearchContentsResponse#data
+      class Data < Telnyx::Internal::Type::BaseModel
+        # @!attribute results
+        #
+        #   @return [Array<Telnyx::Models::WebSearchContentsResponse::Data::Result>, nil]
+        optional :results,
+                 -> { Telnyx::Internal::Type::ArrayOf[Telnyx::Models::WebSearchContentsResponse::Data::Result] }
+
+        # @!method initialize(results: nil)
+        #   @param results [Array<Telnyx::Models::WebSearchContentsResponse::Data::Result>]
+
+        class Result < Telnyx::Internal::Type::BaseModel
+          # @!attribute url
+          #   The source URL.
+          #
+          #   @return [String]
+          required :url, String
+
+          # @!attribute html
+          #   Cleaned HTML content (if `html` format requested; may also be present on freshly
+          #   crawled pages).
+          #
+          #   @return [String, nil]
+          optional :html, String
+
+          # @!attribute markdown
+          #   Markdown content (if `markdown` format requested).
+          #
+          #   @return [String, nil]
+          optional :markdown, String
+
+          # @!attribute metadata
+          #   Page metadata (if `metadata` format requested).
+          #
+          #   @return [Telnyx::Models::WebSearchContentsResponse::Data::Result::Metadata, nil]
+          optional :metadata, -> { Telnyx::Models::WebSearchContentsResponse::Data::Result::Metadata }
+
+          # @!attribute title
+          #   Page title (if available).
+          #
+          #   @return [String, nil]
+          optional :title, String
+
+          # @!method initialize(url:, html: nil, markdown: nil, metadata: nil, title: nil)
+          #   Some parameter documentations has been truncated, see
+          #   {Telnyx::Models::WebSearchContentsResponse::Data::Result} for more details.
+          #
+          #   @param url [String] The source URL.
+          #
+          #   @param html [String] Cleaned HTML content (if `html` format requested; may also be present on freshly
+          #
+          #   @param markdown [String] Markdown content (if `markdown` format requested).
+          #
+          #   @param metadata [Telnyx::Models::WebSearchContentsResponse::Data::Result::Metadata] Page metadata (if `metadata` format requested).
+          #
+          #   @param title [String] Page title (if available).
+
+          # @see Telnyx::Models::WebSearchContentsResponse::Data::Result#metadata
+          class Metadata < Telnyx::Internal::Type::BaseModel
+            # @!attribute favicon_url
+            #   Favicon URL (if available).
+            #
+            #   @return [String, nil]
+            optional :favicon_url, String
+
+            # @!attribute site_name
+            #   Site name. Often empty.
+            #
+            #   @return [String, nil]
+            optional :site_name, String
+
+            # @!method initialize(favicon_url: nil, site_name: nil)
+            #   Page metadata (if `metadata` format requested).
+            #
+            #   @param favicon_url [String] Favicon URL (if available).
+            #
+            #   @param site_name [String] Site name. Often empty.
+          end
+        end
+      end
+    end
+  end
+end