telnyx 5.36.0 → 5.36.2

data/rbi/telnyx/models/alphanumeric_sender_id_retrieve_response.rbi

@@ -0,0 +1,180 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    class AlphanumericSenderIDRetrieveResponse < Telnyx::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            Telnyx::Models::AlphanumericSenderIDRetrieveResponse,
+            Telnyx::Internal::AnyHash
+          )
+        end
+
+      sig do
+        returns(
+          T.nilable(Telnyx::Models::AlphanumericSenderIDRetrieveResponse::Data)
+        )
+      end
+      attr_reader :data
+
+      sig do
+        params(
+          data:
+            Telnyx::Models::AlphanumericSenderIDRetrieveResponse::Data::OrHash
+        ).void
+      end
+      attr_writer :data
+
+      sig do
+        params(
+          data:
+            Telnyx::Models::AlphanumericSenderIDRetrieveResponse::Data::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(data: nil)
+      end
+
+      sig do
+        override.returns(
+          { data: Telnyx::Models::AlphanumericSenderIDRetrieveResponse::Data }
+        )
+      end
+      def to_hash
+      end
+
+      class Data < Telnyx::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Telnyx::Models::AlphanumericSenderIDRetrieveResponse::Data,
+              Telnyx::Internal::AnyHash
+            )
+          end
+
+        # Uniquely identifies the alphanumeric sender ID resource.
+        sig { returns(T.nilable(String)) }
+        attr_reader :id
+
+        sig { params(id: String).void }
+        attr_writer :id
+
+        # The alphanumeric sender ID string.
+        sig { returns(T.nilable(String)) }
+        attr_reader :alphanumeric_sender_id
+
+        sig { params(alphanumeric_sender_id: String).void }
+        attr_writer :alphanumeric_sender_id
+
+        # The messaging profile this sender ID belongs to.
+        sig { returns(T.nilable(String)) }
+        attr_reader :messaging_profile_id
+
+        sig { params(messaging_profile_id: String).void }
+        attr_writer :messaging_profile_id
+
+        # The organization that owns this sender ID.
+        sig { returns(T.nilable(String)) }
+        attr_reader :organization_id
+
+        sig { params(organization_id: String).void }
+        attr_writer :organization_id
+
+        sig do
+          returns(
+            T.nilable(
+              Telnyx::Models::AlphanumericSenderIDRetrieveResponse::Data::RecordType::TaggedSymbol
+            )
+          )
+        end
+        attr_reader :record_type
+
+        sig do
+          params(
+            record_type:
+              Telnyx::Models::AlphanumericSenderIDRetrieveResponse::Data::RecordType::OrSymbol
+          ).void
+        end
+        attr_writer :record_type
+
+        # A US long code number to use as fallback when sending to US destinations.
+        sig { returns(T.nilable(String)) }
+        attr_reader :us_long_code_fallback
+
+        sig { params(us_long_code_fallback: String).void }
+        attr_writer :us_long_code_fallback
+
+        sig do
+          params(
+            id: String,
+            alphanumeric_sender_id: String,
+            messaging_profile_id: String,
+            organization_id: String,
+            record_type:
+              Telnyx::Models::AlphanumericSenderIDRetrieveResponse::Data::RecordType::OrSymbol,
+            us_long_code_fallback: String
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Uniquely identifies the alphanumeric sender ID resource.
+          id: nil,
+          # The alphanumeric sender ID string.
+          alphanumeric_sender_id: nil,
+          # The messaging profile this sender ID belongs to.
+          messaging_profile_id: nil,
+          # The organization that owns this sender ID.
+          organization_id: nil,
+          record_type: nil,
+          # A US long code number to use as fallback when sending to US destinations.
+          us_long_code_fallback: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              id: String,
+              alphanumeric_sender_id: String,
+              messaging_profile_id: String,
+              organization_id: String,
+              record_type:
+                Telnyx::Models::AlphanumericSenderIDRetrieveResponse::Data::RecordType::TaggedSymbol,
+              us_long_code_fallback: String
+            }
+          )
+        end
+        def to_hash
+        end
+
+        module RecordType
+          extend Telnyx::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                Telnyx::Models::AlphanumericSenderIDRetrieveResponse::Data::RecordType
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          ALPHANUMERIC_SENDER_ID =
+            T.let(
+              :alphanumeric_sender_id,
+              Telnyx::Models::AlphanumericSenderIDRetrieveResponse::Data::RecordType::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                Telnyx::Models::AlphanumericSenderIDRetrieveResponse::Data::RecordType::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/models/message_retrieve_group_messages_params.rbi

@@ -0,0 +1,30 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    class MessageRetrieveGroupMessagesParams < Telnyx::Internal::Type::BaseModel
+      extend Telnyx::Internal::Type::RequestParameters::Converter
+      include Telnyx::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            Telnyx::MessageRetrieveGroupMessagesParams,
+            Telnyx::Internal::AnyHash
+          )
+        end
+
+      sig do
+        params(request_options: Telnyx::RequestOptions::OrHash).returns(
+          T.attached_class
+        )
+      end
+      def self.new(request_options: {})
+      end
+
+      sig { override.returns({ request_options: Telnyx::RequestOptions }) }
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/telnyx/models/message_retrieve_group_messages_response.rbi

@@ -0,0 +1,37 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    class MessageRetrieveGroupMessagesResponse < Telnyx::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            Telnyx::Models::MessageRetrieveGroupMessagesResponse,
+            Telnyx::Internal::AnyHash
+          )
+        end
+
+      sig { returns(T.nilable(T::Array[Telnyx::OutboundMessagePayload])) }
+      attr_reader :data
+
+      sig do
+        params(data: T::Array[Telnyx::OutboundMessagePayload::OrHash]).void
+      end
+      attr_writer :data
+
+      sig do
+        params(data: T::Array[Telnyx::OutboundMessagePayload::OrHash]).returns(
+          T.attached_class
+        )
+      end
+      def self.new(data: nil)
+      end
+
+      sig do
+        override.returns({ data: T::Array[Telnyx::OutboundMessagePayload] })
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/telnyx/models/message_send_with_alphanumeric_sender_params.rbi

@@ -0,0 +1,97 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    class MessageSendWithAlphanumericSenderParams < Telnyx::Internal::Type::BaseModel
+      extend Telnyx::Internal::Type::RequestParameters::Converter
+      include Telnyx::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            Telnyx::MessageSendWithAlphanumericSenderParams,
+            Telnyx::Internal::AnyHash
+          )
+        end
+
+      # A valid alphanumeric sender ID on the user's account.
+      sig { returns(String) }
+      attr_accessor :from
+
+      # The messaging profile ID to use.
+      sig { returns(String) }
+      attr_accessor :messaging_profile_id
+
+      # The message body.
+      sig { returns(String) }
+      attr_accessor :text
+
+      # Receiving address (+E.164 formatted phone number).
+      sig { returns(String) }
+      attr_accessor :to
+
+      # If true, use the messaging profile's webhook settings.
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :use_profile_webhooks
+
+      sig { params(use_profile_webhooks: T::Boolean).void }
+      attr_writer :use_profile_webhooks
+
+      # Failover callback URL for delivery status updates.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :webhook_failover_url
+
+      # Callback URL for delivery status updates.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :webhook_url
+
+      sig do
+        params(
+          from: String,
+          messaging_profile_id: String,
+          text: String,
+          to: String,
+          use_profile_webhooks: T::Boolean,
+          webhook_failover_url: T.nilable(String),
+          webhook_url: T.nilable(String),
+          request_options: Telnyx::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # A valid alphanumeric sender ID on the user's account.
+        from:,
+        # The messaging profile ID to use.
+        messaging_profile_id:,
+        # The message body.
+        text:,
+        # Receiving address (+E.164 formatted phone number).
+        to:,
+        # If true, use the messaging profile's webhook settings.
+        use_profile_webhooks: nil,
+        # Failover callback URL for delivery status updates.
+        webhook_failover_url: nil,
+        # Callback URL for delivery status updates.
+        webhook_url: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            from: String,
+            messaging_profile_id: String,
+            text: String,
+            to: String,
+            use_profile_webhooks: T::Boolean,
+            webhook_failover_url: T.nilable(String),
+            webhook_url: T.nilable(String),
+            request_options: Telnyx::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/telnyx/models/message_send_with_alphanumeric_sender_response.rbi

@@ -0,0 +1,33 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    class MessageSendWithAlphanumericSenderResponse < Telnyx::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            Telnyx::Models::MessageSendWithAlphanumericSenderResponse,
+            Telnyx::Internal::AnyHash
+          )
+        end
+
+      sig { returns(T.nilable(Telnyx::OutboundMessagePayload)) }
+      attr_reader :data
+
+      sig { params(data: Telnyx::OutboundMessagePayload::OrHash).void }
+      attr_writer :data
+
+      sig do
+        params(data: Telnyx::OutboundMessagePayload::OrHash).returns(
+          T.attached_class
+        )
+      end
+      def self.new(data: nil)
+      end
+
+      sig { override.returns({ data: Telnyx::OutboundMessagePayload }) }
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/telnyx/models/messaging_10dlc/partner_campaign_list_params.rbi

@@ -124,9 +124,9 @@ module Telnyx
               :tcrBrandId,
               Telnyx::Messaging10dlc::PartnerCampaignListParams::Sort::TaggedSymbol
             )
-          TCR_BRAN_ID_DESC =
+          TCR_BRAND_ID_DESC =
             T.let(
-              :"-tcrBranId",
+              :"-tcrBrandId",
               Telnyx::Messaging10dlc::PartnerCampaignListParams::Sort::TaggedSymbol
             )
           TCR_CAMPAIGN_ID =

data/rbi/telnyx/models/messaging_hosted_number_list_params.rbi

@@ -0,0 +1,148 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    class MessagingHostedNumberListParams < Telnyx::Internal::Type::BaseModel
+      extend Telnyx::Internal::Type::RequestParameters::Converter
+      include Telnyx::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            Telnyx::MessagingHostedNumberListParams,
+            Telnyx::Internal::AnyHash
+          )
+        end
+
+      # Filter by messaging profile ID.
+      sig { returns(T.nilable(String)) }
+      attr_reader :filter_messaging_profile_id
+
+      sig { params(filter_messaging_profile_id: String).void }
+      attr_writer :filter_messaging_profile_id
+
+      # Filter by exact phone number.
+      sig { returns(T.nilable(String)) }
+      attr_reader :filter_phone_number
+
+      sig { params(filter_phone_number: String).void }
+      attr_writer :filter_phone_number
+
+      # Filter by phone number substring.
+      sig { returns(T.nilable(String)) }
+      attr_reader :filter_phone_number_contains
+
+      sig { params(filter_phone_number_contains: String).void }
+      attr_writer :filter_phone_number_contains
+
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :page_number
+
+      sig { params(page_number: Integer).void }
+      attr_writer :page_number
+
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :page_size
+
+      sig { params(page_size: Integer).void }
+      attr_writer :page_size
+
+      # Sort by phone number.
+      sig do
+        returns(
+          T.nilable(
+            Telnyx::MessagingHostedNumberListParams::SortPhoneNumber::OrSymbol
+          )
+        )
+      end
+      attr_reader :sort_phone_number
+
+      sig do
+        params(
+          sort_phone_number:
+            Telnyx::MessagingHostedNumberListParams::SortPhoneNumber::OrSymbol
+        ).void
+      end
+      attr_writer :sort_phone_number
+
+      sig do
+        params(
+          filter_messaging_profile_id: String,
+          filter_phone_number: String,
+          filter_phone_number_contains: String,
+          page_number: Integer,
+          page_size: Integer,
+          sort_phone_number:
+            Telnyx::MessagingHostedNumberListParams::SortPhoneNumber::OrSymbol,
+          request_options: Telnyx::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Filter by messaging profile ID.
+        filter_messaging_profile_id: nil,
+        # Filter by exact phone number.
+        filter_phone_number: nil,
+        # Filter by phone number substring.
+        filter_phone_number_contains: nil,
+        page_number: nil,
+        page_size: nil,
+        # Sort by phone number.
+        sort_phone_number: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            filter_messaging_profile_id: String,
+            filter_phone_number: String,
+            filter_phone_number_contains: String,
+            page_number: Integer,
+            page_size: Integer,
+            sort_phone_number:
+              Telnyx::MessagingHostedNumberListParams::SortPhoneNumber::OrSymbol,
+            request_options: Telnyx::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+
+      # Sort by phone number.
+      module SortPhoneNumber
+        extend Telnyx::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(
+              Symbol,
+              Telnyx::MessagingHostedNumberListParams::SortPhoneNumber
+            )
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        ASC =
+          T.let(
+            :asc,
+            Telnyx::MessagingHostedNumberListParams::SortPhoneNumber::TaggedSymbol
+          )
+        DESC =
+          T.let(
+            :desc,
+            Telnyx::MessagingHostedNumberListParams::SortPhoneNumber::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              Telnyx::MessagingHostedNumberListParams::SortPhoneNumber::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/models/messaging_hosted_number_retrieve_params.rbi

@@ -0,0 +1,30 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    class MessagingHostedNumberRetrieveParams < Telnyx::Internal::Type::BaseModel
+      extend Telnyx::Internal::Type::RequestParameters::Converter
+      include Telnyx::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            Telnyx::MessagingHostedNumberRetrieveParams,
+            Telnyx::Internal::AnyHash
+          )
+        end
+
+      sig do
+        params(request_options: Telnyx::RequestOptions::OrHash).returns(
+          T.attached_class
+        )
+      end
+      def self.new(request_options: {})
+      end
+
+      sig { override.returns({ request_options: Telnyx::RequestOptions }) }
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/telnyx/models/messaging_hosted_number_retrieve_response.rbi

@@ -0,0 +1,37 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    class MessagingHostedNumberRetrieveResponse < Telnyx::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            Telnyx::Models::MessagingHostedNumberRetrieveResponse,
+            Telnyx::Internal::AnyHash
+          )
+        end
+
+      sig { returns(T.nilable(Telnyx::PhoneNumberWithMessagingSettings)) }
+      attr_reader :data
+
+      sig do
+        params(data: Telnyx::PhoneNumberWithMessagingSettings::OrHash).void
+      end
+      attr_writer :data
+
+      sig do
+        params(data: Telnyx::PhoneNumberWithMessagingSettings::OrHash).returns(
+          T.attached_class
+        )
+      end
+      def self.new(data: nil)
+      end
+
+      sig do
+        override.returns({ data: Telnyx::PhoneNumberWithMessagingSettings })
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/telnyx/models/messaging_hosted_number_update_params.rbi

@@ -0,0 +1,87 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    class MessagingHostedNumberUpdateParams < Telnyx::Internal::Type::BaseModel
+      extend Telnyx::Internal::Type::RequestParameters::Converter
+      include Telnyx::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            Telnyx::MessagingHostedNumberUpdateParams,
+            Telnyx::Internal::AnyHash
+          )
+        end
+
+      # Configure the messaging product for this number:
+      #
+      # - Omit this field or set its value to `null` to keep the current value.
+      # - Set this field to a quoted product ID to set this phone number to that product
+      sig { returns(T.nilable(String)) }
+      attr_reader :messaging_product
+
+      sig { params(messaging_product: String).void }
+      attr_writer :messaging_product
+
+      # Configure the messaging profile this phone number is assigned to:
+      #
+      # - Omit this field or set its value to `null` to keep the current value.
+      # - Set this field to `""` to unassign the number from its messaging profile
+      # - Set this field to a quoted UUID of a messaging profile to assign this number
+      #   to that messaging profile
+      sig { returns(T.nilable(String)) }
+      attr_reader :messaging_profile_id
+
+      sig { params(messaging_profile_id: String).void }
+      attr_writer :messaging_profile_id
+
+      # Tags to set on this phone number.
+      sig { returns(T.nilable(T::Array[String])) }
+      attr_reader :tags
+
+      sig { params(tags: T::Array[String]).void }
+      attr_writer :tags
+
+      sig do
+        params(
+          messaging_product: String,
+          messaging_profile_id: String,
+          tags: T::Array[String],
+          request_options: Telnyx::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Configure the messaging product for this number:
+        #
+        # - Omit this field or set its value to `null` to keep the current value.
+        # - Set this field to a quoted product ID to set this phone number to that product
+        messaging_product: nil,
+        # Configure the messaging profile this phone number is assigned to:
+        #
+        # - Omit this field or set its value to `null` to keep the current value.
+        # - Set this field to `""` to unassign the number from its messaging profile
+        # - Set this field to a quoted UUID of a messaging profile to assign this number
+        #   to that messaging profile
+        messaging_profile_id: nil,
+        # Tags to set on this phone number.
+        tags: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            messaging_product: String,
+            messaging_profile_id: String,
+            tags: T::Array[String],
+            request_options: Telnyx::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end