import { PeriodDocumentDataData } from "./period-document";
export interface SpreadsDocument {
    data: SpreadsDocumentData;
    error: any;
    metaData: any;
}
export interface SpreadsDocumentData extends Omit<SpreadsDocumentDataFetched, "createdDate" | "endDate" | "startDate"> {
    createdDate: Date;
    endDate: Date;
    startDate: Date;
}
export interface SpreadsDocumentDataFetched {
    analystName: string;
    analystUuid: string;
    archived: boolean;
    /** A collection of category UUIDs that have been collapsed (their children
     * aren't visible) by the user. */
    collapsedCategories?: Record<string, true>;
    createdDate: string;
    dataVersion: number;
    editable: boolean;
    endDate: string;
    entityName: string;
    entityUuid: string;
    financialModelUuid: string;
    hideFromPrint?: {
        categoryUuids: string[];
        periodUuids: string[];
    };
    institutionUuid: string;
    narrativeData: {
        [key: string]: string | null;
    };
    periods?: Partial<PeriodDocumentDataData>[];
    narrativePagebreaks: Array<any>;
    periodUuids: Array<string>;
    startDate: string;
    status: string;
    uuid: string;
    visible: boolean;
}
/**
 * When using the bafs-api lib this interface is not needed because no objects
 * with this shape will be exposed to clients. See
 * `libs/bafs-api/src/spreads/spreads.ts`.
 *
 * Response returned by a cms/v1 request.
 * @deprecated
 */
export interface SpreadsDocumentFetched {
    data: SpreadsDocumentDataFetched;
    error: any;
    metaData: any;
}