@itwin/access-control-client 3.7.0 → 4.1.0

package/lib/esm/accessControlClientInterfaces/GroupMembersClient.js

@@ -0,0 +1,6 @@
+/*---------------------------------------------------------------------------------------------
+ * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+ * See LICENSE.md in the project root for license terms and full copyright notice.
+ *--------------------------------------------------------------------------------------------*/
+export {};
+//# sourceMappingURL=GroupMembersClient.js.map

package/lib/esm/accessControlClientInterfaces/GroupMembersClient.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"GroupMembersClient.js","sourceRoot":"","sources":["../../../src/accessControlClientInterfaces/GroupMembersClient.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 { AccessToken } from \"@itwin/core-bentley\";\nimport type { BentleyAPIResponse, ODataQueryParams } from \"../types/CommonApiTypes\";\nimport type { GroupMemberAssignment, MultipleGroupMembersResponse, SingleGroupMemberResponse } from \"../types/GroupMember\";\nimport type { Links } from \"../types/links\";\n\nexport interface IGroupMembersClient {\n  /** Retrieves a list of group members and their roles assigned to a specified iTwin. */\n  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\n  /** Retrieves a specific group member for a specified iTwin. */\n  getITwinGroupMember(\n    accessToken: AccessToken,\n    iTwinId: string,\n    memberId: string\n  ): Promise<BentleyAPIResponse<SingleGroupMemberResponse>>;\n\n  /** Add new iTwin group members */\n  addITwinGroupMembers(\n    accessToken: AccessToken,\n    iTwinId: string,\n    newMembers: GroupMemberAssignment\n  ): Promise<BentleyAPIResponse<MultipleGroupMembersResponse>>;\n\n  /**  Remove the specified iTwin group member */\n  removeITwinGroupMember(\n    accessToken: AccessToken,\n    iTwinId: string,\n    memberId: string\n  ): Promise<BentleyAPIResponse<undefined>>;\n\n  /**  Update iTwin group member roles */\n  updateITwinGroupMember(\n    accessToken: AccessToken,\n    iTwinId: string,\n    memberId: string,\n    roleIds: string[]\n  ): Promise<BentleyAPIResponse<SingleGroupMemberResponse>>;\n}"]}

package/lib/esm/accessControlClientInterfaces/ITwinJobsClient.d.ts

@@ -0,0 +1,12 @@
+import type { AccessToken } from "@itwin/core-bentley";
+import type { BentleyAPIResponse, ResultMode } from "../types/CommonApiTypes";
+import type { ITwinJob, ITwinJobActions } from "../types/ITwinJob";
+export interface IITwinJobsClient {
+    /** Creates a new iTwin Job */
+    createITwinJob(accessToken: AccessToken, iTwinId: string, iTwinJobActions: ITwinJobActions): Promise<BentleyAPIResponse<ITwinJob>>;
+    /** Gets an iTwin Job. To see errors, pass in the `representation` result mode. */
+    getITwinJob<T extends ResultMode = "minimal">(accessToken: AccessToken, iTwinId: string, iTwinJobId: string, resultMode?: T): Promise<BentleyAPIResponse<T extends "representation" ? ITwinJob : Omit<ITwinJob, "error">>>;
+    /** Gets the iTwin Job Actions for a specified iTwin Job. */
+    getITwinJobActions(accessToken: AccessToken, iTwinId: string, iTwinJobId?: string): Promise<BentleyAPIResponse<ITwinJobActions>>;
+}
+//# sourceMappingURL=ITwinJobsClient.d.ts.map

package/lib/esm/accessControlClientInterfaces/ITwinJobsClient.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ITwinJobsClient.d.ts","sourceRoot":"","sources":["../../../src/accessControlClientInterfaces/ITwinJobsClient.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAC;AACvD,OAAO,KAAK,EAAE,kBAAkB,EAAE,UAAU,EAAE,MAAM,yBAAyB,CAAC;AAC9E,OAAO,KAAK,EAAE,QAAQ,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAEnE,MAAM,WAAW,gBAAgB;IAC/B,8BAA8B;IAC9B,cAAc,CACZ,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,MAAM,EACf,eAAe,EAAE,eAAe,GAC/B,OAAO,CAAC,kBAAkB,CAAC,QAAQ,CAAC,CAAC,CAAC;IAEzC,kFAAkF;IAClF,WAAW,CAAC,CAAC,SAAS,UAAU,GAAG,SAAS,EAC1C,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,CAAC;IAEhG,4DAA4D;IAC5D,kBAAkB,CAChB,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,MAAM,EACf,UAAU,CAAC,EAAE,MAAM,GAClB,OAAO,CAAC,kBAAkB,CAAC,eAAe,CAAC,CAAC,CAAC;CACjD"}

package/lib/esm/accessControlClientInterfaces/ITwinJobsClient.js

@@ -0,0 +1,6 @@
+/*---------------------------------------------------------------------------------------------
+ * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+ * See LICENSE.md in the project root for license terms and full copyright notice.
+ *--------------------------------------------------------------------------------------------*/
+export {};
+//# sourceMappingURL=ITwinJobsClient.js.map

package/lib/esm/accessControlClientInterfaces/ITwinJobsClient.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ITwinJobsClient.js","sourceRoot":"","sources":["../../../src/accessControlClientInterfaces/ITwinJobsClient.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 { AccessToken } from \"@itwin/core-bentley\";\nimport type { BentleyAPIResponse, ResultMode } from \"../types/CommonApiTypes\";\nimport type { ITwinJob, ITwinJobActions } from \"../types/ITwinJob\";\n\nexport interface IITwinJobsClient {\n  /** Creates a new iTwin Job */\n  createITwinJob(\n    accessToken: AccessToken,\n    iTwinId: string,\n    iTwinJobActions: ITwinJobActions\n  ): Promise<BentleyAPIResponse<ITwinJob>>;\n\n  /** Gets an iTwin Job. To see errors, pass in the `representation` result mode. */\n  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\n  /** Gets the iTwin Job Actions for a specified iTwin Job. */\n  getITwinJobActions(\n    accessToken: AccessToken,\n    iTwinId: string,\n    iTwinJobId?: string\n  ): Promise<BentleyAPIResponse<ITwinJobActions>>;\n}\n"]}

package/lib/esm/accessControlClientInterfaces/ItwinSharesClient.d.ts

@@ -0,0 +1,25 @@
+import type { AccessToken } from "@itwin/core-bentley";
+import type { BentleyAPIResponse } from "../types/CommonApiTypes";
+import type { MultiShareContractResponse, ShareContract, SingleShareContractResponse } from "../types/ShareContract";
+/** @beta */
+export interface IITwinSharesClient {
+    /** Create a new iTwin Share
+     * @beta
+     */
+    createITwinShare(accessToken: AccessToken, iTwinId: string, iTwinShare: Partial<Pick<ShareContract, "shareContract"> & {
+        expiration: string | null;
+    }>): Promise<BentleyAPIResponse<SingleShareContractResponse>>;
+    /** get a iTwin Share
+     * @beta
+    */
+    getITwinShare(accessToken: AccessToken, iTwinId: string, sharedId: string): Promise<BentleyAPIResponse<SingleShareContractResponse>>;
+    /** get a iTwin Share
+     * @beta
+     */
+    getITwinShares(accessToken: AccessToken, iTwinId: string): Promise<BentleyAPIResponse<MultiShareContractResponse>>;
+    /** delete a iTwin Share
+     * @beta
+    */
+    revokeITwinShare(accessToken: AccessToken, iTwinId: string, sharedId: string): Promise<BentleyAPIResponse<undefined>>;
+}
+//# sourceMappingURL=ItwinSharesClient.d.ts.map

package/lib/esm/accessControlClientInterfaces/ItwinSharesClient.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ItwinSharesClient.d.ts","sourceRoot":"","sources":["../../../src/accessControlClientInterfaces/ItwinSharesClient.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAC;AACvD,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,yBAAyB,CAAC;AAClE,OAAO,KAAK,EAAE,0BAA0B,EAAE,aAAa,EAAE,2BAA2B,EAAE,MAAM,wBAAwB,CAAC;AAErH,YAAY;AACZ,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,gBAAgB,CACd,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,CAAC;IAE5D;;MAEE;IACF,aAAa,CACX,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,MAAM,EACf,QAAQ,EAAE,MAAM,GACf,OAAO,CAAC,kBAAkB,CAAC,2BAA2B,CAAC,CAAC,CAAC;IAE1D;;OAEG;IACL,cAAc,CACZ,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,MAAM,GACd,OAAO,CAAC,kBAAkB,CAAC,0BAA0B,CAAC,CAAC,CAAC;IAE3D;;MAEE;IACF,gBAAgB,CACd,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,MAAM,EACf,QAAQ,EAAE,MAAM,GACf,OAAO,CAAC,kBAAkB,CAAC,SAAS,CAAC,CAAC,CAAC;CAC3C"}

package/lib/esm/accessControlClientInterfaces/ItwinSharesClient.js

@@ -0,0 +1,6 @@
+/*---------------------------------------------------------------------------------------------
+ * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+ * See LICENSE.md in the project root for license terms and full copyright notice.
+ *--------------------------------------------------------------------------------------------*/
+export {};
+//# sourceMappingURL=ItwinSharesClient.js.map

package/lib/esm/accessControlClientInterfaces/ItwinSharesClient.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ItwinSharesClient.js","sourceRoot":"","sources":["../../../src/accessControlClientInterfaces/ItwinSharesClient.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 { AccessToken } from \"@itwin/core-bentley\";\nimport type { BentleyAPIResponse } from \"../types/CommonApiTypes\";\nimport type { MultiShareContractResponse, ShareContract, SingleShareContractResponse } from \"../types/ShareContract\";\n\n/** @beta */\nexport interface IITwinSharesClient {\n  /** Create a new iTwin Share\n   * @beta\n   */\n  createITwinShare(\n    accessToken: AccessToken,\n    iTwinId: string,\n    iTwinShare: Partial<Pick<ShareContract, \"shareContract\"> & { expiration: string | null }>,\n  ): Promise<BentleyAPIResponse<SingleShareContractResponse>>;\n\n  /** get a iTwin Share\n   * @beta\n  */\n  getITwinShare(\n    accessToken: AccessToken,\n    iTwinId: string,\n    sharedId: string,\n  ): Promise<BentleyAPIResponse<SingleShareContractResponse>>;\n\n    /** get a iTwin Share\n     * @beta\n     */\n  getITwinShares(\n    accessToken: AccessToken,\n    iTwinId: string,\n  ): Promise<BentleyAPIResponse<MultiShareContractResponse>>;\n\n  /** delete a iTwin Share\n   * @beta\n  */\n  revokeITwinShare(\n    accessToken: AccessToken,\n    iTwinId: string,\n    sharedId: string,\n  ): Promise<BentleyAPIResponse<undefined>>;\n}\n"]}

package/lib/esm/accessControlClientInterfaces/MemberInvitationsClient.d.ts

@@ -0,0 +1,12 @@
+import type { AccessToken } from "@itwin/core-bentley";
+import type { BentleyAPIResponse, ODataQueryParams } from "../types/CommonApiTypes";
+import type { MultipleMemberInvitationResponse, SingleMemberInvitationResponse } from "../types/Invitations";
+export interface IMemberInvitationsClient {
+    /** Retrieves a list of member invitations. */
+    queryITwinMemberInvitations(accessToken: AccessToken, iTwinId: string, arg?: Pick<ODataQueryParams, "top" | "skip">): Promise<BentleyAPIResponse<MultipleMemberInvitationResponse>>;
+    /** Retrieves a member invitations by invite id. */
+    getITwinMemberInvitation(accessToken: AccessToken, iTwinId: string, invitationId: string): Promise<BentleyAPIResponse<SingleMemberInvitationResponse>>;
+    /** Removes an existing member invitation. */
+    deleteITwinMemberInvitation(accessToken: AccessToken, iTwinId: string, invitationId: string): Promise<BentleyAPIResponse<undefined>>;
+}
+//# sourceMappingURL=MemberInvitationsClient.d.ts.map

package/lib/esm/accessControlClientInterfaces/MemberInvitationsClient.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"MemberInvitationsClient.d.ts","sourceRoot":"","sources":["../../../src/accessControlClientInterfaces/MemberInvitationsClient.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAC;AACvD,OAAO,KAAK,EAAE,kBAAkB,EAAE,gBAAgB,EAAE,MAAM,yBAAyB,CAAC;AACpF,OAAO,KAAK,EAAE,gCAAgC,EAAE,8BAA8B,EAAE,MAAM,sBAAsB,CAAC;AAE7G,MAAM,WAAW,wBAAwB;IACvC,8CAA8C;IAC9C,2BAA2B,CACzB,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,MAAM,EACf,GAAG,CAAC,EAAE,IAAI,CAAC,gBAAgB,EAAE,KAAK,GAAG,MAAM,CAAC,GAC3C,OAAO,CAAC,kBAAkB,CAAC,gCAAgC,CAAC,CAAC,CAAC;IAEjE,mDAAmD;IACnD,wBAAwB,CACtB,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,MAAM,EACf,YAAY,EAAE,MAAM,GACnB,OAAO,CAAC,kBAAkB,CAAC,8BAA8B,CAAC,CAAC,CAAC;IAE/D,6CAA6C;IAC7C,2BAA2B,CACzB,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,MAAM,EACf,YAAY,EAAE,MAAM,GACnB,OAAO,CAAC,kBAAkB,CAAC,SAAS,CAAC,CAAC,CAAC;CAC3C"}

package/lib/esm/accessControlClientInterfaces/MemberInvitationsClient.js

@@ -0,0 +1,6 @@
+/*---------------------------------------------------------------------------------------------
+ * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+ * See LICENSE.md in the project root for license terms and full copyright notice.
+ *--------------------------------------------------------------------------------------------*/
+export {};
+//# sourceMappingURL=MemberInvitationsClient.js.map

package/lib/esm/accessControlClientInterfaces/MemberInvitationsClient.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"MemberInvitationsClient.js","sourceRoot":"","sources":["../../../src/accessControlClientInterfaces/MemberInvitationsClient.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 { AccessToken } from \"@itwin/core-bentley\";\nimport type { BentleyAPIResponse, ODataQueryParams } from \"../types/CommonApiTypes\";\nimport type { MultipleMemberInvitationResponse, SingleMemberInvitationResponse } from \"../types/Invitations\";\n\nexport interface IMemberInvitationsClient {\n  /** Retrieves a list of member invitations. */\n  queryITwinMemberInvitations(\n    accessToken: AccessToken,\n    iTwinId: string,\n    arg?: Pick<ODataQueryParams, \"top\" | \"skip\">\n  ): Promise<BentleyAPIResponse<MultipleMemberInvitationResponse>>;\n\n  /** Retrieves a member invitations by invite id. */\n  getITwinMemberInvitation(\n    accessToken: AccessToken,\n    iTwinId: string,\n    invitationId: string\n  ): Promise<BentleyAPIResponse<SingleMemberInvitationResponse>>;\n\n  /** Removes an existing member invitation. */\n  deleteITwinMemberInvitation(\n    accessToken: AccessToken,\n    iTwinId: string,\n    invitationId: string\n  ): Promise<BentleyAPIResponse<undefined>>;\n}"]}

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

@@ -0,0 +1,13 @@
+import type { AccessToken } from "@itwin/core-bentley";
+import type { OwnerMember } from "../access-control-client";
+import type { BentleyAPIResponse, ODataQueryParams } from "../types/CommonApiTypes";
+import type { AddOwnerMemberResponse, OwnerMemberMultiResponse } from "../types/OwnerMember";
+export interface IOwnerMembersClient {
+    /** Retrieves a list of owner members on a specified iTwin. */
+    queryITwinOwnerMembers(accessToken: AccessToken, iTwinId: string, arg?: Pick<ODataQueryParams, "top" | "skip">): Promise<BentleyAPIResponse<OwnerMemberMultiResponse>>;
+    /** Add or invite new iTwin owner member */
+    addITwinOwnerMember(accessToken: AccessToken, iTwinId: string, newMember: Pick<OwnerMember, "email">): Promise<BentleyAPIResponse<AddOwnerMemberResponse>>;
+    /**  Remove the specified iTwin owner member */
+    removeITwinOwnerMember(accessToken: AccessToken, iTwinId: string, memberId: string): Promise<BentleyAPIResponse<undefined>>;
+}
+//# sourceMappingURL=OwnerMembersClient%20.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"OwnerMembersClient .d.ts","sourceRoot":"","sources":["../../../src/accessControlClientInterfaces/OwnerMembersClient .ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAC;AACvD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,0BAA0B,CAAC;AAC5D,OAAO,KAAK,EAAE,kBAAkB,EAAE,gBAAgB,EAAE,MAAM,yBAAyB,CAAC;AACpF,OAAO,KAAK,EAAE,sBAAsB,EAAE,wBAAwB,EAAE,MAAM,sBAAsB,CAAC;AAG7F,MAAM,WAAW,mBAAmB;IAClC,8DAA8D;IAC9D,sBAAsB,CACpB,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,MAAM,EACf,GAAG,CAAC,EAAE,IAAI,CAAC,gBAAgB,EAAE,KAAK,GAAG,MAAM,CAAC,GAC3C,OAAO,CAAC,kBAAkB,CAAC,wBAAwB,CAAC,CAAC,CAAC;IAEzD,2CAA2C;IAC3C,mBAAmB,CACjB,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,MAAM,EACf,SAAS,EAAG,IAAI,CAAC,WAAW,EAAE,OAAO,CAAC,GACrC,OAAO,CAAC,kBAAkB,CAAC,sBAAsB,CAAC,CAAC,CAAC;IAEvD,+CAA+C;IAC/C,sBAAsB,CACpB,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,MAAM,EACf,QAAQ,EAAE,MAAM,GACf,OAAO,CAAC,kBAAkB,CAAC,SAAS,CAAC,CAAC,CAAC;CAC3C"}

package/lib/esm/accessControlClientInterfaces/OwnerMembersClient .js

@@ -0,0 +1,6 @@
+/*---------------------------------------------------------------------------------------------
+ * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+ * See LICENSE.md in the project root for license terms and full copyright notice.
+ *--------------------------------------------------------------------------------------------*/
+export {};
+//# sourceMappingURL=OwnerMembersClient%20.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"OwnerMembersClient .js","sourceRoot":"","sources":["../../../src/accessControlClientInterfaces/OwnerMembersClient .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 { AccessToken } from \"@itwin/core-bentley\";\nimport type { OwnerMember } from \"../access-control-client\";\nimport type { BentleyAPIResponse, ODataQueryParams } from \"../types/CommonApiTypes\";\nimport type { AddOwnerMemberResponse, OwnerMemberMultiResponse } from \"../types/OwnerMember\";\n\n\nexport interface IOwnerMembersClient {\n  /** Retrieves a list of owner members on a specified iTwin. */\n  queryITwinOwnerMembers(\n    accessToken: AccessToken,\n    iTwinId: string,\n    arg?: Pick<ODataQueryParams, \"top\" | \"skip\">\n  ): Promise<BentleyAPIResponse<OwnerMemberMultiResponse>>;\n\n  /** Add or invite new iTwin owner member */\n  addITwinOwnerMember(\n    accessToken: AccessToken,\n    iTwinId: string,\n    newMember : Pick<OwnerMember, \"email\">\n  ): Promise<BentleyAPIResponse<AddOwnerMemberResponse>>;\n\n  /**  Remove the specified iTwin owner member */\n  removeITwinOwnerMember(\n    accessToken: AccessToken,\n    iTwinId: string,\n    memberId: string\n  ): Promise<BentleyAPIResponse<undefined>>;\n}"]}

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

@@ -0,0 +1,10 @@
+import type { AccessToken } from "@itwin/core-bentley";
+import type { BentleyAPIResponse } from "../types/CommonApiTypes";
+import type { Permission } from "../types/Permission";
+export interface IPermissionsClient {
+    /** Retrieves the list of all available permissions **/
+    getPermissions(accessToken: AccessToken): Promise<BentleyAPIResponse<Permission[]>>;
+    /** Retrieves a list of permissions the identity has for a specified iTwin */
+    getITwinPermissions(accessToken: AccessToken, iTwinId: string): Promise<BentleyAPIResponse<Permission[]>>;
+}
+//# sourceMappingURL=PermissionsClient.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"PermissionsClient.d.ts","sourceRoot":"","sources":["../../../src/accessControlClientInterfaces/PermissionsClient.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAC;AACvD,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,yBAAyB,CAAC;AAClE,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AAEtD,MAAM,WAAW,kBAAkB;IACjC,uDAAuD;IACvD,cAAc,CACZ,WAAW,EAAE,WAAW,GACvB,OAAO,CAAC,kBAAkB,CAAC,UAAU,EAAE,CAAC,CAAC,CAAC;IAE7C,6EAA6E;IAC7E,mBAAmB,CACjB,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,MAAM,GACd,OAAO,CAAC,kBAAkB,CAAC,UAAU,EAAE,CAAC,CAAC,CAAC;CAC9C"}

package/lib/esm/accessControlClientInterfaces/PermissionsClient.js

@@ -0,0 +1,6 @@
+/*---------------------------------------------------------------------------------------------
+ * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+ * See LICENSE.md in the project root for license terms and full copyright notice.
+ *--------------------------------------------------------------------------------------------*/
+export {};
+//# sourceMappingURL=PermissionsClient.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"PermissionsClient.js","sourceRoot":"","sources":["../../../src/accessControlClientInterfaces/PermissionsClient.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 { AccessToken } from \"@itwin/core-bentley\";\nimport type { BentleyAPIResponse } from \"../types/CommonApiTypes\";\nimport type { Permission } from \"../types/Permission\";\n\nexport interface IPermissionsClient {\n  /** Retrieves the list of all available permissions **/\n  getPermissions(\n    accessToken: AccessToken\n  ): Promise<BentleyAPIResponse<Permission[]>>;\n\n  /** Retrieves a list of permissions the identity has for a specified iTwin */\n  getITwinPermissions(\n    accessToken: AccessToken,\n    iTwinId: string\n  ): Promise<BentleyAPIResponse<Permission[]>>;\n}"]}

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

@@ -0,0 +1,16 @@
+import type { AccessToken } from "@itwin/core-bentley";
+import type { BentleyAPIResponse } from "../types/CommonApiTypes";
+import type { Role } from "../types/Role";
+export interface IRolesClient {
+    /** Retrieves a list of roles the for a specified iTwin */
+    getITwinRoles(accessToken: AccessToken, iTwinId: string): Promise<BentleyAPIResponse<Role[]>>;
+    /** Retrieves a role for a specified iTwin */
+    getITwinRole(accessToken: AccessToken, iTwinId: string, roleId: string): Promise<BentleyAPIResponse<Role>>;
+    /** Creates a new iTwin Role */
+    createITwinRole(accessToken: AccessToken, iTwinId: string, role: Pick<Role, "displayName" | "description">): Promise<BentleyAPIResponse<Pick<Role, "id" | "displayName" | "description">>>;
+    /** Removes an existing iTwin Role */
+    deleteITwinRole(accessToken: AccessToken, iTwinId: string, roleId: string): Promise<BentleyAPIResponse<undefined>>;
+    /** Updates an existing iTwin Role */
+    updateITwinRole(accessToken: AccessToken, iTwinId: string, roleId: string, role: Partial<Omit<Role, "id">>): Promise<BentleyAPIResponse<Role>>;
+}
+//# sourceMappingURL=RolesClient.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"RolesClient.d.ts","sourceRoot":"","sources":["../../../src/accessControlClientInterfaces/RolesClient.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAC;AACvD,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,yBAAyB,CAAC;AAClE,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,eAAe,CAAC;AAG1C,MAAM,WAAW,YAAY;IAC3B,0DAA0D;IAC1D,aAAa,CACX,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,MAAM,GACd,OAAO,CAAC,kBAAkB,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC;IAEvC,6CAA6C;IAC7C,YAAY,CACV,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,MAAM,EACf,MAAM,EAAE,MAAM,GACb,OAAO,CAAC,kBAAkB,CAAC,IAAI,CAAC,CAAC,CAAC;IAErC,+BAA+B;IAC/B,eAAe,CACb,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,MAAM,EACf,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE,aAAa,GAAG,aAAa,CAAC,GAC9C,OAAO,CAAC,kBAAkB,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,GAAG,aAAa,GAAG,aAAa,CAAC,CAAC,CAAC,CAAC;IAEjF,qCAAqC;IACrC,eAAe,CACb,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,MAAM,EACf,MAAM,EAAE,MAAM,GACb,OAAO,CAAC,kBAAkB,CAAC,SAAS,CAAC,CAAC,CAAC;IAE1C,qCAAqC;IACrC,eAAe,CACb,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,MAAM,EACf,MAAM,EAAE,MAAM,EACd,IAAI,EAAE,OAAO,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC,GAC9B,OAAO,CAAC,kBAAkB,CAAC,IAAI,CAAC,CAAC,CAAC;CACtC"}

package/lib/esm/accessControlClientInterfaces/RolesClient.js

@@ -0,0 +1,6 @@
+/*---------------------------------------------------------------------------------------------
+ * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+ * See LICENSE.md in the project root for license terms and full copyright notice.
+ *--------------------------------------------------------------------------------------------*/
+export {};
+//# sourceMappingURL=RolesClient.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"RolesClient.js","sourceRoot":"","sources":["../../../src/accessControlClientInterfaces/RolesClient.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 { AccessToken } from \"@itwin/core-bentley\";\nimport type { BentleyAPIResponse } from \"../types/CommonApiTypes\";\nimport type { Role } from \"../types/Role\";\n\n\nexport interface IRolesClient {\n  /** Retrieves a list of roles the for a specified iTwin */\n  getITwinRoles(\n    accessToken: AccessToken,\n    iTwinId: string,\n  ): Promise<BentleyAPIResponse<Role[]>>;\n\n  /** Retrieves a role for a specified iTwin */\n  getITwinRole(\n    accessToken: AccessToken,\n    iTwinId: string,\n    roleId: string\n  ): Promise<BentleyAPIResponse<Role>>;\n\n  /** Creates a new iTwin Role */\n  createITwinRole(\n    accessToken: AccessToken,\n    iTwinId: string,\n    role: Pick<Role, \"displayName\" | \"description\">\n  ): Promise<BentleyAPIResponse<Pick<Role, \"id\" | \"displayName\" | \"description\">>>;\n\n  /** Removes an existing iTwin Role */\n  deleteITwinRole(\n    accessToken: AccessToken,\n    iTwinId: string,\n    roleId: string\n  ): Promise<BentleyAPIResponse<undefined>>;\n\n  /** Updates an existing iTwin Role */\n  updateITwinRole(\n    accessToken: AccessToken,\n    iTwinId: string,\n    roleId: string,\n    role: Partial<Omit<Role, \"id\">>\n  ): Promise<BentleyAPIResponse<Role>>;\n}"]}

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

@@ -0,0 +1,16 @@
+import type { AccessToken } from "@itwin/core-bentley";
+import type { BentleyAPIResponse, ODataQueryParams } from "../types/CommonApiTypes";
+import type { AddUserMember, AddUserMemberResponse, MultipleUserMembersResponse, SingleUserMemberResponse } from "../types/UserMembers";
+export interface IUserMembersClient {
+    /** Retrieves a list of user members and their roles assigned to a specified iTwin. */
+    queryITwinUserMembers(accessToken: AccessToken, iTwinId: string, arg?: Pick<ODataQueryParams, "top" | "skip">): Promise<BentleyAPIResponse<MultipleUserMembersResponse>>;
+    /** Retrieves a specific user member for a specified iTwin. */
+    getITwinUserMember(accessToken: AccessToken, iTwinId: string, memberId: string): Promise<BentleyAPIResponse<SingleUserMemberResponse>>;
+    /** Add or invite new iTwin user members */
+    addITwinUserMembers(accessToken: AccessToken, iTwinId: string, newMembers: AddUserMember[], customMessage?: string): Promise<BentleyAPIResponse<AddUserMemberResponse>>;
+    /**  Remove the specified iTwin user member */
+    removeITwinUserMember(accessToken: AccessToken, iTwinId: string, memberId: string): Promise<BentleyAPIResponse<undefined>>;
+    /**  Update iTwin user member roles */
+    updateITwinUserMember(accessToken: AccessToken, iTwinId: string, memberId: string, roleIds: string[]): Promise<BentleyAPIResponse<SingleUserMemberResponse>>;
+}
+//# sourceMappingURL=UserMembersClient.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"UserMembersClient.d.ts","sourceRoot":"","sources":["../../../src/accessControlClientInterfaces/UserMembersClient.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAC;AACvD,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;AAGxI,MAAM,WAAW,kBAAkB;IACjC,sFAAsF;IACtF,qBAAqB,CACnB,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,CAAC;IAE5D,8DAA8D;IAC9D,kBAAkB,CAChB,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,MAAM,EACf,QAAQ,EAAE,MAAM,GACf,OAAO,CAAC,kBAAkB,CAAC,wBAAwB,CAAC,CAAC,CAAA;IAExD,2CAA2C;IAC3C,mBAAmB,CACjB,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,CAAC;IAEtD,8CAA8C;IAC9C,qBAAqB,CACnB,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,MAAM,EACf,QAAQ,EAAE,MAAM,GACf,OAAO,CAAC,kBAAkB,CAAC,SAAS,CAAC,CAAC,CAAC;IAE1C,sCAAsC;IACtC,qBAAqB,CACnB,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,MAAM,EACf,QAAQ,EAAE,MAAM,EAChB,OAAO,EAAE,MAAM,EAAE,GAChB,OAAO,CAAC,kBAAkB,CAAC,wBAAwB,CAAC,CAAC,CAAC;CAC1D"}

package/lib/esm/accessControlClientInterfaces/UserMembersClient.js

@@ -0,0 +1,6 @@
+/*---------------------------------------------------------------------------------------------
+ * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+ * See LICENSE.md in the project root for license terms and full copyright notice.
+ *--------------------------------------------------------------------------------------------*/
+export {};
+//# sourceMappingURL=UserMembersClient.js.map

package/lib/esm/accessControlClientInterfaces/UserMembersClient.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"UserMembersClient.js","sourceRoot":"","sources":["../../../src/accessControlClientInterfaces/UserMembersClient.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 { AccessToken } from \"@itwin/core-bentley\";\nimport type { BentleyAPIResponse, ODataQueryParams } from \"../types/CommonApiTypes\";\nimport type { AddUserMember, AddUserMemberResponse, MultipleUserMembersResponse, SingleUserMemberResponse } from \"../types/UserMembers\";\n\n\nexport interface IUserMembersClient {\n  /** Retrieves a list of user members and their roles assigned to a specified iTwin. */\n  queryITwinUserMembers(\n    accessToken: AccessToken,\n    iTwinId: string,\n    arg?: Pick<ODataQueryParams, \"top\" | \"skip\">\n  ): Promise<BentleyAPIResponse<MultipleUserMembersResponse>>;\n\n  /** Retrieves a specific user member for a specified iTwin. */\n  getITwinUserMember(\n    accessToken: AccessToken,\n    iTwinId: string,\n    memberId: string\n  ): Promise<BentleyAPIResponse<SingleUserMemberResponse>>\n\n  /** Add or invite new iTwin user members */\n  addITwinUserMembers(\n    accessToken: AccessToken,\n    iTwinId: string,\n    newMembers: AddUserMember[],\n    customMessage?: string\n  ): Promise<BentleyAPIResponse<AddUserMemberResponse>>;\n\n  /**  Remove the specified iTwin user member */\n  removeITwinUserMember(\n    accessToken: AccessToken,\n    iTwinId: string,\n    memberId: string\n  ): Promise<BentleyAPIResponse<undefined>>;\n\n  /**  Update iTwin user member roles */\n  updateITwinUserMember(\n    accessToken: AccessToken,\n    iTwinId: string,\n    memberId: string,\n    roleIds: string[]\n  ): Promise<BentleyAPIResponse<SingleUserMemberResponse>>;\n}\n"]}

package/lib/esm/accessControlClientInterfaces/accessControl.d.ts

@@ -0,0 +1,23 @@
+import type { IGroupsClient } from "./GroupClient";
+import type { IGroupMemberInvitationClient } from "./GroupMemberInvitationClient";
+import type { IGroupMembersClient } from "./GroupMembersClient";
+import type { IITwinJobsClient } from "./ITwinJobsClient";
+import type { IITwinSharesClient } from "./ItwinSharesClient";
+import type { IMemberInvitationsClient } from "./MemberInvitationsClient";
+import type { IOwnerMembersClient } from "./OwnerMembersClient ";
+import type { IPermissionsClient } from "./PermissionsClient";
+import type { IRolesClient } from "./RolesClient";
+import type { IUserMembersClient } from "./UserMembersClient";
+export interface IAccessControlClient {
+    permissions: IPermissionsClient;
+    roles: IRolesClient;
+    groups: IGroupsClient;
+    userMembers: IUserMembersClient;
+    groupMembers: IGroupMembersClient;
+    ownerMembers: IOwnerMembersClient;
+    memberInvitations: IMemberInvitationsClient;
+    itwinJobs: IITwinJobsClient;
+    itwinShares: IITwinSharesClient;
+    groupMemberInvitations: IGroupMemberInvitationClient;
+}
+//# sourceMappingURL=accessControl.d.ts.map

package/lib/esm/accessControlClientInterfaces/accessControl.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"accessControl.d.ts","sourceRoot":"","sources":["../../../src/accessControlClientInterfaces/accessControl.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,eAAe,CAAC;AACnD,OAAO,KAAK,EAAE,4BAA4B,EAAE,MAAM,+BAA+B,CAAC;AAClF,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,sBAAsB,CAAC;AAChE,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,mBAAmB,CAAC;AAC1D,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,qBAAqB,CAAC;AAC9D,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,2BAA2B,CAAC;AAC1E,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AACjE,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,qBAAqB,CAAC;AAC9D,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,eAAe,CAAC;AAClD,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,qBAAqB,CAAC;AAE9D,MAAM,WAAW,oBAAoB;IACnC,WAAW,EAAE,kBAAkB,CAAC;IAChC,KAAK,EAAE,YAAY,CAAC;IACpB,MAAM,EAAE,aAAa,CAAC;IACtB,WAAW,EAAE,kBAAkB,CAAC;IAChC,YAAY,EAAE,mBAAmB,CAAC;IAClC,YAAY,EAAE,mBAAmB,CAAC;IAClC,iBAAiB,EAAE,wBAAwB,CAAC;IAC5C,SAAS,EAAE,gBAAgB,CAAC;IAC5B,WAAW,EAAE,kBAAkB,CAAC;IAChC,sBAAsB,EAAE,4BAA4B,CAAA;CACrD"}

package/lib/esm/accessControlClientInterfaces/accessControl.js

@@ -0,0 +1,6 @@
+/*---------------------------------------------------------------------------------------------
+ * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+ * See LICENSE.md in the project root for license terms and full copyright notice.
+ *--------------------------------------------------------------------------------------------*/
+export {};
+//# sourceMappingURL=accessControl.js.map

package/lib/esm/accessControlClientInterfaces/accessControl.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"accessControl.js","sourceRoot":"","sources":["../../../src/accessControlClientInterfaces/accessControl.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 { IGroupsClient } from \"./GroupClient\";\nimport type { IGroupMemberInvitationClient } from \"./GroupMemberInvitationClient\";\nimport type { IGroupMembersClient } from \"./GroupMembersClient\";\nimport type { IITwinJobsClient } from \"./ITwinJobsClient\";\nimport type { IITwinSharesClient } from \"./ItwinSharesClient\";\nimport type { IMemberInvitationsClient } from \"./MemberInvitationsClient\";\nimport type { IOwnerMembersClient } from \"./OwnerMembersClient \";\nimport type { IPermissionsClient } from \"./PermissionsClient\";\nimport type { IRolesClient } from \"./RolesClient\";\nimport type { IUserMembersClient } from \"./UserMembersClient\";\n\nexport interface IAccessControlClient {\n  permissions: IPermissionsClient;\n  roles: IRolesClient;\n  groups: IGroupsClient;\n  userMembers: IUserMembersClient;\n  groupMembers: IGroupMembersClient;\n  ownerMembers: IOwnerMembersClient;\n  memberInvitations: IMemberInvitationsClient;\n  itwinJobs: IITwinJobsClient;\n  itwinShares: IITwinSharesClient;\n  groupMemberInvitations: IGroupMemberInvitationClient\n}\n"]}

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

@@ -2,40 +2,99 @@
  * @module AccessControlClient
  */
 import type { AccessToken } from "@itwin/core-bentley";
-import type { AccessControlAPIResponse, AccessControlQueryArg } from "../accessControlTypes";
-declare type Method = "GET" | "POST" | "PUT" | "PATCH" | "DELETE";
-interface RequestConfig {
-    method: Method;
-    url: string;
-    data?: any;
-    headers?: Record<string, string>;
-    validateStatus?: (status: number) => boolean;
-}
+import type { BentleyAPIResponse, Method, ODataQueryParams, RequestConfig } from "../types/CommonApiTypes";
+import { ParameterMapping } from "../types/typeUtils";
+/**
+ * Base client class providing common functionality for Access Control API requests.
+ * Handles authentication, request configuration, and query string building, and error validation.
+ */
 export declare class BaseClient {
     protected _baseUrl: string;
+    /**
+   * Creates a new BaseClient instance for Access Control API operations
+   * @param url - Optional custom base URL, defaults to production iTwins API URL
+   *
+   * @example
+   * ```typescript
+   * // Use default production URL
+   * const client = new BaseClient();
+   *
+   * // Use custom URL for development/testing
+   * const client = new ITwinsAccessClient("https://api.bentley.com/accesscontrol/itwins");
+   * ```
+   */
     constructor(url?: string);
     /**
-      * Sends a basic API request
-      * @param accessToken The client access token
-      * @param method The method type of the request (ex. GET, POST, DELETE, etc)
-      * @param url The url of the request
-      */
-    protected sendGenericAPIRequest(accessToken: AccessToken, method: Method, url: string, data?: any, property?: string, additionalHeaders?: {
-        [key: string]: string;
-    }): Promise<AccessControlAPIResponse<any>>;
+     * Maps the some properties of {@link ODataQueryParams} to their corresponding query parameter names.
+     *
+     * @remarks
+     * This mapping is used to translate internal property names to the expected parameter names
+     * when constructing requests. Properties mapped to empty strings are excluded from
+     * the query string as they should be sent as headers instead.
+     *
+     * The mapping includes OData query parameters (prefixed with $) for pagination.
+     *
+     * @readonly
+     */
+    protected static readonly paginationParamMapping: ParameterMapping<Pick<ODataQueryParams, "top" | "skip">>;
+    /**
+     * Sends a basic API request to the specified URL with the given method and data.
+     * @param accessToken The client access token
+     * @param method The HTTP method of the request (GET, POST, DELETE, etc)
+     * @param url The URL of the request
+     * @param data Optional request body data
+     * @param property Optional property name to extract from response data
+     * @param additionalHeaders Optional additional headers to include in the request
+     * @returns Promise resolving to a BentleyAPIResponse containing the response data or error
+     */
+    protected sendGenericAPIRequest<TResponse = unknown, TData = unknown>(accessToken: AccessToken, method: Method, url: string, data?: TData, property?: string, additionalHeaders?: Record<string, string>): Promise<BentleyAPIResponse<TResponse>>;
+    /**
+     * Build the request configuration including method, headers, and body
+     * @param accessTokenString The client access token
+     * @param method The HTTP method of the request
+     * @param url The URL of the request
+     * @param data Optional request body data
+     * @param additionalHeaders Optional additional headers to include in the request
+     * @returns RequestConfig object with method, url, body, and headers
+     */
+    protected getRequestOptions<TData>(accessTokenString: AccessToken, method: Method, url: string, data?: TData, additionalHeaders?: Record<string, string>): RequestConfig;
     /**
-      * Build the request methods, headers, and other options
-      * @param accessToken The client access token
-      */
-    protected getRequestOptions(accessToken: AccessToken, method: Method, url: string, data?: any, additionalHeaders?: {
-        [key: string]: string;
-    }): RequestConfig;
+   * Builds a query string to be appended to a URL from query arguments
+   * @param parameterMapping - Parameter mapping configuration that maps object properties to query parameter names
+   * @param queryArg - Object containing queryable properties for filtering
+   * @returns Query string with parameters applied, ready to append to a URL
+   *
+   * @example
+   * ```typescript
+   * const queryString = this.getQueryString(
+   *   BaseClient.paginationParamMapping,
+   *   {
+   *     top: 10,
+   *     skip: 5,
+   *   }
+   * );
+   * // Returns: "$top=10&$skip=5"
+   * ```
+   */
+    protected getQueryString<T>(parameterMapping: ParameterMapping<NonNullable<T>>, queryArg?: T): string;
     /**
-      * Build a query to be appended to a URL
-      * @param queryArg Object container queryable properties
-      * @returns query string with AccessControlQueryArg applied, which should be appended to a url
-      */
-    protected getQueryString(queryArg: AccessControlQueryArg): string;
+     * Helper method to build query parameter array from mapping.
+     * Uses exhaustive parameter mapping to ensure type safety and prevent missing parameters.
+     * Automatically handles URL encoding and filters out excluded parameters.
+     *
+     * @param queryArg - Object containing queryable properties
+     * @param mapping - Parameter mapping configuration that maps object properties to query parameter names
+     * @returns Array of formatted query parameter strings ready for URL construction
+     *
+     * @example
+     * ```typescript
+     * const params = this.buildQueryParams(
+     *   { top: 10, skip: 5 },
+     *   { top: "$top", skip: "$skip" }
+     * );
+     * // Returns: ["$top=10", "$skip=5"]
+     * ```
+     */
+    private buildQueryParams;
 }
-export {};
 //# sourceMappingURL=BaseClient.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"BaseClient.d.ts","sourceRoot":"","sources":["../../../src/subClients/BaseClient.ts"],"names":[],"mappings":"AAIA;;GAEG;AACH,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAC;AACvD,OAAO,KAAK,EAAE,wBAAwB,EAAE,qBAAqB,EAAE,MAAM,uBAAuB,CAAC;AAG7F,aAAK,MAAM,GAAG,KAAK,GAAG,MAAM,GAAG,KAAK,GAAG,OAAO,GAAG,QAAQ,CAAC;AAE1D,UAAU,aAAa;IACrB,MAAM,EAAE,MAAM,CAAC;IACf,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,CAAC,EAAE,GAAG,CAAC;IACX,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACjC,cAAc,CAAC,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,OAAO,CAAC;CAC9C;AAED,qBAAa,UAAU;IACrB,SAAS,CAAC,QAAQ,EAAE,MAAM,CAAkD;gBAEzD,GAAG,CAAC,EAAE,MAAM;IAa/B;;;;;QAKI;cACY,qBAAqB,CACnC,WAAW,EAAE,WAAW,EACxB,MAAM,EAAE,MAAM,EACd,GAAG,EAAE,MAAM,EACX,IAAI,CAAC,EAAE,GAAG,EACV,QAAQ,CAAC,EAAE,MAAM,EACjB,iBAAiB,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,GAC5C,OAAO,CAAC,wBAAwB,CAAC,GAAG,CAAC,CAAC;IA2CzC;;;QAGI;IACJ,SAAS,CAAC,iBAAiB,CAAC,WAAW,EAAE,WAAW,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,GAAG,EAAE,iBAAiB,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,GAAG,aAAa;IAiB5J;;;;QAII;IACJ,SAAS,CAAC,cAAc,CAAC,QAAQ,EAAE,qBAAqB,GAAG,MAAM;CAclE"}
+{"version":3,"file":"BaseClient.d.ts","sourceRoot":"","sources":["../../../src/subClients/BaseClient.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAC;AACvD,OAAO,KAAK,EAEV,kBAAkB,EAClB,MAAM,EACN,gBAAgB,EAChB,aAAa,EACd,MAAM,yBAAyB,CAAC;AACjC,OAAO,EAAe,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AA8BnE;;;GAGG;AACH,qBAAa,UAAU;IACrB,SAAS,CAAC,QAAQ,EAAE,MAAM,CAAkD;IAE1E;;;;;;;;;;;;KAYC;gBACgB,GAAG,CAAC,EAAE,MAAM;IAa/B;;;;;;;;;;;OAWG;IACH,SAAS,CAAC,MAAM,CAAC,QAAQ,CAAC,sBAAsB,EAAE,gBAAgB,CAAC,IAAI,CAAC,gBAAgB,EAAE,KAAK,GAAG,MAAM,CAAC,CAAC,CAI7F;IAEb;;;;;;;;;OASG;cACa,qBAAqB,CAAC,SAAS,GAAG,OAAO,EAAE,KAAK,GAAG,OAAO,EACxE,WAAW,EAAE,WAAW,EACxB,MAAM,EAAE,MAAM,EACd,GAAG,EAAE,MAAM,EACX,IAAI,CAAC,EAAE,KAAK,EACZ,QAAQ,CAAC,EAAE,MAAM,EACjB,iBAAiB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GACzC,OAAO,CAAC,kBAAkB,CAAC,SAAS,CAAC,CAAC;IAuDzC;;;;;;;;OAQG;IACH,SAAS,CAAC,iBAAiB,CAAC,KAAK,EAC/B,iBAAiB,EAAE,WAAW,EAC9B,MAAM,EAAE,MAAM,EACd,GAAG,EAAE,MAAM,EACX,IAAI,CAAC,EAAE,KAAK,EACZ,iBAAiB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GACzC,aAAa;IAuBd;;;;;;;;;;;;;;;;;KAiBC;IACH,SAAS,CAAC,cAAc,CAAC,CAAC,EACxB,gBAAgB,EAAE,gBAAgB,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,EAClD,QAAQ,CAAC,EAAE,CAAC,GACX,MAAM;IAOT;;;;;;;;;;;;;;;;;OAiBG;IACH,OAAO,CAAC,gBAAgB;CAoBzB"}