ark-email 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2fd8727fd7e7cd6868b8265be0edf509d2213e440c3b2ac4d695971026d38172
-  data.tar.gz: 2e7355fd8bbc133c5257224134ea34f502ccc7842f5fbba8460293e36998b705
+  metadata.gz: ddf19df44b85deecef1d6cbf6590336a3309035c29a4407967df568b5ac9ca19
+  data.tar.gz: d7048ca3b1397cd9c1ff148be90bb0bc24bcb691d543f511f8c94a7e9e6e3109
 SHA512:
-  metadata.gz: b665865ed7fd3153eb7470a2ed7fd25b2a91ac37720e53aab3946d430325c2e286574e809c0b54ec94f952e05b5488b4dff6c03023c6395e366d64d2fcf720a2
-  data.tar.gz: 7b49bdc1e1e54e41ce93bc94eb7835e856f1a21fb33b2ad42dfa2bd24a68197e75e5177c6144ea25b5802676a96e842e0e70866b5e1c700584eb3f9c7ca6292a
+  metadata.gz: 1d9d815fed0a695d07f4fc015c0b05e9864dbbdbe7f905566032eef3f13eee959276aa7b4abe256eaa668b73c4b690f7e94e5cef31c8ad4bedef0bfeb0ef7ae0
+  data.tar.gz: 45de3d27d11501f0430b2f32ee215bea62af5884e1a3c2507a36d6e833b734e22d3f6b3cb2f9de3a208225adce8546f50087fa54e78fde260fcbf9a1c9381854

data/CHANGELOG.md

@@ -1,5 +1,18 @@
 # Changelog
 
+## 0.7.0 (2026-01-14)
+
+Full Changelog: [v0.6.0...v0.7.0](https://github.com/ArkHQ-io/ark-ruby/compare/v0.6.0...v0.7.0)
+
+### Features
+
+* **api:** add metadata ([ce7e4f9](https://github.com/ArkHQ-io/ark-ruby/commit/ce7e4f902f732cd6cddd18d7efe81faddb6400c4))
+
+
+### Chores
+
+* fix typo in descriptions ([56e8b92](https://github.com/ArkHQ-io/ark-ruby/commit/56e8b9247d89c53d9e522e5785f52be79b7abdd7))
+
 ## 0.6.0 (2026-01-13)
 
 Full Changelog: [v0.5.2...v0.6.0](https://github.com/ArkHQ-io/ark-ruby/compare/v0.5.2...v0.6.0)

data/README.md

@@ -26,7 +26,7 @@ To use this gem, install via Bundler by adding the following to your application
 <!-- x-release-please-start-version -->
 
 ```ruby
-gem "ark-email", "~> 0.6.0"
+gem "ark-email", "~> 0.7.0"
 ```
 
 <!-- x-release-please-end -->

data/lib/ark_email/models/email_send_batch_params.rb

@@ -48,6 +48,21 @@ module ArkEmail
         #   @return [String, nil]
         optional :html, String, nil?: true
 
+        # @!attribute metadata
+        #   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).
+        #
+        #   @return [Hash{Symbol=>String}, nil]
+        optional :metadata, ArkEmail::Internal::Type::HashOf[String], nil?: true
+
         # @!attribute tag
         #
         #   @return [String, nil]
@@ -58,11 +73,20 @@ module ArkEmail
         #   @return [String, nil]
         optional :text, String, nil?: true
 
-        # @!method initialize(subject:, to:, html: nil, tag: nil, text: nil)
+        # @!method initialize(subject:, to:, html: nil, metadata: nil, tag: nil, text: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {ArkEmail::Models::EmailSendBatchParams::Email} for more details.
+        #
         #   @param subject [String]
+        #
         #   @param to [Array<String>]
+        #
         #   @param html [String, nil]
+        #
+        #   @param metadata [Hash{Symbol=>String}, nil] Custom key-value pairs attached to an email for webhook correlation.
+        #
         #   @param tag [String, nil]
+        #
         #   @param text [String, nil]
       end
     end

data/lib/ark_email/models/email_send_params.rb

@@ -66,6 +66,21 @@ module ArkEmail
       #   @return [String, nil]
       optional :html, String, nil?: true
 
+      # @!attribute metadata
+      #   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).
+      #
+      #   @return [Hash{Symbol=>String}, nil]
+      optional :metadata, ArkEmail::Internal::Type::HashOf[String], nil?: true
+
       # @!attribute reply_to
       #   Reply-to address (accepts null)
       #
@@ -90,7 +105,7 @@ module ArkEmail
       #   @return [String, nil]
       optional :idempotency_key, String
 
-      # @!method initialize(from:, subject:, to:, attachments: nil, bcc: nil, cc: nil, headers: nil, html: nil, reply_to: nil, tag: nil, text: nil, idempotency_key: nil, request_options: {})
+      # @!method initialize(from:, subject:, to:, attachments: nil, bcc: nil, cc: nil, headers: nil, html: nil, metadata: nil, reply_to: nil, tag: nil, text: nil, idempotency_key: nil, request_options: {})
       #   Some parameter documentations has been truncated, see
       #   {ArkEmail::Models::EmailSendParams} for more details.
       #
@@ -110,6 +125,8 @@ module ArkEmail
       #
       #   @param html [String, nil] HTML body content (accepts null).
       #
+      #   @param metadata [Hash{Symbol=>String}, nil] Custom key-value pairs attached to an email for webhook correlation.
+      #
       #   @param reply_to [String, nil] Reply-to address (accepts null)
       #
       #   @param tag [String, nil] Tag for categorization and filtering (accepts null)

data/lib/ark_email/resources/emails.rb

@@ -142,7 +142,7 @@ module ArkEmail
       # - `GET /emails/{id}/deliveries` - View delivery attempts
       # - `POST /emails/{id}/retry` - Retry failed delivery
       #
-      # @overload send_(from:, subject:, to:, attachments: nil, bcc: nil, cc: nil, headers: nil, html: nil, reply_to: nil, tag: nil, text: nil, idempotency_key: nil, request_options: {})
+      # @overload send_(from:, subject:, to:, attachments: nil, bcc: nil, cc: nil, headers: nil, html: nil, metadata: nil, reply_to: nil, tag: nil, text: nil, idempotency_key: nil, request_options: {})
       #
       # @param from [String] Body param: Sender email address. Must be from a verified domain.
       #
@@ -160,6 +160,8 @@ module ArkEmail
       #
       # @param html [String, nil] Body param: HTML body content (accepts null).
       #
+      # @param metadata [Hash{Symbol=>String}, nil] Body param: Custom key-value pairs attached to an email for webhook correlation.
+      #
       # @param reply_to [String, nil] Body param: Reply-to address (accepts null)
       #
       # @param tag [String, nil] Body param: Tag for categorization and filtering (accepts null)
@@ -199,7 +201,7 @@ module ArkEmail
       #
       # @overload send_batch(emails:, from:, idempotency_key: nil, request_options: {})
       #
-      # @param emails [Array<ArkEmail::Models::EmailSendBatchParams::Email>] Body param:
+      # @param emails [Array<ArkEmail::Models::EmailSendBatchParams::Email>] Body param
       #
       # @param from [String] Body param: Sender email for all messages
       #

data/lib/ark_email/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ArkEmail
-  VERSION = "0.6.0"
+  VERSION = "0.7.0"
 end

data/rbi/ark_email/models/email_send_batch_params.rbi

@@ -72,6 +72,19 @@ module ArkEmail
         sig { returns(T.nilable(String)) }
         attr_accessor :html
 
+        # 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).
+        sig { returns(T.nilable(T::Hash[Symbol, String])) }
+        attr_accessor :metadata
+
         sig { returns(T.nilable(String)) }
         attr_accessor :tag
 
@@ -83,11 +96,29 @@ module ArkEmail
             subject: String,
             to: T::Array[String],
             html: T.nilable(String),
+            metadata: T.nilable(T::Hash[Symbol, String]),
             tag: T.nilable(String),
             text: T.nilable(String)
           ).returns(T.attached_class)
         end
-        def self.new(subject:, to:, html: nil, tag: nil, text: nil)
+        def self.new(
+          subject:,
+          to:,
+          html: nil,
+          # 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,
+          tag: nil,
+          text: nil
+        )
         end
 
         sig do
@@ -96,6 +127,7 @@ module ArkEmail
               subject: String,
               to: T::Array[String],
               html: T.nilable(String),
+              metadata: T.nilable(T::Hash[Symbol, String]),
               tag: T.nilable(String),
               text: T.nilable(String)
             }

data/rbi/ark_email/models/email_send_params.rbi

@@ -54,6 +54,19 @@ module ArkEmail
       sig { returns(T.nilable(String)) }
       attr_accessor :html
 
+      # 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).
+      sig { returns(T.nilable(T::Hash[Symbol, String])) }
+      attr_accessor :metadata
+
       # Reply-to address (accepts null)
       sig { returns(T.nilable(String)) }
       attr_accessor :reply_to
@@ -84,6 +97,7 @@ module ArkEmail
           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),
@@ -117,6 +131,17 @@ module ArkEmail
         # HTML body content (accepts null). Maximum 5MB (5,242,880 characters). Combined
         # with attachments, the total message must not exceed 14MB.
         html: nil,
+        # 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,
         # Reply-to address (accepts null)
         reply_to: nil,
         # Tag for categorization and filtering (accepts null)
@@ -141,6 +166,7 @@ module ArkEmail
             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),

data/rbi/ark_email/resources/emails.rbi

@@ -132,6 +132,7 @@ module ArkEmail
           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),
@@ -165,6 +166,17 @@ module ArkEmail
         # 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: 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 (accepts null)
@@ -195,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:,

data/sig/ark_email/models/email_send_batch_params.rbs

@@ -39,6 +39,7 @@ module ArkEmail
           subject: String,
           to: ::Array[String],
           html: String?,
+          metadata: ::Hash[Symbol, String]?,
           tag: String?,
           text: String?
         }
@@ -50,6 +51,8 @@ module ArkEmail
 
         attr_accessor html: String?
 
+        attr_accessor metadata: ::Hash[Symbol, String]?
+
         attr_accessor tag: String?
 
         attr_accessor text: String?
@@ -58,6 +61,7 @@ module ArkEmail
           subject: String,
           to: ::Array[String],
           ?html: String?,
+          ?metadata: ::Hash[Symbol, String]?,
           ?tag: String?,
           ?text: String?
         ) -> void
@@ -66,6 +70,7 @@ module ArkEmail
           subject: String,
           to: ::Array[String],
           html: String?,
+          metadata: ::Hash[Symbol, String]?,
           tag: String?,
           text: String?
         }

data/sig/ark_email/models/email_send_params.rbs

@@ -10,6 +10,7 @@ module ArkEmail
         cc: ::Array[String]?,
         headers: ::Hash[Symbol, String]?,
         html: String?,
+        metadata: ::Hash[Symbol, String]?,
         reply_to: String?,
         tag: String?,
         text: String?,
@@ -37,6 +38,8 @@ module ArkEmail
 
       attr_accessor html: String?
 
+      attr_accessor metadata: ::Hash[Symbol, String]?
+
       attr_accessor reply_to: String?
 
       attr_accessor tag: String?
@@ -56,6 +59,7 @@ module ArkEmail
         ?cc: ::Array[String]?,
         ?headers: ::Hash[Symbol, String]?,
         ?html: String?,
+        ?metadata: ::Hash[Symbol, String]?,
         ?reply_to: String?,
         ?tag: String?,
         ?text: String?,
@@ -72,6 +76,7 @@ module ArkEmail
         cc: ::Array[String]?,
         headers: ::Hash[Symbol, String]?,
         html: String?,
+        metadata: ::Hash[Symbol, String]?,
         reply_to: String?,
         tag: String?,
         text: String?,

data/sig/ark_email/resources/emails.rbs

@@ -38,6 +38,7 @@ module ArkEmail
         ?cc: ::Array[String]?,
         ?headers: ::Hash[Symbol, String]?,
         ?html: String?,
+        ?metadata: ::Hash[Symbol, String]?,
         ?reply_to: String?,
         ?tag: String?,
         ?text: String?,

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ark-email
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Ark
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-01-13 00:00:00.000000000 Z
+date: 2026-01-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cgi