@rockcarver/frodo-lib/types/api/ApiTypes.d.ts

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

export interface NoIdObjectSkeletonInterface {
    _rev?: string;
    [k: string]: string | number | boolean | string[] | IdObjectSkeletonInterface | object | undefined;
}
export interface IdObjectSkeletonInterface extends NoIdObjectSkeletonInterface {
    _id?: string;
}
export interface AmConfigEntityInterface extends IdObjectSkeletonInterface {
    _type?: EntityType;
}
export type Readable<Type> = Type;
export type Writable<Type> = {
    inherited: boolean;
    value?: Type;
};
export type QueryResult<Type> = {
    result: Type[];
};
export type PagedResult<Type> = {
    result: Type[];
    resultCount: number;
    pagedResultsCookie: string;
    totalPagedResultsPolicy: 'EXACT' | 'NONE';
    totalPagedResults: number;
    remainingPagedResults: number;
};
export type EntityType = IdObjectSkeletonInterface & {
    name: string;
    collection: boolean;
};
/**
 * See {@link https://backstage.forgerock.com/docs/idm/7.5/crest/crest-patch.html}.
 */
export interface PatchOperationInterface {
    operation: 'add' | 'copy' | 'increment' | 'move' | 'remove' | 'replace' | 'transform';
    field: string;
    value?: any;
    from?: string;
}
//# sourceMappingURL=ApiTypes.d.ts.map