ark-email 0.5.1

data/lib/ark_email/models/suppression_create_response.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+module ArkEmail
+  module Models
+    # @see ArkEmail::Resources::Suppressions#create
+    class SuppressionCreateResponse < ArkEmail::Internal::Type::BaseModel
+      # @!attribute data
+      #
+      #   @return [ArkEmail::Models::SuppressionCreateResponse::Data]
+      required :data, -> { ArkEmail::Models::SuppressionCreateResponse::Data }
+
+      # @!attribute meta
+      #
+      #   @return [ArkEmail::Models::APIMeta]
+      required :meta, -> { ArkEmail::APIMeta }
+
+      # @!attribute success
+      #
+      #   @return [Boolean, true]
+      required :success, const: true
+
+      # @!method initialize(data:, meta:, success: true)
+      #   @param data [ArkEmail::Models::SuppressionCreateResponse::Data]
+      #   @param meta [ArkEmail::Models::APIMeta]
+      #   @param success [Boolean, true]
+
+      # @see ArkEmail::Models::SuppressionCreateResponse#data
+      class Data < ArkEmail::Internal::Type::BaseModel
+        # @!attribute id
+        #   Suppression ID
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute address
+        #
+        #   @return [String]
+        required :address, String
+
+        # @!attribute created_at
+        #
+        #   @return [Time]
+        required :created_at, Time, api_name: :createdAt
+
+        # @!attribute reason
+        #   Reason for suppression
+        #
+        #   @return [String, nil]
+        optional :reason, String
+
+        # @!method initialize(id:, address:, created_at:, reason: nil)
+        #   @param id [String] Suppression ID
+        #
+        #   @param address [String]
+        #
+        #   @param created_at [Time]
+        #
+        #   @param reason [String] Reason for suppression
+      end
+    end
+  end
+end

data/lib/ark_email/models/suppression_delete_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module ArkEmail
+  module Models
+    # @see ArkEmail::Resources::Suppressions#delete
+    class SuppressionDeleteParams < ArkEmail::Internal::Type::BaseModel
+      extend ArkEmail::Internal::Type::RequestParameters::Converter
+      include ArkEmail::Internal::Type::RequestParameters
+
+      # @!method initialize(request_options: {})
+      #   @param request_options [ArkEmail::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/ark_email/models/suppression_delete_response.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module ArkEmail
+  module Models
+    # @see ArkEmail::Resources::Suppressions#delete
+    class SuppressionDeleteResponse < ArkEmail::Internal::Type::BaseModel
+      # @!attribute data
+      #
+      #   @return [ArkEmail::Models::SuppressionDeleteResponse::Data]
+      required :data, -> { ArkEmail::Models::SuppressionDeleteResponse::Data }
+
+      # @!attribute meta
+      #
+      #   @return [ArkEmail::Models::APIMeta]
+      required :meta, -> { ArkEmail::APIMeta }
+
+      # @!attribute success
+      #
+      #   @return [Boolean, true]
+      required :success, const: true
+
+      # @!method initialize(data:, meta:, success: true)
+      #   @param data [ArkEmail::Models::SuppressionDeleteResponse::Data]
+      #   @param meta [ArkEmail::Models::APIMeta]
+      #   @param success [Boolean, true]
+
+      # @see ArkEmail::Models::SuppressionDeleteResponse#data
+      class Data < ArkEmail::Internal::Type::BaseModel
+        # @!attribute message
+        #
+        #   @return [String]
+        required :message, String
+
+        # @!method initialize(message:)
+        #   @param message [String]
+      end
+    end
+  end
+end

data/lib/ark_email/models/suppression_list_params.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module ArkEmail
+  module Models
+    # @see ArkEmail::Resources::Suppressions#list
+    class SuppressionListParams < ArkEmail::Internal::Type::BaseModel
+      extend ArkEmail::Internal::Type::RequestParameters::Converter
+      include ArkEmail::Internal::Type::RequestParameters
+
+      # @!attribute page
+      #
+      #   @return [Integer, nil]
+      optional :page, Integer
+
+      # @!attribute per_page
+      #
+      #   @return [Integer, nil]
+      optional :per_page, Integer
+
+      # @!method initialize(page: nil, per_page: nil, request_options: {})
+      #   @param page [Integer]
+      #   @param per_page [Integer]
+      #   @param request_options [ArkEmail::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/ark_email/models/suppression_list_response.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module ArkEmail
+  module Models
+    # @see ArkEmail::Resources::Suppressions#list
+    class SuppressionListResponse < ArkEmail::Internal::Type::BaseModel
+      # @!attribute id
+      #   Suppression ID
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute address
+      #
+      #   @return [String]
+      required :address, String
+
+      # @!attribute created_at
+      #
+      #   @return [Time]
+      required :created_at, Time, api_name: :createdAt
+
+      # @!attribute reason
+      #
+      #   @return [String, nil]
+      optional :reason, String
+
+      # @!method initialize(id:, address:, created_at:, reason: nil)
+      #   @param id [String] Suppression ID
+      #
+      #   @param address [String]
+      #
+      #   @param created_at [Time]
+      #
+      #   @param reason [String]
+    end
+  end
+end

data/lib/ark_email/models/suppression_retrieve_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module ArkEmail
+  module Models
+    # @see ArkEmail::Resources::Suppressions#retrieve
+    class SuppressionRetrieveParams < ArkEmail::Internal::Type::BaseModel
+      extend ArkEmail::Internal::Type::RequestParameters::Converter
+      include ArkEmail::Internal::Type::RequestParameters
+
+      # @!method initialize(request_options: {})
+      #   @param request_options [ArkEmail::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/ark_email/models/suppression_retrieve_response.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+module ArkEmail
+  module Models
+    # @see ArkEmail::Resources::Suppressions#retrieve
+    class SuppressionRetrieveResponse < ArkEmail::Internal::Type::BaseModel
+      # @!attribute data
+      #
+      #   @return [ArkEmail::Models::SuppressionRetrieveResponse::Data]
+      required :data, -> { ArkEmail::Models::SuppressionRetrieveResponse::Data }
+
+      # @!attribute meta
+      #
+      #   @return [ArkEmail::Models::APIMeta]
+      required :meta, -> { ArkEmail::APIMeta }
+
+      # @!attribute success
+      #
+      #   @return [Boolean, true]
+      required :success, const: true
+
+      # @!method initialize(data:, meta:, success: true)
+      #   @param data [ArkEmail::Models::SuppressionRetrieveResponse::Data]
+      #   @param meta [ArkEmail::Models::APIMeta]
+      #   @param success [Boolean, true]
+
+      # @see ArkEmail::Models::SuppressionRetrieveResponse#data
+      class Data < ArkEmail::Internal::Type::BaseModel
+        # @!attribute address
+        #   The email address that was checked
+        #
+        #   @return [String]
+        required :address, String
+
+        # @!attribute suppressed
+        #   Whether the address is currently suppressed
+        #
+        #   @return [Boolean]
+        required :suppressed, ArkEmail::Internal::Type::Boolean
+
+        # @!attribute created_at
+        #   When the suppression was created (if suppressed)
+        #
+        #   @return [Time, nil]
+        optional :created_at, Time, api_name: :createdAt, nil?: true
+
+        # @!attribute reason
+        #   Reason for suppression (if suppressed)
+        #
+        #   @return [String, nil]
+        optional :reason, String, nil?: true
+
+        # @!method initialize(address:, suppressed:, created_at: nil, reason: nil)
+        #   @param address [String] The email address that was checked
+        #
+        #   @param suppressed [Boolean] Whether the address is currently suppressed
+        #
+        #   @param created_at [Time, nil] When the suppression was created (if suppressed)
+        #
+        #   @param reason [String, nil] Reason for suppression (if suppressed)
+      end
+    end
+  end
+end

data/lib/ark_email/models/track_domain.rb

@@ -0,0 +1,172 @@
+# frozen_string_literal: true
+
+module ArkEmail
+  module Models
+    class TrackDomain < ArkEmail::Internal::Type::BaseModel
+      # @!attribute id
+      #   Track domain ID
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute created_at
+      #   When the track domain was created
+      #
+      #   @return [Time]
+      required :created_at, Time, api_name: :createdAt
+
+      # @!attribute dns_ok
+      #   Whether DNS is correctly configured
+      #
+      #   @return [Boolean]
+      required :dns_ok, ArkEmail::Internal::Type::Boolean, api_name: :dnsOk
+
+      # @!attribute domain_id
+      #   ID of the parent sending domain
+      #
+      #   @return [String]
+      required :domain_id, String, api_name: :domainId
+
+      # @!attribute full_name
+      #   Full domain name
+      #
+      #   @return [String]
+      required :full_name, String, api_name: :fullName
+
+      # @!attribute name
+      #   Subdomain name
+      #
+      #   @return [String]
+      required :name, String
+
+      # @!attribute ssl_enabled
+      #   Whether SSL is enabled for tracking URLs
+      #
+      #   @return [Boolean]
+      required :ssl_enabled, ArkEmail::Internal::Type::Boolean, api_name: :sslEnabled
+
+      # @!attribute track_clicks
+      #   Whether click tracking is enabled
+      #
+      #   @return [Boolean]
+      required :track_clicks, ArkEmail::Internal::Type::Boolean, api_name: :trackClicks
+
+      # @!attribute track_opens
+      #   Whether open tracking is enabled
+      #
+      #   @return [Boolean]
+      required :track_opens, ArkEmail::Internal::Type::Boolean, api_name: :trackOpens
+
+      # @!attribute dns_checked_at
+      #   When DNS was last checked
+      #
+      #   @return [Time, nil]
+      optional :dns_checked_at, Time, api_name: :dnsCheckedAt, nil?: true
+
+      # @!attribute dns_error
+      #   DNS error message if verification failed
+      #
+      #   @return [String, nil]
+      optional :dns_error, String, api_name: :dnsError, nil?: true
+
+      # @!attribute dns_record
+      #   Required DNS record configuration
+      #
+      #   @return [ArkEmail::Models::TrackDomain::DNSRecord, nil]
+      optional :dns_record, -> { ArkEmail::TrackDomain::DNSRecord }, api_name: :dnsRecord, nil?: true
+
+      # @!attribute dns_status
+      #   Current DNS verification status
+      #
+      #   @return [Symbol, ArkEmail::Models::TrackDomain::DNSStatus, nil]
+      optional :dns_status, enum: -> { ArkEmail::TrackDomain::DNSStatus }, api_name: :dnsStatus, nil?: true
+
+      # @!attribute excluded_click_domains
+      #   Domains excluded from click tracking
+      #
+      #   @return [String, nil]
+      optional :excluded_click_domains, String, api_name: :excludedClickDomains, nil?: true
+
+      # @!attribute updated_at
+      #   When the track domain was last updated
+      #
+      #   @return [Time, nil]
+      optional :updated_at, Time, api_name: :updatedAt, nil?: true
+
+      # @!method initialize(id:, created_at:, dns_ok:, domain_id:, full_name:, name:, ssl_enabled:, track_clicks:, track_opens:, dns_checked_at: nil, dns_error: nil, dns_record: nil, dns_status: nil, excluded_click_domains: nil, updated_at: nil)
+      #   @param id [String] Track domain ID
+      #
+      #   @param created_at [Time] When the track domain was created
+      #
+      #   @param dns_ok [Boolean] Whether DNS is correctly configured
+      #
+      #   @param domain_id [String] ID of the parent sending domain
+      #
+      #   @param full_name [String] Full domain name
+      #
+      #   @param name [String] Subdomain name
+      #
+      #   @param ssl_enabled [Boolean] Whether SSL is enabled for tracking URLs
+      #
+      #   @param track_clicks [Boolean] Whether click tracking is enabled
+      #
+      #   @param track_opens [Boolean] Whether open tracking is enabled
+      #
+      #   @param dns_checked_at [Time, nil] When DNS was last checked
+      #
+      #   @param dns_error [String, nil] DNS error message if verification failed
+      #
+      #   @param dns_record [ArkEmail::Models::TrackDomain::DNSRecord, nil] Required DNS record configuration
+      #
+      #   @param dns_status [Symbol, ArkEmail::Models::TrackDomain::DNSStatus, nil] Current DNS verification status
+      #
+      #   @param excluded_click_domains [String, nil] Domains excluded from click tracking
+      #
+      #   @param updated_at [Time, nil] When the track domain was last updated
+
+      # @see ArkEmail::Models::TrackDomain#dns_record
+      class DNSRecord < ArkEmail::Internal::Type::BaseModel
+        # @!attribute name
+        #   DNS record name
+        #
+        #   @return [String, nil]
+        optional :name, String
+
+        # @!attribute type
+        #   DNS record type
+        #
+        #   @return [String, nil]
+        optional :type, String
+
+        # @!attribute value
+        #   DNS record value (target)
+        #
+        #   @return [String, nil]
+        optional :value, String
+
+        # @!method initialize(name: nil, type: nil, value: nil)
+        #   Required DNS record configuration
+        #
+        #   @param name [String] DNS record name
+        #
+        #   @param type [String] DNS record type
+        #
+        #   @param value [String] DNS record value (target)
+      end
+
+      # Current DNS verification status
+      #
+      # @see ArkEmail::Models::TrackDomain#dns_status
+      module DNSStatus
+        extend ArkEmail::Internal::Type::Enum
+
+        OK = :ok
+        MISSING = :missing
+        INVALID = :invalid
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/ark_email/models/tracking_create_params.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+module ArkEmail
+  module Models
+    # @see ArkEmail::Resources::Tracking#create
+    class TrackingCreateParams < ArkEmail::Internal::Type::BaseModel
+      extend ArkEmail::Internal::Type::RequestParameters::Converter
+      include ArkEmail::Internal::Type::RequestParameters
+
+      # @!attribute domain_id
+      #   ID of the sending domain to attach this track domain to
+      #
+      #   @return [String]
+      required :domain_id, String, api_name: :domainId
+
+      # @!attribute name
+      #   Subdomain name (e.g., 'track' for track.yourdomain.com)
+      #
+      #   @return [String]
+      required :name, String
+
+      # @!attribute ssl_enabled
+      #   Enable SSL for tracking URLs (recommended)
+      #
+      #   @return [Boolean, nil]
+      optional :ssl_enabled, ArkEmail::Internal::Type::Boolean, api_name: :sslEnabled
+
+      # @!attribute track_clicks
+      #   Enable click tracking
+      #
+      #   @return [Boolean, nil]
+      optional :track_clicks, ArkEmail::Internal::Type::Boolean, api_name: :trackClicks
+
+      # @!attribute track_opens
+      #   Enable open tracking (tracking pixel)
+      #
+      #   @return [Boolean, nil]
+      optional :track_opens, ArkEmail::Internal::Type::Boolean, api_name: :trackOpens
+
+      # @!method initialize(domain_id:, name:, ssl_enabled: nil, track_clicks: nil, track_opens: nil, request_options: {})
+      #   @param domain_id [String] ID of the sending domain to attach this track domain to
+      #
+      #   @param name [String] Subdomain name (e.g., 'track' for track.yourdomain.com)
+      #
+      #   @param ssl_enabled [Boolean] Enable SSL for tracking URLs (recommended)
+      #
+      #   @param track_clicks [Boolean] Enable click tracking
+      #
+      #   @param track_opens [Boolean] Enable open tracking (tracking pixel)
+      #
+      #   @param request_options [ArkEmail::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/ark_email/models/tracking_create_response.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module ArkEmail
+  module Models
+    # @see ArkEmail::Resources::Tracking#create
+    class TrackingCreateResponse < ArkEmail::Internal::Type::BaseModel
+      # @!attribute data
+      #
+      #   @return [ArkEmail::Models::TrackDomain]
+      required :data, -> { ArkEmail::TrackDomain }
+
+      # @!attribute meta
+      #
+      #   @return [ArkEmail::Models::APIMeta]
+      required :meta, -> { ArkEmail::APIMeta }
+
+      # @!attribute success
+      #
+      #   @return [Boolean, true]
+      required :success, const: true
+
+      # @!method initialize(data:, meta:, success: true)
+      #   @param data [ArkEmail::Models::TrackDomain]
+      #   @param meta [ArkEmail::Models::APIMeta]
+      #   @param success [Boolean, true]
+    end
+  end
+end

data/lib/ark_email/models/tracking_delete_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module ArkEmail
+  module Models
+    # @see ArkEmail::Resources::Tracking#delete
+    class TrackingDeleteParams < ArkEmail::Internal::Type::BaseModel
+      extend ArkEmail::Internal::Type::RequestParameters::Converter
+      include ArkEmail::Internal::Type::RequestParameters
+
+      # @!method initialize(request_options: {})
+      #   @param request_options [ArkEmail::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/ark_email/models/tracking_delete_response.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module ArkEmail
+  module Models
+    # @see ArkEmail::Resources::Tracking#delete
+    class TrackingDeleteResponse < ArkEmail::Internal::Type::BaseModel
+      # @!attribute data
+      #
+      #   @return [ArkEmail::Models::TrackingDeleteResponse::Data]
+      required :data, -> { ArkEmail::Models::TrackingDeleteResponse::Data }
+
+      # @!attribute meta
+      #
+      #   @return [ArkEmail::Models::APIMeta]
+      required :meta, -> { ArkEmail::APIMeta }
+
+      # @!attribute success
+      #
+      #   @return [Boolean, true]
+      required :success, const: true
+
+      # @!method initialize(data:, meta:, success: true)
+      #   @param data [ArkEmail::Models::TrackingDeleteResponse::Data]
+      #   @param meta [ArkEmail::Models::APIMeta]
+      #   @param success [Boolean, true]
+
+      # @see ArkEmail::Models::TrackingDeleteResponse#data
+      class Data < ArkEmail::Internal::Type::BaseModel
+        # @!attribute message
+        #
+        #   @return [String]
+        required :message, String
+
+        # @!method initialize(message:)
+        #   @param message [String]
+      end
+    end
+  end
+end

data/lib/ark_email/models/tracking_list_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module ArkEmail
+  module Models
+    # @see ArkEmail::Resources::Tracking#list
+    class TrackingListParams < ArkEmail::Internal::Type::BaseModel
+      extend ArkEmail::Internal::Type::RequestParameters::Converter
+      include ArkEmail::Internal::Type::RequestParameters
+
+      # @!method initialize(request_options: {})
+      #   @param request_options [ArkEmail::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/ark_email/models/tracking_list_response.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module ArkEmail
+  module Models
+    # @see ArkEmail::Resources::Tracking#list
+    class TrackingListResponse < ArkEmail::Internal::Type::BaseModel
+      # @!attribute data
+      #
+      #   @return [ArkEmail::Models::TrackingListResponse::Data]
+      required :data, -> { ArkEmail::Models::TrackingListResponse::Data }
+
+      # @!attribute meta
+      #
+      #   @return [ArkEmail::Models::APIMeta]
+      required :meta, -> { ArkEmail::APIMeta }
+
+      # @!attribute success
+      #
+      #   @return [Boolean, true]
+      required :success, const: true
+
+      # @!method initialize(data:, meta:, success: true)
+      #   @param data [ArkEmail::Models::TrackingListResponse::Data]
+      #   @param meta [ArkEmail::Models::APIMeta]
+      #   @param success [Boolean, true]
+
+      # @see ArkEmail::Models::TrackingListResponse#data
+      class Data < ArkEmail::Internal::Type::BaseModel
+        # @!attribute track_domains
+        #
+        #   @return [Array<ArkEmail::Models::TrackDomain>]
+        required :track_domains,
+                 -> { ArkEmail::Internal::Type::ArrayOf[ArkEmail::TrackDomain] },
+                 api_name: :trackDomains
+
+        # @!method initialize(track_domains:)
+        #   @param track_domains [Array<ArkEmail::Models::TrackDomain>]
+      end
+    end
+  end
+end

data/lib/ark_email/models/tracking_retrieve_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module ArkEmail
+  module Models
+    # @see ArkEmail::Resources::Tracking#retrieve
+    class TrackingRetrieveParams < ArkEmail::Internal::Type::BaseModel
+      extend ArkEmail::Internal::Type::RequestParameters::Converter
+      include ArkEmail::Internal::Type::RequestParameters
+
+      # @!method initialize(request_options: {})
+      #   @param request_options [ArkEmail::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/ark_email/models/tracking_retrieve_response.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module ArkEmail
+  module Models
+    # @see ArkEmail::Resources::Tracking#retrieve
+    class TrackingRetrieveResponse < ArkEmail::Internal::Type::BaseModel
+      # @!attribute data
+      #
+      #   @return [ArkEmail::Models::TrackDomain]
+      required :data, -> { ArkEmail::TrackDomain }
+
+      # @!attribute meta
+      #
+      #   @return [ArkEmail::Models::APIMeta]
+      required :meta, -> { ArkEmail::APIMeta }
+
+      # @!attribute success
+      #
+      #   @return [Boolean, true]
+      required :success, const: true
+
+      # @!method initialize(data:, meta:, success: true)
+      #   @param data [ArkEmail::Models::TrackDomain]
+      #   @param meta [ArkEmail::Models::APIMeta]
+      #   @param success [Boolean, true]
+    end
+  end
+end