# Reference
## Accounts
client.accounts.getCurrent () -> Flatfile.AccountResponse
#### 📝 Description
Get the current account
#### 🔌 Usage
```typescript
await client.accounts.getCurrent();
```
#### ⚙️ Parameters
**requestOptions:** `Accounts.RequestOptions`
client.accounts.updateCurrent ({ ...params }) -> Flatfile.AccountResponse
#### 📝 Description
Update the current account
#### 🔌 Usage
```typescript
await client.accounts.updateCurrent({
name: "My Company Name",
defaultAppId: "us_app_YOUR_ID",
});
```
#### ⚙️ Parameters
**request:** `Flatfile.AccountPatch`
**requestOptions:** `Accounts.RequestOptions`
client.actions.create ({ ...params }) -> Flatfile.ApiActionResponse
#### 🔌 Usage
```typescript
await client.actions.create({
spaceId: "spaceId",
body: {
label: "label",
targetId: "targetId",
},
});
```
#### ⚙️ Parameters
**request:** `Flatfile.ActionCreateRequest`
**requestOptions:** `Actions.RequestOptions`
client.actions.bulkCreate ({ ...params }) -> Flatfile.ApiActionsResponse
#### 🔌 Usage
```typescript
await client.actions.bulkCreate({
spaceId: "spaceId",
body: [
{
label: "label",
targetId: "targetId",
},
{
label: "label",
targetId: "targetId",
},
],
});
```
#### ⚙️ Parameters
**request:** `Flatfile.ActionsBulkCreateRequest`
**requestOptions:** `Actions.RequestOptions`
client.actions.getAll ({ ...params }) -> Flatfile.ApiActionsResponse
#### 🔌 Usage
```typescript
await client.actions.getAll({
spaceId: "spaceId",
});
```
#### ⚙️ Parameters
**request:** `Flatfile.GetActionsRequest`
**requestOptions:** `Actions.RequestOptions`
client.actions.get (actionId) -> Flatfile.ApiActionResponse
#### 🔌 Usage
```typescript
await client.actions.get("actionId");
```
#### ⚙️ Parameters
**actionId:** `Flatfile.ActionId` — The id of the action to return
**requestOptions:** `Actions.RequestOptions`
client.actions.update (actionId, { ...params }) -> Flatfile.ApiActionResponse
#### 🔌 Usage
```typescript
await client.actions.update("actionId", {});
```
#### ⚙️ Parameters
**actionId:** `Flatfile.ActionId` — The id of the action to patch
**request:** `Flatfile.ActionUpdate`
**requestOptions:** `Actions.RequestOptions`
client.actions.delete (actionId) -> Flatfile.Success
#### 🔌 Usage
```typescript
await client.actions.delete("actionId");
```
#### ⚙️ Parameters
**actionId:** `Flatfile.ActionId` — The id of the action to delete
**requestOptions:** `Actions.RequestOptions`
client.agentExports.list ({ ...params }) -> Flatfile.ListAgentExportsResponse
#### 🔌 Usage
```typescript
await client.agentExports.list();
```
#### ⚙️ Parameters
**request:** `Flatfile.ListAgentExportsRequest`
**requestOptions:** `AgentExports.RequestOptions`
client.agentExports.get (agentExportId) -> Flatfile.GetAgentExportResponse
#### 🔌 Usage
```typescript
await client.agentExports.get("us_agx_YOUR_ID");
```
#### ⚙️ Parameters
**agentExportId:** `Flatfile.AgentExportId`
**requestOptions:** `AgentExports.RequestOptions`
client.agentExports.delete (agentExportId) -> Flatfile.Success
#### 🔌 Usage
```typescript
await client.agentExports.delete("us_agx_YOUR_ID");
```
#### ⚙️ Parameters
**agentExportId:** `Flatfile.AgentExportId`
**requestOptions:** `AgentExports.RequestOptions`
client.agents.list ({ ...params }) -> Flatfile.ListAgentsResponse
#### 🔌 Usage
```typescript
await client.agents.list({
environmentId: "us_env_YOUR_ID",
pageSize: 20,
pageNumber: 1,
});
```
#### ⚙️ Parameters
**request:** `Flatfile.ListAgentsRequest`
**requestOptions:** `Agents.RequestOptions`
client.agents.create ({ ...params }) -> Flatfile.AgentResponse
#### 🔌 Usage
```typescript
await client.agents.create({
environmentId: "us_env_YOUR_ID",
body: {
topics: ["workbook:updated"],
compiler: "js",
source: "module.exports = { routeEvent: async (...args) => { console.log(args) } }",
namespace: "space:blue",
},
});
```
#### ⚙️ Parameters
**request:** `Flatfile.CreateAgentsRequest`
**requestOptions:** `Agents.RequestOptions`
client.agents.get (agentId, { ...params }) -> Flatfile.AgentResponse
#### 🔌 Usage
```typescript
await client.agents.get("us_ag_YOUR_ID", {
environmentId: "us_env_YOUR_ID",
});
```
#### ⚙️ Parameters
**agentId:** `Flatfile.AgentId`
**request:** `Flatfile.GetAgentRequest`
**requestOptions:** `Agents.RequestOptions`
client.agents.listVersions (agentId) -> Flatfile.ListAgentVersionsResponse
#### 🔌 Usage
```typescript
await client.agents.listVersions("agentId");
```
#### ⚙️ Parameters
**agentId:** `Flatfile.AgentId`
**requestOptions:** `Agents.RequestOptions`
client.agents.revert (agentId, agentVersionId) -> Flatfile.AgentVersionResponse
#### 🔌 Usage
```typescript
await client.agents.revert("agentId", "agentVersionId");
```
#### ⚙️ Parameters
**agentId:** `Flatfile.AgentId`
**agentVersionId:** `Flatfile.AgentVersionId`
**requestOptions:** `Agents.RequestOptions`
client.agents.listAgentRoles (agentId) -> Flatfile.ListActorRolesResponse
#### 📝 Description
Lists roles assigned to an agent.
#### 🔌 Usage
```typescript
await client.agents.listAgentRoles("agentId");
```
#### ⚙️ Parameters
**agentId:** `Flatfile.AgentId` — The agent id
**requestOptions:** `Agents.RequestOptions`
client.agents.assignAgentRole (agentId, { ...params }) -> Flatfile.AssignRoleResponse
#### 📝 Description
Assigns a role to a agent.
#### 🔌 Usage
```typescript
await client.agents.assignAgentRole("agentId", {
roleId: "roleId",
resourceId: "resourceId",
});
```
#### ⚙️ Parameters
**agentId:** `Flatfile.AgentId` — The agent id
**request:** `Flatfile.AssignActorRoleRequest`
**requestOptions:** `Agents.RequestOptions`
client.agents.deleteAgentRole (agentId, actorRoleId) -> Flatfile.Success
#### 📝 Description
Removes a role from an agent.
#### 🔌 Usage
```typescript
await client.agents.deleteAgentRole("agentId", "actorRoleId");
```
#### ⚙️ Parameters
**agentId:** `Flatfile.AgentId` — The agent id
**actorRoleId:** `Flatfile.ActorRoleId` — The actor role id
**requestOptions:** `Agents.RequestOptions`
client.agents.getAgentLogs (agentId, { ...params }) -> Flatfile.GetAgentLogsResponse
#### 🔌 Usage
```typescript
await client.agents.getAgentLogs("us_ag_YOUR_ID", {
environmentId: "us_env_YOUR_ID",
});
```
#### ⚙️ Parameters
**agentId:** `Flatfile.AgentId`
**request:** `Flatfile.GetAgentLogsRequest`
**requestOptions:** `Agents.RequestOptions`
client.agents.getAgentLog (eventId, { ...params }) -> Flatfile.GetDetailedAgentLogResponse
#### 🔌 Usage
```typescript
await client.agents.getAgentLog("commons.EventId", {
environmentId: "us_env_YOUR_ID",
});
```
#### ⚙️ Parameters
**eventId:** `Flatfile.EventId`
**request:** `Flatfile.GetAgentLogRequest`
**requestOptions:** `Agents.RequestOptions`
client.agents.getEnvironmentAgentLogs ({ ...params }) -> Flatfile.GetDetailedAgentLogsResponse
#### 🔌 Usage
```typescript
await client.agents.getEnvironmentAgentLogs({
environmentId: "us_env_YOUR_ID",
spaceId: "us_sp_YOUR_ID",
success: true,
pageSize: 20,
pageNumber: 1,
});
```
#### ⚙️ Parameters
**request:** `Flatfile.GetEnvironmentAgentLogsRequest`
**requestOptions:** `Agents.RequestOptions`
client.agents.getEnvironmentAgentExecutions ({ ...params }) -> Flatfile.GetExecutionsResponse
#### 🔌 Usage
```typescript
await client.agents.getEnvironmentAgentExecutions({
environmentId: "us_env_YOUR_ID",
agentId: "us_ag_YOUR_ID",
spaceId: "us_sp_YOUR_ID",
success: true,
pageSize: 20,
pageNumber: 1,
});
```
#### ⚙️ Parameters
**request:** `Flatfile.GetEnvironmentAgentExecutionsRequest`
**requestOptions:** `Agents.RequestOptions`
client.agents.delete (agentId, { ...params }) -> Flatfile.Success
#### 📝 Description
Deletes a single agent
#### 🔌 Usage
```typescript
await client.agents.delete("us_ag_YOUR_ID");
```
#### ⚙️ Parameters
**agentId:** `Flatfile.AgentId`
**request:** `Flatfile.DeleteAgentRequest`
**requestOptions:** `Agents.RequestOptions`
client.analysis.list ({ ...params }) -> Flatfile.AnalysisResponse
#### 🔌 Usage
```typescript
await client.analysis.list({
sheetId: "sheetId",
});
```
#### ⚙️ Parameters
**request:** `Flatfile.ListAnalysisRequest`
**requestOptions:** `Analysis.RequestOptions`
client.analysis.create ({ ...params }) -> Flatfile.AnalysisResponse
#### 🔌 Usage
```typescript
await client.analysis.create({
sheetId: "sheetId",
environmentId: "environmentId",
spaceId: "spaceId",
workbookId: "workbookId",
analyses: [
{
field: "field",
result: {
key: "value",
},
},
{
field: "field",
result: {
key: "value",
},
},
],
});
```
#### ⚙️ Parameters
**request:** `Flatfile.CreateAnalysisRequest`
**requestOptions:** `Analysis.RequestOptions`
client.analysis.get (analysisId, { ...params }) -> Flatfile.AnalysisData
#### 🔌 Usage
```typescript
await client.analysis.get("analysisId", {
sheetId: "sheetId",
});
```
#### ⚙️ Parameters
**analysisId:** `Flatfile.AnalysisId`
**request:** `Flatfile.GetAnalysisRequest`
**requestOptions:** `Analysis.RequestOptions`
client.analysis.delete (analysisId, { ...params }) -> Flatfile.Success
#### 🔌 Usage
```typescript
await client.analysis.delete("analysisId", {
sheetId: "sheetId",
});
```
#### ⚙️ Parameters
**analysisId:** `Flatfile.AnalysisId`
**request:** `Flatfile.DeleteAnalysisRequest`
**requestOptions:** `Analysis.RequestOptions`
client.analysis.deleteBySheet ({ ...params }) -> Flatfile.DeleteAnalysesResponse
#### 🔌 Usage
```typescript
await client.analysis.deleteBySheet({
sheetId: "sheetId",
});
```
#### ⚙️ Parameters
**request:** `Flatfile.DeleteAnalysesBySheetRequest`
**requestOptions:** `Analysis.RequestOptions`
client.analysis.updateSuggestion (analysisId, suggestionId, { ...params }) -> Flatfile.Success
#### 🔌 Usage
```typescript
await client.analysis.updateSuggestion("analysisId", "suggestionId", {
sheetId: "sheetId",
suggestion: {
key: "value",
},
});
```
#### ⚙️ Parameters
**analysisId:** `Flatfile.AnalysisId`
**suggestionId:** `string`
**request:** `Flatfile.UpdateSuggestionRequest`
**requestOptions:** `Analysis.RequestOptions`
client.analysis.deleteSuggestion (analysisId, suggestionId, { ...params }) -> Flatfile.Success
#### 🔌 Usage
```typescript
await client.analysis.deleteSuggestion("analysisId", "suggestionId", {
sheetId: "sheetId",
});
```
#### ⚙️ Parameters
**analysisId:** `Flatfile.AnalysisId`
**suggestionId:** `string`
**request:** `Flatfile.DeleteSuggestionRequest`
**requestOptions:** `Analysis.RequestOptions`
client.apps.list () -> Flatfile.AppsResponse
#### 📝 Description
Returns apps in an account
#### 🔌 Usage
```typescript
await client.apps.list();
```
#### ⚙️ Parameters
**requestOptions:** `Apps.RequestOptions`
client.apps.get (appId) -> Flatfile.AppResponse
#### 📝 Description
Returns an app
#### 🔌 Usage
```typescript
await client.apps.get("us_app_YOUR_ID");
```
#### ⚙️ Parameters
**appId:** `Flatfile.AppId` — ID of app
**requestOptions:** `Apps.RequestOptions`
client.apps.update (appId, { ...params }) -> Flatfile.AppResponse
#### 📝 Description
Updates an app
#### 🔌 Usage
```typescript
await client.apps.update("us_app_YOUR_ID", {
name: "Nightly Data Loads",
namespace: "nightly-data",
entity: "Sync",
entityPlural: "Syncs",
icon: '\n ',
metadata: {
foo: "bar",
},
});
```
#### ⚙️ Parameters
**appId:** `Flatfile.AppId` — ID of app
**request:** `Flatfile.AppPatch`
**requestOptions:** `Apps.RequestOptions`
client.apps.create ({ ...params }) -> Flatfile.AppResponse
#### 📝 Description
Creates an app
#### 🔌 Usage
```typescript
await client.apps.create({
name: "Nightly Data Loads",
namespace: "nightly-data",
type: "CUSTOM",
entity: "Sync",
entityPlural: "Syncs",
icon: '\n ',
metadata: {
foo: "bar",
},
});
```
#### ⚙️ Parameters
**request:** `Flatfile.AppCreate`
**requestOptions:** `Apps.RequestOptions`
client.apps.delete (appId) -> Flatfile.SuccessResponse
#### 📝 Description
Deletes an app
#### 🔌 Usage
```typescript
await client.apps.delete("us_app_YOUR_ID");
```
#### ⚙️ Parameters
**appId:** `Flatfile.AppId` — ID of app to delete
**requestOptions:** `Apps.RequestOptions`
client.apps.getConstraints (appId, { ...params }) -> Flatfile.ConstraintsResponse
#### 📝 Description
Returns constraints for an app
#### 🔌 Usage
```typescript
await client.apps.getConstraints("appId");
```
#### ⚙️ Parameters
**appId:** `Flatfile.AppId` — ID of the app
**request:** `Flatfile.GetConstraintsRequest`
**requestOptions:** `Apps.RequestOptions`
client.apps.createConstraint (appId, { ...params }) -> Flatfile.ConstraintResponse
#### 📝 Description
Creates a new constraint for an app
#### 🔌 Usage
```typescript
await client.apps.createConstraint("appId", {});
```
#### ⚙️ Parameters
**appId:** `Flatfile.AppId` — ID of the app
**request:** `Flatfile.ConstraintCreate`
**requestOptions:** `Apps.RequestOptions`
client.apps.getConstraintById (appId, constraintId) -> Flatfile.ConstraintResponse
#### 📝 Description
Returns a specific constraint
#### 🔌 Usage
```typescript
await client.apps.getConstraintById("appId", "constraintId");
```
#### ⚙️ Parameters
**appId:** `Flatfile.AppId` — ID of the app
**constraintId:** `Flatfile.ConstraintId` — ID of the constraint
**requestOptions:** `Apps.RequestOptions`
client.apps.getConstraintVersions (appId, constraintId) -> Flatfile.ConstraintVersionsResponse
#### 📝 Description
Returns the versions of a specific constraint
#### 🔌 Usage
```typescript
await client.apps.getConstraintVersions("appId", "constraintId");
```
#### ⚙️ Parameters
**appId:** `Flatfile.AppId` — ID of the app
**constraintId:** `Flatfile.ConstraintId` — ID of the constraint
**requestOptions:** `Apps.RequestOptions`
client.apps.getConstraintVersion (appId, constraintId, version) -> Flatfile.ConstraintVersionResponse
#### 📝 Description
Returns a specified version of a specific constraint
#### 🔌 Usage
```typescript
await client.apps.getConstraintVersion("appId", "constraintId", 1);
```
#### ⚙️ Parameters
**appId:** `Flatfile.AppId` — ID of the app
**constraintId:** `Flatfile.ConstraintId` — ID of the constraint
**version:** `number` — Version of the constraint
**requestOptions:** `Apps.RequestOptions`
client.apps.updateConstraint (appId, constraintId, { ...params }) -> Flatfile.ConstraintResponse
#### 📝 Description
Updates a specific constraint
#### 🔌 Usage
```typescript
await client.apps.updateConstraint("appId", "constraintId", {});
```
#### ⚙️ Parameters
**appId:** `Flatfile.AppId` — ID of the app
**constraintId:** `Flatfile.ConstraintId` — ID of the constraint
**request:** `Flatfile.ConstraintUpdate`
**requestOptions:** `Apps.RequestOptions`
client.apps.deleteConstraint (appId, constraintId) -> Flatfile.SuccessResponse
#### 📝 Description
Deletes a specific constraint
#### 🔌 Usage
```typescript
await client.apps.deleteConstraint("appId", "constraintId");
```
#### ⚙️ Parameters
**appId:** `Flatfile.AppId` — ID of the app
**constraintId:** `Flatfile.ConstraintId` — ID of the constraint
**requestOptions:** `Apps.RequestOptions`
client.assistant.list ({ ...params }) -> Flatfile.PromptsResponse
#### 📝 Description
Returns prompts created by user
#### 🔌 Usage
```typescript
await client.assistant.list();
```
#### ⚙️ Parameters
**request:** `Flatfile.ListPromptsRequest`
**requestOptions:** `Assistant.RequestOptions`
client.assistant.get (promptId) -> Flatfile.PromptResponse
#### 📝 Description
Returns a prompt
#### 🔌 Usage
```typescript
await client.assistant.get("us_pr_YOUR_ID");
```
#### ⚙️ Parameters
**promptId:** `Flatfile.PromptId` — ID of prompts
**requestOptions:** `Assistant.RequestOptions`
client.assistant.update (promptId, { ...params }) -> Flatfile.PromptResponse
#### 📝 Description
Updates a prompt
#### 🔌 Usage
```typescript
await client.assistant.update("us_pr_YOUR_ID", {
prompt: "Combine first name and last name into a new column called Full Name",
});
```
#### ⚙️ Parameters
**promptId:** `Flatfile.PromptId` — ID of prompts
**request:** `Flatfile.PromptPatch`
**requestOptions:** `Assistant.RequestOptions`
client.assistant.create ({ ...params }) -> Flatfile.PromptResponse
#### 📝 Description
Creates a prompt
#### 🔌 Usage
```typescript
await client.assistant.create({
prompt: "Combine first name and last name into a new column called Full Name",
environmentId: "us_env_YOUR_ID",
spaceId: "us_sp_YOUR_ID",
});
```
#### ⚙️ Parameters
**request:** `Flatfile.PromptCreate`
**requestOptions:** `Assistant.RequestOptions`
client.assistant.delete (promptId) -> Flatfile.Success
#### 📝 Description
Deletes a prompts
#### 🔌 Usage
```typescript
await client.assistant.delete("us_pr_YOUR_ID");
```
#### ⚙️ Parameters
**promptId:** `Flatfile.PromptId` — ID of prompts
**requestOptions:** `Assistant.RequestOptions`
client.auth.createAccessToken ({ ...params }) -> Flatfile.AccessToken
#### 📝 Description
Exchange credentials for an access token. Credentials can be a Client ID and Secret or an Email and Password
#### 🔌 Usage
```typescript
await client.auth.createAccessToken({
type: "userCredentials",
email: "yourEmail@example.com",
password: "yourSuper$ecurePassw0rd",
});
```
#### ⚙️ Parameters
**request:** `Flatfile.Credentials`
**requestOptions:** `Auth.RequestOptions`
client.auth.getApiKeys ({ ...params }) -> Flatfile.ApiKeysResponse
#### 🔌 Usage
```typescript
await client.auth.getApiKeys({
environmentId: "us_env_YOUR_ID",
});
```
#### ⚙️ Parameters
**request:** `Flatfile.GetApiKeysRequest`
**requestOptions:** `Auth.RequestOptions`
client.auth.getPublishableKey ({ ...params }) -> Flatfile.PublishableKeyResponse
#### 🔌 Usage
```typescript
await client.auth.getPublishableKey({
environmentId: "us_env_YOUR_ID",
});
```
#### ⚙️ Parameters
**request:** `Flatfile.GetPublishableKeyRequest`
**requestOptions:** `Auth.RequestOptions`
client.auth.createNewApiKey ({ ...params }) -> Flatfile.ApiKeysResponse
#### 🔌 Usage
```typescript
await client.auth.createNewApiKey({
environmentId: "us_env_YOUR_ID",
type: "PUBLISHABLE",
});
```
#### ⚙️ Parameters
**request:** `Flatfile.CreateNewApiKeyRequest`
**requestOptions:** `Auth.RequestOptions`
client.auth.deleteApiKey ({ ...params }) -> Flatfile.Success
#### 🔌 Usage
```typescript
await client.auth.deleteApiKey({
environmentId: "us_env_YOUR_ID",
key: "us_key_YOUR_ID",
});
```
#### ⚙️ Parameters
**request:** `Flatfile.DeleteApiKeyRequest`
**requestOptions:** `Auth.RequestOptions`
client.auth.refreshToken ({ ...params }) -> Flatfile.AccessToken
#### 🔌 Usage
```typescript
await client.auth.refreshToken("string");
```
#### ⚙️ Parameters
**request:** `string`
**requestOptions:** `Auth.RequestOptions`
client.auth.getSftpCredentials ({ ...params }) -> Flatfile.SftpCredentials
#### 🔌 Usage
```typescript
await client.auth.getSftpCredentials({
spaceId: "spaceId",
});
```
#### ⚙️ Parameters
**request:** `Flatfile.GetSftpCredentialsRequest`
**requestOptions:** `Auth.RequestOptions`
client.auth.listPersonalAccessTokens () -> Flatfile.PersonalAccessTokensResponse
#### 📝 Description
List all personal access tokens for the authenticated user
#### 🔌 Usage
```typescript
await client.auth.listPersonalAccessTokens();
```
#### ⚙️ Parameters
**requestOptions:** `Auth.RequestOptions`
client.auth.createPersonalAccessToken ({ ...params }) -> Flatfile.CreatePersonalAccessTokenResponse
#### 📝 Description
Create a new personal access token for the authenticated user
#### 🔌 Usage
```typescript
await client.auth.createPersonalAccessToken({
name: "name",
});
```
#### ⚙️ Parameters
**request:** `Flatfile.CreatePersonalAccessTokenRequest`
**requestOptions:** `Auth.RequestOptions`
client.auth.deletePersonalAccessToken (accessTokenId, { ...params }) -> Flatfile.Success
#### 📝 Description
Delete a specific personal access token by ID
#### 🔌 Usage
```typescript
await client.auth.deletePersonalAccessToken("accessTokenId");
```
#### ⚙️ Parameters
**accessTokenId:** `Flatfile.PersonalAccessTokenId` — ID of the personal access token to delete
**request:** `Flatfile.DeletePersonalAccessTokenRequest`
**requestOptions:** `Auth.RequestOptions`
client.canvasAreas.list ({ ...params }) -> Flatfile.ListCanvasAreasResponse
#### 📝 Description
Returns a list of canvas areas filtered by canvas, space, or environment
#### 🔌 Usage
```typescript
await client.canvasAreas.list();
```
#### ⚙️ Parameters
**request:** `Flatfile.ListCanvasAreasRequest`
**requestOptions:** `CanvasAreas.RequestOptions`
client.canvasAreas.create ({ ...params }) -> Flatfile.CanvasAreaResponse
#### 📝 Description
Creates a new canvas area
#### 🔌 Usage
```typescript
await client.canvasAreas.create({
canvasId: "canvasId",
type: "mapping",
position: "top",
});
```
#### ⚙️ Parameters
**request:** `Flatfile.CreateCanvasAreaRequest`
**requestOptions:** `CanvasAreas.RequestOptions`
client.canvasAreas.get (canvasAreaId) -> Flatfile.CanvasAreaResponse
#### 📝 Description
Returns a specific canvas area by ID
#### 🔌 Usage
```typescript
await client.canvasAreas.get("canvasAreaId");
```
#### ⚙️ Parameters
**canvasAreaId:** `Flatfile.CanvasAreaId`
**requestOptions:** `CanvasAreas.RequestOptions`
client.canvasAreas.update (canvasAreaId, { ...params }) -> Flatfile.CanvasAreaResponse
#### 📝 Description
Updates an existing canvas area
#### 🔌 Usage
```typescript
await client.canvasAreas.update("canvasAreaId");
```
#### ⚙️ Parameters
**canvasAreaId:** `Flatfile.CanvasAreaId`
**request:** `Flatfile.UpdateCanvasAreaRequest`
**requestOptions:** `CanvasAreas.RequestOptions`
client.canvasAreas.delete (canvasAreaId) -> Flatfile.Success
#### 📝 Description
Deletes a specific canvas area
#### 🔌 Usage
```typescript
await client.canvasAreas.delete("canvasAreaId");
```
#### ⚙️ Parameters
**canvasAreaId:** `Flatfile.CanvasAreaId`
**requestOptions:** `CanvasAreas.RequestOptions`
client.cells.getValues (sheetId, { ...params }) -> Flatfile.CellsResponseDeprecated
#### 📝 Description
Returns record cell values grouped by all fields in the sheet
#### 🔌 Usage
```typescript
await client.cells.getValues("us_sh_YOUR_ID", {
fieldKey: "firstName",
sortField: "firstName",
sortDirection: "asc",
filter: "valid",
});
```
#### ⚙️ Parameters
**sheetId:** `Flatfile.SheetId` — ID of sheet
**request:** `Flatfile.GetFieldValuesRequestDeprecated`
**requestOptions:** `Cells.RequestOptions`
client.commits.get (commitId) -> Flatfile.CommitResponse
#### 📝 Description
Returns the details of a commit version
#### 🔌 Usage
```typescript
await client.commits.get("us_vr_YOUR_ID");
```
#### ⚙️ Parameters
**commitId:** `Flatfile.CommitId` — ID of the commit version to return
**requestOptions:** `Commits.RequestOptions`
client.commits.complete (commitId) -> Flatfile.Success
#### 📝 Description
Completes a commit version. This marks the commit as complete and acknowledges that the changes have been applied to the sheet.
#### 🔌 Usage
```typescript
await client.commits.complete("commitId");
```
#### ⚙️ Parameters
**commitId:** `Flatfile.CommitId` — ID of the commit version to complete
**requestOptions:** `Commits.RequestOptions`
client.commits.replay (commitId) -> Flatfile.Success
#### 📝 Description
Replays a commit:created event.
#### 🔌 Usage
```typescript
await client.commits.replay("commitId");
```
#### ⚙️ Parameters
**commitId:** `Flatfile.CommitId` — ID of the commit version to re-emit a commit:created event for
**requestOptions:** `Commits.RequestOptions`
client.dataClips.create ({ ...params }) -> Flatfile.DataClip
#### 📝 Description
Creates a new DataClip.
#### 🔌 Usage
```typescript
await client.dataClips.create({
name: "name",
sourceSheetId: "sourceSheetId",
});
```
#### ⚙️ Parameters
**request:** `Flatfile.CreateDataClipRequest`
**requestOptions:** `DataClips.RequestOptions`
client.dataClips.update (dataClipId, { ...params }) -> Flatfile.DataClipResponse
#### 🔌 Usage
```typescript
await client.dataClips.update("dataClipId", {
name: "name",
});
```
#### ⚙️ Parameters
**dataClipId:** `Flatfile.DataClipId`
**request:** `Flatfile.UpdateDataClipRequest`
**requestOptions:** `DataClips.RequestOptions`
client.dataClips.delete (dataClipId) -> Flatfile.Success
#### 🔌 Usage
```typescript
await client.dataClips.delete("dataClipId");
```
#### ⚙️ Parameters
**dataClipId:** `Flatfile.DataClipId`
**requestOptions:** `DataClips.RequestOptions`
client.dataClips.get (dataClipId) -> Flatfile.DataClipResponse
#### 🔌 Usage
```typescript
await client.dataClips.get("dataClipId");
```
#### ⚙️ Parameters
**dataClipId:** `Flatfile.DataClipId`
**requestOptions:** `DataClips.RequestOptions`
client.dataClips.addRecordsToClip (dataClipId, { ...params }) -> Flatfile.RecordsResponseData
#### 📝 Description
Adds records to an existing DataClip.
#### 🔌 Usage
```typescript
await client.dataClips.addRecordsToClip("dataClipId", {
recordIds: ["recordIds", "recordIds"],
});
```
#### ⚙️ Parameters
**dataClipId:** `Flatfile.DataClipId`
**request:** `Flatfile.AddRecordsToClipRequest`
**requestOptions:** `DataClips.RequestOptions`
client.dataClips.list ({ ...params }) -> Flatfile.ListDataClipResponse
#### 🔌 Usage
```typescript
await client.dataClips.list();
```
#### ⚙️ Parameters
**request:** `Flatfile.ListDataClipsRequest`
**requestOptions:** `DataClips.RequestOptions`
client.dataClips.getResolutions (dataClipId, { ...params }) -> Flatfile.DiffRecordsResponse
#### 🔌 Usage
```typescript
await client.dataClips.getResolutions("dataClipId");
```
#### ⚙️ Parameters
**dataClipId:** `Flatfile.DataClipId`
**request:** `Flatfile.GetDataClipResolutionsRequest`
**requestOptions:** `DataClips.RequestOptions`
client.dataClips.getResolutionIndex (dataClipId, { ...params }) -> Flatfile.GetResolutionIndexResponse
#### 🔌 Usage
```typescript
await client.dataClips.getResolutionIndex("dataClipId", {
filterConflicts: "filterConflicts",
id: "id",
});
```
#### ⚙️ Parameters
**dataClipId:** `Flatfile.DataClipId`
**request:** `Flatfile.GetDataClipResolutionIndexRequest`
**requestOptions:** `DataClips.RequestOptions`
client.dataClips.updateResolution (dataClipId, { ...params }) -> Flatfile.Success
#### 🔌 Usage
```typescript
await client.dataClips.updateResolution("dataClipId", {
resolvedRecords: [
{
recordId: "recordId",
resolves: [{}, {}],
},
{
recordId: "recordId",
resolves: [{}, {}],
},
],
});
```
#### ⚙️ Parameters
**dataClipId:** `Flatfile.DataClipId`
**request:** `Flatfile.UpdateResolutionRequest`
**requestOptions:** `DataClips.RequestOptions`
client.dataClips.refreshResolutions (dataClipId) -> Flatfile.Success
#### 🔌 Usage
```typescript
await client.dataClips.refreshResolutions("dataClipId");
```
#### ⚙️ Parameters
**dataClipId:** `Flatfile.DataClipId`
**requestOptions:** `DataClips.RequestOptions`
client.dataRetentionPolicies.list ({ ...params }) -> Flatfile.ListDataRetentionPoliciesResponse
#### 📝 Description
Returns all data retention policies on an account matching a filter for environmentId
#### 🔌 Usage
```typescript
await client.dataRetentionPolicies.list({
environmentId: "us_env_YOUR_ID",
});
```
#### ⚙️ Parameters
**request:** `Flatfile.ListDataRetentionPoliciesRequest`
**requestOptions:** `DataRetentionPolicies.RequestOptions`
client.dataRetentionPolicies.create ({ ...params }) -> Flatfile.DataRetentionPolicyResponse
#### 📝 Description
Add a new data retention policy to the space
#### 🔌 Usage
```typescript
await client.dataRetentionPolicies.create({
type: "lastActivity",
period: 5,
environmentId: "us_env_YOUR_ID",
});
```
#### ⚙️ Parameters
**request:** `Flatfile.DataRetentionPolicyConfig`
**requestOptions:** `DataRetentionPolicies.RequestOptions`
client.dataRetentionPolicies.get (id) -> Flatfile.DataRetentionPolicyResponse
#### 📝 Description
Returns a single data retention policy
#### 🔌 Usage
```typescript
await client.dataRetentionPolicies.get("us_drp_YOUR_ID");
```
#### ⚙️ Parameters
**id:** `Flatfile.DataRetentionPolicyId` — ID of data retention policy to return
**requestOptions:** `DataRetentionPolicies.RequestOptions`
client.dataRetentionPolicies.update (id, { ...params }) -> Flatfile.DataRetentionPolicyResponse
#### 📝 Description
Updates a single data retention policy
#### 🔌 Usage
```typescript
await client.dataRetentionPolicies.update("us_drp_YOUR_ID", {
type: "lastActivity",
period: 5,
environmentId: "us_env_YOUR_ID",
});
```
#### ⚙️ Parameters
**id:** `Flatfile.DataRetentionPolicyId` — ID of data retention policy to update
**request:** `Flatfile.DataRetentionPolicyConfig`
**requestOptions:** `DataRetentionPolicies.RequestOptions`
client.dataRetentionPolicies.delete (id) -> Flatfile.Success
#### 📝 Description
Deletes a single data retention policy
#### 🔌 Usage
```typescript
await client.dataRetentionPolicies.delete("id");
```
#### ⚙️ Parameters
**id:** `Flatfile.DataRetentionPolicyId` — ID of data retention policy to delete
**requestOptions:** `DataRetentionPolicies.RequestOptions`
client.documents.list (spaceId) -> Flatfile.ListDocumentsResponse
#### 📝 Description
Returns all documents for a space
#### 🔌 Usage
```typescript
await client.documents.list("us_sp_YOUR_ID");
```
#### ⚙️ Parameters
**spaceId:** `Flatfile.SpaceId` — ID of space to return
**requestOptions:** `Documents.RequestOptions`
client.documents.create (spaceId, { ...params }) -> Flatfile.DocumentResponse
#### 📝 Description
Add a new document to the space
#### 🔌 Usage
```typescript
await client.documents.create("us_sp_YOUR_ID", {
title: "My Document 1",
body: "My information",
actions: [
{
operation: "submitAction",
mode: "foreground",
label: "Submit",
description: "Submit data to webhook.site",
primary: true,
},
],
});
```
#### ⚙️ Parameters
**spaceId:** `Flatfile.SpaceId` — ID of space to return
**request:** `Flatfile.DocumentConfig`
**requestOptions:** `Documents.RequestOptions`
client.documents.get (spaceId, documentId) -> Flatfile.DocumentResponse
#### 📝 Description
Returns a single document
#### 🔌 Usage
```typescript
await client.documents.get("us_sp_YOUR_ID", "us_dc_YOUR_ID");
```
#### ⚙️ Parameters
**spaceId:** `Flatfile.SpaceId` — ID of space to return
**documentId:** `Flatfile.DocumentId` — ID of document to return
**requestOptions:** `Documents.RequestOptions`
client.documents.update (spaceId, documentId, { ...params }) -> Flatfile.DocumentResponse
#### 📝 Description
updates a single document, for only the body and title
#### 🔌 Usage
```typescript
await client.documents.update("us_sp_YOUR_ID", "us_dc_YOUR_ID", {
title: "Updated Title",
body: "Updated My information",
});
```
#### ⚙️ Parameters
**spaceId:** `Flatfile.SpaceId` — ID of space to return
**documentId:** `Flatfile.DocumentId` — ID of document to return
**request:** `Flatfile.DocumentConfig`
**requestOptions:** `Documents.RequestOptions`
client.documents.delete (spaceId, documentId) -> Flatfile.Success
#### 📝 Description
Deletes a single document
#### 🔌 Usage
```typescript
await client.documents.delete("spaceId", "documentId");
```
#### ⚙️ Parameters
**spaceId:** `Flatfile.SpaceId` — ID of space to return
**documentId:** `Flatfile.DocumentId` — ID of document to delete
**requestOptions:** `Documents.RequestOptions`
client.entitlements.list ({ ...params }) -> Flatfile.ListEntitlementsResponse
#### 📝 Description
Returns all entitlements matching a filter for resourceId
#### 🔌 Usage
```typescript
await client.entitlements.list({
resourceId: "string",
});
```
#### ⚙️ Parameters
**request:** `Flatfile.ListEntitlementsRequest`
**requestOptions:** `Entitlements.RequestOptions`
client.environments.list ({ ...params }) -> Flatfile.ListEnvironmentsResponse
#### 📝 Description
Get all environments
#### 🔌 Usage
```typescript
await client.environments.list();
```
#### ⚙️ Parameters
**request:** `Flatfile.ListEnvironmentsRequest`
**requestOptions:** `Environments.RequestOptions`
client.environments.create ({ ...params }) -> Flatfile.EnvironmentResponse
#### 📝 Description
Create a new environment
#### 🔌 Usage
```typescript
await client.environments.create({
name: "dev",
isProd: false,
guestAuthentication: ["magic_link"],
metadata: {
key: "value",
},
namespaces: ["default"],
});
```
#### ⚙️ Parameters
**request:** `Flatfile.EnvironmentConfigCreate`
**requestOptions:** `Environments.RequestOptions`
client.environments.getEnvironmentEventToken ({ ...params }) -> Flatfile.EventTokenResponse
#### 📝 Description
Get a token which can be used to subscribe to events for this environment
#### 🔌 Usage
```typescript
await client.environments.getEnvironmentEventToken({
environmentId: "us_env_YOUR_ID",
});
```
#### ⚙️ Parameters
**request:** `Flatfile.GetEnvironmentEventTokenRequest`
**requestOptions:** `Environments.RequestOptions`
client.environments.get (environmentId) -> Flatfile.EnvironmentResponse
#### 📝 Description
Returns a single environment
#### 🔌 Usage
```typescript
await client.environments.get("us_env_YOUR_ID");
```
#### ⚙️ Parameters
**environmentId:** `string` — ID of the environment to return. To fetch the current environment, pass `current`
**requestOptions:** `Environments.RequestOptions`
client.environments.update (environmentId, { ...params }) -> Flatfile.Environment
#### 📝 Description
Updates a single environment, to change the name for example
#### 🔌 Usage
```typescript
await client.environments.update("us_env_YOUR_ID", {
name: "dev",
isProd: false,
guestAuthentication: ["magic_link"],
metadata: {
key: "value",
},
namespaces: ["default"],
});
```
#### ⚙️ Parameters
**environmentId:** `string` — ID of the environment to update
**request:** `Flatfile.EnvironmentConfigUpdate`
**requestOptions:** `Environments.RequestOptions`
client.environments.delete (environmentId) -> Flatfile.Success
#### 📝 Description
Deletes a single environment
#### 🔌 Usage
```typescript
await client.environments.delete("us_env_YOUR_ID");
```
#### ⚙️ Parameters
**environmentId:** `string` — ID of the environment to delete
**requestOptions:** `Environments.RequestOptions`
client.environments.listGuides (environmentId) -> Flatfile.GuideListResponse
#### 📝 Description
Returns guides in an account
#### 🔌 Usage
```typescript
await client.environments.listGuides("us_env_YOUR_ID");
```
#### ⚙️ Parameters
**environmentId:** `Flatfile.EnvironmentId` — ID of the environment
**requestOptions:** `Environments.RequestOptions`
client.environments.getGuide (environmentId, guideId) -> Flatfile.GuideDetailResponse
#### 📝 Description
Returns a guide
#### 🔌 Usage
```typescript
await client.environments.getGuide("us_env_YOUR_ID", "us_gu_YOUR_ID");
```
#### ⚙️ Parameters
**environmentId:** `Flatfile.EnvironmentId` — ID of the environment
**guideId:** `Flatfile.GuideId` — ID of guide
**requestOptions:** `Environments.RequestOptions`
client.environments.updateGuide (environmentId, guideId, { ...params }) -> Flatfile.GuideDetailResponse
#### 📝 Description
Updates a guide
#### 🔌 Usage
```typescript
await client.environments.updateGuide("us_env_YOUR_ID", "us_gu_YOUR_ID", {
description: "Updated getting started guide",
title: "Data import made easy",
slug: "getting-started",
environmentId: "commons.EnvironmentId",
metadata: {
category: "onboarding",
},
});
```
#### ⚙️ Parameters
**environmentId:** `Flatfile.EnvironmentId` — ID of the environment
**guideId:** `Flatfile.GuideId` — ID of guide
**request:** `Flatfile.GuideUpdateRequest`
**requestOptions:** `Environments.RequestOptions`
client.environments.createGuide (environmentId, { ...params }) -> Flatfile.GuideDetailResponse
#### 📝 Description
Creates a guide
#### 🔌 Usage
```typescript
await client.environments.createGuide("us_env_YOUR_ID", {
description: "Getting started guide",
title: "Data import made easy",
slug: "getting-started",
environmentId: "commons.EnvironmentId",
blocks: [],
metadata: {
category: "onboarding",
},
});
```
#### ⚙️ Parameters
**environmentId:** `Flatfile.EnvironmentId` — ID of the environment
**request:** `Flatfile.GuideCreateRequest`
**requestOptions:** `Environments.RequestOptions`
client.environments.deleteGuide (environmentId, guideId) -> Flatfile.GuideDeleteResponse
#### 📝 Description
Deletes a guide
#### 🔌 Usage
```typescript
await client.environments.deleteGuide("us_env_YOUR_ID", "us_gu_YOUR_ID");
```
#### ⚙️ Parameters
**environmentId:** `Flatfile.EnvironmentId` — ID of the environment
**guideId:** `Flatfile.GuideId` — ID of guide to delete
**requestOptions:** `Environments.RequestOptions`
client.environments.getGuideVersion (environmentId, guideId, version) -> Flatfile.GuideVersionResponse
#### 📝 Description
Returns a specified version of a specific guide
#### 🔌 Usage
```typescript
await client.environments.getGuideVersion("us_env_YOUR_ID", "us_gu_YOUR_ID", 1);
```
#### ⚙️ Parameters
**environmentId:** `Flatfile.EnvironmentId` — ID of the environment
**guideId:** `Flatfile.GuideId` — ID of the guide
**version:** `number` — Version of the guide
**requestOptions:** `Environments.RequestOptions`
client.events.list ({ ...params }) -> Flatfile.ListAllEventsResponse
#### 📝 Description
Event topics that the Flatfile Platform emits.
#### 🔌 Usage
```typescript
await client.events.list();
```
#### ⚙️ Parameters
**request:** `Flatfile.ListEventsRequest`
**requestOptions:** `Events.RequestOptions`
client.events.create ({ ...params }) -> Flatfile.EventResponse
#### 🔌 Usage
```typescript
await client.events.create({
topic: "workbook:updated",
payload: {
recordsAdded: 100,
},
domain: "workbook",
context: {
accountId: "us_acc_YOUR_ID",
actorId: "us_key_SOME_KEY",
environmentId: "us_env_YOUR_ID",
spaceId: "us_sp_YOUR_ID",
workbookId: "us_wb_YOUR_ID",
},
});
```
#### ⚙️ Parameters
**request:** `Flatfile.CreateEventConfig`
**requestOptions:** `Events.RequestOptions`
client.events.get (eventId) -> Flatfile.EventResponse
#### 🔌 Usage
```typescript
await client.events.get("us_evt_YOUR_ID");
```
#### ⚙️ Parameters
**eventId:** `Flatfile.EventId` — The event id
**requestOptions:** `Events.RequestOptions`
client.events.ack (eventId) -> Flatfile.Success
#### 🔌 Usage
```typescript
await client.events.ack("eventId");
```
#### ⚙️ Parameters
**eventId:** `Flatfile.EventId` — The event id
**requestOptions:** `Events.RequestOptions`
client.events.getEventToken ({ ...params }) -> Flatfile.EventTokenResponse
#### 📝 Description
Get a token which can be used to subscribe to events for this space
#### 🔌 Usage
```typescript
await client.events.getEventToken();
```
#### ⚙️ Parameters
**request:** `Flatfile.GetEventTokenRequest`
**requestOptions:** `Events.RequestOptions`
client.files.list ({ ...params }) -> Flatfile.ListFilesResponse
#### 🔌 Usage
```typescript
await client.files.list();
```
#### ⚙️ Parameters
**request:** `Flatfile.ListFilesRequest`
**requestOptions:** `Files.RequestOptions`
client.files.get (fileId) -> Flatfile.FileResponse
#### 🔌 Usage
```typescript
await client.files.get("us_fl_YOUR_ID");
```
#### ⚙️ Parameters
**fileId:** `string`
**requestOptions:** `Files.RequestOptions`
client.files.delete (fileId) -> Flatfile.Success
#### 🔌 Usage
```typescript
await client.files.delete("fileId");
```
#### ⚙️ Parameters
**fileId:** `string`
**requestOptions:** `Files.RequestOptions`
client.files.update (fileId, { ...params }) -> Flatfile.FileResponse
#### 📝 Description
Update a file, to change the workbook id for example
#### 🔌 Usage
```typescript
await client.files.update("us_fl_YOUR_ID", {
name: "NewFileName",
});
```
#### ⚙️ Parameters
**fileId:** `string` — ID of file to update
**request:** `Flatfile.UpdateFileRequest`
**requestOptions:** `Files.RequestOptions`
client.files.clone (fileId, { ...params }) -> Flatfile.FileResponse
#### 🔌 Usage
```typescript
await client.files.clone("us_fl_YOUR_ID", {
prefix: "Cloned Test File",
});
```
#### ⚙️ Parameters
**fileId:** `Flatfile.FileId`
**request:** `Flatfile.CloneFileRequest`
**requestOptions:** `Files.RequestOptions`
client.files.detectHeader ({ ...params }) -> Flatfile.DetectHeaderResponse
#### 🔌 Usage
```typescript
await client.files.detectHeader({
options: {
algorithm: "aiDetection",
},
data: [
["", "", "", "", ""],
["Trip Idea", "", "", "", ""],
["Name", "Age", "City", "", ""],
["David", "25", "New York", "Yes", ""],
["Sarah", "32", "London", "", "Green"],
["Michael", "42", "Sydney", "No", ""],
["Jessica", "28", "Paris", "No", "Blue"],
],
});
```
#### ⚙️ Parameters
**request:** `Flatfile.DetectHeaderRequest`
**requestOptions:** `Files.RequestOptions`
client.flags.create (workbookId, { ...params }) -> Flatfile.FlagResponse
#### 📝 Description
Creates a new flag for the workbook
#### 🔌 Usage
```typescript
await client.flags.create("us_wb_YOUR_ID", {
slug: "important",
label: "Important",
colorHex: "#0090FF",
});
```
#### ⚙️ Parameters
**workbookId:** `Flatfile.WorkbookId` — The workbook ID to manage flags for
**request:** `Flatfile.CreateFlagRequest`
**requestOptions:** `Flags.RequestOptions`
client.flags.list (workbookId) -> Flatfile.FlagResponse[]
#### 📝 Description
Gets all flags for the workbook
#### 🔌 Usage
```typescript
await client.flags.list("us_wb_YOUR_ID");
```
#### ⚙️ Parameters
**workbookId:** `Flatfile.WorkbookId` — The workbook ID to manage flags for
**requestOptions:** `Flags.RequestOptions`
client.flags.get (workbookId, slug) -> Flatfile.FlagResponse | undefined
#### 📝 Description
Gets a specific flag by its slug
#### 🔌 Usage
```typescript
await client.flags.get("us_wb_YOUR_ID", "important");
```
#### ⚙️ Parameters
**workbookId:** `Flatfile.WorkbookId` — The workbook ID to manage flags for
**slug:** `string` — The flag slug to retrieve
**requestOptions:** `Flags.RequestOptions`
client.flags.update (workbookId, slug, { ...params }) -> Flatfile.FlagResponse
#### 📝 Description
Updates an existing flag
#### 🔌 Usage
```typescript
await client.flags.update("us_wb_YOUR_ID", "important", {
label: "Updated Important",
colorHex: "#30A46C",
});
```
#### ⚙️ Parameters
**workbookId:** `Flatfile.WorkbookId` — The workbook ID to manage flags for
**slug:** `string` — The flag slug to update
**request:** `Flatfile.UpdateFlagRequest`
**requestOptions:** `Flags.RequestOptions`
client.flags.delete (workbookId, slug) -> Flatfile.Success
#### 📝 Description
Deletes a flag
#### 🔌 Usage
```typescript
await client.flags.delete("us_wb_YOUR_ID", "important");
```
#### ⚙️ Parameters
**workbookId:** `Flatfile.WorkbookId` — The workbook ID to manage flags for
**slug:** `string` — The flag slug to delete
**requestOptions:** `Flags.RequestOptions`
client.flags.bulkMutate (workbookId, { ...params }) -> Flatfile.BulkMutateFlagsResponse
#### 📝 Description
Performs bulk flag operations on records
#### 🔌 Usage
```typescript
await client.flags.bulkMutate("us_wb_YOUR_ID", {
operation: "apply",
slug: "important",
flag: {
label: "Important",
colorHex: "#0090FF",
},
snapshotLabel: "Before important flag application",
});
```
#### ⚙️ Parameters
**workbookId:** `Flatfile.WorkbookId` — The workbook ID to manage flags for
**request:** `Flatfile.BulkMutateFlagsRequest`
**requestOptions:** `Flags.RequestOptions`
client.foreigndb.restore (workbookId, { ...params }) -> Flatfile.RestoreDatabaseResponse
#### 📝 Description
Restore a database from a backup
#### 🔌 Usage
```typescript
await client.foreigndb.restore("workbookId", {
fileId: "fileId",
});
```
#### ⚙️ Parameters
**workbookId:** `string` — the workbook id
**request:** `Flatfile.RestoreDatabaseRequest`
**requestOptions:** `Foreigndb.RequestOptions`
client.foreigndb.configureWorkbook (workbookId) -> Flatfile.Success
#### 📝 Description
Configure the workbook
#### 🔌 Usage
```typescript
await client.foreigndb.configureWorkbook("workbookId");
```
#### ⚙️ Parameters
**workbookId:** `string` — the workbook id
**requestOptions:** `Foreigndb.RequestOptions`
client.foreigndb.getDatabaseInfo (workbookId) -> Flatfile.GetDatabaseResponse
#### 📝 Description
Get the database information
#### 🔌 Usage
```typescript
await client.foreigndb.getDatabaseInfo("workbookId");
```
#### ⚙️ Parameters
**workbookId:** `string` — the workbook id
**requestOptions:** `Foreigndb.RequestOptions`
client.foreigndb.deleteDatabase (workbookId) -> Flatfile.Success
#### 📝 Description
Delete the database
#### 🔌 Usage
```typescript
await client.foreigndb.deleteDatabase("workbookId");
```
#### ⚙️ Parameters
**workbookId:** `string` — the workbook id
**requestOptions:** `Foreigndb.RequestOptions`
client.foreigndb.upload (workbookId, { ...params }) -> Flatfile.Success
#### 📝 Description
Persist a file in s3 object storage
#### 🔌 Usage
```typescript
await client.foreigndb.upload("workbookId", {
fileId: "fileId",
});
```
#### ⚙️ Parameters
**workbookId:** `string` — the workbook id
**request:** `Flatfile.UploadToObjectStorageRequest`
**requestOptions:** `Foreigndb.RequestOptions`
client.guests.list ({ ...params }) -> Flatfile.ListGuestsResponse
#### 📝 Description
Returns all guests
#### 🔌 Usage
```typescript
await client.guests.list({
spaceId: "us_sp_YOUR_ID",
});
```
#### ⚙️ Parameters
**request:** `Flatfile.ListGuestsRequest`
**requestOptions:** `Guests.RequestOptions`
client.guests.create ({ ...params }) -> Flatfile.CreateGuestResponse
#### 📝 Description
Guests are only there to upload, edit, and download files and perform their tasks in a specific Space.
#### 🔌 Usage
```typescript
await client.guests.create([
{
environmentId: "us_env_YOUR_ID",
email: "email@example.com",
name: "Your Name",
spaces: [
{
id: "us_sp_YOUR_ID",
workbooks: [
{
id: "us_wb_YOUR_ID",
},
],
sheets: [
{
id: "us_sh_YOUR_ID",
},
],
lastAccessed: "2023-10-30T16:59:45.735Z",
},
],
},
]);
```
#### ⚙️ Parameters
**request:** `Flatfile.GuestConfig[]`
**requestOptions:** `Guests.RequestOptions`
client.guests.get (guestId) -> Flatfile.GuestResponse
#### 📝 Description
Returns a single guest
#### 🔌 Usage
```typescript
await client.guests.get("us_g_YOUR_ID");
```
#### ⚙️ Parameters
**guestId:** `Flatfile.GuestId` — ID of guest to return
**requestOptions:** `Guests.RequestOptions`
client.guests.delete (guestId, { ...params }) -> Flatfile.Success
#### 📝 Description
Deletes a single guest or removes guest access from a specific space
#### 🔌 Usage
```typescript
await client.guests.delete("us_g_YOUR_ID");
```
#### ⚙️ Parameters
**guestId:** `Flatfile.GuestId` — ID of guest to return
**request:** `Flatfile.DeleteGuestRequest`
**requestOptions:** `Guests.RequestOptions`
client.guests.update (guestId, { ...params }) -> Flatfile.GuestResponse
#### 📝 Description
Updates a single guest, for example to change name or email
#### 🔌 Usage
```typescript
await client.guests.update("us_g_YOUR_ID", {
email: "updated@example.com",
name: "Your Name Updated",
});
```
#### ⚙️ Parameters
**guestId:** `Flatfile.GuestId` — ID of guest to return
**request:** `Flatfile.GuestConfigUpdate`
**requestOptions:** `Guests.RequestOptions`
client.guests.getGuestToken (guestId, { ...params }) -> Flatfile.GuestTokenResponse
#### 📝 Description
Returns a single guest token
#### 🔌 Usage
```typescript
await client.guests.getGuestToken("us_g_YOUR_ID");
```
#### ⚙️ Parameters
**guestId:** `Flatfile.GuestId` — ID of guest to return
**request:** `Flatfile.GetGuestTokenRequest`
**requestOptions:** `Guests.RequestOptions`
client.guests.listGuestRoles (guestId) -> Flatfile.ListActorRolesResponse
#### 📝 Description
Lists roles assigned to a guest.
#### 🔌 Usage
```typescript
await client.guests.listGuestRoles("guestId");
```
#### ⚙️ Parameters
**guestId:** `Flatfile.GuestId` — The guest id
**requestOptions:** `Guests.RequestOptions`
client.guests.assignGuestRole (guestId, { ...params }) -> Flatfile.AssignRoleResponse
#### 📝 Description
Assigns a role to a guest.
#### 🔌 Usage
```typescript
await client.guests.assignGuestRole("guestId", {
roleId: "roleId",
resourceId: "resourceId",
});
```
#### ⚙️ Parameters
**guestId:** `Flatfile.GuestId` — The guest id
**request:** `Flatfile.AssignActorRoleRequest`
**requestOptions:** `Guests.RequestOptions`
client.guests.deleteGuestRole (guestId, actorRoleId) -> Flatfile.Success
#### 📝 Description
Removes a role from a guest.
#### 🔌 Usage
```typescript
await client.guests.deleteGuestRole("guestId", "actorRoleId");
```
#### ⚙️ Parameters
**guestId:** `Flatfile.GuestId` — The guest id
**actorRoleId:** `Flatfile.ActorRoleId` — The actor role id
**requestOptions:** `Guests.RequestOptions`
client.guests.invite ({ ...params }) -> Flatfile.Success
#### 📝 Description
Guests can be created as a named guest on the Space or there’s a global link that will let anonymous guests into the space.
#### 🔌 Usage
```typescript
await client.guests.invite([
{
guestId: "us_g_YOUR_ID",
spaceId: "us_sp_YOUR_ID",
fromName: "Your Name",
message: "Hello, I would like to invite you to my space.",
},
]);
```
#### ⚙️ Parameters
**request:** `Flatfile.Invite[]`
**requestOptions:** `Guests.RequestOptions`
client.jobs.list ({ ...params }) -> Flatfile.ListJobsResponse
#### 🔌 Usage
```typescript
await client.jobs.list({
environmentId: "us_env_YOUR_ID",
spaceId: "us_sp_YOUR_ID",
});
```
#### ⚙️ Parameters
**request:** `Flatfile.ListJobsRequest`
**requestOptions:** `Jobs.RequestOptions`
client.jobs.create ({ ...params }) -> Flatfile.JobResponse
#### 🔌 Usage
```typescript
await client.jobs.create({
type: "workbook",
operation: "submitAction",
source: "us_wb_YOUR_ID",
});
```
#### ⚙️ Parameters
**request:** `Flatfile.JobConfig`
**requestOptions:** `Jobs.RequestOptions`
client.jobs.get (jobId) -> Flatfile.JobResponse
#### 🔌 Usage
```typescript
await client.jobs.get("us_jb_YOUR_ID");
```
#### ⚙️ Parameters
**jobId:** `Flatfile.JobId` — The id of the job to return
**requestOptions:** `Jobs.RequestOptions`
client.jobs.update (jobId, { ...params }) -> Flatfile.JobResponse
#### 🔌 Usage
```typescript
await client.jobs.update("us_jb_YOUR_ID", {
config: {},
status: "complete",
progress: 100,
});
```
#### ⚙️ Parameters
**jobId:** `Flatfile.JobId` — The id of the job to patch
**request:** `Flatfile.JobUpdate`
**requestOptions:** `Jobs.RequestOptions`
client.jobs.delete (jobId) -> Flatfile.Success
#### 🔌 Usage
```typescript
await client.jobs.delete("us_jb_YOUR_ID");
```
#### ⚙️ Parameters
**jobId:** `Flatfile.JobId` — The id of the job to delete
**requestOptions:** `Jobs.RequestOptions`
client.jobs.execute (jobId) -> Flatfile.Success
#### 📝 Description
Execute a job and return the job
#### 🔌 Usage
```typescript
await client.jobs.execute("us_jb_YOUR_ID");
```
#### ⚙️ Parameters
**jobId:** `string` — ID of job to return
**requestOptions:** `Jobs.RequestOptions`
client.jobs.getExecutionPlan (jobId) -> Flatfile.JobPlanResponse
#### 📝 Description
Returns a single job's execution plan
#### 🔌 Usage
```typescript
await client.jobs.getExecutionPlan("us_jb_YOUR_ID");
```
#### ⚙️ Parameters
**jobId:** `Flatfile.JobId` — ID of job to return
**requestOptions:** `Jobs.RequestOptions`
client.jobs.updateExecutionPlan (jobId, { ...params }) -> Flatfile.JobPlanResponse
#### 📝 Description
Update a job's entire execution plan
#### 🔌 Usage
```typescript
await client.jobs.updateExecutionPlan("us_jb_YOUR_ID", {
fieldMapping: [
{
sourceField: {
type: "string",
key: "firstName",
},
destinationField: {
type: "string",
key: "firstName",
label: "First Name",
},
},
{
sourceField: {
type: "string",
key: "lastName",
},
destinationField: {
type: "string",
key: "lastName",
label: "Last Name",
},
},
],
unmappedSourceFields: [
{
sourceField: {
type: "string",
key: "email",
},
},
],
unmappedDestinationFields: [
{
destinationField: {
type: "string",
key: "email",
label: "Email",
},
},
],
fileId: "us_fl_YOUR_ID",
jobId: "us_jb_YOUR_ID",
});
```
#### ⚙️ Parameters
**jobId:** `Flatfile.JobId` — ID of job to return
**request:** `Flatfile.JobExecutionPlanRequest`
**requestOptions:** `Jobs.RequestOptions`
client.jobs.updateExecutionPlanFields (jobId, { ...params }) -> Flatfile.JobPlanResponse
#### 📝 Description
Update one or more individual fields on a job's execution plan
#### 🔌 Usage
```typescript
await client.jobs.updateExecutionPlanFields("jobId", {
fileId: "fileId",
jobId: "jobId",
});
```
#### ⚙️ Parameters
**jobId:** `string` — ID of job to return
**request:** `Flatfile.JobExecutionPlanConfigRequest`
**requestOptions:** `Jobs.RequestOptions`
client.jobs.ack (jobId, { ...params }) -> Flatfile.JobResponse
#### 📝 Description
Acknowledge a job and return the job
#### 🔌 Usage
```typescript
await client.jobs.ack("us_jb_YOUR_ID", {
info: "Acknowledged by user",
progress: 100,
estimatedCompletionAt: "2023-10-30T20:04:32.074Z",
});
```
#### ⚙️ Parameters
**jobId:** `Flatfile.JobId` — ID of job to return
**request:** `Flatfile.JobAckDetails`
**requestOptions:** `Jobs.RequestOptions`
client.jobs.ackOutcome (jobId) -> Flatfile.JobResponse
#### 📝 Description
Acknowledge a job outcome and return the job
#### 🔌 Usage
```typescript
await client.jobs.ackOutcome("us_jb_YOUR_ID");
```
#### ⚙️ Parameters
**jobId:** `Flatfile.JobId` — ID of job to return
**requestOptions:** `Jobs.RequestOptions`
client.jobs.complete (jobId, { ...params }) -> Flatfile.JobResponse
#### 📝 Description
Complete a job and return the job
#### 🔌 Usage
```typescript
await client.jobs.complete("us_jb_YOUR_ID", {
outcome: {
acknowledge: true,
buttonText: "Acknowledge",
next: {
type: "id",
id: "us_jb_YOUR_ID",
},
heading: "Success",
message: "Job was successful",
},
info: "Job is Complete",
});
```
#### ⚙️ Parameters
**jobId:** `Flatfile.JobId` — ID of job to return
**request:** `Flatfile.JobCompleteDetails`
**requestOptions:** `Jobs.RequestOptions`
client.jobs.fail (jobId, { ...params }) -> Flatfile.JobResponse
#### 📝 Description
Fail a job and return the job
#### 🔌 Usage
```typescript
await client.jobs.fail("us_jb_YOUR_ID", {
outcome: {
acknowledge: true,
buttonText: "Acknowledge",
next: {
type: "id",
id: "us_jb_YOUR_ID",
},
heading: "Failed",
message: "Job failed",
},
info: "Job was failed",
});
```
#### ⚙️ Parameters
**jobId:** `Flatfile.JobId` — ID of job to return
**request:** `Flatfile.JobCompleteDetails`
**requestOptions:** `Jobs.RequestOptions`
client.jobs.cancel (jobId, { ...params }) -> Flatfile.JobResponse
#### 📝 Description
Cancel a job and return the job
#### 🔌 Usage
```typescript
await client.jobs.cancel("us_jb_YOUR_ID", {
info: "Job was canceled",
});
```
#### ⚙️ Parameters
**jobId:** `Flatfile.JobId` — ID of job to return
**request:** `Flatfile.JobCancelDetails`
**requestOptions:** `Jobs.RequestOptions`
client.jobs.retry (jobId) -> Flatfile.JobResponse
#### 📝 Description
Retry a failt job and return the job
#### 🔌 Usage
```typescript
await client.jobs.retry("jobId");
```
#### ⚙️ Parameters
**jobId:** `Flatfile.JobId` — ID of job to return
**requestOptions:** `Jobs.RequestOptions`
client.jobs.previewMutation ({ ...params }) -> Flatfile.DiffRecordsResponse
#### 📝 Description
Preview the results of a mutation
#### 🔌 Usage
```typescript
await client.jobs.previewMutation({
sheetId: "sheetId",
mutateRecord: "mutateRecord",
});
```
#### ⚙️ Parameters
**request:** `Flatfile.MutateJobConfig`
**requestOptions:** `Jobs.RequestOptions`
client.jobs.split (jobId, { ...params }) -> Flatfile.JobResponse
#### 📝 Description
Split a job and return the job
#### 🔌 Usage
```typescript
await client.jobs.split("us_jb_YOUR_ID", {
parts: [{}],
runInParallel: true,
});
```
#### ⚙️ Parameters
**jobId:** `Flatfile.JobId` — ID of job to return
**request:** `Flatfile.JobSplitDetails`
**requestOptions:** `Jobs.RequestOptions`
client.mapping.createMappingProgram ({ ...params }) -> Flatfile.ProgramResponse
#### 📝 Description
Creates a list of mapping rules based on two provided schemas
#### 🔌 Usage
```typescript
await client.mapping.createMappingProgram({
body: {
source: {
name: "name",
fields: [
{
type: "string",
key: "key",
},
{
type: "string",
key: "key",
},
],
},
destination: {
name: "name",
fields: [
{
type: "string",
key: "key",
},
{
type: "string",
key: "key",
},
],
},
},
});
```
#### ⚙️ Parameters
**request:** `Flatfile.CreateMappingProgram`
**requestOptions:** `Mapping.RequestOptions`
client.mapping.deleteAllHistoryForUser ({ ...params }) -> Flatfile.Success
#### 📝 Description
Deletes all history for the authenticated user
#### 🔌 Usage
```typescript
await client.mapping.deleteAllHistoryForUser();
```
#### ⚙️ Parameters
**request:** `Flatfile.DeleteAllHistoryForUserRequest`
**requestOptions:** `Mapping.RequestOptions`
client.mapping.listMappingPrograms ({ ...params }) -> Flatfile.ProgramsResponse
#### 📝 Description
List all mapping programs
#### 🔌 Usage
```typescript
await client.mapping.listMappingPrograms();
```
#### ⚙️ Parameters
**request:** `Flatfile.ListProgramsRequest`
**requestOptions:** `Mapping.RequestOptions`
client.mapping.getMappingProgram (programId) -> Flatfile.ProgramResponse
#### 📝 Description
Get a mapping program
#### 🔌 Usage
```typescript
await client.mapping.getMappingProgram("programId");
```
#### ⚙️ Parameters
**programId:** `Flatfile.ProgramId` — ID of the program
**requestOptions:** `Mapping.RequestOptions`
client.mapping.updateMappingProgram (programId, { ...params }) -> Flatfile.ProgramResponse
#### 📝 Description
Updates a mapping program
#### 🔌 Usage
```typescript
await client.mapping.updateMappingProgram("programId", {
source: {
name: "name",
fields: [
{
type: "string",
key: "key",
},
{
type: "string",
key: "key",
},
],
},
destination: {
name: "name",
fields: [
{
type: "string",
key: "key",
},
{
type: "string",
key: "key",
},
],
},
});
```
#### ⚙️ Parameters
**programId:** `Flatfile.ProgramId` — ID of the program
**request:** `Flatfile.ProgramConfig`
**requestOptions:** `Mapping.RequestOptions`
client.mapping.deleteMappingProgram (programId) -> Flatfile.Success
#### 📝 Description
Deletes a mapping program
#### 🔌 Usage
```typescript
await client.mapping.deleteMappingProgram("programId");
```
#### ⚙️ Parameters
**programId:** `Flatfile.ProgramId` — ID of the program
**requestOptions:** `Mapping.RequestOptions`
client.mapping.createRules (programId, { ...params }) -> Flatfile.MappingRulesResponse
#### 📝 Description
Add mapping rules to a program
#### 🔌 Usage
```typescript
await client.mapping.createRules("programId", [
{
name: "name",
type: "type",
},
{
name: "name",
type: "type",
},
]);
```
#### ⚙️ Parameters
**programId:** `Flatfile.ProgramId` — ID of the program
**request:** `Flatfile.CreateMappingRulesRequest`
**requestOptions:** `Mapping.RequestOptions`
client.mapping.deleteMultipleRules (programId, { ...params }) -> Flatfile.Success
#### 📝 Description
Deletes multiple mapping rules from a program
#### 🔌 Usage
```typescript
await client.mapping.deleteMultipleRules("programId", {
ruleIds: ["ruleIds", "ruleIds"],
});
```
#### ⚙️ Parameters
**programId:** `Flatfile.ProgramId` — ID of the program
**request:** `Flatfile.DeleteMultipleRulesRequest`
**requestOptions:** `Mapping.RequestOptions`
client.mapping.listRules (programId) -> Flatfile.MappingRulesResponse
#### 📝 Description
List all mapping rules in a program
#### 🔌 Usage
```typescript
await client.mapping.listRules("us_mp_YOUR_ID");
```
#### ⚙️ Parameters
**programId:** `Flatfile.ProgramId` — ID of the program
**requestOptions:** `Mapping.RequestOptions`
client.mapping.getRule (programId, mappingId) -> Flatfile.MappingRuleResponse
#### 📝 Description
Get a mapping rule from a program
#### 🔌 Usage
```typescript
await client.mapping.getRule("us_mp_YOUR_ID", "us_mr_YOUR_ID");
```
#### ⚙️ Parameters
**programId:** `Flatfile.ProgramId` — ID of the program
**mappingId:** `Flatfile.MappingId` — ID of mapping rule
**requestOptions:** `Mapping.RequestOptions`
client.mapping.updateRule (programId, mappingId, { ...params }) -> Flatfile.MappingRuleResponse
#### 📝 Description
Updates a mapping rule in a program
#### 🔌 Usage
```typescript
await client.mapping.updateRule("us_mp_YOUR_ID", "us_mr_YOUR_ID", {
name: "Assign mapping rule",
type: "assign",
config: {},
metadata: {},
});
```
#### ⚙️ Parameters
**programId:** `Flatfile.ProgramId` — ID of the program
**mappingId:** `Flatfile.MappingId` — ID of mapping rule
**request:** `Flatfile.MappingRuleConfig`
**requestOptions:** `Mapping.RequestOptions`
client.mapping.updateRules (programId, { ...params }) -> Flatfile.MappingRulesResponse
#### 📝 Description
Updates a list of mapping rules in a program
#### 🔌 Usage
```typescript
await client.mapping.updateRules("programId", [
{
name: "name",
type: "type",
id: "id",
createdAt: "2024-01-15T09:30:00Z",
updatedAt: "2024-01-15T09:30:00Z",
},
{
name: "name",
type: "type",
id: "id",
createdAt: "2024-01-15T09:30:00Z",
updatedAt: "2024-01-15T09:30:00Z",
},
]);
```
#### ⚙️ Parameters
**programId:** `Flatfile.ProgramId` — ID of the program
**request:** `Flatfile.UpdateMappingRulesRequest`
**requestOptions:** `Mapping.RequestOptions`
client.mapping.deleteRule (programId, mappingId) -> Flatfile.Success
#### 📝 Description
Deletes a mapping rule from a program
#### 🔌 Usage
```typescript
await client.mapping.deleteRule("us_mp_YOUR_ID", "us_mr_YOUR_ID");
```
#### ⚙️ Parameters
**programId:** `Flatfile.ProgramId` — ID of the program
**mappingId:** `Flatfile.MappingId` — ID of mapping rule
**requestOptions:** `Mapping.RequestOptions`
client.messages.createMessage (threadId, { ...params }) -> Flatfile.MessageModel
#### 📝 Description
Create a new message in a thread
#### 🔌 Usage
```typescript
await client.messages.createMessage("threadId", {
content: {
content: {
key: "value",
},
},
role: "system",
});
```
#### ⚙️ Parameters
**threadId:** `Flatfile.ThreadId`
**request:** `Flatfile.MessageApiCreateData`
**requestOptions:** `Messages.RequestOptions`
client.messages.getMessages (threadId) -> Flatfile.MessageCollection
#### 📝 Description
Get all messages in a thread
#### 🔌 Usage
```typescript
await client.messages.getMessages("threadId");
```
#### ⚙️ Parameters
**threadId:** `Flatfile.ThreadId`
**requestOptions:** `Messages.RequestOptions`
client.messages.getMessage (threadId, messageId) -> Flatfile.MessageModel
#### 📝 Description
Get a specific message by ID
#### 🔌 Usage
```typescript
await client.messages.getMessage("threadId", "messageId");
```
#### ⚙️ Parameters
**threadId:** `Flatfile.ThreadId`
**messageId:** `Flatfile.MessageId`
**requestOptions:** `Messages.RequestOptions`
client.messages.updateMessage (threadId, messageId, { ...params }) -> Flatfile.MessageModel
#### 📝 Description
Update an existing message
#### 🔌 Usage
```typescript
await client.messages.updateMessage("threadId", "messageId", {});
```
#### ⚙️ Parameters
**threadId:** `Flatfile.ThreadId`
**messageId:** `Flatfile.MessageId`
**request:** `Flatfile.MessageApiUpdateData`
**requestOptions:** `Messages.RequestOptions`
client.messages.deleteMessage (threadId, messageId) -> Flatfile.Success
#### 📝 Description
Delete a message
#### 🔌 Usage
```typescript
await client.messages.deleteMessage("threadId", "messageId");
```
#### ⚙️ Parameters
**threadId:** `Flatfile.ThreadId`
**messageId:** `Flatfile.MessageId`
**requestOptions:** `Messages.RequestOptions`
client.onboardingDatapoints.createOnboardingDatapoint (onboardingId, { ...params }) -> Flatfile.OnboardingDatapointResponse
#### 📝 Description
Create a new onboarding datapoint
#### 🔌 Usage
```typescript
await client.onboardingDatapoints.createOnboardingDatapoint("onboardingId", {
onboardingId: "onboardingId",
data: {
key: "value",
},
});
```
#### ⚙️ Parameters
**onboardingId:** `Flatfile.OnboardingId`
**request:** `Flatfile.OnboardingDatapointCreate`
**requestOptions:** `OnboardingDatapoints.RequestOptions`
client.onboardingDatapoints.getOnboardingDatapoints (onboardingId) -> Flatfile.OnboardingDatapointsResponse
#### 📝 Description
Get all datapoints for an onboarding
#### 🔌 Usage
```typescript
await client.onboardingDatapoints.getOnboardingDatapoints("onboardingId");
```
#### ⚙️ Parameters
**onboardingId:** `Flatfile.OnboardingId`
**requestOptions:** `OnboardingDatapoints.RequestOptions`
client.onboardingDatapoints.getOnboardingDatapoint (onboardingId, datapointId) -> Flatfile.OnboardingDatapointResponse
#### 📝 Description
Get a single onboarding datapoint by ID
#### 🔌 Usage
```typescript
await client.onboardingDatapoints.getOnboardingDatapoint("onboardingId", "datapointId");
```
#### ⚙️ Parameters
**onboardingId:** `Flatfile.OnboardingId`
**datapointId:** `Flatfile.OnboardingDatapointId`
**requestOptions:** `OnboardingDatapoints.RequestOptions`
client.onboardingDatapoints.updateOnboardingDatapoint (onboardingId, datapointId, { ...params }) -> Flatfile.OnboardingDatapointResponse
#### 📝 Description
Update an onboarding datapoint
#### 🔌 Usage
```typescript
await client.onboardingDatapoints.updateOnboardingDatapoint("onboardingId", "datapointId", {});
```
#### ⚙️ Parameters
**onboardingId:** `Flatfile.OnboardingId`
**datapointId:** `Flatfile.OnboardingDatapointId`
**request:** `Flatfile.OnboardingDatapointUpdate`
**requestOptions:** `OnboardingDatapoints.RequestOptions`
client.onboardingDatapoints.deleteOnboardingDatapoint (onboardingId, datapointId) -> Flatfile.Success
#### 📝 Description
Soft delete an onboarding datapoint
#### 🔌 Usage
```typescript
await client.onboardingDatapoints.deleteOnboardingDatapoint("onboardingId", "datapointId");
```
#### ⚙️ Parameters
**onboardingId:** `Flatfile.OnboardingId`
**datapointId:** `Flatfile.OnboardingDatapointId`
**requestOptions:** `OnboardingDatapoints.RequestOptions`
client.onboardings.createOnboarding ({ ...params }) -> Flatfile.OnboardingResponse
#### 📝 Description
Create a new onboarding
#### 🔌 Usage
```typescript
await client.onboardings.createOnboarding({
userId: "userId",
});
```
#### ⚙️ Parameters
**request:** `Flatfile.OnboardingCreate`
**requestOptions:** `Onboardings.RequestOptions`
client.onboardings.getOnboardings ({ ...params }) -> Flatfile.OnboardingsResponse
#### 📝 Description
Get onboardings with optional filtering by user ID
#### 🔌 Usage
```typescript
await client.onboardings.getOnboardings();
```
#### ⚙️ Parameters
**request:** `Flatfile.GetOnboardingsRequest`
**requestOptions:** `Onboardings.RequestOptions`
client.onboardings.getOnboarding (onboardingId) -> Flatfile.OnboardingResponse
#### 📝 Description
Get a single onboarding by ID
#### 🔌 Usage
```typescript
await client.onboardings.getOnboarding("onboardingId");
```
#### ⚙️ Parameters
**onboardingId:** `Flatfile.OnboardingId`
**requestOptions:** `Onboardings.RequestOptions`
client.onboardings.deleteOnboarding (onboardingId) -> Flatfile.Success
#### 📝 Description
Soft delete an onboarding
#### 🔌 Usage
```typescript
await client.onboardings.deleteOnboarding("onboardingId");
```
#### ⚙️ Parameters
**onboardingId:** `Flatfile.OnboardingId`
**requestOptions:** `Onboardings.RequestOptions`
client.onboardings.updateOnboardingProgress (onboardingId, { ...params }) -> Flatfile.OnboardingResponse
#### 📝 Description
Update onboarding progress
#### 🔌 Usage
```typescript
await client.onboardings.updateOnboardingProgress("onboardingId", {
currentStep: 1,
});
```
#### ⚙️ Parameters
**onboardingId:** `Flatfile.OnboardingId`
**request:** `Flatfile.OnboardingProgressUpdate`
**requestOptions:** `Onboardings.RequestOptions`
client.onboardings.getOnboardingStatus (onboardingId) -> Flatfile.OnboardingResponse
#### 📝 Description
Get onboarding status
#### 🔌 Usage
```typescript
await client.onboardings.getOnboardingStatus("onboardingId");
```
#### ⚙️ Parameters
**onboardingId:** `Flatfile.OnboardingId`
**requestOptions:** `Onboardings.RequestOptions`
client.records.get (sheetId, { ...params }) -> Flatfile.GetRecordsResponse
#### 📝 Description
Returns records from a sheet in a workbook
#### 🔌 Usage
```typescript
await client.records.get("us_sh_YOUR_ID");
```
#### ⚙️ Parameters
**sheetId:** `Flatfile.SheetId` — ID of sheet
**request:** `Flatfile.GetRecordsRequest`
**requestOptions:** `Records.RequestOptions`
client.records.indices (sheetId, { ...params }) -> Flatfile.GetRecordIndicesResponse
#### 📝 Description
Returns indices of records from a sheet in a workbook
#### 🔌 Usage
```typescript
await client.records.indices("us_sh_YOUR_ID", {
ids: "list<$commons.RecordId.Example0, $commons.RecordId.Example1>",
});
```
#### ⚙️ Parameters
**sheetId:** `Flatfile.SheetId` — ID of sheet
**request:** `Flatfile.GetRecordIndicesRequest`
**requestOptions:** `Records.RequestOptions`
client.records.update (sheetId, { ...params }) -> Flatfile.VersionResponse
#### 📝 Description
Updates existing records in a workbook sheet
#### 🔌 Usage
```typescript
await client.records.update("us_sh_YOUR_ID", [
{
id: "us_rc_YOUR_ID",
versionId: "us_vr_YOUR_ID",
commitId: "us_vr_YOUR_ID",
values: {
firstName: {
value: "John",
messages: [],
valid: true,
},
lastName: {
value: "Smith",
messages: [],
valid: true,
},
email: {
value: "john.smith@example.com",
messages: [],
valid: true,
},
},
valid: true,
metadata: {},
config: {},
},
]);
```
#### ⚙️ Parameters
**sheetId:** `Flatfile.SheetId` — ID of sheet
**request:** `Flatfile.Records`
**requestOptions:** `Records.RequestOptions`
client.records.insert (sheetId, { ...params }) -> Flatfile.RecordsResponse
#### 📝 Description
Adds records to a workbook sheet
#### 🔌 Usage
```typescript
await client.records.insert("us_sh_YOUR_ID", [
{
firstName: {
value: "John",
messages: [],
valid: true,
},
lastName: {
value: "Smith",
messages: [],
valid: true,
},
email: {
value: "john.smith@example.com",
messages: [],
valid: true,
},
},
]);
```
#### ⚙️ Parameters
**sheetId:** `Flatfile.SheetId` — ID of sheet
**request:** `Flatfile.RecordData[]`
**requestOptions:** `Records.RequestOptions`
client.records.delete (sheetId, { ...params }) -> Flatfile.Success
#### 📝 Description
Deletes records from a workbook sheet
#### 🔌 Usage
```typescript
await client.records.delete("us_sh_YOUR_ID", {
ids: "us_rc_YOUR_ID",
});
```
#### ⚙️ Parameters
**sheetId:** `Flatfile.SheetId` — ID of sheet
**request:** `Flatfile.DeleteRecordsRequest`
**requestOptions:** `Records.RequestOptions`
client.records.findAndReplace (sheetId, { ...params }) -> Flatfile.VersionResponse
#### 📝 Description
Searches for all values that match the 'find' value (globally or for a specific field via 'fieldKey') and replaces them with the 'replace' value. Wrap 'find' value in double quotes for exact match (""). Returns a commitId for the updated records
#### 🔌 Usage
```typescript
await client.records.findAndReplace("us_sh_YOUR_ID", {
fieldKey: "email",
});
```
#### ⚙️ Parameters
**sheetId:** `Flatfile.SheetId` — ID of sheet
**request:** `Flatfile.FindAndReplaceRecordRequest`
**requestOptions:** `Records.RequestOptions`
client.records.bulkUpdate (sheetId, { ...params }) -> Flatfile.VersionResponse
#### 📝 Description
Updates multiple records at once with the same field values based on filter criteria. This is similar to a SQL UPDATE statement where you can update specific fields for all records matching certain conditions.
#### 🔌 Usage
```typescript
await client.records.bulkUpdate("us_sh_YOUR_ID", {
fieldUpdates: {
status: {
value: "completed",
},
processedAt: {
value: "2023-11-20T16:59:40.286Z",
},
},
});
```
#### ⚙️ Parameters
**sheetId:** `Flatfile.SheetId` — ID of sheet
**request:** `Flatfile.BulkUpdateRecordRequest`
**requestOptions:** `Records.RequestOptions`
client.roles.list () -> Flatfile.ListRolesResponse
#### 📝 Description
List all roles for an account
#### 🔌 Usage
```typescript
await client.roles.list();
```
#### ⚙️ Parameters
**requestOptions:** `Roles.RequestOptions`
client.routines.list ({ ...params }) -> Flatfile.RoutinesResponse
#### 📝 Description
Returns a list of routines
#### 🔌 Usage
```typescript
await client.routines.list({
runbookId: "us_rb_YOUR_ID",
});
```
#### ⚙️ Parameters
**request:** `Flatfile.ListRoutinesRequest`
**requestOptions:** `Routines.RequestOptions`
client.routines.get (routineId) -> Flatfile.RoutineResponse
#### 📝 Description
Returns a routine
#### 🔌 Usage
```typescript
await client.routines.get("us_rtn_YOUR_ID");
```
#### ⚙️ Parameters
**routineId:** `Flatfile.RoutineId`
**requestOptions:** `Routines.RequestOptions`
client.routines.create ({ ...params }) -> Flatfile.RoutineResponse
#### 📝 Description
Creates a new routine
#### 🔌 Usage
```typescript
await client.routines.create({
runbookId: "us_rb_YOUR_ID",
name: "Split Address to Street, City, State, Zip",
config: {
sourceSheetId: "us_sh_YOUR_ID",
destinationSheetId: "us_sh_YOUR_ID",
programId: "us_mp_YOUR_ID",
},
ordinal: 1,
type: "JOB",
});
```
#### ⚙️ Parameters
**request:** `Flatfile.CreateRoutineRequest`
**requestOptions:** `Routines.RequestOptions`
client.routines.update (routineId, { ...params }) -> Flatfile.RoutineResponse
#### 📝 Description
Updates a routine
#### 🔌 Usage
```typescript
await client.routines.update("us_rtn_YOUR_ID", {
name: "Split Address to Street, City, State, Zip",
config: {
sourceSheetId: "us_sh_YOUR_ID",
destinationSheetId: "us_sh_YOUR_ID",
programId: "us_mp_YOUR_ID",
},
ordinal: 1,
type: "JOB",
});
```
#### ⚙️ Parameters
**routineId:** `Flatfile.RoutineId`
**request:** `Flatfile.UpdateRoutineRequest`
**requestOptions:** `Routines.RequestOptions`
client.routines.delete (routineId) -> Flatfile.Success
#### 📝 Description
Deletes a routine
#### 🔌 Usage
```typescript
await client.routines.delete("us_rtn_YOUR_ID");
```
#### ⚙️ Parameters
**routineId:** `Flatfile.RoutineId`
**requestOptions:** `Routines.RequestOptions`
client.runbooks.list ({ ...params }) -> Flatfile.RunbooksResponse
#### 📝 Description
Returns a list of runbooks
#### 🔌 Usage
```typescript
await client.runbooks.list();
```
#### ⚙️ Parameters
**request:** `Flatfile.ListRunbooksRequest`
**requestOptions:** `Runbooks.RequestOptions`
client.runbooks.get (runbookId) -> Flatfile.RunbookResponse
#### 📝 Description
Returns a runbook
#### 🔌 Usage
```typescript
await client.runbooks.get("us_rb_YOUR_ID");
```
#### ⚙️ Parameters
**runbookId:** `Flatfile.RunbookId`
**requestOptions:** `Runbooks.RequestOptions`
client.runbooks.create ({ ...params }) -> Flatfile.RunbookResponse
#### 📝 Description
Creates a new runbook
#### 🔌 Usage
```typescript
await client.runbooks.create({
accountId: "us_acc_YOUR_ID",
appId: "us_app_YOUR_ID",
environmentId: "us_env_YOUR_ID",
spaceId: "us_sp_YOUR_ID",
name: "Runbook For Vendor X",
config: {
sourceSheetIds: ["us_sh_YOUR_ID"],
destinationSheetIds: ["us_sh_YOUR_ID"],
},
status: "CREATED",
type: "PREPROCESSING",
});
```
#### ⚙️ Parameters
**request:** `Flatfile.CreateRunbookRequest`
**requestOptions:** `Runbooks.RequestOptions`
client.runbooks.update (runbookId, { ...params }) -> Flatfile.RunbookResponse
#### 📝 Description
Updates a runbook
#### 🔌 Usage
```typescript
await client.runbooks.update("us_rb_YOUR_ID", {
name: "Runbook For Vendor X",
});
```
#### ⚙️ Parameters
**runbookId:** `Flatfile.RunbookId`
**request:** `Flatfile.UpdateRunbookRequest`
**requestOptions:** `Runbooks.RequestOptions`
client.runbooks.delete (runbookId) -> Flatfile.Success
#### 📝 Description
Deletes a runbook
#### 🔌 Usage
```typescript
await client.runbooks.delete("us_rb_YOUR_ID");
```
#### ⚙️ Parameters
**runbookId:** `Flatfile.RunbookId`
**requestOptions:** `Runbooks.RequestOptions`
client.secrets.list ({ ...params }) -> Flatfile.SecretsResponse
#### 📝 Description
Fetch all secrets for a given environmentId and optionally apply space overrides
#### 🔌 Usage
```typescript
await client.secrets.list({
environmentId: "us_env_YOUR_ID",
});
```
#### ⚙️ Parameters
**request:** `Flatfile.ListSecrets`
**requestOptions:** `Secrets.RequestOptions`
client.secrets.upsert ({ ...params }) -> Flatfile.SecretsResponse
#### 📝 Description
Insert or Update a Secret by name for environment or space
#### 🔌 Usage
```typescript
await client.secrets.upsert({
name: "My Secret",
value: "Sup3r$ecret\\/alue!",
environmentId: "us_env_YOUR_ID",
spaceId: "us_sp_YOUR_ID",
actorId: "us_usr_YOUR_ID",
});
```
#### ⚙️ Parameters
**request:** `Flatfile.WriteSecret`
**requestOptions:** `Secrets.RequestOptions`
client.secrets.delete (secretId) -> Flatfile.SecretsResponse
#### 📝 Description
Deletes a specific Secret from the Environment or Space as is the case
#### 🔌 Usage
```typescript
await client.secrets.delete("us_sec_YOUR_ID");
```
#### ⚙️ Parameters
**secretId:** `Flatfile.SecretId` — The ID of the secret.
**requestOptions:** `Secrets.RequestOptions`
client.sheets.list ({ ...params }) -> Flatfile.ListSheetsResponse
#### 📝 Description
Returns sheets in a workbook
#### 🔌 Usage
```typescript
await client.sheets.list({
workbookId: "us_wb_YOUR_ID",
});
```
#### ⚙️ Parameters
**request:** `Flatfile.ListSheetsRequest`
**requestOptions:** `Sheets.RequestOptions`
client.sheets.get (sheetId) -> Flatfile.SheetResponse
#### 📝 Description
Returns a sheet in a workbook
#### 🔌 Usage
```typescript
await client.sheets.get("us_sh_YOUR_ID");
```
#### ⚙️ Parameters
**sheetId:** `Flatfile.SheetId` — ID of sheet
**requestOptions:** `Sheets.RequestOptions`
client.sheets.delete (sheetId) -> Flatfile.Success
#### 📝 Description
Deletes a specific sheet from a workbook
#### 🔌 Usage
```typescript
await client.sheets.delete("us_sh_YOUR_ID");
```
#### ⚙️ Parameters
**sheetId:** `Flatfile.SheetId` — ID of sheet
**requestOptions:** `Sheets.RequestOptions`
client.sheets.duplicateSheet (sheetId, { ...params }) -> Flatfile.SheetResponse
#### 📝 Description
Creates a copy of a sheet including all its data within the same workbook
#### 🔌 Usage
```typescript
await client.sheets.duplicateSheet("us_sh_YOUR_ID", {
name: "Copy of Contacts",
slug: "contacts-copy",
});
```
#### ⚙️ Parameters
**sheetId:** `Flatfile.SheetId` — ID of sheet to duplicate
**request:** `Flatfile.DuplicateSheetRequest`
**requestOptions:** `Sheets.RequestOptions`
client.sheets.validate (sheetId) -> Flatfile.Success
#### 📝 Description
Trigger data hooks and validation to run on a sheet
#### 🔌 Usage
```typescript
await client.sheets.validate("us_sh_YOUR_ID");
```
#### ⚙️ Parameters
**sheetId:** `Flatfile.SheetId` — ID of sheet
**requestOptions:** `Sheets.RequestOptions`
client.sheets.getRecordCounts (sheetId, { ...params }) -> Flatfile.RecordCountsResponse
#### 📝 Description
Returns counts of records from a sheet
#### 🔌 Usage
```typescript
await client.sheets.getRecordCounts("us_sh_YOUR_ID", {
versionId: "us_vr_YOUR_ID",
});
```
#### ⚙️ Parameters
**sheetId:** `Flatfile.SheetId` — ID of sheet
**request:** `Flatfile.GetRecordCountsRequest`
**requestOptions:** `Sheets.RequestOptions`
client.sheets.getCalculations (sheetId, { ...params }) -> Flatfile.ListCalculationsResponse
#### 📝 Description
Returns all calculations for a sheet
#### 🔌 Usage
```typescript
await client.sheets.getCalculations("sheetId");
```
#### ⚙️ Parameters
**sheetId:** `Flatfile.SheetId` — ID of sheet
**request:** `Flatfile.GetCalculationsRequest`
**requestOptions:** `Sheets.RequestOptions`
client.sheets.addField (sheetId, { ...params }) -> Flatfile.FieldConfigResponse
#### 📝 Description
Adds a new field to a sheet
#### 🔌 Usage
```typescript
await client.sheets.addField("sheetId", {
body: {
type: "string",
key: "key",
},
});
```
#### ⚙️ Parameters
**sheetId:** `Flatfile.SheetId` — ID of sheet
**request:** `Flatfile.CreateFieldRequest`
**requestOptions:** `Sheets.RequestOptions`
client.sheets.removeField (sheetId, fieldKey) -> Flatfile.Success
#### 📝 Description
Removes field from a sheet
#### 🔌 Usage
```typescript
await client.sheets.removeField("sheetId", "fieldKey");
```
#### ⚙️ Parameters
**sheetId:** `Flatfile.SheetId` — ID of sheet
**fieldKey:** `string` — Unique field key
**requestOptions:** `Sheets.RequestOptions`
client.sheets.getSheetCommits (sheetId, { ...params }) -> Flatfile.ListCommitsResponse
#### 📝 Description
Returns the commit versions for a sheet
#### 🔌 Usage
```typescript
await client.sheets.getSheetCommits("us_sh_YOUR_ID");
```
#### ⚙️ Parameters
**sheetId:** `Flatfile.SheetId` — ID of sheet
**request:** `Flatfile.ListSheetCommitsRequest`
**requestOptions:** `Sheets.RequestOptions`
client.sheets.lockSheet (sheetId) -> Flatfile.Success
#### 📝 Description
Locks a sheet
#### 🔌 Usage
```typescript
await client.sheets.lockSheet("us_sh_YOUR_ID");
```
#### ⚙️ Parameters
**sheetId:** `Flatfile.SheetId` — ID of sheet
**requestOptions:** `Sheets.RequestOptions`
client.sheets.unlockSheet (sheetId) -> Flatfile.Success
#### 📝 Description
Removes a lock from a sheet
#### 🔌 Usage
```typescript
await client.sheets.unlockSheet("us_sh_YOUR_ID");
```
#### ⚙️ Parameters
**sheetId:** `Flatfile.SheetId` — ID of sheet
**requestOptions:** `Sheets.RequestOptions`
client.sheets.getCellValues (sheetId, { ...params }) -> Flatfile.CellsResponse
#### 📝 Description
Returns record cell values grouped by all fields in the sheet
#### 🔌 Usage
```typescript
await client.sheets.getCellValues("us_sh_YOUR_ID", {
distinct: true,
fieldKey: "firstName",
sortField: "firstName",
sortDirection: "asc",
filter: "valid",
});
```
#### ⚙️ Parameters
**sheetId:** `Flatfile.SheetId` — ID of sheet
**request:** `Flatfile.GetFieldValuesRequest`
**requestOptions:** `Sheets.RequestOptions`
client.sheets.updateSheet (sheetId, { ...params }) -> Flatfile.SheetResponse
#### 📝 Description
Updates Sheet
#### 🔌 Usage
```typescript
await client.sheets.updateSheet("us_sh_YOUR_ID", {
name: "New Sheet Name",
metadata: {
rowHeaders: [6],
},
});
```
#### ⚙️ Parameters
**sheetId:** `Flatfile.SheetId` — ID of sheet
**request:** `Flatfile.SheetUpdateRequest`
**requestOptions:** `Sheets.RequestOptions`
client.snapshots.createSnapshot ({ ...params }) -> Flatfile.SnapshotResponse
#### 📝 Description
Creates a snapshot of a sheet
#### 🔌 Usage
```typescript
await client.snapshots.createSnapshot({
sheetId: "us_sh_YOUR_ID",
label: "My snapshot",
});
```
#### ⚙️ Parameters
**request:** `Flatfile.CreateSnapshotRequest`
**requestOptions:** `Snapshots.RequestOptions`
client.snapshots.listSnapshots ({ ...params }) -> Flatfile.SnapshotsResponse
#### 📝 Description
List all snapshots of a sheet
#### 🔌 Usage
```typescript
await client.snapshots.listSnapshots({
sheetId: "us_sh_YOUR_ID",
});
```
#### ⚙️ Parameters
**request:** `Flatfile.ListSnapshotRequest`
**requestOptions:** `Snapshots.RequestOptions`
client.snapshots.getSnapshot (snapshotId, { ...params }) -> Flatfile.SnapshotResponse
#### 📝 Description
Gets a snapshot of a sheet
#### 🔌 Usage
```typescript
await client.snapshots.getSnapshot("us_ss_YOUR_ID", {
includeSummary: true,
});
```
#### ⚙️ Parameters
**snapshotId:** `Flatfile.SnapshotId` — ID of snapshot
**request:** `Flatfile.GetSnapshotRequest`
**requestOptions:** `Snapshots.RequestOptions`
client.snapshots.deleteSnapshot (snapshotId) -> Flatfile.Success
#### 📝 Description
Deletes a snapshot of a sheet
#### 🔌 Usage
```typescript
await client.snapshots.deleteSnapshot("us_ss_YOUR_ID");
```
#### ⚙️ Parameters
**snapshotId:** `Flatfile.SnapshotId` — ID of snapshot
**requestOptions:** `Snapshots.RequestOptions`
client.snapshots.restoreSnapshot (snapshotId, { ...params }) -> Flatfile.SnapshotResponse
#### 📝 Description
Restores a snapshot of a sheet
#### 🔌 Usage
```typescript
await client.snapshots.restoreSnapshot("us_ss_YOUR_ID", {
created: true,
updated: true,
deleted: true,
});
```
#### ⚙️ Parameters
**snapshotId:** `Flatfile.SnapshotId` — ID of snapshot
**request:** `Flatfile.RestoreOptions`
**requestOptions:** `Snapshots.RequestOptions`
client.snapshots.getSnapshotRecords (snapshotId, { ...params }) -> Flatfile.DiffRecordsResponse
#### 📝 Description
Gets records from a snapshot of a sheet
#### 🔌 Usage
```typescript
await client.snapshots.getSnapshotRecords("us_ss_YOUR_ID", {
pageSize: 10,
pageNumber: 1,
changeType: "createdSince",
});
```
#### ⚙️ Parameters
**snapshotId:** `Flatfile.SnapshotId` — ID of snapshot
**request:** `Flatfile.GetSnapshotRecordsRequest`
**requestOptions:** `Snapshots.RequestOptions`
client.spaces.list ({ ...params }) -> Flatfile.ListSpacesResponse
#### 📝 Description
Returns all spaces for an account or environment
#### 🔌 Usage
```typescript
await client.spaces.list({
environmentId: "us_env_YOUR_ID",
});
```
#### ⚙️ Parameters
**request:** `Flatfile.ListSpacesRequest`
**requestOptions:** `Spaces.RequestOptions`
client.spaces.create ({ ...params }) -> Flatfile.SpaceResponse
#### 📝 Description
Creates a new space based on an existing Space Config
#### 🔌 Usage
```typescript
await client.spaces.create({
name: "My First Workbook",
displayOrder: 1,
environmentId: "us_env_YOUR_ID",
primaryWorkbookId: "us_wb_YOUR_ID",
});
```
#### ⚙️ Parameters
**request:** `Flatfile.SpaceConfig`
**requestOptions:** `Spaces.RequestOptions`
client.spaces.get (spaceId) -> Flatfile.SpaceResponse
#### 📝 Description
Returns a single space
#### 🔌 Usage
```typescript
await client.spaces.get("us_sp_YOUR_ID");
```
#### ⚙️ Parameters
**spaceId:** `Flatfile.SpaceId` — ID of space to return
**requestOptions:** `Spaces.RequestOptions`
client.spaces.delete (spaceId) -> Flatfile.Success
#### 📝 Description
Delete a space
#### 🔌 Usage
```typescript
await client.spaces.delete("us_sp_YOUR_ID");
```
#### ⚙️ Parameters
**spaceId:** `Flatfile.SpaceId` — ID of space to delete
**requestOptions:** `Spaces.RequestOptions`
client.spaces.bulkDelete ({ ...params }) -> Flatfile.Success
#### 📝 Description
Delete multiple spaces by id
#### 🔌 Usage
```typescript
await client.spaces.bulkDelete({
spaceIds: "us_sp_YOUR_ID",
});
```
#### ⚙️ Parameters
**request:** `Flatfile.DeleteSpacesRequest`
**requestOptions:** `Spaces.RequestOptions`
client.spaces.update (spaceId, { ...params }) -> Flatfile.SpaceResponse
#### 📝 Description
Update a space, to change the name for example
#### 🔌 Usage
```typescript
await client.spaces.update("us_sp_YOUR_ID", {
name: "My Updated Worbook",
});
```
#### ⚙️ Parameters
**spaceId:** `Flatfile.SpaceId` — ID of space to update
**request:** `Flatfile.SpaceConfig`
**requestOptions:** `Spaces.RequestOptions`
client.spaces.archiveSpace (spaceId) -> Flatfile.Success
#### 📝 Description
Sets archivedAt timestamp on a space
#### 🔌 Usage
```typescript
await client.spaces.archiveSpace("us_sp_YOUR_ID");
```
#### ⚙️ Parameters
**spaceId:** `Flatfile.SpaceId` — ID of space to archive
**requestOptions:** `Spaces.RequestOptions`
client.spaces.unarchiveSpace (spaceId) -> Flatfile.Success
#### 📝 Description
Sets archivedAt timestamp on a space to null
#### 🔌 Usage
```typescript
await client.spaces.unarchiveSpace("us_sp_YOUR_ID");
```
#### ⚙️ Parameters
**spaceId:** `Flatfile.SpaceId` — ID of space to unarchive
**requestOptions:** `Spaces.RequestOptions`
client.spaces.upgrade (spaceId, { ...params }) -> Flatfile.SpaceResponse
#### 🔌 Usage
```typescript
await client.spaces.upgrade("spaceId", {
id: "id",
});
```
#### ⚙️ Parameters
**spaceId:** `Flatfile.SpaceId` — ID of space to update
**request:** `Flatfile.UpgradeSpaceConfig`
**requestOptions:** `Spaces.RequestOptions`
client.spaces.createGuidance (spaceId, { ...params }) -> Flatfile.GuidanceResource
#### 📝 Description
Creates a new guidance
#### 🔌 Usage
```typescript
await client.spaces.createGuidance("us_sp_YOUR_ID", {
guideSlug: "getting-started",
options: {
target: "getting-started",
trigger: "first",
type: "sidebar",
role: "admin",
},
});
```
#### ⚙️ Parameters
**spaceId:** `Flatfile.SpaceId` — ID of the space
**request:** `Flatfile.GuidanceApiCreateData`
**requestOptions:** `Spaces.RequestOptions`
client.spaces.listGuidance (spaceId, { ...params }) -> Flatfile.GuidanceListResponse
#### 📝 Description
Lists guidances
#### 🔌 Usage
```typescript
await client.spaces.listGuidance("us_sp_YOUR_ID", {
includeGuide: true,
});
```
#### ⚙️ Parameters
**spaceId:** `Flatfile.SpaceId` — ID of the space
**request:** `Flatfile.ListGuidanceRequest`
**requestOptions:** `Spaces.RequestOptions`
client.spaces.getGuidance (spaceId, guidanceId, { ...params }) -> Flatfile.GuidanceResource
#### 📝 Description
Retrieves a guidance by its id
#### 🔌 Usage
```typescript
await client.spaces.getGuidance("us_sp_YOUR_ID", "us_gd_YOUR_ID", {
includeGuide: true,
});
```
#### ⚙️ Parameters
**spaceId:** `Flatfile.SpaceId` — ID of the space
**guidanceId:** `Flatfile.GuidanceId` — ID of the guidance
**request:** `Flatfile.GetGuidanceRequest`
**requestOptions:** `Spaces.RequestOptions`
client.spaces.updateGuidance (spaceId, guidanceId, { ...params }) -> Flatfile.GuidanceResource
#### 📝 Description
Updates a guidance with the given id
#### 🔌 Usage
```typescript
await client.spaces.updateGuidance("us_sp_YOUR_ID", "us_gd_YOUR_ID", {
options: {
target: "getting-started",
trigger: "first",
type: "sidebar",
role: "admin",
},
});
```
#### ⚙️ Parameters
**spaceId:** `Flatfile.SpaceId` — ID of the space
**guidanceId:** `Flatfile.GuidanceId` — ID of the guidance
**request:** `Flatfile.GuidanceApiUpdateData`
**requestOptions:** `Spaces.RequestOptions`
client.spaces.deleteGuidance (spaceId, guidanceId) -> Flatfile.Success
#### 📝 Description
Deletes a guidance by its id
#### 🔌 Usage
```typescript
await client.spaces.deleteGuidance("us_sp_YOUR_ID", "us_gd_YOUR_ID");
```
#### ⚙️ Parameters
**spaceId:** `Flatfile.SpaceId` — ID of the space
**guidanceId:** `Flatfile.GuidanceId` — ID of the guidance
**requestOptions:** `Spaces.RequestOptions`
client.spaces.createDraft (spaceId) -> Flatfile.SpaceDraftResponse
#### 📝 Description
Creates a draft of a space
#### 🔌 Usage
```typescript
await client.spaces.createDraft("spaceId");
```
#### ⚙️ Parameters
**spaceId:** `Flatfile.SpaceId` — ID of space to create draft of
**requestOptions:** `Spaces.RequestOptions`
client.spaces.listSpaceDrafts (spaceId) -> Flatfile.SpaceDraftListResponse
#### 📝 Description
Lists drafts for a space
#### 🔌 Usage
```typescript
await client.spaces.listSpaceDrafts("spaceId");
```
#### ⚙️ Parameters
**spaceId:** `Flatfile.SpaceId` — ID of space to list drafts for
**requestOptions:** `Spaces.RequestOptions`
client.spaces.getSpaceDraft (spaceId, draftSpaceId) -> Flatfile.SpaceDraftMergeOperationsResponse
#### 📝 Description
Gets a draft by the space id and draft space id
#### 🔌 Usage
```typescript
await client.spaces.getSpaceDraft("spaceId", "draftSpaceId");
```
#### ⚙️ Parameters
**spaceId:** `Flatfile.SpaceId` — ID of space to get draft for
**draftSpaceId:** `Flatfile.SpaceId` — ID of draft space to get
**requestOptions:** `Spaces.RequestOptions`
client.spaces.mergeDraft (spaceId, draftSpaceId) -> Flatfile.Success
#### 📝 Description
Merges a draft into a space
#### 🔌 Usage
```typescript
await client.spaces.mergeDraft("spaceId", "draftSpaceId");
```
#### ⚙️ Parameters
**spaceId:** `Flatfile.SpaceId` — ID of space to merge draft into
**draftSpaceId:** `Flatfile.SpaceId` — ID of draft space to merge
**requestOptions:** `Spaces.RequestOptions`
client.threads.createThread ({ ...params }) -> Flatfile.ThreadResponse
#### 📝 Description
Create a new thread
#### 🔌 Usage
```typescript
await client.threads.createThread({
resourceId: "resourceId",
status: "ready",
});
```
#### ⚙️ Parameters
**request:** `Flatfile.ThreadApiCreateData`
**requestOptions:** `Threads.RequestOptions`
client.threads.getThreads ({ ...params }) -> Flatfile.ThreadCollection
#### 📝 Description
Get threads with optional filtering by resource
#### 🔌 Usage
```typescript
await client.threads.getThreads();
```
#### ⚙️ Parameters
**request:** `Flatfile.GetThreadsRequest`
**requestOptions:** `Threads.RequestOptions`
client.threads.getThread (threadId) -> Flatfile.ThreadResponse
#### 📝 Description
Get a specific thread by ID
#### 🔌 Usage
```typescript
await client.threads.getThread("threadId");
```
#### ⚙️ Parameters
**threadId:** `Flatfile.ThreadId`
**requestOptions:** `Threads.RequestOptions`
client.threads.updateThread (threadId, { ...params }) -> Flatfile.ThreadResponse
#### 📝 Description
Update a thread
#### 🔌 Usage
```typescript
await client.threads.updateThread("threadId", {});
```
#### ⚙️ Parameters
**threadId:** `Flatfile.ThreadId`
**request:** `Flatfile.ThreadApiUpdateData`
**requestOptions:** `Threads.RequestOptions`
client.threads.deleteThread (threadId) -> Flatfile.Success
#### 📝 Description
Soft delete a thread
#### 🔌 Usage
```typescript
await client.threads.deleteThread("threadId");
```
#### ⚙️ Parameters
**threadId:** `Flatfile.ThreadId`
**requestOptions:** `Threads.RequestOptions`
client.transformations.list ({ ...params }) -> Flatfile.TransformationsResponse
#### 🔌 Usage
```typescript
await client.transformations.list({
appId: "appId",
matchKeys: ["matchKeys", "matchKeys"],
});
```
#### ⚙️ Parameters
**request:** `Flatfile.ListTransformationsRequest`
**requestOptions:** `Transformations.RequestOptions`
client.transformations.create ({ ...params }) -> Flatfile.TransformationResponse
#### 🔌 Usage
```typescript
await client.transformations.create({
accountId: "accountId",
environmentId: "environmentId",
spaceId: "spaceId",
appId: "appId",
sheetId: "sheetId",
keys: ["keys", "keys"],
sourceKeys: ["sourceKeys", "sourceKeys"],
destinationKeys: ["destinationKeys", "destinationKeys"],
mutationCommand: "mutationCommand",
config: {
key: "value",
},
type: "type",
});
```
#### ⚙️ Parameters
**request:** `Flatfile.TransformationCreateDto`
**requestOptions:** `Transformations.RequestOptions`
client.transformations.update (transformationId, { ...params }) -> Flatfile.TransformationResponse
#### 🔌 Usage
```typescript
await client.transformations.update("transformationId", {
accountId: "accountId",
environmentId: "environmentId",
spaceId: "spaceId",
appId: "appId",
sheetId: "sheetId",
keys: ["keys", "keys"],
sourceKeys: ["sourceKeys", "sourceKeys"],
destinationKeys: ["destinationKeys", "destinationKeys"],
mutationCommand: "mutationCommand",
config: {
key: "value",
},
type: "type",
});
```
#### ⚙️ Parameters
**transformationId:** `Flatfile.TransformationId` — The id of the transformation to update
**request:** `Flatfile.TransformationCreateDto`
**requestOptions:** `Transformations.RequestOptions`
client.transformations.delete (transformationId) -> Flatfile.Success
#### 🔌 Usage
```typescript
await client.transformations.delete("transformationId");
```
#### ⚙️ Parameters
**transformationId:** `Flatfile.TransformationId` — The id of the transformation to delete
**requestOptions:** `Transformations.RequestOptions`
client.users.list ({ ...params }) -> Flatfile.ListUsersResponse
#### 📝 Description
Gets a list of users
#### 🔌 Usage
```typescript
await client.users.list({
email: "john.smith@example.com",
});
```
#### ⚙️ Parameters
**request:** `Flatfile.ListUsersRequest`
**requestOptions:** `Users.RequestOptions`
client.users.createAndInvite ({ ...params }) -> Flatfile.UserWithRolesResponse
#### 📝 Description
Creates and invites a new user to your account.
#### 🔌 Usage
```typescript
await client.users.createAndInvite({
email: "john.smith@example.com",
name: "John Smith",
actorRoles: [
{
roleId: "us_rol_YOUR_ID",
resourceId: "us_acc_YOUR_ID",
},
{
roleId: "us_rol_YOUR_ID",
resourceId: "us_env_YOUR_ID",
},
],
});
```
#### ⚙️ Parameters
**request:** `Flatfile.UserCreateAndInviteRequest`
**requestOptions:** `Users.RequestOptions`
client.users.resendInvite (userId) -> Flatfile.Success
#### 📝 Description
Resends an invite to a user for your account.
#### 🔌 Usage
```typescript
await client.users.resendInvite("userId");
```
#### ⚙️ Parameters
**userId:** `Flatfile.UserId` — The user id
**requestOptions:** `Users.RequestOptions`
client.users.update (userId, { ...params }) -> Flatfile.UserResponse
#### 📝 Description
Updates a user
#### 🔌 Usage
```typescript
await client.users.update("userId");
```
#### ⚙️ Parameters
**userId:** `Flatfile.UserId` — The user id
**request:** `Flatfile.UpdateUserRequest`
**requestOptions:** `Users.RequestOptions`
client.users.get (userId) -> Flatfile.UserResponse
#### 📝 Description
Gets a user
#### 🔌 Usage
```typescript
await client.users.get("us_usr_YOUR_ID");
```
#### ⚙️ Parameters
**userId:** `Flatfile.UserId` — The user id
**requestOptions:** `Users.RequestOptions`
client.users.delete (userId) -> Flatfile.Success
#### 📝 Description
Deletes a user
#### 🔌 Usage
```typescript
await client.users.delete("userId");
```
#### ⚙️ Parameters
**userId:** `Flatfile.UserId` — The user id
**requestOptions:** `Users.RequestOptions`
client.users.listUserRoles (userId) -> Flatfile.ListActorRolesResponse
#### 📝 Description
Lists roles assigned to a user.
#### 🔌 Usage
```typescript
await client.users.listUserRoles("userId");
```
#### ⚙️ Parameters
**userId:** `Flatfile.UserId` — The user id
**requestOptions:** `Users.RequestOptions`
client.users.assignUserRole (userId, { ...params }) -> Flatfile.AssignRoleResponse
#### 📝 Description
Assigns a role to a user.
#### 🔌 Usage
```typescript
await client.users.assignUserRole("userId", {
roleId: "roleId",
resourceId: "resourceId",
});
```
#### ⚙️ Parameters
**userId:** `Flatfile.UserId` — The user id
**request:** `Flatfile.AssignActorRoleRequest`
**requestOptions:** `Users.RequestOptions`
client.users.deleteUserRole (userId, actorRoleId) -> Flatfile.Success
#### 📝 Description
Removes a role from a user.
#### 🔌 Usage
```typescript
await client.users.deleteUserRole("userId", "actorRoleId");
```
#### ⚙️ Parameters
**userId:** `Flatfile.UserId` — The user id
**actorRoleId:** `Flatfile.ActorRoleId` — The actor role id
**requestOptions:** `Users.RequestOptions`
client.users.listApiTokens (userId, { ...params }) -> Flatfile.ListApiTokensResponse
#### 📝 Description
Gets all the api tokens for a user.
#### 🔌 Usage
```typescript
await client.users.listApiTokens("userId", {
tenantId: "tenantId",
});
```
#### ⚙️ Parameters
**userId:** `Flatfile.UserId` — The user id
**request:** `Flatfile.ListApiTokensRequest`
**requestOptions:** `Users.RequestOptions`
client.users.createApiToken (userId, { ...params }) -> Flatfile.ApiTokenResponse
#### 📝 Description
Creates an api token for authenticating against Flatfile APIs.
#### 🔌 Usage
```typescript
await client.users.createApiToken("userId", {
tenantId: "tenantId",
});
```
#### ⚙️ Parameters
**userId:** `Flatfile.UserId` — The user id
**request:** `Flatfile.CreateApiTokenRequest`
**requestOptions:** `Users.RequestOptions`
client.users.exchangeToken ({ ...params }) -> Flatfile.ExchangeTokenResponse
#### 📝 Description
Exchange an invitation for an access token
#### 🔌 Usage
```typescript
await client.users.exchangeToken();
```
#### ⚙️ Parameters
**request:** `Flatfile.ExchangeTokenRequest`
**requestOptions:** `Users.RequestOptions`
client.versions.createId ({ ...params }) -> Flatfile.VersionResponse
#### 🔌 Usage
```typescript
await client.versions.createId({
sheetId: "us_sh_YOUR_ID",
parentVersionId: "us_vr_YOUR_ID",
});
```
#### ⚙️ Parameters
**request:** `Flatfile.VersionsPostRequestBody`
**requestOptions:** `Versions.RequestOptions`
client.views.list ({ ...params }) -> Flatfile.ListViewsResponse
#### 📝 Description
Returns all views for the sheet
#### 🔌 Usage
```typescript
await client.views.list({
sheetId: "us_sh_YOUR_ID",
});
```
#### ⚙️ Parameters
**request:** `Flatfile.ListViewsRequest`
**requestOptions:** `Views.RequestOptions`
client.views.create ({ ...params }) -> Flatfile.ViewResponse
#### 📝 Description
Add a new view to the space
#### 🔌 Usage
```typescript
await client.views.create({
sheetId: "us_sh_YOUR_ID",
name: "My View",
config: {
filter: "error",
filterField: "email",
q: "firstname like %John%",
sortField: "email",
sortDirection: "asc",
},
});
```
#### ⚙️ Parameters
**request:** `Flatfile.ViewCreate`
**requestOptions:** `Views.RequestOptions`
client.views.get (viewId) -> Flatfile.ViewResponse
#### 📝 Description
Returns a single view
#### 🔌 Usage
```typescript
await client.views.get("us_vi_YOUR_ID");
```
#### ⚙️ Parameters
**viewId:** `Flatfile.ViewId` — ID of view to return
**requestOptions:** `Views.RequestOptions`
client.views.update (viewId, { ...params }) -> Flatfile.ViewResponse
#### 📝 Description
Updates a single view
#### 🔌 Usage
```typescript
await client.views.update("us_vi_YOUR_ID", {
name: "My View",
config: {
filter: "error",
filterField: "email",
q: "firstname like %John%",
sortField: "email",
sortDirection: "asc",
},
});
```
#### ⚙️ Parameters
**viewId:** `Flatfile.ViewId` — ID of view to update
**request:** `Flatfile.ViewUpdate`
**requestOptions:** `Views.RequestOptions`
client.views.delete (viewId) -> Flatfile.Success
#### 📝 Description
Deletes a single view
#### 🔌 Usage
```typescript
await client.views.delete("us_vi_YOUR_ID");
```
#### ⚙️ Parameters
**viewId:** `Flatfile.ViewId` — ID of view to delete
**requestOptions:** `Views.RequestOptions`
client.workbooks.list ({ ...params }) -> Flatfile.ListWorkbooksResponse
#### 📝 Description
Returns all workbooks matching a filter for an account or space
#### 🔌 Usage
```typescript
await client.workbooks.list({
spaceId: "us_sp_YOUR_ID",
});
```
#### ⚙️ Parameters
**request:** `Flatfile.ListWorkbooksRequest`
**requestOptions:** `Workbooks.RequestOptions`
client.workbooks.create ({ ...params }) -> Flatfile.WorkbookResponse
#### 📝 Description
Creates a workbook and adds it to a space
#### 🔌 Usage
```typescript
await client.workbooks.create({
name: "My First Workbook",
sheets: [
{
name: "Contacts",
slug: "contacts",
fields: [
{
type: "string",
key: "firstName",
label: "First Name",
},
{
type: "string",
key: "lastName",
label: "Last Name",
},
{
type: "string",
key: "email",
label: "Email",
},
],
mappingConfidenceThreshold: 0.5,
},
],
labels: ["simple-demo"],
actions: [
{
operation: "submitAction",
mode: "foreground",
label: "Submit",
description: "Submit data to webhook.site",
primary: true,
},
],
settings: {
trackChanges: true,
autoRunAnalysis: true,
},
});
```
#### ⚙️ Parameters
**request:** `Flatfile.CreateWorkbookConfig`
**requestOptions:** `Workbooks.RequestOptions`
client.workbooks.get (workbookId) -> Flatfile.WorkbookResponse
#### 📝 Description
Returns a single workbook
#### 🔌 Usage
```typescript
await client.workbooks.get("us_wb_YOUR_ID");
```
#### ⚙️ Parameters
**workbookId:** `Flatfile.WorkbookId` — ID of workbook to return
**requestOptions:** `Workbooks.RequestOptions`
client.workbooks.delete (workbookId) -> Flatfile.Success
#### 📝 Description
Deletes a workbook and all of its record data permanently
#### 🔌 Usage
```typescript
await client.workbooks.delete("us_wb_YOUR_ID");
```
#### ⚙️ Parameters
**workbookId:** `Flatfile.WorkbookId` — ID of workbook to delete
**requestOptions:** `Workbooks.RequestOptions`
client.workbooks.update (workbookId, { ...params }) -> Flatfile.WorkbookResponse
#### 📝 Description
Updates a workbook
Adding a sheet to a workbook does not require the config object to be provided, however updating an existing sheet does.
#### 🔌 Usage
```typescript
await client.workbooks.update("us_wb_YOUR_ID", {
name: "My Updated Workbook",
labels: ["my-new-label"],
actions: [
{
operation: "submitAction",
mode: "foreground",
label: "Submit Changes",
description: "Submit data to webhook.site",
primary: true,
},
],
});
```
#### ⚙️ Parameters
**workbookId:** `Flatfile.WorkbookId` — ID of workbook to update
**request:** `Flatfile.WorkbookUpdate`
**requestOptions:** `Workbooks.RequestOptions`
client.workbooks.getWorkbookCommits (workbookId, { ...params }) -> Flatfile.ListCommitsResponse
#### 📝 Description
Returns the commits for a workbook
#### 🔌 Usage
```typescript
await client.workbooks.getWorkbookCommits("us_wb_YOUR_ID");
```
#### ⚙️ Parameters
**workbookId:** `Flatfile.WorkbookId` — ID of workbook
**request:** `Flatfile.ListWorkbookCommitsRequest`
**requestOptions:** `Workbooks.RequestOptions`
client.workbooks.rebuildWorkbook (workbookId) -> Flatfile.Success
#### 📝 Description
Rebuild a workbook
#### 🔌 Usage
```typescript
await client.workbooks.rebuildWorkbook("workbookId");
```
#### ⚙️ Parameters
**workbookId:** `Flatfile.WorkbookId` — ID of workbook to rebuild
**requestOptions:** `Workbooks.RequestOptions`