@itwin/access-control-client 3.6.0 → 4.0.0

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

@@ -2,29 +2,68 @@
  * @module AccessControlClient
  */
 import type { AccessToken } from "@itwin/core-bentley";
-import type { AccessControlAPIResponse, AccessControlQueryArg, AddOwnerMemberResponse, IOwnerMembersClient, OwnerMember } from "../accessControlTypes";
+import type { IOwnerMembersClient } from "../accessControlClientInterfaces/OwnerMembersClient ";
+import type { BentleyAPIResponse, ODataQueryParams } from "../types/CommonApiTypes";
+import type { OwnerMember } from "../types/Members";
+import type { AddOwnerMemberResponse, OwnerMemberMultiResponse } from "../types/OwnerMember";
 import { BaseClient } from "./BaseClient";
+/** Client API to perform owner member operations.
+ */
 export declare class OwnerMembersClient extends BaseClient implements IOwnerMembersClient {
+    /** Create a new OwnerMembersClient instance
+     * @param url Optional base URL for the access control service. If not provided, defaults to base url.
+     */
     constructor(url?: string);
     /** Retrieves a list of iTwin owner members on an iTwin.
      * @param accessToken The client access token string
      * @param iTwinId The id of the iTwin
-     * @returns Array of members
+     * @param arg Optional query parameters for pagination (top, skip)
+     * @returns Array of owner members, including any "missing users" with null profile data
+     * @remarks
+     * **Missing Users**
+     *
+     * When members are removed from the Bentley Identity Management System, they are not
+     * automatically removed from the iTwin. Therefore, it is possible to have a situation
+     * where the user is no longer valid, yet they are still a member of the iTwin. When
+     * this happens, the user member will be returned from this API endpoint with the
+     * following values:
+     *
+     * ```json
+     * {
+     *     "id": "<memberId>",
+     *     "email": null,
+     *     "givenName": null,
+     *     "surname": null,
+     *     "organization": null,
+     *     ...
+     * }
+     * ```
+     *
+     * You should account for this in your software if you do not want to show these users.
+     *
+     * **Cleanup**
+     *
+     * The Access Control API will perform a once-a-week cleanup to remove these "Missing Users".
+     * You can rely on this automated clean-up if this timeline is sufficient.
+     *
+     * If not, you can use the Remove iTwin Owner Member API (use the memberId) to remove
+     * the owner member from the iTwin.
+     *
      */
-    queryITwinOwnerMembersAsync(accessToken: AccessToken, iTwinId: string, arg?: AccessControlQueryArg): Promise<AccessControlAPIResponse<OwnerMember[]>>;
-    /** Add new iTwin owner member
+    queryITwinOwnerMembers(accessToken: AccessToken, iTwinId: string, arg?: Pick<ODataQueryParams, "top" | "skip">): Promise<BentleyAPIResponse<OwnerMemberMultiResponse>>;
+    /** Add new iTwin owner member.
      * @param accessToken The client access token string
      * @param iTwinId The id of the iTwin
      * @param newMember The new owner member to add or invite
      * @returns AddOwnerMemberResponse -- the added or invited owner
      */
-    addITwinOwnerMemberAsync(accessToken: AccessToken, iTwinId: string, newMember: OwnerMember): Promise<AccessControlAPIResponse<AddOwnerMemberResponse>>;
+    addITwinOwnerMember(accessToken: AccessToken, iTwinId: string, newMember: Pick<OwnerMember, "email">): Promise<BentleyAPIResponse<AddOwnerMemberResponse>>;
     /** Remove the specified owner 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
      */
-    removeITwinOwnerMemberAsync(accessToken: AccessToken, iTwinId: string, memberId: string): Promise<AccessControlAPIResponse<undefined>>;
+    removeITwinOwnerMember(accessToken: AccessToken, iTwinId: string, memberId: string): Promise<BentleyAPIResponse<undefined>>;
 }
 //# sourceMappingURL=OwnerMembersClient.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"OwnerMembersClient.d.ts","sourceRoot":"","sources":["../../../src/subClients/OwnerMembersClient.ts"],"names":[],"mappings":"AAIA;;GAEG;AACH,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAC;AACvD,OAAO,KAAK,EACV,wBAAwB,EACxB,qBAAqB,EACrB,sBAAsB,EACtB,mBAAmB,EACnB,WAAW,EACZ,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE1C,qBAAa,kBACX,SAAQ,UACR,YAAW,mBAAmB;gBACX,GAAG,CAAC,EAAE,MAAM;IAI/B;;;;OAIG;IACU,2BAA2B,CACtC,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,MAAM,EACf,GAAG,CAAC,EAAE,qBAAqB,GAC1B,OAAO,CAAC,wBAAwB,CAAC,WAAW,EAAE,CAAC,CAAC;IAgBnD;;;;;OAKG;IACU,wBAAwB,CACnC,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,MAAM,EACf,SAAS,EAAE,WAAW,GACrB,OAAO,CAAC,wBAAwB,CAAC,sBAAsB,CAAC,CAAC;IAU5D;;;;;OAKG;IACU,2BAA2B,CACtC,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,MAAM,EACf,QAAQ,EAAE,MAAM,GACf,OAAO,CAAC,wBAAwB,CAAC,SAAS,CAAC,CAAC;CAIhD"}
+{"version":3,"file":"OwnerMembersClient.d.ts","sourceRoot":"","sources":["../../../src/subClients/OwnerMembersClient.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAC;AACvD,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,sDAAsD,CAAC;AAChG,OAAO,KAAK,EAAE,kBAAkB,EAAE,gBAAgB,EAAE,MAAM,yBAAyB,CAAC;AACpF,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AACpD,OAAO,KAAK,EAAE,sBAAsB,EAAE,wBAAwB,EAAE,MAAM,sBAAsB,CAAC;AAC7F,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE1C;GACG;AACH,qBAAa,kBACX,SAAQ,UACR,YAAW,mBAAmB;IAC9B;;OAEG;gBACgB,GAAG,CAAC,EAAE,MAAM;IAI/B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAmCG;IACU,sBAAsB,CACjC,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,MAAM,EACf,GAAG,CAAC,EAAE,IAAI,CAAC,gBAAgB,EAAE,KAAK,GAAG,MAAM,CAAC,GAC3C,OAAO,CAAC,kBAAkB,CAAC,wBAAwB,CAAC,CAAC;IAaxD;;;;;OAKG;IACU,mBAAmB,CAC9B,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,MAAM,EACf,SAAS,EAAE,IAAI,CAAC,WAAW,EAAE,OAAO,CAAC,GACpC,OAAO,CAAC,kBAAkB,CAAC,sBAAsB,CAAC,CAAC;IAUtD;;;;;OAKG;IACU,sBAAsB,CACjC,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,MAAM,EACf,QAAQ,EAAE,MAAM,GACf,OAAO,CAAC,kBAAkB,CAAC,SAAS,CAAC,CAAC;CAI1C"}

package/lib/esm/subClients/OwnerMembersClient.js

@@ -1,27 +1,67 @@
+/*---------------------------------------------------------------------------------------------
+ * 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
+ */
 import { BaseClient } from "./BaseClient";
+/** Client API to perform owner member operations.
+ */
 export class OwnerMembersClient extends BaseClient {
+    /** Create a new OwnerMembersClient instance
+     * @param url Optional base URL for the access control service. If not provided, defaults to base url.
+     */
     constructor(url) {
         super(url);
     }
     /** Retrieves a list of iTwin owner members on an iTwin.
      * @param accessToken The client access token string
      * @param iTwinId The id of the iTwin
-     * @returns Array of members
+     * @param arg Optional query parameters for pagination (top, skip)
+     * @returns Array of owner members, including any "missing users" with null profile data
+     * @remarks
+     * **Missing Users**
+     *
+     * When members are removed from the Bentley Identity Management System, they are not
+     * automatically removed from the iTwin. Therefore, it is possible to have a situation
+     * where the user is no longer valid, yet they are still a member of the iTwin. When
+     * this happens, the user member will be returned from this API endpoint with the
+     * following values:
+     *
+     * ```json
+     * {
+     *     "id": "<memberId>",
+     *     "email": null,
+     *     "givenName": null,
+     *     "surname": null,
+     *     "organization": null,
+     *     ...
+     * }
+     * ```
+     *
+     * You should account for this in your software if you do not want to show these users.
+     *
+     * **Cleanup**
+     *
+     * The Access Control API will perform a once-a-week cleanup to remove these "Missing Users".
+     * You can rely on this automated clean-up if this timeline is sufficient.
+     *
+     * If not, you can use the Remove iTwin Owner Member API (use the memberId) to remove
+     * the owner member from the iTwin.
+     *
      */
-    async queryITwinOwnerMembersAsync(accessToken, iTwinId, arg) {
-        let url = `${this._baseUrl}/${iTwinId}/members/owners`;
-        if (arg) {
-            url += `?${this.getQueryString(arg)}`;
-        }
-        return this.sendGenericAPIRequest(accessToken, "GET", url, undefined, "members"); // TODO: Consider how to handle paging
+    async queryITwinOwnerMembers(accessToken, iTwinId, arg) {
+        const url = `${this._baseUrl}/${iTwinId}/members/owners${arg ? `?${this.getQueryString(OwnerMembersClient.paginationParamMapping, { top: arg.top, skip: arg.skip })}` : ''}`;
+        return this.sendGenericAPIRequest(accessToken, "GET", url, undefined);
     }
-    /** Add new iTwin owner member
+    /** Add new iTwin owner member.
      * @param accessToken The client access token string
      * @param iTwinId The id of the iTwin
      * @param newMember The new owner member to add or invite
      * @returns AddOwnerMemberResponse -- the added or invited owner
      */
-    async addITwinOwnerMemberAsync(accessToken, iTwinId, newMember) {
+    async addITwinOwnerMember(accessToken, iTwinId, newMember) {
         const url = `${this._baseUrl}/${iTwinId}/members/owners`;
         return this.sendGenericAPIRequest(accessToken, "POST", url, newMember);
     }
@@ -31,7 +71,7 @@ export class OwnerMembersClient extends BaseClient {
      * @param memberId The id of the member
      * @returns No Content
      */
-    async removeITwinOwnerMemberAsync(accessToken, iTwinId, memberId) {
+    async removeITwinOwnerMember(accessToken, iTwinId, memberId) {
         const url = `${this._baseUrl}/${iTwinId}/members/owners/${memberId}`;
         return this.sendGenericAPIRequest(accessToken, "DELETE", url);
     }

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

@@ -1 +1 @@
-{"version":3,"file":"OwnerMembersClient.js","sourceRoot":"","sources":["../../../src/subClients/OwnerMembersClient.ts"],"names":[],"mappings":"AAeA,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE1C,MAAM,OAAO,kBACX,SAAQ,UAAU;IAElB,YAAmB,GAAY;QAC7B,KAAK,CAAC,GAAG,CAAC,CAAC;IACb,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,2BAA2B,CACtC,WAAwB,EACxB,OAAe,EACf,GAA2B;QAE3B,IAAI,GAAG,GAAG,GAAG,IAAI,CAAC,QAAQ,IAAI,OAAO,iBAAiB,CAAC;QAEvD,IAAI,GAAG,EAAE;YACP,GAAG,IAAI,IAAI,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,EAAE,CAAC;SACvC;QAED,OAAO,IAAI,CAAC,qBAAqB,CAC/B,WAAW,EACX,KAAK,EACL,GAAG,EACH,SAAS,EACT,SAAS,CACV,CAAC,CAAC,sCAAsC;IAC3C,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,wBAAwB,CACnC,WAAwB,EACxB,OAAe,EACf,SAAsB;QAEtB,MAAM,GAAG,GAAG,GAAG,IAAI,CAAC,QAAQ,IAAI,OAAO,iBAAiB,CAAC;QACzD,OAAO,IAAI,CAAC,qBAAqB,CAC/B,WAAW,EACX,MAAM,EACN,GAAG,EACH,SAAS,CACV,CAAC;IACJ,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,2BAA2B,CACtC,WAAwB,EACxB,OAAe,EACf,QAAgB;QAEhB,MAAM,GAAG,GAAG,GAAG,IAAI,CAAC,QAAQ,IAAI,OAAO,mBAAmB,QAAQ,EAAE,CAAC;QACrE,OAAO,IAAI,CAAC,qBAAqB,CAAC,WAAW,EAAE,QAAQ,EAAE,GAAG,CAAC,CAAC;IAChE,CAAC;CACF","sourcesContent":["/*---------------------------------------------------------------------------------------------\n * Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n * See LICENSE.md in the project root for license terms and full copyright notice.\n *--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module AccessControlClient\n */\nimport type { AccessToken } from \"@itwin/core-bentley\";\nimport type {\n  AccessControlAPIResponse,\n  AccessControlQueryArg,\n  AddOwnerMemberResponse,\n  IOwnerMembersClient,\n  OwnerMember,\n} from \"../accessControlTypes\";\nimport { BaseClient } from \"./BaseClient\";\n\nexport class OwnerMembersClient\n  extends BaseClient\n  implements IOwnerMembersClient {\n  public constructor(url?: string) {\n    super(url);\n  }\n\n  /** Retrieves a list of iTwin owner members on an iTwin.\n   * @param accessToken The client access token string\n   * @param iTwinId The id of the iTwin\n   * @returns Array of members\n   */\n  public async queryITwinOwnerMembersAsync(\n    accessToken: AccessToken,\n    iTwinId: string,\n    arg?: AccessControlQueryArg\n  ): Promise<AccessControlAPIResponse<OwnerMember[]>> {\n    let url = `${this._baseUrl}/${iTwinId}/members/owners`;\n\n    if (arg) {\n      url += `?${this.getQueryString(arg)}`;\n    }\n\n    return this.sendGenericAPIRequest(\n      accessToken,\n      \"GET\",\n      url,\n      undefined,\n      \"members\"\n    ); // TODO: Consider how to handle paging\n  }\n\n  /** Add new iTwin owner member\n   * @param accessToken The client access token string\n   * @param iTwinId The id of the iTwin\n   * @param newMember The new owner member to add or invite\n   * @returns AddOwnerMemberResponse -- the added or invited owner\n   */\n  public async addITwinOwnerMemberAsync(\n    accessToken: AccessToken,\n    iTwinId: string,\n    newMember: OwnerMember\n  ): Promise<AccessControlAPIResponse<AddOwnerMemberResponse>> {\n    const url = `${this._baseUrl}/${iTwinId}/members/owners`;\n    return this.sendGenericAPIRequest(\n      accessToken,\n      \"POST\",\n      url,\n      newMember\n    );\n  }\n\n  /** Remove the specified owner member from the iTwin\n   * @param accessToken The client access token string\n   * @param iTwinId The id of the iTwin\n   * @param memberId The id of the member\n   * @returns No Content\n   */\n  public async removeITwinOwnerMemberAsync(\n    accessToken: AccessToken,\n    iTwinId: string,\n    memberId: string\n  ): Promise<AccessControlAPIResponse<undefined>> {\n    const url = `${this._baseUrl}/${iTwinId}/members/owners/${memberId}`;\n    return this.sendGenericAPIRequest(accessToken, \"DELETE\", url);\n  }\n}\n"]}
+{"version":3,"file":"OwnerMembersClient.js","sourceRoot":"","sources":["../../../src/subClients/OwnerMembersClient.ts"],"names":[],"mappings":"AAAA;;;gGAGgG;AAChG;;GAEG;AAOH,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE1C;GACG;AACH,MAAM,OAAO,kBACX,SAAQ,UAAU;IAElB;;OAEG;IACH,YAAmB,GAAY;QAC7B,KAAK,CAAC,GAAG,CAAC,CAAC;IACb,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAmCG;IACI,KAAK,CAAC,sBAAsB,CACjC,WAAwB,EACxB,OAAe,EACf,GAA4C;QAE5C,MAAM,GAAG,GAAG,GAAG,IAAI,CAAC,QAAQ,IAAI,OAAO,kBACrC,GAAG,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC,cAAc,CAAC,kBAAkB,CAAC,sBAAsB,EAAE,EAAE,GAAG,EAAE,GAAG,CAAC,GAAG,EAAE,IAAI,EAAE,GAAG,CAAC,IAAI,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,EACjH,EAAE,CAAC;QAEH,OAAO,IAAI,CAAC,qBAAqB,CAC/B,WAAW,EACX,KAAK,EACL,GAAG,EACH,SAAS,CACV,CAAC;IACJ,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,mBAAmB,CAC9B,WAAwB,EACxB,OAAe,EACf,SAAqC;QAErC,MAAM,GAAG,GAAG,GAAG,IAAI,CAAC,QAAQ,IAAI,OAAO,iBAAiB,CAAC;QACzD,OAAO,IAAI,CAAC,qBAAqB,CAC/B,WAAW,EACX,MAAM,EACN,GAAG,EACH,SAAS,CACV,CAAC;IACJ,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,sBAAsB,CACjC,WAAwB,EACxB,OAAe,EACf,QAAgB;QAEhB,MAAM,GAAG,GAAG,GAAG,IAAI,CAAC,QAAQ,IAAI,OAAO,mBAAmB,QAAQ,EAAE,CAAC;QACrE,OAAO,IAAI,CAAC,qBAAqB,CAAC,WAAW,EAAE,QAAQ,EAAE,GAAG,CAAC,CAAC;IAChE,CAAC;CACF","sourcesContent":["/*---------------------------------------------------------------------------------------------\n * Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n * See LICENSE.md in the project root for license terms and full copyright notice.\n *--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module AccessControlClient\n */\n\nimport type { AccessToken } from \"@itwin/core-bentley\";\nimport type { IOwnerMembersClient } from \"../accessControlClientInterfaces/OwnerMembersClient \";\nimport type { BentleyAPIResponse, ODataQueryParams } from \"../types/CommonApiTypes\";\nimport type { OwnerMember } from \"../types/Members\";\nimport type { AddOwnerMemberResponse, OwnerMemberMultiResponse } from \"../types/OwnerMember\";\nimport { BaseClient } from \"./BaseClient\";\n\n/** Client API to perform owner member operations.\n */\nexport class OwnerMembersClient\n  extends BaseClient\n  implements IOwnerMembersClient {\n  /** Create a new OwnerMembersClient instance\n   * @param url Optional base URL for the access control service. If not provided, defaults to base url.\n   */\n  public constructor(url?: string) {\n    super(url);\n  }\n\n  /** Retrieves a list of iTwin owner members on an iTwin.\n   * @param accessToken The client access token string\n   * @param iTwinId The id of the iTwin\n   * @param arg Optional query parameters for pagination (top, skip)\n   * @returns Array of owner members, including any \"missing users\" with null profile data\n   * @remarks\n   * **Missing Users**\n   *\n   * When members are removed from the Bentley Identity Management System, they are not\n   * automatically removed from the iTwin. Therefore, it is possible to have a situation\n   * where the user is no longer valid, yet they are still a member of the iTwin. When\n   * this happens, the user member will be returned from this API endpoint with the\n   * following values:\n   *\n   * ```json\n   * {\n   *     \"id\": \"<memberId>\",\n   *     \"email\": null,\n   *     \"givenName\": null,\n   *     \"surname\": null,\n   *     \"organization\": null,\n   *     ...\n   * }\n   * ```\n   *\n   * You should account for this in your software if you do not want to show these users.\n   *\n   * **Cleanup**\n   *\n   * The Access Control API will perform a once-a-week cleanup to remove these \"Missing Users\".\n   * You can rely on this automated clean-up if this timeline is sufficient.\n   *\n   * If not, you can use the Remove iTwin Owner Member API (use the memberId) to remove\n   * the owner member from the iTwin.\n   *\n   */\n  public async queryITwinOwnerMembers(\n    accessToken: AccessToken,\n    iTwinId: string,\n    arg?: Pick<ODataQueryParams, \"top\" | \"skip\">\n  ): Promise<BentleyAPIResponse<OwnerMemberMultiResponse>> {\n    const url = `${this._baseUrl}/${iTwinId}/members/owners${\n      arg ? `?${this.getQueryString(OwnerMembersClient.paginationParamMapping, { top: arg.top, skip: arg.skip })}` : ''\n    }`;\n\n    return this.sendGenericAPIRequest(\n      accessToken,\n      \"GET\",\n      url,\n      undefined,\n    );\n  }\n\n  /** Add new iTwin owner member.\n   * @param accessToken The client access token string\n   * @param iTwinId The id of the iTwin\n   * @param newMember The new owner member to add or invite\n   * @returns AddOwnerMemberResponse -- the added or invited owner\n   */\n  public async addITwinOwnerMember(\n    accessToken: AccessToken,\n    iTwinId: string,\n    newMember: Pick<OwnerMember, \"email\">\n  ): Promise<BentleyAPIResponse<AddOwnerMemberResponse>> {\n    const url = `${this._baseUrl}/${iTwinId}/members/owners`;\n    return this.sendGenericAPIRequest(\n      accessToken,\n      \"POST\",\n      url,\n      newMember\n    );\n  }\n\n  /** Remove the specified owner member from the iTwin\n   * @param accessToken The client access token string\n   * @param iTwinId The id of the iTwin\n   * @param memberId The id of the member\n   * @returns No Content\n   */\n  public async removeITwinOwnerMember(\n    accessToken: AccessToken,\n    iTwinId: string,\n    memberId: string\n  ): Promise<BentleyAPIResponse<undefined>> {\n    const url = `${this._baseUrl}/${iTwinId}/members/owners/${memberId}`;\n    return this.sendGenericAPIRequest(accessToken, \"DELETE\", url);\n  }\n}\n"]}

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

@@ -2,20 +2,27 @@
  * @module AccessControlClient
  */
 import type { AccessToken } from "@itwin/core-bentley";
-import type { AccessControlAPIResponse, IPermissionsClient, Permission } from "../accessControlTypes";
+import type { IPermissionsClient } from "../accessControlClientInterfaces/PermissionsClient";
+import type { BentleyAPIResponse } from "../types/CommonApiTypes";
+import type { Permission } from "../types/Permission";
 import { BaseClient } from "./BaseClient";
+/** Client API to perform iTwin permission operations.
+ */
 export declare class PermissionsClient extends BaseClient implements IPermissionsClient {
+    /** Create a new PermissionsClient instance
+     * @param url Optional base URL for the access control service. If not provided, defaults to base url.
+     */
     constructor(url?: string);
     /** Retrieves the list of all available permissions
       * @param accessToken The client access token string
       * @returns Array of permissions
       */
-    getPermissionsAsync(accessToken: AccessToken): Promise<AccessControlAPIResponse<Permission[]>>;
+    getPermissions(accessToken: AccessToken): Promise<BentleyAPIResponse<Permission[]>>;
     /** Retrieves a list of permissions the identity has for a specified iTwin
       * @param accessToken The client access token string
       * @param iTwinId The id of the iTwin
       * @returns Array of permissions
       */
-    getITwinPermissionsAsync(accessToken: AccessToken, iTwinId: string): Promise<AccessControlAPIResponse<Permission[]>>;
+    getITwinPermissions(accessToken: AccessToken, iTwinId: string): Promise<BentleyAPIResponse<Permission[]>>;
 }
 //# sourceMappingURL=PermissionsClient.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"PermissionsClient.d.ts","sourceRoot":"","sources":["../../../src/subClients/PermissionsClient.ts"],"names":[],"mappings":"AAIA;;GAEG;AACH,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAC;AACvD,OAAO,KAAK,EAAE,wBAAwB,EAAE,kBAAkB,EAAE,UAAU,EAAE,MAAM,uBAAuB,CAAC;AACtG,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE1C,qBAAa,iBAAkB,SAAQ,UAAW,YAAW,kBAAkB;gBAC1D,GAAG,CAAC,EAAE,MAAM;IAI/B;;;QAGI;IACS,mBAAmB,CAC9B,WAAW,EAAE,WAAW,GACvB,OAAO,CAAC,wBAAwB,CAAC,UAAU,EAAE,CAAC,CAAC;IAKlD;;;;QAII;IACS,wBAAwB,CACnC,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,MAAM,GACd,OAAO,CAAC,wBAAwB,CAAC,UAAU,EAAE,CAAC,CAAC;CAInD"}
+{"version":3,"file":"PermissionsClient.d.ts","sourceRoot":"","sources":["../../../src/subClients/PermissionsClient.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAC;AACvD,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,oDAAoD,CAAC;AAC7F,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,yBAAyB,CAAC;AAClE,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACtD,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE1C;GACG;AACH,qBAAa,iBAAkB,SAAQ,UAAW,YAAW,kBAAkB;IAC7E;;OAEG;gBACgB,GAAG,CAAC,EAAE,MAAM;IAI/B;;;QAGI;IACS,cAAc,CACzB,WAAW,EAAE,WAAW,GACvB,OAAO,CAAC,kBAAkB,CAAC,UAAU,EAAE,CAAC,CAAC;IAK5C;;;;QAII;IACS,mBAAmB,CAC9B,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,MAAM,GACd,OAAO,CAAC,kBAAkB,CAAC,UAAU,EAAE,CAAC,CAAC;CAI7C"}

package/lib/esm/subClients/PermissionsClient.js

@@ -1,5 +1,17 @@
+/*---------------------------------------------------------------------------------------------
+ * 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
+ */
 import { BaseClient } from "./BaseClient";
+/** Client API to perform iTwin permission operations.
+ */
 export class PermissionsClient extends BaseClient {
+    /** Create a new PermissionsClient instance
+     * @param url Optional base URL for the access control service. If not provided, defaults to base url.
+     */
     constructor(url) {
         super(url);
     }
@@ -7,7 +19,7 @@ export class PermissionsClient extends BaseClient {
       * @param accessToken The client access token string
       * @returns Array of permissions
       */
-    async getPermissionsAsync(accessToken) {
+    async getPermissions(accessToken) {
         const url = `${this._baseUrl}/permissions`;
         return this.sendGenericAPIRequest(accessToken, "GET", url, undefined, "permissions");
     }
@@ -16,7 +28,7 @@ export class PermissionsClient extends BaseClient {
       * @param iTwinId The id of the iTwin
       * @returns Array of permissions
       */
-    async getITwinPermissionsAsync(accessToken, iTwinId) {
+    async getITwinPermissions(accessToken, iTwinId) {
         const url = `${this._baseUrl}/${iTwinId}/permissions`;
         return this.sendGenericAPIRequest(accessToken, "GET", url, undefined, "permissions");
     }

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

@@ -1 +1 @@
-{"version":3,"file":"PermissionsClient.js","sourceRoot":"","sources":["../../../src/subClients/PermissionsClient.ts"],"names":[],"mappings":"AASA,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE1C,MAAM,OAAO,iBAAkB,SAAQ,UAAU;IAC/C,YAAmB,GAAY;QAC7B,KAAK,CAAC,GAAG,CAAC,CAAC;IACb,CAAC;IAED;;;QAGI;IACG,KAAK,CAAC,mBAAmB,CAC9B,WAAwB;QAExB,MAAM,GAAG,GAAG,GAAG,IAAI,CAAC,QAAQ,cAAc,CAAC;QAC3C,OAAO,IAAI,CAAC,qBAAqB,CAAC,WAAW,EAAE,KAAK,EAAE,GAAG,EAAE,SAAS,EAAE,aAAa,CAAC,CAAC;IACvF,CAAC;IAED;;;;QAII;IACG,KAAK,CAAC,wBAAwB,CACnC,WAAwB,EACxB,OAAe;QAEf,MAAM,GAAG,GAAG,GAAG,IAAI,CAAC,QAAQ,IAAI,OAAO,cAAc,CAAC;QACtD,OAAO,IAAI,CAAC,qBAAqB,CAAC,WAAW,EAAE,KAAK,EAAE,GAAG,EAAE,SAAS,EAAE,aAAa,CAAC,CAAC;IACvF,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, IPermissionsClient, Permission } from \"../accessControlTypes\";\r\nimport { BaseClient } from \"./BaseClient\";\r\n\r\nexport class PermissionsClient extends BaseClient implements IPermissionsClient{\r\n  public constructor(url?: string) {\r\n    super(url);\r\n  }\r\n\r\n  /** Retrieves the list of all available permissions\r\n    * @param accessToken The client access token string\r\n    * @returns Array of permissions\r\n    */\r\n  public async getPermissionsAsync(\r\n    accessToken: AccessToken,\r\n  ): Promise<AccessControlAPIResponse<Permission[]>>{\r\n    const url = `${this._baseUrl}/permissions`;\r\n    return this.sendGenericAPIRequest(accessToken, \"GET\", url, undefined, \"permissions\");\r\n  }\r\n\r\n  /** Retrieves a list of permissions the identity has for a specified iTwin\r\n    * @param accessToken The client access token string\r\n    * @param iTwinId The id of the iTwin\r\n    * @returns Array of permissions\r\n    */\r\n  public async getITwinPermissionsAsync(\r\n    accessToken: AccessToken,\r\n    iTwinId: string,\r\n  ): Promise<AccessControlAPIResponse<Permission[]>>{\r\n    const url = `${this._baseUrl}/${iTwinId}/permissions`;\r\n    return this.sendGenericAPIRequest(accessToken, \"GET\", url, undefined, \"permissions\");\r\n  }\r\n}\r\n"]}
+{"version":3,"file":"PermissionsClient.js","sourceRoot":"","sources":["../../../src/subClients/PermissionsClient.ts"],"names":[],"mappings":"AAAA;;;gGAGgG;AAChG;;GAEG;AAMH,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE1C;GACG;AACH,MAAM,OAAO,iBAAkB,SAAQ,UAAU;IAC/C;;OAEG;IACH,YAAmB,GAAY;QAC7B,KAAK,CAAC,GAAG,CAAC,CAAC;IACb,CAAC;IAED;;;QAGI;IACG,KAAK,CAAC,cAAc,CACzB,WAAwB;QAExB,MAAM,GAAG,GAAG,GAAG,IAAI,CAAC,QAAQ,cAAc,CAAC;QAC3C,OAAO,IAAI,CAAC,qBAAqB,CAAC,WAAW,EAAE,KAAK,EAAE,GAAG,EAAE,SAAS,EAAE,aAAa,CAAC,CAAC;IACvF,CAAC;IAED;;;;QAII;IACG,KAAK,CAAC,mBAAmB,CAC9B,WAAwB,EACxB,OAAe;QAEf,MAAM,GAAG,GAAG,GAAG,IAAI,CAAC,QAAQ,IAAI,OAAO,cAAc,CAAC;QACtD,OAAO,IAAI,CAAC,qBAAqB,CAAC,WAAW,EAAE,KAAK,EAAE,GAAG,EAAE,SAAS,EAAE,aAAa,CAAC,CAAC;IACvF,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\n\r\nimport type { AccessToken } from \"@itwin/core-bentley\";\r\nimport type { IPermissionsClient } from \"../accessControlClientInterfaces/PermissionsClient\";\r\nimport type { BentleyAPIResponse } from \"../types/CommonApiTypes\";\r\nimport type { Permission } from \"../types/Permission\";\r\nimport { BaseClient } from \"./BaseClient\";\r\n\r\n/** Client API to perform iTwin permission operations.\r\n */\r\nexport class PermissionsClient extends BaseClient implements IPermissionsClient{\r\n  /** Create a new PermissionsClient instance\r\n   * @param url Optional base URL for the access control service. If not provided, defaults to base url.\r\n   */\r\n  public constructor(url?: string) {\r\n    super(url);\r\n  }\r\n\r\n  /** Retrieves the list of all available permissions\r\n    * @param accessToken The client access token string\r\n    * @returns Array of permissions\r\n    */\r\n  public async getPermissions(\r\n    accessToken: AccessToken,\r\n  ): Promise<BentleyAPIResponse<Permission[]>>{\r\n    const url = `${this._baseUrl}/permissions`;\r\n    return this.sendGenericAPIRequest(accessToken, \"GET\", url, undefined, \"permissions\");\r\n  }\r\n\r\n  /** Retrieves a list of permissions the identity has for a specified iTwin\r\n    * @param accessToken The client access token string\r\n    * @param iTwinId The id of the iTwin\r\n    * @returns Array of permissions\r\n    */\r\n  public async getITwinPermissions(\r\n    accessToken: AccessToken,\r\n    iTwinId: string,\r\n  ): Promise<BentleyAPIResponse<Permission[]>>{\r\n    const url = `${this._baseUrl}/${iTwinId}/permissions`;\r\n    return this.sendGenericAPIRequest(accessToken, \"GET\", url, undefined, \"permissions\");\r\n  }\r\n}\r\n"]}

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

@@ -2,38 +2,43 @@
  * @module AccessControlClient
  */
 import type { AccessToken } from "@itwin/core-bentley";
-import type { AccessControlAPIResponse, IRolesClient, Role } from "../accessControlTypes";
+import type { IRolesClient } from "../accessControlClientInterfaces/RolesClient";
+import type { BentleyAPIResponse } from "../types/CommonApiTypes";
+import type { Role } from "../types/Role";
 import { BaseClient } from "./BaseClient";
+/** Client API to perform iTwin role operations.
+ */
 export declare class RolesClient extends BaseClient implements IRolesClient {
+    /** Create a new RolesClient instance
+     * @param url Optional base URL for the access control service. If not provided, defaults to base url.
+     */
     constructor(url?: string);
     /** Retrieves a list of available user roles that are defined for a specified iTwin
       * @param accessToken The client access token string
       * @param iTwinId The id of the iTwin
       * @returns Roles
       */
-    getITwinRolesAsync(accessToken: AccessToken, iTwinId: string, additionalHeaders?: {
-        [key: string]: string;
-    }): Promise<AccessControlAPIResponse<Role[]>>;
+    getITwinRoles(accessToken: AccessToken, iTwinId: string): Promise<BentleyAPIResponse<Role[]>>;
     /** Retrieves the specified role for the specified iTwin
       * @param accessToken The client access token string
       * @param iTwinId The id of the iTwin
       * @returns Role
       */
-    getITwinRoleAsync(accessToken: AccessToken, iTwinId: string, roleId: string): Promise<AccessControlAPIResponse<Role>>;
+    getITwinRole(accessToken: AccessToken, iTwinId: string, roleId: string): Promise<BentleyAPIResponse<Role>>;
     /** Creates a new iTwin Role
       * @param accessToken The client access token string
       * @param iTwinId The id of the iTwin
       * @param role The role to be created
       * @returns Role
       */
-    createITwinRoleAsync(accessToken: AccessToken, iTwinId: string, role: Role): Promise<AccessControlAPIResponse<Role>>;
+    createITwinRole(accessToken: AccessToken, iTwinId: string, role: Pick<Role, "displayName" | "description">): Promise<BentleyAPIResponse<Pick<Role, "id" | "displayName" | "description">>>;
     /** Delete the specified iTwin role
       * @param accessToken The client access token string
       * @param iTwinId The id of the iTwin
       * @param roleId The id of the role to remove
       * @returns No Content
       */
-    deleteITwinRoleAsync(accessToken: AccessToken, iTwinId: string, roleId: string): Promise<AccessControlAPIResponse<undefined>>;
+    deleteITwinRole(accessToken: AccessToken, iTwinId: string, roleId: string): Promise<BentleyAPIResponse<undefined>>;
     /** Update the specified iTwin role
       * @param accessToken The client access token string
       * @param iTwinId The id of the iTwin
@@ -41,6 +46,6 @@ export declare class RolesClient extends BaseClient implements IRolesClient {
       * @param role The updated role
       * @returns Role
       */
-    updateITwinRoleAsync(accessToken: AccessToken, iTwinId: string, roleId: string, role: Role): Promise<AccessControlAPIResponse<Role>>;
+    updateITwinRole(accessToken: AccessToken, iTwinId: string, roleId: string, role: Partial<Omit<Role, "id">>): Promise<BentleyAPIResponse<Role>>;
 }
 //# sourceMappingURL=RolesClient.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"RolesClient.d.ts","sourceRoot":"","sources":["../../../src/subClients/RolesClient.ts"],"names":[],"mappings":"AAIA;;GAEG;AACH,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAC;AACvD,OAAO,KAAK,EAAE,wBAAwB,EAAE,YAAY,EAAE,IAAI,EAAE,MAAM,uBAAuB,CAAC;AAC1F,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE1C,qBAAa,WAAY,SAAQ,UAAW,YAAW,YAAY;gBAC9C,GAAG,CAAC,EAAE,MAAM;IAI/B;;;;QAII;IACS,kBAAkB,CAC7B,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;IAK5C;;;;QAII;IACS,iBAAiB,CAC5B,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,MAAM,EACf,MAAM,EAAE,MAAM,GACb,OAAO,CAAC,wBAAwB,CAAC,IAAI,CAAC,CAAC;IAK1C;;;;;QAKI;IACS,oBAAoB,CAC/B,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,MAAM,EACf,IAAI,EAAE,IAAI,GACT,OAAO,CAAC,wBAAwB,CAAC,IAAI,CAAC,CAAC;IAK1C;;;;;QAKI;IACS,oBAAoB,CAC/B,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,MAAM,EACf,MAAM,EAAE,MAAM,GACb,OAAO,CAAC,wBAAwB,CAAC,SAAS,CAAC,CAAC;IAK/C;;;;;;QAMI;IACS,oBAAoB,CAC/B,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,MAAM,EACf,MAAM,EAAE,MAAM,EACd,IAAI,EAAE,IAAI,GACT,OAAO,CAAC,wBAAwB,CAAC,IAAI,CAAC,CAAC;CAI3C"}
+{"version":3,"file":"RolesClient.d.ts","sourceRoot":"","sources":["../../../src/subClients/RolesClient.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAC;AACvD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,8CAA8C,CAAC;AACjF,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,yBAAyB,CAAC;AAClE,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,eAAe,CAAC;AAC1C,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAG1C;GACG;AACH,qBAAa,WAAY,SAAQ,UAAW,YAAW,YAAY;IACjE;;OAEG;gBACgB,GAAG,CAAC,EAAE,MAAM;IAI/B;;;;QAII;IACS,aAAa,CACxB,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,MAAM,GACd,OAAO,CAAC,kBAAkB,CAAC,IAAI,EAAE,CAAC,CAAC;IAKtC;;;;QAII;IACS,YAAY,CACvB,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,MAAM,EACf,MAAM,EAAE,MAAM,GACb,OAAO,CAAC,kBAAkB,CAAC,IAAI,CAAC,CAAC;IAKpC;;;;;QAKI;IACS,eAAe,CAC1B,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,MAAM,EACf,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE,aAAa,GAAG,aAAa,CAAC,GAC9C,OAAO,CAAC,kBAAkB,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,GAAG,aAAa,GAAG,aAAa,CAAC,CAAC,CAAC;IAKhF;;;;;QAKI;IACS,eAAe,CAC1B,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,MAAM,EACf,MAAM,EAAE,MAAM,GACb,OAAO,CAAC,kBAAkB,CAAC,SAAS,CAAC,CAAC;IAKzC;;;;;;QAMI;IACS,eAAe,CAC1B,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,MAAM,EACf,MAAM,EAAE,MAAM,EACd,IAAI,EAAE,OAAO,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC,GAC9B,OAAO,CAAC,kBAAkB,CAAC,IAAI,CAAC,CAAC;CAIrC"}

package/lib/esm/subClients/RolesClient.js

@@ -1,5 +1,17 @@
+/*---------------------------------------------------------------------------------------------
+ * 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
+ */
 import { BaseClient } from "./BaseClient";
+/** Client API to perform iTwin role operations.
+ */
 export class RolesClient extends BaseClient {
+    /** Create a new RolesClient instance
+     * @param url Optional base URL for the access control service. If not provided, defaults to base url.
+     */
     constructor(url) {
         super(url);
     }
@@ -8,16 +20,16 @@ export class RolesClient extends BaseClient {
       * @param iTwinId The id of the iTwin
       * @returns Roles
       */
-    async getITwinRolesAsync(accessToken, iTwinId, additionalHeaders) {
+    async getITwinRoles(accessToken, iTwinId) {
         const url = `${this._baseUrl}/${iTwinId}/roles`;
-        return this.sendGenericAPIRequest(accessToken, "GET", url, undefined, "roles", additionalHeaders);
+        return this.sendGenericAPIRequest(accessToken, "GET", url, undefined, "roles");
     }
     /** Retrieves the specified role for the specified iTwin
       * @param accessToken The client access token string
       * @param iTwinId The id of the iTwin
       * @returns Role
       */
-    async getITwinRoleAsync(accessToken, iTwinId, roleId) {
+    async getITwinRole(accessToken, iTwinId, roleId) {
         const url = `${this._baseUrl}/${iTwinId}/roles/${roleId}`;
         return this.sendGenericAPIRequest(accessToken, "GET", url, undefined, "role");
     }
@@ -27,7 +39,7 @@ export class RolesClient extends BaseClient {
       * @param role The role to be created
       * @returns Role
       */
-    async createITwinRoleAsync(accessToken, iTwinId, role) {
+    async createITwinRole(accessToken, iTwinId, role) {
         const url = `${this._baseUrl}/${iTwinId}/roles`;
         return this.sendGenericAPIRequest(accessToken, "POST", url, role, "role");
     }
@@ -37,7 +49,7 @@ export class RolesClient extends BaseClient {
       * @param roleId The id of the role to remove
       * @returns No Content
       */
-    async deleteITwinRoleAsync(accessToken, iTwinId, roleId) {
+    async deleteITwinRole(accessToken, iTwinId, roleId) {
         const url = `${this._baseUrl}/${iTwinId}/roles/${roleId}`;
         return this.sendGenericAPIRequest(accessToken, "DELETE", url);
     }
@@ -48,7 +60,7 @@ export class RolesClient extends BaseClient {
       * @param role The updated role
       * @returns Role
       */
-    async updateITwinRoleAsync(accessToken, iTwinId, roleId, role) {
+    async updateITwinRole(accessToken, iTwinId, roleId, role) {
         const url = `${this._baseUrl}/${iTwinId}/roles/${roleId}`;
         return this.sendGenericAPIRequest(accessToken, "PATCH", url, role, "role");
     }

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

@@ -1 +1 @@
-{"version":3,"file":"RolesClient.js","sourceRoot":"","sources":["../../../src/subClients/RolesClient.ts"],"names":[],"mappings":"AASA,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE1C,MAAM,OAAO,WAAY,SAAQ,UAAU;IACzC,YAAmB,GAAY;QAC7B,KAAK,CAAC,GAAG,CAAC,CAAC;IACb,CAAC;IAED;;;;QAII;IACG,KAAK,CAAC,kBAAkB,CAC7B,WAAwB,EACxB,OAAe,EACf,iBAA6C;QAE7C,MAAM,GAAG,GAAG,GAAG,IAAI,CAAC,QAAQ,IAAI,OAAO,QAAQ,CAAC;QAChD,OAAO,IAAI,CAAC,qBAAqB,CAAC,WAAW,EAAE,KAAK,EAAE,GAAG,EAAE,SAAS,EAAE,OAAO,EAAE,iBAAiB,CAAC,CAAC;IACpG,CAAC;IAED;;;;QAII;IACG,KAAK,CAAC,iBAAiB,CAC5B,WAAwB,EACxB,OAAe,EACf,MAAc;QAEd,MAAM,GAAG,GAAG,GAAG,IAAI,CAAC,QAAQ,IAAI,OAAO,UAAU,MAAM,EAAE,CAAC;QAC1D,OAAO,IAAI,CAAC,qBAAqB,CAAC,WAAW,EAAE,KAAK,EAAE,GAAG,EAAE,SAAS,EAAE,MAAM,CAAC,CAAC;IAChF,CAAC;IAED;;;;;QAKI;IACG,KAAK,CAAC,oBAAoB,CAC/B,WAAwB,EACxB,OAAe,EACf,IAAU;QAEV,MAAM,GAAG,GAAG,GAAG,IAAI,CAAC,QAAQ,IAAI,OAAO,QAAQ,CAAC;QAChD,OAAO,IAAI,CAAC,qBAAqB,CAAC,WAAW,EAAE,MAAM,EAAE,GAAG,EAAE,IAAI,EAAE,MAAM,CAAC,CAAC;IAC5E,CAAC;IAED;;;;;QAKI;IACG,KAAK,CAAC,oBAAoB,CAC/B,WAAwB,EACxB,OAAe,EACf,MAAc;QAEd,MAAM,GAAG,GAAG,GAAG,IAAI,CAAC,QAAQ,IAAI,OAAO,UAAU,MAAM,EAAE,CAAC;QAC1D,OAAO,IAAI,CAAC,qBAAqB,CAAC,WAAW,EAAE,QAAQ,EAAE,GAAG,CAAC,CAAC;IAChE,CAAC;IAED;;;;;;QAMI;IACG,KAAK,CAAC,oBAAoB,CAC/B,WAAwB,EACxB,OAAe,EACf,MAAc,EACd,IAAU;QAEV,MAAM,GAAG,GAAG,GAAG,IAAI,CAAC,QAAQ,IAAI,OAAO,UAAU,MAAM,EAAE,CAAC;QAC1D,OAAO,IAAI,CAAC,qBAAqB,CAAC,WAAW,EAAE,OAAO,EAAE,GAAG,EAAE,IAAI,EAAE,MAAM,CAAC,CAAC;IAC7E,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, IRolesClient, Role } from \"../accessControlTypes\";\r\nimport { BaseClient } from \"./BaseClient\";\r\n\r\nexport class RolesClient extends BaseClient implements IRolesClient {\r\n  public constructor(url?: string) {\r\n    super(url);\r\n  }\r\n\r\n  /** Retrieves a list of available user roles that are defined for a specified iTwin\r\n    * @param accessToken The client access token string\r\n    * @param iTwinId The id of the iTwin\r\n    * @returns Roles\r\n    */\r\n  public async getITwinRolesAsync(\r\n    accessToken: AccessToken,\r\n    iTwinId: string,\r\n    additionalHeaders?: { [key: string]: string }\r\n  ): Promise<AccessControlAPIResponse<Role[]>> {\r\n    const url = `${this._baseUrl}/${iTwinId}/roles`;\r\n    return this.sendGenericAPIRequest(accessToken, \"GET\", url, undefined, \"roles\", additionalHeaders);\r\n  }\r\n\r\n  /** Retrieves the specified role for the specified iTwin\r\n    * @param accessToken The client access token string\r\n    * @param iTwinId The id of the iTwin\r\n    * @returns Role\r\n    */\r\n  public async getITwinRoleAsync(\r\n    accessToken: AccessToken,\r\n    iTwinId: string,\r\n    roleId: string,\r\n  ): Promise<AccessControlAPIResponse<Role>> {\r\n    const url = `${this._baseUrl}/${iTwinId}/roles/${roleId}`;\r\n    return this.sendGenericAPIRequest(accessToken, \"GET\", url, undefined, \"role\");\r\n  }\r\n\r\n  /** Creates a new iTwin Role\r\n    * @param accessToken The client access token string\r\n    * @param iTwinId The id of the iTwin\r\n    * @param role The role to be created\r\n    * @returns Role\r\n    */\r\n  public async createITwinRoleAsync(\r\n    accessToken: AccessToken,\r\n    iTwinId: string,\r\n    role: Role\r\n  ): Promise<AccessControlAPIResponse<Role>> {\r\n    const url = `${this._baseUrl}/${iTwinId}/roles`;\r\n    return this.sendGenericAPIRequest(accessToken, \"POST\", url, role, \"role\");\r\n  }\r\n\r\n  /** Delete the specified iTwin role\r\n    * @param accessToken The client access token string\r\n    * @param iTwinId The id of the iTwin\r\n    * @param roleId The id of the role to remove\r\n    * @returns No Content\r\n    */\r\n  public async deleteITwinRoleAsync(\r\n    accessToken: AccessToken,\r\n    iTwinId: string,\r\n    roleId: string,\r\n  ): Promise<AccessControlAPIResponse<undefined>> {\r\n    const url = `${this._baseUrl}/${iTwinId}/roles/${roleId}`;\r\n    return this.sendGenericAPIRequest(accessToken, \"DELETE\", url);\r\n  }\r\n\r\n  /** Update the specified iTwin role\r\n    * @param accessToken The client access token string\r\n    * @param iTwinId The id of the iTwin\r\n    * @param roleId The id of the role to update\r\n    * @param role The updated role\r\n    * @returns Role\r\n    */\r\n  public async updateITwinRoleAsync(\r\n    accessToken: AccessToken,\r\n    iTwinId: string,\r\n    roleId: string,\r\n    role: Role\r\n  ): Promise<AccessControlAPIResponse<Role>> {\r\n    const url = `${this._baseUrl}/${iTwinId}/roles/${roleId}`;\r\n    return this.sendGenericAPIRequest(accessToken, \"PATCH\", url, role, \"role\");\r\n  }\r\n}\r\n"]}
+{"version":3,"file":"RolesClient.js","sourceRoot":"","sources":["../../../src/subClients/RolesClient.ts"],"names":[],"mappings":"AAAA;;;gGAGgG;AAChG;;GAEG;AAMH,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAG1C;GACG;AACH,MAAM,OAAO,WAAY,SAAQ,UAAU;IACzC;;OAEG;IACH,YAAmB,GAAY;QAC7B,KAAK,CAAC,GAAG,CAAC,CAAC;IACb,CAAC;IAED;;;;QAII;IACG,KAAK,CAAC,aAAa,CACxB,WAAwB,EACxB,OAAe;QAEf,MAAM,GAAG,GAAG,GAAG,IAAI,CAAC,QAAQ,IAAI,OAAO,QAAQ,CAAC;QAChD,OAAO,IAAI,CAAC,qBAAqB,CAAC,WAAW,EAAE,KAAK,EAAE,GAAG,EAAE,SAAS,EAAE,OAAO,CAAC,CAAC;IACjF,CAAC;IAED;;;;QAII;IACG,KAAK,CAAC,YAAY,CACvB,WAAwB,EACxB,OAAe,EACf,MAAc;QAEd,MAAM,GAAG,GAAG,GAAG,IAAI,CAAC,QAAQ,IAAI,OAAO,UAAU,MAAM,EAAE,CAAC;QAC1D,OAAO,IAAI,CAAC,qBAAqB,CAAC,WAAW,EAAE,KAAK,EAAE,GAAG,EAAE,SAAS,EAAE,MAAM,CAAC,CAAC;IAChF,CAAC;IAED;;;;;QAKI;IACG,KAAK,CAAC,eAAe,CAC1B,WAAwB,EACxB,OAAe,EACf,IAA+C;QAE/C,MAAM,GAAG,GAAG,GAAG,IAAI,CAAC,QAAQ,IAAI,OAAO,QAAQ,CAAC;QAChD,OAAO,IAAI,CAAC,qBAAqB,CAAC,WAAW,EAAE,MAAM,EAAE,GAAG,EAAE,IAAI,EAAE,MAAM,CAAC,CAAC;IAC5E,CAAC;IAED;;;;;QAKI;IACG,KAAK,CAAC,eAAe,CAC1B,WAAwB,EACxB,OAAe,EACf,MAAc;QAEd,MAAM,GAAG,GAAG,GAAG,IAAI,CAAC,QAAQ,IAAI,OAAO,UAAU,MAAM,EAAE,CAAC;QAC1D,OAAO,IAAI,CAAC,qBAAqB,CAAC,WAAW,EAAE,QAAQ,EAAE,GAAG,CAAC,CAAC;IAChE,CAAC;IAED;;;;;;QAMI;IACG,KAAK,CAAC,eAAe,CAC1B,WAAwB,EACxB,OAAe,EACf,MAAc,EACd,IAA+B;QAE/B,MAAM,GAAG,GAAG,GAAG,IAAI,CAAC,QAAQ,IAAI,OAAO,UAAU,MAAM,EAAE,CAAC;QAC1D,OAAO,IAAI,CAAC,qBAAqB,CAAC,WAAW,EAAE,OAAO,EAAE,GAAG,EAAE,IAAI,EAAE,MAAM,CAAC,CAAC;IAC7E,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\n\r\nimport type { AccessToken } from \"@itwin/core-bentley\";\r\nimport type { IRolesClient } from \"../accessControlClientInterfaces/RolesClient\";\r\nimport type { BentleyAPIResponse } from \"../types/CommonApiTypes\";\r\nimport type { Role } from \"../types/Role\";\r\nimport { BaseClient } from \"./BaseClient\";\r\n\r\n\r\n/** Client API to perform iTwin role operations.\r\n */\r\nexport class RolesClient extends BaseClient implements IRolesClient {\r\n  /** Create a new RolesClient instance\r\n   * @param url Optional base URL for the access control service. If not provided, defaults to base url.\r\n   */\r\n  public constructor(url?: string) {\r\n    super(url);\r\n  }\r\n\r\n  /** Retrieves a list of available user roles that are defined for a specified iTwin\r\n    * @param accessToken The client access token string\r\n    * @param iTwinId The id of the iTwin\r\n    * @returns Roles\r\n    */\r\n  public async getITwinRoles(\r\n    accessToken: AccessToken,\r\n    iTwinId: string,\r\n  ): Promise<BentleyAPIResponse<Role[]>> {\r\n    const url = `${this._baseUrl}/${iTwinId}/roles`;\r\n    return this.sendGenericAPIRequest(accessToken, \"GET\", url, undefined, \"roles\");\r\n  }\r\n\r\n  /** Retrieves the specified role for the specified iTwin\r\n    * @param accessToken The client access token string\r\n    * @param iTwinId The id of the iTwin\r\n    * @returns Role\r\n    */\r\n  public async getITwinRole(\r\n    accessToken: AccessToken,\r\n    iTwinId: string,\r\n    roleId: string,\r\n  ): Promise<BentleyAPIResponse<Role>> {\r\n    const url = `${this._baseUrl}/${iTwinId}/roles/${roleId}`;\r\n    return this.sendGenericAPIRequest(accessToken, \"GET\", url, undefined, \"role\");\r\n  }\r\n\r\n  /** Creates a new iTwin Role\r\n    * @param accessToken The client access token string\r\n    * @param iTwinId The id of the iTwin\r\n    * @param role The role to be created\r\n    * @returns Role\r\n    */\r\n  public async createITwinRole(\r\n    accessToken: AccessToken,\r\n    iTwinId: string,\r\n    role: Pick<Role, \"displayName\" | \"description\">\r\n  ): Promise<BentleyAPIResponse<Pick<Role, \"id\" | \"displayName\" | \"description\">>> {\r\n    const url = `${this._baseUrl}/${iTwinId}/roles`;\r\n    return this.sendGenericAPIRequest(accessToken, \"POST\", url, role, \"role\");\r\n  }\r\n\r\n  /** Delete the specified iTwin role\r\n    * @param accessToken The client access token string\r\n    * @param iTwinId The id of the iTwin\r\n    * @param roleId The id of the role to remove\r\n    * @returns No Content\r\n    */\r\n  public async deleteITwinRole(\r\n    accessToken: AccessToken,\r\n    iTwinId: string,\r\n    roleId: string,\r\n  ): Promise<BentleyAPIResponse<undefined>> {\r\n    const url = `${this._baseUrl}/${iTwinId}/roles/${roleId}`;\r\n    return this.sendGenericAPIRequest(accessToken, \"DELETE\", url);\r\n  }\r\n\r\n  /** Update the specified iTwin role\r\n    * @param accessToken The client access token string\r\n    * @param iTwinId The id of the iTwin\r\n    * @param roleId The id of the role to update\r\n    * @param role The updated role\r\n    * @returns Role\r\n    */\r\n  public async updateITwinRole(\r\n    accessToken: AccessToken,\r\n    iTwinId: string,\r\n    roleId: string,\r\n    role: Partial<Omit<Role, \"id\">>\r\n  ): Promise<BentleyAPIResponse<Role>> {\r\n    const url = `${this._baseUrl}/${iTwinId}/roles/${roleId}`;\r\n    return this.sendGenericAPIRequest(accessToken, \"PATCH\", url, role, \"role\");\r\n  }\r\n}\r\n"]}

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

@@ -2,23 +2,30 @@
  * @module AccessControlClient
  */
 import type { AccessToken } from "@itwin/core-bentley";
-import type { AccessControlAPIResponse, AccessControlQueryArg, AddUserMember, AddUserMemberResponse, IUserMembersClient, UserMember } from "../accessControlTypes";
+import type { IUserMembersClient } from "../accessControlClientInterfaces/UserMembersClient";
+import type { BentleyAPIResponse, ODataQueryParams } from "../types/CommonApiTypes";
+import type { AddUserMember, AddUserMemberResponse, MultipleUserMembersResponse, SingleUserMemberResponse } from "../types/UserMembers";
 import { BaseClient } from "./BaseClient";
+/** Client API to perform user members operations.
+ */
 export declare class UserMembersClient extends BaseClient implements IUserMembersClient {
+    /** Create a new UserMembersClient instance
+     * @param url Optional base URL for the access control service. If not provided, defaults to base url.
+     */
     constructor(url?: string);
     /** Retrieves a list of iTwin user members and their roles assignments.
      * @param accessToken The client access token string
      * @param iTwinId The id of the iTwin
      * @returns Array of members
      */
-    queryITwinUserMembersAsync(accessToken: AccessToken, iTwinId: string, arg?: AccessControlQueryArg): Promise<AccessControlAPIResponse<UserMember[]>>;
+    queryITwinUserMembers(accessToken: AccessToken, iTwinId: string, arg?: Pick<ODataQueryParams, "top" | "skip">): Promise<BentleyAPIResponse<MultipleUserMembersResponse>>;
     /** Retrieves a specific user 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
      */
-    getITwinUserMemberAsync(accessToken: AccessToken, iTwinId: string, memberId: string): Promise<AccessControlAPIResponse<UserMember>>;
+    getITwinUserMember(accessToken: AccessToken, iTwinId: string, memberId: string): Promise<BentleyAPIResponse<SingleUserMemberResponse>>;
     /** Add new iTwin user members
      * @param accessToken The client access token string
      * @param iTwinId The id of the iTwin
@@ -26,14 +33,14 @@ export declare class UserMembersClient extends BaseClient implements IUserMember
      * @param customMessage Send custom message in welcome email when adding new members
      * @returns AddUserMemberResponse -- the added or invited user members
      */
-    addITwinUserMembersAsync(accessToken: AccessToken, iTwinId: string, newMembers: AddUserMember[], customMessage?: string): Promise<AccessControlAPIResponse<AddUserMemberResponse>>;
+    addITwinUserMembers(accessToken: AccessToken, iTwinId: string, newMembers: AddUserMember[], customMessage?: string): Promise<BentleyAPIResponse<AddUserMemberResponse>>;
     /** Remove the specified user 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
      */
-    removeITwinUserMemberAsync(accessToken: AccessToken, iTwinId: string, memberId: string): Promise<AccessControlAPIResponse<undefined>>;
+    removeITwinUserMember(accessToken: AccessToken, iTwinId: string, memberId: string): Promise<BentleyAPIResponse<undefined>>;
     /** Update iTwin user member roles
      * @param accessToken The client access token string
      * @param iTwinId The id of the iTwin
@@ -41,6 +48,6 @@ export declare class UserMembersClient extends BaseClient implements IUserMember
      * @param roleIds The ids of the roles to be assigned
      * @returns Member
      */
-    updateITwinUserMemberAsync(accessToken: AccessToken, iTwinId: string, memberId: string, roleIds: string[]): Promise<AccessControlAPIResponse<UserMember>>;
+    updateITwinUserMember(accessToken: AccessToken, iTwinId: string, memberId: string, roleIds: string[]): Promise<BentleyAPIResponse<SingleUserMemberResponse>>;
 }
 //# sourceMappingURL=UserMembersClient.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"UserMembersClient.d.ts","sourceRoot":"","sources":["../../../src/subClients/UserMembersClient.ts"],"names":[],"mappings":"AAIA;;GAEG;AACH,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAC;AACvD,OAAO,KAAK,EACV,wBAAwB,EACxB,qBAAqB,EACrB,aAAa,EACb,qBAAqB,EACrB,kBAAkB,EAClB,UAAU,EACX,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE1C,qBAAa,iBACX,SAAQ,UACR,YAAW,kBAAkB;gBACV,GAAG,CAAC,EAAE,MAAM;IAI/B;;;;OAIG;IACU,0BAA0B,CACrC,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,MAAM,EACf,GAAG,CAAC,EAAE,qBAAqB,GAC1B,OAAO,CAAC,wBAAwB,CAAC,UAAU,EAAE,CAAC,CAAC;IAgBlD;;;;;OAKG;IACU,uBAAuB,CAClC,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,MAAM,EACf,QAAQ,EAAE,MAAM,GACf,OAAO,CAAC,wBAAwB,CAAC,UAAU,CAAC,CAAC;IAWhD;;;;;;OAMG;IACU,wBAAwB,CACnC,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;IAc3D;;;;;OAKG;IACU,0BAA0B,CACrC,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,MAAM,EACf,QAAQ,EAAE,MAAM,GACf,OAAO,CAAC,wBAAwB,CAAC,SAAS,CAAC,CAAC;IAK/C;;;;;;OAMG;IACU,0BAA0B,CACrC,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,MAAM,EACf,QAAQ,EAAE,MAAM,EAChB,OAAO,EAAE,MAAM,EAAE,GAChB,OAAO,CAAC,wBAAwB,CAAC,UAAU,CAAC,CAAC;CAajD"}
+{"version":3,"file":"UserMembersClient.d.ts","sourceRoot":"","sources":["../../../src/subClients/UserMembersClient.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAC;AACvD,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,oDAAoD,CAAC;AAC7F,OAAO,KAAK,EAAE,kBAAkB,EAAE,gBAAgB,EAAE,MAAM,yBAAyB,CAAC;AACpF,OAAO,KAAK,EAAE,aAAa,EAAE,qBAAqB,EAAE,2BAA2B,EAAE,wBAAwB,EAAE,MAAM,sBAAsB,CAAC;AACxI,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE1C;GACG;AACH,qBAAa,iBACX,SAAQ,UACR,YAAW,kBAAkB;IAC7B;;OAEG;gBACgB,GAAG,CAAC,EAAE,MAAM;IAI/B;;;;OAIG;IACU,qBAAqB,CAChC,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,MAAM,EACf,GAAG,CAAC,EAAE,IAAI,CAAC,gBAAgB,EAAE,KAAK,GAAG,MAAM,CAAC,GAC3C,OAAO,CAAC,kBAAkB,CAAC,2BAA2B,CAAC,CAAC;IAe3D;;;;;OAKG;IACU,kBAAkB,CAC7B,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,MAAM,EACf,QAAQ,EAAE,MAAM,GACf,OAAO,CAAC,kBAAkB,CAAC,wBAAwB,CAAC,CAAC;IAUxD;;;;;;OAMG;IACU,mBAAmB,CAC9B,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,MAAM,EACf,UAAU,EAAE,aAAa,EAAE,EAC3B,aAAa,CAAC,EAAE,MAAM,GACrB,OAAO,CAAC,kBAAkB,CAAC,qBAAqB,CAAC,CAAC;IAcrD;;;;;OAKG;IACU,qBAAqB,CAChC,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,MAAM,EACf,QAAQ,EAAE,MAAM,GACf,OAAO,CAAC,kBAAkB,CAAC,SAAS,CAAC,CAAC;IAKzC;;;;;;OAMG;IACU,qBAAqB,CAChC,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,MAAM,EACf,QAAQ,EAAE,MAAM,EAChB,OAAO,EAAE,MAAM,EAAE,GAChB,OAAO,CAAC,kBAAkB,CAAC,wBAAwB,CAAC,CAAC;CAYzD"}

package/lib/esm/subClients/UserMembersClient.js

@@ -1,5 +1,17 @@
+/*---------------------------------------------------------------------------------------------
+ * 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
+ */
 import { BaseClient } from "./BaseClient";
+/** Client API to perform user members operations.
+ */
 export class UserMembersClient extends BaseClient {
+    /** Create a new UserMembersClient instance
+     * @param url Optional base URL for the access control service. If not provided, defaults to base url.
+     */
     constructor(url) {
         super(url);
     }
@@ -8,12 +20,12 @@ export class UserMembersClient extends BaseClient {
      * @param iTwinId The id of the iTwin
      * @returns Array of members
      */
-    async queryITwinUserMembersAsync(accessToken, iTwinId, arg) {
+    async queryITwinUserMembers(accessToken, iTwinId, arg) {
         let url = `${this._baseUrl}/${iTwinId}/members/users`;
         if (arg) {
-            url += `?${this.getQueryString(arg)}`;
+            url += `?${this.getQueryString(UserMembersClient.paginationParamMapping, { top: arg.top, skip: arg.skip })}`;
         }
-        return this.sendGenericAPIRequest(accessToken, "GET", url, undefined, "members"); // TODO: Consider how to handle paging
+        return this.sendGenericAPIRequest(accessToken, "GET", url, undefined);
     }
     /** Retrieves a specific user member for a specified iTwin.
      * @param accessToken The client access token string
@@ -21,9 +33,9 @@ export class UserMembersClient extends BaseClient {
      * @param memberId The id of the member
      * @returns Member
      */
-    async getITwinUserMemberAsync(accessToken, iTwinId, memberId) {
+    async getITwinUserMember(accessToken, iTwinId, memberId) {
         const url = `${this._baseUrl}/${iTwinId}/members/users/${memberId}`;
-        return this.sendGenericAPIRequest(accessToken, "GET", url, undefined, "member");
+        return this.sendGenericAPIRequest(accessToken, "GET", url, undefined);
     }
     /** Add new iTwin user members
      * @param accessToken The client access token string
@@ -32,7 +44,7 @@ export class UserMembersClient extends BaseClient {
      * @param customMessage Send custom message in welcome email when adding new members
      * @returns AddUserMemberResponse -- the added or invited user members
      */
-    async addITwinUserMembersAsync(accessToken, iTwinId, newMembers, customMessage) {
+    async addITwinUserMembers(accessToken, iTwinId, newMembers, customMessage) {
         const url = `${this._baseUrl}/${iTwinId}/members/users`;
         const body = {
             members: newMembers,
@@ -46,7 +58,7 @@ export class UserMembersClient extends BaseClient {
      * @param memberId The id of the member
      * @returns No Content
      */
-    async removeITwinUserMemberAsync(accessToken, iTwinId, memberId) {
+    async removeITwinUserMember(accessToken, iTwinId, memberId) {
         const url = `${this._baseUrl}/${iTwinId}/members/users/${memberId}`;
         return this.sendGenericAPIRequest(accessToken, "DELETE", url);
     }
@@ -57,12 +69,12 @@ export class UserMembersClient extends BaseClient {
      * @param roleIds The ids of the roles to be assigned
      * @returns Member
      */
-    async updateITwinUserMemberAsync(accessToken, iTwinId, memberId, roleIds) {
+    async updateITwinUserMember(accessToken, iTwinId, memberId, roleIds) {
         const url = `${this._baseUrl}/${iTwinId}/members/users/${memberId}`;
         const body = {
             roleIds,
         };
-        return this.sendGenericAPIRequest(accessToken, "PATCH", url, body, "member");
+        return this.sendGenericAPIRequest(accessToken, "PATCH", url, body);
     }
 }
 //# sourceMappingURL=UserMembersClient.js.map