telnyx 5.36.0 → 5.36.2

data/rbi/telnyx/models/alphanumeric_sender_id_create_response.rbi

@@ -0,0 +1,178 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    class AlphanumericSenderIDCreateResponse < Telnyx::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            Telnyx::Models::AlphanumericSenderIDCreateResponse,
+            Telnyx::Internal::AnyHash
+          )
+        end
+
+      sig do
+        returns(
+          T.nilable(Telnyx::Models::AlphanumericSenderIDCreateResponse::Data)
+        )
+      end
+      attr_reader :data
+
+      sig do
+        params(
+          data: Telnyx::Models::AlphanumericSenderIDCreateResponse::Data::OrHash
+        ).void
+      end
+      attr_writer :data
+
+      sig do
+        params(
+          data: Telnyx::Models::AlphanumericSenderIDCreateResponse::Data::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(data: nil)
+      end
+
+      sig do
+        override.returns(
+          { data: Telnyx::Models::AlphanumericSenderIDCreateResponse::Data }
+        )
+      end
+      def to_hash
+      end
+
+      class Data < Telnyx::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Telnyx::Models::AlphanumericSenderIDCreateResponse::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::AlphanumericSenderIDCreateResponse::Data::RecordType::TaggedSymbol
+            )
+          )
+        end
+        attr_reader :record_type
+
+        sig do
+          params(
+            record_type:
+              Telnyx::Models::AlphanumericSenderIDCreateResponse::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::AlphanumericSenderIDCreateResponse::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::AlphanumericSenderIDCreateResponse::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::AlphanumericSenderIDCreateResponse::Data::RecordType
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          ALPHANUMERIC_SENDER_ID =
+            T.let(
+              :alphanumeric_sender_id,
+              Telnyx::Models::AlphanumericSenderIDCreateResponse::Data::RecordType::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                Telnyx::Models::AlphanumericSenderIDCreateResponse::Data::RecordType::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/models/alphanumeric_sender_id_delete_params.rbi

@@ -0,0 +1,30 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    class AlphanumericSenderIDDeleteParams < Telnyx::Internal::Type::BaseModel
+      extend Telnyx::Internal::Type::RequestParameters::Converter
+      include Telnyx::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            Telnyx::AlphanumericSenderIDDeleteParams,
+            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/alphanumeric_sender_id_delete_response.rbi

@@ -0,0 +1,178 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    class AlphanumericSenderIDDeleteResponse < Telnyx::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            Telnyx::Models::AlphanumericSenderIDDeleteResponse,
+            Telnyx::Internal::AnyHash
+          )
+        end
+
+      sig do
+        returns(
+          T.nilable(Telnyx::Models::AlphanumericSenderIDDeleteResponse::Data)
+        )
+      end
+      attr_reader :data
+
+      sig do
+        params(
+          data: Telnyx::Models::AlphanumericSenderIDDeleteResponse::Data::OrHash
+        ).void
+      end
+      attr_writer :data
+
+      sig do
+        params(
+          data: Telnyx::Models::AlphanumericSenderIDDeleteResponse::Data::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(data: nil)
+      end
+
+      sig do
+        override.returns(
+          { data: Telnyx::Models::AlphanumericSenderIDDeleteResponse::Data }
+        )
+      end
+      def to_hash
+      end
+
+      class Data < Telnyx::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Telnyx::Models::AlphanumericSenderIDDeleteResponse::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::AlphanumericSenderIDDeleteResponse::Data::RecordType::TaggedSymbol
+            )
+          )
+        end
+        attr_reader :record_type
+
+        sig do
+          params(
+            record_type:
+              Telnyx::Models::AlphanumericSenderIDDeleteResponse::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::AlphanumericSenderIDDeleteResponse::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::AlphanumericSenderIDDeleteResponse::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::AlphanumericSenderIDDeleteResponse::Data::RecordType
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          ALPHANUMERIC_SENDER_ID =
+            T.let(
+              :alphanumeric_sender_id,
+              Telnyx::Models::AlphanumericSenderIDDeleteResponse::Data::RecordType::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                Telnyx::Models::AlphanumericSenderIDDeleteResponse::Data::RecordType::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/models/alphanumeric_sender_id_list_params.rbi

@@ -0,0 +1,71 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    class AlphanumericSenderIDListParams < Telnyx::Internal::Type::BaseModel
+      extend Telnyx::Internal::Type::RequestParameters::Converter
+      include Telnyx::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            Telnyx::AlphanumericSenderIDListParams,
+            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
+
+      # Page number.
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :page_number
+
+      sig { params(page_number: Integer).void }
+      attr_writer :page_number
+
+      # Page size.
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :page_size
+
+      sig { params(page_size: Integer).void }
+      attr_writer :page_size
+
+      sig do
+        params(
+          filter_messaging_profile_id: String,
+          page_number: Integer,
+          page_size: Integer,
+          request_options: Telnyx::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Filter by messaging profile ID.
+        filter_messaging_profile_id: nil,
+        # Page number.
+        page_number: nil,
+        # Page size.
+        page_size: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            filter_messaging_profile_id: String,
+            page_number: Integer,
+            page_size: Integer,
+            request_options: Telnyx::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/telnyx/models/alphanumeric_sender_id_list_response.rbi

@@ -0,0 +1,138 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    class AlphanumericSenderIDListResponse < Telnyx::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            Telnyx::Models::AlphanumericSenderIDListResponse,
+            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::AlphanumericSenderIDListResponse::RecordType::TaggedSymbol
+          )
+        )
+      end
+      attr_reader :record_type
+
+      sig do
+        params(
+          record_type:
+            Telnyx::Models::AlphanumericSenderIDListResponse::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::AlphanumericSenderIDListResponse::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::AlphanumericSenderIDListResponse::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::AlphanumericSenderIDListResponse::RecordType
+            )
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        ALPHANUMERIC_SENDER_ID =
+          T.let(
+            :alphanumeric_sender_id,
+            Telnyx::Models::AlphanumericSenderIDListResponse::RecordType::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              Telnyx::Models::AlphanumericSenderIDListResponse::RecordType::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/models/alphanumeric_sender_id_retrieve_params.rbi

@@ -0,0 +1,30 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    class AlphanumericSenderIDRetrieveParams < Telnyx::Internal::Type::BaseModel
+      extend Telnyx::Internal::Type::RequestParameters::Converter
+      include Telnyx::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            Telnyx::AlphanumericSenderIDRetrieveParams,
+            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