@gct-paas/api 0.1.0-word.2 → 0.1.0

package/lib/apaas/service/apis/online-form-log.service.d.ts

@@ -1,15 +1,30 @@
+import type { AxiosRequestConfig } from 'axios';
 import type { OnlineFormLogResponse } from '../entities';
 
 export interface getListQuery {
-  ignoreBtnType?: string; // 需要忽略的按钮类型：以逗号分割：Form(变更-原后端定义之Change),Abandon(作废)
-  instanceId?: string; // 在线表单实例id
-  procDefType: string; // 流程类型: 电子表单审批 OF_APPROVE、文控审批 DOC_CONTROL_APPROVE
-  tmplId: string; // 在线表单模板id/文控文件模板id:baseId:id
+  /**
+   * 需要忽略的按钮类型：以逗号分割：Form(变更-原后端定义之Change),Abandon(作废)
+   */
+  ignoreBtnType?: string;
+  /**
+   * 在线表单实例id
+   */
+  instanceId?: string;
+  /**
+   * 流程类型: 电子表单审批 OF_APPROVE、文控审批 DOC_CONTROL_APPROVE
+   */
+  procDefType: string;
+  /**
+   * 在线表单模板id/文控文件模板id:baseId:id
+   */
+  tmplId: string;
 }
 export interface OnlineFormLogService {
-  // 列表
+  /**
+   * 列表
+   */
   getList(
     query: getListQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<OnlineFormLogResponse[]>>;
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<OnlineFormLogResponse[]>;
 }

package/lib/apaas/service/apis/online-form-tmpl-log.service.d.ts

@@ -1,55 +1,86 @@
+import type { AxiosRequestConfig } from 'axios';
 import type {
   OnlineFormTmplLogRequest,
   OnlineFormTmplLogResponse,
 } from '../entities';
 
 export interface deleteQuery {
-  ids: string; // 删除的id，多个按','分割
+  /**
+   * 删除的id，多个按','分割
+   */
+  ids: string;
 }
 export interface getInfoQuery {
-  id: string; // id
+  /**
+   * id
+   */
+  id: string;
 }
 export interface getListQuery {
-  tmplId: string; // 模板ID
+  /**
+   * 模板ID
+   */
+  tmplId: string;
 }
 export interface getPageListQuery {
-  pageNo?: number; // 页码
-  pageSize?: number; // 每页数据条数
-  tmplId: string; // 模板ID
+  /**
+   * 页码
+   */
+  pageNo?: number;
+  /**
+   * 每页数据条数
+   */
+  pageSize?: number;
+  /**
+   * 模板ID
+   */
+  tmplId: string;
 }
-export interface putIdQuery {
-  id: string; // 数据主键
+export interface putIdPathParams {
+  id: string;
 }
 export interface OnlineFormTmplLogService {
-  // 保存
+  /**
+   * 保存
+   */
   post(
     data: OnlineFormTmplLogRequest,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<string>>;
-  // 删除
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<string>;
+  /**
+   * 删除
+   */
   delete(
     query: deleteQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<string>>;
-  // 详情
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<string>;
+  /**
+   * 详情
+   */
   getInfo(
     query: getInfoQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<OnlineFormTmplLogResponse>>;
-  // 列表
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<OnlineFormTmplLogResponse>;
+  /**
+   * 列表
+   */
   getList(
     query: getListQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<OnlineFormTmplLogResponse[]>>;
-  // 分页列表
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<OnlineFormTmplLogResponse[]>;
+  /**
+   * 分页列表
+   */
   getPageList(
     query: getPageListQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<IPage<OnlineFormTmplLogResponse>>>;
-  // 修改
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<IPage<OnlineFormTmplLogResponse>>;
+  /**
+   * 修改
+   */
   putId(
-    query: putIdQuery,
+    path: putIdPathParams,
     data: OnlineFormTmplLogRequest,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<string>>;
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<string>;
 }

package/lib/apaas/service/apis/online-form-tmpl.service.d.ts

@@ -1,3 +1,4 @@
+import type { AxiosRequestConfig } from 'axios';
 import type {
   OnlineFormTmplRequest,
   ModelBriefInfo,
@@ -10,151 +11,276 @@ import type {
   OnlineFormDesignDTO,
 } from '../entities';
 
+export interface postCopyCustomizeIdPathParams {
+  id: string;
+}
+export interface postCopyIdPathParams {
+  id: string;
+}
+export interface postCopyVersionIdPathParams {
+  id: string;
+}
+export interface getFormModelsIdPathParams {
+  id: string;
+}
 export interface getGetCommunicationConfigQuery {
-  id: string; // id
+  /**
+   * id
+   */
+  id: string;
 }
 export interface getGetVersionByIdQuery {
-  id: string; // id
+  /**
+   * id
+   */
+  id: string;
 }
 export interface getListBaseAndProcessFormQuery {
-  categoryId?: string; // categoryId
-  formType?: string; // formType
-  name?: string; // name
+  /**
+   * categoryId
+   */
+  categoryId?: string;
+  /**
+   * formType
+   */
+  formType?: string;
+  /**
+   * name
+   */
+  name?: string;
 }
 export interface getListOnlineFormModelsQuery {
-  name?: string; // name
+  /**
+   * name
+   */
+  name?: string;
 }
 export interface getListVersionByIdQuery {
-  id: string; // id
+  /**
+   * id
+   */
+  id: string;
+}
+export interface getModelIdPathParams {
+  id: string;
 }
 export interface postReleaseQuery {
-  tmplId: string; // 模板id
+  /**
+   * 模板id
+   */
+  tmplId: string;
 }
 export interface deleteRemoveByIdQuery {
-  id: string; // 删除的id
+  /**
+   * 删除的id
+   */
+  id: string;
 }
 export interface deleteRemoveVersionByIdQuery {
-  id: string; // 删除的id
+  /**
+   * 删除的id
+   */
+  id: string;
+}
+export interface putSetDefaultIdPathParams {
+  id: string;
 }
 export interface getStashQuery {
-  id: string; // 模板id
+  /**
+   * 模板id
+   */
+  id: string;
+}
+export interface putStashIdPathParams {
+  id: string;
+}
+export interface postUpdateCommunicationConfigIdPathParams {
+  id: string;
+}
+export interface putUpdateDesignerIdPathParams {
+  id: string;
+}
+export interface putUpdateVersionByIdIdPathParams {
+  id: string;
 }
 export interface OnlineFormTmplService {
-  // 自定义复制
+  /**
+   * 自定义复制
+   */
   postCopyCustomizeId(
+    path: postCopyCustomizeIdPathParams,
     data: OnlineFormTmplRequest,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<string>>;
-  // 复制
-  postCopyId(config?: Record<string, string>): Promise<IHttpResponse<string>>;
-  // 复制版本
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<string>;
+  /**
+   * 复制
+   */
+  postCopyId(
+    path: postCopyIdPathParams,
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<string>;
+  /**
+   * 复制版本
+   */
   postCopyVersionId(
+    path: postCopyVersionIdPathParams,
     data: OnlineFormTmplRequest,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<string>>;
-  // 查询基础表单和流程表单中使用的主子模型列表
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<string>;
+  /**
+   * 查询基础表单和流程表单中使用的主子模型列表
+   */
   getFormModelsId(
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<ModelBriefInfo[]>>;
-  // 获取通信配置
+    path: getFormModelsIdPathParams,
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<ModelBriefInfo[]>;
+  /**
+   * 获取通信配置
+   */
   getGetCommunicationConfig(
     query: getGetCommunicationConfigQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<string>>;
-  // 根据id查子
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<string>;
+  /**
+   * 根据id查子
+   */
   getGetVersionById(
     query: getGetVersionByIdQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<OnlineFormTmplResponse>>;
-  // 批量查询指定id表单详情
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<OnlineFormTmplResponse>;
+  /**
+   * 批量查询指定id表单详情
+   */
   postInfos(
     data: DocumentInfo4Req,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<OnlineFormTmplResponse[]>>;
-  // 获取所有基础表单和流程表单
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<OnlineFormTmplResponse[]>;
+  /**
+   * 获取所有基础表单和流程表单
+   */
   getListBaseAndProcessForm(
     query: getListBaseAndProcessFormQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<OnlineFormTmplResponse[]>>;
-  // 获取所有基础表单和流程表单及其对应模型
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<OnlineFormTmplResponse[]>;
+  /**
+   * 获取所有基础表单和流程表单及其对应模型
+   */
   getListOnlineFormModels(
     query: getListOnlineFormModelsQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<OnlineFormTmplModelResponse[]>>;
-  // 根据父id查子列表
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<OnlineFormTmplModelResponse[]>;
+  /**
+   * 根据父id查子列表
+   */
   getListVersionById(
     query: getListVersionByIdQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<OnlineFormTmplResponse[]>>;
-  // 查询表单中使用的主子表列表
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<OnlineFormTmplResponse[]>;
+  /**
+   * 查询表单中使用的主子表列表
+   */
   getModelId(
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<ModelBriefInfo[]>>;
-  // 普通表单发布api
+    path: getModelIdPathParams,
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<ModelBriefInfo[]>;
+  /**
+   * 普通表单发布api
+   */
   postRelease(
     query: postReleaseQuery,
     data: SimpleOnlineFormDesignDTO,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<string>>;
-  // 删除
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<string>;
+  /**
+   * 删除
+   */
   deleteRemoveById(
     query: deleteRemoveByIdQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<string>>;
-  // 删除版本
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<string>;
+  /**
+   * 删除版本
+   */
   deleteRemoveVersionById(
     query: deleteRemoveVersionByIdQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<boolean>>;
-  // 保存
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<boolean>;
+  /**
+   * 保存
+   */
   postSave(
     data: OnlineFormTmplRequest,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<string>>;
-  // 新建字段
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<string>;
+  /**
+   * 新建字段
+   */
   postSaveField(
     data: OnlineFormFieldMetaVO,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<string>>;
-  // 页面设置
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<string>;
+  /**
+   * 页面设置
+   */
   postSaveOperation(
     data: OnlineFormTmplOperationConfig,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<string>>;
-  // 保存版本
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<string>;
+  /**
+   * 保存版本
+   */
   postSaveVersion(
     data: OnlineFormTmplRequest,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<string>>;
-  // 设为默认版本
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<string>;
+  /**
+   * 设为默认版本
+   */
   putSetDefaultId(
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<string>>;
-  // 获取快捷表单模式暂存设计的Json
+    path: putSetDefaultIdPathParams,
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<string>;
+  /**
+   * 获取快捷表单模式暂存设计的Json
+   */
   getStash(
     query: getStashQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<OnlineFormDesignDTO>>;
-  // 快捷表单模式暂存设计Json
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<OnlineFormDesignDTO>;
+  /**
+   * 快捷表单模式暂存设计Json
+   */
   putStashId(
+    path: putStashIdPathParams,
     data: OnlineFormDesignDTO,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<string>>;
-  // test
-  postTest(config?: Record<string, string>): Promise<IHttpResponse<string[]>>;
-  // 修改通信配置
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<string>;
+  /**
+   * test
+   */
+  postTest(config?: Partial<AxiosRequestConfig>): Promise<string[]>;
+  /**
+   * 修改通信配置
+   */
   postUpdateCommunicationConfigId(
+    path: postUpdateCommunicationConfigIdPathParams,
     data: OnlineFormDesignDTO,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<string>>;
-  // 修改设计Json
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<string>;
+  /**
+   * 修改设计Json
+   */
   putUpdateDesignerId(
+    path: putUpdateDesignerIdPathParams,
     data: OnlineFormDesignDTO,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<string>>;
-  // 修改版本
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<string>;
+  /**
+   * 修改版本
+   */
   putUpdateVersionByIdId(
+    path: putUpdateVersionByIdIdPathParams,
     data: OnlineFormTmplRequest,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<string>>;
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<string>;
 }