ark-email 0.5.1

data/rbi/ark_email/models/webhook_create_params.rbi

@@ -0,0 +1,154 @@
+# typed: strong
+
+module ArkEmail
+  module Models
+    class WebhookCreateParams < ArkEmail::Internal::Type::BaseModel
+      extend ArkEmail::Internal::Type::RequestParameters::Converter
+      include ArkEmail::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(ArkEmail::WebhookCreateParams, ArkEmail::Internal::AnyHash)
+        end
+
+      # Events to subscribe to:
+      #
+      # - `MessageSent` - Email successfully delivered to recipient's server
+      # - `MessageDelayed` - Temporary delivery failure, will retry
+      # - `MessageDeliveryFailed` - Permanent delivery failure
+      # - `MessageHeld` - Email held for manual review
+      # - `MessageBounced` - Email bounced back
+      # - `MessageLinkClicked` - Recipient clicked a tracked link
+      # - `MessageLoaded` - Recipient opened the email (tracking pixel loaded)
+      # - `DomainDNSError` - DNS configuration issue detected
+      sig { returns(T::Array[ArkEmail::WebhookCreateParams::Event::OrSymbol]) }
+      attr_accessor :events
+
+      # Webhook name for identification
+      sig { returns(String) }
+      attr_accessor :name
+
+      # HTTPS endpoint URL
+      sig { returns(String) }
+      attr_accessor :url
+
+      # Subscribe to all events (ignores events array)
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :all_events
+
+      sig { params(all_events: T::Boolean).void }
+      attr_writer :all_events
+
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :enabled
+
+      sig { params(enabled: T::Boolean).void }
+      attr_writer :enabled
+
+      sig do
+        params(
+          events: T::Array[ArkEmail::WebhookCreateParams::Event::OrSymbol],
+          name: String,
+          url: String,
+          all_events: T::Boolean,
+          enabled: T::Boolean,
+          request_options: ArkEmail::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Events to subscribe to:
+        #
+        # - `MessageSent` - Email successfully delivered to recipient's server
+        # - `MessageDelayed` - Temporary delivery failure, will retry
+        # - `MessageDeliveryFailed` - Permanent delivery failure
+        # - `MessageHeld` - Email held for manual review
+        # - `MessageBounced` - Email bounced back
+        # - `MessageLinkClicked` - Recipient clicked a tracked link
+        # - `MessageLoaded` - Recipient opened the email (tracking pixel loaded)
+        # - `DomainDNSError` - DNS configuration issue detected
+        events:,
+        # Webhook name for identification
+        name:,
+        # HTTPS endpoint URL
+        url:,
+        # Subscribe to all events (ignores events array)
+        all_events: nil,
+        enabled: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            events: T::Array[ArkEmail::WebhookCreateParams::Event::OrSymbol],
+            name: String,
+            url: String,
+            all_events: T::Boolean,
+            enabled: T::Boolean,
+            request_options: ArkEmail::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+
+      module Event
+        extend ArkEmail::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias { T.all(Symbol, ArkEmail::WebhookCreateParams::Event) }
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        MESSAGE_SENT =
+          T.let(
+            :MessageSent,
+            ArkEmail::WebhookCreateParams::Event::TaggedSymbol
+          )
+        MESSAGE_DELAYED =
+          T.let(
+            :MessageDelayed,
+            ArkEmail::WebhookCreateParams::Event::TaggedSymbol
+          )
+        MESSAGE_DELIVERY_FAILED =
+          T.let(
+            :MessageDeliveryFailed,
+            ArkEmail::WebhookCreateParams::Event::TaggedSymbol
+          )
+        MESSAGE_HELD =
+          T.let(
+            :MessageHeld,
+            ArkEmail::WebhookCreateParams::Event::TaggedSymbol
+          )
+        MESSAGE_BOUNCED =
+          T.let(
+            :MessageBounced,
+            ArkEmail::WebhookCreateParams::Event::TaggedSymbol
+          )
+        MESSAGE_LINK_CLICKED =
+          T.let(
+            :MessageLinkClicked,
+            ArkEmail::WebhookCreateParams::Event::TaggedSymbol
+          )
+        MESSAGE_LOADED =
+          T.let(
+            :MessageLoaded,
+            ArkEmail::WebhookCreateParams::Event::TaggedSymbol
+          )
+        DOMAIN_DNS_ERROR =
+          T.let(
+            :DomainDNSError,
+            ArkEmail::WebhookCreateParams::Event::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[ArkEmail::WebhookCreateParams::Event::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/ark_email/models/webhook_create_response.rbi

@@ -0,0 +1,217 @@
+# typed: strong
+
+module ArkEmail
+  module Models
+    class WebhookCreateResponse < ArkEmail::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            ArkEmail::Models::WebhookCreateResponse,
+            ArkEmail::Internal::AnyHash
+          )
+        end
+
+      sig { returns(ArkEmail::Models::WebhookCreateResponse::Data) }
+      attr_reader :data
+
+      sig do
+        params(data: ArkEmail::Models::WebhookCreateResponse::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::WebhookCreateResponse::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::WebhookCreateResponse::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::WebhookCreateResponse::Data,
+              ArkEmail::Internal::AnyHash
+            )
+          end
+
+        # Webhook ID
+        sig { returns(String) }
+        attr_accessor :id
+
+        # Whether subscribed to all events
+        sig { returns(T::Boolean) }
+        attr_accessor :all_events
+
+        sig { returns(Time) }
+        attr_accessor :created_at
+
+        # Whether the webhook is active
+        sig { returns(T::Boolean) }
+        attr_accessor :enabled
+
+        # Subscribed events
+        sig do
+          returns(
+            T::Array[
+              ArkEmail::Models::WebhookCreateResponse::Data::Event::TaggedSymbol
+            ]
+          )
+        end
+        attr_accessor :events
+
+        # Webhook name for identification
+        sig { returns(String) }
+        attr_accessor :name
+
+        # Webhook endpoint URL
+        sig { returns(String) }
+        attr_accessor :url
+
+        sig { returns(String) }
+        attr_accessor :uuid
+
+        sig do
+          params(
+            id: String,
+            all_events: T::Boolean,
+            created_at: Time,
+            enabled: T::Boolean,
+            events:
+              T::Array[
+                ArkEmail::Models::WebhookCreateResponse::Data::Event::OrSymbol
+              ],
+            name: String,
+            url: String,
+            uuid: String
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Webhook ID
+          id:,
+          # Whether subscribed to all events
+          all_events:,
+          created_at:,
+          # Whether the webhook is active
+          enabled:,
+          # Subscribed events
+          events:,
+          # Webhook name for identification
+          name:,
+          # Webhook endpoint URL
+          url:,
+          uuid:
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              id: String,
+              all_events: T::Boolean,
+              created_at: Time,
+              enabled: T::Boolean,
+              events:
+                T::Array[
+                  ArkEmail::Models::WebhookCreateResponse::Data::Event::TaggedSymbol
+                ],
+              name: String,
+              url: String,
+              uuid: String
+            }
+          )
+        end
+        def to_hash
+        end
+
+        module Event
+          extend ArkEmail::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                ArkEmail::Models::WebhookCreateResponse::Data::Event
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          MESSAGE_SENT =
+            T.let(
+              :MessageSent,
+              ArkEmail::Models::WebhookCreateResponse::Data::Event::TaggedSymbol
+            )
+          MESSAGE_DELAYED =
+            T.let(
+              :MessageDelayed,
+              ArkEmail::Models::WebhookCreateResponse::Data::Event::TaggedSymbol
+            )
+          MESSAGE_DELIVERY_FAILED =
+            T.let(
+              :MessageDeliveryFailed,
+              ArkEmail::Models::WebhookCreateResponse::Data::Event::TaggedSymbol
+            )
+          MESSAGE_HELD =
+            T.let(
+              :MessageHeld,
+              ArkEmail::Models::WebhookCreateResponse::Data::Event::TaggedSymbol
+            )
+          MESSAGE_BOUNCED =
+            T.let(
+              :MessageBounced,
+              ArkEmail::Models::WebhookCreateResponse::Data::Event::TaggedSymbol
+            )
+          MESSAGE_LINK_CLICKED =
+            T.let(
+              :MessageLinkClicked,
+              ArkEmail::Models::WebhookCreateResponse::Data::Event::TaggedSymbol
+            )
+          MESSAGE_LOADED =
+            T.let(
+              :MessageLoaded,
+              ArkEmail::Models::WebhookCreateResponse::Data::Event::TaggedSymbol
+            )
+          DOMAIN_DNS_ERROR =
+            T.let(
+              :DomainDNSError,
+              ArkEmail::Models::WebhookCreateResponse::Data::Event::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                ArkEmail::Models::WebhookCreateResponse::Data::Event::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/ark_email/models/webhook_delete_params.rbi

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

@@ -0,0 +1,75 @@
+# typed: strong
+
+module ArkEmail
+  module Models
+    class WebhookDeleteResponse < ArkEmail::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            ArkEmail::Models::WebhookDeleteResponse,
+            ArkEmail::Internal::AnyHash
+          )
+        end
+
+      sig { returns(ArkEmail::Models::WebhookDeleteResponse::Data) }
+      attr_reader :data
+
+      sig do
+        params(data: ArkEmail::Models::WebhookDeleteResponse::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::WebhookDeleteResponse::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::WebhookDeleteResponse::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::WebhookDeleteResponse::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/webhook_list_params.rbi

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

@@ -0,0 +1,152 @@
+# typed: strong
+
+module ArkEmail
+  module Models
+    class WebhookListResponse < ArkEmail::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            ArkEmail::Models::WebhookListResponse,
+            ArkEmail::Internal::AnyHash
+          )
+        end
+
+      sig { returns(ArkEmail::Models::WebhookListResponse::Data) }
+      attr_reader :data
+
+      sig do
+        params(data: ArkEmail::Models::WebhookListResponse::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::WebhookListResponse::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::WebhookListResponse::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::WebhookListResponse::Data,
+              ArkEmail::Internal::AnyHash
+            )
+          end
+
+        sig do
+          returns(
+            T::Array[ArkEmail::Models::WebhookListResponse::Data::Webhook]
+          )
+        end
+        attr_accessor :webhooks
+
+        sig do
+          params(
+            webhooks:
+              T::Array[
+                ArkEmail::Models::WebhookListResponse::Data::Webhook::OrHash
+              ]
+          ).returns(T.attached_class)
+        end
+        def self.new(webhooks:)
+        end
+
+        sig do
+          override.returns(
+            {
+              webhooks:
+                T::Array[ArkEmail::Models::WebhookListResponse::Data::Webhook]
+            }
+          )
+        end
+        def to_hash
+        end
+
+        class Webhook < ArkEmail::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                ArkEmail::Models::WebhookListResponse::Data::Webhook,
+                ArkEmail::Internal::AnyHash
+              )
+            end
+
+          # Webhook ID
+          sig { returns(String) }
+          attr_accessor :id
+
+          sig { returns(T::Boolean) }
+          attr_accessor :enabled
+
+          sig { returns(T::Array[String]) }
+          attr_accessor :events
+
+          sig { returns(String) }
+          attr_accessor :name
+
+          sig { returns(String) }
+          attr_accessor :url
+
+          sig do
+            params(
+              id: String,
+              enabled: T::Boolean,
+              events: T::Array[String],
+              name: String,
+              url: String
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # Webhook ID
+            id:,
+            enabled:,
+            events:,
+            name:,
+            url:
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                id: String,
+                enabled: T::Boolean,
+                events: T::Array[String],
+                name: String,
+                url: String
+              }
+            )
+          end
+          def to_hash
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/ark_email/models/webhook_retrieve_params.rbi

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