ark-email 0.5.2 → 0.7.0

data/rbi/ark_email/models/webhook_create_params.rbi

@@ -11,19 +11,6 @@ module ArkEmail
           T.any(ArkEmail::WebhookCreateParams, ArkEmail::Internal::AnyHash)
         end
 
-      # 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
-      sig { returns(T::Array[ArkEmail::WebhookCreateParams::Event::OrSymbol]) }
-      attr_accessor :events
-
       # Webhook name for identification
       sig { returns(String) }
       attr_accessor :name
@@ -32,31 +19,52 @@ module ArkEmail
       sig { returns(String) }
       attr_accessor :url
 
-      # Subscribe to all events (ignores events array)
+      # Subscribe to all events (ignores events array, accepts null)
       sig { returns(T.nilable(T::Boolean)) }
-      attr_reader :all_events
-
-      sig { params(all_events: T::Boolean).void }
-      attr_writer :all_events
+      attr_accessor :all_events
 
+      # Whether the webhook is enabled (accepts null)
       sig { returns(T.nilable(T::Boolean)) }
-      attr_reader :enabled
+      attr_accessor :enabled
 
-      sig { params(enabled: T::Boolean).void }
-      attr_writer :enabled
+      # Events to subscribe to (accepts null):
+      #
+      # - `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
+      sig do
+        returns(
+          T.nilable(T::Array[ArkEmail::WebhookCreateParams::Event::OrSymbol])
+        )
+      end
+      attr_accessor :events
 
       sig do
         params(
-          events: T::Array[ArkEmail::WebhookCreateParams::Event::OrSymbol],
           name: String,
           url: String,
-          all_events: T::Boolean,
-          enabled: T::Boolean,
+          all_events: T.nilable(T::Boolean),
+          enabled: T.nilable(T::Boolean),
+          events:
+            T.nilable(T::Array[ArkEmail::WebhookCreateParams::Event::OrSymbol]),
           request_options: ArkEmail::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
       def self.new(
-        # Events to subscribe to:
+        # Webhook name for identification
+        name:,
+        # HTTPS endpoint URL
+        url:,
+        # Subscribe to all events (ignores events array, accepts null)
+        all_events: nil,
+        # Whether the webhook is enabled (accepts null)
+        enabled: nil,
+        # Events to subscribe to (accepts null):
         #
         # - `MessageSent` - Email successfully delivered to recipient's server
         # - `MessageDelayed` - Temporary delivery failure, will retry
@@ -66,14 +74,7 @@ module ArkEmail
         # - `MessageLinkClicked` - Recipient clicked a tracked link
         # - `MessageLoaded` - Recipient opened the email (tracking pixel loaded)
         # - `DomainDNSError` - DNS configuration issue detected
-        events:,
-        # Webhook name for identification
-        name:,
-        # HTTPS endpoint URL
-        url:,
-        # Subscribe to all events (ignores events array)
-        all_events: nil,
-        enabled: nil,
+        events: nil,
         request_options: {}
       )
       end
@@ -81,11 +82,14 @@ module ArkEmail
       sig do
         override.returns(
           {
-            events: T::Array[ArkEmail::WebhookCreateParams::Event::OrSymbol],
             name: String,
             url: String,
-            all_events: T::Boolean,
-            enabled: T::Boolean,
+            all_events: T.nilable(T::Boolean),
+            enabled: T.nilable(T::Boolean),
+            events:
+              T.nilable(
+                T::Array[ArkEmail::WebhookCreateParams::Event::OrSymbol]
+              ),
             request_options: ArkEmail::RequestOptions
           }
         )

data/rbi/ark_email/models/webhook_update_params.rbi

@@ -12,42 +12,27 @@ module ArkEmail
         end
 
       sig { returns(T.nilable(T::Boolean)) }
-      attr_reader :all_events
-
-      sig { params(all_events: T::Boolean).void }
-      attr_writer :all_events
+      attr_accessor :all_events
 
       sig { returns(T.nilable(T::Boolean)) }
-      attr_reader :enabled
-
-      sig { params(enabled: T::Boolean).void }
-      attr_writer :enabled
+      attr_accessor :enabled
 
       sig { returns(T.nilable(T::Array[String])) }
-      attr_reader :events
-
-      sig { params(events: T::Array[String]).void }
-      attr_writer :events
+      attr_accessor :events
 
       sig { returns(T.nilable(String)) }
-      attr_reader :name
-
-      sig { params(name: String).void }
-      attr_writer :name
+      attr_accessor :name
 
       sig { returns(T.nilable(String)) }
-      attr_reader :url
-
-      sig { params(url: String).void }
-      attr_writer :url
+      attr_accessor :url
 
       sig do
         params(
-          all_events: T::Boolean,
-          enabled: T::Boolean,
-          events: T::Array[String],
-          name: String,
-          url: String,
+          all_events: T.nilable(T::Boolean),
+          enabled: T.nilable(T::Boolean),
+          events: T.nilable(T::Array[String]),
+          name: T.nilable(String),
+          url: T.nilable(String),
           request_options: ArkEmail::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
@@ -64,11 +49,11 @@ module ArkEmail
       sig do
         override.returns(
           {
-            all_events: T::Boolean,
-            enabled: T::Boolean,
-            events: T::Array[String],
-            name: String,
-            url: String,
+            all_events: T.nilable(T::Boolean),
+            enabled: T.nilable(T::Boolean),
+            events: T.nilable(T::Array[String]),
+            name: T.nilable(String),
+            url: T.nilable(String),
             request_options: ArkEmail::RequestOptions
           }
         )

data/rbi/ark_email/resources/emails.rbi

@@ -126,14 +126,16 @@ module ArkEmail
           from: String,
           subject: String,
           to: T::Array[String],
-          attachments: T::Array[ArkEmail::EmailSendParams::Attachment::OrHash],
-          bcc: T::Array[String],
-          cc: T::Array[String],
-          headers: T::Hash[Symbol, String],
-          html: String,
-          reply_to: String,
-          tag: String,
-          text: String,
+          attachments:
+            T.nilable(T::Array[ArkEmail::EmailSendParams::Attachment::OrHash]),
+          bcc: T.nilable(T::Array[String]),
+          cc: T.nilable(T::Array[String]),
+          headers: T.nilable(T::Hash[Symbol, String]),
+          html: T.nilable(String),
+          metadata: T.nilable(T::Hash[Symbol, String]),
+          reply_to: T.nilable(String),
+          tag: T.nilable(String),
+          text: T.nilable(String),
           idempotency_key: String,
           request_options: ArkEmail::RequestOptions::OrHash
         ).returns(ArkEmail::Models::EmailSendResponse)
@@ -153,23 +155,34 @@ module ArkEmail
         subject:,
         # Body param: Recipient email addresses (max 50)
         to:,
-        # Body param: File attachments
+        # Body param: File attachments (accepts null)
         attachments: nil,
-        # Body param: BCC recipients
+        # Body param: BCC recipients (accepts null)
         bcc: nil,
-        # Body param: CC recipients
+        # Body param: CC recipients (accepts null)
         cc: nil,
-        # Body param: Custom email headers
+        # Body param: Custom email headers (accepts null)
         headers: nil,
-        # Body param: HTML body content. Maximum 5MB (5,242,880 characters). Combined with
-        # attachments, the total message must not exceed 14MB.
+        # Body param: HTML body content (accepts null). Maximum 5MB (5,242,880
+        # characters). Combined with attachments, the total message must not exceed 14MB.
         html: nil,
-        # Body param: Reply-to address
+        # Body param: Custom key-value pairs attached to an email for webhook correlation.
+        #
+        # When you send an email with metadata, these key-value pairs are:
+        #
+        # - **Stored** with the message
+        # - **Returned** in all webhook event payloads (MessageSent, MessageBounced, etc.)
+        # - **Never visible** to email recipients
+        #
+        # This is useful for correlating webhook events with your internal systems (e.g.,
+        # user IDs, order IDs, campaign identifiers).
+        metadata: nil,
+        # Body param: Reply-to address (accepts null)
         reply_to: nil,
-        # Body param: Tag for categorization and filtering
+        # Body param: Tag for categorization and filtering (accepts null)
         tag: nil,
-        # Body param: Plain text body (auto-generated from HTML if not provided). Maximum
-        # 5MB (5,242,880 characters).
+        # Body param: Plain text body (accepts null, auto-generated from HTML if not
+        # provided). Maximum 5MB (5,242,880 characters).
         text: nil,
         # Header param: Unique key for idempotent requests. If a request with this key was
         # already processed, the cached response is returned. Keys expire after 24 hours.
@@ -194,7 +207,7 @@ module ArkEmail
         ).returns(ArkEmail::Models::EmailSendBatchResponse)
       end
       def send_batch(
-        # Body param:
+        # Body param
         emails:,
         # Body param: Sender email for all messages
         from:,
@@ -214,6 +227,7 @@ module ArkEmail
           data: String,
           mail_from: String,
           rcpt_to: T::Array[String],
+          bounce: T.nilable(T::Boolean),
           request_options: ArkEmail::RequestOptions::OrHash
         ).returns(ArkEmail::Models::EmailSendRawResponse)
       end
@@ -224,6 +238,8 @@ module ArkEmail
         mail_from:,
         # Envelope recipient addresses
         rcpt_to:,
+        # Whether this is a bounce message (accepts null)
+        bounce: nil,
         request_options: {}
       )
       end

data/rbi/ark_email/resources/suppressions.rbi

@@ -8,14 +8,14 @@ module ArkEmail
       sig do
         params(
           address: String,
-          reason: String,
+          reason: T.nilable(String),
           request_options: ArkEmail::RequestOptions::OrHash
         ).returns(ArkEmail::Models::SuppressionCreateResponse)
       end
       def create(
         # Email address to suppress
         address:,
-        # Reason for suppression
+        # Reason for suppression (accepts null)
         reason: nil,
         request_options: {}
       )

data/rbi/ark_email/resources/tracking.rbi

@@ -9,11 +9,11 @@ module ArkEmail
       # value before tracking will work.
       sig do
         params(
-          domain_id: String,
+          domain_id: Integer,
           name: String,
-          ssl_enabled: T::Boolean,
-          track_clicks: T::Boolean,
-          track_opens: T::Boolean,
+          ssl_enabled: T.nilable(T::Boolean),
+          track_clicks: T.nilable(T::Boolean),
+          track_opens: T.nilable(T::Boolean),
           request_options: ArkEmail::RequestOptions::OrHash
         ).returns(ArkEmail::Models::TrackingCreateResponse)
       end
@@ -22,11 +22,11 @@ module ArkEmail
         domain_id:,
         # Subdomain name (e.g., 'track' for track.yourdomain.com)
         name:,
-        # Enable SSL for tracking URLs (recommended)
+        # Enable SSL for tracking URLs (accepts null, defaults to true)
         ssl_enabled: nil,
-        # Enable click tracking
+        # Enable click tracking (accepts null, defaults to true)
         track_clicks: nil,
-        # Enable open tracking (tracking pixel)
+        # Enable open tracking (tracking pixel, accepts null, defaults to true)
         track_opens: nil,
         request_options: {}
       )
@@ -57,23 +57,23 @@ module ArkEmail
       sig do
         params(
           tracking_id: String,
-          excluded_click_domains: String,
-          ssl_enabled: T::Boolean,
-          track_clicks: T::Boolean,
-          track_opens: T::Boolean,
+          excluded_click_domains: T.nilable(String),
+          ssl_enabled: T.nilable(T::Boolean),
+          track_clicks: T.nilable(T::Boolean),
+          track_opens: T.nilable(T::Boolean),
           request_options: ArkEmail::RequestOptions::OrHash
         ).returns(ArkEmail::Models::TrackingUpdateResponse)
       end
       def update(
         # Track domain ID or UUID
         tracking_id,
-        # Comma-separated list of domains to exclude from click tracking
+        # Comma-separated list of domains to exclude from click tracking (accepts null)
         excluded_click_domains: nil,
-        # Enable or disable SSL for tracking URLs
+        # Enable or disable SSL for tracking URLs (accepts null)
         ssl_enabled: nil,
-        # Enable or disable click tracking
+        # Enable or disable click tracking (accepts null)
         track_clicks: nil,
-        # Enable or disable open tracking
+        # Enable or disable open tracking (accepts null)
         track_opens: nil,
         request_options: {}
       )

data/rbi/ark_email/resources/webhooks.rbi

@@ -17,16 +17,25 @@ module ArkEmail
       # - `DomainDNSError` - Domain DNS issue detected
       sig do
         params(
-          events: T::Array[ArkEmail::WebhookCreateParams::Event::OrSymbol],
           name: String,
           url: String,
-          all_events: T::Boolean,
-          enabled: T::Boolean,
+          all_events: T.nilable(T::Boolean),
+          enabled: T.nilable(T::Boolean),
+          events:
+            T.nilable(T::Array[ArkEmail::WebhookCreateParams::Event::OrSymbol]),
           request_options: ArkEmail::RequestOptions::OrHash
         ).returns(ArkEmail::Models::WebhookCreateResponse)
       end
       def create(
-        # Events to subscribe to:
+        # Webhook name for identification
+        name:,
+        # HTTPS endpoint URL
+        url:,
+        # Subscribe to all events (ignores events array, accepts null)
+        all_events: nil,
+        # Whether the webhook is enabled (accepts null)
+        enabled: nil,
+        # Events to subscribe to (accepts null):
         #
         # - `MessageSent` - Email successfully delivered to recipient's server
         # - `MessageDelayed` - Temporary delivery failure, will retry
@@ -36,14 +45,7 @@ module ArkEmail
         # - `MessageLinkClicked` - Recipient clicked a tracked link
         # - `MessageLoaded` - Recipient opened the email (tracking pixel loaded)
         # - `DomainDNSError` - DNS configuration issue detected
-        events:,
-        # Webhook name for identification
-        name:,
-        # HTTPS endpoint URL
-        url:,
-        # Subscribe to all events (ignores events array)
-        all_events: nil,
-        enabled: nil,
+        events: nil,
         request_options: {}
       )
       end
@@ -62,11 +64,11 @@ module ArkEmail
       sig do
         params(
           webhook_id: String,
-          all_events: T::Boolean,
-          enabled: T::Boolean,
-          events: T::Array[String],
-          name: String,
-          url: String,
+          all_events: T.nilable(T::Boolean),
+          enabled: T.nilable(T::Boolean),
+          events: T.nilable(T::Array[String]),
+          name: T.nilable(String),
+          url: T.nilable(String),
           request_options: ArkEmail::RequestOptions::OrHash
         ).returns(ArkEmail::Models::WebhookUpdateResponse)
       end

data/sig/ark_email/models/email_send_batch_params.rbs

@@ -38,9 +38,10 @@ module ArkEmail
         {
           subject: String,
           to: ::Array[String],
-          html: String,
-          tag: String,
-          text: String
+          html: String?,
+          metadata: ::Hash[Symbol, String]?,
+          tag: String?,
+          text: String?
         }
 
       class Email < ArkEmail::Internal::Type::BaseModel
@@ -48,32 +49,30 @@ module ArkEmail
 
         attr_accessor to: ::Array[String]
 
-        attr_reader html: String?
+        attr_accessor html: String?
 
-        def html=: (String) -> String
+        attr_accessor metadata: ::Hash[Symbol, String]?
 
-        attr_reader tag: String?
+        attr_accessor tag: String?
 
-        def tag=: (String) -> String
-
-        attr_reader text: String?
-
-        def text=: (String) -> String
+        attr_accessor text: String?
 
         def initialize: (
           subject: String,
           to: ::Array[String],
-          ?html: String,
-          ?tag: String,
-          ?text: String
+          ?html: String?,
+          ?metadata: ::Hash[Symbol, String]?,
+          ?tag: String?,
+          ?text: String?
         ) -> void
 
         def to_hash: -> {
           subject: String,
           to: ::Array[String],
-          html: String,
-          tag: String,
-          text: String
+          html: String?,
+          metadata: ::Hash[Symbol, String]?,
+          tag: String?,
+          text: String?
         }
       end
     end

data/sig/ark_email/models/email_send_params.rbs

@@ -5,14 +5,15 @@ module ArkEmail
         from: String,
         subject: String,
         to: ::Array[String],
-        attachments: ::Array[ArkEmail::EmailSendParams::Attachment],
-        bcc: ::Array[String],
-        cc: ::Array[String],
-        headers: ::Hash[Symbol, String],
-        html: String,
-        reply_to: String,
-        tag: String,
-        text: String,
+        attachments: ::Array[ArkEmail::EmailSendParams::Attachment]?,
+        bcc: ::Array[String]?,
+        cc: ::Array[String]?,
+        headers: ::Hash[Symbol, String]?,
+        html: String?,
+        metadata: ::Hash[Symbol, String]?,
+        reply_to: String?,
+        tag: String?,
+        text: String?,
         idempotency_key: String
       }
       & ArkEmail::Internal::Type::request_parameters
@@ -27,39 +28,23 @@ module ArkEmail
 
       attr_accessor to: ::Array[String]
 
-      attr_reader attachments: ::Array[ArkEmail::EmailSendParams::Attachment]?
+      attr_accessor attachments: ::Array[ArkEmail::EmailSendParams::Attachment]?
 
-      def attachments=: (
-        ::Array[ArkEmail::EmailSendParams::Attachment]
-      ) -> ::Array[ArkEmail::EmailSendParams::Attachment]
+      attr_accessor bcc: ::Array[String]?
 
-      attr_reader bcc: ::Array[String]?
+      attr_accessor cc: ::Array[String]?
 
-      def bcc=: (::Array[String]) -> ::Array[String]
+      attr_accessor headers: ::Hash[Symbol, String]?
 
-      attr_reader cc: ::Array[String]?
+      attr_accessor html: String?
 
-      def cc=: (::Array[String]) -> ::Array[String]
+      attr_accessor metadata: ::Hash[Symbol, String]?
 
-      attr_reader headers: ::Hash[Symbol, String]?
+      attr_accessor reply_to: String?
 
-      def headers=: (::Hash[Symbol, String]) -> ::Hash[Symbol, String]
+      attr_accessor tag: String?
 
-      attr_reader html: String?
-
-      def html=: (String) -> String
-
-      attr_reader reply_to: String?
-
-      def reply_to=: (String) -> String
-
-      attr_reader tag: String?
-
-      def tag=: (String) -> String
-
-      attr_reader text: String?
-
-      def text=: (String) -> String
+      attr_accessor text: String?
 
       attr_reader idempotency_key: String?
 
@@ -69,14 +54,15 @@ module ArkEmail
         from: String,
         subject: String,
         to: ::Array[String],
-        ?attachments: ::Array[ArkEmail::EmailSendParams::Attachment],
-        ?bcc: ::Array[String],
-        ?cc: ::Array[String],
-        ?headers: ::Hash[Symbol, String],
-        ?html: String,
-        ?reply_to: String,
-        ?tag: String,
-        ?text: String,
+        ?attachments: ::Array[ArkEmail::EmailSendParams::Attachment]?,
+        ?bcc: ::Array[String]?,
+        ?cc: ::Array[String]?,
+        ?headers: ::Hash[Symbol, String]?,
+        ?html: String?,
+        ?metadata: ::Hash[Symbol, String]?,
+        ?reply_to: String?,
+        ?tag: String?,
+        ?text: String?,
         ?idempotency_key: String,
         ?request_options: ArkEmail::request_opts
       ) -> void
@@ -85,14 +71,15 @@ module ArkEmail
         from: String,
         subject: String,
         to: ::Array[String],
-        attachments: ::Array[ArkEmail::EmailSendParams::Attachment],
-        bcc: ::Array[String],
-        cc: ::Array[String],
-        headers: ::Hash[Symbol, String],
-        html: String,
-        reply_to: String,
-        tag: String,
-        text: String,
+        attachments: ::Array[ArkEmail::EmailSendParams::Attachment]?,
+        bcc: ::Array[String]?,
+        cc: ::Array[String]?,
+        headers: ::Hash[Symbol, String]?,
+        html: String?,
+        metadata: ::Hash[Symbol, String]?,
+        reply_to: String?,
+        tag: String?,
+        text: String?,
         idempotency_key: String,
         request_options: ArkEmail::RequestOptions
       }

data/sig/ark_email/models/email_send_raw_params.rbs

@@ -1,7 +1,12 @@
 module ArkEmail
   module Models
     type email_send_raw_params =
-      { data: String, mail_from: String, rcpt_to: ::Array[String] }
+      {
+        data: String,
+        mail_from: String,
+        rcpt_to: ::Array[String],
+        bounce: bool?
+      }
       & ArkEmail::Internal::Type::request_parameters
 
     class EmailSendRawParams < ArkEmail::Internal::Type::BaseModel
@@ -14,10 +19,13 @@ module ArkEmail
 
       attr_accessor rcpt_to: ::Array[String]
 
+      attr_accessor bounce: bool?
+
       def initialize: (
         data: String,
         mail_from: String,
         rcpt_to: ::Array[String],
+        ?bounce: bool?,
         ?request_options: ArkEmail::request_opts
       ) -> void
 
@@ -25,6 +33,7 @@ module ArkEmail
         data: String,
         mail_from: String,
         rcpt_to: ::Array[String],
+        bounce: bool?,
         request_options: ArkEmail::RequestOptions
       }
     end

data/sig/ark_email/models/suppression_bulk_create_params.rbs

@@ -22,18 +22,16 @@ module ArkEmail
         request_options: ArkEmail::RequestOptions
       }
 
-      type suppression = { address: String, reason: String }
+      type suppression = { address: String, reason: String? }
 
       class Suppression < ArkEmail::Internal::Type::BaseModel
         attr_accessor address: String
 
-        attr_reader reason: String?
+        attr_accessor reason: String?
 
-        def reason=: (String) -> String
+        def initialize: (address: String, ?reason: String?) -> void
 
-        def initialize: (address: String, ?reason: String) -> void
-
-        def to_hash: -> { address: String, reason: String }
+        def to_hash: -> { address: String, reason: String? }
       end
     end
   end