From f0e18402bed68984be99b8979892453c454bb462 Mon Sep 17 00:00:00 2001 From: courier-codegen Date: Tue, 15 Sep 2026 17:16:12 +0000 Subject: [PATCH] docs(api): group the topic digest endpoints under Digests, and match the docs voice --- .../PreferenceUpdateOrCreateTopicParams.kt | 6 +++--- .../models/users/preferences/TopicPreference.kt | 12 ++++++------ .../workspacepreferences/TopicDigestRequest.kt | 2 +- .../WorkspacePreferenceTopicCreateRequest.kt | 8 ++++---- .../WorkspacePreferenceTopicReplaceRequest.kt | 8 ++++---- 5 files changed, 18 insertions(+), 18 deletions(-) diff --git a/courier-java-core/src/main/kotlin/com/courier/models/users/preferences/PreferenceUpdateOrCreateTopicParams.kt b/courier-java-core/src/main/kotlin/com/courier/models/users/preferences/PreferenceUpdateOrCreateTopicParams.kt index 6d598c05..3f8552d7 100644 --- a/courier-java-core/src/main/kotlin/com/courier/models/users/preferences/PreferenceUpdateOrCreateTopicParams.kt +++ b/courier-java-core/src/main/kotlin/com/courier/models/users/preferences/PreferenceUpdateOrCreateTopicParams.kt @@ -506,7 +506,7 @@ private constructor( /** * Put this recipient on one of the topic's digest schedules. Send `null` to clear the - * choice and return them to the topic's default. Omit to leave an existing choice alone -- + * choice and return them to the topic's default. Omit to leave an existing choice alone, * unlike the routing fields, which this endpoint replaces. An id that is not an active * schedule on the topic is rejected with a `400` before anything is written. * @@ -657,8 +657,8 @@ private constructor( /** * Put this recipient on one of the topic's digest schedules. Send `null` to clear the - * choice and return them to the topic's default. Omit to leave an existing choice alone - * -- unlike the routing fields, which this endpoint replaces. An id that is not an + * choice and return them to the topic's default. Omit to leave an existing choice + * alone, unlike the routing fields, which this endpoint replaces. An id that is not an * active schedule on the topic is rejected with a `400` before anything is written. */ fun digestScheduleId(digestScheduleId: String?) = diff --git a/courier-java-core/src/main/kotlin/com/courier/models/users/preferences/TopicPreference.kt b/courier-java-core/src/main/kotlin/com/courier/models/users/preferences/TopicPreference.kt index eee08a17..bc525a54 100644 --- a/courier-java-core/src/main/kotlin/com/courier/models/users/preferences/TopicPreference.kt +++ b/courier-java-core/src/main/kotlin/com/courier/models/users/preferences/TopicPreference.kt @@ -117,9 +117,9 @@ private constructor( customRouting.getOptional("custom_routing") /** - * The digest schedule this recipient is on for the topic. Omitted -- not null -- when they have - * not chosen one, in which case the topic's default schedule applies. Ids come from the topic's - * digest configuration or from `GET /digests/schedules`. + * The digest schedule this recipient is on for the topic. Omitted rather than null when they + * have not chosen one, in which case the topic's default schedule applies. Ids come from the + * topic's digest configuration or from `GET /digests/schedules`. * * @throws CourierInvalidDataException if the JSON field has an unexpected type (e.g. if the * server responded with an unexpected value). @@ -378,9 +378,9 @@ private constructor( } /** - * The digest schedule this recipient is on for the topic. Omitted -- not null -- when they - * have not chosen one, in which case the topic's default schedule applies. Ids come from - * the topic's digest configuration or from `GET /digests/schedules`. + * The digest schedule this recipient is on for the topic. Omitted rather than null when + * they have not chosen one, in which case the topic's default schedule applies. Ids come + * from the topic's digest configuration or from `GET /digests/schedules`. */ fun digestScheduleId(digestScheduleId: String) = digestScheduleId(JsonField.of(digestScheduleId)) diff --git a/courier-java-core/src/main/kotlin/com/courier/models/workspacepreferences/TopicDigestRequest.kt b/courier-java-core/src/main/kotlin/com/courier/models/workspacepreferences/TopicDigestRequest.kt index 3665f153..ecde5161 100644 --- a/courier-java-core/src/main/kotlin/com/courier/models/workspacepreferences/TopicDigestRequest.kt +++ b/courier-java-core/src/main/kotlin/com/courier/models/workspacepreferences/TopicDigestRequest.kt @@ -24,7 +24,7 @@ import kotlin.jvm.optionals.getOrNull * how collected events are retained. * * Send `null` for the whole object to turn a digest off, which unlinks the template and removes its - * schedules. There is no `enabled` flag, and `schedules: []` is rejected -- both states are + * schedules. There is no `enabled` flag, and `schedules: []` is rejected, because both states are * un-deliverable rather than merely off. */ class TopicDigestRequest diff --git a/courier-java-core/src/main/kotlin/com/courier/models/workspacepreferences/WorkspacePreferenceTopicCreateRequest.kt b/courier-java-core/src/main/kotlin/com/courier/models/workspacepreferences/WorkspacePreferenceTopicCreateRequest.kt index eb0d05a7..9564370d 100644 --- a/courier-java-core/src/main/kotlin/com/courier/models/workspacepreferences/WorkspacePreferenceTopicCreateRequest.kt +++ b/courier-java-core/src/main/kotlin/com/courier/models/workspacepreferences/WorkspacePreferenceTopicCreateRequest.kt @@ -110,8 +110,8 @@ private constructor( * and how collected events are retained. * * Send `null` for the whole object to turn a digest off, which unlinks the template and removes - * its schedules. There is no `enabled` flag, and `schedules: []` is rejected -- both states are - * un-deliverable rather than merely off. + * its schedules. There is no `enabled` flag, and `schedules: []` is rejected, because both + * states are un-deliverable rather than merely off. * * @throws CourierInvalidDataException if the JSON field has an unexpected type (e.g. if the * server responded with an unexpected value). @@ -350,8 +350,8 @@ private constructor( * on, and how collected events are retained. * * Send `null` for the whole object to turn a digest off, which unlinks the template and - * removes its schedules. There is no `enabled` flag, and `schedules: []` is rejected -- - * both states are un-deliverable rather than merely off. + * removes its schedules. There is no `enabled` flag, and `schedules: []` is rejected, + * because both states are un-deliverable rather than merely off. */ fun digest(digest: TopicDigestRequest?) = digest(JsonField.ofNullable(digest)) diff --git a/courier-java-core/src/main/kotlin/com/courier/models/workspacepreferences/WorkspacePreferenceTopicReplaceRequest.kt b/courier-java-core/src/main/kotlin/com/courier/models/workspacepreferences/WorkspacePreferenceTopicReplaceRequest.kt index a397dd2a..9484ce5d 100644 --- a/courier-java-core/src/main/kotlin/com/courier/models/workspacepreferences/WorkspacePreferenceTopicReplaceRequest.kt +++ b/courier-java-core/src/main/kotlin/com/courier/models/workspacepreferences/WorkspacePreferenceTopicReplaceRequest.kt @@ -113,8 +113,8 @@ private constructor( * and how collected events are retained. * * Send `null` for the whole object to turn a digest off, which unlinks the template and removes - * its schedules. There is no `enabled` flag, and `schedules: []` is rejected -- both states are - * un-deliverable rather than merely off. + * its schedules. There is no `enabled` flag, and `schedules: []` is rejected, because both + * states are un-deliverable rather than merely off. * * @throws CourierInvalidDataException if the JSON field has an unexpected type (e.g. if the * server responded with an unexpected value). @@ -352,8 +352,8 @@ private constructor( * on, and how collected events are retained. * * Send `null` for the whole object to turn a digest off, which unlinks the template and - * removes its schedules. There is no `enabled` flag, and `schedules: []` is rejected -- - * both states are un-deliverable rather than merely off. + * removes its schedules. There is no `enabled` flag, and `schedules: []` is rejected, + * because both states are un-deliverable rather than merely off. */ fun digest(digest: TopicDigestRequest?) = digest(JsonField.ofNullable(digest))