telnyx 5.159.0 → 5.161.0

data/rbi/telnyx/resources/external_connections.rbi

@@ -155,7 +155,8 @@ module Telnyx
       )
       end
 
-      # Update a location's static emergency address
+      # Update the static emergency address assigned to a specific location of an
+      # external connection.
       sig do
         params(
           location_id: String,

data/rbi/telnyx/resources/faxes.rbi

@@ -101,7 +101,7 @@ module Telnyx
       )
       end
 
-      # View a fax
+      # Retrieve the details of a single fax.
       sig do
         params(
           id: String,
@@ -115,7 +115,7 @@ module Telnyx
       )
       end
 
-      # View a list of faxes
+      # Retrieve a paginated list of faxes sent or received on your account.
       sig do
         params(
           filter: Telnyx::FaxListParams::Filter::OrHash,
@@ -135,7 +135,7 @@ module Telnyx
       )
       end
 
-      # Delete a fax
+      # Delete a fax resource from your account.
       sig do
         params(id: String, request_options: Telnyx::RequestOptions::OrHash).void
       end

data/rbi/telnyx/resources/fqdn_connections/fqdn_authentication.rbi

@@ -0,0 +1,77 @@
+# typed: strong
+
+module Telnyx
+  module Resources
+    class FqdnConnections
+      # FQDN connection operations
+      class FqdnAuthentication
+        # Retrieves the details of an existing FQDN authentication strategy for a specific
+        # FQDN connection.
+        sig do
+          params(
+            fqdn_connection_id: String,
+            request_options: Telnyx::RequestOptions::OrHash
+          ).returns(
+            Telnyx::Models::FqdnConnections::FqdnAuthenticationListResponse
+          )
+        end
+        def list(
+          # The ID of the FQDN connection.
+          fqdn_connection_id,
+          request_options: {}
+        )
+        end
+
+        # Updates the FQDN authentication strategy for a specific FQDN connection.
+        sig do
+          params(
+            fqdn_connection_id: String,
+            failover_url: String,
+            fqdn_outbound_authentication:
+              Telnyx::FqdnConnections::FqdnAuthenticationPatchAllParams::FqdnOutboundAuthentication::OrSymbol,
+            ip_authentication_method:
+              Telnyx::FqdnConnections::FqdnAuthenticationPatchAllParams::IPAuthenticationMethod::OrSymbol,
+            password: String,
+            txt_name: String,
+            txt_ttl: Integer,
+            txt_value: String,
+            user_name: String,
+            webhook_url: String,
+            request_options: Telnyx::RequestOptions::OrHash
+          ).returns(
+            Telnyx::Models::FqdnConnections::FqdnAuthenticationPatchAllResponse
+          )
+        end
+        def patch_all(
+          # The ID of the FQDN connection.
+          fqdn_connection_id,
+          # The failover webhook URL.
+          failover_url: nil,
+          # The outbound authentication type.
+          fqdn_outbound_authentication: nil,
+          # The IP authentication method.
+          ip_authentication_method: nil,
+          # The password for authentication.
+          password: nil,
+          # The TXT record name for Microsoft Teams SBC DNS verification.
+          txt_name: nil,
+          # The TTL for the TXT record.
+          txt_ttl: nil,
+          # The TXT record value for Microsoft Teams SBC DNS verification.
+          txt_value: nil,
+          # The username for authentication.
+          user_name: nil,
+          # The webhook URL for authentication events.
+          webhook_url: nil,
+          request_options: {}
+        )
+        end
+
+        # @api private
+        sig { params(client: Telnyx::Client).returns(T.attached_class) }
+        def self.new(client:)
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/resources/fqdn_connections.rbi

@@ -4,6 +4,10 @@ module Telnyx
   module Resources
     # FQDN connection operations
     class FqdnConnections
+      # FQDN connection operations
+      sig { returns(Telnyx::Resources::FqdnConnections::FqdnAuthentication) }
+      attr_reader :fqdn_authentication
+
       # Creates a FQDN connection.
       sig do
         params(
@@ -131,6 +135,7 @@ module Telnyx
           android_push_credential_id: T.nilable(String),
           call_cost_in_webhooks: T::Boolean,
           connection_name: String,
+          conversation_persistence: T::Boolean,
           default_on_hold_comfort_noise_enabled: T::Boolean,
           dtmf_type: Telnyx::DtmfType::OrSymbol,
           encode_contact_header_enabled: T::Boolean,
@@ -168,6 +173,10 @@ module Telnyx
         call_cost_in_webhooks: nil,
         # A user-assigned name to help manage the connection.
         connection_name: nil,
+        # Whether conversation persistence is enabled for this connection. When enabled,
+        # calls handled by the connection are transcribed, stored, and indexed. Defaults
+        # to false.
+        conversation_persistence: nil,
         # When enabled, Telnyx will generate comfort noise when you place the call on
         # hold. If disabled, you will need to generate comfort noise or on hold music to
         # avoid RTP timeout.

data/rbi/telnyx/resources/global_ip_assignment_health.rbi

@@ -4,7 +4,7 @@ module Telnyx
   module Resources
     # Global IPs
     class GlobalIPAssignmentHealth
-      # Global IP Assignment Health Check Metrics
+      # Retrieve health check metrics for your Global IP assignments.
       sig do
         params(
           filter:

data/rbi/telnyx/resources/global_ip_assignments_usage.rbi

@@ -4,7 +4,7 @@ module Telnyx
   module Resources
     # Global IPs
     class GlobalIPAssignmentsUsage
-      # Global IP Assignment Usage Metrics
+      # Retrieve usage metrics for your Global IP assignments.
       sig do
         params(
           filter:

data/rbi/telnyx/resources/global_ip_latency.rbi

@@ -4,7 +4,7 @@ module Telnyx
   module Resources
     # Global IPs
     class GlobalIPLatency
-      # Global IP Latency Metrics
+      # Retrieve latency metrics measured for your Global IPs.
       sig do
         params(
           filter: Telnyx::GlobalIPLatencyRetrieveParams::Filter::OrHash,

data/rbi/telnyx/resources/global_ip_usage.rbi

@@ -4,7 +4,7 @@ module Telnyx
   module Resources
     # Global IPs
     class GlobalIPUsage
-      # Global IP Usage Metrics
+      # Retrieve usage metrics for your Global IPs.
       sig do
         params(
           filter: Telnyx::GlobalIPUsageRetrieveParams::Filter::OrHash,

data/rbi/telnyx/resources/ip_connections.rbi

@@ -128,6 +128,7 @@ module Telnyx
           android_push_credential_id: T.nilable(String),
           call_cost_in_webhooks: T::Boolean,
           connection_name: String,
+          conversation_persistence: T::Boolean,
           default_on_hold_comfort_noise_enabled: T::Boolean,
           dtmf_type: Telnyx::DtmfType::OrSymbol,
           encode_contact_header_enabled: T::Boolean,
@@ -166,6 +167,10 @@ module Telnyx
         # Specifies if call cost webhooks should be sent for this connection.
         call_cost_in_webhooks: nil,
         connection_name: nil,
+        # Whether conversation persistence is enabled for this connection. When enabled,
+        # calls handled by the connection are transcribed, stored, and indexed. Defaults
+        # to false.
+        conversation_persistence: nil,
         # When enabled, Telnyx will generate comfort noise when you place the call on
         # hold. If disabled, you will need to generate comfort noise or on hold music to
         # avoid RTP timeout.

data/rbi/telnyx/resources/ledger_billing_group_reports.rbi

@@ -4,7 +4,8 @@ module Telnyx
   module Resources
     # Ledger billing reports
     class LedgerBillingGroupReports
-      # Create a ledger billing group report
+      # Create a ledger billing group report, which aggregates ledger activity by
+      # billing group.
       sig do
         params(
           month: Integer,
@@ -21,7 +22,8 @@ module Telnyx
       )
       end
 
-      # Get a ledger billing group report
+      # Retrieve the details and status of a previously created ledger billing group
+      # report.
       sig do
         params(
           id: String,

data/rbi/telnyx/resources/meeting_sessions/actions.rbi

@@ -0,0 +1,71 @@
+# typed: strong
+
+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.
+        sig do
+          params(
+            id: String,
+            text: String,
+            request_options: Telnyx::RequestOptions::OrHash
+          ).returns(Telnyx::MeetingSessions::ActionAcceptedResponse)
+        end
+        def send_chat(
+          # Unique identifier for the meeting session.
+          id,
+          # Chat message text to send in the meeting.
+          text:,
+          request_options: {}
+        )
+        end
+
+        # Sends audio / text-to-speech into a meeting session.
+        sig do
+          params(
+            id: String,
+            text: String,
+            interrupt: T::Boolean,
+            voice: String,
+            request_options: Telnyx::RequestOptions::OrHash
+          ).returns(Telnyx::MeetingSessions::ActionAcceptedResponse)
+        end
+        def speak(
+          # Unique identifier for the meeting session.
+          id,
+          # Text for the bot to speak.
+          text:,
+          # If true, interrupt any currently playing audio to speak this text immediately.
+          interrupt: nil,
+          # Voice identifier to use for this utterance. When supplied, it overrides the
+          # session-default voice configured at creation; otherwise the speak action uses
+          # that session default.
+          voice: nil,
+          request_options: {}
+        )
+        end
+
+        # Stops any active text-to-speech playback in a meeting session.
+        sig do
+          params(
+            id: String,
+            request_options: Telnyx::RequestOptions::OrHash
+          ).returns(Telnyx::MeetingSessions::ActionAcceptedResponse)
+        end
+        def stop_speaking(
+          # Unique identifier for the meeting session.
+          id,
+          request_options: {}
+        )
+        end
+
+        # @api private
+        sig { params(client: Telnyx::Client).returns(T.attached_class) }
+        def self.new(client:)
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/resources/meeting_sessions/artifacts.rbi

@@ -0,0 +1,67 @@
+# typed: strong
+
+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.
+        sig do
+          params(
+            id: String,
+            type: Telnyx::MeetingSessions::ArtifactCreateParams::Type::OrSymbol,
+            request_options: Telnyx::RequestOptions::OrHash
+          ).returns(Telnyx::MeetingSessions::MeetingSessionArtifactResponse)
+        end
+        def create(
+          # Unique identifier for the meeting session.
+          id,
+          # Type of artifact to generate from the session.
+          type:,
+          request_options: {}
+        )
+        end
+
+        # Retrieves a single meeting session artifact by ID.
+        sig do
+          params(
+            artifact_id: String,
+            id: String,
+            request_options: Telnyx::RequestOptions::OrHash
+          ).returns(Telnyx::MeetingSessions::MeetingSessionArtifactResponse)
+        end
+        def retrieve(
+          # Unique identifier for a meeting session artifact.
+          artifact_id,
+          # Unique identifier for the meeting session.
+          id:,
+          request_options: {}
+        )
+        end
+
+        # Returns a list of artifacts for a meeting session.
+        sig do
+          params(
+            id: String,
+            request_options: Telnyx::RequestOptions::OrHash
+          ).returns(Telnyx::Models::MeetingSessions::ArtifactListResponse)
+        end
+        def list(
+          # Unique identifier for the meeting session.
+          id,
+          request_options: {}
+        )
+        end
+
+        # @api private
+        sig { params(client: Telnyx::Client).returns(T.attached_class) }
+        def self.new(client:)
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/resources/meeting_sessions.rbi

@@ -0,0 +1,256 @@
+# typed: strong
+
+module Telnyx
+  module Resources
+    class MeetingSessions
+      # Send real-time speech and chat actions to an active meeting session.
+      sig { returns(Telnyx::Resources::MeetingSessions::Actions) }
+      attr_reader :actions
+
+      # Create and retrieve asynchronous summaries and action-item artifacts.
+      sig { returns(Telnyx::Resources::MeetingSessions::Artifacts) }
+      attr_reader :artifacts
+
+      # Creates a new meeting session. When an idempotency_key is supplied in the
+      # request body, replay lookup is scoped to the authenticated account and compares
+      # only the key; the request payload is not fingerprinted or compared. If a session
+      # with that key already exists for the account, the existing session is replayed
+      # (200); otherwise a new session is created (201). Supports bring-your-own-key
+      # (BYOK) configuration. The session may enter asynchronous states (e.g. joining,
+      # waiting_for_admission) before becoming active. Optional `camera_image` input is
+      # write-only and applies only when no Avatar or Assistant webpage output takes
+      # precedence. An ignored URL is not fetched. An effective URL source is resolved
+      # before bot creation; neither the source URL nor image bytes are persisted,
+      # returned, or logged. Treat signed URLs as credentials.
+      sig do
+        params(
+          meeting_url: String,
+          assistant: Telnyx::MeetingSessionCreateParams::Assistant::OrHash,
+          avatar: Telnyx::MeetingSessionCreateParams::Avatar::OrHash,
+          barge_in: T::Boolean,
+          bot_name: String,
+          camera_image:
+            T.any(
+              Telnyx::MeetingSessionCreateParams::CameraImage::MeetingSessionCameraImageBase64Source::OrHash,
+              Telnyx::MeetingSessionCreateParams::CameraImage::MeetingSessionCameraImageURLSource::OrHash
+            ),
+          idempotency_key: String,
+          join_at: Time,
+          metadata: T::Hash[Symbol, T.anything],
+          speak_on_enter: String,
+          summarize_on_end: T::Boolean,
+          voice: String,
+          webhook_url: String,
+          request_options: Telnyx::RequestOptions::OrHash
+        ).returns(Telnyx::MeetingSessionResponse)
+      end
+      def create(
+        # The meeting URL the bot should join.
+        meeting_url:,
+        # Request options for attaching a voice assistant to the session. Routing fields
+        # (`call_control_connection_id`, `from`, and `loopback_sip_uri`) are used only to
+        # establish the assistant call leg and are omitted from response objects.
+        # `audio_gate` is returned with `id` in the assistant response object.
+        assistant: nil,
+        # Request options for attaching a bring-your-own-key avatar to the session.
+        avatar: nil,
+        # When enabled, a human participant `speech_on` event interrupts and stops the
+        # current bot audio; it does not bypass admission or initiate speech. Assistant
+        # sessions reject `barge_in: true`.
+        barge_in: nil,
+        # Display name for the bot in the meeting. Defaults to "Meeting Bot".
+        bot_name: nil,
+        # Write-only static camera-tile image for this session, not a native account or
+        # participant profile photo. Supply exactly one JPEG source. When effective, the
+        # image is used as the bot's static camera/video output; presentation varies by
+        # meeting platform and recording configuration and is not guaranteed in
+        # recordings. An effective Avatar or Assistant webpage output takes precedence, so
+        # this input is ignored and a URL source is not fetched.
+        camera_image: nil,
+        # Client-supplied idempotency key to safely retry creation requests without
+        # duplicating sessions. Lookup is scoped to the authenticated account and compares
+        # the key only; the request payload is not fingerprinted or compared.
+        idempotency_key: nil,
+        # ISO-8601 timestamp in the future at which the bot should join. If omitted, the
+        # bot joins immediately.
+        join_at: nil,
+        # Arbitrary key-value metadata attached to the session. The serialized JSON
+        # representation must not exceed 16384 characters at runtime.
+        metadata: nil,
+        # Text the bot speaks when it enters the meeting.
+        speak_on_enter: nil,
+        # If true, generate a summary artifact when the session ends.
+        summarize_on_end: nil,
+        # Session-default voice identifier used for `speak_on_enter` and ordinary speak
+        # actions. A voice supplied on an individual speak action overrides this default
+        # for that utterance.
+        voice: nil,
+        # HTTPS endpoint to receive session lifecycle callbacks. Static validation
+        # requires HTTPS, rejects embedded credentials and blocked hosts, and enforces
+        # egress policy. Validation makes no network request to the endpoint.
+        webhook_url: nil,
+        request_options: {}
+      )
+      end
+
+      # Retrieves a single meeting session by ID. A session that does not exist or that
+      # belongs to a different account both return 404.
+      sig do
+        params(
+          id: String,
+          request_options: Telnyx::RequestOptions::OrHash
+        ).returns(Telnyx::MeetingSessionResponse)
+      end
+      def retrieve(
+        # Unique identifier for the meeting session.
+        id,
+        request_options: {}
+      )
+      end
+
+      # Updates mutable properties of a meeting session. Only sessions in the scheduled
+      # state can be updated; any other state returns 409 with the invalid_state error
+      # code. All request fields are optional, and an empty object is a valid no-op
+      # update.
+      sig do
+        params(
+          id: String,
+          bot_name: String,
+          join_at: Time,
+          request_options: Telnyx::RequestOptions::OrHash
+        ).returns(Telnyx::MeetingSessionResponse)
+      end
+      def update(
+        # Unique identifier for the meeting session.
+        id,
+        # Updated display name for the bot.
+        bot_name: nil,
+        # ISO-8601 timestamp for the bot to join. May be updated to reschedule.
+        join_at: nil,
+        request_options: {}
+      )
+      end
+
+      # Returns a list of meeting sessions, optionally filtered by status.
+      sig do
+        params(
+          status: Telnyx::MeetingSessionListParams::Status::OrSymbol,
+          request_options: Telnyx::RequestOptions::OrHash
+        ).returns(Telnyx::Models::MeetingSessionListResponse)
+      end
+      def list(
+        # Filter meeting sessions by current status.
+        status: nil,
+        request_options: {}
+      )
+      end
+
+      # Stops a meeting session without deleting its persisted record. Scheduled bots
+      # are cancelled, while bots that are joining or active are asked to leave. The
+      # persisted meeting session record remains available.
+      sig do
+        params(
+          id: String,
+          request_options: Telnyx::RequestOptions::OrHash
+        ).returns(Telnyx::MeetingSessionResponse)
+      end
+      def delete(
+        # Unique identifier for the meeting session.
+        id,
+        request_options: {}
+      )
+      end
+
+      # **Not yet available in production** — this route is not currently routed on
+      # api.telnyx.com and returns a generic 404; it is documented ahead of rollout.
+      # Irreversibly requests deletion of provider-hosted aggregate recording media
+      # under the provider contract. The operation retains the Telnyx-local Meeting
+      # session, transcript segments, events, artifacts, and usage records. It is
+      # separate from `DELETE /meeting_sessions/{id}`, which stops or cancels
+      # participation without deleting the persisted session. A missing/foreign session
+      # returns 404; provider deletion failures return 502.
+      sig do
+        params(
+          id: String,
+          request_options: Telnyx::RequestOptions::OrHash
+        ).returns(Telnyx::Models::MeetingSessionDeleteRecordingMediaResponse)
+      end
+      def delete_recording_media(
+        # Unique identifier for the meeting session.
+        id,
+        request_options: {}
+      )
+      end
+
+      # Returns stored events ordered by ascending `seq`. To continue, pass the last
+      # returned item's `seq` as `after`. An empty page means no later stored events
+      # existed at read time; this operation returns no separate next-page cursor.
+      # Default `limit` is 100 and maximum is 1,000.
+      sig do
+        params(
+          id: String,
+          after: Integer,
+          limit: Integer,
+          request_options: Telnyx::RequestOptions::OrHash
+        ).returns(Telnyx::Models::MeetingSessionRetrieveEventsResponse)
+      end
+      def retrieve_events(
+        # Unique identifier for the meeting session.
+        id,
+        # Return results with a cursor position after this value.
+        after: nil,
+        # Maximum number of results to return per page.
+        limit: nil,
+        request_options: {}
+      )
+      end
+
+      # Returns recordings for a meeting session.
+      sig do
+        params(
+          id: String,
+          request_options: Telnyx::RequestOptions::OrHash
+        ).returns(Telnyx::Models::MeetingSessionRetrieveRecordingsResponse)
+      end
+      def retrieve_recordings(
+        # Unique identifier for the meeting session.
+        id,
+        request_options: {}
+      )
+      end
+
+      # Returns transcript segments ordered by ascending `seq`. Default `limit` is 100
+      # and maximum is 1,000. Continue with `after=meta.next_after`. A long-poll timeout
+      # returns 200 with empty `data` and `meta.next_after: null`; retain the cursor
+      # supplied to that request because null is not a replacement cursor.
+      sig do
+        params(
+          id: String,
+          after: Integer,
+          limit: Integer,
+          wait_seconds: Integer,
+          request_options: Telnyx::RequestOptions::OrHash
+        ).returns(Telnyx::Models::MeetingSessionRetrieveTranscriptResponse)
+      end
+      def retrieve_transcript(
+        # Unique identifier for the meeting session.
+        id,
+        # Return results with a cursor position after this value.
+        after: nil,
+        # Maximum number of results to return per page.
+        limit: nil,
+        # Long-poll duration in seconds. The server holds the connection open for up to
+        # this many seconds, waiting for new or updated results before returning an empty
+        # response. Set to 0 for an immediate response.
+        wait_seconds: nil,
+        request_options: {}
+      )
+      end
+
+      # @api private
+      sig { params(client: Telnyx::Client).returns(T.attached_class) }
+      def self.new(client:)
+      end
+    end
+  end
+end

data/rbi/telnyx/resources/messages/rcs.rbi

@@ -26,7 +26,8 @@ module Telnyx
         )
         end
 
-        # Send an RCS message
+        # Queues an outbound RCS message through the selected RCS agent. Check recipient
+        # capabilities before sending features that require RCS support.
         sig do
           params(
             agent_id: String,