@inweb/client/src/Api/IRole.ts

JavaScript REST API client for the Open Cloud Server

///////////////////////////////////////////////////////////////////////////////
// Copyright (C) 2002-2025, Open Design Alliance (the "Alliance").
// All rights reserved.
//
// This software and its documentation and related materials are owned by
// the Alliance. The software may only be incorporated into application
// programs owned by members of the Alliance, subject to a signed
// Membership Agreement and Supplemental Software License Agreement with the
// Alliance. The structure and organization of this software are the valuable
// trade secrets of the Alliance and its suppliers. The software is also
// protected by copyright law and international treaty provisions. Application
// programs incorporating this software must include the following statement
// with their copyright notices:
//
//   This application incorporates Open Design Alliance software pursuant to a
//   license agreement with Open Design Alliance.
//   Open Design Alliance Copyright (C) 2002-2025 by Open Design Alliance.
//   All rights reserved.
//
// By use of this software, its documentation or related materials, you
// acknowledge and accept the above terms.
///////////////////////////////////////////////////////////////////////////////

/**
 * Defines the {@link Role | role} actions are allowed to be performed.
 */
export interface IRoleActions {
  /**
   * Defines what actions are allowed to be performed at the project level. The available actions
   * include:
   *
   * - `update` - The ability to update the project details.
   * - `createTopic` - The ability to create a new topic.
   * - `createDocument` - The ability to create a new document.
   */
  projectActions?: string[];

  /**
   * Defines what actions are allowed to be performed at the topic level. The available actions include:
   *
   * - `update` - The ability to update the topic.
   * - `updateBimSnippet` - The ability to update the BIM snippet for topics.
   * - `updateRelatedTopics` - The ability to update the collection of related topics.
   * - `updateDocumentReferences` - The ability to update the collection of document references.
   * - `updateFiles` - The ability to update the file header.
   * - `createComment` - The ability to create a comment.
   * - `createViewpoint` - The ability to create a new viewpoint.
   */
  topicActions?: string[];

  /**
   * Defines what actions are allowed to be performed at the comment level. The available actions
   * include:
   *
   * - `update` - The ability to update the comment.
   * - `delete` - The ability to delete the comment.
   */
  commentActions?: string[];

  /**
   * Defines what actions are allowed to be performed at the viewpoint level. The available actions
   * include:
   *
   * - `update` - The ability to update the viewpoint.
   * - `delete` - The ability to delete the viewpoint.
   */
  viewpointActions?: string[];

  /**
   * Defines what actions are allowed to be performed at the groups level. The available actions include:
   *
   * - `create` - The ability to create the group.
   * - `update` - The ability to update the group.
   * - `updateUser` - The ability to add users to the group.
   * - `delete` - The ability to delete the group.
   */

  odaGroupActions?: string[];

  /**
   * Defines what actions are allowed to be performed at the roles level. The available actions include:
   *
   * - `create` - The ability to create the role.
   * - `update` - The ability to update the role.
   * - `delete` - The ability to delete the role.
   */
  odaRoleActions?: string[];
}