@gct-paas/api 0.1.6-dev.5 → 0.1.6-dev.6

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

@@ -0,0 +1,733 @@
+/* eslint-disable @typescript-eslint/no-explicit-any */
+import type { AxiosRequestConfig } from 'axios';
+import type {
+  CreateBranchRequest,
+  CreateAppRequest,
+  CreateImportAppResponse,
+  FieldMetaResponse,
+  MenuConfig,
+  AppBranchResponse,
+  CommitLogResponse,
+  ImportVersionRequest,
+  MergePreviewResponse,
+  MergeRequest,
+  MergeLogResponse,
+  ModelCompleteResponse,
+  PublishLogResponse,
+  AppPublishLogResponse,
+  RevertRequest,
+  SwitchBranchRequest,
+  UserOfApp,
+  AuditLogSearchRequest,
+  AuditLogResponse,
+  UserBaseInfo,
+  AuditLogRequest,
+  DatasourceMove,
+  SelectItem,
+  DataSourceProperties,
+  TransferAllWorkItemRequest,
+  ProcessDefinitionFeignResponse,
+} from '../entities';
+
+export interface getAppCreateIndexQuery {
+  /**
+   * appId
+   */
+  appId: string;
+  /**
+   * env
+   */
+  env: string;
+  /**
+   * fieldKeys
+   */
+  fieldKeys: string;
+  /**
+   * indexName
+   */
+  indexName: string;
+  /**
+   * modelKey
+   */
+  modelKey: string;
+}
+export interface getAppDeleteIndexQuery {
+  /**
+   * appId
+   */
+  appId: string;
+  /**
+   * env
+   */
+  env: string;
+  /**
+   * indexName
+   */
+  indexName: string;
+  /**
+   * modelKey
+   */
+  modelKey: string;
+}
+export interface deleteAppDropProdDbQuery {
+  /**
+   * appId
+   */
+  appId: string;
+}
+export interface deleteAppDropTestDbQuery {
+  /**
+   * appId
+   */
+  appId: string;
+}
+export interface getAppFieldMetaListQuery {
+  /**
+   * 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
+   */
+  appEnv: string;
+  /**
+   * appId
+   */
+  appId: string;
+  /**
+   * menuType
+   */
+  menuType: string;
+}
+export interface getAppGetCurrentBranchQuery {
+  /**
+   * appId
+   */
+  appId: string;
+}
+export interface getAppGetIndexQuery {
+  /**
+   * appId
+   */
+  appId: string;
+  /**
+   * env
+   */
+  env: string;
+  /**
+   * indexName
+   */
+  indexName?: string;
+  /**
+   * modelKey
+   */
+  modelKey: string;
+  /**
+   * preName
+   */
+  preName?: string;
+}
+export interface getAppGetLatestBranchQuery {
+  /**
+   * appId
+   */
+  appId: string;
+}
+export interface getAppGetLatestCommitQuery {
+  /**
+   * appId
+   */
+  appId: string;
+  /**
+   * branchId
+   */
+  branchId: string;
+}
+export interface getAppImportVersionPreviewQuery {
+  /**
+   * appId
+   */
+  appId: string;
+  /**
+   * appPkgUrl
+   */
+  appPkgUrl: string;
+}
+export interface getAppListBranchQuery {
+  /**
+   * appId
+   */
+  appId: string;
+}
+export interface getAppMergeInfoQuery {
+  /**
+   * appId
+   */
+  appId: string;
+  /**
+   * id
+   */
+  id: string;
+}
+export interface getAppMergePageListQuery {
+  /**
+   * appId
+   */
+  appId: string;
+  /**
+   * keyword
+   */
+  keyword?: string;
+  /**
+   * pageNo
+   */
+  pageNo?: number;
+  /**
+   * pageSize
+   */
+  pageSize?: number;
+}
+export interface getAppMergePreviewQuery {
+  /**
+   * appId
+   */
+  appId: string;
+  /**
+   * sourceBranchId
+   */
+  sourceBranchId: string;
+  /**
+   * targetBranchId
+   */
+  targetBranchId: string;
+}
+export interface getAppModelMetaListQuery {
+  /**
+   * appId
+   */
+  appId: string;
+  /**
+   * env
+   */
+  env: string;
+}
+export interface getAppPublishLogInfoQuery {
+  /**
+   * appId
+   */
+  appId: string;
+  /**
+   * branchId
+   */
+  branchId: string;
+  /**
+   * publishId
+   */
+  publishId: string;
+}
+export interface getAppPublishLogPageListQuery {
+  /**
+   * 环境 test/prod
+   */
+  appEnv?: string;
+  /**
+   * 应用id
+   */
+  appId: string;
+  /**
+   * 页码
+   */
+  pageNo?: number;
+  /**
+   * 每页数据条数
+   */
+  pageSize?: number;
+  /**
+   * 状态
+   */
+  state?: string;
+}
+export interface getAppReportInfosQuery {
+  /**
+   * app id
+   */
+  appId?: string;
+  /**
+   * 环境
+   */
+  env?: string;
+  /**
+   * true:按分类，false:按数据集
+   */
+  type?: boolean;
+}
+export interface postAppVisibleMenuQuery {
+  /**
+   * appEnv
+   */
+  appEnv: string;
+  /**
+   * appId
+   */
+  appId: string;
+  /**
+   * menuType
+   */
+  menuType: string;
+}
+export interface postAuditLogInfoQuery {
+  /**
+   * id
+   */
+  id: string;
+}
+export interface getAuditLogModulesQuery {
+  /**
+   * appId
+   */
+  appId: string;
+}
+export interface getAuditLogOperateTypesQuery {
+  /**
+   * 操作页面
+   */
+  appId: string;
+}
+export interface getAuditLogOperatorsQuery {
+  /**
+   * appId
+   */
+  appId: string;
+  /**
+   * tenantId
+   */
+  tenantId?: string;
+}
+export interface postDatasourceColumnFormatQuery {
+  /**
+   * dbType
+   */
+  dbType?: string;
+}
+export interface getIeDataReportQuery {
+  /**
+   * 文件id
+   */
+  fileId: string;
+}
+export type postModelComprehensiveBizServiceGeneralBsModelCategoryModelKeyBsKeyQuery =
+  Record<any, any>;
+export interface postModelComprehensiveBizServiceGeneralBsModelCategoryModelKeyBsKeyPathParams {
+  modelCategory: string;
+  modelKey: string;
+  bsKey: string;
+}
+export interface postModelComprehensiveBizServiceModelCategoryModelKeyUploadQuery {
+  /**
+   * bsKey
+   */
+  bsKey: string;
+  /**
+   * requestParam
+   */
+  [key: any]: any;
+}
+export interface postModelComprehensiveBizServiceModelCategoryModelKeyUploadPathParams {
+  modelCategory: string;
+  modelKey: string;
+}
+export type getModelComprehensiveBizServiceModelCategoryModelKeyBsKeyQuery =
+  Record<any, any>;
+export interface getModelComprehensiveBizServiceModelCategoryModelKeyBsKeyPathParams {
+  modelCategory: string;
+  modelKey: string;
+  bsKey: string;
+}
+export type postModelComprehensiveBizServiceModelCategoryModelKeyBsKeyQuery =
+  Record<any, any>;
+export interface postModelComprehensiveBizServiceModelCategoryModelKeyBsKeyPathParams {
+  modelCategory: string;
+  modelKey: string;
+  bsKey: string;
+}
+export type putModelComprehensiveBizServiceModelCategoryModelKeyBsKeyQuery =
+  Record<any, any>;
+export interface putModelComprehensiveBizServiceModelCategoryModelKeyBsKeyPathParams {
+  modelCategory: string;
+  modelKey: string;
+  bsKey: string;
+}
+export type deleteModelComprehensiveBizServiceModelCategoryModelKeyBsKeyQuery =
+  Record<any, any>;
+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获取应用最新分支的所有模型
+   */
+  getAppFieldMetaList(
+    query: getAppFieldMetaListQuery,
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<FieldMetaResponse[]>;
+  /**
+   * 根据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获取应用最新分支的所有模型
+   */
+  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获取应用菜单
+   */
+  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获取应用菜单
+   */
+  postAuditLogSave(
+    data: AuditLogRequest,
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<boolean>;
+  /**
+   * 数据迁移
+   */
+  postDatamoveExecute(
+    data: DatasourceMove,
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<string>;
+  /**
+   * sql格式化
+   */
+  postDatasourceColumnFormat(
+    query: postDatasourceColumnFormatQuery,
+    data: SelectItem,
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<string>;
+  /**
+   * 业务服务get请求接口
+   */
+  getDatasourceInfo(
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<DataSourceProperties>;
+  /**
+   * 生产环境转移所有工作项（待填报、待审核等）
+   */
+  postEdhrProdTransferAllWorkItem(
+    data: TransferAllWorkItemRequest,
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<any>;
+  /**
+   * 测试环境转移所有工作项（待填报、待审核等）
+   */
+  postEdhrTestTransferAllWorkItem(
+    data: TransferAllWorkItemRequest,
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<any>;
+  /**
+   * 下载错误报告
+   */
+  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请求接口
+   */
+  getModelComprehensiveBizServiceModelCategoryModelKeyBsKey(
+    path: getModelComprehensiveBizServiceModelCategoryModelKeyBsKeyPathParams,
+    query: getModelComprehensiveBizServiceModelCategoryModelKeyBsKeyQuery,
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<object>;
+  /**
+   * 业务服务post请求接口
+   */
+  postModelComprehensiveBizServiceModelCategoryModelKeyBsKey(
+    path: postModelComprehensiveBizServiceModelCategoryModelKeyBsKeyPathParams,
+    query: postModelComprehensiveBizServiceModelCategoryModelKeyBsKeyQuery,
+    data: IObject,
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<object>;
+  /**
+   * 业务服务put请求接口
+   */
+  putModelComprehensiveBizServiceModelCategoryModelKeyBsKey(
+    path: putModelComprehensiveBizServiceModelCategoryModelKeyBsKeyPathParams,
+    query: putModelComprehensiveBizServiceModelCategoryModelKeyBsKeyQuery,
+    data: IObject,
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<object>;
+  /**
+   * 业务服务delete请求接口
+   */
+  deleteModelComprehensiveBizServiceModelCategoryModelKeyBsKey(
+    path: deleteModelComprehensiveBizServiceModelCategoryModelKeyBsKeyPathParams,
+    query: deleteModelComprehensiveBizServiceModelCategoryModelKeyBsKeyQuery,
+    data: IObject,
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<object>;
+  /**
+   * 列出所有
+   */
+  getProcessListAll(
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<ProcessDefinitionFeignResponse[]>;
+}