@itwin/access-control-client 3.6.0 → 4.0.0

package/lib/cjs/subClients/ItwinShares.js

@@ -0,0 +1,77 @@
+"use strict";
+/*---------------------------------------------------------------------------------------------
+ * 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
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ITwinSharesClient = void 0;
+const BaseClient_1 = require("./BaseClient");
+/** Client API to perform iTwin share operations.
+ * @beta
+ */
+class ITwinSharesClient extends BaseClient_1.BaseClient {
+    /** Create a new ITwinSharesClient instance
+     * @param url Optional base URL for the access control service. If not provided, defaults to base url.
+     */
+    constructor(url) {
+        super(url);
+    }
+    /** Create a new iTwin share
+     * @param accessToken The client access token string
+     * @param iTwinId The id of the iTwin
+     * @param iTwinShare The details of the iTwin share to be created
+     * @remarks
+     * #### Create
+     * Creating an iTwin Share allows your iTwin to be publicly accessible, enabling anyone with the `shareKey` to view its data without needing to sign in. To use a share, take the value of the `shareKey` property and prepend it with the `Basic` prefix in the authorization header of your request.
+     *
+     * #### Share Contract
+     * Each share is governed by a share contract that specifies the APIs available for the share and its associated iTwin.
+     * Only an iTwin admin can create iTwin Shares, and only a maximum of 10 shares can be active at a time per application that created it.
+     * The share contract expires after 90 days unless a shorter expiration is specified in the request body, with 90 days being the maximum duration. If the expiration property in the request body is left empty, it will default to the maximum duration from the moment of creation.
+     * A share can be revoked at any time using the Revoke iTwin Share endpoint.
+     * @returns ITwin Share
+     * @beta
+     */
+    async createITwinShare(accessToken, iTwinId, iTwinShare) {
+        const url = `${this._baseUrl}/${iTwinId}/shares`;
+        return this.sendGenericAPIRequest(accessToken, "POST", url, iTwinShare);
+    }
+    /** Get iTwin share
+   * @param accessToken The client access token string
+   * @param iTwinId The id of the iTwin
+   * @param sharedId The id of the iTwin share to be retrieved
+   * @returns The iTwin share details
+   * @beta
+   */
+    async getITwinShare(accessToken, iTwinId, sharedId) {
+        const url = `${this._baseUrl}/${iTwinId}/shares/${sharedId}`;
+        return this.sendGenericAPIRequest(accessToken, "GET", url);
+    }
+    /** Get iTwin shares
+     * @param accessToken The client access token string
+     * @param iTwinId The id of the iTwin
+     * @param sharedId The id of the iTwin share to be retrieved
+     * @returns The iTwin share details
+     * @beta
+     */
+    async getITwinShares(accessToken, iTwinId) {
+        const url = `${this._baseUrl}/${iTwinId}/shares`;
+        return this.sendGenericAPIRequest(accessToken, "GET", url);
+    }
+    /** Revoke iTwin share
+   * @param accessToken The client access token string
+   * @param iTwinId The id of the iTwin
+   * @param sharedId The id of the iTwin share to be revoked
+   * @returns No Content
+   * @beta
+   */
+    async revokeITwinShare(accessToken, iTwinId, sharedId) {
+        const url = `${this._baseUrl}/${iTwinId}/shares/${sharedId}`;
+        return this.sendGenericAPIRequest(accessToken, "DELETE", url);
+    }
+}
+exports.ITwinSharesClient = ITwinSharesClient;
+//# sourceMappingURL=ItwinShares.js.map

package/lib/cjs/subClients/ItwinShares.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ItwinShares.js","sourceRoot":"","sources":["../../../src/subClients/ItwinShares.ts"],"names":[],"mappings":";AAAA;;;gGAGgG;AAChG;;GAEG;;;AAMH,6CAA0C;AAE1C;;GAEG;AACH,MAAa,iBACX,SAAQ,uBAAU;IAGlB;;OAEG;IACH,YAAmB,GAAY;QAC7B,KAAK,CAAC,GAAG,CAAC,CAAC;IACb,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACI,KAAK,CAAC,gBAAgB,CAC3B,WAAwB,EACxB,OAAe,EACf,UAAyF;QAEzF,MAAM,GAAG,GAAG,GAAG,IAAI,CAAC,QAAQ,IAAI,OAAO,SAAS,CAAC;QACjD,OAAO,IAAI,CAAC,qBAAqB,CAAC,WAAW,EAAE,MAAM,EAAE,GAAG,EAAE,UAAU,CAAC,CAAC;IAC1E,CAAC;IAEC;;;;;;KAMC;IACI,KAAK,CAAC,aAAa,CACxB,WAAwB,EACxB,OAAe,EACf,QAAgB;QAEhB,MAAM,GAAG,GAAG,GAAG,IAAI,CAAC,QAAQ,IAAI,OAAO,WAAW,QAAQ,EAAE,CAAC;QAC7D,OAAO,IAAI,CAAC,qBAAqB,CAAC,WAAW,EAAE,KAAK,EAAE,GAAG,CAAC,CAAC;IAC7D,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,cAAc,CACzB,WAAwB,EACxB,OAAe;QAEf,MAAM,GAAG,GAAG,GAAG,IAAI,CAAC,QAAQ,IAAI,OAAO,SAAS,CAAC;QACjD,OAAO,IAAI,CAAC,qBAAqB,CAAC,WAAW,EAAE,KAAK,EAAE,GAAG,CAAC,CAAC;IAC7D,CAAC;IAEC;;;;;;KAMC;IACI,KAAK,CAAC,gBAAgB,CAC3B,WAAwB,EACxB,OAAe,EACf,QAAgB;QAEhB,MAAM,GAAG,GAAG,GAAG,IAAI,CAAC,QAAQ,IAAI,OAAO,WAAW,QAAQ,EAAE,CAAC;QAC7D,OAAO,IAAI,CAAC,qBAAqB,CAAC,WAAW,EAAE,QAAQ,EAAE,GAAG,CAAC,CAAC;IAChE,CAAC;CAEF;AAnFD,8CAmFC","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 { IITwinSharesClient } from \"../accessControlClientInterfaces/ItwinSharesClient\";\nimport type { BentleyAPIResponse } from \"../types/CommonApiTypes\";\nimport type { MultiShareContractResponse, ShareContract, SingleShareContractResponse } from \"../types/ShareContract\";\nimport { BaseClient } from \"./BaseClient\";\n\n/** Client API to perform iTwin share operations.\n * @beta\n */\nexport class ITwinSharesClient\n  extends BaseClient\n  implements IITwinSharesClient\n{\n  /** Create a new ITwinSharesClient 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  /** Create a new iTwin share\n   * @param accessToken The client access token string\n   * @param iTwinId The id of the iTwin\n   * @param iTwinShare The details of the iTwin share to be created\n   * @remarks\n   * #### Create\n   * Creating an iTwin Share allows your iTwin to be publicly accessible, enabling anyone with the `shareKey` to view its data without needing to sign in. To use a share, take the value of the `shareKey` property and prepend it with the `Basic` prefix in the authorization header of your request.\n   *\n   * #### Share Contract\n   * Each share is governed by a share contract that specifies the APIs available for the share and its associated iTwin.\n   * Only an iTwin admin can create iTwin Shares, and only a maximum of 10 shares can be active at a time per application that created it.\n   * The share contract expires after 90 days unless a shorter expiration is specified in the request body, with 90 days being the maximum duration. If the expiration property in the request body is left empty, it will default to the maximum duration from the moment of creation.\n   * A share can be revoked at any time using the Revoke iTwin Share endpoint.\n   * @returns ITwin Share\n   * @beta\n   */\n  public async createITwinShare(\n    accessToken: AccessToken,\n    iTwinId: string,\n    iTwinShare: Partial<Pick<ShareContract, \"shareContract\"> & { expiration: string | null }>\n  ): Promise<BentleyAPIResponse<SingleShareContractResponse>> {\n    const url = `${this._baseUrl}/${iTwinId}/shares`;\n    return this.sendGenericAPIRequest(accessToken, \"POST\", url, iTwinShare);\n  }\n\n    /** Get iTwin share\n   * @param accessToken The client access token string\n   * @param iTwinId The id of the iTwin\n   * @param sharedId The id of the iTwin share to be retrieved\n   * @returns The iTwin share details\n   * @beta\n   */\n  public async getITwinShare(\n    accessToken: AccessToken,\n    iTwinId: string,\n    sharedId: string,\n  ): Promise<BentleyAPIResponse<SingleShareContractResponse>> {\n    const url = `${this._baseUrl}/${iTwinId}/shares/${sharedId}`;\n    return this.sendGenericAPIRequest(accessToken, \"GET\", url);\n  }\n\n  /** Get iTwin shares\n   * @param accessToken The client access token string\n   * @param iTwinId The id of the iTwin\n   * @param sharedId The id of the iTwin share to be retrieved\n   * @returns The iTwin share details\n   * @beta\n   */\n  public async getITwinShares(\n    accessToken: AccessToken,\n    iTwinId: string,\n  ): Promise<BentleyAPIResponse<MultiShareContractResponse>> {\n    const url = `${this._baseUrl}/${iTwinId}/shares`;\n    return this.sendGenericAPIRequest(accessToken, \"GET\", url);\n  }\n\n    /** Revoke iTwin share\n   * @param accessToken The client access token string\n   * @param iTwinId The id of the iTwin\n   * @param sharedId The id of the iTwin share to be revoked\n   * @returns No Content\n   * @beta\n   */\n  public async revokeITwinShare(\n    accessToken: AccessToken,\n    iTwinId: string,\n    sharedId: string,\n  ): Promise<BentleyAPIResponse<undefined>> {\n    const url = `${this._baseUrl}/${iTwinId}/shares/${sharedId}`;\n    return this.sendGenericAPIRequest(accessToken, \"DELETE\", url);\n  }\n\n}\n"]}

package/lib/cjs/subClients/MemberInvitationsClient.d.ts

@@ -2,16 +2,29 @@
  * @module AccessControlClient
  */
 import type { AccessToken } from "@itwin/core-bentley";
-import type { AccessControlAPIResponse, AccessControlQueryArg, IMemberInvitationsClient, MemberInvitation } from "../accessControlTypes";
+import type { IMemberInvitationsClient } from "../accessControlClientInterfaces/MemberInvitationsClient";
+import type { BentleyAPIResponse, ODataQueryParams } from "../types/CommonApiTypes";
+import type { MultipleMemberInvitationResponse } from "../types/Invitations";
 import { BaseClient } from "./BaseClient";
+/** Client API to perform iTwin member invitation operations.
+ */
 export declare class MemberInvitationsClient extends BaseClient implements IMemberInvitationsClient {
+    /** Create a new MemberInvitationsClient 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 member invitations.
      * @param accessToken The client access token string
      * @param iTwinId The id of the iTwin
      * @returns Array of member invitations
      */
-    queryITwinMemberInvitationsAsync(accessToken: AccessToken, iTwinId: string, arg?: AccessControlQueryArg): Promise<AccessControlAPIResponse<MemberInvitation[]>>;
-    deleteITwinMemberInvitationAsync(accessToken: AccessToken, iTwinId: string, invitationId: string): Promise<AccessControlAPIResponse<undefined>>;
+    queryITwinMemberInvitations(accessToken: AccessToken, iTwinId: string, arg?: Pick<ODataQueryParams, "top" | "skip">): Promise<BentleyAPIResponse<MultipleMemberInvitationResponse>>;
+    /** Deletes a member invitations.
+     * @param accessToken The client access token string
+     * @param iTwinId The id of the iTwin
+     * @param invitationId The id of the invitation id
+     * @returns No Content
+     */
+    deleteITwinMemberInvitation(accessToken: AccessToken, iTwinId: string, invitationId: string): Promise<BentleyAPIResponse<undefined>>;
 }
 //# sourceMappingURL=MemberInvitationsClient.d.ts.map

package/lib/cjs/subClients/MemberInvitationsClient.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"MemberInvitationsClient.d.ts","sourceRoot":"","sources":["../../../src/subClients/MemberInvitationsClient.ts"],"names":[],"mappings":"AAIA;;GAEG;AACH,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAC;AACvD,OAAO,KAAK,EACV,wBAAwB,EACxB,qBAAqB,EACrB,wBAAwB,EACxB,gBAAgB,EACjB,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE1C,qBAAa,uBACX,SAAQ,UACR,YAAW,wBAAwB;gBAChB,GAAG,CAAC,EAAE,MAAM;IAI/B;;;;OAIG;IACU,gCAAgC,CAC3C,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,MAAM,EACf,GAAG,CAAC,EAAE,qBAAqB,GAC1B,OAAO,CAAC,wBAAwB,CAAC,gBAAgB,EAAE,CAAC,CAAC;IAgB3C,gCAAgC,CAC3C,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,MAAM,EACf,YAAY,EAAE,MAAM,GACnB,OAAO,CAAC,wBAAwB,CAAC,SAAS,CAAC,CAAC;CAIhD"}
+{"version":3,"file":"MemberInvitationsClient.d.ts","sourceRoot":"","sources":["../../../src/subClients/MemberInvitationsClient.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAC;AACvD,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,0DAA0D,CAAC;AACzG,OAAO,KAAK,EAAE,kBAAkB,EAAE,gBAAgB,EAAE,MAAM,yBAAyB,CAAC;AACpF,OAAO,KAAK,EAAE,gCAAgC,EAAE,MAAM,sBAAsB,CAAC;AAC7E,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE1C;GACG;AACH,qBAAa,uBACX,SAAQ,UACR,YAAW,wBAAwB;IACnC;;OAEG;gBACgB,GAAG,CAAC,EAAE,MAAM;IAI/B;;;;OAIG;IACU,2BAA2B,CACtC,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,MAAM,EACf,GAAG,CAAC,EAAE,IAAI,CAAC,gBAAgB,EAAE,KAAK,GAAG,MAAM,CAAC,GAC3C,OAAO,CAAC,kBAAkB,CAAC,gCAAgC,CAAC,CAAC;IAahE;;;;;OAKG;IACU,2BAA2B,CACtC,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,MAAM,EACf,YAAY,EAAE,MAAM,GACnB,OAAO,CAAC,kBAAkB,CAAC,SAAS,CAAC,CAAC;CAI1C"}

package/lib/cjs/subClients/MemberInvitationsClient.js

@@ -1,8 +1,20 @@
 "use strict";
+/*---------------------------------------------------------------------------------------------
+ * 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
+ */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.MemberInvitationsClient = void 0;
 const BaseClient_1 = require("./BaseClient");
+/** Client API to perform iTwin member invitation operations.
+ */
 class MemberInvitationsClient extends BaseClient_1.BaseClient {
+    /** Create a new MemberInvitationsClient instance
+     * @param url Optional base URL for the access control service. If not provided, defaults to base url.
+     */
     constructor(url) {
         super(url);
     }
@@ -11,14 +23,17 @@ class MemberInvitationsClient extends BaseClient_1.BaseClient {
      * @param iTwinId The id of the iTwin
      * @returns Array of member invitations
      */
-    async queryITwinMemberInvitationsAsync(accessToken, iTwinId, arg) {
-        let url = `${this._baseUrl}/${iTwinId}/members/invitations`;
-        if (arg) {
-            url += `?${this.getQueryString(arg)}`;
-        }
-        return this.sendGenericAPIRequest(accessToken, "GET", url, undefined, "invitations");
+    async queryITwinMemberInvitations(accessToken, iTwinId, arg) {
+        const url = `${this._baseUrl}/${iTwinId}/members/invitations${arg ? `?${this.getQueryString(MemberInvitationsClient.paginationParamMapping, { top: arg.top, skip: arg.skip })}` : ''}`;
+        return this.sendGenericAPIRequest(accessToken, "GET", url, undefined);
     }
-    async deleteITwinMemberInvitationAsync(accessToken, iTwinId, invitationId) {
+    /** Deletes a member invitations.
+     * @param accessToken The client access token string
+     * @param iTwinId The id of the iTwin
+     * @param invitationId The id of the invitation id
+     * @returns No Content
+     */
+    async deleteITwinMemberInvitation(accessToken, iTwinId, invitationId) {
         const url = `${this._baseUrl}/${iTwinId}/members/invitations/${invitationId}`;
         return this.sendGenericAPIRequest(accessToken, "DELETE", url);
     }

package/lib/cjs/subClients/MemberInvitationsClient.js.map

@@ -1 +1 @@
-{"version":3,"file":"MemberInvitationsClient.js","sourceRoot":"","sources":["../../../src/subClients/MemberInvitationsClient.ts"],"names":[],"mappings":";;;AAcA,6CAA0C;AAE1C,MAAa,uBACX,SAAQ,uBAAU;IAElB,YAAmB,GAAY;QAC7B,KAAK,CAAC,GAAG,CAAC,CAAC;IACb,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,gCAAgC,CAC3C,WAAwB,EACxB,OAAe,EACf,GAA2B;QAE3B,IAAI,GAAG,GAAG,GAAG,IAAI,CAAC,QAAQ,IAAI,OAAO,sBAAsB,CAAC;QAE5D,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,aAAa,CACd,CAAC;IACJ,CAAC;IAEM,KAAK,CAAC,gCAAgC,CAC3C,WAAwB,EACxB,OAAe,EACf,YAAoB;QAEpB,MAAM,GAAG,GAAG,GAAG,IAAI,CAAC,QAAQ,IAAI,OAAO,wBAAwB,YAAY,EAAE,CAAC;QAC9E,OAAO,IAAI,CAAC,qBAAqB,CAAC,WAAW,EAAE,QAAQ,EAAE,GAAG,CAAC,CAAC;IAChE,CAAC;CACF;AAxCD,0DAwCC","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  IMemberInvitationsClient,\n  MemberInvitation,\n} from \"../accessControlTypes\";\nimport { BaseClient } from \"./BaseClient\";\n\nexport class MemberInvitationsClient\n  extends BaseClient\n  implements IMemberInvitationsClient {\n  public constructor(url?: string) {\n    super(url);\n  }\n\n  /** Retrieves a list of iTwin member invitations.\n   * @param accessToken The client access token string\n   * @param iTwinId The id of the iTwin\n   * @returns Array of member invitations\n   */\n  public async queryITwinMemberInvitationsAsync(\n    accessToken: AccessToken,\n    iTwinId: string,\n    arg?: AccessControlQueryArg\n  ): Promise<AccessControlAPIResponse<MemberInvitation[]>> {\n    let url = `${this._baseUrl}/${iTwinId}/members/invitations`;\n\n    if (arg) {\n      url += `?${this.getQueryString(arg)}`;\n    }\n\n    return this.sendGenericAPIRequest(\n      accessToken,\n      \"GET\",\n      url,\n      undefined,\n      \"invitations\"\n    );\n  }\n\n  public async deleteITwinMemberInvitationAsync(\n    accessToken: AccessToken,\n    iTwinId: string,\n    invitationId: string\n  ): Promise<AccessControlAPIResponse<undefined>> {\n    const url = `${this._baseUrl}/${iTwinId}/members/invitations/${invitationId}`;\n    return this.sendGenericAPIRequest(accessToken, \"DELETE\", url);\n  }\n}\n"]}
+{"version":3,"file":"MemberInvitationsClient.js","sourceRoot":"","sources":["../../../src/subClients/MemberInvitationsClient.ts"],"names":[],"mappings":";AAAA;;;gGAGgG;AAChG;;GAEG;;;AAMH,6CAA0C;AAE1C;GACG;AACH,MAAa,uBACX,SAAQ,uBAAU;IAElB;;OAEG;IACH,YAAmB,GAAY;QAC7B,KAAK,CAAC,GAAG,CAAC,CAAC;IACb,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,2BAA2B,CACtC,WAAwB,EACxB,OAAe,EACf,GAA4C;QAE5C,MAAM,GAAG,GAAG,GAAG,IAAI,CAAC,QAAQ,IAAI,OAAO,uBACrC,GAAG,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC,cAAc,CAAC,uBAAuB,CAAC,sBAAsB,EAAE,EAAE,GAAG,EAAE,GAAG,CAAC,GAAG,EAAE,IAAI,EAAE,GAAG,CAAC,IAAI,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,EACtH,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,2BAA2B,CACtC,WAAwB,EACxB,OAAe,EACf,YAAoB;QAEpB,MAAM,GAAG,GAAG,GAAG,IAAI,CAAC,QAAQ,IAAI,OAAO,wBAAwB,YAAY,EAAE,CAAC;QAC9E,OAAO,IAAI,CAAC,qBAAqB,CAAC,WAAW,EAAE,QAAQ,EAAE,GAAG,CAAC,CAAC;IAChE,CAAC;CACF;AA9CD,0DA8CC","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 { IMemberInvitationsClient } from \"../accessControlClientInterfaces/MemberInvitationsClient\";\nimport type { BentleyAPIResponse, ODataQueryParams } from \"../types/CommonApiTypes\";\nimport type { MultipleMemberInvitationResponse } from \"../types/Invitations\";\nimport { BaseClient } from \"./BaseClient\";\n\n/** Client API to perform iTwin member invitation operations.\n */\nexport class MemberInvitationsClient\n  extends BaseClient\n  implements IMemberInvitationsClient {\n  /** Create a new MemberInvitationsClient 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 member invitations.\n   * @param accessToken The client access token string\n   * @param iTwinId The id of the iTwin\n   * @returns Array of member invitations\n   */\n  public async queryITwinMemberInvitations(\n    accessToken: AccessToken,\n    iTwinId: string,\n    arg?: Pick<ODataQueryParams, \"top\" | \"skip\">\n  ): Promise<BentleyAPIResponse<MultipleMemberInvitationResponse>> {\n    const url = `${this._baseUrl}/${iTwinId}/members/invitations${\n      arg ? `?${this.getQueryString(MemberInvitationsClient.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  /** Deletes a member invitations.\n   * @param accessToken The client access token string\n   * @param iTwinId The id of the iTwin\n   * @param invitationId The id of the invitation id\n   * @returns No Content\n   */\n  public async deleteITwinMemberInvitation(\n    accessToken: AccessToken,\n    iTwinId: string,\n    invitationId: string\n  ): Promise<BentleyAPIResponse<undefined>> {\n    const url = `${this._baseUrl}/${iTwinId}/members/invitations/${invitationId}`;\n    return this.sendGenericAPIRequest(accessToken, \"DELETE\", url);\n  }\n}\n"]}

package/lib/cjs/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/cjs/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/cjs/subClients/OwnerMembersClient.js

@@ -1,30 +1,70 @@
 "use strict";
+/*---------------------------------------------------------------------------------------------
+ * 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
+ */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.OwnerMembersClient = void 0;
 const BaseClient_1 = require("./BaseClient");
+/** Client API to perform owner member operations.
+ */
 class OwnerMembersClient extends BaseClient_1.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);
     }
@@ -34,7 +74,7 @@ class OwnerMembersClient extends BaseClient_1.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/cjs/subClients/OwnerMembersClient.js.map

@@ -1 +1 @@
-{"version":3,"file":"OwnerMembersClient.js","sourceRoot":"","sources":["../../../src/subClients/OwnerMembersClient.ts"],"names":[],"mappings":";;;AAeA,6CAA0C;AAE1C,MAAa,kBACX,SAAQ,uBAAU;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;AAlED,gDAkEC","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,6CAA0C;AAE1C;GACG;AACH,MAAa,kBACX,SAAQ,uBAAU;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;AAjGD,gDAiGC","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/cjs/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/cjs/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/cjs/subClients/PermissionsClient.js

@@ -1,8 +1,20 @@
 "use strict";
+/*---------------------------------------------------------------------------------------------
+ * 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
+ */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.PermissionsClient = void 0;
 const BaseClient_1 = require("./BaseClient");
+/** Client API to perform iTwin permission operations.
+ */
 class PermissionsClient extends BaseClient_1.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);
     }
@@ -10,7 +22,7 @@ class PermissionsClient extends BaseClient_1.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");
     }
@@ -19,7 +31,7 @@ class PermissionsClient extends BaseClient_1.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/cjs/subClients/PermissionsClient.js.map

@@ -1 +1 @@
-{"version":3,"file":"PermissionsClient.js","sourceRoot":"","sources":["../../../src/subClients/PermissionsClient.ts"],"names":[],"mappings":";;;AASA,6CAA0C;AAE1C,MAAa,iBAAkB,SAAQ,uBAAU;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;AA5BD,8CA4BC","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,6CAA0C;AAE1C;GACG;AACH,MAAa,iBAAkB,SAAQ,uBAAU;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;AA/BD,8CA+BC","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/cjs/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/cjs/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"}