@itwin/access-control-client 3.6.0 → 4.0.0

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

@@ -2,37 +2,47 @@
  * @module AccessControlClient
  */
 import type { AccessToken } from "@itwin/core-bentley";
-import type { AccessControlAPIResponse, AccessControlQueryArg, AddGroupMember, GroupMember, IGroupMembersClient } from "../accessControlTypes";
+import type { IGroupMembersClient } from "../accessControlClientInterfaces/GroupMembersClient";
+import type { BentleyAPIResponse, ODataQueryParams } from "../types/CommonApiTypes";
+import type { GroupMemberAssignment, MultipleGroupMembersResponse, SingleGroupMemberResponse } from "../types/GroupMember";
+import type { Links } from "../types/links";
 import { BaseClient } from "./BaseClient";
+/** Client API to perform iTwin group members operations.
+ */
 export declare class GroupMembersClient extends BaseClient implements IGroupMembersClient {
+    /** Create a new GroupMembersClient 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 group members and their roles assignments.
      * @param accessToken The client access token string
      * @param iTwinId The id of the iTwin
      * @returns Array of members
      */
-    queryITwinGroupMembersAsync(accessToken: AccessToken, iTwinId: string, arg?: AccessControlQueryArg): Promise<AccessControlAPIResponse<GroupMember[]>>;
+    queryITwinGroupMembers(accessToken: AccessToken, iTwinId: string, arg?: Pick<ODataQueryParams, "top" | "skip">): Promise<BentleyAPIResponse<MultipleGroupMembersResponse & {
+        _links: Links;
+    }>>;
     /** Retrieves a specific group 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
      */
-    getITwinGroupMemberAsync(accessToken: AccessToken, iTwinId: string, memberId: string): Promise<AccessControlAPIResponse<GroupMember>>;
+    getITwinGroupMember(accessToken: AccessToken, iTwinId: string, memberId: string): Promise<BentleyAPIResponse<SingleGroupMemberResponse>>;
     /** Add new iTwin group members
      * @param accessToken The client access token string
      * @param iTwinId The id of the iTwin
      * @param newMembers The list of new members to be added along with their role
      * @returns Member[]
      */
-    addITwinGroupMembersAsync(accessToken: AccessToken, iTwinId: string, newMembers: AddGroupMember[]): Promise<AccessControlAPIResponse<GroupMember[]>>;
+    addITwinGroupMembers(accessToken: AccessToken, iTwinId: string, newMembers: GroupMemberAssignment): Promise<BentleyAPIResponse<MultipleGroupMembersResponse>>;
     /** Remove the specified group 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
      */
-    removeITwinGroupMemberAsync(accessToken: AccessToken, iTwinId: string, memberId: string): Promise<AccessControlAPIResponse<undefined>>;
+    removeITwinGroupMember(accessToken: AccessToken, iTwinId: string, memberId: string): Promise<BentleyAPIResponse<undefined>>;
     /** Update iTwin group member roles
      * @param accessToken The client access token string
      * @param iTwinId The id of the iTwin
@@ -40,6 +50,6 @@ export declare class GroupMembersClient extends BaseClient implements IGroupMemb
      * @param roleIds The ids of the roles to be assigned
      * @returns Member
      */
-    updateITwinGroupMemberAsync(accessToken: AccessToken, iTwinId: string, memberId: string, roleIds: string[]): Promise<AccessControlAPIResponse<GroupMember>>;
+    updateITwinGroupMember(accessToken: AccessToken, iTwinId: string, memberId: string, roleIds: string[]): Promise<BentleyAPIResponse<SingleGroupMemberResponse>>;
 }
 //# sourceMappingURL=GroupMembersClient.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"GroupMembersClient.d.ts","sourceRoot":"","sources":["../../../src/subClients/GroupMembersClient.ts"],"names":[],"mappings":"AAIA;;GAEG;AACH,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAC;AACvD,OAAO,KAAK,EACV,wBAAwB,EACxB,qBAAqB,EACrB,cAAc,EACd,WAAW,EACX,mBAAmB,EACpB,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,QAAQ,EAAE,MAAM,GACf,OAAO,CAAC,wBAAwB,CAAC,WAAW,CAAC,CAAC;IAWjD;;;;;OAKG;IACU,yBAAyB,CACpC,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,MAAM,EACf,UAAU,EAAE,cAAc,EAAE,GAC3B,OAAO,CAAC,wBAAwB,CAAC,WAAW,EAAE,CAAC,CAAC;IAcnD;;;;;OAKG;IACU,2BAA2B,CACtC,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,MAAM,EACf,QAAQ,EAAE,MAAM,GACf,OAAO,CAAC,wBAAwB,CAAC,SAAS,CAAC,CAAC;IAK/C;;;;;;OAMG;IACU,2BAA2B,CACtC,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,MAAM,EACf,QAAQ,EAAE,MAAM,EAChB,OAAO,EAAE,MAAM,EAAE,GAChB,OAAO,CAAC,wBAAwB,CAAC,WAAW,CAAC,CAAC;CAalD"}
+{"version":3,"file":"GroupMembersClient.d.ts","sourceRoot":"","sources":["../../../src/subClients/GroupMembersClient.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAC;AACvD,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,qDAAqD,CAAC;AAC/F,OAAO,KAAK,EAAE,kBAAkB,EAAE,gBAAgB,EAAE,MAAM,yBAAyB,CAAC;AACpF,OAAO,KAAK,EAAE,qBAAqB,EAAE,4BAA4B,EAAE,yBAAyB,EAAE,MAAM,sBAAsB,CAAC;AAC3H,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,gBAAgB,CAAC;AAC5C,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;;;;OAIG;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,4BAA4B,GAC1D;QAEA,MAAM,EAAE,KAAK,CAAA;KACZ,CACA,CAAC;IAeF;;;;;OAKG;IACU,mBAAmB,CAC9B,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,MAAM,EACf,QAAQ,EAAE,MAAM,GACf,OAAO,CAAC,kBAAkB,CAAC,yBAAyB,CAAC,CAAC;IAUzD;;;;;OAKG;IACU,oBAAoB,CAC/B,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,MAAM,EACf,UAAU,EAAE,qBAAqB,GAChC,OAAO,CAAC,kBAAkB,CAAC,4BAA4B,CAAC,CAAC;IAU5D;;;;;OAKG;IACU,sBAAsB,CACjC,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,MAAM,EACf,QAAQ,EAAE,MAAM,GACf,OAAO,CAAC,kBAAkB,CAAC,SAAS,CAAC,CAAC;IAKzC;;;;;;OAMG;IACU,sBAAsB,CACjC,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,MAAM,EACf,QAAQ,EAAE,MAAM,EAChB,OAAO,EAAE,MAAM,EAAE,GAChB,OAAO,CAAC,kBAAkB,CAAC,yBAAyB,CAAC,CAAC;CAY1D"}

package/lib/cjs/subClients/GroupMembersClient.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.GroupMembersClient = void 0;
 const BaseClient_1 = require("./BaseClient");
+/** Client API to perform iTwin group members operations.
+ */
 class GroupMembersClient extends BaseClient_1.BaseClient {
+    /** Create a new GroupMembersClient instance
+     * @param url Optional base URL for the access control service. If not provided, defaults to base url.
+     */
     constructor(url) {
         super(url);
     }
@@ -11,12 +23,12 @@ class GroupMembersClient extends BaseClient_1.BaseClient {
      * @param iTwinId The id of the iTwin
      * @returns Array of members
      */
-    async queryITwinGroupMembersAsync(accessToken, iTwinId, arg) {
+    async queryITwinGroupMembers(accessToken, iTwinId, arg) {
         let url = `${this._baseUrl}/${iTwinId}/members/groups`;
         if (arg) {
-            url += `?${this.getQueryString(arg)}`;
+            url += `?${this.getQueryString(GroupMembersClient.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 group member for a specified iTwin.
      * @param accessToken The client access token string
@@ -24,9 +36,9 @@ class GroupMembersClient extends BaseClient_1.BaseClient {
      * @param memberId The id of the member
      * @returns Member
      */
-    async getITwinGroupMemberAsync(accessToken, iTwinId, memberId) {
+    async getITwinGroupMember(accessToken, iTwinId, memberId) {
         const url = `${this._baseUrl}/${iTwinId}/members/groups/${memberId}`;
-        return this.sendGenericAPIRequest(accessToken, "GET", url, undefined, "member");
+        return this.sendGenericAPIRequest(accessToken, "GET", url, undefined);
     }
     /** Add new iTwin group members
      * @param accessToken The client access token string
@@ -34,12 +46,9 @@ class GroupMembersClient extends BaseClient_1.BaseClient {
      * @param newMembers The list of new members to be added along with their role
      * @returns Member[]
      */
-    async addITwinGroupMembersAsync(accessToken, iTwinId, newMembers) {
+    async addITwinGroupMembers(accessToken, iTwinId, newMembers) {
         const url = `${this._baseUrl}/${iTwinId}/members/groups`;
-        const body = {
-            members: newMembers,
-        };
-        return this.sendGenericAPIRequest(accessToken, "POST", url, body, "members");
+        return this.sendGenericAPIRequest(accessToken, "POST", url, newMembers);
     }
     /** Remove the specified group member from the iTwin
      * @param accessToken The client access token string
@@ -47,7 +56,7 @@ class GroupMembersClient extends BaseClient_1.BaseClient {
      * @param memberId The id of the member
      * @returns No Content
      */
-    async removeITwinGroupMemberAsync(accessToken, iTwinId, memberId) {
+    async removeITwinGroupMember(accessToken, iTwinId, memberId) {
         const url = `${this._baseUrl}/${iTwinId}/members/groups/${memberId}`;
         return this.sendGenericAPIRequest(accessToken, "DELETE", url);
     }
@@ -58,12 +67,12 @@ class GroupMembersClient extends BaseClient_1.BaseClient {
      * @param roleIds The ids of the roles to be assigned
      * @returns Member
      */
-    async updateITwinGroupMemberAsync(accessToken, iTwinId, memberId, roleIds) {
+    async updateITwinGroupMember(accessToken, iTwinId, memberId, roleIds) {
         const url = `${this._baseUrl}/${iTwinId}/members/groups/${memberId}`;
         const body = {
             roleIds,
         };
-        return this.sendGenericAPIRequest(accessToken, "PATCH", url, body, "member");
+        return this.sendGenericAPIRequest(accessToken, "PATCH", url, body);
     }
 }
 exports.GroupMembersClient = GroupMembersClient;

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

@@ -1 +1 @@
-{"version":3,"file":"GroupMembersClient.js","sourceRoot":"","sources":["../../../src/subClients/GroupMembersClient.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,QAAgB;QAEhB,MAAM,GAAG,GAAG,GAAG,IAAI,CAAC,QAAQ,IAAI,OAAO,mBAAmB,QAAQ,EAAE,CAAC;QACrE,OAAO,IAAI,CAAC,qBAAqB,CAC/B,WAAW,EACX,KAAK,EACL,GAAG,EACH,SAAS,EACT,QAAQ,CACT,CAAC;IACJ,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,yBAAyB,CACpC,WAAwB,EACxB,OAAe,EACf,UAA4B;QAE5B,MAAM,GAAG,GAAG,GAAG,IAAI,CAAC,QAAQ,IAAI,OAAO,iBAAiB,CAAC;QACzD,MAAM,IAAI,GAAG;YACX,OAAO,EAAE,UAAU;SACpB,CAAC;QACF,OAAO,IAAI,CAAC,qBAAqB,CAC/B,WAAW,EACX,MAAM,EACN,GAAG,EACH,IAAI,EACJ,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;IAED;;;;;;OAMG;IACI,KAAK,CAAC,2BAA2B,CACtC,WAAwB,EACxB,OAAe,EACf,QAAgB,EAChB,OAAiB;QAEjB,MAAM,GAAG,GAAG,GAAG,IAAI,CAAC,QAAQ,IAAI,OAAO,mBAAmB,QAAQ,EAAE,CAAC;QACrE,MAAM,IAAI,GAAG;YACX,OAAO;SACR,CAAC;QACF,OAAO,IAAI,CAAC,qBAAqB,CAC/B,WAAW,EACX,OAAO,EACP,GAAG,EACH,IAAI,EACJ,QAAQ,CACT,CAAC;IACJ,CAAC;CACF;AArHD,gDAqHC","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  AddGroupMember,\n  GroupMember,\n  IGroupMembersClient,\n} from \"../accessControlTypes\";\nimport { BaseClient } from \"./BaseClient\";\n\nexport class GroupMembersClient\n  extends BaseClient\n  implements IGroupMembersClient {\n  public constructor(url?: string) {\n    super(url);\n  }\n\n  /** Retrieves a list of iTwin group members and their roles assignments.\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 queryITwinGroupMembersAsync(\n    accessToken: AccessToken,\n    iTwinId: string,\n    arg?: AccessControlQueryArg\n  ): Promise<AccessControlAPIResponse<GroupMember[]>> {\n    let url = `${this._baseUrl}/${iTwinId}/members/groups`;\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  /** Retrieves a specific group member for a specified 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 Member\n   */\n  public async getITwinGroupMemberAsync(\n    accessToken: AccessToken,\n    iTwinId: string,\n    memberId: string\n  ): Promise<AccessControlAPIResponse<GroupMember>> {\n    const url = `${this._baseUrl}/${iTwinId}/members/groups/${memberId}`;\n    return this.sendGenericAPIRequest(\n      accessToken,\n      \"GET\",\n      url,\n      undefined,\n      \"member\"\n    );\n  }\n\n  /** Add new iTwin group members\n   * @param accessToken The client access token string\n   * @param iTwinId The id of the iTwin\n   * @param newMembers The list of new members to be added along with their role\n   * @returns Member[]\n   */\n  public async addITwinGroupMembersAsync(\n    accessToken: AccessToken,\n    iTwinId: string,\n    newMembers: AddGroupMember[]\n  ): Promise<AccessControlAPIResponse<GroupMember[]>> {\n    const url = `${this._baseUrl}/${iTwinId}/members/groups`;\n    const body = {\n      members: newMembers,\n    };\n    return this.sendGenericAPIRequest(\n      accessToken,\n      \"POST\",\n      url,\n      body,\n      \"members\"\n    );\n  }\n\n  /** Remove the specified group 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 removeITwinGroupMemberAsync(\n    accessToken: AccessToken,\n    iTwinId: string,\n    memberId: string\n  ): Promise<AccessControlAPIResponse<undefined>> {\n    const url = `${this._baseUrl}/${iTwinId}/members/groups/${memberId}`;\n    return this.sendGenericAPIRequest(accessToken, \"DELETE\", url);\n  }\n\n  /** Update iTwin group member roles\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   * @param roleIds The ids of the roles to be assigned\n   * @returns Member\n   */\n  public async updateITwinGroupMemberAsync(\n    accessToken: AccessToken,\n    iTwinId: string,\n    memberId: string,\n    roleIds: string[]\n  ): Promise<AccessControlAPIResponse<GroupMember>> {\n    const url = `${this._baseUrl}/${iTwinId}/members/groups/${memberId}`;\n    const body = {\n      roleIds,\n    };\n    return this.sendGenericAPIRequest(\n      accessToken,\n      \"PATCH\",\n      url,\n      body,\n      \"member\"\n    );\n  }\n}\n"]}
+{"version":3,"file":"GroupMembersClient.js","sourceRoot":"","sources":["../../../src/subClients/GroupMembersClient.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;;;;OAIG;IACI,KAAK,CAAC,sBAAsB,CACjC,WAAwB,EACxB,OAAe,EACf,GAA4C;QAO5C,IAAI,GAAG,GAAG,GAAG,IAAI,CAAC,QAAQ,IAAI,OAAO,iBAAiB,CAAC;QAEvD,IAAI,GAAG,EAAE,CAAC;YACR,GAAG,IAAI,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;QAChH,CAAC;QAED,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,QAAgB;QAEhB,MAAM,GAAG,GAAG,GAAG,IAAI,CAAC,QAAQ,IAAI,OAAO,mBAAmB,QAAQ,EAAE,CAAC;QACrE,OAAO,IAAI,CAAC,qBAAqB,CAC/B,WAAW,EACX,KAAK,EACL,GAAG,EACH,SAAS,CACV,CAAC;IACJ,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,oBAAoB,CAC/B,WAAwB,EACxB,OAAe,EACf,UAAiC;QAEjC,MAAM,GAAG,GAAG,GAAG,IAAI,CAAC,QAAQ,IAAI,OAAO,iBAAiB,CAAC;QACzD,OAAO,IAAI,CAAC,qBAAqB,CAC/B,WAAW,EACX,MAAM,EACN,GAAG,EACH,UAAU,CACX,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;IAED;;;;;;OAMG;IACI,KAAK,CAAC,sBAAsB,CACjC,WAAwB,EACxB,OAAe,EACf,QAAgB,EAChB,OAAiB;QAEjB,MAAM,GAAG,GAAG,GAAG,IAAI,CAAC,QAAQ,IAAI,OAAO,mBAAmB,QAAQ,EAAE,CAAC;QACrE,MAAM,IAAI,GAAG;YACX,OAAO;SACR,CAAC;QACF,OAAO,IAAI,CAAC,qBAAqB,CAC/B,WAAW,EACX,OAAO,EACP,GAAG,EACH,IAAI,CACL,CAAC;IACJ,CAAC;CACF;AAtHD,gDAsHC","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 { IGroupMembersClient } from \"../accessControlClientInterfaces/GroupMembersClient\";\nimport type { BentleyAPIResponse, ODataQueryParams } from \"../types/CommonApiTypes\";\nimport type { GroupMemberAssignment, MultipleGroupMembersResponse, SingleGroupMemberResponse } from \"../types/GroupMember\";\nimport type { Links } from \"../types/links\";\nimport { BaseClient } from \"./BaseClient\";\n\n/** Client API to perform iTwin group members operations.\n */\nexport class GroupMembersClient\n  extends BaseClient\n  implements IGroupMembersClient {\n  /** Create a new GroupMembersClient 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 group members and their roles assignments.\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 queryITwinGroupMembers(\n    accessToken: AccessToken,\n    iTwinId: string,\n    arg?: Pick<ODataQueryParams, \"top\" | \"skip\">\n  ): Promise<BentleyAPIResponse<MultipleGroupMembersResponse &\n  {\n    // eslint-disable-next-line @typescript-eslint/naming-convention\n  _links: Links\n  }\n  >> {\n    let url = `${this._baseUrl}/${iTwinId}/members/groups`;\n\n    if (arg) {\n      url += `?${this.getQueryString(GroupMembersClient.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  /** Retrieves a specific group member for a specified 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 Member\n   */\n  public async getITwinGroupMember(\n    accessToken: AccessToken,\n    iTwinId: string,\n    memberId: string\n  ): Promise<BentleyAPIResponse<SingleGroupMemberResponse>>{\n    const url = `${this._baseUrl}/${iTwinId}/members/groups/${memberId}`;\n    return this.sendGenericAPIRequest(\n      accessToken,\n      \"GET\",\n      url,\n      undefined,\n    );\n  }\n\n  /** Add new iTwin group members\n   * @param accessToken The client access token string\n   * @param iTwinId The id of the iTwin\n   * @param newMembers The list of new members to be added along with their role\n   * @returns Member[]\n   */\n  public async addITwinGroupMembers(\n    accessToken: AccessToken,\n    iTwinId: string,\n    newMembers: GroupMemberAssignment\n  ): Promise<BentleyAPIResponse<MultipleGroupMembersResponse>> {\n    const url = `${this._baseUrl}/${iTwinId}/members/groups`;\n    return this.sendGenericAPIRequest(\n      accessToken,\n      \"POST\",\n      url,\n      newMembers,\n    );\n  }\n\n  /** Remove the specified group 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 removeITwinGroupMember(\n    accessToken: AccessToken,\n    iTwinId: string,\n    memberId: string\n  ): Promise<BentleyAPIResponse<undefined>> {\n    const url = `${this._baseUrl}/${iTwinId}/members/groups/${memberId}`;\n    return this.sendGenericAPIRequest(accessToken, \"DELETE\", url);\n  }\n\n  /** Update iTwin group member roles\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   * @param roleIds The ids of the roles to be assigned\n   * @returns Member\n   */\n  public async updateITwinGroupMember(\n    accessToken: AccessToken,\n    iTwinId: string,\n    memberId: string,\n    roleIds: string[]\n  ): Promise<BentleyAPIResponse<SingleGroupMemberResponse>> {\n    const url = `${this._baseUrl}/${iTwinId}/members/groups/${memberId}`;\n    const body = {\n      roleIds,\n    };\n    return this.sendGenericAPIRequest(\n      accessToken,\n      \"PATCH\",\n      url,\n      body\n    );\n  }\n}\n"]}

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

@@ -2,45 +2,53 @@
  * @module AccessControlClient
  */
 import type { AccessToken } from "@itwin/core-bentley";
-import type { AccessControlAPIResponse, Group, GroupUpdate, IGroupsClient } from "../accessControlTypes";
+import type { IGroupsClient } from "../accessControlClientInterfaces/GroupClient";
+import type { BentleyAPIResponse } from "../types/CommonApiTypes";
+import type { Group, MultipleGroupsResponse, SingleGroupResponse } from "../types/Groups";
 import { BaseClient } from "./BaseClient";
+/** Client API to perform iTwin group operations.
+ */
 export declare class GroupsClient extends BaseClient implements IGroupsClient {
+    /** Create a new GroupsClient 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 Group[]
       */
-    getITwinGroupsAsync(accessToken: AccessToken, iTwinId: string, additionalHeaders?: {
-        [key: string]: string;
-    }): Promise<AccessControlAPIResponse<Group[]>>;
+    getITwinGroups(accessToken: AccessToken, iTwinId: string): Promise<BentleyAPIResponse<MultipleGroupsResponse>>;
     /** Retrieves the specified role for the specified iTwin
       * @param accessToken The client access token string
       * @param iTwinId The id of the iTwin
       * @returns Group
       */
-    getITwinGroupAsync(accessToken: AccessToken, iTwinId: string, groupId: string): Promise<AccessControlAPIResponse<Group>>;
+    getITwinGroup(accessToken: AccessToken, iTwinId: string, groupId: string): Promise<BentleyAPIResponse<SingleGroupResponse>>;
     /** Creates a new iTwin group
       * @param accessToken The client access token string
       * @param iTwinId The id of the iTwin
       * @param group The group to be created
       * @returns Group
       */
-    createITwinGroupAsync(accessToken: AccessToken, iTwinId: string, group: Group): Promise<AccessControlAPIResponse<Group>>;
+    createITwinGroup(accessToken: AccessToken, iTwinId: string, group: Pick<Group, "name" | "description">): Promise<BentleyAPIResponse<SingleGroupResponse>>;
     /** Delete the specified iTwin group
       * @param accessToken The client access token string
       * @param iTwinId The id of the iTwin
       * @param groupId The id of the group to remove
       * @returns No Content
       */
-    deleteITwinGroupAsync(accessToken: AccessToken, iTwinId: string, groupId: string): Promise<AccessControlAPIResponse<undefined>>;
+    deleteITwinGroup(accessToken: AccessToken, iTwinId: string, groupId: string): Promise<BentleyAPIResponse<undefined>>;
     /** Update the specified iTwin group
       * @param accessToken The client access token string
       * @param iTwinId The id of the iTwin
       * @param groupId The id of the role to update
       * @param group The updated group
-      * @returns Role
+      * @returns Group that was updated
       */
-    updateITwinGroupAsync(accessToken: AccessToken, iTwinId: string, groupId: string, group: GroupUpdate): Promise<AccessControlAPIResponse<Group>>;
+    updateITwinGroup(accessToken: AccessToken, iTwinId: string, groupId: string, group: Partial<Pick<Group, "name" | "description"> & {
+        members: string[];
+        imsGroups: string[];
+    }>): Promise<BentleyAPIResponse<SingleGroupResponse>>;
 }
 //# sourceMappingURL=GroupsClient.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"GroupsClient.d.ts","sourceRoot":"","sources":["../../../src/subClients/GroupsClient.ts"],"names":[],"mappings":"AAIA;;GAEG;AACH,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAC;AACvD,OAAO,KAAK,EAAE,wBAAwB,EAAE,KAAK,EAAE,WAAW,EAAE,aAAa,EAAE,MAAM,uBAAuB,CAAC;AACzG,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE1C,qBAAa,YAAa,SAAQ,UAAW,YAAW,aAAa;gBAChD,GAAG,CAAC,EAAE,MAAM;IAI/B;;;;QAII;IACS,mBAAmB,CAC9B,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,MAAM,EACf,iBAAiB,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,GAC5C,OAAO,CAAC,wBAAwB,CAAC,KAAK,EAAE,CAAC,CAAC;IAK7C;;;;QAII;IACS,kBAAkB,CAC7B,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,MAAM,EACf,OAAO,EAAE,MAAM,GACd,OAAO,CAAC,wBAAwB,CAAC,KAAK,CAAC,CAAC;IAK3C;;;;;QAKI;IACS,qBAAqB,CAChC,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,MAAM,EACf,KAAK,EAAE,KAAK,GACX,OAAO,CAAC,wBAAwB,CAAC,KAAK,CAAC,CAAC;IAK3C;;;;;QAKI;IACS,qBAAqB,CAChC,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,MAAM,EACf,OAAO,EAAE,MAAM,GACd,OAAO,CAAC,wBAAwB,CAAC,SAAS,CAAC,CAAC;IAK/C;;;;;;QAMI;IACS,qBAAqB,CAChC,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,MAAM,EACf,OAAO,EAAE,MAAM,EACf,KAAK,EAAE,WAAW,GACjB,OAAO,CAAC,wBAAwB,CAAC,KAAK,CAAC,CAAC;CAI5C"}
+{"version":3,"file":"GroupsClient.d.ts","sourceRoot":"","sources":["../../../src/subClients/GroupsClient.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAC;AACvD,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,8CAA8C,CAAC;AAClF,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,yBAAyB,CAAC;AAClE,OAAO,KAAK,EAAE,KAAK,EAAE,sBAAsB,EAAE,mBAAmB,EAAE,MAAM,iBAAiB,CAAC;AAC1F,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE1C;GACG;AACH,qBAAa,YAAa,SAAQ,UAAW,YAAW,aAAa;IACnE;;OAEG;gBACgB,GAAG,CAAC,EAAE,MAAM;IAI/B;;;;QAII;IACS,cAAc,CACzB,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,MAAM,GACd,OAAO,CAAC,kBAAkB,CAAC,sBAAsB,CAAC,CAAC;IAKtD;;;;QAII;IACS,aAAa,CACxB,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,MAAM,EACf,OAAO,EAAE,MAAM,GACd,OAAO,CAAC,kBAAkB,CAAC,mBAAmB,CAAC,CAAC;IAKnD;;;;;QAKI;IACS,gBAAgB,CAC3B,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,MAAM,EACf,KAAK,EAAE,IAAI,CAAE,KAAK,EAAE,MAAM,GAAG,aAAa,CAAC,GAC1C,OAAO,CAAC,kBAAkB,CAAC,mBAAmB,CAAC,CAAC;IAKnD;;;;;QAKI;IACS,gBAAgB,CAC3B,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,MAAM,EACf,OAAO,EAAE,MAAM,GACd,OAAO,CAAC,kBAAkB,CAAC,SAAS,CAAC,CAAC;IAKzC;;;;;;QAMI;IACS,gBAAgB,CAC3B,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,MAAM,EACf,OAAO,EAAE,MAAM,EACf,KAAK,EAAE,OAAO,CAAC,IAAI,CAAC,KAAK,EAAE,MAAM,GAAG,aAAa,CAAC,GAAG;QAAE,OAAO,EAAE,MAAM,EAAE,CAAC;QAAC,SAAS,EAAE,MAAM,EAAE,CAAA;KAAE,CAAC,GAC/F,OAAO,CAAC,kBAAkB,CAAC,mBAAmB,CAAC,CAAC;CAIpD"}

package/lib/cjs/subClients/GroupsClient.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.GroupsClient = void 0;
 const BaseClient_1 = require("./BaseClient");
+/** Client API to perform iTwin group operations.
+ */
 class GroupsClient extends BaseClient_1.BaseClient {
+    /** Create a new GroupsClient instance
+     * @param url Optional base URL for the access control service. If not provided, defaults to base url.
+     */
     constructor(url) {
         super(url);
     }
@@ -11,18 +23,18 @@ class GroupsClient extends BaseClient_1.BaseClient {
       * @param iTwinId The id of the iTwin
       * @returns Group[]
       */
-    async getITwinGroupsAsync(accessToken, iTwinId, additionalHeaders) {
+    async getITwinGroups(accessToken, iTwinId) {
         const url = `${this._baseUrl}/${iTwinId}/groups`;
-        return this.sendGenericAPIRequest(accessToken, "GET", url, undefined, "groups", additionalHeaders);
+        return this.sendGenericAPIRequest(accessToken, "GET", url);
     }
     /** Retrieves the specified role for the specified iTwin
       * @param accessToken The client access token string
       * @param iTwinId The id of the iTwin
       * @returns Group
       */
-    async getITwinGroupAsync(accessToken, iTwinId, groupId) {
+    async getITwinGroup(accessToken, iTwinId, groupId) {
         const url = `${this._baseUrl}/${iTwinId}/groups/${groupId}`;
-        return this.sendGenericAPIRequest(accessToken, "GET", url, undefined, "group");
+        return this.sendGenericAPIRequest(accessToken, "GET", url);
     }
     /** Creates a new iTwin group
       * @param accessToken The client access token string
@@ -30,9 +42,9 @@ class GroupsClient extends BaseClient_1.BaseClient {
       * @param group The group to be created
       * @returns Group
       */
-    async createITwinGroupAsync(accessToken, iTwinId, group) {
+    async createITwinGroup(accessToken, iTwinId, group) {
         const url = `${this._baseUrl}/${iTwinId}/groups`;
-        return this.sendGenericAPIRequest(accessToken, "POST", url, group, "group");
+        return this.sendGenericAPIRequest(accessToken, "POST", url, group);
     }
     /** Delete the specified iTwin group
       * @param accessToken The client access token string
@@ -40,7 +52,7 @@ class GroupsClient extends BaseClient_1.BaseClient {
       * @param groupId The id of the group to remove
       * @returns No Content
       */
-    async deleteITwinGroupAsync(accessToken, iTwinId, groupId) {
+    async deleteITwinGroup(accessToken, iTwinId, groupId) {
         const url = `${this._baseUrl}/${iTwinId}/groups/${groupId}`;
         return this.sendGenericAPIRequest(accessToken, "DELETE", url);
     }
@@ -49,11 +61,11 @@ class GroupsClient extends BaseClient_1.BaseClient {
       * @param iTwinId The id of the iTwin
       * @param groupId The id of the role to update
       * @param group The updated group
-      * @returns Role
+      * @returns Group that was updated
       */
-    async updateITwinGroupAsync(accessToken, iTwinId, groupId, group) {
+    async updateITwinGroup(accessToken, iTwinId, groupId, group) {
         const url = `${this._baseUrl}/${iTwinId}/groups/${groupId}`;
-        return this.sendGenericAPIRequest(accessToken, "PATCH", url, group, "group");
+        return this.sendGenericAPIRequest(accessToken, "PATCH", url, group);
     }
 }
 exports.GroupsClient = GroupsClient;

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

@@ -1 +1 @@
-{"version":3,"file":"GroupsClient.js","sourceRoot":"","sources":["../../../src/subClients/GroupsClient.ts"],"names":[],"mappings":";;;AASA,6CAA0C;AAE1C,MAAa,YAAa,SAAQ,uBAAU;IAC1C,YAAmB,GAAY;QAC7B,KAAK,CAAC,GAAG,CAAC,CAAC;IACb,CAAC;IAED;;;;QAII;IACG,KAAK,CAAC,mBAAmB,CAC9B,WAAwB,EACxB,OAAe,EACf,iBAA6C;QAE7C,MAAM,GAAG,GAAG,GAAG,IAAI,CAAC,QAAQ,IAAI,OAAO,SAAS,CAAC;QACjD,OAAO,IAAI,CAAC,qBAAqB,CAAC,WAAW,EAAE,KAAK,EAAE,GAAG,EAAE,SAAS,EAAE,QAAQ,EAAE,iBAAiB,CAAC,CAAC;IACrG,CAAC;IAED;;;;QAII;IACG,KAAK,CAAC,kBAAkB,CAC7B,WAAwB,EACxB,OAAe,EACf,OAAe;QAEf,MAAM,GAAG,GAAG,GAAG,IAAI,CAAC,QAAQ,IAAI,OAAO,WAAW,OAAO,EAAE,CAAC;QAC5D,OAAO,IAAI,CAAC,qBAAqB,CAAC,WAAW,EAAE,KAAK,EAAE,GAAG,EAAE,SAAS,EAAE,OAAO,CAAC,CAAC;IACjF,CAAC;IAED;;;;;QAKI;IACG,KAAK,CAAC,qBAAqB,CAChC,WAAwB,EACxB,OAAe,EACf,KAAY;QAEZ,MAAM,GAAG,GAAG,GAAG,IAAI,CAAC,QAAQ,IAAI,OAAO,SAAS,CAAC;QACjD,OAAO,IAAI,CAAC,qBAAqB,CAAC,WAAW,EAAE,MAAM,EAAE,GAAG,EAAE,KAAK,EAAE,OAAO,CAAC,CAAC;IAC9E,CAAC;IAED;;;;;QAKI;IACG,KAAK,CAAC,qBAAqB,CAChC,WAAwB,EACxB,OAAe,EACf,OAAe;QAEf,MAAM,GAAG,GAAG,GAAG,IAAI,CAAC,QAAQ,IAAI,OAAO,WAAW,OAAO,EAAE,CAAC;QAC5D,OAAO,IAAI,CAAC,qBAAqB,CAAC,WAAW,EAAE,QAAQ,EAAE,GAAG,CAAC,CAAC;IAChE,CAAC;IAED;;;;;;QAMI;IACG,KAAK,CAAC,qBAAqB,CAChC,WAAwB,EACxB,OAAe,EACf,OAAe,EACf,KAAkB;QAElB,MAAM,GAAG,GAAG,GAAG,IAAI,CAAC,QAAQ,IAAI,OAAO,WAAW,OAAO,EAAE,CAAC;QAC5D,OAAO,IAAI,CAAC,qBAAqB,CAAC,WAAW,EAAE,OAAO,EAAE,GAAG,EAAE,KAAK,EAAE,OAAO,CAAC,CAAC;IAC/E,CAAC;CACF;AA/ED,oCA+EC","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 { AccessControlAPIResponse, Group, GroupUpdate, IGroupsClient } from \"../accessControlTypes\";\nimport { BaseClient } from \"./BaseClient\";\n\nexport class GroupsClient extends BaseClient implements IGroupsClient{\n  public constructor(url?: string) {\n    super(url);\n  }\n\n  /** Retrieves a list of available user roles that are defined for a specified iTwin\n    * @param accessToken The client access token string\n    * @param iTwinId The id of the iTwin\n    * @returns Group[]\n    */\n  public async getITwinGroupsAsync(\n    accessToken: AccessToken,\n    iTwinId: string,\n    additionalHeaders?: { [key: string]: string }\n  ): Promise<AccessControlAPIResponse<Group[]>>{\n    const url = `${this._baseUrl}/${iTwinId}/groups`;\n    return this.sendGenericAPIRequest(accessToken, \"GET\", url, undefined, \"groups\", additionalHeaders);\n  }\n\n  /** Retrieves the specified role for the specified iTwin\n    * @param accessToken The client access token string\n    * @param iTwinId The id of the iTwin\n    * @returns Group\n    */\n  public async getITwinGroupAsync(\n    accessToken: AccessToken,\n    iTwinId: string,\n    groupId: string,\n  ): Promise<AccessControlAPIResponse<Group>>{\n    const url = `${this._baseUrl}/${iTwinId}/groups/${groupId}`;\n    return this.sendGenericAPIRequest(accessToken, \"GET\", url, undefined, \"group\");\n  }\n\n  /** Creates a new iTwin group\n    * @param accessToken The client access token string\n    * @param iTwinId The id of the iTwin\n    * @param group The group to be created\n    * @returns Group\n    */\n  public async createITwinGroupAsync(\n    accessToken: AccessToken,\n    iTwinId: string,\n    group: Group\n  ): Promise<AccessControlAPIResponse<Group>>{\n    const url = `${this._baseUrl}/${iTwinId}/groups`;\n    return this.sendGenericAPIRequest(accessToken, \"POST\", url, group, \"group\");\n  }\n\n  /** Delete the specified iTwin group\n    * @param accessToken The client access token string\n    * @param iTwinId The id of the iTwin\n    * @param groupId The id of the group to remove\n    * @returns No Content\n    */\n  public async deleteITwinGroupAsync(\n    accessToken: AccessToken,\n    iTwinId: string,\n    groupId: string,\n  ): Promise<AccessControlAPIResponse<undefined>>{\n    const url = `${this._baseUrl}/${iTwinId}/groups/${groupId}`;\n    return this.sendGenericAPIRequest(accessToken, \"DELETE\", url);\n  }\n\n  /** Update the specified iTwin group\n    * @param accessToken The client access token string\n    * @param iTwinId The id of the iTwin\n    * @param groupId The id of the role to update\n    * @param group The updated group\n    * @returns Role\n    */\n  public async updateITwinGroupAsync(\n    accessToken: AccessToken,\n    iTwinId: string,\n    groupId: string,\n    group: GroupUpdate\n  ): Promise<AccessControlAPIResponse<Group>>{\n    const url = `${this._baseUrl}/${iTwinId}/groups/${groupId}`;\n    return this.sendGenericAPIRequest(accessToken, \"PATCH\", url, group, \"group\");\n  }\n}\n"]}
+{"version":3,"file":"GroupsClient.js","sourceRoot":"","sources":["../../../src/subClients/GroupsClient.ts"],"names":[],"mappings":";AAAA;;;gGAGgG;AAChG;;GAEG;;;AAMH,6CAA0C;AAE1C;GACG;AACH,MAAa,YAAa,SAAQ,uBAAU;IAC1C;;OAEG;IACH,YAAmB,GAAY;QAC7B,KAAK,CAAC,GAAG,CAAC,CAAC;IACb,CAAC;IAED;;;;QAII;IACG,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;IAED;;;;QAII;IACG,KAAK,CAAC,aAAa,CACxB,WAAwB,EACxB,OAAe,EACf,OAAe;QAEf,MAAM,GAAG,GAAG,GAAG,IAAI,CAAC,QAAQ,IAAI,OAAO,WAAW,OAAO,EAAE,CAAC;QAC5D,OAAO,IAAI,CAAC,qBAAqB,CAAC,WAAW,EAAE,KAAK,EAAE,GAAG,CAAC,CAAC;IAC7D,CAAC;IAED;;;;;QAKI;IACG,KAAK,CAAC,gBAAgB,CAC3B,WAAwB,EACxB,OAAe,EACf,KAA2C;QAE3C,MAAM,GAAG,GAAG,GAAG,IAAI,CAAC,QAAQ,IAAI,OAAO,SAAS,CAAC;QACjD,OAAO,IAAI,CAAC,qBAAqB,CAAC,WAAW,EAAE,MAAM,EAAE,GAAG,EAAE,KAAK,CAAC,CAAC;IACrE,CAAC;IAED;;;;;QAKI;IACG,KAAK,CAAC,gBAAgB,CAC3B,WAAwB,EACxB,OAAe,EACf,OAAe;QAEf,MAAM,GAAG,GAAG,GAAG,IAAI,CAAC,QAAQ,IAAI,OAAO,WAAW,OAAO,EAAE,CAAC;QAC5D,OAAO,IAAI,CAAC,qBAAqB,CAAC,WAAW,EAAE,QAAQ,EAAE,GAAG,CAAC,CAAC;IAChE,CAAC;IAED;;;;;;QAMI;IACG,KAAK,CAAC,gBAAgB,CAC3B,WAAwB,EACxB,OAAe,EACf,OAAe,EACf,KAAgG;QAEhG,MAAM,GAAG,GAAG,GAAG,IAAI,CAAC,QAAQ,IAAI,OAAO,WAAW,OAAO,EAAE,CAAC;QAC5D,OAAO,IAAI,CAAC,qBAAqB,CAAC,WAAW,EAAE,OAAO,EAAE,GAAG,EAAE,KAAK,CAAC,CAAC;IACtE,CAAC;CACF;AAjFD,oCAiFC","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 { IGroupsClient } from \"../accessControlClientInterfaces/GroupClient\";\nimport type { BentleyAPIResponse } from \"../types/CommonApiTypes\";\nimport type { Group, MultipleGroupsResponse, SingleGroupResponse } from \"../types/Groups\";\nimport { BaseClient } from \"./BaseClient\";\n\n/** Client API to perform iTwin group operations.\n */\nexport class GroupsClient extends BaseClient implements IGroupsClient{\n  /** Create a new GroupsClient 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 available user roles that are defined for a specified iTwin\n    * @param accessToken The client access token string\n    * @param iTwinId The id of the iTwin\n    * @returns Group[]\n    */\n  public async getITwinGroups(\n    accessToken: AccessToken,\n    iTwinId: string\n  ): Promise<BentleyAPIResponse<MultipleGroupsResponse>>{\n    const url = `${this._baseUrl}/${iTwinId}/groups`;\n    return this.sendGenericAPIRequest(accessToken, \"GET\", url);\n  }\n\n  /** Retrieves the specified role for the specified iTwin\n    * @param accessToken The client access token string\n    * @param iTwinId The id of the iTwin\n    * @returns Group\n    */\n  public async getITwinGroup(\n    accessToken: AccessToken,\n    iTwinId: string,\n    groupId: string,\n  ): Promise<BentleyAPIResponse<SingleGroupResponse>>{\n    const url = `${this._baseUrl}/${iTwinId}/groups/${groupId}`;\n    return this.sendGenericAPIRequest(accessToken, \"GET\", url);\n  }\n\n  /** Creates a new iTwin group\n    * @param accessToken The client access token string\n    * @param iTwinId The id of the iTwin\n    * @param group The group to be created\n    * @returns Group\n    */\n  public async createITwinGroup(\n    accessToken: AccessToken,\n    iTwinId: string,\n    group: Pick< Group, \"name\" | \"description\">\n  ): Promise<BentleyAPIResponse<SingleGroupResponse>>{\n    const url = `${this._baseUrl}/${iTwinId}/groups`;\n    return this.sendGenericAPIRequest(accessToken, \"POST\", url, group);\n  }\n\n  /** Delete the specified iTwin group\n    * @param accessToken The client access token string\n    * @param iTwinId The id of the iTwin\n    * @param groupId The id of the group to remove\n    * @returns No Content\n    */\n  public async deleteITwinGroup(\n    accessToken: AccessToken,\n    iTwinId: string,\n    groupId: string,\n  ): Promise<BentleyAPIResponse<undefined>>{\n    const url = `${this._baseUrl}/${iTwinId}/groups/${groupId}`;\n    return this.sendGenericAPIRequest(accessToken, \"DELETE\", url);\n  }\n\n  /** Update the specified iTwin group\n    * @param accessToken The client access token string\n    * @param iTwinId The id of the iTwin\n    * @param groupId The id of the role to update\n    * @param group The updated group\n    * @returns Group that was updated\n    */\n  public async updateITwinGroup(\n    accessToken: AccessToken,\n    iTwinId: string,\n    groupId: string,\n    group: Partial<Pick<Group, \"name\" | \"description\"> & { members: string[]; imsGroups: string[] }>\n  ): Promise<BentleyAPIResponse<SingleGroupResponse>>{\n    const url = `${this._baseUrl}/${iTwinId}/groups/${groupId}`;\n    return this.sendGenericAPIRequest(accessToken, \"PATCH\", url, group);\n  }\n}\n"]}

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

@@ -2,9 +2,16 @@
  * @module AccessControlClient
  */
 import type { AccessToken } from "@itwin/core-bentley";
-import type { AccessControlAPIResponse, AccessControlResultMode, IITwinJobsClient, ITwinJob, ITwinJobActions } from "../accessControlTypes";
+import type { IITwinJobsClient } from "../accessControlClientInterfaces/ITwinJobsClient";
+import type { BentleyAPIResponse, ResultMode } from "../types/CommonApiTypes";
+import type { ITwinJob, ITwinJobActions } from "../types/ITwinJob";
 import { BaseClient } from "./BaseClient";
+/** Client API to perform iTwin job operations.
+ */
 export declare class ITwinJobsClient extends BaseClient implements IITwinJobsClient {
+    /** Create a new ITwinJobsClient instance
+     * @param url Optional base URL for the access control service. If not provided, defaults to base url.
+     */
     constructor(url?: string);
     /** Create a new iTwin Job
        * @param accessToken The client access token string
@@ -12,7 +19,7 @@ export declare class ITwinJobsClient extends BaseClient implements IITwinJobsCli
        * @param iTwinActions The actions of the iTwin Job
        * @returns ITwin Job
        */
-    createITwinJobAsync(accessToken: AccessToken, iTwinId: string, iTwinJobActions: ITwinJobActions): Promise<AccessControlAPIResponse<ITwinJob>>;
+    createITwinJob(accessToken: AccessToken, iTwinId: string, iTwinJobActions: ITwinJobActions): Promise<BentleyAPIResponse<ITwinJob>>;
     /** Gets an iTwin Job.
        * @param accessToken The client access token string
        * @param iTwinId The id of the iTwin
@@ -20,19 +27,19 @@ export declare class ITwinJobsClient extends BaseClient implements IITwinJobsCli
        * @param resultMode (Optional) Access Control result mode: minimal or representation (defaults to minimal)
        * @returns ITwin Job
        */
-    getITwinJobAsync(accessToken: AccessToken, iTwinId: string, iTwinJobId: string, resultMode?: AccessControlResultMode): Promise<AccessControlAPIResponse<ITwinJob>>;
+    getITwinJob<T extends ResultMode = "minimal">(accessToken: AccessToken, iTwinId: string, iTwinJobId: string, resultMode?: T): Promise<BentleyAPIResponse<T extends "representation" ? ITwinJob : Omit<ITwinJob, "error">>>;
     /** Gets an iTwin Job.
        * @param accessToken The client access token string
        * @param iTwinId The id of the iTwin
        * @param iTwinJobId The id of the iTwin Job
        * @returns ITwin Job Actions
        */
-    getITwinJobActionsAsync(accessToken: AccessToken, iTwinId: string, iTwinJobId?: string): Promise<AccessControlAPIResponse<ITwinJobActions>>;
+    getITwinJobActions(accessToken: AccessToken, iTwinId: string, iTwinJobId?: string): Promise<BentleyAPIResponse<ITwinJobActions>>;
     /**
      * Format result mode parameter into a headers entry
      * @param resultMode (Optional) Access Control result mode
      * @protected
      */
-    protected getResultModeHeaders(resultMode?: AccessControlResultMode): Record<string, string>;
+    protected getResultModeHeaders(resultMode?: ResultMode): Record<string, string>;
 }
 //# sourceMappingURL=ITwinJobsClient.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"ITwinJobsClient.d.ts","sourceRoot":"","sources":["../../../src/subClients/ITwinJobsClient.ts"],"names":[],"mappings":"AAIA;;GAEG;AACH,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAC;AACvD,OAAO,KAAK,EAAE,wBAAwB,EAAE,uBAAuB,EAAE,gBAAgB,EAAE,QAAQ,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAC;AAC5I,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE1C,qBAAa,eAAgB,SAAQ,UAAW,YAAW,gBAAgB;gBACtD,GAAG,CAAC,EAAE,MAAM;IAI/B;;;;;SAKK;IACQ,mBAAmB,CAC9B,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,MAAM,EACf,eAAe,EAAE,eAAe,GAC/B,OAAO,CAAC,wBAAwB,CAAC,QAAQ,CAAC,CAAC;IAK9C;;;;;;SAMK;IACQ,gBAAgB,CAC3B,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,MAAM,EACf,UAAU,EAAE,MAAM,EAClB,UAAU,CAAC,EAAE,uBAAuB,GACnC,OAAO,CAAC,wBAAwB,CAAC,QAAQ,CAAC,CAAC;IAM9C;;;;;SAKK;IACQ,uBAAuB,CAClC,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,MAAM,EACf,UAAU,CAAC,EAAE,MAAM,GAClB,OAAO,CAAC,wBAAwB,CAAC,eAAe,CAAC,CAAC;IAKrD;;;;OAIG;IACH,SAAS,CAAC,oBAAoB,CAAC,UAAU,GAAE,uBAAmC,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC;CAKxG"}
+{"version":3,"file":"ITwinJobsClient.d.ts","sourceRoot":"","sources":["../../../src/subClients/ITwinJobsClient.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAC;AACvD,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,kDAAkD,CAAC;AACzF,OAAO,KAAK,EAAE,kBAAkB,EAAE,UAAU,EAAE,MAAM,yBAAyB,CAAC;AAC9E,OAAO,KAAK,EAAE,QAAQ,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AACnE,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE1C;GACG;AACH,qBAAa,eAAgB,SAAQ,UAAW,YAAW,gBAAgB;IACzE;;OAEG;gBACgB,GAAG,CAAC,EAAE,MAAM;IAI/B;;;;;SAKK;IACQ,cAAc,CACzB,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,MAAM,EACf,eAAe,EAAE,eAAe,GAC/B,OAAO,CAAC,kBAAkB,CAAC,QAAQ,CAAC,CAAC;IAKxC;;;;;;SAMK;IACQ,WAAW,CAAC,CAAC,SAAS,UAAU,GAAG,SAAS,EACvD,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,MAAM,EACf,UAAU,EAAE,MAAM,EAClB,UAAU,CAAC,EAAE,CAAC,GACb,OAAO,CAAC,kBAAkB,CAAC,CAAC,SAAS,gBAAgB,GAAG,QAAQ,GAAG,IAAI,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC,CAAC;IAM/F;;;;;SAKK;IACQ,kBAAkB,CAC7B,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,MAAM,EACf,UAAU,CAAC,EAAE,MAAM,GAClB,OAAO,CAAC,kBAAkB,CAAC,eAAe,CAAC,CAAC;IAK/C;;;;OAIG;IACH,SAAS,CAAC,oBAAoB,CAAC,UAAU,GAAE,UAAsB,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC;CAK3F"}

package/lib/cjs/subClients/ITwinJobsClient.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.ITwinJobsClient = void 0;
 const BaseClient_1 = require("./BaseClient");
+/** Client API to perform iTwin job operations.
+ */
 class ITwinJobsClient extends BaseClient_1.BaseClient {
+    /** Create a new ITwinJobsClient instance
+     * @param url Optional base URL for the access control service. If not provided, defaults to base url.
+     */
     constructor(url) {
         super(url);
     }
@@ -12,7 +24,7 @@ class ITwinJobsClient extends BaseClient_1.BaseClient {
        * @param iTwinActions The actions of the iTwin Job
        * @returns ITwin Job
        */
-    async createITwinJobAsync(accessToken, iTwinId, iTwinJobActions) {
+    async createITwinJob(accessToken, iTwinId, iTwinJobActions) {
         const url = `${this._baseUrl}/${iTwinId}/jobs`;
         return this.sendGenericAPIRequest(accessToken, "POST", url, { actions: iTwinJobActions });
     }
@@ -23,7 +35,7 @@ class ITwinJobsClient extends BaseClient_1.BaseClient {
        * @param resultMode (Optional) Access Control result mode: minimal or representation (defaults to minimal)
        * @returns ITwin Job
        */
-    async getITwinJobAsync(accessToken, iTwinId, iTwinJobId, resultMode) {
+    async getITwinJob(accessToken, iTwinId, iTwinJobId, resultMode) {
         const headers = this.getResultModeHeaders(resultMode);
         const url = `${this._baseUrl}/${iTwinId}/jobs/${iTwinJobId}`;
         return this.sendGenericAPIRequest(accessToken, "GET", url, undefined, undefined, headers);
@@ -34,7 +46,7 @@ class ITwinJobsClient extends BaseClient_1.BaseClient {
        * @param iTwinJobId The id of the iTwin Job
        * @returns ITwin Job Actions
        */
-    async getITwinJobActionsAsync(accessToken, iTwinId, iTwinJobId) {
+    async getITwinJobActions(accessToken, iTwinId, iTwinJobId) {
         const url = `${this._baseUrl}/${iTwinId}/jobs/${iTwinJobId}/actions`;
         return this.sendGenericAPIRequest(accessToken, "GET", url, undefined, "actions");
     }

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

@@ -1 +1 @@
-{"version":3,"file":"ITwinJobsClient.js","sourceRoot":"","sources":["../../../src/subClients/ITwinJobsClient.ts"],"names":[],"mappings":";;;AASA,6CAA0C;AAE1C,MAAa,eAAgB,SAAQ,uBAAU;IAC7C,YAAmB,GAAY;QAC7B,KAAK,CAAC,GAAG,CAAC,CAAC;IACb,CAAC;IAED;;;;;SAKK;IACE,KAAK,CAAC,mBAAmB,CAC9B,WAAwB,EACxB,OAAe,EACf,eAAgC;QAEhC,MAAM,GAAG,GAAG,GAAG,IAAI,CAAC,QAAQ,IAAI,OAAO,OAAO,CAAC;QAC/C,OAAO,IAAI,CAAC,qBAAqB,CAAC,WAAW,EAAE,MAAM,EAAE,GAAG,EAAE,EAAE,OAAO,EAAE,eAAe,EAAE,CAAC,CAAC;IAC5F,CAAC;IAED;;;;;;SAMK;IACE,KAAK,CAAC,gBAAgB,CAC3B,WAAwB,EACxB,OAAe,EACf,UAAkB,EAClB,UAAoC;QAEpC,MAAM,OAAO,GAAG,IAAI,CAAC,oBAAoB,CAAC,UAAU,CAAC,CAAC;QACtD,MAAM,GAAG,GAAG,GAAG,IAAI,CAAC,QAAQ,IAAI,OAAO,SAAS,UAAU,EAAE,CAAC;QAC7D,OAAO,IAAI,CAAC,qBAAqB,CAAC,WAAW,EAAE,KAAK,EAAE,GAAG,EAAE,SAAS,EAAE,SAAS,EAAE,OAAO,CAAC,CAAC;IAC5F,CAAC;IAED;;;;;SAKK;IACE,KAAK,CAAC,uBAAuB,CAClC,WAAwB,EACxB,OAAe,EACf,UAAmB;QAEnB,MAAM,GAAG,GAAG,GAAG,IAAI,CAAC,QAAQ,IAAI,OAAO,SAAS,UAAU,UAAU,CAAC;QACrE,OAAO,IAAI,CAAC,qBAAqB,CAAC,WAAW,EAAE,KAAK,EAAE,GAAG,EAAE,SAAS,EAAE,SAAS,CAAC,CAAC;IACnF,CAAC;IAED;;;;OAIG;IACO,oBAAoB,CAAC,aAAsC,SAAS;QAC5E,OAAO;YACL,MAAM,EAAE,UAAU,UAAU,EAAE;SAC/B,CAAC;IACJ,CAAC;CACF;AA/DD,0CA+DC","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 { AccessControlAPIResponse, AccessControlResultMode, IITwinJobsClient, ITwinJob, ITwinJobActions } from \"../accessControlTypes\";\nimport { BaseClient } from \"./BaseClient\";\n\nexport class ITwinJobsClient extends BaseClient implements IITwinJobsClient {\n  public constructor(url?: string) {\n    super(url);\n  }\n\n  /** Create a new iTwin Job\n     * @param accessToken The client access token string\n     * @param iTwinId The id of the iTwin\n     * @param iTwinActions The actions of the iTwin Job\n     * @returns ITwin Job\n     */\n  public async createITwinJobAsync(\n    accessToken: AccessToken,\n    iTwinId: string,\n    iTwinJobActions: ITwinJobActions\n  ): Promise<AccessControlAPIResponse<ITwinJob>> {\n    const url = `${this._baseUrl}/${iTwinId}/jobs`;\n    return this.sendGenericAPIRequest(accessToken, \"POST\", url, { actions: iTwinJobActions });\n  }\n\n  /** Gets an iTwin Job.\n     * @param accessToken The client access token string\n     * @param iTwinId The id of the iTwin\n     * @param iTwinJobId The id of the iTwin Job\n     * @param resultMode (Optional) Access Control result mode: minimal or representation (defaults to minimal)\n     * @returns ITwin Job\n     */\n  public async getITwinJobAsync(\n    accessToken: AccessToken,\n    iTwinId: string,\n    iTwinJobId: string,\n    resultMode?: AccessControlResultMode\n  ): Promise<AccessControlAPIResponse<ITwinJob>> {\n    const headers = this.getResultModeHeaders(resultMode);\n    const url = `${this._baseUrl}/${iTwinId}/jobs/${iTwinJobId}`;\n    return this.sendGenericAPIRequest(accessToken, \"GET\", url, undefined, undefined, headers);\n  }\n\n  /** Gets an iTwin Job.\n     * @param accessToken The client access token string\n     * @param iTwinId The id of the iTwin\n     * @param iTwinJobId The id of the iTwin Job\n     * @returns ITwin Job Actions\n     */\n  public async getITwinJobActionsAsync(\n    accessToken: AccessToken,\n    iTwinId: string,\n    iTwinJobId?: string\n  ): Promise<AccessControlAPIResponse<ITwinJobActions>> {\n    const url = `${this._baseUrl}/${iTwinId}/jobs/${iTwinJobId}/actions`;\n    return this.sendGenericAPIRequest(accessToken, \"GET\", url, undefined, \"actions\");\n  }\n\n  /**\n   * Format result mode parameter into a headers entry\n   * @param resultMode (Optional) Access Control result mode\n   * @protected\n   */\n  protected getResultModeHeaders(resultMode: AccessControlResultMode = \"minimal\"): Record<string, string> {\n    return {\n      prefer: `return=${resultMode}`,\n    };\n  }\n}\n"]}
+{"version":3,"file":"ITwinJobsClient.js","sourceRoot":"","sources":["../../../src/subClients/ITwinJobsClient.ts"],"names":[],"mappings":";AAAA;;;gGAGgG;AAChG;;GAEG;;;AAMH,6CAA0C;AAE1C;GACG;AACH,MAAa,eAAgB,SAAQ,uBAAU;IAC7C;;OAEG;IACH,YAAmB,GAAY;QAC7B,KAAK,CAAC,GAAG,CAAC,CAAC;IACb,CAAC;IAED;;;;;SAKK;IACE,KAAK,CAAC,cAAc,CACzB,WAAwB,EACxB,OAAe,EACf,eAAgC;QAEhC,MAAM,GAAG,GAAG,GAAG,IAAI,CAAC,QAAQ,IAAI,OAAO,OAAO,CAAC;QAC/C,OAAO,IAAI,CAAC,qBAAqB,CAAC,WAAW,EAAE,MAAM,EAAE,GAAG,EAAE,EAAE,OAAO,EAAE,eAAe,EAAE,CAAC,CAAC;IAC5F,CAAC;IAED;;;;;;SAMK;IACE,KAAK,CAAC,WAAW,CACtB,WAAwB,EACxB,OAAe,EACf,UAAkB,EAClB,UAAc;QAEd,MAAM,OAAO,GAAG,IAAI,CAAC,oBAAoB,CAAC,UAAU,CAAC,CAAC;QACtD,MAAM,GAAG,GAAG,GAAG,IAAI,CAAC,QAAQ,IAAI,OAAO,SAAS,UAAU,EAAE,CAAC;QAC7D,OAAO,IAAI,CAAC,qBAAqB,CAAC,WAAW,EAAE,KAAK,EAAE,GAAG,EAAE,SAAS,EAAE,SAAS,EAAE,OAAO,CAAC,CAAC;IAC5F,CAAC;IAED;;;;;SAKK;IACE,KAAK,CAAC,kBAAkB,CAC7B,WAAwB,EACxB,OAAe,EACf,UAAmB;QAEnB,MAAM,GAAG,GAAG,GAAG,IAAI,CAAC,QAAQ,IAAI,OAAO,SAAS,UAAU,UAAU,CAAC;QACrE,OAAO,IAAI,CAAC,qBAAqB,CAAC,WAAW,EAAE,KAAK,EAAE,GAAG,EAAE,SAAS,EAAE,SAAS,CAAC,CAAC;IACnF,CAAC;IAED;;;;OAIG;IACO,oBAAoB,CAAC,aAAyB,SAAS;QAC/D,OAAO;YACL,MAAM,EAAE,UAAU,UAAU,EAAE;SAC/B,CAAC;IACJ,CAAC;CACF;AAlED,0CAkEC","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 { IITwinJobsClient } from \"../accessControlClientInterfaces/ITwinJobsClient\";\nimport type { BentleyAPIResponse, ResultMode } from \"../types/CommonApiTypes\";\nimport type { ITwinJob, ITwinJobActions } from \"../types/ITwinJob\";\nimport { BaseClient } from \"./BaseClient\";\n\n/** Client API to perform iTwin job operations.\n */\nexport class ITwinJobsClient extends BaseClient implements IITwinJobsClient {\n  /** Create a new ITwinJobsClient 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 Job\n     * @param accessToken The client access token string\n     * @param iTwinId The id of the iTwin\n     * @param iTwinActions The actions of the iTwin Job\n     * @returns ITwin Job\n     */\n  public async createITwinJob(\n    accessToken: AccessToken,\n    iTwinId: string,\n    iTwinJobActions: ITwinJobActions\n  ): Promise<BentleyAPIResponse<ITwinJob>> {\n    const url = `${this._baseUrl}/${iTwinId}/jobs`;\n    return this.sendGenericAPIRequest(accessToken, \"POST\", url, { actions: iTwinJobActions });\n  }\n\n  /** Gets an iTwin Job.\n     * @param accessToken The client access token string\n     * @param iTwinId The id of the iTwin\n     * @param iTwinJobId The id of the iTwin Job\n     * @param resultMode (Optional) Access Control result mode: minimal or representation (defaults to minimal)\n     * @returns ITwin Job\n     */\n  public async getITwinJob<T extends ResultMode = \"minimal\">(\n    accessToken: AccessToken,\n    iTwinId: string,\n    iTwinJobId: string,\n    resultMode?: T\n  ): Promise<BentleyAPIResponse<T extends \"representation\" ? ITwinJob : Omit<ITwinJob, \"error\">>> {\n    const headers = this.getResultModeHeaders(resultMode);\n    const url = `${this._baseUrl}/${iTwinId}/jobs/${iTwinJobId}`;\n    return this.sendGenericAPIRequest(accessToken, \"GET\", url, undefined, undefined, headers);\n  }\n\n  /** Gets an iTwin Job.\n     * @param accessToken The client access token string\n     * @param iTwinId The id of the iTwin\n     * @param iTwinJobId The id of the iTwin Job\n     * @returns ITwin Job Actions\n     */\n  public async getITwinJobActions(\n    accessToken: AccessToken,\n    iTwinId: string,\n    iTwinJobId?: string\n  ): Promise<BentleyAPIResponse<ITwinJobActions>> {\n    const url = `${this._baseUrl}/${iTwinId}/jobs/${iTwinJobId}/actions`;\n    return this.sendGenericAPIRequest(accessToken, \"GET\", url, undefined, \"actions\");\n  }\n\n  /**\n   * Format result mode parameter into a headers entry\n   * @param resultMode (Optional) Access Control result mode\n   * @protected\n   */\n  protected getResultModeHeaders(resultMode: ResultMode = \"minimal\"): Record<string, string> {\n    return {\n      prefer: `return=${resultMode}`,\n    };\n  }\n}\n"]}

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

@@ -0,0 +1,61 @@
+/** @packageDocumentation
+ * @module AccessControlClient
+ */
+import type { AccessToken } from "@itwin/core-bentley";
+import type { IITwinSharesClient } from "../accessControlClientInterfaces/ItwinSharesClient";
+import type { BentleyAPIResponse } from "../types/CommonApiTypes";
+import type { MultiShareContractResponse, ShareContract, SingleShareContractResponse } from "../types/ShareContract";
+import { BaseClient } from "./BaseClient";
+/** Client API to perform iTwin share operations.
+ * @beta
+ */
+export declare class ITwinSharesClient extends BaseClient implements IITwinSharesClient {
+    /** Create a new ITwinSharesClient instance
+     * @param url Optional base URL for the access control service. If not provided, defaults to base url.
+     */
+    constructor(url?: string);
+    /** 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
+     */
+    createITwinShare(accessToken: AccessToken, iTwinId: string, iTwinShare: Partial<Pick<ShareContract, "shareContract"> & {
+        expiration: string | null;
+    }>): Promise<BentleyAPIResponse<SingleShareContractResponse>>;
+    /** 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
+   */
+    getITwinShare(accessToken: AccessToken, iTwinId: string, sharedId: string): Promise<BentleyAPIResponse<SingleShareContractResponse>>;
+    /** 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
+     */
+    getITwinShares(accessToken: AccessToken, iTwinId: string): Promise<BentleyAPIResponse<MultiShareContractResponse>>;
+    /** 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
+   */
+    revokeITwinShare(accessToken: AccessToken, iTwinId: string, sharedId: string): Promise<BentleyAPIResponse<undefined>>;
+}
+//# sourceMappingURL=ItwinShares.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"ItwinShares.d.ts","sourceRoot":"","sources":["../../../src/subClients/ItwinShares.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,0BAA0B,EAAE,aAAa,EAAE,2BAA2B,EAAE,MAAM,wBAAwB,CAAC;AACrH,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE1C;;GAEG;AACH,qBAAa,iBACX,SAAQ,UACR,YAAW,kBAAkB;IAE7B;;OAEG;gBACgB,GAAG,CAAC,EAAE,MAAM;IAI/B;;;;;;;;;;;;;;;OAeG;IACU,gBAAgB,CAC3B,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,MAAM,EACf,UAAU,EAAE,OAAO,CAAC,IAAI,CAAC,aAAa,EAAE,eAAe,CAAC,GAAG;QAAE,UAAU,EAAE,MAAM,GAAG,IAAI,CAAA;KAAE,CAAC,GACxF,OAAO,CAAC,kBAAkB,CAAC,2BAA2B,CAAC,CAAC;IAKzD;;;;;;KAMC;IACU,aAAa,CACxB,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,MAAM,EACf,QAAQ,EAAE,MAAM,GACf,OAAO,CAAC,kBAAkB,CAAC,2BAA2B,CAAC,CAAC;IAK3D;;;;;;OAMG;IACU,cAAc,CACzB,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,MAAM,GACd,OAAO,CAAC,kBAAkB,CAAC,0BAA0B,CAAC,CAAC;IAKxD;;;;;;KAMC;IACU,gBAAgB,CAC3B,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,MAAM,EACf,QAAQ,EAAE,MAAM,GACf,OAAO,CAAC,kBAAkB,CAAC,SAAS,CAAC,CAAC;CAK1C"}