diff --git a/CHANGELOG.md b/CHANGELOG.md index bc6b0ddd7..8eb3fde89 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -22,6 +22,11 @@ The backend (`fastapi_backend`) and the frontend (`nextjs-frontend`) are version answer text, file names, titles, people, paths or addresses. Settings shows whether it is on and how the last exports went, and can send a test span; the API and each worker follow a change without a restart (docs/telemetry.md). +- **Security: the API client generator is upgraded.** `@hey-api/openapi-ts` moves from 0.83 to 0.99, which removes + the critical handlebars and tar alerts it brought in and fixes a prototype-chain issue in the generated client + itself. `make openapi` regenerates `app/openapi-client` as before. The client keeps its old behaviour of failing + loudly when the API can't be reached (`throwingNetworkErrors` in `lib/api/client.ts`), so an API outage still shows + as an error rather than as "Wrong email or password". - **Security: frontend dependencies patched.** The web app's lockfile now pulls fixed versions of form-data, ws, brace-expansion, minimatch, picomatch, glob, js-yaml, flatted, browserslist, Babel and the other packages GitHub flagged, each kept inside the major version its parent asks for (`overrides` in `nextjs-frontend/pnpm-workspace.yaml`). diff --git a/nextjs-frontend/__tests__/api-client.test.ts b/nextjs-frontend/__tests__/api-client.test.ts new file mode 100644 index 000000000..12db431fa --- /dev/null +++ b/nextjs-frontend/__tests__/api-client.test.ts @@ -0,0 +1,33 @@ +/** + * @jest-environment node + */ +import { Auth } from "@/app/openapi-client"; +import { createClient, createConfig } from "@/app/openapi-client/client"; +import { throwingNetworkErrors } from "@/lib/api/client"; + +function clientWith(fetchImpl: typeof fetch) { + return throwingNetworkErrors(createClient(createConfig({ baseUrl: "http://api.test", fetch: fetchImpl }))); +} + +describe("the API client", () => { + it("rejects when the API can't be reached", async () => { + const client = clientWith(() => Promise.reject(new TypeError("fetch failed"))); + await expect(Auth.status({ client })).rejects.toThrow("fetch failed"); + }); + + it("returns HTTP errors with the response", async () => { + const client = clientWith(async () => + Response.json({ detail: "Too many attempts" }, { status: 429, headers: { "Content-Type": "application/json" } }), + ); + const { data, error, response } = await Auth.login({ client, body: { email: "a@b.c", password: "x" } }); + expect(data).toBeUndefined(); + expect(error).toEqual({ detail: "Too many attempts" }); + expect(response?.status).toBe(429); + }); + + it("returns data on success", async () => { + const client = clientWith(async () => Response.json({ setup_required: false })); + const { data } = await Auth.status({ client }); + expect(data).toEqual({ setup_required: false }); + }); +}); diff --git a/nextjs-frontend/app/openapi-client/client.gen.ts b/nextjs-frontend/app/openapi-client/client.gen.ts index 849f3364c..e64944e30 100644 --- a/nextjs-frontend/app/openapi-client/client.gen.ts +++ b/nextjs-frontend/app/openapi-client/client.gen.ts @@ -1,7 +1,7 @@ // This file is auto-generated by @hey-api/openapi-ts -import type { ClientOptions } from "./types.gen"; -import { type ClientOptions as DefaultClientOptions, type Config, createClient, createConfig } from "./client"; +import { type Client, type ClientOptions, type Config, createClient, createConfig } from "./client"; +import type { ClientOptions as ClientOptions2 } from "./types.gen"; /** * The `createClientConfig()` function will be called on client initialization @@ -11,8 +11,8 @@ import { type ClientOptions as DefaultClientOptions, type Config, createClient, * `setConfig()`. This is useful for example if you're using Next.js * to ensure your client always has the correct values. */ -export type CreateClientConfig = ( - override?: Config, -) => Config & T>; +export type CreateClientConfig = ( + override?: Config, +) => Config & T>; -export const client = createClient(createConfig()); +export const client: Client = createClient(createConfig()); diff --git a/nextjs-frontend/app/openapi-client/client/client.gen.ts b/nextjs-frontend/app/openapi-client/client/client.gen.ts index 440e30b1c..f5a7d956e 100644 --- a/nextjs-frontend/app/openapi-client/client/client.gen.ts +++ b/nextjs-frontend/app/openapi-client/client/client.gen.ts @@ -31,20 +31,24 @@ export const createClient = (config: Config = {}): Client => { const interceptors = createInterceptors(); - const beforeRequest = async (options: RequestOptions) => { + const beforeRequest = async < + TData = unknown, + TResponseStyle extends "data" | "fields" = "fields", + ThrowOnError extends boolean = boolean, + Url extends string = string, + >( + options: RequestOptions, + ) => { const opts = { ..._config, ...options, fetch: options.fetch ?? _config.fetch ?? globalThis.fetch, headers: mergeHeaders(_config.headers, options.headers), - serializedBody: undefined, + serializedBody: undefined as string | undefined, }; if (opts.security) { - await setAuthParams({ - ...opts, - security: opts.security, - }); + await setAuthParams(opts); } if (opts.requestValidator) { @@ -52,7 +56,7 @@ export const createClient = (config: Config = {}): Client => { } if (opts.body !== undefined && opts.bodySerializer) { - opts.serializedBody = opts.bodySerializer(opts.body); + opts.serializedBody = opts.bodySerializer(opts.body) as string | undefined; } // remove Content-Type header if body is empty to avoid sending invalid requests @@ -60,142 +64,159 @@ export const createClient = (config: Config = {}): Client => { opts.headers.delete("Content-Type"); } - const url = buildUrl(opts); + const resolvedOpts = opts as typeof opts & ResolvedRequestOptions; + const url = buildUrl(resolvedOpts); - return { opts, url }; + return { opts: resolvedOpts, url }; }; const request: Client["request"] = async (options) => { - // @ts-expect-error - const { opts, url } = await beforeRequest(options); - const requestInit: ReqInit = { - redirect: "follow", - ...opts, - body: getValidRequestBody(opts), - }; + const throwOnError = options.throwOnError ?? _config.throwOnError; + const responseStyle = options.responseStyle ?? _config.responseStyle; - let request = new Request(url, requestInit); + let request: Request | undefined; + let response: Response | undefined; - for (const fn of interceptors.request.fns) { - if (fn) { - request = await fn(request, opts); - } - } + try { + const { opts, url } = await beforeRequest(options); + const requestInit: ReqInit = { + redirect: "follow", + ...opts, + body: getValidRequestBody(opts), + }; - // fetch must be assigned here, otherwise it would throw the error: - // TypeError: Failed to execute 'fetch' on 'Window': Illegal invocation - const _fetch = opts.fetch!; - let response = await _fetch(request); + request = new Request(url, requestInit); - for (const fn of interceptors.response.fns) { - if (fn) { - response = await fn(response, request, opts); + for (const fn of interceptors.request.fns) { + if (fn) { + request = await fn(request, opts); + } } - } - const result = { - request, - response, - }; + // fetch must be assigned here, otherwise it would throw the error: + // TypeError: Failed to execute 'fetch' on 'Window': Illegal invocation + const _fetch = opts.fetch!; + + response = await _fetch(request); + + for (const fn of interceptors.response.fns) { + if (fn) { + response = await fn(response, request, opts); + } + } - if (response.ok) { - const parseAs = - (opts.parseAs === "auto" ? getParseAs(response.headers.get("Content-Type")) : opts.parseAs) ?? "json"; + const result = { + request, + response, + }; + + if (response.ok) { + const parseAs = + (opts.parseAs === "auto" ? getParseAs(response.headers.get("Content-Type")) : opts.parseAs) ?? "json"; + + if (response.status === 204 || response.headers.get("Content-Length") === "0") { + let emptyData: any; + switch (parseAs) { + case "arrayBuffer": + case "blob": + case "text": + emptyData = await response[parseAs](); + break; + case "formData": + emptyData = new FormData(); + break; + case "stream": + emptyData = response.body; + break; + case "json": + default: + emptyData = {}; + break; + } + return opts.responseStyle === "data" + ? emptyData + : { + data: emptyData, + ...result, + }; + } - if (response.status === 204 || response.headers.get("Content-Length") === "0") { - let emptyData: any; + let data: any; switch (parseAs) { case "arrayBuffer": case "blob": + case "formData": case "text": - emptyData = await response[parseAs](); + data = await response[parseAs](); break; - case "formData": - emptyData = new FormData(); + case "json": { + // Some servers return 200 with no Content-Length and empty body. + // response.json() would throw; read as text and parse if non-empty. + const text = await response.text(); + data = text ? JSON.parse(text) : {}; break; + } case "stream": - emptyData = response.body; - break; - case "json": - default: - emptyData = {}; - break; + return opts.responseStyle === "data" + ? response.body + : { + data: response.body, + ...result, + }; } + + if (parseAs === "json") { + if (opts.responseValidator) { + await opts.responseValidator(data); + } + + if (opts.responseTransformer) { + data = await opts.responseTransformer(data); + } + } + return opts.responseStyle === "data" - ? emptyData + ? data : { - data: emptyData, + data, ...result, }; } - let data: any; - switch (parseAs) { - case "arrayBuffer": - case "blob": - case "formData": - case "json": - case "text": - data = await response[parseAs](); - break; - case "stream": - return opts.responseStyle === "data" - ? response.body - : { - data: response.body, - ...result, - }; + const textError = await response.text(); + let jsonError: unknown; + + try { + jsonError = JSON.parse(textError); + } catch { + // noop } - if (parseAs === "json") { - if (opts.responseValidator) { - await opts.responseValidator(data); - } + throw jsonError ?? textError; + } catch (error) { + let finalError = error; - if (opts.responseTransformer) { - data = await opts.responseTransformer(data); + for (const fn of interceptors.error.fns) { + if (fn) { + finalError = await fn(finalError, response, request, options as ResolvedRequestOptions); } } - return opts.responseStyle === "data" - ? data - : { - data, - ...result, - }; - } - - const textError = await response.text(); - let jsonError: unknown; - - try { - jsonError = JSON.parse(textError); - } catch { - // noop - } - - const error = jsonError ?? textError; - let finalError = error; + finalError = finalError || {}; - for (const fn of interceptors.error.fns) { - if (fn) { - finalError = (await fn(error, response, request, opts)) as string; + if (throwOnError) { + throw finalError; } - } - - finalError = finalError || ({} as string); - if (opts.throwOnError) { - throw finalError; + // TODO: we probably want to return error and improve types + return responseStyle === "data" + ? undefined + : { + error: finalError, + request, + response, + }; } - - // TODO: we probably want to return error and improve types - return opts.responseStyle === "data" - ? undefined - : { - error: finalError, - ...result, - }; }; const makeMethodFn = (method: Uppercase) => (options: RequestOptions) => request({ ...options, method }); @@ -205,7 +226,6 @@ export const createClient = (config: Config = {}): Client => { return createSseClient({ ...opts, body: opts.body as BodyInit | null | undefined, - headers: opts.headers as unknown as Record, method, onRequest: async (url, init) => { let request = new Request(url, init); @@ -216,12 +236,15 @@ export const createClient = (config: Config = {}): Client => { } return request; }, + serializedBody: getValidRequestBody(opts) as BodyInit | null | undefined, url, }); }; + const _buildUrl: Client["buildUrl"] = (options) => buildUrl({ ..._config, ...options }); + return { - buildUrl, + buildUrl: _buildUrl, connect: makeMethodFn("CONNECT"), delete: makeMethodFn("DELETE"), get: makeMethodFn("GET"), diff --git a/nextjs-frontend/app/openapi-client/client/index.ts b/nextjs-frontend/app/openapi-client/client/index.ts index ed0c5bc52..45f69ad0d 100644 --- a/nextjs-frontend/app/openapi-client/client/index.ts +++ b/nextjs-frontend/app/openapi-client/client/index.ts @@ -4,6 +4,9 @@ export type { Auth } from "../core/auth.gen"; export type { QuerySerializerOptions } from "../core/bodySerializer.gen"; export { formDataBodySerializer, jsonBodySerializer, urlSearchParamsBodySerializer } from "../core/bodySerializer.gen"; export { buildClientParams } from "../core/params.gen"; +export { serializeQueryKeyValue } from "../core/queryKeySerializer.gen"; +export type { ServerSentEventsResult } from "../core/serverSentEvents.gen"; +export type { ClientMeta } from "../core/types.gen"; export { createClient } from "./client.gen"; export type { Client, @@ -11,7 +14,6 @@ export type { Config, CreateClientConfig, Options, - OptionsLegacyParser, RequestOptions, RequestResult, ResolvedRequestOptions, diff --git a/nextjs-frontend/app/openapi-client/client/types.gen.ts b/nextjs-frontend/app/openapi-client/client/types.gen.ts index 8a30ed939..c943aa362 100644 --- a/nextjs-frontend/app/openapi-client/client/types.gen.ts +++ b/nextjs-frontend/app/openapi-client/client/types.gen.ts @@ -63,7 +63,7 @@ export interface RequestOptions< }>, Pick< ServerSentEventsOptions, - "onSseError" | "onSseEvent" | "sseDefaultRetryDelay" | "sseMaxRetryAttempts" | "sseMaxRetryDelay" + "onRequest" | "onSseError" | "onSseEvent" | "sseDefaultRetryDelay" | "sseMaxRetryAttempts" | "sseMaxRetryDelay" > { /** * Any body that you want to add to your request. @@ -85,6 +85,7 @@ export interface ResolvedRequestOptions< ThrowOnError extends boolean = boolean, Url extends string = string, > extends RequestOptions { + headers: Headers; serializedBody?: string; } @@ -118,8 +119,10 @@ export type RequestResult< error: TError extends Record ? TError[keyof TError] : TError; } ) & { - request: Request; - response: Response; + /** request may be undefined, because error may be from building the request object itself */ + request?: Request; + /** response may be undefined, because error may be from building the request object itself or from a network error */ + response?: Response; } >; @@ -140,12 +143,13 @@ type MethodFn = < type SseFn = < TData = unknown, - TError = unknown, + // eslint-disable-next-line @typescript-eslint/no-unused-vars + _TError = unknown, ThrowOnError extends boolean = false, TResponseStyle extends ResponseStyle = "fields", >( - options: Omit, "method">, -) => Promise>; + options: Omit, "method">, +) => Promise>; type RequestFn = < TData = unknown, @@ -165,7 +169,7 @@ type BuildUrlFn = < url: string; }, >( - options: Pick & Options, + options: TData & Options, ) => string; export type Client = CoreClient & { @@ -200,20 +204,4 @@ export type Options< TResponse = unknown, TResponseStyle extends ResponseStyle = "fields", > = OmitKeys, "body" | "path" | "query" | "url"> & - Omit; - -export type OptionsLegacyParser< - TData = unknown, - ThrowOnError extends boolean = boolean, - TResponseStyle extends ResponseStyle = "fields", -> = TData extends { body?: any } - ? TData extends { headers?: any } - ? OmitKeys, "body" | "headers" | "url"> & TData - : OmitKeys, "body" | "url"> & - TData & - Pick, "headers"> - : TData extends { headers?: any } - ? OmitKeys, "headers" | "url"> & - TData & - Pick, "body"> - : OmitKeys, "url"> & TData; + ([TData] extends [never] ? unknown : Omit); diff --git a/nextjs-frontend/app/openapi-client/client/utils.gen.ts b/nextjs-frontend/app/openapi-client/client/utils.gen.ts index 199ee9739..8d12f9c58 100644 --- a/nextjs-frontend/app/openapi-client/client/utils.gen.ts +++ b/nextjs-frontend/app/openapi-client/client/utils.gen.ts @@ -7,8 +7,10 @@ import { serializeArrayParam, serializeObjectParam, serializePrimitiveParam } fr import { getUrl } from "../core/utils.gen"; import type { Client, ClientOptions, Config, RequestOptions } from "./types.gen"; -export const createQuerySerializer = ({ allowReserved, array, object }: QuerySerializerOptions = {}) => { - const querySerializer = (queryParams: T) => { +export const createQuerySerializer = ({ parameters = {}, ...args }: QuerySerializerOptions = {}): (( + queryParams: T, +) => string) => { + const querySerializer = (queryParams: T): string => { const search: string[] = []; if (queryParams && typeof queryParams === "object") { for (const name in queryParams) { @@ -18,29 +20,31 @@ export const createQuerySerializer = ({ allowReserved, array, objec continue; } + const options = parameters[name] || args; + if (Array.isArray(value)) { const serializedArray = serializeArrayParam({ - allowReserved, + allowReserved: options.allowReserved, explode: true, name, style: "form", value, - ...array, + ...options.array, }); if (serializedArray) search.push(serializedArray); } else if (typeof value === "object") { const serializedObject = serializeObjectParam({ - allowReserved, + allowReserved: options.allowReserved, explode: true, name, style: "deepObject", value: value as Record, - ...object, + ...options.object, }); if (serializedObject) search.push(serializedObject); } else { const serializedPrimitive = serializePrimitiveParam({ - allowReserved, + allowReserved: options.allowReserved, name, value: value as string, }); @@ -103,14 +107,12 @@ const checkForExistence = ( return false; }; -export const setAuthParams = async ({ - security, - ...options -}: Pick, "security"> & - Pick & { +export async function setAuthParams( + options: Pick & { headers: Headers; - }) => { - for (const auth of security) { + }, +): Promise { + for (const auth of options.security ?? []) { if (checkForExistence(options, auth.name)) { continue; } @@ -139,7 +141,7 @@ export const setAuthParams = async ({ break; } } -}; +} export const buildUrl: Client["buildUrl"] = (options) => getUrl({ @@ -187,7 +189,7 @@ export const mergeHeaders = (...headers: Array["headers"] | und mergedHeaders.append(key, v as string); } } else if (value !== undefined) { - // assume object headers are meant to be JSON stringified, i.e. their + // assume object headers are meant to be JSON stringified, i.e., their // content value in OpenAPI specification is 'application/json' mergedHeaders.set(key, typeof value === "object" ? JSON.stringify(value) : (value as string)); } @@ -198,8 +200,10 @@ export const mergeHeaders = (...headers: Array["headers"] | und type ErrInterceptor = ( error: Err, - response: Res, - request: Req, + /** response may be undefined due to a network error where no response object is produced */ + response: Res | undefined, + /** request may be undefined, because error may be from building the request object itself */ + request: Req | undefined, options: Options, ) => Err | Promise; diff --git a/nextjs-frontend/app/openapi-client/core/auth.gen.ts b/nextjs-frontend/app/openapi-client/core/auth.gen.ts index d392a5cb5..9f3a7cd8e 100644 --- a/nextjs-frontend/app/openapi-client/core/auth.gen.ts +++ b/nextjs-frontend/app/openapi-client/core/auth.gen.ts @@ -9,6 +9,13 @@ export interface Auth { * @default 'header' */ in?: "header" | "query" | "cookie"; + /** + * A unique identifier for the security scheme. + * + * Defined only when there are multiple security schemes whose `Auth` + * shape would otherwise be identical. + */ + key?: string; /** * Header or query parameter name. * diff --git a/nextjs-frontend/app/openapi-client/core/bodySerializer.gen.ts b/nextjs-frontend/app/openapi-client/core/bodySerializer.gen.ts index 9a8009564..07d5581a5 100644 --- a/nextjs-frontend/app/openapi-client/core/bodySerializer.gen.ts +++ b/nextjs-frontend/app/openapi-client/core/bodySerializer.gen.ts @@ -4,13 +4,21 @@ import type { ArrayStyle, ObjectStyle, SerializerOptions } from "./pathSerialize export type QuerySerializer = (query: Record) => string; -export type BodySerializer = (body: any) => any; +export type BodySerializer = (body: unknown) => unknown; -export interface QuerySerializerOptions { +type QuerySerializerOptionsObject = { allowReserved?: boolean; - array?: SerializerOptions; - object?: SerializerOptions; -} + array?: Partial>; + object?: Partial>; +}; + +export type QuerySerializerOptions = QuerySerializerOptionsObject & { + /** + * Per-parameter serialization overrides. When provided, these settings + * override the global array/object settings for specific parameter names. + */ + parameters?: Record; +}; const serializeFormDataPair = (data: FormData, key: string, value: unknown): void => { if (typeof value === "string" || value instanceof Blob) { @@ -31,10 +39,10 @@ const serializeUrlSearchParamsPair = (data: URLSearchParams, key: string, value: }; export const formDataBodySerializer = { - bodySerializer: | Array>>(body: T): FormData => { + bodySerializer: (body: unknown): FormData => { const data = new FormData(); - Object.entries(body).forEach(([key, value]) => { + Object.entries(body as Record).forEach(([key, value]) => { if (value === undefined || value === null) { return; } @@ -50,15 +58,15 @@ export const formDataBodySerializer = { }; export const jsonBodySerializer = { - bodySerializer: (body: T): string => + bodySerializer: (body: unknown): string => JSON.stringify(body, (_key, value) => (typeof value === "bigint" ? value.toString() : value)), }; export const urlSearchParamsBodySerializer = { - bodySerializer: | Array>>(body: T): string => { + bodySerializer: (body: unknown): string => { const data = new URLSearchParams(); - Object.entries(body).forEach(([key, value]) => { + Object.entries(body as Record).forEach(([key, value]) => { if (value === undefined || value === null) { return; } diff --git a/nextjs-frontend/app/openapi-client/core/params.gen.ts b/nextjs-frontend/app/openapi-client/core/params.gen.ts index 52ef537ff..38d634cba 100644 --- a/nextjs-frontend/app/openapi-client/core/params.gen.ts +++ b/nextjs-frontend/app/openapi-client/core/params.gen.ts @@ -22,6 +22,17 @@ export type Field = */ key?: string; map?: string; + } + | { + /** + * Field name. This is the name we want the user to see and use. + */ + key: string; + /** + * Field mapped name. This is the name we want to use in the request. + * If `in` is omitted, `map` aliases `key` to the transport layer. + */ + map: Slot; }; export interface Fields { @@ -41,13 +52,17 @@ const extraPrefixes = Object.entries(extraPrefixesMap); type KeyMap = Map< string, - { - in: Slot; - map?: string; - } + | { + in: Slot; + map?: string; + } + | { + in?: never; + map: Slot; + } >; -const buildKeyMap = (fields: FieldsConfig, map?: KeyMap): KeyMap => { +function buildKeyMap(fields: FieldsConfig, map?: KeyMap): KeyMap { if (!map) { map = new Map(); } @@ -60,39 +75,52 @@ const buildKeyMap = (fields: FieldsConfig, map?: KeyMap): KeyMap => { map: config.map, }); } + } else if ("key" in config) { + map.set(config.key, { + map: config.map, + }); } else if (config.args) { buildKeyMap(config.args, map); } } return map; -}; +} interface Params { - body: unknown; + body?: unknown; headers: Record; path: Record; query: Record; } -const stripEmptySlots = (params: Params) => { +function stripEmptySlots(params: Params): void { for (const [slot, value] of Object.entries(params)) { - if (value && typeof value === "object" && !Object.keys(value).length) { + if (slot === "body") continue; + if (value && typeof value === "object" && !Array.isArray(value) && !Object.keys(value).length) { delete params[slot as Slot]; } } -}; +} -export const buildClientParams = (args: ReadonlyArray, fields: FieldsConfig) => { +export function buildClientParams(args: ReadonlyArray, fields: FieldsConfig): Params { const params: Params = { - body: {}, - headers: {}, - path: {}, - query: {}, + headers: Object.create(null), + path: Object.create(null), + query: Object.create(null), }; const map = buildKeyMap(fields); + function writeSlot(slot: Slot, key: string, value: unknown): void { + let record = params[slot] as Record | undefined; + if (record === undefined) { + record = Object.create(null) as Record; + params[slot] = record; + } + record[key] = value; + } + let config: FieldsConfig[number] | undefined; for (const [index, arg] of args.entries()) { @@ -108,7 +136,9 @@ export const buildClientParams = (args: ReadonlyArray, fields: FieldsCo if (config.key) { const field = map.get(config.key)!; const name = field.map || config.key; - (params[field.in] as Record)[name] = arg; + if (field.in) { + writeSlot(field.in, name, arg); + } } else { params.body = arg; } @@ -117,18 +147,22 @@ export const buildClientParams = (args: ReadonlyArray, fields: FieldsCo const field = map.get(key); if (field) { - const name = field.map || key; - (params[field.in] as Record)[name] = value; + if (field.in) { + const name = field.map || key; + writeSlot(field.in, name, value); + } else { + params[field.map] = value; + } } else { const extra = extraPrefixes.find(([prefix]) => key.startsWith(prefix)); if (extra) { const [prefix, slot] = extra; - (params[slot] as Record)[key.slice(prefix.length)] = value; - } else { - for (const [slot, allowed] of Object.entries(config.allowExtra ?? {})) { + writeSlot(slot, key.slice(prefix.length), value); + } else if ("allowExtra" in config && config.allowExtra) { + for (const [slot, allowed] of Object.entries(config.allowExtra)) { if (allowed) { - (params[slot as Slot] as Record)[key] = value; + writeSlot(slot as Slot, key, value); break; } } @@ -141,4 +175,4 @@ export const buildClientParams = (args: ReadonlyArray, fields: FieldsCo stripEmptySlots(params); return params; -}; +} diff --git a/nextjs-frontend/app/openapi-client/core/pathSerializer.gen.ts b/nextjs-frontend/app/openapi-client/core/pathSerializer.gen.ts index aa4d3d918..325fb7075 100644 --- a/nextjs-frontend/app/openapi-client/core/pathSerializer.gen.ts +++ b/nextjs-frontend/app/openapi-client/core/pathSerializer.gen.ts @@ -25,7 +25,7 @@ interface SerializePrimitiveParam extends SerializePrimitiveOptions { value: string; } -export const separatorArrayExplode = (style: ArraySeparatorStyle) => { +export const separatorArrayExplode = (style: ArraySeparatorStyle): "." | ";" | "," | "&" => { switch (style) { case "label": return "."; @@ -38,7 +38,7 @@ export const separatorArrayExplode = (style: ArraySeparatorStyle) => { } }; -export const separatorArrayNoExplode = (style: ArraySeparatorStyle) => { +export const separatorArrayNoExplode = (style: ArraySeparatorStyle): "," | "|" | "%20" => { switch (style) { case "form": return ","; @@ -51,7 +51,7 @@ export const separatorArrayNoExplode = (style: ArraySeparatorStyle) => { } }; -export const separatorObjectExplode = (style: ObjectSeparatorStyle) => { +export const separatorObjectExplode = (style: ObjectSeparatorStyle): "." | ";" | "," | "&" => { switch (style) { case "label": return "."; @@ -72,7 +72,7 @@ export const serializeArrayParam = ({ value, }: SerializeOptions & { value: unknown[]; -}) => { +}): string => { if (!explode) { const joinedValues = (allowReserved ? value : value.map((v) => encodeURIComponent(v as string))).join( separatorArrayNoExplode(style), @@ -106,7 +106,7 @@ export const serializeArrayParam = ({ return style === "label" || style === "matrix" ? separator + joinedValues : joinedValues; }; -export const serializePrimitiveParam = ({ allowReserved, name, value }: SerializePrimitiveParam) => { +export const serializePrimitiveParam = ({ allowReserved, name, value }: SerializePrimitiveParam): string => { if (value === undefined || value === null) { return ""; } @@ -130,7 +130,7 @@ export const serializeObjectParam = ({ }: SerializeOptions & { value: Record | Date; valueOnly?: boolean; -}) => { +}): string => { if (value instanceof Date) { return valueOnly ? value.toISOString() : `${name}=${value.toISOString()}`; } diff --git a/nextjs-frontend/app/openapi-client/core/queryKeySerializer.gen.ts b/nextjs-frontend/app/openapi-client/core/queryKeySerializer.gen.ts new file mode 100644 index 000000000..9bf2184ec --- /dev/null +++ b/nextjs-frontend/app/openapi-client/core/queryKeySerializer.gen.ts @@ -0,0 +1,111 @@ +// This file is auto-generated by @hey-api/openapi-ts + +/** + * JSON-friendly union that mirrors what Pinia Colada can hash. + */ +export type JsonValue = null | string | number | boolean | JsonValue[] | { [key: string]: JsonValue }; + +/** + * Replacer that converts non-JSON values (bigint, Date, etc.) to safe substitutes. + */ +export const queryKeyJsonReplacer = (_key: string, value: unknown): unknown | undefined => { + if (value === undefined || typeof value === "function" || typeof value === "symbol") { + return undefined; + } + if (typeof value === "bigint") { + return value.toString(); + } + if (value instanceof Date) { + return value.toISOString(); + } + return value; +}; + +/** + * Safely stringifies a value and parses it back into a JsonValue. + */ +export const stringifyToJsonValue = (input: unknown): JsonValue | undefined => { + try { + const json = JSON.stringify(input, queryKeyJsonReplacer); + if (json === undefined) { + return undefined; + } + return JSON.parse(json) as JsonValue; + } catch { + return undefined; + } +}; + +/** + * Detects plain objects (including objects with a null prototype). + */ +const isPlainObject = (value: unknown): value is Record => { + if (value === null || typeof value !== "object") { + return false; + } + const prototype = Object.getPrototypeOf(value as object); + return prototype === Object.prototype || prototype === null; +}; + +/** + * Turns URLSearchParams into a sorted JSON object for deterministic keys. + */ +const serializeSearchParams = (params: URLSearchParams): JsonValue => { + const entries = Array.from(params.entries()).sort(([a], [b]) => a.localeCompare(b)); + const result: Record = {}; + + for (const [key, value] of entries) { + const existing = result[key]; + if (existing === undefined) { + result[key] = value; + continue; + } + + if (Array.isArray(existing)) { + (existing as string[]).push(value); + } else { + result[key] = [existing, value]; + } + } + + return result; +}; + +/** + * Normalizes any accepted value into a JSON-friendly shape for query keys. + */ +export const serializeQueryKeyValue = (value: unknown): JsonValue | undefined => { + if (value === null) { + return null; + } + + if (typeof value === "string" || typeof value === "number" || typeof value === "boolean") { + return value; + } + + if (value === undefined || typeof value === "function" || typeof value === "symbol") { + return undefined; + } + + if (typeof value === "bigint") { + return value.toString(); + } + + if (value instanceof Date) { + return value.toISOString(); + } + + if (Array.isArray(value)) { + return stringifyToJsonValue(value); + } + + if (typeof URLSearchParams !== "undefined" && value instanceof URLSearchParams) { + return serializeSearchParams(value); + } + + if (isPlainObject(value)) { + return stringifyToJsonValue(value); + } + + return undefined; +}; diff --git a/nextjs-frontend/app/openapi-client/core/serverSentEvents.gen.ts b/nextjs-frontend/app/openapi-client/core/serverSentEvents.gen.ts index b2fe59604..09194470c 100644 --- a/nextjs-frontend/app/openapi-client/core/serverSentEvents.gen.ts +++ b/nextjs-frontend/app/openapi-client/core/serverSentEvents.gen.ts @@ -75,7 +75,7 @@ export type ServerSentEventsResult ? TData[keyof TData] : TData, TReturn, TNext>; }; -export const createSseClient = ({ +export function createSseClient({ onRequest, onSseError, onSseEvent, @@ -87,7 +87,7 @@ export const createSseClient = ({ sseSleepFn, url, ...options -}: ServerSentEventsOptions): ServerSentEventsResult => { +}: ServerSentEventsOptions): ServerSentEventsResult { let lastEventId: string | undefined; const sleep = sseSleepFn ?? ((ms: number) => new Promise((resolve) => setTimeout(resolve, ms))); @@ -151,6 +151,7 @@ export const createSseClient = ({ const { done, value } = await reader.read(); if (done) break; buffer += value; + buffer = buffer.replace(/\r\n?/g, "\n"); // normalize line endings const chunks = buffer.split("\n\n"); buffer = chunks.pop() ?? ""; @@ -234,4 +235,4 @@ export const createSseClient = ({ const stream = createStream(); return { stream }; -}; +} diff --git a/nextjs-frontend/app/openapi-client/core/types.gen.ts b/nextjs-frontend/app/openapi-client/core/types.gen.ts index 7047c8161..7b436ec81 100644 --- a/nextjs-frontend/app/openapi-client/core/types.gen.ts +++ b/nextjs-frontend/app/openapi-client/core/types.gen.ts @@ -62,7 +62,7 @@ export interface Config { requestValidator?: (data: unknown) => Promise; /** * A function transforming response data before it's returned. This is useful - * for post-processing data, e.g. converting ISO strings into Date objects. + * for post-processing data, e.g., converting ISO strings into Date objects. */ responseTransformer?: (data: unknown) => Promise; /** @@ -73,6 +73,12 @@ export interface Config { responseValidator?: (data: unknown) => Promise; } +/** + * Arbitrary metadata passed through the `meta` request option. + */ +// eslint-disable-next-line @typescript-eslint/no-empty-object-type +export interface ClientMeta {} + type IsExactlyNeverOrNeverUndefined = [T] extends [never] ? true : [T] extends [never | undefined] diff --git a/nextjs-frontend/app/openapi-client/core/utils.gen.ts b/nextjs-frontend/app/openapi-client/core/utils.gen.ts index f210e72a4..92a6608a9 100644 --- a/nextjs-frontend/app/openapi-client/core/utils.gen.ts +++ b/nextjs-frontend/app/openapi-client/core/utils.gen.ts @@ -13,9 +13,9 @@ export interface PathSerializer { url: string; } -export const PATH_PARAM_RE = /\{[^{}]+\}/g; +export const PATH_PARAM_RE: RegExp = /\{[^{}]+\}/g; -export const defaultPathSerializer = ({ path, url: _url }: PathSerializer) => { +export const defaultPathSerializer = ({ path, url: _url }: PathSerializer): string => { let url = _url; const matches = _url.match(PATH_PARAM_RE); if (matches) { @@ -92,7 +92,7 @@ export const getUrl = ({ query?: Record; querySerializer: QuerySerializer; url: string; -}) => { +}): string => { const pathUrl = _url.startsWith("/") ? _url : `/${_url}`; let url = (baseUrl ?? "") + pathUrl; if (path) { @@ -112,7 +112,7 @@ export function getValidRequestBody(options: { body?: unknown; bodySerializer?: BodySerializer | null; serializedBody?: unknown; -}) { +}): unknown { const hasBody = options.body !== undefined; const isSerializedBody = hasBody && options.bodySerializer; @@ -123,7 +123,7 @@ export function getValidRequestBody(options: { return hasSerializedBody ? options.serializedBody : null; } - // not all clients implement a serializedBody property (i.e. client-axios) + // not all clients implement a serializedBody property (i.e., client-axios) return options.body !== "" ? options.body : null; } diff --git a/nextjs-frontend/app/openapi-client/index.ts b/nextjs-frontend/app/openapi-client/index.ts index a6d236379..1a49a7911 100644 --- a/nextjs-frontend/app/openapi-client/index.ts +++ b/nextjs-frontend/app/openapi-client/index.ts @@ -1,4 +1,1786 @@ // This file is auto-generated by @hey-api/openapi-ts -export * from "./types.gen"; -export * from "./sdk.gen"; +export { + AccessRequests, + Admin, + Auth, + Batches, + Chats, + Collections, + Comments, + ContentTypes, + Entities, + Fields, + Files, + Iiif, + Imports, + Jobs, + Metadata, + Namespaces, + Notes, + Notifications, + Oauth, + type Options, + Pipelines, + Public, + Resources, + Routines, + Search, + Searches, + Setup, + Sources, + Speakers, + Templates, + Tokens, + Uploads, + Users, + Video, + Views, + Workflows, +} from "./sdk.gen"; +export type { + AcceptGraphChangeData, + AcceptGraphChangeError, + AcceptGraphChangeErrors, + AcceptGraphChangeResponse, + AcceptGraphChangeResponses, + AccessRequest, + AccountToken, + AddFileData, + AddFileError, + AddFileErrors, + AddFileResponse, + AddFileResponses, + AddRecordingPermissionData, + AddRecordingPermissionError, + AddRecordingPermissionErrors, + AddRecordingPermissionResponse, + AddRecordingPermissionResponses, + AnswerCheck, + AnswerData, + AnswerError, + AnswerErrors, + AnswerResponse, + AnswerResponses, + ApiToken, + ApiTokenCreate, + ApiTokenCreated, + Approval, + ApprovalDecision, + ApprovalOutcome, + ApproveAccessRequestData, + ApproveAccessRequestError, + ApproveAccessRequestErrors, + ApproveAccessRequestResponse, + ApproveAccessRequestResponses, + AttachedTo, + AuditEntry, + AuthStatus, + Backend, + Batch, + BatchActionResult, + BatchCombine, + BatchCreate, + BatchEstimate, + BatchNeedsConfirmation, + BatchPlan, + BatchProgress, + BatchReport, + BatchReportRef, + BatchResults, + BatchRun, + BatchSelection, + BatchSummary, + BodyOauthRevoke, + BodyOauthToken, + BrowseEntry, + BrowseSourceData, + BrowseSourceError, + BrowseSourceErrors, + BrowseSourceResponse, + BrowseSourceResponses, + BulkUpdateMetadataData, + BulkUpdateMetadataError, + BulkUpdateMetadataErrors, + BulkUpdateMetadataResponse, + BulkUpdateMetadataResponses, + CancelJobData, + CancelJobError, + CancelJobErrors, + CancelJobResponse, + CancelJobResponses, + CancelUploadData, + CancelUploadError, + CancelUploadErrors, + CancelUploadResponse, + CancelUploadResponses, + ChangePasswordData, + ChangePasswordError, + ChangePasswordErrors, + ChangePasswordResponse, + ChangePasswordResponses, + Chat, + ChatCapabilities, + ChatCapabilitiesData, + ChatCapabilitiesResponse, + ChatCapabilitiesResponses, + ChatCreate, + ChatMessage, + ChatScope, + ChatSummary, + ChatUpdate, + CheckMessageData, + CheckMessageError, + CheckMessageErrors, + CheckMessageResponse, + CheckMessageResponses, + ClientOptions, + ClientRegistered, + ClientRegistration, + CloseRecordingToIpGroupData, + CloseRecordingToIpGroupError, + CloseRecordingToIpGroupErrors, + CloseRecordingToIpGroupResponse, + CloseRecordingToIpGroupResponses, + Collection, + CollectionCreate, + CollectionDetail, + CollectionMember, + CollectionMemberSet, + CollectionNode, + CollectionNodeCreate, + CollectionNodeUpdate, + CollectionRecording, + CollectionStep, + CollectionUpdate, + CombineBatchData, + CombineBatchError, + CombineBatchErrors, + CombineBatchResponse, + CombineBatchResponses, + Comment, + CommentCreate, + CommentUpdate, + Consent, + ConsentAnswer, + ConsentClient, + ConsentData, + ConsentError, + ConsentErrors, + ConsentResponse, + ConsentResponses, + ConsentResult, + ContentRules, + ContentState, + ContentType, + ContentTypeCatalog, + ContentTypeCreate, + ContentTypeUpdate, + ContentTypeUse, + ControlBatchData, + ControlBatchError, + ControlBatchErrors, + ControlBatchResponse, + ControlBatchResponses, + ControlWorkerData, + ControlWorkerError, + ControlWorkerErrors, + ControlWorkerResponse, + ControlWorkerResponses, + Converters, + CreateBatchData, + CreateBatchError, + CreateBatchErrors, + CreateBatchResponse, + CreateBatchResponses, + CreateChatData, + CreateChatError, + CreateChatErrors, + CreateChatResponse, + CreateChatResponses, + CreateCollectionData, + CreateCollectionError, + CreateCollectionErrors, + CreateCollectionResponse, + CreateCollectionResponses, + CreateCommentData, + CreateCommentError, + CreateCommentErrors, + CreateCommentResponse, + CreateCommentResponses, + CreateContentTypeData, + CreateContentTypeError, + CreateContentTypeErrors, + CreateContentTypeResponse, + CreateContentTypeResponses, + Created, + CreateFieldData, + CreateFieldError, + CreateFieldErrors, + CreateFieldResponse, + CreateFieldResponses, + CreateHighlightData, + CreateHighlightError, + CreateHighlightErrors, + CreateHighlightResponse, + CreateHighlightResponses, + CreateIpGroupData, + CreateIpGroupError, + CreateIpGroupErrors, + CreateIpGroupResponse, + CreateIpGroupResponses, + CreateJobsData, + CreateJobsError, + CreateJobsErrors, + CreateJobsResponse, + CreateJobsResponses, + CreateNamespaceCollectionData, + CreateNamespaceCollectionError, + CreateNamespaceCollectionErrors, + CreateNamespaceCollectionResponse, + CreateNamespaceCollectionResponses, + CreateNamespaceData, + CreateNamespaceError, + CreateNamespaceErrors, + CreateNamespaceResponse, + CreateNamespaceResponses, + CreateNoteData, + CreateNoteError, + CreateNoteErrors, + CreateNoteResponse, + CreateNoteResponses, + CreateNotifyTargetData, + CreateNotifyTargetError, + CreateNotifyTargetErrors, + CreateNotifyTargetResponse, + CreateNotifyTargetResponses, + CreatePipelineData, + CreatePipelineError, + CreatePipelineErrors, + CreatePipelineResponse, + CreatePipelineResponses, + CreatePipelineVersionData, + CreatePipelineVersionError, + CreatePipelineVersionErrors, + CreatePipelineVersionResponse, + CreatePipelineVersionResponses, + CreateRoutineData, + CreateRoutineError, + CreateRoutineErrors, + CreateRoutineResponse, + CreateRoutineResponses, + CreateSearchData, + CreateSearchError, + CreateSearchErrors, + CreateSearchResponse, + CreateSearchResponses, + CreateShareData, + CreateShareError, + CreateShareErrors, + CreateShareResponse, + CreateShareResponses, + CreateSourceData, + CreateSourceError, + CreateSourceErrors, + CreateSourceResponse, + CreateSourceResponses, + CreateTemplateData, + CreateTemplateError, + CreateTemplateErrors, + CreateTemplateResponse, + CreateTemplateResponses, + CreateTemplateVersionData, + CreateTemplateVersionError, + CreateTemplateVersionErrors, + CreateTemplateVersionResponse, + CreateTemplateVersionResponses, + CreateTokenData, + CreateTokenError, + CreateTokenErrors, + CreateTokenResponse, + CreateTokenResponses, + CreateUserData, + CreateUserError, + CreateUserErrors, + CreateUserResponse, + CreateUserResponses, + CreateViewData, + CreateViewError, + CreateViewErrors, + CreateViewResponse, + CreateViewResponses, + CreateWatchData, + CreateWatchError, + CreateWatchErrors, + CreateWatchResponse, + CreateWatchResponses, + CreateWorkflowData, + CreateWorkflowError, + CreateWorkflowErrors, + CreateWorkflowResponse, + CreateWorkflowResponses, + CreateWorkflowVersionData, + CreateWorkflowVersionError, + CreateWorkflowVersionErrors, + CreateWorkflowVersionResponse, + CreateWorkflowVersionResponses, + DecideApprovalData, + DecideApprovalError, + DecideApprovalErrors, + DecideApprovalResponse, + DecideApprovalResponses, + DeclineAccessRequestData, + DeclineAccessRequestError, + DeclineAccessRequestErrors, + DeclineAccessRequestResponse, + DeclineAccessRequestResponses, + DeleteChatData, + DeleteChatError, + DeleteChatErrors, + DeleteChatResponse, + DeleteChatResponses, + DeleteCollectionData, + DeleteCollectionError, + DeleteCollectionErrors, + DeleteCollectionResponse, + DeleteCollectionResponses, + DeleteCommentData, + DeleteCommentError, + DeleteCommentErrors, + DeleteCommentResponse, + DeleteCommentResponses, + DeleteContentTypeData, + DeleteContentTypeError, + DeleteContentTypeErrors, + DeleteContentTypeResponse, + DeleteContentTypeResponses, + DeleteFaceData, + DeleteFaceError, + DeleteFaceErrors, + DeleteFaceResponse, + DeleteFaceResponses, + DeleteFaceTrackData, + DeleteFaceTrackError, + DeleteFaceTrackErrors, + DeleteFaceTrackResponse, + DeleteFaceTrackResponses, + DeleteFieldData, + DeleteFieldError, + DeleteFieldErrors, + DeleteFieldResponse, + DeleteFieldResponses, + DeleteFileData, + DeleteFileError, + DeleteFileErrors, + DeleteFileResponse, + DeleteFileResponses, + DeleteHighlightData, + DeleteHighlightError, + DeleteHighlightErrors, + DeleteHighlightResponse, + DeleteHighlightResponses, + DeleteIpGroupData, + DeleteIpGroupError, + DeleteIpGroupErrors, + DeleteIpGroupResponse, + DeleteIpGroupResponses, + DeleteNamespaceCollectionData, + DeleteNamespaceCollectionError, + DeleteNamespaceCollectionErrors, + DeleteNamespaceCollectionResponse, + DeleteNamespaceCollectionResponses, + DeleteNamespaceFacesData, + DeleteNamespaceFacesError, + DeleteNamespaceFacesErrors, + DeleteNamespaceFacesResponse, + DeleteNamespaceFacesResponses, + DeleteNoteData, + DeleteNoteError, + DeleteNoteErrors, + DeleteNoteResponse, + DeleteNoteResponses, + DeleteNotifyTargetData, + DeleteNotifyTargetError, + DeleteNotifyTargetErrors, + DeleteNotifyTargetResponse, + DeleteNotifyTargetResponses, + DeleteRecordingData, + DeleteRecordingError, + DeleteRecordingErrors, + DeleteRecordingResponse, + DeleteRecordingResponses, + DeleteRoutineData, + DeleteRoutineError, + DeleteRoutineErrors, + DeleteRoutineResponse, + DeleteRoutineResponses, + DeleteSearchData, + DeleteSearchError, + DeleteSearchErrors, + DeleteSearchResponse, + DeleteSearchResponses, + DeleteSourceData, + DeleteSourceError, + DeleteSourceErrors, + DeleteSourceResponse, + DeleteSourceResponses, + DeleteViewData, + DeleteViewError, + DeleteViewErrors, + DeleteViewResponse, + DeleteViewResponses, + DeleteWatchData, + DeleteWatchError, + DeleteWatchErrors, + DeleteWatchResponse, + DeleteWatchResponses, + Description, + DiffTemplateVersionsData, + DiffTemplateVersionsError, + DiffTemplateVersionsErrors, + DiffTemplateVersionsResponse, + DiffTemplateVersionsResponses, + DismissFaceSuggestionData, + DismissFaceSuggestionError, + DismissFaceSuggestionErrors, + DismissFaceSuggestionResponse, + DismissFaceSuggestionResponses, + DismissGraphChangeData, + DismissGraphChangeError, + DismissGraphChangeErrors, + DismissGraphChangeResponse, + DismissGraphChangeResponses, + DownloadFileData, + DownloadFileError, + DownloadFileErrors, + DownloadFileResponse, + DownloadFileResponses, + EditSegmentData, + EditSegmentError, + EditSegmentErrors, + EditSegmentResponse, + EditSegmentResponses, + EmailInfo, + EmbedLink, + EntityDetail, + EntityHide, + EntityLink, + EntityLinkRequest, + EntityList, + EntityMerge, + EntityMerged, + EntityNotSame, + EntityRename, + EntityRetype, + EntityType, + Estimate, + EstimateBatchData, + EstimateBatchError, + EstimateBatchErrors, + EstimateBatchResponse, + EstimateBatchResponses, + EventInfo, + ExploreGraphData, + ExploreGraphError, + ExploreGraphErrors, + ExploreGraphResponse, + ExploreGraphResponses, + ExportBatchResultsData, + ExportBatchResultsError, + ExportBatchResultsErrors, + ExportBatchResultsResponses, + ExportRecordingData, + ExportRecordingError, + ExportRecordingErrors, + ExportRecordingResponses, + FaceDismiss, + FaceMerge, + FaceMerged, + FaceRename, + FacesMode, + FacesModeSet, + FaceSpeaker, + FacetCount, + FieldCreate, + FieldDef, + FieldUpdate, + FieldValue, + FieldValues, + FieldValuesUpdate, + FileLine, + FileLines, + FileUpdate, + FindGraphPathData, + FindGraphPathError, + FindGraphPathErrors, + FindGraphPathResponse, + FindGraphPathResponses, + FinishData, + FinishError, + FinishErrors, + FinishResponse, + FinishResponses, + FixScreenTextData, + FixScreenTextError, + FixScreenTextErrors, + FixScreenTextResponse, + FixScreenTextResponses, + ForgotPasswordData, + ForgotPasswordError, + ForgotPasswordErrors, + ForgotPasswordRequest, + ForgotPasswordResponse, + ForgotPasswordResponses, + GetAudioData, + GetAudioError, + GetAudioErrors, + GetAudioResponses, + GetBatchData, + GetBatchError, + GetBatchErrors, + GetBatchResponse, + GetBatchResponses, + GetBatchResultsData, + GetBatchResultsError, + GetBatchResultsErrors, + GetBatchResultsResponse, + GetBatchResultsResponses, + GetChatData, + GetChatError, + GetChatErrors, + GetChatResponse, + GetChatResponses, + GetCollectionData, + GetCollectionError, + GetCollectionErrors, + GetCollectionFieldsData, + GetCollectionFieldsError, + GetCollectionFieldsErrors, + GetCollectionFieldsResponse, + GetCollectionFieldsResponses, + GetCollectionResponse, + GetCollectionResponses, + GetContentStateData, + GetContentStateError, + GetContentStateErrors, + GetContentStateResponse, + GetContentStateResponses, + GetEmbedLinkData, + GetEmbedLinkError, + GetEmbedLinkErrors, + GetEmbedLinkResponse, + GetEmbedLinkResponses, + GetEntityConnectionsData, + GetEntityConnectionsError, + GetEntityConnectionsErrors, + GetEntityConnectionsResponse, + GetEntityConnectionsResponses, + GetEntityData, + GetEntityError, + GetEntityErrors, + GetEntityResponse, + GetEntityResponses, + GetEntityTimelineData, + GetEntityTimelineError, + GetEntityTimelineErrors, + GetEntityTimelineResponse, + GetEntityTimelineResponses, + GetFieldData, + GetFieldError, + GetFieldErrors, + GetFieldResponse, + GetFieldResponses, + GetFileFieldsData, + GetFileFieldsError, + GetFileFieldsErrors, + GetFileFieldsResponse, + GetFileFieldsResponses, + GetFrameData, + GetFrameError, + GetFrameErrors, + GetFrameResponses, + GetGraphData, + GetGraphError, + GetGraphErrors, + GetGraphResponse, + GetGraphResponses, + GetHealthData, + GetHealthResponse, + GetHealthResponses, + GetJobData, + GetJobError, + GetJobErrors, + GetJobLogData, + GetJobLogError, + GetJobLogErrors, + GetJobLogResponse, + GetJobLogResponses, + GetJobResponse, + GetJobResponses, + GetMediaData, + GetMediaError, + GetMediaErrors, + GetMediaResponses, + GetNamespaceCollectionData, + GetNamespaceCollectionError, + GetNamespaceCollectionErrors, + GetNamespaceCollectionResponse, + GetNamespaceCollectionResponses, + GetNamespaceFacesData, + GetNamespaceFacesError, + GetNamespaceFacesErrors, + GetNamespaceFacesResponse, + GetNamespaceFacesResponses, + GetNamespaceMetadataData, + GetNamespaceMetadataError, + GetNamespaceMetadataErrors, + GetNamespaceMetadataResponse, + GetNamespaceMetadataResponses, + GetNamespaceStatsData, + GetNamespaceStatsError, + GetNamespaceStatsErrors, + GetNamespaceStatsResponse, + GetNamespaceStatsResponses, + GetNamespaceWordcloudData, + GetNamespaceWordcloudError, + GetNamespaceWordcloudErrors, + GetNamespaceWordcloudResponse, + GetNamespaceWordcloudResponses, + GetPdfData, + GetPdfError, + GetPdfErrors, + GetPdfResponse, + GetPdfResponses, + GetPipelineData, + GetPipelineError, + GetPipelineErrors, + GetPipelineResponse, + GetPipelineResponses, + GetPlayerData, + GetPlayerError, + GetPlayerErrors, + GetPlayerResponse, + GetPlayerResponses, + GetPublicCollectionData, + GetPublicCollectionError, + GetPublicCollectionErrors, + GetPublicCollectionResponse, + GetPublicCollectionResponses, + GetPublicHomeData, + GetPublicHomeResponse, + GetPublicHomeResponses, + GetPublicRecordingData, + GetPublicRecordingError, + GetPublicRecordingErrors, + GetPublicRecordingResponse, + GetPublicRecordingResponses, + GetRecordingAccessData, + GetRecordingAccessError, + GetRecordingAccessErrors, + GetRecordingAccessResponse, + GetRecordingAccessResponses, + GetRecordingContentTypeData, + GetRecordingContentTypeError, + GetRecordingContentTypeErrors, + GetRecordingContentTypeResponse, + GetRecordingContentTypeResponses, + GetRecordingData, + GetRecordingError, + GetRecordingErrors, + GetRecordingIiifData, + GetRecordingIiifError, + GetRecordingIiifErrors, + GetRecordingIiifResponse, + GetRecordingIiifResponses, + GetRecordingMetadataData, + GetRecordingMetadataError, + GetRecordingMetadataErrors, + GetRecordingMetadataResponse, + GetRecordingMetadataResponses, + GetRecordingResponse, + GetRecordingResponses, + GetRecordingWordcloudData, + GetRecordingWordcloudError, + GetRecordingWordcloudErrors, + GetRecordingWordcloudResponse, + GetRecordingWordcloudResponses, + GetResourceFieldsData, + GetResourceFieldsError, + GetResourceFieldsErrors, + GetResourceFieldsResponse, + GetResourceFieldsResponses, + GetRoutineData, + GetRoutineError, + GetRoutineErrors, + GetRoutineResponse, + GetRoutineResponses, + GetRunData, + GetRunError, + GetRunErrors, + GetRunResponse, + GetRunResponses, + GetSettingsData, + GetSettingsResponse, + GetSettingsResponses, + GetSetupData, + GetSetupResponse, + GetSetupResponses, + GetTemplateData, + GetTemplateError, + GetTemplateErrors, + GetTemplateResponse, + GetTemplateResponses, + GetUploadData, + GetUploadError, + GetUploadErrors, + GetUploadResponse, + GetUploadResponses, + GetWorkflowData, + GetWorkflowError, + GetWorkflowErrors, + GetWorkflowResponse, + GetWorkflowResponses, + Graph, + GraphChange, + GraphChangeAccept, + Health, + HealthCounts, + HealthDatabase, + HealthDisk, + HealthSource, + HideEntityData, + HideEntityError, + HideEntityErrors, + HideEntityResponse, + HideEntityResponses, + Highlight, + HighlightCreate, + HighlightUpdate, + HttpValidationError, + IiifImport, + IiifImported, + IiifPanel, + IiifUrl, + IiifValidation, + ImportedAs, + ImportFromSourceData, + ImportFromSourceError, + ImportFromSourceErrors, + ImportFromSourceResponse, + ImportFromSourceResponses, + ImportIiifData, + ImportIiifError, + ImportIiifErrors, + ImportIiifResponse, + ImportIiifResponses, + ImportPreview, + ImportPreviewRequest, + ImportRequest, + ImportResult, + ImportTranscriptData, + ImportTranscriptError, + ImportTranscriptErrors, + ImportTranscriptResponse, + ImportTranscriptResponses, + ImportWebPageData, + ImportWebPageError, + ImportWebPageErrors, + ImportWebPageResponse, + ImportWebPageResponses, + IpGroup, + IpGroupCreate, + IpGroups, + IpGroupUpdate, + Job, + JobList, + JobLog, + JobPipeline, + JobQueued, + JobsCreate, + JobsQueued, + LanguageCount, + LastSend, + LinkEntityData, + LinkEntityError, + LinkEntityErrors, + LinkEntityResponse, + LinkEntityResponses, + LinkFaceSpeakerData, + LinkFaceSpeakerError, + LinkFaceSpeakerErrors, + LinkFaceSpeakerResponse, + LinkFaceSpeakerResponses, + LinkSpeakerData, + LinkSpeakerError, + LinkSpeakerErrors, + LinkSpeakerResponse, + LinkSpeakerResponses, + ListAccessRequestsData, + ListAccessRequestsError, + ListAccessRequestsErrors, + ListAccessRequestsResponse, + ListAccessRequestsResponses, + ListAllTokensData, + ListAllTokensResponse, + ListAllTokensResponses, + ListApprovalsData, + ListApprovalsError, + ListApprovalsErrors, + ListApprovalsResponse, + ListApprovalsResponses, + ListAuditData, + ListAuditError, + ListAuditErrors, + ListAuditResponse, + ListAuditResponses, + ListBackendsData, + ListBackendsResponse, + ListBackendsResponses, + ListBatchesData, + ListBatchesResponse, + ListBatchesResponses, + ListChatsData, + ListChatsResponse, + ListChatsResponses, + ListCollectionMembersData, + ListCollectionMembersError, + ListCollectionMembersErrors, + ListCollectionMembersResponse, + ListCollectionMembersResponses, + ListCollectionsData, + ListCollectionsResponse, + ListCollectionsResponses, + ListCommentsData, + ListCommentsError, + ListCommentsErrors, + ListCommentsResponse, + ListCommentsResponses, + ListContentTypesData, + ListContentTypesResponse, + ListContentTypesResponses, + ListEntitiesData, + ListEntitiesError, + ListEntitiesErrors, + ListEntitiesResponse, + ListEntitiesResponses, + ListEntityMentionsData, + ListEntityMentionsError, + ListEntityMentionsErrors, + ListEntityMentionsResponse, + ListEntityMentionsResponses, + ListEntityMergesData, + ListEntityMergesResponse, + ListEntityMergesResponses, + ListEntitySuggestionsData, + ListEntitySuggestionsError, + ListEntitySuggestionsErrors, + ListEntitySuggestionsResponse, + ListEntitySuggestionsResponses, + ListEntityTypesData, + ListEntityTypesResponse, + ListEntityTypesResponses, + ListFieldsData, + ListFieldsError, + ListFieldsErrors, + ListFieldsResponse, + ListFieldsResponses, + ListFileLinesData, + ListFileLinesError, + ListFileLinesErrors, + ListFileLinesResponse, + ListFileLinesResponses, + ListFilesData, + ListFilesError, + ListFilesErrors, + ListFilesResponse, + ListFilesResponses, + ListGrantsData, + ListGrantsResponse, + ListGrantsResponses, + ListGraphChangesData, + ListGraphChangesError, + ListGraphChangesErrors, + ListGraphChangesResponse, + ListGraphChangesResponses, + ListHighlightsData, + ListHighlightsError, + ListHighlightsErrors, + ListHighlightsResponse, + ListHighlightsResponses, + ListIpGroupsData, + ListIpGroupsError, + ListIpGroupsErrors, + ListIpGroupsResponse, + ListIpGroupsResponses, + ListJobsData, + ListJobsError, + ListJobsErrors, + ListJobsResponse, + ListJobsResponses, + ListLanguagesData, + ListLanguagesError, + ListLanguagesErrors, + ListLanguagesResponse, + ListLanguagesResponses, + ListMembersData, + ListMembersError, + ListMembersErrors, + ListMembersResponse, + ListMembersResponses, + ListMentionsData, + ListMentionsError, + ListMentionsErrors, + ListMentionsResponse, + ListMentionsResponses, + ListNamespaceCollectionsData, + ListNamespaceCollectionsError, + ListNamespaceCollectionsErrors, + ListNamespaceCollectionsResponse, + ListNamespaceCollectionsResponses, + ListNamespacesData, + ListNamespacesResponse, + ListNamespacesResponses, + ListNotesData, + ListNotesError, + ListNotesErrors, + ListNotesResponse, + ListNotesResponses, + ListNotifyDeliveriesData, + ListNotifyDeliveriesError, + ListNotifyDeliveriesErrors, + ListNotifyDeliveriesResponse, + ListNotifyDeliveriesResponses, + ListNotifyTargetsData, + ListNotifyTargetsError, + ListNotifyTargetsErrors, + ListNotifyTargetsResponse, + ListNotifyTargetsResponses, + ListObjectsData, + ListObjectsError, + ListObjectsErrors, + ListObjectsResponse, + ListObjectsResponses, + ListOriginsData, + ListOriginsError, + ListOriginsErrors, + ListOriginsResponse, + ListOriginsResponses, + ListOutputsData, + ListOutputsError, + ListOutputsErrors, + ListOutputsResponse, + ListOutputsResponses, + ListPendingAccessRequestsData, + ListPendingAccessRequestsResponse, + ListPendingAccessRequestsResponses, + ListPipelinesData, + ListPipelinesResponse, + ListPipelinesResponses, + ListRecordingIpGroupsData, + ListRecordingIpGroupsError, + ListRecordingIpGroupsErrors, + ListRecordingIpGroupsResponse, + ListRecordingIpGroupsResponses, + ListRecordingMetadataHistoryData, + ListRecordingMetadataHistoryError, + ListRecordingMetadataHistoryErrors, + ListRecordingMetadataHistoryResponse, + ListRecordingMetadataHistoryResponses, + ListRecordingPermissionsData, + ListRecordingPermissionsError, + ListRecordingPermissionsErrors, + ListRecordingPermissionsResponse, + ListRecordingPermissionsResponses, + ListRecordingsData, + ListRecordingsError, + ListRecordingsErrors, + ListRecordingsResponse, + ListRecordingsResponses, + ListRoutinesData, + ListRoutinesResponse, + ListRoutinesResponses, + ListRunsData, + ListRunsError, + ListRunsErrors, + ListRunsResponse, + ListRunsResponses, + ListSearchesData, + ListSearchesResponse, + ListSearchesResponses, + ListSegmentEditsData, + ListSegmentEditsError, + ListSegmentEditsErrors, + ListSegmentEditsResponse, + ListSegmentEditsResponses, + ListSharesData, + ListSharesError, + ListSharesErrors, + ListSharesResponse, + ListSharesResponses, + ListSourcesData, + ListSourcesResponse, + ListSourcesResponses, + ListSpeakerRecordingsData, + ListSpeakerRecordingsError, + ListSpeakerRecordingsErrors, + ListSpeakerRecordingsResponse, + ListSpeakerRecordingsResponses, + ListSpeakersData, + ListSpeakersError, + ListSpeakersErrors, + ListSpeakersResponse, + ListSpeakersResponses, + ListTagsData, + ListTagsError, + ListTagsErrors, + ListTagsResponse, + ListTagsResponses, + ListTemplatesData, + ListTemplatesResponse, + ListTemplatesResponses, + ListTokensData, + ListTokensResponse, + ListTokensResponses, + ListUploadsData, + ListUploadsResponse, + ListUploadsResponses, + ListUsersData, + ListUsersResponse, + ListUsersResponses, + ListViewsData, + ListViewsResponse, + ListViewsResponses, + ListWatchesData, + ListWatchesResponse, + ListWatchesResponses, + ListWorkersData, + ListWorkersResponse, + ListWorkersResponses, + ListWorkflowsData, + ListWorkflowsResponse, + ListWorkflowsResponses, + LlmEstimate, + LlmTestResult, + LoginData, + LoginError, + LoginErrors, + LoginRequest, + LoginResponse, + LoginResponses, + LogoutData, + LogoutError, + LogoutErrors, + LogoutResponse, + LogoutResponses, + MarkEntitiesNotSameData, + MarkEntitiesNotSameError, + MarkEntitiesNotSameErrors, + MarkEntitiesNotSameResponse, + MarkEntitiesNotSameResponses, + Me, + MeData, + Member, + MemberSet, + Mention, + MentionList, + MentionMove, + MentionMoved, + MeResponse, + MeResponses, + MergeEntitiesData, + MergeEntitiesError, + MergeEntitiesErrors, + MergeEntitiesResponse, + MergeEntitiesResponses, + MergeFaceData, + MergeFaceError, + MergeFaceErrors, + MergeFaceResponse, + MergeFaceResponses, + MergeSegmentsData, + MergeSegmentsError, + MergeSegmentsErrors, + MergeSegmentsResponse, + MergeSegmentsResponses, + MergeSpeakerData, + MergeSpeakerError, + MergeSpeakerErrors, + MergeSpeakerResponse, + MergeSpeakerResponses, + MessageCreate, + MetadataBulk, + MetadataBulkResult, + MetadataEdit, + MeUpdate, + MonthStats, + MoveMentionData, + MoveMentionError, + MoveMentionErrors, + MoveMentionResponse, + MoveMentionResponses, + MoveRecordingData, + MoveRecordingError, + MoveRecordingErrors, + MoveRecordingResponse, + MoveRecordingResponses, + Namespace, + NamespaceAccess, + NamespaceCreate, + NamespaceFaces, + NamespaceMetadata, + NamespaceMetadataUpdate, + NamespaceStats, + NamespaceUpdate, + NodeType, + Note, + NoteCreate, + NoteUpdate, + NotifyDelivery, + NotifySecret, + NotifyTarget, + NotifyTargetCreate, + NotifyTargetCreated, + NotifyTargets, + NotifyTargetUpdate, + NotifyTestResult, + NotSameSpeakerData, + NotSameSpeakerError, + NotSameSpeakerErrors, + NotSameSpeakerResponse, + NotSameSpeakerResponses, + OAuthGrant, + OAuthTokens, + ObjectCount, + ObjectFacet, + ObjectTrack, + OcrFix, + Ok, + OpenRecordingToIpGroupData, + OpenRecordingToIpGroupError, + OpenRecordingToIpGroupErrors, + OpenRecordingToIpGroupResponse, + OpenRecordingToIpGroupResponses, + OriginCount, + Output, + Page, + Passage, + PasswordChange, + Permission, + PermissionAdd, + Pipeline, + PipelineCatalog, + PipelineCreate, + PipelineGraph, + PipelineRunRequest, + PipelineSummary, + PipelineVersionCreate, + PipelineVersionInfo, + Placed, + PlaceRecordingsData, + PlaceRecordingsError, + PlaceRecordingsErrors, + PlaceRecordingsResponse, + PlaceRecordingsResponses, + Player, + PreviewIiifImportData, + PreviewIiifImportError, + PreviewIiifImportErrors, + PreviewIiifImportResponse, + PreviewIiifImportResponses, + PreviewImportData, + PreviewImportError, + PreviewImportErrors, + PreviewImportResponse, + PreviewImportResponses, + PreviewLine, + PreviewScheduleData, + PreviewScheduleError, + PreviewScheduleErrors, + PreviewScheduleResponse, + PreviewScheduleResponses, + PreviewTemplateData, + PreviewTemplateError, + PreviewTemplateErrors, + PreviewTemplateResponse, + PreviewTemplateResponses, + PreviewWatchData, + PreviewWatchError, + PreviewWatchErrors, + PreviewWatchResponse, + PreviewWatchResponses, + PrimaryFile, + PublicCard, + PublicChapter, + PublicCollection, + PublicCollectionSummary, + PublicDownload, + PublicFile, + PublicHit, + PublicHome, + PublicMedia, + PublicPage, + PublicRecording, + PublicRequest, + PublicRequestCreate, + PublicResult, + PublicSearch, + PublicSegment, + PublicSpeaker, + PublicTranscript, + QueueStepData, + QueueStepError, + QueueStepErrors, + QueueStepResponse, + QueueStepResponses, + Recording, + RecordingAccess, + RecordingAccessUpdate, + RecordingContentType, + RecordingContentTypeSet, + RecordingFacet, + RecordingIpGroup, + RecordingMetadata, + RecordingMetadataUpdate, + RecordingMove, + RecordingMoved, + RecordingSpeaker, + RecordingsPlace, + RecordingsRetag, + RecordingSummary, + RecordingUpdate, + RefreshData, + RefreshError, + RefreshErrors, + RefreshRequest, + RefreshResponse, + RefreshResponses, + RegisterData, + RegisterError, + RegisterErrors, + RegisterResponse, + RegisterResponses, + ReindexSearchData, + ReindexSearchResponse, + ReindexSearchResponses, + RemoveRecordingPermissionData, + RemoveRecordingPermissionError, + RemoveRecordingPermissionErrors, + RemoveRecordingPermissionResponse, + RemoveRecordingPermissionResponses, + RenameEntityData, + RenameEntityError, + RenameEntityErrors, + RenameEntityResponse, + RenameEntityResponses, + RenameFaceData, + RenameFaceError, + RenameFaceErrors, + RenameFaceResponse, + RenameFaceResponses, + RenameSpeakerData, + RenameSpeakerError, + RenameSpeakerErrors, + RenameSpeakerResponse, + RenameSpeakerResponses, + Rendition, + ReprocessRecordingData, + ReprocessRecordingError, + ReprocessRecordingErrors, + ReprocessRecordingResponse, + ReprocessRecordingResponses, + ReprocessRequest, + RequestAccessData, + RequestAccessError, + RequestAccessErrors, + RequestAccessResponse, + RequestAccessResponses, + ResetPasswordData, + ResetPasswordError, + ResetPasswordErrors, + ResetPasswordRequest, + ResetPasswordResponse, + ResetPasswordResponses, + ResourceFile, + ResourceFiles, + RetagRecordingsData, + RetagRecordingsError, + RetagRecordingsErrors, + RetagRecordingsResponse, + RetagRecordingsResponses, + RetryJobData, + RetryJobError, + RetryJobErrors, + RetryJobResponse, + RetryJobResponses, + RetypeEntitiesData, + RetypeEntitiesError, + RetypeEntitiesErrors, + RetypeEntitiesResponse, + RetypeEntitiesResponses, + RevertMetadataEditData, + RevertMetadataEditError, + RevertMetadataEditErrors, + RevertMetadataEditResponse, + RevertMetadataEditResponses, + RevokeAnyTokenData, + RevokeAnyTokenError, + RevokeAnyTokenErrors, + RevokeAnyTokenResponse, + RevokeAnyTokenResponses, + RevokeData, + RevokeError, + RevokeErrors, + RevokeGrantData, + RevokeGrantError, + RevokeGrantErrors, + RevokeGrantResponse, + RevokeGrantResponses, + RevokeResponse, + RevokeResponses, + RevokeShareData, + RevokeShareError, + RevokeShareErrors, + RevokeShareResponse, + RevokeShareResponses, + RevokeSharesData, + RevokeSharesError, + RevokeSharesErrors, + RevokeSharesResponse, + RevokeSharesResponses, + RevokeTokenData, + RevokeTokenError, + RevokeTokenErrors, + RevokeTokenResponse, + RevokeTokenResponses, + RotateNotifySecretData, + RotateNotifySecretError, + RotateNotifySecretErrors, + RotateNotifySecretResponse, + RotateNotifySecretResponses, + Routine, + RoutineCatalog, + RoutineCreate, + RoutineRun, + RoutineRunRequest, + RoutineUpdate, + RunPipelineData, + RunPipelineError, + RunPipelineErrors, + RunPipelineResponse, + RunPipelineResponses, + RunRoutineData, + RunRoutineError, + RunRoutineErrors, + RunRoutineResponse, + RunRoutineResponses, + RunWorkflowData, + RunWorkflowError, + RunWorkflowErrors, + RunWorkflowResponse, + RunWorkflowResponses, + SaveCollectionFieldsData, + SaveCollectionFieldsError, + SaveCollectionFieldsErrors, + SaveCollectionFieldsResponse, + SaveCollectionFieldsResponses, + SavedSearch, + SavedView, + SaveFileFieldsData, + SaveFileFieldsError, + SaveFileFieldsErrors, + SaveFileFieldsResponse, + SaveFileFieldsResponses, + SaveLlmData, + SaveLlmError, + SaveLlmErrors, + SaveLlmResponse, + SaveLlmResponses, + SaveNamespaceData, + SaveNamespaceError, + SaveNamespaceErrors, + SaveNamespaceResponse, + SaveNamespaceResponses, + SaveResourceFieldsData, + SaveResourceFieldsError, + SaveResourceFieldsErrors, + SaveResourceFieldsResponse, + SaveResourceFieldsResponses, + SaveStorageData, + SaveStorageError, + SaveStorageErrors, + SaveStorageResponse, + SaveStorageResponses, + SaveTelemetryData, + SaveTelemetryError, + SaveTelemetryErrors, + SaveTelemetryResponse, + SaveTelemetryResponses, + ScanWatchData, + ScanWatchError, + ScanWatchErrors, + ScanWatchResponse, + ScanWatchResponses, + SchedulePreview, + SearchCreate, + SearchFacets, + SearchHit, + SearchPublicData, + SearchPublicError, + SearchPublicErrors, + SearchPublicResponse, + SearchPublicResponses, + SearchResults, + SearchTranscriptsData, + SearchTranscriptsError, + SearchTranscriptsErrors, + SearchTranscriptsResponse, + SearchTranscriptsResponses, + SearchUpdate, + SecretFlag, + SegmentEdit, + SegmentSplit, + SegmentUpdate, + SendChunkData, + SendChunkError, + SendChunkErrors, + SendChunkResponse, + SendChunkResponses, + SendMessageData, + SendMessageError, + SendMessageErrors, + SendMessageResponses, + SetCollectionMemberData, + SetCollectionMemberError, + SetCollectionMemberErrors, + SetCollectionMemberResponse, + SetCollectionMemberResponses, + SetMemberData, + SetMemberError, + SetMemberErrors, + SetMemberResponse, + SetMemberResponses, + SetNamespaceFacesModeData, + SetNamespaceFacesModeError, + SetNamespaceFacesModeErrors, + SetNamespaceFacesModeResponse, + SetNamespaceFacesModeResponses, + SetRecordingContentTypeData, + SetRecordingContentTypeError, + SetRecordingContentTypeErrors, + SetRecordingContentTypeResponse, + SetRecordingContentTypeResponses, + SetupAdmin, + SetupData, + SetupError, + SetupErrors, + SetupFinish, + SetupLlm, + SetupLlmView, + SetupNamespace, + SetupNamespaceView, + SetupRequest, + SetupResponse, + SetupResponses, + SetupSaved, + SetupStorage, + SetupStorageView, + SetupTelemetry, + SetupTelemetryView, + SetupView, + Share, + ShareCreate, + ShareLink, + ShareSite, + Source, + SourceCreate, + SourceCreated, + SourceHealth, + SourceImport, + SourceImportRequest, + SourceImportResult, + SourceUpdate, + SourceUpdated, + Speaker, + SpeakerCandidate, + SpeakerDirectory, + SpeakerFacet, + SpeakerLink, + SpeakerLinkRequest, + SpeakerMerge, + SpeakerMerged, + SpeakerMergeRequest, + SpeakerPair, + SpeakerRecording, + SpeakerRename, + SpeakerStats, + SpeakerSuggestion, + SplitSegmentData, + SplitSegmentError, + SplitSegmentErrors, + SplitSegmentResponse, + SplitSegmentResponses, + Started, + StartUploadData, + StartUploadError, + StartUploadErrors, + StartUploadResponse, + StartUploadResponses, + StatusData, + StatusResponse, + StatusResponses, + StepOutput, + StepQueued, + StepRun, + StopAnswerData, + StopAnswerError, + StopAnswerErrors, + StopAnswerResponse, + StopAnswerResponses, + StopResult, + StreamEventsData, + StreamEventsError, + StreamEventsErrors, + StreamEventsResponses, + SuggestTermsData, + SuggestTermsError, + SuggestTermsErrors, + SuggestTermsResponse, + SuggestTermsResponses, + TagCount, + TagsChanged, + TelemetryExport, + TelemetryStatus, + TelemetryStatusData, + TelemetryStatusResponse, + TelemetryStatusResponses, + TelemetryTestResult, + Template, + TemplateCreate, + TemplatePreview, + TemplatePreviewRequest, + TemplateSummary, + TemplateVersionCreate, + TemplateVersionInfo, + TermSuggestion, + TestLlmData, + TestLlmResponse, + TestLlmResponses, + TestNotifyTargetData, + TestNotifyTargetError, + TestNotifyTargetErrors, + TestNotifyTargetResponse, + TestNotifyTargetResponses, + TestSourceData, + TestSourceError, + TestSourceErrors, + TestSourceResponse, + TestSourceResponses, + TestTelemetryData, + TestTelemetryResponse, + TestTelemetryResponses, + TokenData, + TokenError, + TokenErrors, + TokenLimits, + TokenLimitsData, + TokenLimitsResponse, + TokenLimitsResponses, + TokenPair, + TokenResponse, + TokenResponses, + ToolStep, + UndoEntityMergeData, + UndoEntityMergeError, + UndoEntityMergeErrors, + UndoEntityMergeResponse, + UndoEntityMergeResponses, + UndoFaceMergeData, + UndoFaceMergeError, + UndoFaceMergeErrors, + UndoFaceMergeResponse, + UndoFaceMergeResponses, + UndoGraphChangeData, + UndoGraphChangeError, + UndoGraphChangeErrors, + UndoGraphChangeResponse, + UndoGraphChangeResponses, + Undone, + UndoRunData, + UndoRunError, + UndoRunErrors, + UndoRunResponse, + UndoRunResponses, + UndoSpeakerMergeData, + UndoSpeakerMergeError, + UndoSpeakerMergeErrors, + UndoSpeakerMergeResponse, + UndoSpeakerMergeResponses, + UnlinkEntityData, + UnlinkEntityError, + UnlinkEntityErrors, + UnlinkEntityResponse, + UnlinkEntityResponses, + UnlinkSpeakerData, + UnlinkSpeakerError, + UnlinkSpeakerErrors, + UnlinkSpeakerResponse, + UnlinkSpeakerResponses, + UpdateChatData, + UpdateChatError, + UpdateChatErrors, + UpdateChatResponse, + UpdateChatResponses, + UpdateCollectionData, + UpdateCollectionError, + UpdateCollectionErrors, + UpdateCollectionResponse, + UpdateCollectionResponses, + UpdateCommentData, + UpdateCommentError, + UpdateCommentErrors, + UpdateCommentResponse, + UpdateCommentResponses, + UpdateContentTypeData, + UpdateContentTypeError, + UpdateContentTypeErrors, + UpdateContentTypeResponse, + UpdateContentTypeResponses, + UpdateFieldData, + UpdateFieldError, + UpdateFieldErrors, + UpdateFieldResponse, + UpdateFieldResponses, + UpdateFileData, + UpdateFileError, + UpdateFileErrors, + UpdateFileResponse, + UpdateFileResponses, + UpdateHighlightData, + UpdateHighlightError, + UpdateHighlightErrors, + UpdateHighlightResponse, + UpdateHighlightResponses, + UpdateIpGroupData, + UpdateIpGroupError, + UpdateIpGroupErrors, + UpdateIpGroupResponse, + UpdateIpGroupResponses, + UpdateMeData, + UpdateMeError, + UpdateMeErrors, + UpdateMeResponse, + UpdateMeResponses, + UpdateNamespaceCollectionData, + UpdateNamespaceCollectionError, + UpdateNamespaceCollectionErrors, + UpdateNamespaceCollectionResponse, + UpdateNamespaceCollectionResponses, + UpdateNamespaceData, + UpdateNamespaceError, + UpdateNamespaceErrors, + UpdateNamespaceMetadataData, + UpdateNamespaceMetadataError, + UpdateNamespaceMetadataErrors, + UpdateNamespaceMetadataResponse, + UpdateNamespaceMetadataResponses, + UpdateNamespaceResponse, + UpdateNamespaceResponses, + UpdateNoteData, + UpdateNoteError, + UpdateNoteErrors, + UpdateNoteResponse, + UpdateNoteResponses, + UpdateNotifyTargetData, + UpdateNotifyTargetError, + UpdateNotifyTargetErrors, + UpdateNotifyTargetResponse, + UpdateNotifyTargetResponses, + UpdateRecordingAccessData, + UpdateRecordingAccessError, + UpdateRecordingAccessErrors, + UpdateRecordingAccessResponse, + UpdateRecordingAccessResponses, + UpdateRecordingData, + UpdateRecordingError, + UpdateRecordingErrors, + UpdateRecordingMetadataData, + UpdateRecordingMetadataError, + UpdateRecordingMetadataErrors, + UpdateRecordingMetadataResponse, + UpdateRecordingMetadataResponses, + UpdateRecordingResponse, + UpdateRecordingResponses, + UpdateRoutineData, + UpdateRoutineError, + UpdateRoutineErrors, + UpdateRoutineResponse, + UpdateRoutineResponses, + UpdateSearchData, + UpdateSearchError, + UpdateSearchErrors, + UpdateSearchResponse, + UpdateSearchResponses, + UpdateSettingsData, + UpdateSettingsError, + UpdateSettingsErrors, + UpdateSettingsResponse, + UpdateSettingsResponses, + UpdateSourceData, + UpdateSourceError, + UpdateSourceErrors, + UpdateSourceResponse, + UpdateSourceResponses, + UpdateUserData, + UpdateUserError, + UpdateUserErrors, + UpdateUserResponse, + UpdateUserResponses, + UpdateViewData, + UpdateViewError, + UpdateViewErrors, + UpdateViewResponse, + UpdateViewResponses, + UpdateWatchData, + UpdateWatchError, + UpdateWatchErrors, + UpdateWatchResponse, + UpdateWatchResponses, + UpdateWorkflowData, + UpdateWorkflowError, + UpdateWorkflowErrors, + UpdateWorkflowResponse, + UpdateWorkflowResponses, + Upload, + UploadLimits, + UploadLimitsData, + UploadLimitsResponse, + UploadLimitsResponses, + UploadStart, + UserCreate, + UserPublic, + UserUpdate, + UserWithRoles, + ValidationError, + VersionSaved, + ViewCreate, + ViewerLink, + ViewState, + ViewUpdate, + Watch, + WatchCreate, + WatchPreview, + WatchPreviewRequest, + WatchUpdate, + WebImportRequest, + WebPage, + WorkerInfo, + Workflow, + WorkflowCatalog, + WorkflowCreate, + WorkflowGraph, + WorkflowRunRequest, + WorkflowSummary, + WorkflowUpdate, + WorkflowVersionCreate, + WorkflowVersionInfo, +} from "./types.gen"; diff --git a/nextjs-frontend/app/openapi-client/sdk.gen.ts b/nextjs-frontend/app/openapi-client/sdk.gen.ts index 22b0c44e3..f8d7940e7 100644 --- a/nextjs-frontend/app/openapi-client/sdk.gen.ts +++ b/nextjs-frontend/app/openapi-client/sdk.gen.ts @@ -1,863 +1,872 @@ // This file is auto-generated by @hey-api/openapi-ts -import { type Options as ClientOptions, type Client, type TDataShape, urlSearchParamsBodySerializer } from "./client"; +import { + type Client, + type ClientMeta, + type Options as Options2, + type RequestResult, + type ServerSentEventsResult, + type TDataShape, + urlSearchParamsBodySerializer, +} from "./client"; +import { client } from "./client.gen"; import type { - StatusData, - StatusResponses, - SetupData, - SetupResponses, - SetupErrors, - LoginData, - LoginResponses, - LoginErrors, - RefreshData, - RefreshResponses, - RefreshErrors, - LogoutData, - LogoutResponses, - LogoutErrors, - MeData, - MeResponses, - UpdateMeData, - UpdateMeResponses, - UpdateMeErrors, + AcceptGraphChangeData, + AcceptGraphChangeErrors, + AcceptGraphChangeResponses, + AddFileData, + AddFileErrors, + AddFileResponses, + AddRecordingPermissionData, + AddRecordingPermissionErrors, + AddRecordingPermissionResponses, + AnswerData, + AnswerErrors, + AnswerResponses, + ApproveAccessRequestData, + ApproveAccessRequestErrors, + ApproveAccessRequestResponses, + BrowseSourceData, + BrowseSourceErrors, + BrowseSourceResponses, + BulkUpdateMetadataData, + BulkUpdateMetadataErrors, + BulkUpdateMetadataResponses, + CancelJobData, + CancelJobErrors, + CancelJobResponses, + CancelUploadData, + CancelUploadErrors, + CancelUploadResponses, ChangePasswordData, - ChangePasswordResponses, ChangePasswordErrors, - ForgotPasswordData, - ForgotPasswordResponses, - ForgotPasswordErrors, - ResetPasswordData, - ResetPasswordResponses, - ResetPasswordErrors, - ListTokensData, - ListTokensResponses, - CreateTokenData, - CreateTokenResponses, - CreateTokenErrors, - TokenLimitsData, - TokenLimitsResponses, - RevokeTokenData, - RevokeTokenResponses, - RevokeTokenErrors, - RegisterData, - RegisterResponses, - RegisterErrors, + ChangePasswordResponses, + ChatCapabilitiesData, + ChatCapabilitiesResponses, + CheckMessageData, + CheckMessageErrors, + CheckMessageResponses, + CloseRecordingToIpGroupData, + CloseRecordingToIpGroupErrors, + CloseRecordingToIpGroupResponses, + CombineBatchData, + CombineBatchErrors, + CombineBatchResponses, ConsentData, - ConsentResponses, ConsentErrors, - AnswerData, - AnswerResponses, - AnswerErrors, - TokenData, - TokenResponses, - TokenErrors, - RevokeData, - RevokeResponses, - RevokeErrors, - ListGrantsData, - ListGrantsResponses, - RevokeGrantData, - RevokeGrantResponses, - RevokeGrantErrors, - ListUsersData, - ListUsersResponses, - CreateUserData, - CreateUserResponses, - CreateUserErrors, - UpdateUserData, - UpdateUserResponses, - UpdateUserErrors, - ListMembersData, - ListMembersResponses, - ListMembersErrors, - SetMemberData, - SetMemberResponses, - SetMemberErrors, - GetSettingsData, - GetSettingsResponses, - UpdateSettingsData, - UpdateSettingsResponses, - UpdateSettingsErrors, - TestLlmData, - TestLlmResponses, - TelemetryStatusData, - TelemetryStatusResponses, - TestTelemetryData, - TestTelemetryResponses, - ListAuditData, - ListAuditResponses, - ListAuditErrors, - ListAllTokensData, - ListAllTokensResponses, - RevokeAnyTokenData, - RevokeAnyTokenResponses, - RevokeAnyTokenErrors, - GetHealthData, - GetHealthResponses, - ReindexSearchData, - ReindexSearchResponses, - GetSetupData, - GetSetupResponses, - SaveNamespaceData, - SaveNamespaceResponses, - SaveNamespaceErrors, - SaveLlmData, - SaveLlmResponses, - SaveLlmErrors, - SaveStorageData, - SaveStorageResponses, - SaveStorageErrors, - SaveTelemetryData, - SaveTelemetryResponses, - SaveTelemetryErrors, - FinishData, - FinishResponses, - FinishErrors, - ListNamespacesData, - ListNamespacesResponses, - CreateNamespaceData, - CreateNamespaceResponses, - CreateNamespaceErrors, - UpdateNamespaceData, - UpdateNamespaceResponses, - UpdateNamespaceErrors, - GetNamespaceWordcloudData, - GetNamespaceWordcloudResponses, - GetNamespaceWordcloudErrors, - GetNamespaceStatsData, - GetNamespaceStatsResponses, - GetNamespaceStatsErrors, - ListIpGroupsData, - ListIpGroupsResponses, - ListIpGroupsErrors, + ConsentResponses, + ControlBatchData, + ControlBatchErrors, + ControlBatchResponses, + ControlWorkerData, + ControlWorkerErrors, + ControlWorkerResponses, + CreateBatchData, + CreateBatchErrors, + CreateBatchResponses, + CreateChatData, + CreateChatErrors, + CreateChatResponses, + CreateCollectionData, + CreateCollectionErrors, + CreateCollectionResponses, + CreateCommentData, + CreateCommentErrors, + CreateCommentResponses, + CreateContentTypeData, + CreateContentTypeErrors, + CreateContentTypeResponses, + CreateFieldData, + CreateFieldErrors, + CreateFieldResponses, + CreateHighlightData, + CreateHighlightErrors, + CreateHighlightResponses, CreateIpGroupData, - CreateIpGroupResponses, CreateIpGroupErrors, - DeleteIpGroupData, - DeleteIpGroupResponses, - DeleteIpGroupErrors, - UpdateIpGroupData, - UpdateIpGroupResponses, - UpdateIpGroupErrors, - ListNamespaceCollectionsData, - ListNamespaceCollectionsResponses, - ListNamespaceCollectionsErrors, + CreateIpGroupResponses, + CreateJobsData, + CreateJobsErrors, + CreateJobsResponses, CreateNamespaceCollectionData, - CreateNamespaceCollectionResponses, CreateNamespaceCollectionErrors, - DeleteNamespaceCollectionData, - DeleteNamespaceCollectionResponses, - DeleteNamespaceCollectionErrors, - GetNamespaceCollectionData, - GetNamespaceCollectionResponses, - GetNamespaceCollectionErrors, - UpdateNamespaceCollectionData, - UpdateNamespaceCollectionResponses, - UpdateNamespaceCollectionErrors, - ListCollectionMembersData, - ListCollectionMembersResponses, - ListCollectionMembersErrors, - SetCollectionMemberData, - SetCollectionMemberResponses, - SetCollectionMemberErrors, - ListRecordingsData, - ListRecordingsResponses, - ListRecordingsErrors, - ListTagsData, - ListTagsResponses, - ListTagsErrors, - RetagRecordingsData, - RetagRecordingsResponses, - RetagRecordingsErrors, - ListOriginsData, - ListOriginsResponses, - ListOriginsErrors, - ListLanguagesData, - ListLanguagesResponses, - ListLanguagesErrors, - ListObjectsData, - ListObjectsResponses, - ListObjectsErrors, - PlaceRecordingsData, - PlaceRecordingsResponses, - PlaceRecordingsErrors, - DeleteRecordingData, - DeleteRecordingResponses, - DeleteRecordingErrors, - GetRecordingData, - GetRecordingResponses, - GetRecordingErrors, - UpdateRecordingData, - UpdateRecordingResponses, - UpdateRecordingErrors, - MoveRecordingData, - MoveRecordingResponses, - MoveRecordingErrors, - GetRecordingAccessData, - GetRecordingAccessResponses, - GetRecordingAccessErrors, - UpdateRecordingAccessData, - UpdateRecordingAccessResponses, - UpdateRecordingAccessErrors, - ListRecordingPermissionsData, - ListRecordingPermissionsResponses, - ListRecordingPermissionsErrors, - AddRecordingPermissionData, - AddRecordingPermissionResponses, - AddRecordingPermissionErrors, - RemoveRecordingPermissionData, - RemoveRecordingPermissionResponses, - RemoveRecordingPermissionErrors, - ListRecordingIpGroupsData, - ListRecordingIpGroupsResponses, - ListRecordingIpGroupsErrors, - CloseRecordingToIpGroupData, - CloseRecordingToIpGroupResponses, - CloseRecordingToIpGroupErrors, - OpenRecordingToIpGroupData, - OpenRecordingToIpGroupResponses, - OpenRecordingToIpGroupErrors, - ListAccessRequestsData, - ListAccessRequestsResponses, - ListAccessRequestsErrors, - ApproveAccessRequestData, - ApproveAccessRequestResponses, - ApproveAccessRequestErrors, - DeclineAccessRequestData, - DeclineAccessRequestResponses, - DeclineAccessRequestErrors, - GetPlayerData, - GetPlayerResponses, - GetPlayerErrors, - GetEmbedLinkData, - GetEmbedLinkResponses, - GetEmbedLinkErrors, - GetAudioData, - GetAudioResponses, - GetAudioErrors, - GetRecordingWordcloudData, - GetRecordingWordcloudResponses, - GetRecordingWordcloudErrors, - ReprocessRecordingData, - ReprocessRecordingResponses, - ReprocessRecordingErrors, - RevokeSharesData, - RevokeSharesResponses, - RevokeSharesErrors, - CreateShareData, - CreateShareResponses, - CreateShareErrors, - RevokeShareData, - RevokeShareResponses, - RevokeShareErrors, - ListSharesData, - ListSharesResponses, - ListSharesErrors, - ExportRecordingData, - ExportRecordingResponses, - ExportRecordingErrors, - EditSegmentData, - EditSegmentResponses, - EditSegmentErrors, - SplitSegmentData, - SplitSegmentResponses, - SplitSegmentErrors, - MergeSegmentsData, - MergeSegmentsResponses, - MergeSegmentsErrors, - ListSegmentEditsData, - ListSegmentEditsResponses, - ListSegmentEditsErrors, - ListOutputsData, - ListOutputsResponses, - ListOutputsErrors, - ListNotesData, - ListNotesResponses, - ListNotesErrors, + CreateNamespaceCollectionResponses, + CreateNamespaceData, + CreateNamespaceErrors, + CreateNamespaceResponses, CreateNoteData, - CreateNoteResponses, CreateNoteErrors, - DeleteNoteData, - DeleteNoteResponses, - DeleteNoteErrors, - UpdateNoteData, - UpdateNoteResponses, - UpdateNoteErrors, - ListCommentsData, - ListCommentsResponses, - ListCommentsErrors, - CreateCommentData, - CreateCommentResponses, - CreateCommentErrors, + CreateNoteResponses, + CreateNotifyTargetData, + CreateNotifyTargetErrors, + CreateNotifyTargetResponses, + CreatePipelineData, + CreatePipelineErrors, + CreatePipelineResponses, + CreatePipelineVersionData, + CreatePipelineVersionErrors, + CreatePipelineVersionResponses, + CreateRoutineData, + CreateRoutineErrors, + CreateRoutineResponses, + CreateSearchData, + CreateSearchErrors, + CreateSearchResponses, + CreateShareData, + CreateShareErrors, + CreateShareResponses, + CreateSourceData, + CreateSourceErrors, + CreateSourceResponses, + CreateTemplateData, + CreateTemplateErrors, + CreateTemplateResponses, + CreateTemplateVersionData, + CreateTemplateVersionErrors, + CreateTemplateVersionResponses, + CreateTokenData, + CreateTokenErrors, + CreateTokenResponses, + CreateUserData, + CreateUserErrors, + CreateUserResponses, + CreateViewData, + CreateViewErrors, + CreateViewResponses, + CreateWatchData, + CreateWatchErrors, + CreateWatchResponses, + CreateWorkflowData, + CreateWorkflowErrors, + CreateWorkflowResponses, + CreateWorkflowVersionData, + CreateWorkflowVersionErrors, + CreateWorkflowVersionResponses, + DecideApprovalData, + DecideApprovalErrors, + DecideApprovalResponses, + DeclineAccessRequestData, + DeclineAccessRequestErrors, + DeclineAccessRequestResponses, + DeleteChatData, + DeleteChatErrors, + DeleteChatResponses, + DeleteCollectionData, + DeleteCollectionErrors, + DeleteCollectionResponses, DeleteCommentData, - DeleteCommentResponses, DeleteCommentErrors, - UpdateCommentData, - UpdateCommentResponses, - UpdateCommentErrors, - ListHighlightsData, - ListHighlightsResponses, - ListHighlightsErrors, - CreateHighlightData, - CreateHighlightResponses, - CreateHighlightErrors, - DeleteHighlightData, - DeleteHighlightResponses, - DeleteHighlightErrors, - UpdateHighlightData, - UpdateHighlightResponses, - UpdateHighlightErrors, - ListFilesData, - ListFilesResponses, - ListFilesErrors, - AddFileData, - AddFileResponses, - AddFileErrors, + DeleteCommentResponses, + DeleteContentTypeData, + DeleteContentTypeErrors, + DeleteContentTypeResponses, + DeleteFaceData, + DeleteFaceErrors, + DeleteFaceResponses, + DeleteFaceTrackData, + DeleteFaceTrackErrors, + DeleteFaceTrackResponses, + DeleteFieldData, + DeleteFieldErrors, + DeleteFieldResponses, DeleteFileData, - DeleteFileResponses, DeleteFileErrors, - UpdateFileData, - UpdateFileResponses, - UpdateFileErrors, + DeleteFileResponses, + DeleteHighlightData, + DeleteHighlightErrors, + DeleteHighlightResponses, + DeleteIpGroupData, + DeleteIpGroupErrors, + DeleteIpGroupResponses, + DeleteNamespaceCollectionData, + DeleteNamespaceCollectionErrors, + DeleteNamespaceCollectionResponses, + DeleteNamespaceFacesData, + DeleteNamespaceFacesErrors, + DeleteNamespaceFacesResponses, + DeleteNoteData, + DeleteNoteErrors, + DeleteNoteResponses, + DeleteNotifyTargetData, + DeleteNotifyTargetErrors, + DeleteNotifyTargetResponses, + DeleteRecordingData, + DeleteRecordingErrors, + DeleteRecordingResponses, + DeleteRoutineData, + DeleteRoutineErrors, + DeleteRoutineResponses, + DeleteSearchData, + DeleteSearchErrors, + DeleteSearchResponses, + DeleteSourceData, + DeleteSourceErrors, + DeleteSourceResponses, + DeleteViewData, + DeleteViewErrors, + DeleteViewResponses, + DeleteWatchData, + DeleteWatchErrors, + DeleteWatchResponses, + DiffTemplateVersionsData, + DiffTemplateVersionsErrors, + DiffTemplateVersionsResponses, + DismissFaceSuggestionData, + DismissFaceSuggestionErrors, + DismissFaceSuggestionResponses, + DismissGraphChangeData, + DismissGraphChangeErrors, + DismissGraphChangeResponses, DownloadFileData, - DownloadFileResponses, DownloadFileErrors, - ListFileLinesData, - ListFileLinesResponses, - ListFileLinesErrors, - ListFieldsData, - ListFieldsResponses, - ListFieldsErrors, - CreateFieldData, - CreateFieldResponses, - CreateFieldErrors, - DeleteFieldData, - DeleteFieldResponses, - DeleteFieldErrors, - GetFieldData, - GetFieldResponses, - GetFieldErrors, - UpdateFieldData, - UpdateFieldResponses, - UpdateFieldErrors, - GetResourceFieldsData, - GetResourceFieldsResponses, - GetResourceFieldsErrors, - SaveResourceFieldsData, - SaveResourceFieldsResponses, - SaveResourceFieldsErrors, + DownloadFileResponses, + EditSegmentData, + EditSegmentErrors, + EditSegmentResponses, + EstimateBatchData, + EstimateBatchErrors, + EstimateBatchResponses, + ExploreGraphData, + ExploreGraphErrors, + ExploreGraphResponses, + ExportBatchResultsData, + ExportBatchResultsErrors, + ExportBatchResultsResponses, + ExportRecordingData, + ExportRecordingErrors, + ExportRecordingResponses, + FindGraphPathData, + FindGraphPathErrors, + FindGraphPathResponses, + FinishData, + FinishErrors, + FinishResponses, + FixScreenTextData, + FixScreenTextErrors, + FixScreenTextResponses, + ForgotPasswordData, + ForgotPasswordErrors, + ForgotPasswordResponses, + GetAudioData, + GetAudioErrors, + GetAudioResponses, + GetBatchData, + GetBatchErrors, + GetBatchResponses, + GetBatchResultsData, + GetBatchResultsErrors, + GetBatchResultsResponses, + GetChatData, + GetChatErrors, + GetChatResponses, + GetCollectionData, + GetCollectionErrors, GetCollectionFieldsData, - GetCollectionFieldsResponses, GetCollectionFieldsErrors, - SaveCollectionFieldsData, - SaveCollectionFieldsResponses, - SaveCollectionFieldsErrors, + GetCollectionFieldsResponses, + GetCollectionResponses, + GetContentStateData, + GetContentStateErrors, + GetContentStateResponses, + GetEmbedLinkData, + GetEmbedLinkErrors, + GetEmbedLinkResponses, + GetEntityConnectionsData, + GetEntityConnectionsErrors, + GetEntityConnectionsResponses, + GetEntityData, + GetEntityErrors, + GetEntityResponses, + GetEntityTimelineData, + GetEntityTimelineErrors, + GetEntityTimelineResponses, + GetFieldData, + GetFieldErrors, + GetFieldResponses, GetFileFieldsData, - GetFileFieldsResponses, GetFileFieldsErrors, - SaveFileFieldsData, - SaveFileFieldsResponses, - SaveFileFieldsErrors, + GetFileFieldsResponses, + GetFrameData, + GetFrameErrors, + GetFrameResponses, + GetGraphData, + GetGraphErrors, + GetGraphResponses, + GetHealthData, + GetHealthResponses, + GetJobData, + GetJobErrors, + GetJobLogData, + GetJobLogErrors, + GetJobLogResponses, + GetJobResponses, + GetMediaData, + GetMediaErrors, + GetMediaResponses, + GetNamespaceCollectionData, + GetNamespaceCollectionErrors, + GetNamespaceCollectionResponses, + GetNamespaceFacesData, + GetNamespaceFacesErrors, + GetNamespaceFacesResponses, + GetNamespaceMetadataData, + GetNamespaceMetadataErrors, + GetNamespaceMetadataResponses, + GetNamespaceStatsData, + GetNamespaceStatsErrors, + GetNamespaceStatsResponses, + GetNamespaceWordcloudData, + GetNamespaceWordcloudErrors, + GetNamespaceWordcloudResponses, + GetPdfData, + GetPdfErrors, + GetPdfResponses, + GetPipelineData, + GetPipelineErrors, + GetPipelineResponses, + GetPlayerData, + GetPlayerErrors, + GetPlayerResponses, + GetPublicCollectionData, + GetPublicCollectionErrors, + GetPublicCollectionResponses, + GetPublicHomeData, + GetPublicHomeResponses, + GetPublicRecordingData, + GetPublicRecordingErrors, + GetPublicRecordingResponses, + GetRecordingAccessData, + GetRecordingAccessErrors, + GetRecordingAccessResponses, + GetRecordingContentTypeData, + GetRecordingContentTypeErrors, + GetRecordingContentTypeResponses, + GetRecordingData, + GetRecordingErrors, + GetRecordingIiifData, + GetRecordingIiifErrors, + GetRecordingIiifResponses, + GetRecordingMetadataData, + GetRecordingMetadataErrors, + GetRecordingMetadataResponses, + GetRecordingResponses, + GetRecordingWordcloudData, + GetRecordingWordcloudErrors, + GetRecordingWordcloudResponses, + GetResourceFieldsData, + GetResourceFieldsErrors, + GetResourceFieldsResponses, + GetRoutineData, + GetRoutineErrors, + GetRoutineResponses, + GetRunData, + GetRunErrors, + GetRunResponses, + GetSettingsData, + GetSettingsResponses, + GetSetupData, + GetSetupResponses, + GetTemplateData, + GetTemplateErrors, + GetTemplateResponses, + GetUploadData, + GetUploadErrors, + GetUploadResponses, + GetWorkflowData, + GetWorkflowErrors, + GetWorkflowResponses, + HideEntityData, + HideEntityErrors, + HideEntityResponses, + ImportFromSourceData, + ImportFromSourceErrors, + ImportFromSourceResponses, + ImportIiifData, + ImportIiifErrors, + ImportIiifResponses, ImportTranscriptData, - ImportTranscriptResponses, ImportTranscriptErrors, + ImportTranscriptResponses, ImportWebPageData, - ImportWebPageResponses, ImportWebPageErrors, - PreviewImportData, - PreviewImportResponses, - PreviewImportErrors, - ImportFromSourceData, - ImportFromSourceResponses, - ImportFromSourceErrors, - UploadLimitsData, - UploadLimitsResponses, - ListUploadsData, - ListUploadsResponses, - StartUploadData, - StartUploadResponses, - StartUploadErrors, - CancelUploadData, - CancelUploadResponses, - CancelUploadErrors, - GetUploadData, - GetUploadResponses, - GetUploadErrors, - SendChunkData, - SendChunkResponses, - SendChunkErrors, - SearchTranscriptsData, - SearchTranscriptsResponses, - SearchTranscriptsErrors, - SuggestTermsData, - SuggestTermsResponses, - SuggestTermsErrors, - GetGraphData, - GetGraphResponses, - GetGraphErrors, + ImportWebPageResponses, + LinkEntityData, + LinkEntityErrors, + LinkEntityResponses, + LinkFaceSpeakerData, + LinkFaceSpeakerErrors, + LinkFaceSpeakerResponses, + LinkSpeakerData, + LinkSpeakerErrors, + LinkSpeakerResponses, + ListAccessRequestsData, + ListAccessRequestsErrors, + ListAccessRequestsResponses, + ListAllTokensData, + ListAllTokensResponses, + ListApprovalsData, + ListApprovalsErrors, + ListApprovalsResponses, + ListAuditData, + ListAuditErrors, + ListAuditResponses, + ListBackendsData, + ListBackendsResponses, + ListBatchesData, + ListBatchesResponses, + ListChatsData, + ListChatsResponses, + ListCollectionMembersData, + ListCollectionMembersErrors, + ListCollectionMembersResponses, + ListCollectionsData, + ListCollectionsResponses, + ListCommentsData, + ListCommentsErrors, + ListCommentsResponses, + ListContentTypesData, + ListContentTypesResponses, + ListEntitiesData, + ListEntitiesErrors, + ListEntitiesResponses, + ListEntityMentionsData, + ListEntityMentionsErrors, + ListEntityMentionsResponses, + ListEntityMergesData, + ListEntityMergesResponses, + ListEntitySuggestionsData, + ListEntitySuggestionsErrors, + ListEntitySuggestionsResponses, + ListEntityTypesData, + ListEntityTypesResponses, + ListFieldsData, + ListFieldsErrors, + ListFieldsResponses, + ListFileLinesData, + ListFileLinesErrors, + ListFileLinesResponses, + ListFilesData, + ListFilesErrors, + ListFilesResponses, + ListGrantsData, + ListGrantsResponses, + ListGraphChangesData, + ListGraphChangesErrors, + ListGraphChangesResponses, + ListHighlightsData, + ListHighlightsErrors, + ListHighlightsResponses, + ListIpGroupsData, + ListIpGroupsErrors, + ListIpGroupsResponses, + ListJobsData, + ListJobsErrors, + ListJobsResponses, + ListLanguagesData, + ListLanguagesErrors, + ListLanguagesResponses, + ListMembersData, + ListMembersErrors, + ListMembersResponses, ListMentionsData, - ListMentionsResponses, ListMentionsErrors, + ListMentionsResponses, + ListNamespaceCollectionsData, + ListNamespaceCollectionsErrors, + ListNamespaceCollectionsResponses, + ListNamespacesData, + ListNamespacesResponses, + ListNotesData, + ListNotesErrors, + ListNotesResponses, + ListNotifyDeliveriesData, + ListNotifyDeliveriesErrors, + ListNotifyDeliveriesResponses, + ListNotifyTargetsData, + ListNotifyTargetsErrors, + ListNotifyTargetsResponses, + ListObjectsData, + ListObjectsErrors, + ListObjectsResponses, + ListOriginsData, + ListOriginsErrors, + ListOriginsResponses, + ListOutputsData, + ListOutputsErrors, + ListOutputsResponses, + ListPendingAccessRequestsData, + ListPendingAccessRequestsResponses, + ListPipelinesData, + ListPipelinesResponses, + ListRecordingIpGroupsData, + ListRecordingIpGroupsErrors, + ListRecordingIpGroupsResponses, + ListRecordingMetadataHistoryData, + ListRecordingMetadataHistoryErrors, + ListRecordingMetadataHistoryResponses, + ListRecordingPermissionsData, + ListRecordingPermissionsErrors, + ListRecordingPermissionsResponses, + ListRecordingsData, + ListRecordingsErrors, + ListRecordingsResponses, + ListRoutinesData, + ListRoutinesResponses, + ListRunsData, + ListRunsErrors, + ListRunsResponses, ListSearchesData, ListSearchesResponses, - CreateSearchData, - CreateSearchResponses, - CreateSearchErrors, - DeleteSearchData, - DeleteSearchResponses, - DeleteSearchErrors, - UpdateSearchData, - UpdateSearchResponses, - UpdateSearchErrors, - ListSpeakersData, - ListSpeakersResponses, - ListSpeakersErrors, + ListSegmentEditsData, + ListSegmentEditsErrors, + ListSegmentEditsResponses, + ListSharesData, + ListSharesErrors, + ListSharesResponses, + ListSourcesData, + ListSourcesResponses, ListSpeakerRecordingsData, - ListSpeakerRecordingsResponses, ListSpeakerRecordingsErrors, - RenameSpeakerData, - RenameSpeakerResponses, - RenameSpeakerErrors, - MergeSpeakerData, - MergeSpeakerResponses, - MergeSpeakerErrors, - UndoSpeakerMergeData, - UndoSpeakerMergeResponses, - UndoSpeakerMergeErrors, - LinkSpeakerData, - LinkSpeakerResponses, - LinkSpeakerErrors, - UnlinkSpeakerData, - UnlinkSpeakerResponses, - UnlinkSpeakerErrors, - NotSameSpeakerData, - NotSameSpeakerResponses, - NotSameSpeakerErrors, - ListEntitiesData, - ListEntitiesResponses, - ListEntitiesErrors, - ListEntityTypesData, - ListEntityTypesResponses, - ListEntitySuggestionsData, - ListEntitySuggestionsResponses, - ListEntitySuggestionsErrors, - ListEntityMergesData, - ListEntityMergesResponses, - GetEntityTimelineData, - GetEntityTimelineResponses, - GetEntityTimelineErrors, - RetypeEntitiesData, - RetypeEntitiesResponses, - RetypeEntitiesErrors, - MergeEntitiesData, - MergeEntitiesResponses, - MergeEntitiesErrors, - UndoEntityMergeData, - UndoEntityMergeResponses, - UndoEntityMergeErrors, + ListSpeakerRecordingsResponses, + ListSpeakersData, + ListSpeakersErrors, + ListSpeakersResponses, + ListTagsData, + ListTagsErrors, + ListTagsResponses, + ListTemplatesData, + ListTemplatesResponses, + ListTokensData, + ListTokensResponses, + ListUploadsData, + ListUploadsResponses, + ListUsersData, + ListUsersResponses, + ListViewsData, + ListViewsResponses, + ListWatchesData, + ListWatchesResponses, + ListWorkersData, + ListWorkersResponses, + ListWorkflowsData, + ListWorkflowsResponses, + LoginData, + LoginErrors, + LoginResponses, + LogoutData, + LogoutErrors, + LogoutResponses, MarkEntitiesNotSameData, - MarkEntitiesNotSameResponses, MarkEntitiesNotSameErrors, - GetEntityData, - GetEntityResponses, - GetEntityErrors, - ListEntityMentionsData, - ListEntityMentionsResponses, - ListEntityMentionsErrors, - GetEntityConnectionsData, - GetEntityConnectionsResponses, - GetEntityConnectionsErrors, - RenameEntityData, - RenameEntityResponses, - RenameEntityErrors, - HideEntityData, - HideEntityResponses, - HideEntityErrors, - LinkEntityData, - LinkEntityResponses, - LinkEntityErrors, - UnlinkEntityData, - UnlinkEntityResponses, - UnlinkEntityErrors, - MoveMentionData, - MoveMentionResponses, - MoveMentionErrors, - ExploreGraphData, - ExploreGraphResponses, - ExploreGraphErrors, - FindGraphPathData, - FindGraphPathResponses, - FindGraphPathErrors, - GetRecordingMetadataData, - GetRecordingMetadataResponses, - GetRecordingMetadataErrors, - UpdateRecordingMetadataData, - UpdateRecordingMetadataResponses, - UpdateRecordingMetadataErrors, - ListRecordingMetadataHistoryData, - ListRecordingMetadataHistoryResponses, - ListRecordingMetadataHistoryErrors, - RevertMetadataEditData, - RevertMetadataEditResponses, - RevertMetadataEditErrors, - GetNamespaceMetadataData, - GetNamespaceMetadataResponses, - GetNamespaceMetadataErrors, - UpdateNamespaceMetadataData, - UpdateNamespaceMetadataResponses, - UpdateNamespaceMetadataErrors, - BulkUpdateMetadataData, - BulkUpdateMetadataResponses, - BulkUpdateMetadataErrors, - GetMediaData, - GetMediaResponses, - GetMediaErrors, - GetPdfData, - GetPdfResponses, - GetPdfErrors, - GetFrameData, - GetFrameResponses, - GetFrameErrors, - FixScreenTextData, - FixScreenTextResponses, - FixScreenTextErrors, - DeleteFaceTrackData, - DeleteFaceTrackResponses, - DeleteFaceTrackErrors, - DeleteNamespaceFacesData, - DeleteNamespaceFacesResponses, - DeleteNamespaceFacesErrors, - GetNamespaceFacesData, - GetNamespaceFacesResponses, - GetNamespaceFacesErrors, - SetNamespaceFacesModeData, - SetNamespaceFacesModeResponses, - SetNamespaceFacesModeErrors, - UndoFaceMergeData, - UndoFaceMergeResponses, - UndoFaceMergeErrors, - DeleteFaceData, - DeleteFaceResponses, - DeleteFaceErrors, - RenameFaceData, - RenameFaceResponses, - RenameFaceErrors, + MarkEntitiesNotSameResponses, + MeData, + MeResponses, + MergeEntitiesData, + MergeEntitiesErrors, + MergeEntitiesResponses, MergeFaceData, - MergeFaceResponses, MergeFaceErrors, - LinkFaceSpeakerData, - LinkFaceSpeakerResponses, - LinkFaceSpeakerErrors, - DismissFaceSuggestionData, - DismissFaceSuggestionResponses, - DismissFaceSuggestionErrors, - GetRecordingIiifData, - GetRecordingIiifResponses, - GetRecordingIiifErrors, - GetContentStateData, - GetContentStateResponses, - GetContentStateErrors, + MergeFaceResponses, + MergeSegmentsData, + MergeSegmentsErrors, + MergeSegmentsResponses, + MergeSpeakerData, + MergeSpeakerErrors, + MergeSpeakerResponses, + MoveMentionData, + MoveMentionErrors, + MoveMentionResponses, + MoveRecordingData, + MoveRecordingErrors, + MoveRecordingResponses, + NotSameSpeakerData, + NotSameSpeakerErrors, + NotSameSpeakerResponses, + OpenRecordingToIpGroupData, + OpenRecordingToIpGroupErrors, + OpenRecordingToIpGroupResponses, + PlaceRecordingsData, + PlaceRecordingsErrors, + PlaceRecordingsResponses, PreviewIiifImportData, - PreviewIiifImportResponses, PreviewIiifImportErrors, - ImportIiifData, - ImportIiifResponses, - ImportIiifErrors, - ListJobsData, - ListJobsResponses, - ListJobsErrors, - CreateJobsData, - CreateJobsResponses, - CreateJobsErrors, - GetJobData, - GetJobResponses, - GetJobErrors, - GetJobLogData, - GetJobLogResponses, - GetJobLogErrors, + PreviewIiifImportResponses, + PreviewImportData, + PreviewImportErrors, + PreviewImportResponses, + PreviewScheduleData, + PreviewScheduleErrors, + PreviewScheduleResponses, + PreviewTemplateData, + PreviewTemplateErrors, + PreviewTemplateResponses, + PreviewWatchData, + PreviewWatchErrors, + PreviewWatchResponses, QueueStepData, - QueueStepResponses, QueueStepErrors, - CancelJobData, - CancelJobResponses, - CancelJobErrors, + QueueStepResponses, + RefreshData, + RefreshErrors, + RefreshResponses, + RegisterData, + RegisterErrors, + RegisterResponses, + ReindexSearchData, + ReindexSearchResponses, + RemoveRecordingPermissionData, + RemoveRecordingPermissionErrors, + RemoveRecordingPermissionResponses, + RenameEntityData, + RenameEntityErrors, + RenameEntityResponses, + RenameFaceData, + RenameFaceErrors, + RenameFaceResponses, + RenameSpeakerData, + RenameSpeakerErrors, + RenameSpeakerResponses, + ReprocessRecordingData, + ReprocessRecordingErrors, + ReprocessRecordingResponses, + RequestAccessData, + RequestAccessErrors, + RequestAccessResponses, + ResetPasswordData, + ResetPasswordErrors, + ResetPasswordResponses, + RetagRecordingsData, + RetagRecordingsErrors, + RetagRecordingsResponses, RetryJobData, - RetryJobResponses, RetryJobErrors, - ListWorkersData, - ListWorkersResponses, - ControlWorkerData, - ControlWorkerResponses, - ControlWorkerErrors, - StreamEventsData, - StreamEventsResponses, - StreamEventsErrors, - ListBackendsData, - ListBackendsResponses, - ListSourcesData, - ListSourcesResponses, - CreateSourceData, - CreateSourceResponses, - CreateSourceErrors, - DeleteSourceData, - DeleteSourceResponses, - DeleteSourceErrors, - UpdateSourceData, - UpdateSourceResponses, - UpdateSourceErrors, - TestSourceData, - TestSourceResponses, - TestSourceErrors, - BrowseSourceData, - BrowseSourceResponses, - BrowseSourceErrors, - ListWatchesData, - ListWatchesResponses, - CreateWatchData, - CreateWatchResponses, - CreateWatchErrors, - PreviewWatchData, - PreviewWatchResponses, - PreviewWatchErrors, - DeleteWatchData, - DeleteWatchResponses, - DeleteWatchErrors, - UpdateWatchData, - UpdateWatchResponses, - UpdateWatchErrors, - ScanWatchData, - ScanWatchResponses, - ScanWatchErrors, - ListTemplatesData, - ListTemplatesResponses, - CreateTemplateData, - CreateTemplateResponses, - CreateTemplateErrors, - PreviewTemplateData, - PreviewTemplateResponses, - PreviewTemplateErrors, - GetTemplateData, - GetTemplateResponses, - GetTemplateErrors, - CreateTemplateVersionData, - CreateTemplateVersionResponses, - CreateTemplateVersionErrors, - DiffTemplateVersionsData, - DiffTemplateVersionsResponses, - DiffTemplateVersionsErrors, - ListPipelinesData, - ListPipelinesResponses, - CreatePipelineData, - CreatePipelineResponses, - CreatePipelineErrors, - GetPipelineData, - GetPipelineResponses, - GetPipelineErrors, - CreatePipelineVersionData, - CreatePipelineVersionResponses, - CreatePipelineVersionErrors, + RetryJobResponses, + RetypeEntitiesData, + RetypeEntitiesErrors, + RetypeEntitiesResponses, + RevertMetadataEditData, + RevertMetadataEditErrors, + RevertMetadataEditResponses, + RevokeAnyTokenData, + RevokeAnyTokenErrors, + RevokeAnyTokenResponses, + RevokeData, + RevokeErrors, + RevokeGrantData, + RevokeGrantErrors, + RevokeGrantResponses, + RevokeResponses, + RevokeShareData, + RevokeShareErrors, + RevokeShareResponses, + RevokeSharesData, + RevokeSharesErrors, + RevokeSharesResponses, + RevokeTokenData, + RevokeTokenErrors, + RevokeTokenResponses, + RotateNotifySecretData, + RotateNotifySecretErrors, + RotateNotifySecretResponses, RunPipelineData, - RunPipelineResponses, RunPipelineErrors, - ListContentTypesData, - ListContentTypesResponses, - CreateContentTypeData, - CreateContentTypeResponses, - CreateContentTypeErrors, - DeleteContentTypeData, - DeleteContentTypeResponses, - DeleteContentTypeErrors, - UpdateContentTypeData, - UpdateContentTypeResponses, - UpdateContentTypeErrors, - GetRecordingContentTypeData, - GetRecordingContentTypeResponses, - GetRecordingContentTypeErrors, - SetRecordingContentTypeData, - SetRecordingContentTypeResponses, - SetRecordingContentTypeErrors, - ListWorkflowsData, - ListWorkflowsResponses, - CreateWorkflowData, - CreateWorkflowResponses, - CreateWorkflowErrors, - GetWorkflowData, - GetWorkflowResponses, - GetWorkflowErrors, - UpdateWorkflowData, - UpdateWorkflowResponses, - UpdateWorkflowErrors, - CreateWorkflowVersionData, - CreateWorkflowVersionResponses, - CreateWorkflowVersionErrors, + RunPipelineResponses, + RunRoutineData, + RunRoutineErrors, + RunRoutineResponses, RunWorkflowData, - RunWorkflowResponses, RunWorkflowErrors, - ListChatsData, - ListChatsResponses, - CreateChatData, - CreateChatResponses, - CreateChatErrors, - ChatCapabilitiesData, - ChatCapabilitiesResponses, - DeleteChatData, - DeleteChatResponses, - DeleteChatErrors, - GetChatData, - GetChatResponses, - GetChatErrors, - UpdateChatData, - UpdateChatResponses, - UpdateChatErrors, + RunWorkflowResponses, + SaveCollectionFieldsData, + SaveCollectionFieldsErrors, + SaveCollectionFieldsResponses, + SaveFileFieldsData, + SaveFileFieldsErrors, + SaveFileFieldsResponses, + SaveLlmData, + SaveLlmErrors, + SaveLlmResponses, + SaveNamespaceData, + SaveNamespaceErrors, + SaveNamespaceResponses, + SaveResourceFieldsData, + SaveResourceFieldsErrors, + SaveResourceFieldsResponses, + SaveStorageData, + SaveStorageErrors, + SaveStorageResponses, + SaveTelemetryData, + SaveTelemetryErrors, + SaveTelemetryResponses, + ScanWatchData, + ScanWatchErrors, + ScanWatchResponses, + SearchPublicData, + SearchPublicErrors, + SearchPublicResponses, + SearchTranscriptsData, + SearchTranscriptsErrors, + SearchTranscriptsResponses, + SendChunkData, + SendChunkErrors, + SendChunkResponses, SendMessageData, - SendMessageResponses, SendMessageErrors, + SendMessageResponses, + SetCollectionMemberData, + SetCollectionMemberErrors, + SetCollectionMemberResponses, + SetMemberData, + SetMemberErrors, + SetMemberResponses, + SetNamespaceFacesModeData, + SetNamespaceFacesModeErrors, + SetNamespaceFacesModeResponses, + SetRecordingContentTypeData, + SetRecordingContentTypeErrors, + SetRecordingContentTypeResponses, + SetupData, + SetupErrors, + SetupResponses, + SplitSegmentData, + SplitSegmentErrors, + SplitSegmentResponses, + StartUploadData, + StartUploadErrors, + StartUploadResponses, + StatusData, + StatusResponses, StopAnswerData, - StopAnswerResponses, StopAnswerErrors, - CheckMessageData, - CheckMessageResponses, - CheckMessageErrors, - ListApprovalsData, - ListApprovalsResponses, - ListApprovalsErrors, - DecideApprovalData, - DecideApprovalResponses, - DecideApprovalErrors, - ListCollectionsData, - ListCollectionsResponses, - CreateCollectionData, - CreateCollectionResponses, - CreateCollectionErrors, - DeleteCollectionData, - DeleteCollectionResponses, - DeleteCollectionErrors, - GetCollectionData, - GetCollectionResponses, - GetCollectionErrors, + StopAnswerResponses, + StreamEventsData, + StreamEventsErrors, + StreamEventsResponses, + SuggestTermsData, + SuggestTermsErrors, + SuggestTermsResponses, + TelemetryStatusData, + TelemetryStatusResponses, + TestLlmData, + TestLlmResponses, + TestNotifyTargetData, + TestNotifyTargetErrors, + TestNotifyTargetResponses, + TestSourceData, + TestSourceErrors, + TestSourceResponses, + TestTelemetryData, + TestTelemetryResponses, + TokenData, + TokenErrors, + TokenLimitsData, + TokenLimitsResponses, + TokenResponses, + UndoEntityMergeData, + UndoEntityMergeErrors, + UndoEntityMergeResponses, + UndoFaceMergeData, + UndoFaceMergeErrors, + UndoFaceMergeResponses, + UndoGraphChangeData, + UndoGraphChangeErrors, + UndoGraphChangeResponses, + UndoRunData, + UndoRunErrors, + UndoRunResponses, + UndoSpeakerMergeData, + UndoSpeakerMergeErrors, + UndoSpeakerMergeResponses, + UnlinkEntityData, + UnlinkEntityErrors, + UnlinkEntityResponses, + UnlinkSpeakerData, + UnlinkSpeakerErrors, + UnlinkSpeakerResponses, + UpdateChatData, + UpdateChatErrors, + UpdateChatResponses, UpdateCollectionData, - UpdateCollectionResponses, UpdateCollectionErrors, - EstimateBatchData, - EstimateBatchResponses, - EstimateBatchErrors, - ListBatchesData, - ListBatchesResponses, - CreateBatchData, - CreateBatchResponses, - CreateBatchErrors, - GetBatchData, - GetBatchResponses, - GetBatchErrors, - CombineBatchData, - CombineBatchResponses, - CombineBatchErrors, - ControlBatchData, - ControlBatchResponses, - ControlBatchErrors, - GetBatchResultsData, - GetBatchResultsResponses, - GetBatchResultsErrors, - ExportBatchResultsData, - ExportBatchResultsResponses, - ExportBatchResultsErrors, - GetPublicHomeData, - GetPublicHomeResponses, - GetPublicCollectionData, - GetPublicCollectionResponses, - GetPublicCollectionErrors, - SearchPublicData, - SearchPublicResponses, - SearchPublicErrors, - GetPublicRecordingData, - GetPublicRecordingResponses, - GetPublicRecordingErrors, - RequestAccessData, - RequestAccessResponses, - RequestAccessErrors, - ListPendingAccessRequestsData, - ListPendingAccessRequestsResponses, - ListViewsData, - ListViewsResponses, - CreateViewData, - CreateViewResponses, - CreateViewErrors, - DeleteViewData, - DeleteViewResponses, - DeleteViewErrors, - UpdateViewData, - UpdateViewResponses, - UpdateViewErrors, - ListNotifyTargetsData, - ListNotifyTargetsResponses, - ListNotifyTargetsErrors, - CreateNotifyTargetData, - CreateNotifyTargetResponses, - CreateNotifyTargetErrors, - DeleteNotifyTargetData, - DeleteNotifyTargetResponses, - DeleteNotifyTargetErrors, + UpdateCollectionResponses, + UpdateCommentData, + UpdateCommentErrors, + UpdateCommentResponses, + UpdateContentTypeData, + UpdateContentTypeErrors, + UpdateContentTypeResponses, + UpdateFieldData, + UpdateFieldErrors, + UpdateFieldResponses, + UpdateFileData, + UpdateFileErrors, + UpdateFileResponses, + UpdateHighlightData, + UpdateHighlightErrors, + UpdateHighlightResponses, + UpdateIpGroupData, + UpdateIpGroupErrors, + UpdateIpGroupResponses, + UpdateMeData, + UpdateMeErrors, + UpdateMeResponses, + UpdateNamespaceCollectionData, + UpdateNamespaceCollectionErrors, + UpdateNamespaceCollectionResponses, + UpdateNamespaceData, + UpdateNamespaceErrors, + UpdateNamespaceMetadataData, + UpdateNamespaceMetadataErrors, + UpdateNamespaceMetadataResponses, + UpdateNamespaceResponses, + UpdateNoteData, + UpdateNoteErrors, + UpdateNoteResponses, UpdateNotifyTargetData, - UpdateNotifyTargetResponses, UpdateNotifyTargetErrors, - TestNotifyTargetData, - TestNotifyTargetResponses, - TestNotifyTargetErrors, - RotateNotifySecretData, - RotateNotifySecretResponses, - RotateNotifySecretErrors, - ListNotifyDeliveriesData, - ListNotifyDeliveriesResponses, - ListNotifyDeliveriesErrors, - ListRoutinesData, - ListRoutinesResponses, - CreateRoutineData, - CreateRoutineResponses, - CreateRoutineErrors, - PreviewScheduleData, - PreviewScheduleResponses, - PreviewScheduleErrors, - DeleteRoutineData, - DeleteRoutineResponses, - DeleteRoutineErrors, - GetRoutineData, - GetRoutineResponses, - GetRoutineErrors, + UpdateNotifyTargetResponses, + UpdateRecordingAccessData, + UpdateRecordingAccessErrors, + UpdateRecordingAccessResponses, + UpdateRecordingData, + UpdateRecordingErrors, + UpdateRecordingMetadataData, + UpdateRecordingMetadataErrors, + UpdateRecordingMetadataResponses, + UpdateRecordingResponses, UpdateRoutineData, - UpdateRoutineResponses, UpdateRoutineErrors, - RunRoutineData, - RunRoutineResponses, - RunRoutineErrors, - ListRunsData, - ListRunsResponses, - ListRunsErrors, - GetRunData, - GetRunResponses, - GetRunErrors, - UndoRunData, - UndoRunResponses, - UndoRunErrors, - ListGraphChangesData, - ListGraphChangesResponses, - ListGraphChangesErrors, - AcceptGraphChangeData, - AcceptGraphChangeResponses, - AcceptGraphChangeErrors, - DismissGraphChangeData, - DismissGraphChangeResponses, - DismissGraphChangeErrors, - UndoGraphChangeData, - UndoGraphChangeResponses, - UndoGraphChangeErrors, + UpdateRoutineResponses, + UpdateSearchData, + UpdateSearchErrors, + UpdateSearchResponses, + UpdateSettingsData, + UpdateSettingsErrors, + UpdateSettingsResponses, + UpdateSourceData, + UpdateSourceErrors, + UpdateSourceResponses, + UpdateUserData, + UpdateUserErrors, + UpdateUserResponses, + UpdateViewData, + UpdateViewErrors, + UpdateViewResponses, + UpdateWatchData, + UpdateWatchErrors, + UpdateWatchResponses, + UpdateWorkflowData, + UpdateWorkflowErrors, + UpdateWorkflowResponses, + UploadLimitsData, + UploadLimitsResponses, } from "./types.gen"; -import { client } from "./client.gen"; -export type Options = ClientOptions< - TData, - ThrowOnError -> & { +export type Options< + TData extends TDataShape = TDataShape, + ThrowOnError extends boolean = boolean, + TResponse = unknown, +> = Options2 & { /** * You can provide a client instance returned by `createClient()` instead of * individual options. This might be also useful if you want to implement a @@ -868,16 +877,19 @@ export type Options; + meta?: keyof ClientMeta extends never ? Record : ClientMeta; }; export class Auth { /** * Status + * * Whether the archive still needs its first admin (the sign-in page shows the setup form instead), and whether * the first-run wizard is still to be finished (the web app takes admins there). */ - public static status(options?: Options) { + public static status( + options?: Options, + ): RequestResult { return (options?.client ?? client).get({ url: "/api/v1/auth/status", ...options, @@ -886,9 +898,12 @@ export class Auth { /** * Setup + * * Create the first admin with the one-time code printed in the server log. */ - public static setup(options: Options) { + public static setup( + options: Options, + ): RequestResult { return (options.client ?? client).post({ url: "/api/v1/auth/setup", ...options, @@ -902,7 +917,9 @@ export class Auth { /** * Login */ - public static login(options: Options) { + public static login( + options: Options, + ): RequestResult { return (options.client ?? client).post({ url: "/api/v1/auth/login", ...options, @@ -915,9 +932,12 @@ export class Auth { /** * Refresh + * * Swap a refresh token for a new pair. Each refresh token works once. */ - public static refresh(options: Options) { + public static refresh( + options: Options, + ): RequestResult { return (options.client ?? client).post({ url: "/api/v1/auth/refresh", ...options, @@ -931,7 +951,9 @@ export class Auth { /** * Logout */ - public static logout(options: Options) { + public static logout( + options: Options, + ): RequestResult { return (options.client ?? client).post({ url: "/api/v1/auth/logout", ...options, @@ -945,18 +967,20 @@ export class Auth { /** * Me */ - public static me(options?: Options) { - return (options?.client ?? client).get({ - url: "/api/v1/auth/me", - ...options, - }); + public static me( + options?: Options, + ): RequestResult { + return (options?.client ?? client).get({ url: "/api/v1/auth/me", ...options }); } /** * Update Me + * * Change your own name. */ - public static updateMe(options: Options) { + public static updateMe( + options: Options, + ): RequestResult { return (options.client ?? client).patch({ url: "/api/v1/auth/me", ...options, @@ -969,12 +993,13 @@ export class Auth { /** * Change Password + * * Change your own password, with your current one (signed in; not with an API token). Your other sessions end * and this one stays; API tokens keep working. Audited as `password.change`. */ public static changePassword( options: Options, - ) { + ): RequestResult { return (options.client ?? client).post({ url: "/api/v1/auth/password", ...options, @@ -987,11 +1012,12 @@ export class Auth { /** * Forgot Password + * * Email a reset link. Answers the same whether or not the address has an account. */ public static forgotPassword( options: Options, - ) { + ): RequestResult { return (options.client ?? client).post({ url: "/api/v1/auth/password/forgot", ...options, @@ -1005,7 +1031,9 @@ export class Auth { /** * Reset Password */ - public static resetPassword(options: Options) { + public static resetPassword( + options: Options, + ): RequestResult { return (options.client ?? client).post({ url: "/api/v1/auth/password/reset", ...options, @@ -1021,7 +1049,9 @@ export class Tokens { /** * List Tokens */ - public static listTokens(options?: Options) { + public static listTokens( + options?: Options, + ): RequestResult { return (options?.client ?? client).get({ url: "/api/v1/tokens", ...options, @@ -1030,10 +1060,13 @@ export class Tokens { /** * Create Token + * * A key that acts as you, with your roles (read only, or read and write). It lasts `days` (default * tokens.default_days, at most tokens.max_days; 0 never expires when tokens.never_expire allows), else 400. */ - public static createToken(options: Options) { + public static createToken( + options: Options, + ): RequestResult { return (options.client ?? client).post({ url: "/api/v1/tokens", ...options, @@ -1046,10 +1079,13 @@ export class Tokens { /** * Token Limits + * * How long a new key may last: its default, the most it may get, and whether it may never expire (admins set * these in the tokens settings). */ - public static tokenLimits(options?: Options) { + public static tokenLimits( + options?: Options, + ): RequestResult { return (options?.client ?? client).get({ url: "/api/v1/tokens/limits", ...options, @@ -1058,9 +1094,12 @@ export class Tokens { /** * Revoke Token + * * Revoke one of your keys. Audited as `token.revoke`. */ - public static revokeToken(options: Options) { + public static revokeToken( + options: Options, + ): RequestResult { return (options.client ?? client).delete({ url: "/api/v1/tokens/{token_id}", ...options, @@ -1071,10 +1110,13 @@ export class Tokens { export class Oauth { /** * Register + * * An app registers itself (RFC 7591), without signing in: it gets a `client_id`, and a `client_secret` if it * asked for one. It can do nothing until someone gives it access. Audited as `oauth.client.register`. */ - public static register(options: Options) { + public static register( + options: Options, + ): RequestResult { return (options.client ?? client).post({ url: "/api/v1/oauth/register", ...options, @@ -1087,10 +1129,13 @@ export class Oauth { /** * Consent + * * What the consent page shows for an app's request: the app, where it takes you back to and what it asks for. * 400 when the request can't be answered (an unknown app, an address it didn't register, no PKCE challenge). */ - public static consent(options: Options) { + public static consent( + options: Options, + ): RequestResult { return (options.client ?? client).get({ url: "/api/v1/oauth/authorize", ...options, @@ -1099,11 +1144,14 @@ export class Oauth { /** * Answer + * * Your answer to an app's request. Yes gives it a one-time code (five minutes) at its redirect address, which * it swaps for tokens that act as you, with your roles; no sends it `error=access_denied`. Audited as * `oauth.grant`. */ - public static answer(options: Options) { + public static answer( + options: Options, + ): RequestResult { return (options.client ?? client).post({ url: "/api/v1/oauth/authorize", ...options, @@ -1116,11 +1164,14 @@ export class Oauth { /** * Token + * * The app swaps its code (`grant_type=authorization_code`, with `code_verifier` and the same `redirect_uri`) * or its refresh token (`grant_type=refresh_token`) for an access token and a new refresh token. Form-encoded, as * OAuth has it; errors are `{error, error_description}`. */ - public static token(options: Options) { + public static token( + options: Options, + ): RequestResult { return (options.client ?? client).post({ ...urlSearchParamsBodySerializer, url: "/api/v1/oauth/token", @@ -1134,10 +1185,13 @@ export class Oauth { /** * Revoke + * * An app hands back a token, access or refresh (RFC 7009): the access it was given ends. Answers the same * whether or not the token was known. Audited as `oauth.revoke`. */ - public static revoke(options: Options) { + public static revoke( + options: Options, + ): RequestResult { return (options.client ?? client).post({ ...urlSearchParamsBodySerializer, url: "/api/v1/oauth/revoke", @@ -1151,9 +1205,12 @@ export class Oauth { /** * List Grants + * * The apps you gave access to, the latest first. */ - public static listGrants(options?: Options) { + public static listGrants( + options?: Options, + ): RequestResult { return (options?.client ?? client).get({ url: "/api/v1/oauth/grants", ...options, @@ -1162,9 +1219,12 @@ export class Oauth { /** * Revoke Grant + * * Take an app's access away: its tokens stop working now. Audited as `oauth.revoke`. */ - public static revokeGrant(options: Options) { + public static revokeGrant( + options: Options, + ): RequestResult { return (options.client ?? client).delete({ url: "/api/v1/oauth/grants/{grant_id}", ...options, @@ -1175,9 +1235,12 @@ export class Oauth { export class Users { /** * List Users + * * Every account, with its role in each namespace. */ - public static listUsers(options?: Options) { + public static listUsers( + options?: Options, + ): RequestResult { return (options?.client ?? client).get({ url: "/api/v1/users", ...options, @@ -1187,7 +1250,9 @@ export class Users { /** * Create User */ - public static createUser(options: Options) { + public static createUser( + options: Options, + ): RequestResult { return (options.client ?? client).post({ url: "/api/v1/users", ...options, @@ -1200,9 +1265,12 @@ export class Users { /** * Update User + * * Rename, promote or demote, disable, or set a new password (which signs the person out everywhere). */ - public static updateUser(options: Options) { + public static updateUser( + options: Options, + ): RequestResult { return (options.client ?? client).patch({ url: "/api/v1/users/{uid}", ...options, @@ -1215,9 +1283,12 @@ export class Users { /** * List Members + * * Who has a role in this namespace (owners only). */ - public static listMembers(options: Options) { + public static listMembers( + options: Options, + ): RequestResult { return (options.client ?? client).get({ url: "/api/v1/namespaces/{name}/members", ...options, @@ -1226,9 +1297,12 @@ export class Users { /** * Set Member + * * Give someone a role in this namespace, change it, or (role null) remove them. Owners only. */ - public static setMember(options: Options) { + public static setMember( + options: Options, + ): RequestResult { return (options.client ?? client).put({ url: "/api/v1/namespaces/{name}/members", ...options, @@ -1243,9 +1317,12 @@ export class Users { export class Admin { /** * Get Settings + * * Every section people can change in the app, with who changed it last. Secrets show only whether they are set. */ - public static getSettings(options?: Options) { + public static getSettings( + options?: Options, + ): RequestResult { return (options?.client ?? client).get({ url: "/api/v1/settings", ...options, @@ -1254,11 +1331,12 @@ export class Admin { /** * Update Settings + * * Change some settings in one section; the keys and their types are checked against the section's defaults. */ public static updateSettings( options: Options, - ) { + ): RequestResult { return (options.client ?? client).put({ url: "/api/v1/settings/{section}", ...options, @@ -1271,9 +1349,12 @@ export class Admin { /** * Test Llm + * * Ask the configured model for one word, to check the address, key and model name. */ - public static testLlm(options?: Options) { + public static testLlm( + options?: Options, + ): RequestResult { return (options?.client ?? client).post({ url: "/api/v1/settings/llm/test", ...options, @@ -1282,11 +1363,12 @@ export class Admin { /** * Telemetry Status + * * Whether telemetry is on, where it goes, and how the API process's last exports went. Off by default. */ public static telemetryStatus( options?: Options, - ) { + ): RequestResult { return (options?.client ?? client).get({ url: "/api/v1/settings/telemetry/status", ...options, @@ -1295,11 +1377,12 @@ export class Admin { /** * Test Telemetry + * * Send one test span to the saved endpoint now (on or off), to check the address and headers. */ public static testTelemetry( options?: Options, - ) { + ): RequestResult { return (options?.client ?? client).post({ url: "/api/v1/settings/telemetry/test", ...options, @@ -1308,9 +1391,12 @@ export class Admin { /** * List Audit + * * Who changed what, newest first. */ - public static listAudit(options?: Options) { + public static listAudit( + options?: Options, + ): RequestResult { return (options?.client ?? client).get({ url: "/api/v1/audit", ...options, @@ -1319,11 +1405,12 @@ export class Admin { /** * List All Tokens + * * Everyone's API keys (admins), the latest made first: whose, what scope, when it expires and was last used. */ public static listAllTokens( options?: Options, - ) { + ): RequestResult { return (options?.client ?? client).get({ url: "/api/v1/admin/tokens", ...options, @@ -1332,11 +1419,12 @@ export class Admin { /** * Revoke Any Token + * * Revoke anyone's API key (admins): whatever uses it stops working now. Audited as `token.revoke`. */ public static revokeAnyToken( options: Options, - ) { + ): RequestResult { return (options.client ?? client).delete({ url: "/api/v1/admin/tokens/{token_id}", ...options, @@ -1345,9 +1433,12 @@ export class Admin { /** * Get Health + * * The database, the job queue, workers, storage sources and disk space at a glance. */ - public static getHealth(options?: Options) { + public static getHealth( + options?: Options, + ): RequestResult { return (options?.client ?? client).get({ url: "/api/v1/admin/health", ...options, @@ -1356,11 +1447,12 @@ export class Admin { /** * Reindex Search + * * Rebuild the search index in the background. */ public static reindexSearch( options?: Options, - ) { + ): RequestResult { return (options?.client ?? client).post({ url: "/api/v1/admin/reindex", ...options, @@ -1371,9 +1463,12 @@ export class Admin { export class Setup { /** * Get Setup + * * What is set already, and which fields .env or archive.yaml locks. */ - public static getSetup(options?: Options) { + public static getSetup( + options?: Options, + ): RequestResult { return (options?.client ?? client).get({ url: "/api/v1/setup", ...options, @@ -1382,9 +1477,12 @@ export class Setup { /** * Save Namespace + * * Create the first namespace (or set the graph mode of one that exists). */ - public static saveNamespace(options: Options) { + public static saveNamespace( + options: Options, + ): RequestResult { return (options.client ?? client).post({ url: "/api/v1/setup/namespace", ...options, @@ -1397,9 +1495,12 @@ export class Setup { /** * Save Llm + * * The model provider: an OpenAI-compatible server's address, the model, and its key (empty: unchanged). */ - public static saveLlm(options: Options) { + public static saveLlm( + options: Options, + ): RequestResult { return (options.client ?? client).put({ url: "/api/v1/setup/llm", ...options, @@ -1412,9 +1513,12 @@ export class Setup { /** * Save Storage + * * The upload limit, and optionally a folder on this machine (inside sources.local_roots) to watch. */ - public static saveStorage(options: Options) { + public static saveStorage( + options: Options, + ): RequestResult { return (options.client ?? client).put({ url: "/api/v1/setup/storage", ...options, @@ -1427,9 +1531,12 @@ export class Setup { /** * Save Telemetry + * * Opt in to telemetry: traces and metrics sent only to this endpoint (an OTLP collector). Off unless chosen. */ - public static saveTelemetry(options: Options) { + public static saveTelemetry( + options: Options, + ): RequestResult { return (options.client ?? client).put({ url: "/api/v1/setup/telemetry", ...options, @@ -1442,9 +1549,12 @@ export class Setup { /** * Finish + * * Finish (or skip) the wizard; the web app stops showing it. Everything stays changeable in Settings. */ - public static finish(options: Options) { + public static finish( + options: Options, + ): RequestResult { return (options.client ?? client).post({ url: "/api/v1/setup/finish", ...options, @@ -1459,12 +1569,13 @@ export class Setup { export class Namespaces { /** * List Namespaces + * * The namespaces you have a role in, with their counts, and those you see only some collections of (`partial`, * no `role`): counted over those collections, without the namespace-wide speakers and word cloud. */ public static listNamespaces( options?: Options, - ) { + ): RequestResult { return (options?.client ?? client).get({ url: "/api/v1/namespaces", ...options, @@ -1476,7 +1587,7 @@ export class Namespaces { */ public static createNamespace( options: Options, - ) { + ): RequestResult { return (options.client ?? client).post({ url: "/api/v1/namespaces", ...options, @@ -1489,12 +1600,13 @@ export class Namespaces { /** * Update Namespace + * * Owners: the graph mode (shared or isolated), the default pipeline (null for the built-in one) and a pipeline per * content type. */ public static updateNamespace( options: Options, - ) { + ): RequestResult { return (options.client ?? client).patch({ url: "/api/v1/namespaces/{name}", ...options, @@ -1507,11 +1619,12 @@ export class Namespaces { /** * Get Namespace Wordcloud + * * The namespace's word cloud. Accepts a bearer token or the signed link from the namespace list. */ public static getNamespaceWordcloud( options: Options, - ) { + ): RequestResult { return (options.client ?? client).get({ url: "/api/v1/namespaces/{name}/wordcloud.svg", ...options, @@ -1520,12 +1633,13 @@ export class Namespaces { /** * Get Namespace Stats + * * The namespace's numbers for the recordings made in a range of days (the Reports overview): how many and how long, * who was heard and for how long, and the same per month. Without a range, every recording. */ public static getNamespaceStats( options: Options, - ) { + ): RequestResult { return (options.client ?? client).get({ url: "/api/v1/namespaces/{name}/stats", ...options, @@ -1534,9 +1648,12 @@ export class Namespaces { /** * List Ip Groups + * * The namespace's IP groups (owners), and your address as the server sees it, to check the ranges against. */ - public static listIpGroups(options: Options) { + public static listIpGroups( + options: Options, + ): RequestResult { return (options.client ?? client).get({ url: "/api/v1/namespaces/{name}/ip-groups", ...options, @@ -1545,10 +1662,13 @@ export class Namespaces { /** * Create Ip Group + * * Add an IP group (owners): visitors from its addresses see all of every recording in the namespace * (everything), or of the recordings chosen on each. Answers with all of the namespace's groups. */ - public static createIpGroup(options: Options) { + public static createIpGroup( + options: Options, + ): RequestResult { return (options.client ?? client).post({ url: "/api/v1/namespaces/{name}/ip-groups", ...options, @@ -1561,9 +1681,12 @@ export class Namespaces { /** * Delete Ip Group + * * Delete an IP group (owners): its visitors lose what it opened. Answers with the groups left. */ - public static deleteIpGroup(options: Options) { + public static deleteIpGroup( + options: Options, + ): RequestResult { return (options.client ?? client).delete({ url: "/api/v1/namespaces/{name}/ip-groups/{gid}", ...options, @@ -1572,10 +1695,13 @@ export class Namespaces { /** * Update Ip Group + * * Rename an IP group, change its ranges or what it opens (owners). Choosing recordings again after opening * everything brings back the ones chosen before. */ - public static updateIpGroup(options: Options) { + public static updateIpGroup( + options: Options, + ): RequestResult { return (options.client ?? client).patch({ url: "/api/v1/namespaces/{name}/ip-groups/{gid}", ...options, @@ -1588,32 +1714,31 @@ export class Namespaces { /** * List Namespace Collections + * * The namespace's collections, depth first and by name, each with its place in the tree, how many recordings it * holds (with and without the collections inside it), and what you may do with it. Someone who sees only some * collections of the namespace gets those, starting from the ones they were given. */ public static listNamespaceCollections( options: Options, - ) { + ): RequestResult { return (options.client ?? client).get< ListNamespaceCollectionsResponses, ListNamespaceCollectionsErrors, ThrowOnError - >({ - url: "/api/v1/namespaces/{name}/collections", - ...options, - }); + >({ url: "/api/v1/namespaces/{name}/collections", ...options }); } /** * Create Namespace Collection + * * Make a collection at the top of the namespace (its editors) or inside `parent` (them, or an admin of `parent`). * Its name is unique among the collections next to it, ignoring case; collections go at most 8 deep. Audited as * `collection.create`. */ public static createNamespaceCollection( options: Options, - ) { + ): RequestResult { return (options.client ?? client).post< CreateNamespaceCollectionResponses, CreateNamespaceCollectionErrors, @@ -1630,20 +1755,18 @@ export class Namespaces { /** * Delete Namespace Collection + * * Delete an empty collection (editors of the namespace, or an admin of it), with the roles given on it: 409 while * it holds recordings or collections, or is the namespace's default. Audited as `collection.delete`. */ public static deleteNamespaceCollection( options: Options, - ) { + ): RequestResult { return (options.client ?? client).delete< DeleteNamespaceCollectionResponses, DeleteNamespaceCollectionErrors, ThrowOnError - >({ - url: "/api/v1/namespaces/{name}/collections/{cid}", - ...options, - }); + >({ url: "/api/v1/namespaces/{name}/collections/{cid}", ...options }); } /** @@ -1651,7 +1774,7 @@ export class Namespaces { */ public static getNamespaceCollection( options: Options, - ) { + ): RequestResult { return (options.client ?? client).get({ url: "/api/v1/namespaces/{name}/collections/{cid}", ...options, @@ -1660,6 +1783,7 @@ export class Namespaces { /** * Update Namespace Collection + * * Rename it, describe it, move it inside another collection of the namespace (`parent`; null: to the top) or make * it the default. Editors of the namespace may do all of that; an admin of the collection all but moving it to the * top or making it the default, and only into a collection they're an admin of. The recordings and collections @@ -1667,7 +1791,7 @@ export class Namespaces { */ public static updateNamespaceCollection( options: Options, - ) { + ): RequestResult { return (options.client ?? client).patch< UpdateNamespaceCollectionResponses, UpdateNamespaceCollectionErrors, @@ -1684,13 +1808,14 @@ export class Namespaces { /** * List Collection Members + * * Who was given a role on the collection, then who has one through a collection it's inside (owners of the * namespace, and admins of the collection). People with a role in the namespace aren't listed: theirs holds in * every collection. */ public static listCollectionMembers( options: Options, - ) { + ): RequestResult { return (options.client ?? client).get({ url: "/api/v1/namespaces/{name}/collections/{cid}/members", ...options, @@ -1699,13 +1824,14 @@ export class Namespaces { /** * Set Collection Member + * * Give someone a role on the collection (and the collections inside it), change it, or (role null) take it away. * They needn't have a role in the namespace: then they see just this collection. Owners of the namespace and admins * of the collection. Answers with the members; audited as `collection.member`. */ public static setCollectionMember( options: Options, - ) { + ): RequestResult { return (options.client ?? client).put({ url: "/api/v1/namespaces/{name}/collections/{cid}/members", ...options, @@ -1720,13 +1846,14 @@ export class Namespaces { export class Resources { /** * List Recordings + * * Recordings you can read, newest first by default: those of the namespaces you have a role in, and of the * collections you were given a role on. Filters combine with AND; the ``X-Total-Count`` header says how many match in * all, so pages can be counted. Each row has your `role` on it. */ public static listRecordings( options?: Options, - ) { + ): RequestResult { return (options?.client ?? client).get({ url: "/api/v1/resources", ...options, @@ -1735,9 +1862,12 @@ export class Resources { /** * List Tags + * * The tags on the recordings you can read (or one namespace's), with how many recordings have each. */ - public static listTags(options?: Options) { + public static listTags( + options?: Options, + ): RequestResult { return (options?.client ?? client).get({ url: "/api/v1/resources/tags", ...options, @@ -1746,11 +1876,12 @@ export class Resources { /** * Retag Recordings + * * Add and remove tags on several recordings at once (editors of each one's namespace). */ public static retagRecordings( options: Options, - ) { + ): RequestResult { return (options.client ?? client).post({ url: "/api/v1/resources/tags", ...options, @@ -1763,10 +1894,13 @@ export class Resources { /** * List Origins + * * Where the recordings you can read (or one namespace's) came from, with how many came from each: connected sources * by name, uploads, pasted text, IIIF imports, the archive's own folders and other imported files. */ - public static listOrigins(options?: Options) { + public static listOrigins( + options?: Options, + ): RequestResult { return (options?.client ?? client).get({ url: "/api/v1/resources/origins", ...options, @@ -1775,11 +1909,12 @@ export class Resources { /** * List Languages + * * The languages of the recordings you can read (or one namespace's), with how many are in each; null: not known. */ public static listLanguages( options?: Options, - ) { + ): RequestResult { return (options?.client ?? client).get({ url: "/api/v1/resources/languages", ...options, @@ -1788,10 +1923,13 @@ export class Resources { /** * List Objects + * * The kinds of object seen in the recordings you can read (or one namespace's), with how many recordings each is * in, the most first (the objects step finds them). */ - public static listObjects(options?: Options) { + public static listObjects( + options?: Options, + ): RequestResult { return (options?.client ?? client).get({ url: "/api/v1/resources/objects", ...options, @@ -1800,6 +1938,7 @@ export class Resources { /** * Place Recordings + * * Move recordings into a collection of their namespace: editors of each recording (through the namespace or the * collection it's in) who are editors of the collection too. Recordings of another namespace are a 400: move them * to that namespace first. Their IIIF Manifests change (partOf), so harvesters hear an Update. Audited as @@ -1807,7 +1946,7 @@ export class Resources { */ public static placeRecordings( options: Options, - ) { + ): RequestResult { return (options.client ?? client).post({ url: "/api/v1/resources/collection", ...options, @@ -1820,6 +1959,7 @@ export class Resources { /** * Delete Recording + * * Delete a recording (owners). Everything Lens made from it goes: its transcript and analysis, frames, reports and * outputs, shares, notes, permissions and requests for access. The media file stays where it is, and scans and watched * folders don't import it again; importing it on purpose brings it back. Its waiting jobs are cancelled; while a job @@ -1827,7 +1967,7 @@ export class Resources { */ public static deleteRecording( options: Options, - ) { + ): RequestResult { return (options.client ?? client).delete({ url: "/api/v1/resources/{rid}", ...options, @@ -1837,7 +1977,9 @@ export class Resources { /** * Get Recording */ - public static getRecording(options: Options) { + public static getRecording( + options: Options, + ): RequestResult { return (options.client ?? client).get({ url: "/api/v1/resources/{rid}", ...options, @@ -1846,11 +1988,12 @@ export class Resources { /** * Update Recording + * * Rename a recording or replace its tags (editors). A renamed recording's report is rebuilt with the new title. */ public static updateRecording( options: Options, - ) { + ): RequestResult { return (options.client ?? client).patch({ url: "/api/v1/resources/{rid}", ...options, @@ -1863,6 +2006,7 @@ export class Resources { /** * Move Recording + * * Move a recording to another namespace (owners of its namespace, editors of the new one). * * It keeps its transcript, media, outputs, notes, permissions and share links (`revoke_shares` stops them working); @@ -1871,7 +2015,9 @@ export class Resources { * analysis runs again there (`job`). The old namespace's scans and watched folders don't import the file again. 409 * when the new namespace has the same file or a job is running on it. Audited as `recording.move`. */ - public static moveRecording(options: Options) { + public static moveRecording( + options: Options, + ): RequestResult { return (options.client ?? client).post({ url: "/api/v1/resources/{rid}/move", ...options, @@ -1884,11 +2030,12 @@ export class Resources { /** * Get Recording Access + * * Who may see the recording: public, restricted or private, the parts a public one opens, featured. */ public static getRecordingAccess( options: Options, - ) { + ): RequestResult { return (options.client ?? client).get({ url: "/api/v1/resources/{rid}/access", ...options, @@ -1897,6 +2044,7 @@ export class Resources { /** * Update Recording Access + * * Make a recording public, restricted or private, choose what a public one opens, feature it (owners). * * access or open set to null follow the namespace's default again. The change is kept in the metadata history, and @@ -1904,7 +2052,7 @@ export class Resources { */ public static updateRecordingAccess( options: Options, - ) { + ): RequestResult { return (options.client ?? client).put({ url: "/api/v1/resources/{rid}/access", ...options, @@ -1917,29 +2065,28 @@ export class Resources { /** * List Recording Permissions + * * The people given permission on the recording (owners), newest first. */ public static listRecordingPermissions( options: Options, - ) { + ): RequestResult { return (options.client ?? client).get< ListRecordingPermissionsResponses, ListRecordingPermissionsErrors, ThrowOnError - >({ - url: "/api/v1/resources/{rid}/permissions", - ...options, - }); + >({ url: "/api/v1/resources/{rid}/permissions", ...options }); } /** * Add Recording Permission + * * Give someone with an account permission on the recording (owners): they see all of it on the pages visitors see * and in IIIF, whatever its access; members of its namespace already do. Answers with everyone who has permission. */ public static addRecordingPermission( options: Options, - ) { + ): RequestResult { return (options.client ?? client).post( { url: "/api/v1/resources/{rid}/permissions", @@ -1954,28 +2101,27 @@ export class Resources { /** * Remove Recording Permission + * * Take someone's permission on the recording away (owners). Answers with everyone who still has it. */ public static removeRecordingPermission( options: Options, - ) { + ): RequestResult { return (options.client ?? client).delete< RemoveRecordingPermissionResponses, RemoveRecordingPermissionErrors, ThrowOnError - >({ - url: "/api/v1/resources/{rid}/permissions/{account}", - ...options, - }); + >({ url: "/api/v1/resources/{rid}/permissions/{account}", ...options }); } /** * List Recording Ip Groups + * * The namespace's IP groups (owners), each with whether visitors from its addresses see all of this recording. */ public static listRecordingIpGroups( options: Options, - ) { + ): RequestResult { return (options.client ?? client).get({ url: "/api/v1/resources/{rid}/ip-groups", ...options, @@ -1984,29 +2130,28 @@ export class Resources { /** * Close Recording To Ip Group + * * Close the recording to an IP group again (owners). */ public static closeRecordingToIpGroup( options: Options, - ) { + ): RequestResult { return (options.client ?? client).delete< CloseRecordingToIpGroupResponses, CloseRecordingToIpGroupErrors, ThrowOnError - >({ - url: "/api/v1/resources/{rid}/ip-groups/{gid}", - ...options, - }); + >({ url: "/api/v1/resources/{rid}/ip-groups/{gid}", ...options }); } /** * Open Recording To Ip Group + * * Open the recording to an IP group that opens chosen recordings (owners): visitors from its addresses see all of * it. Answers with the namespace's groups. */ public static openRecordingToIpGroup( options: Options, - ) { + ): RequestResult { return (options.client ?? client).put({ url: "/api/v1/resources/{rid}/ip-groups/{gid}", ...options, @@ -2015,11 +2160,12 @@ export class Resources { /** * List Access Requests + * * Requests for access to the recording (owners), newest first; pending ones wait for an answer. */ public static listAccessRequests( options: Options, - ) { + ): RequestResult { return (options.client ?? client).get({ url: "/api/v1/resources/{rid}/requests", ...options, @@ -2028,11 +2174,12 @@ export class Resources { /** * Approve Access Request + * * Approve a request (owners): the person gets permission on the recording. */ public static approveAccessRequest( options: Options, - ) { + ): RequestResult { return (options.client ?? client).post({ url: "/api/v1/resources/{rid}/requests/{account}/approve", ...options, @@ -2041,11 +2188,12 @@ export class Resources { /** * Decline Access Request + * * Decline a request (owners). They can ask again. */ public static declineAccessRequest( options: Options, - ) { + ): RequestResult { return (options.client ?? client).post({ url: "/api/v1/resources/{rid}/requests/{account}/decline", ...options, @@ -2054,9 +2202,12 @@ export class Resources { /** * Get Player + * * Player data. Works with a share link (``?s=``) as well as signed in; media links in it are signed. */ - public static getPlayer(options: Options) { + public static getPlayer( + options: Options, + ): RequestResult { return (options.client ?? client).get({ url: "/api/v1/resources/{rid}/player", ...options, @@ -2065,9 +2216,12 @@ export class Resources { /** * Get Embed Link + * * A signed link to the embeddable player, for people who can see the recording (it expires; share links don't). */ - public static getEmbedLink(options: Options) { + public static getEmbedLink( + options: Options, + ): RequestResult { return (options.client ?? client).get({ url: "/api/v1/resources/{rid}/embed-link", ...options, @@ -2076,9 +2230,12 @@ export class Resources { /** * Get Audio + * * The audio, with byte ranges. Accepts a bearer token, a share link (``?s=``) or a signed link. */ - public static getAudio(options: Options) { + public static getAudio( + options: Options, + ): RequestResult { return (options.client ?? client).get({ url: "/api/v1/resources/{rid}/audio", ...options, @@ -2090,7 +2247,7 @@ export class Resources { */ public static getRecordingWordcloud( options: Options, - ) { + ): RequestResult { return (options.client ?? client).get({ url: "/api/v1/resources/{rid}/wordcloud.svg", ...options, @@ -2102,7 +2259,7 @@ export class Resources { */ public static reprocessRecording( options: Options, - ) { + ): RequestResult { return (options.client ?? client).post({ url: "/api/v1/resources/{rid}/reprocess", ...options, @@ -2115,9 +2272,12 @@ export class Resources { /** * Revoke Shares + * * Revoke every link that still works. Opening one shows a page saying the link isn't available. */ - public static revokeShares(options: Options) { + public static revokeShares( + options: Options, + ): RequestResult { return (options.client ?? client).delete({ url: "/api/v1/resources/{rid}/share", ...options, @@ -2126,10 +2286,13 @@ export class Resources { /** * Create Share + * * A read-only link to this one recording, for people without an account, with a short ``/s/`` address too. Its * address is only shown now. Revoke it with DELETE /shares/{id}, or every link with DELETE /share. */ - public static createShare(options: Options) { + public static createShare( + options: Options, + ): RequestResult { return (options.client ?? client).post({ url: "/api/v1/resources/{rid}/share", ...options, @@ -2142,9 +2305,12 @@ export class Resources { /** * Revoke Share + * * Revoke one link. Opening it shows a page saying the link isn't available; the others keep working. */ - public static revokeShare(options: Options) { + public static revokeShare( + options: Options, + ): RequestResult { return (options.client ?? client).delete({ url: "/api/v1/resources/{rid}/shares/{sid}", ...options, @@ -2153,10 +2319,13 @@ export class Resources { /** * List Shares + * * The recording's share links, newest first: whether each still works, how often it was played, and the sites * whose pages embed it. */ - public static listShares(options: Options) { + public static listShares( + options: Options, + ): RequestResult { return (options.client ?? client).get({ url: "/api/v1/resources/{rid}/shares", ...options, @@ -2165,11 +2334,12 @@ export class Resources { /** * Export Recording + * * The transcript as txt, md, srt, vtt or json (a download). */ public static exportRecording( options: Options, - ) { + ): RequestResult { return (options.client ?? client).get({ url: "/api/v1/resources/{rid}/export.{fmt}", ...options, @@ -2178,9 +2348,12 @@ export class Resources { /** * Edit Segment + * * Correct a transcript line (text and/or speaker); the recording is re-analysed afterwards. */ - public static editSegment(options: Options) { + public static editSegment( + options: Options, + ): RequestResult { return (options.client ?? client).patch({ url: "/api/v1/resources/{rid}/segments/{idx}", ...options, @@ -2193,12 +2366,15 @@ export class Resources { /** * Split Segment + * * Split a transcript line in two (editors): at `at`, a position in its text, moved back to the start of the word * it's in. The second part starts at `t` (ms) when given, else when its first word was said (or as far into the * line's time as `at` is into its text); it keeps the line's speaker unless `speaker` is sent. The lines after it * move down one, with their corrections. Kept in the edit history; the recording is re-analysed afterwards. */ - public static splitSegment(options: Options) { + public static splitSegment( + options: Options, + ): RequestResult { return (options.client ?? client).post({ url: "/api/v1/resources/{rid}/segments/{idx}/split", ...options, @@ -2211,11 +2387,14 @@ export class Resources { /** * Merge Segments + * * Merge a transcript line with the next one (editors): one line with both texts, from the first's start to the * second's end, with the first's speaker. The lines after it move up one, with their corrections. Kept in the edit * history (with where to split it again); the recording is re-analysed afterwards. */ - public static mergeSegments(options: Options) { + public static mergeSegments( + options: Options, + ): RequestResult { return (options.client ?? client).post({ url: "/api/v1/resources/{rid}/segments/{idx}/merge", ...options, @@ -2224,11 +2403,12 @@ export class Resources { /** * List Segment Edits + * * Corrections, splits and merges of the transcript, the latest first. */ public static listSegmentEdits( options: Options, - ) { + ): RequestResult { return (options.client ?? client).get({ url: "/api/v1/resources/{rid}/edits", ...options, @@ -2237,9 +2417,12 @@ export class Resources { /** * List Outputs + * * Results of LLM pipeline steps for this recording. */ - public static listOutputs(options: Options) { + public static listOutputs( + options: Options, + ): RequestResult { return (options.client ?? client).get({ url: "/api/v1/resources/{rid}/outputs", ...options, @@ -2250,9 +2433,12 @@ export class Resources { export class Notes { /** * List Notes + * * Your notes on the recording and the ones shared on it: notes about the whole recording first, then by moment. */ - public static listNotes(options: Options) { + public static listNotes( + options: Options, + ): RequestResult { return (options.client ?? client).get({ url: "/api/v1/resources/{rid}/notes", ...options, @@ -2261,11 +2447,14 @@ export class Notes { /** * Create Note + * * Write a note about a moment (`t0`–`t1`, with the `quote` picked in the transcript) or about the whole recording. * Anyone who can read the recording can; only you see it unless you share it with everyone who can read the * recording, which needs editor access. Up to 500 each on a recording. Sharing is audited (`note.share`). */ - public static createNote(options: Options) { + public static createNote( + options: Options, + ): RequestResult { return (options.client ?? client).post({ url: "/api/v1/resources/{rid}/notes", ...options, @@ -2278,10 +2467,13 @@ export class Notes { /** * Delete Note + * * Delete it: its writer, or for a shared note an owner of the recording (of its namespace, or an admin of its * collection). Deleting a shared note is audited (`note.delete`). */ - public static deleteNote(options: Options) { + public static deleteNote( + options: Options, + ): RequestResult { return (options.client ?? client).delete({ url: "/api/v1/resources/{rid}/notes/{nid}", ...options, @@ -2290,10 +2482,13 @@ export class Notes { /** * Update Note + * * Change its text, or share or unshare it: its writer only. Sharing needs editor access; sharing and unsharing * are audited (`note.share`, `note.unshare`). */ - public static updateNote(options: Options) { + public static updateNote( + options: Options, + ): RequestResult { return (options.client ?? client).patch({ url: "/api/v1/resources/{rid}/notes/{nid}", ...options, @@ -2308,10 +2503,13 @@ export class Notes { export class Comments { /** * List Comments + * * The resource's comments, threaded: each thread (the ones about the whole resource first, then by moment) * followed by its replies, the earliest first. */ - public static listComments(options: Options) { + public static listComments( + options: Options, + ): RequestResult { return (options.client ?? client).get({ url: "/api/v1/resources/{rid}/comments", ...options, @@ -2320,11 +2518,14 @@ export class Comments { /** * Create Comment + * * Comment on a moment or passage (`t0`–`t1`, with the `quote` picked in the text) or on the whole resource, or * with `parent` reply on a thread (a reply to a reply goes on the thread too). Anyone who can read the resource * can, up to 1,000 each on a resource. */ - public static createComment(options: Options) { + public static createComment( + options: Options, + ): RequestResult { return (options.client ?? client).post({ url: "/api/v1/resources/{rid}/comments", ...options, @@ -2337,10 +2538,13 @@ export class Comments { /** * Delete Comment + * * Delete it: its writer, or an owner of the resource (of its namespace, or an admin of its collection). A * thread's first comment takes its replies with it. Audited (`comment.delete`). */ - public static deleteComment(options: Options) { + public static deleteComment( + options: Options, + ): RequestResult { return (options.client ?? client).delete({ url: "/api/v1/resources/{rid}/comments/{cid}", ...options, @@ -2349,10 +2553,13 @@ export class Comments { /** * Update Comment + * * Change its text (its writer only), or resolve or reopen its thread (`resolved`, on the thread's first * comment: its writer, or an editor of the resource; audited as `comment.resolve` and `comment.reopen`). */ - public static updateComment(options: Options) { + public static updateComment( + options: Options, + ): RequestResult { return (options.client ?? client).patch({ url: "/api/v1/resources/{rid}/comments/{cid}", ...options, @@ -2365,11 +2572,12 @@ export class Comments { /** * List Highlights + * * The resource's highlights, by passage, for everyone who can read it. */ public static listHighlights( options: Options, - ) { + ): RequestResult { return (options.client ?? client).get({ url: "/api/v1/resources/{rid}/highlights", ...options, @@ -2378,12 +2586,13 @@ export class Comments { /** * Create Highlight + * * Mark a passage (`t0`–`t1`, with the `quote` picked in the text) in a `colour` (yellow, green, blue or red), * with a `label`: editors of the resource. Up to 1,000 on a resource. */ public static createHighlight( options: Options, - ) { + ): RequestResult { return (options.client ?? client).post({ url: "/api/v1/resources/{rid}/highlights", ...options, @@ -2396,11 +2605,12 @@ export class Comments { /** * Delete Highlight + * * Delete it: editors of the resource. Audited (`highlight.delete`). */ public static deleteHighlight( options: Options, - ) { + ): RequestResult { return (options.client ?? client).delete({ url: "/api/v1/resources/{rid}/highlights/{hid}", ...options, @@ -2409,11 +2619,12 @@ export class Comments { /** * Update Highlight + * * Change its colour or its label (an empty label clears it): editors of the resource. */ public static updateHighlight( options: Options, - ) { + ): RequestResult { return (options.client ?? client).patch({ url: "/api/v1/resources/{rid}/highlights/{hid}", ...options, @@ -2428,10 +2639,13 @@ export class Comments { export class Files { /** * List Files + * * The resource's primary file (its audio or video, if it has one) and its supplementary files, with signed links to * download them. */ - public static listFiles(options: Options) { + public static listFiles( + options: Options, + ): RequestResult { return (options.client ?? client).get({ url: "/api/v1/resources/{rid}/files", ...options, @@ -2440,12 +2654,15 @@ export class Files { /** * Add File + * * Add a file as the raw request body (application/octet-stream), up to `server.max_upload_mb`. Each role takes * its own types: transcripts and translations .txt .md .json .jsonl .srt .vtt .docx .doc .pdf, captions .vtt .srt, * indexes those and OHMS .xml, thumbnails .jpg .png .webp .gif, attachments anything. 400 when its contents can't * be read as its role. Editors; audited as `file.add`. */ - public static addFile(options: Options) { + public static addFile( + options: Options, + ): RequestResult { return (options.client ?? client).post({ bodySerializer: null, url: "/api/v1/resources/{rid}/files", @@ -2459,9 +2676,12 @@ export class Files { /** * Delete File + * * Delete a file and the lines read from it. Editors; audited as `file.delete`. */ - public static deleteFile(options: Options) { + public static deleteFile( + options: Options, + ): RequestResult { return (options.client ?? client).delete({ url: "/api/v1/resources/{rid}/files/{fid}", ...options, @@ -2470,10 +2690,13 @@ export class Files { /** * Update File + * * Change a file's role, language, label or description (null clears the last three). A new role reads it again, * so a file can't take a role whose type it isn't. Editors; audited as `file.update`. */ - public static updateFile(options: Options) { + public static updateFile( + options: Options, + ): RequestResult { return (options.client ?? client).patch({ url: "/api/v1/resources/{rid}/files/{fid}", ...options, @@ -2486,9 +2709,12 @@ export class Files { /** * Download File + * * The file as it was added, to save. Accepts a bearer token or a signed link (from the list). */ - public static downloadFile(options: Options) { + public static downloadFile( + options: Options, + ): RequestResult { return (options.client ?? client).get({ url: "/api/v1/resources/{rid}/files/{fid}/download", ...options, @@ -2497,9 +2723,12 @@ export class Files { /** * List File Lines + * * The lines read from a transcript, captions, translation or index, in order. */ - public static listFileLines(options: Options) { + public static listFileLines( + options: Options, + ): RequestResult { return (options.client ?? client).get({ url: "/api/v1/resources/{rid}/files/{fid}/lines", ...options, @@ -2510,9 +2739,12 @@ export class Files { export class Fields { /** * List Fields + * * The namespace's custom fields: its own, then those of its collections (the ones you see), each in order. */ - public static listFields(options: Options) { + public static listFields( + options: Options, + ): RequestResult { return (options.client ?? client).get({ url: "/api/v1/namespaces/{name}/fields", ...options, @@ -2521,11 +2753,14 @@ export class Fields { /** * Create Field + * * Define a field on the namespace, or on one of its collections (`collection`). It describes the resources, the * collections or the files inside (`target`); new fields are internal unless `published`. Editors; audited as * `field.create`. */ - public static createField(options: Options) { + public static createField( + options: Options, + ): RequestResult { return (options.client ?? client).post({ url: "/api/v1/namespaces/{name}/fields", ...options, @@ -2538,10 +2773,13 @@ export class Fields { /** * Delete Field + * * Delete a field and every value it has. Editors of where it's defined; audited as `field.delete` with how many * values went. Answers with the field as it was, `uses` saying how many values were deleted. */ - public static deleteField(options: Options) { + public static deleteField( + options: Options, + ): RequestResult { return (options.client ?? client).delete({ url: "/api/v1/namespaces/{name}/fields/{fid}", ...options, @@ -2550,9 +2788,12 @@ export class Fields { /** * Get Field + * * One field, with how many items have a value for it (`uses`). */ - public static getField(options: Options) { + public static getField( + options: Options, + ): RequestResult { return (options.client ?? client).get({ url: "/api/v1/namespaces/{name}/fields/{fid}", ...options, @@ -2561,11 +2802,14 @@ export class Fields { /** * Update Field + * * Rename a field, change its options (400 for one that items have chosen), its help, whether it's published, or * its place in the order. Its type and what it describes stay. Editors of where it's defined; audited as * `field.update`. */ - public static updateField(options: Options) { + public static updateField( + options: Options, + ): RequestResult { return (options.client ?? client).patch({ url: "/api/v1/namespaces/{name}/fields/{fid}", ...options, @@ -2578,12 +2822,13 @@ export class Fields { /** * Get Resource Fields + * * The custom fields that describe this resource (defined on its namespace and on the collections it's in), with * its values. */ public static getResourceFields( options: Options, - ) { + ): RequestResult { return (options.client ?? client).get({ url: "/api/v1/resources/{rid}/fields", ...options, @@ -2592,12 +2837,13 @@ export class Fields { /** * Save Resource Fields + * * Set or clear (null) the resource's values for the fields named; the others keep theirs. Editors. Kept in its * metadata history (so a revert puts them back) and audited as `fields.save`. */ public static saveResourceFields( options: Options, - ) { + ): RequestResult { return (options.client ?? client).put({ url: "/api/v1/resources/{rid}/fields", ...options, @@ -2610,12 +2856,13 @@ export class Fields { /** * Get Collection Fields + * * The custom fields that describe this collection (defined on the namespace, and on the collections it's inside), * with its values. */ public static getCollectionFields( options: Options, - ) { + ): RequestResult { return (options.client ?? client).get({ url: "/api/v1/namespaces/{name}/collections/{cid}/fields", ...options, @@ -2624,12 +2871,13 @@ export class Fields { /** * Save Collection Fields + * * Set or clear (null) the collection's values for the fields named. Those who arrange it (editors of the namespace, * admins of the collection); audited as `fields.save`. */ public static saveCollectionFields( options: Options, - ) { + ): RequestResult { return (options.client ?? client).put({ url: "/api/v1/namespaces/{name}/collections/{cid}/fields", ...options, @@ -2642,10 +2890,13 @@ export class Fields { /** * Get File Fields + * * The custom fields that describe this file (defined on its resource's namespace and collections), with its * values. */ - public static getFileFields(options: Options) { + public static getFileFields( + options: Options, + ): RequestResult { return (options.client ?? client).get({ url: "/api/v1/resources/{rid}/files/{fid}/fields", ...options, @@ -2654,11 +2905,12 @@ export class Fields { /** * Save File Fields + * * Set or clear (null) the file's values for the fields named. Editors of the resource; audited as `fields.save`. */ public static saveFileFields( options: Options, - ) { + ): RequestResult { return (options.client ?? client).put({ url: "/api/v1/resources/{rid}/files/{fid}/fields", ...options, @@ -2673,12 +2925,13 @@ export class Fields { export class Imports { /** * Import Transcript + * * Import a transcript into a namespace (editors; admins may name a new namespace). The namespace's pipeline, or * the one chosen (`pipeline`), is queued as a job. */ public static importTranscript( options: Options, - ) { + ): RequestResult { return (options.client ?? client).post({ url: "/api/v1/import", ...options, @@ -2691,12 +2944,15 @@ export class Imports { /** * Import Web Page + * * Capture a web page as a document (editors; admins may name a new namespace): the namespace's pipeline, or * `pipeline`, keeps the page as it is now, as a PDF (a link to a PDF is kept as it is; other pages are printed by * headless Chromium), and reads it page by page. Only public addresses on ports 80 and 443 can be captured (and the * networks in documents.web_networks). Audited as `import.web`. */ - public static importWebPage(options: Options) { + public static importWebPage( + options: Options, + ): RequestResult { return (options.client ?? client).post({ url: "/api/v1/import/web", ...options, @@ -2709,9 +2965,12 @@ export class Imports { /** * Preview Import + * * Parse without saving: what the importer would make of this text or file. */ - public static previewImport(options: Options) { + public static previewImport( + options: Options, + ): RequestResult { return (options.client ?? client).post({ url: "/api/v1/import/preview", ...options, @@ -2724,6 +2983,7 @@ export class Imports { /** * Import From Source + * * Import chosen files of a storage source into a namespace now, rather than watching their folder (admins, like * sources; a new namespace is created). Audio, video, documents (PDFs) and images stay on the source and run the * namespace's pipeline, or `pipeline`; transcripts are imported, and PDFs, Word and text files too with @@ -2733,7 +2993,7 @@ export class Imports { */ public static importFromSource( options: Options, - ) { + ): RequestResult { return (options.client ?? client).post({ url: "/api/v1/import/source", ...options, @@ -2748,10 +3008,13 @@ export class Imports { export class Uploads { /** * Upload Limits + * * What can be uploaded: the audio and video types, the largest file, the chunk size the web app sends, and the * largest transcript file for POST /import. */ - public static uploadLimits(options?: Options) { + public static uploadLimits( + options?: Options, + ): RequestResult { return (options?.client ?? client).get({ url: "/api/v1/uploads/limits", ...options, @@ -2760,9 +3023,12 @@ export class Uploads { /** * List Uploads + * * Your uploads that haven't finished, newest first: sending the same file again carries on where it stopped. */ - public static listUploads(options?: Options) { + public static listUploads( + options?: Options, + ): RequestResult { return (options?.client ?? client).get({ url: "/api/v1/uploads", ...options, @@ -2771,13 +3037,16 @@ export class Uploads { /** * Start Upload + * * Start uploading an audio or video file into a namespace (editors; admins may name a new one), or as the audio of * a transcript-only recording (`recording`; editors of its namespace). `pipeline` runs once it's here instead of the * namespace's. Then send the file with PUT /uploads/{uid}. * 400 for a type not in uploads.extensions, 409 when the recording has audio already, 413 over uploads.max_mb, 507 * when the server's disk can't hold it. */ - public static startUpload(options: Options) { + public static startUpload( + options: Options, + ): RequestResult { return (options.client ?? client).post({ url: "/api/v1/uploads", ...options, @@ -2790,9 +3059,12 @@ export class Uploads { /** * Cancel Upload + * * Stop an upload and throw away what has arrived. A finished one is only forgotten: its recording stays. */ - public static cancelUpload(options: Options) { + public static cancelUpload( + options: Options, + ): RequestResult { return (options.client ?? client).delete({ url: "/api/v1/uploads/{uid}", ...options, @@ -2801,9 +3073,12 @@ export class Uploads { /** * Get Upload + * * How much of an upload has arrived (`offset`), or the recording it became. */ - public static getUpload(options: Options) { + public static getUpload( + options: Options, + ): RequestResult { return (options.client ?? client).get({ url: "/api/v1/uploads/{uid}", ...options, @@ -2812,12 +3087,15 @@ export class Uploads { /** * Send Chunk + * * The next chunk of the file as the raw request body (application/octet-stream), starting at `offset`; it streams * to disk. A chunk that breaks off is dropped whole. 409 when `offset` isn't where the upload has got to (GET it and * send from its `offset`), or while another chunk of it is arriving. The chunk with the last byte returns the upload * done, with its recording and job (for `attach`, the job that runs the steps that need media); audited as `upload`. */ - public static sendChunk(options: Options) { + public static sendChunk( + options: Options, + ): RequestResult { return (options.client ?? client).put({ bodySerializer: null, url: "/api/v1/uploads/{uid}", @@ -2833,6 +3111,7 @@ export class Uploads { export class Search { /** * Search Transcripts + * * Moments where the words are said (or shown on screen in a video, or written in a resource's supplementary * transcripts, captions, translations and indexes, or the kinds of object seen in videos, documents and images), * best first, in the namespaces you can read and the collections you were given a role on. A speaker or emotion @@ -2840,7 +3119,7 @@ export class Search { */ public static searchTranscripts( options: Options, - ) { + ): RequestResult { return (options.client ?? client).get({ url: "/api/v1/search", ...options, @@ -2849,11 +3128,14 @@ export class Search { /** * Suggest Terms + * * Whole words said in the namespaces you can read (or `ns`) that start with `prefix`, the most said first. Search * has no prefix search, so the web app offers these when someone types interp*. Words are counted per namespace, so * collections you were given a role on don't add any. */ - public static suggestTerms(options: Options) { + public static suggestTerms( + options: Options, + ): RequestResult { return (options.client ?? client).get({ url: "/api/v1/search/terms", ...options, @@ -2862,9 +3144,12 @@ export class Search { /** * Get Graph + * * Speakers and entities as a graph, over the namespaces you can read (isolated ones only in their own scope). */ - public static getGraph(options?: Options) { + public static getGraph( + options?: Options, + ): RequestResult { return (options?.client ?? client).get({ url: "/api/v1/graph", ...options, @@ -2874,7 +3159,9 @@ export class Search { /** * List Mentions */ - public static listMentions(options: Options) { + public static listMentions( + options: Options, + ): RequestResult { return (options.client ?? client).get({ url: "/api/v1/mentions", ...options, @@ -2885,9 +3172,12 @@ export class Search { export class Searches { /** * List Searches + * * Your saved searches, then the ones shared with namespaces you can read; the latest changed first in each. */ - public static listSearches(options?: Options) { + public static listSearches( + options?: Options, + ): RequestResult { return (options?.client ?? client).get({ url: "/api/v1/searches", ...options, @@ -2896,10 +3186,13 @@ export class Searches { /** * Create Search + * * Save a search (its words, namespace, speaker, emotion, recording and object) under a name unique among yours. Sharing it * with its namespace needs editor access there. */ - public static createSearch(options: Options) { + public static createSearch( + options: Options, + ): RequestResult { return (options.client ?? client).post({ url: "/api/v1/searches", ...options, @@ -2912,9 +3205,12 @@ export class Searches { /** * Delete Search + * * Delete it: its maker, or for a shared one an owner of its namespace. Deleting a shared one is audited. */ - public static deleteSearch(options: Options) { + public static deleteSearch( + options: Options, + ): RequestResult { return (options.client ?? client).delete({ url: "/api/v1/searches/{sid}", ...options, @@ -2923,10 +3219,13 @@ export class Searches { /** * Update Search + * * Rename it, or share or unshare it. Its maker only; sharing needs editor access to its namespace, and a search of * every namespace can't be shared. */ - public static updateSearch(options: Options) { + public static updateSearch( + options: Options, + ): RequestResult { return (options.client ?? client).patch({ url: "/api/v1/searches/{sid}", ...options, @@ -2941,10 +3240,13 @@ export class Searches { export class Speakers { /** * List Speakers + * * A namespace's speakers, its recent merges (undoable; who merged and how many recordings moved), links to speakers * in other namespaces, and voices in other shared namespaces that are likely the same person (`cross`). */ - public static listSpeakers(options: Options) { + public static listSpeakers( + options: Options, + ): RequestResult { return (options.client ?? client).get({ url: "/api/v1/speakers", ...options, @@ -2956,7 +3258,7 @@ export class Speakers { */ public static listSpeakerRecordings( options: Options, - ) { + ): RequestResult { return (options.client ?? client).get({ url: "/api/v1/speakers/{sid}/recordings", ...options, @@ -2966,7 +3268,9 @@ export class Speakers { /** * Rename Speaker */ - public static renameSpeaker(options: Options) { + public static renameSpeaker( + options: Options, + ): RequestResult { return (options.client ?? client).post({ url: "/api/v1/speakers/{sid}", ...options, @@ -2979,9 +3283,12 @@ export class Speakers { /** * Merge Speaker + * * Fold this speaker into ``into`` (same namespace). Undo with POST /merges/{merge_id}/undo. */ - public static mergeSpeaker(options: Options) { + public static mergeSpeaker( + options: Options, + ): RequestResult { return (options.client ?? client).post({ url: "/api/v1/speakers/{sid}/merge", ...options, @@ -2997,7 +3304,7 @@ export class Speakers { */ public static undoSpeakerMerge( options: Options, - ) { + ): RequestResult { return (options.client ?? client).post({ url: "/api/v1/merges/{mid}/undo", ...options, @@ -3006,9 +3313,12 @@ export class Speakers { /** * Link Speaker + * * Mark this speaker and one in another namespace as the same person (you need editor access to both). */ - public static linkSpeaker(options: Options) { + public static linkSpeaker( + options: Options, + ): RequestResult { return (options.client ?? client).post({ url: "/api/v1/speakers/{sid}/link", ...options, @@ -3021,10 +3331,13 @@ export class Speakers { /** * Unlink Speaker + * * They aren't the same person after all: remove the link (editor access to both). 404 when they aren't linked. * Audited as speaker.unlink. */ - public static unlinkSpeaker(options: Options) { + public static unlinkSpeaker( + options: Options, + ): RequestResult { return (options.client ?? client).post({ url: "/api/v1/speakers/{sid}/unlink", ...options, @@ -3037,12 +3350,13 @@ export class Speakers { /** * Not Same Speaker + * * These two aren't the same person: drop the suggestion to merge them (one namespace) or link them (two), and * never suggest it again. Editor access to both namespaces. Audited as speaker.not_same. */ public static notSameSpeaker( options: Options, - ) { + ): RequestResult { return (options.client ?? client).post({ url: "/api/v1/speakers/{sid}/not-same", ...options, @@ -3057,11 +3371,14 @@ export class Speakers { export class Entities { /** * List Entities + * * Entities in the namespaces you can read. `types` and `namespaces` are comma-separated; `group` joins same-named ones. * With `recording`, those said in it, also for someone who sees it through a role on its collection (then counted * over the recordings they see). */ - public static listEntities(options?: Options) { + public static listEntities( + options?: Options, + ): RequestResult { return (options?.client ?? client).get({ url: "/api/v1/entities", ...options, @@ -3073,7 +3390,7 @@ export class Entities { */ public static listEntityTypes( options?: Options, - ) { + ): RequestResult { return (options?.client ?? client).get({ url: "/api/v1/entities/types", ...options, @@ -3082,11 +3399,12 @@ export class Entities { /** * List Entity Suggestions + * * Entities that are probably the same thing (same letters, acronyms, sound-alikes), to merge or mark as different. */ public static listEntitySuggestions( options?: Options, - ) { + ): RequestResult { return (options?.client ?? client).get({ url: "/api/v1/entities/suggestions", ...options, @@ -3098,7 +3416,7 @@ export class Entities { */ public static listEntityMerges( options?: Options, - ) { + ): RequestResult { return (options?.client ?? client).get({ url: "/api/v1/entities/merges", ...options, @@ -3107,11 +3425,12 @@ export class Entities { /** * Get Entity Timeline + * * Mentions per month (or week) per namespace for comma-separated entity ids. */ public static getEntityTimeline( options: Options, - ) { + ): RequestResult { return (options.client ?? client).get({ url: "/api/v1/entities/timeline", ...options, @@ -3123,7 +3442,7 @@ export class Entities { */ public static retypeEntities( options: Options, - ) { + ): RequestResult { return (options.client ?? client).post({ url: "/api/v1/entities/retype", ...options, @@ -3137,7 +3456,9 @@ export class Entities { /** * Merge Entities */ - public static mergeEntities(options: Options) { + public static mergeEntities( + options: Options, + ): RequestResult { return (options.client ?? client).post({ url: "/api/v1/entities/merge", ...options, @@ -3153,7 +3474,7 @@ export class Entities { */ public static undoEntityMerge( options: Options, - ) { + ): RequestResult { return (options.client ?? client).post({ url: "/api/v1/entities/merges/{mid}/undo", ...options, @@ -3162,11 +3483,12 @@ export class Entities { /** * Mark Entities Not Same + * * Stop suggesting that these two are the same. */ public static markEntitiesNotSame( options: Options, - ) { + ): RequestResult { return (options.client ?? client).post({ url: "/api/v1/entities/not-same", ...options, @@ -3180,7 +3502,9 @@ export class Entities { /** * Get Entity */ - public static getEntity(options: Options) { + public static getEntity( + options: Options, + ): RequestResult { return (options.client ?? client).get({ url: "/api/v1/entities/{eid}", ...options, @@ -3189,11 +3513,12 @@ export class Entities { /** * List Entity Mentions + * * Every line that mentions the entity; `highlight` is the [start, end) of the mention in `text`. sort: newest, oldest, most. */ public static listEntityMentions( options: Options, - ) { + ): RequestResult { return (options.client ?? client).get({ url: "/api/v1/entities/{eid}/mentions", ...options, @@ -3202,11 +3527,12 @@ export class Entities { /** * Get Entity Connections + * * Entities mentioned together with this one, and who mentions it most. */ public static getEntityConnections( options: Options, - ) { + ): RequestResult { return (options.client ?? client).get({ url: "/api/v1/entities/{eid}/connections", ...options, @@ -3215,9 +3541,12 @@ export class Entities { /** * Rename Entity + * * Rename; with `correct`, also fix the transcript lines (re-analysing the recordings). `dry_run` previews the lines. */ - public static renameEntity(options: Options) { + public static renameEntity( + options: Options, + ): RequestResult { return (options.client ?? client).post({ url: "/api/v1/entities/{eid}/rename", ...options, @@ -3231,7 +3560,9 @@ export class Entities { /** * Hide Entity */ - public static hideEntity(options: Options) { + public static hideEntity( + options: Options, + ): RequestResult { return (options.client ?? client).post({ url: "/api/v1/entities/{eid}/hide", ...options, @@ -3244,9 +3575,12 @@ export class Entities { /** * Link Entity + * * Say an entity in another namespace is the same thing (they stay separate; the graph joins them). */ - public static linkEntity(options: Options) { + public static linkEntity( + options: Options, + ): RequestResult { return (options.client ?? client).post({ url: "/api/v1/entities/{eid}/link", ...options, @@ -3260,7 +3594,9 @@ export class Entities { /** * Unlink Entity */ - public static unlinkEntity(options: Options) { + public static unlinkEntity( + options: Options, + ): RequestResult { return (options.client ?? client).delete({ url: "/api/v1/entities/{eid}/link/{other}", ...options, @@ -3269,9 +3605,12 @@ export class Entities { /** * Move Mention + * * Point one mention at another entity (or a new one), or say it isn't an entity. Survives re-analysis. */ - public static moveMention(options: Options) { + public static moveMention( + options: Options, + ): RequestResult { return (options.client ?? client).post({ url: "/api/v1/mentions/{mention}/move", ...options, @@ -3284,9 +3623,12 @@ export class Entities { /** * Explore Graph + * * The neighbourhood of a node (`e` for an entity, a speaker node id...). scope: `all` (shared graphs) or `ns:`. */ - public static exploreGraph(options: Options) { + public static exploreGraph( + options: Options, + ): RequestResult { return (options.client ?? client).get({ url: "/api/v1/graph/explore", ...options, @@ -3295,9 +3637,12 @@ export class Entities { /** * Find Graph Path + * * The shortest chain of links between two nodes, with the lines that show each link. */ - public static findGraphPath(options: Options) { + public static findGraphPath( + options: Options, + ): RequestResult { return (options.client ?? client).get({ url: "/api/v1/graph/path", ...options, @@ -3311,7 +3656,7 @@ export class Metadata { */ public static getRecordingMetadata( options: Options, - ) { + ): RequestResult { return (options.client ?? client).get({ url: "/api/v1/resources/{rid}/metadata", ...options, @@ -3320,11 +3665,12 @@ export class Metadata { /** * Update Recording Metadata + * * Save fields (null clears one) or put them back to their derived values. The access fields need an owner. */ public static updateRecordingMetadata( options: Options, - ) { + ): RequestResult { return (options.client ?? client).put< UpdateRecordingMetadataResponses, UpdateRecordingMetadataErrors, @@ -3344,24 +3690,22 @@ export class Metadata { */ public static listRecordingMetadataHistory( options: Options, - ) { + ): RequestResult { return (options.client ?? client).get< ListRecordingMetadataHistoryResponses, ListRecordingMetadataHistoryErrors, ThrowOnError - >({ - url: "/api/v1/resources/{rid}/metadata/history", - ...options, - }); + >({ url: "/api/v1/resources/{rid}/metadata/history", ...options }); } /** * Revert Metadata Edit + * * Put a recording's (editors) or namespace's (owners) metadata back to how it was before this edit. */ public static revertMetadataEdit( options: Options, - ) { + ): RequestResult { return (options.client ?? client).post({ url: "/api/v1/metadata/edits/{eid}/revert", ...options, @@ -3370,12 +3714,13 @@ export class Metadata { /** * Get Namespace Metadata + * * The namespace's description and metadata profile, for anyone who sees some of it (the profile says how its * recordings are catalogued). */ public static getNamespaceMetadata( options: Options, - ) { + ): RequestResult { return (options.client ?? client).get({ url: "/api/v1/namespaces/{name}/metadata", ...options, @@ -3384,11 +3729,12 @@ export class Metadata { /** * Update Namespace Metadata + * * Collection metadata and the profile (required fields, defaults, vocabularies, default access). Owners only. */ public static updateNamespaceMetadata( options: Options, - ) { + ): RequestResult { return (options.client ?? client).put< UpdateNamespaceMetadataResponses, UpdateNamespaceMetadataErrors, @@ -3405,11 +3751,12 @@ export class Metadata { /** * Bulk Update Metadata + * * Set or clear fields on many recordings. `dry_run` (the default) reports what would change. */ public static bulkUpdateMetadata( options: Options, - ) { + ): RequestResult { return (options.client ?? client).post({ url: "/api/v1/metadata/bulk", ...options, @@ -3424,10 +3771,13 @@ export class Metadata { export class Video { /** * Get Media + * * The video or audio file, with byte ranges; a document's or an image's file, to save. Accepts a bearer token, a * share link (``?s=``) or a signed link. */ - public static getMedia(options: Options) { + public static getMedia( + options: Options, + ): RequestResult { return (options.client ?? client).get({ url: "/api/v1/resources/{rid}/media", ...options, @@ -3436,10 +3786,13 @@ export class Video { /** * Get Pdf + * * The PDF made of a document that isn't one (a Word file, an email, …): what its pages are drawn from, to save. * Accepts a bearer token, a share link (``?s=``) or a signed link. */ - public static getPdf(options: Options) { + public static getPdf( + options: Options, + ): RequestResult { return (options.client ?? client).get({ url: "/api/v1/resources/{rid}/pdf", ...options, @@ -3448,11 +3801,14 @@ export class Video { /** * Get Frame + * * A still (shot frame, text-on-screen frame or face crop), or a document's or an image's page. Where the namespace * pixelates faces, a visitor (no role in the namespace, nor a link the API signed for a member) gets the faces found * on it pixelated. */ - public static getFrame(options: Options) { + public static getFrame( + options: Options, + ): RequestResult { return (options.client ?? client).get({ url: "/api/v1/resources/{rid}/frames/{name}", ...options, @@ -3461,9 +3817,12 @@ export class Video { /** * Fix Screen Text + * * Correct text read off the screen (the machine's reading is kept as `machine_text`). */ - public static fixScreenText(options: Options) { + public static fixScreenText( + options: Options, + ): RequestResult { return (options.client ?? client).patch({ url: "/api/v1/resources/{rid}/ocr/{span}", ...options, @@ -3476,11 +3835,12 @@ export class Video { /** * Delete Face Track + * * Not a face: remove this track (and its crop) from the recording. */ public static deleteFaceTrack( options: Options, - ) { + ): RequestResult { return (options.client ?? client).delete({ url: "/api/v1/resources/{rid}/faces/{track}", ...options, @@ -3489,11 +3849,12 @@ export class Video { /** * Delete Namespace Faces + * * Delete every face, track and crop in the namespace. Owners only. */ public static deleteNamespaceFaces( options: Options, - ) { + ): RequestResult { return (options.client ?? client).delete({ url: "/api/v1/namespaces/{name}/faces", ...options, @@ -3502,13 +3863,14 @@ export class Video { /** * Get Namespace Faces + * * The face mode (with who set it and why), the faces found (with suggested names) and recent merges. * * Each face's `cover_url` is a signed link to its crop. */ public static getNamespaceFaces( options: Options, - ) { + ): RequestResult { return (options.client ?? client).get({ url: "/api/v1/namespaces/{name}/faces", ...options, @@ -3517,12 +3879,13 @@ export class Video { /** * Set Namespace Faces Mode + * * off, detect or recognize (which needs a purpose), and whether faces are pixelated for visitors. Owners only. * `reprocess` queues the namespace's videos, documents and images (faces on their pages). */ public static setNamespaceFacesMode( options: Options, - ) { + ): RequestResult { return (options.client ?? client).put({ url: "/api/v1/namespaces/{name}/faces/mode", ...options, @@ -3536,7 +3899,9 @@ export class Video { /** * Undo Face Merge */ - public static undoFaceMerge(options: Options) { + public static undoFaceMerge( + options: Options, + ): RequestResult { return (options.client ?? client).post({ url: "/api/v1/faces/merges/{mid}/undo", ...options, @@ -3545,9 +3910,12 @@ export class Video { /** * Delete Face + * * Delete a face with its tracks and crops. Owners only. */ - public static deleteFace(options: Options) { + public static deleteFace( + options: Options, + ): RequestResult { return (options.client ?? client).delete({ url: "/api/v1/faces/{fid}", ...options, @@ -3557,7 +3925,9 @@ export class Video { /** * Rename Face */ - public static renameFace(options: Options) { + public static renameFace( + options: Options, + ): RequestResult { return (options.client ?? client).post({ url: "/api/v1/faces/{fid}", ...options, @@ -3570,9 +3940,12 @@ export class Video { /** * Merge Face + * * Merge this face into another (the same person). */ - public static mergeFace(options: Options) { + public static mergeFace( + options: Options, + ): RequestResult { return (options.client ?? client).post({ url: "/api/v1/faces/{fid}/merge", ...options, @@ -3585,11 +3958,12 @@ export class Video { /** * Link Face Speaker + * * Say whose voice goes with this face (null unlinks). */ public static linkFaceSpeaker( options: Options, - ) { + ): RequestResult { return (options.client ?? client).post({ url: "/api/v1/faces/{fid}/speaker", ...options, @@ -3602,11 +3976,12 @@ export class Video { /** * Dismiss Face Suggestion + * * Drop a suggestion (`kind` face or speaker, with its id). */ public static dismissFaceSuggestion( options: Options, - ) { + ): RequestResult { return (options.client ?? client).post({ url: "/api/v1/faces/{fid}/dismiss", ...options, @@ -3621,11 +3996,12 @@ export class Video { export class Iiif { /** * Get Recording Iiif + * * The recording's manifest (as `json`), whether it is published, its layers, a schema check and viewer links. */ public static getRecordingIiif( options: Options, - ) { + ): RequestResult { return (options.client ?? client).get({ url: "/api/v1/resources/{rid}/iiif", ...options, @@ -3634,11 +4010,12 @@ export class Iiif { /** * Get Content State + * * A IIIF Content State pointing at a moment (t0..t1 seconds) of the recording, and links that open it. */ public static getContentState( options: Options, - ) { + ): RequestResult { return (options.client ?? client).get({ url: "/api/v1/resources/{rid}/content-state", ...options, @@ -3647,11 +4024,12 @@ export class Iiif { /** * Preview Iiif Import + * * What a IIIF manifest or collection would import (Presentation 3; version 2 is refused with a message). */ public static previewIiifImport( options: Options, - ) { + ): RequestResult { return (options.client ?? client).post({ url: "/api/v1/import/iiif/preview", ...options, @@ -3664,11 +4042,14 @@ export class Iiif { /** * Import Iiif + * * Import recordings (audio, captions and metadata) from a IIIF manifest or collection into a namespace. * * With `wait`, answers with the new recording ids; otherwise imports in the background (202). */ - public static importIiif(options: Options) { + public static importIiif( + options: Options, + ): RequestResult { return (options.client ?? client).post({ url: "/api/v1/import/iiif", ...options, @@ -3683,11 +4064,14 @@ export class Iiif { export class Jobs { /** * List Jobs + * * Recent jobs, newest first, with counts by status and by namespace (of the jobs in `namespace` and `batch`, of * any status), plus the latest job's step and log (for the progress bar). With `recording`, that recording's runs, * also for someone who sees it through a role on its collection (then the counts are of those runs only). */ - public static listJobs(options?: Options) { + public static listJobs( + options?: Options, + ): RequestResult { return (options?.client ?? client).get({ url: "/api/v1/jobs", ...options, @@ -3696,9 +4080,12 @@ export class Jobs { /** * Create Jobs + * * Queue recordings (these steps, a pipeline, or their namespace's pipeline) and/or everything pending in a namespace. */ - public static createJobs(options: Options) { + public static createJobs( + options: Options, + ): RequestResult { return (options.client ?? client).post({ url: "/api/v1/jobs", ...options, @@ -3711,10 +4098,13 @@ export class Jobs { /** * Get Job + * * One run: its steps and how each went (`step_runs`), the pipeline it runs, its last log lines, and how long its * steps usually take on this recording (`estimates`, `eta_seconds`). */ - public static getJob(options: Options) { + public static getJob( + options: Options, + ): RequestResult { return (options.client ?? client).get({ url: "/api/v1/jobs/{jid}", ...options, @@ -3723,10 +4113,13 @@ export class Jobs { /** * Get Job Log + * * A run's whole log, a page at a time: up to `limit` lines from line `after`, and how many there are. Runs from * before whole logs were kept have their last 200 lines. */ - public static getJobLog(options: Options) { + public static getJobLog( + options: Options, + ): RequestResult { return (options.client ?? client).get({ url: "/api/v1/jobs/{jid}/log", ...options, @@ -3735,10 +4128,13 @@ export class Jobs { /** * Queue Step + * * The web app's batch buttons: queue one step for everything that needs it (``transcribe``, ``diarize``, * ``analyze``, ``summarize``, ``report``), or (admins) ``run``/``scan`` the configured folders. */ - public static queueStep(options: Options) { + public static queueStep( + options: Options, + ): RequestResult { return (options.client ?? client).post({ url: "/api/v1/jobs/steps/{step}", ...options, @@ -3748,7 +4144,9 @@ export class Jobs { /** * Cancel Job */ - public static cancelJob(options: Options) { + public static cancelJob( + options: Options, + ): RequestResult { return (options.client ?? client).post({ url: "/api/v1/jobs/{jid}/cancel", ...options, @@ -3758,7 +4156,9 @@ export class Jobs { /** * Retry Job */ - public static retryJob(options: Options) { + public static retryJob( + options: Options, + ): RequestResult { return (options.client ?? client).post({ url: "/api/v1/jobs/{jid}/retry", ...options, @@ -3767,9 +4167,12 @@ export class Jobs { /** * List Workers + * * Every worker that has checked in: the steps it runs, its heartbeat and load, and whether it's paused. */ - public static listWorkers(options?: Options) { + public static listWorkers( + options?: Options, + ): RequestResult { return (options?.client ?? client).get({ url: "/api/v1/workers", ...options, @@ -3778,11 +4181,14 @@ export class Jobs { /** * Control Worker + * * ``pause``: the worker takes no new runs; the one it has carries on to the end. ``drain``: it also hands that run * back to the queue after the step it's on, so another worker carries on, and stays paused. ``resume``: it takes runs * again. A paused worker stays paused when it restarts under the same name. Audited as ``worker.``. */ - public static controlWorker(options: Options) { + public static controlWorker( + options: Options, + ): RequestResult { return (options.client ?? client).post({ url: "/api/v1/workers/{name}/{action}", ...options, @@ -3791,13 +4197,16 @@ export class Jobs { /** * Stream Events + * * Server-sent events: one ``job`` event per job change in namespaces you can read, from ``since`` (default: now). * ``once=true`` sends what has changed and closes. ``logs=`` follows that one job: its changes, and each batch of * new log lines as a ``log`` event ``{job, start, lines}`` (``start`` numbers the first line, so a client can tell * an overlap or a gap; the first one carries up to the last 200 lines). Read it with fetch (it needs the * Authorization header). */ - public static streamEvents(options?: Options) { + public static streamEvents( + options?: Options, + ): Promise> { return (options?.client ?? client).sse.get({ url: "/api/v1/events", ...options, @@ -3808,9 +4217,12 @@ export class Jobs { export class Sources { /** * List Backends + * * The kinds of storage a source can be, with their settings and secrets. */ - public static listBackends(options?: Options) { + public static listBackends( + options?: Options, + ): RequestResult { return (options?.client ?? client).get({ url: "/api/v1/sources/backends", ...options, @@ -3820,7 +4232,9 @@ export class Sources { /** * List Sources */ - public static listSources(options?: Options) { + public static listSources( + options?: Options, + ): RequestResult { return (options?.client ?? client).get({ url: "/api/v1/sources", ...options, @@ -3829,9 +4243,12 @@ export class Sources { /** * Create Source + * * Add a source and test it; secrets are stored encrypted and never shown again. */ - public static createSource(options: Options) { + public static createSource( + options: Options, + ): RequestResult { return (options.client ?? client).post({ url: "/api/v1/sources", ...options, @@ -3844,9 +4261,12 @@ export class Sources { /** * Delete Source + * * Remove a source and its watched folders. */ - public static deleteSource(options: Options) { + public static deleteSource( + options: Options, + ): RequestResult { return (options.client ?? client).delete({ url: "/api/v1/sources/{sid}", ...options, @@ -3856,7 +4276,9 @@ export class Sources { /** * Update Source */ - public static updateSource(options: Options) { + public static updateSource( + options: Options, + ): RequestResult { return (options.client ?? client).patch({ url: "/api/v1/sources/{sid}", ...options, @@ -3870,7 +4292,9 @@ export class Sources { /** * Test Source */ - public static testSource(options: Options) { + public static testSource( + options: Options, + ): RequestResult { return (options.client ?? client).post({ url: "/api/v1/sources/{sid}/test", ...options, @@ -3879,10 +4303,13 @@ export class Sources { /** * Browse Source + * * The folders and files at one path of a source (for local sources, no path lists the allowed roots), with the * recordings each file already is. */ - public static browseSource(options: Options) { + public static browseSource( + options: Options, + ): RequestResult { return (options.client ?? client).get({ url: "/api/v1/sources/{sid}/browse", ...options, @@ -3891,9 +4318,12 @@ export class Sources { /** * List Watches + * * Watched folders: all of them for admins, else those feeding namespaces you own. */ - public static listWatches(options?: Options) { + public static listWatches( + options?: Options, + ): RequestResult { return (options?.client ?? client).get({ url: "/api/v1/watches", ...options, @@ -3902,9 +4332,12 @@ export class Sources { /** * Create Watch + * * Watch a folder of a source; new files there are imported into the namespace (which is created if needed). */ - public static createWatch(options: Options) { + public static createWatch( + options: Options, + ): RequestResult { return (options.client ?? client).post({ url: "/api/v1/watches", ...options, @@ -3917,9 +4350,12 @@ export class Sources { /** * Preview Watch + * * How many files a watched folder would pick up (the backfill count), before creating it. */ - public static previewWatch(options: Options) { + public static previewWatch( + options: Options, + ): RequestResult { return (options.client ?? client).post({ url: "/api/v1/watches/preview", ...options, @@ -3933,7 +4369,9 @@ export class Sources { /** * Delete Watch */ - public static deleteWatch(options: Options) { + public static deleteWatch( + options: Options, + ): RequestResult { return (options.client ?? client).delete({ url: "/api/v1/watches/{wid}", ...options, @@ -3943,7 +4381,9 @@ export class Sources { /** * Update Watch */ - public static updateWatch(options: Options) { + public static updateWatch( + options: Options, + ): RequestResult { return (options.client ?? client).patch({ url: "/api/v1/watches/{wid}", ...options, @@ -3956,9 +4396,12 @@ export class Sources { /** * Scan Watch + * * Look for new files now instead of waiting for the next poll. */ - public static scanWatch(options: Options) { + public static scanWatch( + options: Options, + ): RequestResult { return (options.client ?? client).post({ url: "/api/v1/watches/{wid}/scan", ...options, @@ -3972,7 +4415,7 @@ export class Templates { */ public static listTemplates( options?: Options, - ) { + ): RequestResult { return (options?.client ?? client).get({ url: "/api/v1/templates", ...options, @@ -3984,7 +4427,7 @@ export class Templates { */ public static createTemplate( options: Options, - ) { + ): RequestResult { return (options.client ?? client).post({ url: "/api/v1/templates", ...options, @@ -3997,13 +4440,14 @@ export class Templates { /** * Preview Template + * * Render a template (saved, or the unsaved text in the editor) against a recording; run=true also calls the model. * * A template that fails to render answers ok=false with the error, so the editor can show it inline. */ public static previewTemplate( options: Options, - ) { + ): RequestResult { return (options.client ?? client).post({ url: "/api/v1/templates/preview", ...options, @@ -4016,9 +4460,12 @@ export class Templates { /** * Get Template + * * One version (default: the current one) and the list of versions. */ - public static getTemplate(options: Options) { + public static getTemplate( + options: Options, + ): RequestResult { return (options.client ?? client).get({ url: "/api/v1/templates/{tid}", ...options, @@ -4030,7 +4477,7 @@ export class Templates { */ public static createTemplateVersion( options: Options, - ) { + ): RequestResult { return (options.client ?? client).post({ url: "/api/v1/templates/{tid}/versions", ...options, @@ -4043,11 +4490,12 @@ export class Templates { /** * Diff Template Versions + * * A unified diff between two versions. */ public static diffTemplateVersions( options: Options, - ) { + ): RequestResult { return (options.client ?? client).get({ url: "/api/v1/templates/{tid}/diff", ...options, @@ -4058,11 +4506,12 @@ export class Templates { export class Pipelines { /** * List Pipelines + * * Saved pipelines, plus what a pipeline can be built from. */ public static listPipelines( options?: Options, - ) { + ): RequestResult { return (options?.client ?? client).get({ url: "/api/v1/pipelines", ...options, @@ -4074,7 +4523,7 @@ export class Pipelines { */ public static createPipeline( options: Options, - ) { + ): RequestResult { return (options.client ?? client).post({ url: "/api/v1/pipelines", ...options, @@ -4087,9 +4536,12 @@ export class Pipelines { /** * Get Pipeline + * * One version (default: the current one) and the list of versions. */ - public static getPipeline(options: Options) { + public static getPipeline( + options: Options, + ): RequestResult { return (options.client ?? client).get({ url: "/api/v1/pipelines/{pid}", ...options, @@ -4101,7 +4553,7 @@ export class Pipelines { */ public static createPipelineVersion( options: Options, - ) { + ): RequestResult { return (options.client ?? client).post({ url: "/api/v1/pipelines/{pid}/versions", ...options, @@ -4114,9 +4566,12 @@ export class Pipelines { /** * Run Pipeline + * * Run this pipeline on one recording now (its outputs are kept). */ - public static runPipeline(options: Options) { + public static runPipeline( + options: Options, + ): RequestResult { return (options.client ?? client).post({ url: "/api/v1/pipelines/{pid}/run", ...options, @@ -4131,11 +4586,12 @@ export class Pipelines { export class ContentTypes { /** * List Content Types + * * Every subtype, by base type (general first). */ public static listContentTypes( options?: Options, - ) { + ): RequestResult { return (options?.client ?? client).get({ url: "/api/v1/content-types", ...options, @@ -4147,7 +4603,7 @@ export class ContentTypes { */ public static createContentType( options: Options, - ) { + ): RequestResult { return (options.client ?? client).post({ url: "/api/v1/content-types", ...options, @@ -4160,11 +4616,12 @@ export class ContentTypes { /** * Delete Content Type + * * Remove a subtype (not a base type's general one). Resources that had it are recognised again. */ public static deleteContentType( options: Options, - ) { + ): RequestResult { return (options.client ?? client).delete({ url: "/api/v1/content-types/{key}", ...options, @@ -4176,7 +4633,7 @@ export class ContentTypes { */ public static updateContentType( options: Options, - ) { + ): RequestResult { return (options.client ?? client).patch({ url: "/api/v1/content-types/{key}", ...options, @@ -4192,24 +4649,22 @@ export class ContentTypes { */ public static getRecordingContentType( options: Options, - ) { + ): RequestResult { return (options.client ?? client).get< GetRecordingContentTypeResponses, GetRecordingContentTypeErrors, ThrowOnError - >({ - url: "/api/v1/resources/{rid}/content-type", - ...options, - }); + >({ url: "/api/v1/resources/{rid}/content-type", ...options }); } /** * Set Recording Content Type + * * Choose the resource's subtype (null: recognise it from the file again). Editors. New runs use its pipeline. */ public static setRecordingContentType( options: Options, - ) { + ): RequestResult { return (options.client ?? client).put< SetRecordingContentTypeResponses, SetRecordingContentTypeErrors, @@ -4228,11 +4683,12 @@ export class ContentTypes { export class Workflows { /** * List Workflows + * * Saved workflows, plus the nodes a workflow can be built from. */ public static listWorkflows( options?: Options, - ) { + ): RequestResult { return (options?.client ?? client).get({ url: "/api/v1/workflows", ...options, @@ -4244,7 +4700,7 @@ export class Workflows { */ public static createWorkflow( options: Options, - ) { + ): RequestResult { return (options.client ?? client).post({ url: "/api/v1/workflows", ...options, @@ -4257,9 +4713,12 @@ export class Workflows { /** * Get Workflow + * * One version (default: the current one) and the list of versions. */ - public static getWorkflow(options: Options) { + public static getWorkflow( + options: Options, + ): RequestResult { return (options.client ?? client).get({ url: "/api/v1/workflows/{wid}", ...options, @@ -4268,11 +4727,12 @@ export class Workflows { /** * Update Workflow + * * Its name and description (the graph changes by saving a version). */ public static updateWorkflow( options: Options, - ) { + ): RequestResult { return (options.client ?? client).patch({ url: "/api/v1/workflows/{wid}", ...options, @@ -4288,7 +4748,7 @@ export class Workflows { */ public static createWorkflowVersion( options: Options, - ) { + ): RequestResult { return (options.client ?? client).post({ url: "/api/v1/workflows/{wid}/versions", ...options, @@ -4301,9 +4761,12 @@ export class Workflows { /** * Run Workflow + * * Run this workflow on one recording now, as a job (after anything its current job still has to do). */ - public static runWorkflow(options: Options) { + public static runWorkflow( + options: Options, + ): RequestResult { return (options.client ?? client).post({ url: "/api/v1/workflows/{wid}/run", ...options, @@ -4318,9 +4781,12 @@ export class Workflows { export class Chats { /** * List Chats + * * Your conversations, most recent first. */ - public static listChats(options?: Options) { + public static listChats( + options?: Options, + ): RequestResult { return (options?.client ?? client).get({ url: "/api/v1/chats", ...options, @@ -4330,7 +4796,9 @@ export class Chats { /** * Create Chat */ - public static createChat(options?: Options) { + public static createChat( + options?: Options, + ): RequestResult { return (options?.client ?? client).post({ url: "/api/v1/chats", ...options, @@ -4343,13 +4811,14 @@ export class Chats { /** * Chat Capabilities + * * What the assistant can do, for anyone signed in: whether a language model is set up and which, whether it uses * tools (and at most how many steps), and whether answers can be checked against their sources. Not the model * server's address or key. */ public static chatCapabilities( options?: Options, - ) { + ): RequestResult { return (options?.client ?? client).get({ url: "/api/v1/chats/capabilities", ...options, @@ -4359,7 +4828,9 @@ export class Chats { /** * Delete Chat */ - public static deleteChat(options: Options) { + public static deleteChat( + options: Options, + ): RequestResult { return (options.client ?? client).delete({ url: "/api/v1/chats/{cid}", ...options, @@ -4368,9 +4839,12 @@ export class Chats { /** * Get Chat + * * A conversation with its messages. Citations follow your current access: ones you can no longer read are left out. */ - public static getChat(options: Options) { + public static getChat( + options: Options, + ): RequestResult { return (options.client ?? client).get({ url: "/api/v1/chats/{cid}", ...options, @@ -4379,9 +4853,12 @@ export class Chats { /** * Update Chat + * * Rename a conversation, change what it draws on, or the model that answers in it (null: the configured one). */ - public static updateChat(options: Options) { + public static updateChat( + options: Options, + ): RequestResult { return (options.client ?? client).patch({ url: "/api/v1/chats/{cid}", ...options, @@ -4394,10 +4871,13 @@ export class Chats { /** * Send Message + * * Ask a question. Streams events: step, approval, notice, passages, token (answer text), error, stopped (POST * /chats/{cid}/stop: what came before is saved, marked stopped), done (the saved message id). */ - public static sendMessage(options: Options) { + public static sendMessage( + options: Options, + ): Promise> { return (options.client ?? client).sse.post({ url: "/api/v1/chats/{cid}/messages", ...options, @@ -4410,10 +4890,13 @@ export class Chats { /** * Stop Answer + * * Stop the answer being written in a conversation: it ends after the piece or tool step it's on, keeps what came * before (saved, marked stopped) and streams `stopped`, then `done`. Works whichever server process is answering. */ - public static stopAnswer(options: Options) { + public static stopAnswer( + options: Options, + ): RequestResult { return (options.client ?? client).post({ url: "/api/v1/chats/{cid}/stop", ...options, @@ -4422,9 +4905,12 @@ export class Chats { /** * Check Message + * * Re-check each cited claim of an answer against the excerpts it cites; the verdict is saved on the message. */ - public static checkMessage(options: Options) { + public static checkMessage( + options: Options, + ): RequestResult { return (options.client ?? client).post({ url: "/api/v1/chats/{cid}/messages/{mid}/check", ...options, @@ -4433,11 +4919,12 @@ export class Chats { /** * List Approvals + * * Work the assistant proposed for you to approve (and what became of it), newest first. */ public static listApprovals( options?: Options, - ) { + ): RequestResult { return (options?.client ?? client).get({ url: "/api/v1/approvals", ...options, @@ -4446,11 +4933,12 @@ export class Chats { /** * Decide Approval + * * Approve (or run a sample of, or decline) something the assistant proposed. Each approval is decided once. */ public static decideApproval( options: Options, - ) { + ): RequestResult { return (options.client ?? client).post({ url: "/api/v1/approvals/{aid}", ...options, @@ -4468,7 +4956,7 @@ export class Collections { */ public static listCollections( options?: Options, - ) { + ): RequestResult { return (options?.client ?? client).get({ url: "/api/v1/collections", ...options, @@ -4480,7 +4968,7 @@ export class Collections { */ public static createCollection( options: Options, - ) { + ): RequestResult { return (options.client ?? client).post({ url: "/api/v1/collections", ...options, @@ -4496,7 +4984,7 @@ export class Collections { */ public static deleteCollection( options: Options, - ) { + ): RequestResult { return (options.client ?? client).delete({ url: "/api/v1/collections/{cid}", ...options, @@ -4505,9 +4993,12 @@ export class Collections { /** * Get Collection + * * The collection with how many recordings you can read in it, and the newest 200 of them. */ - public static getCollection(options: Options) { + public static getCollection( + options: Options, + ): RequestResult { return (options.client ?? client).get({ url: "/api/v1/collections/{cid}", ...options, @@ -4516,11 +5007,12 @@ export class Collections { /** * Update Collection + * * Change your collection. A filter collection takes a new filter; a fixed one a new list of recordings. */ public static updateCollection( options: Options, - ) { + ): RequestResult { return (options.client ?? client).patch({ url: "/api/v1/collections/{cid}", ...options, @@ -4535,9 +5027,12 @@ export class Collections { export class Batches { /** * Estimate Batch + * * What a run would cost, before starting it. Only recordings you can change count; the rest are `skipped`. */ - public static estimateBatch(options: Options) { + public static estimateBatch( + options: Options, + ): RequestResult { return (options.client ?? client).post({ url: "/api/v1/batches/estimate", ...options, @@ -4550,9 +5045,12 @@ export class Batches { /** * List Batches + * * Your batch runs (everyone's, for admins), newest first. */ - public static listBatches(options?: Options) { + public static listBatches( + options?: Options, + ): RequestResult { return (options?.client ?? client).get({ url: "/api/v1/batches", ...options, @@ -4562,7 +5060,9 @@ export class Batches { /** * Create Batch */ - public static createBatch(options: Options) { + public static createBatch( + options: Options, + ): RequestResult { return (options.client ?? client).post({ url: "/api/v1/batches", ...options, @@ -4576,7 +5076,9 @@ export class Batches { /** * Get Batch */ - public static getBatch(options: Options) { + public static getBatch( + options: Options, + ): RequestResult { return (options.client ?? client).get({ url: "/api/v1/batches/{bid}", ...options, @@ -4585,9 +5087,12 @@ export class Batches { /** * Combine Batch + * * One overview written by the model from every recording's result, citing each as [n]; saved on the batch. */ - public static combineBatch(options: Options) { + public static combineBatch( + options: Options, + ): RequestResult { return (options.client ?? client).post({ url: "/api/v1/batches/{bid}/combine", ...options, @@ -4600,9 +5105,12 @@ export class Batches { /** * Control Batch + * * continue (after a sample), pause, resume, cancel, or retry the failed recordings. */ - public static controlBatch(options: Options) { + public static controlBatch( + options: Options, + ): RequestResult { return (options.client ?? client).post({ url: "/api/v1/batches/{bid}/{action}", ...options, @@ -4611,11 +5119,12 @@ export class Batches { /** * Get Batch Results + * * The run's outputs as one table: list-valued fields become one row per item (e.g. every action item). */ public static getBatchResults( options: Options, - ) { + ): RequestResult { return (options.client ?? client).get({ url: "/api/v1/batches/{bid}/results", ...options, @@ -4627,7 +5136,7 @@ export class Batches { */ public static exportBatchResults( options: Options, - ) { + ): RequestResult { return (options.client ?? client).get({ url: "/api/v1/batches/{bid}/results.{fmt}", ...options, @@ -4638,11 +5147,12 @@ export class Batches { export class Public { /** * Get Public Home + * * The home page: featured public recordings, for everyone, and the collections this visitor sees anything in. */ public static getPublicHome( options?: Options, - ) { + ): RequestResult { return (options?.client ?? client).get({ url: "/api/v1/public/home", ...options, @@ -4651,13 +5161,14 @@ export class Public { /** * Get Public Collection + * * A collection's page: its description and the recordings this visitor sees, newest first. Visitors see the public * ones; signed-in people also see restricted ones, locked; members see all of them. A collection with nothing for * this visitor answers 404, as a missing one does. */ public static getPublicCollection( options: Options, - ) { + ): RequestResult { return (options.client ?? client).get({ url: "/api/v1/public/collections/{name}", ...options, @@ -4666,11 +5177,14 @@ export class Public { /** * Search Public + * * Search what this visitor may see: titles of the recordings they see listed, and the lines of the transcripts * they may read. Title matches come first. Restricted recordings (for signed-in people) and public ones with the * transcript closed match on their title only. */ - public static searchPublic(options?: Options) { + public static searchPublic( + options?: Options, + ): RequestResult { return (options?.client ?? client).get({ url: "/api/v1/public/search", ...options, @@ -4679,6 +5193,7 @@ export class Public { /** * Get Public Recording + * * A recording's public page: what this visitor may see of it, and nothing more. * * Anyone sees a public recording's page, description and open parts; a signed-in person sees a restricted one's title @@ -4687,7 +5202,7 @@ export class Public { */ public static getPublicRecording( options: Options, - ) { + ): RequestResult { return (options.client ?? client).get({ url: "/api/v1/public/recordings/{rid}", ...options, @@ -4696,11 +5211,14 @@ export class Public { /** * Request Access + * * Ask for access to a recording (signed in, without permission): its closed parts, or a restricted one. Asking * again replaces the earlier request. The namespace's owners hear of it by email when mail is set up; they approve * (which gives permission) or decline in the recording's access settings. */ - public static requestAccess(options: Options) { + public static requestAccess( + options: Options, + ): RequestResult { return (options.client ?? client).post({ url: "/api/v1/public/recordings/{rid}/request", ...options, @@ -4715,12 +5233,13 @@ export class Public { export class AccessRequests { /** * List Pending Access Requests + * * Requests waiting for an answer, for recordings in the namespaces you own (all of them for admins), newest * first. Each is answered in its recording's access settings. */ public static listPendingAccessRequests( options?: Options, - ) { + ): RequestResult { return (options?.client ?? client).get({ url: "/api/v1/access-requests", ...options, @@ -4731,9 +5250,12 @@ export class AccessRequests { export class Views { /** * List Views + * * Your views, then the ones shared with namespaces you can read; the latest changed first in each. */ - public static listViews(options?: Options) { + public static listViews( + options?: Options, + ): RequestResult { return (options?.client ?? client).get({ url: "/api/v1/views", ...options, @@ -4742,10 +5264,13 @@ export class Views { /** * Create View + * * Save what the Library shows under a name (unique among your views). Sharing it with its namespace needs * editor access there. */ - public static createView(options: Options) { + public static createView( + options: Options, + ): RequestResult { return (options.client ?? client).post({ url: "/api/v1/views", ...options, @@ -4758,9 +5283,12 @@ export class Views { /** * Delete View + * * Delete it: its maker, or for a shared view an owner of its namespace. Deleting a shared view is audited. */ - public static deleteView(options: Options) { + public static deleteView( + options: Options, + ): RequestResult { return (options.client ?? client).delete({ url: "/api/v1/views/{vid}", ...options, @@ -4769,10 +5297,13 @@ export class Views { /** * Update View + * * Rename it, share or unshare it, or save what the Library shows into it. Its maker only; sharing needs editor * access to its namespace, and a view of every namespace can't be shared. */ - public static updateView(options: Options) { + public static updateView( + options: Options, + ): RequestResult { return (options.client ?? client).patch({ url: "/api/v1/views/{vid}", ...options, @@ -4787,11 +5318,12 @@ export class Views { export class Notifications { /** * List Notify Targets + * * The namespace's notification targets (owners), and the events they can get. */ public static listNotifyTargets( options: Options, - ) { + ): RequestResult { return (options.client ?? client).get({ url: "/api/v1/namespaces/{name}/notifications", ...options, @@ -4800,11 +5332,12 @@ export class Notifications { /** * Create Notify Target + * * Add a target (owners). A webhook comes back with its signing secret, this once. */ public static createNotifyTarget( options: Options, - ) { + ): RequestResult { return (options.client ?? client).post({ url: "/api/v1/namespaces/{name}/notifications", ...options, @@ -4817,11 +5350,12 @@ export class Notifications { /** * Delete Notify Target + * * Delete a target and what it was sent (owners). */ public static deleteNotifyTarget( options: Options, - ) { + ): RequestResult { return (options.client ?? client).delete({ url: "/api/v1/namespaces/{name}/notifications/{tid}", ...options, @@ -4830,11 +5364,12 @@ export class Notifications { /** * Update Notify Target + * * Change a target (owners): its name, address, events, whether it's on, and Matterbridge's gateway, name and token. */ public static updateNotifyTarget( options: Options, - ) { + ): RequestResult { return (options.client ?? client).patch({ url: "/api/v1/namespaces/{name}/notifications/{tid}", ...options, @@ -4847,11 +5382,12 @@ export class Notifications { /** * Test Notify Target + * * Send the target a test message now (owners) and say how it went; it shows in the target's deliveries too. */ public static testNotifyTarget( options: Options, - ) { + ): RequestResult { return (options.client ?? client).post({ url: "/api/v1/namespaces/{name}/notifications/{tid}/test", ...options, @@ -4860,11 +5396,12 @@ export class Notifications { /** * Rotate Notify Secret + * * A webhook's new signing secret (owners), shown this once; the old one stops working at once. */ public static rotateNotifySecret( options: Options, - ) { + ): RequestResult { return (options.client ?? client).post({ url: "/api/v1/namespaces/{name}/notifications/{tid}/secret", ...options, @@ -4873,11 +5410,12 @@ export class Notifications { /** * List Notify Deliveries + * * What the target was sent lately, newest first (owners): up to 50, kept for 30 days. */ public static listNotifyDeliveries( options: Options, - ) { + ): RequestResult { return (options.client ?? client).get({ url: "/api/v1/namespaces/{name}/notifications/{tid}/deliveries", ...options, @@ -4889,7 +5427,9 @@ export class Routines { /** * List Routines */ - public static listRoutines(options?: Options) { + public static listRoutines( + options?: Options, + ): RequestResult { return (options?.client ?? client).get({ url: "/api/v1/routines", ...options, @@ -4899,7 +5439,9 @@ export class Routines { /** * Create Routine */ - public static createRoutine(options: Options) { + public static createRoutine( + options: Options, + ): RequestResult { return (options.client ?? client).post({ url: "/api/v1/routines", ...options, @@ -4912,11 +5454,12 @@ export class Routines { /** * Preview Schedule + * * What a schedule means and the next five times it runs, to check one before saving it. */ public static previewSchedule( options: Options, - ) { + ): RequestResult { return (options.client ?? client).get({ url: "/api/v1/routines/schedule", ...options, @@ -4926,7 +5469,9 @@ export class Routines { /** * Delete Routine */ - public static deleteRoutine(options: Options) { + public static deleteRoutine( + options: Options, + ): RequestResult { return (options.client ?? client).delete({ url: "/api/v1/routines/{rid}", ...options, @@ -4936,7 +5481,9 @@ export class Routines { /** * Get Routine */ - public static getRoutine(options: Options) { + public static getRoutine( + options: Options, + ): RequestResult { return (options.client ?? client).get({ url: "/api/v1/routines/{rid}", ...options, @@ -4945,10 +5492,13 @@ export class Routines { /** * Update Routine + * * Change what is sent: `schedule: null` makes it a routine run only by hand, `namespaces: null` runs it over * every namespace. */ - public static updateRoutine(options: Options) { + public static updateRoutine( + options: Options, + ): RequestResult { return (options.client ?? client).patch({ url: "/api/v1/routines/{rid}", ...options, @@ -4961,9 +5511,12 @@ export class Routines { /** * Run Routine + * * Run it as soon as the scheduler next looks (within half a minute), even when it is off. */ - public static runRoutine(options: Options) { + public static runRoutine( + options: Options, + ): RequestResult { return (options.client ?? client).post({ url: "/api/v1/routines/{rid}/run", ...options, @@ -4977,7 +5530,9 @@ export class Routines { /** * List Runs */ - public static listRuns(options: Options) { + public static listRuns( + options: Options, + ): RequestResult { return (options.client ?? client).get({ url: "/api/v1/routines/{rid}/runs", ...options, @@ -4987,7 +5542,9 @@ export class Routines { /** * Get Run */ - public static getRun(options: Options) { + public static getRun( + options: Options, + ): RequestResult { return (options.client ?? client).get({ url: "/api/v1/routine-runs/{run_id}", ...options, @@ -4996,9 +5553,12 @@ export class Routines { /** * Undo Run + * * Take back every graph change the run made. */ - public static undoRun(options: Options) { + public static undoRun( + options: Options, + ): RequestResult { return (options.client ?? client).post({ url: "/api/v1/routine-runs/{run_id}/undo", ...options, @@ -5007,11 +5567,12 @@ export class Routines { /** * List Graph Changes + * * Changes to the entities of namespaces you can read, newest first. */ public static listGraphChanges( options?: Options, - ) { + ): RequestResult { return (options?.client ?? client).get({ url: "/api/v1/graph-changes", ...options, @@ -5023,7 +5584,7 @@ export class Routines { */ public static acceptGraphChange( options: Options, - ) { + ): RequestResult { return (options.client ?? client).post({ url: "/api/v1/graph-changes/{cid}/accept", ...options, @@ -5039,7 +5600,7 @@ export class Routines { */ public static dismissGraphChange( options: Options, - ) { + ): RequestResult { return (options.client ?? client).post({ url: "/api/v1/graph-changes/{cid}/dismiss", ...options, @@ -5051,7 +5612,7 @@ export class Routines { */ public static undoGraphChange( options: Options, - ) { + ): RequestResult { return (options.client ?? client).post({ url: "/api/v1/graph-changes/{cid}/undo", ...options, diff --git a/nextjs-frontend/app/openapi-client/types.gen.ts b/nextjs-frontend/app/openapi-client/types.gen.ts index 1a7e74d02..f1869e1d9 100644 --- a/nextjs-frontend/app/openapi-client/types.gen.ts +++ b/nextjs-frontend/app/openapi-client/types.gen.ts @@ -1,7 +1,12 @@ // This file is auto-generated by @hey-api/openapi-ts +export type ClientOptions = { + baseUrl: `${string}://${string}` | (string & {}); +}; + /** * AccessRequest + * * Someone asking for permission on a recording (docs/access.md). */ export type AccessRequest = { @@ -49,32 +54,12 @@ export type AccessRequest = { * Decided At */ decided_at?: string | null; - [key: string]: - | unknown - | number - | string - | null - | string - | null - | string - | string - | null - | string - | null - | string - | null - | "pending" - | "approved" - | "declined" - | string - | null - | string - | null - | undefined; + [key: string]: unknown; }; /** * AccountToken + * * Anyone's key, for admins. */ export type AccountToken = { @@ -114,8 +99,7 @@ export type AccountToken = { * Email */ email?: string | null; - [key: string]: - unknown | number | string | "read" | "write" | string | null | string | null | string | null | undefined; + [key: string]: unknown; }; /** @@ -124,11 +108,13 @@ export type AccountToken = { export type AnswerCheck = { /** * Claims + * * sentences that cite a source */ claims: number; /** * Supported + * * claims the cited excerpts support */ supported: number; @@ -142,14 +128,7 @@ export type AnswerCheck = { * Uncited */ uncited?: Array; - [key: string]: - | unknown - | number - | Array<{ - [key: string]: unknown; - }> - | Array - | undefined; + [key: string]: unknown; }; /** @@ -184,7 +163,7 @@ export type ApiToken = { * Last Used At */ last_used_at?: string | null; - [key: string]: unknown | number | string | "read" | "write" | string | null | string | null | undefined; + [key: string]: unknown; }; /** @@ -201,6 +180,7 @@ export type ApiTokenCreate = { scope?: "read" | "write"; /** * Days + * * how long it lasts; default: tokens.default_days; 0: never expires, when tokens.never_expire allows */ days?: number | null; @@ -222,7 +202,7 @@ export type ApiTokenCreated = { * Note */ note?: string; - [key: string]: unknown | number | string | undefined; + [key: string]: unknown; }; /** @@ -261,7 +241,7 @@ export type Approval = { * Result */ result?: unknown; - [key: string]: unknown | number | number | null | string | string | null | string | null | undefined; + [key: string]: unknown; }; /** @@ -284,14 +264,16 @@ export type ApprovalOutcome = { status: string; /** * Batch + * * the batch run started, for run_template */ batch?: number | null; - [key: string]: unknown | string | number | null | undefined; + [key: string]: unknown; }; /** * AttachedTo + * * The email a resource was attached to (it's one of that email's files too). */ export type AttachedTo = { @@ -307,7 +289,7 @@ export type AttachedTo = { * Title */ title?: string | null; - [key: string]: unknown | number | number | null | string | null | undefined; + [key: string]: unknown; }; /** @@ -334,7 +316,7 @@ export type AuditEntry = { * Detail */ detail?: unknown; - [key: string]: unknown | string | string | null | string | null | undefined; + [key: string]: unknown; }; /** @@ -349,7 +331,7 @@ export type AuthStatus = { * Wizard Pending */ wizard_pending?: boolean; - [key: string]: unknown | boolean | undefined; + [key: string]: unknown; }; /** @@ -362,6 +344,7 @@ export type Backend = { label: string; /** * Fields + * * parameters and their defaults */ fields: { @@ -373,19 +356,11 @@ export type Backend = { secrets: Array; /** * Oauth + * * the command that produces the token, for OAuth backends */ oauth?: string | null; - [key: string]: - | unknown - | string - | { - [key: string]: string; - } - | Array - | string - | null - | undefined; + [key: string]: unknown; }; /** @@ -439,29 +414,7 @@ export type Batch = { skipped?: number; estimate?: Estimate | null; report?: BatchReport | null; - [key: string]: - | unknown - | number - | string - | string - | null - | string - | null - | BatchProgress - | Array<{ - [key: string]: unknown; - }> - | { - [key: string]: unknown; - } - | null - | Array - | Array - | Estimate - | null - | BatchReport - | null - | undefined; + [key: string]: unknown; }; /** @@ -474,10 +427,11 @@ export type BatchActionResult = { ok?: boolean; /** * Result + * * recordings started (continue) or jobs retried (retry) */ result?: number | null; - [key: string]: unknown | boolean | number | null | undefined; + [key: string]: unknown; }; /** @@ -502,11 +456,13 @@ export type BatchCreate = { run?: BatchRun; /** * Sample + * * run on this many first; continue after review */ sample?: number | null; /** * Confirm + * * the confirmation text a big run asks for, e.g. "RUN 40" */ confirm?: string | null; @@ -537,6 +493,7 @@ export type BatchEstimate = { llm: LlmEstimate; /** * Would Replace + * * existing outputs the run would overwrite */ would_replace: number; @@ -560,25 +517,11 @@ export type BatchEstimate = { }>; /** * Skipped + * * matching recordings you can't change */ skipped: number; - [key: string]: - | unknown - | number - | { - [key: string]: number; - } - | number - | LlmEstimate - | boolean - | string - | null - | string - | Array<{ - [key: string]: unknown; - }> - | undefined; + [key: string]: unknown; }; /** @@ -590,7 +533,7 @@ export type BatchNeedsConfirmation = { */ detail: string; estimate: Estimate; - [key: string]: unknown | string | Estimate; + [key: string]: unknown; }; /** @@ -623,12 +566,7 @@ export type BatchProgress = { * Remaining */ remaining: number; - [key: string]: - | unknown - | { - [key: string]: number; - } - | number; + [key: string]: unknown; }; /** @@ -655,7 +593,7 @@ export type BatchReport = { * Refs */ refs?: Array; - [key: string]: unknown | string | string | null | string | null | Array | undefined; + [key: string]: unknown; }; /** @@ -678,7 +616,7 @@ export type BatchReportRef = { * Date */ date?: string | null; - [key: string]: unknown | number | string | null | string | null | undefined; + [key: string]: unknown; }; /** @@ -699,19 +637,12 @@ export type BatchResults = { rows: Array<{ [key: string]: unknown; }>; - [key: string]: - | unknown - | string - | null - | Array - | Array<{ - [key: string]: unknown; - }> - | undefined; + [key: string]: unknown; }; /** * BatchRun + * * What to run: a template, a pipeline, or a list of steps. */ export type BatchRun = { @@ -721,11 +652,13 @@ export type BatchRun = { template?: number | null; /** * Key + * * output key for a prompt template */ key?: string | null; /** * Filename + * * file name for an export template */ filename?: string | null; @@ -746,6 +679,7 @@ export type BatchRun = { /** * BatchSelection + * * Which recordings: a collection, a list, or a filter (optionally narrowed to a namespace, entity or speaker). */ export type BatchSelection = { @@ -802,7 +736,7 @@ export type BatchSummary = { */ created_at?: string | null; progress: BatchProgress; - [key: string]: unknown | number | string | string | null | string | null | BatchProgress | undefined; + [key: string]: unknown; }; /** @@ -887,33 +821,23 @@ export type BrowseEntry = { modified?: string | null; /** * Title + * * an email's subject, a calendar event's title */ title?: string | null; /** * When + * * when an email was sent, or a calendar event starts */ when?: string | null; /** * Imported + * * the recordings this file already is, and where */ imported?: Array; - [key: string]: - | unknown - | string - | boolean - | number - | null - | string - | null - | string - | null - | string - | null - | Array - | undefined; + [key: string]: unknown; }; /** @@ -936,6 +860,7 @@ export type Chat = { }; /** * Model + * * the model chosen for this conversation; null: the configured one */ model?: string | null; @@ -955,21 +880,7 @@ export type Chat = { * Messages */ messages?: Array; - [key: string]: - | unknown - | number - | string - | { - [key: string]: unknown; - } - | string - | null - | string - | null - | string - | null - | Array - | undefined; + [key: string]: unknown; }; /** @@ -978,35 +889,41 @@ export type Chat = { export type ChatCapabilities = { /** * Configured + * * a language model is set up; without one, answers are the best-matching passages */ configured: boolean; /** * Model + * * the model answers come from */ model?: string | null; /** * Tools + * * the assistant looks things up with tools (and may propose work for approval) */ tools: boolean; /** * Max Steps + * * the most tool calls it makes for one answer */ max_steps: number; /** * Check + * * answers can be checked against their sources */ check: boolean; /** * Models + * * the models people may pick, the configured one first (llm.chat_models, else the server's list) */ models?: Array; - [key: string]: unknown | boolean | string | null | number | Array | undefined; + [key: string]: unknown; }; /** @@ -1020,6 +937,7 @@ export type ChatCreate = { scope?: ChatScope | null; /** * Model + * * the model that answers in it (one of GET /chats/capabilities `models`); null: the configured one */ model?: string | null; @@ -1051,21 +969,25 @@ export type ChatMessage = { created_at?: string | null; /** * Stopped + * * the answer was stopped (POST /chats/{cid}/stop): `content` is what came before */ stopped?: boolean; /** * Steps + * * the tools the assistant used for this answer, in order */ steps?: Array; /** * Notice + * * e.g. the model can't use tools, so the answer came from a search */ notice?: string | null; /** * Error + * * why there's no answer */ error?: string | null; @@ -1075,34 +997,16 @@ export type ChatMessage = { check?: AnswerCheck | null; /** * Model + * * the model that wrote the answer */ model?: string | null; - [key: string]: - | unknown - | number - | "user" - | "assistant" - | string - | Array - | null - | string - | null - | boolean - | Array - | string - | null - | string - | null - | AnswerCheck - | null - | string - | null - | undefined; + [key: string]: unknown; }; /** * ChatScope + * * What a conversation may draw on. Every field narrows it; leave them out to use everything you can read. */ export type ChatScope = { @@ -1116,6 +1020,7 @@ export type ChatScope = { recordings?: Array | null; /** * Collections + * * saved collections (yours or shared): their recordings as they are when it answers */ collections?: Array | null; @@ -1125,11 +1030,13 @@ export type ChatScope = { speakers?: Array | null; /** * From + * * YYYY-MM-DD */ from?: string | null; /** * To + * * YYYY-MM-DD */ to?: string | null; @@ -1155,6 +1062,7 @@ export type ChatSummary = { }; /** * Model + * * the model chosen for this conversation; null: the configured one */ model?: string | null; @@ -1166,20 +1074,7 @@ export type ChatSummary = { * Updated At */ updated_at?: string | null; - [key: string]: - | unknown - | number - | string - | { - [key: string]: unknown; - } - | string - | null - | string - | null - | string - | null - | undefined; + [key: string]: unknown; }; /** @@ -1193,6 +1088,7 @@ export type ChatUpdate = { scope?: ChatScope | null; /** * Model + * * the model that answers in it (one of GET /chats/capabilities `models`); null: the configured one */ model?: string | null; @@ -1208,6 +1104,7 @@ export type ClientRegistered = { client_id: string; /** * Client Secret + * * only for apps that asked for one; shown once */ client_secret?: string | null; @@ -1217,6 +1114,7 @@ export type ClientRegistered = { client_id_issued_at: number; /** * Client Secret Expires At + * * 0: it doesn't expire */ client_secret_expires_at?: number; @@ -1248,32 +1146,24 @@ export type ClientRegistered = { * Scope */ scope?: string; - [key: string]: - | unknown - | string - | string - | null - | number - | string - | null - | Array - | Array - | Array - | undefined; + [key: string]: unknown; }; /** * ClientRegistration + * * Dynamic client registration (RFC 7591). Metadata Lens has no use for is ignored, as the RFC asks. */ export type ClientRegistration = { /** * Redirect Uris + * * https, http://localhost (any port), or the app's own scheme; 1 to 10 */ redirect_uris: Array; /** * Client Name + * * shown on the consent page and in the list of apps with access */ client_name?: string | null; @@ -1283,6 +1173,7 @@ export type ClientRegistration = { client_uri?: string | null; /** * Token Endpoint Auth Method + * * none (public apps), client_secret_post or client_secret_basic */ token_endpoint_auth_method?: string; @@ -1340,6 +1231,7 @@ export type Collection = { updated_at?: string | null; /** * Count + * * recordings in it you can read */ count: number; @@ -1347,24 +1239,7 @@ export type Collection = { * Recordings */ recordings?: Array | null; - [key: string]: - | unknown - | number - | string - | string - | null - | "filter" - | "fixed" - | { - [key: string]: unknown; - } - | null - | boolean - | string - | null - | Array - | null - | undefined; + [key: string]: unknown; }; /** @@ -1381,6 +1256,7 @@ export type CollectionCreate = { description?: string | null; /** * Filter + * * keys: namespaces, speakers, entities, from, to, q, media, status */ filter?: { @@ -1388,6 +1264,7 @@ export type CollectionCreate = { } | null; /** * Recordings + * * a fixed list instead of a filter */ recordings?: Array | null; @@ -1437,6 +1314,7 @@ export type CollectionDetail = { updated_at?: string | null; /** * Count + * * recordings in it you can read */ count: number; @@ -1446,28 +1324,11 @@ export type CollectionDetail = { created_at?: string | null; /** * Recordings + * * the newest 200 you can read */ recordings: Array; - [key: string]: - | unknown - | number - | string - | string - | null - | "filter" - | "fixed" - | { - [key: string]: unknown; - } - | null - | boolean - | string - | null - | string - | null - | Array - | undefined; + [key: string]: unknown; }; /** @@ -1492,6 +1353,7 @@ export type CollectionMember = { role: "viewer" | "editor" | "admin"; /** * By + * * who gave it */ by?: string | null; @@ -1503,27 +1365,12 @@ export type CollectionMember = { * given on this collection it's inside (null: on this one) */ inherited_from?: CollectionStep | null; - [key: string]: - | unknown - | number - | string - | null - | string - | null - | "viewer" - | "editor" - | "admin" - | string - | null - | string - | null - | CollectionStep - | null - | undefined; + [key: string]: unknown; }; /** * CollectionMemberSet + * * Who (by email, or by account id) and their role on the collection; a null role takes it away. */ export type CollectionMemberSet = { @@ -1559,36 +1406,43 @@ export type CollectionNode = { description?: string | null; /** * Parent + * * the collection it's in; null: the top of its namespace */ parent?: number | null; /** * Depth + * * 0 at the top */ depth?: number; /** * Path + * * names from the top of the namespace down to it */ path?: Array; /** * Recordings + * * recordings it holds */ recordings?: number; /** * Total + * * recordings it and the collections inside it hold */ total?: number; /** * Children + * * collections directly inside it */ children?: number; /** * Default + * * new recordings go here when nobody says where */ default?: boolean; @@ -1606,40 +1460,23 @@ export type CollectionNode = { updated_at?: string | null; /** * Role + * * your role on it: from your namespace role (an owner is an admin) or one given on it or above it */ role?: "viewer" | "editor" | "admin" | null; /** * Can Change + * * you may rename, describe, move or delete it, and make collections inside it */ can_change?: boolean; /** * Can Grant + * * you may give people roles on it */ can_grant?: boolean; - [key: string]: - | unknown - | number - | string - | string - | null - | number - | null - | Array - | boolean - | string - | null - | string - | null - | string - | null - | "viewer" - | "editor" - | "admin" - | null - | undefined; + [key: string]: unknown; }; /** @@ -1648,11 +1485,13 @@ export type CollectionNode = { export type CollectionNodeCreate = { /** * Name + * * unique among the collections next to it, ignoring case */ name: string; /** * Parent + * * the collection to put it in; null: the top of the namespace */ parent?: number | null; @@ -1664,6 +1503,7 @@ export type CollectionNodeCreate = { /** * CollectionNodeUpdate + * * Send what changes: `parent` null moves it to the top; `default: true` makes it the namespace's default. */ export type CollectionNodeUpdate = { @@ -1677,11 +1517,13 @@ export type CollectionNodeUpdate = { description?: string | null; /** * Parent + * * move it inside this collection; null: to the top */ parent?: number | null; /** * Default + * * true: new recordings go here when nobody says where */ default?: boolean | null; @@ -1707,7 +1549,7 @@ export type CollectionRecording = { * Duration Ms */ duration_ms?: number | null; - [key: string]: unknown | number | string | null | string | null | number | null | undefined; + [key: string]: unknown; }; /** @@ -1722,7 +1564,7 @@ export type CollectionStep = { * Name */ name: string; - [key: string]: unknown | number | string; + [key: string]: unknown; }; /** @@ -1739,6 +1581,7 @@ export type CollectionUpdate = { description?: string | null; /** * Filter + * * keys: namespaces, speakers, entities, from, to, q, media, status */ filter?: { @@ -1768,6 +1611,7 @@ export type Comment = { recording: number; /** * Parent + * * the comment this replies to (the thread's first); null: it starts a thread */ parent?: number | null; @@ -1777,26 +1621,31 @@ export type Comment = { text: string; /** * T0 + * * the moment it's about, in ms from the start; null: the whole resource, or a reply */ t0?: number | null; /** * T1 + * * where that moment ends, in ms */ t1?: number | null; /** * Quote + * * the words picked in the text */ quote?: string | null; /** * Resolved + * * the thread is resolved (its first comment says so) */ resolved?: boolean; /** * Resolved By + * * who resolved it: their email */ resolved_by?: string | null; @@ -1810,11 +1659,13 @@ export type Comment = { resolved_at?: string | null; /** * Created By + * * its writer's email */ created_by?: string | null; /** * Created By Name + * * its writer's name, when they gave one */ created_by_name?: string | null; @@ -1828,54 +1679,29 @@ export type Comment = { updated_at?: string | null; /** * Edited At + * * when its text last changed */ edited_at?: string | null; /** * Mine + * * you wrote it: only you can change its text */ mine: boolean; /** * Can Resolve + * * you can resolve or reopen the thread: you started it, or you edit the resource */ can_resolve: boolean; /** * Can Delete + * * you wrote it, or you own the resource */ can_delete: boolean; - [key: string]: - | unknown - | number - | number - | null - | string - | number - | null - | number - | null - | string - | null - | boolean - | string - | null - | string - | null - | string - | null - | string - | null - | string - | null - | string - | null - | string - | null - | string - | null - | undefined; + [key: string]: unknown; }; /** @@ -1888,21 +1714,25 @@ export type CommentCreate = { text: string; /** * Parent + * * reply on this comment's thread (its moment is the thread's) */ parent?: number | null; /** * T0 + * * the moment it's about, in ms from the start; leave out for the whole resource */ t0?: number | null; /** * T1 + * * where that moment ends, in ms (default: t0) */ t1?: number | null; /** * Quote + * * the words picked in the text */ quote?: string | null; @@ -1914,11 +1744,13 @@ export type CommentCreate = { export type CommentUpdate = { /** * Text + * * its writer only */ text?: string | null; /** * Resolved + * * resolve or reopen the thread: its writer, or an editor of the resource */ resolved?: boolean | null; @@ -1926,6 +1758,7 @@ export type CommentUpdate = { /** * Consent + * * What the consent page shows. */ export type Consent = { @@ -1936,15 +1769,17 @@ export type Consent = { redirect_uri: string; /** * Scope + * * what the app asks for: read, or read and write */ scope: "read" | "read write"; /** * Granted + * * what you gave this app before, if anything */ granted?: "read" | "read write" | null; - [key: string]: unknown | ConsentClient | string | "read" | "read write" | "read" | "read write" | null | undefined; + [key: string]: unknown; }; /** @@ -1989,6 +1824,7 @@ export type ConsentAnswer = { approve: boolean; /** * Grant + * * give less than was asked for (read); default: what was asked for */ grant?: "read" | "read write" | null; @@ -2010,7 +1846,7 @@ export type ConsentClient = { * Uri */ uri?: string | null; - [key: string]: unknown | string | string | null | undefined; + [key: string]: unknown; }; /** @@ -2019,24 +1855,28 @@ export type ConsentClient = { export type ConsentResult = { /** * Redirect To + * * send the browser here: the app's address with its code, or with error=access_denied */ redirect_to: string; - [key: string]: unknown | string; + [key: string]: unknown; }; /** * ContentRules + * * How a subtype is recognised when nobody chose it: every rule given has to hold. */ export type ContentRules = { /** * Extensions + * * e.g. [.srt, .vtt] */ extensions?: Array | null; /** * Pattern + * * a regular expression found in the file name or title */ pattern?: string | null; @@ -2072,13 +1912,7 @@ export type ContentState = { * Viewers */ viewers: Array; - [key: string]: - | unknown - | { - [key: string]: unknown; - } - | string - | Array; + [key: string]: unknown; }; /** @@ -2103,6 +1937,7 @@ export type ContentType = { description?: string | null; /** * Pipeline + * * its pipeline; none: the namespace default runs */ pipeline?: number | null; @@ -2114,31 +1949,17 @@ export type ContentType = { } | null; /** * General + * * the base type's catch-all: can be renamed, not removed */ general: boolean; /** * Builtin + * * one Lens started with */ builtin: boolean; - [key: string]: - | unknown - | string - | "video" - | "audio" - | "image" - | "text" - | string - | null - | number - | null - | { - [key: string]: unknown; - } - | null - | boolean - | undefined; + [key: string]: unknown; }; /** @@ -2153,7 +1974,7 @@ export type ContentTypeCatalog = { * Types */ types: Array; - [key: string]: unknown | Array | Array; + [key: string]: unknown; }; /** @@ -2170,6 +1991,7 @@ export type ContentTypeCreate = { label: string; /** * Key + * * lowercase letters, digits and _; made from the label if left out */ key?: string | null; @@ -2186,6 +2008,7 @@ export type ContentTypeCreate = { /** * ContentTypeUpdate + * * Only what you send changes; its key and base type stay. */ export type ContentTypeUpdate = { @@ -2216,35 +2039,40 @@ export type ContentTypeUse = { * Content Type */ content_type: string; - [key: string]: unknown | string; + [key: string]: unknown; }; /** * Converters + * * What this server can make into PDFs to read as documents (docs/api.md#documents-and-images). */ export type Converters = { /** * Office + * * Word, PowerPoint and spreadsheet files, OpenDocument and RTF (LibreOffice) */ office: boolean; /** * Pages + * * text, Markdown, saved web pages and .eml emails (Chromium or LibreOffice) */ pages: boolean; /** * Msg + * * Outlook .msg emails (those, and the extract-msg package) */ msg: boolean; /** * Web + * * web pages captured from their address (Chromium; POST /import/web) */ web?: boolean; - [key: string]: unknown | boolean | undefined; + [key: string]: unknown; }; /** @@ -2259,54 +2087,63 @@ export type Created = { * Id */ id: number; - [key: string]: unknown | boolean | number | undefined; + [key: string]: unknown; }; /** * Description + * * What a model that can see images said a page or a shot shows. */ export type Description = { /** * Idx + * * the page (from 0) or the shot it describes */ idx: number; /** * T0 + * * where it starts: ms, or the page (from 0) when `paged` */ t0: number; /** * T1 + * * where it ends (not included): ms, or the page after it when `paged` */ t1: number; /** * Text + * * the description: a few sentences */ text: string; /** * Model + * * the model that wrote it (llm.vision_model) */ model: string; /** * Frame + * * signed link to the page's drawing or the shot's keyframe */ frame?: string | null; /** * Paged + * * true for a document's or an image's pages */ paged?: boolean | null; - [key: string]: unknown | number | string | string | null | boolean | null | undefined; + [key: string]: unknown; }; /** * EmailInfo + * * An email's own description, read when it was made into a PDF. */ export type EmailInfo = { @@ -2316,6 +2153,7 @@ export type EmailInfo = { subject?: string | null; /** * From + * * who sent it */ from?: string | null; @@ -2329,10 +2167,11 @@ export type EmailInfo = { cc?: string | null; /** * Date + * * when it was sent (ISO 8601) */ date?: string | null; - [key: string]: unknown | string | null | string | null | string | null | string | null | string | null | undefined; + [key: string]: unknown; }; /** @@ -2341,10 +2180,11 @@ export type EmailInfo = { export type EmbedLink = { /** * Url + * * signed link to the embeddable player */ url: string; - [key: string]: unknown | string; + [key: string]: unknown; }; /** @@ -2413,23 +2253,7 @@ export type EntityDetail = { * Hidden */ hidden?: boolean; - [key: string]: - | unknown - | number - | string - | string - | null - | Array - | string - | null - | string - | null - | Array - | Array<{ - [key: string]: unknown; - }> - | boolean - | undefined; + [key: string]: unknown; }; /** @@ -2462,7 +2286,7 @@ export type EntityLink = { * Namespace */ namespace?: string | null; - [key: string]: unknown | number | string | null | string | null | undefined; + [key: string]: unknown; }; /** @@ -2471,6 +2295,7 @@ export type EntityLink = { export type EntityLinkRequest = { /** * With + * * the entity (in another namespace) that is the same thing */ with?: number; @@ -2502,19 +2327,7 @@ export type EntityList = { [key: string]: number; }; }; - [key: string]: - | unknown - | number - | Array<{ - [key: string]: unknown; - }> - | Array - | { - [key: string]: { - [key: string]: number; - }; - } - | undefined; + [key: string]: unknown; }; /** @@ -2543,7 +2356,7 @@ export type EntityMerged = { * Merge */ merge: number; - [key: string]: unknown | boolean | number | undefined; + [key: string]: unknown; }; /** @@ -2574,6 +2387,7 @@ export type EntityRename = { keep_alias?: boolean; /** * Correct + * * also correct the transcript lines that say the old name */ correct?: boolean; @@ -2611,10 +2425,11 @@ export type EntityType = { label: string; /** * Quiet + * * extracted but hidden unless a filter asks for it (dates, numbers) */ quiet: boolean; - [key: string]: unknown | string | boolean; + [key: string]: unknown; }; /** @@ -2642,6 +2457,7 @@ export type Estimate = { llm: LlmEstimate; /** * Would Replace + * * existing outputs the run would overwrite */ would_replace: number; @@ -2653,18 +2469,7 @@ export type Estimate = { * Confirm Text */ confirm_text?: string | null; - [key: string]: - | unknown - | number - | { - [key: string]: number; - } - | number - | LlmEstimate - | boolean - | string - | null - | undefined; + [key: string]: unknown; }; /** @@ -2679,8 +2484,7 @@ export type EventInfo = { * Label */ label: string; - [key: string]: - unknown | "job.succeeded" | "job.failed" | "job.cancelled" | "batch.finished" | "recording.added" | string; + [key: string]: unknown; }; /** @@ -2719,7 +2523,7 @@ export type FaceMerged = { * Merge */ merge: number; - [key: string]: unknown | boolean | number | undefined; + [key: string]: unknown; }; /** @@ -2748,21 +2552,25 @@ export type FaceSpeaker = { export type FacesMode = { /** * Mode + * * off, detect or recognize; left out, the mode stays as it is */ mode?: string | null; /** * Pixelate + * * pixelate the faces found in the pictures visitors see (public pages, embeds, share links, IIIF); members see them as they are. Needs faces detected */ pixelate?: boolean | null; /** * Purpose + * * why faces are recognised (required for recognize) */ purpose?: string | null; /** * Reprocess + * * queue face detection for this namespace's videos, documents and images */ reprocess?: boolean; @@ -2780,7 +2588,7 @@ export type FacesModeSet = { * Jobs */ jobs?: Array; - [key: string]: unknown | boolean | Array | undefined; + [key: string]: unknown; }; /** @@ -2793,10 +2601,11 @@ export type FacetCount = { name: string; /** * Count + * * matching moments */ count: number; - [key: string]: unknown | string | number; + [key: string]: unknown; }; /** @@ -2817,11 +2626,13 @@ export type FieldCreate = { target?: "resource" | "collection" | "file"; /** * Collection + * * define it on this collection of the namespace (default: the namespace) */ collection?: number | null; /** * Options + * * choice and choices fields */ options?: Array | null; @@ -2853,11 +2664,13 @@ export type FieldDef = { type: "text" | "longtext" | "number" | "date" | "boolean" | "choice" | "choices" | "link"; /** * Target + * * what it describes: the resources, the collections or the files inside where it's defined */ target: "resource" | "collection" | "file"; /** * Options + * * choice and choices fields: what may be chosen */ options?: Array | null; @@ -2867,16 +2680,19 @@ export type FieldDef = { help?: string | null; /** * Published + * * shown on public pages and in IIIF metadata; otherwise only in the workspace */ published: boolean; /** * Collection + * * the collection it's defined on; null: the namespace */ collection?: number | null; /** * Collection Path + * * that collection's names, from the top */ collection_path?: Array; @@ -2886,42 +2702,17 @@ export type FieldDef = { ord?: number | null; /** * Can Change + * * you may change or delete it: editors of where it's defined */ can_change: boolean; /** * Uses + * * how many items have a value for it (when asked for one field) */ uses?: number | null; - [key: string]: - | unknown - | number - | string - | "text" - | "longtext" - | "number" - | "date" - | "boolean" - | "choice" - | "choices" - | "link" - | "resource" - | "collection" - | "file" - | Array - | null - | string - | null - | boolean - | number - | null - | Array - | number - | null - | number - | null - | undefined; + [key: string]: unknown; }; /** @@ -2938,6 +2729,7 @@ export type FieldUpdate = { options?: Array | null; /** * Help + * * null clears it */ help?: string | null; @@ -2947,6 +2739,7 @@ export type FieldUpdate = { published?: boolean | null; /** * Ord + * * its place among the namespace's fields, lowest first */ ord?: number | null; @@ -2959,10 +2752,11 @@ export type FieldValue = { field: FieldDef; /** * Value + * * text, a number, a date (YYYY, YYYY-MM or YYYY-MM-DD), yes/no, an option or options, a link */ value?: unknown; - [key: string]: unknown | FieldDef | undefined; + [key: string]: unknown; }; /** @@ -2971,15 +2765,17 @@ export type FieldValue = { export type FieldValues = { /** * Fields + * * the fields that describe it, in order, with its values (null: none) */ fields: Array; /** * Can Change + * * you may change its values */ can_change: boolean; - [key: string]: unknown | Array | boolean; + [key: string]: unknown; }; /** @@ -2988,6 +2784,7 @@ export type FieldValues = { export type FieldValuesUpdate = { /** * Values + * * {"": its value, or null to clear it}; fields not named keep theirs */ values: { @@ -3005,6 +2802,7 @@ export type FileLine = { idx: number; /** * T0 + * * ms; none in a file that doesn't say when its lines are */ t0?: number | null; @@ -3014,46 +2812,35 @@ export type FileLine = { t1?: number | null; /** * Text + * * the line; for an index, its title, synopsis and keywords together */ text: string; /** * Speaker + * * who says it, as the file names them */ speaker?: string | null; /** * Title + * * an index entry's title */ title?: string | null; /** * Synopsis + * * an index entry's synopsis */ synopsis?: string | null; /** * Keywords + * * an index entry's keywords */ keywords?: Array | null; - [key: string]: - | unknown - | number - | number - | null - | number - | null - | string - | string - | null - | string - | null - | string - | null - | Array - | null - | undefined; + [key: string]: unknown; }; /** @@ -3068,7 +2855,7 @@ export type FileLines = { * Lines */ lines: Array; - [key: string]: unknown | number | Array; + [key: string]: unknown; }; /** @@ -3077,21 +2864,25 @@ export type FileLines = { export type FileUpdate = { /** * Role + * * a new role; transcripts, captions, translations and indexes are read again */ role?: "transcript" | "captions" | "translation" | "index" | "thumbnail" | "attachment" | null; /** * Language + * * null clears it */ language?: string | null; /** * Label + * * null clears it */ label?: string | null; /** * Description + * * null clears it */ description?: string | null; @@ -3131,16 +2922,7 @@ export type Graph = { edges: Array<{ [key: string]: unknown; }>; - [key: string]: - | unknown - | string - | Array - | Array<{ - [key: string]: unknown; - }> - | Array<{ - [key: string]: unknown; - }>; + [key: string]: unknown; }; /** @@ -3217,45 +2999,7 @@ export type GraphChange = { * Decided By */ decided_by?: string | null; - [key: string]: - | unknown - | number - | "merge" - | "link" - | { - [key: string]: unknown; - } - | { - [key: string]: unknown; - } - | Array - | string - | null - | number - | null - | { - [key: string]: unknown; - } - | null - | number - | null - | "proposed" - | "applied" - | "dismissed" - | "undone" - | number - | null - | number - | null - | number - | null - | string - | null - | string - | null - | string - | null - | undefined; + [key: string]: unknown; }; /** @@ -3264,6 +3008,7 @@ export type GraphChange = { export type GraphChangeAccept = { /** * Keep + * * for a merge: the entity to keep (default: the one proposed) */ keep?: number | null; @@ -3286,6 +3031,7 @@ export type Health = { database: HealthDatabase; /** * Queue + * * jobs by status */ queue: { @@ -3303,18 +3049,7 @@ export type Health = { sources: Array; disk: HealthDisk; counts: HealthCounts; - [key: string]: - | unknown - | HealthDatabase - | { - [key: string]: number; - } - | Array<{ - [key: string]: unknown; - }> - | Array - | HealthDisk - | HealthCounts; + [key: string]: unknown; }; /** @@ -3333,7 +3068,7 @@ export type HealthCounts = { * Accounts */ accounts: number; - [key: string]: unknown | number; + [key: string]: unknown; }; /** @@ -3350,6 +3085,7 @@ export type HealthDatabase = { embedded: boolean; /** * Fulltext + * * the full-text index keyword this SurrealDB uses (FULLTEXT or SEARCH); null: none */ fulltext?: string | null; @@ -3357,7 +3093,7 @@ export type HealthDatabase = { * Ok */ ok: boolean; - [key: string]: unknown | string | boolean | string | null | undefined; + [key: string]: unknown; }; /** @@ -3376,7 +3112,7 @@ export type HealthDisk = { * Total Gb */ total_gb: number; - [key: string]: unknown | string | number; + [key: string]: unknown; }; /** @@ -3401,15 +3137,7 @@ export type HealthSource = { health?: { [key: string]: unknown; } | null; - [key: string]: - | unknown - | number - | string - | { - [key: string]: unknown; - } - | null - | undefined; + [key: string]: unknown; }; /** @@ -3426,16 +3154,19 @@ export type Highlight = { recording: number; /** * T0 + * * where the passage starts, in ms from the start */ t0: number; /** * T1 + * * where it ends, in ms */ t1: number; /** * Quote + * * the words picked in the text */ quote?: string | null; @@ -3445,11 +3176,13 @@ export type Highlight = { colour: "yellow" | "green" | "blue" | "red"; /** * Label + * * what it marks, in a few words */ label?: string | null; /** * Created By + * * who made it: their email */ created_by?: string | null; @@ -3467,35 +3200,17 @@ export type Highlight = { updated_at?: string | null; /** * Mine + * * you made it */ mine: boolean; /** * Can Edit + * * you can change or delete it: you edit the resource */ can_edit: boolean; - [key: string]: - | unknown - | number - | string - | null - | "yellow" - | "green" - | "blue" - | "red" - | string - | null - | string - | null - | string - | null - | string - | null - | string - | null - | boolean - | undefined; + [key: string]: unknown; }; /** @@ -3504,16 +3219,19 @@ export type Highlight = { export type HighlightCreate = { /** * T0 + * * where the passage starts, in ms from the start */ t0: number; /** * T1 + * * where it ends, in ms (default: t0) */ t1?: number | null; /** * Quote + * * the words picked in the text */ quote?: string | null; @@ -3523,6 +3241,7 @@ export type HighlightCreate = { colour?: "yellow" | "green" | "blue" | "red"; /** * Label + * * what it marks, in a few words */ label?: string | null; @@ -3538,6 +3257,7 @@ export type HighlightUpdate = { colour?: "yellow" | "green" | "blue" | "red" | null; /** * Label + * * a new label; empty clears it */ label?: string | null; @@ -3565,11 +3285,13 @@ export type IiifImport = { limit?: number; /** * Wait + * * import before answering instead of in the background */ wait?: boolean; /** * Collection + * * a collection of the namespace to put them in; default: its default collection */ collection?: number | null; @@ -3591,7 +3313,7 @@ export type IiifImported = { * Status */ status?: string | null; - [key: string]: unknown | boolean | Array | null | string | null | undefined; + [key: string]: unknown; }; /** @@ -3612,6 +3334,7 @@ export type IiifPanel = { access: "public" | "restricted" | "private"; /** * Open + * * the parts anyone may use, when the recording is public */ open: Array<"media" | "transcript" | "index">; @@ -3621,6 +3344,7 @@ export type IiifPanel = { featured?: boolean; /** * Published + * * IIIF publishes public recordings */ published: boolean; @@ -3643,21 +3367,7 @@ export type IiifPanel = { json: { [key: string]: unknown; }; - [key: string]: - | unknown - | string - | "public" - | "restricted" - | "private" - | Array<"media" | "transcript" | "index"> - | boolean - | Array - | IiifValidation - | Array - | { - [key: string]: unknown; - } - | undefined; + [key: string]: unknown; }; /** @@ -3682,7 +3392,7 @@ export type IiifValidation = { * Problems */ problems: Array; - [key: string]: unknown | boolean | Array; + [key: string]: unknown; }; /** @@ -3713,11 +3423,12 @@ export type ImportPreview = { * Preview */ preview: Array; - [key: string]: unknown | string | string | null | number | Array | Array | undefined; + [key: string]: unknown; }; /** * ImportPreviewRequest + * * A file (``filename`` + base64 ``data``) or pasted ``text``. */ export type ImportPreviewRequest = { @@ -3731,6 +3442,7 @@ export type ImportPreviewRequest = { filename?: string | null; /** * Data + * * the file, base64 encoded */ data?: string | null; @@ -3754,6 +3466,7 @@ export type ImportRequest = { filename?: string | null; /** * Data + * * the file, base64 encoded */ data?: string | null; @@ -3763,6 +3476,7 @@ export type ImportRequest = { text?: string | null; /** * Namespace + * * created if it doesn't exist (admins only) */ namespace?: string; @@ -3772,16 +3486,19 @@ export type ImportRequest = { title?: string | null; /** * Speakers + * * rename speakers on the way in: "S1=Alice,S2=Bob" */ speakers?: string | null; /** * Pipeline + * * run this pipeline afterwards instead of the namespace's (GET /pipelines) */ pipeline?: number | null; /** * Collection + * * a collection of the namespace to put it in; default: its default collection */ collection?: number | null; @@ -3803,7 +3520,7 @@ export type ImportResult = { * Job */ job: number; - [key: string]: unknown | boolean | number | undefined; + [key: string]: unknown; }; /** @@ -3818,11 +3535,12 @@ export type ImportedAs = { * Namespace */ namespace: string; - [key: string]: unknown | number | string; + [key: string]: unknown; }; /** * IpGroup + * * Address ranges whose visitors see all of some of the namespace's recordings without signing in (docs/access.md). */ export type IpGroup = { @@ -3836,21 +3554,25 @@ export type IpGroup = { name: string; /** * Ranges + * * addresses and CIDR ranges */ ranges: Array; /** * Everything + * * opens every recording in the namespace; else the ones chosen on each recording */ everything: boolean; /** * Chosen + * * how many recordings it opens when it doesn't open everything */ chosen?: number; /** * Here + * * the address you're asking from is in it */ here?: boolean; @@ -3870,21 +3592,7 @@ export type IpGroup = { * Updated At */ updated_at?: string | null; - [key: string]: - | unknown - | number - | string - | Array - | boolean - | string - | null - | string - | null - | string - | null - | string - | null - | undefined; + [key: string]: unknown; }; /** @@ -3897,11 +3605,13 @@ export type IpGroupCreate = { name: string; /** * Ranges + * * addresses (203.0.113.7) or CIDR ranges (203.0.113.0/24) */ ranges: Array; /** * Everything + * * open every recording in the namespace; else choose them on each recording */ everything?: boolean; @@ -3931,6 +3641,7 @@ export type IpGroupUpdate = { export type IpGroups = { /** * Address + * * your address as the server sees it; null when it can't tell (see server.trusted_proxies) */ address?: string | null; @@ -3938,7 +3649,7 @@ export type IpGroups = { * Groups */ groups: Array; - [key: string]: unknown | string | null | Array | undefined; + [key: string]: unknown; }; /** @@ -3987,6 +3698,7 @@ export type Job = { error?: string | null; /** * Title + * * the recording's title */ title?: string | null; @@ -4028,79 +3740,35 @@ export type Job = { cancel_requested?: boolean | null; /** * Log + * * the last 200 lines; GET /jobs/{jid}/log has them all */ log?: Array | null; /** * Log Total + * * how many lines the run has logged */ log_total?: number | null; /** * Step Runs + * * GET /jobs/{jid}: one per step, in order: how its latest run went (null until it has run; runs from before these were kept have none) */ step_runs?: Array | null; /** * Estimates + * * GET /jobs/{jid}: how long each step usually takes on this recording, in seconds, from recent runs (null for a step with none) */ estimates?: Array | null; /** * Eta Seconds + * * GET /jobs/{jid}, while queued or running: about how long until it finishes, from `estimates` */ eta_seconds?: number | null; - [key: string]: - | unknown - | number - | number - | null - | number - | null - | number - | null - | JobPipeline - | null - | Array - | number - | null - | string - | null - | string - | string - | null - | string - | null - | number - | null - | string - | null - | number - | null - | string - | null - | string - | null - | string - | null - | string - | null - | string - | null - | boolean - | null - | Array - | null - | number - | null - | Array - | null - | Array - | null - | number - | null - | undefined; + [key: string]: unknown; }; /** @@ -4113,6 +3781,7 @@ export type JobList = { jobs: Array; /** * Counts + * * jobs of each status (in `namespace` and `batch`, whatever `status`) */ counts: { @@ -4120,6 +3789,7 @@ export type JobList = { }; /** * Namespaces + * * jobs in each namespace you can read (in `batch`, whatever `status`) */ namespaces?: { @@ -4131,11 +3801,13 @@ export type JobList = { running: boolean; /** * Step + * * the latest job's current (or last) step */ step?: unknown; /** * Returncode + * * the latest job: null while active, 0 succeeded, 1 otherwise */ returncode?: number | null; @@ -4143,20 +3815,7 @@ export type JobList = { * Log */ log?: string; - [key: string]: - | unknown - | Array - | { - [key: string]: number; - } - | { - [key: string]: number; - } - | boolean - | number - | null - | string - | undefined; + [key: string]: unknown; }; /** @@ -4165,6 +3824,7 @@ export type JobList = { export type JobLog = { /** * Start + * * the number of the first line here (0-based) */ start: number; @@ -4174,15 +3834,17 @@ export type JobLog = { lines: Array; /** * Total + * * how many lines the run has logged so far */ total: number; /** * More + * * whether there are lines after these */ more: boolean; - [key: string]: unknown | number | Array | boolean; + [key: string]: unknown; }; /** @@ -4191,11 +3853,13 @@ export type JobLog = { export type JobPipeline = { /** * Id + * * null for the standard steps */ id?: number | null; /** * Version + * * the version the run pinned when it was queued */ version?: number | null; @@ -4203,7 +3867,7 @@ export type JobPipeline = { * Name */ name: string; - [key: string]: unknown | number | null | number | null | string | undefined; + [key: string]: unknown; }; /** @@ -4218,7 +3882,7 @@ export type JobQueued = { * Job */ job: number; - [key: string]: unknown | boolean | number | undefined; + [key: string]: unknown; }; /** @@ -4244,6 +3908,7 @@ export type JobsCreate = { pipeline?: number | null; /** * Namespace + * * also queue everything in this namespace that still needs work */ namespace?: string | null; @@ -4261,7 +3926,7 @@ export type JobsQueued = { * Jobs */ jobs: Array; - [key: string]: unknown | boolean | Array | undefined; + [key: string]: unknown; }; /** @@ -4270,6 +3935,7 @@ export type JobsQueued = { export type LanguageCount = { /** * Language + * * a language code; null: not known */ language?: string | null; @@ -4277,7 +3943,7 @@ export type LanguageCount = { * Recordings */ recordings: number; - [key: string]: unknown | string | null | number | undefined; + [key: string]: unknown; }; /** @@ -4294,6 +3960,7 @@ export type LastSend = { ok: boolean; /** * Code + * * the HTTP status it answered with */ code?: number | null; @@ -4305,7 +3972,7 @@ export type LastSend = { * Event */ event?: string | null; - [key: string]: unknown | string | boolean | number | null | string | null | string | null | undefined; + [key: string]: unknown; }; /** @@ -4332,7 +3999,7 @@ export type LlmEstimate = { * Model */ model?: string | null; - [key: string]: unknown | number | number | null | string | null | undefined; + [key: string]: unknown; }; /** @@ -4359,7 +4026,7 @@ export type LlmTestResult = { * Model */ model?: string | null; - [key: string]: unknown | boolean | string | null | string | null | number | null | string | null | undefined; + [key: string]: unknown; }; /** @@ -4383,6 +4050,7 @@ export type Me = { user: UserPublic; /** * Roles + * * namespace name -> role */ roles: { @@ -4390,6 +4058,7 @@ export type Me = { }; /** * Partial + * * namespaces you have no role in but see some collections of (roles on collections) */ partial?: Array; @@ -4401,19 +4070,7 @@ export type Me = { * Scope */ scope: "read" | "write"; - [key: string]: - | unknown - | UserPublic - | { - [key: string]: "viewer" | "editor" | "owner"; - } - | Array - | "access" - | "token" - | "oauth" - | "read" - | "write" - | undefined; + [key: string]: unknown; }; /** @@ -4422,6 +4079,7 @@ export type Me = { export type MeUpdate = { /** * Name + * * whitespace is collapsed */ name: string; @@ -4447,11 +4105,12 @@ export type Member = { * Name */ name?: string | null; - [key: string]: unknown | number | "viewer" | "editor" | "owner" | string | null | string | null | undefined; + [key: string]: unknown; }; /** * MemberSet + * * Who (by email, or by account id) and their role; a null role removes them from the namespace. */ export type MemberSet = { @@ -4501,7 +4160,7 @@ export type Mention = { * Recorded At */ recorded_at?: string; - [key: string]: unknown | number | string | null | string | null | string | null | string | null | string | undefined; + [key: string]: unknown; }; /** @@ -4518,12 +4177,7 @@ export type MentionList = { items: Array<{ [key: string]: unknown; }>; - [key: string]: - | unknown - | number - | Array<{ - [key: string]: unknown; - }>; + [key: string]: unknown; }; /** @@ -4532,11 +4186,13 @@ export type MentionList = { export type MentionMove = { /** * Target + * * an entity in the same namespace */ target?: number | null; /** * New Name + * * or a new (or existing) entity by name */ new_name?: string | null; @@ -4546,6 +4202,7 @@ export type MentionMove = { new_type?: string | null; /** * Remove + * * or say this mention isn't an entity at all */ remove?: boolean; @@ -4563,7 +4220,7 @@ export type MentionMoved = { * Entity */ entity?: number | null; - [key: string]: unknown | boolean | number | null | undefined; + [key: string]: unknown; }; /** @@ -4572,11 +4229,13 @@ export type MentionMoved = { export type MessageCreate = { /** * Content + * * the question (up to 4000 characters) */ content: string; /** * Model + * * answer this one with another model (one of GET /chats/capabilities `models`), e.g. to retry */ model?: string | null; @@ -4592,6 +4251,7 @@ export type MetadataBulk = { recordings?: Array; /** * Namespace + * * every recording in this namespace (added to `recordings`) */ namespace?: string | null; @@ -4607,6 +4267,7 @@ export type MetadataBulk = { clear?: Array; /** * Dry Run + * * report what would change without changing it */ dry_run?: boolean; @@ -4632,7 +4293,7 @@ export type MetadataBulkResult = { * Changed */ changed?: number | null; - [key: string]: unknown | number | Array | number | null | number | null | undefined; + [key: string]: unknown; }; /** @@ -4667,21 +4328,7 @@ export type MetadataEdit = { after: { [key: string]: unknown; }; - [key: string]: - | unknown - | number - | string - | null - | string - | null - | Array - | { - [key: string]: unknown; - } - | { - [key: string]: unknown; - } - | undefined; + [key: string]: unknown; }; /** @@ -4690,6 +4337,7 @@ export type MetadataEdit = { export type MonthStats = { /** * Month + * * YYYY-MM */ month: string; @@ -4699,10 +4347,11 @@ export type MonthStats = { recordings?: number; /** * Ms + * * how long they are together */ ms?: number; - [key: string]: unknown | string | number | undefined; + [key: string]: unknown; }; /** @@ -4727,6 +4376,7 @@ export type Namespace = { recordings?: number; /** * Ms + * * total duration of its recordings */ ms?: number; @@ -4744,33 +4394,23 @@ export type Namespace = { speakers?: number; /** * Role + * * your role in it; null when you see only some of its collections */ role?: "viewer" | "editor" | "owner" | null; /** * Partial + * * you see only the collections you were given a role on */ partial?: boolean; /** * Wordcloud + * * signed link to the namespace word cloud (SVG) */ wordcloud?: string | null; - [key: string]: - | unknown - | number - | string - | string - | null - | "viewer" - | "editor" - | "owner" - | null - | boolean - | string - | null - | undefined; + [key: string]: unknown; }; /** @@ -4785,7 +4425,7 @@ export type NamespaceAccess = { * Open */ open: Array<"media" | "transcript" | "index">; - [key: string]: unknown | "public" | "restricted" | "private" | Array<"media" | "transcript" | "index">; + [key: string]: unknown; }; /** @@ -4794,6 +4434,7 @@ export type NamespaceAccess = { export type NamespaceCreate = { /** * Name + * * lowercase letters, digits, - and _ */ name: string; @@ -4809,11 +4450,13 @@ export type NamespaceCreate = { export type NamespaceFaces = { /** * Mode + * * off, detect or recognize */ mode: string; /** * Pixelate + * * faces are pixelated in the pictures visitors see */ pixelate?: boolean; @@ -4841,23 +4484,7 @@ export type NamespaceFaces = { merges: Array<{ [key: string]: unknown; }>; - [key: string]: - | unknown - | string - | boolean - | string - | null - | string - | null - | string - | null - | Array<{ - [key: string]: unknown; - }> - | Array<{ - [key: string]: unknown; - }> - | undefined; + [key: string]: unknown; }; /** @@ -4880,17 +4507,7 @@ export type NamespaceMetadata = { profile: { [key: string]: unknown; }; - [key: string]: - | unknown - | string - | null - | { - [key: string]: unknown; - } - | { - [key: string]: unknown; - } - | undefined; + [key: string]: unknown; }; /** @@ -4917,72 +4534,70 @@ export type NamespaceMetadataUpdate = { export type NamespaceStats = { /** * From + * * the first day of the range (YYYY-MM-DD); null when open */ from?: string | null; /** * To + * * the last day of the range; null when open */ to?: string | null; /** * Recordings + * * recordings made in the range (without a range: all of them, dated or not) */ recordings: number; /** * Ms + * * how long they are together */ ms: number; /** * Speakers + * * speakers heard in them */ speakers: number; /** * Undated + * * the namespace's recordings without a date: counted only when there's no range */ undated?: number; /** * First + * * the day of the earliest dated recording in the range */ first?: string | null; /** * Last + * * the day of the latest dated recording in the range */ last?: string | null; /** * Months + * * each calendar month from `from` (else the first recording) to `to` (else the later of today and the last recording), empty ones included; at most the latest 240 */ months?: Array; /** * Top Speakers + * * by talk time in the range, most first */ top_speakers?: Array; - [key: string]: - | unknown - | string - | null - | string - | null - | number - | string - | null - | string - | null - | Array - | Array - | undefined; + [key: string]: unknown; }; /** * NamespaceUpdate + * * Only the fields you send change; send ``pipeline: null`` to go back to the default pipeline. */ export type NamespaceUpdate = { @@ -4996,6 +4611,7 @@ export type NamespaceUpdate = { pipeline?: number | null; /** * Pipelines + * * the namespace's own pipeline per content subtype (by key); null drops the override */ pipelines?: { @@ -5017,20 +4633,23 @@ export type NodeType = { settings: Array; /** * Scopes + * * the workflow scopes it can be used in */ scopes?: Array; /** * Inputs + * * how many edges may come in: 0, 1, or -1 for any number */ inputs: number; /** * Outputs + * * its outgoing ports: [] for none, ['out'], or a condition's ['yes', 'no'] */ outputs: Array; - [key: string]: unknown | string | Array | Array | number | Array | undefined; + [key: string]: unknown; }; /** @@ -5051,31 +4670,37 @@ export type Note = { text: string; /** * T0 + * * the moment it's about, in ms from the start; null: the whole recording */ t0?: number | null; /** * T1 + * * where that moment ends, in ms */ t1?: number | null; /** * Quote + * * the words picked in the transcript */ quote?: string | null; /** * Shared + * * everyone who can read the recording sees it */ shared?: boolean; /** * Created By + * * its writer's email */ created_by?: string | null; /** * Created By Name + * * its writer's name, when they gave one */ created_by_name?: string | null; @@ -5089,41 +4714,23 @@ export type Note = { updated_at?: string | null; /** * Edited At + * * when its text last changed */ edited_at?: string | null; /** * Mine + * * you wrote it: only you can change it */ mine: boolean; /** * Can Delete + * * you wrote it, or it's shared and you own the recording's namespace */ can_delete: boolean; - [key: string]: - | unknown - | number - | string - | number - | null - | number - | null - | string - | null - | boolean - | string - | null - | string - | null - | string - | null - | string - | null - | string - | null - | undefined; + [key: string]: unknown; }; /** @@ -5136,21 +4743,25 @@ export type NoteCreate = { text: string; /** * T0 + * * the moment it's about, in ms from the start; leave out for the whole recording */ t0?: number | null; /** * T1 + * * where that moment ends, in ms (default: t0) */ t1?: number | null; /** * Quote + * * the words picked in the transcript */ quote?: string | null; /** * Shared + * * share it with everyone who can read the recording (needs editor access) */ shared?: boolean; @@ -5166,6 +4777,7 @@ export type NoteUpdate = { text?: string | null; /** * Shared + * * share or unshare it (sharing needs editor access) */ shared?: boolean | null; @@ -5201,6 +4813,7 @@ export type NotifyDelivery = { error?: string | null; /** * Text + * * the message, as chat targets get it */ text?: string | null; @@ -5214,29 +4827,11 @@ export type NotifyDelivery = { sent_at?: string | null; /** * Next At + * * when it's tried again, while pending */ next_at?: string | null; - [key: string]: - | unknown - | string - | "pending" - | "sending" - | "sent" - | "failed" - | "dropped" - | number - | number - | null - | string - | null - | string - | null - | string - | null - | string - | null - | undefined; + [key: string]: unknown; }; /** @@ -5245,10 +4840,11 @@ export type NotifyDelivery = { export type NotifySecret = { /** * Secret + * * the webhook's new signing secret, shown this once */ secret: string; - [key: string]: unknown | string; + [key: string]: unknown; }; /** @@ -5269,6 +4865,7 @@ export type NotifyTarget = { kind: "webhook" | "matterbridge" | "slack" | "discord"; /** * Url + * * scheme, host and port of its address; the rest stays sealed */ url?: string | null; @@ -5282,21 +4879,25 @@ export type NotifyTarget = { enabled: boolean; /** * Gateway + * * Matterbridge: the gateway it sends to */ gateway?: string | null; /** * Username + * * Matterbridge: the name messages are sent under */ username?: string | null; /** * Secret Set + * * webhook: deliveries are signed */ secret_set?: boolean; /** * Token Set + * * Matterbridge: an API token is sent */ token_set?: boolean; @@ -5320,33 +4921,7 @@ export type NotifyTarget = { * Updated At */ updated_at?: string | null; - [key: string]: - | unknown - | number - | string - | "webhook" - | "matterbridge" - | "slack" - | "discord" - | string - | null - | Array<"job.succeeded" | "job.failed" | "job.cancelled" | "batch.finished" | "recording.added"> - | boolean - | string - | null - | string - | null - | LastSend - | null - | string - | null - | string - | null - | string - | null - | string - | null - | undefined; + [key: string]: unknown; }; /** @@ -5363,11 +4938,13 @@ export type NotifyTargetCreate = { kind: "webhook" | "matterbridge" | "slack" | "discord"; /** * Url + * * where to POST: the webhook's URL, or the Matterbridge API's address (/api/message is added) */ url: string; /** * Events + * * default: job.failed and batch.finished */ events?: Array<"job.succeeded" | "job.failed" | "job.cancelled" | "batch.finished" | "recording.added"> | null; @@ -5377,16 +4954,19 @@ export type NotifyTargetCreate = { enabled?: boolean; /** * Gateway + * * Matterbridge: the [[gateway]] name to send to */ gateway?: string | null; /** * Username + * * Matterbridge: the name to send as (default Lens) */ username?: string | null; /** * Token + * * Matterbridge: the API token ([api] Token), if it has one */ token?: string | null; @@ -5399,10 +4979,11 @@ export type NotifyTargetCreated = { target: NotifyTarget; /** * Secret + * * webhook: the signing secret, shown this once */ secret?: string | null; - [key: string]: unknown | NotifyTarget | string | null | undefined; + [key: string]: unknown; }; /** @@ -5415,6 +4996,7 @@ export type NotifyTargetUpdate = { name?: string | null; /** * Url + * * a new address, in full; leave it out to keep the one saved */ url?: string | null; @@ -5436,6 +5018,7 @@ export type NotifyTargetUpdate = { username?: string | null; /** * Token + * * Matterbridge: a new token; "" removes it */ token?: string | null; @@ -5455,10 +5038,11 @@ export type NotifyTargets = { targets: Array; /** * Enabled + * * notifications are on for the server (an admin's notifications.enabled) */ enabled: boolean; - [key: string]: unknown | Array | Array | boolean; + [key: string]: unknown; }; /** @@ -5477,11 +5061,12 @@ export type NotifyTestResult = { * Error */ error?: string | null; - [key: string]: unknown | boolean | number | null | string | null | undefined; + [key: string]: unknown; }; /** * OAuthGrant + * * An app you gave access to. */ export type OAuthGrant = { @@ -5515,11 +5100,11 @@ export type OAuthGrant = { last_used_at?: string | null; /** * Expires At + * * when its access ends unless the app renews it before */ expires_at?: string | null; - [key: string]: - unknown | number | string | string | null | "read" | "read write" | string | null | string | null | undefined; + [key: string]: unknown; }; /** @@ -5536,6 +5121,7 @@ export type OAuthTokens = { token_type?: "Bearer"; /** * Expires In + * * seconds until the access token expires */ expires_in: number; @@ -5547,7 +5133,7 @@ export type OAuthTokens = { * Scope */ scope: "read" | "read write"; - [key: string]: unknown | string | "Bearer" | number | "read" | "read write" | undefined; + [key: string]: unknown; }; /** @@ -5556,6 +5142,7 @@ export type OAuthTokens = { export type ObjectCount = { /** * Object + * * a kind of object (person, car, dog …) */ object: string; @@ -5563,7 +5150,7 @@ export type ObjectCount = { * Recordings */ recordings: number; - [key: string]: unknown | string | number; + [key: string]: unknown; }; /** @@ -5572,93 +5159,92 @@ export type ObjectCount = { export type ObjectFacet = { /** * Name + * * a kind of object (person, car …) */ name: string; /** * Count + * * how many of the recordings with matching moments it's seen in */ count: number; - [key: string]: unknown | string | number; + [key: string]: unknown; }; /** * ObjectTrack + * * A kind of object seen in a recording, and where. */ export type ObjectTrack = { /** * Label + * * what it is (person, car, dog …: the COCO dataset's kinds, with the default engine) */ label: string; /** * Spans + * * [from, to) where it's seen: ms, or page numbers from 0 when `paged` */ spans: Array>; /** * Screen Ms + * * how long it's seen (ms), or on how many pages when `paged` */ screen_ms: number; /** * First Ms + * * where it's first seen: ms, or a page number when `paged` */ first_ms: number; /** * Count + * * how many times it was found (on how many sampled frames or pages, and side by side) */ count: number; /** * Score + * * how sure the detector was, on average (0-1) */ score: number; /** * Frame + * * signed link to the frame or page it's best seen on */ frame?: string | null; /** * Box + * * where it is on that frame or page: [x, y, w, h] as fractions */ box?: Array | null; /** * Boxes + * * each place it was found: [t (ms, or page), x, y, w, h, score] (at most 500) */ boxes?: Array>; /** * Paged + * * true for a document's or an image's pages */ paged?: boolean | null; /** * Engine + * * the detector: yolox or ultralytics */ engine?: string | null; - [key: string]: - | unknown - | string - | Array> - | number - | number - | string - | null - | Array - | null - | Array> - | boolean - | null - | string - | null - | undefined; + [key: string]: unknown; }; /** @@ -5679,7 +5265,7 @@ export type Ok = { * Ok */ ok?: boolean; - [key: string]: unknown | boolean | undefined; + [key: string]: unknown; }; /** @@ -5688,6 +5274,7 @@ export type Ok = { export type OriginCount = { /** * Origin + * * source:, upload, paste, iiif, folder (the archive's own folders) or file */ origin: string; @@ -5699,7 +5286,7 @@ export type OriginCount = { * Recordings */ recordings: number; - [key: string]: unknown | string | number; + [key: string]: unknown; }; /** @@ -5722,21 +5309,24 @@ export type Output = { * Created At */ created_at?: string | null; - [key: string]: unknown | string | string | null | undefined; + [key: string]: unknown; }; /** * Page + * * A page of a document, or an image (a TIFF has one per frame). */ export type Page = { /** * Idx + * * from 0 */ idx: number; /** * Width + * * pixels of its image */ width?: number | null; @@ -5746,46 +5336,35 @@ export type Page = { height?: number | null; /** * Image + * * a signed link to it, drawn; none when it couldn't be */ image?: string | null; /** * Thumb + * * a signed link to it, small */ thumb?: string | null; /** * Text + * * how its text was read: from the PDF, or by OCR; none without text */ text?: "pdf" | "ocr" | null; /** * Chars + * * characters of text on it */ chars?: number; /** * Label + * * the PDF's own name for it (iv, A-1, …) when it isn't its number */ label?: string | null; - [key: string]: - | unknown - | number - | number - | null - | number - | null - | string - | null - | string - | null - | "pdf" - | "ocr" - | null - | string - | null - | undefined; + [key: string]: unknown; }; /** @@ -5818,11 +5397,13 @@ export type Passage = { t0?: number | number | null; /** * Time + * * when it was said ("12:34"), or for a document its page ("p. 3") */ time?: string | null; /** * Page + * * a document's or an image's page it's on (from 0) */ page?: number | null; @@ -5836,31 +5417,11 @@ export type Passage = { text: string; /** * Used + * * cited in the answer */ used?: boolean | null; - [key: string]: - | unknown - | number - | string - | null - | string - | null - | string - | null - | number - | number - | null - | string - | null - | number - | null - | string - | null - | string - | boolean - | null - | undefined; + [key: string]: unknown; }; /** @@ -5873,6 +5434,7 @@ export type PasswordChange = { current_password: string; /** * New Password + * * at least 10 characters */ new_password: string; @@ -5880,6 +5442,7 @@ export type PasswordChange = { /** * Permission + * * Someone given permission on a recording (docs/access.md): they see all of it on the pages visitors see and in * IIIF, whatever its access. */ @@ -5898,6 +5461,7 @@ export type Permission = { name?: string | null; /** * By + * * who gave it */ by?: string | null; @@ -5905,7 +5469,7 @@ export type Permission = { * At */ at?: string | null; - [key: string]: unknown | number | string | string | null | string | null | string | null | undefined; + [key: string]: unknown; }; /** @@ -5914,6 +5478,7 @@ export type Permission = { export type PermissionAdd = { /** * Email + * * the address of an account in this archive */ email: string; @@ -5970,26 +5535,7 @@ export type Pipeline = { * History */ history?: Array; - [key: string]: - | unknown - | number - | string - | string - | null - | string - | null - | string - | null - | Array<{ - [key: string]: unknown; - }> - | PipelineGraph - | string - | null - | string - | null - | Array - | undefined; + [key: string]: unknown; }; /** @@ -5998,6 +5544,7 @@ export type Pipeline = { export type PipelineCatalog = { /** * Standard + * * the built-in pipeline */ standard: Array; @@ -6007,16 +5554,19 @@ export type PipelineCatalog = { step_types: Array; /** * Asset Steps + * * steps that make something of the media */ asset_steps?: Array; /** * Base Types + * * video, audio, image and text */ base_types?: Array; /** * Conditions + * * keys a step's `when` may use */ conditions: Array; @@ -6024,15 +5574,7 @@ export type PipelineCatalog = { * Pipelines */ pipelines: Array; - [key: string]: - | unknown - | Array - | Array - | Array - | Array - | Array - | Array - | undefined; + [key: string]: unknown; }; /** @@ -6045,6 +5587,7 @@ export type PipelineCreate = { name: string; /** * Steps + * * the steps in order; or send a graph instead */ steps?: Array< @@ -6062,11 +5605,13 @@ export type PipelineCreate = { /** * PipelineGraph + * * A pipeline as the canvas draws it: steps as nodes, an edge saying its target runs after its source. */ export type PipelineGraph = { /** * Nodes + * * {id, step, x, y} */ nodes: Array<{ @@ -6074,6 +5619,7 @@ export type PipelineGraph = { }>; /** * Edges + * * {source, target} */ edges?: Array<{ @@ -6117,31 +5663,23 @@ export type PipelineSummary = { updated_at?: string | null; /** * Namespaces + * * namespaces that use it by default */ namespaces?: Array; /** * Content Types + * * namespaces that use it for one content subtype */ content_types?: Array; /** * Subtypes + * * content subtypes whose pipeline it is */ subtypes?: Array; - [key: string]: - | unknown - | number - | string - | string - | null - | string - | null - | Array - | Array - | Array - | undefined; + [key: string]: unknown; }; /** @@ -6150,6 +5688,7 @@ export type PipelineSummary = { export type PipelineVersionCreate = { /** * Steps + * * the steps in order; or send a graph instead */ steps?: Array< @@ -6189,7 +5728,7 @@ export type PipelineVersionInfo = { * Created By */ created_by?: string | null; - [key: string]: unknown | number | string | null | string | null | string | null | undefined; + [key: string]: unknown; }; /** @@ -6202,14 +5741,16 @@ export type Placed = { ok?: boolean; /** * Moved + * * how many weren't in it already */ moved: number; - [key: string]: unknown | boolean | number | undefined; + [key: string]: unknown; }; /** * Player + * * Everything the player shows: transcript, speakers, sections, entities and, for videos, shots and faces; for * documents and images, their pages. */ @@ -6236,6 +5777,7 @@ export type Player = { duration_ms?: number | null; /** * Audio + * * signed audio link, or null when there is no audio */ audio?: string | null; @@ -6247,6 +5789,7 @@ export type Player = { }>; /** * Segments + * * the lines: t0, t1 (ms), s (speaker key), text, e (emotion), v (event), and w, the timed words as [c0, c1, t0, t1] (a character range of text, ms) when transcription gave them; a document's or an image's blocks of text have p, their page (from 0), and b, where they are on it ([x, y, w, h] as fractions of the page), and times that are only a reading pace */ segments?: Array<{ @@ -6280,6 +5823,7 @@ export type Player = { } | null; /** * Media + * * kind: audio, video, document or image (audio for a transcript without media), and its size */ media?: { @@ -6287,72 +5831,35 @@ export type Player = { } | null; /** * Pages + * * a document's or an image's pages, in order */ pages?: Array | null; /** * Objects + * * videos, documents and images: the kinds of object seen in it, the most seen first */ objects?: Array; /** * Descriptions + * * videos, documents and images: what each shot or page shows, by a model that can see */ descriptions?: Array; /** * Faces Mode + * * the namespace's face mode: off, detect or recognize */ faces_mode?: string; /** * Faces Pixelate + * * the namespace pixelates faces in the pictures visitors see */ faces_pixelate?: boolean; - [key: string]: - | unknown - | number - | string - | null - | string - | null - | string - | null - | number - | null - | string - | null - | Array<{ - [key: string]: unknown; - }> - | Array<{ - [key: string]: unknown; - }> - | Array<{ - [key: string]: unknown; - }> - | Array<{ - [key: string]: unknown; - }> - | Array - | Array - | null - | { - [key: string]: unknown; - } - | null - | { - [key: string]: unknown; - } - | null - | Array - | null - | Array - | Array - | string - | boolean - | undefined; + [key: string]: unknown; }; /** @@ -6371,11 +5878,12 @@ export type PreviewLine = { * Text */ text: string; - [key: string]: unknown | string | string | null | undefined; + [key: string]: unknown; }; /** * PrimaryFile + * * The audio, video, document or image the resource's pipeline runs on. */ export type PrimaryFile = { @@ -6389,6 +5897,7 @@ export type PrimaryFile = { kind: "audio" | "video" | "document" | "image"; /** * Size + * * bytes */ size?: number | null; @@ -6398,34 +5907,22 @@ export type PrimaryFile = { content_type?: string | null; /** * Download + * * a signed link to it */ download: string; /** * Pdf + * * a document that isn't a PDF: a signed link to the PDF made of it */ pdf?: string | null; - [key: string]: - | unknown - | string - | null - | "audio" - | "video" - | "document" - | "image" - | number - | null - | string - | null - | string - | string - | null - | undefined; + [key: string]: unknown; }; /** * PublicCard + * * A recording in a list, as this visitor may see it: a locked one (restricted, signed in without permission) shows * its title only. */ @@ -6472,37 +5969,11 @@ export type PublicCard = { summary?: string | null; /** * Poster + * * signed link to a video's first frame, when the visitor may play it */ poster?: string | null; - [key: string]: - | unknown - | number - | string - | null - | string - | null - | string - | null - | number - | null - | "audio" - | "video" - | "transcript" - | "document" - | "image" - | "full" - | "public" - | "locked" - | "public" - | "restricted" - | "private" - | boolean - | string - | null - | string - | null - | undefined; + [key: string]: unknown; }; /** @@ -6521,7 +5992,7 @@ export type PublicChapter = { * Title */ title?: string | null; - [key: string]: unknown | number | number | null | string | null | undefined; + [key: string]: unknown; }; /** @@ -6556,16 +6027,19 @@ export type PublicCollection = { } | null; /** * Member + * * the visitor has a role in this namespace, so they see all of its recordings */ member: boolean; /** * Network + * * the IP group that opens all of its recordings to the visitor's address */ network?: string | null; /** * Total + * * how many recordings this visitor sees here, on all pages */ total: number; @@ -6573,25 +6047,7 @@ export type PublicCollection = { * Items */ items: Array; - [key: string]: - | unknown - | string - | string - | null - | string - | null - | string - | null - | { - [key: string]: unknown; - } - | null - | boolean - | string - | null - | number - | Array - | undefined; + [key: string]: unknown; }; /** @@ -6612,6 +6068,7 @@ export type PublicCollectionSummary = { summary?: string | null; /** * Recordings + * * how many of its recordings this visitor sees */ recordings: number; @@ -6621,10 +6078,11 @@ export type PublicCollectionSummary = { member: boolean; /** * Network + * * the IP group that opens all of it to the visitor's address */ network?: string | null; - [key: string]: unknown | string | string | null | number | boolean | string | null | undefined; + [key: string]: unknown; }; /** @@ -6643,11 +6101,12 @@ export type PublicDownload = { * Url */ url: string; - [key: string]: unknown | string; + [key: string]: unknown; }; /** * PublicFile + * * A supplementary file a visitor may download: it follows the part its role does (transcripts, captions and * translations the transcript, indexes the index, thumbnails the media); attachments need permission. */ @@ -6674,6 +6133,7 @@ export type PublicFile = { language?: string | null; /** * Size + * * bytes */ size: number; @@ -6683,10 +6143,11 @@ export type PublicFile = { content_type?: string | null; /** * Url + * * a signed link to download it */ url: string; - [key: string]: unknown | number | string | string | null | string | null | string | null | undefined; + [key: string]: unknown; }; /** @@ -6695,20 +6156,23 @@ export type PublicFile = { export type PublicHit = { /** * T0 + * * where the line starts, in ms */ t0: number; /** * Snippet + * * the line around the match, HTML-escaped, with around what was found */ snippet: string; /** * Page + * * a document's or an image's text: the page it's on (from 0) */ page?: number | null; - [key: string]: unknown | number | string | number | null | undefined; + [key: string]: unknown; }; /** @@ -6717,20 +6181,23 @@ export type PublicHit = { export type PublicHome = { /** * Featured + * * featured public recordings, newest first */ featured: Array; /** * Shared + * * recordings the visitor was given permission on, outside their namespaces */ shared?: Array; /** * Collections + * * the collections this visitor sees anything in */ collections: Array; - [key: string]: unknown | Array | Array | Array | undefined; + [key: string]: unknown; }; /** @@ -6739,6 +6206,7 @@ export type PublicHome = { export type PublicMedia = { /** * Url + * * signed link to the audio or video; to a document's or an image's file, to save */ url: string; @@ -6756,60 +6224,46 @@ export type PublicMedia = { height?: number | null; /** * Poster + * * signed link to a video's first frame, or a document's first page */ poster?: string | null; /** * Envelope + * * loudness over time, for drawing the waveform */ envelope?: Array | null; /** * Pages + * * a document's or an image's pages */ pages?: Array | null; /** * File + * * a document's or an image's file, in words: PDF, Word document, email, image, … */ file?: string | null; /** * Pdf + * * a document that isn't a PDF: signed link to the PDF made of it */ pdf?: string | null; - [key: string]: - | unknown - | string - | "audio" - | "video" - | "document" - | "image" - | number - | null - | number - | null - | string - | null - | Array - | null - | Array - | null - | string - | null - | string - | null - | undefined; + [key: string]: unknown; }; /** * PublicPage + * * A page of a document, or an image, drawn. */ export type PublicPage = { /** * Idx + * * from 0 */ idx: number; @@ -6823,25 +6277,28 @@ export type PublicPage = { height?: number | null; /** * Image + * * signed link to it, drawn; none when it couldn't be */ image?: string | null; /** * Thumb + * * signed link to it, small */ thumb?: string | null; /** * Label + * * the PDF's own name for it, when it isn't its number */ label?: string | null; - [key: string]: - unknown | number | number | null | number | null | string | null | string | null | string | null | undefined; + [key: string]: unknown; }; /** * PublicRecording + * * A recording as this visitor may see it: all of it with permission, else its page, description and open parts, * or (restricted, signed in) its title only. Parts left out are null. */ @@ -6872,6 +6329,7 @@ export type PublicRecording = { media_kind: "audio" | "video" | "transcript" | "document" | "image"; /** * View + * * full: with permission; public: a public recording; locked: restricted, listed with a lock */ view: "full" | "public" | "locked"; @@ -6881,6 +6339,7 @@ export type PublicRecording = { access: "public" | "restricted" | "private"; /** * Open + * * the parts a public recording opens to everyone */ open: Array<"media" | "transcript" | "index">; @@ -6890,21 +6349,25 @@ export type PublicRecording = { featured: boolean; /** * Member + * * the visitor has a role in the recording's namespace, so it opens in the workspace too */ member: boolean; /** * Granted + * * the visitor was given permission on this recording, so they see all of it */ granted?: boolean; /** * Network + * * the IP group whose addresses see all of it, when that's why the visitor does */ network?: string | null; /** * Description + * * descriptive metadata, as IIIF publishes it */ description?: { @@ -6918,21 +6381,25 @@ export type PublicRecording = { chapters?: Array | null; /** * Closed + * * parts the recording has that this visitor can't use */ closed: Array<"media" | "transcript" | "index">; /** * Files + * * its supplementary files this visitor may download */ files?: Array; /** * Files Closed + * * how many of its files this visitor can't download */ files_closed?: number; /** * Can Request + * * signed in without permission, with something closed: they may ask for access */ can_request?: boolean; @@ -6940,51 +6407,12 @@ export type PublicRecording = { * their latest request for access, if they made one */ request?: PublicRequest | null; - [key: string]: - | unknown - | number - | string - | null - | string - | null - | string - | null - | number - | null - | "audio" - | "video" - | "transcript" - | "document" - | "image" - | "full" - | "public" - | "locked" - | "public" - | "restricted" - | "private" - | Array<"media" | "transcript" | "index"> - | boolean - | string - | null - | { - [key: string]: unknown; - } - | null - | PublicMedia - | null - | PublicTranscript - | null - | Array - | null - | Array<"media" | "transcript" | "index"> - | Array - | PublicRequest - | null - | undefined; + [key: string]: unknown; }; /** * PublicRequest + * * Someone's latest request for access to a recording. */ export type PublicRequest = { @@ -7004,8 +6432,7 @@ export type PublicRequest = { * Decided At */ decided_at?: string | null; - [key: string]: - unknown | "pending" | "approved" | "declined" | string | null | string | null | string | null | undefined; + [key: string]: unknown; }; /** @@ -7014,6 +6441,7 @@ export type PublicRequest = { export type PublicRequestCreate = { /** * Message + * * why they'd like access, for the owners */ message?: string | null; @@ -7065,43 +6493,17 @@ export type PublicResult = { summary?: string | null; /** * Poster + * * signed link to a video's first frame, when the visitor may play it */ poster?: string | null; /** * Hits + * * matching transcript lines, best first; none where the transcript is closed */ hits?: Array; - [key: string]: - | unknown - | number - | string - | null - | string - | null - | string - | null - | number - | null - | "audio" - | "video" - | "transcript" - | "document" - | "image" - | "full" - | "public" - | "locked" - | "public" - | "restricted" - | "private" - | boolean - | string - | null - | string - | null - | Array - | undefined; + [key: string]: unknown; }; /** @@ -7114,11 +6516,13 @@ export type PublicSearch = { q: string; /** * Total + * * how many recordings match, on all pages */ total: number; /** * Capped + * * there were too many matching lines to rank them all */ capped: boolean; @@ -7126,7 +6530,7 @@ export type PublicSearch = { * Items */ items: Array; - [key: string]: unknown | string | number | boolean | Array; + [key: string]: unknown; }; /** @@ -7135,16 +6539,19 @@ export type PublicSearch = { export type PublicSegment = { /** * T0 + * * start, in ms (for a document's text, only a reading pace) */ t0: number; /** * T1 + * * end, in ms */ t1: number; /** * S + * * the speaker's key */ s?: string | null; @@ -7154,10 +6561,11 @@ export type PublicSegment = { text: string; /** * P + * * a document's or an image's text: the page it's on (from 0) */ p?: number | null; - [key: string]: unknown | number | string | null | string | number | null | undefined; + [key: string]: unknown; }; /** @@ -7176,7 +6584,7 @@ export type PublicSpeaker = { * Color */ color: string; - [key: string]: unknown | string; + [key: string]: unknown; }; /** @@ -7193,14 +6601,16 @@ export type PublicTranscript = { segments: Array; /** * Downloads + * * transcript files; offered when the transcript is open to everyone */ downloads: Array; - [key: string]: unknown | Array | Array | Array; + [key: string]: unknown; }; /** * Recording + * * The recording row (less its envelope) plus what the recording page needs. */ export type Recording = { @@ -7226,16 +6636,19 @@ export type Recording = { namespace?: string | null; /** * Collection + * * the collection it lives in */ collection?: number | null; /** * Collection Path + * * its collection and the ones it's in, from the top */ collection_path?: Array; /** * Role + * * your role on it: through its namespace or its collection (an admin of the collection is an owner) */ role?: "viewer" | "editor" | "owner" | null; @@ -7253,6 +6666,7 @@ export type Recording = { } | null; /** * Report Url + * * signed link to the built report page, if one exists */ report_url?: string | null; @@ -7268,11 +6682,13 @@ export type Recording = { }>; /** * Access + * * its own access, or its namespace's default */ access?: "public" | "restricted" | "private"; /** * Open + * * the parts anyone may use when it is public */ open?: Array<"media" | "transcript" | "index">; @@ -7282,6 +6698,7 @@ export type Recording = { featured?: boolean; /** * Access Inherited + * * the access comes from the namespace's default */ access_inherited?: boolean; @@ -7305,55 +6722,12 @@ export type Recording = { * a web page captured as a document */ web?: WebPage | null; - [key: string]: - | unknown - | number - | string - | null - | string - | null - | string - | null - | number - | null - | Array - | "viewer" - | "editor" - | "owner" - | null - | { - [key: string]: unknown; - } - | null - | { - [key: string]: unknown; - } - | null - | string - | null - | Array - | Array<{ - [key: string]: unknown; - }> - | "public" - | "restricted" - | "private" - | Array<"media" | "transcript" | "index"> - | boolean - | Array - | EmailInfo - | null - | Rendition - | null - | AttachedTo - | null - | WebPage - | null - | undefined; + [key: string]: unknown; }; /** * RecordingAccess + * * Who may see the recording: public, restricted or private (docs/access.md). */ export type RecordingAccess = { @@ -7363,6 +6737,7 @@ export type RecordingAccess = { access: "public" | "restricted" | "private"; /** * Open + * * the parts anyone may use when it is public: media, transcript, index */ open: Array<"media" | "transcript" | "index">; @@ -7372,6 +6747,7 @@ export type RecordingAccess = { featured: boolean; /** * Inherited + * * access and open come from the namespace's default */ inherited: boolean; @@ -7379,12 +6755,12 @@ export type RecordingAccess = { * the namespace's default */ default: NamespaceAccess; - [key: string]: - unknown | "public" | "restricted" | "private" | Array<"media" | "transcript" | "index"> | boolean | NamespaceAccess; + [key: string]: unknown; }; /** * RecordingAccessUpdate + * * Send the settings to change. access or open set to null follow the namespace's default again. */ export type RecordingAccessUpdate = { @@ -7409,10 +6785,11 @@ export type RecordingContentType = { content_type: ContentType; /** * Chosen + * * someone chose it; otherwise it was recognised from the file */ chosen: boolean; - [key: string]: unknown | ContentType | boolean; + [key: string]: unknown; }; /** @@ -7421,6 +6798,7 @@ export type RecordingContentType = { export type RecordingContentTypeSet = { /** * Content Type + * * a subtype of the resource's base type; null to recognise it again */ content_type: string | null; @@ -7440,14 +6818,16 @@ export type RecordingFacet = { title?: string | null; /** * Count + * * matching moments */ count: number; - [key: string]: unknown | number | string | null | undefined; + [key: string]: unknown; }; /** * RecordingIpGroup + * * One of the namespace's IP groups, and whether it opens this recording (docs/access.md). */ export type RecordingIpGroup = { @@ -7465,15 +6845,17 @@ export type RecordingIpGroup = { ranges: Array; /** * Everything + * * it opens every recording in the namespace */ everything: boolean; /** * Opens + * * visitors from its addresses see all of this recording */ opens: boolean; - [key: string]: unknown | number | string | Array | boolean; + [key: string]: unknown; }; /** @@ -7482,6 +6864,7 @@ export type RecordingIpGroup = { export type RecordingMetadata = { /** * Meta + * * the effective metadata: stored values over derived defaults */ meta: { @@ -7505,20 +6888,7 @@ export type RecordingMetadata = { problems: Array<{ [key: string]: unknown; }>; - [key: string]: - | unknown - | { - [key: string]: unknown; - } - | { - [key: string]: unknown; - } - | { - [key: string]: unknown; - } - | Array<{ - [key: string]: unknown; - }>; + [key: string]: unknown; }; /** @@ -7527,6 +6897,7 @@ export type RecordingMetadata = { export type RecordingMetadataUpdate = { /** * Set + * * fields to save; null clears one */ set?: { @@ -7534,6 +6905,7 @@ export type RecordingMetadataUpdate = { }; /** * Reset + * * fields to put back to their derived values */ reset?: Array; @@ -7545,21 +6917,25 @@ export type RecordingMetadataUpdate = { export type RecordingMove = { /** * Namespace + * * the namespace to move it to */ namespace: string; /** * Rediarize + * * identify its speakers again from their voices in the new namespace (audio only); else matched by name */ rediarize?: boolean; /** * Revoke Shares + * * stop its share links working; otherwise they keep working */ revoke_shares?: boolean; /** * Collection + * * a collection of the new namespace to put it in; default: its default collection */ collection?: number | null; @@ -7579,16 +6955,19 @@ export type RecordingMoved = { namespace: string; /** * Collection + * * the collection it's in now */ collection?: number | null; /** * Job + * * the job that analyses it again in the new namespace */ job: number; /** * Pinned + * * what it had from its old namespace and keeps: access, open parts, metadata defaults */ pinned?: Array; @@ -7596,7 +6975,7 @@ export type RecordingMoved = { * Shares Revoked */ shares_revoked?: number; - [key: string]: unknown | boolean | string | number | null | number | Array | undefined; + [key: string]: unknown; }; /** @@ -7619,7 +6998,7 @@ export type RecordingSpeaker = { * Score */ score?: number | null; - [key: string]: unknown | number | string | string | null | number | null | undefined; + [key: string]: unknown; }; /** @@ -7664,6 +7043,7 @@ export type RecordingSummary = { namespace?: string | null; /** * Collection + * * the collection it lives in */ collection?: number | null; @@ -7673,16 +7053,19 @@ export type RecordingSummary = { collection_name?: string | null; /** * Media Kind + * * audio, video, transcript (text without media), document or image */ media_kind: string; /** * Pages + * * a document's or an image's pages */ pages?: number | null; /** * Poster + * * signed link to a video's first frame, or a document's or image's first page */ poster?: string | null; @@ -7706,16 +7089,19 @@ export type RecordingSummary = { sentiment?: unknown; /** * Speakers + * * speaker names, comma separated */ speakers?: string; /** * Access + * * its own access, or its namespace's default */ access?: "public" | "restricted" | "private"; /** * Open + * * the parts anyone may use when it is public */ open?: Array<"media" | "transcript" | "index">; @@ -7729,86 +7115,46 @@ export type RecordingSummary = { tags?: Array; /** * Language + * * its language code, when known */ language?: string | null; /** * Origin + * * where it came from: source: (a connected source), upload, paste, iiif, folder or file */ origin?: string | null; /** * Origin Name + * * what to call its origin: the source's name, or e.g. Uploaded */ origin_name?: string | null; /** * Role + * * your role on it: through its namespace or its collection (an admin of the collection is an owner) */ role?: "viewer" | "editor" | "owner" | null; - [key: string]: - | unknown - | number - | string - | null - | string - | null - | number - | null - | string - | null - | string - | null - | string - | null - | string - | null - | number - | null - | string - | null - | string - | number - | null - | string - | null - | { - [key: string]: unknown; - } - | number - | null - | "public" - | "restricted" - | "private" - | Array<"media" | "transcript" | "index"> - | boolean - | Array - | string - | null - | string - | null - | string - | null - | "viewer" - | "editor" - | "owner" - | null - | undefined; + [key: string]: unknown; }; /** * RecordingUpdate + * * The fields to change; the others stay as they are. */ export type RecordingUpdate = { /** * Title + * * whitespace is collapsed */ title?: string | null; /** * Tags + * * replace its tags (at most 20, 40 characters each) */ tags?: Array | null; @@ -7824,6 +7170,7 @@ export type RecordingsPlace = { recordings: Array; /** * Collection + * * a collection of their namespace */ collection: number; @@ -7859,11 +7206,13 @@ export type RefreshRequest = { /** * Rendition + * * How a document that isn't a PDF was made into one. */ export type Rendition = { /** * From + * * its own type: .docx, .eml, … */ from: string; @@ -7871,7 +7220,7 @@ export type Rendition = { * By */ by: "libreoffice" | "chromium"; - [key: string]: unknown | string | "libreoffice" | "chromium"; + [key: string]: unknown; }; /** @@ -7880,6 +7229,7 @@ export type Rendition = { export type ReprocessRequest = { /** * Steps + * * default: the namespace's pipeline */ steps?: Array< @@ -7926,6 +7276,7 @@ export type ResourceFile = { name: string; /** * Size + * * bytes */ size: number; @@ -7935,6 +7286,7 @@ export type ResourceFile = { content_type: string; /** * Language + * * what language it's in (a code such as en or pt-BR) */ language?: string | null; @@ -7948,21 +7300,25 @@ export type ResourceFile = { description?: string | null; /** * Lines + * * transcripts, captions, translations and indexes: how many lines were read from it */ lines?: number | null; /** * Timed + * * whether its lines say when they are (else they have no times) */ timed?: boolean | null; /** * Resource + * * an email's attachment: the resource it became (or the one it was already) */ resource?: number | null; /** * Public + * * everyone may download it: the resource is public with the part its role follows open (attachments never are) */ public: boolean; @@ -7972,11 +7328,13 @@ export type ResourceFile = { created_at?: string | null; /** * Created By + * * who added it: their email */ created_by?: string | null; /** * Created By Name + * * their name, when they gave one */ created_by_name?: string | null; @@ -7986,41 +7344,11 @@ export type ResourceFile = { updated_at?: string | null; /** * Download + * * a signed link to it */ download: string; - [key: string]: - | unknown - | number - | "transcript" - | "captions" - | "translation" - | "index" - | "thumbnail" - | "attachment" - | string - | string - | null - | string - | null - | string - | null - | number - | null - | boolean - | null - | number - | null - | boolean - | string - | null - | string - | null - | string - | null - | string - | null - | undefined; + [key: string]: unknown; }; /** @@ -8033,20 +7361,23 @@ export type ResourceFiles = { primary?: PrimaryFile | null; /** * Files + * * by role, then the earliest added first */ files: Array; /** * Max Mb + * * the largest file that can be added (server.max_upload_mb) */ max_mb: number; /** * Can Change + * * you may add, change and delete its files (editors) */ can_change: boolean; - [key: string]: unknown | PrimaryFile | null | Array | number | boolean | undefined; + [key: string]: unknown; }; /** @@ -8071,6 +7402,7 @@ export type Routine = { enabled: boolean; /** * Schedule + * * five-field cron (minute hour day month weekday) or @daily...; none: by hand only */ schedule?: string | null; @@ -8084,6 +7416,7 @@ export type Routine = { timezone?: string; /** * Namespaces + * * namespace ids; none for every namespace */ namespaces?: Array | null; @@ -8125,35 +7458,7 @@ export type Routine = { * Created By */ created_by?: string | null; - [key: string]: - | unknown - | number - | string - | string - | null - | boolean - | string - | null - | Array - | null - | Array - | null - | Array<{ - [key: string]: unknown; - }> - | string - | null - | string - | null - | string - | null - | number - | null - | string - | null - | string - | null - | undefined; + [key: string]: unknown; }; /** @@ -8166,15 +7471,17 @@ export type RoutineCatalog = { routines: Array; /** * Actions + * * what a routine can do: sync, pipeline, workflow */ actions: Array; /** * Recordings + * * which recordings a pipeline or workflow action takes: new, unprocessed, all */ recordings: Array; - [key: string]: unknown | Array | Array | Array; + [key: string]: unknown; }; /** @@ -8187,6 +7494,7 @@ export type RoutineCreate = { name: string; /** * Actions + * * in order: {type: sync, watches?}, {type: pipeline, pipeline?, steps?, recordings?, limit?}, {type: workflow, workflow, version?, recordings?, limit?, propose_only?} */ actions: Array<{ @@ -8266,28 +7574,7 @@ export type RoutineRun = { * Log */ log?: Array | null; - [key: string]: - | unknown - | number - | string - | string - | null - | string - | null - | string - | null - | Array<{ - [key: string]: unknown; - }> - | string - | null - | { - [key: string]: number; - } - | null - | Array - | null - | undefined; + [key: string]: unknown; }; /** @@ -8296,6 +7583,7 @@ export type RoutineRun = { export type RoutineRunRequest = { /** * Propose Only + * * graph workflows propose every change instead of making the sure ones */ propose_only?: boolean; @@ -8351,11 +7639,13 @@ export type SavedSearch = { name: string; /** * Namespace + * * the namespace it searches; null: every namespace you can read */ namespace?: string | null; /** * Shared + * * everyone with a role in its namespace sees it */ shared?: boolean; @@ -8369,6 +7659,7 @@ export type SavedSearch = { speaker?: number | null; /** * Speaker Name + * * the speaker's name, when you can read their namespace */ speaker_name?: string | null; @@ -8382,16 +7673,19 @@ export type SavedSearch = { recording?: number | null; /** * Recording Title + * * the recording's title, when you can read it */ recording_title?: string | null; /** * Object + * * a kind of object the recordings have */ object?: string | null; /** * Created By + * * its maker's email */ created_by?: string | null; @@ -8405,40 +7699,17 @@ export type SavedSearch = { updated_at?: string | null; /** * Mine + * * you made it: only you can change it */ mine: boolean; /** * Can Delete + * * you made it, or it's shared and you own its namespace */ can_delete: boolean; - [key: string]: - | unknown - | number - | string - | string - | null - | boolean - | number - | null - | string - | null - | string - | null - | number - | null - | string - | null - | string - | null - | string - | null - | string - | null - | string - | null - | undefined; + [key: string]: unknown; }; /** @@ -8455,17 +7726,20 @@ export type SavedView = { name: string; /** * Namespace + * * the namespace it shows; null: every namespace you can read */ namespace?: string | null; /** * Shared + * * everyone with a role in its namespace sees it */ shared?: boolean; state: ViewState; /** * Created By + * * its maker's email */ created_by?: string | null; @@ -8479,29 +7753,17 @@ export type SavedView = { updated_at?: string | null; /** * Mine + * * you made it: only you can change it */ mine: boolean; /** * Can Delete + * * you made it, or it's shared and you own its namespace */ can_delete: boolean; - [key: string]: - | unknown - | number - | string - | string - | null - | boolean - | ViewState - | string - | null - | string - | null - | string - | null - | undefined; + [key: string]: unknown; }; /** @@ -8524,7 +7786,7 @@ export type SchedulePreview = { * Next */ next: Array; - [key: string]: unknown | string | Array; + [key: string]: unknown; }; /** @@ -8533,6 +7795,7 @@ export type SchedulePreview = { export type SearchCreate = { /** * Q + * * words, "phrases", OR between alternatives */ q: string; @@ -8550,6 +7813,7 @@ export type SearchCreate = { recording?: number | null; /** * Object + * * a kind of object the recordings have (person, car …) */ object?: string | null; @@ -8559,11 +7823,13 @@ export type SearchCreate = { name: string; /** * Namespace + * * search one namespace; null: every namespace you can read */ namespace?: string | null; /** * Shared + * * share it with its namespace (needs editor access there) */ shared?: boolean; @@ -8571,17 +7837,20 @@ export type SearchCreate = { /** * SearchFacets + * * How many of all the matching moments are in each namespace, speaker, emotion and recording (up to 50 of each, * most first), and the kinds of object seen in the recordings they're in. Text on screen has no speaker or emotion. */ export type SearchFacets = { /** * Moments + * * the matching moments counted: all of them, unless `partial` */ moments: number; /** * Partial + * * more than 20,000 moments match; the counts cover 20,000 of them */ partial: boolean; @@ -8605,16 +7874,7 @@ export type SearchFacets = { * Objects */ objects?: Array; - [key: string]: - | unknown - | number - | boolean - | Array - | Array - | Array - | Array - | Array - | undefined; + [key: string]: unknown; }; /** @@ -8623,6 +7883,7 @@ export type SearchFacets = { export type SearchHit = { /** * Id + * * segment id (int) for transcript hits, OCR span or file line id (str) for the others */ id: number | string; @@ -8636,6 +7897,7 @@ export type SearchHit = { idx?: number | null; /** * T0 + * * ms; None for a line of a file that doesn't say when its lines are */ t0: number | null; @@ -8669,92 +7931,59 @@ export type SearchHit = { namespace?: string | null; /** * Snippet + * * HTML: escaped text with around matches */ snippet: string; /** * Source + * * "said" (transcript), "screen" (text on screen in a video), "file" (a line of a supplementary file), "page" (text on a page of a document or an image, whose times are only a reading pace), "object" (a kind of object seen in a video, a document or an image, where it's first seen; its snippet is the kind) or "described" (what a model that can see said a shot of a video, or a page, shows) */ source: "said" | "screen" | "file" | "page" | "object" | "described"; /** * Frame + * * screen, object and described hits: signed link to the video frame or the page */ frame?: string | null; /** * Box + * * screen, page and object hits: where it is on the frame or the page ([x, y, w, h] fractions) */ box?: unknown; /** * Page + * * page hits, and object and described hits on pages: which page (from 0) */ page?: number | null; /** * File + * * file hits: the supplementary file the line is in */ file?: number | null; /** * File Role + * * file hits: its role (transcript, captions, translation or index) */ file_role?: string | null; /** * File Label + * * file hits: its label, or its name */ file_label?: string | null; /** * Line + * * file hits: which of its lines (from 0) */ line?: number | null; - [key: string]: - | unknown - | number - | string - | number - | number - | null - | number - | null - | number - | null - | string - | null - | number - | null - | string - | null - | string - | null - | string - | null - | string - | null - | string - | "said" - | "screen" - | "file" - | "page" - | "object" - | "described" - | string - | null - | number - | null - | number - | null - | string - | null - | string - | null - | number - | null - | undefined; + [key: string]: unknown; }; /** @@ -8767,6 +7996,7 @@ export type SearchResults = { q: string; /** * Query + * * how the query was understood */ query: string; @@ -8786,11 +8016,12 @@ export type SearchResults = { * with `facets=true`: counts over all the matching moments */ facets?: SearchFacets | null; - [key: string]: unknown | string | number | boolean | Array | SearchFacets | null | undefined; + [key: string]: unknown; }; /** * SearchUpdate + * * Only what you send changes. */ export type SearchUpdate = { @@ -8800,6 +8031,7 @@ export type SearchUpdate = { name?: string | null; /** * Shared + * * share it with its namespace (needs editor access there), or stop */ shared?: boolean | null; @@ -8817,7 +8049,7 @@ export type SecretFlag = { * Set */ set: boolean; - [key: string]: unknown | boolean | undefined; + [key: string]: unknown; }; /** @@ -8830,6 +8062,7 @@ export type SegmentEdit = { idx: number; /** * Kind + * * split or merge; null for a correction */ kind?: "split" | "merge" | null; @@ -8853,44 +8086,30 @@ export type SegmentEdit = { * At */ at?: string | null; - [key: string]: - | unknown - | number - | "split" - | "merge" - | null - | { - [key: string]: unknown; - } - | null - | { - [key: string]: unknown; - } - | null - | string - | null - | string - | null - | undefined; + [key: string]: unknown; }; /** * SegmentSplit + * * Where to split a line: `at`, a position in its text (the split goes at the start of the word it's in). */ export type SegmentSplit = { /** * At + * * a character position in the line's text */ at: number; /** * T + * * when the second part starts, in ms (default: when its first word was said) */ t?: number | null; /** * Speaker + * * the second part's speaker (an id in the namespace, or null); leave out to keep the line's */ speaker?: number | null; @@ -8898,6 +8117,7 @@ export type SegmentSplit = { /** * SegmentUpdate + * * Send ``text``, ``speaker`` (a speaker id in the same namespace, or null), or both. */ export type SegmentUpdate = { @@ -8919,7 +8139,7 @@ export type SetupAdmin = { * From Env */ from_env: boolean; - [key: string]: unknown | boolean; + [key: string]: unknown; }; /** @@ -8964,12 +8184,7 @@ export type SetupLlmView = { * Locked */ locked: Array; - [key: string]: - | unknown - | { - [key: string]: unknown; - } - | Array; + [key: string]: unknown; }; /** @@ -8998,7 +8213,7 @@ export type SetupNamespaceView = { * Locked */ locked: boolean; - [key: string]: unknown | Array | boolean; + [key: string]: unknown; }; /** @@ -9039,7 +8254,7 @@ export type SetupSaved = { * Watch */ watch?: number | null; - [key: string]: unknown | boolean | Array | number | null | undefined; + [key: string]: unknown; }; /** @@ -9088,7 +8303,7 @@ export type SetupStorageView = { * Watches */ watches: number; - [key: string]: unknown | string | boolean | Array | number; + [key: string]: unknown; }; /** @@ -9121,7 +8336,7 @@ export type SetupTelemetryView = { * Locked */ locked: Array; - [key: string]: unknown | boolean | string | null | Array | undefined; + [key: string]: unknown; }; /** @@ -9137,8 +8352,7 @@ export type SetupView = { llm: SetupLlmView; storage: SetupStorageView; telemetry: SetupTelemetryView; - [key: string]: - unknown | boolean | SetupAdmin | SetupNamespaceView | SetupLlmView | SetupStorageView | SetupTelemetryView; + [key: string]: unknown; }; /** @@ -9147,6 +8361,7 @@ export type SetupView = { export type Share = { /** * Id + * * first characters of the link's id */ id: string; @@ -9164,6 +8379,7 @@ export type Share = { expires_at?: string | null; /** * Active + * * it still works: not revoked and not expired */ active: boolean; @@ -9181,43 +8397,29 @@ export type Share = { revoked_at?: string | null; /** * Short + * * it has a short /s/ address (links made before short links have none) */ short?: boolean; /** * Plays + * * times its player started playing, once per page load (not counting Lens itself) */ plays?: number; /** * Played At + * * the last play */ played_at?: string | null; /** * Embedded On + * * sites whose pages framed its player, most recent first (up to 50) */ embedded_on?: Array; - [key: string]: - | unknown - | string - | string - | null - | string - | null - | string - | null - | boolean - | string - | null - | string - | null - | number - | string - | null - | Array - | undefined; + [key: string]: unknown; }; /** @@ -9236,6 +8438,7 @@ export type ShareCreate = { export type ShareLink = { /** * Id + * * the link's id, as GET /shares lists it */ id: string; @@ -9245,15 +8448,17 @@ export type ShareLink = { token: string; /** * Embed + * * embeddable player link carrying the share token (works without signing in) */ embed: string; /** * Short + * * "/s/": a short address for the same player; it expires and is revoked with the link */ short?: string | null; - [key: string]: unknown | string | string | null | undefined; + [key: string]: unknown; }; /** @@ -9262,11 +8467,13 @@ export type ShareLink = { export type ShareSite = { /** * Origin + * * a site whose pages framed the player (scheme and host, as browsers report it) */ origin: string; /** * Opens + * * how many times the player was opened there */ opens?: number; @@ -9274,7 +8481,7 @@ export type ShareSite = { * Last At */ last_at?: string | null; - [key: string]: unknown | string | number | string | null | undefined; + [key: string]: unknown; }; /** @@ -9322,33 +8529,7 @@ export type Source = { * Watches */ watches?: number; - [key: string]: - | unknown - | number - | string - | "s3" - | "dropbox" - | "drive" - | "onedrive" - | "sftp" - | "smb" - | "webdav" - | "local" - | "imap" - | "ical" - | { - [key: string]: unknown; - } - | { - [key: string]: SecretFlag; - } - | string - | null - | SourceHealth - | null - | string - | null - | undefined; + [key: string]: unknown; }; /** @@ -9371,6 +8552,7 @@ export type SourceCreate = { } | null; /** * Secrets + * * stored encrypted; never shown again */ secrets?: { @@ -9391,7 +8573,7 @@ export type SourceCreated = { */ id: number; health: SourceHealth; - [key: string]: unknown | boolean | number | SourceHealth | undefined; + [key: string]: unknown; }; /** @@ -9410,7 +8592,7 @@ export type SourceHealth = { * Error */ error?: string | null; - [key: string]: unknown | boolean | string | null | string | null | undefined; + [key: string]: unknown; }; /** @@ -9421,7 +8603,7 @@ export type SourceImport = { * Results */ results: Array; - [key: string]: unknown | Array; + [key: string]: unknown; }; /** @@ -9434,6 +8616,7 @@ export type SourceImportRequest = { source: number; /** * Paths + * * files of the source, as browsing it lists them */ paths: Array; @@ -9443,16 +8626,19 @@ export type SourceImportRequest = { namespace: string; /** * Pipeline + * * run this pipeline afterwards instead of the namespace's */ pipeline?: number | null; /** * Collection + * * a collection of the namespace to put them in; default: its default collection */ collection?: number | null; /** * Documents As + * * PDFs, Word and text files become documents (their pages kept and read), or transcripts (their text only) */ documents_as?: "document" | "transcript"; @@ -9482,20 +8668,7 @@ export type SourceImportResult = { * Detail */ detail?: string | null; - [key: string]: - | unknown - | string - | "queued" - | "already" - | "skipped" - | "error" - | number - | null - | number - | null - | string - | null - | undefined; + [key: string]: unknown; }; /** @@ -9514,6 +8687,7 @@ export type SourceUpdate = { } | null; /** * Secrets + * * null or empty removes a secret */ secrets?: { @@ -9530,7 +8704,7 @@ export type SourceUpdated = { */ ok?: boolean; health: SourceHealth; - [key: string]: unknown | boolean | SourceHealth | undefined; + [key: string]: unknown; }; /** @@ -9573,7 +8747,7 @@ export type Speaker = { * Suggestions */ suggestions?: Array; - [key: string]: unknown | number | string | string | null | boolean | Array | undefined; + [key: string]: unknown; }; /** @@ -9582,11 +8756,13 @@ export type Speaker = { export type SpeakerCandidate = { /** * A + * * this namespace's speaker */ a: number; /** * B + * * the speaker in another namespace */ b: number; @@ -9608,10 +8784,11 @@ export type SpeakerCandidate = { b_ns?: string | null; /** * Score + * * how alike the two voices are (cosine similarity, at least speakers.match_threshold) */ score: number; - [key: string]: unknown | number | string | null | string | null | string | null | string | null | number | undefined; + [key: string]: unknown; }; /** @@ -9632,11 +8809,11 @@ export type SpeakerDirectory = { links: Array; /** * Cross + * * likely the same voice in another shared namespace you can read (speakers.cross_namespace: suggest), best first; not linked, and not said to be different */ cross?: Array; - [key: string]: - unknown | Array | Array | Array | Array | undefined; + [key: string]: unknown; }; /** @@ -9657,10 +8834,11 @@ export type SpeakerFacet = { namespace?: string | null; /** * Count + * * matching moments */ count: number; - [key: string]: unknown | number | string | string | null | undefined; + [key: string]: unknown; }; /** @@ -9691,7 +8869,7 @@ export type SpeakerLink = { * B Ns */ b_ns?: string | null; - [key: string]: unknown | number | string | null | string | null | string | null | string | null | undefined; + [key: string]: unknown; }; /** @@ -9700,6 +8878,7 @@ export type SpeakerLink = { export type SpeakerLinkRequest = { /** * With + * * a speaker in another namespace: the same person */ with: number; @@ -9743,16 +8922,19 @@ export type SpeakerMerge = { into_name?: string | null; /** * By + * * who merged them */ by?: string | null; /** * Recordings + * * how many recordings' lines moved to the remaining speaker */ recordings?: number | null; /** * Segments + * * how many lines moved */ segments?: number | null; @@ -9764,28 +8946,7 @@ export type SpeakerMerge = { * Undone At */ undone_at?: string | null; - [key: string]: - | unknown - | number - | string - | null - | string - | null - | string - | null - | string - | null - | string - | null - | number - | null - | number - | null - | string - | null - | string - | null - | undefined; + [key: string]: unknown; }; /** @@ -9794,6 +8955,7 @@ export type SpeakerMerge = { export type SpeakerMergeRequest = { /** * Into + * * the speaker that remains */ into: number; @@ -9811,7 +8973,7 @@ export type SpeakerMerged = { * Merge Id */ merge_id: number; - [key: string]: unknown | boolean | number | undefined; + [key: string]: unknown; }; /** @@ -9820,6 +8982,7 @@ export type SpeakerMerged = { export type SpeakerPair = { /** * With + * * the other speaker */ with: number; @@ -9849,7 +9012,7 @@ export type SpeakerRecording = { * First T0 */ first_t0?: number; - [key: string]: unknown | number | string | null | string | null | undefined; + [key: string]: unknown; }; /** @@ -9858,6 +9021,7 @@ export type SpeakerRecording = { export type SpeakerRename = { /** * Name + * * empty to go back to the automatic label */ name?: string; @@ -9877,15 +9041,17 @@ export type SpeakerStats = { name?: string | null; /** * Talk Ms + * * how long they talk in the range's recordings */ talk_ms?: number; /** * Recordings + * * how many of the range's recordings they talk in */ recordings?: number; - [key: string]: unknown | number | string | null | undefined; + [key: string]: unknown; }; /** @@ -9904,11 +9070,12 @@ export type SpeakerSuggestion = { * Score */ score: number; - [key: string]: unknown | number | string | number; + [key: string]: unknown; }; /** * Started + * * Work that carries on after the response (202 Accepted). */ export type Started = { @@ -9920,7 +9087,7 @@ export type Started = { * Status */ status: string; - [key: string]: unknown | boolean | string | undefined; + [key: string]: unknown; }; /** @@ -9929,6 +9096,7 @@ export type Started = { export type StepOutput = { /** * Key + * * saved as outputs. on the recording */ key: string; @@ -9938,6 +9106,7 @@ export type StepOutput = { template?: number | null; /** * Version + * * the template version it was made with */ version?: number | null; @@ -9945,7 +9114,7 @@ export type StepOutput = { * Model */ model?: string | null; - [key: string]: unknown | string | number | null | number | null | string | null | undefined; + [key: string]: unknown; }; /** @@ -9958,10 +9127,11 @@ export type StepQueued = { ok?: boolean; /** * Queued + * * how many recordings were queued, or "scanning" */ queued: number | string; - [key: string]: unknown | boolean | number | string | undefined; + [key: string]: unknown; }; /** @@ -9978,6 +9148,7 @@ export type StepRun = { finished_at?: string | null; /** * Seconds + * * how long it took */ seconds?: number | null; @@ -9987,6 +9158,7 @@ export type StepRun = { outcome?: "running" | "done" | "skipped" | "failed" | null; /** * Note + * * its last message, why it skipped, or its error */ note?: string | null; @@ -9996,42 +9168,23 @@ export type StepRun = { worker?: string | null; /** * Log From + * * its first line in the run's log (GET /jobs/{jid}/log numbers lines from 0) */ log_from?: number | null; /** * Log To + * * the line after its last one */ log_to?: number | null; /** * Outputs + * * the outputs it saved */ outputs?: Array; - [key: string]: - | unknown - | string - | null - | string - | null - | number - | null - | "running" - | "done" - | "skipped" - | "failed" - | null - | string - | null - | string - | null - | number - | null - | number - | null - | Array - | undefined; + [key: string]: unknown; }; /** @@ -10044,10 +9197,11 @@ export type StopResult = { ok?: boolean; /** * Stopping + * * an answer was being written, and stops after its current piece or step */ stopping: boolean; - [key: string]: unknown | boolean | undefined; + [key: string]: unknown; }; /** @@ -10062,7 +9216,7 @@ export type TagCount = { * Recordings */ recordings: number; - [key: string]: unknown | string | number; + [key: string]: unknown; }; /** @@ -10075,10 +9229,11 @@ export type TagsChanged = { ok?: boolean; /** * Changed + * * how many recordings' tags changed */ changed: number; - [key: string]: unknown | boolean | number | undefined; + [key: string]: unknown; }; /** @@ -10097,11 +9252,12 @@ export type TelemetryExport = { * Error */ error?: string | null; - [key: string]: unknown | number | boolean | string | null | undefined; + [key: string]: unknown; }; /** * TelemetryStatus + * * What the API process does with telemetry now; each worker follows the same settings on its own. */ export type TelemetryStatus = { @@ -10123,7 +9279,7 @@ export type TelemetryStatus = { metrics: boolean; last_traces?: TelemetryExport | null; last_metrics?: TelemetryExport | null; - [key: string]: unknown | boolean | string | null | TelemetryExport | null | TelemetryExport | null | undefined; + [key: string]: unknown; }; /** @@ -10142,7 +9298,7 @@ export type TelemetryTestResult = { * Ms */ ms?: number | null; - [key: string]: unknown | boolean | string | null | number | null | undefined; + [key: string]: unknown; }; /** @@ -10187,6 +9343,7 @@ export type Template = { body: string; /** * Schema + * * JSON schema the model's answer must match (prompts) */ schema?: { @@ -10208,31 +9365,7 @@ export type Template = { * History */ history?: Array; - [key: string]: - | unknown - | number - | string - | "prompt" - | "report" - | "export" - | string - | null - | string - | null - | string - | null - | { - [key: string]: unknown; - } - | null - | string - | null - | string - | null - | string - | null - | Array - | undefined; + [key: string]: unknown; }; /** @@ -10291,11 +9424,12 @@ export type TemplatePreview = { * Error */ error?: string | null; - [key: string]: unknown | boolean | "prompt" | "report" | "export" | null | string | null | string | null | undefined; + [key: string]: unknown; }; /** * TemplatePreviewRequest + * * A saved template (`template`, optional `version`), or the unsaved text in the editor (`body` and friends). */ export type TemplatePreviewRequest = { @@ -10335,6 +9469,7 @@ export type TemplatePreviewRequest = { filename?: string | null; /** * Run + * * also call the model (prompts only) */ run?: boolean; @@ -10372,7 +9507,7 @@ export type TemplateSummary = { * Versions */ versions?: number; - [key: string]: unknown | number | string | "prompt" | "report" | "export" | string | null | string | null | undefined; + [key: string]: unknown; }; /** @@ -10399,6 +9534,7 @@ export type TemplateVersionCreate = { notes?: string | null; /** * Publish + * * make this the current version */ publish?: boolean; @@ -10424,7 +9560,7 @@ export type TemplateVersionInfo = { * Created By */ created_by?: string | null; - [key: string]: unknown | number | string | null | string | null | string | null | undefined; + [key: string]: unknown; }; /** @@ -10437,19 +9573,22 @@ export type TermSuggestion = { word: string; /** * Count + * * how often it's said */ count: number; /** * Recordings + * * in how many recordings */ recordings: number; - [key: string]: unknown | string | number; + [key: string]: unknown; }; /** * TokenLimits + * * How long API keys may last, set by admins (the tokens settings). */ export type TokenLimits = { @@ -10463,10 +9602,11 @@ export type TokenLimits = { max_days: number; /** * Never Expire + * * keys may be made that never expire (days: 0) */ never_expire: boolean; - [key: string]: unknown | number | boolean; + [key: string]: unknown; }; /** @@ -10487,11 +9627,12 @@ export type TokenPair = { token_type?: "bearer"; /** * Expires In + * * seconds until the access token expires */ expires_in: number; user: UserPublic; - [key: string]: unknown | string | "bearer" | number | UserPublic | undefined; + [key: string]: unknown; }; /** @@ -10512,13 +9653,7 @@ export type ToolStep = { * Summary */ summary?: string; - [key: string]: - | unknown - | string - | { - [key: string]: unknown; - } - | undefined; + [key: string]: unknown; }; /** @@ -10531,10 +9666,11 @@ export type Undone = { undone: number; /** * Failed + * * changes that couldn't be undone (an entity in them was deleted since) */ failed?: number; - [key: string]: unknown | number | undefined; + [key: string]: unknown; }; /** @@ -10551,6 +9687,7 @@ export type Upload = { namespace: string; /** * Filename + * * the name it's stored under */ filename: string; @@ -10564,6 +9701,7 @@ export type Upload = { size: number; /** * Offset + * * how many bytes have arrived: the next chunk starts here */ offset: number; @@ -10573,26 +9711,31 @@ export type Upload = { state: "receiving" | "done"; /** * Attach + * * the transcript-only recording it becomes the audio of */ attach?: number | null; /** * Pipeline + * * the pipeline chosen to run once it's here (default: the namespace's) */ pipeline?: number | null; /** * Recording + * * the recording it became (or was attached to), once done */ recording?: number | null; /** * Job + * * the processing queued for it, if any */ job?: number | null; /** * Duplicate + * * the namespace already had this file: `recording` is that one */ duplicate?: boolean; @@ -10602,27 +9745,11 @@ export type Upload = { created_at: string; /** * Expires At + * * when it's removed unless more of it arrives (uploads.expire_hours after the last chunk) */ expires_at: string; - [key: string]: - | unknown - | string - | string - | null - | number - | "receiving" - | "done" - | number - | null - | number - | null - | number - | null - | number - | null - | boolean - | undefined; + [key: string]: unknown; }; /** @@ -10631,26 +9758,30 @@ export type Upload = { export type UploadLimits = { /** * Max Mb + * * the largest file, in MB (uploads.max_mb) */ max_mb: number; /** * Extensions + * * the types that can be uploaded (uploads.extensions) */ extensions: Array; /** * Chunk Mb + * * how much the web app sends per request (uploads.chunk_mb) */ chunk_mb: number; /** * Transcript Mb + * * the largest transcript file for POST /import (server.max_upload_mb) */ transcript_mb: number; convert: Converters; - [key: string]: unknown | number | Array | Converters; + [key: string]: unknown; }; /** @@ -10659,11 +9790,13 @@ export type UploadLimits = { export type UploadStart = { /** * Namespace + * * a namespace you edit; admins may name a new one, created when the upload finishes (default: the recording's) */ namespace?: string; /** * Recording + * * attach the file to this transcript-only recording as its audio, instead of making a recording of it */ recording?: number | null; @@ -10673,26 +9806,31 @@ export type UploadStart = { filename: string; /** * Size + * * the file's size in bytes */ size: number; /** * Title + * * the recording's title (default: the file's name) */ title?: string | null; /** * Pipeline + * * run this pipeline once it's here instead of the namespace's (not with `recording`) */ pipeline?: number | null; /** * Collection + * * a collection of the namespace to put the recording in (default: its default collection; not with `recording`) */ collection?: number | null; /** * Modified + * * the file's last-modified time in milliseconds since 1970; dates the recording when its name doesn't */ modified?: number | null; @@ -10752,8 +9890,7 @@ export type UserPublic = { * Last Login At */ last_login_at?: string | null; - [key: string]: - unknown | number | string | string | null | boolean | boolean | null | string | null | string | null | undefined; + [key: string]: unknown; }; /** @@ -10774,6 +9911,7 @@ export type UserUpdate = { disabled?: boolean | null; /** * Password + * * a new password; signs the person out everywhere */ password?: string | null; @@ -10813,28 +9951,13 @@ export type UserWithRoles = { last_login_at?: string | null; /** * Roles + * * namespace name -> role */ roles?: { [key: string]: "viewer" | "editor" | "owner"; }; - [key: string]: - | unknown - | number - | string - | string - | null - | boolean - | boolean - | null - | string - | null - | string - | null - | { - [key: string]: "viewer" | "editor" | "owner"; - } - | undefined; + [key: string]: unknown; }; /** @@ -10867,7 +9990,7 @@ export type VersionSaved = { * Version */ version: number; - [key: string]: unknown | boolean | number | undefined; + [key: string]: unknown; }; /** @@ -10880,11 +10003,13 @@ export type ViewCreate = { name: string; /** * Namespace + * * the namespace it shows; null: every namespace you can read */ namespace?: string | null; /** * Shared + * * share it with its namespace (needs editor access there) */ shared?: boolean; @@ -10893,6 +10018,7 @@ export type ViewCreate = { /** * ViewState + * * What the Library shows. Dates and lengths are the Library's ranges, so "the last 7 days" stays the last 7 days. */ export type ViewState = { @@ -10902,6 +10028,7 @@ export type ViewState = { tab?: "all" | "attention" | "processing" | "mine"; /** * Q + * * the filter box */ q?: string; @@ -10911,6 +10038,7 @@ export type ViewState = { statuses?: Array<"new" | "transcribed" | "diarized" | "analyzed" | "error" | "processing" | "failed">; /** * Speaker + * * a speaker's name: whoever has it in the namespaces shown */ speaker?: string | null; @@ -10920,6 +10048,7 @@ export type ViewState = { date?: "any" | "today" | "7d" | "30d" | "90d" | "1y"; /** * Duration + * * short: under 10 min; medium: 10–30; long: 30–60; xlong: over an hour */ duration?: "any" | "short" | "medium" | "long" | "xlong"; @@ -10929,21 +10058,25 @@ export type ViewState = { media?: "any" | "audio" | "video" | "transcript" | "document" | "image"; /** * Tags + * * any of these */ tags?: Array; /** * Origins + * * where they came from (GET /recordings `origin`) */ origins?: Array; /** * Languages + * * language codes; none: not known */ languages?: Array; /** * Objects + * * kinds of object seen in them (GET /recordings `object`): any of these */ objects?: Array; @@ -10965,16 +10098,19 @@ export type ViewState = { | "-importance"; /** * Collection + * * a collection of the view's namespace (and the ones inside it) */ collection?: number | null; /** * Field + * * a custom field of the view's namespace: the recordings with a value for it */ field?: number | null; /** * Value + * * with field: the value to match (GET /recordings `value`) */ value?: string | null; @@ -10982,6 +10118,7 @@ export type ViewState = { /** * ViewUpdate + * * Only what you send changes. */ export type ViewUpdate = { @@ -10991,6 +10128,7 @@ export type ViewUpdate = { name?: string | null; /** * Shared + * * share it with its namespace (needs editor access there), or stop */ shared?: boolean | null; @@ -11012,7 +10150,7 @@ export type ViewerLink = { * Url */ url: string; - [key: string]: unknown | string; + [key: string]: unknown; }; /** @@ -11093,45 +10231,7 @@ export type Watch = { * Last Error */ last_error?: string | null; - [key: string]: - | unknown - | number - | string - | string - | null - | string - | null - | "audio" - | "transcripts" - | "both" - | "documents" - | "all" - | null - | number - | null - | number - | null - | boolean - | null - | Array - | null - | Array - | null - | Array - | null - | boolean - | null - | string - | null - | string - | null - | { - [key: string]: unknown; - } - | null - | string - | null - | undefined; + [key: string]: unknown; }; /** @@ -11140,6 +10240,7 @@ export type Watch = { export type WatchCreate = { /** * Kinds + * * what to pick up: audio (and video), transcripts, both of those (PDFs read as transcripts), documents (PDFs and images), or all of them (PDFs as documents; the default) */ kinds?: "audio" | "transcripts" | "both" | "documents" | "all" | null; @@ -11153,6 +10254,7 @@ export type WatchCreate = { stable_seconds?: number | null; /** * Backfill + * * also import files already there */ backfill?: boolean | null; @@ -11200,6 +10302,7 @@ export type WatchPreview = { files: number; /** * Audio + * * audio and video */ audio: number; @@ -11215,7 +10318,7 @@ export type WatchPreview = { * Images */ images?: number; - [key: string]: unknown | number | undefined; + [key: string]: unknown; }; /** @@ -11232,6 +10335,7 @@ export type WatchPreviewRequest = { path?: string; /** * Kinds + * * what to pick up: audio (and video), transcripts, both of those (PDFs read as transcripts), documents (PDFs and images), or all of them (PDFs as documents; the default) */ kinds?: "audio" | "transcripts" | "both" | "documents" | "all" | null; @@ -11251,6 +10355,7 @@ export type WatchPreviewRequest = { export type WatchUpdate = { /** * Kinds + * * what to pick up: audio (and video), transcripts, both of those (PDFs read as transcripts), documents (PDFs and images), or all of them (PDFs as documents; the default) */ kinds?: "audio" | "transcripts" | "both" | "documents" | "all" | null; @@ -11264,6 +10369,7 @@ export type WatchUpdate = { stable_seconds?: number | null; /** * Backfill + * * also import files already there */ backfill?: boolean | null; @@ -11295,26 +10401,31 @@ export type WatchUpdate = { export type WebImportRequest = { /** * Url + * * the page's address, http:// or https:// */ url: string; /** * Namespace + * * a namespace you edit; admins may name a new one */ namespace: string; /** * Title + * * default: the page's own title, once it's captured */ title?: string | null; /** * Pipeline + * * run this pipeline afterwards instead of the namespace's */ pipeline?: number | null; /** * Collection + * * a collection of the namespace to put it in; default: its default collection */ collection?: number | null; @@ -11322,30 +10433,35 @@ export type WebImportRequest = { /** * WebPage + * * A web page captured as a document: where it was, and when. */ export type WebPage = { /** * Url + * * the address given */ url: string; /** * Final + * * the address it ended at, after redirects */ final?: string | null; /** * Captured At + * * when it was captured; none until its pipeline has run */ captured_at?: string | null; /** * How + * * printed by Chromium, or a PDF kept as it was */ how?: "printed" | "pdf" | null; - [key: string]: unknown | string | string | null | string | null | "printed" | "pdf" | null | undefined; + [key: string]: unknown; }; /** @@ -11366,21 +10482,25 @@ export type WorkerInfo = { host?: string | null; /** * Heartbeat At + * * its last heartbeat: every 30 s when idle, every 15 s during a run */ heartbeat_at?: string | null; /** * Current + * * the job it's running */ current?: unknown; /** * Paused + * * it takes no new runs (POST /workers/{name}/pause) */ paused?: boolean; /** * Draining + * * it hands the run it has back to the queue after the step it's on */ draining?: boolean; @@ -11394,6 +10514,7 @@ export type WorkerInfo = { paused_at?: string | null; /** * Load + * * its machine's 1-minute load average per CPU (1.0: every CPU busy) */ load?: number | null; @@ -11403,28 +10524,11 @@ export type WorkerInfo = { cpus?: number | null; /** * Steps Last Hour + * * steps it finished (done or skipped) in the last hour */ steps_last_hour?: number; - [key: string]: - | unknown - | string - | Array - | string - | null - | string - | null - | boolean - | string - | null - | string - | null - | number - | null - | number - | null - | number - | undefined; + [key: string]: unknown; }; /** @@ -11476,23 +10580,7 @@ export type Workflow = { * History */ history?: Array; - [key: string]: - | unknown - | number - | string - | string - | null - | string - | null - | string - | null - | WorkflowGraph - | string - | null - | string - | null - | Array - | undefined; + [key: string]: unknown; }; /** @@ -11505,6 +10593,7 @@ export type WorkflowCatalog = { node_types: Array; /** * Operators + * * what a condition node can test */ operators: Array; @@ -11520,8 +10609,7 @@ export type WorkflowCatalog = { * Workflows */ workflows: Array; - [key: string]: - unknown | Array | Array | Array | Array | Array | undefined; + [key: string]: unknown; }; /** @@ -11549,6 +10637,7 @@ export type WorkflowCreate = { export type WorkflowGraph = { /** * Nodes + * * {id, type, config, label, x, y} */ nodes: Array<{ @@ -11556,6 +10645,7 @@ export type WorkflowGraph = { }>; /** * Edges + * * {source, target, branch (a condition's yes or no)} */ edges?: Array<{ @@ -11595,6 +10685,7 @@ export type WorkflowSummary = { description?: string | null; /** * Scope + * * recording (run by pipelines) or graph (run over namespaces by routines) */ scope?: string; @@ -11608,10 +10699,11 @@ export type WorkflowSummary = { updated_at?: string | null; /** * Pipelines + * * pipelines whose current version runs it */ pipelines?: Array; - [key: string]: unknown | number | string | string | null | string | null | Array | undefined; + [key: string]: unknown; }; /** @@ -11663,7 +10755,7 @@ export type WorkflowVersionInfo = { * Created By */ created_by?: string | null; - [key: string]: unknown | number | string | null | string | null | string | null | undefined; + [key: string]: unknown; }; export type StatusData = { @@ -11908,6 +11000,7 @@ export type ListTokensData = { export type ListTokensResponses = { /** * Response Tokens-List Tokens + * * Successful Response */ 200: Array; @@ -12162,6 +11255,7 @@ export type ListGrantsData = { export type ListGrantsResponses = { /** * Response Oauth-List Grants + * * Successful Response */ 200: Array; @@ -12209,6 +11303,7 @@ export type ListUsersData = { export type ListUsersResponses = { /** * Response Users-List Users + * * Successful Response */ 200: Array; @@ -12295,6 +11390,7 @@ export type ListMembersError = ListMembersErrors[keyof ListMembersErrors]; export type ListMembersResponses = { /** * Response Users-List Members + * * Successful Response */ 200: Array; @@ -12342,6 +11438,7 @@ export type GetSettingsData = { export type GetSettingsResponses = { /** * Response Admin-Get Settings + * * Successful Response */ 200: { @@ -12458,6 +11555,7 @@ export type ListAuditError = ListAuditErrors[keyof ListAuditErrors]; export type ListAuditResponses = { /** * Response Admin-List Audit + * * Successful Response */ 200: Array; @@ -12475,6 +11573,7 @@ export type ListAllTokensData = { export type ListAllTokensResponses = { /** * Response Admin-List All Tokens + * * Successful Response */ 200: Array; @@ -12695,6 +11794,7 @@ export type ListNamespacesData = { export type ListNamespacesResponses = { /** * Response Namespaces-List Namespaces + * * Successful Response */ 200: Array; @@ -12798,16 +11898,19 @@ export type GetNamespaceStatsData = { query?: { /** * From + * * recorded on or after this day */ from?: string | null; /** * To + * * recorded on or before this day */ to?: string | null; /** * Top + * * how many speakers in `top_speakers` */ top?: number; @@ -12985,6 +12088,7 @@ export type ListNamespaceCollectionsError = ListNamespaceCollectionsErrors[keyof export type ListNamespaceCollectionsResponses = { /** * Response Namespaces-List Namespace Collections + * * Successful Response */ 200: Array; @@ -13156,6 +12260,7 @@ export type ListCollectionMembersError = ListCollectionMembersErrors[keyof ListC export type ListCollectionMembersResponses = { /** * Response Namespaces-List Collection Members + * * Successful Response */ 200: Array; @@ -13191,6 +12296,7 @@ export type SetCollectionMemberError = SetCollectionMemberErrors[keyof SetCollec export type SetCollectionMemberResponses = { /** * Response Namespaces-Set Collection Member + * * Successful Response */ 200: Array; @@ -13204,111 +12310,133 @@ export type ListRecordingsData = { query?: { /** * Ns + * * one namespace (default: every namespace you can read) */ ns?: string | null; /** * Q + * * words that must all appear in the title, the namespace or a speaker's name */ q?: string | null; /** * Status + * * recording statuses, or processing (a job is queued or running) and failed (the latest job failed); repeat for several (any of them matches) */ status?: Array<"new" | "transcribed" | "diarized" | "analyzed" | "error" | "processing" | "failed"> | null; /** * Attention + * * only recordings that need a person: errored, latest job failed, or a voice match to review */ attention?: boolean; /** * Processing + * * only recordings with a job queued or running */ processing?: boolean; /** * Speaker + * * speaker ids; repeat for several (any of them matches) */ speaker?: Array | null; /** * From + * * recorded on or after this day */ from?: string | null; /** * To + * * recorded on or before this day */ to?: string | null; /** * Min Duration + * * at least this many seconds long */ min_duration?: number | null; /** * Max Duration + * * shorter than this many seconds */ max_duration?: number | null; /** * Media + * * audio, video, transcript (no media), document or image */ media?: "audio" | "video" | "transcript" | "document" | "image" | null; /** * Access + * * public, restricted or private; repeat for several */ access?: Array<"public" | "restricted" | "private"> | null; /** * Featured + * * only featured recordings (true) or only the others (false) */ featured?: boolean | null; /** * Tag + * * tags (ignoring case); repeat for several (any of them matches) */ tag?: Array | null; /** * Origin + * * where they came from: source: (a connected source), upload, paste, iiif, folder (the archive's own folders) or file; repeat for several */ origin?: Array | null; /** * Language + * * language codes (ignoring case), none for recordings whose language isn't known; repeat for several */ language?: Array | null; /** * Object + * * kinds of object seen in it (person, car, dog …; ignoring case); repeat for several (any of them matches) */ object?: Array | null; /** * Edited By + * * me: recordings you edited (corrected the transcript, changed the catalogue record or renamed) */ edited_by?: "me" | null; /** * Collection + * * a collection: the recordings in it and in the collections inside it */ collection?: number | null; /** * Field + * * a custom field (of resources): the recordings with a value for it, or with `value` */ field?: number | null; /** * Value + * * with `field`: text that its value contains, the number, a date it starts with (1998, 1998-05), true/false, or one of its options */ value?: string | null; /** * Sort + * * date, title, duration, speakers, status or importance; prefix - for descending */ sort?: @@ -13348,6 +12476,7 @@ export type ListRecordingsError = ListRecordingsErrors[keyof ListRecordingsError export type ListRecordingsResponses = { /** * Response Recordings-List Recordings + * * Successful Response */ 200: Array; @@ -13361,6 +12490,7 @@ export type ListTagsData = { query?: { /** * Ns + * * one namespace */ ns?: string | null; @@ -13380,6 +12510,7 @@ export type ListTagsError = ListTagsErrors[keyof ListTagsErrors]; export type ListTagsResponses = { /** * Response Recordings-List Tags + * * Successful Response */ 200: Array; @@ -13418,6 +12549,7 @@ export type ListOriginsData = { query?: { /** * Ns + * * one namespace */ ns?: string | null; @@ -13437,6 +12569,7 @@ export type ListOriginsError = ListOriginsErrors[keyof ListOriginsErrors]; export type ListOriginsResponses = { /** * Response Recordings-List Origins + * * Successful Response */ 200: Array; @@ -13450,6 +12583,7 @@ export type ListLanguagesData = { query?: { /** * Ns + * * one namespace */ ns?: string | null; @@ -13469,6 +12603,7 @@ export type ListLanguagesError = ListLanguagesErrors[keyof ListLanguagesErrors]; export type ListLanguagesResponses = { /** * Response Recordings-List Languages + * * Successful Response */ 200: Array; @@ -13482,6 +12617,7 @@ export type ListObjectsData = { query?: { /** * Ns + * * one namespace */ ns?: string | null; @@ -13501,6 +12637,7 @@ export type ListObjectsError = ListObjectsErrors[keyof ListObjectsErrors]; export type ListObjectsResponses = { /** * Response Recordings-List Objects + * * Successful Response */ 200: Array; @@ -13737,6 +12874,7 @@ export type ListRecordingPermissionsError = ListRecordingPermissionsErrors[keyof export type ListRecordingPermissionsResponses = { /** * Response Recordings-List Recording Permissions + * * Successful Response */ 200: Array; @@ -13769,6 +12907,7 @@ export type AddRecordingPermissionError = AddRecordingPermissionErrors[keyof Add export type AddRecordingPermissionResponses = { /** * Response Recordings-Add Recording Permission + * * Successful Response */ 200: Array; @@ -13804,6 +12943,7 @@ export type RemoveRecordingPermissionError = RemoveRecordingPermissionErrors[key export type RemoveRecordingPermissionResponses = { /** * Response Recordings-Remove Recording Permission + * * Successful Response */ 200: Array; @@ -13836,6 +12976,7 @@ export type ListRecordingIpGroupsError = ListRecordingIpGroupsErrors[keyof ListR export type ListRecordingIpGroupsResponses = { /** * Response Recordings-List Recording Ip Groups + * * Successful Response */ 200: Array; @@ -13871,6 +13012,7 @@ export type CloseRecordingToIpGroupError = CloseRecordingToIpGroupErrors[keyof C export type CloseRecordingToIpGroupResponses = { /** * Response Recordings-Close Recording To Ip Group + * * Successful Response */ 200: Array; @@ -13906,6 +13048,7 @@ export type OpenRecordingToIpGroupError = OpenRecordingToIpGroupErrors[keyof Ope export type OpenRecordingToIpGroupResponses = { /** * Response Recordings-Open Recording To Ip Group + * * Successful Response */ 200: Array; @@ -13937,6 +13080,7 @@ export type ListAccessRequestsError = ListAccessRequestsErrors[keyof ListAccessR export type ListAccessRequestsResponses = { /** * Response Recordings-List Access Requests + * * Successful Response */ 200: Array; @@ -13972,6 +13116,7 @@ export type ApproveAccessRequestError = ApproveAccessRequestErrors[keyof Approve export type ApproveAccessRequestResponses = { /** * Response Recordings-Approve Access Request + * * Successful Response */ 200: Array; @@ -14007,6 +13152,7 @@ export type DeclineAccessRequestError = DeclineAccessRequestErrors[keyof Decline export type DeclineAccessRequestResponses = { /** * Response Recordings-Decline Access Request + * * Successful Response */ 200: Array; @@ -14060,6 +13206,7 @@ export type GetEmbedLinkData = { query?: { /** * T + * * start at this second */ t?: number; @@ -14262,6 +13409,7 @@ export type RevokeShareData = { rid: number; /** * Sid + * * the link's id */ sid: string; @@ -14312,6 +13460,7 @@ export type ListSharesError = ListSharesErrors[keyof ListSharesErrors]; export type ListSharesResponses = { /** * Response Recordings-List Shares + * * Successful Response */ 200: Array; @@ -14477,6 +13626,7 @@ export type ListSegmentEditsError = ListSegmentEditsErrors[keyof ListSegmentEdit export type ListSegmentEditsResponses = { /** * Response Recordings-List Segment Edits + * * Successful Response */ 200: Array; @@ -14508,6 +13658,7 @@ export type ListOutputsError = ListOutputsErrors[keyof ListOutputsErrors]; export type ListOutputsResponses = { /** * Response Recordings-List Outputs + * * Successful Response */ 200: Array; @@ -14539,6 +13690,7 @@ export type ListNotesError = ListNotesErrors[keyof ListNotesErrors]; export type ListNotesResponses = { /** * Response Notes-List Notes + * * Successful Response */ 200: Array; @@ -14668,6 +13820,7 @@ export type ListCommentsError = ListCommentsErrors[keyof ListCommentsErrors]; export type ListCommentsResponses = { /** * Response Comments-List Comments + * * Successful Response */ 200: Array; @@ -14797,6 +13950,7 @@ export type ListHighlightsError = ListHighlightsErrors[keyof ListHighlightsError export type ListHighlightsResponses = { /** * Response Comments-List Highlights + * * Successful Response */ 200: Array; @@ -14943,16 +14097,19 @@ export type AddFileData = { query: { /** * Role + * * what it is: transcripts, captions, translations and indexes are read into lines search finds */ role: "transcript" | "captions" | "translation" | "index" | "thumbnail" | "attachment"; /** * Name + * * its file name, with the extension */ name: string; /** * Language + * * what language it's in (en, pt-BR) */ language?: string | null; @@ -15151,6 +14308,7 @@ export type ListFieldsError = ListFieldsErrors[keyof ListFieldsErrors]; export type ListFieldsResponses = { /** * Response Fields-List Fields + * * Successful Response */ 200: Array; @@ -15612,6 +14770,7 @@ export type ListUploadsData = { export type ListUploadsResponses = { /** * Response Uploads-List Uploads + * * Successful Response */ 200: Array; @@ -15715,6 +14874,7 @@ export type SendChunkData = { query: { /** * Offset + * * where this chunk starts in the file: the upload's `offset` */ offset: number; @@ -15746,6 +14906,7 @@ export type SearchTranscriptsData = { query: { /** * Q + * * words, "phrases", OR between alternatives */ q: string; @@ -15767,6 +14928,7 @@ export type SearchTranscriptsData = { recording?: number | null; /** * Object + * * only recordings this kind of object is seen in (person, car …) */ object?: string | null; @@ -15780,6 +14942,7 @@ export type SearchTranscriptsData = { offset?: number; /** * Facets + * * also count all the matching moments by namespace, speaker, emotion and recording, and list their kinds of object */ facets?: boolean; @@ -15811,6 +14974,7 @@ export type SuggestTermsData = { query: { /** * Prefix + * * the start of a word (a trailing * is ignored) */ prefix: string; @@ -15838,6 +15002,7 @@ export type SuggestTermsError = SuggestTermsErrors[keyof SuggestTermsErrors]; export type SuggestTermsResponses = { /** * Response Search-Suggest Terms + * * Successful Response */ 200: Array; @@ -15851,6 +15016,7 @@ export type GetGraphData = { query?: { /** * Scope + * * "global" or "ns:" */ scope?: string; @@ -15882,6 +15048,7 @@ export type ListMentionsData = { query: { /** * Entities + * * entity ids, comma separated (up to 50) */ entities: string; @@ -15901,6 +15068,7 @@ export type ListMentionsError = ListMentionsErrors[keyof ListMentionsErrors]; export type ListMentionsResponses = { /** * Response Search-List Mentions + * * Successful Response */ 200: Array; @@ -15918,6 +15086,7 @@ export type ListSearchesData = { export type ListSearchesResponses = { /** * Response Searches-List Searches + * * Successful Response */ 200: Array; @@ -16064,6 +15233,7 @@ export type ListSpeakerRecordingsError = ListSpeakerRecordingsErrors[keyof ListS export type ListSpeakerRecordingsResponses = { /** * Response Speakers-List Speaker Recordings + * * Successful Response */ 200: Array; @@ -16339,6 +15509,7 @@ export type ListEntityTypesData = { export type ListEntityTypesResponses = { /** * Response Entities-List Entity Types + * * Successful Response */ 200: Array; @@ -16374,6 +15545,7 @@ export type ListEntitySuggestionsError = ListEntitySuggestionsErrors[keyof ListE export type ListEntitySuggestionsResponses = { /** * Response Entities-List Entity Suggestions + * * Successful Response */ 200: Array<{ @@ -16393,6 +15565,7 @@ export type ListEntityMergesData = { export type ListEntityMergesResponses = { /** * Response Entities-List Entity Merges + * * Successful Response */ 200: Array<{ @@ -16430,6 +15603,7 @@ export type GetEntityTimelineError = GetEntityTimelineErrors[keyof GetEntityTime export type GetEntityTimelineResponses = { /** * Response Entities-Get Entity Timeline + * * Successful Response */ 200: { @@ -16657,6 +15831,7 @@ export type GetEntityConnectionsError = GetEntityConnectionsErrors[keyof GetEnti export type GetEntityConnectionsResponses = { /** * Response Entities-Get Entity Connections + * * Successful Response */ 200: { @@ -16690,6 +15865,7 @@ export type RenameEntityError = RenameEntityErrors[keyof RenameEntityErrors]; export type RenameEntityResponses = { /** * Response Entities-Rename Entity + * * Successful Response */ 200: { @@ -16874,6 +16050,7 @@ export type ExploreGraphError = ExploreGraphErrors[keyof ExploreGraphErrors]; export type ExploreGraphResponses = { /** * Response Entities-Explore Graph + * * Successful Response */ 200: { @@ -16915,6 +16092,7 @@ export type FindGraphPathError = FindGraphPathErrors[keyof FindGraphPathErrors]; export type FindGraphPathResponses = { /** * Response Entities-Find Graph Path + * * Successful Response */ 200: { @@ -17009,6 +16187,7 @@ export type ListRecordingMetadataHistoryError = export type ListRecordingMetadataHistoryResponses = { /** * Response Metadata-List Recording Metadata History + * * Successful Response */ 200: Array; @@ -17667,6 +16846,7 @@ export type PreviewIiifImportError = PreviewIiifImportErrors[keyof PreviewIiifIm export type PreviewIiifImportResponses = { /** * Response Iiif-Preview Iiif Import + * * Successful Response */ 200: { @@ -17711,6 +16891,7 @@ export type ListJobsData = { query?: { /** * Status + * * comma separated, e.g. queued,running */ status?: string | null; @@ -17720,11 +16901,13 @@ export type ListJobsData = { recording?: number | null; /** * Batch + * * only this batch run's jobs */ batch?: number | null; /** * Namespace + * * only this namespace's jobs (404 when you can't read it) */ namespace?: string | null; @@ -17820,6 +17003,7 @@ export type GetJobLogData = { query?: { /** * After + * * start at this line (0-based) */ after?: number; @@ -17949,6 +17133,7 @@ export type ListWorkersData = { export type ListWorkersResponses = { /** * Response Jobs-List Workers + * * Successful Response */ 200: Array; @@ -18004,6 +17189,7 @@ export type StreamEventsData = { once?: boolean; /** * Logs + * * follow this job only, with its new log lines as `log` events */ logs?: number | null; @@ -18037,6 +17223,7 @@ export type ListBackendsData = { export type ListBackendsResponses = { /** * Response Sources-List Backends + * * Successful Response */ 200: { @@ -18056,6 +17243,7 @@ export type ListSourcesData = { export type ListSourcesResponses = { /** * Response Sources-List Sources + * * Successful Response */ 200: Array; @@ -18207,6 +17395,7 @@ export type BrowseSourceError = BrowseSourceErrors[keyof BrowseSourceErrors]; export type BrowseSourceResponses = { /** * Response Sources-Browse Source + * * Successful Response */ 200: Array; @@ -18224,6 +17413,7 @@ export type ListWatchesData = { export type ListWatchesResponses = { /** * Response Sources-List Watches + * * Successful Response */ 200: Array; @@ -18381,6 +17571,7 @@ export type ListTemplatesData = { export type ListTemplatesResponses = { /** * Response Templates-List Templates + * * Successful Response */ 200: Array; @@ -19015,6 +18206,7 @@ export type ListChatsData = { export type ListChatsResponses = { /** * Response Chats-List Chats + * * Successful Response */ 200: Array; @@ -19272,6 +18464,7 @@ export type ListApprovalsError = ListApprovalsErrors[keyof ListApprovalsErrors]; export type ListApprovalsResponses = { /** * Response Chats-List Approvals + * * Successful Response */ 200: Array; @@ -19319,6 +18512,7 @@ export type ListCollectionsData = { export type ListCollectionsResponses = { /** * Response Collections-List Collections + * * Successful Response */ 200: Array; @@ -19476,6 +18670,7 @@ export type ListBatchesData = { export type ListBatchesResponses = { /** * Response Batches-List Batches + * * Successful Response */ 200: Array; @@ -19742,6 +18937,7 @@ export type SearchPublicData = { query?: { /** * Q + * * words, "phrases", OR between alternatives */ q?: string; @@ -19845,6 +19041,7 @@ export type ListPendingAccessRequestsData = { export type ListPendingAccessRequestsResponses = { /** * Response Access Requests-List Pending Access Requests + * * Successful Response */ 200: Array; @@ -19863,6 +19060,7 @@ export type ListViewsData = { export type ListViewsResponses = { /** * Response Views-List Views + * * Successful Response */ 200: Array; @@ -20179,6 +19377,7 @@ export type ListNotifyDeliveriesError = ListNotifyDeliveriesErrors[keyof ListNot export type ListNotifyDeliveriesResponses = { /** * Response Notifications-List Notify Deliveries + * * Successful Response */ 200: Array; @@ -20410,6 +19609,7 @@ export type ListRunsError = ListRunsErrors[keyof ListRunsErrors]; export type ListRunsResponses = { /** * Response Routines-List Runs + * * Successful Response */ 200: Array; @@ -20509,6 +19709,7 @@ export type ListGraphChangesError = ListGraphChangesErrors[keyof ListGraphChange export type ListGraphChangesResponses = { /** * Response Routines-List Graph Changes + * * Successful Response */ 200: Array; @@ -20605,7 +19806,3 @@ export type UndoGraphChangeResponses = { }; export type UndoGraphChangeResponse = UndoGraphChangeResponses[keyof UndoGraphChangeResponses]; - -export type ClientOptions = { - baseUrl: `${string}://${string}` | (string & {}); -}; diff --git a/nextjs-frontend/auth.ts b/nextjs-frontend/auth.ts index 514bf775d..b547e3e90 100644 --- a/nextjs-frontend/auth.ts +++ b/nextjs-frontend/auth.ts @@ -28,7 +28,7 @@ export const { handlers, auth, signIn, signOut } = NextAuth({ client: createApiClient(), body: parsed.data, }); - if (response.status === 429) throw new ThrottledSignin(); + if (response?.status === 429) throw new ThrottledSignin(); if (!data) return null; return { ...sessionUser(data.user), tokens: tokensFromPair(data) }; diff --git a/nextjs-frontend/lib/api/browser.ts b/nextjs-frontend/lib/api/browser.ts index 33195475b..653989737 100644 --- a/nextjs-frontend/lib/api/browser.ts +++ b/nextjs-frontend/lib/api/browser.ts @@ -5,6 +5,7 @@ import { useMemo } from "react"; import { createClient, createConfig, type Client } from "@/app/openapi-client/client"; import type { ClientOptions } from "@/app/openapi-client/types.gen"; +import { throwingNetworkErrors } from "@/lib/api/client"; import { holdUntilSignedIn, refreshedToken } from "@/lib/auth/reauth"; /** @@ -36,12 +37,14 @@ export function useApiClient(): Client { const token = session?.accessToken; return useMemo( () => - createClient( - createConfig({ - baseUrl: "", - headers: token ? { Authorization: `Bearer ${token}` } : {}, - fetch: fetchWithReauth, - }), + throwingNetworkErrors( + createClient( + createConfig({ + baseUrl: "", + headers: token ? { Authorization: `Bearer ${token}` } : {}, + fetch: fetchWithReauth, + }), + ), ), [token], ); diff --git a/nextjs-frontend/lib/api/client.ts b/nextjs-frontend/lib/api/client.ts index 6f706d62f..1c5931975 100644 --- a/nextjs-frontend/lib/api/client.ts +++ b/nextjs-frontend/lib/api/client.ts @@ -18,7 +18,22 @@ export function createApiClient(accessToken?: string, forwardedFor?: string | nu const headers: Record = {}; if (accessToken) headers.Authorization = `Bearer ${accessToken}`; if (forwardedFor) headers["X-Forwarded-For"] = forwardedFor; - return createClient(createConfig({ baseUrl: apiBaseUrl(), cache: "no-store", headers })); + return throwingNetworkErrors( + createClient(createConfig({ baseUrl: apiBaseUrl(), cache: "no-store", headers })), + ); +} + +/** + * Makes a request that never got a response (the API is down, the fetch was aborted) reject, as it did before + * @hey-api/openapi-ts 0.97. The generated client now returns those as `{ error, response: undefined }`, which callers + * would read as an API error. HTTP errors still come back as `{ error, response }`. + */ +export function throwingNetworkErrors(client: Client): Client { + client.interceptors.error.use((error, response) => { + if (!response) throw error; + return error; + }); + return client; } type ErrorBody = { detail?: unknown } | undefined | null; diff --git a/nextjs-frontend/lib/auth/tokens.ts b/nextjs-frontend/lib/auth/tokens.ts index a67411c7f..5a6df3e88 100644 --- a/nextjs-frontend/lib/auth/tokens.ts +++ b/nextjs-frontend/lib/auth/tokens.ts @@ -69,8 +69,8 @@ export function refreshTokens(refreshToken: string): Promise { body: { refresh_token: refreshToken }, }).then(({ data, response }) => { if (data) return data; - if (response.status === 401) return null; - throw new Error(`Token refresh failed with status ${response.status}`); + if (response?.status === 401) return null; + throw new Error(`Token refresh failed with status ${response?.status}`); }); recent.set(refreshToken, { promise, at: now }); promise.catch(() => recent.delete(refreshToken)); diff --git a/nextjs-frontend/openapi-ts.config.ts b/nextjs-frontend/openapi-ts.config.ts index 37c8b917f..73eb27288 100644 --- a/nextjs-frontend/openapi-ts.config.ts +++ b/nextjs-frontend/openapi-ts.config.ts @@ -10,8 +10,9 @@ export default defineConfig({ // types, so `make openapi`, the dev watcher and the pre-commit hook would each write a different client. input: path.resolve(process.env.OPENAPI_OUTPUT_FILE || "openapi.json"), output: { - format: "prettier", - lint: "eslint", + // Prettier only: eslint.config.mjs ignores the generated client, and ESLint exits non-zero when every file it is + // given is ignored. + postProcess: ["prettier"], path: "app/openapi-client", }, plugins: [ diff --git a/nextjs-frontend/package.json b/nextjs-frontend/package.json index 450ac582f..de72d6d4b 100644 --- a/nextjs-frontend/package.json +++ b/nextjs-frontend/package.json @@ -46,7 +46,7 @@ "@auth/core": "0.41.3", "@eslint/eslintrc": "^3.3.7", "@eslint/js": "^9.39.5", - "@hey-api/openapi-ts": "^0.83.1", + "@hey-api/openapi-ts": "^0.99.0", "@next/eslint-plugin-next": "16.3.7", "@testing-library/jest-dom": "^6.6.3", "@testing-library/react": "^16.3.3", diff --git a/nextjs-frontend/pnpm-lock.yaml b/nextjs-frontend/pnpm-lock.yaml index 8f6dbc3cb..4528b56ca 100644 --- a/nextjs-frontend/pnpm-lock.yaml +++ b/nextjs-frontend/pnpm-lock.yaml @@ -17,6 +17,7 @@ overrides: form-data@^4: ^4.0.6 glob@^10: ^10.5.0 js-yaml@^3: ^3.15.2 + js-yaml@^4: ^4.3.2 lodash@^4: ^4.18.1 minimatch@^3: ^3.1.5 minimatch@^9: ^9.0.9 @@ -119,8 +120,8 @@ importers: specifier: ^9.39.5 version: 9.39.5 '@hey-api/openapi-ts': - specifier: ^0.83.1 - version: 0.83.1(typescript@5.6.3) + specifier: ^0.99.0 + version: 0.99.0(typescript@5.6.3) '@next/eslint-plugin-next': specifier: 16.3.7 version: 16.3.7(eslint@9.39.5(jiti@2.7.0)) @@ -485,22 +486,30 @@ packages: '@floating-ui/utils@0.2.8': resolution: {integrity: sha512-kym7SodPp8/wloecOpcmSnWJsK7M0E5Wg8UcFA+uO4B9s5d0ywXOEro/8HM9x0rW+TljRzul/14UYz3TleT3ig==} - '@hey-api/codegen-core@0.1.0': - resolution: {integrity: sha512-7B6B9Zuw4uQWoG5YwAwNC+UTz6ErAujqaQrJuMu/OgPkUHq+hl6zdKKi2MX/399vPYilo0IGBxQHmY1UfmTHsw==} - engines: {node: ^18.18.0 || ^20.9.0 || >=22.10.0} - peerDependencies: - typescript: '>=5.5.3' + '@hey-api/codegen-core@0.9.1': + resolution: {integrity: sha512-s97jL1dgTMuiMHv2BZ1X4Tgd99Mf9GOvGdNqNcGwIMmnR+PgYNoraj4Zvp134MKsNCap/m7k0r0vKKnl56pj4w==} + engines: {node: '>=22.18.0'} - '@hey-api/json-schema-ref-parser@1.1.0': - resolution: {integrity: sha512-+5eg9pgAAM9oSqJQuUtfTKbLz8yieFKN91myyXiLnprqFj8ROfxUKJLr9DKq/hGKyybKT1WxFSetDqCFm80pCA==} - engines: {node: '>= 16'} + '@hey-api/json-schema-ref-parser@1.4.4': + resolution: {integrity: sha512-otmd+zCxbYVBIp/mlMTnGkvlNYLkVKgs3VOIq0kSnenhB1+fRwLPQIeSwyWM6E51oXhUedkYjVsVpkVexeuJOA==} + engines: {node: '>=22.18.0'} - '@hey-api/openapi-ts@0.83.1': - resolution: {integrity: sha512-AJIXDsXBLXS4uzhU+yVeNmD43uN6FYPcWpcid7Q0bA4JRXpI+6livOzUUMiuszt3NlgHy1gcf6x15W2xHNSoag==} - engines: {node: ^18.18.0 || ^20.9.0 || >=22.10.0} + '@hey-api/openapi-ts@0.99.0': + resolution: {integrity: sha512-SePU/5oEWWkvUBYmvzdYRctseoLuskyhs4ET0RvLIcmzc8yLQoA2R+KtBIQ8bPsoSUB0m4E5SmBnl6aGSA0szQ==} + engines: {node: '>=22.18.0'} hasBin: true peerDependencies: - typescript: '>=5.5.3' + typescript: '>=5.5.3 || >=6.0.0 || 6.0.1-rc' + + '@hey-api/shared@0.5.0': + resolution: {integrity: sha512-JN/j4Ebh4cJGYIQ5cwWuqe7GeSUyQoz7oC51WqyhKOcrejK6DKZMDkshc5d1eKTRuRL+rjozuRcoUaZZn2DGPw==} + engines: {node: '>=22.18.0'} + + '@hey-api/spec-types@0.2.0': + resolution: {integrity: sha512-ibQ8Is7evMavzr8GNyJCcTg975d8DpaMUyLmOrQ85UBdy1l6t1KuRAwgChAbesJsIlNV6gjmlXruWyegDX18Fg==} + + '@hey-api/types@0.1.4': + resolution: {integrity: sha512-thWfawrDIP7wSI9ioT13I5soaaqB5vAPIiZmgD8PbeEVKNrkonc0N/Sjj97ezl7oQgusZmaNphGdMKipPO6IBg==} '@humanfs/core@0.19.2': resolution: {integrity: sha512-UhXNm+CFMWcbChXywFwkmhqjs3PRCmcSa/hfBgLIb7oQ5HNb1wS0icWsGtSAUNgefHeI+eBrA8I1fxmbHsGdvA==} @@ -779,6 +788,10 @@ packages: '@jsdevtools/ono@7.1.3': resolution: {integrity: sha512-4JQNk+3mVzK3xh2rqd6RB4J46qUR19azEHBneZyTZM+c456qOrbbM/5xcR8huNCCcbVt7+UmizG6GuUvPvKUYg==} + '@lukeed/ms@2.0.2': + resolution: {integrity: sha512-9I2Zn6+NJLfaGoz9jN3lpwDgAYvfGeNYdbAIjJOqzs4Tpc+VU3Jqq4IofSUBKajiDS8k9fZIg18/z13mpk1bsA==} + engines: {node: '>=8'} + '@next/env@16.3.7': resolution: {integrity: sha512-/HuhBN1CorqNTmewTIh81yXOQri6B8Ye/c9D7+830XqwVaf8qMnJNrgNxDn6dLtihq8YzBbI6NSAuMKvpr+DvQ==} @@ -1719,10 +1732,10 @@ packages: resolution: {integrity: sha512-tjwM5exMg6BGRI+kNmTntNsvdZS1X8BFYS6tnJ2hdH0kVxM6/eVZ2xy+FqStSWvYmtfFMDLIxurorHwDKfDz5Q==} engines: {node: '>=18'} - c12@2.0.1: - resolution: {integrity: sha512-Z4JgsKXHG37C6PYUtIxCfLJZvo6FyhHJoClwwb9ftUkLpPSkuYqn6Tr+vnaN8hymm0kIbcg6Ey3kv/Q71k5w/A==} + c12@3.3.4: + resolution: {integrity: sha512-cM0ApFQSBXuourJejzwv/AuPRvAxordTyParRVcHjjtXirtkzM0uK2L9TTn9s0cXZbG7E55jCivRQzoxYmRAlA==} peerDependencies: - magicast: ^0.3.5 + magicast: '*' peerDependenciesMeta: magicast: optional: true @@ -1783,17 +1796,14 @@ packages: resolution: {integrity: sha512-n8enUVCED/KVRQlab1hr3MVpcVMvxtZjmEa956u+4YijlmQED223XMSYj2tLuKvr4jcCTzNNMpQDUer72MMmzA==} engines: {node: '>= 14.16.0'} - chownr@2.0.0: - resolution: {integrity: sha512-bIomtDF5KGpdogkLd9VspvFzk9KfpyyGlS8YFVZl7TGPBHL5snIOnxeshwVgPteQ9b4Eydl+pVbIyE1DcvCWgQ==} - engines: {node: '>=10'} + chokidar@5.0.0: + resolution: {integrity: sha512-TQMmc3w+5AxjpL8iIiwebF73dRDF4fBIieAqGn9RGCWaEVwQ6Fb2cGe31Yns0RRIzii5goJ1Y7xbMwo1TxMplw==} + engines: {node: '>= 20.19.0'} ci-info@3.9.0: resolution: {integrity: sha512-NIxF55hv4nSqQswkAeiOi1r83xy8JldOFDTWiug55KBu9Jnblncd2U6ViHmYgHf01TPZS77NJBhBMKdWj9HQMQ==} engines: {node: '>=8'} - citty@0.1.6: - resolution: {integrity: sha512-tskPPKEs8D2KPafUypv2gxwJP8h/OaJmC82QQGGDQcHvXX43xF2VDACcJVmZ0EuSxkpO9Kc4MlrA3q0+FG58AQ==} - cjs-module-lexer@1.4.1: resolution: {integrity: sha512-cuSVIHi9/9E/+821Qjdvngor+xpnlwnuwIyZOaLmHBVdXL+gP+I6QQB9VkO7RI77YIcTV+S1W9AreJ5eN63JBA==} @@ -1845,9 +1855,9 @@ packages: resolution: {integrity: sha512-FQN4MRfuJeHf7cBbBMJFXhKSDq+2kAArBlmRBvcvFE5BB1HZKXtSFASDhdlz9zOYwxh8lDdnvmMOe/+5cdoEdg==} engines: {node: '>= 0.8'} - commander@13.0.0: - resolution: {integrity: sha512-oPYleIY8wmTVzkvQq10AEok6YcTC4sRUBl8F9gVuwchGVUCTbl/vhLTaQqutuuySYOsu8YTgV+OxKc/8Yvx+mQ==} - engines: {node: '>=18'} + commander@15.0.0: + resolution: {integrity: sha512-z67u4ZhzCL/Tydu1lJARtEZYWbWaN7oYLHbsuzocr6y4N6WZAagG3RQ4FW61V1/0+jImpj293XfrcYnd1qxtPg==} + engines: {node: '>=22.12.0'} commander@4.1.1: resolution: {integrity: sha512-NOKm8xhkzAjzFx8B2v5OAHT+u5pRQc2UCa2Vq9jYL/31o2wi9mxBA7LIFs3sV5VSC49z6pEhfbMULvShKj26WA==} @@ -1856,12 +1866,11 @@ packages: concat-map@0.0.1: resolution: {integrity: sha512-/Srv4dswyQNBfohGpz9o6Yb3Gz3SrUDqBH5rTuhGR7ahtlbYKnVxw2bCFMRljaA7EXHaXZ8wsHdodFvbkhKmqg==} - confbox@0.1.8: - resolution: {integrity: sha512-RMtmw0iFkeR4YV+fUOSucriAQNb9g8zFR52MWCtl+cCZOFRNL6zeB395vPzFhEjjn4fMxXudmELnl/KF/WrK6w==} + confbox@0.2.4: + resolution: {integrity: sha512-ysOGlgTFbN2/Y6Cg3Iye8YKulHw+R2fNXHrgSmXISQdMnomY6eNDprVdW9R5xBguEqI954+S6709UyiO7B+6OQ==} - consola@3.4.2: - resolution: {integrity: sha512-5IKcdX0nnYavi6G7TtOhwkYzyjfJlatbjMjuLSfE2kYT5pMDOilZ4OvMhi637CcDICTmz3wARPoyhqyX1Y+XvA==} - engines: {node: ^14.18.0 || >=16.10.0} + confbox@0.3.1: + resolution: {integrity: sha512-cKUSoKa8YxFZZSmraVi7onONx3amu77ngK3kGpsYHDH7drPwCRkQE1RYMPlLRrMtnciRj274XNRxcHxnKmDSnA==} convert-source-map@2.0.0: resolution: {integrity: sha512-Kvp459HrV2FEJ1CAsi1Ku+MY3kasH19TFykTz2xWmMeq6bk2NU3XXvfJ+Q61m0xktWwt+1HSYf3JZsTms3aRJg==} @@ -1874,10 +1883,6 @@ packages: create-require@1.1.1: resolution: {integrity: sha512-dcKFX3jn0MpIaXjisoRvexIJVEKzaq7z2rZKxf+MSr9TkdmHmsU4m2lcLojrj/FHl8mk5VxMmYA+ftRkP/3oKQ==} - cross-spawn@7.0.5: - resolution: {integrity: sha512-ZVJrKKYunU38/76t0RMOulHOnUcbU9GbpWKAOZ0mhjr7CX6FVrH+4FrAapSOekrgFQ3f/8gwMEuIft0aKq6Hug==} - engines: {node: '>= 8'} - cross-spawn@7.0.6: resolution: {integrity: sha512-uV2QOWP2nWzsy2aMp8aRibhi9dlzF5Hgh5SHaB9OiTGEyDTiJJyx0uy51QXdyWbtAHNua4XJzUKca3OzKUd3vA==} engines: {node: '>= 8'} @@ -2086,6 +2091,10 @@ packages: resolution: {integrity: sha512-ZmdL2rui+eB2YwhsWzjInR8LldtZHGDoQ1ugH85ppHKwpUHL7j7rN0Ti9NCnGiQbhaZ11FpR+7ao1dNsmduNUg==} engines: {node: '>=12'} + dotenv@17.4.2: + resolution: {integrity: sha512-nI4U3TottKAcAD9LLud4Cb7b2QztQMUEfHbvhTH09bqXTxnSie8WnjPALV/WMCrJZ6UV/qHJ6L03OqO3LcdYZw==} + engines: {node: '>=12'} + dunder-proto@1.0.1: resolution: {integrity: sha512-KIN/nDJBQRcXw0MLVhZE9iQHmG68qAVIBg9CqmUYjmQIhgij9U5MFvrqkUL5FbtyyzZuOeOt0zdeRe4UY7ct+A==} engines: {node: '>= 0.4'} @@ -2321,6 +2330,9 @@ packages: resolution: {integrity: sha512-2Zks0hf1VLFYI1kbh0I5jP3KHHyCHpkfyHBzsSXRFgl/Bg9mWYfMW8oD+PdMPlEwy5HNsR9JutYy6pMeOh61nw==} engines: {node: ^14.15.0 || ^16.10.0 || >=18.0.0} + exsolve@1.1.1: + resolution: {integrity: sha512-9U/jZUgjnSGyntRr6y5Muu1MJcwFl6kPu7k8qLF0IMNfLqvw0NZ4nnVDq0RVoZ0RvCyumib4Ez3KYrVfilrw+g==} + fast-deep-equal@3.1.3: resolution: {integrity: sha512-f3qQ9oQy9j2AhBe/H9VC91wLmKBCCU/gDOnKNAYG5hswO7BLKj09Hc5HYNz9cGI++xlpDCIgDaitVs03ATR84Q==} @@ -2395,10 +2407,6 @@ packages: fraction.js@5.3.4: resolution: {integrity: sha512-1X1NTtiJphryn/uLQz3whtY6jK3fTqoE3ohKs0tT+Ujr1W59oopxmoEh7Lu5p6vBaPbgoM0bzveAW4Qi5RyWDQ==} - fs-minipass@2.1.0: - resolution: {integrity: sha512-V/JgOLFCS+R6Vcq0slCuaeWEdNC3ouDlJMNIsacH2VtALiu9mV4LPrHc5cDl8k5aw6J8jwgWWpiTo5RYhmIzvg==} - engines: {node: '>= 8'} - fs.realpath@1.0.0: resolution: {integrity: sha512-OO0pH2lK6a0hZnAdau5ItzHPI6pUlvI7jMVnxUQRtw4owF2wk8lOSabtGDCTP4Ggrg2MbGnWO9X8K1t4+fGMDw==} @@ -2449,11 +2457,14 @@ packages: resolution: {integrity: sha512-w9UMqWwJxHNOvoNzSJ2oPF5wvYcvP7jUvYzhp67yEhTi17ZDBBC1z9pTdGuzjD+EFIqLSYRweZjqfiPzQ06Ebg==} engines: {node: '>= 0.4'} + get-tsconfig@4.14.0: + resolution: {integrity: sha512-yTb+8DXzDREzgvYmh6s9vHsSVCHeC0G3PI5bEXNBHtmshPnO+S5O7qgLEOn0I5QvMy6kpZN8K1NKGyilLb93wA==} + get-tsconfig@4.8.1: resolution: {integrity: sha512-k9PN+cFBmaLWtVz29SkUoqU5O0slLuHJXt/2P+tMVFT+phsSGXGkp9t3rQIqdz0e+06EHNGs3oM6ZX1s2zHxRg==} - giget@1.2.5: - resolution: {integrity: sha512-r1ekGw/Bgpi3HLV3h1MRBIlSAdHoIMklpaQ3OQLFcRw9PwAj2rqigvIbg+dBUI51OxVI2jsEtDywDBjSiuf7Ug==} + giget@3.3.1: + resolution: {integrity: sha512-r+mvuDjrjMpsdw46Kmeydb8bdHm7wOKw8wNBtTndkjbPjgAp5oUJUxRE76wZFknxIPokfWvep2qSXK37aXE6zg==} hasBin: true glob-parent@5.1.2: @@ -2496,11 +2507,6 @@ packages: graceful-fs@4.2.11: resolution: {integrity: sha512-RbJ5/jmFcNNCcDV5o9eTnBLJ/HszWV0P73bc+Ff4nS/rJj+YaS6IGyiOL0VoBYX+l1Wrl3k63h/KrH+nhJ0XvQ==} - handlebars@4.7.8: - resolution: {integrity: sha512-vafaFqs8MZkRrSX7sFVUdo3ap/eNiLnb4IakshzvP56X5Nr1iGKAIqdX6tMlm6HcNRIkr6AxO5jFEoJzzpT8aQ==} - engines: {node: '>=0.4.7'} - hasBin: true - handlebars@4.7.9: resolution: {integrity: sha512-4E71E0rpOaQuJR2A3xDZ+GM1HyWYv1clR58tC8emQNeQe3RH7MAzSbat+V0wG78LQBo6m6bzSG/L4pBuCsgnUQ==} engines: {node: '>=0.4.7'} @@ -2680,6 +2686,10 @@ packages: resolution: {integrity: sha512-xelSayHH36ZgE7ZWhli7pW34hNbNl8Ojv5KVmkJD4hBdD3th8Tfk9vYasLM+mXWOZhFkgZfxhLSnrwRr4elSSg==} engines: {node: '>=0.10.0'} + is-in-ssh@1.0.0: + resolution: {integrity: sha512-jYa6Q9rH90kR1vKB6NM7qqd1mge3Fx4Dhw5TVlK1MUBqhEOuCagrEHMevNuCcbECmXZ0ThXkRm+Ymr51HwEPAw==} + engines: {node: '>=20'} + is-inside-container@1.0.0: resolution: {integrity: sha512-KIYLCCJghfHZxqjYBE7rEy0OBuTd5xCHS7tHVgvCLkx7StIoaxwNW3hCALgEUjFfeRk+MG/Qxmp/vtETEF3tRA==} engines: {node: '>=14.16'} @@ -3114,30 +3124,10 @@ packages: minimist@1.2.8: resolution: {integrity: sha512-2yyAR8qBkN3YuheJanUpWC5U3bb5osDywNB8RzDVlDwDHbocAJveqqj1u8+SVD7jkWT4yvsHCpWqqWqAxb0zCA==} - minipass@3.3.6: - resolution: {integrity: sha512-DxiNidxSEK+tHG6zOIklvNOwm3hvCrbUrdtzY74U6HKTJxvIDfOUL5W5P2Ghd3DTkhhKPYGqeNUIh5qcM4YBfw==} - engines: {node: '>=8'} - - minipass@5.0.0: - resolution: {integrity: sha512-3FnjYuehv9k6ovOEbyOswadCDPX1piCfhV8ncmYtHOjuPwylVWsghTLo7rabjC3Rx5xD4HDx8Wm1xnMF7S5qFQ==} - engines: {node: '>=8'} - minipass@7.1.2: resolution: {integrity: sha512-qOOzS1cBTWYF4BH8fVePDBOO9iptMnGUEZwNc/cMWnTV2nVLZ7VoNWEPHkYczZA0pdoA7dl6e7FL659nX9S2aw==} engines: {node: '>=16 || 14 >=14.17'} - minizlib@2.1.2: - resolution: {integrity: sha512-bAxsR8BVfj60DWXHE3u30oHzfl4G7khkSuPW+qvpd7jFRHm7dLxOjUk1EHACJ/hxLY8phGJ0YhYHZo7jil7Qdg==} - engines: {node: '>= 8'} - - mkdirp@1.0.4: - resolution: {integrity: sha512-vVqVZQyf3WLx2Shd0qJ9xuvqgAyKPLAiqITEtqW0oIUjzo3PePDd6fW9iFz30ef7Ysp/oiWqbhszeGWW2T6Gzw==} - engines: {node: '>=10'} - hasBin: true - - mlly@1.8.2: - resolution: {integrity: sha512-d+ObxMQFmbt10sretNDytwt85VrbkhhUA/JBGm1MPaWJ65Cl4wOgLaB1NYvJSZ0Ef03MMEU/0xpPMXUIQ29UfA==} - ms@2.1.3: resolution: {integrity: sha512-6FlzubTLZG3J2a/NVCAleEhjzq5oxgHyaCU9yYXvcLsvoVaHJq/s5xXI6/XXP6tz7R9xAOtHnSO/tXtF3WRTlA==} @@ -3192,9 +3182,6 @@ packages: sass: optional: true - node-fetch-native@1.6.7: - resolution: {integrity: sha512-g9yhqoedzIUm0nTnTqAQvueMPVOuIY16bqgAJJC8XOOubYFNwz6IER9qs0Gq2Xd0+CecCKFjtdDTMA4u4xG06Q==} - node-int64@0.4.0: resolution: {integrity: sha512-O5lz91xSOeoXP6DulyHfllpq+Eg00MWitZIbtPfoSEvqIHdl5gfcY6hYzDWnj0qD5tz52PI08u9qUvSVeUBeHw==} @@ -3213,11 +3200,6 @@ packages: nwsapi@2.2.13: resolution: {integrity: sha512-cTGB9ptp9dY9A5VbMSe7fQBcl/tt22Vcqdq8+eN93rblOuE0aCFu4aZ2vMwct/2t+lFnosm8RkQW1I0Omb1UtQ==} - nypm@0.5.4: - resolution: {integrity: sha512-X0SNNrZiGU8/e/zAB7sCTtdxWTMSIO73q+xuKgglm2Yvzwlo8UoC5FNySQFCvl84uPaeADkqHUZUkWy4aH4xOA==} - engines: {node: ^14.16.0 || >=16.10.0} - hasBin: true - oauth4webapi@3.8.8: resolution: {integrity: sha512-8N28E+a/oxfXWBgOMt+ZP/JUf/XR+IFbvkAEPP3gznXOMv9BpAAwiIj0TFNz3tGTPc0ZQ8zmWBNgN1nAys0gng==} @@ -3257,8 +3239,8 @@ packages: resolution: {integrity: sha512-gXah6aZrcUxjWg2zR2MwouP2eHlCBzdV4pygudehaKXSGW4v2AsRQUK+lwwXhii6KFZcunEnmSUoYp5CXibxtA==} engines: {node: '>= 0.4'} - ohash@1.1.6: - resolution: {integrity: sha512-TBu7PtV8YkAZn0tSxobKY2n2aAQva936lhRrj6957aDaCf9IEtqsKbgMzXE/F/sjqYOwmrukeORHNLe5glk7Cg==} + ohash@2.0.12: + resolution: {integrity: sha512-65S/5gk9YSsaRjcyf7Nfa6h/d3E8/1gslpXfI4W7Dxn/oap8IKRuNT5VXkLQ1YFKIEg4apRY4Pj6aiwFzrDdmw==} once@1.4.0: resolution: {integrity: sha512-lNaJgI+2Q5URQBkccEKHTQOPaXdUxnZZElQTZY0MFUAuaEqe1E+Nyvgdz/aIyNi6Z9MzO5dv1H8n58/GELp3+w==} @@ -3267,9 +3249,9 @@ packages: resolution: {integrity: sha512-kbpaSSGJTWdAY5KPVeMOKXSrPtr8C8C7wodJbcsd51jRnmD+GZu8Y0VoU6Dm5Z4vWr0Ig/1NKuWRKf7j5aaYSg==} engines: {node: '>=6'} - open@10.1.2: - resolution: {integrity: sha512-cxN6aIDPz6rm8hbebcP7vrQNhvRcveZoJU72Y7vskh4oIm+BZwBECnx5nTmrlres1Qapvx27Qo1Auukpf8PKXw==} - engines: {node: '>=18'} + open@11.0.0: + resolution: {integrity: sha512-smsWv2LzFjP03xmvFoJ331ss6h+jixfA4UUV/Bsiyuu4YJPfN+FIQGOIiv4w9/+MoHkfkJ22UIaQWRVFRfH6Vw==} + engines: {node: '>=20'} optionator@0.9.4: resolution: {integrity: sha512-6IpQ7mKUxRcZNLIObR0hz7lxsapSSIYNZJwXPGeF0mTVqGKFIXj1DQcMoT22S3ROcLyY/rz0PWaWZ9ayWmad9g==} @@ -3340,14 +3322,11 @@ packages: resolution: {integrity: sha512-Xa4Nw17FS9ApQFJ9umLiJS4orGjm7ZzwUrwamcGQuHSzDyth9boKDaycYdDcZDuqYATXw4HFXgaqWTctW/v1HA==} engines: {node: '>=16 || 14 >=14.18'} - pathe@1.1.2: - resolution: {integrity: sha512-whLdWMYL2TwI08hn8/ZqAbrVemu0LNaNNJZX73O6qaIdCTfXutsLhMkjdENX0qhsQ9uIimo4/aQOmXkoon2nDQ==} - pathe@2.0.3: resolution: {integrity: sha512-WUjGcAqP1gQacoQe+OBJsFA7Ld4DyXuUIjZ5cc75cLHvJ7dtNsTugphxIADwspS+AraAUePCKrSVtPLFj/F88w==} - perfect-debounce@1.0.0: - resolution: {integrity: sha512-xCy9V055GLEqoFaHoC1SoLIaLmWctgCUaBaWxDZ7/Zx4CTyX7cJQLJOok/orfjZAh9kEYpjJa4d0KcJmCbctZA==} + perfect-debounce@2.1.0: + resolution: {integrity: sha512-LjgdTytVFXeUgtHZr9WYViYSM/g8MkcTPYDlPa3cDqMirHjKiSZPYd6DoL7pK8AJQr+uWkQvCjHNdiMqsrJs+g==} picocolors@1.1.1: resolution: {integrity: sha512-xceH2snhtb5M9liqDsmEw56le376mTZkEX/jEb/RxNFyegNul7eNslCXP9FDj/Lcu0X8KEyMceP2ntpaHrDEVA==} @@ -3372,8 +3351,8 @@ packages: resolution: {integrity: sha512-HRDzbaKjC+AOWVXxAU/x54COGeIv9eb+6CkDSQoNTt4XyWoIJvuPsXizxu/Fr23EiekbtZwmh1IcIG/l/a10GQ==} engines: {node: '>=8'} - pkg-types@1.3.1: - resolution: {integrity: sha512-/Jm5M4RvtBFVkKWRu2BLUTNP8/M2a+UwuAX+ae4770q1qVGtfjG+WTCupoZixokjmHiry8uI+dlY8KXYV5HVVQ==} + pkg-types@2.3.3: + resolution: {integrity: sha512-j/lCFdcppV0JxWpCEITdbDltBxPP6cHT+yNJ6Go2OgoSA9518X847X9z0p6LtA4Nc16+eQzCZjRrWanTGvHJ5w==} possible-typed-array-names@1.0.0: resolution: {integrity: sha512-d7Uw+eZoloe0EHDIYoe+bQ5WXnGMOpmiZFTuMWCwpjzzkL2nTjcKiAk4hh8TjnGye2TwWOk3UXucZ+3rbmBa8Q==} @@ -3424,6 +3403,10 @@ packages: resolution: {integrity: sha512-RRuzqDtt5Y9h3quz5hWhK+TPnsmVs6WwSU6LkJMeY4HstUEDuYTG8UJSdawMRzmzAtV+KEoG8N3Qg2qLy5vM/A==} engines: {node: ^10 || ^12 || >=14} + powershell-utils@0.1.0: + resolution: {integrity: sha512-dM0jVuXJPsDN6DvRpea484tCUaMiXWjuCn++HGTqUWzGDjv5tZkEZldAJ/UMlqRYGFrD/etByo4/xOuC/snX2A==} + engines: {node: '>=20'} + preact-render-to-string@6.5.11: resolution: {integrity: sha512-ubnauqoGczeGISiOh6RjX0/cdaF8v/oDXIjO85XALCQjwQP+SB4RDXXtvZ6yTYSjG+PC1QRP2AhPgCEsM2EvUw==} peerDependencies: @@ -3472,8 +3455,8 @@ packages: queue-microtask@1.2.3: resolution: {integrity: sha512-NuaNSa6flKT5JaSYQzJok04JzTL1CA6aGhv5rfLW3PgqA+M2ChpZQnAC8h8i4ZFkBS8X5RqkDBHA7r4hej3K9A==} - rc9@2.1.2: - resolution: {integrity: sha512-btXCnMmRIBINM2LDZoEmOogIZU7Qe7zn4BpomSKZ/ykbLObuBdvG+mFq11DL6fjH1DRwHhrlgtYWG96bJiC7Cg==} + rc9@3.1.0: + resolution: {integrity: sha512-ufjkNVzbRHKcCOmTahZkmVsyc3W+MSk3jY03m+a7tGHkIsdVMG9l10/3HvFbWkkKzY5VFp3pkRsIo/UYgmFL7Q==} react-dom@19.3.0: resolution: {integrity: sha512-JDk8dgif51OjFoDE70+OT9ICyYr+69HlmihNwp1+Nsfbna3t5sIiCa9ZJktDmQ4/1b/rn26hIAR2uYXDMr5r0Q==} @@ -3544,6 +3527,10 @@ packages: resolution: {integrity: sha512-yDMz9g+VaZkqBYS/ozoBJwaBhTbZo3UNYQHNRw1D3UFQB8oHB4uS/tAODO+ZLjGWmUbKnIlOWO+aaIiAxrUWHA==} engines: {node: '>= 14.16.0'} + readdirp@5.1.1: + resolution: {integrity: sha512-Kko+Y5XQ6fM+Ce3dq3m9YGxnacYZYl9cA1wZjaF3Vbry2L3i1qVg8+CAgNPsXRArPMUMCaOR7oa9Nqntc43JKA==} + engines: {node: '>= 20.19.0'} + redent@3.0.0: resolution: {integrity: sha512-6tDA8g98We0zd0GvVeMT9arEOnTw9qM03L9cJXaCjrip1OO764RDBLBfrB4cwzNGDj5OA5ioymC9GkizgWJDUg==} engines: {node: '>=8'} @@ -3630,8 +3617,8 @@ packages: resolution: {integrity: sha512-BR7VvDCVHO+q2xBEWskxS6DJE1qRnb7DxzUrogb71CWoSficBxYsiAGd+Kl0mmq/MprG9yArRkyrQxTO6XjMzA==} hasBin: true - semver@7.7.2: - resolution: {integrity: sha512-RF0Fw+rO5AMf9MAyaRXI4AV0Ulj5lMHqVxxdSgiVbixSCXoEmmX/jk0CuJw4+3SqroYO9VoUh+HcuJivvtJemA==} + semver@7.8.4: + resolution: {integrity: sha512-rUCObTnP32Q08R2uuIrt7r9PlEonuTmtuXYcW6s5kjdlj3xbnwe+21yXptAUYcMAABLkYYTtnmzb3w3EDZfueA==} engines: {node: '>=10'} hasBin: true @@ -3845,11 +3832,6 @@ packages: resolution: {integrity: sha512-GNzQvQTOIP6RyTfE2Qxb8ZVlNmw0n88vp1szwWRimP02mnTsx3Wtn5qRdqY9w2XduFNUgvOwhNnQsjwCp+kqaQ==} engines: {node: '>=6'} - tar@6.2.1: - resolution: {integrity: sha512-DZ4yORTwrbTj/7MZYq2w+/ZFdI6OZ/f9SFHR+71gIVUZhOQPHzVCLpvRnPgyaMpfWxxk/4ONva3GQSyNIKRv6A==} - engines: {node: '>=10'} - deprecated: Old versions of tar are not supported, and contain widely publicized security vulnerabilities, which have been fixed in the current version. Please update. Support for old versions may be purchased (at exorbitant rates) by contacting i@izs.me - test-exclude@6.0.0: resolution: {integrity: sha512-cAGWPIyOHU6zlmg88jwm7VRyXnMN7iV68OGAbYDk/Mh/xC/pzVPlQtY6ngoIH/5/tciuhGfvESU8GrHrcxD56w==} engines: {node: '>=8'} @@ -3861,9 +3843,6 @@ packages: thenify@3.3.1: resolution: {integrity: sha512-RVZSIV5IG10Hk3enotrhvz0T9em6cyHBLkH/YAZuKqd8hRkKhSfCGIcP2KUY0EPxndzANBmNllzWPwak+bheSw==} - tinyexec@0.3.2: - resolution: {integrity: sha512-KQQR9yN7R5+OSwaK0XQoj22pwHoTlgYqmUscPYoknOoWCWfj/5/ABTMRi69FrKU5ffPVh5QcFikpWJI/P1ocHA==} - tinyglobby@0.2.15: resolution: {integrity: sha512-j2Zq4NyQYG5XMST4cbs02Ak8iJUdxRM0XI5QyxXuZOzKOINmWurp3smXu3y5wDcJrptwpSjgXHzIQxR0omXljQ==} engines: {node: '>=12.0.0'} @@ -3983,9 +3962,6 @@ packages: engines: {node: '>=14.17'} hasBin: true - ufo@1.6.4: - resolution: {integrity: sha512-JFNbkD1Svwe0KvGi8GOeLcP4kAWQ609twvCdcHxq1oSL8svv39ZuSvajcD8B+5D0eL4+s1Is2D/O6KN3qcTeRA==} - uglify-js@3.19.3: resolution: {integrity: sha512-v3Xu+yuwBXisp6QYTcH4UbH+xYJXqnq2m/LtQVWKWzYc1iehYnLixoQDN9FH6/j9/oybfd6W9Ghwkl8+UMKTKQ==} engines: {node: '>=0.8.0'} @@ -4135,6 +4111,10 @@ packages: utf-8-validate: optional: true + wsl-utils@0.3.1: + resolution: {integrity: sha512-g/eziiSUNBSsdDJtCLB8bdYEUMj4jR7AGeUo96p/3dTafgjHhpF4RiCFPiRILwjQoDXx5MqkBr4fwWtR3Ky4Wg==} + engines: {node: '>=20'} + xml-name-validator@4.0.0: resolution: {integrity: sha512-ICP2e+jsHvAj2E2lIHxa5tjXRlKDJo4IdvPvCXbXQGdzSfmSpNVyIKMvoZHjDY9DP0zV17iI85o90vRFXNccRw==} engines: {node: '>=12'} @@ -4152,9 +4132,6 @@ packages: yallist@3.1.1: resolution: {integrity: sha512-a4UGQaWPH59mOXUYnAG2ewncQS4i4F43Tv3JoAM+s2VDAmS9NsK8GpDMLrCHPksFT7h3K6TOoUNn2pb7RoXx4g==} - yallist@4.0.0: - resolution: {integrity: sha512-3wdGidZyq5PB084XLES5TpOSRA3wjXAlIWMhum2kRcv/41Sn2emQ0dycQW4uZXLejwKvg6EsvbdlVL+FYEct7A==} - yaml@2.9.1: resolution: {integrity: sha512-3NxN8+78OdzbT7C/WjGsyfPAtJaN3FNDsWxv7Y7mcDsT/oOmgW8BpyQQFFBnvZE3j9Y2Sdz1ULFLezL7Eb2yFw==} engines: {node: '>= 14.6'} @@ -4526,32 +4503,56 @@ snapshots: '@floating-ui/utils@0.2.8': {} - '@hey-api/codegen-core@0.1.0(typescript@5.6.3)': + '@hey-api/codegen-core@0.9.1': dependencies: - typescript: 5.6.3 + '@hey-api/types': 0.1.4 + ansi-colors: 4.1.3 + c12: 3.3.4 + color-support: 1.1.3 + transitivePeerDependencies: + - magicast - '@hey-api/json-schema-ref-parser@1.1.0': + '@hey-api/json-schema-ref-parser@1.4.4': dependencies: '@jsdevtools/ono': 7.1.3 '@types/json-schema': 7.0.15 js-yaml: 4.3.2 - lodash: 4.18.1 - '@hey-api/openapi-ts@0.83.1(typescript@5.6.3)': + '@hey-api/openapi-ts@0.99.0(typescript@5.6.3)': dependencies: - '@hey-api/codegen-core': 0.1.0(typescript@5.6.3) - '@hey-api/json-schema-ref-parser': 1.1.0 + '@hey-api/codegen-core': 0.9.1 + '@hey-api/json-schema-ref-parser': 1.4.4 + '@hey-api/shared': 0.5.0 + '@hey-api/spec-types': 0.2.0 + '@hey-api/types': 0.1.4 + '@lukeed/ms': 2.0.2 ansi-colors: 4.1.3 - c12: 2.0.1 color-support: 1.1.3 - commander: 13.0.0 - handlebars: 4.7.8 - open: 10.1.2 - semver: 7.7.2 + commander: 15.0.0 + get-tsconfig: 4.14.0 typescript: 5.6.3 transitivePeerDependencies: - magicast + '@hey-api/shared@0.5.0': + dependencies: + '@hey-api/codegen-core': 0.9.1 + '@hey-api/json-schema-ref-parser': 1.4.4 + '@hey-api/spec-types': 0.2.0 + '@hey-api/types': 0.1.4 + ansi-colors: 4.1.3 + cross-spawn: 7.0.6 + open: 11.0.0 + semver: 7.8.4 + transitivePeerDependencies: + - magicast + + '@hey-api/spec-types@0.2.0': + dependencies: + '@hey-api/types': 0.1.4 + + '@hey-api/types@0.1.4': {} + '@humanfs/core@0.19.2': dependencies: '@humanfs/types': 0.15.0 @@ -4895,6 +4896,8 @@ snapshots: '@jsdevtools/ono@7.1.3': {} + '@lukeed/ms@2.0.2': {} + '@next/env@16.3.7': {} '@next/eslint-plugin-next@16.3.7(eslint@9.39.5(jiti@2.7.0))': @@ -5928,20 +5931,20 @@ snapshots: dependencies: run-applescript: 7.1.0 - c12@2.0.1: + c12@3.3.4: dependencies: - chokidar: 4.0.1 - confbox: 0.1.8 + chokidar: 5.0.0 + confbox: 0.2.4 defu: 6.1.7 - dotenv: 16.4.5 - giget: 1.2.5 + dotenv: 17.4.2 + exsolve: 1.1.1 + giget: 3.3.1 jiti: 2.7.0 - mlly: 1.8.2 - ohash: 1.1.6 - pathe: 1.1.2 - perfect-debounce: 1.0.0 - pkg-types: 1.3.1 - rc9: 2.1.2 + ohash: 2.0.12 + pathe: 2.0.3 + perfect-debounce: 2.1.0 + pkg-types: 2.3.3 + rc9: 3.1.0 call-bind-apply-helpers@1.0.2: dependencies: @@ -6005,14 +6008,12 @@ snapshots: dependencies: readdirp: 4.0.2 - chownr@2.0.0: {} + chokidar@5.0.0: + dependencies: + readdirp: 5.1.1 ci-info@3.9.0: {} - citty@0.1.6: - dependencies: - consola: 3.4.2 - cjs-module-lexer@1.4.1: {} class-variance-authority@0.7.1: @@ -6059,15 +6060,15 @@ snapshots: dependencies: delayed-stream: 1.0.0 - commander@13.0.0: {} + commander@15.0.0: {} commander@4.1.1: {} concat-map@0.0.1: {} - confbox@0.1.8: {} + confbox@0.2.4: {} - consola@3.4.2: {} + confbox@0.3.1: {} convert-source-map@2.0.0: {} @@ -6088,12 +6089,6 @@ snapshots: create-require@1.1.1: {} - cross-spawn@7.0.5: - dependencies: - path-key: 3.1.1 - shebang-command: 2.0.0 - which: 2.0.2 - cross-spawn@7.0.6: dependencies: path-key: 3.1.1 @@ -6256,6 +6251,8 @@ snapshots: dotenv@16.4.5: {} + dotenv@17.4.2: {} + dunder-proto@1.0.1: dependencies: call-bind-apply-helpers: 1.0.2 @@ -6624,7 +6621,7 @@ snapshots: execa@5.1.1: dependencies: - cross-spawn: 7.0.5 + cross-spawn: 7.0.6 get-stream: 6.0.1 human-signals: 2.1.0 is-stream: 2.0.1 @@ -6644,6 +6641,8 @@ snapshots: jest-message-util: 29.7.0 jest-util: 29.7.0 + exsolve@1.1.1: {} + fast-deep-equal@3.1.3: {} fast-glob@3.3.1: @@ -6726,10 +6725,6 @@ snapshots: fraction.js@5.3.4: {} - fs-minipass@2.1.0: - dependencies: - minipass: 3.3.6 - fs.realpath@1.0.0: {} fsevents@2.3.3: @@ -6782,19 +6777,15 @@ snapshots: es-errors: 1.3.0 get-intrinsic: 1.3.0 - get-tsconfig@4.8.1: + get-tsconfig@4.14.0: dependencies: resolve-pkg-maps: 1.0.0 - giget@1.2.5: + get-tsconfig@4.8.1: dependencies: - citty: 0.1.6 - consola: 3.4.2 - defu: 6.1.7 - node-fetch-native: 1.6.7 - nypm: 0.5.4 - pathe: 2.0.3 - tar: 6.2.1 + resolve-pkg-maps: 1.0.0 + + giget@3.3.1: {} glob-parent@5.1.2: dependencies: @@ -6837,15 +6828,6 @@ snapshots: graceful-fs@4.2.11: {} - handlebars@4.7.8: - dependencies: - minimist: 1.2.8 - neo-async: 2.6.2 - source-map: 0.6.1 - wordwrap: 1.0.0 - optionalDependencies: - uglify-js: 3.19.3 - handlebars@4.7.9: dependencies: minimist: 1.2.8 @@ -7017,6 +6999,8 @@ snapshots: dependencies: is-extglob: 2.1.1 + is-in-ssh@1.0.0: {} + is-inside-container@1.0.0: dependencies: is-docker: 3.0.0 @@ -7642,28 +7626,8 @@ snapshots: minimist@1.2.8: {} - minipass@3.3.6: - dependencies: - yallist: 4.0.0 - - minipass@5.0.0: {} - minipass@7.1.2: {} - minizlib@2.1.2: - dependencies: - minipass: 3.3.6 - yallist: 4.0.0 - - mkdirp@1.0.4: {} - - mlly@1.8.2: - dependencies: - acorn: 8.18.0 - pathe: 2.0.3 - pkg-types: 1.3.1 - ufo: 1.6.4 - ms@2.1.3: {} mz@2.7.0: @@ -7709,8 +7673,6 @@ snapshots: - '@types/node' - babel-plugin-macros - node-fetch-native@1.6.7: {} - node-int64@0.4.0: {} node-releases@2.0.57: {} @@ -7723,15 +7685,6 @@ snapshots: nwsapi@2.2.13: {} - nypm@0.5.4: - dependencies: - citty: 0.1.6 - consola: 3.4.2 - pathe: 2.0.3 - pkg-types: 1.3.1 - tinyexec: 0.3.2 - ufo: 1.6.4 - oauth4webapi@3.8.8: {} object-assign@4.1.1: {} @@ -7777,7 +7730,7 @@ snapshots: define-properties: 1.2.1 es-object-atoms: 1.1.1 - ohash@1.1.6: {} + ohash@2.0.12: {} once@1.4.0: dependencies: @@ -7787,12 +7740,14 @@ snapshots: dependencies: mimic-fn: 2.1.0 - open@10.1.2: + open@11.0.0: dependencies: default-browser: 5.5.1 define-lazy-prop: 3.0.0 + is-in-ssh: 1.0.0 is-inside-container: 1.0.0 - is-wsl: 3.1.0 + powershell-utils: 0.1.0 + wsl-utils: 0.3.1 optionator@0.9.4: dependencies: @@ -7863,11 +7818,9 @@ snapshots: lru-cache: 10.4.3 minipass: 7.1.2 - pathe@1.1.2: {} - pathe@2.0.3: {} - perfect-debounce@1.0.0: {} + perfect-debounce@2.1.0: {} picocolors@1.1.1: {} @@ -7883,10 +7836,10 @@ snapshots: dependencies: find-up: 4.1.0 - pkg-types@1.3.1: + pkg-types@2.3.3: dependencies: - confbox: 0.1.8 - mlly: 1.8.2 + confbox: 0.3.1 + exsolve: 1.1.1 pathe: 2.0.3 possible-typed-array-names@1.0.0: {} @@ -7935,6 +7888,8 @@ snapshots: picocolors: 1.1.1 source-map-js: 1.2.2 + powershell-utils@0.1.0: {} + preact-render-to-string@6.5.11(preact@10.24.3): dependencies: preact: 10.24.3 @@ -7980,7 +7935,7 @@ snapshots: queue-microtask@1.2.3: {} - rc9@2.1.2: + rc9@3.1.0: dependencies: defu: 6.1.7 destr: 2.0.5 @@ -8041,6 +7996,8 @@ snapshots: readdirp@4.0.2: {} + readdirp@5.1.1: {} + redent@3.0.0: dependencies: indent-string: 4.0.0 @@ -8133,7 +8090,7 @@ snapshots: semver@6.3.1: {} - semver@7.7.2: {} + semver@7.8.4: {} semver@7.8.5: {} @@ -8417,15 +8374,6 @@ snapshots: tapable@2.2.1: {} - tar@6.2.1: - dependencies: - chownr: 2.0.0 - fs-minipass: 2.1.0 - minipass: 5.0.0 - minizlib: 2.1.2 - mkdirp: 1.0.4 - yallist: 4.0.0 - test-exclude@6.0.0: dependencies: '@istanbuljs/schema': 0.1.3 @@ -8440,8 +8388,6 @@ snapshots: dependencies: any-promise: 1.3.0 - tinyexec@0.3.2: {} - tinyglobby@0.2.15: dependencies: fdir: 6.5.0(picomatch@4.0.7) @@ -8573,8 +8519,6 @@ snapshots: typescript@5.6.3: {} - ufo@1.6.4: {} - uglify-js@3.19.3: optional: true @@ -8732,6 +8676,11 @@ snapshots: ws@8.22.0: {} + wsl-utils@0.3.1: + dependencies: + is-wsl: 3.1.0 + powershell-utils: 0.1.0 + xml-name-validator@4.0.0: {} xmlchars@2.2.0: {} @@ -8742,8 +8691,6 @@ snapshots: yallist@3.1.1: {} - yallist@4.0.0: {} - yaml@2.9.1: {} yargs-parser@13.1.2: diff --git a/nextjs-frontend/pnpm-workspace.yaml b/nextjs-frontend/pnpm-workspace.yaml index 02290ad5f..374bc3315 100644 --- a/nextjs-frontend/pnpm-workspace.yaml +++ b/nextjs-frontend/pnpm-workspace.yaml @@ -17,6 +17,7 @@ overrides: form-data@^4: ^4.0.6 glob@^10: ^10.5.0 js-yaml@^3: ^3.15.2 + js-yaml@^4: ^4.3.2 lodash@^4: ^4.18.1 minimatch@^3: ^3.1.5 minimatch@^9: ^9.0.9