@corti/sdk 4.2.0 → 5.0.0-rc

package/dist/cjs/api/resources/documents/client/Client.d.ts

@@ -2,6 +2,7 @@ import type { BaseClientOptions, BaseRequestOptions } from "../../../../BaseClie
 import { type NormalizedClientOptionsWithAuth } from "../../../../BaseClient.js";
 import * as core from "../../../../core/index.js";
 import * as Corti from "../../../index.js";
+import { ClassicClient } from "../resources/classic/client/Client.js";
 import { SectionsClient } from "../resources/sections/client/Client.js";
 import { TemplatesClient } from "../resources/templates/client/Client.js";
 export declare namespace DocumentsClient {
@@ -11,132 +12,99 @@ export declare namespace DocumentsClient {
 }
 export declare class DocumentsClient {
     protected readonly _options: NormalizedClientOptionsWithAuth<DocumentsClient.Options>;
+    protected _classic: ClassicClient | undefined;
     protected _templates: TemplatesClient | undefined;
     protected _sections: SectionsClient | undefined;
     constructor(options: DocumentsClient.Options);
+    get classic(): ClassicClient;
     get templates(): TemplatesClient;
     get sections(): SectionsClient;
     /**
-     * @deprecated
+     * Guided Documents list (`GET /documents/`). For classic interaction-scoped documents, use `client.documents.classic.list`.
      *
-     * List Documents
+     * Returns a list of previously generated documents.
+     * Use query parameters to filter by template, interaction, or label.
      *
-     * @param {Corti.Uuid} id - The unique identifier of the interaction. Must be a valid UUID.
+     * @param {Corti.GuidedDocumentsListRequest} request
      * @param {DocumentsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Corti.BadRequestError}
-     * @throws {@link Corti.ForbiddenError}
-     * @throws {@link Corti.InternalServerError}
-     * @throws {@link Corti.GatewayTimeoutError}
      *
      * @example
-     *     await client.documents.list("f47ac10b-58cc-4372-a567-0e02b2c3d479")
+     *     await client.documents.list()
      */
-    list(id: Corti.Uuid, requestOptions?: DocumentsClient.RequestOptions): core.HttpResponsePromise<Corti.DocumentsListResponse>;
+    list(request?: Corti.GuidedDocumentsListRequest, requestOptions?: DocumentsClient.RequestOptions): core.HttpResponsePromise<Corti.GuidedDocument[]>;
     private __list;
     /**
-     * @deprecated
-     *
-     * This endpoint offers different ways to generate a document. Find guides to document generation [here](/textgen/documents-standard).
+     * Generates a structured document using one of three template-supply paths: a stored template reference (optionally with runtime overrides), an ad-hoc assembly of stored sections, or a fully inline dynamic template. Exactly one of `templateRef`, `assemblyTemplate`, or `dynamicTemplate` must be provided.
+     * Context can combine different types or reference an interactionId to automatically fetch existing context to pass to the LLM. Note that discarded facts are not passed to the LLM.
+     * With the exception of the plain `templateRef` path (no overrides), every call creates a new auto-generated template aggregate that snapshots the resolved prompts as a drift-proof receipt, persisted for 30 days.
      *
-     * @param {Corti.Uuid} id - The unique identifier of the interaction. Must be a valid UUID.
-     * @param {Corti.DocumentsCreateRequest} request
+     * @param {Corti.GuidedDocumentsGenerateRequest} request
      * @param {DocumentsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Corti.BadRequestError}
-     * @throws {@link Corti.ForbiddenError}
+     * @throws {@link Corti.NotFoundError}
+     * @throws {@link Corti.UnprocessableEntityError}
      * @throws {@link Corti.InternalServerError}
-     * @throws {@link Corti.GatewayTimeoutError}
      *
      * @example
-     *     await client.documents.create("f47ac10b-58cc-4372-a567-0e02b2c3d479", {
-     *         context: [{
-     *                 type: "facts",
-     *                 data: [{
-     *                         text: "text"
-     *                     }]
-     *             }],
-     *         templateKey: "templateKey",
-     *         outputLanguage: "outputLanguage"
+     *     await client.documents.generate({
+     *         outputLanguage: "outputLanguage",
+     *         templateRef: {
+     *             templateId: "templateId"
+     *         }
      *     })
      */
-    create(id: Corti.Uuid, request: Corti.DocumentsCreateRequest, requestOptions?: DocumentsClient.RequestOptions): core.HttpResponsePromise<Corti.DocumentsGetResponse>;
-    private __create;
+    generate(request: Corti.GuidedDocumentsGenerateRequest, requestOptions?: DocumentsClient.RequestOptions): core.HttpResponsePromise<Corti.GuidedDocumentsCreateEphemeralResponse>;
+    private __generate;
     /**
-     * @deprecated
+     * Guided Documents get (`GET /documents/{documentID}`). For classic interaction-scoped documents, use `client.documents.classic.get`.
      *
-     * Get Document.
+     * Returns a previously generated document by ID, including its rendered string output
+     * and structured object.
      *
-     * @param {Corti.Uuid} id - The unique identifier of the interaction. Must be a valid UUID.
-     * @param {Corti.Uuid} documentId - The document ID representing the context for the request. Must be a valid UUID.
+     * @param {string} documentID
      * @param {DocumentsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
-     * @throws {@link Corti.BadRequestError}
-     * @throws {@link Corti.ForbiddenError}
-     * @throws {@link Corti.InternalServerError}
-     * @throws {@link Corti.GatewayTimeoutError}
+     * @throws {@link Corti.NotFoundError}
      *
      * @example
-     *     await client.documents.get("f47ac10b-58cc-4372-a567-0e02b2c3d479", "f47ac10b-58cc-4372-a567-0e02b2c3d479")
+     *     await client.documents.get("documentID")
      */
-    get(id: Corti.Uuid, documentId: Corti.Uuid, requestOptions?: DocumentsClient.RequestOptions): core.HttpResponsePromise<Corti.DocumentsGetResponse>;
+    get(documentID: string, requestOptions?: DocumentsClient.RequestOptions): core.HttpResponsePromise<Corti.GuidedDocument>;
     private __get;
     /**
-     * @deprecated
+     * Guided Documents delete (`DELETE /documents/{documentID}`). For classic interaction-scoped documents, use `client.documents.classic.delete`.
+     *
+     * Deletes the document. This cannot be undone.
      *
-     * @param {Corti.Uuid} id - The unique identifier of the interaction. Must be a valid UUID.
-     * @param {Corti.Uuid} documentId - The document ID representing the context for the request. Must be a valid UUID.
+     * @param {string} documentID
      * @param {DocumentsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
-     * @throws {@link Corti.ForbiddenError}
      * @throws {@link Corti.NotFoundError}
-     * @throws {@link Corti.InternalServerError}
-     * @throws {@link Corti.GatewayTimeoutError}
      *
      * @example
-     *     await client.documents.delete("f47ac10b-58cc-4372-a567-0e02b2c3d479", "f47ac10b-58cc-4372-a567-0e02b2c3d479")
+     *     await client.documents.delete("documentID")
      */
-    delete(id: Corti.Uuid, documentId: Corti.Uuid, requestOptions?: DocumentsClient.RequestOptions): core.HttpResponsePromise<void>;
+    delete(documentID: string, requestOptions?: DocumentsClient.RequestOptions): core.HttpResponsePromise<void>;
     private __delete;
     /**
-     * @deprecated
-     *
-     * @param {Corti.Uuid} id - The unique identifier of the interaction. Must be a valid UUID.
-     * @param {Corti.Uuid} documentId - The document ID representing the context for the request. Must be a valid UUID.
-     * @param {Corti.DocumentsUpdateRequest} request
-     * @param {DocumentsClient.RequestOptions} requestOptions - Request-specific configuration.
+     * Guided Documents update (`PATCH /documents/{documentID}`). For classic interaction-scoped documents, use `client.documents.classic.update`.
      *
-     * @throws {@link Corti.BadRequestError}
-     * @throws {@link Corti.ForbiddenError}
-     * @throws {@link Corti.InternalServerError}
-     * @throws {@link Corti.GatewayTimeoutError}
+     * Updates the document's `name`, `labels`, or rendered output (`stringDocument` / `structuredDocument`).
+     * Use this to persist edits made to a previously generated document.
      *
-     * @example
-     *     await client.documents.update("f47ac10b-58cc-4372-a567-0e02b2c3d479", "f47ac10b-58cc-4372-a567-0e02b2c3d479")
-     */
-    update(id: Corti.Uuid, documentId: Corti.Uuid, request?: Corti.DocumentsUpdateRequest, requestOptions?: DocumentsClient.RequestOptions): core.HttpResponsePromise<Corti.DocumentsGetResponse>;
-    private __update;
-    /**
-     * Generates a structured document using one of three template-supply paths: a stored template reference (optionally with runtime overrides), an ad-hoc assembly of stored sections, or a fully inline dynamic template. Exactly one of `templateRef`, `assemblyTemplate`, or `dynamicTemplate` must be provided.
-     * Context can combine different types or reference an interactionId to automatically fetch existing context to pass to the LLM. Note that discarded facts are not passed to the LLM.
-     * With the exception of the plain `templateRef` path (no overrides), every call creates a new auto-generated template aggregate that snapshots the resolved prompts as a drift-proof receipt, persisted for 30 days.
-     *
-     * @param {Corti.GuidedDocumentsGenerateRequest} request
+     * @param {string} documentID
+     * @param {Corti.GuidedDocumentsUpdateRequest} request
      * @param {DocumentsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Corti.BadRequestError}
      * @throws {@link Corti.NotFoundError}
-     * @throws {@link Corti.UnprocessableEntityError}
-     * @throws {@link Corti.InternalServerError}
      *
      * @example
-     *     await client.documents.generate({
-     *         outputLanguage: "outputLanguage",
-     *         templateRef: {
-     *             templateId: "templateId"
-     *         }
-     *     })
+     *     await client.documents.update("documentID")
      */
-    generate(request: Corti.GuidedDocumentsGenerateRequest, requestOptions?: DocumentsClient.RequestOptions): core.HttpResponsePromise<Corti.GuidedDocumentsCreateEphemeralResponse>;
-    private __generate;
+    update(documentID: string, request?: Corti.GuidedDocumentsUpdateRequest, requestOptions?: DocumentsClient.RequestOptions): core.HttpResponsePromise<Corti.GuidedDocument>;
+    private __update;
 }