telnyx 5.162.0 → 5.164.0

data/rbi/telnyx/models/email_block_retrieve_events_response.rbi

@@ -11,211 +11,164 @@ module Telnyx
           )
         end
 
+      sig { returns(String) }
+      attr_accessor :id
+
+      # Free-text (`user_id`/`org_id`/`api_key`/`dev_bypass`/`system`/`manual`).
+      sig { returns(String) }
+      attr_accessor :actor
+
       sig do
         returns(
-          T::Array[Telnyx::Models::EmailBlockRetrieveEventsResponse::Data]
+          Telnyx::Models::EmailBlockRetrieveEventsResponse::EventType::TaggedSymbol
         )
       end
-      attr_accessor :data
-
-      sig { returns(Telnyx::OffsetMeta) }
-      attr_reader :meta
+      attr_accessor :event_type
 
-      sig { params(meta: Telnyx::OffsetMeta::OrHash).void }
-      attr_writer :meta
+      sig { returns(Time) }
+      attr_accessor :occurred_at
 
-      sig do
-        params(
-          data:
-            T::Array[
-              Telnyx::Models::EmailBlockRetrieveEventsResponse::Data::OrHash
-            ],
-          meta: Telnyx::OffsetMeta::OrHash
-        ).returns(T.attached_class)
-      end
-      def self.new(data:, meta:)
-      end
+      # Free-text snapshot of the block's reason at event time.
+      sig { returns(String) }
+      attr_accessor :reason
 
+      # View-only.
       sig do
-        override.returns(
-          {
-            data:
-              T::Array[Telnyx::Models::EmailBlockRetrieveEventsResponse::Data],
-            meta: Telnyx::OffsetMeta
-          }
+        returns(
+          Telnyx::Models::EmailBlockRetrieveEventsResponse::RecordType::TaggedSymbol
         )
       end
-      def to_hash
-      end
+      attr_accessor :record_type
 
-      class Data < Telnyx::Internal::Type::BaseModel
-        OrHash =
-          T.type_alias do
-            T.any(
-              Telnyx::Models::EmailBlockRetrieveEventsResponse::Data,
-              Telnyx::Internal::AnyHash
-            )
-          end
+      # Free-text snapshot of the block's source at event time.
+      sig { returns(String) }
+      attr_accessor :source
 
-        sig { returns(String) }
-        attr_accessor :id
+      # `null` when the schema field is nil (the context usually sets it to `{}`).
+      sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
+      attr_accessor :meta
 
+      sig do
+        params(
+          id: String,
+          actor: String,
+          event_type:
+            Telnyx::Models::EmailBlockRetrieveEventsResponse::EventType::OrSymbol,
+          occurred_at: Time,
+          reason: String,
+          record_type:
+            Telnyx::Models::EmailBlockRetrieveEventsResponse::RecordType::OrSymbol,
+          source: String,
+          meta: T.nilable(T::Hash[Symbol, T.anything])
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        id:,
         # Free-text (`user_id`/`org_id`/`api_key`/`dev_bypass`/`system`/`manual`).
-        sig { returns(String) }
-        attr_accessor :actor
-
-        sig do
-          returns(
-            Telnyx::Models::EmailBlockRetrieveEventsResponse::Data::EventType::TaggedSymbol
-          )
-        end
-        attr_accessor :event_type
-
-        sig { returns(Time) }
-        attr_accessor :occurred_at
-
+        actor:,
+        event_type:,
+        occurred_at:,
         # Free-text snapshot of the block's reason at event time.
-        sig { returns(String) }
-        attr_accessor :reason
-
+        reason:,
         # View-only.
-        sig do
-          returns(
-            Telnyx::Models::EmailBlockRetrieveEventsResponse::Data::RecordType::TaggedSymbol
-          )
-        end
-        attr_accessor :record_type
-
+        record_type:,
         # Free-text snapshot of the block's source at event time.
-        sig { returns(String) }
-        attr_accessor :source
-
+        source:,
         # `null` when the schema field is nil (the context usually sets it to `{}`).
-        sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
-        attr_accessor :meta
+        meta: nil
+      )
+      end
 
-        sig do
-          params(
+      sig do
+        override.returns(
+          {
             id: String,
             actor: String,
             event_type:
-              Telnyx::Models::EmailBlockRetrieveEventsResponse::Data::EventType::OrSymbol,
+              Telnyx::Models::EmailBlockRetrieveEventsResponse::EventType::TaggedSymbol,
             occurred_at: Time,
             reason: String,
             record_type:
-              Telnyx::Models::EmailBlockRetrieveEventsResponse::Data::RecordType::OrSymbol,
+              Telnyx::Models::EmailBlockRetrieveEventsResponse::RecordType::TaggedSymbol,
             source: String,
             meta: T.nilable(T::Hash[Symbol, T.anything])
-          ).returns(T.attached_class)
-        end
-        def self.new(
-          id:,
-          # Free-text (`user_id`/`org_id`/`api_key`/`dev_bypass`/`system`/`manual`).
-          actor:,
-          event_type:,
-          occurred_at:,
-          # Free-text snapshot of the block's reason at event time.
-          reason:,
-          # View-only.
-          record_type:,
-          # Free-text snapshot of the block's source at event time.
-          source:,
-          # `null` when the schema field is nil (the context usually sets it to `{}`).
-          meta: nil
+          }
         )
-        end
+      end
+      def to_hash
+      end
+
+      module EventType
+        extend Telnyx::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(
+              Symbol,
+              Telnyx::Models::EmailBlockRetrieveEventsResponse::EventType
+            )
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        CREATED =
+          T.let(
+            :created,
+            Telnyx::Models::EmailBlockRetrieveEventsResponse::EventType::TaggedSymbol
+          )
+        REMOVED =
+          T.let(
+            :removed,
+            Telnyx::Models::EmailBlockRetrieveEventsResponse::EventType::TaggedSymbol
+          )
+        EXPIRED =
+          T.let(
+            :expired,
+            Telnyx::Models::EmailBlockRetrieveEventsResponse::EventType::TaggedSymbol
+          )
+        OVERRIDE_USED =
+          T.let(
+            :override_used,
+            Telnyx::Models::EmailBlockRetrieveEventsResponse::EventType::TaggedSymbol
+          )
 
         sig do
           override.returns(
-            {
-              id: String,
-              actor: String,
-              event_type:
-                Telnyx::Models::EmailBlockRetrieveEventsResponse::Data::EventType::TaggedSymbol,
-              occurred_at: Time,
-              reason: String,
-              record_type:
-                Telnyx::Models::EmailBlockRetrieveEventsResponse::Data::RecordType::TaggedSymbol,
-              source: String,
-              meta: T.nilable(T::Hash[Symbol, T.anything])
-            }
+            T::Array[
+              Telnyx::Models::EmailBlockRetrieveEventsResponse::EventType::TaggedSymbol
+            ]
           )
         end
-        def to_hash
+        def self.values
         end
+      end
 
-        module EventType
-          extend Telnyx::Internal::Type::Enum
-
-          TaggedSymbol =
-            T.type_alias do
-              T.all(
-                Symbol,
-                Telnyx::Models::EmailBlockRetrieveEventsResponse::Data::EventType
-              )
-            end
-          OrSymbol = T.type_alias { T.any(Symbol, String) }
-
-          CREATED =
-            T.let(
-              :created,
-              Telnyx::Models::EmailBlockRetrieveEventsResponse::Data::EventType::TaggedSymbol
-            )
-          REMOVED =
-            T.let(
-              :removed,
-              Telnyx::Models::EmailBlockRetrieveEventsResponse::Data::EventType::TaggedSymbol
-            )
-          EXPIRED =
-            T.let(
-              :expired,
-              Telnyx::Models::EmailBlockRetrieveEventsResponse::Data::EventType::TaggedSymbol
-            )
-          OVERRIDE_USED =
-            T.let(
-              :override_used,
-              Telnyx::Models::EmailBlockRetrieveEventsResponse::Data::EventType::TaggedSymbol
-            )
+      # View-only.
+      module RecordType
+        extend Telnyx::Internal::Type::Enum
 
-          sig do
-            override.returns(
-              T::Array[
-                Telnyx::Models::EmailBlockRetrieveEventsResponse::Data::EventType::TaggedSymbol
-              ]
+        TaggedSymbol =
+          T.type_alias do
+            T.all(
+              Symbol,
+              Telnyx::Models::EmailBlockRetrieveEventsResponse::RecordType
             )
           end
-          def self.values
-          end
-        end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
 
-        # View-only.
-        module RecordType
-          extend Telnyx::Internal::Type::Enum
-
-          TaggedSymbol =
-            T.type_alias do
-              T.all(
-                Symbol,
-                Telnyx::Models::EmailBlockRetrieveEventsResponse::Data::RecordType
-              )
-            end
-          OrSymbol = T.type_alias { T.any(Symbol, String) }
-
-          EMAIL_BLOCK_EVENT =
-            T.let(
-              :email_block_event,
-              Telnyx::Models::EmailBlockRetrieveEventsResponse::Data::RecordType::TaggedSymbol
-            )
+        EMAIL_BLOCK_EVENT =
+          T.let(
+            :email_block_event,
+            Telnyx::Models::EmailBlockRetrieveEventsResponse::RecordType::TaggedSymbol
+          )
 
-          sig do
-            override.returns(
-              T::Array[
-                Telnyx::Models::EmailBlockRetrieveEventsResponse::Data::RecordType::TaggedSymbol
-              ]
-            )
-          end
-          def self.values
-          end
+        sig do
+          override.returns(
+            T::Array[
+              Telnyx::Models::EmailBlockRetrieveEventsResponse::RecordType::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
         end
       end
     end

data/rbi/telnyx/models/email_blocks/email_block_import.rbi

@@ -0,0 +1,307 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    EmailBlockImport = EmailBlocks::EmailBlockImport
+
+    module EmailBlocks
+      class EmailBlockImport < Telnyx::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Telnyx::EmailBlocks::EmailBlockImport,
+              Telnyx::Internal::AnyHash
+            )
+          end
+
+        sig { returns(String) }
+        attr_accessor :id
+
+        sig { returns(Time) }
+        attr_accessor :created_at
+
+        # View-only.
+        sig do
+          returns(
+            Telnyx::EmailBlocks::EmailBlockImport::RecordType::TaggedSymbol
+          )
+        end
+        attr_accessor :record_type
+
+        sig do
+          returns(Telnyx::EmailBlocks::EmailBlockImport::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::EmailBlockImport::Provider::TaggedSymbol
+            )
+          )
+        end
+        attr_reader :provider
+
+        sig do
+          params(
+            provider: Telnyx::EmailBlocks::EmailBlockImport::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::EmailBlockImport::RecordType::OrSymbol,
+            status: Telnyx::EmailBlocks::EmailBlockImport::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::EmailBlockImport::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::EmailBlockImport::RecordType::TaggedSymbol,
+              status:
+                Telnyx::EmailBlocks::EmailBlockImport::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::EmailBlockImport::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::EmailBlockImport::RecordType)
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          EMAIL_BLOCK_IMPORT =
+            T.let(
+              :email_block_import,
+              Telnyx::EmailBlocks::EmailBlockImport::RecordType::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                Telnyx::EmailBlocks::EmailBlockImport::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::EmailBlockImport::Status)
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          PENDING =
+            T.let(
+              :pending,
+              Telnyx::EmailBlocks::EmailBlockImport::Status::TaggedSymbol
+            )
+          PROCESSING =
+            T.let(
+              :processing,
+              Telnyx::EmailBlocks::EmailBlockImport::Status::TaggedSymbol
+            )
+          COMPLETED =
+            T.let(
+              :completed,
+              Telnyx::EmailBlocks::EmailBlockImport::Status::TaggedSymbol
+            )
+          FAILED =
+            T.let(
+              :failed,
+              Telnyx::EmailBlocks::EmailBlockImport::Status::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                Telnyx::EmailBlocks::EmailBlockImport::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::EmailBlockImport::Provider)
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          SENDGRID =
+            T.let(
+              :sendgrid,
+              Telnyx::EmailBlocks::EmailBlockImport::Provider::TaggedSymbol
+            )
+          MAILGUN =
+            T.let(
+              :mailgun,
+              Telnyx::EmailBlocks::EmailBlockImport::Provider::TaggedSymbol
+            )
+          SES =
+            T.let(
+              :ses,
+              Telnyx::EmailBlocks::EmailBlockImport::Provider::TaggedSymbol
+            )
+          GENERIC =
+            T.let(
+              :generic,
+              Telnyx::EmailBlocks::EmailBlockImport::Provider::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                Telnyx::EmailBlocks::EmailBlockImport::Provider::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+    end
+  end
+end