telnyx 5.159.0 → 5.161.0

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

data/lib/telnyx/resources/meeting_sessions.rb

@@ -0,0 +1,290 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Resources
+    class MeetingSessions
+      # Send real-time speech and chat actions to an active meeting session.
+      # @return [Telnyx::Resources::MeetingSessions::Actions]
+      attr_reader :actions
+
+      # Create and retrieve asynchronous summaries and action-item artifacts.
+      # @return [Telnyx::Resources::MeetingSessions::Artifacts]
+      attr_reader :artifacts
+
+      # Some parameter documentations has been truncated, see
+      # {Telnyx::Models::MeetingSessionCreateParams} for more details.
+      #
+      # 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.
+      #
+      # @overload create(meeting_url:, assistant: nil, avatar: nil, barge_in: nil, bot_name: nil, camera_image: nil, idempotency_key: nil, join_at: nil, metadata: nil, speak_on_enter: nil, summarize_on_end: nil, voice: nil, webhook_url: nil, request_options: {})
+      #
+      # @param meeting_url [String] The meeting URL the bot should join.
+      #
+      # @param assistant [Telnyx::Models::MeetingSessionCreateParams::Assistant] Request options for attaching a voice assistant to the session. Routing fields (
+      #
+      # @param avatar [Telnyx::Models::MeetingSessionCreateParams::Avatar] Request options for attaching a bring-your-own-key avatar to the session.
+      #
+      # @param barge_in [Boolean] When enabled, a human participant `speech_on` event interrupts and stops the cur
+      #
+      # @param bot_name [String] Display name for the bot in the meeting. Defaults to "Meeting Bot".
+      #
+      # @param camera_image [Telnyx::Models::MeetingSessionCreateParams::CameraImage::MeetingSessionCameraImageBase64Source, Telnyx::Models::MeetingSessionCreateParams::CameraImage::MeetingSessionCameraImageURLSource] Write-only static camera-tile image for this session, not a native account or pa
+      #
+      # @param idempotency_key [String] Client-supplied idempotency key to safely retry creation requests without duplic
+      #
+      # @param join_at [Time] ISO-8601 timestamp in the future at which the bot should join. If omitted, the b
+      #
+      # @param metadata [Hash{Symbol=>Object}] Arbitrary key-value metadata attached to the session. The serialized JSON repres
+      #
+      # @param speak_on_enter [String] Text the bot speaks when it enters the meeting.
+      #
+      # @param summarize_on_end [Boolean] If true, generate a summary artifact when the session ends.
+      #
+      # @param voice [String] Session-default voice identifier used for `speak_on_enter` and ordinary speak ac
+      #
+      # @param webhook_url [String] HTTPS endpoint to receive session lifecycle callbacks. Static validation require
+      #
+      # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Telnyx::Models::MeetingSessionResponse]
+      #
+      # @see Telnyx::Models::MeetingSessionCreateParams
+      def create(params)
+        parsed, options = Telnyx::MeetingSessionCreateParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: "meeting_sessions",
+          body: parsed,
+          model: Telnyx::MeetingSessionResponse,
+          options: 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.
+      #
+      # @overload retrieve(id, request_options: {})
+      #
+      # @param id [String] Unique identifier for the meeting session.
+      #
+      # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Telnyx::Models::MeetingSessionResponse]
+      #
+      # @see Telnyx::Models::MeetingSessionRetrieveParams
+      def retrieve(id, params = {})
+        @client.request(
+          method: :get,
+          path: ["meeting_sessions/%1$s", id],
+          model: Telnyx::MeetingSessionResponse,
+          options: params[: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.
+      #
+      # @overload update(id, bot_name: nil, join_at: nil, request_options: {})
+      #
+      # @param id [String] Unique identifier for the meeting session.
+      #
+      # @param bot_name [String] Updated display name for the bot.
+      #
+      # @param join_at [Time] ISO-8601 timestamp for the bot to join. May be updated to reschedule.
+      #
+      # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Telnyx::Models::MeetingSessionResponse]
+      #
+      # @see Telnyx::Models::MeetingSessionUpdateParams
+      def update(id, params = {})
+        parsed, options = Telnyx::MeetingSessionUpdateParams.dump_request(params)
+        @client.request(
+          method: :patch,
+          path: ["meeting_sessions/%1$s", id],
+          body: parsed,
+          model: Telnyx::MeetingSessionResponse,
+          options: options
+        )
+      end
+
+      # Returns a list of meeting sessions, optionally filtered by status.
+      #
+      # @overload list(status: nil, request_options: {})
+      #
+      # @param status [Symbol, Telnyx::Models::MeetingSessionListParams::Status] Filter meeting sessions by current status.
+      #
+      # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Telnyx::Models::MeetingSessionListResponse]
+      #
+      # @see Telnyx::Models::MeetingSessionListParams
+      def list(params = {})
+        parsed, options = Telnyx::MeetingSessionListParams.dump_request(params)
+        query = Telnyx::Internal::Util.encode_query_params(parsed)
+        @client.request(
+          method: :get,
+          path: "meeting_sessions",
+          query: query,
+          model: Telnyx::Models::MeetingSessionListResponse,
+          options: 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.
+      #
+      # @overload delete(id, request_options: {})
+      #
+      # @param id [String] Unique identifier for the meeting session.
+      #
+      # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Telnyx::Models::MeetingSessionResponse]
+      #
+      # @see Telnyx::Models::MeetingSessionDeleteParams
+      def delete(id, params = {})
+        @client.request(
+          method: :delete,
+          path: ["meeting_sessions/%1$s", id],
+          model: Telnyx::MeetingSessionResponse,
+          options: params[: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.
+      #
+      # @overload delete_recording_media(id, request_options: {})
+      #
+      # @param id [String] Unique identifier for the meeting session.
+      #
+      # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Telnyx::Models::MeetingSessionDeleteRecordingMediaResponse]
+      #
+      # @see Telnyx::Models::MeetingSessionDeleteRecordingMediaParams
+      def delete_recording_media(id, params = {})
+        @client.request(
+          method: :delete,
+          path: ["meeting_sessions/%1$s/recording_media", id],
+          model: Telnyx::Models::MeetingSessionDeleteRecordingMediaResponse,
+          options: params[: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.
+      #
+      # @overload retrieve_events(id, after: nil, limit: nil, request_options: {})
+      #
+      # @param id [String] Unique identifier for the meeting session.
+      #
+      # @param after [Integer] Return results with a cursor position after this value.
+      #
+      # @param limit [Integer] Maximum number of results to return per page.
+      #
+      # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Telnyx::Models::MeetingSessionRetrieveEventsResponse]
+      #
+      # @see Telnyx::Models::MeetingSessionRetrieveEventsParams
+      def retrieve_events(id, params = {})
+        parsed, options = Telnyx::MeetingSessionRetrieveEventsParams.dump_request(params)
+        query = Telnyx::Internal::Util.encode_query_params(parsed)
+        @client.request(
+          method: :get,
+          path: ["meeting_sessions/%1$s/events", id],
+          query: query,
+          model: Telnyx::Models::MeetingSessionRetrieveEventsResponse,
+          options: options
+        )
+      end
+
+      # Returns recordings for a meeting session.
+      #
+      # @overload retrieve_recordings(id, request_options: {})
+      #
+      # @param id [String] Unique identifier for the meeting session.
+      #
+      # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Telnyx::Models::MeetingSessionRetrieveRecordingsResponse]
+      #
+      # @see Telnyx::Models::MeetingSessionRetrieveRecordingsParams
+      def retrieve_recordings(id, params = {})
+        @client.request(
+          method: :get,
+          path: ["meeting_sessions/%1$s/recordings", id],
+          model: Telnyx::Models::MeetingSessionRetrieveRecordingsResponse,
+          options: params[:request_options]
+        )
+      end
+
+      # Some parameter documentations has been truncated, see
+      # {Telnyx::Models::MeetingSessionRetrieveTranscriptParams} for more details.
+      #
+      # 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.
+      #
+      # @overload retrieve_transcript(id, after: nil, limit: nil, wait_seconds: nil, request_options: {})
+      #
+      # @param id [String] Unique identifier for the meeting session.
+      #
+      # @param after [Integer] Return results with a cursor position after this value.
+      #
+      # @param limit [Integer] Maximum number of results to return per page.
+      #
+      # @param wait_seconds [Integer] Long-poll duration in seconds. The server holds the connection open for up to th
+      #
+      # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Telnyx::Models::MeetingSessionRetrieveTranscriptResponse]
+      #
+      # @see Telnyx::Models::MeetingSessionRetrieveTranscriptParams
+      def retrieve_transcript(id, params = {})
+        parsed, options = Telnyx::MeetingSessionRetrieveTranscriptParams.dump_request(params)
+        query = Telnyx::Internal::Util.encode_query_params(parsed)
+        @client.request(
+          method: :get,
+          path: ["meeting_sessions/%1$s/transcript", id],
+          query: query,
+          model: Telnyx::Models::MeetingSessionRetrieveTranscriptResponse,
+          options: options
+        )
+      end
+
+      # @api private
+      #
+      # @param client [Telnyx::Client]
+      def initialize(client:)
+        @client = client
+        @actions = Telnyx::Resources::MeetingSessions::Actions.new(client: client)
+        @artifacts = Telnyx::Resources::MeetingSessions::Artifacts.new(client: client)
+      end
+    end
+  end
+end

data/lib/telnyx/resources/messages/rcs.rb

@@ -33,7 +33,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.
         #
         # @overload send_(agent_id:, agent_message:, messaging_profile_id:, to:, mms_fallback: nil, sms_fallback: nil, type: nil, webhook_url: nil, request_options: {})
         #

data/lib/telnyx/resources/messages.rb

@@ -2,7 +2,6 @@
 
 module Telnyx
   module Resources
-    # Messages
     class Messages
       # Send RCS messages
       # @return [Telnyx::Resources::Messages::Rcs]
@@ -181,7 +180,8 @@ module Telnyx
       # Some parameter documentations has been truncated, see
       # {Telnyx::Models::MessageSendGroupMmsParams} for more details.
       #
-      # Send a group MMS message
+      # Queues an MMS addressed to multiple recipients as a group conversation. Delivery
+      # events are reported asynchronously through messaging webhooks.
       #
       # @overload send_group_mms(from:, to:, media_urls: nil, subject: nil, text: nil, use_profile_webhooks: nil, webhook_failover_url: nil, webhook_url: nil, request_options: {})
       #
@@ -220,7 +220,8 @@ module Telnyx
       # Some parameter documentations has been truncated, see
       # {Telnyx::Models::MessageSendLongCodeParams} for more details.
       #
-      # Send a long code message
+      # Queues an outbound SMS or MMS using a long-code sender. Delivery progress and
+      # final disposition are reported asynchronously through messaging webhooks.
       #
       # @overload send_long_code(from:, to:, auto_detect: nil, encoding: nil, media_urls: nil, subject: nil, text: nil, type: nil, use_profile_webhooks: nil, webhook_failover_url: nil, webhook_url: nil, request_options: {})
       #
@@ -265,7 +266,8 @@ module Telnyx
       # Some parameter documentations has been truncated, see
       # {Telnyx::Models::MessageSendNumberPoolParams} for more details.
       #
-      # Send a message using number pool
+      # Queues an outbound message using a number pool. Telnyx selects an eligible
+      # sender from the pool according to its messaging profile configuration.
       #
       # @overload send_number_pool(messaging_profile_id:, to:, auto_detect: nil, encoding: nil, media_urls: nil, subject: nil, text: nil, type: nil, use_profile_webhooks: nil, webhook_failover_url: nil, webhook_url: nil, request_options: {})
       #
@@ -310,7 +312,8 @@ module Telnyx
       # Some parameter documentations has been truncated, see
       # {Telnyx::Models::MessageSendShortCodeParams} for more details.
       #
-      # Send a short code message
+      # Queues an outbound SMS or MMS using a short-code sender. Delivery progress and
+      # final disposition are reported asynchronously through messaging webhooks.
       #
       # @overload send_short_code(from:, to:, auto_detect: nil, encoding: nil, media_urls: nil, subject: nil, text: nil, type: nil, use_profile_webhooks: nil, webhook_failover_url: nil, webhook_url: nil, request_options: {})
       #
@@ -386,6 +389,41 @@ module Telnyx
         )
       end
 
+      # Sends a WhatsApp message using a Telnyx WhatsApp-enabled number. The message
+      # body, interactive elements, media, location, and reaction content are specified
+      # in the `whatsapp_message` field. Delivery progress and final disposition are
+      # reported asynchronously through messaging webhooks.
+      #
+      # @overload whatsapp(from:, to:, whatsapp_message:, messaging_profile_id: nil, type: nil, webhook_url: nil, request_options: {})
+      #
+      # @param from [String] Phone number in +E.164 format associated with Whatsapp account
+      #
+      # @param to [String] Phone number in +E.164 format
+      #
+      # @param whatsapp_message [Telnyx::Models::WhatsappMessageContent]
+      #
+      # @param messaging_profile_id [String] Messaging profile ID - required if the 'from' number is not SMS-enabled
+      #
+      # @param type [Symbol, Telnyx::Models::MessageWhatsappParams::Type] Message type - must be set to "WHATSAPP"
+      #
+      # @param webhook_url [String] The URL where webhooks related to this message will be sent.
+      #
+      # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Telnyx::Models::MessageWhatsappResponse]
+      #
+      # @see Telnyx::Models::MessageWhatsappParams
+      def whatsapp(params)
+        parsed, options = Telnyx::MessageWhatsappParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: "messages/whatsapp",
+          body: parsed,
+          model: Telnyx::Models::MessageWhatsappResponse,
+          options: options
+        )
+      end
+
       # @api private
       #
       # @param client [Telnyx::Client]

data/lib/telnyx/resources/messaging/rcs/agents.rb

@@ -6,7 +6,7 @@ module Telnyx
       class Rcs
         # Send RCS messages
         class Agents
-          # Retrieve an RCS agent
+          # Returns the configuration and current state of the specified RCS agent.
           #
           # @overload retrieve(id, request_options: {})
           #
@@ -14,19 +14,19 @@ module Telnyx
           #
           # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
           #
-          # @return [Telnyx::Models::RcsAgentResponse]
+          # @return [Telnyx::Models::Rcs::RcsAgentResponse]
           #
           # @see Telnyx::Models::Messaging::Rcs::AgentRetrieveParams
           def retrieve(id, params = {})
             @client.request(
               method: :get,
               path: ["messaging/rcs/agents/%1$s", id],
-              model: Telnyx::RcsAgentResponse,
+              model: Telnyx::Rcs::RcsAgentResponse,
               options: params[:request_options]
             )
           end
 
-          # Modify an RCS agent
+          # Updates the supplied configuration fields on the specified RCS agent.
           #
           # @overload update(id, profile_id: nil, webhook_failover_url: nil, webhook_url: nil, request_options: {})
           #
@@ -40,7 +40,7 @@ module Telnyx
           #
           # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
           #
-          # @return [Telnyx::Models::RcsAgentResponse]
+          # @return [Telnyx::Models::Rcs::RcsAgentResponse]
           #
           # @see Telnyx::Models::Messaging::Rcs::AgentUpdateParams
           def update(id, params = {})
@@ -49,12 +49,12 @@ module Telnyx
               method: :patch,
               path: ["messaging/rcs/agents/%1$s", id],
               body: parsed,
-              model: Telnyx::RcsAgentResponse,
+              model: Telnyx::Rcs::RcsAgentResponse,
               options: options
             )
           end
 
-          # List all RCS agents
+          # Returns RCS agents available to the authenticated account.
           #
           # @overload list(page_number: nil, page_size: nil, request_options: {})
           #
@@ -62,7 +62,7 @@ module Telnyx
           # @param page_size [Integer]
           # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
           #
-          # @return [Telnyx::Internal::DefaultFlatPagination<Telnyx::Models::RcsAgent>]
+          # @return [Telnyx::Internal::DefaultFlatPagination<Telnyx::Models::Rcs::RcsAgent>]
           #
           # @see Telnyx::Models::Messaging::Rcs::AgentListParams
           def list(params = {})
@@ -73,7 +73,7 @@ module Telnyx
               path: "messaging/rcs/agents",
               query: query.transform_keys(page_number: "page[number]", page_size: "page[size]"),
               page: Telnyx::Internal::DefaultFlatPagination,
-              model: Telnyx::RcsAgent,
+              model: Telnyx::Rcs::RcsAgent,
               options: options
             )
           end

data/lib/telnyx/resources/messaging/rcs.rb

@@ -36,7 +36,7 @@ module Telnyx
           )
         end
 
-        # Check RCS capabilities (batch)
+        # Returns RCS capability information for multiple recipients in one request.
         #
         # @overload list_bulk_capabilities(agent_id:, phone_numbers:, request_options: {})
         #
@@ -60,7 +60,8 @@ module Telnyx
           )
         end
 
-        # Check RCS capabilities
+        # Returns the RCS features supported by the specified recipient for the selected
+        # agent.
         #
         # @overload retrieve_capabilities(phone_number, agent_id:, request_options: {})
         #

data/lib/telnyx/resources/messaging_10dlc/brand.rb

@@ -317,7 +317,9 @@ module Telnyx
           )
         end
 
-        # Resend brand 2FA email
+        # Requests a new two-factor authentication email for the specified 10DLC brand.
+        # Complete verification through the link delivered to the brand contact before
+        # continuing registration.
         #
         # @overload resend_2fa_email(brand_id, request_options: {})
         #

data/lib/telnyx/resources/messaging_10dlc/campaign/osr.rb

@@ -6,7 +6,9 @@ module Telnyx
       class Campaign
         # Campaign operations
         class Osr
-          # Get OSR campaign attributes
+          # Returns the optional shared-responsibility attributes recorded for the campaign.
+          # Use these values to inspect the campaign configuration submitted to the
+          # registry.
           #
           # @overload get_attributes(campaign_id, request_options: {})
           #

data/lib/telnyx/resources/messaging_10dlc/campaign/usecase.rb

@@ -6,7 +6,8 @@ module Telnyx
       class Campaign
         # Campaign operations
         class Usecase
-          # Get Campaign Cost
+          # Returns the upfront and monthly cost associated with the selected 10DLC campaign
+          # use case.
           #
           # @overload get_cost(usecase:, request_options: {})
           #

data/lib/telnyx/resources/messaging_10dlc/campaign.rb

@@ -194,7 +194,8 @@ module Telnyx
           )
         end
 
-        # Get Sharing Status
+        # Returns whether the campaign is configured for partner sharing and the current
+        # sharing state.
         #
         # @overload get_sharing_status(campaign_id, request_options: {})
         #

data/lib/telnyx/resources/messaging_10dlc/partner_campaigns.rb

@@ -120,7 +120,7 @@ module Telnyx
           )
         end
 
-        # Get Sharing Status
+        # Returns the partner-sharing state for the specified campaign.
         #
         # @overload retrieve_sharing_status(campaign_id, request_options: {})
         #

data/lib/telnyx/resources/messaging_10dlc/phone_number_campaigns.rb

@@ -5,7 +5,8 @@ module Telnyx
     class Messaging10dlc
       # Phone number campaign assignment
       class PhoneNumberCampaigns
-        # Create New Phone Number Campaign
+        # Assigns a phone number to a 10DLC campaign. The assignment controls which
+        # registered campaign is used for traffic from that number.
         #
         # @overload create(campaign_id:, phone_number:, request_options: {})
         #
@@ -49,7 +50,7 @@ module Telnyx
           )
         end
 
-        # Create New Phone Number Campaign
+        # Replaces the 10DLC campaign assignment for the specified phone number.
         #
         # @overload update(campaign_phone_number, campaign_id:, phone_number:, request_options: {})
         #
@@ -79,7 +80,8 @@ module Telnyx
         # {Telnyx::Models::Messaging10dlc::PhoneNumberCampaignListParams} for more
         # details.
         #
-        # List phone number campaigns
+        # Returns phone-number-to-campaign assignments for the authenticated account.
+        # Apply the documented filters and pagination parameters to narrow the result set.
         #
         # @overload list(filter: nil, page: nil, records_per_page: nil, sort: nil, request_options: {})
         #

data/lib/telnyx/resources/messaging_10dlc.rb

@@ -26,7 +26,8 @@ module Telnyx
       # @return [Telnyx::Resources::Messaging10dlc::PhoneNumberAssignmentByProfile]
       attr_reader :phone_number_assignment_by_profile
 
-      # Get Enum
+      # Returns the accepted values for the selected 10DLC enumeration endpoint. Use
+      # these values when constructing brand and campaign requests.
       #
       # @overload get_enum(endpoint, request_options: {})
       #