@itwin/access-control-client 3.7.0 → 4.0.0

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

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

@@ -0,0 +1 @@
+{"version":3,"file":"Members.js","sourceRoot":"","sources":["../../../src/types/Members.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\ninterface UserBase {\n  /** Unique identifier for the user */\n  id: string;\n  /** Email address of the user */\n  email: string;\n  /** First name of the user */\n  givenName: string;\n  /** Last name of the user */\n  surname: string;\n  /** Organization the user belongs to */\n  organization: string;\n}\n\n/**\n * Represents a user within a group in the access control system.\n *\n * @example\n * ```typescript\n * const groupUser: GroupUser = {\n *   id: \"550e8400-e29b-41d4-a716-446655440000\",\n *   email: \"sarah.connor@techcorp.com\",\n *   givenName: \"Sarah\",\n *   surname: \"Connor\",\n *   organization: \"TechCorp Industries\"\n * };\n * ```\n */\nexport type GroupUser = UserBase;\n\n/**\n * Represents a user who is a member of an iTwin with associated roles and profile information.\n *\n * @remarks\n * User members are individuals who have been added to an iTwin and assigned specific roles.\n * This provides information about the user's identity, assigned roles, and organization.\n *\n * @example\n * ```typescript\n * const userMember: UserMember = {\n *   id: \"550e8400-e29b-41d4-a716-446655440000\",\n *   email: \"john.smith@company.com\",\n *   givenName: \"John\",\n *   surname: \"Smith\",\n *   organization: \"ACME Corporation\",\n *   roles: [\n *     { id: \"admin-role\", displayName: \"Administrator\", description : \"Has full access to all resources\" },\n *     { id: \"viewer-role\", displayName: \"Project Viewer\", description : \"Can view project details\" }\n *   ]\n * };\n * ```\n */\nexport interface UserMember extends UserBase{\n  /** Array of roles assigned to this user member */\n  roles: Role[];\n}\n\n/**\n * Represents an iTwin owner member with their basic information.\n *\n * @example\n * ```typescript\n * const ownerMember: OwnerMember = {\n *   id: \"550e8400-e29b-41d4-a716-446655440000\",\n *   email: \"john.doe@company.com\",\n *   givenName: \"John\",\n *   surname: \"Doe\",\n *   organization: \"Acme Corporation\"\n * };\n * ```\n */\nexport type OwnerMember = UserBase;"]}

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

@@ -0,0 +1,105 @@
+import type { MemberInvitation } from "./Invitations";
+import type { Links } from "./links";
+import type { OwnerMember } from "./Members";
+/**
+ * Response object when adding a new owner member to an iTwin.
+ *
+ * @remarks
+ * Add new iTwin owner members. iTwin Owners are users which have full control over the iTwin.
+ * Each owner is granted all permissions on the iTwin, allowing them to perform any action on the iTwin they own.
+ *
+ * Users which are external (i.e. not in the same organization as the iTwin) are not automatically added to the iTwin.
+ * Instead, they're invited. Users which are not external, are immediately added as members on the iTwin.
+ *
+ * Invited individuals will receive an invitation via Email, where they'll be prompted to accept the invitation.
+ * Upon accepting, they'll then become a member of the iTwin.
+ *
+ * @example
+ * ```typescript
+ * const addResponse: AddOwnerMemberResponse = {
+ *   member: {
+ *     id: "550e8400-e29b-41d4-a716-446655440000",
+ *     email: "new.owner@company.com",
+ *     givenName: "Jane",
+ *     surname: "Smith",
+ *     organization: "Tech Solutions Inc"
+ *   },
+ *   invitation: {
+ *     id: "inv-550e8400-e29b-41d4-a716-446655440001",
+ *     email: "new.owner@company.com",
+ *     invitedByEmail: "admin@company.com",
+ *     status: "Pending",
+ *     createdDate: "2023-10-15T10:30:00Z",
+ *     expirationDate: "2023-11-15T10:30:00Z"
+ *   }
+ * };
+ * ```
+ */
+export interface AddOwnerMemberResponse {
+    /** The newly added owner member */
+    member: OwnerMember;
+    /** Invitation details for the new member */
+    invitation: MemberInvitation | null;
+}
+/**
+ * Response object containing multiple owner members with pagination links.
+ *
+ * @example
+ * ```typescript
+ * const multiResponse: OwnerMemberMultiResponse = {
+ *   members: [
+ *     {
+ *       id: "owner1-550e8400-e29b-41d4-a716-446655440000",
+ *       email: "owner1@company.com",
+ *       givenName: "Alice",
+ *       surname: "Johnson",
+ *       organization: "Primary Corp"
+ *     },
+ *     {
+ *       id: "owner2-550e8400-e29b-41d4-a716-446655440001",
+ *       email: "owner2@company.com",
+ *       givenName: "Bob",
+ *       surname: "Wilson",
+ *       organization: "Secondary LLC"
+ *     }
+ *   ],
+ *   _links: {
+ *     self: { href: "/members/owners?$skip=0&$top=100 },
+ *     next: { href: "/members/owners?$skip=100&$top=100" },
+ *     prev: { href: "/members/owners?$skip=0&$top=100" }
+ *   }
+ * };
+ * ```
+ *
+ * @remarks
+ * This interface is used for API responses that return collections of owner members,
+ * such as GET /members/owners operations. Includes HAL-style navigation links for pagination.
+ *
+ * #### Missing Users
+ * When users are removed from the Bentley Identity Management System, they are not automatically removed from the iTwin. Therefore, it is possible to have a situation where the user is no longer valid, yet they are still an owner member of the iTwin. When this happens, the owner members will be returned from this API endpoint with the following values:
+ * ```typescript
+ * { members: [
+ *     {
+ *       "id": <memberId>,
+ *       "email": null,
+ *       "givenName": null,
+ *       "surname": null,
+ *       "organization": null,
+ *       ...
+ *     }
+ *   ]
+ * }
+ * ```
+ *
+ * #### Cleanup
+ * The Access Control API will perform a once-a-week cleanup to remove these "Missing Users". You can rely on this automated clean-up if this timeline is sufficient.
+ *
+ * If not, you can use the Remove iTwin Owner Member API (use the memberId) to remove the owner member from the iTwin.
+ */
+export interface OwnerMemberMultiResponse {
+    /** Array of owner members */
+    members: OwnerMember[];
+    /** Navigation links for pagination */
+    "_links": Links;
+}
+//# sourceMappingURL=OwnerMember.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"OwnerMember.d.ts","sourceRoot":"","sources":["../../../src/types/OwnerMember.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,eAAe,CAAC;AACtD,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AACrC,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,WAAW,CAAC;AAE7C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiCG;AACH,MAAM,WAAW,sBAAsB;IACrC,mCAAmC;IACnC,MAAM,EAAE,WAAW,CAAC;IACpB,4CAA4C;IAC5C,UAAU,EAAE,gBAAgB,GAAG,IAAI,CAAC;CACrC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAsDG;AACH,MAAM,WAAW,wBAAwB;IACvC,6BAA6B;IAC7B,OAAO,EAAE,WAAW,EAAE,CAAC;IACvB,sCAAsC;IAEtC,QAAQ,EAAE,KAAK,CAAC;CACjB"}

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

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

@@ -0,0 +1 @@
+{"version":3,"file":"OwnerMember.js","sourceRoot":"","sources":["../../../src/types/OwnerMember.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 { MemberInvitation } from \"./Invitations\";\nimport type { Links } from \"./links\";\nimport type { OwnerMember } from \"./Members\";\n\n/**\n * Response object when adding a new owner member to an iTwin.\n *\n * @remarks\n * Add new iTwin owner members. iTwin Owners are users which have full control over the iTwin.\n * Each owner is granted all permissions on the iTwin, allowing them to perform any action on the iTwin they own.\n *\n * Users which are external (i.e. not in the same organization as the iTwin) are not automatically added to the iTwin.\n * Instead, they're invited. Users which are not external, are immediately added as members on the iTwin.\n *\n * Invited individuals will receive an invitation via Email, where they'll be prompted to accept the invitation.\n * Upon accepting, they'll then become a member of the iTwin.\n *\n * @example\n * ```typescript\n * const addResponse: AddOwnerMemberResponse = {\n *   member: {\n *     id: \"550e8400-e29b-41d4-a716-446655440000\",\n *     email: \"new.owner@company.com\",\n *     givenName: \"Jane\",\n *     surname: \"Smith\",\n *     organization: \"Tech Solutions Inc\"\n *   },\n *   invitation: {\n *     id: \"inv-550e8400-e29b-41d4-a716-446655440001\",\n *     email: \"new.owner@company.com\",\n *     invitedByEmail: \"admin@company.com\",\n *     status: \"Pending\",\n *     createdDate: \"2023-10-15T10:30:00Z\",\n *     expirationDate: \"2023-11-15T10:30:00Z\"\n *   }\n * };\n * ```\n */\nexport interface AddOwnerMemberResponse {\n  /** The newly added owner member */\n  member: OwnerMember;\n  /** Invitation details for the new member */\n  invitation: MemberInvitation | null;\n}\n\n/**\n * Response object containing multiple owner members with pagination links.\n *\n * @example\n * ```typescript\n * const multiResponse: OwnerMemberMultiResponse = {\n *   members: [\n *     {\n *       id: \"owner1-550e8400-e29b-41d4-a716-446655440000\",\n *       email: \"owner1@company.com\",\n *       givenName: \"Alice\",\n *       surname: \"Johnson\",\n *       organization: \"Primary Corp\"\n *     },\n *     {\n *       id: \"owner2-550e8400-e29b-41d4-a716-446655440001\",\n *       email: \"owner2@company.com\",\n *       givenName: \"Bob\",\n *       surname: \"Wilson\",\n *       organization: \"Secondary LLC\"\n *     }\n *   ],\n *   _links: {\n *     self: { href: \"/members/owners?$skip=0&$top=100 },\n *     next: { href: \"/members/owners?$skip=100&$top=100\" },\n *     prev: { href: \"/members/owners?$skip=0&$top=100\" }\n *   }\n * };\n * ```\n *\n * @remarks\n * This interface is used for API responses that return collections of owner members,\n * such as GET /members/owners operations. Includes HAL-style navigation links for pagination.\n *\n * #### Missing Users\n * When users are removed from the Bentley Identity Management System, they are not automatically removed from the iTwin. Therefore, it is possible to have a situation where the user is no longer valid, yet they are still an owner member of the iTwin. When this happens, the owner members will be returned from this API endpoint with the following values:\n * ```typescript\n * { members: [\n *     {\n *       \"id\": <memberId>,\n *       \"email\": null,\n *       \"givenName\": null,\n *       \"surname\": null,\n *       \"organization\": null,\n *       ...\n *     }\n *   ]\n * }\n * ```\n *\n * #### Cleanup\n * The Access Control API will perform a once-a-week cleanup to remove these \"Missing Users\". You can rely on this automated clean-up if this timeline is sufficient.\n *\n * If not, you can use the Remove iTwin Owner Member API (use the memberId) to remove the owner member from the iTwin.\n */\nexport interface OwnerMemberMultiResponse {\n  /** Array of owner members */\n  members: OwnerMember[];\n  /** Navigation links for pagination */\n  // eslint-disable-next-line @typescript-eslint/naming-convention\n  \"_links\": Links;\n}"]}

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

@@ -0,0 +1,5 @@
+/** Represents a permission string used in access control operations.
+ * Permissions define what actions a user or role is allowed to perform within an iTwin.
+ */
+export type Permission = string;
+//# sourceMappingURL=Permission.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"Permission.d.ts","sourceRoot":"","sources":["../../../src/types/Permission.ts"],"names":[],"mappings":"AAKA;;GAEG;AACH,MAAM,MAAM,UAAU,GAAG,MAAM,CAAC"}

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

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

@@ -0,0 +1 @@
+{"version":3,"file":"Permission.js","sourceRoot":"","sources":["../../../src/types/Permission.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\n/** Represents a permission string used in access control operations.\n * Permissions define what actions a user or role is allowed to perform within an iTwin.\n */\nexport type Permission = string;"]}

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

@@ -0,0 +1,33 @@
+import type { Permission } from "./Permission";
+/**
+ * Represents a role that defines a set of permissions for iTwin access control.
+ * Roles are assigned to users to grant them specific capabilities within an iTwin.
+ *
+ * @example
+ * ```typescript
+ * const projectManagerRole: Role = {
+ *   id: "550e8400-e29b-41d4-a716-446655440000",
+ *   displayName: "Project Manager",
+ *   description: "Full access to manage project resources, users, and settings",
+ *   permissions: [
+ *     "itwins_read",
+ *     "itwins_modify",
+ *     "itwins_members_read",
+ *     "itwins_members_modify",
+ *     "imodels_read",
+ *     "imodels_write"
+ *   ]
+ * };
+ * ```
+ */
+export interface Role {
+    /** Unique identifier for the role. Optional when creating a new role. */
+    id: string;
+    /** Human-readable name for the role */
+    displayName: string;
+    /** Detailed description of what this role provides */
+    description: string;
+    /** Array of permissions associated with this role */
+    permissions: Permission[];
+}
+//# sourceMappingURL=Role.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"Role.d.ts","sourceRoot":"","sources":["../../../src/types/Role.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE/C;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAM,WAAW,IAAI;IACnB,yEAAyE;IACzE,EAAE,EAAE,MAAM,CAAC;IACX,uCAAuC;IACvC,WAAW,EAAE,MAAM,CAAC;IACpB,sDAAsD;IACtD,WAAW,EAAE,MAAM,CAAC;IACpB,qDAAqD;IACrD,WAAW,EAAE,UAAU,EAAE,CAAC;CAC3B"}

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

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

@@ -0,0 +1 @@
+{"version":3,"file":"Role.js","sourceRoot":"","sources":["../../../src/types/Role.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 { Permission } from \"./Permission\";\n\n/**\n * Represents a role that defines a set of permissions for iTwin access control.\n * Roles are assigned to users to grant them specific capabilities within an iTwin.\n *\n * @example\n * ```typescript\n * const projectManagerRole: Role = {\n *   id: \"550e8400-e29b-41d4-a716-446655440000\",\n *   displayName: \"Project Manager\",\n *   description: \"Full access to manage project resources, users, and settings\",\n *   permissions: [\n *     \"itwins_read\",\n *     \"itwins_modify\",\n *     \"itwins_members_read\",\n *     \"itwins_members_modify\",\n *     \"imodels_read\",\n *     \"imodels_write\"\n *   ]\n * };\n * ```\n */\nexport interface Role {\n  /** Unique identifier for the role. Optional when creating a new role. */\n  id: string;\n  /** Human-readable name for the role */\n  displayName: string;\n  /** Detailed description of what this role provides */\n  description: string;\n  /** Array of permissions associated with this role */\n  permissions: Permission[];\n}\n"]}

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

@@ -0,0 +1,80 @@
+/**
+ * Represents an iTwin share contract that allows public access to iTwin data.
+ * Share contracts enable external users to access iTwin resources without authentication.
+ *
+ * @example
+ * ```typescript
+ * const shareContract: ShareContract = {
+ *   id: "550e8400-e29b-41d4-a716-446655440000",
+ *   iTwinId: "a1b2c3d4-e5f6-4789-0123-456789abcdef",
+ *   shareKey: "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
+ *   shareContract: "Default",
+ *   expiration: "2024-12-31T23:59:59.999Z"
+ * };
+ *
+ * // Usage in authorization header:
+ * const authHeader = `Basic ${shareContract.shareKey}`;
+ * ```
+ */
+export interface ShareContract {
+    /** Unique identifier for the share contract */
+    id: string;
+    /** The iTwin ID that this share contract applies to */
+    iTwinId: string;
+    /** The share key used for authentication. Prepend with 'Basic' in authorization headers. */
+    shareKey: string;
+    /** The type of share contract (e.g., "Default") that defines available APIs */
+    shareContract: string;
+    /** ISO date string when the share contract expires */
+    expiration: string;
+}
+/**
+ * Response object containing a single share contract.
+ *
+ * @example
+ * ```typescript
+ * const response: SingleShareContractResponse = {
+ *   share: {
+ *     id: "550e8400-e29b-41d4-a716-446655440000",
+ *     iTwinId: "a1b2c3d4-e5f6-4789-0123-456789abcdef",
+ *     shareKey: "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
+ *     shareContract: "Default",
+ *     expiration: "2024-12-31T23:59:59.999Z"
+ *   }
+ * };
+ * ```
+ */
+export interface SingleShareContractResponse {
+    /** The share contract data */
+    share: ShareContract;
+}
+/**
+ * Response object containing multiple share contracts.
+ *
+ * @example
+ * ```typescript
+ * const response: MultiShareContractResponse = {
+ *   shares: [
+ *     {
+ *       id: "share1-550e8400-e29b-41d4-a716-446655440000",
+ *       iTwinId: "a1b2c3d4-e5f6-4789-0123-456789abcdef",
+ *       shareKey: "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
+ *       shareContract: "Default",
+ *       expiration: "2024-12-31T23:59:59.999Z"
+ *     },
+ *     {
+ *       id: "share2-550e8400-e29b-41d4-a716-446655440001",
+ *       iTwinId: "a1b2c3d4-e5f6-4789-0123-456789abcdef",
+ *       shareKey: "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
+ *       shareContract: "Premium",
+ *       expiration: "2025-06-30T23:59:59.999Z"
+ *     }
+ *   ]
+ * };
+ * ```
+ */
+export interface MultiShareContractResponse {
+    /** Array of share contracts */
+    shares: ShareContract[];
+}
+//# sourceMappingURL=ShareContract.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"ShareContract.d.ts","sourceRoot":"","sources":["../../../src/types/ShareContract.ts"],"names":[],"mappings":"AAKA;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,WAAW,aAAa;IAC5B,+CAA+C;IAC/C,EAAE,EAAE,MAAM,CAAC;IACX,uDAAuD;IACvD,OAAO,EAAE,MAAM,CAAC;IAChB,4FAA4F;IAC5F,QAAQ,EAAE,MAAM,CAAC;IACjB,+EAA+E;IAC/E,aAAa,EAAE,MAAM,CAAC;IACtB,sDAAsD;IACtD,UAAU,EAAE,MAAM,CAAC;CACpB;AAED;;;;;;;;;;;;;;;GAeG;AACH,MAAM,WAAW,2BAA2B;IAC1C,8BAA8B;IAC9B,KAAK,EAAG,aAAa,CAAC;CACvB;AAED;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,MAAM,WAAW,0BAA0B;IACzC,+BAA+B;IAC/B,MAAM,EAAE,aAAa,EAAE,CAAC;CACzB"}

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

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

@@ -0,0 +1 @@
+{"version":3,"file":"ShareContract.js","sourceRoot":"","sources":["../../../src/types/ShareContract.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\n/**\n * Represents an iTwin share contract that allows public access to iTwin data.\n * Share contracts enable external users to access iTwin resources without authentication.\n *\n * @example\n * ```typescript\n * const shareContract: ShareContract = {\n *   id: \"550e8400-e29b-41d4-a716-446655440000\",\n *   iTwinId: \"a1b2c3d4-e5f6-4789-0123-456789abcdef\",\n *   shareKey: \"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...\",\n *   shareContract: \"Default\",\n *   expiration: \"2024-12-31T23:59:59.999Z\"\n * };\n *\n * // Usage in authorization header:\n * const authHeader = `Basic ${shareContract.shareKey}`;\n * ```\n */\nexport interface ShareContract {\n  /** Unique identifier for the share contract */\n  id: string;\n  /** The iTwin ID that this share contract applies to */\n  iTwinId: string;\n  /** The share key used for authentication. Prepend with 'Basic' in authorization headers. */\n  shareKey: string;\n  /** The type of share contract (e.g., \"Default\") that defines available APIs */\n  shareContract: string;\n  /** ISO date string when the share contract expires */\n  expiration: string;\n}\n\n/**\n * Response object containing a single share contract.\n *\n * @example\n * ```typescript\n * const response: SingleShareContractResponse = {\n *   share: {\n *     id: \"550e8400-e29b-41d4-a716-446655440000\",\n *     iTwinId: \"a1b2c3d4-e5f6-4789-0123-456789abcdef\",\n *     shareKey: \"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...\",\n *     shareContract: \"Default\",\n *     expiration: \"2024-12-31T23:59:59.999Z\"\n *   }\n * };\n * ```\n */\nexport interface SingleShareContractResponse {\n  /** The share contract data */\n  share:  ShareContract;\n}\n\n/**\n * Response object containing multiple share contracts.\n *\n * @example\n * ```typescript\n * const response: MultiShareContractResponse = {\n *   shares: [\n *     {\n *       id: \"share1-550e8400-e29b-41d4-a716-446655440000\",\n *       iTwinId: \"a1b2c3d4-e5f6-4789-0123-456789abcdef\",\n *       shareKey: \"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...\",\n *       shareContract: \"Default\",\n *       expiration: \"2024-12-31T23:59:59.999Z\"\n *     },\n *     {\n *       id: \"share2-550e8400-e29b-41d4-a716-446655440001\",\n *       iTwinId: \"a1b2c3d4-e5f6-4789-0123-456789abcdef\",\n *       shareKey: \"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...\",\n *       shareContract: \"Premium\",\n *       expiration: \"2025-06-30T23:59:59.999Z\"\n *     }\n *   ]\n * };\n * ```\n */\nexport interface MultiShareContractResponse {\n  /** Array of share contracts */\n  shares: ShareContract[];\n}\n"]}

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

@@ -0,0 +1,115 @@
+import type { MemberInvitation } from "./Invitations";
+import type { Links } from "./links";
+import type { UserMember } from "./Members";
+/**
+ * Request to add or invite a user member to an iTwin with role assignments.
+ *
+ *
+ * @example
+ * ```typescript
+ * const newMember: AddUserMember = {
+ *   email: "newuser@company.com",
+ *   roleIds: ["5abbfcef-0eab-472a-b5f5-5c5a43df34b1", "83ee0d80-dea3-495a-b6c0-7bb102ebbcc3"]
+ * };
+ * ```
+ */
+export interface AddUserMember {
+    /** Array of role IDs to assign to the user */
+    roleIds: string[];
+    /** Email address of the user to add or invite */
+    email: string;
+}
+/**
+ * Response from adding user members to an iTwin.
+ *
+ * @remarks
+ * This response contains both members (users immediately added) and invitations
+ * (external users who need to accept invitations). Internal users are automatically
+ * added as members, while external users receive email invitations.
+ *
+ * @example
+ * ```typescript
+ * const response: AddUserMemberResponse = {
+ *   members: [
+ *     // Internal users added immediately
+ *     { id: "123", email: "internal@company.com", givenName: "Jane", surname: "Doe", organization: "ACME Corp", roles: [...] }
+ *   ],
+ *   invitations: [
+ *     // External users who received invitations
+ *     { id: "inv456", email: "external@other.com", status: "Pending", roles: [...] }
+ *   ]
+ * };
+ * ```
+ */
+export interface AddUserMemberResponse {
+    /** Users that were immediately added as members (internal users) */
+    members: UserMember[];
+    /** Invitations sent to external users who need to accept them */
+    invitations: MemberInvitation[];
+}
+/**
+ * API response wrapper for a single user member operation.
+ *
+ * @remarks
+ * This interface is used for API responses that return a single user member,
+ * such as GET /members/{id} operations.
+ *
+ * #### Missing Users
+ * When users are removed from the Bentley Identity Management System, they are not automatically removed from the iTwin. Therefore, it is possible to have a situation where the user is no longer valid, yet they are still a user member of the iTwin. When this happens, the user member will be returned from this API endpoint with the follow values:
+ * ```typescript
+ * { member:
+    {
+      "id": <memberId>,
+      "email": null,
+      "givenName": null,
+      "surname": null,
+      "organization": null,
+      ...
+    }
+  * }
+ * ```
+ *
+ * #### Cleanup
+ * The Access Control API will perform a once-a-week cleanup to remove these "Missing Users". You can rely on this automated clean-up if this timeline is sufficient.
+ *
+ * If not, you can use the Remove iTwin User Member API (use the memberId) to remove the user member from the iTwin.
+ */
+export interface SingleUserMemberResponse {
+    /** The user member data */
+    member: UserMember;
+}
+/**
+ * API response wrapper for multiple user members with pagination support.
+ *
+ * @remarks
+ * This interface is used for API responses that return collections of user members,
+ * such as GET /members operations. Includes HAL-style navigation links for pagination.
+ *
+ * #### Missing Users
+ * When users are removed from the Bentley Identity Management System, they are not automatically removed from the iTwin. Therefore, it is possible to have a situation where the user is no longer valid, yet they are still a user member of the iTwin. When this happens, the user members will be returned from this API endpoint with the following values:
+ * ```typescript
+ * { members: [
+ *     {
+ *       "id": <memberId>,
+ *       "email": null,
+ *       "givenName": null,
+ *       "surname": null,
+ *       "organization": null,
+ *       ...
+ *     }
+ *   ]
+ * }
+ * ```
+ *
+ * #### Cleanup
+ * The Access Control API will perform a once-a-week cleanup to remove these "Missing Users". You can rely on this automated clean-up if this timeline is sufficient.
+ *
+ * If not, you can use the Remove iTwin User Member API (use the memberId) to remove the user member from the iTwin.
+ */
+export interface MultipleUserMembersResponse {
+    /** Array of user members in the current page */
+    members: UserMember[];
+    /** HAL-style navigation links for pagination (first, next, prev, last) */
+    _links: Links;
+}
+//# sourceMappingURL=UserMembers.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"UserMembers.d.ts","sourceRoot":"","sources":["../../../src/types/UserMembers.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,eAAe,CAAC;AACtD,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AACrC,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,WAAW,CAAC;AAE5C;;;;;;;;;;;GAWG;AACH,MAAM,WAAW,aAAa;IAC5B,8CAA8C;IAC9C,OAAO,EAAE,MAAM,EAAE,CAAC;IAClB,iDAAiD;IACjD,KAAK,EAAE,MAAM,CAAC;CACf;AAED;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,MAAM,WAAW,qBAAqB;IACpC,oEAAoE;IACpE,OAAO,EAAE,UAAU,EAAE,CAAC;IACtB,iEAAiE;IACjE,WAAW,EAAE,gBAAgB,EAAE,CAAC;CACjC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,MAAM,WAAW,wBAAwB;IACvC,2BAA2B;IAC3B,MAAM,EAAE,UAAU,CAAC;CACpB;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,MAAM,WAAW,2BAA2B;IAC1C,gDAAgD;IAChD,OAAO,EAAE,UAAU,EAAE,CAAC;IACtB,0EAA0E;IAE1E,MAAM,EAAE,KAAK,CAAC;CACf"}

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

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

@@ -0,0 +1 @@
+{"version":3,"file":"UserMembers.js","sourceRoot":"","sources":["../../../src/types/UserMembers.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 { MemberInvitation } from \"./Invitations\";\nimport type { Links } from \"./links\";\nimport type { UserMember } from \"./Members\";\n\n/**\n * Request to add or invite a user member to an iTwin with role assignments.\n *\n *\n * @example\n * ```typescript\n * const newMember: AddUserMember = {\n *   email: \"newuser@company.com\",\n *   roleIds: [\"5abbfcef-0eab-472a-b5f5-5c5a43df34b1\", \"83ee0d80-dea3-495a-b6c0-7bb102ebbcc3\"]\n * };\n * ```\n */\nexport interface AddUserMember {\n  /** Array of role IDs to assign to the user */\n  roleIds: string[];\n  /** Email address of the user to add or invite */\n  email: string;\n}\n\n/**\n * Response from adding user members to an iTwin.\n *\n * @remarks\n * This response contains both members (users immediately added) and invitations\n * (external users who need to accept invitations). Internal users are automatically\n * added as members, while external users receive email invitations.\n *\n * @example\n * ```typescript\n * const response: AddUserMemberResponse = {\n *   members: [\n *     // Internal users added immediately\n *     { id: \"123\", email: \"internal@company.com\", givenName: \"Jane\", surname: \"Doe\", organization: \"ACME Corp\", roles: [...] }\n *   ],\n *   invitations: [\n *     // External users who received invitations\n *     { id: \"inv456\", email: \"external@other.com\", status: \"Pending\", roles: [...] }\n *   ]\n * };\n * ```\n */\nexport interface AddUserMemberResponse {\n  /** Users that were immediately added as members (internal users) */\n  members: UserMember[];\n  /** Invitations sent to external users who need to accept them */\n  invitations: MemberInvitation[];\n}\n\n/**\n * API response wrapper for a single user member operation.\n *\n * @remarks\n * This interface is used for API responses that return a single user member,\n * such as GET /members/{id} operations.\n *\n * #### Missing Users\n * When users are removed from the Bentley Identity Management System, they are not automatically removed from the iTwin. Therefore, it is possible to have a situation where the user is no longer valid, yet they are still a user member of the iTwin. When this happens, the user member will be returned from this API endpoint with the follow values:\n * ```typescript\n * { member:\n    {\n      \"id\": <memberId>,\n      \"email\": null,\n      \"givenName\": null,\n      \"surname\": null,\n      \"organization\": null,\n      ...\n    }\n  * }\n * ```\n *\n * #### Cleanup\n * The Access Control API will perform a once-a-week cleanup to remove these \"Missing Users\". You can rely on this automated clean-up if this timeline is sufficient.\n *\n * If not, you can use the Remove iTwin User Member API (use the memberId) to remove the user member from the iTwin.\n */\nexport interface SingleUserMemberResponse {\n  /** The user member data */\n  member: UserMember;\n}\n\n/**\n * API response wrapper for multiple user members with pagination support.\n *\n * @remarks\n * This interface is used for API responses that return collections of user members,\n * such as GET /members operations. Includes HAL-style navigation links for pagination.\n *\n * #### Missing Users\n * When users are removed from the Bentley Identity Management System, they are not automatically removed from the iTwin. Therefore, it is possible to have a situation where the user is no longer valid, yet they are still a user member of the iTwin. When this happens, the user members will be returned from this API endpoint with the following values:\n * ```typescript\n * { members: [\n *     {\n *       \"id\": <memberId>,\n *       \"email\": null,\n *       \"givenName\": null,\n *       \"surname\": null,\n *       \"organization\": null,\n *       ...\n *     }\n *   ]\n * }\n * ```\n *\n * #### Cleanup\n * The Access Control API will perform a once-a-week cleanup to remove these \"Missing Users\". You can rely on this automated clean-up if this timeline is sufficient.\n *\n * If not, you can use the Remove iTwin User Member API (use the memberId) to remove the user member from the iTwin.\n */\nexport interface MultipleUserMembersResponse {\n  /** Array of user members in the current page */\n  members: UserMember[];\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"]}

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

@@ -0,0 +1,20 @@
+/**
+ * Represents a hyperlink reference in API responses
+ */
+export interface Link {
+    /** The URL or URI of the link */
+    href: string;
+}
+/**
+ * Collection of navigation links typically used for pagination in API responses.
+ * Follows HAL (Hypertext Application Language) specification for hypermedia links.
+ */
+export interface Links {
+    /** Link to the current resource */
+    self: Link;
+    /** Link to the previous page of results */
+    prev: Link;
+    /** Link to the next page of results */
+    next: Link;
+}
+//# sourceMappingURL=links.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"links.d.ts","sourceRoot":"","sources":["../../../src/types/links.ts"],"names":[],"mappings":"AAKA;;GAEG;AACH,MAAM,WAAW,IAAI;IACnB,iCAAiC;IACjC,IAAI,EAAE,MAAM,CAAC;CACd;AAED;;;GAGG;AACH,MAAM,WAAW,KAAK;IACpB,mCAAmC;IACnC,IAAI,EAAE,IAAI,CAAC;IACX,2CAA2C;IAC3C,IAAI,EAAE,IAAI,CAAC;IACX,uCAAuC;IACvC,IAAI,EAAE,IAAI,CAAC;CACZ"}

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

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

@@ -0,0 +1 @@
+{"version":3,"file":"links.js","sourceRoot":"","sources":["../../../src/types/links.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/**\n * Represents a hyperlink reference in API responses\n */\nexport interface Link {\n  /** The URL or URI of the link */\n  href: string;\n}\n\n/**\n * Collection of navigation links typically used for pagination in API responses.\n * Follows HAL (Hypertext Application Language) specification for hypermedia links.\n */\nexport interface Links {\n  /** Link to the current resource */\n  self: Link;\n  /** Link to the previous page of results */\n  prev: Link;\n  /** Link to the next page of results */\n  next: Link;\n}"]}

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

@@ -0,0 +1,42 @@
+/**
+ * Type guard to check if an object has a specific property and narrows the type to Record<string, unknown>
+ * @param obj - Unknown object to check for property existence
+ * @param prop - Property key name to check for
+ * @returns True if the object has the specified property, false otherwise
+ *
+ * @example
+ * ```typescript
+ * const data: unknown = { name: "John", age: 30 };
+ * if (hasProperty(data, "name")) {
+ *   console.log(data.name); // ✅ Type-safe access
+ * }
+ * ```
+ */
+export declare function hasProperty(obj: unknown, prop: string): obj is Record<string, unknown>;
+/**
+ * Utility type that creates a mapping object where every property of type T must be mapped to a string value.
+ * This ensures you can't forget to handle any properties - TypeScript will give you an error if you miss one.
+ *
+ * @template T - The source object type whose properties need to be mapped
+ *
+ * @example
+ * ```typescript
+ * interface User { name: string; age: number; }
+ *
+ * // ✅ Valid - all properties mapped
+ * const mapping: ParameterMapping<User> = {
+ *   name: "user_name",
+ *   age: "user_age"
+ * };
+ *
+ * // ❌ TypeScript error - missing 'age' property
+ * const incomplete: ParameterMapping<User> = {
+ *   name: "user_name"
+ *   // Error: Property 'age' is missing!
+ * };
+ * ```
+ */
+export type ParameterMapping<T> = {
+    [K in keyof Required<T>]: string;
+};
+//# sourceMappingURL=typeUtils.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"typeUtils.d.ts","sourceRoot":"","sources":["../../../src/types/typeUtils.ts"],"names":[],"mappings":"AAKA;;;;;;;;;;;;;GAaG;AACH,wBAAgB,WAAW,CACzB,GAAG,EAAE,OAAO,EACZ,IAAI,EAAE,MAAM,GACX,GAAG,IAAI,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAEhC;AAED;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,MAAM,MAAM,gBAAgB,CAAC,CAAC,IAAI;KAC/B,CAAC,IAAI,MAAM,QAAQ,CAAC,CAAC,CAAC,GAAG,MAAM;CACjC,CAAC"}

package/lib/esm/types/typeUtils.js

@@ -0,0 +1,22 @@
+/*---------------------------------------------------------------------------------------------
+ * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+ * See LICENSE.md in the project root for license terms and full copyright notice.
+ *--------------------------------------------------------------------------------------------*/
+/**
+ * Type guard to check if an object has a specific property and narrows the type to Record<string, unknown>
+ * @param obj - Unknown object to check for property existence
+ * @param prop - Property key name to check for
+ * @returns True if the object has the specified property, false otherwise
+ *
+ * @example
+ * ```typescript
+ * const data: unknown = { name: "John", age: 30 };
+ * if (hasProperty(data, "name")) {
+ *   console.log(data.name); // ✅ Type-safe access
+ * }
+ * ```
+ */
+export function hasProperty(obj, prop) {
+    return typeof obj === "object" && obj !== null && prop in obj;
+}
+//# sourceMappingURL=typeUtils.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"typeUtils.js","sourceRoot":"","sources":["../../../src/types/typeUtils.ts"],"names":[],"mappings":"AAAA;;;gGAGgG;AAEhG;;;;;;;;;;;;;GAaG;AACH,MAAM,UAAU,WAAW,CACzB,GAAY,EACZ,IAAY;IAEZ,OAAO,OAAO,GAAG,KAAK,QAAQ,IAAI,GAAG,KAAK,IAAI,IAAI,IAAI,IAAI,GAAG,CAAC;AAChE,CAAC","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/**\n * Type guard to check if an object has a specific property and narrows the type to Record<string, unknown>\n * @param obj - Unknown object to check for property existence\n * @param prop - Property key name to check for\n * @returns True if the object has the specified property, false otherwise\n *\n * @example\n * ```typescript\n * const data: unknown = { name: \"John\", age: 30 };\n * if (hasProperty(data, \"name\")) {\n *   console.log(data.name); // ✅ Type-safe access\n * }\n * ```\n */\nexport function hasProperty(\n  obj: unknown,\n  prop: string\n): obj is Record<string, unknown> {\n  return typeof obj === \"object\" && obj !== null && prop in obj;\n}\n\n/**\n * Utility type that creates a mapping object where every property of type T must be mapped to a string value.\n * This ensures you can't forget to handle any properties - TypeScript will give you an error if you miss one.\n *\n * @template T - The source object type whose properties need to be mapped\n *\n * @example\n * ```typescript\n * interface User { name: string; age: number; }\n *\n * // ✅ Valid - all properties mapped\n * const mapping: ParameterMapping<User> = {\n *   name: \"user_name\",\n *   age: \"user_age\"\n * };\n *\n * // ❌ TypeScript error - missing 'age' property\n * const incomplete: ParameterMapping<User> = {\n *   name: \"user_name\"\n *   // Error: Property 'age' is missing!\n * };\n * ```\n */\nexport type ParameterMapping<T> = {\n  [K in keyof Required<T>]: string;\n};"]}