ark-email 0.5.1

data/lib/ark_email/models/tracking_update_params.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module ArkEmail
+  module Models
+    # @see ArkEmail::Resources::Tracking#update
+    class TrackingUpdateParams < ArkEmail::Internal::Type::BaseModel
+      extend ArkEmail::Internal::Type::RequestParameters::Converter
+      include ArkEmail::Internal::Type::RequestParameters
+
+      # @!attribute excluded_click_domains
+      #   Comma-separated list of domains to exclude from click tracking
+      #
+      #   @return [String, nil]
+      optional :excluded_click_domains, String, api_name: :excludedClickDomains
+
+      # @!attribute ssl_enabled
+      #   Enable or disable SSL for tracking URLs
+      #
+      #   @return [Boolean, nil]
+      optional :ssl_enabled, ArkEmail::Internal::Type::Boolean, api_name: :sslEnabled
+
+      # @!attribute track_clicks
+      #   Enable or disable click tracking
+      #
+      #   @return [Boolean, nil]
+      optional :track_clicks, ArkEmail::Internal::Type::Boolean, api_name: :trackClicks
+
+      # @!attribute track_opens
+      #   Enable or disable open tracking
+      #
+      #   @return [Boolean, nil]
+      optional :track_opens, ArkEmail::Internal::Type::Boolean, api_name: :trackOpens
+
+      # @!method initialize(excluded_click_domains: nil, ssl_enabled: nil, track_clicks: nil, track_opens: nil, request_options: {})
+      #   @param excluded_click_domains [String] Comma-separated list of domains to exclude from click tracking
+      #
+      #   @param ssl_enabled [Boolean] Enable or disable SSL for tracking URLs
+      #
+      #   @param track_clicks [Boolean] Enable or disable click tracking
+      #
+      #   @param track_opens [Boolean] Enable or disable open tracking
+      #
+      #   @param request_options [ArkEmail::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/ark_email/models/tracking_update_response.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module ArkEmail
+  module Models
+    # @see ArkEmail::Resources::Tracking#update
+    class TrackingUpdateResponse < 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_verify_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module ArkEmail
+  module Models
+    # @see ArkEmail::Resources::Tracking#verify
+    class TrackingVerifyParams < 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_verify_response.rb

@@ -0,0 +1,133 @@
+# frozen_string_literal: true
+
+module ArkEmail
+  module Models
+    # @see ArkEmail::Resources::Tracking#verify
+    class TrackingVerifyResponse < ArkEmail::Internal::Type::BaseModel
+      # @!attribute data
+      #
+      #   @return [ArkEmail::Models::TrackingVerifyResponse::Data]
+      required :data, -> { ArkEmail::Models::TrackingVerifyResponse::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::TrackingVerifyResponse::Data]
+      #   @param meta [ArkEmail::Models::APIMeta]
+      #   @param success [Boolean, true]
+
+      # @see ArkEmail::Models::TrackingVerifyResponse#data
+      class Data < ArkEmail::Internal::Type::BaseModel
+        # @!attribute id
+        #   Track domain ID
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute dns_ok
+        #   Whether DNS is correctly configured
+        #
+        #   @return [Boolean]
+        required :dns_ok, ArkEmail::Internal::Type::Boolean, api_name: :dnsOk
+
+        # @!attribute dns_status
+        #   Current DNS verification status
+        #
+        #   @return [Symbol, ArkEmail::Models::TrackingVerifyResponse::Data::DNSStatus, nil]
+        required :dns_status,
+                 enum: -> { ArkEmail::Models::TrackingVerifyResponse::Data::DNSStatus },
+                 api_name: :dnsStatus,
+                 nil?: true
+
+        # @!attribute full_name
+        #   Full domain name
+        #
+        #   @return [String]
+        required :full_name, String, api_name: :fullName
+
+        # @!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::TrackingVerifyResponse::Data::DNSRecord, nil]
+        optional :dns_record,
+                 -> { ArkEmail::Models::TrackingVerifyResponse::Data::DNSRecord },
+                 api_name: :dnsRecord,
+                 nil?: true
+
+        # @!method initialize(id:, dns_ok:, dns_status:, full_name:, dns_checked_at: nil, dns_error: nil, dns_record: nil)
+        #   @param id [String] Track domain ID
+        #
+        #   @param dns_ok [Boolean] Whether DNS is correctly configured
+        #
+        #   @param dns_status [Symbol, ArkEmail::Models::TrackingVerifyResponse::Data::DNSStatus, nil] Current DNS verification status
+        #
+        #   @param full_name [String] Full domain name
+        #
+        #   @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::TrackingVerifyResponse::Data::DNSRecord, nil] Required DNS record configuration
+
+        # Current DNS verification status
+        #
+        # @see ArkEmail::Models::TrackingVerifyResponse::Data#dns_status
+        module DNSStatus
+          extend ArkEmail::Internal::Type::Enum
+
+          OK = :ok
+          MISSING = :missing
+          INVALID = :invalid
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
+        # @see ArkEmail::Models::TrackingVerifyResponse::Data#dns_record
+        class DNSRecord < ArkEmail::Internal::Type::BaseModel
+          # @!attribute name
+          #
+          #   @return [String, nil]
+          optional :name, String
+
+          # @!attribute type
+          #
+          #   @return [String, nil]
+          optional :type, String
+
+          # @!attribute value
+          #
+          #   @return [String, nil]
+          optional :value, String
+
+          # @!method initialize(name: nil, type: nil, value: nil)
+          #   Required DNS record configuration
+          #
+          #   @param name [String]
+          #   @param type [String]
+          #   @param value [String]
+        end
+      end
+    end
+  end
+end

data/lib/ark_email/models/webhook_create_params.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+module ArkEmail
+  module Models
+    # @see ArkEmail::Resources::Webhooks#create
+    class WebhookCreateParams < ArkEmail::Internal::Type::BaseModel
+      extend ArkEmail::Internal::Type::RequestParameters::Converter
+      include ArkEmail::Internal::Type::RequestParameters
+
+      # @!attribute events
+      #   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
+      #
+      #   @return [Array<Symbol, ArkEmail::Models::WebhookCreateParams::Event>]
+      required :events, -> { ArkEmail::Internal::Type::ArrayOf[enum: ArkEmail::WebhookCreateParams::Event] }
+
+      # @!attribute name
+      #   Webhook name for identification
+      #
+      #   @return [String]
+      required :name, String
+
+      # @!attribute url
+      #   HTTPS endpoint URL
+      #
+      #   @return [String]
+      required :url, String
+
+      # @!attribute all_events
+      #   Subscribe to all events (ignores events array)
+      #
+      #   @return [Boolean, nil]
+      optional :all_events, ArkEmail::Internal::Type::Boolean, api_name: :allEvents
+
+      # @!attribute enabled
+      #
+      #   @return [Boolean, nil]
+      optional :enabled, ArkEmail::Internal::Type::Boolean
+
+      # @!method initialize(events:, name:, url:, all_events: nil, enabled: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {ArkEmail::Models::WebhookCreateParams} for more details.
+      #
+      #   @param events [Array<Symbol, ArkEmail::Models::WebhookCreateParams::Event>] Events to subscribe to:
+      #
+      #   @param name [String] Webhook name for identification
+      #
+      #   @param url [String] HTTPS endpoint URL
+      #
+      #   @param all_events [Boolean] Subscribe to all events (ignores events array)
+      #
+      #   @param enabled [Boolean]
+      #
+      #   @param request_options [ArkEmail::RequestOptions, Hash{Symbol=>Object}]
+
+      module Event
+        extend ArkEmail::Internal::Type::Enum
+
+        MESSAGE_SENT = :MessageSent
+        MESSAGE_DELAYED = :MessageDelayed
+        MESSAGE_DELIVERY_FAILED = :MessageDeliveryFailed
+        MESSAGE_HELD = :MessageHeld
+        MESSAGE_BOUNCED = :MessageBounced
+        MESSAGE_LINK_CLICKED = :MessageLinkClicked
+        MESSAGE_LOADED = :MessageLoaded
+        DOMAIN_DNS_ERROR = :DomainDNSError
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/ark_email/models/webhook_create_response.rb

@@ -0,0 +1,111 @@
+# frozen_string_literal: true
+
+module ArkEmail
+  module Models
+    # @see ArkEmail::Resources::Webhooks#create
+    class WebhookCreateResponse < ArkEmail::Internal::Type::BaseModel
+      # @!attribute data
+      #
+      #   @return [ArkEmail::Models::WebhookCreateResponse::Data]
+      required :data, -> { ArkEmail::Models::WebhookCreateResponse::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::WebhookCreateResponse::Data]
+      #   @param meta [ArkEmail::Models::APIMeta]
+      #   @param success [Boolean, true]
+
+      # @see ArkEmail::Models::WebhookCreateResponse#data
+      class Data < ArkEmail::Internal::Type::BaseModel
+        # @!attribute id
+        #   Webhook ID
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute all_events
+        #   Whether subscribed to all events
+        #
+        #   @return [Boolean]
+        required :all_events, ArkEmail::Internal::Type::Boolean, api_name: :allEvents
+
+        # @!attribute created_at
+        #
+        #   @return [Time]
+        required :created_at, Time, api_name: :createdAt
+
+        # @!attribute enabled
+        #   Whether the webhook is active
+        #
+        #   @return [Boolean]
+        required :enabled, ArkEmail::Internal::Type::Boolean
+
+        # @!attribute events
+        #   Subscribed events
+        #
+        #   @return [Array<Symbol, ArkEmail::Models::WebhookCreateResponse::Data::Event>]
+        required :events,
+                 -> { ArkEmail::Internal::Type::ArrayOf[enum: ArkEmail::Models::WebhookCreateResponse::Data::Event] }
+
+        # @!attribute name
+        #   Webhook name for identification
+        #
+        #   @return [String]
+        required :name, String
+
+        # @!attribute url
+        #   Webhook endpoint URL
+        #
+        #   @return [String]
+        required :url, String
+
+        # @!attribute uuid
+        #
+        #   @return [String]
+        required :uuid, String
+
+        # @!method initialize(id:, all_events:, created_at:, enabled:, events:, name:, url:, uuid:)
+        #   @param id [String] Webhook ID
+        #
+        #   @param all_events [Boolean] Whether subscribed to all events
+        #
+        #   @param created_at [Time]
+        #
+        #   @param enabled [Boolean] Whether the webhook is active
+        #
+        #   @param events [Array<Symbol, ArkEmail::Models::WebhookCreateResponse::Data::Event>] Subscribed events
+        #
+        #   @param name [String] Webhook name for identification
+        #
+        #   @param url [String] Webhook endpoint URL
+        #
+        #   @param uuid [String]
+
+        module Event
+          extend ArkEmail::Internal::Type::Enum
+
+          MESSAGE_SENT = :MessageSent
+          MESSAGE_DELAYED = :MessageDelayed
+          MESSAGE_DELIVERY_FAILED = :MessageDeliveryFailed
+          MESSAGE_HELD = :MessageHeld
+          MESSAGE_BOUNCED = :MessageBounced
+          MESSAGE_LINK_CLICKED = :MessageLinkClicked
+          MESSAGE_LOADED = :MessageLoaded
+          DOMAIN_DNS_ERROR = :DomainDNSError
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

data/lib/ark_email/models/webhook_delete_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module ArkEmail
+  module Models
+    # @see ArkEmail::Resources::Webhooks#delete
+    class WebhookDeleteParams < 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/webhook_delete_response.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module ArkEmail
+  module Models
+    # @see ArkEmail::Resources::Webhooks#delete
+    class WebhookDeleteResponse < ArkEmail::Internal::Type::BaseModel
+      # @!attribute data
+      #
+      #   @return [ArkEmail::Models::WebhookDeleteResponse::Data]
+      required :data, -> { ArkEmail::Models::WebhookDeleteResponse::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::WebhookDeleteResponse::Data]
+      #   @param meta [ArkEmail::Models::APIMeta]
+      #   @param success [Boolean, true]
+
+      # @see ArkEmail::Models::WebhookDeleteResponse#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/webhook_list_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module ArkEmail
+  module Models
+    # @see ArkEmail::Resources::Webhooks#list
+    class WebhookListParams < 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/webhook_list_response.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+module ArkEmail
+  module Models
+    # @see ArkEmail::Resources::Webhooks#list
+    class WebhookListResponse < ArkEmail::Internal::Type::BaseModel
+      # @!attribute data
+      #
+      #   @return [ArkEmail::Models::WebhookListResponse::Data]
+      required :data, -> { ArkEmail::Models::WebhookListResponse::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::WebhookListResponse::Data]
+      #   @param meta [ArkEmail::Models::APIMeta]
+      #   @param success [Boolean, true]
+
+      # @see ArkEmail::Models::WebhookListResponse#data
+      class Data < ArkEmail::Internal::Type::BaseModel
+        # @!attribute webhooks
+        #
+        #   @return [Array<ArkEmail::Models::WebhookListResponse::Data::Webhook>]
+        required :webhooks,
+                 -> { ArkEmail::Internal::Type::ArrayOf[ArkEmail::Models::WebhookListResponse::Data::Webhook] }
+
+        # @!method initialize(webhooks:)
+        #   @param webhooks [Array<ArkEmail::Models::WebhookListResponse::Data::Webhook>]
+
+        class Webhook < ArkEmail::Internal::Type::BaseModel
+          # @!attribute id
+          #   Webhook ID
+          #
+          #   @return [String]
+          required :id, String
+
+          # @!attribute enabled
+          #
+          #   @return [Boolean]
+          required :enabled, ArkEmail::Internal::Type::Boolean
+
+          # @!attribute events
+          #
+          #   @return [Array<String>]
+          required :events, ArkEmail::Internal::Type::ArrayOf[String]
+
+          # @!attribute name
+          #
+          #   @return [String]
+          required :name, String
+
+          # @!attribute url
+          #
+          #   @return [String]
+          required :url, String
+
+          # @!method initialize(id:, enabled:, events:, name:, url:)
+          #   @param id [String] Webhook ID
+          #
+          #   @param enabled [Boolean]
+          #
+          #   @param events [Array<String>]
+          #
+          #   @param name [String]
+          #
+          #   @param url [String]
+        end
+      end
+    end
+  end
+end

data/lib/ark_email/models/webhook_retrieve_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module ArkEmail
+  module Models
+    # @see ArkEmail::Resources::Webhooks#retrieve
+    class WebhookRetrieveParams < 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/webhook_retrieve_response.rb

@@ -0,0 +1,111 @@
+# frozen_string_literal: true
+
+module ArkEmail
+  module Models
+    # @see ArkEmail::Resources::Webhooks#retrieve
+    class WebhookRetrieveResponse < ArkEmail::Internal::Type::BaseModel
+      # @!attribute data
+      #
+      #   @return [ArkEmail::Models::WebhookRetrieveResponse::Data]
+      required :data, -> { ArkEmail::Models::WebhookRetrieveResponse::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::WebhookRetrieveResponse::Data]
+      #   @param meta [ArkEmail::Models::APIMeta]
+      #   @param success [Boolean, true]
+
+      # @see ArkEmail::Models::WebhookRetrieveResponse#data
+      class Data < ArkEmail::Internal::Type::BaseModel
+        # @!attribute id
+        #   Webhook ID
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute all_events
+        #   Whether subscribed to all events
+        #
+        #   @return [Boolean]
+        required :all_events, ArkEmail::Internal::Type::Boolean, api_name: :allEvents
+
+        # @!attribute created_at
+        #
+        #   @return [Time]
+        required :created_at, Time, api_name: :createdAt
+
+        # @!attribute enabled
+        #   Whether the webhook is active
+        #
+        #   @return [Boolean]
+        required :enabled, ArkEmail::Internal::Type::Boolean
+
+        # @!attribute events
+        #   Subscribed events
+        #
+        #   @return [Array<Symbol, ArkEmail::Models::WebhookRetrieveResponse::Data::Event>]
+        required :events,
+                 -> { ArkEmail::Internal::Type::ArrayOf[enum: ArkEmail::Models::WebhookRetrieveResponse::Data::Event] }
+
+        # @!attribute name
+        #   Webhook name for identification
+        #
+        #   @return [String]
+        required :name, String
+
+        # @!attribute url
+        #   Webhook endpoint URL
+        #
+        #   @return [String]
+        required :url, String
+
+        # @!attribute uuid
+        #
+        #   @return [String]
+        required :uuid, String
+
+        # @!method initialize(id:, all_events:, created_at:, enabled:, events:, name:, url:, uuid:)
+        #   @param id [String] Webhook ID
+        #
+        #   @param all_events [Boolean] Whether subscribed to all events
+        #
+        #   @param created_at [Time]
+        #
+        #   @param enabled [Boolean] Whether the webhook is active
+        #
+        #   @param events [Array<Symbol, ArkEmail::Models::WebhookRetrieveResponse::Data::Event>] Subscribed events
+        #
+        #   @param name [String] Webhook name for identification
+        #
+        #   @param url [String] Webhook endpoint URL
+        #
+        #   @param uuid [String]
+
+        module Event
+          extend ArkEmail::Internal::Type::Enum
+
+          MESSAGE_SENT = :MessageSent
+          MESSAGE_DELAYED = :MessageDelayed
+          MESSAGE_DELIVERY_FAILED = :MessageDeliveryFailed
+          MESSAGE_HELD = :MessageHeld
+          MESSAGE_BOUNCED = :MessageBounced
+          MESSAGE_LINK_CLICKED = :MessageLinkClicked
+          MESSAGE_LOADED = :MessageLoaded
+          DOMAIN_DNS_ERROR = :DomainDNSError
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end