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

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

@@ -0,0 +1,65 @@
+/**
+ * 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 const AnnouncementReadResultResource = zod.strictObject({
+    marked: zod.int().describe("How many this call changed; already-read ones are not counted"),
+});

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

@@ -0,0 +1,79 @@
+/**
+ * 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 AnnouncementResource: 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>;
+export type AnnouncementResource = zod.input<typeof AnnouncementResource>;
+export type AnnouncementResourceOutput = zod.output<typeof AnnouncementResource>;

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

@@ -0,0 +1,85 @@
+/**
+ * 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 { NotificationSeverity } from "./notificationSeverity.zod.js";
+export const AnnouncementResource = zod
+    .strictObject({
+    id: zod.uuid(),
+    title: zod.string(),
+    body: zod
+        .string()
+        .describe("The text as a fragment of HTML, same rules as a notification body"),
+    severity: NotificationSeverity,
+    critical: zod
+        .boolean()
+        .describe('You cannot dismiss this one. It is a property of the announcement rather than a second type, because what the operator judges when writing it is "is this important enough to push", and that is the question this asks.'),
+    published_at: zod.iso.datetime({ offset: true }),
+    expires_at: zod.iso
+        .datetime({ offset: true })
+        .nullish()
+        .describe("When it drops out of this list; null means it stays"),
+    read_at: zod.iso
+        .datetime({ offset: true })
+        .nullish()
+        .describe("When you read it; null means you have not"),
+})
+    .describe("One announcement, with its text in the language on your preferences.");

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

@@ -0,0 +1,70 @@
+/**
+ * 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 authorizeRealtimeChannelRequestBodyChannelNameMax = 255;
+export declare const authorizeRealtimeChannelRequestBodySocketIdMax = 128;
+export declare const AuthorizeRealtimeChannelRequestBody: zod.ZodObject<{
+    channel_name: zod.ZodString;
+    socket_id: zod.ZodString;
+}, zod.z.core.$strict>;
+export type AuthorizeRealtimeChannelRequestBody = zod.input<typeof AuthorizeRealtimeChannelRequestBody>;
+export type AuthorizeRealtimeChannelRequestBodyOutput = zod.output<typeof AuthorizeRealtimeChannelRequestBody>;

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

@@ -0,0 +1,76 @@
+/**
+ * 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 const authorizeRealtimeChannelRequestBodyChannelNameMax = 255;
+export const authorizeRealtimeChannelRequestBodySocketIdMax = 128;
+export const AuthorizeRealtimeChannelRequestBody = zod.strictObject({
+    channel_name: zod
+        .string()
+        .min(1)
+        .max(authorizeRealtimeChannelRequestBodyChannelNameMax)
+        .describe("The channel being subscribed to"),
+    socket_id: zod
+        .string()
+        .min(1)
+        .max(authorizeRealtimeChannelRequestBodySocketIdMax)
+        .describe("The connection identifier the realtime server assigned to this client"),
+});

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

@@ -0,0 +1,70 @@
+/**
+ * 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 ChannelKind: zod.ZodEnum<{
+    lark_webhook: "lark_webhook";
+    wecom_webhook: "wecom_webhook";
+    bark: "bark";
+    generic_webhook: "generic_webhook";
+}>;
+export type ChannelKind = zod.input<typeof ChannelKind>;
+export type ChannelKindOutput = zod.output<typeof ChannelKind>;

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

@@ -0,0 +1,65 @@
+/**
+ * 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 const ChannelKind = zod
+    .enum(["lark_webhook", "wecom_webhook", "bark", "generic_webhook"])
+    .describe("The kind of endpoint, which determines both how the message is shaped and what the\nendpoint is.\n\n`lark_webhook` and `wecom_webhook` are group robot webhook URLs and receive a card.\n`bark` is a Bark server URL including the device key and receives a short line of text.\n`generic_webhook` receives a JSON document and is the option for anything else.");

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

@@ -0,0 +1,91 @@
+/**
+ * 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 ChannelListResponseBody: zod.ZodObject<{
+    items: zod.ZodArray<zod.ZodObject<{
+        channel_scope: zod.ZodEnum<{
+            project: "project";
+            user: "user";
+        }>;
+        consecutive_failures: zod.ZodInt;
+        created_at: zod.z.ZodISODateTime;
+        disabled_at: zod.ZodNullable<zod.z.ZodISODateTime>;
+        disabled_reason: zod.ZodNullable<zod.ZodString>;
+        id: zod.ZodUUID;
+        kind: zod.ZodEnum<{
+            lark_webhook: "lark_webhook";
+            wecom_webhook: "wecom_webhook";
+            bark: "bark";
+            generic_webhook: "generic_webhook";
+        }>;
+        last_error: zod.ZodNullable<zod.ZodString>;
+        last_failure_at: zod.ZodNullable<zod.z.ZodISODateTime>;
+        last_success_at: zod.ZodNullable<zod.z.ZodISODateTime>;
+        name: zod.ZodString;
+        project_id: zod.ZodNullable<zod.ZodUUID>;
+        redacted: zod.ZodString;
+        updated_at: zod.z.ZodISODateTime;
+        verified_at: zod.ZodNullable<zod.z.ZodISODateTime>;
+    }, zod.z.core.$strict>>;
+}, zod.z.core.$strict>;
+export type ChannelListResponseBody = zod.input<typeof ChannelListResponseBody>;
+export type ChannelListResponseBodyOutput = zod.output<typeof ChannelListResponseBody>;