@icure/cardinal-sdk 2.4.3 → 2.5.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/api/RoleApi.d.mts CHANGED
@@ -36,26 +36,28 @@ export interface RoleApi {
36
36
  /**
37
37
  *
38
38
  * Creates a new role.
39
- * @param name the [Role.name].
39
+ * @param name the [Role.name]. It can only contain uppercase characters A->Z, underscores and cannot be longer than 40 characters.
40
40
  * @param permissions the set of permissions that this role will grant.
41
+ * @param description a short description (max 300 characters) for the role.
41
42
  * @param inheritsUpTo the maximum level in the downward group hierarchy where this role can be accessed (null = any child group at
42
43
  * any level, 0 = only the current group can access this role, 1 = only this group and children groups can access this role, etc...)
43
44
  * @return the created role.
44
45
  */
45
- createRole(name: string, permissions: Array<string>, options?: {
46
+ createRole(name: string, permissions: Array<string>, description: string | undefined, options?: {
46
47
  inheritsUpTo?: number | undefined;
47
48
  }): Promise<Role>;
48
49
  /**
49
50
  *
50
51
  * Creates a new role in a specific group.
51
52
  * @param groupId the id of the group.
52
- * @param name the [Role.name].
53
+ * @param name the [Role.name]. It can only contain uppercase characters A->Z, underscores and cannot be longer than 40 characters.
54
+ * @param description a short description (max 300 characters) for the role.
53
55
  * @param permissions the set of permissions that this role will grant.
54
56
  * @param inheritsUpTo the maximum level in the downward group hierarchy where this role can be accessed (null = any child group at
55
57
  * any level, 0 = only the current group can access this role, 1 = only this group and children groups can access this role, etc...)
56
58
  * @return the created role.
57
59
  */
58
- createRoleInGroup(groupId: string, name: string, permissions: Array<string>, options?: {
60
+ createRoleInGroup(groupId: string, name: string, permissions: Array<string>, description: string | undefined, options?: {
59
61
  inheritsUpTo?: number | undefined;
60
62
  }): Promise<Role>;
61
63
  /**