release: 5.18.1

.release-please-manifest.json

@@ -1,3 +1,3 @@
 {
-  ".": "5.18.0"
+  ".": "5.18.1"
 }

.stats.yml

@@ -1,4 +1,4 @@
 configured_endpoints: 134
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/courier/courier-b053468fefe6d757f86f3233ebbc52d80329ed2a6e7a6740fee01e4028a4c3b9.yml
-openapi_spec_hash: 416835e693de0fe19945be90a787d3f3
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/courier/courier-5c878919b3df530781ebcd4ab1cda83606304da75c53fe0817d4c725d5bbbe73.yml
+openapi_spec_hash: dd37022222543ff064200e65e4b82f59
 config_hash: 8d28dbeabe9d4dcc7d5b8c021a4cbbd7

CHANGELOG.md

@@ -1,5 +1,14 @@
 # Changelog
 
+## 5.18.1 (2026-07-25)
+
+Full Changelog: [v5.18.0...v5.18.1](https://github.com/trycourier/courier-csharp/compare/v5.18.0...v5.18.1)
+
+### Documentation
+
+* **openapi:** describe user topic-preference fields explicitly ([#172](https://github.com/trycourier/courier-csharp/issues/172)) ([7a0f629](https://github.com/trycourier/courier-csharp/commit/7a0f629f65ccaad8b5ca3b1a85dbc57d459da31b))
+* **openapi:** rewrite operation descriptions for agents and SEO ([#174](https://github.com/trycourier/courier-csharp/issues/174)) ([e22f43f](https://github.com/trycourier/courier-csharp/commit/e22f43f8050b6b71e58c5996e2e591cba57c15be))
+
 ## 5.18.0 (2026-07-23)
 
 Full Changelog: [v5.17.0...v5.18.0](https://github.com/trycourier/courier-csharp/compare/v5.17.0...v5.18.0)

src/TryCourier/Models/Audiences/AudienceDeleteParams.cs

@@ -9,7 +9,8 @@
 namespace TryCourier.Models.Audiences;
 
 /// <summary>
-/// Deletes the specified audience.
+/// Deletes an audience permanently, so update any caller sending to it by audience
+/// id first. Those sends fail once the audience is gone.
 ///
 /// <para>NOTE: Do not inherit from this type outside the SDK unless you're okay with
 /// breaking changes in non-major versions. We may add new methods in the future that

src/TryCourier/Models/Audiences/AudienceListMembersParams.cs

@@ -9,7 +9,8 @@
 namespace TryCourier.Models.Audiences;
 
 /// <summary>
-/// Get list of members of an audience.
+/// Returns the users currently matching an audience filter, with paging. Membership
+/// is recalculated, so results shift as profiles change.
 ///
 /// <para>NOTE: Do not inherit from this type outside the SDK unless you're okay with
 /// breaking changes in non-major versions. We may add new methods in the future that

src/TryCourier/Models/Audiences/AudienceListParams.cs

@@ -9,7 +9,8 @@
 namespace TryCourier.Models.Audiences;
 
 /// <summary>
-/// Get the audiences associated with the authorization token.
+/// Returns the audiences in the workspace with paging. Audiences are filter-based
+/// groups that recalculate as user profiles change.
 ///
 /// <para>NOTE: Do not inherit from this type outside the SDK unless you're okay with
 /// breaking changes in non-major versions. We may add new methods in the future that

src/TryCourier/Models/Audiences/AudienceRetrieveParams.cs

@@ -9,7 +9,8 @@
 namespace TryCourier.Models.Audiences;
 
 /// <summary>
-/// Returns the specified audience by id.
+/// Returns one audience with its name, description, and the filter and AND or OR
+/// operator that decide which users belong to it.
 ///
 /// <para>NOTE: Do not inherit from this type outside the SDK unless you're okay with
 /// breaking changes in non-major versions. We may add new methods in the future that

src/TryCourier/Models/Audiences/AudienceUpdateParams.cs

@@ -12,7 +12,8 @@
 namespace TryCourier.Models.Audiences;
 
 /// <summary>
-/// Creates or updates audience.
+/// Creates or replaces an audience from a filter and an AND or OR operator. Membership
+/// recalculates automatically as profiles change.
 ///
 /// <para>NOTE: Do not inherit from this type outside the SDK unless you're okay with
 /// breaking changes in non-major versions. We may add new methods in the future that

src/TryCourier/Models/AuditEvents/AuditEventListParams.cs

@@ -9,7 +9,8 @@
 namespace TryCourier.Models.AuditEvents;
 
 /// <summary>
-/// Fetch the list of audit events
+/// Returns the workspace's audit event log with cursor paging. Each event records
+/// the actor, target, source, type, and timestamp of a change.
 ///
 /// <para>NOTE: Do not inherit from this type outside the SDK unless you're okay with
 /// breaking changes in non-major versions. We may add new methods in the future that

src/TryCourier/Models/AuditEvents/AuditEventRetrieveParams.cs

@@ -9,7 +9,8 @@
 namespace TryCourier.Models.AuditEvents;
 
 /// <summary>
-/// Fetch a specific audit event by ID.
+/// Returns one audit event by id, including the actor who performed it, the target
+/// they changed, the source, the event type, and a timestamp.
 ///
 /// <para>NOTE: Do not inherit from this type outside the SDK unless you're okay with
 /// breaking changes in non-major versions. We may add new methods in the future that

src/TryCourier/Models/Auth/AuthIssueTokenParams.cs

@@ -10,7 +10,8 @@
 namespace TryCourier.Models.Auth;
 
 /// <summary>
-/// Returns a new access token.
+/// Returns a JWT for authenticating client-side SDKs such as the Inbox. You supply
+/// the scope and an expires_in duration, both required.
 ///
 /// <para>NOTE: Do not inherit from this type outside the SDK unless you're okay with
 /// breaking changes in non-major versions. We may add new methods in the future that

src/TryCourier/Models/Automations/AutomationListParams.cs

@@ -11,7 +11,8 @@
 namespace TryCourier.Models.Automations;
 
 /// <summary>
-/// Get the list of automations.
+/// Lists the workspace's saved automation templates, each with its id and a cursor
+/// for paging to the next page of results.
 ///
 /// <para>NOTE: Do not inherit from this type outside the SDK unless you're okay with
 /// breaking changes in non-major versions. We may add new methods in the future that

src/TryCourier/Models/Automations/Invoke/InvokeInvokeAdHocParams.cs

@@ -13,9 +13,8 @@
 namespace TryCourier.Models.Automations.Invoke;
 
 /// <summary>
-/// Invoke an ad hoc automation run. This endpoint accepts a JSON payload with a
-/// series of automation steps. For information about what steps are available, checkout
-/// the ad hoc automation guide [here](https://www.courier.com/docs/automations/steps/).
+/// Runs a series of automation steps supplied inline, without a saved template,
+/// and returns a runId.
 ///
 /// <para>NOTE: Do not inherit from this type outside the SDK unless you're okay with
 /// breaking changes in non-major versions. We may add new methods in the future that

src/TryCourier/Models/Automations/Invoke/InvokeInvokeByTemplateParams.cs

@@ -10,7 +10,8 @@
 namespace TryCourier.Models.Automations.Invoke;
 
 /// <summary>
-/// Invoke an automation run from an automation template.
+/// Starts an automation run from a saved template for one recipient, with optional
+/// data and profile, and returns a runId.
 ///
 /// <para>NOTE: Do not inherit from this type outside the SDK unless you're okay with
 /// breaking changes in non-major versions. We may add new methods in the future that

src/TryCourier/Models/Brands/BrandCreateParams.cs

@@ -10,8 +10,8 @@
 namespace TryCourier.Models.Brands;
 
 /// <summary>
-/// Create a new brand. Requires `name` and `settings` (with at least `colors.primary`
-/// and `colors.secondary`).
+/// Creates a brand from a name and settings, including primary and secondary colors.
+/// Brands supply the logo, colors, and styling that templates render with.
 ///
 /// <para>NOTE: Do not inherit from this type outside the SDK unless you're okay with
 /// breaking changes in non-major versions. We may add new methods in the future that

src/TryCourier/Models/Brands/BrandDeleteParams.cs

@@ -9,7 +9,8 @@
 namespace TryCourier.Models.Brands;
 
 /// <summary>
-/// Delete a brand by brand ID.
+/// Deletes a brand by id. Reassign any template or tenant that references it before
+/// deleting to keep their styling intact.
 ///
 /// <para>NOTE: Do not inherit from this type outside the SDK unless you're okay with
 /// breaking changes in non-major versions. We may add new methods in the future that

src/TryCourier/Models/Brands/BrandListParams.cs

@@ -9,7 +9,8 @@
 namespace TryCourier.Models.Brands;
 
 /// <summary>
-/// Get the list of brands.
+/// Lists the workspace's brands. Every entry carries its name, styling settings,
+/// snippets, and published version.
 ///
 /// <para>NOTE: Do not inherit from this type outside the SDK unless you're okay with
 /// breaking changes in non-major versions. We may add new methods in the future that

src/TryCourier/Models/Brands/BrandRetrieveParams.cs

@@ -9,7 +9,8 @@
 namespace TryCourier.Models.Brands;
 
 /// <summary>
-/// Fetch a specific brand by brand ID.
+/// Returns one brand by id, including its colors, logo and styling settings, Handlebars
+/// snippets, and published version.
 ///
 /// <para>NOTE: Do not inherit from this type outside the SDK unless you're okay with
 /// breaking changes in non-major versions. We may add new methods in the future that

src/TryCourier/Models/Brands/BrandUpdateParams.cs

@@ -10,7 +10,8 @@
 namespace TryCourier.Models.Brands;
 
 /// <summary>
-/// Replace an existing brand with the supplied values.
+/// Replaces a brand with the values you supply, so send the complete settings and
+/// snippets rather than only the fields you want changed.
 ///
 /// <para>NOTE: Do not inherit from this type outside the SDK unless you're okay with
 /// breaking changes in non-major versions. We may add new methods in the future that

src/TryCourier/Models/Digests/Schedules/ScheduleListInstancesParams.cs

@@ -9,9 +9,8 @@
 namespace TryCourier.Models.Digests.Schedules;
 
 /// <summary>
-/// List the digest instances for a schedule. Each instance represents the events
-/// accumulated for a single user against the schedule, and can be used to monitor
-/// digest accumulation before the digest is released.
+/// Returns the digest instances for a schedule, one per user, with cursor paging.
+/// Use it to see what has accumulated before a digest releases.
 ///
 /// <para>NOTE: Do not inherit from this type outside the SDK unless you're okay with
 /// breaking changes in non-major versions. We may add new methods in the future that

src/TryCourier/Models/Inbound/InboundTrackEventParams.cs

@@ -12,7 +12,8 @@
 namespace TryCourier.Models.Inbound;
 
 /// <summary>
-/// Courier Track Event
+/// Records an inbound event that can trigger a journey. Requires an event name, a
+/// messageId you generate, a type, and a properties object.
 ///
 /// <para>NOTE: Do not inherit from this type outside the SDK unless you're okay with
 /// breaking changes in non-major versions. We may add new methods in the future that

src/TryCourier/Models/Journeys/JourneyArchiveParams.cs

@@ -9,8 +9,8 @@
 namespace TryCourier.Models.Journeys;
 
 /// <summary>
-/// Archive a journey. Archived journeys cannot be invoked. Existing journey runs
-/// continue to completion.
+/// Archives a journey so it can no longer be invoked. Runs already in flight continue
+/// to completion, so archiving never strands a user mid-sequence.
 ///
 /// <para>NOTE: Do not inherit from this type outside the SDK unless you're okay with
 /// breaking changes in non-major versions. We may add new methods in the future that

src/TryCourier/Models/Journeys/JourneyCancelParams.cs

@@ -10,12 +10,8 @@
 namespace TryCourier.Models.Journeys;
 
 /// <summary>
-/// Cancel journey runs. The request body must include EXACTLY ONE of `cancelation_token`
-/// (cancels every run associated with the token) or `run_id` (cancels a single tenant-scoped
-/// run). Supplying both or neither returns a `400`. A `run_id` that does not match
-/// a run for the tenant returns `404`. Cancelation is idempotent: a run that has
-/// already finished (`PROCESSED`/`ERROR`) or was already `CANCELED` is left unchanged
-/// and its current status is returned.
+/// Cancels in-flight journey runs, either every run sharing a cancelation token or
+/// one run by id. Use it to stop a sequence when the event resolves.
 ///
 /// <para>NOTE: Do not inherit from this type outside the SDK unless you're okay with
 /// breaking changes in non-major versions. We may add new methods in the future that

src/TryCourier/Models/Journeys/JourneyCreateParams.cs

@@ -11,11 +11,8 @@
 namespace TryCourier.Models.Journeys;
 
 /// <summary>
-/// Create a journey. Defaults to `DRAFT` state; pass `state: "PUBLISHED"` to publish
-/// on create. Send nodes are not allowed on `POST`. The standard flow is: create
-/// the journey shell here, add notification templates with `POST /journeys/{templateId}/templates`,
-/// then wire them into the journey with `PUT /journeys/{templateId}`. Call `POST
-/// /journeys/{templateId}/publish` to publish a draft after the fact.
+/// Creates a journey from a set of nodes, in draft state unless you pass a published
+/// state. Send nodes cannot be included until their templates exist.
 ///
 /// <para>NOTE: Do not inherit from this type outside the SDK unless you're okay with
 /// breaking changes in non-major versions. We may add new methods in the future that

src/TryCourier/Models/Journeys/JourneyInvokeParams.cs

@@ -10,8 +10,8 @@
 namespace TryCourier.Models.Journeys;
 
 /// <summary>
-/// Invoke a journey by id or alias to start a new run. The response includes a `runId`
-/// identifying the run.
+/// Starts a journey run for one user and returns a runId. Runs execute asynchronously,
+/// so the response arrives before any message is sent.
 ///
 /// <para>NOTE: Do not inherit from this type outside the SDK unless you're okay with
 /// breaking changes in non-major versions. We may add new methods in the future that

src/TryCourier/Models/Journeys/JourneyListParams.cs

@@ -11,7 +11,8 @@
 namespace TryCourier.Models.Journeys;
 
 /// <summary>
-/// Get the list of journeys.
+/// Lists the workspace's journeys, each carrying a name, state, and enabled flag.
+/// Paged by cursor.
 ///
 /// <para>NOTE: Do not inherit from this type outside the SDK unless you're okay with
 /// breaking changes in non-major versions. We may add new methods in the future that

src/TryCourier/Models/Journeys/JourneyListVersionsParams.cs

@@ -9,7 +9,8 @@
 namespace TryCourier.Models.Journeys;
 
 /// <summary>
-/// List published versions of a journey, ordered most recent first.
+/// Lists a journey's published versions, most recent first, so you have a version
+/// id to roll back to. Paged by cursor.
 ///
 /// <para>NOTE: Do not inherit from this type outside the SDK unless you're okay with
 /// breaking changes in non-major versions. We may add new methods in the future that

src/TryCourier/Models/Journeys/JourneyPublishParams.cs

@@ -10,9 +10,8 @@
 namespace TryCourier.Models.Journeys;
 
 /// <summary>
-/// Publish the current draft as a new version. Body is optional; pass `{ "version":
-/// "vN" }` to roll back to a prior version instead. Returns 404 if the journey has
-/// no draft to publish.
+/// Publishes a journey's current draft as a new version, making it live for new
+/// runs. Pass a version instead to roll back to an earlier one.
 ///
 /// <para>NOTE: Do not inherit from this type outside the SDK unless you're okay with
 /// breaking changes in non-major versions. We may add new methods in the future that

src/TryCourier/Models/Journeys/JourneyReplaceParams.cs

@@ -11,10 +11,8 @@
 namespace TryCourier.Models.Journeys;
 
 /// <summary>
-/// Replace the journey draft. Updates the working draft only; call `POST /journeys/{templateId}/publish`
-/// to make it live, or pass `state: "PUBLISHED"` in this request to publish immediately.
-/// Send-node `template` ids must already exist and be scoped to this journey, and
-/// node ids must not be claimed by another journey.
+/// Replaces a journey's working draft, leaving the published version live until you
+/// publish. Reach for this when editing a journey already running.
 ///
 /// <para>NOTE: Do not inherit from this type outside the SDK unless you're okay with
 /// breaking changes in non-major versions. We may add new methods in the future that

src/TryCourier/Models/Journeys/Templates/TemplateArchiveParams.cs

@@ -9,7 +9,8 @@
 namespace TryCourier.Models.Journeys.Templates;
 
 /// <summary>
-/// Archive the journey-scoped notification template. Archived templates cannot be sent.
+/// Archives one journey's notification template, preventing further sends. Detach
+/// any send node referencing it beforehand.
 ///
 /// <para>NOTE: Do not inherit from this type outside the SDK unless you're okay with
 /// breaking changes in non-major versions. We may add new methods in the future that

src/TryCourier/Models/Journeys/Templates/TemplateListVersionsParams.cs

@@ -9,8 +9,8 @@
 namespace TryCourier.Models.Journeys.Templates;
 
 /// <summary>
-/// List published versions of the journey-scoped notification template, ordered most
-/// recent first.
+/// Lists the published versions of a template that belongs to a journey, most recent
+/// first. Paged by cursor.
 ///
 /// <para>NOTE: Do not inherit from this type outside the SDK unless you're okay with
 /// breaking changes in non-major versions. We may add new methods in the future that

src/TryCourier/Models/Journeys/Templates/TemplatePublishParams.cs

@@ -10,8 +10,8 @@
 namespace TryCourier.Models.Journeys.Templates;
 
 /// <summary>
-/// Publish the current draft of the journey-scoped notification template as a new
-/// version. Optionally roll back to a prior version by passing `{ "version": "vN" }`.
+/// Publishes a journey-scoped template's draft as a new version. Pass a version
+/// instead to roll back the template to an earlier publish.
 ///
 /// <para>NOTE: Do not inherit from this type outside the SDK unless you're okay with
 /// breaking changes in non-major versions. We may add new methods in the future that

src/TryCourier/Models/Journeys/Templates/TemplateReplaceParams.cs

@@ -13,7 +13,8 @@
 namespace TryCourier.Models.Journeys.Templates;
 
 /// <summary>
-/// Replace the journey-scoped notification template draft.
+/// Replaces the draft content of one journey's notification template. Publish it
+/// before send nodes referencing it render the change.
 ///
 /// <para>NOTE: Do not inherit from this type outside the SDK unless you're okay with
 /// breaking changes in non-major versions. We may add new methods in the future that

src/TryCourier/Models/Journeys/Templates/TemplateRetrieveContentParams.cs

@@ -9,10 +9,8 @@
 namespace TryCourier.Models.Journeys.Templates;
 
 /// <summary>
-/// Retrieve the elemental content of a journey-scoped notification template. The
-/// response contains the versioned elements along with their content checksums,
-/// which can be used to detect changes between versions. Pass `?version=draft` (default
-/// `published`) to retrieve the working draft, or `?version=vN` for a historical version.
+/// Returns the Elemental elements and version of a journey-scoped template's content.
+/// Compare versions to see what changed between publishes.
 ///
 /// <para>NOTE: Do not inherit from this type outside the SDK unless you're okay with
 /// breaking changes in non-major versions. We may add new methods in the future that

src/TryCourier/Models/Journeys/Templates/TemplateRetrieveParams.cs

@@ -9,8 +9,8 @@
 namespace TryCourier.Models.Journeys.Templates;
 
 /// <summary>
-/// Fetch a journey-scoped notification template by id. Pass `?version=draft` (default
-/// `published`) to retrieve the working draft, or `?version=vN` for a historical version.
+/// Returns a journey's own notification template with its name, brand, subscription
+/// topic, and content. Defaults to the published version.
 ///
 /// <para>NOTE: Do not inherit from this type outside the SDK unless you're okay with
 /// breaking changes in non-major versions. We may add new methods in the future that

src/TryCourier/Models/Lists/ListDeleteParams.cs

@@ -9,7 +9,8 @@
 namespace TryCourier.Models.Lists;
 
 /// <summary>
-/// Delete a list by list ID.
+/// Deletes a list, halting sends that target it. A previously deleted list can be
+/// brought back with the companion restore endpoint.
 ///
 /// <para>NOTE: Do not inherit from this type outside the SDK unless you're okay with
 /// breaking changes in non-major versions. We may add new methods in the future that

src/TryCourier/Models/Lists/ListListParams.cs

@@ -9,7 +9,8 @@
 namespace TryCourier.Models.Lists;
 
 /// <summary>
-/// Returns all of the lists, with the ability to filter based on a pattern.
+/// Returns the workspace's lists, filterable by a pattern to fetch a subset such
+/// as every regional list. Paged by cursor.
 ///
 /// <para>NOTE: Do not inherit from this type outside the SDK unless you're okay with
 /// breaking changes in non-major versions. We may add new methods in the future that