/**
 * This file was auto-generated by Fern from our API Definition.
 */
import * as Flatfile from "../../../index";
/**
 * The configuration for a bulk flag mutation job
 *
 * @example
 *     {
 *         workbookId: "us_wb_YOUR_ID",
 *         mutation: {
 *             type: "flag",
 *             operation: Flatfile.FlagOperation.Apply,
 *             flag: {
 *                 slug: "important",
 *                 label: "Important",
 *                 colorHex: "#FF0000"
 *             }
 *         },
 *         snapshotLabel: "Before important flag application"
 *     }
 *
 * @example
 *     {
 *         workbookId: "us_wb_YOUR_ID",
 *         mutation: {
 *             type: "flag",
 *             operation: Flatfile.FlagOperation.Delete,
 *             flag: {
 *                 slug: "important"
 *             }
 *         },
 *         exceptions: ["rec_123", "rec_456"]
 *     }
 */
export interface BulkMutateFlagsJobConfig {
    /** The workbook to perform flag mutations on */
    workbookId: Flatfile.WorkbookId;
    /** Record IDs to exclude from the operation */
    exceptions?: string[];
    /** Query string to filter records */
    query?: string;
    /** Filter object to apply to records */
    filter?: any;
    /** Field to filter on */
    filterField?: string;
    /** Value to search for */
    searchValue?: string;
    /** Field to search in */
    searchField?: string;
    /** General search query */
    q?: string;
    /** Specific record IDs to target */
    ids?: string[];
    /** Label for snapshot before mutation */
    snapshotLabel?: string;
    /** The flag mutation configuration */
    mutation: Flatfile.FlagMutationConfig;
}