pylon-api 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6d98b4389f4182e2f3d62261c2a60d9f4a325c18a5376c09668cc17e1594219c
-  data.tar.gz: ea1c690a74e4e8d2890098211d58909ae551af8deecaf757d3463e5de37f3cdc
+  metadata.gz: ae2b3657a71f50dfe1fbe13af8222fd19fb8026356543cae2b9372bb12bee3fa
+  data.tar.gz: 5232f1d4a792a6d06bf847ce5170bd4272166b7c47700f50929f676319dd0b88
 SHA512:
-  metadata.gz: b3a1dcd703454b3efc5818292f01a00366a50ddfa5f06d6dbbdbfc865907b907b05ea35d0ca591e0eb93d5ffbec26e4ad90b85e47379aa029f61346b766e81f1
-  data.tar.gz: aa703a9d4f20da2243ce49b31627548afd719835a3a591fab2ffafd5480ab84cbce02b3c88a54b25979a8138641b584c9e32054ae673f548ca4936daa2531e53
+  metadata.gz: 1d87c185ffa7b4657a9daaa49e87aa1e03b17913c2c65601270f076165902b1689b7c1e02a0142bfb26a10c751507987547fc49658848104e965861d454ba5fc
+  data.tar.gz: 0fc12093a40563fbb376d6cd84dcf90dfdcd3e359702ab1f99cf750c1b458436a8ccd806d4d9089d42afaadeffeec1a36b25a3faaae290f4f32ee92145fc567e

data/CHANGELOG.md

@@ -1,5 +1,27 @@
 # 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
+- Fixed URL-based file attachments by ensuring they use proper multipart form encoding
+
+## [1.1.0] - 2025-04-17
+
+### Added
+- Support for URL-based file attachments
+- Enhanced attachment handling for various file types
+- Added MIME type detection for file uploads
+
 ## [1.0.0] - 2024-03-21
 
 ### Changed

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

@@ -7,7 +7,22 @@ module Pylon
   #   client = Pylon::Client.new(api_key: 'your_api_key')
   #   issues = client.list_issues(start_time: '2024-03-01T00:00:00Z', end_time: '2024-03-31T23:59:59Z')
   #   issues.each { |issue| puts issue.title }
+  # rubocop:disable Metrics/ClassLength
   class Client
+    # Common MIME types for file uploads
+    MIME_TYPES = {
+      ".jpg" => "image/jpeg",
+      ".jpeg" => "image/jpeg",
+      ".png" => "image/png",
+      ".gif" => "image/gif",
+      ".pdf" => "application/pdf",
+      ".doc" => "application/msword",
+      ".docx" => "application/vnd.openxmlformats-officedocument.wordprocessingml.document",
+      ".xls" => "application/vnd.ms-excel",
+      ".xlsx" => "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet",
+      ".csv" => "text/csv",
+      ".txt" => "text/plain"
+    }
     # Base URL for the Pylon API
     BASE_URL = "https://api.usepylon.com"
 
@@ -45,10 +60,36 @@ module Pylon
 
     # Create a new attachment
     #
-    # @param file [String] The file content to upload
+    # @param file [File, String, nil] The file to upload (File object or file content)
+    # @param description [String, nil] A text description of the file
+    # @param file_url [String, nil] A URL to fetch the file from if file is not provided
     # @return [Models::Attachment] Created attachment object
-    def create_attachment(file)
-      post("/attachments", body: { file: file }, model_class: Models::Attachment)
+    # @raise [ArgumentError] If neither file nor file_url is provided
+    def create_attachment(file = nil, description: nil, file_url: nil)
+      if file.nil? && file_url.nil?
+        raise ArgumentError, "Either file or file_url must be provided"
+      end
+
+      params = {}
+      params[:description] = description if description
+      params[:file_url] = file_url if file_url
+
+      if file
+        if file.is_a?(::File) || (file.respond_to?(:path) && file.respond_to?(:read))
+          # For File objects or IO-like objects
+          params[:file] = Faraday::UploadIO.new(file, mime_type_for_file(file), File.basename(file.path))
+        else
+          # For raw content as string, create a temp file
+          temp_file = Tempfile.new(["upload", ".bin"])
+          temp_file.binmode
+          temp_file.write(file)
+          temp_file.rewind
+          params[:file] = Faraday::UploadIO.new(temp_file, "application/octet-stream")
+        end
+      end
+      
+      # Always use multipart for attachments, whether file or file_url
+      post_multipart("/attachments", params, model_class: Models::Attachment)
     end
 
     # Get details for a specific attachment
@@ -111,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
@@ -324,6 +388,17 @@ module Pylon
       end
     end
 
+    # Determine MIME type for file
+    #
+    # @param file [File] The file to determine MIME type for
+    # @return [String] The MIME type
+    def mime_type_for_file(file)
+      return "application/octet-stream" unless file.respond_to?(:path)
+
+      ext = File.extname(file.path).downcase
+      MIME_TYPES[ext] || "application/octet-stream"
+    end
+
     # Handle API response and raise appropriate errors
     #
     # @param response [Faraday::Response] The API response
@@ -427,6 +502,34 @@ module Pylon
       handle_response(connection.post(path, body.to_json), model_class, collection)
     end
 
+    # Make a multipart POST request for file uploads
+    #
+    # @param path [String] The API endpoint path
+    # @param params [Hash] Request parameters including file uploads
+    # @param model_class [Class] The model class to use for wrapping the response
+    # @param collection [Boolean] Whether the response is a collection of items
+    # @return [Models::Base, Models::Collection, Array] Model, Collection, or response data array
+    def post_multipart(path, params = {}, model_class: nil, collection: false)
+      # Create a connection without the default JSON content type for multipart uploads
+      multipart_conn = Faraday.new(@base_url) do |f|
+        f.request :multipart
+        # Only force multipart for file_url uploads, omit url_encoded middleware
+        f.response :json, content_type: /\bjson$/
+        f.response :logger if @debug
+        f.adapter Faraday.default_adapter
+        f.headers["Authorization"] = "Bearer #{api_key}"
+        f.headers["Accept"] = "application/json"
+      end
+      
+      # If we have a file_url but no actual file, create a dummy file part to force multipart encoding
+      if params[:file_url] && !params[:file]
+        # Create an empty file part to force multipart encoding
+        params[:_dummy] = Faraday::FilePart.new(StringIO.new(""), "application/octet-stream", "dummy")
+      end
+
+      handle_response(multipart_conn.post(path, params), model_class, collection)
+    end
+
     # Make a PATCH request
     #
     # @param path [String] The API endpoint path

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,7 +4,7 @@ module Pylon
   # Major version for breaking changes
   MAJOR = 1
   # Minor version for new features
-  MINOR = 1
+  MINOR = 2
   # Patch version for bug fixes
   PATCH = 0
   # Pre-release version (optional)

data/lib/pylon.rb

@@ -3,6 +3,7 @@
 require "faraday"
 require "faraday/multipart"
 require "json"
+require "tempfile"
 
 require_relative "pylon/version"
 require_relative "pylon/models/base"
@@ -16,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.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Ben Odom
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-04-17 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