@itwin/access-control-client 3.6.0 → 4.0.0

package/lib/esm/accessControlTypes.d.ts

@@ -1,229 +0,0 @@
-/** @packageDocumentation
- * @module AccessControlClient
- */
-import type { AccessToken } from "@itwin/core-bentley";
-export interface IAccessControlClient {
-    permissions: IPermissionsClient;
-    roles: IRolesClient;
-    groups: IGroupsClient;
-    userMembers: IUserMembersClient;
-    groupMembers: IGroupMembersClient;
-    ownerMembers: IOwnerMembersClient;
-    memberInvitations: IMemberInvitationsClient;
-    itwinJobs: IITwinJobsClient;
-}
-export interface IPermissionsClient {
-    /** Retrieves the list of all available permissions **/
-    getPermissionsAsync(accessToken: AccessToken): Promise<AccessControlAPIResponse<Permission[]>>;
-    /** Retrieves a list of permissions the identity has for a specified iTwin */
-    getITwinPermissionsAsync(accessToken: AccessToken, iTwinId: string): Promise<AccessControlAPIResponse<Permission[]>>;
-}
-export interface IUserMembersClient {
-    /** Retrieves a list of user members and their roles assigned to a specified iTwin. */
-    queryITwinUserMembersAsync(accessToken: AccessToken, iTwinId: string, arg?: AccessControlQueryArg): Promise<AccessControlAPIResponse<UserMember[]>>;
-    /** Retrieves a specific user member for a specified iTwin. */
-    getITwinUserMemberAsync(accessToken: AccessToken, iTwinId: string, memberId: string): Promise<AccessControlAPIResponse<UserMember>>;
-    /** Add or invite new iTwin user members */
-    addITwinUserMembersAsync(accessToken: AccessToken, iTwinId: string, newMembers: AddUserMember[], customMessage?: string): Promise<AccessControlAPIResponse<AddUserMemberResponse>>;
-    /**  Remove the specified iTwin user member */
-    removeITwinUserMemberAsync(accessToken: AccessToken, iTwinId: string, memberId: string): Promise<AccessControlAPIResponse<undefined>>;
-    /**  Update iTwin user member roles */
-    updateITwinUserMemberAsync(accessToken: AccessToken, iTwinId: string, memberId: string, roleIds: string[]): Promise<AccessControlAPIResponse<UserMember>>;
-}
-export interface IOwnerMembersClient {
-    /** Retrieves a list of owner members on a specified iTwin. */
-    queryITwinOwnerMembersAsync(accessToken: AccessToken, iTwinId: string, arg?: AccessControlQueryArg): Promise<AccessControlAPIResponse<OwnerMember[]>>;
-    /** Add or invite new iTwin owner member */
-    addITwinOwnerMemberAsync(accessToken: AccessToken, iTwinId: string, newMember: OwnerMember): Promise<AccessControlAPIResponse<AddOwnerMemberResponse>>;
-    /**  Remove the specified iTwin owner member */
-    removeITwinOwnerMemberAsync(accessToken: AccessToken, iTwinId: string, memberId: string): Promise<AccessControlAPIResponse<undefined>>;
-}
-export interface IGroupMembersClient {
-    /** Retrieves a list of group members and their roles assigned to a specified iTwin. */
-    queryITwinGroupMembersAsync(accessToken: AccessToken, iTwinId: string, arg?: AccessControlQueryArg): Promise<AccessControlAPIResponse<GroupMember[]>>;
-    /** Retrieves a specific group member for a specified iTwin. */
-    getITwinGroupMemberAsync(accessToken: AccessToken, iTwinId: string, memberId: string): Promise<AccessControlAPIResponse<GroupMember>>;
-    /** Add new iTwin group members */
-    addITwinGroupMembersAsync(accessToken: AccessToken, iTwinId: string, newMembers: AddGroupMember[]): Promise<AccessControlAPIResponse<GroupMember[]>>;
-    /**  Remove the specified iTwin group member */
-    removeITwinGroupMemberAsync(accessToken: AccessToken, iTwinId: string, memberId: string): Promise<AccessControlAPIResponse<undefined>>;
-    /**  Update iTwin group member roles */
-    updateITwinGroupMemberAsync(accessToken: AccessToken, iTwinId: string, memberId: string, roleIds: string[]): Promise<AccessControlAPIResponse<GroupMember>>;
-}
-export interface IRolesClient {
-    /** Retrieves a list of roles the for a specified iTwin */
-    getITwinRolesAsync(accessToken: AccessToken, iTwinId: string, additionalHeaders?: {
-        [key: string]: string;
-    }): Promise<AccessControlAPIResponse<Role[]>>;
-    /** Retrieves a role for a specified iTwin */
-    getITwinRoleAsync(accessToken: AccessToken, iTwinId: string, roleId: string): Promise<AccessControlAPIResponse<Role>>;
-    /** Creates a new iTwin Role */
-    createITwinRoleAsync(accessToken: AccessToken, iTwinId: string, role: Role): Promise<AccessControlAPIResponse<Role>>;
-    /** Removes an existing iTwin Role */
-    deleteITwinRoleAsync(accessToken: AccessToken, iTwinId: string, roleId: string): Promise<AccessControlAPIResponse<undefined>>;
-    /** Updates an existing iTwin Role */
-    updateITwinRoleAsync(accessToken: AccessToken, iTwinId: string, roleId: string, role: Role): Promise<AccessControlAPIResponse<Role>>;
-}
-export interface IGroupsClient {
-    /** Retrieves a list of groups the for a specified iTwin */
-    getITwinGroupsAsync(accessToken: AccessToken, iTwinId: string, additionalHeaders?: {
-        [key: string]: string;
-    }): Promise<AccessControlAPIResponse<Group[]>>;
-    /** Retrieves a group for a specified iTwin */
-    getITwinGroupAsync(accessToken: AccessToken, iTwinId: string, groupId: string): Promise<AccessControlAPIResponse<Group>>;
-    /** Creates a new iTwin group */
-    createITwinGroupAsync(accessToken: AccessToken, iTwinId: string, group: Group): Promise<AccessControlAPIResponse<Group>>;
-    /** Removes an existing iTwin group */
-    deleteITwinGroupAsync(accessToken: AccessToken, iTwinId: string, groupId: string): Promise<AccessControlAPIResponse<undefined>>;
-    /** Updates an existing iTwin group */
-    updateITwinGroupAsync(accessToken: AccessToken, iTwinId: string, groupId: string, group: GroupUpdate): Promise<AccessControlAPIResponse<Group>>;
-}
-export interface IMemberInvitationsClient {
-    /** Retrieves a list of member invitations. */
-    queryITwinMemberInvitationsAsync(accessToken: AccessToken, iTwinId: string, arg?: AccessControlQueryArg): Promise<AccessControlAPIResponse<MemberInvitation[]>>;
-    /** Removes an existing member invitation. */
-    deleteITwinMemberInvitationAsync(accessToken: AccessToken, iTwinId: string, invitationId: string): Promise<AccessControlAPIResponse<undefined>>;
-}
-export interface IITwinJobsClient {
-    /** Creates a new iTwin Job */
-    createITwinJobAsync(accessToken: AccessToken, iTwinId: string, iTwinJobActions: ITwinJobActions): Promise<AccessControlAPIResponse<ITwinJob>>;
-    /** Gets an iTwin Job. To see errors, pass in the `representation` result mode. */
-    getITwinJobAsync(accessToken: AccessToken, iTwinId: string, iTwinJobId?: string, resultMode?: AccessControlResultMode): Promise<AccessControlAPIResponse<ITwinJob>>;
-    /** Gets the iTwin Job Actions for a specified iTwin Job. */
-    getITwinJobActionsAsync(accessToken: AccessToken, iTwinId: string, iTwinJobId?: string): Promise<AccessControlAPIResponse<ITwinJobActions>>;
-}
-/**
- * Optional result mode. Minimal is the default, representation returns extra properties
- */
-export declare type AccessControlResultMode = "minimal" | "representation";
-export interface AccessControlQueryArg {
-    top?: number;
-    skip?: number;
-    resultMode?: AccessControlResultMode;
-}
-export interface AccessControlAPIResponse<T> {
-    data?: T;
-    status: number;
-    error?: Error;
-    headers: {
-        [key: string]: any;
-    };
-}
-export interface Error {
-    code: string;
-    message: string;
-    details?: ErrorDetail[];
-    target?: string;
-}
-export interface ErrorDetail {
-    code: string;
-    message: string;
-    target?: string;
-}
-export interface AddOwnerMemberResponse {
-    member?: OwnerMember;
-    invitation?: MemberInvitation;
-}
-export interface AddUserMemberResponse {
-    members: UserMember[];
-    invitations: MemberInvitation[];
-}
-export declare type Permission = string;
-export interface UserMember {
-    id?: string;
-    email?: string;
-    givenName?: string;
-    surname?: string;
-    organization?: string;
-    roles?: Omit<Role, "permissions">[];
-}
-export interface AddUserMember {
-    roleIds: string[];
-    email: string;
-}
-export interface OwnerMember {
-    id?: string;
-    email?: string;
-    givenName?: string;
-    surname?: string;
-    organization?: string;
-}
-export interface GroupMember {
-    id?: string;
-    groupName?: string;
-    groupDescription?: string;
-    roles?: Omit<Role, "permissions">[];
-    imsGroupsCount?: number;
-    membersCount?: number;
-}
-export interface AddGroupMember {
-    groupId: string;
-    roleIds: string[];
-}
-export interface Role {
-    id?: string;
-    displayName: string;
-    description: string;
-    permissions: Permission[];
-}
-export interface Group {
-    id?: string;
-    name?: string;
-    description?: string;
-    members?: GroupUser[];
-    imsGroups?: string[];
-    imsGroupsCount?: number;
-    membersCount?: number;
-}
-export interface GroupUser {
-    id?: string;
-    email?: string;
-    givenName?: string;
-    surname?: string;
-    organization?: string;
-}
-export interface GroupUpdate {
-    id?: string;
-    name?: string;
-    description?: string;
-    members?: string[];
-    imsGroups?: string[];
-}
-export interface MemberInvitation {
-    id: string;
-    email: string;
-    invitedByEmail: string;
-    status: MemberInvitationStatus;
-    createdDate: string;
-    expirationDate: string;
-    roles?: Omit<Role, "permissions" | "description">[];
-}
-export declare enum MemberInvitationStatus {
-    Pending = "Pending",
-    Accepted = "Accepted"
-}
-export declare enum ITwinJobStatus {
-    Active = "Active",
-    Complete = "Completed",
-    PartialCompleted = "PartialCompleted",
-    Failed = "Failed"
-}
-/** Contains extra properties with "representation" result mode.
- */
-export interface ITwinJob {
-    id: string;
-    itwinId: string;
-    status: ITwinJobStatus;
-    error?: ErrorDetail[];
-}
-export interface ITwinJobActions {
-    assignRoles?: ITwinJobAction[];
-    unassignRoles?: ITwinJobAction[];
-    removeMembers?: Omit<ITwinJobAction, "roleIds">[];
-    options?: any;
-}
-export interface ITwinJobAction {
-    email: string;
-    roleIds: string[];
-}
-//# sourceMappingURL=accessControlTypes.d.ts.map

package/lib/esm/accessControlTypes.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"accessControlTypes.d.ts","sourceRoot":"","sources":["../../src/accessControlTypes.ts"],"names":[],"mappings":"AAKA;;GAEG;AAEH,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAC;AAIvD,MAAM,WAAW,oBAAoB;IACnC,WAAW,EAAE,kBAAkB,CAAC;IAChC,KAAK,EAAE,YAAY,CAAC;IACpB,MAAM,EAAE,aAAa,CAAC;IACtB,WAAW,EAAE,kBAAkB,CAAC;IAChC,YAAY,EAAE,mBAAmB,CAAC;IAClC,YAAY,EAAE,mBAAmB,CAAC;IAClC,iBAAiB,EAAE,wBAAwB,CAAC;IAC5C,SAAS,EAAE,gBAAgB,CAAC;CAC7B;AAED,MAAM,WAAW,kBAAkB;IACjC,uDAAuD;IACvD,mBAAmB,CACjB,WAAW,EAAE,WAAW,GACvB,OAAO,CAAC,wBAAwB,CAAC,UAAU,EAAE,CAAC,CAAC,CAAC;IAEnD,6EAA6E;IAC7E,wBAAwB,CACtB,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,MAAM,GACd,OAAO,CAAC,wBAAwB,CAAC,UAAU,EAAE,CAAC,CAAC,CAAC;CACpD;AAED,MAAM,WAAW,kBAAkB;IACjC,sFAAsF;IACtF,0BAA0B,CACxB,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,MAAM,EACf,GAAG,CAAC,EAAE,qBAAqB,GAC1B,OAAO,CAAC,wBAAwB,CAAC,UAAU,EAAE,CAAC,CAAC,CAAC;IAEnD,8DAA8D;IAC9D,uBAAuB,CACrB,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,MAAM,EACf,QAAQ,EAAE,MAAM,GACf,OAAO,CAAC,wBAAwB,CAAC,UAAU,CAAC,CAAC,CAAC;IAEjD,2CAA2C;IAC3C,wBAAwB,CACtB,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,MAAM,EACf,UAAU,EAAE,aAAa,EAAE,EAC3B,aAAa,CAAC,EAAE,MAAM,GACrB,OAAO,CAAC,wBAAwB,CAAC,qBAAqB,CAAC,CAAC,CAAC;IAE5D,8CAA8C;IAC9C,0BAA0B,CACxB,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,MAAM,EACf,QAAQ,EAAE,MAAM,GACf,OAAO,CAAC,wBAAwB,CAAC,SAAS,CAAC,CAAC,CAAC;IAEhD,sCAAsC;IACtC,0BAA0B,CACxB,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,MAAM,EACf,QAAQ,EAAE,MAAM,EAChB,OAAO,EAAE,MAAM,EAAE,GAChB,OAAO,CAAC,wBAAwB,CAAC,UAAU,CAAC,CAAC,CAAC;CAClD;AAED,MAAM,WAAW,mBAAmB;IAClC,8DAA8D;IAC9D,2BAA2B,CACzB,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,MAAM,EACf,GAAG,CAAC,EAAE,qBAAqB,GAC1B,OAAO,CAAC,wBAAwB,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC;IAEpD,2CAA2C;IAC3C,wBAAwB,CACtB,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,MAAM,EACf,SAAS,EAAE,WAAW,GACrB,OAAO,CAAC,wBAAwB,CAAC,sBAAsB,CAAC,CAAC,CAAC;IAE7D,+CAA+C;IAC/C,2BAA2B,CACzB,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,MAAM,EACf,QAAQ,EAAE,MAAM,GACf,OAAO,CAAC,wBAAwB,CAAC,SAAS,CAAC,CAAC,CAAC;CACjD;AAED,MAAM,WAAW,mBAAmB;IAClC,uFAAuF;IACvF,2BAA2B,CACzB,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,MAAM,EACf,GAAG,CAAC,EAAE,qBAAqB,GAC1B,OAAO,CAAC,wBAAwB,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC;IAEpD,+DAA+D;IAC/D,wBAAwB,CACtB,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,MAAM,EACf,QAAQ,EAAE,MAAM,GACf,OAAO,CAAC,wBAAwB,CAAC,WAAW,CAAC,CAAC,CAAC;IAElD,kCAAkC;IAClC,yBAAyB,CACvB,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,MAAM,EACf,UAAU,EAAE,cAAc,EAAE,GAC3B,OAAO,CAAC,wBAAwB,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC;IAEpD,+CAA+C;IAC/C,2BAA2B,CACzB,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,MAAM,EACf,QAAQ,EAAE,MAAM,GACf,OAAO,CAAC,wBAAwB,CAAC,SAAS,CAAC,CAAC,CAAC;IAEhD,uCAAuC;IACvC,2BAA2B,CACzB,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,MAAM,EACf,QAAQ,EAAE,MAAM,EAChB,OAAO,EAAE,MAAM,EAAE,GAChB,OAAO,CAAC,wBAAwB,CAAC,WAAW,CAAC,CAAC,CAAC;CACnD;AAED,MAAM,WAAW,YAAY;IAC3B,0DAA0D;IAC1D,kBAAkB,CAChB,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,MAAM,EACf,iBAAiB,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,GAC5C,OAAO,CAAC,wBAAwB,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC;IAE7C,6CAA6C;IAC7C,iBAAiB,CACf,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,MAAM,EACf,MAAM,EAAE,MAAM,GACb,OAAO,CAAC,wBAAwB,CAAC,IAAI,CAAC,CAAC,CAAC;IAE3C,+BAA+B;IAC/B,oBAAoB,CAClB,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,MAAM,EACf,IAAI,EAAE,IAAI,GACT,OAAO,CAAC,wBAAwB,CAAC,IAAI,CAAC,CAAC,CAAC;IAE3C,qCAAqC;IACrC,oBAAoB,CAClB,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,MAAM,EACf,MAAM,EAAE,MAAM,GACb,OAAO,CAAC,wBAAwB,CAAC,SAAS,CAAC,CAAC,CAAC;IAEhD,qCAAqC;IACrC,oBAAoB,CAClB,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,MAAM,EACf,MAAM,EAAE,MAAM,EACd,IAAI,EAAE,IAAI,GACT,OAAO,CAAC,wBAAwB,CAAC,IAAI,CAAC,CAAC,CAAC;CAC5C;AAED,MAAM,WAAW,aAAa;IAC5B,2DAA2D;IAC3D,mBAAmB,CACjB,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,MAAM,EACf,iBAAiB,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,GAC5C,OAAO,CAAC,wBAAwB,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;IAE9C,8CAA8C;IAC9C,kBAAkB,CAChB,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,MAAM,EACf,OAAO,EAAE,MAAM,GACd,OAAO,CAAC,wBAAwB,CAAC,KAAK,CAAC,CAAC,CAAC;IAE5C,gCAAgC;IAChC,qBAAqB,CACnB,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,MAAM,EACf,KAAK,EAAE,KAAK,GACX,OAAO,CAAC,wBAAwB,CAAC,KAAK,CAAC,CAAC,CAAC;IAE5C,sCAAsC;IACtC,qBAAqB,CACnB,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,MAAM,EACf,OAAO,EAAE,MAAM,GACd,OAAO,CAAC,wBAAwB,CAAC,SAAS,CAAC,CAAC,CAAC;IAEhD,sCAAsC;IACtC,qBAAqB,CACnB,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,MAAM,EACf,OAAO,EAAE,MAAM,EACf,KAAK,EAAE,WAAW,GACjB,OAAO,CAAC,wBAAwB,CAAC,KAAK,CAAC,CAAC,CAAC;CAC7C;AAED,MAAM,WAAW,wBAAwB;IACvC,8CAA8C;IAC9C,gCAAgC,CAC9B,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,MAAM,EACf,GAAG,CAAC,EAAE,qBAAqB,GAC1B,OAAO,CAAC,wBAAwB,CAAC,gBAAgB,EAAE,CAAC,CAAC,CAAC;IAEzD,6CAA6C;IAC7C,gCAAgC,CAC9B,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,MAAM,EACf,YAAY,EAAE,MAAM,GACnB,OAAO,CAAC,wBAAwB,CAAC,SAAS,CAAC,CAAC,CAAC;CACjD;AAED,MAAM,WAAW,gBAAgB;IAC/B,8BAA8B;IAC9B,mBAAmB,CACjB,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,MAAM,EACf,eAAe,EAAE,eAAe,GAC/B,OAAO,CAAC,wBAAwB,CAAC,QAAQ,CAAC,CAAC,CAAC;IAE/C,kFAAkF;IAClF,gBAAgB,CACd,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,MAAM,EACf,UAAU,CAAC,EAAE,MAAM,EACnB,UAAU,CAAC,EAAE,uBAAuB,GACnC,OAAO,CAAC,wBAAwB,CAAC,QAAQ,CAAC,CAAC,CAAC;IAE/C,4DAA4D;IAC5D,uBAAuB,CACrB,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,MAAM,EACf,UAAU,CAAC,EAAE,MAAM,GAClB,OAAO,CAAC,wBAAwB,CAAC,eAAe,CAAC,CAAC,CAAC;CACvD;AAMD;;GAEG;AACH,oBAAY,uBAAuB,GAAG,SAAS,GAAG,gBAAgB,CAAC;AAEnE,MAAM,WAAW,qBAAqB;IACpC,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,UAAU,CAAC,EAAE,uBAAuB,CAAC;CACtC;AAED,MAAM,WAAW,wBAAwB,CAAC,CAAC;IACzC,IAAI,CAAC,EAAE,CAAC,CAAC;IACT,MAAM,EAAE,MAAM,CAAC;IACf,KAAK,CAAC,EAAE,KAAK,CAAC;IACd,OAAO,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;KAAE,CAAC;CACjC;AAED,MAAM,WAAW,KAAK;IACpB,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,CAAC,EAAE,WAAW,EAAE,CAAC;IACxB,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,WAAW;IAC1B,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAMD,MAAM,WAAW,sBAAsB;IACrC,MAAM,CAAC,EAAE,WAAW,CAAC;IACrB,UAAU,CAAC,EAAE,gBAAgB,CAAC;CAC/B;AAED,MAAM,WAAW,qBAAqB;IACpC,OAAO,EAAE,UAAU,EAAE,CAAC;IACtB,WAAW,EAAE,gBAAgB,EAAE,CAAC;CACjC;AAMD,oBAAY,UAAU,GAAG,MAAM,CAAC;AAEhC,MAAM,WAAW,UAAU;IACzB,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,KAAK,CAAC,EAAE,IAAI,CAAC,IAAI,EAAE,aAAa,CAAC,EAAE,CAAC;CACrC;AAED,MAAM,WAAW,aAAa;IAC5B,OAAO,EAAE,MAAM,EAAE,CAAC;IAClB,KAAK,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,WAAW;IAC1B,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAED,MAAM,WAAW,WAAW;IAC1B,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,KAAK,CAAC,EAAE,IAAI,CAAC,IAAI,EAAE,aAAa,CAAC,EAAE,CAAC;IACpC,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAED,MAAM,WAAW,cAAc;IAC7B,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,MAAM,EAAE,CAAC;CACnB;AAED,MAAM,WAAW,IAAI;IACnB,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,WAAW,EAAE,MAAM,CAAC;IACpB,WAAW,EAAE,MAAM,CAAC;IACpB,WAAW,EAAE,UAAU,EAAE,CAAC;CAC3B;AAED,MAAM,WAAW,KAAK;IACpB,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,OAAO,CAAC,EAAE,SAAS,EAAE,CAAC;IACtB,SAAS,CAAC,EAAE,MAAM,EAAE,CAAC;IACrB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAED,MAAM,WAAW,SAAS;IACxB,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAED,MAAM,WAAW,WAAW;IAC1B,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;IACnB,SAAS,CAAC,EAAE,MAAM,EAAE,CAAC;CACtB;AAED,MAAM,WAAW,gBAAgB;IAC/B,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE,MAAM,CAAC;IACd,cAAc,EAAE,MAAM,CAAC;IACvB,MAAM,EAAE,sBAAsB,CAAC;IAC/B,WAAW,EAAE,MAAM,CAAC;IACpB,cAAc,EAAE,MAAM,CAAC;IACvB,KAAK,CAAC,EAAE,IAAI,CAAC,IAAI,EAAE,aAAa,GAAC,aAAa,CAAC,EAAE,CAAC;CACnD;AAED,oBAAY,sBAAsB;IAChC,OAAO,YAAY;IACnB,QAAQ,aAAa;CACtB;AAED,oBAAY,cAAc;IACxB,MAAM,WAAW;IACjB,QAAQ,cAAc;IACtB,gBAAgB,qBAAqB;IACrC,MAAM,WAAW;CAClB;AAED;GACG;AACH,MAAM,WAAW,QAAQ;IACvB,EAAE,EAAE,MAAM,CAAC;IACX,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,EAAE,cAAc,CAAC;IAGvB,KAAK,CAAC,EAAE,WAAW,EAAE,CAAC;CACvB;AAED,MAAM,WAAW,eAAe;IAC9B,WAAW,CAAC,EAAE,cAAc,EAAE,CAAC;IAC/B,aAAa,CAAC,EAAE,cAAc,EAAE,CAAC;IACjC,aAAa,CAAC,EAAE,IAAI,CAAC,cAAc,EAAE,SAAS,CAAC,EAAE,CAAC;IAClD,OAAO,CAAC,EAAE,GAAG,CAAC;CACf;AAED,MAAM,WAAW,cAAc;IAC7B,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,EAAE,MAAM,EAAE,CAAC;CACnB"}

package/lib/esm/accessControlTypes.js

@@ -1,22 +0,0 @@
-/* eslint-disable spaced-comment */
-/*---------------------------------------------------------------------------------------------
- * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
- * See LICENSE.md in the project root for license terms and full copyright notice.
- *--------------------------------------------------------------------------------------------*/
-/** @packageDocumentation
- * @module AccessControlClient
- */
-export var MemberInvitationStatus;
-(function (MemberInvitationStatus) {
-    MemberInvitationStatus["Pending"] = "Pending";
-    MemberInvitationStatus["Accepted"] = "Accepted";
-})(MemberInvitationStatus || (MemberInvitationStatus = {}));
-export var ITwinJobStatus;
-(function (ITwinJobStatus) {
-    ITwinJobStatus["Active"] = "Active";
-    ITwinJobStatus["Complete"] = "Completed";
-    ITwinJobStatus["PartialCompleted"] = "PartialCompleted";
-    ITwinJobStatus["Failed"] = "Failed";
-})(ITwinJobStatus || (ITwinJobStatus = {}));
-//#endregion
-//# sourceMappingURL=accessControlTypes.js.map

package/lib/esm/accessControlTypes.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"accessControlTypes.js","sourceRoot":"","sources":["../../src/accessControlTypes.ts"],"names":[],"mappings":"AAAA,mCAAmC;AACnC;;;gGAGgG;AAChG;;GAEG;AA4XH,MAAM,CAAN,IAAY,sBAGX;AAHD,WAAY,sBAAsB;IAChC,6CAAmB,CAAA;IACnB,+CAAqB,CAAA;AACvB,CAAC,EAHW,sBAAsB,KAAtB,sBAAsB,QAGjC;AAED,MAAM,CAAN,IAAY,cAKX;AALD,WAAY,cAAc;IACxB,mCAAiB,CAAA;IACjB,wCAAsB,CAAA;IACtB,uDAAqC,CAAA;IACrC,mCAAiB,CAAA;AACnB,CAAC,EALW,cAAc,KAAd,cAAc,QAKzB;AAyBD,YAAY","sourcesContent":["/* eslint-disable spaced-comment */\r\n/*---------------------------------------------------------------------------------------------\r\n * Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n * See LICENSE.md in the project root for license terms and full copyright notice.\r\n *--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module AccessControlClient\r\n */\r\n\r\nimport type { AccessToken } from \"@itwin/core-bentley\";\r\n\r\n//#region clients\r\n\r\nexport interface IAccessControlClient {\r\n  permissions: IPermissionsClient;\r\n  roles: IRolesClient;\r\n  groups: IGroupsClient;\r\n  userMembers: IUserMembersClient;\r\n  groupMembers: IGroupMembersClient;\r\n  ownerMembers: IOwnerMembersClient;\r\n  memberInvitations: IMemberInvitationsClient;\r\n  itwinJobs: IITwinJobsClient;\r\n}\r\n\r\nexport interface IPermissionsClient {\r\n  /** Retrieves the list of all available permissions **/\r\n  getPermissionsAsync(\r\n    accessToken: AccessToken\r\n  ): Promise<AccessControlAPIResponse<Permission[]>>;\r\n\r\n  /** Retrieves a list of permissions the identity has for a specified iTwin */\r\n  getITwinPermissionsAsync(\r\n    accessToken: AccessToken,\r\n    iTwinId: string\r\n  ): Promise<AccessControlAPIResponse<Permission[]>>;\r\n}\r\n\r\nexport interface IUserMembersClient {\r\n  /** Retrieves a list of user members and their roles assigned to a specified iTwin. */\r\n  queryITwinUserMembersAsync(\r\n    accessToken: AccessToken,\r\n    iTwinId: string,\r\n    arg?: AccessControlQueryArg\r\n  ): Promise<AccessControlAPIResponse<UserMember[]>>;\r\n\r\n  /** Retrieves a specific user member for a specified iTwin. */\r\n  getITwinUserMemberAsync(\r\n    accessToken: AccessToken,\r\n    iTwinId: string,\r\n    memberId: string\r\n  ): Promise<AccessControlAPIResponse<UserMember>>;\r\n\r\n  /** Add or invite new iTwin user members */\r\n  addITwinUserMembersAsync(\r\n    accessToken: AccessToken,\r\n    iTwinId: string,\r\n    newMembers: AddUserMember[],\r\n    customMessage?: string\r\n  ): Promise<AccessControlAPIResponse<AddUserMemberResponse>>;\r\n\r\n  /**  Remove the specified iTwin user member */\r\n  removeITwinUserMemberAsync(\r\n    accessToken: AccessToken,\r\n    iTwinId: string,\r\n    memberId: string\r\n  ): Promise<AccessControlAPIResponse<undefined>>;\r\n\r\n  /**  Update iTwin user member roles */\r\n  updateITwinUserMemberAsync(\r\n    accessToken: AccessToken,\r\n    iTwinId: string,\r\n    memberId: string,\r\n    roleIds: string[]\r\n  ): Promise<AccessControlAPIResponse<UserMember>>;\r\n}\r\n\r\nexport interface IOwnerMembersClient {\r\n  /** Retrieves a list of owner members on a specified iTwin. */\r\n  queryITwinOwnerMembersAsync(\r\n    accessToken: AccessToken,\r\n    iTwinId: string,\r\n    arg?: AccessControlQueryArg\r\n  ): Promise<AccessControlAPIResponse<OwnerMember[]>>;\r\n\r\n  /** Add or invite new iTwin owner member */\r\n  addITwinOwnerMemberAsync(\r\n    accessToken: AccessToken,\r\n    iTwinId: string,\r\n    newMember: OwnerMember\r\n  ): Promise<AccessControlAPIResponse<AddOwnerMemberResponse>>;\r\n\r\n  /**  Remove the specified iTwin owner member */\r\n  removeITwinOwnerMemberAsync(\r\n    accessToken: AccessToken,\r\n    iTwinId: string,\r\n    memberId: string\r\n  ): Promise<AccessControlAPIResponse<undefined>>;\r\n}\r\n\r\nexport interface IGroupMembersClient {\r\n  /** Retrieves a list of group members and their roles assigned to a specified iTwin. */\r\n  queryITwinGroupMembersAsync(\r\n    accessToken: AccessToken,\r\n    iTwinId: string,\r\n    arg?: AccessControlQueryArg\r\n  ): Promise<AccessControlAPIResponse<GroupMember[]>>;\r\n\r\n  /** Retrieves a specific group member for a specified iTwin. */\r\n  getITwinGroupMemberAsync(\r\n    accessToken: AccessToken,\r\n    iTwinId: string,\r\n    memberId: string\r\n  ): Promise<AccessControlAPIResponse<GroupMember>>;\r\n\r\n  /** Add new iTwin group members */\r\n  addITwinGroupMembersAsync(\r\n    accessToken: AccessToken,\r\n    iTwinId: string,\r\n    newMembers: AddGroupMember[]\r\n  ): Promise<AccessControlAPIResponse<GroupMember[]>>;\r\n\r\n  /**  Remove the specified iTwin group member */\r\n  removeITwinGroupMemberAsync(\r\n    accessToken: AccessToken,\r\n    iTwinId: string,\r\n    memberId: string\r\n  ): Promise<AccessControlAPIResponse<undefined>>;\r\n\r\n  /**  Update iTwin group member roles */\r\n  updateITwinGroupMemberAsync(\r\n    accessToken: AccessToken,\r\n    iTwinId: string,\r\n    memberId: string,\r\n    roleIds: string[]\r\n  ): Promise<AccessControlAPIResponse<GroupMember>>;\r\n}\r\n\r\nexport interface IRolesClient {\r\n  /** Retrieves a list of roles the for a specified iTwin */\r\n  getITwinRolesAsync(\r\n    accessToken: AccessToken,\r\n    iTwinId: string,\r\n    additionalHeaders?: { [key: string]: string }\r\n  ): Promise<AccessControlAPIResponse<Role[]>>;\r\n\r\n  /** Retrieves a role for a specified iTwin */\r\n  getITwinRoleAsync(\r\n    accessToken: AccessToken,\r\n    iTwinId: string,\r\n    roleId: string\r\n  ): Promise<AccessControlAPIResponse<Role>>;\r\n\r\n  /** Creates a new iTwin Role */\r\n  createITwinRoleAsync(\r\n    accessToken: AccessToken,\r\n    iTwinId: string,\r\n    role: Role\r\n  ): Promise<AccessControlAPIResponse<Role>>;\r\n\r\n  /** Removes an existing iTwin Role */\r\n  deleteITwinRoleAsync(\r\n    accessToken: AccessToken,\r\n    iTwinId: string,\r\n    roleId: string\r\n  ): Promise<AccessControlAPIResponse<undefined>>;\r\n\r\n  /** Updates an existing iTwin Role */\r\n  updateITwinRoleAsync(\r\n    accessToken: AccessToken,\r\n    iTwinId: string,\r\n    roleId: string,\r\n    role: Role\r\n  ): Promise<AccessControlAPIResponse<Role>>;\r\n}\r\n\r\nexport interface IGroupsClient {\r\n  /** Retrieves a list of groups the for a specified iTwin */\r\n  getITwinGroupsAsync(\r\n    accessToken: AccessToken,\r\n    iTwinId: string,\r\n    additionalHeaders?: { [key: string]: string }\r\n  ): Promise<AccessControlAPIResponse<Group[]>>;\r\n\r\n  /** Retrieves a group for a specified iTwin */\r\n  getITwinGroupAsync(\r\n    accessToken: AccessToken,\r\n    iTwinId: string,\r\n    groupId: string\r\n  ): Promise<AccessControlAPIResponse<Group>>;\r\n\r\n  /** Creates a new iTwin group */\r\n  createITwinGroupAsync(\r\n    accessToken: AccessToken,\r\n    iTwinId: string,\r\n    group: Group\r\n  ): Promise<AccessControlAPIResponse<Group>>;\r\n\r\n  /** Removes an existing iTwin group */\r\n  deleteITwinGroupAsync(\r\n    accessToken: AccessToken,\r\n    iTwinId: string,\r\n    groupId: string\r\n  ): Promise<AccessControlAPIResponse<undefined>>;\r\n\r\n  /** Updates an existing iTwin group */\r\n  updateITwinGroupAsync(\r\n    accessToken: AccessToken,\r\n    iTwinId: string,\r\n    groupId: string,\r\n    group: GroupUpdate\r\n  ): Promise<AccessControlAPIResponse<Group>>;\r\n}\r\n\r\nexport interface IMemberInvitationsClient {\r\n  /** Retrieves a list of member invitations. */\r\n  queryITwinMemberInvitationsAsync(\r\n    accessToken: AccessToken,\r\n    iTwinId: string,\r\n    arg?: AccessControlQueryArg\r\n  ): Promise<AccessControlAPIResponse<MemberInvitation[]>>;\r\n\r\n  /** Removes an existing member invitation. */\r\n  deleteITwinMemberInvitationAsync(\r\n    accessToken: AccessToken,\r\n    iTwinId: string,\r\n    invitationId: string\r\n  ): Promise<AccessControlAPIResponse<undefined>>;\r\n}\r\n\r\nexport interface IITwinJobsClient {\r\n  /** Creates a new iTwin Job */\r\n  createITwinJobAsync(\r\n    accessToken: AccessToken,\r\n    iTwinId: string,\r\n    iTwinJobActions: ITwinJobActions\r\n  ): Promise<AccessControlAPIResponse<ITwinJob>>;\r\n\r\n  /** Gets an iTwin Job. To see errors, pass in the `representation` result mode. */\r\n  getITwinJobAsync(\r\n    accessToken: AccessToken,\r\n    iTwinId: string,\r\n    iTwinJobId?: string,\r\n    resultMode?: AccessControlResultMode\r\n  ): Promise<AccessControlAPIResponse<ITwinJob>>;\r\n\r\n  /** Gets the iTwin Job Actions for a specified iTwin Job. */\r\n  getITwinJobActionsAsync(\r\n    accessToken: AccessToken,\r\n    iTwinId: string,\r\n    iTwinJobId?: string\r\n  ): Promise<AccessControlAPIResponse<ITwinJobActions>>;\r\n}\r\n\r\n//#endregion\r\n\r\n//#region generic-responses\r\n\r\n/**\r\n * Optional result mode. Minimal is the default, representation returns extra properties\r\n */\r\nexport type AccessControlResultMode = \"minimal\" | \"representation\";\r\n\r\nexport interface AccessControlQueryArg {\r\n  top?: number;\r\n  skip?: number;\r\n  resultMode?: AccessControlResultMode;\r\n}\r\n\r\nexport interface AccessControlAPIResponse<T> {\r\n  data?: T;\r\n  status: number;\r\n  error?: Error;\r\n  headers: { [key: string]: any };\r\n}\r\n\r\nexport interface Error {\r\n  code: string;\r\n  message: string;\r\n  details?: ErrorDetail[];\r\n  target?: string;\r\n}\r\n\r\nexport interface ErrorDetail {\r\n  code: string;\r\n  message: string;\r\n  target?: string;\r\n}\r\n\r\n//#endregion\r\n\r\n//#region custom responses\r\n\r\nexport interface AddOwnerMemberResponse {\r\n  member?: OwnerMember;\r\n  invitation?: MemberInvitation;\r\n}\r\n\r\nexport interface AddUserMemberResponse {\r\n  members: UserMember[];\r\n  invitations: MemberInvitation[];\r\n}\r\n\r\n//#endregion\r\n\r\n//#region base object\r\n\r\nexport type Permission = string;\r\n\r\nexport interface UserMember {\r\n  id?: string;\r\n  email?: string;\r\n  givenName?: string;\r\n  surname?: string;\r\n  organization?: string;\r\n  roles?: Omit<Role, \"permissions\">[];\r\n}\r\n\r\nexport interface AddUserMember {\r\n  roleIds: string[];\r\n  email: string;\r\n}\r\n\r\nexport interface OwnerMember {\r\n  id?: string;\r\n  email?: string;\r\n  givenName?: string;\r\n  surname?: string;\r\n  organization?: string;\r\n}\r\n\r\nexport interface GroupMember {\r\n  id?: string;\r\n  groupName?: string;\r\n  groupDescription?: string;\r\n  roles?: Omit<Role, \"permissions\">[];\r\n  imsGroupsCount?: number;\r\n  membersCount?: number;\r\n}\r\n\r\nexport interface AddGroupMember {\r\n  groupId: string;\r\n  roleIds: string[];\r\n}\r\n\r\nexport interface Role {\r\n  id?: string;\r\n  displayName: string;\r\n  description: string;\r\n  permissions: Permission[];\r\n}\r\n\r\nexport interface Group {\r\n  id?: string;\r\n  name?: string;\r\n  description?: string;\r\n  members?: GroupUser[];\r\n  imsGroups?: string[];\r\n  imsGroupsCount?: number;\r\n  membersCount?: number;\r\n}\r\n\r\nexport interface GroupUser {\r\n  id?: string;\r\n  email?: string;\r\n  givenName?: string;\r\n  surname?: string;\r\n  organization?: string;\r\n}\r\n\r\nexport interface GroupUpdate {\r\n  id?: string;\r\n  name?: string;\r\n  description?: string;\r\n  members?: string[];\r\n  imsGroups?: string[];\r\n}\r\n\r\nexport interface MemberInvitation {\r\n  id: string;\r\n  email: string;\r\n  invitedByEmail: string;\r\n  status: MemberInvitationStatus;\r\n  createdDate: string;\r\n  expirationDate: string;\r\n  roles?: Omit<Role, \"permissions\"|\"description\">[];\r\n}\r\n\r\nexport enum MemberInvitationStatus {\r\n  Pending = \"Pending\",\r\n  Accepted = \"Accepted\"\r\n}\r\n\r\nexport enum ITwinJobStatus {\r\n  Active = \"Active\",\r\n  Complete = \"Completed\",\r\n  PartialCompleted = \"PartialCompleted\",\r\n  Failed = \"Failed\"\r\n}\r\n\r\n/** Contains extra properties with \"representation\" result mode.\r\n */\r\nexport interface ITwinJob {\r\n  id: string;\r\n  itwinId: string;\r\n  status: ITwinJobStatus;\r\n\r\n  // extra properties available with \"representation\" result mode:\r\n  error?: ErrorDetail[];\r\n}\r\n\r\nexport interface ITwinJobActions {\r\n  assignRoles?: ITwinJobAction[];\r\n  unassignRoles?: ITwinJobAction[];\r\n  removeMembers?: Omit<ITwinJobAction, \"roleIds\">[];\r\n  options?: any;\r\n}\r\n\r\nexport interface ITwinJobAction {\r\n  email: string;\r\n  roleIds: string[];\r\n}\r\n\r\n//#endregion\r\n\r\n"]}