pylon-api 1.1.1 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4f54f7ed75e823866e06256d1a598bb3158e686131156932b7aad3d9a90da9c7
-  data.tar.gz: fe68e2c1be8128acadd4179b2baa2751fd9223fdbe1a5c66cb35d2d41c13fae0
+  metadata.gz: ae2b3657a71f50dfe1fbe13af8222fd19fb8026356543cae2b9372bb12bee3fa
+  data.tar.gz: 5232f1d4a792a6d06bf847ce5170bd4272166b7c47700f50929f676319dd0b88
 SHA512:
-  metadata.gz: 6282c28251d01ed1f7c196fbb421c3e895d37681da8e71e5941ed74db3ff88aff39e8e9c8604fe899d555e61aec5bc7b8824fcdf30e6e789c3b74086d25ae7ee
-  data.tar.gz: bf00a26818a96154c91a2a1f281d219372f0fd97b8b0075ddbb70fcebaa675c28b31e55a10bf218303fcc4e2b0ad15229a30950e2f2a5e41cd174995940c0a2a
+  metadata.gz: 1d87c185ffa7b4657a9daaa49e87aa1e03b17913c2c65601270f076165902b1689b7c1e02a0142bfb26a10c751507987547fc49658848104e965861d454ba5fc
+  data.tar.gz: 0fc12093a40563fbb376d6cd84dcf90dfdcd3e359702ab1f99cf750c1b458436a8ccd806d4d9089d42afaadeffeec1a36b25a3faaae290f4f32ee92145fc567e

data/CHANGELOG.md

@@ -1,5 +1,15 @@
 # Changelog
 
+## [1.2.0] - 2026-09-20
+
+### Added
+- `list_email_suppressions` for `GET /email-suppressions` with optional `email`, `cursor`, and `limit` query parameters. Pass `email` to check a single address; an empty collection means it is not suppressed.
+- `delete_email_suppression` for `DELETE /email-suppressions/{id}`
+- `Pylon::Models::EmailSuppression` model (`id`, `email`, `reason`, `created_at`, `bounce_details`)
+
+### Changed
+- Documentation only: README examples now use `body_html` when creating issues and note the 365-day window for `list_issues`. No existing method signatures, paths, or return types changed.
+
 ## [1.1.1] - 2025-04-18
 
 ### Fixed

data/README.md

@@ -55,25 +55,35 @@ account, response = client.get_account('account_id')
 #### Issues
 
 ```ruby
-# List issues (requires time range, max 30 days)
+# List issues (requires time range, max 365 days)
 start_time = Time.now.utc - 86400 # 24 hours ago
 end_time = Time.now.utc
 
-issues, response = client.list_issues(
+issues = client.list_issues(
   start_time: start_time.strftime("%Y-%m-%dT%H:%M:%SZ"),
   end_time: end_time.strftime("%Y-%m-%dT%H:%M:%SZ"),
   page: 1,
-  per_page: 20,
-  status: 'open' # optional filter
+  per_page: 20
 )
 
-# Create an issue
-issue, response = client.create_issue(
+# Create an issue (title and body_html are required by the API)
+issue = client.create_issue(
   title: 'New Issue',
-  description: 'Issue description'
+  body_html: '<p>Issue description</p>',
+  requester_email: 'customer@example.com'
 )
 ```
 
+#### Email Suppressions
+
+```ruby
+# Check whether a single address is suppressed (empty collection means not suppressed)
+suppressions = client.list_email_suppressions(email: 'user@example.com')
+
+# Remove a suppression
+client.delete_email_suppression(suppressions.first.id) unless suppressions.size.zero?
+```
+
 #### Teams
 
 ```ruby

data/lib/pylon/client.rb

@@ -152,7 +152,30 @@ module Pylon
       post("/custom_fields", body: params)
     end
 
-    # Lists issues within a specified time range (max 30 days)
+    # List email suppressions, most recently suppressed first
+    #
+    # Pass +email+ to check a single address. An empty collection means the
+    # address is not suppressed. Uses the API's cursor-based pagination.
+    #
+    # @param email [String, nil] Only return the suppression for this address, if one exists
+    # @param cursor [String, nil] Cursor for the next page of results
+    # @param limit [Integer, nil] Number of suppressions to fetch (API default 100, max 1000)
+    # @return [Models::Collection<Models::EmailSuppression>] Collection of email suppression objects
+    def list_email_suppressions(email: nil, cursor: nil, limit: nil)
+      query = { email: email, cursor: cursor, limit: limit }.compact
+      get("/email-suppressions", query: query,
+          model_class: Models::EmailSuppression, collection: true)
+    end
+
+    # Remove an email suppression so Pylon resumes sending to the address
+    #
+    # @param suppression_id [String] The ID of the email suppression to remove
+    # @return [Array(Hash, Faraday::Response)] Response data and raw response
+    def delete_email_suppression(suppression_id)
+      delete("/email-suppressions/#{suppression_id}")
+    end
+
+    # Lists issues within a specified time range (max 365 days)
     #
     # @param start_time [String] Start time in RFC3339 format
     # @param end_time [String] End time in RFC3339 format

data/lib/pylon/models/email_suppression.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Pylon
+  module Models
+    # An email address Pylon will not send to, either because a message
+    # hard bounced or because someone suppressed it manually.
+    #
+    # Attributes: id, email, reason ("hard_bounce" or "manual"),
+    # created_at (RFC3339), bounce_details
+    class EmailSuppression < Base
+    end
+  end
+end

data/lib/pylon/version.rb

@@ -4,9 +4,9 @@ module Pylon
   # Major version for breaking changes
   MAJOR = 1
   # Minor version for new features
-  MINOR = 1
+  MINOR = 2
   # Patch version for bug fixes
-  PATCH = 1
+  PATCH = 0
   # Pre-release version (optional)
   PRE = nil
 

data/lib/pylon.rb

@@ -17,6 +17,7 @@ require_relative "pylon/models/attachment"
 require_relative "pylon/models/contact"
 require_relative "pylon/models/ticket_form"
 require_relative "pylon/models/article"
+require_relative "pylon/models/email_suppression"
 require_relative "pylon/client"
 
 module Pylon

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pylon-api
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.2.0
 platform: ruby
 authors:
 - Ben Odom
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-04-18 00:00:00.000000000 Z
+date: 2026-09-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -140,6 +140,7 @@ files:
 - lib/pylon/models/base.rb
 - lib/pylon/models/collection.rb
 - lib/pylon/models/contact.rb
+- lib/pylon/models/email_suppression.rb
 - lib/pylon/models/issue.rb
 - lib/pylon/models/tag.rb
 - lib/pylon/models/team.rb