@leaflow/sdk 0.0.0-dev.29.g8fe6a71 → 0.0.0-dev.293.g578f043

package/dist/notification/v1/generated/schemas.zod.js

@@ -0,0 +1,412 @@
+/**
+ * Generated by orval 🍺
+ * Do not edit manually.
+ * Leaflow Notification API
+ * Read the notifications this platform has sent you, and choose where each kind of notification
+ * is delivered.
+ *
+ * Every service on the platform reports events here rather than contacting you directly. This
+ * API is the single place where those events are read, and the single place where delivery is
+ * configured.
+ *
+ * ## Authentication
+ *
+ * Every request carries a scoped token; see the `bearerAuth` security scheme.
+ *
+ * **Neither the path nor the headers carry a `project_id`**: the current project is determined by
+ * the token. Listing operations return everything addressed to you across every project by
+ * default, because a notification is addressed to a person rather than to a project; pass
+ * `scope=current_project` to narrow the result to the project in the token.
+ *
+ * ## Conventions
+ *
+ * - **Notifications are typed, and the type determines who receives it.** A type such as
+ *   `compute.instance.provisioned` is addressed to whoever created the instance, while
+ *   `monitoring.alert.raised` is addressed to every member of the project. The full catalogue is
+ *   available from `GET /api/v1/notification-types` and is stable: a type identifier is never
+ *   reused for a different event.
+ * - **Text is rendered at read time from the language on your preferences.** Changing the
+ *   language changes the text of everything already in the inbox. Messages already delivered by
+ *   email or to an outbound channel are not rewritten, because they have already been sent.
+ * - **Times inside rendered text are stated in UTC and say so.** There is no time zone setting.
+ *   Clients that can determine the reader's time zone should present `created_at`, `occurred_at`
+ *   and the timestamps in `params` — all of which are RFC 3339 — in local time instead. Email
+ *   cannot do this, which is why the text it carries is explicit about being UTC.
+ * - **Some types must reach you, and those cannot be muted or removed from email.** They are
+ *   marked `mandatory` in the catalogue: types you would only find out about by signing in, when
+ *   not finding out costs you something — a suspension, a deletion, a credential that expires.
+ *   Everything else about them is still configurable, including adding channels of your own.
+ * - **Deleting a preference restores the default; it does not turn the type off.** To stop
+ *   receiving a type, set `muted` on it.
+ * - **Outbound channels deliver nothing until they are verified.** Registering a channel does not
+ *   contact it. Verification is a separate operation that sends one message, and only a channel
+ *   that has acknowledged it receives anything afterwards.
+ * - **Channel endpoints are never returned.** No operation, including the one that registers
+ *   them, returns the address that was submitted. A channel entered incorrectly must be deleted
+ *   and registered again.
+ *
+ * ## Rate and volume
+ *
+ * Delivery to outbound channels is limited per channel, and bursts of alerts about one server are
+ * summarised rather than sent individually. Nothing is summarised in the inbox: it always holds
+ * every notification. A notification that was summarised or suppressed is still readable here.
+ *
+ * ## One-time credentials
+ *
+ * Some notifications carry a reference to a credential rather than the credential itself — the
+ * initial password of a newly created instance, for example. That credential is readable exactly
+ * once, expires on its own, and is destroyed as soon as it has been read. Requesting it a second
+ * time returns `CREDENTIAL_TICKET_CONSUMED`.
+ * OpenAPI spec version: 1.0.0
+ */
+import * as zod from "zod";
+import { AuthorizeRealtimeChannelRequestBody } from "./validators/authorizeRealtimeChannelRequestBody.zod.js";
+import { ConfirmEmailOverrideRequestBody } from "./validators/confirmEmailOverrideRequestBody.zod.js";
+import { CreateChannelRequestBody } from "./validators/createChannelRequestBody.zod.js";
+import { MarkNotificationsReadRequestBody } from "./validators/markNotificationsReadRequestBody.zod.js";
+import { UpdateChannelRequestBody } from "./validators/updateChannelRequestBody.zod.js";
+import { UpdatePreferencesRequestBody } from "./validators/updatePreferencesRequestBody.zod.js";
+import { UpdateTypePreferenceRequestBody } from "./validators/updateTypePreferenceRequestBody.zod.js";
+/**
+ * Returns notifications in reverse chronological order, newest first.
+ *
+ * Announcements are not in this list. They are one row for the whole platform rather than
+ * one per reader, so they are listed, read and counted by their own operations under
+ * `/api/v1/announcements`. `kind` is on every item here for clients that merge the two lists
+ * themselves, and it is `notification` for everything this operation returns.
+ * @summary List notifications addressed to you
+ */
+export const listNotificationsQueryLimitDefault = 50;
+export const listNotificationsQueryLimitMax = 200;
+export const listNotificationsQueryOffsetDefault = 0;
+export const listNotificationsQueryOffsetMin = 0;
+export const listNotificationsQueryOffsetMax = 10000;
+export const listNotificationsQueryTypeMax = 128;
+export const listNotificationsQueryIncludeArchivedDefault = false;
+export const ListNotificationsQueryParams = zod.strictObject({
+    limit: zod
+        .int()
+        .min(1)
+        .max(listNotificationsQueryLimitMax)
+        .default(listNotificationsQueryLimitDefault)
+        .describe("Items returned in this page. Defaults to 50; at most 200."),
+    offset: zod
+        .int()
+        .min(listNotificationsQueryOffsetMin)
+        .max(listNotificationsQueryOffsetMax)
+        .default(listNotificationsQueryOffsetDefault)
+        .describe("Items to skip. Defaults to 0; at most 10000."),
+    scope: zod
+        .enum(["all", "current_project"])
+        .optional()
+        .describe("Which projects to include; defaults to every project"),
+    type: zod
+        .string()
+        .max(listNotificationsQueryTypeMax)
+        .optional()
+        .describe("Return only notifications of this type; omit for all types"),
+    min_severity: zod
+        .enum(["info", "warning", "error", "critical"])
+        .optional()
+        .describe("Return only notifications at or above this severity; omit for all severities"),
+    read: zod
+        .boolean()
+        .optional()
+        .describe("Restrict to unread, to read, or to neither; omit for both"),
+    include_archived: zod
+        .boolean()
+        .default(listNotificationsQueryIncludeArchivedDefault)
+        .describe("Include archived notifications; they are excluded by default"),
+});
+/**
+ * Marks every listed notification as read. Notifications already read are left alone, and the
+ * operation succeeds whether or not any of them changed.
+ *
+ * Passing an empty list marks everything currently unread as read.
+ * @summary Mark several notifications as read
+ */
+export const MarkNotificationsReadBody = MarkNotificationsReadRequestBody;
+/**
+ * Returns the number of unread notifications. This is the value behind the badge in the
+ * console, and it is also carried on every realtime event, so it does not normally need to be
+ * requested on its own.
+ * @summary Count unread notifications
+ */
+export const CountUnreadNotificationsQueryParams = zod.strictObject({
+    scope: zod
+        .enum(["all", "current_project"])
+        .optional()
+        .describe("Which projects to include; defaults to every project"),
+});
+/**
+ * A notification addressed to someone else returns `NOTIFICATION_NOT_FOUND`, the same answer
+ * as one that does not exist.
+ * @summary Get one notification
+ */
+export const GetNotificationParams = zod.strictObject({
+    notificationId: zod
+        .uuid()
+        .describe("The notification, or the announcement when kind is announcement"),
+});
+/**
+ * Marking a notification that is already read succeeds and changes nothing.
+ * @summary Mark one notification as read
+ */
+export const MarkNotificationReadParams = zod.strictObject({
+    notificationId: zod
+        .uuid()
+        .describe("The notification, or the announcement when kind is announcement"),
+});
+/**
+ * Puts it back in the unread count, which is what somebody wants after opening a thing by
+ * accident and needing it to stay in front of them.
+ *
+ * Marking one that is already unread succeeds and changes nothing.
+ * @summary Mark one notification as unread
+ */
+export const MarkNotificationUnreadParams = zod.strictObject({
+    notificationId: zod
+        .uuid()
+        .describe("The notification, or the announcement when kind is announcement"),
+});
+/**
+ * Archiving removes a notification from the default listing without deleting it; pass
+ * `include_archived` to see it again. Archiving also marks it read.
+ * @summary Archive one notification
+ */
+export const ArchiveNotificationParams = zod.strictObject({
+    notificationId: zod
+        .uuid()
+        .describe("The notification, or the announcement when kind is announcement"),
+});
+/**
+ * Returns it to the default listing. Archiving is one click away from anything in the list,
+ * so undoing it has to be too; without this operation a mistaken archive is permanent, and
+ * the notification stays reachable only by asking for archived ones.
+ *
+ * It does not mark it unread again: archiving marked it read, and that it was read is still
+ * true. Use `mark-notification-unread` for that.
+ *
+ * Unarchiving one that is not archived succeeds and changes nothing.
+ * @summary Take one notification out of the archive
+ */
+export const UnarchiveNotificationParams = zod.strictObject({
+    notificationId: zod
+        .uuid()
+        .describe("The notification, or the announcement when kind is announcement"),
+});
+/**
+ * Idempotent: marking one twice is the same as marking it once. There is no way to mark it
+ * unread — having read something is a fact, not a state.
+ * @summary Mark one announcement as read
+ */
+export const ReadAnnouncementParams = zod.strictObject({
+    announcementId: zod.uuid(),
+});
+/**
+ * Fields that are omitted are left alone.
+ *
+ * Setting `email_override` records it as the pending address; nothing is sent to it until
+ * `send-email-override-code` is called, and email keeps going where it went before. Setting
+ * it to null clears the pending address and any address in use, returning delivery to the
+ * account address.
+ *
+ * An address is never used until somebody proves they can read it. Without that, anybody
+ * could point their own notifications at a stranger's mailbox, and the stranger would get
+ * mail about an account they have never heard of.
+ * @summary Update your delivery preferences
+ */
+export const UpdateNotificationPreferencesBody = UpdatePreferencesRequestBody;
+/**
+ * A correct code moves the pending address into use: email starts going there instead of the
+ * account address, and the pending slot is emptied.
+ *
+ * A wrong code counts against the attempts on that code. Running out of attempts throws the
+ * code away, and a new one has to be sent; the pending address itself is kept, so nobody
+ * loses their place by mistyping.
+ * @summary Confirm the pending address with its code
+ */
+export const ConfirmEmailOverrideBody = ConfirmEmailOverrideRequestBody;
+/**
+ * Returns one entry per notification type, whether or not it has been configured. Entries
+ * that have never been configured are reported with `inherited: true` and carry the defaults
+ * from the catalogue.
+ *
+ * A preference applies either to one project or to every project. Both are returned; the one
+ * naming a project takes precedence for that project.
+ * @summary List your per-type preferences
+ */
+export const ListTypePreferencesQueryParams = zod.strictObject({
+    project_id: zod
+        .uuid()
+        .optional()
+        .describe("Return preferences for this project in addition to the account-wide ones; omit for the account-wide ones only"),
+});
+/**
+ * States how this type should be delivered, replacing whatever was configured before.
+ *
+ * Omitting `project_id` configures every project. Naming one configures that project alone
+ * and takes precedence there.
+ *
+ * On a type marked `mandatory`, setting `muted` or omitting `email` from `channels` returns
+ * `NOTIFICATION_TYPE_MANDATORY`. Everything else about such a type is configurable, including
+ * adding channels and raising `min_severity`.
+ *
+ * Naming a channel the type does not support returns `NOTIFICATION_CHANNEL_UNSUPPORTED`.
+ * `inbox` is accepted but has no effect: every notification is in the inbox regardless.
+ * @summary Set the preference for one type
+ */
+export const updateTypePreferencePathTypeMin = 3;
+export const updateTypePreferencePathTypeMax = 128;
+export const updateTypePreferencePathTypeRegExp = new RegExp("^[a-z][a-z0-9_]*(\\.[a-z][a-z0-9_]*){2,}$");
+export const UpdateTypePreferenceParams = zod.strictObject({
+    type: zod
+        .string()
+        .min(updateTypePreferencePathTypeMin)
+        .max(updateTypePreferencePathTypeMax)
+        .regex(updateTypePreferencePathTypeRegExp)
+        .describe("A notification type identifier, as listed by list-notification-types"),
+});
+export const UpdateTypePreferenceQueryParams = zod.strictObject({
+    project_id: zod
+        .uuid()
+        .optional()
+        .describe("Apply to this project alone; omit to apply to every project"),
+});
+export const UpdateTypePreferenceBody = UpdateTypePreferenceRequestBody;
+/**
+ * Removes the configured preference so the type follows the default in the catalogue again.
+ *
+ * **This does not stop the type from being delivered.** To stop receiving it, set `muted`
+ * instead. Deleting a preference that was never configured succeeds and changes nothing.
+ * @summary Restore the default for one type
+ */
+export const deleteTypePreferencePathTypeMin = 3;
+export const deleteTypePreferencePathTypeMax = 128;
+export const deleteTypePreferencePathTypeRegExp = new RegExp("^[a-z][a-z0-9_]*(\\.[a-z][a-z0-9_]*){2,}$");
+export const DeleteTypePreferenceParams = zod.strictObject({
+    type: zod
+        .string()
+        .min(deleteTypePreferencePathTypeMin)
+        .max(deleteTypePreferencePathTypeMax)
+        .regex(deleteTypePreferencePathTypeRegExp)
+        .describe("A notification type identifier, as listed by list-notification-types"),
+});
+export const DeleteTypePreferenceQueryParams = zod.strictObject({
+    project_id: zod
+        .uuid()
+        .optional()
+        .describe("Apply to this project alone; omit to apply to every project"),
+});
+/**
+ * Returns the channels you have registered, and the channels registered for the project in
+ * the token. The address of each is not included.
+ * @summary List outbound channels
+ */
+export const ListUserChannelsQueryParams = zod.strictObject({
+    channel_scope: zod
+        .enum(["user", "project"])
+        .optional()
+        .describe("Return only channels of this scope; omit for both"),
+    kind: zod
+        .enum(["lark_webhook", "wecom_webhook", "bark", "generic_webhook"])
+        .optional()
+        .describe("Return only channels of this kind; omit for all kinds"),
+});
+/**
+ * Registering a channel does not contact it and does not make it deliver anything: a new
+ * channel is unverified, and unverified channels are skipped. Call verify to send it one
+ * message and make it usable.
+ *
+ * A `project` channel is shared with everyone in the project and requires
+ * `notification:channels.manage`. A `user` channel is yours alone.
+ *
+ * The endpoint must be reachable over the public internet. Addresses that resolve to private
+ * or link-local ranges are rejected with `CHANNEL_ENDPOINT_NOT_PUBLIC`, both here and again
+ * at delivery time. Registering an endpoint already registered in the same scope returns
+ * `CHANNEL_DUPLICATE`.
+ *
+ * The submitted endpoint is not returned by this or any other operation.
+ * @summary Register an outbound channel
+ */
+export const CreateUserChannelBody = CreateChannelRequestBody;
+/**
+ * Fields that are omitted are left alone.
+ *
+ * A channel disabled after repeated failures is re-enabled by setting `enabled` to true,
+ * which also clears the failure count. It remains verified, so it starts delivering again
+ * immediately — verify it first if the cause of the failures is not known to be resolved.
+ *
+ * Changing the endpoint is not possible; register a new channel and delete this one.
+ * @summary Rename or re-enable an outbound channel
+ */
+export const UpdateUserChannelParams = zod.strictObject({
+    channelId: zod.uuid().describe("The outbound channel"),
+});
+export const UpdateUserChannelBody = UpdateChannelRequestBody;
+/**
+ * Deleting a channel stops delivery to it and destroys the stored endpoint. Deliveries
+ * already queued for it are abandoned.
+ * @summary Delete an outbound channel
+ */
+export const DeleteUserChannelParams = zod.strictObject({
+    channelId: zod.uuid().describe("The outbound channel"),
+});
+/**
+ * Sends one message to the channel and marks it verified if the endpoint accepted it.
+ *
+ * **The endpoint accepting the message is not proof that it arrived where it was meant to.**
+ * A webhook URL belonging to the wrong group answers exactly the same way. Confirm the
+ * message appeared before relying on the channel.
+ *
+ * A channel that fails verification is not marked verified and continues to be skipped. The
+ * reason is reported in `last_error`; it is the provider's own wording and is not translated.
+ * @summary Verify an outbound channel
+ */
+export const VerifyUserChannelParams = zod.strictObject({
+    channelId: zod.uuid().describe("The outbound channel"),
+});
+/**
+ * Reports whether the credential is still available without consuming it. It never contains
+ * the credential itself.
+ *
+ * A ticket addressed to someone else returns `CREDENTIAL_TICKET_NOT_FOUND`, the same answer
+ * as one that does not exist.
+ * @summary Describe a one-time credential
+ */
+export const DescribeCredentialTicketParams = zod.strictObject({
+    ticketId: zod.uuid().describe("The one-time credential"),
+});
+/**
+ * Returns the credential and destroys it in the same step. **This is the only operation that
+ * ever returns it, and it succeeds only once.**
+ *
+ * Every subsequent request returns `CREDENTIAL_TICKET_CONSUMED`, including one issued
+ * concurrently with the first: exactly one caller receives the credential.
+ *
+ * A ticket that has expired returns `CREDENTIAL_TICKET_EXPIRED`, and one withdrawn by the
+ * service that created it returns `CREDENTIAL_TICKET_REVOKED`. In all three cases the
+ * credential is already gone and cannot be recovered; obtain a new one from the service that
+ * owns the resource.
+ *
+ * This operation is a POST rather than a GET because a GET would be followed by link
+ * scanners in mail clients and by browser prefetching, either of which would consume the
+ * credential before the recipient opened it.
+ * @summary Reveal a one-time credential
+ */
+export const RevealCredentialParams = zod.strictObject({
+    ticketId: zod.uuid().describe("The one-time credential"),
+});
+/**
+ * Authorizes one subscription. Realtime clients call this on their own while subscribing; it
+ * is not normally called directly.
+ *
+ * Only two channels are authorized: the one naming you, and the one naming the project in
+ * the token. Any other channel returns `REALTIME_CHANNEL_FORBIDDEN`.
+ *
+ * **Authorization is evaluated once, when the subscription is established.** A subscription
+ * already open is not revoked when project membership changes, so realtime events carry
+ * identifiers and counts only, never the contents of a notification.
+ * @summary Authorize a realtime channel subscription
+ */
+export const AuthorizeRealtimeChannelBody = AuthorizeRealtimeChannelRequestBody;

package/dist/notification/v1/generated/validators/announcementListResource.zod.d.ts

@@ -0,0 +1,82 @@
+/**
+ * Generated by orval 🍺
+ * Do not edit manually.
+ * Leaflow Notification API
+ * Read the notifications this platform has sent you, and choose where each kind of notification
+ * is delivered.
+ *
+ * Every service on the platform reports events here rather than contacting you directly. This
+ * API is the single place where those events are read, and the single place where delivery is
+ * configured.
+ *
+ * ## Authentication
+ *
+ * Every request carries a scoped token; see the `bearerAuth` security scheme.
+ *
+ * **Neither the path nor the headers carry a `project_id`**: the current project is determined by
+ * the token. Listing operations return everything addressed to you across every project by
+ * default, because a notification is addressed to a person rather than to a project; pass
+ * `scope=current_project` to narrow the result to the project in the token.
+ *
+ * ## Conventions
+ *
+ * - **Notifications are typed, and the type determines who receives it.** A type such as
+ *   `compute.instance.provisioned` is addressed to whoever created the instance, while
+ *   `monitoring.alert.raised` is addressed to every member of the project. The full catalogue is
+ *   available from `GET /api/v1/notification-types` and is stable: a type identifier is never
+ *   reused for a different event.
+ * - **Text is rendered at read time from the language on your preferences.** Changing the
+ *   language changes the text of everything already in the inbox. Messages already delivered by
+ *   email or to an outbound channel are not rewritten, because they have already been sent.
+ * - **Times inside rendered text are stated in UTC and say so.** There is no time zone setting.
+ *   Clients that can determine the reader's time zone should present `created_at`, `occurred_at`
+ *   and the timestamps in `params` — all of which are RFC 3339 — in local time instead. Email
+ *   cannot do this, which is why the text it carries is explicit about being UTC.
+ * - **Some types must reach you, and those cannot be muted or removed from email.** They are
+ *   marked `mandatory` in the catalogue: types you would only find out about by signing in, when
+ *   not finding out costs you something — a suspension, a deletion, a credential that expires.
+ *   Everything else about them is still configurable, including adding channels of your own.
+ * - **Deleting a preference restores the default; it does not turn the type off.** To stop
+ *   receiving a type, set `muted` on it.
+ * - **Outbound channels deliver nothing until they are verified.** Registering a channel does not
+ *   contact it. Verification is a separate operation that sends one message, and only a channel
+ *   that has acknowledged it receives anything afterwards.
+ * - **Channel endpoints are never returned.** No operation, including the one that registers
+ *   them, returns the address that was submitted. A channel entered incorrectly must be deleted
+ *   and registered again.
+ *
+ * ## Rate and volume
+ *
+ * Delivery to outbound channels is limited per channel, and bursts of alerts about one server are
+ * summarised rather than sent individually. Nothing is summarised in the inbox: it always holds
+ * every notification. A notification that was summarised or suppressed is still readable here.
+ *
+ * ## One-time credentials
+ *
+ * Some notifications carry a reference to a credential rather than the credential itself — the
+ * initial password of a newly created instance, for example. That credential is readable exactly
+ * once, expires on its own, and is destroyed as soon as it has been read. Requesting it a second
+ * time returns `CREDENTIAL_TICKET_CONSUMED`.
+ * OpenAPI spec version: 1.0.0
+ */
+import * as zod from "zod";
+export declare const AnnouncementListResource: zod.ZodObject<{
+    items: zod.ZodArray<zod.ZodObject<{
+        id: zod.ZodUUID;
+        title: zod.ZodString;
+        body: zod.ZodString;
+        severity: zod.ZodEnum<{
+            error: "error";
+            info: "info";
+            warning: "warning";
+            critical: "critical";
+        }>;
+        critical: zod.ZodBoolean;
+        published_at: zod.z.ZodISODateTime;
+        expires_at: zod.ZodOptional<zod.ZodNullable<zod.z.ZodISODateTime>>;
+        read_at: zod.ZodOptional<zod.ZodNullable<zod.z.ZodISODateTime>>;
+    }, zod.z.core.$strict>>;
+    unread: zod.ZodInt;
+}, zod.z.core.$strict>;
+export type AnnouncementListResource = zod.input<typeof AnnouncementListResource>;
+export type AnnouncementListResourceOutput = zod.output<typeof AnnouncementListResource>;

package/dist/notification/v1/generated/validators/announcementListResource.zod.js

@@ -0,0 +1,67 @@
+/**
+ * Generated by orval 🍺
+ * Do not edit manually.
+ * Leaflow Notification API
+ * Read the notifications this platform has sent you, and choose where each kind of notification
+ * is delivered.
+ *
+ * Every service on the platform reports events here rather than contacting you directly. This
+ * API is the single place where those events are read, and the single place where delivery is
+ * configured.
+ *
+ * ## Authentication
+ *
+ * Every request carries a scoped token; see the `bearerAuth` security scheme.
+ *
+ * **Neither the path nor the headers carry a `project_id`**: the current project is determined by
+ * the token. Listing operations return everything addressed to you across every project by
+ * default, because a notification is addressed to a person rather than to a project; pass
+ * `scope=current_project` to narrow the result to the project in the token.
+ *
+ * ## Conventions
+ *
+ * - **Notifications are typed, and the type determines who receives it.** A type such as
+ *   `compute.instance.provisioned` is addressed to whoever created the instance, while
+ *   `monitoring.alert.raised` is addressed to every member of the project. The full catalogue is
+ *   available from `GET /api/v1/notification-types` and is stable: a type identifier is never
+ *   reused for a different event.
+ * - **Text is rendered at read time from the language on your preferences.** Changing the
+ *   language changes the text of everything already in the inbox. Messages already delivered by
+ *   email or to an outbound channel are not rewritten, because they have already been sent.
+ * - **Times inside rendered text are stated in UTC and say so.** There is no time zone setting.
+ *   Clients that can determine the reader's time zone should present `created_at`, `occurred_at`
+ *   and the timestamps in `params` — all of which are RFC 3339 — in local time instead. Email
+ *   cannot do this, which is why the text it carries is explicit about being UTC.
+ * - **Some types must reach you, and those cannot be muted or removed from email.** They are
+ *   marked `mandatory` in the catalogue: types you would only find out about by signing in, when
+ *   not finding out costs you something — a suspension, a deletion, a credential that expires.
+ *   Everything else about them is still configurable, including adding channels of your own.
+ * - **Deleting a preference restores the default; it does not turn the type off.** To stop
+ *   receiving a type, set `muted` on it.
+ * - **Outbound channels deliver nothing until they are verified.** Registering a channel does not
+ *   contact it. Verification is a separate operation that sends one message, and only a channel
+ *   that has acknowledged it receives anything afterwards.
+ * - **Channel endpoints are never returned.** No operation, including the one that registers
+ *   them, returns the address that was submitted. A channel entered incorrectly must be deleted
+ *   and registered again.
+ *
+ * ## Rate and volume
+ *
+ * Delivery to outbound channels is limited per channel, and bursts of alerts about one server are
+ * summarised rather than sent individually. Nothing is summarised in the inbox: it always holds
+ * every notification. A notification that was summarised or suppressed is still readable here.
+ *
+ * ## One-time credentials
+ *
+ * Some notifications carry a reference to a credential rather than the credential itself — the
+ * initial password of a newly created instance, for example. That credential is readable exactly
+ * once, expires on its own, and is destroyed as soon as it has been read. Requesting it a second
+ * time returns `CREDENTIAL_TICKET_CONSUMED`.
+ * OpenAPI spec version: 1.0.0
+ */
+import * as zod from "zod";
+import { AnnouncementResource } from "./announcementResource.zod.js";
+export const AnnouncementListResource = zod.strictObject({
+    items: zod.array(AnnouncementResource),
+    unread: zod.int().describe("How many of them you have not read"),
+});

package/dist/notification/v1/generated/validators/announcementReadResultResource.zod.d.ts

@@ -0,0 +1,67 @@
+/**
+ * Generated by orval 🍺
+ * Do not edit manually.
+ * Leaflow Notification API
+ * Read the notifications this platform has sent you, and choose where each kind of notification
+ * is delivered.
+ *
+ * Every service on the platform reports events here rather than contacting you directly. This
+ * API is the single place where those events are read, and the single place where delivery is
+ * configured.
+ *
+ * ## Authentication
+ *
+ * Every request carries a scoped token; see the `bearerAuth` security scheme.
+ *
+ * **Neither the path nor the headers carry a `project_id`**: the current project is determined by
+ * the token. Listing operations return everything addressed to you across every project by
+ * default, because a notification is addressed to a person rather than to a project; pass
+ * `scope=current_project` to narrow the result to the project in the token.
+ *
+ * ## Conventions
+ *
+ * - **Notifications are typed, and the type determines who receives it.** A type such as
+ *   `compute.instance.provisioned` is addressed to whoever created the instance, while
+ *   `monitoring.alert.raised` is addressed to every member of the project. The full catalogue is
+ *   available from `GET /api/v1/notification-types` and is stable: a type identifier is never
+ *   reused for a different event.
+ * - **Text is rendered at read time from the language on your preferences.** Changing the
+ *   language changes the text of everything already in the inbox. Messages already delivered by
+ *   email or to an outbound channel are not rewritten, because they have already been sent.
+ * - **Times inside rendered text are stated in UTC and say so.** There is no time zone setting.
+ *   Clients that can determine the reader's time zone should present `created_at`, `occurred_at`
+ *   and the timestamps in `params` — all of which are RFC 3339 — in local time instead. Email
+ *   cannot do this, which is why the text it carries is explicit about being UTC.
+ * - **Some types must reach you, and those cannot be muted or removed from email.** They are
+ *   marked `mandatory` in the catalogue: types you would only find out about by signing in, when
+ *   not finding out costs you something — a suspension, a deletion, a credential that expires.
+ *   Everything else about them is still configurable, including adding channels of your own.
+ * - **Deleting a preference restores the default; it does not turn the type off.** To stop
+ *   receiving a type, set `muted` on it.
+ * - **Outbound channels deliver nothing until they are verified.** Registering a channel does not
+ *   contact it. Verification is a separate operation that sends one message, and only a channel
+ *   that has acknowledged it receives anything afterwards.
+ * - **Channel endpoints are never returned.** No operation, including the one that registers
+ *   them, returns the address that was submitted. A channel entered incorrectly must be deleted
+ *   and registered again.
+ *
+ * ## Rate and volume
+ *
+ * Delivery to outbound channels is limited per channel, and bursts of alerts about one server are
+ * summarised rather than sent individually. Nothing is summarised in the inbox: it always holds
+ * every notification. A notification that was summarised or suppressed is still readable here.
+ *
+ * ## One-time credentials
+ *
+ * Some notifications carry a reference to a credential rather than the credential itself — the
+ * initial password of a newly created instance, for example. That credential is readable exactly
+ * once, expires on its own, and is destroyed as soon as it has been read. Requesting it a second
+ * time returns `CREDENTIAL_TICKET_CONSUMED`.
+ * OpenAPI spec version: 1.0.0
+ */
+import * as zod from "zod";
+export declare const AnnouncementReadResultResource: zod.ZodObject<{
+    marked: zod.ZodInt;
+}, zod.z.core.$strict>;
+export type AnnouncementReadResultResource = zod.input<typeof AnnouncementReadResultResource>;
+export type AnnouncementReadResultResourceOutput = zod.output<typeof AnnouncementReadResultResource>;