feat: Pagination support for list methods (#126)

Author: drish

examples/api_keys.rb

@@ -19,6 +19,14 @@ def list
   puts keys
 end
 
+def list_paginated
+  # List with pagination parameters
+  paginated_keys = Resend::ApiKeys.list({ limit: 10, after: "key_id_here" })
+  puts "Paginated response:"
+  puts paginated_keys
+  puts "Has more: #{paginated_keys[:has_more]}" if paginated_keys[:has_more]
+end
+
 def remove
   key = Resend::ApiKeys.create({name: "t"})
   puts "created api key id: #{key[:id]}"

examples/audiences.rb

@@ -19,6 +19,11 @@ def example
   audiences = Resend::Audiences.list
   puts audiences
 
+  # Example with pagination
+  paginated_audiences = Resend::Audiences.list({ limit: 5 })
+  puts "Paginated audiences (limit 5):"
+  puts paginated_audiences
+
   Resend::Audiences.remove audience[:id]
   puts "deleted #{audience[:id]}"
 end

examples/broadcasts.rb

@@ -39,6 +39,11 @@
 broadcasts = Resend::Broadcasts.list
 puts broadcasts
 
+# Example with pagination
+paginated_broadcasts = Resend::Broadcasts.list({ limit: 15, after: "broadcast_id_here" })
+puts "Paginated broadcasts (limit 15, after broadcast_id_here):"
+puts paginated_broadcasts
+
 retrieved = Resend::Broadcasts.get(broadcast[:id])
 puts "retrieved #{retrieved[:id]}"
 

examples/contacts.rb

@@ -43,6 +43,11 @@ def example
   contacts = Resend::Contacts.list(audience_id)
   puts contacts
 
+  # Example with pagination
+  paginated_contacts = Resend::Contacts.list(audience_id, { limit: 10 })
+  puts "Paginated contacts (limit 10):"
+  puts paginated_contacts
+
   # delete by id
   del = Resend::Contacts.remove(audience_id, contact[:id])
 

examples/domains.rb

@@ -49,6 +49,11 @@ def update
 def list
   domains = Resend::Domains.list
   puts domains
+
+  # Example with pagination
+  paginated_domains = Resend::Domains.list({ limit: 20, before: "domain_id_here" })
+  puts "Paginated domains (limit 20, before domain_id_here):"
+  puts paginated_domains
 end
 
 def remove

examples/with_pagination.rb

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+require_relative "../lib/resend"
+
+raise if ENV["RESEND_API_KEY"].nil?
+
+Resend.api_key = ENV["RESEND_API_KEY"]
+
+puts "=== Resend Ruby SDK Pagination Examples ==="
+puts
+
+# API Keys pagination
+puts "1. API Keys Pagination:"
+puts "List first 5 API keys:"
+api_keys = Resend::ApiKeys.list({ limit: 5 })
+puts api_keys
+puts "Has more: #{api_keys[:has_more]}" if api_keys.key?(:has_more)
+puts
+
+# Audiences pagination
+puts "2. Audiences Pagination:"
+puts "List first 10 audiences:"
+audiences = Resend::Audiences.list({ limit: 10 })
+puts audiences
+puts "Has more: #{audiences[:has_more]}" if audiences.key?(:has_more)
+puts
+
+# If we have audiences, demonstrate pagination with 'after'
+if audiences[:data] && !audiences[:data].empty?
+  first_audience_id = audiences[:data].first[:id]
+  puts "List audiences after '#{first_audience_id}':"
+  next_audiences = Resend::Audiences.list({ limit: 5, after: first_audience_id })
+  puts next_audiences
+  puts
+end
+
+# Domains pagination
+puts "3. Domains Pagination:"
+puts "List first 3 domains:"
+domains = Resend::Domains.list({ limit: 3 })
+puts domains
+puts "Has more: #{domains[:has_more]}" if domains.key?(:has_more)
+puts
+
+# Broadcasts pagination
+puts "4. Broadcasts Pagination:"
+puts "List first 2 broadcasts:"
+broadcasts = Resend::Broadcasts.list({ limit: 2 })
+puts broadcasts
+puts "Has more: #{broadcasts[:has_more]}" if broadcasts.key?(:has_more)
+puts
+
+# Contacts pagination (requires an audience ID)
+puts "5. Contacts Pagination:"
+if audiences[:data] && !audiences[:data].empty?
+  audience_id = audiences[:data].first[:id]
+  if audience_id && !audience_id.empty?
+    puts "List first 5 contacts from audience '#{audience_id}':"
+    begin
+      contacts = Resend::Contacts.list(audience_id, { limit: 5 })
+      puts contacts
+      puts "Has more: #{contacts[:has_more]}" if contacts.key?(:has_more)
+    rescue Resend::Error => e
+      puts "Error listing contacts: #{e.message}"
+      puts "(This might happen if the audience has no contacts or access is restricted)"
+    end
+  else
+    puts "Audience ID is empty, skipping contacts pagination example"
+  end
+else
+  puts "No audiences available for contacts pagination example"
+end
+puts
+
+puts "=== Pagination Parameters ==="
+puts "• limit: Number of items to retrieve (1-100)"
+puts "• after: ID after which to retrieve more items"
+puts "• before: ID before which to retrieve more items"
+puts
+puts "Example usage:"
+puts "Resend::ApiKeys.list({ limit: 25, after: 'key_123' })"
+puts "Resend::Domains.list({ limit: 10, before: 'domain_456' })"
+puts "Resend::Contacts.list('audience_id', { limit: 50 })"

lib/resend.rb

@@ -6,9 +6,11 @@
 # Utils
 require "httparty"
 require "json"
+require "cgi"
 require "resend/errors"
 require "resend/client"
 require "resend/request"
+require "resend/pagination_helper"
 
 # API Operations
 require "resend/audiences"

lib/resend/api_keys.rb

@@ -11,8 +11,8 @@ def create(params)
       end
 
       # https://resend.com/docs/api-reference/api-keys/list-api-keys
-      def list
-        path = "api-keys"
+      def list(params = {})
+        path = Resend::PaginationHelper.build_paginated_path("api-keys", params)
         Resend::Request.new(path, {}, "get").perform
       end
 

lib/resend/audiences.rb

@@ -17,8 +17,8 @@ def get(audience_id = "")
       end
 
       # https://resend.com/docs/api-reference/audiences/list-audiences
-      def list
-        path = "audiences"
+      def list(params = {})
+        path = Resend::PaginationHelper.build_paginated_path("audiences", params)
         Resend::Request.new(path, {}, "get").perform
       end
 

lib/resend/broadcasts.rb

@@ -23,8 +23,8 @@ def send(params = {})
       end
 
       # https://resend.com/docs/api-reference/broadcasts/list-broadcasts
-      def list
-        path = "broadcasts"
+      def list(params = {})
+        path = Resend::PaginationHelper.build_paginated_path("broadcasts", params)
         Resend::Request.new(path, {}, "get").perform
       end