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

package/es/apaas/service/apis/designer-lock.service.d.ts

@@ -2,33 +2,49 @@ import type { AxiosRequestConfig } from 'axios';
 import type { PageLockRequest, PageOccupyResponse } from '../entities';
 
 export interface getGetPageOccupyMsgQuery {
-  id: string; // id
-  type?: string; // type
+  /**
+   * id
+   */
+  id: string;
+  /**
+   * type
+   */
+  type?: string;
 }
 export interface DesignerLockService {
-  // 取消page页面占用
+  /**
+   * 取消page页面占用
+   */
   postCancelOccupyPage(
     data: PageLockRequest,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
-  // 获取page页面占用信息
+  ): Promise<string>;
+  /**
+   * 获取page页面占用信息
+   */
   getGetPageOccupyMsg(
     query: getGetPageOccupyMsgQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<PageOccupyResponse>>;
-  // 锁定page页面
+  ): Promise<PageOccupyResponse>;
+  /**
+   * 锁定page页面
+   */
   postLockPage(
     data: PageLockRequest,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
-  // 占用page页面进行编辑
+  ): Promise<string>;
+  /**
+   * 占用page页面进行编辑
+   */
   postOccupyPage(
     data: PageLockRequest,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
-  // 解除锁定page页面
+  ): Promise<string>;
+  /**
+   * 解除锁定page页面
+   */
   postUnLockPage(
     data: PageLockRequest,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
+  ): Promise<string>;
 }

package/es/apaas/service/apis/designer-operate-log.service.d.ts

@@ -2,19 +2,45 @@ import type { AxiosRequestConfig } from 'axios';
 import type { DesignerOperateLogResponse } from '../entities';
 
 export interface getPageListQuery {
-  bizModel?: string; // 模块
-  endTime?: string; // 截止时间
-  keyword?: string; // 内容
-  operateType?: string; // 操作类型
-  pageNo?: number; // 页码
-  pageSize?: number; // 每页数据条数
-  startTime?: string; // 开始时间
-  username?: string; // 操作人
+  /**
+   * 模块
+   */
+  bizModel?: string;
+  /**
+   * 截止时间
+   */
+  endTime?: string;
+  /**
+   * 内容
+   */
+  keyword?: string;
+  /**
+   * 操作类型
+   */
+  operateType?: string;
+  /**
+   * 页码
+   */
+  pageNo?: number;
+  /**
+   * 每页数据条数
+   */
+  pageSize?: number;
+  /**
+   * 开始时间
+   */
+  startTime?: string;
+  /**
+   * 操作人
+   */
+  username?: string;
 }
 export interface DesignerOperateLogService {
-  // 应用操作日志分页查询
+  /**
+   * 应用操作日志分页查询
+   */
   getPageList(
     query: getPageListQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<IPage<DesignerOperateLogResponse>>>;
+  ): Promise<IPage<DesignerOperateLogResponse>>;
 }

package/es/apaas/service/apis/devops.service.d.ts

@@ -2,13 +2,17 @@ import type { AxiosRequestConfig } from 'axios';
 import type { DigitsFieldDTO, UpdateDigitsRequest } from '../entities';
 
 export interface DevopsService {
-  // 获取所有涉及到精度小数的字段
+  /**
+   * 获取所有涉及到精度小数的字段
+   */
   getListAllDigitsFields(
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<DigitsFieldDTO[]>>;
-  // 更新精度
+  ): Promise<DigitsFieldDTO[]>;
+  /**
+   * 更新精度
+   */
   postUpdateDigits(
     data: UpdateDigitsRequest,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
+  ): Promise<string>;
 }

package/es/apaas/service/apis/dhr.service.d.ts

@@ -11,47 +11,73 @@ import type {
 } from '../entities';
 
 export interface getLogFindByTraceIdQuery {
-  modelKey: string; // modelKey
-  traceId: string; // traceId
+  /**
+   * modelKey
+   */
+  modelKey: string;
+  /**
+   * traceId
+   */
+  traceId: string;
+}
+export interface getLogListIsntanceIdPathParams {
+  isntanceId: string;
 }
 export interface DhrService {
-  // dhr操作日志列表详情
+  /**
+   * dhr操作日志列表详情
+   */
   getLogFindByTraceId(
     query: getLogFindByTraceIdQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<EdhrSummaryTraceDetail[]>>;
-  // dhr操作日志列表
+  ): Promise<EdhrSummaryTraceDetail[]>;
+  /**
+   * dhr操作日志列表
+   */
   getLogListIsntanceId(
+    path: getLogListIsntanceIdPathParams,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<EdhrLogEntity[]>>;
-  // 审核
+  ): Promise<EdhrLogEntity[]>;
+  /**
+   * 审核
+   */
   postProcessApprove(
     data: DhrProcessApproveRequest,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
-  // 流程干预转办
+  ): Promise<string>;
+  /**
+   * 流程干预转办
+   */
   postProcessInterfereReassign(
     data: DhrProcessReassign4InterfereRequest,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
-  // 流程干预退回
+  ): Promise<string>;
+  /**
+   * 流程干预退回
+   */
   postProcessInterfereReturn(
     data: DhrProcessReturn4InterfereRequest,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
-  // 根据按钮key跳转流程节点
+  ): Promise<string>;
+  /**
+   * 根据按钮key跳转流程节点
+   */
   postProcessJump(
     data: DhrProcessJumpRequest,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
-  // 转办
+  ): Promise<string>;
+  /**
+   * 转办
+   */
   postProcessReassign(
     data: DhrProcessReassignRequest,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
-  // 退回
+  ): Promise<string>;
+  /**
+   * 退回
+   */
   postProcessReturn(
     data: DhrProcessReturnRequest,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
+  ): Promise<string>;
 }

package/es/apaas/service/apis/dify-chat.service.d.ts

@@ -2,14 +2,18 @@ import type { AxiosRequestConfig } from 'axios';
 import type { DifyDocRequest, DifyChatRequest } from '../entities';
 
 export interface DifyChatService {
-  // 同步知识库
+  /**
+   * 同步知识库
+   */
   postAsyncDocument(
     data: DifyDocRequest,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
-  // 会话
+  ): Promise<string>;
+  /**
+   * 会话
+   */
   postChat(
     data: DifyChatRequest,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
+  ): Promise<string>;
 }

package/es/apaas/service/apis/doc-control-started.service.d.ts

@@ -2,36 +2,75 @@ import type { AxiosRequestConfig } from 'axios';
 import type { DocControlStartedResponse } from '../entities';
 
 export interface getInfoQuery {
-  id: string; // id
+  /**
+   * id
+   */
+  id: string;
 }
 export interface getListQuery {
-  categoryId?: string; // 分类ID
-  code?: string; // 文件编码
-  controlTmplType?: string; // 类型(EDHR,在线表单:FORM)
-  name?: string; // 文件名称
+  /**
+   * 分类ID
+   */
+  categoryId?: string;
+  /**
+   * 文件编码
+   */
+  code?: string;
+  /**
+   * 类型(EDHR,在线表单:FORM)
+   */
+  controlTmplType?: string;
+  /**
+   * 文件名称
+   */
+  name?: string;
 }
 export interface getPageListQuery {
-  categoryId?: string; // 分类ID
-  code?: string; // 文件编码
-  controlTmplType?: string; // 类型(EDHR,在线表单:FORM)
-  name?: string; // 文件名称
-  pageNo?: number; // 页码
-  pageSize?: number; // 每页数据条数
+  /**
+   * 分类ID
+   */
+  categoryId?: string;
+  /**
+   * 文件编码
+   */
+  code?: string;
+  /**
+   * 类型(EDHR,在线表单:FORM)
+   */
+  controlTmplType?: string;
+  /**
+   * 文件名称
+   */
+  name?: string;
+  /**
+   * 页码
+   */
+  pageNo?: number;
+  /**
+   * 每页数据条数
+   */
+  pageSize?: number;
 }
 export interface DocControlStartedService {
-  // 详情
+  /**
+   * 详情
+   */
   getInfo(
     query: getInfoQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<DocControlStartedResponse>>;
-  // 我发起的受控列表
+  ): Promise<DocControlStartedResponse>;
+  /**
+   * 我发起的受控列表
+   */
   getList(
     query: getListQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<DocControlStartedResponse[]>>;
-  // 我发起的受控分页列表
+  ): Promise<DocControlStartedResponse[]>;
+  /**
+   * 我发起的受控分页列表
+   */
   getPageList(
     query: getPageListQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<IPage<DocControlStartedResponse>>>;
+  ): Promise<IPage<DocControlStartedResponse>>;
 }

package/es/apaas/service/apis/doc-control-task-done.service.d.ts

@@ -2,36 +2,75 @@ import type { AxiosRequestConfig } from 'axios';
 import type { DocControlTaskDoneResponse } from '../entities';
 
 export interface getInfoQuery {
-  id: string; // id
+  /**
+   * id
+   */
+  id: string;
 }
 export interface getListQuery {
-  categoryId?: string; // 分类ID
-  code?: string; // 文件编码
-  controlTmplType?: string; // 类型(EDHR,在线表单:FORM)
-  name?: string; // 文件名称
+  /**
+   * 分类ID
+   */
+  categoryId?: string;
+  /**
+   * 文件编码
+   */
+  code?: string;
+  /**
+   * 类型(EDHR,在线表单:FORM)
+   */
+  controlTmplType?: string;
+  /**
+   * 文件名称
+   */
+  name?: string;
 }
 export interface getPageListQuery {
-  categoryId?: string; // 分类ID
-  code?: string; // 文件编码
-  controlTmplType?: string; // 类型(EDHR,在线表单:FORM)
-  name?: string; // 文件名称
-  pageNo?: number; // 页码
-  pageSize?: number; // 每页数据条数
+  /**
+   * 分类ID
+   */
+  categoryId?: string;
+  /**
+   * 文件编码
+   */
+  code?: string;
+  /**
+   * 类型(EDHR,在线表单:FORM)
+   */
+  controlTmplType?: string;
+  /**
+   * 文件名称
+   */
+  name?: string;
+  /**
+   * 页码
+   */
+  pageNo?: number;
+  /**
+   * 每页数据条数
+   */
+  pageSize?: number;
 }
 export interface DocControlTaskDoneService {
-  // 详情
+  /**
+   * 详情
+   */
   getInfo(
     query: getInfoQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<DocControlTaskDoneResponse>>;
-  // 受控历史列表
+  ): Promise<DocControlTaskDoneResponse>;
+  /**
+   * 受控历史列表
+   */
   getList(
     query: getListQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<DocControlTaskDoneResponse[]>>;
-  // 受控历史分页列表
+  ): Promise<DocControlTaskDoneResponse[]>;
+  /**
+   * 受控历史分页列表
+   */
   getPageList(
     query: getPageListQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<IPage<DocControlTaskDoneResponse>>>;
+  ): Promise<IPage<DocControlTaskDoneResponse>>;
 }

package/es/apaas/service/apis/doc-control-task-todo.service.d.ts

@@ -2,55 +2,120 @@ import type { AxiosRequestConfig } from 'axios';
 import type { DocControlTaskTodoResponse } from '../entities';
 
 export interface getAllUserPageListQuery {
-  categoryId?: string; // 分类ID
-  code?: string; // 文件编码
-  controlTmplType?: string; // 类型(EDHR,在线表单:FORM)
-  name?: string; // 文件名称
-  pageNo?: number; // 页码
-  pageSize?: number; // 分页大小
-  sortField?: string; // 排序字段
-  sortType?: string; // 排序方式：ASC/DESC， 不传默认 ASC
+  /**
+   * 分类ID
+   */
+  categoryId?: string;
+  /**
+   * 文件编码
+   */
+  code?: string;
+  /**
+   * 类型(EDHR,在线表单:FORM)
+   */
+  controlTmplType?: string;
+  /**
+   * 文件名称
+   */
+  name?: string;
+  /**
+   * 页码
+   */
+  pageNo?: number;
+  /**
+   * 分页大小
+   */
+  pageSize?: number;
+  /**
+   * 排序字段
+   */
+  sortField?: string;
+  /**
+   * 排序方式：ASC/DESC， 不传默认 ASC
+   */
+  sortType?: string;
 }
 export interface getInfoQuery {
-  id: string; // id
+  /**
+   * id
+   */
+  id: string;
 }
 export interface getListQuery {
-  categoryId?: string; // 分类ID
-  code?: string; // 文件编码
-  controlTmplType?: string; // 类型(EDHR,在线表单:FORM)
-  name?: string; // 文件名称
+  /**
+   * 分类ID
+   */
+  categoryId?: string;
+  /**
+   * 文件编码
+   */
+  code?: string;
+  /**
+   * 类型(EDHR,在线表单:FORM)
+   */
+  controlTmplType?: string;
+  /**
+   * 文件名称
+   */
+  name?: string;
 }
 export interface getPageListQuery {
-  categoryId?: string; // 分类ID
-  code?: string; // 文件编码
-  controlTmplType?: string; // 类型(EDHR,在线表单:FORM)
-  name?: string; // 文件名称
-  pageNo?: number; // 页码
-  pageSize?: number; // 每页数据条数
+  /**
+   * 分类ID
+   */
+  categoryId?: string;
+  /**
+   * 文件编码
+   */
+  code?: string;
+  /**
+   * 类型(EDHR,在线表单:FORM)
+   */
+  controlTmplType?: string;
+  /**
+   * 文件名称
+   */
+  name?: string;
+  /**
+   * 页码
+   */
+  pageNo?: number;
+  /**
+   * 每页数据条数
+   */
+  pageSize?: number;
 }
 export interface DocControlTaskTodoService {
-  // 所有人的分页列表
+  /**
+   * 所有人的分页列表
+   */
   getAllUserPageList(
     query: getAllUserPageListQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<IPage<DocControlTaskTodoResponse>>>;
-  // 待我受控数量
-  getCount(
-    config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<number>>;
-  // 详情
+  ): Promise<IPage<DocControlTaskTodoResponse>>;
+  /**
+   * 待我受控数量
+   */
+  getCount(config?: Partial<AxiosRequestConfig>): Promise<number>;
+  /**
+   * 详情
+   */
   getInfo(
     query: getInfoQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<DocControlTaskTodoResponse>>;
-  // 待我受控列表
+  ): Promise<DocControlTaskTodoResponse>;
+  /**
+   * 待我受控列表
+   */
   getList(
     query: getListQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<DocControlTaskTodoResponse[]>>;
-  // 待我受控分页列表
+  ): Promise<DocControlTaskTodoResponse[]>;
+  /**
+   * 待我受控分页列表
+   */
   getPageList(
     query: getPageListQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<IPage<DocControlTaskTodoResponse>>>;
+  ): Promise<IPage<DocControlTaskTodoResponse>>;
 }