/** * This file was auto-generated by Fern from our API Definition. */ import * as Flatfile from "../../../../index"; /** * @example * { * fieldUpdates: { * "status": { * value: "completed" * }, * "processedAt": { * value: "2023-11-20T16:59:40.286Z" * } * } * } */ export interface BulkUpdateRecordRequest { filter?: Flatfile.Filter; /** * Name of field by which to filter records */ filterField?: Flatfile.FilterField; searchValue?: Flatfile.SearchValue; searchField?: Flatfile.SearchField; sortField?: Flatfile.SortField; sortDirection?: Flatfile.SortDirection; /** * The Record Ids param (ids) is a list of record ids that can be passed to several record endpoints allowing the user to identify specific records to INCLUDE in the query, or specific records to EXCLUDE, depending on whether or not filters are being applied. When passing a query param that filters the record dataset, such as 'searchValue', or a 'filter' of 'valid' | 'error' | 'all', the 'ids' param will EXCLUDE those records from the filtered results. For basic queries that do not filter the dataset, passing record ids in the 'ids' param will limit the dataset to INCLUDE just those specific records */ ids?: Flatfile.RecordId | Flatfile.RecordId[]; /** * An FFQL query used to filter the result set */ q?: string; /** * Whether to suppress events for this bulk update */ silent?: boolean; /** A map of field keys to cell values that will be applied to all matching records */ fieldUpdates: Record; }