/* eslint-disable */
/* tslint:disable */
// @ts-nocheck
/*
 * ---------------------------------------------------------------
 * ## THIS FILE WAS GENERATED VIA SWAGGER-TYPESCRIPT-API        ##
 * ##                                                           ##
 * ## AUTHOR: acacode                                           ##
 * ## SOURCE: https://github.com/acacode/swagger-typescript-api ##
 * ---------------------------------------------------------------
 */

/** @format int32 */
import type { PermitEntityEvent, NotificationPayloadMode, NotificationNotificationType, MagicStringPartType, ActionBulkUpdate, ActionBulkUpdateAction, GormDeletedAt, KioskConfig, KioskScreen, AiOptions, ApiEndpoint, ApiEndpointParam, ApiOptions, App, AppOptions, Assets, Button, CustomAction, EntityFrontEvent, EntityKioskFlow, EntityOptions, EntityPrintTemplate, Fields, MagicString, MagicStringPart, PermitUserScope, ErrorResponse } from './common'

export enum FieldInitMode {
  FieldInitModeStatic = 0,
  FieldInitModeFormula = 1,
  FieldInitModeRelation = 2,
  FieldInitModeSpecial1 = 3,
  FieldInitModeSpecial2 = 4,
  FieldInitModeSpecial3 = 5,
  FieldInitModeSpecial4 = 6,
  FieldInitModeSpecial5 = 7,
}

export interface Entity {
  app?: App;
  app_id?: number;
  createdAt?: string;
  deletedAt?: GormDeletedAt;
  field?: Fields;
  field_id_seq?: number;
  icon_name?: string;
  id?: number;
  /** 新增字段, 数据索引版本. 如果有该entity的ingress配置了新的可查询字段，则需要更新该字段。 */
  index_version?: number;
  layout?: number[][];
  name?: string;
  /** 新增字段, 优化完成状态. 标识当前entity是否已完成索引优化，可以使用简化查询 */
  optimization_complete?: boolean;
  options?: EntityOptions;
  options_json?: number[];
  prototypes?: number[];
  schema_version?: number;
  /** 新增字段, 分片字段, 用于标识使用哪个字段进行分片 */
  sharding_column?: string;
  sort?: number;
  tenant_id?: number;
  updatedAt?: string;
  workflow_enabled?: boolean;
  workflow_id?: number;
}

export interface Field {
  children?: Fields;
  code_index?: boolean;
  default_value_mode?: FieldInitMode;
  description?: string;
  editable?: boolean;
  id?: number;
  key?: string;
  label?: string;
  number_decimal?: number;
  options?: FieldOptions;
  required?: boolean;
  scannable?: boolean;
  show_label?: boolean;
  transfers?: StateTransfer[];
  type?: string;
  unique?: boolean;
  value?: any;
  visible?: boolean;
}

export type FieldOptions = Record<string, any>;

export interface StateTransfer {
  cfg?: number[];
  from?: number[];
  id?: string;
  label?: string;
  modifier?: ActionBulkUpdate[];
  to?: number;
}

export interface EntityCloneReqVO {
  app_id?: number;
  copy_workflow?: boolean;
  entity_id?: number;
  name?: string;
}

export interface EntityCloneRespVO {
  id?: number;
  name?: string;
}

export interface EntityDebugInvokeHookReqVO {
  action?: EntityFrontEvent;
  /** 所有类型共用的输入字段 */
  input?: Record<string, any>;
}

export interface EntityDeleteEntityRespVO {
  success?: boolean;
}

export interface EntityInfoRespVO {
  app_id?: number;
  field_id_seq?: number;
  fields?: Fields;
  id?: number;
  is_entity_admin?: boolean;
  layout?: number[][];
  name?: string;
  options?: EntityOptions;
  prototypes?: number[];
  schema_version?: number;
  workflow_enabled?: boolean;
}

export interface EntityKioskFlowCreateReqVO {
  config?: KioskConfig;
  enabled?: boolean;
  name?: string;
  user_scope?: PermitUserScope[];
}

export interface EntityKioskFlowUpdateReqVO {
  app_id?: number;
  changed?: string[];
  config?: KioskConfig;
  enabled?: boolean;
  entity_id?: number;
  icon_name?: string;
  id?: string;
  last_modified_by?: number;
  name?: string;
  tenant_id?: number;
  title_color?: string;
  updatedAt?: string;
  user_scope?: PermitUserScope[];
}

export interface EntityPrintTemplatesCreateReqVO {
  background_assets?: Assets;
  background_assets_id?: number;
  entity_id?: number;
  id?: number;
  name?: string;
  size?: string;
  template?: Record<string, any>;
}

export interface EntityPrintTemplatesCreateRespVO {
  background_assets?: Assets;
  background_assets_id?: number;
  entity_id?: number;
  id?: number;
  name?: string;
  size?: string;
  template?: Record<string, any>;
}

export interface EntityPrintTemplatesDeleteRespVO {
  background_assets?: Assets;
  background_assets_id?: number;
  entity_id?: number;
  id?: number;
  name?: string;
  size?: string;
  template?: Record<string, any>;
}

export interface EntityPrintTemplatesGetRespVO {
  background_assets?: Assets;
  background_assets_id?: number;
  entity_id?: number;
  id?: number;
  name?: string;
  size?: string;
  template?: Record<string, any>;
}

export interface EntityPrintTemplatesUpdateReqVO {
  background_assets?: Assets;
  background_assets_id?: number;
  entity_id?: number;
  id?: number;
  name?: string;
  size?: string;
  template?: Record<string, any>;
}

export interface EntityPrintTemplatesUpdateRespVO {
  background_assets?: Assets;
  background_assets_id?: number;
  entity_id?: number;
  id?: number;
  name?: string;
  size?: string;
  template?: Record<string, any>;
}

export interface EntitySaveCustomKeysFieldVO {
  id?: number;
  key?: string;
}

export interface EntitySaveCustomKeysRespVO {
  app_id?: number;
  field_id_seq?: number;
  fields?: Fields;
  id?: number;
  layout?: number[][];
  name?: string;
  options?: EntityOptions;
  prototypes?: number[];
  schema_version?: number;
  workflow_enabled?: boolean;
}

export interface EntitySaveNameReqVO {
  name?: string;
}

export interface EntitySaveNameRespVO {
  app_id?: number;
  field_id_seq?: number;
  fields?: Fields;
  id?: number;
  layout?: number[][];
  name?: string;
  options?: EntityOptions;
  prototypes?: number[];
  schema_version?: number;
  workflow_enabled?: boolean;
}

export interface EntitySaveReqVO {
  app_id?: number;
  current_serial?: EntitySerialUpdaterVO;
  field_id_seq?: number;
  fields?: Fields;
  id?: number;
  layout?: number[][];
  name?: string;
  options?: EntityOptions;
  prototypes?: number[];
  schema_version?: number;
  workflow_enabled?: boolean;
}

export interface EntitySaveRespVO {
  app_id?: number;
  field_id_seq?: number;
  fields?: Fields;
  id?: number;
  layout?: number[][];
  name?: string;
  options?: EntityOptions;
  prototypes?: number[];
  schema_version?: number;
  workflow_enabled?: boolean;
}

export interface EntitySerialInitValReqVO {
  command?: string;
  field_id?: number;
  reset?: string;
}

export interface EntitySerialInitValRespVO {
  current?: number;
}

export interface EntitySerialUpdaterVO {
  reset?: string;
  value?: number;
}

export interface EntityTestNotificationReqVO {
  /** Webhook密钥（仅webhook类型需要） */
  secret?: string;
  /** webhook 或 sqs */
  type?: string;
  /** 通知URL */
  url?: string;
}

export interface EntityTestNotificationRespVO {
  message?: string;
  success?: boolean;
}

export interface EntityUpdateButtonsRespVO {
  app_id?: number;
  field_id_seq?: number;
  fields?: Fields;
  id?: number;
  layout?: number[][];
  name?: string;
  options?: EntityOptions;
  prototypes?: number[];
  schema_version?: number;
  workflow_enabled?: boolean;
}

export interface EntityUpdateNotificationsRespVO {
  app_id?: number;
  field_id_seq?: number;
  fields?: Fields;
  id?: number;
  layout?: number[][];
  name?: string;
  options?: EntityOptions;
  prototypes?: number[];
  schema_version?: number;
  workflow_enabled?: boolean;
}

export interface EntityUpdateOptionsReqVO {
  ArchiveSearchFieldID?: number;
  CommentAble?: boolean;
  CustomTitle?: boolean;
  EnableArchive?: boolean;
  EnableFastEdit?: boolean;
  EnableLog?: boolean;
  EnableTags?: boolean;
  TitleFormat?: MagicString;
}

export interface EntityUpdateOptionsRespVO {
  app_id?: number;
  field_id_seq?: number;
  fields?: Fields;
  id?: number;
  layout?: number[][];
  name?: string;
  options?: EntityOptions;
  prototypes?: number[];
  schema_version?: number;
  workflow_enabled?: boolean;
}

export interface EntityUpdateSuccessScreenReqVO {
  EnableDraft?: boolean;
  EnableOffline?: boolean;
  EnableSuccessScreen?: boolean;
  SuccessScreen?: string;
}

export interface EntityUpdateSuccessScreenRespVO {
  app_id?: number;
  field_id_seq?: number;
  fields?: Fields;
  id?: number;
  layout?: number[][];
  name?: string;
  options?: EntityOptions;
  prototypes?: number[];
  schema_version?: number;
  workflow_enabled?: boolean;
}