@itwin/access-control-client 3.7.0 → 4.1.0

package/lib/cjs/subClients/RolesClient.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.RolesClient = void 0;
 const BaseClient_1 = require("./BaseClient");
+/** Client API to perform iTwin role operations.
+ */
 class RolesClient extends BaseClient_1.BaseClient {
+    /** Create a new RolesClient instance
+     * @param url Optional base URL for the access control service. If not provided, defaults to base url.
+     */
     constructor(url) {
         super(url);
     }
@@ -11,16 +23,16 @@ class RolesClient extends BaseClient_1.BaseClient {
       * @param iTwinId The id of the iTwin
       * @returns Roles
       */
-    async getITwinRolesAsync(accessToken, iTwinId, additionalHeaders) {
+    async getITwinRoles(accessToken, iTwinId) {
         const url = `${this._baseUrl}/${iTwinId}/roles`;
-        return this.sendGenericAPIRequest(accessToken, "GET", url, undefined, "roles", additionalHeaders);
+        return this.sendGenericAPIRequest(accessToken, "GET", url, undefined, "roles");
     }
     /** Retrieves the specified role for the specified iTwin
       * @param accessToken The client access token string
       * @param iTwinId The id of the iTwin
       * @returns Role
       */
-    async getITwinRoleAsync(accessToken, iTwinId, roleId) {
+    async getITwinRole(accessToken, iTwinId, roleId) {
         const url = `${this._baseUrl}/${iTwinId}/roles/${roleId}`;
         return this.sendGenericAPIRequest(accessToken, "GET", url, undefined, "role");
     }
@@ -30,7 +42,7 @@ class RolesClient extends BaseClient_1.BaseClient {
       * @param role The role to be created
       * @returns Role
       */
-    async createITwinRoleAsync(accessToken, iTwinId, role) {
+    async createITwinRole(accessToken, iTwinId, role) {
         const url = `${this._baseUrl}/${iTwinId}/roles`;
         return this.sendGenericAPIRequest(accessToken, "POST", url, role, "role");
     }
@@ -40,7 +52,7 @@ class RolesClient extends BaseClient_1.BaseClient {
       * @param roleId The id of the role to remove
       * @returns No Content
       */
-    async deleteITwinRoleAsync(accessToken, iTwinId, roleId) {
+    async deleteITwinRole(accessToken, iTwinId, roleId) {
         const url = `${this._baseUrl}/${iTwinId}/roles/${roleId}`;
         return this.sendGenericAPIRequest(accessToken, "DELETE", url);
     }
@@ -51,7 +63,7 @@ class RolesClient extends BaseClient_1.BaseClient {
       * @param role The updated role
       * @returns Role
       */
-    async updateITwinRoleAsync(accessToken, iTwinId, roleId, role) {
+    async updateITwinRole(accessToken, iTwinId, roleId, role) {
         const url = `${this._baseUrl}/${iTwinId}/roles/${roleId}`;
         return this.sendGenericAPIRequest(accessToken, "PATCH", url, role, "role");
     }

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

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

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

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

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

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

package/lib/cjs/subClients/UserMembersClient.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.UserMembersClient = void 0;
 const BaseClient_1 = require("./BaseClient");
+/** Client API to perform user members operations.
+ */
 class UserMembersClient extends BaseClient_1.BaseClient {
+    /** Create a new UserMembersClient instance
+     * @param url Optional base URL for the access control service. If not provided, defaults to base url.
+     */
     constructor(url) {
         super(url);
     }
@@ -11,12 +23,12 @@ class UserMembersClient extends BaseClient_1.BaseClient {
      * @param iTwinId The id of the iTwin
      * @returns Array of members
      */
-    async queryITwinUserMembersAsync(accessToken, iTwinId, arg) {
+    async queryITwinUserMembers(accessToken, iTwinId, arg) {
         let url = `${this._baseUrl}/${iTwinId}/members/users`;
         if (arg) {
-            url += `?${this.getQueryString(arg)}`;
+            url += `?${this.getQueryString(UserMembersClient.paginationParamMapping, { top: arg.top, skip: arg.skip })}`;
         }
-        return this.sendGenericAPIRequest(accessToken, "GET", url, undefined, "members"); // TODO: Consider how to handle paging
+        return this.sendGenericAPIRequest(accessToken, "GET", url, undefined);
     }
     /** Retrieves a specific user member for a specified iTwin.
      * @param accessToken The client access token string
@@ -24,9 +36,9 @@ class UserMembersClient extends BaseClient_1.BaseClient {
      * @param memberId The id of the member
      * @returns Member
      */
-    async getITwinUserMemberAsync(accessToken, iTwinId, memberId) {
+    async getITwinUserMember(accessToken, iTwinId, memberId) {
         const url = `${this._baseUrl}/${iTwinId}/members/users/${memberId}`;
-        return this.sendGenericAPIRequest(accessToken, "GET", url, undefined, "member");
+        return this.sendGenericAPIRequest(accessToken, "GET", url, undefined);
     }
     /** Add new iTwin user members
      * @param accessToken The client access token string
@@ -35,7 +47,7 @@ class UserMembersClient extends BaseClient_1.BaseClient {
      * @param customMessage Send custom message in welcome email when adding new members
      * @returns AddUserMemberResponse -- the added or invited user members
      */
-    async addITwinUserMembersAsync(accessToken, iTwinId, newMembers, customMessage) {
+    async addITwinUserMembers(accessToken, iTwinId, newMembers, customMessage) {
         const url = `${this._baseUrl}/${iTwinId}/members/users`;
         const body = {
             members: newMembers,
@@ -49,7 +61,7 @@ class UserMembersClient extends BaseClient_1.BaseClient {
      * @param memberId The id of the member
      * @returns No Content
      */
-    async removeITwinUserMemberAsync(accessToken, iTwinId, memberId) {
+    async removeITwinUserMember(accessToken, iTwinId, memberId) {
         const url = `${this._baseUrl}/${iTwinId}/members/users/${memberId}`;
         return this.sendGenericAPIRequest(accessToken, "DELETE", url);
     }
@@ -60,12 +72,12 @@ class UserMembersClient extends BaseClient_1.BaseClient {
      * @param roleIds The ids of the roles to be assigned
      * @returns Member
      */
-    async updateITwinUserMemberAsync(accessToken, iTwinId, memberId, roleIds) {
+    async updateITwinUserMember(accessToken, iTwinId, memberId, roleIds) {
         const url = `${this._baseUrl}/${iTwinId}/members/users/${memberId}`;
         const body = {
             roleIds,
         };
-        return this.sendGenericAPIRequest(accessToken, "PATCH", url, body, "member");
+        return this.sendGenericAPIRequest(accessToken, "PATCH", url, body);
     }
 }
 exports.UserMembersClient = UserMembersClient;

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

@@ -1 +1 @@
-{"version":3,"file":"UserMembersClient.js","sourceRoot":"","sources":["../../../src/subClients/UserMembersClient.ts"],"names":[],"mappings":";;;AAgBA,6CAA0C;AAE1C,MAAa,iBACX,SAAQ,uBAAU;IAElB,YAAmB,GAAY;QAC7B,KAAK,CAAC,GAAG,CAAC,CAAC;IACb,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,0BAA0B,CACrC,WAAwB,EACxB,OAAe,EACf,GAA2B;QAE3B,IAAI,GAAG,GAAG,GAAG,IAAI,CAAC,QAAQ,IAAI,OAAO,gBAAgB,CAAC;QAEtD,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,uBAAuB,CAClC,WAAwB,EACxB,OAAe,EACf,QAAgB;QAEhB,MAAM,GAAG,GAAG,GAAG,IAAI,CAAC,QAAQ,IAAI,OAAO,kBAAkB,QAAQ,EAAE,CAAC;QACpE,OAAO,IAAI,CAAC,qBAAqB,CAC/B,WAAW,EACX,KAAK,EACL,GAAG,EACH,SAAS,EACT,QAAQ,CACT,CAAC;IACJ,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,wBAAwB,CACnC,WAAwB,EACxB,OAAe,EACf,UAA2B,EAC3B,aAAsB;QAEtB,MAAM,GAAG,GAAG,GAAG,IAAI,CAAC,QAAQ,IAAI,OAAO,gBAAgB,CAAC;QACxD,MAAM,IAAI,GAAG;YACX,OAAO,EAAE,UAAU;YACnB,aAAa;SACd,CAAC;QACF,OAAO,IAAI,CAAC,qBAAqB,CAC/B,WAAW,EACX,MAAM,EACN,GAAG,EACH,IAAI,CACL,CAAC;IACJ,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,0BAA0B,CACrC,WAAwB,EACxB,OAAe,EACf,QAAgB;QAEhB,MAAM,GAAG,GAAG,GAAG,IAAI,CAAC,QAAQ,IAAI,OAAO,kBAAkB,QAAQ,EAAE,CAAC;QACpE,OAAO,IAAI,CAAC,qBAAqB,CAAC,WAAW,EAAE,QAAQ,EAAE,GAAG,CAAC,CAAC;IAChE,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,0BAA0B,CACrC,WAAwB,EACxB,OAAe,EACf,QAAgB,EAChB,OAAiB;QAEjB,MAAM,GAAG,GAAG,GAAG,IAAI,CAAC,QAAQ,IAAI,OAAO,kBAAkB,QAAQ,EAAE,CAAC;QACpE,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;AAvHD,8CAuHC","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  AddUserMember,\n  AddUserMemberResponse,\n  IUserMembersClient,\n  UserMember,\n} from \"../accessControlTypes\";\nimport { BaseClient } from \"./BaseClient\";\n\nexport class UserMembersClient\n  extends BaseClient\n  implements IUserMembersClient {\n  public constructor(url?: string) {\n    super(url);\n  }\n\n  /** Retrieves a list of iTwin user 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 queryITwinUserMembersAsync(\n    accessToken: AccessToken,\n    iTwinId: string,\n    arg?: AccessControlQueryArg\n  ): Promise<AccessControlAPIResponse<UserMember[]>> {\n    let url = `${this._baseUrl}/${iTwinId}/members/users`;\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 user 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 getITwinUserMemberAsync(\n    accessToken: AccessToken,\n    iTwinId: string,\n    memberId: string\n  ): Promise<AccessControlAPIResponse<UserMember>> {\n    const url = `${this._baseUrl}/${iTwinId}/members/users/${memberId}`;\n    return this.sendGenericAPIRequest(\n      accessToken,\n      \"GET\",\n      url,\n      undefined,\n      \"member\"\n    );\n  }\n\n  /** Add new iTwin user members\n   * @param accessToken The client access token string\n   * @param iTwinId The id of the iTwin\n   * @param newMembers The list of members to add or invite, along with their role\n   * @param customMessage Send custom message in welcome email when adding new members\n   * @returns AddUserMemberResponse -- the added or invited user members\n   */\n  public async addITwinUserMembersAsync(\n    accessToken: AccessToken,\n    iTwinId: string,\n    newMembers: AddUserMember[],\n    customMessage?: string\n  ): Promise<AccessControlAPIResponse<AddUserMemberResponse>> {\n    const url = `${this._baseUrl}/${iTwinId}/members/users`;\n    const body = {\n      members: newMembers,\n      customMessage,\n    };\n    return this.sendGenericAPIRequest(\n      accessToken,\n      \"POST\",\n      url,\n      body\n    );\n  }\n\n  /** Remove the specified user 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 removeITwinUserMemberAsync(\n    accessToken: AccessToken,\n    iTwinId: string,\n    memberId: string\n  ): Promise<AccessControlAPIResponse<undefined>> {\n    const url = `${this._baseUrl}/${iTwinId}/members/users/${memberId}`;\n    return this.sendGenericAPIRequest(accessToken, \"DELETE\", url);\n  }\n\n  /** Update iTwin user 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 updateITwinUserMemberAsync(\n    accessToken: AccessToken,\n    iTwinId: string,\n    memberId: string,\n    roleIds: string[]\n  ): Promise<AccessControlAPIResponse<UserMember>> {\n    const url = `${this._baseUrl}/${iTwinId}/members/users/${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":"UserMembersClient.js","sourceRoot":"","sources":["../../../src/subClients/UserMembersClient.ts"],"names":[],"mappings":";AAAA;;;gGAGgG;AAChG;;GAEG;;;AAMH,6CAA0C;AAE1C;GACG;AACH,MAAa,iBACX,SAAQ,uBAAU;IAElB;;OAEG;IACH,YAAmB,GAAY;QAC7B,KAAK,CAAC,GAAG,CAAC,CAAC;IACb,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,qBAAqB,CAChC,WAAwB,EACxB,OAAe,EACf,GAA4C;QAE5C,IAAI,GAAG,GAAG,GAAG,IAAI,CAAC,QAAQ,IAAI,OAAO,gBAAgB,CAAC;QAEtD,IAAI,GAAG,EAAE,CAAC;YACR,GAAG,IAAI,IAAI,IAAI,CAAC,cAAc,CAAC,iBAAiB,CAAC,sBAAsB,EAAE,EAAE,GAAG,EAAE,GAAG,CAAC,GAAG,EAAE,IAAI,EAAE,GAAG,CAAC,IAAI,EAAE,CAAC,EAAE,CAAC;QAC/G,CAAC;QAED,OAAO,IAAI,CAAC,qBAAqB,CAC/B,WAAW,EACX,KAAK,EACL,GAAG,EACH,SAAS,CACV,CAAC;IACJ,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,kBAAkB,CAC7B,WAAwB,EACxB,OAAe,EACf,QAAgB;QAEhB,MAAM,GAAG,GAAG,GAAG,IAAI,CAAC,QAAQ,IAAI,OAAO,kBAAkB,QAAQ,EAAE,CAAC;QACpE,OAAO,IAAI,CAAC,qBAAqB,CAC/B,WAAW,EACX,KAAK,EACL,GAAG,EACH,SAAS,CACV,CAAC;IACJ,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,mBAAmB,CAC9B,WAAwB,EACxB,OAAe,EACf,UAA2B,EAC3B,aAAsB;QAEtB,MAAM,GAAG,GAAG,GAAG,IAAI,CAAC,QAAQ,IAAI,OAAO,gBAAgB,CAAC;QACxD,MAAM,IAAI,GAAG;YACX,OAAO,EAAE,UAAU;YACnB,aAAa;SACd,CAAC;QACF,OAAO,IAAI,CAAC,qBAAqB,CAC/B,WAAW,EACX,MAAM,EACN,GAAG,EACH,IAAI,CACL,CAAC;IACJ,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,qBAAqB,CAChC,WAAwB,EACxB,OAAe,EACf,QAAgB;QAEhB,MAAM,GAAG,GAAG,GAAG,IAAI,CAAC,QAAQ,IAAI,OAAO,kBAAkB,QAAQ,EAAE,CAAC;QACpE,OAAO,IAAI,CAAC,qBAAqB,CAAC,WAAW,EAAE,QAAQ,EAAE,GAAG,CAAC,CAAC;IAChE,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,qBAAqB,CAChC,WAAwB,EACxB,OAAe,EACf,QAAgB,EAChB,OAAiB;QAEjB,MAAM,GAAG,GAAG,GAAG,IAAI,CAAC,QAAQ,IAAI,OAAO,kBAAkB,QAAQ,EAAE,CAAC;QACpE,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;AAvHD,8CAuHC","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 { IUserMembersClient } from \"../accessControlClientInterfaces/UserMembersClient\";\nimport type { BentleyAPIResponse, ODataQueryParams } from \"../types/CommonApiTypes\";\nimport type { AddUserMember, AddUserMemberResponse, MultipleUserMembersResponse, SingleUserMemberResponse } from \"../types/UserMembers\";\nimport { BaseClient } from \"./BaseClient\";\n\n/** Client API to perform user members operations.\n */\nexport class UserMembersClient\n  extends BaseClient\n  implements IUserMembersClient {\n  /** Create a new UserMembersClient 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 user 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 queryITwinUserMembers(\n    accessToken: AccessToken,\n    iTwinId: string,\n    arg?: Pick<ODataQueryParams, \"top\" | \"skip\">\n  ): Promise<BentleyAPIResponse<MultipleUserMembersResponse>> {\n    let url = `${this._baseUrl}/${iTwinId}/members/users`;\n\n    if (arg) {\n      url += `?${this.getQueryString(UserMembersClient.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 user 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 getITwinUserMember(\n    accessToken: AccessToken,\n    iTwinId: string,\n    memberId: string\n  ): Promise<BentleyAPIResponse<SingleUserMemberResponse>> {\n    const url = `${this._baseUrl}/${iTwinId}/members/users/${memberId}`;\n    return this.sendGenericAPIRequest(\n      accessToken,\n      \"GET\",\n      url,\n      undefined\n    );\n  }\n\n  /** Add new iTwin user members\n   * @param accessToken The client access token string\n   * @param iTwinId The id of the iTwin\n   * @param newMembers The list of members to add or invite, along with their role\n   * @param customMessage Send custom message in welcome email when adding new members\n   * @returns AddUserMemberResponse -- the added or invited user members\n   */\n  public async addITwinUserMembers(\n    accessToken: AccessToken,\n    iTwinId: string,\n    newMembers: AddUserMember[],\n    customMessage?: string\n  ): Promise<BentleyAPIResponse<AddUserMemberResponse>> {\n    const url = `${this._baseUrl}/${iTwinId}/members/users`;\n    const body = {\n      members: newMembers,\n      customMessage,\n    };\n    return this.sendGenericAPIRequest(\n      accessToken,\n      \"POST\",\n      url,\n      body\n    );\n  }\n\n  /** Remove the specified user 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 removeITwinUserMember(\n    accessToken: AccessToken,\n    iTwinId: string,\n    memberId: string\n  ): Promise<BentleyAPIResponse<undefined>> {\n    const url = `${this._baseUrl}/${iTwinId}/members/users/${memberId}`;\n    return this.sendGenericAPIRequest(accessToken, \"DELETE\", url);\n  }\n\n  /** Update iTwin user 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 updateITwinUserMember(\n    accessToken: AccessToken,\n    iTwinId: string,\n    memberId: string,\n    roleIds: string[]\n  ): Promise<BentleyAPIResponse<SingleUserMemberResponse>> {\n    const url = `${this._baseUrl}/${iTwinId}/members/users/${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/types/CommonApiTypes.d.ts

@@ -0,0 +1,78 @@
+declare global {
+    var IMJS_URL_PREFIX: string | undefined;
+}
+/**
+ * Common HTTP methods used in API requests
+ */
+export type Method = "GET" | "POST" | "PUT" | "DELETE" | "PATCH";
+/**
+ * Configuration object for HTTP requests
+ */
+export interface RequestConfig {
+    method: Method;
+    url: string;
+    body?: string | Blob;
+    headers?: Record<string, string>;
+    validateStatus?: (status: number) => boolean;
+}
+/**
+ * Standard response structure for all Bentley public API operations
+ * @template T The type of data returned in the response
+ */
+export interface BentleyAPIResponse<T> {
+    data?: T;
+    status: number;
+    error?: ApimError;
+    headers: Record<string, string>;
+}
+/**
+ * Error response structure from iTwins API
+ */
+export interface ApimError {
+    code: string;
+    message: string;
+    details?: ErrorDetail[];
+    target?: string;
+}
+/**
+ * Detailed error information from iTwins API responses
+ */
+export interface ErrorDetail {
+    code: string;
+    message: string;
+    target?: string;
+}
+/**
+ * Result mode preference for API responses.
+ * - minimal: Returns only essential data fields
+ * - representation: Returns complete data with all available properties
+ */
+export type ResultMode = "minimal" | "representation";
+/**
+ * OData query parameters interface for filtering, pagination, and data manipulation.
+ * Supports standard OData v4 query options for flexible API data retrieval.
+ * @see {@link https://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part2-url-conventions.html} OData URL Conventions
+ */
+export interface ODataQueryParams {
+    /** Maximum number of results to return (for pagination) */
+    top?: number;
+    /** Number of results to skip (for pagination) */
+    skip?: number;
+    /** Search string to filter results by keyword */
+    search?: string;
+    /** Filter expression to apply to the query */
+    filter?: string;
+    /** Comma-separated list of properties to include in the response */
+    select?: string;
+    /** Comma-separated list of properties to expand with related data */
+    expand?: string;
+    /** Comma-separated list of properties to order results by (append ' desc' for descending) */
+    orderby?: string;
+    /** Include total count of matching records in response metadata */
+    count?: boolean;
+    /** Apply aggregation transformations to the data */
+    apply?: string;
+    /** Specify response format (json, xml, etc.) */
+    format?: string;
+}
+//# sourceMappingURL=CommonApiTypes.d.ts.map

package/lib/cjs/types/CommonApiTypes.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"CommonApiTypes.d.ts","sourceRoot":"","sources":["../../../src/types/CommonApiTypes.ts"],"names":[],"mappings":"AAMA,OAAO,CAAC,MAAM,CAAC;IACb,IAAI,eAAe,EAAE,MAAM,GAAG,SAAS,CAAC;CACzC;AAED;;GAEG;AACH,MAAM,MAAM,MAAM,GAAG,KAAK,GAAG,MAAM,GAAG,KAAK,GAAG,QAAQ,GAAG,OAAO,CAAC;AAEjE;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B,MAAM,EAAE,MAAM,CAAC;IACf,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACrB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACjC,cAAc,CAAC,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,OAAO,CAAC;CAC9C;AAED;;;GAGG;AACH,MAAM,WAAW,kBAAkB,CAAC,CAAC;IACnC,IAAI,CAAC,EAAE,CAAC,CAAC;IACT,MAAM,EAAE,MAAM,CAAC;IACf,KAAK,CAAC,EAAE,SAAS,CAAC;IAClB,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CACjC;AAED;;GAEG;AACH,MAAM,WAAW,SAAS;IACxB,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,CAAC,EAAE,WAAW,EAAE,CAAC;IACxB,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED;;;;GAIG;AACH,MAAM,MAAM,UAAU,GAAG,SAAS,GAAG,gBAAgB,CAAC;AAEtD;;;;GAIG;AACH,MAAM,WAAW,gBAAgB;IAC/B,2DAA2D;IAC3D,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,iDAAiD;IACjD,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,iDAAiD;IACjD,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,8CAA8C;IAC9C,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,oEAAoE;IACpE,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,qEAAqE;IACrE,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,6FAA6F;IAC7F,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,mEAAmE;IACnE,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,oDAAoD;IACpD,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,gDAAgD;IAChD,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB"}

package/lib/cjs/types/CommonApiTypes.js

@@ -0,0 +1,7 @@
+"use strict";
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=CommonApiTypes.js.map

package/lib/cjs/types/CommonApiTypes.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"CommonApiTypes.js","sourceRoot":"","sources":["../../../src/types/CommonApiTypes.ts"],"names":[],"mappings":";AAAA;;;+FAG+F","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\n// Add this at the top of the file or in a types file\ndeclare global {\n  var IMJS_URL_PREFIX: string | undefined;\n}\n\n/**\n * Common HTTP methods used in API requests\n */\nexport type Method = \"GET\" | \"POST\" | \"PUT\" | \"DELETE\" | \"PATCH\";\n\n/**\n * Configuration object for HTTP requests\n */\nexport interface RequestConfig {\n  method: Method;\n  url: string;\n  body?: string | Blob;\n  headers?: Record<string, string>;\n  validateStatus?: (status: number) => boolean;\n}\n\n/**\n * Standard response structure for all Bentley public API operations\n * @template T The type of data returned in the response\n */\nexport interface BentleyAPIResponse<T> {\n  data?: T;\n  status: number;\n  error?: ApimError;\n  headers: Record<string, string>;\n}\n\n/**\n * Error response structure from iTwins API\n */\nexport interface ApimError {\n  code: string;\n  message: string;\n  details?: ErrorDetail[];\n  target?: string;\n}\n\n/**\n * Detailed error information from iTwins API responses\n */\nexport interface ErrorDetail {\n  code: string;\n  message: string;\n  target?: string;\n}\n\n/**\n * Result mode preference for API responses.\n * - minimal: Returns only essential data fields\n * - representation: Returns complete data with all available properties\n */\nexport type ResultMode = \"minimal\" | \"representation\";\n\n/**\n * OData query parameters interface for filtering, pagination, and data manipulation.\n * Supports standard OData v4 query options for flexible API data retrieval.\n * @see {@link https://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part2-url-conventions.html} OData URL Conventions\n */\nexport interface ODataQueryParams {\n  /** Maximum number of results to return (for pagination) */\n  top?: number;\n  /** Number of results to skip (for pagination) */\n  skip?: number;\n  /** Search string to filter results by keyword */\n  search?: string;\n  /** Filter expression to apply to the query */\n  filter?: string;\n  /** Comma-separated list of properties to include in the response */\n  select?: string;\n  /** Comma-separated list of properties to expand with related data */\n  expand?: string;\n  /** Comma-separated list of properties to order results by (append ' desc' for descending) */\n  orderby?: string;\n  /** Include total count of matching records in response metadata */\n  count?: boolean;\n  /** Apply aggregation transformations to the data */\n  apply?: string;\n  /** Specify response format (json, xml, etc.) */\n  format?: string;\n}"]}

package/lib/cjs/types/GroupMember.d.ts

@@ -0,0 +1,75 @@
+import type { Role } from "./Role";
+/**
+ * Represents a group that is a member of an iTwin with associated roles and metadata.
+ *
+ * @remarks
+ * Group members are groups that have been added to an iTwin and assigned specific roles.
+ * This provides information about the group's identity, assigned roles, and aggregate
+ * counts of its nested membership structure.
+ *
+ * @example
+ * ```typescript
+ * const groupMember: GroupMember = {
+ *   id: "550e8400-e29b-41d4-a716-446655440000",
+ *   groupName: "Engineering Team",
+ *   groupDescription: "Software engineering team members",
+ *   roles: [
+ *     { id: "admin-role", displayName: "Administrator" },
+ *     { id: "viewer-role", displayName: "Viewer" }
+ *   ],
+ * };
+ * ```
+ */
+export interface GroupMember {
+    /** Unique identifier for the group member */
+    id: string;
+    /** Display name of the group */
+    groupName: string;
+    /** Human-readable description of the group's purpose */
+    groupDescription: string;
+    /** Array of roles assigned to this group member (excludes permissions for security) */
+    roles: Role[];
+}
+/**
+ * Request to add group members to an iTwin with role assignments.
+ *
+ * @remarks
+ * The total number of roles assigned in this request must not exceed 50.
+ * This can be achieved with many different configurations. For example,
+ * 1 role can be assigned to 50 groups, or 5 roles can be assigned to 10 groups,
+ * both resulting in 50 role assignments.
+ *
+ * @example
+ * ```typescript
+ * const request: AddGroupMembers = {
+ *   members: [{
+ *     groupId: "6abbfcea-0eab-472a-b5f5-5c5a43df34b4",
+ *     roleIds: ["5abbfcef-0eab-472a-b5f5-5c5a43df34b1", "83ee0d80-dea3-495a-b6c0-7bb102ebbcc3"]
+ *   }]
+ * };
+ * ```
+ */
+export interface GroupMemberAssignment {
+    /** Array of groups to add as members with their assigned roles */
+    members: {
+        /** The ID of the group to add as a member */
+        groupId: string;
+        /** Array of role IDs to assign to this group member */
+        roleIds: string[];
+    }[];
+}
+/**
+ * API response wrapper for a single group member operation.
+ */
+export interface SingleGroupMemberResponse {
+    /** The group member data returned by the API */
+    member: GroupMember;
+}
+/**
+ * API response wrapper for multiple group members operations.
+ */
+export interface MultipleGroupMembersResponse {
+    /** Array of group members returned by the API */
+    members: GroupMember[];
+}
+//# sourceMappingURL=GroupMember.d.ts.map

package/lib/cjs/types/GroupMember.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"GroupMember.d.ts","sourceRoot":"","sources":["../../../src/types/GroupMember.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AAEnC;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAM,WAAW,WAAW;IAC1B,6CAA6C;IAC7C,EAAE,EAAE,MAAM,CAAC;IACX,gCAAgC;IAChC,SAAS,EAAE,MAAM,CAAC;IAClB,wDAAwD;IACxD,gBAAgB,EAAE,MAAM,CAAC;IACzB,uFAAuF;IACvF,KAAK,EAAE,IAAI,EAAE,CAAC;CACf;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,WAAW,qBAAqB;IACpC,kEAAkE;IAClE,OAAO,EAAE;QACP,6CAA6C;QAC7C,OAAO,EAAE,MAAM,CAAC;QAChB,uDAAuD;QACvD,OAAO,EAAE,MAAM,EAAE,CAAC;KACnB,EAAE,CAAC;CACL;AAED;;GAEG;AACH,MAAM,WAAW,yBAAyB;IACxC,gDAAgD;IAChD,MAAM,EAAE,WAAW,CAAC;CACrB;AAED;;GAEG;AACH,MAAM,WAAW,4BAA4B;IAC3C,iDAAiD;IACjD,OAAO,EAAE,WAAW,EAAE,CAAC;CACxB"}

package/lib/cjs/types/GroupMember.js

@@ -0,0 +1,7 @@
+"use strict";
+/*---------------------------------------------------------------------------------------------
+ * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+ * See LICENSE.md in the project root for license terms and full copyright notice.
+ *--------------------------------------------------------------------------------------------*/
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=GroupMember.js.map

package/lib/cjs/types/GroupMember.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"GroupMember.js","sourceRoot":"","sources":["../../../src/types/GroupMember.ts"],"names":[],"mappings":";AAAA;;;gGAGgG","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\nimport type { Role } from \"./Role\";\n\n/**\n * Represents a group that is a member of an iTwin with associated roles and metadata.\n *\n * @remarks\n * Group members are groups that have been added to an iTwin and assigned specific roles.\n * This provides information about the group's identity, assigned roles, and aggregate\n * counts of its nested membership structure.\n *\n * @example\n * ```typescript\n * const groupMember: GroupMember = {\n *   id: \"550e8400-e29b-41d4-a716-446655440000\",\n *   groupName: \"Engineering Team\",\n *   groupDescription: \"Software engineering team members\",\n *   roles: [\n *     { id: \"admin-role\", displayName: \"Administrator\" },\n *     { id: \"viewer-role\", displayName: \"Viewer\" }\n *   ],\n * };\n * ```\n */\nexport interface GroupMember {\n  /** Unique identifier for the group member */\n  id: string;\n  /** Display name of the group */\n  groupName: string;\n  /** Human-readable description of the group's purpose */\n  groupDescription: string;\n  /** Array of roles assigned to this group member (excludes permissions for security) */\n  roles: Role[];\n}\n\n/**\n * Request to add group members to an iTwin with role assignments.\n *\n * @remarks\n * The total number of roles assigned in this request must not exceed 50.\n * This can be achieved with many different configurations. For example,\n * 1 role can be assigned to 50 groups, or 5 roles can be assigned to 10 groups,\n * both resulting in 50 role assignments.\n *\n * @example\n * ```typescript\n * const request: AddGroupMembers = {\n *   members: [{\n *     groupId: \"6abbfcea-0eab-472a-b5f5-5c5a43df34b4\",\n *     roleIds: [\"5abbfcef-0eab-472a-b5f5-5c5a43df34b1\", \"83ee0d80-dea3-495a-b6c0-7bb102ebbcc3\"]\n *   }]\n * };\n * ```\n */\nexport interface GroupMemberAssignment {\n  /** Array of groups to add as members with their assigned roles */\n  members: {\n    /** The ID of the group to add as a member */\n    groupId: string;\n    /** Array of role IDs to assign to this group member */\n    roleIds: string[];\n  }[];\n}\n\n/**\n * API response wrapper for a single group member operation.\n */\nexport interface SingleGroupMemberResponse {\n  /** The group member data returned by the API */\n  member: GroupMember;\n}\n\n/**\n * API response wrapper for multiple group members operations.\n */\nexport interface MultipleGroupMembersResponse {\n  /** Array of group members returned by the API */\n  members: GroupMember[];\n}"]}

package/lib/cjs/types/Groups.d.ts

@@ -0,0 +1,83 @@
+import type { Links } from "./links";
+import type { GroupUser } from "./Members";
+/**
+ * Represents an access control group within an iTwin.
+ *
+ * @remarks
+ * Access Control groups provide the ability to manage groups of users at one time.
+ * You can create groups on the Account iTwin to manage access across iTwins or
+ * create a group for an individual iTwin. Groups created on an individual iTwin
+ * are available only on that iTwin.
+ *
+ * Groups can contain individual users. Groups can also reference Bentley Identity
+ * Management System (IMS) groups. By referencing an IMS group, you can manage
+ * groups of individuals in your Active Directory, while providing them access to
+ * iTwin Platform using role assignments.
+ *
+ * @example
+ * ```typescript
+ * const projectGroup: Group = {
+ *   id: "550e8400-e29b-41d4-a716-446655440000",
+ *   name: "Project Managers",
+ *   description: "Users with project management responsibilities",
+ *   members: [
+ *     { id: "user123", email: "manager@company.com", firstName: "John", lastName: "Smith" }
+ *   ],
+ *   imsGroups: ["COMPANY_ADMINS", "PROJECT_LEADS"]
+ * };
+ * ```
+ */
+export interface Group {
+    /** The Group id */
+    id: string;
+    /** The name of your Group */
+    name: string;
+    /** A description of your Group */
+    description: string;
+    /** List of members assigned to the Group. Max size of 50 */
+    members: GroupUser[];
+    /** List of IMS Groups assigned to the Group. Max size of 50 */
+    imsGroups: string[];
+}
+/**
+ * API response wrapper for a single group operation.
+ *
+ * @remarks
+ * This interface is used for API responses that return a single group,
+ * such as GET /groups/{id}, POST /groups, and PATCH /groups/{id} operations.
+ */
+export interface SingleGroupResponse {
+    /** The group data returned by the API */
+    group: Group;
+}
+/** Utility type to determine if any pagination parameters are present */
+export type HasAnyPaginationParam<T> = T extends {
+    top?: unknown;
+} | {
+    skip?: unknown;
+} ? true : false;
+/**
+ * API response wrapper for multiple groups operations.
+ * Conditional inclusion of HAL-style links based on pagination parameters.
+ *
+ * @remarks
+ * This interface is used for API responses that return multiple groups,
+ * such as GET /groups operations. The array may be empty if no groups
+ * match the query criteria or if the iTwin has no groups defined.
+ */
+export type GroupsResponseWithConditionalLinks<T> = HasAnyPaginationParam<T> extends true ? MultipleGroupsResponse : Omit<MultipleGroupsResponse, "_links">;
+/**
+ * API response wrapper for multiple groups operations.
+ *
+ * @remarks
+ * This interface is used for API responses that return multiple groups,
+ * such as GET /groups operations. The array may be empty if no groups
+ * match the query criteria or if the iTwin has no groups defined.
+ */
+export interface MultipleGroupsResponse {
+    /** Array of groups returned by the API */
+    groups: Group[];
+    /** HAL-style links for pagination and related resources */
+    _links: Links;
+}
+//# sourceMappingURL=Groups.d.ts.map

package/lib/cjs/types/Groups.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Groups.d.ts","sourceRoot":"","sources":["../../../src/types/Groups.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AACrC,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,WAAW,CAAC;AAE3C;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,MAAM,WAAW,KAAK;IACpB,mBAAmB;IACnB,EAAE,EAAE,MAAM,CAAC;IACX,6BAA6B;IAC7B,IAAI,EAAE,MAAM,CAAC;IACb,kCAAkC;IAClC,WAAW,EAAE,MAAM,CAAC;IACpB,4DAA4D;IAC5D,OAAO,EAAE,SAAS,EAAE,CAAC;IACrB,+DAA+D;IAC/D,SAAS,EAAE,MAAM,EAAE,CAAC;CACrB;AAED;;;;;;GAMG;AACH,MAAM,WAAW,mBAAmB;IAClC,yCAAyC;IACzC,KAAK,EAAE,KAAK,CAAC;CACd;AAED,yEAAyE;AACzE,MAAM,MAAM,qBAAqB,CAAC,CAAC,IACjC,CAAC,SAAS;IAAE,GAAG,CAAC,EAAE,OAAO,CAAA;CAAE,GAAG;IAAE,IAAI,CAAC,EAAE,OAAO,CAAA;CAAE,GAAG,IAAI,GAAG,KAAK,CAAC;AAElE;;;;;;;;GAQG;AACH,MAAM,MAAM,kCAAkC,CAAC,CAAC,IAC9C,qBAAqB,CAAC,CAAC,CAAC,SAAS,IAAI,GACjC,sBAAsB,GACtB,IAAI,CAAC,sBAAsB,EAAE,QAAQ,CAAC,CAAC;AAE7C;;;;;;;GAOG;AACH,MAAM,WAAW,sBAAsB;IACrC,0CAA0C;IAC1C,MAAM,EAAE,KAAK,EAAE,CAAC;IAChB,2DAA2D;IAE3D,MAAM,EAAE,KAAK,CAAC;CACf"}

package/lib/cjs/types/Groups.js

@@ -0,0 +1,7 @@
+"use strict";
+/*---------------------------------------------------------------------------------------------
+ * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+ * See LICENSE.md in the project root for license terms and full copyright notice.
+ *--------------------------------------------------------------------------------------------*/
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=Groups.js.map

package/lib/cjs/types/Groups.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Groups.js","sourceRoot":"","sources":["../../../src/types/Groups.ts"],"names":[],"mappings":";AAAA;;;gGAGgG","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\nimport type { Links } from \"./links\";\nimport type { GroupUser } from \"./Members\";\n\n/**\n * Represents an access control group within an iTwin.\n *\n * @remarks\n * Access Control groups provide the ability to manage groups of users at one time.\n * You can create groups on the Account iTwin to manage access across iTwins or\n * create a group for an individual iTwin. Groups created on an individual iTwin\n * are available only on that iTwin.\n *\n * Groups can contain individual users. Groups can also reference Bentley Identity\n * Management System (IMS) groups. By referencing an IMS group, you can manage\n * groups of individuals in your Active Directory, while providing them access to\n * iTwin Platform using role assignments.\n *\n * @example\n * ```typescript\n * const projectGroup: Group = {\n *   id: \"550e8400-e29b-41d4-a716-446655440000\",\n *   name: \"Project Managers\",\n *   description: \"Users with project management responsibilities\",\n *   members: [\n *     { id: \"user123\", email: \"manager@company.com\", firstName: \"John\", lastName: \"Smith\" }\n *   ],\n *   imsGroups: [\"COMPANY_ADMINS\", \"PROJECT_LEADS\"]\n * };\n * ```\n */\nexport interface Group {\n  /** The Group id */\n  id: string;\n  /** The name of your Group */\n  name: string;\n  /** A description of your Group */\n  description: string;\n  /** List of members assigned to the Group. Max size of 50 */\n  members: GroupUser[];\n  /** List of IMS Groups assigned to the Group. Max size of 50 */\n  imsGroups: string[];\n}\n\n/**\n * API response wrapper for a single group operation.\n *\n * @remarks\n * This interface is used for API responses that return a single group,\n * such as GET /groups/{id}, POST /groups, and PATCH /groups/{id} operations.\n */\nexport interface SingleGroupResponse {\n  /** The group data returned by the API */\n  group: Group;\n}\n\n/** Utility type to determine if any pagination parameters are present */\nexport type HasAnyPaginationParam<T> =\n  T extends { top?: unknown } | { skip?: unknown } ? true : false;\n\n/**\n * API response wrapper for multiple groups operations.\n * Conditional inclusion of HAL-style links based on pagination parameters.\n *\n * @remarks\n * This interface is used for API responses that return multiple groups,\n * such as GET /groups operations. The array may be empty if no groups\n * match the query criteria or if the iTwin has no groups defined.\n */\nexport type GroupsResponseWithConditionalLinks<T> =\n  HasAnyPaginationParam<T> extends true\n    ? MultipleGroupsResponse\n    : Omit<MultipleGroupsResponse, \"_links\">;\n\n/**\n * API response wrapper for multiple groups operations.\n *\n * @remarks\n * This interface is used for API responses that return multiple groups,\n * such as GET /groups operations. The array may be empty if no groups\n * match the query criteria or if the iTwin has no groups defined.\n */\nexport interface MultipleGroupsResponse {\n  /** Array of groups returned by the API */\n  groups: Group[];\n  /** HAL-style links for pagination and related resources */\n  // eslint-disable-next-line @typescript-eslint/naming-convention\n  _links: Links;\n}\n"]}