millionsend 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d9260a596d597a0aad944da04656fb5c99606374b48b9e235f3e883917ef2bc6
-  data.tar.gz: 677e347b5604bd68edf198df96802d652470d3e4aef679460fdb24bce3563993
+  metadata.gz: 0d6e46f436a0805ef763edac14bbd254e6f17503c598a8374b6abe9f45efcc76
+  data.tar.gz: 04c8ab67229c03c8769c7f9ef872b0e11b98d8aa8919a21c0d4c6ce6cc0582f9
 SHA512:
-  metadata.gz: fb4c0031b1c2b22911ebba5b0f5d45c05b613196b2e665c11212d5146c5e7102c4cdbba343245acf814bffc6e8394d603c2c124d325a25c4c70fc1a49ac21789
-  data.tar.gz: bae43393a0387f459f882638a9eb6a7961cdc6d9b94b602d914cd199c071ce7e403706610e89e1426273e347cb1a3d6393518cf7d9f91d567352692c8765f2fe
+  metadata.gz: ea4ff1283155e92f65aea2088a6ae4abdfd5032b3c93c243eb838a30ab141070c328bc7d2a278e0399894ec1e18300abef83a727ace9ed48a4b7e3271941e284
+  data.tar.gz: e845a9d24731c584b931a0de44fd7f0adee3760bcaa8d45d55412e301c6e9ad545cc1d62e294938e8adbdba07ebc204d156a96584d2d5b16fc721826853137dc

data/README.md

@@ -128,7 +128,12 @@ Millionsend::Contacts.list(limit: 50)
 Millionsend::Contacts::Topics.update(email: "ada@acme.dev", topics: [{ id: topic_id, subscription: "opt_out" }]) # resend-ruby shape
 Millionsend::Contacts.topics_update("ada@acme.dev", [{ id: topic_id, subscription: "opt_out" }])                 # positional
 Millionsend::Contacts::Topics.list(email: "ada@acme.dev") # GET /contacts/:id/topics — every topic with its effective
-                                                          # subscription; explicit: false when it is the topic's default
+                                                          # subscription (explicit: false when it is the topic's default)
+                                                          # and its visibility ("public" | "private")
+
+# Preference-center link (MillionSend extension) — POST /contacts/:id/preferences-link
+link = Millionsend::Contacts.preferences_link("ada@acme.dev") # by id or email; also preferences_link(id: ...) / (email: ...)
+link[:url] # the contact's hosted preference page; no expiry, so show it only to that contact
 
 # Segment membership — POST / DELETE /contacts/:id/segments/:segment_id
 Millionsend::Contacts::Segments.add("ada@acme.dev", segment_id)
@@ -143,6 +148,10 @@ result = Millionsend::Contacts::Batch.create(
 result[:data]   # [{ index:, id:, status: "created" | "updated" | "skipped" }]
 result[:counts] # { created:, updated:, skipped:, failed: }
 result[:errors] # permissive mode only: [{ index:, message: }]
+
+# Bulk delete (MillionSend extension) — up to 1000 per call, exactly one of ids: / emails:
+Millionsend::Contacts::Batch.remove(emails: ["a@acme.dev", "b@acme.dev"]) # or ids: [...]
+# => { data: [{ object: "contact", contact: "<uuid>", deleted: true }, ...] } — only the rows actually deleted
 ```
 
 Contacts are addressable by id or email; when an `update` hash carries both, the email wins.
@@ -237,14 +246,26 @@ hook = Millionsend::Webhooks.create(
   signing_secret: "whsec_..." # optional: reuse an existing secret so the receiver keeps verifying
 )
 hook[:signing_secret]
-Millionsend::Webhooks.get(hook[:id]) # also returns signing_secret
+Millionsend::Webhooks.get(hook[:id]) # also returns signing_secret and previous_secret_expires_at
 Millionsend::Webhooks.list
 Millionsend::Webhooks.update(hook[:id], events: ["email.opened"], status: "disabled")
 Millionsend::Webhooks.remove(hook[:id])
+
+# Rotate the signing secret (MillionSend extension) — POST /webhooks/:id/rotate
+rotated = Millionsend::Webhooks.rotate(hook[:id])                                         # mints a new secret, 24h overlap
+rotated = Millionsend::Webhooks.rotate(hook[:id], signing_secret: "whsec_...", overlap_hours: 0) # bring your own, no overlap
+rotated[:signing_secret]              # the secret now signing deliveries
+rotated[:previous_secret_expires_at]  # ISO time until which the old secret also signs, or nil
 ```
 
+During the overlap window (`overlap_hours`, 0–72, default 24) every delivery carries both
+signatures, so a receiver holding either verifies; `Webhooks.get` reports the window's end
+as `previous_secret_expires_at` (`nil` when none is open).
+
 Events: `email.sent`, `email.delivered`, `email.delivery_delayed`, `email.bounced`,
-`email.complained`, `email.opened`, `email.clicked`, `deliverability.warning`,
+`email.complained`, `email.opened`, `email.clicked`, `contact.created`, `contact.updated`,
+`contact.deleted`, `contact.unsubscribed`, `contact.resubscribed`, `contact.topic_opt_in`,
+`contact.topic_opt_out`, `suppression.added`, `suppression.removed`, `deliverability.warning`,
 `deliverability.paused`, `quota.warning`, `quota.reached`, `quota.paused`.
 
 ### API keys
@@ -368,8 +389,9 @@ works as in resend-ruby. Notes:
   Resend's audiences alias.
 - Not in the API (yet), so not here: broadcast recipients/clicked links, email sharing and
   metrics, contact imports, receiving, automations, logs, OAuth grants, webhook event replay.
-- MillionSend extensions with no Resend counterpart: `Segments`, `Contacts::Batch`, `Usage`,
-  `Deliverability`, `Emails.get_insights`, `Suppressions` `origin: "unsubscribe"`.
+- MillionSend extensions with no Resend counterpart: `Segments`, `Contacts::Batch`,
+  `Contacts.preferences_link`, `Webhooks.rotate`, `Usage`, `Deliverability`,
+  `Emails.get_insights`, `Suppressions` `origin: "unsubscribe"`.
 
 ## License
 

data/lib/millionsend/contacts.rb

@@ -42,6 +42,14 @@ module Millionsend
         Millionsend::Request.new(method: :patch, path: "#{member_path(id_or_email)}/topics", body: topics).perform
       end
 
+      # POST /contacts/:id_or_email/preferences-link — the contact's hosted
+      # preference page, { object: "preferences_link", contact:, url: }. The
+      # url is a contact-scoped capability with no expiry: hand it only to that
+      # contact. 422 when the instance cannot build hosted links.
+      def preferences_link(id_or_email)
+        Millionsend::Request.new(method: :post, path: "#{member_path(id_or_email)}/preferences-link").perform
+      end
+
       # Every member method also accepts resend-ruby's addressing hash
       # ({ id: } / { email: } / { contact_id: }) in place of the bare value.
       def member_path(id_or_email)
@@ -54,9 +62,10 @@ module Millionsend
     module Topics
       class << self
         # GET /contacts/:id_or_email/topics — { id: | email: } or a bare id/email.
-        # Every topic comes back with the contact's effective subscription;
-        # explicit: false means it is the topic's default, not a stored choice.
-        # Unpaginated, like Topics.list.
+        # Every topic comes back with the contact's effective subscription
+        # (explicit: false means it is the topic's default, not a stored
+        # choice) and its visibility ("public" | "private"). Unpaginated, like
+        # Topics.list.
         def list(params)
           Millionsend::Request.new(method: :get, path: "#{Millionsend::Contacts.member_path(params)}/topics").perform
         end
@@ -68,7 +77,8 @@ module Millionsend
       end
     end
 
-    # Bulk contact creation — a MillionSend extension (Resend imports via CSV).
+    # Bulk contact creation and deletion — MillionSend extensions (Resend
+    # imports via CSV and deletes one at a time).
     module Batch
       class << self
         # POST /contacts/batch with a bare array of up to 1000 create payloads.
@@ -85,6 +95,14 @@ module Millionsend
             **Millionsend::Util.request_options(options)
           ).perform
         end
+
+        # POST /contacts/batch/remove — { ids: [...] } or { emails: [...] }
+        # (exactly one, up to 1000). Returns { data: [{ object:, contact:,
+        # deleted: true }] } listing only the rows actually deleted; unknown
+        # ids or addresses are skipped.
+        def remove(params)
+          Millionsend::Request.new(method: :post, path: "/contacts/batch/remove", body: params).perform
+        end
       end
     end
 

data/lib/millionsend/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Millionsend
-  VERSION = "0.5.0"
+  VERSION = "0.6.0"
 end

data/lib/millionsend/webhooks.rb

@@ -10,7 +10,8 @@ module Millionsend
         Millionsend::Request.new(method: :post, path: "/webhooks", body: params).perform
       end
 
-      # GET /webhooks/:id — includes signing_secret.
+      # GET /webhooks/:id — includes signing_secret and
+      # previous_secret_expires_at (nil unless a rotation's overlap window is open).
       def get(id)
         Millionsend::Request.new(method: :get, path: member_path(id)).perform
       end
@@ -30,6 +31,14 @@ module Millionsend
         Millionsend::Request.new(method: :delete, path: member_path(id)).perform
       end
 
+      # POST /webhooks/:id/rotate — signing_secret (optional whsec_ value to
+      # bring your own; omitted mints one) and overlap_hours (0..72, default
+      # 24) during which deliveries carry both signatures. Returns { object:,
+      # id:, signing_secret:, previous_secret_expires_at: }.
+      def rotate(id, params = {})
+        Millionsend::Request.new(method: :post, path: "#{member_path(id)}/rotate", body: params).perform
+      end
+
       private
 
       def member_path(id)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: millionsend
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - MillionSend