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

package/es/apaas/service/apis/online-user-summary.service.d.ts

@@ -5,47 +5,71 @@ 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 {
-  pageNo?: number; // 页码
-  pageSize?: number; // 每页数据条数
+  /**
+   * 页码
+   */
+  pageNo?: number;
+  /**
+   * 每页数据条数
+   */
+  pageSize?: number;
 }
-export interface putIdQuery {
-  id: string; // 数据主键
+export interface putIdPathParams {
+  id: string;
 }
 export interface OnlineUserSummaryService {
-  // 保存
+  /**
+   * 保存
+   */
   post(
     data: OnlineUserSummaryRequest,
     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<OnlineUserSummaryResponse>>;
-  // 列表
+  ): Promise<OnlineUserSummaryResponse>;
+  /**
+   * 列表
+   */
   getList(
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<OnlineUserSummaryResponse[]>>;
-  // 分页列表
+  ): Promise<OnlineUserSummaryResponse[]>;
+  /**
+   * 分页列表
+   */
   getPageList(
     query: getPageListQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<IPage<OnlineUserSummaryResponse>>>;
-  // 修改
+  ): Promise<IPage<OnlineUserSummaryResponse>>;
+  /**
+   * 修改
+   */
   putId(
-    query: putIdQuery,
+    path: putIdPathParams,
     data: OnlineUserSummaryRequest,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
+  ): Promise<string>;
 }

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

@@ -6,43 +6,84 @@ 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<IHttpResponse<ClientsDto[]>>;
-  // 踢出
+  ): Promise<ClientsDto[]>;
+  /**
+   * 踢出
+   */
   getExit(
     query: getExitQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<boolean>>;
-  // 获取在线用户峰值数据
+  ): Promise<boolean>;
+  /**
+   * 获取在线用户峰值数据
+   */
   getMaxOnlineUser(
     query: getMaxOnlineUserQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<OnlineUserSummary>>;
-  // 在线用户列表
+  ): Promise<OnlineUserSummary>;
+  /**
+   * 在线用户列表
+   */
   getPageList(
     query: getPageListQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<IPage<OnlineUsersResponse>>>;
+  ): Promise<IPage<OnlineUsersResponse>>;
 }

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

@@ -2,62 +2,98 @@ 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 putIdQuery {
-  id: string; // 数据主键
+export interface putIdPathParams {
+  id: string;
 }
 export interface OpenapiService {
-  // 保存
+  /**
+   * 保存
+   */
   post(
     data: OpenapiRequest,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
-  // 删除
+  ): Promise<string>;
+  /**
+   * 删除
+   */
   delete(
     query: deleteQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
-  // 单个api详情
+  ): Promise<string>;
+  /**
+   * 单个api详情
+   */
   getGetApiInfo(
     query: getGetApiInfoQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<ApiInfo>>;
-  // 所有api详情
-  getGetApiInfos(
-    config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<ApiInfo[]>>;
-  // 详情
+  ): Promise<ApiInfo>;
+  /**
+   * 所有api详情
+   */
+  getGetApiInfos(config?: Partial<AxiosRequestConfig>): Promise<ApiInfo[]>;
+  /**
+   * 详情
+   */
   getInfo(
     query: getInfoQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<OpenapiResponse>>;
-  // 列表
-  getList(
-    config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<OpenapiResponse[]>>;
-  // 分页列表
+  ): Promise<OpenapiResponse>;
+  /**
+   * 列表
+   */
+  getList(config?: Partial<AxiosRequestConfig>): Promise<OpenapiResponse[]>;
+  /**
+   * 分页列表
+   */
   getPageList(
     query: getPageListQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<IPage<OpenapiResponse>>>;
-  // 修改
+  ): Promise<IPage<OpenapiResponse>>;
+  /**
+   * 修改
+   */
   putId(
-    query: putIdQuery,
+    path: putIdPathParams,
     data: OpenapiRequest,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
+  ): Promise<string>;
 }

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

@@ -6,66 +6,127 @@ 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;
 }
-export interface putIdQuery {
-  id: string; // 数据主键
+export interface putIdPathParams {
+  id: string;
 }
 export interface PadPageService {
-  // 保存
+  /**
+   * 保存
+   */
   post(
     data: PadPageRequest,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
-  // 删除
+  ): Promise<string>;
+  /**
+   * 删除
+   */
   delete(
     query: deleteQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
-  // 复制页面
+  ): Promise<string>;
+  /**
+   * 复制页面
+   */
   postCopyByIdId(
+    path: postCopyByIdIdPathParams,
     data: PadPageRequest,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
-  // 详情
+  ): Promise<string>;
+  /**
+   * 详情
+   */
   getInfo(
     query: getInfoQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<PadPageResponse>>;
-  // 列表
-  getList(
-    config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<PadPageResponse[]>>;
-  // 分页列表
+  ): Promise<PadPageResponse>;
+  /**
+   * 列表
+   */
+  getList(config?: Partial<AxiosRequestConfig>): Promise<PadPageResponse[]>;
+  /**
+   * 分页列表
+   */
   getPageList(
     query: getPageListQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<IPage<PadPageResponse>>>;
-  // 修改页面设计Json
+  ): Promise<IPage<PadPageResponse>>;
+  /**
+   * 修改页面设计Json
+   */
   putUpdateDesignerJsonId(
+    path: putUpdateDesignerJsonIdPathParams,
     data: WebpageDesignerJsonRequest,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
-  // 修改
+  ): Promise<string>;
+  /**
+   * 修改
+   */
   putId(
-    query: putIdQuery,
+    path: putIdPathParams,
     data: PadPageRequest,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
+  ): Promise<string>;
 }

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

@@ -5,55 +5,103 @@ 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 putIdQuery {
-  id: string; // 数据主键
+export interface putIdPathParams {
+  id: string;
 }
 export interface PageDesignerLogService {
-  // 保存
+  /**
+   * 保存
+   */
   post(
     data: PageDesignerLogRequest,
     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<PageDesignerLogResponse>>;
-  // 列表
+  ): Promise<PageDesignerLogResponse>;
+  /**
+   * 列表
+   */
   getList(
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<PageDesignerLogResponse[]>>;
-  // 分页列表
+  ): Promise<PageDesignerLogResponse[]>;
+  /**
+   * 分页列表
+   */
   getPageList(
     query: getPageListQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<IPage<PageDesignerLogResponse>>>;
-  // 修改
+  ): Promise<IPage<PageDesignerLogResponse>>;
+  /**
+   * 修改
+   */
   putId(
-    query: putIdQuery,
+    path: putIdPathParams,
     data: PageDesignerLogRequest,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
+  ): Promise<string>;
 }