@letta-ai/letta-client 0.1.159 → 0.1.161

package/dist/api/resources/folders/client/Client.d.ts

@@ -0,0 +1,206 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as environments from "../../../../environments";
+import * as core from "../../../../core";
+import * as Letta from "../../../index";
+import * as fs from "fs";
+import { Blob } from "buffer";
+export declare namespace Folders {
+    interface Options {
+        environment?: core.Supplier<environments.LettaEnvironment | string>;
+        /** Specify a custom URL to connect the client to. */
+        baseUrl?: core.Supplier<string>;
+        token?: core.Supplier<string | undefined>;
+        /** Override the X-Project header */
+        project?: core.Supplier<string | undefined>;
+        fetcher?: core.FetchFunction;
+    }
+    interface RequestOptions {
+        /** The maximum time to wait for a response in seconds. */
+        timeoutInSeconds?: number;
+        /** The number of times to retry the request. Defaults to 2. */
+        maxRetries?: number;
+        /** A hook to abort the request. */
+        abortSignal?: AbortSignal;
+        /** Override the X-Project header */
+        project?: string | undefined;
+        /** Additional headers to include in the request. */
+        headers?: Record<string, string>;
+    }
+}
+export declare class Folders {
+    protected readonly _options: Folders.Options;
+    constructor(_options?: Folders.Options);
+    /**
+     * Count all data folders created by a user.
+     *
+     * @param {Folders.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Letta.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.folders.countFolders()
+     */
+    countFolders(requestOptions?: Folders.RequestOptions): Promise<number>;
+    /**
+     * Get a folder by ID
+     *
+     * @param {string} folderId
+     * @param {Folders.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Letta.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.folders.retrieveFolder("folder_id")
+     */
+    retrieveFolder(folderId: string, requestOptions?: Folders.RequestOptions): Promise<Letta.Folder>;
+    /**
+     * Delete a data folder.
+     *
+     * @param {string} folderId
+     * @param {Folders.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Letta.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.folders.deleteFolder("folder_id")
+     */
+    deleteFolder(folderId: string, requestOptions?: Folders.RequestOptions): Promise<unknown>;
+    /**
+     * Update the name or documentation of an existing data folder.
+     *
+     * @param {string} folderId
+     * @param {Letta.FolderUpdate} request
+     * @param {Folders.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Letta.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.folders.modifyFolder("folder_id")
+     */
+    modifyFolder(folderId: string, request?: Letta.FolderUpdate, requestOptions?: Folders.RequestOptions): Promise<Letta.Folder>;
+    /**
+     * Get a folder by name
+     *
+     * @param {string} folderName
+     * @param {Folders.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Letta.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.folders.getFolderIdByName("folder_name")
+     */
+    getFolderIdByName(folderName: string, requestOptions?: Folders.RequestOptions): Promise<string>;
+    /**
+     * Get aggregated metadata for all folders in an organization.
+     *
+     * Returns structured metadata including:
+     * - Total number of folders
+     * - Total number of files across all folders
+     * - Total size of all files
+     * - Per-source breakdown with file details (file_name, file_size per file) if include_detailed_per_source_metadata is True
+     *
+     * @param {Letta.GetFoldersMetadataRequest} request
+     * @param {Folders.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Letta.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.folders.getFoldersMetadata()
+     */
+    getFoldersMetadata(request?: Letta.GetFoldersMetadataRequest, requestOptions?: Folders.RequestOptions): Promise<Letta.OrganizationSourcesStats>;
+    /**
+     * List all data folders created by a user.
+     *
+     * @param {Folders.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Letta.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.folders.listFolders()
+     */
+    listFolders(requestOptions?: Folders.RequestOptions): Promise<Letta.Folder[]>;
+    /**
+     * Create a new data folder.
+     *
+     * @param {Letta.FolderCreate} request
+     * @param {Folders.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Letta.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.folders.createFolder({
+     *         name: "name"
+     *     })
+     */
+    createFolder(request: Letta.FolderCreate, requestOptions?: Folders.RequestOptions): Promise<Letta.Folder>;
+    /**
+     * Upload a file to a data folder.
+     *
+     * @param {File | fs.ReadStream | Blob} file
+     * @param {string} folderId
+     * @param {Letta.BodyUploadFileToFolder} request
+     * @param {Folders.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Letta.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.folders.uploadFileToFolder(fs.createReadStream("/path/to/your/file"), "folder_id", {})
+     */
+    uploadFileToFolder(file: File | fs.ReadStream | Blob, folderId: string, request: Letta.BodyUploadFileToFolder, requestOptions?: Folders.RequestOptions): Promise<Letta.FileMetadata>;
+    /**
+     * Get all agent IDs that have the specified folder attached.
+     *
+     * @param {string} folderId
+     * @param {Folders.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Letta.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.folders.getAgentsForFolder("folder_id")
+     */
+    getAgentsForFolder(folderId: string, requestOptions?: Folders.RequestOptions): Promise<string[]>;
+    /**
+     * List all passages associated with a data folder.
+     *
+     * @param {string} folderId
+     * @param {Letta.ListFolderPassagesRequest} request
+     * @param {Folders.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Letta.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.folders.listFolderPassages("folder_id")
+     */
+    listFolderPassages(folderId: string, request?: Letta.ListFolderPassagesRequest, requestOptions?: Folders.RequestOptions): Promise<Letta.Passage[]>;
+    /**
+     * List paginated files associated with a data folder.
+     *
+     * @param {string} folderId
+     * @param {Letta.ListFolderFilesRequest} request
+     * @param {Folders.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Letta.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.folders.listFolderFiles("folder_id")
+     */
+    listFolderFiles(folderId: string, request?: Letta.ListFolderFilesRequest, requestOptions?: Folders.RequestOptions): Promise<Letta.FileMetadata[]>;
+    /**
+     * Delete a file from a folder.
+     *
+     * @param {string} folderId
+     * @param {string} fileId
+     * @param {Folders.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Letta.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.folders.deleteFileFromFolder("folder_id", "file_id")
+     */
+    deleteFileFromFolder(folderId: string, fileId: string, requestOptions?: Folders.RequestOptions): Promise<void>;
+    protected _getCustomAuthorizationHeaders(): Promise<{
+        Authorization: string;
+    }>;
+}