telnyx 5.171.0 → 5.173.0

data/rbi/telnyx/models/messages/rc_send_params.rbi

@@ -68,6 +68,12 @@ module Telnyx
         sig { params(webhook_url: String).void }
         attr_writer :webhook_url
 
+        sig { returns(T.nilable(String)) }
+        attr_reader :idempotency_key
+
+        sig { params(idempotency_key: String).void }
+        attr_writer :idempotency_key
+
         sig do
           params(
             agent_id: String,
@@ -78,6 +84,7 @@ module Telnyx
             sms_fallback: Telnyx::Messages::RcSendParams::SMSFallback::OrHash,
             type: Telnyx::Messages::RcSendParams::Type::OrSymbol,
             webhook_url: String,
+            idempotency_key: String,
             request_options: Telnyx::RequestOptions::OrHash
           ).returns(T.attached_class)
         end
@@ -95,6 +102,7 @@ module Telnyx
           type: nil,
           # The URL where webhooks related to this message will be sent.
           webhook_url: nil,
+          idempotency_key: nil,
           request_options: {}
         )
         end
@@ -110,6 +118,7 @@ module Telnyx
               sms_fallback: Telnyx::Messages::RcSendParams::SMSFallback,
               type: Telnyx::Messages::RcSendParams::Type::OrSymbol,
               webhook_url: String,
+              idempotency_key: String,
               request_options: Telnyx::RequestOptions
             }
           )

data/rbi/telnyx/models/messaging_inbound_message_payload.rbi

@@ -459,13 +459,23 @@ module Telnyx
         sig { params(foreign_id: String).void }
         attr_writer :foreign_id
 
-        # WhatsApp sender in E.164 format.
+        # WhatsApp sender in E.164 format. Empty when the user hides their phone number;
+        # `from_user_id` then identifies the sender.
         sig { returns(T.nilable(String)) }
         attr_reader :from
 
         sig { params(from: String).void }
         attr_writer :from
 
+        # Business-scoped user ID (BSUID) of the WhatsApp sender when Meta provides one,
+        # for example `US.13491208655302741918`. When `from` is empty, pass this value as
+        # `to` to reply.
+        sig { returns(T.nilable(String)) }
+        attr_reader :from_user_id
+
+        sig { params(from_user_id: String).void }
+        attr_writer :from_user_id
+
         # Location shared in an RCS message.
         sig do
           returns(
@@ -576,6 +586,7 @@ module Telnyx
             edit: Telnyx::MessagingInboundMessagePayload::Body::Edit::OrHash,
             foreign_id: String,
             from: String,
+            from_user_id: String,
             location:
               Telnyx::MessagingInboundMessagePayload::Body::Location::OrHash,
             revoke:
@@ -600,8 +611,13 @@ module Telnyx
           edit: nil,
           # Meta WhatsApp message identifier for this webhook event.
           foreign_id: nil,
-          # WhatsApp sender in E.164 format.
+          # WhatsApp sender in E.164 format. Empty when the user hides their phone number;
+          # `from_user_id` then identifies the sender.
           from: nil,
+          # Business-scoped user ID (BSUID) of the WhatsApp sender when Meta provides one,
+          # for example `US.13491208655302741918`. When `from` is empty, pass this value as
+          # `to` to reply.
+          from_user_id: nil,
           # Location shared in an RCS message.
           location: nil,
           # Details for a revoked WhatsApp message.
@@ -627,6 +643,7 @@ module Telnyx
               edit: Telnyx::MessagingInboundMessagePayload::Body::Edit,
               foreign_id: String,
               from: String,
+              from_user_id: String,
               location: Telnyx::MessagingInboundMessagePayload::Body::Location,
               revoke: Telnyx::MessagingInboundMessagePayload::Body::Revoke,
               suggestion_response:

data/rbi/telnyx/models/messaging_messaging_profile.rbi

@@ -56,6 +56,13 @@ module Telnyx
       sig { returns(T.nilable(String)) }
       attr_accessor :health_webhook_url
 
+      # MM7 settings for inbound messages
+      sig { returns(T.nilable(Telnyx::Mm7Metadata)) }
+      attr_reader :mm7_metadata
+
+      sig { params(mm7_metadata: T.nilable(Telnyx::Mm7Metadata::OrHash)).void }
+      attr_writer :mm7_metadata
+
       # enables SMS fallback for MMS messages.
       sig { returns(T.nilable(T::Boolean)) }
       attr_reader :mms_fall_back_to_sms
@@ -249,6 +256,7 @@ module Telnyx
           enabled: T::Boolean,
           features: T.nilable(Telnyx::MessagingProfileFeatures::OrHash),
           health_webhook_url: T.nilable(String),
+          mm7_metadata: T.nilable(Telnyx::Mm7Metadata::OrHash),
           mms_fall_back_to_sms: T::Boolean,
           mms_transcoding: T::Boolean,
           mobile_only: T::Boolean,
@@ -294,6 +302,8 @@ module Telnyx
         features: nil,
         # DEPRECATED: health check url service checking
         health_webhook_url: nil,
+        # MM7 settings for inbound messages
+        mm7_metadata: nil,
         # enables SMS fallback for MMS messages.
         mms_fall_back_to_sms: nil,
         # enables automated resizing of MMS media.
@@ -368,6 +378,7 @@ module Telnyx
             enabled: T::Boolean,
             features: T.nilable(Telnyx::MessagingProfileFeatures),
             health_webhook_url: T.nilable(String),
+            mm7_metadata: T.nilable(Telnyx::Mm7Metadata),
             mms_fall_back_to_sms: T::Boolean,
             mms_transcoding: T::Boolean,
             mobile_only: T::Boolean,

data/rbi/telnyx/models/messaging_outbound_message_payload.rbi

@@ -18,7 +18,8 @@ module Telnyx
       sig { params(id: String).void }
       attr_writer :id
 
-      # RCS webhook message body. Text messages use the text property.
+      # Message body for RCS and WhatsApp. RCS text messages use the text property.
+      # WhatsApp messages contain the `whatsapp_message` object from the send request.
       sig { returns(T.nilable(Telnyx::MessagingOutboundMessagePayload::Body)) }
       attr_reader :body
 
@@ -225,6 +226,21 @@ module Telnyx
       sig { returns(T.nilable(String)) }
       attr_accessor :tcr_campaign_registered
 
+      # Telnyx ID of the WhatsApp template used by the message, when known.
+      sig { returns(T.nilable(String)) }
+      attr_reader :template_id
+
+      sig { params(template_id: String).void }
+      attr_writer :template_id
+
+      # Name of the WhatsApp template used by the message. Present for WhatsApp template
+      # messages.
+      sig { returns(T.nilable(String)) }
+      attr_reader :template_name
+
+      sig { params(template_name: String).void }
+      attr_writer :template_name
+
       # Message body (i.e., content) as a non-empty string.
       #
       # **Required for SMS**
@@ -317,6 +333,8 @@ module Telnyx
           tcr_campaign_billable: T::Boolean,
           tcr_campaign_id: T.nilable(String),
           tcr_campaign_registered: T.nilable(String),
+          template_id: String,
+          template_name: String,
           text: String,
           to: T::Array[Telnyx::MessagingOutboundMessagePayload::To::OrHash],
           type: Telnyx::MessagingOutboundMessagePayload::Type::OrSymbol,
@@ -329,7 +347,8 @@ module Telnyx
       def self.new(
         # Identifies the type of resource.
         id: nil,
-        # RCS webhook message body. Text messages use the text property.
+        # Message body for RCS and WhatsApp. RCS text messages use the text property.
+        # WhatsApp messages contain the `whatsapp_message` object from the send request.
         body: nil,
         cc: nil,
         # ISO 8601 formatted date indicating when the message was finalized.
@@ -376,6 +395,11 @@ module Telnyx
         tcr_campaign_id: nil,
         # The registration status of the TCR campaign.
         tcr_campaign_registered: nil,
+        # Telnyx ID of the WhatsApp template used by the message, when known.
+        template_id: nil,
+        # Name of the WhatsApp template used by the message. Present for WhatsApp template
+        # messages.
+        template_name: nil,
         # Message body (i.e., content) as a non-empty string.
         #
         # **Required for SMS**
@@ -429,6 +453,8 @@ module Telnyx
             tcr_campaign_billable: T::Boolean,
             tcr_campaign_id: T.nilable(String),
             tcr_campaign_registered: T.nilable(String),
+            template_id: String,
+            template_name: String,
             text: String,
             to: T::Array[Telnyx::MessagingOutboundMessagePayload::To],
             type: Telnyx::MessagingOutboundMessagePayload::Type::OrSymbol,
@@ -458,7 +484,8 @@ module Telnyx
         sig { params(text: String).void }
         attr_writer :text
 
-        # RCS webhook message body. Text messages use the text property.
+        # Message body for RCS and WhatsApp. RCS text messages use the text property.
+        # WhatsApp messages contain the `whatsapp_message` object from the send request.
         sig { params(text: String).returns(T.attached_class) }
         def self.new(
           # RCS text message.
@@ -1375,6 +1402,11 @@ module Telnyx
             :RCS,
             Telnyx::MessagingOutboundMessagePayload::Type::TaggedSymbol
           )
+        WHATSAPP =
+          T.let(
+            :WHATSAPP,
+            Telnyx::MessagingOutboundMessagePayload::Type::TaggedSymbol
+          )
 
         sig do
           override.returns(

data/rbi/telnyx/models/messaging_profile_create_params.rbi

@@ -69,6 +69,13 @@ module Telnyx
       sig { returns(T.nilable(String)) }
       attr_accessor :health_webhook_url
 
+      # MM7 settings for inbound messages
+      sig { returns(T.nilable(Telnyx::Mm7Metadata)) }
+      attr_reader :mm7_metadata
+
+      sig { params(mm7_metadata: T.nilable(Telnyx::Mm7Metadata::OrHash)).void }
+      attr_writer :mm7_metadata
+
       # enables SMS fallback for MMS messages.
       sig { returns(T.nilable(T::Boolean)) }
       attr_reader :mms_fall_back_to_sms
@@ -175,6 +182,7 @@ module Telnyx
           enabled: T::Boolean,
           features: T.nilable(Telnyx::MessagingProfileFeatures::OrHash),
           health_webhook_url: T.nilable(String),
+          mm7_metadata: T.nilable(Telnyx::Mm7Metadata::OrHash),
           mms_fall_back_to_sms: T::Boolean,
           mms_transcoding: T::Boolean,
           mobile_only: T::Boolean,
@@ -215,6 +223,8 @@ module Telnyx
         features: nil,
         # A URL to receive health check webhooks for numbers in this profile.
         health_webhook_url: nil,
+        # MM7 settings for inbound messages
+        mm7_metadata: nil,
         # enables SMS fallback for MMS messages.
         mms_fall_back_to_sms: nil,
         # enables automated resizing of MMS media.
@@ -265,6 +275,7 @@ module Telnyx
             enabled: T::Boolean,
             features: T.nilable(Telnyx::MessagingProfileFeatures),
             health_webhook_url: T.nilable(String),
+            mm7_metadata: T.nilable(Telnyx::Mm7Metadata),
             mms_fall_back_to_sms: T::Boolean,
             mms_transcoding: T::Boolean,
             mobile_only: T::Boolean,

data/rbi/telnyx/models/messaging_profile_update_params.rbi

@@ -58,6 +58,13 @@ module Telnyx
       end
       attr_writer :features
 
+      # MM7 settings for inbound messages
+      sig { returns(T.nilable(Telnyx::Mm7Metadata)) }
+      attr_reader :mm7_metadata
+
+      sig { params(mm7_metadata: T.nilable(Telnyx::Mm7Metadata::OrHash)).void }
+      attr_writer :mm7_metadata
+
       # enables SMS fallback for MMS messages.
       sig { returns(T.nilable(T::Boolean)) }
       attr_reader :mms_fall_back_to_sms
@@ -202,6 +209,7 @@ module Telnyx
           daily_spend_limit_enabled: T::Boolean,
           enabled: T::Boolean,
           features: T.nilable(Telnyx::MessagingProfileFeatures::OrHash),
+          mm7_metadata: T.nilable(Telnyx::Mm7Metadata::OrHash),
           mms_fall_back_to_sms: T::Boolean,
           mms_transcoding: T::Boolean,
           mobile_only: T::Boolean,
@@ -239,6 +247,8 @@ module Telnyx
         # profile. Keys map to individual feature flags; unknown keys are accepted and
         # preserved for forward compatibility with rolling deployments.
         features: nil,
+        # MM7 settings for inbound messages
+        mm7_metadata: nil,
         # enables SMS fallback for MMS messages.
         mms_fall_back_to_sms: nil,
         # enables automated resizing of MMS media.
@@ -304,6 +314,7 @@ module Telnyx
             daily_spend_limit_enabled: T::Boolean,
             enabled: T::Boolean,
             features: T.nilable(Telnyx::MessagingProfileFeatures),
+            mm7_metadata: T.nilable(Telnyx::Mm7Metadata),
             mms_fall_back_to_sms: T::Boolean,
             mms_transcoding: T::Boolean,
             mobile_only: T::Boolean,

data/rbi/telnyx/models/mm7_metadata.rbi

@@ -0,0 +1,47 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    class Mm7Metadata < Telnyx::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias { T.any(Telnyx::Mm7Metadata, Telnyx::Internal::AnyHash) }
+
+      # Failover webhook URL to receive inbound MM7 traffic
+      sig { returns(T.nilable(String)) }
+      attr_reader :mm7_failover_webhook_url
+
+      sig { params(mm7_failover_webhook_url: String).void }
+      attr_writer :mm7_failover_webhook_url
+
+      # Webhook URL to receive inbound MM7 traffic
+      sig { returns(T.nilable(String)) }
+      attr_reader :mm7_webhook_url
+
+      sig { params(mm7_webhook_url: String).void }
+      attr_writer :mm7_webhook_url
+
+      # MM7 settings for inbound messages
+      sig do
+        params(
+          mm7_failover_webhook_url: String,
+          mm7_webhook_url: String
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Failover webhook URL to receive inbound MM7 traffic
+        mm7_failover_webhook_url: nil,
+        # Webhook URL to receive inbound MM7 traffic
+        mm7_webhook_url: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          { mm7_failover_webhook_url: String, mm7_webhook_url: String }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/telnyx/models/netapps_cursor_pagination_meta.rbi

@@ -0,0 +1,106 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    class NetappsCursorPaginationMeta < Telnyx::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Telnyx::NetappsCursorPaginationMeta, Telnyx::Internal::AnyHash)
+        end
+
+      # Opaque cursors. Absent keys mean there is no such page.
+      sig { returns(T.nilable(Telnyx::NetappsCursorPaginationMeta::Cursors)) }
+      attr_reader :cursors
+
+      sig do
+        params(
+          cursors: Telnyx::NetappsCursorPaginationMeta::Cursors::OrHash
+        ).void
+      end
+      attr_writer :cursors
+
+      # The path of the next page, with the same query parameters. Absent on the last
+      # page.
+      sig { returns(T.nilable(String)) }
+      attr_reader :next_
+
+      sig { params(next_: String).void }
+      attr_writer :next_
+
+      # The path of the previous page. Present when the request used `page[after]`.
+      sig { returns(T.nilable(String)) }
+      attr_reader :previous
+
+      sig { params(previous: String).void }
+      attr_writer :previous
+
+      sig do
+        params(
+          cursors: Telnyx::NetappsCursorPaginationMeta::Cursors::OrHash,
+          next_: String,
+          previous: String
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Opaque cursors. Absent keys mean there is no such page.
+        cursors: nil,
+        # The path of the next page, with the same query parameters. Absent on the last
+        # page.
+        next_: nil,
+        # The path of the previous page. Present when the request used `page[after]`.
+        previous: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            cursors: Telnyx::NetappsCursorPaginationMeta::Cursors,
+            next_: String,
+            previous: String
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class Cursors < Telnyx::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Telnyx::NetappsCursorPaginationMeta::Cursors,
+              Telnyx::Internal::AnyHash
+            )
+          end
+
+        # Pass as `page[after]` to fetch the next page. Absent on the last page.
+        sig { returns(T.nilable(String)) }
+        attr_reader :after
+
+        sig { params(after: String).void }
+        attr_writer :after
+
+        # The cursor of the previous page. Present when the request used `page[after]`.
+        sig { returns(T.nilable(String)) }
+        attr_reader :before
+
+        sig { params(before: String).void }
+        attr_writer :before
+
+        # Opaque cursors. Absent keys mean there is no such page.
+        sig { params(after: String, before: String).returns(T.attached_class) }
+        def self.new(
+          # Pass as `page[after]` to fetch the next page. Absent on the last page.
+          after: nil,
+          # The cursor of the previous page. Present when the request used `page[after]`.
+          before: nil
+        )
+        end
+
+        sig { override.returns({ after: String, before: String }) }
+        def to_hash
+        end
+      end
+    end
+  end
+end