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

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

@@ -6,41 +6,82 @@ import type {
 } from '../entities';
 
 export interface getClientsQuery {
-  appId: string; // appId
+  /**
+   * appId
+   */
+  appId: string;
 }
 export interface getExitQuery {
-  clientId?: string; // clientId
+  /**
+   * clientId
+   */
+  clientId?: string;
 }
 export interface getMaxOnlineUserQuery {
-  detail?: boolean; // 返回详细数据
-  endTime?: string; // 截止时间
-  startTime?: string; // 开始时间
+  /**
+   * 返回详细数据
+   */
+  detail?: boolean;
+  /**
+   * 截止时间
+   */
+  endTime?: string;
+  /**
+   * 开始时间
+   */
+  startTime?: string;
 }
 export interface getPageListQuery {
-  clientType?: string; // 客户端类型
-  fullname?: string; // 姓名
-  pageNo?: number; // 页码
-  pageSize?: number; // 每页数据条数
-  userAuthType?: number; // 用户授权类型 0 授权用户 1被共享用户
-  username?: string; // 账号
+  /**
+   * 客户端类型
+   */
+  clientType?: string;
+  /**
+   * 姓名
+   */
+  fullname?: string;
+  /**
+   * 页码
+   */
+  pageNo?: number;
+  /**
+   * 每页数据条数
+   */
+  pageSize?: number;
+  /**
+   * 用户授权类型 0 授权用户 1被共享用户
+   */
+  userAuthType?: number;
+  /**
+   * 账号
+   */
+  username?: string;
 }
 export interface OnlineService {
-  // 获取在线客户端
+  /**
+   * 获取在线客户端
+   */
   getClients(
     query: getClientsQuery,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<ClientsDto[]>;
-  // 踢出
+  /**
+   * 踢出
+   */
   getExit(
     query: getExitQuery,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<boolean>;
-  // 获取在线用户峰值数据
+  /**
+   * 获取在线用户峰值数据
+   */
   getMaxOnlineUser(
     query: getMaxOnlineUserQuery,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<OnlineUserSummary>;
-  // 在线用户列表
+  /**
+   * 在线用户列表
+   */
   getPageList(
     query: getPageListQuery,
     config?: Partial<AxiosRequestConfig>,

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

@@ -2,55 +2,95 @@ import type { AxiosRequestConfig } from 'axios';
 import type { OpenapiRequest, ApiInfo, OpenapiResponse } from '../entities';
 
 export interface deleteQuery {
-  ids: string; // 删除的id，多个按','分割
+  /**
+   * 删除的id，多个按','分割
+   */
+  ids: string;
 }
 export interface getGetApiInfoQuery {
-  id: string; // id
+  /**
+   * id
+   */
+  id: string;
 }
 export interface getInfoQuery {
-  id: string; // id
+  /**
+   * id
+   */
+  id: string;
 }
 export interface getPageListQuery {
-  key?: string; // key
-  modelKey?: string; // modelKey
-  name?: string; // name
-  pageNo?: number; // pageNo
-  pageSize?: number; // pageSize
+  /**
+   * key
+   */
+  key?: string;
+  /**
+   * modelKey
+   */
+  modelKey?: string;
+  /**
+   * name
+   */
+  name?: string;
+  /**
+   * pageNo
+   */
+  pageNo?: number;
+  /**
+   * pageSize
+   */
+  pageSize?: number;
 }
 export interface putIdPathParams {
   id: string;
 }
 export interface OpenapiService {
-  // 保存
+  /**
+   * 保存
+   */
   post(
     data: OpenapiRequest,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<string>;
-  // 删除
+  /**
+   * 删除
+   */
   delete(
     query: deleteQuery,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<string>;
-  // 单个api详情
+  /**
+   * 单个api详情
+   */
   getGetApiInfo(
     query: getGetApiInfoQuery,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<ApiInfo>;
-  // 所有api详情
+  /**
+   * 所有api详情
+   */
   getGetApiInfos(config?: Partial<AxiosRequestConfig>): Promise<ApiInfo[]>;
-  // 详情
+  /**
+   * 详情
+   */
   getInfo(
     query: getInfoQuery,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<OpenapiResponse>;
-  // 列表
+  /**
+   * 列表
+   */
   getList(config?: Partial<AxiosRequestConfig>): Promise<OpenapiResponse[]>;
-  // 分页列表
+  /**
+   * 分页列表
+   */
   getPageList(
     query: getPageListQuery,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<IPage<OpenapiResponse>>;
-  // 修改
+  /**
+   * 修改
+   */
   putId(
     path: putIdPathParams,
     data: OpenapiRequest,

package/es/apaas/service/apis/pad-page.service.d.ts

@@ -6,26 +6,65 @@ import type {
 } from '../entities';
 
 export interface deleteQuery {
-  ids: string; // 删除的id，多个按','分割
+  /**
+   * 删除的id，多个按','分割
+   */
+  ids: string;
 }
 export interface postCopyByIdIdPathParams {
   id: string;
 }
 export interface getInfoQuery {
-  id: string; // id
-  type?: number; // type
+  /**
+   * id
+   */
+  id: string;
+  /**
+   * type
+   */
+  type?: number;
 }
 export interface getPageListQuery {
-  description?: string; // 页面描述
-  endTime?: string; // 结束时间
-  id?: string; // 主键id
-  key?: string; // 页面key
-  name?: string; // 页面名称
-  pageNo?: number; // 页码
-  pageSize?: number; // 分页大小
-  sortField?: string; // 排序字段
-  sortType?: string; // 排序方式：ASC/DESC， 不传默认 ASC
-  startTime?: string; // 开始时间
+  /**
+   * 页面描述
+   */
+  description?: string;
+  /**
+   * 结束时间
+   */
+  endTime?: string;
+  /**
+   * 主键id
+   */
+  id?: string;
+  /**
+   * 页面key
+   */
+  key?: string;
+  /**
+   * 页面名称
+   */
+  name?: string;
+  /**
+   * 页码
+   */
+  pageNo?: number;
+  /**
+   * 分页大小
+   */
+  pageSize?: number;
+  /**
+   * 排序字段
+   */
+  sortField?: string;
+  /**
+   * 排序方式：ASC/DESC， 不传默认 ASC
+   */
+  sortType?: string;
+  /**
+   * 开始时间
+   */
+  startTime?: string;
 }
 export interface putUpdateDesignerJsonIdPathParams {
   id: string;
@@ -34,41 +73,57 @@ export interface putIdPathParams {
   id: string;
 }
 export interface PadPageService {
-  // 保存
+  /**
+   * 保存
+   */
   post(
     data: PadPageRequest,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<string>;
-  // 删除
+  /**
+   * 删除
+   */
   delete(
     query: deleteQuery,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<string>;
-  // 复制页面
+  /**
+   * 复制页面
+   */
   postCopyByIdId(
     path: postCopyByIdIdPathParams,
     data: PadPageRequest,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<string>;
-  // 详情
+  /**
+   * 详情
+   */
   getInfo(
     query: getInfoQuery,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<PadPageResponse>;
-  // 列表
+  /**
+   * 列表
+   */
   getList(config?: Partial<AxiosRequestConfig>): Promise<PadPageResponse[]>;
-  // 分页列表
+  /**
+   * 分页列表
+   */
   getPageList(
     query: getPageListQuery,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<IPage<PadPageResponse>>;
-  // 修改页面设计Json
+  /**
+   * 修改页面设计Json
+   */
   putUpdateDesignerJsonId(
     path: putUpdateDesignerJsonIdPathParams,
     data: WebpageDesignerJsonRequest,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<string>;
-  // 修改
+  /**
+   * 修改
+   */
   putId(
     path: putIdPathParams,
     data: PadPageRequest,

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

@@ -5,52 +5,100 @@ import type {
 } from '../entities';
 
 export interface deleteQuery {
-  ids: string; // 删除的id，多个按','分割
+  /**
+   * 删除的id，多个按','分割
+   */
+  ids: string;
 }
 export interface getInfoQuery {
-  id: string; // id
+  /**
+   * id
+   */
+  id: string;
 }
 export interface getPageListQuery {
-  endTime?: string; // 结束时间
-  id?: string; // 主键id
-  name?: string; // 页面名称
-  pageNo?: number; // 页码
-  pageSize?: number; // 分页大小
-  relationId?: string; // 管理数据id
-  relationType?: number; // 类型（1 web、2 pda 、3 pad）
-  sortField?: string; // 排序字段
-  sortType?: string; // 排序方式：ASC/DESC， 不传默认 ASC
-  startTime?: string; // 开始时间
+  /**
+   * 结束时间
+   */
+  endTime?: string;
+  /**
+   * 主键id
+   */
+  id?: string;
+  /**
+   * 页面名称
+   */
+  name?: string;
+  /**
+   * 页码
+   */
+  pageNo?: number;
+  /**
+   * 分页大小
+   */
+  pageSize?: number;
+  /**
+   * 管理数据id
+   */
+  relationId?: string;
+  /**
+   * 类型（1 web、2 pda 、3 pad）
+   */
+  relationType?: number;
+  /**
+   * 排序字段
+   */
+  sortField?: string;
+  /**
+   * 排序方式：ASC/DESC， 不传默认 ASC
+   */
+  sortType?: string;
+  /**
+   * 开始时间
+   */
+  startTime?: string;
 }
 export interface putIdPathParams {
   id: string;
 }
 export interface PageDesignerLogService {
-  // 保存
+  /**
+   * 保存
+   */
   post(
     data: PageDesignerLogRequest,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<string>;
-  // 删除
+  /**
+   * 删除
+   */
   delete(
     query: deleteQuery,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<string>;
-  // 详情
+  /**
+   * 详情
+   */
   getInfo(
     query: getInfoQuery,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<PageDesignerLogResponse>;
-  // 列表
+  /**
+   * 列表
+   */
   getList(
     config?: Partial<AxiosRequestConfig>,
   ): Promise<PageDesignerLogResponse[]>;
-  // 分页列表
+  /**
+   * 分页列表
+   */
   getPageList(
     query: getPageListQuery,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<IPage<PageDesignerLogResponse>>;
-  // 修改
+  /**
+   * 修改
+   */
   putId(
     path: putIdPathParams,
     data: PageDesignerLogRequest,

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

@@ -2,48 +2,75 @@ import type { AxiosRequestConfig } from 'axios';
 import type { PermissionRequest, PermissionResponse } from '../entities';
 
 export interface deleteQuery {
-  ids: string; // 删除的id，多个按','分割
+  /**
+   * 删除的id，多个按','分割
+   */
+  ids: string;
 }
 export interface getInfoQuery {
-  id: string; // id
+  /**
+   * id
+   */
+  id: string;
 }
 export interface getListQuery {
-  relationId?: string; //
+  /**
+   *
+   */
+  relationId?: string;
 }
 export interface getPageListQuery {
-  pageNo?: number; // 页码
-  pageSize?: number; // 每页数据条数
+  /**
+   * 页码
+   */
+  pageNo?: number;
+  /**
+   * 每页数据条数
+   */
+  pageSize?: number;
 }
 export interface putIdPathParams {
   id: string;
 }
 export interface PermissionService {
-  // 保存
+  /**
+   * 保存
+   */
   post(
     data: PermissionRequest,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<string>;
-  // 删除
+  /**
+   * 删除
+   */
   delete(
     query: deleteQuery,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<string>;
-  // 详情
+  /**
+   * 详情
+   */
   getInfo(
     query: getInfoQuery,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<PermissionResponse>;
-  // 列表
+  /**
+   * 列表
+   */
   getList(
     query: getListQuery,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<PermissionResponse[]>;
-  // 分页列表
+  /**
+   * 分页列表
+   */
   getPageList(
     query: getPageListQuery,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<IPage<PermissionResponse>>;
-  // 修改
+  /**
+   * 修改
+   */
   putId(
     path: putIdPathParams,
     data: PermissionRequest,

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

@@ -8,26 +8,36 @@ import type {
 } from '../entities';
 
 export interface PlatService {
-  // 应用全局配置设置 保存/更新
+  /**
+   * 应用全局配置设置 保存/更新
+   */
   postAppGlobal(
     data: SysConfigRequest,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<string>;
-  // 应用全局配置设置 查询
+  /**
+   * 应用全局配置设置 查询
+   */
   getAppGlobalInfo(
     config?: Partial<AxiosRequestConfig>,
   ): Promise<SysConfigResponse>;
-  // 基础设置 保存/更新
+  /**
+   * 基础设置 保存/更新
+   */
   postBase(
     data: PlatformBaseConfig,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<string>;
-  // 组织设置 保存/更新
+  /**
+   * 组织设置 保存/更新
+   */
   postOrg(
     data: OrgConfig,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<string>;
-  // 安全设置 保存/更新
+  /**
+   * 安全设置 保存/更新
+   */
   postSecurity(
     data: SecurityConfig,
     config?: Partial<AxiosRequestConfig>,

package/es/apaas/service/apis/pm-process-definition-version.service.d.ts

@@ -7,62 +7,89 @@ import type {
 } from '../entities';
 
 export interface deleteQuery {
-  ids: string; // 删除的id，多个按','分割
+  /**
+   * 删除的id，多个按','分割
+   */
+  ids: string;
 }
 export interface postCopyIdPathParams {
   id: string;
 }
 export interface postDeployQuery {
-  procVerId?: string; // procVerId
+  /**
+   * procVerId
+   */
+  procVerId?: string;
 }
 export interface getListQuery {
-  procDefId: string; // 流程定义id(表单版本id)
+  /**
+   * 流程定义id(表单版本id)
+   */
+  procDefId: string;
 }
 export interface getIdPathParams {
   id: string;
 }
 export interface PmProcessDefinitionVersionService {
-  // 新建版本
+  /**
+   * 新建版本
+   */
   post(
     data: PmProcessDefinitionVersionRequest,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<string>;
-  // 删除
+  /**
+   * 删除
+   */
   delete(
     query: deleteQuery,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<boolean>;
-  // 复制
+  /**
+   * 复制
+   */
   postCopyId(
     path: postCopyIdPathParams,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<string>;
-  // 发布
+  /**
+   * 发布
+   */
   postDeploy(
     query: postDeployQuery,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<string>;
-  // 列表
+  /**
+   * 列表
+   */
   getList(
     query: getListQuery,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<ProcessDefinitionVerListResponse[]>;
-  // 保存
+  /**
+   * 保存
+   */
   postSave(
     data: PmProcessDefinitionVersionRequest,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<string>;
-  // 保存并发布
+  /**
+   * 保存并发布
+   */
   postSaveAndDeploy(
     data: PmProcessDefinitionVersionRequest,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<string>;
-  // 保存审批人和消息接收人
+  /**
+   * 保存审批人和消息接收人
+   */
   postUpdateProcessUser(
     data: ProcessUserRequest,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<string>;
-  // 详情
+  /**
+   * 详情
+   */
   getId(
     path: getIdPathParams,
     config?: Partial<AxiosRequestConfig>,