@itwin/access-control-client/lib/cjs/subClients/ITwinJobsClient.d.ts

Access control client for the iTwin platform

/** @packageDocumentation
 * @module AccessControlClient
 */
import type { AccessToken } from "@itwin/core-bentley";
import type { IITwinJobsClient } from "../accessControlClientInterfaces/ITwinJobsClient";
import type { BentleyAPIResponse, ResultMode } from "../types/CommonApiTypes";
import type { ITwinJob, ITwinJobActions } from "../types/ITwinJob";
import { BaseClient } from "./BaseClient";
/** Client API to perform iTwin job operations.
 */
export declare class ITwinJobsClient extends BaseClient implements IITwinJobsClient {
    /** Create a new ITwinJobsClient instance
     * @param url Optional base URL for the access control service. If not provided, defaults to base url.
     */
    constructor(url?: string);
    /** Create a new iTwin Job
       * @param accessToken The client access token string
       * @param iTwinId The id of the iTwin
       * @param iTwinActions The actions of the iTwin Job
       * @returns ITwin Job
       */
    createITwinJob(accessToken: AccessToken, iTwinId: string, iTwinJobActions: ITwinJobActions): Promise<BentleyAPIResponse<ITwinJob>>;
    /** Gets an iTwin Job.
       * @param accessToken The client access token string
       * @param iTwinId The id of the iTwin
       * @param iTwinJobId The id of the iTwin Job
       * @param resultMode (Optional) Access Control result mode: minimal or representation (defaults to minimal)
       * @returns ITwin Job
       */
    getITwinJob<T extends ResultMode = "minimal">(accessToken: AccessToken, iTwinId: string, iTwinJobId: string, resultMode?: T): Promise<BentleyAPIResponse<T extends "representation" ? ITwinJob : Omit<ITwinJob, "error">>>;
    /** Gets an iTwin Job.
       * @param accessToken The client access token string
       * @param iTwinId The id of the iTwin
       * @param iTwinJobId The id of the iTwin Job
       * @returns ITwin Job Actions
       */
    getITwinJobActions(accessToken: AccessToken, iTwinId: string, iTwinJobId?: string): Promise<BentleyAPIResponse<ITwinJobActions>>;
    /**
     * Format result mode parameter into a headers entry
     * @param resultMode (Optional) Access Control result mode
     * @protected
     */
    protected getResultModeHeaders(resultMode?: ResultMode): Record<string, string>;
}
//# sourceMappingURL=ITwinJobsClient.d.ts.map