telnyx 5.160.0 → 5.161.0

data/lib/telnyx/models/web_search_create_params.rb

@@ -0,0 +1,95 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    # @see Telnyx::Resources::WebSearch#create
+    class WebSearchCreateParams < Telnyx::Internal::Type::BaseModel
+      extend Telnyx::Internal::Type::RequestParameters::Converter
+      include Telnyx::Internal::Type::RequestParameters
+
+      # @!attribute query
+      #   The search query text.
+      #
+      #   @return [String]
+      required :query, String
+
+      # @!attribute count
+      #   Number of results to return (1-100).
+      #
+      #   @return [Integer, nil]
+      optional :count, Integer
+
+      # @!attribute country
+      #   Two-letter country code (ISO 3166-1 alpha-2) to bias results.
+      #
+      #   @return [String, nil]
+      optional :country, String
+
+      # @!attribute exclude_domains
+      #   Exclude results from these domains (bare hostnames, e.g. `pinterest.com`).
+      #
+      #   @return [Array<String>, nil]
+      optional :exclude_domains, Telnyx::Internal::Type::ArrayOf[String]
+
+      # @!attribute freshness
+      #   Time-based filter for results. Common values: `day`, `week`, `month`, `year`.
+      #
+      #   @return [String, nil]
+      optional :freshness, String
+
+      # @!attribute include_domains
+      #   Restrict results to these domains (bare hostnames, e.g. `arxiv.org`).
+      #
+      #   @return [Array<String>, nil]
+      optional :include_domains, Telnyx::Internal::Type::ArrayOf[String]
+
+      # @!attribute livecrawl
+      #   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`.
+      #
+      #   @return [Boolean, nil]
+      optional :livecrawl, Telnyx::Internal::Type::Boolean
+
+      # @!attribute safesearch
+      #   Safe search filter level.
+      #
+      #   @return [Symbol, Telnyx::Models::WebSearchCreateParams::Safesearch, nil]
+      optional :safesearch, enum: -> { Telnyx::WebSearchCreateParams::Safesearch }
+
+      # @!method initialize(query:, count: nil, country: nil, exclude_domains: nil, freshness: nil, include_domains: nil, livecrawl: nil, safesearch: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Telnyx::Models::WebSearchCreateParams} for more details.
+      #
+      #   @param query [String] The search query text.
+      #
+      #   @param count [Integer] Number of results to return (1-100).
+      #
+      #   @param country [String] Two-letter country code (ISO 3166-1 alpha-2) to bias results.
+      #
+      #   @param exclude_domains [Array<String>] Exclude results from these domains (bare hostnames, e.g. `pinterest.com`).
+      #
+      #   @param freshness [String] Time-based filter for results. Common values: `day`, `week`, `month`, `year`.
+      #
+      #   @param include_domains [Array<String>] Restrict results to these domains (bare hostnames, e.g. `arxiv.org`).
+      #
+      #   @param livecrawl [Boolean] When true, the provider crawls pages in real-time for fresh content. The boolean
+      #
+      #   @param safesearch [Symbol, Telnyx::Models::WebSearchCreateParams::Safesearch] Safe search filter level.
+      #
+      #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
+
+      # Safe search filter level.
+      module Safesearch
+        extend Telnyx::Internal::Type::Enum
+
+        OFF = :off
+        MODERATE = :moderate
+        STRICT = :strict
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/telnyx/models/web_search_create_response.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    # @see Telnyx::Resources::WebSearch#create
+    class WebSearchCreateResponse < Telnyx::Internal::Type::BaseModel
+      # @!attribute data
+      #
+      #   @return [Telnyx::Models::WebSearchCreateResponse::Data, nil]
+      optional :data, -> { Telnyx::Models::WebSearchCreateResponse::Data }
+
+      # @!method initialize(data: nil)
+      #   @param data [Telnyx::Models::WebSearchCreateResponse::Data]
+
+      # @see Telnyx::Models::WebSearchCreateResponse#data
+      class Data < Telnyx::Internal::Type::BaseModel
+        # @!attribute results
+        #
+        #   @return [Telnyx::Models::WebSearchCreateResponse::Data::Results, nil]
+        optional :results, -> { Telnyx::Models::WebSearchCreateResponse::Data::Results }
+
+        # @!method initialize(results: nil)
+        #   @param results [Telnyx::Models::WebSearchCreateResponse::Data::Results]
+
+        # @see Telnyx::Models::WebSearchCreateResponse::Data#results
+        class Results < Telnyx::Internal::Type::BaseModel
+          # @!attribute web
+          #   Web search results.
+          #
+          #   @return [Array<Telnyx::Models::WebSearchResult>]
+          required :web, -> { Telnyx::Internal::Type::ArrayOf[Telnyx::WebSearchResult] }
+
+          # @!attribute news
+          #   News search results. Present only when the query surfaces news results.
+          #
+          #   @return [Array<Telnyx::Models::WebSearchResult>, nil]
+          optional :news, -> { Telnyx::Internal::Type::ArrayOf[Telnyx::WebSearchResult] }
+
+          # @!method initialize(web:, news: nil)
+          #   @param web [Array<Telnyx::Models::WebSearchResult>] Web search results.
+          #
+          #   @param news [Array<Telnyx::Models::WebSearchResult>] News search results. Present only when the query surfaces news results.
+        end
+      end
+    end
+  end
+end

data/lib/telnyx/models/web_search_result.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    class WebSearchResult < Telnyx::Internal::Type::BaseModel
+      # @!attribute description
+      #   Short description or excerpt.
+      #
+      #   @return [String]
+      required :description, String
+
+      # @!attribute snippets
+      #   Relevant text snippets from the page.
+      #
+      #   @return [Array<String>]
+      required :snippets, Telnyx::Internal::Type::ArrayOf[String]
+
+      # @!attribute title
+      #   Result title.
+      #
+      #   @return [String]
+      required :title, String
+
+      # @!attribute url
+      #   Result URL.
+      #
+      #   @return [String]
+      required :url, String
+
+      # @!attribute favicon_url
+      #   Favicon URL (if available).
+      #
+      #   @return [String, nil]
+      optional :favicon_url, String
+
+      # @!attribute thumbnail_url
+      #   Thumbnail image URL (if available).
+      #
+      #   @return [String, nil]
+      optional :thumbnail_url, String
+
+      # @!method initialize(description:, snippets:, title:, url:, favicon_url: nil, thumbnail_url: nil)
+      #   @param description [String] Short description or excerpt.
+      #
+      #   @param snippets [Array<String>] Relevant text snippets from the page.
+      #
+      #   @param title [String] Result title.
+      #
+      #   @param url [String] Result URL.
+      #
+      #   @param favicon_url [String] Favicon URL (if available).
+      #
+      #   @param thumbnail_url [String] Thumbnail image URL (if available).
+    end
+  end
+end

data/lib/telnyx/models.rb

@@ -103,6 +103,10 @@ module Telnyx
 
   APIError = Telnyx::Models::APIError
 
+  ArtifactCompletedWebhookEvent = Telnyx::Models::ArtifactCompletedWebhookEvent
+
+  ArtifactFailedWebhookEvent = Telnyx::Models::ArtifactFailedWebhookEvent
+
   AttachmentRequest = Telnyx::Models::AttachmentRequest
 
   Attempt = Telnyx::Models::Attempt
@@ -1048,6 +1052,30 @@ 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
@@ -1587,6 +1615,8 @@ module Telnyx
 
   Record = Telnyx::Models::Record
 
+  RecordingAvailableWebhookEvent = Telnyx::Models::RecordingAvailableWebhookEvent
+
   RecordingDeleteParams = Telnyx::Models::RecordingDeleteParams
 
   RecordingListParams = Telnyx::Models::RecordingListParams
@@ -1707,6 +1737,8 @@ module Telnyx
 
   SessionAnalysisRetrieveParams = Telnyx::Models::SessionAnalysisRetrieveParams
 
+  SessionStatusChangedWebhookEvent = Telnyx::Models::SessionStatusChangedWebhookEvent
+
   SetiRetrieveBlackBoxTestResultsParams = Telnyx::Models::SetiRetrieveBlackBoxTestResultsParams
 
   Settings = Telnyx::Models::Settings
@@ -1910,6 +1942,8 @@ module Telnyx
 
   TrafficType = Telnyx::Models::TrafficType
 
+  TranscriptCompletedWebhookEvent = Telnyx::Models::TranscriptCompletedWebhookEvent
+
   Transcription = Telnyx::Models::Transcription
 
   TranscriptionWebhookEvent = Telnyx::Models::TranscriptionWebhookEvent
@@ -2105,6 +2139,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
 

data/lib/telnyx/resources/calls/actions.rb

@@ -122,7 +122,7 @@ module Telnyx
         #
         # @param webhook_url_method [Symbol, Telnyx::Models::Calls::ActionAnswerParams::WebhookURLMethod] HTTP request type used for `webhook_url`.
         #
-        # @param webhook_urls [Hash{Symbol=>String}] A map of event types to webhook URLs. When an event of the specified type occurs
+        # @param webhook_urls [Hash{Symbol=>Array<String>}] A map of event types to arrays of webhook URLs. When an event of the specified t
         #
         # @param webhook_urls_method [Symbol, Telnyx::Models::Calls::ActionAnswerParams::WebhookURLsMethod] HTTP request method to invoke `webhook_urls`.
         #
@@ -1892,7 +1892,7 @@ module Telnyx
         #
         # @param webhook_url_method [Symbol, Telnyx::Models::Calls::ActionTransferParams::WebhookURLMethod] HTTP request type used for `webhook_url`.
         #
-        # @param webhook_urls [Hash{Symbol=>String}] A map of event types to webhook URLs. When an event of the specified type occurs
+        # @param webhook_urls [Hash{Symbol=>Array<String>}] A map of event types to arrays of webhook URLs. When an event of the specified t
         #
         # @param webhook_urls_method [Symbol, Telnyx::Models::Calls::ActionTransferParams::WebhookURLsMethod] HTTP request method to invoke `webhook_urls`.
         #

data/lib/telnyx/resources/calls.rb

@@ -162,7 +162,7 @@ module Telnyx
       #
       # @param webhook_url_method [Symbol, Telnyx::Models::CallDialParams::WebhookURLMethod] HTTP request type used for `webhook_url`.
       #
-      # @param webhook_urls [Hash{Symbol=>String}] A map of event types to webhook URLs. When an event of the specified type occurs
+      # @param webhook_urls [Hash{Symbol=>Array<String>}] A map of event types to arrays of webhook URLs. When an event of the specified t
       #
       # @param webhook_urls_method [Symbol, Telnyx::Models::CallDialParams::WebhookURLsMethod] HTTP request method to invoke `webhook_urls`.
       #

data/lib/telnyx/resources/meeting_sessions/actions.rb

@@ -0,0 +1,92 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Resources
+    class MeetingSessions
+      # Send real-time speech and chat actions to an active meeting session.
+      class Actions
+        # Sends a chat message into a meeting session.
+        #
+        # @overload send_chat(id, text:, request_options: {})
+        #
+        # @param id [String] Unique identifier for the meeting session.
+        #
+        # @param text [String] Chat message text to send in the meeting.
+        #
+        # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Telnyx::Models::MeetingSessions::ActionAcceptedResponse]
+        #
+        # @see Telnyx::Models::MeetingSessions::ActionSendChatParams
+        def send_chat(id, params)
+          parsed, options = Telnyx::MeetingSessions::ActionSendChatParams.dump_request(params)
+          @client.request(
+            method: :post,
+            path: ["meeting_sessions/%1$s/actions/send_chat", id],
+            body: parsed,
+            model: Telnyx::MeetingSessions::ActionAcceptedResponse,
+            options: options
+          )
+        end
+
+        # Some parameter documentations has been truncated, see
+        # {Telnyx::Models::MeetingSessions::ActionSpeakParams} for more details.
+        #
+        # Sends audio / text-to-speech into a meeting session.
+        #
+        # @overload speak(id, text:, interrupt: nil, voice: nil, request_options: {})
+        #
+        # @param id [String] Unique identifier for the meeting session.
+        #
+        # @param text [String] Text for the bot to speak.
+        #
+        # @param interrupt [Boolean] If true, interrupt any currently playing audio to speak this text immediately.
+        #
+        # @param voice [String] Voice identifier to use for this utterance. When supplied, it overrides the sess
+        #
+        # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Telnyx::Models::MeetingSessions::ActionAcceptedResponse]
+        #
+        # @see Telnyx::Models::MeetingSessions::ActionSpeakParams
+        def speak(id, params)
+          parsed, options = Telnyx::MeetingSessions::ActionSpeakParams.dump_request(params)
+          @client.request(
+            method: :post,
+            path: ["meeting_sessions/%1$s/actions/speak", id],
+            body: parsed,
+            model: Telnyx::MeetingSessions::ActionAcceptedResponse,
+            options: options
+          )
+        end
+
+        # Stops any active text-to-speech playback in a meeting session.
+        #
+        # @overload stop_speaking(id, request_options: {})
+        #
+        # @param id [String] Unique identifier for the meeting session.
+        #
+        # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Telnyx::Models::MeetingSessions::ActionAcceptedResponse]
+        #
+        # @see Telnyx::Models::MeetingSessions::ActionStopSpeakingParams
+        def stop_speaking(id, params = {})
+          @client.request(
+            method: :post,
+            path: ["meeting_sessions/%1$s/actions/stop_speaking", id],
+            model: Telnyx::MeetingSessions::ActionAcceptedResponse,
+            options: params[:request_options]
+          )
+        end
+
+        # @api private
+        #
+        # @param client [Telnyx::Client]
+        def initialize(client:)
+          @client = client
+        end
+      end
+    end
+  end
+end

data/lib/telnyx/resources/meeting_sessions/artifacts.rb

@@ -0,0 +1,92 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Resources
+    class MeetingSessions
+      # Create and retrieve asynchronous summaries and action-item artifacts.
+      class Artifacts
+        # Requests asynchronous generation of one `summary` or `action_items` artifact.
+        # Each type requires its own request. Generation requires transcript content and
+        # configured inference and currently reads at most the first 10,000 segments, so
+        # exceptionally long transcripts may produce incomplete artifacts or fail model
+        # limits.
+        #
+        # @overload create(id, type:, request_options: {})
+        #
+        # @param id [String] Unique identifier for the meeting session.
+        #
+        # @param type [Symbol, Telnyx::Models::MeetingSessions::ArtifactCreateParams::Type] Type of artifact to generate from the session.
+        #
+        # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Telnyx::Models::MeetingSessions::MeetingSessionArtifactResponse]
+        #
+        # @see Telnyx::Models::MeetingSessions::ArtifactCreateParams
+        def create(id, params)
+          parsed, options = Telnyx::MeetingSessions::ArtifactCreateParams.dump_request(params)
+          @client.request(
+            method: :post,
+            path: ["meeting_sessions/%1$s/artifacts", id],
+            body: parsed,
+            model: Telnyx::MeetingSessions::MeetingSessionArtifactResponse,
+            options: options
+          )
+        end
+
+        # Retrieves a single meeting session artifact by ID.
+        #
+        # @overload retrieve(artifact_id, id:, request_options: {})
+        #
+        # @param artifact_id [String] Unique identifier for a meeting session artifact.
+        #
+        # @param id [String] Unique identifier for the meeting session.
+        #
+        # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Telnyx::Models::MeetingSessions::MeetingSessionArtifactResponse]
+        #
+        # @see Telnyx::Models::MeetingSessions::ArtifactRetrieveParams
+        def retrieve(artifact_id, params)
+          parsed, options = Telnyx::MeetingSessions::ArtifactRetrieveParams.dump_request(params)
+          id =
+            parsed.delete(:id) do
+              raise ArgumentError.new("missing required path argument #{_1}")
+            end
+          @client.request(
+            method: :get,
+            path: ["meeting_sessions/%1$s/artifacts/%2$s", id, artifact_id],
+            model: Telnyx::MeetingSessions::MeetingSessionArtifactResponse,
+            options: options
+          )
+        end
+
+        # Returns a list of artifacts for a meeting session.
+        #
+        # @overload list(id, request_options: {})
+        #
+        # @param id [String] Unique identifier for the meeting session.
+        #
+        # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Telnyx::Models::MeetingSessions::ArtifactListResponse]
+        #
+        # @see Telnyx::Models::MeetingSessions::ArtifactListParams
+        def list(id, params = {})
+          @client.request(
+            method: :get,
+            path: ["meeting_sessions/%1$s/artifacts", id],
+            model: Telnyx::Models::MeetingSessions::ArtifactListResponse,
+            options: params[:request_options]
+          )
+        end
+
+        # @api private
+        #
+        # @param client [Telnyx::Client]
+        def initialize(client:)
+          @client = client
+        end
+      end
+    end
+  end
+end