@alfresco/js-api 9.1.0-15484232623 → 9.1.0-15488123400

package/typings/src/api/gs-core-rest-api/api/filePlans.api.d.ts

@@ -21,6 +21,7 @@ import { RecordCategoryPaging } from '../model/recordCategoryPaging';
 import { RootCategoryBodyCreate } from '../model/rootCategoryBodyCreate';
 import { BaseApi } from './base.api';
 import { RecordsIncludeQuery, RecordsPagingQuery, RecordsSourceQuery } from './types';
+import { FilePlanRolePaging, FilePlanRoleParameters } from '../model';
 /**
  * FilePlansApi service.
  */
@@ -66,4 +67,11 @@ export declare class FilePlansApi extends BaseApi {
      * @returns Promise<FilePlanEntry>
      */
     updateFilePlan(filePlanId: string, filePlanBodyUpdate: FilePlanBodyUpdate, opts?: RecordsIncludeQuery): Promise<FilePlanEntry>;
+    /**
+     * Gets a list of roles for the specified file plan.
+     * @param filePlanId The identifier of a file plan. You can also use the -filePlan- alias.
+     * @param parameters Optional parameters
+     * @returns Promise<FilePlanEntry>
+     */
+    getFilePlanRoles(filePlanId: string, parameters?: FilePlanRoleParameters): Promise<FilePlanRolePaging>;
 }

package/typings/src/api/gs-core-rest-api/model/filePlanRole.d.ts

@@ -0,0 +1,25 @@
+/*!
+ * @license
+ * Copyright © 2005-2025 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 { FilePlanRoleCapability } from './filePlanRoleCapability';
+export declare class FilePlanRole {
+    displayLabel: string;
+    groupShortName: string;
+    name: string;
+    roleGroupName: string;
+    capabilities: FilePlanRoleCapability[];
+    constructor(input?: Partial<FilePlanRole>);
+}

package/typings/src/api/gs-core-rest-api/model/filePlanRoleCapability.d.ts

@@ -0,0 +1,24 @@
+/*!
+ * @license
+ * Copyright © 2005-2025 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 { FilePlanRoleCapabilityGroup } from './filePlanRoleCapabilityGroup';
+export declare class FilePlanRoleCapability {
+    group: FilePlanRoleCapabilityGroup;
+    index: number;
+    name: string;
+    title: string;
+    constructor(input?: Partial<FilePlanRoleCapability>);
+}

package/typings/src/api/gs-core-rest-api/model/filePlanRoleCapabilityGroup.d.ts

@@ -0,0 +1,21 @@
+/*!
+ * @license
+ * Copyright © 2005-2025 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 declare class FilePlanRoleCapabilityGroup {
+    id: string;
+    title: string;
+    constructor(input?: Partial<FilePlanRoleCapabilityGroup>);
+}

package/typings/src/api/gs-core-rest-api/model/filePlanRoleEntry.d.ts

@@ -0,0 +1,21 @@
+/*!
+ * @license
+ * Copyright © 2005-2025 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 { FilePlanRole } from './filePlanRole';
+export declare class FilePlanRoleEntry {
+    entry: FilePlanRole;
+    constructor(input?: Partial<FilePlanRoleEntry>);
+}

package/typings/src/api/gs-core-rest-api/model/filePlanRolePaging.d.ts

@@ -0,0 +1,21 @@
+/*!
+ * @license
+ * Copyright © 2005-2025 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 { FilePlanRolePagingList } from './filePlanRolePagingList';
+export declare class FilePlanRolePaging {
+    list: FilePlanRolePagingList;
+    constructor(input: Partial<FilePlanRolePaging>);
+}

package/typings/src/api/gs-core-rest-api/model/filePlanRolePagingList.d.ts

@@ -0,0 +1,23 @@
+/*!
+ * @license
+ * Copyright © 2005-2025 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 { Pagination } from '../../content-rest-api';
+import { FilePlanRoleEntry } from './filePlanRoleEntry';
+export declare class FilePlanRolePagingList {
+    entries: FilePlanRoleEntry[];
+    pagination: Pagination;
+    constructor(input: Partial<FilePlanRolePagingList>);
+}

package/typings/src/api/gs-core-rest-api/model/filePlanRoleParameters.d.ts

@@ -0,0 +1,20 @@
+/*!
+ * @license
+ * Copyright © 2005-2025 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 { FilePlanRoleParametersWhere } from './filePlanRoleParametersWhere';
+export interface FilePlanRoleParameters {
+    where?: FilePlanRoleParametersWhere;
+}

package/typings/src/api/gs-core-rest-api/model/filePlanRoleParametersWhere.d.ts

@@ -0,0 +1,19 @@
+/*!
+ * @license
+ * Copyright © 2005-2025 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 interface FilePlanRoleParametersWhere {
+    capabilityNames?: string[];
+}

package/typings/src/api/gs-core-rest-api/model/index.d.ts

@@ -18,6 +18,14 @@ export * from './filePlan';
 export * from './filePlanBodyUpdate';
 export * from './filePlanComponentBodyUpdate';
 export * from './filePlanEntry';
+export * from './filePlanRole';
+export * from './filePlanRoleCapability';
+export * from './filePlanRoleCapabilityGroup';
+export * from './filePlanRoleEntry';
+export * from './filePlanRolePaging';
+export * from './filePlanRolePagingList';
+export * from './filePlanRoleParameters';
+export * from './filePlanRoleParametersWhere';
 export * from './rMNodeBodyCreate';
 export * from './rMNodeBodyCreateWithRelativePath';
 export * from './rMSite';