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

package/lib/apaas/service/apis/merge-log.service.d.ts

@@ -2,38 +2,52 @@ import type { AxiosRequestConfig } from 'axios';
 import type { MergeLogRequest, MergeLogResponse } 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 MergeLogService {
-  // 保存
+  /**
+   * 保存
+   */
   post(
     data: MergeLogRequest,
     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<MergeLogResponse>>;
-  // 列表
-  getList(
-    config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<MergeLogResponse[]>>;
-  // 修改
+  ): Promise<MergeLogResponse>;
+  /**
+   * 列表
+   */
+  getList(config?: Partial<AxiosRequestConfig>): Promise<MergeLogResponse[]>;
+  /**
+   * 修改
+   */
   putId(
-    query: putIdQuery,
+    path: putIdPathParams,
     data: MergeLogRequest,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
+  ): Promise<string>;
 }

package/lib/apaas/service/apis/message-record.service.d.ts

@@ -2,48 +2,100 @@ import type { AxiosRequestConfig } from 'axios';
 import type { MessageRecordRequest, MessageRecordResponse } 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; // endTime
-  formSerialNo?: string; // formSerialNo
-  modelName?: string; // modelName
-  pageNo?: number; // 页码
-  pageSize?: number; // 每页数据条数
-  pushType?: string; // pushType
-  result?: string; // result
-  startTime?: string; // startTime
-  tmplKey?: string; // tmplKey
-  tmplName?: string; // tmplName
-  userId?: string; // userId
-  userName?: string; // userName
+  /**
+   * endTime
+   */
+  endTime?: string;
+  /**
+   * formSerialNo
+   */
+  formSerialNo?: string;
+  /**
+   * modelName
+   */
+  modelName?: string;
+  /**
+   * 页码
+   */
+  pageNo?: number;
+  /**
+   * 每页数据条数
+   */
+  pageSize?: number;
+  /**
+   * pushType
+   */
+  pushType?: string;
+  /**
+   * result
+   */
+  result?: string;
+  /**
+   * startTime
+   */
+  startTime?: string;
+  /**
+   * tmplKey
+   */
+  tmplKey?: string;
+  /**
+   * tmplName
+   */
+  tmplName?: string;
+  /**
+   * userId
+   */
+  userId?: string;
+  /**
+   * userName
+   */
+  userName?: string;
 }
 export interface MessageRecordService {
-  // 保存
+  /**
+   * 保存
+   */
   post(
     data: MessageRecordRequest,
     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<MessageRecordResponse>>;
-  // 列表
+  ): Promise<MessageRecordResponse>;
+  /**
+   * 列表
+   */
   getList(
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<MessageRecordResponse[]>>;
-  // 分页列表
+  ): Promise<MessageRecordResponse[]>;
+  /**
+   * 分页列表
+   */
   getPageList(
     query: getPageListQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<IPage<MessageRecordResponse>>>;
+  ): Promise<IPage<MessageRecordResponse>>;
 }

package/lib/apaas/service/apis/message-setting.service.d.ts

@@ -2,17 +2,24 @@ import type { AxiosRequestConfig } from 'axios';
 import type { 消息设置VO, 发送消息DTO } from '../entities';
 
 export interface getFindAllByTypeQuery {
-  type: string; // type
+  /**
+   * type
+   */
+  type: string;
 }
 export interface MessageSettingService {
-  // 根据类型获取消息设置列表 email 邮箱 dingtalk 钉钉 wecom 企业微信 feishu 飞书 system 站内信
+  /**
+   * 根据类型获取消息设置列表 email 邮箱 dingtalk 钉钉 wecom 企业微信 feishu 飞书 system 站内信
+   */
   getFindAllByType(
     query: getFindAllByTypeQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<消息设置VO[]>>;
-  // 发送企业微信、钉钉、飞书、站内、邮件消息
+  ): Promise<消息设置VO[]>;
+  /**
+   * 发送企业微信、钉钉、飞书、站内、邮件消息
+   */
   postSendMessageByType(
     data: 发送消息DTO,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<boolean>>;
+  ): Promise<boolean>;
 }

package/lib/apaas/service/apis/message-tmpl.service.d.ts

@@ -7,67 +7,110 @@ import type {
 } from '../entities';
 
 export interface deleteQuery {
-  ids: string; // 删除的id，多个按','分割
+  /**
+   * 删除的id，多个按','分割
+   */
+  ids: string;
 }
 export interface getListByModelKeyQuery {
-  modelKey: string; // modelKey
+  /**
+   * modelKey
+   */
+  modelKey: string;
 }
 export interface getPageListQuery {
-  key?: string; // key
-  modelName?: string; // modelName
-  name?: string; // name
-  opened?: number; // opened
-  pageNo?: number; // 页码
-  pageSize?: number; // 每页数据条数
-  type?: string; // type
+  /**
+   * key
+   */
+  key?: string;
+  /**
+   * modelName
+   */
+  modelName?: string;
+  /**
+   * name
+   */
+  name?: string;
+  /**
+   * opened
+   */
+  opened?: number;
+  /**
+   * 页码
+   */
+  pageNo?: number;
+  /**
+   * 每页数据条数
+   */
+  pageSize?: number;
+  /**
+   * type
+   */
+  type?: string;
 }
-export interface putIdQuery {
-  id: string; // 数据主键
+export interface putIdPathParams {
+  id: string;
 }
 export interface MessageTmplService {
-  // 保存
+  /**
+   * 保存
+   */
   post(
     data: MessageTmplRequest,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
-  // 删除
+  ): Promise<string>;
+  /**
+   * 删除
+   */
   delete(
     query: deleteQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
-  // 列表
-  getList(
-    config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<MessageTmplResponse[]>>;
-  // 通过模型key筛选消息模板
+  ): Promise<string>;
+  /**
+   * 列表
+   */
+  getList(config?: Partial<AxiosRequestConfig>): Promise<MessageTmplResponse[]>;
+  /**
+   * 通过模型key筛选消息模板
+   */
   getListByModelKey(
     query: getListByModelKeyQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<MessageTmplResponse[]>>;
-  // 公开和不公开
+  ): Promise<MessageTmplResponse[]>;
+  /**
+   * 公开和不公开
+   */
   putOpened(
     data: MessageTmplOpenedRequest,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
-  // 分页列表
+  ): Promise<string>;
+  /**
+   * 分页列表
+   */
   getPageList(
     query: getPageListQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<IPage<MessageTmplResponse>>>;
-  // 审核流程发送消息
+  ): Promise<IPage<MessageTmplResponse>>;
+  /**
+   * 审核流程发送消息
+   */
   postProcessSend(
     data: MessageTmplSendRequest,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
-  // 测试发送消息
+  ): Promise<string>;
+  /**
+   * 测试发送消息
+   */
   postSend(
     data: MessageTmplSendRequest,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
-  // 修改
+  ): Promise<string>;
+  /**
+   * 修改
+   */
   putId(
-    query: putIdQuery,
+    path: putIdPathParams,
     data: MessageTmplRequest,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
+  ): Promise<string>;
 }

package/lib/apaas/service/apis/mobile-homepage.service.d.ts

@@ -6,61 +6,95 @@ 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 putUpdateDesignerJsonIdPathParams {
+  id: string;
+}
+export interface putIdPathParams {
+  id: string;
 }
 export interface MobileHomepageService {
-  // 保存
+  /**
+   * 保存
+   */
   post(
     data: MobileHomepageRequest,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
-  // 删除
+  ): Promise<string>;
+  /**
+   * 删除
+   */
   delete(
     query: deleteQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
-  // 查询选中的
+  ): Promise<string>;
+  /**
+   * 查询选中的
+   */
   getGetSelected(
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<MobileHomepageResponse>>;
-  // 详情
+  ): Promise<MobileHomepageResponse>;
+  /**
+   * 详情
+   */
   getInfo(
     query: getInfoQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<MobileHomepageResponse>>;
-  // 列表
+  ): Promise<MobileHomepageResponse>;
+  /**
+   * 列表
+   */
   getList(
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<MobileHomepageResponse[]>>;
-  // 分页列表
+  ): Promise<MobileHomepageResponse[]>;
+  /**
+   * 分页列表
+   */
   getPageList(
     query: getPageListQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<IPage<MobileHomepageResponse>>>;
-  // 选中页面，不传id代表都不选中
+  ): Promise<IPage<MobileHomepageResponse>>;
+  /**
+   * 选中页面，不传id代表都不选中
+   */
   postSelect(
     data: SingleRequest,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
-  // 修改页面设计Json
+  ): Promise<string>;
+  /**
+   * 修改页面设计Json
+   */
   putUpdateDesignerJsonId(
+    path: putUpdateDesignerJsonIdPathParams,
     data: MobileHomepageRequest,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
-  // 修改
+  ): Promise<string>;
+  /**
+   * 修改
+   */
   putId(
-    query: putIdQuery,
+    path: putIdPathParams,
     data: MobileHomepageRequest,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
+  ): Promise<string>;
 }

package/lib/apaas/service/apis/mobile-page.service.d.ts

@@ -7,66 +7,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 MobilePageService {
-  // 保存
+  /**
+   * 保存
+   */
   post(
     data: MobilePageRequest,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
-  // 删除
+  ): Promise<string>;
+  /**
+   * 删除
+   */
   delete(
     query: deleteQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
-  // 复制页面
+  ): Promise<string>;
+  /**
+   * 复制页面
+   */
   postCopyByIdId(
+    path: postCopyByIdIdPathParams,
     data: WebpageRequest,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
-  // 详情
+  ): Promise<string>;
+  /**
+   * 详情
+   */
   getInfo(
     query: getInfoQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<MobilePageResponse>>;
-  // 列表
-  getList(
-    config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<MobilePageResponse[]>>;
-  // 分页列表
+  ): Promise<MobilePageResponse>;
+  /**
+   * 列表
+   */
+  getList(config?: Partial<AxiosRequestConfig>): Promise<MobilePageResponse[]>;
+  /**
+   * 分页列表
+   */
   getPageList(
     query: getPageListQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<IPage<MobilePageResponse>>>;
-  // 修改webPage页面设计Json
+  ): Promise<IPage<MobilePageResponse>>;
+  /**
+   * 修改webPage页面设计Json
+   */
   putUpdateDesignerJsonId(
+    path: putUpdateDesignerJsonIdPathParams,
     data: WebpageDesignerJsonRequest,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
-  // 修改
+  ): Promise<string>;
+  /**
+   * 修改
+   */
   putId(
-    query: putIdQuery,
+    path: putIdPathParams,
     data: MobilePageRequest,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
+  ): Promise<string>;
 }