# userApi Module

## Overview

This module provides APIs for user operations.

## API Functions


### common.ts

Source: `src/api/user/common.ts`

#### `getAppDetail()`

```typescript
async function getAppDetail(id: string | number): Promise<AppDetailRespVO>
```

#### `getDataset()`

```typescript
async function getDataset(id: string | number,
  nodeId: string | number): Promise<DatasetRow[]>
```

#### `getOrganizationTree()`

```typescript
async function getOrganizationTree(data: GetOrganizationTreeReqVO): Promise<GetOrganizationTreeRespVO>
```

#### `getOrganizationUsers()`

```typescript
async function getOrganizationUsers(data: GetOrganizationUsersReqVO): Promise<GetOrganizationUsersRespVO>
```

#### `getUploadToken()`

```typescript
async function getUploadToken(data: GetUploadTokenReqVO): Promise<GetUploadTokenRespVO>
```

#### `getIngress()`

```typescript
async function getIngress(appId: string,
  ingressId: string): Promise<IngressRespVO>
```

#### `setIngressOptionsTabber()`

```typescript
async function setIngressOptionsTabber(appId: string,
  ingressId: string,
  data: IngressSetOptionsTabberReqVO): Promise<IngressSetOptionsTabberRespVO>
```

#### `mobileUpload()`

```typescript
async function mobileUpload(data: MobileUploadReqVO): Promise<MobileUploadRespVO>
```

#### `checkMobileUpload()`

```typescript
async function checkMobileUpload(data: MobileUploadCheckReqVO): Promise<MobileUploadCheckRespVO>
```

#### `uploadPreview()`

```typescript
async function uploadPreview(data: UploadPreviewReqVO): Promise<UploadPreviewRespVO>
```

#### `validateEntityUnique()`

```typescript
async function validateEntityUnique(appId: string,
  entityId: string,
  data: EntityValidateUniqReqVO): Promise<EntityValidateUniqRespVO>
```

#### `queryEntityRelation()`

```typescript
async function queryEntityRelation(appId: string,
  entityId: string,
  data: EntityQueryRelationReqVO): Promise<EntityQueryRelationRespVO>
```

#### `queryLinktoPickOptions()`

```typescript
async function queryLinktoPickOptions(appId: string,
  entityId: string,
  data: EntityQueryRelationReqVO): Promise<EntityQueryRelationRespVO>
```

#### `queryLinktoValues()`

```typescript
async function queryLinktoValues(appId: string,
  entityId: string,
  data: EntityQueryLinkToValuesReqVO): Promise<EntityQueryRelationRespVO>
```

#### `getSubformRelationData()`

```typescript
async function getSubformRelationData(appId: string,
  entityId: string,
  options: any): Promise<any>
```


### context.ts

Source: `src/api/user/context.ts`

#### `getContextUserToken()`

```typescript
async function getContextUserToken(): Promise<FetchUserTokenRespVO>
```


### copilot.ts

Source: `src/api/user/copilot.ts`

#### `initCopilotConversation()`

```typescript
async function initCopilotConversation(): Promise<CopilotInitConversationRespVO>
```

#### `sendCopilotMessage()`

```typescript
async function sendCopilotMessage(data: CopilotSendMessageReqVO): Promise<CopilotSendMessageRespVO>
```


### dashboard.ts

Source: `src/api/user/dashboard.ts`

#### `getDashboard()`

```typescript
async function getDashboard(appId: string,
  dashboardId: string): Promise<DashboardGetRespVO>
```

#### `getDashboardWidgets()`

```typescript
async function getDashboardWidgets(appId: string,
  dashboardId: string): Promise<DashboardWidgets[]>
```

#### `getExportTask()`

```typescript
async function getExportTask(id: string): Promise<ExportTaskRespVO>
```

#### `fetchWidgetsData()`

```typescript
async function fetchWidgetsData(appId: string,
  data: FetchWidgetsDataReqVO): Promise<FetchWidgetsDataRespVO>
```


### entity.ts

Source: `src/api/user/entity.ts`

#### `addEntityComment()`

```typescript
async function addEntityComment(appId: string,
  entityId: string,
  rowId: string,
  data: EntityAddCommentReqVO): Promise<EntityAddCommentRespVO>
```

#### `configEntityAIImport()`

```typescript
async function configEntityAIImport(appId: string,
  entityId: string,
  data: EntityAIImportConfigReqVO): Promise<EntityAIImportConfigRespVO>
```

#### `updateEntityBulk()`

```typescript
async function updateEntityBulk(appId: string,
  entityId: string,
  data: EntityBulkUpdateReqVO): Promise<EntityBulkUpdateRespVO>
```

#### `saveEntityBulkUpdateAs()`

```typescript
async function saveEntityBulkUpdateAs(appId: string,
  entityId: string,
  data: EntityBulkUpdateSaveAsReqVO): Promise<EntityBulkUpdateSaveAsRespVO>
```

#### `deleteEntityComment()`

```typescript
async function deleteEntityComment(appId: string,
  entityId: string,
  rowId: string,
  data: EntityDelCommentReqVO): Promise<EntityDelCommentRespVO>
```

#### `doEntityAction()`

```typescript
async function doEntityAction(appId: string,
  entityId: string,
  rowId: string,
  action: string,
  data: EntityDoActionReqVO): Promise<EntityDoActionRespVO>
```

#### `doEntityFsmAction()`

```typescript
async function doEntityFsmAction(appId: string,
  entityId: string,
  actionCode: string,
  data: EntityDoFsmActionReqVO): Promise<EntityDoFsmActionRespVO>
```

#### `exportEntity()`

```typescript
async function exportEntity(appId: string,
  entityId: string,
  data: EntityExportReqVO): Promise<EntityExportRespVO>
```

#### `getEntityComments()`

```typescript
async function getEntityComments(appId: string,
  entityId: string,
  rowId: string,
  data: CommonQueryFormVO): Promise<EntityGetCommentsRespVO>
```

#### `getEntityLogs()`

```typescript
async function getEntityLogs(appId: string,
  entityId: string,
  rowId: string,
  data: CommonQueryFormVO): Promise<EntityGetLogsRespVO>
```

#### `importEntity()`

```typescript
async function importEntity(appId: string,
  entityId: string,
  data: EntityImportReqVO & EntityImportActionVO): Promise<ImporterPostUploadRespVO | ImporterDoProcessRespVO | ImporterGetStateRespVO | ImporterInitTokenRespVO>
```

#### `prepareEntityImport()`

```typescript
async function prepareEntityImport(appId: string,
  entityId: string,
  data: EntityImportPrepareReqVO): Promise<EntityImportPrepareRespVO>
```

#### `getEntityInfo()`

```typescript
async function getEntityInfo(appId: string,
  entityId: string,): Promise<EntityInfoRespVO>
```

#### `invokeEntityBatchOperator()`

```typescript
async function invokeEntityBatchOperator(appId: string,
  entityId: string,
  data: EntityInvokeBatchOperatorReqVO & InvokeRequestVO): Promise<EntityInvokeBatchOperatorRespVO>
```

#### `invokeEntityHook()`

```typescript
async function invokeEntityHook(appId: string,
  entityId: string,
  actionId: string,
  data: InvokeRequestVO): Promise<EntityInvokeHookRespVO>
```

#### `getEntityProcessMap()`

```typescript
async function getEntityProcessMap(appId: string,
  entityId: string,
  rowId: string): Promise<EntityProcessMapRespVO>
```

#### `getEntityPrintTemplates()`

```typescript
async function getEntityPrintTemplates(appId: string,
  entityId: string): Promise<EntityPrintTemplatesListRespVO>
```


### flow.ts

Source: `src/api/user/flow.ts`

#### `queryUserFlow()`

```typescript
async function queryUserFlow(data: UserFlowQueryReqVO): Promise<UserFlowQueryRespVO>
```

#### `getUserFlowStatus()`

```typescript
async function getUserFlowStatus(): Promise<UserFlowStatusRespVO>
```


### global-action.ts

Source: `src/api/user/global-action.ts`

#### `acceptTenantInvitation()`

```typescript
async function acceptTenantInvitation(data: GlobalActionAcceptInvitationReqVO): Promise<GlobalActionAcceptInvitationRespVO>
```

#### `acceptTenantInvitationLink()`

```typescript
async function acceptTenantInvitationLink(data: GlobalActionAcceptInvitationLinkReqVO): Promise<GlobalActionAcceptInvitationLinkRespVO>
```

#### `createTenant()`

```typescript
async function createTenant(data: GlobalActionCreateTenantReqVO): Promise<GlobalActionCreateTenantRespVO>
```

#### `setDefaultTenant()`

```typescript
async function setDefaultTenant(data: GlobalActionSetDefaultTenantReqVO): Promise<GlobalActionSetDefaultTenantRespVO>
```

#### `verifyEmail()`

```typescript
async function verifyEmail(data: GlobalActionEmailVerifyReqVO): Promise<GlobalActionEmailVerifyRespVO>
```

#### `resendEmailVerify()`

```typescript
async function resendEmailVerify(data: GlobalActionEmailVerifyResendReqVO): Promise<GlobalActionEmailVerifyResendRespVO>
```

#### `getEmailVerifyStatus()`

```typescript
async function getEmailVerifyStatus(): Promise<GlobalActionEmailVerifyStatusRespVO>
```

#### `getEntry()`

```typescript
async function getEntry(refresh: boolean = false): Promise<GlobalActionEntryRespVO>
```

#### `getTenantAuthRole()`

```typescript
async function getTenantAuthRole(): Promise<GlobalActionGetAuthRoleRespVO>
```

#### `getTenantInvitationLink()`

```typescript
async function getTenantInvitationLink(id: string): Promise<GlobalActionGetInvitationLinkRespVO>
```

#### `getLink()`

```typescript
async function getLink(name: string): Promise<void>
```

#### `setProfileEmail()`

```typescript
async function setProfileEmail(data: GlobalActionProfileSetEmailReqVO): Promise<GlobalActionProfileSetEmailRespVO>
```

#### `cancelProfileEmail()`

```typescript
async function cancelProfileEmail(hashid: string): Promise<GlobalActionProfileSetEmailCancelRespVO>
```

#### `getProfileEmailHistory()`

```typescript
async function getProfileEmailHistory(): Promise<GlobalActionProfileSetEmailHistoryRespVO>
```


### kiosk.ts

Source: `src/api/user/kiosk.ts`

#### `getKioskScreens()`

```typescript
async function getKioskScreens(appId: string): Promise<KioskScreensRespVO>
```


### profile.ts

Source: `src/api/user/profile.ts`

#### `getUserProfile()`

```typescript
async function getUserProfile(): Promise<UserProfileRespVO>
```

#### `updateUserProfile()`

```typescript
async function updateUserProfile(data: UserProfileUpdateReqVO): Promise<UserProfileUpdateRespVO>
```

#### `updateUserAvatar()`

```typescript
async function updateUserAvatar(data: UpdateAvatarReqVO): Promise<UpdateAvatarRespVO>
```

#### `getUserAuthChannels()`

```typescript
async function getUserAuthChannels(): Promise<AuthChannelsRespVO>
```

#### `changeUserPassword()`

```typescript
async function changeUserPassword(data: ChangePasswordReqVO): Promise<ChangePasswordRespVO>
```

#### `fetchEntityUserToken()`

```typescript
async function fetchEntityUserToken(appId: string,
  entityId: string): Promise<FetchUserTokenRespVO>
```


### workflow.ts

Source: `src/api/user/workflow.ts`

#### `putEntityQueryKeeper()`

```typescript
async function putEntityQueryKeeper(appId: string,
  entityId: string,
  data: EntityPutQueryKeeperReqVO): Promise<EntityPutQueryKeeperRespVO>
```

#### `queryEntity()`

```typescript
async function queryEntity(appId: string,
  entityId: string,
  data: EntityQueryReqVO): Promise<EntityQueryRespVO>
```

#### `filterEntityQuery()`

```typescript
async function filterEntityQuery(appId: string,
  entityId: string,
  data: EntityQueryFilterReqVO): Promise<EntityQueryFilterRespVO>
```

#### `queryEntitySelection()`

```typescript
async function queryEntitySelection(appId: string,
  entityId: string,
  action: string,
  data: EntitySelectionActionReqVO): Promise<EntityQuerySelectionRespVO>
```

#### `resolveEntityWorkflow()`

```typescript
async function resolveEntityWorkflow(appId: string,
  entityId: string,
  data: EntityResolveWorkflowReqVO): Promise<EntityResolveWorkflowRespVO>
```

#### `getEntityRow()`

```typescript
async function getEntityRow(appId: string,
  entityId: string,
  rowId: string,
  params?: Record<string, any>): Promise<EntityRowRespVO>
```

#### `deleteEntityRow()`

```typescript
async function deleteEntityRow(appId: string,
  entityId: string,
  data: EntitySelectionActionReqVO): Promise<EntityRowDeleteRespVO>
```

#### `restoreEntityRow()`

```typescript
async function restoreEntityRow(appId: string,
  entityId: string,
  data: EntitySelectionActionReqVO): Promise<{ restored: number }>
```

#### `updateEntityRow()`

```typescript
async function updateEntityRow(appId: string,
  entityId: string,
  rowId: string,
  data: EntityUpdateReqVO): Promise<EntityUpdateRespVO>
```

#### `validateEntityUniq()`

```typescript
async function validateEntityUniq(appId: string,
  entityId: string,
  data: EntityValidateUniqReqVO): Promise<EntityValidateUniqRespVO>
```

#### `insertEntity()`

```typescript
async function insertEntity(appId: string,
  entityId: string,
  data: InsertReqVO): Promise<InsertRespVO>
```

#### `prepareEntityInsert()`

```typescript
async function prepareEntityInsert(appId: string,
  entityId: string,
  data: InsertPrepareReqVO): Promise<InsertPrepareRespVO>
```

#### `queryEntityWorkflowApproveUsers()`

```typescript
async function queryEntityWorkflowApproveUsers(appId: string,
  entityId: string): Promise<EntityWorkflowApproveUsersRespVO>
```

#### `queryEntityWorkflowNodes()`

```typescript
async function queryEntityWorkflowNodes(appId: string,
  entityId: string): Promise<EntityWorkflowNodesRespVO>
```

#### `getEntitySubformItems()`

```typescript
async function getEntitySubformItems(appId: string,
  entityId: string,
  rowId: string,
  data: GetSubformItemsReqVO): Promise<GetSubformItemsRespVO>
```