@leaflow/sdk 0.0.0-dev.49.g6065fbb → 0.0.0-dev.494.g12e1b53

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

@@ -0,0 +1,2280 @@
+/**
+ * Generated by orval 🍺
+ * Do not edit manually.
+ * Leaflow Assistant API
+ * Conversations with agents that operate the Leaflow platform, plus their folders, tasks, files and
+ * chat-app channels.
+ *
+ * A conversation is a thread. A person talks to the main thread; the agent in it can start subagents,
+ * which are threads too and run on their own: stopping the main thread does not stop them, and each
+ * subagent tells its parent when it ends. A thread runs in turns; each turn records the model and
+ * reasoning effort it used and its token usage.
+ *
+ * Models come from the Canopy catalogue. A new thread uses the model it names, the caller's default
+ * from /api/v1/settings, or the first catalogue model that can run an agent. Reasoning models take one
+ * 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
+ * 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.
+ *
+ * Files uploaded that way are listed by search-attachments. Renaming or removing one does not change
+ * the conversations that already use it; downloading keeps working.
+ * OpenAPI spec version: 2.0.0
+ */
+export interface FieldViolation {
+    /** The path to the rejected field in the request body, such as `items[2].price_id`. */
+    field: string;
+    /** Why the field was rejected, such as `REQUIRED` or `OUT_OF_RANGE`. */
+    reason?: string;
+}
+/**
+ * Values that belong to `reason`, one set per reason. Clients use them to fill in
+ * localized text and never parse `message` to obtain them. Keys are documented per
+ * reason; a key that has appeared once keeps appearing.
+ */
+export type ErrorStatusMetadata = {
+    [key: string]: string;
+};
+export interface ErrorStatus {
+    /** The HTTP status code of the response. */
+    code: number;
+    /** The canonical name of the status, such as `INVALID_ARGUMENT` or `UNAVAILABLE`. */
+    status: string;
+    /**
+     * A description of the failure for developers. It is always English and is not meant
+     * to be shown to end users as is.
+     */
+    message: string;
+    /**
+     * A stable machine-readable code identifying the failure. Clients branch on this value
+     * and render their own text; it does not change once published.
+     */
+    reason?: string;
+    /**
+     * Values that belong to `reason`, one set per reason. Clients use them to fill in
+     * localized text and never parse `message` to obtain them. Keys are documented per
+     * reason; a key that has appeared once keeps appearing.
+     */
+    metadata?: ErrorStatusMetadata;
+    /**
+     * Request fields rejected by the request's constraints. Present on validation
+     * failures; one request may violate several fields.
+     */
+    field_violations?: FieldViolation[];
+    /**
+     * How long the client should wait before retrying, as a duration string such as
+     * `30s`. Present only when waiting can succeed.
+     */
+    retry_delay?: string;
+    /**
+     * The identifier of the request in the service's logs. Quote it when reporting a
+     * failure.
+     */
+    request_id?: string;
+}
+/**
+ * A failed request. The envelope follows the Google REST error format: `code` is the HTTP
+ * status, `status` is its canonical name, and `reason` is the stable machine-readable code
+ * that identifies the failure.
+ */
+export interface Error {
+    error: ErrorStatus;
+}
+/**
+ * Tokens reported by Canopy. Cache hit rate is cachedInputTokens / inputTokens.
+ */
+export interface Usage {
+    /**
+     * Prompt tokens, including cached ones.
+     * @minimum 0
+     */
+    inputTokens: number;
+    /**
+     * Prompt tokens read from the provider's cache.
+     * @minimum 0
+     */
+    cachedInputTokens: number;
+    /**
+     * Prompt tokens written to the provider's cache. Zero for providers that do not report it.
+     * @minimum 0
+     */
+    cacheWriteTokens: number;
+    /**
+     * Output tokens, including reasoning.
+     * @minimum 0
+     */
+    outputTokens: number;
+    /**
+     * Output tokens spent on reasoning.
+     * @minimum 0
+     */
+    reasoningTokens: number;
+    /** @minimum 0 */
+    totalTokens: number;
+    /**
+     * Model requests made.
+     * @minimum 0
+     */
+    requests: number;
+    /** False while a request has not reported its usage yet, so the numbers may still grow. */
+    complete: boolean;
+}
+/**
+ * How much the model reasons before answering. Sent to the model unchanged.
+ */
+export type ReasoningEffort = (typeof ReasoningEffort)[keyof typeof ReasoningEffort];
+export declare const ReasoningEffort: {
+    readonly low: "low";
+    readonly medium: "medium";
+    readonly high: "high";
+};
+/**
+ * `manual` asks a person before tools that change something, `guardian` lets an automatic reviewer decide, `yolo` runs them without asking.
+ */
+export type ApprovalMode = (typeof ApprovalMode)[keyof typeof ApprovalMode];
+export declare const ApprovalMode: {
+    readonly manual: "manual";
+    readonly guardian: "guardian";
+    readonly yolo: "yolo";
+};
+/**
+ * What the thread is doing. `waiting` is waiting for subagents or tasks it started; `awaiting_approval` and `awaiting_input` wait for a person.
+ */
+export type ThreadStatus = (typeof ThreadStatus)[keyof typeof ThreadStatus];
+export declare const ThreadStatus: {
+    readonly idle: "idle";
+    readonly starting: "starting";
+    readonly running: "running";
+    readonly waiting: "waiting";
+    readonly awaiting_approval: "awaiting_approval";
+    readonly awaiting_input: "awaiting_input";
+};
+/**
+ * `declined` ended because a person declined a tool call; `cancelled` was stopped.
+ */
+export type TurnStatus = (typeof TurnStatus)[keyof typeof TurnStatus];
+export declare const TurnStatus: {
+    readonly running: "running";
+    readonly completed: "completed";
+    readonly failed: "failed";
+    readonly declined: "declined";
+    readonly cancelled: "cancelled";
+};
+/**
+ * `main` for a conversation with a person, `subagent` for one started by another agent.
+ */
+export type ThreadResourceRole = (typeof ThreadResourceRole)[keyof typeof ThreadResourceRole];
+export declare const ThreadResourceRole: {
+    readonly main: "main";
+    readonly subagent: "subagent";
+};
+/**
+ * Where this step stands. At most one step is in_progress at any time.
+ */
+export type TodoResourceStatus = (typeof TodoResourceStatus)[keyof typeof TodoResourceStatus];
+export declare const TodoResourceStatus: {
+    readonly pending: "pending";
+    readonly in_progress: "in_progress";
+    readonly completed: "completed";
+};
+export interface TodoResource {
+    /** The step as an instruction — "Install nginx". */
+    content: string;
+    /** The same step phrased as happening now — "Installing nginx". Show this one while the step is in progress. */
+    activeForm: string;
+    /** Where this step stands. At most one step is in_progress at any time. */
+    status: TodoResourceStatus;
+}
+export type PendingActionResourceType = (typeof PendingActionResourceType)[keyof typeof PendingActionResourceType];
+export declare const PendingActionResourceType: {
+    readonly approval: "approval";
+    readonly question: "question";
+};
+/**
+ * A tool call that cannot continue until a person approves it or answers it.
+ */
+export interface PendingActionResource {
+    /** The conversation the tool call belongs to; a subagent's id when the subagent is the one waiting. */
+    threadId: string;
+    /**
+     * The waiting tool calls. Approvals come in batches; a question is a single item.
+     * @minItems 1
+     */
+    itemIds: string[];
+    type: PendingActionResourceType;
+}
+export interface SubagentCountResource {
+    /** @minimum 0 */
+    total: number;
+    /** @minimum 0 */
+    running: number;
+}
+/**
+ * `message` answers messages; `compaction` summarizes the history to free the context window.
+ */
+export type TurnType = (typeof TurnType)[keyof typeof TurnType];
+export declare const TurnType: {
+    readonly message: "message";
+    readonly compaction: "compaction";
+};
+export interface LastTurnResource {
+    id: string;
+    type: TurnType;
+    status: TurnStatus;
+    /**
+     * Why the turn failed. Null unless status is failed.
+     * @nullable
+     */
+    failureCode: string | null;
+    /** @nullable */
+    completedAt: string | null;
+}
+/**
+ * How much of the model's context window the conversation occupies.
+ */
+export interface ContextUsageResource {
+    /**
+     * Prompt tokens of the latest model request. Null before the first request.
+     * @nullable
+     */
+    usedTokens: number | null;
+    /**
+     * The context window of the conversation's model. Null when the model is not in the catalogue.
+     * @nullable
+     */
+    windowTokens: number | null;
+}
+/**
+ * A conversation with an agent. The main conversation and its subagents have the same shape;
+ * `role` tells them apart.
+ */
+export interface ThreadResource {
+    id: string;
+    /** `main` for a conversation with a person, `subagent` for one started by another agent. */
+    role: ThreadResourceRole;
+    /**
+     * The conversation that started this subagent. Null for main conversations.
+     * @nullable
+     */
+    parentId: string | null;
+    /**
+     * The subagent's name, unique among the subagents of its parent. Null for main conversations.
+     * @nullable
+     */
+    agentName: string | null;
+    /**
+     * Null until the conversation has a name.
+     * @nullable
+     */
+    title: string | null;
+    /**
+     * The folder that holds this conversation. Null for subagents, which are not filed.
+     * @nullable
+     */
+    folderId: string | null;
+    /**
+     * The version of this conversation's place in its folder. Pass it as `expectedVersion` when moving it.
+     * @minimum 0
+     */
+    orderVersion: number;
+    /** The Canopy model the next model request uses. */
+    modelId: string;
+    /** Null when the model does not reason. */
+    reasoningEffort: ReasoningEffort | null;
+    approvalMode: ApprovalMode;
+    status: ThreadStatus;
+    /**
+     * What the assistant is doing right now, for example "Reading nginx.conf". Null when idle.
+     * @nullable
+     */
+    activity: string | null;
+    /**
+     * The beginning of the assistant's latest message.
+     * @nullable
+     */
+    recentMessage: string | null;
+    /** The assistant's current plan, in order. Empty when it has none. */
+    todos: TodoResource[];
+    /** What this conversation is waiting for from a person. It may belong to one of its subagents. */
+    pendingAction: PendingActionResource | null;
+    subagents: SubagentCountResource;
+    /** The most recent turn. Null before the first message. */
+    lastTurn: LastTurnResource | null;
+    context: ContextUsageResource;
+    /** Token usage over the whole conversation. For a main conversation this includes its subagents. */
+    usage: Usage;
+    /** The assistant replied after the conversation was last marked read. */
+    unread: boolean;
+    archived: boolean;
+    /**
+     * How many messages the person has sent in this conversation, as listed by list-thread-messages.
+     * @minimum 0
+     */
+    messageCount: number;
+    createdAt: string;
+    /** The last activity. Renaming or moving the conversation does not change it. */
+    updatedAt: string;
+}
+/**
+ * @nullable
+ */
+export type MessagePartData = {
+    [key: string]: unknown;
+} | null;
+/**
+ * One piece of a message. `type` says which field carries it:
+ *
+ * - `text` — the words, in `text`
+ * - `file` — an attachment uploaded earlier, by id in `attachmentId`
+ * - `data-<name>` — context from the client, in `data`. The name is shown to the assistant so it
+ *   can tell one block from another.
+ */
+export interface MessagePart {
+    /**
+     * @minLength 1
+     * @maxLength 64
+     */
+    type: string;
+    /** @nullable */
+    text?: string | null;
+    /**
+     * The attachment must have been uploaded and not yet sent with another message.
+     * @nullable
+     */
+    attachmentId?: string | null;
+    /** @nullable */
+    data?: MessagePartData;
+}
+export type ClientActionRequestType = (typeof ClientActionRequestType)[keyof typeof ClientActionRequestType];
+export declare const ClientActionRequestType: {
+    readonly function: "function";
+};
+/**
+ * JSON Schema for the arguments. Omit for an action without arguments.
+ * @nullable
+ */
+export type ClientFunctionRequestParameters = {
+    [key: string]: unknown;
+} | null;
+/**
+ * The MCP and Anthropic name for `parameters`. Give one or the other.
+ * @nullable
+ */
+export type ClientFunctionRequestInputSchema = {
+    [key: string]: unknown;
+} | null;
+export interface ClientFunctionRequest {
+    /**
+     * @minLength 1
+     * @maxLength 64
+     */
+    name: string;
+    /**
+     * What the action does, written for the model. OpenAI's limit on tool descriptions is 1024 characters.
+     * @minLength 1
+     * @maxLength 1024
+     */
+    description: string;
+    /**
+     * JSON Schema for the arguments. Omit for an action without arguments.
+     * @nullable
+     */
+    parameters?: ClientFunctionRequestParameters;
+    /**
+     * The MCP and Anthropic name for `parameters`. Give one or the other.
+     * @nullable
+     */
+    inputSchema?: ClientFunctionRequestInputSchema;
+}
+/**
+ * A tool in the OpenAI Chat Completions format, plus `readOnly` and `timeoutMs`.
+ */
+export interface ClientActionRequest {
+    type?: ClientActionRequestType;
+    function: ClientFunctionRequest;
+    /** True when the action changes nothing outside the client. Other actions go through approval before they run. */
+    readOnly: boolean;
+    /**
+     * How long the assistant waits for this action. Longer values are capped.
+     * @minimum 0
+     */
+    timeoutMs?: number;
+}
+/**
+ * Which client this is and which actions it offers, so the assistant can ask it to run them while
+ * it answers. Send `actions` only when they changed since the last message; omitting them keeps
+ * what was declared before.
+ */
+export interface ClientContextRequest {
+    /**
+     * Identifies this client while it stays open; one per tab or process.
+     * @minLength 1
+     * @maxLength 128
+     */
+    clientId: string;
+    /**
+     * How the client names itself, for example "Leaflow console (web)".
+     * @maxLength 64
+     */
+    label?: string;
+    /**
+     * The actions on offer now. `[]` withdraws all of them; null keeps the previous declaration.
+     * @maxItems 32
+     * @nullable
+     */
+    actions?: ClientActionRequest[] | null;
+}
+export interface SendMessageRequestBody {
+    /**
+     * The message, in the order it was written. A message with nothing but text is a single text
+     * part.
+     * @minItems 1
+     */
+    parts: MessagePart[];
+    client?: ClientContextRequest;
+}
+export interface CreateThreadRequestBody {
+    /**
+     * @minLength 1
+     * @maxLength 255
+     */
+    title?: string;
+    /**
+     * The folder to file it in. Omit for the inbox.
+     * @maxLength 64
+     */
+    folderId?: string;
+    /**
+     * Omit to use the caller's default model.
+     * @minLength 1
+     * @maxLength 128
+     */
+    modelId?: string;
+    /** Omit to use the caller's default effort, or medium. */
+    reasoningEffort?: ReasoningEffort;
+    approvalMode?: ApprovalMode;
+    message?: SendMessageRequestBody;
+}
+export interface CreateThreadResponseBody {
+    thread: ThreadResource;
+    /**
+     * The turn started by `message`. Null when no message was sent.
+     * @nullable
+     */
+    turnId: string | null;
+}
+/**
+ * Defaults to main unless parentId is given.
+ */
+export type SearchThreadsRequestBodyRole = (typeof SearchThreadsRequestBodyRole)[keyof typeof SearchThreadsRequestBodyRole];
+export declare const SearchThreadsRequestBodyRole: {
+    readonly main: "main";
+    readonly subagent: "subagent";
+};
+/**
+ * `needs_action` is waiting for a person or ended with a failure, `running` is working,
+ * and `done` is everything else.
+ */
+export type SearchThreadsRequestBodyState = (typeof SearchThreadsRequestBodyState)[keyof typeof SearchThreadsRequestBodyState];
+export declare const SearchThreadsRequestBodyState: {
+    readonly needs_action: "needs_action";
+    readonly running: "running";
+    readonly done: "done";
+};
+/**
+ * `attention` puts conversations that need action first, then running ones, then the most
+ * recent. `recent` orders by last activity. `manual` is the order inside a folder and requires
+ * folderId.
+ */
+export type SearchThreadsRequestBodySort = (typeof SearchThreadsRequestBodySort)[keyof typeof SearchThreadsRequestBodySort];
+export declare const SearchThreadsRequestBodySort: {
+    readonly attention: "attention";
+    readonly recent: "recent";
+    readonly manual: "manual";
+};
+export type SearchThreadsRequestBodyIncludeItem = (typeof SearchThreadsRequestBodyIncludeItem)[keyof typeof SearchThreadsRequestBodyIncludeItem];
+export declare const SearchThreadsRequestBodyIncludeItem: {
+    readonly counts: "counts";
+};
+export interface SearchThreadsRequestBody {
+    /**
+     * Read these conversations, including subagents and archived ones. Cannot be combined with cursor.
+     * @minItems 1
+     * @maxItems 200
+     */
+    ids?: string[];
+    /**
+     * Only conversations in this folder.
+     * @maxLength 64
+     */
+    folderId?: string;
+    /**
+     * Only the subagents of this conversation.
+     * @maxLength 64
+     */
+    parentId?: string;
+    /** Defaults to main unless parentId is given. */
+    role?: SearchThreadsRequestBodyRole;
+    /**
+     * `needs_action` is waiting for a person or ended with a failure, `running` is working,
+     * and `done` is everything else.
+     */
+    state?: SearchThreadsRequestBodyState;
+    /** True for archived conversations only; otherwise unarchived only. */
+    archived?: boolean;
+    /**
+     * Matches titles, case-insensitively.
+     * @maxLength 100
+     */
+    q?: string;
+    /**
+     * `attention` puts conversations that need action first, then running ones, then the most
+     * recent. `recent` orders by last activity. `manual` is the order inside a folder and requires
+     * folderId.
+     */
+    sort?: SearchThreadsRequestBodySort;
+    /** @maxLength 1024 */
+    cursor?: string;
+    /**
+     * @minimum 1
+     * @maximum 200
+     */
+    limit?: number;
+    /** Optional parts of the response. `counts` adds `counts`. */
+    include?: SearchThreadsRequestBodyIncludeItem[];
+}
+/**
+ * Counts over everything the criteria match, not only this page. `state`, `q` and the cursor are ignored.
+ */
+export interface ThreadCountsResource {
+    /** @minimum 0 */
+    total: number;
+    /** @minimum 0 */
+    needsAction: number;
+    /** @minimum 0 */
+    running: number;
+    /** @minimum 0 */
+    unread: number;
+}
+export interface ThreadListResponseBody {
+    threads: ThreadResource[];
+    /**
+     * Null on the last page.
+     * @nullable
+     */
+    nextCursor: string | null;
+    /** Null unless `include` asked for it. */
+    counts: ThreadCountsResource | null;
+}
+export interface UpdateThreadRequestBody {
+    /**
+     * @minLength 1
+     * @maxLength 255
+     */
+    title?: string;
+    /**
+     * @minLength 1
+     * @maxLength 128
+     */
+    modelId?: string;
+    reasoningEffort?: ReasoningEffort | null;
+    approvalMode?: ApprovalMode;
+    archived?: boolean;
+}
+export interface ResumeThreadRequestBody {
+    /**
+     * Added to the conversation before the turn starts.
+     * @maxLength 20000
+     */
+    message?: string;
+}
+export interface TurnStartedResponseBody {
+    turnId: string;
+}
+export interface RevertRequestBody {
+    /**
+     * The first item to revert; it and everything after it are reverted.
+     * @minimum 0
+     */
+    ordinal: number;
+}
+export interface RevertedCountResponseBody {
+    /** @minimum 0 */
+    reverted: number;
+}
+/**
+ * Pagination metadata for stable numbered pages. total_count is returned only when the operation can determine it without an unbounded scan.
+ */
+export interface OffsetPagination {
+    /** @minimum 1 */
+    page: number;
+    /** @minimum 1 */
+    page_size: number;
+    /** @minimum 0 */
+    total_count?: number;
+}
+/**
+ * Pagination metadata for keyset traversal. Pass next_cursor as cursor to read the following page; null means there is no following page.
+ */
+export interface CursorPagination {
+    /** @minimum 1 */
+    page_size: number;
+    /** @nullable */
+    next_cursor?: string | null;
+}
+/**
+ * One run of the agent, from the message that started it until it stopped.
+ */
+export interface ThreadTurnResource {
+    id: string;
+    threadId: string;
+    type: TurnType;
+    status: TurnStatus;
+    /**
+     * The first item the turn wrote. Null before it has written one.
+     * @nullable
+     */
+    firstOrdinal: number | null;
+    /**
+     * The last item the turn wrote so far.
+     * @nullable
+     */
+    lastOrdinal: number | null;
+    /**
+     * The beginning of the message that started the turn. Null for compaction turns and turns started by the assistant itself.
+     * @nullable
+     */
+    preview: string | null;
+    modelId: string;
+    reasoningEffort: ReasoningEffort | null;
+    approvalMode: ApprovalMode;
+    /**
+     * Why the turn failed. Null unless status is failed.
+     * @nullable
+     */
+    failureCode: string | null;
+    /**
+     * How many tools the turn called.
+     * @minimum 0
+     */
+    toolCalls: number;
+    /** Tokens used by every model request of this turn, including title generation, review and compaction. */
+    usage: Usage;
+    /**
+     * An estimate of the output tokens of the model request in progress, which `usage` does not
+     * count yet. It grows about once a second while the model writes and returns to 0 when the
+     * request ends and its exact usage is added. Show `usage.outputTokens` plus this while the turn
+     * runs.
+     * @minimum 0
+     */
+    streamingOutputTokens: number;
+    startedAt: string;
+    /**
+     * When the first output token arrived. Null until then.
+     * @nullable
+     */
+    firstTokenAt: string | null;
+    /**
+     * Null while the turn is running.
+     * @nullable
+     */
+    completedAt: string | null;
+}
+export interface ThreadTurnListResponseBody {
+    /** Newest first. */
+    turns: ThreadTurnResource[];
+    /** @nullable */
+    nextCursor: string | null;
+}
+export type ThreadItemResourceType = (typeof ThreadItemResourceType)[keyof typeof ThreadItemResourceType];
+export declare const ThreadItemResourceType: {
+    readonly user_message: "user_message";
+    readonly external_message: "external_message";
+    readonly agent_message: "agent_message";
+    readonly reasoning: "reasoning";
+    readonly tool_call: "tool_call";
+    readonly compaction: "compaction";
+    readonly token_budget_reminder: "token_budget_reminder";
+    readonly turn_failure: "turn_failure";
+};
+/**
+ * `queued` is a message sent while the assistant was busy that it has not read yet.
+ */
+export type ThreadItemResourceStatus = (typeof ThreadItemResourceStatus)[keyof typeof ThreadItemResourceStatus];
+export declare const ThreadItemResourceStatus: {
+    readonly queued: "queued";
+    readonly pending: "pending";
+    readonly in_progress: "in_progress";
+    readonly completed: "completed";
+    readonly failed: "failed";
+    readonly declined: "declined";
+    readonly cancelled: "cancelled";
+};
+/**
+ * `subagent` for a subagent reporting to its parent, `thread` for another of the person's
+ * conversations, `task` for a task, `channel` for a chat app.
+ */
+export type ItemSourceResourceType = (typeof ItemSourceResourceType)[keyof typeof ItemSourceResourceType];
+export declare const ItemSourceResourceType: {
+    readonly subagent: "subagent";
+    readonly thread: "thread";
+    readonly task: "task";
+    readonly channel: "channel";
+};
+export interface ItemSourceResource {
+    /**
+     * `subagent` for a subagent reporting to its parent, `thread` for another of the person's
+     * conversations, `task` for a task, `channel` for a chat app.
+     */
+    type: ItemSourceResourceType;
+    /** The conversation, task or channel the message came from. */
+    id: string;
+}
+export type PartResourceType = (typeof PartResourceType)[keyof typeof PartResourceType];
+export declare const PartResourceType: {
+    readonly text: "text";
+    readonly file: "file";
+};
+export interface PartResource {
+    /**
+     * Addresses this part in the realtime stream: text arrives as `append` frames pointing at
+     * `/items/{item}/parts/{id}/text`. Not an array index.
+     */
+    id: string;
+    type: PartResourceType;
+    /**
+     * For `text` parts. Grows as the answer is written.
+     * @nullable
+     */
+    text: string | null;
+    /**
+     * For `file` parts. Points at one of the item's `attachments`.
+     * @nullable
+     */
+    attachmentId: string | null;
+}
+/**
+ * A client renders an image in place and everything else as a file to download.
+ */
+export type AttachmentResourceType = (typeof AttachmentResourceType)[keyof typeof AttachmentResourceType];
+export declare const AttachmentResourceType: {
+    readonly image: "image";
+    readonly text: "text";
+    readonly binary: "binary";
+};
+export interface AttachmentResource {
+    id: string;
+    /** A client renders an image in place and everything else as a file to download. */
+    type: AttachmentResourceType;
+    filename: string;
+    byteSize: number;
+    /**
+     * Null unless type is image. Lets a client hold the space before the image loads.
+     * @nullable
+     */
+    width: number | null;
+    /**
+     * Null unless type is image.
+     * @nullable
+     */
+    height: number | null;
+}
+export type ClientContextPartData = {
+    [key: string]: unknown;
+};
+/**
+ * A `data-*` part as the client sent it.
+ */
+export interface ClientContextPart {
+    type: string;
+    data: ClientContextPartData;
+}
+/**
+ * Determines which of the remaining fields is populated.
+ */
+export type PresentationResourceType = (typeof PresentationResourceType)[keyof typeof PresentationResourceType];
+export declare const PresentationResourceType: {
+    readonly file_diff: "file_diff";
+};
+export type FileDiffResourceStatus = (typeof FileDiffResourceStatus)[keyof typeof FileDiffResourceStatus];
+export declare const FileDiffResourceStatus: {
+    readonly added: "added";
+    readonly modified: "modified";
+    readonly deleted: "deleted";
+};
+/**
+ * The change a tool call applied to a single file. Present once the call has completed; while it
+ * awaits approval, derive a preview from its `old_string` and `new_string` arguments.
+ */
+export interface FileDiffResource {
+    /** Absolute path of the file on the instance. */
+    path: string;
+    status: FileDiffResourceStatus;
+    /** Lines added. Complete even when `unified` is null. */
+    added: number;
+    /** Lines removed. Complete even when `unified` is null. */
+    removed: number;
+    /**
+     * The change as a unified diff with three lines of context. Null when it exceeds the size limit.
+     * @nullable
+     */
+    unified: string | null;
+}
+/**
+ * Structured detail produced by a tool call, in addition to the one-line `detail`.
+ */
+export interface PresentationResource {
+    /** Determines which of the remaining fields is populated. */
+    type: PresentationResourceType;
+    fileDiff: FileDiffResource | null;
+}
+/**
+ * Whether the call needed a decision before it ran. Null for calls that need none.
+ * `auto_approved` was approved by the automatic reviewer.
+ * @nullable
+ */
+export type ToolCallResourceApprovalStatus = (typeof ToolCallResourceApprovalStatus)[keyof typeof ToolCallResourceApprovalStatus] | null;
+export declare const ToolCallResourceApprovalStatus: {
+    readonly pending: "pending";
+    readonly reviewing: "reviewing";
+    readonly approved: "approved";
+    readonly auto_approved: "auto_approved";
+    readonly declined: "declined";
+    readonly unreviewed: "unreviewed";
+};
+/**
+ * Who decided the call. `user` is the person, in the console or a chat app; `auto_review` is
+ * the automatic reviewer; `policy` is the tool itself, which cannot be called this way. Null
+ * when nobody decided, including calls that needed no decision.
+ * @nullable
+ */
+export type ToolCallResourceApprovalSource = (typeof ToolCallResourceApprovalSource)[keyof typeof ToolCallResourceApprovalSource] | null;
+export declare const ToolCallResourceApprovalSource: {
+    readonly user: "user";
+    readonly auto_review: "auto_review";
+    readonly policy: "policy";
+};
+export interface ChoiceResource {
+    label: string;
+    description: string;
+}
+export interface QuestionResource {
+    id: string;
+    /** A short label for the question. */
+    header: string;
+    question: string;
+    /** Suggested answers. A free-form answer is accepted as well. */
+    choices: ChoiceResource[];
+}
+/**
+ * The answers given so far, by question id. Null for other calls.
+ * @nullable
+ */
+export type ToolCallResourceAnswers = {
+    [key: string]: string;
+} | null;
+export interface ToolCallResource {
+    /** The tool's group, for example `instance`, `leaflow`, `agent` or `client`. Empty for tools without one. */
+    namespace: string;
+    tool: string;
+    /** The arguments as JSON text. Cut in lists when long; then it is no longer valid JSON. */
+    arguments: string;
+    /**
+     * What the call acts on, for display, such as a file path or an instance name.
+     * @nullable
+     */
+    target: string | null;
+    /**
+     * A one-line description of what the call did.
+     * @nullable
+     */
+    detail: string | null;
+    presentation: PresentationResource | null;
+    /**
+     * Whether the call needed a decision before it ran. Null for calls that need none.
+     * `auto_approved` was approved by the automatic reviewer.
+     * @nullable
+     */
+    approvalStatus: ToolCallResourceApprovalStatus;
+    /** @nullable */
+    approvalReason: string | null;
+    /**
+     * Who decided the call. `user` is the person, in the console or a chat app; `auto_review` is
+     * the automatic reviewer; `policy` is the tool itself, which cannot be called this way. Null
+     * when nobody decided, including calls that needed no decision.
+     * @nullable
+     */
+    approvalSource: ToolCallResourceApprovalSource;
+    /**
+     * When a person or the reviewer decided the call or answered its questions.
+     * @nullable
+     */
+    decidedAt: string | null;
+    /**
+     * The questions of an `ask` call. Null for other calls.
+     * @nullable
+     */
+    questions: QuestionResource[] | null;
+    /**
+     * The answers given so far, by question id. Null for other calls.
+     * @nullable
+     */
+    answers: ToolCallResourceAnswers;
+    /**
+     * How long an `ask` call waits before it continues with its default answers. Null when it waits indefinitely.
+     * @nullable
+     */
+    autoAnswerMs: number | null;
+}
+/**
+ * One entry of the transcript. `type` determines which fields it carries.
+ */
+export interface ThreadItemResource {
+    id: string;
+    /**
+     * The position in the transcript. Never renumbered. Null for a message waiting in the queue.
+     * @nullable
+     */
+    ordinal: number | null;
+    /**
+     * The turn that wrote this item. Null for messages waiting in the queue.
+     * @nullable
+     */
+    turnId: string | null;
+    type: ThreadItemResourceType;
+    /** `queued` is a message sent while the assistant was busy that it has not read yet. */
+    status: ThreadItemResourceStatus;
+    /** Left out of model requests since a revert. Shown, but marked. */
+    reverted: boolean;
+    /** Long reasoning or tool arguments were cut from this list; read the item for all of it. */
+    truncated: boolean;
+    /** Who wrote an `external_message`. Null for other items. */
+    source: ItemSourceResource | null;
+    /**
+     * The Canopy model that produced this item. Null for messages a person or another source sent.
+     * @nullable
+     */
+    modelId: string | null;
+    /**
+     * How long the reasoning or the tool call took. Null while it runs and for other items.
+     * @nullable
+     */
+    durationMs: number | null;
+    /**
+     * The content, in the order it was written. Text arrives as `append` frames on the realtime
+     * stream. An attachment belongs where it was written, so render parts in order. Empty for
+     * tool calls; their outcome is in `toolCall.detail` and `toolCall.presentation`.
+     */
+    parts: PartResource[];
+    attachments: AttachmentResource[];
+    /**
+     * The `data-*` blocks the client attached to a user message. They are not part of what the
+     * person wrote; render the message from `parts` and leave these out of the bubble.
+     */
+    clientContext: ClientContextPart[];
+    /** The call, for a `tool_call` item. Null for other items. */
+    toolCall: ToolCallResource | null;
+    /**
+     * The position of a `user_message` among the person's messages, from 1, as in
+     * list-thread-messages. Null for other items, and for messages that are reverted or waiting
+     * in the queue.
+     * @minimum 1
+     * @nullable
+     */
+    messageIndex: number | null;
+    createdAt: string;
+}
+/**
+ * One message the person sent, as an entry of the conversation's outline.
+ */
+export interface ThreadMessageResource {
+    /** The transcript item. */
+    id: string;
+    /**
+     * The position among the person's messages, from 1.
+     * @minimum 1
+     */
+    index: number;
+    /** The item's position in the transcript, for list-thread-items `around`. */
+    ordinal: number;
+    turnId: string;
+    /** The beginning of the message's text, at most 120 characters. Empty for a message with only attachments. */
+    preview: string;
+    /**
+     * How many files the message carries.
+     * @minimum 0
+     */
+    attachments: number;
+    createdAt: string;
+}
+export interface ThreadMessageListResponseBody {
+    messages: ThreadMessageResource[];
+    /**
+     * How many messages the person has sent in this conversation, the same as the thread's `messageCount`.
+     * @minimum 0
+     */
+    total: number;
+}
+export interface ThreadItemListResponseBody {
+    /** Oldest first. */
+    items: ThreadItemResource[];
+    /**
+     * The first ordinal of the window; pass as `before` to read the window above. Null when the window is empty.
+     * @nullable
+     */
+    startOrdinal: number | null;
+    /**
+     * The last ordinal of the window; pass as `after` to read the window below. Null when the window is empty.
+     * @nullable
+     */
+    endOrdinal: number | null;
+    hasEarlier: boolean;
+    hasLater: boolean;
+    /** Messages waiting for the assistant, in the order they were sent. Empty unless the window reaches the end. */
+    queued: ThreadItemResource[];
+    /**
+     * Subscribe to the conversation on /api/v1/realtime from this cursor to receive what is
+     * written after this window. Null unless the window reaches the end.
+     * @nullable
+     */
+    streamCursor: string | null;
+}
+export interface SendMessageResponseBody {
+    /**
+     * The turn this message started. Null when it was queued behind a running turn.
+     * @nullable
+     */
+    turnId: string | null;
+    queued: boolean;
+    /**
+     * How many messages were waiting ahead of this one when it was queued.
+     * @minimum 0
+     */
+    queuedAhead: number;
+}
+export interface DecideToolCallsRequestBody {
+    /**
+     * The tool calls awaiting approval, from `pendingAction.itemIds`.
+     * @minItems 1
+     */
+    itemIds: string[];
+    approved: boolean;
+    /**
+     * Passed to the assistant with a decline, so it can change course.
+     * @maxLength 2000
+     */
+    reason?: string;
+}
+/**
+ * A map from question id to the answer.
+ */
+export type AnswerQuestionRequestBodyAnswers = {
+    [key: string]: string;
+};
+export interface AnswerQuestionRequestBody {
+    /** A map from question id to the answer. */
+    answers: AnswerQuestionRequestBodyAnswers;
+}
+export interface ToolResultRequestBody {
+    /**
+     * The client that declared the action. A result from another client is refused.
+     * @minLength 1
+     */
+    clientId: string;
+    ok: boolean;
+    /** What the action produced. At most 64 KiB; use `nextCursor` for more. */
+    output?: string;
+    /**
+     * Why it failed, when `ok` is false. Written for the assistant, which cannot see the screen.
+     * @maxLength 2000
+     */
+    error?: string;
+    /**
+     * Pass when there is more to read; the assistant calls again with it.
+     * @maxLength 500
+     */
+    nextCursor?: string;
+}
+/**
+ * `inbox` holds the conversations nobody filed. Each caller has one per project.
+ */
+export type FolderResourceType = (typeof FolderResourceType)[keyof typeof FolderResourceType];
+export declare const FolderResourceType: {
+    readonly inbox: "inbox";
+    readonly custom: "custom";
+};
+/**
+ * Unarchived conversations in the folder.
+ */
+export interface FolderCountsResource {
+    /** @minimum 0 */
+    total: number;
+    /** @minimum 0 */
+    needsAction: number;
+    /** @minimum 0 */
+    running: number;
+}
+export interface FolderResource {
+    id: string;
+    /** `inbox` holds the conversations nobody filed. Each caller has one per project. */
+    type: FolderResourceType;
+    name: string;
+    counts: FolderCountsResource;
+    /** @minimum 0 */
+    orderVersion: number;
+    createdAt: string;
+    updatedAt: string;
+}
+export interface FolderListResponseBody {
+    folders: FolderResource[];
+}
+export interface CreateFolderRequestBody {
+    /**
+     * @minLength 1
+     * @maxLength 64
+     */
+    name: string;
+}
+export interface UpdateFolderRequestBody {
+    /**
+     * @minLength 1
+     * @maxLength 64
+     */
+    name: string;
+}
+export interface MoveFolderRequestBody {
+    /** @nullable */
+    beforeFolderId: string | null;
+    /** @minimum 0 */
+    expectedVersion: number;
+}
+export interface PlaceThreadRequestBody {
+    /** @nullable */
+    beforeThreadId?: string | null;
+    /** @nullable */
+    afterThreadId?: string | null;
+    /**
+     * The conversation's `orderVersion`.
+     * @minimum 0
+     */
+    expectedVersion: number;
+}
+/**
+ * `completed` is a one-time task whose run has ended.
+ */
+export type TaskResourceStatus = (typeof TaskResourceStatus)[keyof typeof TaskResourceStatus];
+export declare const TaskResourceStatus: {
+    readonly active: "active";
+    readonly paused: "paused";
+    readonly completed: "completed";
+    readonly cancelled: "cancelled";
+};
+export type TaskTriggerType = (typeof TaskTriggerType)[keyof typeof TaskTriggerType];
+export declare const TaskTriggerType: {
+    readonly now: "now";
+    readonly at: "at";
+    readonly interval: "interval";
+    readonly cron: "cron";
+    readonly event: "event";
+};
+/**
+ * What happens when a run is due while the previous one is still going.
+ */
+export type TaskTriggerOverlapPolicy = (typeof TaskTriggerOverlapPolicy)[keyof typeof TaskTriggerOverlapPolicy];
+export declare const TaskTriggerOverlapPolicy: {
+    readonly skip: "skip";
+    readonly buffer_one: "buffer_one";
+};
+/**
+ * When the task runs. `type` determines which fields apply. An `event` task runs when a matching
+ * event message arrives. Messages are delivered as they happen and are not stored: a message
+ * published while delivery is interrupted does not start a run, and a message can arrive late or
+ * more than once.
+ */
+export interface TaskTrigger {
+    type: TaskTriggerType;
+    /**
+     * For `at`.
+     * @nullable
+     */
+    runAt?: string | null;
+    /**
+     * For `interval`.
+     * @minimum 10
+     * @nullable
+     */
+    intervalSeconds?: number | null;
+    /**
+     * For `interval`. Runs fall on anchorAt plus whole intervals. Defaults to the creation time.
+     * @nullable
+     */
+    anchorAt?: string | null;
+    /**
+     * For `cron`. A cron expression evaluated in `timezone`, for example `0 9 * * 1-5`.
+     * @maxLength 128
+     * @nullable
+     */
+    cron?: string | null;
+    /** An IANA time zone for `cron`. */
+    timezone?: string;
+    /** What happens when a run is due while the previous one is still going. */
+    overlapPolicy?: TaskTriggerOverlapPolicy;
+    /**
+     * How late a missed run may still start, for example after a pause or an outage.
+     * @minimum 10
+     */
+    catchupSeconds?: number;
+    /**
+     * For `event`. The full name of the event to listen for.
+     * @maxLength 128
+     * @nullable
+     */
+    event?: string | null;
+    /**
+     * For `event`. A filter on the message key: layers separated by `/`, `+` matching exactly one
+     * layer, and `#` as the last layer matching that layer and every layer below it. Null matches
+     * every key.
+     * @maxLength 512
+     * @nullable
+     */
+    eventKey?: string | null;
+    /**
+     * For `event`. A CEL expression that must be true for a message to count, over `data` (the
+     * payload) and `event` (`name`, `version`, `key`, `sender_id` and `created_at`). Reading a field
+     * the payload does not carry counts as false; use `has()` for optional fields. Null counts every
+     * message.
+     * @maxLength 2048
+     * @nullable
+     */
+    eventCondition?: string | null;
+    /**
+     * For `event`. The number of event-triggered runs after which the task completes. Null means no limit.
+     * @minimum 1
+     * @nullable
+     */
+    maxRuns?: number | null;
+    /**
+     * For `event`. The task stops listening and completes at this time.
+     * @nullable
+     */
+    expiresAt?: string | null;
+    /**
+     * For `event`. The least time between the starts of two event-triggered runs. Messages that
+     * match in between are delivered with the next run.
+     * @minimum 10
+     */
+    cooldownSeconds?: number;
+}
+export type TaskActionType = (typeof TaskActionType)[keyof typeof TaskActionType];
+export declare const TaskActionType: {
+    readonly prompt: "prompt";
+    readonly command: "command";
+};
+/**
+ * What a run does. `type` determines which fields apply.
+ */
+export interface TaskAction {
+    type: TaskActionType;
+    /**
+     * For `prompt`. Sent to the conversation as a message from the task.
+     * @maxLength 20000
+     * @nullable
+     */
+    prompt?: string | null;
+    /**
+     * For `command`. The instance that runs it.
+     * @nullable
+     */
+    instanceId?: string | null;
+    /**
+     * For `command`. A shell command.
+     * @maxLength 20000
+     * @nullable
+     */
+    command?: string | null;
+    /**
+     * For `command`. The run fails with status timed_out after this long.
+     * @minimum 1
+     * @maximum 3600
+     */
+    timeoutSeconds?: number;
+}
+export type TaskRunResourceStatus = (typeof TaskRunResourceStatus)[keyof typeof TaskRunResourceStatus];
+export declare const TaskRunResourceStatus: {
+    readonly queued: "queued";
+    readonly running: "running";
+    readonly completed: "completed";
+    readonly failed: "failed";
+    readonly cancelled: "cancelled";
+    readonly timed_out: "timed_out";
+};
+/**
+ * How the run started: `schedule` by the task's own trigger, including a task set to run now;
+ * `manual` by a person running it outside its schedule; `assistant` by the assistant; `event` by
+ * matching event messages.
+ */
+export type TaskRunResourceTrigger = (typeof TaskRunResourceTrigger)[keyof typeof TaskRunResourceTrigger];
+export declare const TaskRunResourceTrigger: {
+    readonly schedule: "schedule";
+    readonly manual: "manual";
+    readonly assistant: "assistant";
+    readonly event: "event";
+};
+/**
+ * The payload as published. Null when it was larger than 4 KiB; see dataBytes.
+ * @nullable
+ */
+export type TaskRunEventData = {
+    [key: string]: unknown;
+} | null;
+/**
+ * An event message that started a run.
+ */
+export interface TaskRunEvent {
+    id: string;
+    event: string;
+    version: number;
+    key: string;
+    createdAt: string;
+    /**
+     * The payload as published. Null when it was larger than 4 KiB; see dataBytes.
+     * @nullable
+     */
+    data: TaskRunEventData;
+    dataBytes: number;
+}
+export interface TaskRunResource {
+    id: string;
+    taskId: string;
+    status: TaskRunResourceStatus;
+    /** @nullable */
+    startedAt: string | null;
+    /** @nullable */
+    finishedAt: string | null;
+    /**
+     * For commands. Null until the command exits.
+     * @nullable
+     */
+    exitCode: number | null;
+    /**
+     * The last 16 KiB of a command's output. Empty for prompts; null in lists, read the run for it.
+     * @nullable
+     */
+    output: string | null;
+    /**
+     * Why the run failed. Null unless status is failed.
+     * @nullable
+     */
+    errorCode: string | null;
+    /**
+     * How the run started: `schedule` by the task's own trigger, including a task set to run now;
+     * `manual` by a person running it outside its schedule; `assistant` by the assistant; `event` by
+     * matching event messages.
+     */
+    trigger: TaskRunResourceTrigger;
+    /** For runs started by events, the number of matching messages the run covers. */
+    eventCount: number;
+    /**
+     * For runs started by events, up to 20 of the messages the run covers. Null in lists; read the run for it.
+     * @nullable
+     */
+    events: TaskRunEvent[] | null;
+}
+export interface TaskResource {
+    id: string;
+    /** The conversation the task reports to. */
+    threadId: string;
+    name: string;
+    /** `completed` is a one-time task whose run has ended. */
+    status: TaskResourceStatus;
+    trigger: TaskTrigger;
+    action: TaskAction;
+    /**
+     * When the trigger starts the next run. Null when it will not.
+     * @nullable
+     */
+    nextRunAt: string | null;
+    /**
+     * For `event`. The event version the condition was checked against. It advances when the event
+     * gains a newer version that the condition still fits; when it no longer fits, the task is
+     * paused and a failed run records TASK_EVENT_VERSION_INCOMPATIBLE.
+     * @nullable
+     */
+    eventVersion: number | null;
+    /** For `event`. The event-triggered runs started under the current trigger. */
+    eventRunCount: number;
+    lastRun: TaskRunResource | null;
+    createdAt: string;
+    updatedAt: string;
+}
+export interface CreateTaskRequestBody {
+    /**
+     * @minLength 1
+     * @maxLength 64
+     */
+    threadId: string;
+    /**
+     * @minLength 1
+     * @maxLength 128
+     */
+    name: string;
+    trigger: TaskTrigger;
+    action: TaskAction;
+}
+export interface UpdateTaskRequestBody {
+    /**
+     * @minLength 1
+     * @maxLength 128
+     */
+    name?: string;
+    trigger?: TaskTrigger;
+    action?: TaskAction;
+}
+export type SearchTasksRequestBodyStatus = (typeof SearchTasksRequestBodyStatus)[keyof typeof SearchTasksRequestBodyStatus];
+export declare const SearchTasksRequestBodyStatus: {
+    readonly active: "active";
+    readonly paused: "paused";
+    readonly completed: "completed";
+    readonly cancelled: "cancelled";
+};
+export type SearchTasksRequestBodyTriggerType = (typeof SearchTasksRequestBodyTriggerType)[keyof typeof SearchTasksRequestBodyTriggerType];
+export declare const SearchTasksRequestBodyTriggerType: {
+    readonly now: "now";
+    readonly at: "at";
+    readonly interval: "interval";
+    readonly cron: "cron";
+    readonly event: "event";
+};
+export type SearchTasksRequestBodyActionType = (typeof SearchTasksRequestBodyActionType)[keyof typeof SearchTasksRequestBodyActionType];
+export declare const SearchTasksRequestBodyActionType: {
+    readonly prompt: "prompt";
+    readonly command: "command";
+};
+export interface SearchTasksRequestBody {
+    /**
+     * Only the tasks that report to this conversation.
+     * @maxLength 64
+     */
+    threadId?: string;
+    status?: SearchTasksRequestBodyStatus;
+    triggerType?: SearchTasksRequestBodyTriggerType;
+    actionType?: SearchTasksRequestBodyActionType;
+    /** @maxLength 1024 */
+    cursor?: string;
+    /**
+     * @minimum 1
+     * @maximum 200
+     */
+    limit?: number;
+}
+export interface TaskListResponseBody {
+    tasks: TaskResource[];
+    /** @nullable */
+    nextCursor: string | null;
+}
+export interface TaskRunListResponseBody {
+    runs: TaskRunResource[];
+    /** @nullable */
+    nextCursor: string | null;
+}
+/**
+ * `user` when it is the caller's choice, `catalog` when it comes from the Canopy catalogue.
+ */
+export type DefaultModelResourceSource = (typeof DefaultModelResourceSource)[keyof typeof DefaultModelResourceSource];
+export declare const DefaultModelResourceSource: {
+    readonly user: "user";
+    readonly catalog: "catalog";
+};
+/**
+ * The model and effort a new conversation gets when it names none.
+ */
+export interface DefaultModelResource {
+    /**
+     * Null when the catalogue has no model that can run an agent.
+     * @nullable
+     */
+    modelId: string | null;
+    reasoningEffort: ReasoningEffort | null;
+    /** `user` when it is the caller's choice, `catalog` when it comes from the Canopy catalogue. */
+    source: DefaultModelResourceSource;
+}
+export interface SettingsResource {
+    /**
+     * The caller's choice. Null when none is set.
+     * @nullable
+     */
+    defaultModelId: string | null;
+    /** The caller's choice. Null when none is set. */
+    defaultReasoningEffort: ReasoningEffort | null;
+    defaultModel: DefaultModelResource;
+}
+export interface UpdateSettingsRequestBody {
+    /**
+     * @minLength 1
+     * @maxLength 128
+     * @nullable
+     */
+    defaultModelId?: string | null;
+    defaultReasoningEffort?: ReasoningEffort | null;
+}
+/**
+ * Counts over everything the criteria match, ignoring `ids` and the cursor.
+ */
+export interface AttachmentCountsResource {
+    total: number;
+    totalBytes: number;
+}
+/**
+ * How the assistant will see this file.
+ */
+export type AttachmentFileResourceType = (typeof AttachmentFileResourceType)[keyof typeof AttachmentFileResourceType];
+export declare const AttachmentFileResourceType: {
+    readonly image: "image";
+    readonly text: "text";
+    readonly binary: "binary";
+};
+export interface AttachmentFileResource {
+    byteSize: number;
+    createdAt: string;
+    /**
+     * When this draft is cleared if no message ever references it. Null once a message uses it —
+     * a file that belongs to a conversation is kept as long as the conversation is.
+     * @nullable
+     */
+    draftExpiresAt: string | null;
+    filename: string;
+    /**
+     * Null unless type is image.
+     * @nullable
+     */
+    height: number | null;
+    id: string;
+    /** Detected at intake, not the Content-Type the client sent. */
+    mime: string;
+    /** How the assistant will see this file. */
+    type: AttachmentFileResourceType;
+    updatedAt: string;
+    /**
+     * Null unless type is image.
+     * @nullable
+     */
+    width: number | null;
+}
+export interface AttachmentListResponseBody {
+    attachments: AttachmentFileResource[];
+    /**
+     * Null on the last page.
+     * @nullable
+     */
+    nextCursor: string | null;
+    /** Null unless `include` asked for it. */
+    counts: AttachmentCountsResource | null;
+}
+/**
+ * How the assistant sees the file.
+ */
+export type SearchAttachmentsRequestBodyType = (typeof SearchAttachmentsRequestBodyType)[keyof typeof SearchAttachmentsRequestBodyType];
+export declare const SearchAttachmentsRequestBodyType: {
+    readonly image: "image";
+    readonly text: "text";
+    readonly binary: "binary";
+};
+export type SearchAttachmentsRequestBodyIncludeItem = (typeof SearchAttachmentsRequestBodyIncludeItem)[keyof typeof SearchAttachmentsRequestBodyIncludeItem];
+export declare const SearchAttachmentsRequestBodyIncludeItem: {
+    readonly counts: "counts";
+};
+export interface SearchAttachmentsRequestBody {
+    /**
+     * Read these attachments. Cannot be combined with cursor.
+     * @minItems 1
+     * @maxItems 200
+     */
+    ids?: string[];
+    /**
+     * Matches filenames, case-insensitively.
+     * @maxLength 100
+     */
+    q?: string;
+    /** How the assistant sees the file. */
+    type?: SearchAttachmentsRequestBodyType;
+    /** True for uploads no message references, false for the rest. */
+    draft?: boolean;
+    /** @maxLength 1024 */
+    cursor?: string;
+    /**
+     * @minimum 1
+     * @maximum 200
+     */
+    limit?: number;
+    /** Optional parts of the response. `counts` adds `counts`. */
+    include?: SearchAttachmentsRequestBodyIncludeItem[];
+}
+export interface UpdateAttachmentRequestBody {
+    /**
+     * @minLength 1
+     * @maxLength 255
+     */
+    filename: string;
+}
+/**
+ * How the assistant will see this file.
+ *
+ * - `image` — read directly, and only by models that accept image input
+ * - `text` — placed inline in the message when small enough, otherwise read on demand
+ * - `binary` — never read directly; the assistant downloads it onto a cloud instance to work with it
+ */
+export type UploadedResourceType = (typeof UploadedResourceType)[keyof typeof UploadedResourceType];
+export declare const UploadedResourceType: {
+    readonly image: "image";
+    readonly text: "text";
+    readonly binary: "binary";
+};
+export interface UploadedResource {
+    /** Size of what was stored. For an image that has been resized, this is the resized size, not what was uploaded. */
+    byteSize: number;
+    /**
+     * When this upload gets cleared if no message ever references it. Sending a message with this id makes it permanent and this stops applying — a file that belongs to a conversation is kept as long as the conversation is.
+     *
+     * It is here so the editor can say so before it happens. An attachment chip that quietly stops working a week later reads as a bug, and the person who hits it has no way to tell that what they are seeing is a draft being collected.
+     */
+    draftExpiresAt: string;
+    filename: string;
+    /**
+     * Null unless type is image.
+     * @nullable
+     */
+    height: number | null;
+    id: string;
+    /**
+     * How the assistant will see this file.
+     *
+     * - `image` — read directly, and only by models that accept image input
+     * - `text` — placed inline in the message when small enough, otherwise read on demand
+     * - `binary` — never read directly; the assistant downloads it onto a cloud instance to work with it
+     */
+    type: UploadedResourceType;
+    /**
+     * Null unless type is image.
+     * @nullable
+     */
+    width: number | null;
+}
+export interface UploadConfigurationResource {
+    enabled: boolean;
+    policyId: string;
+    maxFileBytes: number;
+    maxImageBytes: number;
+    partSizeBytes: number;
+    expirySeconds: number;
+}
+export interface UploadPartResource {
+    number: number;
+    byteSize: number;
+    etag: string;
+}
+export interface UploadResource {
+    id: string;
+    filename: string;
+    byteSize: number;
+    partSizeBytes: number;
+    policyId: string;
+    expiresAt: string;
+    status: string;
+    /** @nullable */
+    attachmentId: string | null;
+    parts: UploadPartResource[];
+}
+export interface UploadListResponseBody {
+    uploads: UploadResource[];
+}
+export interface CreateUploadRequestBody {
+    /**
+     * @minLength 1
+     * @maxLength 64
+     */
+    requestId: string;
+    /**
+     * @minLength 1
+     * @maxLength 255
+     */
+    filename: string;
+    byteSize: number;
+    policyId: string;
+    maxFileBytes: number;
+    partSizeBytes: number;
+}
+export interface UpdateUploadRequestBody {
+    /**
+     * @minLength 1
+     * @maxLength 255
+     */
+    filename: string;
+}
+export interface CompleteUploadRequestBody {
+    policyId: string;
+}
+export interface MemoryResource {
+    /** The fact itself */
+    body: string;
+    createdAt: string;
+    id: string;
+    /** The name the assistant gave this fact; it overwrites or deletes its own entries by that name */
+    name: string;
+    /** Which conversation the assistant learned it in. That conversation may since have been deleted */
+    sourceThreadId?: string;
+    updatedAt: string;
+}
+export interface MemoryListResponseBody {
+    items: MemoryResource[];
+}
+/**
+ * Path to contents, `SKILL.md` among them. Only returned by `get-skill`; the list leaves it out.
+ * @nullable
+ */
+export type SkillResourceFiles = {
+    [key: string]: string;
+} | null;
+/**
+ * `builtin` — provided by the platform and read-only here.
+ * `project` — written for this project and editable by anyone in it.
+ */
+export type SkillResourceOrigin = (typeof SkillResourceOrigin)[keyof typeof SkillResourceOrigin];
+export declare const SkillResourceOrigin: {
+    readonly builtin: "builtin";
+    readonly project: "project";
+};
+export interface SkillResource {
+    /**
+     * True when the assistant wrote this skill during a conversation rather than a person
+     * writing it here.
+     *
+     * Which conversation is deliberately not returned: skills are shared across the project
+     * while conversations belong to one person, so naming one would tell everybody in the
+     * project that a particular colleague had it.
+     */
+    authoredByAssistant: boolean;
+    /** Why the assistant would open this skill. It sits in every request, so it is the one field worth writing carefully. */
+    description: string;
+    enabled: boolean;
+    /**
+     * Path to contents, `SKILL.md` among them. Only returned by `get-skill`; the list leaves it out.
+     * @nullable
+     */
+    files?: SkillResourceFiles;
+    name: string;
+    /**
+     * `builtin` — provided by the platform and read-only here.
+     * `project` — written for this project and editable by anyone in it.
+     */
+    origin: SkillResourceOrigin;
+    /** @nullable */
+    shortDescription: string | null;
+    /**
+     * Null for built-in skills, which have no edit history here.
+     * @nullable
+     */
+    updatedAt: string | null;
+}
+export interface SkillListResponseBody {
+    skills: SkillResource[];
+}
+/**
+ * Path to contents. `SKILL.md` is required; anything else it references goes alongside it.
+ *
+ * Paths are relative to the skill and cannot leave it. At most 32 files, 256 KiB each and
+ * 1 MiB in total.
+ */
+export type SkillRequestBodyFiles = {
+    [key: string]: string;
+};
+export interface SkillRequestBody {
+    /**
+     * Why the assistant would open this skill. It sits in every request; write it as the answer to "when do I need this", not "what does it contain".
+     * @minLength 1
+     * @maxLength 1024
+     */
+    description: string;
+    enabled?: boolean;
+    /**
+     * Path to contents. `SKILL.md` is required; anything else it references goes alongside it.
+     *
+     * Paths are relative to the skill and cannot leave it. At most 32 files, 256 KiB each and
+     * 1 MiB in total.
+     */
+    files: SkillRequestBodyFiles;
+    /**
+     * Also how the assistant refers to it, so renaming is deleting and writing again.
+     * @minLength 1
+     * @maxLength 64
+     */
+    name: string;
+    /** @maxLength 1024 */
+    shortDescription?: string;
+}
+export interface SkillEnabledRequestBody {
+    enabled: boolean;
+}
+export type BindingResourceConnectionStatus = (typeof BindingResourceConnectionStatus)[keyof typeof BindingResourceConnectionStatus];
+export declare const BindingResourceConnectionStatus: {
+    readonly logged_out: "logged_out";
+    readonly qr_pending: "qr_pending";
+    readonly online: "online";
+    readonly expired: "expired";
+};
+export type BindingResourceStatus = (typeof BindingResourceStatus)[keyof typeof BindingResourceStatus];
+export declare const BindingResourceStatus: {
+    readonly pending: "pending";
+    readonly active: "active";
+    readonly revoked: "revoked";
+};
+export interface BindingResource {
+    channelId: string;
+    connectionStatus: BindingResourceConnectionStatus;
+    createdAt: string;
+    id: string;
+    peerName: string;
+    platform: string;
+    status: BindingResourceStatus;
+    /** @nullable */
+    verifiedAt: string | null;
+}
+export interface LengthAwarePageBindingResource {
+    /** The entries on this page */
+    items: BindingResource[];
+    /** The page size, echoing what was requested */
+    limit: number;
+    /** How many were skipped, echoing what was requested */
+    offset: number;
+    /** How many match in total, not just on this page */
+    total: number;
+}
+/**
+ * How far this channel is from working. Only `online` receives messages and can issue binding codes
+ */
+export type ChannelResourceConnectionStatus = (typeof ChannelResourceConnectionStatus)[keyof typeof ChannelResourceConnectionStatus];
+export declare const ChannelResourceConnectionStatus: {
+    readonly logged_out: "logged_out";
+    readonly qr_pending: "qr_pending";
+    readonly online: "online";
+    readonly expired: "expired";
+};
+/**
+ * The state of the long-lived connection right now. Always `stopped` for webhook platforms
+ */
+export type ChannelResourceRuntimeStatus = (typeof ChannelResourceRuntimeStatus)[keyof typeof ChannelResourceRuntimeStatus];
+export declare const ChannelResourceRuntimeStatus: {
+    readonly stopped: "stopped";
+    readonly running: "running";
+};
+export type ChannelResourceSenderPolicy = (typeof ChannelResourceSenderPolicy)[keyof typeof ChannelResourceSenderPolicy];
+export declare const ChannelResourceSenderPolicy: {
+    readonly bound_only: "bound_only";
+    readonly open: "open";
+};
+export type ChannelResourceStatus = (typeof ChannelResourceStatus)[keyof typeof ChannelResourceStatus];
+export declare const ChannelResourceStatus: {
+    readonly active: "active";
+    readonly suspended: "suspended";
+    readonly disabled: "disabled";
+};
+export interface ChannelResource {
+    /** @nullable */
+    allowFrom: string[] | null;
+    /** How far this channel is from working. Only `online` receives messages and can issue binding codes */
+    connectionStatus: ChannelResourceConnectionStatus;
+    createdAt: string;
+    id: string;
+    name: string;
+    platform: string;
+    /** The state of the long-lived connection right now. Always `stopped` for webhook platforms */
+    runtimeStatus: ChannelResourceRuntimeStatus;
+    senderPolicy: ChannelResourceSenderPolicy;
+    status: ChannelResourceStatus;
+    updatedAt: string;
+    /** The webhook path, for gateway configuration and for diagnosis */
+    webhookPath: string;
+    /**
+     * The webhook address to paste into that platform's console. Null when the deployment declares no public entry point
+     * @nullable
+     */
+    webhookUrl: string | null;
+}
+export interface LengthAwarePageChannelResource {
+    /** The entries on this page */
+    items: ChannelResource[];
+    /** The page size, echoing what was requested */
+    limit: number;
+    /** How many were skipped, echoing what was requested */
+    offset: number;
+    /** How many match in total, not just on this page */
+    total: number;
+}
+/**
+ * Credentials for that platform. Write-only: they cannot be read back after creation
+ */
+export type CreateChannelRequestBodyCredentials = {
+    [key: string]: string;
+};
+export type CreateChannelRequestBodySenderPolicy = (typeof CreateChannelRequestBodySenderPolicy)[keyof typeof CreateChannelRequestBodySenderPolicy];
+export declare const CreateChannelRequestBodySenderPolicy: {
+    readonly bound_only: "bound_only";
+    readonly open: "open";
+};
+export interface CreateChannelRequestBody {
+    /** @nullable */
+    allowFrom?: string[] | null;
+    /** Credentials for that platform. Write-only: they cannot be read back after creation */
+    credentials?: CreateChannelRequestBodyCredentials;
+    /**
+     * @minLength 1
+     * @maxLength 128
+     */
+    name: string;
+    /** @minLength 1 */
+    platform: string;
+    senderPolicy?: CreateChannelRequestBodySenderPolicy;
+    /** Required for platforms that generate the secret themselves (secretSource=supplied). Must be absent for `generated` ones, where the secret we make is returned once in webhookSecret on this response */
+    webhookSecret?: string;
+}
+/**
+ * How far this channel is from working. Only `online` receives messages and can issue binding codes
+ */
+export type ChannelWithSecretResponseBodyConnectionStatus = (typeof ChannelWithSecretResponseBodyConnectionStatus)[keyof typeof ChannelWithSecretResponseBodyConnectionStatus];
+export declare const ChannelWithSecretResponseBodyConnectionStatus: {
+    readonly logged_out: "logged_out";
+    readonly qr_pending: "qr_pending";
+    readonly online: "online";
+    readonly expired: "expired";
+};
+/**
+ * The state of the long-lived connection right now. Always `stopped` for webhook platforms
+ */
+export type ChannelWithSecretResponseBodyRuntimeStatus = (typeof ChannelWithSecretResponseBodyRuntimeStatus)[keyof typeof ChannelWithSecretResponseBodyRuntimeStatus];
+export declare const ChannelWithSecretResponseBodyRuntimeStatus: {
+    readonly stopped: "stopped";
+    readonly running: "running";
+};
+export type ChannelWithSecretResponseBodySenderPolicy = (typeof ChannelWithSecretResponseBodySenderPolicy)[keyof typeof ChannelWithSecretResponseBodySenderPolicy];
+export declare const ChannelWithSecretResponseBodySenderPolicy: {
+    readonly bound_only: "bound_only";
+    readonly open: "open";
+};
+export type ChannelWithSecretResponseBodyStatus = (typeof ChannelWithSecretResponseBodyStatus)[keyof typeof ChannelWithSecretResponseBodyStatus];
+export declare const ChannelWithSecretResponseBodyStatus: {
+    readonly active: "active";
+    readonly suspended: "suspended";
+    readonly disabled: "disabled";
+};
+export interface ChannelWithSecretResponseBody {
+    /** @nullable */
+    allowFrom: string[] | null;
+    /** How far this channel is from working. Only `online` receives messages and can issue binding codes */
+    connectionStatus: ChannelWithSecretResponseBodyConnectionStatus;
+    createdAt: string;
+    id: string;
+    name: string;
+    platform: string;
+    /** The state of the long-lived connection right now. Always `stopped` for webhook platforms */
+    runtimeStatus: ChannelWithSecretResponseBodyRuntimeStatus;
+    senderPolicy: ChannelWithSecretResponseBodySenderPolicy;
+    status: ChannelWithSecretResponseBodyStatus;
+    updatedAt: string;
+    /** The webhook path, for gateway configuration and for diagnosis */
+    webhookPath: string;
+    /**
+     * The webhook secret we generated, to paste into that platform's console. **It cannot be retrieved again** — the only way forward is rotating to a new one. Null when the platform generates the secret (secretSource=supplied) or does not use webhooks at all
+     * @nullable
+     */
+    webhookSecret: string | null;
+    /**
+     * The webhook address to paste into that platform's console. Null when the deployment declares no public entry point
+     * @nullable
+     */
+    webhookUrl: string | null;
+}
+/**
+ * Replaced wholesale rather than merged key by key. Absent means unchanged
+ */
+export type UpdateChannelRequestBodyCredentials = {
+    [key: string]: string;
+};
+/**
+ * Only when this is sent is allowFrom replaced along with it
+ */
+export type UpdateChannelRequestBodySenderPolicy = (typeof UpdateChannelRequestBodySenderPolicy)[keyof typeof UpdateChannelRequestBodySenderPolicy];
+export declare const UpdateChannelRequestBodySenderPolicy: {
+    readonly bound_only: "bound_only";
+    readonly open: "open";
+};
+export interface UpdateChannelRequestBody {
+    /**
+     * The allow list. Only applied when senderPolicy is sent as well
+     * @nullable
+     */
+    allowFrom?: string[] | null;
+    /** Replaced wholesale rather than merged key by key. Absent means unchanged */
+    credentials?: UpdateChannelRequestBodyCredentials;
+    enabled?: boolean;
+    /** @maxLength 128 */
+    name?: string;
+    /** Only when this is sent is allowFrom replaced along with it */
+    senderPolicy?: UpdateChannelRequestBodySenderPolicy;
+}
+export interface BindingCodeResponseBody {
+    code: string;
+    expiresAt: string;
+}
+export interface RejectionResource {
+    at: string;
+    peerId: string;
+    peerName: string;
+    peerUsername: string;
+    platform: string;
+    textLength: number;
+    verdict: string;
+}
+export interface RejectionListResponseBody {
+    /** @nullable */
+    rejections: RejectionResource[] | null;
+}
+export interface RotateSecretRequestBody {
+    /** Required for platforms that generate the secret themselves (secretSource=supplied). Must be absent for `generated` ones */
+    webhookSecret?: string;
+}
+export interface WebhookSecretResponseBody {
+    webhookSecret: string;
+}
+export type SenderCheckResourceVerdict = (typeof SenderCheckResourceVerdict)[keyof typeof SenderCheckResourceVerdict];
+export declare const SenderCheckResourceVerdict: {
+    readonly ALLOWED_BY_BINDING: "ALLOWED_BY_BINDING";
+    readonly ALLOWED_BY_ALLOW_FROM: "ALLOWED_BY_ALLOW_FROM";
+    readonly ALLOWED_BY_POLICY: "ALLOWED_BY_POLICY";
+    readonly REJECTED_NOT_ALLOWED: "REJECTED_NOT_ALLOWED";
+};
+export interface SenderCheckResource {
+    /** @nullable */
+    allowFrom: string[] | null;
+    allowed: boolean;
+    /** @nullable */
+    bindingId: string | null;
+    senderPolicy: string;
+    verdict: SenderCheckResourceVerdict;
+}
+export type LoginResourceStatus = (typeof LoginResourceStatus)[keyof typeof LoginResourceStatus];
+export declare const LoginResourceStatus: {
+    readonly wait: "wait";
+    readonly scanned: "scanned";
+    readonly confirmed: "confirmed";
+    readonly expired: "expired";
+    readonly error: "error";
+    readonly need_verify_code: "need_verify_code";
+};
+export interface LoginResource {
+    /** When this login flow expires. Past that, stop polling and start a new one */
+    expiresAt: string;
+    id: string;
+    /** The text to encode and render as a QR code by the client — not an image address and not a data URI. When a code expires this flow issues another and keeps waiting, so each poll may return a new string */
+    qrcodeData: string;
+    /** Why it failed. Present only when status is error or expired */
+    reason: string;
+    status: LoginResourceStatus;
+}
+export interface CredentialFieldResource {
+    help: string;
+    key: string;
+    label: string;
+    required: boolean;
+    secret: boolean;
+}
+export type PlatformResourceSecretSource = (typeof PlatformResourceSecretSource)[keyof typeof PlatformResourceSecretSource];
+export declare const PlatformResourceSecretSource: {
+    readonly generated: "generated";
+    readonly supplied: "supplied";
+    readonly none: "none";
+};
+export type PlatformResourceSetupChallenge = (typeof PlatformResourceSetupChallenge)[keyof typeof PlatformResourceSetupChallenge];
+export declare const PlatformResourceSetupChallenge: {
+    readonly none: "none";
+    readonly webhook: "webhook";
+    readonly scan: "scan";
+};
+export type PlatformResourceSetupMethod = (typeof PlatformResourceSetupMethod)[keyof typeof PlatformResourceSetupMethod];
+export declare const PlatformResourceSetupMethod: {
+    readonly credentials: "credentials";
+    readonly scan: "scan";
+};
+export interface PlatformResource {
+    /** @nullable */
+    credentialFields: CredentialFieldResource[] | null;
+    name: string;
+    resident: boolean;
+    secretSource: PlatformResourceSecretSource;
+    setupChallenge: PlatformResourceSetupChallenge;
+    setupMethod: PlatformResourceSetupMethod;
+    /** The webhook path template; {channel} is replaced with the channel id */
+    webhookPath: string;
+    /**
+     * The full webhook address template. Null when the deployment declares no public entry point
+     * @nullable
+     */
+    webhookUrlTemplate: string | null;
+}
+export interface PlatformListResponseBody {
+    /** @nullable */
+    platforms: PlatformResource[] | null;
+}
+export interface VerifyCodeRequestBody {
+    /** @minLength 1 */
+    code: string;
+}
+/**
+ * Error
+ */
+export type ErrorResponse = Error;
+export type ListThreadItemsParams = {
+    /**
+     * Return the window ending just above this ordinal.
+     * @minimum 0
+     */
+    before?: number;
+    /**
+     * Return the window starting just below this ordinal.
+     * @minimum 0
+     */
+    after?: number;
+    /**
+     * Return a window containing this ordinal. Only one of before, after and around may be given.
+     * @minimum 0
+     */
+    around?: number;
+    /**
+     * How many turns a window holds at most.
+     * @minimum 1
+     * @maximum 50
+     */
+    turns?: number;
+};
+export type ListThreadMessagesParams = {
+    /**
+     * Items to skip. Defaults to 0; at most 10000.
+     * @minimum 0
+     * @maximum 10000
+     */
+    offset?: number;
+    /**
+     * Items returned in this page. Defaults to 50; at most 200.
+     * @minimum 1
+     * @maximum 200
+     */
+    limit?: number;
+};
+export type ListThreadTurnsParams = {
+    /**
+     * @minItems 1
+     * @maxItems 200
+     */
+    ids?: string[];
+    /**
+     * The next_cursor returned by the previous page. Omit it for the first page.
+     * @minLength 1
+     * @maxLength 1024
+     */
+    cursor?: string;
+    /**
+     * Items returned in this page. Defaults to 50; at most 200.
+     * @minimum 1
+     * @maximum 200
+     */
+    limit?: number;
+};
+export type ListTaskRunsParams = {
+    /**
+     * The next_cursor returned by the previous page. Omit it for the first page.
+     * @minLength 1
+     * @maxLength 1024
+     */
+    cursor?: string;
+    /**
+     * Items returned in this page. Defaults to 50; at most 200.
+     * @minimum 1
+     * @maximum 200
+     */
+    limit?: number;
+};
+export type UploadAttachmentParams = {
+    /**
+     * The name to show and to give the assistant. Images do not need one; anything else does, because the name is most of what says what the file is. Falls back to a generated name.
+     * @maxLength 255
+     */
+    filename?: string;
+};
+export type PutUploadPartParams = {
+    policyId: string;
+};
+export type PutUploadPartHeaders = {
+    /**
+     * @minimum 1
+     */
+    "X-Part-Size": number;
+};
+export type ListBindingsParams = {
+    /**
+     * Items returned in this page. Defaults to 50; at most 200.
+     * @minimum 1
+     * @maximum 200
+     */
+    limit?: number;
+    /**
+     * Items to skip. Defaults to 0; at most 10000.
+     * @minimum 0
+     * @maximum 10000
+     */
+    offset?: number;
+    platform?: string;
+    channelId?: string;
+    /**
+     * Return only bindings that are active
+     */
+    active?: boolean;
+};
+export type ListChannelsParams = {
+    /**
+     * Items returned in this page. Defaults to 50; at most 200.
+     * @minimum 1
+     * @maximum 200
+     */
+    limit?: number;
+    /**
+     * Items to skip. Defaults to 0; at most 10000.
+     * @minimum 0
+     * @maximum 10000
+     */
+    offset?: number;
+    platform?: string;
+    /**
+     * Return only channels that are enabled
+     */
+    active?: boolean;
+};
+export type ListChannelRejectionsParams = {
+    /**
+     * @minimum 0
+     * @maximum 100
+     */
+    limit?: number;
+};
+export type CheckSenderParams = {
+    /**
+     * That person's id on the platform, the same value bindings and rejections carry
+     */
+    peerId: string;
+    /**
+     * Only platforms with usernames, such as Telegram, can supply this. Without the @. Empty means there is no username
+     */
+    username?: string;
+};