telnyx 5.158.0 → 5.159.0

data/rbi/telnyx/models/email_block_retrieve_export_params.rbi

@@ -0,0 +1,216 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    class EmailBlockRetrieveExportParams < Telnyx::Internal::Type::BaseModel
+      extend Telnyx::Internal::Type::RequestParameters::Converter
+      include Telnyx::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            Telnyx::EmailBlockRetrieveExportParams,
+            Telnyx::Internal::AnyHash
+          )
+        end
+
+      # `created_at > value` (ISO 8601).
+      sig { returns(T.nilable(Time)) }
+      attr_reader :filter_created_after
+
+      sig { params(filter_created_after: Time).void }
+      attr_writer :filter_created_after
+
+      # `created_at < value` (ISO 8601).
+      sig { returns(T.nilable(Time)) }
+      attr_reader :filter_created_before
+
+      sig { params(filter_created_before: Time).void }
+      attr_writer :filter_created_before
+
+      # Exact-match filter on domain_id (UUID).
+      sig { returns(T.nilable(String)) }
+      attr_reader :filter_domain_id
+
+      sig { params(filter_domain_id: String).void }
+      attr_writer :filter_domain_id
+
+      # Exact-match filter on reason.
+      sig do
+        returns(
+          T.nilable(
+            Telnyx::EmailBlockRetrieveExportParams::FilterReason::OrSymbol
+          )
+        )
+      end
+      attr_reader :filter_reason
+
+      sig do
+        params(
+          filter_reason:
+            Telnyx::EmailBlockRetrieveExportParams::FilterReason::OrSymbol
+        ).void
+      end
+      attr_writer :filter_reason
+
+      # Offset page number (≥1, default 1).
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :page_number
+
+      sig { params(page_number: Integer).void }
+      attr_writer :page_number
+
+      # Page size (1–100, default 25).
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :page_size
+
+      sig { params(page_size: Integer).void }
+      attr_writer :page_size
+
+      # Sort field. Leading `-` = desc; only `created_at` is sortable. Default
+      # `-created_at`. `--` is an error.
+      sig do
+        returns(
+          T.nilable(Telnyx::EmailBlockRetrieveExportParams::Sort::OrSymbol)
+        )
+      end
+      attr_reader :sort
+
+      sig do
+        params(
+          sort: Telnyx::EmailBlockRetrieveExportParams::Sort::OrSymbol
+        ).void
+      end
+      attr_writer :sort
+
+      sig do
+        params(
+          filter_created_after: Time,
+          filter_created_before: Time,
+          filter_domain_id: String,
+          filter_reason:
+            Telnyx::EmailBlockRetrieveExportParams::FilterReason::OrSymbol,
+          page_number: Integer,
+          page_size: Integer,
+          sort: Telnyx::EmailBlockRetrieveExportParams::Sort::OrSymbol,
+          request_options: Telnyx::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # `created_at > value` (ISO 8601).
+        filter_created_after: nil,
+        # `created_at < value` (ISO 8601).
+        filter_created_before: nil,
+        # Exact-match filter on domain_id (UUID).
+        filter_domain_id: nil,
+        # Exact-match filter on reason.
+        filter_reason: nil,
+        # Offset page number (≥1, default 1).
+        page_number: nil,
+        # Page size (1–100, default 25).
+        page_size: nil,
+        # Sort field. Leading `-` = desc; only `created_at` is sortable. Default
+        # `-created_at`. `--` is an error.
+        sort: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            filter_created_after: Time,
+            filter_created_before: Time,
+            filter_domain_id: String,
+            filter_reason:
+              Telnyx::EmailBlockRetrieveExportParams::FilterReason::OrSymbol,
+            page_number: Integer,
+            page_size: Integer,
+            sort: Telnyx::EmailBlockRetrieveExportParams::Sort::OrSymbol,
+            request_options: Telnyx::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+
+      # Exact-match filter on reason.
+      module FilterReason
+        extend Telnyx::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, Telnyx::EmailBlockRetrieveExportParams::FilterReason)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        HARD_BOUNCE =
+          T.let(
+            :hard_bounce,
+            Telnyx::EmailBlockRetrieveExportParams::FilterReason::TaggedSymbol
+          )
+        SPAM_COMPLAINT =
+          T.let(
+            :spam_complaint,
+            Telnyx::EmailBlockRetrieveExportParams::FilterReason::TaggedSymbol
+          )
+        UNSUBSCRIBE =
+          T.let(
+            :unsubscribe,
+            Telnyx::EmailBlockRetrieveExportParams::FilterReason::TaggedSymbol
+          )
+        INVALID =
+          T.let(
+            :invalid,
+            Telnyx::EmailBlockRetrieveExportParams::FilterReason::TaggedSymbol
+          )
+        MANUAL_BLOCK =
+          T.let(
+            :manual_block,
+            Telnyx::EmailBlockRetrieveExportParams::FilterReason::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              Telnyx::EmailBlockRetrieveExportParams::FilterReason::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+
+      # Sort field. Leading `-` = desc; only `created_at` is sortable. Default
+      # `-created_at`. `--` is an error.
+      module Sort
+        extend Telnyx::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, Telnyx::EmailBlockRetrieveExportParams::Sort)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        CREATED_AT =
+          T.let(
+            :created_at,
+            Telnyx::EmailBlockRetrieveExportParams::Sort::TaggedSymbol
+          )
+        CREATED_AT_DESC =
+          T.let(
+            :"-created_at",
+            Telnyx::EmailBlockRetrieveExportParams::Sort::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[Telnyx::EmailBlockRetrieveExportParams::Sort::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/models/email_block_retrieve_export_response.rbi

@@ -0,0 +1,7 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    EmailBlockRetrieveExportResponse = T.type_alias { String }
+  end
+end

data/rbi/telnyx/models/email_block_retrieve_params.rbi

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

data/rbi/telnyx/models/email_blocks/email_block_import_response.rbi

@@ -0,0 +1,363 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    EmailBlockImportResponse = EmailBlocks::EmailBlockImportResponse
+
+    module EmailBlocks
+      class EmailBlockImportResponse < Telnyx::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Telnyx::EmailBlocks::EmailBlockImportResponse,
+              Telnyx::Internal::AnyHash
+            )
+          end
+
+        # Import job. Schema fields hidden: `account_id`, `csv_content`, `block_ttl_days`.
+        # Nullable fields use the omit-nullable pattern.
+        sig { returns(Telnyx::EmailBlocks::EmailBlockImportResponse::Data) }
+        attr_reader :data
+
+        sig do
+          params(
+            data: Telnyx::EmailBlocks::EmailBlockImportResponse::Data::OrHash
+          ).void
+        end
+        attr_writer :data
+
+        sig do
+          params(
+            data: Telnyx::EmailBlocks::EmailBlockImportResponse::Data::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Import job. Schema fields hidden: `account_id`, `csv_content`, `block_ttl_days`.
+          # Nullable fields use the omit-nullable pattern.
+          data:
+        )
+        end
+
+        sig do
+          override.returns(
+            { data: Telnyx::EmailBlocks::EmailBlockImportResponse::Data }
+          )
+        end
+        def to_hash
+        end
+
+        class Data < Telnyx::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Telnyx::EmailBlocks::EmailBlockImportResponse::Data,
+                Telnyx::Internal::AnyHash
+              )
+            end
+
+          sig { returns(String) }
+          attr_accessor :id
+
+          sig { returns(Time) }
+          attr_accessor :created_at
+
+          # View-only.
+          sig do
+            returns(
+              Telnyx::EmailBlocks::EmailBlockImportResponse::Data::RecordType::TaggedSymbol
+            )
+          end
+          attr_accessor :record_type
+
+          sig do
+            returns(
+              Telnyx::EmailBlocks::EmailBlockImportResponse::Data::Status::TaggedSymbol
+            )
+          end
+          attr_accessor :status
+
+          # Data-row count at upload.
+          sig { returns(Integer) }
+          attr_accessor :total
+
+          sig { returns(Time) }
+          attr_accessor :updated_at
+
+          # Omitted until terminal success.
+          sig { returns(T.nilable(Time)) }
+          attr_reader :completed_at
+
+          sig { params(completed_at: Time).void }
+          attr_writer :completed_at
+
+          # Only when `status == completed`.
+          sig { returns(T.nilable(Integer)) }
+          attr_reader :created_count
+
+          sig { params(created_count: Integer).void }
+          attr_writer :created_count
+
+          # Only when `status == completed`.
+          sig { returns(T.nilable(Integer)) }
+          attr_reader :error_count
+
+          sig { params(error_count: Integer).void }
+          attr_writer :error_count
+
+          # `{row_number: reason}`; only rendered when non-empty.
+          sig { returns(T.nilable(T::Hash[Symbol, String])) }
+          attr_reader :errors
+
+          sig { params(errors: T::Hash[Symbol, String]).void }
+          attr_writer :errors
+
+          # Only when `status == completed`.
+          sig { returns(T.nilable(Integer)) }
+          attr_reader :existing_count
+
+          sig { params(existing_count: Integer).void }
+          attr_writer :existing_count
+
+          # Only on terminal failure.
+          sig { returns(T.nilable(String)) }
+          attr_reader :failure_reason
+
+          sig { params(failure_reason: String).void }
+          attr_writer :failure_reason
+
+          # Only when `status == completed`.
+          sig { returns(T.nilable(Integer)) }
+          attr_reader :processed_rows
+
+          sig { params(processed_rows: Integer).void }
+          attr_writer :processed_rows
+
+          # Omitted when nil.
+          sig do
+            returns(
+              T.nilable(
+                Telnyx::EmailBlocks::EmailBlockImportResponse::Data::Provider::TaggedSymbol
+              )
+            )
+          end
+          attr_reader :provider
+
+          sig do
+            params(
+              provider:
+                Telnyx::EmailBlocks::EmailBlockImportResponse::Data::Provider::OrSymbol
+            ).void
+          end
+          attr_writer :provider
+
+          # Only when `status == completed`.
+          sig { returns(T.nilable(Integer)) }
+          attr_reader :skipped_count
+
+          sig { params(skipped_count: Integer).void }
+          attr_writer :skipped_count
+
+          # Import job. Schema fields hidden: `account_id`, `csv_content`, `block_ttl_days`.
+          # Nullable fields use the omit-nullable pattern.
+          sig do
+            params(
+              id: String,
+              created_at: Time,
+              record_type:
+                Telnyx::EmailBlocks::EmailBlockImportResponse::Data::RecordType::OrSymbol,
+              status:
+                Telnyx::EmailBlocks::EmailBlockImportResponse::Data::Status::OrSymbol,
+              total: Integer,
+              updated_at: Time,
+              completed_at: Time,
+              created_count: Integer,
+              error_count: Integer,
+              errors: T::Hash[Symbol, String],
+              existing_count: Integer,
+              failure_reason: String,
+              processed_rows: Integer,
+              provider:
+                Telnyx::EmailBlocks::EmailBlockImportResponse::Data::Provider::OrSymbol,
+              skipped_count: Integer
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            id:,
+            created_at:,
+            # View-only.
+            record_type:,
+            status:,
+            # Data-row count at upload.
+            total:,
+            updated_at:,
+            # Omitted until terminal success.
+            completed_at: nil,
+            # Only when `status == completed`.
+            created_count: nil,
+            # Only when `status == completed`.
+            error_count: nil,
+            # `{row_number: reason}`; only rendered when non-empty.
+            errors: nil,
+            # Only when `status == completed`.
+            existing_count: nil,
+            # Only on terminal failure.
+            failure_reason: nil,
+            # Only when `status == completed`.
+            processed_rows: nil,
+            # Omitted when nil.
+            provider: nil,
+            # Only when `status == completed`.
+            skipped_count: nil
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                id: String,
+                created_at: Time,
+                record_type:
+                  Telnyx::EmailBlocks::EmailBlockImportResponse::Data::RecordType::TaggedSymbol,
+                status:
+                  Telnyx::EmailBlocks::EmailBlockImportResponse::Data::Status::TaggedSymbol,
+                total: Integer,
+                updated_at: Time,
+                completed_at: Time,
+                created_count: Integer,
+                error_count: Integer,
+                errors: T::Hash[Symbol, String],
+                existing_count: Integer,
+                failure_reason: String,
+                processed_rows: Integer,
+                provider:
+                  Telnyx::EmailBlocks::EmailBlockImportResponse::Data::Provider::TaggedSymbol,
+                skipped_count: Integer
+              }
+            )
+          end
+          def to_hash
+          end
+
+          # View-only.
+          module RecordType
+            extend Telnyx::Internal::Type::Enum
+
+            TaggedSymbol =
+              T.type_alias do
+                T.all(
+                  Symbol,
+                  Telnyx::EmailBlocks::EmailBlockImportResponse::Data::RecordType
+                )
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            EMAIL_BLOCK_IMPORT =
+              T.let(
+                :email_block_import,
+                Telnyx::EmailBlocks::EmailBlockImportResponse::Data::RecordType::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  Telnyx::EmailBlocks::EmailBlockImportResponse::Data::RecordType::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
+          end
+
+          module Status
+            extend Telnyx::Internal::Type::Enum
+
+            TaggedSymbol =
+              T.type_alias do
+                T.all(
+                  Symbol,
+                  Telnyx::EmailBlocks::EmailBlockImportResponse::Data::Status
+                )
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            PENDING =
+              T.let(
+                :pending,
+                Telnyx::EmailBlocks::EmailBlockImportResponse::Data::Status::TaggedSymbol
+              )
+            PROCESSING =
+              T.let(
+                :processing,
+                Telnyx::EmailBlocks::EmailBlockImportResponse::Data::Status::TaggedSymbol
+              )
+            COMPLETED =
+              T.let(
+                :completed,
+                Telnyx::EmailBlocks::EmailBlockImportResponse::Data::Status::TaggedSymbol
+              )
+            FAILED =
+              T.let(
+                :failed,
+                Telnyx::EmailBlocks::EmailBlockImportResponse::Data::Status::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  Telnyx::EmailBlocks::EmailBlockImportResponse::Data::Status::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
+          end
+
+          # Omitted when nil.
+          module Provider
+            extend Telnyx::Internal::Type::Enum
+
+            TaggedSymbol =
+              T.type_alias do
+                T.all(
+                  Symbol,
+                  Telnyx::EmailBlocks::EmailBlockImportResponse::Data::Provider
+                )
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            SENDGRID =
+              T.let(
+                :sendgrid,
+                Telnyx::EmailBlocks::EmailBlockImportResponse::Data::Provider::TaggedSymbol
+              )
+            MAILGUN =
+              T.let(
+                :mailgun,
+                Telnyx::EmailBlocks::EmailBlockImportResponse::Data::Provider::TaggedSymbol
+              )
+            SES =
+              T.let(
+                :ses,
+                Telnyx::EmailBlocks::EmailBlockImportResponse::Data::Provider::TaggedSymbol
+              )
+            GENERIC =
+              T.let(
+                :generic,
+                Telnyx::EmailBlocks::EmailBlockImportResponse::Data::Provider::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  Telnyx::EmailBlocks::EmailBlockImportResponse::Data::Provider::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/models/email_blocks/import_create_params.rbi

@@ -0,0 +1,61 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    module EmailBlocks
+      class ImportCreateParams < Telnyx::Internal::Type::BaseModel
+        extend Telnyx::Internal::Type::RequestParameters::Converter
+        include Telnyx::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              Telnyx::EmailBlocks::ImportCreateParams,
+              Telnyx::Internal::AnyHash
+            )
+          end
+
+        # The CSV file (Plug.Upload). Missing/non-upload → 400.
+        sig { returns(Telnyx::Internal::FileInput) }
+        attr_accessor :file
+
+        # TTL for imported `manual_block` rows; other reasons get `expires_at: null`.
+        # Invalid/missing → falls back to 30.
+        sig { returns(T.nilable(Integer)) }
+        attr_reader :block_ttl_days
+
+        sig { params(block_ttl_days: Integer).void }
+        attr_writer :block_ttl_days
+
+        sig do
+          params(
+            file: Telnyx::Internal::FileInput,
+            block_ttl_days: Integer,
+            request_options: Telnyx::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The CSV file (Plug.Upload). Missing/non-upload → 400.
+          file:,
+          # TTL for imported `manual_block` rows; other reasons get `expires_at: null`.
+          # Invalid/missing → falls back to 30.
+          block_ttl_days: nil,
+          request_options: {}
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              file: Telnyx::Internal::FileInput,
+              block_ttl_days: Integer,
+              request_options: Telnyx::RequestOptions
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end