/**
 * This file was auto-generated by Fern from our API Definition.
 */
import * as Flatfile from "../../../../index";
/**
 * @example
 *     {
 *         environmentId: "us_env_YOUR_ID",
 *         spaceId: "us_sp_YOUR_ID"
 *     }
 */
export interface ListJobsRequest {
    /**
     * When provided, only jobs for the given environment will be returned
     */
    environmentId?: Flatfile.EnvironmentId;
    /**
     * When provided, only jobs for the given space will be returned
     */
    spaceId?: Flatfile.SpaceId;
    /**
     * When provided, only jobs for the given workbook will be returned
     */
    workbookId?: Flatfile.WorkbookId;
    /**
     * When provided, only jobs for the given file will be returned
     */
    fileId?: Flatfile.FileId;
    /**
     * When provided, only jobs that are parts of the given job will be returned
     */
    parentId?: Flatfile.JobId;
    /**
     * Number of jobs to return in a page (default 20)
     */
    pageSize?: number;
    /**
     * Based on pageSize, which page of jobs to return
     */
    pageNumber?: number;
    /**
     * Sort direction - asc (ascending) or desc (descending)
     */
    sortDirection?: Flatfile.SortDirection;
    /**
     * When true, only top-level jobs will be returned unless a parentId is specified
     */
    excludeChildJobs?: boolean;
    /**
     * When provided, only jobs with the given source will be returned
     */
    source?: string;
}