Created
June 5, 2023 23:32
-
-
Save dboskovic/e3fe064a71f13296335be687a95ac23c to your computer and use it in GitHub Desktop.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| <!-- START doctoc generated TOC please keep comment here to allow auto update --> | |
| <!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE --> | |
| - [@flatfile/api](#flatfileapi) | |
| - [Synopsis](#synopsis) | |
| - [Details](#details) | |
| - [Flatfile Node API Library](#flatfile-node-api-library) | |
| - [Documentation](#documentation) | |
| - [Installation](#installation) | |
| - [Usage](#usage) | |
| - [Handling errors](#handling-errors) | |
| - [Handling events](#handling-events) | |
| - [Fields](#fields) | |
| - [Beta status](#beta-status) | |
| - [Contributing](#contributing) | |
| - [API](#api) | |
| - [Contribution](#contribution) | |
| - [Classes](#classes) | |
| - [Class: BadRequestError](#class-badrequesterror) | |
| - [Hierarchy](#hierarchy) | |
| - [Table of contents](#table-of-contents) | |
| - [Constructors](#constructors) | |
| - [Properties](#properties) | |
| - [Methods](#methods) | |
| - [Class: NotFoundError](#class-notfounderror) | |
| - [Hierarchy](#hierarchy-1) | |
| - [Table of contents](#table-of-contents-1) | |
| - [Constructors](#constructors-1) | |
| - [Properties](#properties-1) | |
| - [Methods](#methods-1) | |
| - [Class: FlatfileClient](#class-flatfileclient) | |
| - [Hierarchy](#hierarchy-2) | |
| - [Table of contents](#table-of-contents-2) | |
| - [Constructors](#constructors-2) | |
| - [Properties](#properties-2) | |
| - [Accessors](#accessors) | |
| - [Class: FlatfileError](#class-flatfileerror) | |
| - [Hierarchy](#hierarchy-3) | |
| - [Table of contents](#table-of-contents-3) | |
| - [Constructors](#constructors-3) | |
| - [Properties](#properties-3) | |
| - [Methods](#methods-2) | |
| - [Class: FlatfileTimeoutError](#class-flatfiletimeouterror) | |
| - [Hierarchy](#hierarchy-4) | |
| - [Table of contents](#table-of-contents-4) | |
| - [Constructors](#constructors-4) | |
| - [Properties](#properties-4) | |
| - [Methods](#methods-3) | |
| - [Interfaces](#interfaces) | |
| - [Interface: Agent](#interface-agent) | |
| - [Hierarchy](#hierarchy-5) | |
| - [Table of contents](#table-of-contents-5) | |
| - [Properties](#properties-5) | |
| - [Interface: AgentConfig](#interface-agentconfig) | |
| - [Hierarchy](#hierarchy-6) | |
| - [Table of contents](#table-of-contents-6) | |
| - [Properties](#properties-6) | |
| - [Interface: AgentLog](#interface-agentlog) | |
| - [Table of contents](#table-of-contents-7) | |
| - [Properties](#properties-7) | |
| - [Interface: AgentResponse](#interface-agentresponse) | |
| - [Table of contents](#table-of-contents-8) | |
| - [Properties](#properties-8) | |
| - [Interface: CreateAgentsRequest](#interface-createagentsrequest) | |
| - [Table of contents](#table-of-contents-9) | |
| - [Properties](#properties-9) | |
| - [Interface: DeleteAgentRequest](#interface-deleteagentrequest) | |
| - [Table of contents](#table-of-contents-10) | |
| - [Properties](#properties-10) | |
| - [Interface: GetAgentLogsRequest](#interface-getagentlogsrequest) | |
| - [Table of contents](#table-of-contents-11) | |
| - [Properties](#properties-11) | |
| - [Interface: GetAgentLogsResponse](#interface-getagentlogsresponse) | |
| - [Table of contents](#table-of-contents-12) | |
| - [Properties](#properties-12) | |
| - [Interface: GetAgentRequest](#interface-getagentrequest) | |
| - [Table of contents](#table-of-contents-13) | |
| - [Properties](#properties-13) | |
| - [Interface: GetEnvironmentAgentLogsRequest](#interface-getenvironmentagentlogsrequest) | |
| - [Table of contents](#table-of-contents-14) | |
| - [Properties](#properties-14) | |
| - [Interface: ListAgentsRequest](#interface-listagentsrequest) | |
| - [Table of contents](#table-of-contents-15) | |
| - [Properties](#properties-15) | |
| - [Interface: ListAgentsResponse](#interface-listagentsresponse) | |
| - [Table of contents](#table-of-contents-16) | |
| - [Properties](#properties-16) | |
| - [Interface: ApiKey](#interface-apikey) | |
| - [Table of contents](#table-of-contents-17) | |
| - [Properties](#properties-17) | |
| - [Interface: ApiKeyOperation](#interface-apikeyoperation) | |
| - [Table of contents](#table-of-contents-18) | |
| - [Properties](#properties-18) | |
| - [Interface: ApiKeysResponse](#interface-apikeysresponse) | |
| - [Table of contents](#table-of-contents-19) | |
| - [Properties](#properties-19) | |
| - [Interface: GetApiKeysRequest](#interface-getapikeysrequest) | |
| - [Table of contents](#table-of-contents-20) | |
| - [Properties](#properties-20) | |
| - [Interface: CheckoutSession](#interface-checkoutsession) | |
| - [Table of contents](#table-of-contents-21) | |
| - [Properties](#properties-21) | |
| - [Interface: CreateCheckoutSessionResponse](#interface-createcheckoutsessionresponse) | |
| - [Table of contents](#table-of-contents-22) | |
| - [Properties](#properties-22) | |
| - [Interface: ProductsResponse](#interface-productsresponse) | |
| - [Table of contents](#table-of-contents-23) | |
| - [Properties](#properties-23) | |
| - [Interface: StripeProduct](#interface-stripeproduct) | |
| - [Table of contents](#table-of-contents-24) | |
| - [Properties](#properties-24) | |
| - [Interface: CellValueWithCounts](#interface-cellvaluewithcounts) | |
| - [Hierarchy](#hierarchy-7) | |
| - [Table of contents](#table-of-contents-25) | |
| - [Properties](#properties-25) | |
| - [Interface: CellsResponse](#interface-cellsresponse) | |
| - [Table of contents](#table-of-contents-26) | |
| - [Properties](#properties-26) | |
| - [Interface: GetFieldValuesRequest](#interface-getfieldvaluesrequest) | |
| - [Table of contents](#table-of-contents-27) | |
| - [Properties](#properties-27) | |
| - [Interface: Action](#interface-action) | |
| - [Table of contents](#table-of-contents-28) | |
| - [Properties](#properties-28) | |
| - [Interface: Error\_](#interface-error%5C_) | |
| - [Table of contents](#table-of-contents-29) | |
| - [Properties](#properties-29) | |
| - [Interface: Pagination](#interface-pagination) | |
| - [Table of contents](#table-of-contents-30) | |
| - [Properties](#properties-30) | |
| - [Interface: Success](#interface-success) | |
| - [Hierarchy](#hierarchy-8) | |
| - [Table of contents](#table-of-contents-31) | |
| - [Properties](#properties-31) | |
| - [Interface: SuccessData](#interface-successdata) | |
| - [Table of contents](#table-of-contents-32) | |
| - [Properties](#properties-32) | |
| - [Interface: Document](#interface-document) | |
| - [Hierarchy](#hierarchy-9) | |
| - [Table of contents](#table-of-contents-33) | |
| - [Properties](#properties-33) | |
| - [Interface: DocumentConfig](#interface-documentconfig) | |
| - [Hierarchy](#hierarchy-10) | |
| - [Table of contents](#table-of-contents-34) | |
| - [Properties](#properties-34) | |
| - [Interface: DocumentResponse](#interface-documentresponse) | |
| - [Table of contents](#table-of-contents-35) | |
| - [Properties](#properties-35) | |
| - [Interface: ListDocumentsResponse](#interface-listdocumentsresponse) | |
| - [Table of contents](#table-of-contents-36) | |
| - [Properties](#properties-36) | |
| - [Interface: Environment](#interface-environment) | |
| - [Hierarchy](#hierarchy-11) | |
| - [Table of contents](#table-of-contents-37) | |
| - [Properties](#properties-37) | |
| - [Interface: EnvironmentConfig](#interface-environmentconfig) | |
| - [Hierarchy](#hierarchy-12) | |
| - [Table of contents](#table-of-contents-38) | |
| - [Properties](#properties-38) | |
| - [Interface: EnvironmentResponse](#interface-environmentresponse) | |
| - [Table of contents](#table-of-contents-39) | |
| - [Properties](#properties-39) | |
| - [Interface: ListEnvironmentsRequest](#interface-listenvironmentsrequest) | |
| - [Table of contents](#table-of-contents-40) | |
| - [Properties](#properties-40) | |
| - [Interface: ListEnvironmentsResponse](#interface-listenvironmentsresponse) | |
| - [Table of contents](#table-of-contents-41) | |
| - [Properties](#properties-41) | |
| - [Interface: ActionTriggeredEvent](#interface-actiontriggeredevent) | |
| - [Hierarchy](#hierarchy-13) | |
| - [Table of contents](#table-of-contents-42) | |
| - [Properties](#properties-42) | |
| - [Interface: BaseEvent](#interface-baseevent) | |
| - [Hierarchy](#hierarchy-14) | |
| - [Table of contents](#table-of-contents-43) | |
| - [Properties](#properties-43) | |
| - [Interface: ClientInitializedEvent](#interface-clientinitializedevent) | |
| - [Hierarchy](#hierarchy-15) | |
| - [Table of contents](#table-of-contents-44) | |
| - [Properties](#properties-44) | |
| - [Interface: Context](#interface-context) | |
| - [Table of contents](#table-of-contents-45) | |
| - [Properties](#properties-45) | |
| - [Interface: ActionTriggered](#interface-actiontriggered) | |
| - [Hierarchy](#hierarchy-16) | |
| - [Table of contents](#table-of-contents-46) | |
| - [Properties](#properties-46) | |
| - [Interface: ClientInitialized](#interface-clientinitialized) | |
| - [Hierarchy](#hierarchy-17) | |
| - [Table of contents](#table-of-contents-47) | |
| - [Properties](#properties-47) | |
| - [Interface: FileDeleted](#interface-filedeleted) | |
| - [Hierarchy](#hierarchy-18) | |
| - [Table of contents](#table-of-contents-48) | |
| - [Properties](#properties-48) | |
| - [Interface: JobCompleted](#interface-jobcompleted) | |
| - [Hierarchy](#hierarchy-19) | |
| - [Table of contents](#table-of-contents-49) | |
| - [Properties](#properties-49) | |
| - [Interface: JobDeleted](#interface-jobdeleted) | |
| - [Hierarchy](#hierarchy-20) | |
| - [Table of contents](#table-of-contents-50) | |
| - [Properties](#properties-50) | |
| - [Interface: JobFailed](#interface-jobfailed) | |
| - [Hierarchy](#hierarchy-21) | |
| - [Table of contents](#table-of-contents-51) | |
| - [Properties](#properties-51) | |
| - [Interface: JobStarted](#interface-jobstarted) | |
| - [Hierarchy](#hierarchy-22) | |
| - [Table of contents](#table-of-contents-52) | |
| - [Properties](#properties-52) | |
| - [Interface: JobUpdated](#interface-jobupdated) | |
| - [Hierarchy](#hierarchy-23) | |
| - [Table of contents](#table-of-contents-53) | |
| - [Properties](#properties-53) | |
| - [Interface: JobWaiting](#interface-jobwaiting) | |
| - [Hierarchy](#hierarchy-24) | |
| - [Table of contents](#table-of-contents-54) | |
| - [Properties](#properties-54) | |
| - [Interface: RecordsCreated](#interface-recordscreated) | |
| - [Hierarchy](#hierarchy-25) | |
| - [Table of contents](#table-of-contents-55) | |
| - [Properties](#properties-55) | |
| - [Interface: RecordsDeleted](#interface-recordsdeleted) | |
| - [Hierarchy](#hierarchy-26) | |
| - [Table of contents](#table-of-contents-56) | |
| - [Properties](#properties-56) | |
| - [Interface: RecordsUpdated](#interface-recordsupdated) | |
| - [Hierarchy](#hierarchy-27) | |
| - [Table of contents](#table-of-contents-57) | |
| - [Properties](#properties-57) | |
| - [Interface: SheetValidated](#interface-sheetvalidated) | |
| - [Hierarchy](#hierarchy-28) | |
| - [Table of contents](#table-of-contents-58) | |
| - [Properties](#properties-58) | |
| - [Interface: SpaceAdded](#interface-spaceadded) | |
| - [Hierarchy](#hierarchy-29) | |
| - [Table of contents](#table-of-contents-59) | |
| - [Properties](#properties-59) | |
| - [Interface: SpaceRemoved](#interface-spaceremoved) | |
| - [Hierarchy](#hierarchy-30) | |
| - [Table of contents](#table-of-contents-60) | |
| - [Properties](#properties-60) | |
| - [Interface: UploadCompleted](#interface-uploadcompleted) | |
| - [Hierarchy](#hierarchy-31) | |
| - [Table of contents](#table-of-contents-61) | |
| - [Properties](#properties-61) | |
| - [Interface: UploadFailed](#interface-uploadfailed) | |
| - [Hierarchy](#hierarchy-32) | |
| - [Table of contents](#table-of-contents-62) | |
| - [Properties](#properties-62) | |
| - [Interface: UploadStarted](#interface-uploadstarted) | |
| - [Hierarchy](#hierarchy-33) | |
| - [Table of contents](#table-of-contents-63) | |
| - [Properties](#properties-63) | |
| - [Interface: UserAdded](#interface-useradded) | |
| - [Hierarchy](#hierarchy-34) | |
| - [Table of contents](#table-of-contents-64) | |
| - [Properties](#properties-64) | |
| - [Interface: UserOffline](#interface-useroffline) | |
| - [Hierarchy](#hierarchy-35) | |
| - [Table of contents](#table-of-contents-65) | |
| - [Properties](#properties-65) | |
| - [Interface: UserOnline](#interface-useronline) | |
| - [Hierarchy](#hierarchy-36) | |
| - [Table of contents](#table-of-contents-66) | |
| - [Properties](#properties-66) | |
| - [Interface: UserRemoved](#interface-userremoved) | |
| - [Hierarchy](#hierarchy-37) | |
| - [Table of contents](#table-of-contents-67) | |
| - [Properties](#properties-67) | |
| - [Interface: WorkbookAdded](#interface-workbookadded) | |
| - [Hierarchy](#hierarchy-38) | |
| - [Table of contents](#table-of-contents-68) | |
| - [Properties](#properties-68) | |
| - [Interface: WorkbookRemoved](#interface-workbookremoved) | |
| - [Hierarchy](#hierarchy-39) | |
| - [Table of contents](#table-of-contents-69) | |
| - [Properties](#properties-69) | |
| - [Interface: WorkbookUpdated](#interface-workbookupdated) | |
| - [Hierarchy](#hierarchy-40) | |
| - [Table of contents](#table-of-contents-70) | |
| - [Properties](#properties-70) | |
| - [Interface: EventAttributes](#interface-eventattributes) | |
| - [Table of contents](#table-of-contents-71) | |
| - [Properties](#properties-71) | |
| - [Interface: EventResponse](#interface-eventresponse) | |
| - [Table of contents](#table-of-contents-72) | |
| - [Properties](#properties-72) | |
| - [Interface: FileDeletedEvent](#interface-filedeletedevent) | |
| - [Hierarchy](#hierarchy-41) | |
| - [Table of contents](#table-of-contents-73) | |
| - [Properties](#properties-73) | |
| - [Interface: GetEventTokenRequest](#interface-geteventtokenrequest) | |
| - [Table of contents](#table-of-contents-74) | |
| - [Properties](#properties-74) | |
| - [Interface: JobCompletedEvent](#interface-jobcompletedevent) | |
| - [Hierarchy](#hierarchy-42) | |
| - [Table of contents](#table-of-contents-75) | |
| - [Properties](#properties-75) | |
| - [Interface: JobDeletedEvent](#interface-jobdeletedevent) | |
| - [Hierarchy](#hierarchy-43) | |
| - [Table of contents](#table-of-contents-76) | |
| - [Properties](#properties-76) | |
| - [Interface: JobFailedEvent](#interface-jobfailedevent) | |
| - [Hierarchy](#hierarchy-44) | |
| - [Table of contents](#table-of-contents-77) | |
| - [Properties](#properties-77) | |
| - [Interface: JobFailedPayload](#interface-jobfailedpayload) | |
| - [Hierarchy](#hierarchy-45) | |
| - [Table of contents](#table-of-contents-78) | |
| - [Properties](#properties-78) | |
| - [Interface: JobPayload](#interface-jobpayload) | |
| - [Hierarchy](#hierarchy-46) | |
| - [Table of contents](#table-of-contents-79) | |
| - [Properties](#properties-79) | |
| - [Interface: JobStartedEvent](#interface-jobstartedevent) | |
| - [Hierarchy](#hierarchy-47) | |
| - [Table of contents](#table-of-contents-80) | |
| - [Properties](#properties-80) | |
| - [Interface: JobUpdatedEvent](#interface-jobupdatedevent) | |
| - [Hierarchy](#hierarchy-48) | |
| - [Table of contents](#table-of-contents-81) | |
| - [Properties](#properties-81) | |
| - [Interface: JobWaitingEvent](#interface-jobwaitingevent) | |
| - [Hierarchy](#hierarchy-49) | |
| - [Table of contents](#table-of-contents-82) | |
| - [Properties](#properties-82) | |
| - [Interface: ListAllEventsResponse](#interface-listalleventsresponse) | |
| - [Table of contents](#table-of-contents-83) | |
| - [Properties](#properties-83) | |
| - [Interface: ListEventsRequest](#interface-listeventsrequest) | |
| - [Table of contents](#table-of-contents-84) | |
| - [Properties](#properties-84) | |
| - [Interface: Origin](#interface-origin) | |
| - [Table of contents](#table-of-contents-85) | |
| - [Properties](#properties-85) | |
| - [Interface: Progress](#interface-progress) | |
| - [Table of contents](#table-of-contents-86) | |
| - [Properties](#properties-86) | |
| - [Interface: RecordsCreatedEvent](#interface-recordscreatedevent) | |
| - [Hierarchy](#hierarchy-50) | |
| - [Table of contents](#table-of-contents-87) | |
| - [Properties](#properties-87) | |
| - [Interface: RecordsDeletedEvent](#interface-recordsdeletedevent) | |
| - [Hierarchy](#hierarchy-51) | |
| - [Table of contents](#table-of-contents-88) | |
| - [Properties](#properties-88) | |
| - [Interface: RecordsPayload](#interface-recordspayload) | |
| - [Table of contents](#table-of-contents-89) | |
| - [Properties](#properties-89) | |
| - [Interface: RecordsUpdatedEvent](#interface-recordsupdatedevent) | |
| - [Hierarchy](#hierarchy-52) | |
| - [Table of contents](#table-of-contents-90) | |
| - [Properties](#properties-90) | |
| - [Interface: SheetValidatedEvent](#interface-sheetvalidatedevent) | |
| - [Hierarchy](#hierarchy-53) | |
| - [Table of contents](#table-of-contents-91) | |
| - [Properties](#properties-91) | |
| - [Interface: SpaceAddedEvent](#interface-spaceaddedevent) | |
| - [Hierarchy](#hierarchy-54) | |
| - [Table of contents](#table-of-contents-92) | |
| - [Properties](#properties-92) | |
| - [Interface: SpaceRemovedEvent](#interface-spaceremovedevent) | |
| - [Hierarchy](#hierarchy-55) | |
| - [Table of contents](#table-of-contents-93) | |
| - [Properties](#properties-93) | |
| - [Interface: UploadCompletedEvent](#interface-uploadcompletedevent) | |
| - [Hierarchy](#hierarchy-56) | |
| - [Table of contents](#table-of-contents-94) | |
| - [Properties](#properties-94) | |
| - [Interface: UploadFailedEvent](#interface-uploadfailedevent) | |
| - [Hierarchy](#hierarchy-57) | |
| - [Table of contents](#table-of-contents-95) | |
| - [Properties](#properties-95) | |
| - [Interface: UploadStartedEvent](#interface-uploadstartedevent) | |
| - [Hierarchy](#hierarchy-58) | |
| - [Table of contents](#table-of-contents-96) | |
| - [Properties](#properties-96) | |
| - [Interface: UserAddedEvent](#interface-useraddedevent) | |
| - [Hierarchy](#hierarchy-59) | |
| - [Table of contents](#table-of-contents-97) | |
| - [Properties](#properties-97) | |
| - [Interface: UserOfflineEvent](#interface-userofflineevent) | |
| - [Hierarchy](#hierarchy-60) | |
| - [Table of contents](#table-of-contents-98) | |
| - [Properties](#properties-98) | |
| - [Interface: UserOnlineEvent](#interface-useronlineevent) | |
| - [Hierarchy](#hierarchy-61) | |
| - [Table of contents](#table-of-contents-99) | |
| - [Properties](#properties-99) | |
| - [Interface: UserRemovedEvent](#interface-userremovedevent) | |
| - [Hierarchy](#hierarchy-62) | |
| - [Table of contents](#table-of-contents-100) | |
| - [Properties](#properties-100) | |
| - [Interface: WorkbookAddedEvent](#interface-workbookaddedevent) | |
| - [Hierarchy](#hierarchy-63) | |
| - [Table of contents](#table-of-contents-101) | |
| - [Properties](#properties-101) | |
| - [Interface: WorkbookRemovedEvent](#interface-workbookremovedevent) | |
| - [Hierarchy](#hierarchy-64) | |
| - [Table of contents](#table-of-contents-102) | |
| - [Properties](#properties-102) | |
| - [Interface: WorkbookUpdatedEvent](#interface-workbookupdatedevent) | |
| - [Hierarchy](#hierarchy-65) | |
| - [Table of contents](#table-of-contents-103) | |
| - [Properties](#properties-103) | |
| - [Interface: CreateFileRequest](#interface-createfilerequest) | |
| - [Table of contents](#table-of-contents-104) | |
| - [Properties](#properties-104) | |
| - [Interface: FileResponse](#interface-fileresponse) | |
| - [Table of contents](#table-of-contents-105) | |
| - [Properties](#properties-105) | |
| - [Interface: File\_](#interface-file%5C_) | |
| - [Table of contents](#table-of-contents-106) | |
| - [Properties](#properties-106) | |
| - [Interface: ListFilesRequest](#interface-listfilesrequest) | |
| - [Table of contents](#table-of-contents-107) | |
| - [Properties](#properties-107) | |
| - [Interface: ListFilesResponse](#interface-listfilesresponse) | |
| - [Table of contents](#table-of-contents-108) | |
| - [Properties](#properties-108) | |
| - [Interface: UpdateFileRequest](#interface-updatefilerequest) | |
| - [Table of contents](#table-of-contents-109) | |
| - [Properties](#properties-109) | |
| - [Interface: CreateGuestResponse](#interface-createguestresponse) | |
| - [Table of contents](#table-of-contents-110) | |
| - [Properties](#properties-110) | |
| - [Interface: Guest](#interface-guest) | |
| - [Hierarchy](#hierarchy-66) | |
| - [Table of contents](#table-of-contents-111) | |
| - [Properties](#properties-111) | |
| - [Interface: GuestConfig](#interface-guestconfig) | |
| - [Hierarchy](#hierarchy-67) | |
| - [Table of contents](#table-of-contents-112) | |
| - [Properties](#properties-112) | |
| - [Interface: GuestSpace](#interface-guestspace) | |
| - [Table of contents](#table-of-contents-113) | |
| - [Properties](#properties-113) | |
| - [Interface: GuestWorkbook](#interface-guestworkbook) | |
| - [Table of contents](#table-of-contents-114) | |
| - [Properties](#properties-114) | |
| - [Interface: Invite](#interface-invite) | |
| - [Table of contents](#table-of-contents-115) | |
| - [Properties](#properties-115) | |
| - [Interface: ListGuestsRequest](#interface-listguestsrequest) | |
| - [Table of contents](#table-of-contents-116) | |
| - [Properties](#properties-116) | |
| - [Interface: ListGuestsResponse](#interface-listguestsresponse) | |
| - [Table of contents](#table-of-contents-117) | |
| - [Properties](#properties-117) | |
| - [Interface: AiAssistJobConfig](#interface-aiassistjobconfig) | |
| - [Table of contents](#table-of-contents-118) | |
| - [Properties](#properties-118) | |
| - [Interface: CategoryMapping](#interface-categorymapping) | |
| - [Table of contents](#table-of-contents-119) | |
| - [Properties](#properties-119) | |
| - [Interface: DeleteJobConfig](#interface-deletejobconfig) | |
| - [Table of contents](#table-of-contents-120) | |
| - [Properties](#properties-120) | |
| - [Interface: DestinationField](#interface-destinationfield) | |
| - [Table of contents](#table-of-contents-121) | |
| - [Properties](#properties-121) | |
| - [Interface: Edge](#interface-edge) | |
| - [Table of contents](#table-of-contents-122) | |
| - [Properties](#properties-122) | |
| - [Interface: EmptyObject](#interface-emptyobject) | |
| - [Interface: EnumDetails](#interface-enumdetails) | |
| - [Table of contents](#table-of-contents-123) | |
| - [Properties](#properties-123) | |
| - [Interface: ExportJobConfig](#interface-exportjobconfig) | |
| - [Table of contents](#table-of-contents-124) | |
| - [Properties](#properties-124) | |
| - [Interface: ExportOptions](#interface-exportoptions) | |
| - [Table of contents](#table-of-contents-125) | |
| - [Properties](#properties-125) | |
| - [Interface: FileJobConfig](#interface-filejobconfig) | |
| - [Table of contents](#table-of-contents-126) | |
| - [Properties](#properties-126) | |
| - [Interface: FindAndReplaceJobConfig](#interface-findandreplacejobconfig) | |
| - [Table of contents](#table-of-contents-127) | |
| - [Properties](#properties-127) | |
| - [Interface: Job](#interface-job) | |
| - [Hierarchy](#hierarchy-68) | |
| - [Table of contents](#table-of-contents-128) | |
| - [Properties](#properties-128) | |
| - [Interface: JobAckDetails](#interface-jobackdetails) | |
| - [Table of contents](#table-of-contents-129) | |
| - [Properties](#properties-129) | |
| - [Interface: JobConfig](#interface-jobconfig) | |
| - [Hierarchy](#hierarchy-69) | |
| - [Table of contents](#table-of-contents-130) | |
| - [Properties](#properties-130) | |
| - [Interface: JobExecutionPlan](#interface-jobexecutionplan) | |
| - [Hierarchy](#hierarchy-70) | |
| - [Table of contents](#table-of-contents-131) | |
| - [Properties](#properties-131) | |
| - [Interface: JobExecutionPlanConfig](#interface-jobexecutionplanconfig) | |
| - [Hierarchy](#hierarchy-71) | |
| - [Table of contents](#table-of-contents-132) | |
| - [Properties](#properties-132) | |
| - [Interface: JobOutcome](#interface-joboutcome) | |
| - [Table of contents](#table-of-contents-133) | |
| - [Properties](#properties-133) | |
| - [Interface: JobPlan](#interface-jobplan) | |
| - [Table of contents](#table-of-contents-134) | |
| - [Properties](#properties-134) | |
| - [Interface: JobResponse](#interface-jobresponse) | |
| - [Table of contents](#table-of-contents-135) | |
| - [Properties](#properties-135) | |
| - [Interface: JobUpdate](#interface-jobupdate) | |
| - [Table of contents](#table-of-contents-136) | |
| - [Properties](#properties-136) | |
| - [Interface: ListJobsRequest](#interface-listjobsrequest) | |
| - [Table of contents](#table-of-contents-137) | |
| - [Properties](#properties-137) | |
| - [Interface: ListJobsResponse](#interface-listjobsresponse) | |
| - [Table of contents](#table-of-contents-138) | |
| - [Properties](#properties-138) | |
| - [Interface: Metadata](#interface-metadata) | |
| - [Table of contents](#table-of-contents-139) | |
| - [Properties](#properties-139) | |
| - [Interface: MutateJobConfig](#interface-mutatejobconfig) | |
| - [Table of contents](#table-of-contents-140) | |
| - [Properties](#properties-140) | |
| - [Interface: PipelineJobConfig](#interface-pipelinejobconfig) | |
| - [Table of contents](#table-of-contents-141) | |
| - [Properties](#properties-141) | |
| - [Interface: SourceField](#interface-sourcefield) | |
| - [Table of contents](#table-of-contents-142) | |
| - [Properties](#properties-142) | |
| - [Interface: ArrayableProperty](#interface-arrayableproperty) | |
| - [Hierarchy](#hierarchy-72) | |
| - [Table of contents](#table-of-contents-143) | |
| - [Properties](#properties-143) | |
| - [Interface: BaseProperty](#interface-baseproperty) | |
| - [Hierarchy](#hierarchy-73) | |
| - [Table of contents](#table-of-contents-144) | |
| - [Properties](#properties-144) | |
| - [Interface: BooleanProperty](#interface-booleanproperty) | |
| - [Hierarchy](#hierarchy-74) | |
| - [Table of contents](#table-of-contents-145) | |
| - [Properties](#properties-145) | |
| - [Interface: BooleanPropertyConfig](#interface-booleanpropertyconfig) | |
| - [Table of contents](#table-of-contents-146) | |
| - [Properties](#properties-146) | |
| - [Interface: Computed](#interface-computed) | |
| - [Table of contents](#table-of-contents-147) | |
| - [Properties](#properties-147) | |
| - [Interface: Required](#interface-required) | |
| - [Table of contents](#table-of-contents-148) | |
| - [Properties](#properties-148) | |
| - [Interface: Unique](#interface-unique) | |
| - [Hierarchy](#hierarchy-75) | |
| - [Table of contents](#table-of-contents-149) | |
| - [Properties](#properties-149) | |
| - [Interface: DateProperty](#interface-dateproperty) | |
| - [Hierarchy](#hierarchy-76) | |
| - [Table of contents](#table-of-contents-150) | |
| - [Properties](#properties-150) | |
| - [Interface: EnumProperty](#interface-enumproperty) | |
| - [Hierarchy](#hierarchy-77) | |
| - [Table of contents](#table-of-contents-151) | |
| - [Properties](#properties-151) | |
| - [Interface: EnumPropertyConfig](#interface-enumpropertyconfig) | |
| - [Table of contents](#table-of-contents-152) | |
| - [Properties](#properties-152) | |
| - [Interface: EnumPropertyOption](#interface-enumpropertyoption) | |
| - [Table of contents](#table-of-contents-153) | |
| - [Properties](#properties-153) | |
| - [Interface: NumberConfig](#interface-numberconfig) | |
| - [Table of contents](#table-of-contents-154) | |
| - [Properties](#properties-154) | |
| - [Interface: NumberProperty](#interface-numberproperty) | |
| - [Hierarchy](#hierarchy-78) | |
| - [Table of contents](#table-of-contents-155) | |
| - [Properties](#properties-155) | |
| - [Interface: Boolean](#interface-boolean) | |
| - [Hierarchy](#hierarchy-79) | |
| - [Table of contents](#table-of-contents-156) | |
| - [Properties](#properties-156) | |
| - [Interface: Date\_](#interface-date%5C_) | |
| - [Hierarchy](#hierarchy-80) | |
| - [Table of contents](#table-of-contents-157) | |
| - [Properties](#properties-157) | |
| - [Interface: Enum](#interface-enum) | |
| - [Hierarchy](#hierarchy-81) | |
| - [Table of contents](#table-of-contents-158) | |
| - [Properties](#properties-158) | |
| - [Interface: Number](#interface-number) | |
| - [Hierarchy](#hierarchy-82) | |
| - [Table of contents](#table-of-contents-159) | |
| - [Properties](#properties-159) | |
| - [Interface: Reference](#interface-reference) | |
| - [Hierarchy](#hierarchy-83) | |
| - [Table of contents](#table-of-contents-160) | |
| - [Properties](#properties-160) | |
| - [Interface: String](#interface-string) | |
| - [Hierarchy](#hierarchy-84) | |
| - [Table of contents](#table-of-contents-161) | |
| - [Properties](#properties-161) | |
| - [Interface: ReferenceProperty](#interface-referenceproperty) | |
| - [Hierarchy](#hierarchy-85) | |
| - [Table of contents](#table-of-contents-162) | |
| - [Properties](#properties-162) | |
| - [Interface: ReferencePropertyConfig](#interface-referencepropertyconfig) | |
| - [Table of contents](#table-of-contents-163) | |
| - [Properties](#properties-163) | |
| - [Interface: StringConfig](#interface-stringconfig) | |
| - [Table of contents](#table-of-contents-164) | |
| - [Properties](#properties-164) | |
| - [Interface: StringProperty](#interface-stringproperty) | |
| - [Hierarchy](#hierarchy-86) | |
| - [Table of contents](#table-of-contents-165) | |
| - [Properties](#properties-165) | |
| - [Interface: UniqueConstraint](#interface-uniqueconstraint) | |
| - [Hierarchy](#hierarchy-87) | |
| - [Table of contents](#table-of-contents-166) | |
| - [Properties](#properties-166) | |
| - [Interface: UniqueConstraintConfig](#interface-uniqueconstraintconfig) | |
| - [Table of contents](#table-of-contents-167) | |
| - [Properties](#properties-167) | |
| - [Interface: CellValue](#interface-cellvalue) | |
| - [Hierarchy](#hierarchy-88) | |
| - [Table of contents](#table-of-contents-168) | |
| - [Properties](#properties-168) | |
| - [Interface: CellValueWithLinks](#interface-cellvaluewithlinks) | |
| - [Hierarchy](#hierarchy-89) | |
| - [Table of contents](#table-of-contents-169) | |
| - [Properties](#properties-169) | |
| - [Interface: DeleteRecordsRequest](#interface-deleterecordsrequest) | |
| - [Table of contents](#table-of-contents-170) | |
| - [Properties](#properties-170) | |
| - [Interface: FindAndReplaceRecordRequest](#interface-findandreplacerecordrequest) | |
| - [Table of contents](#table-of-contents-171) | |
| - [Properties](#properties-171) | |
| - [Interface: FindAndReplaceRecordRequestDeprecated](#interface-findandreplacerecordrequestdeprecated) | |
| - [Table of contents](#table-of-contents-172) | |
| - [Properties](#properties-172) | |
| - [Interface: FindRecordsRequest](#interface-findrecordsrequest) | |
| - [Table of contents](#table-of-contents-173) | |
| - [Properties](#properties-173) | |
| - [Interface: GetRecordsRequest](#interface-getrecordsrequest) | |
| - [Table of contents](#table-of-contents-174) | |
| - [Properties](#properties-174) | |
| - [Interface: RecordCounts](#interface-recordcounts) | |
| - [Table of contents](#table-of-contents-175) | |
| - [Properties](#properties-175) | |
| - [Interface: RecordWithLinks](#interface-recordwithlinks) | |
| - [Table of contents](#table-of-contents-176) | |
| - [Properties](#properties-176) | |
| - [Interface: Record\_](#interface-record%5C_) | |
| - [Table of contents](#table-of-contents-177) | |
| - [Properties](#properties-177) | |
| - [Interface: RecordsResponse](#interface-recordsresponse) | |
| - [Table of contents](#table-of-contents-178) | |
| - [Properties](#properties-178) | |
| - [Interface: RecordsResponseData](#interface-recordsresponsedata) | |
| - [Hierarchy](#hierarchy-90) | |
| - [Table of contents](#table-of-contents-179) | |
| - [Properties](#properties-179) | |
| - [Interface: ValidationMessage](#interface-validationmessage) | |
| - [Table of contents](#table-of-contents-180) | |
| - [Properties](#properties-180) | |
| - [Interface: GetRecordCountsRequest](#interface-getrecordcountsrequest) | |
| - [Table of contents](#table-of-contents-181) | |
| - [Properties](#properties-181) | |
| - [Interface: GetRecordsCsvRequest](#interface-getrecordscsvrequest) | |
| - [Table of contents](#table-of-contents-182) | |
| - [Properties](#properties-182) | |
| - [Interface: ListSheetsRequest](#interface-listsheetsrequest) | |
| - [Table of contents](#table-of-contents-183) | |
| - [Properties](#properties-183) | |
| - [Interface: ListSheetsResponse](#interface-listsheetsresponse) | |
| - [Table of contents](#table-of-contents-184) | |
| - [Properties](#properties-184) | |
| - [Interface: RecordCountsResponse](#interface-recordcountsresponse) | |
| - [Table of contents](#table-of-contents-185) | |
| - [Properties](#properties-185) | |
| - [Interface: RecordCountsResponseData](#interface-recordcountsresponsedata) | |
| - [Hierarchy](#hierarchy-91) | |
| - [Table of contents](#table-of-contents-186) | |
| - [Properties](#properties-186) | |
| - [Interface: Sheet](#interface-sheet) | |
| - [Table of contents](#table-of-contents-187) | |
| - [Properties](#properties-187) | |
| - [Interface: SheetConfig](#interface-sheetconfig) | |
| - [Table of contents](#table-of-contents-188) | |
| - [Properties](#properties-188) | |
| - [Interface: SheetResponse](#interface-sheetresponse) | |
| - [Table of contents](#table-of-contents-189) | |
| - [Properties](#properties-189) | |
| - [Interface: EventToken](#interface-eventtoken) | |
| - [Table of contents](#table-of-contents-190) | |
| - [Properties](#properties-190) | |
| - [Interface: EventTokenResponse](#interface-eventtokenresponse) | |
| - [Table of contents](#table-of-contents-191) | |
| - [Properties](#properties-191) | |
| - [Interface: ListSpacesRequest](#interface-listspacesrequest) | |
| - [Table of contents](#table-of-contents-192) | |
| - [Properties](#properties-192) | |
| - [Interface: ListSpacesResponse](#interface-listspacesresponse) | |
| - [Table of contents](#table-of-contents-193) | |
| - [Properties](#properties-193) | |
| - [Interface: Space](#interface-space) | |
| - [Hierarchy](#hierarchy-92) | |
| - [Table of contents](#table-of-contents-194) | |
| - [Properties](#properties-194) | |
| - [Interface: SpaceConfig](#interface-spaceconfig) | |
| - [Hierarchy](#hierarchy-93) | |
| - [Table of contents](#table-of-contents-195) | |
| - [Properties](#properties-195) | |
| - [Interface: SpaceResponse](#interface-spaceresponse) | |
| - [Table of contents](#table-of-contents-196) | |
| - [Properties](#properties-196) | |
| - [Interface: ApiToken](#interface-apitoken) | |
| - [Table of contents](#table-of-contents-197) | |
| - [Properties](#properties-197) | |
| - [Interface: CreateApiTokenRequest](#interface-createapitokenrequest) | |
| - [Table of contents](#table-of-contents-198) | |
| - [Properties](#properties-198) | |
| - [Interface: ExchangeTokenData](#interface-exchangetokendata) | |
| - [Table of contents](#table-of-contents-199) | |
| - [Properties](#properties-199) | |
| - [Interface: ExchangeTokenRequest](#interface-exchangetokenrequest) | |
| - [Table of contents](#table-of-contents-200) | |
| - [Properties](#properties-200) | |
| - [Interface: ExchangeTokenResponse](#interface-exchangetokenresponse) | |
| - [Table of contents](#table-of-contents-201) | |
| - [Properties](#properties-201) | |
| - [Interface: ListApiTokensRequest](#interface-listapitokensrequest) | |
| - [Table of contents](#table-of-contents-202) | |
| - [Properties](#properties-202) | |
| - [Interface: ListApiTokensResponse](#interface-listapitokensresponse) | |
| - [Table of contents](#table-of-contents-203) | |
| - [Properties](#properties-203) | |
| - [Interface: ListUsersRequest](#interface-listusersrequest) | |
| - [Table of contents](#table-of-contents-204) | |
| - [Properties](#properties-204) | |
| - [Interface: ListUsersResponse](#interface-listusersresponse) | |
| - [Table of contents](#table-of-contents-205) | |
| - [Properties](#properties-205) | |
| - [Interface: User](#interface-user) | |
| - [Hierarchy](#hierarchy-94) | |
| - [Table of contents](#table-of-contents-206) | |
| - [Properties](#properties-206) | |
| - [Interface: UserConfig](#interface-userconfig) | |
| - [Hierarchy](#hierarchy-95) | |
| - [Table of contents](#table-of-contents-207) | |
| - [Properties](#properties-207) | |
| - [Interface: UserResponse](#interface-userresponse) | |
| - [Table of contents](#table-of-contents-208) | |
| - [Properties](#properties-208) | |
| - [Interface: VersionResponse](#interface-versionresponse) | |
| - [Table of contents](#table-of-contents-209) | |
| - [Properties](#properties-209) | |
| - [Interface: VersionsPostRequestBody](#interface-versionspostrequestbody) | |
| - [Table of contents](#table-of-contents-210) | |
| - [Properties](#properties-210) | |
| - [Interface: CreateWorkbookConfig](#interface-createworkbookconfig) | |
| - [Table of contents](#table-of-contents-211) | |
| - [Properties](#properties-211) | |
| - [Interface: ListWorkbooksRequest](#interface-listworkbooksrequest) | |
| - [Table of contents](#table-of-contents-212) | |
| - [Properties](#properties-212) | |
| - [Interface: ListWorkbooksResponse](#interface-listworkbooksresponse) | |
| - [Table of contents](#table-of-contents-213) | |
| - [Properties](#properties-213) | |
| - [Interface: UpdateWorkbookConfig](#interface-updateworkbookconfig) | |
| - [Table of contents](#table-of-contents-214) | |
| - [Properties](#properties-214) | |
| - [Interface: Workbook](#interface-workbook) | |
| - [Table of contents](#table-of-contents-215) | |
| - [Properties](#properties-215) | |
| - [Interface: WorkbookResponse](#interface-workbookresponse) | |
| - [Table of contents](#table-of-contents-216) | |
| - [Properties](#properties-216) | |
| - [Interface: Options](#interface-options) | |
| - [Table of contents](#table-of-contents-217) | |
| - [Properties](#properties-217) | |
| - [@flatfile/api](#flatfileapi-1) | |
| - [Table of contents](#table-of-contents-218) | |
| - [Namespaces](#namespaces) | |
| - [Classes](#classes-1) | |
| - [Type Aliases](#type-aliases) | |
| - [Variables](#variables) | |
| - [Type Aliases](#type-aliases-1) | |
| - [FlatfileEnvironment](#flatfileenvironment) | |
| - [Variables](#variables-1) | |
| - [FlatfileEnvironment](#flatfileenvironment-1) | |
| - [default](#default) | |
| - [Modules](#modules) | |
| - [Namespace: agents](#namespace-agents) | |
| - [Table of contents](#table-of-contents-219) | |
| - [Type Aliases](#type-aliases-2) | |
| - [Variables](#variables-2) | |
| - [Namespace: auth](#namespace-auth) | |
| - [Table of contents](#table-of-contents-220) | |
| - [Type Aliases](#type-aliases-3) | |
| - [Variables](#variables-3) | |
| - [Namespace: billing](#namespace-billing) | |
| - [Table of contents](#table-of-contents-221) | |
| - [Namespace: cells](#namespace-cells) | |
| - [Table of contents](#table-of-contents-222) | |
| - [Type Aliases](#type-aliases-4) | |
| - [Namespace: commons](#namespace-commons) | |
| - [Table of contents](#table-of-contents-223) | |
| - [Type Aliases](#type-aliases-5) | |
| - [Variables](#variables-4) | |
| - [Namespace: documents](#namespace-documents) | |
| - [Table of contents](#table-of-contents-224) | |
| - [Namespace: environments](#namespace-environments) | |
| - [Table of contents](#table-of-contents-225) | |
| - [Type Aliases](#type-aliases-6) | |
| - [Variables](#variables-5) | |
| - [Namespace: Event](#namespace-event) | |
| - [Table of contents](#table-of-contents-226) | |
| - [Namespace: events](#namespace-events) | |
| - [Table of contents](#table-of-contents-227) | |
| - [Type Aliases](#type-aliases-7) | |
| - [Variables](#variables-6) | |
| - [Namespace: files](#namespace-files) | |
| - [Table of contents](#table-of-contents-228) | |
| - [Type Aliases](#type-aliases-8) | |
| - [Variables](#variables-7) | |
| - [Namespace: guests](#namespace-guests) | |
| - [Table of contents](#table-of-contents-229) | |
| - [Namespace: jobs](#namespace-jobs) | |
| - [Table of contents](#table-of-contents-230) | |
| - [Type Aliases](#type-aliases-9) | |
| - [Variables](#variables-8) | |
| - [Namespace: Flatfile](#namespace-flatfile) | |
| - [Table of contents](#table-of-contents-231) | |
| - [References](#references) | |
| - [Namespace: Constraint](#namespace-constraint) | |
| - [Table of contents](#table-of-contents-232) | |
| - [Namespace: Property](#namespace-property) | |
| - [Table of contents](#table-of-contents-233) | |
| - [Namespace: property](#namespace-property) | |
| - [Table of contents](#table-of-contents-234) | |
| - [Type Aliases](#type-aliases-10) | |
| - [Variables](#variables-9) | |
| - [Namespace: records](#namespace-records) | |
| - [Table of contents](#table-of-contents-235) | |
| - [Type Aliases](#type-aliases-11) | |
| - [Variables](#variables-10) | |
| - [Namespace: sheets](#namespace-sheets) | |
| - [Table of contents](#table-of-contents-236) | |
| - [Type Aliases](#type-aliases-12) | |
| - [Variables](#variables-11) | |
| - [Namespace: spaces](#namespace-spaces) | |
| - [Table of contents](#table-of-contents-237) | |
| - [Type Aliases](#type-aliases-13) | |
| - [Variables](#variables-12) | |
| - [Namespace: users](#namespace-users) | |
| - [Table of contents](#table-of-contents-238) | |
| - [Namespace: versions](#namespace-versions) | |
| - [Table of contents](#table-of-contents-239) | |
| - [Namespace: workbooks](#namespace-workbooks) | |
| - [Table of contents](#table-of-contents-240) | |
| - [Namespace: FlatfileClient](#namespace-flatfileclient) | |
| - [Table of contents](#table-of-contents-241) | |
| <!-- END doctoc generated TOC please keep comment here to allow auto update --> | |
| <a name="readmemd"></a> | |
| @flatfile/api / [Exports](#modulesmd) | |
| # @flatfile/api | |
| <!-- START doctoc generated TOC please keep comment here to allow auto update --> | |
| <!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE --> | |
| - [Synopsis](#synopsis) | |
| - [Details](#details) | |
| - [Flatfile Node API Library](#flatfile-node-api-library) | |
| - [Documentation](#documentation) | |
| - [Installation](#installation) | |
| - [Usage](#usage) | |
| - [Handling errors](#handling-errors) | |
| - [Handling events](#handling-events) | |
| - [Fields](#fields) | |
| - [Beta status](#beta-status) | |
| - [Contributing](#contributing) | |
| - [API](#api) | |
| - [Contribution](#contribution) | |
| <!-- END doctoc generated TOC please keep comment here to allow auto update --> | |
| # Synopsis | |
| # Details | |
| <!-- usage --> | |
| <!-- commands --> | |
| # Flatfile Node API Library | |
| [](https://www.npmjs.com/package/@flatfile/api) | |
| [](https://github.com/fern-api/fern) | |
| The Flatfile Node.js library provides convenient access to the Flatfile API from JavaScript/TypeScript. | |
| ## Documentation | |
| API reference documentation is available [here](https://flatfile.stoplight.io/docs/v10). | |
| ## Installation | |
| ``` | |
| npm install --save @flatfile/api | |
| # or | |
| yarn add @flatfile/api | |
| ``` | |
| ## Usage | |
| [](https://stackblitz.com/edit/flatfile-typescript-sdk-7xtsm5?file=app.ts&view=editor) | |
| ```typescript | |
| 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](https://github.com/fern-flatfile/flatfile-node/blob/main/src/errors/FlatfileError.ts) will be thrown: | |
| ```ts | |
| 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](https://www.typescriptlang.org/docs/handbook/unions-and-intersections.html#discriminating-unions) that make it easy to handle specific events. | |
| ```ts | |
| 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](https://www.typescriptlang.org/docs/handbook/unions-and-intersections.html#discriminating-unions) that make it easy to introspect different fields. | |
| ```ts | |
| 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](https://github.com/FlatFilers/flatfile-node/issues) first to discuss with us! | |
| On the other hand, contributions to the README are always very welcome! | |
| # API | |
| # Contribution | |
| # Classes | |
| <a name="classesflatfilecommonsbadrequesterrormd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / [commons](#modulesflatfilecommonsmd) / BadRequestError | |
| ## Class: BadRequestError | |
| [Flatfile](#modulesflatfilemd).[commons](#modulesflatfilecommonsmd).BadRequestError | |
| This file was auto-generated by Fern from our API Definition. | |
| ### Hierarchy | |
| - [`FlatfileError`](#classesflatfileerrormd) | |
| ↳ **`BadRequestError`** | |
| ### Table of contents | |
| #### Constructors | |
| - [constructor](#constructor) | |
| #### Properties | |
| - [body](#body) | |
| - [message](#message) | |
| - [name](#name) | |
| - [stack](#stack) | |
| - [statusCode](#statuscode) | |
| - [prepareStackTrace](#preparestacktrace) | |
| - [stackTraceLimit](#stacktracelimit) | |
| #### Methods | |
| - [captureStackTrace](#capturestacktrace) | |
| ### Constructors | |
| #### constructor | |
| • **new BadRequestError**(`body`) | |
| ##### Parameters | |
| | Name | Type | | |
| | :------ | :------ | | |
| | `body` | [`Error_`](#interfacesflatfilecommonserror_md)[] | | |
| ##### Overrides | |
| [FlatfileError](#classesflatfileerrormd).[constructor](#constructor) | |
| ##### Defined in | |
| [src/api/resources/commons/errors/BadRequestError.ts:9](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/commons/errors/BadRequestError.ts#L9) | |
| ### Properties | |
| #### body | |
| • `Optional` `Readonly` **body**: `unknown` | |
| ##### Inherited from | |
| [FlatfileError](#classesflatfileerrormd).[body](#body) | |
| ##### Defined in | |
| [src/errors/FlatfileError.ts:7](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/errors/FlatfileError.ts#L7) | |
| ___ | |
| #### message | |
| • **message**: `string` | |
| ##### Inherited from | |
| [FlatfileError](#classesflatfileerrormd).[message](#message) | |
| ##### Defined in | |
| node_modules/typescript/lib/lib.es5.d.ts:1023 | |
| ___ | |
| #### name | |
| • **name**: `string` | |
| ##### Inherited from | |
| [FlatfileError](#classesflatfileerrormd).[name](#name) | |
| ##### Defined in | |
| node_modules/typescript/lib/lib.es5.d.ts:1022 | |
| ___ | |
| #### stack | |
| • `Optional` **stack**: `string` | |
| ##### Inherited from | |
| [FlatfileError](#classesflatfileerrormd).[stack](#stack) | |
| ##### Defined in | |
| node_modules/typescript/lib/lib.es5.d.ts:1024 | |
| ___ | |
| #### statusCode | |
| • `Optional` `Readonly` **statusCode**: `number` | |
| ##### Inherited from | |
| [FlatfileError](#classesflatfileerrormd).[statusCode](#statuscode) | |
| ##### Defined in | |
| [src/errors/FlatfileError.ts:6](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/errors/FlatfileError.ts#L6) | |
| ___ | |
| #### 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](#classesflatfileerrormd).[prepareStackTrace](#preparestacktrace) | |
| ##### Defined in | |
| node_modules/@types/node/globals.d.ts:11 | |
| ___ | |
| #### stackTraceLimit | |
| ▪ `Static` **stackTraceLimit**: `number` | |
| ##### Inherited from | |
| [FlatfileError](#classesflatfileerrormd).[stackTraceLimit](#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](#classesflatfileerrormd).[captureStackTrace](#capturestacktrace) | |
| ##### Defined in | |
| node_modules/@types/node/globals.d.ts:4 | |
| <a name="classesflatfilecommonsnotfounderrormd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / [commons](#modulesflatfilecommonsmd) / NotFoundError | |
| ## Class: NotFoundError | |
| [Flatfile](#modulesflatfilemd).[commons](#modulesflatfilecommonsmd).NotFoundError | |
| This file was auto-generated by Fern from our API Definition. | |
| ### Hierarchy | |
| - [`FlatfileError`](#classesflatfileerrormd) | |
| ↳ **`NotFoundError`** | |
| ### Table of contents | |
| #### Constructors | |
| - [constructor](#constructor) | |
| #### Properties | |
| - [body](#body) | |
| - [message](#message) | |
| - [name](#name) | |
| - [stack](#stack) | |
| - [statusCode](#statuscode) | |
| - [prepareStackTrace](#preparestacktrace) | |
| - [stackTraceLimit](#stacktracelimit) | |
| #### Methods | |
| - [captureStackTrace](#capturestacktrace) | |
| ### Constructors | |
| #### constructor | |
| • **new NotFoundError**(`body`) | |
| ##### Parameters | |
| | Name | Type | | |
| | :------ | :------ | | |
| | `body` | [`Error_`](#interfacesflatfilecommonserror_md)[] | | |
| ##### Overrides | |
| [FlatfileError](#classesflatfileerrormd).[constructor](#constructor) | |
| ##### Defined in | |
| [src/api/resources/commons/errors/NotFoundError.ts:9](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/commons/errors/NotFoundError.ts#L9) | |
| ### Properties | |
| #### body | |
| • `Optional` `Readonly` **body**: `unknown` | |
| ##### Inherited from | |
| [FlatfileError](#classesflatfileerrormd).[body](#body) | |
| ##### Defined in | |
| [src/errors/FlatfileError.ts:7](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/errors/FlatfileError.ts#L7) | |
| ___ | |
| #### message | |
| • **message**: `string` | |
| ##### Inherited from | |
| [FlatfileError](#classesflatfileerrormd).[message](#message) | |
| ##### Defined in | |
| node_modules/typescript/lib/lib.es5.d.ts:1023 | |
| ___ | |
| #### name | |
| • **name**: `string` | |
| ##### Inherited from | |
| [FlatfileError](#classesflatfileerrormd).[name](#name) | |
| ##### Defined in | |
| node_modules/typescript/lib/lib.es5.d.ts:1022 | |
| ___ | |
| #### stack | |
| • `Optional` **stack**: `string` | |
| ##### Inherited from | |
| [FlatfileError](#classesflatfileerrormd).[stack](#stack) | |
| ##### Defined in | |
| node_modules/typescript/lib/lib.es5.d.ts:1024 | |
| ___ | |
| #### statusCode | |
| • `Optional` `Readonly` **statusCode**: `number` | |
| ##### Inherited from | |
| [FlatfileError](#classesflatfileerrormd).[statusCode](#statuscode) | |
| ##### Defined in | |
| [src/errors/FlatfileError.ts:6](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/errors/FlatfileError.ts#L6) | |
| ___ | |
| #### 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](#classesflatfileerrormd).[prepareStackTrace](#preparestacktrace) | |
| ##### Defined in | |
| node_modules/@types/node/globals.d.ts:11 | |
| ___ | |
| #### stackTraceLimit | |
| ▪ `Static` **stackTraceLimit**: `number` | |
| ##### Inherited from | |
| [FlatfileError](#classesflatfileerrormd).[stackTraceLimit](#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](#classesflatfileerrormd).[captureStackTrace](#capturestacktrace) | |
| ##### Defined in | |
| node_modules/@types/node/globals.d.ts:4 | |
| <a name="classesflatfileclient-1md"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / FlatfileClient | |
| ## Class: FlatfileClient | |
| ### Hierarchy | |
| - `FlatfileClient` | |
| ↳ **`FlatfileClient`** | |
| ### Table of contents | |
| #### Constructors | |
| - [constructor](#constructor) | |
| #### Properties | |
| - [\_agents](#_agents) | |
| - [\_auth](#_auth) | |
| - [\_billing](#_billing) | |
| - [\_cells](#_cells) | |
| - [\_documents](#_documents) | |
| - [\_environments](#_environments) | |
| - [\_events](#_events) | |
| - [\_files](#_files) | |
| - [\_guests](#_guests) | |
| - [\_jobs](#_jobs) | |
| - [\_records](#_records) | |
| - [\_sheets](#_sheets) | |
| - [\_spaces](#_spaces) | |
| - [\_users](#_users) | |
| - [\_versions](#_versions) | |
| - [\_workbooks](#_workbooks) | |
| - [options](#options) | |
| - [token](#token) | |
| #### Accessors | |
| - [agents](#agents) | |
| - [auth](#auth) | |
| - [billing](#billing) | |
| - [cells](#cells) | |
| - [documents](#documents) | |
| - [environments](#environments) | |
| - [events](#events) | |
| - [files](#files) | |
| - [guests](#guests) | |
| - [jobs](#jobs) | |
| - [records](#records) | |
| - [sheets](#sheets) | |
| - [spaces](#spaces) | |
| - [users](#users) | |
| - [versions](#versions) | |
| - [workbooks](#workbooks) | |
| ### Constructors | |
| #### constructor | |
| • **new FlatfileClient**(`options?`) | |
| ##### Parameters | |
| | Name | Type | | |
| | :------ | :------ | | |
| | `options` | [`Options`](#interfacesflatfileclientoptionsmd) | | |
| ##### Overrides | |
| FernClient.constructor | |
| ##### Defined in | |
| [src/wrapper/FlatfileClient.ts:24](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/wrapper/FlatfileClient.ts#L24) | |
| ### Properties | |
| #### \_agents | |
| • `Protected` **\_agents**: `undefined` \| `Agents` | |
| ##### Inherited from | |
| FernClient.\_agents | |
| ##### Defined in | |
| [src/Client.ts:42](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/Client.ts#L42) | |
| ___ | |
| #### \_auth | |
| • `Protected` **\_auth**: `undefined` \| `Auth` | |
| ##### Inherited from | |
| FernClient.\_auth | |
| ##### Defined in | |
| [src/Client.ts:48](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/Client.ts#L48) | |
| ___ | |
| #### \_billing | |
| • `Protected` **\_billing**: `undefined` \| `Billing` | |
| ##### Inherited from | |
| FernClient.\_billing | |
| ##### Defined in | |
| [src/Client.ts:54](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/Client.ts#L54) | |
| ___ | |
| #### \_cells | |
| • `Protected` **\_cells**: `undefined` \| `Cells` | |
| ##### Inherited from | |
| FernClient.\_cells | |
| ##### Defined in | |
| [src/Client.ts:60](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/Client.ts#L60) | |
| ___ | |
| #### \_documents | |
| • `Protected` **\_documents**: `undefined` \| `Documents` | |
| ##### Inherited from | |
| FernClient.\_documents | |
| ##### Defined in | |
| [src/Client.ts:66](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/Client.ts#L66) | |
| ___ | |
| #### \_environments | |
| • `Protected` **\_environments**: `undefined` \| `Environments` | |
| ##### Inherited from | |
| FernClient.\_environments | |
| ##### Defined in | |
| [src/Client.ts:72](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/Client.ts#L72) | |
| ___ | |
| #### \_events | |
| • `Protected` **\_events**: `undefined` \| `Events` | |
| ##### Inherited from | |
| FernClient.\_events | |
| ##### Defined in | |
| [src/Client.ts:78](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/Client.ts#L78) | |
| ___ | |
| #### \_files | |
| • `Protected` **\_files**: `undefined` \| `Files` | |
| ##### Inherited from | |
| FernClient.\_files | |
| ##### Defined in | |
| [src/Client.ts:84](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/Client.ts#L84) | |
| ___ | |
| #### \_guests | |
| • `Protected` **\_guests**: `undefined` \| `Guests` | |
| ##### Inherited from | |
| FernClient.\_guests | |
| ##### Defined in | |
| [src/Client.ts:90](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/Client.ts#L90) | |
| ___ | |
| #### \_jobs | |
| • `Protected` **\_jobs**: `undefined` \| `Jobs` | |
| ##### Inherited from | |
| FernClient.\_jobs | |
| ##### Defined in | |
| [src/Client.ts:96](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/Client.ts#L96) | |
| ___ | |
| #### \_records | |
| • `Protected` **\_records**: `undefined` \| `Records` | |
| ##### Inherited from | |
| FernClient.\_records | |
| ##### Defined in | |
| [src/Client.ts:102](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/Client.ts#L102) | |
| ___ | |
| #### \_sheets | |
| • `Protected` **\_sheets**: `undefined` \| `Sheets` | |
| ##### Inherited from | |
| FernClient.\_sheets | |
| ##### Defined in | |
| [src/Client.ts:108](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/Client.ts#L108) | |
| ___ | |
| #### \_spaces | |
| • `Protected` **\_spaces**: `undefined` \| `Spaces` | |
| ##### Inherited from | |
| FernClient.\_spaces | |
| ##### Defined in | |
| [src/Client.ts:36](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/Client.ts#L36) | |
| ___ | |
| #### \_users | |
| • `Protected` **\_users**: `undefined` \| `Users` | |
| ##### Inherited from | |
| FernClient.\_users | |
| ##### Defined in | |
| [src/Client.ts:114](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/Client.ts#L114) | |
| ___ | |
| #### \_versions | |
| • `Protected` **\_versions**: `undefined` \| `Versions` | |
| ##### Inherited from | |
| FernClient.\_versions | |
| ##### Defined in | |
| [src/Client.ts:120](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/Client.ts#L120) | |
| ___ | |
| #### \_workbooks | |
| • `Protected` **\_workbooks**: `undefined` \| `Workbooks` | |
| ##### Inherited from | |
| FernClient.\_workbooks | |
| ##### Defined in | |
| [src/Client.ts:126](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/Client.ts#L126) | |
| ___ | |
| #### options | |
| • `Protected` `Readonly` **options**: `Options` | |
| ##### Inherited from | |
| FernClient.options | |
| ##### Defined in | |
| [src/Client.ts:34](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/Client.ts#L34) | |
| ___ | |
| #### token | |
| • `Private` **token**: `undefined` \| `string` | |
| ##### Defined in | |
| [src/wrapper/FlatfileClient.ts:22](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/wrapper/FlatfileClient.ts#L22) | |
| ### Accessors | |
| #### agents | |
| • `get` **agents**(): `Agents` | |
| ##### Returns | |
| `Agents` | |
| ##### Inherited from | |
| FernClient.agents | |
| ##### Defined in | |
| [src/Client.ts:44](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/Client.ts#L44) | |
| ___ | |
| #### auth | |
| • `get` **auth**(): `Auth` | |
| ##### Returns | |
| `Auth` | |
| ##### Inherited from | |
| FernClient.auth | |
| ##### Defined in | |
| [src/Client.ts:50](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/Client.ts#L50) | |
| ___ | |
| #### billing | |
| • `get` **billing**(): `Billing` | |
| ##### Returns | |
| `Billing` | |
| ##### Inherited from | |
| FernClient.billing | |
| ##### Defined in | |
| [src/Client.ts:56](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/Client.ts#L56) | |
| ___ | |
| #### cells | |
| • `get` **cells**(): `Cells` | |
| ##### Returns | |
| `Cells` | |
| ##### Inherited from | |
| FernClient.cells | |
| ##### Defined in | |
| [src/Client.ts:62](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/Client.ts#L62) | |
| ___ | |
| #### documents | |
| • `get` **documents**(): `Documents` | |
| ##### Returns | |
| `Documents` | |
| ##### Inherited from | |
| FernClient.documents | |
| ##### Defined in | |
| [src/Client.ts:68](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/Client.ts#L68) | |
| ___ | |
| #### environments | |
| • `get` **environments**(): `Environments` | |
| ##### Returns | |
| `Environments` | |
| ##### Inherited from | |
| FernClient.environments | |
| ##### Defined in | |
| [src/Client.ts:74](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/Client.ts#L74) | |
| ___ | |
| #### events | |
| • `get` **events**(): `Events` | |
| ##### Returns | |
| `Events` | |
| ##### Inherited from | |
| FernClient.events | |
| ##### Defined in | |
| [src/Client.ts:80](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/Client.ts#L80) | |
| ___ | |
| #### files | |
| • `get` **files**(): `Files` | |
| ##### Returns | |
| `Files` | |
| ##### Inherited from | |
| FernClient.files | |
| ##### Defined in | |
| [src/Client.ts:86](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/Client.ts#L86) | |
| ___ | |
| #### guests | |
| • `get` **guests**(): `Guests` | |
| ##### Returns | |
| `Guests` | |
| ##### Inherited from | |
| FernClient.guests | |
| ##### Defined in | |
| [src/Client.ts:92](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/Client.ts#L92) | |
| ___ | |
| #### jobs | |
| • `get` **jobs**(): `Jobs` | |
| ##### Returns | |
| `Jobs` | |
| ##### Inherited from | |
| FernClient.jobs | |
| ##### Defined in | |
| [src/Client.ts:98](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/Client.ts#L98) | |
| ___ | |
| #### records | |
| • `get` **records**(): `Records` | |
| ##### Returns | |
| `Records` | |
| ##### Inherited from | |
| FernClient.records | |
| ##### Defined in | |
| [src/Client.ts:104](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/Client.ts#L104) | |
| ___ | |
| #### sheets | |
| • `get` **sheets**(): `Sheets` | |
| ##### Returns | |
| `Sheets` | |
| ##### Inherited from | |
| FernClient.sheets | |
| ##### Defined in | |
| [src/Client.ts:110](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/Client.ts#L110) | |
| ___ | |
| #### spaces | |
| • `get` **spaces**(): `Spaces` | |
| ##### Returns | |
| `Spaces` | |
| ##### Inherited from | |
| FernClient.spaces | |
| ##### Defined in | |
| [src/Client.ts:38](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/Client.ts#L38) | |
| ___ | |
| #### users | |
| • `get` **users**(): `Users` | |
| ##### Returns | |
| `Users` | |
| ##### Inherited from | |
| FernClient.users | |
| ##### Defined in | |
| [src/Client.ts:116](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/Client.ts#L116) | |
| ___ | |
| #### versions | |
| • `get` **versions**(): `Versions` | |
| ##### Returns | |
| `Versions` | |
| ##### Inherited from | |
| FernClient.versions | |
| ##### Defined in | |
| [src/Client.ts:122](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/Client.ts#L122) | |
| ___ | |
| #### workbooks | |
| • `get` **workbooks**(): `Workbooks` | |
| ##### Returns | |
| `Workbooks` | |
| ##### Inherited from | |
| FernClient.workbooks | |
| ##### Defined in | |
| [src/Client.ts:128](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/Client.ts#L128) | |
| <a name="classesflatfileerrormd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / FlatfileError | |
| ## Class: FlatfileError | |
| This file was auto-generated by Fern from our API Definition. | |
| ### Hierarchy | |
| - `Error` | |
| ↳ **`FlatfileError`** | |
| ↳↳ [`BadRequestError`](#classesflatfilecommonsbadrequesterrormd) | |
| ↳↳ [`NotFoundError`](#classesflatfilecommonsnotfounderrormd) | |
| ### Table of contents | |
| #### Constructors | |
| - [constructor](#constructor) | |
| #### Properties | |
| - [body](#body) | |
| - [message](#message) | |
| - [name](#name) | |
| - [stack](#stack) | |
| - [statusCode](#statuscode) | |
| - [prepareStackTrace](#preparestacktrace) | |
| - [stackTraceLimit](#stacktracelimit) | |
| #### Methods | |
| - [captureStackTrace](#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](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/errors/FlatfileError.ts#L9) | |
| ### Properties | |
| #### body | |
| • `Optional` `Readonly` **body**: `unknown` | |
| ##### Defined in | |
| [src/errors/FlatfileError.ts:7](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/errors/FlatfileError.ts#L7) | |
| ___ | |
| #### 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](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/errors/FlatfileError.ts#L6) | |
| ___ | |
| #### 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 | |
| <a name="classesflatfiletimeouterrormd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / FlatfileTimeoutError | |
| ## Class: FlatfileTimeoutError | |
| This file was auto-generated by Fern from our API Definition. | |
| ### Hierarchy | |
| - `Error` | |
| ↳ **`FlatfileTimeoutError`** | |
| ### Table of contents | |
| #### Constructors | |
| - [constructor](#constructor) | |
| #### Properties | |
| - [message](#message) | |
| - [name](#name) | |
| - [stack](#stack) | |
| - [prepareStackTrace](#preparestacktrace) | |
| - [stackTraceLimit](#stacktracelimit) | |
| #### Methods | |
| - [captureStackTrace](#capturestacktrace) | |
| ### Constructors | |
| #### constructor | |
| • **new FlatfileTimeoutError**() | |
| ##### Overrides | |
| Error.constructor | |
| ##### Defined in | |
| [src/errors/FlatfileTimeoutError.ts:6](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/errors/FlatfileTimeoutError.ts#L6) | |
| ### 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 | |
| <a name="interfacesflatfileagentsagentmd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / [agents](#modulesflatfileagentsmd) / Agent | |
| ## Interface: Agent | |
| [Flatfile](#modulesflatfilemd).[agents](#modulesflatfileagentsmd).Agent | |
| **`Example`** | |
| ```ts | |
| { | |
| * id: "123", | |
| * topics: [Flatfile.EventTopic.FileCreated], | |
| * compiler: Flatfile.Compiler.Js, | |
| * source: "module.exports = { routeEvent: async (...args) => { console.log(args) } }" | |
| * } | |
| ``` | |
| ### Hierarchy | |
| - [`AgentConfig`](#interfacesflatfileagentsagentconfigmd) | |
| ↳ **`Agent`** | |
| ### Table of contents | |
| #### Properties | |
| - [compiler](#compiler) | |
| - [id](#id) | |
| - [source](#source) | |
| - [topics](#topics) | |
| ### Properties | |
| #### compiler | |
| • `Optional` **compiler**: ``"js"`` | |
| The compiler of the agent | |
| ##### Inherited from | |
| [AgentConfig](#interfacesflatfileagentsagentconfigmd).[compiler](#compiler) | |
| ##### Defined in | |
| [src/api/resources/agents/types/AgentConfig.ts:21](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/agents/types/AgentConfig.ts#L21) | |
| ___ | |
| #### id | |
| • **id**: `string` | |
| ##### Defined in | |
| [src/api/resources/agents/types/Agent.ts:17](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/agents/types/Agent.ts#L17) | |
| ___ | |
| #### source | |
| • `Optional` **source**: `string` | |
| The source of the agent | |
| ##### Inherited from | |
| [AgentConfig](#interfacesflatfileagentsagentconfigmd).[source](#source) | |
| ##### Defined in | |
| [src/api/resources/agents/types/AgentConfig.ts:23](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/agents/types/AgentConfig.ts#L23) | |
| ___ | |
| #### topics | |
| • `Optional` **topics**: [`EventTopic`](#eventtopic-1)[] | |
| The topics the agent should listen for | |
| ##### Inherited from | |
| [AgentConfig](#interfacesflatfileagentsagentconfigmd).[topics](#topics) | |
| ##### Defined in | |
| [src/api/resources/agents/types/AgentConfig.ts:19](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/agents/types/AgentConfig.ts#L19) | |
| <a name="interfacesflatfileagentsagentconfigmd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / [agents](#modulesflatfileagentsmd) / AgentConfig | |
| ## Interface: AgentConfig | |
| [Flatfile](#modulesflatfilemd).[agents](#modulesflatfileagentsmd).AgentConfig | |
| Properties used to create a new agent | |
| **`Example`** | |
| ```ts | |
| { | |
| * topics: [Flatfile.EventTopic.FileCreated], | |
| * compiler: Flatfile.Compiler.Js, | |
| * source: "module.exports = { routeEvent: async (...args) => { console.log(args) } }" | |
| * } | |
| ``` | |
| ### Hierarchy | |
| - **`AgentConfig`** | |
| ↳ [`Agent`](#interfacesflatfileagentsagentmd) | |
| ### Table of contents | |
| #### Properties | |
| - [compiler](#compiler) | |
| - [source](#source) | |
| - [topics](#topics) | |
| ### Properties | |
| #### compiler | |
| • `Optional` **compiler**: ``"js"`` | |
| The compiler of the agent | |
| ##### Defined in | |
| [src/api/resources/agents/types/AgentConfig.ts:21](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/agents/types/AgentConfig.ts#L21) | |
| ___ | |
| #### source | |
| • `Optional` **source**: `string` | |
| The source of the agent | |
| ##### Defined in | |
| [src/api/resources/agents/types/AgentConfig.ts:23](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/agents/types/AgentConfig.ts#L23) | |
| ___ | |
| #### topics | |
| • `Optional` **topics**: [`EventTopic`](#eventtopic-1)[] | |
| The topics the agent should listen for | |
| ##### Defined in | |
| [src/api/resources/agents/types/AgentConfig.ts:19](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/agents/types/AgentConfig.ts#L19) | |
| <a name="interfacesflatfileagentsagentlogmd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / [agents](#modulesflatfileagentsmd) / AgentLog | |
| ## Interface: AgentLog | |
| [Flatfile](#modulesflatfilemd).[agents](#modulesflatfileagentsmd).AgentLog | |
| A log of an agent execution | |
| **`Example`** | |
| ```ts | |
| { | |
| * 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](#completedat) | |
| - [createdAt](#createdat) | |
| - [eventId](#eventid) | |
| - [log](#log) | |
| - [success](#success) | |
| ### Properties | |
| #### completedAt | |
| • **completedAt**: `Date` | |
| ##### Defined in | |
| [src/api/resources/agents/types/AgentLog.ts:24](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/agents/types/AgentLog.ts#L24) | |
| ___ | |
| #### createdAt | |
| • **createdAt**: `Date` | |
| ##### Defined in | |
| [src/api/resources/agents/types/AgentLog.ts:23](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/agents/types/AgentLog.ts#L23) | |
| ___ | |
| #### eventId | |
| • **eventId**: `string` | |
| ##### Defined in | |
| [src/api/resources/agents/types/AgentLog.ts:20](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/agents/types/AgentLog.ts#L20) | |
| ___ | |
| #### log | |
| • `Optional` **log**: `string` | |
| The log of the agent execution | |
| ##### Defined in | |
| [src/api/resources/agents/types/AgentLog.ts:26](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/agents/types/AgentLog.ts#L26) | |
| ___ | |
| #### success | |
| • **success**: `boolean` | |
| Whether the agent execution was successful | |
| ##### Defined in | |
| [src/api/resources/agents/types/AgentLog.ts:22](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/agents/types/AgentLog.ts#L22) | |
| <a name="interfacesflatfileagentsagentresponsemd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / [agents](#modulesflatfileagentsmd) / AgentResponse | |
| ## Interface: AgentResponse | |
| [Flatfile](#modulesflatfilemd).[agents](#modulesflatfileagentsmd).AgentResponse | |
| **`Example`** | |
| ```ts | |
| { | |
| * 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](#data) | |
| ### Properties | |
| #### data | |
| • **data**: [`Agent`](#interfacesflatfileagentsagentmd) | |
| ##### Defined in | |
| [src/api/resources/agents/types/AgentResponse.ts:19](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/agents/types/AgentResponse.ts#L19) | |
| <a name="interfacesflatfileagentscreateagentsrequestmd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / [agents](#modulesflatfileagentsmd) / CreateAgentsRequest | |
| ## Interface: CreateAgentsRequest | |
| [Flatfile](#modulesflatfilemd).[agents](#modulesflatfileagentsmd).CreateAgentsRequest | |
| ### Table of contents | |
| #### Properties | |
| - [body](#body) | |
| - [environmentId](#environmentid) | |
| ### Properties | |
| #### body | |
| • **body**: [`AgentConfig`](#interfacesflatfileagentsagentconfigmd) | |
| ##### Defined in | |
| [src/api/resources/agents/client/requests/CreateAgentsRequest.ts:9](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/agents/client/requests/CreateAgentsRequest.ts#L9) | |
| ___ | |
| #### environmentId | |
| • **environmentId**: `string` | |
| ##### Defined in | |
| [src/api/resources/agents/client/requests/CreateAgentsRequest.ts:8](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/agents/client/requests/CreateAgentsRequest.ts#L8) | |
| <a name="interfacesflatfileagentsdeleteagentrequestmd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / [agents](#modulesflatfileagentsmd) / DeleteAgentRequest | |
| ## Interface: DeleteAgentRequest | |
| [Flatfile](#modulesflatfilemd).[agents](#modulesflatfileagentsmd).DeleteAgentRequest | |
| ### Table of contents | |
| #### Properties | |
| - [body](#body) | |
| - [environmentId](#environmentid) | |
| ### Properties | |
| #### body | |
| • **body**: [`AgentConfig`](#interfacesflatfileagentsagentconfigmd) | |
| ##### Defined in | |
| [src/api/resources/agents/client/requests/DeleteAgentRequest.ts:9](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/agents/client/requests/DeleteAgentRequest.ts#L9) | |
| ___ | |
| #### environmentId | |
| • **environmentId**: `string` | |
| ##### Defined in | |
| [src/api/resources/agents/client/requests/DeleteAgentRequest.ts:8](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/agents/client/requests/DeleteAgentRequest.ts#L8) | |
| <a name="interfacesflatfileagentsgetagentlogsrequestmd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / [agents](#modulesflatfileagentsmd) / GetAgentLogsRequest | |
| ## Interface: GetAgentLogsRequest | |
| [Flatfile](#modulesflatfilemd).[agents](#modulesflatfileagentsmd).GetAgentLogsRequest | |
| ### Table of contents | |
| #### Properties | |
| - [environmentId](#environmentid) | |
| ### Properties | |
| #### environmentId | |
| • **environmentId**: `string` | |
| ##### Defined in | |
| [src/api/resources/agents/client/requests/GetAgentLogsRequest.ts:8](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/agents/client/requests/GetAgentLogsRequest.ts#L8) | |
| <a name="interfacesflatfileagentsgetagentlogsresponsemd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / [agents](#modulesflatfileagentsmd) / GetAgentLogsResponse | |
| ## Interface: GetAgentLogsResponse | |
| [Flatfile](#modulesflatfilemd).[agents](#modulesflatfileagentsmd).GetAgentLogsResponse | |
| **`Example`** | |
| ```ts | |
| { | |
| * 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](#data) | |
| - [pagination](#pagination) | |
| ### Properties | |
| #### data | |
| • **data**: [`AgentLog`](#interfacesflatfileagentsagentlogmd)[] | |
| ##### Defined in | |
| [src/api/resources/agents/types/GetAgentLogsResponse.ts:26](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/agents/types/GetAgentLogsResponse.ts#L26) | |
| ___ | |
| #### pagination | |
| • `Optional` **pagination**: [`Pagination`](#interfacesflatfilecommonspaginationmd) | |
| ##### Defined in | |
| [src/api/resources/agents/types/GetAgentLogsResponse.ts:25](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/agents/types/GetAgentLogsResponse.ts#L25) | |
| <a name="interfacesflatfileagentsgetagentrequestmd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / [agents](#modulesflatfileagentsmd) / GetAgentRequest | |
| ## Interface: GetAgentRequest | |
| [Flatfile](#modulesflatfilemd).[agents](#modulesflatfileagentsmd).GetAgentRequest | |
| ### Table of contents | |
| #### Properties | |
| - [environmentId](#environmentid) | |
| ### Properties | |
| #### environmentId | |
| • **environmentId**: `string` | |
| ##### Defined in | |
| [src/api/resources/agents/client/requests/GetAgentRequest.ts:8](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/agents/client/requests/GetAgentRequest.ts#L8) | |
| <a name="interfacesflatfileagentsgetenvironmentagentlogsrequestmd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / [agents](#modulesflatfileagentsmd) / GetEnvironmentAgentLogsRequest | |
| ## Interface: GetEnvironmentAgentLogsRequest | |
| [Flatfile](#modulesflatfilemd).[agents](#modulesflatfileagentsmd).GetEnvironmentAgentLogsRequest | |
| ### Table of contents | |
| #### Properties | |
| - [environmentId](#environmentid) | |
| - [pageNumber](#pagenumber) | |
| - [pageSize](#pagesize) | |
| ### Properties | |
| #### environmentId | |
| • **environmentId**: `string` | |
| ##### Defined in | |
| [src/api/resources/agents/client/requests/GetEnvironmentAgentLogsRequest.ts:8](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/agents/client/requests/GetEnvironmentAgentLogsRequest.ts#L8) | |
| ___ | |
| #### pageNumber | |
| • `Optional` **pageNumber**: `number` | |
| Based on pageSize, which page of records to return | |
| ##### Defined in | |
| [src/api/resources/agents/client/requests/GetEnvironmentAgentLogsRequest.ts:16](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/agents/client/requests/GetEnvironmentAgentLogsRequest.ts#L16) | |
| ___ | |
| #### 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](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/agents/client/requests/GetEnvironmentAgentLogsRequest.ts#L12) | |
| <a name="interfacesflatfileagentslistagentsrequestmd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / [agents](#modulesflatfileagentsmd) / ListAgentsRequest | |
| ## Interface: ListAgentsRequest | |
| [Flatfile](#modulesflatfilemd).[agents](#modulesflatfileagentsmd).ListAgentsRequest | |
| ### Table of contents | |
| #### Properties | |
| - [environmentId](#environmentid) | |
| ### Properties | |
| #### environmentId | |
| • **environmentId**: `string` | |
| ##### Defined in | |
| [src/api/resources/agents/client/requests/ListAgentsRequest.ts:8](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/agents/client/requests/ListAgentsRequest.ts#L8) | |
| <a name="interfacesflatfileagentslistagentsresponsemd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / [agents](#modulesflatfileagentsmd) / ListAgentsResponse | |
| ## Interface: ListAgentsResponse | |
| [Flatfile](#modulesflatfilemd).[agents](#modulesflatfileagentsmd).ListAgentsResponse | |
| **`Example`** | |
| ```ts | |
| { | |
| * 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](#data) | |
| ### Properties | |
| #### data | |
| • **data**: [`Agent`](#interfacesflatfileagentsagentmd)[] | |
| ##### Defined in | |
| [src/api/resources/agents/types/ListAgentsResponse.ts:19](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/agents/types/ListAgentsResponse.ts#L19) | |
| <a name="interfacesflatfileauthapikeymd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / [auth](#modulesflatfileauthmd) / ApiKey | |
| ## Interface: ApiKey | |
| [Flatfile](#modulesflatfilemd).[auth](#modulesflatfileauthmd).ApiKey | |
| API Key used for authenticating against our APIs | |
| ### Table of contents | |
| #### Properties | |
| - [accountId](#accountid) | |
| - [createdAt](#createdat) | |
| - [environmentId](#environmentid) | |
| - [expireAt](#expireat) | |
| - [id](#id) | |
| - [operations](#operations) | |
| - [rawKey](#rawkey) | |
| - [secret](#secret) | |
| - [type](#type) | |
| - [updatedAt](#updatedat) | |
| ### Properties | |
| #### accountId | |
| • `Optional` **accountId**: `string` | |
| ##### Defined in | |
| [src/api/resources/auth/types/ApiKey.ts:15](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/auth/types/ApiKey.ts#L15) | |
| ___ | |
| #### createdAt | |
| • **createdAt**: `Date` | |
| ##### Defined in | |
| [src/api/resources/auth/types/ApiKey.ts:17](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/auth/types/ApiKey.ts#L17) | |
| ___ | |
| #### environmentId | |
| • `Optional` **environmentId**: `string` | |
| ##### Defined in | |
| [src/api/resources/auth/types/ApiKey.ts:14](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/auth/types/ApiKey.ts#L14) | |
| ___ | |
| #### expireAt | |
| • **expireAt**: `Date` | |
| ##### Defined in | |
| [src/api/resources/auth/types/ApiKey.ts:19](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/auth/types/ApiKey.ts#L19) | |
| ___ | |
| #### id | |
| • **id**: `string` | |
| ##### Defined in | |
| [src/api/resources/auth/types/ApiKey.ts:11](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/auth/types/ApiKey.ts#L11) | |
| ___ | |
| #### operations | |
| • **operations**: [`ApiKeyOperation`](#interfacesflatfileauthapikeyoperationmd)[] | |
| ##### Defined in | |
| [src/api/resources/auth/types/ApiKey.ts:16](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/auth/types/ApiKey.ts#L16) | |
| ___ | |
| #### rawKey | |
| • **rawKey**: `string` | |
| ##### Defined in | |
| [src/api/resources/auth/types/ApiKey.ts:12](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/auth/types/ApiKey.ts#L12) | |
| ___ | |
| #### secret | |
| • `Optional` **secret**: `string` | |
| ##### Defined in | |
| [src/api/resources/auth/types/ApiKey.ts:20](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/auth/types/ApiKey.ts#L20) | |
| ___ | |
| #### type | |
| • **type**: [`ApiKeyType`](#apikeytype-1) | |
| ##### Defined in | |
| [src/api/resources/auth/types/ApiKey.ts:13](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/auth/types/ApiKey.ts#L13) | |
| ___ | |
| #### updatedAt | |
| • `Optional` **updatedAt**: `Date` | |
| ##### Defined in | |
| [src/api/resources/auth/types/ApiKey.ts:18](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/auth/types/ApiKey.ts#L18) | |
| <a name="interfacesflatfileauthapikeyoperationmd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / [auth](#modulesflatfileauthmd) / ApiKeyOperation | |
| ## Interface: ApiKeyOperation | |
| [Flatfile](#modulesflatfilemd).[auth](#modulesflatfileauthmd).ApiKeyOperation | |
| This file was auto-generated by Fern from our API Definition. | |
| ### Table of contents | |
| #### Properties | |
| - [method](#method) | |
| - [path](#path) | |
| ### Properties | |
| #### method | |
| • **method**: `string` | |
| ##### Defined in | |
| [src/api/resources/auth/types/ApiKeyOperation.ts:7](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/auth/types/ApiKeyOperation.ts#L7) | |
| ___ | |
| #### path | |
| • **path**: `string` | |
| ##### Defined in | |
| [src/api/resources/auth/types/ApiKeyOperation.ts:6](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/auth/types/ApiKeyOperation.ts#L6) | |
| <a name="interfacesflatfileauthapikeysresponsemd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / [auth](#modulesflatfileauthmd) / ApiKeysResponse | |
| ## Interface: ApiKeysResponse | |
| [Flatfile](#modulesflatfilemd).[auth](#modulesflatfileauthmd).ApiKeysResponse | |
| ### Table of contents | |
| #### Properties | |
| - [data](#data) | |
| ### Properties | |
| #### data | |
| • **data**: [`ApiKey`](#interfacesflatfileauthapikeymd)[] | |
| ##### Defined in | |
| [src/api/resources/auth/types/ApiKeysResponse.ts:8](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/auth/types/ApiKeysResponse.ts#L8) | |
| <a name="interfacesflatfileauthgetapikeysrequestmd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / [auth](#modulesflatfileauthmd) / GetApiKeysRequest | |
| ## Interface: GetApiKeysRequest | |
| [Flatfile](#modulesflatfilemd).[auth](#modulesflatfileauthmd).GetApiKeysRequest | |
| ### Table of contents | |
| #### Properties | |
| - [environmentId](#environmentid) | |
| ### Properties | |
| #### environmentId | |
| • **environmentId**: `string` | |
| ID of environment to search | |
| ##### Defined in | |
| [src/api/resources/auth/client/requests/GetApiKeysRequest.ts:11](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/auth/client/requests/GetApiKeysRequest.ts#L11) | |
| <a name="interfacesflatfilebillingcheckoutsessionmd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / [billing](#modulesflatfilebillingmd) / CheckoutSession | |
| ## Interface: CheckoutSession | |
| [Flatfile](#modulesflatfilemd).[billing](#modulesflatfilebillingmd).CheckoutSession | |
| A Checkout Session as returned by Stripe | |
| ### Table of contents | |
| #### Properties | |
| - [id](#id) | |
| - [object](#object) | |
| ### Properties | |
| #### id | |
| • `Optional` **id**: `string` | |
| ##### Defined in | |
| [src/api/resources/billing/types/CheckoutSession.ts:9](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/billing/types/CheckoutSession.ts#L9) | |
| ___ | |
| #### object | |
| • `Optional` **object**: `string` | |
| ##### Defined in | |
| [src/api/resources/billing/types/CheckoutSession.ts:10](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/billing/types/CheckoutSession.ts#L10) | |
| <a name="interfacesflatfilebillingcreatecheckoutsessionresponsemd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / [billing](#modulesflatfilebillingmd) / CreateCheckoutSessionResponse | |
| ## Interface: CreateCheckoutSessionResponse | |
| [Flatfile](#modulesflatfilemd).[billing](#modulesflatfilebillingmd).CreateCheckoutSessionResponse | |
| ### Table of contents | |
| #### Properties | |
| - [data](#data) | |
| ### Properties | |
| #### data | |
| • **data**: [`CheckoutSession`](#interfacesflatfilebillingcheckoutsessionmd) | |
| ##### Defined in | |
| [src/api/resources/billing/types/CreateCheckoutSessionResponse.ts:8](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/billing/types/CreateCheckoutSessionResponse.ts#L8) | |
| <a name="interfacesflatfilebillingproductsresponsemd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / [billing](#modulesflatfilebillingmd) / ProductsResponse | |
| ## Interface: ProductsResponse | |
| [Flatfile](#modulesflatfilemd).[billing](#modulesflatfilebillingmd).ProductsResponse | |
| ### Table of contents | |
| #### Properties | |
| - [data](#data) | |
| ### Properties | |
| #### data | |
| • **data**: [`StripeProduct`](#interfacesflatfilebillingstripeproductmd)[] | |
| ##### Defined in | |
| [src/api/resources/billing/types/ProductsResponse.ts:8](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/billing/types/ProductsResponse.ts#L8) | |
| <a name="interfacesflatfilebillingstripeproductmd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / [billing](#modulesflatfilebillingmd) / StripeProduct | |
| ## Interface: StripeProduct | |
| [Flatfile](#modulesflatfilemd).[billing](#modulesflatfilebillingmd).StripeProduct | |
| A product as returned by Stripe | |
| ### Table of contents | |
| #### Properties | |
| - [active](#active) | |
| - [attributes](#attributes) | |
| - [created](#created) | |
| - [defaultPrice](#defaultprice) | |
| - [description](#description) | |
| - [id](#id) | |
| - [images](#images) | |
| - [livemode](#livemode) | |
| - [metadata](#metadata) | |
| - [name](#name) | |
| - [object](#object) | |
| - [packageDimensions](#packagedimensions) | |
| - [shippable](#shippable) | |
| - [statementDescriptor](#statementdescriptor) | |
| - [taxCode](#taxcode) | |
| - [type](#type) | |
| - [unitLabel](#unitlabel) | |
| - [updated](#updated) | |
| - [url](#url) | |
| ### Properties | |
| #### active | |
| • **active**: `boolean` | |
| ##### Defined in | |
| [src/api/resources/billing/types/StripeProduct.ts:11](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/billing/types/StripeProduct.ts#L11) | |
| ___ | |
| #### attributes | |
| • **attributes**: `string`[] | |
| ##### Defined in | |
| [src/api/resources/billing/types/StripeProduct.ts:12](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/billing/types/StripeProduct.ts#L12) | |
| ___ | |
| #### created | |
| • **created**: `number` | |
| ##### Defined in | |
| [src/api/resources/billing/types/StripeProduct.ts:13](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/billing/types/StripeProduct.ts#L13) | |
| ___ | |
| #### defaultPrice | |
| • **defaultPrice**: `string` | |
| ##### Defined in | |
| [src/api/resources/billing/types/StripeProduct.ts:14](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/billing/types/StripeProduct.ts#L14) | |
| ___ | |
| #### description | |
| • **description**: `string` | |
| ##### Defined in | |
| [src/api/resources/billing/types/StripeProduct.ts:15](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/billing/types/StripeProduct.ts#L15) | |
| ___ | |
| #### id | |
| • **id**: `string` | |
| ##### Defined in | |
| [src/api/resources/billing/types/StripeProduct.ts:9](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/billing/types/StripeProduct.ts#L9) | |
| ___ | |
| #### images | |
| • **images**: `string`[] | |
| ##### Defined in | |
| [src/api/resources/billing/types/StripeProduct.ts:16](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/billing/types/StripeProduct.ts#L16) | |
| ___ | |
| #### livemode | |
| • **livemode**: `boolean` | |
| ##### Defined in | |
| [src/api/resources/billing/types/StripeProduct.ts:17](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/billing/types/StripeProduct.ts#L17) | |
| ___ | |
| #### metadata | |
| • `Optional` **metadata**: `unknown` | |
| ##### Defined in | |
| [src/api/resources/billing/types/StripeProduct.ts:18](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/billing/types/StripeProduct.ts#L18) | |
| ___ | |
| #### name | |
| • **name**: `string` | |
| ##### Defined in | |
| [src/api/resources/billing/types/StripeProduct.ts:19](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/billing/types/StripeProduct.ts#L19) | |
| ___ | |
| #### object | |
| • **object**: `string` | |
| ##### Defined in | |
| [src/api/resources/billing/types/StripeProduct.ts:10](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/billing/types/StripeProduct.ts#L10) | |
| ___ | |
| #### packageDimensions | |
| • **packageDimensions**: `string` | |
| ##### Defined in | |
| [src/api/resources/billing/types/StripeProduct.ts:20](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/billing/types/StripeProduct.ts#L20) | |
| ___ | |
| #### shippable | |
| • **shippable**: `boolean` | |
| ##### Defined in | |
| [src/api/resources/billing/types/StripeProduct.ts:21](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/billing/types/StripeProduct.ts#L21) | |
| ___ | |
| #### statementDescriptor | |
| • **statementDescriptor**: `string` | |
| ##### Defined in | |
| [src/api/resources/billing/types/StripeProduct.ts:22](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/billing/types/StripeProduct.ts#L22) | |
| ___ | |
| #### taxCode | |
| • **taxCode**: `string` | |
| ##### Defined in | |
| [src/api/resources/billing/types/StripeProduct.ts:23](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/billing/types/StripeProduct.ts#L23) | |
| ___ | |
| #### type | |
| • **type**: `string` | |
| ##### Defined in | |
| [src/api/resources/billing/types/StripeProduct.ts:24](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/billing/types/StripeProduct.ts#L24) | |
| ___ | |
| #### unitLabel | |
| • **unitLabel**: `string` | |
| ##### Defined in | |
| [src/api/resources/billing/types/StripeProduct.ts:25](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/billing/types/StripeProduct.ts#L25) | |
| ___ | |
| #### updated | |
| • **updated**: `number` | |
| ##### Defined in | |
| [src/api/resources/billing/types/StripeProduct.ts:26](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/billing/types/StripeProduct.ts#L26) | |
| ___ | |
| #### url | |
| • **url**: `string` | |
| ##### Defined in | |
| [src/api/resources/billing/types/StripeProduct.ts:27](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/billing/types/StripeProduct.ts#L27) | |
| <a name="interfacesflatfilecellscellvaluewithcountsmd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / [cells](#modulesflatfilecellsmd) / CellValueWithCounts | |
| ## Interface: CellValueWithCounts | |
| [Flatfile](#modulesflatfilemd).[cells](#modulesflatfilecellsmd).CellValueWithCounts | |
| ### Hierarchy | |
| - [`CellValue`](#interfacesflatfilerecordscellvaluemd) | |
| ↳ **`CellValueWithCounts`** | |
| ### Table of contents | |
| #### Properties | |
| - [counts](#counts) | |
| - [messages](#messages) | |
| - [updatedAt](#updatedat) | |
| - [valid](#valid) | |
| - [value](#value) | |
| ### Properties | |
| #### counts | |
| • `Optional` **counts**: [`RecordCounts`](#interfacesflatfilerecordsrecordcountsmd) | |
| ##### Defined in | |
| [src/api/resources/cells/types/CellValueWithCounts.ts:8](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/cells/types/CellValueWithCounts.ts#L8) | |
| ___ | |
| #### messages | |
| • `Optional` **messages**: [`ValidationMessage`](#interfacesflatfilerecordsvalidationmessagemd)[] | |
| ##### Inherited from | |
| [CellValue](#interfacesflatfilerecordscellvaluemd).[messages](#messages) | |
| ##### Defined in | |
| [src/api/resources/records/types/CellValue.ts:9](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/records/types/CellValue.ts#L9) | |
| ___ | |
| #### updatedAt | |
| • `Optional` **updatedAt**: `Date` | |
| ##### Inherited from | |
| [CellValue](#interfacesflatfilerecordscellvaluemd).[updatedAt](#updatedat) | |
| ##### Defined in | |
| [src/api/resources/records/types/CellValue.ts:11](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/records/types/CellValue.ts#L11) | |
| ___ | |
| #### valid | |
| • `Optional` **valid**: `boolean` | |
| ##### Inherited from | |
| [CellValue](#interfacesflatfilerecordscellvaluemd).[valid](#valid) | |
| ##### Defined in | |
| [src/api/resources/records/types/CellValue.ts:8](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/records/types/CellValue.ts#L8) | |
| ___ | |
| #### value | |
| • `Optional` **value**: [`CellValueUnion`](#cellvalueunion) | |
| ##### Inherited from | |
| [CellValue](#interfacesflatfilerecordscellvaluemd).[value](#value) | |
| ##### Defined in | |
| [src/api/resources/records/types/CellValue.ts:10](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/records/types/CellValue.ts#L10) | |
| <a name="interfacesflatfilecellscellsresponsemd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / [cells](#modulesflatfilecellsmd) / CellsResponse | |
| ## Interface: CellsResponse | |
| [Flatfile](#modulesflatfilemd).[cells](#modulesflatfilecellsmd).CellsResponse | |
| ### Table of contents | |
| #### Properties | |
| - [data](#data) | |
| ### Properties | |
| #### data | |
| • **data**: [`CellsResponseData`](#cellsresponsedata) | |
| ##### Defined in | |
| [src/api/resources/cells/types/CellsResponse.ts:8](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/cells/types/CellsResponse.ts#L8) | |
| <a name="interfacesflatfilecellsgetfieldvaluesrequestmd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / [cells](#modulesflatfilecellsmd) / GetFieldValuesRequest | |
| ## Interface: GetFieldValuesRequest | |
| [Flatfile](#modulesflatfilemd).[cells](#modulesflatfilecellsmd).GetFieldValuesRequest | |
| ### Table of contents | |
| #### Properties | |
| - [distinct](#distinct) | |
| - [fieldKey](#fieldkey) | |
| - [filter](#filter) | |
| - [filterField](#filterfield) | |
| - [includeCounts](#includecounts) | |
| - [pageNumber](#pagenumber) | |
| - [pageSize](#pagesize) | |
| - [searchValue](#searchvalue) | |
| - [sortDirection](#sortdirection) | |
| - [sortField](#sortfield) | |
| ### Properties | |
| #### distinct | |
| • `Optional` **distinct**: `boolean` | |
| When true, excludes duplicate values | |
| ##### Defined in | |
| [src/api/resources/cells/client/requests/GetFieldValuesRequest.ts:34](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/cells/client/requests/GetFieldValuesRequest.ts#L34) | |
| ___ | |
| #### 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](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/cells/client/requests/GetFieldValuesRequest.ts#L12) | |
| ___ | |
| #### filter | |
| • `Optional` **filter**: [`Filter`](#filter-1) | |
| Options to filter records | |
| ##### Defined in | |
| [src/api/resources/cells/client/requests/GetFieldValuesRequest.ts:18](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/cells/client/requests/GetFieldValuesRequest.ts#L18) | |
| ___ | |
| #### filterField | |
| • `Optional` **filterField**: `string` | |
| Name of field by which to filter records | |
| ##### Defined in | |
| [src/api/resources/cells/client/requests/GetFieldValuesRequest.ts:22](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/cells/client/requests/GetFieldValuesRequest.ts#L22) | |
| ___ | |
| #### 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](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/cells/client/requests/GetFieldValuesRequest.ts#L38) | |
| ___ | |
| #### pageNumber | |
| • `Optional` **pageNumber**: `number` | |
| Based on pageSize, which page of records to return | |
| ##### Defined in | |
| [src/api/resources/cells/client/requests/GetFieldValuesRequest.ts:30](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/cells/client/requests/GetFieldValuesRequest.ts#L30) | |
| ___ | |
| #### 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](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/cells/client/requests/GetFieldValuesRequest.ts#L26) | |
| ___ | |
| #### 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](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/cells/client/requests/GetFieldValuesRequest.ts#L42) | |
| ___ | |
| #### sortDirection | |
| • `Optional` **sortDirection**: [`SortDirection`](#sortdirection-1) | |
| ##### Defined in | |
| [src/api/resources/cells/client/requests/GetFieldValuesRequest.ts:14](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/cells/client/requests/GetFieldValuesRequest.ts#L14) | |
| ___ | |
| #### sortField | |
| • `Optional` **sortField**: `string` | |
| ##### Defined in | |
| [src/api/resources/cells/client/requests/GetFieldValuesRequest.ts:13](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/cells/client/requests/GetFieldValuesRequest.ts#L13) | |
| <a name="interfacesflatfilecommonsactionmd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / [commons](#modulesflatfilecommonsmd) / Action | |
| ## Interface: Action | |
| [Flatfile](#modulesflatfilemd).[commons](#modulesflatfilecommonsmd).Action | |
| ### Table of contents | |
| #### Properties | |
| - [confirm](#confirm) | |
| - [description](#description) | |
| - [label](#label) | |
| - [mode](#mode) | |
| - [operation](#operation) | |
| - [primary](#primary) | |
| - [slug](#slug) | |
| - [type](#type) | |
| ### Properties | |
| #### confirm | |
| • `Optional` **confirm**: `boolean` | |
| ##### Defined in | |
| [src/api/resources/commons/types/Action.ts:15](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/commons/types/Action.ts#L15) | |
| ___ | |
| #### description | |
| • `Optional` **description**: `string` | |
| ##### Defined in | |
| [src/api/resources/commons/types/Action.ts:13](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/commons/types/Action.ts#L13) | |
| ___ | |
| #### label | |
| • **label**: `string` | |
| ##### Defined in | |
| [src/api/resources/commons/types/Action.ts:11](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/commons/types/Action.ts#L11) | |
| ___ | |
| #### mode | |
| • `Optional` **mode**: [`ActionMode`](#actionmode-1) | |
| ##### Defined in | |
| [src/api/resources/commons/types/Action.ts:10](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/commons/types/Action.ts#L10) | |
| ___ | |
| #### operation | |
| • `Optional` **operation**: `string` | |
| ##### Defined in | |
| [src/api/resources/commons/types/Action.ts:9](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/commons/types/Action.ts#L9) | |
| ___ | |
| #### primary | |
| • `Optional` **primary**: `boolean` | |
| ##### Defined in | |
| [src/api/resources/commons/types/Action.ts:14](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/commons/types/Action.ts#L14) | |
| ___ | |
| #### slug | |
| • `Optional` **slug**: `string` | |
| ##### Defined in | |
| [src/api/resources/commons/types/Action.ts:8](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/commons/types/Action.ts#L8) | |
| ___ | |
| #### type | |
| • `Optional` **type**: `string` | |
| ##### Defined in | |
| [src/api/resources/commons/types/Action.ts:12](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/commons/types/Action.ts#L12) | |
| <a name="interfacesflatfilecommonserror_md"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / [commons](#modulesflatfilecommonsmd) / Error\_ | |
| ## Interface: Error\_ | |
| [Flatfile](#modulesflatfilemd).[commons](#modulesflatfilecommonsmd).Error_ | |
| This file was auto-generated by Fern from our API Definition. | |
| ### Table of contents | |
| #### Properties | |
| - [key](#key) | |
| - [message](#message) | |
| ### Properties | |
| #### key | |
| • `Optional` **key**: `string` | |
| ##### Defined in | |
| [src/api/resources/commons/types/Error_.ts:6](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/commons/types/Error_.ts#L6) | |
| ___ | |
| #### message | |
| • **message**: `string` | |
| ##### Defined in | |
| [src/api/resources/commons/types/Error_.ts:7](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/commons/types/Error_.ts#L7) | |
| <a name="interfacesflatfilecommonspaginationmd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / [commons](#modulesflatfilecommonsmd) / Pagination | |
| ## Interface: Pagination | |
| [Flatfile](#modulesflatfilemd).[commons](#modulesflatfilecommonsmd).Pagination | |
| pagination info | |
| **`Example`** | |
| ```ts | |
| { | |
| * currentPage: 3, | |
| * pageCount: 50, | |
| * totalCount: 100 | |
| * } | |
| ``` | |
| ### Table of contents | |
| #### Properties | |
| - [currentPage](#currentpage) | |
| - [pageCount](#pagecount) | |
| - [totalCount](#totalcount) | |
| ### Properties | |
| #### currentPage | |
| • **currentPage**: `number` | |
| current page of results | |
| ##### Defined in | |
| [src/api/resources/commons/types/Pagination.ts:17](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/commons/types/Pagination.ts#L17) | |
| ___ | |
| #### pageCount | |
| • **pageCount**: `number` | |
| total number of pages of results | |
| ##### Defined in | |
| [src/api/resources/commons/types/Pagination.ts:19](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/commons/types/Pagination.ts#L19) | |
| ___ | |
| #### totalCount | |
| • **totalCount**: `number` | |
| total available results | |
| ##### Defined in | |
| [src/api/resources/commons/types/Pagination.ts:21](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/commons/types/Pagination.ts#L21) | |
| <a name="interfacesflatfilecommonssuccessmd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / [commons](#modulesflatfilecommonsmd) / Success | |
| ## Interface: Success | |
| [Flatfile](#modulesflatfilemd).[commons](#modulesflatfilecommonsmd).Success | |
| Informs whether or not a request was successful | |
| **`Example`** | |
| ```ts | |
| { | |
| * data: { | |
| * success: true | |
| * } | |
| * } | |
| ``` | |
| ### Hierarchy | |
| - **`Success`** | |
| ↳ [`RecordsResponseData`](#interfacesflatfilerecordsrecordsresponsedatamd) | |
| ↳ [`RecordCountsResponseData`](#interfacesflatfilesheetsrecordcountsresponsedatamd) | |
| ### Table of contents | |
| #### Properties | |
| - [data](#data) | |
| ### Properties | |
| #### data | |
| • **data**: [`SuccessData`](#interfacesflatfilecommonssuccessdatamd) | |
| ##### Defined in | |
| [src/api/resources/commons/types/Success.ts:18](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/commons/types/Success.ts#L18) | |
| <a name="interfacesflatfilecommonssuccessdatamd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / [commons](#modulesflatfilecommonsmd) / SuccessData | |
| ## Interface: SuccessData | |
| [Flatfile](#modulesflatfilemd).[commons](#modulesflatfilecommonsmd).SuccessData | |
| This file was auto-generated by Fern from our API Definition. | |
| ### Table of contents | |
| #### Properties | |
| - [success](#success) | |
| ### Properties | |
| #### success | |
| • **success**: `boolean` | |
| ##### Defined in | |
| [src/api/resources/commons/types/SuccessData.ts:6](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/commons/types/SuccessData.ts#L6) | |
| <a name="interfacesflatfiledocumentsdocumentmd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / [documents](#modulesflatfiledocumentsmd) / Document | |
| ## Interface: Document | |
| [Flatfile](#modulesflatfilemd).[documents](#modulesflatfiledocumentsmd).Document | |
| A document (markdown components) belong to a space | |
| ### Hierarchy | |
| - [`DocumentConfig`](#interfacesflatfiledocumentsdocumentconfigmd) | |
| ↳ **`Document`** | |
| ### Table of contents | |
| #### Properties | |
| - [body](#body) | |
| - [id](#id) | |
| - [spaceId](#spaceid) | |
| - [title](#title) | |
| ### Properties | |
| #### body | |
| • **body**: `string` | |
| ##### Inherited from | |
| [DocumentConfig](#interfacesflatfiledocumentsdocumentconfigmd).[body](#body) | |
| ##### Defined in | |
| [src/api/resources/documents/types/DocumentConfig.ts:7](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/documents/types/DocumentConfig.ts#L7) | |
| ___ | |
| #### id | |
| • **id**: `string` | |
| ##### Defined in | |
| [src/api/resources/documents/types/Document.ts:11](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/documents/types/Document.ts#L11) | |
| ___ | |
| #### spaceId | |
| • `Optional` **spaceId**: `string` | |
| ##### Defined in | |
| [src/api/resources/documents/types/Document.ts:12](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/documents/types/Document.ts#L12) | |
| ___ | |
| #### title | |
| • **title**: `string` | |
| ##### Inherited from | |
| [DocumentConfig](#interfacesflatfiledocumentsdocumentconfigmd).[title](#title) | |
| ##### Defined in | |
| [src/api/resources/documents/types/DocumentConfig.ts:6](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/documents/types/DocumentConfig.ts#L6) | |
| <a name="interfacesflatfiledocumentsdocumentconfigmd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / [documents](#modulesflatfiledocumentsmd) / DocumentConfig | |
| ## Interface: DocumentConfig | |
| [Flatfile](#modulesflatfilemd).[documents](#modulesflatfiledocumentsmd).DocumentConfig | |
| This file was auto-generated by Fern from our API Definition. | |
| ### Hierarchy | |
| - **`DocumentConfig`** | |
| ↳ [`Document`](#interfacesflatfiledocumentsdocumentmd) | |
| ### Table of contents | |
| #### Properties | |
| - [body](#body) | |
| - [title](#title) | |
| ### Properties | |
| #### body | |
| • **body**: `string` | |
| ##### Defined in | |
| [src/api/resources/documents/types/DocumentConfig.ts:7](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/documents/types/DocumentConfig.ts#L7) | |
| ___ | |
| #### title | |
| • **title**: `string` | |
| ##### Defined in | |
| [src/api/resources/documents/types/DocumentConfig.ts:6](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/documents/types/DocumentConfig.ts#L6) | |
| <a name="interfacesflatfiledocumentsdocumentresponsemd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / [documents](#modulesflatfiledocumentsmd) / DocumentResponse | |
| ## Interface: DocumentResponse | |
| [Flatfile](#modulesflatfilemd).[documents](#modulesflatfiledocumentsmd).DocumentResponse | |
| ### Table of contents | |
| #### Properties | |
| - [data](#data) | |
| ### Properties | |
| #### data | |
| • **data**: [`Document`](#interfacesflatfiledocumentsdocumentmd) | |
| ##### Defined in | |
| [src/api/resources/documents/types/DocumentResponse.ts:8](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/documents/types/DocumentResponse.ts#L8) | |
| <a name="interfacesflatfiledocumentslistdocumentsresponsemd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / [documents](#modulesflatfiledocumentsmd) / ListDocumentsResponse | |
| ## Interface: ListDocumentsResponse | |
| [Flatfile](#modulesflatfilemd).[documents](#modulesflatfiledocumentsmd).ListDocumentsResponse | |
| ### Table of contents | |
| #### Properties | |
| - [data](#data) | |
| ### Properties | |
| #### data | |
| • **data**: [`Document`](#interfacesflatfiledocumentsdocumentmd)[] | |
| ##### Defined in | |
| [src/api/resources/documents/types/ListDocumentsResponse.ts:8](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/documents/types/ListDocumentsResponse.ts#L8) | |
| <a name="interfacesflatfileenvironmentsenvironmentmd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / [environments](#modulesflatfileenvironmentsmd) / Environment | |
| ## Interface: Environment | |
| [Flatfile](#modulesflatfilemd).[environments](#modulesflatfileenvironmentsmd).Environment | |
| **`Example`** | |
| ```ts | |
| { | |
| * name: "dev", | |
| * isProd: false, | |
| * guestAuthentication: [Flatfile.GuestAuthenticationEnum.MagicLink], | |
| * id: "us_env_hVXkXs0b", | |
| * accountId: "us_acc_uj6s91wc" | |
| * } | |
| ``` | |
| ### Hierarchy | |
| - [`EnvironmentConfig`](#interfacesflatfileenvironmentsenvironmentconfigmd) | |
| ↳ **`Environment`** | |
| ### Table of contents | |
| #### Properties | |
| - [accountId](#accountid) | |
| - [features](#features) | |
| - [guestAuthentication](#guestauthentication) | |
| - [id](#id) | |
| - [isProd](#isprod) | |
| - [name](#name) | |
| ### Properties | |
| #### accountId | |
| • `Optional` **accountId**: `string` | |
| ##### Defined in | |
| [src/api/resources/environments/types/Environment.ts:19](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/environments/types/Environment.ts#L19) | |
| ___ | |
| #### features | |
| • `Optional` **features**: `Record`<`string`, `unknown`\> | |
| ##### Inherited from | |
| [EnvironmentConfig](#interfacesflatfileenvironmentsenvironmentconfigmd).[features](#features) | |
| ##### Defined in | |
| [src/api/resources/environments/types/EnvironmentConfig.ts:23](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/environments/types/EnvironmentConfig.ts#L23) | |
| ___ | |
| #### guestAuthentication | |
| • `Optional` **guestAuthentication**: [`GuestAuthenticationEnum`](#guestauthenticationenum-1)[] | |
| ##### Inherited from | |
| [EnvironmentConfig](#interfacesflatfileenvironmentsenvironmentconfigmd).[guestAuthentication](#guestauthentication) | |
| ##### Defined in | |
| [src/api/resources/environments/types/EnvironmentConfig.ts:22](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/environments/types/EnvironmentConfig.ts#L22) | |
| ___ | |
| #### id | |
| • **id**: `string` | |
| ##### Defined in | |
| [src/api/resources/environments/types/Environment.ts:18](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/environments/types/Environment.ts#L18) | |
| ___ | |
| #### isProd | |
| • **isProd**: `boolean` | |
| Whether or not the environment is a production environment | |
| ##### Inherited from | |
| [EnvironmentConfig](#interfacesflatfileenvironmentsenvironmentconfigmd).[isProd](#isprod) | |
| ##### Defined in | |
| [src/api/resources/environments/types/EnvironmentConfig.ts:21](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/environments/types/EnvironmentConfig.ts#L21) | |
| ___ | |
| #### name | |
| • **name**: `string` | |
| The name of the environment | |
| ##### Inherited from | |
| [EnvironmentConfig](#interfacesflatfileenvironmentsenvironmentconfigmd).[name](#name) | |
| ##### Defined in | |
| [src/api/resources/environments/types/EnvironmentConfig.ts:19](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/environments/types/EnvironmentConfig.ts#L19) | |
| <a name="interfacesflatfileenvironmentsenvironmentconfigmd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / [environments](#modulesflatfileenvironmentsmd) / EnvironmentConfig | |
| ## Interface: EnvironmentConfig | |
| [Flatfile](#modulesflatfilemd).[environments](#modulesflatfileenvironmentsmd).EnvironmentConfig | |
| Properties used to create a new environment | |
| **`Example`** | |
| ```ts | |
| { | |
| * name: "dev", | |
| * isProd: false, | |
| * guestAuthentication: [Flatfile.GuestAuthenticationEnum.MagicLink] | |
| * } | |
| ``` | |
| ### Hierarchy | |
| - **`EnvironmentConfig`** | |
| ↳ [`Environment`](#interfacesflatfileenvironmentsenvironmentmd) | |
| ### Table of contents | |
| #### Properties | |
| - [features](#features) | |
| - [guestAuthentication](#guestauthentication) | |
| - [isProd](#isprod) | |
| - [name](#name) | |
| ### Properties | |
| #### features | |
| • `Optional` **features**: `Record`<`string`, `unknown`\> | |
| ##### Defined in | |
| [src/api/resources/environments/types/EnvironmentConfig.ts:23](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/environments/types/EnvironmentConfig.ts#L23) | |
| ___ | |
| #### guestAuthentication | |
| • `Optional` **guestAuthentication**: [`GuestAuthenticationEnum`](#guestauthenticationenum-1)[] | |
| ##### Defined in | |
| [src/api/resources/environments/types/EnvironmentConfig.ts:22](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/environments/types/EnvironmentConfig.ts#L22) | |
| ___ | |
| #### isProd | |
| • **isProd**: `boolean` | |
| Whether or not the environment is a production environment | |
| ##### Defined in | |
| [src/api/resources/environments/types/EnvironmentConfig.ts:21](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/environments/types/EnvironmentConfig.ts#L21) | |
| ___ | |
| #### name | |
| • **name**: `string` | |
| The name of the environment | |
| ##### Defined in | |
| [src/api/resources/environments/types/EnvironmentConfig.ts:19](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/environments/types/EnvironmentConfig.ts#L19) | |
| <a name="interfacesflatfileenvironmentsenvironmentresponsemd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / [environments](#modulesflatfileenvironmentsmd) / EnvironmentResponse | |
| ## Interface: EnvironmentResponse | |
| [Flatfile](#modulesflatfilemd).[environments](#modulesflatfileenvironmentsmd).EnvironmentResponse | |
| ### Table of contents | |
| #### Properties | |
| - [data](#data) | |
| ### Properties | |
| #### data | |
| • **data**: [`Environment`](#interfacesflatfileenvironmentsenvironmentmd) | |
| ##### Defined in | |
| [src/api/resources/environments/types/EnvironmentResponse.ts:8](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/environments/types/EnvironmentResponse.ts#L8) | |
| <a name="interfacesflatfileenvironmentslistenvironmentsrequestmd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / [environments](#modulesflatfileenvironmentsmd) / ListEnvironmentsRequest | |
| ## Interface: ListEnvironmentsRequest | |
| [Flatfile](#modulesflatfilemd).[environments](#modulesflatfileenvironmentsmd).ListEnvironmentsRequest | |
| This file was auto-generated by Fern from our API Definition. | |
| ### Table of contents | |
| #### Properties | |
| - [pageNumber](#pagenumber) | |
| - [pageSize](#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](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/environments/client/requests/ListEnvironmentsRequest.ts#L13) | |
| ___ | |
| #### 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](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/environments/client/requests/ListEnvironmentsRequest.ts#L9) | |
| <a name="interfacesflatfileenvironmentslistenvironmentsresponsemd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / [environments](#modulesflatfileenvironmentsmd) / ListEnvironmentsResponse | |
| ## Interface: ListEnvironmentsResponse | |
| [Flatfile](#modulesflatfilemd).[environments](#modulesflatfileenvironmentsmd).ListEnvironmentsResponse | |
| ### Table of contents | |
| #### Properties | |
| - [data](#data) | |
| - [pagination](#pagination) | |
| ### Properties | |
| #### data | |
| • **data**: [`Environment`](#interfacesflatfileenvironmentsenvironmentmd)[] | |
| ##### Defined in | |
| [src/api/resources/environments/types/ListEnvironmentsResponse.ts:8](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/environments/types/ListEnvironmentsResponse.ts#L8) | |
| ___ | |
| #### pagination | |
| • `Optional` **pagination**: [`Pagination`](#interfacesflatfilecommonspaginationmd) | |
| ##### Defined in | |
| [src/api/resources/environments/types/ListEnvironmentsResponse.ts:9](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/environments/types/ListEnvironmentsResponse.ts#L9) | |
| <a name="interfacesflatfileeventsactiontriggeredeventmd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / [events](#modulesflatfileeventsmd) / ActionTriggeredEvent | |
| ## Interface: ActionTriggeredEvent | |
| [Flatfile](#modulesflatfilemd).[events](#modulesflatfileeventsmd).ActionTriggeredEvent | |
| ### Hierarchy | |
| - [`BaseEvent`](#interfacesflatfileeventsbaseeventmd) | |
| ↳ **`ActionTriggeredEvent`** | |
| ↳↳ [`ActionTriggered`](#interfacesflatfileeventseventactiontriggeredmd) | |
| ### Table of contents | |
| #### Properties | |
| - [acknowledgedAt](#acknowledgedat) | |
| - [acknowledgedBy](#acknowledgedby) | |
| - [attributes](#attributes) | |
| - [callbackUrl](#callbackurl) | |
| - [context](#context) | |
| - [createdAt](#createdat) | |
| - [dataUrl](#dataurl) | |
| - [deletedAt](#deletedat) | |
| - [domain](#domain) | |
| - [origin](#origin) | |
| - [payload](#payload) | |
| - [target](#target) | |
| - [topic](#topic) | |
| ### Properties | |
| #### acknowledgedAt | |
| • `Optional` **acknowledgedAt**: `string` | |
| Date the event was acknowledged | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[acknowledgedAt](#acknowledgedat) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:24](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L24) | |
| ___ | |
| #### acknowledgedBy | |
| • `Optional` **acknowledgedBy**: `string` | |
| The actor (user or system) who acknowledged the event | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[acknowledgedBy](#acknowledgedby) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:26](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L26) | |
| ___ | |
| #### attributes | |
| • `Optional` **attributes**: [`EventAttributes`](#interfacesflatfileeventseventattributesmd) | |
| The attributes of the event | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[attributes](#attributes) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:14](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L14) | |
| ___ | |
| #### callbackUrl | |
| • `Optional` **callbackUrl**: `string` | |
| The callback url to acknowledge the event | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[callbackUrl](#callbackurl) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:16](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L16) | |
| ___ | |
| #### context | |
| • **context**: [`Context`](#interfacesflatfileeventscontextmd) | |
| The context of the event | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[context](#context) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:12](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L12) | |
| ___ | |
| #### createdAt | |
| • **createdAt**: `Date` | |
| Date the event was created | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[createdAt](#createdat) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:20](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L20) | |
| ___ | |
| #### dataUrl | |
| • `Optional` **dataUrl**: `string` | |
| The url to retrieve the data associated with the event | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[dataUrl](#dataurl) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:18](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L18) | |
| ___ | |
| #### deletedAt | |
| • `Optional` **deletedAt**: `Date` | |
| Date the event was deleted | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[deletedAt](#deletedat) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:22](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L22) | |
| ___ | |
| #### domain | |
| • **domain**: [`Domain`](#domain-1) | |
| The domain of the event | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[domain](#domain) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:9](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L9) | |
| ___ | |
| #### origin | |
| • `Optional` **origin**: [`Origin`](#interfacesflatfileeventsoriginmd) | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[origin](#origin) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:28](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L28) | |
| ___ | |
| #### payload | |
| • **payload**: `Record`<`string`, `unknown`\> | |
| ##### Defined in | |
| [src/api/resources/events/types/ActionTriggeredEvent.ts:8](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/ActionTriggeredEvent.ts#L8) | |
| ___ | |
| #### target | |
| • `Optional` **target**: `string` | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[target](#target) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:27](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L27) | |
| ___ | |
| #### topic | |
| • **topic**: [`EventTopic`](#eventtopic-1) | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[topic](#topic) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:10](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L10) | |
| <a name="interfacesflatfileeventsbaseeventmd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / [events](#modulesflatfileeventsmd) / BaseEvent | |
| ## Interface: BaseEvent | |
| [Flatfile](#modulesflatfilemd).[events](#modulesflatfileeventsmd).BaseEvent | |
| ### Hierarchy | |
| - **`BaseEvent`** | |
| ↳ [`SpaceAddedEvent`](#interfacesflatfileeventsspaceaddedeventmd) | |
| ↳ [`SpaceRemovedEvent`](#interfacesflatfileeventsspaceremovedeventmd) | |
| ↳ [`WorkbookAddedEvent`](#interfacesflatfileeventsworkbookaddedeventmd) | |
| ↳ [`WorkbookRemovedEvent`](#interfacesflatfileeventsworkbookremovedeventmd) | |
| ↳ [`WorkbookUpdatedEvent`](#interfacesflatfileeventsworkbookupdatedeventmd) | |
| ↳ [`UserAddedEvent`](#interfacesflatfileeventsuseraddedeventmd) | |
| ↳ [`UserRemovedEvent`](#interfacesflatfileeventsuserremovedeventmd) | |
| ↳ [`UserOnlineEvent`](#interfacesflatfileeventsuseronlineeventmd) | |
| ↳ [`UserOfflineEvent`](#interfacesflatfileeventsuserofflineeventmd) | |
| ↳ [`UploadStartedEvent`](#interfacesflatfileeventsuploadstartedeventmd) | |
| ↳ [`UploadFailedEvent`](#interfacesflatfileeventsuploadfailedeventmd) | |
| ↳ [`UploadCompletedEvent`](#interfacesflatfileeventsuploadcompletedeventmd) | |
| ↳ [`JobStartedEvent`](#interfacesflatfileeventsjobstartedeventmd) | |
| ↳ [`JobWaitingEvent`](#interfacesflatfileeventsjobwaitingeventmd) | |
| ↳ [`JobUpdatedEvent`](#interfacesflatfileeventsjobupdatedeventmd) | |
| ↳ [`JobFailedEvent`](#interfacesflatfileeventsjobfailedeventmd) | |
| ↳ [`JobCompletedEvent`](#interfacesflatfileeventsjobcompletedeventmd) | |
| ↳ [`JobDeletedEvent`](#interfacesflatfileeventsjobdeletedeventmd) | |
| ↳ [`RecordsCreatedEvent`](#interfacesflatfileeventsrecordscreatedeventmd) | |
| ↳ [`RecordsUpdatedEvent`](#interfacesflatfileeventsrecordsupdatedeventmd) | |
| ↳ [`RecordsDeletedEvent`](#interfacesflatfileeventsrecordsdeletedeventmd) | |
| ↳ [`SheetValidatedEvent`](#interfacesflatfileeventssheetvalidatedeventmd) | |
| ↳ [`ActionTriggeredEvent`](#interfacesflatfileeventsactiontriggeredeventmd) | |
| ↳ [`FileDeletedEvent`](#interfacesflatfileeventsfiledeletedeventmd) | |
| ↳ [`ClientInitializedEvent`](#interfacesflatfileeventsclientinitializedeventmd) | |
| ### Table of contents | |
| #### Properties | |
| - [acknowledgedAt](#acknowledgedat) | |
| - [acknowledgedBy](#acknowledgedby) | |
| - [attributes](#attributes) | |
| - [callbackUrl](#callbackurl) | |
| - [context](#context) | |
| - [createdAt](#createdat) | |
| - [dataUrl](#dataurl) | |
| - [deletedAt](#deletedat) | |
| - [domain](#domain) | |
| - [origin](#origin) | |
| - [target](#target) | |
| - [topic](#topic) | |
| ### Properties | |
| #### acknowledgedAt | |
| • `Optional` **acknowledgedAt**: `string` | |
| Date the event was acknowledged | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:24](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L24) | |
| ___ | |
| #### acknowledgedBy | |
| • `Optional` **acknowledgedBy**: `string` | |
| The actor (user or system) who acknowledged the event | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:26](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L26) | |
| ___ | |
| #### attributes | |
| • `Optional` **attributes**: [`EventAttributes`](#interfacesflatfileeventseventattributesmd) | |
| The attributes of the event | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:14](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L14) | |
| ___ | |
| #### callbackUrl | |
| • `Optional` **callbackUrl**: `string` | |
| The callback url to acknowledge the event | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:16](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L16) | |
| ___ | |
| #### context | |
| • **context**: [`Context`](#interfacesflatfileeventscontextmd) | |
| The context of the event | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:12](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L12) | |
| ___ | |
| #### createdAt | |
| • **createdAt**: `Date` | |
| Date the event was created | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:20](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L20) | |
| ___ | |
| #### dataUrl | |
| • `Optional` **dataUrl**: `string` | |
| The url to retrieve the data associated with the event | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:18](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L18) | |
| ___ | |
| #### deletedAt | |
| • `Optional` **deletedAt**: `Date` | |
| Date the event was deleted | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:22](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L22) | |
| ___ | |
| #### domain | |
| • **domain**: [`Domain`](#domain-1) | |
| The domain of the event | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:9](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L9) | |
| ___ | |
| #### origin | |
| • `Optional` **origin**: [`Origin`](#interfacesflatfileeventsoriginmd) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:28](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L28) | |
| ___ | |
| #### target | |
| • `Optional` **target**: `string` | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:27](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L27) | |
| ___ | |
| #### topic | |
| • **topic**: [`EventTopic`](#eventtopic-1) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:10](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L10) | |
| <a name="interfacesflatfileeventsclientinitializedeventmd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / [events](#modulesflatfileeventsmd) / ClientInitializedEvent | |
| ## Interface: ClientInitializedEvent | |
| [Flatfile](#modulesflatfilemd).[events](#modulesflatfileeventsmd).ClientInitializedEvent | |
| ### Hierarchy | |
| - [`BaseEvent`](#interfacesflatfileeventsbaseeventmd) | |
| ↳ **`ClientInitializedEvent`** | |
| ↳↳ [`ClientInitialized`](#interfacesflatfileeventseventclientinitializedmd) | |
| ### Table of contents | |
| #### Properties | |
| - [acknowledgedAt](#acknowledgedat) | |
| - [acknowledgedBy](#acknowledgedby) | |
| - [attributes](#attributes) | |
| - [callbackUrl](#callbackurl) | |
| - [context](#context) | |
| - [createdAt](#createdat) | |
| - [dataUrl](#dataurl) | |
| - [deletedAt](#deletedat) | |
| - [domain](#domain) | |
| - [origin](#origin) | |
| - [payload](#payload) | |
| - [target](#target) | |
| - [topic](#topic) | |
| ### Properties | |
| #### acknowledgedAt | |
| • `Optional` **acknowledgedAt**: `string` | |
| Date the event was acknowledged | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[acknowledgedAt](#acknowledgedat) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:24](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L24) | |
| ___ | |
| #### acknowledgedBy | |
| • `Optional` **acknowledgedBy**: `string` | |
| The actor (user or system) who acknowledged the event | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[acknowledgedBy](#acknowledgedby) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:26](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L26) | |
| ___ | |
| #### attributes | |
| • `Optional` **attributes**: [`EventAttributes`](#interfacesflatfileeventseventattributesmd) | |
| The attributes of the event | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[attributes](#attributes) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:14](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L14) | |
| ___ | |
| #### callbackUrl | |
| • `Optional` **callbackUrl**: `string` | |
| The callback url to acknowledge the event | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[callbackUrl](#callbackurl) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:16](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L16) | |
| ___ | |
| #### context | |
| • **context**: [`Context`](#interfacesflatfileeventscontextmd) | |
| The context of the event | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[context](#context) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:12](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L12) | |
| ___ | |
| #### createdAt | |
| • **createdAt**: `Date` | |
| Date the event was created | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[createdAt](#createdat) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:20](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L20) | |
| ___ | |
| #### dataUrl | |
| • `Optional` **dataUrl**: `string` | |
| The url to retrieve the data associated with the event | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[dataUrl](#dataurl) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:18](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L18) | |
| ___ | |
| #### deletedAt | |
| • `Optional` **deletedAt**: `Date` | |
| Date the event was deleted | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[deletedAt](#deletedat) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:22](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L22) | |
| ___ | |
| #### domain | |
| • **domain**: [`Domain`](#domain-1) | |
| The domain of the event | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[domain](#domain) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:9](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L9) | |
| ___ | |
| #### origin | |
| • `Optional` **origin**: [`Origin`](#interfacesflatfileeventsoriginmd) | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[origin](#origin) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:28](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L28) | |
| ___ | |
| #### payload | |
| • **payload**: `Record`<`string`, `unknown`\> | |
| ##### Defined in | |
| [src/api/resources/events/types/ClientInitializedEvent.ts:8](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/ClientInitializedEvent.ts#L8) | |
| ___ | |
| #### target | |
| • `Optional` **target**: `string` | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[target](#target) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:27](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L27) | |
| ___ | |
| #### topic | |
| • **topic**: [`EventTopic`](#eventtopic-1) | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[topic](#topic) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:10](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L10) | |
| <a name="interfacesflatfileeventscontextmd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / [events](#modulesflatfileeventsmd) / Context | |
| ## Interface: Context | |
| [Flatfile](#modulesflatfilemd).[events](#modulesflatfileeventsmd).Context | |
| The context of the event | |
| ### Table of contents | |
| #### Properties | |
| - [accountId](#accountid) | |
| - [actionName](#actionname) | |
| - [actorId](#actorid) | |
| - [environmentId](#environmentid) | |
| - [fileId](#fileid) | |
| - [jobId](#jobid) | |
| - [precedingEventId](#precedingeventid) | |
| - [sheetId](#sheetid) | |
| - [sheetSlug](#sheetslug) | |
| - [spaceId](#spaceid) | |
| - [versionId](#versionid) | |
| - [workbookId](#workbookid) | |
| ### Properties | |
| #### accountId | |
| • **accountId**: `string` | |
| ##### Defined in | |
| [src/api/resources/events/types/Context.ts:12](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/Context.ts#L12) | |
| ___ | |
| #### actionName | |
| • `Optional` **actionName**: `string` | |
| ##### Defined in | |
| [src/api/resources/events/types/Context.ts:11](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/Context.ts#L11) | |
| ___ | |
| #### actorId | |
| • `Optional` **actorId**: `string` | |
| Can be a UserId, GuestId, or AgentId | |
| ##### Defined in | |
| [src/api/resources/events/types/Context.ts:23](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/Context.ts#L23) | |
| ___ | |
| #### environmentId | |
| • **environmentId**: `string` | |
| ##### Defined in | |
| [src/api/resources/events/types/Context.ts:13](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/Context.ts#L13) | |
| ___ | |
| #### fileId | |
| • `Optional` **fileId**: `string` | |
| ##### Defined in | |
| [src/api/resources/events/types/Context.ts:20](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/Context.ts#L20) | |
| ___ | |
| #### jobId | |
| • `Optional` **jobId**: `string` | |
| ##### Defined in | |
| [src/api/resources/events/types/Context.ts:19](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/Context.ts#L19) | |
| ___ | |
| #### precedingEventId | |
| • `Optional` **precedingEventId**: `string` | |
| ##### Defined in | |
| [src/api/resources/events/types/Context.ts:21](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/Context.ts#L21) | |
| ___ | |
| #### sheetId | |
| • `Optional` **sheetId**: `string` | |
| ##### Defined in | |
| [src/api/resources/events/types/Context.ts:16](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/Context.ts#L16) | |
| ___ | |
| #### sheetSlug | |
| • `Optional` **sheetSlug**: `string` | |
| ##### Defined in | |
| [src/api/resources/events/types/Context.ts:17](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/Context.ts#L17) | |
| ___ | |
| #### spaceId | |
| • `Optional` **spaceId**: `string` | |
| ##### Defined in | |
| [src/api/resources/events/types/Context.ts:14](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/Context.ts#L14) | |
| ___ | |
| #### versionId | |
| • `Optional` **versionId**: `string` | |
| ##### Defined in | |
| [src/api/resources/events/types/Context.ts:18](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/Context.ts#L18) | |
| ___ | |
| #### workbookId | |
| • `Optional` **workbookId**: `string` | |
| ##### Defined in | |
| [src/api/resources/events/types/Context.ts:15](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/Context.ts#L15) | |
| <a name="interfacesflatfileeventseventactiontriggeredmd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / [events](#modulesflatfileeventsmd) / [Event](#modulesflatfileeventseventmd) / ActionTriggered | |
| ## Interface: ActionTriggered | |
| [events](#modulesflatfileeventsmd).[Event](#modulesflatfileeventseventmd).ActionTriggered | |
| ### Hierarchy | |
| - [`ActionTriggeredEvent`](#interfacesflatfileeventsactiontriggeredeventmd) | |
| ↳ **`ActionTriggered`** | |
| ### Table of contents | |
| #### Properties | |
| - [acknowledgedAt](#acknowledgedat) | |
| - [acknowledgedBy](#acknowledgedby) | |
| - [attributes](#attributes) | |
| - [callbackUrl](#callbackurl) | |
| - [context](#context) | |
| - [createdAt](#createdat) | |
| - [dataUrl](#dataurl) | |
| - [deletedAt](#deletedat) | |
| - [domain](#domain) | |
| - [origin](#origin) | |
| - [payload](#payload) | |
| - [target](#target) | |
| - [topic](#topic) | |
| - [type](#type) | |
| ### Properties | |
| #### acknowledgedAt | |
| • `Optional` **acknowledgedAt**: `string` | |
| Date the event was acknowledged | |
| ##### Inherited from | |
| [ActionTriggeredEvent](#interfacesflatfileeventsactiontriggeredeventmd).[acknowledgedAt](#acknowledgedat) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:24](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L24) | |
| ___ | |
| #### acknowledgedBy | |
| • `Optional` **acknowledgedBy**: `string` | |
| The actor (user or system) who acknowledged the event | |
| ##### Inherited from | |
| [ActionTriggeredEvent](#interfacesflatfileeventsactiontriggeredeventmd).[acknowledgedBy](#acknowledgedby) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:26](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L26) | |
| ___ | |
| #### attributes | |
| • `Optional` **attributes**: [`EventAttributes`](#interfacesflatfileeventseventattributesmd) | |
| The attributes of the event | |
| ##### Inherited from | |
| [ActionTriggeredEvent](#interfacesflatfileeventsactiontriggeredeventmd).[attributes](#attributes) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:14](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L14) | |
| ___ | |
| #### callbackUrl | |
| • `Optional` **callbackUrl**: `string` | |
| The callback url to acknowledge the event | |
| ##### Inherited from | |
| [ActionTriggeredEvent](#interfacesflatfileeventsactiontriggeredeventmd).[callbackUrl](#callbackurl) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:16](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L16) | |
| ___ | |
| #### context | |
| • **context**: [`Context`](#interfacesflatfileeventscontextmd) | |
| The context of the event | |
| ##### Inherited from | |
| [ActionTriggeredEvent](#interfacesflatfileeventsactiontriggeredeventmd).[context](#context) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:12](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L12) | |
| ___ | |
| #### createdAt | |
| • **createdAt**: `Date` | |
| Date the event was created | |
| ##### Inherited from | |
| [ActionTriggeredEvent](#interfacesflatfileeventsactiontriggeredeventmd).[createdAt](#createdat) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:20](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L20) | |
| ___ | |
| #### dataUrl | |
| • `Optional` **dataUrl**: `string` | |
| The url to retrieve the data associated with the event | |
| ##### Inherited from | |
| [ActionTriggeredEvent](#interfacesflatfileeventsactiontriggeredeventmd).[dataUrl](#dataurl) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:18](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L18) | |
| ___ | |
| #### deletedAt | |
| • `Optional` **deletedAt**: `Date` | |
| Date the event was deleted | |
| ##### Inherited from | |
| [ActionTriggeredEvent](#interfacesflatfileeventsactiontriggeredeventmd).[deletedAt](#deletedat) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:22](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L22) | |
| ___ | |
| #### domain | |
| • **domain**: [`Domain`](#domain-1) | |
| The domain of the event | |
| ##### Inherited from | |
| [ActionTriggeredEvent](#interfacesflatfileeventsactiontriggeredeventmd).[domain](#domain) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:9](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L9) | |
| ___ | |
| #### origin | |
| • `Optional` **origin**: [`Origin`](#interfacesflatfileeventsoriginmd) | |
| ##### Inherited from | |
| [ActionTriggeredEvent](#interfacesflatfileeventsactiontriggeredeventmd).[origin](#origin) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:28](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L28) | |
| ___ | |
| #### payload | |
| • **payload**: `Record`<`string`, `unknown`\> | |
| ##### Inherited from | |
| [ActionTriggeredEvent](#interfacesflatfileeventsactiontriggeredeventmd).[payload](#payload) | |
| ##### Defined in | |
| [src/api/resources/events/types/ActionTriggeredEvent.ts:8](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/ActionTriggeredEvent.ts#L8) | |
| ___ | |
| #### target | |
| • `Optional` **target**: `string` | |
| ##### Inherited from | |
| [ActionTriggeredEvent](#interfacesflatfileeventsactiontriggeredeventmd).[target](#target) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:27](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L27) | |
| ___ | |
| #### topic | |
| • **topic**: [`EventTopic`](#eventtopic-1) | |
| ##### Inherited from | |
| [ActionTriggeredEvent](#interfacesflatfileeventsactiontriggeredeventmd).[topic](#topic) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:10](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L10) | |
| ___ | |
| #### type | |
| • **type**: ``"action:triggered"`` | |
| ##### Defined in | |
| [src/api/resources/events/types/Event.ts:127](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/Event.ts#L127) | |
| <a name="interfacesflatfileeventseventclientinitializedmd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / [events](#modulesflatfileeventsmd) / [Event](#modulesflatfileeventseventmd) / ClientInitialized | |
| ## Interface: ClientInitialized | |
| [events](#modulesflatfileeventsmd).[Event](#modulesflatfileeventseventmd).ClientInitialized | |
| ### Hierarchy | |
| - [`ClientInitializedEvent`](#interfacesflatfileeventsclientinitializedeventmd) | |
| ↳ **`ClientInitialized`** | |
| ### Table of contents | |
| #### Properties | |
| - [acknowledgedAt](#acknowledgedat) | |
| - [acknowledgedBy](#acknowledgedby) | |
| - [attributes](#attributes) | |
| - [callbackUrl](#callbackurl) | |
| - [context](#context) | |
| - [createdAt](#createdat) | |
| - [dataUrl](#dataurl) | |
| - [deletedAt](#deletedat) | |
| - [domain](#domain) | |
| - [origin](#origin) | |
| - [payload](#payload) | |
| - [target](#target) | |
| - [topic](#topic) | |
| - [type](#type) | |
| ### Properties | |
| #### acknowledgedAt | |
| • `Optional` **acknowledgedAt**: `string` | |
| Date the event was acknowledged | |
| ##### Inherited from | |
| [ClientInitializedEvent](#interfacesflatfileeventsclientinitializedeventmd).[acknowledgedAt](#acknowledgedat) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:24](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L24) | |
| ___ | |
| #### acknowledgedBy | |
| • `Optional` **acknowledgedBy**: `string` | |
| The actor (user or system) who acknowledged the event | |
| ##### Inherited from | |
| [ClientInitializedEvent](#interfacesflatfileeventsclientinitializedeventmd).[acknowledgedBy](#acknowledgedby) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:26](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L26) | |
| ___ | |
| #### attributes | |
| • `Optional` **attributes**: [`EventAttributes`](#interfacesflatfileeventseventattributesmd) | |
| The attributes of the event | |
| ##### Inherited from | |
| [ClientInitializedEvent](#interfacesflatfileeventsclientinitializedeventmd).[attributes](#attributes) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:14](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L14) | |
| ___ | |
| #### callbackUrl | |
| • `Optional` **callbackUrl**: `string` | |
| The callback url to acknowledge the event | |
| ##### Inherited from | |
| [ClientInitializedEvent](#interfacesflatfileeventsclientinitializedeventmd).[callbackUrl](#callbackurl) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:16](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L16) | |
| ___ | |
| #### context | |
| • **context**: [`Context`](#interfacesflatfileeventscontextmd) | |
| The context of the event | |
| ##### Inherited from | |
| [ClientInitializedEvent](#interfacesflatfileeventsclientinitializedeventmd).[context](#context) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:12](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L12) | |
| ___ | |
| #### createdAt | |
| • **createdAt**: `Date` | |
| Date the event was created | |
| ##### Inherited from | |
| [ClientInitializedEvent](#interfacesflatfileeventsclientinitializedeventmd).[createdAt](#createdat) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:20](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L20) | |
| ___ | |
| #### dataUrl | |
| • `Optional` **dataUrl**: `string` | |
| The url to retrieve the data associated with the event | |
| ##### Inherited from | |
| [ClientInitializedEvent](#interfacesflatfileeventsclientinitializedeventmd).[dataUrl](#dataurl) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:18](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L18) | |
| ___ | |
| #### deletedAt | |
| • `Optional` **deletedAt**: `Date` | |
| Date the event was deleted | |
| ##### Inherited from | |
| [ClientInitializedEvent](#interfacesflatfileeventsclientinitializedeventmd).[deletedAt](#deletedat) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:22](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L22) | |
| ___ | |
| #### domain | |
| • **domain**: [`Domain`](#domain-1) | |
| The domain of the event | |
| ##### Inherited from | |
| [ClientInitializedEvent](#interfacesflatfileeventsclientinitializedeventmd).[domain](#domain) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:9](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L9) | |
| ___ | |
| #### origin | |
| • `Optional` **origin**: [`Origin`](#interfacesflatfileeventsoriginmd) | |
| ##### Inherited from | |
| [ClientInitializedEvent](#interfacesflatfileeventsclientinitializedeventmd).[origin](#origin) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:28](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L28) | |
| ___ | |
| #### payload | |
| • **payload**: `Record`<`string`, `unknown`\> | |
| ##### Inherited from | |
| [ClientInitializedEvent](#interfacesflatfileeventsclientinitializedeventmd).[payload](#payload) | |
| ##### Defined in | |
| [src/api/resources/events/types/ClientInitializedEvent.ts:8](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/ClientInitializedEvent.ts#L8) | |
| ___ | |
| #### target | |
| • `Optional` **target**: `string` | |
| ##### Inherited from | |
| [ClientInitializedEvent](#interfacesflatfileeventsclientinitializedeventmd).[target](#target) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:27](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L27) | |
| ___ | |
| #### topic | |
| • **topic**: [`EventTopic`](#eventtopic-1) | |
| ##### Inherited from | |
| [ClientInitializedEvent](#interfacesflatfileeventsclientinitializedeventmd).[topic](#topic) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:10](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L10) | |
| ___ | |
| #### type | |
| • **type**: ``"client:init"`` | |
| ##### Defined in | |
| [src/api/resources/events/types/Event.ts:135](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/Event.ts#L135) | |
| <a name="interfacesflatfileeventseventfiledeletedmd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / [events](#modulesflatfileeventsmd) / [Event](#modulesflatfileeventseventmd) / FileDeleted | |
| ## Interface: FileDeleted | |
| [events](#modulesflatfileeventsmd).[Event](#modulesflatfileeventseventmd).FileDeleted | |
| ### Hierarchy | |
| - [`FileDeletedEvent`](#interfacesflatfileeventsfiledeletedeventmd) | |
| ↳ **`FileDeleted`** | |
| ### Table of contents | |
| #### Properties | |
| - [acknowledgedAt](#acknowledgedat) | |
| - [acknowledgedBy](#acknowledgedby) | |
| - [attributes](#attributes) | |
| - [callbackUrl](#callbackurl) | |
| - [context](#context) | |
| - [createdAt](#createdat) | |
| - [dataUrl](#dataurl) | |
| - [deletedAt](#deletedat) | |
| - [domain](#domain) | |
| - [origin](#origin) | |
| - [payload](#payload) | |
| - [target](#target) | |
| - [topic](#topic) | |
| - [type](#type) | |
| ### Properties | |
| #### acknowledgedAt | |
| • `Optional` **acknowledgedAt**: `string` | |
| Date the event was acknowledged | |
| ##### Inherited from | |
| [FileDeletedEvent](#interfacesflatfileeventsfiledeletedeventmd).[acknowledgedAt](#acknowledgedat) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:24](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L24) | |
| ___ | |
| #### acknowledgedBy | |
| • `Optional` **acknowledgedBy**: `string` | |
| The actor (user or system) who acknowledged the event | |
| ##### Inherited from | |
| [FileDeletedEvent](#interfacesflatfileeventsfiledeletedeventmd).[acknowledgedBy](#acknowledgedby) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:26](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L26) | |
| ___ | |
| #### attributes | |
| • `Optional` **attributes**: [`EventAttributes`](#interfacesflatfileeventseventattributesmd) | |
| The attributes of the event | |
| ##### Inherited from | |
| [FileDeletedEvent](#interfacesflatfileeventsfiledeletedeventmd).[attributes](#attributes) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:14](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L14) | |
| ___ | |
| #### callbackUrl | |
| • `Optional` **callbackUrl**: `string` | |
| The callback url to acknowledge the event | |
| ##### Inherited from | |
| [FileDeletedEvent](#interfacesflatfileeventsfiledeletedeventmd).[callbackUrl](#callbackurl) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:16](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L16) | |
| ___ | |
| #### context | |
| • **context**: [`Context`](#interfacesflatfileeventscontextmd) | |
| The context of the event | |
| ##### Inherited from | |
| [FileDeletedEvent](#interfacesflatfileeventsfiledeletedeventmd).[context](#context) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:12](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L12) | |
| ___ | |
| #### createdAt | |
| • **createdAt**: `Date` | |
| Date the event was created | |
| ##### Inherited from | |
| [FileDeletedEvent](#interfacesflatfileeventsfiledeletedeventmd).[createdAt](#createdat) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:20](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L20) | |
| ___ | |
| #### dataUrl | |
| • `Optional` **dataUrl**: `string` | |
| The url to retrieve the data associated with the event | |
| ##### Inherited from | |
| [FileDeletedEvent](#interfacesflatfileeventsfiledeletedeventmd).[dataUrl](#dataurl) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:18](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L18) | |
| ___ | |
| #### deletedAt | |
| • `Optional` **deletedAt**: `Date` | |
| Date the event was deleted | |
| ##### Inherited from | |
| [FileDeletedEvent](#interfacesflatfileeventsfiledeletedeventmd).[deletedAt](#deletedat) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:22](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L22) | |
| ___ | |
| #### domain | |
| • **domain**: [`Domain`](#domain-1) | |
| The domain of the event | |
| ##### Inherited from | |
| [FileDeletedEvent](#interfacesflatfileeventsfiledeletedeventmd).[domain](#domain) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:9](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L9) | |
| ___ | |
| #### origin | |
| • `Optional` **origin**: [`Origin`](#interfacesflatfileeventsoriginmd) | |
| ##### Inherited from | |
| [FileDeletedEvent](#interfacesflatfileeventsfiledeletedeventmd).[origin](#origin) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:28](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L28) | |
| ___ | |
| #### payload | |
| • **payload**: `Record`<`string`, `unknown`\> | |
| ##### Inherited from | |
| [FileDeletedEvent](#interfacesflatfileeventsfiledeletedeventmd).[payload](#payload) | |
| ##### Defined in | |
| [src/api/resources/events/types/FileDeletedEvent.ts:8](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/FileDeletedEvent.ts#L8) | |
| ___ | |
| #### target | |
| • `Optional` **target**: `string` | |
| ##### Inherited from | |
| [FileDeletedEvent](#interfacesflatfileeventsfiledeletedeventmd).[target](#target) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:27](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L27) | |
| ___ | |
| #### topic | |
| • **topic**: [`EventTopic`](#eventtopic-1) | |
| ##### Inherited from | |
| [FileDeletedEvent](#interfacesflatfileeventsfiledeletedeventmd).[topic](#topic) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:10](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L10) | |
| ___ | |
| #### type | |
| • **type**: ``"file:deleted"`` | |
| ##### Defined in | |
| [src/api/resources/events/types/Event.ts:131](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/Event.ts#L131) | |
| <a name="interfacesflatfileeventseventjobcompletedmd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / [events](#modulesflatfileeventsmd) / [Event](#modulesflatfileeventseventmd) / JobCompleted | |
| ## Interface: JobCompleted | |
| [events](#modulesflatfileeventsmd).[Event](#modulesflatfileeventseventmd).JobCompleted | |
| ### Hierarchy | |
| - [`JobCompletedEvent`](#interfacesflatfileeventsjobcompletedeventmd) | |
| ↳ **`JobCompleted`** | |
| ### Table of contents | |
| #### Properties | |
| - [acknowledgedAt](#acknowledgedat) | |
| - [acknowledgedBy](#acknowledgedby) | |
| - [attributes](#attributes) | |
| - [callbackUrl](#callbackurl) | |
| - [context](#context) | |
| - [createdAt](#createdat) | |
| - [dataUrl](#dataurl) | |
| - [deletedAt](#deletedat) | |
| - [domain](#domain) | |
| - [origin](#origin) | |
| - [payload](#payload) | |
| - [target](#target) | |
| - [topic](#topic) | |
| - [type](#type) | |
| ### Properties | |
| #### acknowledgedAt | |
| • `Optional` **acknowledgedAt**: `string` | |
| Date the event was acknowledged | |
| ##### Inherited from | |
| [JobCompletedEvent](#interfacesflatfileeventsjobcompletedeventmd).[acknowledgedAt](#acknowledgedat) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:24](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L24) | |
| ___ | |
| #### acknowledgedBy | |
| • `Optional` **acknowledgedBy**: `string` | |
| The actor (user or system) who acknowledged the event | |
| ##### Inherited from | |
| [JobCompletedEvent](#interfacesflatfileeventsjobcompletedeventmd).[acknowledgedBy](#acknowledgedby) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:26](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L26) | |
| ___ | |
| #### attributes | |
| • `Optional` **attributes**: [`EventAttributes`](#interfacesflatfileeventseventattributesmd) | |
| The attributes of the event | |
| ##### Inherited from | |
| [JobCompletedEvent](#interfacesflatfileeventsjobcompletedeventmd).[attributes](#attributes) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:14](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L14) | |
| ___ | |
| #### callbackUrl | |
| • `Optional` **callbackUrl**: `string` | |
| The callback url to acknowledge the event | |
| ##### Inherited from | |
| [JobCompletedEvent](#interfacesflatfileeventsjobcompletedeventmd).[callbackUrl](#callbackurl) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:16](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L16) | |
| ___ | |
| #### context | |
| • **context**: [`Context`](#interfacesflatfileeventscontextmd) | |
| The context of the event | |
| ##### Inherited from | |
| [JobCompletedEvent](#interfacesflatfileeventsjobcompletedeventmd).[context](#context) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:12](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L12) | |
| ___ | |
| #### createdAt | |
| • **createdAt**: `Date` | |
| Date the event was created | |
| ##### Inherited from | |
| [JobCompletedEvent](#interfacesflatfileeventsjobcompletedeventmd).[createdAt](#createdat) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:20](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L20) | |
| ___ | |
| #### dataUrl | |
| • `Optional` **dataUrl**: `string` | |
| The url to retrieve the data associated with the event | |
| ##### Inherited from | |
| [JobCompletedEvent](#interfacesflatfileeventsjobcompletedeventmd).[dataUrl](#dataurl) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:18](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L18) | |
| ___ | |
| #### deletedAt | |
| • `Optional` **deletedAt**: `Date` | |
| Date the event was deleted | |
| ##### Inherited from | |
| [JobCompletedEvent](#interfacesflatfileeventsjobcompletedeventmd).[deletedAt](#deletedat) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:22](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L22) | |
| ___ | |
| #### domain | |
| • **domain**: [`Domain`](#domain-1) | |
| The domain of the event | |
| ##### Inherited from | |
| [JobCompletedEvent](#interfacesflatfileeventsjobcompletedeventmd).[domain](#domain) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:9](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L9) | |
| ___ | |
| #### origin | |
| • `Optional` **origin**: [`Origin`](#interfacesflatfileeventsoriginmd) | |
| ##### Inherited from | |
| [JobCompletedEvent](#interfacesflatfileeventsjobcompletedeventmd).[origin](#origin) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:28](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L28) | |
| ___ | |
| #### payload | |
| • **payload**: [`JobPayload`](#interfacesflatfileeventsjobpayloadmd) | |
| ##### Inherited from | |
| [JobCompletedEvent](#interfacesflatfileeventsjobcompletedeventmd).[payload](#payload) | |
| ##### Defined in | |
| [src/api/resources/events/types/JobCompletedEvent.ts:8](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/JobCompletedEvent.ts#L8) | |
| ___ | |
| #### target | |
| • `Optional` **target**: `string` | |
| ##### Inherited from | |
| [JobCompletedEvent](#interfacesflatfileeventsjobcompletedeventmd).[target](#target) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:27](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L27) | |
| ___ | |
| #### topic | |
| • **topic**: [`EventTopic`](#eventtopic-1) | |
| ##### Inherited from | |
| [JobCompletedEvent](#interfacesflatfileeventsjobcompletedeventmd).[topic](#topic) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:10](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L10) | |
| ___ | |
| #### type | |
| • **type**: ``"job_completed"`` | |
| ##### Defined in | |
| [src/api/resources/events/types/Event.ts:103](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/Event.ts#L103) | |
| <a name="interfacesflatfileeventseventjobdeletedmd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / [events](#modulesflatfileeventsmd) / [Event](#modulesflatfileeventseventmd) / JobDeleted | |
| ## Interface: JobDeleted | |
| [events](#modulesflatfileeventsmd).[Event](#modulesflatfileeventseventmd).JobDeleted | |
| ### Hierarchy | |
| - [`JobDeletedEvent`](#interfacesflatfileeventsjobdeletedeventmd) | |
| ↳ **`JobDeleted`** | |
| ### Table of contents | |
| #### Properties | |
| - [acknowledgedAt](#acknowledgedat) | |
| - [acknowledgedBy](#acknowledgedby) | |
| - [attributes](#attributes) | |
| - [callbackUrl](#callbackurl) | |
| - [context](#context) | |
| - [createdAt](#createdat) | |
| - [dataUrl](#dataurl) | |
| - [deletedAt](#deletedat) | |
| - [domain](#domain) | |
| - [origin](#origin) | |
| - [payload](#payload) | |
| - [target](#target) | |
| - [topic](#topic) | |
| - [type](#type) | |
| ### Properties | |
| #### acknowledgedAt | |
| • `Optional` **acknowledgedAt**: `string` | |
| Date the event was acknowledged | |
| ##### Inherited from | |
| [JobDeletedEvent](#interfacesflatfileeventsjobdeletedeventmd).[acknowledgedAt](#acknowledgedat) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:24](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L24) | |
| ___ | |
| #### acknowledgedBy | |
| • `Optional` **acknowledgedBy**: `string` | |
| The actor (user or system) who acknowledged the event | |
| ##### Inherited from | |
| [JobDeletedEvent](#interfacesflatfileeventsjobdeletedeventmd).[acknowledgedBy](#acknowledgedby) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:26](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L26) | |
| ___ | |
| #### attributes | |
| • `Optional` **attributes**: [`EventAttributes`](#interfacesflatfileeventseventattributesmd) | |
| The attributes of the event | |
| ##### Inherited from | |
| [JobDeletedEvent](#interfacesflatfileeventsjobdeletedeventmd).[attributes](#attributes) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:14](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L14) | |
| ___ | |
| #### callbackUrl | |
| • `Optional` **callbackUrl**: `string` | |
| The callback url to acknowledge the event | |
| ##### Inherited from | |
| [JobDeletedEvent](#interfacesflatfileeventsjobdeletedeventmd).[callbackUrl](#callbackurl) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:16](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L16) | |
| ___ | |
| #### context | |
| • **context**: [`Context`](#interfacesflatfileeventscontextmd) | |
| The context of the event | |
| ##### Inherited from | |
| [JobDeletedEvent](#interfacesflatfileeventsjobdeletedeventmd).[context](#context) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:12](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L12) | |
| ___ | |
| #### createdAt | |
| • **createdAt**: `Date` | |
| Date the event was created | |
| ##### Inherited from | |
| [JobDeletedEvent](#interfacesflatfileeventsjobdeletedeventmd).[createdAt](#createdat) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:20](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L20) | |
| ___ | |
| #### dataUrl | |
| • `Optional` **dataUrl**: `string` | |
| The url to retrieve the data associated with the event | |
| ##### Inherited from | |
| [JobDeletedEvent](#interfacesflatfileeventsjobdeletedeventmd).[dataUrl](#dataurl) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:18](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L18) | |
| ___ | |
| #### deletedAt | |
| • `Optional` **deletedAt**: `Date` | |
| Date the event was deleted | |
| ##### Inherited from | |
| [JobDeletedEvent](#interfacesflatfileeventsjobdeletedeventmd).[deletedAt](#deletedat) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:22](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L22) | |
| ___ | |
| #### domain | |
| • **domain**: [`Domain`](#domain-1) | |
| The domain of the event | |
| ##### Inherited from | |
| [JobDeletedEvent](#interfacesflatfileeventsjobdeletedeventmd).[domain](#domain) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:9](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L9) | |
| ___ | |
| #### origin | |
| • `Optional` **origin**: [`Origin`](#interfacesflatfileeventsoriginmd) | |
| ##### Inherited from | |
| [JobDeletedEvent](#interfacesflatfileeventsjobdeletedeventmd).[origin](#origin) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:28](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L28) | |
| ___ | |
| #### payload | |
| • **payload**: `Record`<`string`, `unknown`\> | |
| ##### Inherited from | |
| [JobDeletedEvent](#interfacesflatfileeventsjobdeletedeventmd).[payload](#payload) | |
| ##### Defined in | |
| [src/api/resources/events/types/JobDeletedEvent.ts:8](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/JobDeletedEvent.ts#L8) | |
| ___ | |
| #### target | |
| • `Optional` **target**: `string` | |
| ##### Inherited from | |
| [JobDeletedEvent](#interfacesflatfileeventsjobdeletedeventmd).[target](#target) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:27](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L27) | |
| ___ | |
| #### topic | |
| • **topic**: [`EventTopic`](#eventtopic-1) | |
| ##### Inherited from | |
| [JobDeletedEvent](#interfacesflatfileeventsjobdeletedeventmd).[topic](#topic) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:10](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L10) | |
| ___ | |
| #### type | |
| • **type**: ``"job:deleted"`` | |
| ##### Defined in | |
| [src/api/resources/events/types/Event.ts:107](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/Event.ts#L107) | |
| <a name="interfacesflatfileeventseventjobfailedmd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / [events](#modulesflatfileeventsmd) / [Event](#modulesflatfileeventseventmd) / JobFailed | |
| ## Interface: JobFailed | |
| [events](#modulesflatfileeventsmd).[Event](#modulesflatfileeventseventmd).JobFailed | |
| ### Hierarchy | |
| - [`JobFailedEvent`](#interfacesflatfileeventsjobfailedeventmd) | |
| ↳ **`JobFailed`** | |
| ### Table of contents | |
| #### Properties | |
| - [acknowledgedAt](#acknowledgedat) | |
| - [acknowledgedBy](#acknowledgedby) | |
| - [attributes](#attributes) | |
| - [callbackUrl](#callbackurl) | |
| - [context](#context) | |
| - [createdAt](#createdat) | |
| - [dataUrl](#dataurl) | |
| - [deletedAt](#deletedat) | |
| - [domain](#domain) | |
| - [origin](#origin) | |
| - [payload](#payload) | |
| - [target](#target) | |
| - [topic](#topic) | |
| - [type](#type) | |
| ### Properties | |
| #### acknowledgedAt | |
| • `Optional` **acknowledgedAt**: `string` | |
| Date the event was acknowledged | |
| ##### Inherited from | |
| [JobFailedEvent](#interfacesflatfileeventsjobfailedeventmd).[acknowledgedAt](#acknowledgedat) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:24](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L24) | |
| ___ | |
| #### acknowledgedBy | |
| • `Optional` **acknowledgedBy**: `string` | |
| The actor (user or system) who acknowledged the event | |
| ##### Inherited from | |
| [JobFailedEvent](#interfacesflatfileeventsjobfailedeventmd).[acknowledgedBy](#acknowledgedby) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:26](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L26) | |
| ___ | |
| #### attributes | |
| • `Optional` **attributes**: [`EventAttributes`](#interfacesflatfileeventseventattributesmd) | |
| The attributes of the event | |
| ##### Inherited from | |
| [JobFailedEvent](#interfacesflatfileeventsjobfailedeventmd).[attributes](#attributes) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:14](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L14) | |
| ___ | |
| #### callbackUrl | |
| • `Optional` **callbackUrl**: `string` | |
| The callback url to acknowledge the event | |
| ##### Inherited from | |
| [JobFailedEvent](#interfacesflatfileeventsjobfailedeventmd).[callbackUrl](#callbackurl) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:16](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L16) | |
| ___ | |
| #### context | |
| • **context**: [`Context`](#interfacesflatfileeventscontextmd) | |
| The context of the event | |
| ##### Inherited from | |
| [JobFailedEvent](#interfacesflatfileeventsjobfailedeventmd).[context](#context) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:12](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L12) | |
| ___ | |
| #### createdAt | |
| • **createdAt**: `Date` | |
| Date the event was created | |
| ##### Inherited from | |
| [JobFailedEvent](#interfacesflatfileeventsjobfailedeventmd).[createdAt](#createdat) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:20](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L20) | |
| ___ | |
| #### dataUrl | |
| • `Optional` **dataUrl**: `string` | |
| The url to retrieve the data associated with the event | |
| ##### Inherited from | |
| [JobFailedEvent](#interfacesflatfileeventsjobfailedeventmd).[dataUrl](#dataurl) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:18](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L18) | |
| ___ | |
| #### deletedAt | |
| • `Optional` **deletedAt**: `Date` | |
| Date the event was deleted | |
| ##### Inherited from | |
| [JobFailedEvent](#interfacesflatfileeventsjobfailedeventmd).[deletedAt](#deletedat) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:22](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L22) | |
| ___ | |
| #### domain | |
| • **domain**: [`Domain`](#domain-1) | |
| The domain of the event | |
| ##### Inherited from | |
| [JobFailedEvent](#interfacesflatfileeventsjobfailedeventmd).[domain](#domain) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:9](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L9) | |
| ___ | |
| #### origin | |
| • `Optional` **origin**: [`Origin`](#interfacesflatfileeventsoriginmd) | |
| ##### Inherited from | |
| [JobFailedEvent](#interfacesflatfileeventsjobfailedeventmd).[origin](#origin) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:28](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L28) | |
| ___ | |
| #### payload | |
| • **payload**: [`JobFailedPayload`](#interfacesflatfileeventsjobfailedpayloadmd) | |
| ##### Inherited from | |
| [JobFailedEvent](#interfacesflatfileeventsjobfailedeventmd).[payload](#payload) | |
| ##### Defined in | |
| [src/api/resources/events/types/JobFailedEvent.ts:8](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/JobFailedEvent.ts#L8) | |
| ___ | |
| #### target | |
| • `Optional` **target**: `string` | |
| ##### Inherited from | |
| [JobFailedEvent](#interfacesflatfileeventsjobfailedeventmd).[target](#target) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:27](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L27) | |
| ___ | |
| #### topic | |
| • **topic**: [`EventTopic`](#eventtopic-1) | |
| ##### Inherited from | |
| [JobFailedEvent](#interfacesflatfileeventsjobfailedeventmd).[topic](#topic) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:10](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L10) | |
| ___ | |
| #### type | |
| • **type**: ``"job:failed"`` | |
| ##### Defined in | |
| [src/api/resources/events/types/Event.ts:99](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/Event.ts#L99) | |
| <a name="interfacesflatfileeventseventjobstartedmd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / [events](#modulesflatfileeventsmd) / [Event](#modulesflatfileeventseventmd) / JobStarted | |
| ## Interface: JobStarted | |
| [events](#modulesflatfileeventsmd).[Event](#modulesflatfileeventseventmd).JobStarted | |
| ### Hierarchy | |
| - [`JobStartedEvent`](#interfacesflatfileeventsjobstartedeventmd) | |
| ↳ **`JobStarted`** | |
| ### Table of contents | |
| #### Properties | |
| - [acknowledgedAt](#acknowledgedat) | |
| - [acknowledgedBy](#acknowledgedby) | |
| - [attributes](#attributes) | |
| - [callbackUrl](#callbackurl) | |
| - [context](#context) | |
| - [createdAt](#createdat) | |
| - [dataUrl](#dataurl) | |
| - [deletedAt](#deletedat) | |
| - [domain](#domain) | |
| - [origin](#origin) | |
| - [payload](#payload) | |
| - [target](#target) | |
| - [topic](#topic) | |
| - [type](#type) | |
| ### Properties | |
| #### acknowledgedAt | |
| • `Optional` **acknowledgedAt**: `string` | |
| Date the event was acknowledged | |
| ##### Inherited from | |
| [JobStartedEvent](#interfacesflatfileeventsjobstartedeventmd).[acknowledgedAt](#acknowledgedat) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:24](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L24) | |
| ___ | |
| #### acknowledgedBy | |
| • `Optional` **acknowledgedBy**: `string` | |
| The actor (user or system) who acknowledged the event | |
| ##### Inherited from | |
| [JobStartedEvent](#interfacesflatfileeventsjobstartedeventmd).[acknowledgedBy](#acknowledgedby) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:26](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L26) | |
| ___ | |
| #### attributes | |
| • `Optional` **attributes**: [`EventAttributes`](#interfacesflatfileeventseventattributesmd) | |
| The attributes of the event | |
| ##### Inherited from | |
| [JobStartedEvent](#interfacesflatfileeventsjobstartedeventmd).[attributes](#attributes) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:14](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L14) | |
| ___ | |
| #### callbackUrl | |
| • `Optional` **callbackUrl**: `string` | |
| The callback url to acknowledge the event | |
| ##### Inherited from | |
| [JobStartedEvent](#interfacesflatfileeventsjobstartedeventmd).[callbackUrl](#callbackurl) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:16](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L16) | |
| ___ | |
| #### context | |
| • **context**: [`Context`](#interfacesflatfileeventscontextmd) | |
| The context of the event | |
| ##### Inherited from | |
| [JobStartedEvent](#interfacesflatfileeventsjobstartedeventmd).[context](#context) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:12](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L12) | |
| ___ | |
| #### createdAt | |
| • **createdAt**: `Date` | |
| Date the event was created | |
| ##### Inherited from | |
| [JobStartedEvent](#interfacesflatfileeventsjobstartedeventmd).[createdAt](#createdat) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:20](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L20) | |
| ___ | |
| #### dataUrl | |
| • `Optional` **dataUrl**: `string` | |
| The url to retrieve the data associated with the event | |
| ##### Inherited from | |
| [JobStartedEvent](#interfacesflatfileeventsjobstartedeventmd).[dataUrl](#dataurl) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:18](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L18) | |
| ___ | |
| #### deletedAt | |
| • `Optional` **deletedAt**: `Date` | |
| Date the event was deleted | |
| ##### Inherited from | |
| [JobStartedEvent](#interfacesflatfileeventsjobstartedeventmd).[deletedAt](#deletedat) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:22](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L22) | |
| ___ | |
| #### domain | |
| • **domain**: [`Domain`](#domain-1) | |
| The domain of the event | |
| ##### Inherited from | |
| [JobStartedEvent](#interfacesflatfileeventsjobstartedeventmd).[domain](#domain) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:9](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L9) | |
| ___ | |
| #### origin | |
| • `Optional` **origin**: [`Origin`](#interfacesflatfileeventsoriginmd) | |
| ##### Inherited from | |
| [JobStartedEvent](#interfacesflatfileeventsjobstartedeventmd).[origin](#origin) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:28](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L28) | |
| ___ | |
| #### payload | |
| • **payload**: [`JobPayload`](#interfacesflatfileeventsjobpayloadmd) | |
| ##### Inherited from | |
| [JobStartedEvent](#interfacesflatfileeventsjobstartedeventmd).[payload](#payload) | |
| ##### Defined in | |
| [src/api/resources/events/types/JobStartedEvent.ts:8](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/JobStartedEvent.ts#L8) | |
| ___ | |
| #### target | |
| • `Optional` **target**: `string` | |
| ##### Inherited from | |
| [JobStartedEvent](#interfacesflatfileeventsjobstartedeventmd).[target](#target) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:27](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L27) | |
| ___ | |
| #### topic | |
| • **topic**: [`EventTopic`](#eventtopic-1) | |
| ##### Inherited from | |
| [JobStartedEvent](#interfacesflatfileeventsjobstartedeventmd).[topic](#topic) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:10](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L10) | |
| ___ | |
| #### type | |
| • **type**: ``"job:started"`` | |
| ##### Defined in | |
| [src/api/resources/events/types/Event.ts:87](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/Event.ts#L87) | |
| <a name="interfacesflatfileeventseventjobupdatedmd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / [events](#modulesflatfileeventsmd) / [Event](#modulesflatfileeventseventmd) / JobUpdated | |
| ## Interface: JobUpdated | |
| [events](#modulesflatfileeventsmd).[Event](#modulesflatfileeventseventmd).JobUpdated | |
| ### Hierarchy | |
| - [`JobUpdatedEvent`](#interfacesflatfileeventsjobupdatedeventmd) | |
| ↳ **`JobUpdated`** | |
| ### Table of contents | |
| #### Properties | |
| - [acknowledgedAt](#acknowledgedat) | |
| - [acknowledgedBy](#acknowledgedby) | |
| - [attributes](#attributes) | |
| - [callbackUrl](#callbackurl) | |
| - [context](#context) | |
| - [createdAt](#createdat) | |
| - [dataUrl](#dataurl) | |
| - [deletedAt](#deletedat) | |
| - [domain](#domain) | |
| - [origin](#origin) | |
| - [payload](#payload) | |
| - [target](#target) | |
| - [topic](#topic) | |
| - [type](#type) | |
| ### Properties | |
| #### acknowledgedAt | |
| • `Optional` **acknowledgedAt**: `string` | |
| Date the event was acknowledged | |
| ##### Inherited from | |
| [JobUpdatedEvent](#interfacesflatfileeventsjobupdatedeventmd).[acknowledgedAt](#acknowledgedat) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:24](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L24) | |
| ___ | |
| #### acknowledgedBy | |
| • `Optional` **acknowledgedBy**: `string` | |
| The actor (user or system) who acknowledged the event | |
| ##### Inherited from | |
| [JobUpdatedEvent](#interfacesflatfileeventsjobupdatedeventmd).[acknowledgedBy](#acknowledgedby) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:26](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L26) | |
| ___ | |
| #### attributes | |
| • `Optional` **attributes**: [`EventAttributes`](#interfacesflatfileeventseventattributesmd) | |
| The attributes of the event | |
| ##### Inherited from | |
| [JobUpdatedEvent](#interfacesflatfileeventsjobupdatedeventmd).[attributes](#attributes) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:14](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L14) | |
| ___ | |
| #### callbackUrl | |
| • `Optional` **callbackUrl**: `string` | |
| The callback url to acknowledge the event | |
| ##### Inherited from | |
| [JobUpdatedEvent](#interfacesflatfileeventsjobupdatedeventmd).[callbackUrl](#callbackurl) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:16](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L16) | |
| ___ | |
| #### context | |
| • **context**: [`Context`](#interfacesflatfileeventscontextmd) | |
| The context of the event | |
| ##### Inherited from | |
| [JobUpdatedEvent](#interfacesflatfileeventsjobupdatedeventmd).[context](#context) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:12](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L12) | |
| ___ | |
| #### createdAt | |
| • **createdAt**: `Date` | |
| Date the event was created | |
| ##### Inherited from | |
| [JobUpdatedEvent](#interfacesflatfileeventsjobupdatedeventmd).[createdAt](#createdat) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:20](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L20) | |
| ___ | |
| #### dataUrl | |
| • `Optional` **dataUrl**: `string` | |
| The url to retrieve the data associated with the event | |
| ##### Inherited from | |
| [JobUpdatedEvent](#interfacesflatfileeventsjobupdatedeventmd).[dataUrl](#dataurl) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:18](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L18) | |
| ___ | |
| #### deletedAt | |
| • `Optional` **deletedAt**: `Date` | |
| Date the event was deleted | |
| ##### Inherited from | |
| [JobUpdatedEvent](#interfacesflatfileeventsjobupdatedeventmd).[deletedAt](#deletedat) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:22](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L22) | |
| ___ | |
| #### domain | |
| • **domain**: [`Domain`](#domain-1) | |
| The domain of the event | |
| ##### Inherited from | |
| [JobUpdatedEvent](#interfacesflatfileeventsjobupdatedeventmd).[domain](#domain) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:9](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L9) | |
| ___ | |
| #### origin | |
| • `Optional` **origin**: [`Origin`](#interfacesflatfileeventsoriginmd) | |
| ##### Inherited from | |
| [JobUpdatedEvent](#interfacesflatfileeventsjobupdatedeventmd).[origin](#origin) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:28](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L28) | |
| ___ | |
| #### payload | |
| • **payload**: [`JobPayload`](#interfacesflatfileeventsjobpayloadmd) | |
| ##### Inherited from | |
| [JobUpdatedEvent](#interfacesflatfileeventsjobupdatedeventmd).[payload](#payload) | |
| ##### Defined in | |
| [src/api/resources/events/types/JobUpdatedEvent.ts:8](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/JobUpdatedEvent.ts#L8) | |
| ___ | |
| #### target | |
| • `Optional` **target**: `string` | |
| ##### Inherited from | |
| [JobUpdatedEvent](#interfacesflatfileeventsjobupdatedeventmd).[target](#target) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:27](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L27) | |
| ___ | |
| #### topic | |
| • **topic**: [`EventTopic`](#eventtopic-1) | |
| ##### Inherited from | |
| [JobUpdatedEvent](#interfacesflatfileeventsjobupdatedeventmd).[topic](#topic) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:10](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L10) | |
| ___ | |
| #### type | |
| • **type**: ``"job:updated"`` | |
| ##### Defined in | |
| [src/api/resources/events/types/Event.ts:95](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/Event.ts#L95) | |
| <a name="interfacesflatfileeventseventjobwaitingmd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / [events](#modulesflatfileeventsmd) / [Event](#modulesflatfileeventseventmd) / JobWaiting | |
| ## Interface: JobWaiting | |
| [events](#modulesflatfileeventsmd).[Event](#modulesflatfileeventseventmd).JobWaiting | |
| ### Hierarchy | |
| - [`JobWaitingEvent`](#interfacesflatfileeventsjobwaitingeventmd) | |
| ↳ **`JobWaiting`** | |
| ### Table of contents | |
| #### Properties | |
| - [acknowledgedAt](#acknowledgedat) | |
| - [acknowledgedBy](#acknowledgedby) | |
| - [attributes](#attributes) | |
| - [callbackUrl](#callbackurl) | |
| - [context](#context) | |
| - [createdAt](#createdat) | |
| - [dataUrl](#dataurl) | |
| - [deletedAt](#deletedat) | |
| - [domain](#domain) | |
| - [origin](#origin) | |
| - [payload](#payload) | |
| - [target](#target) | |
| - [topic](#topic) | |
| - [type](#type) | |
| ### Properties | |
| #### acknowledgedAt | |
| • `Optional` **acknowledgedAt**: `string` | |
| Date the event was acknowledged | |
| ##### Inherited from | |
| [JobWaitingEvent](#interfacesflatfileeventsjobwaitingeventmd).[acknowledgedAt](#acknowledgedat) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:24](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L24) | |
| ___ | |
| #### acknowledgedBy | |
| • `Optional` **acknowledgedBy**: `string` | |
| The actor (user or system) who acknowledged the event | |
| ##### Inherited from | |
| [JobWaitingEvent](#interfacesflatfileeventsjobwaitingeventmd).[acknowledgedBy](#acknowledgedby) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:26](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L26) | |
| ___ | |
| #### attributes | |
| • `Optional` **attributes**: [`EventAttributes`](#interfacesflatfileeventseventattributesmd) | |
| The attributes of the event | |
| ##### Inherited from | |
| [JobWaitingEvent](#interfacesflatfileeventsjobwaitingeventmd).[attributes](#attributes) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:14](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L14) | |
| ___ | |
| #### callbackUrl | |
| • `Optional` **callbackUrl**: `string` | |
| The callback url to acknowledge the event | |
| ##### Inherited from | |
| [JobWaitingEvent](#interfacesflatfileeventsjobwaitingeventmd).[callbackUrl](#callbackurl) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:16](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L16) | |
| ___ | |
| #### context | |
| • **context**: [`Context`](#interfacesflatfileeventscontextmd) | |
| The context of the event | |
| ##### Inherited from | |
| [JobWaitingEvent](#interfacesflatfileeventsjobwaitingeventmd).[context](#context) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:12](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L12) | |
| ___ | |
| #### createdAt | |
| • **createdAt**: `Date` | |
| Date the event was created | |
| ##### Inherited from | |
| [JobWaitingEvent](#interfacesflatfileeventsjobwaitingeventmd).[createdAt](#createdat) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:20](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L20) | |
| ___ | |
| #### dataUrl | |
| • `Optional` **dataUrl**: `string` | |
| The url to retrieve the data associated with the event | |
| ##### Inherited from | |
| [JobWaitingEvent](#interfacesflatfileeventsjobwaitingeventmd).[dataUrl](#dataurl) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:18](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L18) | |
| ___ | |
| #### deletedAt | |
| • `Optional` **deletedAt**: `Date` | |
| Date the event was deleted | |
| ##### Inherited from | |
| [JobWaitingEvent](#interfacesflatfileeventsjobwaitingeventmd).[deletedAt](#deletedat) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:22](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L22) | |
| ___ | |
| #### domain | |
| • **domain**: [`Domain`](#domain-1) | |
| The domain of the event | |
| ##### Inherited from | |
| [JobWaitingEvent](#interfacesflatfileeventsjobwaitingeventmd).[domain](#domain) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:9](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L9) | |
| ___ | |
| #### origin | |
| • `Optional` **origin**: [`Origin`](#interfacesflatfileeventsoriginmd) | |
| ##### Inherited from | |
| [JobWaitingEvent](#interfacesflatfileeventsjobwaitingeventmd).[origin](#origin) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:28](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L28) | |
| ___ | |
| #### payload | |
| • **payload**: `Record`<`string`, `unknown`\> | |
| ##### Inherited from | |
| [JobWaitingEvent](#interfacesflatfileeventsjobwaitingeventmd).[payload](#payload) | |
| ##### Defined in | |
| [src/api/resources/events/types/JobWaitingEvent.ts:8](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/JobWaitingEvent.ts#L8) | |
| ___ | |
| #### target | |
| • `Optional` **target**: `string` | |
| ##### Inherited from | |
| [JobWaitingEvent](#interfacesflatfileeventsjobwaitingeventmd).[target](#target) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:27](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L27) | |
| ___ | |
| #### topic | |
| • **topic**: [`EventTopic`](#eventtopic-1) | |
| ##### Inherited from | |
| [JobWaitingEvent](#interfacesflatfileeventsjobwaitingeventmd).[topic](#topic) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:10](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L10) | |
| ___ | |
| #### type | |
| • **type**: ``"job:waiting"`` | |
| ##### Defined in | |
| [src/api/resources/events/types/Event.ts:91](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/Event.ts#L91) | |
| <a name="interfacesflatfileeventseventrecordscreatedmd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / [events](#modulesflatfileeventsmd) / [Event](#modulesflatfileeventseventmd) / RecordsCreated | |
| ## Interface: RecordsCreated | |
| [events](#modulesflatfileeventsmd).[Event](#modulesflatfileeventseventmd).RecordsCreated | |
| ### Hierarchy | |
| - [`RecordsCreatedEvent`](#interfacesflatfileeventsrecordscreatedeventmd) | |
| ↳ **`RecordsCreated`** | |
| ### Table of contents | |
| #### Properties | |
| - [acknowledgedAt](#acknowledgedat) | |
| - [acknowledgedBy](#acknowledgedby) | |
| - [attributes](#attributes) | |
| - [callbackUrl](#callbackurl) | |
| - [context](#context) | |
| - [createdAt](#createdat) | |
| - [dataUrl](#dataurl) | |
| - [deletedAt](#deletedat) | |
| - [domain](#domain) | |
| - [origin](#origin) | |
| - [payload](#payload) | |
| - [target](#target) | |
| - [topic](#topic) | |
| - [type](#type) | |
| ### Properties | |
| #### acknowledgedAt | |
| • `Optional` **acknowledgedAt**: `string` | |
| Date the event was acknowledged | |
| ##### Inherited from | |
| [RecordsCreatedEvent](#interfacesflatfileeventsrecordscreatedeventmd).[acknowledgedAt](#acknowledgedat) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:24](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L24) | |
| ___ | |
| #### acknowledgedBy | |
| • `Optional` **acknowledgedBy**: `string` | |
| The actor (user or system) who acknowledged the event | |
| ##### Inherited from | |
| [RecordsCreatedEvent](#interfacesflatfileeventsrecordscreatedeventmd).[acknowledgedBy](#acknowledgedby) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:26](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L26) | |
| ___ | |
| #### attributes | |
| • `Optional` **attributes**: [`EventAttributes`](#interfacesflatfileeventseventattributesmd) | |
| The attributes of the event | |
| ##### Inherited from | |
| [RecordsCreatedEvent](#interfacesflatfileeventsrecordscreatedeventmd).[attributes](#attributes) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:14](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L14) | |
| ___ | |
| #### callbackUrl | |
| • `Optional` **callbackUrl**: `string` | |
| The callback url to acknowledge the event | |
| ##### Inherited from | |
| [RecordsCreatedEvent](#interfacesflatfileeventsrecordscreatedeventmd).[callbackUrl](#callbackurl) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:16](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L16) | |
| ___ | |
| #### context | |
| • **context**: [`Context`](#interfacesflatfileeventscontextmd) | |
| The context of the event | |
| ##### Inherited from | |
| [RecordsCreatedEvent](#interfacesflatfileeventsrecordscreatedeventmd).[context](#context) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:12](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L12) | |
| ___ | |
| #### createdAt | |
| • **createdAt**: `Date` | |
| Date the event was created | |
| ##### Inherited from | |
| [RecordsCreatedEvent](#interfacesflatfileeventsrecordscreatedeventmd).[createdAt](#createdat) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:20](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L20) | |
| ___ | |
| #### dataUrl | |
| • `Optional` **dataUrl**: `string` | |
| The url to retrieve the data associated with the event | |
| ##### Inherited from | |
| [RecordsCreatedEvent](#interfacesflatfileeventsrecordscreatedeventmd).[dataUrl](#dataurl) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:18](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L18) | |
| ___ | |
| #### deletedAt | |
| • `Optional` **deletedAt**: `Date` | |
| Date the event was deleted | |
| ##### Inherited from | |
| [RecordsCreatedEvent](#interfacesflatfileeventsrecordscreatedeventmd).[deletedAt](#deletedat) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:22](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L22) | |
| ___ | |
| #### domain | |
| • **domain**: [`Domain`](#domain-1) | |
| The domain of the event | |
| ##### Inherited from | |
| [RecordsCreatedEvent](#interfacesflatfileeventsrecordscreatedeventmd).[domain](#domain) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:9](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L9) | |
| ___ | |
| #### origin | |
| • `Optional` **origin**: [`Origin`](#interfacesflatfileeventsoriginmd) | |
| ##### Inherited from | |
| [RecordsCreatedEvent](#interfacesflatfileeventsrecordscreatedeventmd).[origin](#origin) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:28](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L28) | |
| ___ | |
| #### payload | |
| • **payload**: [`RecordsPayload`](#interfacesflatfileeventsrecordspayloadmd) | |
| ##### Inherited from | |
| [RecordsCreatedEvent](#interfacesflatfileeventsrecordscreatedeventmd).[payload](#payload) | |
| ##### Defined in | |
| [src/api/resources/events/types/RecordsCreatedEvent.ts:8](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/RecordsCreatedEvent.ts#L8) | |
| ___ | |
| #### target | |
| • `Optional` **target**: `string` | |
| ##### Inherited from | |
| [RecordsCreatedEvent](#interfacesflatfileeventsrecordscreatedeventmd).[target](#target) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:27](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L27) | |
| ___ | |
| #### topic | |
| • **topic**: [`EventTopic`](#eventtopic-1) | |
| ##### Inherited from | |
| [RecordsCreatedEvent](#interfacesflatfileeventsrecordscreatedeventmd).[topic](#topic) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:10](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L10) | |
| ___ | |
| #### type | |
| • **type**: ``"records:created"`` | |
| ##### Defined in | |
| [src/api/resources/events/types/Event.ts:111](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/Event.ts#L111) | |
| <a name="interfacesflatfileeventseventrecordsdeletedmd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / [events](#modulesflatfileeventsmd) / [Event](#modulesflatfileeventseventmd) / RecordsDeleted | |
| ## Interface: RecordsDeleted | |
| [events](#modulesflatfileeventsmd).[Event](#modulesflatfileeventseventmd).RecordsDeleted | |
| ### Hierarchy | |
| - [`RecordsDeletedEvent`](#interfacesflatfileeventsrecordsdeletedeventmd) | |
| ↳ **`RecordsDeleted`** | |
| ### Table of contents | |
| #### Properties | |
| - [acknowledgedAt](#acknowledgedat) | |
| - [acknowledgedBy](#acknowledgedby) | |
| - [attributes](#attributes) | |
| - [callbackUrl](#callbackurl) | |
| - [context](#context) | |
| - [createdAt](#createdat) | |
| - [dataUrl](#dataurl) | |
| - [deletedAt](#deletedat) | |
| - [domain](#domain) | |
| - [origin](#origin) | |
| - [payload](#payload) | |
| - [target](#target) | |
| - [topic](#topic) | |
| - [type](#type) | |
| ### Properties | |
| #### acknowledgedAt | |
| • `Optional` **acknowledgedAt**: `string` | |
| Date the event was acknowledged | |
| ##### Inherited from | |
| [RecordsDeletedEvent](#interfacesflatfileeventsrecordsdeletedeventmd).[acknowledgedAt](#acknowledgedat) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:24](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L24) | |
| ___ | |
| #### acknowledgedBy | |
| • `Optional` **acknowledgedBy**: `string` | |
| The actor (user or system) who acknowledged the event | |
| ##### Inherited from | |
| [RecordsDeletedEvent](#interfacesflatfileeventsrecordsdeletedeventmd).[acknowledgedBy](#acknowledgedby) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:26](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L26) | |
| ___ | |
| #### attributes | |
| • `Optional` **attributes**: [`EventAttributes`](#interfacesflatfileeventseventattributesmd) | |
| The attributes of the event | |
| ##### Inherited from | |
| [RecordsDeletedEvent](#interfacesflatfileeventsrecordsdeletedeventmd).[attributes](#attributes) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:14](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L14) | |
| ___ | |
| #### callbackUrl | |
| • `Optional` **callbackUrl**: `string` | |
| The callback url to acknowledge the event | |
| ##### Inherited from | |
| [RecordsDeletedEvent](#interfacesflatfileeventsrecordsdeletedeventmd).[callbackUrl](#callbackurl) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:16](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L16) | |
| ___ | |
| #### context | |
| • **context**: [`Context`](#interfacesflatfileeventscontextmd) | |
| The context of the event | |
| ##### Inherited from | |
| [RecordsDeletedEvent](#interfacesflatfileeventsrecordsdeletedeventmd).[context](#context) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:12](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L12) | |
| ___ | |
| #### createdAt | |
| • **createdAt**: `Date` | |
| Date the event was created | |
| ##### Inherited from | |
| [RecordsDeletedEvent](#interfacesflatfileeventsrecordsdeletedeventmd).[createdAt](#createdat) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:20](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L20) | |
| ___ | |
| #### dataUrl | |
| • `Optional` **dataUrl**: `string` | |
| The url to retrieve the data associated with the event | |
| ##### Inherited from | |
| [RecordsDeletedEvent](#interfacesflatfileeventsrecordsdeletedeventmd).[dataUrl](#dataurl) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:18](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L18) | |
| ___ | |
| #### deletedAt | |
| • `Optional` **deletedAt**: `Date` | |
| Date the event was deleted | |
| ##### Inherited from | |
| [RecordsDeletedEvent](#interfacesflatfileeventsrecordsdeletedeventmd).[deletedAt](#deletedat) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:22](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L22) | |
| ___ | |
| #### domain | |
| • **domain**: [`Domain`](#domain-1) | |
| The domain of the event | |
| ##### Inherited from | |
| [RecordsDeletedEvent](#interfacesflatfileeventsrecordsdeletedeventmd).[domain](#domain) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:9](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L9) | |
| ___ | |
| #### origin | |
| • `Optional` **origin**: [`Origin`](#interfacesflatfileeventsoriginmd) | |
| ##### Inherited from | |
| [RecordsDeletedEvent](#interfacesflatfileeventsrecordsdeletedeventmd).[origin](#origin) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:28](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L28) | |
| ___ | |
| #### payload | |
| • **payload**: `Record`<`string`, `unknown`\> | |
| ##### Inherited from | |
| [RecordsDeletedEvent](#interfacesflatfileeventsrecordsdeletedeventmd).[payload](#payload) | |
| ##### Defined in | |
| [src/api/resources/events/types/RecordsDeletedEvent.ts:8](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/RecordsDeletedEvent.ts#L8) | |
| ___ | |
| #### target | |
| • `Optional` **target**: `string` | |
| ##### Inherited from | |
| [RecordsDeletedEvent](#interfacesflatfileeventsrecordsdeletedeventmd).[target](#target) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:27](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L27) | |
| ___ | |
| #### topic | |
| • **topic**: [`EventTopic`](#eventtopic-1) | |
| ##### Inherited from | |
| [RecordsDeletedEvent](#interfacesflatfileeventsrecordsdeletedeventmd).[topic](#topic) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:10](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L10) | |
| ___ | |
| #### type | |
| • **type**: ``"records:deleted"`` | |
| ##### Defined in | |
| [src/api/resources/events/types/Event.ts:119](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/Event.ts#L119) | |
| <a name="interfacesflatfileeventseventrecordsupdatedmd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / [events](#modulesflatfileeventsmd) / [Event](#modulesflatfileeventseventmd) / RecordsUpdated | |
| ## Interface: RecordsUpdated | |
| [events](#modulesflatfileeventsmd).[Event](#modulesflatfileeventseventmd).RecordsUpdated | |
| ### Hierarchy | |
| - [`RecordsUpdatedEvent`](#interfacesflatfileeventsrecordsupdatedeventmd) | |
| ↳ **`RecordsUpdated`** | |
| ### Table of contents | |
| #### Properties | |
| - [acknowledgedAt](#acknowledgedat) | |
| - [acknowledgedBy](#acknowledgedby) | |
| - [attributes](#attributes) | |
| - [callbackUrl](#callbackurl) | |
| - [context](#context) | |
| - [createdAt](#createdat) | |
| - [dataUrl](#dataurl) | |
| - [deletedAt](#deletedat) | |
| - [domain](#domain) | |
| - [origin](#origin) | |
| - [payload](#payload) | |
| - [target](#target) | |
| - [topic](#topic) | |
| - [type](#type) | |
| ### Properties | |
| #### acknowledgedAt | |
| • `Optional` **acknowledgedAt**: `string` | |
| Date the event was acknowledged | |
| ##### Inherited from | |
| [RecordsUpdatedEvent](#interfacesflatfileeventsrecordsupdatedeventmd).[acknowledgedAt](#acknowledgedat) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:24](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L24) | |
| ___ | |
| #### acknowledgedBy | |
| • `Optional` **acknowledgedBy**: `string` | |
| The actor (user or system) who acknowledged the event | |
| ##### Inherited from | |
| [RecordsUpdatedEvent](#interfacesflatfileeventsrecordsupdatedeventmd).[acknowledgedBy](#acknowledgedby) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:26](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L26) | |
| ___ | |
| #### attributes | |
| • `Optional` **attributes**: [`EventAttributes`](#interfacesflatfileeventseventattributesmd) | |
| The attributes of the event | |
| ##### Inherited from | |
| [RecordsUpdatedEvent](#interfacesflatfileeventsrecordsupdatedeventmd).[attributes](#attributes) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:14](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L14) | |
| ___ | |
| #### callbackUrl | |
| • `Optional` **callbackUrl**: `string` | |
| The callback url to acknowledge the event | |
| ##### Inherited from | |
| [RecordsUpdatedEvent](#interfacesflatfileeventsrecordsupdatedeventmd).[callbackUrl](#callbackurl) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:16](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L16) | |
| ___ | |
| #### context | |
| • **context**: [`Context`](#interfacesflatfileeventscontextmd) | |
| The context of the event | |
| ##### Inherited from | |
| [RecordsUpdatedEvent](#interfacesflatfileeventsrecordsupdatedeventmd).[context](#context) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:12](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L12) | |
| ___ | |
| #### createdAt | |
| • **createdAt**: `Date` | |
| Date the event was created | |
| ##### Inherited from | |
| [RecordsUpdatedEvent](#interfacesflatfileeventsrecordsupdatedeventmd).[createdAt](#createdat) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:20](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L20) | |
| ___ | |
| #### dataUrl | |
| • `Optional` **dataUrl**: `string` | |
| The url to retrieve the data associated with the event | |
| ##### Inherited from | |
| [RecordsUpdatedEvent](#interfacesflatfileeventsrecordsupdatedeventmd).[dataUrl](#dataurl) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:18](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L18) | |
| ___ | |
| #### deletedAt | |
| • `Optional` **deletedAt**: `Date` | |
| Date the event was deleted | |
| ##### Inherited from | |
| [RecordsUpdatedEvent](#interfacesflatfileeventsrecordsupdatedeventmd).[deletedAt](#deletedat) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:22](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L22) | |
| ___ | |
| #### domain | |
| • **domain**: [`Domain`](#domain-1) | |
| The domain of the event | |
| ##### Inherited from | |
| [RecordsUpdatedEvent](#interfacesflatfileeventsrecordsupdatedeventmd).[domain](#domain) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:9](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L9) | |
| ___ | |
| #### origin | |
| • `Optional` **origin**: [`Origin`](#interfacesflatfileeventsoriginmd) | |
| ##### Inherited from | |
| [RecordsUpdatedEvent](#interfacesflatfileeventsrecordsupdatedeventmd).[origin](#origin) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:28](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L28) | |
| ___ | |
| #### payload | |
| • **payload**: [`RecordsPayload`](#interfacesflatfileeventsrecordspayloadmd) | |
| ##### Inherited from | |
| [RecordsUpdatedEvent](#interfacesflatfileeventsrecordsupdatedeventmd).[payload](#payload) | |
| ##### Defined in | |
| [src/api/resources/events/types/RecordsUpdatedEvent.ts:8](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/RecordsUpdatedEvent.ts#L8) | |
| ___ | |
| #### target | |
| • `Optional` **target**: `string` | |
| ##### Inherited from | |
| [RecordsUpdatedEvent](#interfacesflatfileeventsrecordsupdatedeventmd).[target](#target) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:27](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L27) | |
| ___ | |
| #### topic | |
| • **topic**: [`EventTopic`](#eventtopic-1) | |
| ##### Inherited from | |
| [RecordsUpdatedEvent](#interfacesflatfileeventsrecordsupdatedeventmd).[topic](#topic) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:10](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L10) | |
| ___ | |
| #### type | |
| • **type**: ``"records:updated"`` | |
| ##### Defined in | |
| [src/api/resources/events/types/Event.ts:115](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/Event.ts#L115) | |
| <a name="interfacesflatfileeventseventsheetvalidatedmd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / [events](#modulesflatfileeventsmd) / [Event](#modulesflatfileeventseventmd) / SheetValidated | |
| ## Interface: SheetValidated | |
| [events](#modulesflatfileeventsmd).[Event](#modulesflatfileeventseventmd).SheetValidated | |
| ### Hierarchy | |
| - [`SheetValidatedEvent`](#interfacesflatfileeventssheetvalidatedeventmd) | |
| ↳ **`SheetValidated`** | |
| ### Table of contents | |
| #### Properties | |
| - [acknowledgedAt](#acknowledgedat) | |
| - [acknowledgedBy](#acknowledgedby) | |
| - [attributes](#attributes) | |
| - [callbackUrl](#callbackurl) | |
| - [context](#context) | |
| - [createdAt](#createdat) | |
| - [dataUrl](#dataurl) | |
| - [deletedAt](#deletedat) | |
| - [domain](#domain) | |
| - [origin](#origin) | |
| - [payload](#payload) | |
| - [target](#target) | |
| - [topic](#topic) | |
| - [type](#type) | |
| ### Properties | |
| #### acknowledgedAt | |
| • `Optional` **acknowledgedAt**: `string` | |
| Date the event was acknowledged | |
| ##### Inherited from | |
| [SheetValidatedEvent](#interfacesflatfileeventssheetvalidatedeventmd).[acknowledgedAt](#acknowledgedat) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:24](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L24) | |
| ___ | |
| #### acknowledgedBy | |
| • `Optional` **acknowledgedBy**: `string` | |
| The actor (user or system) who acknowledged the event | |
| ##### Inherited from | |
| [SheetValidatedEvent](#interfacesflatfileeventssheetvalidatedeventmd).[acknowledgedBy](#acknowledgedby) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:26](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L26) | |
| ___ | |
| #### attributes | |
| • `Optional` **attributes**: [`EventAttributes`](#interfacesflatfileeventseventattributesmd) | |
| The attributes of the event | |
| ##### Inherited from | |
| [SheetValidatedEvent](#interfacesflatfileeventssheetvalidatedeventmd).[attributes](#attributes) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:14](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L14) | |
| ___ | |
| #### callbackUrl | |
| • `Optional` **callbackUrl**: `string` | |
| The callback url to acknowledge the event | |
| ##### Inherited from | |
| [SheetValidatedEvent](#interfacesflatfileeventssheetvalidatedeventmd).[callbackUrl](#callbackurl) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:16](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L16) | |
| ___ | |
| #### context | |
| • **context**: [`Context`](#interfacesflatfileeventscontextmd) | |
| The context of the event | |
| ##### Inherited from | |
| [SheetValidatedEvent](#interfacesflatfileeventssheetvalidatedeventmd).[context](#context) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:12](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L12) | |
| ___ | |
| #### createdAt | |
| • **createdAt**: `Date` | |
| Date the event was created | |
| ##### Inherited from | |
| [SheetValidatedEvent](#interfacesflatfileeventssheetvalidatedeventmd).[createdAt](#createdat) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:20](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L20) | |
| ___ | |
| #### dataUrl | |
| • `Optional` **dataUrl**: `string` | |
| The url to retrieve the data associated with the event | |
| ##### Inherited from | |
| [SheetValidatedEvent](#interfacesflatfileeventssheetvalidatedeventmd).[dataUrl](#dataurl) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:18](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L18) | |
| ___ | |
| #### deletedAt | |
| • `Optional` **deletedAt**: `Date` | |
| Date the event was deleted | |
| ##### Inherited from | |
| [SheetValidatedEvent](#interfacesflatfileeventssheetvalidatedeventmd).[deletedAt](#deletedat) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:22](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L22) | |
| ___ | |
| #### domain | |
| • **domain**: [`Domain`](#domain-1) | |
| The domain of the event | |
| ##### Inherited from | |
| [SheetValidatedEvent](#interfacesflatfileeventssheetvalidatedeventmd).[domain](#domain) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:9](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L9) | |
| ___ | |
| #### origin | |
| • `Optional` **origin**: [`Origin`](#interfacesflatfileeventsoriginmd) | |
| ##### Inherited from | |
| [SheetValidatedEvent](#interfacesflatfileeventssheetvalidatedeventmd).[origin](#origin) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:28](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L28) | |
| ___ | |
| #### payload | |
| • **payload**: `Record`<`string`, `unknown`\> | |
| ##### Inherited from | |
| [SheetValidatedEvent](#interfacesflatfileeventssheetvalidatedeventmd).[payload](#payload) | |
| ##### Defined in | |
| [src/api/resources/events/types/SheetValidatedEvent.ts:8](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/SheetValidatedEvent.ts#L8) | |
| ___ | |
| #### target | |
| • `Optional` **target**: `string` | |
| ##### Inherited from | |
| [SheetValidatedEvent](#interfacesflatfileeventssheetvalidatedeventmd).[target](#target) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:27](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L27) | |
| ___ | |
| #### topic | |
| • **topic**: [`EventTopic`](#eventtopic-1) | |
| ##### Inherited from | |
| [SheetValidatedEvent](#interfacesflatfileeventssheetvalidatedeventmd).[topic](#topic) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:10](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L10) | |
| ___ | |
| #### type | |
| • **type**: ``"sheet:validated"`` | |
| ##### Defined in | |
| [src/api/resources/events/types/Event.ts:123](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/Event.ts#L123) | |
| <a name="interfacesflatfileeventseventspaceaddedmd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / [events](#modulesflatfileeventsmd) / [Event](#modulesflatfileeventseventmd) / SpaceAdded | |
| ## Interface: SpaceAdded | |
| [events](#modulesflatfileeventsmd).[Event](#modulesflatfileeventseventmd).SpaceAdded | |
| ### Hierarchy | |
| - [`SpaceAddedEvent`](#interfacesflatfileeventsspaceaddedeventmd) | |
| ↳ **`SpaceAdded`** | |
| ### Table of contents | |
| #### Properties | |
| - [acknowledgedAt](#acknowledgedat) | |
| - [acknowledgedBy](#acknowledgedby) | |
| - [attributes](#attributes) | |
| - [callbackUrl](#callbackurl) | |
| - [context](#context) | |
| - [createdAt](#createdat) | |
| - [dataUrl](#dataurl) | |
| - [deletedAt](#deletedat) | |
| - [domain](#domain) | |
| - [origin](#origin) | |
| - [payload](#payload) | |
| - [target](#target) | |
| - [topic](#topic) | |
| - [type](#type) | |
| ### Properties | |
| #### acknowledgedAt | |
| • `Optional` **acknowledgedAt**: `string` | |
| Date the event was acknowledged | |
| ##### Inherited from | |
| [SpaceAddedEvent](#interfacesflatfileeventsspaceaddedeventmd).[acknowledgedAt](#acknowledgedat) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:24](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L24) | |
| ___ | |
| #### acknowledgedBy | |
| • `Optional` **acknowledgedBy**: `string` | |
| The actor (user or system) who acknowledged the event | |
| ##### Inherited from | |
| [SpaceAddedEvent](#interfacesflatfileeventsspaceaddedeventmd).[acknowledgedBy](#acknowledgedby) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:26](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L26) | |
| ___ | |
| #### attributes | |
| • `Optional` **attributes**: [`EventAttributes`](#interfacesflatfileeventseventattributesmd) | |
| The attributes of the event | |
| ##### Inherited from | |
| [SpaceAddedEvent](#interfacesflatfileeventsspaceaddedeventmd).[attributes](#attributes) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:14](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L14) | |
| ___ | |
| #### callbackUrl | |
| • `Optional` **callbackUrl**: `string` | |
| The callback url to acknowledge the event | |
| ##### Inherited from | |
| [SpaceAddedEvent](#interfacesflatfileeventsspaceaddedeventmd).[callbackUrl](#callbackurl) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:16](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L16) | |
| ___ | |
| #### context | |
| • **context**: [`Context`](#interfacesflatfileeventscontextmd) | |
| The context of the event | |
| ##### Inherited from | |
| [SpaceAddedEvent](#interfacesflatfileeventsspaceaddedeventmd).[context](#context) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:12](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L12) | |
| ___ | |
| #### createdAt | |
| • **createdAt**: `Date` | |
| Date the event was created | |
| ##### Inherited from | |
| [SpaceAddedEvent](#interfacesflatfileeventsspaceaddedeventmd).[createdAt](#createdat) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:20](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L20) | |
| ___ | |
| #### dataUrl | |
| • `Optional` **dataUrl**: `string` | |
| The url to retrieve the data associated with the event | |
| ##### Inherited from | |
| [SpaceAddedEvent](#interfacesflatfileeventsspaceaddedeventmd).[dataUrl](#dataurl) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:18](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L18) | |
| ___ | |
| #### deletedAt | |
| • `Optional` **deletedAt**: `Date` | |
| Date the event was deleted | |
| ##### Inherited from | |
| [SpaceAddedEvent](#interfacesflatfileeventsspaceaddedeventmd).[deletedAt](#deletedat) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:22](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L22) | |
| ___ | |
| #### domain | |
| • **domain**: [`Domain`](#domain-1) | |
| The domain of the event | |
| ##### Inherited from | |
| [SpaceAddedEvent](#interfacesflatfileeventsspaceaddedeventmd).[domain](#domain) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:9](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L9) | |
| ___ | |
| #### origin | |
| • `Optional` **origin**: [`Origin`](#interfacesflatfileeventsoriginmd) | |
| ##### Inherited from | |
| [SpaceAddedEvent](#interfacesflatfileeventsspaceaddedeventmd).[origin](#origin) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:28](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L28) | |
| ___ | |
| #### payload | |
| • **payload**: `Record`<`string`, `unknown`\> | |
| ##### Inherited from | |
| [SpaceAddedEvent](#interfacesflatfileeventsspaceaddedeventmd).[payload](#payload) | |
| ##### Defined in | |
| [src/api/resources/events/types/SpaceAddedEvent.ts:8](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/SpaceAddedEvent.ts#L8) | |
| ___ | |
| #### target | |
| • `Optional` **target**: `string` | |
| ##### Inherited from | |
| [SpaceAddedEvent](#interfacesflatfileeventsspaceaddedeventmd).[target](#target) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:27](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L27) | |
| ___ | |
| #### topic | |
| • **topic**: [`EventTopic`](#eventtopic-1) | |
| ##### Inherited from | |
| [SpaceAddedEvent](#interfacesflatfileeventsspaceaddedeventmd).[topic](#topic) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:10](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L10) | |
| ___ | |
| #### type | |
| • **type**: ``"space:added"`` | |
| ##### Defined in | |
| [src/api/resources/events/types/Event.ts:39](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/Event.ts#L39) | |
| <a name="interfacesflatfileeventseventspaceremovedmd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / [events](#modulesflatfileeventsmd) / [Event](#modulesflatfileeventseventmd) / SpaceRemoved | |
| ## Interface: SpaceRemoved | |
| [events](#modulesflatfileeventsmd).[Event](#modulesflatfileeventseventmd).SpaceRemoved | |
| ### Hierarchy | |
| - [`SpaceRemovedEvent`](#interfacesflatfileeventsspaceremovedeventmd) | |
| ↳ **`SpaceRemoved`** | |
| ### Table of contents | |
| #### Properties | |
| - [acknowledgedAt](#acknowledgedat) | |
| - [acknowledgedBy](#acknowledgedby) | |
| - [attributes](#attributes) | |
| - [callbackUrl](#callbackurl) | |
| - [context](#context) | |
| - [createdAt](#createdat) | |
| - [dataUrl](#dataurl) | |
| - [deletedAt](#deletedat) | |
| - [domain](#domain) | |
| - [origin](#origin) | |
| - [payload](#payload) | |
| - [target](#target) | |
| - [topic](#topic) | |
| - [type](#type) | |
| ### Properties | |
| #### acknowledgedAt | |
| • `Optional` **acknowledgedAt**: `string` | |
| Date the event was acknowledged | |
| ##### Inherited from | |
| [SpaceRemovedEvent](#interfacesflatfileeventsspaceremovedeventmd).[acknowledgedAt](#acknowledgedat) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:24](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L24) | |
| ___ | |
| #### acknowledgedBy | |
| • `Optional` **acknowledgedBy**: `string` | |
| The actor (user or system) who acknowledged the event | |
| ##### Inherited from | |
| [SpaceRemovedEvent](#interfacesflatfileeventsspaceremovedeventmd).[acknowledgedBy](#acknowledgedby) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:26](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L26) | |
| ___ | |
| #### attributes | |
| • `Optional` **attributes**: [`EventAttributes`](#interfacesflatfileeventseventattributesmd) | |
| The attributes of the event | |
| ##### Inherited from | |
| [SpaceRemovedEvent](#interfacesflatfileeventsspaceremovedeventmd).[attributes](#attributes) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:14](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L14) | |
| ___ | |
| #### callbackUrl | |
| • `Optional` **callbackUrl**: `string` | |
| The callback url to acknowledge the event | |
| ##### Inherited from | |
| [SpaceRemovedEvent](#interfacesflatfileeventsspaceremovedeventmd).[callbackUrl](#callbackurl) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:16](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L16) | |
| ___ | |
| #### context | |
| • **context**: [`Context`](#interfacesflatfileeventscontextmd) | |
| The context of the event | |
| ##### Inherited from | |
| [SpaceRemovedEvent](#interfacesflatfileeventsspaceremovedeventmd).[context](#context) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:12](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L12) | |
| ___ | |
| #### createdAt | |
| • **createdAt**: `Date` | |
| Date the event was created | |
| ##### Inherited from | |
| [SpaceRemovedEvent](#interfacesflatfileeventsspaceremovedeventmd).[createdAt](#createdat) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:20](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L20) | |
| ___ | |
| #### dataUrl | |
| • `Optional` **dataUrl**: `string` | |
| The url to retrieve the data associated with the event | |
| ##### Inherited from | |
| [SpaceRemovedEvent](#interfacesflatfileeventsspaceremovedeventmd).[dataUrl](#dataurl) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:18](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L18) | |
| ___ | |
| #### deletedAt | |
| • `Optional` **deletedAt**: `Date` | |
| Date the event was deleted | |
| ##### Inherited from | |
| [SpaceRemovedEvent](#interfacesflatfileeventsspaceremovedeventmd).[deletedAt](#deletedat) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:22](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L22) | |
| ___ | |
| #### domain | |
| • **domain**: [`Domain`](#domain-1) | |
| The domain of the event | |
| ##### Inherited from | |
| [SpaceRemovedEvent](#interfacesflatfileeventsspaceremovedeventmd).[domain](#domain) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:9](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L9) | |
| ___ | |
| #### origin | |
| • `Optional` **origin**: [`Origin`](#interfacesflatfileeventsoriginmd) | |
| ##### Inherited from | |
| [SpaceRemovedEvent](#interfacesflatfileeventsspaceremovedeventmd).[origin](#origin) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:28](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L28) | |
| ___ | |
| #### payload | |
| • **payload**: `Record`<`string`, `unknown`\> | |
| ##### Inherited from | |
| [SpaceRemovedEvent](#interfacesflatfileeventsspaceremovedeventmd).[payload](#payload) | |
| ##### Defined in | |
| [src/api/resources/events/types/SpaceRemovedEvent.ts:8](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/SpaceRemovedEvent.ts#L8) | |
| ___ | |
| #### target | |
| • `Optional` **target**: `string` | |
| ##### Inherited from | |
| [SpaceRemovedEvent](#interfacesflatfileeventsspaceremovedeventmd).[target](#target) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:27](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L27) | |
| ___ | |
| #### topic | |
| • **topic**: [`EventTopic`](#eventtopic-1) | |
| ##### Inherited from | |
| [SpaceRemovedEvent](#interfacesflatfileeventsspaceremovedeventmd).[topic](#topic) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:10](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L10) | |
| ___ | |
| #### type | |
| • **type**: ``"space:removed"`` | |
| ##### Defined in | |
| [src/api/resources/events/types/Event.ts:43](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/Event.ts#L43) | |
| <a name="interfacesflatfileeventseventuploadcompletedmd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / [events](#modulesflatfileeventsmd) / [Event](#modulesflatfileeventseventmd) / UploadCompleted | |
| ## Interface: UploadCompleted | |
| [events](#modulesflatfileeventsmd).[Event](#modulesflatfileeventseventmd).UploadCompleted | |
| ### Hierarchy | |
| - [`UploadCompletedEvent`](#interfacesflatfileeventsuploadcompletedeventmd) | |
| ↳ **`UploadCompleted`** | |
| ### Table of contents | |
| #### Properties | |
| - [acknowledgedAt](#acknowledgedat) | |
| - [acknowledgedBy](#acknowledgedby) | |
| - [attributes](#attributes) | |
| - [callbackUrl](#callbackurl) | |
| - [context](#context) | |
| - [createdAt](#createdat) | |
| - [dataUrl](#dataurl) | |
| - [deletedAt](#deletedat) | |
| - [domain](#domain) | |
| - [origin](#origin) | |
| - [payload](#payload) | |
| - [target](#target) | |
| - [topic](#topic) | |
| - [type](#type) | |
| ### Properties | |
| #### acknowledgedAt | |
| • `Optional` **acknowledgedAt**: `string` | |
| Date the event was acknowledged | |
| ##### Inherited from | |
| [UploadCompletedEvent](#interfacesflatfileeventsuploadcompletedeventmd).[acknowledgedAt](#acknowledgedat) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:24](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L24) | |
| ___ | |
| #### acknowledgedBy | |
| • `Optional` **acknowledgedBy**: `string` | |
| The actor (user or system) who acknowledged the event | |
| ##### Inherited from | |
| [UploadCompletedEvent](#interfacesflatfileeventsuploadcompletedeventmd).[acknowledgedBy](#acknowledgedby) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:26](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L26) | |
| ___ | |
| #### attributes | |
| • `Optional` **attributes**: [`EventAttributes`](#interfacesflatfileeventseventattributesmd) | |
| The attributes of the event | |
| ##### Inherited from | |
| [UploadCompletedEvent](#interfacesflatfileeventsuploadcompletedeventmd).[attributes](#attributes) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:14](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L14) | |
| ___ | |
| #### callbackUrl | |
| • `Optional` **callbackUrl**: `string` | |
| The callback url to acknowledge the event | |
| ##### Inherited from | |
| [UploadCompletedEvent](#interfacesflatfileeventsuploadcompletedeventmd).[callbackUrl](#callbackurl) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:16](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L16) | |
| ___ | |
| #### context | |
| • **context**: [`Context`](#interfacesflatfileeventscontextmd) | |
| The context of the event | |
| ##### Inherited from | |
| [UploadCompletedEvent](#interfacesflatfileeventsuploadcompletedeventmd).[context](#context) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:12](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L12) | |
| ___ | |
| #### createdAt | |
| • **createdAt**: `Date` | |
| Date the event was created | |
| ##### Inherited from | |
| [UploadCompletedEvent](#interfacesflatfileeventsuploadcompletedeventmd).[createdAt](#createdat) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:20](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L20) | |
| ___ | |
| #### dataUrl | |
| • `Optional` **dataUrl**: `string` | |
| The url to retrieve the data associated with the event | |
| ##### Inherited from | |
| [UploadCompletedEvent](#interfacesflatfileeventsuploadcompletedeventmd).[dataUrl](#dataurl) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:18](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L18) | |
| ___ | |
| #### deletedAt | |
| • `Optional` **deletedAt**: `Date` | |
| Date the event was deleted | |
| ##### Inherited from | |
| [UploadCompletedEvent](#interfacesflatfileeventsuploadcompletedeventmd).[deletedAt](#deletedat) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:22](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L22) | |
| ___ | |
| #### domain | |
| • **domain**: [`Domain`](#domain-1) | |
| The domain of the event | |
| ##### Inherited from | |
| [UploadCompletedEvent](#interfacesflatfileeventsuploadcompletedeventmd).[domain](#domain) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:9](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L9) | |
| ___ | |
| #### origin | |
| • `Optional` **origin**: [`Origin`](#interfacesflatfileeventsoriginmd) | |
| ##### Inherited from | |
| [UploadCompletedEvent](#interfacesflatfileeventsuploadcompletedeventmd).[origin](#origin) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:28](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L28) | |
| ___ | |
| #### payload | |
| • **payload**: `Record`<`string`, `unknown`\> | |
| ##### Inherited from | |
| [UploadCompletedEvent](#interfacesflatfileeventsuploadcompletedeventmd).[payload](#payload) | |
| ##### Defined in | |
| [src/api/resources/events/types/UploadCompletedEvent.ts:8](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/UploadCompletedEvent.ts#L8) | |
| ___ | |
| #### target | |
| • `Optional` **target**: `string` | |
| ##### Inherited from | |
| [UploadCompletedEvent](#interfacesflatfileeventsuploadcompletedeventmd).[target](#target) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:27](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L27) | |
| ___ | |
| #### topic | |
| • **topic**: [`EventTopic`](#eventtopic-1) | |
| ##### Inherited from | |
| [UploadCompletedEvent](#interfacesflatfileeventsuploadcompletedeventmd).[topic](#topic) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:10](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L10) | |
| ___ | |
| #### type | |
| • **type**: ``"upload:completed"`` | |
| ##### Defined in | |
| [src/api/resources/events/types/Event.ts:83](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/Event.ts#L83) | |
| <a name="interfacesflatfileeventseventuploadfailedmd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / [events](#modulesflatfileeventsmd) / [Event](#modulesflatfileeventseventmd) / UploadFailed | |
| ## Interface: UploadFailed | |
| [events](#modulesflatfileeventsmd).[Event](#modulesflatfileeventseventmd).UploadFailed | |
| ### Hierarchy | |
| - [`UploadFailedEvent`](#interfacesflatfileeventsuploadfailedeventmd) | |
| ↳ **`UploadFailed`** | |
| ### Table of contents | |
| #### Properties | |
| - [acknowledgedAt](#acknowledgedat) | |
| - [acknowledgedBy](#acknowledgedby) | |
| - [attributes](#attributes) | |
| - [callbackUrl](#callbackurl) | |
| - [context](#context) | |
| - [createdAt](#createdat) | |
| - [dataUrl](#dataurl) | |
| - [deletedAt](#deletedat) | |
| - [domain](#domain) | |
| - [origin](#origin) | |
| - [payload](#payload) | |
| - [target](#target) | |
| - [topic](#topic) | |
| - [type](#type) | |
| ### Properties | |
| #### acknowledgedAt | |
| • `Optional` **acknowledgedAt**: `string` | |
| Date the event was acknowledged | |
| ##### Inherited from | |
| [UploadFailedEvent](#interfacesflatfileeventsuploadfailedeventmd).[acknowledgedAt](#acknowledgedat) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:24](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L24) | |
| ___ | |
| #### acknowledgedBy | |
| • `Optional` **acknowledgedBy**: `string` | |
| The actor (user or system) who acknowledged the event | |
| ##### Inherited from | |
| [UploadFailedEvent](#interfacesflatfileeventsuploadfailedeventmd).[acknowledgedBy](#acknowledgedby) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:26](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L26) | |
| ___ | |
| #### attributes | |
| • `Optional` **attributes**: [`EventAttributes`](#interfacesflatfileeventseventattributesmd) | |
| The attributes of the event | |
| ##### Inherited from | |
| [UploadFailedEvent](#interfacesflatfileeventsuploadfailedeventmd).[attributes](#attributes) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:14](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L14) | |
| ___ | |
| #### callbackUrl | |
| • `Optional` **callbackUrl**: `string` | |
| The callback url to acknowledge the event | |
| ##### Inherited from | |
| [UploadFailedEvent](#interfacesflatfileeventsuploadfailedeventmd).[callbackUrl](#callbackurl) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:16](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L16) | |
| ___ | |
| #### context | |
| • **context**: [`Context`](#interfacesflatfileeventscontextmd) | |
| The context of the event | |
| ##### Inherited from | |
| [UploadFailedEvent](#interfacesflatfileeventsuploadfailedeventmd).[context](#context) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:12](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L12) | |
| ___ | |
| #### createdAt | |
| • **createdAt**: `Date` | |
| Date the event was created | |
| ##### Inherited from | |
| [UploadFailedEvent](#interfacesflatfileeventsuploadfailedeventmd).[createdAt](#createdat) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:20](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L20) | |
| ___ | |
| #### dataUrl | |
| • `Optional` **dataUrl**: `string` | |
| The url to retrieve the data associated with the event | |
| ##### Inherited from | |
| [UploadFailedEvent](#interfacesflatfileeventsuploadfailedeventmd).[dataUrl](#dataurl) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:18](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L18) | |
| ___ | |
| #### deletedAt | |
| • `Optional` **deletedAt**: `Date` | |
| Date the event was deleted | |
| ##### Inherited from | |
| [UploadFailedEvent](#interfacesflatfileeventsuploadfailedeventmd).[deletedAt](#deletedat) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:22](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L22) | |
| ___ | |
| #### domain | |
| • **domain**: [`Domain`](#domain-1) | |
| The domain of the event | |
| ##### Inherited from | |
| [UploadFailedEvent](#interfacesflatfileeventsuploadfailedeventmd).[domain](#domain) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:9](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L9) | |
| ___ | |
| #### origin | |
| • `Optional` **origin**: [`Origin`](#interfacesflatfileeventsoriginmd) | |
| ##### Inherited from | |
| [UploadFailedEvent](#interfacesflatfileeventsuploadfailedeventmd).[origin](#origin) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:28](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L28) | |
| ___ | |
| #### payload | |
| • **payload**: `Record`<`string`, `unknown`\> | |
| ##### Inherited from | |
| [UploadFailedEvent](#interfacesflatfileeventsuploadfailedeventmd).[payload](#payload) | |
| ##### Defined in | |
| [src/api/resources/events/types/UploadFailedEvent.ts:8](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/UploadFailedEvent.ts#L8) | |
| ___ | |
| #### target | |
| • `Optional` **target**: `string` | |
| ##### Inherited from | |
| [UploadFailedEvent](#interfacesflatfileeventsuploadfailedeventmd).[target](#target) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:27](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L27) | |
| ___ | |
| #### topic | |
| • **topic**: [`EventTopic`](#eventtopic-1) | |
| ##### Inherited from | |
| [UploadFailedEvent](#interfacesflatfileeventsuploadfailedeventmd).[topic](#topic) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:10](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L10) | |
| ___ | |
| #### type | |
| • **type**: ``"upload:failed"`` | |
| ##### Defined in | |
| [src/api/resources/events/types/Event.ts:79](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/Event.ts#L79) | |
| <a name="interfacesflatfileeventseventuploadstartedmd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / [events](#modulesflatfileeventsmd) / [Event](#modulesflatfileeventseventmd) / UploadStarted | |
| ## Interface: UploadStarted | |
| [events](#modulesflatfileeventsmd).[Event](#modulesflatfileeventseventmd).UploadStarted | |
| ### Hierarchy | |
| - [`UploadStartedEvent`](#interfacesflatfileeventsuploadstartedeventmd) | |
| ↳ **`UploadStarted`** | |
| ### Table of contents | |
| #### Properties | |
| - [acknowledgedAt](#acknowledgedat) | |
| - [acknowledgedBy](#acknowledgedby) | |
| - [attributes](#attributes) | |
| - [callbackUrl](#callbackurl) | |
| - [context](#context) | |
| - [createdAt](#createdat) | |
| - [dataUrl](#dataurl) | |
| - [deletedAt](#deletedat) | |
| - [domain](#domain) | |
| - [origin](#origin) | |
| - [payload](#payload) | |
| - [target](#target) | |
| - [topic](#topic) | |
| - [type](#type) | |
| ### Properties | |
| #### acknowledgedAt | |
| • `Optional` **acknowledgedAt**: `string` | |
| Date the event was acknowledged | |
| ##### Inherited from | |
| [UploadStartedEvent](#interfacesflatfileeventsuploadstartedeventmd).[acknowledgedAt](#acknowledgedat) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:24](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L24) | |
| ___ | |
| #### acknowledgedBy | |
| • `Optional` **acknowledgedBy**: `string` | |
| The actor (user or system) who acknowledged the event | |
| ##### Inherited from | |
| [UploadStartedEvent](#interfacesflatfileeventsuploadstartedeventmd).[acknowledgedBy](#acknowledgedby) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:26](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L26) | |
| ___ | |
| #### attributes | |
| • `Optional` **attributes**: [`EventAttributes`](#interfacesflatfileeventseventattributesmd) | |
| The attributes of the event | |
| ##### Inherited from | |
| [UploadStartedEvent](#interfacesflatfileeventsuploadstartedeventmd).[attributes](#attributes) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:14](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L14) | |
| ___ | |
| #### callbackUrl | |
| • `Optional` **callbackUrl**: `string` | |
| The callback url to acknowledge the event | |
| ##### Inherited from | |
| [UploadStartedEvent](#interfacesflatfileeventsuploadstartedeventmd).[callbackUrl](#callbackurl) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:16](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L16) | |
| ___ | |
| #### context | |
| • **context**: [`Context`](#interfacesflatfileeventscontextmd) | |
| The context of the event | |
| ##### Inherited from | |
| [UploadStartedEvent](#interfacesflatfileeventsuploadstartedeventmd).[context](#context) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:12](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L12) | |
| ___ | |
| #### createdAt | |
| • **createdAt**: `Date` | |
| Date the event was created | |
| ##### Inherited from | |
| [UploadStartedEvent](#interfacesflatfileeventsuploadstartedeventmd).[createdAt](#createdat) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:20](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L20) | |
| ___ | |
| #### dataUrl | |
| • `Optional` **dataUrl**: `string` | |
| The url to retrieve the data associated with the event | |
| ##### Inherited from | |
| [UploadStartedEvent](#interfacesflatfileeventsuploadstartedeventmd).[dataUrl](#dataurl) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:18](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L18) | |
| ___ | |
| #### deletedAt | |
| • `Optional` **deletedAt**: `Date` | |
| Date the event was deleted | |
| ##### Inherited from | |
| [UploadStartedEvent](#interfacesflatfileeventsuploadstartedeventmd).[deletedAt](#deletedat) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:22](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L22) | |
| ___ | |
| #### domain | |
| • **domain**: [`Domain`](#domain-1) | |
| The domain of the event | |
| ##### Inherited from | |
| [UploadStartedEvent](#interfacesflatfileeventsuploadstartedeventmd).[domain](#domain) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:9](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L9) | |
| ___ | |
| #### origin | |
| • `Optional` **origin**: [`Origin`](#interfacesflatfileeventsoriginmd) | |
| ##### Inherited from | |
| [UploadStartedEvent](#interfacesflatfileeventsuploadstartedeventmd).[origin](#origin) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:28](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L28) | |
| ___ | |
| #### payload | |
| • **payload**: `Record`<`string`, `unknown`\> | |
| ##### Inherited from | |
| [UploadStartedEvent](#interfacesflatfileeventsuploadstartedeventmd).[payload](#payload) | |
| ##### Defined in | |
| [src/api/resources/events/types/UploadStartedEvent.ts:8](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/UploadStartedEvent.ts#L8) | |
| ___ | |
| #### target | |
| • `Optional` **target**: `string` | |
| ##### Inherited from | |
| [UploadStartedEvent](#interfacesflatfileeventsuploadstartedeventmd).[target](#target) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:27](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L27) | |
| ___ | |
| #### topic | |
| • **topic**: [`EventTopic`](#eventtopic-1) | |
| ##### Inherited from | |
| [UploadStartedEvent](#interfacesflatfileeventsuploadstartedeventmd).[topic](#topic) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:10](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L10) | |
| ___ | |
| #### type | |
| • **type**: ``"upload:started"`` | |
| ##### Defined in | |
| [src/api/resources/events/types/Event.ts:75](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/Event.ts#L75) | |
| <a name="interfacesflatfileeventseventuseraddedmd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / [events](#modulesflatfileeventsmd) / [Event](#modulesflatfileeventseventmd) / UserAdded | |
| ## Interface: UserAdded | |
| [events](#modulesflatfileeventsmd).[Event](#modulesflatfileeventseventmd).UserAdded | |
| ### Hierarchy | |
| - [`UserAddedEvent`](#interfacesflatfileeventsuseraddedeventmd) | |
| ↳ **`UserAdded`** | |
| ### Table of contents | |
| #### Properties | |
| - [acknowledgedAt](#acknowledgedat) | |
| - [acknowledgedBy](#acknowledgedby) | |
| - [attributes](#attributes) | |
| - [callbackUrl](#callbackurl) | |
| - [context](#context) | |
| - [createdAt](#createdat) | |
| - [dataUrl](#dataurl) | |
| - [deletedAt](#deletedat) | |
| - [domain](#domain) | |
| - [origin](#origin) | |
| - [payload](#payload) | |
| - [target](#target) | |
| - [topic](#topic) | |
| - [type](#type) | |
| ### Properties | |
| #### acknowledgedAt | |
| • `Optional` **acknowledgedAt**: `string` | |
| Date the event was acknowledged | |
| ##### Inherited from | |
| [UserAddedEvent](#interfacesflatfileeventsuseraddedeventmd).[acknowledgedAt](#acknowledgedat) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:24](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L24) | |
| ___ | |
| #### acknowledgedBy | |
| • `Optional` **acknowledgedBy**: `string` | |
| The actor (user or system) who acknowledged the event | |
| ##### Inherited from | |
| [UserAddedEvent](#interfacesflatfileeventsuseraddedeventmd).[acknowledgedBy](#acknowledgedby) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:26](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L26) | |
| ___ | |
| #### attributes | |
| • `Optional` **attributes**: [`EventAttributes`](#interfacesflatfileeventseventattributesmd) | |
| The attributes of the event | |
| ##### Inherited from | |
| [UserAddedEvent](#interfacesflatfileeventsuseraddedeventmd).[attributes](#attributes) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:14](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L14) | |
| ___ | |
| #### callbackUrl | |
| • `Optional` **callbackUrl**: `string` | |
| The callback url to acknowledge the event | |
| ##### Inherited from | |
| [UserAddedEvent](#interfacesflatfileeventsuseraddedeventmd).[callbackUrl](#callbackurl) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:16](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L16) | |
| ___ | |
| #### context | |
| • **context**: [`Context`](#interfacesflatfileeventscontextmd) | |
| The context of the event | |
| ##### Inherited from | |
| [UserAddedEvent](#interfacesflatfileeventsuseraddedeventmd).[context](#context) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:12](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L12) | |
| ___ | |
| #### createdAt | |
| • **createdAt**: `Date` | |
| Date the event was created | |
| ##### Inherited from | |
| [UserAddedEvent](#interfacesflatfileeventsuseraddedeventmd).[createdAt](#createdat) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:20](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L20) | |
| ___ | |
| #### dataUrl | |
| • `Optional` **dataUrl**: `string` | |
| The url to retrieve the data associated with the event | |
| ##### Inherited from | |
| [UserAddedEvent](#interfacesflatfileeventsuseraddedeventmd).[dataUrl](#dataurl) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:18](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L18) | |
| ___ | |
| #### deletedAt | |
| • `Optional` **deletedAt**: `Date` | |
| Date the event was deleted | |
| ##### Inherited from | |
| [UserAddedEvent](#interfacesflatfileeventsuseraddedeventmd).[deletedAt](#deletedat) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:22](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L22) | |
| ___ | |
| #### domain | |
| • **domain**: [`Domain`](#domain-1) | |
| The domain of the event | |
| ##### Inherited from | |
| [UserAddedEvent](#interfacesflatfileeventsuseraddedeventmd).[domain](#domain) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:9](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L9) | |
| ___ | |
| #### origin | |
| • `Optional` **origin**: [`Origin`](#interfacesflatfileeventsoriginmd) | |
| ##### Inherited from | |
| [UserAddedEvent](#interfacesflatfileeventsuseraddedeventmd).[origin](#origin) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:28](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L28) | |
| ___ | |
| #### payload | |
| • **payload**: `Record`<`string`, `unknown`\> | |
| ##### Inherited from | |
| [UserAddedEvent](#interfacesflatfileeventsuseraddedeventmd).[payload](#payload) | |
| ##### Defined in | |
| [src/api/resources/events/types/UserAddedEvent.ts:8](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/UserAddedEvent.ts#L8) | |
| ___ | |
| #### target | |
| • `Optional` **target**: `string` | |
| ##### Inherited from | |
| [UserAddedEvent](#interfacesflatfileeventsuseraddedeventmd).[target](#target) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:27](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L27) | |
| ___ | |
| #### topic | |
| • **topic**: [`EventTopic`](#eventtopic-1) | |
| ##### Inherited from | |
| [UserAddedEvent](#interfacesflatfileeventsuseraddedeventmd).[topic](#topic) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:10](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L10) | |
| ___ | |
| #### type | |
| • **type**: ``"user:added"`` | |
| ##### Defined in | |
| [src/api/resources/events/types/Event.ts:59](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/Event.ts#L59) | |
| <a name="interfacesflatfileeventseventuserofflinemd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / [events](#modulesflatfileeventsmd) / [Event](#modulesflatfileeventseventmd) / UserOffline | |
| ## Interface: UserOffline | |
| [events](#modulesflatfileeventsmd).[Event](#modulesflatfileeventseventmd).UserOffline | |
| ### Hierarchy | |
| - [`UserOfflineEvent`](#interfacesflatfileeventsuserofflineeventmd) | |
| ↳ **`UserOffline`** | |
| ### Table of contents | |
| #### Properties | |
| - [acknowledgedAt](#acknowledgedat) | |
| - [acknowledgedBy](#acknowledgedby) | |
| - [attributes](#attributes) | |
| - [callbackUrl](#callbackurl) | |
| - [context](#context) | |
| - [createdAt](#createdat) | |
| - [dataUrl](#dataurl) | |
| - [deletedAt](#deletedat) | |
| - [domain](#domain) | |
| - [origin](#origin) | |
| - [payload](#payload) | |
| - [target](#target) | |
| - [topic](#topic) | |
| - [type](#type) | |
| ### Properties | |
| #### acknowledgedAt | |
| • `Optional` **acknowledgedAt**: `string` | |
| Date the event was acknowledged | |
| ##### Inherited from | |
| [UserOfflineEvent](#interfacesflatfileeventsuserofflineeventmd).[acknowledgedAt](#acknowledgedat) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:24](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L24) | |
| ___ | |
| #### acknowledgedBy | |
| • `Optional` **acknowledgedBy**: `string` | |
| The actor (user or system) who acknowledged the event | |
| ##### Inherited from | |
| [UserOfflineEvent](#interfacesflatfileeventsuserofflineeventmd).[acknowledgedBy](#acknowledgedby) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:26](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L26) | |
| ___ | |
| #### attributes | |
| • `Optional` **attributes**: [`EventAttributes`](#interfacesflatfileeventseventattributesmd) | |
| The attributes of the event | |
| ##### Inherited from | |
| [UserOfflineEvent](#interfacesflatfileeventsuserofflineeventmd).[attributes](#attributes) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:14](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L14) | |
| ___ | |
| #### callbackUrl | |
| • `Optional` **callbackUrl**: `string` | |
| The callback url to acknowledge the event | |
| ##### Inherited from | |
| [UserOfflineEvent](#interfacesflatfileeventsuserofflineeventmd).[callbackUrl](#callbackurl) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:16](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L16) | |
| ___ | |
| #### context | |
| • **context**: [`Context`](#interfacesflatfileeventscontextmd) | |
| The context of the event | |
| ##### Inherited from | |
| [UserOfflineEvent](#interfacesflatfileeventsuserofflineeventmd).[context](#context) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:12](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L12) | |
| ___ | |
| #### createdAt | |
| • **createdAt**: `Date` | |
| Date the event was created | |
| ##### Inherited from | |
| [UserOfflineEvent](#interfacesflatfileeventsuserofflineeventmd).[createdAt](#createdat) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:20](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L20) | |
| ___ | |
| #### dataUrl | |
| • `Optional` **dataUrl**: `string` | |
| The url to retrieve the data associated with the event | |
| ##### Inherited from | |
| [UserOfflineEvent](#interfacesflatfileeventsuserofflineeventmd).[dataUrl](#dataurl) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:18](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L18) | |
| ___ | |
| #### deletedAt | |
| • `Optional` **deletedAt**: `Date` | |
| Date the event was deleted | |
| ##### Inherited from | |
| [UserOfflineEvent](#interfacesflatfileeventsuserofflineeventmd).[deletedAt](#deletedat) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:22](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L22) | |
| ___ | |
| #### domain | |
| • **domain**: [`Domain`](#domain-1) | |
| The domain of the event | |
| ##### Inherited from | |
| [UserOfflineEvent](#interfacesflatfileeventsuserofflineeventmd).[domain](#domain) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:9](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L9) | |
| ___ | |
| #### origin | |
| • `Optional` **origin**: [`Origin`](#interfacesflatfileeventsoriginmd) | |
| ##### Inherited from | |
| [UserOfflineEvent](#interfacesflatfileeventsuserofflineeventmd).[origin](#origin) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:28](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L28) | |
| ___ | |
| #### payload | |
| • **payload**: `Record`<`string`, `unknown`\> | |
| ##### Inherited from | |
| [UserOfflineEvent](#interfacesflatfileeventsuserofflineeventmd).[payload](#payload) | |
| ##### Defined in | |
| [src/api/resources/events/types/UserOfflineEvent.ts:8](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/UserOfflineEvent.ts#L8) | |
| ___ | |
| #### target | |
| • `Optional` **target**: `string` | |
| ##### Inherited from | |
| [UserOfflineEvent](#interfacesflatfileeventsuserofflineeventmd).[target](#target) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:27](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L27) | |
| ___ | |
| #### topic | |
| • **topic**: [`EventTopic`](#eventtopic-1) | |
| ##### Inherited from | |
| [UserOfflineEvent](#interfacesflatfileeventsuserofflineeventmd).[topic](#topic) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:10](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L10) | |
| ___ | |
| #### type | |
| • **type**: ``"user:offline"`` | |
| ##### Defined in | |
| [src/api/resources/events/types/Event.ts:71](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/Event.ts#L71) | |
| <a name="interfacesflatfileeventseventuseronlinemd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / [events](#modulesflatfileeventsmd) / [Event](#modulesflatfileeventseventmd) / UserOnline | |
| ## Interface: UserOnline | |
| [events](#modulesflatfileeventsmd).[Event](#modulesflatfileeventseventmd).UserOnline | |
| ### Hierarchy | |
| - [`UserOnlineEvent`](#interfacesflatfileeventsuseronlineeventmd) | |
| ↳ **`UserOnline`** | |
| ### Table of contents | |
| #### Properties | |
| - [acknowledgedAt](#acknowledgedat) | |
| - [acknowledgedBy](#acknowledgedby) | |
| - [attributes](#attributes) | |
| - [callbackUrl](#callbackurl) | |
| - [context](#context) | |
| - [createdAt](#createdat) | |
| - [dataUrl](#dataurl) | |
| - [deletedAt](#deletedat) | |
| - [domain](#domain) | |
| - [origin](#origin) | |
| - [payload](#payload) | |
| - [target](#target) | |
| - [topic](#topic) | |
| - [type](#type) | |
| ### Properties | |
| #### acknowledgedAt | |
| • `Optional` **acknowledgedAt**: `string` | |
| Date the event was acknowledged | |
| ##### Inherited from | |
| [UserOnlineEvent](#interfacesflatfileeventsuseronlineeventmd).[acknowledgedAt](#acknowledgedat) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:24](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L24) | |
| ___ | |
| #### acknowledgedBy | |
| • `Optional` **acknowledgedBy**: `string` | |
| The actor (user or system) who acknowledged the event | |
| ##### Inherited from | |
| [UserOnlineEvent](#interfacesflatfileeventsuseronlineeventmd).[acknowledgedBy](#acknowledgedby) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:26](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L26) | |
| ___ | |
| #### attributes | |
| • `Optional` **attributes**: [`EventAttributes`](#interfacesflatfileeventseventattributesmd) | |
| The attributes of the event | |
| ##### Inherited from | |
| [UserOnlineEvent](#interfacesflatfileeventsuseronlineeventmd).[attributes](#attributes) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:14](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L14) | |
| ___ | |
| #### callbackUrl | |
| • `Optional` **callbackUrl**: `string` | |
| The callback url to acknowledge the event | |
| ##### Inherited from | |
| [UserOnlineEvent](#interfacesflatfileeventsuseronlineeventmd).[callbackUrl](#callbackurl) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:16](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L16) | |
| ___ | |
| #### context | |
| • **context**: [`Context`](#interfacesflatfileeventscontextmd) | |
| The context of the event | |
| ##### Inherited from | |
| [UserOnlineEvent](#interfacesflatfileeventsuseronlineeventmd).[context](#context) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:12](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L12) | |
| ___ | |
| #### createdAt | |
| • **createdAt**: `Date` | |
| Date the event was created | |
| ##### Inherited from | |
| [UserOnlineEvent](#interfacesflatfileeventsuseronlineeventmd).[createdAt](#createdat) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:20](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L20) | |
| ___ | |
| #### dataUrl | |
| • `Optional` **dataUrl**: `string` | |
| The url to retrieve the data associated with the event | |
| ##### Inherited from | |
| [UserOnlineEvent](#interfacesflatfileeventsuseronlineeventmd).[dataUrl](#dataurl) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:18](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L18) | |
| ___ | |
| #### deletedAt | |
| • `Optional` **deletedAt**: `Date` | |
| Date the event was deleted | |
| ##### Inherited from | |
| [UserOnlineEvent](#interfacesflatfileeventsuseronlineeventmd).[deletedAt](#deletedat) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:22](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L22) | |
| ___ | |
| #### domain | |
| • **domain**: [`Domain`](#domain-1) | |
| The domain of the event | |
| ##### Inherited from | |
| [UserOnlineEvent](#interfacesflatfileeventsuseronlineeventmd).[domain](#domain) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:9](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L9) | |
| ___ | |
| #### origin | |
| • `Optional` **origin**: [`Origin`](#interfacesflatfileeventsoriginmd) | |
| ##### Inherited from | |
| [UserOnlineEvent](#interfacesflatfileeventsuseronlineeventmd).[origin](#origin) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:28](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L28) | |
| ___ | |
| #### payload | |
| • **payload**: `Record`<`string`, `unknown`\> | |
| ##### Inherited from | |
| [UserOnlineEvent](#interfacesflatfileeventsuseronlineeventmd).[payload](#payload) | |
| ##### Defined in | |
| [src/api/resources/events/types/UserOnlineEvent.ts:8](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/UserOnlineEvent.ts#L8) | |
| ___ | |
| #### target | |
| • `Optional` **target**: `string` | |
| ##### Inherited from | |
| [UserOnlineEvent](#interfacesflatfileeventsuseronlineeventmd).[target](#target) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:27](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L27) | |
| ___ | |
| #### topic | |
| • **topic**: [`EventTopic`](#eventtopic-1) | |
| ##### Inherited from | |
| [UserOnlineEvent](#interfacesflatfileeventsuseronlineeventmd).[topic](#topic) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:10](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L10) | |
| ___ | |
| #### type | |
| • **type**: ``"user:online"`` | |
| ##### Defined in | |
| [src/api/resources/events/types/Event.ts:67](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/Event.ts#L67) | |
| <a name="interfacesflatfileeventseventuserremovedmd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / [events](#modulesflatfileeventsmd) / [Event](#modulesflatfileeventseventmd) / UserRemoved | |
| ## Interface: UserRemoved | |
| [events](#modulesflatfileeventsmd).[Event](#modulesflatfileeventseventmd).UserRemoved | |
| ### Hierarchy | |
| - [`UserRemovedEvent`](#interfacesflatfileeventsuserremovedeventmd) | |
| ↳ **`UserRemoved`** | |
| ### Table of contents | |
| #### Properties | |
| - [acknowledgedAt](#acknowledgedat) | |
| - [acknowledgedBy](#acknowledgedby) | |
| - [attributes](#attributes) | |
| - [callbackUrl](#callbackurl) | |
| - [context](#context) | |
| - [createdAt](#createdat) | |
| - [dataUrl](#dataurl) | |
| - [deletedAt](#deletedat) | |
| - [domain](#domain) | |
| - [origin](#origin) | |
| - [payload](#payload) | |
| - [target](#target) | |
| - [topic](#topic) | |
| - [type](#type) | |
| ### Properties | |
| #### acknowledgedAt | |
| • `Optional` **acknowledgedAt**: `string` | |
| Date the event was acknowledged | |
| ##### Inherited from | |
| [UserRemovedEvent](#interfacesflatfileeventsuserremovedeventmd).[acknowledgedAt](#acknowledgedat) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:24](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L24) | |
| ___ | |
| #### acknowledgedBy | |
| • `Optional` **acknowledgedBy**: `string` | |
| The actor (user or system) who acknowledged the event | |
| ##### Inherited from | |
| [UserRemovedEvent](#interfacesflatfileeventsuserremovedeventmd).[acknowledgedBy](#acknowledgedby) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:26](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L26) | |
| ___ | |
| #### attributes | |
| • `Optional` **attributes**: [`EventAttributes`](#interfacesflatfileeventseventattributesmd) | |
| The attributes of the event | |
| ##### Inherited from | |
| [UserRemovedEvent](#interfacesflatfileeventsuserremovedeventmd).[attributes](#attributes) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:14](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L14) | |
| ___ | |
| #### callbackUrl | |
| • `Optional` **callbackUrl**: `string` | |
| The callback url to acknowledge the event | |
| ##### Inherited from | |
| [UserRemovedEvent](#interfacesflatfileeventsuserremovedeventmd).[callbackUrl](#callbackurl) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:16](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L16) | |
| ___ | |
| #### context | |
| • **context**: [`Context`](#interfacesflatfileeventscontextmd) | |
| The context of the event | |
| ##### Inherited from | |
| [UserRemovedEvent](#interfacesflatfileeventsuserremovedeventmd).[context](#context) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:12](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L12) | |
| ___ | |
| #### createdAt | |
| • **createdAt**: `Date` | |
| Date the event was created | |
| ##### Inherited from | |
| [UserRemovedEvent](#interfacesflatfileeventsuserremovedeventmd).[createdAt](#createdat) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:20](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L20) | |
| ___ | |
| #### dataUrl | |
| • `Optional` **dataUrl**: `string` | |
| The url to retrieve the data associated with the event | |
| ##### Inherited from | |
| [UserRemovedEvent](#interfacesflatfileeventsuserremovedeventmd).[dataUrl](#dataurl) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:18](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L18) | |
| ___ | |
| #### deletedAt | |
| • `Optional` **deletedAt**: `Date` | |
| Date the event was deleted | |
| ##### Inherited from | |
| [UserRemovedEvent](#interfacesflatfileeventsuserremovedeventmd).[deletedAt](#deletedat) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:22](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L22) | |
| ___ | |
| #### domain | |
| • **domain**: [`Domain`](#domain-1) | |
| The domain of the event | |
| ##### Inherited from | |
| [UserRemovedEvent](#interfacesflatfileeventsuserremovedeventmd).[domain](#domain) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:9](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L9) | |
| ___ | |
| #### origin | |
| • `Optional` **origin**: [`Origin`](#interfacesflatfileeventsoriginmd) | |
| ##### Inherited from | |
| [UserRemovedEvent](#interfacesflatfileeventsuserremovedeventmd).[origin](#origin) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:28](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L28) | |
| ___ | |
| #### payload | |
| • **payload**: `Record`<`string`, `unknown`\> | |
| ##### Inherited from | |
| [UserRemovedEvent](#interfacesflatfileeventsuserremovedeventmd).[payload](#payload) | |
| ##### Defined in | |
| [src/api/resources/events/types/UserRemovedEvent.ts:8](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/UserRemovedEvent.ts#L8) | |
| ___ | |
| #### target | |
| • `Optional` **target**: `string` | |
| ##### Inherited from | |
| [UserRemovedEvent](#interfacesflatfileeventsuserremovedeventmd).[target](#target) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:27](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L27) | |
| ___ | |
| #### topic | |
| • **topic**: [`EventTopic`](#eventtopic-1) | |
| ##### Inherited from | |
| [UserRemovedEvent](#interfacesflatfileeventsuserremovedeventmd).[topic](#topic) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:10](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L10) | |
| ___ | |
| #### type | |
| • **type**: ``"user:removed"`` | |
| ##### Defined in | |
| [src/api/resources/events/types/Event.ts:63](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/Event.ts#L63) | |
| <a name="interfacesflatfileeventseventworkbookaddedmd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / [events](#modulesflatfileeventsmd) / [Event](#modulesflatfileeventseventmd) / WorkbookAdded | |
| ## Interface: WorkbookAdded | |
| [events](#modulesflatfileeventsmd).[Event](#modulesflatfileeventseventmd).WorkbookAdded | |
| ### Hierarchy | |
| - [`WorkbookAddedEvent`](#interfacesflatfileeventsworkbookaddedeventmd) | |
| ↳ **`WorkbookAdded`** | |
| ### Table of contents | |
| #### Properties | |
| - [acknowledgedAt](#acknowledgedat) | |
| - [acknowledgedBy](#acknowledgedby) | |
| - [attributes](#attributes) | |
| - [callbackUrl](#callbackurl) | |
| - [context](#context) | |
| - [createdAt](#createdat) | |
| - [dataUrl](#dataurl) | |
| - [deletedAt](#deletedat) | |
| - [domain](#domain) | |
| - [origin](#origin) | |
| - [payload](#payload) | |
| - [target](#target) | |
| - [topic](#topic) | |
| - [type](#type) | |
| ### Properties | |
| #### acknowledgedAt | |
| • `Optional` **acknowledgedAt**: `string` | |
| Date the event was acknowledged | |
| ##### Inherited from | |
| [WorkbookAddedEvent](#interfacesflatfileeventsworkbookaddedeventmd).[acknowledgedAt](#acknowledgedat) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:24](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L24) | |
| ___ | |
| #### acknowledgedBy | |
| • `Optional` **acknowledgedBy**: `string` | |
| The actor (user or system) who acknowledged the event | |
| ##### Inherited from | |
| [WorkbookAddedEvent](#interfacesflatfileeventsworkbookaddedeventmd).[acknowledgedBy](#acknowledgedby) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:26](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L26) | |
| ___ | |
| #### attributes | |
| • `Optional` **attributes**: [`EventAttributes`](#interfacesflatfileeventseventattributesmd) | |
| The attributes of the event | |
| ##### Inherited from | |
| [WorkbookAddedEvent](#interfacesflatfileeventsworkbookaddedeventmd).[attributes](#attributes) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:14](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L14) | |
| ___ | |
| #### callbackUrl | |
| • `Optional` **callbackUrl**: `string` | |
| The callback url to acknowledge the event | |
| ##### Inherited from | |
| [WorkbookAddedEvent](#interfacesflatfileeventsworkbookaddedeventmd).[callbackUrl](#callbackurl) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:16](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L16) | |
| ___ | |
| #### context | |
| • **context**: [`Context`](#interfacesflatfileeventscontextmd) | |
| The context of the event | |
| ##### Inherited from | |
| [WorkbookAddedEvent](#interfacesflatfileeventsworkbookaddedeventmd).[context](#context) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:12](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L12) | |
| ___ | |
| #### createdAt | |
| • **createdAt**: `Date` | |
| Date the event was created | |
| ##### Inherited from | |
| [WorkbookAddedEvent](#interfacesflatfileeventsworkbookaddedeventmd).[createdAt](#createdat) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:20](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L20) | |
| ___ | |
| #### dataUrl | |
| • `Optional` **dataUrl**: `string` | |
| The url to retrieve the data associated with the event | |
| ##### Inherited from | |
| [WorkbookAddedEvent](#interfacesflatfileeventsworkbookaddedeventmd).[dataUrl](#dataurl) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:18](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L18) | |
| ___ | |
| #### deletedAt | |
| • `Optional` **deletedAt**: `Date` | |
| Date the event was deleted | |
| ##### Inherited from | |
| [WorkbookAddedEvent](#interfacesflatfileeventsworkbookaddedeventmd).[deletedAt](#deletedat) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:22](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L22) | |
| ___ | |
| #### domain | |
| • **domain**: [`Domain`](#domain-1) | |
| The domain of the event | |
| ##### Inherited from | |
| [WorkbookAddedEvent](#interfacesflatfileeventsworkbookaddedeventmd).[domain](#domain) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:9](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L9) | |
| ___ | |
| #### origin | |
| • `Optional` **origin**: [`Origin`](#interfacesflatfileeventsoriginmd) | |
| ##### Inherited from | |
| [WorkbookAddedEvent](#interfacesflatfileeventsworkbookaddedeventmd).[origin](#origin) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:28](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L28) | |
| ___ | |
| #### payload | |
| • **payload**: `Record`<`string`, `unknown`\> | |
| ##### Inherited from | |
| [WorkbookAddedEvent](#interfacesflatfileeventsworkbookaddedeventmd).[payload](#payload) | |
| ##### Defined in | |
| [src/api/resources/events/types/WorkbookAddedEvent.ts:8](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/WorkbookAddedEvent.ts#L8) | |
| ___ | |
| #### target | |
| • `Optional` **target**: `string` | |
| ##### Inherited from | |
| [WorkbookAddedEvent](#interfacesflatfileeventsworkbookaddedeventmd).[target](#target) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:27](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L27) | |
| ___ | |
| #### topic | |
| • **topic**: [`EventTopic`](#eventtopic-1) | |
| ##### Inherited from | |
| [WorkbookAddedEvent](#interfacesflatfileeventsworkbookaddedeventmd).[topic](#topic) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:10](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L10) | |
| ___ | |
| #### type | |
| • **type**: ``"workbook:added"`` | |
| ##### Defined in | |
| [src/api/resources/events/types/Event.ts:47](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/Event.ts#L47) | |
| <a name="interfacesflatfileeventseventworkbookremovedmd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / [events](#modulesflatfileeventsmd) / [Event](#modulesflatfileeventseventmd) / WorkbookRemoved | |
| ## Interface: WorkbookRemoved | |
| [events](#modulesflatfileeventsmd).[Event](#modulesflatfileeventseventmd).WorkbookRemoved | |
| ### Hierarchy | |
| - [`WorkbookRemovedEvent`](#interfacesflatfileeventsworkbookremovedeventmd) | |
| ↳ **`WorkbookRemoved`** | |
| ### Table of contents | |
| #### Properties | |
| - [acknowledgedAt](#acknowledgedat) | |
| - [acknowledgedBy](#acknowledgedby) | |
| - [attributes](#attributes) | |
| - [callbackUrl](#callbackurl) | |
| - [context](#context) | |
| - [createdAt](#createdat) | |
| - [dataUrl](#dataurl) | |
| - [deletedAt](#deletedat) | |
| - [domain](#domain) | |
| - [origin](#origin) | |
| - [payload](#payload) | |
| - [target](#target) | |
| - [topic](#topic) | |
| - [type](#type) | |
| ### Properties | |
| #### acknowledgedAt | |
| • `Optional` **acknowledgedAt**: `string` | |
| Date the event was acknowledged | |
| ##### Inherited from | |
| [WorkbookRemovedEvent](#interfacesflatfileeventsworkbookremovedeventmd).[acknowledgedAt](#acknowledgedat) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:24](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L24) | |
| ___ | |
| #### acknowledgedBy | |
| • `Optional` **acknowledgedBy**: `string` | |
| The actor (user or system) who acknowledged the event | |
| ##### Inherited from | |
| [WorkbookRemovedEvent](#interfacesflatfileeventsworkbookremovedeventmd).[acknowledgedBy](#acknowledgedby) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:26](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L26) | |
| ___ | |
| #### attributes | |
| • `Optional` **attributes**: [`EventAttributes`](#interfacesflatfileeventseventattributesmd) | |
| The attributes of the event | |
| ##### Inherited from | |
| [WorkbookRemovedEvent](#interfacesflatfileeventsworkbookremovedeventmd).[attributes](#attributes) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:14](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L14) | |
| ___ | |
| #### callbackUrl | |
| • `Optional` **callbackUrl**: `string` | |
| The callback url to acknowledge the event | |
| ##### Inherited from | |
| [WorkbookRemovedEvent](#interfacesflatfileeventsworkbookremovedeventmd).[callbackUrl](#callbackurl) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:16](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L16) | |
| ___ | |
| #### context | |
| • **context**: [`Context`](#interfacesflatfileeventscontextmd) | |
| The context of the event | |
| ##### Inherited from | |
| [WorkbookRemovedEvent](#interfacesflatfileeventsworkbookremovedeventmd).[context](#context) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:12](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L12) | |
| ___ | |
| #### createdAt | |
| • **createdAt**: `Date` | |
| Date the event was created | |
| ##### Inherited from | |
| [WorkbookRemovedEvent](#interfacesflatfileeventsworkbookremovedeventmd).[createdAt](#createdat) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:20](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L20) | |
| ___ | |
| #### dataUrl | |
| • `Optional` **dataUrl**: `string` | |
| The url to retrieve the data associated with the event | |
| ##### Inherited from | |
| [WorkbookRemovedEvent](#interfacesflatfileeventsworkbookremovedeventmd).[dataUrl](#dataurl) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:18](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L18) | |
| ___ | |
| #### deletedAt | |
| • `Optional` **deletedAt**: `Date` | |
| Date the event was deleted | |
| ##### Inherited from | |
| [WorkbookRemovedEvent](#interfacesflatfileeventsworkbookremovedeventmd).[deletedAt](#deletedat) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:22](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L22) | |
| ___ | |
| #### domain | |
| • **domain**: [`Domain`](#domain-1) | |
| The domain of the event | |
| ##### Inherited from | |
| [WorkbookRemovedEvent](#interfacesflatfileeventsworkbookremovedeventmd).[domain](#domain) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:9](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L9) | |
| ___ | |
| #### origin | |
| • `Optional` **origin**: [`Origin`](#interfacesflatfileeventsoriginmd) | |
| ##### Inherited from | |
| [WorkbookRemovedEvent](#interfacesflatfileeventsworkbookremovedeventmd).[origin](#origin) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:28](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L28) | |
| ___ | |
| #### payload | |
| • **payload**: `Record`<`string`, `unknown`\> | |
| ##### Inherited from | |
| [WorkbookRemovedEvent](#interfacesflatfileeventsworkbookremovedeventmd).[payload](#payload) | |
| ##### Defined in | |
| [src/api/resources/events/types/WorkbookRemovedEvent.ts:8](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/WorkbookRemovedEvent.ts#L8) | |
| ___ | |
| #### target | |
| • `Optional` **target**: `string` | |
| ##### Inherited from | |
| [WorkbookRemovedEvent](#interfacesflatfileeventsworkbookremovedeventmd).[target](#target) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:27](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L27) | |
| ___ | |
| #### topic | |
| • **topic**: [`EventTopic`](#eventtopic-1) | |
| ##### Inherited from | |
| [WorkbookRemovedEvent](#interfacesflatfileeventsworkbookremovedeventmd).[topic](#topic) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:10](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L10) | |
| ___ | |
| #### type | |
| • **type**: ``"workbook:removed"`` | |
| ##### Defined in | |
| [src/api/resources/events/types/Event.ts:55](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/Event.ts#L55) | |
| <a name="interfacesflatfileeventseventworkbookupdatedmd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / [events](#modulesflatfileeventsmd) / [Event](#modulesflatfileeventseventmd) / WorkbookUpdated | |
| ## Interface: WorkbookUpdated | |
| [events](#modulesflatfileeventsmd).[Event](#modulesflatfileeventseventmd).WorkbookUpdated | |
| ### Hierarchy | |
| - [`WorkbookUpdatedEvent`](#interfacesflatfileeventsworkbookupdatedeventmd) | |
| ↳ **`WorkbookUpdated`** | |
| ### Table of contents | |
| #### Properties | |
| - [acknowledgedAt](#acknowledgedat) | |
| - [acknowledgedBy](#acknowledgedby) | |
| - [attributes](#attributes) | |
| - [callbackUrl](#callbackurl) | |
| - [context](#context) | |
| - [createdAt](#createdat) | |
| - [dataUrl](#dataurl) | |
| - [deletedAt](#deletedat) | |
| - [domain](#domain) | |
| - [origin](#origin) | |
| - [payload](#payload) | |
| - [target](#target) | |
| - [topic](#topic) | |
| - [type](#type) | |
| ### Properties | |
| #### acknowledgedAt | |
| • `Optional` **acknowledgedAt**: `string` | |
| Date the event was acknowledged | |
| ##### Inherited from | |
| [WorkbookUpdatedEvent](#interfacesflatfileeventsworkbookupdatedeventmd).[acknowledgedAt](#acknowledgedat) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:24](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L24) | |
| ___ | |
| #### acknowledgedBy | |
| • `Optional` **acknowledgedBy**: `string` | |
| The actor (user or system) who acknowledged the event | |
| ##### Inherited from | |
| [WorkbookUpdatedEvent](#interfacesflatfileeventsworkbookupdatedeventmd).[acknowledgedBy](#acknowledgedby) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:26](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L26) | |
| ___ | |
| #### attributes | |
| • `Optional` **attributes**: [`EventAttributes`](#interfacesflatfileeventseventattributesmd) | |
| The attributes of the event | |
| ##### Inherited from | |
| [WorkbookUpdatedEvent](#interfacesflatfileeventsworkbookupdatedeventmd).[attributes](#attributes) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:14](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L14) | |
| ___ | |
| #### callbackUrl | |
| • `Optional` **callbackUrl**: `string` | |
| The callback url to acknowledge the event | |
| ##### Inherited from | |
| [WorkbookUpdatedEvent](#interfacesflatfileeventsworkbookupdatedeventmd).[callbackUrl](#callbackurl) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:16](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L16) | |
| ___ | |
| #### context | |
| • **context**: [`Context`](#interfacesflatfileeventscontextmd) | |
| The context of the event | |
| ##### Inherited from | |
| [WorkbookUpdatedEvent](#interfacesflatfileeventsworkbookupdatedeventmd).[context](#context) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:12](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L12) | |
| ___ | |
| #### createdAt | |
| • **createdAt**: `Date` | |
| Date the event was created | |
| ##### Inherited from | |
| [WorkbookUpdatedEvent](#interfacesflatfileeventsworkbookupdatedeventmd).[createdAt](#createdat) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:20](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L20) | |
| ___ | |
| #### dataUrl | |
| • `Optional` **dataUrl**: `string` | |
| The url to retrieve the data associated with the event | |
| ##### Inherited from | |
| [WorkbookUpdatedEvent](#interfacesflatfileeventsworkbookupdatedeventmd).[dataUrl](#dataurl) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:18](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L18) | |
| ___ | |
| #### deletedAt | |
| • `Optional` **deletedAt**: `Date` | |
| Date the event was deleted | |
| ##### Inherited from | |
| [WorkbookUpdatedEvent](#interfacesflatfileeventsworkbookupdatedeventmd).[deletedAt](#deletedat) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:22](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L22) | |
| ___ | |
| #### domain | |
| • **domain**: [`Domain`](#domain-1) | |
| The domain of the event | |
| ##### Inherited from | |
| [WorkbookUpdatedEvent](#interfacesflatfileeventsworkbookupdatedeventmd).[domain](#domain) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:9](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L9) | |
| ___ | |
| #### origin | |
| • `Optional` **origin**: [`Origin`](#interfacesflatfileeventsoriginmd) | |
| ##### Inherited from | |
| [WorkbookUpdatedEvent](#interfacesflatfileeventsworkbookupdatedeventmd).[origin](#origin) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:28](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L28) | |
| ___ | |
| #### payload | |
| • **payload**: `Record`<`string`, `unknown`\> | |
| ##### Inherited from | |
| [WorkbookUpdatedEvent](#interfacesflatfileeventsworkbookupdatedeventmd).[payload](#payload) | |
| ##### Defined in | |
| [src/api/resources/events/types/WorkbookUpdatedEvent.ts:8](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/WorkbookUpdatedEvent.ts#L8) | |
| ___ | |
| #### target | |
| • `Optional` **target**: `string` | |
| ##### Inherited from | |
| [WorkbookUpdatedEvent](#interfacesflatfileeventsworkbookupdatedeventmd).[target](#target) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:27](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L27) | |
| ___ | |
| #### topic | |
| • **topic**: [`EventTopic`](#eventtopic-1) | |
| ##### Inherited from | |
| [WorkbookUpdatedEvent](#interfacesflatfileeventsworkbookupdatedeventmd).[topic](#topic) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:10](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L10) | |
| ___ | |
| #### type | |
| • **type**: ``"workbook:updated"`` | |
| ##### Defined in | |
| [src/api/resources/events/types/Event.ts:51](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/Event.ts#L51) | |
| <a name="interfacesflatfileeventseventattributesmd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / [events](#modulesflatfileeventsmd) / EventAttributes | |
| ## Interface: EventAttributes | |
| [Flatfile](#modulesflatfilemd).[events](#modulesflatfileeventsmd).EventAttributes | |
| The attributes of the event | |
| ### Table of contents | |
| #### Properties | |
| - [progress](#progress) | |
| - [targetUpdatedAt](#targetupdatedat) | |
| ### Properties | |
| #### progress | |
| • `Optional` **progress**: [`Progress`](#interfacesflatfileeventsprogressmd) | |
| The progress of the event within a collection of iterable events | |
| ##### Defined in | |
| [src/api/resources/events/types/EventAttributes.ts:14](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/EventAttributes.ts#L14) | |
| ___ | |
| #### targetUpdatedAt | |
| • `Optional` **targetUpdatedAt**: `Date` | |
| Date the related entity was last updated | |
| ##### Defined in | |
| [src/api/resources/events/types/EventAttributes.ts:12](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/EventAttributes.ts#L12) | |
| <a name="interfacesflatfileeventseventresponsemd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / [events](#modulesflatfileeventsmd) / EventResponse | |
| ## Interface: EventResponse | |
| [Flatfile](#modulesflatfilemd).[events](#modulesflatfileeventsmd).EventResponse | |
| ### Table of contents | |
| #### Properties | |
| - [data](#data) | |
| ### Properties | |
| #### data | |
| • **data**: [`Event`](#event) | |
| ##### Defined in | |
| [src/api/resources/events/types/EventResponse.ts:8](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/EventResponse.ts#L8) | |
| <a name="interfacesflatfileeventsfiledeletedeventmd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / [events](#modulesflatfileeventsmd) / FileDeletedEvent | |
| ## Interface: FileDeletedEvent | |
| [Flatfile](#modulesflatfilemd).[events](#modulesflatfileeventsmd).FileDeletedEvent | |
| ### Hierarchy | |
| - [`BaseEvent`](#interfacesflatfileeventsbaseeventmd) | |
| ↳ **`FileDeletedEvent`** | |
| ↳↳ [`FileDeleted`](#interfacesflatfileeventseventfiledeletedmd) | |
| ### Table of contents | |
| #### Properties | |
| - [acknowledgedAt](#acknowledgedat) | |
| - [acknowledgedBy](#acknowledgedby) | |
| - [attributes](#attributes) | |
| - [callbackUrl](#callbackurl) | |
| - [context](#context) | |
| - [createdAt](#createdat) | |
| - [dataUrl](#dataurl) | |
| - [deletedAt](#deletedat) | |
| - [domain](#domain) | |
| - [origin](#origin) | |
| - [payload](#payload) | |
| - [target](#target) | |
| - [topic](#topic) | |
| ### Properties | |
| #### acknowledgedAt | |
| • `Optional` **acknowledgedAt**: `string` | |
| Date the event was acknowledged | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[acknowledgedAt](#acknowledgedat) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:24](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L24) | |
| ___ | |
| #### acknowledgedBy | |
| • `Optional` **acknowledgedBy**: `string` | |
| The actor (user or system) who acknowledged the event | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[acknowledgedBy](#acknowledgedby) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:26](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L26) | |
| ___ | |
| #### attributes | |
| • `Optional` **attributes**: [`EventAttributes`](#interfacesflatfileeventseventattributesmd) | |
| The attributes of the event | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[attributes](#attributes) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:14](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L14) | |
| ___ | |
| #### callbackUrl | |
| • `Optional` **callbackUrl**: `string` | |
| The callback url to acknowledge the event | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[callbackUrl](#callbackurl) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:16](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L16) | |
| ___ | |
| #### context | |
| • **context**: [`Context`](#interfacesflatfileeventscontextmd) | |
| The context of the event | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[context](#context) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:12](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L12) | |
| ___ | |
| #### createdAt | |
| • **createdAt**: `Date` | |
| Date the event was created | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[createdAt](#createdat) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:20](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L20) | |
| ___ | |
| #### dataUrl | |
| • `Optional` **dataUrl**: `string` | |
| The url to retrieve the data associated with the event | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[dataUrl](#dataurl) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:18](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L18) | |
| ___ | |
| #### deletedAt | |
| • `Optional` **deletedAt**: `Date` | |
| Date the event was deleted | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[deletedAt](#deletedat) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:22](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L22) | |
| ___ | |
| #### domain | |
| • **domain**: [`Domain`](#domain-1) | |
| The domain of the event | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[domain](#domain) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:9](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L9) | |
| ___ | |
| #### origin | |
| • `Optional` **origin**: [`Origin`](#interfacesflatfileeventsoriginmd) | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[origin](#origin) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:28](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L28) | |
| ___ | |
| #### payload | |
| • **payload**: `Record`<`string`, `unknown`\> | |
| ##### Defined in | |
| [src/api/resources/events/types/FileDeletedEvent.ts:8](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/FileDeletedEvent.ts#L8) | |
| ___ | |
| #### target | |
| • `Optional` **target**: `string` | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[target](#target) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:27](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L27) | |
| ___ | |
| #### topic | |
| • **topic**: [`EventTopic`](#eventtopic-1) | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[topic](#topic) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:10](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L10) | |
| <a name="interfacesflatfileeventsgeteventtokenrequestmd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / [events](#modulesflatfileeventsmd) / GetEventTokenRequest | |
| ## Interface: GetEventTokenRequest | |
| [Flatfile](#modulesflatfilemd).[events](#modulesflatfileeventsmd).GetEventTokenRequest | |
| ### Table of contents | |
| #### Properties | |
| - [scope](#scope) | |
| - [spaceId](#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](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/client/requests/GetEventTokenRequest.ts#L15) | |
| ___ | |
| #### spaceId | |
| • `Optional` **spaceId**: `string` | |
| The space id | |
| ##### Defined in | |
| [src/api/resources/events/client/requests/GetEventTokenRequest.ts:11](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/client/requests/GetEventTokenRequest.ts#L11) | |
| <a name="interfacesflatfileeventsjobcompletedeventmd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / [events](#modulesflatfileeventsmd) / JobCompletedEvent | |
| ## Interface: JobCompletedEvent | |
| [Flatfile](#modulesflatfilemd).[events](#modulesflatfileeventsmd).JobCompletedEvent | |
| ### Hierarchy | |
| - [`BaseEvent`](#interfacesflatfileeventsbaseeventmd) | |
| ↳ **`JobCompletedEvent`** | |
| ↳↳ [`JobCompleted`](#interfacesflatfileeventseventjobcompletedmd) | |
| ### Table of contents | |
| #### Properties | |
| - [acknowledgedAt](#acknowledgedat) | |
| - [acknowledgedBy](#acknowledgedby) | |
| - [attributes](#attributes) | |
| - [callbackUrl](#callbackurl) | |
| - [context](#context) | |
| - [createdAt](#createdat) | |
| - [dataUrl](#dataurl) | |
| - [deletedAt](#deletedat) | |
| - [domain](#domain) | |
| - [origin](#origin) | |
| - [payload](#payload) | |
| - [target](#target) | |
| - [topic](#topic) | |
| ### Properties | |
| #### acknowledgedAt | |
| • `Optional` **acknowledgedAt**: `string` | |
| Date the event was acknowledged | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[acknowledgedAt](#acknowledgedat) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:24](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L24) | |
| ___ | |
| #### acknowledgedBy | |
| • `Optional` **acknowledgedBy**: `string` | |
| The actor (user or system) who acknowledged the event | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[acknowledgedBy](#acknowledgedby) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:26](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L26) | |
| ___ | |
| #### attributes | |
| • `Optional` **attributes**: [`EventAttributes`](#interfacesflatfileeventseventattributesmd) | |
| The attributes of the event | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[attributes](#attributes) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:14](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L14) | |
| ___ | |
| #### callbackUrl | |
| • `Optional` **callbackUrl**: `string` | |
| The callback url to acknowledge the event | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[callbackUrl](#callbackurl) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:16](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L16) | |
| ___ | |
| #### context | |
| • **context**: [`Context`](#interfacesflatfileeventscontextmd) | |
| The context of the event | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[context](#context) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:12](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L12) | |
| ___ | |
| #### createdAt | |
| • **createdAt**: `Date` | |
| Date the event was created | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[createdAt](#createdat) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:20](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L20) | |
| ___ | |
| #### dataUrl | |
| • `Optional` **dataUrl**: `string` | |
| The url to retrieve the data associated with the event | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[dataUrl](#dataurl) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:18](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L18) | |
| ___ | |
| #### deletedAt | |
| • `Optional` **deletedAt**: `Date` | |
| Date the event was deleted | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[deletedAt](#deletedat) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:22](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L22) | |
| ___ | |
| #### domain | |
| • **domain**: [`Domain`](#domain-1) | |
| The domain of the event | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[domain](#domain) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:9](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L9) | |
| ___ | |
| #### origin | |
| • `Optional` **origin**: [`Origin`](#interfacesflatfileeventsoriginmd) | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[origin](#origin) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:28](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L28) | |
| ___ | |
| #### payload | |
| • **payload**: [`JobPayload`](#interfacesflatfileeventsjobpayloadmd) | |
| ##### Defined in | |
| [src/api/resources/events/types/JobCompletedEvent.ts:8](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/JobCompletedEvent.ts#L8) | |
| ___ | |
| #### target | |
| • `Optional` **target**: `string` | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[target](#target) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:27](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L27) | |
| ___ | |
| #### topic | |
| • **topic**: [`EventTopic`](#eventtopic-1) | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[topic](#topic) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:10](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L10) | |
| <a name="interfacesflatfileeventsjobdeletedeventmd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / [events](#modulesflatfileeventsmd) / JobDeletedEvent | |
| ## Interface: JobDeletedEvent | |
| [Flatfile](#modulesflatfilemd).[events](#modulesflatfileeventsmd).JobDeletedEvent | |
| ### Hierarchy | |
| - [`BaseEvent`](#interfacesflatfileeventsbaseeventmd) | |
| ↳ **`JobDeletedEvent`** | |
| ↳↳ [`JobDeleted`](#interfacesflatfileeventseventjobdeletedmd) | |
| ### Table of contents | |
| #### Properties | |
| - [acknowledgedAt](#acknowledgedat) | |
| - [acknowledgedBy](#acknowledgedby) | |
| - [attributes](#attributes) | |
| - [callbackUrl](#callbackurl) | |
| - [context](#context) | |
| - [createdAt](#createdat) | |
| - [dataUrl](#dataurl) | |
| - [deletedAt](#deletedat) | |
| - [domain](#domain) | |
| - [origin](#origin) | |
| - [payload](#payload) | |
| - [target](#target) | |
| - [topic](#topic) | |
| ### Properties | |
| #### acknowledgedAt | |
| • `Optional` **acknowledgedAt**: `string` | |
| Date the event was acknowledged | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[acknowledgedAt](#acknowledgedat) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:24](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L24) | |
| ___ | |
| #### acknowledgedBy | |
| • `Optional` **acknowledgedBy**: `string` | |
| The actor (user or system) who acknowledged the event | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[acknowledgedBy](#acknowledgedby) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:26](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L26) | |
| ___ | |
| #### attributes | |
| • `Optional` **attributes**: [`EventAttributes`](#interfacesflatfileeventseventattributesmd) | |
| The attributes of the event | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[attributes](#attributes) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:14](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L14) | |
| ___ | |
| #### callbackUrl | |
| • `Optional` **callbackUrl**: `string` | |
| The callback url to acknowledge the event | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[callbackUrl](#callbackurl) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:16](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L16) | |
| ___ | |
| #### context | |
| • **context**: [`Context`](#interfacesflatfileeventscontextmd) | |
| The context of the event | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[context](#context) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:12](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L12) | |
| ___ | |
| #### createdAt | |
| • **createdAt**: `Date` | |
| Date the event was created | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[createdAt](#createdat) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:20](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L20) | |
| ___ | |
| #### dataUrl | |
| • `Optional` **dataUrl**: `string` | |
| The url to retrieve the data associated with the event | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[dataUrl](#dataurl) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:18](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L18) | |
| ___ | |
| #### deletedAt | |
| • `Optional` **deletedAt**: `Date` | |
| Date the event was deleted | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[deletedAt](#deletedat) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:22](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L22) | |
| ___ | |
| #### domain | |
| • **domain**: [`Domain`](#domain-1) | |
| The domain of the event | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[domain](#domain) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:9](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L9) | |
| ___ | |
| #### origin | |
| • `Optional` **origin**: [`Origin`](#interfacesflatfileeventsoriginmd) | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[origin](#origin) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:28](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L28) | |
| ___ | |
| #### payload | |
| • **payload**: `Record`<`string`, `unknown`\> | |
| ##### Defined in | |
| [src/api/resources/events/types/JobDeletedEvent.ts:8](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/JobDeletedEvent.ts#L8) | |
| ___ | |
| #### target | |
| • `Optional` **target**: `string` | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[target](#target) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:27](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L27) | |
| ___ | |
| #### topic | |
| • **topic**: [`EventTopic`](#eventtopic-1) | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[topic](#topic) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:10](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L10) | |
| <a name="interfacesflatfileeventsjobfailedeventmd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / [events](#modulesflatfileeventsmd) / JobFailedEvent | |
| ## Interface: JobFailedEvent | |
| [Flatfile](#modulesflatfilemd).[events](#modulesflatfileeventsmd).JobFailedEvent | |
| ### Hierarchy | |
| - [`BaseEvent`](#interfacesflatfileeventsbaseeventmd) | |
| ↳ **`JobFailedEvent`** | |
| ↳↳ [`JobFailed`](#interfacesflatfileeventseventjobfailedmd) | |
| ### Table of contents | |
| #### Properties | |
| - [acknowledgedAt](#acknowledgedat) | |
| - [acknowledgedBy](#acknowledgedby) | |
| - [attributes](#attributes) | |
| - [callbackUrl](#callbackurl) | |
| - [context](#context) | |
| - [createdAt](#createdat) | |
| - [dataUrl](#dataurl) | |
| - [deletedAt](#deletedat) | |
| - [domain](#domain) | |
| - [origin](#origin) | |
| - [payload](#payload) | |
| - [target](#target) | |
| - [topic](#topic) | |
| ### Properties | |
| #### acknowledgedAt | |
| • `Optional` **acknowledgedAt**: `string` | |
| Date the event was acknowledged | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[acknowledgedAt](#acknowledgedat) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:24](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L24) | |
| ___ | |
| #### acknowledgedBy | |
| • `Optional` **acknowledgedBy**: `string` | |
| The actor (user or system) who acknowledged the event | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[acknowledgedBy](#acknowledgedby) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:26](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L26) | |
| ___ | |
| #### attributes | |
| • `Optional` **attributes**: [`EventAttributes`](#interfacesflatfileeventseventattributesmd) | |
| The attributes of the event | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[attributes](#attributes) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:14](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L14) | |
| ___ | |
| #### callbackUrl | |
| • `Optional` **callbackUrl**: `string` | |
| The callback url to acknowledge the event | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[callbackUrl](#callbackurl) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:16](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L16) | |
| ___ | |
| #### context | |
| • **context**: [`Context`](#interfacesflatfileeventscontextmd) | |
| The context of the event | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[context](#context) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:12](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L12) | |
| ___ | |
| #### createdAt | |
| • **createdAt**: `Date` | |
| Date the event was created | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[createdAt](#createdat) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:20](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L20) | |
| ___ | |
| #### dataUrl | |
| • `Optional` **dataUrl**: `string` | |
| The url to retrieve the data associated with the event | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[dataUrl](#dataurl) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:18](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L18) | |
| ___ | |
| #### deletedAt | |
| • `Optional` **deletedAt**: `Date` | |
| Date the event was deleted | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[deletedAt](#deletedat) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:22](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L22) | |
| ___ | |
| #### domain | |
| • **domain**: [`Domain`](#domain-1) | |
| The domain of the event | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[domain](#domain) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:9](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L9) | |
| ___ | |
| #### origin | |
| • `Optional` **origin**: [`Origin`](#interfacesflatfileeventsoriginmd) | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[origin](#origin) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:28](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L28) | |
| ___ | |
| #### payload | |
| • **payload**: [`JobFailedPayload`](#interfacesflatfileeventsjobfailedpayloadmd) | |
| ##### Defined in | |
| [src/api/resources/events/types/JobFailedEvent.ts:8](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/JobFailedEvent.ts#L8) | |
| ___ | |
| #### target | |
| • `Optional` **target**: `string` | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[target](#target) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:27](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L27) | |
| ___ | |
| #### topic | |
| • **topic**: [`EventTopic`](#eventtopic-1) | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[topic](#topic) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:10](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L10) | |
| <a name="interfacesflatfileeventsjobfailedpayloadmd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / [events](#modulesflatfileeventsmd) / JobFailedPayload | |
| ## Interface: JobFailedPayload | |
| [Flatfile](#modulesflatfilemd).[events](#modulesflatfileeventsmd).JobFailedPayload | |
| ### Hierarchy | |
| - [`JobPayload`](#interfacesflatfileeventsjobpayloadmd) | |
| ↳ **`JobFailedPayload`** | |
| ### Table of contents | |
| #### Properties | |
| - [err](#err) | |
| - [operation](#operation) | |
| - [type](#type) | |
| ### Properties | |
| #### err | |
| • **err**: `string` | |
| ##### Defined in | |
| [src/api/resources/events/types/JobFailedPayload.ts:8](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/JobFailedPayload.ts#L8) | |
| ___ | |
| #### operation | |
| • **operation**: [`JobOperationType`](#joboperationtype-1) | |
| ##### Inherited from | |
| [JobPayload](#interfacesflatfileeventsjobpayloadmd).[operation](#operation) | |
| ##### Defined in | |
| [src/api/resources/events/types/JobPayload.ts:9](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/JobPayload.ts#L9) | |
| ___ | |
| #### type | |
| • **type**: [`JobPayloadType`](#jobpayloadtype-1) | |
| ##### Inherited from | |
| [JobPayload](#interfacesflatfileeventsjobpayloadmd).[type](#type) | |
| ##### Defined in | |
| [src/api/resources/events/types/JobPayload.ts:8](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/JobPayload.ts#L8) | |
| <a name="interfacesflatfileeventsjobpayloadmd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / [events](#modulesflatfileeventsmd) / JobPayload | |
| ## Interface: JobPayload | |
| [Flatfile](#modulesflatfilemd).[events](#modulesflatfileeventsmd).JobPayload | |
| ### Hierarchy | |
| - **`JobPayload`** | |
| ↳ [`JobFailedPayload`](#interfacesflatfileeventsjobfailedpayloadmd) | |
| ### Table of contents | |
| #### Properties | |
| - [operation](#operation) | |
| - [type](#type) | |
| ### Properties | |
| #### operation | |
| • **operation**: [`JobOperationType`](#joboperationtype-1) | |
| ##### Defined in | |
| [src/api/resources/events/types/JobPayload.ts:9](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/JobPayload.ts#L9) | |
| ___ | |
| #### type | |
| • **type**: [`JobPayloadType`](#jobpayloadtype-1) | |
| ##### Defined in | |
| [src/api/resources/events/types/JobPayload.ts:8](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/JobPayload.ts#L8) | |
| <a name="interfacesflatfileeventsjobstartedeventmd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / [events](#modulesflatfileeventsmd) / JobStartedEvent | |
| ## Interface: JobStartedEvent | |
| [Flatfile](#modulesflatfilemd).[events](#modulesflatfileeventsmd).JobStartedEvent | |
| ### Hierarchy | |
| - [`BaseEvent`](#interfacesflatfileeventsbaseeventmd) | |
| ↳ **`JobStartedEvent`** | |
| ↳↳ [`JobStarted`](#interfacesflatfileeventseventjobstartedmd) | |
| ### Table of contents | |
| #### Properties | |
| - [acknowledgedAt](#acknowledgedat) | |
| - [acknowledgedBy](#acknowledgedby) | |
| - [attributes](#attributes) | |
| - [callbackUrl](#callbackurl) | |
| - [context](#context) | |
| - [createdAt](#createdat) | |
| - [dataUrl](#dataurl) | |
| - [deletedAt](#deletedat) | |
| - [domain](#domain) | |
| - [origin](#origin) | |
| - [payload](#payload) | |
| - [target](#target) | |
| - [topic](#topic) | |
| ### Properties | |
| #### acknowledgedAt | |
| • `Optional` **acknowledgedAt**: `string` | |
| Date the event was acknowledged | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[acknowledgedAt](#acknowledgedat) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:24](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L24) | |
| ___ | |
| #### acknowledgedBy | |
| • `Optional` **acknowledgedBy**: `string` | |
| The actor (user or system) who acknowledged the event | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[acknowledgedBy](#acknowledgedby) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:26](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L26) | |
| ___ | |
| #### attributes | |
| • `Optional` **attributes**: [`EventAttributes`](#interfacesflatfileeventseventattributesmd) | |
| The attributes of the event | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[attributes](#attributes) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:14](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L14) | |
| ___ | |
| #### callbackUrl | |
| • `Optional` **callbackUrl**: `string` | |
| The callback url to acknowledge the event | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[callbackUrl](#callbackurl) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:16](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L16) | |
| ___ | |
| #### context | |
| • **context**: [`Context`](#interfacesflatfileeventscontextmd) | |
| The context of the event | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[context](#context) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:12](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L12) | |
| ___ | |
| #### createdAt | |
| • **createdAt**: `Date` | |
| Date the event was created | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[createdAt](#createdat) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:20](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L20) | |
| ___ | |
| #### dataUrl | |
| • `Optional` **dataUrl**: `string` | |
| The url to retrieve the data associated with the event | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[dataUrl](#dataurl) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:18](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L18) | |
| ___ | |
| #### deletedAt | |
| • `Optional` **deletedAt**: `Date` | |
| Date the event was deleted | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[deletedAt](#deletedat) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:22](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L22) | |
| ___ | |
| #### domain | |
| • **domain**: [`Domain`](#domain-1) | |
| The domain of the event | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[domain](#domain) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:9](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L9) | |
| ___ | |
| #### origin | |
| • `Optional` **origin**: [`Origin`](#interfacesflatfileeventsoriginmd) | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[origin](#origin) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:28](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L28) | |
| ___ | |
| #### payload | |
| • **payload**: [`JobPayload`](#interfacesflatfileeventsjobpayloadmd) | |
| ##### Defined in | |
| [src/api/resources/events/types/JobStartedEvent.ts:8](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/JobStartedEvent.ts#L8) | |
| ___ | |
| #### target | |
| • `Optional` **target**: `string` | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[target](#target) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:27](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L27) | |
| ___ | |
| #### topic | |
| • **topic**: [`EventTopic`](#eventtopic-1) | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[topic](#topic) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:10](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L10) | |
| <a name="interfacesflatfileeventsjobupdatedeventmd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / [events](#modulesflatfileeventsmd) / JobUpdatedEvent | |
| ## Interface: JobUpdatedEvent | |
| [Flatfile](#modulesflatfilemd).[events](#modulesflatfileeventsmd).JobUpdatedEvent | |
| ### Hierarchy | |
| - [`BaseEvent`](#interfacesflatfileeventsbaseeventmd) | |
| ↳ **`JobUpdatedEvent`** | |
| ↳↳ [`JobUpdated`](#interfacesflatfileeventseventjobupdatedmd) | |
| ### Table of contents | |
| #### Properties | |
| - [acknowledgedAt](#acknowledgedat) | |
| - [acknowledgedBy](#acknowledgedby) | |
| - [attributes](#attributes) | |
| - [callbackUrl](#callbackurl) | |
| - [context](#context) | |
| - [createdAt](#createdat) | |
| - [dataUrl](#dataurl) | |
| - [deletedAt](#deletedat) | |
| - [domain](#domain) | |
| - [origin](#origin) | |
| - [payload](#payload) | |
| - [target](#target) | |
| - [topic](#topic) | |
| ### Properties | |
| #### acknowledgedAt | |
| • `Optional` **acknowledgedAt**: `string` | |
| Date the event was acknowledged | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[acknowledgedAt](#acknowledgedat) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:24](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L24) | |
| ___ | |
| #### acknowledgedBy | |
| • `Optional` **acknowledgedBy**: `string` | |
| The actor (user or system) who acknowledged the event | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[acknowledgedBy](#acknowledgedby) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:26](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L26) | |
| ___ | |
| #### attributes | |
| • `Optional` **attributes**: [`EventAttributes`](#interfacesflatfileeventseventattributesmd) | |
| The attributes of the event | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[attributes](#attributes) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:14](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L14) | |
| ___ | |
| #### callbackUrl | |
| • `Optional` **callbackUrl**: `string` | |
| The callback url to acknowledge the event | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[callbackUrl](#callbackurl) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:16](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L16) | |
| ___ | |
| #### context | |
| • **context**: [`Context`](#interfacesflatfileeventscontextmd) | |
| The context of the event | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[context](#context) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:12](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L12) | |
| ___ | |
| #### createdAt | |
| • **createdAt**: `Date` | |
| Date the event was created | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[createdAt](#createdat) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:20](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L20) | |
| ___ | |
| #### dataUrl | |
| • `Optional` **dataUrl**: `string` | |
| The url to retrieve the data associated with the event | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[dataUrl](#dataurl) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:18](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L18) | |
| ___ | |
| #### deletedAt | |
| • `Optional` **deletedAt**: `Date` | |
| Date the event was deleted | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[deletedAt](#deletedat) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:22](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L22) | |
| ___ | |
| #### domain | |
| • **domain**: [`Domain`](#domain-1) | |
| The domain of the event | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[domain](#domain) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:9](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L9) | |
| ___ | |
| #### origin | |
| • `Optional` **origin**: [`Origin`](#interfacesflatfileeventsoriginmd) | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[origin](#origin) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:28](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L28) | |
| ___ | |
| #### payload | |
| • **payload**: [`JobPayload`](#interfacesflatfileeventsjobpayloadmd) | |
| ##### Defined in | |
| [src/api/resources/events/types/JobUpdatedEvent.ts:8](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/JobUpdatedEvent.ts#L8) | |
| ___ | |
| #### target | |
| • `Optional` **target**: `string` | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[target](#target) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:27](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L27) | |
| ___ | |
| #### topic | |
| • **topic**: [`EventTopic`](#eventtopic-1) | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[topic](#topic) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:10](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L10) | |
| <a name="interfacesflatfileeventsjobwaitingeventmd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / [events](#modulesflatfileeventsmd) / JobWaitingEvent | |
| ## Interface: JobWaitingEvent | |
| [Flatfile](#modulesflatfilemd).[events](#modulesflatfileeventsmd).JobWaitingEvent | |
| ### Hierarchy | |
| - [`BaseEvent`](#interfacesflatfileeventsbaseeventmd) | |
| ↳ **`JobWaitingEvent`** | |
| ↳↳ [`JobWaiting`](#interfacesflatfileeventseventjobwaitingmd) | |
| ### Table of contents | |
| #### Properties | |
| - [acknowledgedAt](#acknowledgedat) | |
| - [acknowledgedBy](#acknowledgedby) | |
| - [attributes](#attributes) | |
| - [callbackUrl](#callbackurl) | |
| - [context](#context) | |
| - [createdAt](#createdat) | |
| - [dataUrl](#dataurl) | |
| - [deletedAt](#deletedat) | |
| - [domain](#domain) | |
| - [origin](#origin) | |
| - [payload](#payload) | |
| - [target](#target) | |
| - [topic](#topic) | |
| ### Properties | |
| #### acknowledgedAt | |
| • `Optional` **acknowledgedAt**: `string` | |
| Date the event was acknowledged | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[acknowledgedAt](#acknowledgedat) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:24](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L24) | |
| ___ | |
| #### acknowledgedBy | |
| • `Optional` **acknowledgedBy**: `string` | |
| The actor (user or system) who acknowledged the event | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[acknowledgedBy](#acknowledgedby) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:26](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L26) | |
| ___ | |
| #### attributes | |
| • `Optional` **attributes**: [`EventAttributes`](#interfacesflatfileeventseventattributesmd) | |
| The attributes of the event | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[attributes](#attributes) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:14](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L14) | |
| ___ | |
| #### callbackUrl | |
| • `Optional` **callbackUrl**: `string` | |
| The callback url to acknowledge the event | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[callbackUrl](#callbackurl) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:16](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L16) | |
| ___ | |
| #### context | |
| • **context**: [`Context`](#interfacesflatfileeventscontextmd) | |
| The context of the event | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[context](#context) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:12](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L12) | |
| ___ | |
| #### createdAt | |
| • **createdAt**: `Date` | |
| Date the event was created | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[createdAt](#createdat) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:20](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L20) | |
| ___ | |
| #### dataUrl | |
| • `Optional` **dataUrl**: `string` | |
| The url to retrieve the data associated with the event | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[dataUrl](#dataurl) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:18](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L18) | |
| ___ | |
| #### deletedAt | |
| • `Optional` **deletedAt**: `Date` | |
| Date the event was deleted | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[deletedAt](#deletedat) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:22](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L22) | |
| ___ | |
| #### domain | |
| • **domain**: [`Domain`](#domain-1) | |
| The domain of the event | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[domain](#domain) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:9](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L9) | |
| ___ | |
| #### origin | |
| • `Optional` **origin**: [`Origin`](#interfacesflatfileeventsoriginmd) | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[origin](#origin) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:28](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L28) | |
| ___ | |
| #### payload | |
| • **payload**: `Record`<`string`, `unknown`\> | |
| ##### Defined in | |
| [src/api/resources/events/types/JobWaitingEvent.ts:8](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/JobWaitingEvent.ts#L8) | |
| ___ | |
| #### target | |
| • `Optional` **target**: `string` | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[target](#target) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:27](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L27) | |
| ___ | |
| #### topic | |
| • **topic**: [`EventTopic`](#eventtopic-1) | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[topic](#topic) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:10](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L10) | |
| <a name="interfacesflatfileeventslistalleventsresponsemd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / [events](#modulesflatfileeventsmd) / ListAllEventsResponse | |
| ## Interface: ListAllEventsResponse | |
| [Flatfile](#modulesflatfilemd).[events](#modulesflatfileeventsmd).ListAllEventsResponse | |
| ### Table of contents | |
| #### Properties | |
| - [data](#data) | |
| ### Properties | |
| #### data | |
| • **data**: [`Event`](#event)[] | |
| ##### Defined in | |
| [src/api/resources/events/types/ListAllEventsResponse.ts:8](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/ListAllEventsResponse.ts#L8) | |
| <a name="interfacesflatfileeventslisteventsrequestmd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / [events](#modulesflatfileeventsmd) / ListEventsRequest | |
| ## Interface: ListEventsRequest | |
| [Flatfile](#modulesflatfilemd).[events](#modulesflatfileeventsmd).ListEventsRequest | |
| ### Table of contents | |
| #### Properties | |
| - [domain](#domain) | |
| - [environmentId](#environmentid) | |
| - [includeAcknowledged](#includeacknowledged) | |
| - [pageNumber](#pagenumber) | |
| - [pageSize](#pagesize) | |
| - [since](#since) | |
| - [spaceId](#spaceid) | |
| - [topic](#topic) | |
| ### Properties | |
| #### domain | |
| • `Optional` **domain**: `string` | |
| Filter by event domain | |
| ##### Defined in | |
| [src/api/resources/events/client/requests/ListEventsRequest.ts:13](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/client/requests/ListEventsRequest.ts#L13) | |
| ___ | |
| #### environmentId | |
| • **environmentId**: `string` | |
| ##### Defined in | |
| [src/api/resources/events/client/requests/ListEventsRequest.ts:8](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/client/requests/ListEventsRequest.ts#L8) | |
| ___ | |
| #### includeAcknowledged | |
| • `Optional` **includeAcknowledged**: `boolean` | |
| Include acknowledged events | |
| ##### Defined in | |
| [src/api/resources/events/client/requests/ListEventsRequest.ts:33](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/client/requests/ListEventsRequest.ts#L33) | |
| ___ | |
| #### pageNumber | |
| • `Optional` **pageNumber**: `number` | |
| Based on pageSize, which page of records to return | |
| ##### Defined in | |
| [src/api/resources/events/client/requests/ListEventsRequest.ts:29](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/client/requests/ListEventsRequest.ts#L29) | |
| ___ | |
| #### 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](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/client/requests/ListEventsRequest.ts#L25) | |
| ___ | |
| #### since | |
| • `Optional` **since**: `string` | |
| Filter by event timestamp | |
| ##### Defined in | |
| [src/api/resources/events/client/requests/ListEventsRequest.ts:21](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/client/requests/ListEventsRequest.ts#L21) | |
| ___ | |
| #### spaceId | |
| • `Optional` **spaceId**: `string` | |
| ##### Defined in | |
| [src/api/resources/events/client/requests/ListEventsRequest.ts:9](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/client/requests/ListEventsRequest.ts#L9) | |
| ___ | |
| #### topic | |
| • `Optional` **topic**: `string` | |
| Filter by event topic | |
| ##### Defined in | |
| [src/api/resources/events/client/requests/ListEventsRequest.ts:17](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/client/requests/ListEventsRequest.ts#L17) | |
| <a name="interfacesflatfileeventsoriginmd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / [events](#modulesflatfileeventsmd) / Origin | |
| ## Interface: Origin | |
| [Flatfile](#modulesflatfilemd).[events](#modulesflatfileeventsmd).Origin | |
| The origin resource of the event | |
| ### Table of contents | |
| #### Properties | |
| - [id](#id) | |
| - [slug](#slug) | |
| ### Properties | |
| #### id | |
| • `Optional` **id**: `string` | |
| ##### Defined in | |
| [src/api/resources/events/types/Origin.ts:9](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/Origin.ts#L9) | |
| ___ | |
| #### slug | |
| • `Optional` **slug**: `string` | |
| ##### Defined in | |
| [src/api/resources/events/types/Origin.ts:10](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/Origin.ts#L10) | |
| <a name="interfacesflatfileeventsprogressmd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / [events](#modulesflatfileeventsmd) / Progress | |
| ## Interface: Progress | |
| [Flatfile](#modulesflatfilemd).[events](#modulesflatfileeventsmd).Progress | |
| The progress of the event within a collection of iterable events | |
| ### Table of contents | |
| #### Properties | |
| - [current](#current) | |
| - [percent](#percent) | |
| - [total](#total) | |
| ### Properties | |
| #### current | |
| • `Optional` **current**: `number` | |
| The current progress of the event | |
| ##### Defined in | |
| [src/api/resources/events/types/Progress.ts:10](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/Progress.ts#L10) | |
| ___ | |
| #### percent | |
| • `Optional` **percent**: `number` | |
| The percent complete of the event group | |
| ##### Defined in | |
| [src/api/resources/events/types/Progress.ts:14](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/Progress.ts#L14) | |
| ___ | |
| #### total | |
| • `Optional` **total**: `number` | |
| The total number of events in this group | |
| ##### Defined in | |
| [src/api/resources/events/types/Progress.ts:12](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/Progress.ts#L12) | |
| <a name="interfacesflatfileeventsrecordscreatedeventmd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / [events](#modulesflatfileeventsmd) / RecordsCreatedEvent | |
| ## Interface: RecordsCreatedEvent | |
| [Flatfile](#modulesflatfilemd).[events](#modulesflatfileeventsmd).RecordsCreatedEvent | |
| ### Hierarchy | |
| - [`BaseEvent`](#interfacesflatfileeventsbaseeventmd) | |
| ↳ **`RecordsCreatedEvent`** | |
| ↳↳ [`RecordsCreated`](#interfacesflatfileeventseventrecordscreatedmd) | |
| ### Table of contents | |
| #### Properties | |
| - [acknowledgedAt](#acknowledgedat) | |
| - [acknowledgedBy](#acknowledgedby) | |
| - [attributes](#attributes) | |
| - [callbackUrl](#callbackurl) | |
| - [context](#context) | |
| - [createdAt](#createdat) | |
| - [dataUrl](#dataurl) | |
| - [deletedAt](#deletedat) | |
| - [domain](#domain) | |
| - [origin](#origin) | |
| - [payload](#payload) | |
| - [target](#target) | |
| - [topic](#topic) | |
| ### Properties | |
| #### acknowledgedAt | |
| • `Optional` **acknowledgedAt**: `string` | |
| Date the event was acknowledged | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[acknowledgedAt](#acknowledgedat) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:24](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L24) | |
| ___ | |
| #### acknowledgedBy | |
| • `Optional` **acknowledgedBy**: `string` | |
| The actor (user or system) who acknowledged the event | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[acknowledgedBy](#acknowledgedby) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:26](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L26) | |
| ___ | |
| #### attributes | |
| • `Optional` **attributes**: [`EventAttributes`](#interfacesflatfileeventseventattributesmd) | |
| The attributes of the event | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[attributes](#attributes) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:14](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L14) | |
| ___ | |
| #### callbackUrl | |
| • `Optional` **callbackUrl**: `string` | |
| The callback url to acknowledge the event | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[callbackUrl](#callbackurl) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:16](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L16) | |
| ___ | |
| #### context | |
| • **context**: [`Context`](#interfacesflatfileeventscontextmd) | |
| The context of the event | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[context](#context) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:12](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L12) | |
| ___ | |
| #### createdAt | |
| • **createdAt**: `Date` | |
| Date the event was created | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[createdAt](#createdat) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:20](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L20) | |
| ___ | |
| #### dataUrl | |
| • `Optional` **dataUrl**: `string` | |
| The url to retrieve the data associated with the event | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[dataUrl](#dataurl) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:18](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L18) | |
| ___ | |
| #### deletedAt | |
| • `Optional` **deletedAt**: `Date` | |
| Date the event was deleted | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[deletedAt](#deletedat) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:22](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L22) | |
| ___ | |
| #### domain | |
| • **domain**: [`Domain`](#domain-1) | |
| The domain of the event | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[domain](#domain) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:9](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L9) | |
| ___ | |
| #### origin | |
| • `Optional` **origin**: [`Origin`](#interfacesflatfileeventsoriginmd) | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[origin](#origin) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:28](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L28) | |
| ___ | |
| #### payload | |
| • **payload**: [`RecordsPayload`](#interfacesflatfileeventsrecordspayloadmd) | |
| ##### Defined in | |
| [src/api/resources/events/types/RecordsCreatedEvent.ts:8](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/RecordsCreatedEvent.ts#L8) | |
| ___ | |
| #### target | |
| • `Optional` **target**: `string` | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[target](#target) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:27](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L27) | |
| ___ | |
| #### topic | |
| • **topic**: [`EventTopic`](#eventtopic-1) | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[topic](#topic) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:10](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L10) | |
| <a name="interfacesflatfileeventsrecordsdeletedeventmd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / [events](#modulesflatfileeventsmd) / RecordsDeletedEvent | |
| ## Interface: RecordsDeletedEvent | |
| [Flatfile](#modulesflatfilemd).[events](#modulesflatfileeventsmd).RecordsDeletedEvent | |
| ### Hierarchy | |
| - [`BaseEvent`](#interfacesflatfileeventsbaseeventmd) | |
| ↳ **`RecordsDeletedEvent`** | |
| ↳↳ [`RecordsDeleted`](#interfacesflatfileeventseventrecordsdeletedmd) | |
| ### Table of contents | |
| #### Properties | |
| - [acknowledgedAt](#acknowledgedat) | |
| - [acknowledgedBy](#acknowledgedby) | |
| - [attributes](#attributes) | |
| - [callbackUrl](#callbackurl) | |
| - [context](#context) | |
| - [createdAt](#createdat) | |
| - [dataUrl](#dataurl) | |
| - [deletedAt](#deletedat) | |
| - [domain](#domain) | |
| - [origin](#origin) | |
| - [payload](#payload) | |
| - [target](#target) | |
| - [topic](#topic) | |
| ### Properties | |
| #### acknowledgedAt | |
| • `Optional` **acknowledgedAt**: `string` | |
| Date the event was acknowledged | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[acknowledgedAt](#acknowledgedat) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:24](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L24) | |
| ___ | |
| #### acknowledgedBy | |
| • `Optional` **acknowledgedBy**: `string` | |
| The actor (user or system) who acknowledged the event | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[acknowledgedBy](#acknowledgedby) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:26](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L26) | |
| ___ | |
| #### attributes | |
| • `Optional` **attributes**: [`EventAttributes`](#interfacesflatfileeventseventattributesmd) | |
| The attributes of the event | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[attributes](#attributes) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:14](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L14) | |
| ___ | |
| #### callbackUrl | |
| • `Optional` **callbackUrl**: `string` | |
| The callback url to acknowledge the event | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[callbackUrl](#callbackurl) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:16](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L16) | |
| ___ | |
| #### context | |
| • **context**: [`Context`](#interfacesflatfileeventscontextmd) | |
| The context of the event | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[context](#context) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:12](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L12) | |
| ___ | |
| #### createdAt | |
| • **createdAt**: `Date` | |
| Date the event was created | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[createdAt](#createdat) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:20](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L20) | |
| ___ | |
| #### dataUrl | |
| • `Optional` **dataUrl**: `string` | |
| The url to retrieve the data associated with the event | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[dataUrl](#dataurl) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:18](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L18) | |
| ___ | |
| #### deletedAt | |
| • `Optional` **deletedAt**: `Date` | |
| Date the event was deleted | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[deletedAt](#deletedat) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:22](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L22) | |
| ___ | |
| #### domain | |
| • **domain**: [`Domain`](#domain-1) | |
| The domain of the event | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[domain](#domain) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:9](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L9) | |
| ___ | |
| #### origin | |
| • `Optional` **origin**: [`Origin`](#interfacesflatfileeventsoriginmd) | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[origin](#origin) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:28](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L28) | |
| ___ | |
| #### payload | |
| • **payload**: `Record`<`string`, `unknown`\> | |
| ##### Defined in | |
| [src/api/resources/events/types/RecordsDeletedEvent.ts:8](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/RecordsDeletedEvent.ts#L8) | |
| ___ | |
| #### target | |
| • `Optional` **target**: `string` | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[target](#target) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:27](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L27) | |
| ___ | |
| #### topic | |
| • **topic**: [`EventTopic`](#eventtopic-1) | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[topic](#topic) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:10](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L10) | |
| <a name="interfacesflatfileeventsrecordspayloadmd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / [events](#modulesflatfileeventsmd) / RecordsPayload | |
| ## Interface: RecordsPayload | |
| [Flatfile](#modulesflatfilemd).[events](#modulesflatfileeventsmd).RecordsPayload | |
| This file was auto-generated by Fern from our API Definition. | |
| ### Table of contents | |
| #### Properties | |
| - [count](#count) | |
| ### Properties | |
| #### count | |
| • **count**: `number` | |
| ##### Defined in | |
| [src/api/resources/events/types/RecordsPayload.ts:6](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/RecordsPayload.ts#L6) | |
| <a name="interfacesflatfileeventsrecordsupdatedeventmd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / [events](#modulesflatfileeventsmd) / RecordsUpdatedEvent | |
| ## Interface: RecordsUpdatedEvent | |
| [Flatfile](#modulesflatfilemd).[events](#modulesflatfileeventsmd).RecordsUpdatedEvent | |
| ### Hierarchy | |
| - [`BaseEvent`](#interfacesflatfileeventsbaseeventmd) | |
| ↳ **`RecordsUpdatedEvent`** | |
| ↳↳ [`RecordsUpdated`](#interfacesflatfileeventseventrecordsupdatedmd) | |
| ### Table of contents | |
| #### Properties | |
| - [acknowledgedAt](#acknowledgedat) | |
| - [acknowledgedBy](#acknowledgedby) | |
| - [attributes](#attributes) | |
| - [callbackUrl](#callbackurl) | |
| - [context](#context) | |
| - [createdAt](#createdat) | |
| - [dataUrl](#dataurl) | |
| - [deletedAt](#deletedat) | |
| - [domain](#domain) | |
| - [origin](#origin) | |
| - [payload](#payload) | |
| - [target](#target) | |
| - [topic](#topic) | |
| ### Properties | |
| #### acknowledgedAt | |
| • `Optional` **acknowledgedAt**: `string` | |
| Date the event was acknowledged | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[acknowledgedAt](#acknowledgedat) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:24](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L24) | |
| ___ | |
| #### acknowledgedBy | |
| • `Optional` **acknowledgedBy**: `string` | |
| The actor (user or system) who acknowledged the event | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[acknowledgedBy](#acknowledgedby) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:26](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L26) | |
| ___ | |
| #### attributes | |
| • `Optional` **attributes**: [`EventAttributes`](#interfacesflatfileeventseventattributesmd) | |
| The attributes of the event | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[attributes](#attributes) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:14](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L14) | |
| ___ | |
| #### callbackUrl | |
| • `Optional` **callbackUrl**: `string` | |
| The callback url to acknowledge the event | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[callbackUrl](#callbackurl) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:16](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L16) | |
| ___ | |
| #### context | |
| • **context**: [`Context`](#interfacesflatfileeventscontextmd) | |
| The context of the event | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[context](#context) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:12](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L12) | |
| ___ | |
| #### createdAt | |
| • **createdAt**: `Date` | |
| Date the event was created | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[createdAt](#createdat) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:20](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L20) | |
| ___ | |
| #### dataUrl | |
| • `Optional` **dataUrl**: `string` | |
| The url to retrieve the data associated with the event | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[dataUrl](#dataurl) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:18](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L18) | |
| ___ | |
| #### deletedAt | |
| • `Optional` **deletedAt**: `Date` | |
| Date the event was deleted | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[deletedAt](#deletedat) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:22](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L22) | |
| ___ | |
| #### domain | |
| • **domain**: [`Domain`](#domain-1) | |
| The domain of the event | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[domain](#domain) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:9](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L9) | |
| ___ | |
| #### origin | |
| • `Optional` **origin**: [`Origin`](#interfacesflatfileeventsoriginmd) | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[origin](#origin) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:28](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L28) | |
| ___ | |
| #### payload | |
| • **payload**: [`RecordsPayload`](#interfacesflatfileeventsrecordspayloadmd) | |
| ##### Defined in | |
| [src/api/resources/events/types/RecordsUpdatedEvent.ts:8](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/RecordsUpdatedEvent.ts#L8) | |
| ___ | |
| #### target | |
| • `Optional` **target**: `string` | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[target](#target) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:27](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L27) | |
| ___ | |
| #### topic | |
| • **topic**: [`EventTopic`](#eventtopic-1) | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[topic](#topic) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:10](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L10) | |
| <a name="interfacesflatfileeventssheetvalidatedeventmd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / [events](#modulesflatfileeventsmd) / SheetValidatedEvent | |
| ## Interface: SheetValidatedEvent | |
| [Flatfile](#modulesflatfilemd).[events](#modulesflatfileeventsmd).SheetValidatedEvent | |
| ### Hierarchy | |
| - [`BaseEvent`](#interfacesflatfileeventsbaseeventmd) | |
| ↳ **`SheetValidatedEvent`** | |
| ↳↳ [`SheetValidated`](#interfacesflatfileeventseventsheetvalidatedmd) | |
| ### Table of contents | |
| #### Properties | |
| - [acknowledgedAt](#acknowledgedat) | |
| - [acknowledgedBy](#acknowledgedby) | |
| - [attributes](#attributes) | |
| - [callbackUrl](#callbackurl) | |
| - [context](#context) | |
| - [createdAt](#createdat) | |
| - [dataUrl](#dataurl) | |
| - [deletedAt](#deletedat) | |
| - [domain](#domain) | |
| - [origin](#origin) | |
| - [payload](#payload) | |
| - [target](#target) | |
| - [topic](#topic) | |
| ### Properties | |
| #### acknowledgedAt | |
| • `Optional` **acknowledgedAt**: `string` | |
| Date the event was acknowledged | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[acknowledgedAt](#acknowledgedat) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:24](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L24) | |
| ___ | |
| #### acknowledgedBy | |
| • `Optional` **acknowledgedBy**: `string` | |
| The actor (user or system) who acknowledged the event | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[acknowledgedBy](#acknowledgedby) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:26](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L26) | |
| ___ | |
| #### attributes | |
| • `Optional` **attributes**: [`EventAttributes`](#interfacesflatfileeventseventattributesmd) | |
| The attributes of the event | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[attributes](#attributes) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:14](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L14) | |
| ___ | |
| #### callbackUrl | |
| • `Optional` **callbackUrl**: `string` | |
| The callback url to acknowledge the event | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[callbackUrl](#callbackurl) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:16](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L16) | |
| ___ | |
| #### context | |
| • **context**: [`Context`](#interfacesflatfileeventscontextmd) | |
| The context of the event | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[context](#context) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:12](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L12) | |
| ___ | |
| #### createdAt | |
| • **createdAt**: `Date` | |
| Date the event was created | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[createdAt](#createdat) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:20](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L20) | |
| ___ | |
| #### dataUrl | |
| • `Optional` **dataUrl**: `string` | |
| The url to retrieve the data associated with the event | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[dataUrl](#dataurl) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:18](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L18) | |
| ___ | |
| #### deletedAt | |
| • `Optional` **deletedAt**: `Date` | |
| Date the event was deleted | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[deletedAt](#deletedat) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:22](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L22) | |
| ___ | |
| #### domain | |
| • **domain**: [`Domain`](#domain-1) | |
| The domain of the event | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[domain](#domain) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:9](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L9) | |
| ___ | |
| #### origin | |
| • `Optional` **origin**: [`Origin`](#interfacesflatfileeventsoriginmd) | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[origin](#origin) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:28](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L28) | |
| ___ | |
| #### payload | |
| • **payload**: `Record`<`string`, `unknown`\> | |
| ##### Defined in | |
| [src/api/resources/events/types/SheetValidatedEvent.ts:8](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/SheetValidatedEvent.ts#L8) | |
| ___ | |
| #### target | |
| • `Optional` **target**: `string` | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[target](#target) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:27](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L27) | |
| ___ | |
| #### topic | |
| • **topic**: [`EventTopic`](#eventtopic-1) | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[topic](#topic) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:10](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L10) | |
| <a name="interfacesflatfileeventsspaceaddedeventmd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / [events](#modulesflatfileeventsmd) / SpaceAddedEvent | |
| ## Interface: SpaceAddedEvent | |
| [Flatfile](#modulesflatfilemd).[events](#modulesflatfileeventsmd).SpaceAddedEvent | |
| ### Hierarchy | |
| - [`BaseEvent`](#interfacesflatfileeventsbaseeventmd) | |
| ↳ **`SpaceAddedEvent`** | |
| ↳↳ [`SpaceAdded`](#interfacesflatfileeventseventspaceaddedmd) | |
| ### Table of contents | |
| #### Properties | |
| - [acknowledgedAt](#acknowledgedat) | |
| - [acknowledgedBy](#acknowledgedby) | |
| - [attributes](#attributes) | |
| - [callbackUrl](#callbackurl) | |
| - [context](#context) | |
| - [createdAt](#createdat) | |
| - [dataUrl](#dataurl) | |
| - [deletedAt](#deletedat) | |
| - [domain](#domain) | |
| - [origin](#origin) | |
| - [payload](#payload) | |
| - [target](#target) | |
| - [topic](#topic) | |
| ### Properties | |
| #### acknowledgedAt | |
| • `Optional` **acknowledgedAt**: `string` | |
| Date the event was acknowledged | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[acknowledgedAt](#acknowledgedat) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:24](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L24) | |
| ___ | |
| #### acknowledgedBy | |
| • `Optional` **acknowledgedBy**: `string` | |
| The actor (user or system) who acknowledged the event | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[acknowledgedBy](#acknowledgedby) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:26](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L26) | |
| ___ | |
| #### attributes | |
| • `Optional` **attributes**: [`EventAttributes`](#interfacesflatfileeventseventattributesmd) | |
| The attributes of the event | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[attributes](#attributes) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:14](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L14) | |
| ___ | |
| #### callbackUrl | |
| • `Optional` **callbackUrl**: `string` | |
| The callback url to acknowledge the event | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[callbackUrl](#callbackurl) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:16](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L16) | |
| ___ | |
| #### context | |
| • **context**: [`Context`](#interfacesflatfileeventscontextmd) | |
| The context of the event | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[context](#context) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:12](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L12) | |
| ___ | |
| #### createdAt | |
| • **createdAt**: `Date` | |
| Date the event was created | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[createdAt](#createdat) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:20](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L20) | |
| ___ | |
| #### dataUrl | |
| • `Optional` **dataUrl**: `string` | |
| The url to retrieve the data associated with the event | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[dataUrl](#dataurl) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:18](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L18) | |
| ___ | |
| #### deletedAt | |
| • `Optional` **deletedAt**: `Date` | |
| Date the event was deleted | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[deletedAt](#deletedat) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:22](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L22) | |
| ___ | |
| #### domain | |
| • **domain**: [`Domain`](#domain-1) | |
| The domain of the event | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[domain](#domain) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:9](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L9) | |
| ___ | |
| #### origin | |
| • `Optional` **origin**: [`Origin`](#interfacesflatfileeventsoriginmd) | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[origin](#origin) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:28](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L28) | |
| ___ | |
| #### payload | |
| • **payload**: `Record`<`string`, `unknown`\> | |
| ##### Defined in | |
| [src/api/resources/events/types/SpaceAddedEvent.ts:8](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/SpaceAddedEvent.ts#L8) | |
| ___ | |
| #### target | |
| • `Optional` **target**: `string` | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[target](#target) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:27](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L27) | |
| ___ | |
| #### topic | |
| • **topic**: [`EventTopic`](#eventtopic-1) | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[topic](#topic) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:10](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L10) | |
| <a name="interfacesflatfileeventsspaceremovedeventmd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / [events](#modulesflatfileeventsmd) / SpaceRemovedEvent | |
| ## Interface: SpaceRemovedEvent | |
| [Flatfile](#modulesflatfilemd).[events](#modulesflatfileeventsmd).SpaceRemovedEvent | |
| ### Hierarchy | |
| - [`BaseEvent`](#interfacesflatfileeventsbaseeventmd) | |
| ↳ **`SpaceRemovedEvent`** | |
| ↳↳ [`SpaceRemoved`](#interfacesflatfileeventseventspaceremovedmd) | |
| ### Table of contents | |
| #### Properties | |
| - [acknowledgedAt](#acknowledgedat) | |
| - [acknowledgedBy](#acknowledgedby) | |
| - [attributes](#attributes) | |
| - [callbackUrl](#callbackurl) | |
| - [context](#context) | |
| - [createdAt](#createdat) | |
| - [dataUrl](#dataurl) | |
| - [deletedAt](#deletedat) | |
| - [domain](#domain) | |
| - [origin](#origin) | |
| - [payload](#payload) | |
| - [target](#target) | |
| - [topic](#topic) | |
| ### Properties | |
| #### acknowledgedAt | |
| • `Optional` **acknowledgedAt**: `string` | |
| Date the event was acknowledged | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[acknowledgedAt](#acknowledgedat) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:24](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L24) | |
| ___ | |
| #### acknowledgedBy | |
| • `Optional` **acknowledgedBy**: `string` | |
| The actor (user or system) who acknowledged the event | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[acknowledgedBy](#acknowledgedby) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:26](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L26) | |
| ___ | |
| #### attributes | |
| • `Optional` **attributes**: [`EventAttributes`](#interfacesflatfileeventseventattributesmd) | |
| The attributes of the event | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[attributes](#attributes) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:14](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L14) | |
| ___ | |
| #### callbackUrl | |
| • `Optional` **callbackUrl**: `string` | |
| The callback url to acknowledge the event | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[callbackUrl](#callbackurl) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:16](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L16) | |
| ___ | |
| #### context | |
| • **context**: [`Context`](#interfacesflatfileeventscontextmd) | |
| The context of the event | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[context](#context) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:12](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L12) | |
| ___ | |
| #### createdAt | |
| • **createdAt**: `Date` | |
| Date the event was created | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[createdAt](#createdat) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:20](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L20) | |
| ___ | |
| #### dataUrl | |
| • `Optional` **dataUrl**: `string` | |
| The url to retrieve the data associated with the event | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[dataUrl](#dataurl) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:18](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L18) | |
| ___ | |
| #### deletedAt | |
| • `Optional` **deletedAt**: `Date` | |
| Date the event was deleted | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[deletedAt](#deletedat) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:22](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L22) | |
| ___ | |
| #### domain | |
| • **domain**: [`Domain`](#domain-1) | |
| The domain of the event | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[domain](#domain) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:9](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L9) | |
| ___ | |
| #### origin | |
| • `Optional` **origin**: [`Origin`](#interfacesflatfileeventsoriginmd) | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[origin](#origin) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:28](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L28) | |
| ___ | |
| #### payload | |
| • **payload**: `Record`<`string`, `unknown`\> | |
| ##### Defined in | |
| [src/api/resources/events/types/SpaceRemovedEvent.ts:8](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/SpaceRemovedEvent.ts#L8) | |
| ___ | |
| #### target | |
| • `Optional` **target**: `string` | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[target](#target) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:27](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L27) | |
| ___ | |
| #### topic | |
| • **topic**: [`EventTopic`](#eventtopic-1) | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[topic](#topic) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:10](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L10) | |
| <a name="interfacesflatfileeventsuploadcompletedeventmd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / [events](#modulesflatfileeventsmd) / UploadCompletedEvent | |
| ## Interface: UploadCompletedEvent | |
| [Flatfile](#modulesflatfilemd).[events](#modulesflatfileeventsmd).UploadCompletedEvent | |
| ### Hierarchy | |
| - [`BaseEvent`](#interfacesflatfileeventsbaseeventmd) | |
| ↳ **`UploadCompletedEvent`** | |
| ↳↳ [`UploadCompleted`](#interfacesflatfileeventseventuploadcompletedmd) | |
| ### Table of contents | |
| #### Properties | |
| - [acknowledgedAt](#acknowledgedat) | |
| - [acknowledgedBy](#acknowledgedby) | |
| - [attributes](#attributes) | |
| - [callbackUrl](#callbackurl) | |
| - [context](#context) | |
| - [createdAt](#createdat) | |
| - [dataUrl](#dataurl) | |
| - [deletedAt](#deletedat) | |
| - [domain](#domain) | |
| - [origin](#origin) | |
| - [payload](#payload) | |
| - [target](#target) | |
| - [topic](#topic) | |
| ### Properties | |
| #### acknowledgedAt | |
| • `Optional` **acknowledgedAt**: `string` | |
| Date the event was acknowledged | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[acknowledgedAt](#acknowledgedat) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:24](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L24) | |
| ___ | |
| #### acknowledgedBy | |
| • `Optional` **acknowledgedBy**: `string` | |
| The actor (user or system) who acknowledged the event | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[acknowledgedBy](#acknowledgedby) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:26](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L26) | |
| ___ | |
| #### attributes | |
| • `Optional` **attributes**: [`EventAttributes`](#interfacesflatfileeventseventattributesmd) | |
| The attributes of the event | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[attributes](#attributes) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:14](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L14) | |
| ___ | |
| #### callbackUrl | |
| • `Optional` **callbackUrl**: `string` | |
| The callback url to acknowledge the event | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[callbackUrl](#callbackurl) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:16](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L16) | |
| ___ | |
| #### context | |
| • **context**: [`Context`](#interfacesflatfileeventscontextmd) | |
| The context of the event | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[context](#context) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:12](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L12) | |
| ___ | |
| #### createdAt | |
| • **createdAt**: `Date` | |
| Date the event was created | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[createdAt](#createdat) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:20](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L20) | |
| ___ | |
| #### dataUrl | |
| • `Optional` **dataUrl**: `string` | |
| The url to retrieve the data associated with the event | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[dataUrl](#dataurl) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:18](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L18) | |
| ___ | |
| #### deletedAt | |
| • `Optional` **deletedAt**: `Date` | |
| Date the event was deleted | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[deletedAt](#deletedat) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:22](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L22) | |
| ___ | |
| #### domain | |
| • **domain**: [`Domain`](#domain-1) | |
| The domain of the event | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[domain](#domain) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:9](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L9) | |
| ___ | |
| #### origin | |
| • `Optional` **origin**: [`Origin`](#interfacesflatfileeventsoriginmd) | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[origin](#origin) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:28](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L28) | |
| ___ | |
| #### payload | |
| • **payload**: `Record`<`string`, `unknown`\> | |
| ##### Defined in | |
| [src/api/resources/events/types/UploadCompletedEvent.ts:8](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/UploadCompletedEvent.ts#L8) | |
| ___ | |
| #### target | |
| • `Optional` **target**: `string` | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[target](#target) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:27](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L27) | |
| ___ | |
| #### topic | |
| • **topic**: [`EventTopic`](#eventtopic-1) | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[topic](#topic) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:10](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L10) | |
| <a name="interfacesflatfileeventsuploadfailedeventmd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / [events](#modulesflatfileeventsmd) / UploadFailedEvent | |
| ## Interface: UploadFailedEvent | |
| [Flatfile](#modulesflatfilemd).[events](#modulesflatfileeventsmd).UploadFailedEvent | |
| ### Hierarchy | |
| - [`BaseEvent`](#interfacesflatfileeventsbaseeventmd) | |
| ↳ **`UploadFailedEvent`** | |
| ↳↳ [`UploadFailed`](#interfacesflatfileeventseventuploadfailedmd) | |
| ### Table of contents | |
| #### Properties | |
| - [acknowledgedAt](#acknowledgedat) | |
| - [acknowledgedBy](#acknowledgedby) | |
| - [attributes](#attributes) | |
| - [callbackUrl](#callbackurl) | |
| - [context](#context) | |
| - [createdAt](#createdat) | |
| - [dataUrl](#dataurl) | |
| - [deletedAt](#deletedat) | |
| - [domain](#domain) | |
| - [origin](#origin) | |
| - [payload](#payload) | |
| - [target](#target) | |
| - [topic](#topic) | |
| ### Properties | |
| #### acknowledgedAt | |
| • `Optional` **acknowledgedAt**: `string` | |
| Date the event was acknowledged | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[acknowledgedAt](#acknowledgedat) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:24](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L24) | |
| ___ | |
| #### acknowledgedBy | |
| • `Optional` **acknowledgedBy**: `string` | |
| The actor (user or system) who acknowledged the event | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[acknowledgedBy](#acknowledgedby) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:26](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L26) | |
| ___ | |
| #### attributes | |
| • `Optional` **attributes**: [`EventAttributes`](#interfacesflatfileeventseventattributesmd) | |
| The attributes of the event | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[attributes](#attributes) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:14](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L14) | |
| ___ | |
| #### callbackUrl | |
| • `Optional` **callbackUrl**: `string` | |
| The callback url to acknowledge the event | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[callbackUrl](#callbackurl) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:16](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L16) | |
| ___ | |
| #### context | |
| • **context**: [`Context`](#interfacesflatfileeventscontextmd) | |
| The context of the event | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[context](#context) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:12](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L12) | |
| ___ | |
| #### createdAt | |
| • **createdAt**: `Date` | |
| Date the event was created | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[createdAt](#createdat) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:20](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L20) | |
| ___ | |
| #### dataUrl | |
| • `Optional` **dataUrl**: `string` | |
| The url to retrieve the data associated with the event | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[dataUrl](#dataurl) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:18](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L18) | |
| ___ | |
| #### deletedAt | |
| • `Optional` **deletedAt**: `Date` | |
| Date the event was deleted | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[deletedAt](#deletedat) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:22](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L22) | |
| ___ | |
| #### domain | |
| • **domain**: [`Domain`](#domain-1) | |
| The domain of the event | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[domain](#domain) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:9](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L9) | |
| ___ | |
| #### origin | |
| • `Optional` **origin**: [`Origin`](#interfacesflatfileeventsoriginmd) | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[origin](#origin) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:28](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L28) | |
| ___ | |
| #### payload | |
| • **payload**: `Record`<`string`, `unknown`\> | |
| ##### Defined in | |
| [src/api/resources/events/types/UploadFailedEvent.ts:8](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/UploadFailedEvent.ts#L8) | |
| ___ | |
| #### target | |
| • `Optional` **target**: `string` | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[target](#target) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:27](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L27) | |
| ___ | |
| #### topic | |
| • **topic**: [`EventTopic`](#eventtopic-1) | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[topic](#topic) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:10](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L10) | |
| <a name="interfacesflatfileeventsuploadstartedeventmd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / [events](#modulesflatfileeventsmd) / UploadStartedEvent | |
| ## Interface: UploadStartedEvent | |
| [Flatfile](#modulesflatfilemd).[events](#modulesflatfileeventsmd).UploadStartedEvent | |
| ### Hierarchy | |
| - [`BaseEvent`](#interfacesflatfileeventsbaseeventmd) | |
| ↳ **`UploadStartedEvent`** | |
| ↳↳ [`UploadStarted`](#interfacesflatfileeventseventuploadstartedmd) | |
| ### Table of contents | |
| #### Properties | |
| - [acknowledgedAt](#acknowledgedat) | |
| - [acknowledgedBy](#acknowledgedby) | |
| - [attributes](#attributes) | |
| - [callbackUrl](#callbackurl) | |
| - [context](#context) | |
| - [createdAt](#createdat) | |
| - [dataUrl](#dataurl) | |
| - [deletedAt](#deletedat) | |
| - [domain](#domain) | |
| - [origin](#origin) | |
| - [payload](#payload) | |
| - [target](#target) | |
| - [topic](#topic) | |
| ### Properties | |
| #### acknowledgedAt | |
| • `Optional` **acknowledgedAt**: `string` | |
| Date the event was acknowledged | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[acknowledgedAt](#acknowledgedat) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:24](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L24) | |
| ___ | |
| #### acknowledgedBy | |
| • `Optional` **acknowledgedBy**: `string` | |
| The actor (user or system) who acknowledged the event | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[acknowledgedBy](#acknowledgedby) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:26](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L26) | |
| ___ | |
| #### attributes | |
| • `Optional` **attributes**: [`EventAttributes`](#interfacesflatfileeventseventattributesmd) | |
| The attributes of the event | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[attributes](#attributes) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:14](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L14) | |
| ___ | |
| #### callbackUrl | |
| • `Optional` **callbackUrl**: `string` | |
| The callback url to acknowledge the event | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[callbackUrl](#callbackurl) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:16](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L16) | |
| ___ | |
| #### context | |
| • **context**: [`Context`](#interfacesflatfileeventscontextmd) | |
| The context of the event | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[context](#context) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:12](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L12) | |
| ___ | |
| #### createdAt | |
| • **createdAt**: `Date` | |
| Date the event was created | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[createdAt](#createdat) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:20](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L20) | |
| ___ | |
| #### dataUrl | |
| • `Optional` **dataUrl**: `string` | |
| The url to retrieve the data associated with the event | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[dataUrl](#dataurl) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:18](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L18) | |
| ___ | |
| #### deletedAt | |
| • `Optional` **deletedAt**: `Date` | |
| Date the event was deleted | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[deletedAt](#deletedat) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:22](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L22) | |
| ___ | |
| #### domain | |
| • **domain**: [`Domain`](#domain-1) | |
| The domain of the event | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[domain](#domain) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:9](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L9) | |
| ___ | |
| #### origin | |
| • `Optional` **origin**: [`Origin`](#interfacesflatfileeventsoriginmd) | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[origin](#origin) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:28](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L28) | |
| ___ | |
| #### payload | |
| • **payload**: `Record`<`string`, `unknown`\> | |
| ##### Defined in | |
| [src/api/resources/events/types/UploadStartedEvent.ts:8](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/UploadStartedEvent.ts#L8) | |
| ___ | |
| #### target | |
| • `Optional` **target**: `string` | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[target](#target) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:27](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L27) | |
| ___ | |
| #### topic | |
| • **topic**: [`EventTopic`](#eventtopic-1) | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[topic](#topic) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:10](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L10) | |
| <a name="interfacesflatfileeventsuseraddedeventmd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / [events](#modulesflatfileeventsmd) / UserAddedEvent | |
| ## Interface: UserAddedEvent | |
| [Flatfile](#modulesflatfilemd).[events](#modulesflatfileeventsmd).UserAddedEvent | |
| ### Hierarchy | |
| - [`BaseEvent`](#interfacesflatfileeventsbaseeventmd) | |
| ↳ **`UserAddedEvent`** | |
| ↳↳ [`UserAdded`](#interfacesflatfileeventseventuseraddedmd) | |
| ### Table of contents | |
| #### Properties | |
| - [acknowledgedAt](#acknowledgedat) | |
| - [acknowledgedBy](#acknowledgedby) | |
| - [attributes](#attributes) | |
| - [callbackUrl](#callbackurl) | |
| - [context](#context) | |
| - [createdAt](#createdat) | |
| - [dataUrl](#dataurl) | |
| - [deletedAt](#deletedat) | |
| - [domain](#domain) | |
| - [origin](#origin) | |
| - [payload](#payload) | |
| - [target](#target) | |
| - [topic](#topic) | |
| ### Properties | |
| #### acknowledgedAt | |
| • `Optional` **acknowledgedAt**: `string` | |
| Date the event was acknowledged | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[acknowledgedAt](#acknowledgedat) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:24](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L24) | |
| ___ | |
| #### acknowledgedBy | |
| • `Optional` **acknowledgedBy**: `string` | |
| The actor (user or system) who acknowledged the event | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[acknowledgedBy](#acknowledgedby) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:26](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L26) | |
| ___ | |
| #### attributes | |
| • `Optional` **attributes**: [`EventAttributes`](#interfacesflatfileeventseventattributesmd) | |
| The attributes of the event | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[attributes](#attributes) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:14](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L14) | |
| ___ | |
| #### callbackUrl | |
| • `Optional` **callbackUrl**: `string` | |
| The callback url to acknowledge the event | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[callbackUrl](#callbackurl) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:16](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L16) | |
| ___ | |
| #### context | |
| • **context**: [`Context`](#interfacesflatfileeventscontextmd) | |
| The context of the event | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[context](#context) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:12](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L12) | |
| ___ | |
| #### createdAt | |
| • **createdAt**: `Date` | |
| Date the event was created | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[createdAt](#createdat) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:20](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L20) | |
| ___ | |
| #### dataUrl | |
| • `Optional` **dataUrl**: `string` | |
| The url to retrieve the data associated with the event | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[dataUrl](#dataurl) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:18](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L18) | |
| ___ | |
| #### deletedAt | |
| • `Optional` **deletedAt**: `Date` | |
| Date the event was deleted | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[deletedAt](#deletedat) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:22](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L22) | |
| ___ | |
| #### domain | |
| • **domain**: [`Domain`](#domain-1) | |
| The domain of the event | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[domain](#domain) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:9](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L9) | |
| ___ | |
| #### origin | |
| • `Optional` **origin**: [`Origin`](#interfacesflatfileeventsoriginmd) | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[origin](#origin) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:28](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L28) | |
| ___ | |
| #### payload | |
| • **payload**: `Record`<`string`, `unknown`\> | |
| ##### Defined in | |
| [src/api/resources/events/types/UserAddedEvent.ts:8](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/UserAddedEvent.ts#L8) | |
| ___ | |
| #### target | |
| • `Optional` **target**: `string` | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[target](#target) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:27](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L27) | |
| ___ | |
| #### topic | |
| • **topic**: [`EventTopic`](#eventtopic-1) | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[topic](#topic) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:10](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L10) | |
| <a name="interfacesflatfileeventsuserofflineeventmd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / [events](#modulesflatfileeventsmd) / UserOfflineEvent | |
| ## Interface: UserOfflineEvent | |
| [Flatfile](#modulesflatfilemd).[events](#modulesflatfileeventsmd).UserOfflineEvent | |
| ### Hierarchy | |
| - [`BaseEvent`](#interfacesflatfileeventsbaseeventmd) | |
| ↳ **`UserOfflineEvent`** | |
| ↳↳ [`UserOffline`](#interfacesflatfileeventseventuserofflinemd) | |
| ### Table of contents | |
| #### Properties | |
| - [acknowledgedAt](#acknowledgedat) | |
| - [acknowledgedBy](#acknowledgedby) | |
| - [attributes](#attributes) | |
| - [callbackUrl](#callbackurl) | |
| - [context](#context) | |
| - [createdAt](#createdat) | |
| - [dataUrl](#dataurl) | |
| - [deletedAt](#deletedat) | |
| - [domain](#domain) | |
| - [origin](#origin) | |
| - [payload](#payload) | |
| - [target](#target) | |
| - [topic](#topic) | |
| ### Properties | |
| #### acknowledgedAt | |
| • `Optional` **acknowledgedAt**: `string` | |
| Date the event was acknowledged | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[acknowledgedAt](#acknowledgedat) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:24](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L24) | |
| ___ | |
| #### acknowledgedBy | |
| • `Optional` **acknowledgedBy**: `string` | |
| The actor (user or system) who acknowledged the event | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[acknowledgedBy](#acknowledgedby) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:26](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L26) | |
| ___ | |
| #### attributes | |
| • `Optional` **attributes**: [`EventAttributes`](#interfacesflatfileeventseventattributesmd) | |
| The attributes of the event | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[attributes](#attributes) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:14](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L14) | |
| ___ | |
| #### callbackUrl | |
| • `Optional` **callbackUrl**: `string` | |
| The callback url to acknowledge the event | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[callbackUrl](#callbackurl) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:16](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L16) | |
| ___ | |
| #### context | |
| • **context**: [`Context`](#interfacesflatfileeventscontextmd) | |
| The context of the event | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[context](#context) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:12](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L12) | |
| ___ | |
| #### createdAt | |
| • **createdAt**: `Date` | |
| Date the event was created | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[createdAt](#createdat) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:20](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L20) | |
| ___ | |
| #### dataUrl | |
| • `Optional` **dataUrl**: `string` | |
| The url to retrieve the data associated with the event | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[dataUrl](#dataurl) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:18](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L18) | |
| ___ | |
| #### deletedAt | |
| • `Optional` **deletedAt**: `Date` | |
| Date the event was deleted | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[deletedAt](#deletedat) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:22](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L22) | |
| ___ | |
| #### domain | |
| • **domain**: [`Domain`](#domain-1) | |
| The domain of the event | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[domain](#domain) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:9](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L9) | |
| ___ | |
| #### origin | |
| • `Optional` **origin**: [`Origin`](#interfacesflatfileeventsoriginmd) | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[origin](#origin) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:28](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L28) | |
| ___ | |
| #### payload | |
| • **payload**: `Record`<`string`, `unknown`\> | |
| ##### Defined in | |
| [src/api/resources/events/types/UserOfflineEvent.ts:8](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/UserOfflineEvent.ts#L8) | |
| ___ | |
| #### target | |
| • `Optional` **target**: `string` | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[target](#target) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:27](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L27) | |
| ___ | |
| #### topic | |
| • **topic**: [`EventTopic`](#eventtopic-1) | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[topic](#topic) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:10](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L10) | |
| <a name="interfacesflatfileeventsuseronlineeventmd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / [events](#modulesflatfileeventsmd) / UserOnlineEvent | |
| ## Interface: UserOnlineEvent | |
| [Flatfile](#modulesflatfilemd).[events](#modulesflatfileeventsmd).UserOnlineEvent | |
| ### Hierarchy | |
| - [`BaseEvent`](#interfacesflatfileeventsbaseeventmd) | |
| ↳ **`UserOnlineEvent`** | |
| ↳↳ [`UserOnline`](#interfacesflatfileeventseventuseronlinemd) | |
| ### Table of contents | |
| #### Properties | |
| - [acknowledgedAt](#acknowledgedat) | |
| - [acknowledgedBy](#acknowledgedby) | |
| - [attributes](#attributes) | |
| - [callbackUrl](#callbackurl) | |
| - [context](#context) | |
| - [createdAt](#createdat) | |
| - [dataUrl](#dataurl) | |
| - [deletedAt](#deletedat) | |
| - [domain](#domain) | |
| - [origin](#origin) | |
| - [payload](#payload) | |
| - [target](#target) | |
| - [topic](#topic) | |
| ### Properties | |
| #### acknowledgedAt | |
| • `Optional` **acknowledgedAt**: `string` | |
| Date the event was acknowledged | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[acknowledgedAt](#acknowledgedat) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:24](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L24) | |
| ___ | |
| #### acknowledgedBy | |
| • `Optional` **acknowledgedBy**: `string` | |
| The actor (user or system) who acknowledged the event | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[acknowledgedBy](#acknowledgedby) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:26](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L26) | |
| ___ | |
| #### attributes | |
| • `Optional` **attributes**: [`EventAttributes`](#interfacesflatfileeventseventattributesmd) | |
| The attributes of the event | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[attributes](#attributes) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:14](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L14) | |
| ___ | |
| #### callbackUrl | |
| • `Optional` **callbackUrl**: `string` | |
| The callback url to acknowledge the event | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[callbackUrl](#callbackurl) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:16](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L16) | |
| ___ | |
| #### context | |
| • **context**: [`Context`](#interfacesflatfileeventscontextmd) | |
| The context of the event | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[context](#context) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:12](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L12) | |
| ___ | |
| #### createdAt | |
| • **createdAt**: `Date` | |
| Date the event was created | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[createdAt](#createdat) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:20](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L20) | |
| ___ | |
| #### dataUrl | |
| • `Optional` **dataUrl**: `string` | |
| The url to retrieve the data associated with the event | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[dataUrl](#dataurl) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:18](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L18) | |
| ___ | |
| #### deletedAt | |
| • `Optional` **deletedAt**: `Date` | |
| Date the event was deleted | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[deletedAt](#deletedat) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:22](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L22) | |
| ___ | |
| #### domain | |
| • **domain**: [`Domain`](#domain-1) | |
| The domain of the event | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[domain](#domain) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:9](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L9) | |
| ___ | |
| #### origin | |
| • `Optional` **origin**: [`Origin`](#interfacesflatfileeventsoriginmd) | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[origin](#origin) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:28](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L28) | |
| ___ | |
| #### payload | |
| • **payload**: `Record`<`string`, `unknown`\> | |
| ##### Defined in | |
| [src/api/resources/events/types/UserOnlineEvent.ts:8](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/UserOnlineEvent.ts#L8) | |
| ___ | |
| #### target | |
| • `Optional` **target**: `string` | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[target](#target) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:27](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L27) | |
| ___ | |
| #### topic | |
| • **topic**: [`EventTopic`](#eventtopic-1) | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[topic](#topic) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:10](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L10) | |
| <a name="interfacesflatfileeventsuserremovedeventmd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / [events](#modulesflatfileeventsmd) / UserRemovedEvent | |
| ## Interface: UserRemovedEvent | |
| [Flatfile](#modulesflatfilemd).[events](#modulesflatfileeventsmd).UserRemovedEvent | |
| ### Hierarchy | |
| - [`BaseEvent`](#interfacesflatfileeventsbaseeventmd) | |
| ↳ **`UserRemovedEvent`** | |
| ↳↳ [`UserRemoved`](#interfacesflatfileeventseventuserremovedmd) | |
| ### Table of contents | |
| #### Properties | |
| - [acknowledgedAt](#acknowledgedat) | |
| - [acknowledgedBy](#acknowledgedby) | |
| - [attributes](#attributes) | |
| - [callbackUrl](#callbackurl) | |
| - [context](#context) | |
| - [createdAt](#createdat) | |
| - [dataUrl](#dataurl) | |
| - [deletedAt](#deletedat) | |
| - [domain](#domain) | |
| - [origin](#origin) | |
| - [payload](#payload) | |
| - [target](#target) | |
| - [topic](#topic) | |
| ### Properties | |
| #### acknowledgedAt | |
| • `Optional` **acknowledgedAt**: `string` | |
| Date the event was acknowledged | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[acknowledgedAt](#acknowledgedat) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:24](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L24) | |
| ___ | |
| #### acknowledgedBy | |
| • `Optional` **acknowledgedBy**: `string` | |
| The actor (user or system) who acknowledged the event | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[acknowledgedBy](#acknowledgedby) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:26](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L26) | |
| ___ | |
| #### attributes | |
| • `Optional` **attributes**: [`EventAttributes`](#interfacesflatfileeventseventattributesmd) | |
| The attributes of the event | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[attributes](#attributes) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:14](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L14) | |
| ___ | |
| #### callbackUrl | |
| • `Optional` **callbackUrl**: `string` | |
| The callback url to acknowledge the event | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[callbackUrl](#callbackurl) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:16](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L16) | |
| ___ | |
| #### context | |
| • **context**: [`Context`](#interfacesflatfileeventscontextmd) | |
| The context of the event | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[context](#context) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:12](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L12) | |
| ___ | |
| #### createdAt | |
| • **createdAt**: `Date` | |
| Date the event was created | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[createdAt](#createdat) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:20](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L20) | |
| ___ | |
| #### dataUrl | |
| • `Optional` **dataUrl**: `string` | |
| The url to retrieve the data associated with the event | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[dataUrl](#dataurl) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:18](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L18) | |
| ___ | |
| #### deletedAt | |
| • `Optional` **deletedAt**: `Date` | |
| Date the event was deleted | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[deletedAt](#deletedat) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:22](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L22) | |
| ___ | |
| #### domain | |
| • **domain**: [`Domain`](#domain-1) | |
| The domain of the event | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[domain](#domain) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:9](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L9) | |
| ___ | |
| #### origin | |
| • `Optional` **origin**: [`Origin`](#interfacesflatfileeventsoriginmd) | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[origin](#origin) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:28](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L28) | |
| ___ | |
| #### payload | |
| • **payload**: `Record`<`string`, `unknown`\> | |
| ##### Defined in | |
| [src/api/resources/events/types/UserRemovedEvent.ts:8](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/UserRemovedEvent.ts#L8) | |
| ___ | |
| #### target | |
| • `Optional` **target**: `string` | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[target](#target) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:27](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L27) | |
| ___ | |
| #### topic | |
| • **topic**: [`EventTopic`](#eventtopic-1) | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[topic](#topic) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:10](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L10) | |
| <a name="interfacesflatfileeventsworkbookaddedeventmd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / [events](#modulesflatfileeventsmd) / WorkbookAddedEvent | |
| ## Interface: WorkbookAddedEvent | |
| [Flatfile](#modulesflatfilemd).[events](#modulesflatfileeventsmd).WorkbookAddedEvent | |
| ### Hierarchy | |
| - [`BaseEvent`](#interfacesflatfileeventsbaseeventmd) | |
| ↳ **`WorkbookAddedEvent`** | |
| ↳↳ [`WorkbookAdded`](#interfacesflatfileeventseventworkbookaddedmd) | |
| ### Table of contents | |
| #### Properties | |
| - [acknowledgedAt](#acknowledgedat) | |
| - [acknowledgedBy](#acknowledgedby) | |
| - [attributes](#attributes) | |
| - [callbackUrl](#callbackurl) | |
| - [context](#context) | |
| - [createdAt](#createdat) | |
| - [dataUrl](#dataurl) | |
| - [deletedAt](#deletedat) | |
| - [domain](#domain) | |
| - [origin](#origin) | |
| - [payload](#payload) | |
| - [target](#target) | |
| - [topic](#topic) | |
| ### Properties | |
| #### acknowledgedAt | |
| • `Optional` **acknowledgedAt**: `string` | |
| Date the event was acknowledged | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[acknowledgedAt](#acknowledgedat) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:24](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L24) | |
| ___ | |
| #### acknowledgedBy | |
| • `Optional` **acknowledgedBy**: `string` | |
| The actor (user or system) who acknowledged the event | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[acknowledgedBy](#acknowledgedby) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:26](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L26) | |
| ___ | |
| #### attributes | |
| • `Optional` **attributes**: [`EventAttributes`](#interfacesflatfileeventseventattributesmd) | |
| The attributes of the event | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[attributes](#attributes) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:14](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L14) | |
| ___ | |
| #### callbackUrl | |
| • `Optional` **callbackUrl**: `string` | |
| The callback url to acknowledge the event | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[callbackUrl](#callbackurl) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:16](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L16) | |
| ___ | |
| #### context | |
| • **context**: [`Context`](#interfacesflatfileeventscontextmd) | |
| The context of the event | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[context](#context) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:12](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L12) | |
| ___ | |
| #### createdAt | |
| • **createdAt**: `Date` | |
| Date the event was created | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[createdAt](#createdat) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:20](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L20) | |
| ___ | |
| #### dataUrl | |
| • `Optional` **dataUrl**: `string` | |
| The url to retrieve the data associated with the event | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[dataUrl](#dataurl) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:18](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L18) | |
| ___ | |
| #### deletedAt | |
| • `Optional` **deletedAt**: `Date` | |
| Date the event was deleted | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[deletedAt](#deletedat) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:22](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L22) | |
| ___ | |
| #### domain | |
| • **domain**: [`Domain`](#domain-1) | |
| The domain of the event | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[domain](#domain) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:9](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L9) | |
| ___ | |
| #### origin | |
| • `Optional` **origin**: [`Origin`](#interfacesflatfileeventsoriginmd) | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[origin](#origin) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:28](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L28) | |
| ___ | |
| #### payload | |
| • **payload**: `Record`<`string`, `unknown`\> | |
| ##### Defined in | |
| [src/api/resources/events/types/WorkbookAddedEvent.ts:8](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/WorkbookAddedEvent.ts#L8) | |
| ___ | |
| #### target | |
| • `Optional` **target**: `string` | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[target](#target) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:27](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L27) | |
| ___ | |
| #### topic | |
| • **topic**: [`EventTopic`](#eventtopic-1) | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[topic](#topic) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:10](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L10) | |
| <a name="interfacesflatfileeventsworkbookremovedeventmd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / [events](#modulesflatfileeventsmd) / WorkbookRemovedEvent | |
| ## Interface: WorkbookRemovedEvent | |
| [Flatfile](#modulesflatfilemd).[events](#modulesflatfileeventsmd).WorkbookRemovedEvent | |
| ### Hierarchy | |
| - [`BaseEvent`](#interfacesflatfileeventsbaseeventmd) | |
| ↳ **`WorkbookRemovedEvent`** | |
| ↳↳ [`WorkbookRemoved`](#interfacesflatfileeventseventworkbookremovedmd) | |
| ### Table of contents | |
| #### Properties | |
| - [acknowledgedAt](#acknowledgedat) | |
| - [acknowledgedBy](#acknowledgedby) | |
| - [attributes](#attributes) | |
| - [callbackUrl](#callbackurl) | |
| - [context](#context) | |
| - [createdAt](#createdat) | |
| - [dataUrl](#dataurl) | |
| - [deletedAt](#deletedat) | |
| - [domain](#domain) | |
| - [origin](#origin) | |
| - [payload](#payload) | |
| - [target](#target) | |
| - [topic](#topic) | |
| ### Properties | |
| #### acknowledgedAt | |
| • `Optional` **acknowledgedAt**: `string` | |
| Date the event was acknowledged | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[acknowledgedAt](#acknowledgedat) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:24](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L24) | |
| ___ | |
| #### acknowledgedBy | |
| • `Optional` **acknowledgedBy**: `string` | |
| The actor (user or system) who acknowledged the event | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[acknowledgedBy](#acknowledgedby) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:26](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L26) | |
| ___ | |
| #### attributes | |
| • `Optional` **attributes**: [`EventAttributes`](#interfacesflatfileeventseventattributesmd) | |
| The attributes of the event | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[attributes](#attributes) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:14](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L14) | |
| ___ | |
| #### callbackUrl | |
| • `Optional` **callbackUrl**: `string` | |
| The callback url to acknowledge the event | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[callbackUrl](#callbackurl) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:16](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L16) | |
| ___ | |
| #### context | |
| • **context**: [`Context`](#interfacesflatfileeventscontextmd) | |
| The context of the event | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[context](#context) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:12](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L12) | |
| ___ | |
| #### createdAt | |
| • **createdAt**: `Date` | |
| Date the event was created | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[createdAt](#createdat) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:20](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L20) | |
| ___ | |
| #### dataUrl | |
| • `Optional` **dataUrl**: `string` | |
| The url to retrieve the data associated with the event | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[dataUrl](#dataurl) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:18](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L18) | |
| ___ | |
| #### deletedAt | |
| • `Optional` **deletedAt**: `Date` | |
| Date the event was deleted | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[deletedAt](#deletedat) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:22](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L22) | |
| ___ | |
| #### domain | |
| • **domain**: [`Domain`](#domain-1) | |
| The domain of the event | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[domain](#domain) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:9](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L9) | |
| ___ | |
| #### origin | |
| • `Optional` **origin**: [`Origin`](#interfacesflatfileeventsoriginmd) | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[origin](#origin) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:28](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L28) | |
| ___ | |
| #### payload | |
| • **payload**: `Record`<`string`, `unknown`\> | |
| ##### Defined in | |
| [src/api/resources/events/types/WorkbookRemovedEvent.ts:8](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/WorkbookRemovedEvent.ts#L8) | |
| ___ | |
| #### target | |
| • `Optional` **target**: `string` | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[target](#target) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:27](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L27) | |
| ___ | |
| #### topic | |
| • **topic**: [`EventTopic`](#eventtopic-1) | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[topic](#topic) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:10](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L10) | |
| <a name="interfacesflatfileeventsworkbookupdatedeventmd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / [events](#modulesflatfileeventsmd) / WorkbookUpdatedEvent | |
| ## Interface: WorkbookUpdatedEvent | |
| [Flatfile](#modulesflatfilemd).[events](#modulesflatfileeventsmd).WorkbookUpdatedEvent | |
| ### Hierarchy | |
| - [`BaseEvent`](#interfacesflatfileeventsbaseeventmd) | |
| ↳ **`WorkbookUpdatedEvent`** | |
| ↳↳ [`WorkbookUpdated`](#interfacesflatfileeventseventworkbookupdatedmd) | |
| ### Table of contents | |
| #### Properties | |
| - [acknowledgedAt](#acknowledgedat) | |
| - [acknowledgedBy](#acknowledgedby) | |
| - [attributes](#attributes) | |
| - [callbackUrl](#callbackurl) | |
| - [context](#context) | |
| - [createdAt](#createdat) | |
| - [dataUrl](#dataurl) | |
| - [deletedAt](#deletedat) | |
| - [domain](#domain) | |
| - [origin](#origin) | |
| - [payload](#payload) | |
| - [target](#target) | |
| - [topic](#topic) | |
| ### Properties | |
| #### acknowledgedAt | |
| • `Optional` **acknowledgedAt**: `string` | |
| Date the event was acknowledged | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[acknowledgedAt](#acknowledgedat) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:24](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L24) | |
| ___ | |
| #### acknowledgedBy | |
| • `Optional` **acknowledgedBy**: `string` | |
| The actor (user or system) who acknowledged the event | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[acknowledgedBy](#acknowledgedby) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:26](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L26) | |
| ___ | |
| #### attributes | |
| • `Optional` **attributes**: [`EventAttributes`](#interfacesflatfileeventseventattributesmd) | |
| The attributes of the event | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[attributes](#attributes) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:14](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L14) | |
| ___ | |
| #### callbackUrl | |
| • `Optional` **callbackUrl**: `string` | |
| The callback url to acknowledge the event | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[callbackUrl](#callbackurl) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:16](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L16) | |
| ___ | |
| #### context | |
| • **context**: [`Context`](#interfacesflatfileeventscontextmd) | |
| The context of the event | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[context](#context) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:12](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L12) | |
| ___ | |
| #### createdAt | |
| • **createdAt**: `Date` | |
| Date the event was created | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[createdAt](#createdat) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:20](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L20) | |
| ___ | |
| #### dataUrl | |
| • `Optional` **dataUrl**: `string` | |
| The url to retrieve the data associated with the event | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[dataUrl](#dataurl) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:18](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L18) | |
| ___ | |
| #### deletedAt | |
| • `Optional` **deletedAt**: `Date` | |
| Date the event was deleted | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[deletedAt](#deletedat) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:22](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L22) | |
| ___ | |
| #### domain | |
| • **domain**: [`Domain`](#domain-1) | |
| The domain of the event | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[domain](#domain) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:9](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L9) | |
| ___ | |
| #### origin | |
| • `Optional` **origin**: [`Origin`](#interfacesflatfileeventsoriginmd) | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[origin](#origin) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:28](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L28) | |
| ___ | |
| #### payload | |
| • **payload**: `Record`<`string`, `unknown`\> | |
| ##### Defined in | |
| [src/api/resources/events/types/WorkbookUpdatedEvent.ts:8](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/WorkbookUpdatedEvent.ts#L8) | |
| ___ | |
| #### target | |
| • `Optional` **target**: `string` | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[target](#target) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:27](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L27) | |
| ___ | |
| #### topic | |
| • **topic**: [`EventTopic`](#eventtopic-1) | |
| ##### Inherited from | |
| [BaseEvent](#interfacesflatfileeventsbaseeventmd).[topic](#topic) | |
| ##### Defined in | |
| [src/api/resources/events/types/BaseEvent.ts:10](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/BaseEvent.ts#L10) | |
| <a name="interfacesflatfilefilescreatefilerequestmd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / [files](#modulesflatfilefilesmd) / CreateFileRequest | |
| ## Interface: CreateFileRequest | |
| [Flatfile](#modulesflatfilemd).[files](#modulesflatfilefilesmd).CreateFileRequest | |
| ### Table of contents | |
| #### Properties | |
| - [environmentId](#environmentid) | |
| - [file](#file) | |
| - [mode](#mode) | |
| - [spaceId](#spaceid) | |
| ### Properties | |
| #### environmentId | |
| • **environmentId**: `string` | |
| ##### Defined in | |
| [src/api/resources/files/client/requests/CreateFileRequest.ts:9](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/files/client/requests/CreateFileRequest.ts#L9) | |
| ___ | |
| #### file | |
| • **file**: `string` | |
| A binary payload containing the file contents | |
| ##### Defined in | |
| [src/api/resources/files/client/requests/CreateFileRequest.ts:13](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/files/client/requests/CreateFileRequest.ts#L13) | |
| ___ | |
| #### mode | |
| • `Optional` **mode**: [`Mode`](#mode-1) | |
| The storage mode of file to insert, defaults to "import" | |
| ##### Defined in | |
| [src/api/resources/files/client/requests/CreateFileRequest.ts:11](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/files/client/requests/CreateFileRequest.ts#L11) | |
| ___ | |
| #### spaceId | |
| • **spaceId**: `string` | |
| ##### Defined in | |
| [src/api/resources/files/client/requests/CreateFileRequest.ts:8](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/files/client/requests/CreateFileRequest.ts#L8) | |
| <a name="interfacesflatfilefilesfileresponsemd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / [files](#modulesflatfilefilesmd) / FileResponse | |
| ## Interface: FileResponse | |
| [Flatfile](#modulesflatfilemd).[files](#modulesflatfilefilesmd).FileResponse | |
| ### Table of contents | |
| #### Properties | |
| - [data](#data) | |
| ### Properties | |
| #### data | |
| • **data**: [`File_`](#interfacesflatfilefilesfile_md) | |
| ##### Defined in | |
| [src/api/resources/files/types/FileResponse.ts:8](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/files/types/FileResponse.ts#L8) | |
| <a name="interfacesflatfilefilesfile_md"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / [files](#modulesflatfilefilesmd) / File\_ | |
| ## Interface: File\_ | |
| [Flatfile](#modulesflatfilemd).[files](#modulesflatfilefilesmd).File_ | |
| Any uploaded file of any type | |
| ### Table of contents | |
| #### Properties | |
| - [actions](#actions) | |
| - [bytesReceived](#bytesreceived) | |
| - [createdAt](#createdat) | |
| - [encoding](#encoding) | |
| - [ext](#ext) | |
| - [id](#id) | |
| - [mimetype](#mimetype) | |
| - [name](#name) | |
| - [sheetId](#sheetid) | |
| - [size](#size) | |
| - [spaceId](#spaceid) | |
| - [status](#status) | |
| - [updatedAt](#updatedat) | |
| - [workbookId](#workbookid) | |
| ### Properties | |
| #### actions | |
| • `Optional` **actions**: [`Action`](#interfacesflatfilecommonsactionmd)[] | |
| ##### Defined in | |
| [src/api/resources/files/types/File_.ts:33](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/files/types/File_.ts#L33) | |
| ___ | |
| #### 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](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/files/types/File_.ts#L25) | |
| ___ | |
| #### createdAt | |
| • **createdAt**: `string` | |
| Date the file was created | |
| ##### Defined in | |
| [src/api/resources/files/types/File_.ts:27](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/files/types/File_.ts#L27) | |
| ___ | |
| #### encoding | |
| • **encoding**: `string` | |
| Text encoding of the file | |
| ##### Defined in | |
| [src/api/resources/files/types/File_.ts:19](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/files/types/File_.ts#L19) | |
| ___ | |
| #### ext | |
| • **ext**: `string` | |
| Extension of the file | |
| ##### Defined in | |
| [src/api/resources/files/types/File_.ts:15](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/files/types/File_.ts#L15) | |
| ___ | |
| #### id | |
| • **id**: `string` | |
| ##### Defined in | |
| [src/api/resources/files/types/File_.ts:11](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/files/types/File_.ts#L11) | |
| ___ | |
| #### mimetype | |
| • **mimetype**: `string` | |
| MIME Type of the file | |
| ##### Defined in | |
| [src/api/resources/files/types/File_.ts:17](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/files/types/File_.ts#L17) | |
| ___ | |
| #### name | |
| • **name**: `string` | |
| Original filename | |
| ##### Defined in | |
| [src/api/resources/files/types/File_.ts:13](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/files/types/File_.ts#L13) | |
| ___ | |
| #### sheetId | |
| • `Optional` **sheetId**: `string` | |
| ##### Defined in | |
| [src/api/resources/files/types/File_.ts:32](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/files/types/File_.ts#L32) | |
| ___ | |
| #### size | |
| • **size**: `number` | |
| Size of file in bytes | |
| ##### Defined in | |
| [src/api/resources/files/types/File_.ts:23](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/files/types/File_.ts#L23) | |
| ___ | |
| #### spaceId | |
| • **spaceId**: `string` | |
| ##### Defined in | |
| [src/api/resources/files/types/File_.ts:30](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/files/types/File_.ts#L30) | |
| ___ | |
| #### status | |
| • **status**: [`ModelFileStatusEnum`](#modelfilestatusenum-1) | |
| Status of the file | |
| ##### Defined in | |
| [src/api/resources/files/types/File_.ts:21](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/files/types/File_.ts#L21) | |
| ___ | |
| #### updatedAt | |
| • **updatedAt**: `string` | |
| Date the file was last updated | |
| ##### Defined in | |
| [src/api/resources/files/types/File_.ts:29](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/files/types/File_.ts#L29) | |
| ___ | |
| #### workbookId | |
| • `Optional` **workbookId**: `string` | |
| ##### Defined in | |
| [src/api/resources/files/types/File_.ts:31](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/files/types/File_.ts#L31) | |
| <a name="interfacesflatfilefileslistfilesrequestmd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / [files](#modulesflatfilefilesmd) / ListFilesRequest | |
| ## Interface: ListFilesRequest | |
| [Flatfile](#modulesflatfilemd).[files](#modulesflatfilefilesmd).ListFilesRequest | |
| ### Table of contents | |
| #### Properties | |
| - [mode](#mode) | |
| - [pageNumber](#pagenumber) | |
| - [pageSize](#pagesize) | |
| - [spaceId](#spaceid) | |
| ### Properties | |
| #### mode | |
| • `Optional` **mode**: [`Mode`](#mode-1) | |
| The storage mode of file to fetch, defaults to "import" | |
| ##### Defined in | |
| [src/api/resources/files/client/requests/ListFilesRequest.ts:20](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/files/client/requests/ListFilesRequest.ts#L20) | |
| ___ | |
| #### pageNumber | |
| • `Optional` **pageNumber**: `number` | |
| Based on pageSize, which page of jobs to return | |
| ##### Defined in | |
| [src/api/resources/files/client/requests/ListFilesRequest.ts:16](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/files/client/requests/ListFilesRequest.ts#L16) | |
| ___ | |
| #### 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](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/files/client/requests/ListFilesRequest.ts#L12) | |
| ___ | |
| #### spaceId | |
| • `Optional` **spaceId**: `string` | |
| ##### Defined in | |
| [src/api/resources/files/client/requests/ListFilesRequest.ts:8](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/files/client/requests/ListFilesRequest.ts#L8) | |
| <a name="interfacesflatfilefileslistfilesresponsemd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / [files](#modulesflatfilefilesmd) / ListFilesResponse | |
| ## Interface: ListFilesResponse | |
| [Flatfile](#modulesflatfilemd).[files](#modulesflatfilefilesmd).ListFilesResponse | |
| ### Table of contents | |
| #### Properties | |
| - [data](#data) | |
| - [pagination](#pagination) | |
| ### Properties | |
| #### data | |
| • **data**: [`File_`](#interfacesflatfilefilesfile_md)[] | |
| ##### Defined in | |
| [src/api/resources/files/types/ListFilesResponse.ts:9](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/files/types/ListFilesResponse.ts#L9) | |
| ___ | |
| #### pagination | |
| • `Optional` **pagination**: [`Pagination`](#interfacesflatfilecommonspaginationmd) | |
| ##### Defined in | |
| [src/api/resources/files/types/ListFilesResponse.ts:8](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/files/types/ListFilesResponse.ts#L8) | |
| <a name="interfacesflatfilefilesupdatefilerequestmd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / [files](#modulesflatfilefilesmd) / UpdateFileRequest | |
| ## Interface: UpdateFileRequest | |
| [Flatfile](#modulesflatfilemd).[files](#modulesflatfilefilesmd).UpdateFileRequest | |
| ### Table of contents | |
| #### Properties | |
| - [actions](#actions) | |
| - [mode](#mode) | |
| - [name](#name) | |
| - [status](#status) | |
| - [workbookId](#workbookid) | |
| ### Properties | |
| #### actions | |
| • `Optional` **actions**: [`Action`](#interfacesflatfilecommonsactionmd)[] | |
| The actions attached to the file | |
| ##### Defined in | |
| [src/api/resources/files/client/requests/UpdateFileRequest.ts:16](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/files/client/requests/UpdateFileRequest.ts#L16) | |
| ___ | |
| #### mode | |
| • `Optional` **mode**: [`Mode`](#mode-1) | |
| The storage mode of file to update | |
| ##### Defined in | |
| [src/api/resources/files/client/requests/UpdateFileRequest.ts:12](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/files/client/requests/UpdateFileRequest.ts#L12) | |
| ___ | |
| #### name | |
| • `Optional` **name**: `string` | |
| The name of the file | |
| ##### Defined in | |
| [src/api/resources/files/client/requests/UpdateFileRequest.ts:10](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/files/client/requests/UpdateFileRequest.ts#L10) | |
| ___ | |
| #### status | |
| • `Optional` **status**: [`ModelFileStatusEnum`](#modelfilestatusenum-1) | |
| Status of the file | |
| ##### Defined in | |
| [src/api/resources/files/client/requests/UpdateFileRequest.ts:14](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/files/client/requests/UpdateFileRequest.ts#L14) | |
| ___ | |
| #### workbookId | |
| • `Optional` **workbookId**: `string` | |
| ##### Defined in | |
| [src/api/resources/files/client/requests/UpdateFileRequest.ts:8](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/files/client/requests/UpdateFileRequest.ts#L8) | |
| <a name="interfacesflatfileguestscreateguestresponsemd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / [guests](#modulesflatfileguestsmd) / CreateGuestResponse | |
| ## Interface: CreateGuestResponse | |
| [Flatfile](#modulesflatfilemd).[guests](#modulesflatfileguestsmd).CreateGuestResponse | |
| ### Table of contents | |
| #### Properties | |
| - [data](#data) | |
| ### Properties | |
| #### data | |
| • **data**: [`Guest`](#interfacesflatfileguestsguestmd)[] | |
| ##### Defined in | |
| [src/api/resources/guests/types/CreateGuestResponse.ts:8](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/guests/types/CreateGuestResponse.ts#L8) | |
| <a name="interfacesflatfileguestsguestmd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / [guests](#modulesflatfileguestsmd) / Guest | |
| ## Interface: Guest | |
| [Flatfile](#modulesflatfilemd).[guests](#modulesflatfileguestsmd).Guest | |
| Configurations for the guests | |
| ### Hierarchy | |
| - [`GuestConfig`](#interfacesflatfileguestsguestconfigmd) | |
| ↳ **`Guest`** | |
| ### Table of contents | |
| #### Properties | |
| - [createdAt](#createdat) | |
| - [email](#email) | |
| - [environmentId](#environmentid) | |
| - [id](#id) | |
| - [name](#name) | |
| - [spaces](#spaces) | |
| - [updatedAt](#updatedat) | |
| - [workbooks](#workbooks) | |
| ### Properties | |
| #### createdAt | |
| • **createdAt**: `Date` | |
| Date the guest object was created | |
| ##### Defined in | |
| [src/api/resources/guests/types/Guest.ts:10](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/guests/types/Guest.ts#L10) | |
| ___ | |
| • **email**: `string` | |
| ##### Inherited from | |
| [GuestConfig](#interfacesflatfileguestsguestconfigmd).[email](#email) | |
| ##### Defined in | |
| [src/api/resources/guests/types/GuestConfig.ts:12](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/guests/types/GuestConfig.ts#L12) | |
| ___ | |
| #### environmentId | |
| • **environmentId**: `string` | |
| ##### Inherited from | |
| [GuestConfig](#interfacesflatfileguestsguestconfigmd).[environmentId](#environmentid) | |
| ##### Defined in | |
| [src/api/resources/guests/types/GuestConfig.ts:11](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/guests/types/GuestConfig.ts#L11) | |
| ___ | |
| #### id | |
| • **id**: `string` | |
| ##### Defined in | |
| [src/api/resources/guests/types/Guest.ts:8](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/guests/types/Guest.ts#L8) | |
| ___ | |
| #### name | |
| • **name**: `string` | |
| ##### Inherited from | |
| [GuestConfig](#interfacesflatfileguestsguestconfigmd).[name](#name) | |
| ##### Defined in | |
| [src/api/resources/guests/types/GuestConfig.ts:13](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/guests/types/GuestConfig.ts#L13) | |
| ___ | |
| #### spaces | |
| • **spaces**: [`GuestSpace`](#interfacesflatfileguestsguestspacemd)[] | |
| ##### Inherited from | |
| [GuestConfig](#interfacesflatfileguestsguestconfigmd).[spaces](#spaces) | |
| ##### Defined in | |
| [src/api/resources/guests/types/GuestConfig.ts:14](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/guests/types/GuestConfig.ts#L14) | |
| ___ | |
| #### updatedAt | |
| • **updatedAt**: `Date` | |
| Date the guest object was last updated | |
| ##### Defined in | |
| [src/api/resources/guests/types/Guest.ts:12](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/guests/types/Guest.ts#L12) | |
| ___ | |
| #### workbooks | |
| • `Optional` **workbooks**: [`GuestWorkbook`](#interfacesflatfileguestsguestworkbookmd)[] | |
| ##### Inherited from | |
| [GuestConfig](#interfacesflatfileguestsguestconfigmd).[workbooks](#workbooks) | |
| ##### Defined in | |
| [src/api/resources/guests/types/GuestConfig.ts:15](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/guests/types/GuestConfig.ts#L15) | |
| <a name="interfacesflatfileguestsguestconfigmd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / [guests](#modulesflatfileguestsmd) / GuestConfig | |
| ## Interface: GuestConfig | |
| [Flatfile](#modulesflatfilemd).[guests](#modulesflatfileguestsmd).GuestConfig | |
| Configurations for the guests | |
| ### Hierarchy | |
| - **`GuestConfig`** | |
| ↳ [`Guest`](#interfacesflatfileguestsguestmd) | |
| ### Table of contents | |
| #### Properties | |
| - [email](#email) | |
| - [environmentId](#environmentid) | |
| - [name](#name) | |
| - [spaces](#spaces) | |
| - [workbooks](#workbooks) | |
| ### Properties | |
| • **email**: `string` | |
| ##### Defined in | |
| [src/api/resources/guests/types/GuestConfig.ts:12](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/guests/types/GuestConfig.ts#L12) | |
| ___ | |
| #### environmentId | |
| • **environmentId**: `string` | |
| ##### Defined in | |
| [src/api/resources/guests/types/GuestConfig.ts:11](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/guests/types/GuestConfig.ts#L11) | |
| ___ | |
| #### name | |
| • **name**: `string` | |
| ##### Defined in | |
| [src/api/resources/guests/types/GuestConfig.ts:13](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/guests/types/GuestConfig.ts#L13) | |
| ___ | |
| #### spaces | |
| • **spaces**: [`GuestSpace`](#interfacesflatfileguestsguestspacemd)[] | |
| ##### Defined in | |
| [src/api/resources/guests/types/GuestConfig.ts:14](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/guests/types/GuestConfig.ts#L14) | |
| ___ | |
| #### workbooks | |
| • `Optional` **workbooks**: [`GuestWorkbook`](#interfacesflatfileguestsguestworkbookmd)[] | |
| ##### Defined in | |
| [src/api/resources/guests/types/GuestConfig.ts:15](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/guests/types/GuestConfig.ts#L15) | |
| <a name="interfacesflatfileguestsguestspacemd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / [guests](#modulesflatfileguestsmd) / GuestSpace | |
| ## Interface: GuestSpace | |
| [Flatfile](#modulesflatfilemd).[guests](#modulesflatfileguestsmd).GuestSpace | |
| ### Table of contents | |
| #### Properties | |
| - [id](#id) | |
| - [lastAccessed](#lastaccessed) | |
| ### Properties | |
| #### id | |
| • **id**: `string` | |
| ##### Defined in | |
| [src/api/resources/guests/types/GuestSpace.ts:8](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/guests/types/GuestSpace.ts#L8) | |
| ___ | |
| #### lastAccessed | |
| • `Optional` **lastAccessed**: `Date` | |
| ##### Defined in | |
| [src/api/resources/guests/types/GuestSpace.ts:9](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/guests/types/GuestSpace.ts#L9) | |
| <a name="interfacesflatfileguestsguestworkbookmd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / [guests](#modulesflatfileguestsmd) / GuestWorkbook | |
| ## Interface: GuestWorkbook | |
| [Flatfile](#modulesflatfilemd).[guests](#modulesflatfileguestsmd).GuestWorkbook | |
| ### Table of contents | |
| #### Properties | |
| - [id](#id) | |
| ### Properties | |
| #### id | |
| • **id**: `string` | |
| ##### Defined in | |
| [src/api/resources/guests/types/GuestWorkbook.ts:8](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/guests/types/GuestWorkbook.ts#L8) | |
| <a name="interfacesflatfileguestsinvitemd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / [guests](#modulesflatfileguestsmd) / Invite | |
| ## Interface: Invite | |
| [Flatfile](#modulesflatfilemd).[guests](#modulesflatfileguestsmd).Invite | |
| ### Table of contents | |
| #### Properties | |
| - [guestId](#guestid) | |
| - [message](#message) | |
| - [spaceId](#spaceid) | |
| ### Properties | |
| #### guestId | |
| • **guestId**: `string` | |
| ##### Defined in | |
| [src/api/resources/guests/types/Invite.ts:8](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/guests/types/Invite.ts#L8) | |
| ___ | |
| #### message | |
| • **message**: `string` | |
| Message to send with the invite | |
| ##### Defined in | |
| [src/api/resources/guests/types/Invite.ts:11](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/guests/types/Invite.ts#L11) | |
| ___ | |
| #### spaceId | |
| • **spaceId**: `string` | |
| ##### Defined in | |
| [src/api/resources/guests/types/Invite.ts:9](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/guests/types/Invite.ts#L9) | |
| <a name="interfacesflatfileguestslistguestsrequestmd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / [guests](#modulesflatfileguestsmd) / ListGuestsRequest | |
| ## Interface: ListGuestsRequest | |
| [Flatfile](#modulesflatfilemd).[guests](#modulesflatfileguestsmd).ListGuestsRequest | |
| ### Table of contents | |
| #### Properties | |
| - [email](#email) | |
| - [spaceId](#spaceid) | |
| ### Properties | |
| • `Optional` **email**: `string` | |
| Email of guest to return | |
| ##### Defined in | |
| [src/api/resources/guests/client/requests/ListGuestsRequest.ts:15](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/guests/client/requests/ListGuestsRequest.ts#L15) | |
| ___ | |
| #### spaceId | |
| • **spaceId**: `string` | |
| ID of space to return | |
| ##### Defined in | |
| [src/api/resources/guests/client/requests/ListGuestsRequest.ts:11](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/guests/client/requests/ListGuestsRequest.ts#L11) | |
| <a name="interfacesflatfileguestslistguestsresponsemd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / [guests](#modulesflatfileguestsmd) / ListGuestsResponse | |
| ## Interface: ListGuestsResponse | |
| [Flatfile](#modulesflatfilemd).[guests](#modulesflatfileguestsmd).ListGuestsResponse | |
| ### Table of contents | |
| #### Properties | |
| - [data](#data) | |
| ### Properties | |
| #### data | |
| • **data**: [`Guest`](#interfacesflatfileguestsguestmd)[] | |
| ##### Defined in | |
| [src/api/resources/guests/types/ListGuestsResponse.ts:8](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/guests/types/ListGuestsResponse.ts#L8) | |
| <a name="interfacesflatfilejobsaiassistjobconfigmd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / [jobs](#modulesflatfilejobsmd) / AiAssistJobConfig | |
| ## Interface: AiAssistJobConfig | |
| [Flatfile](#modulesflatfilemd).[jobs](#modulesflatfilejobsmd).AiAssistJobConfig | |
| This file was auto-generated by Fern from our API Definition. | |
| ### Table of contents | |
| #### Properties | |
| - [command](#command) | |
| - [metadata](#metadata) | |
| - [model](#model) | |
| - [modelParams](#modelparams) | |
| - [mutateRecord](#mutaterecord) | |
| ### Properties | |
| #### command | |
| • **command**: `string` | |
| ##### Defined in | |
| [src/api/resources/jobs/types/AiAssistJobConfig.ts:7](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/jobs/types/AiAssistJobConfig.ts#L7) | |
| ___ | |
| #### 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](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/jobs/types/AiAssistJobConfig.ts#L12) | |
| ___ | |
| #### model | |
| • **model**: `string` | |
| ##### Defined in | |
| [src/api/resources/jobs/types/AiAssistJobConfig.ts:6](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/jobs/types/AiAssistJobConfig.ts#L6) | |
| ___ | |
| #### modelParams | |
| • `Optional` **modelParams**: `Record`<`string`, `unknown`\> | |
| ##### Defined in | |
| [src/api/resources/jobs/types/AiAssistJobConfig.ts:8](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/jobs/types/AiAssistJobConfig.ts#L8) | |
| ___ | |
| #### mutateRecord | |
| • `Optional` **mutateRecord**: `string` | |
| This will be generated by the AI not by you. | |
| ##### Defined in | |
| [src/api/resources/jobs/types/AiAssistJobConfig.ts:10](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/jobs/types/AiAssistJobConfig.ts#L10) | |
| <a name="interfacesflatfilejobscategorymappingmd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / [jobs](#modulesflatfilejobsmd) / CategoryMapping | |
| ## Interface: CategoryMapping | |
| [Flatfile](#modulesflatfilemd).[jobs](#modulesflatfilejobsmd).CategoryMapping | |
| This file was auto-generated by Fern from our API Definition. | |
| ### Table of contents | |
| #### Properties | |
| - [destinationValue](#destinationvalue) | |
| - [sourceValue](#sourcevalue) | |
| ### Properties | |
| #### destinationValue | |
| • `Optional` **destinationValue**: `string` | |
| ##### Defined in | |
| [src/api/resources/jobs/types/CategoryMapping.ts:7](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/jobs/types/CategoryMapping.ts#L7) | |
| ___ | |
| #### sourceValue | |
| • `Optional` **sourceValue**: `string` | |
| ##### Defined in | |
| [src/api/resources/jobs/types/CategoryMapping.ts:6](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/jobs/types/CategoryMapping.ts#L6) | |
| <a name="interfacesflatfilejobsdeletejobconfigmd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / [jobs](#modulesflatfilejobsmd) / DeleteJobConfig | |
| ## Interface: DeleteJobConfig | |
| [Flatfile](#modulesflatfilemd).[jobs](#modulesflatfilejobsmd).DeleteJobConfig | |
| The configuration for a delete job | |
| ### Table of contents | |
| #### Properties | |
| - [exceptions](#exceptions) | |
| - [filter](#filter) | |
| - [filterField](#filterfield) | |
| - [searchField](#searchfield) | |
| - [searchValue](#searchvalue) | |
| - [sheet](#sheet) | |
| ### Properties | |
| #### exceptions | |
| • `Optional` **exceptions**: `string`[] | |
| ##### Defined in | |
| [src/api/resources/jobs/types/DeleteJobConfig.ts:16](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/jobs/types/DeleteJobConfig.ts#L16) | |
| ___ | |
| #### filter | |
| • `Optional` **filter**: [`Filter`](#filter-1) | |
| ##### Defined in | |
| [src/api/resources/jobs/types/DeleteJobConfig.ts:11](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/jobs/types/DeleteJobConfig.ts#L11) | |
| ___ | |
| #### filterField | |
| • `Optional` **filterField**: `string` | |
| ##### Defined in | |
| [src/api/resources/jobs/types/DeleteJobConfig.ts:12](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/jobs/types/DeleteJobConfig.ts#L12) | |
| ___ | |
| #### searchField | |
| • `Optional` **searchField**: `string` | |
| ##### Defined in | |
| [src/api/resources/jobs/types/DeleteJobConfig.ts:14](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/jobs/types/DeleteJobConfig.ts#L14) | |
| ___ | |
| #### searchValue | |
| • `Optional` **searchValue**: `string` | |
| ##### Defined in | |
| [src/api/resources/jobs/types/DeleteJobConfig.ts:13](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/jobs/types/DeleteJobConfig.ts#L13) | |
| ___ | |
| #### sheet | |
| • **sheet**: `string` | |
| ##### Defined in | |
| [src/api/resources/jobs/types/DeleteJobConfig.ts:15](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/jobs/types/DeleteJobConfig.ts#L15) | |
| <a name="interfacesflatfilejobsdestinationfieldmd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / [jobs](#modulesflatfilejobsmd) / DestinationField | |
| ## Interface: DestinationField | |
| [Flatfile](#modulesflatfilemd).[jobs](#modulesflatfilejobsmd).DestinationField | |
| ### Table of contents | |
| #### Properties | |
| - [destinationField](#destinationfield) | |
| - [enumDetails](#enumdetails) | |
| - [preview](#preview) | |
| ### Properties | |
| #### destinationField | |
| • **destinationField**: [`Property`](#property) | |
| ##### Defined in | |
| [src/api/resources/jobs/types/DestinationField.ts:10](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/jobs/types/DestinationField.ts#L10) | |
| ___ | |
| #### enumDetails | |
| • `Optional` **enumDetails**: [`EnumDetails`](#interfacesflatfilejobsenumdetailsmd) | |
| 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](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/jobs/types/DestinationField.ts#L9) | |
| ___ | |
| #### preview | |
| • `Optional` **preview**: `string`[] | |
| ##### Defined in | |
| [src/api/resources/jobs/types/DestinationField.ts:11](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/jobs/types/DestinationField.ts#L11) | |
| <a name="interfacesflatfilejobsedgemd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / [jobs](#modulesflatfilejobsmd) / Edge | |
| ## Interface: Edge | |
| [Flatfile](#modulesflatfilemd).[jobs](#modulesflatfilejobsmd).Edge | |
| ### Table of contents | |
| #### Properties | |
| - [destinationField](#destinationfield) | |
| - [enumDetails](#enumdetails) | |
| - [metadata](#metadata) | |
| - [preview](#preview) | |
| - [sourceField](#sourcefield) | |
| ### Properties | |
| #### destinationField | |
| • **destinationField**: [`Property`](#property) | |
| ##### Defined in | |
| [src/api/resources/jobs/types/Edge.ts:9](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/jobs/types/Edge.ts#L9) | |
| ___ | |
| #### enumDetails | |
| • `Optional` **enumDetails**: [`EnumDetails`](#interfacesflatfilejobsenumdetailsmd) | |
| 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](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/jobs/types/Edge.ts#L12) | |
| ___ | |
| #### metadata | |
| • `Optional` **metadata**: [`Metadata`](#interfacesflatfilejobsmetadatamd) | |
| ##### Defined in | |
| [src/api/resources/jobs/types/Edge.ts:13](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/jobs/types/Edge.ts#L13) | |
| ___ | |
| #### preview | |
| • `Optional` **preview**: `string`[] | |
| ##### Defined in | |
| [src/api/resources/jobs/types/Edge.ts:10](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/jobs/types/Edge.ts#L10) | |
| ___ | |
| #### sourceField | |
| • **sourceField**: [`Property`](#property) | |
| ##### Defined in | |
| [src/api/resources/jobs/types/Edge.ts:8](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/jobs/types/Edge.ts#L8) | |
| <a name="interfacesflatfilejobsemptyobjectmd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / [jobs](#modulesflatfilejobsmd) / EmptyObject | |
| ## Interface: EmptyObject | |
| [Flatfile](#modulesflatfilemd).[jobs](#modulesflatfilejobsmd).EmptyObject | |
| This file was auto-generated by Fern from our API Definition. | |
| <a name="interfacesflatfilejobsenumdetailsmd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / [jobs](#modulesflatfilejobsmd) / EnumDetails | |
| ## Interface: EnumDetails | |
| [Flatfile](#modulesflatfilemd).[jobs](#modulesflatfilejobsmd).EnumDetails | |
| Only available if one or more of the destination fields is of type enum. Provides category mapping. | |
| ### Table of contents | |
| #### Properties | |
| - [mapping](#mapping) | |
| - [unusedDestinationValues](#unuseddestinationvalues) | |
| - [unusedSourceValues](#unusedsourcevalues) | |
| ### Properties | |
| #### mapping | |
| • `Optional` **mapping**: [`CategoryMapping`](#interfacesflatfilejobscategorymappingmd)[] | |
| ##### Defined in | |
| [src/api/resources/jobs/types/EnumDetails.ts:11](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/jobs/types/EnumDetails.ts#L11) | |
| ___ | |
| #### unusedDestinationValues | |
| • `Optional` **unusedDestinationValues**: `string`[] | |
| ##### Defined in | |
| [src/api/resources/jobs/types/EnumDetails.ts:13](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/jobs/types/EnumDetails.ts#L13) | |
| ___ | |
| #### unusedSourceValues | |
| • `Optional` **unusedSourceValues**: `string`[] | |
| ##### Defined in | |
| [src/api/resources/jobs/types/EnumDetails.ts:12](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/jobs/types/EnumDetails.ts#L12) | |
| <a name="interfacesflatfilejobsexportjobconfigmd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / [jobs](#modulesflatfilejobsmd) / ExportJobConfig | |
| ## Interface: ExportJobConfig | |
| [Flatfile](#modulesflatfilemd).[jobs](#modulesflatfilejobsmd).ExportJobConfig | |
| ### Table of contents | |
| #### Properties | |
| - [options](#options) | |
| ### Properties | |
| #### options | |
| • **options**: [`ExportOptions`](#interfacesflatfilejobsexportoptionsmd) | |
| ##### Defined in | |
| [src/api/resources/jobs/types/ExportJobConfig.ts:8](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/jobs/types/ExportJobConfig.ts#L8) | |
| <a name="interfacesflatfilejobsexportoptionsmd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / [jobs](#modulesflatfilejobsmd) / ExportOptions | |
| ## Interface: ExportOptions | |
| [Flatfile](#modulesflatfilemd).[jobs](#modulesflatfilejobsmd).ExportOptions | |
| ### Table of contents | |
| #### Properties | |
| - [filter](#filter) | |
| - [filterField](#filterfield) | |
| - [ids](#ids) | |
| - [searchField](#searchfield) | |
| - [searchValue](#searchvalue) | |
| - [sortDirection](#sortdirection) | |
| - [sortField](#sortfield) | |
| - [versionId](#versionid) | |
| ### Properties | |
| #### filter | |
| • `Optional` **filter**: [`Filter`](#filter-1) | |
| ##### Defined in | |
| [src/api/resources/jobs/types/ExportOptions.ts:11](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/jobs/types/ExportOptions.ts#L11) | |
| ___ | |
| #### filterField | |
| • `Optional` **filterField**: `string` | |
| ##### Defined in | |
| [src/api/resources/jobs/types/ExportOptions.ts:12](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/jobs/types/ExportOptions.ts#L12) | |
| ___ | |
| #### 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](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/jobs/types/ExportOptions.ts#L19) | |
| ___ | |
| #### searchField | |
| • `Optional` **searchField**: `string` | |
| ##### Defined in | |
| [src/api/resources/jobs/types/ExportOptions.ts:14](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/jobs/types/ExportOptions.ts#L14) | |
| ___ | |
| #### searchValue | |
| • `Optional` **searchValue**: `string` | |
| ##### Defined in | |
| [src/api/resources/jobs/types/ExportOptions.ts:13](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/jobs/types/ExportOptions.ts#L13) | |
| ___ | |
| #### sortDirection | |
| • `Optional` **sortDirection**: [`SortDirection`](#sortdirection-1) | |
| ##### Defined in | |
| [src/api/resources/jobs/types/ExportOptions.ts:10](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/jobs/types/ExportOptions.ts#L10) | |
| ___ | |
| #### sortField | |
| • `Optional` **sortField**: `string` | |
| ##### Defined in | |
| [src/api/resources/jobs/types/ExportOptions.ts:9](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/jobs/types/ExportOptions.ts#L9) | |
| ___ | |
| #### versionId | |
| • `Optional` **versionId**: `string` | |
| ##### Defined in | |
| [src/api/resources/jobs/types/ExportOptions.ts:8](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/jobs/types/ExportOptions.ts#L8) | |
| <a name="interfacesflatfilejobsfilejobconfigmd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / [jobs](#modulesflatfilejobsmd) / FileJobConfig | |
| ## Interface: FileJobConfig | |
| [Flatfile](#modulesflatfilemd).[jobs](#modulesflatfilejobsmd).FileJobConfig | |
| ### Table of contents | |
| #### Properties | |
| - [driver](#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](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/jobs/types/FileJobConfig.ts#L9) | |
| <a name="interfacesflatfilejobsfindandreplacejobconfigmd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / [jobs](#modulesflatfilejobsmd) / FindAndReplaceJobConfig | |
| ## Interface: FindAndReplaceJobConfig | |
| [Flatfile](#modulesflatfilemd).[jobs](#modulesflatfilejobsmd).FindAndReplaceJobConfig | |
| ### Table of contents | |
| #### Properties | |
| - [fieldKey](#fieldkey) | |
| - [filter](#filter) | |
| - [filterField](#filterfield) | |
| - [find](#find) | |
| - [ids](#ids) | |
| - [replace](#replace) | |
| - [searchField](#searchfield) | |
| - [searchValue](#searchvalue) | |
| ### Properties | |
| #### fieldKey | |
| • **fieldKey**: `string` | |
| The value to replace found values with | |
| ##### Defined in | |
| [src/api/resources/jobs/types/FindAndReplaceJobConfig.ts:22](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/jobs/types/FindAndReplaceJobConfig.ts#L22) | |
| ___ | |
| #### filter | |
| • `Optional` **filter**: [`Filter`](#filter-1) | |
| ##### Defined in | |
| [src/api/resources/jobs/types/FindAndReplaceJobConfig.ts:8](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/jobs/types/FindAndReplaceJobConfig.ts#L8) | |
| ___ | |
| #### filterField | |
| • `Optional` **filterField**: `string` | |
| ##### Defined in | |
| [src/api/resources/jobs/types/FindAndReplaceJobConfig.ts:9](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/jobs/types/FindAndReplaceJobConfig.ts#L9) | |
| ___ | |
| #### find | |
| • `Optional` **find**: [`CellValueUnion`](#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](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/jobs/types/FindAndReplaceJobConfig.ts#L18) | |
| ___ | |
| #### 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](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/jobs/types/FindAndReplaceJobConfig.ts#L16) | |
| ___ | |
| #### replace | |
| • `Optional` **replace**: [`CellValueUnion`](#cellvalueunion) | |
| The value to replace found values with | |
| ##### Defined in | |
| [src/api/resources/jobs/types/FindAndReplaceJobConfig.ts:20](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/jobs/types/FindAndReplaceJobConfig.ts#L20) | |
| ___ | |
| #### searchField | |
| • `Optional` **searchField**: `string` | |
| ##### Defined in | |
| [src/api/resources/jobs/types/FindAndReplaceJobConfig.ts:11](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/jobs/types/FindAndReplaceJobConfig.ts#L11) | |
| ___ | |
| #### searchValue | |
| • `Optional` **searchValue**: `string` | |
| ##### Defined in | |
| [src/api/resources/jobs/types/FindAndReplaceJobConfig.ts:10](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/jobs/types/FindAndReplaceJobConfig.ts#L10) | |
| <a name="interfacesflatfilejobsjobmd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / [jobs](#modulesflatfilejobsmd) / Job | |
| ## Interface: Job | |
| [Flatfile](#modulesflatfilemd).[jobs](#modulesflatfilejobsmd).Job | |
| A single unit of work that will execute asynchronously | |
| ### Hierarchy | |
| - [`JobConfig`](#interfacesflatfilejobsjobconfigmd) | |
| ↳ **`Job`** | |
| ### Table of contents | |
| #### Properties | |
| - [config](#config) | |
| - [createdAt](#createdat) | |
| - [destination](#destination) | |
| - [fileId](#fileid) | |
| - [finishedAt](#finishedat) | |
| - [id](#id) | |
| - [info](#info) | |
| - [input](#input) | |
| - [managed](#managed) | |
| - [mode](#mode) | |
| - [operation](#operation) | |
| - [outcome](#outcome) | |
| - [outcomeAcknowledgedAt](#outcomeacknowledgedat) | |
| - [progress](#progress) | |
| - [source](#source) | |
| - [startedAt](#startedat) | |
| - [status](#status) | |
| - [trigger](#trigger) | |
| - [type](#type) | |
| - [updatedAt](#updatedat) | |
| ### Properties | |
| #### config | |
| • `Optional` **config**: [`JobUpdateConfig`](#jobupdateconfig) | |
| ##### Inherited from | |
| [JobConfig](#interfacesflatfilejobsjobconfigmd).[config](#config) | |
| ##### Defined in | |
| [src/api/resources/jobs/types/JobConfig.ts:17](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/jobs/types/JobConfig.ts#L17) | |
| ___ | |
| #### createdAt | |
| • **createdAt**: `Date` | |
| Date the item was created | |
| ##### Defined in | |
| [src/api/resources/jobs/types/Job.ts:13](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/jobs/types/Job.ts#L13) | |
| ___ | |
| #### destination | |
| • `Optional` **destination**: `string` | |
| ##### Inherited from | |
| [JobConfig](#interfacesflatfilejobsjobconfigmd).[destination](#destination) | |
| ##### Defined in | |
| [src/api/resources/jobs/types/JobConfig.ts:16](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/jobs/types/JobConfig.ts#L16) | |
| ___ | |
| #### fileId | |
| • `Optional` **fileId**: `string` | |
| ##### Inherited from | |
| [JobConfig](#interfacesflatfilejobsjobconfigmd).[fileId](#fileid) | |
| ##### Defined in | |
| [src/api/resources/jobs/types/JobConfig.ts:24](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/jobs/types/JobConfig.ts#L24) | |
| ___ | |
| #### finishedAt | |
| • `Optional` **finishedAt**: `Date` | |
| the time that the job finished at | |
| ##### Defined in | |
| [src/api/resources/jobs/types/Job.ts:19](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/jobs/types/Job.ts#L19) | |
| ___ | |
| #### id | |
| • **id**: `string` | |
| ##### Defined in | |
| [src/api/resources/jobs/types/Job.ts:11](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/jobs/types/Job.ts#L11) | |
| ___ | |
| #### info | |
| • `Optional` **info**: `string` | |
| Current status of job in text | |
| ##### Inherited from | |
| [JobConfig](#interfacesflatfilejobsjobconfigmd).[info](#info) | |
| ##### Defined in | |
| [src/api/resources/jobs/types/JobConfig.ts:32](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/jobs/types/JobConfig.ts#L32) | |
| ___ | |
| #### input | |
| • `Optional` **input**: `Record`<`string`, `unknown`\> | |
| Input parameters for this job type. | |
| ##### Inherited from | |
| [JobConfig](#interfacesflatfilejobsjobconfigmd).[input](#input) | |
| ##### Defined in | |
| [src/api/resources/jobs/types/JobConfig.ts:28](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/jobs/types/JobConfig.ts#L28) | |
| ___ | |
| #### managed | |
| • **managed**: `boolean` | |
| Indicates if Flatfile is managing the control flow of this job or if it is being manually tracked. | |
| ##### Inherited from | |
| [JobConfig](#interfacesflatfilejobsjobconfigmd).[managed](#managed) | |
| ##### Defined in | |
| [src/api/resources/jobs/types/JobConfig.ts:34](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/jobs/types/JobConfig.ts#L34) | |
| ___ | |
| #### mode | |
| • `Optional` **mode**: [`JobMode`](#jobmode-1) | |
| the mode of the job | |
| ##### Inherited from | |
| [JobConfig](#interfacesflatfilejobsjobconfigmd).[mode](#mode) | |
| ##### Defined in | |
| [src/api/resources/jobs/types/JobConfig.ts:26](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/jobs/types/JobConfig.ts#L26) | |
| ___ | |
| #### operation | |
| • **operation**: `string` | |
| the type of operation to perform on the data. For example, "export". | |
| ##### Inherited from | |
| [JobConfig](#interfacesflatfilejobsjobconfigmd).[operation](#operation) | |
| ##### Defined in | |
| [src/api/resources/jobs/types/JobConfig.ts:14](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/jobs/types/JobConfig.ts#L14) | |
| ___ | |
| #### outcome | |
| • `Optional` **outcome**: `Record`<`string`, `unknown`\> | |
| Outcome summary of job. | |
| ##### Inherited from | |
| [JobConfig](#interfacesflatfilejobsjobconfigmd).[outcome](#outcome) | |
| ##### Defined in | |
| [src/api/resources/jobs/types/JobConfig.ts:30](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/jobs/types/JobConfig.ts#L30) | |
| ___ | |
| #### 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](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/jobs/types/Job.ts#L21) | |
| ___ | |
| #### progress | |
| • `Optional` **progress**: `number` | |
| the progress of the job | |
| ##### Inherited from | |
| [JobConfig](#interfacesflatfilejobsjobconfigmd).[progress](#progress) | |
| ##### Defined in | |
| [src/api/resources/jobs/types/JobConfig.ts:23](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/jobs/types/JobConfig.ts#L23) | |
| ___ | |
| #### source | |
| • **source**: `string` | |
| ##### Inherited from | |
| [JobConfig](#interfacesflatfilejobsjobconfigmd).[source](#source) | |
| ##### Defined in | |
| [src/api/resources/jobs/types/JobConfig.ts:15](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/jobs/types/JobConfig.ts#L15) | |
| ___ | |
| #### startedAt | |
| • `Optional` **startedAt**: `Date` | |
| the time that the job started at | |
| ##### Defined in | |
| [src/api/resources/jobs/types/Job.ts:17](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/jobs/types/Job.ts#L17) | |
| ___ | |
| #### status | |
| • `Optional` **status**: [`JobStatus`](#jobstatus-1) | |
| the status of the job | |
| ##### Inherited from | |
| [JobConfig](#interfacesflatfilejobsjobconfigmd).[status](#status) | |
| ##### Defined in | |
| [src/api/resources/jobs/types/JobConfig.ts:21](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/jobs/types/JobConfig.ts#L21) | |
| ___ | |
| #### trigger | |
| • `Optional` **trigger**: [`Trigger`](#trigger-1) | |
| the type of trigger to use for this job | |
| ##### Inherited from | |
| [JobConfig](#interfacesflatfilejobsjobconfigmd).[trigger](#trigger) | |
| ##### Defined in | |
| [src/api/resources/jobs/types/JobConfig.ts:19](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/jobs/types/JobConfig.ts#L19) | |
| ___ | |
| #### type | |
| • **type**: [`JobType`](#jobtype-1) | |
| The type of job | |
| ##### Inherited from | |
| [JobConfig](#interfacesflatfilejobsjobconfigmd).[type](#type) | |
| ##### Defined in | |
| [src/api/resources/jobs/types/JobConfig.ts:12](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/jobs/types/JobConfig.ts#L12) | |
| ___ | |
| #### updatedAt | |
| • **updatedAt**: `Date` | |
| Date the item was last updated | |
| ##### Defined in | |
| [src/api/resources/jobs/types/Job.ts:15](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/jobs/types/Job.ts#L15) | |
| <a name="interfacesflatfilejobsjobackdetailsmd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / [jobs](#modulesflatfilejobsmd) / JobAckDetails | |
| ## Interface: JobAckDetails | |
| [Flatfile](#modulesflatfilemd).[jobs](#modulesflatfilejobsmd).JobAckDetails | |
| Details about the user who acknowledged the job | |
| ### Table of contents | |
| #### Properties | |
| - [info](#info) | |
| - [progress](#progress) | |
| ### Properties | |
| #### info | |
| • `Optional` **info**: `string` | |
| ##### Defined in | |
| [src/api/resources/jobs/types/JobAckDetails.ts:9](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/jobs/types/JobAckDetails.ts#L9) | |
| ___ | |
| #### progress | |
| • `Optional` **progress**: `number` | |
| ##### Defined in | |
| [src/api/resources/jobs/types/JobAckDetails.ts:10](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/jobs/types/JobAckDetails.ts#L10) | |
| <a name="interfacesflatfilejobsjobconfigmd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / [jobs](#modulesflatfilejobsmd) / JobConfig | |
| ## Interface: JobConfig | |
| [Flatfile](#modulesflatfilemd).[jobs](#modulesflatfilejobsmd).JobConfig | |
| A single unit of work that a pipeline will execute | |
| ### Hierarchy | |
| - **`JobConfig`** | |
| ↳ [`Job`](#interfacesflatfilejobsjobmd) | |
| ### Table of contents | |
| #### Properties | |
| - [config](#config) | |
| - [destination](#destination) | |
| - [fileId](#fileid) | |
| - [info](#info) | |
| - [input](#input) | |
| - [managed](#managed) | |
| - [mode](#mode) | |
| - [operation](#operation) | |
| - [outcome](#outcome) | |
| - [progress](#progress) | |
| - [source](#source) | |
| - [status](#status) | |
| - [trigger](#trigger) | |
| - [type](#type) | |
| ### Properties | |
| #### config | |
| • `Optional` **config**: [`JobUpdateConfig`](#jobupdateconfig) | |
| ##### Defined in | |
| [src/api/resources/jobs/types/JobConfig.ts:17](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/jobs/types/JobConfig.ts#L17) | |
| ___ | |
| #### destination | |
| • `Optional` **destination**: `string` | |
| ##### Defined in | |
| [src/api/resources/jobs/types/JobConfig.ts:16](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/jobs/types/JobConfig.ts#L16) | |
| ___ | |
| #### fileId | |
| • `Optional` **fileId**: `string` | |
| ##### Defined in | |
| [src/api/resources/jobs/types/JobConfig.ts:24](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/jobs/types/JobConfig.ts#L24) | |
| ___ | |
| #### info | |
| • `Optional` **info**: `string` | |
| Current status of job in text | |
| ##### Defined in | |
| [src/api/resources/jobs/types/JobConfig.ts:32](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/jobs/types/JobConfig.ts#L32) | |
| ___ | |
| #### input | |
| • `Optional` **input**: `Record`<`string`, `unknown`\> | |
| Input parameters for this job type. | |
| ##### Defined in | |
| [src/api/resources/jobs/types/JobConfig.ts:28](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/jobs/types/JobConfig.ts#L28) | |
| ___ | |
| #### 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](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/jobs/types/JobConfig.ts#L34) | |
| ___ | |
| #### mode | |
| • `Optional` **mode**: [`JobMode`](#jobmode-1) | |
| the mode of the job | |
| ##### Defined in | |
| [src/api/resources/jobs/types/JobConfig.ts:26](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/jobs/types/JobConfig.ts#L26) | |
| ___ | |
| #### 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](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/jobs/types/JobConfig.ts#L14) | |
| ___ | |
| #### outcome | |
| • `Optional` **outcome**: `Record`<`string`, `unknown`\> | |
| Outcome summary of job. | |
| ##### Defined in | |
| [src/api/resources/jobs/types/JobConfig.ts:30](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/jobs/types/JobConfig.ts#L30) | |
| ___ | |
| #### progress | |
| • `Optional` **progress**: `number` | |
| the progress of the job | |
| ##### Defined in | |
| [src/api/resources/jobs/types/JobConfig.ts:23](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/jobs/types/JobConfig.ts#L23) | |
| ___ | |
| #### source | |
| • **source**: `string` | |
| ##### Defined in | |
| [src/api/resources/jobs/types/JobConfig.ts:15](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/jobs/types/JobConfig.ts#L15) | |
| ___ | |
| #### status | |
| • `Optional` **status**: [`JobStatus`](#jobstatus-1) | |
| the status of the job | |
| ##### Defined in | |
| [src/api/resources/jobs/types/JobConfig.ts:21](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/jobs/types/JobConfig.ts#L21) | |
| ___ | |
| #### trigger | |
| • `Optional` **trigger**: [`Trigger`](#trigger-1) | |
| the type of trigger to use for this job | |
| ##### Defined in | |
| [src/api/resources/jobs/types/JobConfig.ts:19](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/jobs/types/JobConfig.ts#L19) | |
| ___ | |
| #### type | |
| • **type**: [`JobType`](#jobtype-1) | |
| The type of job | |
| ##### Defined in | |
| [src/api/resources/jobs/types/JobConfig.ts:12](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/jobs/types/JobConfig.ts#L12) | |
| <a name="interfacesflatfilejobsjobexecutionplanmd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / [jobs](#modulesflatfilejobsmd) / JobExecutionPlan | |
| ## Interface: JobExecutionPlan | |
| [Flatfile](#modulesflatfilemd).[jobs](#modulesflatfilejobsmd).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`](#interfacesflatfilejobsjobexecutionplanconfigmd) | |
| ### Table of contents | |
| #### Properties | |
| - [fieldMapping](#fieldmapping) | |
| - [headerRowCount](#headerrowcount) | |
| - [unmappedDestinationFields](#unmappeddestinationfields) | |
| - [unmappedSourceFields](#unmappedsourcefields) | |
| ### Properties | |
| #### fieldMapping | |
| • `Optional` **fieldMapping**: [`Edge`](#interfacesflatfilejobsedgemd)[] | |
| ##### Defined in | |
| [src/api/resources/jobs/types/JobExecutionPlan.ts:11](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/jobs/types/JobExecutionPlan.ts#L11) | |
| ___ | |
| #### 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](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/jobs/types/JobExecutionPlan.ts#L15) | |
| ___ | |
| #### unmappedDestinationFields | |
| • `Optional` **unmappedDestinationFields**: [`DestinationField`](#interfacesflatfilejobsdestinationfieldmd)[] | |
| ##### Defined in | |
| [src/api/resources/jobs/types/JobExecutionPlan.ts:13](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/jobs/types/JobExecutionPlan.ts#L13) | |
| ___ | |
| #### unmappedSourceFields | |
| • `Optional` **unmappedSourceFields**: [`SourceField`](#interfacesflatfilejobssourcefieldmd)[] | |
| ##### Defined in | |
| [src/api/resources/jobs/types/JobExecutionPlan.ts:12](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/jobs/types/JobExecutionPlan.ts#L12) | |
| <a name="interfacesflatfilejobsjobexecutionplanconfigmd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / [jobs](#modulesflatfilejobsmd) / JobExecutionPlanConfig | |
| ## Interface: JobExecutionPlanConfig | |
| [Flatfile](#modulesflatfilemd).[jobs](#modulesflatfilejobsmd).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`](#interfacesflatfilejobsjobexecutionplanmd) | |
| ↳ **`JobExecutionPlanConfig`** | |
| ### Table of contents | |
| #### Properties | |
| - [fieldMapping](#fieldmapping) | |
| - [fileId](#fileid) | |
| - [headerRowCount](#headerrowcount) | |
| - [jobId](#jobid) | |
| - [unmappedDestinationFields](#unmappeddestinationfields) | |
| - [unmappedSourceFields](#unmappedsourcefields) | |
| ### Properties | |
| #### fieldMapping | |
| • `Optional` **fieldMapping**: [`Edge`](#interfacesflatfilejobsedgemd)[] | |
| ##### Inherited from | |
| [JobExecutionPlan](#interfacesflatfilejobsjobexecutionplanmd).[fieldMapping](#fieldmapping) | |
| ##### Defined in | |
| [src/api/resources/jobs/types/JobExecutionPlan.ts:11](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/jobs/types/JobExecutionPlan.ts#L11) | |
| ___ | |
| #### fileId | |
| • **fileId**: `string` | |
| ##### Defined in | |
| [src/api/resources/jobs/types/JobExecutionPlanConfig.ts:8](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/jobs/types/JobExecutionPlanConfig.ts#L8) | |
| ___ | |
| #### headerRowCount | |
| • `Optional` **headerRowCount**: `number` | |
| The number of rows to skip before reading data from the document | |
| ##### Inherited from | |
| [JobExecutionPlan](#interfacesflatfilejobsjobexecutionplanmd).[headerRowCount](#headerrowcount) | |
| ##### Defined in | |
| [src/api/resources/jobs/types/JobExecutionPlan.ts:15](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/jobs/types/JobExecutionPlan.ts#L15) | |
| ___ | |
| #### jobId | |
| • **jobId**: `string` | |
| ##### Defined in | |
| [src/api/resources/jobs/types/JobExecutionPlanConfig.ts:9](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/jobs/types/JobExecutionPlanConfig.ts#L9) | |
| ___ | |
| #### unmappedDestinationFields | |
| • `Optional` **unmappedDestinationFields**: [`DestinationField`](#interfacesflatfilejobsdestinationfieldmd)[] | |
| ##### Inherited from | |
| [JobExecutionPlan](#interfacesflatfilejobsjobexecutionplanmd).[unmappedDestinationFields](#unmappeddestinationfields) | |
| ##### Defined in | |
| [src/api/resources/jobs/types/JobExecutionPlan.ts:13](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/jobs/types/JobExecutionPlan.ts#L13) | |
| ___ | |
| #### unmappedSourceFields | |
| • `Optional` **unmappedSourceFields**: [`SourceField`](#interfacesflatfilejobssourcefieldmd)[] | |
| ##### Inherited from | |
| [JobExecutionPlan](#interfacesflatfilejobsjobexecutionplanmd).[unmappedSourceFields](#unmappedsourcefields) | |
| ##### Defined in | |
| [src/api/resources/jobs/types/JobExecutionPlan.ts:12](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/jobs/types/JobExecutionPlan.ts#L12) | |
| <a name="interfacesflatfilejobsjoboutcomemd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / [jobs](#modulesflatfilejobsmd) / JobOutcome | |
| ## Interface: JobOutcome | |
| [Flatfile](#modulesflatfilemd).[jobs](#modulesflatfilejobsmd).JobOutcome | |
| Outcome summary of a job | |
| ### Table of contents | |
| #### Properties | |
| - [info](#info) | |
| - [outcome](#outcome) | |
| ### Properties | |
| #### info | |
| • `Optional` **info**: `string` | |
| ##### Defined in | |
| [src/api/resources/jobs/types/JobOutcome.ts:10](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/jobs/types/JobOutcome.ts#L10) | |
| ___ | |
| #### outcome | |
| • `Optional` **outcome**: `Record`<`string`, `unknown`\> | |
| ##### Defined in | |
| [src/api/resources/jobs/types/JobOutcome.ts:9](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/jobs/types/JobOutcome.ts#L9) | |
| <a name="interfacesflatfilejobsjobplanmd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / [jobs](#modulesflatfilejobsmd) / JobPlan | |
| ## Interface: JobPlan | |
| [Flatfile](#modulesflatfilemd).[jobs](#modulesflatfilejobsmd).JobPlan | |
| The job/plan tuple that contains the full plan and the jobs status | |
| ### Table of contents | |
| #### Properties | |
| - [job](#job) | |
| - [plan](#plan) | |
| ### Properties | |
| #### job | |
| • `Optional` **job**: [`Job`](#interfacesflatfilejobsjobmd) | |
| ##### Defined in | |
| [src/api/resources/jobs/types/JobPlan.ts:11](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/jobs/types/JobPlan.ts#L11) | |
| ___ | |
| #### plan | |
| • `Optional` **plan**: [`JobExecutionPlan`](#interfacesflatfilejobsjobexecutionplanmd) | |
| ##### Defined in | |
| [src/api/resources/jobs/types/JobPlan.ts:12](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/jobs/types/JobPlan.ts#L12) | |
| <a name="interfacesflatfilejobsjobresponsemd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / [jobs](#modulesflatfilejobsmd) / JobResponse | |
| ## Interface: JobResponse | |
| [Flatfile](#modulesflatfilemd).[jobs](#modulesflatfilejobsmd).JobResponse | |
| ### Table of contents | |
| #### Properties | |
| - [data](#data) | |
| ### Properties | |
| #### data | |
| • **data**: [`Job`](#interfacesflatfilejobsjobmd) | |
| ##### Defined in | |
| [src/api/resources/jobs/types/JobResponse.ts:8](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/jobs/types/JobResponse.ts#L8) | |
| <a name="interfacesflatfilejobsjobupdatemd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / [jobs](#modulesflatfilejobsmd) / JobUpdate | |
| ## Interface: JobUpdate | |
| [Flatfile](#modulesflatfilemd).[jobs](#modulesflatfilejobsmd).JobUpdate | |
| A single unit of work that will be executed | |
| ### Table of contents | |
| #### Properties | |
| - [config](#config) | |
| - [outcomeAcknowledgedAt](#outcomeacknowledgedat) | |
| - [progress](#progress) | |
| - [status](#status) | |
| ### Properties | |
| #### config | |
| • `Optional` **config**: [`JobUpdateConfig`](#jobupdateconfig) | |
| ##### Defined in | |
| [src/api/resources/jobs/types/JobUpdate.ts:11](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/jobs/types/JobUpdate.ts#L11) | |
| ___ | |
| #### 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](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/jobs/types/JobUpdate.ts#L17) | |
| ___ | |
| #### progress | |
| • `Optional` **progress**: `number` | |
| the progress of the job | |
| ##### Defined in | |
| [src/api/resources/jobs/types/JobUpdate.ts:15](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/jobs/types/JobUpdate.ts#L15) | |
| ___ | |
| #### status | |
| • `Optional` **status**: [`JobStatus`](#jobstatus-1) | |
| the status of the job | |
| ##### Defined in | |
| [src/api/resources/jobs/types/JobUpdate.ts:13](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/jobs/types/JobUpdate.ts#L13) | |
| <a name="interfacesflatfilejobslistjobsrequestmd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / [jobs](#modulesflatfilejobsmd) / ListJobsRequest | |
| ## Interface: ListJobsRequest | |
| [Flatfile](#modulesflatfilemd).[jobs](#modulesflatfilejobsmd).ListJobsRequest | |
| ### Table of contents | |
| #### Properties | |
| - [environmentId](#environmentid) | |
| - [fileId](#fileid) | |
| - [pageNumber](#pagenumber) | |
| - [pageSize](#pagesize) | |
| - [sortDirection](#sortdirection) | |
| - [spaceId](#spaceid) | |
| - [workbookId](#workbookid) | |
| ### Properties | |
| #### environmentId | |
| • `Optional` **environmentId**: `string` | |
| ##### Defined in | |
| [src/api/resources/jobs/client/requests/ListJobsRequest.ts:8](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/jobs/client/requests/ListJobsRequest.ts#L8) | |
| ___ | |
| #### fileId | |
| • `Optional` **fileId**: `string` | |
| ##### Defined in | |
| [src/api/resources/jobs/client/requests/ListJobsRequest.ts:11](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/jobs/client/requests/ListJobsRequest.ts#L11) | |
| ___ | |
| #### pageNumber | |
| • `Optional` **pageNumber**: `number` | |
| Based on pageSize, which page of jobs to return | |
| ##### Defined in | |
| [src/api/resources/jobs/client/requests/ListJobsRequest.ts:19](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/jobs/client/requests/ListJobsRequest.ts#L19) | |
| ___ | |
| #### 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](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/jobs/client/requests/ListJobsRequest.ts#L15) | |
| ___ | |
| #### sortDirection | |
| • `Optional` **sortDirection**: [`SortDirection`](#sortdirection-1) | |
| ##### Defined in | |
| [src/api/resources/jobs/client/requests/ListJobsRequest.ts:20](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/jobs/client/requests/ListJobsRequest.ts#L20) | |
| ___ | |
| #### spaceId | |
| • `Optional` **spaceId**: `string` | |
| ##### Defined in | |
| [src/api/resources/jobs/client/requests/ListJobsRequest.ts:9](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/jobs/client/requests/ListJobsRequest.ts#L9) | |
| ___ | |
| #### workbookId | |
| • `Optional` **workbookId**: `string` | |
| ##### Defined in | |
| [src/api/resources/jobs/client/requests/ListJobsRequest.ts:10](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/jobs/client/requests/ListJobsRequest.ts#L10) | |
| <a name="interfacesflatfilejobslistjobsresponsemd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / [jobs](#modulesflatfilejobsmd) / ListJobsResponse | |
| ## Interface: ListJobsResponse | |
| [Flatfile](#modulesflatfilemd).[jobs](#modulesflatfilejobsmd).ListJobsResponse | |
| ### Table of contents | |
| #### Properties | |
| - [data](#data) | |
| - [pagination](#pagination) | |
| ### Properties | |
| #### data | |
| • **data**: [`Job`](#interfacesflatfilejobsjobmd)[] | |
| ##### Defined in | |
| [src/api/resources/jobs/types/ListJobsResponse.ts:9](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/jobs/types/ListJobsResponse.ts#L9) | |
| ___ | |
| #### pagination | |
| • `Optional` **pagination**: [`Pagination`](#interfacesflatfilecommonspaginationmd) | |
| ##### Defined in | |
| [src/api/resources/jobs/types/ListJobsResponse.ts:8](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/jobs/types/ListJobsResponse.ts#L8) | |
| <a name="interfacesflatfilejobsmetadatamd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / [jobs](#modulesflatfilejobsmd) / Metadata | |
| ## Interface: Metadata | |
| [Flatfile](#modulesflatfilemd).[jobs](#modulesflatfilejobsmd).Metadata | |
| ### Table of contents | |
| #### Properties | |
| - [certainty](#certainty) | |
| - [source](#source) | |
| ### Properties | |
| #### certainty | |
| • `Optional` **certainty**: [`Certainty`](#certainty-1) | |
| ##### Defined in | |
| [src/api/resources/jobs/types/Metadata.ts:8](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/jobs/types/Metadata.ts#L8) | |
| ___ | |
| #### source | |
| • `Optional` **source**: `string` | |
| ##### Defined in | |
| [src/api/resources/jobs/types/Metadata.ts:9](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/jobs/types/Metadata.ts#L9) | |
| <a name="interfacesflatfilejobsmutatejobconfigmd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / [jobs](#modulesflatfilejobsmd) / MutateJobConfig | |
| ## Interface: MutateJobConfig | |
| [Flatfile](#modulesflatfilemd).[jobs](#modulesflatfilejobsmd).MutateJobConfig | |
| ### Table of contents | |
| #### Properties | |
| - [mutateRecord](#mutaterecord) | |
| - [mutationId](#mutationid) | |
| - [sheetId](#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](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/jobs/types/MutateJobConfig.ts#L10) | |
| ___ | |
| #### 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](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/jobs/types/MutateJobConfig.ts#L12) | |
| ___ | |
| #### sheetId | |
| • **sheetId**: `string` | |
| ##### Defined in | |
| [src/api/resources/jobs/types/MutateJobConfig.ts:8](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/jobs/types/MutateJobConfig.ts#L8) | |
| <a name="interfacesflatfilejobspipelinejobconfigmd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / [jobs](#modulesflatfilejobsmd) / PipelineJobConfig | |
| ## Interface: PipelineJobConfig | |
| [Flatfile](#modulesflatfilemd).[jobs](#modulesflatfilejobsmd).PipelineJobConfig | |
| ### Table of contents | |
| #### Properties | |
| - [destinationSheetId](#destinationsheetid) | |
| - [sourceSheetId](#sourcesheetid) | |
| ### Properties | |
| #### destinationSheetId | |
| • **destinationSheetId**: `string` | |
| ##### Defined in | |
| [src/api/resources/jobs/types/PipelineJobConfig.ts:9](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/jobs/types/PipelineJobConfig.ts#L9) | |
| ___ | |
| #### sourceSheetId | |
| • **sourceSheetId**: `string` | |
| ##### Defined in | |
| [src/api/resources/jobs/types/PipelineJobConfig.ts:8](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/jobs/types/PipelineJobConfig.ts#L8) | |
| <a name="interfacesflatfilejobssourcefieldmd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / [jobs](#modulesflatfilejobsmd) / SourceField | |
| ## Interface: SourceField | |
| [Flatfile](#modulesflatfilemd).[jobs](#modulesflatfilejobsmd).SourceField | |
| ### Table of contents | |
| #### Properties | |
| - [preview](#preview) | |
| - [sourceField](#sourcefield) | |
| ### Properties | |
| #### preview | |
| • `Optional` **preview**: `string`[] | |
| ##### Defined in | |
| [src/api/resources/jobs/types/SourceField.ts:9](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/jobs/types/SourceField.ts#L9) | |
| ___ | |
| #### sourceField | |
| • **sourceField**: [`Property`](#property) | |
| ##### Defined in | |
| [src/api/resources/jobs/types/SourceField.ts:8](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/jobs/types/SourceField.ts#L8) | |
| <a name="interfacesflatfilepropertyarrayablepropertymd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / [property](#modulesflatfilepropertymd) / ArrayableProperty | |
| ## Interface: ArrayableProperty | |
| [Flatfile](#modulesflatfilemd).[property](#modulesflatfilepropertymd).ArrayableProperty | |
| This file was auto-generated by Fern from our API Definition. | |
| ### Hierarchy | |
| - **`ArrayableProperty`** | |
| ↳ [`NumberProperty`](#interfacesflatfilepropertynumberpropertymd) | |
| ↳ [`EnumProperty`](#interfacesflatfilepropertyenumpropertymd) | |
| ↳ [`ReferenceProperty`](#interfacesflatfilepropertyreferencepropertymd) | |
| ### Table of contents | |
| #### Properties | |
| - [isArray](#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](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/property/types/ArrayableProperty.ts#L7) | |
| <a name="interfacesflatfilepropertybasepropertymd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / [property](#modulesflatfilepropertymd) / BaseProperty | |
| ## Interface: BaseProperty | |
| [Flatfile](#modulesflatfilemd).[property](#modulesflatfilepropertymd).BaseProperty | |
| ### Hierarchy | |
| - **`BaseProperty`** | |
| ↳ [`StringProperty`](#interfacesflatfilepropertystringpropertymd) | |
| ↳ [`NumberProperty`](#interfacesflatfilepropertynumberpropertymd) | |
| ↳ [`BooleanProperty`](#interfacesflatfilepropertybooleanpropertymd) | |
| ↳ [`DateProperty`](#interfacesflatfilepropertydatepropertymd) | |
| ↳ [`EnumProperty`](#interfacesflatfilepropertyenumpropertymd) | |
| ↳ [`ReferenceProperty`](#interfacesflatfilepropertyreferencepropertymd) | |
| ### Table of contents | |
| #### Properties | |
| - [constraints](#constraints) | |
| - [description](#description) | |
| - [key](#key) | |
| - [label](#label) | |
| - [metadata](#metadata) | |
| - [readonly](#readonly) | |
| ### Properties | |
| #### constraints | |
| • `Optional` **constraints**: [`Constraint`](#constraint)[] | |
| ##### Defined in | |
| [src/api/resources/property/types/BaseProperty.ts:12](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/property/types/BaseProperty.ts#L12) | |
| ___ | |
| #### description | |
| • `Optional` **description**: `string` | |
| ##### Defined in | |
| [src/api/resources/property/types/BaseProperty.ts:11](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/property/types/BaseProperty.ts#L11) | |
| ___ | |
| #### key | |
| • **key**: `string` | |
| ##### Defined in | |
| [src/api/resources/property/types/BaseProperty.ts:8](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/property/types/BaseProperty.ts#L8) | |
| ___ | |
| #### label | |
| • `Optional` **label**: `string` | |
| User friendly field name | |
| ##### Defined in | |
| [src/api/resources/property/types/BaseProperty.ts:10](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/property/types/BaseProperty.ts#L10) | |
| ___ | |
| #### 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](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/property/types/BaseProperty.ts#L15) | |
| ___ | |
| #### readonly | |
| • `Optional` **readonly**: `boolean` | |
| ##### Defined in | |
| [src/api/resources/property/types/BaseProperty.ts:13](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/property/types/BaseProperty.ts#L13) | |
| <a name="interfacesflatfilepropertybooleanpropertymd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / [property](#modulesflatfilepropertymd) / BooleanProperty | |
| ## Interface: BooleanProperty | |
| [Flatfile](#modulesflatfilemd).[property](#modulesflatfilepropertymd).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`](#interfacesflatfilepropertybasepropertymd) | |
| ↳ **`BooleanProperty`** | |
| ↳↳ [`Boolean`](#interfacesflatfilepropertypropertybooleanmd) | |
| ### Table of contents | |
| #### Properties | |
| - [config](#config) | |
| - [constraints](#constraints) | |
| - [description](#description) | |
| - [key](#key) | |
| - [label](#label) | |
| - [metadata](#metadata) | |
| - [readonly](#readonly) | |
| ### Properties | |
| #### config | |
| • `Optional` **config**: [`BooleanPropertyConfig`](#interfacesflatfilepropertybooleanpropertyconfigmd) | |
| ##### Defined in | |
| [src/api/resources/property/types/BooleanProperty.ts:11](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/property/types/BooleanProperty.ts#L11) | |
| ___ | |
| #### constraints | |
| • `Optional` **constraints**: [`Constraint`](#constraint)[] | |
| ##### Inherited from | |
| [BaseProperty](#interfacesflatfilepropertybasepropertymd).[constraints](#constraints) | |
| ##### Defined in | |
| [src/api/resources/property/types/BaseProperty.ts:12](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/property/types/BaseProperty.ts#L12) | |
| ___ | |
| #### description | |
| • `Optional` **description**: `string` | |
| ##### Inherited from | |
| [BaseProperty](#interfacesflatfilepropertybasepropertymd).[description](#description) | |
| ##### Defined in | |
| [src/api/resources/property/types/BaseProperty.ts:11](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/property/types/BaseProperty.ts#L11) | |
| ___ | |
| #### key | |
| • **key**: `string` | |
| ##### Inherited from | |
| [BaseProperty](#interfacesflatfilepropertybasepropertymd).[key](#key) | |
| ##### Defined in | |
| [src/api/resources/property/types/BaseProperty.ts:8](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/property/types/BaseProperty.ts#L8) | |
| ___ | |
| #### label | |
| • `Optional` **label**: `string` | |
| User friendly field name | |
| ##### Inherited from | |
| [BaseProperty](#interfacesflatfilepropertybasepropertymd).[label](#label) | |
| ##### Defined in | |
| [src/api/resources/property/types/BaseProperty.ts:10](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/property/types/BaseProperty.ts#L10) | |
| ___ | |
| #### metadata | |
| • `Optional` **metadata**: `unknown` | |
| Useful for any contextual metadata regarding the schema. Store any valid json here. | |
| ##### Inherited from | |
| [BaseProperty](#interfacesflatfilepropertybasepropertymd).[metadata](#metadata) | |
| ##### Defined in | |
| [src/api/resources/property/types/BaseProperty.ts:15](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/property/types/BaseProperty.ts#L15) | |
| ___ | |
| #### readonly | |
| • `Optional` **readonly**: `boolean` | |
| ##### Inherited from | |
| [BaseProperty](#interfacesflatfilepropertybasepropertymd).[readonly](#readonly) | |
| ##### Defined in | |
| [src/api/resources/property/types/BaseProperty.ts:13](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/property/types/BaseProperty.ts#L13) | |
| <a name="interfacesflatfilepropertybooleanpropertyconfigmd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / [property](#modulesflatfilepropertymd) / BooleanPropertyConfig | |
| ## Interface: BooleanPropertyConfig | |
| [Flatfile](#modulesflatfilemd).[property](#modulesflatfilepropertymd).BooleanPropertyConfig | |
| This file was auto-generated by Fern from our API Definition. | |
| ### Table of contents | |
| #### Properties | |
| - [allowIndeterminate](#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](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/property/types/BooleanPropertyConfig.ts#L7) | |
| <a name="interfacesflatfilepropertyconstraintcomputedmd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / [property](#modulesflatfilepropertymd) / [Constraint](#modulesflatfilepropertyconstraintmd) / Computed | |
| ## Interface: Computed | |
| [property](#modulesflatfilepropertymd).[Constraint](#modulesflatfilepropertyconstraintmd).Computed | |
| ### Table of contents | |
| #### Properties | |
| - [type](#type) | |
| ### Properties | |
| #### type | |
| • **type**: ``"computed"`` | |
| ##### Defined in | |
| [src/api/resources/property/types/Constraint.ts:19](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/property/types/Constraint.ts#L19) | |
| <a name="interfacesflatfilepropertyconstraintrequiredmd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / [property](#modulesflatfilepropertymd) / [Constraint](#modulesflatfilepropertyconstraintmd) / Required | |
| ## Interface: Required | |
| [property](#modulesflatfilepropertymd).[Constraint](#modulesflatfilepropertyconstraintmd).Required | |
| ### Table of contents | |
| #### Properties | |
| - [type](#type) | |
| ### Properties | |
| #### type | |
| • **type**: ``"required"`` | |
| ##### Defined in | |
| [src/api/resources/property/types/Constraint.ts:11](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/property/types/Constraint.ts#L11) | |
| <a name="interfacesflatfilepropertyconstraintuniquemd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / [property](#modulesflatfilepropertymd) / [Constraint](#modulesflatfilepropertyconstraintmd) / Unique | |
| ## Interface: Unique | |
| [property](#modulesflatfilepropertymd).[Constraint](#modulesflatfilepropertyconstraintmd).Unique | |
| ### Hierarchy | |
| - [`UniqueConstraint`](#interfacesflatfilepropertyuniqueconstraintmd) | |
| ↳ **`Unique`** | |
| ### Table of contents | |
| #### Properties | |
| - [config](#config) | |
| - [type](#type) | |
| ### Properties | |
| #### config | |
| • `Optional` **config**: [`UniqueConstraintConfig`](#interfacesflatfilepropertyuniqueconstraintconfigmd) | |
| ##### Inherited from | |
| [UniqueConstraint](#interfacesflatfilepropertyuniqueconstraintmd).[config](#config) | |
| ##### Defined in | |
| [src/api/resources/property/types/UniqueConstraint.ts:8](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/property/types/UniqueConstraint.ts#L8) | |
| ___ | |
| #### type | |
| • **type**: ``"unique"`` | |
| ##### Defined in | |
| [src/api/resources/property/types/Constraint.ts:15](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/property/types/Constraint.ts#L15) | |
| <a name="interfacesflatfilepropertydatepropertymd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / [property](#modulesflatfilepropertymd) / DateProperty | |
| ## Interface: DateProperty | |
| [Flatfile](#modulesflatfilemd).[property](#modulesflatfilepropertymd).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`](#interfacesflatfilepropertybasepropertymd) | |
| ↳ **`DateProperty`** | |
| ↳↳ [`Date_`](#interfacesflatfilepropertypropertydate_md) | |
| ### Table of contents | |
| #### Properties | |
| - [constraints](#constraints) | |
| - [description](#description) | |
| - [key](#key) | |
| - [label](#label) | |
| - [metadata](#metadata) | |
| - [readonly](#readonly) | |
| ### Properties | |
| #### constraints | |
| • `Optional` **constraints**: [`Constraint`](#constraint)[] | |
| ##### Inherited from | |
| [BaseProperty](#interfacesflatfilepropertybasepropertymd).[constraints](#constraints) | |
| ##### Defined in | |
| [src/api/resources/property/types/BaseProperty.ts:12](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/property/types/BaseProperty.ts#L12) | |
| ___ | |
| #### description | |
| • `Optional` **description**: `string` | |
| ##### Inherited from | |
| [BaseProperty](#interfacesflatfilepropertybasepropertymd).[description](#description) | |
| ##### Defined in | |
| [src/api/resources/property/types/BaseProperty.ts:11](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/property/types/BaseProperty.ts#L11) | |
| ___ | |
| #### key | |
| • **key**: `string` | |
| ##### Inherited from | |
| [BaseProperty](#interfacesflatfilepropertybasepropertymd).[key](#key) | |
| ##### Defined in | |
| [src/api/resources/property/types/BaseProperty.ts:8](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/property/types/BaseProperty.ts#L8) | |
| ___ | |
| #### label | |
| • `Optional` **label**: `string` | |
| User friendly field name | |
| ##### Inherited from | |
| [BaseProperty](#interfacesflatfilepropertybasepropertymd).[label](#label) | |
| ##### Defined in | |
| [src/api/resources/property/types/BaseProperty.ts:10](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/property/types/BaseProperty.ts#L10) | |
| ___ | |
| #### metadata | |
| • `Optional` **metadata**: `unknown` | |
| Useful for any contextual metadata regarding the schema. Store any valid json here. | |
| ##### Inherited from | |
| [BaseProperty](#interfacesflatfilepropertybasepropertymd).[metadata](#metadata) | |
| ##### Defined in | |
| [src/api/resources/property/types/BaseProperty.ts:15](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/property/types/BaseProperty.ts#L15) | |
| ___ | |
| #### readonly | |
| • `Optional` **readonly**: `boolean` | |
| ##### Inherited from | |
| [BaseProperty](#interfacesflatfilepropertybasepropertymd).[readonly](#readonly) | |
| ##### Defined in | |
| [src/api/resources/property/types/BaseProperty.ts:13](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/property/types/BaseProperty.ts#L13) | |
| <a name="interfacesflatfilepropertyenumpropertymd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / [property](#modulesflatfilepropertymd) / EnumProperty | |
| ## Interface: EnumProperty | |
| [Flatfile](#modulesflatfilemd).[property](#modulesflatfilepropertymd).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`](#interfacesflatfilepropertybasepropertymd) | |
| - [`ArrayableProperty`](#interfacesflatfilepropertyarrayablepropertymd) | |
| ↳ **`EnumProperty`** | |
| ↳↳ [`Enum`](#interfacesflatfilepropertypropertyenummd) | |
| ### Table of contents | |
| #### Properties | |
| - [config](#config) | |
| - [constraints](#constraints) | |
| - [description](#description) | |
| - [isArray](#isarray) | |
| - [key](#key) | |
| - [label](#label) | |
| - [metadata](#metadata) | |
| - [multi](#multi) | |
| - [readonly](#readonly) | |
| ### Properties | |
| #### config | |
| • **config**: [`EnumPropertyConfig`](#interfacesflatfilepropertyenumpropertyconfigmd) | |
| ##### Defined in | |
| [src/api/resources/property/types/EnumProperty.ts:13](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/property/types/EnumProperty.ts#L13) | |
| ___ | |
| #### constraints | |
| • `Optional` **constraints**: [`Constraint`](#constraint)[] | |
| ##### Inherited from | |
| [BaseProperty](#interfacesflatfilepropertybasepropertymd).[constraints](#constraints) | |
| ##### Defined in | |
| [src/api/resources/property/types/BaseProperty.ts:12](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/property/types/BaseProperty.ts#L12) | |
| ___ | |
| #### description | |
| • `Optional` **description**: `string` | |
| ##### Inherited from | |
| [BaseProperty](#interfacesflatfilepropertybasepropertymd).[description](#description) | |
| ##### Defined in | |
| [src/api/resources/property/types/BaseProperty.ts:11](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/property/types/BaseProperty.ts#L11) | |
| ___ | |
| #### isArray | |
| • `Optional` **isArray**: `boolean` | |
| Will allow multiple values and store as an array | |
| ##### Inherited from | |
| [ArrayableProperty](#interfacesflatfilepropertyarrayablepropertymd).[isArray](#isarray) | |
| ##### Defined in | |
| [src/api/resources/property/types/ArrayableProperty.ts:7](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/property/types/ArrayableProperty.ts#L7) | |
| ___ | |
| #### key | |
| • **key**: `string` | |
| ##### Inherited from | |
| [BaseProperty](#interfacesflatfilepropertybasepropertymd).[key](#key) | |
| ##### Defined in | |
| [src/api/resources/property/types/BaseProperty.ts:8](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/property/types/BaseProperty.ts#L8) | |
| ___ | |
| #### label | |
| • `Optional` **label**: `string` | |
| User friendly field name | |
| ##### Inherited from | |
| [BaseProperty](#interfacesflatfilepropertybasepropertymd).[label](#label) | |
| ##### Defined in | |
| [src/api/resources/property/types/BaseProperty.ts:10](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/property/types/BaseProperty.ts#L10) | |
| ___ | |
| #### metadata | |
| • `Optional` **metadata**: `unknown` | |
| Useful for any contextual metadata regarding the schema. Store any valid json here. | |
| ##### Inherited from | |
| [BaseProperty](#interfacesflatfilepropertybasepropertymd).[metadata](#metadata) | |
| ##### Defined in | |
| [src/api/resources/property/types/BaseProperty.ts:15](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/property/types/BaseProperty.ts#L15) | |
| ___ | |
| #### 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](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/property/types/EnumProperty.ts#L12) | |
| ___ | |
| #### readonly | |
| • `Optional` **readonly**: `boolean` | |
| ##### Inherited from | |
| [BaseProperty](#interfacesflatfilepropertybasepropertymd).[readonly](#readonly) | |
| ##### Defined in | |
| [src/api/resources/property/types/BaseProperty.ts:13](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/property/types/BaseProperty.ts#L13) | |
| <a name="interfacesflatfilepropertyenumpropertyconfigmd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / [property](#modulesflatfilepropertymd) / EnumPropertyConfig | |
| ## Interface: EnumPropertyConfig | |
| [Flatfile](#modulesflatfilemd).[property](#modulesflatfilepropertymd).EnumPropertyConfig | |
| ### Table of contents | |
| #### Properties | |
| - [allowCustom](#allowcustom) | |
| - [options](#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](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/property/types/EnumPropertyConfig.ts#L9) | |
| ___ | |
| #### options | |
| • **options**: [`EnumPropertyOption`](#interfacesflatfilepropertyenumpropertyoptionmd)[] | |
| ##### Defined in | |
| [src/api/resources/property/types/EnumPropertyConfig.ts:10](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/property/types/EnumPropertyConfig.ts#L10) | |
| <a name="interfacesflatfilepropertyenumpropertyoptionmd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / [property](#modulesflatfilepropertymd) / EnumPropertyOption | |
| ## Interface: EnumPropertyOption | |
| [Flatfile](#modulesflatfilemd).[property](#modulesflatfilepropertymd).EnumPropertyOption | |
| This file was auto-generated by Fern from our API Definition. | |
| ### Table of contents | |
| #### Properties | |
| - [color](#color) | |
| - [icon](#icon) | |
| - [label](#label) | |
| - [meta](#meta) | |
| - [value](#value) | |
| ### Properties | |
| #### color | |
| • `Optional` **color**: `string` | |
| An optional color to assign this option | |
| ##### Defined in | |
| [src/api/resources/property/types/EnumPropertyOption.ts:9](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/property/types/EnumPropertyOption.ts#L9) | |
| ___ | |
| #### icon | |
| • `Optional` **icon**: `string` | |
| A reference pointer to a previously registered icon | |
| ##### Defined in | |
| [src/api/resources/property/types/EnumPropertyOption.ts:11](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/property/types/EnumPropertyOption.ts#L11) | |
| ___ | |
| #### 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](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/property/types/EnumPropertyOption.ts#L7) | |
| ___ | |
| #### 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](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/property/types/EnumPropertyOption.ts#L13) | |
| ___ | |
| #### 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](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/property/types/EnumPropertyOption.ts#L15) | |
| <a name="interfacesflatfilepropertynumberconfigmd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / [property](#modulesflatfilepropertymd) / NumberConfig | |
| ## Interface: NumberConfig | |
| [Flatfile](#modulesflatfilemd).[property](#modulesflatfilepropertymd).NumberConfig | |
| **`Example`** | |
| ```ts | |
| { | |
| * decimalPlaces: 2 | |
| * } | |
| ``` | |
| ### Table of contents | |
| #### Properties | |
| - [decimalPlaces](#decimalplaces) | |
| ### Properties | |
| #### decimalPlaces | |
| • **decimalPlaces**: `number` | |
| Number of decimal places to round data to | |
| ##### Defined in | |
| [src/api/resources/property/types/NumberConfig.ts:13](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/property/types/NumberConfig.ts#L13) | |
| <a name="interfacesflatfilepropertynumberpropertymd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / [property](#modulesflatfilepropertymd) / NumberProperty | |
| ## Interface: NumberProperty | |
| [Flatfile](#modulesflatfilemd).[property](#modulesflatfilepropertymd).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`](#interfacesflatfilepropertybasepropertymd) | |
| - [`ArrayableProperty`](#interfacesflatfilepropertyarrayablepropertymd) | |
| ↳ **`NumberProperty`** | |
| ↳↳ [`Number`](#interfacesflatfilepropertypropertynumbermd) | |
| ### Table of contents | |
| #### Properties | |
| - [config](#config) | |
| - [constraints](#constraints) | |
| - [description](#description) | |
| - [isArray](#isarray) | |
| - [key](#key) | |
| - [label](#label) | |
| - [metadata](#metadata) | |
| - [readonly](#readonly) | |
| ### Properties | |
| #### config | |
| • `Optional` **config**: [`NumberConfig`](#interfacesflatfilepropertynumberconfigmd) | |
| ##### Defined in | |
| [src/api/resources/property/types/NumberProperty.ts:11](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/property/types/NumberProperty.ts#L11) | |
| ___ | |
| #### constraints | |
| • `Optional` **constraints**: [`Constraint`](#constraint)[] | |
| ##### Inherited from | |
| [BaseProperty](#interfacesflatfilepropertybasepropertymd).[constraints](#constraints) | |
| ##### Defined in | |
| [src/api/resources/property/types/BaseProperty.ts:12](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/property/types/BaseProperty.ts#L12) | |
| ___ | |
| #### description | |
| • `Optional` **description**: `string` | |
| ##### Inherited from | |
| [BaseProperty](#interfacesflatfilepropertybasepropertymd).[description](#description) | |
| ##### Defined in | |
| [src/api/resources/property/types/BaseProperty.ts:11](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/property/types/BaseProperty.ts#L11) | |
| ___ | |
| #### isArray | |
| • `Optional` **isArray**: `boolean` | |
| Will allow multiple values and store as an array | |
| ##### Inherited from | |
| [ArrayableProperty](#interfacesflatfilepropertyarrayablepropertymd).[isArray](#isarray) | |
| ##### Defined in | |
| [src/api/resources/property/types/ArrayableProperty.ts:7](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/property/types/ArrayableProperty.ts#L7) | |
| ___ | |
| #### key | |
| • **key**: `string` | |
| ##### Inherited from | |
| [BaseProperty](#interfacesflatfilepropertybasepropertymd).[key](#key) | |
| ##### Defined in | |
| [src/api/resources/property/types/BaseProperty.ts:8](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/property/types/BaseProperty.ts#L8) | |
| ___ | |
| #### label | |
| • `Optional` **label**: `string` | |
| User friendly field name | |
| ##### Inherited from | |
| [BaseProperty](#interfacesflatfilepropertybasepropertymd).[label](#label) | |
| ##### Defined in | |
| [src/api/resources/property/types/BaseProperty.ts:10](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/property/types/BaseProperty.ts#L10) | |
| ___ | |
| #### metadata | |
| • `Optional` **metadata**: `unknown` | |
| Useful for any contextual metadata regarding the schema. Store any valid json here. | |
| ##### Inherited from | |
| [BaseProperty](#interfacesflatfilepropertybasepropertymd).[metadata](#metadata) | |
| ##### Defined in | |
| [src/api/resources/property/types/BaseProperty.ts:15](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/property/types/BaseProperty.ts#L15) | |
| ___ | |
| #### readonly | |
| • `Optional` **readonly**: `boolean` | |
| ##### Inherited from | |
| [BaseProperty](#interfacesflatfilepropertybasepropertymd).[readonly](#readonly) | |
| ##### Defined in | |
| [src/api/resources/property/types/BaseProperty.ts:13](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/property/types/BaseProperty.ts#L13) | |
| <a name="interfacesflatfilepropertypropertybooleanmd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / [property](#modulesflatfilepropertymd) / [Property](#modulesflatfilepropertypropertymd) / Boolean | |
| ## Interface: Boolean | |
| [property](#modulesflatfilepropertymd).[Property](#modulesflatfilepropertypropertymd).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`](#interfacesflatfilepropertybooleanpropertymd) | |
| ↳ **`Boolean`** | |
| ### Table of contents | |
| #### Properties | |
| - [config](#config) | |
| - [constraints](#constraints) | |
| - [description](#description) | |
| - [key](#key) | |
| - [label](#label) | |
| - [metadata](#metadata) | |
| - [readonly](#readonly) | |
| - [type](#type) | |
| ### Properties | |
| #### config | |
| • `Optional` **config**: [`BooleanPropertyConfig`](#interfacesflatfilepropertybooleanpropertyconfigmd) | |
| ##### Inherited from | |
| [BooleanProperty](#interfacesflatfilepropertybooleanpropertymd).[config](#config) | |
| ##### Defined in | |
| [src/api/resources/property/types/BooleanProperty.ts:11](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/property/types/BooleanProperty.ts#L11) | |
| ___ | |
| #### constraints | |
| • `Optional` **constraints**: [`Constraint`](#constraint)[] | |
| ##### Inherited from | |
| [BooleanProperty](#interfacesflatfilepropertybooleanpropertymd).[constraints](#constraints) | |
| ##### Defined in | |
| [src/api/resources/property/types/BaseProperty.ts:12](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/property/types/BaseProperty.ts#L12) | |
| ___ | |
| #### description | |
| • `Optional` **description**: `string` | |
| ##### Inherited from | |
| [BooleanProperty](#interfacesflatfilepropertybooleanpropertymd).[description](#description) | |
| ##### Defined in | |
| [src/api/resources/property/types/BaseProperty.ts:11](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/property/types/BaseProperty.ts#L11) | |
| ___ | |
| #### key | |
| • **key**: `string` | |
| ##### Inherited from | |
| [BooleanProperty](#interfacesflatfilepropertybooleanpropertymd).[key](#key) | |
| ##### Defined in | |
| [src/api/resources/property/types/BaseProperty.ts:8](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/property/types/BaseProperty.ts#L8) | |
| ___ | |
| #### label | |
| • `Optional` **label**: `string` | |
| User friendly field name | |
| ##### Inherited from | |
| [BooleanProperty](#interfacesflatfilepropertybooleanpropertymd).[label](#label) | |
| ##### Defined in | |
| [src/api/resources/property/types/BaseProperty.ts:10](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/property/types/BaseProperty.ts#L10) | |
| ___ | |
| #### metadata | |
| • `Optional` **metadata**: `unknown` | |
| Useful for any contextual metadata regarding the schema. Store any valid json here. | |
| ##### Inherited from | |
| [BooleanProperty](#interfacesflatfilepropertybooleanpropertymd).[metadata](#metadata) | |
| ##### Defined in | |
| [src/api/resources/property/types/BaseProperty.ts:15](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/property/types/BaseProperty.ts#L15) | |
| ___ | |
| #### readonly | |
| • `Optional` **readonly**: `boolean` | |
| ##### Inherited from | |
| [BooleanProperty](#interfacesflatfilepropertybooleanpropertymd).[readonly](#readonly) | |
| ##### Defined in | |
| [src/api/resources/property/types/BaseProperty.ts:13](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/property/types/BaseProperty.ts#L13) | |
| ___ | |
| #### type | |
| • **type**: ``"boolean"`` | |
| ##### Defined in | |
| [src/api/resources/property/types/Property.ts:104](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/property/types/Property.ts#L104) | |
| <a name="interfacesflatfilepropertypropertydate_md"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / [property](#modulesflatfilepropertymd) / [Property](#modulesflatfilepropertypropertymd) / Date\_ | |
| ## Interface: Date\_ | |
| [property](#modulesflatfilepropertymd).[Property](#modulesflatfilepropertypropertymd).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`](#interfacesflatfilepropertydatepropertymd) | |
| ↳ **`Date_`** | |
| ### Table of contents | |
| #### Properties | |
| - [constraints](#constraints) | |
| - [description](#description) | |
| - [key](#key) | |
| - [label](#label) | |
| - [metadata](#metadata) | |
| - [readonly](#readonly) | |
| - [type](#type) | |
| ### Properties | |
| #### constraints | |
| • `Optional` **constraints**: [`Constraint`](#constraint)[] | |
| ##### Inherited from | |
| [DateProperty](#interfacesflatfilepropertydatepropertymd).[constraints](#constraints) | |
| ##### Defined in | |
| [src/api/resources/property/types/BaseProperty.ts:12](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/property/types/BaseProperty.ts#L12) | |
| ___ | |
| #### description | |
| • `Optional` **description**: `string` | |
| ##### Inherited from | |
| [DateProperty](#interfacesflatfilepropertydatepropertymd).[description](#description) | |
| ##### Defined in | |
| [src/api/resources/property/types/BaseProperty.ts:11](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/property/types/BaseProperty.ts#L11) | |
| ___ | |
| #### key | |
| • **key**: `string` | |
| ##### Inherited from | |
| [DateProperty](#interfacesflatfilepropertydatepropertymd).[key](#key) | |
| ##### Defined in | |
| [src/api/resources/property/types/BaseProperty.ts:8](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/property/types/BaseProperty.ts#L8) | |
| ___ | |
| #### label | |
| • `Optional` **label**: `string` | |
| User friendly field name | |
| ##### Inherited from | |
| [DateProperty](#interfacesflatfilepropertydatepropertymd).[label](#label) | |
| ##### Defined in | |
| [src/api/resources/property/types/BaseProperty.ts:10](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/property/types/BaseProperty.ts#L10) | |
| ___ | |
| #### metadata | |
| • `Optional` **metadata**: `unknown` | |
| Useful for any contextual metadata regarding the schema. Store any valid json here. | |
| ##### Inherited from | |
| [DateProperty](#interfacesflatfilepropertydatepropertymd).[metadata](#metadata) | |
| ##### Defined in | |
| [src/api/resources/property/types/BaseProperty.ts:15](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/property/types/BaseProperty.ts#L15) | |
| ___ | |
| #### readonly | |
| • `Optional` **readonly**: `boolean` | |
| ##### Inherited from | |
| [DateProperty](#interfacesflatfilepropertydatepropertymd).[readonly](#readonly) | |
| ##### Defined in | |
| [src/api/resources/property/types/BaseProperty.ts:13](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/property/types/BaseProperty.ts#L13) | |
| ___ | |
| #### type | |
| • **type**: ``"date"`` | |
| ##### Defined in | |
| [src/api/resources/property/types/Property.ts:108](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/property/types/Property.ts#L108) | |
| <a name="interfacesflatfilepropertypropertyenummd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / [property](#modulesflatfilepropertymd) / [Property](#modulesflatfilepropertypropertymd) / Enum | |
| ## Interface: Enum | |
| [property](#modulesflatfilepropertymd).[Property](#modulesflatfilepropertypropertymd).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`](#interfacesflatfilepropertyenumpropertymd) | |
| ↳ **`Enum`** | |
| ### Table of contents | |
| #### Properties | |
| - [config](#config) | |
| - [constraints](#constraints) | |
| - [description](#description) | |
| - [isArray](#isarray) | |
| - [key](#key) | |
| - [label](#label) | |
| - [metadata](#metadata) | |
| - [multi](#multi) | |
| - [readonly](#readonly) | |
| - [type](#type) | |
| ### Properties | |
| #### config | |
| • **config**: [`EnumPropertyConfig`](#interfacesflatfilepropertyenumpropertyconfigmd) | |
| ##### Inherited from | |
| [EnumProperty](#interfacesflatfilepropertyenumpropertymd).[config](#config) | |
| ##### Defined in | |
| [src/api/resources/property/types/EnumProperty.ts:13](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/property/types/EnumProperty.ts#L13) | |
| ___ | |
| #### constraints | |
| • `Optional` **constraints**: [`Constraint`](#constraint)[] | |
| ##### Inherited from | |
| [EnumProperty](#interfacesflatfilepropertyenumpropertymd).[constraints](#constraints) | |
| ##### Defined in | |
| [src/api/resources/property/types/BaseProperty.ts:12](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/property/types/BaseProperty.ts#L12) | |
| ___ | |
| #### description | |
| • `Optional` **description**: `string` | |
| ##### Inherited from | |
| [EnumProperty](#interfacesflatfilepropertyenumpropertymd).[description](#description) | |
| ##### Defined in | |
| [src/api/resources/property/types/BaseProperty.ts:11](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/property/types/BaseProperty.ts#L11) | |
| ___ | |
| #### isArray | |
| • `Optional` **isArray**: `boolean` | |
| Will allow multiple values and store as an array | |
| ##### Inherited from | |
| [EnumProperty](#interfacesflatfilepropertyenumpropertymd).[isArray](#isarray) | |
| ##### Defined in | |
| [src/api/resources/property/types/ArrayableProperty.ts:7](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/property/types/ArrayableProperty.ts#L7) | |
| ___ | |
| #### key | |
| • **key**: `string` | |
| ##### Inherited from | |
| [EnumProperty](#interfacesflatfilepropertyenumpropertymd).[key](#key) | |
| ##### Defined in | |
| [src/api/resources/property/types/BaseProperty.ts:8](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/property/types/BaseProperty.ts#L8) | |
| ___ | |
| #### label | |
| • `Optional` **label**: `string` | |
| User friendly field name | |
| ##### Inherited from | |
| [EnumProperty](#interfacesflatfilepropertyenumpropertymd).[label](#label) | |
| ##### Defined in | |
| [src/api/resources/property/types/BaseProperty.ts:10](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/property/types/BaseProperty.ts#L10) | |
| ___ | |
| #### metadata | |
| • `Optional` **metadata**: `unknown` | |
| Useful for any contextual metadata regarding the schema. Store any valid json here. | |
| ##### Inherited from | |
| [EnumProperty](#interfacesflatfilepropertyenumpropertymd).[metadata](#metadata) | |
| ##### Defined in | |
| [src/api/resources/property/types/BaseProperty.ts:15](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/property/types/BaseProperty.ts#L15) | |
| ___ | |
| #### 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](#interfacesflatfilepropertyenumpropertymd).[multi](#multi) | |
| ##### Defined in | |
| [src/api/resources/property/types/EnumProperty.ts:12](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/property/types/EnumProperty.ts#L12) | |
| ___ | |
| #### readonly | |
| • `Optional` **readonly**: `boolean` | |
| ##### Inherited from | |
| [EnumProperty](#interfacesflatfilepropertyenumpropertymd).[readonly](#readonly) | |
| ##### Defined in | |
| [src/api/resources/property/types/BaseProperty.ts:13](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/property/types/BaseProperty.ts#L13) | |
| ___ | |
| #### type | |
| • **type**: ``"enum"`` | |
| ##### Defined in | |
| [src/api/resources/property/types/Property.ts:112](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/property/types/Property.ts#L112) | |
| <a name="interfacesflatfilepropertypropertynumbermd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / [property](#modulesflatfilepropertymd) / [Property](#modulesflatfilepropertypropertymd) / Number | |
| ## Interface: Number | |
| [property](#modulesflatfilepropertymd).[Property](#modulesflatfilepropertypropertymd).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`](#interfacesflatfilepropertynumberpropertymd) | |
| ↳ **`Number`** | |
| ### Table of contents | |
| #### Properties | |
| - [config](#config) | |
| - [constraints](#constraints) | |
| - [description](#description) | |
| - [isArray](#isarray) | |
| - [key](#key) | |
| - [label](#label) | |
| - [metadata](#metadata) | |
| - [readonly](#readonly) | |
| - [type](#type) | |
| ### Properties | |
| #### config | |
| • `Optional` **config**: [`NumberConfig`](#interfacesflatfilepropertynumberconfigmd) | |
| ##### Inherited from | |
| [NumberProperty](#interfacesflatfilepropertynumberpropertymd).[config](#config) | |
| ##### Defined in | |
| [src/api/resources/property/types/NumberProperty.ts:11](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/property/types/NumberProperty.ts#L11) | |
| ___ | |
| #### constraints | |
| • `Optional` **constraints**: [`Constraint`](#constraint)[] | |
| ##### Inherited from | |
| [NumberProperty](#interfacesflatfilepropertynumberpropertymd).[constraints](#constraints) | |
| ##### Defined in | |
| [src/api/resources/property/types/BaseProperty.ts:12](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/property/types/BaseProperty.ts#L12) | |
| ___ | |
| #### description | |
| • `Optional` **description**: `string` | |
| ##### Inherited from | |
| [NumberProperty](#interfacesflatfilepropertynumberpropertymd).[description](#description) | |
| ##### Defined in | |
| [src/api/resources/property/types/BaseProperty.ts:11](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/property/types/BaseProperty.ts#L11) | |
| ___ | |
| #### isArray | |
| • `Optional` **isArray**: `boolean` | |
| Will allow multiple values and store as an array | |
| ##### Inherited from | |
| [NumberProperty](#interfacesflatfilepropertynumberpropertymd).[isArray](#isarray) | |
| ##### Defined in | |
| [src/api/resources/property/types/ArrayableProperty.ts:7](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/property/types/ArrayableProperty.ts#L7) | |
| ___ | |
| #### key | |
| • **key**: `string` | |
| ##### Inherited from | |
| [NumberProperty](#interfacesflatfilepropertynumberpropertymd).[key](#key) | |
| ##### Defined in | |
| [src/api/resources/property/types/BaseProperty.ts:8](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/property/types/BaseProperty.ts#L8) | |
| ___ | |
| #### label | |
| • `Optional` **label**: `string` | |
| User friendly field name | |
| ##### Inherited from | |
| [NumberProperty](#interfacesflatfilepropertynumberpropertymd).[label](#label) | |
| ##### Defined in | |
| [src/api/resources/property/types/BaseProperty.ts:10](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/property/types/BaseProperty.ts#L10) | |
| ___ | |
| #### metadata | |
| • `Optional` **metadata**: `unknown` | |
| Useful for any contextual metadata regarding the schema. Store any valid json here. | |
| ##### Inherited from | |
| [NumberProperty](#interfacesflatfilepropertynumberpropertymd).[metadata](#metadata) | |
| ##### Defined in | |
| [src/api/resources/property/types/BaseProperty.ts:15](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/property/types/BaseProperty.ts#L15) | |
| ___ | |
| #### readonly | |
| • `Optional` **readonly**: `boolean` | |
| ##### Inherited from | |
| [NumberProperty](#interfacesflatfilepropertynumberpropertymd).[readonly](#readonly) | |
| ##### Defined in | |
| [src/api/resources/property/types/BaseProperty.ts:13](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/property/types/BaseProperty.ts#L13) | |
| ___ | |
| #### type | |
| • **type**: ``"number"`` | |
| ##### Defined in | |
| [src/api/resources/property/types/Property.ts:100](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/property/types/Property.ts#L100) | |
| <a name="interfacesflatfilepropertypropertyreferencemd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / [property](#modulesflatfilepropertymd) / [Property](#modulesflatfilepropertypropertymd) / Reference | |
| ## Interface: Reference | |
| [property](#modulesflatfilepropertymd).[Property](#modulesflatfilepropertypropertymd).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`](#interfacesflatfilepropertyreferencepropertymd) | |
| ↳ **`Reference`** | |
| ### Table of contents | |
| #### Properties | |
| - [config](#config) | |
| - [constraints](#constraints) | |
| - [description](#description) | |
| - [isArray](#isarray) | |
| - [key](#key) | |
| - [label](#label) | |
| - [metadata](#metadata) | |
| - [readonly](#readonly) | |
| - [type](#type) | |
| ### Properties | |
| #### config | |
| • **config**: [`ReferencePropertyConfig`](#interfacesflatfilepropertyreferencepropertyconfigmd) | |
| ##### Inherited from | |
| [ReferenceProperty](#interfacesflatfilepropertyreferencepropertymd).[config](#config) | |
| ##### Defined in | |
| [src/api/resources/property/types/ReferenceProperty.ts:11](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/property/types/ReferenceProperty.ts#L11) | |
| ___ | |
| #### constraints | |
| • `Optional` **constraints**: [`Constraint`](#constraint)[] | |
| ##### Inherited from | |
| [ReferenceProperty](#interfacesflatfilepropertyreferencepropertymd).[constraints](#constraints) | |
| ##### Defined in | |
| [src/api/resources/property/types/BaseProperty.ts:12](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/property/types/BaseProperty.ts#L12) | |
| ___ | |
| #### description | |
| • `Optional` **description**: `string` | |
| ##### Inherited from | |
| [ReferenceProperty](#interfacesflatfilepropertyreferencepropertymd).[description](#description) | |
| ##### Defined in | |
| [src/api/resources/property/types/BaseProperty.ts:11](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/property/types/BaseProperty.ts#L11) | |
| ___ | |
| #### isArray | |
| • `Optional` **isArray**: `boolean` | |
| Will allow multiple values and store as an array | |
| ##### Inherited from | |
| [ReferenceProperty](#interfacesflatfilepropertyreferencepropertymd).[isArray](#isarray) | |
| ##### Defined in | |
| [src/api/resources/property/types/ArrayableProperty.ts:7](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/property/types/ArrayableProperty.ts#L7) | |
| ___ | |
| #### key | |
| • **key**: `string` | |
| ##### Inherited from | |
| [ReferenceProperty](#interfacesflatfilepropertyreferencepropertymd).[key](#key) | |
| ##### Defined in | |
| [src/api/resources/property/types/BaseProperty.ts:8](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/property/types/BaseProperty.ts#L8) | |
| ___ | |
| #### label | |
| • `Optional` **label**: `string` | |
| User friendly field name | |
| ##### Inherited from | |
| [ReferenceProperty](#interfacesflatfilepropertyreferencepropertymd).[label](#label) | |
| ##### Defined in | |
| [src/api/resources/property/types/BaseProperty.ts:10](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/property/types/BaseProperty.ts#L10) | |
| ___ | |
| #### metadata | |
| • `Optional` **metadata**: `unknown` | |
| Useful for any contextual metadata regarding the schema. Store any valid json here. | |
| ##### Inherited from | |
| [ReferenceProperty](#interfacesflatfilepropertyreferencepropertymd).[metadata](#metadata) | |
| ##### Defined in | |
| [src/api/resources/property/types/BaseProperty.ts:15](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/property/types/BaseProperty.ts#L15) | |
| ___ | |
| #### readonly | |
| • `Optional` **readonly**: `boolean` | |
| ##### Inherited from | |
| [ReferenceProperty](#interfacesflatfilepropertyreferencepropertymd).[readonly](#readonly) | |
| ##### Defined in | |
| [src/api/resources/property/types/BaseProperty.ts:13](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/property/types/BaseProperty.ts#L13) | |
| ___ | |
| #### type | |
| • **type**: ``"reference"`` | |
| ##### Defined in | |
| [src/api/resources/property/types/Property.ts:116](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/property/types/Property.ts#L116) | |
| <a name="interfacesflatfilepropertypropertystringmd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / [property](#modulesflatfilepropertymd) / [Property](#modulesflatfilepropertypropertymd) / String | |
| ## Interface: String | |
| [property](#modulesflatfilepropertymd).[Property](#modulesflatfilepropertypropertymd).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`](#interfacesflatfilepropertystringpropertymd) | |
| ↳ **`String`** | |
| ### Table of contents | |
| #### Properties | |
| - [config](#config) | |
| - [constraints](#constraints) | |
| - [description](#description) | |
| - [key](#key) | |
| - [label](#label) | |
| - [metadata](#metadata) | |
| - [readonly](#readonly) | |
| - [type](#type) | |
| ### Properties | |
| #### config | |
| • `Optional` **config**: [`StringConfig`](#interfacesflatfilepropertystringconfigmd) | |
| ##### Inherited from | |
| [StringProperty](#interfacesflatfilepropertystringpropertymd).[config](#config) | |
| ##### Defined in | |
| [src/api/resources/property/types/StringProperty.ts:11](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/property/types/StringProperty.ts#L11) | |
| ___ | |
| #### constraints | |
| • `Optional` **constraints**: [`Constraint`](#constraint)[] | |
| ##### Inherited from | |
| [StringProperty](#interfacesflatfilepropertystringpropertymd).[constraints](#constraints) | |
| ##### Defined in | |
| [src/api/resources/property/types/BaseProperty.ts:12](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/property/types/BaseProperty.ts#L12) | |
| ___ | |
| #### description | |
| • `Optional` **description**: `string` | |
| ##### Inherited from | |
| [StringProperty](#interfacesflatfilepropertystringpropertymd).[description](#description) | |
| ##### Defined in | |
| [src/api/resources/property/types/BaseProperty.ts:11](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/property/types/BaseProperty.ts#L11) | |
| ___ | |
| #### key | |
| • **key**: `string` | |
| ##### Inherited from | |
| [StringProperty](#interfacesflatfilepropertystringpropertymd).[key](#key) | |
| ##### Defined in | |
| [src/api/resources/property/types/BaseProperty.ts:8](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/property/types/BaseProperty.ts#L8) | |
| ___ | |
| #### label | |
| • `Optional` **label**: `string` | |
| User friendly field name | |
| ##### Inherited from | |
| [StringProperty](#interfacesflatfilepropertystringpropertymd).[label](#label) | |
| ##### Defined in | |
| [src/api/resources/property/types/BaseProperty.ts:10](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/property/types/BaseProperty.ts#L10) | |
| ___ | |
| #### metadata | |
| • `Optional` **metadata**: `unknown` | |
| Useful for any contextual metadata regarding the schema. Store any valid json here. | |
| ##### Inherited from | |
| [StringProperty](#interfacesflatfilepropertystringpropertymd).[metadata](#metadata) | |
| ##### Defined in | |
| [src/api/resources/property/types/BaseProperty.ts:15](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/property/types/BaseProperty.ts#L15) | |
| ___ | |
| #### readonly | |
| • `Optional` **readonly**: `boolean` | |
| ##### Inherited from | |
| [StringProperty](#interfacesflatfilepropertystringpropertymd).[readonly](#readonly) | |
| ##### Defined in | |
| [src/api/resources/property/types/BaseProperty.ts:13](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/property/types/BaseProperty.ts#L13) | |
| ___ | |
| #### type | |
| • **type**: ``"string"`` | |
| ##### Defined in | |
| [src/api/resources/property/types/Property.ts:96](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/property/types/Property.ts#L96) | |
| <a name="interfacesflatfilepropertyreferencepropertymd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / [property](#modulesflatfilepropertymd) / ReferenceProperty | |
| ## Interface: ReferenceProperty | |
| [Flatfile](#modulesflatfilemd).[property](#modulesflatfilepropertymd).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`](#interfacesflatfilepropertybasepropertymd) | |
| - [`ArrayableProperty`](#interfacesflatfilepropertyarrayablepropertymd) | |
| ↳ **`ReferenceProperty`** | |
| ↳↳ [`Reference`](#interfacesflatfilepropertypropertyreferencemd) | |
| ### Table of contents | |
| #### Properties | |
| - [config](#config) | |
| - [constraints](#constraints) | |
| - [description](#description) | |
| - [isArray](#isarray) | |
| - [key](#key) | |
| - [label](#label) | |
| - [metadata](#metadata) | |
| - [readonly](#readonly) | |
| ### Properties | |
| #### config | |
| • **config**: [`ReferencePropertyConfig`](#interfacesflatfilepropertyreferencepropertyconfigmd) | |
| ##### Defined in | |
| [src/api/resources/property/types/ReferenceProperty.ts:11](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/property/types/ReferenceProperty.ts#L11) | |
| ___ | |
| #### constraints | |
| • `Optional` **constraints**: [`Constraint`](#constraint)[] | |
| ##### Inherited from | |
| [BaseProperty](#interfacesflatfilepropertybasepropertymd).[constraints](#constraints) | |
| ##### Defined in | |
| [src/api/resources/property/types/BaseProperty.ts:12](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/property/types/BaseProperty.ts#L12) | |
| ___ | |
| #### description | |
| • `Optional` **description**: `string` | |
| ##### Inherited from | |
| [BaseProperty](#interfacesflatfilepropertybasepropertymd).[description](#description) | |
| ##### Defined in | |
| [src/api/resources/property/types/BaseProperty.ts:11](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/property/types/BaseProperty.ts#L11) | |
| ___ | |
| #### isArray | |
| • `Optional` **isArray**: `boolean` | |
| Will allow multiple values and store as an array | |
| ##### Inherited from | |
| [ArrayableProperty](#interfacesflatfilepropertyarrayablepropertymd).[isArray](#isarray) | |
| ##### Defined in | |
| [src/api/resources/property/types/ArrayableProperty.ts:7](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/property/types/ArrayableProperty.ts#L7) | |
| ___ | |
| #### key | |
| • **key**: `string` | |
| ##### Inherited from | |
| [BaseProperty](#interfacesflatfilepropertybasepropertymd).[key](#key) | |
| ##### Defined in | |
| [src/api/resources/property/types/BaseProperty.ts:8](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/property/types/BaseProperty.ts#L8) | |
| ___ | |
| #### label | |
| • `Optional` **label**: `string` | |
| User friendly field name | |
| ##### Inherited from | |
| [BaseProperty](#interfacesflatfilepropertybasepropertymd).[label](#label) | |
| ##### Defined in | |
| [src/api/resources/property/types/BaseProperty.ts:10](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/property/types/BaseProperty.ts#L10) | |
| ___ | |
| #### metadata | |
| • `Optional` **metadata**: `unknown` | |
| Useful for any contextual metadata regarding the schema. Store any valid json here. | |
| ##### Inherited from | |
| [BaseProperty](#interfacesflatfilepropertybasepropertymd).[metadata](#metadata) | |
| ##### Defined in | |
| [src/api/resources/property/types/BaseProperty.ts:15](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/property/types/BaseProperty.ts#L15) | |
| ___ | |
| #### readonly | |
| • `Optional` **readonly**: `boolean` | |
| ##### Inherited from | |
| [BaseProperty](#interfacesflatfilepropertybasepropertymd).[readonly](#readonly) | |
| ##### Defined in | |
| [src/api/resources/property/types/BaseProperty.ts:13](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/property/types/BaseProperty.ts#L13) | |
| <a name="interfacesflatfilepropertyreferencepropertyconfigmd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / [property](#modulesflatfilepropertymd) / ReferencePropertyConfig | |
| ## Interface: ReferencePropertyConfig | |
| [Flatfile](#modulesflatfilemd).[property](#modulesflatfilepropertymd).ReferencePropertyConfig | |
| ### Table of contents | |
| #### Properties | |
| - [key](#key) | |
| - [ref](#ref) | |
| - [relationship](#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](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/property/types/ReferencePropertyConfig.ts#L11) | |
| ___ | |
| #### 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](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/property/types/ReferencePropertyConfig.ts#L9) | |
| ___ | |
| #### relationship | |
| • **relationship**: [`ReferencePropertyRelationship`](#referencepropertyrelationship-1) | |
| The type of relationship this defines | |
| ##### Defined in | |
| [src/api/resources/property/types/ReferencePropertyConfig.ts:13](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/property/types/ReferencePropertyConfig.ts#L13) | |
| <a name="interfacesflatfilepropertystringconfigmd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / [property](#modulesflatfilepropertymd) / StringConfig | |
| ## Interface: StringConfig | |
| [Flatfile](#modulesflatfilemd).[property](#modulesflatfilepropertymd).StringConfig | |
| ### Table of contents | |
| #### Properties | |
| - [size](#size) | |
| ### Properties | |
| #### size | |
| • **size**: [`StringConfigOptions`](#stringconfigoptions-1) | |
| ##### Defined in | |
| [src/api/resources/property/types/StringConfig.ts:8](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/property/types/StringConfig.ts#L8) | |
| <a name="interfacesflatfilepropertystringpropertymd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / [property](#modulesflatfilepropertymd) / StringProperty | |
| ## Interface: StringProperty | |
| [Flatfile](#modulesflatfilemd).[property](#modulesflatfilepropertymd).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`](#interfacesflatfilepropertybasepropertymd) | |
| ↳ **`StringProperty`** | |
| ↳↳ [`String`](#interfacesflatfilepropertypropertystringmd) | |
| ### Table of contents | |
| #### Properties | |
| - [config](#config) | |
| - [constraints](#constraints) | |
| - [description](#description) | |
| - [key](#key) | |
| - [label](#label) | |
| - [metadata](#metadata) | |
| - [readonly](#readonly) | |
| ### Properties | |
| #### config | |
| • `Optional` **config**: [`StringConfig`](#interfacesflatfilepropertystringconfigmd) | |
| ##### Defined in | |
| [src/api/resources/property/types/StringProperty.ts:11](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/property/types/StringProperty.ts#L11) | |
| ___ | |
| #### constraints | |
| • `Optional` **constraints**: [`Constraint`](#constraint)[] | |
| ##### Inherited from | |
| [BaseProperty](#interfacesflatfilepropertybasepropertymd).[constraints](#constraints) | |
| ##### Defined in | |
| [src/api/resources/property/types/BaseProperty.ts:12](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/property/types/BaseProperty.ts#L12) | |
| ___ | |
| #### description | |
| • `Optional` **description**: `string` | |
| ##### Inherited from | |
| [BaseProperty](#interfacesflatfilepropertybasepropertymd).[description](#description) | |
| ##### Defined in | |
| [src/api/resources/property/types/BaseProperty.ts:11](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/property/types/BaseProperty.ts#L11) | |
| ___ | |
| #### key | |
| • **key**: `string` | |
| ##### Inherited from | |
| [BaseProperty](#interfacesflatfilepropertybasepropertymd).[key](#key) | |
| ##### Defined in | |
| [src/api/resources/property/types/BaseProperty.ts:8](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/property/types/BaseProperty.ts#L8) | |
| ___ | |
| #### label | |
| • `Optional` **label**: `string` | |
| User friendly field name | |
| ##### Inherited from | |
| [BaseProperty](#interfacesflatfilepropertybasepropertymd).[label](#label) | |
| ##### Defined in | |
| [src/api/resources/property/types/BaseProperty.ts:10](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/property/types/BaseProperty.ts#L10) | |
| ___ | |
| #### metadata | |
| • `Optional` **metadata**: `unknown` | |
| Useful for any contextual metadata regarding the schema. Store any valid json here. | |
| ##### Inherited from | |
| [BaseProperty](#interfacesflatfilepropertybasepropertymd).[metadata](#metadata) | |
| ##### Defined in | |
| [src/api/resources/property/types/BaseProperty.ts:15](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/property/types/BaseProperty.ts#L15) | |
| ___ | |
| #### readonly | |
| • `Optional` **readonly**: `boolean` | |
| ##### Inherited from | |
| [BaseProperty](#interfacesflatfilepropertybasepropertymd).[readonly](#readonly) | |
| ##### Defined in | |
| [src/api/resources/property/types/BaseProperty.ts:13](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/property/types/BaseProperty.ts#L13) | |
| <a name="interfacesflatfilepropertyuniqueconstraintmd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / [property](#modulesflatfilepropertymd) / UniqueConstraint | |
| ## Interface: UniqueConstraint | |
| [Flatfile](#modulesflatfilemd).[property](#modulesflatfilepropertymd).UniqueConstraint | |
| ### Hierarchy | |
| - **`UniqueConstraint`** | |
| ↳ [`Unique`](#interfacesflatfilepropertyconstraintuniquemd) | |
| ### Table of contents | |
| #### Properties | |
| - [config](#config) | |
| ### Properties | |
| #### config | |
| • `Optional` **config**: [`UniqueConstraintConfig`](#interfacesflatfilepropertyuniqueconstraintconfigmd) | |
| ##### Defined in | |
| [src/api/resources/property/types/UniqueConstraint.ts:8](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/property/types/UniqueConstraint.ts#L8) | |
| <a name="interfacesflatfilepropertyuniqueconstraintconfigmd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / [property](#modulesflatfilepropertymd) / UniqueConstraintConfig | |
| ## Interface: UniqueConstraintConfig | |
| [Flatfile](#modulesflatfilemd).[property](#modulesflatfilepropertymd).UniqueConstraintConfig | |
| This file was auto-generated by Fern from our API Definition. | |
| ### Table of contents | |
| #### Properties | |
| - [caseSensitive](#casesensitive) | |
| - [ignoreEmpty](#ignoreempty) | |
| ### Properties | |
| #### caseSensitive | |
| • `Optional` **caseSensitive**: `boolean` | |
| Ignore casing when determining uniqueness | |
| ##### Defined in | |
| [src/api/resources/property/types/UniqueConstraintConfig.ts:7](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/property/types/UniqueConstraintConfig.ts#L7) | |
| ___ | |
| #### ignoreEmpty | |
| • `Optional` **ignoreEmpty**: `boolean` | |
| Do not flag empty values as duplicate | |
| ##### Defined in | |
| [src/api/resources/property/types/UniqueConstraintConfig.ts:9](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/property/types/UniqueConstraintConfig.ts#L9) | |
| <a name="interfacesflatfilerecordscellvaluemd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / [records](#modulesflatfilerecordsmd) / CellValue | |
| ## Interface: CellValue | |
| [Flatfile](#modulesflatfilemd).[records](#modulesflatfilerecordsmd).CellValue | |
| ### Hierarchy | |
| - **`CellValue`** | |
| ↳ [`CellValueWithCounts`](#interfacesflatfilecellscellvaluewithcountsmd) | |
| ↳ [`CellValueWithLinks`](#interfacesflatfilerecordscellvaluewithlinksmd) | |
| ### Table of contents | |
| #### Properties | |
| - [messages](#messages) | |
| - [updatedAt](#updatedat) | |
| - [valid](#valid) | |
| - [value](#value) | |
| ### Properties | |
| #### messages | |
| • `Optional` **messages**: [`ValidationMessage`](#interfacesflatfilerecordsvalidationmessagemd)[] | |
| ##### Defined in | |
| [src/api/resources/records/types/CellValue.ts:9](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/records/types/CellValue.ts#L9) | |
| ___ | |
| #### updatedAt | |
| • `Optional` **updatedAt**: `Date` | |
| ##### Defined in | |
| [src/api/resources/records/types/CellValue.ts:11](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/records/types/CellValue.ts#L11) | |
| ___ | |
| #### valid | |
| • `Optional` **valid**: `boolean` | |
| ##### Defined in | |
| [src/api/resources/records/types/CellValue.ts:8](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/records/types/CellValue.ts#L8) | |
| ___ | |
| #### value | |
| • `Optional` **value**: [`CellValueUnion`](#cellvalueunion) | |
| ##### Defined in | |
| [src/api/resources/records/types/CellValue.ts:10](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/records/types/CellValue.ts#L10) | |
| <a name="interfacesflatfilerecordscellvaluewithlinksmd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / [records](#modulesflatfilerecordsmd) / CellValueWithLinks | |
| ## Interface: CellValueWithLinks | |
| [Flatfile](#modulesflatfilemd).[records](#modulesflatfilerecordsmd).CellValueWithLinks | |
| ### Hierarchy | |
| - [`CellValue`](#interfacesflatfilerecordscellvaluemd) | |
| ↳ **`CellValueWithLinks`** | |
| ### Table of contents | |
| #### Properties | |
| - [links](#links) | |
| - [messages](#messages) | |
| - [updatedAt](#updatedat) | |
| - [valid](#valid) | |
| - [value](#value) | |
| ### Properties | |
| #### links | |
| • `Optional` **links**: [`Records`](#records) | |
| ##### Defined in | |
| [src/api/resources/records/types/CellValueWithLinks.ts:8](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/records/types/CellValueWithLinks.ts#L8) | |
| ___ | |
| #### messages | |
| • `Optional` **messages**: [`ValidationMessage`](#interfacesflatfilerecordsvalidationmessagemd)[] | |
| ##### Inherited from | |
| [CellValue](#interfacesflatfilerecordscellvaluemd).[messages](#messages) | |
| ##### Defined in | |
| [src/api/resources/records/types/CellValue.ts:9](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/records/types/CellValue.ts#L9) | |
| ___ | |
| #### updatedAt | |
| • `Optional` **updatedAt**: `Date` | |
| ##### Inherited from | |
| [CellValue](#interfacesflatfilerecordscellvaluemd).[updatedAt](#updatedat) | |
| ##### Defined in | |
| [src/api/resources/records/types/CellValue.ts:11](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/records/types/CellValue.ts#L11) | |
| ___ | |
| #### valid | |
| • `Optional` **valid**: `boolean` | |
| ##### Inherited from | |
| [CellValue](#interfacesflatfilerecordscellvaluemd).[valid](#valid) | |
| ##### Defined in | |
| [src/api/resources/records/types/CellValue.ts:8](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/records/types/CellValue.ts#L8) | |
| ___ | |
| #### value | |
| • `Optional` **value**: [`CellValueUnion`](#cellvalueunion) | |
| ##### Inherited from | |
| [CellValue](#interfacesflatfilerecordscellvaluemd).[value](#value) | |
| ##### Defined in | |
| [src/api/resources/records/types/CellValue.ts:10](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/records/types/CellValue.ts#L10) | |
| <a name="interfacesflatfilerecordsdeleterecordsrequestmd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / [records](#modulesflatfilerecordsmd) / DeleteRecordsRequest | |
| ## Interface: DeleteRecordsRequest | |
| [Flatfile](#modulesflatfilemd).[records](#modulesflatfilerecordsmd).DeleteRecordsRequest | |
| ### Table of contents | |
| #### Properties | |
| - [ids](#ids) | |
| ### Properties | |
| #### ids | |
| • `Optional` **ids**: `string` \| `string`[] | |
| A list of record ids | |
| ##### Defined in | |
| [src/api/resources/records/client/requests/DeleteRecordsRequest.ts:11](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/records/client/requests/DeleteRecordsRequest.ts#L11) | |
| <a name="interfacesflatfilerecordsfindandreplacerecordrequestmd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / [records](#modulesflatfilerecordsmd) / FindAndReplaceRecordRequest | |
| ## Interface: FindAndReplaceRecordRequest | |
| [Flatfile](#modulesflatfilemd).[records](#modulesflatfilerecordsmd).FindAndReplaceRecordRequest | |
| ### Table of contents | |
| #### Properties | |
| - [fieldKey](#fieldkey) | |
| - [filter](#filter) | |
| - [filterField](#filterfield) | |
| - [find](#find) | |
| - [ids](#ids) | |
| - [replace](#replace) | |
| - [searchField](#searchfield) | |
| - [searchValue](#searchvalue) | |
| ### Properties | |
| #### fieldKey | |
| • **fieldKey**: `string` | |
| The value to replace found values with | |
| ##### Defined in | |
| [src/api/resources/records/client/requests/FindAndReplaceRecordRequest.ts:25](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/records/client/requests/FindAndReplaceRecordRequest.ts#L25) | |
| ___ | |
| #### filter | |
| • `Optional` **filter**: [`Filter`](#filter-1) | |
| ##### Defined in | |
| [src/api/resources/records/client/requests/FindAndReplaceRecordRequest.ts:8](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/records/client/requests/FindAndReplaceRecordRequest.ts#L8) | |
| ___ | |
| #### filterField | |
| • `Optional` **filterField**: `string` | |
| Name of field by which to filter records | |
| ##### Defined in | |
| [src/api/resources/records/client/requests/FindAndReplaceRecordRequest.ts:12](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/records/client/requests/FindAndReplaceRecordRequest.ts#L12) | |
| ___ | |
| #### find | |
| • `Optional` **find**: [`CellValueUnion`](#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](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/records/client/requests/FindAndReplaceRecordRequest.ts#L21) | |
| ___ | |
| #### 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](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/records/client/requests/FindAndReplaceRecordRequest.ts#L19) | |
| ___ | |
| #### replace | |
| • `Optional` **replace**: [`CellValueUnion`](#cellvalueunion) | |
| The value to replace found values with | |
| ##### Defined in | |
| [src/api/resources/records/client/requests/FindAndReplaceRecordRequest.ts:23](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/records/client/requests/FindAndReplaceRecordRequest.ts#L23) | |
| ___ | |
| #### searchField | |
| • `Optional` **searchField**: `string` | |
| ##### Defined in | |
| [src/api/resources/records/client/requests/FindAndReplaceRecordRequest.ts:14](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/records/client/requests/FindAndReplaceRecordRequest.ts#L14) | |
| ___ | |
| #### searchValue | |
| • `Optional` **searchValue**: `string` | |
| ##### Defined in | |
| [src/api/resources/records/client/requests/FindAndReplaceRecordRequest.ts:13](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/records/client/requests/FindAndReplaceRecordRequest.ts#L13) | |
| <a name="interfacesflatfilerecordsfindandreplacerecordrequestdeprecatedmd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / [records](#modulesflatfilerecordsmd) / FindAndReplaceRecordRequestDeprecated | |
| ## Interface: FindAndReplaceRecordRequestDeprecated | |
| [Flatfile](#modulesflatfilemd).[records](#modulesflatfilerecordsmd).FindAndReplaceRecordRequestDeprecated | |
| ### Table of contents | |
| #### Properties | |
| - [fieldKey](#fieldkey) | |
| - [filter](#filter) | |
| - [pageNumber](#pagenumber) | |
| - [pageSize](#pagesize) | |
| - [replace](#replace) | |
| - [searchValue](#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](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/records/client/requests/FindAndReplaceRecordRequestDeprecated.ts#L11) | |
| ___ | |
| #### filter | |
| • `Optional` **filter**: [`Filter`](#filter-1) | |
| ##### Defined in | |
| [src/api/resources/records/client/requests/FindAndReplaceRecordRequestDeprecated.ts:16](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/records/client/requests/FindAndReplaceRecordRequestDeprecated.ts#L16) | |
| ___ | |
| #### pageNumber | |
| • `Optional` **pageNumber**: `number` | |
| Based on pageSize, which page of records to return | |
| ##### Defined in | |
| [src/api/resources/records/client/requests/FindAndReplaceRecordRequestDeprecated.ts:24](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/records/client/requests/FindAndReplaceRecordRequestDeprecated.ts#L24) | |
| ___ | |
| #### 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](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/records/client/requests/FindAndReplaceRecordRequestDeprecated.ts#L20) | |
| ___ | |
| #### replace | |
| • `Optional` **replace**: `unknown` | |
| The value to replace found values with | |
| ##### Defined in | |
| [src/api/resources/records/client/requests/FindAndReplaceRecordRequestDeprecated.ts:26](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/records/client/requests/FindAndReplaceRecordRequestDeprecated.ts#L26) | |
| ___ | |
| #### 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](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/records/client/requests/FindAndReplaceRecordRequestDeprecated.ts#L15) | |
| <a name="interfacesflatfilerecordsfindrecordsrequestmd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / [records](#modulesflatfilerecordsmd) / FindRecordsRequest | |
| ## Interface: FindRecordsRequest | |
| [Flatfile](#modulesflatfilemd).[records](#modulesflatfilerecordsmd).FindRecordsRequest | |
| This file was auto-generated by Fern from our API Definition. | |
| ### Table of contents | |
| #### Properties | |
| - [fieldKey](#fieldkey) | |
| - [pageNumber](#pagenumber) | |
| - [pageSize](#pagesize) | |
| - [searchValue](#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](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/records/client/requests/FindRecordsRequest.ts#L9) | |
| ___ | |
| #### pageNumber | |
| • `Optional` **pageNumber**: `number` | |
| Based on pageSize, which page of records to return | |
| ##### Defined in | |
| [src/api/resources/records/client/requests/FindRecordsRequest.ts:21](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/records/client/requests/FindRecordsRequest.ts#L21) | |
| ___ | |
| #### 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](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/records/client/requests/FindRecordsRequest.ts#L17) | |
| ___ | |
| #### searchValue | |
| • **searchValue**: `string` | |
| The value to search for | |
| ##### Defined in | |
| [src/api/resources/records/client/requests/FindRecordsRequest.ts:13](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/records/client/requests/FindRecordsRequest.ts#L13) | |
| <a name="interfacesflatfilerecordsgetrecordsrequestmd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / [records](#modulesflatfilerecordsmd) / GetRecordsRequest | |
| ## Interface: GetRecordsRequest | |
| [Flatfile](#modulesflatfilemd).[records](#modulesflatfilerecordsmd).GetRecordsRequest | |
| ### Table of contents | |
| #### Properties | |
| - [filter](#filter) | |
| - [filterField](#filterfield) | |
| - [for](#for) | |
| - [ids](#ids) | |
| - [includeCounts](#includecounts) | |
| - [includeLMessages](#includelmessages) | |
| - [includeLinks](#includelinks) | |
| - [pageNumber](#pagenumber) | |
| - [pageSize](#pagesize) | |
| - [q](#q) | |
| - [searchField](#searchfield) | |
| - [searchValue](#searchvalue) | |
| - [sinceVersionId](#sinceversionid) | |
| - [sortDirection](#sortdirection) | |
| - [sortField](#sortfield) | |
| - [untilVersionId](#untilversionid) | |
| - [versionId](#versionid) | |
| ### Properties | |
| #### filter | |
| • `Optional` **filter**: [`Filter`](#filter-1) | |
| ##### Defined in | |
| [src/api/resources/records/client/requests/GetRecordsRequest.ts:13](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/records/client/requests/GetRecordsRequest.ts#L13) | |
| ___ | |
| #### filterField | |
| • `Optional` **filterField**: `string` | |
| Name of field by which to filter records | |
| ##### Defined in | |
| [src/api/resources/records/client/requests/GetRecordsRequest.ts:17](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/records/client/requests/GetRecordsRequest.ts#L17) | |
| ___ | |
| #### 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](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/records/client/requests/GetRecordsRequest.ts#L48) | |
| ___ | |
| #### 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](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/records/client/requests/GetRecordsRequest.ts#L24) | |
| ___ | |
| #### 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](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/records/client/requests/GetRecordsRequest.ts#L36) | |
| ___ | |
| #### includeLMessages | |
| • `Optional` **includeLMessages**: `boolean` | |
| Include error messages, defaults to false. | |
| ##### Defined in | |
| [src/api/resources/records/client/requests/GetRecordsRequest.ts:44](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/records/client/requests/GetRecordsRequest.ts#L44) | |
| ___ | |
| #### 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](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/records/client/requests/GetRecordsRequest.ts#L40) | |
| ___ | |
| #### pageNumber | |
| • `Optional` **pageNumber**: `number` | |
| Based on pageSize, which page of records to return | |
| ##### Defined in | |
| [src/api/resources/records/client/requests/GetRecordsRequest.ts:32](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/records/client/requests/GetRecordsRequest.ts#L32) | |
| ___ | |
| #### 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](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/records/client/requests/GetRecordsRequest.ts#L28) | |
| ___ | |
| #### q | |
| • `Optional` **q**: `string` | |
| An FFQL query used to filter the result set | |
| ##### Defined in | |
| [src/api/resources/records/client/requests/GetRecordsRequest.ts:52](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/records/client/requests/GetRecordsRequest.ts#L52) | |
| ___ | |
| #### searchField | |
| • `Optional` **searchField**: `string` | |
| ##### Defined in | |
| [src/api/resources/records/client/requests/GetRecordsRequest.ts:19](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/records/client/requests/GetRecordsRequest.ts#L19) | |
| ___ | |
| #### searchValue | |
| • `Optional` **searchValue**: `string` | |
| ##### Defined in | |
| [src/api/resources/records/client/requests/GetRecordsRequest.ts:18](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/records/client/requests/GetRecordsRequest.ts#L18) | |
| ___ | |
| #### sinceVersionId | |
| • `Optional` **sinceVersionId**: `string` | |
| ##### Defined in | |
| [src/api/resources/records/client/requests/GetRecordsRequest.ts:10](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/records/client/requests/GetRecordsRequest.ts#L10) | |
| ___ | |
| #### sortDirection | |
| • `Optional` **sortDirection**: [`SortDirection`](#sortdirection-1) | |
| ##### Defined in | |
| [src/api/resources/records/client/requests/GetRecordsRequest.ts:12](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/records/client/requests/GetRecordsRequest.ts#L12) | |
| ___ | |
| #### sortField | |
| • `Optional` **sortField**: `string` | |
| ##### Defined in | |
| [src/api/resources/records/client/requests/GetRecordsRequest.ts:11](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/records/client/requests/GetRecordsRequest.ts#L11) | |
| ___ | |
| #### untilVersionId | |
| • `Optional` **untilVersionId**: `string` | |
| ##### Defined in | |
| [src/api/resources/records/client/requests/GetRecordsRequest.ts:9](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/records/client/requests/GetRecordsRequest.ts#L9) | |
| ___ | |
| #### versionId | |
| • `Optional` **versionId**: `string` | |
| ##### Defined in | |
| [src/api/resources/records/client/requests/GetRecordsRequest.ts:8](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/records/client/requests/GetRecordsRequest.ts#L8) | |
| <a name="interfacesflatfilerecordsrecordcountsmd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / [records](#modulesflatfilerecordsmd) / RecordCounts | |
| ## Interface: RecordCounts | |
| [Flatfile](#modulesflatfilemd).[records](#modulesflatfilerecordsmd).RecordCounts | |
| This file was auto-generated by Fern from our API Definition. | |
| ### Table of contents | |
| #### Properties | |
| - [error](#error) | |
| - [errorsByField](#errorsbyfield) | |
| - [total](#total) | |
| - [valid](#valid) | |
| ### Properties | |
| #### error | |
| • **error**: `number` | |
| ##### Defined in | |
| [src/api/resources/records/types/RecordCounts.ts:8](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/records/types/RecordCounts.ts#L8) | |
| ___ | |
| #### errorsByField | |
| • `Optional` **errorsByField**: `Record`<`string`, `number`\> | |
| ##### Defined in | |
| [src/api/resources/records/types/RecordCounts.ts:9](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/records/types/RecordCounts.ts#L9) | |
| ___ | |
| #### total | |
| • **total**: `number` | |
| ##### Defined in | |
| [src/api/resources/records/types/RecordCounts.ts:6](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/records/types/RecordCounts.ts#L6) | |
| ___ | |
| #### valid | |
| • **valid**: `number` | |
| ##### Defined in | |
| [src/api/resources/records/types/RecordCounts.ts:7](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/records/types/RecordCounts.ts#L7) | |
| <a name="interfacesflatfilerecordsrecordwithlinksmd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / [records](#modulesflatfilerecordsmd) / RecordWithLinks | |
| ## Interface: RecordWithLinks | |
| [Flatfile](#modulesflatfilemd).[records](#modulesflatfilerecordsmd).RecordWithLinks | |
| A single row of data in a Sheet, including links to related rows | |
| ### Table of contents | |
| #### Properties | |
| - [id](#id) | |
| - [messages](#messages) | |
| - [metadata](#metadata) | |
| - [valid](#valid) | |
| - [values](#values) | |
| ### Properties | |
| #### id | |
| • **id**: `string` | |
| ##### Defined in | |
| [src/api/resources/records/types/RecordWithLinks.ts:11](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/records/types/RecordWithLinks.ts#L11) | |
| ___ | |
| #### messages | |
| • `Optional` **messages**: [`ValidationMessage`](#interfacesflatfilerecordsvalidationmessagemd)[] | |
| ##### Defined in | |
| [src/api/resources/records/types/RecordWithLinks.ts:14](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/records/types/RecordWithLinks.ts#L14) | |
| ___ | |
| #### metadata | |
| • `Optional` **metadata**: `Record`<`string`, `unknown`\> | |
| ##### Defined in | |
| [src/api/resources/records/types/RecordWithLinks.ts:15](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/records/types/RecordWithLinks.ts#L15) | |
| ___ | |
| #### valid | |
| • `Optional` **valid**: `boolean` | |
| ##### Defined in | |
| [src/api/resources/records/types/RecordWithLinks.ts:13](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/records/types/RecordWithLinks.ts#L13) | |
| ___ | |
| #### values | |
| • **values**: [`RecordDataWithLinks`](#recorddatawithlinks) | |
| ##### Defined in | |
| [src/api/resources/records/types/RecordWithLinks.ts:12](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/records/types/RecordWithLinks.ts#L12) | |
| <a name="interfacesflatfilerecordsrecord_md"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / [records](#modulesflatfilerecordsmd) / Record\_ | |
| ## Interface: Record\_ | |
| [Flatfile](#modulesflatfilemd).[records](#modulesflatfilerecordsmd).Record_ | |
| A single row of data in a Sheet | |
| ### Table of contents | |
| #### Properties | |
| - [id](#id) | |
| - [messages](#messages) | |
| - [metadata](#metadata) | |
| - [valid](#valid) | |
| - [values](#values) | |
| ### Properties | |
| #### id | |
| • **id**: `string` | |
| ##### Defined in | |
| [src/api/resources/records/types/Record_.ts:11](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/records/types/Record_.ts#L11) | |
| ___ | |
| #### messages | |
| • `Optional` **messages**: [`ValidationMessage`](#interfacesflatfilerecordsvalidationmessagemd)[] | |
| ##### Defined in | |
| [src/api/resources/records/types/Record_.ts:14](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/records/types/Record_.ts#L14) | |
| ___ | |
| #### metadata | |
| • `Optional` **metadata**: `Record`<`string`, `unknown`\> | |
| ##### Defined in | |
| [src/api/resources/records/types/Record_.ts:15](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/records/types/Record_.ts#L15) | |
| ___ | |
| #### valid | |
| • `Optional` **valid**: `boolean` | |
| ##### Defined in | |
| [src/api/resources/records/types/Record_.ts:13](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/records/types/Record_.ts#L13) | |
| ___ | |
| #### values | |
| • **values**: [`RecordData`](#recorddata) | |
| ##### Defined in | |
| [src/api/resources/records/types/Record_.ts:12](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/records/types/Record_.ts#L12) | |
| <a name="interfacesflatfilerecordsrecordsresponsemd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / [records](#modulesflatfilerecordsmd) / RecordsResponse | |
| ## Interface: RecordsResponse | |
| [Flatfile](#modulesflatfilemd).[records](#modulesflatfilerecordsmd).RecordsResponse | |
| ### Table of contents | |
| #### Properties | |
| - [data](#data) | |
| ### Properties | |
| #### data | |
| • **data**: [`RecordsResponseData`](#interfacesflatfilerecordsrecordsresponsedatamd) | |
| ##### Defined in | |
| [src/api/resources/records/types/RecordsResponse.ts:8](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/records/types/RecordsResponse.ts#L8) | |
| <a name="interfacesflatfilerecordsrecordsresponsedatamd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / [records](#modulesflatfilerecordsmd) / RecordsResponseData | |
| ## Interface: RecordsResponseData | |
| [Flatfile](#modulesflatfilemd).[records](#modulesflatfilerecordsmd).RecordsResponseData | |
| A list of records with optional record counts | |
| ### Hierarchy | |
| - [`Success`](#interfacesflatfilecommonssuccessmd) | |
| ↳ **`RecordsResponseData`** | |
| ### Table of contents | |
| #### Properties | |
| - [counts](#counts) | |
| - [data](#data) | |
| - [records](#records) | |
| - [versionId](#versionid) | |
| ### Properties | |
| #### counts | |
| • `Optional` **counts**: [`RecordCounts`](#interfacesflatfilerecordsrecordcountsmd) | |
| ##### Defined in | |
| [src/api/resources/records/types/RecordsResponseData.ts:12](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/records/types/RecordsResponseData.ts#L12) | |
| ___ | |
| #### data | |
| • **data**: [`SuccessData`](#interfacesflatfilecommonssuccessdatamd) | |
| ##### Inherited from | |
| [Success](#interfacesflatfilecommonssuccessmd).[data](#data) | |
| ##### Defined in | |
| [src/api/resources/commons/types/Success.ts:18](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/commons/types/Success.ts#L18) | |
| ___ | |
| #### records | |
| • `Optional` **records**: [`RecordsWithLinks`](#recordswithlinks) | |
| ##### Defined in | |
| [src/api/resources/records/types/RecordsResponseData.ts:11](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/records/types/RecordsResponseData.ts#L11) | |
| ___ | |
| #### versionId | |
| • `Optional` **versionId**: `string` | |
| ##### Defined in | |
| [src/api/resources/records/types/RecordsResponseData.ts:13](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/records/types/RecordsResponseData.ts#L13) | |
| <a name="interfacesflatfilerecordsvalidationmessagemd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / [records](#modulesflatfilerecordsmd) / ValidationMessage | |
| ## Interface: ValidationMessage | |
| [Flatfile](#modulesflatfilemd).[records](#modulesflatfilerecordsmd).ValidationMessage | |
| Record data validation messages | |
| ### Table of contents | |
| #### Properties | |
| - [message](#message) | |
| - [source](#source) | |
| - [type](#type) | |
| ### Properties | |
| #### message | |
| • `Optional` **message**: `string` | |
| ##### Defined in | |
| [src/api/resources/records/types/ValidationMessage.ts:13](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/records/types/ValidationMessage.ts#L13) | |
| ___ | |
| #### source | |
| • `Optional` **source**: [`ValidationSource`](#validationsource-1) | |
| ##### Defined in | |
| [src/api/resources/records/types/ValidationMessage.ts:12](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/records/types/ValidationMessage.ts#L12) | |
| ___ | |
| #### type | |
| • `Optional` **type**: [`ValidationType`](#validationtype-1) | |
| ##### Defined in | |
| [src/api/resources/records/types/ValidationMessage.ts:11](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/records/types/ValidationMessage.ts#L11) | |
| <a name="interfacesflatfilesheetsgetrecordcountsrequestmd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / [sheets](#modulesflatfilesheetsmd) / GetRecordCountsRequest | |
| ## Interface: GetRecordCountsRequest | |
| [Flatfile](#modulesflatfilemd).[sheets](#modulesflatfilesheetsmd).GetRecordCountsRequest | |
| ### Table of contents | |
| #### Properties | |
| - [byField](#byfield) | |
| - [filter](#filter) | |
| - [filterField](#filterfield) | |
| - [q](#q) | |
| - [searchField](#searchfield) | |
| - [searchValue](#searchvalue) | |
| - [sinceVersionId](#sinceversionid) | |
| - [versionId](#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](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/sheets/client/requests/GetRecordCountsRequest.ts#L20) | |
| ___ | |
| #### filter | |
| • `Optional` **filter**: [`Filter`](#filter-1) | |
| Options to filter records | |
| ##### Defined in | |
| [src/api/resources/sheets/client/requests/GetRecordCountsRequest.ts:13](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/sheets/client/requests/GetRecordCountsRequest.ts#L13) | |
| ___ | |
| #### filterField | |
| • `Optional` **filterField**: `string` | |
| ##### Defined in | |
| [src/api/resources/sheets/client/requests/GetRecordCountsRequest.ts:14](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/sheets/client/requests/GetRecordCountsRequest.ts#L14) | |
| ___ | |
| #### 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](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/sheets/client/requests/GetRecordCountsRequest.ts#L24) | |
| ___ | |
| #### searchField | |
| • `Optional` **searchField**: `string` | |
| ##### Defined in | |
| [src/api/resources/sheets/client/requests/GetRecordCountsRequest.ts:16](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/sheets/client/requests/GetRecordCountsRequest.ts#L16) | |
| ___ | |
| #### searchValue | |
| • `Optional` **searchValue**: `string` | |
| ##### Defined in | |
| [src/api/resources/sheets/client/requests/GetRecordCountsRequest.ts:15](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/sheets/client/requests/GetRecordCountsRequest.ts#L15) | |
| ___ | |
| #### sinceVersionId | |
| • `Optional` **sinceVersionId**: `string` | |
| ##### Defined in | |
| [src/api/resources/sheets/client/requests/GetRecordCountsRequest.ts:9](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/sheets/client/requests/GetRecordCountsRequest.ts#L9) | |
| ___ | |
| #### versionId | |
| • `Optional` **versionId**: `string` | |
| ##### Defined in | |
| [src/api/resources/sheets/client/requests/GetRecordCountsRequest.ts:8](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/sheets/client/requests/GetRecordCountsRequest.ts#L8) | |
| <a name="interfacesflatfilesheetsgetrecordscsvrequestmd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / [sheets](#modulesflatfilesheetsmd) / GetRecordsCsvRequest | |
| ## Interface: GetRecordsCsvRequest | |
| [Flatfile](#modulesflatfilemd).[sheets](#modulesflatfilesheetsmd).GetRecordsCsvRequest | |
| ### Table of contents | |
| #### Properties | |
| - [filter](#filter) | |
| - [filterField](#filterfield) | |
| - [ids](#ids) | |
| - [searchField](#searchfield) | |
| - [searchValue](#searchvalue) | |
| - [sinceVersionId](#sinceversionid) | |
| - [sortDirection](#sortdirection) | |
| - [sortField](#sortfield) | |
| - [versionId](#versionid) | |
| ### Properties | |
| #### filter | |
| • `Optional` **filter**: [`Filter`](#filter-1) | |
| Options to filter records | |
| ##### Defined in | |
| [src/api/resources/sheets/client/requests/GetRecordsCsvRequest.ts:18](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/sheets/client/requests/GetRecordsCsvRequest.ts#L18) | |
| ___ | |
| #### filterField | |
| • `Optional` **filterField**: `string` | |
| ##### Defined in | |
| [src/api/resources/sheets/client/requests/GetRecordsCsvRequest.ts:19](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/sheets/client/requests/GetRecordsCsvRequest.ts#L19) | |
| ___ | |
| #### 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](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/sheets/client/requests/GetRecordsCsvRequest.ts#L26) | |
| ___ | |
| #### searchField | |
| • `Optional` **searchField**: `string` | |
| ##### Defined in | |
| [src/api/resources/sheets/client/requests/GetRecordsCsvRequest.ts:21](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/sheets/client/requests/GetRecordsCsvRequest.ts#L21) | |
| ___ | |
| #### searchValue | |
| • `Optional` **searchValue**: `string` | |
| ##### Defined in | |
| [src/api/resources/sheets/client/requests/GetRecordsCsvRequest.ts:20](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/sheets/client/requests/GetRecordsCsvRequest.ts#L20) | |
| ___ | |
| #### sinceVersionId | |
| • `Optional` **sinceVersionId**: `string` | |
| ##### Defined in | |
| [src/api/resources/sheets/client/requests/GetRecordsCsvRequest.ts:9](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/sheets/client/requests/GetRecordsCsvRequest.ts#L9) | |
| ___ | |
| #### sortDirection | |
| • `Optional` **sortDirection**: [`SortDirection`](#sortdirection-1) | |
| Sort direction - asc (ascending) or desc (descending) | |
| ##### Defined in | |
| [src/api/resources/sheets/client/requests/GetRecordsCsvRequest.ts:14](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/sheets/client/requests/GetRecordsCsvRequest.ts#L14) | |
| ___ | |
| #### sortField | |
| • `Optional` **sortField**: `string` | |
| ##### Defined in | |
| [src/api/resources/sheets/client/requests/GetRecordsCsvRequest.ts:10](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/sheets/client/requests/GetRecordsCsvRequest.ts#L10) | |
| ___ | |
| #### versionId | |
| • `Optional` **versionId**: `string` | |
| ##### Defined in | |
| [src/api/resources/sheets/client/requests/GetRecordsCsvRequest.ts:8](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/sheets/client/requests/GetRecordsCsvRequest.ts#L8) | |
| <a name="interfacesflatfilesheetslistsheetsrequestmd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / [sheets](#modulesflatfilesheetsmd) / ListSheetsRequest | |
| ## Interface: ListSheetsRequest | |
| [Flatfile](#modulesflatfilemd).[sheets](#modulesflatfilesheetsmd).ListSheetsRequest | |
| ### Table of contents | |
| #### Properties | |
| - [workbookId](#workbookid) | |
| ### Properties | |
| #### workbookId | |
| • **workbookId**: `string` | |
| ID of workbook | |
| ##### Defined in | |
| [src/api/resources/sheets/client/requests/ListSheetsRequest.ts:11](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/sheets/client/requests/ListSheetsRequest.ts#L11) | |
| <a name="interfacesflatfilesheetslistsheetsresponsemd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / [sheets](#modulesflatfilesheetsmd) / ListSheetsResponse | |
| ## Interface: ListSheetsResponse | |
| [Flatfile](#modulesflatfilemd).[sheets](#modulesflatfilesheetsmd).ListSheetsResponse | |
| ### Table of contents | |
| #### Properties | |
| - [data](#data) | |
| ### Properties | |
| #### data | |
| • **data**: [`Sheet`](#interfacesflatfilesheetssheetmd)[] | |
| ##### Defined in | |
| [src/api/resources/sheets/types/ListSheetsResponse.ts:8](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/sheets/types/ListSheetsResponse.ts#L8) | |
| <a name="interfacesflatfilesheetsrecordcountsresponsemd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / [sheets](#modulesflatfilesheetsmd) / RecordCountsResponse | |
| ## Interface: RecordCountsResponse | |
| [Flatfile](#modulesflatfilemd).[sheets](#modulesflatfilesheetsmd).RecordCountsResponse | |
| ### Table of contents | |
| #### Properties | |
| - [data](#data) | |
| ### Properties | |
| #### data | |
| • **data**: [`RecordCountsResponseData`](#interfacesflatfilesheetsrecordcountsresponsedatamd) | |
| ##### Defined in | |
| [src/api/resources/sheets/types/RecordCountsResponse.ts:8](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/sheets/types/RecordCountsResponse.ts#L8) | |
| <a name="interfacesflatfilesheetsrecordcountsresponsedatamd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / [sheets](#modulesflatfilesheetsmd) / RecordCountsResponseData | |
| ## Interface: RecordCountsResponseData | |
| [Flatfile](#modulesflatfilemd).[sheets](#modulesflatfilesheetsmd).RecordCountsResponseData | |
| Informs whether or not a request was successful | |
| **`Example`** | |
| ```ts | |
| { | |
| * data: { | |
| * success: true | |
| * } | |
| * } | |
| ``` | |
| ### Hierarchy | |
| - [`Success`](#interfacesflatfilecommonssuccessmd) | |
| ↳ **`RecordCountsResponseData`** | |
| ### Table of contents | |
| #### Properties | |
| - [counts](#counts) | |
| - [data](#data) | |
| ### Properties | |
| #### counts | |
| • `Optional` **counts**: [`RecordCounts`](#interfacesflatfilerecordsrecordcountsmd) | |
| ##### Defined in | |
| [src/api/resources/sheets/types/RecordCountsResponseData.ts:8](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/sheets/types/RecordCountsResponseData.ts#L8) | |
| ___ | |
| #### data | |
| • **data**: [`SuccessData`](#interfacesflatfilecommonssuccessdatamd) | |
| ##### Inherited from | |
| [Success](#interfacesflatfilecommonssuccessmd).[data](#data) | |
| ##### Defined in | |
| [src/api/resources/commons/types/Success.ts:18](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/commons/types/Success.ts#L18) | |
| <a name="interfacesflatfilesheetssheetmd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / [sheets](#modulesflatfilesheetsmd) / Sheet | |
| ## Interface: Sheet | |
| [Flatfile](#modulesflatfilemd).[sheets](#modulesflatfilesheetsmd).Sheet | |
| A place to store tabular data | |
| ### Table of contents | |
| #### Properties | |
| - [config](#config) | |
| - [countRecords](#countrecords) | |
| - [id](#id) | |
| - [name](#name) | |
| - [workbookId](#workbookid) | |
| ### Properties | |
| #### config | |
| • `Optional` **config**: [`SheetConfig`](#interfacesflatfilesheetssheetconfigmd) | |
| ##### Defined in | |
| [src/api/resources/sheets/types/Sheet.ts:14](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/sheets/types/Sheet.ts#L14) | |
| ___ | |
| #### countRecords | |
| • `Optional` **countRecords**: [`RecordCounts`](#interfacesflatfilerecordsrecordcountsmd) | |
| ##### Defined in | |
| [src/api/resources/sheets/types/Sheet.ts:15](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/sheets/types/Sheet.ts#L15) | |
| ___ | |
| #### id | |
| • **id**: `string` | |
| ##### Defined in | |
| [src/api/resources/sheets/types/Sheet.ts:11](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/sheets/types/Sheet.ts#L11) | |
| ___ | |
| #### name | |
| • **name**: `string` | |
| ##### Defined in | |
| [src/api/resources/sheets/types/Sheet.ts:13](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/sheets/types/Sheet.ts#L13) | |
| ___ | |
| #### workbookId | |
| • **workbookId**: `string` | |
| ##### Defined in | |
| [src/api/resources/sheets/types/Sheet.ts:12](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/sheets/types/Sheet.ts#L12) | |
| <a name="interfacesflatfilesheetssheetconfigmd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / [sheets](#modulesflatfilesheetsmd) / SheetConfig | |
| ## Interface: SheetConfig | |
| [Flatfile](#modulesflatfilemd).[sheets](#modulesflatfilesheetsmd).SheetConfig | |
| Describes shape of data as well as behavior | |
| ### Table of contents | |
| #### Properties | |
| - [access](#access) | |
| - [actions](#actions) | |
| - [description](#description) | |
| - [fields](#fields) | |
| - [name](#name) | |
| - [readonly](#readonly) | |
| - [slug](#slug) | |
| ### Properties | |
| #### access | |
| • `Optional` **access**: [`SheetAccess`](#sheetaccess-1)[] | |
| ##### Defined in | |
| [src/api/resources/sheets/types/SheetConfig.ts:15](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/sheets/types/SheetConfig.ts#L15) | |
| ___ | |
| #### actions | |
| • `Optional` **actions**: [`Action`](#interfacesflatfilecommonsactionmd)[] | |
| ##### Defined in | |
| [src/api/resources/sheets/types/SheetConfig.ts:17](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/sheets/types/SheetConfig.ts#L17) | |
| ___ | |
| #### description | |
| • `Optional` **description**: `string` | |
| ##### Defined in | |
| [src/api/resources/sheets/types/SheetConfig.ts:12](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/sheets/types/SheetConfig.ts#L12) | |
| ___ | |
| #### fields | |
| • **fields**: [`Property`](#property)[] | |
| ##### Defined in | |
| [src/api/resources/sheets/types/SheetConfig.ts:16](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/sheets/types/SheetConfig.ts#L16) | |
| ___ | |
| #### name | |
| • **name**: `string` | |
| ##### Defined in | |
| [src/api/resources/sheets/types/SheetConfig.ts:11](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/sheets/types/SheetConfig.ts#L11) | |
| ___ | |
| #### readonly | |
| • `Optional` **readonly**: `boolean` | |
| ##### Defined in | |
| [src/api/resources/sheets/types/SheetConfig.ts:14](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/sheets/types/SheetConfig.ts#L14) | |
| ___ | |
| #### slug | |
| • `Optional` **slug**: `string` | |
| ##### Defined in | |
| [src/api/resources/sheets/types/SheetConfig.ts:13](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/sheets/types/SheetConfig.ts#L13) | |
| <a name="interfacesflatfilesheetssheetresponsemd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / [sheets](#modulesflatfilesheetsmd) / SheetResponse | |
| ## Interface: SheetResponse | |
| [Flatfile](#modulesflatfilemd).[sheets](#modulesflatfilesheetsmd).SheetResponse | |
| ### Table of contents | |
| #### Properties | |
| - [data](#data) | |
| ### Properties | |
| #### data | |
| • **data**: [`Sheet`](#interfacesflatfilesheetssheetmd) | |
| ##### Defined in | |
| [src/api/resources/sheets/types/SheetResponse.ts:8](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/sheets/types/SheetResponse.ts#L8) | |
| <a name="interfacesflatfilespaceseventtokenmd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / [spaces](#modulesflatfilespacesmd) / EventToken | |
| ## Interface: EventToken | |
| [Flatfile](#modulesflatfilemd).[spaces](#modulesflatfilespacesmd).EventToken | |
| Properties used to allow users to connect to the event bus | |
| ### Table of contents | |
| #### Properties | |
| - [accountId](#accountid) | |
| - [subscribeKey](#subscribekey) | |
| - [token](#token) | |
| - [ttl](#ttl) | |
| ### Properties | |
| #### accountId | |
| • `Optional` **accountId**: `string` | |
| ##### Defined in | |
| [src/api/resources/spaces/types/EventToken.ts:11](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/spaces/types/EventToken.ts#L11) | |
| ___ | |
| #### subscribeKey | |
| • `Optional` **subscribeKey**: `string` | |
| The id of the event bus to subscribe to | |
| ##### Defined in | |
| [src/api/resources/spaces/types/EventToken.ts:13](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/spaces/types/EventToken.ts#L13) | |
| ___ | |
| #### token | |
| • `Optional` **token**: `string` | |
| ##### Defined in | |
| [src/api/resources/spaces/types/EventToken.ts:16](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/spaces/types/EventToken.ts#L16) | |
| ___ | |
| #### ttl | |
| • `Optional` **ttl**: `number` | |
| Time to live in minutes | |
| ##### Defined in | |
| [src/api/resources/spaces/types/EventToken.ts:15](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/spaces/types/EventToken.ts#L15) | |
| <a name="interfacesflatfilespaceseventtokenresponsemd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / [spaces](#modulesflatfilespacesmd) / EventTokenResponse | |
| ## Interface: EventTokenResponse | |
| [Flatfile](#modulesflatfilemd).[spaces](#modulesflatfilespacesmd).EventTokenResponse | |
| ### Table of contents | |
| #### Properties | |
| - [data](#data) | |
| ### Properties | |
| #### data | |
| • **data**: [`EventToken`](#interfacesflatfilespaceseventtokenmd) | |
| ##### Defined in | |
| [src/api/resources/spaces/types/EventTokenResponse.ts:8](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/spaces/types/EventTokenResponse.ts#L8) | |
| <a name="interfacesflatfilespaceslistspacesrequestmd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / [spaces](#modulesflatfilespacesmd) / ListSpacesRequest | |
| ## Interface: ListSpacesRequest | |
| [Flatfile](#modulesflatfilemd).[spaces](#modulesflatfilespacesmd).ListSpacesRequest | |
| ### Table of contents | |
| #### Properties | |
| - [archived](#archived) | |
| - [environmentId](#environmentid) | |
| - [pageNumber](#pagenumber) | |
| - [pageSize](#pagesize) | |
| - [search](#search) | |
| - [sortDirection](#sortdirection) | |
| - [sortField](#sortfield) | |
| ### Properties | |
| #### archived | |
| • `Optional` **archived**: `boolean` | |
| ##### Defined in | |
| [src/api/resources/spaces/client/requests/ListSpacesRequest.ts:18](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/spaces/client/requests/ListSpacesRequest.ts#L18) | |
| ___ | |
| #### environmentId | |
| • `Optional` **environmentId**: `string` | |
| ##### Defined in | |
| [src/api/resources/spaces/client/requests/ListSpacesRequest.ts:8](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/spaces/client/requests/ListSpacesRequest.ts#L8) | |
| ___ | |
| #### pageNumber | |
| • `Optional` **pageNumber**: `number` | |
| Based on pageSize, which page of records to return | |
| ##### Defined in | |
| [src/api/resources/spaces/client/requests/ListSpacesRequest.ts:16](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/spaces/client/requests/ListSpacesRequest.ts#L16) | |
| ___ | |
| #### 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](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/spaces/client/requests/ListSpacesRequest.ts#L12) | |
| ___ | |
| #### search | |
| • `Optional` **search**: `string` | |
| ##### Defined in | |
| [src/api/resources/spaces/client/requests/ListSpacesRequest.ts:17](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/spaces/client/requests/ListSpacesRequest.ts#L17) | |
| ___ | |
| #### sortDirection | |
| • `Optional` **sortDirection**: [`SortDirection`](#sortdirection-1) | |
| ##### Defined in | |
| [src/api/resources/spaces/client/requests/ListSpacesRequest.ts:20](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/spaces/client/requests/ListSpacesRequest.ts#L20) | |
| ___ | |
| #### sortField | |
| • `Optional` **sortField**: [`GetSpacesSortField`](#getspacessortfield-1) | |
| ##### Defined in | |
| [src/api/resources/spaces/client/requests/ListSpacesRequest.ts:19](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/spaces/client/requests/ListSpacesRequest.ts#L19) | |
| <a name="interfacesflatfilespaceslistspacesresponsemd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / [spaces](#modulesflatfilespacesmd) / ListSpacesResponse | |
| ## Interface: ListSpacesResponse | |
| [Flatfile](#modulesflatfilemd).[spaces](#modulesflatfilespacesmd).ListSpacesResponse | |
| ### Table of contents | |
| #### Properties | |
| - [data](#data) | |
| - [pagination](#pagination) | |
| ### Properties | |
| #### data | |
| • **data**: [`Space`](#interfacesflatfilespacesspacemd)[] | |
| ##### Defined in | |
| [src/api/resources/spaces/types/ListSpacesResponse.ts:9](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/spaces/types/ListSpacesResponse.ts#L9) | |
| ___ | |
| #### pagination | |
| • `Optional` **pagination**: [`Pagination`](#interfacesflatfilecommonspaginationmd) | |
| ##### Defined in | |
| [src/api/resources/spaces/types/ListSpacesResponse.ts:8](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/spaces/types/ListSpacesResponse.ts#L8) | |
| <a name="interfacesflatfilespacesspacemd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / [spaces](#modulesflatfilespacesmd) / Space | |
| ## Interface: Space | |
| [Flatfile](#modulesflatfilemd).[spaces](#modulesflatfilespacesmd).Space | |
| A place to store your workbooks | |
| ### Hierarchy | |
| - [`SpaceConfig`](#interfacesflatfilespacesspaceconfigmd) | |
| ↳ **`Space`** | |
| ### Table of contents | |
| #### Properties | |
| - [access](#access) | |
| - [accessToken](#accesstoken) | |
| - [actions](#actions) | |
| - [archivedAt](#archivedat) | |
| - [autoConfigure](#autoconfigure) | |
| - [createdAt](#createdat) | |
| - [createdByUserId](#createdbyuserid) | |
| - [createdByUserName](#createdbyusername) | |
| - [displayOrder](#displayorder) | |
| - [environmentId](#environmentid) | |
| - [filesCount](#filescount) | |
| - [guestAuthentication](#guestauthentication) | |
| - [guestLink](#guestlink) | |
| - [id](#id) | |
| - [metadata](#metadata) | |
| - [name](#name) | |
| - [primaryWorkbookId](#primaryworkbookid) | |
| - [spaceConfigId](#spaceconfigid) | |
| - [updatedAt](#updatedat) | |
| - [workbookCount](#workbookcount) | |
| ### Properties | |
| #### access | |
| • `Optional` **access**: [`SpaceAccess`](#spaceaccess-1)[] | |
| ##### Inherited from | |
| [SpaceConfig](#interfacesflatfilespacesspaceconfigmd).[access](#access) | |
| ##### Defined in | |
| [src/api/resources/spaces/types/SpaceConfig.ts:22](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/spaces/types/SpaceConfig.ts#L22) | |
| ___ | |
| #### accessToken | |
| • `Optional` **accessToken**: `string` | |
| ##### Defined in | |
| [src/api/resources/spaces/types/Space.ts:27](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/spaces/types/Space.ts#L27) | |
| ___ | |
| #### actions | |
| • `Optional` **actions**: [`Action`](#interfacesflatfilecommonsactionmd)[] | |
| ##### Inherited from | |
| [SpaceConfig](#interfacesflatfilespacesspaceconfigmd).[actions](#actions) | |
| ##### Defined in | |
| [src/api/resources/spaces/types/SpaceConfig.ts:20](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/spaces/types/SpaceConfig.ts#L20) | |
| ___ | |
| #### archivedAt | |
| • `Optional` **archivedAt**: `Date` | |
| Date when space was archived | |
| ##### Defined in | |
| [src/api/resources/spaces/types/Space.ts:24](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/spaces/types/Space.ts#L24) | |
| ___ | |
| #### autoConfigure | |
| • `Optional` **autoConfigure**: `boolean` | |
| ##### Inherited from | |
| [SpaceConfig](#interfacesflatfilespacesspaceconfigmd).[autoConfigure](#autoconfigure) | |
| ##### Defined in | |
| [src/api/resources/spaces/types/SpaceConfig.ts:23](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/spaces/types/SpaceConfig.ts#L23) | |
| ___ | |
| #### createdAt | |
| • **createdAt**: `Date` | |
| Date when space was created | |
| ##### Defined in | |
| [src/api/resources/spaces/types/Space.ts:20](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/spaces/types/Space.ts#L20) | |
| ___ | |
| #### createdByUserId | |
| • `Optional` **createdByUserId**: `string` | |
| ##### Defined in | |
| [src/api/resources/spaces/types/Space.ts:16](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/spaces/types/Space.ts#L16) | |
| ___ | |
| #### createdByUserName | |
| • `Optional` **createdByUserName**: `string` | |
| User name who created space | |
| ##### Defined in | |
| [src/api/resources/spaces/types/Space.ts:18](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/spaces/types/Space.ts#L18) | |
| ___ | |
| #### displayOrder | |
| • `Optional` **displayOrder**: `number` | |
| The display order | |
| ##### Inherited from | |
| [SpaceConfig](#interfacesflatfilespacesspaceconfigmd).[displayOrder](#displayorder) | |
| ##### Defined in | |
| [src/api/resources/spaces/types/SpaceConfig.ts:17](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/spaces/types/SpaceConfig.ts#L17) | |
| ___ | |
| #### environmentId | |
| • **environmentId**: `string` | |
| ##### Inherited from | |
| [SpaceConfig](#interfacesflatfilespacesspaceconfigmd).[environmentId](#environmentid) | |
| ##### Defined in | |
| [src/api/resources/spaces/types/SpaceConfig.ts:12](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/spaces/types/SpaceConfig.ts#L12) | |
| ___ | |
| #### filesCount | |
| • `Optional` **filesCount**: `number` | |
| Amount of files in the space | |
| ##### Defined in | |
| [src/api/resources/spaces/types/Space.ts:15](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/spaces/types/Space.ts#L15) | |
| ___ | |
| #### guestAuthentication | |
| • `Optional` **guestAuthentication**: [`GuestAuthenticationEnum`](#guestauthenticationenum-1)[] | |
| ##### Inherited from | |
| [SpaceConfig](#interfacesflatfilespacesspaceconfigmd).[guestAuthentication](#guestauthentication) | |
| ##### Defined in | |
| [src/api/resources/spaces/types/SpaceConfig.ts:21](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/spaces/types/SpaceConfig.ts#L21) | |
| ___ | |
| #### guestLink | |
| • `Optional` **guestLink**: `string` | |
| Guest link to the space | |
| ##### Defined in | |
| [src/api/resources/spaces/types/Space.ts:26](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/spaces/types/Space.ts#L26) | |
| ___ | |
| #### id | |
| • **id**: `string` | |
| ##### Defined in | |
| [src/api/resources/spaces/types/Space.ts:11](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/spaces/types/Space.ts#L11) | |
| ___ | |
| #### metadata | |
| • `Optional` **metadata**: `unknown` | |
| Metadata for the space | |
| ##### Inherited from | |
| [SpaceConfig](#interfacesflatfilespacesspaceconfigmd).[metadata](#metadata) | |
| ##### Defined in | |
| [src/api/resources/spaces/types/SpaceConfig.ts:19](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/spaces/types/SpaceConfig.ts#L19) | |
| ___ | |
| #### name | |
| • `Optional` **name**: `string` | |
| The name of the space | |
| ##### Inherited from | |
| [SpaceConfig](#interfacesflatfilespacesspaceconfigmd).[name](#name) | |
| ##### Defined in | |
| [src/api/resources/spaces/types/SpaceConfig.ts:15](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/spaces/types/SpaceConfig.ts#L15) | |
| ___ | |
| #### primaryWorkbookId | |
| • `Optional` **primaryWorkbookId**: `string` | |
| ##### Inherited from | |
| [SpaceConfig](#interfacesflatfilespacesspaceconfigmd).[primaryWorkbookId](#primaryworkbookid) | |
| ##### Defined in | |
| [src/api/resources/spaces/types/SpaceConfig.ts:13](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/spaces/types/SpaceConfig.ts#L13) | |
| ___ | |
| #### spaceConfigId | |
| • `Optional` **spaceConfigId**: `string` | |
| ##### Inherited from | |
| [SpaceConfig](#interfacesflatfilespacesspaceconfigmd).[spaceConfigId](#spaceconfigid) | |
| ##### Defined in | |
| [src/api/resources/spaces/types/SpaceConfig.ts:11](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/spaces/types/SpaceConfig.ts#L11) | |
| ___ | |
| #### updatedAt | |
| • **updatedAt**: `Date` | |
| Date when space was updated | |
| ##### Defined in | |
| [src/api/resources/spaces/types/Space.ts:22](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/spaces/types/Space.ts#L22) | |
| ___ | |
| #### workbookCount | |
| • `Optional` **workbookCount**: `number` | |
| Amount of workbooks in the space | |
| ##### Defined in | |
| [src/api/resources/spaces/types/Space.ts:13](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/spaces/types/Space.ts#L13) | |
| <a name="interfacesflatfilespacesspaceconfigmd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / [spaces](#modulesflatfilespacesmd) / SpaceConfig | |
| ## Interface: SpaceConfig | |
| [Flatfile](#modulesflatfilemd).[spaces](#modulesflatfilespacesmd).SpaceConfig | |
| Properties used to create a new Space | |
| ### Hierarchy | |
| - **`SpaceConfig`** | |
| ↳ [`Space`](#interfacesflatfilespacesspacemd) | |
| ### Table of contents | |
| #### Properties | |
| - [access](#access) | |
| - [actions](#actions) | |
| - [autoConfigure](#autoconfigure) | |
| - [displayOrder](#displayorder) | |
| - [environmentId](#environmentid) | |
| - [guestAuthentication](#guestauthentication) | |
| - [metadata](#metadata) | |
| - [name](#name) | |
| - [primaryWorkbookId](#primaryworkbookid) | |
| - [spaceConfigId](#spaceconfigid) | |
| ### Properties | |
| #### access | |
| • `Optional` **access**: [`SpaceAccess`](#spaceaccess-1)[] | |
| ##### Defined in | |
| [src/api/resources/spaces/types/SpaceConfig.ts:22](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/spaces/types/SpaceConfig.ts#L22) | |
| ___ | |
| #### actions | |
| • `Optional` **actions**: [`Action`](#interfacesflatfilecommonsactionmd)[] | |
| ##### Defined in | |
| [src/api/resources/spaces/types/SpaceConfig.ts:20](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/spaces/types/SpaceConfig.ts#L20) | |
| ___ | |
| #### autoConfigure | |
| • `Optional` **autoConfigure**: `boolean` | |
| ##### Defined in | |
| [src/api/resources/spaces/types/SpaceConfig.ts:23](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/spaces/types/SpaceConfig.ts#L23) | |
| ___ | |
| #### displayOrder | |
| • `Optional` **displayOrder**: `number` | |
| The display order | |
| ##### Defined in | |
| [src/api/resources/spaces/types/SpaceConfig.ts:17](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/spaces/types/SpaceConfig.ts#L17) | |
| ___ | |
| #### environmentId | |
| • **environmentId**: `string` | |
| ##### Defined in | |
| [src/api/resources/spaces/types/SpaceConfig.ts:12](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/spaces/types/SpaceConfig.ts#L12) | |
| ___ | |
| #### guestAuthentication | |
| • `Optional` **guestAuthentication**: [`GuestAuthenticationEnum`](#guestauthenticationenum-1)[] | |
| ##### Defined in | |
| [src/api/resources/spaces/types/SpaceConfig.ts:21](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/spaces/types/SpaceConfig.ts#L21) | |
| ___ | |
| #### metadata | |
| • `Optional` **metadata**: `unknown` | |
| Metadata for the space | |
| ##### Defined in | |
| [src/api/resources/spaces/types/SpaceConfig.ts:19](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/spaces/types/SpaceConfig.ts#L19) | |
| ___ | |
| #### name | |
| • `Optional` **name**: `string` | |
| The name of the space | |
| ##### Defined in | |
| [src/api/resources/spaces/types/SpaceConfig.ts:15](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/spaces/types/SpaceConfig.ts#L15) | |
| ___ | |
| #### primaryWorkbookId | |
| • `Optional` **primaryWorkbookId**: `string` | |
| ##### Defined in | |
| [src/api/resources/spaces/types/SpaceConfig.ts:13](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/spaces/types/SpaceConfig.ts#L13) | |
| ___ | |
| #### spaceConfigId | |
| • `Optional` **spaceConfigId**: `string` | |
| ##### Defined in | |
| [src/api/resources/spaces/types/SpaceConfig.ts:11](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/spaces/types/SpaceConfig.ts#L11) | |
| <a name="interfacesflatfilespacesspaceresponsemd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / [spaces](#modulesflatfilespacesmd) / SpaceResponse | |
| ## Interface: SpaceResponse | |
| [Flatfile](#modulesflatfilemd).[spaces](#modulesflatfilespacesmd).SpaceResponse | |
| ### Table of contents | |
| #### Properties | |
| - [data](#data) | |
| ### Properties | |
| #### data | |
| • **data**: [`Space`](#interfacesflatfilespacesspacemd) | |
| ##### Defined in | |
| [src/api/resources/spaces/types/SpaceResponse.ts:8](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/spaces/types/SpaceResponse.ts#L8) | |
| <a name="interfacesflatfileusersapitokenmd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / [users](#modulesflatfileusersmd) / ApiToken | |
| ## Interface: ApiToken | |
| [Flatfile](#modulesflatfilemd).[users](#modulesflatfileusersmd).ApiToken | |
| Client id and secret used for authenticating against our APIs | |
| ### Table of contents | |
| #### Properties | |
| - [clientId](#clientid) | |
| - [createdAt](#createdat) | |
| - [description](#description) | |
| - [metadata](#metadata) | |
| - [secret](#secret) | |
| ### Properties | |
| #### clientId | |
| • **clientId**: `string` | |
| ##### Defined in | |
| [src/api/resources/users/types/ApiToken.ts:9](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/users/types/ApiToken.ts#L9) | |
| ___ | |
| #### createdAt | |
| • **createdAt**: `Date` | |
| ##### Defined in | |
| [src/api/resources/users/types/ApiToken.ts:12](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/users/types/ApiToken.ts#L12) | |
| ___ | |
| #### description | |
| • **description**: `string` | |
| ##### Defined in | |
| [src/api/resources/users/types/ApiToken.ts:10](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/users/types/ApiToken.ts#L10) | |
| ___ | |
| #### metadata | |
| • **metadata**: `Record`<`string`, `unknown`\> | |
| ##### Defined in | |
| [src/api/resources/users/types/ApiToken.ts:11](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/users/types/ApiToken.ts#L11) | |
| ___ | |
| #### secret | |
| • `Optional` **secret**: `string` | |
| ##### Defined in | |
| [src/api/resources/users/types/ApiToken.ts:13](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/users/types/ApiToken.ts#L13) | |
| <a name="interfacesflatfileuserscreateapitokenrequestmd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / [users](#modulesflatfileusersmd) / CreateApiTokenRequest | |
| ## Interface: CreateApiTokenRequest | |
| [Flatfile](#modulesflatfilemd).[users](#modulesflatfileusersmd).CreateApiTokenRequest | |
| This file was auto-generated by Fern from our API Definition. | |
| ### Table of contents | |
| #### Properties | |
| - [tenantId](#tenantid) | |
| ### Properties | |
| #### tenantId | |
| • **tenantId**: `string` | |
| ##### Defined in | |
| [src/api/resources/users/client/requests/CreateApiTokenRequest.ts:6](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/users/client/requests/CreateApiTokenRequest.ts#L6) | |
| <a name="interfacesflatfileusersexchangetokendatamd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / [users](#modulesflatfileusersmd) / ExchangeTokenData | |
| ## Interface: ExchangeTokenData | |
| [Flatfile](#modulesflatfilemd).[users](#modulesflatfileusersmd).ExchangeTokenData | |
| This file was auto-generated by Fern from our API Definition. | |
| ### Table of contents | |
| #### Properties | |
| - [sentTo](#sentto) | |
| - [token](#token) | |
| - [valid](#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](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/users/types/ExchangeTokenData.ts#L11) | |
| ___ | |
| #### token | |
| • `Optional` **token**: `string` | |
| The refreshed token, if the provided token was valid | |
| ##### Defined in | |
| [src/api/resources/users/types/ExchangeTokenData.ts:9](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/users/types/ExchangeTokenData.ts#L9) | |
| ___ | |
| #### valid | |
| • **valid**: `boolean` | |
| Whether the provided token was valid | |
| ##### Defined in | |
| [src/api/resources/users/types/ExchangeTokenData.ts:7](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/users/types/ExchangeTokenData.ts#L7) | |
| <a name="interfacesflatfileusersexchangetokenrequestmd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / [users](#modulesflatfileusersmd) / ExchangeTokenRequest | |
| ## Interface: ExchangeTokenRequest | |
| [Flatfile](#modulesflatfilemd).[users](#modulesflatfileusersmd).ExchangeTokenRequest | |
| This file was auto-generated by Fern from our API Definition. | |
| ### Table of contents | |
| #### Properties | |
| - [email](#email) | |
| - [spaceId](#spaceid) | |
| - [token](#token) | |
| ### Properties | |
| • `Optional` **email**: `string` | |
| The invited guest's email, required if no token | |
| ##### Defined in | |
| [src/api/resources/users/client/requests/ExchangeTokenRequest.ts:9](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/users/client/requests/ExchangeTokenRequest.ts#L9) | |
| ___ | |
| #### spaceId | |
| • `Optional` **spaceId**: `string` | |
| The spaceId, required if no token | |
| ##### Defined in | |
| [src/api/resources/users/client/requests/ExchangeTokenRequest.ts:11](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/users/client/requests/ExchangeTokenRequest.ts#L11) | |
| ___ | |
| #### token | |
| • `Optional` **token**: `string` | |
| The token to use for the request | |
| ##### Defined in | |
| [src/api/resources/users/client/requests/ExchangeTokenRequest.ts:7](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/users/client/requests/ExchangeTokenRequest.ts#L7) | |
| <a name="interfacesflatfileusersexchangetokenresponsemd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / [users](#modulesflatfileusersmd) / ExchangeTokenResponse | |
| ## Interface: ExchangeTokenResponse | |
| [Flatfile](#modulesflatfilemd).[users](#modulesflatfileusersmd).ExchangeTokenResponse | |
| ### Table of contents | |
| #### Properties | |
| - [data](#data) | |
| ### Properties | |
| #### data | |
| • **data**: [`ExchangeTokenData`](#interfacesflatfileusersexchangetokendatamd) | |
| ##### Defined in | |
| [src/api/resources/users/types/ExchangeTokenResponse.ts:8](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/users/types/ExchangeTokenResponse.ts#L8) | |
| <a name="interfacesflatfileuserslistapitokensrequestmd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / [users](#modulesflatfileusersmd) / ListApiTokensRequest | |
| ## Interface: ListApiTokensRequest | |
| [Flatfile](#modulesflatfilemd).[users](#modulesflatfileusersmd).ListApiTokensRequest | |
| This file was auto-generated by Fern from our API Definition. | |
| ### Table of contents | |
| #### Properties | |
| - [pageNumber](#pagenumber) | |
| - [pageSize](#pagesize) | |
| - [tenantId](#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](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/users/client/requests/ListApiTokensRequest.ts#L14) | |
| ___ | |
| #### 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](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/users/client/requests/ListApiTokensRequest.ts#L10) | |
| ___ | |
| #### tenantId | |
| • **tenantId**: `string` | |
| ##### Defined in | |
| [src/api/resources/users/client/requests/ListApiTokensRequest.ts:6](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/users/client/requests/ListApiTokensRequest.ts#L6) | |
| <a name="interfacesflatfileuserslistapitokensresponsemd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / [users](#modulesflatfileusersmd) / ListApiTokensResponse | |
| ## Interface: ListApiTokensResponse | |
| [Flatfile](#modulesflatfilemd).[users](#modulesflatfileusersmd).ListApiTokensResponse | |
| List of api tokens without secrets | |
| ### Table of contents | |
| #### Properties | |
| - [data](#data) | |
| - [pagination](#pagination) | |
| ### Properties | |
| #### data | |
| • **data**: [`ApiToken`](#interfacesflatfileusersapitokenmd)[] | |
| ##### Defined in | |
| [src/api/resources/users/types/ListApiTokensResponse.ts:12](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/users/types/ListApiTokensResponse.ts#L12) | |
| ___ | |
| #### pagination | |
| • `Optional` **pagination**: [`Pagination`](#interfacesflatfilecommonspaginationmd) | |
| ##### Defined in | |
| [src/api/resources/users/types/ListApiTokensResponse.ts:11](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/users/types/ListApiTokensResponse.ts#L11) | |
| <a name="interfacesflatfileuserslistusersrequestmd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / [users](#modulesflatfileusersmd) / ListUsersRequest | |
| ## Interface: ListUsersRequest | |
| [Flatfile](#modulesflatfilemd).[users](#modulesflatfileusersmd).ListUsersRequest | |
| This file was auto-generated by Fern from our API Definition. | |
| ### Table of contents | |
| #### Properties | |
| - [email](#email) | |
| ### Properties | |
| • `Optional` **email**: `string` | |
| Email of guest to return | |
| ##### Defined in | |
| [src/api/resources/users/client/requests/ListUsersRequest.ts:9](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/users/client/requests/ListUsersRequest.ts#L9) | |
| <a name="interfacesflatfileuserslistusersresponsemd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / [users](#modulesflatfileusersmd) / ListUsersResponse | |
| ## Interface: ListUsersResponse | |
| [Flatfile](#modulesflatfilemd).[users](#modulesflatfileusersmd).ListUsersResponse | |
| ### Table of contents | |
| #### Properties | |
| - [data](#data) | |
| ### Properties | |
| #### data | |
| • **data**: [`User`](#interfacesflatfileusersusermd)[] | |
| ##### Defined in | |
| [src/api/resources/users/types/ListUsersResponse.ts:8](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/users/types/ListUsersResponse.ts#L8) | |
| <a name="interfacesflatfileusersusermd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / [users](#modulesflatfileusersmd) / User | |
| ## Interface: User | |
| [Flatfile](#modulesflatfilemd).[users](#modulesflatfileusersmd).User | |
| Configurations for the user | |
| ### Hierarchy | |
| - [`UserConfig`](#interfacesflatfileusersuserconfigmd) | |
| ↳ **`User`** | |
| ### Table of contents | |
| #### Properties | |
| - [accountId](#accountid) | |
| - [email](#email) | |
| - [id](#id) | |
| - [name](#name) | |
| ### Properties | |
| #### accountId | |
| • **accountId**: `string` | |
| ##### Inherited from | |
| [UserConfig](#interfacesflatfileusersuserconfigmd).[accountId](#accountid) | |
| ##### Defined in | |
| [src/api/resources/users/types/UserConfig.ts:13](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/users/types/UserConfig.ts#L13) | |
| ___ | |
| • **email**: `string` | |
| ##### Inherited from | |
| [UserConfig](#interfacesflatfileusersuserconfigmd).[email](#email) | |
| ##### Defined in | |
| [src/api/resources/users/types/UserConfig.ts:11](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/users/types/UserConfig.ts#L11) | |
| ___ | |
| #### id | |
| • **id**: `string` | |
| ##### Defined in | |
| [src/api/resources/users/types/User.ts:11](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/users/types/User.ts#L11) | |
| ___ | |
| #### name | |
| • **name**: `string` | |
| ##### Inherited from | |
| [UserConfig](#interfacesflatfileusersuserconfigmd).[name](#name) | |
| ##### Defined in | |
| [src/api/resources/users/types/UserConfig.ts:12](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/users/types/UserConfig.ts#L12) | |
| <a name="interfacesflatfileusersuserconfigmd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / [users](#modulesflatfileusersmd) / UserConfig | |
| ## Interface: UserConfig | |
| [Flatfile](#modulesflatfilemd).[users](#modulesflatfileusersmd).UserConfig | |
| Properties used to create a new user | |
| ### Hierarchy | |
| - **`UserConfig`** | |
| ↳ [`User`](#interfacesflatfileusersusermd) | |
| ### Table of contents | |
| #### Properties | |
| - [accountId](#accountid) | |
| - [email](#email) | |
| - [name](#name) | |
| ### Properties | |
| #### accountId | |
| • **accountId**: `string` | |
| ##### Defined in | |
| [src/api/resources/users/types/UserConfig.ts:13](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/users/types/UserConfig.ts#L13) | |
| ___ | |
| • **email**: `string` | |
| ##### Defined in | |
| [src/api/resources/users/types/UserConfig.ts:11](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/users/types/UserConfig.ts#L11) | |
| ___ | |
| #### name | |
| • **name**: `string` | |
| ##### Defined in | |
| [src/api/resources/users/types/UserConfig.ts:12](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/users/types/UserConfig.ts#L12) | |
| <a name="interfacesflatfileusersuserresponsemd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / [users](#modulesflatfileusersmd) / UserResponse | |
| ## Interface: UserResponse | |
| [Flatfile](#modulesflatfilemd).[users](#modulesflatfileusersmd).UserResponse | |
| ### Table of contents | |
| #### Properties | |
| - [data](#data) | |
| ### Properties | |
| #### data | |
| • **data**: [`User`](#interfacesflatfileusersusermd) | |
| ##### Defined in | |
| [src/api/resources/users/types/UserResponse.ts:8](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/users/types/UserResponse.ts#L8) | |
| <a name="interfacesflatfileversionsversionresponsemd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / [versions](#modulesflatfileversionsmd) / VersionResponse | |
| ## Interface: VersionResponse | |
| [Flatfile](#modulesflatfilemd).[versions](#modulesflatfileversionsmd).VersionResponse | |
| ### Table of contents | |
| #### Properties | |
| - [versionId](#versionid) | |
| ### Properties | |
| #### versionId | |
| • **versionId**: `string` | |
| ##### Defined in | |
| [src/api/resources/versions/types/VersionResponse.ts:8](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/versions/types/VersionResponse.ts#L8) | |
| <a name="interfacesflatfileversionsversionspostrequestbodymd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / [versions](#modulesflatfileversionsmd) / VersionsPostRequestBody | |
| ## Interface: VersionsPostRequestBody | |
| [Flatfile](#modulesflatfilemd).[versions](#modulesflatfileversionsmd).VersionsPostRequestBody | |
| ### Table of contents | |
| #### Properties | |
| - [parentVersionId](#parentversionid) | |
| - [sheetId](#sheetid) | |
| ### Properties | |
| #### parentVersionId | |
| • `Optional` **parentVersionId**: `string` | |
| ##### Defined in | |
| [src/api/resources/versions/client/requests/VersionsPostRequestBody.ts:9](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/versions/client/requests/VersionsPostRequestBody.ts#L9) | |
| ___ | |
| #### sheetId | |
| • `Optional` **sheetId**: `string` | |
| ##### Defined in | |
| [src/api/resources/versions/client/requests/VersionsPostRequestBody.ts:8](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/versions/client/requests/VersionsPostRequestBody.ts#L8) | |
| <a name="interfacesflatfileworkbookscreateworkbookconfigmd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / [workbooks](#modulesflatfileworkbooksmd) / CreateWorkbookConfig | |
| ## Interface: CreateWorkbookConfig | |
| [Flatfile](#modulesflatfilemd).[workbooks](#modulesflatfileworkbooksmd).CreateWorkbookConfig | |
| Properties used to create a new Workbook | |
| ### Table of contents | |
| #### Properties | |
| - [actions](#actions) | |
| - [environmentId](#environmentid) | |
| - [labels](#labels) | |
| - [name](#name) | |
| - [sheets](#sheets) | |
| - [spaceId](#spaceid) | |
| ### Properties | |
| #### actions | |
| • `Optional` **actions**: [`Action`](#interfacesflatfilecommonsactionmd)[] | |
| ##### Defined in | |
| [src/api/resources/workbooks/types/CreateWorkbookConfig.ts:17](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/workbooks/types/CreateWorkbookConfig.ts#L17) | |
| ___ | |
| #### environmentId | |
| • `Optional` **environmentId**: `string` | |
| ##### Defined in | |
| [src/api/resources/workbooks/types/CreateWorkbookConfig.ts:14](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/workbooks/types/CreateWorkbookConfig.ts#L14) | |
| ___ | |
| #### labels | |
| • `Optional` **labels**: `string`[] | |
| ##### Defined in | |
| [src/api/resources/workbooks/types/CreateWorkbookConfig.ts:12](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/workbooks/types/CreateWorkbookConfig.ts#L12) | |
| ___ | |
| #### name | |
| • **name**: `string` | |
| ##### Defined in | |
| [src/api/resources/workbooks/types/CreateWorkbookConfig.ts:11](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/workbooks/types/CreateWorkbookConfig.ts#L11) | |
| ___ | |
| #### sheets | |
| • `Optional` **sheets**: [`SheetConfig`](#interfacesflatfilesheetssheetconfigmd)[] | |
| Sheets must be <= 50 | |
| ##### Defined in | |
| [src/api/resources/workbooks/types/CreateWorkbookConfig.ts:16](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/workbooks/types/CreateWorkbookConfig.ts#L16) | |
| ___ | |
| #### spaceId | |
| • `Optional` **spaceId**: `string` | |
| ##### Defined in | |
| [src/api/resources/workbooks/types/CreateWorkbookConfig.ts:13](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/workbooks/types/CreateWorkbookConfig.ts#L13) | |
| <a name="interfacesflatfileworkbookslistworkbooksrequestmd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / [workbooks](#modulesflatfileworkbooksmd) / ListWorkbooksRequest | |
| ## Interface: ListWorkbooksRequest | |
| [Flatfile](#modulesflatfilemd).[workbooks](#modulesflatfileworkbooksmd).ListWorkbooksRequest | |
| ### Table of contents | |
| #### Properties | |
| - [includeCounts](#includecounts) | |
| - [spaceId](#spaceid) | |
| ### Properties | |
| #### includeCounts | |
| • `Optional` **includeCounts**: `boolean` | |
| Include counts for the workbook | |
| ##### Defined in | |
| [src/api/resources/workbooks/client/requests/ListWorkbooksRequest.ts:12](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/workbooks/client/requests/ListWorkbooksRequest.ts#L12) | |
| ___ | |
| #### spaceId | |
| • `Optional` **spaceId**: `string` | |
| ##### Defined in | |
| [src/api/resources/workbooks/client/requests/ListWorkbooksRequest.ts:8](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/workbooks/client/requests/ListWorkbooksRequest.ts#L8) | |
| <a name="interfacesflatfileworkbookslistworkbooksresponsemd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / [workbooks](#modulesflatfileworkbooksmd) / ListWorkbooksResponse | |
| ## Interface: ListWorkbooksResponse | |
| [Flatfile](#modulesflatfilemd).[workbooks](#modulesflatfileworkbooksmd).ListWorkbooksResponse | |
| ### Table of contents | |
| #### Properties | |
| - [data](#data) | |
| ### Properties | |
| #### data | |
| • **data**: [`Workbook`](#interfacesflatfileworkbooksworkbookmd)[] | |
| ##### Defined in | |
| [src/api/resources/workbooks/types/ListWorkbooksResponse.ts:8](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/workbooks/types/ListWorkbooksResponse.ts#L8) | |
| <a name="interfacesflatfileworkbooksupdateworkbookconfigmd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / [workbooks](#modulesflatfileworkbooksmd) / UpdateWorkbookConfig | |
| ## Interface: UpdateWorkbookConfig | |
| [Flatfile](#modulesflatfilemd).[workbooks](#modulesflatfileworkbooksmd).UpdateWorkbookConfig | |
| Properties used to create a new Workbook | |
| ### Table of contents | |
| #### Properties | |
| - [actions](#actions) | |
| - [environmentId](#environmentid) | |
| - [labels](#labels) | |
| - [name](#name) | |
| - [sheets](#sheets) | |
| - [spaceId](#spaceid) | |
| ### Properties | |
| #### actions | |
| • `Optional` **actions**: [`Action`](#interfacesflatfilecommonsactionmd)[] | |
| ##### Defined in | |
| [src/api/resources/workbooks/types/UpdateWorkbookConfig.ts:17](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/workbooks/types/UpdateWorkbookConfig.ts#L17) | |
| ___ | |
| #### environmentId | |
| • `Optional` **environmentId**: `string` | |
| ##### Defined in | |
| [src/api/resources/workbooks/types/UpdateWorkbookConfig.ts:14](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/workbooks/types/UpdateWorkbookConfig.ts#L14) | |
| ___ | |
| #### labels | |
| • `Optional` **labels**: `string`[] | |
| ##### Defined in | |
| [src/api/resources/workbooks/types/UpdateWorkbookConfig.ts:12](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/workbooks/types/UpdateWorkbookConfig.ts#L12) | |
| ___ | |
| #### name | |
| • `Optional` **name**: `string` | |
| ##### Defined in | |
| [src/api/resources/workbooks/types/UpdateWorkbookConfig.ts:11](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/workbooks/types/UpdateWorkbookConfig.ts#L11) | |
| ___ | |
| #### sheets | |
| • `Optional` **sheets**: [`SheetConfig`](#interfacesflatfilesheetssheetconfigmd)[] | |
| Sheets must be <= 50 | |
| ##### Defined in | |
| [src/api/resources/workbooks/types/UpdateWorkbookConfig.ts:16](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/workbooks/types/UpdateWorkbookConfig.ts#L16) | |
| ___ | |
| #### spaceId | |
| • `Optional` **spaceId**: `string` | |
| ##### Defined in | |
| [src/api/resources/workbooks/types/UpdateWorkbookConfig.ts:13](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/workbooks/types/UpdateWorkbookConfig.ts#L13) | |
| <a name="interfacesflatfileworkbooksworkbookmd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / [workbooks](#modulesflatfileworkbooksmd) / Workbook | |
| ## Interface: Workbook | |
| [Flatfile](#modulesflatfilemd).[workbooks](#modulesflatfileworkbooksmd).Workbook | |
| A collection of one or more sheets | |
| ### Table of contents | |
| #### Properties | |
| - [actions](#actions) | |
| - [createdAt](#createdat) | |
| - [environmentId](#environmentid) | |
| - [id](#id) | |
| - [labels](#labels) | |
| - [name](#name) | |
| - [sheets](#sheets) | |
| - [spaceId](#spaceid) | |
| - [updatedAt](#updatedat) | |
| ### Properties | |
| #### actions | |
| • `Optional` **actions**: [`Action`](#interfacesflatfilecommonsactionmd)[] | |
| ##### Defined in | |
| [src/api/resources/workbooks/types/Workbook.ts:17](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/workbooks/types/Workbook.ts#L17) | |
| ___ | |
| #### createdAt | |
| • **createdAt**: `Date` | |
| Date the workbook was created | |
| ##### Defined in | |
| [src/api/resources/workbooks/types/Workbook.ts:21](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/workbooks/types/Workbook.ts#L21) | |
| ___ | |
| #### environmentId | |
| • `Optional` **environmentId**: `string` | |
| ##### Defined in | |
| [src/api/resources/workbooks/types/Workbook.ts:14](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/workbooks/types/Workbook.ts#L14) | |
| ___ | |
| #### id | |
| • **id**: `string` | |
| ##### Defined in | |
| [src/api/resources/workbooks/types/Workbook.ts:11](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/workbooks/types/Workbook.ts#L11) | |
| ___ | |
| #### labels | |
| • `Optional` **labels**: `string`[] | |
| ##### Defined in | |
| [src/api/resources/workbooks/types/Workbook.ts:16](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/workbooks/types/Workbook.ts#L16) | |
| ___ | |
| #### name | |
| • `Optional` **name**: `string` | |
| ##### Defined in | |
| [src/api/resources/workbooks/types/Workbook.ts:12](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/workbooks/types/Workbook.ts#L12) | |
| ___ | |
| #### sheets | |
| • `Optional` **sheets**: [`Sheet`](#interfacesflatfilesheetssheetmd)[] | |
| ##### Defined in | |
| [src/api/resources/workbooks/types/Workbook.ts:15](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/workbooks/types/Workbook.ts#L15) | |
| ___ | |
| #### spaceId | |
| • **spaceId**: `string` | |
| ##### Defined in | |
| [src/api/resources/workbooks/types/Workbook.ts:13](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/workbooks/types/Workbook.ts#L13) | |
| ___ | |
| #### updatedAt | |
| • **updatedAt**: `Date` | |
| Date the workbook was last updated | |
| ##### Defined in | |
| [src/api/resources/workbooks/types/Workbook.ts:19](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/workbooks/types/Workbook.ts#L19) | |
| <a name="interfacesflatfileworkbooksworkbookresponsemd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / [workbooks](#modulesflatfileworkbooksmd) / WorkbookResponse | |
| ## Interface: WorkbookResponse | |
| [Flatfile](#modulesflatfilemd).[workbooks](#modulesflatfileworkbooksmd).WorkbookResponse | |
| ### Table of contents | |
| #### Properties | |
| - [data](#data) | |
| ### Properties | |
| #### data | |
| • **data**: [`Workbook`](#interfacesflatfileworkbooksworkbookmd) | |
| ##### Defined in | |
| [src/api/resources/workbooks/types/WorkbookResponse.ts:8](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/workbooks/types/WorkbookResponse.ts#L8) | |
| <a name="interfacesflatfileclientoptionsmd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [FlatfileClient](#modulesflatfileclientmd) / Options | |
| ## Interface: Options | |
| [FlatfileClient](#modulesflatfileclientmd).Options | |
| ### Table of contents | |
| #### Properties | |
| - [apiUrl](#apiurl) | |
| - [environment](#environment) | |
| - [token](#token) | |
| ### Properties | |
| #### apiUrl | |
| • `Optional` **apiUrl**: `string` | |
| ##### Defined in | |
| [src/wrapper/FlatfileClient.ts:16](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/wrapper/FlatfileClient.ts#L16) | |
| ___ | |
| #### environment | |
| • `Optional` **environment**: `Supplier`<`string`\> | |
| **`Deprecated`** | |
| use apiUrl instead | |
| ##### Defined in | |
| [src/wrapper/FlatfileClient.ts:15](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/wrapper/FlatfileClient.ts#L15) | |
| ___ | |
| #### token | |
| • `Optional` **token**: `Supplier`<`string`\> | |
| ##### Defined in | |
| [src/wrapper/FlatfileClient.ts:17](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/wrapper/FlatfileClient.ts#L17) | |
| <a name="modulesmd"></a> | |
| [@flatfile/api](#readmemd) / Exports | |
| # @flatfile/api | |
| ## Table of contents | |
| ### Namespaces | |
| - [Flatfile](#modulesflatfilemd) | |
| - [FlatfileClient](#modulesflatfileclientmd) | |
| ### Classes | |
| - [FlatfileClient](#classesflatfileclient-1md) | |
| - [FlatfileError](#classesflatfileerrormd) | |
| - [FlatfileTimeoutError](#classesflatfiletimeouterrormd) | |
| ### Type Aliases | |
| - [FlatfileEnvironment](#flatfileenvironment) | |
| ### Variables | |
| - [FlatfileEnvironment](#flatfileenvironment-1) | |
| - [default](#default) | |
| ## Type Aliases | |
| ### FlatfileEnvironment | |
| Ƭ **FlatfileEnvironment**: typeof [`Production`](#production) | |
| #### Defined in | |
| [src/environments.ts:5](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/environments.ts#L5) | |
| [src/environments.ts:9](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/environments.ts#L9) | |
| ## 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](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/environments.ts#L5) | |
| [src/environments.ts:9](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/environments.ts#L9) | |
| ___ | |
| ### default | |
| • **default**: [`FlatfileClient`](#classesflatfileclient-1md) | |
| #### Defined in | |
| [src/index.ts:8](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/index.ts#L8) | |
| # Modules | |
| <a name="modulesflatfileagentsmd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / agents | |
| ## Namespace: agents | |
| [Flatfile](#modulesflatfilemd).agents | |
| ### Table of contents | |
| #### Interfaces | |
| - [Agent](#interfacesflatfileagentsagentmd) | |
| - [AgentConfig](#interfacesflatfileagentsagentconfigmd) | |
| - [AgentLog](#interfacesflatfileagentsagentlogmd) | |
| - [AgentResponse](#interfacesflatfileagentsagentresponsemd) | |
| - [CreateAgentsRequest](#interfacesflatfileagentscreateagentsrequestmd) | |
| - [DeleteAgentRequest](#interfacesflatfileagentsdeleteagentrequestmd) | |
| - [GetAgentLogsRequest](#interfacesflatfileagentsgetagentlogsrequestmd) | |
| - [GetAgentLogsResponse](#interfacesflatfileagentsgetagentlogsresponsemd) | |
| - [GetAgentRequest](#interfacesflatfileagentsgetagentrequestmd) | |
| - [GetEnvironmentAgentLogsRequest](#interfacesflatfileagentsgetenvironmentagentlogsrequestmd) | |
| - [ListAgentsRequest](#interfacesflatfileagentslistagentsrequestmd) | |
| - [ListAgentsResponse](#interfacesflatfileagentslistagentsresponsemd) | |
| #### Type Aliases | |
| - [Compiler](#compiler) | |
| #### Variables | |
| - [Compiler](#compiler-1) | |
| ### Type Aliases | |
| #### Compiler | |
| Ƭ **Compiler**: ``"js"`` | |
| The compiler of the agent | |
| **`Example`** | |
| ```ts | |
| Flatfile.Compiler.Js | |
| ``` | |
| ##### Defined in | |
| [src/api/resources/agents/types/Compiler.ts:11](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/agents/types/Compiler.ts#L11) | |
| [src/api/resources/agents/types/Compiler.ts:13](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/agents/types/Compiler.ts#L13) | |
| ### Variables | |
| #### Compiler | |
| • **Compiler**: `Object` | |
| ##### Type declaration | |
| | Name | Type | | |
| | :------ | :------ | | |
| | `Js` | ``"js"`` | | |
| ##### Defined in | |
| [src/api/resources/agents/types/Compiler.ts:11](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/agents/types/Compiler.ts#L11) | |
| [src/api/resources/agents/types/Compiler.ts:13](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/agents/types/Compiler.ts#L13) | |
| <a name="modulesflatfileauthmd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / auth | |
| ## Namespace: auth | |
| [Flatfile](#modulesflatfilemd).auth | |
| ### Table of contents | |
| #### Interfaces | |
| - [ApiKey](#interfacesflatfileauthapikeymd) | |
| - [ApiKeyOperation](#interfacesflatfileauthapikeyoperationmd) | |
| - [ApiKeysResponse](#interfacesflatfileauthapikeysresponsemd) | |
| - [GetApiKeysRequest](#interfacesflatfileauthgetapikeysrequestmd) | |
| #### Type Aliases | |
| - [ApiKeyType](#apikeytype) | |
| #### Variables | |
| - [ApiKeyType](#apikeytype-1) | |
| ### 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](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/auth/types/ApiKeyType.ts#L5) | |
| [src/api/resources/auth/types/ApiKeyType.ts:7](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/auth/types/ApiKeyType.ts#L7) | |
| ### Variables | |
| #### ApiKeyType | |
| • **ApiKeyType**: `Object` | |
| ##### Type declaration | |
| | Name | Type | | |
| | :------ | :------ | | |
| | `Publishable` | ``"PUBLISHABLE"`` | | |
| | `Secret` | ``"SECRET"`` | | |
| ##### Defined in | |
| [src/api/resources/auth/types/ApiKeyType.ts:5](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/auth/types/ApiKeyType.ts#L5) | |
| [src/api/resources/auth/types/ApiKeyType.ts:7](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/auth/types/ApiKeyType.ts#L7) | |
| <a name="modulesflatfilebillingmd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / billing | |
| ## Namespace: billing | |
| [Flatfile](#modulesflatfilemd).billing | |
| ### Table of contents | |
| #### Interfaces | |
| - [CheckoutSession](#interfacesflatfilebillingcheckoutsessionmd) | |
| - [CreateCheckoutSessionResponse](#interfacesflatfilebillingcreatecheckoutsessionresponsemd) | |
| - [ProductsResponse](#interfacesflatfilebillingproductsresponsemd) | |
| - [StripeProduct](#interfacesflatfilebillingstripeproductmd) | |
| <a name="modulesflatfilecellsmd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / cells | |
| ## Namespace: cells | |
| [Flatfile](#modulesflatfilemd).cells | |
| ### Table of contents | |
| #### Interfaces | |
| - [CellValueWithCounts](#interfacesflatfilecellscellvaluewithcountsmd) | |
| - [CellsResponse](#interfacesflatfilecellscellsresponsemd) | |
| - [GetFieldValuesRequest](#interfacesflatfilecellsgetfieldvaluesrequestmd) | |
| #### Type Aliases | |
| - [CellsResponseData](#cellsresponsedata) | |
| ### Type Aliases | |
| #### CellsResponseData | |
| Ƭ **CellsResponseData**: `Record`<`string`, [`CellValueWithCounts`](#interfacesflatfilecellscellvaluewithcountsmd)[]\> | |
| Cell values grouped by field key | |
| ##### Defined in | |
| [src/api/resources/cells/types/CellsResponseData.ts:10](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/cells/types/CellsResponseData.ts#L10) | |
| <a name="modulesflatfilecommonsmd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / commons | |
| ## Namespace: commons | |
| [Flatfile](#modulesflatfilemd).commons | |
| ### Table of contents | |
| #### Classes | |
| - [BadRequestError](#classesflatfilecommonsbadrequesterrormd) | |
| - [NotFoundError](#classesflatfilecommonsnotfounderrormd) | |
| #### Interfaces | |
| - [Action](#interfacesflatfilecommonsactionmd) | |
| - [Error\_](#interfacesflatfilecommonserror_md) | |
| - [Pagination](#interfacesflatfilecommonspaginationmd) | |
| - [Success](#interfacesflatfilecommonssuccessmd) | |
| - [SuccessData](#interfacesflatfilecommonssuccessdatamd) | |
| #### Type Aliases | |
| - [AccountId](#accountid) | |
| - [ActionMode](#actionmode) | |
| - [AgentId](#agentid) | |
| - [DocumentId](#documentid) | |
| - [EnvironmentId](#environmentid) | |
| - [EventId](#eventid) | |
| - [FileId](#fileid) | |
| - [Filter](#filter) | |
| - [FilterField](#filterfield) | |
| - [GuestId](#guestid) | |
| - [JobId](#jobid) | |
| - [RecordId](#recordid) | |
| - [SearchField](#searchfield) | |
| - [SearchValue](#searchvalue) | |
| - [SheetId](#sheetid) | |
| - [SortDirection](#sortdirection) | |
| - [SortField](#sortfield) | |
| - [SpaceConfigId](#spaceconfigid) | |
| - [SpaceId](#spaceid) | |
| - [UserId](#userid) | |
| - [VersionId](#versionid) | |
| - [WorkbookId](#workbookid) | |
| #### Variables | |
| - [ActionMode](#actionmode-1) | |
| - [Filter](#filter-1) | |
| - [SortDirection](#sortdirection-1) | |
| ### Type Aliases | |
| #### AccountId | |
| Ƭ **AccountId**: `string` | |
| Account ID | |
| **`Example`** | |
| ```ts | |
| "us_acc_uj6s91wc" | |
| ``` | |
| ##### Defined in | |
| [src/api/resources/commons/types/AccountId.ts:11](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/commons/types/AccountId.ts#L11) | |
| ___ | |
| #### 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](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/commons/types/ActionMode.ts#L5) | |
| [src/api/resources/commons/types/ActionMode.ts:7](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/commons/types/ActionMode.ts#L7) | |
| ___ | |
| #### AgentId | |
| Ƭ **AgentId**: `string` | |
| Agent ID | |
| **`Example`** | |
| ```ts | |
| "us_ag_qGZbKwDW" | |
| ``` | |
| ##### Defined in | |
| [src/api/resources/commons/types/AgentId.ts:11](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/commons/types/AgentId.ts#L11) | |
| ___ | |
| #### DocumentId | |
| Ƭ **DocumentId**: `string` | |
| Document ID | |
| **`Example`** | |
| ```ts | |
| "us_dc_KwDW6cfH" | |
| ``` | |
| ##### Defined in | |
| [src/api/resources/commons/types/DocumentId.ts:11](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/commons/types/DocumentId.ts#L11) | |
| ___ | |
| #### EnvironmentId | |
| Ƭ **EnvironmentId**: `string` | |
| Environment ID | |
| **`Example`** | |
| ```ts | |
| "us_env_hVXkXs0b" | |
| ``` | |
| ##### Defined in | |
| [src/api/resources/commons/types/EnvironmentId.ts:11](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/commons/types/EnvironmentId.ts#L11) | |
| ___ | |
| #### EventId | |
| Ƭ **EventId**: `string` | |
| Event ID | |
| **`Example`** | |
| ```ts | |
| "us_evt_9cuesESa7W9cuesE" | |
| ``` | |
| ##### Defined in | |
| [src/api/resources/commons/types/EventId.ts:11](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/commons/types/EventId.ts#L11) | |
| ___ | |
| #### FileId | |
| Ƭ **FileId**: `string` | |
| File ID | |
| **`Example`** | |
| ```ts | |
| "us_fl_qGZbKwDW" | |
| ``` | |
| ##### Defined in | |
| [src/api/resources/commons/types/FileId.ts:11](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/commons/types/FileId.ts#L11) | |
| ___ | |
| #### Filter | |
| Ƭ **Filter**: ``"valid"`` \| ``"error"`` \| ``"all"`` \| ``"none"`` | |
| Options to filter records | |
| ##### Defined in | |
| [src/api/resources/commons/types/Filter.ts:8](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/commons/types/Filter.ts#L8) | |
| [src/api/resources/commons/types/Filter.ts:10](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/commons/types/Filter.ts#L10) | |
| ___ | |
| #### 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](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/commons/types/FilterField.ts#L8) | |
| ___ | |
| #### GuestId | |
| Ƭ **GuestId**: `string` | |
| Guest ID | |
| **`Example`** | |
| ```ts | |
| "us_g_5ue7P9cU" | |
| ``` | |
| ##### Defined in | |
| [src/api/resources/commons/types/GuestId.ts:11](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/commons/types/GuestId.ts#L11) | |
| ___ | |
| #### JobId | |
| Ƭ **JobId**: `string` | |
| Pipeline Job ID | |
| **`Example`** | |
| ```ts | |
| "us_jb_UQg89Drd" | |
| ``` | |
| ##### Defined in | |
| [src/api/resources/commons/types/JobId.ts:11](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/commons/types/JobId.ts#L11) | |
| ___ | |
| #### RecordId | |
| Ƭ **RecordId**: `string` | |
| Record ID | |
| **`Example`** | |
| ```ts | |
| "us_rc_a7W9cuesESa7W9cu" | |
| ``` | |
| ##### Defined in | |
| [src/api/resources/commons/types/RecordId.ts:11](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/commons/types/RecordId.ts#L11) | |
| ___ | |
| #### SearchField | |
| Ƭ **SearchField**: `string` | |
| Use this to narrow the searchValue results to a specific field | |
| ##### Defined in | |
| [src/api/resources/commons/types/SearchField.ts:8](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/commons/types/SearchField.ts#L8) | |
| ___ | |
| #### SearchValue | |
| Ƭ **SearchValue**: `string` | |
| Search the entire sheet for the given value, returning matching rows | |
| ##### Defined in | |
| [src/api/resources/commons/types/SearchValue.ts:8](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/commons/types/SearchValue.ts#L8) | |
| ___ | |
| #### SheetId | |
| Ƭ **SheetId**: `string` | |
| Sheet ID | |
| **`Example`** | |
| ```ts | |
| "us_sh_fHfzjzHb" | |
| ``` | |
| ##### Defined in | |
| [src/api/resources/commons/types/SheetId.ts:11](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/commons/types/SheetId.ts#L11) | |
| ___ | |
| #### SortDirection | |
| Ƭ **SortDirection**: ``"asc"`` \| ``"desc"`` | |
| Sort direction - asc (ascending) or desc (descending) | |
| **`Example`** | |
| ```ts | |
| Flatfile.SortDirection.Asc | |
| ``` | |
| ##### Defined in | |
| [src/api/resources/commons/types/SortDirection.ts:11](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/commons/types/SortDirection.ts#L11) | |
| [src/api/resources/commons/types/SortDirection.ts:13](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/commons/types/SortDirection.ts#L13) | |
| ___ | |
| #### SortField | |
| Ƭ **SortField**: `string` | |
| Name of field by which to sort records | |
| ##### Defined in | |
| [src/api/resources/commons/types/SortField.ts:8](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/commons/types/SortField.ts#L8) | |
| ___ | |
| #### SpaceConfigId | |
| Ƭ **SpaceConfigId**: `string` | |
| Space Config ID | |
| **`Example`** | |
| ```ts | |
| "us_sc_uj691wck" | |
| ``` | |
| ##### Defined in | |
| [src/api/resources/commons/types/SpaceConfigId.ts:11](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/commons/types/SpaceConfigId.ts#L11) | |
| ___ | |
| #### SpaceId | |
| Ƭ **SpaceId**: `string` | |
| Space ID | |
| **`Example`** | |
| ```ts | |
| "us_sp_DrdXetPN" | |
| ``` | |
| ##### Defined in | |
| [src/api/resources/commons/types/SpaceId.ts:11](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/commons/types/SpaceId.ts#L11) | |
| ___ | |
| #### UserId | |
| Ƭ **UserId**: `string` | |
| User ID | |
| **`Example`** | |
| ```ts | |
| "us_usr_a7Ws9cue" | |
| ``` | |
| ##### Defined in | |
| [src/api/resources/commons/types/UserId.ts:11](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/commons/types/UserId.ts#L11) | |
| ___ | |
| #### VersionId | |
| Ƭ **VersionId**: `string` | |
| Version ID | |
| **`Example`** | |
| ```ts | |
| "us_vr_jte4tzVn" | |
| ``` | |
| ##### Defined in | |
| [src/api/resources/commons/types/VersionId.ts:11](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/commons/types/VersionId.ts#L11) | |
| ___ | |
| #### WorkbookId | |
| Ƭ **WorkbookId**: `string` | |
| Workbook ID | |
| **`Example`** | |
| ```ts | |
| "us_wb_qGZbKwDW" | |
| ``` | |
| ##### Defined in | |
| [src/api/resources/commons/types/WorkbookId.ts:11](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/commons/types/WorkbookId.ts#L11) | |
| ### Variables | |
| #### ActionMode | |
| • **ActionMode**: `Object` | |
| ##### Type declaration | |
| | Name | Type | | |
| | :------ | :------ | | |
| | `Background` | ``"background"`` | | |
| | `Foreground` | ``"foreground"`` | | |
| ##### Defined in | |
| [src/api/resources/commons/types/ActionMode.ts:5](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/commons/types/ActionMode.ts#L5) | |
| [src/api/resources/commons/types/ActionMode.ts:7](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/commons/types/ActionMode.ts#L7) | |
| ___ | |
| #### 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](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/commons/types/Filter.ts#L8) | |
| [src/api/resources/commons/types/Filter.ts:10](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/commons/types/Filter.ts#L10) | |
| ___ | |
| #### SortDirection | |
| • **SortDirection**: `Object` | |
| ##### Type declaration | |
| | Name | Type | | |
| | :------ | :------ | | |
| | `Asc` | ``"asc"`` | | |
| | `Desc` | ``"desc"`` | | |
| ##### Defined in | |
| [src/api/resources/commons/types/SortDirection.ts:11](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/commons/types/SortDirection.ts#L11) | |
| [src/api/resources/commons/types/SortDirection.ts:13](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/commons/types/SortDirection.ts#L13) | |
| <a name="modulesflatfiledocumentsmd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / documents | |
| ## Namespace: documents | |
| [Flatfile](#modulesflatfilemd).documents | |
| ### Table of contents | |
| #### Interfaces | |
| - [Document](#interfacesflatfiledocumentsdocumentmd) | |
| - [DocumentConfig](#interfacesflatfiledocumentsdocumentconfigmd) | |
| - [DocumentResponse](#interfacesflatfiledocumentsdocumentresponsemd) | |
| - [ListDocumentsResponse](#interfacesflatfiledocumentslistdocumentsresponsemd) | |
| <a name="modulesflatfileenvironmentsmd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / environments | |
| ## Namespace: environments | |
| [Flatfile](#modulesflatfilemd).environments | |
| ### Table of contents | |
| #### Interfaces | |
| - [Environment](#interfacesflatfileenvironmentsenvironmentmd) | |
| - [EnvironmentConfig](#interfacesflatfileenvironmentsenvironmentconfigmd) | |
| - [EnvironmentResponse](#interfacesflatfileenvironmentsenvironmentresponsemd) | |
| - [ListEnvironmentsRequest](#interfacesflatfileenvironmentslistenvironmentsrequestmd) | |
| - [ListEnvironmentsResponse](#interfacesflatfileenvironmentslistenvironmentsresponsemd) | |
| #### Type Aliases | |
| - [GuestAuthenticationEnum](#guestauthenticationenum) | |
| #### Variables | |
| - [GuestAuthenticationEnum](#guestauthenticationenum-1) | |
| ### 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](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/environments/types/GuestAuthenticationEnum.ts#L8) | |
| [src/api/resources/environments/types/GuestAuthenticationEnum.ts:10](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/environments/types/GuestAuthenticationEnum.ts#L10) | |
| ### Variables | |
| #### GuestAuthenticationEnum | |
| • **GuestAuthenticationEnum**: `Object` | |
| ##### Type declaration | |
| | Name | Type | | |
| | :------ | :------ | | |
| | `MagicLink` | ``"magic_link"`` | | |
| | `SharedLink` | ``"shared_link"`` | | |
| ##### Defined in | |
| [src/api/resources/environments/types/GuestAuthenticationEnum.ts:8](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/environments/types/GuestAuthenticationEnum.ts#L8) | |
| [src/api/resources/environments/types/GuestAuthenticationEnum.ts:10](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/environments/types/GuestAuthenticationEnum.ts#L10) | |
| <a name="modulesflatfileeventseventmd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / [events](#modulesflatfileeventsmd) / Event | |
| ## Namespace: Event | |
| [Flatfile](#modulesflatfilemd).[events](#modulesflatfileeventsmd).Event | |
| ### Table of contents | |
| #### Interfaces | |
| - [ActionTriggered](#interfacesflatfileeventseventactiontriggeredmd) | |
| - [ClientInitialized](#interfacesflatfileeventseventclientinitializedmd) | |
| - [FileDeleted](#interfacesflatfileeventseventfiledeletedmd) | |
| - [JobCompleted](#interfacesflatfileeventseventjobcompletedmd) | |
| - [JobDeleted](#interfacesflatfileeventseventjobdeletedmd) | |
| - [JobFailed](#interfacesflatfileeventseventjobfailedmd) | |
| - [JobStarted](#interfacesflatfileeventseventjobstartedmd) | |
| - [JobUpdated](#interfacesflatfileeventseventjobupdatedmd) | |
| - [JobWaiting](#interfacesflatfileeventseventjobwaitingmd) | |
| - [RecordsCreated](#interfacesflatfileeventseventrecordscreatedmd) | |
| - [RecordsDeleted](#interfacesflatfileeventseventrecordsdeletedmd) | |
| - [RecordsUpdated](#interfacesflatfileeventseventrecordsupdatedmd) | |
| - [SheetValidated](#interfacesflatfileeventseventsheetvalidatedmd) | |
| - [SpaceAdded](#interfacesflatfileeventseventspaceaddedmd) | |
| - [SpaceRemoved](#interfacesflatfileeventseventspaceremovedmd) | |
| - [UploadCompleted](#interfacesflatfileeventseventuploadcompletedmd) | |
| - [UploadFailed](#interfacesflatfileeventseventuploadfailedmd) | |
| - [UploadStarted](#interfacesflatfileeventseventuploadstartedmd) | |
| - [UserAdded](#interfacesflatfileeventseventuseraddedmd) | |
| - [UserOffline](#interfacesflatfileeventseventuserofflinemd) | |
| - [UserOnline](#interfacesflatfileeventseventuseronlinemd) | |
| - [UserRemoved](#interfacesflatfileeventseventuserremovedmd) | |
| - [WorkbookAdded](#interfacesflatfileeventseventworkbookaddedmd) | |
| - [WorkbookRemoved](#interfacesflatfileeventseventworkbookremovedmd) | |
| - [WorkbookUpdated](#interfacesflatfileeventseventworkbookupdatedmd) | |
| <a name="modulesflatfileeventsmd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / events | |
| ## Namespace: events | |
| [Flatfile](#modulesflatfilemd).events | |
| ### Table of contents | |
| #### Namespaces | |
| - [Event](#modulesflatfileeventseventmd) | |
| #### Interfaces | |
| - [ActionTriggeredEvent](#interfacesflatfileeventsactiontriggeredeventmd) | |
| - [BaseEvent](#interfacesflatfileeventsbaseeventmd) | |
| - [ClientInitializedEvent](#interfacesflatfileeventsclientinitializedeventmd) | |
| - [Context](#interfacesflatfileeventscontextmd) | |
| - [EventAttributes](#interfacesflatfileeventseventattributesmd) | |
| - [EventResponse](#interfacesflatfileeventseventresponsemd) | |
| - [FileDeletedEvent](#interfacesflatfileeventsfiledeletedeventmd) | |
| - [GetEventTokenRequest](#interfacesflatfileeventsgeteventtokenrequestmd) | |
| - [JobCompletedEvent](#interfacesflatfileeventsjobcompletedeventmd) | |
| - [JobDeletedEvent](#interfacesflatfileeventsjobdeletedeventmd) | |
| - [JobFailedEvent](#interfacesflatfileeventsjobfailedeventmd) | |
| - [JobFailedPayload](#interfacesflatfileeventsjobfailedpayloadmd) | |
| - [JobPayload](#interfacesflatfileeventsjobpayloadmd) | |
| - [JobStartedEvent](#interfacesflatfileeventsjobstartedeventmd) | |
| - [JobUpdatedEvent](#interfacesflatfileeventsjobupdatedeventmd) | |
| - [JobWaitingEvent](#interfacesflatfileeventsjobwaitingeventmd) | |
| - [ListAllEventsResponse](#interfacesflatfileeventslistalleventsresponsemd) | |
| - [ListEventsRequest](#interfacesflatfileeventslisteventsrequestmd) | |
| - [Origin](#interfacesflatfileeventsoriginmd) | |
| - [Progress](#interfacesflatfileeventsprogressmd) | |
| - [RecordsCreatedEvent](#interfacesflatfileeventsrecordscreatedeventmd) | |
| - [RecordsDeletedEvent](#interfacesflatfileeventsrecordsdeletedeventmd) | |
| - [RecordsPayload](#interfacesflatfileeventsrecordspayloadmd) | |
| - [RecordsUpdatedEvent](#interfacesflatfileeventsrecordsupdatedeventmd) | |
| - [SheetValidatedEvent](#interfacesflatfileeventssheetvalidatedeventmd) | |
| - [SpaceAddedEvent](#interfacesflatfileeventsspaceaddedeventmd) | |
| - [SpaceRemovedEvent](#interfacesflatfileeventsspaceremovedeventmd) | |
| - [UploadCompletedEvent](#interfacesflatfileeventsuploadcompletedeventmd) | |
| - [UploadFailedEvent](#interfacesflatfileeventsuploadfailedeventmd) | |
| - [UploadStartedEvent](#interfacesflatfileeventsuploadstartedeventmd) | |
| - [UserAddedEvent](#interfacesflatfileeventsuseraddedeventmd) | |
| - [UserOfflineEvent](#interfacesflatfileeventsuserofflineeventmd) | |
| - [UserOnlineEvent](#interfacesflatfileeventsuseronlineeventmd) | |
| - [UserRemovedEvent](#interfacesflatfileeventsuserremovedeventmd) | |
| - [WorkbookAddedEvent](#interfacesflatfileeventsworkbookaddedeventmd) | |
| - [WorkbookRemovedEvent](#interfacesflatfileeventsworkbookremovedeventmd) | |
| - [WorkbookUpdatedEvent](#interfacesflatfileeventsworkbookupdatedeventmd) | |
| #### Type Aliases | |
| - [ActionName](#actionname) | |
| - [Domain](#domain) | |
| - [Event](#event) | |
| - [EventTopic](#eventtopic) | |
| - [JobOperationType](#joboperationtype) | |
| - [JobPayloadType](#jobpayloadtype) | |
| - [SheetSlug](#sheetslug) | |
| #### Variables | |
| - [Domain](#domain-1) | |
| - [EventTopic](#eventtopic-1) | |
| - [JobOperationType](#joboperationtype-1) | |
| - [JobPayloadType](#jobpayloadtype-1) | |
| ### Type Aliases | |
| #### ActionName | |
| Ƭ **ActionName**: `string` | |
| Name of an action | |
| ##### Defined in | |
| [src/api/resources/events/types/ActionName.ts:8](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/ActionName.ts#L8) | |
| ___ | |
| #### Domain | |
| Ƭ **Domain**: ``"file"`` \| ``"space"`` \| ``"workbook"`` \| ``"job"`` | |
| The domain of the event | |
| **`Example`** | |
| ```ts | |
| Flatfile.Domain.Job | |
| ``` | |
| ##### Defined in | |
| [src/api/resources/events/types/Domain.ts:11](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/Domain.ts#L11) | |
| [src/api/resources/events/types/Domain.ts:13](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/Domain.ts#L13) | |
| ___ | |
| #### Event | |
| Ƭ **Event**: [`SpaceAdded`](#interfacesflatfileeventseventspaceaddedmd) \| [`SpaceRemoved`](#interfacesflatfileeventseventspaceremovedmd) \| [`WorkbookAdded`](#interfacesflatfileeventseventworkbookaddedmd) \| [`WorkbookUpdated`](#interfacesflatfileeventseventworkbookupdatedmd) \| [`WorkbookRemoved`](#interfacesflatfileeventseventworkbookremovedmd) \| [`UserAdded`](#interfacesflatfileeventseventuseraddedmd) \| [`UserRemoved`](#interfacesflatfileeventseventuserremovedmd) \| [`UserOnline`](#interfacesflatfileeventseventuseronlinemd) \| [`UserOffline`](#interfacesflatfileeventseventuserofflinemd) \| [`UploadStarted`](#interfacesflatfileeventseventuploadstartedmd) \| [`UploadFailed`](#interfacesflatfileeventseventuploadfailedmd) \| [`UploadCompleted`](#interfacesflatfileeventseventuploadcompletedmd) \| [`JobStarted`](#interfacesflatfileeventseventjobstartedmd) \| [`JobWaiting`](#interfacesflatfileeventseventjobwaitingmd) \| [`JobUpdated`](#interfacesflatfileeventseventjobupdatedmd) \| [`JobFailed`](#interfacesflatfileeventseventjobfailedmd) \| [`JobCompleted`](#interfacesflatfileeventseventjobcompletedmd) \| [`JobDeleted`](#interfacesflatfileeventseventjobdeletedmd) \| [`RecordsCreated`](#interfacesflatfileeventseventrecordscreatedmd) \| [`RecordsUpdated`](#interfacesflatfileeventseventrecordsupdatedmd) \| [`RecordsDeleted`](#interfacesflatfileeventseventrecordsdeletedmd) \| [`SheetValidated`](#interfacesflatfileeventseventsheetvalidatedmd) \| [`ActionTriggered`](#interfacesflatfileeventseventactiontriggeredmd) \| [`FileDeleted`](#interfacesflatfileeventseventfiledeletedmd) \| [`ClientInitialized`](#interfacesflatfileeventseventclientinitializedmd) | |
| Properties used to create a new event | |
| ##### Defined in | |
| [src/api/resources/events/types/Event.ts:10](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/Event.ts#L10) | |
| [src/api/resources/events/types/Event.ts:37](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/Event.ts#L37) | |
| ___ | |
| #### 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`** | |
| ```ts | |
| Flatfile.EventTopic.FileCreated | |
| ``` | |
| ##### Defined in | |
| [src/api/resources/events/types/EventTopic.ts:11](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/EventTopic.ts#L11) | |
| [src/api/resources/events/types/EventTopic.ts:42](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/EventTopic.ts#L42) | |
| ___ | |
| #### 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](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/JobOperationType.ts#L5) | |
| [src/api/resources/events/types/JobOperationType.ts:7](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/JobOperationType.ts#L7) | |
| ___ | |
| #### 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](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/JobPayloadType.ts#L5) | |
| [src/api/resources/events/types/JobPayloadType.ts:7](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/JobPayloadType.ts#L7) | |
| ___ | |
| #### SheetSlug | |
| Ƭ **SheetSlug**: `string` | |
| Sheet Slug | |
| ##### Defined in | |
| [src/api/resources/events/types/SheetSlug.ts:8](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/SheetSlug.ts#L8) | |
| ### 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](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/Domain.ts#L11) | |
| [src/api/resources/events/types/Domain.ts:13](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/Domain.ts#L13) | |
| ___ | |
| #### 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](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/EventTopic.ts#L11) | |
| [src/api/resources/events/types/EventTopic.ts:42](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/EventTopic.ts#L42) | |
| ___ | |
| #### JobOperationType | |
| • **JobOperationType**: `Object` | |
| ##### Type declaration | |
| | Name | Type | | |
| | :------ | :------ | | |
| | `Extract` | ``"EXTRACT"`` | | |
| | `Map` | ``"MAP"`` | | |
| ##### Defined in | |
| [src/api/resources/events/types/JobOperationType.ts:5](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/JobOperationType.ts#L5) | |
| [src/api/resources/events/types/JobOperationType.ts:7](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/JobOperationType.ts#L7) | |
| ___ | |
| #### JobPayloadType | |
| • **JobPayloadType**: `Object` | |
| ##### Type declaration | |
| | Name | Type | | |
| | :------ | :------ | | |
| | `File` | ``"FILE"`` | | |
| | `Pipeline` | ``"PIPELINE"`` | | |
| ##### Defined in | |
| [src/api/resources/events/types/JobPayloadType.ts:5](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/JobPayloadType.ts#L5) | |
| [src/api/resources/events/types/JobPayloadType.ts:7](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/events/types/JobPayloadType.ts#L7) | |
| <a name="modulesflatfilefilesmd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / files | |
| ## Namespace: files | |
| [Flatfile](#modulesflatfilemd).files | |
| ### Table of contents | |
| #### Interfaces | |
| - [CreateFileRequest](#interfacesflatfilefilescreatefilerequestmd) | |
| - [FileResponse](#interfacesflatfilefilesfileresponsemd) | |
| - [File\_](#interfacesflatfilefilesfile_md) | |
| - [ListFilesRequest](#interfacesflatfilefileslistfilesrequestmd) | |
| - [ListFilesResponse](#interfacesflatfilefileslistfilesresponsemd) | |
| - [UpdateFileRequest](#interfacesflatfilefilesupdatefilerequestmd) | |
| #### Type Aliases | |
| - [Mode](#mode) | |
| - [ModelFileStatusEnum](#modelfilestatusenum) | |
| #### Variables | |
| - [Mode](#mode-1) | |
| - [ModelFileStatusEnum](#modelfilestatusenum-1) | |
| ### 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](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/files/types/Mode.ts#L5) | |
| [src/api/resources/files/types/Mode.ts:7](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/files/types/Mode.ts#L7) | |
| ___ | |
| #### 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](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/files/types/ModelFileStatusEnum.ts#L5) | |
| [src/api/resources/files/types/ModelFileStatusEnum.ts:7](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/files/types/ModelFileStatusEnum.ts#L7) | |
| ### Variables | |
| #### Mode | |
| • **Mode**: `Object` | |
| ##### Type declaration | |
| | Name | Type | | |
| | :------ | :------ | | |
| | `Export` | ``"export"`` | | |
| | `Import` | ``"import"`` | | |
| ##### Defined in | |
| [src/api/resources/files/types/Mode.ts:5](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/files/types/Mode.ts#L5) | |
| [src/api/resources/files/types/Mode.ts:7](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/files/types/Mode.ts#L7) | |
| ___ | |
| #### 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](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/files/types/ModelFileStatusEnum.ts#L5) | |
| [src/api/resources/files/types/ModelFileStatusEnum.ts:7](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/files/types/ModelFileStatusEnum.ts#L7) | |
| <a name="modulesflatfileguestsmd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / guests | |
| ## Namespace: guests | |
| [Flatfile](#modulesflatfilemd).guests | |
| ### Table of contents | |
| #### Interfaces | |
| - [CreateGuestResponse](#interfacesflatfileguestscreateguestresponsemd) | |
| - [Guest](#interfacesflatfileguestsguestmd) | |
| - [GuestConfig](#interfacesflatfileguestsguestconfigmd) | |
| - [GuestSpace](#interfacesflatfileguestsguestspacemd) | |
| - [GuestWorkbook](#interfacesflatfileguestsguestworkbookmd) | |
| - [Invite](#interfacesflatfileguestsinvitemd) | |
| - [ListGuestsRequest](#interfacesflatfileguestslistguestsrequestmd) | |
| - [ListGuestsResponse](#interfacesflatfileguestslistguestsresponsemd) | |
| <a name="modulesflatfilejobsmd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / jobs | |
| ## Namespace: jobs | |
| [Flatfile](#modulesflatfilemd).jobs | |
| ### Table of contents | |
| #### Interfaces | |
| - [AiAssistJobConfig](#interfacesflatfilejobsaiassistjobconfigmd) | |
| - [CategoryMapping](#interfacesflatfilejobscategorymappingmd) | |
| - [DeleteJobConfig](#interfacesflatfilejobsdeletejobconfigmd) | |
| - [DestinationField](#interfacesflatfilejobsdestinationfieldmd) | |
| - [Edge](#interfacesflatfilejobsedgemd) | |
| - [EmptyObject](#interfacesflatfilejobsemptyobjectmd) | |
| - [EnumDetails](#interfacesflatfilejobsenumdetailsmd) | |
| - [ExportJobConfig](#interfacesflatfilejobsexportjobconfigmd) | |
| - [ExportOptions](#interfacesflatfilejobsexportoptionsmd) | |
| - [FileJobConfig](#interfacesflatfilejobsfilejobconfigmd) | |
| - [FindAndReplaceJobConfig](#interfacesflatfilejobsfindandreplacejobconfigmd) | |
| - [Job](#interfacesflatfilejobsjobmd) | |
| - [JobAckDetails](#interfacesflatfilejobsjobackdetailsmd) | |
| - [JobConfig](#interfacesflatfilejobsjobconfigmd) | |
| - [JobExecutionPlan](#interfacesflatfilejobsjobexecutionplanmd) | |
| - [JobExecutionPlanConfig](#interfacesflatfilejobsjobexecutionplanconfigmd) | |
| - [JobOutcome](#interfacesflatfilejobsjoboutcomemd) | |
| - [JobPlan](#interfacesflatfilejobsjobplanmd) | |
| - [JobResponse](#interfacesflatfilejobsjobresponsemd) | |
| - [JobUpdate](#interfacesflatfilejobsjobupdatemd) | |
| - [ListJobsRequest](#interfacesflatfilejobslistjobsrequestmd) | |
| - [ListJobsResponse](#interfacesflatfilejobslistjobsresponsemd) | |
| - [Metadata](#interfacesflatfilejobsmetadatamd) | |
| - [MutateJobConfig](#interfacesflatfilejobsmutatejobconfigmd) | |
| - [PipelineJobConfig](#interfacesflatfilejobspipelinejobconfigmd) | |
| - [SourceField](#interfacesflatfilejobssourcefieldmd) | |
| #### Type Aliases | |
| - [Certainty](#certainty) | |
| - [Driver](#driver) | |
| - [JobDestination](#jobdestination) | |
| - [JobMode](#jobmode) | |
| - [JobSource](#jobsource) | |
| - [JobStatus](#jobstatus) | |
| - [JobType](#jobtype) | |
| - [JobUpdateConfig](#jobupdateconfig) | |
| - [Trigger](#trigger) | |
| #### Variables | |
| - [Certainty](#certainty-1) | |
| - [Driver](#driver-1) | |
| - [JobMode](#jobmode-1) | |
| - [JobStatus](#jobstatus-1) | |
| - [JobType](#jobtype-1) | |
| - [Trigger](#trigger-1) | |
| ### 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](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/jobs/types/Certainty.ts#L5) | |
| [src/api/resources/jobs/types/Certainty.ts:7](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/jobs/types/Certainty.ts#L7) | |
| ___ | |
| #### Driver | |
| Ƭ **Driver**: ``"csv"`` | |
| The driver to use for extracting data from the file | |
| ##### Defined in | |
| [src/api/resources/jobs/types/Driver.ts:8](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/jobs/types/Driver.ts#L8) | |
| [src/api/resources/jobs/types/Driver.ts:10](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/jobs/types/Driver.ts#L10) | |
| ___ | |
| #### JobDestination | |
| Ƭ **JobDestination**: [`WorkbookId`](#workbookid) | |
| The id of the workbook where extracted file data will be sent | |
| ##### Defined in | |
| [src/api/resources/jobs/types/JobDestination.ts:10](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/jobs/types/JobDestination.ts#L10) | |
| ___ | |
| #### JobMode | |
| Ƭ **JobMode**: ``"foreground"`` \| ``"background"`` | |
| the mode of the job | |
| ##### Defined in | |
| [src/api/resources/jobs/types/JobMode.ts:8](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/jobs/types/JobMode.ts#L8) | |
| [src/api/resources/jobs/types/JobMode.ts:10](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/jobs/types/JobMode.ts#L10) | |
| ___ | |
| #### JobSource | |
| Ƭ **JobSource**: `string` | |
| The id of a file, workbook, or sheet | |
| ##### Defined in | |
| [src/api/resources/jobs/types/JobSource.ts:8](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/jobs/types/JobSource.ts#L8) | |
| ___ | |
| #### JobStatus | |
| Ƭ **JobStatus**: ``"planning"`` \| ``"ready"`` \| ``"executing"`` \| ``"complete"`` \| ``"failed"`` | |
| the status of the job | |
| ##### Defined in | |
| [src/api/resources/jobs/types/JobStatus.ts:8](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/jobs/types/JobStatus.ts#L8) | |
| [src/api/resources/jobs/types/JobStatus.ts:10](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/jobs/types/JobStatus.ts#L10) | |
| ___ | |
| #### JobType | |
| Ƭ **JobType**: ``"file"`` \| ``"workbook"`` \| ``"sheet"`` | |
| The type of job | |
| ##### Defined in | |
| [src/api/resources/jobs/types/JobType.ts:8](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/jobs/types/JobType.ts#L8) | |
| [src/api/resources/jobs/types/JobType.ts:10](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/jobs/types/JobType.ts#L10) | |
| ___ | |
| #### JobUpdateConfig | |
| Ƭ **JobUpdateConfig**: [`DeleteJobConfig`](#interfacesflatfilejobsdeletejobconfigmd) \| [`FileJobConfig`](#interfacesflatfilejobsfilejobconfigmd) \| [`PipelineJobConfig`](#interfacesflatfilejobspipelinejobconfigmd) \| [`ExportJobConfig`](#interfacesflatfilejobsexportjobconfigmd) \| [`MutateJobConfig`](#interfacesflatfilejobsmutatejobconfigmd) \| [`AiAssistJobConfig`](#interfacesflatfilejobsaiassistjobconfigmd) \| [`FindAndReplaceJobConfig`](#interfacesflatfilejobsfindandreplacejobconfigmd) \| [`EmptyObject`](#interfacesflatfilejobsemptyobjectmd) | |
| ##### Defined in | |
| [src/api/resources/jobs/types/JobUpdateConfig.ts:7](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/jobs/types/JobUpdateConfig.ts#L7) | |
| ___ | |
| #### Trigger | |
| Ƭ **Trigger**: ``"manual"`` \| ``"immediate"`` | |
| the type of trigger to use for this job | |
| ##### Defined in | |
| [src/api/resources/jobs/types/Trigger.ts:8](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/jobs/types/Trigger.ts#L8) | |
| [src/api/resources/jobs/types/Trigger.ts:10](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/jobs/types/Trigger.ts#L10) | |
| ### 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](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/jobs/types/Certainty.ts#L5) | |
| [src/api/resources/jobs/types/Certainty.ts:7](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/jobs/types/Certainty.ts#L7) | |
| ___ | |
| #### Driver | |
| • **Driver**: `Object` | |
| ##### Type declaration | |
| | Name | Type | | |
| | :------ | :------ | | |
| | `Csv` | ``"csv"`` | | |
| ##### Defined in | |
| [src/api/resources/jobs/types/Driver.ts:8](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/jobs/types/Driver.ts#L8) | |
| [src/api/resources/jobs/types/Driver.ts:10](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/jobs/types/Driver.ts#L10) | |
| ___ | |
| #### JobMode | |
| • **JobMode**: `Object` | |
| ##### Type declaration | |
| | Name | Type | | |
| | :------ | :------ | | |
| | `Background` | ``"background"`` | | |
| | `Foreground` | ``"foreground"`` | | |
| ##### Defined in | |
| [src/api/resources/jobs/types/JobMode.ts:8](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/jobs/types/JobMode.ts#L8) | |
| [src/api/resources/jobs/types/JobMode.ts:10](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/jobs/types/JobMode.ts#L10) | |
| ___ | |
| #### 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](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/jobs/types/JobStatus.ts#L8) | |
| [src/api/resources/jobs/types/JobStatus.ts:10](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/jobs/types/JobStatus.ts#L10) | |
| ___ | |
| #### JobType | |
| • **JobType**: `Object` | |
| ##### Type declaration | |
| | Name | Type | | |
| | :------ | :------ | | |
| | `File` | ``"file"`` | | |
| | `Sheet` | ``"sheet"`` | | |
| | `Workbook` | ``"workbook"`` | | |
| ##### Defined in | |
| [src/api/resources/jobs/types/JobType.ts:8](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/jobs/types/JobType.ts#L8) | |
| [src/api/resources/jobs/types/JobType.ts:10](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/jobs/types/JobType.ts#L10) | |
| ___ | |
| #### Trigger | |
| • **Trigger**: `Object` | |
| ##### Type declaration | |
| | Name | Type | | |
| | :------ | :------ | | |
| | `Immediate` | ``"immediate"`` | | |
| | `Manual` | ``"manual"`` | | |
| ##### Defined in | |
| [src/api/resources/jobs/types/Trigger.ts:8](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/jobs/types/Trigger.ts#L8) | |
| [src/api/resources/jobs/types/Trigger.ts:10](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/jobs/types/Trigger.ts#L10) | |
| <a name="modulesflatfilemd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / Flatfile | |
| ## Namespace: Flatfile | |
| ### Table of contents | |
| #### References | |
| - [AccountId](#accountid) | |
| - [Action](#action) | |
| - [ActionMode](#actionmode) | |
| - [ActionName](#actionname) | |
| - [ActionTriggeredEvent](#actiontriggeredevent) | |
| - [Agent](#agent) | |
| - [AgentConfig](#agentconfig) | |
| - [AgentId](#agentid) | |
| - [AgentLog](#agentlog) | |
| - [AgentResponse](#agentresponse) | |
| - [AiAssistJobConfig](#aiassistjobconfig) | |
| - [ApiKey](#apikey) | |
| - [ApiKeyOperation](#apikeyoperation) | |
| - [ApiKeyType](#apikeytype) | |
| - [ApiKeysResponse](#apikeysresponse) | |
| - [ApiToken](#apitoken) | |
| - [ArrayableProperty](#arrayableproperty) | |
| - [BadRequestError](#badrequesterror) | |
| - [BaseEvent](#baseevent) | |
| - [BaseProperty](#baseproperty) | |
| - [BooleanProperty](#booleanproperty) | |
| - [BooleanPropertyConfig](#booleanpropertyconfig) | |
| - [CategoryMapping](#categorymapping) | |
| - [CellValue](#cellvalue) | |
| - [CellValueUnion](#cellvalueunion) | |
| - [CellValueWithCounts](#cellvaluewithcounts) | |
| - [CellValueWithLinks](#cellvaluewithlinks) | |
| - [CellsResponse](#cellsresponse) | |
| - [CellsResponseData](#cellsresponsedata) | |
| - [Certainty](#certainty) | |
| - [CheckoutSession](#checkoutsession) | |
| - [ClientInitializedEvent](#clientinitializedevent) | |
| - [Compiler](#compiler) | |
| - [Constraint](#constraint) | |
| - [Context](#context) | |
| - [CreateAgentsRequest](#createagentsrequest) | |
| - [CreateApiTokenRequest](#createapitokenrequest) | |
| - [CreateCheckoutSessionResponse](#createcheckoutsessionresponse) | |
| - [CreateFileRequest](#createfilerequest) | |
| - [CreateGuestResponse](#createguestresponse) | |
| - [CreateWorkbookConfig](#createworkbookconfig) | |
| - [DateProperty](#dateproperty) | |
| - [DeleteAgentRequest](#deleteagentrequest) | |
| - [DeleteJobConfig](#deletejobconfig) | |
| - [DeleteRecordsRequest](#deleterecordsrequest) | |
| - [DestinationField](#destinationfield) | |
| - [Document](#document) | |
| - [DocumentConfig](#documentconfig) | |
| - [DocumentId](#documentid) | |
| - [DocumentResponse](#documentresponse) | |
| - [Domain](#domain) | |
| - [Driver](#driver) | |
| - [Edge](#edge) | |
| - [EmptyObject](#emptyobject) | |
| - [EnumDetails](#enumdetails) | |
| - [EnumProperty](#enumproperty) | |
| - [EnumPropertyConfig](#enumpropertyconfig) | |
| - [EnumPropertyOption](#enumpropertyoption) | |
| - [Environment](#environment) | |
| - [EnvironmentConfig](#environmentconfig) | |
| - [EnvironmentId](#environmentid) | |
| - [EnvironmentResponse](#environmentresponse) | |
| - [Error\_](#error_) | |
| - [Event](#event) | |
| - [EventAttributes](#eventattributes) | |
| - [EventId](#eventid) | |
| - [EventResponse](#eventresponse) | |
| - [EventTopic](#eventtopic) | |
| - [ExchangeTokenData](#exchangetokendata) | |
| - [ExchangeTokenRequest](#exchangetokenrequest) | |
| - [ExchangeTokenResponse](#exchangetokenresponse) | |
| - [ExportJobConfig](#exportjobconfig) | |
| - [ExportOptions](#exportoptions) | |
| - [FileDeletedEvent](#filedeletedevent) | |
| - [FileId](#fileid) | |
| - [FileJobConfig](#filejobconfig) | |
| - [FileResponse](#fileresponse) | |
| - [File\_](#file_) | |
| - [Filter](#filter) | |
| - [FilterField](#filterfield) | |
| - [FindAndReplaceJobConfig](#findandreplacejobconfig) | |
| - [FindAndReplaceRecordRequest](#findandreplacerecordrequest) | |
| - [FindAndReplaceRecordRequestDeprecated](#findandreplacerecordrequestdeprecated) | |
| - [FindRecordsRequest](#findrecordsrequest) | |
| - [GetAgentLogsRequest](#getagentlogsrequest) | |
| - [GetAgentLogsResponse](#getagentlogsresponse) | |
| - [GetAgentRequest](#getagentrequest) | |
| - [GetApiKeysRequest](#getapikeysrequest) | |
| - [GetEnvironmentAgentLogsRequest](#getenvironmentagentlogsrequest) | |
| - [GetEventTokenRequest](#geteventtokenrequest) | |
| - [GetFieldValuesRequest](#getfieldvaluesrequest) | |
| - [GetRecordCountsRequest](#getrecordcountsrequest) | |
| - [GetRecordsCsvRequest](#getrecordscsvrequest) | |
| - [GetRecordsRequest](#getrecordsrequest) | |
| - [Guest](#guest) | |
| - [GuestAuthenticationEnum](#guestauthenticationenum) | |
| - [GuestConfig](#guestconfig) | |
| - [GuestId](#guestid) | |
| - [GuestSpace](#guestspace) | |
| - [GuestWorkbook](#guestworkbook) | |
| - [Invite](#invite) | |
| - [Job](#job) | |
| - [JobAckDetails](#jobackdetails) | |
| - [JobCompletedEvent](#jobcompletedevent) | |
| - [JobConfig](#jobconfig) | |
| - [JobDeletedEvent](#jobdeletedevent) | |
| - [JobDestination](#jobdestination) | |
| - [JobExecutionPlan](#jobexecutionplan) | |
| - [JobExecutionPlanConfig](#jobexecutionplanconfig) | |
| - [JobFailedEvent](#jobfailedevent) | |
| - [JobFailedPayload](#jobfailedpayload) | |
| - [JobId](#jobid) | |
| - [JobMode](#jobmode) | |
| - [JobOperationType](#joboperationtype) | |
| - [JobOutcome](#joboutcome) | |
| - [JobPayload](#jobpayload) | |
| - [JobPayloadType](#jobpayloadtype) | |
| - [JobPlan](#jobplan) | |
| - [JobResponse](#jobresponse) | |
| - [JobSource](#jobsource) | |
| - [JobStartedEvent](#jobstartedevent) | |
| - [JobStatus](#jobstatus) | |
| - [JobType](#jobtype) | |
| - [JobUpdate](#jobupdate) | |
| - [JobUpdateConfig](#jobupdateconfig) | |
| - [JobUpdatedEvent](#jobupdatedevent) | |
| - [JobWaitingEvent](#jobwaitingevent) | |
| - [ListAgentsRequest](#listagentsrequest) | |
| - [ListAgentsResponse](#listagentsresponse) | |
| - [ListAllEventsResponse](#listalleventsresponse) | |
| - [ListApiTokensRequest](#listapitokensrequest) | |
| - [ListApiTokensResponse](#listapitokensresponse) | |
| - [ListDocumentsResponse](#listdocumentsresponse) | |
| - [ListEnvironmentsRequest](#listenvironmentsrequest) | |
| - [ListEnvironmentsResponse](#listenvironmentsresponse) | |
| - [ListEventsRequest](#listeventsrequest) | |
| - [ListFilesRequest](#listfilesrequest) | |
| - [ListFilesResponse](#listfilesresponse) | |
| - [ListGuestsRequest](#listguestsrequest) | |
| - [ListGuestsResponse](#listguestsresponse) | |
| - [ListJobsRequest](#listjobsrequest) | |
| - [ListJobsResponse](#listjobsresponse) | |
| - [ListSheetsRequest](#listsheetsrequest) | |
| - [ListSheetsResponse](#listsheetsresponse) | |
| - [ListUsersRequest](#listusersrequest) | |
| - [ListUsersResponse](#listusersresponse) | |
| - [ListWorkbooksRequest](#listworkbooksrequest) | |
| - [ListWorkbooksResponse](#listworkbooksresponse) | |
| - [Metadata](#metadata) | |
| - [Mode](#mode) | |
| - [ModelFileStatusEnum](#modelfilestatusenum) | |
| - [MutateJobConfig](#mutatejobconfig) | |
| - [NotFoundError](#notfounderror) | |
| - [NumberConfig](#numberconfig) | |
| - [NumberProperty](#numberproperty) | |
| - [Origin](#origin) | |
| - [Pagination](#pagination) | |
| - [PipelineJobConfig](#pipelinejobconfig) | |
| - [ProductsResponse](#productsresponse) | |
| - [Progress](#progress) | |
| - [Property](#property) | |
| - [RecordCounts](#recordcounts) | |
| - [RecordCountsResponse](#recordcountsresponse) | |
| - [RecordCountsResponseData](#recordcountsresponsedata) | |
| - [RecordData](#recorddata) | |
| - [RecordDataWithLinks](#recorddatawithlinks) | |
| - [RecordId](#recordid) | |
| - [RecordWithLinks](#recordwithlinks) | |
| - [Record\_](#record_) | |
| - [Records](#records) | |
| - [RecordsCreatedEvent](#recordscreatedevent) | |
| - [RecordsDeletedEvent](#recordsdeletedevent) | |
| - [RecordsPayload](#recordspayload) | |
| - [RecordsResponse](#recordsresponse) | |
| - [RecordsResponseData](#recordsresponsedata) | |
| - [RecordsUpdatedEvent](#recordsupdatedevent) | |
| - [RecordsWithLinks](#recordswithlinks) | |
| - [ReferenceProperty](#referenceproperty) | |
| - [ReferencePropertyConfig](#referencepropertyconfig) | |
| - [ReferencePropertyRelationship](#referencepropertyrelationship) | |
| - [SearchField](#searchfield) | |
| - [SearchValue](#searchvalue) | |
| - [Sheet](#sheet) | |
| - [SheetAccess](#sheetaccess) | |
| - [SheetConfig](#sheetconfig) | |
| - [SheetId](#sheetid) | |
| - [SheetResponse](#sheetresponse) | |
| - [SheetSlug](#sheetslug) | |
| - [SheetValidatedEvent](#sheetvalidatedevent) | |
| - [SortDirection](#sortdirection) | |
| - [SortField](#sortfield) | |
| - [SourceField](#sourcefield) | |
| - [SpaceAddedEvent](#spaceaddedevent) | |
| - [SpaceConfigId](#spaceconfigid) | |
| - [SpaceId](#spaceid) | |
| - [SpaceRemovedEvent](#spaceremovedevent) | |
| - [StringConfig](#stringconfig) | |
| - [StringConfigOptions](#stringconfigoptions) | |
| - [StringProperty](#stringproperty) | |
| - [StripeProduct](#stripeproduct) | |
| - [Success](#success) | |
| - [SuccessData](#successdata) | |
| - [Trigger](#trigger) | |
| - [UniqueConstraint](#uniqueconstraint) | |
| - [UniqueConstraintConfig](#uniqueconstraintconfig) | |
| - [UpdateFileRequest](#updatefilerequest) | |
| - [UpdateWorkbookConfig](#updateworkbookconfig) | |
| - [UploadCompletedEvent](#uploadcompletedevent) | |
| - [UploadFailedEvent](#uploadfailedevent) | |
| - [UploadStartedEvent](#uploadstartedevent) | |
| - [User](#user) | |
| - [UserAddedEvent](#useraddedevent) | |
| - [UserConfig](#userconfig) | |
| - [UserId](#userid) | |
| - [UserOfflineEvent](#userofflineevent) | |
| - [UserOnlineEvent](#useronlineevent) | |
| - [UserRemovedEvent](#userremovedevent) | |
| - [UserResponse](#userresponse) | |
| - [ValidationMessage](#validationmessage) | |
| - [ValidationSource](#validationsource) | |
| - [ValidationType](#validationtype) | |
| - [VersionId](#versionid) | |
| - [VersionResponse](#versionresponse) | |
| - [VersionsPostRequestBody](#versionspostrequestbody) | |
| - [Workbook](#workbook) | |
| - [WorkbookAddedEvent](#workbookaddedevent) | |
| - [WorkbookId](#workbookid) | |
| - [WorkbookRemovedEvent](#workbookremovedevent) | |
| - [WorkbookResponse](#workbookresponse) | |
| - [WorkbookUpdatedEvent](#workbookupdatedevent) | |
| #### Namespaces | |
| - [agents](#modulesflatfileagentsmd) | |
| - [auth](#modulesflatfileauthmd) | |
| - [billing](#modulesflatfilebillingmd) | |
| - [cells](#modulesflatfilecellsmd) | |
| - [commons](#modulesflatfilecommonsmd) | |
| - [documents](#modulesflatfiledocumentsmd) | |
| - [environments](#modulesflatfileenvironmentsmd) | |
| - [events](#modulesflatfileeventsmd) | |
| - [files](#modulesflatfilefilesmd) | |
| - [guests](#modulesflatfileguestsmd) | |
| - [jobs](#modulesflatfilejobsmd) | |
| - [property](#modulesflatfilepropertymd) | |
| - [records](#modulesflatfilerecordsmd) | |
| - [sheets](#modulesflatfilesheetsmd) | |
| - [spaces](#modulesflatfilespacesmd) | |
| - [users](#modulesflatfileusersmd) | |
| - [versions](#modulesflatfileversionsmd) | |
| - [workbooks](#modulesflatfileworkbooksmd) | |
| ### References | |
| #### AccountId | |
| Re-exports [AccountId](#accountid) | |
| ___ | |
| #### Action | |
| Re-exports [Action](#interfacesflatfilecommonsactionmd) | |
| ___ | |
| #### ActionMode | |
| Re-exports [ActionMode](#actionmode-1) | |
| ___ | |
| #### ActionName | |
| Re-exports [ActionName](#actionname) | |
| ___ | |
| #### ActionTriggeredEvent | |
| Re-exports [ActionTriggeredEvent](#interfacesflatfileeventsactiontriggeredeventmd) | |
| ___ | |
| #### Agent | |
| Re-exports [Agent](#interfacesflatfileagentsagentmd) | |
| ___ | |
| #### AgentConfig | |
| Re-exports [AgentConfig](#interfacesflatfileagentsagentconfigmd) | |
| ___ | |
| #### AgentId | |
| Re-exports [AgentId](#agentid) | |
| ___ | |
| #### AgentLog | |
| Re-exports [AgentLog](#interfacesflatfileagentsagentlogmd) | |
| ___ | |
| #### AgentResponse | |
| Re-exports [AgentResponse](#interfacesflatfileagentsagentresponsemd) | |
| ___ | |
| #### AiAssistJobConfig | |
| Re-exports [AiAssistJobConfig](#interfacesflatfilejobsaiassistjobconfigmd) | |
| ___ | |
| #### ApiKey | |
| Re-exports [ApiKey](#interfacesflatfileauthapikeymd) | |
| ___ | |
| #### ApiKeyOperation | |
| Re-exports [ApiKeyOperation](#interfacesflatfileauthapikeyoperationmd) | |
| ___ | |
| #### ApiKeyType | |
| Re-exports [ApiKeyType](#apikeytype-1) | |
| ___ | |
| #### ApiKeysResponse | |
| Re-exports [ApiKeysResponse](#interfacesflatfileauthapikeysresponsemd) | |
| ___ | |
| #### ApiToken | |
| Re-exports [ApiToken](#interfacesflatfileusersapitokenmd) | |
| ___ | |
| #### ArrayableProperty | |
| Re-exports [ArrayableProperty](#interfacesflatfilepropertyarrayablepropertymd) | |
| ___ | |
| #### BadRequestError | |
| Re-exports [BadRequestError](#classesflatfilecommonsbadrequesterrormd) | |
| ___ | |
| #### BaseEvent | |
| Re-exports [BaseEvent](#interfacesflatfileeventsbaseeventmd) | |
| ___ | |
| #### BaseProperty | |
| Re-exports [BaseProperty](#interfacesflatfilepropertybasepropertymd) | |
| ___ | |
| #### BooleanProperty | |
| Re-exports [BooleanProperty](#interfacesflatfilepropertybooleanpropertymd) | |
| ___ | |
| #### BooleanPropertyConfig | |
| Re-exports [BooleanPropertyConfig](#interfacesflatfilepropertybooleanpropertyconfigmd) | |
| ___ | |
| #### CategoryMapping | |
| Re-exports [CategoryMapping](#interfacesflatfilejobscategorymappingmd) | |
| ___ | |
| #### CellValue | |
| Re-exports [CellValue](#interfacesflatfilerecordscellvaluemd) | |
| ___ | |
| #### CellValueUnion | |
| Re-exports [CellValueUnion](#cellvalueunion) | |
| ___ | |
| #### CellValueWithCounts | |
| Re-exports [CellValueWithCounts](#interfacesflatfilecellscellvaluewithcountsmd) | |
| ___ | |
| #### CellValueWithLinks | |
| Re-exports [CellValueWithLinks](#interfacesflatfilerecordscellvaluewithlinksmd) | |
| ___ | |
| #### CellsResponse | |
| Re-exports [CellsResponse](#interfacesflatfilecellscellsresponsemd) | |
| ___ | |
| #### CellsResponseData | |
| Re-exports [CellsResponseData](#cellsresponsedata) | |
| ___ | |
| #### Certainty | |
| Re-exports [Certainty](#certainty-1) | |
| ___ | |
| #### CheckoutSession | |
| Re-exports [CheckoutSession](#interfacesflatfilebillingcheckoutsessionmd) | |
| ___ | |
| #### ClientInitializedEvent | |
| Re-exports [ClientInitializedEvent](#interfacesflatfileeventsclientinitializedeventmd) | |
| ___ | |
| #### Compiler | |
| Re-exports [Compiler](#compiler-1) | |
| ___ | |
| #### Constraint | |
| Re-exports [Constraint](#constraint) | |
| ___ | |
| #### Context | |
| Re-exports [Context](#interfacesflatfileeventscontextmd) | |
| ___ | |
| #### CreateAgentsRequest | |
| Re-exports [CreateAgentsRequest](#interfacesflatfileagentscreateagentsrequestmd) | |
| ___ | |
| #### CreateApiTokenRequest | |
| Re-exports [CreateApiTokenRequest](#interfacesflatfileuserscreateapitokenrequestmd) | |
| ___ | |
| #### CreateCheckoutSessionResponse | |
| Re-exports [CreateCheckoutSessionResponse](#interfacesflatfilebillingcreatecheckoutsessionresponsemd) | |
| ___ | |
| #### CreateFileRequest | |
| Re-exports [CreateFileRequest](#interfacesflatfilefilescreatefilerequestmd) | |
| ___ | |
| #### CreateGuestResponse | |
| Re-exports [CreateGuestResponse](#interfacesflatfileguestscreateguestresponsemd) | |
| ___ | |
| #### CreateWorkbookConfig | |
| Re-exports [CreateWorkbookConfig](#interfacesflatfileworkbookscreateworkbookconfigmd) | |
| ___ | |
| #### DateProperty | |
| Re-exports [DateProperty](#interfacesflatfilepropertydatepropertymd) | |
| ___ | |
| #### DeleteAgentRequest | |
| Re-exports [DeleteAgentRequest](#interfacesflatfileagentsdeleteagentrequestmd) | |
| ___ | |
| #### DeleteJobConfig | |
| Re-exports [DeleteJobConfig](#interfacesflatfilejobsdeletejobconfigmd) | |
| ___ | |
| #### DeleteRecordsRequest | |
| Re-exports [DeleteRecordsRequest](#interfacesflatfilerecordsdeleterecordsrequestmd) | |
| ___ | |
| #### DestinationField | |
| Re-exports [DestinationField](#interfacesflatfilejobsdestinationfieldmd) | |
| ___ | |
| #### Document | |
| Re-exports [Document](#interfacesflatfiledocumentsdocumentmd) | |
| ___ | |
| #### DocumentConfig | |
| Re-exports [DocumentConfig](#interfacesflatfiledocumentsdocumentconfigmd) | |
| ___ | |
| #### DocumentId | |
| Re-exports [DocumentId](#documentid) | |
| ___ | |
| #### DocumentResponse | |
| Re-exports [DocumentResponse](#interfacesflatfiledocumentsdocumentresponsemd) | |
| ___ | |
| #### Domain | |
| Re-exports [Domain](#domain-1) | |
| ___ | |
| #### Driver | |
| Re-exports [Driver](#driver-1) | |
| ___ | |
| #### Edge | |
| Re-exports [Edge](#interfacesflatfilejobsedgemd) | |
| ___ | |
| #### EmptyObject | |
| Re-exports [EmptyObject](#interfacesflatfilejobsemptyobjectmd) | |
| ___ | |
| #### EnumDetails | |
| Re-exports [EnumDetails](#interfacesflatfilejobsenumdetailsmd) | |
| ___ | |
| #### EnumProperty | |
| Re-exports [EnumProperty](#interfacesflatfilepropertyenumpropertymd) | |
| ___ | |
| #### EnumPropertyConfig | |
| Re-exports [EnumPropertyConfig](#interfacesflatfilepropertyenumpropertyconfigmd) | |
| ___ | |
| #### EnumPropertyOption | |
| Re-exports [EnumPropertyOption](#interfacesflatfilepropertyenumpropertyoptionmd) | |
| ___ | |
| #### Environment | |
| Re-exports [Environment](#interfacesflatfileenvironmentsenvironmentmd) | |
| ___ | |
| #### EnvironmentConfig | |
| Re-exports [EnvironmentConfig](#interfacesflatfileenvironmentsenvironmentconfigmd) | |
| ___ | |
| #### EnvironmentId | |
| Re-exports [EnvironmentId](#environmentid) | |
| ___ | |
| #### EnvironmentResponse | |
| Re-exports [EnvironmentResponse](#interfacesflatfileenvironmentsenvironmentresponsemd) | |
| ___ | |
| #### Error\_ | |
| Re-exports [Error_](#interfacesflatfilecommonserror_md) | |
| ___ | |
| #### Event | |
| Re-exports [Event](#event) | |
| ___ | |
| #### EventAttributes | |
| Re-exports [EventAttributes](#interfacesflatfileeventseventattributesmd) | |
| ___ | |
| #### EventId | |
| Re-exports [EventId](#eventid) | |
| ___ | |
| #### EventResponse | |
| Re-exports [EventResponse](#interfacesflatfileeventseventresponsemd) | |
| ___ | |
| #### EventTopic | |
| Re-exports [EventTopic](#eventtopic-1) | |
| ___ | |
| #### ExchangeTokenData | |
| Re-exports [ExchangeTokenData](#interfacesflatfileusersexchangetokendatamd) | |
| ___ | |
| #### ExchangeTokenRequest | |
| Re-exports [ExchangeTokenRequest](#interfacesflatfileusersexchangetokenrequestmd) | |
| ___ | |
| #### ExchangeTokenResponse | |
| Re-exports [ExchangeTokenResponse](#interfacesflatfileusersexchangetokenresponsemd) | |
| ___ | |
| #### ExportJobConfig | |
| Re-exports [ExportJobConfig](#interfacesflatfilejobsexportjobconfigmd) | |
| ___ | |
| #### ExportOptions | |
| Re-exports [ExportOptions](#interfacesflatfilejobsexportoptionsmd) | |
| ___ | |
| #### FileDeletedEvent | |
| Re-exports [FileDeletedEvent](#interfacesflatfileeventsfiledeletedeventmd) | |
| ___ | |
| #### FileId | |
| Re-exports [FileId](#fileid) | |
| ___ | |
| #### FileJobConfig | |
| Re-exports [FileJobConfig](#interfacesflatfilejobsfilejobconfigmd) | |
| ___ | |
| #### FileResponse | |
| Re-exports [FileResponse](#interfacesflatfilefilesfileresponsemd) | |
| ___ | |
| #### File\_ | |
| Re-exports [File_](#interfacesflatfilefilesfile_md) | |
| ___ | |
| #### Filter | |
| Re-exports [Filter](#filter-1) | |
| ___ | |
| #### FilterField | |
| Re-exports [FilterField](#filterfield) | |
| ___ | |
| #### FindAndReplaceJobConfig | |
| Re-exports [FindAndReplaceJobConfig](#interfacesflatfilejobsfindandreplacejobconfigmd) | |
| ___ | |
| #### FindAndReplaceRecordRequest | |
| Re-exports [FindAndReplaceRecordRequest](#interfacesflatfilerecordsfindandreplacerecordrequestmd) | |
| ___ | |
| #### FindAndReplaceRecordRequestDeprecated | |
| Re-exports [FindAndReplaceRecordRequestDeprecated](#interfacesflatfilerecordsfindandreplacerecordrequestdeprecatedmd) | |
| ___ | |
| #### FindRecordsRequest | |
| Re-exports [FindRecordsRequest](#interfacesflatfilerecordsfindrecordsrequestmd) | |
| ___ | |
| #### GetAgentLogsRequest | |
| Re-exports [GetAgentLogsRequest](#interfacesflatfileagentsgetagentlogsrequestmd) | |
| ___ | |
| #### GetAgentLogsResponse | |
| Re-exports [GetAgentLogsResponse](#interfacesflatfileagentsgetagentlogsresponsemd) | |
| ___ | |
| #### GetAgentRequest | |
| Re-exports [GetAgentRequest](#interfacesflatfileagentsgetagentrequestmd) | |
| ___ | |
| #### GetApiKeysRequest | |
| Re-exports [GetApiKeysRequest](#interfacesflatfileauthgetapikeysrequestmd) | |
| ___ | |
| #### GetEnvironmentAgentLogsRequest | |
| Re-exports [GetEnvironmentAgentLogsRequest](#interfacesflatfileagentsgetenvironmentagentlogsrequestmd) | |
| ___ | |
| #### GetEventTokenRequest | |
| Re-exports [GetEventTokenRequest](#interfacesflatfileeventsgeteventtokenrequestmd) | |
| ___ | |
| #### GetFieldValuesRequest | |
| Re-exports [GetFieldValuesRequest](#interfacesflatfilecellsgetfieldvaluesrequestmd) | |
| ___ | |
| #### GetRecordCountsRequest | |
| Re-exports [GetRecordCountsRequest](#interfacesflatfilesheetsgetrecordcountsrequestmd) | |
| ___ | |
| #### GetRecordsCsvRequest | |
| Re-exports [GetRecordsCsvRequest](#interfacesflatfilesheetsgetrecordscsvrequestmd) | |
| ___ | |
| #### GetRecordsRequest | |
| Re-exports [GetRecordsRequest](#interfacesflatfilerecordsgetrecordsrequestmd) | |
| ___ | |
| #### Guest | |
| Re-exports [Guest](#interfacesflatfileguestsguestmd) | |
| ___ | |
| #### GuestAuthenticationEnum | |
| Re-exports [GuestAuthenticationEnum](#guestauthenticationenum-1) | |
| ___ | |
| #### GuestConfig | |
| Re-exports [GuestConfig](#interfacesflatfileguestsguestconfigmd) | |
| ___ | |
| #### GuestId | |
| Re-exports [GuestId](#guestid) | |
| ___ | |
| #### GuestSpace | |
| Re-exports [GuestSpace](#interfacesflatfileguestsguestspacemd) | |
| ___ | |
| #### GuestWorkbook | |
| Re-exports [GuestWorkbook](#interfacesflatfileguestsguestworkbookmd) | |
| ___ | |
| #### Invite | |
| Re-exports [Invite](#interfacesflatfileguestsinvitemd) | |
| ___ | |
| #### Job | |
| Re-exports [Job](#interfacesflatfilejobsjobmd) | |
| ___ | |
| #### JobAckDetails | |
| Re-exports [JobAckDetails](#interfacesflatfilejobsjobackdetailsmd) | |
| ___ | |
| #### JobCompletedEvent | |
| Re-exports [JobCompletedEvent](#interfacesflatfileeventsjobcompletedeventmd) | |
| ___ | |
| #### JobConfig | |
| Re-exports [JobConfig](#interfacesflatfilejobsjobconfigmd) | |
| ___ | |
| #### JobDeletedEvent | |
| Re-exports [JobDeletedEvent](#interfacesflatfileeventsjobdeletedeventmd) | |
| ___ | |
| #### JobDestination | |
| Re-exports [JobDestination](#jobdestination) | |
| ___ | |
| #### JobExecutionPlan | |
| Re-exports [JobExecutionPlan](#interfacesflatfilejobsjobexecutionplanmd) | |
| ___ | |
| #### JobExecutionPlanConfig | |
| Re-exports [JobExecutionPlanConfig](#interfacesflatfilejobsjobexecutionplanconfigmd) | |
| ___ | |
| #### JobFailedEvent | |
| Re-exports [JobFailedEvent](#interfacesflatfileeventsjobfailedeventmd) | |
| ___ | |
| #### JobFailedPayload | |
| Re-exports [JobFailedPayload](#interfacesflatfileeventsjobfailedpayloadmd) | |
| ___ | |
| #### JobId | |
| Re-exports [JobId](#jobid) | |
| ___ | |
| #### JobMode | |
| Re-exports [JobMode](#jobmode-1) | |
| ___ | |
| #### JobOperationType | |
| Re-exports [JobOperationType](#joboperationtype-1) | |
| ___ | |
| #### JobOutcome | |
| Re-exports [JobOutcome](#interfacesflatfilejobsjoboutcomemd) | |
| ___ | |
| #### JobPayload | |
| Re-exports [JobPayload](#interfacesflatfileeventsjobpayloadmd) | |
| ___ | |
| #### JobPayloadType | |
| Re-exports [JobPayloadType](#jobpayloadtype-1) | |
| ___ | |
| #### JobPlan | |
| Re-exports [JobPlan](#interfacesflatfilejobsjobplanmd) | |
| ___ | |
| #### JobResponse | |
| Re-exports [JobResponse](#interfacesflatfilejobsjobresponsemd) | |
| ___ | |
| #### JobSource | |
| Re-exports [JobSource](#jobsource) | |
| ___ | |
| #### JobStartedEvent | |
| Re-exports [JobStartedEvent](#interfacesflatfileeventsjobstartedeventmd) | |
| ___ | |
| #### JobStatus | |
| Re-exports [JobStatus](#jobstatus-1) | |
| ___ | |
| #### JobType | |
| Re-exports [JobType](#jobtype-1) | |
| ___ | |
| #### JobUpdate | |
| Re-exports [JobUpdate](#interfacesflatfilejobsjobupdatemd) | |
| ___ | |
| #### JobUpdateConfig | |
| Re-exports [JobUpdateConfig](#jobupdateconfig) | |
| ___ | |
| #### JobUpdatedEvent | |
| Re-exports [JobUpdatedEvent](#interfacesflatfileeventsjobupdatedeventmd) | |
| ___ | |
| #### JobWaitingEvent | |
| Re-exports [JobWaitingEvent](#interfacesflatfileeventsjobwaitingeventmd) | |
| ___ | |
| #### ListAgentsRequest | |
| Re-exports [ListAgentsRequest](#interfacesflatfileagentslistagentsrequestmd) | |
| ___ | |
| #### ListAgentsResponse | |
| Re-exports [ListAgentsResponse](#interfacesflatfileagentslistagentsresponsemd) | |
| ___ | |
| #### ListAllEventsResponse | |
| Re-exports [ListAllEventsResponse](#interfacesflatfileeventslistalleventsresponsemd) | |
| ___ | |
| #### ListApiTokensRequest | |
| Re-exports [ListApiTokensRequest](#interfacesflatfileuserslistapitokensrequestmd) | |
| ___ | |
| #### ListApiTokensResponse | |
| Re-exports [ListApiTokensResponse](#interfacesflatfileuserslistapitokensresponsemd) | |
| ___ | |
| #### ListDocumentsResponse | |
| Re-exports [ListDocumentsResponse](#interfacesflatfiledocumentslistdocumentsresponsemd) | |
| ___ | |
| #### ListEnvironmentsRequest | |
| Re-exports [ListEnvironmentsRequest](#interfacesflatfileenvironmentslistenvironmentsrequestmd) | |
| ___ | |
| #### ListEnvironmentsResponse | |
| Re-exports [ListEnvironmentsResponse](#interfacesflatfileenvironmentslistenvironmentsresponsemd) | |
| ___ | |
| #### ListEventsRequest | |
| Re-exports [ListEventsRequest](#interfacesflatfileeventslisteventsrequestmd) | |
| ___ | |
| #### ListFilesRequest | |
| Re-exports [ListFilesRequest](#interfacesflatfilefileslistfilesrequestmd) | |
| ___ | |
| #### ListFilesResponse | |
| Re-exports [ListFilesResponse](#interfacesflatfilefileslistfilesresponsemd) | |
| ___ | |
| #### ListGuestsRequest | |
| Re-exports [ListGuestsRequest](#interfacesflatfileguestslistguestsrequestmd) | |
| ___ | |
| #### ListGuestsResponse | |
| Re-exports [ListGuestsResponse](#interfacesflatfileguestslistguestsresponsemd) | |
| ___ | |
| #### ListJobsRequest | |
| Re-exports [ListJobsRequest](#interfacesflatfilejobslistjobsrequestmd) | |
| ___ | |
| #### ListJobsResponse | |
| Re-exports [ListJobsResponse](#interfacesflatfilejobslistjobsresponsemd) | |
| ___ | |
| #### ListSheetsRequest | |
| Re-exports [ListSheetsRequest](#interfacesflatfilesheetslistsheetsrequestmd) | |
| ___ | |
| #### ListSheetsResponse | |
| Re-exports [ListSheetsResponse](#interfacesflatfilesheetslistsheetsresponsemd) | |
| ___ | |
| #### ListUsersRequest | |
| Re-exports [ListUsersRequest](#interfacesflatfileuserslistusersrequestmd) | |
| ___ | |
| #### ListUsersResponse | |
| Re-exports [ListUsersResponse](#interfacesflatfileuserslistusersresponsemd) | |
| ___ | |
| #### ListWorkbooksRequest | |
| Re-exports [ListWorkbooksRequest](#interfacesflatfileworkbookslistworkbooksrequestmd) | |
| ___ | |
| #### ListWorkbooksResponse | |
| Re-exports [ListWorkbooksResponse](#interfacesflatfileworkbookslistworkbooksresponsemd) | |
| ___ | |
| #### Metadata | |
| Re-exports [Metadata](#interfacesflatfilejobsmetadatamd) | |
| ___ | |
| #### Mode | |
| Re-exports [Mode](#mode-1) | |
| ___ | |
| #### ModelFileStatusEnum | |
| Re-exports [ModelFileStatusEnum](#modelfilestatusenum-1) | |
| ___ | |
| #### MutateJobConfig | |
| Re-exports [MutateJobConfig](#interfacesflatfilejobsmutatejobconfigmd) | |
| ___ | |
| #### NotFoundError | |
| Re-exports [NotFoundError](#classesflatfilecommonsnotfounderrormd) | |
| ___ | |
| #### NumberConfig | |
| Re-exports [NumberConfig](#interfacesflatfilepropertynumberconfigmd) | |
| ___ | |
| #### NumberProperty | |
| Re-exports [NumberProperty](#interfacesflatfilepropertynumberpropertymd) | |
| ___ | |
| #### Origin | |
| Re-exports [Origin](#interfacesflatfileeventsoriginmd) | |
| ___ | |
| #### Pagination | |
| Re-exports [Pagination](#interfacesflatfilecommonspaginationmd) | |
| ___ | |
| #### PipelineJobConfig | |
| Re-exports [PipelineJobConfig](#interfacesflatfilejobspipelinejobconfigmd) | |
| ___ | |
| #### ProductsResponse | |
| Re-exports [ProductsResponse](#interfacesflatfilebillingproductsresponsemd) | |
| ___ | |
| #### Progress | |
| Re-exports [Progress](#interfacesflatfileeventsprogressmd) | |
| ___ | |
| #### Property | |
| Re-exports [Property](#property) | |
| ___ | |
| #### RecordCounts | |
| Re-exports [RecordCounts](#interfacesflatfilerecordsrecordcountsmd) | |
| ___ | |
| #### RecordCountsResponse | |
| Re-exports [RecordCountsResponse](#interfacesflatfilesheetsrecordcountsresponsemd) | |
| ___ | |
| #### RecordCountsResponseData | |
| Re-exports [RecordCountsResponseData](#interfacesflatfilesheetsrecordcountsresponsedatamd) | |
| ___ | |
| #### RecordData | |
| Re-exports [RecordData](#recorddata) | |
| ___ | |
| #### RecordDataWithLinks | |
| Re-exports [RecordDataWithLinks](#recorddatawithlinks) | |
| ___ | |
| #### RecordId | |
| Re-exports [RecordId](#recordid) | |
| ___ | |
| #### RecordWithLinks | |
| Re-exports [RecordWithLinks](#interfacesflatfilerecordsrecordwithlinksmd) | |
| ___ | |
| #### Record\_ | |
| Re-exports [Record_](#interfacesflatfilerecordsrecord_md) | |
| ___ | |
| #### Records | |
| Re-exports [Records](#records) | |
| ___ | |
| #### RecordsCreatedEvent | |
| Re-exports [RecordsCreatedEvent](#interfacesflatfileeventsrecordscreatedeventmd) | |
| ___ | |
| #### RecordsDeletedEvent | |
| Re-exports [RecordsDeletedEvent](#interfacesflatfileeventsrecordsdeletedeventmd) | |
| ___ | |
| #### RecordsPayload | |
| Re-exports [RecordsPayload](#interfacesflatfileeventsrecordspayloadmd) | |
| ___ | |
| #### RecordsResponse | |
| Re-exports [RecordsResponse](#interfacesflatfilerecordsrecordsresponsemd) | |
| ___ | |
| #### RecordsResponseData | |
| Re-exports [RecordsResponseData](#interfacesflatfilerecordsrecordsresponsedatamd) | |
| ___ | |
| #### RecordsUpdatedEvent | |
| Re-exports [RecordsUpdatedEvent](#interfacesflatfileeventsrecordsupdatedeventmd) | |
| ___ | |
| #### RecordsWithLinks | |
| Re-exports [RecordsWithLinks](#recordswithlinks) | |
| ___ | |
| #### ReferenceProperty | |
| Re-exports [ReferenceProperty](#interfacesflatfilepropertyreferencepropertymd) | |
| ___ | |
| #### ReferencePropertyConfig | |
| Re-exports [ReferencePropertyConfig](#interfacesflatfilepropertyreferencepropertyconfigmd) | |
| ___ | |
| #### ReferencePropertyRelationship | |
| Re-exports [ReferencePropertyRelationship](#referencepropertyrelationship-1) | |
| ___ | |
| #### SearchField | |
| Re-exports [SearchField](#searchfield) | |
| ___ | |
| #### SearchValue | |
| Re-exports [SearchValue](#searchvalue) | |
| ___ | |
| #### Sheet | |
| Re-exports [Sheet](#interfacesflatfilesheetssheetmd) | |
| ___ | |
| #### SheetAccess | |
| Re-exports [SheetAccess](#sheetaccess-1) | |
| ___ | |
| #### SheetConfig | |
| Re-exports [SheetConfig](#interfacesflatfilesheetssheetconfigmd) | |
| ___ | |
| #### SheetId | |
| Re-exports [SheetId](#sheetid) | |
| ___ | |
| #### SheetResponse | |
| Re-exports [SheetResponse](#interfacesflatfilesheetssheetresponsemd) | |
| ___ | |
| #### SheetSlug | |
| Re-exports [SheetSlug](#sheetslug) | |
| ___ | |
| #### SheetValidatedEvent | |
| Re-exports [SheetValidatedEvent](#interfacesflatfileeventssheetvalidatedeventmd) | |
| ___ | |
| #### SortDirection | |
| Re-exports [SortDirection](#sortdirection-1) | |
| ___ | |
| #### SortField | |
| Re-exports [SortField](#sortfield) | |
| ___ | |
| #### SourceField | |
| Re-exports [SourceField](#interfacesflatfilejobssourcefieldmd) | |
| ___ | |
| #### SpaceAddedEvent | |
| Re-exports [SpaceAddedEvent](#interfacesflatfileeventsspaceaddedeventmd) | |
| ___ | |
| #### SpaceConfigId | |
| Re-exports [SpaceConfigId](#spaceconfigid) | |
| ___ | |
| #### SpaceId | |
| Re-exports [SpaceId](#spaceid) | |
| ___ | |
| #### SpaceRemovedEvent | |
| Re-exports [SpaceRemovedEvent](#interfacesflatfileeventsspaceremovedeventmd) | |
| ___ | |
| #### StringConfig | |
| Re-exports [StringConfig](#interfacesflatfilepropertystringconfigmd) | |
| ___ | |
| #### StringConfigOptions | |
| Re-exports [StringConfigOptions](#stringconfigoptions-1) | |
| ___ | |
| #### StringProperty | |
| Re-exports [StringProperty](#interfacesflatfilepropertystringpropertymd) | |
| ___ | |
| #### StripeProduct | |
| Re-exports [StripeProduct](#interfacesflatfilebillingstripeproductmd) | |
| ___ | |
| #### Success | |
| Re-exports [Success](#interfacesflatfilecommonssuccessmd) | |
| ___ | |
| #### SuccessData | |
| Re-exports [SuccessData](#interfacesflatfilecommonssuccessdatamd) | |
| ___ | |
| #### Trigger | |
| Re-exports [Trigger](#trigger-1) | |
| ___ | |
| #### UniqueConstraint | |
| Re-exports [UniqueConstraint](#interfacesflatfilepropertyuniqueconstraintmd) | |
| ___ | |
| #### UniqueConstraintConfig | |
| Re-exports [UniqueConstraintConfig](#interfacesflatfilepropertyuniqueconstraintconfigmd) | |
| ___ | |
| #### UpdateFileRequest | |
| Re-exports [UpdateFileRequest](#interfacesflatfilefilesupdatefilerequestmd) | |
| ___ | |
| #### UpdateWorkbookConfig | |
| Re-exports [UpdateWorkbookConfig](#interfacesflatfileworkbooksupdateworkbookconfigmd) | |
| ___ | |
| #### UploadCompletedEvent | |
| Re-exports [UploadCompletedEvent](#interfacesflatfileeventsuploadcompletedeventmd) | |
| ___ | |
| #### UploadFailedEvent | |
| Re-exports [UploadFailedEvent](#interfacesflatfileeventsuploadfailedeventmd) | |
| ___ | |
| #### UploadStartedEvent | |
| Re-exports [UploadStartedEvent](#interfacesflatfileeventsuploadstartedeventmd) | |
| ___ | |
| #### User | |
| Re-exports [User](#interfacesflatfileusersusermd) | |
| ___ | |
| #### UserAddedEvent | |
| Re-exports [UserAddedEvent](#interfacesflatfileeventsuseraddedeventmd) | |
| ___ | |
| #### UserConfig | |
| Re-exports [UserConfig](#interfacesflatfileusersuserconfigmd) | |
| ___ | |
| #### UserId | |
| Re-exports [UserId](#userid) | |
| ___ | |
| #### UserOfflineEvent | |
| Re-exports [UserOfflineEvent](#interfacesflatfileeventsuserofflineeventmd) | |
| ___ | |
| #### UserOnlineEvent | |
| Re-exports [UserOnlineEvent](#interfacesflatfileeventsuseronlineeventmd) | |
| ___ | |
| #### UserRemovedEvent | |
| Re-exports [UserRemovedEvent](#interfacesflatfileeventsuserremovedeventmd) | |
| ___ | |
| #### UserResponse | |
| Re-exports [UserResponse](#interfacesflatfileusersuserresponsemd) | |
| ___ | |
| #### ValidationMessage | |
| Re-exports [ValidationMessage](#interfacesflatfilerecordsvalidationmessagemd) | |
| ___ | |
| #### ValidationSource | |
| Re-exports [ValidationSource](#validationsource-1) | |
| ___ | |
| #### ValidationType | |
| Re-exports [ValidationType](#validationtype-1) | |
| ___ | |
| #### VersionId | |
| Re-exports [VersionId](#versionid) | |
| ___ | |
| #### VersionResponse | |
| Re-exports [VersionResponse](#interfacesflatfileversionsversionresponsemd) | |
| ___ | |
| #### VersionsPostRequestBody | |
| Re-exports [VersionsPostRequestBody](#interfacesflatfileversionsversionspostrequestbodymd) | |
| ___ | |
| #### Workbook | |
| Re-exports [Workbook](#interfacesflatfileworkbooksworkbookmd) | |
| ___ | |
| #### WorkbookAddedEvent | |
| Re-exports [WorkbookAddedEvent](#interfacesflatfileeventsworkbookaddedeventmd) | |
| ___ | |
| #### WorkbookId | |
| Re-exports [WorkbookId](#workbookid) | |
| ___ | |
| #### WorkbookRemovedEvent | |
| Re-exports [WorkbookRemovedEvent](#interfacesflatfileeventsworkbookremovedeventmd) | |
| ___ | |
| #### WorkbookResponse | |
| Re-exports [WorkbookResponse](#interfacesflatfileworkbooksworkbookresponsemd) | |
| ___ | |
| #### WorkbookUpdatedEvent | |
| Re-exports [WorkbookUpdatedEvent](#interfacesflatfileeventsworkbookupdatedeventmd) | |
| <a name="modulesflatfilepropertyconstraintmd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / [property](#modulesflatfilepropertymd) / Constraint | |
| ## Namespace: Constraint | |
| [Flatfile](#modulesflatfilemd).[property](#modulesflatfilepropertymd).Constraint | |
| ### Table of contents | |
| #### Interfaces | |
| - [Computed](#interfacesflatfilepropertyconstraintcomputedmd) | |
| - [Required](#interfacesflatfilepropertyconstraintrequiredmd) | |
| - [Unique](#interfacesflatfilepropertyconstraintuniquemd) | |
| <a name="modulesflatfilepropertypropertymd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / [property](#modulesflatfilepropertymd) / Property | |
| ## Namespace: Property | |
| [Flatfile](#modulesflatfilemd).[property](#modulesflatfilepropertymd).Property | |
| ### Table of contents | |
| #### Interfaces | |
| - [Boolean](#interfacesflatfilepropertypropertybooleanmd) | |
| - [Date\_](#interfacesflatfilepropertypropertydate_md) | |
| - [Enum](#interfacesflatfilepropertypropertyenummd) | |
| - [Number](#interfacesflatfilepropertypropertynumbermd) | |
| - [Reference](#interfacesflatfilepropertypropertyreferencemd) | |
| - [String](#interfacesflatfilepropertypropertystringmd) | |
| <a name="modulesflatfilepropertymd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / property | |
| ## Namespace: property | |
| [Flatfile](#modulesflatfilemd).property | |
| ### Table of contents | |
| #### Namespaces | |
| - [Constraint](#modulesflatfilepropertyconstraintmd) | |
| - [Property](#modulesflatfilepropertypropertymd) | |
| #### Interfaces | |
| - [ArrayableProperty](#interfacesflatfilepropertyarrayablepropertymd) | |
| - [BaseProperty](#interfacesflatfilepropertybasepropertymd) | |
| - [BooleanProperty](#interfacesflatfilepropertybooleanpropertymd) | |
| - [BooleanPropertyConfig](#interfacesflatfilepropertybooleanpropertyconfigmd) | |
| - [DateProperty](#interfacesflatfilepropertydatepropertymd) | |
| - [EnumProperty](#interfacesflatfilepropertyenumpropertymd) | |
| - [EnumPropertyConfig](#interfacesflatfilepropertyenumpropertyconfigmd) | |
| - [EnumPropertyOption](#interfacesflatfilepropertyenumpropertyoptionmd) | |
| - [NumberConfig](#interfacesflatfilepropertynumberconfigmd) | |
| - [NumberProperty](#interfacesflatfilepropertynumberpropertymd) | |
| - [ReferenceProperty](#interfacesflatfilepropertyreferencepropertymd) | |
| - [ReferencePropertyConfig](#interfacesflatfilepropertyreferencepropertyconfigmd) | |
| - [StringConfig](#interfacesflatfilepropertystringconfigmd) | |
| - [StringProperty](#interfacesflatfilepropertystringpropertymd) | |
| - [UniqueConstraint](#interfacesflatfilepropertyuniqueconstraintmd) | |
| - [UniqueConstraintConfig](#interfacesflatfilepropertyuniqueconstraintconfigmd) | |
| #### Type Aliases | |
| - [Constraint](#constraint) | |
| - [Property](#property) | |
| - [ReferencePropertyRelationship](#referencepropertyrelationship) | |
| - [StringConfigOptions](#stringconfigoptions) | |
| #### Variables | |
| - [ReferencePropertyRelationship](#referencepropertyrelationship-1) | |
| - [StringConfigOptions](#stringconfigoptions-1) | |
| ### Type Aliases | |
| #### Constraint | |
| Ƭ **Constraint**: [`Required`](#interfacesflatfilepropertyconstraintrequiredmd) \| [`Unique`](#interfacesflatfilepropertyconstraintuniquemd) \| [`Computed`](#interfacesflatfilepropertyconstraintcomputedmd) | |
| ##### Defined in | |
| [src/api/resources/property/types/Constraint.ts:7](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/property/types/Constraint.ts#L7) | |
| [src/api/resources/property/types/Constraint.ts:9](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/property/types/Constraint.ts#L9) | |
| ___ | |
| #### Property | |
| Ƭ **Property**: [`String`](#interfacesflatfilepropertypropertystringmd) \| [`Number`](#interfacesflatfilepropertypropertynumbermd) \| [`Boolean`](#interfacesflatfilepropertypropertybooleanmd) \| [`Date_`](#interfacesflatfilepropertypropertydate_md) \| [`Enum`](#interfacesflatfilepropertypropertyenummd) \| [`Reference`](#interfacesflatfilepropertypropertyreferencemd) | |
| **`Example`** | |
| ```ts | |
| { | |
| * 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`** | |
| ```ts | |
| { | |
| * type: "number", | |
| * key: "price", | |
| * config: { | |
| * decimalPlaces: 2 | |
| * } | |
| * } | |
| ``` | |
| **`Example`** | |
| ```ts | |
| { | |
| * type: "boolean", | |
| * key: "editable", | |
| * config: { | |
| * allowIndeterminate: true | |
| * } | |
| * } | |
| ``` | |
| **`Example`** | |
| ```ts | |
| { | |
| * type: "date" | |
| * } | |
| ``` | |
| **`Example`** | |
| ```ts | |
| { | |
| * 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`** | |
| ```ts | |
| { | |
| * 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](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/property/types/Property.ts#L86) | |
| [src/api/resources/property/types/Property.ts:94](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/property/types/Property.ts#L94) | |
| ___ | |
| #### 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](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/property/types/ReferencePropertyRelationship.ts#L5) | |
| [src/api/resources/property/types/ReferencePropertyRelationship.ts:7](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/property/types/ReferencePropertyRelationship.ts#L7) | |
| ___ | |
| #### 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](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/property/types/StringConfigOptions.ts#L8) | |
| [src/api/resources/property/types/StringConfigOptions.ts:22](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/property/types/StringConfigOptions.ts#L22) | |
| ### Variables | |
| #### ReferencePropertyRelationship | |
| • **ReferencePropertyRelationship**: `Object` | |
| ##### Type declaration | |
| | Name | Type | | |
| | :------ | :------ | | |
| | `HasMany` | ``"has-many"`` | | |
| | `HasOne` | ``"has-one"`` | | |
| ##### Defined in | |
| [src/api/resources/property/types/ReferencePropertyRelationship.ts:5](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/property/types/ReferencePropertyRelationship.ts#L5) | |
| [src/api/resources/property/types/ReferencePropertyRelationship.ts:7](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/property/types/ReferencePropertyRelationship.ts#L7) | |
| ___ | |
| #### 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](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/property/types/StringConfigOptions.ts#L8) | |
| [src/api/resources/property/types/StringConfigOptions.ts:22](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/property/types/StringConfigOptions.ts#L22) | |
| <a name="modulesflatfilerecordsmd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / records | |
| ## Namespace: records | |
| [Flatfile](#modulesflatfilemd).records | |
| ### Table of contents | |
| #### Interfaces | |
| - [CellValue](#interfacesflatfilerecordscellvaluemd) | |
| - [CellValueWithLinks](#interfacesflatfilerecordscellvaluewithlinksmd) | |
| - [DeleteRecordsRequest](#interfacesflatfilerecordsdeleterecordsrequestmd) | |
| - [FindAndReplaceRecordRequest](#interfacesflatfilerecordsfindandreplacerecordrequestmd) | |
| - [FindAndReplaceRecordRequestDeprecated](#interfacesflatfilerecordsfindandreplacerecordrequestdeprecatedmd) | |
| - [FindRecordsRequest](#interfacesflatfilerecordsfindrecordsrequestmd) | |
| - [GetRecordsRequest](#interfacesflatfilerecordsgetrecordsrequestmd) | |
| - [RecordCounts](#interfacesflatfilerecordsrecordcountsmd) | |
| - [RecordWithLinks](#interfacesflatfilerecordsrecordwithlinksmd) | |
| - [Record\_](#interfacesflatfilerecordsrecord_md) | |
| - [RecordsResponse](#interfacesflatfilerecordsrecordsresponsemd) | |
| - [RecordsResponseData](#interfacesflatfilerecordsrecordsresponsedatamd) | |
| - [ValidationMessage](#interfacesflatfilerecordsvalidationmessagemd) | |
| #### Type Aliases | |
| - [CellValueUnion](#cellvalueunion) | |
| - [RecordData](#recorddata) | |
| - [RecordDataWithLinks](#recorddatawithlinks) | |
| - [Records](#records) | |
| - [RecordsWithLinks](#recordswithlinks) | |
| - [ValidationSource](#validationsource) | |
| - [ValidationType](#validationtype) | |
| #### Variables | |
| - [ValidationSource](#validationsource-1) | |
| - [ValidationType](#validationtype-1) | |
| ### 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](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/records/types/CellValueUnion.ts#L5) | |
| ___ | |
| #### RecordData | |
| Ƭ **RecordData**: `Record`<`string`, [`CellValue`](#interfacesflatfilerecordscellvaluemd)\> | |
| A single row of data in a Sheet | |
| ##### Defined in | |
| [src/api/resources/records/types/RecordData.ts:10](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/records/types/RecordData.ts#L10) | |
| ___ | |
| #### RecordDataWithLinks | |
| Ƭ **RecordDataWithLinks**: `Record`<`string`, [`CellValueWithLinks`](#interfacesflatfilerecordscellvaluewithlinksmd)\> | |
| A single row of data in a Sheet, including links to related rows | |
| ##### Defined in | |
| [src/api/resources/records/types/RecordDataWithLinks.ts:10](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/records/types/RecordDataWithLinks.ts#L10) | |
| ___ | |
| #### Records | |
| Ƭ **Records**: [`Record_`](#interfacesflatfilerecordsrecord_md)[] | |
| List of Record objects | |
| ##### Defined in | |
| [src/api/resources/records/types/Records.ts:10](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/records/types/Records.ts#L10) | |
| ___ | |
| #### RecordsWithLinks | |
| Ƭ **RecordsWithLinks**: [`RecordWithLinks`](#interfacesflatfilerecordsrecordwithlinksmd)[] | |
| List of Record objects, including links to related rows | |
| ##### Defined in | |
| [src/api/resources/records/types/RecordsWithLinks.ts:10](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/records/types/RecordsWithLinks.ts#L10) | |
| ___ | |
| #### 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](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/records/types/ValidationSource.ts#L5) | |
| [src/api/resources/records/types/ValidationSource.ts:12](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/records/types/ValidationSource.ts#L12) | |
| ___ | |
| #### 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](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/records/types/ValidationType.ts#L5) | |
| [src/api/resources/records/types/ValidationType.ts:7](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/records/types/ValidationType.ts#L7) | |
| ### 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](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/records/types/ValidationSource.ts#L5) | |
| [src/api/resources/records/types/ValidationSource.ts:12](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/records/types/ValidationSource.ts#L12) | |
| ___ | |
| #### ValidationType | |
| • **ValidationType**: `Object` | |
| ##### Type declaration | |
| | Name | Type | | |
| | :------ | :------ | | |
| | `Error` | ``"error"`` | | |
| | `Info` | ``"info"`` | | |
| | `Warn` | ``"warn"`` | | |
| ##### Defined in | |
| [src/api/resources/records/types/ValidationType.ts:5](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/records/types/ValidationType.ts#L5) | |
| [src/api/resources/records/types/ValidationType.ts:7](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/records/types/ValidationType.ts#L7) | |
| <a name="modulesflatfilesheetsmd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / sheets | |
| ## Namespace: sheets | |
| [Flatfile](#modulesflatfilemd).sheets | |
| ### Table of contents | |
| #### Interfaces | |
| - [GetRecordCountsRequest](#interfacesflatfilesheetsgetrecordcountsrequestmd) | |
| - [GetRecordsCsvRequest](#interfacesflatfilesheetsgetrecordscsvrequestmd) | |
| - [ListSheetsRequest](#interfacesflatfilesheetslistsheetsrequestmd) | |
| - [ListSheetsResponse](#interfacesflatfilesheetslistsheetsresponsemd) | |
| - [RecordCountsResponse](#interfacesflatfilesheetsrecordcountsresponsemd) | |
| - [RecordCountsResponseData](#interfacesflatfilesheetsrecordcountsresponsedatamd) | |
| - [Sheet](#interfacesflatfilesheetssheetmd) | |
| - [SheetConfig](#interfacesflatfilesheetssheetconfigmd) | |
| - [SheetResponse](#interfacesflatfilesheetssheetresponsemd) | |
| #### Type Aliases | |
| - [SheetAccess](#sheetaccess) | |
| #### Variables | |
| - [SheetAccess](#sheetaccess-1) | |
| ### 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](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/sheets/types/SheetAccess.ts#L5) | |
| [src/api/resources/sheets/types/SheetAccess.ts:7](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/sheets/types/SheetAccess.ts#L7) | |
| ### 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](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/sheets/types/SheetAccess.ts#L5) | |
| [src/api/resources/sheets/types/SheetAccess.ts:7](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/sheets/types/SheetAccess.ts#L7) | |
| <a name="modulesflatfilespacesmd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / spaces | |
| ## Namespace: spaces | |
| [Flatfile](#modulesflatfilemd).spaces | |
| ### Table of contents | |
| #### Interfaces | |
| - [EventToken](#interfacesflatfilespaceseventtokenmd) | |
| - [EventTokenResponse](#interfacesflatfilespaceseventtokenresponsemd) | |
| - [ListSpacesRequest](#interfacesflatfilespaceslistspacesrequestmd) | |
| - [ListSpacesResponse](#interfacesflatfilespaceslistspacesresponsemd) | |
| - [Space](#interfacesflatfilespacesspacemd) | |
| - [SpaceConfig](#interfacesflatfilespacesspaceconfigmd) | |
| - [SpaceResponse](#interfacesflatfilespacesspaceresponsemd) | |
| #### Type Aliases | |
| - [GetSpacesSortField](#getspacessortfield) | |
| - [SpaceAccess](#spaceaccess) | |
| #### Variables | |
| - [GetSpacesSortField](#getspacessortfield-1) | |
| - [SpaceAccess](#spaceaccess-1) | |
| ### 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](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/spaces/types/GetSpacesSortField.ts#L5) | |
| [src/api/resources/spaces/types/GetSpacesSortField.ts:7](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/spaces/types/GetSpacesSortField.ts#L7) | |
| ___ | |
| #### SpaceAccess | |
| Ƭ **SpaceAccess**: ``"*"`` \| ``"upload"`` | |
| This file was auto-generated by Fern from our API Definition. | |
| ##### Defined in | |
| [src/api/resources/spaces/types/SpaceAccess.ts:5](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/spaces/types/SpaceAccess.ts#L5) | |
| [src/api/resources/spaces/types/SpaceAccess.ts:7](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/spaces/types/SpaceAccess.ts#L7) | |
| ### 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](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/spaces/types/GetSpacesSortField.ts#L5) | |
| [src/api/resources/spaces/types/GetSpacesSortField.ts:7](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/spaces/types/GetSpacesSortField.ts#L7) | |
| ___ | |
| #### SpaceAccess | |
| • **SpaceAccess**: `Object` | |
| ##### Type declaration | |
| | Name | Type | | |
| | :------ | :------ | | |
| | `All` | ``"*"`` | | |
| | `Upload` | ``"upload"`` | | |
| ##### Defined in | |
| [src/api/resources/spaces/types/SpaceAccess.ts:5](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/spaces/types/SpaceAccess.ts#L5) | |
| [src/api/resources/spaces/types/SpaceAccess.ts:7](https://github.com/FlatFilers/flatfile-node/blob/84271e6/src/api/resources/spaces/types/SpaceAccess.ts#L7) | |
| <a name="modulesflatfileusersmd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / users | |
| ## Namespace: users | |
| [Flatfile](#modulesflatfilemd).users | |
| ### Table of contents | |
| #### Interfaces | |
| - [ApiToken](#interfacesflatfileusersapitokenmd) | |
| - [CreateApiTokenRequest](#interfacesflatfileuserscreateapitokenrequestmd) | |
| - [ExchangeTokenData](#interfacesflatfileusersexchangetokendatamd) | |
| - [ExchangeTokenRequest](#interfacesflatfileusersexchangetokenrequestmd) | |
| - [ExchangeTokenResponse](#interfacesflatfileusersexchangetokenresponsemd) | |
| - [ListApiTokensRequest](#interfacesflatfileuserslistapitokensrequestmd) | |
| - [ListApiTokensResponse](#interfacesflatfileuserslistapitokensresponsemd) | |
| - [ListUsersRequest](#interfacesflatfileuserslistusersrequestmd) | |
| - [ListUsersResponse](#interfacesflatfileuserslistusersresponsemd) | |
| - [User](#interfacesflatfileusersusermd) | |
| - [UserConfig](#interfacesflatfileusersuserconfigmd) | |
| - [UserResponse](#interfacesflatfileusersuserresponsemd) | |
| <a name="modulesflatfileversionsmd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / versions | |
| ## Namespace: versions | |
| [Flatfile](#modulesflatfilemd).versions | |
| ### Table of contents | |
| #### Interfaces | |
| - [VersionResponse](#interfacesflatfileversionsversionresponsemd) | |
| - [VersionsPostRequestBody](#interfacesflatfileversionsversionspostrequestbodymd) | |
| <a name="modulesflatfileworkbooksmd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / [Flatfile](#modulesflatfilemd) / workbooks | |
| ## Namespace: workbooks | |
| [Flatfile](#modulesflatfilemd).workbooks | |
| ### Table of contents | |
| #### Interfaces | |
| - [CreateWorkbookConfig](#interfacesflatfileworkbookscreateworkbookconfigmd) | |
| - [ListWorkbooksRequest](#interfacesflatfileworkbookslistworkbooksrequestmd) | |
| - [ListWorkbooksResponse](#interfacesflatfileworkbookslistworkbooksresponsemd) | |
| - [UpdateWorkbookConfig](#interfacesflatfileworkbooksupdateworkbookconfigmd) | |
| - [Workbook](#interfacesflatfileworkbooksworkbookmd) | |
| - [WorkbookResponse](#interfacesflatfileworkbooksworkbookresponsemd) | |
| <a name="modulesflatfileclientmd"></a> | |
| [@flatfile/api](#readmemd) / [Exports](#modulesmd) / FlatfileClient | |
| ## Namespace: FlatfileClient | |
| ### Table of contents | |
| #### Interfaces | |
| - [Options](#interfacesflatfileclientoptionsmd) |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment