ark-email 0.8.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5b28db2b8003c270a67cebc743ea403628c8a13a8d0cff4b4e357704aae84c55
-  data.tar.gz: 8ccf63ab298517800021888ab0e2041d4eb5b66c27735d16e3ed2c630fb3eab7
+  metadata.gz: ee70352e87d7586234884d318276da0a01b94c7a8cc47e795d37fa77571a0d17
+  data.tar.gz: f469a30b7c8ed720169c6b6c613eb8279789e82505581d1584d930c67d678784
 SHA512:
-  metadata.gz: ebe864f749bc491e0d8d190661a3c265050b59d7a21e7e8bf97b4fb52c148040a02b42f51d03e7f5b2e19119c75abf1581ab78835d66529632453b4a206a7064
-  data.tar.gz: 0bd1b269b07c48c3514ec03cb0a7372c980f8f4ee48687b06c8bb7593cd2ea0303d6b22aa7bbc8300462294bd2132cf0232e87b585376a0f96470040941591c9
+  metadata.gz: 176ab6feb912821c518e32aea92ff9c3b7acf82e25ef4382aca2a9101bc1f5339c2bd9e76f89c9cf6e0feb0313a635101ddb5169b70232f2fa68a046f279cdf2
+  data.tar.gz: 9244988b7e44d174dd35d7b0f005574b37acd10aae831db4170c15725d00d7c22d37ab705f5f7cfbfe49e199f2f74b40680e055c3f52edf7ebd9b92832b71396

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## 0.9.0 (2026-01-21)
+
+Full Changelog: [v0.8.0...v0.9.0](https://github.com/ArkHQ-io/ark-ruby/compare/v0.8.0...v0.9.0)
+
+### Features
+
+* **api:** add sandbox domain ([d61ffa2](https://github.com/ArkHQ-io/ark-ruby/commit/d61ffa220016820c5620ba168461e82fab223ed4))
+
 ## 0.8.0 (2026-01-20)
 
 Full Changelog: [v0.7.0...v0.8.0](https://github.com/ArkHQ-io/ark-ruby/compare/v0.7.0...v0.8.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.8.0"
+gem "ark-email", "~> 0.9.0"
 ```
 
 <!-- x-release-please-end -->

data/lib/ark_email/models/email_send_batch_response.rb

@@ -51,7 +51,17 @@ module ArkEmail
         #   @return [Integer]
         required :total, Integer
 
-        # @!method initialize(accepted:, failed:, messages:, total:)
+        # @!attribute sandbox
+        #   Whether this batch was sent in sandbox mode. Only present (and true) for sandbox
+        #   emails sent from @arkhq.io addresses.
+        #
+        #   @return [Boolean, nil]
+        optional :sandbox, ArkEmail::Internal::Type::Boolean
+
+        # @!method initialize(accepted:, failed:, messages:, total:, sandbox: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {ArkEmail::Models::EmailSendBatchResponse::Data} for more details.
+        #
         #   @param accepted [Integer] Successfully accepted emails
         #
         #   @param failed [Integer] Failed emails
@@ -59,6 +69,8 @@ module ArkEmail
         #   @param messages [Hash{Symbol=>ArkEmail::Models::EmailSendBatchResponse::Data::Message}] Map of recipient email to message info
         #
         #   @param total [Integer] Total emails in the batch
+        #
+        #   @param sandbox [Boolean] Whether this batch was sent in sandbox mode.
 
         class Message < ArkEmail::Internal::Type::BaseModel
           # @!attribute id

data/lib/ark_email/models/email_send_params.rb

@@ -8,7 +8,7 @@ module ArkEmail
       include ArkEmail::Internal::Type::RequestParameters
 
       # @!attribute from
-      #   Sender email address. Must be from a verified domain.
+      #   Sender email address. Must be from a verified domain OR use sandbox mode.
       #
       #   **Supported formats:**
       #
@@ -18,6 +18,10 @@ module ArkEmail
       #
       #   The domain portion must match a verified sending domain in your account.
       #
+      #   **Sandbox mode:** Use `sandbox@arkhq.io` to send test emails without domain
+      #   verification. Sandbox emails can only be sent to organization members and are
+      #   limited to 10 per day.
+      #
       #   @return [String]
       required :from, String
 
@@ -117,7 +121,7 @@ module ArkEmail
       #   Some parameter documentations has been truncated, see
       #   {ArkEmail::Models::EmailSendParams} for more details.
       #
-      #   @param from [String] Sender email address. Must be from a verified domain.
+      #   @param from [String] Sender email address. Must be from a verified domain OR use sandbox mode.
       #
       #   @param subject [String] Email subject line
       #

data/lib/ark_email/models/email_send_raw_response.rb

@@ -50,7 +50,17 @@ module ArkEmail
         #   @return [String, nil]
         optional :message_id, String, api_name: :messageId
 
-        # @!method initialize(id:, status:, to:, message_id: nil)
+        # @!attribute sandbox
+        #   Whether this email was sent in sandbox mode. Only present (and true) for sandbox
+        #   emails sent from @arkhq.io addresses.
+        #
+        #   @return [Boolean, nil]
+        optional :sandbox, ArkEmail::Internal::Type::Boolean
+
+        # @!method initialize(id:, status:, to:, message_id: nil, sandbox: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {ArkEmail::Models::EmailSendRawResponse::Data} for more details.
+        #
         #   @param id [String] Unique message ID (format: msg*{id}*{token})
         #
         #   @param status [Symbol, ArkEmail::Models::EmailSendRawResponse::Data::Status] Current delivery status
@@ -58,6 +68,8 @@ module ArkEmail
         #   @param to [Array<String>] List of recipient addresses
         #
         #   @param message_id [String] SMTP Message-ID header value
+        #
+        #   @param sandbox [Boolean] Whether this email was sent in sandbox mode.
 
         # Current delivery status
         #

data/lib/ark_email/models/email_send_response.rb

@@ -50,7 +50,17 @@ module ArkEmail
         #   @return [String, nil]
         optional :message_id, String, api_name: :messageId
 
-        # @!method initialize(id:, status:, to:, message_id: nil)
+        # @!attribute sandbox
+        #   Whether this email was sent in sandbox mode. Only present (and true) for sandbox
+        #   emails sent from @arkhq.io addresses.
+        #
+        #   @return [Boolean, nil]
+        optional :sandbox, ArkEmail::Internal::Type::Boolean
+
+        # @!method initialize(id:, status:, to:, message_id: nil, sandbox: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {ArkEmail::Models::EmailSendResponse::Data} for more details.
+        #
         #   @param id [String] Unique message ID (format: msg*{id}*{token})
         #
         #   @param status [Symbol, ArkEmail::Models::EmailSendResponse::Data::Status] Current delivery status
@@ -58,6 +68,8 @@ module ArkEmail
         #   @param to [Array<String>] List of recipient addresses
         #
         #   @param message_id [String] SMTP Message-ID header value
+        #
+        #   @param sandbox [Boolean] Whether this email was sent in sandbox mode.
 
         # Current delivery status
         #

data/lib/ark_email/resources/emails.rb

@@ -144,7 +144,7 @@ module ArkEmail
       #
       # @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.
+      # @param from [String] Body param: Sender email address. Must be from a verified domain OR use sandbox
       #
       # @param subject [String] Body param: Email subject line
       #

data/lib/ark_email/version.rb

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

data/rbi/ark_email/models/email_send_batch_response.rbi

@@ -84,6 +84,14 @@ module ArkEmail
         sig { returns(Integer) }
         attr_accessor :total
 
+        # Whether this batch was sent in sandbox mode. Only present (and true) for sandbox
+        # emails sent from @arkhq.io addresses.
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_reader :sandbox
+
+        sig { params(sandbox: T::Boolean).void }
+        attr_writer :sandbox
+
         sig do
           params(
             accepted: Integer,
@@ -93,7 +101,8 @@ module ArkEmail
                 Symbol,
                 ArkEmail::Models::EmailSendBatchResponse::Data::Message::OrHash
               ],
-            total: Integer
+            total: Integer,
+            sandbox: T::Boolean
           ).returns(T.attached_class)
         end
         def self.new(
@@ -104,7 +113,10 @@ module ArkEmail
           # Map of recipient email to message info
           messages:,
           # Total emails in the batch
-          total:
+          total:,
+          # Whether this batch was sent in sandbox mode. Only present (and true) for sandbox
+          # emails sent from @arkhq.io addresses.
+          sandbox: nil
         )
         end
 
@@ -118,7 +130,8 @@ module ArkEmail
                   Symbol,
                   ArkEmail::Models::EmailSendBatchResponse::Data::Message
                 ],
-              total: Integer
+              total: Integer,
+              sandbox: T::Boolean
             }
           )
         end

data/rbi/ark_email/models/email_send_params.rbi

@@ -11,7 +11,7 @@ module ArkEmail
           T.any(ArkEmail::EmailSendParams, ArkEmail::Internal::AnyHash)
         end
 
-      # Sender email address. Must be from a verified domain.
+      # Sender email address. Must be from a verified domain OR use sandbox mode.
       #
       # **Supported formats:**
       #
@@ -20,6 +20,10 @@ module ArkEmail
       # - With quoted name: `"Acme Support" <support@yourdomain.com>`
       #
       # The domain portion must match a verified sending domain in your account.
+      #
+      # **Sandbox mode:** Use `sandbox@arkhq.io` to send test emails without domain
+      # verification. Sandbox emails can only be sent to organization members and are
+      # limited to 10 per day.
       sig { returns(String) }
       attr_accessor :from
 
@@ -114,7 +118,7 @@ module ArkEmail
         ).returns(T.attached_class)
       end
       def self.new(
-        # Sender email address. Must be from a verified domain.
+        # Sender email address. Must be from a verified domain OR use sandbox mode.
         #
         # **Supported formats:**
         #
@@ -123,6 +127,10 @@ module ArkEmail
         # - With quoted name: `"Acme Support" <support@yourdomain.com>`
         #
         # The domain portion must match a verified sending domain in your account.
+        #
+        # **Sandbox mode:** Use `sandbox@arkhq.io` to send test emails without domain
+        # verification. Sandbox emails can only be sent to organization members and are
+        # limited to 10 per day.
         from:,
         # Email subject line
         subject:,

data/rbi/ark_email/models/email_send_raw_response.rbi

@@ -82,13 +82,22 @@ module ArkEmail
         sig { params(message_id: String).void }
         attr_writer :message_id
 
+        # Whether this email was sent in sandbox mode. Only present (and true) for sandbox
+        # emails sent from @arkhq.io addresses.
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_reader :sandbox
+
+        sig { params(sandbox: T::Boolean).void }
+        attr_writer :sandbox
+
         sig do
           params(
             id: String,
             status:
               ArkEmail::Models::EmailSendRawResponse::Data::Status::OrSymbol,
             to: T::Array[String],
-            message_id: String
+            message_id: String,
+            sandbox: T::Boolean
           ).returns(T.attached_class)
         end
         def self.new(
@@ -99,7 +108,10 @@ module ArkEmail
           # List of recipient addresses
           to:,
           # SMTP Message-ID header value
-          message_id: nil
+          message_id: nil,
+          # Whether this email was sent in sandbox mode. Only present (and true) for sandbox
+          # emails sent from @arkhq.io addresses.
+          sandbox: nil
         )
         end
 
@@ -110,7 +122,8 @@ module ArkEmail
               status:
                 ArkEmail::Models::EmailSendRawResponse::Data::Status::TaggedSymbol,
               to: T::Array[String],
-              message_id: String
+              message_id: String,
+              sandbox: T::Boolean
             }
           )
         end

data/rbi/ark_email/models/email_send_response.rbi

@@ -82,12 +82,21 @@ module ArkEmail
         sig { params(message_id: String).void }
         attr_writer :message_id
 
+        # Whether this email was sent in sandbox mode. Only present (and true) for sandbox
+        # emails sent from @arkhq.io addresses.
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_reader :sandbox
+
+        sig { params(sandbox: T::Boolean).void }
+        attr_writer :sandbox
+
         sig do
           params(
             id: String,
             status: ArkEmail::Models::EmailSendResponse::Data::Status::OrSymbol,
             to: T::Array[String],
-            message_id: String
+            message_id: String,
+            sandbox: T::Boolean
           ).returns(T.attached_class)
         end
         def self.new(
@@ -98,7 +107,10 @@ module ArkEmail
           # List of recipient addresses
           to:,
           # SMTP Message-ID header value
-          message_id: nil
+          message_id: nil,
+          # Whether this email was sent in sandbox mode. Only present (and true) for sandbox
+          # emails sent from @arkhq.io addresses.
+          sandbox: nil
         )
         end
 
@@ -109,7 +121,8 @@ module ArkEmail
               status:
                 ArkEmail::Models::EmailSendResponse::Data::Status::TaggedSymbol,
               to: T::Array[String],
-              message_id: String
+              message_id: String,
+              sandbox: T::Boolean
             }
           )
         end

data/rbi/ark_email/resources/emails.rbi

@@ -141,7 +141,8 @@ module ArkEmail
         ).returns(ArkEmail::Models::EmailSendResponse)
       end
       def send_(
-        # Body param: Sender email address. Must be from a verified domain.
+        # Body param: Sender email address. Must be from a verified domain OR use sandbox
+        # mode.
         #
         # **Supported formats:**
         #
@@ -150,6 +151,10 @@ module ArkEmail
         # - With quoted name: `"Acme Support" <support@yourdomain.com>`
         #
         # The domain portion must match a verified sending domain in your account.
+        #
+        # **Sandbox mode:** Use `sandbox@arkhq.io` to send test emails without domain
+        # verification. Sandbox emails can only be sent to organization members and are
+        # limited to 10 per day.
         from:,
         # Body param: Email subject line
         subject:,

data/sig/ark_email/models/email_send_batch_response.rbs

@@ -31,7 +31,8 @@ module ArkEmail
           accepted: Integer,
           failed: Integer,
           messages: ::Hash[Symbol, ArkEmail::Models::EmailSendBatchResponse::Data::Message],
-          total: Integer
+          total: Integer,
+          sandbox: bool
         }
 
       class Data < ArkEmail::Internal::Type::BaseModel
@@ -43,18 +44,24 @@ module ArkEmail
 
         attr_accessor total: Integer
 
+        attr_reader sandbox: bool?
+
+        def sandbox=: (bool) -> bool
+
         def initialize: (
           accepted: Integer,
           failed: Integer,
           messages: ::Hash[Symbol, ArkEmail::Models::EmailSendBatchResponse::Data::Message],
-          total: Integer
+          total: Integer,
+          ?sandbox: bool
         ) -> void
 
         def to_hash: -> {
           accepted: Integer,
           failed: Integer,
           messages: ::Hash[Symbol, ArkEmail::Models::EmailSendBatchResponse::Data::Message],
-          total: Integer
+          total: Integer,
+          sandbox: bool
         }
 
         type message = { id: String, token: String }

data/sig/ark_email/models/email_send_raw_response.rbs

@@ -31,7 +31,8 @@ module ArkEmail
           id: String,
           status: ArkEmail::Models::EmailSendRawResponse::Data::status,
           to: ::Array[String],
-          message_id: String
+          message_id: String,
+          sandbox: bool
         }
 
       class Data < ArkEmail::Internal::Type::BaseModel
@@ -45,18 +46,24 @@ module ArkEmail
 
         def message_id=: (String) -> String
 
+        attr_reader sandbox: bool?
+
+        def sandbox=: (bool) -> bool
+
         def initialize: (
           id: String,
           status: ArkEmail::Models::EmailSendRawResponse::Data::status,
           to: ::Array[String],
-          ?message_id: String
+          ?message_id: String,
+          ?sandbox: bool
         ) -> void
 
         def to_hash: -> {
           id: String,
           status: ArkEmail::Models::EmailSendRawResponse::Data::status,
           to: ::Array[String],
-          message_id: String
+          message_id: String,
+          sandbox: bool
         }
 
         type status = :pending | :sent

data/sig/ark_email/models/email_send_response.rbs

@@ -31,7 +31,8 @@ module ArkEmail
           id: String,
           status: ArkEmail::Models::EmailSendResponse::Data::status,
           to: ::Array[String],
-          message_id: String
+          message_id: String,
+          sandbox: bool
         }
 
       class Data < ArkEmail::Internal::Type::BaseModel
@@ -45,18 +46,24 @@ module ArkEmail
 
         def message_id=: (String) -> String
 
+        attr_reader sandbox: bool?
+
+        def sandbox=: (bool) -> bool
+
         def initialize: (
           id: String,
           status: ArkEmail::Models::EmailSendResponse::Data::status,
           to: ::Array[String],
-          ?message_id: String
+          ?message_id: String,
+          ?sandbox: bool
         ) -> void
 
         def to_hash: -> {
           id: String,
           status: ArkEmail::Models::EmailSendResponse::Data::status,
           to: ::Array[String],
-          message_id: String
+          message_id: String,
+          sandbox: bool
         }
 
         type status = :pending | :sent

metadata

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