UNPKG

@coveo/platform-client

Version:

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

27 lines 1.64 kB
"use strict"; Object.defineProperty(exports, "__esModule", { value: true }); const tslib_1 = require("tslib"); const APICore_js_1 = tslib_1.__importDefault(require("../../../APICore.js")); const Resource_js_1 = tslib_1.__importDefault(require("../../Resource.js")); class Documents extends Resource_js_1.default { static baseUrl = `/rest/organizations/${APICore_js_1.default.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)); } } exports.default = Documents; //# sourceMappingURL=Documents.js.map