anypost 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 65b858025a9f3fda8fb8a21e6c704503e49eaad8f0fcac5913c4a7808524acb5
-  data.tar.gz: 82615f81815ca2da06ae99b3e3a07c8e76eef059ec229c21a1324d5326f75030
+  metadata.gz: 626219a093ae533c0f15851744e4a6eb92a42e29f793c70ac6b219c64f74f5c2
+  data.tar.gz: 840398e4b95ff4e1bbdb6c1d5b719865304c9f0625f7e6c8f5de5b19cafbf45c
 SHA512:
-  metadata.gz: dd83c2564df58e7dcc5c1819833578cd60040e1d25f0b0a2a8542c06968870b3b6615287dacddf95a7e058337a823e66f4394662a4fd26ba3ef20faf90219c7d
-  data.tar.gz: ce4d157c91e82055a0bd191f6ce3cd6bb8505bd8be8dac779f67e3b592f96855b79c9caf82c8250a93eab85b278e862d36eea2b2d23aca98287d83837f4f2f58
+  metadata.gz: caab7720e980e41910338662984bc706b2d731b01d3ebf4938f3db65c534b2b6f3ddd67efb014439030d71e4092763a05557477f3a6dffd0a0b615652e2219d7
+  data.tar.gz: db2311ea2c576f98d120fb5e5f07c6914b3e4ee0c92a3fe64b94a7e294418a19b95529576070531f7ffb03a7f2393982a1581014ea0bcce34f6120c97da3b84f

data/README.md

@@ -4,6 +4,8 @@ The official Ruby gem for the [Anypost](https://anypost.com) email API.
 
 Requires Ruby 3.2+. Built on [Faraday](https://github.com/lostisland/faraday).
 
+This README covers the SDK itself: installation, idioms, and configuration. For platform concepts and the full field-level API reference, see the [Anypost documentation](https://anypost.com/docs).
+
 ## Install
 
 ```bash
@@ -24,10 +26,10 @@ require "anypost"
 client = Anypost::Client.new("ap_your_api_key")
 
 email = client.email.send(
-  from: "Acme <you@yourdomain.com>",
-  to: ["someone@example.com"],
-  subject: "Hello from Anypost",
-  html: "<p>It worked.</p>"
+  from: "YourCo <you@yourdomain.com>",
+  to: ["you@example.com"],
+  subject: "Welcome to Anypost",
+  html: "<p>Hello, inbox!</p>"
 )
 
 puts email.id
@@ -49,7 +51,7 @@ One of `text`, `html`, or `template_id` is required. All recipients in `to`, `cc
 
 ```ruby
 client.email.send(
-  from: "Acme <you@yourdomain.com>",
+  from: "YourCo <you@yourdomain.com>",
   to: ["a@example.com", "b@example.com"],
   cc: ["team@example.com"],
   reply_to: "support@yourdomain.com",
@@ -60,11 +62,11 @@ client.email.send(
 )
 ```
 
-Attachment `content` is the raw file bytes — pass what `File.binread` returns and the SDK base64-encodes it. Do not pre-encode it. The request body is capped at 5 MB.
+Attachment `content` is the raw file bytes: pass what `File.binread` returns and the SDK base64-encodes it. Do not pre-encode it. The request body is capped at 5 MB.
 
 ```ruby
 client.email.send(
-  from: "you@yourdomain.com",
+  from: "YourCo <you@yourdomain.com>",
   to: ["someone@example.com"],
   subject: "Your report",
   text: "Attached.",
@@ -78,20 +80,22 @@ Send with a published template and per-recipient variables:
 
 ```ruby
 client.email.send(
-  from: "you@yourdomain.com",
+  from: "YourCo <you@yourdomain.com>",
   to: ["someone@example.com"],
   template_id: "template_018f2c5e-3a40-7a91-9c25-3a0b1d5e6f78",
   variables: {name: "Ada", plan: "pro"}
 )
 ```
 
+See the [send reference](https://anypost.com/docs/reference/emails) for the complete field list.
+
 ## Batch
 
 Send 1 to 100 independent messages in one request. `defaults` fills any field an entry omits.
 
 ```ruby
 result = client.email.send_batch(
-  defaults: {from: "you@yourdomain.com"},
+  defaults: {from: "YourCo <you@yourdomain.com>"},
   emails: [
     {to: ["a@example.com"], subject: "Hi A", text: "..."},
     {to: ["b@example.com"], subject: "Hi B", text: "..."}
@@ -115,7 +119,7 @@ end
 
 ## Domains
 
-Manage sending domains under `client.domains`. Add a domain, publish the CNAMEs it returns, then verify.
+Manage sending domains under `client.domains`. Add a domain, publish the DNS records it returns, then verify.
 
 ```ruby
 domain = client.domains.create(name: "example.com")
@@ -123,21 +127,13 @@ domain = client.domains.create(name: "example.com")
 domain.dns_records.each do |record|
   puts "#{record.type} #{record.name} -> #{record.value}"
 end
-```
-
-`verify` always returns the current domain — a still-`pending` domain does not raise. Read `status` and `verification_failure`, and poll while DNS propagates.
 
-```ruby
 checked = client.domains.verify(domain.id)
+# verify returns the current domain even while pending; it does not raise
 puts checked.verification_failure.code unless checked.status == "verified"
 ```
 
-`get`, `update` (tracking config only), and `delete` round out the resource:
-
-```ruby
-client.domains.update(domain.id, tracking: {opens_enabled: true, clicks_enabled: true, subdomain: "track"})
-client.domains.delete(domain.id)
-```
+`get`, `update` (tracking config only), and `delete` round out the resource. See [Domains](https://anypost.com/docs/reference/domains) for the verification lifecycle and field reference.
 
 ## API keys
 
@@ -150,12 +146,9 @@ created = client.api_keys.create(
   allowed_domains: ["example.com"]
 )
 puts created.key # store now; never retrievable again
-
-client.api_keys.update(created.id, name: "Production server", permissions: "full")
-client.api_keys.delete(created.id)
 ```
 
-`get` returns metadata only — `key_prefix`, never the secret. Permission and restriction changes take up to 5 minutes to propagate through the gateway cache.
+`get` returns metadata only (`key_prefix`, never the secret); `update` and `delete` round out the resource. See [API keys](https://anypost.com/docs/reference/api-keys) for the permission model and cache propagation.
 
 ## Templates
 
@@ -168,30 +161,22 @@ template = client.templates.create(
   html: "<h1>Welcome, {{ name }}</h1>"
 )
 
-client.templates.update_draft(template.id, subject: "Welcome to Acme", html: "<h1>Welcome, {{ name }}</h1>")
 client.templates.publish(template.id)
 ```
 
-`kind` is `html` or `markdown` and is immutable once set. The plain-text body is always derived server-side. `get_draft`, `delete_draft`, `duplicate`, `get`, `update` (name only), and `delete` round out the resource. Send with a published template via `template_id` (see [Sending](#sending)).
+`kind` (`html` or `markdown`) is immutable once set; the plain-text body is always derived server-side. `get_draft`, `update_draft`, `delete_draft`, `duplicate`, `get`, `update` (name only), and `delete` round out the resource. Send a published template with `template_id` (see [Sending](#sending)). See [Templates](https://anypost.com/docs/reference/templates) for the full model.
 
 ## Suppressions
 
-A suppression blocks sends to an address, scoped to a `topic`. The wildcard `*` blocks every topic; a specific topic (e.g. `marketing`) leaves transactional traffic untouched. Bounces and complaints write `*` automatically.
+A suppression blocks sends to an address, scoped to a `topic`. The wildcard `*` blocks every topic; a named topic (e.g. `marketing`) leaves transactional traffic untouched.
 
 ```ruby
 client.suppressions.create(email: "alice@example.com", topic: "marketing", note: "Customer requested removal")
 
-row = client.suppressions.get("alice@example.com", "*")
 client.suppressions.delete("alice@example.com", "marketing")
 ```
 
-`list` accepts `email_contains`, `topic`, `reason`, and `origin` filters. `list_for_email` returns every row for an address across all topics; `delete_for_email` removes them all.
-
-```ruby
-client.suppressions.list(reason: "complaint").each do |s|
-  puts "#{s.email} #{s.topic} #{s.suppressed_at}"
-end
-```
+`get`, `list` (with `email_contains`, `topic`, `reason`, and `origin` filters), `list_for_email`, and `delete_for_email` round out the resource. See [Suppressions](https://anypost.com/docs/reference/suppressions) for scoping and the automatic-suppression rules for bounces and complaints.
 
 ## Webhooks
 
@@ -206,18 +191,11 @@ webhook = client.webhooks.create(
 puts webhook.signing_secret # store now; never retrievable again
 ```
 
-`update` sets the name, URL, events, and `status` together — set `status` to `"disabled"` to pause delivery, `"active"` to resume. `test` sends one synthetic `webhook.test` event and returns the outcome even when the endpoint fails. `rotate_secret` issues a new secret and keeps the previous one valid for a 24-hour grace window; `get`, `list`, and `delete` round out the resource.
-
-```ruby
-result = client.webhooks.test(webhook.id)
-puts "#{result.status_code} #{result.error}" unless result.delivered
-
-rotated = client.webhooks.rotate_secret(webhook.id)
-```
+`update`, `test`, `rotate_secret`, `get`, `list`, and `delete` round out the resource. See [Webhooks](https://anypost.com/docs/reference/webhooks) for the event catalog, status transitions, and the secret-rotation grace window.
 
 ### Verifying deliveries
 
-`Anypost::WebhookSignature.verify` is a module method — it needs the signing secret, not an API key, so call it in your handler without a client. Pass the **raw** request body (the exact bytes, before JSON parsing), the `Anypost-Signature` header, and the secret. It returns on success and raises `Anypost::WebhookVerificationError` otherwise. `Anypost::WebhookSignature.unwrap` does the same and returns the parsed delivery as a `Response`.
+`Anypost::WebhookSignature.verify` is a module method. It needs the signing secret, not an API key, so call it in your handler without a client. Pass the **raw** request body (the exact bytes, before JSON parsing), the `Anypost-Signature` header, and the secret. It returns on success and raises `Anypost::WebhookVerificationError` otherwise. `Anypost::WebhookSignature.unwrap` does the same and returns the parsed delivery as a `Response`.
 
 ```ruby
 begin
@@ -231,7 +209,7 @@ rescue Anypost::WebhookVerificationError => e
 end
 ```
 
-Reach for `verify` when something else has already parsed the body. Keep the raw bytes for the verify step, then use your parsed object once it passes — a Rack-style handler:
+Reach for `verify` when something else has already parsed the body. Keep the raw bytes for the verify step, then use your parsed object once it passes (a Rack-style handler):
 
 ```ruby
 post "/anypost" do
@@ -247,11 +225,11 @@ post "/anypost" do
 end
 ```
 
-Deliveries older than five minutes are rejected by default to bound replay; pass `tolerance_seconds:` to widen, narrow, or disable (`0`) that check. During a secret rotation the header carries a `v1=` component per active secret, and a match on any one passes — so deliveries keep verifying while you redeploy.
+Deliveries older than five minutes are rejected by default to bound replay; pass `tolerance_seconds:` to widen, narrow, or disable (`0`) that check. During a secret rotation the header carries a `v1=` component per active secret, and a match on any one passes, so deliveries keep verifying while you redeploy.
 
 ## Events
 
-`client.events.list` pages the team's event stream, newest-first. The window defaults to the last 24 hours and is clamped to your plan's retention. Events are read-only and not addressable by id — there is no `get`.
+`client.events.list` pages the team's event stream, newest-first. The window defaults to the last 24 hours and is clamped to your plan's retention. Events are read-only and not addressable by id, so there is no `get`.
 
 ```ruby
 client.events.list(event_type: "email.bounced").each do |event|
@@ -259,16 +237,11 @@ client.events.list(event_type: "email.bounced").each do |event|
 end
 ```
 
-Filter by `start`, `end`, `event_type`, `recipient`, `email_id`, `message_id`, `domain`, `topic`, `campaign`, `template_id`, and `tags`. All filters are exact-match, except `tags`, which takes an array and matches an event carrying *any* of the given tags. A filter value that matches no row returns an empty page. This is also how you backfill the gap after a webhook endpoint was disabled — page the events that occurred during the outage once it's healthy.
-
-```ruby
-# Events tagged "onboarding" OR "welcome", that also bounced.
-page = client.events.list(tags: ["onboarding", "welcome"], event_type: "email.bounced")
-```
+Filter by `start`, `end`, `event_type`, `recipient`, `email_id`, `message_id`, `domain`, `topic`, `campaign`, `template_id`, `ip_pool`, and `tags`, an array that matches an event carrying *any* of the given tags. Every other filter is exact-match. This is also how you backfill the gap after a webhook endpoint was disabled: page the events that occurred during the outage once it's healthy. See [Events](https://anypost.com/docs/reference/events) for the field reference.
 
 ## Pagination
 
-List endpoints return a `Page`. Read one page directly, or iterate it to walk every page — the client fetches each one as needed.
+List endpoints return a `Page`. Read one page directly, or iterate it to walk every page; the client fetches each one as needed.
 
 ```ruby
 page = client.domains.list(limit: 50)

data/lib/anypost/resources/events.rb

@@ -9,7 +9,7 @@ module Anypost
       # The window defaults to the last 24 hours and is clamped to the plan's
       # retention. Filter with `start`, `end`, `event_type`, `recipient`,
       # `email_id`, `message_id`, `domain`, `topic`, `campaign`, `template_id`,
-      # and `tags` (an array, matched with hasAny).
+      # `ip_pool`, and `tags` (an array, matched with hasAny).
       def list(params = {})
         tags = params[:tags]
         paginate("/events", {
@@ -25,6 +25,10 @@ module Anypost
           topic: params[:topic],
           campaign: params[:campaign],
           template_id: params[:template_id],
+          # Exact match against the [a-z0-9]([a-z0-9-]*[a-z0-9])? pool-name
+          # shape. A value outside it returns an empty list rather than being
+          # ignored, so a typo cannot silently widen the answer to "all pools".
+          ip_pool: params[:ip_pool],
           # Sent comma-separated (tags=a,b); the API matches with hasAny.
           tags: (tags.is_a?(Array) && !tags.empty?) ? tags.join(",") : nil
         })

data/lib/anypost/version.rb

@@ -3,5 +3,5 @@
 module Anypost
   # The single source of truth for the gem version. Bump this, tag the commit
   # `vX.Y.Z`, and push — the release workflow builds and pushes to RubyGems.
-  VERSION = "1.0.0"
+  VERSION = "1.1.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: anypost
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Anypost
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-06-09 00:00:00.000000000 Z
+date: 2026-07-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday