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

package/dist/support/v1/generated/validators/uploadAttachmentParams.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 uploadAttachmentParamsFilenameMax = 255;
+export declare const UploadAttachmentParams: zod.ZodObject<{
+    filename: zod.ZodString;
+}, zod.z.core.$strict>;
+export type UploadAttachmentParams = zod.input<typeof UploadAttachmentParams>;
+export type UploadAttachmentParamsOutput = zod.output<typeof UploadAttachmentParams>;

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

@@ -0,0 +1,55 @@
+/**
+ * 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 uploadAttachmentParamsFilenameMax = 255;
+export const UploadAttachmentParams = zod.strictObject({
+    filename: zod.string().min(1).max(uploadAttachmentParamsFilenameMax),
+});

package/dist/support/v1/index.d.ts

@@ -0,0 +1,3 @@
+export * from "./generated/functions.js";
+export * from "./generated/models.js";
+export * as schemas from "./generated/schemas.zod.js";

package/dist/support/v1/index.js

@@ -0,0 +1,3 @@
+export * from "./generated/functions.js";
+export * from "./generated/models.js";
+export * as schemas from "./generated/schemas.zod.js";

package/dist/tunnel/v1/generated/functions.d.ts

@@ -0,0 +1,190 @@
+/**
+ * Generated by orval 🍺
+ * Do not edit manually.
+ * Leaflow Tunnel API
+ * The user-facing API of Leaflow Tunnel: generating a tunnel for a project, reading its subscription address, and reading its traffic usage.
+ *
+ * ## Layer 4 only
+ *
+ * The platform offers tunnels at layers 2, 3 and 4. **Every endpoint in this document belongs to layer 4** and is served under `/tunnel/l4`. Layers 2 and 3 are not yet open and will carry their own prefixes.
+ *
+ * ## Layer 4 is entitled per project, and no project holds it by default
+ *
+ * **Every endpoint in this document requires the current project to have been entitled.** Without the entitlement each one answers 403 `TUNNEL_NOT_ENTITLED`. Entitlement is granted by the platform per project and cannot be obtained by the user.
+ *
+ * `TUNNEL_NOT_ENTITLED` and `TUNNEL_NOT_FOUND` state different things and cannot be handled as one. The first means the project has not been entitled; the second means it has, and no tunnel has been generated yet.
+ *
+ * ## Authentication
+ *
+ * Every request carries a scoped token; see the `bearerAuth` security scheme.
+ *
+ * ## Conventions
+ *
+ * - **One layer 4 tunnel per project.** The path is therefore the singular `/tunnel/l4` and carries no id.
+ *
+ * - **Generation is idempotent.** Calling it again returns the existing tunnel rather than an error.
+ *
+ * - **The subscription address is a credential.** It is equivalent to a password, is returned only by `GET /tunnel/l4/subscription`, and appears neither in the tunnel itself nor in any list. Do not call that endpoint before the user asks for the address. Rotate it whenever it may have been exposed; every subscription already distributed stops working at once.
+ *
+ * - **`preparing` does not mean unusable.** The subscription link works while nodes are still being distributed, and its contents are derived at the moment it is fetched.
+ *
+ * - **Only `billed_bytes` decides whether the quota is exceeded.** A route may carry a multiplier such as 1.5× or 0×, so `raw_bytes`, the volume actually transferred, need not equal it. A `quota_bytes` of 0 means unlimited.
+ *
+ * - **Usage lags by up to one collection interval.** It suits usage control rather than settlement.
+ *
+ * - **Daily usage does not sum to the usage of the current period.** One is cut by calendar day and the other by billing period.
+ * OpenAPI spec version: 1.0.0
+ */
+import type { Error, ListL4TunnelUsageSeriesParams, SubscriptionResource, TunnelResource, UsageResource, UsageSeriesResource } from "./models.js";
+export type HTTPStatusCode1xx = 100 | 101 | 102 | 103;
+export type HTTPStatusCode2xx = 200 | 201 | 202 | 203 | 204 | 205 | 206 | 207;
+export type HTTPStatusCode3xx = 300 | 301 | 302 | 303 | 304 | 305 | 307 | 308;
+export type HTTPStatusCode4xx = 400 | 401 | 402 | 403 | 404 | 405 | 406 | 407 | 408 | 409 | 410 | 411 | 412 | 413 | 414 | 415 | 416 | 417 | 418 | 419 | 420 | 421 | 422 | 423 | 424 | 426 | 428 | 429 | 431 | 451;
+export type HTTPStatusCode5xx = 500 | 501 | 502 | 503 | 504 | 505 | 507 | 511;
+export type HTTPStatusCodes = HTTPStatusCode1xx | HTTPStatusCode2xx | HTTPStatusCode3xx | HTTPStatusCode4xx | HTTPStatusCode5xx;
+export type getL4TunnelResponse200 = {
+    data: TunnelResource;
+    status: 200;
+};
+export type getL4TunnelResponseDefault = {
+    data: Error;
+    status: Exclude<HTTPStatusCodes, 200>;
+};
+export type getL4TunnelResponseSuccess = getL4TunnelResponse200 & {
+    headers: Headers;
+};
+export type getL4TunnelResponseError = getL4TunnelResponseDefault & {
+    headers: Headers;
+};
+export type getL4TunnelResponse = getL4TunnelResponseSuccess | getL4TunnelResponseError;
+export declare const getGetL4TunnelUrl: () => string;
+/**
+ * `TUNNEL_NOT_FOUND` means no tunnel has been generated yet.
+ *
+ * 403 `TUNNEL_NOT_ENTITLED` states something else: the project has not been entitled to layer 4 at all.
+ *
+ * The subscription address, the usage and the quota each have their own endpoint and are not repeated here.
+ * @summary Get the layer 4 tunnel of the current project
+ */
+export declare const getL4Tunnel: (options?: RequestInit, fetchFn?: typeof globalThis.fetch) => Promise<getL4TunnelResponse>;
+export type generateL4TunnelResponse200 = {
+    data: TunnelResource;
+    status: 200;
+};
+export type generateL4TunnelResponseDefault = {
+    data: Error;
+    status: Exclude<HTTPStatusCodes, 200>;
+};
+export type generateL4TunnelResponseSuccess = generateL4TunnelResponse200 & {
+    headers: Headers;
+};
+export type generateL4TunnelResponseError = generateL4TunnelResponseDefault & {
+    headers: Headers;
+};
+export type generateL4TunnelResponse = generateL4TunnelResponseSuccess | generateL4TunnelResponseError;
+export declare const getGenerateL4TunnelUrl: () => string;
+/**
+ * **Idempotent**: calling it again returns the existing tunnel rather than an error.
+ *
+ * Read the address from the subscription endpoint afterwards; it is not returned here.
+ * @summary Generate the layer 4 tunnel
+ */
+export declare const generateL4Tunnel: (options?: RequestInit, fetchFn?: typeof globalThis.fetch) => Promise<generateL4TunnelResponse>;
+export type getL4TunnelSubscriptionResponse200 = {
+    data: SubscriptionResource;
+    status: 200;
+};
+export type getL4TunnelSubscriptionResponseDefault = {
+    data: Error;
+    status: Exclude<HTTPStatusCodes, 200>;
+};
+export type getL4TunnelSubscriptionResponseSuccess = getL4TunnelSubscriptionResponse200 & {
+    headers: Headers;
+};
+export type getL4TunnelSubscriptionResponseError = getL4TunnelSubscriptionResponseDefault & {
+    headers: Headers;
+};
+export type getL4TunnelSubscriptionResponse = getL4TunnelSubscriptionResponseSuccess | getL4TunnelSubscriptionResponseError;
+export declare const getGetL4TunnelSubscriptionUrl: () => string;
+/**
+ * **This URL is a credential, equivalent to a password.** It yields every node of the project along with their passwords. It is returned here alone, and appears neither in the tunnel itself nor in any list.
+ *
+ * Do not call this endpoint before the user asks for the address.
+ *
+ * A `status` of `preparing` leaves the link usable; its contents are derived at the moment it is fetched.
+ * @summary Get the subscription address
+ */
+export declare const getL4TunnelSubscription: (options?: RequestInit, fetchFn?: typeof globalThis.fetch) => Promise<getL4TunnelSubscriptionResponse>;
+export type rotateL4TunnelSubscriptionResponse200 = {
+    data: TunnelResource;
+    status: 200;
+};
+export type rotateL4TunnelSubscriptionResponseDefault = {
+    data: Error;
+    status: Exclude<HTTPStatusCodes, 200>;
+};
+export type rotateL4TunnelSubscriptionResponseSuccess = rotateL4TunnelSubscriptionResponse200 & {
+    headers: Headers;
+};
+export type rotateL4TunnelSubscriptionResponseError = rotateL4TunnelSubscriptionResponseDefault & {
+    headers: Headers;
+};
+export type rotateL4TunnelSubscriptionResponse = rotateL4TunnelSubscriptionResponseSuccess | rotateL4TunnelSubscriptionResponseError;
+export declare const getRotateL4TunnelSubscriptionUrl: () => string;
+/**
+ * **This is the remedy for an exposed credential, and every subscription already distributed stops working at once.**
+ *
+ * The subscription token and the node passwords are replaced together, so every client has to fetch the subscription again before it can carry on. Confirm that this is the intended outcome before calling.
+ *
+ * A tunnel disabled by the platform cannot be rotated (`TUNNEL_DISABLED_FOR_ROTATE`); resolve the cause first.
+ *
+ * Read the new address from the subscription endpoint afterwards; **it is not returned here**.
+ * @summary Rotate the subscription address and the node passwords
+ */
+export declare const rotateL4TunnelSubscription: (options?: RequestInit, fetchFn?: typeof globalThis.fetch) => Promise<rotateL4TunnelSubscriptionResponse>;
+export type getL4TunnelUsageResponse200 = {
+    data: UsageResource;
+    status: 200;
+};
+export type getL4TunnelUsageResponseDefault = {
+    data: Error;
+    status: Exclude<HTTPStatusCodes, 200>;
+};
+export type getL4TunnelUsageResponseSuccess = getL4TunnelUsageResponse200 & {
+    headers: Headers;
+};
+export type getL4TunnelUsageResponseError = getL4TunnelUsageResponseDefault & {
+    headers: Headers;
+};
+export type getL4TunnelUsageResponse = getL4TunnelUsageResponseSuccess | getL4TunnelUsageResponseError;
+export declare const getGetL4TunnelUsageUrl: () => string;
+/**
+ * Read live.
+ *
+ * Only `billed_bytes` decides whether the quota is exceeded: a route may carry a multiplier such as 1.5× or 0×, so `raw_bytes`, the volume actually transferred, need not equal it. A `quota_bytes` of 0 means unlimited.
+ * @summary Get the usage of the current period
+ */
+export declare const getL4TunnelUsage: (options?: RequestInit, fetchFn?: typeof globalThis.fetch) => Promise<getL4TunnelUsageResponse>;
+export type listL4TunnelUsageSeriesResponse200 = {
+    data: UsageSeriesResource;
+    status: 200;
+};
+export type listL4TunnelUsageSeriesResponseDefault = {
+    data: Error;
+    status: Exclude<HTTPStatusCodes, 200>;
+};
+export type listL4TunnelUsageSeriesResponseSuccess = listL4TunnelUsageSeriesResponse200 & {
+    headers: Headers;
+};
+export type listL4TunnelUsageSeriesResponseError = listL4TunnelUsageSeriesResponseDefault & {
+    headers: Headers;
+};
+export type listL4TunnelUsageSeriesResponse = listL4TunnelUsageSeriesResponseSuccess | listL4TunnelUsageSeriesResponseError;
+export declare const getListL4TunnelUsageSeriesUrl: (params?: ListL4TunnelUsageSeriesParams) => string;
+/**
+ * Cut by calendar day. A day carrying no traffic is absent rather than zero, so a chart has to fill the date axis itself.
+ *
+ * These days do not sum to the usage of the current period, which is cut by billing period. Resetting the usage of the current period leaves every daily total in place.
+ * @summary Get daily usage
+ */
+export declare const listL4TunnelUsageSeries: (params?: ListL4TunnelUsageSeriesParams, options?: RequestInit, fetchFn?: typeof globalThis.fetch) => Promise<listL4TunnelUsageSeriesResponse>;

package/dist/tunnel/v1/generated/functions.js

@@ -0,0 +1,125 @@
+export const getGetL4TunnelUrl = () => {
+    return `https://tunnel.leaflow.cloud/api/v1/tunnel/l4`;
+};
+/**
+ * `TUNNEL_NOT_FOUND` means no tunnel has been generated yet.
+ *
+ * 403 `TUNNEL_NOT_ENTITLED` states something else: the project has not been entitled to layer 4 at all.
+ *
+ * The subscription address, the usage and the quota each have their own endpoint and are not repeated here.
+ * @summary Get the layer 4 tunnel of the current project
+ */
+export const getL4Tunnel = async (options, fetchFn) => {
+    const res = await (fetchFn ?? fetch)(getGetL4TunnelUrl(), {
+        ...options,
+        method: "GET",
+    });
+    const body = [204, 205, 304].includes(res.status) ? null : await res.text();
+    const data = body ? JSON.parse(body) : {};
+    return { data, status: res.status, headers: res.headers };
+};
+export const getGenerateL4TunnelUrl = () => {
+    return `https://tunnel.leaflow.cloud/api/v1/tunnel/l4`;
+};
+/**
+ * **Idempotent**: calling it again returns the existing tunnel rather than an error.
+ *
+ * Read the address from the subscription endpoint afterwards; it is not returned here.
+ * @summary Generate the layer 4 tunnel
+ */
+export const generateL4Tunnel = async (options, fetchFn) => {
+    const res = await (fetchFn ?? fetch)(getGenerateL4TunnelUrl(), {
+        ...options,
+        method: "POST",
+    });
+    const body = [204, 205, 304].includes(res.status) ? null : await res.text();
+    const data = body ? JSON.parse(body) : {};
+    return { data, status: res.status, headers: res.headers };
+};
+export const getGetL4TunnelSubscriptionUrl = () => {
+    return `https://tunnel.leaflow.cloud/api/v1/tunnel/l4/subscription`;
+};
+/**
+ * **This URL is a credential, equivalent to a password.** It yields every node of the project along with their passwords. It is returned here alone, and appears neither in the tunnel itself nor in any list.
+ *
+ * Do not call this endpoint before the user asks for the address.
+ *
+ * A `status` of `preparing` leaves the link usable; its contents are derived at the moment it is fetched.
+ * @summary Get the subscription address
+ */
+export const getL4TunnelSubscription = async (options, fetchFn) => {
+    const res = await (fetchFn ?? fetch)(getGetL4TunnelSubscriptionUrl(), {
+        ...options,
+        method: "GET",
+    });
+    const body = [204, 205, 304].includes(res.status) ? null : await res.text();
+    const data = body ? JSON.parse(body) : {};
+    return { data, status: res.status, headers: res.headers };
+};
+export const getRotateL4TunnelSubscriptionUrl = () => {
+    return `https://tunnel.leaflow.cloud/api/v1/tunnel/l4/subscription/rotate`;
+};
+/**
+ * **This is the remedy for an exposed credential, and every subscription already distributed stops working at once.**
+ *
+ * The subscription token and the node passwords are replaced together, so every client has to fetch the subscription again before it can carry on. Confirm that this is the intended outcome before calling.
+ *
+ * A tunnel disabled by the platform cannot be rotated (`TUNNEL_DISABLED_FOR_ROTATE`); resolve the cause first.
+ *
+ * Read the new address from the subscription endpoint afterwards; **it is not returned here**.
+ * @summary Rotate the subscription address and the node passwords
+ */
+export const rotateL4TunnelSubscription = async (options, fetchFn) => {
+    const res = await (fetchFn ?? fetch)(getRotateL4TunnelSubscriptionUrl(), {
+        ...options,
+        method: "POST",
+    });
+    const body = [204, 205, 304].includes(res.status) ? null : await res.text();
+    const data = body ? JSON.parse(body) : {};
+    return { data, status: res.status, headers: res.headers };
+};
+export const getGetL4TunnelUsageUrl = () => {
+    return `https://tunnel.leaflow.cloud/api/v1/tunnel/l4/usage`;
+};
+/**
+ * Read live.
+ *
+ * Only `billed_bytes` decides whether the quota is exceeded: a route may carry a multiplier such as 1.5× or 0×, so `raw_bytes`, the volume actually transferred, need not equal it. A `quota_bytes` of 0 means unlimited.
+ * @summary Get the usage of the current period
+ */
+export const getL4TunnelUsage = async (options, fetchFn) => {
+    const res = await (fetchFn ?? fetch)(getGetL4TunnelUsageUrl(), {
+        ...options,
+        method: "GET",
+    });
+    const body = [204, 205, 304].includes(res.status) ? null : await res.text();
+    const data = body ? JSON.parse(body) : {};
+    return { data, status: res.status, headers: res.headers };
+};
+export const getListL4TunnelUsageSeriesUrl = (params) => {
+    const normalizedParams = new URLSearchParams();
+    Object.entries(params || {}).forEach(([key, value]) => {
+        if (value !== undefined) {
+            normalizedParams.append(key, value === null ? "null" : String(value));
+        }
+    });
+    const stringifiedParams = normalizedParams.toString();
+    return stringifiedParams.length > 0
+        ? `https://tunnel.leaflow.cloud/api/v1/tunnel/l4/usage/series?${stringifiedParams}`
+        : `https://tunnel.leaflow.cloud/api/v1/tunnel/l4/usage/series`;
+};
+/**
+ * Cut by calendar day. A day carrying no traffic is absent rather than zero, so a chart has to fill the date axis itself.
+ *
+ * These days do not sum to the usage of the current period, which is cut by billing period. Resetting the usage of the current period leaves every daily total in place.
+ * @summary Get daily usage
+ */
+export const listL4TunnelUsageSeries = async (params, options, fetchFn) => {
+    const res = await (fetchFn ?? fetch)(getListL4TunnelUsageSeriesUrl(params), {
+        ...options,
+        method: "GET",
+    });
+    const body = [204, 205, 304].includes(res.status) ? null : await res.text();
+    const data = body ? JSON.parse(body) : {};
+    return { data, status: res.status, headers: res.headers };
+};

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

@@ -0,0 +1,119 @@
+/**
+ * Generated by orval 🍺
+ * Do not edit manually.
+ * Leaflow Tunnel API
+ * The user-facing API of Leaflow Tunnel: generating a tunnel for a project, reading its subscription address, and reading its traffic usage.
+ *
+ * ## Layer 4 only
+ *
+ * The platform offers tunnels at layers 2, 3 and 4. **Every endpoint in this document belongs to layer 4** and is served under `/tunnel/l4`. Layers 2 and 3 are not yet open and will carry their own prefixes.
+ *
+ * ## Layer 4 is entitled per project, and no project holds it by default
+ *
+ * **Every endpoint in this document requires the current project to have been entitled.** Without the entitlement each one answers 403 `TUNNEL_NOT_ENTITLED`. Entitlement is granted by the platform per project and cannot be obtained by the user.
+ *
+ * `TUNNEL_NOT_ENTITLED` and `TUNNEL_NOT_FOUND` state different things and cannot be handled as one. The first means the project has not been entitled; the second means it has, and no tunnel has been generated yet.
+ *
+ * ## Authentication
+ *
+ * Every request carries a scoped token; see the `bearerAuth` security scheme.
+ *
+ * ## Conventions
+ *
+ * - **One layer 4 tunnel per project.** The path is therefore the singular `/tunnel/l4` and carries no id.
+ *
+ * - **Generation is idempotent.** Calling it again returns the existing tunnel rather than an error.
+ *
+ * - **The subscription address is a credential.** It is equivalent to a password, is returned only by `GET /tunnel/l4/subscription`, and appears neither in the tunnel itself nor in any list. Do not call that endpoint before the user asks for the address. Rotate it whenever it may have been exposed; every subscription already distributed stops working at once.
+ *
+ * - **`preparing` does not mean unusable.** The subscription link works while nodes are still being distributed, and its contents are derived at the moment it is fetched.
+ *
+ * - **Only `billed_bytes` decides whether the quota is exceeded.** A route may carry a multiplier such as 1.5× or 0×, so `raw_bytes`, the volume actually transferred, need not equal it. A `quota_bytes` of 0 means unlimited.
+ *
+ * - **Usage lags by up to one collection interval.** It suits usage control rather than settlement.
+ *
+ * - **Daily usage does not sum to the usage of the current period.** One is cut by calendar day and the other by billing period.
+ * OpenAPI spec version: 1.0.0
+ */
+/**
+ * What a given `code` carries alongside the message. The keys depend on the code,
+ * and a client that does not recognise one ignores it.
+ */
+export type ErrorMeta = {
+    [key: string]: unknown;
+};
+export interface Error {
+    code?: string;
+    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.
+     */
+    meta?: ErrorMeta;
+    status: number;
+}
+/**
+ * ready means every node has been distributed; preparing means distribution is still under way, and the link works either way
+ */
+export type SubscriptionResourceStatus = (typeof SubscriptionResourceStatus)[keyof typeof SubscriptionResourceStatus];
+export declare const SubscriptionResourceStatus: {
+    readonly preparing: "preparing";
+    readonly ready: "ready";
+};
+export interface SubscriptionResource {
+    /** ready means every node has been distributed; preparing means distribution is still under way, and the link works either way */
+    status: SubscriptionResourceStatus;
+    updated_at: string;
+    /** The subscription address. It is a long-lived credential equivalent to a password; do not forward it or share a screenshot of it */
+    url: string;
+    version: number;
+}
+/**
+ * The layer 4 tunnel of the current project. It answers a single question — whether the tunnel has been generated
+ */
+export interface TunnelResource {
+    created_at: string;
+    /** Whether the tunnel is currently usable. false means the platform has disabled it — for an unpaid balance, a violation, or a suspended project — and the cause has to be resolved first */
+    enabled: boolean;
+    id: string;
+}
+export interface UsageDayResource {
+    billed_bytes: number;
+    /** YYYY-MM-DD */
+    day: string;
+    raw_bytes: number;
+}
+export interface UsageResource {
+    /** Usage after the multiplier of each route has been applied. Quota is measured against this value */
+    billed_bytes: number;
+    over_quota: boolean;
+    /** Last day of the current billing period (YYYY-MM-DD) */
+    period_end: string;
+    /** First day of the current billing period (YYYY-MM-DD) */
+    period_start: string;
+    /** The quota in force; 0 means unlimited */
+    quota_bytes: number;
+    /**
+     * When the quota was found to be exceeded; null while it has not been
+     * @nullable
+     */
+    quota_exceeded_at: string | null;
+    /** Bytes actually transferred. Quota is not measured against this value */
+    raw_bytes: number;
+    upload_bytes: number;
+    /** Usage as a percentage of the quota */
+    usage_percent: number;
+}
+export interface UsageSeriesResource {
+    /** The number of days actually covered, which may have been clamped to the range 1–365 */
+    days: number;
+    points: UsageDayResource[];
+}
+export type ListL4TunnelUsageSeriesParams = {
+    /**
+     * How many days to cover. 0 requests the default of 30; the range accepted is 1–365, and a larger value is clamped to it
+     * @minimum 0
+     * @maximum 3650
+     */
+    days?: number;
+};

package/dist/tunnel/v1/generated/models.js

@@ -0,0 +1,4 @@
+export const SubscriptionResourceStatus = {
+    preparing: "preparing",
+    ready: "ready",
+};

package/dist/tunnel/v1/generated/schemas.zod.d.ts

@@ -0,0 +1,50 @@
+/**
+ * Generated by orval 🍺
+ * Do not edit manually.
+ * Leaflow Tunnel API
+ * The user-facing API of Leaflow Tunnel: generating a tunnel for a project, reading its subscription address, and reading its traffic usage.
+ *
+ * ## Layer 4 only
+ *
+ * The platform offers tunnels at layers 2, 3 and 4. **Every endpoint in this document belongs to layer 4** and is served under `/tunnel/l4`. Layers 2 and 3 are not yet open and will carry their own prefixes.
+ *
+ * ## Layer 4 is entitled per project, and no project holds it by default
+ *
+ * **Every endpoint in this document requires the current project to have been entitled.** Without the entitlement each one answers 403 `TUNNEL_NOT_ENTITLED`. Entitlement is granted by the platform per project and cannot be obtained by the user.
+ *
+ * `TUNNEL_NOT_ENTITLED` and `TUNNEL_NOT_FOUND` state different things and cannot be handled as one. The first means the project has not been entitled; the second means it has, and no tunnel has been generated yet.
+ *
+ * ## Authentication
+ *
+ * Every request carries a scoped token; see the `bearerAuth` security scheme.
+ *
+ * ## Conventions
+ *
+ * - **One layer 4 tunnel per project.** The path is therefore the singular `/tunnel/l4` and carries no id.
+ *
+ * - **Generation is idempotent.** Calling it again returns the existing tunnel rather than an error.
+ *
+ * - **The subscription address is a credential.** It is equivalent to a password, is returned only by `GET /tunnel/l4/subscription`, and appears neither in the tunnel itself nor in any list. Do not call that endpoint before the user asks for the address. Rotate it whenever it may have been exposed; every subscription already distributed stops working at once.
+ *
+ * - **`preparing` does not mean unusable.** The subscription link works while nodes are still being distributed, and its contents are derived at the moment it is fetched.
+ *
+ * - **Only `billed_bytes` decides whether the quota is exceeded.** A route may carry a multiplier such as 1.5× or 0×, so `raw_bytes`, the volume actually transferred, need not equal it. A `quota_bytes` of 0 means unlimited.
+ *
+ * - **Usage lags by up to one collection interval.** It suits usage control rather than settlement.
+ *
+ * - **Daily usage does not sum to the usage of the current period.** One is cut by calendar day and the other by billing period.
+ * OpenAPI spec version: 1.0.0
+ */
+import * as zod from "zod";
+/**
+ * Cut by calendar day. A day carrying no traffic is absent rather than zero, so a chart has to fill the date axis itself.
+ *
+ * These days do not sum to the usage of the current period, which is cut by billing period. Resetting the usage of the current period leaves every daily total in place.
+ * @summary Get daily usage
+ */
+export declare const listL4TunnelUsageSeriesQueryDaysDefault = 30;
+export declare const listL4TunnelUsageSeriesQueryDaysMin = 0;
+export declare const listL4TunnelUsageSeriesQueryDaysMax = 3650;
+export declare const ListL4TunnelUsageSeriesQueryParams: zod.ZodObject<{
+    days: zod.ZodDefault<zod.ZodInt>;
+}, zod.z.core.$strict>;

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

@@ -0,0 +1,55 @@
+/**
+ * Generated by orval 🍺
+ * Do not edit manually.
+ * Leaflow Tunnel API
+ * The user-facing API of Leaflow Tunnel: generating a tunnel for a project, reading its subscription address, and reading its traffic usage.
+ *
+ * ## Layer 4 only
+ *
+ * The platform offers tunnels at layers 2, 3 and 4. **Every endpoint in this document belongs to layer 4** and is served under `/tunnel/l4`. Layers 2 and 3 are not yet open and will carry their own prefixes.
+ *
+ * ## Layer 4 is entitled per project, and no project holds it by default
+ *
+ * **Every endpoint in this document requires the current project to have been entitled.** Without the entitlement each one answers 403 `TUNNEL_NOT_ENTITLED`. Entitlement is granted by the platform per project and cannot be obtained by the user.
+ *
+ * `TUNNEL_NOT_ENTITLED` and `TUNNEL_NOT_FOUND` state different things and cannot be handled as one. The first means the project has not been entitled; the second means it has, and no tunnel has been generated yet.
+ *
+ * ## Authentication
+ *
+ * Every request carries a scoped token; see the `bearerAuth` security scheme.
+ *
+ * ## Conventions
+ *
+ * - **One layer 4 tunnel per project.** The path is therefore the singular `/tunnel/l4` and carries no id.
+ *
+ * - **Generation is idempotent.** Calling it again returns the existing tunnel rather than an error.
+ *
+ * - **The subscription address is a credential.** It is equivalent to a password, is returned only by `GET /tunnel/l4/subscription`, and appears neither in the tunnel itself nor in any list. Do not call that endpoint before the user asks for the address. Rotate it whenever it may have been exposed; every subscription already distributed stops working at once.
+ *
+ * - **`preparing` does not mean unusable.** The subscription link works while nodes are still being distributed, and its contents are derived at the moment it is fetched.
+ *
+ * - **Only `billed_bytes` decides whether the quota is exceeded.** A route may carry a multiplier such as 1.5× or 0×, so `raw_bytes`, the volume actually transferred, need not equal it. A `quota_bytes` of 0 means unlimited.
+ *
+ * - **Usage lags by up to one collection interval.** It suits usage control rather than settlement.
+ *
+ * - **Daily usage does not sum to the usage of the current period.** One is cut by calendar day and the other by billing period.
+ * OpenAPI spec version: 1.0.0
+ */
+import * as zod from "zod";
+/**
+ * Cut by calendar day. A day carrying no traffic is absent rather than zero, so a chart has to fill the date axis itself.
+ *
+ * These days do not sum to the usage of the current period, which is cut by billing period. Resetting the usage of the current period leaves every daily total in place.
+ * @summary Get daily usage
+ */
+export const listL4TunnelUsageSeriesQueryDaysDefault = 30;
+export const listL4TunnelUsageSeriesQueryDaysMin = 0;
+export const listL4TunnelUsageSeriesQueryDaysMax = 3650;
+export const ListL4TunnelUsageSeriesQueryParams = zod.strictObject({
+    days: zod
+        .int()
+        .min(listL4TunnelUsageSeriesQueryDaysMin)
+        .max(listL4TunnelUsageSeriesQueryDaysMax)
+        .default(listL4TunnelUsageSeriesQueryDaysDefault)
+        .describe("How many days to cover. 0 requests the default of 30; the range accepted is 1–365, and a larger value is clamped to it"),
+});