ark-email 0.5.1

data/rbi/ark_email/models/email_send_response.rbi

@@ -0,0 +1,153 @@
+# typed: strong
+
+module ArkEmail
+  module Models
+    class EmailSendResponse < ArkEmail::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            ArkEmail::Models::EmailSendResponse,
+            ArkEmail::Internal::AnyHash
+          )
+        end
+
+      sig { returns(ArkEmail::Models::EmailSendResponse::Data) }
+      attr_reader :data
+
+      sig do
+        params(data: ArkEmail::Models::EmailSendResponse::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::EmailSendResponse::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::EmailSendResponse::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::EmailSendResponse::Data,
+              ArkEmail::Internal::AnyHash
+            )
+          end
+
+        # Unique message ID (format: msg*{id}*{token})
+        sig { returns(String) }
+        attr_accessor :id
+
+        # Current delivery status
+        sig do
+          returns(
+            ArkEmail::Models::EmailSendResponse::Data::Status::TaggedSymbol
+          )
+        end
+        attr_accessor :status
+
+        # List of recipient addresses
+        sig { returns(T::Array[String]) }
+        attr_accessor :to
+
+        # SMTP Message-ID header value
+        sig { returns(T.nilable(String)) }
+        attr_reader :message_id
+
+        sig { params(message_id: String).void }
+        attr_writer :message_id
+
+        sig do
+          params(
+            id: String,
+            status: ArkEmail::Models::EmailSendResponse::Data::Status::OrSymbol,
+            to: T::Array[String],
+            message_id: String
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Unique message ID (format: msg*{id}*{token})
+          id:,
+          # Current delivery status
+          status:,
+          # List of recipient addresses
+          to:,
+          # SMTP Message-ID header value
+          message_id: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              id: String,
+              status:
+                ArkEmail::Models::EmailSendResponse::Data::Status::TaggedSymbol,
+              to: T::Array[String],
+              message_id: String
+            }
+          )
+        end
+        def to_hash
+        end
+
+        # Current delivery status
+        module Status
+          extend ArkEmail::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(Symbol, ArkEmail::Models::EmailSendResponse::Data::Status)
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          PENDING =
+            T.let(
+              :pending,
+              ArkEmail::Models::EmailSendResponse::Data::Status::TaggedSymbol
+            )
+          SENT =
+            T.let(
+              :sent,
+              ArkEmail::Models::EmailSendResponse::Data::Status::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                ArkEmail::Models::EmailSendResponse::Data::Status::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/ark_email/models/suppression_bulk_create_params.rbi

@@ -0,0 +1,76 @@
+# typed: strong
+
+module ArkEmail
+  module Models
+    class SuppressionBulkCreateParams < ArkEmail::Internal::Type::BaseModel
+      extend ArkEmail::Internal::Type::RequestParameters::Converter
+      include ArkEmail::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            ArkEmail::SuppressionBulkCreateParams,
+            ArkEmail::Internal::AnyHash
+          )
+        end
+
+      sig do
+        returns(T::Array[ArkEmail::SuppressionBulkCreateParams::Suppression])
+      end
+      attr_accessor :suppressions
+
+      sig do
+        params(
+          suppressions:
+            T::Array[
+              ArkEmail::SuppressionBulkCreateParams::Suppression::OrHash
+            ],
+          request_options: ArkEmail::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(suppressions:, request_options: {})
+      end
+
+      sig do
+        override.returns(
+          {
+            suppressions:
+              T::Array[ArkEmail::SuppressionBulkCreateParams::Suppression],
+            request_options: ArkEmail::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class Suppression < ArkEmail::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              ArkEmail::SuppressionBulkCreateParams::Suppression,
+              ArkEmail::Internal::AnyHash
+            )
+          end
+
+        sig { returns(String) }
+        attr_accessor :address
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :reason
+
+        sig { params(reason: String).void }
+        attr_writer :reason
+
+        sig do
+          params(address: String, reason: String).returns(T.attached_class)
+        end
+        def self.new(address:, reason: nil)
+        end
+
+        sig { override.returns({ address: String, reason: String }) }
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/ark_email/models/suppression_bulk_create_response.rbi

@@ -0,0 +1,115 @@
+# typed: strong
+
+module ArkEmail
+  module Models
+    class SuppressionBulkCreateResponse < ArkEmail::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            ArkEmail::Models::SuppressionBulkCreateResponse,
+            ArkEmail::Internal::AnyHash
+          )
+        end
+
+      sig { returns(ArkEmail::Models::SuppressionBulkCreateResponse::Data) }
+      attr_reader :data
+
+      sig do
+        params(
+          data: ArkEmail::Models::SuppressionBulkCreateResponse::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::SuppressionBulkCreateResponse::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::SuppressionBulkCreateResponse::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::SuppressionBulkCreateResponse::Data,
+              ArkEmail::Internal::AnyHash
+            )
+          end
+
+        # Newly suppressed addresses
+        sig { returns(Integer) }
+        attr_accessor :added
+
+        # Invalid addresses skipped
+        sig { returns(Integer) }
+        attr_accessor :failed
+
+        # Total addresses in request
+        sig { returns(Integer) }
+        attr_accessor :total_requested
+
+        # Already suppressed addresses (updated reason)
+        sig { returns(Integer) }
+        attr_accessor :updated
+
+        sig do
+          params(
+            added: Integer,
+            failed: Integer,
+            total_requested: Integer,
+            updated: Integer
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Newly suppressed addresses
+          added:,
+          # Invalid addresses skipped
+          failed:,
+          # Total addresses in request
+          total_requested:,
+          # Already suppressed addresses (updated reason)
+          updated:
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              added: Integer,
+              failed: Integer,
+              total_requested: Integer,
+              updated: Integer
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/ark_email/models/suppression_create_params.rbi

@@ -0,0 +1,54 @@
+# typed: strong
+
+module ArkEmail
+  module Models
+    class SuppressionCreateParams < ArkEmail::Internal::Type::BaseModel
+      extend ArkEmail::Internal::Type::RequestParameters::Converter
+      include ArkEmail::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(ArkEmail::SuppressionCreateParams, ArkEmail::Internal::AnyHash)
+        end
+
+      # Email address to suppress
+      sig { returns(String) }
+      attr_accessor :address
+
+      # Reason for suppression
+      sig { returns(T.nilable(String)) }
+      attr_reader :reason
+
+      sig { params(reason: String).void }
+      attr_writer :reason
+
+      sig do
+        params(
+          address: String,
+          reason: String,
+          request_options: ArkEmail::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Email address to suppress
+        address:,
+        # Reason for suppression
+        reason: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            address: String,
+            reason: String,
+            request_options: ArkEmail::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/ark_email/models/suppression_create_response.rbi

@@ -0,0 +1,109 @@
+# typed: strong
+
+module ArkEmail
+  module Models
+    class SuppressionCreateResponse < ArkEmail::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            ArkEmail::Models::SuppressionCreateResponse,
+            ArkEmail::Internal::AnyHash
+          )
+        end
+
+      sig { returns(ArkEmail::Models::SuppressionCreateResponse::Data) }
+      attr_reader :data
+
+      sig do
+        params(
+          data: ArkEmail::Models::SuppressionCreateResponse::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::SuppressionCreateResponse::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::SuppressionCreateResponse::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::SuppressionCreateResponse::Data,
+              ArkEmail::Internal::AnyHash
+            )
+          end
+
+        # Suppression ID
+        sig { returns(String) }
+        attr_accessor :id
+
+        sig { returns(String) }
+        attr_accessor :address
+
+        sig { returns(Time) }
+        attr_accessor :created_at
+
+        # Reason for suppression
+        sig { returns(T.nilable(String)) }
+        attr_reader :reason
+
+        sig { params(reason: String).void }
+        attr_writer :reason
+
+        sig do
+          params(
+            id: String,
+            address: String,
+            created_at: Time,
+            reason: String
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Suppression ID
+          id:,
+          address:,
+          created_at:,
+          # Reason for suppression
+          reason: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            { id: String, address: String, created_at: Time, reason: String }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/ark_email/models/suppression_delete_params.rbi

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

@@ -0,0 +1,77 @@
+# typed: strong
+
+module ArkEmail
+  module Models
+    class SuppressionDeleteResponse < ArkEmail::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            ArkEmail::Models::SuppressionDeleteResponse,
+            ArkEmail::Internal::AnyHash
+          )
+        end
+
+      sig { returns(ArkEmail::Models::SuppressionDeleteResponse::Data) }
+      attr_reader :data
+
+      sig do
+        params(
+          data: ArkEmail::Models::SuppressionDeleteResponse::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::SuppressionDeleteResponse::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::SuppressionDeleteResponse::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::SuppressionDeleteResponse::Data,
+              ArkEmail::Internal::AnyHash
+            )
+          end
+
+        sig { returns(String) }
+        attr_accessor :message
+
+        sig { params(message: String).returns(T.attached_class) }
+        def self.new(message:)
+        end
+
+        sig { override.returns({ message: String }) }
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/ark_email/models/suppression_list_params.rbi

@@ -0,0 +1,49 @@
+# typed: strong
+
+module ArkEmail
+  module Models
+    class SuppressionListParams < ArkEmail::Internal::Type::BaseModel
+      extend ArkEmail::Internal::Type::RequestParameters::Converter
+      include ArkEmail::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(ArkEmail::SuppressionListParams, ArkEmail::Internal::AnyHash)
+        end
+
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :page
+
+      sig { params(page: Integer).void }
+      attr_writer :page
+
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :per_page
+
+      sig { params(per_page: Integer).void }
+      attr_writer :per_page
+
+      sig do
+        params(
+          page: Integer,
+          per_page: Integer,
+          request_options: ArkEmail::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(page: nil, per_page: nil, request_options: {})
+      end
+
+      sig do
+        override.returns(
+          {
+            page: Integer,
+            per_page: Integer,
+            request_options: ArkEmail::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/ark_email/models/suppression_list_response.rbi

@@ -0,0 +1,56 @@
+# typed: strong
+
+module ArkEmail
+  module Models
+    class SuppressionListResponse < ArkEmail::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            ArkEmail::Models::SuppressionListResponse,
+            ArkEmail::Internal::AnyHash
+          )
+        end
+
+      # Suppression ID
+      sig { returns(String) }
+      attr_accessor :id
+
+      sig { returns(String) }
+      attr_accessor :address
+
+      sig { returns(Time) }
+      attr_accessor :created_at
+
+      sig { returns(T.nilable(String)) }
+      attr_reader :reason
+
+      sig { params(reason: String).void }
+      attr_writer :reason
+
+      sig do
+        params(
+          id: String,
+          address: String,
+          created_at: Time,
+          reason: String
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Suppression ID
+        id:,
+        address:,
+        created_at:,
+        reason: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          { id: String, address: String, created_at: Time, reason: String }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end