sendly 3.13.1 → 3.15.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1ad8dcba5563ab2a1db6279693b52ebb4d8317ab00b227e0ab48579010cf1042
-  data.tar.gz: dc3654811cb83405cbf9e432f73392784be9da9a2bd7435b9cf5107553592bf2
+  metadata.gz: 56c908f29c221c85c90e24d73b43066013f4d3cec54aba6fe7517fb227e045b4
+  data.tar.gz: d128303727afab0708a108693a8effc1026296ade3b90e2de848286166d8eaea
 SHA512:
-  metadata.gz: 8735eda8760bb4370c8b5706e50973b221023d5dd066cb3aba31b005c23c752933e874826b216d1fad084793c7f321755f10d707e23fb9077db9df7940fc8beb
-  data.tar.gz: eceee9b80a5409b234ff876e5733ca5d9b375793a6fef0e755b334003d8794fbc39c68c216c9f8da1f69e06a7a5915b2a59bc82277b3c77f73432ffac89d6411
+  metadata.gz: ce1fa34f4d023c436c61fca5edd146f14eb57c8e7b881ed6e34f10d3aa1cfa18a0304fae311251c0c3dcb89ad86b0888ca74297d809d0f7863af6c808371f455
+  data.tar.gz: 9b1f5393016e47ec383a5436942c4da13f34acf65b95bb764d32aff4b83f615f3394326213926ad56ca2aa3bcfcecb2320ee07286215f1f8c2d7939b2c2457f7

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    sendly (3.13.1)
+    sendly (3.15.2)
       faraday (~> 2.0)
       faraday-retry (~> 2.0)
 

data/README.md

@@ -108,6 +108,13 @@ message = client.messages.send(
   message_type: "transactional"
 )
 
+# With custom metadata (max 4KB)
+message = client.messages.send(
+  to: "+15551234567",
+  text: "Your order #12345 has shipped!",
+  metadata: { order_id: "12345", customer_id: "cust_abc" }
+)
+
 puts message.id
 puts message.status
 puts message.credits_used

data/lib/sendly/messages.rb

@@ -15,6 +15,7 @@ module Sendly
     # @param to [String] Recipient phone number in E.164 format
     # @param text [String] Message content (max 1600 characters)
     # @param message_type [String] Message type: "marketing" (default) or "transactional"
+    # @param metadata [Hash] Custom JSON metadata to attach to the message (max 4KB)
     # @return [Sendly::Message] The sent message
     #
     # @raise [Sendly::ValidationError] If parameters are invalid
@@ -35,12 +36,13 @@ module Sendly
     #     text: "Your verification code is 123456",
     #     message_type: "transactional"
     #   )
-    def send(to:, text:, message_type: nil)
+    def send(to:, text:, message_type: nil, metadata: nil)
       validate_phone!(to)
       validate_text!(text)
 
       body = { to: to, text: text }
       body[:messageType] = message_type if message_type
+      body[:metadata] = metadata if metadata
 
       response = client.post("/messages", body)
       # API returns message directly at top level
@@ -129,6 +131,7 @@ module Sendly
     # @param scheduled_at [String] ISO 8601 datetime for when to send
     # @param from [String] Sender ID or phone number (optional)
     # @param message_type [String] Message type: "marketing" (default) or "transactional"
+    # @param metadata [Hash] Custom JSON metadata to attach to the message (max 4KB)
     # @return [Hash] The scheduled message
     #
     # @raise [Sendly::ValidationError] If parameters are invalid
@@ -140,7 +143,7 @@ module Sendly
     #     scheduled_at: "2025-01-20T10:00:00Z"
     #   )
     #   puts scheduled["id"]
-    def schedule(to:, text:, scheduled_at:, from: nil, message_type: nil)
+    def schedule(to:, text:, scheduled_at:, from: nil, message_type: nil, metadata: nil)
       validate_phone!(to)
       validate_text!(text)
       raise ValidationError, "scheduled_at is required" if scheduled_at.nil? || scheduled_at.empty?
@@ -148,6 +151,7 @@ module Sendly
       body = { to: to, text: text, scheduledAt: scheduled_at }
       body[:from] = from if from
       body[:messageType] = message_type if message_type
+      body[:metadata] = metadata if metadata
 
       client.post("/messages/schedule", body)
     end
@@ -212,6 +216,7 @@ module Sendly
     # @param messages [Array<Hash>] Array of messages with :to and :text keys
     # @param from [String] Sender ID or phone number (optional, applies to all)
     # @param message_type [String] Message type: "marketing" (default) or "transactional"
+    # @param metadata [Hash] Shared metadata for all messages (max 4KB). Each message can also have its own metadata hash which takes priority.
     # @return [Hash] Batch response with batch_id and status
     #
     # @raise [Sendly::ValidationError] If parameters are invalid
@@ -225,7 +230,7 @@ module Sendly
     #     ]
     #   )
     #   puts "Batch #{result['batchId']}: #{result['queued']} queued"
-    def send_batch(messages:, from: nil, message_type: nil)
+    def send_batch(messages:, from: nil, message_type: nil, metadata: nil)
       raise ValidationError, "Messages array is required" if messages.nil? || messages.empty?
 
       messages.each_with_index do |msg, i|
@@ -241,6 +246,7 @@ module Sendly
       body = { messages: messages }
       body[:from] = from if from
       body[:messageType] = message_type if message_type
+      body[:metadata] = metadata if metadata
 
       client.post("/messages/batch", body)
     end

data/lib/sendly/types.rb

@@ -51,6 +51,9 @@ module Sendly
     # @return [Time, nil] Delivery timestamp
     attr_reader :delivered_at
 
+    # @return [Hash, nil] Custom metadata attached to the message
+    attr_reader :metadata
+
     # Message status constants (sending removed - doesn't exist in database)
     STATUSES = %w[queued sent delivered failed bounced].freeze
 
@@ -74,6 +77,7 @@ module Sendly
       @sender_note = data["senderNote"]
       @created_at = parse_time(data["createdAt"])
       @delivered_at = parse_time(data["deliveredAt"])
+      @metadata = data["metadata"]
     end
 
     # Check if message was delivered
@@ -113,7 +117,8 @@ module Sendly
         warning: warning,
         sender_note: sender_note,
         created_at: created_at&.iso8601,
-        delivered_at: delivered_at&.iso8601
+        delivered_at: delivered_at&.iso8601,
+        metadata: metadata
       }.compact
     end
 

data/lib/sendly/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Sendly
-  VERSION = "3.13.1"
+  VERSION = "3.15.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sendly
 version: !ruby/object:Gem::Version
-  version: 3.13.1
+  version: 3.15.2
 platform: ruby
 authors:
 - Sendly
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2026-02-01 00:00:00.000000000 Z
+date: 2026-02-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday