@itwin/access-control-client
Version:
Access control client for the iTwin platform
33 lines • 1.73 kB
TypeScript
/** @packageDocumentation
* @module AccessControlClient
*/
import type { AccessToken } from "@itwin/core-bentley";
import type { MultipleGroupMemberInvitationResponse } from "../access-control-client";
import type { IGroupMemberInvitationClient } from "../accessControlClientInterfaces/GroupMemberInvitationClient";
import type { BentleyAPIResponse, ODataQueryParams } from "../types/CommonApiTypes";
import { BaseClient } from "./BaseClient";
/** Client API to perform iTwin group members operations.
* @beta
*/
export declare class GroupMemberInvitationClient extends BaseClient implements IGroupMemberInvitationClient {
/** Create a new GroupMembersClient instance
* @param url Optional base URL for the access control service. If not provided, defaults to base url.
*/
constructor(url?: string);
/** Retrieves a list of iTwin group members and their roles assignments.
* @param accessToken The client access token string
* @param iTwinId The id of the iTwin
* @beta
* @returns Array of members
*/
queryITwinGroupMemberInvitations(accessToken: AccessToken, iTwinId: string, groupId: string, arg?: Pick<ODataQueryParams, "top" | "skip">): Promise<BentleyAPIResponse<MultipleGroupMemberInvitationResponse>>;
/** Deletes a member invitations.
* @param accessToken The client access token string
* @param iTwinId The id of the iTwin
* @param invitationId The id of the invitation id
* @beta
* @returns Array of member invitations
*/
deleteITwinGroupMemberInvitation(accessToken: AccessToken, iTwinId: string, groupId: string, invitationId: string): Promise<BentleyAPIResponse<undefined>>;
}
//# sourceMappingURL=GroupMemberInvitationsClient.d.ts.map