twelvelabs-js 1.2.9 → 1.3.0

package/api/resources/knowledgeStoreItemCollections/client/Client.d.ts

@@ -0,0 +1,159 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as environments from "../../../../environments";
+import * as core from "../../../../core";
+import * as TwelvelabsApi from "../../../index";
+export declare namespace KnowledgeStoreItemCollections {
+    interface Options {
+        environment?: core.Supplier<environments.TwelvelabsApiEnvironment | string>;
+        /** Specify a custom URL to connect the client to. */
+        baseUrl?: core.Supplier<string>;
+        apiKey: core.Supplier<string>;
+    }
+    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;
+        /** Additional headers to include in the request. */
+        headers?: Record<string, string>;
+    }
+}
+export declare class KnowledgeStoreItemCollections {
+    protected readonly _options: KnowledgeStoreItemCollections.Options;
+    constructor(_options: KnowledgeStoreItemCollections.Options);
+    /**
+     * Returns a list of the item collections in the specified knowledge store.
+     *
+     * @param {string} knowledgeStoreId - The unique identifier of the knowledge store.
+     * @param {TwelvelabsApi.KnowledgeStoreItemCollectionsListRequest} request
+     * @param {KnowledgeStoreItemCollections.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link TwelvelabsApi.BadRequestError}
+     *
+     * @example
+     *     await client.knowledgeStoreItemCollections.list("ks_069e9869-1ea3-7481-8000-dae72bf6be6e", {
+     *         page: 1,
+     *         pageLimit: 10,
+     *         sortBy: "created_at",
+     *         sortOption: "desc"
+     *     })
+     */
+    list(knowledgeStoreId: string, request?: TwelvelabsApi.KnowledgeStoreItemCollectionsListRequest, requestOptions?: KnowledgeStoreItemCollections.RequestOptions): Promise<core.Page<TwelvelabsApi.KnowledgeStoreItemCollection>>;
+    /**
+     * Creates an item collection in the specified knowledge store. An item collection is a named collection of items. Use item collections to organize and reference subsets of items together.
+     *
+     * @param {string} knowledgeStoreId - The unique identifier of the knowledge store.
+     * @param {TwelvelabsApi.KnowledgeStoreItemCollectionsCreateRequest} request
+     * @param {KnowledgeStoreItemCollections.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link TwelvelabsApi.BadRequestError}
+     *
+     * @example
+     *     await client.knowledgeStoreItemCollections.create("ks_069e9869-1ea3-7481-8000-dae72bf6be6e", {
+     *         name: "Q1 highlights"
+     *     })
+     */
+    create(knowledgeStoreId: string, request: TwelvelabsApi.KnowledgeStoreItemCollectionsCreateRequest, requestOptions?: KnowledgeStoreItemCollections.RequestOptions): core.HttpResponsePromise<TwelvelabsApi.KnowledgeStoreItemCollection>;
+    private __create;
+    /**
+     * Retrieves the details of a specific item collection.
+     *
+     * @param {string} knowledgeStoreId - The unique identifier of the knowledge store.
+     * @param {string} collectionId - The unique identifier of the knowledge store item collection.
+     * @param {KnowledgeStoreItemCollections.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link TwelvelabsApi.BadRequestError}
+     *
+     * @example
+     *     await client.knowledgeStoreItemCollections.retrieve("ks_069e9869-1ea3-7481-8000-dae72bf6be6e", "ksic_069e9870-3c4d-7abc-9012-3456789abcde")
+     */
+    retrieve(knowledgeStoreId: string, collectionId: string, requestOptions?: KnowledgeStoreItemCollections.RequestOptions): core.HttpResponsePromise<TwelvelabsApi.KnowledgeStoreItemCollection>;
+    private __retrieve;
+    /**
+     * Deletes the specified item collection. The items themselves remain in the knowledge store.
+     *
+     * @param {string} knowledgeStoreId - The unique identifier of the knowledge store.
+     * @param {string} collectionId - The unique identifier of the knowledge store item collection.
+     * @param {KnowledgeStoreItemCollections.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link TwelvelabsApi.BadRequestError}
+     *
+     * @example
+     *     await client.knowledgeStoreItemCollections.delete("ks_069e9869-1ea3-7481-8000-dae72bf6be6e", "ksic_069e9870-3c4d-7abc-9012-3456789abcde")
+     */
+    delete(knowledgeStoreId: string, collectionId: string, requestOptions?: KnowledgeStoreItemCollections.RequestOptions): core.HttpResponsePromise<void>;
+    private __delete;
+    /**
+     * Updates the `name`, `description`, and `metadata` fields of the specified item collection.
+     *
+     * @param {string} knowledgeStoreId - The unique identifier of the knowledge store.
+     * @param {string} collectionId - The unique identifier of the knowledge store item collection.
+     * @param {TwelvelabsApi.KnowledgeStoreItemCollectionsUpdateRequest} request
+     * @param {KnowledgeStoreItemCollections.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link TwelvelabsApi.BadRequestError}
+     *
+     * @example
+     *     await client.knowledgeStoreItemCollections.update("ks_069e9869-1ea3-7481-8000-dae72bf6be6e", "ksic_069e9870-3c4d-7abc-9012-3456789abcde")
+     */
+    update(knowledgeStoreId: string, collectionId: string, request?: TwelvelabsApi.KnowledgeStoreItemCollectionsUpdateRequest, requestOptions?: KnowledgeStoreItemCollections.RequestOptions): core.HttpResponsePromise<TwelvelabsApi.KnowledgeStoreItemCollection>;
+    private __update;
+    /**
+     * Returns a list of the items in the specified item collection.
+     *
+     * @param {string} knowledgeStoreId - The unique identifier of the knowledge store.
+     * @param {string} collectionId - The unique identifier of the knowledge store item collection.
+     * @param {TwelvelabsApi.KnowledgeStoreItemCollectionsListItemsRequest} request
+     * @param {KnowledgeStoreItemCollections.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link TwelvelabsApi.BadRequestError}
+     *
+     * @example
+     *     await client.knowledgeStoreItemCollections.listItems("ks_069e9869-1ea3-7481-8000-dae72bf6be6e", "ksic_069e9870-3c4d-7abc-9012-3456789abcde", {
+     *         page: 1,
+     *         pageLimit: 10
+     *     })
+     */
+    listItems(knowledgeStoreId: string, collectionId: string, request?: TwelvelabsApi.KnowledgeStoreItemCollectionsListItemsRequest, requestOptions?: KnowledgeStoreItemCollections.RequestOptions): Promise<core.Page<TwelvelabsApi.KnowledgeStoreItem>>;
+    /**
+     * Adds one or more items to the specified item collection. This operation is idempotent — items already in the collection are skipped. Every identifier must reference an existing item in the knowledge store.
+     *
+     * @param {string} knowledgeStoreId - The unique identifier of the knowledge store.
+     * @param {string} collectionId - The unique identifier of the knowledge store item collection.
+     * @param {TwelvelabsApi.KnowledgeStoreItemCollectionsAddItemsRequest} request
+     * @param {KnowledgeStoreItemCollections.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link TwelvelabsApi.BadRequestError}
+     *
+     * @example
+     *     await client.knowledgeStoreItemCollections.addItems("ks_069e9869-1ea3-7481-8000-dae72bf6be6e", "ksic_069e9870-3c4d-7abc-9012-3456789abcde", {
+     *         itemIds: ["ksi_069e9870-3c4d-7abc-9012-3456789abcde"]
+     *     })
+     */
+    addItems(knowledgeStoreId: string, collectionId: string, request: TwelvelabsApi.KnowledgeStoreItemCollectionsAddItemsRequest, requestOptions?: KnowledgeStoreItemCollections.RequestOptions): core.HttpResponsePromise<TwelvelabsApi.KnowledgeStoreItemCollection>;
+    private __addItems;
+    /**
+     * Removes one or more items from the specified item collection. This operation is idempotent — identifiers that do not match a member of the collection are ignored. The items themselves remain in the knowledge store.
+     *
+     * @param {string} knowledgeStoreId - The unique identifier of the knowledge store.
+     * @param {string} collectionId - The unique identifier of the knowledge store item collection.
+     * @param {TwelvelabsApi.KnowledgeStoreItemCollectionsRemoveItemsRequest} request
+     * @param {KnowledgeStoreItemCollections.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link TwelvelabsApi.BadRequestError}
+     *
+     * @example
+     *     await client.knowledgeStoreItemCollections.removeItems("ks_069e9869-1ea3-7481-8000-dae72bf6be6e", "ksic_069e9870-3c4d-7abc-9012-3456789abcde", {
+     *         itemIds: ["ksi_069e9870-3c4d-7abc-9012-3456789abcde"]
+     *     })
+     */
+    removeItems(knowledgeStoreId: string, collectionId: string, request: TwelvelabsApi.KnowledgeStoreItemCollectionsRemoveItemsRequest, requestOptions?: KnowledgeStoreItemCollections.RequestOptions): core.HttpResponsePromise<void>;
+    private __removeItems;
+    protected _getCustomAuthorizationHeaders(): Promise<{
+        "x-api-key": string;
+    }>;
+}