@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 { AccessControlAPIResponse, AccessControlResultMode, IITwinJobsClient, ITwinJob, ITwinJobActions } from "../accessControlTypes";
import { BaseClient } from "./BaseClient";
export declare class ITwinJobsClient extends BaseClient implements IITwinJobsClient {
    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
       */
    createITwinJobAsync(accessToken: AccessToken, iTwinId: string, iTwinJobActions: ITwinJobActions): Promise<AccessControlAPIResponse<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
       */
    getITwinJobAsync(accessToken: AccessToken, iTwinId: string, iTwinJobId: string, resultMode?: AccessControlResultMode): Promise<AccessControlAPIResponse<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
       * @returns ITwin Job Actions
       */
    getITwinJobActionsAsync(accessToken: AccessToken, iTwinId: string, iTwinJobId?: string): Promise<AccessControlAPIResponse<ITwinJobActions>>;
    /**
     * Format result mode parameter into a headers entry
     * @param resultMode (Optional) Access Control result mode
     * @protected
     */
    protected getResultModeHeaders(resultMode?: AccessControlResultMode): Record<string, string>;
}
//# sourceMappingURL=ITwinJobsClient.d.ts.map