@coveo/platform-client/dist/esm/resources/Indexes/Documents/Documents.js

The main goal of this package is to provide an easy to configure and straightforward way of querying Coveo Cloud APIs using JavaScript.

import API from '../../../APICore.js';
import Resource from '../../Resource.js';
export default class Documents extends Resource {
    static baseUrl = `/rest/organizations/${API.orgPlaceholder}/indexes`;
    /**
     * Lists the [permissions](https://docs.coveo.com/en/223/glossary/permission) of an [item](https://docs.coveo.com/en/210/glossary/item) in a Coveo Cloud organization index.
     * @param indexId The unique identifier of the target index.
     * @param documentId The unique identifier of the item whose permissions to list.
     */
    listPermissions(indexId, documentId) {
        return this.api.get(`${Documents.baseUrl}/${indexId}/documents/${encodeURIComponent(encodeURIComponent(documentId))}/permissions`);
    }
    /**
     * Lists the [effective permissions](https://docs.coveo.com/en/194/glossary/effective-permissions) of an [item](https://docs.coveo.com/en/210/glossary/item) in a Coveo Cloud organization index.
     * @param indexId The unique identifier of the target index.
     * @param documentId The unique identifier of the item whose permissions to list.
     * @param options
     */
    listEffectivePermissions(indexId, documentId, options = {}) {
        return this.api.get(this.buildPath(`${Documents.baseUrl}/${indexId}/documents/${encodeURIComponent(encodeURIComponent(documentId))}/permissions/effective`, options));
    }
}
//# sourceMappingURL=Documents.js.map