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

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

@@ -0,0 +1,64 @@
+/**
+ * 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 { MaintenanceImpact } from "./maintenanceImpact.zod.js";
+import { MaintenanceStatus } from "./maintenanceStatus.zod.js";
+export const NoticeMaintenanceResource = zod.strictObject({
+    body: zod.string().describe("Markdown"),
+    components: zod.array(zod.string()),
+    id: zod.uuid(),
+    impact: MaintenanceImpact,
+    scheduled_for: zod.iso.datetime({ offset: true }),
+    scheduled_until: zod.iso.datetime({ offset: true }),
+    started_at: zod.iso.datetime({ offset: true }).nullable(),
+    status: MaintenanceStatus,
+    title: zod.string(),
+});

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

@@ -0,0 +1,76 @@
+/**
+ * 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 NoticeResource: zod.ZodObject<{
+    maintenances: zod.ZodArray<zod.ZodObject<{
+        body: zod.ZodString;
+        components: zod.ZodArray<zod.ZodString>;
+        id: zod.ZodUUID;
+        impact: zod.ZodEnum<{
+            PARTIAL_OUTAGE: "PARTIAL_OUTAGE";
+            MAJOR_OUTAGE: "MAJOR_OUTAGE";
+            NONE: "NONE";
+            DEGRADED: "DEGRADED";
+        }>;
+        scheduled_for: zod.z.ZodISODateTime;
+        scheduled_until: zod.z.ZodISODateTime;
+        started_at: zod.ZodNullable<zod.z.ZodISODateTime>;
+        status: zod.ZodEnum<{
+            SCHEDULED: "SCHEDULED";
+            IN_PROGRESS: "IN_PROGRESS";
+            COMPLETED: "COMPLETED";
+            CANCELLED: "CANCELLED";
+        }>;
+        title: zod.ZodString;
+    }, zod.z.core.$strict>>;
+}, zod.z.core.$strict>;
+export type NoticeResource = zod.input<typeof NoticeResource>;
+export type NoticeResourceOutput = zod.output<typeof NoticeResource>;

package/dist/support/v1/generated/validators/noticeResource.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";
+import { NoticeMaintenanceResource } from "./noticeMaintenanceResource.zod.js";
+export const NoticeResource = zod
+    .strictObject({
+    maintenances: zod.array(NoticeMaintenanceResource),
+})
+    .describe("What is in effect right now, for readers who have not signed in.\n\nThis shape is deliberately narrower than the authenticated resources and carries no read\nstate.");

package/dist/support/v1/generated/validators/offsetPagination.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 offsetPaginationTotalCountMin = 0;
+export declare const OffsetPagination: zod.ZodObject<{
+    page: zod.ZodInt;
+    page_size: zod.ZodInt;
+    total_count: zod.ZodOptional<zod.ZodInt>;
+}, zod.z.core.$strict>;
+export type OffsetPagination = zod.input<typeof OffsetPagination>;
+export type OffsetPaginationOutput = zod.output<typeof OffsetPagination>;

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

@@ -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 const offsetPaginationTotalCountMin = 0;
+export const OffsetPagination = zod
+    .strictObject({
+    page: zod.int().min(1),
+    page_size: zod.int().min(1),
+    total_count: zod.int().min(offsetPaginationTotalCountMin).optional(),
+})
+    .describe("Pagination metadata for stable numbered pages. total_count is returned only when the operation can determine it without an unbounded scan.");

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

@@ -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 declare const TicketAttachmentResource: zod.ZodObject<{
+    content_type: zod.ZodString;
+    created_at: zod.z.ZodISODateTime;
+    filename: zod.ZodString;
+    id: zod.ZodUUID;
+    size_bytes: zod.ZodInt;
+}, zod.z.core.$strict>;
+export type TicketAttachmentResource = zod.input<typeof TicketAttachmentResource>;
+export type TicketAttachmentResourceOutput = zod.output<typeof TicketAttachmentResource>;

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

@@ -0,0 +1,62 @@
+/**
+ * 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 TicketAttachmentResource = zod
+    .strictObject({
+    content_type: zod
+        .string()
+        .describe("Determined from the content, which may differ from the Content-Type sent on upload"),
+    created_at: zod.iso.datetime({ offset: true }),
+    filename: zod.string(),
+    id: zod.uuid(),
+    size_bytes: zod.int(),
+})
+    .describe("A file uploaded for a ticket. The bytes are retrieved separately; see the download-url operation.");

package/dist/support/v1/generated/validators/ticketAuthorType.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 TicketAuthorType: zod.ZodEnum<{
+    OPERATOR: "OPERATOR";
+    USER: "USER";
+}>;
+export type TicketAuthorType = zod.input<typeof TicketAuthorType>;
+export type TicketAuthorTypeOutput = zod.output<typeof TicketAuthorType>;

package/dist/support/v1/generated/validators/ticketAuthorType.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 TicketAuthorType = zod
+    .enum(["USER", "OPERATOR"])
+    .describe("Whether a message was written by a project member or by support.");

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

@@ -0,0 +1,58 @@
+/**
+ * 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 TicketCategoryResource: zod.ZodObject<{
+    description: zod.ZodNullable<zod.ZodString>;
+    id: zod.ZodUUID;
+    name: zod.ZodString;
+}, zod.z.core.$strict>;
+export type TicketCategoryResource = zod.input<typeof TicketCategoryResource>;
+export type TicketCategoryResourceOutput = zod.output<typeof TicketCategoryResource>;

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

@@ -0,0 +1,58 @@
+/**
+ * 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 TicketCategoryResource = zod
+    .strictObject({
+    description: zod.string().nullable(),
+    id: zod.uuid(),
+    name: zod.string(),
+})
+    .describe("A ticket category.");