@rockcarver/frodo-lib/types/ops/ReconOps.d.ts

A library to manage ForgeRock Identity Cloud tenants, ForgeOps deployments, and classic deployments.

import { ReconStatusType, ReconType } from '../api/ReconApi';
import { State } from '../shared/State';
export type Recon = {
    /**
     * Read all reconciliation runs
     * @returns {Promise<ReconType[]>} a promise resolving to an array of recon objects
     */
    readRecons(): Promise<ReconType[]>;
    /**
     * Read recon
     * @param {string} reconId id of the recon
     * @returns {Promise<ReconType>} a promise resolving to a recon object
     */
    readRecon(reconId: string): Promise<ReconType>;
    /**
     * Start a reconciliation
     * @param {string} mappingName mapping to reconcile
     * @returns {Promise<ReconStatusType>} a promise resolving to a recon status object
     */
    startRecon(mappingName: string): Promise<ReconStatusType>;
    /**
     * Start a reconciliation by Id
     * @param {string} mappingName mapping to reconcile
     * @param {string} objectId id of object to reconcile
     * @returns {Promise<ReconStatusType>} a promise resolving to a recon status object
     */
    startReconById(mappingName: string, objectId: string): Promise<ReconStatusType>;
    /**
     * Cancel a reconciliation
     * @param {string} reconId id of the recon to cancel
     * @returns {Promise<ReconStatusType>} a promise resolving to a recon status object
     */
    cancelRecon(reconId: string): Promise<ReconStatusType>;
};
declare const _default: (state: State) => Recon;
export default _default;
export declare function readRecons({ state, }: {
    state: State;
}): Promise<ReconType[]>;
export declare function readRecon({ reconId, state, }: {
    reconId: string;
    state: State;
}): Promise<ReconType>;
export declare function startRecon({ mappingName, state, }: {
    mappingName: string;
    state: State;
}): Promise<ReconStatusType>;
export declare function startReconById({ mappingName, objectId, state, }: {
    mappingName: string;
    objectId: string;
    state: State;
}): Promise<ReconStatusType>;
export declare function cancelRecon({ reconId, state, }: {
    reconId: string;
    state: State;
}): Promise<ReconStatusType>;
//# sourceMappingURL=ReconOps.d.ts.map