ark-email 0.16.0 → 0.18.0

data/rbi/ark_email/models/tenant_retrieve_params.rbi

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

@@ -0,0 +1,52 @@
+# typed: strong
+
+module ArkEmail
+  module Models
+    class TenantRetrieveResponse < ArkEmail::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            ArkEmail::Models::TenantRetrieveResponse,
+            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_update_params.rbi

@@ -0,0 +1,140 @@
+# typed: strong
+
+module ArkEmail
+  module Models
+    class TenantUpdateParams < ArkEmail::Internal::Type::BaseModel
+      extend ArkEmail::Internal::Type::RequestParameters::Converter
+      include ArkEmail::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(ArkEmail::TenantUpdateParams, ArkEmail::Internal::AnyHash)
+        end
+
+      # 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::TenantUpdateParams::Metadata::Variants)
+            ]
+          )
+        )
+      end
+      attr_accessor :metadata
+
+      # Display name for the tenant
+      sig { returns(T.nilable(String)) }
+      attr_reader :name
+
+      sig { params(name: String).void }
+      attr_writer :name
+
+      # Tenant status
+      sig { returns(T.nilable(ArkEmail::TenantUpdateParams::Status::OrSymbol)) }
+      attr_reader :status
+
+      sig do
+        params(status: ArkEmail::TenantUpdateParams::Status::OrSymbol).void
+      end
+      attr_writer :status
+
+      sig do
+        params(
+          metadata:
+            T.nilable(
+              T::Hash[
+                Symbol,
+                T.nilable(ArkEmail::TenantUpdateParams::Metadata::Variants)
+              ]
+            ),
+          name: String,
+          status: ArkEmail::TenantUpdateParams::Status::OrSymbol,
+          request_options: ArkEmail::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # 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,
+        # Display name for the tenant
+        name: nil,
+        # Tenant status
+        status: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            metadata:
+              T.nilable(
+                T::Hash[
+                  Symbol,
+                  T.nilable(ArkEmail::TenantUpdateParams::Metadata::Variants)
+                ]
+              ),
+            name: String,
+            status: ArkEmail::TenantUpdateParams::Status::OrSymbol,
+            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::TenantUpdateParams::Metadata::Variants]
+          )
+        end
+        def self.variants
+        end
+      end
+
+      # Tenant status
+      module Status
+        extend ArkEmail::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias { T.all(Symbol, ArkEmail::TenantUpdateParams::Status) }
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        ACTIVE =
+          T.let(:active, ArkEmail::TenantUpdateParams::Status::TaggedSymbol)
+        SUSPENDED =
+          T.let(:suspended, ArkEmail::TenantUpdateParams::Status::TaggedSymbol)
+        ARCHIVED =
+          T.let(:archived, ArkEmail::TenantUpdateParams::Status::TaggedSymbol)
+
+        sig do
+          override.returns(
+            T::Array[ArkEmail::TenantUpdateParams::Status::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/ark_email/models/tenant_update_response.rbi

@@ -0,0 +1,52 @@
+# typed: strong
+
+module ArkEmail
+  module Models
+    class TenantUpdateResponse < ArkEmail::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            ArkEmail::Models::TenantUpdateResponse,
+            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.rbi

@@ -48,6 +48,18 @@ module ArkEmail
 
   SuppressionRetrieveParams = ArkEmail::Models::SuppressionRetrieveParams
 
+  Tenant = ArkEmail::Models::Tenant
+
+  TenantCreateParams = ArkEmail::Models::TenantCreateParams
+
+  TenantDeleteParams = ArkEmail::Models::TenantDeleteParams
+
+  TenantListParams = ArkEmail::Models::TenantListParams
+
+  TenantRetrieveParams = ArkEmail::Models::TenantRetrieveParams
+
+  TenantUpdateParams = ArkEmail::Models::TenantUpdateParams
+
   TrackDomain = ArkEmail::Models::TrackDomain
 
   TrackingCreateParams = ArkEmail::Models::TrackingCreateParams

data/rbi/ark_email/resources/tenants.rbi

@@ -0,0 +1,131 @@
+# typed: strong
+
+module ArkEmail
+  module Resources
+    class Tenants
+      # Create a new tenant.
+      #
+      # Returns the created tenant with a unique `id`. Store this ID in your database to
+      # reference this tenant later.
+      sig do
+        params(
+          name: String,
+          metadata:
+            T.nilable(
+              T::Hash[
+                Symbol,
+                T.nilable(ArkEmail::TenantCreateParams::Metadata::Variants)
+              ]
+            ),
+          request_options: ArkEmail::RequestOptions::OrHash
+        ).returns(ArkEmail::Models::TenantCreateResponse)
+      end
+      def create(
+        # 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
+
+      # Get a tenant by ID.
+      sig do
+        params(
+          tenant_id: String,
+          request_options: ArkEmail::RequestOptions::OrHash
+        ).returns(ArkEmail::Models::TenantRetrieveResponse)
+      end
+      def retrieve(
+        # The tenant ID
+        tenant_id,
+        request_options: {}
+      )
+      end
+
+      # Update a tenant's name, metadata, or status. At least one field is required.
+      #
+      # Metadata is replaced entirely—include all keys you want to keep.
+      sig do
+        params(
+          tenant_id: String,
+          metadata:
+            T.nilable(
+              T::Hash[
+                Symbol,
+                T.nilable(ArkEmail::TenantUpdateParams::Metadata::Variants)
+              ]
+            ),
+          name: String,
+          status: ArkEmail::TenantUpdateParams::Status::OrSymbol,
+          request_options: ArkEmail::RequestOptions::OrHash
+        ).returns(ArkEmail::Models::TenantUpdateResponse)
+      end
+      def update(
+        # The tenant ID
+        tenant_id,
+        # 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,
+        # Display name for the tenant
+        name: nil,
+        # Tenant status
+        status: nil,
+        request_options: {}
+      )
+      end
+
+      # List all tenants with pagination. Filter by `status` if needed.
+      sig do
+        params(
+          page: Integer,
+          per_page: Integer,
+          status: ArkEmail::TenantListParams::Status::OrSymbol,
+          request_options: ArkEmail::RequestOptions::OrHash
+        ).returns(ArkEmail::Internal::PageNumberPagination[ArkEmail::Tenant])
+      end
+      def list(
+        # 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
+
+      # Permanently delete a tenant. This cannot be undone.
+      sig do
+        params(
+          tenant_id: String,
+          request_options: ArkEmail::RequestOptions::OrHash
+        ).returns(ArkEmail::Models::TenantDeleteResponse)
+      end
+      def delete(
+        # The tenant ID
+        tenant_id,
+        request_options: {}
+      )
+      end
+
+      # @api private
+      sig { params(client: ArkEmail::Client).returns(T.attached_class) }
+      def self.new(client:)
+      end
+    end
+  end
+end

data/sig/ark_email/client.rbs

@@ -24,6 +24,8 @@ module ArkEmail
 
     attr_reader usage: ArkEmail::Resources::Usage
 
+    attr_reader tenants: ArkEmail::Resources::Tenants
+
     private def auth_headers: -> ::Hash[String, String]
 
     def initialize: (

data/sig/ark_email/models/email_retrieve_deliveries_response.rbs

@@ -68,10 +68,14 @@ module ArkEmail
             status: String,
             timestamp: Float,
             timestamp_iso: Time,
+            classification: ArkEmail::Models::EmailRetrieveDeliveriesResponse::Data::Delivery::classification?,
+            classification_code: Integer?,
             code: Integer,
             details: String,
             output: String,
-            sent_with_ssl: bool
+            remote_host: String?,
+            sent_with_ssl: bool,
+            smtp_enhanced_code: String?
           }
 
         class Delivery < ArkEmail::Internal::Type::BaseModel
@@ -83,6 +87,10 @@ module ArkEmail
 
           attr_accessor timestamp_iso: Time
 
+          attr_accessor classification: ArkEmail::Models::EmailRetrieveDeliveriesResponse::Data::Delivery::classification?
+
+          attr_accessor classification_code: Integer?
+
           attr_reader code: Integer?
 
           def code=: (Integer) -> Integer
@@ -95,19 +103,27 @@ module ArkEmail
 
           def output=: (String) -> String
 
+          attr_accessor remote_host: String?
+
           attr_reader sent_with_ssl: bool?
 
           def sent_with_ssl=: (bool) -> bool
 
+          attr_accessor smtp_enhanced_code: String?
+
           def initialize: (
             id: String,
             status: String,
             timestamp: Float,
             timestamp_iso: Time,
+            ?classification: ArkEmail::Models::EmailRetrieveDeliveriesResponse::Data::Delivery::classification?,
+            ?classification_code: Integer?,
             ?code: Integer,
             ?details: String,
             ?output: String,
-            ?sent_with_ssl: bool
+            ?remote_host: String?,
+            ?sent_with_ssl: bool,
+            ?smtp_enhanced_code: String?
           ) -> void
 
           def to_hash: -> {
@@ -115,11 +131,50 @@ module ArkEmail
             status: String,
             timestamp: Float,
             timestamp_iso: Time,
+            classification: ArkEmail::Models::EmailRetrieveDeliveriesResponse::Data::Delivery::classification?,
+            classification_code: Integer?,
             code: Integer,
             details: String,
             output: String,
-            sent_with_ssl: bool
+            remote_host: String?,
+            sent_with_ssl: bool,
+            smtp_enhanced_code: String?
           }
+
+          type classification =
+            :invalid_recipient
+            | :mailbox_full
+            | :message_too_large
+            | :spam_block
+            | :policy_violation
+            | :no_mailbox
+            | :not_accepting_mail
+            | :temporarily_unavailable
+            | :protocol_error
+            | :tls_required
+            | :connection_error
+            | :dns_error
+            | :unclassified
+
+          module Classification
+            extend ArkEmail::Internal::Type::Enum
+
+            INVALID_RECIPIENT: :invalid_recipient
+            MAILBOX_FULL: :mailbox_full
+            MESSAGE_TOO_LARGE: :message_too_large
+            SPAM_BLOCK: :spam_block
+            POLICY_VIOLATION: :policy_violation
+            NO_MAILBOX: :no_mailbox
+            NOT_ACCEPTING_MAIL: :not_accepting_mail
+            TEMPORARILY_UNAVAILABLE: :temporarily_unavailable
+            PROTOCOL_ERROR: :protocol_error
+            TLS_REQUIRED: :tls_required
+            CONNECTION_ERROR: :connection_error
+            DNS_ERROR: :dns_error
+            UNCLASSIFIED: :unclassified
+
+            def self?.values: -> ::Array[ArkEmail::Models::EmailRetrieveDeliveriesResponse::Data::Delivery::classification]
+          end
         end
 
         type retry_state =

data/sig/ark_email/models/email_retrieve_response.rbs

@@ -347,10 +347,14 @@ module ArkEmail
             status: String,
             timestamp: Float,
             timestamp_iso: Time,
+            classification: ArkEmail::Models::EmailRetrieveResponse::Data::Delivery::classification?,
+            classification_code: Integer?,
             code: Integer,
             details: String,
             output: String,
-            sent_with_ssl: bool
+            remote_host: String?,
+            sent_with_ssl: bool,
+            smtp_enhanced_code: String?
           }
 
         class Delivery < ArkEmail::Internal::Type::BaseModel
@@ -362,6 +366,10 @@ module ArkEmail
 
           attr_accessor timestamp_iso: Time
 
+          attr_accessor classification: ArkEmail::Models::EmailRetrieveResponse::Data::Delivery::classification?
+
+          attr_accessor classification_code: Integer?
+
           attr_reader code: Integer?
 
           def code=: (Integer) -> Integer
@@ -374,19 +382,27 @@ module ArkEmail
 
           def output=: (String) -> String
 
+          attr_accessor remote_host: String?
+
           attr_reader sent_with_ssl: bool?
 
           def sent_with_ssl=: (bool) -> bool
 
+          attr_accessor smtp_enhanced_code: String?
+
           def initialize: (
             id: String,
             status: String,
             timestamp: Float,
             timestamp_iso: Time,
+            ?classification: ArkEmail::Models::EmailRetrieveResponse::Data::Delivery::classification?,
+            ?classification_code: Integer?,
             ?code: Integer,
             ?details: String,
             ?output: String,
-            ?sent_with_ssl: bool
+            ?remote_host: String?,
+            ?sent_with_ssl: bool,
+            ?smtp_enhanced_code: String?
           ) -> void
 
           def to_hash: -> {
@@ -394,11 +410,50 @@ module ArkEmail
             status: String,
             timestamp: Float,
             timestamp_iso: Time,
+            classification: ArkEmail::Models::EmailRetrieveResponse::Data::Delivery::classification?,
+            classification_code: Integer?,
             code: Integer,
             details: String,
             output: String,
-            sent_with_ssl: bool
+            remote_host: String?,
+            sent_with_ssl: bool,
+            smtp_enhanced_code: String?
           }
+
+          type classification =
+            :invalid_recipient
+            | :mailbox_full
+            | :message_too_large
+            | :spam_block
+            | :policy_violation
+            | :no_mailbox
+            | :not_accepting_mail
+            | :temporarily_unavailable
+            | :protocol_error
+            | :tls_required
+            | :connection_error
+            | :dns_error
+            | :unclassified
+
+          module Classification
+            extend ArkEmail::Internal::Type::Enum
+
+            INVALID_RECIPIENT: :invalid_recipient
+            MAILBOX_FULL: :mailbox_full
+            MESSAGE_TOO_LARGE: :message_too_large
+            SPAM_BLOCK: :spam_block
+            POLICY_VIOLATION: :policy_violation
+            NO_MAILBOX: :no_mailbox
+            NOT_ACCEPTING_MAIL: :not_accepting_mail
+            TEMPORARILY_UNAVAILABLE: :temporarily_unavailable
+            PROTOCOL_ERROR: :protocol_error
+            TLS_REQUIRED: :tls_required
+            CONNECTION_ERROR: :connection_error
+            DNS_ERROR: :dns_error
+            UNCLASSIFIED: :unclassified
+
+            def self?.values: -> ::Array[ArkEmail::Models::EmailRetrieveResponse::Data::Delivery::classification]
+          end
         end
       end
     end