/** * This file was auto-generated by Fern from our API Definition. */ import * as Flatfile from "../../../../index"; export interface GetRecordsCsvRequest { /** * Deprecated, use `sinceCommitId` instead. */ versionId?: string; /** * Returns records that were changed in that version in that version and only those records. */ commitId?: Flatfile.CommitId; /** * Deprecated, use `sinceCommitId` instead. */ sinceVersionId?: Flatfile.VersionId; /** * Returns records that were changed in that version in addition to any records from versions after that version. */ sinceCommitId?: Flatfile.CommitId; /** * The field to sort the data on. */ sortField?: Flatfile.SortField; /** * Sort direction - asc (ascending) or desc (descending) */ sortDirection?: Flatfile.SortDirection; /** * Options to filter records */ filter?: Flatfile.Filter; /** * The field to filter the data on. */ filterField?: Flatfile.FilterField; /** * The value to search for data on. */ searchValue?: Flatfile.SearchValue; /** * The field to search for data on. */ searchField?: Flatfile.SearchField; /** * 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[]; }