@bitbitpress/client 1.1.4 → 1.2.3

package/dist/generated/openapi.d.ts

@@ -173,6 +173,21 @@ export interface paths {
                         };
                     };
                 };
+                /** @description Forbidden errors */
+                403: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            /**
+                             * @example Forbidden: Subscription required
+                             * @enum {string}
+                             */
+                            error: "Forbidden: Subscription required";
+                        };
+                    };
+                };
                 /** @description Internal server error */
                 500: {
                     headers: {
@@ -275,6 +290,21 @@ export interface paths {
                         };
                     };
                 };
+                /** @description Forbidden errors */
+                403: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            /**
+                             * @example Forbidden: Subscription required
+                             * @enum {string}
+                             */
+                            error: "Forbidden: Subscription required";
+                        };
+                    };
+                };
                 /** @description Internal server error */
                 500: {
                     headers: {
@@ -368,6 +398,21 @@ export interface paths {
                         };
                     };
                 };
+                /** @description Forbidden errors */
+                403: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            /**
+                             * @example Forbidden: Subscription required
+                             * @enum {string}
+                             */
+                            error: "Forbidden: Subscription required";
+                        };
+                    };
+                };
                 /** @description Internal server error */
                 500: {
                     headers: {
@@ -494,6 +539,21 @@ export interface paths {
                         };
                     };
                 };
+                /** @description Forbidden errors */
+                403: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            /**
+                             * @example Forbidden: Subscription required
+                             * @enum {string}
+                             */
+                            error: "Forbidden: Subscription required";
+                        };
+                    };
+                };
                 /** @description Internal server error */
                 500: {
                     headers: {
@@ -590,6 +650,21 @@ export interface paths {
                         };
                     };
                 };
+                /** @description Forbidden errors */
+                403: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            /**
+                             * @example Forbidden: Subscription required
+                             * @enum {string}
+                             */
+                            error: "Forbidden: Subscription required";
+                        };
+                    };
+                };
                 /** @description Internal server error */
                 500: {
                     headers: {
@@ -709,6 +784,21 @@ export interface paths {
                         };
                     };
                 };
+                /** @description Forbidden errors */
+                403: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            /**
+                             * @example Forbidden: Subscription required
+                             * @enum {string}
+                             */
+                            error: "Forbidden: Subscription required";
+                        };
+                    };
+                };
                 /** @description Internal server error */
                 500: {
                     headers: {
@@ -825,6 +915,21 @@ export interface paths {
                         };
                     };
                 };
+                /** @description Forbidden errors */
+                403: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            /**
+                             * @example Forbidden: Subscription required
+                             * @enum {string}
+                             */
+                            error: "Forbidden: Subscription required";
+                        };
+                    };
+                };
                 /** @description Internal server error */
                 500: {
                     headers: {
@@ -997,19 +1102,23 @@ export interface paths {
                             configurationKeyName?: string;
                             /** @description How many recent stored synthesis outputs to expose in the streamed `synthesisHistory` / `synthesisHistoryEntries` fields. Defaults to 0 (no history emitted). When > 0, the final data event includes a `synthesisHistoryEntries` array of up to N `{ synthesisOutputId, data }` (most-recent first; each row's payload paired with its output id, so submissions can attach to a specific historical output), and — DEPRECATED, for older app builds — an index-aligned `synthesisHistory` array of the same bare `data` payloads. The first entry is the current synthesis itself — the same payload `data` is derived from — and the remaining entries are older stored rows. */
                             synthesisHistoryLimit?: number;
-                            /** @description Per-request overrides for search options. */
+                            /** @description Per-request overrides for the entry agent's search options (merged over the config). Deliberately limited to per-request scoping — a recency window and tag filters. Search SHAPE (which data sources, search type, mime/asset types, result/bit counts) is a config-design decision and is NOT overridable per request. */
                             searchOptionsOverrides?: {
                                 /** @description Override for search lookback window in minutes (e.g. 1440 for last 24 hours). */
                                 lookbackMinutes?: number;
+                                /** @description Only include assets carrying at least one of these tags. */
+                                includeTags?: string[];
+                                /** @description Exclude assets carrying any of these tags. */
+                                excludeTags?: string[];
                             };
-                            /** @description Inputs used as context for the synthesis: externalId (article ID), or text (freeform text). */
+                            /** @description Inputs used as context for the synthesis. Each agent only receives the input types listed in its own config. Types: text (freeform), externalId (an asset by external id, injected as context), assetIds (comma-separated INTERNAL asset ids, injected as context), synthesisOutputIds (comma-separated SynthesisOutput ids whose data is injected as context), excludeExternalIds / excludeAssetIds (comma-separated ids excluded from search). */
                             inputs?: {
                                 /**
-                                 * @description Type of input: externalId (article) or text (freeform).
+                                 * @description Input type. externalId = one asset by external id; assetIds = internal asset ids (comma-separated); synthesisOutputIds = prior output ids (comma-separated); text = freeform; excludeExternalIds / excludeAssetIds = ids to exclude from search (comma-separated).
                                  * @enum {string}
                                  */
-                                type: "externalId" | "text" | "excludeExternalIds";
-                                /** @description External ID (e.g. article) for externalId, freeform text for text, or comma-separated list of external IDs to exclude */
+                                type: "externalId" | "text" | "assetIds" | "synthesisOutputIds" | "excludeExternalIds" | "excludeAssetIds";
+                                /** @description The input value: an external id / freeform text, or a comma-separated list of ids for assetIds / synthesisOutputIds / excludeExternalIds / excludeAssetIds. */
                                 value: string;
                             }[];
                             /** @description Optional output definition. Omit to use the output schema declared on the config named by `configurationKeyName` (`output.outputSchema`). */
@@ -1087,6 +1196,21 @@ export interface paths {
                         };
                     };
                 };
+                /** @description Forbidden errors */
+                403: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            /**
+                             * @example Forbidden: Subscription required
+                             * @enum {string}
+                             */
+                            error: "Forbidden: Subscription required";
+                        };
+                    };
+                };
                 /** @description Internal server error */
                 500: {
                     headers: {
@@ -1150,19 +1274,23 @@ export interface paths {
                             keyName: string;
                             /** @description How many recent stored synthesis outputs to expose in the streamed `synthesisHistory` / `synthesisHistoryEntries` fields. Defaults to 0. See `/v1/user/synthesize` for the full semantics. */
                             synthesisHistoryLimit?: number;
-                            /** @description Per-request overrides for search options. */
+                            /** @description Per-request overrides for the entry agent's search options (merged over the config). Deliberately limited to per-request scoping — a recency window and tag filters. Search SHAPE (which data sources, search type, mime/asset types, result/bit counts) is a config-design decision and is NOT overridable per request. */
                             searchOptionsOverrides?: {
                                 /** @description Override for search lookback window in minutes (e.g. 1440 for last 24 hours). */
                                 lookbackMinutes?: number;
+                                /** @description Only include assets carrying at least one of these tags. */
+                                includeTags?: string[];
+                                /** @description Exclude assets carrying any of these tags. */
+                                excludeTags?: string[];
                             };
-                            /** @description Inputs used as context for the synthesis: externalId (article ID), or text (freeform text). */
+                            /** @description Inputs used as context for the synthesis. Each agent only receives the input types listed in its own config. Types: text (freeform), externalId (an asset by external id), assetIds (comma-separated INTERNAL asset ids), synthesisOutputIds (comma-separated SynthesisOutput ids whose data is injected as context), excludeExternalIds / excludeAssetIds (comma-separated ids excluded from search). */
                             inputs?: {
                                 /**
-                                 * @description Type of input: externalId (article) or text (freeform).
+                                 * @description Input type. externalId = one asset by external id; assetIds = internal asset ids (comma-separated); synthesisOutputIds = prior output ids (comma-separated); text = freeform; excludeExternalIds / excludeAssetIds = ids to exclude from search (comma-separated).
                                  * @enum {string}
                                  */
-                                type: "externalId" | "text" | "excludeExternalIds";
-                                /** @description External ID (e.g. article) for externalId, freeform text for text, or comma-separated list of external IDs to exclude */
+                                type: "externalId" | "text" | "assetIds" | "synthesisOutputIds" | "excludeExternalIds" | "excludeAssetIds";
+                                /** @description The input value: an external id / freeform text, or a comma-separated list of ids for assetIds / synthesisOutputIds / excludeExternalIds / excludeAssetIds. */
                                 value: string;
                             }[];
                             /** @description Optional output definition. Omit to use the output schema declared on the UI's attached config (`output.outputSchema`). */
@@ -1239,6 +1367,21 @@ export interface paths {
                         };
                     };
                 };
+                /** @description Forbidden errors */
+                403: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            /**
+                             * @example Forbidden: Subscription required
+                             * @enum {string}
+                             */
+                            error: "Forbidden: Subscription required";
+                        };
+                    };
+                };
                 /** @description Internal server error */
                 500: {
                     headers: {
@@ -1393,7 +1536,7 @@ export interface paths {
          * User - Synthesize Piece Audio
          * @description **POST** `/v1/user/synthesis-piece/tts`
          *
-         *     Mint a short-lived, self-authenticating HLS URL for a published piece's spoken content. A media player calls this when the listener presses play, then plays the returned `url` (via the SDK's `ctx.playMedia`) to stream the synthesized speech on demand. The request REFERENCES the piece's content — omit `field` for the whole piece's spoken content, pass a top-level `field` to scope to it, and/or `index` for a single turn — and the server resolves the turns from the piece itself (so the URL never carries the text). The URL is gated at issue time (a few-minute expiry, and only PUBLISHED pieces), so a fresh URL can't be minted after a piece is unpublished. Note: the URL is an HLS playlist whose audio segments are content-addressed and cached long-lived — a player that already loaded a URL may keep playing that audio from cache after the URL expires or the piece is unpublished.
+         *     Mint a short-lived, self-authenticating HLS URL for a published piece's spoken content. A media player calls this when the listener presses play, then plays the returned `url` (via the SDK's `ctx.playMedia`) to stream the synthesized speech on demand. The request REFERENCES the piece's content — omit `field` for the whole piece's spoken content, pass a top-level `field` to scope to it, and/or `index` for a single turn — and the server resolves the turns from the piece itself (so the URL never carries the text). The URL is gated at issue time (it expires ~30 minutes after minting, and only PUBLISHED pieces), so a fresh URL can't be minted after a piece is unpublished. Note: the URL is an HLS playlist whose audio segments are content-addressed and cached long-lived — a player that already loaded a URL may keep playing that audio from cache after the URL expires or the piece is unpublished.
          */
         post: {
             parameters: {
@@ -1485,6 +1628,111 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/v1/user/synthesis/tts": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * User - Synthesize Synthesis Output Audio
+         * @description **POST** `/v1/user/synthesis/tts`
+         *
+         *     Mint a short-lived, self-authenticating HLS URL for the authenticated app user's own stored synthesis output — the on-request audio entry point a rendered SynthesisUI's `ctx.tts` calls when the listener presses play. The request REFERENCES the output's spoken content by `synthesisOutputId` (the id returned with the synthesis result) — omit `field` for the whole output's spoken content, pass a top-level `field` to scope to it, and/or `index` for a single turn — and the server reloads the turns from the stored output row (so the URL never carries the text). The URL is gated at mint by OWNERSHIP (only the app user who owns the output can mint it) and expires ~30 minutes after minting. Note: the URL is an HLS playlist whose audio segments are content-addressed and cached long-lived — a player that already loaded a URL may keep playing that audio from cache after the URL expires.
+         */
+        post: {
+            parameters: {
+                query?: never;
+                header: {
+                    /** @description Bearer token for authentication */
+                    authorization: string;
+                };
+                path?: never;
+                cookie?: never;
+            };
+            requestBody: {
+                content: {
+                    "application/json": {
+                        /** @description The id of the synthesis output to voice (returned with the synthesis result). */
+                        synthesisOutputId: string;
+                        /** @description Top-level field to voice. Omit for the whole output's spoken content. */
+                        field?: string;
+                        /** @description A single turn index within the resolved content. Omit for all turns. */
+                        index?: number;
+                    };
+                };
+            };
+            responses: {
+                /** @description Successful response */
+                200: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            /** @example true */
+                            success: boolean;
+                            data: {
+                                /** @description A short-lived streaming URL to point an `<audio>` element at. */
+                                url?: string;
+                                /** @description Set instead of `url` when audio can't be produced (output not found/not owned, or the text isn't part of the output). */
+                                error?: string;
+                            };
+                        };
+                    };
+                };
+                /** @description Bad request - missing or invalid parameters */
+                400: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            /** @example Bad request */
+                            error?: string;
+                        };
+                    };
+                };
+                /** @description Unauthorized errors */
+                401: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            /**
+                             * @example Unauthorized: No authentication token provided
+                             * @enum {string}
+                             */
+                            error?: "Unauthorized: No authentication token provided" | "Unauthorized: Token has expired" | "Unauthorized: Invalid token" | "Unauthorized: Authentication failed";
+                        };
+                    };
+                };
+                /** @description Internal server error */
+                500: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            /** @example false */
+                            success?: boolean;
+                            /** @example Internal server error: An unknown error occurred */
+                            error?: string;
+                        };
+                    };
+                };
+            };
+        };
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/v1/user/interactions": {
         parameters: {
             query?: never;
@@ -1577,6 +1825,21 @@ export interface paths {
                         };
                     };
                 };
+                /** @description Forbidden errors */
+                403: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            /**
+                             * @example Forbidden: Subscription required
+                             * @enum {string}
+                             */
+                            error: "Forbidden: Subscription required";
+                        };
+                    };
+                };
                 /** @description Internal server error */
                 500: {
                     headers: {
@@ -1690,6 +1953,21 @@ export interface paths {
                         };
                     };
                 };
+                /** @description Forbidden errors */
+                403: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            /**
+                             * @example Forbidden: Subscription required
+                             * @enum {string}
+                             */
+                            error: "Forbidden: Subscription required";
+                        };
+                    };
+                };
                 /** @description Default Response */
                 404: {
                     headers: {
@@ -1796,6 +2074,21 @@ export interface paths {
                         };
                     };
                 };
+                /** @description Forbidden errors */
+                403: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            /**
+                             * @example Forbidden: Subscription required
+                             * @enum {string}
+                             */
+                            error: "Forbidden: Subscription required";
+                        };
+                    };
+                };
                 /** @description Internal server error */
                 500: {
                     headers: {
@@ -1902,6 +2195,21 @@ export interface paths {
                         };
                     };
                 };
+                /** @description Forbidden errors */
+                403: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            /**
+                             * @example Forbidden: Subscription required
+                             * @enum {string}
+                             */
+                            error: "Forbidden: Subscription required";
+                        };
+                    };
+                };
                 /** @description Not found */
                 404: {
                     headers: {
@@ -2026,248 +2334,18 @@ export interface paths {
                         };
                     };
                 };
-                /** @description Internal server error */
-                500: {
-                    headers: {
-                        [name: string]: unknown;
-                    };
-                    content: {
-                        "application/json": {
-                            /** @example false */
-                            success?: boolean;
-                            /** @example Internal server error: An unknown error occurred */
-                            error?: string;
-                        };
-                    };
-                };
-            };
-        };
-        delete?: never;
-        options?: never;
-        head?: never;
-        patch?: never;
-        trace?: never;
-    };
-    "/v1/user-submissions": {
-        parameters: {
-            query?: never;
-            header?: never;
-            path?: never;
-            cookie?: never;
-        };
-        get?: never;
-        put?: never;
-        /**
-         * User Submissions - Create Submission
-         * @description **POST** `/v1/user-submissions` Creates a structured user submission and optional presigned file upload URLs.
-         */
-        post: {
-            parameters: {
-                query?: never;
-                header: {
-                    authorization: string;
-                };
-                path?: never;
-                cookie?: never;
-            };
-            requestBody: {
-                content: {
-                    "application/json": {
-                        synthesisOutputId: string;
-                        synthesisOutputContentKey?: string;
-                        data: {
-                            [key: string]: unknown;
-                        };
-                        files?: {
-                            field: string;
-                            contentType: string;
-                            fileName?: string;
-                        }[];
-                    };
-                };
-            };
-            responses: {
-                /** @description Default Response */
-                200: {
-                    headers: {
-                        [name: string]: unknown;
-                    };
-                    content: {
-                        "application/json": {
-                            success: boolean;
-                            data: {
-                                submission: {
-                                    id: string;
-                                    synthesisConfigId: string;
-                                    synthesisOutputId: string;
-                                    synthesisOutputContentKey: string;
-                                    appUserId: string;
-                                    state: string;
-                                    createdAt: string;
-                                    updatedAt?: string;
-                                } & {
-                                    [key: string]: unknown;
-                                };
-                                uploads: {
-                                    field: string;
-                                    s3Key: string;
-                                    uploadUrl: string;
-                                }[];
-                            };
-                        };
-                    };
-                };
-                /** @description Bad request - missing or invalid parameters */
-                400: {
-                    headers: {
-                        [name: string]: unknown;
-                    };
-                    content: {
-                        "application/json": {
-                            /** @example Bad request */
-                            error?: string;
-                        };
-                    };
-                };
-                /** @description Unauthorized errors */
-                401: {
-                    headers: {
-                        [name: string]: unknown;
-                    };
-                    content: {
-                        "application/json": {
-                            /**
-                             * @example Unauthorized: No authentication token provided
-                             * @enum {string}
-                             */
-                            error?: "Unauthorized: No authentication token provided" | "Unauthorized: Token has expired" | "Unauthorized: Invalid token" | "Unauthorized: Authentication failed";
-                        };
-                    };
-                };
-                /** @description Not found */
-                404: {
-                    headers: {
-                        [name: string]: unknown;
-                    };
-                    content: {
-                        "application/json": {
-                            /** @example Not found */
-                            error?: string;
-                        };
-                    };
-                };
-                /** @description Internal server error */
-                500: {
-                    headers: {
-                        [name: string]: unknown;
-                    };
-                    content: {
-                        "application/json": {
-                            /** @example false */
-                            success?: boolean;
-                            /** @example Internal server error: An unknown error occurred */
-                            error?: string;
-                        };
-                    };
-                };
-            };
-        };
-        delete?: never;
-        options?: never;
-        head?: never;
-        patch?: never;
-        trace?: never;
-    };
-    "/v1/user-submission-schemas/{keyName}/submissions": {
-        parameters: {
-            query?: never;
-            header?: never;
-            path?: never;
-            cookie?: never;
-        };
-        /**
-         * User Submissions - List Live Submissions
-         * @description **GET** `/v1/user-submission-schemas/:keyName/submissions` Lists live submissions for a schema. Customer apps cannot read non-live submissions.
-         */
-        get: {
-            parameters: {
-                query?: {
-                    first?: number;
-                    after?: string;
-                };
-                header: {
-                    authorization: string;
-                };
-                path: {
-                    keyName: string;
-                };
-                cookie?: never;
-            };
-            requestBody?: never;
-            responses: {
-                /** @description Default Response */
-                200: {
-                    headers: {
-                        [name: string]: unknown;
-                    };
-                    content: {
-                        "application/json": {
-                            success: boolean;
-                            data: {
-                                cursor: null | string;
-                                items: {
-                                    id: string;
-                                    data: {
-                                        [key: string]: unknown;
-                                    };
-                                    files: {
-                                        field: string;
-                                        contentType: string;
-                                        fileName?: string;
-                                        downloadUrl: string;
-                                    }[];
-                                    createdAt: string;
-                                }[];
-                            };
-                        };
-                    };
-                };
-                /** @description Bad request - missing or invalid parameters */
-                400: {
-                    headers: {
-                        [name: string]: unknown;
-                    };
-                    content: {
-                        "application/json": {
-                            /** @example Bad request */
-                            error?: string;
-                        };
-                    };
-                };
-                /** @description Unauthorized errors */
-                401: {
+                /** @description Forbidden errors */
+                403: {
                     headers: {
                         [name: string]: unknown;
                     };
                     content: {
                         "application/json": {
                             /**
-                             * @example Unauthorized: No authentication token provided
+                             * @example Forbidden: Subscription required
                              * @enum {string}
                              */
-                            error?: "Unauthorized: No authentication token provided" | "Unauthorized: Token has expired" | "Unauthorized: Invalid token" | "Unauthorized: Authentication failed";
-                        };
-                    };
-                };
-                /** @description Not found */
-                404: {
-                    headers: {
-                        [name: string]: unknown;
-                    };
-                    content: {
-                        "application/json": {
-                            /** @example Not found */
-                            error?: string;
+                            error: "Forbidden: Subscription required";
                         };
                     };
                 };
@@ -2287,8 +2365,6 @@ export interface paths {
                 };
             };
         };
-        put?: never;
-        post?: never;
         delete?: never;
         options?: never;
         head?: never;