@leaflow/sdk 0.172.0 → 0.174.0

package/dist/monitoring/v1/generated/models.d.ts

@@ -18,22 +18,64 @@
  * Enrollment and rotation responses include `tls_psk`. No other endpoint will return it again, so store it immediately. If it is lost, rotate once more — at the cost of updating the agent configuration on the monitored machine.
  * OpenAPI spec version: 1.0.0
  */
+export interface FieldViolation {
+    /** The path to the rejected field in the request body, such as `items[2].price_id`. */
+    field: string;
+    /** Why the field was rejected, such as `REQUIRED` or `OUT_OF_RANGE`. */
+    reason?: string;
+}
 /**
- * What a given `code` carries alongside the message. The keys depend on the code,
- * and a client that does not recognise one ignores it.
+ * Values that belong to `reason`, one set per reason. Clients use them to fill in
+ * localized text and never parse `message` to obtain them. Keys are documented per
+ * reason; a key that has appeared once keeps appearing.
  */
-export type ErrorMeta = {
-    [key: string]: unknown;
+export type ErrorStatusMetadata = {
+    [key: string]: string;
 };
-export interface Error {
-    code?: string;
+export interface ErrorStatus {
+    /** The HTTP status code of the response. */
+    code: number;
+    /** The canonical name of the status, such as `INVALID_ARGUMENT` or `UNAVAILABLE`. */
+    status: string;
+    /**
+     * A description of the failure for developers. It is always English and is not meant
+     * to be shown to end users as is.
+     */
     message: string;
     /**
-     * What a given `code` carries alongside the message. The keys depend on the code,
-     * and a client that does not recognise one ignores it.
+     * A stable machine-readable code identifying the failure. Clients branch on this value
+     * and render their own text; it does not change once published.
+     */
+    reason?: string;
+    /**
+     * Values that belong to `reason`, one set per reason. Clients use them to fill in
+     * localized text and never parse `message` to obtain them. Keys are documented per
+     * reason; a key that has appeared once keeps appearing.
+     */
+    metadata?: ErrorStatusMetadata;
+    /**
+     * Request fields rejected by the request's constraints. Present on validation
+     * failures; one request may violate several fields.
      */
-    meta?: ErrorMeta;
-    status: number;
+    field_violations?: FieldViolation[];
+    /**
+     * How long the client should wait before retrying, as a duration string such as
+     * `30s`. Present only when waiting can succeed.
+     */
+    retry_delay?: string;
+    /**
+     * The identifier of the request in the service's logs. Quote it when reporting a
+     * failure.
+     */
+    request_id?: string;
+}
+/**
+ * A failed request. The envelope follows the Google REST error format: `code` is the HTTP
+ * status, `status` is its canonical name, and `reason` is the stable machine-readable code
+ * that identifies the failure.
+ */
+export interface Error {
+    error: ErrorStatus;
 }
 export interface IncidentFollowerResource {
     display_name: string;

package/dist/monitoring/v1/generated/validators/error.zod.d.ts

@@ -20,10 +20,19 @@
  */
 import * as zod from "zod";
 export declare const Error: zod.ZodObject<{
-    code: zod.ZodOptional<zod.ZodString>;
-    message: zod.ZodString;
-    meta: zod.ZodOptional<zod.ZodRecord<zod.ZodString, zod.ZodUnknown>>;
-    status: zod.ZodInt;
+    error: zod.ZodObject<{
+        code: zod.ZodInt;
+        status: zod.ZodString;
+        message: zod.ZodString;
+        reason: zod.ZodOptional<zod.ZodString>;
+        metadata: zod.ZodOptional<zod.ZodRecord<zod.ZodString, zod.ZodString>>;
+        field_violations: zod.ZodOptional<zod.ZodArray<zod.ZodObject<{
+            field: zod.ZodString;
+            reason: zod.ZodOptional<zod.ZodString>;
+        }, zod.z.core.$strict>>>;
+        retry_delay: zod.ZodOptional<zod.ZodString>;
+        request_id: zod.ZodOptional<zod.ZodString>;
+    }, zod.z.core.$strict>;
 }, zod.z.core.$strict>;
 export type Error = zod.input<typeof Error>;
 export type ErrorOutput = zod.output<typeof Error>;

package/dist/monitoring/v1/generated/validators/error.zod.js

@@ -19,12 +19,9 @@
  * OpenAPI spec version: 1.0.0
  */
 import * as zod from "zod";
-export const Error = zod.strictObject({
-    code: zod.string().optional(),
-    message: zod.string(),
-    meta: zod
-        .record(zod.string(), zod.unknown())
-        .optional()
-        .describe("What a given `code` carries alongside the message. The keys depend on the code,\nand a client that does not recognise one ignores it."),
-    status: zod.int(),
-});
+import { ErrorStatus } from "./errorStatus.zod.js";
+export const Error = zod
+    .strictObject({
+    error: ErrorStatus,
+})
+    .describe("A failed request. The envelope follows the Google REST error format: `code` is the HTTP\nstatus, `status` is its canonical name, and `reason` is the stable machine-readable code\nthat identifies the failure.");

package/dist/monitoring/v1/generated/validators/errorStatus.zod.d.ts

@@ -0,0 +1,36 @@
+/**
+ * Generated by orval 🍺
+ * Do not edit manually.
+ * Leaflow Monitoring API
+ * Monitoring for your own project: enroll machines, read metrics, work through incidents, schedule maintenance windows, and set availability targets.
+ *
+ * ## Authentication
+ *
+ * Every request carries a scoped token; see the `bearerAuth` security scheme.
+ *
+ * ## Two distinctions worth keeping straight
+ *
+ * - **Disabling is not deleting.** `POST /servers/{id}/disable` is reversible and preserves all history. `DELETE /servers/{id}` also removes the monitored host, its history and every incident recorded against it, and cannot be undone.
+ * - **Recovery is not closure.** `incident_status` reports whether monitoring considers the problem recovered; `closed_at` reports whether someone has finished handling it. An incident that has not recovered may still be closed as an accepted risk.
+ *
+ * ## The PSK is returned once
+ *
+ * Enrollment and rotation responses include `tls_psk`. No other endpoint will return it again, so store it immediately. If it is lost, rotate once more — at the cost of updating the agent configuration on the monitored machine.
+ * OpenAPI spec version: 1.0.0
+ */
+import * as zod from "zod";
+export declare const ErrorStatus: zod.ZodObject<{
+    code: zod.ZodInt;
+    status: zod.ZodString;
+    message: zod.ZodString;
+    reason: zod.ZodOptional<zod.ZodString>;
+    metadata: zod.ZodOptional<zod.ZodRecord<zod.ZodString, zod.ZodString>>;
+    field_violations: zod.ZodOptional<zod.ZodArray<zod.ZodObject<{
+        field: zod.ZodString;
+        reason: zod.ZodOptional<zod.ZodString>;
+    }, zod.z.core.$strict>>>;
+    retry_delay: zod.ZodOptional<zod.ZodString>;
+    request_id: zod.ZodOptional<zod.ZodString>;
+}, zod.z.core.$strict>;
+export type ErrorStatus = zod.input<typeof ErrorStatus>;
+export type ErrorStatusOutput = zod.output<typeof ErrorStatus>;

package/dist/monitoring/v1/generated/validators/errorStatus.zod.js

@@ -0,0 +1,51 @@
+/**
+ * Generated by orval 🍺
+ * Do not edit manually.
+ * Leaflow Monitoring API
+ * Monitoring for your own project: enroll machines, read metrics, work through incidents, schedule maintenance windows, and set availability targets.
+ *
+ * ## Authentication
+ *
+ * Every request carries a scoped token; see the `bearerAuth` security scheme.
+ *
+ * ## Two distinctions worth keeping straight
+ *
+ * - **Disabling is not deleting.** `POST /servers/{id}/disable` is reversible and preserves all history. `DELETE /servers/{id}` also removes the monitored host, its history and every incident recorded against it, and cannot be undone.
+ * - **Recovery is not closure.** `incident_status` reports whether monitoring considers the problem recovered; `closed_at` reports whether someone has finished handling it. An incident that has not recovered may still be closed as an accepted risk.
+ *
+ * ## The PSK is returned once
+ *
+ * Enrollment and rotation responses include `tls_psk`. No other endpoint will return it again, so store it immediately. If it is lost, rotate once more — at the cost of updating the agent configuration on the monitored machine.
+ * OpenAPI spec version: 1.0.0
+ */
+import * as zod from "zod";
+import { FieldViolation } from "./fieldViolation.zod.js";
+export const ErrorStatus = zod.strictObject({
+    code: zod.int().describe("The HTTP status code of the response."),
+    status: zod
+        .string()
+        .describe("The canonical name of the status, such as `INVALID_ARGUMENT` or `UNAVAILABLE`."),
+    message: zod
+        .string()
+        .describe("A description of the failure for developers. It is always English and is not meant\nto be shown to end users as is."),
+    reason: zod
+        .string()
+        .optional()
+        .describe("A stable machine-readable code identifying the failure. Clients branch on this value\nand render their own text; it does not change once published."),
+    metadata: zod
+        .record(zod.string(), zod.string())
+        .optional()
+        .describe("Values that belong to `reason`, one set per reason. Clients use them to fill in\nlocalized text and never parse `message` to obtain them. Keys are documented per\nreason; a key that has appeared once keeps appearing."),
+    field_violations: zod
+        .array(FieldViolation)
+        .optional()
+        .describe("Request fields rejected by the request's constraints. Present on validation\nfailures; one request may violate several fields."),
+    retry_delay: zod
+        .string()
+        .optional()
+        .describe("How long the client should wait before retrying, as a duration string such as\n`30s`. Present only when waiting can succeed."),
+    request_id: zod
+        .string()
+        .optional()
+        .describe("The identifier of the request in the service's logs. Quote it when reporting a\nfailure."),
+});

package/dist/monitoring/v1/generated/validators/fieldViolation.zod.d.ts

@@ -0,0 +1,27 @@
+/**
+ * Generated by orval 🍺
+ * Do not edit manually.
+ * Leaflow Monitoring API
+ * Monitoring for your own project: enroll machines, read metrics, work through incidents, schedule maintenance windows, and set availability targets.
+ *
+ * ## Authentication
+ *
+ * Every request carries a scoped token; see the `bearerAuth` security scheme.
+ *
+ * ## Two distinctions worth keeping straight
+ *
+ * - **Disabling is not deleting.** `POST /servers/{id}/disable` is reversible and preserves all history. `DELETE /servers/{id}` also removes the monitored host, its history and every incident recorded against it, and cannot be undone.
+ * - **Recovery is not closure.** `incident_status` reports whether monitoring considers the problem recovered; `closed_at` reports whether someone has finished handling it. An incident that has not recovered may still be closed as an accepted risk.
+ *
+ * ## The PSK is returned once
+ *
+ * Enrollment and rotation responses include `tls_psk`. No other endpoint will return it again, so store it immediately. If it is lost, rotate once more — at the cost of updating the agent configuration on the monitored machine.
+ * OpenAPI spec version: 1.0.0
+ */
+import * as zod from "zod";
+export declare const FieldViolation: zod.ZodObject<{
+    field: zod.ZodString;
+    reason: zod.ZodOptional<zod.ZodString>;
+}, zod.z.core.$strict>;
+export type FieldViolation = zod.input<typeof FieldViolation>;
+export type FieldViolationOutput = zod.output<typeof FieldViolation>;

package/dist/monitoring/v1/generated/validators/fieldViolation.zod.js

@@ -0,0 +1,30 @@
+/**
+ * Generated by orval 🍺
+ * Do not edit manually.
+ * Leaflow Monitoring API
+ * Monitoring for your own project: enroll machines, read metrics, work through incidents, schedule maintenance windows, and set availability targets.
+ *
+ * ## Authentication
+ *
+ * Every request carries a scoped token; see the `bearerAuth` security scheme.
+ *
+ * ## Two distinctions worth keeping straight
+ *
+ * - **Disabling is not deleting.** `POST /servers/{id}/disable` is reversible and preserves all history. `DELETE /servers/{id}` also removes the monitored host, its history and every incident recorded against it, and cannot be undone.
+ * - **Recovery is not closure.** `incident_status` reports whether monitoring considers the problem recovered; `closed_at` reports whether someone has finished handling it. An incident that has not recovered may still be closed as an accepted risk.
+ *
+ * ## The PSK is returned once
+ *
+ * Enrollment and rotation responses include `tls_psk`. No other endpoint will return it again, so store it immediately. If it is lost, rotate once more — at the cost of updating the agent configuration on the monitored machine.
+ * OpenAPI spec version: 1.0.0
+ */
+import * as zod from "zod";
+export const FieldViolation = zod.strictObject({
+    field: zod
+        .string()
+        .describe("The path to the rejected field in the request body, such as `items[2].price_id`."),
+    reason: zod
+        .string()
+        .optional()
+        .describe("Why the field was rejected, such as `REQUIRED` or `OUT_OF_RANGE`."),
+});

package/dist/notification/v1/generated/models.d.ts

@@ -59,22 +59,64 @@
  * time returns `CREDENTIAL_TICKET_CONSUMED`.
  * OpenAPI spec version: 1.0.0
  */
+export interface FieldViolation {
+    /** The path to the rejected field in the request body, such as `items[2].price_id`. */
+    field: string;
+    /** Why the field was rejected, such as `REQUIRED` or `OUT_OF_RANGE`. */
+    reason?: string;
+}
 /**
- * What a given `code` carries alongside the message. The keys depend on the code,
- * and a client that does not recognise one ignores it.
+ * Values that belong to `reason`, one set per reason. Clients use them to fill in
+ * localized text and never parse `message` to obtain them. Keys are documented per
+ * reason; a key that has appeared once keeps appearing.
  */
-export type ErrorMeta = {
-    [key: string]: unknown;
+export type ErrorStatusMetadata = {
+    [key: string]: string;
 };
-export interface Error {
-    code?: string;
+export interface ErrorStatus {
+    /** The HTTP status code of the response. */
+    code: number;
+    /** The canonical name of the status, such as `INVALID_ARGUMENT` or `UNAVAILABLE`. */
+    status: string;
+    /**
+     * A description of the failure for developers. It is always English and is not meant
+     * to be shown to end users as is.
+     */
     message: string;
     /**
-     * What a given `code` carries alongside the message. The keys depend on the code,
-     * and a client that does not recognise one ignores it.
+     * A stable machine-readable code identifying the failure. Clients branch on this value
+     * and render their own text; it does not change once published.
+     */
+    reason?: string;
+    /**
+     * Values that belong to `reason`, one set per reason. Clients use them to fill in
+     * localized text and never parse `message` to obtain them. Keys are documented per
+     * reason; a key that has appeared once keeps appearing.
+     */
+    metadata?: ErrorStatusMetadata;
+    /**
+     * Request fields rejected by the request's constraints. Present on validation
+     * failures; one request may violate several fields.
      */
-    meta?: ErrorMeta;
-    status: number;
+    field_violations?: FieldViolation[];
+    /**
+     * How long the client should wait before retrying, as a duration string such as
+     * `30s`. Present only when waiting can succeed.
+     */
+    retry_delay?: string;
+    /**
+     * The identifier of the request in the service's logs. Quote it when reporting a
+     * failure.
+     */
+    request_id?: string;
+}
+/**
+ * A failed request. The envelope follows the Google REST error format: `code` is the HTTP
+ * status, `status` is its canonical name, and `reason` is the stable machine-readable code
+ * that identifies the failure.
+ */
+export interface Error {
+    error: ErrorStatus;
 }
 /**
  * `all` covers every project you belong to as well as notifications that belong to no

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

@@ -61,10 +61,19 @@
  */
 import * as zod from "zod";
 export declare const Error: zod.ZodObject<{
-    code: zod.ZodOptional<zod.ZodString>;
-    message: zod.ZodString;
-    meta: zod.ZodOptional<zod.ZodRecord<zod.ZodString, zod.ZodUnknown>>;
-    status: zod.ZodInt;
+    error: zod.ZodObject<{
+        code: zod.ZodInt;
+        status: zod.ZodString;
+        message: zod.ZodString;
+        reason: zod.ZodOptional<zod.ZodString>;
+        metadata: zod.ZodOptional<zod.ZodRecord<zod.ZodString, zod.ZodString>>;
+        field_violations: zod.ZodOptional<zod.ZodArray<zod.ZodObject<{
+            field: zod.ZodString;
+            reason: zod.ZodOptional<zod.ZodString>;
+        }, zod.z.core.$strict>>>;
+        retry_delay: zod.ZodOptional<zod.ZodString>;
+        request_id: zod.ZodOptional<zod.ZodString>;
+    }, zod.z.core.$strict>;
 }, zod.z.core.$strict>;
 export type Error = zod.input<typeof Error>;
 export type ErrorOutput = zod.output<typeof Error>;

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

@@ -60,12 +60,9 @@
  * OpenAPI spec version: 1.0.0
  */
 import * as zod from "zod";
-export const Error = zod.strictObject({
-    code: zod.string().optional(),
-    message: zod.string(),
-    meta: zod
-        .record(zod.string(), zod.unknown())
-        .optional()
-        .describe("What a given `code` carries alongside the message. The keys depend on the code,\nand a client that does not recognise one ignores it."),
-    status: zod.int(),
-});
+import { ErrorStatus } from "./errorStatus.zod.js";
+export const Error = zod
+    .strictObject({
+    error: ErrorStatus,
+})
+    .describe("A failed request. The envelope follows the Google REST error format: `code` is the HTTP\nstatus, `status` is its canonical name, and `reason` is the stable machine-readable code\nthat identifies the failure.");

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

@@ -0,0 +1,77 @@
+/**
+ * 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 ErrorStatus: zod.ZodObject<{
+    code: zod.ZodInt;
+    status: zod.ZodString;
+    message: zod.ZodString;
+    reason: zod.ZodOptional<zod.ZodString>;
+    metadata: zod.ZodOptional<zod.ZodRecord<zod.ZodString, zod.ZodString>>;
+    field_violations: zod.ZodOptional<zod.ZodArray<zod.ZodObject<{
+        field: zod.ZodString;
+        reason: zod.ZodOptional<zod.ZodString>;
+    }, zod.z.core.$strict>>>;
+    retry_delay: zod.ZodOptional<zod.ZodString>;
+    request_id: zod.ZodOptional<zod.ZodString>;
+}, zod.z.core.$strict>;
+export type ErrorStatus = zod.input<typeof ErrorStatus>;
+export type ErrorStatusOutput = zod.output<typeof ErrorStatus>;

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

@@ -0,0 +1,92 @@
+/**
+ * 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 { FieldViolation } from "./fieldViolation.zod.js";
+export const ErrorStatus = zod.strictObject({
+    code: zod.int().describe("The HTTP status code of the response."),
+    status: zod
+        .string()
+        .describe("The canonical name of the status, such as `INVALID_ARGUMENT` or `UNAVAILABLE`."),
+    message: zod
+        .string()
+        .describe("A description of the failure for developers. It is always English and is not meant\nto be shown to end users as is."),
+    reason: zod
+        .string()
+        .optional()
+        .describe("A stable machine-readable code identifying the failure. Clients branch on this value\nand render their own text; it does not change once published."),
+    metadata: zod
+        .record(zod.string(), zod.string())
+        .optional()
+        .describe("Values that belong to `reason`, one set per reason. Clients use them to fill in\nlocalized text and never parse `message` to obtain them. Keys are documented per\nreason; a key that has appeared once keeps appearing."),
+    field_violations: zod
+        .array(FieldViolation)
+        .optional()
+        .describe("Request fields rejected by the request's constraints. Present on validation\nfailures; one request may violate several fields."),
+    retry_delay: zod
+        .string()
+        .optional()
+        .describe("How long the client should wait before retrying, as a duration string such as\n`30s`. Present only when waiting can succeed."),
+    request_id: zod
+        .string()
+        .optional()
+        .describe("The identifier of the request in the service's logs. Quote it when reporting a\nfailure."),
+});

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

@@ -0,0 +1,68 @@
+/**
+ * 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 FieldViolation: zod.ZodObject<{
+    field: zod.ZodString;
+    reason: zod.ZodOptional<zod.ZodString>;
+}, zod.z.core.$strict>;
+export type FieldViolation = zod.input<typeof FieldViolation>;
+export type FieldViolationOutput = zod.output<typeof FieldViolation>;