ark-email 0.7.0 → 0.9.0

data/rbi/ark_email/models/webhook_list_deliveries_params.rbi

@@ -0,0 +1,172 @@
+# typed: strong
+
+module ArkEmail
+  module Models
+    class WebhookListDeliveriesParams < ArkEmail::Internal::Type::BaseModel
+      extend ArkEmail::Internal::Type::RequestParameters::Converter
+      include ArkEmail::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            ArkEmail::WebhookListDeliveriesParams,
+            ArkEmail::Internal::AnyHash
+          )
+        end
+
+      # Only deliveries after this Unix timestamp
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :after
+
+      sig { params(after: Integer).void }
+      attr_writer :after
+
+      # Only deliveries before this Unix timestamp
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :before
+
+      sig { params(before: Integer).void }
+      attr_writer :before
+
+      # Filter by event type
+      sig do
+        returns(
+          T.nilable(ArkEmail::WebhookListDeliveriesParams::Event::OrSymbol)
+        )
+      end
+      attr_reader :event
+
+      sig do
+        params(
+          event: ArkEmail::WebhookListDeliveriesParams::Event::OrSymbol
+        ).void
+      end
+      attr_writer :event
+
+      # Page number (default 1)
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :page
+
+      sig { params(page: Integer).void }
+      attr_writer :page
+
+      # Items per page (default 30, max 100)
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :per_page
+
+      sig { params(per_page: Integer).void }
+      attr_writer :per_page
+
+      # Filter by delivery success (true = 2xx response, false = non-2xx or error)
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :success
+
+      sig { params(success: T::Boolean).void }
+      attr_writer :success
+
+      sig do
+        params(
+          after: Integer,
+          before: Integer,
+          event: ArkEmail::WebhookListDeliveriesParams::Event::OrSymbol,
+          page: Integer,
+          per_page: Integer,
+          success: T::Boolean,
+          request_options: ArkEmail::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Only deliveries after this Unix timestamp
+        after: nil,
+        # Only deliveries before this Unix timestamp
+        before: nil,
+        # Filter by event type
+        event: nil,
+        # Page number (default 1)
+        page: nil,
+        # Items per page (default 30, max 100)
+        per_page: nil,
+        # Filter by delivery success (true = 2xx response, false = non-2xx or error)
+        success: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            after: Integer,
+            before: Integer,
+            event: ArkEmail::WebhookListDeliveriesParams::Event::OrSymbol,
+            page: Integer,
+            per_page: Integer,
+            success: T::Boolean,
+            request_options: ArkEmail::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+
+      # Filter by event type
+      module Event
+        extend ArkEmail::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, ArkEmail::WebhookListDeliveriesParams::Event)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        MESSAGE_SENT =
+          T.let(
+            :MessageSent,
+            ArkEmail::WebhookListDeliveriesParams::Event::TaggedSymbol
+          )
+        MESSAGE_DELAYED =
+          T.let(
+            :MessageDelayed,
+            ArkEmail::WebhookListDeliveriesParams::Event::TaggedSymbol
+          )
+        MESSAGE_DELIVERY_FAILED =
+          T.let(
+            :MessageDeliveryFailed,
+            ArkEmail::WebhookListDeliveriesParams::Event::TaggedSymbol
+          )
+        MESSAGE_HELD =
+          T.let(
+            :MessageHeld,
+            ArkEmail::WebhookListDeliveriesParams::Event::TaggedSymbol
+          )
+        MESSAGE_BOUNCED =
+          T.let(
+            :MessageBounced,
+            ArkEmail::WebhookListDeliveriesParams::Event::TaggedSymbol
+          )
+        MESSAGE_LINK_CLICKED =
+          T.let(
+            :MessageLinkClicked,
+            ArkEmail::WebhookListDeliveriesParams::Event::TaggedSymbol
+          )
+        MESSAGE_LOADED =
+          T.let(
+            :MessageLoaded,
+            ArkEmail::WebhookListDeliveriesParams::Event::TaggedSymbol
+          )
+        DOMAIN_DNS_ERROR =
+          T.let(
+            :DomainDNSError,
+            ArkEmail::WebhookListDeliveriesParams::Event::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[ArkEmail::WebhookListDeliveriesParams::Event::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/ark_email/models/webhook_list_deliveries_response.rbi

@@ -0,0 +1,257 @@
+# typed: strong
+
+module ArkEmail
+  module Models
+    class WebhookListDeliveriesResponse < ArkEmail::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            ArkEmail::Models::WebhookListDeliveriesResponse,
+            ArkEmail::Internal::AnyHash
+          )
+        end
+
+      sig do
+        returns(T::Array[ArkEmail::Models::WebhookListDeliveriesResponse::Data])
+      end
+      attr_accessor :data
+
+      sig { returns(ArkEmail::APIMeta) }
+      attr_reader :meta
+
+      sig { params(meta: ArkEmail::APIMeta::OrHash).void }
+      attr_writer :meta
+
+      # Current page number
+      sig { returns(Integer) }
+      attr_accessor :page
+
+      # Items per page
+      sig { returns(Integer) }
+      attr_accessor :per_page
+
+      # Total number of deliveries matching the filter
+      sig { returns(Integer) }
+      attr_accessor :total
+
+      # Total number of pages
+      sig { returns(Integer) }
+      attr_accessor :total_pages
+
+      # Paginated list of webhook delivery attempts
+      sig do
+        params(
+          data:
+            T::Array[
+              ArkEmail::Models::WebhookListDeliveriesResponse::Data::OrHash
+            ],
+          meta: ArkEmail::APIMeta::OrHash,
+          page: Integer,
+          per_page: Integer,
+          total: Integer,
+          total_pages: Integer
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        data:,
+        meta:,
+        # Current page number
+        page:,
+        # Items per page
+        per_page:,
+        # Total number of deliveries matching the filter
+        total:,
+        # Total number of pages
+        total_pages:
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            data:
+              T::Array[ArkEmail::Models::WebhookListDeliveriesResponse::Data],
+            meta: ArkEmail::APIMeta,
+            page: Integer,
+            per_page: Integer,
+            total: Integer,
+            total_pages: Integer
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class Data < ArkEmail::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              ArkEmail::Models::WebhookListDeliveriesResponse::Data,
+              ArkEmail::Internal::AnyHash
+            )
+          end
+
+        # Unique delivery ID (UUID)
+        sig { returns(String) }
+        attr_accessor :id
+
+        # Attempt number (1 for first attempt, increments with retries)
+        sig { returns(Integer) }
+        attr_accessor :attempt
+
+        # Event type that triggered this delivery
+        sig do
+          returns(
+            ArkEmail::Models::WebhookListDeliveriesResponse::Data::Event::TaggedSymbol
+          )
+        end
+        attr_accessor :event
+
+        # HTTP status code returned by the endpoint (null if connection failed)
+        sig { returns(T.nilable(Integer)) }
+        attr_accessor :status_code
+
+        # Whether the delivery was successful (2xx response)
+        sig { returns(T::Boolean) }
+        attr_accessor :success
+
+        # When this delivery attempt occurred
+        sig { returns(Time) }
+        attr_accessor :timestamp
+
+        # URL the webhook was delivered to
+        sig { returns(String) }
+        attr_accessor :url
+
+        # ID of the webhook this delivery belongs to
+        sig { returns(String) }
+        attr_accessor :webhook_id
+
+        # Whether this delivery will be retried (true if failed and retries remaining)
+        sig { returns(T::Boolean) }
+        attr_accessor :will_retry
+
+        # Summary of a webhook delivery attempt
+        sig do
+          params(
+            id: String,
+            attempt: Integer,
+            event:
+              ArkEmail::Models::WebhookListDeliveriesResponse::Data::Event::OrSymbol,
+            status_code: T.nilable(Integer),
+            success: T::Boolean,
+            timestamp: Time,
+            url: String,
+            webhook_id: String,
+            will_retry: T::Boolean
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Unique delivery ID (UUID)
+          id:,
+          # Attempt number (1 for first attempt, increments with retries)
+          attempt:,
+          # Event type that triggered this delivery
+          event:,
+          # HTTP status code returned by the endpoint (null if connection failed)
+          status_code:,
+          # Whether the delivery was successful (2xx response)
+          success:,
+          # When this delivery attempt occurred
+          timestamp:,
+          # URL the webhook was delivered to
+          url:,
+          # ID of the webhook this delivery belongs to
+          webhook_id:,
+          # Whether this delivery will be retried (true if failed and retries remaining)
+          will_retry:
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              id: String,
+              attempt: Integer,
+              event:
+                ArkEmail::Models::WebhookListDeliveriesResponse::Data::Event::TaggedSymbol,
+              status_code: T.nilable(Integer),
+              success: T::Boolean,
+              timestamp: Time,
+              url: String,
+              webhook_id: String,
+              will_retry: T::Boolean
+            }
+          )
+        end
+        def to_hash
+        end
+
+        # Event type that triggered this delivery
+        module Event
+          extend ArkEmail::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                ArkEmail::Models::WebhookListDeliveriesResponse::Data::Event
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          MESSAGE_SENT =
+            T.let(
+              :MessageSent,
+              ArkEmail::Models::WebhookListDeliveriesResponse::Data::Event::TaggedSymbol
+            )
+          MESSAGE_DELAYED =
+            T.let(
+              :MessageDelayed,
+              ArkEmail::Models::WebhookListDeliveriesResponse::Data::Event::TaggedSymbol
+            )
+          MESSAGE_DELIVERY_FAILED =
+            T.let(
+              :MessageDeliveryFailed,
+              ArkEmail::Models::WebhookListDeliveriesResponse::Data::Event::TaggedSymbol
+            )
+          MESSAGE_HELD =
+            T.let(
+              :MessageHeld,
+              ArkEmail::Models::WebhookListDeliveriesResponse::Data::Event::TaggedSymbol
+            )
+          MESSAGE_BOUNCED =
+            T.let(
+              :MessageBounced,
+              ArkEmail::Models::WebhookListDeliveriesResponse::Data::Event::TaggedSymbol
+            )
+          MESSAGE_LINK_CLICKED =
+            T.let(
+              :MessageLinkClicked,
+              ArkEmail::Models::WebhookListDeliveriesResponse::Data::Event::TaggedSymbol
+            )
+          MESSAGE_LOADED =
+            T.let(
+              :MessageLoaded,
+              ArkEmail::Models::WebhookListDeliveriesResponse::Data::Event::TaggedSymbol
+            )
+          DOMAIN_DNS_ERROR =
+            T.let(
+              :DomainDNSError,
+              ArkEmail::Models::WebhookListDeliveriesResponse::Data::Event::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                ArkEmail::Models::WebhookListDeliveriesResponse::Data::Event::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/ark_email/models/webhook_replay_delivery_params.rbi

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

data/rbi/ark_email/models/webhook_replay_delivery_response.rbi

@@ -0,0 +1,132 @@
+# typed: strong
+
+module ArkEmail
+  module Models
+    class WebhookReplayDeliveryResponse < ArkEmail::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            ArkEmail::Models::WebhookReplayDeliveryResponse,
+            ArkEmail::Internal::AnyHash
+          )
+        end
+
+      sig { returns(ArkEmail::Models::WebhookReplayDeliveryResponse::Data) }
+      attr_reader :data
+
+      sig do
+        params(
+          data: ArkEmail::Models::WebhookReplayDeliveryResponse::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
+
+      # Result of replaying a webhook delivery
+      sig do
+        params(
+          data: ArkEmail::Models::WebhookReplayDeliveryResponse::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::WebhookReplayDeliveryResponse::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::WebhookReplayDeliveryResponse::Data,
+              ArkEmail::Internal::AnyHash
+            )
+          end
+
+        # Request duration in milliseconds
+        sig { returns(Integer) }
+        attr_accessor :duration
+
+        # ID of the new delivery created by the replay
+        sig { returns(String) }
+        attr_accessor :new_delivery_id
+
+        # ID of the original delivery that was replayed
+        sig { returns(String) }
+        attr_accessor :original_delivery_id
+
+        # HTTP status code from your endpoint
+        sig { returns(T.nilable(Integer)) }
+        attr_accessor :status_code
+
+        # Whether the replay was successful (2xx response from endpoint)
+        sig { returns(T::Boolean) }
+        attr_accessor :success
+
+        # When the replay was executed
+        sig { returns(Time) }
+        attr_accessor :timestamp
+
+        sig do
+          params(
+            duration: Integer,
+            new_delivery_id: String,
+            original_delivery_id: String,
+            status_code: T.nilable(Integer),
+            success: T::Boolean,
+            timestamp: Time
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Request duration in milliseconds
+          duration:,
+          # ID of the new delivery created by the replay
+          new_delivery_id:,
+          # ID of the original delivery that was replayed
+          original_delivery_id:,
+          # HTTP status code from your endpoint
+          status_code:,
+          # Whether the replay was successful (2xx response from endpoint)
+          success:,
+          # When the replay was executed
+          timestamp:
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              duration: Integer,
+              new_delivery_id: String,
+              original_delivery_id: String,
+              status_code: T.nilable(Integer),
+              success: T::Boolean,
+              timestamp: Time
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/ark_email/models/webhook_retrieve_delivery_params.rbi

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