@itwin/access-control-client 3.7.0 → 4.1.0

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

@@ -1 +1 @@
-{"version":3,"file":"UserMembersClient.js","sourceRoot":"","sources":["../../../src/subClients/UserMembersClient.ts"],"names":[],"mappings":"AAgBA,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE1C,MAAM,OAAO,iBACX,SAAQ,UAAU;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","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,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE1C;GACG;AACH,MAAM,OAAO,iBACX,SAAQ,UAAU;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","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/esm/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/esm/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/esm/types/CommonApiTypes.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=CommonApiTypes.js.map

package/lib/esm/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/esm/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/esm/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/esm/types/GroupMember.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=GroupMember.js.map

package/lib/esm/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/esm/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/esm/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/esm/types/Groups.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=Groups.js.map

package/lib/esm/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"]}

package/lib/esm/types/ITwinJob.d.ts

@@ -0,0 +1,70 @@
+import type { ErrorDetail } from "./CommonApiTypes";
+/**
+ * Represents the current status of an iTwin job operation.
+ * Jobs progress through these states as they are processed by the system.
+ */
+export type ITwinJobStatus = "Active" | "Completed" | "PartialCompleted" | "Failed";
+/**
+ * This interface represents a job that manages user access control operations
+ * such as assigning roles, removing members, etc.
+ */
+export interface ITwinJob {
+    /** Unique identifier for the job */
+    id: string;
+    /** The iTwin ID this job operates on */
+    itwinId: string;
+    /** Current status of the job */
+    status: ITwinJobStatus;
+    /** Error details if the job encountered issues, empty array if no errors */
+    error: ErrorDetail[];
+}
+/**
+ * Available action types that can be performed in an iTwin job.
+ * These represent the different operations that can be batched together.
+ */
+export type ItwinJobActions = "assignRoles" | "unassignRoles" | "removeMembers";
+/**
+ * Defines the structure for iTwin job actions with type-safe action payloads.
+ *
+ * @remarks
+ * - `assignRoles` and `unassignRoles` actions include both email and roleIds
+ * - `removeMembers` actions only include email (roleIds are omitted)
+ * - Additional options can be provided for job configuration
+ *
+ * @example
+ * ```typescript
+ * const jobActions: ITwinJobActions = {
+ *   assignRoles: [
+ *     { email: "user@example.com", roleIds: ["admin", "viewer"] }
+ *   ],
+ *   removeMembers: [
+ *     { email: "former-user@example.com" } // No roleIds needed
+ *   ],
+ *   options: {
+ *     timeout: 30000,
+ *     retries: 3
+ *   }
+ * };
+ * ```
+ */
+export type ITwinJobActions = {
+    [K in ItwinJobActions]?: K extends "removeMembers" ? Omit<ITwinJobAction, "roleIds">[] : ITwinJobAction[];
+} & {
+    /** Additional configuration options for the job */
+    options?: Record<string, unknown>;
+};
+/**
+ * Represents a single action within an iTwin job that affects a user's access.
+ *
+ * @remarks
+ * This interface defines the core structure for user-related operations.
+ * When used with `removeMembers` actions, the `roleIds` property should be
+ * omitted.
+ */
+export interface ITwinJobAction {
+    /** Email address of the user to be affected by this action */
+    email: string;
+    /** Array of role IDs to assign or unassign (not used for removeMembers) */
+    roleIds: string[];
+}
+//# sourceMappingURL=ITwinJob.d.ts.map

package/lib/esm/types/ITwinJob.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ITwinJob.d.ts","sourceRoot":"","sources":["../../../src/types/ITwinJob.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAEpD;;;GAGG;AACH,MAAM,MAAM,cAAc,GACtB,QAAQ,GACR,WAAW,GACX,kBAAkB,GAClB,QAAQ,CAAC;AAEb;;;GAGG;AACH,MAAM,WAAW,QAAQ;IACvB,oCAAoC;IACpC,EAAE,EAAE,MAAM,CAAC;IACX,wCAAwC;IACxC,OAAO,EAAE,MAAM,CAAC;IAChB,gCAAgC;IAChC,MAAM,EAAE,cAAc,CAAC;IACvB,4EAA4E;IAC5E,KAAK,EAAE,WAAW,EAAE,CAAC;CACtB;AAED;;;GAGG;AACH,MAAM,MAAM,eAAe,GAAG,aAAa,GAAG,eAAe,GAAG,eAAe,CAAC;AAEhF;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,MAAM,MAAM,eAAe,GAAG;KAC3B,CAAC,IAAI,eAAe,CAAC,CAAC,EAAE,CAAC,SAAS,eAAe,GAC9C,IAAI,CAAC,cAAc,EAAE,SAAS,CAAC,EAAE,GACjC,cAAc,EAAE;CACrB,GAAG;IACF,mDAAmD;IACnD,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACnC,CAAC;AAEF;;;;;;;GAOG;AACH,MAAM,WAAW,cAAc;IAC7B,8DAA8D;IAC9D,KAAK,EAAE,MAAM,CAAC;IACd,2EAA2E;IAC3E,OAAO,EAAE,MAAM,EAAE,CAAC;CACnB"}

package/lib/esm/types/ITwinJob.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=ITwinJob.js.map

package/lib/esm/types/ITwinJob.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ITwinJob.js","sourceRoot":"","sources":["../../../src/types/ITwinJob.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 { ErrorDetail } from \"./CommonApiTypes\";\n\n/**\n * Represents the current status of an iTwin job operation.\n * Jobs progress through these states as they are processed by the system.\n */\nexport type ITwinJobStatus =\n  | \"Active\"      // Job is currently being processed\n  | \"Completed\"   // Job has finished successfully\n  | \"PartialCompleted\"  // Job completed with some failures\n  | \"Failed\";     // Job failed to complete\n\n/**\n * This interface represents a job that manages user access control operations\n * such as assigning roles, removing members, etc.\n */\nexport interface ITwinJob {\n  /** Unique identifier for the job */\n  id: string;\n  /** The iTwin ID this job operates on */\n  itwinId: string;\n  /** Current status of the job */\n  status: ITwinJobStatus;\n  /** Error details if the job encountered issues, empty array if no errors */\n  error: ErrorDetail[];\n}\n\n/**\n * Available action types that can be performed in an iTwin job.\n * These represent the different operations that can be batched together.\n */\nexport type ItwinJobActions = \"assignRoles\" | \"unassignRoles\" | \"removeMembers\";\n\n/**\n * Defines the structure for iTwin job actions with type-safe action payloads.\n *\n * @remarks\n * - `assignRoles` and `unassignRoles` actions include both email and roleIds\n * - `removeMembers` actions only include email (roleIds are omitted)\n * - Additional options can be provided for job configuration\n *\n * @example\n * ```typescript\n * const jobActions: ITwinJobActions = {\n *   assignRoles: [\n *     { email: \"user@example.com\", roleIds: [\"admin\", \"viewer\"] }\n *   ],\n *   removeMembers: [\n *     { email: \"former-user@example.com\" } // No roleIds needed\n *   ],\n *   options: {\n *     timeout: 30000,\n *     retries: 3\n *   }\n * };\n * ```\n */\nexport type ITwinJobActions = {\n  [K in ItwinJobActions]?: K extends \"removeMembers\"\n    ? Omit<ITwinJobAction, \"roleIds\">[]\n    : ITwinJobAction[];\n} & {\n  /** Additional configuration options for the job */\n  options?: Record<string, unknown>;\n};\n\n/**\n * Represents a single action within an iTwin job that affects a user's access.\n *\n * @remarks\n * This interface defines the core structure for user-related operations.\n * When used with `removeMembers` actions, the `roleIds` property should be\n * omitted.\n */\nexport interface ITwinJobAction {\n  /** Email address of the user to be affected by this action */\n  email: string;\n  /** Array of role IDs to assign or unassign (not used for removeMembers) */\n  roleIds: string[];\n}"]}

package/lib/esm/types/Invitations.d.ts

@@ -0,0 +1,146 @@
+import type { Links } from "./links";
+import type { Role } from "./Role";
+/**
+ * Represents an invitation sent to a user to join an iTwin as a member.
+ *
+ * @remarks
+ * Member invitations are created when external users (not in the same organization as the iTwin)
+ * are invited to join an iTwin. The invited user receives an email invitation and must accept it
+ * to become a member. Invitations have expiration dates and can be in various states.
+ *
+ * @example
+ * ```typescript
+ * const invitation: MemberInvitation = {
+ *   id: "550e8400-e29b-41d4-a716-446655440000",
+ *   email: "external.user@othercompany.com",
+ *   invitedByEmail: "admin@mycompany.com",
+ *   status: "Pending",
+ *   createdDate: "2023-10-15T10:30:00Z",
+ *   expirationDate: "2023-11-15T10:30:00Z",
+ *   roles: [
+ *     { id: "viewer-role", displayName: "Project Viewer", description : "Can view project details" }
+ *   ]
+ * };
+ * ```
+ */
+export interface MemberInvitation {
+    /** Unique identifier for the invitation */
+    id: string;
+    /** Email address of the invited user */
+    email: string;
+    /** Email address of the user who sent the invitation */
+    invitedByEmail: string;
+    /** Current status of the invitation */
+    status: MemberInvitationStatus;
+    /** ISO 8601 timestamp when the invitation was created */
+    createdDate: string;
+    /** ISO 8601 timestamp when the invitation expires */
+    expirationDate: string;
+    /** Optional array of roles that will be assigned upon acceptance (excludes permissions) */
+    roles?: Role[];
+}
+/**
+ * Represents the current state of a member invitation.
+ *
+ * @remarks
+ * Invitations start as "Pending" when first sent and transition to "Accepted"
+ * when the invited user accepts the invitation.
+ */
+export type MemberInvitationStatus = "Pending" | "Accepted";
+/**
+ * API response wrapper for multiple member invitations with pagination support.
+ *
+ * @remarks
+ * This interface is used for API responses that return collections of member invitations,
+ * such as GET /invitations operations. Includes HAL-style navigation links for pagination
+ * to handle large numbers of invitations efficiently.
+ *
+ * @example
+ * ```typescript
+ * const response: MultipleMemberInvitationResponse = {
+ *   invitations: [
+ *     { id: "inv1", email: "user1@external.com", status: "Pending", ... },
+ *     { id: "inv2", email: "user2@external.com", status: "Accepted", ... }
+ *   ],
+ *   _links: {
+ *     self: { href: "/members/invitations?$skip=0&$top=100" },
+ *     next: { href: "/members/invitations?$skip=100&$top=100" },
+ *     prev: { href: "/members/invitations?$skip=0&$top=100" }
+ *   }
+ * };
+ * ```
+ */
+export interface MultipleMemberInvitationResponse {
+    /** Array of member invitations in the current page */
+    invitations: MemberInvitation[];
+    /** HAL-style navigation links for pagination (first, next, prev, last) */
+    _links: Links;
+}
+/**
+ * API response wrapper for a member invitation.
+ *
+ * @remarks
+ * This interface is used for API responses that a single member invitation,
+ * such as GET /invitations operations.
+ *
+ * @example
+ * ```typescript
+ * const response: MultipleMemberInvitationResponse = {
+ *   invitation: {{ id: "inv1", email: "user1@external.com", status: "Pending", ... }} ,
+ * };
+ * ```
+ */
+export interface SingleMemberInvitationResponse {
+    /** The member invitation */
+    invitation: MemberInvitation;
+}
+/**
+ * Represents an invitation sent to a group member to join an iTwin.
+ *
+ * @remarks
+ * Retrieves a list of iTwin group member invitations. By default, users will receive the invitations they have sent.
+ * If the user is an iTwin Owner, they will receive all invitations for the iTwin.
+ * Invitations have an expiration of 7 days after their creation. Once that expiration passes, the invitation will not be returned.
+ *
+ * @example
+ * ```typescript
+ * const groupInvitation: GroupMemberInvitation = {
+ *   id: "550e8400-e29b-41d4-a716-446655440000",
+ *   email: "group.member@external.com",
+ *   invitedByEmail: "admin@mycompany.com",
+ *   status: "Pending",
+ *   createdDate: "2023-10-15T10:30:00Z",
+ *   expirationDate: "2023-11-15T10:30:00Z"
+ * };
+ * ```
+ */
+export type GroupMemberInvitation = Omit<MemberInvitation, "roles">;
+/**
+ * API response wrapper for multiple group member invitations with pagination support.
+ *
+ * @remarks
+ * This interface is used for API responses that return collections of group member invitations.
+ * Includes HAL-style navigation links for pagination to handle large numbers of group invitations efficiently.
+ *
+ * @example
+ * ```typescript
+ * const response: MultipleGroupMemberInvitationResponse = {
+ *   invitations: [
+ *     { id: "inv1", email: "user1@external.com", status: "Pending", ... },
+ *     { id: "inv2", email: "user2@external.com", status: "Accepted", ... }
+ *   ],
+ *   _links: {
+ *     self: { href: "/groups/invitations?$skip=0&$top=100" },
+ *     next: { href: "/groups/invitations?$skip=100&$top=100" },
+ *     prev: { href: "/groups/invitations?$skip=0&$top=100" }
+ *   }
+ * };
+ * ```
+ */
+export interface MultipleGroupMemberInvitationResponse {
+    /** Array of group member invitations in the current page */
+    invitations: GroupMemberInvitation[];
+    /** HAL-style navigation links for pagination (first, next, prev, last) */
+    _links: Links;
+}
+//# sourceMappingURL=Invitations.d.ts.map

package/lib/esm/types/Invitations.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Invitations.d.ts","sourceRoot":"","sources":["../../../src/types/Invitations.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AACrC,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AAEnC;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,MAAM,WAAW,gBAAgB;IAC/B,2CAA2C;IAC3C,EAAE,EAAE,MAAM,CAAC;IACX,wCAAwC;IACxC,KAAK,EAAE,MAAM,CAAC;IACd,wDAAwD;IACxD,cAAc,EAAE,MAAM,CAAC;IACvB,uCAAuC;IACvC,MAAM,EAAE,sBAAsB,CAAC;IAC/B,yDAAyD;IACzD,WAAW,EAAE,MAAM,CAAC;IACpB,qDAAqD;IACrD,cAAc,EAAE,MAAM,CAAC;IACvB,2FAA2F;IAC3F,KAAK,CAAC,EAAE,IAAI,EAAE,CAAC;CAChB;AAED;;;;;;GAMG;AACH,MAAM,MAAM,sBAAsB,GAAG,SAAS,GAAG,UAAU,CAAC;AAE5D;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,MAAM,WAAW,gCAAgC;IAC/C,sDAAsD;IACtD,WAAW,EAAE,gBAAgB,EAAE,CAAC;IAChC,0EAA0E;IAE1E,MAAM,EAAE,KAAK,CAAC;CACf;AAED;;;;;;;;;;;;;GAaG;AACH,MAAM,WAAW,8BAA8B;IAC7C,4BAA4B;IAC5B,UAAU,EAAE,gBAAgB,CAAC;CAC9B;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,MAAM,qBAAqB,GAAG,IAAI,CAAC,gBAAgB,EAAE,OAAO,CAAC,CAAC;AAEpE;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,MAAM,WAAW,qCAAqC;IACpD,4DAA4D;IAC5D,WAAW,EAAE,qBAAqB,EAAE,CAAC;IACrC,0EAA0E;IAE1E,MAAM,EAAE,KAAK,CAAC;CACf"}

package/lib/esm/types/Invitations.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=Invitations.js.map

package/lib/esm/types/Invitations.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Invitations.js","sourceRoot":"","sources":["../../../src/types/Invitations.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 { Role } from \"./Role\";\n\n/**\n * Represents an invitation sent to a user to join an iTwin as a member.\n *\n * @remarks\n * Member invitations are created when external users (not in the same organization as the iTwin)\n * are invited to join an iTwin. The invited user receives an email invitation and must accept it\n * to become a member. Invitations have expiration dates and can be in various states.\n *\n * @example\n * ```typescript\n * const invitation: MemberInvitation = {\n *   id: \"550e8400-e29b-41d4-a716-446655440000\",\n *   email: \"external.user@othercompany.com\",\n *   invitedByEmail: \"admin@mycompany.com\",\n *   status: \"Pending\",\n *   createdDate: \"2023-10-15T10:30:00Z\",\n *   expirationDate: \"2023-11-15T10:30:00Z\",\n *   roles: [\n *     { id: \"viewer-role\", displayName: \"Project Viewer\", description : \"Can view project details\" }\n *   ]\n * };\n * ```\n */\nexport interface MemberInvitation {\n  /** Unique identifier for the invitation */\n  id: string;\n  /** Email address of the invited user */\n  email: string;\n  /** Email address of the user who sent the invitation */\n  invitedByEmail: string;\n  /** Current status of the invitation */\n  status: MemberInvitationStatus;\n  /** ISO 8601 timestamp when the invitation was created */\n  createdDate: string;\n  /** ISO 8601 timestamp when the invitation expires */\n  expirationDate: string;\n  /** Optional array of roles that will be assigned upon acceptance (excludes permissions) */\n  roles?: Role[];\n}\n\n/**\n * Represents the current state of a member invitation.\n *\n * @remarks\n * Invitations start as \"Pending\" when first sent and transition to \"Accepted\"\n * when the invited user accepts the invitation.\n */\nexport type MemberInvitationStatus = \"Pending\" | \"Accepted\";\n\n/**\n * API response wrapper for multiple member invitations with pagination support.\n *\n * @remarks\n * This interface is used for API responses that return collections of member invitations,\n * such as GET /invitations operations. Includes HAL-style navigation links for pagination\n * to handle large numbers of invitations efficiently.\n *\n * @example\n * ```typescript\n * const response: MultipleMemberInvitationResponse = {\n *   invitations: [\n *     { id: \"inv1\", email: \"user1@external.com\", status: \"Pending\", ... },\n *     { id: \"inv2\", email: \"user2@external.com\", status: \"Accepted\", ... }\n *   ],\n *   _links: {\n *     self: { href: \"/members/invitations?$skip=0&$top=100\" },\n *     next: { href: \"/members/invitations?$skip=100&$top=100\" },\n *     prev: { href: \"/members/invitations?$skip=0&$top=100\" }\n *   }\n * };\n * ```\n */\nexport interface MultipleMemberInvitationResponse {\n  /** Array of member invitations in the current page */\n  invitations: MemberInvitation[];\n  /** HAL-style navigation links for pagination (first, next, prev, last) */\n  // eslint-disable-next-line @typescript-eslint/naming-convention\n  _links: Links;\n}\n\n/**\n * API response wrapper for a member invitation.\n *\n * @remarks\n * This interface is used for API responses that a single member invitation,\n * such as GET /invitations operations.\n *\n * @example\n * ```typescript\n * const response: MultipleMemberInvitationResponse = {\n *   invitation: {{ id: \"inv1\", email: \"user1@external.com\", status: \"Pending\", ... }} ,\n * };\n * ```\n */\nexport interface SingleMemberInvitationResponse {\n  /** The member invitation */\n  invitation: MemberInvitation;\n}\n\n/**\n * Represents an invitation sent to a group member to join an iTwin.\n *\n * @remarks\n * Retrieves a list of iTwin group member invitations. By default, users will receive the invitations they have sent.\n * If the user is an iTwin Owner, they will receive all invitations for the iTwin.\n * Invitations have an expiration of 7 days after their creation. Once that expiration passes, the invitation will not be returned.\n *\n * @example\n * ```typescript\n * const groupInvitation: GroupMemberInvitation = {\n *   id: \"550e8400-e29b-41d4-a716-446655440000\",\n *   email: \"group.member@external.com\",\n *   invitedByEmail: \"admin@mycompany.com\",\n *   status: \"Pending\",\n *   createdDate: \"2023-10-15T10:30:00Z\",\n *   expirationDate: \"2023-11-15T10:30:00Z\"\n * };\n * ```\n */\nexport type GroupMemberInvitation = Omit<MemberInvitation, \"roles\">;\n\n/**\n * API response wrapper for multiple group member invitations with pagination support.\n *\n * @remarks\n * This interface is used for API responses that return collections of group member invitations.\n * Includes HAL-style navigation links for pagination to handle large numbers of group invitations efficiently.\n *\n * @example\n * ```typescript\n * const response: MultipleGroupMemberInvitationResponse = {\n *   invitations: [\n *     { id: \"inv1\", email: \"user1@external.com\", status: \"Pending\", ... },\n *     { id: \"inv2\", email: \"user2@external.com\", status: \"Accepted\", ... }\n *   ],\n *   _links: {\n *     self: { href: \"/groups/invitations?$skip=0&$top=100\" },\n *     next: { href: \"/groups/invitations?$skip=100&$top=100\" },\n *     prev: { href: \"/groups/invitations?$skip=0&$top=100\" }\n *   }\n * };\n * ```\n */\nexport interface MultipleGroupMemberInvitationResponse {\n  /** Array of group member invitations in the current page */\n  invitations: GroupMemberInvitation[];\n  /** HAL-style navigation links for pagination (first, next, prev, last) */\n  // eslint-disable-next-line @typescript-eslint/naming-convention\n  _links: Links;\n}"]}