api.md

• @flatfile/api
• Synopsis
• Details
• Flatfile Node API Library
  • Documentation
  • Installation
  • Usage
  • Handling errors
  • Handling events
  • Fields
  • Beta status
  • Contributing
• API
• Contribution
• Classes
  • Class: BadRequestError
    • Hierarchy
    • Table of contents
    • Constructors
    • Properties
    • Methods
  • Class: NotFoundError
    • Hierarchy
    • Table of contents
    • Constructors
    • Properties
    • Methods
  • Class: FlatfileClient
    • Hierarchy
    • Table of contents
    • Constructors
    • Properties
    • Accessors
  • Class: FlatfileError
    • Hierarchy
    • Table of contents
    • Constructors
    • Properties
    • Methods
  • Class: FlatfileTimeoutError
    • Hierarchy
    • Table of contents
    • Constructors
    • Properties
    • Methods
• Interfaces
  • Interface: Agent
    • Hierarchy
    • Table of contents
    • Properties
  • Interface: AgentConfig
    • Hierarchy
    • Table of contents
    • Properties
  • Interface: AgentLog
    • Table of contents
    • Properties
  • Interface: AgentResponse
    • Table of contents
    • Properties
  • Interface: CreateAgentsRequest
    • Table of contents
    • Properties
  • Interface: DeleteAgentRequest
    • Table of contents
    • Properties
  • Interface: GetAgentLogsRequest
    • Table of contents
    • Properties
  • Interface: GetAgentLogsResponse
    • Table of contents
    • Properties
  • Interface: GetAgentRequest
    • Table of contents
    • Properties
  • Interface: GetEnvironmentAgentLogsRequest
    • Table of contents
    • Properties
  • Interface: ListAgentsRequest
    • Table of contents
    • Properties
  • Interface: ListAgentsResponse
    • Table of contents
    • Properties
  • Interface: ApiKey
    • Table of contents
    • Properties
  • Interface: ApiKeyOperation
    • Table of contents
    • Properties
  • Interface: ApiKeysResponse
    • Table of contents
    • Properties
  • Interface: GetApiKeysRequest
    • Table of contents
    • Properties
  • Interface: CheckoutSession
    • Table of contents
    • Properties
  • Interface: CreateCheckoutSessionResponse
    • Table of contents
    • Properties
  • Interface: ProductsResponse
    • Table of contents
    • Properties
  • Interface: StripeProduct
    • Table of contents
    • Properties
  • Interface: CellValueWithCounts
    • Hierarchy
    • Table of contents
    • Properties
  • Interface: CellsResponse
    • Table of contents
    • Properties
  • Interface: GetFieldValuesRequest
    • Table of contents
    • Properties
  • Interface: Action
    • Table of contents
    • Properties
  • Interface: Error_
    • Table of contents
    • Properties
  • Interface: Pagination
    • Table of contents
    • Properties
  • Interface: Success
    • Hierarchy
    • Table of contents
    • Properties
  • Interface: SuccessData
    • Table of contents
    • Properties
  • Interface: Document
    • Hierarchy
    • Table of contents
    • Properties
  • Interface: DocumentConfig
    • Hierarchy
    • Table of contents
    • Properties
  • Interface: DocumentResponse
    • Table of contents
    • Properties
  • Interface: ListDocumentsResponse
    • Table of contents
    • Properties
  • Interface: Environment
    • Hierarchy
    • Table of contents
    • Properties
  • Interface: EnvironmentConfig
    • Hierarchy
    • Table of contents
    • Properties
  • Interface: EnvironmentResponse
    • Table of contents
    • Properties
  • Interface: ListEnvironmentsRequest
    • Table of contents
    • Properties
  • Interface: ListEnvironmentsResponse
    • Table of contents
    • Properties
  • Interface: ActionTriggeredEvent
    • Hierarchy
    • Table of contents
    • Properties
  • Interface: BaseEvent
    • Hierarchy
    • Table of contents
    • Properties
  • Interface: ClientInitializedEvent
    • Hierarchy
    • Table of contents
    • Properties
  • Interface: Context
    • Table of contents
    • Properties
  • Interface: ActionTriggered
    • Hierarchy
    • Table of contents
    • Properties
  • Interface: ClientInitialized
    • Hierarchy
    • Table of contents
    • Properties
  • Interface: FileDeleted
    • Hierarchy
    • Table of contents
    • Properties
  • Interface: JobCompleted
    • Hierarchy
    • Table of contents
    • Properties
  • Interface: JobDeleted
    • Hierarchy
    • Table of contents
    • Properties
  • Interface: JobFailed
    • Hierarchy
    • Table of contents
    • Properties
  • Interface: JobStarted
    • Hierarchy
    • Table of contents
    • Properties
  • Interface: JobUpdated
    • Hierarchy
    • Table of contents
    • Properties
  • Interface: JobWaiting
    • Hierarchy
    • Table of contents
    • Properties
  • Interface: RecordsCreated
    • Hierarchy
    • Table of contents
    • Properties
  • Interface: RecordsDeleted
    • Hierarchy
    • Table of contents
    • Properties
  • Interface: RecordsUpdated
    • Hierarchy
    • Table of contents
    • Properties
  • Interface: SheetValidated
    • Hierarchy
    • Table of contents
    • Properties
  • Interface: SpaceAdded
    • Hierarchy
    • Table of contents
    • Properties
  • Interface: SpaceRemoved
    • Hierarchy
    • Table of contents
    • Properties
  • Interface: UploadCompleted
    • Hierarchy
    • Table of contents
    • Properties
  • Interface: UploadFailed
    • Hierarchy
    • Table of contents
    • Properties
  • Interface: UploadStarted
    • Hierarchy
    • Table of contents
    • Properties
  • Interface: UserAdded
    • Hierarchy
    • Table of contents
    • Properties
  • Interface: UserOffline
    • Hierarchy
    • Table of contents
    • Properties
  • Interface: UserOnline
    • Hierarchy
    • Table of contents
    • Properties
  • Interface: UserRemoved
    • Hierarchy
    • Table of contents
    • Properties
  • Interface: WorkbookAdded
    • Hierarchy
    • Table of contents
    • Properties
  • Interface: WorkbookRemoved
    • Hierarchy
    • Table of contents
    • Properties
  • Interface: WorkbookUpdated
    • Hierarchy
    • Table of contents
    • Properties
  • Interface: EventAttributes
    • Table of contents
    • Properties
  • Interface: EventResponse
    • Table of contents
    • Properties
  • Interface: FileDeletedEvent
    • Hierarchy
    • Table of contents
    • Properties
  • Interface: GetEventTokenRequest
    • Table of contents
    • Properties
  • Interface: JobCompletedEvent
    • Hierarchy
    • Table of contents
    • Properties
  • Interface: JobDeletedEvent
    • Hierarchy
    • Table of contents
    • Properties
  • Interface: JobFailedEvent
    • Hierarchy
    • Table of contents
    • Properties
  • Interface: JobFailedPayload
    • Hierarchy
    • Table of contents
    • Properties
  • Interface: JobPayload
    • Hierarchy
    • Table of contents
    • Properties
  • Interface: JobStartedEvent
    • Hierarchy
    • Table of contents
    • Properties
  • Interface: JobUpdatedEvent
    • Hierarchy
    • Table of contents
    • Properties
  • Interface: JobWaitingEvent
    • Hierarchy
    • Table of contents
    • Properties
  • Interface: ListAllEventsResponse
    • Table of contents
    • Properties
  • Interface: ListEventsRequest
    • Table of contents
    • Properties
  • Interface: Origin
    • Table of contents
    • Properties
  • Interface: Progress
    • Table of contents
    • Properties
  • Interface: RecordsCreatedEvent
    • Hierarchy
    • Table of contents
    • Properties
  • Interface: RecordsDeletedEvent
    • Hierarchy
    • Table of contents
    • Properties
  • Interface: RecordsPayload
    • Table of contents
    • Properties
  • Interface: RecordsUpdatedEvent
    • Hierarchy
    • Table of contents
    • Properties
  • Interface: SheetValidatedEvent
    • Hierarchy
    • Table of contents
    • Properties
  • Interface: SpaceAddedEvent
    • Hierarchy
    • Table of contents
    • Properties
  • Interface: SpaceRemovedEvent
    • Hierarchy
    • Table of contents
    • Properties
  • Interface: UploadCompletedEvent
    • Hierarchy
    • Table of contents
    • Properties
  • Interface: UploadFailedEvent
    • Hierarchy
    • Table of contents
    • Properties
  • Interface: UploadStartedEvent
    • Hierarchy
    • Table of contents
    • Properties
  • Interface: UserAddedEvent
    • Hierarchy
    • Table of contents
    • Properties
  • Interface: UserOfflineEvent
    • Hierarchy
    • Table of contents
    • Properties
  • Interface: UserOnlineEvent
    • Hierarchy
    • Table of contents
    • Properties
  • Interface: UserRemovedEvent
    • Hierarchy
    • Table of contents
    • Properties
  • Interface: WorkbookAddedEvent
    • Hierarchy
    • Table of contents
    • Properties
  • Interface: WorkbookRemovedEvent
    • Hierarchy
    • Table of contents
    • Properties
  • Interface: WorkbookUpdatedEvent
    • Hierarchy
    • Table of contents
    • Properties
  • Interface: CreateFileRequest
    • Table of contents
    • Properties
  • Interface: FileResponse
    • Table of contents
    • Properties
  • Interface: File_
    • Table of contents
    • Properties
  • Interface: ListFilesRequest
    • Table of contents
    • Properties
  • Interface: ListFilesResponse
    • Table of contents
    • Properties
  • Interface: UpdateFileRequest
    • Table of contents
    • Properties
  • Interface: CreateGuestResponse
    • Table of contents
    • Properties
  • Interface: Guest
    • Hierarchy
    • Table of contents
    • Properties
  • Interface: GuestConfig
    • Hierarchy
    • Table of contents
    • Properties
  • Interface: GuestSpace
    • Table of contents
    • Properties
  • Interface: GuestWorkbook
    • Table of contents
    • Properties
  • Interface: Invite
    • Table of contents
    • Properties
  • Interface: ListGuestsRequest
    • Table of contents
    • Properties
  • Interface: ListGuestsResponse
    • Table of contents
    • Properties
  • Interface: AiAssistJobConfig
    • Table of contents
    • Properties
  • Interface: CategoryMapping
    • Table of contents
    • Properties
  • Interface: DeleteJobConfig
    • Table of contents
    • Properties
  • Interface: DestinationField
    • Table of contents
    • Properties
  • Interface: Edge
    • Table of contents
    • Properties
  • Interface: EmptyObject
  • Interface: EnumDetails
    • Table of contents
    • Properties
  • Interface: ExportJobConfig
    • Table of contents
    • Properties
  • Interface: ExportOptions
    • Table of contents
    • Properties
  • Interface: FileJobConfig
    • Table of contents
    • Properties
  • Interface: FindAndReplaceJobConfig
    • Table of contents
    • Properties
  • Interface: Job
    • Hierarchy
    • Table of contents
    • Properties
  • Interface: JobAckDetails
    • Table of contents
    • Properties
  • Interface: JobConfig
    • Hierarchy
    • Table of contents
    • Properties
  • Interface: JobExecutionPlan
    • Hierarchy
    • Table of contents
    • Properties
  • Interface: JobExecutionPlanConfig
    • Hierarchy
    • Table of contents
    • Properties
  • Interface: JobOutcome
    • Table of contents
    • Properties
  • Interface: JobPlan
    • Table of contents
    • Properties
  • Interface: JobResponse
    • Table of contents
    • Properties
  • Interface: JobUpdate
    • Table of contents
    • Properties
  • Interface: ListJobsRequest
    • Table of contents
    • Properties
  • Interface: ListJobsResponse
    • Table of contents
    • Properties
  • Interface: Metadata
    • Table of contents
    • Properties
  • Interface: MutateJobConfig
    • Table of contents
    • Properties
  • Interface: PipelineJobConfig
    • Table of contents
    • Properties
  • Interface: SourceField
    • Table of contents
    • Properties
  • Interface: ArrayableProperty
    • Hierarchy
    • Table of contents
    • Properties
  • Interface: BaseProperty
    • Hierarchy
    • Table of contents
    • Properties
  • Interface: BooleanProperty
    • Hierarchy
    • Table of contents
    • Properties
  • Interface: BooleanPropertyConfig
    • Table of contents
    • Properties
  • Interface: Computed
    • Table of contents
    • Properties
  • Interface: Required
    • Table of contents
    • Properties
  • Interface: Unique
    • Hierarchy
    • Table of contents
    • Properties
  • Interface: DateProperty
    • Hierarchy
    • Table of contents
    • Properties
  • Interface: EnumProperty
    • Hierarchy
    • Table of contents
    • Properties
  • Interface: EnumPropertyConfig
    • Table of contents
    • Properties
  • Interface: EnumPropertyOption
    • Table of contents
    • Properties
  • Interface: NumberConfig
    • Table of contents
    • Properties
  • Interface: NumberProperty
    • Hierarchy
    • Table of contents
    • Properties
  • Interface: Boolean
    • Hierarchy
    • Table of contents
    • Properties
  • Interface: Date_
    • Hierarchy
    • Table of contents
    • Properties
  • Interface: Enum
    • Hierarchy
    • Table of contents
    • Properties
  • Interface: Number
    • Hierarchy
    • Table of contents
    • Properties
  • Interface: Reference
    • Hierarchy
    • Table of contents
    • Properties
  • Interface: String
    • Hierarchy
    • Table of contents
    • Properties
  • Interface: ReferenceProperty
    • Hierarchy
    • Table of contents
    • Properties
  • Interface: ReferencePropertyConfig
    • Table of contents
    • Properties
  • Interface: StringConfig
    • Table of contents
    • Properties
  • Interface: StringProperty
    • Hierarchy
    • Table of contents
    • Properties
  • Interface: UniqueConstraint
    • Hierarchy
    • Table of contents
    • Properties
  • Interface: UniqueConstraintConfig
    • Table of contents
    • Properties
  • Interface: CellValue
    • Hierarchy
    • Table of contents
    • Properties
  • Interface: CellValueWithLinks
    • Hierarchy
    • Table of contents
    • Properties
  • Interface: DeleteRecordsRequest
    • Table of contents
    • Properties
  • Interface: FindAndReplaceRecordRequest
    • Table of contents
    • Properties
  • Interface: FindAndReplaceRecordRequestDeprecated
    • Table of contents
    • Properties
  • Interface: FindRecordsRequest
    • Table of contents
    • Properties
  • Interface: GetRecordsRequest
    • Table of contents
    • Properties
  • Interface: RecordCounts
    • Table of contents
    • Properties
  • Interface: RecordWithLinks
    • Table of contents
    • Properties
  • Interface: Record_
    • Table of contents
    • Properties
  • Interface: RecordsResponse
    • Table of contents
    • Properties
  • Interface: RecordsResponseData
    • Hierarchy
    • Table of contents
    • Properties
  • Interface: ValidationMessage
    • Table of contents
    • Properties
  • Interface: GetRecordCountsRequest
    • Table of contents
    • Properties
  • Interface: GetRecordsCsvRequest
    • Table of contents
    • Properties
  • Interface: ListSheetsRequest
    • Table of contents
    • Properties
  • Interface: ListSheetsResponse
    • Table of contents
    • Properties
  • Interface: RecordCountsResponse
    • Table of contents
    • Properties
  • Interface: RecordCountsResponseData
    • Hierarchy
    • Table of contents
    • Properties
  • Interface: Sheet
    • Table of contents
    • Properties
  • Interface: SheetConfig
    • Table of contents
    • Properties
  • Interface: SheetResponse
    • Table of contents
    • Properties
  • Interface: EventToken
    • Table of contents
    • Properties
  • Interface: EventTokenResponse
    • Table of contents
    • Properties
  • Interface: ListSpacesRequest
    • Table of contents
    • Properties
  • Interface: ListSpacesResponse
    • Table of contents
    • Properties
  • Interface: Space
    • Hierarchy
    • Table of contents
    • Properties
  • Interface: SpaceConfig
    • Hierarchy
    • Table of contents
    • Properties
  • Interface: SpaceResponse
    • Table of contents
    • Properties
  • Interface: ApiToken
    • Table of contents
    • Properties
  • Interface: CreateApiTokenRequest
    • Table of contents
    • Properties
  • Interface: ExchangeTokenData
    • Table of contents
    • Properties
  • Interface: ExchangeTokenRequest
    • Table of contents
    • Properties
  • Interface: ExchangeTokenResponse
    • Table of contents
    • Properties
  • Interface: ListApiTokensRequest
    • Table of contents
    • Properties
  • Interface: ListApiTokensResponse
    • Table of contents
    • Properties
  • Interface: ListUsersRequest
    • Table of contents
    • Properties
  • Interface: ListUsersResponse
    • Table of contents
    • Properties
  • Interface: User
    • Hierarchy
    • Table of contents
    • Properties
  • Interface: UserConfig
    • Hierarchy
    • Table of contents
    • Properties
  • Interface: UserResponse
    • Table of contents
    • Properties
  • Interface: VersionResponse
    • Table of contents
    • Properties
  • Interface: VersionsPostRequestBody
    • Table of contents
    • Properties
  • Interface: CreateWorkbookConfig
    • Table of contents
    • Properties
  • Interface: ListWorkbooksRequest
    • Table of contents
    • Properties
  • Interface: ListWorkbooksResponse
    • Table of contents
    • Properties
  • Interface: UpdateWorkbookConfig
    • Table of contents
    • Properties
  • Interface: Workbook
    • Table of contents
    • Properties
  • Interface: WorkbookResponse
    • Table of contents
    • Properties
  • Interface: Options
    • Table of contents
    • Properties
• @flatfile/api
  • Table of contents
    • Namespaces
    • Classes
    • Type Aliases
    • Variables
  • Type Aliases
    • FlatfileEnvironment
  • Variables
    • FlatfileEnvironment
    • default
• Modules
  • Namespace: agents
    • Table of contents
    • Type Aliases
    • Variables
  • Namespace: auth
    • Table of contents
    • Type Aliases
    • Variables
  • Namespace: billing
    • Table of contents
  • Namespace: cells
    • Table of contents
    • Type Aliases
  • Namespace: commons
    • Table of contents
    • Type Aliases
    • Variables
  • Namespace: documents
    • Table of contents
  • Namespace: environments
    • Table of contents
    • Type Aliases
    • Variables
  • Namespace: Event
    • Table of contents
  • Namespace: events
    • Table of contents
    • Type Aliases
    • Variables
  • Namespace: files
    • Table of contents
    • Type Aliases
    • Variables
  • Namespace: guests
    • Table of contents
  • Namespace: jobs
    • Table of contents
    • Type Aliases
    • Variables
  • Namespace: Flatfile
    • Table of contents
    • References
  • Namespace: Constraint
    • Table of contents
  • Namespace: Property
    • Table of contents
  • Namespace: property
    • Table of contents
    • Type Aliases
    • Variables
  • Namespace: records
    • Table of contents
    • Type Aliases
    • Variables
  • Namespace: sheets
    • Table of contents
    • Type Aliases
    • Variables
  • Namespace: spaces
    • Table of contents
    • Type Aliases
    • Variables
  • Namespace: users
    • Table of contents
  • Namespace: versions
    • Table of contents
  • Namespace: workbooks
    • Table of contents
  • Namespace: FlatfileClient
    • Table of contents

@flatfile/api / Exports

@flatfile/api

• Synopsis
• Details
• Flatfile Node API Library
  • Documentation
  • Installation
  • Usage
  • Handling errors
  • Handling events
  • Fields
  • Beta status
  • Contributing
• API
• Contribution

Synopsis

Details

Flatfile Node API Library

The Flatfile Node.js library provides convenient access to the Flatfile API from JavaScript/TypeScript.

Documentation

API reference documentation is available here.

Installation

npm install --save @flatfile/api
# or
yarn add @flatfile/api

Usage

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);

Handling errors

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

Handling events

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
}

Fields

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
    }
}

Beta status

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.

Contributing

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!

API

Contribution

Classes

@flatfile/api / Exports / Flatfile / commons / BadRequestError

Class: BadRequestError

Flatfile.commons.BadRequestError

This file was auto-generated by Fern from our API Definition.

Hierarchy

• FlatfileError

  ↳ BadRequestError

Table of contents

Constructors

• constructor

Properties

• body
• message
• name
• stack
• statusCode
• prepareStackTrace
• stackTraceLimit

Methods

• captureStackTrace

Constructors

constructor

• new BadRequestError(body)

Parameters

Name	Type
body	Error_[]

Overrides

FlatfileError.constructor

Defined in

src/api/resources/commons/errors/BadRequestError.ts:9

Properties

body

• Optional Readonly body: unknown

Inherited from

FlatfileError.body

Defined in

src/errors/FlatfileError.ts:7

---

message

• message: string

Inherited from

FlatfileError.message

Defined in

node_modules/typescript/lib/lib.es5.d.ts:1023

---

name

• name: string

Inherited from

FlatfileError.name

Defined in

node_modules/typescript/lib/lib.es5.d.ts:1022

---

stack

• Optional stack: string

Inherited from

FlatfileError.stack

Defined in

node_modules/typescript/lib/lib.es5.d.ts:1024

---

statusCode

• Optional Readonly statusCode: number

Inherited from

FlatfileError.statusCode

Defined in

src/errors/FlatfileError.ts:6

---

prepareStackTrace

▪ Static Optional prepareStackTrace: (err: Error, stackTraces: CallSite[]) => any

Type declaration

▸ (err, stackTraces): any

Optional override for formatting stack traces

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

Parameters

Name	Type
err	Error
stackTraces	CallSite[]

Returns

any

Inherited from

FlatfileError.prepareStackTrace

Defined in

node_modules/@types/node/globals.d.ts:11

---

stackTraceLimit

▪ Static stackTraceLimit: number

Inherited from

FlatfileError.stackTraceLimit

Defined in

node_modules/@types/node/globals.d.ts:13

Methods

captureStackTrace

▸ Static captureStackTrace(targetObject, constructorOpt?): void

Create .stack property on a target object

Parameters

Name	Type
targetObject	object
constructorOpt?	Function

Returns

void

Inherited from

FlatfileError.captureStackTrace

Defined in

node_modules/@types/node/globals.d.ts:4

@flatfile/api / Exports / Flatfile / commons / NotFoundError

Class: NotFoundError

Flatfile.commons.NotFoundError

This file was auto-generated by Fern from our API Definition.

Hierarchy

• FlatfileError

  ↳ NotFoundError

Table of contents

Constructors

• constructor

Properties

• body
• message
• name
• stack
• statusCode
• prepareStackTrace
• stackTraceLimit

Methods

• captureStackTrace

Constructors

constructor

• new NotFoundError(body)

Parameters

Name	Type
body	Error_[]

Overrides

FlatfileError.constructor

Defined in

src/api/resources/commons/errors/NotFoundError.ts:9

Properties

body

• Optional Readonly body: unknown

Inherited from

FlatfileError.body

Defined in

src/errors/FlatfileError.ts:7

---

message

• message: string

Inherited from

FlatfileError.message

Defined in

node_modules/typescript/lib/lib.es5.d.ts:1023

---

name

• name: string

Inherited from

FlatfileError.name

Defined in

node_modules/typescript/lib/lib.es5.d.ts:1022

---

stack

• Optional stack: string

Inherited from

FlatfileError.stack

Defined in

node_modules/typescript/lib/lib.es5.d.ts:1024

---

statusCode

• Optional Readonly statusCode: number

Inherited from

FlatfileError.statusCode

Defined in

src/errors/FlatfileError.ts:6

---

prepareStackTrace

▪ Static Optional prepareStackTrace: (err: Error, stackTraces: CallSite[]) => any

Type declaration

▸ (err, stackTraces): any

Optional override for formatting stack traces

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

Parameters

Name	Type
err	Error
stackTraces	CallSite[]

Returns

any

Inherited from

FlatfileError.prepareStackTrace

Defined in

node_modules/@types/node/globals.d.ts:11

---

stackTraceLimit

▪ Static stackTraceLimit: number

Inherited from

FlatfileError.stackTraceLimit

Defined in

node_modules/@types/node/globals.d.ts:13

Methods

captureStackTrace

▸ Static captureStackTrace(targetObject, constructorOpt?): void

Create .stack property on a target object

Parameters

Name	Type
targetObject	object
constructorOpt?	Function

Returns

void

Inherited from

FlatfileError.captureStackTrace

Defined in

node_modules/@types/node/globals.d.ts:4

@flatfile/api / Exports / FlatfileClient

Class: FlatfileClient

Hierarchy

• FlatfileClient

  ↳ FlatfileClient

Table of contents

Constructors

• constructor

Properties

• _agents
• _auth
• _billing
• _cells
• _documents
• _environments
• _events
• _files
• _guests
• _jobs
• _records
• _sheets
• _spaces
• _users
• _versions
• _workbooks
• options
• token

Accessors

• agents
• auth
• billing
• cells
• documents
• environments
• events
• files
• guests
• jobs
• records
• sheets
• spaces
• users
• versions
• workbooks

Constructors

constructor

• new FlatfileClient(options?)

Parameters

Name	Type
options	Options

Overrides

FernClient.constructor

Defined in

src/wrapper/FlatfileClient.ts:24

Properties

_agents

• Protected _agents: undefined | Agents

Inherited from

FernClient._agents

Defined in

src/Client.ts:42

---

_auth

• Protected _auth: undefined | Auth

Inherited from

FernClient._auth

Defined in

src/Client.ts:48

---

_billing

• Protected _billing: undefined | Billing

Inherited from

FernClient._billing

Defined in

src/Client.ts:54

---

_cells

• Protected _cells: undefined | Cells

Inherited from

FernClient._cells

Defined in

src/Client.ts:60

---

_documents

• Protected _documents: undefined | Documents

Inherited from

FernClient._documents

Defined in

src/Client.ts:66

---

_environments

• Protected _environments: undefined | Environments

Inherited from

FernClient._environments

Defined in

src/Client.ts:72

---

_events

• Protected _events: undefined | Events

Inherited from

FernClient._events

Defined in

src/Client.ts:78

---

_files

• Protected _files: undefined | Files

Inherited from

FernClient._files

Defined in

src/Client.ts:84

---

_guests

• Protected _guests: undefined | Guests

Inherited from

FernClient._guests

Defined in

src/Client.ts:90

---

_jobs

• Protected _jobs: undefined | Jobs

Inherited from

FernClient._jobs

Defined in

src/Client.ts:96

---

_records

• Protected _records: undefined | Records

Inherited from

FernClient._records

Defined in

src/Client.ts:102

---

_sheets

• Protected _sheets: undefined | Sheets

Inherited from

FernClient._sheets

Defined in

src/Client.ts:108

---

_spaces

• Protected _spaces: undefined | Spaces

Inherited from

FernClient._spaces

Defined in

src/Client.ts:36

---

_users

• Protected _users: undefined | Users

Inherited from

FernClient._users

Defined in

src/Client.ts:114

---

_versions

• Protected _versions: undefined | Versions

Inherited from

FernClient._versions

Defined in

src/Client.ts:120

---

_workbooks

• Protected _workbooks: undefined | Workbooks

Inherited from

FernClient._workbooks

Defined in

src/Client.ts:126

---

options

• Protected Readonly options: Options

Inherited from

FernClient.options

Defined in

src/Client.ts:34

---

token

• Private token: undefined | string

Defined in

src/wrapper/FlatfileClient.ts:22

Accessors

agents

• get agents(): Agents

Returns

Agents

Inherited from

FernClient.agents

Defined in

src/Client.ts:44

---

auth

• get auth(): Auth

Returns

Auth

Inherited from

FernClient.auth

Defined in

src/Client.ts:50

---

billing

• get billing(): Billing

Returns

Billing

Inherited from

FernClient.billing

Defined in

src/Client.ts:56

---

cells

• get cells(): Cells

Returns

Cells

Inherited from

FernClient.cells

Defined in

src/Client.ts:62

---

documents

• get documents(): Documents

Returns

Documents

Inherited from

FernClient.documents

Defined in

src/Client.ts:68

---

environments

• get environments(): Environments

Returns

Environments

Inherited from

FernClient.environments

Defined in

src/Client.ts:74

---

events

• get events(): Events

Returns

Events

Inherited from

FernClient.events

Defined in

src/Client.ts:80

---

files

• get files(): Files

Returns

Files

Inherited from

FernClient.files

Defined in

src/Client.ts:86

---

guests

• get guests(): Guests

Returns

Guests

Inherited from

FernClient.guests

Defined in

src/Client.ts:92

---

jobs

• get jobs(): Jobs

Returns

Jobs

Inherited from

FernClient.jobs

Defined in

src/Client.ts:98

---

records

• get records(): Records

Returns

Records

Inherited from

FernClient.records

Defined in

src/Client.ts:104

---

sheets

• get sheets(): Sheets

Returns

Sheets

Inherited from

FernClient.sheets

Defined in

src/Client.ts:110

---

spaces

• get spaces(): Spaces

Returns

Spaces

Inherited from

FernClient.spaces

Defined in

src/Client.ts:38

---

users

• get users(): Users

Returns

Users

Inherited from

FernClient.users

Defined in

src/Client.ts:116

---

versions

• get versions(): Versions

Returns

Versions

Inherited from

FernClient.versions

Defined in

src/Client.ts:122

---

workbooks

• get workbooks(): Workbooks

Returns

Workbooks

Inherited from

FernClient.workbooks

Defined in

src/Client.ts:128

@flatfile/api / Exports / FlatfileError

Class: FlatfileError

This file was auto-generated by Fern from our API Definition.

Hierarchy

• Error

  ↳ FlatfileError

  ↳↳ BadRequestError

  ↳↳ NotFoundError

Table of contents

Constructors

• constructor

Properties

• body
• message
• name
• stack
• statusCode
• prepareStackTrace
• stackTraceLimit

Methods

• captureStackTrace

Constructors

constructor

• new FlatfileError(«destructured»)

Parameters

Name	Type
«destructured»	Object
› body?	unknown
› message?	string
› statusCode?	number

Overrides

Error.constructor

Defined in

src/errors/FlatfileError.ts:9

Properties

body

• Optional Readonly body: unknown

Defined in

src/errors/FlatfileError.ts:7

---

message

• message: string

Inherited from

Error.message

Defined in

node_modules/typescript/lib/lib.es5.d.ts:1023

---

name

• name: string

Inherited from

Error.name

Defined in

node_modules/typescript/lib/lib.es5.d.ts:1022

---

stack

• Optional stack: string

Inherited from

Error.stack

Defined in

node_modules/typescript/lib/lib.es5.d.ts:1024

---

statusCode

• Optional Readonly statusCode: number

Defined in

src/errors/FlatfileError.ts:6

---

prepareStackTrace

▪ Static Optional prepareStackTrace: (err: Error, stackTraces: CallSite[]) => any

Type declaration

▸ (err, stackTraces): any

Optional override for formatting stack traces

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

Parameters

Name	Type
err	Error
stackTraces	CallSite[]

Returns

any

Inherited from

Error.prepareStackTrace

Defined in

node_modules/@types/node/globals.d.ts:11

---

stackTraceLimit

▪ Static stackTraceLimit: number

Inherited from

Error.stackTraceLimit

Defined in

node_modules/@types/node/globals.d.ts:13

Methods

captureStackTrace

▸ Static captureStackTrace(targetObject, constructorOpt?): void

Create .stack property on a target object

Parameters

Name	Type
targetObject	object
constructorOpt?	Function

Returns

void

Inherited from

Error.captureStackTrace

Defined in

node_modules/@types/node/globals.d.ts:4

@flatfile/api / Exports / FlatfileTimeoutError

Class: FlatfileTimeoutError

This file was auto-generated by Fern from our API Definition.

Hierarchy

• Error

  ↳ FlatfileTimeoutError

Table of contents

Constructors

• constructor

Properties

• message
• name
• stack
• prepareStackTrace
• stackTraceLimit

Methods

• captureStackTrace

Constructors

constructor

• new FlatfileTimeoutError()

Overrides

Error.constructor

Defined in

src/errors/FlatfileTimeoutError.ts:6

Properties

message

• message: string

Inherited from

Error.message

Defined in

node_modules/typescript/lib/lib.es5.d.ts:1023

---

name

• name: string

Inherited from

Error.name

Defined in

node_modules/typescript/lib/lib.es5.d.ts:1022

---

stack

• Optional stack: string

Inherited from

Error.stack

Defined in

node_modules/typescript/lib/lib.es5.d.ts:1024

---

prepareStackTrace

▪ Static Optional prepareStackTrace: (err: Error, stackTraces: CallSite[]) => any

Type declaration

▸ (err, stackTraces): any

Optional override for formatting stack traces

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

Parameters

Name	Type
err	Error
stackTraces	CallSite[]

Returns

any

Inherited from

Error.prepareStackTrace

Defined in

node_modules/@types/node/globals.d.ts:11

---

stackTraceLimit

▪ Static stackTraceLimit: number

Inherited from

Error.stackTraceLimit

Defined in

node_modules/@types/node/globals.d.ts:13

Methods

captureStackTrace

▸ Static captureStackTrace(targetObject, constructorOpt?): void

Create .stack property on a target object

Parameters

Name	Type
targetObject	object
constructorOpt?	Function

Returns

void

Inherited from

Error.captureStackTrace

Defined in

node_modules/@types/node/globals.d.ts:4

Interfaces

@flatfile/api / Exports / Flatfile / agents / Agent

Interface: Agent

Flatfile.agents.Agent

Example

{
 *         id: "123",
 *         topics: [Flatfile.EventTopic.FileCreated],
 *         compiler: Flatfile.Compiler.Js,
 *         source: "module.exports = { routeEvent: async (...args) => { console.log(args) } }"
 *     }

Hierarchy

• AgentConfig

  ↳ Agent

Table of contents

Properties

• compiler
• id
• source
• topics

Properties

compiler

• Optional compiler: "js"

The compiler of the agent

Inherited from

AgentConfig.compiler

Defined in

src/api/resources/agents/types/AgentConfig.ts:21

---

id

• id: string

Defined in

src/api/resources/agents/types/Agent.ts:17

---

source

• Optional source: string

The source of the agent

Inherited from

AgentConfig.source

Defined in

src/api/resources/agents/types/AgentConfig.ts:23

---

topics

• Optional topics: EventTopic[]

The topics the agent should listen for

Inherited from

AgentConfig.topics

Defined in

src/api/resources/agents/types/AgentConfig.ts:19

@flatfile/api / Exports / Flatfile / agents / AgentConfig

Interface: AgentConfig

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) } }"
 *     }

Hierarchy

• AgentConfig

  ↳ Agent

Table of contents

Properties

• compiler
• source
• topics

Properties

compiler

• Optional compiler: "js"

The compiler of the agent

Defined in

src/api/resources/agents/types/AgentConfig.ts:21

---

source

• Optional source: string

The source of the agent

Defined in

src/api/resources/agents/types/AgentConfig.ts:23

---

topics

• Optional topics: EventTopic[]

The topics the agent should listen for

Defined in

src/api/resources/agents/types/AgentConfig.ts:19

@flatfile/api / Exports / Flatfile / agents / AgentLog

Interface: AgentLog

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"
 *     }

Table of contents

Properties

• completedAt
• createdAt
• eventId
• log
• success

Properties

completedAt

• completedAt: Date

Defined in

src/api/resources/agents/types/AgentLog.ts:24

---

createdAt

• createdAt: Date

Defined in

src/api/resources/agents/types/AgentLog.ts:23

---

eventId

• eventId: string

Defined in

src/api/resources/agents/types/AgentLog.ts:20

---

log

• Optional log: string

The log of the agent execution

Defined in

src/api/resources/agents/types/AgentLog.ts:26

---

success

• success: boolean

Whether the agent execution was successful

Defined in

src/api/resources/agents/types/AgentLog.ts:22

@flatfile/api / Exports / Flatfile / agents / AgentResponse

Interface: AgentResponse

Flatfile.agents.AgentResponse

Example

{
 *         data: {
 *             id: "123",
 *             topics: [Flatfile.EventTopic.FileCreated],
 *             compiler: Flatfile.Compiler.Js,
 *             source: "module.exports = { routeEvent: async (...args) => { console.log(args) } }"
 *         }
 *     }

Table of contents

Properties

• data

Properties

data

• data: Agent

Defined in

src/api/resources/agents/types/AgentResponse.ts:19

@flatfile/api / Exports / Flatfile / agents / CreateAgentsRequest

Interface: CreateAgentsRequest

Flatfile.agents.CreateAgentsRequest

Table of contents

Properties

• body
• environmentId

Properties

body

• body: AgentConfig

Defined in

src/api/resources/agents/client/requests/CreateAgentsRequest.ts:9

---

environmentId

• environmentId: string

Defined in

src/api/resources/agents/client/requests/CreateAgentsRequest.ts:8

@flatfile/api / Exports / Flatfile / agents / DeleteAgentRequest

Interface: DeleteAgentRequest

Flatfile.agents.DeleteAgentRequest

Table of contents

Properties

• body
• environmentId

Properties

body

• body: AgentConfig

Defined in

src/api/resources/agents/client/requests/DeleteAgentRequest.ts:9

---

environmentId

• environmentId: string

Defined in

src/api/resources/agents/client/requests/DeleteAgentRequest.ts:8

@flatfile/api / Exports / Flatfile / agents / GetAgentLogsRequest

Interface: GetAgentLogsRequest

Flatfile.agents.GetAgentLogsRequest

Table of contents

Properties

• environmentId

Properties

environmentId

• environmentId: string

Defined in

src/api/resources/agents/client/requests/GetAgentLogsRequest.ts:8

@flatfile/api / Exports / Flatfile / agents / GetAgentLogsResponse

Interface: 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"
 *             }]
 *     }

Table of contents

Properties

• data
• pagination

Properties

data

• data: AgentLog[]

Defined in

src/api/resources/agents/types/GetAgentLogsResponse.ts:26

---

pagination

• Optional pagination: Pagination

Defined in

src/api/resources/agents/types/GetAgentLogsResponse.ts:25

@flatfile/api / Exports / Flatfile / agents / GetAgentRequest

Interface: GetAgentRequest

Flatfile.agents.GetAgentRequest

Table of contents

Properties

• environmentId

Properties

environmentId

• environmentId: string

Defined in

src/api/resources/agents/client/requests/GetAgentRequest.ts:8

@flatfile/api / Exports / Flatfile / agents / GetEnvironmentAgentLogsRequest

Interface: GetEnvironmentAgentLogsRequest

Flatfile.agents.GetEnvironmentAgentLogsRequest

Table of contents

Properties

• environmentId
• pageNumber
• pageSize

Properties

environmentId

• environmentId: string

Defined in

src/api/resources/agents/client/requests/GetEnvironmentAgentLogsRequest.ts:8

---

pageNumber

• Optional pageNumber: number

Based on pageSize, which page of records to return

Defined in

src/api/resources/agents/client/requests/GetEnvironmentAgentLogsRequest.ts:16

---

pageSize

• Optional pageSize: number

Number of logs to return in a page (default 20)

Defined in

src/api/resources/agents/client/requests/GetEnvironmentAgentLogsRequest.ts:12

@flatfile/api / Exports / Flatfile / agents / ListAgentsRequest

Interface: ListAgentsRequest

Flatfile.agents.ListAgentsRequest

Table of contents

Properties

• environmentId

Properties

environmentId

• environmentId: string

Defined in

src/api/resources/agents/client/requests/ListAgentsRequest.ts:8

@flatfile/api / Exports / Flatfile / agents / ListAgentsResponse

Interface: 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) } }"
 *             }]
 *     }

Table of contents

Properties

• data

Properties

data

• data: Agent[]

Defined in

src/api/resources/agents/types/ListAgentsResponse.ts:19

@flatfile/api / Exports / Flatfile / auth / ApiKey

Interface: ApiKey

Flatfile.auth.ApiKey

API Key used for authenticating against our APIs

Table of contents

Properties

• accountId
• createdAt
• environmentId
• expireAt
• id
• operations
• rawKey
• secret
• type
• updatedAt

Properties

accountId

• Optional accountId: string

Defined in

src/api/resources/auth/types/ApiKey.ts:15

---

createdAt

• createdAt: Date

Defined in

src/api/resources/auth/types/ApiKey.ts:17

---

environmentId

• Optional environmentId: string

Defined in

src/api/resources/auth/types/ApiKey.ts:14

---

expireAt

• expireAt: Date

Defined in

src/api/resources/auth/types/ApiKey.ts:19

---

id

• id: string

Defined in

src/api/resources/auth/types/ApiKey.ts:11

---

operations

• operations: ApiKeyOperation[]

Defined in

src/api/resources/auth/types/ApiKey.ts:16

---

rawKey

• rawKey: string

Defined in

src/api/resources/auth/types/ApiKey.ts:12

---

secret

• Optional secret: string

Defined in

src/api/resources/auth/types/ApiKey.ts:20

---

type

• type: ApiKeyType

Defined in

src/api/resources/auth/types/ApiKey.ts:13

---

updatedAt

• Optional updatedAt: Date

Defined in

src/api/resources/auth/types/ApiKey.ts:18

@flatfile/api / Exports / Flatfile / auth / ApiKeyOperation

Interface: ApiKeyOperation

Flatfile.auth.ApiKeyOperation

This file was auto-generated by Fern from our API Definition.

Table of contents

Properties

• method
• path

Properties

method

• method: string

Defined in

src/api/resources/auth/types/ApiKeyOperation.ts:7

---

path

• path: string

Defined in

src/api/resources/auth/types/ApiKeyOperation.ts:6

@flatfile/api / Exports / Flatfile / auth / ApiKeysResponse

Interface: ApiKeysResponse

Flatfile.auth.ApiKeysResponse

Table of contents

Properties

• data

Properties

data

• data: ApiKey[]

Defined in

src/api/resources/auth/types/ApiKeysResponse.ts:8

@flatfile/api / Exports / Flatfile / auth / GetApiKeysRequest

Interface: GetApiKeysRequest

Flatfile.auth.GetApiKeysRequest

Table of contents

Properties

• environmentId

Properties

environmentId

• environmentId: string

ID of environment to search

Defined in

src/api/resources/auth/client/requests/GetApiKeysRequest.ts:11

@flatfile/api / Exports / Flatfile / billing / CheckoutSession

Interface: CheckoutSession

Flatfile.billing.CheckoutSession

A Checkout Session as returned by Stripe

Table of contents

Properties

• id
• object

Properties

id

• Optional id: string

Defined in

src/api/resources/billing/types/CheckoutSession.ts:9

---

object

• Optional object: string

Defined in

src/api/resources/billing/types/CheckoutSession.ts:10

@flatfile/api / Exports / Flatfile / billing / CreateCheckoutSessionResponse

Interface: CreateCheckoutSessionResponse

Flatfile.billing.CreateCheckoutSessionResponse

Table of contents

Properties

• data

Properties

data

• data: CheckoutSession

Defined in

src/api/resources/billing/types/CreateCheckoutSessionResponse.ts:8

@flatfile/api / Exports / Flatfile / billing / ProductsResponse

Interface: ProductsResponse

Flatfile.billing.ProductsResponse

Table of contents

Properties

• data

Properties

data

• data: StripeProduct[]

Defined in

src/api/resources/billing/types/ProductsResponse.ts:8

@flatfile/api / Exports / Flatfile / billing / StripeProduct

Interface: StripeProduct

Flatfile.billing.StripeProduct

A product as returned by Stripe

Table of contents

Properties

• active
• attributes
• created
• defaultPrice
• description
• id
• images
• livemode
• metadata
• name
• object
• packageDimensions
• shippable
• statementDescriptor
• taxCode
• type
• unitLabel
• updated
• url

Properties

active

• active: boolean

Defined in

src/api/resources/billing/types/StripeProduct.ts:11

---

attributes

• attributes: string[]

Defined in

src/api/resources/billing/types/StripeProduct.ts:12

---

created

• created: number

Defined in

src/api/resources/billing/types/StripeProduct.ts:13

---

defaultPrice

• defaultPrice: string

Defined in

src/api/resources/billing/types/StripeProduct.ts:14

---

description

• description: string

Defined in

src/api/resources/billing/types/StripeProduct.ts:15

---

id

• id: string

Defined in

src/api/resources/billing/types/StripeProduct.ts:9

---

images

• images: string[]

Defined in

src/api/resources/billing/types/StripeProduct.ts:16

---

livemode

• livemode: boolean

Defined in

src/api/resources/billing/types/StripeProduct.ts:17

---

metadata

• Optional metadata: unknown

Defined in

src/api/resources/billing/types/StripeProduct.ts:18

---

name

• name: string

Defined in

src/api/resources/billing/types/StripeProduct.ts:19

---

object

• object: string

Defined in

src/api/resources/billing/types/StripeProduct.ts:10

---

packageDimensions

• packageDimensions: string

Defined in

src/api/resources/billing/types/StripeProduct.ts:20

---

shippable

• shippable: boolean

Defined in

src/api/resources/billing/types/StripeProduct.ts:21

---

statementDescriptor

• statementDescriptor: string

Defined in

src/api/resources/billing/types/StripeProduct.ts:22

---

taxCode

• taxCode: string

Defined in

src/api/resources/billing/types/StripeProduct.ts:23

---

type

• type: string

Defined in

src/api/resources/billing/types/StripeProduct.ts:24

---

unitLabel

• unitLabel: string

Defined in

src/api/resources/billing/types/StripeProduct.ts:25

---

updated

• updated: number

Defined in

src/api/resources/billing/types/StripeProduct.ts:26

---

url

• url: string

Defined in

src/api/resources/billing/types/StripeProduct.ts:27

@flatfile/api / Exports / Flatfile / cells / CellValueWithCounts

Interface: CellValueWithCounts

Flatfile.cells.CellValueWithCounts

Hierarchy

• CellValue

  ↳ CellValueWithCounts

Table of contents

Properties

• counts
• messages
• updatedAt
• valid
• value

Properties

counts

• Optional counts: RecordCounts

Defined in

src/api/resources/cells/types/CellValueWithCounts.ts:8

---

messages

• Optional messages: ValidationMessage[]

Inherited from

CellValue.messages

Defined in

src/api/resources/records/types/CellValue.ts:9

---

updatedAt

• Optional updatedAt: Date

Inherited from

CellValue.updatedAt

Defined in

src/api/resources/records/types/CellValue.ts:11

---

valid

• Optional valid: boolean

Inherited from

CellValue.valid

Defined in

src/api/resources/records/types/CellValue.ts:8

---

value

• Optional value: CellValueUnion

Inherited from

CellValue.value

Defined in

src/api/resources/records/types/CellValue.ts:10

@flatfile/api / Exports / Flatfile / cells / CellsResponse

Interface: CellsResponse

Flatfile.cells.CellsResponse

Table of contents

Properties

• data

Properties

data

• data: CellsResponseData

Defined in

src/api/resources/cells/types/CellsResponse.ts:8

@flatfile/api / Exports / Flatfile / cells / GetFieldValuesRequest

Interface: GetFieldValuesRequest

Flatfile.cells.GetFieldValuesRequest

Table of contents

Properties

• distinct
• fieldKey
• filter
• filterField
• includeCounts
• pageNumber
• pageSize
• searchValue
• sortDirection
• sortField

Properties

distinct

• Optional distinct: boolean

When true, excludes duplicate values

Defined in

src/api/resources/cells/client/requests/GetFieldValuesRequest.ts:34

---

fieldKey

• fieldKey: string

Returns results from the given field only. Otherwise all field cells are returned

Defined in

src/api/resources/cells/client/requests/GetFieldValuesRequest.ts:12

---

filter

• Optional filter: Filter

Options to filter records

Defined in

src/api/resources/cells/client/requests/GetFieldValuesRequest.ts:18

---

filterField

• Optional filterField: string

Name of field by which to filter records

Defined in

src/api/resources/cells/client/requests/GetFieldValuesRequest.ts:22

---

includeCounts

• Optional includeCounts: boolean

When both distinct and includeCounts are true, the count of distinct field values will be returned

Defined in

src/api/resources/cells/client/requests/GetFieldValuesRequest.ts:38

---

pageNumber

• Optional pageNumber: number

Based on pageSize, which page of records to return

Defined in

src/api/resources/cells/client/requests/GetFieldValuesRequest.ts:30

---

pageSize

• Optional pageSize: number

Number of records to return in a page (default 1000 if pageNumber included)

Defined in

src/api/resources/cells/client/requests/GetFieldValuesRequest.ts:26

---

searchValue

• Optional searchValue: string

A value to find for a given field in a sheet. Wrap the value in "" for exact match

Defined in

src/api/resources/cells/client/requests/GetFieldValuesRequest.ts:42

---

sortDirection

• Optional sortDirection: SortDirection

Defined in

src/api/resources/cells/client/requests/GetFieldValuesRequest.ts:14

---

sortField

• Optional sortField: string

Defined in

src/api/resources/cells/client/requests/GetFieldValuesRequest.ts:13

@flatfile/api / Exports / Flatfile / commons / Action

Interface: Action

Flatfile.commons.Action

Table of contents

Properties

• confirm
• description
• label
• mode
• operation
• primary
• slug
• type

Properties

confirm

• Optional confirm: boolean

Defined in

src/api/resources/commons/types/Action.ts:15

---

description

• Optional description: string

Defined in

src/api/resources/commons/types/Action.ts:13

---

label

• label: string

Defined in

src/api/resources/commons/types/Action.ts:11

---

mode

• Optional mode: ActionMode

Defined in

src/api/resources/commons/types/Action.ts:10

---

operation

• Optional operation: string

Defined in

src/api/resources/commons/types/Action.ts:9

---

primary

• Optional primary: boolean

Defined in

src/api/resources/commons/types/Action.ts:14

---

slug

• Optional slug: string

Defined in

src/api/resources/commons/types/Action.ts:8

---

type

• Optional type: string

Defined in

src/api/resources/commons/types/Action.ts:12

@flatfile/api / Exports / Flatfile / commons / Error_

Interface: Error_

Flatfile.commons.Error_

This file was auto-generated by Fern from our API Definition.

Table of contents

Properties

• key
• message

Properties

key

• Optional key: string

Defined in

src/api/resources/commons/types/Error_.ts:6

---

message

• message: string

Defined in

src/api/resources/commons/types/Error_.ts:7

@flatfile/api / Exports / Flatfile / commons / Pagination

Interface: Pagination

Flatfile.commons.Pagination

pagination info

Example

{
 *         currentPage: 3,
 *         pageCount: 50,
 *         totalCount: 100
 *     }

Table of contents

Properties

• currentPage
• pageCount
• totalCount

Properties

currentPage

• currentPage: number

current page of results

Defined in

src/api/resources/commons/types/Pagination.ts:17

---

pageCount

• pageCount: number

total number of pages of results

Defined in

src/api/resources/commons/types/Pagination.ts:19

---

totalCount

• totalCount: number

total available results

Defined in

src/api/resources/commons/types/Pagination.ts:21

@flatfile/api / Exports / Flatfile / commons / Success

Interface: Success

Flatfile.commons.Success

Informs whether or not a request was successful

Example

{
 *         data: {
 *             success: true
 *         }
 *     }

Hierarchy

• Success

  ↳ RecordsResponseData

  ↳ RecordCountsResponseData

Table of contents

Properties

• data

Properties

data

• data: SuccessData

Defined in

src/api/resources/commons/types/Success.ts:18

@flatfile/api / Exports / Flatfile / commons / SuccessData

Interface: SuccessData

Flatfile.commons.SuccessData

This file was auto-generated by Fern from our API Definition.

Table of contents

Properties

• success

Properties

success

• success: boolean

Defined in

src/api/resources/commons/types/SuccessData.ts:6

@flatfile/api / Exports / Flatfile / documents / Document

Interface: Document

Flatfile.documents.Document

A document (markdown components) belong to a space

Hierarchy

• DocumentConfig

  ↳ Document

Table of contents

Properties

• body
• id
• spaceId
• title

Properties

body

• body: string

Inherited from

DocumentConfig.body

Defined in

src/api/resources/documents/types/DocumentConfig.ts:7

---

id

• id: string

Defined in

src/api/resources/documents/types/Document.ts:11

---

spaceId

• Optional spaceId: string

Defined in

src/api/resources/documents/types/Document.ts:12

---

title

• title: string

Inherited from

DocumentConfig.title

Defined in

src/api/resources/documents/types/DocumentConfig.ts:6

@flatfile/api / Exports / Flatfile / documents / DocumentConfig

Interface: DocumentConfig

Flatfile.documents.DocumentConfig

This file was auto-generated by Fern from our API Definition.

Hierarchy

• DocumentConfig

  ↳ Document

Table of contents

Properties

• body
• title

Properties

body

• body: string

Defined in

src/api/resources/documents/types/DocumentConfig.ts:7

---

title

• title: string

Defined in

src/api/resources/documents/types/DocumentConfig.ts:6

@flatfile/api / Exports / Flatfile / documents / DocumentResponse

Interface: DocumentResponse

Flatfile.documents.DocumentResponse

Table of contents

Properties

• data

Properties

data

• data: Document

Defined in

src/api/resources/documents/types/DocumentResponse.ts:8

@flatfile/api / Exports / Flatfile / documents / ListDocumentsResponse

Interface: ListDocumentsResponse

Flatfile.documents.ListDocumentsResponse

Table of contents

Properties

• data

Properties

data

• data: Document[]

Defined in

src/api/resources/documents/types/ListDocumentsResponse.ts:8

@flatfile/api / Exports / Flatfile / environments / Environment

Interface: Environment

Flatfile.environments.Environment

Example

{
 *         name: "dev",
 *         isProd: false,
 *         guestAuthentication: [Flatfile.GuestAuthenticationEnum.MagicLink],
 *         id: "us_env_hVXkXs0b",
 *         accountId: "us_acc_uj6s91wc"
 *     }

Hierarchy

• EnvironmentConfig

  ↳ Environment

Table of contents

Properties

• accountId
• features
• guestAuthentication
• id
• isProd
• name

Properties

accountId

• Optional accountId: string

Defined in

src/api/resources/environments/types/Environment.ts:19

---

features

• Optional features: Record<string, unknown>

Inherited from

EnvironmentConfig.features

Defined in

src/api/resources/environments/types/EnvironmentConfig.ts:23

---

guestAuthentication

• Optional guestAuthentication: GuestAuthenticationEnum[]

Inherited from

EnvironmentConfig.guestAuthentication

Defined in

src/api/resources/environments/types/EnvironmentConfig.ts:22

---

id

• id: string

Defined in

src/api/resources/environments/types/Environment.ts:18

---

isProd

• isProd: boolean

Whether or not the environment is a production environment

Inherited from

EnvironmentConfig.isProd

Defined in

src/api/resources/environments/types/EnvironmentConfig.ts:21

---

name

• name: string

The name of the environment

Inherited from

EnvironmentConfig.name

Defined in

src/api/resources/environments/types/EnvironmentConfig.ts:19

@flatfile/api / Exports / Flatfile / environments / EnvironmentConfig

Interface: EnvironmentConfig

Flatfile.environments.EnvironmentConfig

Properties used to create a new environment

Example

{
 *         name: "dev",
 *         isProd: false,
 *         guestAuthentication: [Flatfile.GuestAuthenticationEnum.MagicLink]
 *     }

Hierarchy

• EnvironmentConfig

  ↳ Environment

Table of contents

Properties

• features
• guestAuthentication
• isProd
• name

Properties

features

• Optional features: Record<string, unknown>

Defined in

src/api/resources/environments/types/EnvironmentConfig.ts:23

---

guestAuthentication

• Optional guestAuthentication: GuestAuthenticationEnum[]

Defined in

src/api/resources/environments/types/EnvironmentConfig.ts:22

---

isProd

• isProd: boolean

Whether or not the environment is a production environment

Defined in

src/api/resources/environments/types/EnvironmentConfig.ts:21

---

name

• name: string

The name of the environment

Defined in

src/api/resources/environments/types/EnvironmentConfig.ts:19

@flatfile/api / Exports / Flatfile / environments / EnvironmentResponse

Interface: EnvironmentResponse

Flatfile.environments.EnvironmentResponse

Table of contents

Properties

• data

Properties

data

• data: Environment

Defined in

src/api/resources/environments/types/EnvironmentResponse.ts:8

@flatfile/api / Exports / Flatfile / environments / ListEnvironmentsRequest

Interface: ListEnvironmentsRequest

Flatfile.environments.ListEnvironmentsRequest

This file was auto-generated by Fern from our API Definition.

Table of contents

Properties

• pageNumber
• pageSize

Properties

pageNumber

• Optional pageNumber: number

Based on pageSize, which page of environments to return

Defined in

src/api/resources/environments/client/requests/ListEnvironmentsRequest.ts:13

---

pageSize

• Optional pageSize: number

Number of environments to return in a page (default 10)

Defined in

src/api/resources/environments/client/requests/ListEnvironmentsRequest.ts:9

@flatfile/api / Exports / Flatfile / environments / ListEnvironmentsResponse

Interface: ListEnvironmentsResponse

Flatfile.environments.ListEnvironmentsResponse

Table of contents

Properties

• data
• pagination

Properties

data

• data: Environment[]

Defined in

src/api/resources/environments/types/ListEnvironmentsResponse.ts:8

---

pagination

• Optional pagination: Pagination

Defined in

src/api/resources/environments/types/ListEnvironmentsResponse.ts:9

@flatfile/api / Exports / Flatfile / events / ActionTriggeredEvent

Interface: ActionTriggeredEvent

Flatfile.events.ActionTriggeredEvent

Hierarchy

• BaseEvent

  ↳ ActionTriggeredEvent

  ↳↳ ActionTriggered

Table of contents

Properties

• acknowledgedAt
• acknowledgedBy
• attributes
• callbackUrl
• context
• createdAt
• dataUrl
• deletedAt
• domain
• origin
• payload
• target
• topic

Properties

acknowledgedAt

• Optional acknowledgedAt: string

Date the event was acknowledged

Inherited from

BaseEvent.acknowledgedAt

Defined in

src/api/resources/events/types/BaseEvent.ts:24

---

acknowledgedBy

• Optional acknowledgedBy: string

The actor (user or system) who acknowledged the event

Inherited from

BaseEvent.acknowledgedBy

Defined in

src/api/resources/events/types/BaseEvent.ts:26

---

attributes

• Optional attributes: EventAttributes

The attributes of the event

Inherited from

BaseEvent.attributes

Defined in

src/api/resources/events/types/BaseEvent.ts:14

---

callbackUrl

• Optional callbackUrl: string

The callback url to acknowledge the event

Inherited from

BaseEvent.callbackUrl

Defined in

src/api/resources/events/types/BaseEvent.ts:16

---

context

• context: Context

The context of the event

Inherited from

BaseEvent.context

Defined in

src/api/resources/events/types/BaseEvent.ts:12

---

createdAt

• createdAt: Date

Date the event was created

Inherited from

BaseEvent.createdAt

Defined in

src/api/resources/events/types/BaseEvent.ts:20

---

dataUrl

• Optional dataUrl: string

The url to retrieve the data associated with the event

Inherited from

BaseEvent.dataUrl

Defined in

src/api/resources/events/types/BaseEvent.ts:18

---

deletedAt

• Optional deletedAt: Date

Date the event was deleted

Inherited from

BaseEvent.deletedAt

Defined in

src/api/resources/events/types/BaseEvent.ts:22

---

domain

• domain: Domain

The domain of the event

Inherited from

BaseEvent.domain

Defined in

src/api/resources/events/types/BaseEvent.ts:9

---

origin

• Optional origin: Origin

Inherited from

BaseEvent.origin

Defined in

src/api/resources/events/types/BaseEvent.ts:28

---

payload

• payload: Record<string, unknown>

Defined in

src/api/resources/events/types/ActionTriggeredEvent.ts:8

---

target

• Optional target: string

Inherited from

BaseEvent.target

Defined in

src/api/resources/events/types/BaseEvent.ts:27

---

topic

• topic: EventTopic

Inherited from

BaseEvent.topic

Defined in

src/api/resources/events/types/BaseEvent.ts:10

@flatfile/api / Exports / Flatfile / events / BaseEvent

Interface: BaseEvent

Flatfile.events.BaseEvent

Hierarchy

• BaseEvent

  ↳ SpaceAddedEvent

  ↳ SpaceRemovedEvent

  ↳ WorkbookAddedEvent

  ↳ WorkbookRemovedEvent

  ↳ WorkbookUpdatedEvent

  ↳ UserAddedEvent

  ↳ UserRemovedEvent

  ↳ UserOnlineEvent

  ↳ UserOfflineEvent

  ↳ UploadStartedEvent

  ↳ UploadFailedEvent

  ↳ UploadCompletedEvent

  ↳ JobStartedEvent

  ↳ JobWaitingEvent

  ↳ JobUpdatedEvent

  ↳ JobFailedEvent

  ↳ JobCompletedEvent

  ↳ JobDeletedEvent

  ↳ RecordsCreatedEvent

  ↳ RecordsUpdatedEvent

  ↳ RecordsDeletedEvent

  ↳ SheetValidatedEvent

  ↳ ActionTriggeredEvent

  ↳ FileDeletedEvent

  ↳ ClientInitializedEvent

Table of contents

Properties

• acknowledgedAt
• acknowledgedBy
• attributes
• callbackUrl
• context
• createdAt
• dataUrl
• deletedAt
• domain
• origin
• target
• topic

Properties

acknowledgedAt

• Optional acknowledgedAt: string

Date the event was acknowledged

Defined in

src/api/resources/events/types/BaseEvent.ts:24

---

acknowledgedBy

• Optional acknowledgedBy: string

The actor (user or system) who acknowledged the event

Defined in

src/api/resources/events/types/BaseEvent.ts:26

---

attributes

• Optional attributes: EventAttributes

The attributes of the event

Defined in

src/api/resources/events/types/BaseEvent.ts:14

---

callbackUrl

• Optional callbackUrl: string

The callback url to acknowledge the event

Defined in

src/api/resources/events/types/BaseEvent.ts:16

---

context

• context: Context

The context of the event

Defined in

src/api/resources/events/types/BaseEvent.ts:12

---

createdAt

• createdAt: Date

Date the event was created

Defined in

src/api/resources/events/types/BaseEvent.ts:20

---

dataUrl

• Optional dataUrl: string

The url to retrieve the data associated with the event

Defined in

src/api/resources/events/types/BaseEvent.ts:18

---

deletedAt

• Optional deletedAt: Date

Date the event was deleted

Defined in

src/api/resources/events/types/BaseEvent.ts:22

---

domain

• domain: Domain

The domain of the event

Defined in

src/api/resources/events/types/BaseEvent.ts:9

---

origin

• Optional origin: Origin

Defined in

src/api/resources/events/types/BaseEvent.ts:28

---

target

• Optional target: string

Defined in

src/api/resources/events/types/BaseEvent.ts:27

---

topic

• topic: EventTopic

Defined in

src/api/resources/events/types/BaseEvent.ts:10

@flatfile/api / Exports / Flatfile / events / ClientInitializedEvent

Interface: ClientInitializedEvent

Flatfile.events.ClientInitializedEvent

Hierarchy

• BaseEvent

  ↳ ClientInitializedEvent

  ↳↳ ClientInitialized

Table of contents

Properties

• acknowledgedAt
• acknowledgedBy
• attributes
• callbackUrl
• context
• createdAt
• dataUrl
• deletedAt
• domain
• origin
• payload
• target
• topic

Properties

acknowledgedAt

• Optional acknowledgedAt: string

Date the event was acknowledged

Inherited from

BaseEvent.acknowledgedAt

Defined in

src/api/resources/events/types/BaseEvent.ts:24

---

acknowledgedBy

• Optional acknowledgedBy: string

The actor (user or system) who acknowledged the event

Inherited from

BaseEvent.acknowledgedBy

Defined in

src/api/resources/events/types/BaseEvent.ts:26

---

attributes

• Optional attributes: EventAttributes

The attributes of the event

Inherited from

BaseEvent.attributes

Defined in

src/api/resources/events/types/BaseEvent.ts:14

---

callbackUrl

• Optional callbackUrl: string

The callback url to acknowledge the event

Inherited from

BaseEvent.callbackUrl

Defined in

src/api/resources/events/types/BaseEvent.ts:16

---

context

• context: Context

The context of the event

Inherited from

BaseEvent.context

Defined in

src/api/resources/events/types/BaseEvent.ts:12

---

createdAt

• createdAt: Date

Date the event was created

Inherited from

BaseEvent.createdAt

Defined in

src/api/resources/events/types/BaseEvent.ts:20

---

dataUrl

• Optional dataUrl: string

The url to retrieve the data associated with the event

Inherited from

BaseEvent.dataUrl

Defined in

src/api/resources/events/types/BaseEvent.ts:18

---

deletedAt

• Optional deletedAt: Date

Date the event was deleted

Inherited from

BaseEvent.deletedAt

Defined in

src/api/resources/events/types/BaseEvent.ts:22

---

domain

• domain: Domain

The domain of the event

Inherited from

BaseEvent.domain

Defined in

src/api/resources/events/types/BaseEvent.ts:9

---

origin

• Optional origin: Origin

Inherited from

BaseEvent.origin

Defined in

src/api/resources/events/types/BaseEvent.ts:28

---

payload

• payload: Record<string, unknown>

Defined in

src/api/resources/events/types/ClientInitializedEvent.ts:8

---

target

• Optional target: string

Inherited from

BaseEvent.target

Defined in

src/api/resources/events/types/BaseEvent.ts:27

---

topic

• topic: EventTopic

Inherited from

BaseEvent.topic

Defined in

src/api/resources/events/types/BaseEvent.ts:10

@flatfile/api / Exports / Flatfile / events / Context

Interface: Context

Flatfile.events.Context

The context of the event

Table of contents

Properties

• accountId
• actionName
• actorId
• environmentId
• fileId
• jobId
• precedingEventId
• sheetId
• sheetSlug
• spaceId
• versionId
• workbookId

Properties

accountId

• accountId: string

Defined in

src/api/resources/events/types/Context.ts:12

---

actionName

• Optional actionName: string

Defined in

src/api/resources/events/types/Context.ts:11

---

actorId

• Optional actorId: string

Can be a UserId, GuestId, or AgentId

Defined in

src/api/resources/events/types/Context.ts:23

---

environmentId

• environmentId: string

Defined in

src/api/resources/events/types/Context.ts:13

---

fileId

• Optional fileId: string

Defined in

src/api/resources/events/types/Context.ts:20

---

jobId

• Optional jobId: string

Defined in

src/api/resources/events/types/Context.ts:19

---

precedingEventId

• Optional precedingEventId: string

Defined in

src/api/resources/events/types/Context.ts:21

---

sheetId

• Optional sheetId: string

Defined in

src/api/resources/events/types/Context.ts:16

---

sheetSlug

• Optional sheetSlug: string

Defined in

src/api/resources/events/types/Context.ts:17

---

spaceId

• Optional spaceId: string

Defined in

src/api/resources/events/types/Context.ts:14

---

versionId

• Optional versionId: string

Defined in

src/api/resources/events/types/Context.ts:18

---

workbookId

• Optional workbookId: string

Defined in

src/api/resources/events/types/Context.ts:15

@flatfile/api / Exports / Flatfile / events / Event / ActionTriggered

Interface: ActionTriggered

events.Event.ActionTriggered

Hierarchy

• ActionTriggeredEvent

  ↳ ActionTriggered

Table of contents

Properties

• acknowledgedAt
• acknowledgedBy
• attributes
• callbackUrl
• context
• createdAt
• dataUrl
• deletedAt
• domain
• origin
• payload
• target
• topic
• type

Properties

acknowledgedAt

• Optional acknowledgedAt: string

Date the event was acknowledged

Inherited from

ActionTriggeredEvent.acknowledgedAt

Defined in

src/api/resources/events/types/BaseEvent.ts:24

---

acknowledgedBy

• Optional acknowledgedBy: string

The actor (user or system) who acknowledged the event

Inherited from

ActionTriggeredEvent.acknowledgedBy

Defined in

src/api/resources/events/types/BaseEvent.ts:26

---

attributes

• Optional attributes: EventAttributes

The attributes of the event

Inherited from

ActionTriggeredEvent.attributes

Defined in

src/api/resources/events/types/BaseEvent.ts:14

---

callbackUrl

• Optional callbackUrl: string

The callback url to acknowledge the event

Inherited from

ActionTriggeredEvent.callbackUrl

Defined in

src/api/resources/events/types/BaseEvent.ts:16

---

context

• context: Context

The context of the event

Inherited from

ActionTriggeredEvent.context

Defined in

src/api/resources/events/types/BaseEvent.ts:12

---

createdAt

• createdAt: Date

Date the event was created

Inherited from

ActionTriggeredEvent.createdAt

Defined in

src/api/resources/events/types/BaseEvent.ts:20

---

dataUrl

• Optional dataUrl: string

The url to retrieve the data associated with the event

Inherited from

ActionTriggeredEvent.dataUrl

Defined in

src/api/resources/events/types/BaseEvent.ts:18

---

deletedAt

• Optional deletedAt: Date

Date the event was deleted

Inherited from

ActionTriggeredEvent.deletedAt

Defined in

src/api/resources/events/types/BaseEvent.ts:22

---

domain

• domain: Domain

The domain of the event

Inherited from

ActionTriggeredEvent.domain

Defined in

src/api/resources/events/types/BaseEvent.ts:9

---

origin

• Optional origin: Origin

Inherited from

ActionTriggeredEvent.origin

Defined in

src/api/resources/events/types/BaseEvent.ts:28

---

payload

• payload: Record<string, unknown>

Inherited from

ActionTriggeredEvent.payload

Defined in

src/api/resources/events/types/ActionTriggeredEvent.ts:8

---

target

• Optional target: string

Inherited from

ActionTriggeredEvent.target

Defined in

src/api/resources/events/types/BaseEvent.ts:27

---

topic

• topic: EventTopic

Inherited from

ActionTriggeredEvent.topic

Defined in

src/api/resources/events/types/BaseEvent.ts:10

---

type

• type: "action:triggered"

Defined in

src/api/resources/events/types/Event.ts:127

@flatfile/api / Exports / Flatfile / events / Event / ClientInitialized

Interface: ClientInitialized

events.Event.ClientInitialized

Hierarchy

• ClientInitializedEvent

  ↳ ClientInitialized

Table of contents

Properties

• acknowledgedAt
• acknowledgedBy
• attributes
• callbackUrl
• context
• createdAt
• dataUrl
• deletedAt
• domain
• origin
• payload
• target
• topic
• type

Properties

acknowledgedAt

• Optional acknowledgedAt: string

Date the event was acknowledged

Inherited from

ClientInitializedEvent.acknowledgedAt

Defined in

src/api/resources/events/types/BaseEvent.ts:24

---

acknowledgedBy

• Optional acknowledgedBy: string

The actor (user or system) who acknowledged the event

Inherited from

ClientInitializedEvent.acknowledgedBy

Defined in

src/api/resources/events/types/BaseEvent.ts:26

---

attributes

• Optional attributes: EventAttributes

The attributes of the event

Inherited from

ClientInitializedEvent.attributes

Defined in

src/api/resources/events/types/BaseEvent.ts:14

---

callbackUrl

• Optional callbackUrl: string

The callback url to acknowledge the event

Inherited from

ClientInitializedEvent.callbackUrl

Defined in

src/api/resources/events/types/BaseEvent.ts:16

---

context

• context: Context

The context of the event

Inherited from

ClientInitializedEvent.context

Defined in

src/api/resources/events/types/BaseEvent.ts:12

---

createdAt

• createdAt: Date

Date the event was created

Inherited from

ClientInitializedEvent.createdAt

Defined in

src/api/resources/events/types/BaseEvent.ts:20

---

dataUrl

• Optional dataUrl: string

The url to retrieve the data associated with the event

Inherited from

ClientInitializedEvent.dataUrl

Defined in

src/api/resources/events/types/BaseEvent.ts:18

---

deletedAt

• Optional deletedAt: Date

Date the event was deleted

Inherited from

ClientInitializedEvent.deletedAt

Defined in

src/api/resources/events/types/BaseEvent.ts:22

---

domain

• domain: Domain

The domain of the event

Inherited from

ClientInitializedEvent.domain

Defined in

src/api/resources/events/types/BaseEvent.ts:9

---

origin

• Optional origin: Origin

Inherited from

ClientInitializedEvent.origin

Defined in

src/api/resources/events/types/BaseEvent.ts:28

---

payload

• payload: Record<string, unknown>

Inherited from

ClientInitializedEvent.payload

Defined in

src/api/resources/events/types/ClientInitializedEvent.ts:8

---

target

• Optional target: string

Inherited from

ClientInitializedEvent.target

Defined in

src/api/resources/events/types/BaseEvent.ts:27

---

topic

• topic: EventTopic

Inherited from

ClientInitializedEvent.topic

Defined in

src/api/resources/events/types/BaseEvent.ts:10

---

type

• type: "client:init"

Defined in

src/api/resources/events/types/Event.ts:135

@flatfile/api / Exports / Flatfile / events / Event / FileDeleted

Interface: FileDeleted

events.Event.FileDeleted

Hierarchy

• FileDeletedEvent

  ↳ FileDeleted

Table of contents

Properties

• acknowledgedAt
• acknowledgedBy
• attributes
• callbackUrl
• context
• createdAt
• dataUrl
• deletedAt
• domain
• origin
• payload
• target
• topic
• type

Properties

acknowledgedAt

• Optional acknowledgedAt: string

Date the event was acknowledged

Inherited from

FileDeletedEvent.acknowledgedAt

Defined in

src/api/resources/events/types/BaseEvent.ts:24

---

acknowledgedBy

• Optional acknowledgedBy: string

The actor (user or system) who acknowledged the event

Inherited from

FileDeletedEvent.acknowledgedBy

Defined in

src/api/resources/events/types/BaseEvent.ts:26

---

attributes

• Optional attributes: EventAttributes

The attributes of the event

Inherited from

FileDeletedEvent.attributes

Defined in

src/api/resources/events/types/BaseEvent.ts:14

---

callbackUrl

• Optional callbackUrl: string

The callback url to acknowledge the event

Inherited from

FileDeletedEvent.callbackUrl

Defined in

src/api/resources/events/types/BaseEvent.ts:16

---

context

• context: Context

The context of the event

Inherited from

FileDeletedEvent.context

Defined in

src/api/resources/events/types/BaseEvent.ts:12

---

createdAt

• createdAt: Date

Date the event was created

Inherited from

FileDeletedEvent.createdAt

Defined in

src/api/resources/events/types/BaseEvent.ts:20

---

dataUrl

• Optional dataUrl: string

The url to retrieve the data associated with the event

Inherited from

FileDeletedEvent.dataUrl

Defined in

src/api/resources/events/types/BaseEvent.ts:18

---

deletedAt

• Optional deletedAt: Date

Date the event was deleted

Inherited from

FileDeletedEvent.deletedAt

Defined in

src/api/resources/events/types/BaseEvent.ts:22

---

domain

• domain: Domain

The domain of the event

Inherited from

FileDeletedEvent.domain

Defined in

src/api/resources/events/types/BaseEvent.ts:9

---

origin

• Optional origin: Origin

Inherited from

FileDeletedEvent.origin

Defined in

src/api/resources/events/types/BaseEvent.ts:28

---

payload

• payload: Record<string, unknown>

Inherited from

FileDeletedEvent.payload

Defined in

src/api/resources/events/types/FileDeletedEvent.ts:8

---

target

• Optional target: string

Inherited from

FileDeletedEvent.target

Defined in

src/api/resources/events/types/BaseEvent.ts:27

---

topic

• topic: EventTopic

Inherited from

FileDeletedEvent.topic

Defined in

src/api/resources/events/types/BaseEvent.ts:10

---

type

• type: "file:deleted"

Defined in

src/api/resources/events/types/Event.ts:131

@flatfile/api / Exports / Flatfile / events / Event / JobCompleted

Interface: JobCompleted

events.Event.JobCompleted

Hierarchy

• JobCompletedEvent

  ↳ JobCompleted

Table of contents

Properties

• acknowledgedAt
• acknowledgedBy
• attributes
• callbackUrl
• context
• createdAt
• dataUrl
• deletedAt
• domain
• origin
• payload
• target
• topic
• type

Properties

acknowledgedAt

• Optional acknowledgedAt: string

Date the event was acknowledged

Inherited from

JobCompletedEvent.acknowledgedAt

Defined in

src/api/resources/events/types/BaseEvent.ts:24

---

acknowledgedBy

• Optional acknowledgedBy: string

The actor (user or system) who acknowledged the event

Inherited from

JobCompletedEvent.acknowledgedBy

Defined in

src/api/resources/events/types/BaseEvent.ts:26

---

attributes

• Optional attributes: EventAttributes

The attributes of the event

Inherited from

JobCompletedEvent.attributes

Defined in

src/api/resources/events/types/BaseEvent.ts:14

---

callbackUrl

• Optional callbackUrl: string

The callback url to acknowledge the event

Inherited from

JobCompletedEvent.callbackUrl

Defined in

src/api/resources/events/types/BaseEvent.ts:16

---

context

• context: Context

The context of the event

Inherited from

JobCompletedEvent.context

Defined in

src/api/resources/events/types/BaseEvent.ts:12

---

createdAt

• createdAt: Date

Date the event was created

Inherited from

JobCompletedEvent.createdAt

Defined in

src/api/resources/events/types/BaseEvent.ts:20

---

dataUrl

• Optional dataUrl: string

The url to retrieve the data associated with the event

Inherited from

JobCompletedEvent.dataUrl

Defined in

src/api/resources/events/types/BaseEvent.ts:18

---

deletedAt

• Optional deletedAt: Date

Date the event was deleted

Inherited from

JobCompletedEvent.deletedAt

Defined in

src/api/resources/events/types/BaseEvent.ts:22

---

domain

• domain: Domain

The domain of the event

Inherited from

JobCompletedEvent.domain

Defined in

src/api/resources/events/types/BaseEvent.ts:9

---

origin

• Optional origin: Origin

Inherited from

JobCompletedEvent.origin

Defined in

src/api/resources/events/types/BaseEvent.ts:28

---

payload

• payload: JobPayload

Inherited from

JobCompletedEvent.payload

Defined in

src/api/resources/events/types/JobCompletedEvent.ts:8

---

target

• Optional target: string

Inherited from

JobCompletedEvent.target

Defined in

src/api/resources/events/types/BaseEvent.ts:27

---

topic

• topic: EventTopic

Inherited from

JobCompletedEvent.topic

Defined in

src/api/resources/events/types/BaseEvent.ts:10

---

type

• type: "job_completed"

Defined in

src/api/resources/events/types/Event.ts:103

@flatfile/api / Exports / Flatfile / events / Event / JobDeleted

Interface: JobDeleted

events.Event.JobDeleted

Hierarchy

• JobDeletedEvent

  ↳ JobDeleted

Table of contents

Properties

• acknowledgedAt
• acknowledgedBy
• attributes
• callbackUrl
• context
• createdAt
• dataUrl
• deletedAt
• domain
• origin
• payload
• target
• topic
• type

Properties

acknowledgedAt

• Optional acknowledgedAt: string

Date the event was acknowledged

Inherited from

JobDeletedEvent.acknowledgedAt

Defined in

src/api/resources/events/types/BaseEvent.ts:24

---

acknowledgedBy

• Optional acknowledgedBy: string

The actor (user or system) who acknowledged the event

Inherited from

JobDeletedEvent.acknowledgedBy

Defined in

src/api/resources/events/types/BaseEvent.ts:26

---

attributes

• Optional attributes: EventAttributes

The attributes of the event

Inherited from

JobDeletedEvent.attributes

Defined in

src/api/resources/events/types/BaseEvent.ts:14

---

callbackUrl

• Optional callbackUrl: string

The callback url to acknowledge the event

Inherited from

JobDeletedEvent.callbackUrl

Defined in

src/api/resources/events/types/BaseEvent.ts:16

---

context

• context: Context

The context of the event

Inherited from

JobDeletedEvent.context

Defined in

src/api/resources/events/types/BaseEvent.ts:12

---

createdAt

• createdAt: Date

Date the event was created

Inherited from

JobDeletedEvent.createdAt

Defined in

src/api/resources/events/types/BaseEvent.ts:20

---

dataUrl

• Optional dataUrl: string

The url to retrieve the data associated with the event

Inherited from

JobDeletedEvent.dataUrl

Defined in

src/api/resources/events/types/BaseEvent.ts:18

---

deletedAt

• Optional deletedAt: Date

Date the event was deleted

Inherited from

JobDeletedEvent.deletedAt

Defined in

src/api/resources/events/types/BaseEvent.ts:22

---

domain

• domain: Domain

The domain of the event

Inherited from

JobDeletedEvent.domain

Defined in

src/api/resources/events/types/BaseEvent.ts:9

---

origin

• Optional origin: Origin

Inherited from

JobDeletedEvent.origin

Defined in

src/api/resources/events/types/BaseEvent.ts:28

---

payload

• payload: Record<string, unknown>

Inherited from

JobDeletedEvent.payload

Defined in

src/api/resources/events/types/JobDeletedEvent.ts:8

---

target

• Optional target: string

Inherited from

JobDeletedEvent.target

Defined in

src/api/resources/events/types/BaseEvent.ts:27

---

topic

• topic: EventTopic

Inherited from

JobDeletedEvent.topic

Defined in

src/api/resources/events/types/BaseEvent.ts:10

---

type

• type: "job:deleted"

Defined in

src/api/resources/events/types/Event.ts:107

@flatfile/api / Exports / Flatfile / events / Event / JobFailed

Interface: JobFailed

events.Event.JobFailed

Hierarchy

• JobFailedEvent

  ↳ JobFailed

Table of contents

Properties

• acknowledgedAt
• acknowledgedBy
• attributes
• callbackUrl
• context
• createdAt
• dataUrl
• deletedAt
• domain
• origin
• payload
• target
• topic
• type

Properties

acknowledgedAt

• Optional acknowledgedAt: string

Date the event was acknowledged

Inherited from

JobFailedEvent.acknowledgedAt

Defined in

src/api/resources/events/types/BaseEvent.ts:24

---

acknowledgedBy

• Optional acknowledgedBy: string

The actor (user or system) who acknowledged the event

Inherited from

JobFailedEvent.acknowledgedBy

Defined in

src/api/resources/events/types/BaseEvent.ts:26

---

attributes

• Optional attributes: EventAttributes

The attributes of the event

Inherited from

JobFailedEvent.attributes

Defined in

src/api/resources/events/types/BaseEvent.ts:14

---

callbackUrl

• Optional callbackUrl: string

The callback url to acknowledge the event

Inherited from

JobFailedEvent.callbackUrl

Defined in

src/api/resources/events/types/BaseEvent.ts:16

---

context

• context: Context

The context of the event

Inherited from

JobFailedEvent.context

Defined in

src/api/resources/events/types/BaseEvent.ts:12

---

createdAt

• createdAt: Date

Date the event was created

Inherited from

JobFailedEvent.createdAt

Defined in

src/api/resources/events/types/BaseEvent.ts:20

---

dataUrl

• Optional dataUrl: string

The url to retrieve the data associated with the event

Inherited from

JobFailedEvent.dataUrl

Defined in

src/api/resources/events/types/BaseEvent.ts:18

---

deletedAt

• Optional deletedAt: Date

Date the event was deleted

Inherited from

JobFailedEvent.deletedAt

Defined in

src/api/resources/events/types/BaseEvent.ts:22

---

domain

• domain: Domain

The domain of the event

Inherited from

JobFailedEvent.domain

Defined in

src/api/resources/events/types/BaseEvent.ts:9

---

origin

• Optional origin: Origin

Inherited from

JobFailedEvent.origin

Defined in

src/api/resources/events/types/BaseEvent.ts:28

---

payload

• payload: JobFailedPayload

Inherited from

JobFailedEvent.payload

Defined in

src/api/resources/events/types/JobFailedEvent.ts:8

---

target

• Optional target: string

Inherited from

JobFailedEvent.target

Defined in

src/api/resources/events/types/BaseEvent.ts:27

---

topic

• topic: EventTopic

Inherited from

JobFailedEvent.topic

Defined in

src/api/resources/events/types/BaseEvent.ts:10

---

type

• type: "job:failed"

Defined in

src/api/resources/events/types/Event.ts:99

@flatfile/api / Exports / Flatfile / events / Event / JobStarted

Interface: JobStarted

events.Event.JobStarted

Hierarchy

• JobStartedEvent

  ↳ JobStarted

Table of contents

Properties

• acknowledgedAt
• acknowledgedBy
• attributes
• callbackUrl
• context
• createdAt
• dataUrl
• deletedAt
• domain
• origin
• payload
• target
• topic
• type

Properties

acknowledgedAt

• Optional acknowledgedAt: string

Date the event was acknowledged

Inherited from

JobStartedEvent.acknowledgedAt

Defined in

src/api/resources/events/types/BaseEvent.ts:24

---

acknowledgedBy

• Optional acknowledgedBy: string

The actor (user or system) who acknowledged the event

Inherited from

JobStartedEvent.acknowledgedBy

Defined in

src/api/resources/events/types/BaseEvent.ts:26

---

attributes

• Optional attributes: EventAttributes

The attributes of the event

Inherited from

JobStartedEvent.attributes

Defined in

src/api/resources/events/types/BaseEvent.ts:14

---

callbackUrl

• Optional callbackUrl: string

The callback url to acknowledge the event

Inherited from

JobStartedEvent.callbackUrl

Defined in

src/api/resources/events/types/BaseEvent.ts:16

---

context

• context: Context

The context of the event

Inherited from

JobStartedEvent.context

Defined in

src/api/resources/events/types/BaseEvent.ts:12

---

createdAt

• createdAt: Date

Date the event was created

Inherited from

JobStartedEvent.createdAt

Defined in

src/api/resources/events/types/BaseEvent.ts:20

---

dataUrl

• Optional dataUrl: string

The url to retrieve the data associated with the event

Inherited from

JobStartedEvent.dataUrl

Defined in

src/api/resources/events/types/BaseEvent.ts:18

---

deletedAt

• Optional deletedAt: Date

Date the event was deleted

Inherited from

JobStartedEvent.deletedAt

Defined in

src/api/resources/events/types/BaseEvent.ts:22

---

domain

• domain: Domain

The domain of the event

Inherited from

JobStartedEvent.domain

Defined in

src/api/resources/events/types/BaseEvent.ts:9

---

origin

• Optional origin: Origin

Inherited from

JobStartedEvent.origin

Defined in

src/api/resources/events/types/BaseEvent.ts:28

---

payload

• payload: JobPayload

Inherited from

JobStartedEvent.payload

Defined in

src/api/resources/events/types/JobStartedEvent.ts:8

---

target

• Optional target: string

Inherited from

JobStartedEvent.target

Defined in

src/api/resources/events/types/BaseEvent.ts:27

---

topic

• topic: EventTopic

Inherited from

JobStartedEvent.topic

Defined in

src/api/resources/events/types/BaseEvent.ts:10

---

type

• type: "job:started"

Defined in

src/api/resources/events/types/Event.ts:87

@flatfile/api / Exports / Flatfile / events / Event / JobUpdated

Interface: JobUpdated

events.Event.JobUpdated

Hierarchy

• JobUpdatedEvent

  ↳ JobUpdated

Table of contents

Properties

• acknowledgedAt
• acknowledgedBy
• attributes
• callbackUrl
• context
• createdAt
• dataUrl
• deletedAt
• domain
• origin
• payload
• target
• topic
• type

Properties

acknowledgedAt

• Optional acknowledgedAt: string

Date the event was acknowledged

Inherited from

JobUpdatedEvent.acknowledgedAt

Defined in

src/api/resources/events/types/BaseEvent.ts:24

---

acknowledgedBy

• Optional acknowledgedBy: string

The actor (user or system) who acknowledged the event

Inherited from

JobUpdatedEvent.acknowledgedBy

Defined in

src/api/resources/events/types/BaseEvent.ts:26

---

attributes

• Optional attributes: EventAttributes

The attributes of the event

Inherited from

JobUpdatedEvent.attributes

Defined in

src/api/resources/events/types/BaseEvent.ts:14

---

callbackUrl

• Optional callbackUrl: string

The callback url to acknowledge the event

Inherited from

JobUpdatedEvent.callbackUrl

Defined in

src/api/resources/events/types/BaseEvent.ts:16

---

context

• context: Context

The context of the event

Inherited from

JobUpdatedEvent.context

Defined in

src/api/resources/events/types/BaseEvent.ts:12

---

createdAt

• createdAt: Date

Date the event was created

Inherited from

JobUpdatedEvent.createdAt

Defined in

src/api/resources/events/types/BaseEvent.ts:20

---

dataUrl

• Optional dataUrl: string

The url to retrieve the data associated with the event

Inherited from

JobUpdatedEvent.dataUrl

Defined in

src/api/resources/events/types/BaseEvent.ts:18

---

deletedAt

• Optional deletedAt: Date

Date the event was deleted

Inherited from

JobUpdatedEvent.deletedAt

Defined in

src/api/resources/events/types/BaseEvent.ts:22

---

domain

• domain: Domain

The domain of the event

Inherited from

JobUpdatedEvent.domain

Defined in

src/api/resources/events/types/BaseEvent.ts:9

---

origin

• Optional origin: Origin

Inherited from

JobUpdatedEvent.origin

Defined in

src/api/resources/events/types/BaseEvent.ts:28

---

payload

• payload: JobPayload

Inherited from

JobUpdatedEvent.payload

Defined in

src/api/resources/events/types/JobUpdatedEvent.ts:8

---

target

• Optional target: string

Inherited from

JobUpdatedEvent.target

Defined in

src/api/resources/events/types/BaseEvent.ts:27

---

topic

• topic: EventTopic

Inherited from

JobUpdatedEvent.topic

Defined in

src/api/resources/events/types/BaseEvent.ts:10

---

type

• type: "job:updated"

Defined in

src/api/resources/events/types/Event.ts:95

@flatfile/api / Exports / Flatfile / events / Event / JobWaiting

Interface: JobWaiting

events.Event.JobWaiting

Hierarchy

• JobWaitingEvent

  ↳ JobWaiting

Table of contents

Properties

• acknowledgedAt
• acknowledgedBy
• attributes
• callbackUrl
• context
• createdAt
• dataUrl
• deletedAt
• domain
• origin
• payload
• target
• topic
• type

Properties

acknowledgedAt

• Optional acknowledgedAt: string

Date the event was acknowledged

Inherited from

JobWaitingEvent.acknowledgedAt

Defined in

src/api/resources/events/types/BaseEvent.ts:24

---

acknowledgedBy

• Optional acknowledgedBy: string

The actor (user or system) who acknowledged the event

Inherited from

JobWaitingEvent.acknowledgedBy

Defined in

src/api/resources/events/types/BaseEvent.ts:26

---

attributes

• Optional attributes: EventAttributes

The attributes of the event

Inherited from

JobWaitingEvent.attributes

Defined in

src/api/resources/events/types/BaseEvent.ts:14

---

callbackUrl

• Optional callbackUrl: string

The callback url to acknowledge the event

Inherited from

JobWaitingEvent.callbackUrl

Defined in

src/api/resources/events/types/BaseEvent.ts:16

---

context

• context: Context

The context of the event

Inherited from

JobWaitingEvent.context

Defined in

src/api/resources/events/types/BaseEvent.ts:12

---

createdAt

• createdAt: Date

Date the event was created

Inherited from

JobWaitingEvent.createdAt

Defined in

src/api/resources/events/types/BaseEvent.ts:20

---

dataUrl

• Optional dataUrl: string

The url to retrieve the data associated with the event

Inherited from

JobWaitingEvent.dataUrl

Defined in

src/api/resources/events/types/BaseEvent.ts:18

---

deletedAt

• Optional deletedAt: Date

Date the event was deleted

Inherited from

JobWaitingEvent.deletedAt

Defined in

src/api/resources/events/types/BaseEvent.ts:22

---

domain

• domain: Domain

The domain of the event

Inherited from

JobWaitingEvent.domain

Defined in

src/api/resources/events/types/BaseEvent.ts:9

---

origin

• Optional origin: Origin

Inherited from

JobWaitingEvent.origin

Defined in

src/api/resources/events/types/BaseEvent.ts:28

---

payload

• payload: Record<string, unknown>

Inherited from

JobWaitingEvent.payload

Defined in

src/api/resources/events/types/JobWaitingEvent.ts:8

---

target

• Optional target: string

Inherited from

JobWaitingEvent.target

Defined in

src/api/resources/events/types/BaseEvent.ts:27

---

topic

• topic: EventTopic

Inherited from

JobWaitingEvent.topic

Defined in

src/api/resources/events/types/BaseEvent.ts:10

---

type

• type: "job:waiting"

Defined in

src/api/resources/events/types/Event.ts:91

@flatfile/api / Exports / Flatfile / events / Event / RecordsCreated

Interface: RecordsCreated

events.Event.RecordsCreated

Hierarchy

• RecordsCreatedEvent

  ↳ RecordsCreated

Table of contents

Properties

• acknowledgedAt
• acknowledgedBy
• attributes
• callbackUrl
• context
• createdAt
• dataUrl
• deletedAt
• domain
• origin
• payload
• target
• topic
• type

Properties

acknowledgedAt

• Optional acknowledgedAt: string

Date the event was acknowledged

Inherited from

RecordsCreatedEvent.acknowledgedAt

Defined in

src/api/resources/events/types/BaseEvent.ts:24

---

acknowledgedBy

• Optional acknowledgedBy: string

The actor (user or system) who acknowledged the event

Inherited from

RecordsCreatedEvent.acknowledgedBy

Defined in

src/api/resources/events/types/BaseEvent.ts:26

---

attributes

• Optional attributes: EventAttributes

The attributes of the event

Inherited from

RecordsCreatedEvent.attributes

Defined in

src/api/resources/events/types/BaseEvent.ts:14

---

callbackUrl

• Optional callbackUrl: string

The callback url to acknowledge the event

Inherited from

RecordsCreatedEvent.callbackUrl

Defined in

src/api/resources/events/types/BaseEvent.ts:16

---

context

• context: Context

The context of the event

Inherited from

RecordsCreatedEvent.context

Defined in

src/api/resources/events/types/BaseEvent.ts:12

---

createdAt

• createdAt: Date

Date the event was created

Inherited from

RecordsCreatedEvent.createdAt

Defined in

src/api/resources/events/types/BaseEvent.ts:20

---

dataUrl

• Optional dataUrl: string

The url to retrieve the data associated with the event

Inherited from

RecordsCreatedEvent.dataUrl

Defined in

src/api/resources/events/types/BaseEvent.ts:18

---

deletedAt

• Optional deletedAt: Date

Date the event was deleted

Inherited from

RecordsCreatedEvent.deletedAt

Defined in

src/api/resources/events/types/BaseEvent.ts:22

---

domain

• domain: Domain

The domain of the event

Inherited from

RecordsCreatedEvent.domain

Defined in

src/api/resources/events/types/BaseEvent.ts:9

---

origin

• Optional origin: Origin

Inherited from

RecordsCreatedEvent.origin

Defined in

src/api/resources/events/types/BaseEvent.ts:28

---

payload

• payload: RecordsPayload

Inherited from

RecordsCreatedEvent.payload

Defined in

src/api/resources/events/types/RecordsCreatedEvent.ts:8

---

target

• Optional target: string

Inherited from

RecordsCreatedEvent.target

Defined in

src/api/resources/events/types/BaseEvent.ts:27

---

topic

• topic: EventTopic

Inherited from

RecordsCreatedEvent.topic

Defined in

src/api/resources/events/types/BaseEvent.ts:10

---

type

• type: "records:created"

Defined in

src/api/resources/events/types/Event.ts:111

@flatfile/api / Exports / Flatfile / events / Event / RecordsDeleted

Interface: RecordsDeleted

events.Event.RecordsDeleted

Hierarchy

• RecordsDeletedEvent

  ↳ RecordsDeleted

Table of contents

Properties

• acknowledgedAt
• acknowledgedBy
• attributes
• callbackUrl
• context
• createdAt
• dataUrl
• deletedAt
• domain
• origin
• payload
• target
• topic
• type

Properties

acknowledgedAt

• Optional acknowledgedAt: string

Date the event was acknowledged

Inherited from

RecordsDeletedEvent.acknowledgedAt

Defined in

src/api/resources/events/types/BaseEvent.ts:24

---

acknowledgedBy

• Optional acknowledgedBy: string

The actor (user or system) who acknowledged the event

Inherited from

RecordsDeletedEvent.acknowledgedBy

Defined in

src/api/resources/events/types/BaseEvent.ts:26

---

attributes

• Optional attributes: EventAttributes

The attributes of the event

Inherited from

RecordsDeletedEvent.attributes

Defined in

src/api/resources/events/types/BaseEvent.ts:14

---

callbackUrl

• Optional callbackUrl: string

The callback url to acknowledge the event

Inherited from

RecordsDeletedEvent.callbackUrl

Defined in

src/api/resources/events/types/BaseEvent.ts:16

---

context

• context: Context

The context of the event

Inherited from

RecordsDeletedEvent.context

Defined in

src/api/resources/events/types/BaseEvent.ts:12

---

createdAt

• createdAt: Date

Date the event was created

Inherited from

RecordsDeletedEvent.createdAt

Defined in

src/api/resources/events/types/BaseEvent.ts:20

---

dataUrl

• Optional dataUrl: string

The url to retrieve the data associated with the event

Inherited from

RecordsDeletedEvent.dataUrl

Defined in

src/api/resources/events/types/BaseEvent.ts:18

---

deletedAt

• Optional deletedAt: Date

Date the event was deleted

Inherited from

RecordsDeletedEvent.deletedAt

Defined in

src/api/resources/events/types/BaseEvent.ts:22

---

domain

• domain: Domain

The domain of the event

Inherited from

RecordsDeletedEvent.domain

Defined in

src/api/resources/events/types/BaseEvent.ts:9

---

origin

• Optional origin: Origin

Inherited from

RecordsDeletedEvent.origin

Defined in

src/api/resources/events/types/BaseEvent.ts:28

---

payload

• payload: Record<string, unknown>

Inherited from

RecordsDeletedEvent.payload

Defined in

src/api/resources/events/types/RecordsDeletedEvent.ts:8

---

target

• Optional target: string

Inherited from

RecordsDeletedEvent.target

Defined in

src/api/resources/events/types/BaseEvent.ts:27

---

topic

• topic: EventTopic

Inherited from

RecordsDeletedEvent.topic

Defined in

src/api/resources/events/types/BaseEvent.ts:10

---

type

• type: "records:deleted"

Defined in

src/api/resources/events/types/Event.ts:119

@flatfile/api / Exports / Flatfile / events / Event / RecordsUpdated

Interface: RecordsUpdated

events.Event.RecordsUpdated

Hierarchy

• RecordsUpdatedEvent

  ↳ RecordsUpdated

Table of contents

Properties

• acknowledgedAt
• acknowledgedBy
• attributes
• callbackUrl
• context
• createdAt
• dataUrl
• deletedAt
• domain
• origin
• payload
• target
• topic
• type

Properties

acknowledgedAt

• Optional acknowledgedAt: string

Date the event was acknowledged

Inherited from

RecordsUpdatedEvent.acknowledgedAt

Defined in

src/api/resources/events/types/BaseEvent.ts:24

---

acknowledgedBy

• Optional acknowledgedBy: string

The actor (user or system) who acknowledged the event

Inherited from

RecordsUpdatedEvent.acknowledgedBy

Defined in

src/api/resources/events/types/BaseEvent.ts:26

---

attributes

• Optional attributes: EventAttributes

The attributes of the event

Inherited from

RecordsUpdatedEvent.attributes

Defined in

src/api/resources/events/types/BaseEvent.ts:14

---

callbackUrl

• Optional callbackUrl: string

The callback url to acknowledge the event

Inherited from

RecordsUpdatedEvent.callbackUrl

Defined in

src/api/resources/events/types/BaseEvent.ts:16

---

context

• context: Context

The context of the event

Inherited from

RecordsUpdatedEvent.context

Defined in

src/api/resources/events/types/BaseEvent.ts:12

---

createdAt

• createdAt: Date

Date the event was created

Inherited from

RecordsUpdatedEvent.createdAt

Defined in

src/api/resources/events/types/BaseEvent.ts:20

---

dataUrl

• Optional dataUrl: string

The url to retrieve the data associated with the event

Inherited from

RecordsUpdatedEvent.dataUrl

Defined in

src/api/resources/events/types/BaseEvent.ts:18

---

deletedAt

• Optional deletedAt: Date

Date the event was deleted

Inherited from

RecordsUpdatedEvent.deletedAt

Defined in

src/api/resources/events/types/BaseEvent.ts:22

---

domain

• domain: Domain

The domain of the event

Inherited from

RecordsUpdatedEvent.domain

Defined in

src/api/resources/events/types/BaseEvent.ts:9

---

origin

• Optional origin: Origin

Inherited from

RecordsUpdatedEvent.origin

Defined in

src/api/resources/events/types/BaseEvent.ts:28

---

payload

• payload: RecordsPayload

Inherited from

RecordsUpdatedEvent.payload

Defined in

src/api/resources/events/types/RecordsUpdatedEvent.ts:8

---

target

• Optional target: string

Inherited from

RecordsUpdatedEvent.target

Defined in

src/api/resources/events/types/BaseEvent.ts:27

---

topic

• topic: EventTopic

Inherited from

RecordsUpdatedEvent.topic

Defined in

src/api/resources/events/types/BaseEvent.ts:10

---

type

• type: "records:updated"

Defined in

src/api/resources/events/types/Event.ts:115

@flatfile/api / Exports / Flatfile / events / Event / SheetValidated

Interface: SheetValidated

events.Event.SheetValidated

Hierarchy

• SheetValidatedEvent

  ↳ SheetValidated

Table of contents

Properties

• acknowledgedAt
• acknowledgedBy
• attributes
• callbackUrl
• context
• createdAt
• dataUrl
• deletedAt
• domain
• origin
• payload
• target
• topic
• type

Properties

acknowledgedAt

• Optional acknowledgedAt: string

Date the event was acknowledged

Inherited from

SheetValidatedEvent.acknowledgedAt

Defined in

src/api/resources/events/types/BaseEvent.ts:24

---

acknowledgedBy

• Optional acknowledgedBy: string

The actor (user or system) who acknowledged the event

Inherited from

SheetValidatedEvent.acknowledgedBy

Defined in

src/api/resources/events/types/BaseEvent.ts:26

---

attributes

• Optional attributes: EventAttributes

The attributes of the event

Inherited from

SheetValidatedEvent.attributes

Defined in

src/api/resources/events/types/BaseEvent.ts:14

---

callbackUrl

• Optional callbackUrl: string

The callback url to acknowledge the event

Inherited from

SheetValidatedEvent.callbackUrl

Defined in

src/api/resources/events/types/BaseEvent.ts:16

---

context

• context: Context

The context of the event

Inherited from

SheetValidatedEvent.context

Defined in

src/api/resources/events/types/BaseEvent.ts:12

---

createdAt

• createdAt: Date

Date the event was created

Inherited from

SheetValidatedEvent.createdAt

Defined in

src/api/resources/events/types/BaseEvent.ts:20

---

dataUrl

• Optional dataUrl: string

The url to retrieve the data associated with the event

Inherited from

SheetValidatedEvent.dataUrl

Defined in

src/api/resources/events/types/BaseEvent.ts:18

---

deletedAt

• Optional deletedAt: Date

Date the event was deleted

Inherited from

SheetValidatedEvent.deletedAt

Defined in

src/api/resources/events/types/BaseEvent.ts:22

---

domain

• domain: Domain

The domain of the event

Inherited from

SheetValidatedEvent.domain

Defined in

src/api/resources/events/types/BaseEvent.ts:9

---

origin

• Optional origin: Origin

Inherited from

SheetValidatedEvent.origin

Defined in

src/api/resources/events/types/BaseEvent.ts:28

---

payload

• payload: Record<string, unknown>

Inherited from

SheetValidatedEvent.payload

Defined in

src/api/resources/events/types/SheetValidatedEvent.ts:8

---

target

• Optional target: string

Inherited from

SheetValidatedEvent.target

Defined in

src/api/resources/events/types/BaseEvent.ts:27

---

topic

• topic: EventTopic

Inherited from

SheetValidatedEvent.topic

Defined in

src/api/resources/events/types/BaseEvent.ts:10

---

type

• type: "sheet:validated"

Defined in

src/api/resources/events/types/Event.ts:123

@flatfile/api / Exports / Flatfile / events / Event / SpaceAdded

Interface: SpaceAdded

events.Event.SpaceAdded

Hierarchy

• SpaceAddedEvent

  ↳ SpaceAdded

Table of contents

Properties

• acknowledgedAt
• acknowledgedBy
• attributes
• callbackUrl
• context
• createdAt
• dataUrl
• deletedAt
• domain
• origin
• payload
• target
• topic
• type

Properties

acknowledgedAt

• Optional acknowledgedAt: string

Date the event was acknowledged

Inherited from

SpaceAddedEvent.acknowledgedAt

Defined in

src/api/resources/events/types/BaseEvent.ts:24

---

acknowledgedBy

• Optional acknowledgedBy: string

The actor (user or system) who acknowledged the event

Inherited from

SpaceAddedEvent.acknowledgedBy

Defined in

src/api/resources/events/types/BaseEvent.ts:26

---

attributes

• Optional attributes: EventAttributes

The attributes of the event

Inherited from

SpaceAddedEvent.attributes

Defined in

src/api/resources/events/types/BaseEvent.ts:14

---

callbackUrl

• Optional callbackUrl: string

The callback url to acknowledge the event

Inherited from

SpaceAddedEvent.callbackUrl

Defined in

src/api/resources/events/types/BaseEvent.ts:16

---

context

• context: Context

The context of the event

Inherited from

SpaceAddedEvent.context

Defined in

src/api/resources/events/types/BaseEvent.ts:12

---

createdAt

• createdAt: Date

Date the event was created

Inherited from

SpaceAddedEvent.createdAt

Defined in

src/api/resources/events/types/BaseEvent.ts:20

---

dataUrl

• Optional dataUrl: string

The url to retrieve the data associated with the event

Inherited from

SpaceAddedEvent.dataUrl

Defined in

src/api/resources/events/types/BaseEvent.ts:18

---

deletedAt

• Optional deletedAt: Date

Date the event was deleted

Inherited from

SpaceAddedEvent.deletedAt

Defined in

src/api/resources/events/types/BaseEvent.ts:22

---

domain

• domain: Domain

The domain of the event

Inherited from

SpaceAddedEvent.domain

Defined in

src/api/resources/events/types/BaseEvent.ts:9

---

origin

• Optional origin: Origin

Inherited from

SpaceAddedEvent.origin

Defined in

src/api/resources/events/types/BaseEvent.ts:28

---

payload

• payload: Record<string, unknown>

Inherited from

SpaceAddedEvent.payload

Defined in

src/api/resources/events/types/SpaceAddedEvent.ts:8

---

target

• Optional target: string

Inherited from

SpaceAddedEvent.target

Defined in

src/api/resources/events/types/BaseEvent.ts:27

---

topic

• topic: EventTopic

Inherited from

SpaceAddedEvent.topic

Defined in

src/api/resources/events/types/BaseEvent.ts:10

---

type

• type: "space:added"

Defined in

src/api/resources/events/types/Event.ts:39

@flatfile/api / Exports / Flatfile / events / Event / SpaceRemoved

Interface: SpaceRemoved

events.Event.SpaceRemoved

Hierarchy

• SpaceRemovedEvent

  ↳ SpaceRemoved

Table of contents

Properties

• acknowledgedAt
• acknowledgedBy
• attributes
• callbackUrl
• context
• createdAt
• dataUrl
• deletedAt
• domain
• origin
• payload
• target
• topic
• type

Properties

acknowledgedAt

• Optional acknowledgedAt: string

Date the event was acknowledged

Inherited from

SpaceRemovedEvent.acknowledgedAt

Defined in

src/api/resources/events/types/BaseEvent.ts:24

---

acknowledgedBy

• Optional acknowledgedBy: string

The actor (user or system) who acknowledged the event

Inherited from

SpaceRemovedEvent.acknowledgedBy

Defined in

src/api/resources/events/types/BaseEvent.ts:26

---

attributes

• Optional attributes: EventAttributes

The attributes of the event

Inherited from

SpaceRemovedEvent.attributes

Defined in

src/api/resources/events/types/BaseEvent.ts:14

---

callbackUrl

• Optional callbackUrl: string

The callback url to acknowledge the event

Inherited from

SpaceRemovedEvent.callbackUrl

Defined in

src/api/resources/events/types/BaseEvent.ts:16

---

context

• context: Context

The context of the event

Inherited from

SpaceRemovedEvent.context

Defined in

src/api/resources/events/types/BaseEvent.ts:12

---

createdAt

• createdAt: Date

Date the event was created

Inherited from

SpaceRemovedEvent.createdAt

Defined in

src/api/resources/events/types/BaseEvent.ts:20

---

dataUrl

• Optional dataUrl: string

The url to retrieve the data associated with the event

Inherited from

SpaceRemovedEvent.dataUrl

Defined in

src/api/resources/events/types/BaseEvent.ts:18

---

deletedAt

• Optional deletedAt: Date

Date the event was deleted

Inherited from

SpaceRemovedEvent.deletedAt

Defined in

src/api/resources/events/types/BaseEvent.ts:22

---

domain

• domain: Domain

The domain of the event

Inherited from

SpaceRemovedEvent.domain

Defined in

src/api/resources/events/types/BaseEvent.ts:9

---

origin

• Optional origin: Origin

Inherited from

SpaceRemovedEvent.origin

Defined in

src/api/resources/events/types/BaseEvent.ts:28

---

payload

• payload: Record<string, unknown>

Inherited from

SpaceRemovedEvent.payload

Defined in

src/api/resources/events/types/SpaceRemovedEvent.ts:8

---

target

• Optional target: string

Inherited from

SpaceRemovedEvent.target

Defined in

src/api/resources/events/types/BaseEvent.ts:27

---

topic

• topic: EventTopic

Inherited from

SpaceRemovedEvent.topic

Defined in

src/api/resources/events/types/BaseEvent.ts:10

---

type

• type: "space:removed"

Defined in

src/api/resources/events/types/Event.ts:43

@flatfile/api / Exports / Flatfile / events / Event / UploadCompleted

Interface: UploadCompleted

events.Event.UploadCompleted

Hierarchy

• UploadCompletedEvent

  ↳ UploadCompleted

Table of contents

Properties

• acknowledgedAt
• acknowledgedBy
• attributes
• callbackUrl
• context
• createdAt
• dataUrl
• deletedAt
• domain
• origin
• payload
• target
• topic
• type

Properties

acknowledgedAt

• Optional acknowledgedAt: string

Date the event was acknowledged

Inherited from

UploadCompletedEvent.acknowledgedAt

Defined in

src/api/resources/events/types/BaseEvent.ts:24

---

acknowledgedBy

• Optional acknowledgedBy: string

The actor (user or system) who acknowledged the event

Inherited from

UploadCompletedEvent.acknowledgedBy

Defined in

src/api/resources/events/types/BaseEvent.ts:26

---

attributes

• Optional attributes: EventAttributes

The attributes of the event

Inherited from

UploadCompletedEvent.attributes

Defined in

src/api/resources/events/types/BaseEvent.ts:14

---

callbackUrl

• Optional callbackUrl: string

The callback url to acknowledge the event

Inherited from

UploadCompletedEvent.callbackUrl

Defined in

src/api/resources/events/types/BaseEvent.ts:16

---

context

• context: Context

The context of the event

Inherited from

UploadCompletedEvent.context

Defined in

src/api/resources/events/types/BaseEvent.ts:12

---

createdAt

• createdAt: Date

Date the event was created

Inherited from

UploadCompletedEvent.createdAt

Defined in

src/api/resources/events/types/BaseEvent.ts:20

---

dataUrl

• Optional dataUrl: string

The url to retrieve the data associated with the event

Inherited from

UploadCompletedEvent.dataUrl

Defined in

src/api/resources/events/types/BaseEvent.ts:18

---

deletedAt

• Optional deletedAt: Date

Date the event was deleted

Inherited from

UploadCompletedEvent.deletedAt

Defined in

src/api/resources/events/types/BaseEvent.ts:22

---

domain

• domain: Domain

The domain of the event

Inherited from

UploadCompletedEvent.domain

Defined in

src/api/resources/events/types/BaseEvent.ts:9

---

origin

• Optional origin: Origin

Inherited from

UploadCompletedEvent.origin

Defined in

src/api/resources/events/types/BaseEvent.ts:28

---

payload

• payload: Record<string, unknown>

Inherited from

UploadCompletedEvent.payload

Defined in

src/api/resources/events/types/UploadCompletedEvent.ts:8

---

target

• Optional target: string

Inherited from

UploadCompletedEvent.target

Defined in

src/api/resources/events/types/BaseEvent.ts:27

---

topic

• topic: EventTopic

Inherited from

UploadCompletedEvent.topic

Defined in

src/api/resources/events/types/BaseEvent.ts:10

---

type

• type: "upload:completed"

Defined in

src/api/resources/events/types/Event.ts:83

@flatfile/api / Exports / Flatfile / events / Event / UploadFailed

Interface: UploadFailed

events.Event.UploadFailed

Hierarchy

• UploadFailedEvent

  ↳ UploadFailed

Table of contents

Properties

• acknowledgedAt
• acknowledgedBy
• attributes
• callbackUrl
• context
• createdAt
• dataUrl
• deletedAt
• domain
• origin
• payload
• target
• topic
• type

Properties

acknowledgedAt

• Optional acknowledgedAt: string

Date the event was acknowledged

Inherited from

UploadFailedEvent.acknowledgedAt

Defined in

src/api/resources/events/types/BaseEvent.ts:24

---

acknowledgedBy

• Optional acknowledgedBy: string

The actor (user or system) who acknowledged the event

Inherited from

UploadFailedEvent.acknowledgedBy

Defined in

src/api/resources/events/types/BaseEvent.ts:26

---

attributes

• Optional attributes: EventAttributes

The attributes of the event

Inherited from

UploadFailedEvent.attributes

Defined in

src/api/resources/events/types/BaseEvent.ts:14

---

callbackUrl

• Optional callbackUrl: string

The callback url to acknowledge the event

Inherited from

UploadFailedEvent.callbackUrl

Defined in

src/api/resources/events/types/BaseEvent.ts:16

---

context

• context: Context

The context of the event

Inherited from

UploadFailedEvent.context

Defined in

src/api/resources/events/types/BaseEvent.ts:12

---

createdAt

• createdAt: Date

Date the event was created

Inherited from

UploadFailedEvent.createdAt

Defined in

src/api/resources/events/types/BaseEvent.ts:20

---

dataUrl

• Optional dataUrl: string

The url to retrieve the data associated with the event

Inherited from

UploadFailedEvent.dataUrl

Defined in

src/api/resources/events/types/BaseEvent.ts:18

---

deletedAt

• Optional deletedAt: Date

Date the event was deleted

Inherited from

UploadFailedEvent.deletedAt

Defined in

src/api/resources/events/types/BaseEvent.ts:22

---

domain

• domain: Domain

The domain of the event

Inherited from

UploadFailedEvent.domain

Defined in

src/api/resources/events/types/BaseEvent.ts:9

---

origin

• Optional origin: Origin

Inherited from

UploadFailedEvent.origin

Defined in

src/api/resources/events/types/BaseEvent.ts:28

---

payload

• payload: Record<string, unknown>

Inherited from

UploadFailedEvent.payload

Defined in

src/api/resources/events/types/UploadFailedEvent.ts:8

---

target

• Optional target: string

Inherited from

UploadFailedEvent.target

Defined in

src/api/resources/events/types/BaseEvent.ts:27

---

topic

• topic: EventTopic

Inherited from

UploadFailedEvent.topic

Defined in

src/api/resources/events/types/BaseEvent.ts:10

---

type

• type: "upload:failed"

Defined in

src/api/resources/events/types/Event.ts:79

@flatfile/api / Exports / Flatfile / events / Event / UploadStarted

Interface: UploadStarted

events.Event.UploadStarted

Hierarchy

• UploadStartedEvent

  ↳ UploadStarted

Table of contents

Properties

• acknowledgedAt
• acknowledgedBy
• attributes
• callbackUrl
• context
• createdAt
• dataUrl
• deletedAt
• domain
• origin
• payload
• target
• topic
• type

Properties

acknowledgedAt

• Optional acknowledgedAt: string

Date the event was acknowledged

Inherited from

UploadStartedEvent.acknowledgedAt

Defined in

src/api/resources/events/types/BaseEvent.ts:24

---

acknowledgedBy

• Optional acknowledgedBy: string

The actor (user or system) who acknowledged the event

Inherited from

UploadStartedEvent.acknowledgedBy

Defined in

src/api/resources/events/types/BaseEvent.ts:26

---

attributes

• Optional attributes: EventAttributes

The attributes of the event

Inherited from

UploadStartedEvent.attributes

Defined in

src/api/resources/events/types/BaseEvent.ts:14

---

callbackUrl

• Optional callbackUrl: string

The callback url to acknowledge the event

Inherited from

UploadStartedEvent.callbackUrl

Defined in

src/api/resources/events/types/BaseEvent.ts:16

---

context

• context: Context

The context of the event

Inherited from

UploadStartedEvent.context

Defined in

src/api/resources/events/types/BaseEvent.ts:12

---

createdAt

• createdAt: Date

Date the event was created

Inherited from

UploadStartedEvent.createdAt

Defined in

src/api/resources/events/types/BaseEvent.ts:20

---

dataUrl

• Optional dataUrl: string

The url to retrieve the data associated with the event

Inherited from

UploadStartedEvent.dataUrl

Defined in

src/api/resources/events/types/BaseEvent.ts:18

---

deletedAt

• Optional deletedAt: Date

Date the event was deleted

Inherited from

UploadStartedEvent.deletedAt

Defined in

src/api/resources/events/types/BaseEvent.ts:22

---

domain

• domain: Domain

The domain of the event

Inherited from

UploadStartedEvent.domain

Defined in

src/api/resources/events/types/BaseEvent.ts:9

---

origin

• Optional origin: Origin

Inherited from

UploadStartedEvent.origin

Defined in

src/api/resources/events/types/BaseEvent.ts:28

---

payload

• payload: Record<string, unknown>

Inherited from

UploadStartedEvent.payload

Defined in

src/api/resources/events/types/UploadStartedEvent.ts:8

---

target

• Optional target: string

Inherited from

UploadStartedEvent.target

Defined in

src/api/resources/events/types/BaseEvent.ts:27

---

topic

• topic: EventTopic

Inherited from

UploadStartedEvent.topic

Defined in

src/api/resources/events/types/BaseEvent.ts:10

---

type

• type: "upload:started"

Defined in

src/api/resources/events/types/Event.ts:75

@flatfile/api / Exports / Flatfile / events / Event / UserAdded

Interface: UserAdded

events.Event.UserAdded

Hierarchy

• UserAddedEvent

  ↳ UserAdded

Table of contents

Properties

• acknowledgedAt
• acknowledgedBy
• attributes
• callbackUrl
• context
• createdAt
• dataUrl
• deletedAt
• domain
• origin
• payload
• target
• topic
• type

Properties

acknowledgedAt

• Optional acknowledgedAt: string

Date the event was acknowledged

Inherited from

UserAddedEvent.acknowledgedAt

Defined in

src/api/resources/events/types/BaseEvent.ts:24

---

acknowledgedBy

• Optional acknowledgedBy: string

The actor (user or system) who acknowledged the event

Inherited from

UserAddedEvent.acknowledgedBy

Defined in

src/api/resources/events/types/BaseEvent.ts:26

---

attributes

• Optional attributes: EventAttributes

The attributes of the event

Inherited from

UserAddedEvent.attributes

Defined in

src/api/resources/events/types/BaseEvent.ts:14

---

callbackUrl

• Optional callbackUrl: string

The callback url to acknowledge the event

Inherited from

UserAddedEvent.callbackUrl

Defined in

src/api/resources/events/types/BaseEvent.ts:16

---

context

• context: Context

The context of the event

Inherited from

UserAddedEvent.context

Defined in

src/api/resources/events/types/BaseEvent.ts:12

---

createdAt

• createdAt: Date

Date the event was created

Inherited from

UserAddedEvent.createdAt

Defined in

src/api/resources/events/types/BaseEvent.ts:20

---

dataUrl

• Optional dataUrl: string

The url to retrieve the data associated with the event

Inherited from

UserAddedEvent.dataUrl

Defined in

src/api/resources/events/types/BaseEvent.ts:18

---

deletedAt

• Optional deletedAt: Date

Date the event was deleted

Inherited from

UserAddedEvent.deletedAt

Defined in

src/api/resources/events/types/BaseEvent.ts:22

---

domain

• domain: Domain

The domain of the event

Inherited from

UserAddedEvent.domain

Defined in

src/api/resources/events/types/BaseEvent.ts:9

---

origin

• Optional origin: Origin

Inherited from

UserAddedEvent.origin

Defined in

src/api/resources/events/types/BaseEvent.ts:28

---

payload

• payload: Record<string, unknown>

Inherited from

UserAddedEvent.payload

Defined in

src/api/resources/events/types/UserAddedEvent.ts:8

---

target

• Optional target: string

Inherited from

UserAddedEvent.target

Defined in

src/api/resources/events/types/BaseEvent.ts:27

---

topic

• topic: EventTopic

Inherited from

UserAddedEvent.topic

Defined in

src/api/resources/events/types/BaseEvent.ts:10

---

type

• type: "user:added"

Defined in

src/api/resources/events/types/Event.ts:59

@flatfile/api / Exports / Flatfile / events / Event / UserOffline

Interface: UserOffline

events.Event.UserOffline

Hierarchy

• UserOfflineEvent

  ↳ UserOffline

Table of contents

Properties

• acknowledgedAt
• acknowledgedBy
• attributes
• callbackUrl
• context
• createdAt
• dataUrl
• deletedAt
• domain
• origin
• payload
• target
• topic
• type

Properties

acknowledgedAt

• Optional acknowledgedAt: string

Date the event was acknowledged

Inherited from

UserOfflineEvent.acknowledgedAt

Defined in

src/api/resources/events/types/BaseEvent.ts:24

---

acknowledgedBy

• Optional acknowledgedBy: string

The actor (user or system) who acknowledged the event

Inherited from

UserOfflineEvent.acknowledgedBy

Defined in

src/api/resources/events/types/BaseEvent.ts:26

---

attributes

• Optional attributes: EventAttributes

The attributes of the event

Inherited from

UserOfflineEvent.attributes

Defined in

src/api/resources/events/types/BaseEvent.ts:14

---

callbackUrl

• Optional callbackUrl: string

The callback url to acknowledge the event

Inherited from

UserOfflineEvent.callbackUrl

Defined in

src/api/resources/events/types/BaseEvent.ts:16

---

context

• context: Context

The context of the event

Inherited from

UserOfflineEvent.context

Defined in

src/api/resources/events/types/BaseEvent.ts:12

---

createdAt

• createdAt: Date

Date the event was created

Inherited from

UserOfflineEvent.createdAt

Defined in

src/api/resources/events/types/BaseEvent.ts:20

---

dataUrl

• Optional dataUrl: string

The url to retrieve the data associated with the event

Inherited from

UserOfflineEvent.dataUrl

Defined in

src/api/resources/events/types/BaseEvent.ts:18

---

deletedAt

• Optional deletedAt: Date

Date the event was deleted

Inherited from

UserOfflineEvent.deletedAt

Defined in

src/api/resources/events/types/BaseEvent.ts:22

---

domain

• domain: Domain

The domain of the event

Inherited from

UserOfflineEvent.domain

Defined in

src/api/resources/events/types/BaseEvent.ts:9

---

origin

• Optional origin: Origin

Inherited from

UserOfflineEvent.origin

Defined in

src/api/resources/events/types/BaseEvent.ts:28

---

payload

• payload: Record<string, unknown>

Inherited from

UserOfflineEvent.payload

Defined in

src/api/resources/events/types/UserOfflineEvent.ts:8

---

target

• Optional target: string

Inherited from

UserOfflineEvent.target

Defined in

src/api/resources/events/types/BaseEvent.ts:27

---

topic

• topic: EventTopic

Inherited from

UserOfflineEvent.topic

Defined in

src/api/resources/events/types/BaseEvent.ts:10

---

type

• type: "user:offline"

Defined in

src/api/resources/events/types/Event.ts:71

@flatfile/api / Exports / Flatfile / events / Event / UserOnline

Interface: UserOnline

events.Event.UserOnline

Hierarchy

• UserOnlineEvent

  ↳ UserOnline

Table of contents

Properties

• acknowledgedAt
• acknowledgedBy
• attributes
• callbackUrl
• context
• createdAt
• dataUrl
• deletedAt
• domain
• origin
• payload
• target
• topic
• type

Properties

acknowledgedAt

• Optional acknowledgedAt: string

Date the event was acknowledged

Inherited from

UserOnlineEvent.acknowledgedAt

Defined in

src/api/resources/events/types/BaseEvent.ts:24

---

acknowledgedBy

• Optional acknowledgedBy: string

The actor (user or system) who acknowledged the event

Inherited from

UserOnlineEvent.acknowledgedBy

Defined in

src/api/resources/events/types/BaseEvent.ts:26

---

attributes

• Optional attributes: EventAttributes

The attributes of the event

Inherited from

UserOnlineEvent.attributes

Defined in

src/api/resources/events/types/BaseEvent.ts:14

---

callbackUrl

• Optional callbackUrl: string

The callback url to acknowledge the event

Inherited from

UserOnlineEvent.callbackUrl

Defined in

src/api/resources/events/types/BaseEvent.ts:16

---

context

• context: Context

The context of the event

Inherited from

UserOnlineEvent.context

Defined in

src/api/resources/events/types/BaseEvent.ts:12

---

createdAt

• createdAt: Date

Date the event was created

Inherited from

UserOnlineEvent.createdAt

Defined in

src/api/resources/events/types/BaseEvent.ts:20

---

dataUrl

• Optional dataUrl: string

The url to retrieve the data associated with the event

Inherited from

UserOnlineEvent.dataUrl

Defined in

src/api/resources/events/types/BaseEvent.ts:18

---

deletedAt

• Optional deletedAt: Date

Date the event was deleted

Inherited from

UserOnlineEvent.deletedAt

Defined in

src/api/resources/events/types/BaseEvent.ts:22

---

domain

• domain: Domain

The domain of the event

Inherited from

UserOnlineEvent.domain

Defined in

src/api/resources/events/types/BaseEvent.ts:9

---

origin

• Optional origin: Origin

Inherited from

UserOnlineEvent.origin

Defined in

src/api/resources/events/types/BaseEvent.ts:28

---

payload

• payload: Record<string, unknown>

Inherited from

UserOnlineEvent.payload

Defined in

src/api/resources/events/types/UserOnlineEvent.ts:8

---

target

• Optional target: string

Inherited from

UserOnlineEvent.target

Defined in

src/api/resources/events/types/BaseEvent.ts:27

---

topic

• topic: EventTopic

Inherited from

UserOnlineEvent.topic

Defined in

src/api/resources/events/types/BaseEvent.ts:10

---

type

• type: "user:online"

Defined in

src/api/resources/events/types/Event.ts:67

@flatfile/api / Exports / Flatfile / events / Event / UserRemoved

Interface: UserRemoved

events.Event.UserRemoved

Hierarchy

• UserRemovedEvent

  ↳ UserRemoved

Table of contents

Properties

• acknowledgedAt
• acknowledgedBy
• attributes
• callbackUrl
• context
• createdAt
• dataUrl
• deletedAt
• domain
• origin
• payload
• target
• topic
• type

Properties

acknowledgedAt

• Optional acknowledgedAt: string

Date the event was acknowledged

Inherited from

UserRemovedEvent.acknowledgedAt

Defined in

src/api/resources/events/types/BaseEvent.ts:24

---

acknowledgedBy

• Optional acknowledgedBy: string

The actor (user or system) who acknowledged the event

Inherited from

UserRemovedEvent.acknowledgedBy

Defined in

src/api/resources/events/types/BaseEvent.ts:26

---

attributes

• Optional attributes: EventAttributes

The attributes of the event

Inherited from

UserRemovedEvent.attributes

Defined in

src/api/resources/events/types/BaseEvent.ts:14

---

callbackUrl

• Optional callbackUrl: string

The callback url to acknowledge the event

Inherited from

UserRemovedEvent.callbackUrl

Defined in

src/api/resources/events/types/BaseEvent.ts:16

---

context

• context: Context

The context of the event

Inherited from

UserRemovedEvent.context

Defined in

src/api/resources/events/types/BaseEvent.ts:12

---

createdAt

• createdAt: Date

Date the event was created

Inherited from

UserRemovedEvent.createdAt

Defined in

src/api/resources/events/types/BaseEvent.ts:20

---

dataUrl

• Optional dataUrl: string

The url to retrieve the data associated with the event

Inherited from

UserRemovedEvent.dataUrl

Defined in

src/api/resources/events/types/BaseEvent.ts:18

---

deletedAt

• Optional deletedAt: Date

Date the event was deleted

Inherited from

UserRemovedEvent.deletedAt

Defined in

src/api/resources/events/types/BaseEvent.ts:22

---

domain

• domain: Domain

The domain of the event

Inherited from

UserRemovedEvent.domain

Defined in

src/api/resources/events/types/BaseEvent.ts:9

---

origin

• Optional origin: Origin

Inherited from

UserRemovedEvent.origin

Defined in

src/api/resources/events/types/BaseEvent.ts:28

---

payload

• payload: Record<string, unknown>

Inherited from

UserRemovedEvent.payload

Defined in

src/api/resources/events/types/UserRemovedEvent.ts:8

---

target

• Optional target: string

Inherited from

UserRemovedEvent.target

Defined in

src/api/resources/events/types/BaseEvent.ts:27

---

topic

• topic: EventTopic

Inherited from

UserRemovedEvent.topic

Defined in

src/api/resources/events/types/BaseEvent.ts:10

---

type

• type: "user:removed"

Defined in

src/api/resources/events/types/Event.ts:63

@flatfile/api / Exports / Flatfile / events / Event / WorkbookAdded

Interface: WorkbookAdded

events.Event.WorkbookAdded

Hierarchy

• WorkbookAddedEvent

  ↳ WorkbookAdded

Table of contents

Properties

• acknowledgedAt
• acknowledgedBy
• attributes
• callbackUrl
• context
• createdAt
• dataUrl
• deletedAt
• domain
• origin
• payload
• target
• topic
• type

Properties

acknowledgedAt

• Optional acknowledgedAt: string

Date the event was acknowledged

Inherited from

WorkbookAddedEvent.acknowledgedAt

Defined in

src/api/resources/events/types/BaseEvent.ts:24

---

acknowledgedBy

• Optional acknowledgedBy: string

The actor (user or system) who acknowledged the event

Inherited from

WorkbookAddedEvent.acknowledgedBy

Defined in

src/api/resources/events/types/BaseEvent.ts:26

---

attributes

• Optional attributes: EventAttributes

The attributes of the event

Inherited from

WorkbookAddedEvent.attributes

Defined in

src/api/resources/events/types/BaseEvent.ts:14

---

callbackUrl

• Optional callbackUrl: string

The callback url to acknowledge the event

Inherited from

WorkbookAddedEvent.callbackUrl

Defined in

src/api/resources/events/types/BaseEvent.ts:16

---

context

• context: Context

The context of the event

Inherited from

WorkbookAddedEvent.context

Defined in

src/api/resources/events/types/BaseEvent.ts:12

---

createdAt

• createdAt: Date

Date the event was created

Inherited from

WorkbookAddedEvent.createdAt

Defined in

src/api/resources/events/types/BaseEvent.ts:20

---

dataUrl

• Optional dataUrl: string

The url to retrieve the data associated with the event

Inherited from

WorkbookAddedEvent.dataUrl

Defined in

src/api/resources/events/types/BaseEvent.ts:18

---

deletedAt

• Optional deletedAt: Date

Date the event was deleted

Inherited from

WorkbookAddedEvent.deletedAt

Defined in

src/api/resources/events/types/BaseEvent.ts:22

---

domain

• domain: Domain

The domain of the event

Inherited from

WorkbookAddedEvent.domain

Defined in

src/api/resources/events/types/BaseEvent.ts:9

---

origin

• Optional origin: Origin

Inherited from

WorkbookAddedEvent.origin

Defined in

src/api/resources/events/types/BaseEvent.ts:28

---

payload

• payload: Record<string, unknown>

Inherited from

WorkbookAddedEvent.payload

Defined in

src/api/resources/events/types/WorkbookAddedEvent.ts:8

---

target

• Optional target: string

Inherited from

WorkbookAddedEvent.target

Defined in

src/api/resources/events/types/BaseEvent.ts:27

---

topic

• topic: EventTopic

Inherited from

WorkbookAddedEvent.topic

Defined in

src/api/resources/events/types/BaseEvent.ts:10

---

type

• type: "workbook:added"

Defined in

src/api/resources/events/types/Event.ts:47

@flatfile/api / Exports / Flatfile / events / Event / WorkbookRemoved

Interface: WorkbookRemoved

events.Event.WorkbookRemoved

Hierarchy

• WorkbookRemovedEvent

  ↳ WorkbookRemoved

Table of contents

Properties

• acknowledgedAt
• acknowledgedBy
• attributes
• callbackUrl
• context
• createdAt
• dataUrl
• deletedAt
• domain
• origin
• payload
• target
• topic
• type

Properties

acknowledgedAt

• Optional acknowledgedAt: string

Date the event was acknowledged

Inherited from

WorkbookRemovedEvent.acknowledgedAt

Defined in

src/api/resources/events/types/BaseEvent.ts:24

---

acknowledgedBy

• Optional acknowledgedBy: string

The actor (user or system) who acknowledged the event

Inherited from

WorkbookRemovedEvent.acknowledgedBy

Defined in

src/api/resources/events/types/BaseEvent.ts:26

---

attributes

• Optional attributes: EventAttributes

The attributes of the event

Inherited from

WorkbookRemovedEvent.attributes

Defined in

src/api/resources/events/types/BaseEvent.ts:14

---

callbackUrl

• Optional callbackUrl: string

The callback url to acknowledge the event

Inherited from

WorkbookRemovedEvent.callbackUrl

Defined in

src/api/resources/events/types/BaseEvent.ts:16

---

context

• context: Context

The context of the event

Inherited from

WorkbookRemovedEvent.context

Defined in

src/api/resources/events/types/BaseEvent.ts:12

---

createdAt

• createdAt: Date

Date the event was created

Inherited from

WorkbookRemovedEvent.createdAt

Defined in

src/api/resources/events/types/BaseEvent.ts:20

---

dataUrl

• Optional dataUrl: string

The url to retrieve the data associated with the event

Inherited from

WorkbookRemovedEvent.dataUrl

Defined in

src/api/resources/events/types/BaseEvent.ts:18

---

deletedAt

• Optional deletedAt: Date

Date the event was deleted

Inherited from

WorkbookRemovedEvent.deletedAt

Defined in

src/api/resources/events/types/BaseEvent.ts:22

---

domain

• domain: Domain

The domain of the event

Inherited from

WorkbookRemovedEvent.domain

Defined in

src/api/resources/events/types/BaseEvent.ts:9

---

origin

• Optional origin: Origin

Inherited from

WorkbookRemovedEvent.origin

Defined in

src/api/resources/events/types/BaseEvent.ts:28

---

payload

• payload: Record<string, unknown>

Inherited from

WorkbookRemovedEvent.payload

Defined in

src/api/resources/events/types/WorkbookRemovedEvent.ts:8

---

target

• Optional target: string

Inherited from

WorkbookRemovedEvent.target

Defined in

src/api/resources/events/types/BaseEvent.ts:27

---

topic

• topic: EventTopic

Inherited from

WorkbookRemovedEvent.topic

Defined in

src/api/resources/events/types/BaseEvent.ts:10

---

type

• type: "workbook:removed"

Defined in

src/api/resources/events/types/Event.ts:55

@flatfile/api / Exports / Flatfile / events / Event / WorkbookUpdated

Interface: WorkbookUpdated

events.Event.WorkbookUpdated

Hierarchy

• WorkbookUpdatedEvent

  ↳ WorkbookUpdated

Table of contents

Properties

• acknowledgedAt
• acknowledgedBy
• attributes
• callbackUrl
• context
• createdAt
• dataUrl
• deletedAt
• domain
• origin
• payload
• target
• topic
• type

Properties

acknowledgedAt

• Optional acknowledgedAt: string

Date the event was acknowledged

Inherited from

WorkbookUpdatedEvent.acknowledgedAt

Defined in

src/api/resources/events/types/BaseEvent.ts:24

---

acknowledgedBy

• Optional acknowledgedBy: string

The actor (user or system) who acknowledged the event

Inherited from

WorkbookUpdatedEvent.acknowledgedBy

Defined in

src/api/resources/events/types/BaseEvent.ts:26

---

attributes

• Optional attributes: EventAttributes

The attributes of the event

Inherited from

WorkbookUpdatedEvent.attributes

Defined in

src/api/resources/events/types/BaseEvent.ts:14

---

callbackUrl

• Optional callbackUrl: string

The callback url to acknowledge the event

Inherited from

WorkbookUpdatedEvent.callbackUrl

Defined in

src/api/resources/events/types/BaseEvent.ts:16

---

context

• context: Context

The context of the event

Inherited from

WorkbookUpdatedEvent.context

Defined in

src/api/resources/events/types/BaseEvent.ts:12

---

createdAt

• createdAt: Date

Date the event was created

Inherited from

WorkbookUpdatedEvent.createdAt

Defined in

src/api/resources/events/types/BaseEvent.ts:20

---

dataUrl

• Optional dataUrl: string

The url to retrieve the data associated with the event

Inherited from

WorkbookUpdatedEvent.dataUrl

Defined in

src/api/resources/events/types/BaseEvent.ts:18

---

deletedAt

• Optional deletedAt: Date

Date the event was deleted

Inherited from

WorkbookUpdatedEvent.deletedAt

Defined in

src/api/resources/events/types/BaseEvent.ts:22

---

domain

• domain: Domain

The domain of the event

Inherited from

WorkbookUpdatedEvent.domain

Defined in

src/api/resources/events/types/BaseEvent.ts:9

---

origin

• Optional origin: Origin

Inherited from

WorkbookUpdatedEvent.origin

Defined in

src/api/resources/events/types/BaseEvent.ts:28

---

payload

• payload: Record<string, unknown>

Inherited from

WorkbookUpdatedEvent.payload

Defined in

src/api/resources/events/types/WorkbookUpdatedEvent.ts:8

---

target

• Optional target: string

Inherited from

WorkbookUpdatedEvent.target

Defined in

src/api/resources/events/types/BaseEvent.ts:27

---

topic

• topic: EventTopic

Inherited from

WorkbookUpdatedEvent.topic

Defined in

src/api/resources/events/types/BaseEvent.ts:10

---

type

• type: "workbook:updated"

Defined in

src/api/resources/events/types/Event.ts:51

@flatfile/api / Exports / Flatfile / events / EventAttributes

Interface: EventAttributes

Flatfile.events.EventAttributes

The attributes of the event

Table of contents

Properties

• progress
• targetUpdatedAt

Properties

progress

• Optional progress: Progress

The progress of the event within a collection of iterable events

Defined in

src/api/resources/events/types/EventAttributes.ts:14

---

targetUpdatedAt

• Optional targetUpdatedAt: Date

Date the related entity was last updated

Defined in

src/api/resources/events/types/EventAttributes.ts:12

@flatfile/api / Exports / Flatfile / events / EventResponse

Interface: EventResponse

Flatfile.events.EventResponse

Table of contents

Properties

• data

Properties

data

• data: Event

Defined in

src/api/resources/events/types/EventResponse.ts:8

@flatfile/api / Exports / Flatfile / events / FileDeletedEvent

Interface: FileDeletedEvent

Flatfile.events.FileDeletedEvent

Hierarchy

• BaseEvent

  ↳ FileDeletedEvent

  ↳↳ FileDeleted

Table of contents

Properties

• acknowledgedAt
• acknowledgedBy
• attributes
• callbackUrl
• context
• createdAt
• dataUrl
• deletedAt
• domain
• origin
• payload
• target
• topic

Properties

acknowledgedAt

• Optional acknowledgedAt: string

Date the event was acknowledged

Inherited from

BaseEvent.acknowledgedAt

Defined in

src/api/resources/events/types/BaseEvent.ts:24

---

acknowledgedBy

• Optional acknowledgedBy: string

The actor (user or system) who acknowledged the event

Inherited from

BaseEvent.acknowledgedBy

Defined in

src/api/resources/events/types/BaseEvent.ts:26

---

attributes

• Optional attributes: EventAttributes

The attributes of the event

Inherited from

BaseEvent.attributes

Defined in

src/api/resources/events/types/BaseEvent.ts:14

---

callbackUrl

• Optional callbackUrl: string

The callback url to acknowledge the event

Inherited from

BaseEvent.callbackUrl

Defined in

src/api/resources/events/types/BaseEvent.ts:16

---

context

• context: Context

The context of the event

Inherited from

BaseEvent.context

Defined in

src/api/resources/events/types/BaseEvent.ts:12

---

createdAt

• createdAt: Date

Date the event was created

Inherited from

BaseEvent.createdAt

Defined in

src/api/resources/events/types/BaseEvent.ts:20

---

dataUrl

• Optional dataUrl: string

The url to retrieve the data associated with the event

Inherited from

BaseEvent.dataUrl

Defined in

src/api/resources/events/types/BaseEvent.ts:18

---

deletedAt

• Optional deletedAt: Date

Date the event was deleted

Inherited from

BaseEvent.deletedAt

Defined in

src/api/resources/events/types/BaseEvent.ts:22

---

domain

• domain: Domain

The domain of the event

Inherited from

BaseEvent.domain

Defined in

src/api/resources/events/types/BaseEvent.ts:9

---

origin

• Optional origin: Origin

Inherited from

BaseEvent.origin

Defined in

src/api/resources/events/types/BaseEvent.ts:28

---

payload

• payload: Record<string, unknown>

Defined in

src/api/resources/events/types/FileDeletedEvent.ts:8

---

target

• Optional target: string

Inherited from

BaseEvent.target

Defined in

src/api/resources/events/types/BaseEvent.ts:27

---

topic

• topic: EventTopic

Inherited from

BaseEvent.topic

Defined in

src/api/resources/events/types/BaseEvent.ts:10

@flatfile/api / Exports / Flatfile / events / GetEventTokenRequest

Interface: GetEventTokenRequest

Flatfile.events.GetEventTokenRequest

Table of contents

Properties

• scope
• spaceId

Properties

scope

• Optional scope: string

The scope of the event stream (space or environment id)

Defined in

src/api/resources/events/client/requests/GetEventTokenRequest.ts:15

---

spaceId

• Optional spaceId: string

The space id

Defined in

src/api/resources/events/client/requests/GetEventTokenRequest.ts:11

@flatfile/api / Exports / Flatfile / events / JobCompletedEvent

Interface: JobCompletedEvent

Flatfile.events.JobCompletedEvent

Hierarchy

• BaseEvent

  ↳ JobCompletedEvent

  ↳↳ JobCompleted

Table of contents

Properties

• acknowledgedAt
• acknowledgedBy
• attributes
• callbackUrl
• context
• createdAt
• dataUrl
• deletedAt
• domain
• origin
• payload
• target
• topic

Properties

acknowledgedAt

• Optional acknowledgedAt: string

Date the event was acknowledged

Inherited from

BaseEvent.acknowledgedAt

Defined in

src/api/resources/events/types/BaseEvent.ts:24

---

acknowledgedBy

• Optional acknowledgedBy: string

The actor (user or system) who acknowledged the event

Inherited from

BaseEvent.acknowledgedBy

Defined in

src/api/resources/events/types/BaseEvent.ts:26

---

attributes

• Optional attributes: EventAttributes

The attributes of the event

Inherited from

BaseEvent.attributes

Defined in

src/api/resources/events/types/BaseEvent.ts:14

---

callbackUrl

• Optional callbackUrl: string

The callback url to acknowledge the event

Inherited from

BaseEvent.callbackUrl

Defined in

src/api/resources/events/types/BaseEvent.ts:16

---

context

• context: Context

The context of the event

Inherited from

BaseEvent.context

Defined in

src/api/resources/events/types/BaseEvent.ts:12

---

createdAt

• createdAt: Date

Date the event was created

Inherited from

BaseEvent.createdAt

Defined in

src/api/resources/events/types/BaseEvent.ts:20

---

dataUrl

• Optional dataUrl: string

The url to retrieve the data associated with the event

Inherited from

BaseEvent.dataUrl

Defined in

src/api/resources/events/types/BaseEvent.ts:18

---

deletedAt

• Optional deletedAt: Date

Date the event was deleted

Inherited from

BaseEvent.deletedAt

Defined in

src/api/resources/events/types/BaseEvent.ts:22

---

domain

• domain: Domain

The domain of the event

Inherited from

BaseEvent.domain

Defined in

src/api/resources/events/types/BaseEvent.ts:9

---

origin

• Optional origin: Origin

Inherited from

BaseEvent.origin

Defined in

src/api/resources/events/types/BaseEvent.ts:28

---

payload

• payload: JobPayload

Defined in

src/api/resources/events/types/JobCompletedEvent.ts:8

---

target

• Optional target: string

Inherited from

BaseEvent.target

Defined in

src/api/resources/events/types/BaseEvent.ts:27

---

topic

• topic: EventTopic

Inherited from

BaseEvent.topic

Defined in

src/api/resources/events/types/BaseEvent.ts:10

@flatfile/api / Exports / Flatfile / events / JobDeletedEvent

Interface: JobDeletedEvent

Flatfile.events.JobDeletedEvent

Hierarchy

• BaseEvent

  ↳ JobDeletedEvent

  ↳↳ JobDeleted

Table of contents

Properties

• acknowledgedAt
• acknowledgedBy
• attributes
• callbackUrl
• context
• createdAt
• dataUrl
• deletedAt
• domain
• origin
• payload
• target
• topic

Properties

acknowledgedAt

• Optional acknowledgedAt: string

Date the event was acknowledged

Inherited from

BaseEvent.acknowledgedAt

Defined in

src/api/resources/events/types/BaseEvent.ts:24

---

acknowledgedBy

• Optional acknowledgedBy: string

The actor (user or system) who acknowledged the event

Inherited from

BaseEvent.acknowledgedBy

Defined in

src/api/resources/events/types/BaseEvent.ts:26

---

attributes

• Optional attributes: EventAttributes

The attributes of the event

Inherited from

BaseEvent.attributes

Defined in

src/api/resources/events/types/BaseEvent.ts:14

---

callbackUrl

• Optional callbackUrl: string

The callback url to acknowledge the event

Inherited from

BaseEvent.callbackUrl

Defined in

src/api/resources/events/types/BaseEvent.ts:16

---

context

• context: Context

The context of the event

Inherited from

BaseEvent.context

Defined in

src/api/resources/events/types/BaseEvent.ts:12

---

createdAt

• createdAt: Date

Date the event was created

Inherited from

BaseEvent.createdAt

Defined in

src/api/resources/events/types/BaseEvent.ts:20

---

dataUrl

• Optional dataUrl: string

The url to retrieve the data associated with the event

Inherited from

BaseEvent.dataUrl

Defined in

src/api/resources/events/types/BaseEvent.ts:18

---

deletedAt

• Optional deletedAt: Date

Date the event was deleted

Inherited from

BaseEvent.deletedAt

Defined in

src/api/resources/events/types/BaseEvent.ts:22

---

domain

• domain: Domain

The domain of the event

Inherited from

BaseEvent.domain

Defined in

src/api/resources/events/types/BaseEvent.ts:9

---

origin

• Optional origin: Origin

Inherited from

BaseEvent.origin

Defined in

src/api/resources/events/types/BaseEvent.ts:28

---

payload

• payload: Record<string, unknown>

Defined in

src/api/resources/events/types/JobDeletedEvent.ts:8

---

target

• Optional target: string

Inherited from

BaseEvent.target

Defined in

src/api/resources/events/types/BaseEvent.ts:27

---

topic

• topic: EventTopic

Inherited from

BaseEvent.topic

Defined in

src/api/resources/events/types/BaseEvent.ts:10

@flatfile/api / Exports / Flatfile / events / JobFailedEvent

Interface: JobFailedEvent

Flatfile.events.JobFailedEvent

Hierarchy

• BaseEvent

  ↳ JobFailedEvent

  ↳↳ JobFailed

Table of contents

Properties

• acknowledgedAt
• acknowledgedBy
• attributes
• callbackUrl
• context
• createdAt
• dataUrl
• deletedAt
• domain
• origin
• payload
• target
• topic

Properties

acknowledgedAt

• Optional acknowledgedAt: string

Date the event was acknowledged

Inherited from

BaseEvent.acknowledgedAt

Defined in

src/api/resources/events/types/BaseEvent.ts:24

---

acknowledgedBy

• Optional acknowledgedBy: string

The actor (user or system) who acknowledged the event

Inherited from

BaseEvent.acknowledgedBy

Defined in

src/api/resources/events/types/BaseEvent.ts:26

---

attributes

• Optional attributes: EventAttributes

The attributes of the event

Inherited from

BaseEvent.attributes

Defined in

src/api/resources/events/types/BaseEvent.ts:14

---

callbackUrl

• Optional callbackUrl: string

The callback url to acknowledge the event

Inherited from

BaseEvent.callbackUrl

Defined in

src/api/resources/events/types/BaseEvent.ts:16

---

context

• context: Context

The context of the event

Inherited from

BaseEvent.context

Defined in

src/api/resources/events/types/BaseEvent.ts:12

---

createdAt

• createdAt: Date

Date the event was created

Inherited from

BaseEvent.createdAt

Defined in

src/api/resources/events/types/BaseEvent.ts:20

---

dataUrl

• Optional dataUrl: string

The url to retrieve the data associated with the event

Inherited from

BaseEvent.dataUrl

Defined in

src/api/resources/events/types/BaseEvent.ts:18

---

deletedAt

• Optional deletedAt: Date

Date the event was deleted

Inherited from

BaseEvent.deletedAt

Defined in

src/api/resources/events/types/BaseEvent.ts:22

---

domain

• domain: Domain

The domain of the event

Inherited from

BaseEvent.domain

Defined in

src/api/resources/events/types/BaseEvent.ts:9

---

origin

• Optional origin: Origin

Inherited from

BaseEvent.origin

Defined in

src/api/resources/events/types/BaseEvent.ts:28

---

payload

• payload: JobFailedPayload

Defined in

src/api/resources/events/types/JobFailedEvent.ts:8

---

target

• Optional target: string

Inherited from

BaseEvent.target

Defined in

src/api/resources/events/types/BaseEvent.ts:27

---

topic

• topic: EventTopic

Inherited from

BaseEvent.topic

Defined in

src/api/resources/events/types/BaseEvent.ts:10

@flatfile/api / Exports / Flatfile / events / JobFailedPayload

Interface: JobFailedPayload

Flatfile.events.JobFailedPayload

Hierarchy

• JobPayload

  ↳ JobFailedPayload

Table of contents

Properties

• err
• operation
• type

Properties

err

• err: string

Defined in

src/api/resources/events/types/JobFailedPayload.ts:8

---

operation

• operation: JobOperationType

Inherited from

JobPayload.operation

Defined in

src/api/resources/events/types/JobPayload.ts:9

---

type

• type: JobPayloadType

Inherited from

JobPayload.type

Defined in

src/api/resources/events/types/JobPayload.ts:8

@flatfile/api / Exports / Flatfile / events / JobPayload

Interface: JobPayload

Flatfile.events.JobPayload

Hierarchy

• JobPayload

  ↳ JobFailedPayload

Table of contents

Properties

• operation
• type

Properties

operation

• operation: JobOperationType

Defined in

src/api/resources/events/types/JobPayload.ts:9

---

type

• type: JobPayloadType

Defined in

src/api/resources/events/types/JobPayload.ts:8

@flatfile/api / Exports / Flatfile / events / JobStartedEvent

Interface: JobStartedEvent

Flatfile.events.JobStartedEvent

Hierarchy

• BaseEvent

  ↳ JobStartedEvent

  ↳↳ JobStarted

Table of contents

Properties

• acknowledgedAt
• acknowledgedBy
• attributes
• callbackUrl
• context
• createdAt
• dataUrl
• deletedAt
• domain
• origin
• payload
• target
• topic

Properties

acknowledgedAt

• Optional acknowledgedAt: string

Date the event was acknowledged

Inherited from

BaseEvent.acknowledgedAt

Defined in

src/api/resources/events/types/BaseEvent.ts:24

---

acknowledgedBy

• Optional acknowledgedBy: string

The actor (user or system) who acknowledged the event

Inherited from

BaseEvent.acknowledgedBy

Defined in

src/api/resources/events/types/BaseEvent.ts:26

---

attributes

• Optional attributes: EventAttributes

The attributes of the event

Inherited from

BaseEvent.attributes

Defined in

src/api/resources/events/types/BaseEvent.ts:14

---

callbackUrl

• Optional callbackUrl: string

The callback url to acknowledge the event

Inherited from

BaseEvent.callbackUrl

Defined in

src/api/resources/events/types/BaseEvent.ts:16

---

context

• context: Context

The context of the event

Inherited from

BaseEvent.context

Defined in

src/api/resources/events/types/BaseEvent.ts:12

---

createdAt

• createdAt: Date

Date the event was created

Inherited from

BaseEvent.createdAt

Defined in

src/api/resources/events/types/BaseEvent.ts:20

---

dataUrl

• Optional dataUrl: string

The url to retrieve the data associated with the event

Inherited from

BaseEvent.dataUrl

Defined in

src/api/resources/events/types/BaseEvent.ts:18

---

deletedAt

• Optional deletedAt: Date

Date the event was deleted

Inherited from

BaseEvent.deletedAt

Defined in

src/api/resources/events/types/BaseEvent.ts:22

---

domain

• domain: Domain

The domain of the event

Inherited from

BaseEvent.domain

Defined in

src/api/resources/events/types/BaseEvent.ts:9

---

origin

• Optional origin: Origin

Inherited from

BaseEvent.origin

Defined in

src/api/resources/events/types/BaseEvent.ts:28

---

payload

• payload: JobPayload

Defined in

src/api/resources/events/types/JobStartedEvent.ts:8

---

target

• Optional target: string

Inherited from

BaseEvent.target

Defined in

src/api/resources/events/types/BaseEvent.ts:27

---

topic

• topic: EventTopic

Inherited from

BaseEvent.topic

Defined in

src/api/resources/events/types/BaseEvent.ts:10

@flatfile/api / Exports / Flatfile / events / JobUpdatedEvent

Interface: JobUpdatedEvent

Flatfile.events.JobUpdatedEvent

Hierarchy

• BaseEvent

  ↳ JobUpdatedEvent

  ↳↳ JobUpdated

Table of contents

Properties

• acknowledgedAt
• acknowledgedBy
• attributes
• callbackUrl
• context
• createdAt
• dataUrl
• deletedAt
• domain
• origin
• payload
• target
• topic

Properties

acknowledgedAt

• Optional acknowledgedAt: string

Date the event was acknowledged

Inherited from

BaseEvent.acknowledgedAt

Defined in

src/api/resources/events/types/BaseEvent.ts:24

---

acknowledgedBy

• Optional acknowledgedBy: string

The actor (user or system) who acknowledged the event

Inherited from

BaseEvent.acknowledgedBy

Defined in

src/api/resources/events/types/BaseEvent.ts:26

---

attributes

• Optional attributes: EventAttributes

The attributes of the event

Inherited from

BaseEvent.attributes

Defined in

src/api/resources/events/types/BaseEvent.ts:14

---

callbackUrl

• Optional callbackUrl: string

The callback url to acknowledge the event

Inherited from

BaseEvent.callbackUrl

Defined in

src/api/resources/events/types/BaseEvent.ts:16

---

context

• context: Context

The context of the event

Inherited from

BaseEvent.context

Defined in

src/api/resources/events/types/BaseEvent.ts:12

---

createdAt

• createdAt: Date

Date the event was created

Inherited from

BaseEvent.createdAt

Defined in

src/api/resources/events/types/BaseEvent.ts:20

---

dataUrl

• Optional dataUrl: string

The url to retrieve the data associated with the event

Inherited from

BaseEvent.dataUrl

Defined in

src/api/resources/events/types/BaseEvent.ts:18

---

deletedAt

• Optional deletedAt: Date

Date the event was deleted

Inherited from

BaseEvent.deletedAt

Defined in

src/api/resources/events/types/BaseEvent.ts:22

---

domain

• domain: Domain

The domain of the event

Inherited from

BaseEvent.domain

Defined in

src/api/resources/events/types/BaseEvent.ts:9

---

origin

• Optional origin: Origin

Inherited from

BaseEvent.origin

Defined in

src/api/resources/events/types/BaseEvent.ts:28

---

payload

• payload: JobPayload

Defined in

src/api/resources/events/types/JobUpdatedEvent.ts:8

---

target

• Optional target: string

Inherited from

BaseEvent.target

Defined in

src/api/resources/events/types/BaseEvent.ts:27

---

topic

• topic: EventTopic

Inherited from

BaseEvent.topic

Defined in

src/api/resources/events/types/BaseEvent.ts:10

@flatfile/api / Exports / Flatfile / events / JobWaitingEvent

Interface: JobWaitingEvent

Flatfile.events.JobWaitingEvent

Hierarchy

• BaseEvent

  ↳ JobWaitingEvent

  ↳↳ JobWaiting

Table of contents

Properties

• acknowledgedAt
• acknowledgedBy
• attributes
• callbackUrl
• context
• createdAt
• dataUrl
• deletedAt
• domain
• origin
• payload
• target
• topic

Properties

acknowledgedAt

• Optional acknowledgedAt: string

Date the event was acknowledged

Inherited from

BaseEvent.acknowledgedAt

Defined in

src/api/resources/events/types/BaseEvent.ts:24

---

acknowledgedBy

• Optional acknowledgedBy: string

The actor (user or system) who acknowledged the event

Inherited from

BaseEvent.acknowledgedBy

Defined in

src/api/resources/events/types/BaseEvent.ts:26

---

attributes

• Optional attributes: EventAttributes

The attributes of the event

Inherited from

BaseEvent.attributes

Defined in

src/api/resources/events/types/BaseEvent.ts:14

---

callbackUrl

• Optional callbackUrl: string

The callback url to acknowledge the event

Inherited from

BaseEvent.callbackUrl

Defined in

src/api/resources/events/types/BaseEvent.ts:16

---

context

• context: Context

The context of the event

Inherited from

BaseEvent.context

Defined in

src/api/resources/events/types/BaseEvent.ts:12

---

createdAt

• createdAt: Date

Date the event was created

Inherited from

BaseEvent.createdAt

Defined in

src/api/resources/events/types/BaseEvent.ts:20

---

dataUrl

• Optional dataUrl: string

The url to retrieve the data associated with the event

Inherited from

BaseEvent.dataUrl

Defined in

src/api/resources/events/types/BaseEvent.ts:18

---

deletedAt

• Optional deletedAt: Date

Date the event was deleted

Inherited from

BaseEvent.deletedAt

Defined in

src/api/resources/events/types/BaseEvent.ts:22

---

domain

• domain: Domain

The domain of the event

Inherited from

BaseEvent.domain

Defined in

src/api/resources/events/types/BaseEvent.ts:9

---

origin

• Optional origin: Origin

Inherited from

BaseEvent.origin

Defined in

src/api/resources/events/types/BaseEvent.ts:28

---

payload

• payload: Record<string, unknown>

Defined in

src/api/resources/events/types/JobWaitingEvent.ts:8

---

target

• Optional target: string

Inherited from

BaseEvent.target

Defined in

src/api/resources/events/types/BaseEvent.ts:27

---

topic

• topic: EventTopic

Inherited from

BaseEvent.topic

Defined in

src/api/resources/events/types/BaseEvent.ts:10

@flatfile/api / Exports / Flatfile / events / ListAllEventsResponse

Interface: ListAllEventsResponse

Flatfile.events.ListAllEventsResponse

Table of contents

Properties

• data

Properties

data

• data: Event[]

Defined in

src/api/resources/events/types/ListAllEventsResponse.ts:8

@flatfile/api / Exports / Flatfile / events / ListEventsRequest

Interface: ListEventsRequest

Flatfile.events.ListEventsRequest

Table of contents

Properties

• domain
• environmentId
• includeAcknowledged
• pageNumber
• pageSize
• since
• spaceId
• topic

Properties

domain

• Optional domain: string

Filter by event domain

Defined in

src/api/resources/events/client/requests/ListEventsRequest.ts:13

---

environmentId

• environmentId: string

Defined in

src/api/resources/events/client/requests/ListEventsRequest.ts:8

---

includeAcknowledged

• Optional includeAcknowledged: boolean

Include acknowledged events

Defined in

src/api/resources/events/client/requests/ListEventsRequest.ts:33

---

pageNumber

• Optional pageNumber: number

Based on pageSize, which page of records to return

Defined in

src/api/resources/events/client/requests/ListEventsRequest.ts:29

---

pageSize

• Optional pageSize: number

Number of tokens to return in a page (default 10)

Defined in

src/api/resources/events/client/requests/ListEventsRequest.ts:25

---

since

• Optional since: string

Filter by event timestamp

Defined in

src/api/resources/events/client/requests/ListEventsRequest.ts:21

---

spaceId

• Optional spaceId: string

Defined in

src/api/resources/events/client/requests/ListEventsRequest.ts:9

---

topic

• Optional topic: string

Filter by event topic

Defined in

src/api/resources/events/client/requests/ListEventsRequest.ts:17

@flatfile/api / Exports / Flatfile / events / Origin

Interface: Origin

Flatfile.events.Origin

The origin resource of the event

Table of contents

Properties

• id
• slug

Properties

id

• Optional id: string

Defined in

src/api/resources/events/types/Origin.ts:9

---

slug

• Optional slug: string

Defined in

src/api/resources/events/types/Origin.ts:10

@flatfile/api / Exports / Flatfile / events / Progress

Interface: Progress

Flatfile.events.Progress

The progress of the event within a collection of iterable events

Table of contents

Properties

• current
• percent
• total

Properties

current

• Optional current: number

The current progress of the event

Defined in

src/api/resources/events/types/Progress.ts:10

---

percent

• Optional percent: number

The percent complete of the event group

Defined in

src/api/resources/events/types/Progress.ts:14

---

total

• Optional total: number

The total number of events in this group

Defined in

src/api/resources/events/types/Progress.ts:12

@flatfile/api / Exports / Flatfile / events / RecordsCreatedEvent

Interface: RecordsCreatedEvent

Flatfile.events.RecordsCreatedEvent

Hierarchy

• BaseEvent

  ↳ RecordsCreatedEvent

  ↳↳ RecordsCreated

Table of contents

Properties

• acknowledgedAt
• acknowledgedBy
• attributes
• callbackUrl
• context
• createdAt
• dataUrl
• deletedAt
• domain
• origin
• payload
• target
• topic

Properties

acknowledgedAt

• Optional acknowledgedAt: string

Date the event was acknowledged

Inherited from

BaseEvent.acknowledgedAt

Defined in

src/api/resources/events/types/BaseEvent.ts:24

---

acknowledgedBy

• Optional acknowledgedBy: string

The actor (user or system) who acknowledged the event

Inherited from

BaseEvent.acknowledgedBy

Defined in

src/api/resources/events/types/BaseEvent.ts:26

---

attributes

• Optional attributes: EventAttributes

The attributes of the event

Inherited from

BaseEvent.attributes

Defined in

src/api/resources/events/types/BaseEvent.ts:14

---

callbackUrl

• Optional callbackUrl: string

The callback url to acknowledge the event

Inherited from

BaseEvent.callbackUrl

Defined in

src/api/resources/events/types/BaseEvent.ts:16

---

context

• context: Context

The context of the event

Inherited from

BaseEvent.context

Defined in

src/api/resources/events/types/BaseEvent.ts:12

---

createdAt

• createdAt: Date

Date the event was created

Inherited from

BaseEvent.createdAt

Defined in

src/api/resources/events/types/BaseEvent.ts:20

---

dataUrl

• Optional dataUrl: string

The url to retrieve the data associated with the event

Inherited from

BaseEvent.dataUrl

Defined in

src/api/resources/events/types/BaseEvent.ts:18

---

deletedAt

• Optional deletedAt: Date

Date the event was deleted

Inherited from

BaseEvent.deletedAt

Defined in

src/api/resources/events/types/BaseEvent.ts:22

---

domain

• domain: Domain

The domain of the event

Inherited from

BaseEvent.domain

Defined in

src/api/resources/events/types/BaseEvent.ts:9

---

origin

• Optional origin: Origin

Inherited from

BaseEvent.origin

Defined in

src/api/resources/events/types/BaseEvent.ts:28

---

payload

• payload: RecordsPayload

Defined in

src/api/resources/events/types/RecordsCreatedEvent.ts:8

---

target

• Optional target: string

Inherited from

BaseEvent.target

Defined in

src/api/resources/events/types/BaseEvent.ts:27

---

topic

• topic: EventTopic

Inherited from

BaseEvent.topic

Defined in

src/api/resources/events/types/BaseEvent.ts:10

@flatfile/api / Exports / Flatfile / events / RecordsDeletedEvent

Interface: RecordsDeletedEvent

Flatfile.events.RecordsDeletedEvent

Hierarchy

• BaseEvent

  ↳ RecordsDeletedEvent

  ↳↳ RecordsDeleted

Table of contents

Properties

• acknowledgedAt
• acknowledgedBy
• attributes
• callbackUrl
• context
• createdAt
• dataUrl
• deletedAt
• domain
• origin
• payload
• target
• topic

Properties

acknowledgedAt

• Optional acknowledgedAt: string

Date the event was acknowledged

Inherited from

BaseEvent.acknowledgedAt

Defined in

src/api/resources/events/types/BaseEvent.ts:24

---

acknowledgedBy

• Optional acknowledgedBy: string

The actor (user or system) who acknowledged the event

Inherited from

BaseEvent.acknowledgedBy

Defined in

src/api/resources/events/types/BaseEvent.ts:26

---

attributes

• Optional attributes: EventAttributes

The attributes of the event

Inherited from

BaseEvent.attributes

Defined in

src/api/resources/events/types/BaseEvent.ts:14

---

callbackUrl

• Optional callbackUrl: string

The callback url to acknowledge the event

Inherited from

BaseEvent.callbackUrl

Defined in

src/api/resources/events/types/BaseEvent.ts:16

---

context

• context: Context

The context of the event

Inherited from

BaseEvent.context

Defined in

src/api/resources/events/types/BaseEvent.ts:12

---

createdAt

• createdAt: Date

Date the event was created

Inherited from

BaseEvent.createdAt

Defined in

src/api/resources/events/types/BaseEvent.ts:20

---

dataUrl

• Optional dataUrl: string

The url to retrieve the data associated with the event

Inherited from

BaseEvent.dataUrl

Defined in

src/api/resources/events/types/BaseEvent.ts:18

---

deletedAt

• Optional deletedAt: Date

Date the event was deleted

Inherited from

BaseEvent.deletedAt

Defined in

src/api/resources/events/types/BaseEvent.ts:22

---

domain

• domain: Domain

The domain of the event

Inherited from

BaseEvent.domain

Defined in

src/api/resources/events/types/BaseEvent.ts:9

---

origin

• Optional origin: Origin

Inherited from

BaseEvent.origin

Defined in

src/api/resources/events/types/BaseEvent.ts:28

---

payload

• payload: Record<string, unknown>

Defined in

src/api/resources/events/types/RecordsDeletedEvent.ts:8

---

target

• Optional target: string

Inherited from

BaseEvent.target

Defined in

src/api/resources/events/types/BaseEvent.ts:27

---

topic

• topic: EventTopic

Inherited from

BaseEvent.topic

Defined in

src/api/resources/events/types/BaseEvent.ts:10

@flatfile/api / Exports / Flatfile / events / RecordsPayload

Interface: RecordsPayload

Flatfile.events.RecordsPayload

This file was auto-generated by Fern from our API Definition.

Table of contents

Properties

• count

Properties

count

• count: number

Defined in

src/api/resources/events/types/RecordsPayload.ts:6

@flatfile/api / Exports / Flatfile / events / RecordsUpdatedEvent

Interface: RecordsUpdatedEvent

Flatfile.events.RecordsUpdatedEvent

Hierarchy

• BaseEvent

  ↳ RecordsUpdatedEvent

  ↳↳ RecordsUpdated

Table of contents

Properties

• acknowledgedAt
• acknowledgedBy
• attributes
• callbackUrl
• context
• createdAt
• dataUrl
• deletedAt
• domain
• origin
• payload
• target
• topic

Properties

acknowledgedAt

• Optional acknowledgedAt: string

Date the event was acknowledged

Inherited from

BaseEvent.acknowledgedAt

Defined in

src/api/resources/events/types/BaseEvent.ts:24

---

acknowledgedBy

• Optional acknowledgedBy: string

The actor (user or system) who acknowledged the event

Inherited from

BaseEvent.acknowledgedBy

Defined in

src/api/resources/events/types/BaseEvent.ts:26

---

attributes

• Optional attributes: EventAttributes

The attributes of the event

Inherited from

BaseEvent.attributes

Defined in

src/api/resources/events/types/BaseEvent.ts:14

---

callbackUrl

• Optional callbackUrl: string

The callback url to acknowledge the event

Inherited from

BaseEvent.callbackUrl

Defined in

src/api/resources/events/types/BaseEvent.ts:16

---

context

• context: Context

The context of the event

Inherited from

BaseEvent.context

Defined in

src/api/resources/events/types/BaseEvent.ts:12

---

createdAt

• createdAt: Date

Date the event was created

Inherited from

BaseEvent.createdAt

Defined in

src/api/resources/events/types/BaseEvent.ts:20

---

dataUrl

• Optional dataUrl: string

The url to retrieve the data associated with the event

Inherited from

BaseEvent.dataUrl

Defined in

src/api/resources/events/types/BaseEvent.ts:18

---

deletedAt

• Optional deletedAt: Date

Date the event was deleted

Inherited from

BaseEvent.deletedAt

Defined in

src/api/resources/events/types/BaseEvent.ts:22

---

domain

• domain: Domain

The domain of the event

Inherited from

BaseEvent.domain

Defined in

src/api/resources/events/types/BaseEvent.ts:9

---

origin

• Optional origin: Origin

Inherited from

BaseEvent.origin

Defined in

src/api/resources/events/types/BaseEvent.ts:28

---

payload

• payload: RecordsPayload

Defined in

src/api/resources/events/types/RecordsUpdatedEvent.ts:8

---

target

• Optional target: string

Inherited from

BaseEvent.target

Defined in

src/api/resources/events/types/BaseEvent.ts:27

---

topic

• topic: EventTopic

Inherited from

BaseEvent.topic

Defined in

src/api/resources/events/types/BaseEvent.ts:10

@flatfile/api / Exports / Flatfile / events / SheetValidatedEvent

Interface: SheetValidatedEvent

Flatfile.events.SheetValidatedEvent

Hierarchy

• BaseEvent

  ↳ SheetValidatedEvent

  ↳↳ SheetValidated

Table of contents

Properties

• acknowledgedAt
• acknowledgedBy
• attributes
• callbackUrl
• context
• createdAt
• dataUrl
• deletedAt
• domain
• origin
• payload
• target
• topic

Properties

acknowledgedAt

• Optional acknowledgedAt: string

Date the event was acknowledged

Inherited from

BaseEvent.acknowledgedAt

Defined in

src/api/resources/events/types/BaseEvent.ts:24

---

acknowledgedBy

• Optional acknowledgedBy: string

The actor (user or system) who acknowledged the event

Inherited from

BaseEvent.acknowledgedBy

Defined in

src/api/resources/events/types/BaseEvent.ts:26

---

attributes

• Optional attributes: EventAttributes

The attributes of the event

Inherited from

BaseEvent.attributes

Defined in

src/api/resources/events/types/BaseEvent.ts:14

---

callbackUrl

• Optional callbackUrl: string

The callback url to acknowledge the event

Inherited from

BaseEvent.callbackUrl

Defined in

src/api/resources/events/types/BaseEvent.ts:16

---

context

• context: Context

The context of the event

Inherited from

BaseEvent.context

Defined in

src/api/resources/events/types/BaseEvent.ts:12

---

createdAt

• createdAt: Date

Date the event was created

Inherited from

BaseEvent.createdAt

Defined in

src/api/resources/events/types/BaseEvent.ts:20

---

dataUrl

• Optional dataUrl: string

The url to retrieve the data associated with the event

Inherited from

BaseEvent.dataUrl

Defined in

src/api/resources/events/types/BaseEvent.ts:18

---

deletedAt

• Optional deletedAt: Date

Date the event was deleted

Inherited from

BaseEvent.deletedAt

Defined in

src/api/resources/events/types/BaseEvent.ts:22

---

domain

• domain: Domain

The domain of the event

Inherited from

BaseEvent.domain

Defined in

src/api/resources/events/types/BaseEvent.ts:9

---

origin

• Optional origin: Origin

Inherited from

BaseEvent.origin

Defined in

src/api/resources/events/types/BaseEvent.ts:28

---

payload

• payload: Record<string, unknown>

Defined in

src/api/resources/events/types/SheetValidatedEvent.ts:8

---

target

• Optional target: string

Inherited from

BaseEvent.target

Defined in

src/api/resources/events/types/BaseEvent.ts:27

---

topic

• topic: EventTopic

Inherited from

BaseEvent.topic

Defined in

src/api/resources/events/types/BaseEvent.ts:10

@flatfile/api / Exports / Flatfile / events / SpaceAddedEvent

Interface: SpaceAddedEvent

Flatfile.events.SpaceAddedEvent

Hierarchy

• BaseEvent

  ↳ SpaceAddedEvent

  ↳↳ SpaceAdded

Table of contents

Properties

• acknowledgedAt
• acknowledgedBy
• attributes
• callbackUrl
• context
• createdAt
• dataUrl
• deletedAt
• domain
• origin
• payload
• target
• topic

Properties

acknowledgedAt

• Optional acknowledgedAt: string

Date the event was acknowledged

Inherited from

BaseEvent.acknowledgedAt

Defined in

src/api/resources/events/types/BaseEvent.ts:24

---

acknowledgedBy

• Optional acknowledgedBy: string

The actor (user or system) who acknowledged the event

Inherited from

BaseEvent.acknowledgedBy

Defined in

src/api/resources/events/types/BaseEvent.ts:26

---

attributes

• Optional attributes: EventAttributes

The attributes of the event

Inherited from

BaseEvent.attributes

Defined in

src/api/resources/events/types/BaseEvent.ts:14

---

callbackUrl

• Optional callbackUrl: string

The callback url to acknowledge the event

Inherited from

BaseEvent.callbackUrl

Defined in

src/api/resources/events/types/BaseEvent.ts:16

---

context

• context: Context

The context of the event

Inherited from

BaseEvent.context

Defined in

src/api/resources/events/types/BaseEvent.ts:12

---

createdAt

• createdAt: Date

Date the event was created

Inherited from

BaseEvent.createdAt

Defined in

src/api/resources/events/types/BaseEvent.ts:20

---

dataUrl

• Optional dataUrl: string

The url to retrieve the data associated with the event

Inherited from

BaseEvent.dataUrl

Defined in

src/api/resources/events/types/BaseEvent.ts:18

---

deletedAt

• Optional deletedAt: Date

Date the event was deleted

Inherited from

BaseEvent.deletedAt

Defined in

src/api/resources/events/types/BaseEvent.ts:22

---

domain

• domain: Domain

The domain of the event

Inherited from

BaseEvent.domain

Defined in

src/api/resources/events/types/BaseEvent.ts:9

---

origin

• Optional origin: Origin

Inherited from

BaseEvent.origin

Defined in

src/api/resources/events/types/BaseEvent.ts:28

---

payload

• payload: Record<string, unknown>

Defined in

src/api/resources/events/types/SpaceAddedEvent.ts:8

---

target

• Optional target: string

Inherited from

BaseEvent.target

Defined in

src/api/resources/events/types/BaseEvent.ts:27

---

topic

• topic: EventTopic

Inherited from

BaseEvent.topic

Defined in

src/api/resources/events/types/BaseEvent.ts:10

@flatfile/api / Exports / Flatfile / events / SpaceRemovedEvent

Interface: SpaceRemovedEvent

Flatfile.events.SpaceRemovedEvent

Hierarchy

• BaseEvent

  ↳ SpaceRemovedEvent

  ↳↳ SpaceRemoved

Table of contents

Properties

• acknowledgedAt
• acknowledgedBy
• attributes
• callbackUrl
• context
• createdAt
• dataUrl
• deletedAt
• domain
• origin
• payload
• target
• topic

Properties

acknowledgedAt

• Optional acknowledgedAt: string

Date the event was acknowledged

Inherited from

BaseEvent.acknowledgedAt

Defined in

src/api/resources/events/types/BaseEvent.ts:24

---

acknowledgedBy

• Optional acknowledgedBy: string

The actor (user or system) who acknowledged the event

Inherited from

BaseEvent.acknowledgedBy

Defined in

src/api/resources/events/types/BaseEvent.ts:26

---

attributes

• Optional attributes: EventAttributes

The attributes of the event

Inherited from

BaseEvent.attributes

Defined in

src/api/resources/events/types/BaseEvent.ts:14

---

callbackUrl

• Optional callbackUrl: string

The callback url to acknowledge the event

Inherited from

BaseEvent.callbackUrl

Defined in

src/api/resources/events/types/BaseEvent.ts:16

---

context

• context: Context

The context of the event

Inherited from

BaseEvent.context

Defined in

src/api/resources/events/types/BaseEvent.ts:12

---

createdAt

• createdAt: Date

Date the event was created

Inherited from

BaseEvent.createdAt

Defined in

src/api/resources/events/types/BaseEvent.ts:20

---

dataUrl

• Optional dataUrl: string

The url to retrieve the data associated with the event

Inherited from

BaseEvent.dataUrl

Defined in

src/api/resources/events/types/BaseEvent.ts:18

---

deletedAt

• Optional deletedAt: Date

Date the event was deleted

Inherited from

BaseEvent.deletedAt

Defined in

src/api/resources/events/types/BaseEvent.ts:22

---

domain

• domain: Domain

The domain of the event

Inherited from

BaseEvent.domain

Defined in

src/api/resources/events/types/BaseEvent.ts:9

---

origin

• Optional origin: Origin

Inherited from

BaseEvent.origin

Defined in

src/api/resources/events/types/BaseEvent.ts:28

---

payload

• payload: Record<string, unknown>

Defined in

src/api/resources/events/types/SpaceRemovedEvent.ts:8

---

target

• Optional target: string

Inherited from

BaseEvent.target

Defined in

src/api/resources/events/types/BaseEvent.ts:27

---

topic

• topic: EventTopic

Inherited from

BaseEvent.topic

Defined in

src/api/resources/events/types/BaseEvent.ts:10

@flatfile/api / Exports / Flatfile / events / UploadCompletedEvent

Interface: UploadCompletedEvent

Flatfile.events.UploadCompletedEvent

Hierarchy

• BaseEvent

  ↳ UploadCompletedEvent

  ↳↳ UploadCompleted

Table of contents

Properties

• acknowledgedAt
• acknowledgedBy
• attributes
• callbackUrl
• context
• createdAt
• dataUrl
• deletedAt
• domain
• origin
• payload
• target
• topic

Properties

acknowledgedAt

• Optional acknowledgedAt: string

Date the event was acknowledged

Inherited from

BaseEvent.acknowledgedAt

Defined in

src/api/resources/events/types/BaseEvent.ts:24

---

acknowledgedBy

• Optional acknowledgedBy: string

The actor (user or system) who acknowledged the event

Inherited from

BaseEvent.acknowledgedBy

Defined in

src/api/resources/events/types/BaseEvent.ts:26

---

attributes

• Optional attributes: EventAttributes

The attributes of the event

Inherited from

BaseEvent.attributes

Defined in

src/api/resources/events/types/BaseEvent.ts:14

---

callbackUrl

• Optional callbackUrl: string

The callback url to acknowledge the event

Inherited from

BaseEvent.callbackUrl

Defined in

src/api/resources/events/types/BaseEvent.ts:16

---

context

• context: Context

The context of the event

Inherited from

BaseEvent.context

Defined in

src/api/resources/events/types/BaseEvent.ts:12

---

createdAt

• createdAt: Date

Date the event was created

Inherited from

BaseEvent.createdAt

Defined in

src/api/resources/events/types/BaseEvent.ts:20

---

dataUrl

• Optional dataUrl: string

The url to retrieve the data associated with the event

Inherited from

BaseEvent.dataUrl

Defined in

src/api/resources/events/types/BaseEvent.ts:18

---

deletedAt

• Optional deletedAt: Date

Date the event was deleted

Inherited from

BaseEvent.deletedAt

Defined in

src/api/resources/events/types/BaseEvent.ts:22

---

domain

• domain: Domain

The domain of the event

Inherited from

BaseEvent.domain

Defined in

src/api/resources/events/types/BaseEvent.ts:9

---

origin

• Optional origin: Origin

Inherited from

BaseEvent.origin

Defined in

src/api/resources/events/types/BaseEvent.ts:28

---

payload

• payload: Record<string, unknown>

Defined in

src/api/resources/events/types/UploadCompletedEvent.ts:8

---

target

• Optional target: string

Inherited from

BaseEvent.target

Defined in

src/api/resources/events/types/BaseEvent.ts:27

---

topic

• topic: EventTopic

Inherited from

BaseEvent.topic

Defined in

src/api/resources/events/types/BaseEvent.ts:10

@flatfile/api / Exports / Flatfile / events / UploadFailedEvent

Interface: UploadFailedEvent

Flatfile.events.UploadFailedEvent

Hierarchy

• BaseEvent

  ↳ UploadFailedEvent

  ↳↳ UploadFailed

Table of contents

Properties

• acknowledgedAt
• acknowledgedBy
• attributes
• callbackUrl
• context
• createdAt
• dataUrl
• deletedAt
• domain
• origin
• payload
• target
• topic

Properties

acknowledgedAt

• Optional acknowledgedAt: string

Date the event was acknowledged

Inherited from

BaseEvent.acknowledgedAt

Defined in

src/api/resources/events/types/BaseEvent.ts:24

---

acknowledgedBy

• Optional acknowledgedBy: string

The actor (user or system) who acknowledged the event

Inherited from

BaseEvent.acknowledgedBy

Defined in

src/api/resources/events/types/BaseEvent.ts:26

---

attributes

• Optional attributes: EventAttributes

The attributes of the event

Inherited from

BaseEvent.attributes

Defined in

src/api/resources/events/types/BaseEvent.ts:14

---

callbackUrl

• Optional callbackUrl: string

The callback url to acknowledge the event

Inherited from

BaseEvent.callbackUrl

Defined in

src/api/resources/events/types/BaseEvent.ts:16

---

context

• context: Context

The context of the event

Inherited from

BaseEvent.context

Defined in

src/api/resources/events/types/BaseEvent.ts:12

---

createdAt

• createdAt: Date

Date the event was created

Inherited from

BaseEvent.createdAt

Defined in

src/api/resources/events/types/BaseEvent.ts:20

---

dataUrl

• Optional dataUrl: string

The url to retrieve the data associated with the event

Inherited from

BaseEvent.dataUrl

Defined in

src/api/resources/events/types/BaseEvent.ts:18

---

deletedAt

• Optional deletedAt: Date

Date the event was deleted

Inherited from

BaseEvent.deletedAt

Defined in

src/api/resources/events/types/BaseEvent.ts:22

---

domain

• domain: Domain

The domain of the event

Inherited from

BaseEvent.domain

Defined in

src/api/resources/events/types/BaseEvent.ts:9

---

origin

• Optional origin: Origin

Inherited from

BaseEvent.origin

Defined in

src/api/resources/events/types/BaseEvent.ts:28

---

payload

• payload: Record<string, unknown>

Defined in

src/api/resources/events/types/UploadFailedEvent.ts:8

---

target

• Optional target: string

Inherited from

BaseEvent.target

Defined in

src/api/resources/events/types/BaseEvent.ts:27

---

topic

• topic: EventTopic

Inherited from

BaseEvent.topic

Defined in

src/api/resources/events/types/BaseEvent.ts:10

@flatfile/api / Exports / Flatfile / events / UploadStartedEvent

Interface: UploadStartedEvent

Flatfile.events.UploadStartedEvent

Hierarchy

• BaseEvent

  ↳ UploadStartedEvent

  ↳↳ UploadStarted

Table of contents

Properties

• acknowledgedAt
• acknowledgedBy
• attributes
• callbackUrl
• context
• createdAt
• dataUrl
• deletedAt
• domain
• origin
• payload
• target
• topic

Properties

acknowledgedAt

• Optional acknowledgedAt: string

Date the event was acknowledged

Inherited from

BaseEvent.acknowledgedAt

Defined in

src/api/resources/events/types/BaseEvent.ts:24

---

acknowledgedBy

• Optional acknowledgedBy: string

The actor (user or system) who acknowledged the event

Inherited from

BaseEvent.acknowledgedBy

Defined in

src/api/resources/events/types/BaseEvent.ts:26

---

attributes

• Optional attributes: EventAttributes

The attributes of the event

Inherited from

BaseEvent.attributes

Defined in

src/api/resources/events/types/BaseEvent.ts:14

---

callbackUrl

• Optional callbackUrl: string

The callback url to acknowledge the event

Inherited from

BaseEvent.callbackUrl

Defined in

src/api/resources/events/types/BaseEvent.ts:16

---

context

• context: Context

The context of the event

Inherited from

BaseEvent.context

Defined in

src/api/resources/events/types/BaseEvent.ts:12

---

createdAt

• createdAt: Date

Date the event was created

Inherited from

BaseEvent.createdAt

Defined in

src/api/resources/events/types/BaseEvent.ts:20

---

dataUrl

• Optional dataUrl: string

The url to retrieve the data associated with the event

Inherited from

BaseEvent.dataUrl

Defined in

src/api/resources/events/types/BaseEvent.ts:18

---

deletedAt

• Optional deletedAt: Date

Date the event was deleted

Inherited from

BaseEvent.deletedAt

Defined in

src/api/resources/events/types/BaseEvent.ts:22

---

domain

• domain: Domain

The domain of the event

Inherited from

BaseEvent.domain

Defined in

src/api/resources/events/types/BaseEvent.ts:9

---

origin

• Optional origin: Origin

Inherited from

BaseEvent.origin

Defined in

src/api/resources/events/types/BaseEvent.ts:28

---

payload

• payload: Record<string, unknown>

Defined in

src/api/resources/events/types/UploadStartedEvent.ts:8

---

target

• Optional target: string

Inherited from

BaseEvent.target

Defined in

src/api/resources/events/types/BaseEvent.ts:27

---

topic

• topic: EventTopic

Inherited from

BaseEvent.topic

Defined in

src/api/resources/events/types/BaseEvent.ts:10

@flatfile/api / Exports / Flatfile / events / UserAddedEvent

Interface: UserAddedEvent

Flatfile.events.UserAddedEvent

Hierarchy

• BaseEvent

  ↳ UserAddedEvent

  ↳↳ UserAdded

Table of contents

Properties

• acknowledgedAt
• acknowledgedBy
• attributes
• callbackUrl
• context
• createdAt
• dataUrl
• deletedAt
• domain
• origin
• payload
• target
• topic

Properties

acknowledgedAt

• Optional acknowledgedAt: string

Date the event was acknowledged

Inherited from

BaseEvent.acknowledgedAt

Defined in

src/api/resources/events/types/BaseEvent.ts:24

---

acknowledgedBy

• Optional acknowledgedBy: string

The actor (user or system) who acknowledged the event

Inherited from

BaseEvent.acknowledgedBy

Defined in

src/api/resources/events/types/BaseEvent.ts:26

---

attributes

• Optional attributes: EventAttributes

The attributes of the event

Inherited from

BaseEvent.attributes

Defined in

src/api/resources/events/types/BaseEvent.ts:14

---

callbackUrl

• Optional callbackUrl: string

The callback url to acknowledge the event

Inherited from

BaseEvent.callbackUrl

Defined in

src/api/resources/events/types/BaseEvent.ts:16

---

context

• context: Context

The context of the event

Inherited from

BaseEvent.context

Defined in

src/api/resources/events/types/BaseEvent.ts:12

---

createdAt

• createdAt: Date

Date the event was created

Inherited from

BaseEvent.createdAt

Defined in

src/api/resources/events/types/BaseEvent.ts:20

---

dataUrl

• Optional dataUrl: string

The url to retrieve the data associated with the event

Inherited from

BaseEvent.dataUrl

Defined in

src/api/resources/events/types/BaseEvent.ts:18

---

deletedAt

• Optional deletedAt: Date

Date the event was deleted

Inherited from

BaseEvent.deletedAt

Defined in

src/api/resources/events/types/BaseEvent.ts:22

---

domain

• domain: Domain

The domain of the event

Inherited from

BaseEvent.domain

Defined in

src/api/resources/events/types/BaseEvent.ts:9

---

origin

• Optional origin: Origin

Inherited from

BaseEvent.origin

Defined in

src/api/resources/events/types/BaseEvent.ts:28

---

payload

• payload: Record<string, unknown>

Defined in

src/api/resources/events/types/UserAddedEvent.ts:8

---

target

• Optional target: string

Inherited from

BaseEvent.target

Defined in

src/api/resources/events/types/BaseEvent.ts:27

---

topic

• topic: EventTopic

Inherited from

BaseEvent.topic

Defined in

src/api/resources/events/types/BaseEvent.ts:10

@flatfile/api / Exports / Flatfile / events / UserOfflineEvent

Interface: UserOfflineEvent

Flatfile.events.UserOfflineEvent

Hierarchy

• BaseEvent

  ↳ UserOfflineEvent

  ↳↳ UserOffline

Table of contents

Properties

• acknowledgedAt
• acknowledgedBy
• attributes
• callbackUrl
• context
• createdAt
• dataUrl
• deletedAt
• domain
• origin
• payload
• target
• topic

Properties

acknowledgedAt

• Optional acknowledgedAt: string

Date the event was acknowledged

Inherited from

BaseEvent.acknowledgedAt

Defined in

src/api/resources/events/types/BaseEvent.ts:24

---

acknowledgedBy

• Optional acknowledgedBy: string

The actor (user or system) who acknowledged the event

Inherited from

BaseEvent.acknowledgedBy

Defined in

src/api/resources/events/types/BaseEvent.ts:26

---

attributes

• Optional attributes: EventAttributes

The attributes of the event

Inherited from

BaseEvent.attributes

Defined in

src/api/resources/events/types/BaseEvent.ts:14

---

callbackUrl

• Optional callbackUrl: string

The callback url to acknowledge the event

Inherited from

BaseEvent.callbackUrl

Defined in

src/api/resources/events/types/BaseEvent.ts:16

---

context

• context: Context

The context of the event

Inherited from

BaseEvent.context

Defined in

src/api/resources/events/types/BaseEvent.ts:12

---

createdAt

• createdAt: Date

Date the event was created

Inherited from

BaseEvent.createdAt

Defined in

src/api/resources/events/types/BaseEvent.ts:20

---

dataUrl

• Optional dataUrl: string

The url to retrieve the data associated with the event

Inherited from

BaseEvent.dataUrl

Defined in

src/api/resources/events/types/BaseEvent.ts:18

---

deletedAt

• Optional deletedAt: Date

Date the event was deleted

Inherited from

BaseEvent.deletedAt

Defined in

src/api/resources/events/types/BaseEvent.ts:22

---

domain

• domain: Domain

The domain of the event

Inherited from

BaseEvent.domain

Defined in

src/api/resources/events/types/BaseEvent.ts:9

---

origin

• Optional origin: Origin

Inherited from

BaseEvent.origin

Defined in

src/api/resources/events/types/BaseEvent.ts:28

---

payload

• payload: Record<string, unknown>

Defined in

src/api/resources/events/types/UserOfflineEvent.ts:8

---

target

• Optional target: string

Inherited from

BaseEvent.target

Defined in

src/api/resources/events/types/BaseEvent.ts:27

---

topic

• topic: EventTopic

Inherited from

BaseEvent.topic

Defined in

src/api/resources/events/types/BaseEvent.ts:10

@flatfile/api / Exports / Flatfile / events / UserOnlineEvent

Interface: UserOnlineEvent

Flatfile.events.UserOnlineEvent

Hierarchy

• BaseEvent

  ↳ UserOnlineEvent

  ↳↳ UserOnline

Table of contents

Properties

• acknowledgedAt
• acknowledgedBy
• attributes
• callbackUrl
• context
• createdAt
• dataUrl
• deletedAt
• domain
• origin
• payload
• target
• topic

Properties

acknowledgedAt

• Optional acknowledgedAt: string

Date the event was acknowledged

Inherited from

BaseEvent.acknowledgedAt

Defined in

src/api/resources/events/types/BaseEvent.ts:24

---

acknowledgedBy

• Optional acknowledgedBy: string

The actor (user or system) who acknowledged the event

Inherited from

BaseEvent.acknowledgedBy

Defined in

src/api/resources/events/types/BaseEvent.ts:26

---

attributes

• Optional attributes: EventAttributes

The attributes of the event

Inherited from

BaseEvent.attributes

Defined in

src/api/resources/events/types/BaseEvent.ts:14

---

callbackUrl

• Optional callbackUrl: string

The callback url to acknowledge the event

Inherited from

BaseEvent.callbackUrl

Defined in

src/api/resources/events/types/BaseEvent.ts:16

---

context

• context: Context

The context of the event

Inherited from

BaseEvent.context

Defined in

src/api/resources/events/types/BaseEvent.ts:12

---

createdAt

• createdAt: Date

Date the event was created

Inherited from

BaseEvent.createdAt

Defined in

src/api/resources/events/types/BaseEvent.ts:20

---

dataUrl

• Optional dataUrl: string

The url to retrieve the data associated with the event

Inherited from

BaseEvent.dataUrl

Defined in

src/api/resources/events/types/BaseEvent.ts:18

---

deletedAt

• Optional deletedAt: Date

Date the event was deleted

Inherited from

BaseEvent.deletedAt

Defined in

src/api/resources/events/types/BaseEvent.ts:22

---

domain

• domain: Domain

The domain of the event

Inherited from

BaseEvent.domain

Defined in

src/api/resources/events/types/BaseEvent.ts:9

---

origin

• Optional origin: Origin

Inherited from

BaseEvent.origin

Defined in

src/api/resources/events/types/BaseEvent.ts:28

---

payload

• payload: Record<string, unknown>

Defined in

src/api/resources/events/types/UserOnlineEvent.ts:8

---

target

• Optional target: string

Inherited from

BaseEvent.target

Defined in

src/api/resources/events/types/BaseEvent.ts:27

---

topic

• topic: EventTopic

Inherited from

BaseEvent.topic

Defined in

src/api/resources/events/types/BaseEvent.ts:10

@flatfile/api / Exports / Flatfile / events / UserRemovedEvent

Interface: UserRemovedEvent

Flatfile.events.UserRemovedEvent

Hierarchy

• BaseEvent

  ↳ UserRemovedEvent

  ↳↳ UserRemoved

Table of contents

Properties

• acknowledgedAt
• acknowledgedBy
• attributes
• callbackUrl
• context
• createdAt
• dataUrl
• deletedAt
• domain
• origin
• payload
• target
• topic

Properties

acknowledgedAt

• Optional acknowledgedAt: string

Date the event was acknowledged

Inherited from

BaseEvent.acknowledgedAt

Defined in

src/api/resources/events/types/BaseEvent.ts:24

---

acknowledgedBy

• Optional acknowledgedBy: string

The actor (user or system) who acknowledged the event

Inherited from

BaseEvent.acknowledgedBy

Defined in

src/api/resources/events/types/BaseEvent.ts:26

---

attributes

• Optional attributes: EventAttributes

The attributes of the event

Inherited from

BaseEvent.attributes

Defined in

src/api/resources/events/types/BaseEvent.ts:14

---

callbackUrl

• Optional callbackUrl: string

The callback url to acknowledge the event

Inherited from

BaseEvent.callbackUrl

Defined in

src/api/resources/events/types/BaseEvent.ts:16

---

context

• context: Context

The context of the event

Inherited from

BaseEvent.context

Defined in

src/api/resources/events/types/BaseEvent.ts:12

---

createdAt

• createdAt: Date

Date the event was created

Inherited from

BaseEvent.createdAt

Defined in

src/api/resources/events/types/BaseEvent.ts:20

---

dataUrl

• Optional dataUrl: string

The url to retrieve the data associated with the event

Inherited from

BaseEvent.dataUrl

Defined in

src/api/resources/events/types/BaseEvent.ts:18

---

deletedAt

• Optional deletedAt: Date

Date the event was deleted

Inherited from

BaseEvent.deletedAt

Defined in

src/api/resources/events/types/BaseEvent.ts:22

---

domain

• domain: Domain

The domain of the event

Inherited from

BaseEvent.domain

Defined in

src/api/resources/events/types/BaseEvent.ts:9

---

origin

• Optional origin: Origin

Inherited from

BaseEvent.origin

Defined in

src/api/resources/events/types/BaseEvent.ts:28

---

payload

• payload: Record<string, unknown>

Defined in

src/api/resources/events/types/UserRemovedEvent.ts:8

---

target

• Optional target: string

Inherited from

BaseEvent.target

Defined in

src/api/resources/events/types/BaseEvent.ts:27

---

topic

• topic: EventTopic

Inherited from

BaseEvent.topic

Defined in

src/api/resources/events/types/BaseEvent.ts:10

@flatfile/api / Exports / Flatfile / events / WorkbookAddedEvent

Interface: WorkbookAddedEvent

Flatfile.events.WorkbookAddedEvent

Hierarchy

• BaseEvent

  ↳ WorkbookAddedEvent

  ↳↳ WorkbookAdded

Table of contents

Properties

• acknowledgedAt
• acknowledgedBy
• attributes
• callbackUrl
• context
• createdAt
• dataUrl
• deletedAt
• domain
• origin
• payload
• target
• topic

Properties

acknowledgedAt

• Optional acknowledgedAt: string

Date the event was acknowledged

Inherited from

BaseEvent.acknowledgedAt

Defined in

src/api/resources/events/types/BaseEvent.ts:24

---

acknowledgedBy

• Optional acknowledgedBy: string

The actor (user or system) who acknowledged the event

Inherited from

BaseEvent.acknowledgedBy

Defined in

src/api/resources/events/types/BaseEvent.ts:26

---

attributes

• Optional attributes: EventAttributes

The attributes of the event

Inherited from

BaseEvent.attributes

Defined in

src/api/resources/events/types/BaseEvent.ts:14

---

callbackUrl

• Optional callbackUrl: string

The callback url to acknowledge the event

Inherited from

BaseEvent.callbackUrl

Defined in

src/api/resources/events/types/BaseEvent.ts:16

---

context

• context: Context

The context of the event

Inherited from

BaseEvent.context

Defined in

src/api/resources/events/types/BaseEvent.ts:12

---

createdAt

• createdAt: Date

Date the event was created

Inherited from

BaseEvent.createdAt

Defined in

src/api/resources/events/types/BaseEvent.ts:20

---

dataUrl

• Optional dataUrl: string

The url to retrieve the data associated with the event

Inherited from

BaseEvent.dataUrl

Defined in

src/api/resources/events/types/BaseEvent.ts:18

---

deletedAt

• Optional deletedAt: Date

Date the event was deleted

Inherited from

BaseEvent.deletedAt

Defined in

src/api/resources/events/types/BaseEvent.ts:22

---

domain

• domain: Domain

The domain of the event

Inherited from

BaseEvent.domain

Defined in

src/api/resources/events/types/BaseEvent.ts:9

---

origin

• Optional origin: Origin

Inherited from

BaseEvent.origin

Defined in

src/api/resources/events/types/BaseEvent.ts:28

---

payload

• payload: Record<string, unknown>

Defined in

src/api/resources/events/types/WorkbookAddedEvent.ts:8

---

target

• Optional target: string

Inherited from

BaseEvent.target

Defined in

src/api/resources/events/types/BaseEvent.ts:27

---

topic

• topic: EventTopic

Inherited from

BaseEvent.topic

Defined in

src/api/resources/events/types/BaseEvent.ts:10

@flatfile/api / Exports / Flatfile / events / WorkbookRemovedEvent

Interface: WorkbookRemovedEvent

Flatfile.events.WorkbookRemovedEvent

Hierarchy

• BaseEvent

  ↳ WorkbookRemovedEvent

  ↳↳ WorkbookRemoved

Table of contents

Properties

• acknowledgedAt
• acknowledgedBy
• attributes
• callbackUrl
• context
• createdAt
• dataUrl
• deletedAt
• domain
• origin
• payload
• target
• topic

Properties

acknowledgedAt

• Optional acknowledgedAt: string

Date the event was acknowledged

Inherited from

BaseEvent.acknowledgedAt

Defined in

src/api/resources/events/types/BaseEvent.ts:24

---

acknowledgedBy

• Optional acknowledgedBy: string

The actor (user or system) who acknowledged the event

Inherited from

BaseEvent.acknowledgedBy

Defined in

src/api/resources/events/types/BaseEvent.ts:26

---

attributes

• Optional attributes: EventAttributes

The attributes of the event

Inherited from

BaseEvent.attributes

Defined in

src/api/resources/events/types/BaseEvent.ts:14

---

callbackUrl

• Optional callbackUrl: string

The callback url to acknowledge the event

Inherited from

BaseEvent.callbackUrl

Defined in

src/api/resources/events/types/BaseEvent.ts:16

---

context

• context: Context

The context of the event

Inherited from

BaseEvent.context

Defined in

src/api/resources/events/types/BaseEvent.ts:12

---

createdAt

• createdAt: Date

Date the event was created

Inherited from

BaseEvent.createdAt

Defined in

src/api/resources/events/types/BaseEvent.ts:20

---

dataUrl

• Optional dataUrl: string

The url to retrieve the data associated with the event

Inherited from

BaseEvent.dataUrl

Defined in

src/api/resources/events/types/BaseEvent.ts:18

---

deletedAt

• Optional deletedAt: Date

Date the event was deleted

Inherited from

BaseEvent.deletedAt

Defined in

src/api/resources/events/types/BaseEvent.ts:22

---

domain

• domain: Domain

The domain of the event

Inherited from

BaseEvent.domain

Defined in

src/api/resources/events/types/BaseEvent.ts:9

---

origin

• Optional origin: Origin

Inherited from

BaseEvent.origin

Defined in

src/api/resources/events/types/BaseEvent.ts:28

---

payload

• payload: Record<string, unknown>

Defined in

src/api/resources/events/types/WorkbookRemovedEvent.ts:8

---

target

• Optional target: string

Inherited from

BaseEvent.target

Defined in

src/api/resources/events/types/BaseEvent.ts:27

---

topic

• topic: EventTopic

Inherited from

BaseEvent.topic

Defined in

src/api/resources/events/types/BaseEvent.ts:10

@flatfile/api / Exports / Flatfile / events / WorkbookUpdatedEvent

Interface: WorkbookUpdatedEvent

Flatfile.events.WorkbookUpdatedEvent

Hierarchy

• BaseEvent

  ↳ WorkbookUpdatedEvent

  ↳↳ WorkbookUpdated

Table of contents

Properties

• acknowledgedAt
• acknowledgedBy
• attributes
• callbackUrl
• context
• createdAt
• dataUrl
• deletedAt
• domain
• origin
• payload
• target
• topic

Properties

acknowledgedAt

• Optional acknowledgedAt: string

Date the event was acknowledged

Inherited from

BaseEvent.acknowledgedAt

Defined in

src/api/resources/events/types/BaseEvent.ts:24

---

acknowledgedBy

• Optional acknowledgedBy: string

The actor (user or system) who acknowledged the event

Inherited from

BaseEvent.acknowledgedBy

Defined in

src/api/resources/events/types/BaseEvent.ts:26

---

attributes

• Optional attributes: EventAttributes

The attributes of the event

Inherited from

BaseEvent.attributes

Defined in

src/api/resources/events/types/BaseEvent.ts:14

---

callbackUrl

• Optional callbackUrl: string

The callback url to acknowledge the event

Inherited from

BaseEvent.callbackUrl

Defined in

src/api/resources/events/types/BaseEvent.ts:16

---

context

• context: Context

The context of the event

Inherited from

BaseEvent.context

Defined in

src/api/resources/events/types/BaseEvent.ts:12

---

createdAt

• createdAt: Date

Date the event was created

Inherited from

BaseEvent.createdAt

Defined in

src/api/resources/events/types/BaseEvent.ts:20

---

dataUrl

• Optional dataUrl: string

The url to retrieve the data associated with the event

Inherited from

BaseEvent.dataUrl

Defined in

src/api/resources/events/types/BaseEvent.ts:18

---

deletedAt

• Optional deletedAt: Date

Date the event was deleted

Inherited from

BaseEvent.deletedAt

Defined in

src/api/resources/events/types/BaseEvent.ts:22

---

domain

• domain: Domain

The domain of the event

Inherited from

BaseEvent.domain

Defined in

src/api/resources/events/types/BaseEvent.ts:9

---

origin

• Optional origin: Origin

Inherited from

BaseEvent.origin

Defined in

src/api/resources/events/types/BaseEvent.ts:28

---

payload

• payload: Record<string, unknown>

Defined in

src/api/resources/events/types/WorkbookUpdatedEvent.ts:8

---

target

• Optional target: string

Inherited from

BaseEvent.target

Defined in

src/api/resources/events/types/BaseEvent.ts:27

---

topic

• topic: EventTopic

Inherited from

BaseEvent.topic

Defined in

src/api/resources/events/types/BaseEvent.ts:10

@flatfile/api / Exports / Flatfile / files / CreateFileRequest

Interface: CreateFileRequest

Flatfile.files.CreateFileRequest

Table of contents

Properties

• environmentId
• file
• mode
• spaceId

Properties

environmentId

• environmentId: string

Defined in

src/api/resources/files/client/requests/CreateFileRequest.ts:9

---

file

• file: string

A binary payload containing the file contents

Defined in

src/api/resources/files/client/requests/CreateFileRequest.ts:13

---

mode

• Optional mode: Mode

The storage mode of file to insert, defaults to "import"

Defined in

src/api/resources/files/client/requests/CreateFileRequest.ts:11

---

spaceId

• spaceId: string

Defined in

src/api/resources/files/client/requests/CreateFileRequest.ts:8

@flatfile/api / Exports / Flatfile / files / FileResponse

Interface: FileResponse

Flatfile.files.FileResponse

Table of contents

Properties

• data

Properties

data

• data: File_

Defined in

src/api/resources/files/types/FileResponse.ts:8

@flatfile/api / Exports / Flatfile / files / File_

Interface: File_

Flatfile.files.File_

Any uploaded file of any type

Table of contents

Properties

• actions
• bytesReceived
• createdAt
• encoding
• ext
• id
• mimetype
• name
• sheetId
• size
• spaceId
• status
• updatedAt
• workbookId

Properties

actions

• Optional actions: Action[]

Defined in

src/api/resources/files/types/File_.ts:33

---

bytesReceived

• bytesReceived: number

Number of bytes that have been uploaded so far (useful for progress tracking)

Defined in

src/api/resources/files/types/File_.ts:25

---

createdAt

• createdAt: string

Date the file was created

Defined in

src/api/resources/files/types/File_.ts:27

---

encoding

• encoding: string

Text encoding of the file

Defined in

src/api/resources/files/types/File_.ts:19

---

ext

• ext: string

Extension of the file

Defined in

src/api/resources/files/types/File_.ts:15

---

id

• id: string

Defined in

src/api/resources/files/types/File_.ts:11

---

mimetype

• mimetype: string

MIME Type of the file

Defined in

src/api/resources/files/types/File_.ts:17

---

name

• name: string

Original filename

Defined in

src/api/resources/files/types/File_.ts:13

---

sheetId

• Optional sheetId: string

Defined in

src/api/resources/files/types/File_.ts:32

---

size

• size: number

Size of file in bytes

Defined in

src/api/resources/files/types/File_.ts:23

---

spaceId

• spaceId: string

Defined in

src/api/resources/files/types/File_.ts:30

---

status

• status: ModelFileStatusEnum

Status of the file

Defined in

src/api/resources/files/types/File_.ts:21

---

updatedAt

• updatedAt: string

Date the file was last updated

Defined in

src/api/resources/files/types/File_.ts:29

---

workbookId

• Optional workbookId: string

Defined in

src/api/resources/files/types/File_.ts:31

@flatfile/api / Exports / Flatfile / files / ListFilesRequest

Interface: ListFilesRequest

Flatfile.files.ListFilesRequest

Table of contents

Properties

• mode
• pageNumber
• pageSize
• spaceId

Properties

mode

• Optional mode: Mode

The storage mode of file to fetch, defaults to "import"

Defined in

src/api/resources/files/client/requests/ListFilesRequest.ts:20

---

pageNumber

• Optional pageNumber: number

Based on pageSize, which page of jobs to return

Defined in

src/api/resources/files/client/requests/ListFilesRequest.ts:16

---

pageSize

• Optional pageSize: number

Number of jobs to return in a page (default 20)

Defined in

src/api/resources/files/client/requests/ListFilesRequest.ts:12

---

spaceId

• Optional spaceId: string

Defined in

src/api/resources/files/client/requests/ListFilesRequest.ts:8

@flatfile/api / Exports / Flatfile / files / ListFilesResponse

Interface: ListFilesResponse

Flatfile.files.ListFilesResponse

Table of contents

Properties

• data
• pagination

Properties

data

• data: File_[]

Defined in

src/api/resources/files/types/ListFilesResponse.ts:9

---

pagination

• Optional pagination: Pagination

Defined in

src/api/resources/files/types/ListFilesResponse.ts:8

@flatfile/api / Exports / Flatfile / files / UpdateFileRequest

Interface: UpdateFileRequest

Flatfile.files.UpdateFileRequest

Table of contents

Properties

• actions
• mode
• name
• status
• workbookId

Properties

actions

• Optional actions: Action[]

The actions attached to the file

Defined in

src/api/resources/files/client/requests/UpdateFileRequest.ts:16

---

mode

• Optional mode: Mode

The storage mode of file to update

Defined in

src/api/resources/files/client/requests/UpdateFileRequest.ts:12

---

name

• Optional name: string

The name of the file

Defined in

src/api/resources/files/client/requests/UpdateFileRequest.ts:10

---

status

• Optional status: ModelFileStatusEnum

Status of the file

Defined in

src/api/resources/files/client/requests/UpdateFileRequest.ts:14

---

workbookId

• Optional workbookId: string

Defined in

src/api/resources/files/client/requests/UpdateFileRequest.ts:8

@flatfile/api / Exports / Flatfile / guests / CreateGuestResponse

Interface: CreateGuestResponse

Flatfile.guests.CreateGuestResponse

Table of contents

Properties

• data

Properties

data

• data: Guest[]

Defined in

src/api/resources/guests/types/CreateGuestResponse.ts:8

@flatfile/api / Exports / Flatfile / guests / Guest

Interface: Guest

Flatfile.guests.Guest

Configurations for the guests

Hierarchy

• GuestConfig

  ↳ Guest

Table of contents

Properties

• createdAt
• email
• environmentId
• id
• name
• spaces
• updatedAt
• workbooks

Properties

createdAt

• createdAt: Date

Date the guest object was created

Defined in

src/api/resources/guests/types/Guest.ts:10

---

email

• email: string

Inherited from

GuestConfig.email

Defined in

src/api/resources/guests/types/GuestConfig.ts:12

---

environmentId

• environmentId: string

Inherited from

GuestConfig.environmentId

Defined in

src/api/resources/guests/types/GuestConfig.ts:11

---

id

• id: string

Defined in

src/api/resources/guests/types/Guest.ts:8

---

name

• name: string

Inherited from

GuestConfig.name

Defined in

src/api/resources/guests/types/GuestConfig.ts:13

---

spaces

• spaces: GuestSpace[]

Inherited from

GuestConfig.spaces

Defined in

src/api/resources/guests/types/GuestConfig.ts:14

---

updatedAt

• updatedAt: Date

Date the guest object was last updated

Defined in

src/api/resources/guests/types/Guest.ts:12

---

workbooks

• Optional workbooks: GuestWorkbook[]

Inherited from

GuestConfig.workbooks

Defined in

src/api/resources/guests/types/GuestConfig.ts:15

@flatfile/api / Exports / Flatfile / guests / GuestConfig

Interface: GuestConfig

Flatfile.guests.GuestConfig

Configurations for the guests

Hierarchy

• GuestConfig

  ↳ Guest

Table of contents

Properties

• email
• environmentId
• name
• spaces
• workbooks

Properties

email

• email: string

Defined in

src/api/resources/guests/types/GuestConfig.ts:12

---

environmentId

• environmentId: string

Defined in

src/api/resources/guests/types/GuestConfig.ts:11

---

name

• name: string

Defined in

src/api/resources/guests/types/GuestConfig.ts:13

---

spaces

• spaces: GuestSpace[]

Defined in

src/api/resources/guests/types/GuestConfig.ts:14

---

workbooks

• Optional workbooks: GuestWorkbook[]

Defined in

src/api/resources/guests/types/GuestConfig.ts:15

@flatfile/api / Exports / Flatfile / guests / GuestSpace

Interface: GuestSpace

Flatfile.guests.GuestSpace

Table of contents

Properties

• id
• lastAccessed

Properties

id

• id: string

Defined in

src/api/resources/guests/types/GuestSpace.ts:8

---

lastAccessed

• Optional lastAccessed: Date

Defined in

src/api/resources/guests/types/GuestSpace.ts:9

@flatfile/api / Exports / Flatfile / guests / GuestWorkbook

Interface: GuestWorkbook

Flatfile.guests.GuestWorkbook

Table of contents

Properties

• id

Properties

id

• id: string

Defined in

src/api/resources/guests/types/GuestWorkbook.ts:8

@flatfile/api / Exports / Flatfile / guests / Invite

Interface: Invite

Flatfile.guests.Invite

Table of contents

Properties

• guestId
• message
• spaceId

Properties

guestId

• guestId: string

Defined in

src/api/resources/guests/types/Invite.ts:8

---

message

• message: string

Message to send with the invite

Defined in

src/api/resources/guests/types/Invite.ts:11

---

spaceId

• spaceId: string

Defined in

src/api/resources/guests/types/Invite.ts:9

@flatfile/api / Exports / Flatfile / guests / ListGuestsRequest

Interface: ListGuestsRequest

Flatfile.guests.ListGuestsRequest

Table of contents

Properties

• email
• spaceId

Properties

email

• Optional email: string

Email of guest to return

Defined in

src/api/resources/guests/client/requests/ListGuestsRequest.ts:15

---

spaceId

• spaceId: string

ID of space to return

Defined in

src/api/resources/guests/client/requests/ListGuestsRequest.ts:11

@flatfile/api / Exports / Flatfile / guests / ListGuestsResponse

Interface: ListGuestsResponse

Flatfile.guests.ListGuestsResponse

Table of contents

Properties

• data

Properties

data

• data: Guest[]

Defined in

src/api/resources/guests/types/ListGuestsResponse.ts:8

@flatfile/api / Exports / Flatfile / jobs / AiAssistJobConfig

Interface: AiAssistJobConfig

Flatfile.jobs.AiAssistJobConfig

This file was auto-generated by Fern from our API Definition.

Table of contents

Properties

• command
• metadata
• model
• modelParams
• mutateRecord

Properties

command

• command: string

Defined in

src/api/resources/jobs/types/AiAssistJobConfig.ts:7

---

metadata

• Optional metadata: Record<string, unknown>

This will be generated by the AI not by you.

Defined in

src/api/resources/jobs/types/AiAssistJobConfig.ts:12

---

model

• model: string

Defined in

src/api/resources/jobs/types/AiAssistJobConfig.ts:6

---

modelParams

• Optional modelParams: Record<string, unknown>

Defined in

src/api/resources/jobs/types/AiAssistJobConfig.ts:8

---

mutateRecord

• Optional mutateRecord: string

This will be generated by the AI not by you.

Defined in

src/api/resources/jobs/types/AiAssistJobConfig.ts:10

@flatfile/api / Exports / Flatfile / jobs / CategoryMapping

Interface: CategoryMapping

Flatfile.jobs.CategoryMapping

This file was auto-generated by Fern from our API Definition.

Table of contents

Properties

• destinationValue
• sourceValue

Properties

destinationValue

• Optional destinationValue: string

Defined in

src/api/resources/jobs/types/CategoryMapping.ts:7

---

sourceValue

• Optional sourceValue: string

Defined in

src/api/resources/jobs/types/CategoryMapping.ts:6

@flatfile/api / Exports / Flatfile / jobs / DeleteJobConfig

Interface: DeleteJobConfig

Flatfile.jobs.DeleteJobConfig

The configuration for a delete job

Table of contents

Properties

• exceptions
• filter
• filterField
• searchField
• searchValue
• sheet

Properties

exceptions

• Optional exceptions: string[]

Defined in

src/api/resources/jobs/types/DeleteJobConfig.ts:16

---

filter

• Optional filter: Filter

Defined in

src/api/resources/jobs/types/DeleteJobConfig.ts:11

---

filterField

• Optional filterField: string

Defined in

src/api/resources/jobs/types/DeleteJobConfig.ts:12

---

searchField

• Optional searchField: string

Defined in

src/api/resources/jobs/types/DeleteJobConfig.ts:14

---

searchValue

• Optional searchValue: string

Defined in

src/api/resources/jobs/types/DeleteJobConfig.ts:13

---

sheet

• sheet: string

Defined in

src/api/resources/jobs/types/DeleteJobConfig.ts:15

@flatfile/api / Exports / Flatfile / jobs / DestinationField

Interface: DestinationField

Flatfile.jobs.DestinationField

Table of contents

Properties

• destinationField
• enumDetails
• preview

Properties

destinationField

• destinationField: Property

Defined in

src/api/resources/jobs/types/DestinationField.ts:10

---

enumDetails

• Optional enumDetails: EnumDetails

Only available if one or more of the destination fields is of type enum. Provides category mapping.

Defined in

src/api/resources/jobs/types/DestinationField.ts:9

---

preview

• Optional preview: string[]

Defined in

src/api/resources/jobs/types/DestinationField.ts:11

@flatfile/api / Exports / Flatfile / jobs / Edge

Interface: Edge

Flatfile.jobs.Edge

Table of contents

Properties

• destinationField
• enumDetails
• metadata
• preview
• sourceField

Properties

destinationField

• destinationField: Property

Defined in

src/api/resources/jobs/types/Edge.ts:9

---

enumDetails

• Optional enumDetails: EnumDetails

Only available if one or more of the destination fields is of type enum. Provides category mapping.

Defined in

src/api/resources/jobs/types/Edge.ts:12

---

metadata

• Optional metadata: Metadata

Defined in

src/api/resources/jobs/types/Edge.ts:13

---

preview

• Optional preview: string[]

Defined in

src/api/resources/jobs/types/Edge.ts:10

---

sourceField

• sourceField: Property

Defined in

src/api/resources/jobs/types/Edge.ts:8

@flatfile/api / Exports / Flatfile / jobs / EmptyObject

Interface: EmptyObject

Flatfile.jobs.EmptyObject

This file was auto-generated by Fern from our API Definition.

@flatfile/api / Exports / Flatfile / jobs / EnumDetails

Interface: EnumDetails

Flatfile.jobs.EnumDetails

Only available if one or more of the destination fields is of type enum. Provides category mapping.

Table of contents

Properties

• mapping
• unusedDestinationValues
• unusedSourceValues

Properties

mapping

• Optional mapping: CategoryMapping[]

Defined in

src/api/resources/jobs/types/EnumDetails.ts:11

---

unusedDestinationValues

• Optional unusedDestinationValues: string[]

Defined in

src/api/resources/jobs/types/EnumDetails.ts:13

---

unusedSourceValues

• Optional unusedSourceValues: string[]

Defined in

src/api/resources/jobs/types/EnumDetails.ts:12

@flatfile/api / Exports / Flatfile / jobs / ExportJobConfig

Interface: ExportJobConfig

Flatfile.jobs.ExportJobConfig

Table of contents

Properties

• options

Properties

options

• options: ExportOptions

Defined in

src/api/resources/jobs/types/ExportJobConfig.ts:8

@flatfile/api / Exports / Flatfile / jobs / ExportOptions

Interface: ExportOptions

Flatfile.jobs.ExportOptions

Table of contents

Properties

• filter
• filterField
• ids
• searchField
• searchValue
• sortDirection
• sortField
• versionId

Properties

filter

• Optional filter: Filter

Defined in

src/api/resources/jobs/types/ExportOptions.ts:11

---

filterField

• Optional filterField: string

Defined in

src/api/resources/jobs/types/ExportOptions.ts:12

---

ids

• 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.'

Defined in

src/api/resources/jobs/types/ExportOptions.ts:19

---

searchField

• Optional searchField: string

Defined in

src/api/resources/jobs/types/ExportOptions.ts:14

---

searchValue

• Optional searchValue: string

Defined in

src/api/resources/jobs/types/ExportOptions.ts:13

---

sortDirection

• Optional sortDirection: SortDirection

Defined in

src/api/resources/jobs/types/ExportOptions.ts:10

---

sortField

• Optional sortField: string

Defined in

src/api/resources/jobs/types/ExportOptions.ts:9

---

versionId

• Optional versionId: string

Defined in

src/api/resources/jobs/types/ExportOptions.ts:8

@flatfile/api / Exports / Flatfile / jobs / FileJobConfig

Interface: FileJobConfig

Flatfile.jobs.FileJobConfig

Table of contents

Properties

• driver

Properties

driver

• driver: "csv"

The driver to use for extracting data from the file

Defined in

src/api/resources/jobs/types/FileJobConfig.ts:9

@flatfile/api / Exports / Flatfile / jobs / FindAndReplaceJobConfig

Interface: FindAndReplaceJobConfig

Flatfile.jobs.FindAndReplaceJobConfig

Table of contents

Properties

• fieldKey
• filter
• filterField
• find
• ids
• replace
• searchField
• searchValue

Properties

fieldKey

• fieldKey: string

The value to replace found values with

Defined in

src/api/resources/jobs/types/FindAndReplaceJobConfig.ts:22

---

filter

• Optional filter: Filter

Defined in

src/api/resources/jobs/types/FindAndReplaceJobConfig.ts:8

---

filterField

• Optional filterField: string

Defined in

src/api/resources/jobs/types/FindAndReplaceJobConfig.ts:9

---

find

• Optional find: CellValueUnion

A value to find for a given field in a sheet. Wrap the value in "" for exact match

Defined in

src/api/resources/jobs/types/FindAndReplaceJobConfig.ts:18

---

ids

• 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.'

Defined in

src/api/resources/jobs/types/FindAndReplaceJobConfig.ts:16

---

replace

• Optional replace: CellValueUnion

The value to replace found values with

Defined in

src/api/resources/jobs/types/FindAndReplaceJobConfig.ts:20

---

searchField

• Optional searchField: string

Defined in

src/api/resources/jobs/types/FindAndReplaceJobConfig.ts:11

---

searchValue

• Optional searchValue: string

Defined in

src/api/resources/jobs/types/FindAndReplaceJobConfig.ts:10

@flatfile/api / Exports / Flatfile / jobs / Job

Interface: Job

Flatfile.jobs.Job

A single unit of work that will execute asynchronously

Hierarchy

• JobConfig

  ↳ Job

Table of contents

Properties

• config
• createdAt
• destination
• fileId
• finishedAt
• id
• info
• input
• managed
• mode
• operation
• outcome
• outcomeAcknowledgedAt
• progress
• source
• startedAt
• status
• trigger
• type
• updatedAt

Properties

config

• Optional config: JobUpdateConfig

Inherited from

JobConfig.config

Defined in

src/api/resources/jobs/types/JobConfig.ts:17

---

createdAt

• createdAt: Date

Date the item was created

Defined in

src/api/resources/jobs/types/Job.ts:13

---

destination

• Optional destination: string

Inherited from

JobConfig.destination

Defined in

src/api/resources/jobs/types/JobConfig.ts:16

---

fileId

• Optional fileId: string

Inherited from

JobConfig.fileId

Defined in

src/api/resources/jobs/types/JobConfig.ts:24

---

finishedAt

• Optional finishedAt: Date

the time that the job finished at

Defined in

src/api/resources/jobs/types/Job.ts:19

---

id

• id: string

Defined in

src/api/resources/jobs/types/Job.ts:11

---

info

• Optional info: string

Current status of job in text

Inherited from

JobConfig.info

Defined in

src/api/resources/jobs/types/JobConfig.ts:32

---

input

• Optional input: Record<string, unknown>

Input parameters for this job type.

Inherited from

JobConfig.input

Defined in

src/api/resources/jobs/types/JobConfig.ts:28

---

managed

• managed: boolean

Indicates if Flatfile is managing the control flow of this job or if it is being manually tracked.

Inherited from

JobConfig.managed

Defined in

src/api/resources/jobs/types/JobConfig.ts:34

---

mode

• Optional mode: JobMode

the mode of the job

Inherited from

JobConfig.mode

Defined in

src/api/resources/jobs/types/JobConfig.ts:26

---

operation

• operation: string

the type of operation to perform on the data. For example, "export".

Inherited from

JobConfig.operation

Defined in

src/api/resources/jobs/types/JobConfig.ts:14

---

outcome

• Optional outcome: Record<string, unknown>

Outcome summary of job.

Inherited from

JobConfig.outcome

Defined in

src/api/resources/jobs/types/JobConfig.ts:30

---

outcomeAcknowledgedAt

• Optional outcomeAcknowledgedAt: Date

the time that the job's outcome has been acknowledged by a user

Defined in

src/api/resources/jobs/types/Job.ts:21

---

progress

• Optional progress: number

the progress of the job

Inherited from

JobConfig.progress

Defined in

src/api/resources/jobs/types/JobConfig.ts:23

---

source

• source: string

Inherited from

JobConfig.source

Defined in

src/api/resources/jobs/types/JobConfig.ts:15

---

startedAt

• Optional startedAt: Date

the time that the job started at

Defined in

src/api/resources/jobs/types/Job.ts:17

---

status

• Optional status: JobStatus

the status of the job

Inherited from

JobConfig.status

Defined in

src/api/resources/jobs/types/JobConfig.ts:21

---

trigger

• Optional trigger: Trigger

the type of trigger to use for this job

Inherited from

JobConfig.trigger

Defined in

src/api/resources/jobs/types/JobConfig.ts:19

---

type

• type: JobType

The type of job

Inherited from

JobConfig.type

Defined in

src/api/resources/jobs/types/JobConfig.ts:12

---

updatedAt

• updatedAt: Date

Date the item was last updated

Defined in

src/api/resources/jobs/types/Job.ts:15

@flatfile/api / Exports / Flatfile / jobs / JobAckDetails

Interface: JobAckDetails

Flatfile.jobs.JobAckDetails

Details about the user who acknowledged the job

Table of contents

Properties

• info
• progress

Properties

info

• Optional info: string

Defined in

src/api/resources/jobs/types/JobAckDetails.ts:9

---

progress

• Optional progress: number

Defined in

src/api/resources/jobs/types/JobAckDetails.ts:10

@flatfile/api / Exports / Flatfile / jobs / JobConfig

Interface: JobConfig

Flatfile.jobs.JobConfig

A single unit of work that a pipeline will execute

Hierarchy

• JobConfig

  ↳ Job

Table of contents

Properties

• config
• destination
• fileId
• info
• input
• managed
• mode
• operation
• outcome
• progress
• source
• status
• trigger
• type

Properties

config

• Optional config: JobUpdateConfig

Defined in

src/api/resources/jobs/types/JobConfig.ts:17

---

destination

• Optional destination: string

Defined in

src/api/resources/jobs/types/JobConfig.ts:16

---

fileId

• Optional fileId: string

Defined in

src/api/resources/jobs/types/JobConfig.ts:24

---

info

• Optional info: string

Current status of job in text

Defined in

src/api/resources/jobs/types/JobConfig.ts:32

---

input

• Optional input: Record<string, unknown>

Input parameters for this job type.

Defined in

src/api/resources/jobs/types/JobConfig.ts:28

---

managed

• managed: boolean

Indicates if Flatfile is managing the control flow of this job or if it is being manually tracked.

Defined in

src/api/resources/jobs/types/JobConfig.ts:34

---

mode

• Optional mode: JobMode

the mode of the job

Defined in

src/api/resources/jobs/types/JobConfig.ts:26

---

operation

• operation: string

the type of operation to perform on the data. For example, "export".

Defined in

src/api/resources/jobs/types/JobConfig.ts:14

---

outcome

• Optional outcome: Record<string, unknown>

Outcome summary of job.

Defined in

src/api/resources/jobs/types/JobConfig.ts:30

---

progress

• Optional progress: number

the progress of the job

Defined in

src/api/resources/jobs/types/JobConfig.ts:23

---

source

• source: string

Defined in

src/api/resources/jobs/types/JobConfig.ts:15

---

status

• Optional status: JobStatus

the status of the job

Defined in

src/api/resources/jobs/types/JobConfig.ts:21

---

trigger

• Optional trigger: Trigger

the type of trigger to use for this job

Defined in

src/api/resources/jobs/types/JobConfig.ts:19

---

type

• type: JobType

The type of job

Defined in

src/api/resources/jobs/types/JobConfig.ts:12

@flatfile/api / Exports / Flatfile / jobs / JobExecutionPlan

Interface: 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.

Hierarchy

• JobExecutionPlan

  ↳ JobExecutionPlanConfig

Table of contents

Properties

• fieldMapping
• headerRowCount
• unmappedDestinationFields
• unmappedSourceFields

Properties

fieldMapping

• Optional fieldMapping: Edge[]

Defined in

src/api/resources/jobs/types/JobExecutionPlan.ts:11

---

headerRowCount

• Optional headerRowCount: number

The number of rows to skip before reading data from the document

Defined in

src/api/resources/jobs/types/JobExecutionPlan.ts:15

---

unmappedDestinationFields

• Optional unmappedDestinationFields: DestinationField[]

Defined in

src/api/resources/jobs/types/JobExecutionPlan.ts:13

---

unmappedSourceFields

• Optional unmappedSourceFields: SourceField[]

Defined in

src/api/resources/jobs/types/JobExecutionPlan.ts:12

@flatfile/api / Exports / Flatfile / jobs / JobExecutionPlanConfig

Interface: 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.

Hierarchy

• JobExecutionPlan

  ↳ JobExecutionPlanConfig

Table of contents

Properties

• fieldMapping
• fileId
• headerRowCount
• jobId
• unmappedDestinationFields
• unmappedSourceFields

Properties

fieldMapping

• Optional fieldMapping: Edge[]

Inherited from

JobExecutionPlan.fieldMapping

Defined in

src/api/resources/jobs/types/JobExecutionPlan.ts:11

---

fileId

• fileId: string

Defined in

src/api/resources/jobs/types/JobExecutionPlanConfig.ts:8

---

headerRowCount

• Optional headerRowCount: number

The number of rows to skip before reading data from the document

Inherited from

JobExecutionPlan.headerRowCount

Defined in

src/api/resources/jobs/types/JobExecutionPlan.ts:15

---

jobId

• jobId: string

Defined in

src/api/resources/jobs/types/JobExecutionPlanConfig.ts:9

---

unmappedDestinationFields

• Optional unmappedDestinationFields: DestinationField[]

Inherited from

JobExecutionPlan.unmappedDestinationFields

Defined in

src/api/resources/jobs/types/JobExecutionPlan.ts:13

---

unmappedSourceFields

• Optional unmappedSourceFields: SourceField[]

Inherited from

JobExecutionPlan.unmappedSourceFields

Defined in

src/api/resources/jobs/types/JobExecutionPlan.ts:12

@flatfile/api / Exports / Flatfile / jobs / JobOutcome

Interface: JobOutcome

Flatfile.jobs.JobOutcome

Outcome summary of a job

Table of contents

Properties

• info
• outcome

Properties

info

• Optional info: string

Defined in

src/api/resources/jobs/types/JobOutcome.ts:10

---

outcome

• Optional outcome: Record<string, unknown>

Defined in

src/api/resources/jobs/types/JobOutcome.ts:9

@flatfile/api / Exports / Flatfile / jobs / JobPlan

Interface: JobPlan

Flatfile.jobs.JobPlan

The job/plan tuple that contains the full plan and the jobs status

Table of contents

Properties

• job
• plan

Properties

job

• Optional job: Job

Defined in

src/api/resources/jobs/types/JobPlan.ts:11

---

plan

• Optional plan: JobExecutionPlan

Defined in

src/api/resources/jobs/types/JobPlan.ts:12

@flatfile/api / Exports / Flatfile / jobs / JobResponse

Interface: JobResponse

Flatfile.jobs.JobResponse

Table of contents

Properties

• data

Properties

data

• data: Job

Defined in

src/api/resources/jobs/types/JobResponse.ts:8

@flatfile/api / Exports / Flatfile / jobs / JobUpdate

Interface: JobUpdate

Flatfile.jobs.JobUpdate

A single unit of work that will be executed

Table of contents

Properties

• config
• outcomeAcknowledgedAt
• progress
• status

Properties

config

• Optional config: JobUpdateConfig

Defined in

src/api/resources/jobs/types/JobUpdate.ts:11

---

outcomeAcknowledgedAt

• Optional outcomeAcknowledgedAt: Date

the time that the job's outcome has been acknowledged by a user

Defined in

src/api/resources/jobs/types/JobUpdate.ts:17

---

progress

• Optional progress: number

the progress of the job

Defined in

src/api/resources/jobs/types/JobUpdate.ts:15

---

status

• Optional status: JobStatus

the status of the job

Defined in

src/api/resources/jobs/types/JobUpdate.ts:13

@flatfile/api / Exports / Flatfile / jobs / ListJobsRequest

Interface: ListJobsRequest

Flatfile.jobs.ListJobsRequest

Table of contents

Properties

• environmentId
• fileId
• pageNumber
• pageSize
• sortDirection
• spaceId
• workbookId

Properties

environmentId

• Optional environmentId: string

Defined in

src/api/resources/jobs/client/requests/ListJobsRequest.ts:8

---

fileId

• Optional fileId: string

Defined in

src/api/resources/jobs/client/requests/ListJobsRequest.ts:11

---

pageNumber

• Optional pageNumber: number

Based on pageSize, which page of jobs to return

Defined in

src/api/resources/jobs/client/requests/ListJobsRequest.ts:19

---

pageSize

• Optional pageSize: number

Number of jobs to return in a page (default 20)

Defined in

src/api/resources/jobs/client/requests/ListJobsRequest.ts:15

---

sortDirection

• Optional sortDirection: SortDirection

Defined in

src/api/resources/jobs/client/requests/ListJobsRequest.ts:20

---

spaceId

• Optional spaceId: string

Defined in

src/api/resources/jobs/client/requests/ListJobsRequest.ts:9

---

workbookId

• Optional workbookId: string

Defined in

src/api/resources/jobs/client/requests/ListJobsRequest.ts:10

@flatfile/api / Exports / Flatfile / jobs / ListJobsResponse

Interface: ListJobsResponse

Flatfile.jobs.ListJobsResponse

Table of contents

Properties

• data
• pagination

Properties

data

• data: Job[]

Defined in

src/api/resources/jobs/types/ListJobsResponse.ts:9

---

pagination

• Optional pagination: Pagination

Defined in

src/api/resources/jobs/types/ListJobsResponse.ts:8

@flatfile/api / Exports / Flatfile / jobs / Metadata

Interface: Metadata

Flatfile.jobs.Metadata

Table of contents

Properties

• certainty
• source

Properties

certainty

• Optional certainty: Certainty

Defined in

src/api/resources/jobs/types/Metadata.ts:8

---

source

• Optional source: string

Defined in

src/api/resources/jobs/types/Metadata.ts:9

@flatfile/api / Exports / Flatfile / jobs / MutateJobConfig

Interface: MutateJobConfig

Flatfile.jobs.MutateJobConfig

Table of contents

Properties

• mutateRecord
• mutationId
• sheetId

Properties

mutateRecord

• mutateRecord: string

A JavaScript function that will be run on each record in the sheet, it should return a mutated record.

Defined in

src/api/resources/jobs/types/MutateJobConfig.ts:10

---

mutationId

• Optional mutationId: string

If the mutation was generated through some sort of id-ed process, this links this job and that process.

Defined in

src/api/resources/jobs/types/MutateJobConfig.ts:12

---

sheetId

• sheetId: string

Defined in

src/api/resources/jobs/types/MutateJobConfig.ts:8

@flatfile/api / Exports / Flatfile / jobs / PipelineJobConfig

Interface: PipelineJobConfig

Flatfile.jobs.PipelineJobConfig

Table of contents

Properties

• destinationSheetId
• sourceSheetId

Properties

destinationSheetId

• destinationSheetId: string

Defined in

src/api/resources/jobs/types/PipelineJobConfig.ts:9

---

sourceSheetId

• sourceSheetId: string

Defined in

src/api/resources/jobs/types/PipelineJobConfig.ts:8

@flatfile/api / Exports / Flatfile / jobs / SourceField

Interface: SourceField

Flatfile.jobs.SourceField

Table of contents

Properties

• preview
• sourceField

Properties

preview

• Optional preview: string[]

Defined in

src/api/resources/jobs/types/SourceField.ts:9

---

sourceField

• sourceField: Property

Defined in

src/api/resources/jobs/types/SourceField.ts:8

@flatfile/api / Exports / Flatfile / property / ArrayableProperty

Interface: ArrayableProperty

Flatfile.property.ArrayableProperty

This file was auto-generated by Fern from our API Definition.

Hierarchy

• ArrayableProperty

  ↳ NumberProperty

  ↳ EnumProperty

  ↳ ReferenceProperty

Table of contents

Properties

• isArray

Properties

isArray

• Optional isArray: boolean

Will allow multiple values and store as an array

Defined in

src/api/resources/property/types/ArrayableProperty.ts:7

@flatfile/api / Exports / Flatfile / property / BaseProperty

Interface: BaseProperty

Flatfile.property.BaseProperty

Hierarchy

• BaseProperty

  ↳ StringProperty

  ↳ NumberProperty

  ↳ BooleanProperty

  ↳ DateProperty

  ↳ EnumProperty

  ↳ ReferenceProperty

Table of contents

Properties

• constraints
• description
• key
• label
• metadata
• readonly

Properties

constraints

• Optional constraints: Constraint[]

Defined in

src/api/resources/property/types/BaseProperty.ts:12

---

description

• Optional description: string

Defined in

src/api/resources/property/types/BaseProperty.ts:11

---

key

• key: string

Defined in

src/api/resources/property/types/BaseProperty.ts:8

---

label

• Optional label: string

User friendly field name

Defined in

src/api/resources/property/types/BaseProperty.ts:10

---

metadata

• Optional metadata: unknown

Useful for any contextual metadata regarding the schema. Store any valid json here.

Defined in

src/api/resources/property/types/BaseProperty.ts:15

---

readonly

• Optional readonly: boolean

Defined in

src/api/resources/property/types/BaseProperty.ts:13

@flatfile/api / Exports / Flatfile / property / BooleanProperty

Interface: 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.

Hierarchy

• BaseProperty

  ↳ BooleanProperty

  ↳↳ Boolean

Table of contents

Properties

• config
• constraints
• description
• key
• label
• metadata
• readonly

Properties

config

• Optional config: BooleanPropertyConfig

Defined in

src/api/resources/property/types/BooleanProperty.ts:11

---

constraints

• Optional constraints: Constraint[]

Inherited from

BaseProperty.constraints

Defined in

src/api/resources/property/types/BaseProperty.ts:12

---

description

• Optional description: string

Inherited from

BaseProperty.description

Defined in

src/api/resources/property/types/BaseProperty.ts:11

---

key

• key: string

Inherited from

BaseProperty.key

Defined in

src/api/resources/property/types/BaseProperty.ts:8

---

label

• Optional label: string

User friendly field name

Inherited from

BaseProperty.label

Defined in

src/api/resources/property/types/BaseProperty.ts:10

---

metadata

• Optional metadata: unknown

Useful for any contextual metadata regarding the schema. Store any valid json here.

Inherited from

BaseProperty.metadata

Defined in

src/api/resources/property/types/BaseProperty.ts:15

---

readonly

• Optional readonly: boolean

Inherited from

BaseProperty.readonly

Defined in

src/api/resources/property/types/BaseProperty.ts:13

@flatfile/api / Exports / Flatfile / property / BooleanPropertyConfig

Interface: BooleanPropertyConfig

Flatfile.property.BooleanPropertyConfig

This file was auto-generated by Fern from our API Definition.

Table of contents

Properties

• allowIndeterminate

Properties

allowIndeterminate

• allowIndeterminate: boolean

Allow a neither true or false state to be stored as null

Defined in

src/api/resources/property/types/BooleanPropertyConfig.ts:7

@flatfile/api / Exports / Flatfile / property / Constraint / Computed

Interface: Computed

property.Constraint.Computed

Table of contents

Properties

• type

Properties

type

• type: "computed"

Defined in

src/api/resources/property/types/Constraint.ts:19

@flatfile/api / Exports / Flatfile / property / Constraint / Required

Interface: Required

property.Constraint.Required

Table of contents

Properties

• type

Properties

type

• type: "required"

Defined in

src/api/resources/property/types/Constraint.ts:11

@flatfile/api / Exports / Flatfile / property / Constraint / Unique

Interface: Unique

property.Constraint.Unique

Hierarchy

• UniqueConstraint

  ↳ Unique

Table of contents

Properties

• config
• type

Properties

config

• Optional config: UniqueConstraintConfig

Inherited from

UniqueConstraint.config

Defined in

src/api/resources/property/types/UniqueConstraint.ts:8

---

type

• type: "unique"

Defined in

src/api/resources/property/types/Constraint.ts:15

@flatfile/api / Exports / Flatfile / property / DateProperty

Interface: 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.

Hierarchy

• BaseProperty

  ↳ DateProperty

  ↳↳ Date_

Table of contents

Properties

• constraints
• description
• key
• label
• metadata
• readonly

Properties

constraints

• Optional constraints: Constraint[]

Inherited from

BaseProperty.constraints

Defined in

src/api/resources/property/types/BaseProperty.ts:12

---

description

• Optional description: string

Inherited from

BaseProperty.description

Defined in

src/api/resources/property/types/BaseProperty.ts:11

---

key

• key: string

Inherited from

BaseProperty.key

Defined in

src/api/resources/property/types/BaseProperty.ts:8

---

label

• Optional label: string

User friendly field name

Inherited from

BaseProperty.label

Defined in

src/api/resources/property/types/BaseProperty.ts:10

---

metadata

• Optional metadata: unknown

Useful for any contextual metadata regarding the schema. Store any valid json here.

Inherited from

BaseProperty.metadata

Defined in

src/api/resources/property/types/BaseProperty.ts:15

---

readonly

• Optional readonly: boolean

Inherited from

BaseProperty.readonly

Defined in

src/api/resources/property/types/BaseProperty.ts:13

@flatfile/api / Exports / Flatfile / property / EnumProperty

Interface: 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.

Hierarchy

• BaseProperty

• ArrayableProperty

  ↳ EnumProperty

  ↳↳ Enum

Table of contents

Properties

• config
• constraints
• description
• isArray
• key
• label
• metadata
• multi
• readonly

Properties

config

• config: EnumPropertyConfig

Defined in

src/api/resources/property/types/EnumProperty.ts:13

---

constraints

• Optional constraints: Constraint[]

Inherited from

BaseProperty.constraints

Defined in

src/api/resources/property/types/BaseProperty.ts:12

---

description

• Optional description: string

Inherited from

BaseProperty.description

Defined in

src/api/resources/property/types/BaseProperty.ts:11

---

isArray

• Optional isArray: boolean

Will allow multiple values and store as an array

Inherited from

ArrayableProperty.isArray

Defined in

src/api/resources/property/types/ArrayableProperty.ts:7

---

key

• key: string

Inherited from

BaseProperty.key

Defined in

src/api/resources/property/types/BaseProperty.ts:8

---

label

• Optional label: string

User friendly field name

Inherited from

BaseProperty.label

Defined in

src/api/resources/property/types/BaseProperty.ts:10

---

metadata

• Optional metadata: unknown

Useful for any contextual metadata regarding the schema. Store any valid json here.

Inherited from

BaseProperty.metadata

Defined in

src/api/resources/property/types/BaseProperty.ts:15

---

multi

• Optional multi: boolean

Will allow multiple values and store / provide the values in an array if set. Not all field types support arrays.

Defined in

src/api/resources/property/types/EnumProperty.ts:12

---

readonly

• Optional readonly: boolean

Inherited from

BaseProperty.readonly

Defined in

src/api/resources/property/types/BaseProperty.ts:13

@flatfile/api / Exports / Flatfile / property / EnumPropertyConfig

Interface: EnumPropertyConfig

Flatfile.property.EnumPropertyConfig

Table of contents

Properties

• allowCustom
• options

Properties

allowCustom

• Optional allowCustom: boolean

Permit the user to create new options for this specific field.

Defined in

src/api/resources/property/types/EnumPropertyConfig.ts:9

---

options

• options: EnumPropertyOption[]

Defined in

src/api/resources/property/types/EnumPropertyConfig.ts:10

@flatfile/api / Exports / Flatfile / property / EnumPropertyOption

Interface: EnumPropertyOption

Flatfile.property.EnumPropertyOption

This file was auto-generated by Fern from our API Definition.

Table of contents

Properties

• color
• icon
• label
• meta
• value

Properties

color

• Optional color: string

An optional color to assign this option

Defined in

src/api/resources/property/types/EnumPropertyOption.ts:9

---

icon

• Optional icon: string

A reference pointer to a previously registered icon

Defined in

src/api/resources/property/types/EnumPropertyOption.ts:11

---

label

• Optional label: string

A visual label for this option, defaults to value if not provided

Defined in

src/api/resources/property/types/EnumPropertyOption.ts:7

---

meta

• Optional meta: Record<string, unknown>

An arbitrary JSON object to be associated with this option and made available to hooks

Defined in

src/api/resources/property/types/EnumPropertyOption.ts:13

---

value

• Optional value: unknown

The value or ID of this option. This value will be sent in egress. The type is a string | integer | boolean.

Defined in

src/api/resources/property/types/EnumPropertyOption.ts:15

@flatfile/api / Exports / Flatfile / property / NumberConfig

Interface: NumberConfig

Flatfile.property.NumberConfig

Example

{
 *         decimalPlaces: 2
 *     }

Table of contents

Properties

• decimalPlaces

Properties

decimalPlaces

• decimalPlaces: number

Number of decimal places to round data to

Defined in

src/api/resources/property/types/NumberConfig.ts:13

@flatfile/api / Exports / Flatfile / property / NumberProperty

Interface: 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.

Hierarchy

• BaseProperty

• ArrayableProperty

  ↳ NumberProperty

  ↳↳ Number

Table of contents

Properties

• config
• constraints
• description
• isArray
• key
• label
• metadata
• readonly

Properties

config

• Optional config: NumberConfig

Defined in

src/api/resources/property/types/NumberProperty.ts:11

---

constraints

• Optional constraints: Constraint[]

Inherited from

BaseProperty.constraints

Defined in

src/api/resources/property/types/BaseProperty.ts:12

---

description

• Optional description: string

Inherited from

BaseProperty.description

Defined in

src/api/resources/property/types/BaseProperty.ts:11

---

isArray

• Optional isArray: boolean

Will allow multiple values and store as an array

Inherited from

ArrayableProperty.isArray

Defined in

src/api/resources/property/types/ArrayableProperty.ts:7

---

key

• key: string

Inherited from

BaseProperty.key

Defined in

src/api/resources/property/types/BaseProperty.ts:8

---

label

• Optional label: string

User friendly field name

Inherited from

BaseProperty.label

Defined in

src/api/resources/property/types/BaseProperty.ts:10

---

metadata

• Optional metadata: unknown

Useful for any contextual metadata regarding the schema. Store any valid json here.

Inherited from

BaseProperty.metadata

Defined in

src/api/resources/property/types/BaseProperty.ts:15

---

readonly

• Optional readonly: boolean

Inherited from

BaseProperty.readonly

Defined in

src/api/resources/property/types/BaseProperty.ts:13

@flatfile/api / Exports / Flatfile / property / Property / Boolean

Interface: Boolean

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.

Hierarchy

• BooleanProperty

  ↳ Boolean

Table of contents

Properties

• config
• constraints
• description
• key
• label
• metadata
• readonly
• type

Properties

config

• Optional config: BooleanPropertyConfig

Inherited from

BooleanProperty.config

Defined in

src/api/resources/property/types/BooleanProperty.ts:11

---

constraints

• Optional constraints: Constraint[]

Inherited from

BooleanProperty.constraints

Defined in

src/api/resources/property/types/BaseProperty.ts:12

---

description

• Optional description: string

Inherited from

BooleanProperty.description

Defined in

src/api/resources/property/types/BaseProperty.ts:11

---

key

• key: string

Inherited from

BooleanProperty.key

Defined in

src/api/resources/property/types/BaseProperty.ts:8

---

label

• Optional label: string

User friendly field name

Inherited from

BooleanProperty.label

Defined in

src/api/resources/property/types/BaseProperty.ts:10

---

metadata

• Optional metadata: unknown

Useful for any contextual metadata regarding the schema. Store any valid json here.

Inherited from

BooleanProperty.metadata

Defined in

src/api/resources/property/types/BaseProperty.ts:15

---

readonly

• Optional readonly: boolean

Inherited from

BooleanProperty.readonly

Defined in

src/api/resources/property/types/BaseProperty.ts:13

---

type

• type: "boolean"

Defined in

src/api/resources/property/types/Property.ts:104

@flatfile/api / Exports / Flatfile / property / Property / Date_

Interface: Date_

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.

Hierarchy

• DateProperty

  ↳ Date_

Table of contents

Properties

• constraints
• description
• key
• label
• metadata
• readonly
• type

Properties

constraints

• Optional constraints: Constraint[]

Inherited from

DateProperty.constraints

Defined in

src/api/resources/property/types/BaseProperty.ts:12

---

description

• Optional description: string

Inherited from

DateProperty.description

Defined in

src/api/resources/property/types/BaseProperty.ts:11

---

key

• key: string

Inherited from

DateProperty.key

Defined in

src/api/resources/property/types/BaseProperty.ts:8

---

label

• Optional label: string

User friendly field name

Inherited from

DateProperty.label

Defined in

src/api/resources/property/types/BaseProperty.ts:10

---

metadata

• Optional metadata: unknown

Useful for any contextual metadata regarding the schema. Store any valid json here.

Inherited from

DateProperty.metadata

Defined in

src/api/resources/property/types/BaseProperty.ts:15

---

readonly

• Optional readonly: boolean

Inherited from

DateProperty.readonly

Defined in

src/api/resources/property/types/BaseProperty.ts:13

---

type

• type: "date"

Defined in

src/api/resources/property/types/Property.ts:108

@flatfile/api / Exports / Flatfile / property / Property / Enum

Interface: Enum

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.

Hierarchy

• EnumProperty

  ↳ Enum

Table of contents

Properties

• config
• constraints
• description
• isArray
• key
• label
• metadata
• multi
• readonly
• type

Properties

config

• config: EnumPropertyConfig

Inherited from

EnumProperty.config

Defined in

src/api/resources/property/types/EnumProperty.ts:13

---

constraints

• Optional constraints: Constraint[]

Inherited from

EnumProperty.constraints

Defined in

src/api/resources/property/types/BaseProperty.ts:12

---

description

• Optional description: string

Inherited from

EnumProperty.description

Defined in

src/api/resources/property/types/BaseProperty.ts:11

---

isArray

• Optional isArray: boolean

Will allow multiple values and store as an array

Inherited from

EnumProperty.isArray

Defined in

src/api/resources/property/types/ArrayableProperty.ts:7

---

key

• key: string

Inherited from

EnumProperty.key

Defined in

src/api/resources/property/types/BaseProperty.ts:8

---

label

• Optional label: string

User friendly field name

Inherited from

EnumProperty.label

Defined in

src/api/resources/property/types/BaseProperty.ts:10

---

metadata

• Optional metadata: unknown

Useful for any contextual metadata regarding the schema. Store any valid json here.

Inherited from

EnumProperty.metadata

Defined in

src/api/resources/property/types/BaseProperty.ts:15

---

multi

• Optional multi: boolean

Will allow multiple values and store / provide the values in an array if set. Not all field types support arrays.

Inherited from

EnumProperty.multi

Defined in

src/api/resources/property/types/EnumProperty.ts:12

---

readonly

• Optional readonly: boolean

Inherited from

EnumProperty.readonly

Defined in

src/api/resources/property/types/BaseProperty.ts:13

---

type

• type: "enum"

Defined in

src/api/resources/property/types/Property.ts:112

@flatfile/api / Exports / Flatfile / property / Property / Number

Interface: Number

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.

Hierarchy

• NumberProperty

  ↳ Number

Table of contents

Properties

• config
• constraints
• description
• isArray
• key
• label
• metadata
• readonly
• type

Properties

config

• Optional config: NumberConfig

Inherited from

NumberProperty.config

Defined in

src/api/resources/property/types/NumberProperty.ts:11

---

constraints

• Optional constraints: Constraint[]

Inherited from

NumberProperty.constraints

Defined in

src/api/resources/property/types/BaseProperty.ts:12

---

description

• Optional description: string

Inherited from

NumberProperty.description

Defined in

src/api/resources/property/types/BaseProperty.ts:11

---

isArray

• Optional isArray: boolean

Will allow multiple values and store as an array

Inherited from

NumberProperty.isArray

Defined in

src/api/resources/property/types/ArrayableProperty.ts:7

---

key

• key: string

Inherited from

NumberProperty.key

Defined in

src/api/resources/property/types/BaseProperty.ts:8

---

label

• Optional label: string

User friendly field name

Inherited from

NumberProperty.label

Defined in

src/api/resources/property/types/BaseProperty.ts:10

---

metadata

• Optional metadata: unknown

Useful for any contextual metadata regarding the schema. Store any valid json here.

Inherited from

NumberProperty.metadata

Defined in

src/api/resources/property/types/BaseProperty.ts:15

---

readonly

• Optional readonly: boolean

Inherited from

NumberProperty.readonly

Defined in

src/api/resources/property/types/BaseProperty.ts:13

---

type

• type: "number"

Defined in

src/api/resources/property/types/Property.ts:100

@flatfile/api / Exports / Flatfile / property / Property / Reference

Interface: Reference

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.

Hierarchy

• ReferenceProperty

  ↳ Reference

Table of contents

Properties

• config
• constraints
• description
• isArray
• key
• label
• metadata
• readonly
• type

Properties

config

• config: ReferencePropertyConfig

Inherited from

ReferenceProperty.config

Defined in

src/api/resources/property/types/ReferenceProperty.ts:11

---

constraints

• Optional constraints: Constraint[]

Inherited from

ReferenceProperty.constraints

Defined in

src/api/resources/property/types/BaseProperty.ts:12

---

description

• Optional description: string

Inherited from

ReferenceProperty.description

Defined in

src/api/resources/property/types/BaseProperty.ts:11

---

isArray

• Optional isArray: boolean

Will allow multiple values and store as an array

Inherited from

ReferenceProperty.isArray

Defined in

src/api/resources/property/types/ArrayableProperty.ts:7

---

key

• key: string

Inherited from

ReferenceProperty.key

Defined in

src/api/resources/property/types/BaseProperty.ts:8

---

label

• Optional label: string

User friendly field name

Inherited from

ReferenceProperty.label

Defined in

src/api/resources/property/types/BaseProperty.ts:10

---

metadata

• Optional metadata: unknown

Useful for any contextual metadata regarding the schema. Store any valid json here.

Inherited from

ReferenceProperty.metadata

Defined in

src/api/resources/property/types/BaseProperty.ts:15

---

readonly

• Optional readonly: boolean

Inherited from

ReferenceProperty.readonly

Defined in

src/api/resources/property/types/BaseProperty.ts:13

---

type

• type: "reference"

Defined in

src/api/resources/property/types/Property.ts:116

@flatfile/api / Exports / Flatfile / property / Property / String

Interface: String

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.

Hierarchy

• StringProperty

  ↳ String

Table of contents

Properties

• config
• constraints
• description
• key
• label
• metadata
• readonly
• type

Properties

config

• Optional config: StringConfig

Inherited from

StringProperty.config

Defined in

src/api/resources/property/types/StringProperty.ts:11

---

constraints

• Optional constraints: Constraint[]

Inherited from

StringProperty.constraints

Defined in

src/api/resources/property/types/BaseProperty.ts:12

---

description

• Optional description: string

Inherited from

StringProperty.description

Defined in

src/api/resources/property/types/BaseProperty.ts:11

---

key

• key: string

Inherited from

StringProperty.key

Defined in

src/api/resources/property/types/BaseProperty.ts:8

---

label

• Optional label: string

User friendly field name

Inherited from

StringProperty.label

Defined in

src/api/resources/property/types/BaseProperty.ts:10

---

metadata

• Optional metadata: unknown

Useful for any contextual metadata regarding the schema. Store any valid json here.

Inherited from

StringProperty.metadata

Defined in

src/api/resources/property/types/BaseProperty.ts:15

---

readonly

• Optional readonly: boolean

Inherited from

StringProperty.readonly

Defined in

src/api/resources/property/types/BaseProperty.ts:13

---

type

• type: "string"

Defined in

src/api/resources/property/types/Property.ts:96

@flatfile/api / Exports / Flatfile / property / ReferenceProperty

Interface: 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.

Hierarchy

• BaseProperty

• ArrayableProperty

  ↳ ReferenceProperty

  ↳↳ Reference

Table of contents

Properties

• config
• constraints
• description
• isArray
• key
• label
• metadata
• readonly

Properties

config

• config: ReferencePropertyConfig

Defined in

src/api/resources/property/types/ReferenceProperty.ts:11

---

constraints

• Optional constraints: Constraint[]

Inherited from

BaseProperty.constraints

Defined in

src/api/resources/property/types/BaseProperty.ts:12

---

description

• Optional description: string

Inherited from

BaseProperty.description

Defined in

src/api/resources/property/types/BaseProperty.ts:11

---

isArray

• Optional isArray: boolean

Will allow multiple values and store as an array

Inherited from

ArrayableProperty.isArray

Defined in

src/api/resources/property/types/ArrayableProperty.ts:7

---

key

• key: string

Inherited from

BaseProperty.key

Defined in

src/api/resources/property/types/BaseProperty.ts:8

---

label

• Optional label: string

User friendly field name

Inherited from

BaseProperty.label

Defined in

src/api/resources/property/types/BaseProperty.ts:10

---

metadata

• Optional metadata: unknown

Useful for any contextual metadata regarding the schema. Store any valid json here.

Inherited from

BaseProperty.metadata

Defined in

src/api/resources/property/types/BaseProperty.ts:15

---

readonly

• Optional readonly: boolean

Inherited from

BaseProperty.readonly

Defined in

src/api/resources/property/types/BaseProperty.ts:13

@flatfile/api / Exports / Flatfile / property / ReferencePropertyConfig

Interface: ReferencePropertyConfig

Flatfile.property.ReferencePropertyConfig

Table of contents

Properties

• key
• ref
• relationship

Properties

key

• key: string

Key of the property to use as the reference key. Defaults to id

Defined in

src/api/resources/property/types/ReferencePropertyConfig.ts:11

---

ref

• ref: string

Full path reference to a sheet configuration. Must be in the same workbook.

Defined in

src/api/resources/property/types/ReferencePropertyConfig.ts:9

---

relationship

• relationship: ReferencePropertyRelationship

The type of relationship this defines

Defined in

src/api/resources/property/types/ReferencePropertyConfig.ts:13

@flatfile/api / Exports / Flatfile / property / StringConfig

Interface: StringConfig

Flatfile.property.StringConfig

Table of contents

Properties

• size

Properties

size

• size: StringConfigOptions

Defined in

src/api/resources/property/types/StringConfig.ts:8

@flatfile/api / Exports / Flatfile / property / StringProperty

Interface: 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.

Hierarchy

• BaseProperty

  ↳ StringProperty

  ↳↳ String

Table of contents

Properties

• config
• constraints
• description
• key
• label
• metadata
• readonly

Properties

config

• Optional config: StringConfig

Defined in

src/api/resources/property/types/StringProperty.ts:11

---

constraints

• Optional constraints: Constraint[]

Inherited from

BaseProperty.constraints

Defined in

src/api/resources/property/types/BaseProperty.ts:12

---

description

• Optional description: string

Inherited from

BaseProperty.description

Defined in

src/api/resources/property/types/BaseProperty.ts:11

---

key

• key: string

Inherited from

BaseProperty.key

Defined in

src/api/resources/property/types/BaseProperty.ts:8

---

label

• Optional label: string

User friendly field name

Inherited from

BaseProperty.label

Defined in

src/api/resources/property/types/BaseProperty.ts:10

---

metadata

• Optional metadata: unknown

Useful for any contextual metadata regarding the schema. Store any valid json here.

Inherited from

BaseProperty.metadata

Defined in

src/api/resources/property/types/BaseProperty.ts:15

---

readonly

• Optional readonly: boolean

Inherited from

BaseProperty.readonly

Defined in

src/api/resources/property/types/BaseProperty.ts:13

@flatfile/api / Exports / Flatfile / property / UniqueConstraint

Interface: UniqueConstraint

Flatfile.property.UniqueConstraint

Hierarchy

• UniqueConstraint

  ↳ Unique

Table of contents

Properties

• config

Properties

config

• Optional config: UniqueConstraintConfig

Defined in

src/api/resources/property/types/UniqueConstraint.ts:8

@flatfile/api / Exports / Flatfile / property / UniqueConstraintConfig

Interface: UniqueConstraintConfig

Flatfile.property.UniqueConstraintConfig

This file was auto-generated by Fern from our API Definition.

Table of contents

Properties

• caseSensitive
• ignoreEmpty

Properties

caseSensitive

• Optional caseSensitive: boolean

Ignore casing when determining uniqueness

Defined in

src/api/resources/property/types/UniqueConstraintConfig.ts:7

---

ignoreEmpty

• Optional ignoreEmpty: boolean

Do not flag empty values as duplicate

Defined in

src/api/resources/property/types/UniqueConstraintConfig.ts:9

@flatfile/api / Exports / Flatfile / records / CellValue

Interface: CellValue

Flatfile.records.CellValue

Hierarchy

• CellValue

  ↳ CellValueWithCounts

  ↳ CellValueWithLinks

Table of contents

Properties

• messages
• updatedAt
• valid
• value

Properties

messages

• Optional messages: ValidationMessage[]

Defined in

src/api/resources/records/types/CellValue.ts:9

---

updatedAt

• Optional updatedAt: Date

Defined in

src/api/resources/records/types/CellValue.ts:11

---

valid

• Optional valid: boolean

Defined in

src/api/resources/records/types/CellValue.ts:8

---

value

• Optional value: CellValueUnion

Defined in

src/api/resources/records/types/CellValue.ts:10

@flatfile/api / Exports / Flatfile / records / CellValueWithLinks

Interface: CellValueWithLinks

Flatfile.records.CellValueWithLinks

Hierarchy

• CellValue

  ↳ CellValueWithLinks

Table of contents

Properties

• links
• messages
• updatedAt
• valid
• value

Properties

links

• Optional links: Records

Defined in

src/api/resources/records/types/CellValueWithLinks.ts:8

---

messages

• Optional messages: ValidationMessage[]

Inherited from

CellValue.messages

Defined in

src/api/resources/records/types/CellValue.ts:9

---

updatedAt

• Optional updatedAt: Date

Inherited from

CellValue.updatedAt

Defined in

src/api/resources/records/types/CellValue.ts:11

---

valid

• Optional valid: boolean

Inherited from

CellValue.valid

Defined in

src/api/resources/records/types/CellValue.ts:8

---

value

• Optional value: CellValueUnion

Inherited from

CellValue.value

Defined in

src/api/resources/records/types/CellValue.ts:10

@flatfile/api / Exports / Flatfile / records / DeleteRecordsRequest

Interface: DeleteRecordsRequest

Flatfile.records.DeleteRecordsRequest

Table of contents

Properties

• ids

Properties

ids

• Optional ids: string | string[]

A list of record ids

Defined in

src/api/resources/records/client/requests/DeleteRecordsRequest.ts:11

@flatfile/api / Exports / Flatfile / records / FindAndReplaceRecordRequest

Interface: FindAndReplaceRecordRequest

Flatfile.records.FindAndReplaceRecordRequest

Table of contents

Properties

• fieldKey
• filter
• filterField
• find
• ids
• replace
• searchField
• searchValue

Properties

fieldKey

• fieldKey: string

The value to replace found values with

Defined in

src/api/resources/records/client/requests/FindAndReplaceRecordRequest.ts:25

---

filter

• Optional filter: Filter

Defined in

src/api/resources/records/client/requests/FindAndReplaceRecordRequest.ts:8

---

filterField

• Optional filterField: string

Name of field by which to filter records

Defined in

src/api/resources/records/client/requests/FindAndReplaceRecordRequest.ts:12

---

find

• Optional find: CellValueUnion

A value to find for a given field in a sheet. Wrap the value in "" for exact match

Defined in

src/api/resources/records/client/requests/FindAndReplaceRecordRequest.ts:21

---

ids

• 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.

Defined in

src/api/resources/records/client/requests/FindAndReplaceRecordRequest.ts:19

---

replace

• Optional replace: CellValueUnion

The value to replace found values with

Defined in

src/api/resources/records/client/requests/FindAndReplaceRecordRequest.ts:23

---

searchField

• Optional searchField: string

Defined in

src/api/resources/records/client/requests/FindAndReplaceRecordRequest.ts:14

---

searchValue

• Optional searchValue: string

Defined in

src/api/resources/records/client/requests/FindAndReplaceRecordRequest.ts:13

@flatfile/api / Exports / Flatfile / records / FindAndReplaceRecordRequestDeprecated

Interface: FindAndReplaceRecordRequestDeprecated

Flatfile.records.FindAndReplaceRecordRequestDeprecated

Table of contents

Properties

• fieldKey
• filter
• pageNumber
• pageSize
• replace
• searchValue

Properties

fieldKey

• fieldKey: string

A unique key used to identify a field in a sheet

Defined in

src/api/resources/records/client/requests/FindAndReplaceRecordRequestDeprecated.ts:11

---

filter

• Optional filter: Filter

Defined in

src/api/resources/records/client/requests/FindAndReplaceRecordRequestDeprecated.ts:16

---

pageNumber

• Optional pageNumber: number

Based on pageSize, which page of records to return

Defined in

src/api/resources/records/client/requests/FindAndReplaceRecordRequestDeprecated.ts:24

---

pageSize

• Optional pageSize: number

Number of records to return in a page (default 1000 if pageNumber included)

Defined in

src/api/resources/records/client/requests/FindAndReplaceRecordRequestDeprecated.ts:20

---

replace

• Optional replace: unknown

The value to replace found values with

Defined in

src/api/resources/records/client/requests/FindAndReplaceRecordRequestDeprecated.ts:26

---

searchValue

• searchValue: string

A value to find for a given field in a sheet. Wrap the value in "" for exact match

Defined in

src/api/resources/records/client/requests/FindAndReplaceRecordRequestDeprecated.ts:15

@flatfile/api / Exports / Flatfile / records / FindRecordsRequest

Interface: FindRecordsRequest

Flatfile.records.FindRecordsRequest

This file was auto-generated by Fern from our API Definition.

Table of contents

Properties

• fieldKey
• pageNumber
• pageSize
• searchValue

Properties

fieldKey

• fieldKey: string

The unique key used to identify a field in a sheet

Defined in

src/api/resources/records/client/requests/FindRecordsRequest.ts:9

---

pageNumber

• Optional pageNumber: number

Based on pageSize, which page of records to return

Defined in

src/api/resources/records/client/requests/FindRecordsRequest.ts:21

---

pageSize

• Optional pageSize: number

Number of records to return in a page (default 1000 if pageNumber included)

Defined in

src/api/resources/records/client/requests/FindRecordsRequest.ts:17

---

searchValue

• searchValue: string

The value to search for

Defined in

src/api/resources/records/client/requests/FindRecordsRequest.ts:13

@flatfile/api / Exports / Flatfile / records / GetRecordsRequest

Interface: GetRecordsRequest

Flatfile.records.GetRecordsRequest

Table of contents

Properties

• filter
• filterField
• for
• ids
• includeCounts
• includeLMessages
• includeLinks
• pageNumber
• pageSize
• q
• searchField
• searchValue
• sinceVersionId
• sortDirection
• sortField
• untilVersionId
• versionId

Properties

filter

• Optional filter: Filter

Defined in

src/api/resources/records/client/requests/GetRecordsRequest.ts:13

---

filterField

• Optional filterField: string

Name of field by which to filter records

Defined in

src/api/resources/records/client/requests/GetRecordsRequest.ts:17

---

for

• Optional for: string

if "for" is provided, the query parameters will be pulled from the event payload

Defined in

src/api/resources/records/client/requests/GetRecordsRequest.ts:48

---

ids

• 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.

Defined in

src/api/resources/records/client/requests/GetRecordsRequest.ts:24

---

includeCounts

• Optional includeCounts: boolean

Include counts for the total records, valid records and records with errors

Defined in

src/api/resources/records/client/requests/GetRecordsRequest.ts:36

---

includeLMessages

• Optional includeLMessages: boolean

Include error messages, defaults to false.

Defined in

src/api/resources/records/client/requests/GetRecordsRequest.ts:44

---

includeLinks

• Optional includeLinks: boolean

If true, linked records will be included in the results. Defaults to false.

Defined in

src/api/resources/records/client/requests/GetRecordsRequest.ts:40

---

pageNumber

• Optional pageNumber: number

Based on pageSize, which page of records to return

Defined in

src/api/resources/records/client/requests/GetRecordsRequest.ts:32

---

pageSize

• Optional pageSize: number

Number of records to return in a page (default 1000 if pageNumber included)

Defined in

src/api/resources/records/client/requests/GetRecordsRequest.ts:28

---

q

• Optional q: string

An FFQL query used to filter the result set

Defined in

src/api/resources/records/client/requests/GetRecordsRequest.ts:52

---

searchField

• Optional searchField: string

Defined in

src/api/resources/records/client/requests/GetRecordsRequest.ts:19

---

searchValue

• Optional searchValue: string

Defined in

src/api/resources/records/client/requests/GetRecordsRequest.ts:18

---

sinceVersionId

• Optional sinceVersionId: string

Defined in

src/api/resources/records/client/requests/GetRecordsRequest.ts:10

---

sortDirection

• Optional sortDirection: SortDirection

Defined in

src/api/resources/records/client/requests/GetRecordsRequest.ts:12

---

sortField

• Optional sortField: string

Defined in

src/api/resources/records/client/requests/GetRecordsRequest.ts:11

---

untilVersionId

• Optional untilVersionId: string

Defined in

src/api/resources/records/client/requests/GetRecordsRequest.ts:9

---

versionId

• Optional versionId: string

Defined in

src/api/resources/records/client/requests/GetRecordsRequest.ts:8

@flatfile/api / Exports / Flatfile / records / RecordCounts

Interface: RecordCounts

Flatfile.records.RecordCounts

This file was auto-generated by Fern from our API Definition.

Table of contents

Properties

• error
• errorsByField
• total
• valid

Properties

error

• error: number

Defined in

src/api/resources/records/types/RecordCounts.ts:8

---

errorsByField

• Optional errorsByField: Record<string, number>

Defined in

src/api/resources/records/types/RecordCounts.ts:9

---

total

• total: number

Defined in

src/api/resources/records/types/RecordCounts.ts:6

---

valid

• valid: number

Defined in

src/api/resources/records/types/RecordCounts.ts:7

@flatfile/api / Exports / Flatfile / records / RecordWithLinks

Interface: RecordWithLinks

Flatfile.records.RecordWithLinks

A single row of data in a Sheet, including links to related rows

Table of contents

Properties

• id
• messages
• metadata
• valid
• values

Properties

id

• id: string

Defined in

src/api/resources/records/types/RecordWithLinks.ts:11

---

messages

• Optional messages: ValidationMessage[]

Defined in

src/api/resources/records/types/RecordWithLinks.ts:14

---

metadata

• Optional metadata: Record<string, unknown>

Defined in

src/api/resources/records/types/RecordWithLinks.ts:15

---

valid

• Optional valid: boolean

Defined in

src/api/resources/records/types/RecordWithLinks.ts:13

---

values

• values: RecordDataWithLinks

Defined in

src/api/resources/records/types/RecordWithLinks.ts:12

@flatfile/api / Exports / Flatfile / records / Record_

Interface: Record_

Flatfile.records.Record_

A single row of data in a Sheet

Table of contents

Properties

• id
• messages
• metadata
• valid
• values

Properties

id

• id: string

Defined in

src/api/resources/records/types/Record_.ts:11

---

messages

• Optional messages: ValidationMessage[]

Defined in

src/api/resources/records/types/Record_.ts:14

---

metadata

• Optional metadata: Record<string, unknown>

Defined in

src/api/resources/records/types/Record_.ts:15

---

valid

• Optional valid: boolean

Defined in

src/api/resources/records/types/Record_.ts:13

---

values

• values: RecordData

Defined in

src/api/resources/records/types/Record_.ts:12

@flatfile/api / Exports / Flatfile / records / RecordsResponse

Interface: RecordsResponse

Flatfile.records.RecordsResponse

Table of contents

Properties

• data

Properties

data

• data: RecordsResponseData

Defined in

src/api/resources/records/types/RecordsResponse.ts:8

@flatfile/api / Exports / Flatfile / records / RecordsResponseData

Interface: RecordsResponseData

Flatfile.records.RecordsResponseData

A list of records with optional record counts

Hierarchy

• Success

  ↳ RecordsResponseData

Table of contents

Properties

• counts
• data
• records
• versionId

Properties

counts

• Optional counts: RecordCounts

Defined in

src/api/resources/records/types/RecordsResponseData.ts:12

---

data

• data: SuccessData

Inherited from

Success.data

Defined in

src/api/resources/commons/types/Success.ts:18

---

records

• Optional records: RecordsWithLinks

Defined in

src/api/resources/records/types/RecordsResponseData.ts:11

---

versionId

• Optional versionId: string

Defined in

src/api/resources/records/types/RecordsResponseData.ts:13

@flatfile/api / Exports / Flatfile / records / ValidationMessage

Interface: ValidationMessage

Flatfile.records.ValidationMessage

Record data validation messages

Table of contents

Properties

• message
• source
• type

Properties

message

• Optional message: string

Defined in

src/api/resources/records/types/ValidationMessage.ts:13

---

source

• Optional source: ValidationSource

Defined in

src/api/resources/records/types/ValidationMessage.ts:12

---

type

• Optional type: ValidationType

Defined in

src/api/resources/records/types/ValidationMessage.ts:11

@flatfile/api / Exports / Flatfile / sheets / GetRecordCountsRequest

Interface: GetRecordCountsRequest

Flatfile.sheets.GetRecordCountsRequest

Table of contents

Properties

• byField
• filter
• filterField
• q
• searchField
• searchValue
• sinceVersionId
• versionId

Properties

byField

• Optional byField: boolean

If true, the error counts for each field will also be returned

Defined in

src/api/resources/sheets/client/requests/GetRecordCountsRequest.ts:20

---

filter

• Optional filter: Filter

Options to filter records

Defined in

src/api/resources/sheets/client/requests/GetRecordCountsRequest.ts:13

---

filterField

• Optional filterField: string

Defined in

src/api/resources/sheets/client/requests/GetRecordCountsRequest.ts:14

---

q

• Optional q: string

An FFQL query used to filter the result set to be counted

Defined in

src/api/resources/sheets/client/requests/GetRecordCountsRequest.ts:24

---

searchField

• Optional searchField: string

Defined in

src/api/resources/sheets/client/requests/GetRecordCountsRequest.ts:16

---

searchValue

• Optional searchValue: string

Defined in

src/api/resources/sheets/client/requests/GetRecordCountsRequest.ts:15

---

sinceVersionId

• Optional sinceVersionId: string

Defined in

src/api/resources/sheets/client/requests/GetRecordCountsRequest.ts:9

---

versionId

• Optional versionId: string

Defined in

src/api/resources/sheets/client/requests/GetRecordCountsRequest.ts:8

@flatfile/api / Exports / Flatfile / sheets / GetRecordsCsvRequest

Interface: GetRecordsCsvRequest

Flatfile.sheets.GetRecordsCsvRequest

Table of contents

Properties

• filter
• filterField
• ids
• searchField
• searchValue
• sinceVersionId
• sortDirection
• sortField
• versionId

Properties

filter

• Optional filter: Filter

Options to filter records

Defined in

src/api/resources/sheets/client/requests/GetRecordsCsvRequest.ts:18

---

filterField

• Optional filterField: string

Defined in

src/api/resources/sheets/client/requests/GetRecordsCsvRequest.ts:19

---

ids

• 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.

Defined in

src/api/resources/sheets/client/requests/GetRecordsCsvRequest.ts:26

---

searchField

• Optional searchField: string

Defined in

src/api/resources/sheets/client/requests/GetRecordsCsvRequest.ts:21

---

searchValue

• Optional searchValue: string

Defined in

src/api/resources/sheets/client/requests/GetRecordsCsvRequest.ts:20

---

sinceVersionId

• Optional sinceVersionId: string

Defined in

src/api/resources/sheets/client/requests/GetRecordsCsvRequest.ts:9

---

sortDirection

• Optional sortDirection: SortDirection

Sort direction - asc (ascending) or desc (descending)

Defined in

src/api/resources/sheets/client/requests/GetRecordsCsvRequest.ts:14

---

sortField

• Optional sortField: string

Defined in

src/api/resources/sheets/client/requests/GetRecordsCsvRequest.ts:10

---

versionId

• Optional versionId: string

Defined in

src/api/resources/sheets/client/requests/GetRecordsCsvRequest.ts:8

@flatfile/api / Exports / Flatfile / sheets / ListSheetsRequest

Interface: ListSheetsRequest

Flatfile.sheets.ListSheetsRequest

Table of contents

Properties

• workbookId

Properties

workbookId

• workbookId: string

ID of workbook

Defined in

src/api/resources/sheets/client/requests/ListSheetsRequest.ts:11

@flatfile/api / Exports / Flatfile / sheets / ListSheetsResponse

Interface: ListSheetsResponse

Flatfile.sheets.ListSheetsResponse

Table of contents

Properties

• data

Properties

data

• data: Sheet[]

Defined in

src/api/resources/sheets/types/ListSheetsResponse.ts:8

@flatfile/api / Exports / Flatfile / sheets / RecordCountsResponse

Interface: RecordCountsResponse

Flatfile.sheets.RecordCountsResponse

Table of contents

Properties

• data

Properties

data

• data: RecordCountsResponseData

Defined in

src/api/resources/sheets/types/RecordCountsResponse.ts:8

@flatfile/api / Exports / Flatfile / sheets / RecordCountsResponseData

Interface: RecordCountsResponseData

Flatfile.sheets.RecordCountsResponseData

Informs whether or not a request was successful

Example

{
 *         data: {
 *             success: true
 *         }
 *     }

Hierarchy

• Success

  ↳ RecordCountsResponseData

Table of contents

Properties

• counts
• data

Properties

counts

• Optional counts: RecordCounts

Defined in

src/api/resources/sheets/types/RecordCountsResponseData.ts:8

---

data

• data: SuccessData

Inherited from

Success.data

Defined in

src/api/resources/commons/types/Success.ts:18

@flatfile/api / Exports / Flatfile / sheets / Sheet

Interface: Sheet

Flatfile.sheets.Sheet

A place to store tabular data

Table of contents

Properties

• config
• countRecords
• id
• name
• workbookId

Properties

config

• Optional config: SheetConfig

Defined in

src/api/resources/sheets/types/Sheet.ts:14

---

countRecords

• Optional countRecords: RecordCounts

Defined in

src/api/resources/sheets/types/Sheet.ts:15

---

id

• id: string

Defined in

src/api/resources/sheets/types/Sheet.ts:11

---

name

• name: string

Defined in

src/api/resources/sheets/types/Sheet.ts:13

---

workbookId

• workbookId: string

Defined in

src/api/resources/sheets/types/Sheet.ts:12

@flatfile/api / Exports / Flatfile / sheets / SheetConfig

Interface: SheetConfig

Flatfile.sheets.SheetConfig

Describes shape of data as well as behavior

Table of contents

Properties

• access
• actions
• description
• fields
• name
• readonly
• slug

Properties

access

• Optional access: SheetAccess[]

Defined in

src/api/resources/sheets/types/SheetConfig.ts:15

---

actions

• Optional actions: Action[]

Defined in

src/api/resources/sheets/types/SheetConfig.ts:17

---

description

• Optional description: string

Defined in

src/api/resources/sheets/types/SheetConfig.ts:12

---

fields

• fields: Property[]

Defined in

src/api/resources/sheets/types/SheetConfig.ts:16

---

name

• name: string

Defined in

src/api/resources/sheets/types/SheetConfig.ts:11

---

readonly

• Optional readonly: boolean

Defined in

src/api/resources/sheets/types/SheetConfig.ts:14

---

slug

• Optional slug: string

Defined in

src/api/resources/sheets/types/SheetConfig.ts:13

@flatfile/api / Exports / Flatfile / sheets / SheetResponse

Interface: SheetResponse

Flatfile.sheets.SheetResponse

Table of contents

Properties

• data

Properties

data

• data: Sheet

Defined in

src/api/resources/sheets/types/SheetResponse.ts:8

@flatfile/api / Exports / Flatfile / spaces / EventToken

Interface: EventToken

Flatfile.spaces.EventToken

Properties used to allow users to connect to the event bus

Table of contents

Properties

• accountId
• subscribeKey
• token
• ttl

Properties

accountId

• Optional accountId: string

Defined in

src/api/resources/spaces/types/EventToken.ts:11

---

subscribeKey

• Optional subscribeKey: string

The id of the event bus to subscribe to

Defined in

src/api/resources/spaces/types/EventToken.ts:13

---

token

• Optional token: string

Defined in

src/api/resources/spaces/types/EventToken.ts:16

---

ttl

• Optional ttl: number

Time to live in minutes

Defined in

src/api/resources/spaces/types/EventToken.ts:15

@flatfile/api / Exports / Flatfile / spaces / EventTokenResponse

Interface: EventTokenResponse

Flatfile.spaces.EventTokenResponse

Table of contents

Properties

• data

Properties

data

• data: EventToken

Defined in

src/api/resources/spaces/types/EventTokenResponse.ts:8

@flatfile/api / Exports / Flatfile / spaces / ListSpacesRequest

Interface: ListSpacesRequest

Flatfile.spaces.ListSpacesRequest

Table of contents

Properties

• archived
• environmentId
• pageNumber
• pageSize
• search
• sortDirection
• sortField

Properties

archived

• Optional archived: boolean

Defined in

src/api/resources/spaces/client/requests/ListSpacesRequest.ts:18

---

environmentId

• Optional environmentId: string

Defined in

src/api/resources/spaces/client/requests/ListSpacesRequest.ts:8

---

pageNumber

• Optional pageNumber: number

Based on pageSize, which page of records to return

Defined in

src/api/resources/spaces/client/requests/ListSpacesRequest.ts:16

---

pageSize

• Optional pageSize: number

Number of spaces to return in a page (default 10)

Defined in

src/api/resources/spaces/client/requests/ListSpacesRequest.ts:12

---

search

• Optional search: string

Defined in

src/api/resources/spaces/client/requests/ListSpacesRequest.ts:17

---

sortDirection

• Optional sortDirection: SortDirection

Defined in

src/api/resources/spaces/client/requests/ListSpacesRequest.ts:20

---

sortField

• Optional sortField: GetSpacesSortField

Defined in

src/api/resources/spaces/client/requests/ListSpacesRequest.ts:19

@flatfile/api / Exports / Flatfile / spaces / ListSpacesResponse

Interface: ListSpacesResponse

Flatfile.spaces.ListSpacesResponse

Table of contents

Properties

• data
• pagination

Properties

data

• data: Space[]

Defined in

src/api/resources/spaces/types/ListSpacesResponse.ts:9

---

pagination

• Optional pagination: Pagination

Defined in

src/api/resources/spaces/types/ListSpacesResponse.ts:8

@flatfile/api / Exports / Flatfile / spaces / Space

Interface: Space

Flatfile.spaces.Space

A place to store your workbooks

Hierarchy

• SpaceConfig

  ↳ Space

Table of contents

Properties

• access
• accessToken
• actions
• archivedAt
• autoConfigure
• createdAt
• createdByUserId
• createdByUserName
• displayOrder
• environmentId
• filesCount
• guestAuthentication
• guestLink
• id
• metadata
• name
• primaryWorkbookId
• spaceConfigId
• updatedAt
• workbookCount

Properties

access

• Optional access: SpaceAccess[]

Inherited from

SpaceConfig.access

Defined in

src/api/resources/spaces/types/SpaceConfig.ts:22

---

accessToken

• Optional accessToken: string

Defined in

src/api/resources/spaces/types/Space.ts:27

---

actions

• Optional actions: Action[]

Inherited from

SpaceConfig.actions

Defined in

src/api/resources/spaces/types/SpaceConfig.ts:20

---

archivedAt

• Optional archivedAt: Date

Date when space was archived

Defined in

src/api/resources/spaces/types/Space.ts:24

---

autoConfigure

• Optional autoConfigure: boolean

Inherited from

SpaceConfig.autoConfigure

Defined in

src/api/resources/spaces/types/SpaceConfig.ts:23

---

createdAt

• createdAt: Date

Date when space was created

Defined in

src/api/resources/spaces/types/Space.ts:20

---

createdByUserId

• Optional createdByUserId: string

Defined in

src/api/resources/spaces/types/Space.ts:16

---

createdByUserName

• Optional createdByUserName: string

User name who created space

Defined in

src/api/resources/spaces/types/Space.ts:18

---

displayOrder

• Optional displayOrder: number

The display order

Inherited from

SpaceConfig.displayOrder

Defined in

src/api/resources/spaces/types/SpaceConfig.ts:17

---

environmentId

• environmentId: string

Inherited from

SpaceConfig.environmentId

Defined in

src/api/resources/spaces/types/SpaceConfig.ts:12

---

filesCount

• Optional filesCount: number

Amount of files in the space

Defined in

src/api/resources/spaces/types/Space.ts:15

---

guestAuthentication

• Optional guestAuthentication: GuestAuthenticationEnum[]

Inherited from

SpaceConfig.guestAuthentication

Defined in

src/api/resources/spaces/types/SpaceConfig.ts:21

---

guestLink

• Optional guestLink: string

Guest link to the space

Defined in

src/api/resources/spaces/types/Space.ts:26

---

id

• id: string

Defined in

src/api/resources/spaces/types/Space.ts:11

---

metadata

• Optional metadata: unknown

Metadata for the space

Inherited from

SpaceConfig.metadata

Defined in

src/api/resources/spaces/types/SpaceConfig.ts:19

---

name

• Optional name: string

The name of the space

Inherited from

SpaceConfig.name

Defined in

src/api/resources/spaces/types/SpaceConfig.ts:15

---

primaryWorkbookId

• Optional primaryWorkbookId: string

Inherited from

SpaceConfig.primaryWorkbookId

Defined in

src/api/resources/spaces/types/SpaceConfig.ts:13

---

spaceConfigId

• Optional spaceConfigId: string

Inherited from

SpaceConfig.spaceConfigId

Defined in

src/api/resources/spaces/types/SpaceConfig.ts:11

---

updatedAt

• updatedAt: Date

Date when space was updated

Defined in

src/api/resources/spaces/types/Space.ts:22

---

workbookCount

• Optional workbookCount: number

Amount of workbooks in the space

Defined in

src/api/resources/spaces/types/Space.ts:13

@flatfile/api / Exports / Flatfile / spaces / SpaceConfig

Interface: SpaceConfig

Flatfile.spaces.SpaceConfig

Properties used to create a new Space

Hierarchy

• SpaceConfig

  ↳ Space

Table of contents

Properties

• access
• actions
• autoConfigure
• displayOrder
• environmentId
• guestAuthentication
• metadata
• name
• primaryWorkbookId
• spaceConfigId

Properties

access

• Optional access: SpaceAccess[]

Defined in

src/api/resources/spaces/types/SpaceConfig.ts:22

---

actions

• Optional actions: Action[]

Defined in

src/api/resources/spaces/types/SpaceConfig.ts:20

---

autoConfigure

• Optional autoConfigure: boolean

Defined in

src/api/resources/spaces/types/SpaceConfig.ts:23

---

displayOrder

• Optional displayOrder: number

The display order

Defined in

src/api/resources/spaces/types/SpaceConfig.ts:17

---

environmentId

• environmentId: string

Defined in

src/api/resources/spaces/types/SpaceConfig.ts:12

---

guestAuthentication

• Optional guestAuthentication: GuestAuthenticationEnum[]

Defined in

src/api/resources/spaces/types/SpaceConfig.ts:21

---

metadata

• Optional metadata: unknown

Metadata for the space

Defined in

src/api/resources/spaces/types/SpaceConfig.ts:19

---

name

• Optional name: string

The name of the space

Defined in

src/api/resources/spaces/types/SpaceConfig.ts:15

---

primaryWorkbookId

• Optional primaryWorkbookId: string

Defined in

src/api/resources/spaces/types/SpaceConfig.ts:13

---

spaceConfigId

• Optional spaceConfigId: string

Defined in

src/api/resources/spaces/types/SpaceConfig.ts:11

@flatfile/api / Exports / Flatfile / spaces / SpaceResponse

Interface: SpaceResponse

Flatfile.spaces.SpaceResponse

Table of contents

Properties

• data

Properties

data

• data: Space

Defined in

src/api/resources/spaces/types/SpaceResponse.ts:8

@flatfile/api / Exports / Flatfile / users / ApiToken

Interface: ApiToken

Flatfile.users.ApiToken

Client id and secret used for authenticating against our APIs

Table of contents

Properties

• clientId
• createdAt
• description
• metadata
• secret

Properties

clientId

• clientId: string

Defined in

src/api/resources/users/types/ApiToken.ts:9

---

createdAt

• createdAt: Date

Defined in

src/api/resources/users/types/ApiToken.ts:12

---

description

• description: string

Defined in

src/api/resources/users/types/ApiToken.ts:10

---

metadata

• metadata: Record<string, unknown>

Defined in

src/api/resources/users/types/ApiToken.ts:11

---

secret

• Optional secret: string

Defined in

src/api/resources/users/types/ApiToken.ts:13

@flatfile/api / Exports / Flatfile / users / CreateApiTokenRequest

Interface: CreateApiTokenRequest

Flatfile.users.CreateApiTokenRequest

This file was auto-generated by Fern from our API Definition.

Table of contents

Properties

• tenantId

Properties

tenantId

• tenantId: string

Defined in

src/api/resources/users/client/requests/CreateApiTokenRequest.ts:6

@flatfile/api / Exports / Flatfile / users / ExchangeTokenData

Interface: ExchangeTokenData

Flatfile.users.ExchangeTokenData

This file was auto-generated by Fern from our API Definition.

Table of contents

Properties

• sentTo
• token
• valid

Properties

sentTo

• Optional sentTo: string

The email address the recovery email was sent to, if the provided token was not valid

Defined in

src/api/resources/users/types/ExchangeTokenData.ts:11

---

token

• Optional token: string

The refreshed token, if the provided token was valid

Defined in

src/api/resources/users/types/ExchangeTokenData.ts:9

---

valid

• valid: boolean

Whether the provided token was valid

Defined in

src/api/resources/users/types/ExchangeTokenData.ts:7

@flatfile/api / Exports / Flatfile / users / ExchangeTokenRequest

Interface: ExchangeTokenRequest

Flatfile.users.ExchangeTokenRequest

This file was auto-generated by Fern from our API Definition.

Table of contents

Properties

• email
• spaceId
• token

Properties

email

• Optional email: string

The invited guest's email, required if no token

Defined in

src/api/resources/users/client/requests/ExchangeTokenRequest.ts:9

---

spaceId

• Optional spaceId: string

The spaceId, required if no token

Defined in

src/api/resources/users/client/requests/ExchangeTokenRequest.ts:11

---

token

• Optional token: string

The token to use for the request

Defined in

src/api/resources/users/client/requests/ExchangeTokenRequest.ts:7

@flatfile/api / Exports / Flatfile / users / ExchangeTokenResponse

Interface: ExchangeTokenResponse

Flatfile.users.ExchangeTokenResponse

Table of contents

Properties

• data

Properties

data

• data: ExchangeTokenData

Defined in

src/api/resources/users/types/ExchangeTokenResponse.ts:8

@flatfile/api / Exports / Flatfile / users / ListApiTokensRequest

Interface: ListApiTokensRequest

Flatfile.users.ListApiTokensRequest

This file was auto-generated by Fern from our API Definition.

Table of contents

Properties

• pageNumber
• pageSize
• tenantId

Properties

pageNumber

• Optional pageNumber: number

Based on pageSize, which page of records to return

Defined in

src/api/resources/users/client/requests/ListApiTokensRequest.ts:14

---

pageSize

• Optional pageSize: number

Number of tokens to return in a page (default 10)

Defined in

src/api/resources/users/client/requests/ListApiTokensRequest.ts:10

---

tenantId

• tenantId: string

Defined in

src/api/resources/users/client/requests/ListApiTokensRequest.ts:6

@flatfile/api / Exports / Flatfile / users / ListApiTokensResponse

Interface: ListApiTokensResponse

Flatfile.users.ListApiTokensResponse

List of api tokens without secrets

Table of contents

Properties

• data
• pagination

Properties

data

• data: ApiToken[]

Defined in

src/api/resources/users/types/ListApiTokensResponse.ts:12

---

pagination

• Optional pagination: Pagination

Defined in

src/api/resources/users/types/ListApiTokensResponse.ts:11

@flatfile/api / Exports / Flatfile / users / ListUsersRequest

Interface: ListUsersRequest

Flatfile.users.ListUsersRequest

This file was auto-generated by Fern from our API Definition.

Table of contents

Properties

• email

Properties

email

• Optional email: string

Email of guest to return

Defined in

src/api/resources/users/client/requests/ListUsersRequest.ts:9

@flatfile/api / Exports / Flatfile / users / ListUsersResponse

Interface: ListUsersResponse

Flatfile.users.ListUsersResponse

Table of contents

Properties

• data

Properties

data

• data: User[]

Defined in

src/api/resources/users/types/ListUsersResponse.ts:8

@flatfile/api / Exports / Flatfile / users / User

Interface: User

Flatfile.users.User

Configurations for the user

Hierarchy

• UserConfig

  ↳ User

Table of contents

Properties

• accountId
• email
• id
• name

Properties

accountId

• accountId: string

Inherited from

UserConfig.accountId

Defined in

src/api/resources/users/types/UserConfig.ts:13

---

email

• email: string

Inherited from

UserConfig.email

Defined in

src/api/resources/users/types/UserConfig.ts:11

---

id

• id: string

Defined in

src/api/resources/users/types/User.ts:11

---

name

• name: string

Inherited from

UserConfig.name

Defined in

src/api/resources/users/types/UserConfig.ts:12

@flatfile/api / Exports / Flatfile / users / UserConfig

Interface: UserConfig

Flatfile.users.UserConfig

Properties used to create a new user

Hierarchy

• UserConfig

  ↳ User

Table of contents

Properties

• accountId
• email
• name

Properties

accountId

• accountId: string

Defined in

src/api/resources/users/types/UserConfig.ts:13

---

email

• email: string

Defined in

src/api/resources/users/types/UserConfig.ts:11

---

name

• name: string

Defined in

src/api/resources/users/types/UserConfig.ts:12

@flatfile/api / Exports / Flatfile / users / UserResponse

Interface: UserResponse

Flatfile.users.UserResponse

Table of contents

Properties

• data

Properties

data

• data: User

Defined in

src/api/resources/users/types/UserResponse.ts:8

@flatfile/api / Exports / Flatfile / versions / VersionResponse

Interface: VersionResponse

Flatfile.versions.VersionResponse

Table of contents

Properties

• versionId

Properties

versionId

• versionId: string

Defined in

src/api/resources/versions/types/VersionResponse.ts:8

@flatfile/api / Exports / Flatfile / versions / VersionsPostRequestBody

Interface: VersionsPostRequestBody

Flatfile.versions.VersionsPostRequestBody

Table of contents

Properties

• parentVersionId
• sheetId

Properties

parentVersionId

• Optional parentVersionId: string

Defined in

src/api/resources/versions/client/requests/VersionsPostRequestBody.ts:9

---

sheetId

• Optional sheetId: string

Defined in

src/api/resources/versions/client/requests/VersionsPostRequestBody.ts:8

@flatfile/api / Exports / Flatfile / workbooks / CreateWorkbookConfig

Interface: CreateWorkbookConfig

Flatfile.workbooks.CreateWorkbookConfig

Properties used to create a new Workbook

Table of contents

Properties

• actions
• environmentId
• labels
• name
• sheets
• spaceId

Properties

actions

• Optional actions: Action[]

Defined in

src/api/resources/workbooks/types/CreateWorkbookConfig.ts:17

---

environmentId

• Optional environmentId: string

Defined in

src/api/resources/workbooks/types/CreateWorkbookConfig.ts:14

---

labels

• Optional labels: string[]

Defined in

src/api/resources/workbooks/types/CreateWorkbookConfig.ts:12

---

name

• name: string

Defined in

src/api/resources/workbooks/types/CreateWorkbookConfig.ts:11

---

sheets

• Optional sheets: SheetConfig[]

Sheets must be <= 50

Defined in

src/api/resources/workbooks/types/CreateWorkbookConfig.ts:16

---

spaceId

• Optional spaceId: string

Defined in

src/api/resources/workbooks/types/CreateWorkbookConfig.ts:13

@flatfile/api / Exports / Flatfile / workbooks / ListWorkbooksRequest

Interface: ListWorkbooksRequest

Flatfile.workbooks.ListWorkbooksRequest

Table of contents

Properties

• includeCounts
• spaceId

Properties

includeCounts

• Optional includeCounts: boolean

Include counts for the workbook

Defined in

src/api/resources/workbooks/client/requests/ListWorkbooksRequest.ts:12

---

spaceId

• Optional spaceId: string

Defined in

src/api/resources/workbooks/client/requests/ListWorkbooksRequest.ts:8

@flatfile/api / Exports / Flatfile / workbooks / ListWorkbooksResponse

Interface: ListWorkbooksResponse

Flatfile.workbooks.ListWorkbooksResponse

Table of contents

Properties

• data

Properties

data

• data: Workbook[]

Defined in

src/api/resources/workbooks/types/ListWorkbooksResponse.ts:8

@flatfile/api / Exports / Flatfile / workbooks / UpdateWorkbookConfig

Interface: UpdateWorkbookConfig

Flatfile.workbooks.UpdateWorkbookConfig

Properties used to create a new Workbook

Table of contents

Properties

• actions
• environmentId
• labels
• name
• sheets
• spaceId

Properties

actions

• Optional actions: Action[]

Defined in

src/api/resources/workbooks/types/UpdateWorkbookConfig.ts:17

---

environmentId

• Optional environmentId: string

Defined in

src/api/resources/workbooks/types/UpdateWorkbookConfig.ts:14

---

labels

• Optional labels: string[]

Defined in

src/api/resources/workbooks/types/UpdateWorkbookConfig.ts:12

---

name

• Optional name: string

Defined in

src/api/resources/workbooks/types/UpdateWorkbookConfig.ts:11

---

sheets

• Optional sheets: SheetConfig[]

Sheets must be <= 50

Defined in

src/api/resources/workbooks/types/UpdateWorkbookConfig.ts:16

---

spaceId

• Optional spaceId: string

Defined in

src/api/resources/workbooks/types/UpdateWorkbookConfig.ts:13

@flatfile/api / Exports / Flatfile / workbooks / Workbook

Interface: Workbook

Flatfile.workbooks.Workbook

A collection of one or more sheets

Table of contents

Properties

• actions
• createdAt
• environmentId
• id
• labels
• name
• sheets
• spaceId
• updatedAt

Properties

actions

• Optional actions: Action[]

Defined in

src/api/resources/workbooks/types/Workbook.ts:17

---

createdAt

• createdAt: Date

Date the workbook was created

Defined in

src/api/resources/workbooks/types/Workbook.ts:21

---

environmentId

• Optional environmentId: string

Defined in

src/api/resources/workbooks/types/Workbook.ts:14

---

id

• id: string

Defined in

src/api/resources/workbooks/types/Workbook.ts:11

---

labels

• Optional labels: string[]

Defined in

src/api/resources/workbooks/types/Workbook.ts:16

---

name

• Optional name: string

Defined in

src/api/resources/workbooks/types/Workbook.ts:12

---

sheets

• Optional sheets: Sheet[]

Defined in

src/api/resources/workbooks/types/Workbook.ts:15

---

spaceId

• spaceId: string

Defined in

src/api/resources/workbooks/types/Workbook.ts:13

---

updatedAt

• updatedAt: Date

Date the workbook was last updated

Defined in

src/api/resources/workbooks/types/Workbook.ts:19

@flatfile/api / Exports / Flatfile / workbooks / WorkbookResponse

Interface: WorkbookResponse

Flatfile.workbooks.WorkbookResponse

Table of contents

Properties

• data

Properties

data

• data: Workbook

Defined in

src/api/resources/workbooks/types/WorkbookResponse.ts:8

@flatfile/api / Exports / FlatfileClient / Options

Interface: Options

FlatfileClient.Options

Table of contents

Properties

• apiUrl
• environment
• token

Properties

apiUrl

• Optional apiUrl: string

Defined in

src/wrapper/FlatfileClient.ts:16

---

environment

• Optional environment: Supplier<string>

Deprecated

use apiUrl instead

Defined in

src/wrapper/FlatfileClient.ts:15

---

token

• Optional token: Supplier<string>

Defined in

src/wrapper/FlatfileClient.ts:17

@flatfile/api / Exports

@flatfile/api

Table of contents

Namespaces

• Flatfile
• FlatfileClient

Classes

• FlatfileClient
• FlatfileError
• FlatfileTimeoutError

Type Aliases

• FlatfileEnvironment

Variables

• FlatfileEnvironment
• default

Type Aliases

FlatfileEnvironment

Ƭ FlatfileEnvironment: typeof Production

Defined in

src/environments.ts:5

src/environments.ts:9

Variables

FlatfileEnvironment

• Const FlatfileEnvironment: Object

This file was auto-generated by Fern from our API Definition.

Type declaration

Name	Type
Production	"https://platform.flatfile.com/api/v1"

Defined in

src/environments.ts:5

src/environments.ts:9

---

default

• default: FlatfileClient

Defined in

src/index.ts:8

Modules

@flatfile/api / Exports / Flatfile / agents

Namespace: agents

Flatfile.agents

Table of contents

Interfaces

• Agent
• AgentConfig
• AgentLog
• AgentResponse
• CreateAgentsRequest
• DeleteAgentRequest
• GetAgentLogsRequest
• GetAgentLogsResponse
• GetAgentRequest
• GetEnvironmentAgentLogsRequest
• ListAgentsRequest
• ListAgentsResponse

Type Aliases

• Compiler

Variables

• Compiler

Type Aliases

Compiler

Ƭ Compiler: "js"

The compiler of the agent

Example

Flatfile.Compiler.Js

Defined in

src/api/resources/agents/types/Compiler.ts:11

src/api/resources/agents/types/Compiler.ts:13

Variables

Compiler

• Compiler: Object

Type declaration

Name	Type
Js	"js"

Defined in

src/api/resources/agents/types/Compiler.ts:11

src/api/resources/agents/types/Compiler.ts:13

@flatfile/api / Exports / Flatfile / auth

Namespace: auth

Flatfile.auth

Table of contents

Interfaces

• ApiKey
• ApiKeyOperation
• ApiKeysResponse
• GetApiKeysRequest

Type Aliases

• ApiKeyType

Variables

• ApiKeyType

Type Aliases

ApiKeyType

Ƭ ApiKeyType: "PUBLISHABLE" | "SECRET"

This file was auto-generated by Fern from our API Definition.

Defined in

src/api/resources/auth/types/ApiKeyType.ts:5

src/api/resources/auth/types/ApiKeyType.ts:7

Variables

ApiKeyType

• ApiKeyType: Object

Type declaration

Name	Type
Publishable	"PUBLISHABLE"
Secret	"SECRET"

Defined in

src/api/resources/auth/types/ApiKeyType.ts:5

src/api/resources/auth/types/ApiKeyType.ts:7

@flatfile/api / Exports / Flatfile / billing

Namespace: billing

Flatfile.billing

Table of contents

Interfaces

• CheckoutSession
• CreateCheckoutSessionResponse
• ProductsResponse
• StripeProduct

@flatfile/api / Exports / Flatfile / cells

Namespace: cells

Flatfile.cells

Table of contents

Interfaces

• CellValueWithCounts
• CellsResponse
• GetFieldValuesRequest

Type Aliases

• CellsResponseData

Type Aliases

CellsResponseData

Ƭ CellsResponseData: Record<string, CellValueWithCounts[]>

Cell values grouped by field key

Defined in

src/api/resources/cells/types/CellsResponseData.ts:10

@flatfile/api / Exports / Flatfile / commons

Namespace: commons

Flatfile.commons

Table of contents

Classes

• BadRequestError
• NotFoundError

Interfaces

• Action
• Error_
• Pagination
• Success
• SuccessData

Type Aliases

• AccountId
• ActionMode
• AgentId
• DocumentId
• EnvironmentId
• EventId
• FileId
• Filter
• FilterField
• GuestId
• JobId
• RecordId
• SearchField
• SearchValue
• SheetId
• SortDirection
• SortField
• SpaceConfigId
• SpaceId
• UserId
• VersionId
• WorkbookId

Variables

• ActionMode
• Filter
• SortDirection

Type Aliases

AccountId

Ƭ AccountId: string

Account ID

Example

"us_acc_uj6s91wc"

Defined in

src/api/resources/commons/types/AccountId.ts:11

---

ActionMode

Ƭ ActionMode: "foreground" | "background"

This file was auto-generated by Fern from our API Definition.

Defined in

src/api/resources/commons/types/ActionMode.ts:5

src/api/resources/commons/types/ActionMode.ts:7

---

AgentId

Ƭ AgentId: string

Agent ID

Example

"us_ag_qGZbKwDW"

Defined in

src/api/resources/commons/types/AgentId.ts:11

---

DocumentId

Ƭ DocumentId: string

Document ID

Example

"us_dc_KwDW6cfH"

Defined in

src/api/resources/commons/types/DocumentId.ts:11

---

EnvironmentId

Ƭ EnvironmentId: string

Environment ID

Example

"us_env_hVXkXs0b"

Defined in

src/api/resources/commons/types/EnvironmentId.ts:11

---

EventId

Ƭ EventId: string

Event ID

Example

"us_evt_9cuesESa7W9cuesE"

Defined in

src/api/resources/commons/types/EventId.ts:11

---

FileId

Ƭ FileId: string

File ID

Example

"us_fl_qGZbKwDW"

Defined in

src/api/resources/commons/types/FileId.ts:11

---

Filter

Ƭ Filter: "valid" | "error" | "all" | "none"

Options to filter records

Defined in

src/api/resources/commons/types/Filter.ts:8

src/api/resources/commons/types/Filter.ts:10

---

FilterField

Ƭ FilterField: string

Use this to narrow the valid/error filter results to a specific field

Defined in

src/api/resources/commons/types/FilterField.ts:8

---

GuestId

Ƭ GuestId: string

Guest ID

Example

"us_g_5ue7P9cU"

Defined in

src/api/resources/commons/types/GuestId.ts:11

---

JobId

Ƭ JobId: string

Pipeline Job ID

Example

"us_jb_UQg89Drd"

Defined in

src/api/resources/commons/types/JobId.ts:11

---

RecordId

Ƭ RecordId: string

Record ID

Example

"us_rc_a7W9cuesESa7W9cu"

Defined in

src/api/resources/commons/types/RecordId.ts:11

---

SearchField

Ƭ SearchField: string

Use this to narrow the searchValue results to a specific field

Defined in

src/api/resources/commons/types/SearchField.ts:8

---

SearchValue

Ƭ SearchValue: string

Search the entire sheet for the given value, returning matching rows

Defined in

src/api/resources/commons/types/SearchValue.ts:8

---

SheetId

Ƭ SheetId: string

Sheet ID

Example

"us_sh_fHfzjzHb"

Defined in

src/api/resources/commons/types/SheetId.ts:11

---

SortDirection

Ƭ SortDirection: "asc" | "desc"

Sort direction - asc (ascending) or desc (descending)

Example

Flatfile.SortDirection.Asc

Defined in

src/api/resources/commons/types/SortDirection.ts:11

src/api/resources/commons/types/SortDirection.ts:13

---

SortField

Ƭ SortField: string

Name of field by which to sort records

Defined in

src/api/resources/commons/types/SortField.ts:8

---

SpaceConfigId

Ƭ SpaceConfigId: string

Space Config ID

Example

"us_sc_uj691wck"

Defined in

src/api/resources/commons/types/SpaceConfigId.ts:11

---

SpaceId

Ƭ SpaceId: string

Space ID

Example

"us_sp_DrdXetPN"

Defined in

src/api/resources/commons/types/SpaceId.ts:11

---

UserId

Ƭ UserId: string

User ID

Example

"us_usr_a7Ws9cue"

Defined in

src/api/resources/commons/types/UserId.ts:11

---

VersionId

Ƭ VersionId: string

Version ID

Example

"us_vr_jte4tzVn"

Defined in

src/api/resources/commons/types/VersionId.ts:11

---

WorkbookId

Ƭ WorkbookId: string

Workbook ID

Example

"us_wb_qGZbKwDW"

Defined in

src/api/resources/commons/types/WorkbookId.ts:11

Variables

ActionMode

• ActionMode: Object

Type declaration

Name	Type
Background	"background"
Foreground	"foreground"

Defined in

src/api/resources/commons/types/ActionMode.ts:5

src/api/resources/commons/types/ActionMode.ts:7

---

Filter

• Filter: Object

Type declaration

Name	Type
All	"all"
Error	"error"
None	"none"
Valid	"valid"

Defined in

src/api/resources/commons/types/Filter.ts:8

src/api/resources/commons/types/Filter.ts:10

---

SortDirection

• SortDirection: Object

Type declaration

Name	Type
Asc	"asc"
Desc	"desc"

Defined in

src/api/resources/commons/types/SortDirection.ts:11

src/api/resources/commons/types/SortDirection.ts:13

@flatfile/api / Exports / Flatfile / documents

Namespace: documents

Flatfile.documents

Table of contents

Interfaces

• Document
• DocumentConfig
• DocumentResponse
• ListDocumentsResponse

@flatfile/api / Exports / Flatfile / environments

Namespace: environments

Flatfile.environments

Table of contents

Interfaces

• Environment
• EnvironmentConfig
• EnvironmentResponse
• ListEnvironmentsRequest
• ListEnvironmentsResponse

Type Aliases

• GuestAuthenticationEnum

Variables

• GuestAuthenticationEnum

Type Aliases

GuestAuthenticationEnum

Ƭ GuestAuthenticationEnum: "shared_link" | "magic_link"

The type of authentication to use for guests

Defined in

src/api/resources/environments/types/GuestAuthenticationEnum.ts:8

src/api/resources/environments/types/GuestAuthenticationEnum.ts:10

Variables

GuestAuthenticationEnum

• GuestAuthenticationEnum: Object

Type declaration

Name	Type
MagicLink	"magic_link"
SharedLink	"shared_link"

Defined in

src/api/resources/environments/types/GuestAuthenticationEnum.ts:8

src/api/resources/environments/types/GuestAuthenticationEnum.ts:10

@flatfile/api / Exports / Flatfile / events / Event

Namespace: Event

Flatfile.events.Event

Table of contents

Interfaces

• 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

Namespace: events

Flatfile.events

Table of contents

Namespaces

• Event

Interfaces

• 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

Type Aliases

• ActionName
• Domain
• Event
• EventTopic
• JobOperationType
• JobPayloadType
• SheetSlug

Variables

• Domain
• EventTopic
• JobOperationType
• JobPayloadType

Type Aliases

ActionName

Ƭ ActionName: string

Name of an action

Defined in

src/api/resources/events/types/ActionName.ts:8

---

Domain

Ƭ Domain: "file" | "space" | "workbook" | "job"

The domain of the event

Example

Flatfile.Domain.Job

Defined in

src/api/resources/events/types/Domain.ts:11

src/api/resources/events/types/Domain.ts:13

---

Event

Ƭ 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

Defined in

src/api/resources/events/types/Event.ts:10

src/api/resources/events/types/Event.ts:37

---

EventTopic

Ƭ 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

Defined in

src/api/resources/events/types/EventTopic.ts:11

src/api/resources/events/types/EventTopic.ts:42

---

JobOperationType

Ƭ JobOperationType: "EXTRACT" | "MAP"

This file was auto-generated by Fern from our API Definition.

Defined in

src/api/resources/events/types/JobOperationType.ts:5

src/api/resources/events/types/JobOperationType.ts:7

---

JobPayloadType

Ƭ JobPayloadType: "FILE" | "PIPELINE"

This file was auto-generated by Fern from our API Definition.

Defined in

src/api/resources/events/types/JobPayloadType.ts:5

src/api/resources/events/types/JobPayloadType.ts:7

---

SheetSlug

Ƭ SheetSlug: string

Sheet Slug

Defined in

src/api/resources/events/types/SheetSlug.ts:8

Variables

Domain

• Domain: Object

Type declaration

Name	Type
File	"file"
Job	"job"
Space	"space"
Workbook	"workbook"

Defined in

src/api/resources/events/types/Domain.ts:11

src/api/resources/events/types/Domain.ts:13

---

EventTopic

• EventTopic: Object

Type declaration

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"

Defined in

src/api/resources/events/types/EventTopic.ts:11

src/api/resources/events/types/EventTopic.ts:42

---

JobOperationType

• JobOperationType: Object

Type declaration

Name	Type
Extract	"EXTRACT"
Map	"MAP"

Defined in

src/api/resources/events/types/JobOperationType.ts:5

src/api/resources/events/types/JobOperationType.ts:7

---

JobPayloadType

• JobPayloadType: Object

Type declaration

Name	Type
File	"FILE"
Pipeline	"PIPELINE"

Defined in

src/api/resources/events/types/JobPayloadType.ts:5

src/api/resources/events/types/JobPayloadType.ts:7

@flatfile/api / Exports / Flatfile / files

Namespace: files

Flatfile.files

Table of contents

Interfaces

• CreateFileRequest
• FileResponse
• File_
• ListFilesRequest
• ListFilesResponse
• UpdateFileRequest

Type Aliases

• Mode
• ModelFileStatusEnum

Variables

• Mode
• ModelFileStatusEnum

Type Aliases

Mode

Ƭ Mode: "import" | "export"

This file was auto-generated by Fern from our API Definition.

Defined in

src/api/resources/files/types/Mode.ts:5

src/api/resources/files/types/Mode.ts:7

---

ModelFileStatusEnum

Ƭ ModelFileStatusEnum: "partial" | "complete" | "archived" | "purged" | "failed"

This file was auto-generated by Fern from our API Definition.

Defined in

src/api/resources/files/types/ModelFileStatusEnum.ts:5

src/api/resources/files/types/ModelFileStatusEnum.ts:7

Variables

Mode

• Mode: Object

Type declaration

Name	Type
Export	"export"
Import	"import"

Defined in

src/api/resources/files/types/Mode.ts:5

src/api/resources/files/types/Mode.ts:7

---

ModelFileStatusEnum

• ModelFileStatusEnum: Object

Type declaration

Name	Type
Archived	"archived"
Complete	"complete"
Failed	"failed"
Partial	"partial"
Purged	"purged"

Defined in

src/api/resources/files/types/ModelFileStatusEnum.ts:5

src/api/resources/files/types/ModelFileStatusEnum.ts:7

@flatfile/api / Exports / Flatfile / guests

Namespace: guests

Flatfile.guests

Table of contents

Interfaces

• CreateGuestResponse
• Guest
• GuestConfig
• GuestSpace
• GuestWorkbook
• Invite
• ListGuestsRequest
• ListGuestsResponse

@flatfile/api / Exports / Flatfile / jobs

Namespace: jobs

Flatfile.jobs

Table of contents

Interfaces

• 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

Type Aliases

• Certainty
• Driver
• JobDestination
• JobMode
• JobSource
• JobStatus
• JobType
• JobUpdateConfig
• Trigger

Variables

• Certainty
• Driver
• JobMode
• JobStatus
• JobType
• Trigger

Type Aliases

Certainty

Ƭ Certainty: "absolute" | "strong" | "moderate" | "weak"

This file was auto-generated by Fern from our API Definition.

Defined in

src/api/resources/jobs/types/Certainty.ts:5

src/api/resources/jobs/types/Certainty.ts:7

---

Driver

Ƭ Driver: "csv"

The driver to use for extracting data from the file

Defined in

src/api/resources/jobs/types/Driver.ts:8

src/api/resources/jobs/types/Driver.ts:10

---

JobDestination

Ƭ JobDestination: WorkbookId

The id of the workbook where extracted file data will be sent

Defined in

src/api/resources/jobs/types/JobDestination.ts:10

---

JobMode

Ƭ JobMode: "foreground" | "background"

the mode of the job

Defined in

src/api/resources/jobs/types/JobMode.ts:8

src/api/resources/jobs/types/JobMode.ts:10

---

JobSource

Ƭ JobSource: string

The id of a file, workbook, or sheet

Defined in

src/api/resources/jobs/types/JobSource.ts:8

---

JobStatus

Ƭ JobStatus: "planning" | "ready" | "executing" | "complete" | "failed"

the status of the job

Defined in

src/api/resources/jobs/types/JobStatus.ts:8

src/api/resources/jobs/types/JobStatus.ts:10

---

JobType

Ƭ JobType: "file" | "workbook" | "sheet"

The type of job

Defined in

src/api/resources/jobs/types/JobType.ts:8

src/api/resources/jobs/types/JobType.ts:10

---

JobUpdateConfig

Ƭ JobUpdateConfig: DeleteJobConfig | FileJobConfig | PipelineJobConfig | ExportJobConfig | MutateJobConfig | AiAssistJobConfig | FindAndReplaceJobConfig | EmptyObject

Defined in

src/api/resources/jobs/types/JobUpdateConfig.ts:7

---

Trigger

Ƭ Trigger: "manual" | "immediate"

the type of trigger to use for this job

Defined in

src/api/resources/jobs/types/Trigger.ts:8

src/api/resources/jobs/types/Trigger.ts:10

Variables

Certainty

• Certainty: Object

Type declaration

Name	Type
Absolute	"absolute"
Moderate	"moderate"
Strong	"strong"
Weak	"weak"

Defined in

src/api/resources/jobs/types/Certainty.ts:5

src/api/resources/jobs/types/Certainty.ts:7

---

Driver

• Driver: Object

Type declaration

Name	Type
Csv	"csv"

Defined in

src/api/resources/jobs/types/Driver.ts:8

src/api/resources/jobs/types/Driver.ts:10

---

JobMode

• JobMode: Object

Type declaration

Name	Type
Background	"background"
Foreground	"foreground"

Defined in

src/api/resources/jobs/types/JobMode.ts:8

src/api/resources/jobs/types/JobMode.ts:10

---

JobStatus

• JobStatus: Object

Type declaration

Name	Type
Complete	"complete"
Executing	"executing"
Failed	"failed"
Planning	"planning"
Ready	"ready"

Defined in

src/api/resources/jobs/types/JobStatus.ts:8

src/api/resources/jobs/types/JobStatus.ts:10

---

JobType

• JobType: Object

Type declaration

Name	Type
File	"file"
Sheet	"sheet"
Workbook	"workbook"

Defined in

src/api/resources/jobs/types/JobType.ts:8

src/api/resources/jobs/types/JobType.ts:10

---

Trigger

• Trigger: Object

Type declaration

Name	Type
Immediate	"immediate"
Manual	"manual"

Defined in

src/api/resources/jobs/types/Trigger.ts:8

src/api/resources/jobs/types/Trigger.ts:10

@flatfile/api / Exports / Flatfile

Namespace: Flatfile

Table of contents

References

• 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

Namespaces

• agents
• auth
• billing
• cells
• commons
• documents
• environments
• events
• files
• guests
• jobs
• property
• records
• sheets
• spaces
• users
• versions
• workbooks

References

AccountId

Re-exports AccountId

---

Action

Re-exports Action

---

ActionMode

Re-exports ActionMode

---

ActionName

Re-exports ActionName

---

ActionTriggeredEvent

Re-exports ActionTriggeredEvent

---

Agent

Re-exports Agent

---

AgentConfig

Re-exports AgentConfig

---

AgentId

Re-exports AgentId

---

AgentLog

Re-exports AgentLog

---

AgentResponse

Re-exports AgentResponse

---

AiAssistJobConfig

Re-exports AiAssistJobConfig

---

ApiKey

Re-exports ApiKey

---

ApiKeyOperation

Re-exports ApiKeyOperation

---

ApiKeyType

Re-exports ApiKeyType

---

ApiKeysResponse

Re-exports ApiKeysResponse

---

ApiToken

Re-exports ApiToken

---

ArrayableProperty

Re-exports ArrayableProperty

---

BadRequestError

Re-exports BadRequestError

---

BaseEvent

Re-exports BaseEvent

---

BaseProperty

Re-exports BaseProperty

---

BooleanProperty

Re-exports BooleanProperty

---

BooleanPropertyConfig

Re-exports BooleanPropertyConfig

---

CategoryMapping

Re-exports CategoryMapping

---

CellValue

Re-exports CellValue

---

CellValueUnion

Re-exports CellValueUnion

---

CellValueWithCounts

Re-exports CellValueWithCounts

---

CellValueWithLinks

Re-exports CellValueWithLinks

---

CellsResponse

Re-exports CellsResponse

---

CellsResponseData

Re-exports CellsResponseData

---

Certainty

Re-exports Certainty

---

CheckoutSession

Re-exports CheckoutSession

---

ClientInitializedEvent

Re-exports ClientInitializedEvent

---

Compiler

Re-exports Compiler

---

Constraint

Re-exports Constraint

---

Context

Re-exports Context

---

CreateAgentsRequest

Re-exports CreateAgentsRequest

---

CreateApiTokenRequest

Re-exports CreateApiTokenRequest

---

CreateCheckoutSessionResponse

Re-exports CreateCheckoutSessionResponse

---

CreateFileRequest

Re-exports CreateFileRequest

---

CreateGuestResponse

Re-exports CreateGuestResponse

---

CreateWorkbookConfig

Re-exports CreateWorkbookConfig

---

DateProperty

Re-exports DateProperty

---

DeleteAgentRequest

Re-exports DeleteAgentRequest

---

DeleteJobConfig

Re-exports DeleteJobConfig

---

DeleteRecordsRequest

Re-exports DeleteRecordsRequest

---

DestinationField

Re-exports DestinationField

---

Document

Re-exports Document

---

DocumentConfig

Re-exports DocumentConfig

---

DocumentId

Re-exports DocumentId

---

DocumentResponse

Re-exports DocumentResponse

---

Domain

Re-exports Domain

---

Driver

Re-exports Driver

---

Edge

Re-exports Edge

---

EmptyObject

Re-exports EmptyObject

---

EnumDetails

Re-exports EnumDetails

---

EnumProperty

Re-exports EnumProperty

---

EnumPropertyConfig

Re-exports EnumPropertyConfig

---

EnumPropertyOption

Re-exports EnumPropertyOption

---

Environment

Re-exports Environment

---

EnvironmentConfig

Re-exports EnvironmentConfig

---

EnvironmentId

Re-exports EnvironmentId

---

EnvironmentResponse

Re-exports EnvironmentResponse

---

Error_

Re-exports Error_

---

Event

Re-exports Event

---

EventAttributes

Re-exports EventAttributes

---

EventId

Re-exports EventId

---

EventResponse

Re-exports EventResponse

---

EventTopic

Re-exports EventTopic

---

ExchangeTokenData

Re-exports ExchangeTokenData

---

ExchangeTokenRequest

Re-exports ExchangeTokenRequest

---

ExchangeTokenResponse

Re-exports ExchangeTokenResponse

---

ExportJobConfig

Re-exports ExportJobConfig

---

ExportOptions

Re-exports ExportOptions

---

FileDeletedEvent

Re-exports FileDeletedEvent

---

FileId

Re-exports FileId

---

FileJobConfig

Re-exports FileJobConfig

---

FileResponse

Re-exports FileResponse

---

File_

Re-exports File_

---

Filter

Re-exports Filter

---

FilterField

Re-exports FilterField

---

FindAndReplaceJobConfig

Re-exports FindAndReplaceJobConfig

---

FindAndReplaceRecordRequest

Re-exports FindAndReplaceRecordRequest

---

FindAndReplaceRecordRequestDeprecated

Re-exports FindAndReplaceRecordRequestDeprecated

---

FindRecordsRequest

Re-exports FindRecordsRequest

---

GetAgentLogsRequest

Re-exports GetAgentLogsRequest

---

GetAgentLogsResponse

Re-exports GetAgentLogsResponse

---

GetAgentRequest

Re-exports GetAgentRequest

---

GetApiKeysRequest

Re-exports GetApiKeysRequest

---

GetEnvironmentAgentLogsRequest

Re-exports GetEnvironmentAgentLogsRequest

---

GetEventTokenRequest

Re-exports GetEventTokenRequest

---

GetFieldValuesRequest

Re-exports GetFieldValuesRequest

---

GetRecordCountsRequest

Re-exports GetRecordCountsRequest

---

GetRecordsCsvRequest

Re-exports GetRecordsCsvRequest

---

GetRecordsRequest

Re-exports GetRecordsRequest

---

Guest

Re-exports Guest

---

GuestAuthenticationEnum

Re-exports GuestAuthenticationEnum

---

GuestConfig

Re-exports GuestConfig

---

GuestId

Re-exports GuestId

---

GuestSpace

Re-exports GuestSpace

---

GuestWorkbook

Re-exports GuestWorkbook

---

Invite

Re-exports Invite

---

Job

Re-exports Job

---

JobAckDetails

Re-exports JobAckDetails

---

JobCompletedEvent

Re-exports JobCompletedEvent

---

JobConfig

Re-exports JobConfig

---

JobDeletedEvent

Re-exports JobDeletedEvent

---

JobDestination

Re-exports JobDestination

---

JobExecutionPlan

Re-exports JobExecutionPlan

---

JobExecutionPlanConfig

Re-exports JobExecutionPlanConfig

---

JobFailedEvent

Re-exports JobFailedEvent

---

JobFailedPayload

Re-exports JobFailedPayload

---

JobId

Re-exports JobId

---

JobMode

Re-exports JobMode

---

JobOperationType

Re-exports JobOperationType

---

JobOutcome

Re-exports JobOutcome

---

JobPayload

Re-exports JobPayload

---

JobPayloadType

Re-exports JobPayloadType

---

JobPlan

Re-exports JobPlan

---

JobResponse

Re-exports JobResponse

---

JobSource

Re-exports JobSource

---

JobStartedEvent

Re-exports JobStartedEvent

---

JobStatus

Re-exports JobStatus

---

JobType

Re-exports JobType

---

JobUpdate

Re-exports JobUpdate

---

JobUpdateConfig

Re-exports JobUpdateConfig

---

JobUpdatedEvent

Re-exports JobUpdatedEvent

---

JobWaitingEvent

Re-exports JobWaitingEvent

---

ListAgentsRequest

Re-exports ListAgentsRequest

---

ListAgentsResponse

Re-exports ListAgentsResponse

---

ListAllEventsResponse

Re-exports ListAllEventsResponse

---

ListApiTokensRequest

Re-exports ListApiTokensRequest

---

ListApiTokensResponse

Re-exports ListApiTokensResponse

---

ListDocumentsResponse

Re-exports ListDocumentsResponse

---

ListEnvironmentsRequest

Re-exports ListEnvironmentsRequest

---

ListEnvironmentsResponse

Re-exports ListEnvironmentsResponse

---

ListEventsRequest

Re-exports ListEventsRequest

---

ListFilesRequest

Re-exports ListFilesRequest

---

ListFilesResponse

Re-exports ListFilesResponse

---

ListGuestsRequest

Re-exports ListGuestsRequest

---

ListGuestsResponse

Re-exports ListGuestsResponse

---

ListJobsRequest

Re-exports ListJobsRequest

---

ListJobsResponse

Re-exports ListJobsResponse

---

ListSheetsRequest

Re-exports ListSheetsRequest

---

ListSheetsResponse

Re-exports ListSheetsResponse

---

ListUsersRequest

Re-exports ListUsersRequest

---

ListUsersResponse

Re-exports ListUsersResponse

---

ListWorkbooksRequest

Re-exports ListWorkbooksRequest

---

ListWorkbooksResponse

Re-exports ListWorkbooksResponse

---

Metadata

Re-exports Metadata

---

Mode

Re-exports Mode

---

ModelFileStatusEnum

Re-exports ModelFileStatusEnum

---

MutateJobConfig

Re-exports MutateJobConfig

---

NotFoundError

Re-exports NotFoundError

---

NumberConfig

Re-exports NumberConfig

---

NumberProperty

Re-exports NumberProperty

---

Origin

Re-exports Origin

---

Pagination

Re-exports Pagination

---

PipelineJobConfig

Re-exports PipelineJobConfig

---

ProductsResponse

Re-exports ProductsResponse

---

Progress

Re-exports Progress

---

Property

Re-exports Property

---

RecordCounts

Re-exports RecordCounts

---

RecordCountsResponse

Re-exports RecordCountsResponse

---

RecordCountsResponseData

Re-exports RecordCountsResponseData

---

RecordData

Re-exports RecordData

---

RecordDataWithLinks

Re-exports RecordDataWithLinks

---

RecordId

Re-exports RecordId

---

RecordWithLinks

Re-exports RecordWithLinks

---

Record_

Re-exports Record_

---

Records

Re-exports Records

---

RecordsCreatedEvent

Re-exports RecordsCreatedEvent

---

RecordsDeletedEvent

Re-exports RecordsDeletedEvent

---

RecordsPayload

Re-exports RecordsPayload

---

RecordsResponse

Re-exports RecordsResponse

---

RecordsResponseData

Re-exports RecordsResponseData

---

RecordsUpdatedEvent

Re-exports RecordsUpdatedEvent

---

RecordsWithLinks

Re-exports RecordsWithLinks

---

ReferenceProperty

Re-exports ReferenceProperty

---

ReferencePropertyConfig

Re-exports ReferencePropertyConfig

---

ReferencePropertyRelationship

Re-exports ReferencePropertyRelationship

---

SearchField

Re-exports SearchField

---

SearchValue

Re-exports SearchValue

---

Sheet

Re-exports Sheet

---

SheetAccess

Re-exports SheetAccess

---

SheetConfig

Re-exports SheetConfig

---

SheetId

Re-exports SheetId

---

SheetResponse

Re-exports SheetResponse

---

SheetSlug

Re-exports SheetSlug

---

SheetValidatedEvent

Re-exports SheetValidatedEvent

---

SortDirection

Re-exports SortDirection

---

SortField

Re-exports SortField

---

SourceField

Re-exports SourceField

---

SpaceAddedEvent

Re-exports SpaceAddedEvent

---

SpaceConfigId

Re-exports SpaceConfigId

---

SpaceId

Re-exports SpaceId

---

SpaceRemovedEvent

Re-exports SpaceRemovedEvent

---

StringConfig

Re-exports StringConfig

---

StringConfigOptions

Re-exports StringConfigOptions

---

StringProperty

Re-exports StringProperty

---

StripeProduct

Re-exports StripeProduct

---

Success

Re-exports Success

---

SuccessData

Re-exports SuccessData

---

Trigger

Re-exports Trigger

---

UniqueConstraint

Re-exports UniqueConstraint

---

UniqueConstraintConfig

Re-exports UniqueConstraintConfig

---

UpdateFileRequest

Re-exports UpdateFileRequest

---

UpdateWorkbookConfig

Re-exports UpdateWorkbookConfig

---

UploadCompletedEvent

Re-exports UploadCompletedEvent

---

UploadFailedEvent

Re-exports UploadFailedEvent

---

UploadStartedEvent

Re-exports UploadStartedEvent

---

User

Re-exports User

---

UserAddedEvent

Re-exports UserAddedEvent

---

UserConfig

Re-exports UserConfig

---

UserId

Re-exports UserId

---

UserOfflineEvent

Re-exports UserOfflineEvent

---

UserOnlineEvent

Re-exports UserOnlineEvent

---

UserRemovedEvent

Re-exports UserRemovedEvent

---

UserResponse

Re-exports UserResponse

---

ValidationMessage

Re-exports ValidationMessage

---

ValidationSource

Re-exports ValidationSource

---

ValidationType

Re-exports ValidationType

---

VersionId

Re-exports VersionId

---

VersionResponse

Re-exports VersionResponse

---

VersionsPostRequestBody

Re-exports VersionsPostRequestBody

---

Workbook

Re-exports Workbook

---

WorkbookAddedEvent

Re-exports WorkbookAddedEvent

---

WorkbookId

Re-exports WorkbookId

---

WorkbookRemovedEvent

Re-exports WorkbookRemovedEvent

---

WorkbookResponse

Re-exports WorkbookResponse

---

WorkbookUpdatedEvent

Re-exports WorkbookUpdatedEvent

@flatfile/api / Exports / Flatfile / property / Constraint

Namespace: Constraint

Flatfile.property.Constraint

Table of contents

Interfaces

• Computed
• Required
• Unique

@flatfile/api / Exports / Flatfile / property / Property

Namespace: Property

Flatfile.property.Property

Table of contents

Interfaces

• Boolean
• Date_
• Enum
• Number
• Reference
• String

@flatfile/api / Exports / Flatfile / property

Namespace: property

Flatfile.property

Table of contents

Namespaces

• Constraint
• Property

Interfaces

• ArrayableProperty
• BaseProperty
• BooleanProperty
• BooleanPropertyConfig
• DateProperty
• EnumProperty
• EnumPropertyConfig
• EnumPropertyOption
• NumberConfig
• NumberProperty
• ReferenceProperty
• ReferencePropertyConfig
• StringConfig
• StringProperty
• UniqueConstraint
• UniqueConstraintConfig

Type Aliases

• Constraint
• Property
• ReferencePropertyRelationship
• StringConfigOptions

Variables

• ReferencePropertyRelationship
• StringConfigOptions

Type Aliases

Constraint

Ƭ Constraint: Required | Unique | Computed

Defined in

src/api/resources/property/types/Constraint.ts:7

src/api/resources/property/types/Constraint.ts:9

---

Property

Ƭ 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"
 *         }
 *     }

Defined in

src/api/resources/property/types/Property.ts:86

src/api/resources/property/types/Property.ts:94

---

ReferencePropertyRelationship

Ƭ ReferencePropertyRelationship: "has-one" | "has-many"

This file was auto-generated by Fern from our API Definition.

Defined in

src/api/resources/property/types/ReferencePropertyRelationship.ts:5

src/api/resources/property/types/ReferencePropertyRelationship.ts:7

---

StringConfigOptions

Ƭ StringConfigOptions: "tiny" | "normal" | "medium" | "long"

How much text should be storeable in this field

Defined in

src/api/resources/property/types/StringConfigOptions.ts:8

src/api/resources/property/types/StringConfigOptions.ts:22

Variables

ReferencePropertyRelationship

• ReferencePropertyRelationship: Object

Type declaration

Name	Type
HasMany	"has-many"
HasOne	"has-one"

Defined in

src/api/resources/property/types/ReferencePropertyRelationship.ts:5

src/api/resources/property/types/ReferencePropertyRelationship.ts:7

---

StringConfigOptions

• StringConfigOptions: Object

Type declaration

Name	Type
Long	"long"
Medium	"medium"
Normal	"normal"
Tiny	"tiny"

Defined in

src/api/resources/property/types/StringConfigOptions.ts:8

src/api/resources/property/types/StringConfigOptions.ts:22

@flatfile/api / Exports / Flatfile / records

Namespace: records

Flatfile.records

Table of contents

Interfaces

• CellValue
• CellValueWithLinks
• DeleteRecordsRequest
• FindAndReplaceRecordRequest
• FindAndReplaceRecordRequestDeprecated
• FindRecordsRequest
• GetRecordsRequest
• RecordCounts
• RecordWithLinks
• Record_
• RecordsResponse
• RecordsResponseData
• ValidationMessage

Type Aliases

• CellValueUnion
• RecordData
• RecordDataWithLinks
• Records
• RecordsWithLinks
• ValidationSource
• ValidationType

Variables

• ValidationSource
• ValidationType

Type Aliases

CellValueUnion

Ƭ CellValueUnion: string | number | boolean

This file was auto-generated by Fern from our API Definition.

Defined in

src/api/resources/records/types/CellValueUnion.ts:5

---

RecordData

Ƭ RecordData: Record<string, CellValue>

A single row of data in a Sheet

Defined in

src/api/resources/records/types/RecordData.ts:10

---

RecordDataWithLinks

Ƭ RecordDataWithLinks: Record<string, CellValueWithLinks>

A single row of data in a Sheet, including links to related rows

Defined in

src/api/resources/records/types/RecordDataWithLinks.ts:10

---

Records

Ƭ Records: Record_[]

List of Record objects

Defined in

src/api/resources/records/types/Records.ts:10

---

RecordsWithLinks

Ƭ RecordsWithLinks: RecordWithLinks[]

List of Record objects, including links to related rows

Defined in

src/api/resources/records/types/RecordsWithLinks.ts:10

---

ValidationSource

Ƭ ValidationSource: "required-constraint" | "unique-constraint" | "custom-logic" | "unlinked" | "invalid-option"

This file was auto-generated by Fern from our API Definition.

Defined in

src/api/resources/records/types/ValidationSource.ts:5

src/api/resources/records/types/ValidationSource.ts:12

---

ValidationType

Ƭ ValidationType: "error" | "warn" | "info"

This file was auto-generated by Fern from our API Definition.

Defined in

src/api/resources/records/types/ValidationType.ts:5

src/api/resources/records/types/ValidationType.ts:7

Variables

ValidationSource

• ValidationSource: Object

Type declaration

Name	Type
CustomLogic	"custom-logic"
InvalidOption	"invalid-option"
RequiredConstraint	"required-constraint"
UniqueConstraint	"unique-constraint"
Unlinked	"unlinked"

Defined in

src/api/resources/records/types/ValidationSource.ts:5

src/api/resources/records/types/ValidationSource.ts:12

---

ValidationType

• ValidationType: Object

Type declaration

Name	Type
Error	"error"
Info	"info"
Warn	"warn"

Defined in

src/api/resources/records/types/ValidationType.ts:5

src/api/resources/records/types/ValidationType.ts:7

@flatfile/api / Exports / Flatfile / sheets

Namespace: sheets

Flatfile.sheets

Table of contents

Interfaces

• GetRecordCountsRequest
• GetRecordsCsvRequest
• ListSheetsRequest
• ListSheetsResponse
• RecordCountsResponse
• RecordCountsResponseData
• Sheet
• SheetConfig
• SheetResponse

Type Aliases

• SheetAccess

Variables

• SheetAccess

Type Aliases

SheetAccess

Ƭ SheetAccess: "*" | "add" | "edit" | "delete" | "import"

This file was auto-generated by Fern from our API Definition.

Defined in

src/api/resources/sheets/types/SheetAccess.ts:5

src/api/resources/sheets/types/SheetAccess.ts:7

Variables

SheetAccess

• SheetAccess: Object

Type declaration

Name	Type
Add	"add"
All	"*"
Delete	"delete"
Edit	"edit"
Import	"import"

Defined in

src/api/resources/sheets/types/SheetAccess.ts:5

src/api/resources/sheets/types/SheetAccess.ts:7

@flatfile/api / Exports / Flatfile / spaces

Namespace: spaces

Flatfile.spaces

Table of contents

Interfaces

• EventToken
• EventTokenResponse
• ListSpacesRequest
• ListSpacesResponse
• Space
• SpaceConfig
• SpaceResponse

Type Aliases

• GetSpacesSortField
• SpaceAccess

Variables

• GetSpacesSortField
• SpaceAccess

Type Aliases

GetSpacesSortField

Ƭ GetSpacesSortField: "name" | "workbooksCount" | "filesCount" | "environmentId" | "createdByUserName"

This file was auto-generated by Fern from our API Definition.

Defined in

src/api/resources/spaces/types/GetSpacesSortField.ts:5

src/api/resources/spaces/types/GetSpacesSortField.ts:7

---

SpaceAccess

Ƭ SpaceAccess: "*" | "upload"

This file was auto-generated by Fern from our API Definition.

Defined in

src/api/resources/spaces/types/SpaceAccess.ts:5

src/api/resources/spaces/types/SpaceAccess.ts:7

Variables

GetSpacesSortField

• GetSpacesSortField: Object

Type declaration

Name	Type
CreatedByUserName	"createdByUserName"
EnvironmentId	"environmentId"
FilesCount	"filesCount"
Name	"name"
WorkbooksCount	"workbooksCount"

Defined in

src/api/resources/spaces/types/GetSpacesSortField.ts:5

src/api/resources/spaces/types/GetSpacesSortField.ts:7

---

SpaceAccess

• SpaceAccess: Object

Type declaration

Name	Type
All	"*"
Upload	"upload"

Defined in

src/api/resources/spaces/types/SpaceAccess.ts:5

src/api/resources/spaces/types/SpaceAccess.ts:7

@flatfile/api / Exports / Flatfile / users

Namespace: users

Flatfile.users

Table of contents

Interfaces

• ApiToken
• CreateApiTokenRequest
• ExchangeTokenData
• ExchangeTokenRequest
• ExchangeTokenResponse
• ListApiTokensRequest
• ListApiTokensResponse
• ListUsersRequest
• ListUsersResponse
• User
• UserConfig
• UserResponse

@flatfile/api / Exports / Flatfile / versions

Namespace: versions

Flatfile.versions

Table of contents

Interfaces

• VersionResponse
• VersionsPostRequestBody

@flatfile/api / Exports / Flatfile / workbooks

Namespace: workbooks

Flatfile.workbooks

Table of contents

Interfaces

• CreateWorkbookConfig
• ListWorkbooksRequest
• ListWorkbooksResponse
• UpdateWorkbookConfig
• Workbook
• WorkbookResponse

@flatfile/api / Exports / FlatfileClient

Namespace: FlatfileClient

Table of contents

Interfaces

• Options