trycourier 4.6.2 → 4.6.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 82a9cb0004cc6bd52214be2bc92b97153f53d977b937772918c91660b54f1d5f
-  data.tar.gz: 940f7dc194b43cbdfc9dfb2158fb60b70d8c564d46fc58f1612c690290e1d5fa
+  metadata.gz: 5b3c3af37c6f737d91d83290e647983613019baa618752d7c8a1d36c49093a04
+  data.tar.gz: 1d04dfb232d575a256224d0108f62ad205aad4e4084fe6ee1733957a65454d5c
 SHA512:
-  metadata.gz: f330eb40986182ede83b0db8aeaef64b9110b3ccb404f6f74199c6232f5a34967b0fbbc03d547799cc3889d97c8b704c17d422cfb89a9ee914073574c6f81320
-  data.tar.gz: b19a2b928aa6801882e2d7d4a26e3c0369d9824296fe170385308941fb712a35eeb11d022d880e7a45f05aa534d763711096a7bb13d4c16568d5d601c4781dd2
+  metadata.gz: becec6815cd9d64e0660caf083842eeb46c9dd07ab003e2115e5e4ec59a25a2f979e3a7180cfef702752ec3dfc5e0884c31d6feed875c0af580ebaca84fed2be
+  data.tar.gz: fd88eb8e5c564358b5caeeffb192280deaa7453fe52482f212df863aa06549f04fb1c94fc26d07b6deefa9bdf29fbfd3816e82819b71acfec2e808950dbf79b5

data/CHANGELOG.md

@@ -1,5 +1,18 @@
 # Changelog
 
+## 4.6.3 (2026-01-27)
+
+Full Changelog: [v4.6.2...v4.6.3](https://github.com/trycourier/courier-ruby/compare/v4.6.2...v4.6.3)
+
+### Chores
+
+* **internal:** update `actions/checkout` version ([58351ff](https://github.com/trycourier/courier-ruby/commit/58351ffafedee9170ccedf73d79c2c87fe84ca7b))
+
+
+### Documentation
+
+* **types:** update version field description in AutomationTemplate ([df81741](https://github.com/trycourier/courier-ruby/commit/df8174149d84e67dd15ca2e54b45ac3e4682039a))
+
 ## 4.6.2 (2026-01-14)
 
 Full Changelog: [v4.6.1...v4.6.2](https://github.com/trycourier/courier-ruby/compare/v4.6.1...v4.6.2)

data/README.md

@@ -17,7 +17,7 @@ To use this gem, install via Bundler by adding the following to your application
 <!-- x-release-please-start-version -->
 
 ```ruby
-gem "trycourier", "~> 4.6.2"
+gem "trycourier", "~> 4.6.3"
 ```
 
 <!-- x-release-please-end -->
@@ -26,9 +26,9 @@ gem "trycourier", "~> 4.6.2"
 
 ```ruby
 require "bundler/setup"
-require "trycourier"
+require "courier"
 
-courier = Trycourier::Client.new(
+courier = Courier::Client.new(
   api_key: ENV["COURIER_API_KEY"] # This is the default and can be omitted
 )
 
@@ -41,19 +41,19 @@ puts(response.requestId)
 
 ### Handling errors
 
-When the library is unable to connect to the API, or if the API returns a non-success status code (i.e., 4xx or 5xx response), a subclass of `Trycourier::Errors::APIError` will be thrown:
+When the library is unable to connect to the API, or if the API returns a non-success status code (i.e., 4xx or 5xx response), a subclass of `Courier::Errors::APIError` will be thrown:
 
 ```ruby
 begin
   send_ = courier.send_.message(
     message: {to: {user_id: "your_user_id"}, template: "your_template_id", data: {foo: "bar"}}
   )
-rescue Trycourier::Errors::APIConnectionError => e
+rescue Courier::Errors::APIConnectionError => e
   puts("The server could not be reached")
   puts(e.cause)  # an underlying Exception, likely raised within `net/http`
-rescue Trycourier::Errors::RateLimitError => e
+rescue Courier::Errors::RateLimitError => e
   puts("A 429 status code was received; we should back off a bit.")
-rescue Trycourier::Errors::APIStatusError => e
+rescue Courier::Errors::APIStatusError => e
   puts("Another non-200-range status code was received")
   puts(e.status)
 end
@@ -85,7 +85,7 @@ You can use the `max_retries` option to configure or disable this:
 
 ```ruby
 # Configure the default for all requests:
-courier = Trycourier::Client.new(
+courier = Courier::Client.new(
   max_retries: 0 # default is 2
 )
 
@@ -102,7 +102,7 @@ By default, requests will time out after 60 seconds. You can use the timeout opt
 
 ```ruby
 # Configure the default for all requests:
-courier = Trycourier::Client.new(
+courier = Courier::Client.new(
   timeout: nil # default is 60
 )
 
@@ -113,7 +113,7 @@ courier.send_.message(
 )
 ```
 
-On timeout, `Trycourier::Errors::APITimeoutError` is raised.
+On timeout, `Courier::Errors::APITimeoutError` is raised.
 
 Note that requests that time out are retried by default.
 
@@ -121,7 +121,7 @@ Note that requests that time out are retried by default.
 
 ### BaseModel
 
-All parameter and response objects inherit from `Trycourier::Internal::Type::BaseModel`, which provides several conveniences, including:
+All parameter and response objects inherit from `Courier::Internal::Type::BaseModel`, which provides several conveniences, including:
 
 1. All fields, including unknown ones, are accessible with `obj[:prop]` syntax, and can be destructured with `obj => {prop: prop}` or pattern-matching syntax.
 
@@ -173,9 +173,9 @@ response = client.request(
 
 ### Concurrency & connection pooling
 
-The `Trycourier::Client` instances are threadsafe, but are only are fork-safe when there are no in-flight HTTP requests.
+The `Courier::Client` instances are threadsafe, but are only are fork-safe when there are no in-flight HTTP requests.
 
-Each instance of `Trycourier::Client` has its own HTTP connection pool with a default size of 99. As such, we recommend instantiating the client once per application in most settings.
+Each instance of `Courier::Client` has its own HTTP connection pool with a default size of 99. As such, we recommend instantiating the client once per application in most settings.
 
 When all available connections from the pool are checked out, requests wait for a new connection to become available, with queue time counting towards the request timeout.
 
@@ -189,8 +189,8 @@ You can provide typesafe request parameters like so:
 
 ```ruby
 courier.send_.message(
-  message: Trycourier::SendMessageParams::Message.new(
-    to: Trycourier::UserRecipient.new(user_id: "your_user_id"),
+  message: Courier::SendMessageParams::Message.new(
+    to: Courier::UserRecipient.new(user_id: "your_user_id"),
     template: "your_template_id",
     data: {foo: "bar"}
   )
@@ -206,9 +206,9 @@ courier.send_.message(
 )
 
 # You can also splat a full Params class:
-params = Trycourier::SendMessageParams.new(
-  message: Trycourier::SendMessageParams::Message.new(
-    to: Trycourier::UserRecipient.new(user_id: "your_user_id"),
+params = Courier::SendMessageParams.new(
+  message: Courier::SendMessageParams::Message.new(
+    to: Courier::UserRecipient.new(user_id: "your_user_id"),
     template: "your_template_id",
     data: {foo: "bar"}
   )
@@ -222,10 +222,10 @@ Since this library does not depend on `sorbet-runtime`, it cannot provide [`T::E
 
 ```ruby
 # :AND
-puts(Trycourier::AudienceUpdateParams::Operator::AND)
+puts(Courier::AudienceUpdateParams::Operator::AND)
 
-# Revealed type: `T.all(Trycourier::AudienceUpdateParams::Operator, Symbol)`
-T.reveal_type(Trycourier::AudienceUpdateParams::Operator::AND)
+# Revealed type: `T.all(Courier::AudienceUpdateParams::Operator, Symbol)`
+T.reveal_type(Courier::AudienceUpdateParams::Operator::AND)
 ```
 
 Enum parameters have a "relaxed" type, so you can either pass in enum constants or their literal value:
@@ -233,7 +233,7 @@ Enum parameters have a "relaxed" type, so you can either pass in enum constants
 ```ruby
 # Using the enum constants preserves the tagged type information:
 courier.audiences.update(
-  operator: Trycourier::AudienceUpdateParams::Operator::AND,
+  operator: Courier::AudienceUpdateParams::Operator::AND,
   # …
 )
 

data/lib/courier/client.rb

@@ -0,0 +1,134 @@
+# frozen_string_literal: true
+
+module Courier
+  class Client < Courier::Internal::Transport::BaseClient
+    # Default max number of retries to attempt after a failed retryable request.
+    DEFAULT_MAX_RETRIES = 2
+
+    # Default per-request timeout.
+    DEFAULT_TIMEOUT_IN_SECONDS = 60.0
+
+    # Default initial retry delay in seconds.
+    # Overall delay is calculated using exponential backoff + jitter.
+    DEFAULT_INITIAL_RETRY_DELAY = 0.5
+
+    # Default max retry delay in seconds.
+    DEFAULT_MAX_RETRY_DELAY = 8.0
+
+    # @return [String]
+    attr_reader :api_key
+
+    # @return [Courier::Resources::Send]
+    attr_reader :send_
+
+    # @return [Courier::Resources::Audiences]
+    attr_reader :audiences
+
+    # @return [Courier::Resources::AuditEvents]
+    attr_reader :audit_events
+
+    # @return [Courier::Resources::Auth]
+    attr_reader :auth
+
+    # @return [Courier::Resources::Automations]
+    attr_reader :automations
+
+    # @return [Courier::Resources::Brands]
+    attr_reader :brands
+
+    # @return [Courier::Resources::Bulk]
+    attr_reader :bulk
+
+    # @return [Courier::Resources::Inbound]
+    attr_reader :inbound
+
+    # @return [Courier::Resources::Lists]
+    attr_reader :lists
+
+    # @return [Courier::Resources::Messages]
+    attr_reader :messages
+
+    # @return [Courier::Resources::Requests]
+    attr_reader :requests
+
+    # @return [Courier::Resources::Notifications]
+    attr_reader :notifications
+
+    # @return [Courier::Resources::Profiles]
+    attr_reader :profiles
+
+    # @return [Courier::Resources::Tenants]
+    attr_reader :tenants
+
+    # @return [Courier::Resources::Translations]
+    attr_reader :translations
+
+    # @return [Courier::Resources::Users]
+    attr_reader :users
+
+    # @api private
+    #
+    # @return [Hash{String=>String}]
+    private def auth_headers
+      return {} if @api_key.nil?
+
+      {"authorization" => "Bearer #{@api_key}"}
+    end
+
+    # Creates and returns a new client for interacting with the API.
+    #
+    # @param api_key [String, nil] Defaults to `ENV["COURIER_API_KEY"]`
+    #
+    # @param base_url [String, nil] Override the default base URL for the API, e.g.,
+    # `"https://api.example.com/v2/"`. Defaults to `ENV["COURIER_BASE_URL"]`
+    #
+    # @param max_retries [Integer] Max number of retries to attempt after a failed retryable request.
+    #
+    # @param timeout [Float]
+    #
+    # @param initial_retry_delay [Float]
+    #
+    # @param max_retry_delay [Float]
+    def initialize(
+      api_key: ENV["COURIER_API_KEY"],
+      base_url: ENV["COURIER_BASE_URL"],
+      max_retries: self.class::DEFAULT_MAX_RETRIES,
+      timeout: self.class::DEFAULT_TIMEOUT_IN_SECONDS,
+      initial_retry_delay: self.class::DEFAULT_INITIAL_RETRY_DELAY,
+      max_retry_delay: self.class::DEFAULT_MAX_RETRY_DELAY
+    )
+      base_url ||= "https://api.courier.com"
+
+      if api_key.nil?
+        raise ArgumentError.new("api_key is required, and can be set via environ: \"COURIER_API_KEY\"")
+      end
+
+      @api_key = api_key.to_s
+
+      super(
+        base_url: base_url,
+        timeout: timeout,
+        max_retries: max_retries,
+        initial_retry_delay: initial_retry_delay,
+        max_retry_delay: max_retry_delay
+      )
+
+      @send_ = Courier::Resources::Send.new(client: self)
+      @audiences = Courier::Resources::Audiences.new(client: self)
+      @audit_events = Courier::Resources::AuditEvents.new(client: self)
+      @auth = Courier::Resources::Auth.new(client: self)
+      @automations = Courier::Resources::Automations.new(client: self)
+      @brands = Courier::Resources::Brands.new(client: self)
+      @bulk = Courier::Resources::Bulk.new(client: self)
+      @inbound = Courier::Resources::Inbound.new(client: self)
+      @lists = Courier::Resources::Lists.new(client: self)
+      @messages = Courier::Resources::Messages.new(client: self)
+      @requests = Courier::Resources::Requests.new(client: self)
+      @notifications = Courier::Resources::Notifications.new(client: self)
+      @profiles = Courier::Resources::Profiles.new(client: self)
+      @tenants = Courier::Resources::Tenants.new(client: self)
+      @translations = Courier::Resources::Translations.new(client: self)
+      @users = Courier::Resources::Users.new(client: self)
+    end
+  end
+end

data/lib/courier/errors.rb

@@ -0,0 +1,228 @@
+# frozen_string_literal: true
+
+module Courier
+  module Errors
+    class Error < StandardError
+      # @!attribute cause
+      #
+      #   @return [StandardError, nil]
+    end
+
+    class ConversionError < Courier::Errors::Error
+      # @return [StandardError, nil]
+      def cause = @cause.nil? ? super : @cause
+
+      # @api private
+      #
+      # @param on [Class<StandardError>]
+      # @param method [Symbol]
+      # @param target [Object]
+      # @param value [Object]
+      # @param cause [StandardError, nil]
+      def initialize(on:, method:, target:, value:, cause: nil)
+        cls = on.name.split("::").last
+
+        message = [
+          "Failed to parse #{cls}.#{method} from #{value.class} to #{target.inspect}.",
+          "To get the unparsed API response, use #{cls}[#{method.inspect}].",
+          cause && "Cause: #{cause.message}"
+        ].filter(&:itself).join(" ")
+
+        @cause = cause
+        super(message)
+      end
+    end
+
+    class APIError < Courier::Errors::Error
+      # @return [URI::Generic]
+      attr_accessor :url
+
+      # @return [Integer, nil]
+      attr_accessor :status
+
+      # @return [Hash{String=>String}, nil]
+      attr_accessor :headers
+
+      # @return [Object, nil]
+      attr_accessor :body
+
+      # @api private
+      #
+      # @param url [URI::Generic]
+      # @param status [Integer, nil]
+      # @param headers [Hash{String=>String}, nil]
+      # @param body [Object, nil]
+      # @param request [nil]
+      # @param response [nil]
+      # @param message [String, nil]
+      def initialize(url:, status: nil, headers: nil, body: nil, request: nil, response: nil, message: nil)
+        @url = url
+        @status = status
+        @headers = headers
+        @body = body
+        @request = request
+        @response = response
+        super(message)
+      end
+    end
+
+    class APIConnectionError < Courier::Errors::APIError
+      # @!attribute status
+      #
+      #   @return [nil]
+
+      # @!attribute body
+      #
+      #   @return [nil]
+
+      # @api private
+      #
+      # @param url [URI::Generic]
+      # @param status [nil]
+      # @param headers [Hash{String=>String}, nil]
+      # @param body [nil]
+      # @param request [nil]
+      # @param response [nil]
+      # @param message [String, nil]
+      def initialize(
+        url:,
+        status: nil,
+        headers: nil,
+        body: nil,
+        request: nil,
+        response: nil,
+        message: "Connection error."
+      )
+        super
+      end
+    end
+
+    class APITimeoutError < Courier::Errors::APIConnectionError
+      # @api private
+      #
+      # @param url [URI::Generic]
+      # @param status [nil]
+      # @param headers [Hash{String=>String}, nil]
+      # @param body [nil]
+      # @param request [nil]
+      # @param response [nil]
+      # @param message [String, nil]
+      def initialize(
+        url:,
+        status: nil,
+        headers: nil,
+        body: nil,
+        request: nil,
+        response: nil,
+        message: "Request timed out."
+      )
+        super
+      end
+    end
+
+    class APIStatusError < Courier::Errors::APIError
+      # @api private
+      #
+      # @param url [URI::Generic]
+      # @param status [Integer]
+      # @param headers [Hash{String=>String}, nil]
+      # @param body [Object, nil]
+      # @param request [nil]
+      # @param response [nil]
+      # @param message [String, nil]
+      #
+      # @return [self]
+      def self.for(url:, status:, headers:, body:, request:, response:, message: nil)
+        kwargs =
+          {
+            url: url,
+            status: status,
+            headers: headers,
+            body: body,
+            request: request,
+            response: response,
+            message: message
+          }
+
+        case status
+        in 400
+          Courier::Errors::BadRequestError.new(**kwargs)
+        in 401
+          Courier::Errors::AuthenticationError.new(**kwargs)
+        in 403
+          Courier::Errors::PermissionDeniedError.new(**kwargs)
+        in 404
+          Courier::Errors::NotFoundError.new(**kwargs)
+        in 409
+          Courier::Errors::ConflictError.new(**kwargs)
+        in 422
+          Courier::Errors::UnprocessableEntityError.new(**kwargs)
+        in 429
+          Courier::Errors::RateLimitError.new(**kwargs)
+        in (500..)
+          Courier::Errors::InternalServerError.new(**kwargs)
+        else
+          Courier::Errors::APIStatusError.new(**kwargs)
+        end
+      end
+
+      # @!parse
+      #   # @return [Integer]
+      #   attr_accessor :status
+
+      # @api private
+      #
+      # @param url [URI::Generic]
+      # @param status [Integer]
+      # @param headers [Hash{String=>String}, nil]
+      # @param body [Object, nil]
+      # @param request [nil]
+      # @param response [nil]
+      # @param message [String, nil]
+      def initialize(url:, status:, headers:, body:, request:, response:, message: nil)
+        message ||= {url: url.to_s, status: status, body: body}
+        super(
+          url: url,
+          status: status,
+          headers: headers,
+          body: body,
+          request: request,
+          response: response,
+          message: message&.to_s
+        )
+      end
+    end
+
+    class BadRequestError < Courier::Errors::APIStatusError
+      HTTP_STATUS = 400
+    end
+
+    class AuthenticationError < Courier::Errors::APIStatusError
+      HTTP_STATUS = 401
+    end
+
+    class PermissionDeniedError < Courier::Errors::APIStatusError
+      HTTP_STATUS = 403
+    end
+
+    class NotFoundError < Courier::Errors::APIStatusError
+      HTTP_STATUS = 404
+    end
+
+    class ConflictError < Courier::Errors::APIStatusError
+      HTTP_STATUS = 409
+    end
+
+    class UnprocessableEntityError < Courier::Errors::APIStatusError
+      HTTP_STATUS = 422
+    end
+
+    class RateLimitError < Courier::Errors::APIStatusError
+      HTTP_STATUS = 429
+    end
+
+    class InternalServerError < Courier::Errors::APIStatusError
+      HTTP_STATUS = (500..)
+    end
+  end
+end

data/lib/courier/file_part.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+module Courier
+  class FilePart
+    # @return [Pathname, StringIO, IO, String]
+    attr_reader :content
+
+    # @return [String, nil]
+    attr_reader :content_type
+
+    # @return [String, nil]
+    attr_reader :filename
+
+    # @api private
+    #
+    # @return [String]
+    private def read
+      case content
+      in Pathname
+        content.read(binmode: true)
+      in StringIO
+        content.string
+      in IO
+        content.read
+      in String
+        content
+      end
+    end
+
+    # @param a [Object]
+    #
+    # @return [String]
+    def to_json(*a) = read.to_json(*a)
+
+    # @param a [Object]
+    #
+    # @return [String]
+    def to_yaml(*a) = read.to_yaml(*a)
+
+    # @param content [Pathname, StringIO, IO, String]
+    # @param filename [Pathname, String, nil]
+    # @param content_type [String, nil]
+    def initialize(content, filename: nil, content_type: nil)
+      @content_type = content_type
+      @filename =
+        case [filename, (@content = content)]
+        in [String | Pathname, _]
+          ::File.basename(filename)
+        in [nil, Pathname]
+          content.basename.to_path
+        in [nil, IO]
+          content.to_path
+        else
+          filename
+        end
+    end
+  end
+end