@gct-paas/api 0.1.0-dev.6 → 0.1.0-dev.7

package/lib/apaas/service/apis/api.service.d.ts

@@ -29,409 +29,703 @@ import type {
 } from '../entities';
 
 export interface getAppCreateIndexQuery {
-  appId: string; // appId
-  env: string; // env
-  fieldKeys: string; // fieldKeys
-  indexName: string; // indexName
-  modelKey: string; // modelKey
+  /**
+   * appId
+   */
+  appId: string;
+  /**
+   * env
+   */
+  env: string;
+  /**
+   * fieldKeys
+   */
+  fieldKeys: string;
+  /**
+   * indexName
+   */
+  indexName: string;
+  /**
+   * modelKey
+   */
+  modelKey: string;
 }
 export interface getAppDeleteIndexQuery {
-  appId: string; // appId
-  env: string; // env
-  indexName: string; // indexName
-  modelKey: string; // modelKey
+  /**
+   * appId
+   */
+  appId: string;
+  /**
+   * env
+   */
+  env: string;
+  /**
+   * indexName
+   */
+  indexName: string;
+  /**
+   * modelKey
+   */
+  modelKey: string;
 }
 export interface deleteAppDropProdDbQuery {
-  appId: string; // appId
+  /**
+   * appId
+   */
+  appId: string;
 }
 export interface deleteAppDropTestDbQuery {
-  appId: string; // appId
+  /**
+   * appId
+   */
+  appId: string;
 }
 export interface getAppFieldMetaListQuery {
-  appId: string; // appId
-  env: string; // env
-  includeBuiltin?: boolean; // includeBuiltin
-  includeProcess?: boolean; // includeProcess
-  keyword?: string; // keyword
-  modelKey: string; // modelKey
-  sys?: boolean; // sys
+  /**
+   * appId
+   */
+  appId: string;
+  /**
+   * env
+   */
+  env: string;
+  /**
+   * includeBuiltin
+   */
+  includeBuiltin?: boolean;
+  /**
+   * includeProcess
+   */
+  includeProcess?: boolean;
+  /**
+   * keyword
+   */
+  keyword?: string;
+  /**
+   * modelKey
+   */
+  modelKey: string;
+  /**
+   * sys
+   */
+  sys?: boolean;
 }
 export interface getAppGetAppMenuQuery {
-  appEnv: string; // appEnv
-  appId: string; // appId
-  menuType: string; // menuType
+  /**
+   * appEnv
+   */
+  appEnv: string;
+  /**
+   * appId
+   */
+  appId: string;
+  /**
+   * menuType
+   */
+  menuType: string;
 }
 export interface getAppGetCurrentBranchQuery {
-  appId: string; // appId
+  /**
+   * appId
+   */
+  appId: string;
 }
 export interface getAppGetIndexQuery {
-  appId: string; // appId
-  env: string; // env
-  indexName?: string; // indexName
-  modelKey: string; // modelKey
-  preName?: string; // preName
+  /**
+   * appId
+   */
+  appId: string;
+  /**
+   * env
+   */
+  env: string;
+  /**
+   * indexName
+   */
+  indexName?: string;
+  /**
+   * modelKey
+   */
+  modelKey: string;
+  /**
+   * preName
+   */
+  preName?: string;
 }
 export interface getAppGetLatestBranchQuery {
-  appId: string; // appId
+  /**
+   * appId
+   */
+  appId: string;
 }
 export interface getAppGetLatestCommitQuery {
-  appId: string; // appId
-  branchId: string; // branchId
+  /**
+   * appId
+   */
+  appId: string;
+  /**
+   * branchId
+   */
+  branchId: string;
 }
 export interface getAppImportVersionPreviewQuery {
-  appId: string; // appId
-  appPkgUrl: string; // appPkgUrl
+  /**
+   * appId
+   */
+  appId: string;
+  /**
+   * appPkgUrl
+   */
+  appPkgUrl: string;
 }
 export interface getAppListBranchQuery {
-  appId: string; // appId
+  /**
+   * appId
+   */
+  appId: string;
 }
 export interface getAppMergeInfoQuery {
-  appId: string; // appId
-  id: string; // id
+  /**
+   * appId
+   */
+  appId: string;
+  /**
+   * id
+   */
+  id: string;
 }
 export interface getAppMergePageListQuery {
-  appId: string; // appId
-  keyword?: string; // keyword
-  pageNo?: number; // pageNo
-  pageSize?: number; // pageSize
+  /**
+   * appId
+   */
+  appId: string;
+  /**
+   * keyword
+   */
+  keyword?: string;
+  /**
+   * pageNo
+   */
+  pageNo?: number;
+  /**
+   * pageSize
+   */
+  pageSize?: number;
 }
 export interface getAppMergePreviewQuery {
-  appId: string; // appId
-  sourceBranchId: string; // sourceBranchId
-  targetBranchId: string; // targetBranchId
+  /**
+   * appId
+   */
+  appId: string;
+  /**
+   * sourceBranchId
+   */
+  sourceBranchId: string;
+  /**
+   * targetBranchId
+   */
+  targetBranchId: string;
 }
 export interface getAppModelMetaListQuery {
-  appId: string; // appId
-  env: string; // env
+  /**
+   * appId
+   */
+  appId: string;
+  /**
+   * env
+   */
+  env: string;
 }
 export interface getAppPublishLogInfoQuery {
-  appId: string; // appId
-  branchId: string; // branchId
-  publishId: string; // publishId
+  /**
+   * appId
+   */
+  appId: string;
+  /**
+   * branchId
+   */
+  branchId: string;
+  /**
+   * publishId
+   */
+  publishId: string;
 }
 export interface getAppPublishLogPageListQuery {
-  appEnv?: string; // 环境 test/prod
-  appId: string; // 应用id
-  pageNo?: number; // 页码
-  pageSize?: number; // 每页数据条数
-  state?: string; // 状态
+  /**
+   * 环境 test/prod
+   */
+  appEnv?: string;
+  /**
+   * 应用id
+   */
+  appId: string;
+  /**
+   * 页码
+   */
+  pageNo?: number;
+  /**
+   * 每页数据条数
+   */
+  pageSize?: number;
+  /**
+   * 状态
+   */
+  state?: string;
 }
 export interface getAppReportInfosQuery {
-  appId?: string; // app id
-  env?: string; // 环境
-  type?: boolean; // true:按分类，false:按数据集
+  /**
+   * app id
+   */
+  appId?: string;
+  /**
+   * 环境
+   */
+  env?: string;
+  /**
+   * true:按分类，false:按数据集
+   */
+  type?: boolean;
 }
 export interface postAppVisibleMenuQuery {
-  appEnv: string; // appEnv
-  appId: string; // appId
-  menuType: string; // menuType
+  /**
+   * appEnv
+   */
+  appEnv: string;
+  /**
+   * appId
+   */
+  appId: string;
+  /**
+   * menuType
+   */
+  menuType: string;
 }
 export interface postAuditLogInfoQuery {
-  id: string; // id
+  /**
+   * id
+   */
+  id: string;
 }
 export interface getAuditLogModulesQuery {
-  appId: string; // appId
+  /**
+   * appId
+   */
+  appId: string;
 }
 export interface getAuditLogOperateTypesQuery {
-  appId: string; // 操作页面
+  /**
+   * 操作页面
+   */
+  appId: string;
 }
 export interface getAuditLogOperatorsQuery {
-  appId: string; // appId
-  tenantId?: string; // tenantId
+  /**
+   * appId
+   */
+  appId: string;
+  /**
+   * tenantId
+   */
+  tenantId?: string;
 }
 export interface postDatasourceColumnFormatQuery {
-  dbType?: string; // dbType
+  /**
+   * dbType
+   */
+  dbType?: string;
 }
 export interface getIeDataReportQuery {
-  fileId: string; // 文件id
-}
-export interface postModelComprehensiveBizServiceGeneralBsModelCategoryModelKeyBsKeyQuery {
-  requestParam: Record<string, unknown>; // requestParam
+  /**
+   * 文件id
+   */
+  fileId: string;
 }
+export type postModelComprehensiveBizServiceGeneralBsModelCategoryModelKeyBsKeyQuery =
+  Record<string, unknown>;
 export interface postModelComprehensiveBizServiceGeneralBsModelCategoryModelKeyBsKeyPathParams {
   modelCategory: string;
   modelKey: string;
   bsKey: string;
 }
 export interface postModelComprehensiveBizServiceModelCategoryModelKeyUploadQuery {
-  bsKey: string; // bsKey
-  requestParam: Record<string, unknown>; // requestParam
+  /**
+   * bsKey
+   */
+  bsKey: string;
+  /**
+   * requestParam
+   */
+  [key: string]: unknown;
 }
 export interface postModelComprehensiveBizServiceModelCategoryModelKeyUploadPathParams {
   modelCategory: string;
   modelKey: string;
 }
-export interface getModelComprehensiveBizServiceModelCategoryModelKeyBsKeyQuery {
-  requestParam: Record<string, unknown>; // requestParam
-}
+export type getModelComprehensiveBizServiceModelCategoryModelKeyBsKeyQuery =
+  Record<string, unknown>;
 export interface getModelComprehensiveBizServiceModelCategoryModelKeyBsKeyPathParams {
   modelCategory: string;
   modelKey: string;
   bsKey: string;
 }
-export interface postModelComprehensiveBizServiceModelCategoryModelKeyBsKeyQuery {
-  requestParam: Record<string, unknown>; // requestParam
-}
+export type postModelComprehensiveBizServiceModelCategoryModelKeyBsKeyQuery =
+  Record<string, unknown>;
 export interface postModelComprehensiveBizServiceModelCategoryModelKeyBsKeyPathParams {
   modelCategory: string;
   modelKey: string;
   bsKey: string;
 }
-export interface putModelComprehensiveBizServiceModelCategoryModelKeyBsKeyQuery {
-  requestParam: Record<string, unknown>; // requestParam
-}
+export type putModelComprehensiveBizServiceModelCategoryModelKeyBsKeyQuery =
+  Record<string, unknown>;
 export interface putModelComprehensiveBizServiceModelCategoryModelKeyBsKeyPathParams {
   modelCategory: string;
   modelKey: string;
   bsKey: string;
 }
-export interface deleteModelComprehensiveBizServiceModelCategoryModelKeyBsKeyQuery {
-  requestParam: Record<string, unknown>; // requestParam
-}
+export type deleteModelComprehensiveBizServiceModelCategoryModelKeyBsKeyQuery =
+  Record<string, unknown>;
 export interface deleteModelComprehensiveBizServiceModelCategoryModelKeyBsKeyPathParams {
   modelCategory: string;
   modelKey: string;
   bsKey: string;
 }
 export interface ApiService {
-  // 创建版本/分支
+  /**
+   * 创建版本/分支
+   */
   postAppCreateBranch(
     data: CreateBranchRequest,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<string>;
-  // 创建导入应用
+  /**
+   * 创建导入应用
+   */
   postAppCreateImportApp(
     data: CreateAppRequest,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<CreateImportAppResponse>;
-  // 根据索引名称查询索引
+  /**
+   * 根据索引名称查询索引
+   */
   getAppCreateIndex(
     query: getAppCreateIndexQuery,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<boolean>;
-  // 创建自建应用
+  /**
+   * 创建自建应用
+   */
   postAppCreateSelfBuiltApp(
     data: CreateAppRequest,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<void>;
-  // 根据索引名称查询索引
+  /**
+   * 根据索引名称查询索引
+   */
   getAppDeleteIndex(
     query: getAppDeleteIndexQuery,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<boolean>;
-  // 删除生产环境数据库
+  /**
+   * 删除生产环境数据库
+   */
   deleteAppDropProdDb(
     query: deleteAppDropProdDbQuery,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<void>;
-  // 删除测试环境数据库（后门接口，谨慎使用！）
+  /**
+   * 删除测试环境数据库（后门接口，谨慎使用！）
+   */
   deleteAppDropTestDb(
     query: deleteAppDropTestDbQuery,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<void>;
-  // 根据appid获取应用最新分支的所有模型
+  /**
+   * 根据appid获取应用最新分支的所有模型
+   */
   getAppFieldMetaList(
     query: getAppFieldMetaListQuery,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<FieldMetaResponse[]>;
-  // 根据appid获取应用菜单
+  /**
+   * 根据appid获取应用菜单
+   */
   getAppGetAppMenu(
     query: getAppGetAppMenuQuery,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<MenuConfig[]>;
-  // 获取当前版本/分支
+  /**
+   * 获取当前版本/分支
+   */
   getAppGetCurrentBranch(
     query: getAppGetCurrentBranchQuery,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<AppBranchResponse>;
-  // 根据索引名称查询索引
+  /**
+   * 根据索引名称查询索引
+   */
   getAppGetIndex(
     query: getAppGetIndexQuery,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<string[]>;
-  // 获取最新版本/分支
+  /**
+   * 获取最新版本/分支
+   */
   getAppGetLatestBranch(
     query: getAppGetLatestBranchQuery,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<AppBranchResponse>;
-  // 获取最新提交
+  /**
+   * 获取最新提交
+   */
   getAppGetLatestCommit(
     query: getAppGetLatestCommitQuery,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<CommitLogResponse>;
-  // 导入版本
+  /**
+   * 导入版本
+   */
   postAppImportVersion(
     data: ImportVersionRequest,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<CreateImportAppResponse>;
-  // 导入版本预览
+  /**
+   * 导入版本预览
+   */
   getAppImportVersionPreview(
     query: getAppImportVersionPreviewQuery,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<MergePreviewResponse>;
-  // 查询版本/分支列表
+  /**
+   * 查询版本/分支列表
+   */
   getAppListBranch(
     query: getAppListBranchQuery,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<AppBranchResponse[]>;
-  // 合并
+  /**
+   * 合并
+   */
   postAppMerge(
     data: MergeRequest,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<string>;
-  // 合并详情
+  /**
+   * 合并详情
+   */
   getAppMergeInfo(
     query: getAppMergeInfoQuery,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<MergeLogResponse>;
-  // 合并记录分页列表
+  /**
+   * 合并记录分页列表
+   */
   getAppMergePageList(
     query: getAppMergePageListQuery,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<IPage<MergeLogResponse>>;
-  // 合并预览
+  /**
+   * 合并预览
+   */
   getAppMergePreview(
     query: getAppMergePreviewQuery,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<MergePreviewResponse>;
-  // 根据appid获取应用最新分支的所有模型
+  /**
+   * 根据appid获取应用最新分支的所有模型
+   */
   getAppModelMetaList(
     query: getAppModelMetaListQuery,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<ModelCompleteResponse[]>;
-  // 查询发布日志详情
+  /**
+   * 查询发布日志详情
+   */
   getAppPublishLogInfo(
     query: getAppPublishLogInfoQuery,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<PublishLogResponse>;
-  // 分页查询发布日志
+  /**
+   * 分页查询发布日志
+   */
   getAppPublishLogPageList(
     query: getAppPublishLogPageListQuery,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<IPage<AppPublishLogResponse>>;
-  // 报表列表获取(按类型)
+  /**
+   * 报表列表获取(按类型)
+   */
   getAppReportInfos(
     query: getAppReportInfosQuery,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<IObject>;
-  // 回退上一版
+  /**
+   * 回退上一版
+   */
   postAppRevert(
     data: RevertRequest,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<PublishLogResponse>;
-  // 切换版本/分支
+  /**
+   * 切换版本/分支
+   */
   postAppSwitchBranch(
     data: SwitchBranchRequest,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<void>;
-  // 根据appid获取应用菜单
+  /**
+   * 根据appid获取应用菜单
+   */
   postAppVisibleMenu(
     query: postAppVisibleMenuQuery,
     data: UserOfApp,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<MenuConfig[]>;
-  // 审计日志导出
+  /**
+   * 审计日志导出
+   */
   postAuditLogExport(
     data: AuditLogSearchRequest,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<IObject[]>;
-  // 审计日志详情
+  /**
+   * 审计日志详情
+   */
   postAuditLogInfo(
     query: postAuditLogInfoQuery,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<AuditLogResponse>;
-  // 功能模块
+  /**
+   * 功能模块
+   */
   getAuditLogModules(
     query: getAuditLogModulesQuery,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<string[]>;
-  // 操作类型
+  /**
+   * 操作类型
+   */
   getAuditLogOperateTypes(
     query: getAuditLogOperateTypesQuery,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<string[]>;
-  // 操作人
+  /**
+   * 操作人
+   */
   getAuditLogOperators(
     query: getAuditLogOperatorsQuery,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<UserBaseInfo[]>;
-  // 审计日志列表查询
+  /**
+   * 审计日志列表查询
+   */
   postAuditLogPageList(
     data: AuditLogSearchRequest,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<IPage<AuditLogResponse>>;
-  // 根据appid获取应用菜单
+  /**
+   * 根据appid获取应用菜单
+   */
   postAuditLogSave(
     data: AuditLogRequest,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<boolean>;
-  // 数据迁移
+  /**
+   * 数据迁移
+   */
   postDatamoveExecute(
     data: DatasourceMove,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<string>;
-  // sql格式化
+  /**
+   * sql格式化
+   */
   postDatasourceColumnFormat(
     query: postDatasourceColumnFormatQuery,
     data: SelectItem,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<string>;
-  // 业务服务get请求接口
+  /**
+   * 业务服务get请求接口
+   */
   getDatasourceInfo(
     config?: Partial<AxiosRequestConfig>,
   ): Promise<DataSourceProperties>;
-  // 生产环境转移所有工作项（待填报、待审核等）
+  /**
+   * 生产环境转移所有工作项（待填报、待审核等）
+   */
   postEdhrProdTransferAllWorkItem(
     data: TransferAllWorkItemRequest,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<unknown>;
-  // 测试环境转移所有工作项（待填报、待审核等）
+  /**
+   * 测试环境转移所有工作项（待填报、待审核等）
+   */
   postEdhrTestTransferAllWorkItem(
     data: TransferAllWorkItemRequest,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<unknown>;
-  // 下载错误报告
+  /**
+   * 下载错误报告
+   */
   getIeDataReport(
     query: getIeDataReportQuery,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<string>;
-  // 业务服务通用请求接口
+  /**
+   * 业务服务通用请求接口
+   */
   postModelComprehensiveBizServiceGeneralBsModelCategoryModelKeyBsKey(
     path: postModelComprehensiveBizServiceGeneralBsModelCategoryModelKeyBsKeyPathParams,
     query: postModelComprehensiveBizServiceGeneralBsModelCategoryModelKeyBsKeyQuery,
+    data: IObject,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<object>;
-  // 业务服务文件上传请求接口
+  /**
+   * 业务服务文件上传请求接口
+   */
   postModelComprehensiveBizServiceModelCategoryModelKeyUpload(
     path: postModelComprehensiveBizServiceModelCategoryModelKeyUploadPathParams,
     query: postModelComprehensiveBizServiceModelCategoryModelKeyUploadQuery,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<object>;
-  // 业务服务get请求接口
+  /**
+   * 业务服务get请求接口
+   */
   getModelComprehensiveBizServiceModelCategoryModelKeyBsKey(
     path: getModelComprehensiveBizServiceModelCategoryModelKeyBsKeyPathParams,
     query: getModelComprehensiveBizServiceModelCategoryModelKeyBsKeyQuery,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<object>;
-  // 业务服务post请求接口
+  /**
+   * 业务服务post请求接口
+   */
   postModelComprehensiveBizServiceModelCategoryModelKeyBsKey(
     path: postModelComprehensiveBizServiceModelCategoryModelKeyBsKeyPathParams,
     query: postModelComprehensiveBizServiceModelCategoryModelKeyBsKeyQuery,
+    data: IObject,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<object>;
-  // 业务服务put请求接口
+  /**
+   * 业务服务put请求接口
+   */
   putModelComprehensiveBizServiceModelCategoryModelKeyBsKey(
     path: putModelComprehensiveBizServiceModelCategoryModelKeyBsKeyPathParams,
     query: putModelComprehensiveBizServiceModelCategoryModelKeyBsKeyQuery,
+    data: IObject,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<object>;
-  // 业务服务delete请求接口
+  /**
+   * 业务服务delete请求接口
+   */
   deleteModelComprehensiveBizServiceModelCategoryModelKeyBsKey(
     path: deleteModelComprehensiveBizServiceModelCategoryModelKeyBsKeyPathParams,
     query: deleteModelComprehensiveBizServiceModelCategoryModelKeyBsKeyQuery,
+    data: IObject,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<object>;
-  // 列出所有
+  /**
+   * 列出所有
+   */
   getProcessListAll(
     config?: Partial<AxiosRequestConfig>,
   ): Promise<ProcessDefinitionFeignResponse[]>;