@leaflow/sdk 0.178.0 → 0.180.0

package/dist/assistant/v1/generated/validators/webhookSecretResponseBody.zod.d.ts

@@ -15,8 +15,9 @@
  * of three efforts — low, medium or high — which are sent to the model unchanged.
  *
  * Read a thread's state with get-thread and its transcript with list-thread-items. Follow both live
- * over the WebSocket described under /api/v1/realtime/tickets. list-thread-messages outlines the
- * person's messages for navigating a long conversation.
+ * through EventBus by subscribing to assistant.thread.frame and assistant.resource.updated; after a
+ * reconnection or an assistant.workspace.invalidated message, read them again. list-thread-messages
+ * outlines the person's messages for navigating a long conversation.
  *
  * Upload large files with /api/v1/uploads: read /api/v1/upload-configuration first, send exact-sized
  * parts, then complete the upload and send its attachment id in a message.

package/dist/assistant/v1/generated/validators/webhookSecretResponseBody.zod.js

@@ -15,8 +15,9 @@
  * of three efforts — low, medium or high — which are sent to the model unchanged.
  *
  * Read a thread's state with get-thread and its transcript with list-thread-items. Follow both live
- * over the WebSocket described under /api/v1/realtime/tickets. list-thread-messages outlines the
- * person's messages for navigating a long conversation.
+ * through EventBus by subscribing to assistant.thread.frame and assistant.resource.updated; after a
+ * reconnection or an assistant.workspace.invalidated message, read them again. list-thread-messages
+ * outlines the person's messages for navigating a long conversation.
  *
  * Upload large files with /api/v1/uploads: read /api/v1/upload-configuration first, send exact-sized
  * parts, then complete the upload and send its attachment id in a message.

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

@@ -4,20 +4,18 @@
  * Leaflow Event Bus API
  * Event definitions, versions, publishing, and realtime access.
  *
- * ## 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.
- *
  * ## Definitions and messages
  *
  * An event is a definition: a name, a description, and one or more versions. A version carries a
  * JSON Schema that every published payload must satisfy. Messages are not stored here and are
  * not part of the event definition.
  *
- * A project event belongs to the current project. A global event has no `project_id`; it is
- * defined by a platform service and is read-only in this API. Global events are listed alongside
- * the project's own events.
+ * Every event belongs to a namespace, and its name is the namespace's name, a dot, and at least a
+ * resource and an action, such as `acme.order.created`. A project creates its own namespaces and
+ * defines events in them. Platform namespaces, such as `leaflow.notification`, are maintained by
+ * platform services: their events are listed alongside the project's own and can be subscribed
+ * to, but cannot be changed or published here, and the namespaces cannot be changed or deleted.
+ * Events in a platform namespace are called platform events below.
  *
  * A version number never changes meaning. Adding optional properties is allowed within a version;
  * a breaking change creates a new version. Publishing without a version uses the highest active
@@ -25,18 +23,241 @@
  *
  * ## Publishing
  *
- * Publishing returns the identity of the message and does not wait for consumers. Messages are
- * not stored and are not replayed: a consumer that connects later does not receive earlier
- * messages. Consumers receive messages through the realtime API or the platform's service API.
+ * Messages are published in batches of up to 64. A batch is validated as a whole: if any message
+ * is rejected, none is published. Publishing returns the identity of each message and does not
+ * wait for consumers. Messages are not stored and are not replayed: a consumer that connects
+ * later does not receive earlier messages.
+ *
+ * Messages published through this API are sent to the current project. A message may name one
+ * `subject`, a member of the project; it is then sent to that member only. Without a subject it is
+ * sent to every member of the project.
+ *
+ * Every publication names a `client_id`. It starts with the prefix returned with a realtime
+ * ticket, `user.{user_id}.project.{project_id}.`, followed by one segment chosen by the
+ * client, such as a random identifier per browser tab. Receivers get it unchanged, so a client
+ * can recognise its own messages. A client ID does not need to be unique: several connections
+ * may share one.
  *
  * ## Realtime
  *
- * Create a ticket, connect to the returned URL with the ticket, and authenticate the connection
- * with a scoped token. A ticket is single-use and short-lived. The connection ends when the
- * token expires unless it is refreshed with a new scoped token for the same user and project.
+ * Every message has a topic `{event}/{project_id|-}/{subject|-}/{key levels}`, where `-` stands
+ * for a missing recipient and the key, split at `/`, supplies the remaining levels. A topic filter
+ * uses `+` to match exactly one level and `#`, only as the last level, to match that level and
+ * every level below it, including none. For example, `{event}/{project_id}/-/#` matches every
+ * message sent to the members of a project, and `{event}/-/{user_id}/#` every message sent to one
+ * person outside any project.
+ *
+ * 1. Create a ticket with `POST /api/v1/realtime/tickets`, naming the events to receive. The
+ *    response lists the topic filters the ticket covers and the `client_id_prefix` to use. For a
+ *    platform event they cover messages sent to the caller, messages sent to no recipient and,
+ *    where the caller's permissions allow, messages sent within the project; for a project event
+ *    they cover messages sent within the project. Without a selected project, use
+ *    `POST /api/v1/account/realtime/tickets`; such a ticket covers only messages sent to the
+ *    caller or to no recipient, and cannot publish.
+ * 2. Open a WebSocket to `wss://eventbus.leaflow.cloud/realtime` and send, within 15 seconds:
+ *    `{"type":"authenticate","ticket":"…","client_id":"…"}`. The reply is
+ *    `{"type":"authenticated","client_id":"…","connection_id":"…","expires_at":"…"}`.
+ *    `connection_id` identifies this connection; it is assigned by EventBus and changes on
+ *    every reconnection.
+ * 3. Send `{"type":"subscribe","id":"…","topics":[…]}`. Each topic must be one of the returned
+ *    `topics` or lie within one of them, for example by naming a key level where the ticket has
+ *    `#`; a batch with any other topic is rejected as a whole. The reply is `subscribed`.
+ *    `unsubscribe` takes the same form and replies `unsubscribed`. Both may be sent at any time
+ *    while the connection is open.
+ * 4. Messages arrive as `{"type":"messages","messages":[…]}`, each element an `EventMessage`. A
+ *    message matching several subscriptions on one connection arrives once for each of them.
+ * 5. A connection may switch to another ticket of the same user at any time by sending
+ *    `authenticate` again: to renew before `expires_at`, to move from an account ticket to a
+ *    project ticket, or to move to another project. `client_id` may be omitted while the
+ *    `client_id_prefix` stays the same; when it changes, a client ID under the new prefix is
+ *    required. Subscriptions the new ticket does not cover are removed at once and reported in a
+ *    `{"type":"revoked","topics":[…]}` frame. A ticket for another user closes the connection
+ *    with code 4401, as does letting the ticket expire.
+ *
+ * A connection holding a project ticket may publish the project's own events with
+ * `{"type":"publish","id":"…","messages":[{"event":"…","key":"…","subject":"…","data":{…}}]}`;
+ * the reply is `published` with the identity of each message. `ping` is answered with `pong`.
+ * A rejected request is answered with `{"type":"error","id":"…","code":"…","message":"…"}`.
+ * Every reply carries the `id` of the request it answers.
  * OpenAPI spec version: 1.0.0
  */
-import type { CreateEventRequest, CreateVersionRequest, Error, EventDetail, EventList, EventResource, EventVersion, ListEventsParams, PublishRequest, PublishResponse, RealtimeTicket, UpdateEventRequest } from "./models.js";
+import type { CreateEventRequest, CreateNamespaceRequest, CreateVersionRequest, Error, EventDetail, EventList, EventResource, EventVersion, ListEventsParams, ListNamespacesParams, NamespaceList, NamespaceResource, PublishRequest, PublishResponse, RealtimeTicket, RealtimeTicketRequest, UpdateEventRequest, UpdateNamespaceRequest } from "./models.js";
+export type listNamespacesResponse200 = {
+    data: NamespaceList;
+    status: 200;
+};
+export type listNamespacesResponse400 = {
+    data: Error;
+    status: 400;
+};
+export type listNamespacesResponse401 = {
+    data: Error;
+    status: 401;
+};
+export type listNamespacesResponse503 = {
+    data: Error;
+    status: 503;
+};
+export type listNamespacesResponseSuccess = listNamespacesResponse200 & {
+    headers: Headers;
+};
+export type listNamespacesResponseError = (listNamespacesResponse400 | listNamespacesResponse401 | listNamespacesResponse503) & {
+    headers: Headers;
+};
+export type listNamespacesResponse = listNamespacesResponseSuccess | listNamespacesResponseError;
+export declare const getListNamespacesUrl: (params?: ListNamespacesParams) => string;
+/**
+ * Returns the platform namespaces followed by the project's own, each group ordered by name.
+ * Archived namespaces are omitted unless `include_archived` is true.
+ * @summary List namespaces
+ */
+export declare const listNamespaces: (params?: ListNamespacesParams, options?: RequestInit, fetchFn?: typeof globalThis.fetch) => Promise<listNamespacesResponse>;
+export type createNamespaceResponse201 = {
+    data: NamespaceResource;
+    status: 201;
+};
+export type createNamespaceResponse400 = {
+    data: Error;
+    status: 400;
+};
+export type createNamespaceResponse401 = {
+    data: Error;
+    status: 401;
+};
+export type createNamespaceResponse403 = {
+    data: Error;
+    status: 403;
+};
+export type createNamespaceResponse409 = {
+    data: Error;
+    status: 409;
+};
+export type createNamespaceResponse503 = {
+    data: Error;
+    status: 503;
+};
+export type createNamespaceResponseSuccess = createNamespaceResponse201 & {
+    headers: Headers;
+};
+export type createNamespaceResponseError = (createNamespaceResponse400 | createNamespaceResponse401 | createNamespaceResponse403 | createNamespaceResponse409 | createNamespaceResponse503) & {
+    headers: Headers;
+};
+export type createNamespaceResponse = createNamespaceResponseSuccess | createNamespaceResponseError;
+export declare const getCreateNamespaceUrl: () => string;
+/**
+ * Creates a namespace in the current project. Its name is a single segment, unique within the
+ * project; names reserved for the platform are rejected.
+ * @summary Create a namespace
+ */
+export declare const createNamespace: (createNamespaceRequest: CreateNamespaceRequest, options?: RequestInit, fetchFn?: typeof globalThis.fetch) => Promise<createNamespaceResponse>;
+export type getNamespaceResponse200 = {
+    data: NamespaceResource;
+    status: 200;
+};
+export type getNamespaceResponse401 = {
+    data: Error;
+    status: 401;
+};
+export type getNamespaceResponse404 = {
+    data: Error;
+    status: 404;
+};
+export type getNamespaceResponse503 = {
+    data: Error;
+    status: 503;
+};
+export type getNamespaceResponseSuccess = getNamespaceResponse200 & {
+    headers: Headers;
+};
+export type getNamespaceResponseError = (getNamespaceResponse401 | getNamespaceResponse404 | getNamespaceResponse503) & {
+    headers: Headers;
+};
+export type getNamespaceResponse = getNamespaceResponseSuccess | getNamespaceResponseError;
+export declare const getGetNamespaceUrl: (namespaceName: string) => string;
+/**
+ * Returns a platform namespace or one of the project's own.
+ * @summary Get a namespace
+ */
+export declare const getNamespace: (namespaceName: string, options?: RequestInit, fetchFn?: typeof globalThis.fetch) => Promise<getNamespaceResponse>;
+export type updateNamespaceResponse200 = {
+    data: NamespaceResource;
+    status: 200;
+};
+export type updateNamespaceResponse400 = {
+    data: Error;
+    status: 400;
+};
+export type updateNamespaceResponse401 = {
+    data: Error;
+    status: 401;
+};
+export type updateNamespaceResponse403 = {
+    data: Error;
+    status: 403;
+};
+export type updateNamespaceResponse404 = {
+    data: Error;
+    status: 404;
+};
+export type updateNamespaceResponse503 = {
+    data: Error;
+    status: 503;
+};
+export type updateNamespaceResponseSuccess = updateNamespaceResponse200 & {
+    headers: Headers;
+};
+export type updateNamespaceResponseError = (updateNamespaceResponse400 | updateNamespaceResponse401 | updateNamespaceResponse403 | updateNamespaceResponse404 | updateNamespaceResponse503) & {
+    headers: Headers;
+};
+export type updateNamespaceResponse = updateNamespaceResponseSuccess | updateNamespaceResponseError;
+export declare const getUpdateNamespaceUrl: (namespaceName: string) => string;
+/**
+ * Changes the description or status of one of the project's namespaces. Only the fields
+ * present in the request are changed. While a namespace is archived, its events cannot be
+ * created, published or subscribed to; restoring it lifts that. Platform namespaces cannot be
+ * changed.
+ * @summary Update a namespace
+ */
+export declare const updateNamespace: (namespaceName: string, updateNamespaceRequest: UpdateNamespaceRequest, options?: RequestInit, fetchFn?: typeof globalThis.fetch) => Promise<updateNamespaceResponse>;
+export type deleteNamespaceResponse204 = {
+    data: void;
+    status: 204;
+};
+export type deleteNamespaceResponse401 = {
+    data: Error;
+    status: 401;
+};
+export type deleteNamespaceResponse403 = {
+    data: Error;
+    status: 403;
+};
+export type deleteNamespaceResponse404 = {
+    data: Error;
+    status: 404;
+};
+export type deleteNamespaceResponse409 = {
+    data: Error;
+    status: 409;
+};
+export type deleteNamespaceResponse503 = {
+    data: Error;
+    status: 503;
+};
+export type deleteNamespaceResponseSuccess = deleteNamespaceResponse204 & {
+    headers: Headers;
+};
+export type deleteNamespaceResponseError = (deleteNamespaceResponse401 | deleteNamespaceResponse403 | deleteNamespaceResponse404 | deleteNamespaceResponse409 | deleteNamespaceResponse503) & {
+    headers: Headers;
+};
+export type deleteNamespaceResponse = deleteNamespaceResponseSuccess | deleteNamespaceResponseError;
+export declare const getDeleteNamespaceUrl: (namespaceName: string) => string;
+/**
+ * Deletes one of the project's namespaces together with every event and version in it.
+ * Publishing or subscribing to those events fails from then on. Platform namespaces cannot be
+ * deleted.
+ * @summary Delete a namespace
+ */
+export declare const deleteNamespace: (namespaceName: string, options?: RequestInit, fetchFn?: typeof globalThis.fetch) => Promise<deleteNamespaceResponse>;
 export type listEventsResponse200 = {
     data: EventList;
     status: 200;
@@ -66,8 +287,7 @@ export type listEventsResponseError = (listEventsResponse400 | listEventsRespons
 export type listEventsResponse = listEventsResponseSuccess | listEventsResponseError;
 export declare const getListEventsUrl: (params?: ListEventsParams) => string;
 /**
- * Returns the global events visible to the project and the project's own events. Ordered by
- * name.
+ * Returns the platform events and the project's own events. Ordered by name.
  * @summary List event definitions
  */
 export declare const listEvents: (params?: ListEventsParams, options?: RequestInit, fetchFn?: typeof globalThis.fetch) => Promise<listEventsResponse>;
@@ -87,6 +307,10 @@ export type createEventResponse403 = {
     data: Error;
     status: 403;
 };
+export type createEventResponse404 = {
+    data: Error;
+    status: 404;
+};
 export type createEventResponse409 = {
     data: Error;
     status: 409;
@@ -98,14 +322,14 @@ export type createEventResponse503 = {
 export type createEventResponseSuccess = createEventResponse201 & {
     headers: Headers;
 };
-export type createEventResponseError = (createEventResponse400 | createEventResponse401 | createEventResponse403 | createEventResponse409 | createEventResponse503) & {
+export type createEventResponseError = (createEventResponse400 | createEventResponse401 | createEventResponse403 | createEventResponse404 | createEventResponse409 | createEventResponse503) & {
     headers: Headers;
 };
 export type createEventResponse = createEventResponseSuccess | createEventResponseError;
 export declare const getCreateEventUrl: () => string;
 /**
- * Creates a project event with its first version. The name is unique within the project. The
- * first segment of the name is the event's namespace and must not be a platform namespace.
+ * Creates an event with its first version in one of the project's namespaces. The first
+ * segment of the name is that namespace, followed by at least a resource and an action.
  * @summary Create an event definition
  */
 export declare const createEvent: (createEventRequest: CreateEventRequest, options?: RequestInit, fetchFn?: typeof globalThis.fetch) => Promise<createEventResponse>;
@@ -260,53 +484,58 @@ export declare const getGetEventVersionUrl: (eventName: string, version: number)
  * @summary Get an event version
  */
 export declare const getEventVersion: (eventName: string, version: number, options?: RequestInit, fetchFn?: typeof globalThis.fetch) => Promise<getEventVersionResponse>;
-export type publishEventResponse202 = {
+export type publishEventsResponse202 = {
     data: PublishResponse;
     status: 202;
 };
-export type publishEventResponse400 = {
+export type publishEventsResponse400 = {
     data: Error;
     status: 400;
 };
-export type publishEventResponse401 = {
+export type publishEventsResponse401 = {
     data: Error;
     status: 401;
 };
-export type publishEventResponse403 = {
+export type publishEventsResponse403 = {
     data: Error;
     status: 403;
 };
-export type publishEventResponse404 = {
+export type publishEventsResponse404 = {
     data: Error;
     status: 404;
 };
-export type publishEventResponse409 = {
+export type publishEventsResponse409 = {
     data: Error;
     status: 409;
 };
-export type publishEventResponse503 = {
+export type publishEventsResponse503 = {
     data: Error;
     status: 503;
 };
-export type publishEventResponseSuccess = publishEventResponse202 & {
+export type publishEventsResponseSuccess = publishEventsResponse202 & {
     headers: Headers;
 };
-export type publishEventResponseError = (publishEventResponse400 | publishEventResponse401 | publishEventResponse403 | publishEventResponse404 | publishEventResponse409 | publishEventResponse503) & {
+export type publishEventsResponseError = (publishEventsResponse400 | publishEventsResponse401 | publishEventsResponse403 | publishEventsResponse404 | publishEventsResponse409 | publishEventsResponse503) & {
     headers: Headers;
 };
-export type publishEventResponse = publishEventResponseSuccess | publishEventResponseError;
-export declare const getPublishEventUrl: (eventName: string) => string;
+export type publishEventsResponse = publishEventsResponseSuccess | publishEventsResponseError;
+export declare const getPublishEventsUrl: () => string;
 /**
- * Validates the payload against the selected version and publishes the message. The response
- * carries the message identity; it does not mean a consumer received it. A version of zero
- * selects the highest active version.
- * @summary Publish an event message
+ * Validates every message against its selected version and publishes the batch. If any message
+ * is rejected, none is published. The response carries the identity of each message in request
+ * order; it does not mean a consumer received it. Only events defined by the current project can
+ * be published here.
+ * @summary Publish event messages
  */
-export declare const publishEvent: (eventName: string, publishRequest: PublishRequest, options?: RequestInit, fetchFn?: typeof globalThis.fetch) => Promise<publishEventResponse>;
+export declare const publishEvents: (publishRequest: PublishRequest, options?: RequestInit, fetchFn?: typeof globalThis.fetch) => Promise<publishEventsResponse>;
 export type createRealtimeTicketResponse201 = {
     data: RealtimeTicket;
     status: 201;
 };
+export type createRealtimeTicketResponse400 = {
+    data: Error;
+    status: 400;
+};
 export type createRealtimeTicketResponse401 = {
     data: Error;
     status: 401;
@@ -315,6 +544,10 @@ export type createRealtimeTicketResponse403 = {
     data: Error;
     status: 403;
 };
+export type createRealtimeTicketResponse404 = {
+    data: Error;
+    status: 404;
+};
 export type createRealtimeTicketResponse503 = {
     data: Error;
     status: 503;
@@ -322,15 +555,59 @@ export type createRealtimeTicketResponse503 = {
 export type createRealtimeTicketResponseSuccess = createRealtimeTicketResponse201 & {
     headers: Headers;
 };
-export type createRealtimeTicketResponseError = (createRealtimeTicketResponse401 | createRealtimeTicketResponse403 | createRealtimeTicketResponse503) & {
+export type createRealtimeTicketResponseError = (createRealtimeTicketResponse400 | createRealtimeTicketResponse401 | createRealtimeTicketResponse403 | createRealtimeTicketResponse404 | createRealtimeTicketResponse503) & {
     headers: Headers;
 };
 export type createRealtimeTicketResponse = createRealtimeTicketResponseSuccess | createRealtimeTicketResponseError;
 export declare const getCreateRealtimeTicketUrl: () => string;
 /**
- * Issues a short-lived ticket for a realtime connection. Connect to `url`, pass the ticket,
- * then authenticate the connection with a scoped token. A ticket is not a bearer token for
- * other APIs.
+ * Issues a short-lived ticket for the named events in the current project. For an event defined
+ * by the project, the ticket covers messages sent to the members of the project and messages
+ * sent to the caller within it. For a platform event, it also covers messages sent to the caller
+ * outside any project and messages sent to no recipient; messages sent within the project are
+ * covered as far as the caller's current permissions allow, which may be limited to some
+ * resources or to none. The caller must still be a member of the project. The ticket lives no
+ * longer than the scoped token it was created with. It is not a bearer token for other APIs.
  * @summary Create a realtime ticket
  */
-export declare const createRealtimeTicket: (options?: RequestInit, fetchFn?: typeof globalThis.fetch) => Promise<createRealtimeTicketResponse>;
+export declare const createRealtimeTicket: (realtimeTicketRequest: RealtimeTicketRequest, options?: RequestInit, fetchFn?: typeof globalThis.fetch) => Promise<createRealtimeTicketResponse>;
+export type createAccountRealtimeTicketResponse201 = {
+    data: RealtimeTicket;
+    status: 201;
+};
+export type createAccountRealtimeTicketResponse400 = {
+    data: Error;
+    status: 400;
+};
+export type createAccountRealtimeTicketResponse401 = {
+    data: Error;
+    status: 401;
+};
+export type createAccountRealtimeTicketResponse403 = {
+    data: Error;
+    status: 403;
+};
+export type createAccountRealtimeTicketResponse404 = {
+    data: Error;
+    status: 404;
+};
+export type createAccountRealtimeTicketResponse503 = {
+    data: Error;
+    status: 503;
+};
+export type createAccountRealtimeTicketResponseSuccess = createAccountRealtimeTicketResponse201 & {
+    headers: Headers;
+};
+export type createAccountRealtimeTicketResponseError = (createAccountRealtimeTicketResponse400 | createAccountRealtimeTicketResponse401 | createAccountRealtimeTicketResponse403 | createAccountRealtimeTicketResponse404 | createAccountRealtimeTicketResponse503) & {
+    headers: Headers;
+};
+export type createAccountRealtimeTicketResponse = createAccountRealtimeTicketResponseSuccess | createAccountRealtimeTicketResponseError;
+export declare const getCreateAccountRealtimeTicketUrl: () => string;
+/**
+ * Issues a short-lived ticket for a caller who has not selected a project, or belongs to none. Only
+ * platform events are accepted, and the ticket covers only messages sent to the caller outside
+ * any project or to no recipient. The ticket cannot publish. Its `client_id_prefix` is `user.{user_id}.`. The
+ * ticket lives no longer than the token it was created with.
+ * @summary Create an account realtime ticket
+ */
+export declare const createAccountRealtimeTicket: (realtimeTicketRequest: RealtimeTicketRequest, options?: RequestInit, fetchFn?: typeof globalThis.fetch) => Promise<createAccountRealtimeTicketResponse>;