@alfresco/js-api 7.3.0-1530 → 7.3.0

package/esm2015/src/api/gs-core-rest-api/api/filePlans.api.js

@@ -1,98 +0,0 @@
-/*!
- * @license
- * Copyright © 2005-2023 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.
- */
-import { FilePlanEntry } from '../model/filePlanEntry';
-import { RecordCategoryEntry } from '../model/recordCategoryEntry';
-import { RecordCategoryPaging } from '../model/recordCategoryPaging';
-import { BaseApi } from './base.api';
-import { buildCollectionParam } from '../../../alfrescoApiClient';
-import { throwIfNotDefined } from '../../../assert';
-export class FilePlansApi extends BaseApi {
-    createFilePlanCategories(filePlanId, nodeBodyCreate, opts) {
-        throwIfNotDefined(filePlanId, 'filePlanId');
-        throwIfNotDefined(nodeBodyCreate, 'nodeBodyCreate');
-        const pathParams = {
-            filePlanId,
-        };
-        const queryParams = {
-            autoRename: opts === null || opts === void 0 ? void 0 : opts.autoRename,
-            include: buildCollectionParam(opts === null || opts === void 0 ? void 0 : opts.include, 'csv'),
-            fields: buildCollectionParam(opts === null || opts === void 0 ? void 0 : opts.fields, 'csv'),
-        };
-        return this.post({
-            path: '/file-plans/{filePlanId}/categories',
-            pathParams,
-            queryParams,
-            contentTypes: ['application/json', 'multipart/form-data'],
-            bodyParam: nodeBodyCreate,
-            returnType: RecordCategoryEntry,
-        });
-    }
-    getFilePlan(filePlanId, opts) {
-        throwIfNotDefined(filePlanId, 'filePlanId');
-        const pathParams = {
-            filePlanId,
-        };
-        const queryParams = {
-            include: buildCollectionParam(opts === null || opts === void 0 ? void 0 : opts.include, 'csv'),
-            fields: buildCollectionParam(opts === null || opts === void 0 ? void 0 : opts.fields, 'csv'),
-        };
-        return this.get({
-            path: '/file-plans/{filePlanId}',
-            pathParams,
-            queryParams,
-            returnType: FilePlanEntry,
-        });
-    }
-    getFilePlanCategories(filePlanId, opts) {
-        throwIfNotDefined(filePlanId, 'filePlanId');
-        const pathParams = {
-            filePlanId,
-        };
-        const queryParams = {
-            skipCount: opts === null || opts === void 0 ? void 0 : opts.skipCount,
-            maxItems: opts === null || opts === void 0 ? void 0 : opts.maxItems,
-            include: buildCollectionParam(opts === null || opts === void 0 ? void 0 : opts.include, 'csv'),
-            includeSource: opts === null || opts === void 0 ? void 0 : opts.includeSource,
-            fields: buildCollectionParam(opts === null || opts === void 0 ? void 0 : opts.fields, 'csv'),
-        };
-        return this.get({
-            path: '/file-plans/{filePlanId}/categories',
-            pathParams,
-            queryParams,
-            returnType: RecordCategoryPaging,
-        });
-    }
-    updateFilePlan(filePlanId, filePlanBodyUpdate, opts) {
-        throwIfNotDefined(filePlanId, 'filePlanId');
-        throwIfNotDefined(filePlanBodyUpdate, 'filePlanBodyUpdate');
-        const pathParams = {
-            filePlanId,
-        };
-        const queryParams = {
-            include: buildCollectionParam(opts === null || opts === void 0 ? void 0 : opts.include, 'csv'),
-            fields: buildCollectionParam(opts === null || opts === void 0 ? void 0 : opts.fields, 'csv'),
-        };
-        return this.put({
-            path: '/file-plans/{filePlanId}',
-            pathParams,
-            queryParams,
-            bodyParam: filePlanBodyUpdate,
-            returnType: FilePlanEntry,
-        });
-    }
-}
-//# sourceMappingURL=../../../../../../src/api/gs-core-rest-api/api/filePlans.api.js.map

package/esm2015/src/api/gs-core-rest-api/api/filePlans.api.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"filePlans.api.js","sourceRoot":"","sources":["filePlans.api.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;GAeG;AAGH,OAAO,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAC;AACvD,OAAO,EAAE,mBAAmB,EAAE,MAAM,8BAA8B,CAAC;AACnE,OAAO,EAAE,oBAAoB,EAAE,MAAM,+BAA+B,CAAC;AAErE,OAAO,EAAE,OAAO,EAAE,MAAM,YAAY,CAAC;AACrC,OAAO,EAAE,oBAAoB,EAAE,MAAM,4BAA4B,CAAC;AAClE,OAAO,EAAE,iBAAiB,EAAE,MAAM,iBAAiB,CAAC;AAOpD,MAAM,OAAO,YAAa,SAAQ,OAAO;IAmErC,wBAAwB,CACpB,UAAkB,EAClB,cAAsC,EACtC,IAEuB;QAEvB,iBAAiB,CAAC,UAAU,EAAE,YAAY,CAAC,CAAC;QAC5C,iBAAiB,CAAC,cAAc,EAAE,gBAAgB,CAAC,CAAC;QAEpD,MAAM,UAAU,GAAG;YACf,UAAU;SACb,CAAC;QAEF,MAAM,WAAW,GAAG;YAChB,UAAU,EAAE,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,UAAU;YAC5B,OAAO,EAAE,oBAAoB,CAAC,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,OAAO,EAAE,KAAK,CAAC;YACnD,MAAM,EAAE,oBAAoB,CAAC,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,MAAM,EAAE,KAAK,CAAC;SACpD,CAAC;QAEF,OAAO,IAAI,CAAC,IAAI,CAAC;YACb,IAAI,EAAE,qCAAqC;YAC3C,UAAU;YACV,WAAW;YACX,YAAY,EAAE,CAAC,kBAAkB,EAAE,qBAAqB,CAAC;YACzD,SAAS,EAAE,cAAc;YACzB,UAAU,EAAE,mBAAmB;SAClC,CAAC,CAAC;IACP,CAAC;IAeD,WAAW,CAAC,UAAkB,EAAE,IAA0B;QACtD,iBAAiB,CAAC,UAAU,EAAE,YAAY,CAAC,CAAC;QAE5C,MAAM,UAAU,GAAG;YACf,UAAU;SACb,CAAC;QAEF,MAAM,WAAW,GAAG;YAChB,OAAO,EAAE,oBAAoB,CAAC,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,OAAO,EAAE,KAAK,CAAC;YACnD,MAAM,EAAE,oBAAoB,CAAC,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,MAAM,EAAE,KAAK,CAAC;SACpD,CAAC;QAEF,OAAO,IAAI,CAAC,GAAG,CAAC;YACZ,IAAI,EAAE,0BAA0B;YAChC,UAAU;YACV,WAAW;YACX,UAAU,EAAE,aAAa;SAC5B,CAAC,CAAC;IACP,CAAC;IAYD,qBAAqB,CAAC,UAAkB,EAAE,IAAoE;QAC1G,iBAAiB,CAAC,UAAU,EAAE,YAAY,CAAC,CAAC;QAE5C,MAAM,UAAU,GAAG;YACf,UAAU;SACb,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,oBAAoB,CAAC,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,OAAO,EAAE,KAAK,CAAC;YACnD,aAAa,EAAE,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,aAAa;YAClC,MAAM,EAAE,oBAAoB,CAAC,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,MAAM,EAAE,KAAK,CAAC;SACpD,CAAC;QAEF,OAAO,IAAI,CAAC,GAAG,CAAC;YACZ,IAAI,EAAE,qCAAqC;YAC3C,UAAU;YACV,WAAW;YACX,UAAU,EAAE,oBAAoB;SACnC,CAAC,CAAC;IACP,CAAC;IAuBD,cAAc,CAAC,UAAkB,EAAE,kBAAsC,EAAE,IAA0B;QACjG,iBAAiB,CAAC,UAAU,EAAE,YAAY,CAAC,CAAC;QAC5C,iBAAiB,CAAC,kBAAkB,EAAE,oBAAoB,CAAC,CAAC;QAE5D,MAAM,UAAU,GAAG;YACf,UAAU;SACb,CAAC;QAEF,MAAM,WAAW,GAAG;YAChB,OAAO,EAAE,oBAAoB,CAAC,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,OAAO,EAAE,KAAK,CAAC;YACnD,MAAM,EAAE,oBAAoB,CAAC,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,MAAM,EAAE,KAAK,CAAC;SACpD,CAAC;QAEF,OAAO,IAAI,CAAC,GAAG,CAAC;YACZ,IAAI,EAAE,0BAA0B;YAChC,UAAU;YACV,WAAW;YACX,SAAS,EAAE,kBAAkB;YAC7B,UAAU,EAAE,aAAa;SAC5B,CAAC,CAAC;IACP,CAAC;CACJ","sourcesContent":["/*!\n * @license\n * Copyright © 2005-2023 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 { FilePlanBodyUpdate } from '../model/filePlanBodyUpdate';\nimport { FilePlanEntry } from '../model/filePlanEntry';\nimport { RecordCategoryEntry } from '../model/recordCategoryEntry';\nimport { RecordCategoryPaging } from '../model/recordCategoryPaging';\nimport { RootCategoryBodyCreate } from '../model/rootCategoryBodyCreate';\nimport { BaseApi } from './base.api';\nimport { buildCollectionParam } from '../../../alfrescoApiClient';\nimport { throwIfNotDefined } from '../../../assert';\nimport { RecordsIncludeQuery, RecordsPagingQuery, RecordsSourceQuery } from './types';\n\n/**\n * FilePlansApi service.\n * @module FilePlansApi\n */\nexport class FilePlansApi extends BaseApi {\n    /**\n    * Create record categories for a file plan\n    *\n    * Creates a record category as a primary child of **filePlanId**.\n\nYou can set the **autoRename** boolean field to automatically resolve name clashes. If there is a name clash, then\nthe API method tries to create\na unique name using an integer suffix.\n\nThis API method also supports record category creation using application/json.\n\nYou must specify at least a **name**.\n\nYou can create a category like this:\nJSON\n{\n  \\\"name\\\":\\\"My Record Category\\\"\n}\n\nYou can set properties when creating a record category:\nJSON\n{\n  \\\"name\\\":\\\"My Record Category\\\",\n  \\\"properties\\\":\n  {\n    \\\"rma:vitalRecordIndicator\\\":\\\"true\\\",\n    \\\"rma:reviewPeriod\\\":\\\"month|1\\\"\n  }\n}\n\nAny missing aspects are applied automatically. You can set aspects explicitly, if needed, using an **aspectNames** field.\n\nIf you specify a list as input, then a paginated list rather than an entry is returned in the response body. For example:\n\nJSON\n{\n  \\\"list\\\": {\n    \\\"pagination\\\": {\n      \\\"count\\\": 2,\n      \\\"hasMoreItems\\\": false,\n      \\\"totalItems\\\": 2,\n      \\\"skipCount\\\": 0,\n      \\\"maxItems\\\": 100\n    },\n    \\\"entries\\\": [\n      {\n        \\\"entry\\\": {\n          ...\n        }\n      },\n      {\n        \\\"entry\\\": {\n          ...\n        }\n      }\n    ]\n  }\n}\n\n    *\n    * @param filePlanId The identifier of a file plan. You can also use the -filePlan- alias.\n    * @param nodeBodyCreate The node information to create.\n    * @param opts Optional parameters\n    * @param opts.autoRename If true, then  a name clash will cause an attempt to auto rename by finding a unique name using an integer suffix.\n    * @return Promise<RecordCategoryEntry>\n    */\n    createFilePlanCategories(\n        filePlanId: string,\n        nodeBodyCreate: RootCategoryBodyCreate,\n        opts?: {\n            autoRename?: boolean;\n        } & RecordsIncludeQuery,\n    ): Promise<RecordCategoryEntry> {\n        throwIfNotDefined(filePlanId, 'filePlanId');\n        throwIfNotDefined(nodeBodyCreate, 'nodeBodyCreate');\n\n        const pathParams = {\n            filePlanId,\n        };\n\n        const queryParams = {\n            autoRename: opts?.autoRename,\n            include: buildCollectionParam(opts?.include, 'csv'),\n            fields: buildCollectionParam(opts?.fields, 'csv'),\n        };\n\n        return this.post({\n            path: '/file-plans/{filePlanId}/categories',\n            pathParams,\n            queryParams,\n            contentTypes: ['application/json', 'multipart/form-data'],\n            bodyParam: nodeBodyCreate,\n            returnType: RecordCategoryEntry,\n        });\n    }\n    /**\n        * Get a file plan\n        *\n        * Gets information for file plan **filePlanId**\n\n    Mandatory fields and the file plan's aspects and properties are returned by default.\n\n    You can use the **include** parameter (include=allowableOperations) to return additional information.\n\n        *\n        * @param filePlanId The identifier of a file plan. You can also use the -filePlan- alias.\n        * @param opts Optional parameters\n        * @return Promise<FilePlanEntry>\n        */\n    getFilePlan(filePlanId: string, opts?: RecordsIncludeQuery): Promise<FilePlanEntry> {\n        throwIfNotDefined(filePlanId, 'filePlanId');\n\n        const pathParams = {\n            filePlanId,\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: '/file-plans/{filePlanId}',\n            pathParams,\n            queryParams,\n            returnType: FilePlanEntry,\n        });\n    }\n\n    /**\n     * List file plans's children\n     *\n     * Minimal information for each child is returned by default.\n     * You can use the **include** parameter (include=allowableOperations) to return additional information.\n     *\n     * @param filePlanId The identifier of a file plan. You can also use the -filePlan- alias.\n     * @param opts Optional parameters\n     * @return Promise<RecordCategoryPaging>\n     */\n    getFilePlanCategories(filePlanId: string, opts?: RecordsIncludeQuery & RecordsPagingQuery & RecordsSourceQuery): Promise<RecordCategoryPaging> {\n        throwIfNotDefined(filePlanId, 'filePlanId');\n\n        const pathParams = {\n            filePlanId,\n        };\n\n        const queryParams = {\n            skipCount: opts?.skipCount,\n            maxItems: opts?.maxItems,\n            include: buildCollectionParam(opts?.include, 'csv'),\n            includeSource: opts?.includeSource,\n            fields: buildCollectionParam(opts?.fields, 'csv'),\n        };\n\n        return this.get({\n            path: '/file-plans/{filePlanId}/categories',\n            pathParams,\n            queryParams,\n            returnType: RecordCategoryPaging,\n        });\n    }\n\n    /**\n     * Update a file plan\n     *\n     * Updates file plan **filePlanId**.\n     * You can only set or update description and title properties:\n     * JSON\n     * {\n     * \\\"properties\\\":\n     * {\n     *    \\\"cm:description\\\": \\\"New Description\\\",\n     *    \\\"cm:title\\\":\\\"New Title\\\"\n     * }\n     *}\n     *\n     * **Note:** Currently there is no optimistic locking for updates, so they are applied in \\\"last one wins\\\" order.\n     *\n     * @param filePlanId The identifier of a file plan. You can also use the -filePlan- alias.\n     * @param filePlanBodyUpdate The file plan information to update.\n     * @param opts Optional parameters\n     * @return Promise<FilePlanEntry>\n     */\n    updateFilePlan(filePlanId: string, filePlanBodyUpdate: FilePlanBodyUpdate, opts?: RecordsIncludeQuery): Promise<FilePlanEntry> {\n        throwIfNotDefined(filePlanId, 'filePlanId');\n        throwIfNotDefined(filePlanBodyUpdate, 'filePlanBodyUpdate');\n\n        const pathParams = {\n            filePlanId,\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: '/file-plans/{filePlanId}',\n            pathParams,\n            queryParams,\n            bodyParam: filePlanBodyUpdate,\n            returnType: FilePlanEntry,\n        });\n    }\n}\n"]}

package/esm2015/src/api/gs-core-rest-api/api/files.api.js

@@ -1,41 +0,0 @@
-/*!
- * @license
- * Copyright © 2005-2023 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.
- */
-import { RecordEntry } from '../model/recordEntry';
-import { BaseApi } from './base.api';
-import { buildCollectionParam } from '../../../alfrescoApiClient';
-import { throwIfNotDefined } from '../../../assert';
-export class FilesApi extends BaseApi {
-    declareRecord(fileId, opts) {
-        throwIfNotDefined(fileId, 'fileId');
-        const pathParams = {
-            fileId,
-        };
-        const queryParams = {
-            hideRecord: opts === null || opts === void 0 ? void 0 : opts.hideRecord,
-            parentId: opts === null || opts === void 0 ? void 0 : opts.parentId,
-            include: buildCollectionParam(opts === null || opts === void 0 ? void 0 : opts.include, 'csv'),
-            fields: buildCollectionParam(opts === null || opts === void 0 ? void 0 : opts.fields, 'csv'),
-        };
-        return this.post({
-            path: '/files/{fileId}/declare',
-            pathParams,
-            queryParams,
-            returnType: RecordEntry,
-        });
-    }
-}
-//# sourceMappingURL=../../../../../../src/api/gs-core-rest-api/api/files.api.js.map

package/esm2015/src/api/gs-core-rest-api/api/files.api.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"files.api.js","sourceRoot":"","sources":["files.api.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;GAeG;AAEH,OAAO,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAC;AACnD,OAAO,EAAE,OAAO,EAAE,MAAM,YAAY,CAAC;AACrC,OAAO,EAAE,oBAAoB,EAAE,MAAM,4BAA4B,CAAC;AAClE,OAAO,EAAE,iBAAiB,EAAE,MAAM,iBAAiB,CAAC;AAOpD,MAAM,OAAO,QAAS,SAAQ,OAAO;IAWjC,aAAa,CACT,MAAc,EACd,IAGuB;QAEvB,iBAAiB,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;QAEpC,MAAM,UAAU,GAAG;YACf,MAAM;SACT,CAAC;QAEF,MAAM,WAAW,GAAG;YAChB,UAAU,EAAE,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,UAAU;YAC5B,QAAQ,EAAE,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,QAAQ;YACxB,OAAO,EAAE,oBAAoB,CAAC,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,OAAO,EAAE,KAAK,CAAC;YACnD,MAAM,EAAE,oBAAoB,CAAC,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,MAAM,EAAE,KAAK,CAAC;SACpD,CAAC;QAEF,OAAO,IAAI,CAAC,IAAI,CAAC;YACb,IAAI,EAAE,yBAAyB;YAC/B,UAAU;YACV,WAAW;YACX,UAAU,EAAE,WAAW;SAC1B,CAAC,CAAC;IACP,CAAC;CACJ","sourcesContent":["/*!\n * @license\n * Copyright © 2005-2023 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 { RecordEntry } from '../model/recordEntry';\nimport { BaseApi } from './base.api';\nimport { buildCollectionParam } from '../../../alfrescoApiClient';\nimport { throwIfNotDefined } from '../../../assert';\nimport { RecordsIncludeQuery } from './types';\n\n/**\n * Files service.\n * @module FilesApi\n */\nexport class FilesApi extends BaseApi {\n    /**\n     * Declare as record\n     *\n     * Declares the file **fileId** in the unfiled records container. The original file is moved to the Records Management site and a secondary parent association is created in the file's original site.\n     *\n     * @param fileId The identifier of a non-record file.\n     * @param opts Optional parameters\n     * @param opts.hideRecord Flag to indicate whether the record should be hidden from the current parent folder. (default to false)\n     * @return Promise<RecordEntry>\n     */\n    declareRecord(\n        fileId: string,\n        opts?: {\n            hideRecord?: boolean;\n            parentId?: string;\n        } & RecordsIncludeQuery,\n    ): Promise<RecordEntry> {\n        throwIfNotDefined(fileId, 'fileId');\n\n        const pathParams = {\n            fileId,\n        };\n\n        const queryParams = {\n            hideRecord: opts?.hideRecord,\n            parentId: opts?.parentId,\n            include: buildCollectionParam(opts?.include, 'csv'),\n            fields: buildCollectionParam(opts?.fields, 'csv'),\n        };\n\n        return this.post({\n            path: '/files/{fileId}/declare',\n            pathParams,\n            queryParams,\n            returnType: RecordEntry,\n        });\n    }\n}\n"]}

package/esm2015/src/api/gs-core-rest-api/api/gsSites.api.js

@@ -1,59 +0,0 @@
-/*!
- * @license
- * Copyright © 2005-2023 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.
- */
-import { RMSiteEntry } from '../model/rMSiteEntry';
-import { BaseApi } from './base.api';
-import { buildCollectionParam } from '../../../alfrescoApiClient';
-import { throwIfNotDefined } from '../../../assert';
-export class GsSitesApi extends BaseApi {
-    createRMSite(siteBodyCreate, opts) {
-        throwIfNotDefined(siteBodyCreate, 'siteBodyCreate');
-        return this.post({
-            path: '/gs-sites',
-            queryParams: opts,
-            bodyParam: siteBodyCreate,
-            returnType: RMSiteEntry,
-        });
-    }
-    deleteRMSite() {
-        return this.delete({
-            path: '/gs-sites/rm',
-        });
-    }
-    getRMSite(opts) {
-        const queryParams = {
-            fields: buildCollectionParam(opts === null || opts === void 0 ? void 0 : opts.fields, 'csv'),
-        };
-        return this.get({
-            path: '/gs-sites/rm',
-            queryParams,
-            returnType: RMSiteEntry,
-        });
-    }
-    updateRMSite(siteBodyUpdate, opts) {
-        throwIfNotDefined(siteBodyUpdate, 'siteBodyUpdate');
-        const queryParams = {
-            fields: buildCollectionParam(opts === null || opts === void 0 ? void 0 : opts.fields, 'csv'),
-        };
-        return this.put({
-            path: '/gs-sites/rm',
-            queryParams,
-            bodyParam: siteBodyUpdate,
-            returnType: RMSiteEntry,
-        });
-    }
-}
-//# sourceMappingURL=../../../../../../src/api/gs-core-rest-api/api/gsSites.api.js.map

package/esm2015/src/api/gs-core-rest-api/api/gsSites.api.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"gsSites.api.js","sourceRoot":"","sources":["gsSites.api.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;GAeG;AAIH,OAAO,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAC;AACnD,OAAO,EAAE,OAAO,EAAE,MAAM,YAAY,CAAC;AACrC,OAAO,EAAE,oBAAoB,EAAE,MAAM,4BAA4B,CAAC;AAClE,OAAO,EAAE,iBAAiB,EAAE,MAAM,iBAAiB,CAAC;AAOpD,MAAM,OAAO,UAAW,SAAQ,OAAO;IAsBnC,YAAY,CAAC,cAAgC,EAAE,IAAuC;QAClF,iBAAiB,CAAC,cAAc,EAAE,gBAAgB,CAAC,CAAC;QAEpD,OAAO,IAAI,CAAC,IAAI,CAAC;YACb,IAAI,EAAE,WAAW;YACjB,WAAW,EAAE,IAAI;YACjB,SAAS,EAAE,cAAc;YACzB,UAAU,EAAE,WAAW;SAC1B,CAAC,CAAC;IACP,CAAC;IAOD,YAAY;QACR,OAAO,IAAI,CAAC,MAAM,CAAC;YACf,IAAI,EAAE,cAAc;SACvB,CAAC,CAAC;IACP,CAAC;IAQD,SAAS,CAAC,IAAyB;QAC/B,MAAM,WAAW,GAAG;YAChB,MAAM,EAAE,oBAAoB,CAAC,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,MAAM,EAAE,KAAK,CAAC;SACpD,CAAC;QAEF,OAAO,IAAI,CAAC,GAAG,CAAC;YACZ,IAAI,EAAE,cAAc;YACpB,WAAW;YACX,UAAU,EAAE,WAAW;SAC1B,CAAC,CAAC;IACP,CAAC;IAYD,YAAY,CAAC,cAAgC,EAAE,IAAyB;QACpE,iBAAiB,CAAC,cAAc,EAAE,gBAAgB,CAAC,CAAC;QAEpD,MAAM,WAAW,GAAG;YAChB,MAAM,EAAE,oBAAoB,CAAC,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,MAAM,EAAE,KAAK,CAAC;SACpD,CAAC;QAEF,OAAO,IAAI,CAAC,GAAG,CAAC;YACZ,IAAI,EAAE,cAAc;YACpB,WAAW;YACX,SAAS,EAAE,cAAc;YACzB,UAAU,EAAE,WAAW;SAC1B,CAAC,CAAC;IACP,CAAC;CACJ","sourcesContent":["/*!\n * @license\n * Copyright © 2005-2023 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 { RMSiteBodyCreate } from '../model/rMSiteBodyCreate';\nimport { RMSiteBodyUpdate } from '../model/rMSiteBodyUpdate';\nimport { RMSiteEntry } from '../model/rMSiteEntry';\nimport { BaseApi } from './base.api';\nimport { buildCollectionParam } from '../../../alfrescoApiClient';\nimport { throwIfNotDefined } from '../../../assert';\nimport { RecordsFieldsQuery } from './types';\n\n/**\n * GsSitesApi service.\n * @module GssitesApi\n */\nexport class GsSitesApi extends BaseApi {\n    /**\n     * Create the Records Management (RM) site\n     *\n     * **Note:** The default site id is rm and the default site name is Records Management. The id of a site cannot be updated once the site has been created.\n     *\n     * For example, to create an RM site named \\\"Records Management\\\" with \\\"Records Management Description\\\" as description, the following body could be used:\n     * JSON\n     * {\n     *   \\\"title\\\": \\\"Records Management\\\",\n     *   \\\"description\\\": \\\"Records Management Description\\\"\n     * }\n     *\n     * The creator will be added as a member with Site Manager role.\n     *\n     * When you create the RM site, the **filePlan** structure is also created including special containers, such as containers for transfers, holds and, unfiled records.\n     *\n     * @param siteBodyCreate The site details\n     * @param opts Optional parameters\n     * @param opts.skipAddToFavorites Flag to indicate whether the RM site should not be added to the user's site favorites. (default to false)\n     * @return Promise<RMSiteEntry>\n     */\n    createRMSite(siteBodyCreate: RMSiteBodyCreate, opts?: { skipAddToFavorites?: boolean }): Promise<RMSiteEntry> {\n        throwIfNotDefined(siteBodyCreate, 'siteBodyCreate');\n\n        return this.post({\n            path: '/gs-sites',\n            queryParams: opts,\n            bodyParam: siteBodyCreate,\n            returnType: RMSiteEntry,\n        });\n    }\n\n    /**\n     * Delete the Records Management (RM) site\n     *\n     * @return Promise<{}>\n     */\n    deleteRMSite(): Promise<void> {\n        return this.delete({\n            path: '/gs-sites/rm',\n        });\n    }\n\n    /**\n     * Get the Records Management (RM) site\n     *\n     * @param opts Optional parameters\n     * @return Promise<RMSiteEntry>\n     */\n    getRMSite(opts?: RecordsFieldsQuery): Promise<RMSiteEntry> {\n        const queryParams = {\n            fields: buildCollectionParam(opts?.fields, 'csv'),\n        };\n\n        return this.get({\n            path: '/gs-sites/rm',\n            queryParams,\n            returnType: RMSiteEntry,\n        });\n    }\n\n    /**\n     * Update the Records Management (RM) site\n     *\n     * Update the details for the RM site. Site Manager or other (site) admin can update title or description.\n     * **Note**: the id, site visibility, or compliance of the RM site cannot be updated once the site has been created.\n     *\n     * @param siteBodyUpdate The RM site information to update.\n     * @param opts Optional parameters\n     * @return Promise<RMSiteEntry>\n     */\n    updateRMSite(siteBodyUpdate: RMSiteBodyUpdate, opts?: RecordsFieldsQuery): Promise<RMSiteEntry> {\n        throwIfNotDefined(siteBodyUpdate, 'siteBodyUpdate');\n\n        const queryParams = {\n            fields: buildCollectionParam(opts?.fields, 'csv'),\n        };\n\n        return this.put({\n            path: '/gs-sites/rm',\n            queryParams,\n            bodyParam: siteBodyUpdate,\n            returnType: RMSiteEntry,\n        });\n    }\n}\n"]}

package/esm2015/src/api/gs-core-rest-api/api/index.js

@@ -1,28 +0,0 @@
-/*!
- * @license
- * Copyright © 2005-2023 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.
- */
-export * from './types';
-export * from './filePlans.api';
-export * from './files.api';
-export * from './gsSites.api';
-export * from './recordCategories.api';
-export * from './recordFolders.api';
-export * from './records.api';
-export * from './transferContainers.api';
-export * from './transfers.api';
-export * from './unfiledContainers.api';
-export * from './unfiledRecordFolders.api';
-//# sourceMappingURL=../../../../../../src/api/gs-core-rest-api/api/index.js.map

package/esm2015/src/api/gs-core-rest-api/api/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;GAeG;AAEH,cAAc,SAAS,CAAC;AACxB,cAAc,iBAAiB,CAAC;AAChC,cAAc,aAAa,CAAC;AAC5B,cAAc,eAAe,CAAC;AAC9B,cAAc,wBAAwB,CAAC;AACvC,cAAc,qBAAqB,CAAC;AACpC,cAAc,eAAe,CAAC;AAC9B,cAAc,0BAA0B,CAAC;AACzC,cAAc,iBAAiB,CAAC;AAChC,cAAc,yBAAyB,CAAC;AACxC,cAAc,4BAA4B,CAAC","sourcesContent":["/*!\n * @license\n * Copyright © 2005-2023 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 './filePlans.api';\nexport * from './files.api';\nexport * from './gsSites.api';\nexport * from './recordCategories.api';\nexport * from './recordFolders.api';\nexport * from './records.api';\nexport * from './transferContainers.api';\nexport * from './transfers.api';\nexport * from './unfiledContainers.api';\nexport * from './unfiledRecordFolders.api';\n"]}

package/esm2015/src/api/gs-core-rest-api/api/recordCategories.api.js

@@ -1,110 +0,0 @@
-/*!
- * @license
- * Copyright © 2005-2023 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.
- */
-import { RecordCategoryChildEntry } from '../model/recordCategoryChildEntry';
-import { RecordCategoryChildPaging } from '../model/recordCategoryChildPaging';
-import { RecordCategoryEntry } from '../model/recordCategoryEntry';
-import { BaseApi } from './base.api';
-import { buildCollectionParam } from '../../../alfrescoApiClient';
-import { throwIfNotDefined } from '../../../assert';
-export class RecordCategoriesApi extends BaseApi {
-    createRecordCategoryChild(recordCategoryId, nodeBodyCreate, opts) {
-        throwIfNotDefined(recordCategoryId, 'recordCategoryId');
-        throwIfNotDefined(nodeBodyCreate, 'nodeBodyCreate');
-        const pathParams = {
-            recordCategoryId
-        };
-        const queryParams = {
-            autoRename: opts === null || opts === void 0 ? void 0 : opts.autoRename,
-            include: buildCollectionParam(opts === null || opts === void 0 ? void 0 : opts.include, 'csv'),
-            fields: buildCollectionParam(opts === null || opts === void 0 ? void 0 : opts.fields, 'csv')
-        };
-        return this.post({
-            path: '/record-categories/{recordCategoryId}/children',
-            pathParams,
-            queryParams,
-            bodyParam: nodeBodyCreate,
-            returnType: RecordCategoryChildEntry
-        });
-    }
-    deleteRecordCategory(recordCategoryId) {
-        throwIfNotDefined(recordCategoryId, 'recordCategoryId');
-        const pathParams = {
-            recordCategoryId
-        };
-        return this.delete({
-            path: '/record-categories/{recordCategoryId}',
-            pathParams
-        });
-    }
-    getRecordCategory(recordCategoryId, opts) {
-        throwIfNotDefined(recordCategoryId, 'recordCategoryId');
-        const pathParams = {
-            recordCategoryId
-        };
-        const queryParams = {
-            include: buildCollectionParam(opts === null || opts === void 0 ? void 0 : opts.include, 'csv'),
-            relativePath: opts === null || opts === void 0 ? void 0 : opts.relativePath,
-            fields: buildCollectionParam(opts === null || opts === void 0 ? void 0 : opts.fields, 'csv')
-        };
-        return this.get({
-            path: '/record-categories/{recordCategoryId}',
-            pathParams,
-            queryParams,
-            returnType: RecordCategoryEntry
-        });
-    }
-    listRecordCategoryChildren(recordCategoryId, opts) {
-        throwIfNotDefined(recordCategoryId, 'recordCategoryId');
-        const pathParams = {
-            recordCategoryId
-        };
-        const queryParams = {
-            skipCount: opts === null || opts === void 0 ? void 0 : opts.skipCount,
-            maxItems: opts === null || opts === void 0 ? void 0 : opts.maxItems,
-            where: opts === null || opts === void 0 ? void 0 : opts.where,
-            include: buildCollectionParam(opts === null || opts === void 0 ? void 0 : opts.include, 'csv'),
-            relativePath: opts === null || opts === void 0 ? void 0 : opts.relativePath,
-            includeSource: opts === null || opts === void 0 ? void 0 : opts.includeSource,
-            fields: buildCollectionParam(opts === null || opts === void 0 ? void 0 : opts.fields, 'csv')
-        };
-        return this.get({
-            path: '/record-categories/{recordCategoryId}/children',
-            pathParams,
-            queryParams,
-            returnType: RecordCategoryChildPaging
-        });
-    }
-    updateRecordCategory(recordCategoryId, recordCategoryBodyUpdate, opts) {
-        throwIfNotDefined(recordCategoryId, 'recordCategoryId');
-        throwIfNotDefined(recordCategoryBodyUpdate, 'recordCategoryBodyUpdate');
-        const pathParams = {
-            recordCategoryId
-        };
-        const queryParams = {
-            include: buildCollectionParam(opts === null || opts === void 0 ? void 0 : opts.include, 'csv'),
-            fields: buildCollectionParam(opts === null || opts === void 0 ? void 0 : opts.fields, 'csv')
-        };
-        return this.put({
-            path: '/record-categories/{recordCategoryId}',
-            pathParams,
-            queryParams,
-            bodyParam: recordCategoryBodyUpdate,
-            returnType: RecordCategoryEntry
-        });
-    }
-}
-//# sourceMappingURL=../../../../../../src/api/gs-core-rest-api/api/recordCategories.api.js.map

package/esm2015/src/api/gs-core-rest-api/api/recordCategories.api.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"recordCategories.api.js","sourceRoot":"","sources":["recordCategories.api.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;GAeG;AAIH,OAAO,EAAE,wBAAwB,EAAE,MAAM,mCAAmC,CAAC;AAC7E,OAAO,EAAE,yBAAyB,EAAE,MAAM,oCAAoC,CAAC;AAC/E,OAAO,EAAE,mBAAmB,EAAE,MAAM,8BAA8B,CAAC;AACnE,OAAO,EAAE,OAAO,EAAE,MAAM,YAAY,CAAC;AACrC,OAAO,EAAE,oBAAoB,EAAE,MAAM,4BAA4B,CAAC;AAClE,OAAO,EAAE,iBAAiB,EAAE,MAAM,iBAAiB,CAAC;AAOpD,MAAM,OAAO,mBAAoB,SAAQ,OAAO;IAwG5C,yBAAyB,CACrB,gBAAwB,EACxB,cAAgD,EAChD,IAEuB;QAEvB,iBAAiB,CAAC,gBAAgB,EAAE,kBAAkB,CAAC,CAAC;QACxD,iBAAiB,CAAC,cAAc,EAAE,gBAAgB,CAAC,CAAC;QAEpD,MAAM,UAAU,GAAG;YACf,gBAAgB;SACnB,CAAC;QAEF,MAAM,WAAW,GAAG;YAChB,UAAU,EAAE,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,UAAU;YAC5B,OAAO,EAAE,oBAAoB,CAAC,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,OAAO,EAAE,KAAK,CAAC;YACnD,MAAM,EAAE,oBAAoB,CAAC,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,MAAM,EAAE,KAAK,CAAC;SACpD,CAAC;QAEF,OAAO,IAAI,CAAC,IAAI,CAAC;YACb,IAAI,EAAE,gDAAgD;YACtD,UAAU;YACV,WAAW;YACX,SAAS,EAAE,cAAc;YACzB,UAAU,EAAE,wBAAwB;SACvC,CAAC,CAAC;IACP,CAAC;IAQD,oBAAoB,CAAC,gBAAwB;QACzC,iBAAiB,CAAC,gBAAgB,EAAE,kBAAkB,CAAC,CAAC;QAExD,MAAM,UAAU,GAAG;YACf,gBAAgB;SACnB,CAAC;QAEF,OAAO,IAAI,CAAC,MAAM,CAAC;YACf,IAAI,EAAE,uCAAuC;YAC7C,UAAU;SACb,CAAC,CAAC;IACP,CAAC;IAaD,iBAAiB,CACb,gBAAwB,EACxB,IAEuB;QAEvB,iBAAiB,CAAC,gBAAgB,EAAE,kBAAkB,CAAC,CAAC;QAExD,MAAM,UAAU,GAAG;YACf,gBAAgB;SACnB,CAAC;QAEF,MAAM,WAAW,GAAG;YAChB,OAAO,EAAE,oBAAoB,CAAC,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,OAAO,EAAE,KAAK,CAAC;YACnD,YAAY,EAAE,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,YAAY;YAChC,MAAM,EAAE,oBAAoB,CAAC,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,MAAM,EAAE,KAAK,CAAC;SACpD,CAAC;QAEF,OAAO,IAAI,CAAC,GAAG,CAAC;YACZ,IAAI,EAAE,uCAAuC;YAC7C,UAAU;YACV,WAAW;YACX,UAAU,EAAE,mBAAmB;SAClC,CAAC,CAAC;IACP,CAAC;IAmBD,0BAA0B,CACtB,gBAAwB,EACxB,IAKsB;QAEtB,iBAAiB,CAAC,gBAAgB,EAAE,kBAAkB,CAAC,CAAC;QAExD,MAAM,UAAU,GAAG;YACf,gBAAgB;SACnB,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,KAAK,EAAE,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,KAAK;YAClB,OAAO,EAAE,oBAAoB,CAAC,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,OAAO,EAAE,KAAK,CAAC;YACnD,YAAY,EAAE,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,YAAY;YAChC,aAAa,EAAE,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,aAAa;YAClC,MAAM,EAAE,oBAAoB,CAAC,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,MAAM,EAAE,KAAK,CAAC;SACpD,CAAC;QAEF,OAAO,IAAI,CAAC,GAAG,CAAC;YACZ,IAAI,EAAE,gDAAgD;YACtD,UAAU;YACV,WAAW;YACX,UAAU,EAAE,yBAAyB;SACxC,CAAC,CAAC;IACP,CAAC;IA8BD,oBAAoB,CAAC,gBAAwB,EAAE,wBAAqD,EAAE,IAA0B;QAC5H,iBAAiB,CAAC,gBAAgB,EAAE,kBAAkB,CAAC,CAAC;QACxD,iBAAiB,CAAC,wBAAwB,EAAE,0BAA0B,CAAC,CAAC;QAExE,MAAM,UAAU,GAAG;YACf,gBAAgB;SACnB,CAAC;QAEF,MAAM,WAAW,GAAG;YAChB,OAAO,EAAE,oBAAoB,CAAC,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,OAAO,EAAE,KAAK,CAAC;YACnD,MAAM,EAAE,oBAAoB,CAAC,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,MAAM,EAAE,KAAK,CAAC;SACpD,CAAC;QAEF,OAAO,IAAI,CAAC,GAAG,CAAC;YACZ,IAAI,EAAE,uCAAuC;YAC7C,UAAU;YACV,WAAW;YACX,SAAS,EAAE,wBAAwB;YACnC,UAAU,EAAE,mBAAmB;SAClC,CAAC,CAAC;IACP,CAAC;CACJ","sourcesContent":["/*!\n * @license\n * Copyright © 2005-2023 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 { FilePlanComponentBodyUpdate } from '../model/filePlanComponentBodyUpdate';\nimport { RMNodeBodyCreateWithRelativePath } from '../model/rMNodeBodyCreateWithRelativePath';\nimport { RecordCategoryChildEntry } from '../model/recordCategoryChildEntry';\nimport { RecordCategoryChildPaging } from '../model/recordCategoryChildPaging';\nimport { RecordCategoryEntry } from '../model/recordCategoryEntry';\nimport { BaseApi } from './base.api';\nimport { buildCollectionParam } from '../../../alfrescoApiClient';\nimport { throwIfNotDefined } from '../../../assert';\nimport { RecordsIncludeQuery, RecordsPagingQuery, RecordsSourceQuery } from './types';\n\n/**\n * RecordCategoriesApi service.\n * @module RecordCategoriesApi\n */\nexport class RecordCategoriesApi extends BaseApi {\n    /**\n    * Create a record category or a record folder\n    *\n    * Create a record category or a record folder as a primary child of **recordCategoryId**.\n\nYou can set the **autoRename** boolean field to automatically resolve name clashes. If there is a name clash, then\nthe API method tries to create\na unique name using an integer suffix.\n\nThis API method also supports record category or record folder creation using application/json.\n\nYou must specify at least a **name** and **nodeType**.\n\nYou can create a category like this:\nJSON\n{\n  \\\"name\\\":\\\"My Record Category\\\",\n  \\\"nodeType\\\":\\\"rma:recordCategory\\\"\n}\n\nYou can create a record folder like this:\nJSON\n{\n  \\\"name\\\":\\\"My Record Folder\\\",\n  \\\"nodeType\\\":\\\"rma:recordFolder\\\"\n}\n\nYou can create a record folder inside a container hierarchy (applies to record categories as well):\nJSON\n{\n  \\\"name\\\":\\\"My Fileplan Component\\\",\n  \\\"nodeType\\\":\\\"rma:recordFolder\\\",\n  \\\"relativePath\\\":\\\"X/Y/Z\\\"\n}\n\nThe **relativePath** specifies the container structure to create relative to the node (record category or record folder). Containers in the\n**relativePath** that do not exist are created before the node is created. The container type is decided considering\nthe type of the parent container and the type of the node to be created.\n\nYou can set properties when creating a record category (applies to record folders as well):\nJSON\n{\n  \\\"name\\\":\\\"My Record Category\\\",\n  \\\"nodeType\\\":\\\"rma:recordCategory\\\",\n  \\\"properties\\\":\n  {\n    \\\"rma:vitalRecordIndicator\\\":\\\"true\\\",\n    \\\"rma:reviewPeriod\\\":\\\"month|1\\\"\n  }\n}\n\nAny missing aspects are applied automatically. You can set aspects explicitly, if needed, using an **aspectNames** field.\n\n**Note:** You can create more than one child by\nspecifying a list of nodes in the JSON body. For example, the following JSON\nbody creates a record category and a record folder inside the specified **categoryId**:\nJSON\n[\n  {\n    \\\"name\\\":\\\"My Record Category\\\",\n    \\\"nodeType\\\":\\\"rma:recordCategory\\\"\n  },\n  {\n    \\\"name\\\":\\\"My Record Folder\\\",\n    \\\"nodeType\\\":\\\"rma:recordFolder\\\"\n  }\n]\n\nIf you specify a list as input, then a paginated list rather than an entry is returned in the response body. For example:\n\nJSON\n{\n  \\\"list\\\": {\n    \\\"pagination\\\": {\n      \\\"count\\\": 2,\n      \\\"hasMoreItems\\\": false,\n      \\\"totalItems\\\": 2,\n      \\\"skipCount\\\": 0,\n      \\\"maxItems\\\": 100\n    },\n    \\\"entries\\\": [\n      {\n        \\\"entry\\\": {\n          ...\n        }\n      },\n      {\n        \\\"entry\\\": {\n          ...\n        }\n      }\n    ]\n  }\n}\n\n    *\n    * @param recordCategoryId The identifier of a record category.\n    * @param nodeBodyCreate The node information to create.\n\n    * @param opts Optional parameters\n    * @param opts.autoRename If true, then  a name clash will cause an attempt to auto rename by finding a unique name using an integer suffix.\n    * @return Promise<RecordCategoryChildEntry>\n    */\n    createRecordCategoryChild(\n        recordCategoryId: string,\n        nodeBodyCreate: RMNodeBodyCreateWithRelativePath,\n        opts?: {\n            autoRename?: boolean;\n        } & RecordsIncludeQuery\n    ): Promise<RecordCategoryChildEntry> {\n        throwIfNotDefined(recordCategoryId, 'recordCategoryId');\n        throwIfNotDefined(nodeBodyCreate, 'nodeBodyCreate');\n\n        const pathParams = {\n            recordCategoryId\n        };\n\n        const queryParams = {\n            autoRename: opts?.autoRename,\n            include: buildCollectionParam(opts?.include, 'csv'),\n            fields: buildCollectionParam(opts?.fields, 'csv')\n        };\n\n        return this.post({\n            path: '/record-categories/{recordCategoryId}/children',\n            pathParams,\n            queryParams,\n            bodyParam: nodeBodyCreate,\n            returnType: RecordCategoryChildEntry\n        });\n    }\n\n    /**\n     * Delete a record category\n     *\n     * @param recordCategoryId The identifier of a record category.\n     * @return Promise<{}>\n     */\n    deleteRecordCategory(recordCategoryId: string): Promise<void> {\n        throwIfNotDefined(recordCategoryId, 'recordCategoryId');\n\n        const pathParams = {\n            recordCategoryId\n        };\n\n        return this.delete({\n            path: '/record-categories/{recordCategoryId}',\n            pathParams\n        });\n    }\n\n    /**\n     * Get a record category\n     *\n     * Mandatory fields and the record category's aspects and properties are returned by default.\n     * You can use the **include** parameter (include=allowableOperations) to return additional information.\n     *\n     * @param recordCategoryId The identifier of a record category.\n     * @param opts Optional parameters\n     * @param opts.relativePath Return information on children in the record category resolved by this path. The path is relative to **recordCategoryId**.\n     * @return Promise<RecordCategoryEntry>\n     */\n    getRecordCategory(\n        recordCategoryId: string,\n        opts?: {\n            relativePath?: string;\n        } & RecordsIncludeQuery\n    ): Promise<RecordCategoryEntry> {\n        throwIfNotDefined(recordCategoryId, 'recordCategoryId');\n\n        const pathParams = {\n            recordCategoryId\n        };\n\n        const queryParams = {\n            include: buildCollectionParam(opts?.include, 'csv'),\n            relativePath: opts?.relativePath,\n            fields: buildCollectionParam(opts?.fields, 'csv')\n        };\n\n        return this.get({\n            path: '/record-categories/{recordCategoryId}',\n            pathParams,\n            queryParams,\n            returnType: RecordCategoryEntry\n        });\n    }\n\n    /**\n     * List record category's children\n     *\n     * Minimal information for each child is returned by default.\n     * You can use the **include** parameter (include=allowableOperations) to return additional information.\n     *\n     * The list of child nodes includes primary children and secondary children, if there are any.\n     *\n     * @param recordCategoryId The identifier of a record category.\n     * @param opts Optional parameters\n     * @param opts.where Optionally filter the list. Here are some examples:\n     *   where=(nodeType='rma:recordFolder')\n     *   where=(nodeType='rma:recordCategory')\n     *   where=(isRecordFolder=true AND isClosed=false)\n     * @param opts.relativePath Return information on children in the record category resolved by this path. The path is relative to **recordCategoryId**.\n     * @return Promise<RecordCategoryChildPaging>\n     */\n    listRecordCategoryChildren(\n        recordCategoryId: string,\n        opts?: {\n            where?: string;\n            relativePath?: string;\n        } & RecordsIncludeQuery &\n            RecordsPagingQuery &\n            RecordsSourceQuery\n    ): Promise<RecordCategoryChildPaging> {\n        throwIfNotDefined(recordCategoryId, 'recordCategoryId');\n\n        const pathParams = {\n            recordCategoryId\n        };\n\n        const queryParams = {\n            skipCount: opts?.skipCount,\n            maxItems: opts?.maxItems,\n            where: opts?.where,\n            include: buildCollectionParam(opts?.include, 'csv'),\n            relativePath: opts?.relativePath,\n            includeSource: opts?.includeSource,\n            fields: buildCollectionParam(opts?.fields, 'csv')\n        };\n\n        return this.get({\n            path: '/record-categories/{recordCategoryId}/children',\n            pathParams,\n            queryParams,\n            returnType: RecordCategoryChildPaging\n        });\n    }\n    /**\n        * Update a record category\n        *\n        * Updates record category **recordCategoryId**. For example, you can rename a record category:\n    JSON\n    {\n      \\\"name\\\":\\\"My new name\\\"\n    }\n\n    You can also set or update one or more properties:\n    JSON\n    {\n      \\\"properties\\\":\n        {\n           \\\"rma:vitalRecordIndicator\\\": true,\n           \\\"rma:reviewPeriod\\\":\\\"month|6\\\"\n        }\n    }\n\n    **Note:** If you want to add or remove aspects, then you must use **GET /record-categories/{recordCategoryId}** first to get the complete set of *aspectNames*.\n\n    **Note:** Currently there is no optimistic locking for updates, so they are applied in \\\"last one wins\\\" order.\n\n        *\n        * @param recordCategoryId The identifier of a record category.\n        * @param recordCategoryBodyUpdate The record category information to update.\n        * @param opts Optional parameters\n        * @return Promise<RecordCategoryEntry>\n        */\n    updateRecordCategory(recordCategoryId: string, recordCategoryBodyUpdate: FilePlanComponentBodyUpdate, opts?: RecordsIncludeQuery): Promise<RecordCategoryEntry> {\n        throwIfNotDefined(recordCategoryId, 'recordCategoryId');\n        throwIfNotDefined(recordCategoryBodyUpdate, 'recordCategoryBodyUpdate');\n\n        const pathParams = {\n            recordCategoryId\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: '/record-categories/{recordCategoryId}',\n            pathParams,\n            queryParams,\n            bodyParam: recordCategoryBodyUpdate,\n            returnType: RecordCategoryEntry\n        });\n    }\n}\n"]}

package/esm2015/src/api/gs-core-rest-api/api/recordFolders.api.js

@@ -1,107 +0,0 @@
-/*!
- * @license
- * Copyright © 2005-2023 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.
- */
-import { RecordEntry } from '../model/recordEntry';
-import { RecordFolderAssociationPaging } from '../model/recordFolderAssociationPaging';
-import { RecordFolderEntry } from '../model/recordFolderEntry';
-import { BaseApi } from './base.api';
-import { buildCollectionParam } from '../../../alfrescoApiClient';
-import { throwIfNotDefined } from '../../../assert';
-export class RecordFoldersApi extends BaseApi {
-    createRecordFolderChild(recordFolderId, recordBodyCreate, opts) {
-        throwIfNotDefined(recordFolderId, 'recordFolderId');
-        throwIfNotDefined(recordBodyCreate, 'recordBodyCreate');
-        const pathParams = {
-            recordFolderId
-        };
-        const queryParams = {
-            include: buildCollectionParam(opts === null || opts === void 0 ? void 0 : opts.include, 'csv'),
-            fields: buildCollectionParam(opts === null || opts === void 0 ? void 0 : opts.fields, 'csv')
-        };
-        return this.post({
-            path: '/record-folders/{recordFolderId}/records',
-            pathParams,
-            queryParams,
-            bodyParam: recordBodyCreate,
-            returnType: RecordEntry
-        });
-    }
-    deleteRecordFolder(recordFolderId) {
-        throwIfNotDefined(recordFolderId, 'recordFolderId');
-        const pathParams = {
-            recordFolderId
-        };
-        return this.delete({
-            path: '/record-folders/{recordFolderId}',
-            pathParams
-        });
-    }
-    getRecordFolder(recordFolderId, opts) {
-        throwIfNotDefined(recordFolderId, 'recordFolderId');
-        const pathParams = {
-            recordFolderId
-        };
-        const queryParams = {
-            include: buildCollectionParam(opts === null || opts === void 0 ? void 0 : opts.include, 'csv'),
-            fields: buildCollectionParam(opts === null || opts === void 0 ? void 0 : opts.fields, 'csv')
-        };
-        return this.get({
-            path: '/record-folders/{recordFolderId}',
-            pathParams,
-            queryParams,
-            returnType: RecordFolderEntry
-        });
-    }
-    listRecordFolderChildren(recordFolderId, opts) {
-        throwIfNotDefined(recordFolderId, 'recordFolderId');
-        const pathParams = {
-            recordFolderId
-        };
-        const queryParams = {
-            skipCount: opts === null || opts === void 0 ? void 0 : opts.skipCount,
-            maxItems: opts === null || opts === void 0 ? void 0 : opts.maxItems,
-            where: opts === null || opts === void 0 ? void 0 : opts.where,
-            include: buildCollectionParam(opts === null || opts === void 0 ? void 0 : opts.include, 'csv'),
-            includeSource: opts === null || opts === void 0 ? void 0 : opts.includeSource,
-            fields: buildCollectionParam(opts === null || opts === void 0 ? void 0 : opts.fields, 'csv')
-        };
-        return this.get({
-            path: '/record-folders/{recordFolderId}/records',
-            pathParams,
-            queryParams,
-            returnType: RecordFolderAssociationPaging
-        });
-    }
-    updateRecordFolder(recordFolderId, recordFolderBodyUpdate, opts) {
-        throwIfNotDefined(recordFolderId, 'recordFolderId');
-        throwIfNotDefined(recordFolderBodyUpdate, 'recordFolderBodyUpdate');
-        const pathParams = {
-            recordFolderId
-        };
-        const queryParams = {
-            include: buildCollectionParam(opts === null || opts === void 0 ? void 0 : opts.include, 'csv'),
-            fields: buildCollectionParam(opts === null || opts === void 0 ? void 0 : opts.fields, 'csv')
-        };
-        return this.put({
-            path: '/record-folders/{recordFolderId}',
-            pathParams,
-            queryParams,
-            bodyParam: recordFolderBodyUpdate,
-            returnType: RecordFolderEntry
-        });
-    }
-}
-//# sourceMappingURL=../../../../../../src/api/gs-core-rest-api/api/recordFolders.api.js.map

package/esm2015/src/api/gs-core-rest-api/api/recordFolders.api.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"recordFolders.api.js","sourceRoot":"","sources":["recordFolders.api.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;GAeG;AAIH,OAAO,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAC;AACnD,OAAO,EAAE,6BAA6B,EAAE,MAAM,wCAAwC,CAAC;AACvF,OAAO,EAAE,iBAAiB,EAAE,MAAM,4BAA4B,CAAC;AAC/D,OAAO,EAAE,OAAO,EAAE,MAAM,YAAY,CAAC;AACrC,OAAO,EAAE,oBAAoB,EAAE,MAAM,4BAA4B,CAAC;AAClE,OAAO,EAAE,iBAAiB,EAAE,MAAM,iBAAiB,CAAC;AAOpD,MAAM,OAAO,gBAAiB,SAAQ,OAAO;IA8FzC,uBAAuB,CAAC,cAAsB,EAAE,gBAAkC,EAAE,IAA0B;QAC1G,iBAAiB,CAAC,cAAc,EAAE,gBAAgB,CAAC,CAAC;QACpD,iBAAiB,CAAC,gBAAgB,EAAE,kBAAkB,CAAC,CAAC;QAExD,MAAM,UAAU,GAAG;YACf,cAAc;SACjB,CAAC;QAEF,MAAM,WAAW,GAAG;YAChB,OAAO,EAAE,oBAAoB,CAAC,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,OAAO,EAAE,KAAK,CAAC;YACnD,MAAM,EAAE,oBAAoB,CAAC,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,MAAM,EAAE,KAAK,CAAC;SACpD,CAAC;QAEF,OAAO,IAAI,CAAC,IAAI,CAAC;YACb,IAAI,EAAE,0CAA0C;YAChD,UAAU;YACV,WAAW;YACX,SAAS,EAAE,gBAAgB;YAC3B,UAAU,EAAE,WAAW;SAC1B,CAAC,CAAC;IACP,CAAC;IAUD,kBAAkB,CAAC,cAAsB;QACrC,iBAAiB,CAAC,cAAc,EAAE,gBAAgB,CAAC,CAAC;QAEpD,MAAM,UAAU,GAAG;YACf,cAAc;SACjB,CAAC;QAEF,OAAO,IAAI,CAAC,MAAM,CAAC;YACf,IAAI,EAAE,kCAAkC;YACxC,UAAU;SACb,CAAC,CAAC;IACP,CAAC;IAYD,eAAe,CAAC,cAAsB,EAAE,IAA0B;QAC9D,iBAAiB,CAAC,cAAc,EAAE,gBAAgB,CAAC,CAAC;QAEpD,MAAM,UAAU,GAAG;YACf,cAAc;SACjB,CAAC;QAEF,MAAM,WAAW,GAAG;YAChB,OAAO,EAAE,oBAAoB,CAAC,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,OAAO,EAAE,KAAK,CAAC;YACnD,MAAM,EAAE,oBAAoB,CAAC,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,MAAM,EAAE,KAAK,CAAC;SACpD,CAAC;QAEF,OAAO,IAAI,CAAC,GAAG,CAAC;YACZ,IAAI,EAAE,kCAAkC;YACxC,UAAU;YACV,WAAW;YACX,UAAU,EAAE,iBAAiB;SAChC,CAAC,CAAC;IACP,CAAC;IAqBD,wBAAwB,CACpB,cAAsB,EACtB,IAIsB;QAEtB,iBAAiB,CAAC,cAAc,EAAE,gBAAgB,CAAC,CAAC;QAEpD,MAAM,UAAU,GAAG;YACf,cAAc;SACjB,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,KAAK,EAAE,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,KAAK;YAClB,OAAO,EAAE,oBAAoB,CAAC,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,OAAO,EAAE,KAAK,CAAC;YACnD,aAAa,EAAE,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,aAAa;YAClC,MAAM,EAAE,oBAAoB,CAAC,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,MAAM,EAAE,KAAK,CAAC;SACpD,CAAC;QAEF,OAAO,IAAI,CAAC,GAAG,CAAC;YACZ,IAAI,EAAE,0CAA0C;YAChD,UAAU;YACV,WAAW;YACX,UAAU,EAAE,6BAA6B;SAC5C,CAAC,CAAC;IACP,CAAC;IA8BD,kBAAkB,CAAC,cAAsB,EAAE,sBAAmD,EAAE,IAA0B;QACtH,iBAAiB,CAAC,cAAc,EAAE,gBAAgB,CAAC,CAAC;QACpD,iBAAiB,CAAC,sBAAsB,EAAE,wBAAwB,CAAC,CAAC;QAEpE,MAAM,UAAU,GAAG;YACf,cAAc;SACjB,CAAC;QAEF,MAAM,WAAW,GAAG;YAChB,OAAO,EAAE,oBAAoB,CAAC,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,OAAO,EAAE,KAAK,CAAC;YACnD,MAAM,EAAE,oBAAoB,CAAC,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,MAAM,EAAE,KAAK,CAAC;SACpD,CAAC;QAEF,OAAO,IAAI,CAAC,GAAG,CAAC;YACZ,IAAI,EAAE,kCAAkC;YACxC,UAAU;YACV,WAAW;YACX,SAAS,EAAE,sBAAsB;YACjC,UAAU,EAAE,iBAAiB;SAChC,CAAC,CAAC;IACP,CAAC;CACJ","sourcesContent":["/*!\n * @license\n * Copyright © 2005-2023 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 { FilePlanComponentBodyUpdate } from '../model/filePlanComponentBodyUpdate';\nimport { RMNodeBodyCreate } from '../model/rMNodeBodyCreate';\nimport { RecordEntry } from '../model/recordEntry';\nimport { RecordFolderAssociationPaging } from '../model/recordFolderAssociationPaging';\nimport { RecordFolderEntry } from '../model/recordFolderEntry';\nimport { BaseApi } from './base.api';\nimport { buildCollectionParam } from '../../../alfrescoApiClient';\nimport { throwIfNotDefined } from '../../../assert';\nimport { RecordsIncludeQuery, RecordsPagingQuery, RecordsSourceQuery } from './types';\n\n/**\n * Record Folders service.\n * @module RecordFoldersApi\n */\nexport class RecordFoldersApi extends BaseApi {\n    /**\n    * Create a record\n    *\n    * Create a record as a primary child of **recordFolderId**.\n\nThis endpoint supports both JSON and multipart/form-data (file upload).\n\n**Using multipart/form-data**\n\nUse the **filedata** field to represent the content to upload, for example, the following curl command will\ncreate a node with the contents of test.txt in the test user's home folder.\n\ncurl -utest:test -X POST host:port/alfresco/api/-default-/public/gs/versions/1/record-folders/{recordFolderId}/records -F filedata=@test.txt\n\nThis API method also supports record creation using application/json.\n\nYou must specify at least a **name** and **nodeType**.\n\nYou can create a non-electronic record like this:\nJSON\n{\n  \\\"name\\\":\\\"My Non-electronic Record\\\",\n  \\\"nodeType\\\":\\\"rma:nonElectronicDocument\\\",\n  \\\"properties\\\":\n    {\n      \\\"cm:description\\\":\\\"My Non-electronic Record Description\\\",\n      \\\"cm:title\\\":\\\"My Non-electronic Record Title\\\",\n      \\\"rma:box\\\":\\\"My Non-electronic Record Box\\\",\n      \\\"rma:file\\\":\\\"My Non-electronic Record File\\\",\n      \\\"rma:numberOfCopies\\\":1,\n      \\\"rma:physicalSize\\\":30,\n      \\\"rma:shelf\\\":\\\"My Non-electronic Record Shelf\\\",\n      \\\"rma:storageLocation\\\":\\\"My Non-electronic Record Location\\\"\n    }\n}\n\nYou can create an empty electronic record:\nJSON\n{\n  \\\"name\\\":\\\"My Electronic Record\\\",\n  \\\"nodeType\\\":\\\"cm:content\\\"\n}\n\nAny missing aspects are applied automatically. You can set aspects explicitly, if needed, using an **aspectNames** field.\n\n**Note:** You can create more than one child by\nspecifying a list of nodes in the JSON body. For example, the following JSON\nbody creates a record category and a record folder inside the specified **categoryId**:\nJSON\n[\n  {\n    \\\"name\\\":\\\"Record 1\\\",\n    \\\"nodeType\\\":\\\"cm:content\\\"\n  },\n  {\n    \\\"name\\\":\\\"Record 2\\\",\n    \\\"nodeType\\\":\\\"cm:content\\\"\n  }\n]\n\nIf you specify a list as input, then a paginated list rather than an entry is returned in the response body. For example:\n\nJSON\n{\n  \\\"list\\\": {\n    \\\"pagination\\\": {\n      \\\"count\\\": 2,\n      \\\"hasMoreItems\\\": false,\n      \\\"totalItems\\\": 2,\n      \\\"skipCount\\\": 0,\n      \\\"maxItems\\\": 100\n    },\n    \\\"entries\\\": [\n      {\n        \\\"entry\\\": {\n          ...\n        }\n      },\n      {\n        \\\"entry\\\": {\n          ...\n        }\n      }\n    ]\n  }\n}\n\n    *\n    * @param recordFolderId The identifier of a record folder.\n    * @param recordBodyCreate The record information to create. This field is ignored for multipart/form-data content uploads.\n    * @param opts Optional parameters\n    * @return Promise<RecordEntry>\n    */\n    createRecordFolderChild(recordFolderId: string, recordBodyCreate: RMNodeBodyCreate, opts?: RecordsIncludeQuery): Promise<RecordEntry> {\n        throwIfNotDefined(recordFolderId, 'recordFolderId');\n        throwIfNotDefined(recordBodyCreate, 'recordBodyCreate');\n\n        const pathParams = {\n            recordFolderId\n        };\n\n        const queryParams = {\n            include: buildCollectionParam(opts?.include, 'csv'),\n            fields: buildCollectionParam(opts?.fields, 'csv')\n        };\n\n        return this.post({\n            path: '/record-folders/{recordFolderId}/records',\n            pathParams,\n            queryParams,\n            bodyParam: recordBodyCreate,\n            returnType: RecordEntry\n        });\n    }\n    /**\n        * Delete a record folder\n        *\n        * Deletes record folder **recordFolderId**. Deleted file plan components cannot be recovered, they are deleted permanently.\n\n        *\n        * @param recordFolderId The identifier of a record folder.\n        * @return Promise<{}>\n        */\n    deleteRecordFolder(recordFolderId: string): Promise<void> {\n        throwIfNotDefined(recordFolderId, 'recordFolderId');\n\n        const pathParams = {\n            recordFolderId\n        };\n\n        return this.delete({\n            path: '/record-folders/{recordFolderId}',\n            pathParams\n        });\n    }\n\n    /**\n     * Get a record folder\n     *\n     * Mandatory fields and the record folder's aspects and properties are returned by default.\n     * You can use the **include** parameter (include=allowableOperations) to return additional information.\n     *\n     * @param recordFolderId The identifier of a record folder.\n     * @param opts Optional parameters\n     * @return Promise<RecordFolderEntry>\n     */\n    getRecordFolder(recordFolderId: string, opts?: RecordsIncludeQuery): Promise<RecordFolderEntry> {\n        throwIfNotDefined(recordFolderId, 'recordFolderId');\n\n        const pathParams = {\n            recordFolderId\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: '/record-folders/{recordFolderId}',\n            pathParams,\n            queryParams,\n            returnType: RecordFolderEntry\n        });\n    }\n\n    /**\n     * List records\n     *\n     * Gets a list of records.\n     *\n     * Minimal information for each record is returned by default.\n     *\n     * The list of records includes primary children and secondary children, if there are any.\n     *\n     * You can use the **include** parameter (include=allowableOperations) to return additional information.\n     *\n     * @param recordFolderId The identifier of a record folder.\n     * @param opts Optional parameters\n     * @param opts.where Optionally filter the list. Here are some examples:\n     *   where=(nodeType='my:specialNodeType')\n     *   where=(nodeType='my:specialNodeType INCLUDESUBTYPES')\n     *   where=(isPrimary=true)\n     * @return Promise<RecordFolderAssociationPaging>\n     */\n    listRecordFolderChildren(\n        recordFolderId: string,\n        opts?: {\n            where?: string;\n        } & RecordsPagingQuery &\n            RecordsIncludeQuery &\n            RecordsSourceQuery\n    ): Promise<RecordFolderAssociationPaging> {\n        throwIfNotDefined(recordFolderId, 'recordFolderId');\n\n        const pathParams = {\n            recordFolderId\n        };\n\n        const queryParams = {\n            skipCount: opts?.skipCount,\n            maxItems: opts?.maxItems,\n            where: opts?.where,\n            include: buildCollectionParam(opts?.include, 'csv'),\n            includeSource: opts?.includeSource,\n            fields: buildCollectionParam(opts?.fields, 'csv')\n        };\n\n        return this.get({\n            path: '/record-folders/{recordFolderId}/records',\n            pathParams,\n            queryParams,\n            returnType: RecordFolderAssociationPaging\n        });\n    }\n    /**\n        * Update a record folder\n        *\n        * Updates record folder **recordFolderId**. For example, you can rename a record folder:\n    JSON\n    {\n      \\\"name\\\":\\\"My new name\\\"\n    }\n\n    You can also set or update one or more properties:\n    JSON\n    {\n      \\\"properties\\\":\n        {\n           \\\"rma:vitalRecordIndicator\\\": true,\n           \\\"rma:reviewPeriod\\\":\\\"month|6\\\"\n        }\n    }\n\n    **Note:** if you want to add or remove aspects, then you must use **GET /record-folders/{recordFolderId}** first to get the complete set of *aspectNames*.\n\n    **Note:** Currently there is no optimistic locking for updates, so they are applied in \\\"last one wins\\\" order.\n\n        *\n        * @param recordFolderId The identifier of a record folder.\n        * @param recordFolderBodyUpdate The record folder information to update.\n        * @param opts Optional parameters\n        * @return Promise<RecordFolderEntry>\n        */\n    updateRecordFolder(recordFolderId: string, recordFolderBodyUpdate: FilePlanComponentBodyUpdate, opts?: RecordsIncludeQuery): Promise<RecordFolderEntry> {\n        throwIfNotDefined(recordFolderId, 'recordFolderId');\n        throwIfNotDefined(recordFolderBodyUpdate, 'recordFolderBodyUpdate');\n\n        const pathParams = {\n            recordFolderId\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: '/record-folders/{recordFolderId}',\n            pathParams,\n            queryParams,\n            bodyParam: recordFolderBodyUpdate,\n            returnType: RecordFolderEntry\n        });\n    }\n}\n"]}