ark-email 0.5.1

data/rbi/ark_email/models/tracking_list_response.rbi

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

data/rbi/ark_email/models/tracking_retrieve_params.rbi

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

@@ -0,0 +1,52 @@
+# typed: strong
+
+module ArkEmail
+  module Models
+    class TrackingRetrieveResponse < ArkEmail::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            ArkEmail::Models::TrackingRetrieveResponse,
+            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_update_params.rbi

@@ -0,0 +1,79 @@
+# typed: strong
+
+module ArkEmail
+  module Models
+    class TrackingUpdateParams < ArkEmail::Internal::Type::BaseModel
+      extend ArkEmail::Internal::Type::RequestParameters::Converter
+      include ArkEmail::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(ArkEmail::TrackingUpdateParams, ArkEmail::Internal::AnyHash)
+        end
+
+      # Comma-separated list of domains to exclude from click tracking
+      sig { returns(T.nilable(String)) }
+      attr_reader :excluded_click_domains
+
+      sig { params(excluded_click_domains: String).void }
+      attr_writer :excluded_click_domains
+
+      # Enable or disable SSL for tracking URLs
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :ssl_enabled
+
+      sig { params(ssl_enabled: T::Boolean).void }
+      attr_writer :ssl_enabled
+
+      # Enable or disable click tracking
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :track_clicks
+
+      sig { params(track_clicks: T::Boolean).void }
+      attr_writer :track_clicks
+
+      # Enable or disable open tracking
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :track_opens
+
+      sig { params(track_opens: T::Boolean).void }
+      attr_writer :track_opens
+
+      sig do
+        params(
+          excluded_click_domains: 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(
+        # Comma-separated list of domains to exclude from click tracking
+        excluded_click_domains: nil,
+        # Enable or disable SSL for tracking URLs
+        ssl_enabled: nil,
+        # Enable or disable click tracking
+        track_clicks: nil,
+        # Enable or disable open tracking
+        track_opens: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            excluded_click_domains: 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_update_response.rbi

@@ -0,0 +1,52 @@
+# typed: strong
+
+module ArkEmail
+  module Models
+    class TrackingUpdateResponse < ArkEmail::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            ArkEmail::Models::TrackingUpdateResponse,
+            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_verify_params.rbi

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

@@ -0,0 +1,254 @@
+# typed: strong
+
+module ArkEmail
+  module Models
+    class TrackingVerifyResponse < ArkEmail::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            ArkEmail::Models::TrackingVerifyResponse,
+            ArkEmail::Internal::AnyHash
+          )
+        end
+
+      sig { returns(ArkEmail::Models::TrackingVerifyResponse::Data) }
+      attr_reader :data
+
+      sig do
+        params(
+          data: ArkEmail::Models::TrackingVerifyResponse::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::TrackingVerifyResponse::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::TrackingVerifyResponse::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::TrackingVerifyResponse::Data,
+              ArkEmail::Internal::AnyHash
+            )
+          end
+
+        # Track domain ID
+        sig { returns(String) }
+        attr_accessor :id
+
+        # Whether DNS is correctly configured
+        sig { returns(T::Boolean) }
+        attr_accessor :dns_ok
+
+        # Current DNS verification status
+        sig do
+          returns(
+            T.nilable(
+              ArkEmail::Models::TrackingVerifyResponse::Data::DNSStatus::TaggedSymbol
+            )
+          )
+        end
+        attr_accessor :dns_status
+
+        # Full domain name
+        sig { returns(String) }
+        attr_accessor :full_name
+
+        # 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 do
+          returns(
+            T.nilable(ArkEmail::Models::TrackingVerifyResponse::Data::DNSRecord)
+          )
+        end
+        attr_reader :dns_record
+
+        sig do
+          params(
+            dns_record:
+              T.nilable(
+                ArkEmail::Models::TrackingVerifyResponse::Data::DNSRecord::OrHash
+              )
+          ).void
+        end
+        attr_writer :dns_record
+
+        sig do
+          params(
+            id: String,
+            dns_ok: T::Boolean,
+            dns_status:
+              T.nilable(
+                ArkEmail::Models::TrackingVerifyResponse::Data::DNSStatus::OrSymbol
+              ),
+            full_name: String,
+            dns_checked_at: T.nilable(Time),
+            dns_error: T.nilable(String),
+            dns_record:
+              T.nilable(
+                ArkEmail::Models::TrackingVerifyResponse::Data::DNSRecord::OrHash
+              )
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Track domain ID
+          id:,
+          # Whether DNS is correctly configured
+          dns_ok:,
+          # Current DNS verification status
+          dns_status:,
+          # Full domain name
+          full_name:,
+          # 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
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              id: String,
+              dns_ok: T::Boolean,
+              dns_status:
+                T.nilable(
+                  ArkEmail::Models::TrackingVerifyResponse::Data::DNSStatus::TaggedSymbol
+                ),
+              full_name: String,
+              dns_checked_at: T.nilable(Time),
+              dns_error: T.nilable(String),
+              dns_record:
+                T.nilable(
+                  ArkEmail::Models::TrackingVerifyResponse::Data::DNSRecord
+                )
+            }
+          )
+        end
+        def to_hash
+        end
+
+        # Current DNS verification status
+        module DNSStatus
+          extend ArkEmail::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                ArkEmail::Models::TrackingVerifyResponse::Data::DNSStatus
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          OK =
+            T.let(
+              :ok,
+              ArkEmail::Models::TrackingVerifyResponse::Data::DNSStatus::TaggedSymbol
+            )
+          MISSING =
+            T.let(
+              :missing,
+              ArkEmail::Models::TrackingVerifyResponse::Data::DNSStatus::TaggedSymbol
+            )
+          INVALID =
+            T.let(
+              :invalid,
+              ArkEmail::Models::TrackingVerifyResponse::Data::DNSStatus::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                ArkEmail::Models::TrackingVerifyResponse::Data::DNSStatus::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+
+        class DNSRecord < ArkEmail::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                ArkEmail::Models::TrackingVerifyResponse::Data::DNSRecord,
+                ArkEmail::Internal::AnyHash
+              )
+            end
+
+          sig { returns(T.nilable(String)) }
+          attr_reader :name
+
+          sig { params(name: String).void }
+          attr_writer :name
+
+          sig { returns(T.nilable(String)) }
+          attr_reader :type
+
+          sig { params(type: String).void }
+          attr_writer :type
+
+          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(name: nil, type: nil, value: nil)
+          end
+
+          sig do
+            override.returns({ name: String, type: String, value: String })
+          end
+          def to_hash
+          end
+        end
+      end
+    end
+  end
+end