ark-email 0.5.2 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6ab3fd5fdd91cecd2ffad82cae703dc8d9c5473efc077645329853a2065f6d67
-  data.tar.gz: 7e7f140f8ef9a5a8f0accd73df700f12b3fddaf2bd28d7e9325c797231beba1e
+  metadata.gz: ddf19df44b85deecef1d6cbf6590336a3309035c29a4407967df568b5ac9ca19
+  data.tar.gz: d7048ca3b1397cd9c1ff148be90bb0bc24bcb691d543f511f8c94a7e9e6e3109
 SHA512:
-  metadata.gz: 9f1136587d8764385067890cd6552cf7678f5005006c07388cc8dc4441e6fa95eaf0b4e30739545a5c9f3e56c9a6c10e854f1469d884b4d7ece6f117f2692d24
-  data.tar.gz: 36544b79b5165b69642ac4dd91ed48777ae3142a601350ff8d09e0f1bbeaf92681abd262d170fae2824c121beff9ce17fcfe1466e2e9f65e67c3b571f4da82f4
+  metadata.gz: 1d9d815fed0a695d07f4fc015c0b05e9864dbbdbe7f905566032eef3f13eee959276aa7b4abe256eaa668b73c4b690f7e94e5cef31c8ad4bedef0bfeb0ef7ae0
+  data.tar.gz: 45de3d27d11501f0430b2f32ee215bea62af5884e1a3c2507a36d6e833b734e22d3f6b3cb2f9de3a208225adce8546f50087fa54e78fde260fcbf9a1c9381854

data/CHANGELOG.md

@@ -1,5 +1,27 @@
 # 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)
+
+### Features
+
+* **api:** manual updates ([d2ec147](https://github.com/ArkHQ-io/ark-ruby/commit/d2ec1479545bbc9000607cd6270798cfe6da5882))
+* **api:** manual updates ([187b4cc](https://github.com/ArkHQ-io/ark-ruby/commit/187b4cc4ab952a33a00e82282249ebf48eb02c5a))
+
 ## 0.5.2 (2026-01-13)
 
 Full Changelog: [v0.5.1...v0.5.2](https://github.com/ArkHQ-io/ark-ruby/compare/v0.5.1...v0.5.2)

data/README.md

@@ -8,8 +8,8 @@ It is generated with [Stainless](https://www.stainless.com/).
 
 Use the Ark MCP Server to enable AI assistants to interact with this API, allowing them to explore endpoints, make test requests, and use documentation to help integrate this SDK into your application.
 
-[![Add to Cursor](https://cursor.com/deeplink/mcp-install-dark.svg)](https://cursor.com/en-US/install-mcp?name=ark-email-mcp&config=eyJjb21tYW5kIjoibnB4IiwiYXJncyI6WyIteSIsImFyay1lbWFpbC1tY3AiXX0)
-[![Install in VS Code](https://img.shields.io/badge/_-Add_to_VS_Code-blue?style=for-the-badge&logo=data:image/svg%2bxml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIGZpbGw9Im5vbmUiIHZpZXdCb3g9IjAgMCA0MCA0MCI+PHBhdGggZmlsbD0iI0VFRSIgZmlsbC1ydWxlPSJldmVub2RkIiBkPSJNMzAuMjM1IDM5Ljg4NGEyLjQ5MSAyLjQ5MSAwIDAgMS0xLjc4MS0uNzNMMTIuNyAyNC43OGwtMy40NiAyLjYyNC0zLjQwNiAyLjU4MmExLjY2NSAxLjY2NSAwIDAgMS0xLjA4Mi4zMzggMS42NjQgMS42NjQgMCAwIDEtMS4wNDYtLjQzMWwtMi4yLTJhMS42NjYgMS42NjYgMCAwIDEgMC0yLjQ2M0w3LjQ1OCAyMCA0LjY3IDE3LjQ1MyAxLjUwNyAxNC41N2ExLjY2NSAxLjY2NSAwIDAgMSAwLTIuNDYzbDIuMi0yYTEuNjY1IDEuNjY1IDAgMCAxIDIuMTMtLjA5N2w2Ljg2MyA1LjIwOUwyOC40NTIuODQ0YTIuNDg4IDIuNDg4IDAgMCAxIDEuODQxLS43MjljLjM1MS4wMDkuNjk5LjA5MSAxLjAxOS4yNDVsOC4yMzYgMy45NjFhMi41IDIuNSAwIDAgMSAxLjQxNSAyLjI1M3YuMDk5LS4wNDVWMzMuMzd2LS4wNDUuMDk1YTIuNTAxIDIuNTAxIDAgMCAxLTEuNDE2IDIuMjU3bC04LjIzNSAzLjk2MWEyLjQ5MiAyLjQ5MiAwIDAgMS0xLjA3Ny4yNDZabS43MTYtMjguOTQ3LTExLjk0OCA5LjA2MiAxMS45NTIgOS4wNjUtLjAwNC0xOC4xMjdaIi8+PC9zdmc+)](https://vscode.stainless.com/mcp/%7B%22name%22%3A%22ark-email-mcp%22%2C%22command%22%3A%22npx%22%2C%22args%22%3A%5B%22-y%22%2C%22ark-email-mcp%22%5D%7D)
+[![Add to Cursor](https://cursor.com/deeplink/mcp-install-dark.svg)](https://cursor.com/en-US/install-mcp?name=ark-email-mcp&config=eyJuYW1lIjoiYXJrLWVtYWlsLW1jcCIsInRyYW5zcG9ydCI6InNzZSIsInVybCI6Imh0dHBzOi8vYXJrLW1jcC5zdGxtY3AuY29tL3NzZSJ9)
+[![Install in VS Code](https://img.shields.io/badge/_-Add_to_VS_Code-blue?style=for-the-badge&logo=data:image/svg%2bxml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIGZpbGw9Im5vbmUiIHZpZXdCb3g9IjAgMCA0MCA0MCI+PHBhdGggZmlsbD0iI0VFRSIgZmlsbC1ydWxlPSJldmVub2RkIiBkPSJNMzAuMjM1IDM5Ljg4NGEyLjQ5MSAyLjQ5MSAwIDAgMS0xLjc4MS0uNzNMMTIuNyAyNC43OGwtMy40NiAyLjYyNC0zLjQwNiAyLjU4MmExLjY2NSAxLjY2NSAwIDAgMS0xLjA4Mi4zMzggMS42NjQgMS42NjQgMCAwIDEtMS4wNDYtLjQzMWwtMi4yLTJhMS42NjYgMS42NjYgMCAwIDEgMC0yLjQ2M0w3LjQ1OCAyMCA0LjY3IDE3LjQ1MyAxLjUwNyAxNC41N2ExLjY2NSAxLjY2NSAwIDAgMSAwLTIuNDYzbDIuMi0yYTEuNjY1IDEuNjY1IDAgMCAxIDIuMTMtLjA5N2w2Ljg2MyA1LjIwOUwyOC40NTIuODQ0YTIuNDg4IDIuNDg4IDAgMCAxIDEuODQxLS43MjljLjM1MS4wMDkuNjk5LjA5MSAxLjAxOS4yNDVsOC4yMzYgMy45NjFhMi41IDIuNSAwIDAgMSAxLjQxNSAyLjI1M3YuMDk5LS4wNDVWMzMuMzd2LS4wNDUuMDk1YTIuNTAxIDIuNTAxIDAgMCAxLTEuNDE2IDIuMjU3bC04LjIzNSAzLjk2MWEyLjQ5MiAyLjQ5MiAwIDAgMS0xLjA3Ny4yNDZabS43MTYtMjguOTQ3LTExLjk0OCA5LjA2MiAxMS45NTIgOS4wNjUtLjAwNC0xOC4xMjdaIi8+PC9zdmc+)](https://vscode.stainless.com/mcp/%7B%22name%22%3A%22ark-email-mcp%22%2C%22type%22%3A%22sse%22%2C%22url%22%3A%22https%3A%2F%2Fark-mcp.stlmcp.com%2Fsse%22%7D)
 
 > Note: You may need to set environment variables in your MCP client.
 
@@ -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.5.2"
+gem "ark-email", "~> 0.7.0"
 ```
 
 <!-- x-release-please-end -->

data/lib/ark_email/models/email_send_batch_params.rb

@@ -46,24 +46,48 @@ module ArkEmail
         # @!attribute html
         #
         #   @return [String, nil]
-        optional :html, String
+        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]
-        optional :tag, String
+        optional :tag, String, nil?: true
 
         # @!attribute text
         #
         #   @return [String, nil]
-        optional :text, String
+        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]
-        #   @param tag [String]
-        #   @param text [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
   end

data/lib/ark_email/models/email_send_params.rb

@@ -34,61 +34,78 @@ module ArkEmail
       required :to, ArkEmail::Internal::Type::ArrayOf[String]
 
       # @!attribute attachments
-      #   File attachments
+      #   File attachments (accepts null)
       #
       #   @return [Array<ArkEmail::Models::EmailSendParams::Attachment>, nil]
-      optional :attachments, -> { ArkEmail::Internal::Type::ArrayOf[ArkEmail::EmailSendParams::Attachment] }
+      optional :attachments,
+               -> { ArkEmail::Internal::Type::ArrayOf[ArkEmail::EmailSendParams::Attachment] },
+               nil?: true
 
       # @!attribute bcc
-      #   BCC recipients
+      #   BCC recipients (accepts null)
       #
       #   @return [Array<String>, nil]
-      optional :bcc, ArkEmail::Internal::Type::ArrayOf[String]
+      optional :bcc, ArkEmail::Internal::Type::ArrayOf[String], nil?: true
 
       # @!attribute cc
-      #   CC recipients
+      #   CC recipients (accepts null)
       #
       #   @return [Array<String>, nil]
-      optional :cc, ArkEmail::Internal::Type::ArrayOf[String]
+      optional :cc, ArkEmail::Internal::Type::ArrayOf[String], nil?: true
 
       # @!attribute headers
-      #   Custom email headers
+      #   Custom email headers (accepts null)
       #
       #   @return [Hash{Symbol=>String}, nil]
-      optional :headers, ArkEmail::Internal::Type::HashOf[String]
+      optional :headers, ArkEmail::Internal::Type::HashOf[String], nil?: true
 
       # @!attribute html
-      #   HTML body content. Maximum 5MB (5,242,880 characters). Combined with
-      #   attachments, the total message must not exceed 14MB.
+      #   HTML body content (accepts null). Maximum 5MB (5,242,880 characters). Combined
+      #   with attachments, the total message must not exceed 14MB.
       #
       #   @return [String, nil]
-      optional :html, String
+      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
+      #   Reply-to address (accepts null)
       #
       #   @return [String, nil]
-      optional :reply_to, String, api_name: :replyTo
+      optional :reply_to, String, api_name: :replyTo, nil?: true
 
       # @!attribute tag
-      #   Tag for categorization and filtering
+      #   Tag for categorization and filtering (accepts null)
       #
       #   @return [String, nil]
-      optional :tag, String
+      optional :tag, String, nil?: true
 
       # @!attribute text
-      #   Plain text body (auto-generated from HTML if not provided). Maximum 5MB
-      #   (5,242,880 characters).
+      #   Plain text body (accepts null, auto-generated from HTML if not provided).
+      #   Maximum 5MB (5,242,880 characters).
       #
       #   @return [String, nil]
-      optional :text, String
+      optional :text, String, nil?: true
 
       # @!attribute idempotency_key
       #
       #   @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.
       #
@@ -98,21 +115,23 @@ module ArkEmail
       #
       #   @param to [Array<String>] Recipient email addresses (max 50)
       #
-      #   @param attachments [Array<ArkEmail::Models::EmailSendParams::Attachment>] File attachments
+      #   @param attachments [Array<ArkEmail::Models::EmailSendParams::Attachment>, nil] File attachments (accepts null)
+      #
+      #   @param bcc [Array<String>, nil] BCC recipients (accepts null)
       #
-      #   @param bcc [Array<String>] BCC recipients
+      #   @param cc [Array<String>, nil] CC recipients (accepts null)
       #
-      #   @param cc [Array<String>] CC recipients
+      #   @param headers [Hash{Symbol=>String}, nil] Custom email headers (accepts null)
       #
-      #   @param headers [Hash{Symbol=>String}] Custom email headers
+      #   @param html [String, nil] HTML body content (accepts null).
       #
-      #   @param html [String] HTML body content.
+      #   @param metadata [Hash{Symbol=>String}, nil] Custom key-value pairs attached to an email for webhook correlation.
       #
-      #   @param reply_to [String] Reply-to address
+      #   @param reply_to [String, nil] Reply-to address (accepts null)
       #
-      #   @param tag [String] Tag for categorization and filtering
+      #   @param tag [String, nil] Tag for categorization and filtering (accepts null)
       #
-      #   @param text [String] Plain text body (auto-generated from HTML if not provided).
+      #   @param text [String, nil] Plain text body (accepts null, auto-generated from HTML if not provided).
       #
       #   @param idempotency_key [String]
       #

data/lib/ark_email/models/email_send_raw_params.rb

@@ -25,13 +25,21 @@ module ArkEmail
       #   @return [Array<String>]
       required :rcpt_to, ArkEmail::Internal::Type::ArrayOf[String], api_name: :rcptTo
 
-      # @!method initialize(data:, mail_from:, rcpt_to:, request_options: {})
+      # @!attribute bounce
+      #   Whether this is a bounce message (accepts null)
+      #
+      #   @return [Boolean, nil]
+      optional :bounce, ArkEmail::Internal::Type::Boolean, nil?: true
+
+      # @!method initialize(data:, mail_from:, rcpt_to:, bounce: nil, request_options: {})
       #   @param data [String] Base64-encoded RFC 2822 message
       #
       #   @param mail_from [String] Envelope sender address
       #
       #   @param rcpt_to [Array<String>] Envelope recipient addresses
       #
+      #   @param bounce [Boolean, nil] Whether this is a bounce message (accepts null)
+      #
       #   @param request_options [ArkEmail::RequestOptions, Hash{Symbol=>Object}]
     end
   end

data/lib/ark_email/models/suppression_bulk_create_params.rb

@@ -24,13 +24,15 @@ module ArkEmail
         required :address, String
 
         # @!attribute reason
+        #   Reason for suppression (accepts null)
         #
         #   @return [String, nil]
-        optional :reason, String
+        optional :reason, String, nil?: true
 
         # @!method initialize(address:, reason: nil)
         #   @param address [String]
-        #   @param reason [String]
+        #
+        #   @param reason [String, nil] Reason for suppression (accepts null)
       end
     end
   end

data/lib/ark_email/models/suppression_create_params.rb

@@ -14,15 +14,15 @@ module ArkEmail
       required :address, String
 
       # @!attribute reason
-      #   Reason for suppression
+      #   Reason for suppression (accepts null)
       #
       #   @return [String, nil]
-      optional :reason, String
+      optional :reason, String, nil?: true
 
       # @!method initialize(address:, reason: nil, request_options: {})
       #   @param address [String] Email address to suppress
       #
-      #   @param reason [String] Reason for suppression
+      #   @param reason [String, nil] Reason for suppression (accepts null)
       #
       #   @param request_options [ArkEmail::RequestOptions, Hash{Symbol=>Object}]
     end

data/lib/ark_email/models/tracking_create_params.rb

@@ -10,8 +10,8 @@ module ArkEmail
       # @!attribute domain_id
       #   ID of the sending domain to attach this track domain to
       #
-      #   @return [String]
-      required :domain_id, String, api_name: :domainId
+      #   @return [Integer]
+      required :domain_id, Integer, api_name: :domainId
 
       # @!attribute name
       #   Subdomain name (e.g., 'track' for track.yourdomain.com)
@@ -20,33 +20,33 @@ module ArkEmail
       required :name, String
 
       # @!attribute ssl_enabled
-      #   Enable SSL for tracking URLs (recommended)
+      #   Enable SSL for tracking URLs (accepts null, defaults to true)
       #
       #   @return [Boolean, nil]
-      optional :ssl_enabled, ArkEmail::Internal::Type::Boolean, api_name: :sslEnabled
+      optional :ssl_enabled, ArkEmail::Internal::Type::Boolean, api_name: :sslEnabled, nil?: true
 
       # @!attribute track_clicks
-      #   Enable click tracking
+      #   Enable click tracking (accepts null, defaults to true)
       #
       #   @return [Boolean, nil]
-      optional :track_clicks, ArkEmail::Internal::Type::Boolean, api_name: :trackClicks
+      optional :track_clicks, ArkEmail::Internal::Type::Boolean, api_name: :trackClicks, nil?: true
 
       # @!attribute track_opens
-      #   Enable open tracking (tracking pixel)
+      #   Enable open tracking (tracking pixel, accepts null, defaults to true)
       #
       #   @return [Boolean, nil]
-      optional :track_opens, ArkEmail::Internal::Type::Boolean, api_name: :trackOpens
+      optional :track_opens, ArkEmail::Internal::Type::Boolean, api_name: :trackOpens, nil?: true
 
       # @!method initialize(domain_id:, name:, ssl_enabled: nil, track_clicks: nil, track_opens: nil, request_options: {})
-      #   @param domain_id [String] ID of the sending domain to attach this track domain to
+      #   @param domain_id [Integer] ID of the sending domain to attach this track domain to
       #
       #   @param name [String] Subdomain name (e.g., 'track' for track.yourdomain.com)
       #
-      #   @param ssl_enabled [Boolean] Enable SSL for tracking URLs (recommended)
+      #   @param ssl_enabled [Boolean, nil] Enable SSL for tracking URLs (accepts null, defaults to true)
       #
-      #   @param track_clicks [Boolean] Enable click tracking
+      #   @param track_clicks [Boolean, nil] Enable click tracking (accepts null, defaults to true)
       #
-      #   @param track_opens [Boolean] Enable open tracking (tracking pixel)
+      #   @param track_opens [Boolean, nil] Enable open tracking (tracking pixel, accepts null, defaults to true)
       #
       #   @param request_options [ArkEmail::RequestOptions, Hash{Symbol=>Object}]
     end

data/lib/ark_email/models/tracking_update_params.rb

@@ -8,37 +8,37 @@ module ArkEmail
       include ArkEmail::Internal::Type::RequestParameters
 
       # @!attribute excluded_click_domains
-      #   Comma-separated list of domains to exclude from click tracking
+      #   Comma-separated list of domains to exclude from click tracking (accepts null)
       #
       #   @return [String, nil]
-      optional :excluded_click_domains, String, api_name: :excludedClickDomains
+      optional :excluded_click_domains, String, api_name: :excludedClickDomains, nil?: true
 
       # @!attribute ssl_enabled
-      #   Enable or disable SSL for tracking URLs
+      #   Enable or disable SSL for tracking URLs (accepts null)
       #
       #   @return [Boolean, nil]
-      optional :ssl_enabled, ArkEmail::Internal::Type::Boolean, api_name: :sslEnabled
+      optional :ssl_enabled, ArkEmail::Internal::Type::Boolean, api_name: :sslEnabled, nil?: true
 
       # @!attribute track_clicks
-      #   Enable or disable click tracking
+      #   Enable or disable click tracking (accepts null)
       #
       #   @return [Boolean, nil]
-      optional :track_clicks, ArkEmail::Internal::Type::Boolean, api_name: :trackClicks
+      optional :track_clicks, ArkEmail::Internal::Type::Boolean, api_name: :trackClicks, nil?: true
 
       # @!attribute track_opens
-      #   Enable or disable open tracking
+      #   Enable or disable open tracking (accepts null)
       #
       #   @return [Boolean, nil]
-      optional :track_opens, ArkEmail::Internal::Type::Boolean, api_name: :trackOpens
+      optional :track_opens, ArkEmail::Internal::Type::Boolean, api_name: :trackOpens, nil?: true
 
       # @!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 excluded_click_domains [String, nil] Comma-separated list of domains to exclude from click tracking (accepts null)
       #
-      #   @param ssl_enabled [Boolean] Enable or disable SSL for tracking URLs
+      #   @param ssl_enabled [Boolean, nil] Enable or disable SSL for tracking URLs (accepts null)
       #
-      #   @param track_clicks [Boolean] Enable or disable click tracking
+      #   @param track_clicks [Boolean, nil] Enable or disable click tracking (accepts null)
       #
-      #   @param track_opens [Boolean] Enable or disable open tracking
+      #   @param track_opens [Boolean, nil] Enable or disable open tracking (accepts null)
       #
       #   @param request_options [ArkEmail::RequestOptions, Hash{Symbol=>Object}]
     end

data/lib/ark_email/models/webhook_create_params.rb

@@ -7,21 +7,6 @@ module ArkEmail
       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
       #
@@ -35,29 +20,47 @@ module ArkEmail
       required :url, String
 
       # @!attribute all_events
-      #   Subscribe to all events (ignores events array)
+      #   Subscribe to all events (ignores events array, accepts null)
       #
       #   @return [Boolean, nil]
-      optional :all_events, ArkEmail::Internal::Type::Boolean, api_name: :allEvents
+      optional :all_events, ArkEmail::Internal::Type::Boolean, api_name: :allEvents, nil?: true
 
       # @!attribute enabled
+      #   Whether the webhook is enabled (accepts null)
       #
       #   @return [Boolean, nil]
-      optional :enabled, ArkEmail::Internal::Type::Boolean
+      optional :enabled, ArkEmail::Internal::Type::Boolean, nil?: true
+
+      # @!attribute events
+      #   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
+      #
+      #   @return [Array<Symbol, ArkEmail::Models::WebhookCreateParams::Event>, nil]
+      optional :events,
+               -> { ArkEmail::Internal::Type::ArrayOf[enum: ArkEmail::WebhookCreateParams::Event] },
+               nil?: true
 
-      # @!method initialize(events:, name:, url:, all_events: nil, enabled: nil, request_options: {})
+      # @!method initialize(name:, url:, all_events: nil, enabled: nil, events: 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 all_events [Boolean, nil] Subscribe to all events (ignores events array, accepts null)
+      #
+      #   @param enabled [Boolean, nil] Whether the webhook is enabled (accepts null)
       #
-      #   @param enabled [Boolean]
+      #   @param events [Array<Symbol, ArkEmail::Models::WebhookCreateParams::Event>, nil] Events to subscribe to (accepts null):
       #
       #   @param request_options [ArkEmail::RequestOptions, Hash{Symbol=>Object}]
 

data/lib/ark_email/models/webhook_update_params.rb

@@ -10,34 +10,34 @@ module ArkEmail
       # @!attribute all_events
       #
       #   @return [Boolean, nil]
-      optional :all_events, ArkEmail::Internal::Type::Boolean, api_name: :allEvents
+      optional :all_events, ArkEmail::Internal::Type::Boolean, api_name: :allEvents, nil?: true
 
       # @!attribute enabled
       #
       #   @return [Boolean, nil]
-      optional :enabled, ArkEmail::Internal::Type::Boolean
+      optional :enabled, ArkEmail::Internal::Type::Boolean, nil?: true
 
       # @!attribute events
       #
       #   @return [Array<String>, nil]
-      optional :events, ArkEmail::Internal::Type::ArrayOf[String]
+      optional :events, ArkEmail::Internal::Type::ArrayOf[String], nil?: true
 
       # @!attribute name
       #
       #   @return [String, nil]
-      optional :name, String
+      optional :name, String, nil?: true
 
       # @!attribute url
       #
       #   @return [String, nil]
-      optional :url, String
+      optional :url, String, nil?: true
 
       # @!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 all_events [Boolean, nil]
+      #   @param enabled [Boolean, nil]
+      #   @param events [Array<String>, nil]
+      #   @param name [String, nil]
+      #   @param url [String, nil]
       #   @param request_options [ArkEmail::RequestOptions, Hash{Symbol=>Object}]
     end
   end

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.
       #
@@ -150,21 +150,23 @@ module ArkEmail
       #
       # @param to [Array<String>] Body param: Recipient email addresses (max 50)
       #
-      # @param attachments [Array<ArkEmail::Models::EmailSendParams::Attachment>] Body param: File attachments
+      # @param attachments [Array<ArkEmail::Models::EmailSendParams::Attachment>, nil] Body param: File attachments (accepts null)
       #
-      # @param bcc [Array<String>] Body param: BCC recipients
+      # @param bcc [Array<String>, nil] Body param: BCC recipients (accepts null)
       #
-      # @param cc [Array<String>] Body param: CC recipients
+      # @param cc [Array<String>, nil] Body param: CC recipients (accepts null)
       #
-      # @param headers [Hash{Symbol=>String}] Body param: Custom email headers
+      # @param headers [Hash{Symbol=>String}, nil] Body param: Custom email headers (accepts null)
       #
-      # @param html [String] Body param: HTML body content.
+      # @param html [String, nil] Body param: HTML body content (accepts null).
       #
-      # @param reply_to [String] Body param: Reply-to address
+      # @param metadata [Hash{Symbol=>String}, nil] Body param: Custom key-value pairs attached to an email for webhook correlation.
       #
-      # @param tag [String] Body param: Tag for categorization and filtering
+      # @param reply_to [String, nil] Body param: Reply-to address (accepts null)
       #
-      # @param text [String] Body param: Plain text body (auto-generated from HTML if not provided).
+      # @param tag [String, nil] Body param: Tag for categorization and filtering (accepts null)
+      #
+      # @param text [String, nil] Body param: Plain text body (accepts null, auto-generated from HTML if not provi
       #
       # @param idempotency_key [String] Header param: Unique key for idempotent requests. If a request with this key was
       #
@@ -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
       #
@@ -228,7 +230,7 @@ module ArkEmail
       #
       # The `data` field should contain the base64-encoded raw email.
       #
-      # @overload send_raw(data:, mail_from:, rcpt_to:, request_options: {})
+      # @overload send_raw(data:, mail_from:, rcpt_to:, bounce: nil, request_options: {})
       #
       # @param data [String] Base64-encoded RFC 2822 message
       #
@@ -236,6 +238,8 @@ module ArkEmail
       #
       # @param rcpt_to [Array<String>] Envelope recipient addresses
       #
+      # @param bounce [Boolean, nil] Whether this is a bounce message (accepts null)
+      #
       # @param request_options [ArkEmail::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [ArkEmail::Models::EmailSendRawResponse]

data/lib/ark_email/resources/suppressions.rb

@@ -10,7 +10,7 @@ module ArkEmail
       #
       # @param address [String] Email address to suppress
       #
-      # @param reason [String] Reason for suppression
+      # @param reason [String, nil] Reason for suppression (accepts null)
       #
       # @param request_options [ArkEmail::RequestOptions, Hash{Symbol=>Object}, nil]
       #