ark-email 0.5.1

data/rbi/ark_email/models/webhook_retrieve_response.rbi

@@ -0,0 +1,219 @@
+# typed: strong
+
+module ArkEmail
+  module Models
+    class WebhookRetrieveResponse < ArkEmail::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            ArkEmail::Models::WebhookRetrieveResponse,
+            ArkEmail::Internal::AnyHash
+          )
+        end
+
+      sig { returns(ArkEmail::Models::WebhookRetrieveResponse::Data) }
+      attr_reader :data
+
+      sig do
+        params(
+          data: ArkEmail::Models::WebhookRetrieveResponse::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::WebhookRetrieveResponse::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::WebhookRetrieveResponse::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::WebhookRetrieveResponse::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::WebhookRetrieveResponse::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::WebhookRetrieveResponse::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::WebhookRetrieveResponse::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::WebhookRetrieveResponse::Data::Event
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          MESSAGE_SENT =
+            T.let(
+              :MessageSent,
+              ArkEmail::Models::WebhookRetrieveResponse::Data::Event::TaggedSymbol
+            )
+          MESSAGE_DELAYED =
+            T.let(
+              :MessageDelayed,
+              ArkEmail::Models::WebhookRetrieveResponse::Data::Event::TaggedSymbol
+            )
+          MESSAGE_DELIVERY_FAILED =
+            T.let(
+              :MessageDeliveryFailed,
+              ArkEmail::Models::WebhookRetrieveResponse::Data::Event::TaggedSymbol
+            )
+          MESSAGE_HELD =
+            T.let(
+              :MessageHeld,
+              ArkEmail::Models::WebhookRetrieveResponse::Data::Event::TaggedSymbol
+            )
+          MESSAGE_BOUNCED =
+            T.let(
+              :MessageBounced,
+              ArkEmail::Models::WebhookRetrieveResponse::Data::Event::TaggedSymbol
+            )
+          MESSAGE_LINK_CLICKED =
+            T.let(
+              :MessageLinkClicked,
+              ArkEmail::Models::WebhookRetrieveResponse::Data::Event::TaggedSymbol
+            )
+          MESSAGE_LOADED =
+            T.let(
+              :MessageLoaded,
+              ArkEmail::Models::WebhookRetrieveResponse::Data::Event::TaggedSymbol
+            )
+          DOMAIN_DNS_ERROR =
+            T.let(
+              :DomainDNSError,
+              ArkEmail::Models::WebhookRetrieveResponse::Data::Event::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                ArkEmail::Models::WebhookRetrieveResponse::Data::Event::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/ark_email/models/webhook_test_params.rbi

@@ -0,0 +1,95 @@
+# typed: strong
+
+module ArkEmail
+  module Models
+    class WebhookTestParams < ArkEmail::Internal::Type::BaseModel
+      extend ArkEmail::Internal::Type::RequestParameters::Converter
+      include ArkEmail::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(ArkEmail::WebhookTestParams, ArkEmail::Internal::AnyHash)
+        end
+
+      # Event type to simulate
+      sig { returns(ArkEmail::WebhookTestParams::Event::OrSymbol) }
+      attr_accessor :event
+
+      sig do
+        params(
+          event: ArkEmail::WebhookTestParams::Event::OrSymbol,
+          request_options: ArkEmail::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Event type to simulate
+        event:,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            event: ArkEmail::WebhookTestParams::Event::OrSymbol,
+            request_options: ArkEmail::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+
+      # Event type to simulate
+      module Event
+        extend ArkEmail::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias { T.all(Symbol, ArkEmail::WebhookTestParams::Event) }
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        MESSAGE_SENT =
+          T.let(:MessageSent, ArkEmail::WebhookTestParams::Event::TaggedSymbol)
+        MESSAGE_DELAYED =
+          T.let(
+            :MessageDelayed,
+            ArkEmail::WebhookTestParams::Event::TaggedSymbol
+          )
+        MESSAGE_DELIVERY_FAILED =
+          T.let(
+            :MessageDeliveryFailed,
+            ArkEmail::WebhookTestParams::Event::TaggedSymbol
+          )
+        MESSAGE_HELD =
+          T.let(:MessageHeld, ArkEmail::WebhookTestParams::Event::TaggedSymbol)
+        MESSAGE_BOUNCED =
+          T.let(
+            :MessageBounced,
+            ArkEmail::WebhookTestParams::Event::TaggedSymbol
+          )
+        MESSAGE_LINK_CLICKED =
+          T.let(
+            :MessageLinkClicked,
+            ArkEmail::WebhookTestParams::Event::TaggedSymbol
+          )
+        MESSAGE_LOADED =
+          T.let(
+            :MessageLoaded,
+            ArkEmail::WebhookTestParams::Event::TaggedSymbol
+          )
+        DOMAIN_DNS_ERROR =
+          T.let(
+            :DomainDNSError,
+            ArkEmail::WebhookTestParams::Event::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[ArkEmail::WebhookTestParams::Event::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/ark_email/models/webhook_test_response.rbi

@@ -0,0 +1,129 @@
+# typed: strong
+
+module ArkEmail
+  module Models
+    class WebhookTestResponse < ArkEmail::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            ArkEmail::Models::WebhookTestResponse,
+            ArkEmail::Internal::AnyHash
+          )
+        end
+
+      sig { returns(ArkEmail::Models::WebhookTestResponse::Data) }
+      attr_reader :data
+
+      sig do
+        params(data: ArkEmail::Models::WebhookTestResponse::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::WebhookTestResponse::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::WebhookTestResponse::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::WebhookTestResponse::Data,
+              ArkEmail::Internal::AnyHash
+            )
+          end
+
+        # Request duration in milliseconds
+        sig { returns(Integer) }
+        attr_accessor :duration
+
+        # Event type that was tested
+        sig { returns(String) }
+        attr_accessor :event
+
+        # HTTP status code from the webhook endpoint
+        sig { returns(T.nilable(Integer)) }
+        attr_accessor :status_code
+
+        # Whether the webhook endpoint responded with a 2xx status
+        sig { returns(T::Boolean) }
+        attr_accessor :success
+
+        # Response body from the webhook endpoint (truncated if too long)
+        sig { returns(T.nilable(String)) }
+        attr_accessor :body
+
+        # Error message if the request failed
+        sig { returns(T.nilable(String)) }
+        attr_accessor :error
+
+        sig do
+          params(
+            duration: Integer,
+            event: String,
+            status_code: T.nilable(Integer),
+            success: T::Boolean,
+            body: T.nilable(String),
+            error: T.nilable(String)
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Request duration in milliseconds
+          duration:,
+          # Event type that was tested
+          event:,
+          # HTTP status code from the webhook endpoint
+          status_code:,
+          # Whether the webhook endpoint responded with a 2xx status
+          success:,
+          # Response body from the webhook endpoint (truncated if too long)
+          body: nil,
+          # Error message if the request failed
+          error: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              duration: Integer,
+              event: String,
+              status_code: T.nilable(Integer),
+              success: T::Boolean,
+              body: T.nilable(String),
+              error: T.nilable(String)
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/ark_email/models/webhook_update_params.rbi

@@ -0,0 +1,80 @@
+# typed: strong
+
+module ArkEmail
+  module Models
+    class WebhookUpdateParams < ArkEmail::Internal::Type::BaseModel
+      extend ArkEmail::Internal::Type::RequestParameters::Converter
+      include ArkEmail::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(ArkEmail::WebhookUpdateParams, ArkEmail::Internal::AnyHash)
+        end
+
+      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 { returns(T.nilable(T::Array[String])) }
+      attr_reader :events
+
+      sig { params(events: T::Array[String]).void }
+      attr_writer :events
+
+      sig { returns(T.nilable(String)) }
+      attr_reader :name
+
+      sig { params(name: String).void }
+      attr_writer :name
+
+      sig { returns(T.nilable(String)) }
+      attr_reader :url
+
+      sig { params(url: String).void }
+      attr_writer :url
+
+      sig do
+        params(
+          all_events: T::Boolean,
+          enabled: T::Boolean,
+          events: T::Array[String],
+          name: String,
+          url: String,
+          request_options: ArkEmail::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        all_events: nil,
+        enabled: nil,
+        events: nil,
+        name: nil,
+        url: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            all_events: T::Boolean,
+            enabled: T::Boolean,
+            events: T::Array[String],
+            name: String,
+            url: String,
+            request_options: ArkEmail::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end