@itwin/access-control-client
Version:
Access control client for the iTwin platform
30 lines • 1.61 kB
TypeScript
/** @packageDocumentation
* @module AccessControlClient
*/
import type { AccessToken } from "@itwin/core-bentley";
import type { IMemberInvitationsClient } from "../accessControlClientInterfaces/MemberInvitationsClient";
import type { BentleyAPIResponse, ODataQueryParams } from "../types/CommonApiTypes";
import type { MultipleMemberInvitationResponse } from "../types/Invitations";
import { BaseClient } from "./BaseClient";
/** Client API to perform iTwin member invitation operations.
*/
export declare class MemberInvitationsClient extends BaseClient implements IMemberInvitationsClient {
/** Create a new MemberInvitationsClient 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 member invitations.
* @param accessToken The client access token string
* @param iTwinId The id of the iTwin
* @returns Array of member invitations
*/
queryITwinMemberInvitations(accessToken: AccessToken, iTwinId: string, arg?: Pick<ODataQueryParams, "top" | "skip">): Promise<BentleyAPIResponse<MultipleMemberInvitationResponse>>;
/** 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
* @returns No Content
*/
deleteITwinMemberInvitation(accessToken: AccessToken, iTwinId: string, invitationId: string): Promise<BentleyAPIResponse<undefined>>;
}
//# sourceMappingURL=MemberInvitationsClient.d.ts.map