ark-email 0.5.1

data/rbi/ark_email/models/suppression_retrieve_params.rbi

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

@@ -0,0 +1,115 @@
+# typed: strong
+
+module ArkEmail
+  module Models
+    class SuppressionRetrieveResponse < ArkEmail::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            ArkEmail::Models::SuppressionRetrieveResponse,
+            ArkEmail::Internal::AnyHash
+          )
+        end
+
+      sig { returns(ArkEmail::Models::SuppressionRetrieveResponse::Data) }
+      attr_reader :data
+
+      sig do
+        params(
+          data: ArkEmail::Models::SuppressionRetrieveResponse::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::SuppressionRetrieveResponse::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::SuppressionRetrieveResponse::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::SuppressionRetrieveResponse::Data,
+              ArkEmail::Internal::AnyHash
+            )
+          end
+
+        # The email address that was checked
+        sig { returns(String) }
+        attr_accessor :address
+
+        # Whether the address is currently suppressed
+        sig { returns(T::Boolean) }
+        attr_accessor :suppressed
+
+        # When the suppression was created (if suppressed)
+        sig { returns(T.nilable(Time)) }
+        attr_accessor :created_at
+
+        # Reason for suppression (if suppressed)
+        sig { returns(T.nilable(String)) }
+        attr_accessor :reason
+
+        sig do
+          params(
+            address: String,
+            suppressed: T::Boolean,
+            created_at: T.nilable(Time),
+            reason: T.nilable(String)
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The email address that was checked
+          address:,
+          # Whether the address is currently suppressed
+          suppressed:,
+          # When the suppression was created (if suppressed)
+          created_at: nil,
+          # Reason for suppression (if suppressed)
+          reason: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              address: String,
+              suppressed: T::Boolean,
+              created_at: T.nilable(Time),
+              reason: T.nilable(String)
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/ark_email/models/track_domain.rbi

@@ -0,0 +1,228 @@
+# typed: strong
+
+module ArkEmail
+  module Models
+    class TrackDomain < ArkEmail::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(ArkEmail::TrackDomain, ArkEmail::Internal::AnyHash)
+        end
+
+      # Track domain ID
+      sig { returns(String) }
+      attr_accessor :id
+
+      # When the track domain was created
+      sig { returns(Time) }
+      attr_accessor :created_at
+
+      # Whether DNS is correctly configured
+      sig { returns(T::Boolean) }
+      attr_accessor :dns_ok
+
+      # ID of the parent sending domain
+      sig { returns(String) }
+      attr_accessor :domain_id
+
+      # Full domain name
+      sig { returns(String) }
+      attr_accessor :full_name
+
+      # Subdomain name
+      sig { returns(String) }
+      attr_accessor :name
+
+      # Whether SSL is enabled for tracking URLs
+      sig { returns(T::Boolean) }
+      attr_accessor :ssl_enabled
+
+      # Whether click tracking is enabled
+      sig { returns(T::Boolean) }
+      attr_accessor :track_clicks
+
+      # Whether open tracking is enabled
+      sig { returns(T::Boolean) }
+      attr_accessor :track_opens
+
+      # When DNS was last checked
+      sig { returns(T.nilable(Time)) }
+      attr_accessor :dns_checked_at
+
+      # DNS error message if verification failed
+      sig { returns(T.nilable(String)) }
+      attr_accessor :dns_error
+
+      # Required DNS record configuration
+      sig { returns(T.nilable(ArkEmail::TrackDomain::DNSRecord)) }
+      attr_reader :dns_record
+
+      sig do
+        params(
+          dns_record: T.nilable(ArkEmail::TrackDomain::DNSRecord::OrHash)
+        ).void
+      end
+      attr_writer :dns_record
+
+      # Current DNS verification status
+      sig { returns(T.nilable(ArkEmail::TrackDomain::DNSStatus::TaggedSymbol)) }
+      attr_accessor :dns_status
+
+      # Domains excluded from click tracking
+      sig { returns(T.nilable(String)) }
+      attr_accessor :excluded_click_domains
+
+      # When the track domain was last updated
+      sig { returns(T.nilable(Time)) }
+      attr_accessor :updated_at
+
+      sig do
+        params(
+          id: String,
+          created_at: Time,
+          dns_ok: T::Boolean,
+          domain_id: String,
+          full_name: String,
+          name: String,
+          ssl_enabled: T::Boolean,
+          track_clicks: T::Boolean,
+          track_opens: T::Boolean,
+          dns_checked_at: T.nilable(Time),
+          dns_error: T.nilable(String),
+          dns_record: T.nilable(ArkEmail::TrackDomain::DNSRecord::OrHash),
+          dns_status: T.nilable(ArkEmail::TrackDomain::DNSStatus::OrSymbol),
+          excluded_click_domains: T.nilable(String),
+          updated_at: T.nilable(Time)
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Track domain ID
+        id:,
+        # When the track domain was created
+        created_at:,
+        # Whether DNS is correctly configured
+        dns_ok:,
+        # ID of the parent sending domain
+        domain_id:,
+        # Full domain name
+        full_name:,
+        # Subdomain name
+        name:,
+        # Whether SSL is enabled for tracking URLs
+        ssl_enabled:,
+        # Whether click tracking is enabled
+        track_clicks:,
+        # Whether open tracking is enabled
+        track_opens:,
+        # When DNS was last checked
+        dns_checked_at: nil,
+        # DNS error message if verification failed
+        dns_error: nil,
+        # Required DNS record configuration
+        dns_record: nil,
+        # Current DNS verification status
+        dns_status: nil,
+        # Domains excluded from click tracking
+        excluded_click_domains: nil,
+        # When the track domain was last updated
+        updated_at: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            id: String,
+            created_at: Time,
+            dns_ok: T::Boolean,
+            domain_id: String,
+            full_name: String,
+            name: String,
+            ssl_enabled: T::Boolean,
+            track_clicks: T::Boolean,
+            track_opens: T::Boolean,
+            dns_checked_at: T.nilable(Time),
+            dns_error: T.nilable(String),
+            dns_record: T.nilable(ArkEmail::TrackDomain::DNSRecord),
+            dns_status:
+              T.nilable(ArkEmail::TrackDomain::DNSStatus::TaggedSymbol),
+            excluded_click_domains: T.nilable(String),
+            updated_at: T.nilable(Time)
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class DNSRecord < ArkEmail::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(ArkEmail::TrackDomain::DNSRecord, ArkEmail::Internal::AnyHash)
+          end
+
+        # DNS record name
+        sig { returns(T.nilable(String)) }
+        attr_reader :name
+
+        sig { params(name: String).void }
+        attr_writer :name
+
+        # DNS record type
+        sig { returns(T.nilable(String)) }
+        attr_reader :type
+
+        sig { params(type: String).void }
+        attr_writer :type
+
+        # DNS record value (target)
+        sig { returns(T.nilable(String)) }
+        attr_reader :value
+
+        sig { params(value: String).void }
+        attr_writer :value
+
+        # Required DNS record configuration
+        sig do
+          params(name: String, type: String, value: String).returns(
+            T.attached_class
+          )
+        end
+        def self.new(
+          # DNS record name
+          name: nil,
+          # DNS record type
+          type: nil,
+          # DNS record value (target)
+          value: nil
+        )
+        end
+
+        sig { override.returns({ name: String, type: String, value: String }) }
+        def to_hash
+        end
+      end
+
+      # Current DNS verification status
+      module DNSStatus
+        extend ArkEmail::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias { T.all(Symbol, ArkEmail::TrackDomain::DNSStatus) }
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        OK = T.let(:ok, ArkEmail::TrackDomain::DNSStatus::TaggedSymbol)
+        MISSING =
+          T.let(:missing, ArkEmail::TrackDomain::DNSStatus::TaggedSymbol)
+        INVALID =
+          T.let(:invalid, ArkEmail::TrackDomain::DNSStatus::TaggedSymbol)
+
+        sig do
+          override.returns(
+            T::Array[ArkEmail::TrackDomain::DNSStatus::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/ark_email/models/tracking_create_params.rbi

@@ -0,0 +1,84 @@
+# typed: strong
+
+module ArkEmail
+  module Models
+    class TrackingCreateParams < ArkEmail::Internal::Type::BaseModel
+      extend ArkEmail::Internal::Type::RequestParameters::Converter
+      include ArkEmail::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(ArkEmail::TrackingCreateParams, ArkEmail::Internal::AnyHash)
+        end
+
+      # ID of the sending domain to attach this track domain to
+      sig { returns(String) }
+      attr_accessor :domain_id
+
+      # Subdomain name (e.g., 'track' for track.yourdomain.com)
+      sig { returns(String) }
+      attr_accessor :name
+
+      # Enable SSL for tracking URLs (recommended)
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :ssl_enabled
+
+      sig { params(ssl_enabled: T::Boolean).void }
+      attr_writer :ssl_enabled
+
+      # Enable click tracking
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :track_clicks
+
+      sig { params(track_clicks: T::Boolean).void }
+      attr_writer :track_clicks
+
+      # Enable open tracking (tracking pixel)
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :track_opens
+
+      sig { params(track_opens: T::Boolean).void }
+      attr_writer :track_opens
+
+      sig do
+        params(
+          domain_id: String,
+          name: String,
+          ssl_enabled: T::Boolean,
+          track_clicks: T::Boolean,
+          track_opens: T::Boolean,
+          request_options: ArkEmail::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # ID of the sending domain to attach this track domain to
+        domain_id:,
+        # Subdomain name (e.g., 'track' for track.yourdomain.com)
+        name:,
+        # Enable SSL for tracking URLs (recommended)
+        ssl_enabled: nil,
+        # Enable click tracking
+        track_clicks: nil,
+        # Enable open tracking (tracking pixel)
+        track_opens: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            domain_id: String,
+            name: String,
+            ssl_enabled: T::Boolean,
+            track_clicks: T::Boolean,
+            track_opens: T::Boolean,
+            request_options: ArkEmail::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/ark_email/models/tracking_create_response.rbi

@@ -0,0 +1,52 @@
+# typed: strong
+
+module ArkEmail
+  module Models
+    class TrackingCreateResponse < ArkEmail::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            ArkEmail::Models::TrackingCreateResponse,
+            ArkEmail::Internal::AnyHash
+          )
+        end
+
+      sig { returns(ArkEmail::TrackDomain) }
+      attr_reader :data
+
+      sig { params(data: ArkEmail::TrackDomain::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::TrackDomain::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::TrackDomain,
+            meta: ArkEmail::APIMeta,
+            success: T::Boolean
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/ark_email/models/tracking_delete_params.rbi

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

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

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