@itwin/access-control-client 3.7.0 → 4.1.0

package/lib/cjs/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/cjs/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/cjs/types/ITwinJob.js

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

package/lib/cjs/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/cjs/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/cjs/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/cjs/types/Invitations.js

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

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

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

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

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

@@ -0,0 +1 @@
+{"version":3,"file":"Members.d.ts","sourceRoot":"","sources":["../../../src/types/Members.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AAGnC,UAAU,QAAQ;IAChB,qCAAqC;IACrC,EAAE,EAAE,MAAM,CAAC;IACX,gCAAgC;IAChC,KAAK,EAAE,MAAM,CAAC;IACd,6BAA6B;IAC7B,SAAS,EAAE,MAAM,CAAC;IAClB,4BAA4B;IAC5B,OAAO,EAAE,MAAM,CAAC;IAChB,uCAAuC;IACvC,YAAY,EAAE,MAAM,CAAC;CACtB;AAED;;;;;;;;;;;;;GAaG;AACH,MAAM,MAAM,SAAS,GAAG,QAAQ,CAAC;AAEjC;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,MAAM,WAAW,UAAW,SAAQ,QAAQ;IAC1C,kDAAkD;IAClD,KAAK,EAAE,IAAI,EAAE,CAAC;CACf;AAED;;;;;;;;;;;;;GAaG;AACH,MAAM,MAAM,WAAW,GAAG,QAAQ,CAAC"}

package/lib/cjs/types/Members.js

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

package/lib/cjs/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/cjs/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/cjs/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/cjs/types/OwnerMember.js

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

package/lib/cjs/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/cjs/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/cjs/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/cjs/types/Permission.js

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

package/lib/cjs/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/cjs/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/cjs/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/cjs/types/Role.js

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

package/lib/cjs/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/cjs/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