trycourier 4.7.1 → 4.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 60a3e529dea2838c4e1a907cb78d1e593eb5aa2574515b56e3923968b73ee6fb
-  data.tar.gz: b9112b225ef1284261bc91162a93929bca085cb983241ccffceb4ab9527892d1
+  metadata.gz: 3402c91918996a99ee5f6847167c87f49ca1d0a711da6de88c1ab620ea1ca58c
+  data.tar.gz: cc72a6efa7d4c23d88069a482f153da899680bcebc0a418e85361e759441fe52
 SHA512:
-  metadata.gz: 2dbc06288c898543b75c19fe26285f7897a11087cebea941cd71eee7458615d3d156bd4e2bfe33ca4f20aa3825d041e30a9f2a7f6b71a83b9523a57839dfa772
-  data.tar.gz: 5fb3b16785c63052748c36af642ec13bf67c7743264060088953d914bcb799a7deb040c066f5b06ae334a16b45dae28e5bef736ab2760f12af3a34ce9f441381
+  metadata.gz: bea7a9fa2457eca3c876aa38a6bbb492fec8f965b06e4b2e1a8ae3df10454cfe08aa04536546e392a36c03341a54bf7103a8444c6de9dd97c1cdc35abba942f6
+  data.tar.gz: 10913c571258c67c3ce10362794e30d2a742b117cde9f4ddbe02a8eabf7c568be4bb64871169ece92b2fe443a3480471adab6c506ac41b7a172579740827b3a0

data/CHANGELOG.md

@@ -1,5 +1,68 @@
 # Changelog
 
+## 4.9.0 (2026-04-01)
+
+Full Changelog: [v4.8.0...v4.9.0](https://github.com/trycourier/courier-ruby/compare/v4.8.0...v4.9.0)
+
+### Features
+
+* **api:** add html variant to elemental_node union ([a5a5a5d](https://github.com/trycourier/courier-ruby/commit/a5a5a5d025d5ddb27a79872b15efaaa08785b032))
+* **api:** add notification template CRUD methods, update list params/types ([4861f87](https://github.com/trycourier/courier-ruby/commit/4861f87ead15aba7b148dc8d2790fe2d018157c9))
+* **api:** add providers resource with create/retrieve/update/list/delete and catalog ([5191261](https://github.com/trycourier/courier-ruby/commit/519126120e84dea8276094325e49d350eff3f7bc))
+* **api:** add routing_strategies resource with create/retrieve/list/replace/archive ([6c64599](https://github.com/trycourier/courier-ruby/commit/6c645999dd54ac75bdb777745363d662f7d9da64))
+
+
+### Bug Fixes
+
+* align path encoding with RFC 3986 section 3.3 ([916afaa](https://github.com/trycourier/courier-ruby/commit/916afaafd525d4d77a42a0739e892c4d4cf5d933))
+* **internal:** correct multipart form field name encoding ([7925b72](https://github.com/trycourier/courier-ruby/commit/7925b72544622783dd17527da1729f6f48ddb744))
+* variable name typo ([1f59fd2](https://github.com/trycourier/courier-ruby/commit/1f59fd2c73459908b337b98135efbd79bf0bfb9a))
+
+
+### Chores
+
+* **ci:** skip lint on metadata-only changes ([22a3e8d](https://github.com/trycourier/courier-ruby/commit/22a3e8d5bbfe6953bca20ba54b7bb2007f4f37c0))
+* **ci:** support opting out of skipping builds on metadata-only commits ([a6c047e](https://github.com/trycourier/courier-ruby/commit/a6c047eaa9730f8c398082cd422bf0bc1087e882))
+* **internal:** tweak CI branches ([08eccfe](https://github.com/trycourier/courier-ruby/commit/08eccfe4c37358304a97686df7248dc02f6ea0f4))
+* **internal:** update gitignore ([95860ac](https://github.com/trycourier/courier-ruby/commit/95860acf54c665132e957913d0fc6187cadaf64c))
+
+
+### Documentation
+
+* add AGENTS.md for AI coding assistants ([#81](https://github.com/trycourier/courier-ruby/issues/81)) ([ff1b8c2](https://github.com/trycourier/courier-ruby/commit/ff1b8c2e58007e1ccd5e631e07f28daf2027cef2))
+* sync README from mintlify-docs (2026-03-23 19:54 UTC) ([#79](https://github.com/trycourier/courier-ruby/issues/79)) ([4b83d99](https://github.com/trycourier/courier-ruby/commit/4b83d99126c8ddedf8e137cfc683bc6be998cc35))
+
+## 4.8.0 (2026-03-12)
+
+Full Changelog: [v4.7.1...v4.8.0](https://github.com/trycourier/courier-ruby/compare/v4.7.1...v4.8.0)
+
+### Features
+
+* **api:** add journeys resource with list and invoke methods ([26a80de](https://github.com/trycourier/courier-ruby/commit/26a80de1aa75c947f63e09da0ae7cb539947ecc4))
+* **api:** add provider_key/device/tracking to token params, remove body_token ([acb3031](https://github.com/trycourier/courier-ruby/commit/acb30313188a385e2ad39be4f4040e4e5836106d))
+* **api:** remove brand field from ElementalContent model ([519fcc0](https://github.com/trycourier/courier-ruby/commit/519fcc0a2f35a1fd61e64362b5a2e7b2d8225232))
+
+
+### Bug Fixes
+
+* mark MessageDetails timestamp fields as optional ([31a0be6](https://github.com/trycourier/courier-ruby/commit/31a0be63ee9969176a7bb3a627eabeb7c26d50f6))
+
+
+### Chores
+
+* **ci:** add build step ([d07ae3d](https://github.com/trycourier/courier-ruby/commit/d07ae3dc073f38ac30af1311f1d70153e441bf51))
+* **ci:** skip uploading artifacts on stainless-internal branches ([d4c0636](https://github.com/trycourier/courier-ruby/commit/d4c06361e5ef4e7c0a3a1660215d63fe845694c5))
+* **internal:** codegen related update ([3a0f51e](https://github.com/trycourier/courier-ruby/commit/3a0f51e6a03c33097f1307ac7974a3c5ca72ac90))
+* **internal:** codegen related update ([1cce4a8](https://github.com/trycourier/courier-ruby/commit/1cce4a8be23782aae7fb9185b8ac2efd06516842))
+* **internal:** remove mock server code ([a81351a](https://github.com/trycourier/courier-ruby/commit/a81351a2fde27b8a785a79436394a991e9048d97))
+* update mock server docs ([62d69fc](https://github.com/trycourier/courier-ruby/commit/62d69fc657babf8ff535e150d74a2283ddb64459))
+
+
+### Documentation
+
+* add AUTO-GENERATED-OVERVIEW markers for README sync ([#75](https://github.com/trycourier/courier-ruby/issues/75)) ([ab86102](https://github.com/trycourier/courier-ruby/commit/ab86102437d2af03dc45beae7262371c70b6847f))
+* sync README from mintlify-docs (2026-02-20 18:11 UTC) ([#76](https://github.com/trycourier/courier-ruby/issues/76)) ([cc67458](https://github.com/trycourier/courier-ruby/commit/cc6745816e152b890b84caaf666178bdbd9d3192))
+
 ## 4.7.1 (2026-02-07)
 
 Full Changelog: [v4.7.0...v4.7.1](https://github.com/trycourier/courier-ruby/compare/v4.7.0...v4.7.1)

data/README.md

@@ -1,259 +1,49 @@
-# Courier Ruby API library
+<!-- AUTO-GENERATED-OVERVIEW:START — Do not edit this section. It is synced from mintlify-docs. -->
+# Courier Ruby SDK
 
-The Courier Ruby library provides convenient access to the Courier REST API from any Ruby 3.2.0+ application. It ships with comprehensive types & docstrings in Yard, RBS, and RBI – [see below](https://github.com/trycourier/courier-ruby#Sorbet) for usage with Sorbet. The standard library's `net/http` is used as the HTTP transport, with connection pooling via the `connection_pool` gem.
-
-It is generated with [Stainless](https://www.stainless.com/).
-
-## Documentation
-
-Documentation for releases of this gem can be found [on RubyDoc](https://gemdocs.org/gems/trycourier).
-
-The REST API documentation can be found on [www.courier.com](https://www.courier.com/docs).
+The Courier Ruby SDK provides typed access to the Courier REST API from any Ruby 3.2+ application. It ships with Yard docstrings, RBS and RBI type definitions for Sorbet, and uses `net/http` with connection pooling.
 
 ## Installation
 
-To use this gem, install via Bundler by adding the following to your application's `Gemfile`:
-
-<!-- x-release-please-start-version -->
+Add to your `Gemfile`:
 
 ```ruby
-gem "trycourier", "~> 4.7.1"
+gem "trycourier"
 ```
 
-<!-- x-release-please-end -->
+Then run `bundle install`.
 
-## Usage
+## Quick Start
 
 ```ruby
 require "bundler/setup"
 require "courier"
 
-courier = Courier::Client.new(
-  api_key: ENV["COURIER_API_KEY"] # This is the default and can be omitted
-)
-
-response = courier.send_.message(
-  message: {to: {user_id: "your_user_id"}, template: "your_template_id", data: {foo: "bar"}}
-)
-
-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 `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 Courier::Errors::APIConnectionError => e
-  puts("The server could not be reached")
-  puts(e.cause)  # an underlying Exception, likely raised within `net/http`
-rescue Courier::Errors::RateLimitError => e
-  puts("A 429 status code was received; we should back off a bit.")
-rescue Courier::Errors::APIStatusError => e
-  puts("Another non-200-range status code was received")
-  puts(e.status)
-end
-```
-
-Error codes are as follows:
-
-| Cause            | Error Type                 |
-| ---------------- | -------------------------- |
-| HTTP 400         | `BadRequestError`          |
-| HTTP 401         | `AuthenticationError`      |
-| HTTP 403         | `PermissionDeniedError`    |
-| HTTP 404         | `NotFoundError`            |
-| HTTP 409         | `ConflictError`            |
-| HTTP 422         | `UnprocessableEntityError` |
-| HTTP 429         | `RateLimitError`           |
-| HTTP >= 500      | `InternalServerError`      |
-| Other HTTP error | `APIStatusError`           |
-| Timeout          | `APITimeoutError`          |
-| Network error    | `APIConnectionError`       |
-
-### Retries
-
-Certain errors will be automatically retried 2 times by default, with a short exponential backoff.
-
-Connection errors (for example, due to a network connectivity problem), 408 Request Timeout, 409 Conflict, 429 Rate Limit, >=500 Internal errors, and timeouts will all be retried by default.
-
-You can use the `max_retries` option to configure or disable this:
-
-```ruby
-# Configure the default for all requests:
-courier = Courier::Client.new(
-  max_retries: 0 # default is 2
-)
-
-# Or, configure per-request:
-courier.send_.message(
-  message: {to: {user_id: "your_user_id"}, template: "your_template_id", data: {foo: "bar"}},
-  request_options: {max_retries: 5}
-)
-```
-
-### Timeouts
-
-By default, requests will time out after 60 seconds. You can use the timeout option to configure or disable this:
-
-```ruby
-# Configure the default for all requests:
-courier = Courier::Client.new(
-  timeout: nil # default is 60
-)
-
-# Or, configure per-request:
-courier.send_.message(
-  message: {to: {user_id: "your_user_id"}, template: "your_template_id", data: {foo: "bar"}},
-  request_options: {timeout: 5}
-)
-```
-
-On timeout, `Courier::Errors::APITimeoutError` is raised.
-
-Note that requests that time out are retried by default.
-
-## Advanced concepts
-
-### BaseModel
-
-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.
-
-2. Structural equivalence for equality; if two API calls return the same values, comparing the responses with == will return true.
-
-3. Both instances and the classes themselves can be pretty-printed.
-
-4. Helpers such as `#to_h`, `#deep_to_h`, `#to_json`, and `#to_yaml`.
-
-### Making custom or undocumented requests
+client = Courier::Client.new
 
-#### Undocumented properties
-
-You can send undocumented parameters to any endpoint, and read undocumented response properties, like so:
-
-Note: the `extra_` parameters of the same name overrides the documented parameters.
-
-```ruby
-response =
-  courier.send_.message(
-    message: {to: {user_id: "your_user_id"}, template: "your_template_id", data: {foo: "bar"}},
-    request_options: {
-      extra_query: {my_query_parameter: value},
-      extra_body: {my_body_parameter: value},
-      extra_headers: {"my-header": value}
+response = client.send_.message(
+  message: {
+    to: { email: "you@example.com" },
+    content: {
+      title: "Hello from Courier!",
+      body: "Your first notification, sent with the Ruby SDK."
     }
-  )
-
-puts(response[:my_undocumented_property])
-```
-
-#### Undocumented request params
-
-If you want to explicitly send an extra param, you can do so with the `extra_query`, `extra_body`, and `extra_headers` under the `request_options:` parameter when making a request, as seen in the examples above.
-
-#### Undocumented endpoints
-
-To make requests to undocumented endpoints while retaining the benefit of auth, retries, and so on, you can make requests using `client.request`, like so:
-
-```ruby
-response = client.request(
-  method: :post,
-  path: '/undocumented/endpoint',
-  query: {"dog": "woof"},
-  headers: {"useful-header": "interesting-value"},
-  body: {"hello": "world"}
-)
-```
-
-### Concurrency & connection pooling
-
-The `Courier::Client` instances are threadsafe, but are only are fork-safe when there are no in-flight HTTP requests.
-
-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.
-
-Unless otherwise specified, other classes in the SDK do not have locks protecting their underlying data structure.
-
-## Sorbet
-
-This library provides comprehensive [RBI](https://sorbet.org/docs/rbi) definitions, and has no dependency on sorbet-runtime.
-
-You can provide typesafe request parameters like so:
-
-```ruby
-courier.send_.message(
-  message: Courier::SendMessageParams::Message.new(
-    to: Courier::UserRecipient.new(user_id: "your_user_id"),
-    template: "your_template_id",
-    data: {foo: "bar"}
-  )
-)
-```
-
-Or, equivalently:
-
-```ruby
-# Hashes work, but are not typesafe:
-courier.send_.message(
-  message: {to: {user_id: "your_user_id"}, template: "your_template_id", data: {foo: "bar"}}
+  }
 )
 
-# You can also splat a full Params class:
-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"}
-  )
-)
-courier.send_.message(**params)
+puts response.request_id
 ```
 
-### Enums
-
-Since this library does not depend on `sorbet-runtime`, it cannot provide [`T::Enum`](https://sorbet.org/docs/tenum) instances. Instead, we provide "tagged symbols" instead, which is always a primitive at runtime:
-
-```ruby
-# :AND
-puts(Courier::AudienceUpdateParams::Operator::AND)
-
-# Revealed type: `T.all(Courier::AudienceUpdateParams::Operator, Symbol)`
-T.reveal_type(Courier::AudienceUpdateParams::Operator::AND)
-```
+The client reads `COURIER_API_KEY` from your environment automatically. You can also pass it explicitly: `Courier::Client.new(api_key: "your-key")`.
 
-Enum parameters have a "relaxed" type, so you can either pass in enum constants or their literal value:
+> **Note**: The method is `send_` (with trailing underscore) because `send` is a reserved method in Ruby.
 
-```ruby
-# Using the enum constants preserves the tagged type information:
-courier.audiences.update(
-  operator: Courier::AudienceUpdateParams::Operator::AND,
-  # …
-)
-
-# Literal values are also permissible:
-courier.audiences.update(
-  operator: :AND,
-  # …
-)
-```
-
-## Versioning
-
-This package follows [SemVer](https://semver.org/spec/v2.0.0.html) conventions. As the library is in initial development and has a major version of `0`, APIs may change at any time.
-
-This package considers improvements to the (non-runtime) `*.rbi` and `*.rbs` type definitions to be non-breaking changes.
-
-## Requirements
-
-Ruby 3.2.0 or higher.
+## Documentation
 
-## Contributing
+Full documentation: **[courier.com/docs/sdk-libraries/ruby](https://www.courier.com/docs/sdk-libraries/ruby/)**
 
-See [the contributing documentation](https://github.com/trycourier/courier-ruby/tree/main/CONTRIBUTING.md).
+- [Quickstart](https://www.courier.com/docs/getting-started/quickstart/)
+- [Send API](https://www.courier.com/docs/platform/sending/send-message/)
+- [API Reference](https://www.courier.com/docs/reference/get-started/)
+- [RubyDoc](https://gemdocs.org/gems/trycourier)
+<!-- AUTO-GENERATED-OVERVIEW:END -->

data/lib/courier/client.rb

@@ -24,6 +24,9 @@ module Courier
     # @return [Courier::Resources::Audiences]
     attr_reader :audiences
 
+    # @return [Courier::Resources::Providers]
+    attr_reader :providers
+
     # @return [Courier::Resources::AuditEvents]
     attr_reader :audit_events
 
@@ -33,6 +36,9 @@ module Courier
     # @return [Courier::Resources::Automations]
     attr_reader :automations
 
+    # @return [Courier::Resources::Journeys]
+    attr_reader :journeys
+
     # @return [Courier::Resources::Brands]
     attr_reader :brands
 
@@ -54,6 +60,9 @@ module Courier
     # @return [Courier::Resources::Notifications]
     attr_reader :notifications
 
+    # @return [Courier::Resources::RoutingStrategies]
+    attr_reader :routing_strategies
+
     # @return [Courier::Resources::Profiles]
     attr_reader :profiles
 
@@ -115,9 +124,11 @@ module Courier
 
       @send_ = Courier::Resources::Send.new(client: self)
       @audiences = Courier::Resources::Audiences.new(client: self)
+      @providers = Courier::Resources::Providers.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)
+      @journeys = Courier::Resources::Journeys.new(client: self)
       @brands = Courier::Resources::Brands.new(client: self)
       @bulk = Courier::Resources::Bulk.new(client: self)
       @inbound = Courier::Resources::Inbound.new(client: self)
@@ -125,6 +136,7 @@ module Courier
       @messages = Courier::Resources::Messages.new(client: self)
       @requests = Courier::Resources::Requests.new(client: self)
       @notifications = Courier::Resources::Notifications.new(client: self)
+      @routing_strategies = Courier::Resources::RoutingStrategies.new(client: self)
       @profiles = Courier::Resources::Profiles.new(client: self)
       @tenants = Courier::Resources::Tenants.new(client: self)
       @translations = Courier::Resources::Translations.new(client: self)

data/lib/courier/internal/util.rb

@@ -157,7 +157,7 @@ module Courier
           in Hash | nil => coerced
             coerced
           else
-            message = "Expected a #{Hash} or #{Courier::Internal::Type::BaseModel}, got #{data.inspect}"
+            message = "Expected a #{Hash} or #{Courier::Internal::Type::BaseModel}, got #{input.inspect}"
             raise ArgumentError.new(message)
           end
         end
@@ -237,6 +237,11 @@ module Courier
         end
       end
 
+      # @type [Regexp]
+      #
+      # https://www.rfc-editor.org/rfc/rfc3986.html#section-3.3
+      RFC_3986_NOT_PCHARS = /[^A-Za-z0-9\-._~!$&'()*+,;=:@]+/
+
       class << self
         # @api private
         #
@@ -247,6 +252,15 @@ module Courier
           "#{uri.scheme}://#{uri.host}#{":#{uri.port}" unless uri.port == uri.default_port}"
         end
 
+        # @api private
+        #
+        # @param path [String, Integer]
+        #
+        # @return [String]
+        def encode_path(path)
+          path.to_s.gsub(Courier::Internal::Util::RFC_3986_NOT_PCHARS) { ERB::Util.url_encode(_1) }
+        end
+
         # @api private
         #
         # @param path [String, Array<String>]
@@ -259,7 +273,7 @@ module Courier
           in []
             ""
           in [String => p, *interpolations]
-            encoded = interpolations.map { ERB::Util.url_encode(_1) }
+            encoded = interpolations.map { encode_path(_1) }
             format(p, *encoded)
           end
         end
@@ -490,6 +504,37 @@ module Courier
       JSONL_CONTENT = %r{^application/(:?x-(?:n|l)djson)|(:?(?:x-)?jsonl)}
 
       class << self
+        # @api private
+        #
+        # @param query [Hash{Symbol=>Object}]
+        #
+        # @return [Hash{Symbol=>Object}]
+        def encode_query_params(query)
+          out = {}
+          query.each { write_query_param_element!(out, _1, _2) }
+          out
+        end
+
+        # @api private
+        #
+        # @param collection [Hash{Symbol=>Object}]
+        # @param key [String]
+        # @param element [Object]
+        #
+        # @return [nil]
+        private def write_query_param_element!(collection, key, element)
+          case element
+          in Hash
+            element.each do |name, value|
+              write_query_param_element!(collection, "#{key}[#{name}]", value)
+            end
+          in Array
+            collection[key] = element.map(&:to_s).join(",")
+          else
+            collection[key] = element.to_s
+          end
+        end
+
         # @api private
         #
         # @param y [Enumerator::Yielder]
@@ -540,16 +585,15 @@ module Courier
           y << "Content-Disposition: form-data"
 
           unless key.nil?
-            name = ERB::Util.url_encode(key.to_s)
-            y << "; name=\"#{name}\""
+            y << "; name=\"#{key}\""
           end
 
           case val
           in Courier::FilePart unless val.filename.nil?
-            filename = ERB::Util.url_encode(val.filename)
+            filename = encode_path(val.filename)
             y << "; filename=\"#{filename}\""
           in Pathname | IO
-            filename = ERB::Util.url_encode(::File.basename(val.to_path))
+            filename = encode_path(::File.basename(val.to_path))
             y << "; filename=\"#{filename}\""
           else
           end

data/lib/courier/models/audience_delete_params.rb

@@ -7,7 +7,13 @@ module Courier
       extend Courier::Internal::Type::RequestParameters::Converter
       include Courier::Internal::Type::RequestParameters
 
-      # @!method initialize(request_options: {})
+      # @!attribute audience_id
+      #
+      #   @return [String]
+      required :audience_id, String
+
+      # @!method initialize(audience_id:, request_options: {})
+      #   @param audience_id [String]
       #   @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}]
     end
   end

data/lib/courier/models/audience_list_members_params.rb

@@ -7,13 +7,20 @@ module Courier
       extend Courier::Internal::Type::RequestParameters::Converter
       include Courier::Internal::Type::RequestParameters
 
+      # @!attribute audience_id
+      #
+      #   @return [String]
+      required :audience_id, String
+
       # @!attribute cursor
       #   A unique identifier that allows for fetching the next set of members
       #
       #   @return [String, nil]
       optional :cursor, String, nil?: true
 
-      # @!method initialize(cursor: nil, request_options: {})
+      # @!method initialize(audience_id:, cursor: nil, request_options: {})
+      #   @param audience_id [String]
+      #
       #   @param cursor [String, nil] A unique identifier that allows for fetching the next set of members
       #
       #   @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}]

data/lib/courier/models/audience_retrieve_params.rb

@@ -7,7 +7,13 @@ module Courier
       extend Courier::Internal::Type::RequestParameters::Converter
       include Courier::Internal::Type::RequestParameters
 
-      # @!method initialize(request_options: {})
+      # @!attribute audience_id
+      #
+      #   @return [String]
+      required :audience_id, String
+
+      # @!method initialize(audience_id:, request_options: {})
+      #   @param audience_id [String]
       #   @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}]
     end
   end

data/lib/courier/models/audience_update_params.rb

@@ -7,6 +7,11 @@ module Courier
       extend Courier::Internal::Type::RequestParameters::Converter
       include Courier::Internal::Type::RequestParameters
 
+      # @!attribute audience_id
+      #
+      #   @return [String]
+      required :audience_id, String
+
       # @!attribute description
       #   A description of the audience
       #
@@ -31,10 +36,12 @@ module Courier
       #   @return [Symbol, Courier::Models::AudienceUpdateParams::Operator, nil]
       optional :operator, enum: -> { Courier::AudienceUpdateParams::Operator }, nil?: true
 
-      # @!method initialize(description: nil, filter: nil, name: nil, operator: nil, request_options: {})
+      # @!method initialize(audience_id:, description: nil, filter: nil, name: nil, operator: nil, request_options: {})
       #   Some parameter documentations has been truncated, see
       #   {Courier::Models::AudienceUpdateParams} for more details.
       #
+      #   @param audience_id [String]
+      #
       #   @param description [String, nil] A description of the audience
       #
       #   @param filter [Courier::Models::AudienceFilterConfig, nil] Filter configuration for audience membership containing an array of filter rules

data/lib/courier/models/audit_event_retrieve_params.rb

@@ -7,7 +7,13 @@ module Courier
       extend Courier::Internal::Type::RequestParameters::Converter
       include Courier::Internal::Type::RequestParameters
 
-      # @!method initialize(request_options: {})
+      # @!attribute audit_event_id
+      #
+      #   @return [String]
+      required :audit_event_id, String
+
+      # @!method initialize(audit_event_id:, request_options: {})
+      #   @param audit_event_id [String]
       #   @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}]
     end
   end

data/lib/courier/models/automations/invoke_invoke_by_template_params.rb

@@ -8,6 +8,11 @@ module Courier
         extend Courier::Internal::Type::RequestParameters::Converter
         include Courier::Internal::Type::RequestParameters
 
+        # @!attribute template_id
+        #
+        #   @return [String]
+        required :template_id, String
+
         # @!attribute recipient
         #
         #   @return [String, nil]
@@ -33,7 +38,8 @@ module Courier
         #   @return [String, nil]
         optional :template, String, nil?: true
 
-        # @!method initialize(recipient:, brand: nil, data: nil, profile: nil, template: nil, request_options: {})
+        # @!method initialize(template_id:, recipient:, brand: nil, data: nil, profile: nil, template: nil, request_options: {})
+        #   @param template_id [String]
         #   @param recipient [String, nil]
         #   @param brand [String, nil]
         #   @param data [Hash{Symbol=>Object}, nil]

data/lib/courier/models/brand_delete_params.rb

@@ -7,7 +7,13 @@ module Courier
       extend Courier::Internal::Type::RequestParameters::Converter
       include Courier::Internal::Type::RequestParameters
 
-      # @!method initialize(request_options: {})
+      # @!attribute brand_id
+      #
+      #   @return [String]
+      required :brand_id, String
+
+      # @!method initialize(brand_id:, request_options: {})
+      #   @param brand_id [String]
       #   @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}]
     end
   end

data/lib/courier/models/brand_retrieve_params.rb

@@ -7,7 +7,13 @@ module Courier
       extend Courier::Internal::Type::RequestParameters::Converter
       include Courier::Internal::Type::RequestParameters
 
-      # @!method initialize(request_options: {})
+      # @!attribute brand_id
+      #
+      #   @return [String]
+      required :brand_id, String
+
+      # @!method initialize(brand_id:, request_options: {})
+      #   @param brand_id [String]
       #   @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}]
     end
   end