@alfresco/js-api 7.9.0-10285171674 → 7.9.0-10285259723

package/src/api/content-rest-api/api/groups.api.js

@@ -0,0 +1,166 @@
+"use strict";
+/*!
+ * @license
+ * Copyright © 2005-2024 Hyland Software, Inc. and its affiliates. All rights reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GroupsApi = void 0;
+const model_1 = require("../model");
+const base_api_1 = require("./base.api");
+const assert_1 = require("../../../assert");
+const alfrescoApiClient_1 = require("../../../alfrescoApiClient");
+class GroupsApi extends base_api_1.BaseApi {
+    createGroup(groupBodyCreate, opts) {
+        (0, assert_1.throwIfNotDefined)(groupBodyCreate, 'groupBodyCreate');
+        const queryParams = {
+            include: (0, alfrescoApiClient_1.buildCollectionParam)(opts === null || opts === void 0 ? void 0 : opts.include, 'csv'),
+            fields: (0, alfrescoApiClient_1.buildCollectionParam)(opts === null || opts === void 0 ? void 0 : opts.fields, 'csv')
+        };
+        return this.post({
+            path: '/groups',
+            queryParams,
+            bodyParam: groupBodyCreate
+        });
+    }
+    createGroupMembership(groupId, groupMembershipBodyCreate, opts) {
+        (0, assert_1.throwIfNotDefined)(groupId, 'groupId');
+        (0, assert_1.throwIfNotDefined)(groupMembershipBodyCreate, 'groupMembershipBodyCreate');
+        const queryParams = {
+            fields: (0, alfrescoApiClient_1.buildCollectionParam)(opts === null || opts === void 0 ? void 0 : opts.fields, 'csv')
+        };
+        return this.post({
+            path: '/groups/{groupId}/members',
+            pathParams: { groupId },
+            queryParams,
+            bodyParam: groupMembershipBodyCreate
+        });
+    }
+    deleteGroup(groupId, opts) {
+        (0, assert_1.throwIfNotDefined)(groupId, 'groupId');
+        opts = opts || {};
+        const cascadeDelete = opts['cascade'] ? opts['cascade'] : false;
+        const pathParams = {
+            groupId
+        };
+        const queryParams = {
+            cascade: cascadeDelete
+        };
+        return this.delete({
+            path: '/groups/{groupId}',
+            pathParams,
+            queryParams
+        });
+    }
+    deleteGroupMembership(groupId, groupMemberId) {
+        (0, assert_1.throwIfNotDefined)(groupId, 'groupId');
+        (0, assert_1.throwIfNotDefined)(groupMemberId, 'groupMemberId');
+        const pathParams = {
+            groupId,
+            groupMemberId
+        };
+        return this.delete({
+            path: '/groups/{groupId}/members/{groupMemberId}',
+            pathParams
+        });
+    }
+    getGroup(groupId, opts) {
+        (0, assert_1.throwIfNotDefined)(groupId, 'groupId');
+        const pathParams = {
+            groupId
+        };
+        const queryParams = {
+            include: (0, alfrescoApiClient_1.buildCollectionParam)(opts === null || opts === void 0 ? void 0 : opts.include, 'csv'),
+            fields: (0, alfrescoApiClient_1.buildCollectionParam)(opts === null || opts === void 0 ? void 0 : opts.fields, 'csv')
+        };
+        return this.get({
+            path: '/groups/{groupId}',
+            pathParams,
+            queryParams
+        });
+    }
+    listGroupMemberships(groupId, opts) {
+        (0, assert_1.throwIfNotDefined)(groupId, 'groupId');
+        const pathParams = {
+            groupId
+        };
+        const queryParams = {
+            skipCount: opts === null || opts === void 0 ? void 0 : opts.skipCount,
+            maxItems: opts === null || opts === void 0 ? void 0 : opts.maxItems,
+            orderBy: (0, alfrescoApiClient_1.buildCollectionParam)(opts === null || opts === void 0 ? void 0 : opts.orderBy, 'csv'),
+            where: opts === null || opts === void 0 ? void 0 : opts.where,
+            fields: (0, alfrescoApiClient_1.buildCollectionParam)(opts === null || opts === void 0 ? void 0 : opts.fields, 'csv')
+        };
+        return this.get({
+            path: '/groups/{groupId}/members',
+            pathParams,
+            queryParams,
+            returnType: model_1.GroupMemberPaging
+        });
+    }
+    listGroupMembershipsForPerson(personId, opts) {
+        (0, assert_1.throwIfNotDefined)(personId, 'personId');
+        const pathParams = {
+            personId
+        };
+        const queryParams = {
+            skipCount: opts === null || opts === void 0 ? void 0 : opts.skipCount,
+            maxItems: opts === null || opts === void 0 ? void 0 : opts.maxItems,
+            orderBy: (0, alfrescoApiClient_1.buildCollectionParam)(opts === null || opts === void 0 ? void 0 : opts.orderBy, 'csv'),
+            include: (0, alfrescoApiClient_1.buildCollectionParam)(opts === null || opts === void 0 ? void 0 : opts.include, 'csv'),
+            where: opts === null || opts === void 0 ? void 0 : opts.where,
+            fields: (0, alfrescoApiClient_1.buildCollectionParam)(opts === null || opts === void 0 ? void 0 : opts.fields, 'csv')
+        };
+        return this.get({
+            path: '/people/{personId}/groups',
+            pathParams,
+            queryParams,
+            returnType: model_1.GroupPaging
+        });
+    }
+    listGroups(opts) {
+        const queryParams = {
+            skipCount: opts === null || opts === void 0 ? void 0 : opts.skipCount,
+            maxItems: opts === null || opts === void 0 ? void 0 : opts.maxItems,
+            orderBy: (0, alfrescoApiClient_1.buildCollectionParam)(opts === null || opts === void 0 ? void 0 : opts.orderBy, 'csv'),
+            include: (0, alfrescoApiClient_1.buildCollectionParam)(opts === null || opts === void 0 ? void 0 : opts.include, 'csv'),
+            where: opts === null || opts === void 0 ? void 0 : opts.where,
+            fields: (0, alfrescoApiClient_1.buildCollectionParam)(opts === null || opts === void 0 ? void 0 : opts.fields, 'csv')
+        };
+        return this.get({
+            path: '/groups',
+            queryParams,
+            returnType: model_1.GroupPaging
+        });
+    }
+    updateGroup(groupId, groupBodyUpdate, opts) {
+        (0, assert_1.throwIfNotDefined)(groupId, 'groupId');
+        (0, assert_1.throwIfNotDefined)(groupBodyUpdate, 'groupBodyUpdate');
+        const pathParams = {
+            groupId
+        };
+        const queryParams = {
+            include: (0, alfrescoApiClient_1.buildCollectionParam)(opts === null || opts === void 0 ? void 0 : opts.include, 'csv'),
+            fields: (0, alfrescoApiClient_1.buildCollectionParam)(opts === null || opts === void 0 ? void 0 : opts.fields, 'csv')
+        };
+        return this.put({
+            path: '/groups/{groupId}',
+            pathParams,
+            queryParams,
+            bodyParam: groupBodyUpdate
+        });
+    }
+}
+exports.GroupsApi = GroupsApi;
+//# sourceMappingURL=../../../../../../../lib/js-api/src/api/content-rest-api/api/groups.api.js.map

package/src/api/content-rest-api/api/groups.api.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"groups.api.js","sourceRoot":"","sources":["groups.api.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;GAeG;;;AAEH,oCAAqJ;AACrJ,yCAAqC;AACrC,4CAAoD;AACpD,kEAAkE;AAwClE,MAAa,SAAU,SAAQ,kBAAO;IAsBlC,WAAW,CAAC,eAAgC,EAAE,IAA+C;QACzF,IAAA,0BAAiB,EAAC,eAAe,EAAE,iBAAiB,CAAC,CAAC;QAEtD,MAAM,WAAW,GAAG;YAChB,OAAO,EAAE,IAAA,wCAAoB,EAAC,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,OAAO,EAAE,KAAK,CAAC;YACnD,MAAM,EAAE,IAAA,wCAAoB,EAAC,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,MAAM,EAAE,KAAK,CAAC;SACpD,CAAC;QAEF,OAAO,IAAI,CAAC,IAAI,CAAC;YACb,IAAI,EAAE,SAAS;YACf,WAAW;YACX,SAAS,EAAE,eAAe;SAC7B,CAAC,CAAC;IACP,CAAC;IAiBD,qBAAqB,CACjB,OAAe,EACf,yBAAoD,EACpD,IAAyB;QAEzB,IAAA,0BAAiB,EAAC,OAAO,EAAE,SAAS,CAAC,CAAC;QACtC,IAAA,0BAAiB,EAAC,yBAAyB,EAAE,2BAA2B,CAAC,CAAC;QAE1E,MAAM,WAAW,GAAG;YAChB,MAAM,EAAE,IAAA,wCAAoB,EAAC,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,MAAM,EAAE,KAAK,CAAC;SACpD,CAAC;QAEF,OAAO,IAAI,CAAC,IAAI,CAAC;YACb,IAAI,EAAE,2BAA2B;YACjC,UAAU,EAAE,EAAE,OAAO,EAAE;YACvB,WAAW;YACX,SAAS,EAAE,yBAAyB;SACvC,CAAC,CAAC;IACP,CAAC;IAiBD,WAAW,CAAC,OAAe,EAAE,IAAsB;QAC/C,IAAA,0BAAiB,EAAC,OAAO,EAAE,SAAS,CAAC,CAAC;QACtC,IAAI,GAAG,IAAI,IAAI,EAAE,CAAC;QAElB,MAAM,aAAa,GAAG,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC;QAEhE,MAAM,UAAU,GAAG;YACf,OAAO;SACV,CAAC;QAEF,MAAM,WAAW,GAAG;YAChB,OAAO,EAAE,aAAa;SACzB,CAAC;QAEF,OAAO,IAAI,CAAC,MAAM,CAAC;YACf,IAAI,EAAE,mBAAmB;YACzB,UAAU;YACV,WAAW;SACd,CAAC,CAAC;IACP,CAAC;IAeD,qBAAqB,CAAC,OAAe,EAAE,aAAqB;QACxD,IAAA,0BAAiB,EAAC,OAAO,EAAE,SAAS,CAAC,CAAC;QACtC,IAAA,0BAAiB,EAAC,aAAa,EAAE,eAAe,CAAC,CAAC;QAElD,MAAM,UAAU,GAAG;YACf,OAAO;YACP,aAAa;SAChB,CAAC;QAEF,OAAO,IAAI,CAAC,MAAM,CAAC;YACf,IAAI,EAAE,2CAA2C;YACjD,UAAU;SACb,CAAC,CAAC;IACP,CAAC;IAcD,QAAQ,CAAC,OAAe,EAAE,IAA+C;QACrE,IAAA,0BAAiB,EAAC,OAAO,EAAE,SAAS,CAAC,CAAC;QAEtC,MAAM,UAAU,GAAG;YACf,OAAO;SACV,CAAC;QAEF,MAAM,WAAW,GAAG;YAChB,OAAO,EAAE,IAAA,wCAAoB,EAAC,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,OAAO,EAAE,KAAK,CAAC;YACnD,MAAM,EAAE,IAAA,wCAAoB,EAAC,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,MAAM,EAAE,KAAK,CAAC;SACpD,CAAC;QAEF,OAAO,IAAI,CAAC,GAAG,CAAC;YACZ,IAAI,EAAE,mBAAmB;YACzB,UAAU;YACV,WAAW;SACd,CAAC,CAAC;IACP,CAAC;IAuBD,oBAAoB,CAAC,OAAe,EAAE,IAAyE;QAC3G,IAAA,0BAAiB,EAAC,OAAO,EAAE,SAAS,CAAC,CAAC;QAEtC,MAAM,UAAU,GAAG;YACf,OAAO;SACV,CAAC;QAEF,MAAM,WAAW,GAAG;YAChB,SAAS,EAAE,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,SAAS;YAC1B,QAAQ,EAAE,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,QAAQ;YACxB,OAAO,EAAE,IAAA,wCAAoB,EAAC,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,OAAO,EAAE,KAAK,CAAC;YACnD,KAAK,EAAE,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,KAAK;YAClB,MAAM,EAAE,IAAA,wCAAoB,EAAC,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,MAAM,EAAE,KAAK,CAAC;SACpD,CAAC;QAEF,OAAO,IAAI,CAAC,GAAG,CAAC;YACZ,IAAI,EAAE,2BAA2B;YACjC,UAAU;YACV,WAAW;YACX,UAAU,EAAE,yBAAiB;SAChC,CAAC,CAAC;IACP,CAAC;IA6BD,6BAA6B,CACzB,QAAgB,EAChB,IAAsF;QAEtF,IAAA,0BAAiB,EAAC,QAAQ,EAAE,UAAU,CAAC,CAAC;QAExC,MAAM,UAAU,GAAG;YACf,QAAQ;SACX,CAAC;QAEF,MAAM,WAAW,GAAG;YAChB,SAAS,EAAE,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,SAAS;YAC1B,QAAQ,EAAE,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,QAAQ;YACxB,OAAO,EAAE,IAAA,wCAAoB,EAAC,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,OAAO,EAAE,KAAK,CAAC;YACnD,OAAO,EAAE,IAAA,wCAAoB,EAAC,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,OAAO,EAAE,KAAK,CAAC;YACnD,KAAK,EAAE,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,KAAK;YAClB,MAAM,EAAE,IAAA,wCAAoB,EAAC,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,MAAM,EAAE,KAAK,CAAC;SACpD,CAAC;QAEF,OAAO,IAAI,CAAC,GAAG,CAAC;YACZ,IAAI,EAAE,2BAA2B;YACjC,UAAU;YACV,WAAW;YACX,UAAU,EAAE,mBAAW;SAC1B,CAAC,CAAC;IACP,CAAC;IAUD,UAAU,CAAC,IAAsF;QAC7F,MAAM,WAAW,GAAG;YAChB,SAAS,EAAE,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,SAAS;YAC1B,QAAQ,EAAE,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,QAAQ;YACxB,OAAO,EAAE,IAAA,wCAAoB,EAAC,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,OAAO,EAAE,KAAK,CAAC;YACnD,OAAO,EAAE,IAAA,wCAAoB,EAAC,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,OAAO,EAAE,KAAK,CAAC;YACnD,KAAK,EAAE,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,KAAK;YAClB,MAAM,EAAE,IAAA,wCAAoB,EAAC,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,MAAM,EAAE,KAAK,CAAC;SACpD,CAAC;QAEF,OAAO,IAAI,CAAC,GAAG,CAAC;YACZ,IAAI,EAAE,SAAS;YACf,WAAW;YACX,UAAU,EAAE,mBAAW;SAC1B,CAAC,CAAC;IACP,CAAC;IAaD,WAAW,CAAC,OAAe,EAAE,eAAgC,EAAE,IAA+C;QAC1G,IAAA,0BAAiB,EAAC,OAAO,EAAE,SAAS,CAAC,CAAC;QACtC,IAAA,0BAAiB,EAAC,eAAe,EAAE,iBAAiB,CAAC,CAAC;QAEtD,MAAM,UAAU,GAAG;YACf,OAAO;SACV,CAAC;QAEF,MAAM,WAAW,GAAG;YAChB,OAAO,EAAE,IAAA,wCAAoB,EAAC,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,OAAO,EAAE,KAAK,CAAC;YACnD,MAAM,EAAE,IAAA,wCAAoB,EAAC,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,MAAM,EAAE,KAAK,CAAC;SACpD,CAAC;QAEF,OAAO,IAAI,CAAC,GAAG,CAAC;YACZ,IAAI,EAAE,mBAAmB;YACzB,UAAU;YACV,WAAW;YACX,SAAS,EAAE,eAAe;SAC7B,CAAC,CAAC;IACP,CAAC;CACJ;AAjUD,8BAiUC","sourcesContent":["/*!\n * @license\n * Copyright © 2005-2024 Hyland Software, Inc. and its affiliates. All rights reserved.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { GroupBodyCreate, GroupBodyUpdate, GroupEntry, GroupMemberEntry, GroupMemberPaging, GroupMembershipBodyCreate, GroupPaging } from '../model';\nimport { BaseApi } from './base.api';\nimport { throwIfNotDefined } from '../../../assert';\nimport { buildCollectionParam } from '../../../alfrescoApiClient';\nimport { ContentFieldsQuery, ContentIncludeQuery, ContentPagingQuery } from './types';\n\nexport interface ListGroupMembershipsOpts {\n    /**\n     * A string to control the order of the entities returned in a list. You can use the **orderBy** parameter to\n     * sort the list by one or more fields.\n     *\n     * Each field has a default sort order, which is normally ascending order. Read the API method implementation notes\n     * above to check if any fields used in this method have a descending default search order.\n     *\n     * To sort the entities in a specific order, you can use the **ASC** and **DESC** keywords for any field\n     */\n    orderBy?: string[];\n    // A string to restrict the returned objects by using a predicate.\n    where?: string;\n}\n\nexport interface GroupPagingOpts {\n    /**\n     * A string to control the order of the entities returned in a list. You can use the **orderBy** parameter to\n     * sort the list by one or more fields.\n     *\n     * Each field has a default sort order, which is normally ascending order. Read the API method implementation notes\n     * above to check if any fields used in this method have a descending default search order.\n     *\n     * To sort the entities in a specific order, you can use the **ASC** and **DESC** keywords for any field.\n     */\n    orderBy?: string[];\n    /**\n     * A string to restrict the returned objects by using a predicate.\n     */\n    where?: string;\n}\n\nexport type DeleteGroupOpts = { cascade?: boolean };\n\n/**\n * Groups service.\n */\nexport class GroupsApi extends BaseApi {\n    /**\n     * Create a group\n     *\n     * **Note:** this endpoint is available in Alfresco 5.2.1 and newer versions.\n     *\n     * Create a group.\n     *\n     * The group id must start with \\\"GROUP\\\\_\\\". If this is omitted it will be added automatically.\n     * This format is also returned when listing groups or group memberships. It should be noted\n     * that the other group-related operations also expect the id to start with \\\"GROUP\\\\_\\\".\n     *\n     * If one or more parentIds are specified then the group will be created and become a member of each of the specified parent groups.\n     * If no parentIds are specified then the group will be created as a root group.\n     * The group will be created in the **APP.DEFAULT** and **AUTH.ALF** zones.\n     *\n     * You must have admin rights to create a group.\n     *\n     * @param groupBodyCreate The group to create.\n     * @param opts Optional parameters\n     * @returns Promise<GroupEntry>\n     */\n    createGroup(groupBodyCreate: GroupBodyCreate, opts?: ContentIncludeQuery & ContentFieldsQuery): Promise<GroupEntry> {\n        throwIfNotDefined(groupBodyCreate, 'groupBodyCreate');\n\n        const queryParams = {\n            include: buildCollectionParam(opts?.include, 'csv'),\n            fields: buildCollectionParam(opts?.fields, 'csv')\n        };\n\n        return this.post({\n            path: '/groups',\n            queryParams,\n            bodyParam: groupBodyCreate\n        });\n    }\n\n    /**\n     * Create a group membership\n     *\n     * **Note:** this endpoint is available in Alfresco 5.2.1 and newer versions.\n     *\n     * Create a group membership (for an existing person or group) within a group **groupId**.\n     * If the added group was previously a root group then it becomes a non-root group since it now has a parent.\n     * It is an error to specify an **id** that does not exist.\n     * You must have admin rights to create a group membership.\n     *\n     * @param groupId The identifier of a group.\n     * @param groupMembershipBodyCreate The group membership to add (person or sub-group).\n     * @param opts Optional parameters\n     * @returns Promise<GroupMemberEntry>\n     */\n    createGroupMembership(\n        groupId: string,\n        groupMembershipBodyCreate: GroupMembershipBodyCreate,\n        opts?: ContentFieldsQuery\n    ): Promise<GroupMemberEntry> {\n        throwIfNotDefined(groupId, 'groupId');\n        throwIfNotDefined(groupMembershipBodyCreate, 'groupMembershipBodyCreate');\n\n        const queryParams = {\n            fields: buildCollectionParam(opts?.fields, 'csv')\n        };\n\n        return this.post({\n            path: '/groups/{groupId}/members',\n            pathParams: { groupId },\n            queryParams,\n            bodyParam: groupMembershipBodyCreate\n        });\n    }\n\n    /**\n     * Delete a group\n     *\n     * **Note:** this endpoint is available in Alfresco 5.2.1 and newer versions.\n     *\n     * Delete group **groupId**.\n     * The option to cascade delete applies this recursively to any hierarchy of group members.\n     * In this case, removing a group member does not delete the person or sub-group itself.\n     * If a removed sub-group no longer has any parent groups then it becomes a root group.\n     * You must have admin rights to delete a group.\n     *\n     * @param groupId The identifier of a group.\n     * @param opts Optional parameters\n     * @returns Promise\n     */\n    deleteGroup(groupId: string, opts?: DeleteGroupOpts): Promise<void> {\n        throwIfNotDefined(groupId, 'groupId');\n        opts = opts || {};\n\n        const cascadeDelete = opts['cascade'] ? opts['cascade'] : false;\n\n        const pathParams = {\n            groupId\n        };\n\n        const queryParams = {\n            cascade: cascadeDelete\n        };\n\n        return this.delete({\n            path: '/groups/{groupId}',\n            pathParams,\n            queryParams\n        });\n    }\n\n    /**\n     * Delete a group membership\n     *\n     * **Note:** this endpoint is available in Alfresco 5.2.1 and newer versions.\n     *\n     * Delete group member **groupMemberId** (person or sub-group) from group **groupId**.\n     * Removing a group member does not delete the person or sub-group itself.\\\n     * If a removed sub-group no longer has any parent groups then it becomes a root group.\n     *\n     * @param groupId The identifier of a group.\n     * @param groupMemberId The identifier of a person or group.\n     * @returns Promise<{}>\n     */\n    deleteGroupMembership(groupId: string, groupMemberId: string): Promise<void> {\n        throwIfNotDefined(groupId, 'groupId');\n        throwIfNotDefined(groupMemberId, 'groupMemberId');\n\n        const pathParams = {\n            groupId,\n            groupMemberId\n        };\n\n        return this.delete({\n            path: '/groups/{groupId}/members/{groupMemberId}',\n            pathParams\n        });\n    }\n\n    /**\n     * Get group details\n     *\n     * **Note:** this endpoint is available in Alfresco 5.2.1 and newer versions.\n     *\n     * Get details for group **groupId**.\n     * You can use the **include** parameter to return additional information.\n     *\n     * @param groupId The identifier of a group.\n     * @param opts Optional parameters\n     * @returns Promise<GroupEntry>\n     */\n    getGroup(groupId: string, opts?: ContentIncludeQuery & ContentFieldsQuery): Promise<GroupEntry> {\n        throwIfNotDefined(groupId, 'groupId');\n\n        const pathParams = {\n            groupId\n        };\n\n        const queryParams = {\n            include: buildCollectionParam(opts?.include, 'csv'),\n            fields: buildCollectionParam(opts?.fields, 'csv')\n        };\n\n        return this.get({\n            path: '/groups/{groupId}',\n            pathParams,\n            queryParams\n        });\n    }\n\n    /**\n     * List memberships of a group\n     *\n     * **Note:** this endpoint is available in Alfresco 5.2.1 and newer versions.\n     *\n     * Gets a list of the group memberships for the group **groupId**.\n     *\n     * You can use the **where** parameter to filter the returned groups by **memberType**.\n     * Example to filter by **memberType**, use any one of:\n     * - (memberType='GROUP')\n     * - (memberType='PERSON')\n     *\n     * The default sort order for the returned list is for group members to be sorted by ascending displayName.\n     * You can override the default by using the **orderBy** parameter. You can specify one of the following fields in the **orderBy** parameter:\n     * - id\n     * - displayName\n     *\n     * @param groupId The identifier of a group.\n     * @param opts Optional parameters\n     * @returns Promise<GroupMemberPaging>\n     */\n    listGroupMemberships(groupId: string, opts?: ListGroupMembershipsOpts & ContentPagingQuery & ContentFieldsQuery): Promise<GroupMemberPaging> {\n        throwIfNotDefined(groupId, 'groupId');\n\n        const pathParams = {\n            groupId\n        };\n\n        const queryParams = {\n            skipCount: opts?.skipCount,\n            maxItems: opts?.maxItems,\n            orderBy: buildCollectionParam(opts?.orderBy, 'csv'),\n            where: opts?.where,\n            fields: buildCollectionParam(opts?.fields, 'csv')\n        };\n\n        return this.get({\n            path: '/groups/{groupId}/members',\n            pathParams,\n            queryParams,\n            returnType: GroupMemberPaging\n        });\n    }\n\n    /**\n     * List group memberships\n     *\n     * **Note:** this endpoint is available in Alfresco 5.2.1 and newer versions.\n     *\n     * @param personId The identifier of a person.\n     * @param opts Optional parameters\n     * @param opts.skipCount The number of entities that exist in the collection before those included in this list.\n     * If not supplied then the default value is 0. (default to 0)\n     * @param opts.maxItems The maximum number of items to return in the list. If not supplied then the default value is 100. (default to 100)\n     * @param opts.orderBy A string to control the order of the entities returned in a list. You can use the **orderBy** parameter to\n     * sort the list by one or more fields.\n     * Each field has a default sort order, which is normally ascending order. Read the API method implementation notes\n     * above to check if any fields used in this method have a descending default search order.\n     * To sort the entities in a specific order, you can use the **ASC** and **DESC** keywords for any field.\n     * @param opts.include Returns additional information about the group. The following optional fields can be requested:\n     * - parentIds\n     * - zones\n     * @param opts.where A string to restrict the returned objects by using a predicate.\n     * @param opts.fields A list of field names.\n     * You can use this parameter to restrict the fields\n     * returned within a response if, for example, you want to save on overall bandwidth.\n     * The list applies to a returned individual entity or entries within a collection.\n     * If the API method also supports the **include** parameter, then the fields specified in the **include**\n     * parameter are returned in addition to those specified in the **fields** parameter.\n     * @returns Promise<GroupPaging>\n     */\n    listGroupMembershipsForPerson(\n        personId: string,\n        opts?: GroupPagingOpts & ContentPagingQuery & ContentIncludeQuery & ContentFieldsQuery\n    ): Promise<GroupPaging> {\n        throwIfNotDefined(personId, 'personId');\n\n        const pathParams = {\n            personId\n        };\n\n        const queryParams = {\n            skipCount: opts?.skipCount,\n            maxItems: opts?.maxItems,\n            orderBy: buildCollectionParam(opts?.orderBy, 'csv'),\n            include: buildCollectionParam(opts?.include, 'csv'),\n            where: opts?.where,\n            fields: buildCollectionParam(opts?.fields, 'csv')\n        };\n\n        return this.get({\n            path: '/people/{personId}/groups',\n            pathParams,\n            queryParams,\n            returnType: GroupPaging\n        });\n    }\n\n    /**\n     * List groups\n     *\n     * **Note:** this endpoint is available in Alfresco 5.2.1 and newer versions.\n     *\n     * @param opts Optional parameters\n     * @returns Promise<GroupPaging>\n     */\n    listGroups(opts?: GroupPagingOpts & ContentPagingQuery & ContentIncludeQuery & ContentFieldsQuery): Promise<GroupPaging> {\n        const queryParams = {\n            skipCount: opts?.skipCount,\n            maxItems: opts?.maxItems,\n            orderBy: buildCollectionParam(opts?.orderBy, 'csv'),\n            include: buildCollectionParam(opts?.include, 'csv'),\n            where: opts?.where,\n            fields: buildCollectionParam(opts?.fields, 'csv')\n        };\n\n        return this.get({\n            path: '/groups',\n            queryParams,\n            returnType: GroupPaging\n        });\n    }\n\n    /**\n     * Update group details\n     *\n     * **Note:** this endpoint is available in Alfresco 5.2.1 and newer versions.\n     * You must have admin rights to update a group.\n     *\n     * @param groupId The identifier of a group.\n     * @param groupBodyUpdate The group information to update.\n     * @param opts Optional parameters\n     * @returns Promise<GroupEntry>\n     */\n    updateGroup(groupId: string, groupBodyUpdate: GroupBodyUpdate, opts?: ContentIncludeQuery & ContentFieldsQuery): Promise<GroupEntry> {\n        throwIfNotDefined(groupId, 'groupId');\n        throwIfNotDefined(groupBodyUpdate, 'groupBodyUpdate');\n\n        const pathParams = {\n            groupId\n        };\n\n        const queryParams = {\n            include: buildCollectionParam(opts?.include, 'csv'),\n            fields: buildCollectionParam(opts?.fields, 'csv')\n        };\n\n        return this.put({\n            path: '/groups/{groupId}',\n            pathParams,\n            queryParams,\n            bodyParam: groupBodyUpdate\n        });\n    }\n}\n"]}

package/src/api/content-rest-api/api/index.js

@@ -0,0 +1,42 @@
+"use strict";
+/*!
+ * @license
+ * Copyright © 2005-2024 Hyland Software, Inc. and its affiliates. All rights reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./types"), exports);
+tslib_1.__exportStar(require("./actions.api"), exports);
+tslib_1.__exportStar(require("./activities.api"), exports);
+tslib_1.__exportStar(require("./audit.api"), exports);
+tslib_1.__exportStar(require("./categories.api"), exports);
+tslib_1.__exportStar(require("./comments.api"), exports);
+tslib_1.__exportStar(require("./downloads.api"), exports);
+tslib_1.__exportStar(require("./favorites.api"), exports);
+tslib_1.__exportStar(require("./groups.api"), exports);
+tslib_1.__exportStar(require("./networks.api"), exports);
+tslib_1.__exportStar(require("./nodes.api"), exports);
+tslib_1.__exportStar(require("./people.api"), exports);
+tslib_1.__exportStar(require("./preferences.api"), exports);
+tslib_1.__exportStar(require("./probes.api"), exports);
+tslib_1.__exportStar(require("./queries.api"), exports);
+tslib_1.__exportStar(require("./ratings.api"), exports);
+tslib_1.__exportStar(require("./renditions.api"), exports);
+tslib_1.__exportStar(require("./sharedlinks.api"), exports);
+tslib_1.__exportStar(require("./sites.api"), exports);
+tslib_1.__exportStar(require("./tags.api"), exports);
+tslib_1.__exportStar(require("./trashcan.api"), exports);
+tslib_1.__exportStar(require("./versions.api"), exports);
+//# sourceMappingURL=../../../../../../../lib/js-api/src/api/content-rest-api/api/index.js.map

package/src/api/content-rest-api/api/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["index.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;GAeG;;;AAEH,kDAAwB;AACxB,wDAA8B;AAC9B,2DAAiC;AACjC,sDAA4B;AAC5B,2DAAiC;AACjC,yDAA+B;AAC/B,0DAAgC;AAChC,0DAAgC;AAChC,uDAA6B;AAC7B,yDAA+B;AAC/B,sDAA4B;AAC5B,uDAA6B;AAC7B,4DAAkC;AAClC,uDAA6B;AAC7B,wDAA8B;AAC9B,wDAA8B;AAC9B,2DAAiC;AACjC,4DAAkC;AAClC,sDAA4B;AAC5B,qDAA2B;AAC3B,yDAA+B;AAC/B,yDAA+B","sourcesContent":["/*!\n * @license\n * Copyright © 2005-2024 Hyland Software, Inc. and its affiliates. All rights reserved.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nexport * from './types';\nexport * from './actions.api';\nexport * from './activities.api';\nexport * from './audit.api';\nexport * from './categories.api';\nexport * from './comments.api';\nexport * from './downloads.api';\nexport * from './favorites.api';\nexport * from './groups.api';\nexport * from './networks.api';\nexport * from './nodes.api';\nexport * from './people.api';\nexport * from './preferences.api';\nexport * from './probes.api';\nexport * from './queries.api';\nexport * from './ratings.api';\nexport * from './renditions.api';\nexport * from './sharedlinks.api';\nexport * from './sites.api';\nexport * from './tags.api';\nexport * from './trashcan.api';\nexport * from './versions.api';\n"]}

package/src/api/content-rest-api/api/networks.api.js

@@ -0,0 +1,77 @@
+"use strict";
+/*!
+ * @license
+ * Copyright © 2005-2024 Hyland Software, Inc. and its affiliates. All rights reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NetworksApi = void 0;
+const personNetworkEntry_1 = require("../model/personNetworkEntry");
+const personNetworkPaging_1 = require("../model/personNetworkPaging");
+const base_api_1 = require("./base.api");
+const assert_1 = require("../../../assert");
+const alfrescoApiClient_1 = require("../../../alfrescoApiClient");
+class NetworksApi extends base_api_1.BaseApi {
+    getNetwork(networkId, opts) {
+        (0, assert_1.throwIfNotDefined)(networkId, 'networkId');
+        const pathParams = {
+            networkId
+        };
+        const queryParams = {
+            fields: (0, alfrescoApiClient_1.buildCollectionParam)(opts === null || opts === void 0 ? void 0 : opts.fields, 'csv')
+        };
+        return this.get({
+            path: '/networks/{networkId}',
+            pathParams,
+            queryParams,
+            returnType: personNetworkEntry_1.PersonNetworkEntry
+        });
+    }
+    getNetworkForPerson(personId, networkId, opts) {
+        (0, assert_1.throwIfNotDefined)(personId, 'personId');
+        (0, assert_1.throwIfNotDefined)(networkId, 'networkId');
+        const pathParams = {
+            personId,
+            networkId
+        };
+        const queryParams = {
+            fields: (0, alfrescoApiClient_1.buildCollectionParam)(opts === null || opts === void 0 ? void 0 : opts.fields, 'csv')
+        };
+        return this.get({
+            path: '/people/{personId}/networks/{networkId}',
+            pathParams,
+            queryParams,
+            returnType: personNetworkEntry_1.PersonNetworkEntry
+        });
+    }
+    listNetworksForPerson(personId, opts) {
+        (0, assert_1.throwIfNotDefined)(personId, 'personId');
+        const pathParams = {
+            personId
+        };
+        const queryParams = {
+            skipCount: opts === null || opts === void 0 ? void 0 : opts.skipCount,
+            maxItems: opts === null || opts === void 0 ? void 0 : opts.maxItems,
+            fields: (0, alfrescoApiClient_1.buildCollectionParam)(opts === null || opts === void 0 ? void 0 : opts.fields, 'csv')
+        };
+        return this.get({
+            path: '/people/{personId}/networks',
+            pathParams,
+            queryParams,
+            returnType: personNetworkPaging_1.PersonNetworkPaging
+        });
+    }
+}
+exports.NetworksApi = NetworksApi;
+//# sourceMappingURL=../../../../../../../lib/js-api/src/api/content-rest-api/api/networks.api.js.map

package/src/api/content-rest-api/api/networks.api.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"networks.api.js","sourceRoot":"","sources":["networks.api.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;GAeG;;;AAEH,oEAAiE;AACjE,sEAAmE;AACnE,yCAAqC;AACrC,4CAAoD;AACpD,kEAAkE;AAMlE,MAAa,WAAY,SAAQ,kBAAO;IAQpC,UAAU,CAAC,SAAiB,EAAE,IAAyB;QACnD,IAAA,0BAAiB,EAAC,SAAS,EAAE,WAAW,CAAC,CAAC;QAE1C,MAAM,UAAU,GAAG;YACf,SAAS;SACZ,CAAC;QAEF,MAAM,WAAW,GAAG;YAChB,MAAM,EAAE,IAAA,wCAAoB,EAAC,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,MAAM,EAAE,KAAK,CAAC;SACpD,CAAC;QAEF,OAAO,IAAI,CAAC,GAAG,CAAC;YACZ,IAAI,EAAE,uBAAuB;YAC7B,UAAU;YACV,WAAW;YACX,UAAU,EAAE,uCAAkB;SACjC,CAAC,CAAC;IACP,CAAC;IAYD,mBAAmB,CAAC,QAAgB,EAAE,SAAiB,EAAE,IAAyB;QAC9E,IAAA,0BAAiB,EAAC,QAAQ,EAAE,UAAU,CAAC,CAAC;QACxC,IAAA,0BAAiB,EAAC,SAAS,EAAE,WAAW,CAAC,CAAC;QAE1C,MAAM,UAAU,GAAG;YACf,QAAQ;YACR,SAAS;SACZ,CAAC;QAEF,MAAM,WAAW,GAAG;YAChB,MAAM,EAAE,IAAA,wCAAoB,EAAC,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,MAAM,EAAE,KAAK,CAAC;SACpD,CAAC;QAEF,OAAO,IAAI,CAAC,GAAG,CAAC;YACZ,IAAI,EAAE,yCAAyC;YAC/C,UAAU;YACV,WAAW;YACX,UAAU,EAAE,uCAAkB;SACjC,CAAC,CAAC;IACP,CAAC;IAYD,qBAAqB,CAAC,QAAgB,EAAE,IAA8C;QAClF,IAAA,0BAAiB,EAAC,QAAQ,EAAE,UAAU,CAAC,CAAC;QAExC,MAAM,UAAU,GAAG;YACf,QAAQ;SACX,CAAC;QAEF,MAAM,WAAW,GAAG;YAChB,SAAS,EAAE,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,SAAS;YAC1B,QAAQ,EAAE,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,QAAQ;YACxB,MAAM,EAAE,IAAA,wCAAoB,EAAC,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,MAAM,EAAE,KAAK,CAAC;SACpD,CAAC;QAEF,OAAO,IAAI,CAAC,GAAG,CAAC;YACZ,IAAI,EAAE,6BAA6B;YACnC,UAAU;YACV,WAAW;YACX,UAAU,EAAE,yCAAmB;SAClC,CAAC,CAAC;IACP,CAAC;CACJ;AAxFD,kCAwFC","sourcesContent":["/*!\n * @license\n * Copyright © 2005-2024 Hyland Software, Inc. and its affiliates. All rights reserved.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { PersonNetworkEntry } from '../model/personNetworkEntry';\nimport { PersonNetworkPaging } from '../model/personNetworkPaging';\nimport { BaseApi } from './base.api';\nimport { throwIfNotDefined } from '../../../assert';\nimport { buildCollectionParam } from '../../../alfrescoApiClient';\nimport { ContentFieldsQuery, ContentPagingQuery } from './types';\n\n/**\n * Networks service.\n */\nexport class NetworksApi extends BaseApi {\n    /**\n     * Get a network\n     *\n     * @param networkId The identifier of a network.\n     * @param opts Optional parameters\n     * @returns Promise<PersonNetworkEntry>\n     */\n    getNetwork(networkId: string, opts?: ContentFieldsQuery): Promise<PersonNetworkEntry> {\n        throwIfNotDefined(networkId, 'networkId');\n\n        const pathParams = {\n            networkId\n        };\n\n        const queryParams = {\n            fields: buildCollectionParam(opts?.fields, 'csv')\n        };\n\n        return this.get({\n            path: '/networks/{networkId}',\n            pathParams,\n            queryParams,\n            returnType: PersonNetworkEntry\n        });\n    }\n\n    /**\n     * Get network information\n     *\n     * You can use the -me- string in place of <personId> to specify the currently authenticated user.\n     *\n     * @param personId The identifier of a person.\n     * @param networkId The identifier of a network.\n     * @param opts Optional parameters\n     * @returns Promise<PersonNetworkEntry>\n     */\n    getNetworkForPerson(personId: string, networkId: string, opts?: ContentFieldsQuery): Promise<PersonNetworkEntry> {\n        throwIfNotDefined(personId, 'personId');\n        throwIfNotDefined(networkId, 'networkId');\n\n        const pathParams = {\n            personId,\n            networkId\n        };\n\n        const queryParams = {\n            fields: buildCollectionParam(opts?.fields, 'csv')\n        };\n\n        return this.get({\n            path: '/people/{personId}/networks/{networkId}',\n            pathParams,\n            queryParams,\n            returnType: PersonNetworkEntry\n        });\n    }\n\n    /**\n     * List network membership\n     *\n     * Gets a list of network memberships for person **personId**.\n     * You can use the -me- string in place of <personId> to specify the currently authenticated user.\n     *\n     * @param personId The identifier of a person.\n     * @param opts Optional parameters\n     * @returns Promise<PersonNetworkPaging>\n     */\n    listNetworksForPerson(personId: string, opts?: ContentPagingQuery & ContentFieldsQuery): Promise<PersonNetworkPaging> {\n        throwIfNotDefined(personId, 'personId');\n\n        const pathParams = {\n            personId\n        };\n\n        const queryParams = {\n            skipCount: opts?.skipCount,\n            maxItems: opts?.maxItems,\n            fields: buildCollectionParam(opts?.fields, 'csv')\n        };\n\n        return this.get({\n            path: '/people/{personId}/networks',\n            pathParams,\n            queryParams,\n            returnType: PersonNetworkPaging\n        });\n    }\n}\n"]}