- @flatfile/api
- Synopsis
- Details
- Flatfile Node API Library
- API
- Contribution
- Classes
- Interfaces
- Interface: Agent
- Interface: AgentConfig
- Interface: AgentLog
- Interface: AgentResponse
- Interface: CreateAgentsRequest
- Interface: DeleteAgentRequest
- Interface: GetAgentLogsRequest
- Interface: GetAgentLogsResponse
- Interface: GetAgentRequest
- Interface: GetEnvironmentAgentLogsRequest
- Interface: ListAgentsRequest
- Interface: ListAgentsResponse
- Interface: ApiKey
- Interface: ApiKeyOperation
- Interface: ApiKeysResponse
- Interface: GetApiKeysRequest
- Interface: CheckoutSession
- Interface: CreateCheckoutSessionResponse
- Interface: ProductsResponse
- Interface: StripeProduct
- Interface: CellValueWithCounts
- Interface: CellsResponse
- Interface: GetFieldValuesRequest
- Interface: Action
- Interface: Error_
- Interface: Pagination
- Interface: Success
- Interface: SuccessData
- Interface: Document
- Interface: DocumentConfig
- Interface: DocumentResponse
- Interface: ListDocumentsResponse
- Interface: Environment
- Interface: EnvironmentConfig
- Interface: EnvironmentResponse
- Interface: ListEnvironmentsRequest
- Interface: ListEnvironmentsResponse
- Interface: ActionTriggeredEvent
- Interface: BaseEvent
- Interface: ClientInitializedEvent
- Interface: Context
- Interface: ActionTriggered
- Interface: ClientInitialized
- Interface: FileDeleted
- Interface: JobCompleted
- Interface: JobDeleted
- Interface: JobFailed
- Interface: JobStarted
- Interface: JobUpdated
- Interface: JobWaiting
- Interface: RecordsCreated
- Interface: RecordsDeleted
- Interface: RecordsUpdated
- Interface: SheetValidated
- Interface: SpaceAdded
- Interface: SpaceRemoved
- Interface: UploadCompleted
- Interface: UploadFailed
- Interface: UploadStarted
- Interface: UserAdded
- Interface: UserOffline
- Interface: UserOnline
- Interface: UserRemoved
- Interface: WorkbookAdded
- Interface: WorkbookRemoved
- Interface: WorkbookUpdated
- Interface: EventAttributes
- Interface: EventResponse
- Interface: FileDeletedEvent
- Interface: GetEventTokenRequest
- Interface: JobCompletedEvent
- Interface: JobDeletedEvent
- Interface: JobFailedEvent
- Interface: JobFailedPayload
- Interface: JobPayload
- Interface: JobStartedEvent
- Interface: JobUpdatedEvent
- Interface: JobWaitingEvent
- Interface: ListAllEventsResponse
- Interface: ListEventsRequest
- Interface: Origin
- Interface: Progress
- Interface: RecordsCreatedEvent
- Interface: RecordsDeletedEvent
- Interface: RecordsPayload
- Interface: RecordsUpdatedEvent
- Interface: SheetValidatedEvent
- Interface: SpaceAddedEvent
- Interface: SpaceRemovedEvent
- Interface: UploadCompletedEvent
- Interface: UploadFailedEvent
- Interface: UploadStartedEvent
- Interface: UserAddedEvent
- Interface: UserOfflineEvent
- Interface: UserOnlineEvent
- Interface: UserRemovedEvent
- Interface: WorkbookAddedEvent
- Interface: WorkbookRemovedEvent
- Interface: WorkbookUpdatedEvent
- Interface: CreateFileRequest
- Interface: FileResponse
- Interface: File_
- Interface: ListFilesRequest
- Interface: ListFilesResponse
- Interface: UpdateFileRequest
- Interface: CreateGuestResponse
- Interface: Guest
- Interface: GuestConfig
- Interface: GuestSpace
- Interface: GuestWorkbook
- Interface: Invite
- Interface: ListGuestsRequest
- Interface: ListGuestsResponse
- Interface: AiAssistJobConfig
- Interface: CategoryMapping
- Interface: DeleteJobConfig
- Interface: DestinationField
- Interface: Edge
- Interface: EmptyObject
- Interface: EnumDetails
- Interface: ExportJobConfig
- Interface: ExportOptions
- Interface: FileJobConfig
- Interface: FindAndReplaceJobConfig
- Interface: Job
- Interface: JobAckDetails
- Interface: JobConfig
- Interface: JobExecutionPlan
- Interface: JobExecutionPlanConfig
- Interface: JobOutcome
- Interface: JobPlan
- Interface: JobResponse
- Interface: JobUpdate
- Interface: ListJobsRequest
- Interface: ListJobsResponse
- Interface: Metadata
- Interface: MutateJobConfig
- Interface: PipelineJobConfig
- Interface: SourceField
- Interface: ArrayableProperty
- Interface: BaseProperty
- Interface: BooleanProperty
- Interface: BooleanPropertyConfig
- Interface: Computed
- Interface: Required
- Interface: Unique
- Interface: DateProperty
- Interface: EnumProperty
- Interface: EnumPropertyConfig
- Interface: EnumPropertyOption
- Interface: NumberConfig
- Interface: NumberProperty
- Interface: Boolean
- Interface: Date_
- Interface: Enum
- Interface: Number
- Interface: Reference
- Interface: String
- Interface: ReferenceProperty
- Interface: ReferencePropertyConfig
- Interface: StringConfig
- Interface: StringProperty
- Interface: UniqueConstraint
- Interface: UniqueConstraintConfig
- Interface: CellValue
- Interface: CellValueWithLinks
- Interface: DeleteRecordsRequest
- Interface: FindAndReplaceRecordRequest
- Interface: FindAndReplaceRecordRequestDeprecated
- Interface: FindRecordsRequest
- Interface: GetRecordsRequest
- Interface: RecordCounts
- Interface: RecordWithLinks
- Interface: Record_
- Interface: RecordsResponse
- Interface: RecordsResponseData
- Interface: ValidationMessage
- Interface: GetRecordCountsRequest
- Interface: GetRecordsCsvRequest
- Interface: ListSheetsRequest
- Interface: ListSheetsResponse
- Interface: RecordCountsResponse
- Interface: RecordCountsResponseData
- Interface: Sheet
- Interface: SheetConfig
- Interface: SheetResponse
- Interface: EventToken
- Interface: EventTokenResponse
- Interface: ListSpacesRequest
- Interface: ListSpacesResponse
- Interface: Space
- Interface: SpaceConfig
- Interface: SpaceResponse
- Interface: ApiToken
- Interface: CreateApiTokenRequest
- Interface: ExchangeTokenData
- Interface: ExchangeTokenRequest
- Interface: ExchangeTokenResponse
- Interface: ListApiTokensRequest
- Interface: ListApiTokensResponse
- Interface: ListUsersRequest
- Interface: ListUsersResponse
- Interface: User
- Interface: UserConfig
- Interface: UserResponse
- Interface: VersionResponse
- Interface: VersionsPostRequestBody
- Interface: CreateWorkbookConfig
- Interface: ListWorkbooksRequest
- Interface: ListWorkbooksResponse
- Interface: UpdateWorkbookConfig
- Interface: Workbook
- Interface: WorkbookResponse
- Interface: Options
- @flatfile/api
- Modules
- Namespace: agents
- Namespace: auth
- Namespace: billing
- Namespace: cells
- Namespace: commons
- Namespace: documents
- Namespace: environments
- Namespace: Event
- Namespace: events
- Namespace: files
- Namespace: guests
- Namespace: jobs
- Namespace: Flatfile
- Namespace: Constraint
- Namespace: Property
- Namespace: property
- Namespace: records
- Namespace: sheets
- Namespace: spaces
- Namespace: users
- Namespace: versions
- Namespace: workbooks
- Namespace: FlatfileClient
@flatfile/api / Exports
The Flatfile Node.js library provides convenient access to the Flatfile API from JavaScript/TypeScript.
API reference documentation is available here.
npm install --save @flatfile/api
# or
yarn add @flatfile/api
import { Flatfile, FlatfileClient } from '@flatfile/api';
const flatfile = new FlatfileClient({
token: 'YOUR_API_KEY',
});
const environment = await flatfile.environments.create({
name: 'dev',
isProd: false,
newSpacesInherit: false,
guestAuthentication: [Flatfile.GuestAuthentication.SharedLink],
});
console.log('Created environment with id', environment.id);
When the API returns a non-success status code (4xx or 5xx response), a subclass of FlatfileError will be thrown:
try {
await client.agents.get("environment-id", "agent-id");
} catch (err) {
if (err instanceof FlatfileError) {
console.log(err.statusCode); // 400
console.log(err.message); // "BadRequestError"
console.log(err.body); // list of errors
}
}
Error codes are as followed:
Status Code | Error Type |
---|---|
400 | BadRequestError |
404 | NotFoundError |
The flatfile platform emits different events (e.g. user:added
, webhook:removed
). The SDK uses discriminated unions that make it easy to handle specific events.
const event = eventResponse.data;
if (event.type === 'job:started') {
console.log(event.payload.operation); // FILE
console.log(event.payload.type); // PIPELINE
} else if (event.type === 'records:created') {
console.log(event.payload.count) // 100
}
The SDK uses discriminated unions that make it easy to introspect different fields.
for (const field of sheet.config.fields) {
if (field.type === 'boolean') {
console.log(field.config?.allowIndeterminate); // false
} else if (field.type === "number") {
console.log(field.config?.decimalPlaces); // 2
} else if (field.type === "enum") {
console.log(field.config.allowCustom); // true
}
}
This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning the package version to a specific version in your package.json file. This way, you can install the same version each time without breaking changes unless you are intentionally looking for the latest version.
While we value open-source contributions to this SDK, this library is generated programmatically. Additions made directly to this library would have to be moved over to our generation code, otherwise they would be overwritten upon the next generated release. Feel free to open a PR as a proof of concept, but know that we will not be able to merge it as-is. We suggest opening an issue first to discuss with us!
On the other hand, contributions to the README are always very welcome!
@flatfile/api / Exports / Flatfile / commons / BadRequestError
Flatfile.commons.BadRequestError
This file was auto-generated by Fern from our API Definition.
-
↳
BadRequestError
• new BadRequestError(body
)
Name | Type |
---|---|
body |
Error_ [] |
src/api/resources/commons/errors/BadRequestError.ts:9
• Optional
Readonly
body: unknown
• message: string
node_modules/typescript/lib/lib.es5.d.ts:1023
• name: string
node_modules/typescript/lib/lib.es5.d.ts:1022
• Optional
stack: string
node_modules/typescript/lib/lib.es5.d.ts:1024
• Optional
Readonly
statusCode: number
▪ Static
Optional
prepareStackTrace: (err
: Error
, stackTraces
: CallSite
[]) => any
▸ (err
, stackTraces
): any
Optional override for formatting stack traces
See
https://v8.dev/docs/stack-trace-api#customizing-stack-traces
Name | Type |
---|---|
err |
Error |
stackTraces |
CallSite [] |
any
FlatfileError.prepareStackTrace
node_modules/@types/node/globals.d.ts:11
▪ Static
stackTraceLimit: number
node_modules/@types/node/globals.d.ts:13
▸ Static
captureStackTrace(targetObject
, constructorOpt?
): void
Create .stack property on a target object
Name | Type |
---|---|
targetObject |
object |
constructorOpt? |
Function |
void
FlatfileError.captureStackTrace
node_modules/@types/node/globals.d.ts:4
@flatfile/api / Exports / Flatfile / commons / NotFoundError
Flatfile.commons.NotFoundError
This file was auto-generated by Fern from our API Definition.
-
↳
NotFoundError
• new NotFoundError(body
)
Name | Type |
---|---|
body |
Error_ [] |
src/api/resources/commons/errors/NotFoundError.ts:9
• Optional
Readonly
body: unknown
• message: string
node_modules/typescript/lib/lib.es5.d.ts:1023
• name: string
node_modules/typescript/lib/lib.es5.d.ts:1022
• Optional
stack: string
node_modules/typescript/lib/lib.es5.d.ts:1024
• Optional
Readonly
statusCode: number
▪ Static
Optional
prepareStackTrace: (err
: Error
, stackTraces
: CallSite
[]) => any
▸ (err
, stackTraces
): any
Optional override for formatting stack traces
See
https://v8.dev/docs/stack-trace-api#customizing-stack-traces
Name | Type |
---|---|
err |
Error |
stackTraces |
CallSite [] |
any
FlatfileError.prepareStackTrace
node_modules/@types/node/globals.d.ts:11
▪ Static
stackTraceLimit: number
node_modules/@types/node/globals.d.ts:13
▸ Static
captureStackTrace(targetObject
, constructorOpt?
): void
Create .stack property on a target object
Name | Type |
---|---|
targetObject |
object |
constructorOpt? |
Function |
void
FlatfileError.captureStackTrace
node_modules/@types/node/globals.d.ts:4
@flatfile/api / Exports / FlatfileClient
-
FlatfileClient
↳
FlatfileClient
- _agents
- _auth
- _billing
- _cells
- _documents
- _environments
- _events
- _files
- _guests
- _jobs
- _records
- _sheets
- _spaces
- _users
- _versions
- _workbooks
- options
- token
- agents
- auth
- billing
- cells
- documents
- environments
- events
- files
- guests
- jobs
- records
- sheets
- spaces
- users
- versions
- workbooks
• new FlatfileClient(options?
)
Name | Type |
---|---|
options |
Options |
FernClient.constructor
src/wrapper/FlatfileClient.ts:24
• Protected
_agents: undefined
| Agents
FernClient._agents
• Protected
_auth: undefined
| Auth
FernClient._auth
• Protected
_billing: undefined
| Billing
FernClient._billing
• Protected
_cells: undefined
| Cells
FernClient._cells
• Protected
_documents: undefined
| Documents
FernClient._documents
• Protected
_environments: undefined
| Environments
FernClient._environments
• Protected
_events: undefined
| Events
FernClient._events
• Protected
_files: undefined
| Files
FernClient._files
• Protected
_guests: undefined
| Guests
FernClient._guests
• Protected
_jobs: undefined
| Jobs
FernClient._jobs
• Protected
_records: undefined
| Records
FernClient._records
• Protected
_sheets: undefined
| Sheets
FernClient._sheets
• Protected
_spaces: undefined
| Spaces
FernClient._spaces
• Protected
_users: undefined
| Users
FernClient._users
• Protected
_versions: undefined
| Versions
FernClient._versions
• Protected
_workbooks: undefined
| Workbooks
FernClient._workbooks
• Protected
Readonly
options: Options
FernClient.options
• Private
token: undefined
| string
src/wrapper/FlatfileClient.ts:22
• get
agents(): Agents
Agents
FernClient.agents
• get
auth(): Auth
Auth
FernClient.auth
• get
billing(): Billing
Billing
FernClient.billing
• get
cells(): Cells
Cells
FernClient.cells
• get
documents(): Documents
Documents
FernClient.documents
• get
environments(): Environments
Environments
FernClient.environments
• get
events(): Events
Events
FernClient.events
• get
files(): Files
Files
FernClient.files
• get
guests(): Guests
Guests
FernClient.guests
• get
jobs(): Jobs
Jobs
FernClient.jobs
• get
records(): Records
Records
FernClient.records
• get
sheets(): Sheets
Sheets
FernClient.sheets
• get
spaces(): Spaces
Spaces
FernClient.spaces
• get
users(): Users
Users
FernClient.users
• get
versions(): Versions
Versions
FernClient.versions
• get
workbooks(): Workbooks
Workbooks
FernClient.workbooks
@flatfile/api / Exports / FlatfileError
This file was auto-generated by Fern from our API Definition.
-
Error
↳
FlatfileError
• new FlatfileError(«destructured»
)
Name | Type |
---|---|
«destructured» |
Object |
› body? |
unknown |
› message? |
string |
› statusCode? |
number |
Error.constructor
• Optional
Readonly
body: unknown
• message: string
Error.message
node_modules/typescript/lib/lib.es5.d.ts:1023
• name: string
Error.name
node_modules/typescript/lib/lib.es5.d.ts:1022
• Optional
stack: string
Error.stack
node_modules/typescript/lib/lib.es5.d.ts:1024
• Optional
Readonly
statusCode: number
▪ Static
Optional
prepareStackTrace: (err
: Error
, stackTraces
: CallSite
[]) => any
▸ (err
, stackTraces
): any
Optional override for formatting stack traces
See
https://v8.dev/docs/stack-trace-api#customizing-stack-traces
Name | Type |
---|---|
err |
Error |
stackTraces |
CallSite [] |
any
Error.prepareStackTrace
node_modules/@types/node/globals.d.ts:11
▪ Static
stackTraceLimit: number
Error.stackTraceLimit
node_modules/@types/node/globals.d.ts:13
▸ Static
captureStackTrace(targetObject
, constructorOpt?
): void
Create .stack property on a target object
Name | Type |
---|---|
targetObject |
object |
constructorOpt? |
Function |
void
Error.captureStackTrace
node_modules/@types/node/globals.d.ts:4
@flatfile/api / Exports / FlatfileTimeoutError
This file was auto-generated by Fern from our API Definition.
-
Error
↳
FlatfileTimeoutError
• new FlatfileTimeoutError()
Error.constructor
src/errors/FlatfileTimeoutError.ts:6
• message: string
Error.message
node_modules/typescript/lib/lib.es5.d.ts:1023
• name: string
Error.name
node_modules/typescript/lib/lib.es5.d.ts:1022
• Optional
stack: string
Error.stack
node_modules/typescript/lib/lib.es5.d.ts:1024
▪ Static
Optional
prepareStackTrace: (err
: Error
, stackTraces
: CallSite
[]) => any
▸ (err
, stackTraces
): any
Optional override for formatting stack traces
See
https://v8.dev/docs/stack-trace-api#customizing-stack-traces
Name | Type |
---|---|
err |
Error |
stackTraces |
CallSite [] |
any
Error.prepareStackTrace
node_modules/@types/node/globals.d.ts:11
▪ Static
stackTraceLimit: number
Error.stackTraceLimit
node_modules/@types/node/globals.d.ts:13
▸ Static
captureStackTrace(targetObject
, constructorOpt?
): void
Create .stack property on a target object
Name | Type |
---|---|
targetObject |
object |
constructorOpt? |
Function |
void
Error.captureStackTrace
node_modules/@types/node/globals.d.ts:4
@flatfile/api / Exports / Flatfile / agents / Agent
Example
{
* id: "123",
* topics: [Flatfile.EventTopic.FileCreated],
* compiler: Flatfile.Compiler.Js,
* source: "module.exports = { routeEvent: async (...args) => { console.log(args) } }"
* }
-
↳
Agent
• Optional
compiler: "js"
The compiler of the agent
src/api/resources/agents/types/AgentConfig.ts:21
• id: string
src/api/resources/agents/types/Agent.ts:17
• Optional
source: string
The source of the agent
src/api/resources/agents/types/AgentConfig.ts:23
• Optional
topics: EventTopic
[]
The topics the agent should listen for
src/api/resources/agents/types/AgentConfig.ts:19
@flatfile/api / Exports / Flatfile / agents / AgentConfig
Properties used to create a new agent
Example
{
* topics: [Flatfile.EventTopic.FileCreated],
* compiler: Flatfile.Compiler.Js,
* source: "module.exports = { routeEvent: async (...args) => { console.log(args) } }"
* }
-
AgentConfig
↳
Agent
• Optional
compiler: "js"
The compiler of the agent
src/api/resources/agents/types/AgentConfig.ts:21
• Optional
source: string
The source of the agent
src/api/resources/agents/types/AgentConfig.ts:23
• Optional
topics: EventTopic
[]
The topics the agent should listen for
src/api/resources/agents/types/AgentConfig.ts:19
@flatfile/api / Exports / Flatfile / agents / AgentLog
A log of an agent execution
Example
{
* eventId: "us_evt_9cuesESa7W9cuesE",
* success: true,
* createdAt: new Date("2022-09-18T00:19:57.007Z"),
* completedAt: new Date("2022-09-18T00:20:04.007Z"),
* log: "SUCCESS"
* }
• completedAt: Date
src/api/resources/agents/types/AgentLog.ts:24
• createdAt: Date
src/api/resources/agents/types/AgentLog.ts:23
• eventId: string
src/api/resources/agents/types/AgentLog.ts:20
• Optional
log: string
The log of the agent execution
src/api/resources/agents/types/AgentLog.ts:26
• success: boolean
Whether the agent execution was successful
src/api/resources/agents/types/AgentLog.ts:22
@flatfile/api / Exports / Flatfile / agents / AgentResponse
Example
{
* data: {
* id: "123",
* topics: [Flatfile.EventTopic.FileCreated],
* compiler: Flatfile.Compiler.Js,
* source: "module.exports = { routeEvent: async (...args) => { console.log(args) } }"
* }
* }
• data: Agent
src/api/resources/agents/types/AgentResponse.ts:19
@flatfile/api / Exports / Flatfile / agents / CreateAgentsRequest
Flatfile.agents.CreateAgentsRequest
• body: AgentConfig
src/api/resources/agents/client/requests/CreateAgentsRequest.ts:9
• environmentId: string
src/api/resources/agents/client/requests/CreateAgentsRequest.ts:8
@flatfile/api / Exports / Flatfile / agents / DeleteAgentRequest
Flatfile.agents.DeleteAgentRequest
• body: AgentConfig
src/api/resources/agents/client/requests/DeleteAgentRequest.ts:9
• environmentId: string
src/api/resources/agents/client/requests/DeleteAgentRequest.ts:8
@flatfile/api / Exports / Flatfile / agents / GetAgentLogsRequest
Flatfile.agents.GetAgentLogsRequest
• environmentId: string
src/api/resources/agents/client/requests/GetAgentLogsRequest.ts:8
@flatfile/api / Exports / Flatfile / agents / GetAgentLogsResponse
Flatfile.agents.GetAgentLogsResponse
Example
{
* pagination: {
* currentPage: 3,
* pageCount: 50,
* totalCount: 100
* },
* data: [{
* eventId: "us_evt_9cuesESa7W9cuesE",
* success: true,
* createdAt: new Date("2022-09-18T00:19:57.007Z"),
* completedAt: new Date("2022-09-18T00:20:04.007Z"),
* log: "SUCCESS"
* }]
* }
• data: AgentLog
[]
src/api/resources/agents/types/GetAgentLogsResponse.ts:26
• Optional
pagination: Pagination
src/api/resources/agents/types/GetAgentLogsResponse.ts:25
@flatfile/api / Exports / Flatfile / agents / GetAgentRequest
Flatfile.agents.GetAgentRequest
• environmentId: string
src/api/resources/agents/client/requests/GetAgentRequest.ts:8
@flatfile/api / Exports / Flatfile / agents / GetEnvironmentAgentLogsRequest
Flatfile.agents.GetEnvironmentAgentLogsRequest
• environmentId: string
src/api/resources/agents/client/requests/GetEnvironmentAgentLogsRequest.ts:8
• Optional
pageNumber: number
Based on pageSize, which page of records to return
src/api/resources/agents/client/requests/GetEnvironmentAgentLogsRequest.ts:16
• Optional
pageSize: number
Number of logs to return in a page (default 20)
src/api/resources/agents/client/requests/GetEnvironmentAgentLogsRequest.ts:12
@flatfile/api / Exports / Flatfile / agents / ListAgentsRequest
Flatfile.agents.ListAgentsRequest
• environmentId: string
src/api/resources/agents/client/requests/ListAgentsRequest.ts:8
@flatfile/api / Exports / Flatfile / agents / ListAgentsResponse
Flatfile.agents.ListAgentsResponse
Example
{
* data: [{
* id: "123",
* topics: [Flatfile.EventTopic.FileCreated],
* compiler: Flatfile.Compiler.Js,
* source: "module.exports = { routeEvent: async (...args) => { console.log(args) } }"
* }]
* }
• data: Agent
[]
src/api/resources/agents/types/ListAgentsResponse.ts:19
@flatfile/api / Exports / Flatfile / auth / ApiKey
API Key used for authenticating against our APIs
• Optional
accountId: string
src/api/resources/auth/types/ApiKey.ts:15
• createdAt: Date
src/api/resources/auth/types/ApiKey.ts:17
• Optional
environmentId: string
src/api/resources/auth/types/ApiKey.ts:14
• expireAt: Date
src/api/resources/auth/types/ApiKey.ts:19
• id: string
src/api/resources/auth/types/ApiKey.ts:11
• operations: ApiKeyOperation
[]
src/api/resources/auth/types/ApiKey.ts:16
• rawKey: string
src/api/resources/auth/types/ApiKey.ts:12
• Optional
secret: string
src/api/resources/auth/types/ApiKey.ts:20
• type: ApiKeyType
src/api/resources/auth/types/ApiKey.ts:13
• Optional
updatedAt: Date
src/api/resources/auth/types/ApiKey.ts:18
@flatfile/api / Exports / Flatfile / auth / ApiKeyOperation
This file was auto-generated by Fern from our API Definition.
• method: string
src/api/resources/auth/types/ApiKeyOperation.ts:7
• path: string
src/api/resources/auth/types/ApiKeyOperation.ts:6
@flatfile/api / Exports / Flatfile / auth / ApiKeysResponse
• data: ApiKey
[]
src/api/resources/auth/types/ApiKeysResponse.ts:8
@flatfile/api / Exports / Flatfile / auth / GetApiKeysRequest
Flatfile.auth.GetApiKeysRequest
• environmentId: string
ID of environment to search
src/api/resources/auth/client/requests/GetApiKeysRequest.ts:11
@flatfile/api / Exports / Flatfile / billing / CheckoutSession
Flatfile.billing.CheckoutSession
A Checkout Session as returned by Stripe
• Optional
id: string
src/api/resources/billing/types/CheckoutSession.ts:9
• Optional
object: string
src/api/resources/billing/types/CheckoutSession.ts:10
@flatfile/api / Exports / Flatfile / billing / CreateCheckoutSessionResponse
Flatfile.billing.CreateCheckoutSessionResponse
• data: CheckoutSession
src/api/resources/billing/types/CreateCheckoutSessionResponse.ts:8
@flatfile/api / Exports / Flatfile / billing / ProductsResponse
Flatfile.billing.ProductsResponse
• data: StripeProduct
[]
src/api/resources/billing/types/ProductsResponse.ts:8
@flatfile/api / Exports / Flatfile / billing / StripeProduct
Flatfile.billing.StripeProduct
A product as returned by Stripe
- active
- attributes
- created
- defaultPrice
- description
- id
- images
- livemode
- metadata
- name
- object
- packageDimensions
- shippable
- statementDescriptor
- taxCode
- type
- unitLabel
- updated
- url
• active: boolean
src/api/resources/billing/types/StripeProduct.ts:11
• attributes: string
[]
src/api/resources/billing/types/StripeProduct.ts:12
• created: number
src/api/resources/billing/types/StripeProduct.ts:13
• defaultPrice: string
src/api/resources/billing/types/StripeProduct.ts:14
• description: string
src/api/resources/billing/types/StripeProduct.ts:15
• id: string
src/api/resources/billing/types/StripeProduct.ts:9
• images: string
[]
src/api/resources/billing/types/StripeProduct.ts:16
• livemode: boolean
src/api/resources/billing/types/StripeProduct.ts:17
• Optional
metadata: unknown
src/api/resources/billing/types/StripeProduct.ts:18
• name: string
src/api/resources/billing/types/StripeProduct.ts:19
• object: string
src/api/resources/billing/types/StripeProduct.ts:10
• packageDimensions: string
src/api/resources/billing/types/StripeProduct.ts:20
• shippable: boolean
src/api/resources/billing/types/StripeProduct.ts:21
• statementDescriptor: string
src/api/resources/billing/types/StripeProduct.ts:22
• taxCode: string
src/api/resources/billing/types/StripeProduct.ts:23
• type: string
src/api/resources/billing/types/StripeProduct.ts:24
• unitLabel: string
src/api/resources/billing/types/StripeProduct.ts:25
• updated: number
src/api/resources/billing/types/StripeProduct.ts:26
• url: string
src/api/resources/billing/types/StripeProduct.ts:27
@flatfile/api / Exports / Flatfile / cells / CellValueWithCounts
Flatfile.cells.CellValueWithCounts
-
↳
CellValueWithCounts
• Optional
counts: RecordCounts
src/api/resources/cells/types/CellValueWithCounts.ts:8
• Optional
messages: ValidationMessage
[]
src/api/resources/records/types/CellValue.ts:9
• Optional
updatedAt: Date
src/api/resources/records/types/CellValue.ts:11
• Optional
valid: boolean
src/api/resources/records/types/CellValue.ts:8
• Optional
value: CellValueUnion
src/api/resources/records/types/CellValue.ts:10
@flatfile/api / Exports / Flatfile / cells / CellsResponse
• data: CellsResponseData
src/api/resources/cells/types/CellsResponse.ts:8
@flatfile/api / Exports / Flatfile / cells / GetFieldValuesRequest
Flatfile.cells.GetFieldValuesRequest
- distinct
- fieldKey
- filter
- filterField
- includeCounts
- pageNumber
- pageSize
- searchValue
- sortDirection
- sortField
• Optional
distinct: boolean
When true, excludes duplicate values
src/api/resources/cells/client/requests/GetFieldValuesRequest.ts:34
• fieldKey: string
Returns results from the given field only. Otherwise all field cells are returned
src/api/resources/cells/client/requests/GetFieldValuesRequest.ts:12
• Optional
filter: Filter
Options to filter records
src/api/resources/cells/client/requests/GetFieldValuesRequest.ts:18
• Optional
filterField: string
Name of field by which to filter records
src/api/resources/cells/client/requests/GetFieldValuesRequest.ts:22
• Optional
includeCounts: boolean
When both distinct and includeCounts are true, the count of distinct field values will be returned
src/api/resources/cells/client/requests/GetFieldValuesRequest.ts:38
• Optional
pageNumber: number
Based on pageSize, which page of records to return
src/api/resources/cells/client/requests/GetFieldValuesRequest.ts:30
• Optional
pageSize: number
Number of records to return in a page (default 1000 if pageNumber included)
src/api/resources/cells/client/requests/GetFieldValuesRequest.ts:26
• Optional
searchValue: string
A value to find for a given field in a sheet. Wrap the value in "" for exact match
src/api/resources/cells/client/requests/GetFieldValuesRequest.ts:42
• Optional
sortDirection: SortDirection
src/api/resources/cells/client/requests/GetFieldValuesRequest.ts:14
• Optional
sortField: string
src/api/resources/cells/client/requests/GetFieldValuesRequest.ts:13
@flatfile/api / Exports / Flatfile / commons / Action
• Optional
confirm: boolean
src/api/resources/commons/types/Action.ts:15
• Optional
description: string
src/api/resources/commons/types/Action.ts:13
• label: string
src/api/resources/commons/types/Action.ts:11
• Optional
mode: ActionMode
src/api/resources/commons/types/Action.ts:10
• Optional
operation: string
src/api/resources/commons/types/Action.ts:9
• Optional
primary: boolean
src/api/resources/commons/types/Action.ts:14
• Optional
slug: string
src/api/resources/commons/types/Action.ts:8
• Optional
type: string
src/api/resources/commons/types/Action.ts:12
@flatfile/api / Exports / Flatfile / commons / Error_
This file was auto-generated by Fern from our API Definition.
• Optional
key: string
src/api/resources/commons/types/Error_.ts:6
• message: string
src/api/resources/commons/types/Error_.ts:7
@flatfile/api / Exports / Flatfile / commons / Pagination
pagination info
Example
{
* currentPage: 3,
* pageCount: 50,
* totalCount: 100
* }
• currentPage: number
current page of results
src/api/resources/commons/types/Pagination.ts:17
• pageCount: number
total number of pages of results
src/api/resources/commons/types/Pagination.ts:19
• totalCount: number
total available results
src/api/resources/commons/types/Pagination.ts:21
@flatfile/api / Exports / Flatfile / commons / Success
Informs whether or not a request was successful
Example
{
* data: {
* success: true
* }
* }
-
Success
• data: SuccessData
src/api/resources/commons/types/Success.ts:18
@flatfile/api / Exports / Flatfile / commons / SuccessData
This file was auto-generated by Fern from our API Definition.
• success: boolean
src/api/resources/commons/types/SuccessData.ts:6
@flatfile/api / Exports / Flatfile / documents / Document
A document (markdown components) belong to a space
-
↳
Document
• body: string
src/api/resources/documents/types/DocumentConfig.ts:7
• id: string
src/api/resources/documents/types/Document.ts:11
• Optional
spaceId: string
src/api/resources/documents/types/Document.ts:12
• title: string
src/api/resources/documents/types/DocumentConfig.ts:6
@flatfile/api / Exports / Flatfile / documents / DocumentConfig
Flatfile.documents.DocumentConfig
This file was auto-generated by Fern from our API Definition.
-
DocumentConfig
↳
Document
• body: string
src/api/resources/documents/types/DocumentConfig.ts:7
• title: string
src/api/resources/documents/types/DocumentConfig.ts:6
@flatfile/api / Exports / Flatfile / documents / DocumentResponse
Flatfile.documents.DocumentResponse
• data: Document
src/api/resources/documents/types/DocumentResponse.ts:8
@flatfile/api / Exports / Flatfile / documents / ListDocumentsResponse
Flatfile.documents.ListDocumentsResponse
• data: Document
[]
src/api/resources/documents/types/ListDocumentsResponse.ts:8
@flatfile/api / Exports / Flatfile / environments / Environment
Flatfile.environments.Environment
Example
{
* name: "dev",
* isProd: false,
* guestAuthentication: [Flatfile.GuestAuthenticationEnum.MagicLink],
* id: "us_env_hVXkXs0b",
* accountId: "us_acc_uj6s91wc"
* }
-
↳
Environment
• Optional
accountId: string
src/api/resources/environments/types/Environment.ts:19
• Optional
features: Record
<string
, unknown
>
src/api/resources/environments/types/EnvironmentConfig.ts:23
• Optional
guestAuthentication: GuestAuthenticationEnum
[]
EnvironmentConfig.guestAuthentication
src/api/resources/environments/types/EnvironmentConfig.ts:22
• id: string
src/api/resources/environments/types/Environment.ts:18
• isProd: boolean
Whether or not the environment is a production environment
src/api/resources/environments/types/EnvironmentConfig.ts:21
• name: string
The name of the environment
src/api/resources/environments/types/EnvironmentConfig.ts:19
@flatfile/api / Exports / Flatfile / environments / EnvironmentConfig
Flatfile.environments.EnvironmentConfig
Properties used to create a new environment
Example
{
* name: "dev",
* isProd: false,
* guestAuthentication: [Flatfile.GuestAuthenticationEnum.MagicLink]
* }
-
EnvironmentConfig
• Optional
features: Record
<string
, unknown
>
src/api/resources/environments/types/EnvironmentConfig.ts:23
• Optional
guestAuthentication: GuestAuthenticationEnum
[]
src/api/resources/environments/types/EnvironmentConfig.ts:22
• isProd: boolean
Whether or not the environment is a production environment
src/api/resources/environments/types/EnvironmentConfig.ts:21
• name: string
The name of the environment
src/api/resources/environments/types/EnvironmentConfig.ts:19
@flatfile/api / Exports / Flatfile / environments / EnvironmentResponse
Flatfile.environments.EnvironmentResponse
• data: Environment
src/api/resources/environments/types/EnvironmentResponse.ts:8
@flatfile/api / Exports / Flatfile / environments / ListEnvironmentsRequest
Flatfile.environments.ListEnvironmentsRequest
This file was auto-generated by Fern from our API Definition.
• Optional
pageNumber: number
Based on pageSize, which page of environments to return
src/api/resources/environments/client/requests/ListEnvironmentsRequest.ts:13
• Optional
pageSize: number
Number of environments to return in a page (default 10)
src/api/resources/environments/client/requests/ListEnvironmentsRequest.ts:9
@flatfile/api / Exports / Flatfile / environments / ListEnvironmentsResponse
Flatfile.environments.ListEnvironmentsResponse
• data: Environment
[]
src/api/resources/environments/types/ListEnvironmentsResponse.ts:8
• Optional
pagination: Pagination
src/api/resources/environments/types/ListEnvironmentsResponse.ts:9
@flatfile/api / Exports / Flatfile / events / ActionTriggeredEvent
Flatfile.events.ActionTriggeredEvent
-
↳
ActionTriggeredEvent
- acknowledgedAt
- acknowledgedBy
- attributes
- callbackUrl
- context
- createdAt
- dataUrl
- deletedAt
- domain
- origin
- payload
- target
- topic
• Optional
acknowledgedAt: string
Date the event was acknowledged
src/api/resources/events/types/BaseEvent.ts:24
• Optional
acknowledgedBy: string
The actor (user or system) who acknowledged the event
src/api/resources/events/types/BaseEvent.ts:26
• Optional
attributes: EventAttributes
The attributes of the event
src/api/resources/events/types/BaseEvent.ts:14
• Optional
callbackUrl: string
The callback url to acknowledge the event
src/api/resources/events/types/BaseEvent.ts:16
• context: Context
The context of the event
src/api/resources/events/types/BaseEvent.ts:12
• createdAt: Date
Date the event was created
src/api/resources/events/types/BaseEvent.ts:20
• Optional
dataUrl: string
The url to retrieve the data associated with the event
src/api/resources/events/types/BaseEvent.ts:18
• Optional
deletedAt: Date
Date the event was deleted
src/api/resources/events/types/BaseEvent.ts:22
• domain: Domain
The domain of the event
src/api/resources/events/types/BaseEvent.ts:9
• Optional
origin: Origin
src/api/resources/events/types/BaseEvent.ts:28
• payload: Record
<string
, unknown
>
src/api/resources/events/types/ActionTriggeredEvent.ts:8
• Optional
target: string
src/api/resources/events/types/BaseEvent.ts:27
• topic: EventTopic
src/api/resources/events/types/BaseEvent.ts:10
@flatfile/api / Exports / Flatfile / events / BaseEvent
-
BaseEvent
- acknowledgedAt
- acknowledgedBy
- attributes
- callbackUrl
- context
- createdAt
- dataUrl
- deletedAt
- domain
- origin
- target
- topic
• Optional
acknowledgedAt: string
Date the event was acknowledged
src/api/resources/events/types/BaseEvent.ts:24
• Optional
acknowledgedBy: string
The actor (user or system) who acknowledged the event
src/api/resources/events/types/BaseEvent.ts:26
• Optional
attributes: EventAttributes
The attributes of the event
src/api/resources/events/types/BaseEvent.ts:14
• Optional
callbackUrl: string
The callback url to acknowledge the event
src/api/resources/events/types/BaseEvent.ts:16
• context: Context
The context of the event
src/api/resources/events/types/BaseEvent.ts:12
• createdAt: Date
Date the event was created
src/api/resources/events/types/BaseEvent.ts:20
• Optional
dataUrl: string
The url to retrieve the data associated with the event
src/api/resources/events/types/BaseEvent.ts:18
• Optional
deletedAt: Date
Date the event was deleted
src/api/resources/events/types/BaseEvent.ts:22
• domain: Domain
The domain of the event
src/api/resources/events/types/BaseEvent.ts:9
• Optional
origin: Origin
src/api/resources/events/types/BaseEvent.ts:28
• Optional
target: string
src/api/resources/events/types/BaseEvent.ts:27
• topic: EventTopic
src/api/resources/events/types/BaseEvent.ts:10
@flatfile/api / Exports / Flatfile / events / ClientInitializedEvent
Flatfile.events.ClientInitializedEvent
-
↳
ClientInitializedEvent
- acknowledgedAt
- acknowledgedBy
- attributes
- callbackUrl
- context
- createdAt
- dataUrl
- deletedAt
- domain
- origin
- payload
- target
- topic
• Optional
acknowledgedAt: string
Date the event was acknowledged
src/api/resources/events/types/BaseEvent.ts:24
• Optional
acknowledgedBy: string
The actor (user or system) who acknowledged the event
src/api/resources/events/types/BaseEvent.ts:26
• Optional
attributes: EventAttributes
The attributes of the event
src/api/resources/events/types/BaseEvent.ts:14
• Optional
callbackUrl: string
The callback url to acknowledge the event
src/api/resources/events/types/BaseEvent.ts:16
• context: Context
The context of the event
src/api/resources/events/types/BaseEvent.ts:12
• createdAt: Date
Date the event was created
src/api/resources/events/types/BaseEvent.ts:20
• Optional
dataUrl: string
The url to retrieve the data associated with the event
src/api/resources/events/types/BaseEvent.ts:18
• Optional
deletedAt: Date
Date the event was deleted
src/api/resources/events/types/BaseEvent.ts:22
• domain: Domain
The domain of the event
src/api/resources/events/types/BaseEvent.ts:9
• Optional
origin: Origin
src/api/resources/events/types/BaseEvent.ts:28
• payload: Record
<string
, unknown
>
src/api/resources/events/types/ClientInitializedEvent.ts:8
• Optional
target: string
src/api/resources/events/types/BaseEvent.ts:27
• topic: EventTopic
src/api/resources/events/types/BaseEvent.ts:10
@flatfile/api / Exports / Flatfile / events / Context
The context of the event
- accountId
- actionName
- actorId
- environmentId
- fileId
- jobId
- precedingEventId
- sheetId
- sheetSlug
- spaceId
- versionId
- workbookId
• accountId: string
src/api/resources/events/types/Context.ts:12
• Optional
actionName: string
src/api/resources/events/types/Context.ts:11
• Optional
actorId: string
Can be a UserId, GuestId, or AgentId
src/api/resources/events/types/Context.ts:23
• environmentId: string
src/api/resources/events/types/Context.ts:13
• Optional
fileId: string
src/api/resources/events/types/Context.ts:20
• Optional
jobId: string
src/api/resources/events/types/Context.ts:19
• Optional
precedingEventId: string
src/api/resources/events/types/Context.ts:21
• Optional
sheetId: string
src/api/resources/events/types/Context.ts:16
• Optional
sheetSlug: string
src/api/resources/events/types/Context.ts:17
• Optional
spaceId: string
src/api/resources/events/types/Context.ts:14
• Optional
versionId: string
src/api/resources/events/types/Context.ts:18
• Optional
workbookId: string
src/api/resources/events/types/Context.ts:15
@flatfile/api / Exports / Flatfile / events / Event / ActionTriggered
-
↳
ActionTriggered
- acknowledgedAt
- acknowledgedBy
- attributes
- callbackUrl
- context
- createdAt
- dataUrl
- deletedAt
- domain
- origin
- payload
- target
- topic
- type
• Optional
acknowledgedAt: string
Date the event was acknowledged
ActionTriggeredEvent.acknowledgedAt
src/api/resources/events/types/BaseEvent.ts:24
• Optional
acknowledgedBy: string
The actor (user or system) who acknowledged the event
ActionTriggeredEvent.acknowledgedBy
src/api/resources/events/types/BaseEvent.ts:26
• Optional
attributes: EventAttributes
The attributes of the event
ActionTriggeredEvent.attributes
src/api/resources/events/types/BaseEvent.ts:14
• Optional
callbackUrl: string
The callback url to acknowledge the event
ActionTriggeredEvent.callbackUrl
src/api/resources/events/types/BaseEvent.ts:16
• context: Context
The context of the event
src/api/resources/events/types/BaseEvent.ts:12
• createdAt: Date
Date the event was created
ActionTriggeredEvent.createdAt
src/api/resources/events/types/BaseEvent.ts:20
• Optional
dataUrl: string
The url to retrieve the data associated with the event
src/api/resources/events/types/BaseEvent.ts:18
• Optional
deletedAt: Date
Date the event was deleted
ActionTriggeredEvent.deletedAt
src/api/resources/events/types/BaseEvent.ts:22
• domain: Domain
The domain of the event
src/api/resources/events/types/BaseEvent.ts:9
• Optional
origin: Origin
src/api/resources/events/types/BaseEvent.ts:28
• payload: Record
<string
, unknown
>
src/api/resources/events/types/ActionTriggeredEvent.ts:8
• Optional
target: string
src/api/resources/events/types/BaseEvent.ts:27
• topic: EventTopic
src/api/resources/events/types/BaseEvent.ts:10
• type: "action:triggered"
src/api/resources/events/types/Event.ts:127
@flatfile/api / Exports / Flatfile / events / Event / ClientInitialized
events.Event.ClientInitialized
-
↳
ClientInitialized
- acknowledgedAt
- acknowledgedBy
- attributes
- callbackUrl
- context
- createdAt
- dataUrl
- deletedAt
- domain
- origin
- payload
- target
- topic
- type
• Optional
acknowledgedAt: string
Date the event was acknowledged
ClientInitializedEvent.acknowledgedAt
src/api/resources/events/types/BaseEvent.ts:24
• Optional
acknowledgedBy: string
The actor (user or system) who acknowledged the event
ClientInitializedEvent.acknowledgedBy
src/api/resources/events/types/BaseEvent.ts:26
• Optional
attributes: EventAttributes
The attributes of the event
ClientInitializedEvent.attributes
src/api/resources/events/types/BaseEvent.ts:14
• Optional
callbackUrl: string
The callback url to acknowledge the event
ClientInitializedEvent.callbackUrl
src/api/resources/events/types/BaseEvent.ts:16
• context: Context
The context of the event
ClientInitializedEvent.context
src/api/resources/events/types/BaseEvent.ts:12
• createdAt: Date
Date the event was created
ClientInitializedEvent.createdAt
src/api/resources/events/types/BaseEvent.ts:20
• Optional
dataUrl: string
The url to retrieve the data associated with the event
ClientInitializedEvent.dataUrl
src/api/resources/events/types/BaseEvent.ts:18
• Optional
deletedAt: Date
Date the event was deleted
ClientInitializedEvent.deletedAt
src/api/resources/events/types/BaseEvent.ts:22
• domain: Domain
The domain of the event
src/api/resources/events/types/BaseEvent.ts:9
• Optional
origin: Origin
src/api/resources/events/types/BaseEvent.ts:28
• payload: Record
<string
, unknown
>
ClientInitializedEvent.payload
src/api/resources/events/types/ClientInitializedEvent.ts:8
• Optional
target: string
src/api/resources/events/types/BaseEvent.ts:27
• topic: EventTopic
src/api/resources/events/types/BaseEvent.ts:10
• type: "client:init"
src/api/resources/events/types/Event.ts:135
@flatfile/api / Exports / Flatfile / events / Event / FileDeleted
-
↳
FileDeleted
- acknowledgedAt
- acknowledgedBy
- attributes
- callbackUrl
- context
- createdAt
- dataUrl
- deletedAt
- domain
- origin
- payload
- target
- topic
- type
• Optional
acknowledgedAt: string
Date the event was acknowledged
FileDeletedEvent.acknowledgedAt
src/api/resources/events/types/BaseEvent.ts:24
• Optional
acknowledgedBy: string
The actor (user or system) who acknowledged the event
FileDeletedEvent.acknowledgedBy
src/api/resources/events/types/BaseEvent.ts:26
• Optional
attributes: EventAttributes
The attributes of the event
src/api/resources/events/types/BaseEvent.ts:14
• Optional
callbackUrl: string
The callback url to acknowledge the event
src/api/resources/events/types/BaseEvent.ts:16
• context: Context
The context of the event
src/api/resources/events/types/BaseEvent.ts:12
• createdAt: Date
Date the event was created
src/api/resources/events/types/BaseEvent.ts:20
• Optional
dataUrl: string
The url to retrieve the data associated with the event
src/api/resources/events/types/BaseEvent.ts:18
• Optional
deletedAt: Date
Date the event was deleted
src/api/resources/events/types/BaseEvent.ts:22
• domain: Domain
The domain of the event
src/api/resources/events/types/BaseEvent.ts:9
• Optional
origin: Origin
src/api/resources/events/types/BaseEvent.ts:28
• payload: Record
<string
, unknown
>
src/api/resources/events/types/FileDeletedEvent.ts:8
• Optional
target: string
src/api/resources/events/types/BaseEvent.ts:27
• topic: EventTopic
src/api/resources/events/types/BaseEvent.ts:10
• type: "file:deleted"
src/api/resources/events/types/Event.ts:131
@flatfile/api / Exports / Flatfile / events / Event / JobCompleted
-
↳
JobCompleted
- acknowledgedAt
- acknowledgedBy
- attributes
- callbackUrl
- context
- createdAt
- dataUrl
- deletedAt
- domain
- origin
- payload
- target
- topic
- type
• Optional
acknowledgedAt: string
Date the event was acknowledged
JobCompletedEvent.acknowledgedAt
src/api/resources/events/types/BaseEvent.ts:24
• Optional
acknowledgedBy: string
The actor (user or system) who acknowledged the event
JobCompletedEvent.acknowledgedBy
src/api/resources/events/types/BaseEvent.ts:26
• Optional
attributes: EventAttributes
The attributes of the event
src/api/resources/events/types/BaseEvent.ts:14
• Optional
callbackUrl: string
The callback url to acknowledge the event
src/api/resources/events/types/BaseEvent.ts:16
• context: Context
The context of the event
src/api/resources/events/types/BaseEvent.ts:12
• createdAt: Date
Date the event was created
src/api/resources/events/types/BaseEvent.ts:20
• Optional
dataUrl: string
The url to retrieve the data associated with the event
src/api/resources/events/types/BaseEvent.ts:18
• Optional
deletedAt: Date
Date the event was deleted
src/api/resources/events/types/BaseEvent.ts:22
• domain: Domain
The domain of the event
src/api/resources/events/types/BaseEvent.ts:9
• Optional
origin: Origin
src/api/resources/events/types/BaseEvent.ts:28
• payload: JobPayload
src/api/resources/events/types/JobCompletedEvent.ts:8
• Optional
target: string
src/api/resources/events/types/BaseEvent.ts:27
• topic: EventTopic
src/api/resources/events/types/BaseEvent.ts:10
• type: "job_completed"
src/api/resources/events/types/Event.ts:103
@flatfile/api / Exports / Flatfile / events / Event / JobDeleted
-
↳
JobDeleted
- acknowledgedAt
- acknowledgedBy
- attributes
- callbackUrl
- context
- createdAt
- dataUrl
- deletedAt
- domain
- origin
- payload
- target
- topic
- type
• Optional
acknowledgedAt: string
Date the event was acknowledged
JobDeletedEvent.acknowledgedAt
src/api/resources/events/types/BaseEvent.ts:24
• Optional
acknowledgedBy: string
The actor (user or system) who acknowledged the event
JobDeletedEvent.acknowledgedBy
src/api/resources/events/types/BaseEvent.ts:26
• Optional
attributes: EventAttributes
The attributes of the event
src/api/resources/events/types/BaseEvent.ts:14
• Optional
callbackUrl: string
The callback url to acknowledge the event
src/api/resources/events/types/BaseEvent.ts:16
• context: Context
The context of the event
src/api/resources/events/types/BaseEvent.ts:12
• createdAt: Date
Date the event was created
src/api/resources/events/types/BaseEvent.ts:20
• Optional
dataUrl: string
The url to retrieve the data associated with the event
src/api/resources/events/types/BaseEvent.ts:18
• Optional
deletedAt: Date
Date the event was deleted
src/api/resources/events/types/BaseEvent.ts:22
• domain: Domain
The domain of the event
src/api/resources/events/types/BaseEvent.ts:9
• Optional
origin: Origin
src/api/resources/events/types/BaseEvent.ts:28
• payload: Record
<string
, unknown
>
src/api/resources/events/types/JobDeletedEvent.ts:8
• Optional
target: string
src/api/resources/events/types/BaseEvent.ts:27
• topic: EventTopic
src/api/resources/events/types/BaseEvent.ts:10
• type: "job:deleted"
src/api/resources/events/types/Event.ts:107
@flatfile/api / Exports / Flatfile / events / Event / JobFailed
-
↳
JobFailed
- acknowledgedAt
- acknowledgedBy
- attributes
- callbackUrl
- context
- createdAt
- dataUrl
- deletedAt
- domain
- origin
- payload
- target
- topic
- type
• Optional
acknowledgedAt: string
Date the event was acknowledged
src/api/resources/events/types/BaseEvent.ts:24
• Optional
acknowledgedBy: string
The actor (user or system) who acknowledged the event
src/api/resources/events/types/BaseEvent.ts:26
• Optional
attributes: EventAttributes
The attributes of the event
src/api/resources/events/types/BaseEvent.ts:14
• Optional
callbackUrl: string
The callback url to acknowledge the event
src/api/resources/events/types/BaseEvent.ts:16
• context: Context
The context of the event
src/api/resources/events/types/BaseEvent.ts:12
• createdAt: Date
Date the event was created
src/api/resources/events/types/BaseEvent.ts:20
• Optional
dataUrl: string
The url to retrieve the data associated with the event
src/api/resources/events/types/BaseEvent.ts:18
• Optional
deletedAt: Date
Date the event was deleted
src/api/resources/events/types/BaseEvent.ts:22
• domain: Domain
The domain of the event
src/api/resources/events/types/BaseEvent.ts:9
• Optional
origin: Origin
src/api/resources/events/types/BaseEvent.ts:28
• payload: JobFailedPayload
src/api/resources/events/types/JobFailedEvent.ts:8
• Optional
target: string
src/api/resources/events/types/BaseEvent.ts:27
• topic: EventTopic
src/api/resources/events/types/BaseEvent.ts:10
• type: "job:failed"
src/api/resources/events/types/Event.ts:99
@flatfile/api / Exports / Flatfile / events / Event / JobStarted
-
↳
JobStarted
- acknowledgedAt
- acknowledgedBy
- attributes
- callbackUrl
- context
- createdAt
- dataUrl
- deletedAt
- domain
- origin
- payload
- target
- topic
- type
• Optional
acknowledgedAt: string
Date the event was acknowledged
JobStartedEvent.acknowledgedAt
src/api/resources/events/types/BaseEvent.ts:24
• Optional
acknowledgedBy: string
The actor (user or system) who acknowledged the event
JobStartedEvent.acknowledgedBy
src/api/resources/events/types/BaseEvent.ts:26
• Optional
attributes: EventAttributes
The attributes of the event
src/api/resources/events/types/BaseEvent.ts:14
• Optional
callbackUrl: string
The callback url to acknowledge the event
src/api/resources/events/types/BaseEvent.ts:16
• context: Context
The context of the event
src/api/resources/events/types/BaseEvent.ts:12
• createdAt: Date
Date the event was created
src/api/resources/events/types/BaseEvent.ts:20
• Optional
dataUrl: string
The url to retrieve the data associated with the event
src/api/resources/events/types/BaseEvent.ts:18
• Optional
deletedAt: Date
Date the event was deleted
src/api/resources/events/types/BaseEvent.ts:22
• domain: Domain
The domain of the event
src/api/resources/events/types/BaseEvent.ts:9
• Optional
origin: Origin
src/api/resources/events/types/BaseEvent.ts:28
• payload: JobPayload
src/api/resources/events/types/JobStartedEvent.ts:8
• Optional
target: string
src/api/resources/events/types/BaseEvent.ts:27
• topic: EventTopic
src/api/resources/events/types/BaseEvent.ts:10
• type: "job:started"
src/api/resources/events/types/Event.ts:87
@flatfile/api / Exports / Flatfile / events / Event / JobUpdated
-
↳
JobUpdated
- acknowledgedAt
- acknowledgedBy
- attributes
- callbackUrl
- context
- createdAt
- dataUrl
- deletedAt
- domain
- origin
- payload
- target
- topic
- type
• Optional
acknowledgedAt: string
Date the event was acknowledged
JobUpdatedEvent.acknowledgedAt
src/api/resources/events/types/BaseEvent.ts:24
• Optional
acknowledgedBy: string
The actor (user or system) who acknowledged the event
JobUpdatedEvent.acknowledgedBy
src/api/resources/events/types/BaseEvent.ts:26
• Optional
attributes: EventAttributes
The attributes of the event
src/api/resources/events/types/BaseEvent.ts:14
• Optional
callbackUrl: string
The callback url to acknowledge the event
src/api/resources/events/types/BaseEvent.ts:16
• context: Context
The context of the event
src/api/resources/events/types/BaseEvent.ts:12
• createdAt: Date
Date the event was created
src/api/resources/events/types/BaseEvent.ts:20
• Optional
dataUrl: string
The url to retrieve the data associated with the event
src/api/resources/events/types/BaseEvent.ts:18
• Optional
deletedAt: Date
Date the event was deleted
src/api/resources/events/types/BaseEvent.ts:22
• domain: Domain
The domain of the event
src/api/resources/events/types/BaseEvent.ts:9
• Optional
origin: Origin
src/api/resources/events/types/BaseEvent.ts:28
• payload: JobPayload
src/api/resources/events/types/JobUpdatedEvent.ts:8
• Optional
target: string
src/api/resources/events/types/BaseEvent.ts:27
• topic: EventTopic
src/api/resources/events/types/BaseEvent.ts:10
• type: "job:updated"
src/api/resources/events/types/Event.ts:95
@flatfile/api / Exports / Flatfile / events / Event / JobWaiting
-
↳
JobWaiting
- acknowledgedAt
- acknowledgedBy
- attributes
- callbackUrl
- context
- createdAt
- dataUrl
- deletedAt
- domain
- origin
- payload
- target
- topic
- type
• Optional
acknowledgedAt: string
Date the event was acknowledged
JobWaitingEvent.acknowledgedAt
src/api/resources/events/types/BaseEvent.ts:24
• Optional
acknowledgedBy: string
The actor (user or system) who acknowledged the event
JobWaitingEvent.acknowledgedBy
src/api/resources/events/types/BaseEvent.ts:26
• Optional
attributes: EventAttributes
The attributes of the event
src/api/resources/events/types/BaseEvent.ts:14
• Optional
callbackUrl: string
The callback url to acknowledge the event
src/api/resources/events/types/BaseEvent.ts:16
• context: Context
The context of the event
src/api/resources/events/types/BaseEvent.ts:12
• createdAt: Date
Date the event was created
src/api/resources/events/types/BaseEvent.ts:20
• Optional
dataUrl: string
The url to retrieve the data associated with the event
src/api/resources/events/types/BaseEvent.ts:18
• Optional
deletedAt: Date
Date the event was deleted
src/api/resources/events/types/BaseEvent.ts:22
• domain: Domain
The domain of the event
src/api/resources/events/types/BaseEvent.ts:9
• Optional
origin: Origin
src/api/resources/events/types/BaseEvent.ts:28
• payload: Record
<string
, unknown
>
src/api/resources/events/types/JobWaitingEvent.ts:8
• Optional
target: string
src/api/resources/events/types/BaseEvent.ts:27
• topic: EventTopic
src/api/resources/events/types/BaseEvent.ts:10
• type: "job:waiting"
src/api/resources/events/types/Event.ts:91
@flatfile/api / Exports / Flatfile / events / Event / RecordsCreated
-
↳
RecordsCreated
- acknowledgedAt
- acknowledgedBy
- attributes
- callbackUrl
- context
- createdAt
- dataUrl
- deletedAt
- domain
- origin
- payload
- target
- topic
- type
• Optional
acknowledgedAt: string
Date the event was acknowledged
RecordsCreatedEvent.acknowledgedAt
src/api/resources/events/types/BaseEvent.ts:24
• Optional
acknowledgedBy: string
The actor (user or system) who acknowledged the event
RecordsCreatedEvent.acknowledgedBy
src/api/resources/events/types/BaseEvent.ts:26
• Optional
attributes: EventAttributes
The attributes of the event
RecordsCreatedEvent.attributes
src/api/resources/events/types/BaseEvent.ts:14
• Optional
callbackUrl: string
The callback url to acknowledge the event
RecordsCreatedEvent.callbackUrl
src/api/resources/events/types/BaseEvent.ts:16
• context: Context
The context of the event
src/api/resources/events/types/BaseEvent.ts:12
• createdAt: Date
Date the event was created
src/api/resources/events/types/BaseEvent.ts:20
• Optional
dataUrl: string
The url to retrieve the data associated with the event
src/api/resources/events/types/BaseEvent.ts:18
• Optional
deletedAt: Date
Date the event was deleted
src/api/resources/events/types/BaseEvent.ts:22
• domain: Domain
The domain of the event
src/api/resources/events/types/BaseEvent.ts:9
• Optional
origin: Origin
src/api/resources/events/types/BaseEvent.ts:28
• payload: RecordsPayload
src/api/resources/events/types/RecordsCreatedEvent.ts:8
• Optional
target: string
src/api/resources/events/types/BaseEvent.ts:27
• topic: EventTopic
src/api/resources/events/types/BaseEvent.ts:10
• type: "records:created"
src/api/resources/events/types/Event.ts:111
@flatfile/api / Exports / Flatfile / events / Event / RecordsDeleted
-
↳
RecordsDeleted
- acknowledgedAt
- acknowledgedBy
- attributes
- callbackUrl
- context
- createdAt
- dataUrl
- deletedAt
- domain
- origin
- payload
- target
- topic
- type
• Optional
acknowledgedAt: string
Date the event was acknowledged
RecordsDeletedEvent.acknowledgedAt
src/api/resources/events/types/BaseEvent.ts:24
• Optional
acknowledgedBy: string
The actor (user or system) who acknowledged the event
RecordsDeletedEvent.acknowledgedBy
src/api/resources/events/types/BaseEvent.ts:26
• Optional
attributes: EventAttributes
The attributes of the event
RecordsDeletedEvent.attributes
src/api/resources/events/types/BaseEvent.ts:14
• Optional
callbackUrl: string
The callback url to acknowledge the event
RecordsDeletedEvent.callbackUrl
src/api/resources/events/types/BaseEvent.ts:16
• context: Context
The context of the event
src/api/resources/events/types/BaseEvent.ts:12
• createdAt: Date
Date the event was created
src/api/resources/events/types/BaseEvent.ts:20
• Optional
dataUrl: string
The url to retrieve the data associated with the event
src/api/resources/events/types/BaseEvent.ts:18
• Optional
deletedAt: Date
Date the event was deleted
src/api/resources/events/types/BaseEvent.ts:22
• domain: Domain
The domain of the event
src/api/resources/events/types/BaseEvent.ts:9
• Optional
origin: Origin
src/api/resources/events/types/BaseEvent.ts:28
• payload: Record
<string
, unknown
>
src/api/resources/events/types/RecordsDeletedEvent.ts:8
• Optional
target: string
src/api/resources/events/types/BaseEvent.ts:27
• topic: EventTopic
src/api/resources/events/types/BaseEvent.ts:10
• type: "records:deleted"
src/api/resources/events/types/Event.ts:119
@flatfile/api / Exports / Flatfile / events / Event / RecordsUpdated
-
↳
RecordsUpdated
- acknowledgedAt
- acknowledgedBy
- attributes
- callbackUrl
- context
- createdAt
- dataUrl
- deletedAt
- domain
- origin
- payload
- target
- topic
- type
• Optional
acknowledgedAt: string
Date the event was acknowledged
RecordsUpdatedEvent.acknowledgedAt
src/api/resources/events/types/BaseEvent.ts:24
• Optional
acknowledgedBy: string
The actor (user or system) who acknowledged the event
RecordsUpdatedEvent.acknowledgedBy
src/api/resources/events/types/BaseEvent.ts:26
• Optional
attributes: EventAttributes
The attributes of the event
RecordsUpdatedEvent.attributes
src/api/resources/events/types/BaseEvent.ts:14
• Optional
callbackUrl: string
The callback url to acknowledge the event
RecordsUpdatedEvent.callbackUrl
src/api/resources/events/types/BaseEvent.ts:16
• context: Context
The context of the event
src/api/resources/events/types/BaseEvent.ts:12
• createdAt: Date
Date the event was created
src/api/resources/events/types/BaseEvent.ts:20
• Optional
dataUrl: string
The url to retrieve the data associated with the event
src/api/resources/events/types/BaseEvent.ts:18
• Optional
deletedAt: Date
Date the event was deleted
src/api/resources/events/types/BaseEvent.ts:22
• domain: Domain
The domain of the event
src/api/resources/events/types/BaseEvent.ts:9
• Optional
origin: Origin
src/api/resources/events/types/BaseEvent.ts:28
• payload: RecordsPayload
src/api/resources/events/types/RecordsUpdatedEvent.ts:8
• Optional
target: string
src/api/resources/events/types/BaseEvent.ts:27
• topic: EventTopic
src/api/resources/events/types/BaseEvent.ts:10
• type: "records:updated"
src/api/resources/events/types/Event.ts:115
@flatfile/api / Exports / Flatfile / events / Event / SheetValidated
-
↳
SheetValidated
- acknowledgedAt
- acknowledgedBy
- attributes
- callbackUrl
- context
- createdAt
- dataUrl
- deletedAt
- domain
- origin
- payload
- target
- topic
- type
• Optional
acknowledgedAt: string
Date the event was acknowledged
SheetValidatedEvent.acknowledgedAt
src/api/resources/events/types/BaseEvent.ts:24
• Optional
acknowledgedBy: string
The actor (user or system) who acknowledged the event
SheetValidatedEvent.acknowledgedBy
src/api/resources/events/types/BaseEvent.ts:26
• Optional
attributes: EventAttributes
The attributes of the event
SheetValidatedEvent.attributes
src/api/resources/events/types/BaseEvent.ts:14
• Optional
callbackUrl: string
The callback url to acknowledge the event
SheetValidatedEvent.callbackUrl
src/api/resources/events/types/BaseEvent.ts:16
• context: Context
The context of the event
src/api/resources/events/types/BaseEvent.ts:12
• createdAt: Date
Date the event was created
src/api/resources/events/types/BaseEvent.ts:20
• Optional
dataUrl: string
The url to retrieve the data associated with the event
src/api/resources/events/types/BaseEvent.ts:18
• Optional
deletedAt: Date
Date the event was deleted
src/api/resources/events/types/BaseEvent.ts:22
• domain: Domain
The domain of the event
src/api/resources/events/types/BaseEvent.ts:9
• Optional
origin: Origin
src/api/resources/events/types/BaseEvent.ts:28
• payload: Record
<string
, unknown
>
src/api/resources/events/types/SheetValidatedEvent.ts:8
• Optional
target: string
src/api/resources/events/types/BaseEvent.ts:27
• topic: EventTopic
src/api/resources/events/types/BaseEvent.ts:10
• type: "sheet:validated"
src/api/resources/events/types/Event.ts:123
@flatfile/api / Exports / Flatfile / events / Event / SpaceAdded
-
↳
SpaceAdded
- acknowledgedAt
- acknowledgedBy
- attributes
- callbackUrl
- context
- createdAt
- dataUrl
- deletedAt
- domain
- origin
- payload
- target
- topic
- type
• Optional
acknowledgedAt: string
Date the event was acknowledged
SpaceAddedEvent.acknowledgedAt
src/api/resources/events/types/BaseEvent.ts:24
• Optional
acknowledgedBy: string
The actor (user or system) who acknowledged the event
SpaceAddedEvent.acknowledgedBy
src/api/resources/events/types/BaseEvent.ts:26
• Optional
attributes: EventAttributes
The attributes of the event
src/api/resources/events/types/BaseEvent.ts:14
• Optional
callbackUrl: string
The callback url to acknowledge the event
src/api/resources/events/types/BaseEvent.ts:16
• context: Context
The context of the event
src/api/resources/events/types/BaseEvent.ts:12
• createdAt: Date
Date the event was created
src/api/resources/events/types/BaseEvent.ts:20
• Optional
dataUrl: string
The url to retrieve the data associated with the event
src/api/resources/events/types/BaseEvent.ts:18
• Optional
deletedAt: Date
Date the event was deleted
src/api/resources/events/types/BaseEvent.ts:22
• domain: Domain
The domain of the event
src/api/resources/events/types/BaseEvent.ts:9
• Optional
origin: Origin
src/api/resources/events/types/BaseEvent.ts:28
• payload: Record
<string
, unknown
>
src/api/resources/events/types/SpaceAddedEvent.ts:8
• Optional
target: string
src/api/resources/events/types/BaseEvent.ts:27
• topic: EventTopic
src/api/resources/events/types/BaseEvent.ts:10
• type: "space:added"
src/api/resources/events/types/Event.ts:39
@flatfile/api / Exports / Flatfile / events / Event / SpaceRemoved
-
↳
SpaceRemoved
- acknowledgedAt
- acknowledgedBy
- attributes
- callbackUrl
- context
- createdAt
- dataUrl
- deletedAt
- domain
- origin
- payload
- target
- topic
- type
• Optional
acknowledgedAt: string
Date the event was acknowledged
SpaceRemovedEvent.acknowledgedAt
src/api/resources/events/types/BaseEvent.ts:24
• Optional
acknowledgedBy: string
The actor (user or system) who acknowledged the event
SpaceRemovedEvent.acknowledgedBy
src/api/resources/events/types/BaseEvent.ts:26
• Optional
attributes: EventAttributes
The attributes of the event
src/api/resources/events/types/BaseEvent.ts:14
• Optional
callbackUrl: string
The callback url to acknowledge the event
src/api/resources/events/types/BaseEvent.ts:16
• context: Context
The context of the event
src/api/resources/events/types/BaseEvent.ts:12
• createdAt: Date
Date the event was created
src/api/resources/events/types/BaseEvent.ts:20
• Optional
dataUrl: string
The url to retrieve the data associated with the event
src/api/resources/events/types/BaseEvent.ts:18
• Optional
deletedAt: Date
Date the event was deleted
src/api/resources/events/types/BaseEvent.ts:22
• domain: Domain
The domain of the event
src/api/resources/events/types/BaseEvent.ts:9
• Optional
origin: Origin
src/api/resources/events/types/BaseEvent.ts:28
• payload: Record
<string
, unknown
>
src/api/resources/events/types/SpaceRemovedEvent.ts:8
• Optional
target: string
src/api/resources/events/types/BaseEvent.ts:27
• topic: EventTopic
src/api/resources/events/types/BaseEvent.ts:10
• type: "space:removed"
src/api/resources/events/types/Event.ts:43
@flatfile/api / Exports / Flatfile / events / Event / UploadCompleted
-
↳
UploadCompleted
- acknowledgedAt
- acknowledgedBy
- attributes
- callbackUrl
- context
- createdAt
- dataUrl
- deletedAt
- domain
- origin
- payload
- target
- topic
- type
• Optional
acknowledgedAt: string
Date the event was acknowledged
UploadCompletedEvent.acknowledgedAt
src/api/resources/events/types/BaseEvent.ts:24
• Optional
acknowledgedBy: string
The actor (user or system) who acknowledged the event
UploadCompletedEvent.acknowledgedBy
src/api/resources/events/types/BaseEvent.ts:26
• Optional
attributes: EventAttributes
The attributes of the event
UploadCompletedEvent.attributes
src/api/resources/events/types/BaseEvent.ts:14
• Optional
callbackUrl: string
The callback url to acknowledge the event
UploadCompletedEvent.callbackUrl
src/api/resources/events/types/BaseEvent.ts:16
• context: Context
The context of the event
src/api/resources/events/types/BaseEvent.ts:12
• createdAt: Date
Date the event was created
UploadCompletedEvent.createdAt
src/api/resources/events/types/BaseEvent.ts:20
• Optional
dataUrl: string
The url to retrieve the data associated with the event
src/api/resources/events/types/BaseEvent.ts:18
• Optional
deletedAt: Date
Date the event was deleted
UploadCompletedEvent.deletedAt
src/api/resources/events/types/BaseEvent.ts:22
• domain: Domain
The domain of the event
src/api/resources/events/types/BaseEvent.ts:9
• Optional
origin: Origin
src/api/resources/events/types/BaseEvent.ts:28
• payload: Record
<string
, unknown
>
src/api/resources/events/types/UploadCompletedEvent.ts:8
• Optional
target: string
src/api/resources/events/types/BaseEvent.ts:27
• topic: EventTopic
src/api/resources/events/types/BaseEvent.ts:10
• type: "upload:completed"
src/api/resources/events/types/Event.ts:83
@flatfile/api / Exports / Flatfile / events / Event / UploadFailed
-
↳
UploadFailed
- acknowledgedAt
- acknowledgedBy
- attributes
- callbackUrl
- context
- createdAt
- dataUrl
- deletedAt
- domain
- origin
- payload
- target
- topic
- type
• Optional
acknowledgedAt: string
Date the event was acknowledged
UploadFailedEvent.acknowledgedAt
src/api/resources/events/types/BaseEvent.ts:24
• Optional
acknowledgedBy: string
The actor (user or system) who acknowledged the event
UploadFailedEvent.acknowledgedBy
src/api/resources/events/types/BaseEvent.ts:26
• Optional
attributes: EventAttributes
The attributes of the event
src/api/resources/events/types/BaseEvent.ts:14
• Optional
callbackUrl: string
The callback url to acknowledge the event
src/api/resources/events/types/BaseEvent.ts:16
• context: Context
The context of the event
src/api/resources/events/types/BaseEvent.ts:12
• createdAt: Date
Date the event was created
src/api/resources/events/types/BaseEvent.ts:20
• Optional
dataUrl: string
The url to retrieve the data associated with the event
src/api/resources/events/types/BaseEvent.ts:18
• Optional
deletedAt: Date
Date the event was deleted
src/api/resources/events/types/BaseEvent.ts:22
• domain: Domain
The domain of the event
src/api/resources/events/types/BaseEvent.ts:9
• Optional
origin: Origin
src/api/resources/events/types/BaseEvent.ts:28
• payload: Record
<string
, unknown
>
src/api/resources/events/types/UploadFailedEvent.ts:8
• Optional
target: string
src/api/resources/events/types/BaseEvent.ts:27
• topic: EventTopic
src/api/resources/events/types/BaseEvent.ts:10
• type: "upload:failed"
src/api/resources/events/types/Event.ts:79
@flatfile/api / Exports / Flatfile / events / Event / UploadStarted
-
↳
UploadStarted
- acknowledgedAt
- acknowledgedBy
- attributes
- callbackUrl
- context
- createdAt
- dataUrl
- deletedAt
- domain
- origin
- payload
- target
- topic
- type
• Optional
acknowledgedAt: string
Date the event was acknowledged
UploadStartedEvent.acknowledgedAt
src/api/resources/events/types/BaseEvent.ts:24
• Optional
acknowledgedBy: string
The actor (user or system) who acknowledged the event
UploadStartedEvent.acknowledgedBy
src/api/resources/events/types/BaseEvent.ts:26
• Optional
attributes: EventAttributes
The attributes of the event
src/api/resources/events/types/BaseEvent.ts:14
• Optional
callbackUrl: string
The callback url to acknowledge the event
UploadStartedEvent.callbackUrl
src/api/resources/events/types/BaseEvent.ts:16
• context: Context
The context of the event
src/api/resources/events/types/BaseEvent.ts:12
• createdAt: Date
Date the event was created
src/api/resources/events/types/BaseEvent.ts:20
• Optional
dataUrl: string
The url to retrieve the data associated with the event
src/api/resources/events/types/BaseEvent.ts:18
• Optional
deletedAt: Date
Date the event was deleted
src/api/resources/events/types/BaseEvent.ts:22
• domain: Domain
The domain of the event
src/api/resources/events/types/BaseEvent.ts:9
• Optional
origin: Origin
src/api/resources/events/types/BaseEvent.ts:28
• payload: Record
<string
, unknown
>
src/api/resources/events/types/UploadStartedEvent.ts:8
• Optional
target: string
src/api/resources/events/types/BaseEvent.ts:27
• topic: EventTopic
src/api/resources/events/types/BaseEvent.ts:10
• type: "upload:started"
src/api/resources/events/types/Event.ts:75
@flatfile/api / Exports / Flatfile / events / Event / UserAdded
-
↳
UserAdded
- acknowledgedAt
- acknowledgedBy
- attributes
- callbackUrl
- context
- createdAt
- dataUrl
- deletedAt
- domain
- origin
- payload
- target
- topic
- type
• Optional
acknowledgedAt: string
Date the event was acknowledged
src/api/resources/events/types/BaseEvent.ts:24
• Optional
acknowledgedBy: string
The actor (user or system) who acknowledged the event
src/api/resources/events/types/BaseEvent.ts:26
• Optional
attributes: EventAttributes
The attributes of the event
src/api/resources/events/types/BaseEvent.ts:14
• Optional
callbackUrl: string
The callback url to acknowledge the event
src/api/resources/events/types/BaseEvent.ts:16
• context: Context
The context of the event
src/api/resources/events/types/BaseEvent.ts:12
• createdAt: Date
Date the event was created
src/api/resources/events/types/BaseEvent.ts:20
• Optional
dataUrl: string
The url to retrieve the data associated with the event
src/api/resources/events/types/BaseEvent.ts:18
• Optional
deletedAt: Date
Date the event was deleted
src/api/resources/events/types/BaseEvent.ts:22
• domain: Domain
The domain of the event
src/api/resources/events/types/BaseEvent.ts:9
• Optional
origin: Origin
src/api/resources/events/types/BaseEvent.ts:28
• payload: Record
<string
, unknown
>
src/api/resources/events/types/UserAddedEvent.ts:8
• Optional
target: string
src/api/resources/events/types/BaseEvent.ts:27
• topic: EventTopic
src/api/resources/events/types/BaseEvent.ts:10
• type: "user:added"
src/api/resources/events/types/Event.ts:59
@flatfile/api / Exports / Flatfile / events / Event / UserOffline
-
↳
UserOffline
- acknowledgedAt
- acknowledgedBy
- attributes
- callbackUrl
- context
- createdAt
- dataUrl
- deletedAt
- domain
- origin
- payload
- target
- topic
- type
• Optional
acknowledgedAt: string
Date the event was acknowledged
UserOfflineEvent.acknowledgedAt
src/api/resources/events/types/BaseEvent.ts:24
• Optional
acknowledgedBy: string
The actor (user or system) who acknowledged the event
UserOfflineEvent.acknowledgedBy
src/api/resources/events/types/BaseEvent.ts:26
• Optional
attributes: EventAttributes
The attributes of the event
src/api/resources/events/types/BaseEvent.ts:14
• Optional
callbackUrl: string
The callback url to acknowledge the event
src/api/resources/events/types/BaseEvent.ts:16
• context: Context
The context of the event
src/api/resources/events/types/BaseEvent.ts:12
• createdAt: Date
Date the event was created
src/api/resources/events/types/BaseEvent.ts:20
• Optional
dataUrl: string
The url to retrieve the data associated with the event
src/api/resources/events/types/BaseEvent.ts:18
• Optional
deletedAt: Date
Date the event was deleted
src/api/resources/events/types/BaseEvent.ts:22
• domain: Domain
The domain of the event
src/api/resources/events/types/BaseEvent.ts:9
• Optional
origin: Origin
src/api/resources/events/types/BaseEvent.ts:28
• payload: Record
<string
, unknown
>
src/api/resources/events/types/UserOfflineEvent.ts:8
• Optional
target: string
src/api/resources/events/types/BaseEvent.ts:27
• topic: EventTopic
src/api/resources/events/types/BaseEvent.ts:10
• type: "user:offline"
src/api/resources/events/types/Event.ts:71
@flatfile/api / Exports / Flatfile / events / Event / UserOnline
-
↳
UserOnline
- acknowledgedAt
- acknowledgedBy
- attributes
- callbackUrl
- context
- createdAt
- dataUrl
- deletedAt
- domain
- origin
- payload
- target
- topic
- type
• Optional
acknowledgedAt: string
Date the event was acknowledged
UserOnlineEvent.acknowledgedAt
src/api/resources/events/types/BaseEvent.ts:24
• Optional
acknowledgedBy: string
The actor (user or system) who acknowledged the event
UserOnlineEvent.acknowledgedBy
src/api/resources/events/types/BaseEvent.ts:26
• Optional
attributes: EventAttributes
The attributes of the event
src/api/resources/events/types/BaseEvent.ts:14
• Optional
callbackUrl: string
The callback url to acknowledge the event
src/api/resources/events/types/BaseEvent.ts:16
• context: Context
The context of the event
src/api/resources/events/types/BaseEvent.ts:12
• createdAt: Date
Date the event was created
src/api/resources/events/types/BaseEvent.ts:20
• Optional
dataUrl: string
The url to retrieve the data associated with the event
src/api/resources/events/types/BaseEvent.ts:18
• Optional
deletedAt: Date
Date the event was deleted
src/api/resources/events/types/BaseEvent.ts:22
• domain: Domain
The domain of the event
src/api/resources/events/types/BaseEvent.ts:9
• Optional
origin: Origin
src/api/resources/events/types/BaseEvent.ts:28
• payload: Record
<string
, unknown
>
src/api/resources/events/types/UserOnlineEvent.ts:8
• Optional
target: string
src/api/resources/events/types/BaseEvent.ts:27
• topic: EventTopic
src/api/resources/events/types/BaseEvent.ts:10
• type: "user:online"
src/api/resources/events/types/Event.ts:67
@flatfile/api / Exports / Flatfile / events / Event / UserRemoved
-
↳
UserRemoved
- acknowledgedAt
- acknowledgedBy
- attributes
- callbackUrl
- context
- createdAt
- dataUrl
- deletedAt
- domain
- origin
- payload
- target
- topic
- type
• Optional
acknowledgedAt: string
Date the event was acknowledged
UserRemovedEvent.acknowledgedAt
src/api/resources/events/types/BaseEvent.ts:24
• Optional
acknowledgedBy: string
The actor (user or system) who acknowledged the event
UserRemovedEvent.acknowledgedBy
src/api/resources/events/types/BaseEvent.ts:26
• Optional
attributes: EventAttributes
The attributes of the event
src/api/resources/events/types/BaseEvent.ts:14
• Optional
callbackUrl: string
The callback url to acknowledge the event
src/api/resources/events/types/BaseEvent.ts:16
• context: Context
The context of the event
src/api/resources/events/types/BaseEvent.ts:12
• createdAt: Date
Date the event was created
src/api/resources/events/types/BaseEvent.ts:20
• Optional
dataUrl: string
The url to retrieve the data associated with the event
src/api/resources/events/types/BaseEvent.ts:18
• Optional
deletedAt: Date
Date the event was deleted
src/api/resources/events/types/BaseEvent.ts:22
• domain: Domain
The domain of the event
src/api/resources/events/types/BaseEvent.ts:9
• Optional
origin: Origin
src/api/resources/events/types/BaseEvent.ts:28
• payload: Record
<string
, unknown
>
src/api/resources/events/types/UserRemovedEvent.ts:8
• Optional
target: string
src/api/resources/events/types/BaseEvent.ts:27
• topic: EventTopic
src/api/resources/events/types/BaseEvent.ts:10
• type: "user:removed"
src/api/resources/events/types/Event.ts:63
@flatfile/api / Exports / Flatfile / events / Event / WorkbookAdded
-
↳
WorkbookAdded
- acknowledgedAt
- acknowledgedBy
- attributes
- callbackUrl
- context
- createdAt
- dataUrl
- deletedAt
- domain
- origin
- payload
- target
- topic
- type
• Optional
acknowledgedAt: string
Date the event was acknowledged
WorkbookAddedEvent.acknowledgedAt
src/api/resources/events/types/BaseEvent.ts:24
• Optional
acknowledgedBy: string
The actor (user or system) who acknowledged the event
WorkbookAddedEvent.acknowledgedBy
src/api/resources/events/types/BaseEvent.ts:26
• Optional
attributes: EventAttributes
The attributes of the event
src/api/resources/events/types/BaseEvent.ts:14
• Optional
callbackUrl: string
The callback url to acknowledge the event
WorkbookAddedEvent.callbackUrl
src/api/resources/events/types/BaseEvent.ts:16
• context: Context
The context of the event
src/api/resources/events/types/BaseEvent.ts:12
• createdAt: Date
Date the event was created
src/api/resources/events/types/BaseEvent.ts:20
• Optional
dataUrl: string
The url to retrieve the data associated with the event
src/api/resources/events/types/BaseEvent.ts:18
• Optional
deletedAt: Date
Date the event was deleted
src/api/resources/events/types/BaseEvent.ts:22
• domain: Domain
The domain of the event
src/api/resources/events/types/BaseEvent.ts:9
• Optional
origin: Origin
src/api/resources/events/types/BaseEvent.ts:28
• payload: Record
<string
, unknown
>
src/api/resources/events/types/WorkbookAddedEvent.ts:8
• Optional
target: string
src/api/resources/events/types/BaseEvent.ts:27
• topic: EventTopic
src/api/resources/events/types/BaseEvent.ts:10
• type: "workbook:added"
src/api/resources/events/types/Event.ts:47
@flatfile/api / Exports / Flatfile / events / Event / WorkbookRemoved
-
↳
WorkbookRemoved
- acknowledgedAt
- acknowledgedBy
- attributes
- callbackUrl
- context
- createdAt
- dataUrl
- deletedAt
- domain
- origin
- payload
- target
- topic
- type
• Optional
acknowledgedAt: string
Date the event was acknowledged
WorkbookRemovedEvent.acknowledgedAt
src/api/resources/events/types/BaseEvent.ts:24
• Optional
acknowledgedBy: string
The actor (user or system) who acknowledged the event
WorkbookRemovedEvent.acknowledgedBy
src/api/resources/events/types/BaseEvent.ts:26
• Optional
attributes: EventAttributes
The attributes of the event
WorkbookRemovedEvent.attributes
src/api/resources/events/types/BaseEvent.ts:14
• Optional
callbackUrl: string
The callback url to acknowledge the event
WorkbookRemovedEvent.callbackUrl
src/api/resources/events/types/BaseEvent.ts:16
• context: Context
The context of the event
src/api/resources/events/types/BaseEvent.ts:12
• createdAt: Date
Date the event was created
WorkbookRemovedEvent.createdAt
src/api/resources/events/types/BaseEvent.ts:20
• Optional
dataUrl: string
The url to retrieve the data associated with the event
src/api/resources/events/types/BaseEvent.ts:18
• Optional
deletedAt: Date
Date the event was deleted
WorkbookRemovedEvent.deletedAt
src/api/resources/events/types/BaseEvent.ts:22
• domain: Domain
The domain of the event
src/api/resources/events/types/BaseEvent.ts:9
• Optional
origin: Origin
src/api/resources/events/types/BaseEvent.ts:28
• payload: Record
<string
, unknown
>
src/api/resources/events/types/WorkbookRemovedEvent.ts:8
• Optional
target: string
src/api/resources/events/types/BaseEvent.ts:27
• topic: EventTopic
src/api/resources/events/types/BaseEvent.ts:10
• type: "workbook:removed"
src/api/resources/events/types/Event.ts:55
@flatfile/api / Exports / Flatfile / events / Event / WorkbookUpdated
-
↳
WorkbookUpdated
- acknowledgedAt
- acknowledgedBy
- attributes
- callbackUrl
- context
- createdAt
- dataUrl
- deletedAt
- domain
- origin
- payload
- target
- topic
- type
• Optional
acknowledgedAt: string
Date the event was acknowledged
WorkbookUpdatedEvent.acknowledgedAt
src/api/resources/events/types/BaseEvent.ts:24
• Optional
acknowledgedBy: string
The actor (user or system) who acknowledged the event
WorkbookUpdatedEvent.acknowledgedBy
src/api/resources/events/types/BaseEvent.ts:26
• Optional
attributes: EventAttributes
The attributes of the event
WorkbookUpdatedEvent.attributes
src/api/resources/events/types/BaseEvent.ts:14
• Optional
callbackUrl: string
The callback url to acknowledge the event
WorkbookUpdatedEvent.callbackUrl
src/api/resources/events/types/BaseEvent.ts:16
• context: Context
The context of the event
src/api/resources/events/types/BaseEvent.ts:12
• createdAt: Date
Date the event was created
WorkbookUpdatedEvent.createdAt
src/api/resources/events/types/BaseEvent.ts:20
• Optional
dataUrl: string
The url to retrieve the data associated with the event
src/api/resources/events/types/BaseEvent.ts:18
• Optional
deletedAt: Date
Date the event was deleted
WorkbookUpdatedEvent.deletedAt
src/api/resources/events/types/BaseEvent.ts:22
• domain: Domain
The domain of the event
src/api/resources/events/types/BaseEvent.ts:9
• Optional
origin: Origin
src/api/resources/events/types/BaseEvent.ts:28
• payload: Record
<string
, unknown
>
src/api/resources/events/types/WorkbookUpdatedEvent.ts:8
• Optional
target: string
src/api/resources/events/types/BaseEvent.ts:27
• topic: EventTopic
src/api/resources/events/types/BaseEvent.ts:10
• type: "workbook:updated"
src/api/resources/events/types/Event.ts:51
@flatfile/api / Exports / Flatfile / events / EventAttributes
Flatfile.events.EventAttributes
The attributes of the event
• Optional
progress: Progress
The progress of the event within a collection of iterable events
src/api/resources/events/types/EventAttributes.ts:14
• Optional
targetUpdatedAt: Date
Date the related entity was last updated
src/api/resources/events/types/EventAttributes.ts:12
@flatfile/api / Exports / Flatfile / events / EventResponse
• data: Event
src/api/resources/events/types/EventResponse.ts:8
@flatfile/api / Exports / Flatfile / events / FileDeletedEvent
Flatfile.events.FileDeletedEvent
-
↳
FileDeletedEvent
↳↳
FileDeleted
- acknowledgedAt
- acknowledgedBy
- attributes
- callbackUrl
- context
- createdAt
- dataUrl
- deletedAt
- domain
- origin
- payload
- target
- topic
• Optional
acknowledgedAt: string
Date the event was acknowledged
src/api/resources/events/types/BaseEvent.ts:24
• Optional
acknowledgedBy: string
The actor (user or system) who acknowledged the event
src/api/resources/events/types/BaseEvent.ts:26
• Optional
attributes: EventAttributes
The attributes of the event
src/api/resources/events/types/BaseEvent.ts:14
• Optional
callbackUrl: string
The callback url to acknowledge the event
src/api/resources/events/types/BaseEvent.ts:16
• context: Context
The context of the event
src/api/resources/events/types/BaseEvent.ts:12
• createdAt: Date
Date the event was created
src/api/resources/events/types/BaseEvent.ts:20
• Optional
dataUrl: string
The url to retrieve the data associated with the event
src/api/resources/events/types/BaseEvent.ts:18
• Optional
deletedAt: Date
Date the event was deleted
src/api/resources/events/types/BaseEvent.ts:22
• domain: Domain
The domain of the event
src/api/resources/events/types/BaseEvent.ts:9
• Optional
origin: Origin
src/api/resources/events/types/BaseEvent.ts:28
• payload: Record
<string
, unknown
>
src/api/resources/events/types/FileDeletedEvent.ts:8
• Optional
target: string
src/api/resources/events/types/BaseEvent.ts:27
• topic: EventTopic
src/api/resources/events/types/BaseEvent.ts:10
@flatfile/api / Exports / Flatfile / events / GetEventTokenRequest
Flatfile.events.GetEventTokenRequest
• Optional
scope: string
The scope of the event stream (space or environment id)
src/api/resources/events/client/requests/GetEventTokenRequest.ts:15
• Optional
spaceId: string
The space id
src/api/resources/events/client/requests/GetEventTokenRequest.ts:11
@flatfile/api / Exports / Flatfile / events / JobCompletedEvent
Flatfile.events.JobCompletedEvent
-
↳
JobCompletedEvent
↳↳
JobCompleted
- acknowledgedAt
- acknowledgedBy
- attributes
- callbackUrl
- context
- createdAt
- dataUrl
- deletedAt
- domain
- origin
- payload
- target
- topic
• Optional
acknowledgedAt: string
Date the event was acknowledged
src/api/resources/events/types/BaseEvent.ts:24
• Optional
acknowledgedBy: string
The actor (user or system) who acknowledged the event
src/api/resources/events/types/BaseEvent.ts:26
• Optional
attributes: EventAttributes
The attributes of the event
src/api/resources/events/types/BaseEvent.ts:14
• Optional
callbackUrl: string
The callback url to acknowledge the event
src/api/resources/events/types/BaseEvent.ts:16
• context: Context
The context of the event
src/api/resources/events/types/BaseEvent.ts:12
• createdAt: Date
Date the event was created
src/api/resources/events/types/BaseEvent.ts:20
• Optional
dataUrl: string
The url to retrieve the data associated with the event
src/api/resources/events/types/BaseEvent.ts:18
• Optional
deletedAt: Date
Date the event was deleted
src/api/resources/events/types/BaseEvent.ts:22
• domain: Domain
The domain of the event
src/api/resources/events/types/BaseEvent.ts:9
• Optional
origin: Origin
src/api/resources/events/types/BaseEvent.ts:28
• payload: JobPayload
src/api/resources/events/types/JobCompletedEvent.ts:8
• Optional
target: string
src/api/resources/events/types/BaseEvent.ts:27
• topic: EventTopic
src/api/resources/events/types/BaseEvent.ts:10
@flatfile/api / Exports / Flatfile / events / JobDeletedEvent
Flatfile.events.JobDeletedEvent
-
↳
JobDeletedEvent
↳↳
JobDeleted
- acknowledgedAt
- acknowledgedBy
- attributes
- callbackUrl
- context
- createdAt
- dataUrl
- deletedAt
- domain
- origin
- payload
- target
- topic
• Optional
acknowledgedAt: string
Date the event was acknowledged
src/api/resources/events/types/BaseEvent.ts:24
• Optional
acknowledgedBy: string
The actor (user or system) who acknowledged the event
src/api/resources/events/types/BaseEvent.ts:26
• Optional
attributes: EventAttributes
The attributes of the event
src/api/resources/events/types/BaseEvent.ts:14
• Optional
callbackUrl: string
The callback url to acknowledge the event
src/api/resources/events/types/BaseEvent.ts:16
• context: Context
The context of the event
src/api/resources/events/types/BaseEvent.ts:12
• createdAt: Date
Date the event was created
src/api/resources/events/types/BaseEvent.ts:20
• Optional
dataUrl: string
The url to retrieve the data associated with the event
src/api/resources/events/types/BaseEvent.ts:18
• Optional
deletedAt: Date
Date the event was deleted
src/api/resources/events/types/BaseEvent.ts:22
• domain: Domain
The domain of the event
src/api/resources/events/types/BaseEvent.ts:9
• Optional
origin: Origin
src/api/resources/events/types/BaseEvent.ts:28
• payload: Record
<string
, unknown
>
src/api/resources/events/types/JobDeletedEvent.ts:8
• Optional
target: string
src/api/resources/events/types/BaseEvent.ts:27
• topic: EventTopic
src/api/resources/events/types/BaseEvent.ts:10
@flatfile/api / Exports / Flatfile / events / JobFailedEvent
Flatfile.events.JobFailedEvent
- acknowledgedAt
- acknowledgedBy
- attributes
- callbackUrl
- context
- createdAt
- dataUrl
- deletedAt
- domain
- origin
- payload
- target
- topic
• Optional
acknowledgedAt: string
Date the event was acknowledged
src/api/resources/events/types/BaseEvent.ts:24
• Optional
acknowledgedBy: string
The actor (user or system) who acknowledged the event
src/api/resources/events/types/BaseEvent.ts:26
• Optional
attributes: EventAttributes
The attributes of the event
src/api/resources/events/types/BaseEvent.ts:14
• Optional
callbackUrl: string
The callback url to acknowledge the event
src/api/resources/events/types/BaseEvent.ts:16
• context: Context
The context of the event
src/api/resources/events/types/BaseEvent.ts:12
• createdAt: Date
Date the event was created
src/api/resources/events/types/BaseEvent.ts:20
• Optional
dataUrl: string
The url to retrieve the data associated with the event
src/api/resources/events/types/BaseEvent.ts:18
• Optional
deletedAt: Date
Date the event was deleted
src/api/resources/events/types/BaseEvent.ts:22
• domain: Domain
The domain of the event
src/api/resources/events/types/BaseEvent.ts:9
• Optional
origin: Origin
src/api/resources/events/types/BaseEvent.ts:28
• payload: JobFailedPayload
src/api/resources/events/types/JobFailedEvent.ts:8
• Optional
target: string
src/api/resources/events/types/BaseEvent.ts:27
• topic: EventTopic
src/api/resources/events/types/BaseEvent.ts:10
@flatfile/api / Exports / Flatfile / events / JobFailedPayload
Flatfile.events.JobFailedPayload
-
↳
JobFailedPayload
• err: string
src/api/resources/events/types/JobFailedPayload.ts:8
• operation: JobOperationType
src/api/resources/events/types/JobPayload.ts:9
• type: JobPayloadType
src/api/resources/events/types/JobPayload.ts:8
@flatfile/api / Exports / Flatfile / events / JobPayload
-
JobPayload
• operation: JobOperationType
src/api/resources/events/types/JobPayload.ts:9
• type: JobPayloadType
src/api/resources/events/types/JobPayload.ts:8
@flatfile/api / Exports / Flatfile / events / JobStartedEvent
Flatfile.events.JobStartedEvent
-
↳
JobStartedEvent
↳↳
JobStarted
- acknowledgedAt
- acknowledgedBy
- attributes
- callbackUrl
- context
- createdAt
- dataUrl
- deletedAt
- domain
- origin
- payload
- target
- topic
• Optional
acknowledgedAt: string
Date the event was acknowledged
src/api/resources/events/types/BaseEvent.ts:24
• Optional
acknowledgedBy: string
The actor (user or system) who acknowledged the event
src/api/resources/events/types/BaseEvent.ts:26
• Optional
attributes: EventAttributes
The attributes of the event
src/api/resources/events/types/BaseEvent.ts:14
• Optional
callbackUrl: string
The callback url to acknowledge the event
src/api/resources/events/types/BaseEvent.ts:16
• context: Context
The context of the event
src/api/resources/events/types/BaseEvent.ts:12
• createdAt: Date
Date the event was created
src/api/resources/events/types/BaseEvent.ts:20
• Optional
dataUrl: string
The url to retrieve the data associated with the event
src/api/resources/events/types/BaseEvent.ts:18
• Optional
deletedAt: Date
Date the event was deleted
src/api/resources/events/types/BaseEvent.ts:22
• domain: Domain
The domain of the event
src/api/resources/events/types/BaseEvent.ts:9
• Optional
origin: Origin
src/api/resources/events/types/BaseEvent.ts:28
• payload: JobPayload
src/api/resources/events/types/JobStartedEvent.ts:8
• Optional
target: string
src/api/resources/events/types/BaseEvent.ts:27
• topic: EventTopic
src/api/resources/events/types/BaseEvent.ts:10
@flatfile/api / Exports / Flatfile / events / JobUpdatedEvent
Flatfile.events.JobUpdatedEvent
-
↳
JobUpdatedEvent
↳↳
JobUpdated
- acknowledgedAt
- acknowledgedBy
- attributes
- callbackUrl
- context
- createdAt
- dataUrl
- deletedAt
- domain
- origin
- payload
- target
- topic
• Optional
acknowledgedAt: string
Date the event was acknowledged
src/api/resources/events/types/BaseEvent.ts:24
• Optional
acknowledgedBy: string
The actor (user or system) who acknowledged the event
src/api/resources/events/types/BaseEvent.ts:26
• Optional
attributes: EventAttributes
The attributes of the event
src/api/resources/events/types/BaseEvent.ts:14
• Optional
callbackUrl: string
The callback url to acknowledge the event
src/api/resources/events/types/BaseEvent.ts:16
• context: Context
The context of the event
src/api/resources/events/types/BaseEvent.ts:12
• createdAt: Date
Date the event was created
src/api/resources/events/types/BaseEvent.ts:20
• Optional
dataUrl: string
The url to retrieve the data associated with the event
src/api/resources/events/types/BaseEvent.ts:18
• Optional
deletedAt: Date
Date the event was deleted
src/api/resources/events/types/BaseEvent.ts:22
• domain: Domain
The domain of the event
src/api/resources/events/types/BaseEvent.ts:9
• Optional
origin: Origin
src/api/resources/events/types/BaseEvent.ts:28
• payload: JobPayload
src/api/resources/events/types/JobUpdatedEvent.ts:8
• Optional
target: string
src/api/resources/events/types/BaseEvent.ts:27
• topic: EventTopic
src/api/resources/events/types/BaseEvent.ts:10
@flatfile/api / Exports / Flatfile / events / JobWaitingEvent
Flatfile.events.JobWaitingEvent
-
↳
JobWaitingEvent
↳↳
JobWaiting
- acknowledgedAt
- acknowledgedBy
- attributes
- callbackUrl
- context
- createdAt
- dataUrl
- deletedAt
- domain
- origin
- payload
- target
- topic
• Optional
acknowledgedAt: string
Date the event was acknowledged
src/api/resources/events/types/BaseEvent.ts:24
• Optional
acknowledgedBy: string
The actor (user or system) who acknowledged the event
src/api/resources/events/types/BaseEvent.ts:26
• Optional
attributes: EventAttributes
The attributes of the event
src/api/resources/events/types/BaseEvent.ts:14
• Optional
callbackUrl: string
The callback url to acknowledge the event
src/api/resources/events/types/BaseEvent.ts:16
• context: Context
The context of the event
src/api/resources/events/types/BaseEvent.ts:12
• createdAt: Date
Date the event was created
src/api/resources/events/types/BaseEvent.ts:20
• Optional
dataUrl: string
The url to retrieve the data associated with the event
src/api/resources/events/types/BaseEvent.ts:18
• Optional
deletedAt: Date
Date the event was deleted
src/api/resources/events/types/BaseEvent.ts:22
• domain: Domain
The domain of the event
src/api/resources/events/types/BaseEvent.ts:9
• Optional
origin: Origin
src/api/resources/events/types/BaseEvent.ts:28
• payload: Record
<string
, unknown
>
src/api/resources/events/types/JobWaitingEvent.ts:8
• Optional
target: string
src/api/resources/events/types/BaseEvent.ts:27
• topic: EventTopic
src/api/resources/events/types/BaseEvent.ts:10
@flatfile/api / Exports / Flatfile / events / ListAllEventsResponse
Flatfile.events.ListAllEventsResponse
• data: Event
[]
src/api/resources/events/types/ListAllEventsResponse.ts:8
@flatfile/api / Exports / Flatfile / events / ListEventsRequest
Flatfile.events.ListEventsRequest
• Optional
domain: string
Filter by event domain
src/api/resources/events/client/requests/ListEventsRequest.ts:13
• environmentId: string
src/api/resources/events/client/requests/ListEventsRequest.ts:8
• Optional
includeAcknowledged: boolean
Include acknowledged events
src/api/resources/events/client/requests/ListEventsRequest.ts:33
• Optional
pageNumber: number
Based on pageSize, which page of records to return
src/api/resources/events/client/requests/ListEventsRequest.ts:29
• Optional
pageSize: number
Number of tokens to return in a page (default 10)
src/api/resources/events/client/requests/ListEventsRequest.ts:25
• Optional
since: string
Filter by event timestamp
src/api/resources/events/client/requests/ListEventsRequest.ts:21
• Optional
spaceId: string
src/api/resources/events/client/requests/ListEventsRequest.ts:9
• Optional
topic: string
Filter by event topic
src/api/resources/events/client/requests/ListEventsRequest.ts:17
@flatfile/api / Exports / Flatfile / events / Origin
The origin resource of the event
• Optional
id: string
src/api/resources/events/types/Origin.ts:9
• Optional
slug: string
src/api/resources/events/types/Origin.ts:10
@flatfile/api / Exports / Flatfile / events / Progress
The progress of the event within a collection of iterable events
• Optional
current: number
The current progress of the event
src/api/resources/events/types/Progress.ts:10
• Optional
percent: number
The percent complete of the event group
src/api/resources/events/types/Progress.ts:14
• Optional
total: number
The total number of events in this group
src/api/resources/events/types/Progress.ts:12
@flatfile/api / Exports / Flatfile / events / RecordsCreatedEvent
Flatfile.events.RecordsCreatedEvent
-
↳
RecordsCreatedEvent
- acknowledgedAt
- acknowledgedBy
- attributes
- callbackUrl
- context
- createdAt
- dataUrl
- deletedAt
- domain
- origin
- payload
- target
- topic
• Optional
acknowledgedAt: string
Date the event was acknowledged
src/api/resources/events/types/BaseEvent.ts:24
• Optional
acknowledgedBy: string
The actor (user or system) who acknowledged the event
src/api/resources/events/types/BaseEvent.ts:26
• Optional
attributes: EventAttributes
The attributes of the event
src/api/resources/events/types/BaseEvent.ts:14
• Optional
callbackUrl: string
The callback url to acknowledge the event
src/api/resources/events/types/BaseEvent.ts:16
• context: Context
The context of the event
src/api/resources/events/types/BaseEvent.ts:12
• createdAt: Date
Date the event was created
src/api/resources/events/types/BaseEvent.ts:20
• Optional
dataUrl: string
The url to retrieve the data associated with the event
src/api/resources/events/types/BaseEvent.ts:18
• Optional
deletedAt: Date
Date the event was deleted
src/api/resources/events/types/BaseEvent.ts:22
• domain: Domain
The domain of the event
src/api/resources/events/types/BaseEvent.ts:9
• Optional
origin: Origin
src/api/resources/events/types/BaseEvent.ts:28
• payload: RecordsPayload
src/api/resources/events/types/RecordsCreatedEvent.ts:8
• Optional
target: string
src/api/resources/events/types/BaseEvent.ts:27
• topic: EventTopic
src/api/resources/events/types/BaseEvent.ts:10
@flatfile/api / Exports / Flatfile / events / RecordsDeletedEvent
Flatfile.events.RecordsDeletedEvent
-
↳
RecordsDeletedEvent
- acknowledgedAt
- acknowledgedBy
- attributes
- callbackUrl
- context
- createdAt
- dataUrl
- deletedAt
- domain
- origin
- payload
- target
- topic
• Optional
acknowledgedAt: string
Date the event was acknowledged
src/api/resources/events/types/BaseEvent.ts:24
• Optional
acknowledgedBy: string
The actor (user or system) who acknowledged the event
src/api/resources/events/types/BaseEvent.ts:26
• Optional
attributes: EventAttributes
The attributes of the event
src/api/resources/events/types/BaseEvent.ts:14
• Optional
callbackUrl: string
The callback url to acknowledge the event
src/api/resources/events/types/BaseEvent.ts:16
• context: Context
The context of the event
src/api/resources/events/types/BaseEvent.ts:12
• createdAt: Date
Date the event was created
src/api/resources/events/types/BaseEvent.ts:20
• Optional
dataUrl: string
The url to retrieve the data associated with the event
src/api/resources/events/types/BaseEvent.ts:18
• Optional
deletedAt: Date
Date the event was deleted
src/api/resources/events/types/BaseEvent.ts:22
• domain: Domain
The domain of the event
src/api/resources/events/types/BaseEvent.ts:9
• Optional
origin: Origin
src/api/resources/events/types/BaseEvent.ts:28
• payload: Record
<string
, unknown
>
src/api/resources/events/types/RecordsDeletedEvent.ts:8
• Optional
target: string
src/api/resources/events/types/BaseEvent.ts:27
• topic: EventTopic
src/api/resources/events/types/BaseEvent.ts:10
@flatfile/api / Exports / Flatfile / events / RecordsPayload
Flatfile.events.RecordsPayload
This file was auto-generated by Fern from our API Definition.
• count: number
src/api/resources/events/types/RecordsPayload.ts:6
@flatfile/api / Exports / Flatfile / events / RecordsUpdatedEvent
Flatfile.events.RecordsUpdatedEvent
-
↳
RecordsUpdatedEvent
- acknowledgedAt
- acknowledgedBy
- attributes
- callbackUrl
- context
- createdAt
- dataUrl
- deletedAt
- domain
- origin
- payload
- target
- topic
• Optional
acknowledgedAt: string
Date the event was acknowledged
src/api/resources/events/types/BaseEvent.ts:24
• Optional
acknowledgedBy: string
The actor (user or system) who acknowledged the event
src/api/resources/events/types/BaseEvent.ts:26
• Optional
attributes: EventAttributes
The attributes of the event
src/api/resources/events/types/BaseEvent.ts:14
• Optional
callbackUrl: string
The callback url to acknowledge the event
src/api/resources/events/types/BaseEvent.ts:16
• context: Context
The context of the event
src/api/resources/events/types/BaseEvent.ts:12
• createdAt: Date
Date the event was created
src/api/resources/events/types/BaseEvent.ts:20
• Optional
dataUrl: string
The url to retrieve the data associated with the event
src/api/resources/events/types/BaseEvent.ts:18
• Optional
deletedAt: Date
Date the event was deleted
src/api/resources/events/types/BaseEvent.ts:22
• domain: Domain
The domain of the event
src/api/resources/events/types/BaseEvent.ts:9
• Optional
origin: Origin
src/api/resources/events/types/BaseEvent.ts:28
• payload: RecordsPayload
src/api/resources/events/types/RecordsUpdatedEvent.ts:8
• Optional
target: string
src/api/resources/events/types/BaseEvent.ts:27
• topic: EventTopic
src/api/resources/events/types/BaseEvent.ts:10
@flatfile/api / Exports / Flatfile / events / SheetValidatedEvent
Flatfile.events.SheetValidatedEvent
-
↳
SheetValidatedEvent
- acknowledgedAt
- acknowledgedBy
- attributes
- callbackUrl
- context
- createdAt
- dataUrl
- deletedAt
- domain
- origin
- payload
- target
- topic
• Optional
acknowledgedAt: string
Date the event was acknowledged
src/api/resources/events/types/BaseEvent.ts:24
• Optional
acknowledgedBy: string
The actor (user or system) who acknowledged the event
src/api/resources/events/types/BaseEvent.ts:26
• Optional
attributes: EventAttributes
The attributes of the event
src/api/resources/events/types/BaseEvent.ts:14
• Optional
callbackUrl: string
The callback url to acknowledge the event
src/api/resources/events/types/BaseEvent.ts:16
• context: Context
The context of the event
src/api/resources/events/types/BaseEvent.ts:12
• createdAt: Date
Date the event was created
src/api/resources/events/types/BaseEvent.ts:20
• Optional
dataUrl: string
The url to retrieve the data associated with the event
src/api/resources/events/types/BaseEvent.ts:18
• Optional
deletedAt: Date
Date the event was deleted
src/api/resources/events/types/BaseEvent.ts:22
• domain: Domain
The domain of the event
src/api/resources/events/types/BaseEvent.ts:9
• Optional
origin: Origin
src/api/resources/events/types/BaseEvent.ts:28
• payload: Record
<string
, unknown
>
src/api/resources/events/types/SheetValidatedEvent.ts:8
• Optional
target: string
src/api/resources/events/types/BaseEvent.ts:27
• topic: EventTopic
src/api/resources/events/types/BaseEvent.ts:10
@flatfile/api / Exports / Flatfile / events / SpaceAddedEvent
Flatfile.events.SpaceAddedEvent
-
↳
SpaceAddedEvent
↳↳
SpaceAdded
- acknowledgedAt
- acknowledgedBy
- attributes
- callbackUrl
- context
- createdAt
- dataUrl
- deletedAt
- domain
- origin
- payload
- target
- topic
• Optional
acknowledgedAt: string
Date the event was acknowledged
src/api/resources/events/types/BaseEvent.ts:24
• Optional
acknowledgedBy: string
The actor (user or system) who acknowledged the event
src/api/resources/events/types/BaseEvent.ts:26
• Optional
attributes: EventAttributes
The attributes of the event
src/api/resources/events/types/BaseEvent.ts:14
• Optional
callbackUrl: string
The callback url to acknowledge the event
src/api/resources/events/types/BaseEvent.ts:16
• context: Context
The context of the event
src/api/resources/events/types/BaseEvent.ts:12
• createdAt: Date
Date the event was created
src/api/resources/events/types/BaseEvent.ts:20
• Optional
dataUrl: string
The url to retrieve the data associated with the event
src/api/resources/events/types/BaseEvent.ts:18
• Optional
deletedAt: Date
Date the event was deleted
src/api/resources/events/types/BaseEvent.ts:22
• domain: Domain
The domain of the event
src/api/resources/events/types/BaseEvent.ts:9
• Optional
origin: Origin
src/api/resources/events/types/BaseEvent.ts:28
• payload: Record
<string
, unknown
>
src/api/resources/events/types/SpaceAddedEvent.ts:8
• Optional
target: string
src/api/resources/events/types/BaseEvent.ts:27
• topic: EventTopic
src/api/resources/events/types/BaseEvent.ts:10
@flatfile/api / Exports / Flatfile / events / SpaceRemovedEvent
Flatfile.events.SpaceRemovedEvent
-
↳
SpaceRemovedEvent
↳↳
SpaceRemoved
- acknowledgedAt
- acknowledgedBy
- attributes
- callbackUrl
- context
- createdAt
- dataUrl
- deletedAt
- domain
- origin
- payload
- target
- topic
• Optional
acknowledgedAt: string
Date the event was acknowledged
src/api/resources/events/types/BaseEvent.ts:24
• Optional
acknowledgedBy: string
The actor (user or system) who acknowledged the event
src/api/resources/events/types/BaseEvent.ts:26
• Optional
attributes: EventAttributes
The attributes of the event
src/api/resources/events/types/BaseEvent.ts:14
• Optional
callbackUrl: string
The callback url to acknowledge the event
src/api/resources/events/types/BaseEvent.ts:16
• context: Context
The context of the event
src/api/resources/events/types/BaseEvent.ts:12
• createdAt: Date
Date the event was created
src/api/resources/events/types/BaseEvent.ts:20
• Optional
dataUrl: string
The url to retrieve the data associated with the event
src/api/resources/events/types/BaseEvent.ts:18
• Optional
deletedAt: Date
Date the event was deleted
src/api/resources/events/types/BaseEvent.ts:22
• domain: Domain
The domain of the event
src/api/resources/events/types/BaseEvent.ts:9
• Optional
origin: Origin
src/api/resources/events/types/BaseEvent.ts:28
• payload: Record
<string
, unknown
>
src/api/resources/events/types/SpaceRemovedEvent.ts:8
• Optional
target: string
src/api/resources/events/types/BaseEvent.ts:27
• topic: EventTopic
src/api/resources/events/types/BaseEvent.ts:10
@flatfile/api / Exports / Flatfile / events / UploadCompletedEvent
Flatfile.events.UploadCompletedEvent
-
↳
UploadCompletedEvent
- acknowledgedAt
- acknowledgedBy
- attributes
- callbackUrl
- context
- createdAt
- dataUrl
- deletedAt
- domain
- origin
- payload
- target
- topic
• Optional
acknowledgedAt: string
Date the event was acknowledged
src/api/resources/events/types/BaseEvent.ts:24
• Optional
acknowledgedBy: string
The actor (user or system) who acknowledged the event
src/api/resources/events/types/BaseEvent.ts:26
• Optional
attributes: EventAttributes
The attributes of the event
src/api/resources/events/types/BaseEvent.ts:14
• Optional
callbackUrl: string
The callback url to acknowledge the event
src/api/resources/events/types/BaseEvent.ts:16
• context: Context
The context of the event
src/api/resources/events/types/BaseEvent.ts:12
• createdAt: Date
Date the event was created
src/api/resources/events/types/BaseEvent.ts:20
• Optional
dataUrl: string
The url to retrieve the data associated with the event
src/api/resources/events/types/BaseEvent.ts:18
• Optional
deletedAt: Date
Date the event was deleted
src/api/resources/events/types/BaseEvent.ts:22
• domain: Domain
The domain of the event
src/api/resources/events/types/BaseEvent.ts:9
• Optional
origin: Origin
src/api/resources/events/types/BaseEvent.ts:28
• payload: Record
<string
, unknown
>
src/api/resources/events/types/UploadCompletedEvent.ts:8
• Optional
target: string
src/api/resources/events/types/BaseEvent.ts:27
• topic: EventTopic
src/api/resources/events/types/BaseEvent.ts:10
@flatfile/api / Exports / Flatfile / events / UploadFailedEvent
Flatfile.events.UploadFailedEvent
-
↳
UploadFailedEvent
↳↳
UploadFailed
- acknowledgedAt
- acknowledgedBy
- attributes
- callbackUrl
- context
- createdAt
- dataUrl
- deletedAt
- domain
- origin
- payload
- target
- topic
• Optional
acknowledgedAt: string
Date the event was acknowledged
src/api/resources/events/types/BaseEvent.ts:24
• Optional
acknowledgedBy: string
The actor (user or system) who acknowledged the event
src/api/resources/events/types/BaseEvent.ts:26
• Optional
attributes: EventAttributes
The attributes of the event
src/api/resources/events/types/BaseEvent.ts:14
• Optional
callbackUrl: string
The callback url to acknowledge the event
src/api/resources/events/types/BaseEvent.ts:16
• context: Context
The context of the event
src/api/resources/events/types/BaseEvent.ts:12
• createdAt: Date
Date the event was created
src/api/resources/events/types/BaseEvent.ts:20
• Optional
dataUrl: string
The url to retrieve the data associated with the event
src/api/resources/events/types/BaseEvent.ts:18
• Optional
deletedAt: Date
Date the event was deleted
src/api/resources/events/types/BaseEvent.ts:22
• domain: Domain
The domain of the event
src/api/resources/events/types/BaseEvent.ts:9
• Optional
origin: Origin
src/api/resources/events/types/BaseEvent.ts:28
• payload: Record
<string
, unknown
>
src/api/resources/events/types/UploadFailedEvent.ts:8
• Optional
target: string
src/api/resources/events/types/BaseEvent.ts:27
• topic: EventTopic
src/api/resources/events/types/BaseEvent.ts:10
@flatfile/api / Exports / Flatfile / events / UploadStartedEvent
Flatfile.events.UploadStartedEvent
-
↳
UploadStartedEvent
- acknowledgedAt
- acknowledgedBy
- attributes
- callbackUrl
- context
- createdAt
- dataUrl
- deletedAt
- domain
- origin
- payload
- target
- topic
• Optional
acknowledgedAt: string
Date the event was acknowledged
src/api/resources/events/types/BaseEvent.ts:24
• Optional
acknowledgedBy: string
The actor (user or system) who acknowledged the event
src/api/resources/events/types/BaseEvent.ts:26
• Optional
attributes: EventAttributes
The attributes of the event
src/api/resources/events/types/BaseEvent.ts:14
• Optional
callbackUrl: string
The callback url to acknowledge the event
src/api/resources/events/types/BaseEvent.ts:16
• context: Context
The context of the event
src/api/resources/events/types/BaseEvent.ts:12
• createdAt: Date
Date the event was created
src/api/resources/events/types/BaseEvent.ts:20
• Optional
dataUrl: string
The url to retrieve the data associated with the event
src/api/resources/events/types/BaseEvent.ts:18
• Optional
deletedAt: Date
Date the event was deleted
src/api/resources/events/types/BaseEvent.ts:22
• domain: Domain
The domain of the event
src/api/resources/events/types/BaseEvent.ts:9
• Optional
origin: Origin
src/api/resources/events/types/BaseEvent.ts:28
• payload: Record
<string
, unknown
>
src/api/resources/events/types/UploadStartedEvent.ts:8
• Optional
target: string
src/api/resources/events/types/BaseEvent.ts:27
• topic: EventTopic
src/api/resources/events/types/BaseEvent.ts:10
@flatfile/api / Exports / Flatfile / events / UserAddedEvent
Flatfile.events.UserAddedEvent
- acknowledgedAt
- acknowledgedBy
- attributes
- callbackUrl
- context
- createdAt
- dataUrl
- deletedAt
- domain
- origin
- payload
- target
- topic
• Optional
acknowledgedAt: string
Date the event was acknowledged
src/api/resources/events/types/BaseEvent.ts:24
• Optional
acknowledgedBy: string
The actor (user or system) who acknowledged the event
src/api/resources/events/types/BaseEvent.ts:26
• Optional
attributes: EventAttributes
The attributes of the event
src/api/resources/events/types/BaseEvent.ts:14
• Optional
callbackUrl: string
The callback url to acknowledge the event
src/api/resources/events/types/BaseEvent.ts:16
• context: Context
The context of the event
src/api/resources/events/types/BaseEvent.ts:12
• createdAt: Date
Date the event was created
src/api/resources/events/types/BaseEvent.ts:20
• Optional
dataUrl: string
The url to retrieve the data associated with the event
src/api/resources/events/types/BaseEvent.ts:18
• Optional
deletedAt: Date
Date the event was deleted
src/api/resources/events/types/BaseEvent.ts:22
• domain: Domain
The domain of the event
src/api/resources/events/types/BaseEvent.ts:9
• Optional
origin: Origin
src/api/resources/events/types/BaseEvent.ts:28
• payload: Record
<string
, unknown
>
src/api/resources/events/types/UserAddedEvent.ts:8
• Optional
target: string
src/api/resources/events/types/BaseEvent.ts:27
• topic: EventTopic
src/api/resources/events/types/BaseEvent.ts:10
@flatfile/api / Exports / Flatfile / events / UserOfflineEvent
Flatfile.events.UserOfflineEvent
-
↳
UserOfflineEvent
↳↳
UserOffline
- acknowledgedAt
- acknowledgedBy
- attributes
- callbackUrl
- context
- createdAt
- dataUrl
- deletedAt
- domain
- origin
- payload
- target
- topic
• Optional
acknowledgedAt: string
Date the event was acknowledged
src/api/resources/events/types/BaseEvent.ts:24
• Optional
acknowledgedBy: string
The actor (user or system) who acknowledged the event
src/api/resources/events/types/BaseEvent.ts:26
• Optional
attributes: EventAttributes
The attributes of the event
src/api/resources/events/types/BaseEvent.ts:14
• Optional
callbackUrl: string
The callback url to acknowledge the event
src/api/resources/events/types/BaseEvent.ts:16
• context: Context
The context of the event
src/api/resources/events/types/BaseEvent.ts:12
• createdAt: Date
Date the event was created
src/api/resources/events/types/BaseEvent.ts:20
• Optional
dataUrl: string
The url to retrieve the data associated with the event
src/api/resources/events/types/BaseEvent.ts:18
• Optional
deletedAt: Date
Date the event was deleted
src/api/resources/events/types/BaseEvent.ts:22
• domain: Domain
The domain of the event
src/api/resources/events/types/BaseEvent.ts:9
• Optional
origin: Origin
src/api/resources/events/types/BaseEvent.ts:28
• payload: Record
<string
, unknown
>
src/api/resources/events/types/UserOfflineEvent.ts:8
• Optional
target: string
src/api/resources/events/types/BaseEvent.ts:27
• topic: EventTopic
src/api/resources/events/types/BaseEvent.ts:10
@flatfile/api / Exports / Flatfile / events / UserOnlineEvent
Flatfile.events.UserOnlineEvent
-
↳
UserOnlineEvent
↳↳
UserOnline
- acknowledgedAt
- acknowledgedBy
- attributes
- callbackUrl
- context
- createdAt
- dataUrl
- deletedAt
- domain
- origin
- payload
- target
- topic
• Optional
acknowledgedAt: string
Date the event was acknowledged
src/api/resources/events/types/BaseEvent.ts:24
• Optional
acknowledgedBy: string
The actor (user or system) who acknowledged the event
src/api/resources/events/types/BaseEvent.ts:26
• Optional
attributes: EventAttributes
The attributes of the event
src/api/resources/events/types/BaseEvent.ts:14
• Optional
callbackUrl: string
The callback url to acknowledge the event
src/api/resources/events/types/BaseEvent.ts:16
• context: Context
The context of the event
src/api/resources/events/types/BaseEvent.ts:12
• createdAt: Date
Date the event was created
src/api/resources/events/types/BaseEvent.ts:20
• Optional
dataUrl: string
The url to retrieve the data associated with the event
src/api/resources/events/types/BaseEvent.ts:18
• Optional
deletedAt: Date
Date the event was deleted
src/api/resources/events/types/BaseEvent.ts:22
• domain: Domain
The domain of the event
src/api/resources/events/types/BaseEvent.ts:9
• Optional
origin: Origin
src/api/resources/events/types/BaseEvent.ts:28
• payload: Record
<string
, unknown
>
src/api/resources/events/types/UserOnlineEvent.ts:8
• Optional
target: string
src/api/resources/events/types/BaseEvent.ts:27
• topic: EventTopic
src/api/resources/events/types/BaseEvent.ts:10
@flatfile/api / Exports / Flatfile / events / UserRemovedEvent
Flatfile.events.UserRemovedEvent
-
↳
UserRemovedEvent
↳↳
UserRemoved
- acknowledgedAt
- acknowledgedBy
- attributes
- callbackUrl
- context
- createdAt
- dataUrl
- deletedAt
- domain
- origin
- payload
- target
- topic
• Optional
acknowledgedAt: string
Date the event was acknowledged
src/api/resources/events/types/BaseEvent.ts:24
• Optional
acknowledgedBy: string
The actor (user or system) who acknowledged the event
src/api/resources/events/types/BaseEvent.ts:26
• Optional
attributes: EventAttributes
The attributes of the event
src/api/resources/events/types/BaseEvent.ts:14
• Optional
callbackUrl: string
The callback url to acknowledge the event
src/api/resources/events/types/BaseEvent.ts:16
• context: Context
The context of the event
src/api/resources/events/types/BaseEvent.ts:12
• createdAt: Date
Date the event was created
src/api/resources/events/types/BaseEvent.ts:20
• Optional
dataUrl: string
The url to retrieve the data associated with the event
src/api/resources/events/types/BaseEvent.ts:18
• Optional
deletedAt: Date
Date the event was deleted
src/api/resources/events/types/BaseEvent.ts:22
• domain: Domain
The domain of the event
src/api/resources/events/types/BaseEvent.ts:9
• Optional
origin: Origin
src/api/resources/events/types/BaseEvent.ts:28
• payload: Record
<string
, unknown
>
src/api/resources/events/types/UserRemovedEvent.ts:8
• Optional
target: string
src/api/resources/events/types/BaseEvent.ts:27
• topic: EventTopic
src/api/resources/events/types/BaseEvent.ts:10
@flatfile/api / Exports / Flatfile / events / WorkbookAddedEvent
Flatfile.events.WorkbookAddedEvent
-
↳
WorkbookAddedEvent
- acknowledgedAt
- acknowledgedBy
- attributes
- callbackUrl
- context
- createdAt
- dataUrl
- deletedAt
- domain
- origin
- payload
- target
- topic
• Optional
acknowledgedAt: string
Date the event was acknowledged
src/api/resources/events/types/BaseEvent.ts:24
• Optional
acknowledgedBy: string
The actor (user or system) who acknowledged the event
src/api/resources/events/types/BaseEvent.ts:26
• Optional
attributes: EventAttributes
The attributes of the event
src/api/resources/events/types/BaseEvent.ts:14
• Optional
callbackUrl: string
The callback url to acknowledge the event
src/api/resources/events/types/BaseEvent.ts:16
• context: Context
The context of the event
src/api/resources/events/types/BaseEvent.ts:12
• createdAt: Date
Date the event was created
src/api/resources/events/types/BaseEvent.ts:20
• Optional
dataUrl: string
The url to retrieve the data associated with the event
src/api/resources/events/types/BaseEvent.ts:18
• Optional
deletedAt: Date
Date the event was deleted
src/api/resources/events/types/BaseEvent.ts:22
• domain: Domain
The domain of the event
src/api/resources/events/types/BaseEvent.ts:9
• Optional
origin: Origin
src/api/resources/events/types/BaseEvent.ts:28
• payload: Record
<string
, unknown
>
src/api/resources/events/types/WorkbookAddedEvent.ts:8
• Optional
target: string
src/api/resources/events/types/BaseEvent.ts:27
• topic: EventTopic
src/api/resources/events/types/BaseEvent.ts:10
@flatfile/api / Exports / Flatfile / events / WorkbookRemovedEvent
Flatfile.events.WorkbookRemovedEvent
-
↳
WorkbookRemovedEvent
- acknowledgedAt
- acknowledgedBy
- attributes
- callbackUrl
- context
- createdAt
- dataUrl
- deletedAt
- domain
- origin
- payload
- target
- topic
• Optional
acknowledgedAt: string
Date the event was acknowledged
src/api/resources/events/types/BaseEvent.ts:24
• Optional
acknowledgedBy: string
The actor (user or system) who acknowledged the event
src/api/resources/events/types/BaseEvent.ts:26
• Optional
attributes: EventAttributes
The attributes of the event
src/api/resources/events/types/BaseEvent.ts:14
• Optional
callbackUrl: string
The callback url to acknowledge the event
src/api/resources/events/types/BaseEvent.ts:16
• context: Context
The context of the event
src/api/resources/events/types/BaseEvent.ts:12
• createdAt: Date
Date the event was created
src/api/resources/events/types/BaseEvent.ts:20
• Optional
dataUrl: string
The url to retrieve the data associated with the event
src/api/resources/events/types/BaseEvent.ts:18
• Optional
deletedAt: Date
Date the event was deleted
src/api/resources/events/types/BaseEvent.ts:22
• domain: Domain
The domain of the event
src/api/resources/events/types/BaseEvent.ts:9
• Optional
origin: Origin
src/api/resources/events/types/BaseEvent.ts:28
• payload: Record
<string
, unknown
>
src/api/resources/events/types/WorkbookRemovedEvent.ts:8
• Optional
target: string
src/api/resources/events/types/BaseEvent.ts:27
• topic: EventTopic
src/api/resources/events/types/BaseEvent.ts:10
@flatfile/api / Exports / Flatfile / events / WorkbookUpdatedEvent
Flatfile.events.WorkbookUpdatedEvent
-
↳
WorkbookUpdatedEvent
- acknowledgedAt
- acknowledgedBy
- attributes
- callbackUrl
- context
- createdAt
- dataUrl
- deletedAt
- domain
- origin
- payload
- target
- topic
• Optional
acknowledgedAt: string
Date the event was acknowledged
src/api/resources/events/types/BaseEvent.ts:24
• Optional
acknowledgedBy: string
The actor (user or system) who acknowledged the event
src/api/resources/events/types/BaseEvent.ts:26
• Optional
attributes: EventAttributes
The attributes of the event
src/api/resources/events/types/BaseEvent.ts:14
• Optional
callbackUrl: string
The callback url to acknowledge the event
src/api/resources/events/types/BaseEvent.ts:16
• context: Context
The context of the event
src/api/resources/events/types/BaseEvent.ts:12
• createdAt: Date
Date the event was created
src/api/resources/events/types/BaseEvent.ts:20
• Optional
dataUrl: string
The url to retrieve the data associated with the event
src/api/resources/events/types/BaseEvent.ts:18
• Optional
deletedAt: Date
Date the event was deleted
src/api/resources/events/types/BaseEvent.ts:22
• domain: Domain
The domain of the event
src/api/resources/events/types/BaseEvent.ts:9
• Optional
origin: Origin
src/api/resources/events/types/BaseEvent.ts:28
• payload: Record
<string
, unknown
>
src/api/resources/events/types/WorkbookUpdatedEvent.ts:8
• Optional
target: string
src/api/resources/events/types/BaseEvent.ts:27
• topic: EventTopic
src/api/resources/events/types/BaseEvent.ts:10
@flatfile/api / Exports / Flatfile / files / CreateFileRequest
Flatfile.files.CreateFileRequest
• environmentId: string
src/api/resources/files/client/requests/CreateFileRequest.ts:9
• file: string
A binary payload containing the file contents
src/api/resources/files/client/requests/CreateFileRequest.ts:13
• Optional
mode: Mode
The storage mode of file to insert, defaults to "import"
src/api/resources/files/client/requests/CreateFileRequest.ts:11
• spaceId: string
src/api/resources/files/client/requests/CreateFileRequest.ts:8
@flatfile/api / Exports / Flatfile / files / FileResponse
• data: File_
src/api/resources/files/types/FileResponse.ts:8
@flatfile/api / Exports / Flatfile / files / File_
Any uploaded file of any type
- actions
- bytesReceived
- createdAt
- encoding
- ext
- id
- mimetype
- name
- sheetId
- size
- spaceId
- status
- updatedAt
- workbookId
• Optional
actions: Action
[]
src/api/resources/files/types/File_.ts:33
• bytesReceived: number
Number of bytes that have been uploaded so far (useful for progress tracking)
src/api/resources/files/types/File_.ts:25
• createdAt: string
Date the file was created
src/api/resources/files/types/File_.ts:27
• encoding: string
Text encoding of the file
src/api/resources/files/types/File_.ts:19
• ext: string
Extension of the file
src/api/resources/files/types/File_.ts:15
• id: string
src/api/resources/files/types/File_.ts:11
• mimetype: string
MIME Type of the file
src/api/resources/files/types/File_.ts:17
• name: string
Original filename
src/api/resources/files/types/File_.ts:13
• Optional
sheetId: string
src/api/resources/files/types/File_.ts:32
• size: number
Size of file in bytes
src/api/resources/files/types/File_.ts:23
• spaceId: string
src/api/resources/files/types/File_.ts:30
• status: ModelFileStatusEnum
Status of the file
src/api/resources/files/types/File_.ts:21
• updatedAt: string
Date the file was last updated
src/api/resources/files/types/File_.ts:29
• Optional
workbookId: string
src/api/resources/files/types/File_.ts:31
@flatfile/api / Exports / Flatfile / files / ListFilesRequest
Flatfile.files.ListFilesRequest
• Optional
mode: Mode
The storage mode of file to fetch, defaults to "import"
src/api/resources/files/client/requests/ListFilesRequest.ts:20
• Optional
pageNumber: number
Based on pageSize, which page of jobs to return
src/api/resources/files/client/requests/ListFilesRequest.ts:16
• Optional
pageSize: number
Number of jobs to return in a page (default 20)
src/api/resources/files/client/requests/ListFilesRequest.ts:12
• Optional
spaceId: string
src/api/resources/files/client/requests/ListFilesRequest.ts:8
@flatfile/api / Exports / Flatfile / files / ListFilesResponse
Flatfile.files.ListFilesResponse
• data: File_
[]
src/api/resources/files/types/ListFilesResponse.ts:9
• Optional
pagination: Pagination
src/api/resources/files/types/ListFilesResponse.ts:8
@flatfile/api / Exports / Flatfile / files / UpdateFileRequest
Flatfile.files.UpdateFileRequest
• Optional
actions: Action
[]
The actions attached to the file
src/api/resources/files/client/requests/UpdateFileRequest.ts:16
• Optional
mode: Mode
The storage mode of file to update
src/api/resources/files/client/requests/UpdateFileRequest.ts:12
• Optional
name: string
The name of the file
src/api/resources/files/client/requests/UpdateFileRequest.ts:10
• Optional
status: ModelFileStatusEnum
Status of the file
src/api/resources/files/client/requests/UpdateFileRequest.ts:14
• Optional
workbookId: string
src/api/resources/files/client/requests/UpdateFileRequest.ts:8
@flatfile/api / Exports / Flatfile / guests / CreateGuestResponse
Flatfile.guests.CreateGuestResponse
• data: Guest
[]
src/api/resources/guests/types/CreateGuestResponse.ts:8
@flatfile/api / Exports / Flatfile / guests / Guest
Configurations for the guests
-
↳
Guest
• createdAt: Date
Date the guest object was created
src/api/resources/guests/types/Guest.ts:10
• email: string
src/api/resources/guests/types/GuestConfig.ts:12
• environmentId: string
src/api/resources/guests/types/GuestConfig.ts:11
• id: string
src/api/resources/guests/types/Guest.ts:8
• name: string
src/api/resources/guests/types/GuestConfig.ts:13
• spaces: GuestSpace
[]
src/api/resources/guests/types/GuestConfig.ts:14
• updatedAt: Date
Date the guest object was last updated
src/api/resources/guests/types/Guest.ts:12
• Optional
workbooks: GuestWorkbook
[]
src/api/resources/guests/types/GuestConfig.ts:15
@flatfile/api / Exports / Flatfile / guests / GuestConfig
Configurations for the guests
-
GuestConfig
↳
Guest
• email: string
src/api/resources/guests/types/GuestConfig.ts:12
• environmentId: string
src/api/resources/guests/types/GuestConfig.ts:11
• name: string
src/api/resources/guests/types/GuestConfig.ts:13
• spaces: GuestSpace
[]
src/api/resources/guests/types/GuestConfig.ts:14
• Optional
workbooks: GuestWorkbook
[]
src/api/resources/guests/types/GuestConfig.ts:15
@flatfile/api / Exports / Flatfile / guests / GuestSpace
• id: string
src/api/resources/guests/types/GuestSpace.ts:8
• Optional
lastAccessed: Date
src/api/resources/guests/types/GuestSpace.ts:9
@flatfile/api / Exports / Flatfile / guests / GuestWorkbook
• id: string
src/api/resources/guests/types/GuestWorkbook.ts:8
@flatfile/api / Exports / Flatfile / guests / Invite
• guestId: string
src/api/resources/guests/types/Invite.ts:8
• message: string
Message to send with the invite
src/api/resources/guests/types/Invite.ts:11
• spaceId: string
src/api/resources/guests/types/Invite.ts:9
@flatfile/api / Exports / Flatfile / guests / ListGuestsRequest
Flatfile.guests.ListGuestsRequest
• Optional
email: string
Email of guest to return
src/api/resources/guests/client/requests/ListGuestsRequest.ts:15
• spaceId: string
ID of space to return
src/api/resources/guests/client/requests/ListGuestsRequest.ts:11
@flatfile/api / Exports / Flatfile / guests / ListGuestsResponse
Flatfile.guests.ListGuestsResponse
• data: Guest
[]
src/api/resources/guests/types/ListGuestsResponse.ts:8
@flatfile/api / Exports / Flatfile / jobs / AiAssistJobConfig
Flatfile.jobs.AiAssistJobConfig
This file was auto-generated by Fern from our API Definition.
• command: string
src/api/resources/jobs/types/AiAssistJobConfig.ts:7
• Optional
metadata: Record
<string
, unknown
>
This will be generated by the AI not by you.
src/api/resources/jobs/types/AiAssistJobConfig.ts:12
• model: string
src/api/resources/jobs/types/AiAssistJobConfig.ts:6
• Optional
modelParams: Record
<string
, unknown
>
src/api/resources/jobs/types/AiAssistJobConfig.ts:8
• Optional
mutateRecord: string
This will be generated by the AI not by you.
src/api/resources/jobs/types/AiAssistJobConfig.ts:10
@flatfile/api / Exports / Flatfile / jobs / CategoryMapping
This file was auto-generated by Fern from our API Definition.
• Optional
destinationValue: string
src/api/resources/jobs/types/CategoryMapping.ts:7
• Optional
sourceValue: string
src/api/resources/jobs/types/CategoryMapping.ts:6
@flatfile/api / Exports / Flatfile / jobs / DeleteJobConfig
The configuration for a delete job
• Optional
exceptions: string
[]
src/api/resources/jobs/types/DeleteJobConfig.ts:16
• Optional
filter: Filter
src/api/resources/jobs/types/DeleteJobConfig.ts:11
• Optional
filterField: string
src/api/resources/jobs/types/DeleteJobConfig.ts:12
• Optional
searchField: string
src/api/resources/jobs/types/DeleteJobConfig.ts:14
• Optional
searchValue: string
src/api/resources/jobs/types/DeleteJobConfig.ts:13
• sheet: string
src/api/resources/jobs/types/DeleteJobConfig.ts:15
@flatfile/api / Exports / Flatfile / jobs / DestinationField
Flatfile.jobs.DestinationField
• destinationField: Property
src/api/resources/jobs/types/DestinationField.ts:10
• Optional
enumDetails: EnumDetails
Only available if one or more of the destination fields is of type enum. Provides category mapping.
src/api/resources/jobs/types/DestinationField.ts:9
• Optional
preview: string
[]
src/api/resources/jobs/types/DestinationField.ts:11
@flatfile/api / Exports / Flatfile / jobs / Edge
• destinationField: Property
src/api/resources/jobs/types/Edge.ts:9
• Optional
enumDetails: EnumDetails
Only available if one or more of the destination fields is of type enum. Provides category mapping.
src/api/resources/jobs/types/Edge.ts:12
• Optional
metadata: Metadata
src/api/resources/jobs/types/Edge.ts:13
• Optional
preview: string
[]
src/api/resources/jobs/types/Edge.ts:10
• sourceField: Property
src/api/resources/jobs/types/Edge.ts:8
@flatfile/api / Exports / Flatfile / jobs / EmptyObject
This file was auto-generated by Fern from our API Definition.
@flatfile/api / Exports / Flatfile / jobs / EnumDetails
Only available if one or more of the destination fields is of type enum. Provides category mapping.
• Optional
mapping: CategoryMapping
[]
src/api/resources/jobs/types/EnumDetails.ts:11
• Optional
unusedDestinationValues: string
[]
src/api/resources/jobs/types/EnumDetails.ts:13
• Optional
unusedSourceValues: string
[]
src/api/resources/jobs/types/EnumDetails.ts:12
@flatfile/api / Exports / Flatfile / jobs / ExportJobConfig
• options: ExportOptions
src/api/resources/jobs/types/ExportJobConfig.ts:8
@flatfile/api / Exports / Flatfile / jobs / ExportOptions
• Optional
filter: Filter
src/api/resources/jobs/types/ExportOptions.ts:11
• Optional
filterField: string
src/api/resources/jobs/types/ExportOptions.ts:12
• ids: string
[]
'A list of record ids to export. If filter is also specified, then this is a list of record ids to exclude from the download.'
src/api/resources/jobs/types/ExportOptions.ts:19
• Optional
searchField: string
src/api/resources/jobs/types/ExportOptions.ts:14
• Optional
searchValue: string
src/api/resources/jobs/types/ExportOptions.ts:13
• Optional
sortDirection: SortDirection
src/api/resources/jobs/types/ExportOptions.ts:10
• Optional
sortField: string
src/api/resources/jobs/types/ExportOptions.ts:9
• Optional
versionId: string
src/api/resources/jobs/types/ExportOptions.ts:8
@flatfile/api / Exports / Flatfile / jobs / FileJobConfig
• driver: "csv"
The driver to use for extracting data from the file
src/api/resources/jobs/types/FileJobConfig.ts:9
@flatfile/api / Exports / Flatfile / jobs / FindAndReplaceJobConfig
Flatfile.jobs.FindAndReplaceJobConfig
• fieldKey: string
The value to replace found values with
src/api/resources/jobs/types/FindAndReplaceJobConfig.ts:22
• Optional
filter: Filter
src/api/resources/jobs/types/FindAndReplaceJobConfig.ts:8
• Optional
filterField: string
src/api/resources/jobs/types/FindAndReplaceJobConfig.ts:9
• Optional
find: CellValueUnion
A value to find for a given field in a sheet. Wrap the value in "" for exact match
src/api/resources/jobs/types/FindAndReplaceJobConfig.ts:18
• Optional
ids: string
[]
'A list of record ids to search within. If filter "all" is also specified, then this is a list of record ids to exclude from the search.'
src/api/resources/jobs/types/FindAndReplaceJobConfig.ts:16
• Optional
replace: CellValueUnion
The value to replace found values with
src/api/resources/jobs/types/FindAndReplaceJobConfig.ts:20
• Optional
searchField: string
src/api/resources/jobs/types/FindAndReplaceJobConfig.ts:11
• Optional
searchValue: string
src/api/resources/jobs/types/FindAndReplaceJobConfig.ts:10
@flatfile/api / Exports / Flatfile / jobs / Job
A single unit of work that will execute asynchronously
-
↳
Job
- config
- createdAt
- destination
- fileId
- finishedAt
- id
- info
- input
- managed
- mode
- operation
- outcome
- outcomeAcknowledgedAt
- progress
- source
- startedAt
- status
- trigger
- type
- updatedAt
• Optional
config: JobUpdateConfig
src/api/resources/jobs/types/JobConfig.ts:17
• createdAt: Date
Date the item was created
src/api/resources/jobs/types/Job.ts:13
• Optional
destination: string
src/api/resources/jobs/types/JobConfig.ts:16
• Optional
fileId: string
src/api/resources/jobs/types/JobConfig.ts:24
• Optional
finishedAt: Date
the time that the job finished at
src/api/resources/jobs/types/Job.ts:19
• id: string
src/api/resources/jobs/types/Job.ts:11
• Optional
info: string
Current status of job in text
src/api/resources/jobs/types/JobConfig.ts:32
• Optional
input: Record
<string
, unknown
>
Input parameters for this job type.
src/api/resources/jobs/types/JobConfig.ts:28
• managed: boolean
Indicates if Flatfile is managing the control flow of this job or if it is being manually tracked.
src/api/resources/jobs/types/JobConfig.ts:34
• Optional
mode: JobMode
the mode of the job
src/api/resources/jobs/types/JobConfig.ts:26
• operation: string
the type of operation to perform on the data. For example, "export".
src/api/resources/jobs/types/JobConfig.ts:14
• Optional
outcome: Record
<string
, unknown
>
Outcome summary of job.
src/api/resources/jobs/types/JobConfig.ts:30
• Optional
outcomeAcknowledgedAt: Date
the time that the job's outcome has been acknowledged by a user
src/api/resources/jobs/types/Job.ts:21
• Optional
progress: number
the progress of the job
src/api/resources/jobs/types/JobConfig.ts:23
• source: string
src/api/resources/jobs/types/JobConfig.ts:15
• Optional
startedAt: Date
the time that the job started at
src/api/resources/jobs/types/Job.ts:17
• Optional
status: JobStatus
the status of the job
src/api/resources/jobs/types/JobConfig.ts:21
• Optional
trigger: Trigger
the type of trigger to use for this job
src/api/resources/jobs/types/JobConfig.ts:19
• type: JobType
The type of job
src/api/resources/jobs/types/JobConfig.ts:12
• updatedAt: Date
Date the item was last updated
src/api/resources/jobs/types/Job.ts:15
@flatfile/api / Exports / Flatfile / jobs / JobAckDetails
Details about the user who acknowledged the job
• Optional
info: string
src/api/resources/jobs/types/JobAckDetails.ts:9
• Optional
progress: number
src/api/resources/jobs/types/JobAckDetails.ts:10
@flatfile/api / Exports / Flatfile / jobs / JobConfig
A single unit of work that a pipeline will execute
-
JobConfig
↳
Job
- config
- destination
- fileId
- info
- input
- managed
- mode
- operation
- outcome
- progress
- source
- status
- trigger
- type
• Optional
config: JobUpdateConfig
src/api/resources/jobs/types/JobConfig.ts:17
• Optional
destination: string
src/api/resources/jobs/types/JobConfig.ts:16
• Optional
fileId: string
src/api/resources/jobs/types/JobConfig.ts:24
• Optional
info: string
Current status of job in text
src/api/resources/jobs/types/JobConfig.ts:32
• Optional
input: Record
<string
, unknown
>
Input parameters for this job type.
src/api/resources/jobs/types/JobConfig.ts:28
• managed: boolean
Indicates if Flatfile is managing the control flow of this job or if it is being manually tracked.
src/api/resources/jobs/types/JobConfig.ts:34
• Optional
mode: JobMode
the mode of the job
src/api/resources/jobs/types/JobConfig.ts:26
• operation: string
the type of operation to perform on the data. For example, "export".
src/api/resources/jobs/types/JobConfig.ts:14
• Optional
outcome: Record
<string
, unknown
>
Outcome summary of job.
src/api/resources/jobs/types/JobConfig.ts:30
• Optional
progress: number
the progress of the job
src/api/resources/jobs/types/JobConfig.ts:23
• source: string
src/api/resources/jobs/types/JobConfig.ts:15
• Optional
status: JobStatus
the status of the job
src/api/resources/jobs/types/JobConfig.ts:21
• Optional
trigger: Trigger
the type of trigger to use for this job
src/api/resources/jobs/types/JobConfig.ts:19
• type: JobType
The type of job
src/api/resources/jobs/types/JobConfig.ts:12
@flatfile/api / Exports / Flatfile / jobs / JobExecutionPlan
Flatfile.jobs.JobExecutionPlan
The execution plan for a job, for example, for a map job, the execution plan is the mapping of the source sheet to the destination sheet.
-
JobExecutionPlan
• Optional
fieldMapping: Edge
[]
src/api/resources/jobs/types/JobExecutionPlan.ts:11
• Optional
headerRowCount: number
The number of rows to skip before reading data from the document
src/api/resources/jobs/types/JobExecutionPlan.ts:15
• Optional
unmappedDestinationFields: DestinationField
[]
src/api/resources/jobs/types/JobExecutionPlan.ts:13
• Optional
unmappedSourceFields: SourceField
[]
src/api/resources/jobs/types/JobExecutionPlan.ts:12
@flatfile/api / Exports / Flatfile / jobs / JobExecutionPlanConfig
Flatfile.jobs.JobExecutionPlanConfig
The execution plan for a job, for example, for a map job, the execution plan is the mapping of the source sheet to the destination sheet.
-
↳
JobExecutionPlanConfig
• Optional
fieldMapping: Edge
[]
src/api/resources/jobs/types/JobExecutionPlan.ts:11
• fileId: string
src/api/resources/jobs/types/JobExecutionPlanConfig.ts:8
• Optional
headerRowCount: number
The number of rows to skip before reading data from the document
JobExecutionPlan.headerRowCount
src/api/resources/jobs/types/JobExecutionPlan.ts:15
• jobId: string
src/api/resources/jobs/types/JobExecutionPlanConfig.ts:9
• Optional
unmappedDestinationFields: DestinationField
[]
JobExecutionPlan.unmappedDestinationFields
src/api/resources/jobs/types/JobExecutionPlan.ts:13
• Optional
unmappedSourceFields: SourceField
[]
JobExecutionPlan.unmappedSourceFields
src/api/resources/jobs/types/JobExecutionPlan.ts:12
@flatfile/api / Exports / Flatfile / jobs / JobOutcome
Outcome summary of a job
• Optional
info: string
src/api/resources/jobs/types/JobOutcome.ts:10
• Optional
outcome: Record
<string
, unknown
>
src/api/resources/jobs/types/JobOutcome.ts:9
@flatfile/api / Exports / Flatfile / jobs / JobPlan
The job/plan tuple that contains the full plan and the jobs status
• Optional
job: Job
src/api/resources/jobs/types/JobPlan.ts:11
• Optional
plan: JobExecutionPlan
src/api/resources/jobs/types/JobPlan.ts:12
@flatfile/api / Exports / Flatfile / jobs / JobResponse
• data: Job
src/api/resources/jobs/types/JobResponse.ts:8
@flatfile/api / Exports / Flatfile / jobs / JobUpdate
A single unit of work that will be executed
• Optional
config: JobUpdateConfig
src/api/resources/jobs/types/JobUpdate.ts:11
• Optional
outcomeAcknowledgedAt: Date
the time that the job's outcome has been acknowledged by a user
src/api/resources/jobs/types/JobUpdate.ts:17
• Optional
progress: number
the progress of the job
src/api/resources/jobs/types/JobUpdate.ts:15
• Optional
status: JobStatus
the status of the job
src/api/resources/jobs/types/JobUpdate.ts:13
@flatfile/api / Exports / Flatfile / jobs / ListJobsRequest
• Optional
environmentId: string
src/api/resources/jobs/client/requests/ListJobsRequest.ts:8
• Optional
fileId: string
src/api/resources/jobs/client/requests/ListJobsRequest.ts:11
• Optional
pageNumber: number
Based on pageSize, which page of jobs to return
src/api/resources/jobs/client/requests/ListJobsRequest.ts:19
• Optional
pageSize: number
Number of jobs to return in a page (default 20)
src/api/resources/jobs/client/requests/ListJobsRequest.ts:15
• Optional
sortDirection: SortDirection
src/api/resources/jobs/client/requests/ListJobsRequest.ts:20
• Optional
spaceId: string
src/api/resources/jobs/client/requests/ListJobsRequest.ts:9
• Optional
workbookId: string
src/api/resources/jobs/client/requests/ListJobsRequest.ts:10
@flatfile/api / Exports / Flatfile / jobs / ListJobsResponse
Flatfile.jobs.ListJobsResponse
• data: Job
[]
src/api/resources/jobs/types/ListJobsResponse.ts:9
• Optional
pagination: Pagination
src/api/resources/jobs/types/ListJobsResponse.ts:8
@flatfile/api / Exports / Flatfile / jobs / Metadata
• Optional
certainty: Certainty
src/api/resources/jobs/types/Metadata.ts:8
• Optional
source: string
src/api/resources/jobs/types/Metadata.ts:9
@flatfile/api / Exports / Flatfile / jobs / MutateJobConfig
• mutateRecord: string
A JavaScript function that will be run on each record in the sheet, it should return a mutated record.
src/api/resources/jobs/types/MutateJobConfig.ts:10
• Optional
mutationId: string
If the mutation was generated through some sort of id-ed process, this links this job and that process.
src/api/resources/jobs/types/MutateJobConfig.ts:12
• sheetId: string
src/api/resources/jobs/types/MutateJobConfig.ts:8
@flatfile/api / Exports / Flatfile / jobs / PipelineJobConfig
Flatfile.jobs.PipelineJobConfig
• destinationSheetId: string
src/api/resources/jobs/types/PipelineJobConfig.ts:9
• sourceSheetId: string
src/api/resources/jobs/types/PipelineJobConfig.ts:8
@flatfile/api / Exports / Flatfile / jobs / SourceField
• Optional
preview: string
[]
src/api/resources/jobs/types/SourceField.ts:9
• sourceField: Property
src/api/resources/jobs/types/SourceField.ts:8
@flatfile/api / Exports / Flatfile / property / ArrayableProperty
Flatfile.property.ArrayableProperty
This file was auto-generated by Fern from our API Definition.
-
ArrayableProperty
• Optional
isArray: boolean
Will allow multiple values and store as an array
src/api/resources/property/types/ArrayableProperty.ts:7
@flatfile/api / Exports / Flatfile / property / BaseProperty
Flatfile.property.BaseProperty
-
BaseProperty
• Optional
constraints: Constraint
[]
src/api/resources/property/types/BaseProperty.ts:12
• Optional
description: string
src/api/resources/property/types/BaseProperty.ts:11
• key: string
src/api/resources/property/types/BaseProperty.ts:8
• Optional
label: string
User friendly field name
src/api/resources/property/types/BaseProperty.ts:10
• Optional
metadata: unknown
Useful for any contextual metadata regarding the schema. Store any valid json here.
src/api/resources/property/types/BaseProperty.ts:15
• Optional
readonly: boolean
src/api/resources/property/types/BaseProperty.ts:13
@flatfile/api / Exports / Flatfile / property / BooleanProperty
Flatfile.property.BooleanProperty
A true
or false
value type. Matching engines should attempt to resolve all common ways of representing this value and it should usually be displayed as a checkbox.
-
↳
BooleanProperty
↳↳
Boolean
• Optional
config: BooleanPropertyConfig
src/api/resources/property/types/BooleanProperty.ts:11
• Optional
constraints: Constraint
[]
src/api/resources/property/types/BaseProperty.ts:12
• Optional
description: string
src/api/resources/property/types/BaseProperty.ts:11
• key: string
src/api/resources/property/types/BaseProperty.ts:8
• Optional
label: string
User friendly field name
src/api/resources/property/types/BaseProperty.ts:10
• Optional
metadata: unknown
Useful for any contextual metadata regarding the schema. Store any valid json here.
src/api/resources/property/types/BaseProperty.ts:15
• Optional
readonly: boolean
src/api/resources/property/types/BaseProperty.ts:13
@flatfile/api / Exports / Flatfile / property / BooleanPropertyConfig
Flatfile.property.BooleanPropertyConfig
This file was auto-generated by Fern from our API Definition.
• allowIndeterminate: boolean
Allow a neither true or false state to be stored as null
src/api/resources/property/types/BooleanPropertyConfig.ts:7
@flatfile/api / Exports / Flatfile / property / Constraint / Computed
property.Constraint.Computed
• type: "computed"
src/api/resources/property/types/Constraint.ts:19
@flatfile/api / Exports / Flatfile / property / Constraint / Required
property.Constraint.Required
• type: "required"
src/api/resources/property/types/Constraint.ts:11
@flatfile/api / Exports / Flatfile / property / Constraint / Unique
property.Constraint.Unique
-
↳
Unique
• Optional
config: UniqueConstraintConfig
src/api/resources/property/types/UniqueConstraint.ts:8
• type: "unique"
src/api/resources/property/types/Constraint.ts:15
@flatfile/api / Exports / Flatfile / property / DateProperty
Flatfile.property.DateProperty
Store a field as a GMT date. Data hooks must convert this value into a YYYY-MM-DD
format in order for it to be considered a valid value. Datetime should be a separate and future supported value as it must consider timezone.
-
↳
DateProperty
↳↳
Date_
• Optional
constraints: Constraint
[]
src/api/resources/property/types/BaseProperty.ts:12
• Optional
description: string
src/api/resources/property/types/BaseProperty.ts:11
• key: string
src/api/resources/property/types/BaseProperty.ts:8
• Optional
label: string
User friendly field name
src/api/resources/property/types/BaseProperty.ts:10
• Optional
metadata: unknown
Useful for any contextual metadata regarding the schema. Store any valid json here.
src/api/resources/property/types/BaseProperty.ts:15
• Optional
readonly: boolean
src/api/resources/property/types/BaseProperty.ts:13
@flatfile/api / Exports / Flatfile / property / EnumProperty
Flatfile.property.EnumProperty
Defines an enumerated list of options for the user to select from. Matching tooling attempts to resolve incoming data assigment to a valid option. The maximum number of options for this list is 100
. For larger lists, users should use the reference or future lookup
types.
-
↳
EnumProperty
↳↳
Enum
• config: EnumPropertyConfig
src/api/resources/property/types/EnumProperty.ts:13
• Optional
constraints: Constraint
[]
src/api/resources/property/types/BaseProperty.ts:12
• Optional
description: string
src/api/resources/property/types/BaseProperty.ts:11
• Optional
isArray: boolean
Will allow multiple values and store as an array
src/api/resources/property/types/ArrayableProperty.ts:7
• key: string
src/api/resources/property/types/BaseProperty.ts:8
• Optional
label: string
User friendly field name
src/api/resources/property/types/BaseProperty.ts:10
• Optional
metadata: unknown
Useful for any contextual metadata regarding the schema. Store any valid json here.
src/api/resources/property/types/BaseProperty.ts:15
• Optional
multi: boolean
Will allow multiple values and store / provide the values in an array if set. Not all field types support arrays.
src/api/resources/property/types/EnumProperty.ts:12
• Optional
readonly: boolean
src/api/resources/property/types/BaseProperty.ts:13
@flatfile/api / Exports / Flatfile / property / EnumPropertyConfig
Flatfile.property.EnumPropertyConfig
• Optional
allowCustom: boolean
Permit the user to create new options for this specific field.
src/api/resources/property/types/EnumPropertyConfig.ts:9
• options: EnumPropertyOption
[]
src/api/resources/property/types/EnumPropertyConfig.ts:10
@flatfile/api / Exports / Flatfile / property / EnumPropertyOption
Flatfile.property.EnumPropertyOption
This file was auto-generated by Fern from our API Definition.
• Optional
color: string
An optional color to assign this option
src/api/resources/property/types/EnumPropertyOption.ts:9
• Optional
icon: string
A reference pointer to a previously registered icon
src/api/resources/property/types/EnumPropertyOption.ts:11
• Optional
label: string
A visual label for this option, defaults to value if not provided
src/api/resources/property/types/EnumPropertyOption.ts:7
• Optional
meta: Record
<string
, unknown
>
An arbitrary JSON object to be associated with this option and made available to hooks
src/api/resources/property/types/EnumPropertyOption.ts:13
• Optional
value: unknown
The value or ID of this option. This value will be sent in egress. The type is a string | integer | boolean.
src/api/resources/property/types/EnumPropertyOption.ts:15
@flatfile/api / Exports / Flatfile / property / NumberConfig
Flatfile.property.NumberConfig
Example
{
* decimalPlaces: 2
* }
• decimalPlaces: number
Number of decimal places to round data to
src/api/resources/property/types/NumberConfig.ts:13
@flatfile/api / Exports / Flatfile / property / NumberProperty
Flatfile.property.NumberProperty
Defines a property that should be stored and read as either an integer or floating point number. Database engines should look at the configuration to determine ideal storage format.
-
↳
NumberProperty
↳↳
Number
• Optional
config: NumberConfig
src/api/resources/property/types/NumberProperty.ts:11
• Optional
constraints: Constraint
[]
src/api/resources/property/types/BaseProperty.ts:12
• Optional
description: string
src/api/resources/property/types/BaseProperty.ts:11
• Optional
isArray: boolean
Will allow multiple values and store as an array
src/api/resources/property/types/ArrayableProperty.ts:7
• key: string
src/api/resources/property/types/BaseProperty.ts:8
• Optional
label: string
User friendly field name
src/api/resources/property/types/BaseProperty.ts:10
• Optional
metadata: unknown
Useful for any contextual metadata regarding the schema. Store any valid json here.
src/api/resources/property/types/BaseProperty.ts:15
• Optional
readonly: boolean
src/api/resources/property/types/BaseProperty.ts:13
@flatfile/api / Exports / Flatfile / property / Property / Boolean
A true
or false
value type. Matching engines should attempt to resolve all common ways of representing this value and it should usually be displayed as a checkbox.
-
↳
Boolean
• Optional
config: BooleanPropertyConfig
src/api/resources/property/types/BooleanProperty.ts:11
• Optional
constraints: Constraint
[]
src/api/resources/property/types/BaseProperty.ts:12
• Optional
description: string
src/api/resources/property/types/BaseProperty.ts:11
• key: string
src/api/resources/property/types/BaseProperty.ts:8
• Optional
label: string
User friendly field name
src/api/resources/property/types/BaseProperty.ts:10
• Optional
metadata: unknown
Useful for any contextual metadata regarding the schema. Store any valid json here.
src/api/resources/property/types/BaseProperty.ts:15
• Optional
readonly: boolean
src/api/resources/property/types/BaseProperty.ts:13
• type: "boolean"
src/api/resources/property/types/Property.ts:104
@flatfile/api / Exports / Flatfile / property / Property / Date_
Store a field as a GMT date. Data hooks must convert this value into a YYYY-MM-DD
format in order for it to be considered a valid value. Datetime should be a separate and future supported value as it must consider timezone.
-
↳
Date_
• Optional
constraints: Constraint
[]
src/api/resources/property/types/BaseProperty.ts:12
• Optional
description: string
src/api/resources/property/types/BaseProperty.ts:11
• key: string
src/api/resources/property/types/BaseProperty.ts:8
• Optional
label: string
User friendly field name
src/api/resources/property/types/BaseProperty.ts:10
• Optional
metadata: unknown
Useful for any contextual metadata regarding the schema. Store any valid json here.
src/api/resources/property/types/BaseProperty.ts:15
• Optional
readonly: boolean
src/api/resources/property/types/BaseProperty.ts:13
• type: "date"
src/api/resources/property/types/Property.ts:108
@flatfile/api / Exports / Flatfile / property / Property / Enum
Defines an enumerated list of options for the user to select from. Matching tooling attempts to resolve incoming data assigment to a valid option. The maximum number of options for this list is 100
. For larger lists, users should use the reference or future lookup
types.
-
↳
Enum
• config: EnumPropertyConfig
src/api/resources/property/types/EnumProperty.ts:13
• Optional
constraints: Constraint
[]
src/api/resources/property/types/BaseProperty.ts:12
• Optional
description: string
src/api/resources/property/types/BaseProperty.ts:11
• Optional
isArray: boolean
Will allow multiple values and store as an array
src/api/resources/property/types/ArrayableProperty.ts:7
• key: string
src/api/resources/property/types/BaseProperty.ts:8
• Optional
label: string
User friendly field name
src/api/resources/property/types/BaseProperty.ts:10
• Optional
metadata: unknown
Useful for any contextual metadata regarding the schema. Store any valid json here.
src/api/resources/property/types/BaseProperty.ts:15
• Optional
multi: boolean
Will allow multiple values and store / provide the values in an array if set. Not all field types support arrays.
src/api/resources/property/types/EnumProperty.ts:12
• Optional
readonly: boolean
src/api/resources/property/types/BaseProperty.ts:13
• type: "enum"
src/api/resources/property/types/Property.ts:112
@flatfile/api / Exports / Flatfile / property / Property / Number
Defines a property that should be stored and read as either an integer or floating point number. Database engines should look at the configuration to determine ideal storage format.
-
↳
Number
• Optional
config: NumberConfig
src/api/resources/property/types/NumberProperty.ts:11
• Optional
constraints: Constraint
[]
src/api/resources/property/types/BaseProperty.ts:12
• Optional
description: string
src/api/resources/property/types/BaseProperty.ts:11
• Optional
isArray: boolean
Will allow multiple values and store as an array
src/api/resources/property/types/ArrayableProperty.ts:7
• key: string
src/api/resources/property/types/BaseProperty.ts:8
• Optional
label: string
User friendly field name
src/api/resources/property/types/BaseProperty.ts:10
• Optional
metadata: unknown
Useful for any contextual metadata regarding the schema. Store any valid json here.
src/api/resources/property/types/BaseProperty.ts:15
• Optional
readonly: boolean
src/api/resources/property/types/BaseProperty.ts:13
• type: "number"
src/api/resources/property/types/Property.ts:100
@flatfile/api / Exports / Flatfile / property / Property / Reference
Defines a reference to another sheet. Links should be established automatically by the matching engine or similar upon an evaluation of unique or similar columns between datasets.
-
↳
Reference
• config: ReferencePropertyConfig
src/api/resources/property/types/ReferenceProperty.ts:11
• Optional
constraints: Constraint
[]
src/api/resources/property/types/BaseProperty.ts:12
• Optional
description: string
src/api/resources/property/types/BaseProperty.ts:11
• Optional
isArray: boolean
Will allow multiple values and store as an array
src/api/resources/property/types/ArrayableProperty.ts:7
• key: string
src/api/resources/property/types/BaseProperty.ts:8
• Optional
label: string
User friendly field name
src/api/resources/property/types/BaseProperty.ts:10
• Optional
metadata: unknown
Useful for any contextual metadata regarding the schema. Store any valid json here.
src/api/resources/property/types/BaseProperty.ts:15
• Optional
readonly: boolean
src/api/resources/property/types/BaseProperty.ts:13
• type: "reference"
src/api/resources/property/types/Property.ts:116
@flatfile/api / Exports / Flatfile / property / Property / String
Defines a property that should be stored and read as a basic string. Database engines should expect any length of text to be provided here unless explicitly defined in the config.
-
↳
String
• Optional
config: StringConfig
src/api/resources/property/types/StringProperty.ts:11
• Optional
constraints: Constraint
[]
src/api/resources/property/types/BaseProperty.ts:12
• Optional
description: string
src/api/resources/property/types/BaseProperty.ts:11
• key: string
src/api/resources/property/types/BaseProperty.ts:8
• Optional
label: string
User friendly field name
src/api/resources/property/types/BaseProperty.ts:10
• Optional
metadata: unknown
Useful for any contextual metadata regarding the schema. Store any valid json here.
src/api/resources/property/types/BaseProperty.ts:15
• Optional
readonly: boolean
src/api/resources/property/types/BaseProperty.ts:13
• type: "string"
src/api/resources/property/types/Property.ts:96
@flatfile/api / Exports / Flatfile / property / ReferenceProperty
Flatfile.property.ReferenceProperty
Defines a reference to another sheet. Links should be established automatically by the matching engine or similar upon an evaluation of unique or similar columns between datasets.
-
↳
ReferenceProperty
↳↳
Reference
• config: ReferencePropertyConfig
src/api/resources/property/types/ReferenceProperty.ts:11
• Optional
constraints: Constraint
[]
src/api/resources/property/types/BaseProperty.ts:12
• Optional
description: string
src/api/resources/property/types/BaseProperty.ts:11
• Optional
isArray: boolean
Will allow multiple values and store as an array
src/api/resources/property/types/ArrayableProperty.ts:7
• key: string
src/api/resources/property/types/BaseProperty.ts:8
• Optional
label: string
User friendly field name
src/api/resources/property/types/BaseProperty.ts:10
• Optional
metadata: unknown
Useful for any contextual metadata regarding the schema. Store any valid json here.
src/api/resources/property/types/BaseProperty.ts:15
• Optional
readonly: boolean
src/api/resources/property/types/BaseProperty.ts:13
@flatfile/api / Exports / Flatfile / property / ReferencePropertyConfig
Flatfile.property.ReferencePropertyConfig
• key: string
Key of the property to use as the reference key. Defaults to id
src/api/resources/property/types/ReferencePropertyConfig.ts:11
• ref: string
Full path reference to a sheet configuration. Must be in the same workbook.
src/api/resources/property/types/ReferencePropertyConfig.ts:9
• relationship: ReferencePropertyRelationship
The type of relationship this defines
src/api/resources/property/types/ReferencePropertyConfig.ts:13
@flatfile/api / Exports / Flatfile / property / StringConfig
Flatfile.property.StringConfig
• size: StringConfigOptions
src/api/resources/property/types/StringConfig.ts:8
@flatfile/api / Exports / Flatfile / property / StringProperty
Flatfile.property.StringProperty
Defines a property that should be stored and read as a basic string. Database engines should expect any length of text to be provided here unless explicitly defined in the config.
-
↳
StringProperty
↳↳
String
• Optional
config: StringConfig
src/api/resources/property/types/StringProperty.ts:11
• Optional
constraints: Constraint
[]
src/api/resources/property/types/BaseProperty.ts:12
• Optional
description: string
src/api/resources/property/types/BaseProperty.ts:11
• key: string
src/api/resources/property/types/BaseProperty.ts:8
• Optional
label: string
User friendly field name
src/api/resources/property/types/BaseProperty.ts:10
• Optional
metadata: unknown
Useful for any contextual metadata regarding the schema. Store any valid json here.
src/api/resources/property/types/BaseProperty.ts:15
• Optional
readonly: boolean
src/api/resources/property/types/BaseProperty.ts:13
@flatfile/api / Exports / Flatfile / property / UniqueConstraint
Flatfile.property.UniqueConstraint
-
UniqueConstraint
↳
Unique
• Optional
config: UniqueConstraintConfig
src/api/resources/property/types/UniqueConstraint.ts:8
@flatfile/api / Exports / Flatfile / property / UniqueConstraintConfig
Flatfile.property.UniqueConstraintConfig
This file was auto-generated by Fern from our API Definition.
• Optional
caseSensitive: boolean
Ignore casing when determining uniqueness
src/api/resources/property/types/UniqueConstraintConfig.ts:7
• Optional
ignoreEmpty: boolean
Do not flag empty values as duplicate
src/api/resources/property/types/UniqueConstraintConfig.ts:9
@flatfile/api / Exports / Flatfile / records / CellValue
-
CellValue
• Optional
messages: ValidationMessage
[]
src/api/resources/records/types/CellValue.ts:9
• Optional
updatedAt: Date
src/api/resources/records/types/CellValue.ts:11
• Optional
valid: boolean
src/api/resources/records/types/CellValue.ts:8
• Optional
value: CellValueUnion
src/api/resources/records/types/CellValue.ts:10
@flatfile/api / Exports / Flatfile / records / CellValueWithLinks
Flatfile.records.CellValueWithLinks
-
↳
CellValueWithLinks
• Optional
links: Records
src/api/resources/records/types/CellValueWithLinks.ts:8
• Optional
messages: ValidationMessage
[]
src/api/resources/records/types/CellValue.ts:9
• Optional
updatedAt: Date
src/api/resources/records/types/CellValue.ts:11
• Optional
valid: boolean
src/api/resources/records/types/CellValue.ts:8
• Optional
value: CellValueUnion
src/api/resources/records/types/CellValue.ts:10
@flatfile/api / Exports / Flatfile / records / DeleteRecordsRequest
Flatfile.records.DeleteRecordsRequest
• Optional
ids: string
| string
[]
A list of record ids
src/api/resources/records/client/requests/DeleteRecordsRequest.ts:11
@flatfile/api / Exports / Flatfile / records / FindAndReplaceRecordRequest
Flatfile.records.FindAndReplaceRecordRequest
• fieldKey: string
The value to replace found values with
src/api/resources/records/client/requests/FindAndReplaceRecordRequest.ts:25
• Optional
filter: Filter
src/api/resources/records/client/requests/FindAndReplaceRecordRequest.ts:8
• Optional
filterField: string
Name of field by which to filter records
src/api/resources/records/client/requests/FindAndReplaceRecordRequest.ts:12
• Optional
find: CellValueUnion
A value to find for a given field in a sheet. Wrap the value in "" for exact match
src/api/resources/records/client/requests/FindAndReplaceRecordRequest.ts:21
• Optional
ids: string
| string
[]
A list of record ids to search within. If filter "all" is also specified, then this is a list of record ids to exclude from the search.
src/api/resources/records/client/requests/FindAndReplaceRecordRequest.ts:19
• Optional
replace: CellValueUnion
The value to replace found values with
src/api/resources/records/client/requests/FindAndReplaceRecordRequest.ts:23
• Optional
searchField: string
src/api/resources/records/client/requests/FindAndReplaceRecordRequest.ts:14
• Optional
searchValue: string
src/api/resources/records/client/requests/FindAndReplaceRecordRequest.ts:13
@flatfile/api / Exports / Flatfile / records / FindAndReplaceRecordRequestDeprecated
Flatfile.records.FindAndReplaceRecordRequestDeprecated
• fieldKey: string
A unique key used to identify a field in a sheet
src/api/resources/records/client/requests/FindAndReplaceRecordRequestDeprecated.ts:11
• Optional
filter: Filter
src/api/resources/records/client/requests/FindAndReplaceRecordRequestDeprecated.ts:16
• Optional
pageNumber: number
Based on pageSize, which page of records to return
src/api/resources/records/client/requests/FindAndReplaceRecordRequestDeprecated.ts:24
• Optional
pageSize: number
Number of records to return in a page (default 1000 if pageNumber included)
src/api/resources/records/client/requests/FindAndReplaceRecordRequestDeprecated.ts:20
• Optional
replace: unknown
The value to replace found values with
src/api/resources/records/client/requests/FindAndReplaceRecordRequestDeprecated.ts:26
• searchValue: string
A value to find for a given field in a sheet. Wrap the value in "" for exact match
src/api/resources/records/client/requests/FindAndReplaceRecordRequestDeprecated.ts:15
@flatfile/api / Exports / Flatfile / records / FindRecordsRequest
Flatfile.records.FindRecordsRequest
This file was auto-generated by Fern from our API Definition.
• fieldKey: string
The unique key used to identify a field in a sheet
src/api/resources/records/client/requests/FindRecordsRequest.ts:9
• Optional
pageNumber: number
Based on pageSize, which page of records to return
src/api/resources/records/client/requests/FindRecordsRequest.ts:21
• Optional
pageSize: number
Number of records to return in a page (default 1000 if pageNumber included)
src/api/resources/records/client/requests/FindRecordsRequest.ts:17
• searchValue: string
The value to search for
src/api/resources/records/client/requests/FindRecordsRequest.ts:13
@flatfile/api / Exports / Flatfile / records / GetRecordsRequest
Flatfile.records.GetRecordsRequest
- filter
- filterField
- for
- ids
- includeCounts
- includeLMessages
- includeLinks
- pageNumber
- pageSize
- q
- searchField
- searchValue
- sinceVersionId
- sortDirection
- sortField
- untilVersionId
- versionId
• Optional
filter: Filter
src/api/resources/records/client/requests/GetRecordsRequest.ts:13
• Optional
filterField: string
Name of field by which to filter records
src/api/resources/records/client/requests/GetRecordsRequest.ts:17
• Optional
for: string
if "for" is provided, the query parameters will be pulled from the event payload
src/api/resources/records/client/requests/GetRecordsRequest.ts:48
• Optional
ids: string
| string
[]
A list of record ids to fetch. If filter "all" is also specified, then this is a list of record ids to exclude from the results.
src/api/resources/records/client/requests/GetRecordsRequest.ts:24
• Optional
includeCounts: boolean
Include counts for the total records, valid records and records with errors
src/api/resources/records/client/requests/GetRecordsRequest.ts:36
• Optional
includeLMessages: boolean
Include error messages, defaults to false.
src/api/resources/records/client/requests/GetRecordsRequest.ts:44
• Optional
includeLinks: boolean
If true, linked records will be included in the results. Defaults to false.
src/api/resources/records/client/requests/GetRecordsRequest.ts:40
• Optional
pageNumber: number
Based on pageSize, which page of records to return
src/api/resources/records/client/requests/GetRecordsRequest.ts:32
• Optional
pageSize: number
Number of records to return in a page (default 1000 if pageNumber included)
src/api/resources/records/client/requests/GetRecordsRequest.ts:28
• Optional
q: string
An FFQL query used to filter the result set
src/api/resources/records/client/requests/GetRecordsRequest.ts:52
• Optional
searchField: string
src/api/resources/records/client/requests/GetRecordsRequest.ts:19
• Optional
searchValue: string
src/api/resources/records/client/requests/GetRecordsRequest.ts:18
• Optional
sinceVersionId: string
src/api/resources/records/client/requests/GetRecordsRequest.ts:10
• Optional
sortDirection: SortDirection
src/api/resources/records/client/requests/GetRecordsRequest.ts:12
• Optional
sortField: string
src/api/resources/records/client/requests/GetRecordsRequest.ts:11
• Optional
untilVersionId: string
src/api/resources/records/client/requests/GetRecordsRequest.ts:9
• Optional
versionId: string
src/api/resources/records/client/requests/GetRecordsRequest.ts:8
@flatfile/api / Exports / Flatfile / records / RecordCounts
This file was auto-generated by Fern from our API Definition.
• error: number
src/api/resources/records/types/RecordCounts.ts:8
• Optional
errorsByField: Record
<string
, number
>
src/api/resources/records/types/RecordCounts.ts:9
• total: number
src/api/resources/records/types/RecordCounts.ts:6
• valid: number
src/api/resources/records/types/RecordCounts.ts:7
@flatfile/api / Exports / Flatfile / records / RecordWithLinks
Flatfile.records.RecordWithLinks
A single row of data in a Sheet, including links to related rows
• id: string
src/api/resources/records/types/RecordWithLinks.ts:11
• Optional
messages: ValidationMessage
[]
src/api/resources/records/types/RecordWithLinks.ts:14
• Optional
metadata: Record
<string
, unknown
>
src/api/resources/records/types/RecordWithLinks.ts:15
• Optional
valid: boolean
src/api/resources/records/types/RecordWithLinks.ts:13
• values: RecordDataWithLinks
src/api/resources/records/types/RecordWithLinks.ts:12
@flatfile/api / Exports / Flatfile / records / Record_
A single row of data in a Sheet
• id: string
src/api/resources/records/types/Record_.ts:11
• Optional
messages: ValidationMessage
[]
src/api/resources/records/types/Record_.ts:14
• Optional
metadata: Record
<string
, unknown
>
src/api/resources/records/types/Record_.ts:15
• Optional
valid: boolean
src/api/resources/records/types/Record_.ts:13
• values: RecordData
src/api/resources/records/types/Record_.ts:12
@flatfile/api / Exports / Flatfile / records / RecordsResponse
Flatfile.records.RecordsResponse
• data: RecordsResponseData
src/api/resources/records/types/RecordsResponse.ts:8
@flatfile/api / Exports / Flatfile / records / RecordsResponseData
Flatfile.records.RecordsResponseData
A list of records with optional record counts
-
↳
RecordsResponseData
• Optional
counts: RecordCounts
src/api/resources/records/types/RecordsResponseData.ts:12
• data: SuccessData
src/api/resources/commons/types/Success.ts:18
• Optional
records: RecordsWithLinks
src/api/resources/records/types/RecordsResponseData.ts:11
• Optional
versionId: string
src/api/resources/records/types/RecordsResponseData.ts:13
@flatfile/api / Exports / Flatfile / records / ValidationMessage
Flatfile.records.ValidationMessage
Record data validation messages
• Optional
message: string
src/api/resources/records/types/ValidationMessage.ts:13
• Optional
source: ValidationSource
src/api/resources/records/types/ValidationMessage.ts:12
• Optional
type: ValidationType
src/api/resources/records/types/ValidationMessage.ts:11
@flatfile/api / Exports / Flatfile / sheets / GetRecordCountsRequest
Flatfile.sheets.GetRecordCountsRequest
• Optional
byField: boolean
If true, the error counts for each field will also be returned
src/api/resources/sheets/client/requests/GetRecordCountsRequest.ts:20
• Optional
filter: Filter
Options to filter records
src/api/resources/sheets/client/requests/GetRecordCountsRequest.ts:13
• Optional
filterField: string
src/api/resources/sheets/client/requests/GetRecordCountsRequest.ts:14
• Optional
q: string
An FFQL query used to filter the result set to be counted
src/api/resources/sheets/client/requests/GetRecordCountsRequest.ts:24
• Optional
searchField: string
src/api/resources/sheets/client/requests/GetRecordCountsRequest.ts:16
• Optional
searchValue: string
src/api/resources/sheets/client/requests/GetRecordCountsRequest.ts:15
• Optional
sinceVersionId: string
src/api/resources/sheets/client/requests/GetRecordCountsRequest.ts:9
• Optional
versionId: string
src/api/resources/sheets/client/requests/GetRecordCountsRequest.ts:8
@flatfile/api / Exports / Flatfile / sheets / GetRecordsCsvRequest
Flatfile.sheets.GetRecordsCsvRequest
• Optional
filter: Filter
Options to filter records
src/api/resources/sheets/client/requests/GetRecordsCsvRequest.ts:18
• Optional
filterField: string
src/api/resources/sheets/client/requests/GetRecordsCsvRequest.ts:19
• Optional
ids: string
| string
[]
A list of record ids to download. If filter "all" is also specified, then this is a list of record ids to exclude from the download.
src/api/resources/sheets/client/requests/GetRecordsCsvRequest.ts:26
• Optional
searchField: string
src/api/resources/sheets/client/requests/GetRecordsCsvRequest.ts:21
• Optional
searchValue: string
src/api/resources/sheets/client/requests/GetRecordsCsvRequest.ts:20
• Optional
sinceVersionId: string
src/api/resources/sheets/client/requests/GetRecordsCsvRequest.ts:9
• Optional
sortDirection: SortDirection
Sort direction - asc (ascending) or desc (descending)
src/api/resources/sheets/client/requests/GetRecordsCsvRequest.ts:14
• Optional
sortField: string
src/api/resources/sheets/client/requests/GetRecordsCsvRequest.ts:10
• Optional
versionId: string
src/api/resources/sheets/client/requests/GetRecordsCsvRequest.ts:8
@flatfile/api / Exports / Flatfile / sheets / ListSheetsRequest
Flatfile.sheets.ListSheetsRequest
• workbookId: string
ID of workbook
src/api/resources/sheets/client/requests/ListSheetsRequest.ts:11
@flatfile/api / Exports / Flatfile / sheets / ListSheetsResponse
Flatfile.sheets.ListSheetsResponse
• data: Sheet
[]
src/api/resources/sheets/types/ListSheetsResponse.ts:8
@flatfile/api / Exports / Flatfile / sheets / RecordCountsResponse
Flatfile.sheets.RecordCountsResponse
• data: RecordCountsResponseData
src/api/resources/sheets/types/RecordCountsResponse.ts:8
@flatfile/api / Exports / Flatfile / sheets / RecordCountsResponseData
Flatfile.sheets.RecordCountsResponseData
Informs whether or not a request was successful
Example
{
* data: {
* success: true
* }
* }
-
↳
RecordCountsResponseData
• Optional
counts: RecordCounts
src/api/resources/sheets/types/RecordCountsResponseData.ts:8
• data: SuccessData
src/api/resources/commons/types/Success.ts:18
@flatfile/api / Exports / Flatfile / sheets / Sheet
A place to store tabular data
• Optional
config: SheetConfig
src/api/resources/sheets/types/Sheet.ts:14
• Optional
countRecords: RecordCounts
src/api/resources/sheets/types/Sheet.ts:15
• id: string
src/api/resources/sheets/types/Sheet.ts:11
• name: string
src/api/resources/sheets/types/Sheet.ts:13
• workbookId: string
src/api/resources/sheets/types/Sheet.ts:12
@flatfile/api / Exports / Flatfile / sheets / SheetConfig
Describes shape of data as well as behavior
• Optional
access: SheetAccess
[]
src/api/resources/sheets/types/SheetConfig.ts:15
• Optional
actions: Action
[]
src/api/resources/sheets/types/SheetConfig.ts:17
• Optional
description: string
src/api/resources/sheets/types/SheetConfig.ts:12
• fields: Property
[]
src/api/resources/sheets/types/SheetConfig.ts:16
• name: string
src/api/resources/sheets/types/SheetConfig.ts:11
• Optional
readonly: boolean
src/api/resources/sheets/types/SheetConfig.ts:14
• Optional
slug: string
src/api/resources/sheets/types/SheetConfig.ts:13
@flatfile/api / Exports / Flatfile / sheets / SheetResponse
• data: Sheet
src/api/resources/sheets/types/SheetResponse.ts:8
@flatfile/api / Exports / Flatfile / spaces / EventToken
Properties used to allow users to connect to the event bus
• Optional
accountId: string
src/api/resources/spaces/types/EventToken.ts:11
• Optional
subscribeKey: string
The id of the event bus to subscribe to
src/api/resources/spaces/types/EventToken.ts:13
• Optional
token: string
src/api/resources/spaces/types/EventToken.ts:16
• Optional
ttl: number
Time to live in minutes
src/api/resources/spaces/types/EventToken.ts:15
@flatfile/api / Exports / Flatfile / spaces / EventTokenResponse
Flatfile.spaces.EventTokenResponse
• data: EventToken
src/api/resources/spaces/types/EventTokenResponse.ts:8
@flatfile/api / Exports / Flatfile / spaces / ListSpacesRequest
Flatfile.spaces.ListSpacesRequest
• Optional
archived: boolean
src/api/resources/spaces/client/requests/ListSpacesRequest.ts:18
• Optional
environmentId: string
src/api/resources/spaces/client/requests/ListSpacesRequest.ts:8
• Optional
pageNumber: number
Based on pageSize, which page of records to return
src/api/resources/spaces/client/requests/ListSpacesRequest.ts:16
• Optional
pageSize: number
Number of spaces to return in a page (default 10)
src/api/resources/spaces/client/requests/ListSpacesRequest.ts:12
• Optional
search: string
src/api/resources/spaces/client/requests/ListSpacesRequest.ts:17
• Optional
sortDirection: SortDirection
src/api/resources/spaces/client/requests/ListSpacesRequest.ts:20
• Optional
sortField: GetSpacesSortField
src/api/resources/spaces/client/requests/ListSpacesRequest.ts:19
@flatfile/api / Exports / Flatfile / spaces / ListSpacesResponse
Flatfile.spaces.ListSpacesResponse
• data: Space
[]
src/api/resources/spaces/types/ListSpacesResponse.ts:9
• Optional
pagination: Pagination
src/api/resources/spaces/types/ListSpacesResponse.ts:8
@flatfile/api / Exports / Flatfile / spaces / Space
A place to store your workbooks
-
↳
Space
- access
- accessToken
- actions
- archivedAt
- autoConfigure
- createdAt
- createdByUserId
- createdByUserName
- displayOrder
- environmentId
- filesCount
- guestAuthentication
- guestLink
- id
- metadata
- name
- primaryWorkbookId
- spaceConfigId
- updatedAt
- workbookCount
• Optional
access: SpaceAccess
[]
src/api/resources/spaces/types/SpaceConfig.ts:22
• Optional
accessToken: string
src/api/resources/spaces/types/Space.ts:27
• Optional
actions: Action
[]
src/api/resources/spaces/types/SpaceConfig.ts:20
• Optional
archivedAt: Date
Date when space was archived
src/api/resources/spaces/types/Space.ts:24
• Optional
autoConfigure: boolean
src/api/resources/spaces/types/SpaceConfig.ts:23
• createdAt: Date
Date when space was created
src/api/resources/spaces/types/Space.ts:20
• Optional
createdByUserId: string
src/api/resources/spaces/types/Space.ts:16
• Optional
createdByUserName: string
User name who created space
src/api/resources/spaces/types/Space.ts:18
• Optional
displayOrder: number
The display order
src/api/resources/spaces/types/SpaceConfig.ts:17
• environmentId: string
src/api/resources/spaces/types/SpaceConfig.ts:12
• Optional
filesCount: number
Amount of files in the space
src/api/resources/spaces/types/Space.ts:15
• Optional
guestAuthentication: GuestAuthenticationEnum
[]
SpaceConfig.guestAuthentication
src/api/resources/spaces/types/SpaceConfig.ts:21
• Optional
guestLink: string
Guest link to the space
src/api/resources/spaces/types/Space.ts:26
• id: string
src/api/resources/spaces/types/Space.ts:11
• Optional
metadata: unknown
Metadata for the space
src/api/resources/spaces/types/SpaceConfig.ts:19
• Optional
name: string
The name of the space
src/api/resources/spaces/types/SpaceConfig.ts:15
• Optional
primaryWorkbookId: string
src/api/resources/spaces/types/SpaceConfig.ts:13
• Optional
spaceConfigId: string
src/api/resources/spaces/types/SpaceConfig.ts:11
• updatedAt: Date
Date when space was updated
src/api/resources/spaces/types/Space.ts:22
• Optional
workbookCount: number
Amount of workbooks in the space
src/api/resources/spaces/types/Space.ts:13
@flatfile/api / Exports / Flatfile / spaces / SpaceConfig
Properties used to create a new Space
-
SpaceConfig
↳
Space
- access
- actions
- autoConfigure
- displayOrder
- environmentId
- guestAuthentication
- metadata
- name
- primaryWorkbookId
- spaceConfigId
• Optional
access: SpaceAccess
[]
src/api/resources/spaces/types/SpaceConfig.ts:22
• Optional
actions: Action
[]
src/api/resources/spaces/types/SpaceConfig.ts:20
• Optional
autoConfigure: boolean
src/api/resources/spaces/types/SpaceConfig.ts:23
• Optional
displayOrder: number
The display order
src/api/resources/spaces/types/SpaceConfig.ts:17
• environmentId: string
src/api/resources/spaces/types/SpaceConfig.ts:12
• Optional
guestAuthentication: GuestAuthenticationEnum
[]
src/api/resources/spaces/types/SpaceConfig.ts:21
• Optional
metadata: unknown
Metadata for the space
src/api/resources/spaces/types/SpaceConfig.ts:19
• Optional
name: string
The name of the space
src/api/resources/spaces/types/SpaceConfig.ts:15
• Optional
primaryWorkbookId: string
src/api/resources/spaces/types/SpaceConfig.ts:13
• Optional
spaceConfigId: string
src/api/resources/spaces/types/SpaceConfig.ts:11
@flatfile/api / Exports / Flatfile / spaces / SpaceResponse
• data: Space
src/api/resources/spaces/types/SpaceResponse.ts:8
@flatfile/api / Exports / Flatfile / users / ApiToken
Client id and secret used for authenticating against our APIs
• clientId: string
src/api/resources/users/types/ApiToken.ts:9
• createdAt: Date
src/api/resources/users/types/ApiToken.ts:12
• description: string
src/api/resources/users/types/ApiToken.ts:10
• metadata: Record
<string
, unknown
>
src/api/resources/users/types/ApiToken.ts:11
• Optional
secret: string
src/api/resources/users/types/ApiToken.ts:13
@flatfile/api / Exports / Flatfile / users / CreateApiTokenRequest
Flatfile.users.CreateApiTokenRequest
This file was auto-generated by Fern from our API Definition.
• tenantId: string
src/api/resources/users/client/requests/CreateApiTokenRequest.ts:6
@flatfile/api / Exports / Flatfile / users / ExchangeTokenData
Flatfile.users.ExchangeTokenData
This file was auto-generated by Fern from our API Definition.
• Optional
sentTo: string
The email address the recovery email was sent to, if the provided token was not valid
src/api/resources/users/types/ExchangeTokenData.ts:11
• Optional
token: string
The refreshed token, if the provided token was valid
src/api/resources/users/types/ExchangeTokenData.ts:9
• valid: boolean
Whether the provided token was valid
src/api/resources/users/types/ExchangeTokenData.ts:7
@flatfile/api / Exports / Flatfile / users / ExchangeTokenRequest
Flatfile.users.ExchangeTokenRequest
This file was auto-generated by Fern from our API Definition.
• Optional
email: string
The invited guest's email, required if no token
src/api/resources/users/client/requests/ExchangeTokenRequest.ts:9
• Optional
spaceId: string
The spaceId, required if no token
src/api/resources/users/client/requests/ExchangeTokenRequest.ts:11
• Optional
token: string
The token to use for the request
src/api/resources/users/client/requests/ExchangeTokenRequest.ts:7
@flatfile/api / Exports / Flatfile / users / ExchangeTokenResponse
Flatfile.users.ExchangeTokenResponse
• data: ExchangeTokenData
src/api/resources/users/types/ExchangeTokenResponse.ts:8
@flatfile/api / Exports / Flatfile / users / ListApiTokensRequest
Flatfile.users.ListApiTokensRequest
This file was auto-generated by Fern from our API Definition.
• Optional
pageNumber: number
Based on pageSize, which page of records to return
src/api/resources/users/client/requests/ListApiTokensRequest.ts:14
• Optional
pageSize: number
Number of tokens to return in a page (default 10)
src/api/resources/users/client/requests/ListApiTokensRequest.ts:10
• tenantId: string
src/api/resources/users/client/requests/ListApiTokensRequest.ts:6
@flatfile/api / Exports / Flatfile / users / ListApiTokensResponse
Flatfile.users.ListApiTokensResponse
List of api tokens without secrets
• data: ApiToken
[]
src/api/resources/users/types/ListApiTokensResponse.ts:12
• Optional
pagination: Pagination
src/api/resources/users/types/ListApiTokensResponse.ts:11
@flatfile/api / Exports / Flatfile / users / ListUsersRequest
Flatfile.users.ListUsersRequest
This file was auto-generated by Fern from our API Definition.
• Optional
email: string
Email of guest to return
src/api/resources/users/client/requests/ListUsersRequest.ts:9
@flatfile/api / Exports / Flatfile / users / ListUsersResponse
Flatfile.users.ListUsersResponse
• data: User
[]
src/api/resources/users/types/ListUsersResponse.ts:8
@flatfile/api / Exports / Flatfile / users / User
Configurations for the user
-
↳
User
• accountId: string
src/api/resources/users/types/UserConfig.ts:13
• email: string
src/api/resources/users/types/UserConfig.ts:11
• id: string
src/api/resources/users/types/User.ts:11
• name: string
src/api/resources/users/types/UserConfig.ts:12
@flatfile/api / Exports / Flatfile / users / UserConfig
Properties used to create a new user
-
UserConfig
↳
User
• accountId: string
src/api/resources/users/types/UserConfig.ts:13
• email: string
src/api/resources/users/types/UserConfig.ts:11
• name: string
src/api/resources/users/types/UserConfig.ts:12
@flatfile/api / Exports / Flatfile / users / UserResponse
• data: User
src/api/resources/users/types/UserResponse.ts:8
@flatfile/api / Exports / Flatfile / versions / VersionResponse
Flatfile.versions.VersionResponse
• versionId: string
src/api/resources/versions/types/VersionResponse.ts:8
@flatfile/api / Exports / Flatfile / versions / VersionsPostRequestBody
Flatfile.versions.VersionsPostRequestBody
• Optional
parentVersionId: string
src/api/resources/versions/client/requests/VersionsPostRequestBody.ts:9
• Optional
sheetId: string
src/api/resources/versions/client/requests/VersionsPostRequestBody.ts:8
@flatfile/api / Exports / Flatfile / workbooks / CreateWorkbookConfig
Flatfile.workbooks.CreateWorkbookConfig
Properties used to create a new Workbook
• Optional
actions: Action
[]
src/api/resources/workbooks/types/CreateWorkbookConfig.ts:17
• Optional
environmentId: string
src/api/resources/workbooks/types/CreateWorkbookConfig.ts:14
• Optional
labels: string
[]
src/api/resources/workbooks/types/CreateWorkbookConfig.ts:12
• name: string
src/api/resources/workbooks/types/CreateWorkbookConfig.ts:11
• Optional
sheets: SheetConfig
[]
Sheets must be <= 50
src/api/resources/workbooks/types/CreateWorkbookConfig.ts:16
• Optional
spaceId: string
src/api/resources/workbooks/types/CreateWorkbookConfig.ts:13
@flatfile/api / Exports / Flatfile / workbooks / ListWorkbooksRequest
Flatfile.workbooks.ListWorkbooksRequest
• Optional
includeCounts: boolean
Include counts for the workbook
src/api/resources/workbooks/client/requests/ListWorkbooksRequest.ts:12
• Optional
spaceId: string
src/api/resources/workbooks/client/requests/ListWorkbooksRequest.ts:8
@flatfile/api / Exports / Flatfile / workbooks / ListWorkbooksResponse
Flatfile.workbooks.ListWorkbooksResponse
• data: Workbook
[]
src/api/resources/workbooks/types/ListWorkbooksResponse.ts:8
@flatfile/api / Exports / Flatfile / workbooks / UpdateWorkbookConfig
Flatfile.workbooks.UpdateWorkbookConfig
Properties used to create a new Workbook
• Optional
actions: Action
[]
src/api/resources/workbooks/types/UpdateWorkbookConfig.ts:17
• Optional
environmentId: string
src/api/resources/workbooks/types/UpdateWorkbookConfig.ts:14
• Optional
labels: string
[]
src/api/resources/workbooks/types/UpdateWorkbookConfig.ts:12
• Optional
name: string
src/api/resources/workbooks/types/UpdateWorkbookConfig.ts:11
• Optional
sheets: SheetConfig
[]
Sheets must be <= 50
src/api/resources/workbooks/types/UpdateWorkbookConfig.ts:16
• Optional
spaceId: string
src/api/resources/workbooks/types/UpdateWorkbookConfig.ts:13
@flatfile/api / Exports / Flatfile / workbooks / Workbook
A collection of one or more sheets
• Optional
actions: Action
[]
src/api/resources/workbooks/types/Workbook.ts:17
• createdAt: Date
Date the workbook was created
src/api/resources/workbooks/types/Workbook.ts:21
• Optional
environmentId: string
src/api/resources/workbooks/types/Workbook.ts:14
• id: string
src/api/resources/workbooks/types/Workbook.ts:11
• Optional
labels: string
[]
src/api/resources/workbooks/types/Workbook.ts:16
• Optional
name: string
src/api/resources/workbooks/types/Workbook.ts:12
• Optional
sheets: Sheet
[]
src/api/resources/workbooks/types/Workbook.ts:15
• spaceId: string
src/api/resources/workbooks/types/Workbook.ts:13
• updatedAt: Date
Date the workbook was last updated
src/api/resources/workbooks/types/Workbook.ts:19
@flatfile/api / Exports / Flatfile / workbooks / WorkbookResponse
Flatfile.workbooks.WorkbookResponse
• data: Workbook
src/api/resources/workbooks/types/WorkbookResponse.ts:8
@flatfile/api / Exports / FlatfileClient / Options
FlatfileClient.Options
• Optional
apiUrl: string
src/wrapper/FlatfileClient.ts:16
• Optional
environment: Supplier
<string
>
Deprecated
use apiUrl instead
src/wrapper/FlatfileClient.ts:15
• Optional
token: Supplier
<string
>
src/wrapper/FlatfileClient.ts:17
@flatfile/api / Exports
Ƭ FlatfileEnvironment: typeof Production
• Const
FlatfileEnvironment: Object
This file was auto-generated by Fern from our API Definition.
Name | Type |
---|---|
Production |
"https://platform.flatfile.com/api/v1" |
• default: FlatfileClient
@flatfile/api / Exports / Flatfile / agents
Flatfile.agents
- Agent
- AgentConfig
- AgentLog
- AgentResponse
- CreateAgentsRequest
- DeleteAgentRequest
- GetAgentLogsRequest
- GetAgentLogsResponse
- GetAgentRequest
- GetEnvironmentAgentLogsRequest
- ListAgentsRequest
- ListAgentsResponse
Ƭ Compiler: "js"
The compiler of the agent
Example
Flatfile.Compiler.Js
src/api/resources/agents/types/Compiler.ts:11
src/api/resources/agents/types/Compiler.ts:13
• Compiler: Object
Name | Type |
---|---|
Js |
"js" |
src/api/resources/agents/types/Compiler.ts:11
src/api/resources/agents/types/Compiler.ts:13
@flatfile/api / Exports / Flatfile / auth
Flatfile.auth
Ƭ ApiKeyType: "PUBLISHABLE"
| "SECRET"
This file was auto-generated by Fern from our API Definition.
src/api/resources/auth/types/ApiKeyType.ts:5
src/api/resources/auth/types/ApiKeyType.ts:7
• ApiKeyType: Object
Name | Type |
---|---|
Publishable |
"PUBLISHABLE" |
Secret |
"SECRET" |
src/api/resources/auth/types/ApiKeyType.ts:5
src/api/resources/auth/types/ApiKeyType.ts:7
@flatfile/api / Exports / Flatfile / billing
Flatfile.billing
@flatfile/api / Exports / Flatfile / cells
Flatfile.cells
Ƭ CellsResponseData: Record
<string
, CellValueWithCounts
[]>
Cell values grouped by field key
src/api/resources/cells/types/CellsResponseData.ts:10
@flatfile/api / Exports / Flatfile / commons
Flatfile.commons
- AccountId
- ActionMode
- AgentId
- DocumentId
- EnvironmentId
- EventId
- FileId
- Filter
- FilterField
- GuestId
- JobId
- RecordId
- SearchField
- SearchValue
- SheetId
- SortDirection
- SortField
- SpaceConfigId
- SpaceId
- UserId
- VersionId
- WorkbookId
Ƭ AccountId: string
Account ID
Example
"us_acc_uj6s91wc"
src/api/resources/commons/types/AccountId.ts:11
Ƭ ActionMode: "foreground"
| "background"
This file was auto-generated by Fern from our API Definition.
src/api/resources/commons/types/ActionMode.ts:5
src/api/resources/commons/types/ActionMode.ts:7
Ƭ AgentId: string
Agent ID
Example
"us_ag_qGZbKwDW"
src/api/resources/commons/types/AgentId.ts:11
Ƭ DocumentId: string
Document ID
Example
"us_dc_KwDW6cfH"
src/api/resources/commons/types/DocumentId.ts:11
Ƭ EnvironmentId: string
Environment ID
Example
"us_env_hVXkXs0b"
src/api/resources/commons/types/EnvironmentId.ts:11
Ƭ EventId: string
Event ID
Example
"us_evt_9cuesESa7W9cuesE"
src/api/resources/commons/types/EventId.ts:11
Ƭ FileId: string
File ID
Example
"us_fl_qGZbKwDW"
src/api/resources/commons/types/FileId.ts:11
Ƭ Filter: "valid"
| "error"
| "all"
| "none"
Options to filter records
src/api/resources/commons/types/Filter.ts:8
src/api/resources/commons/types/Filter.ts:10
Ƭ FilterField: string
Use this to narrow the valid/error filter results to a specific field
src/api/resources/commons/types/FilterField.ts:8
Ƭ GuestId: string
Guest ID
Example
"us_g_5ue7P9cU"
src/api/resources/commons/types/GuestId.ts:11
Ƭ JobId: string
Pipeline Job ID
Example
"us_jb_UQg89Drd"
src/api/resources/commons/types/JobId.ts:11
Ƭ RecordId: string
Record ID
Example
"us_rc_a7W9cuesESa7W9cu"
src/api/resources/commons/types/RecordId.ts:11
Ƭ SearchField: string
Use this to narrow the searchValue results to a specific field
src/api/resources/commons/types/SearchField.ts:8
Ƭ SearchValue: string
Search the entire sheet for the given value, returning matching rows
src/api/resources/commons/types/SearchValue.ts:8
Ƭ SheetId: string
Sheet ID
Example
"us_sh_fHfzjzHb"
src/api/resources/commons/types/SheetId.ts:11
Ƭ SortDirection: "asc"
| "desc"
Sort direction - asc (ascending) or desc (descending)
Example
Flatfile.SortDirection.Asc
src/api/resources/commons/types/SortDirection.ts:11
src/api/resources/commons/types/SortDirection.ts:13
Ƭ SortField: string
Name of field by which to sort records
src/api/resources/commons/types/SortField.ts:8
Ƭ SpaceConfigId: string
Space Config ID
Example
"us_sc_uj691wck"
src/api/resources/commons/types/SpaceConfigId.ts:11
Ƭ SpaceId: string
Space ID
Example
"us_sp_DrdXetPN"
src/api/resources/commons/types/SpaceId.ts:11
Ƭ UserId: string
User ID
Example
"us_usr_a7Ws9cue"
src/api/resources/commons/types/UserId.ts:11
Ƭ VersionId: string
Version ID
Example
"us_vr_jte4tzVn"
src/api/resources/commons/types/VersionId.ts:11
Ƭ WorkbookId: string
Workbook ID
Example
"us_wb_qGZbKwDW"
src/api/resources/commons/types/WorkbookId.ts:11
• ActionMode: Object
Name | Type |
---|---|
Background |
"background" |
Foreground |
"foreground" |
src/api/resources/commons/types/ActionMode.ts:5
src/api/resources/commons/types/ActionMode.ts:7
• Filter: Object
Name | Type |
---|---|
All |
"all" |
Error |
"error" |
None |
"none" |
Valid |
"valid" |
src/api/resources/commons/types/Filter.ts:8
src/api/resources/commons/types/Filter.ts:10
• SortDirection: Object
Name | Type |
---|---|
Asc |
"asc" |
Desc |
"desc" |
src/api/resources/commons/types/SortDirection.ts:11
src/api/resources/commons/types/SortDirection.ts:13
@flatfile/api / Exports / Flatfile / documents
Flatfile.documents
@flatfile/api / Exports / Flatfile / environments
Flatfile.environments
Ƭ GuestAuthenticationEnum: "shared_link"
| "magic_link"
The type of authentication to use for guests
src/api/resources/environments/types/GuestAuthenticationEnum.ts:8
src/api/resources/environments/types/GuestAuthenticationEnum.ts:10
• GuestAuthenticationEnum: Object
Name | Type |
---|---|
MagicLink |
"magic_link" |
SharedLink |
"shared_link" |
src/api/resources/environments/types/GuestAuthenticationEnum.ts:8
src/api/resources/environments/types/GuestAuthenticationEnum.ts:10
@flatfile/api / Exports / Flatfile / events / Event
- ActionTriggered
- ClientInitialized
- FileDeleted
- JobCompleted
- JobDeleted
- JobFailed
- JobStarted
- JobUpdated
- JobWaiting
- RecordsCreated
- RecordsDeleted
- RecordsUpdated
- SheetValidated
- SpaceAdded
- SpaceRemoved
- UploadCompleted
- UploadFailed
- UploadStarted
- UserAdded
- UserOffline
- UserOnline
- UserRemoved
- WorkbookAdded
- WorkbookRemoved
- WorkbookUpdated
@flatfile/api / Exports / Flatfile / events
Flatfile.events
- ActionTriggeredEvent
- BaseEvent
- ClientInitializedEvent
- Context
- EventAttributes
- EventResponse
- FileDeletedEvent
- GetEventTokenRequest
- JobCompletedEvent
- JobDeletedEvent
- JobFailedEvent
- JobFailedPayload
- JobPayload
- JobStartedEvent
- JobUpdatedEvent
- JobWaitingEvent
- ListAllEventsResponse
- ListEventsRequest
- Origin
- Progress
- RecordsCreatedEvent
- RecordsDeletedEvent
- RecordsPayload
- RecordsUpdatedEvent
- SheetValidatedEvent
- SpaceAddedEvent
- SpaceRemovedEvent
- UploadCompletedEvent
- UploadFailedEvent
- UploadStartedEvent
- UserAddedEvent
- UserOfflineEvent
- UserOnlineEvent
- UserRemovedEvent
- WorkbookAddedEvent
- WorkbookRemovedEvent
- WorkbookUpdatedEvent
Ƭ ActionName: string
Name of an action
src/api/resources/events/types/ActionName.ts:8
Ƭ Domain: "file"
| "space"
| "workbook"
| "job"
The domain of the event
Example
Flatfile.Domain.Job
src/api/resources/events/types/Domain.ts:11
src/api/resources/events/types/Domain.ts:13
Ƭ Event: SpaceAdded
| SpaceRemoved
| WorkbookAdded
| WorkbookUpdated
| WorkbookRemoved
| UserAdded
| UserRemoved
| UserOnline
| UserOffline
| UploadStarted
| UploadFailed
| UploadCompleted
| JobStarted
| JobWaiting
| JobUpdated
| JobFailed
| JobCompleted
| JobDeleted
| RecordsCreated
| RecordsUpdated
| RecordsDeleted
| SheetValidated
| ActionTriggered
| FileDeleted
| ClientInitialized
Properties used to create a new event
src/api/resources/events/types/Event.ts:10
src/api/resources/events/types/Event.ts:37
Ƭ EventTopic: "agent:created"
| "agent:updated"
| "agent:deleted"
| "space:created"
| "space:updated"
| "space:deleted"
| "workbook:created"
| "workbook:updated"
| "workbook:deleted"
| "sheet:created"
| "sheet:updated"
| "sheet:deleted"
| "record:created"
| "record:updated"
| "record:deleted"
| "file:created"
| "file:updated"
| "file:deleted"
| "job:created"
| "job:updated"
| "job:deleted"
| "job:completed"
| "job:ready"
| "job:scheduled"
| "job:outcome_acknowledged"
| "job:failed"
| "commit:created"
| "commit:updated"
| "layer:created"
The topic of the event
Example
Flatfile.EventTopic.FileCreated
src/api/resources/events/types/EventTopic.ts:11
src/api/resources/events/types/EventTopic.ts:42
Ƭ JobOperationType: "EXTRACT"
| "MAP"
This file was auto-generated by Fern from our API Definition.
src/api/resources/events/types/JobOperationType.ts:5
src/api/resources/events/types/JobOperationType.ts:7
Ƭ JobPayloadType: "FILE"
| "PIPELINE"
This file was auto-generated by Fern from our API Definition.
src/api/resources/events/types/JobPayloadType.ts:5
src/api/resources/events/types/JobPayloadType.ts:7
Ƭ SheetSlug: string
Sheet Slug
src/api/resources/events/types/SheetSlug.ts:8
• Domain: Object
Name | Type |
---|---|
File |
"file" |
Job |
"job" |
Space |
"space" |
Workbook |
"workbook" |
src/api/resources/events/types/Domain.ts:11
src/api/resources/events/types/Domain.ts:13
• EventTopic: Object
Name | Type |
---|---|
AgentCreated |
"agent:created" |
AgentDeleted |
"agent:deleted" |
AgentUpdated |
"agent:updated" |
CommitCreated |
"commit:created" |
CommitUpdated |
"commit:updated" |
FileCreated |
"file:created" |
FileDeleted |
"file:deleted" |
FileUpdated |
"file:updated" |
JobCompleted |
"job:completed" |
JobCreated |
"job:created" |
JobDeleted |
"job:deleted" |
JobFailed |
"job:failed" |
JobOutcomeAcknowledged |
"job:outcome_acknowledged" |
JobReady |
"job:ready" |
JobScheduled |
"job:scheduled" |
JobUpdated |
"job:updated" |
LayerCreated |
"layer:created" |
RecordCreated |
"record:created" |
RecordDeleted |
"record:deleted" |
RecordUpdated |
"record:updated" |
SheetCreated |
"sheet:created" |
SheetDeleted |
"sheet:deleted" |
SheetUpdated |
"sheet:updated" |
SpaceCreated |
"space:created" |
SpaceDeleted |
"space:deleted" |
SpaceUpdated |
"space:updated" |
WorkbookCreated |
"workbook:created" |
WorkbookDeleted |
"workbook:deleted" |
WorkbookUpdated |
"workbook:updated" |
src/api/resources/events/types/EventTopic.ts:11
src/api/resources/events/types/EventTopic.ts:42
• JobOperationType: Object
Name | Type |
---|---|
Extract |
"EXTRACT" |
Map |
"MAP" |
src/api/resources/events/types/JobOperationType.ts:5
src/api/resources/events/types/JobOperationType.ts:7
• JobPayloadType: Object
Name | Type |
---|---|
File |
"FILE" |
Pipeline |
"PIPELINE" |
src/api/resources/events/types/JobPayloadType.ts:5
src/api/resources/events/types/JobPayloadType.ts:7
@flatfile/api / Exports / Flatfile / files
Flatfile.files
Ƭ Mode: "import"
| "export"
This file was auto-generated by Fern from our API Definition.
src/api/resources/files/types/Mode.ts:5
src/api/resources/files/types/Mode.ts:7
Ƭ ModelFileStatusEnum: "partial"
| "complete"
| "archived"
| "purged"
| "failed"
This file was auto-generated by Fern from our API Definition.
src/api/resources/files/types/ModelFileStatusEnum.ts:5
src/api/resources/files/types/ModelFileStatusEnum.ts:7
• Mode: Object
Name | Type |
---|---|
Export |
"export" |
Import |
"import" |
src/api/resources/files/types/Mode.ts:5
src/api/resources/files/types/Mode.ts:7
• ModelFileStatusEnum: Object
Name | Type |
---|---|
Archived |
"archived" |
Complete |
"complete" |
Failed |
"failed" |
Partial |
"partial" |
Purged |
"purged" |
src/api/resources/files/types/ModelFileStatusEnum.ts:5
src/api/resources/files/types/ModelFileStatusEnum.ts:7
@flatfile/api / Exports / Flatfile / guests
Flatfile.guests
- CreateGuestResponse
- Guest
- GuestConfig
- GuestSpace
- GuestWorkbook
- Invite
- ListGuestsRequest
- ListGuestsResponse
@flatfile/api / Exports / Flatfile / jobs
Flatfile.jobs
- AiAssistJobConfig
- CategoryMapping
- DeleteJobConfig
- DestinationField
- Edge
- EmptyObject
- EnumDetails
- ExportJobConfig
- ExportOptions
- FileJobConfig
- FindAndReplaceJobConfig
- Job
- JobAckDetails
- JobConfig
- JobExecutionPlan
- JobExecutionPlanConfig
- JobOutcome
- JobPlan
- JobResponse
- JobUpdate
- ListJobsRequest
- ListJobsResponse
- Metadata
- MutateJobConfig
- PipelineJobConfig
- SourceField
Ƭ Certainty: "absolute"
| "strong"
| "moderate"
| "weak"
This file was auto-generated by Fern from our API Definition.
src/api/resources/jobs/types/Certainty.ts:5
src/api/resources/jobs/types/Certainty.ts:7
Ƭ Driver: "csv"
The driver to use for extracting data from the file
src/api/resources/jobs/types/Driver.ts:8
src/api/resources/jobs/types/Driver.ts:10
Ƭ JobDestination: WorkbookId
The id of the workbook where extracted file data will be sent
src/api/resources/jobs/types/JobDestination.ts:10
Ƭ JobMode: "foreground"
| "background"
the mode of the job
src/api/resources/jobs/types/JobMode.ts:8
src/api/resources/jobs/types/JobMode.ts:10
Ƭ JobSource: string
The id of a file, workbook, or sheet
src/api/resources/jobs/types/JobSource.ts:8
Ƭ JobStatus: "planning"
| "ready"
| "executing"
| "complete"
| "failed"
the status of the job
src/api/resources/jobs/types/JobStatus.ts:8
src/api/resources/jobs/types/JobStatus.ts:10
Ƭ JobType: "file"
| "workbook"
| "sheet"
The type of job
src/api/resources/jobs/types/JobType.ts:8
src/api/resources/jobs/types/JobType.ts:10
Ƭ JobUpdateConfig: DeleteJobConfig
| FileJobConfig
| PipelineJobConfig
| ExportJobConfig
| MutateJobConfig
| AiAssistJobConfig
| FindAndReplaceJobConfig
| EmptyObject
src/api/resources/jobs/types/JobUpdateConfig.ts:7
Ƭ Trigger: "manual"
| "immediate"
the type of trigger to use for this job
src/api/resources/jobs/types/Trigger.ts:8
src/api/resources/jobs/types/Trigger.ts:10
• Certainty: Object
Name | Type |
---|---|
Absolute |
"absolute" |
Moderate |
"moderate" |
Strong |
"strong" |
Weak |
"weak" |
src/api/resources/jobs/types/Certainty.ts:5
src/api/resources/jobs/types/Certainty.ts:7
• Driver: Object
Name | Type |
---|---|
Csv |
"csv" |
src/api/resources/jobs/types/Driver.ts:8
src/api/resources/jobs/types/Driver.ts:10
• JobMode: Object
Name | Type |
---|---|
Background |
"background" |
Foreground |
"foreground" |
src/api/resources/jobs/types/JobMode.ts:8
src/api/resources/jobs/types/JobMode.ts:10
• JobStatus: Object
Name | Type |
---|---|
Complete |
"complete" |
Executing |
"executing" |
Failed |
"failed" |
Planning |
"planning" |
Ready |
"ready" |
src/api/resources/jobs/types/JobStatus.ts:8
src/api/resources/jobs/types/JobStatus.ts:10
• JobType: Object
Name | Type |
---|---|
File |
"file" |
Sheet |
"sheet" |
Workbook |
"workbook" |
src/api/resources/jobs/types/JobType.ts:8
src/api/resources/jobs/types/JobType.ts:10
• Trigger: Object
Name | Type |
---|---|
Immediate |
"immediate" |
Manual |
"manual" |
src/api/resources/jobs/types/Trigger.ts:8
src/api/resources/jobs/types/Trigger.ts:10
@flatfile/api / Exports / Flatfile
- AccountId
- Action
- ActionMode
- ActionName
- ActionTriggeredEvent
- Agent
- AgentConfig
- AgentId
- AgentLog
- AgentResponse
- AiAssistJobConfig
- ApiKey
- ApiKeyOperation
- ApiKeyType
- ApiKeysResponse
- ApiToken
- ArrayableProperty
- BadRequestError
- BaseEvent
- BaseProperty
- BooleanProperty
- BooleanPropertyConfig
- CategoryMapping
- CellValue
- CellValueUnion
- CellValueWithCounts
- CellValueWithLinks
- CellsResponse
- CellsResponseData
- Certainty
- CheckoutSession
- ClientInitializedEvent
- Compiler
- Constraint
- Context
- CreateAgentsRequest
- CreateApiTokenRequest
- CreateCheckoutSessionResponse
- CreateFileRequest
- CreateGuestResponse
- CreateWorkbookConfig
- DateProperty
- DeleteAgentRequest
- DeleteJobConfig
- DeleteRecordsRequest
- DestinationField
- Document
- DocumentConfig
- DocumentId
- DocumentResponse
- Domain
- Driver
- Edge
- EmptyObject
- EnumDetails
- EnumProperty
- EnumPropertyConfig
- EnumPropertyOption
- Environment
- EnvironmentConfig
- EnvironmentId
- EnvironmentResponse
- Error_
- Event
- EventAttributes
- EventId
- EventResponse
- EventTopic
- ExchangeTokenData
- ExchangeTokenRequest
- ExchangeTokenResponse
- ExportJobConfig
- ExportOptions
- FileDeletedEvent
- FileId
- FileJobConfig
- FileResponse
- File_
- Filter
- FilterField
- FindAndReplaceJobConfig
- FindAndReplaceRecordRequest
- FindAndReplaceRecordRequestDeprecated
- FindRecordsRequest
- GetAgentLogsRequest
- GetAgentLogsResponse
- GetAgentRequest
- GetApiKeysRequest
- GetEnvironmentAgentLogsRequest
- GetEventTokenRequest
- GetFieldValuesRequest
- GetRecordCountsRequest
- GetRecordsCsvRequest
- GetRecordsRequest
- Guest
- GuestAuthenticationEnum
- GuestConfig
- GuestId
- GuestSpace
- GuestWorkbook
- Invite
- Job
- JobAckDetails
- JobCompletedEvent
- JobConfig
- JobDeletedEvent
- JobDestination
- JobExecutionPlan
- JobExecutionPlanConfig
- JobFailedEvent
- JobFailedPayload
- JobId
- JobMode
- JobOperationType
- JobOutcome
- JobPayload
- JobPayloadType
- JobPlan
- JobResponse
- JobSource
- JobStartedEvent
- JobStatus
- JobType
- JobUpdate
- JobUpdateConfig
- JobUpdatedEvent
- JobWaitingEvent
- ListAgentsRequest
- ListAgentsResponse
- ListAllEventsResponse
- ListApiTokensRequest
- ListApiTokensResponse
- ListDocumentsResponse
- ListEnvironmentsRequest
- ListEnvironmentsResponse
- ListEventsRequest
- ListFilesRequest
- ListFilesResponse
- ListGuestsRequest
- ListGuestsResponse
- ListJobsRequest
- ListJobsResponse
- ListSheetsRequest
- ListSheetsResponse
- ListUsersRequest
- ListUsersResponse
- ListWorkbooksRequest
- ListWorkbooksResponse
- Metadata
- Mode
- ModelFileStatusEnum
- MutateJobConfig
- NotFoundError
- NumberConfig
- NumberProperty
- Origin
- Pagination
- PipelineJobConfig
- ProductsResponse
- Progress
- Property
- RecordCounts
- RecordCountsResponse
- RecordCountsResponseData
- RecordData
- RecordDataWithLinks
- RecordId
- RecordWithLinks
- Record_
- Records
- RecordsCreatedEvent
- RecordsDeletedEvent
- RecordsPayload
- RecordsResponse
- RecordsResponseData
- RecordsUpdatedEvent
- RecordsWithLinks
- ReferenceProperty
- ReferencePropertyConfig
- ReferencePropertyRelationship
- SearchField
- SearchValue
- Sheet
- SheetAccess
- SheetConfig
- SheetId
- SheetResponse
- SheetSlug
- SheetValidatedEvent
- SortDirection
- SortField
- SourceField
- SpaceAddedEvent
- SpaceConfigId
- SpaceId
- SpaceRemovedEvent
- StringConfig
- StringConfigOptions
- StringProperty
- StripeProduct
- Success
- SuccessData
- Trigger
- UniqueConstraint
- UniqueConstraintConfig
- UpdateFileRequest
- UpdateWorkbookConfig
- UploadCompletedEvent
- UploadFailedEvent
- UploadStartedEvent
- User
- UserAddedEvent
- UserConfig
- UserId
- UserOfflineEvent
- UserOnlineEvent
- UserRemovedEvent
- UserResponse
- ValidationMessage
- ValidationSource
- ValidationType
- VersionId
- VersionResponse
- VersionsPostRequestBody
- Workbook
- WorkbookAddedEvent
- WorkbookId
- WorkbookRemovedEvent
- WorkbookResponse
- WorkbookUpdatedEvent
- agents
- auth
- billing
- cells
- commons
- documents
- environments
- events
- files
- guests
- jobs
- property
- records
- sheets
- spaces
- users
- versions
- workbooks
Re-exports AccountId
Re-exports Action
Re-exports ActionMode
Re-exports ActionName
Re-exports ActionTriggeredEvent
Re-exports Agent
Re-exports AgentConfig
Re-exports AgentId
Re-exports AgentLog
Re-exports AgentResponse
Re-exports AiAssistJobConfig
Re-exports ApiKey
Re-exports ApiKeyOperation
Re-exports ApiKeyType
Re-exports ApiKeysResponse
Re-exports ApiToken
Re-exports ArrayableProperty
Re-exports BadRequestError
Re-exports BaseEvent
Re-exports BaseProperty
Re-exports BooleanProperty
Re-exports BooleanPropertyConfig
Re-exports CategoryMapping
Re-exports CellValue
Re-exports CellValueUnion
Re-exports CellValueWithCounts
Re-exports CellValueWithLinks
Re-exports CellsResponse
Re-exports CellsResponseData
Re-exports Certainty
Re-exports CheckoutSession
Re-exports ClientInitializedEvent
Re-exports Compiler
Re-exports Constraint
Re-exports Context
Re-exports CreateAgentsRequest
Re-exports CreateApiTokenRequest
Re-exports CreateCheckoutSessionResponse
Re-exports CreateFileRequest
Re-exports CreateGuestResponse
Re-exports CreateWorkbookConfig
Re-exports DateProperty
Re-exports DeleteAgentRequest
Re-exports DeleteJobConfig
Re-exports DeleteRecordsRequest
Re-exports DestinationField
Re-exports Document
Re-exports DocumentConfig
Re-exports DocumentId
Re-exports DocumentResponse
Re-exports Domain
Re-exports Driver
Re-exports Edge
Re-exports EmptyObject
Re-exports EnumDetails
Re-exports EnumProperty
Re-exports EnumPropertyConfig
Re-exports EnumPropertyOption
Re-exports Environment
Re-exports EnvironmentConfig
Re-exports EnvironmentId
Re-exports EnvironmentResponse
Re-exports Error_
Re-exports Event
Re-exports EventAttributes
Re-exports EventId
Re-exports EventResponse
Re-exports EventTopic
Re-exports ExchangeTokenData
Re-exports ExchangeTokenRequest
Re-exports ExchangeTokenResponse
Re-exports ExportJobConfig
Re-exports ExportOptions
Re-exports FileDeletedEvent
Re-exports FileId
Re-exports FileJobConfig
Re-exports FileResponse
Re-exports File_
Re-exports Filter
Re-exports FilterField
Re-exports FindAndReplaceJobConfig
Re-exports FindAndReplaceRecordRequest
Re-exports FindAndReplaceRecordRequestDeprecated
Re-exports FindRecordsRequest
Re-exports GetAgentLogsRequest
Re-exports GetAgentLogsResponse
Re-exports GetAgentRequest
Re-exports GetApiKeysRequest
Re-exports GetEnvironmentAgentLogsRequest
Re-exports GetEventTokenRequest
Re-exports GetFieldValuesRequest
Re-exports GetRecordCountsRequest
Re-exports GetRecordsCsvRequest
Re-exports GetRecordsRequest
Re-exports Guest
Re-exports GuestAuthenticationEnum
Re-exports GuestConfig
Re-exports GuestId
Re-exports GuestSpace
Re-exports GuestWorkbook
Re-exports Invite
Re-exports Job
Re-exports JobAckDetails
Re-exports JobCompletedEvent
Re-exports JobConfig
Re-exports JobDeletedEvent
Re-exports JobDestination
Re-exports JobExecutionPlan
Re-exports JobExecutionPlanConfig
Re-exports JobFailedEvent
Re-exports JobFailedPayload
Re-exports JobId
Re-exports JobMode
Re-exports JobOperationType
Re-exports JobOutcome
Re-exports JobPayload
Re-exports JobPayloadType
Re-exports JobPlan
Re-exports JobResponse
Re-exports JobSource
Re-exports JobStartedEvent
Re-exports JobStatus
Re-exports JobType
Re-exports JobUpdate
Re-exports JobUpdateConfig
Re-exports JobUpdatedEvent
Re-exports JobWaitingEvent
Re-exports ListAgentsRequest
Re-exports ListAgentsResponse
Re-exports ListAllEventsResponse
Re-exports ListApiTokensRequest
Re-exports ListApiTokensResponse
Re-exports ListDocumentsResponse
Re-exports ListEnvironmentsRequest
Re-exports ListEnvironmentsResponse
Re-exports ListEventsRequest
Re-exports ListFilesRequest
Re-exports ListFilesResponse
Re-exports ListGuestsRequest
Re-exports ListGuestsResponse
Re-exports ListJobsRequest
Re-exports ListJobsResponse
Re-exports ListSheetsRequest
Re-exports ListSheetsResponse
Re-exports ListUsersRequest
Re-exports ListUsersResponse
Re-exports ListWorkbooksRequest
Re-exports ListWorkbooksResponse
Re-exports Metadata
Re-exports Mode
Re-exports ModelFileStatusEnum
Re-exports MutateJobConfig
Re-exports NotFoundError
Re-exports NumberConfig
Re-exports NumberProperty
Re-exports Origin
Re-exports Pagination
Re-exports PipelineJobConfig
Re-exports ProductsResponse
Re-exports Progress
Re-exports Property
Re-exports RecordCounts
Re-exports RecordCountsResponse
Re-exports RecordCountsResponseData
Re-exports RecordData
Re-exports RecordDataWithLinks
Re-exports RecordId
Re-exports RecordWithLinks
Re-exports Record_
Re-exports Records
Re-exports RecordsCreatedEvent
Re-exports RecordsDeletedEvent
Re-exports RecordsPayload
Re-exports RecordsResponse
Re-exports RecordsResponseData
Re-exports RecordsUpdatedEvent
Re-exports RecordsWithLinks
Re-exports ReferenceProperty
Re-exports ReferencePropertyConfig
Re-exports ReferencePropertyRelationship
Re-exports SearchField
Re-exports SearchValue
Re-exports Sheet
Re-exports SheetAccess
Re-exports SheetConfig
Re-exports SheetId
Re-exports SheetResponse
Re-exports SheetSlug
Re-exports SheetValidatedEvent
Re-exports SortDirection
Re-exports SortField
Re-exports SourceField
Re-exports SpaceAddedEvent
Re-exports SpaceConfigId
Re-exports SpaceId
Re-exports SpaceRemovedEvent
Re-exports StringConfig
Re-exports StringConfigOptions
Re-exports StringProperty
Re-exports StripeProduct
Re-exports Success
Re-exports SuccessData
Re-exports Trigger
Re-exports UniqueConstraint
Re-exports UniqueConstraintConfig
Re-exports UpdateFileRequest
Re-exports UpdateWorkbookConfig
Re-exports UploadCompletedEvent
Re-exports UploadFailedEvent
Re-exports UploadStartedEvent
Re-exports User
Re-exports UserAddedEvent
Re-exports UserConfig
Re-exports UserId
Re-exports UserOfflineEvent
Re-exports UserOnlineEvent
Re-exports UserRemovedEvent
Re-exports UserResponse
Re-exports ValidationMessage
Re-exports ValidationSource
Re-exports ValidationType
Re-exports VersionId
Re-exports VersionResponse
Re-exports VersionsPostRequestBody
Re-exports Workbook
Re-exports WorkbookAddedEvent
Re-exports WorkbookId
Re-exports WorkbookRemovedEvent
Re-exports WorkbookResponse
Re-exports WorkbookUpdatedEvent
@flatfile/api / Exports / Flatfile / property / Constraint
@flatfile/api / Exports / Flatfile / property / Property
@flatfile/api / Exports / Flatfile / property
Flatfile.property
- ArrayableProperty
- BaseProperty
- BooleanProperty
- BooleanPropertyConfig
- DateProperty
- EnumProperty
- EnumPropertyConfig
- EnumPropertyOption
- NumberConfig
- NumberProperty
- ReferenceProperty
- ReferencePropertyConfig
- StringConfig
- StringProperty
- UniqueConstraint
- UniqueConstraintConfig
Ƭ Constraint: Required
| Unique
| Computed
src/api/resources/property/types/Constraint.ts:7
src/api/resources/property/types/Constraint.ts:9
Ƭ Property: String
| Number
| Boolean
| Date_
| Enum
| Reference
Example
{
* type: "string",
* key: "code",
* label: "Product Code",
* description: "Unique identifier defining an individual product.",
* constraints: [{
* type: "unique",
* config: {
* caseSensitive: false
* }
* }],
* config: {
* size: Flatfile.StringConfigOptions.Tiny
* }
* }
Example
{
* type: "number",
* key: "price",
* config: {
* decimalPlaces: 2
* }
* }
Example
{
* type: "boolean",
* key: "editable",
* config: {
* allowIndeterminate: true
* }
* }
Example
{
* type: "date"
* }
Example
{
* type: "enum",
* key: "category",
* label: "Product Category",
* isArray: false,
* multi: true,
* config: {
* allowCustom: false,
* options: [{
* value: 9,
* label: "Kitchenware",
* icon: "pots-and-pans",
* color: "#f00000",
* meta: {
* "product_code_prefix": "KI-"
* }
* }, {
* value: 9,
* label: "Clothing",
* meta: {
* "product_code_prefix": "CL-"
* }
* }]
* }
* }
Example
{
* type: "reference",
* key: "user reference",
* config: {
* ref: "/sheet/users/3",
* relationship: Flatfile.ReferencePropertyRelationship.HasMany,
* key: "id"
* }
* }
src/api/resources/property/types/Property.ts:86
src/api/resources/property/types/Property.ts:94
Ƭ ReferencePropertyRelationship: "has-one"
| "has-many"
This file was auto-generated by Fern from our API Definition.
src/api/resources/property/types/ReferencePropertyRelationship.ts:5
src/api/resources/property/types/ReferencePropertyRelationship.ts:7
Ƭ StringConfigOptions: "tiny"
| "normal"
| "medium"
| "long"
How much text should be storeable in this field
src/api/resources/property/types/StringConfigOptions.ts:8
src/api/resources/property/types/StringConfigOptions.ts:22
• ReferencePropertyRelationship: Object
Name | Type |
---|---|
HasMany |
"has-many" |
HasOne |
"has-one" |
src/api/resources/property/types/ReferencePropertyRelationship.ts:5
src/api/resources/property/types/ReferencePropertyRelationship.ts:7
• StringConfigOptions: Object
Name | Type |
---|---|
Long |
"long" |
Medium |
"medium" |
Normal |
"normal" |
Tiny |
"tiny" |
src/api/resources/property/types/StringConfigOptions.ts:8
src/api/resources/property/types/StringConfigOptions.ts:22
@flatfile/api / Exports / Flatfile / records
Flatfile.records
- CellValue
- CellValueWithLinks
- DeleteRecordsRequest
- FindAndReplaceRecordRequest
- FindAndReplaceRecordRequestDeprecated
- FindRecordsRequest
- GetRecordsRequest
- RecordCounts
- RecordWithLinks
- Record_
- RecordsResponse
- RecordsResponseData
- ValidationMessage
- CellValueUnion
- RecordData
- RecordDataWithLinks
- Records
- RecordsWithLinks
- ValidationSource
- ValidationType
Ƭ CellValueUnion: string
| number
| boolean
This file was auto-generated by Fern from our API Definition.
src/api/resources/records/types/CellValueUnion.ts:5
Ƭ RecordData: Record
<string
, CellValue
>
A single row of data in a Sheet
src/api/resources/records/types/RecordData.ts:10
Ƭ RecordDataWithLinks: Record
<string
, CellValueWithLinks
>
A single row of data in a Sheet, including links to related rows
src/api/resources/records/types/RecordDataWithLinks.ts:10
Ƭ Records: Record_
[]
List of Record objects
src/api/resources/records/types/Records.ts:10
Ƭ RecordsWithLinks: RecordWithLinks
[]
List of Record objects, including links to related rows
src/api/resources/records/types/RecordsWithLinks.ts:10
Ƭ ValidationSource: "required-constraint"
| "unique-constraint"
| "custom-logic"
| "unlinked"
| "invalid-option"
This file was auto-generated by Fern from our API Definition.
src/api/resources/records/types/ValidationSource.ts:5
src/api/resources/records/types/ValidationSource.ts:12
Ƭ ValidationType: "error"
| "warn"
| "info"
This file was auto-generated by Fern from our API Definition.
src/api/resources/records/types/ValidationType.ts:5
src/api/resources/records/types/ValidationType.ts:7
• ValidationSource: Object
Name | Type |
---|---|
CustomLogic |
"custom-logic" |
InvalidOption |
"invalid-option" |
RequiredConstraint |
"required-constraint" |
UniqueConstraint |
"unique-constraint" |
Unlinked |
"unlinked" |
src/api/resources/records/types/ValidationSource.ts:5
src/api/resources/records/types/ValidationSource.ts:12
• ValidationType: Object
Name | Type |
---|---|
Error |
"error" |
Info |
"info" |
Warn |
"warn" |
src/api/resources/records/types/ValidationType.ts:5
src/api/resources/records/types/ValidationType.ts:7
@flatfile/api / Exports / Flatfile / sheets
Flatfile.sheets
- GetRecordCountsRequest
- GetRecordsCsvRequest
- ListSheetsRequest
- ListSheetsResponse
- RecordCountsResponse
- RecordCountsResponseData
- Sheet
- SheetConfig
- SheetResponse
Ƭ SheetAccess: "*"
| "add"
| "edit"
| "delete"
| "import"
This file was auto-generated by Fern from our API Definition.
src/api/resources/sheets/types/SheetAccess.ts:5
src/api/resources/sheets/types/SheetAccess.ts:7
• SheetAccess: Object
Name | Type |
---|---|
Add |
"add" |
All |
"*" |
Delete |
"delete" |
Edit |
"edit" |
Import |
"import" |
src/api/resources/sheets/types/SheetAccess.ts:5
src/api/resources/sheets/types/SheetAccess.ts:7
@flatfile/api / Exports / Flatfile / spaces
Flatfile.spaces
Ƭ GetSpacesSortField: "name"
| "workbooksCount"
| "filesCount"
| "environmentId"
| "createdByUserName"
This file was auto-generated by Fern from our API Definition.
src/api/resources/spaces/types/GetSpacesSortField.ts:5
src/api/resources/spaces/types/GetSpacesSortField.ts:7
Ƭ SpaceAccess: "*"
| "upload"
This file was auto-generated by Fern from our API Definition.
src/api/resources/spaces/types/SpaceAccess.ts:5
src/api/resources/spaces/types/SpaceAccess.ts:7
• GetSpacesSortField: Object
Name | Type |
---|---|
CreatedByUserName |
"createdByUserName" |
EnvironmentId |
"environmentId" |
FilesCount |
"filesCount" |
Name |
"name" |
WorkbooksCount |
"workbooksCount" |
src/api/resources/spaces/types/GetSpacesSortField.ts:5
src/api/resources/spaces/types/GetSpacesSortField.ts:7
• SpaceAccess: Object
Name | Type |
---|---|
All |
"*" |
Upload |
"upload" |
src/api/resources/spaces/types/SpaceAccess.ts:5
src/api/resources/spaces/types/SpaceAccess.ts:7
@flatfile/api / Exports / Flatfile / users
Flatfile.users
- ApiToken
- CreateApiTokenRequest
- ExchangeTokenData
- ExchangeTokenRequest
- ExchangeTokenResponse
- ListApiTokensRequest
- ListApiTokensResponse
- ListUsersRequest
- ListUsersResponse
- User
- UserConfig
- UserResponse
@flatfile/api / Exports / Flatfile / versions
Flatfile.versions
@flatfile/api / Exports / Flatfile / workbooks
Flatfile.workbooks
- CreateWorkbookConfig
- ListWorkbooksRequest
- ListWorkbooksResponse
- UpdateWorkbookConfig
- Workbook
- WorkbookResponse
@flatfile/api / Exports / FlatfileClient