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

package/es/platform/service/apis/sign-log.service.d.ts

@@ -7,48 +7,66 @@ import type {
 } from '../entities';
 
 export interface deleteQuery {
-  ids: string; // 删除的id，多个按','分割
+  /**
+   * 删除的id，多个按','分割
+   */
+  ids: string;
 }
 export interface getInfoQuery {
-  id: string; // id
+  /**
+   * id
+   */
+  id: string;
 }
-export interface putIdQuery {
-  id: string; // 数据主键
+export interface putIdPathParams {
+  id: string;
 }
 export interface SignLogService {
-  // 保存
+  /**
+   * 保存
+   */
   post(
     data: SignLogRequestDTO,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
-  // 删除
+  ): Promise<string>;
+  /**
+   * 删除
+   */
   delete(
     query: deleteQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
-  // 详情
+  ): Promise<string>;
+  /**
+   * 详情
+   */
   getInfo(
     query: getInfoQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<SignLogResponse>>;
-  // 列表
-  getList(
-    config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<SignLogResponse[]>>;
-  // 操作人
+  ): Promise<SignLogResponse>;
+  /**
+   * 列表
+   */
+  getList(config?: Partial<AxiosRequestConfig>): Promise<SignLogResponse[]>;
+  /**
+   * 操作人
+   */
   postOperators(
     data: SignLogRequest,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<UserInfo[]>>;
-  // 分页列表
+  ): Promise<UserInfo[]>;
+  /**
+   * 分页列表
+   */
   postPageList(
     data: SignLogRequest,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<IPage<SignLogResponse>>>;
-  // 修改
+  ): Promise<IPage<SignLogResponse>>;
+  /**
+   * 修改
+   */
   putId(
-    query: putIdQuery,
+    path: putIdPathParams,
     data: SignLogRequest,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
+  ): Promise<string>;
 }

package/es/platform/service/apis/sms.service.d.ts

@@ -2,14 +2,18 @@ import type { AxiosRequestConfig } from 'axios';
 import type { SmsDto } from '../entities';
 
 export interface SmsService {
-  // 获取短信功能的签名与短信模板
+  /**
+   * 获取短信功能的签名与短信模板
+   */
   postGetSignsAndTemplates(
     data: SmsDto,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<IObject>>;
-  // 发送短消息
+  ): Promise<IObject>;
+  /**
+   * 发送短消息
+   */
   postSendMsg(
     data: SmsDto,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
+  ): Promise<string>;
 }

package/es/platform/service/apis/started-process.service.d.ts

@@ -2,36 +2,63 @@ import type { AxiosRequestConfig } from 'axios';
 import type { StartedProcessResponse, AppProcess } from '../entities';
 
 export interface deleteQuery {
-  ids: string; // 删除的id，多个按','分割
+  /**
+   * 删除的id，多个按','分割
+   */
+  ids: string;
 }
 export interface getInfoQuery {
-  id: string; // id
+  /**
+   * id
+   */
+  id: string;
 }
 export interface getPageListQuery {
-  finished?: boolean; // 已完成
-  pageNo?: number; // 页码
-  pageSize?: number; // 每页数据条数
-  processId?: string; // 流程ID
-  processTitle?: string; // 流程标题
+  /**
+   * 已完成
+   */
+  finished?: boolean;
+  /**
+   * 页码
+   */
+  pageNo?: number;
+  /**
+   * 每页数据条数
+   */
+  pageSize?: number;
+  /**
+   * 流程ID
+   */
+  processId?: string;
+  /**
+   * 流程标题
+   */
+  processTitle?: string;
 }
 export interface StartedProcessService {
-  // 删除
+  /**
+   * 删除
+   */
   delete(
     query: deleteQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
-  // 详情
+  ): Promise<string>;
+  /**
+   * 详情
+   */
   getInfo(
     query: getInfoQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<StartedProcessResponse>>;
-  // 分页列表
+  ): Promise<StartedProcessResponse>;
+  /**
+   * 分页列表
+   */
   getPageList(
     query: getPageListQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<IPage<StartedProcessResponse>>>;
-  // 我的流程
-  getProcess(
-    config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<AppProcess[]>>;
+  ): Promise<IPage<StartedProcessResponse>>;
+  /**
+   * 我的流程
+   */
+  getProcess(config?: Partial<AxiosRequestConfig>): Promise<AppProcess[]>;
 }

package/es/platform/service/apis/task-delegate.service.d.ts

@@ -6,60 +6,96 @@ import type {
 } from '../entities';
 
 export interface deleteQuery {
-  ids: string; // 删除的id，多个按','分割
+  /**
+   * 删除的id，多个按','分割
+   */
+  ids: string;
+}
+export interface postCancelIdPathParams {
+  id: string;
 }
 export interface getInfoQuery {
-  id: string; // id
+  /**
+   * id
+   */
+  id: string;
 }
 export interface getListQuery {
-  valid?: boolean; // valid
+  /**
+   * valid
+   */
+  valid?: boolean;
 }
 export interface getPageListQuery {
-  pageNo?: number; // 页码
-  pageSize?: number; // 每页数据条数
-  valid?: boolean; // valid
+  /**
+   * 页码
+   */
+  pageNo?: number;
+  /**
+   * 每页数据条数
+   */
+  pageSize?: number;
+  /**
+   * valid
+   */
+  valid?: boolean;
 }
-export interface putIdQuery {
-  id: string; // 数据主键
+export interface putIdPathParams {
+  id: string;
 }
 export interface TaskDelegateService {
-  // 保存
+  /**
+   * 保存
+   */
   post(
     data: TaskDelegateRequest,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
-  // 删除
+  ): Promise<string>;
+  /**
+   * 删除
+   */
   delete(
     query: deleteQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
-  // 取消
+  ): Promise<string>;
+  /**
+   * 取消
+   */
   postCancelId(
+    path: postCancelIdPathParams,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
-  // 详情
+  ): Promise<string>;
+  /**
+   * 详情
+   */
   getInfo(
     query: getInfoQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<TaskDelegateResponse>>;
-  // 列表
+  ): Promise<TaskDelegateResponse>;
+  /**
+   * 列表
+   */
   getList(
     query: getListQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<TaskDelegateResponse[]>>;
-  // 分页列表
+  ): Promise<TaskDelegateResponse[]>;
+  /**
+   * 分页列表
+   */
   getPageList(
     query: getPageListQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<IPage<TaskDelegateResponse>>>;
-  // 我的流程
-  getProcess(
-    config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<AppProcess[]>>;
-  // 修改
+  ): Promise<IPage<TaskDelegateResponse>>;
+  /**
+   * 我的流程
+   */
+  getProcess(config?: Partial<AxiosRequestConfig>): Promise<AppProcess[]>;
+  /**
+   * 修改
+   */
   putId(
-    query: putIdQuery,
+    path: putIdPathParams,
     data: TaskDelegateRequest,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
+  ): Promise<string>;
 }

package/es/platform/service/apis/task-done.service.d.ts

@@ -2,35 +2,59 @@ import type { AxiosRequestConfig } from 'axios';
 import type { TaskDoneResponse, AppProcess } from '../entities';
 
 export interface deleteQuery {
-  ids: string; // 删除的id，多个按','分割
+  /**
+   * 删除的id，多个按','分割
+   */
+  ids: string;
 }
 export interface getInfoQuery {
-  id: string; // id
+  /**
+   * id
+   */
+  id: string;
 }
 export interface getPageListQuery {
-  finished?: boolean; // 已完成
-  pageNo?: number; // 页码
-  pageSize?: number; // 每页数据条数
-  processId?: string; // 流程ID
+  /**
+   * 已完成
+   */
+  finished?: boolean;
+  /**
+   * 页码
+   */
+  pageNo?: number;
+  /**
+   * 每页数据条数
+   */
+  pageSize?: number;
+  /**
+   * 流程ID
+   */
+  processId?: string;
 }
 export interface TaskDoneService {
-  // 删除
+  /**
+   * 删除
+   */
   delete(
     query: deleteQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
-  // 详情
+  ): Promise<string>;
+  /**
+   * 详情
+   */
   getInfo(
     query: getInfoQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<TaskDoneResponse>>;
-  // 分页列表
+  ): Promise<TaskDoneResponse>;
+  /**
+   * 分页列表
+   */
   getPageList(
     query: getPageListQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<IPage<TaskDoneResponse>>>;
-  // 我的流程
-  getProcess(
-    config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<AppProcess[]>>;
+  ): Promise<IPage<TaskDoneResponse>>;
+  /**
+   * 我的流程
+   */
+  getProcess(config?: Partial<AxiosRequestConfig>): Promise<AppProcess[]>;
 }

package/es/platform/service/apis/task-todo.service.d.ts

@@ -2,35 +2,59 @@ import type { AxiosRequestConfig } from 'axios';
 import type { TaskTodoResponse, AppProcess } from '../entities';
 
 export interface deleteQuery {
-  ids: string; // 删除的id，多个按','分割
+  /**
+   * 删除的id，多个按','分割
+   */
+  ids: string;
 }
 export interface getInfoQuery {
-  id: string; // id
+  /**
+   * id
+   */
+  id: string;
 }
 export interface getPageListQuery {
-  pageNo?: number; // 页码
-  pageSize?: number; // 每页数据条数
-  processId?: string; // 流程ID
-  processTitle?: string; // 流程标题
+  /**
+   * 页码
+   */
+  pageNo?: number;
+  /**
+   * 每页数据条数
+   */
+  pageSize?: number;
+  /**
+   * 流程ID
+   */
+  processId?: string;
+  /**
+   * 流程标题
+   */
+  processTitle?: string;
 }
 export interface TaskTodoService {
-  // 删除
+  /**
+   * 删除
+   */
   delete(
     query: deleteQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
-  // 详情
+  ): Promise<string>;
+  /**
+   * 详情
+   */
   getInfo(
     query: getInfoQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<TaskTodoResponse>>;
-  // 分页列表
+  ): Promise<TaskTodoResponse>;
+  /**
+   * 分页列表
+   */
   getPageList(
     query: getPageListQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<IPage<TaskTodoResponse>>>;
-  // 我的流程
-  getProcess(
-    config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<AppProcess[]>>;
+  ): Promise<IPage<TaskTodoResponse>>;
+  /**
+   * 我的流程
+   */
+  getProcess(config?: Partial<AxiosRequestConfig>): Promise<AppProcess[]>;
 }

package/es/platform/service/apis/tenant-developer.service.d.ts

@@ -7,66 +7,113 @@ import type {
 } from '../entities';
 
 export interface deleteQuery {
-  ids: string; // 删除的id，多个按','分割
+  /**
+   * 删除的id，多个按','分割
+   */
+  ids: string;
 }
 export interface getGetUserMaintainerAppQuery {
-  userId: string; // userId
+  /**
+   * userId
+   */
+  userId: string;
 }
 export interface getInfoQuery {
-  id: string; // id
+  /**
+   * id
+   */
+  id: string;
 }
 export interface getPageListQuery {
-  account?: string; // 账号
-  fullName?: string; // 名称
-  pageNo?: number; // 页码
-  pageSize?: number; // 分页大小
-  phone?: string; // 手机号
-  sortField?: string; // 排序字段
-  sortType?: string; // 排序方式：ASC/DESC， 不传默认 ASC
-  type?: string; // 类型
+  /**
+   * 账号
+   */
+  account?: string;
+  /**
+   * 名称
+   */
+  fullName?: string;
+  /**
+   * 页码
+   */
+  pageNo?: number;
+  /**
+   * 分页大小
+   */
+  pageSize?: number;
+  /**
+   * 手机号
+   */
+  phone?: string;
+  /**
+   * 排序字段
+   */
+  sortField?: string;
+  /**
+   * 排序方式：ASC/DESC， 不传默认 ASC
+   */
+  sortType?: string;
+  /**
+   * 类型
+   */
+  type?: string;
 }
-export interface putIdQuery {
-  id: string; // 数据主键
+export interface putIdPathParams {
+  id: string;
 }
 export interface TenantDeveloperService {
-  // 保存
+  /**
+   * 保存
+   */
   post(
     data: TenantDeveloperRequest,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
-  // 删除
+  ): Promise<string>;
+  /**
+   * 删除
+   */
   delete(
     query: deleteQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
-  // 移除并且交接
+  ): Promise<string>;
+  /**
+   * 移除并且交接
+   */
   postRemoveAndHandover(
     data: RemoveAndHandoverRequest,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
-  // 查询人员是否有维护的应用
+  ): Promise<string>;
+  /**
+   * 查询人员是否有维护的应用
+   */
   getGetUserMaintainerApp(
     query: getGetUserMaintainerAppQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<AppMemberPO[]>>;
-  // 详情
+  ): Promise<AppMemberPO[]>;
+  /**
+   * 详情
+   */
   getInfo(
     query: getInfoQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<TenantDeveloperDTO>>;
-  // 列表
-  getList(
-    config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<TenantDeveloperDTO[]>>;
-  // 分页列表
+  ): Promise<TenantDeveloperDTO>;
+  /**
+   * 列表
+   */
+  getList(config?: Partial<AxiosRequestConfig>): Promise<TenantDeveloperDTO[]>;
+  /**
+   * 分页列表
+   */
   getPageList(
     query: getPageListQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<IPage<TenantDeveloperDTO>>>;
-  // 修改
+  ): Promise<IPage<TenantDeveloperDTO>>;
+  /**
+   * 修改
+   */
   putId(
-    query: putIdQuery,
+    path: putIdPathParams,
     data: TenantDeveloperRequest,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
+  ): Promise<string>;
 }