ark-email 0.5.1

data/lib/ark_email/models/webhook_test_params.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module ArkEmail
+  module Models
+    # @see ArkEmail::Resources::Webhooks#test_
+    class WebhookTestParams < ArkEmail::Internal::Type::BaseModel
+      extend ArkEmail::Internal::Type::RequestParameters::Converter
+      include ArkEmail::Internal::Type::RequestParameters
+
+      # @!attribute event
+      #   Event type to simulate
+      #
+      #   @return [Symbol, ArkEmail::Models::WebhookTestParams::Event]
+      required :event, enum: -> { ArkEmail::WebhookTestParams::Event }
+
+      # @!method initialize(event:, request_options: {})
+      #   @param event [Symbol, ArkEmail::Models::WebhookTestParams::Event] Event type to simulate
+      #
+      #   @param request_options [ArkEmail::RequestOptions, Hash{Symbol=>Object}]
+
+      # Event type to simulate
+      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_test_response.rb

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+
+module ArkEmail
+  module Models
+    # @see ArkEmail::Resources::Webhooks#test_
+    class WebhookTestResponse < ArkEmail::Internal::Type::BaseModel
+      # @!attribute data
+      #
+      #   @return [ArkEmail::Models::WebhookTestResponse::Data]
+      required :data, -> { ArkEmail::Models::WebhookTestResponse::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::WebhookTestResponse::Data]
+      #   @param meta [ArkEmail::Models::APIMeta]
+      #   @param success [Boolean, true]
+
+      # @see ArkEmail::Models::WebhookTestResponse#data
+      class Data < ArkEmail::Internal::Type::BaseModel
+        # @!attribute duration
+        #   Request duration in milliseconds
+        #
+        #   @return [Integer]
+        required :duration, Integer
+
+        # @!attribute event
+        #   Event type that was tested
+        #
+        #   @return [String]
+        required :event, String
+
+        # @!attribute status_code
+        #   HTTP status code from the webhook endpoint
+        #
+        #   @return [Integer, nil]
+        required :status_code, Integer, api_name: :statusCode, nil?: true
+
+        # @!attribute success
+        #   Whether the webhook endpoint responded with a 2xx status
+        #
+        #   @return [Boolean]
+        required :success, ArkEmail::Internal::Type::Boolean
+
+        # @!attribute body
+        #   Response body from the webhook endpoint (truncated if too long)
+        #
+        #   @return [String, nil]
+        optional :body, String, nil?: true
+
+        # @!attribute error
+        #   Error message if the request failed
+        #
+        #   @return [String, nil]
+        optional :error, String, nil?: true
+
+        # @!method initialize(duration:, event:, status_code:, success:, body: nil, error: nil)
+        #   @param duration [Integer] Request duration in milliseconds
+        #
+        #   @param event [String] Event type that was tested
+        #
+        #   @param status_code [Integer, nil] HTTP status code from the webhook endpoint
+        #
+        #   @param success [Boolean] Whether the webhook endpoint responded with a 2xx status
+        #
+        #   @param body [String, nil] Response body from the webhook endpoint (truncated if too long)
+        #
+        #   @param error [String, nil] Error message if the request failed
+      end
+    end
+  end
+end

data/lib/ark_email/models/webhook_update_params.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module ArkEmail
+  module Models
+    # @see ArkEmail::Resources::Webhooks#update
+    class WebhookUpdateParams < ArkEmail::Internal::Type::BaseModel
+      extend ArkEmail::Internal::Type::RequestParameters::Converter
+      include ArkEmail::Internal::Type::RequestParameters
+
+      # @!attribute all_events
+      #
+      #   @return [Boolean, nil]
+      optional :all_events, ArkEmail::Internal::Type::Boolean, api_name: :allEvents
+
+      # @!attribute enabled
+      #
+      #   @return [Boolean, nil]
+      optional :enabled, ArkEmail::Internal::Type::Boolean
+
+      # @!attribute events
+      #
+      #   @return [Array<String>, nil]
+      optional :events, ArkEmail::Internal::Type::ArrayOf[String]
+
+      # @!attribute name
+      #
+      #   @return [String, nil]
+      optional :name, String
+
+      # @!attribute url
+      #
+      #   @return [String, nil]
+      optional :url, String
+
+      # @!method initialize(all_events: nil, enabled: nil, events: nil, name: nil, url: nil, request_options: {})
+      #   @param all_events [Boolean]
+      #   @param enabled [Boolean]
+      #   @param events [Array<String>]
+      #   @param name [String]
+      #   @param url [String]
+      #   @param request_options [ArkEmail::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/ark_email/models/webhook_update_response.rb

@@ -0,0 +1,111 @@
+# frozen_string_literal: true
+
+module ArkEmail
+  module Models
+    # @see ArkEmail::Resources::Webhooks#update
+    class WebhookUpdateResponse < ArkEmail::Internal::Type::BaseModel
+      # @!attribute data
+      #
+      #   @return [ArkEmail::Models::WebhookUpdateResponse::Data]
+      required :data, -> { ArkEmail::Models::WebhookUpdateResponse::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::WebhookUpdateResponse::Data]
+      #   @param meta [ArkEmail::Models::APIMeta]
+      #   @param success [Boolean, true]
+
+      # @see ArkEmail::Models::WebhookUpdateResponse#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::WebhookUpdateResponse::Data::Event>]
+        required :events,
+                 -> { ArkEmail::Internal::Type::ArrayOf[enum: ArkEmail::Models::WebhookUpdateResponse::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::WebhookUpdateResponse::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.rb

@@ -0,0 +1,105 @@
+# frozen_string_literal: true
+
+module ArkEmail
+  [ArkEmail::Internal::Type::BaseModel, *ArkEmail::Internal::Type::BaseModel.subclasses].each do |cls|
+    cls.define_sorbet_constant!(:OrHash) { T.type_alias { T.any(cls, ArkEmail::Internal::AnyHash) } }
+  end
+
+  ArkEmail::Internal::Util.walk_namespaces(ArkEmail::Models).each do |mod|
+    case mod
+    in ArkEmail::Internal::Type::Enum | ArkEmail::Internal::Type::Union
+      mod.constants.each do |name|
+        case mod.const_get(name)
+        in true | false
+          mod.define_sorbet_constant!(:TaggedBoolean) { T.type_alias { T::Boolean } }
+          mod.define_sorbet_constant!(:OrBoolean) { T.type_alias { T::Boolean } }
+        in Integer
+          mod.define_sorbet_constant!(:TaggedInteger) { T.type_alias { Integer } }
+          mod.define_sorbet_constant!(:OrInteger) { T.type_alias { Integer } }
+        in Float
+          mod.define_sorbet_constant!(:TaggedFloat) { T.type_alias { Float } }
+          mod.define_sorbet_constant!(:OrFloat) { T.type_alias { Float } }
+        in Symbol
+          mod.define_sorbet_constant!(:TaggedSymbol) { T.type_alias { Symbol } }
+          mod.define_sorbet_constant!(:OrSymbol) { T.type_alias { T.any(Symbol, String) } }
+        else
+        end
+      end
+    else
+    end
+  end
+
+  ArkEmail::Internal::Util.walk_namespaces(ArkEmail::Models)
+                          .lazy
+                          .grep(ArkEmail::Internal::Type::Union)
+                          .each do |mod|
+    const = :Variants
+    next if mod.sorbet_constant_defined?(const)
+
+    mod.define_sorbet_constant!(const) { T.type_alias { mod.to_sorbet_type } }
+  end
+
+  APIMeta = ArkEmail::Models::APIMeta
+
+  DNSRecord = ArkEmail::Models::DNSRecord
+
+  DomainCreateParams = ArkEmail::Models::DomainCreateParams
+
+  DomainDeleteParams = ArkEmail::Models::DomainDeleteParams
+
+  DomainListParams = ArkEmail::Models::DomainListParams
+
+  DomainRetrieveParams = ArkEmail::Models::DomainRetrieveParams
+
+  DomainVerifyParams = ArkEmail::Models::DomainVerifyParams
+
+  EmailListParams = ArkEmail::Models::EmailListParams
+
+  EmailRetrieveDeliveriesParams = ArkEmail::Models::EmailRetrieveDeliveriesParams
+
+  EmailRetrieveParams = ArkEmail::Models::EmailRetrieveParams
+
+  EmailRetryParams = ArkEmail::Models::EmailRetryParams
+
+  EmailSendBatchParams = ArkEmail::Models::EmailSendBatchParams
+
+  EmailSendParams = ArkEmail::Models::EmailSendParams
+
+  EmailSendRawParams = ArkEmail::Models::EmailSendRawParams
+
+  SuppressionBulkCreateParams = ArkEmail::Models::SuppressionBulkCreateParams
+
+  SuppressionCreateParams = ArkEmail::Models::SuppressionCreateParams
+
+  SuppressionDeleteParams = ArkEmail::Models::SuppressionDeleteParams
+
+  SuppressionListParams = ArkEmail::Models::SuppressionListParams
+
+  SuppressionRetrieveParams = ArkEmail::Models::SuppressionRetrieveParams
+
+  TrackDomain = ArkEmail::Models::TrackDomain
+
+  TrackingCreateParams = ArkEmail::Models::TrackingCreateParams
+
+  TrackingDeleteParams = ArkEmail::Models::TrackingDeleteParams
+
+  TrackingListParams = ArkEmail::Models::TrackingListParams
+
+  TrackingRetrieveParams = ArkEmail::Models::TrackingRetrieveParams
+
+  TrackingUpdateParams = ArkEmail::Models::TrackingUpdateParams
+
+  TrackingVerifyParams = ArkEmail::Models::TrackingVerifyParams
+
+  WebhookCreateParams = ArkEmail::Models::WebhookCreateParams
+
+  WebhookDeleteParams = ArkEmail::Models::WebhookDeleteParams
+
+  WebhookListParams = ArkEmail::Models::WebhookListParams
+
+  WebhookRetrieveParams = ArkEmail::Models::WebhookRetrieveParams
+
+  WebhookTestParams = ArkEmail::Models::WebhookTestParams
+
+  WebhookUpdateParams = ArkEmail::Models::WebhookUpdateParams
+end

data/lib/ark_email/request_options.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+module ArkEmail
+  # Specify HTTP behaviour to use for a specific request. These options supplement
+  # or override those provided at the client level.
+  #
+  # When making a request, you can pass an actual {RequestOptions} instance, or
+  # simply pass a Hash with symbol keys matching the attributes on this class.
+  class RequestOptions < ArkEmail::Internal::Type::BaseModel
+    # @api private
+    #
+    # @param opts [ArkEmail::RequestOptions, Hash{Symbol=>Object}]
+    #
+    # @raise [ArgumentError]
+    def self.validate!(opts)
+      case opts
+      in ArkEmail::RequestOptions | Hash
+        opts.to_h.each_key do |k|
+          unless fields.include?(k)
+            raise ArgumentError.new("Request `opts` keys must be one of #{fields.keys}, got #{k.inspect}")
+          end
+        end
+      else
+        raise ArgumentError.new("Request `opts` must be a Hash or RequestOptions, got #{opts.inspect}")
+      end
+    end
+
+    # @!attribute idempotency_key
+    #   Idempotency key to send with request and all associated retries. Will only be
+    #   sent for write requests.
+    #
+    #   @return [String, nil]
+    optional :idempotency_key, String
+
+    # @!attribute extra_query
+    #   Extra query params to send with the request. These are `.merge`’d into any
+    #   `query` given at the client level.
+    #
+    #   @return [Hash{String=>Array<String>, String, nil}, nil]
+    optional :extra_query, ArkEmail::Internal::Type::HashOf[ArkEmail::Internal::Type::ArrayOf[String]]
+
+    # @!attribute extra_headers
+    #   Extra headers to send with the request. These are `.merged`’d into any
+    #   `extra_headers` given at the client level.
+    #
+    #   @return [Hash{String=>String, nil}, nil]
+    optional :extra_headers, ArkEmail::Internal::Type::HashOf[String, nil?: true]
+
+    # @!attribute extra_body
+    #   Extra data to send with the request. These are deep merged into any data
+    #   generated as part of the normal request.
+    #
+    #   @return [Object, nil]
+    optional :extra_body, ArkEmail::Internal::Type::HashOf[ArkEmail::Internal::Type::Unknown]
+
+    # @!attribute max_retries
+    #   Maximum number of retries to attempt after a failed initial request.
+    #
+    #   @return [Integer, nil]
+    optional :max_retries, Integer
+
+    # @!attribute timeout
+    #   Request timeout in seconds.
+    #
+    #   @return [Float, nil]
+    optional :timeout, Float
+
+    # @!method initialize(values = {})
+    #   Returns a new instance of RequestOptions.
+    #
+    #   @param values [Hash{Symbol=>Object}]
+
+    define_sorbet_constant!(:OrHash) do
+      T.type_alias { T.any(ArkEmail::RequestOptions, ArkEmail::Internal::AnyHash) }
+    end
+  end
+end

data/lib/ark_email/resources/domains.rb

@@ -0,0 +1,127 @@
+# frozen_string_literal: true
+
+module ArkEmail
+  module Resources
+    class Domains
+      # Add a new domain for sending emails. Returns DNS records that must be configured
+      # before the domain can be verified.
+      #
+      # **Required DNS records:**
+      #
+      # - **SPF** - TXT record for sender authentication
+      # - **DKIM** - TXT record for email signing
+      # - **Return Path** - CNAME for bounce handling
+      #
+      # After adding DNS records, call `POST /domains/{id}/verify` to verify.
+      #
+      # @overload create(name:, request_options: {})
+      #
+      # @param name [String] Domain name (e.g., "mail.example.com")
+      #
+      # @param request_options [ArkEmail::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [ArkEmail::Models::DomainCreateResponse]
+      #
+      # @see ArkEmail::Models::DomainCreateParams
+      def create(params)
+        parsed, options = ArkEmail::DomainCreateParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: "domains",
+          body: parsed,
+          model: ArkEmail::Models::DomainCreateResponse,
+          options: options
+        )
+      end
+
+      # Get detailed information about a domain including DNS record status
+      #
+      # @overload retrieve(domain_id, request_options: {})
+      #
+      # @param domain_id [String] Domain ID or domain name
+      #
+      # @param request_options [ArkEmail::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [ArkEmail::Models::DomainRetrieveResponse]
+      #
+      # @see ArkEmail::Models::DomainRetrieveParams
+      def retrieve(domain_id, params = {})
+        @client.request(
+          method: :get,
+          path: ["domains/%1$s", domain_id],
+          model: ArkEmail::Models::DomainRetrieveResponse,
+          options: params[:request_options]
+        )
+      end
+
+      # Get all sending domains with their verification status
+      #
+      # @overload list(request_options: {})
+      #
+      # @param request_options [ArkEmail::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [ArkEmail::Models::DomainListResponse]
+      #
+      # @see ArkEmail::Models::DomainListParams
+      def list(params = {})
+        @client.request(
+          method: :get,
+          path: "domains",
+          model: ArkEmail::Models::DomainListResponse,
+          options: params[:request_options]
+        )
+      end
+
+      # Remove a sending domain. You will no longer be able to send emails from this
+      # domain.
+      #
+      # **Warning:** This action cannot be undone.
+      #
+      # @overload delete(domain_id, request_options: {})
+      #
+      # @param domain_id [String]
+      # @param request_options [ArkEmail::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [ArkEmail::Models::DomainDeleteResponse]
+      #
+      # @see ArkEmail::Models::DomainDeleteParams
+      def delete(domain_id, params = {})
+        @client.request(
+          method: :delete,
+          path: ["domains/%1$s", domain_id],
+          model: ArkEmail::Models::DomainDeleteResponse,
+          options: params[:request_options]
+        )
+      end
+
+      # Check if DNS records are correctly configured and verify the domain. Returns the
+      # current status of each required DNS record.
+      #
+      # Call this after you've added the DNS records shown when creating the domain.
+      #
+      # @overload verify(domain_id, request_options: {})
+      #
+      # @param domain_id [String]
+      # @param request_options [ArkEmail::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [ArkEmail::Models::DomainVerifyResponse]
+      #
+      # @see ArkEmail::Models::DomainVerifyParams
+      def verify(domain_id, params = {})
+        @client.request(
+          method: :post,
+          path: ["domains/%1$s/verify", domain_id],
+          model: ArkEmail::Models::DomainVerifyResponse,
+          options: params[:request_options]
+        )
+      end
+
+      # @api private
+      #
+      # @param client [ArkEmail::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end