@promptbook/remote-client

/** * This file was auto-generated by openapi-typescript. * Do not make direct changes to the file. */ export type paths = { readonly '/': { readonly parameters: { readonly query?: never; readonly header?: never; readonly path?: never; readonly cookie?: never; }; /** * Get server details * @description Returns details about the Promptbook server. */ readonly get: { readonly parameters: { readonly query?: never; readonly header?: never; readonly path?: never; readonly cookie?: never; }; readonly requestBody?: never; readonly responses: { /** @description Server details in markdown format. */ readonly 200: { headers: { readonly [name: string]: unknown; }; content: { readonly 'text/markdown': string; }; }; }; }; readonly put?: never; readonly post?: never; readonly delete?: never; readonly options?: never; readonly head?: never; readonly patch?: never; readonly trace?: never; }; readonly '/login': { readonly parameters: { readonly query?: never; readonly header?: never; readonly path?: never; readonly cookie?: never; }; readonly get?: never; readonly put?: never; /** * Login to the server * @description Login to the server and get identification. */ readonly post: { readonly parameters: { readonly query?: never; readonly header?: never; readonly path?: never; readonly cookie?: never; }; readonly requestBody: { readonly content: { readonly 'application/json': { readonly username?: string; readonly password?: string; readonly appId?: string; }; }; }; readonly responses: { /** @description Successful login */ readonly 201: { headers: { readonly [name: string]: unknown; }; content: { readonly 'application/json': { readonly isSuccess?: boolean; readonly message?: string; readonly error?: Record<string, never>; readonly identification?: Record<string, never>; }; }; }; /** @description Bad request or login failed */ readonly 400: { headers: { readonly [name: string]: unknown; }; content: { readonly 'application/json': { readonly error?: Record<string, never>; }; }; }; /** @description Authentication error */ readonly 401: { headers: { readonly [name: string]: unknown; }; content: { readonly 'application/json': { /** @enum {boolean} */ readonly isSuccess?: false; readonly message?: string; readonly error?: Record<string, never>; }; }; }; }; }; readonly delete?: never; readonly options?: never; readonly head?: never; readonly patch?: never; readonly trace?: never; }; readonly '/books': { readonly parameters: { readonly query?: never; readonly header?: never; readonly path?: never; readonly cookie?: never; }; /** * List all books * @description Returns a list of all available books in the collection. */ readonly get: { readonly parameters: { readonly query?: never; readonly header?: never; readonly path?: never; readonly cookie?: never; }; readonly requestBody?: never; readonly responses: { /** @description A list of books. */ readonly 200: { headers: { readonly [name: string]: unknown; }; content: { readonly 'application/json': readonly string[]; }; }; /** @description No collection available */ readonly 500: { headers: { readonly [name: string]: unknown; }; content: { readonly 'text/plain': string; }; }; }; }; readonly put?: never; readonly post?: never; readonly delete?: never; readonly options?: never; readonly head?: never; readonly patch?: never; readonly trace?: never; }; readonly '/books/{bookId}': { readonly parameters: { readonly query?: never; readonly header?: never; readonly path?: never; readonly cookie?: never; }; /** * Get book content * @description Returns the content of a specific book. */ readonly get: { readonly parameters: { readonly query?: never; readonly header?: never; readonly path: { /** @description The ID of the book to retrieve. */ readonly bookId: string; }; readonly cookie?: never; }; readonly requestBody?: never; readonly responses: { /** @description The content of the book. */ readonly 200: { headers: { readonly [name: string]: unknown; }; content: { readonly 'text/markdown': string; }; }; /** @description Book not found. */ readonly 404: { headers: { readonly [name: string]: unknown; }; content: { readonly 'application/json': { readonly error?: Record<string, never>; }; }; }; /** @description No collection available */ readonly 500: { headers: { readonly [name: string]: unknown; }; content: { readonly 'text/plain': string; }; }; }; }; readonly put?: never; readonly post?: never; readonly delete?: never; readonly options?: never; readonly head?: never; readonly patch?: never; readonly trace?: never; }; readonly '/executions': { readonly parameters: { readonly query?: never; readonly header?: never; readonly path?: never; readonly cookie?: never; }; /** * List all executions * @description Returns a list of all running execution tasks. */ readonly get: { readonly parameters: { readonly query?: never; readonly header?: never; readonly path?: never; readonly cookie?: never; }; readonly requestBody?: never; readonly responses: { /** @description A list of execution tasks. */ readonly 200: { headers: { readonly [name: string]: unknown; }; content: { readonly 'application/json': readonly { readonly nonce?: string; readonly taskId?: string; readonly taskType?: string; readonly status?: string; /** Format: date-time */ readonly createdAt?: string; /** Format: date-time */ readonly updatedAt?: string; }[]; }; }; }; }; readonly put?: never; readonly post?: never; readonly delete?: never; readonly options?: never; readonly head?: never; readonly patch?: never; readonly trace?: never; }; readonly '/executions/last': { readonly parameters: { readonly query?: never; readonly header?: never; readonly path?: never; readonly cookie?: never; }; /** * Get the last execution * @description Returns details of the last execution task. */ readonly get: { readonly parameters: { readonly query?: never; readonly header?: never; readonly path?: never; readonly cookie?: never; }; readonly requestBody?: never; readonly responses: { /** @description The last execution task with full details. */ readonly 200: { headers: { readonly [name: string]: unknown; }; content: { readonly 'application/json': { readonly nonce?: string; readonly taskId?: string; readonly taskType?: string; readonly status?: string; readonly errors?: readonly Record<string, never>[]; readonly warnings?: readonly Record<string, never>[]; /** Format: date-time */ readonly createdAt?: string; /** Format: date-time */ readonly updatedAt?: string; readonly currentValue?: Record<string, never>; }; }; }; /** @description No execution tasks found. */ readonly 404: { headers: { readonly [name: string]: unknown; }; content: { readonly 'text/plain': string; }; }; }; }; readonly put?: never; readonly post?: never; readonly delete?: never; readonly options?: never; readonly head?: never; readonly patch?: never; readonly trace?: never; }; readonly '/executions/{taskId}': { readonly parameters: { readonly query?: never; readonly header?: never; readonly path?: never; readonly cookie?: never; }; /** * Get specific execution * @description Returns details of a specific execution task. */ readonly get: { readonly parameters: { readonly query?: never; readonly header?: never; readonly path: { /** @description The ID of the execution task to retrieve. */ readonly taskId: string; }; readonly cookie?: never; }; readonly requestBody?: never; readonly responses: { /** @description The execution task with full details. */ readonly 200: { headers: { readonly [name: string]: unknown; }; content: { readonly 'application/json': { readonly nonce?: string; readonly taskId?: string; readonly taskType?: string; readonly status?: string; readonly errors?: readonly Record<string, never>[]; readonly warnings?: readonly Record<string, never>[]; /** Format: date-time */ readonly createdAt?: string; /** Format: date-time */ readonly updatedAt?: string; readonly currentValue?: Record<string, never>; }; }; }; /** @description Execution task not found. */ readonly 404: { headers: { readonly [name: string]: unknown; }; content: { readonly 'text/plain': string; }; }; }; }; readonly put?: never; readonly post?: never; readonly delete?: never; readonly options?: never; readonly head?: never; readonly patch?: never; readonly trace?: never; }; readonly '/executions/new': { readonly parameters: { readonly query?: never; readonly header?: never; readonly path?: never; readonly cookie?: never; }; readonly get?: never; readonly put?: never; /** * Start a new execution * @description Starts a new execution task for a given pipeline. */ readonly post: { readonly parameters: { readonly query?: never; readonly header?: never; readonly path?: never; readonly cookie?: never; }; readonly requestBody: { readonly content: { readonly 'application/json': { /** @description URL of the pipeline to execute */ readonly pipelineUrl?: string; /** @description Alternative field for pipelineUrl */ readonly book?: string; /** @description Parameters for pipeline execution */ readonly inputParameters?: Record<string, never>; /** @description User identification data */ readonly identification?: Record<string, never>; }; }; }; readonly responses: { /** @description The newly created execution task. */ readonly 200: { headers: { readonly [name: string]: unknown; }; content: { readonly 'application/json': Record<string, never>; }; }; /** @description Invalid input. */ readonly 400: { headers: { readonly [name: string]: unknown; }; content: { readonly 'application/json': { readonly error?: Record<string, never>; }; }; }; /** @description Pipeline not found. */ readonly 404: { headers: { readonly [name: string]: unknown; }; content: { readonly 'text/plain': string; }; }; }; }; readonly delete?: never; readonly options?: never; readonly head?: never; readonly patch?: never; readonly trace?: never; }; readonly '/api-docs': { readonly parameters: { readonly query?: never; readonly header?: never; readonly path?: never; readonly cookie?: never; }; /** * API documentation UI * @description Swagger UI for API documentation */ readonly get: { readonly parameters: { readonly query?: never; readonly header?: never; readonly path?: never; readonly cookie?: never; }; readonly requestBody?: never; readonly responses: { /** @description HTML Swagger UI */ readonly 200: { headers: { readonly [name: string]: unknown; }; content?: never; }; }; }; readonly put?: never; readonly post?: never; readonly delete?: never; readonly options?: never; readonly head?: never; readonly patch?: never; readonly trace?: never; }; readonly '/swagger': { readonly parameters: { readonly query?: never; readonly header?: never; readonly path?: never; readonly cookie?: never; }; /** * API documentation UI (alternative path) * @description Swagger UI for API documentation */ readonly get: { readonly parameters: { readonly query?: never; readonly header?: never; readonly path?: never; readonly cookie?: never; }; readonly requestBody?: never; readonly responses: { /** @description HTML Swagger UI */ readonly 200: { headers: { readonly [name: string]: unknown; }; content?: never; }; }; }; readonly put?: never; readonly post?: never; readonly delete?: never; readonly options?: never; readonly head?: never; readonly patch?: never; readonly trace?: never; }; readonly '/openapi': { readonly parameters: { readonly query?: never; readonly header?: never; readonly path?: never; readonly cookie?: never; }; /** * OpenAPI specification * @description Returns the OpenAPI JSON specification */ readonly get: { readonly parameters: { readonly query?: never; readonly header?: never; readonly path?: never; readonly cookie?: never; }; readonly requestBody?: never; readonly responses: { /** @description OpenAPI specification */ readonly 200: { headers: { readonly [name: string]: unknown; }; content: { readonly 'application/json': Record<string, never>; }; }; }; }; readonly put?: never; readonly post?: never; readonly delete?: never; readonly options?: never; readonly head?: never; readonly patch?: never; readonly trace?: never; }; }; export type webhooks = Record<string, never>; export type components = { schemas: { readonly Error: { readonly error?: Record<string, never>; }; readonly ExecutionTaskSummary: { readonly nonce?: string; readonly taskId?: string; readonly taskType?: string; readonly status?: string; /** Format: date-time */ readonly createdAt?: string; /** Format: date-time */ readonly updatedAt?: string; }; readonly ExecutionTaskFull: { readonly nonce?: string; readonly taskId?: string; readonly taskType?: string; readonly status?: string; readonly errors?: readonly Record<string, never>[]; readonly warnings?: readonly Record<string, never>[]; /** Format: date-time */ readonly createdAt?: string; /** Format: date-time */ readonly updatedAt?: string; readonly currentValue?: Record<string, never>; }; }; responses: never; parameters: never; requestBodies: never; headers: never; pathItems: never; }; export type $defs = Record<string, never>; export type operations = Record<string, never>;