@leaflow/sdk 0.0.0-dev.29.g8fe6a71 → 0.0.0-dev.291.gcde7444

package/dist/support/v1/generated/validators/createTicketRequestBody.zod.d.ts

@@ -0,0 +1,68 @@
+/**
+ * Generated by orval 🍺
+ * Do not edit manually.
+ * Leaflow Support API
+ * Support tickets and scheduled maintenance notices.
+ *
+ * ## Authentication
+ *
+ * Every request carries a scoped token; see the `bearerAuth` security scheme. The single
+ * exception is `GET /api/v1/notices`, which requires no credentials at all.
+ *
+ * **Neither the path nor the headers carry a `project_id`**: the current project is determined by
+ * the token.
+ *
+ * ## Tickets belong to the project
+ *
+ * A ticket is owned by the project it was opened in, not by the person who opened it. Every member
+ * of that project can read it, reply to it and close it. `created_by` records who opened it and is
+ * informational.
+ *
+ * A ticket is in one of three states:
+ *
+ * | State | Meaning |
+ * | --- | --- |
+ * | `OPEN` | Waiting on us |
+ * | `AWAITING_USER` | Waiting on you |
+ * | `CLOSED` | Finished |
+ *
+ * **The state follows whoever spoke last** and cannot be set directly. Posting a message moves the
+ * ticket to `OPEN`; a reply from support moves it to `AWAITING_USER`. Posting a message on a closed
+ * ticket reopens it as `OPEN`, so a follow-up question never lands on a ticket nobody reads.
+ *
+ * Tickets left in `AWAITING_USER` without activity are closed automatically after a period of
+ * inactivity. Tickets in `OPEN` are never closed automatically.
+ *
+ * ## Attachments are uploaded before they are referenced
+ *
+ * Upload a file to `POST /api/v1/attachments`, then pass the returned id in `attachment_ids` when
+ * opening a ticket or posting a message. An attachment that is never referenced is removed after a
+ * time, so upload and reference in the same session.
+ *
+ * The content type is determined from the content itself, not from the `Content-Type` header.
+ * Files whose determined type is not accepted are rejected with `TICKET_ATTACHMENT_TYPE_REJECTED`.
+ *
+ * ## Maintenance is read-only here
+ *
+ * Scheduled maintenance is published by platform operators and is read-only here. Platform
+ * announcements are not part of this API; they are owned by the notification service.
+ * OpenAPI spec version: 1.0.0
+ */
+import * as zod from "zod";
+export declare const createTicketRequestBodyAttachmentIdsMax = 10;
+export declare const createTicketRequestBodyBodyMax = 20000;
+export declare const createTicketRequestBodySubjectMax = 255;
+export declare const CreateTicketRequestBody: zod.ZodObject<{
+    attachment_ids: zod.ZodOptional<zod.ZodArray<zod.ZodUUID>>;
+    body: zod.ZodString;
+    category_id: zod.ZodOptional<zod.ZodUUID>;
+    priority: zod.ZodOptional<zod.ZodEnum<{
+        HIGH: "HIGH";
+        LOW: "LOW";
+        NORMAL: "NORMAL";
+        URGENT: "URGENT";
+    }>>;
+    subject: zod.ZodString;
+}, zod.z.core.$strict>;
+export type CreateTicketRequestBody = zod.input<typeof CreateTicketRequestBody>;
+export type CreateTicketRequestBodyOutput = zod.output<typeof CreateTicketRequestBody>;

package/dist/support/v1/generated/validators/createTicketRequestBody.zod.js

@@ -0,0 +1,70 @@
+/**
+ * Generated by orval 🍺
+ * Do not edit manually.
+ * Leaflow Support API
+ * Support tickets and scheduled maintenance notices.
+ *
+ * ## Authentication
+ *
+ * Every request carries a scoped token; see the `bearerAuth` security scheme. The single
+ * exception is `GET /api/v1/notices`, which requires no credentials at all.
+ *
+ * **Neither the path nor the headers carry a `project_id`**: the current project is determined by
+ * the token.
+ *
+ * ## Tickets belong to the project
+ *
+ * A ticket is owned by the project it was opened in, not by the person who opened it. Every member
+ * of that project can read it, reply to it and close it. `created_by` records who opened it and is
+ * informational.
+ *
+ * A ticket is in one of three states:
+ *
+ * | State | Meaning |
+ * | --- | --- |
+ * | `OPEN` | Waiting on us |
+ * | `AWAITING_USER` | Waiting on you |
+ * | `CLOSED` | Finished |
+ *
+ * **The state follows whoever spoke last** and cannot be set directly. Posting a message moves the
+ * ticket to `OPEN`; a reply from support moves it to `AWAITING_USER`. Posting a message on a closed
+ * ticket reopens it as `OPEN`, so a follow-up question never lands on a ticket nobody reads.
+ *
+ * Tickets left in `AWAITING_USER` without activity are closed automatically after a period of
+ * inactivity. Tickets in `OPEN` are never closed automatically.
+ *
+ * ## Attachments are uploaded before they are referenced
+ *
+ * Upload a file to `POST /api/v1/attachments`, then pass the returned id in `attachment_ids` when
+ * opening a ticket or posting a message. An attachment that is never referenced is removed after a
+ * time, so upload and reference in the same session.
+ *
+ * The content type is determined from the content itself, not from the `Content-Type` header.
+ * Files whose determined type is not accepted are rejected with `TICKET_ATTACHMENT_TYPE_REJECTED`.
+ *
+ * ## Maintenance is read-only here
+ *
+ * Scheduled maintenance is published by platform operators and is read-only here. Platform
+ * announcements are not part of this API; they are owned by the notification service.
+ * OpenAPI spec version: 1.0.0
+ */
+import * as zod from "zod";
+import { TicketPriority } from "./ticketPriority.zod.js";
+export const createTicketRequestBodyAttachmentIdsMax = 10;
+export const createTicketRequestBodyBodyMax = 20000;
+export const createTicketRequestBodySubjectMax = 255;
+export const CreateTicketRequestBody = zod.strictObject({
+    attachment_ids: zod
+        .array(zod.uuid())
+        .max(createTicketRequestBodyAttachmentIdsMax)
+        .optional()
+        .describe("Attachments to reference from the first message. Each must have been uploaded in this project and not yet referenced"),
+    body: zod
+        .string()
+        .min(1)
+        .max(createTicketRequestBodyBodyMax)
+        .describe("The first message. Markdown"),
+    category_id: zod.uuid().optional(),
+    priority: TicketPriority.optional(),
+    subject: zod.string().min(1).max(createTicketRequestBodySubjectMax),
+});

package/dist/support/v1/generated/validators/createTicketSatisfactionRequestBody.zod.d.ts

@@ -0,0 +1,59 @@
+/**
+ * Generated by orval 🍺
+ * Do not edit manually.
+ * Leaflow Support API
+ * Support tickets and scheduled maintenance notices.
+ *
+ * ## Authentication
+ *
+ * Every request carries a scoped token; see the `bearerAuth` security scheme. The single
+ * exception is `GET /api/v1/notices`, which requires no credentials at all.
+ *
+ * **Neither the path nor the headers carry a `project_id`**: the current project is determined by
+ * the token.
+ *
+ * ## Tickets belong to the project
+ *
+ * A ticket is owned by the project it was opened in, not by the person who opened it. Every member
+ * of that project can read it, reply to it and close it. `created_by` records who opened it and is
+ * informational.
+ *
+ * A ticket is in one of three states:
+ *
+ * | State | Meaning |
+ * | --- | --- |
+ * | `OPEN` | Waiting on us |
+ * | `AWAITING_USER` | Waiting on you |
+ * | `CLOSED` | Finished |
+ *
+ * **The state follows whoever spoke last** and cannot be set directly. Posting a message moves the
+ * ticket to `OPEN`; a reply from support moves it to `AWAITING_USER`. Posting a message on a closed
+ * ticket reopens it as `OPEN`, so a follow-up question never lands on a ticket nobody reads.
+ *
+ * Tickets left in `AWAITING_USER` without activity are closed automatically after a period of
+ * inactivity. Tickets in `OPEN` are never closed automatically.
+ *
+ * ## Attachments are uploaded before they are referenced
+ *
+ * Upload a file to `POST /api/v1/attachments`, then pass the returned id in `attachment_ids` when
+ * opening a ticket or posting a message. An attachment that is never referenced is removed after a
+ * time, so upload and reference in the same session.
+ *
+ * The content type is determined from the content itself, not from the `Content-Type` header.
+ * Files whose determined type is not accepted are rejected with `TICKET_ATTACHMENT_TYPE_REJECTED`.
+ *
+ * ## Maintenance is read-only here
+ *
+ * Scheduled maintenance is published by platform operators and is read-only here. Platform
+ * announcements are not part of this API; they are owned by the notification service.
+ * OpenAPI spec version: 1.0.0
+ */
+import * as zod from "zod";
+export declare const createTicketSatisfactionRequestBodyCommentMax = 2000;
+export declare const createTicketSatisfactionRequestBodyScoreMax = 5;
+export declare const CreateTicketSatisfactionRequestBody: zod.ZodObject<{
+    comment: zod.ZodOptional<zod.ZodString>;
+    score: zod.ZodInt;
+}, zod.z.core.$strict>;
+export type CreateTicketSatisfactionRequestBody = zod.input<typeof CreateTicketSatisfactionRequestBody>;
+export type CreateTicketSatisfactionRequestBodyOutput = zod.output<typeof CreateTicketSatisfactionRequestBody>;

package/dist/support/v1/generated/validators/createTicketSatisfactionRequestBody.zod.js

@@ -0,0 +1,57 @@
+/**
+ * Generated by orval 🍺
+ * Do not edit manually.
+ * Leaflow Support API
+ * Support tickets and scheduled maintenance notices.
+ *
+ * ## Authentication
+ *
+ * Every request carries a scoped token; see the `bearerAuth` security scheme. The single
+ * exception is `GET /api/v1/notices`, which requires no credentials at all.
+ *
+ * **Neither the path nor the headers carry a `project_id`**: the current project is determined by
+ * the token.
+ *
+ * ## Tickets belong to the project
+ *
+ * A ticket is owned by the project it was opened in, not by the person who opened it. Every member
+ * of that project can read it, reply to it and close it. `created_by` records who opened it and is
+ * informational.
+ *
+ * A ticket is in one of three states:
+ *
+ * | State | Meaning |
+ * | --- | --- |
+ * | `OPEN` | Waiting on us |
+ * | `AWAITING_USER` | Waiting on you |
+ * | `CLOSED` | Finished |
+ *
+ * **The state follows whoever spoke last** and cannot be set directly. Posting a message moves the
+ * ticket to `OPEN`; a reply from support moves it to `AWAITING_USER`. Posting a message on a closed
+ * ticket reopens it as `OPEN`, so a follow-up question never lands on a ticket nobody reads.
+ *
+ * Tickets left in `AWAITING_USER` without activity are closed automatically after a period of
+ * inactivity. Tickets in `OPEN` are never closed automatically.
+ *
+ * ## Attachments are uploaded before they are referenced
+ *
+ * Upload a file to `POST /api/v1/attachments`, then pass the returned id in `attachment_ids` when
+ * opening a ticket or posting a message. An attachment that is never referenced is removed after a
+ * time, so upload and reference in the same session.
+ *
+ * The content type is determined from the content itself, not from the `Content-Type` header.
+ * Files whose determined type is not accepted are rejected with `TICKET_ATTACHMENT_TYPE_REJECTED`.
+ *
+ * ## Maintenance is read-only here
+ *
+ * Scheduled maintenance is published by platform operators and is read-only here. Platform
+ * announcements are not part of this API; they are owned by the notification service.
+ * OpenAPI spec version: 1.0.0
+ */
+import * as zod from "zod";
+export const createTicketSatisfactionRequestBodyCommentMax = 2000;
+export const createTicketSatisfactionRequestBodyScoreMax = 5;
+export const CreateTicketSatisfactionRequestBody = zod.strictObject({
+    comment: zod.string().max(createTicketSatisfactionRequestBodyCommentMax).optional(),
+    score: zod.int().min(1).max(createTicketSatisfactionRequestBodyScoreMax),
+});

package/dist/support/v1/generated/validators/cursorPagination.zod.d.ts

@@ -0,0 +1,57 @@
+/**
+ * Generated by orval 🍺
+ * Do not edit manually.
+ * Leaflow Support API
+ * Support tickets and scheduled maintenance notices.
+ *
+ * ## Authentication
+ *
+ * Every request carries a scoped token; see the `bearerAuth` security scheme. The single
+ * exception is `GET /api/v1/notices`, which requires no credentials at all.
+ *
+ * **Neither the path nor the headers carry a `project_id`**: the current project is determined by
+ * the token.
+ *
+ * ## Tickets belong to the project
+ *
+ * A ticket is owned by the project it was opened in, not by the person who opened it. Every member
+ * of that project can read it, reply to it and close it. `created_by` records who opened it and is
+ * informational.
+ *
+ * A ticket is in one of three states:
+ *
+ * | State | Meaning |
+ * | --- | --- |
+ * | `OPEN` | Waiting on us |
+ * | `AWAITING_USER` | Waiting on you |
+ * | `CLOSED` | Finished |
+ *
+ * **The state follows whoever spoke last** and cannot be set directly. Posting a message moves the
+ * ticket to `OPEN`; a reply from support moves it to `AWAITING_USER`. Posting a message on a closed
+ * ticket reopens it as `OPEN`, so a follow-up question never lands on a ticket nobody reads.
+ *
+ * Tickets left in `AWAITING_USER` without activity are closed automatically after a period of
+ * inactivity. Tickets in `OPEN` are never closed automatically.
+ *
+ * ## Attachments are uploaded before they are referenced
+ *
+ * Upload a file to `POST /api/v1/attachments`, then pass the returned id in `attachment_ids` when
+ * opening a ticket or posting a message. An attachment that is never referenced is removed after a
+ * time, so upload and reference in the same session.
+ *
+ * The content type is determined from the content itself, not from the `Content-Type` header.
+ * Files whose determined type is not accepted are rejected with `TICKET_ATTACHMENT_TYPE_REJECTED`.
+ *
+ * ## Maintenance is read-only here
+ *
+ * Scheduled maintenance is published by platform operators and is read-only here. Platform
+ * announcements are not part of this API; they are owned by the notification service.
+ * OpenAPI spec version: 1.0.0
+ */
+import * as zod from "zod";
+export declare const CursorPagination: zod.ZodObject<{
+    page_size: zod.ZodInt;
+    next_cursor: zod.ZodOptional<zod.ZodNullable<zod.ZodString>>;
+}, zod.z.core.$strict>;
+export type CursorPagination = zod.input<typeof CursorPagination>;
+export type CursorPaginationOutput = zod.output<typeof CursorPagination>;

package/dist/support/v1/generated/validators/cursorPagination.zod.js

@@ -0,0 +1,57 @@
+/**
+ * Generated by orval 🍺
+ * Do not edit manually.
+ * Leaflow Support API
+ * Support tickets and scheduled maintenance notices.
+ *
+ * ## Authentication
+ *
+ * Every request carries a scoped token; see the `bearerAuth` security scheme. The single
+ * exception is `GET /api/v1/notices`, which requires no credentials at all.
+ *
+ * **Neither the path nor the headers carry a `project_id`**: the current project is determined by
+ * the token.
+ *
+ * ## Tickets belong to the project
+ *
+ * A ticket is owned by the project it was opened in, not by the person who opened it. Every member
+ * of that project can read it, reply to it and close it. `created_by` records who opened it and is
+ * informational.
+ *
+ * A ticket is in one of three states:
+ *
+ * | State | Meaning |
+ * | --- | --- |
+ * | `OPEN` | Waiting on us |
+ * | `AWAITING_USER` | Waiting on you |
+ * | `CLOSED` | Finished |
+ *
+ * **The state follows whoever spoke last** and cannot be set directly. Posting a message moves the
+ * ticket to `OPEN`; a reply from support moves it to `AWAITING_USER`. Posting a message on a closed
+ * ticket reopens it as `OPEN`, so a follow-up question never lands on a ticket nobody reads.
+ *
+ * Tickets left in `AWAITING_USER` without activity are closed automatically after a period of
+ * inactivity. Tickets in `OPEN` are never closed automatically.
+ *
+ * ## Attachments are uploaded before they are referenced
+ *
+ * Upload a file to `POST /api/v1/attachments`, then pass the returned id in `attachment_ids` when
+ * opening a ticket or posting a message. An attachment that is never referenced is removed after a
+ * time, so upload and reference in the same session.
+ *
+ * The content type is determined from the content itself, not from the `Content-Type` header.
+ * Files whose determined type is not accepted are rejected with `TICKET_ATTACHMENT_TYPE_REJECTED`.
+ *
+ * ## Maintenance is read-only here
+ *
+ * Scheduled maintenance is published by platform operators and is read-only here. Platform
+ * announcements are not part of this API; they are owned by the notification service.
+ * OpenAPI spec version: 1.0.0
+ */
+import * as zod from "zod";
+export const CursorPagination = zod
+    .strictObject({
+    page_size: zod.int().min(1),
+    next_cursor: zod.string().nullish(),
+})
+    .describe("Pagination metadata for keyset traversal. Pass next_cursor as cursor to read the following page; null means there is no following page.");

package/dist/support/v1/generated/validators/downloadAttachmentParams.zod.d.ts

@@ -0,0 +1,56 @@
+/**
+ * Generated by orval 🍺
+ * Do not edit manually.
+ * Leaflow Support API
+ * Support tickets and scheduled maintenance notices.
+ *
+ * ## Authentication
+ *
+ * Every request carries a scoped token; see the `bearerAuth` security scheme. The single
+ * exception is `GET /api/v1/notices`, which requires no credentials at all.
+ *
+ * **Neither the path nor the headers carry a `project_id`**: the current project is determined by
+ * the token.
+ *
+ * ## Tickets belong to the project
+ *
+ * A ticket is owned by the project it was opened in, not by the person who opened it. Every member
+ * of that project can read it, reply to it and close it. `created_by` records who opened it and is
+ * informational.
+ *
+ * A ticket is in one of three states:
+ *
+ * | State | Meaning |
+ * | --- | --- |
+ * | `OPEN` | Waiting on us |
+ * | `AWAITING_USER` | Waiting on you |
+ * | `CLOSED` | Finished |
+ *
+ * **The state follows whoever spoke last** and cannot be set directly. Posting a message moves the
+ * ticket to `OPEN`; a reply from support moves it to `AWAITING_USER`. Posting a message on a closed
+ * ticket reopens it as `OPEN`, so a follow-up question never lands on a ticket nobody reads.
+ *
+ * Tickets left in `AWAITING_USER` without activity are closed automatically after a period of
+ * inactivity. Tickets in `OPEN` are never closed automatically.
+ *
+ * ## Attachments are uploaded before they are referenced
+ *
+ * Upload a file to `POST /api/v1/attachments`, then pass the returned id in `attachment_ids` when
+ * opening a ticket or posting a message. An attachment that is never referenced is removed after a
+ * time, so upload and reference in the same session.
+ *
+ * The content type is determined from the content itself, not from the `Content-Type` header.
+ * Files whose determined type is not accepted are rejected with `TICKET_ATTACHMENT_TYPE_REJECTED`.
+ *
+ * ## Maintenance is read-only here
+ *
+ * Scheduled maintenance is published by platform operators and is read-only here. Platform
+ * announcements are not part of this API; they are owned by the notification service.
+ * OpenAPI spec version: 1.0.0
+ */
+import * as zod from "zod";
+export declare const DownloadAttachmentParams: zod.ZodObject<{
+    inline: zod.ZodOptional<zod.ZodBoolean>;
+}, zod.z.core.$strict>;
+export type DownloadAttachmentParams = zod.input<typeof DownloadAttachmentParams>;
+export type DownloadAttachmentParamsOutput = zod.output<typeof DownloadAttachmentParams>;

package/dist/support/v1/generated/validators/downloadAttachmentParams.zod.js

@@ -0,0 +1,54 @@
+/**
+ * Generated by orval 🍺
+ * Do not edit manually.
+ * Leaflow Support API
+ * Support tickets and scheduled maintenance notices.
+ *
+ * ## Authentication
+ *
+ * Every request carries a scoped token; see the `bearerAuth` security scheme. The single
+ * exception is `GET /api/v1/notices`, which requires no credentials at all.
+ *
+ * **Neither the path nor the headers carry a `project_id`**: the current project is determined by
+ * the token.
+ *
+ * ## Tickets belong to the project
+ *
+ * A ticket is owned by the project it was opened in, not by the person who opened it. Every member
+ * of that project can read it, reply to it and close it. `created_by` records who opened it and is
+ * informational.
+ *
+ * A ticket is in one of three states:
+ *
+ * | State | Meaning |
+ * | --- | --- |
+ * | `OPEN` | Waiting on us |
+ * | `AWAITING_USER` | Waiting on you |
+ * | `CLOSED` | Finished |
+ *
+ * **The state follows whoever spoke last** and cannot be set directly. Posting a message moves the
+ * ticket to `OPEN`; a reply from support moves it to `AWAITING_USER`. Posting a message on a closed
+ * ticket reopens it as `OPEN`, so a follow-up question never lands on a ticket nobody reads.
+ *
+ * Tickets left in `AWAITING_USER` without activity are closed automatically after a period of
+ * inactivity. Tickets in `OPEN` are never closed automatically.
+ *
+ * ## Attachments are uploaded before they are referenced
+ *
+ * Upload a file to `POST /api/v1/attachments`, then pass the returned id in `attachment_ids` when
+ * opening a ticket or posting a message. An attachment that is never referenced is removed after a
+ * time, so upload and reference in the same session.
+ *
+ * The content type is determined from the content itself, not from the `Content-Type` header.
+ * Files whose determined type is not accepted are rejected with `TICKET_ATTACHMENT_TYPE_REJECTED`.
+ *
+ * ## Maintenance is read-only here
+ *
+ * Scheduled maintenance is published by platform operators and is read-only here. Platform
+ * announcements are not part of this API; they are owned by the notification service.
+ * OpenAPI spec version: 1.0.0
+ */
+import * as zod from "zod";
+export const DownloadAttachmentParams = zod.strictObject({
+    inline: zod.boolean().optional(),
+});

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

@@ -0,0 +1,59 @@
+/**
+ * Generated by orval 🍺
+ * Do not edit manually.
+ * Leaflow Support API
+ * Support tickets and scheduled maintenance notices.
+ *
+ * ## Authentication
+ *
+ * Every request carries a scoped token; see the `bearerAuth` security scheme. The single
+ * exception is `GET /api/v1/notices`, which requires no credentials at all.
+ *
+ * **Neither the path nor the headers carry a `project_id`**: the current project is determined by
+ * the token.
+ *
+ * ## Tickets belong to the project
+ *
+ * A ticket is owned by the project it was opened in, not by the person who opened it. Every member
+ * of that project can read it, reply to it and close it. `created_by` records who opened it and is
+ * informational.
+ *
+ * A ticket is in one of three states:
+ *
+ * | State | Meaning |
+ * | --- | --- |
+ * | `OPEN` | Waiting on us |
+ * | `AWAITING_USER` | Waiting on you |
+ * | `CLOSED` | Finished |
+ *
+ * **The state follows whoever spoke last** and cannot be set directly. Posting a message moves the
+ * ticket to `OPEN`; a reply from support moves it to `AWAITING_USER`. Posting a message on a closed
+ * ticket reopens it as `OPEN`, so a follow-up question never lands on a ticket nobody reads.
+ *
+ * Tickets left in `AWAITING_USER` without activity are closed automatically after a period of
+ * inactivity. Tickets in `OPEN` are never closed automatically.
+ *
+ * ## Attachments are uploaded before they are referenced
+ *
+ * Upload a file to `POST /api/v1/attachments`, then pass the returned id in `attachment_ids` when
+ * opening a ticket or posting a message. An attachment that is never referenced is removed after a
+ * time, so upload and reference in the same session.
+ *
+ * The content type is determined from the content itself, not from the `Content-Type` header.
+ * Files whose determined type is not accepted are rejected with `TICKET_ATTACHMENT_TYPE_REJECTED`.
+ *
+ * ## Maintenance is read-only here
+ *
+ * Scheduled maintenance is published by platform operators and is read-only here. Platform
+ * announcements are not part of this API; they are owned by the notification service.
+ * OpenAPI spec version: 1.0.0
+ */
+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;
+}, zod.z.core.$strict>;
+export type Error = zod.input<typeof Error>;
+export type ErrorOutput = zod.output<typeof Error>;

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

@@ -0,0 +1,60 @@
+/**
+ * Generated by orval 🍺
+ * Do not edit manually.
+ * Leaflow Support API
+ * Support tickets and scheduled maintenance notices.
+ *
+ * ## Authentication
+ *
+ * Every request carries a scoped token; see the `bearerAuth` security scheme. The single
+ * exception is `GET /api/v1/notices`, which requires no credentials at all.
+ *
+ * **Neither the path nor the headers carry a `project_id`**: the current project is determined by
+ * the token.
+ *
+ * ## Tickets belong to the project
+ *
+ * A ticket is owned by the project it was opened in, not by the person who opened it. Every member
+ * of that project can read it, reply to it and close it. `created_by` records who opened it and is
+ * informational.
+ *
+ * A ticket is in one of three states:
+ *
+ * | State | Meaning |
+ * | --- | --- |
+ * | `OPEN` | Waiting on us |
+ * | `AWAITING_USER` | Waiting on you |
+ * | `CLOSED` | Finished |
+ *
+ * **The state follows whoever spoke last** and cannot be set directly. Posting a message moves the
+ * ticket to `OPEN`; a reply from support moves it to `AWAITING_USER`. Posting a message on a closed
+ * ticket reopens it as `OPEN`, so a follow-up question never lands on a ticket nobody reads.
+ *
+ * Tickets left in `AWAITING_USER` without activity are closed automatically after a period of
+ * inactivity. Tickets in `OPEN` are never closed automatically.
+ *
+ * ## Attachments are uploaded before they are referenced
+ *
+ * Upload a file to `POST /api/v1/attachments`, then pass the returned id in `attachment_ids` when
+ * opening a ticket or posting a message. An attachment that is never referenced is removed after a
+ * time, so upload and reference in the same session.
+ *
+ * The content type is determined from the content itself, not from the `Content-Type` header.
+ * Files whose determined type is not accepted are rejected with `TICKET_ATTACHMENT_TYPE_REJECTED`.
+ *
+ * ## Maintenance is read-only here
+ *
+ * Scheduled maintenance is published by platform operators and is read-only here. Platform
+ * announcements are not part of this API; they are owned by the notification service.
+ * 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(),
+});