resend 1.10.0 → 1.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f371f1dad3f54dd4be3d53a1a242749f451a2052b87faf8c062a29b001fa9d40
-  data.tar.gz: 5acf401dbb4d342126629e4e7f13744cd9569ec4cb872a1e14822f5c1d207ab7
+  metadata.gz: 64e11672300db0ff3bdc430fada0fbd8ca115a07d2bfbbd761ea95dacf1e5c80
+  data.tar.gz: 02d393546fb4316ae1f9a6da5682e7d7b71aaad6b36a1bf29a84e4ef1996336e
 SHA512:
-  metadata.gz: 65c023232e15a0a64fe731ab6a5691d29972bc3b2e57a2f25b5ccdfe94d7c92ef80da1d8acb06a1cd9ddb23338767b07c960cb099d74990f46a9f0c8a3e8314d
-  data.tar.gz: 88301451135d13c9944062cb08e5b2a59e76e933cdc01cdcabbfc8c944f9cce70fa88eb7fd238cd59f799fd4f22d0b0cfd1bf9e0bc785d5cd03b363dff6177fe
+  metadata.gz: 714868b613882c10b8990bef7a06dcd132e5d29dbda076f84d13f5c69ffe60fed0518d694e67e5a7ce46bc9a4fe84352a418dfc8711020d04a307764bd3130de
+  data.tar.gz: 9465a51da2439c78eedaad4bf9ad5e411e6a1068fb5c28d8829c9f8a4fadeab23c7c4da5f3fc40af48b58c457eefe403cb57533ad79c0dbe2f3b0bf4f2837a60

data/lib/resend/broadcasts.rb

@@ -41,6 +41,12 @@ module Resend
         Resend::Request.new(path, {}, "get").perform
       end
 
+      # https://resend.com/docs/api-reference/broadcasts/list-broadcast-clicked-links
+      def clicked_links(broadcast_id = "", params = {})
+        path = Resend::PaginationHelper.build_paginated_path("broadcasts/#{broadcast_id}/clicked-links", params)
+        Resend::Request.new(path, {}, "get").perform
+      end
+
       def cancel(broadcast_id = "")
         path = "broadcasts/#{broadcast_id}/cancel"
         Resend::Request.new(path, {}, "post").perform
@@ -57,6 +63,25 @@ module Resend
         path = "broadcasts/#{broadcast_id}"
         Resend::Request.new(path, {}, "get").perform
       end
+
+      # https://resend.com/docs/api-reference/broadcasts/list-broadcast-recipients
+      # @param broadcast_id [String] the broadcast id
+      # @param params [Hash] the parameters
+      # @option params [String] :type the recipient event type to filter by (required):
+      #   sent, delivered, opened, clicked, bounced, complained, unsubscribed, suppressed
+      # @option params [String] :email filter recipients by email address (optional)
+      # @option params [String] :bounce_type filter bounced recipients by bounce type (optional,
+      #   only valid when type is bounced): permanent, transient, undetermined
+      # @option params [Integer] :limit the maximum number of results to return (optional)
+      # @option params [String] :after the cursor for pagination (optional)
+      # @option params [String] :before the cursor for pagination (optional)
+      def recipients(broadcast_id = "", params = {})
+        raise ArgumentError, "type is required" if params[:type].nil?
+
+        base_path = "broadcasts/#{broadcast_id}/recipients"
+        path = Resend::PaginationHelper.build_paginated_path(base_path, params)
+        Resend::Request.new(path, {}, "get").perform
+      end
     end
   end
 end

data/lib/resend/emails.rb

@@ -61,6 +61,64 @@ module Resend
 
         Resend::Request.new(path, query_params, "get").perform
       end
+
+      # Retrieve email metrics.
+      # see more: https://resend.com/docs/api-reference/emails/metrics
+      #
+      # @param options [Hash] Optional parameters for filtering and shaping the metrics response
+      # @option options [String] :start_date ISO 8601 date/datetime. Defaults to 6 days before :end_date
+      # @option options [String] :end_date ISO 8601 date/datetime. Defaults to now
+      # @option options [String] :timezone IANA timezone, e.g. "America/New_York". Defaults to "UTC"
+      # @option options [String] :granularity Bucket size used when :period is in :dimensions.
+      #   One of "hourly", "daily", "weekly", "monthly". Defaults to "daily"
+      # @option options [Array<String>] :metrics Metrics to include. Defaults to all metrics.
+      # @option options [Array<String>] :dimensions Dimensions to break down by: "period", "domain",
+      #   "email", "broadcast". Defaults to none, which returns totals only.
+      # @option options [Array<String>] :domain_id Restrict to these sending domain IDs (max 100)
+      # @option options [Array<String>] :email_id Restrict to these email IDs (max 100)
+      # @option options [Array<String>] :broadcast_id Restrict to these broadcast IDs (max 100)
+      def metrics(options = {})
+        path = "emails/metrics"
+        validate_metrics_options(options)
+        Resend::Request.new(path, build_metrics_query(options), "get").perform
+      end
+
+      private
+
+      # The `email` and `broadcast` dimensions/filters are mutually exclusive.
+      def validate_metrics_options(options)
+        dimensions = Array(options[:dimensions])
+        has_broadcast = dimensions.include?("broadcast") || !Array(options[:broadcast_id]).empty?
+        has_email = dimensions.include?("email") || !Array(options[:email_id]).empty?
+
+        return unless has_broadcast && has_email
+
+        raise ArgumentError,
+              "`broadcast`/`broadcast_id` cannot be combined with `email`/`email_id`"
+      end
+
+      # Builds the metrics query hash, filtering out nil values and joining
+      # list-style params (metrics, dimensions, domain_id, email_id, broadcast_id)
+      # into comma-separated strings as expected by the API.
+      def build_metrics_query(options)
+        query_params = {}
+
+        %i[start_date end_date timezone granularity].each do |key|
+          value = options[key]
+          query_params[key] = value unless blank?(value)
+        end
+
+        %i[metrics dimensions domain_id email_id broadcast_id].each do |key|
+          values = Array(options[key]).reject { |value| blank?(value) }
+          query_params[key] = values.join(",") unless values.empty?
+        end
+
+        query_params
+      end
+
+      def blank?(value)
+        value.nil? || value.to_s.empty?
+      end
     end
   end
 end

data/lib/resend/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Resend
-  VERSION = "1.10.0"
+  VERSION = "1.11.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: resend
 version: !ruby/object:Gem::Version
-  version: 1.10.0
+  version: 1.11.0
 platform: ruby
 authors:
 - Derich Pacheco