acquia-dam-sdk/dist/apis/collections/api.d.ts

Interact with the Acquia DAM API

import { ApiClient } from '../../client/index.js';
import { AddRemoveAssetsParams, CreateCollectionParams, ListCollectionsParams } from './requests.js';
import { CreateCollectionResult, ListCollectionsResult } from './responses.js';

declare class CollectionsApi {
    private _client;
    /**
     * Create an instance of the CollectionsApi class
     *
     * Provides information about global, shared, and private Collections
     *
     * @param client Provide an instance of ApiClient.
     */
    constructor(client: ApiClient);
    /**
     * Add or remove multiple assets from multiple collections
     * @param params Information about the request
     * @returns Promise containing no information
     * @see {@link https://widenv1.docs.apiary.io/#reference/collections/collection-assets/adding/removing-assets}
     */
    addOrRemoveAssets(params: AddRemoveAssetsParams): Promise<void>;
    /**
     * Create a local (private) collection
     * @param params Information about the request
     * @returns Promise containing information about the created collection
     * @see {@link https://widenv1.docs.apiary.io/#reference/collections/collection-assets/create-a-collection}
     */
    createCollection(params: CreateCollectionParams): Promise<CreateCollectionResult>;
    /**
     * Retrieve a list of collections.
     * @param params Information about the request
     * @returns Promise containing a list of collections
     * @see {@link https://widenv2.docs.apiary.io/#reference/collections/collections/list-collections}
     */
    listCollections(params: ListCollectionsParams): Promise<ListCollectionsResult>;
}

export { CollectionsApi };