ark-email 0.16.0 → 0.18.0

data/rbi/ark_email/models/email_retrieve_response.rbi

@@ -774,6 +774,25 @@ module ArkEmail
           sig { returns(Time) }
           attr_accessor :timestamp_iso
 
+          # Bounce classification category (present for failed deliveries). Helps understand
+          # why delivery failed for analytics and automated handling.
+          sig do
+            returns(
+              T.nilable(
+                ArkEmail::Models::EmailRetrieveResponse::Data::Delivery::Classification::TaggedSymbol
+              )
+            )
+          end
+          attr_accessor :classification
+
+          # Numeric bounce classification code for programmatic handling. Codes:
+          # 10=invalid_recipient, 11=no_mailbox, 12=not_accepting_mail, 20=mailbox_full,
+          # 21=message_too_large, 30=spam_block, 31=policy_violation, 32=tls_required,
+          # 40=connection_error, 41=dns_error, 42=temporarily_unavailable,
+          # 50=protocol_error, 99=unclassified
+          sig { returns(T.nilable(Integer)) }
+          attr_accessor :classification_code
+
           # SMTP response code
           sig { returns(T.nilable(Integer)) }
           attr_reader :code
@@ -781,20 +800,29 @@ module ArkEmail
           sig { params(code: Integer).void }
           attr_writer :code
 
-          # Status details
+          # Human-readable delivery summary. Format varies by status:
+          #
+          # - **sent**: `Message for {recipient} accepted by {ip}:{port} ({hostname})`
+          # - **softfail/hardfail**:
+          #   `{code} {classification}: Delivery to {recipient} failed at {ip}:{port} ({hostname})`
           sig { returns(T.nilable(String)) }
           attr_reader :details
 
           sig { params(details: String).void }
           attr_writer :details
 
-          # SMTP server response from the receiving mail server
+          # Raw SMTP response from the receiving mail server
           sig { returns(T.nilable(String)) }
           attr_reader :output
 
           sig { params(output: String).void }
           attr_writer :output
 
+          # Hostname of the remote mail server that processed the delivery. Present for all
+          # delivery attempts (successful and failed).
+          sig { returns(T.nilable(String)) }
+          attr_accessor :remote_host
+
           # Whether TLS was used
           sig { returns(T.nilable(T::Boolean)) }
           attr_reader :sent_with_ssl
@@ -802,16 +830,29 @@ module ArkEmail
           sig { params(sent_with_ssl: T::Boolean).void }
           attr_writer :sent_with_ssl
 
+          # RFC 3463 enhanced status code from SMTP response (e.g., "5.1.1", "4.2.2"). First
+          # digit: 2=success, 4=temporary, 5=permanent. Second digit: category (1=address,
+          # 2=mailbox, 7=security, etc.).
+          sig { returns(T.nilable(String)) }
+          attr_accessor :smtp_enhanced_code
+
           sig do
             params(
               id: String,
               status: String,
               timestamp: Float,
               timestamp_iso: Time,
+              classification:
+                T.nilable(
+                  ArkEmail::Models::EmailRetrieveResponse::Data::Delivery::Classification::OrSymbol
+                ),
+              classification_code: T.nilable(Integer),
               code: Integer,
               details: String,
               output: String,
-              sent_with_ssl: T::Boolean
+              remote_host: T.nilable(String),
+              sent_with_ssl: T::Boolean,
+              smtp_enhanced_code: T.nilable(String)
             ).returns(T.attached_class)
           end
           def self.new(
@@ -823,14 +864,34 @@ module ArkEmail
             timestamp:,
             # ISO 8601 timestamp
             timestamp_iso:,
+            # Bounce classification category (present for failed deliveries). Helps understand
+            # why delivery failed for analytics and automated handling.
+            classification: nil,
+            # Numeric bounce classification code for programmatic handling. Codes:
+            # 10=invalid_recipient, 11=no_mailbox, 12=not_accepting_mail, 20=mailbox_full,
+            # 21=message_too_large, 30=spam_block, 31=policy_violation, 32=tls_required,
+            # 40=connection_error, 41=dns_error, 42=temporarily_unavailable,
+            # 50=protocol_error, 99=unclassified
+            classification_code: nil,
             # SMTP response code
             code: nil,
-            # Status details
+            # Human-readable delivery summary. Format varies by status:
+            #
+            # - **sent**: `Message for {recipient} accepted by {ip}:{port} ({hostname})`
+            # - **softfail/hardfail**:
+            #   `{code} {classification}: Delivery to {recipient} failed at {ip}:{port} ({hostname})`
             details: nil,
-            # SMTP server response from the receiving mail server
+            # Raw SMTP response from the receiving mail server
             output: nil,
+            # Hostname of the remote mail server that processed the delivery. Present for all
+            # delivery attempts (successful and failed).
+            remote_host: nil,
             # Whether TLS was used
-            sent_with_ssl: nil
+            sent_with_ssl: nil,
+            # RFC 3463 enhanced status code from SMTP response (e.g., "5.1.1", "4.2.2"). First
+            # digit: 2=success, 4=temporary, 5=permanent. Second digit: category (1=address,
+            # 2=mailbox, 7=security, etc.).
+            smtp_enhanced_code: nil
           )
           end
 
@@ -841,15 +902,113 @@ module ArkEmail
                 status: String,
                 timestamp: Float,
                 timestamp_iso: Time,
+                classification:
+                  T.nilable(
+                    ArkEmail::Models::EmailRetrieveResponse::Data::Delivery::Classification::TaggedSymbol
+                  ),
+                classification_code: T.nilable(Integer),
                 code: Integer,
                 details: String,
                 output: String,
-                sent_with_ssl: T::Boolean
+                remote_host: T.nilable(String),
+                sent_with_ssl: T::Boolean,
+                smtp_enhanced_code: T.nilable(String)
               }
             )
           end
           def to_hash
           end
+
+          # Bounce classification category (present for failed deliveries). Helps understand
+          # why delivery failed for analytics and automated handling.
+          module Classification
+            extend ArkEmail::Internal::Type::Enum
+
+            TaggedSymbol =
+              T.type_alias do
+                T.all(
+                  Symbol,
+                  ArkEmail::Models::EmailRetrieveResponse::Data::Delivery::Classification
+                )
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            INVALID_RECIPIENT =
+              T.let(
+                :invalid_recipient,
+                ArkEmail::Models::EmailRetrieveResponse::Data::Delivery::Classification::TaggedSymbol
+              )
+            MAILBOX_FULL =
+              T.let(
+                :mailbox_full,
+                ArkEmail::Models::EmailRetrieveResponse::Data::Delivery::Classification::TaggedSymbol
+              )
+            MESSAGE_TOO_LARGE =
+              T.let(
+                :message_too_large,
+                ArkEmail::Models::EmailRetrieveResponse::Data::Delivery::Classification::TaggedSymbol
+              )
+            SPAM_BLOCK =
+              T.let(
+                :spam_block,
+                ArkEmail::Models::EmailRetrieveResponse::Data::Delivery::Classification::TaggedSymbol
+              )
+            POLICY_VIOLATION =
+              T.let(
+                :policy_violation,
+                ArkEmail::Models::EmailRetrieveResponse::Data::Delivery::Classification::TaggedSymbol
+              )
+            NO_MAILBOX =
+              T.let(
+                :no_mailbox,
+                ArkEmail::Models::EmailRetrieveResponse::Data::Delivery::Classification::TaggedSymbol
+              )
+            NOT_ACCEPTING_MAIL =
+              T.let(
+                :not_accepting_mail,
+                ArkEmail::Models::EmailRetrieveResponse::Data::Delivery::Classification::TaggedSymbol
+              )
+            TEMPORARILY_UNAVAILABLE =
+              T.let(
+                :temporarily_unavailable,
+                ArkEmail::Models::EmailRetrieveResponse::Data::Delivery::Classification::TaggedSymbol
+              )
+            PROTOCOL_ERROR =
+              T.let(
+                :protocol_error,
+                ArkEmail::Models::EmailRetrieveResponse::Data::Delivery::Classification::TaggedSymbol
+              )
+            TLS_REQUIRED =
+              T.let(
+                :tls_required,
+                ArkEmail::Models::EmailRetrieveResponse::Data::Delivery::Classification::TaggedSymbol
+              )
+            CONNECTION_ERROR =
+              T.let(
+                :connection_error,
+                ArkEmail::Models::EmailRetrieveResponse::Data::Delivery::Classification::TaggedSymbol
+              )
+            DNS_ERROR =
+              T.let(
+                :dns_error,
+                ArkEmail::Models::EmailRetrieveResponse::Data::Delivery::Classification::TaggedSymbol
+              )
+            UNCLASSIFIED =
+              T.let(
+                :unclassified,
+                ArkEmail::Models::EmailRetrieveResponse::Data::Delivery::Classification::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  ArkEmail::Models::EmailRetrieveResponse::Data::Delivery::Classification::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
+          end
         end
       end
     end

data/rbi/ark_email/models/tenant.rbi

@@ -0,0 +1,121 @@
+# typed: strong
+
+module ArkEmail
+  module Models
+    class Tenant < ArkEmail::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias { T.any(ArkEmail::Tenant, ArkEmail::Internal::AnyHash) }
+
+      # Unique identifier for the tenant
+      sig { returns(String) }
+      attr_accessor :id
+
+      # When the tenant was created
+      sig { returns(Time) }
+      attr_accessor :created_at
+
+      # Custom key-value pairs for storing additional data
+      sig do
+        returns(
+          T::Hash[Symbol, T.nilable(ArkEmail::Tenant::Metadata::Variants)]
+        )
+      end
+      attr_accessor :metadata
+
+      # Display name for the tenant
+      sig { returns(String) }
+      attr_accessor :name
+
+      # Current status of the tenant:
+      #
+      # - `active` - Normal operation
+      # - `suspended` - Temporarily disabled
+      # - `archived` - Soft-deleted
+      sig { returns(ArkEmail::Tenant::Status::TaggedSymbol) }
+      attr_accessor :status
+
+      # When the tenant was last updated
+      sig { returns(Time) }
+      attr_accessor :updated_at
+
+      sig do
+        params(
+          id: String,
+          created_at: Time,
+          metadata:
+            T::Hash[Symbol, T.nilable(ArkEmail::Tenant::Metadata::Variants)],
+          name: String,
+          status: ArkEmail::Tenant::Status::OrSymbol,
+          updated_at: Time
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Unique identifier for the tenant
+        id:,
+        # When the tenant was created
+        created_at:,
+        # Custom key-value pairs for storing additional data
+        metadata:,
+        # Display name for the tenant
+        name:,
+        # Current status of the tenant:
+        #
+        # - `active` - Normal operation
+        # - `suspended` - Temporarily disabled
+        # - `archived` - Soft-deleted
+        status:,
+        # When the tenant was last updated
+        updated_at:
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            id: String,
+            created_at: Time,
+            metadata:
+              T::Hash[Symbol, T.nilable(ArkEmail::Tenant::Metadata::Variants)],
+            name: String,
+            status: ArkEmail::Tenant::Status::TaggedSymbol,
+            updated_at: Time
+          }
+        )
+      end
+      def to_hash
+      end
+
+      module Metadata
+        extend ArkEmail::Internal::Type::Union
+
+        Variants = T.type_alias { T.any(String, Float, T::Boolean) }
+
+        sig { override.returns(T::Array[ArkEmail::Tenant::Metadata::Variants]) }
+        def self.variants
+        end
+      end
+
+      # Current status of the tenant:
+      #
+      # - `active` - Normal operation
+      # - `suspended` - Temporarily disabled
+      # - `archived` - Soft-deleted
+      module Status
+        extend ArkEmail::Internal::Type::Enum
+
+        TaggedSymbol = T.type_alias { T.all(Symbol, ArkEmail::Tenant::Status) }
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        ACTIVE = T.let(:active, ArkEmail::Tenant::Status::TaggedSymbol)
+        SUSPENDED = T.let(:suspended, ArkEmail::Tenant::Status::TaggedSymbol)
+        ARCHIVED = T.let(:archived, ArkEmail::Tenant::Status::TaggedSymbol)
+
+        sig do
+          override.returns(T::Array[ArkEmail::Tenant::Status::TaggedSymbol])
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/ark_email/models/tenant_create_params.rbi

@@ -0,0 +1,100 @@
+# typed: strong
+
+module ArkEmail
+  module Models
+    class TenantCreateParams < ArkEmail::Internal::Type::BaseModel
+      extend ArkEmail::Internal::Type::RequestParameters::Converter
+      include ArkEmail::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(ArkEmail::TenantCreateParams, ArkEmail::Internal::AnyHash)
+        end
+
+      # Display name for the tenant (e.g., your customer's company name)
+      sig { returns(String) }
+      attr_accessor :name
+
+      # Custom key-value pairs. Useful for storing references to your internal systems.
+      #
+      # **Limits:**
+      #
+      # - Max 50 keys
+      # - Key names max 40 characters
+      # - String values max 500 characters
+      # - Total size max 8KB
+      sig do
+        returns(
+          T.nilable(
+            T::Hash[
+              Symbol,
+              T.nilable(ArkEmail::TenantCreateParams::Metadata::Variants)
+            ]
+          )
+        )
+      end
+      attr_accessor :metadata
+
+      sig do
+        params(
+          name: String,
+          metadata:
+            T.nilable(
+              T::Hash[
+                Symbol,
+                T.nilable(ArkEmail::TenantCreateParams::Metadata::Variants)
+              ]
+            ),
+          request_options: ArkEmail::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Display name for the tenant (e.g., your customer's company name)
+        name:,
+        # Custom key-value pairs. Useful for storing references to your internal systems.
+        #
+        # **Limits:**
+        #
+        # - Max 50 keys
+        # - Key names max 40 characters
+        # - String values max 500 characters
+        # - Total size max 8KB
+        metadata: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            name: String,
+            metadata:
+              T.nilable(
+                T::Hash[
+                  Symbol,
+                  T.nilable(ArkEmail::TenantCreateParams::Metadata::Variants)
+                ]
+              ),
+            request_options: ArkEmail::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+
+      module Metadata
+        extend ArkEmail::Internal::Type::Union
+
+        Variants = T.type_alias { T.any(String, Float, T::Boolean) }
+
+        sig do
+          override.returns(
+            T::Array[ArkEmail::TenantCreateParams::Metadata::Variants]
+          )
+        end
+        def self.variants
+        end
+      end
+    end
+  end
+end

data/rbi/ark_email/models/tenant_create_response.rbi

@@ -0,0 +1,52 @@
+# typed: strong
+
+module ArkEmail
+  module Models
+    class TenantCreateResponse < ArkEmail::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            ArkEmail::Models::TenantCreateResponse,
+            ArkEmail::Internal::AnyHash
+          )
+        end
+
+      sig { returns(ArkEmail::Tenant) }
+      attr_reader :data
+
+      sig { params(data: ArkEmail::Tenant::OrHash).void }
+      attr_writer :data
+
+      sig { returns(ArkEmail::APIMeta) }
+      attr_reader :meta
+
+      sig { params(meta: ArkEmail::APIMeta::OrHash).void }
+      attr_writer :meta
+
+      sig { returns(T::Boolean) }
+      attr_accessor :success
+
+      sig do
+        params(
+          data: ArkEmail::Tenant::OrHash,
+          meta: ArkEmail::APIMeta::OrHash,
+          success: T::Boolean
+        ).returns(T.attached_class)
+      end
+      def self.new(data:, meta:, success: true)
+      end
+
+      sig do
+        override.returns(
+          {
+            data: ArkEmail::Tenant,
+            meta: ArkEmail::APIMeta,
+            success: T::Boolean
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/ark_email/models/tenant_delete_params.rbi

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

data/rbi/ark_email/models/tenant_delete_response.rbi

@@ -0,0 +1,75 @@
+# typed: strong
+
+module ArkEmail
+  module Models
+    class TenantDeleteResponse < ArkEmail::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            ArkEmail::Models::TenantDeleteResponse,
+            ArkEmail::Internal::AnyHash
+          )
+        end
+
+      sig { returns(ArkEmail::Models::TenantDeleteResponse::Data) }
+      attr_reader :data
+
+      sig do
+        params(data: ArkEmail::Models::TenantDeleteResponse::Data::OrHash).void
+      end
+      attr_writer :data
+
+      sig { returns(ArkEmail::APIMeta) }
+      attr_reader :meta
+
+      sig { params(meta: ArkEmail::APIMeta::OrHash).void }
+      attr_writer :meta
+
+      sig { returns(T::Boolean) }
+      attr_accessor :success
+
+      sig do
+        params(
+          data: ArkEmail::Models::TenantDeleteResponse::Data::OrHash,
+          meta: ArkEmail::APIMeta::OrHash,
+          success: T::Boolean
+        ).returns(T.attached_class)
+      end
+      def self.new(data:, meta:, success: true)
+      end
+
+      sig do
+        override.returns(
+          {
+            data: ArkEmail::Models::TenantDeleteResponse::Data,
+            meta: ArkEmail::APIMeta,
+            success: T::Boolean
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class Data < ArkEmail::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              ArkEmail::Models::TenantDeleteResponse::Data,
+              ArkEmail::Internal::AnyHash
+            )
+          end
+
+        sig { returns(T::Boolean) }
+        attr_accessor :deleted
+
+        sig { params(deleted: T::Boolean).returns(T.attached_class) }
+        def self.new(deleted: true)
+        end
+
+        sig { override.returns({ deleted: T::Boolean }) }
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/ark_email/models/tenant_list_params.rbi

@@ -0,0 +1,92 @@
+# typed: strong
+
+module ArkEmail
+  module Models
+    class TenantListParams < ArkEmail::Internal::Type::BaseModel
+      extend ArkEmail::Internal::Type::RequestParameters::Converter
+      include ArkEmail::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(ArkEmail::TenantListParams, ArkEmail::Internal::AnyHash)
+        end
+
+      # Page number (1-indexed)
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :page
+
+      sig { params(page: Integer).void }
+      attr_writer :page
+
+      # Number of items per page (max 100)
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :per_page
+
+      sig { params(per_page: Integer).void }
+      attr_writer :per_page
+
+      # Filter by tenant status
+      sig { returns(T.nilable(ArkEmail::TenantListParams::Status::OrSymbol)) }
+      attr_reader :status
+
+      sig { params(status: ArkEmail::TenantListParams::Status::OrSymbol).void }
+      attr_writer :status
+
+      sig do
+        params(
+          page: Integer,
+          per_page: Integer,
+          status: ArkEmail::TenantListParams::Status::OrSymbol,
+          request_options: ArkEmail::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Page number (1-indexed)
+        page: nil,
+        # Number of items per page (max 100)
+        per_page: nil,
+        # Filter by tenant status
+        status: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            page: Integer,
+            per_page: Integer,
+            status: ArkEmail::TenantListParams::Status::OrSymbol,
+            request_options: ArkEmail::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+
+      # Filter by tenant status
+      module Status
+        extend ArkEmail::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias { T.all(Symbol, ArkEmail::TenantListParams::Status) }
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        ACTIVE =
+          T.let(:active, ArkEmail::TenantListParams::Status::TaggedSymbol)
+        SUSPENDED =
+          T.let(:suspended, ArkEmail::TenantListParams::Status::TaggedSymbol)
+        ARCHIVED =
+          T.let(:archived, ArkEmail::TenantListParams::Status::TaggedSymbol)
+
+        sig do
+          override.returns(
+            T::Array[ArkEmail::TenantListParams::Status::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end