@itwin/access-control-client 1.2.0 → 2.0.0

package/lib/esm/subClients/MembersClient.d.ts

@@ -1,45 +0,0 @@
-/** @packageDocumentation
- * @module AccessControlClient
- */
-import type { AccessToken } from "@itwin/core-bentley";
-import type { AccessControlAPIResponse, AccessControlQueryArg, IMembersClient, Member } from "../accessControlTypes";
-import { BaseClient } from "./BaseClient";
-export declare class MembersClient extends BaseClient implements IMembersClient {
-    constructor(url?: string);
-    /** Retrieves a list of iTwin members and their roles assignments.
-      * @param accessToken The client access token string
-      * @param iTwinId The id of the iTwin
-      * @returns Array of members
-      */
-    queryITwinMembersAsync(accessToken: AccessToken, iTwinId: string, arg?: AccessControlQueryArg): Promise<AccessControlAPIResponse<Member[]>>;
-    /** Retrieves a specific member for a specified iTwin.
-      * @param accessToken The client access token string
-      * @param iTwinId The id of the iTwin
-      * @param memberId The id of the member
-      * @returns Member
-      */
-    getITwinMemberAsync(accessToken: AccessToken, iTwinId: string, memberId: string): Promise<AccessControlAPIResponse<Member>>;
-    /** Add new iTwin members
-      * @param accessToken The client access token string
-      * @param iTwinId The id of the iTwin
-      * @param newMembers The list of new members to be added along with their role
-      * @returns Member[]
-      */
-    addITwinMembersAsync(accessToken: AccessToken, iTwinId: string, newMembers: Member[]): Promise<AccessControlAPIResponse<Member[]>>;
-    /** Remove the specified member from the iTwin
-      * @param accessToken The client access token string
-      * @param iTwinId The id of the iTwin
-      * @param memberId The id of the member
-      * @returns No Content
-      */
-    removeITwinMemberAsync(accessToken: AccessToken, iTwinId: string, memberId: string): Promise<AccessControlAPIResponse<undefined>>;
-    /** Update iTwin team member roles
-      * @param accessToken The client access token string
-      * @param iTwinId The id of the iTwin
-      * @param memberId The id of the member
-      * @param roleIds The ids of the roles to be assigned
-      * @returns Member
-      */
-    updateITwinMemberAsync(accessToken: AccessToken, iTwinId: string, memberId: string, roleIds: string[]): Promise<AccessControlAPIResponse<Member>>;
-}
-//# sourceMappingURL=MembersClient.d.ts.map

package/lib/esm/subClients/MembersClient.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"MembersClient.d.ts","sourceRoot":"","sources":["../../../src/subClients/MembersClient.ts"],"names":[],"mappings":"AAIA;;GAEG;AACH,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAC;AACvD,OAAO,KAAK,EAAE,wBAAwB,EAAE,qBAAqB,EAAE,cAAc,EAAE,MAAM,EAAE,MAAM,uBAAuB,CAAC;AACrH,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE1C,qBAAa,aAAc,SAAQ,UAAW,YAAW,cAAc;gBAClD,GAAG,CAAC,EAAE,MAAM;IAI/B;;;;QAII;IACS,sBAAsB,CACjC,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,MAAM,EACf,GAAG,CAAC,EAAE,qBAAqB,GAC1B,OAAO,CAAC,wBAAwB,CAAC,MAAM,EAAE,CAAC,CAAC;IAM9C;;;;;QAKI;IACS,mBAAmB,CAC9B,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,MAAM,EACf,QAAQ,EAAE,MAAM,GACf,OAAO,CAAC,wBAAwB,CAAC,MAAM,CAAC,CAAC;IAK5C;;;;;QAKI;IACS,oBAAoB,CAC/B,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,MAAM,EACf,UAAU,EAAE,MAAM,EAAE,GACnB,OAAO,CAAC,wBAAwB,CAAC,MAAM,EAAE,CAAC,CAAC;IAQ9C;;;;;QAKI;IACS,sBAAsB,CACjC,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,MAAM,EACf,QAAQ,EAAE,MAAM,GACf,OAAO,CAAC,wBAAwB,CAAC,SAAS,CAAC,CAAC;IAK/C;;;;;;QAMI;IACS,sBAAsB,CACjC,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,MAAM,EACf,QAAQ,EAAE,MAAM,EAChB,OAAO,EAAE,MAAM,EAAE,GAChB,OAAO,CAAC,wBAAwB,CAAC,MAAM,CAAC,CAAC;CAO7C"}

package/lib/esm/subClients/MembersClient.js

@@ -1,65 +0,0 @@
-import { BaseClient } from "./BaseClient";
-export class MembersClient extends BaseClient {
-    constructor(url) {
-        super(url);
-    }
-    /** Retrieves a list of iTwin members and their roles assignments.
-      * @param accessToken The client access token string
-      * @param iTwinId The id of the iTwin
-      * @returns Array of members
-      */
-    async queryITwinMembersAsync(accessToken, iTwinId, arg) {
-        let url = `${this._baseUrl}/${iTwinId}/members`;
-        if (arg)
-            url += `?${this.getQueryString(arg)}`;
-        return this.sendGenericAPIRequest(accessToken, "GET", url, undefined, "members"); // TODO: Consider how to handle paging
-    }
-    /** Retrieves a specific member for a specified iTwin.
-      * @param accessToken The client access token string
-      * @param iTwinId The id of the iTwin
-      * @param memberId The id of the member
-      * @returns Member
-      */
-    async getITwinMemberAsync(accessToken, iTwinId, memberId) {
-        const url = `${this._baseUrl}/${iTwinId}/members/${memberId}`;
-        return this.sendGenericAPIRequest(accessToken, "GET", url, undefined, "member");
-    }
-    /** Add new iTwin members
-      * @param accessToken The client access token string
-      * @param iTwinId The id of the iTwin
-      * @param newMembers The list of new members to be added along with their role
-      * @returns Member[]
-      */
-    async addITwinMembersAsync(accessToken, iTwinId, newMembers) {
-        const url = `${this._baseUrl}/${iTwinId}/members`;
-        const body = {
-            members: newMembers,
-        };
-        return this.sendGenericAPIRequest(accessToken, "POST", url, body, "members");
-    }
-    /** Remove the specified member from the iTwin
-      * @param accessToken The client access token string
-      * @param iTwinId The id of the iTwin
-      * @param memberId The id of the member
-      * @returns No Content
-      */
-    async removeITwinMemberAsync(accessToken, iTwinId, memberId) {
-        const url = `${this._baseUrl}/${iTwinId}/members/${memberId}`;
-        return this.sendGenericAPIRequest(accessToken, "DELETE", url);
-    }
-    /** Update iTwin team member roles
-      * @param accessToken The client access token string
-      * @param iTwinId The id of the iTwin
-      * @param memberId The id of the member
-      * @param roleIds The ids of the roles to be assigned
-      * @returns Member
-      */
-    async updateITwinMemberAsync(accessToken, iTwinId, memberId, roleIds) {
-        const url = `${this._baseUrl}/${iTwinId}/members/${memberId}`;
-        const body = {
-            roleIds,
-        };
-        return this.sendGenericAPIRequest(accessToken, "PATCH", url, body, "member");
-    }
-}
-//# sourceMappingURL=MembersClient.js.map

package/lib/esm/subClients/MembersClient.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"MembersClient.js","sourceRoot":"","sources":["../../../src/subClients/MembersClient.ts"],"names":[],"mappings":"AASA,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE1C,MAAM,OAAO,aAAc,SAAQ,UAAU;IAC3C,YAAmB,GAAY;QAC7B,KAAK,CAAC,GAAG,CAAC,CAAC;IACb,CAAC;IAED;;;;QAII;IACG,KAAK,CAAC,sBAAsB,CACjC,WAAwB,EACxB,OAAe,EACf,GAA2B;QAE3B,IAAI,GAAG,GAAG,GAAG,IAAI,CAAC,QAAQ,IAAI,OAAO,UAAU,CAAC;QAChD,IAAI,GAAG;YAAE,GAAG,IAAI,IAAI,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,EAAE,CAAC;QAC/C,OAAO,IAAI,CAAC,qBAAqB,CAAC,WAAW,EAAE,KAAK,EAAE,GAAG,EAAE,SAAS,EAAE,SAAS,CAAC,CAAC,CAAC,sCAAsC;IAC1H,CAAC;IAED;;;;;QAKI;IACG,KAAK,CAAC,mBAAmB,CAC9B,WAAwB,EACxB,OAAe,EACf,QAAgB;QAEhB,MAAM,GAAG,GAAG,GAAG,IAAI,CAAC,QAAQ,IAAI,OAAO,YAAY,QAAQ,EAAE,CAAC;QAC9D,OAAO,IAAI,CAAC,qBAAqB,CAAC,WAAW,EAAE,KAAK,EAAE,GAAG,EAAE,SAAS,EAAE,QAAQ,CAAC,CAAC;IAClF,CAAC;IAED;;;;;QAKI;IACG,KAAK,CAAC,oBAAoB,CAC/B,WAAwB,EACxB,OAAe,EACf,UAAoB;QAEpB,MAAM,GAAG,GAAG,GAAG,IAAI,CAAC,QAAQ,IAAI,OAAO,UAAU,CAAC;QAClD,MAAM,IAAI,GAAG;YACX,OAAO,EAAE,UAAU;SACpB,CAAC;QACF,OAAO,IAAI,CAAC,qBAAqB,CAAC,WAAW,EAAE,MAAM,EAAE,GAAG,EAAE,IAAI,EAAE,SAAS,CAAC,CAAC;IAC/E,CAAC;IAED;;;;;QAKI;IACG,KAAK,CAAC,sBAAsB,CACjC,WAAwB,EACxB,OAAe,EACf,QAAgB;QAEhB,MAAM,GAAG,GAAG,GAAG,IAAI,CAAC,QAAQ,IAAI,OAAO,YAAY,QAAQ,EAAE,CAAC;QAC9D,OAAO,IAAI,CAAC,qBAAqB,CAAC,WAAW,EAAE,QAAQ,EAAE,GAAG,CAAC,CAAC;IAChE,CAAC;IAED;;;;;;QAMI;IACG,KAAK,CAAC,sBAAsB,CACjC,WAAwB,EACxB,OAAe,EACf,QAAgB,EAChB,OAAiB;QAEjB,MAAM,GAAG,GAAG,GAAG,IAAI,CAAC,QAAQ,IAAI,OAAO,YAAY,QAAQ,EAAE,CAAC;QAC9D,MAAM,IAAI,GAAG;YACX,OAAO;SACR,CAAC;QACF,OAAO,IAAI,CAAC,qBAAqB,CAAC,WAAW,EAAE,OAAO,EAAE,GAAG,EAAE,IAAI,EAAE,QAAQ,CAAC,CAAC;IAC/E,CAAC;CACF","sourcesContent":["/*---------------------------------------------------------------------------------------------\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\nimport type { AccessToken } from \"@itwin/core-bentley\";\r\nimport type { AccessControlAPIResponse, AccessControlQueryArg, IMembersClient, Member } from \"../accessControlTypes\";\r\nimport { BaseClient } from \"./BaseClient\";\r\n\r\nexport class MembersClient extends BaseClient implements IMembersClient{\r\n  public constructor(url?: string) {\r\n    super(url);\r\n  }\r\n\r\n  /** Retrieves a list of iTwin members and their roles assignments.\r\n    * @param accessToken The client access token string\r\n    * @param iTwinId The id of the iTwin\r\n    * @returns Array of members\r\n    */\r\n  public async queryITwinMembersAsync(\r\n    accessToken: AccessToken,\r\n    iTwinId: string,\r\n    arg?: AccessControlQueryArg\r\n  ): Promise<AccessControlAPIResponse<Member[]>>{\r\n    let url = `${this._baseUrl}/${iTwinId}/members`;\r\n    if (arg) url += `?${this.getQueryString(arg)}`;\r\n    return this.sendGenericAPIRequest(accessToken, \"GET\", url, undefined, \"members\"); // TODO: Consider how to handle paging\r\n  }\r\n\r\n  /** Retrieves a specific member for a specified iTwin.\r\n    * @param accessToken The client access token string\r\n    * @param iTwinId The id of the iTwin\r\n    * @param memberId The id of the member\r\n    * @returns Member\r\n    */\r\n  public async getITwinMemberAsync(\r\n    accessToken: AccessToken,\r\n    iTwinId: string,\r\n    memberId: string\r\n  ): Promise<AccessControlAPIResponse<Member>>{\r\n    const url = `${this._baseUrl}/${iTwinId}/members/${memberId}`;\r\n    return this.sendGenericAPIRequest(accessToken, \"GET\", url, undefined, \"member\");\r\n  }\r\n\r\n  /** Add new iTwin members\r\n    * @param accessToken The client access token string\r\n    * @param iTwinId The id of the iTwin\r\n    * @param newMembers The list of new members to be added along with their role\r\n    * @returns Member[]\r\n    */\r\n  public async addITwinMembersAsync(\r\n    accessToken: AccessToken,\r\n    iTwinId: string,\r\n    newMembers: Member[]\r\n  ): Promise<AccessControlAPIResponse<Member[]>>{\r\n    const url = `${this._baseUrl}/${iTwinId}/members`;\r\n    const body = {\r\n      members: newMembers,\r\n    };\r\n    return this.sendGenericAPIRequest(accessToken, \"POST\", url, body, \"members\");\r\n  }\r\n\r\n  /** Remove the specified member from the iTwin\r\n    * @param accessToken The client access token string\r\n    * @param iTwinId The id of the iTwin\r\n    * @param memberId The id of the member\r\n    * @returns No Content\r\n    */\r\n  public async removeITwinMemberAsync(\r\n    accessToken: AccessToken,\r\n    iTwinId: string,\r\n    memberId: string\r\n  ): Promise<AccessControlAPIResponse<undefined>> {\r\n    const url = `${this._baseUrl}/${iTwinId}/members/${memberId}`;\r\n    return this.sendGenericAPIRequest(accessToken, \"DELETE\", url);\r\n  }\r\n\r\n  /** Update iTwin team member roles\r\n    * @param accessToken The client access token string\r\n    * @param iTwinId The id of the iTwin\r\n    * @param memberId The id of the member\r\n    * @param roleIds The ids of the roles to be assigned\r\n    * @returns Member\r\n    */\r\n  public async updateITwinMemberAsync(\r\n    accessToken: AccessToken,\r\n    iTwinId: string,\r\n    memberId: string,\r\n    roleIds: string[]\r\n  ): Promise<AccessControlAPIResponse<Member>> {\r\n    const url = `${this._baseUrl}/${iTwinId}/members/${memberId}`;\r\n    const body = {\r\n      roleIds,\r\n    };\r\n    return this.sendGenericAPIRequest(accessToken, \"PATCH\", url, body, \"member\");\r\n  }\r\n}\r\n"]}