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

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

@@ -2,17 +2,37 @@ import type { AxiosRequestConfig } from 'axios';
 import type { LoginLogResponse } from '../entities';
 
 export interface getPageListQuery {
-  endTime?: string; // 截止时间
-  ip?: string; // IP地址
-  pageNo?: number; // 页码
-  pageSize?: number; // 每页数据条数
-  sourceEnum?: string; // 客户端
-  startTime?: string; // 开始时间
+  /**
+   * 截止时间
+   */
+  endTime?: string;
+  /**
+   * IP地址
+   */
+  ip?: string;
+  /**
+   * 页码
+   */
+  pageNo?: number;
+  /**
+   * 每页数据条数
+   */
+  pageSize?: number;
+  /**
+   * 客户端
+   */
+  sourceEnum?: string;
+  /**
+   * 开始时间
+   */
+  startTime?: string;
 }
 export interface LoginLogService {
-  // 登录足迹分页列表
+  /**
+   * 登录足迹分页列表
+   */
   getPageList(
     query: getPageListQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<IPage<LoginLogResponse>>>;
+  ): Promise<IPage<LoginLogResponse>>;
 }

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

@@ -7,39 +7,67 @@ import type {
 } from '../entities';
 
 export interface getSignOutQuery {
-  appId?: string; // 应用id
-  clientId?: string; // 应用id
-  env?: string; // 应用环境
-  platform?: string; // 页面SystemTypeEnum
+  /**
+   * 应用id
+   */
+  appId?: string;
+  /**
+   * 应用id
+   */
+  clientId?: string;
+  /**
+   * 应用环境
+   */
+  env?: string;
+  /**
+   * 页面SystemTypeEnum
+   */
+  platform?: string;
 }
 export interface getUserAppAuthQuery {
-  appId: string; // 应用id
-  clientId: string; // 客户端id
+  /**
+   * 应用id
+   */
+  appId: string;
+  /**
+   * 客户端id
+   */
+  clientId: string;
 }
 export interface LoginService {
-  // 验证第三方平台是否注册正常
+  /**
+   * 验证第三方平台是否注册正常
+   */
   postCheckApp(
     data: ThirdAppConfigReq,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
-  // 短信登录发送短信
+  ): Promise<string>;
+  /**
+   * 短信登录发送短信
+   */
   postSendMsg(
     data: SmsDto,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
-  // 登录api
+  ): Promise<string>;
+  /**
+   * 登录api
+   */
   postSign(
     data: UserBaseReq,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<UserLoginResp>>;
-  // 退出登录
+  ): Promise<UserLoginResp>;
+  /**
+   * 退出登录
+   */
   getSignOut(
     query: getSignOutQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
-  // 当前人员登录app时是否有权限
+  ): Promise<string>;
+  /**
+   * 当前人员登录app时是否有权限
+   */
   getUserAppAuth(
     query: getUserAppAuthQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<boolean>>;
+  ): Promise<boolean>;
 }

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

@@ -2,22 +2,38 @@ import type { AxiosRequestConfig } from 'axios';
 import type { ManagerBean } from '../entities';
 
 export interface getPlatPageListQuery {
-  pageNo?: number; // 页码
-  pageSize?: number; // 每页数据条数
+  /**
+   * 页码
+   */
+  pageNo?: number;
+  /**
+   * 每页数据条数
+   */
+  pageSize?: number;
 }
 export interface getTenantPageListQuery {
-  pageNo?: number; // 页码
-  pageSize?: number; // 每页数据条数
+  /**
+   * 页码
+   */
+  pageNo?: number;
+  /**
+   * 每页数据条数
+   */
+  pageSize?: number;
 }
 export interface ManagerService {
-  // (平台管理)管理员分页列表
+  /**
+   * (平台管理)管理员分页列表
+   */
   getPlatPageList(
     query: getPlatPageListQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<IPage<ManagerBean>>>;
-  // (租户管理后台)管理员分页列表
+  ): Promise<IPage<ManagerBean>>;
+  /**
+   * (租户管理后台)管理员分页列表
+   */
   getTenantPageList(
     query: getTenantPageListQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<IPage<ManagerBean>>>;
+  ): Promise<IPage<ManagerBean>>;
 }

package/es/platform/service/apis/message-setting.service.d.ts

@@ -8,79 +8,141 @@ import type {
 } from '../entities';
 
 export interface deleteQuery {
-  ids: string; // 删除的id，多个按','分割
+  /**
+   * 删除的id，多个按','分割
+   */
+  ids: string;
 }
 export interface getInfoQuery {
-  id: string; // id
+  /**
+   * id
+   */
+  id: string;
 }
 export interface getListQuery {
-  type?: string; // type
+  /**
+   * type
+   */
+  type?: string;
 }
 export interface getPageListQuery {
-  endTime?: string; // 结束时间
-  key?: string; // key
-  name?: string; // 名称
-  pageNo?: number; // 页码
-  pageSize?: number; // 分页大小
-  remark?: string; // 备注
-  serviceType?: string; // 服务类型
-  sortField?: string; // 排序字段
-  sortType?: string; // 排序方式：ASC/DESC， 不传默认 ASC
-  startTime?: string; // 开始时间
-  type?: string; // 消息分类
+  /**
+   * 结束时间
+   */
+  endTime?: string;
+  /**
+   * key
+   */
+  key?: string;
+  /**
+   * 名称
+   */
+  name?: string;
+  /**
+   * 页码
+   */
+  pageNo?: number;
+  /**
+   * 分页大小
+   */
+  pageSize?: number;
+  /**
+   * 备注
+   */
+  remark?: string;
+  /**
+   * 服务类型
+   */
+  serviceType?: string;
+  /**
+   * 排序字段
+   */
+  sortField?: string;
+  /**
+   * 排序方式：ASC/DESC， 不传默认 ASC
+   */
+  sortType?: string;
+  /**
+   * 开始时间
+   */
+  startTime?: string;
+  /**
+   * 消息分类
+   */
+  type?: string;
 }
-export interface putIdQuery {
-  id: string; // 数据主键
+export interface putIdPathParams {
+  id: string;
 }
 export interface MessageSettingService {
-  // 保存
+  /**
+   * 保存
+   */
   post(
     data: MessageSettingRequest,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
-  // 删除
+  ): Promise<string>;
+  /**
+   * 删除
+   */
   delete(
     query: deleteQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
-  // 获取各个类型的数据条数
+  ): Promise<string>;
+  /**
+   * 获取各个类型的数据条数
+   */
   getGetTypeCount(
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<MessageSettingCountResponse>>;
-  // 详情
+  ): Promise<MessageSettingCountResponse>;
+  /**
+   * 详情
+   */
   getInfo(
     query: getInfoQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<MessageSettingResponse>>;
-  // 列表
+  ): Promise<MessageSettingResponse>;
+  /**
+   * 列表
+   */
   getList(
     query: getListQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<MessageSettingResponse[]>>;
-  // 调试用api测试发送MQTT消息
+  ): Promise<MessageSettingResponse[]>;
+  /**
+   * 调试用api测试发送MQTT消息
+   */
   postMqttSend(
     data: SendMessageRequest,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
-  // 分页列表
+  ): Promise<string>;
+  /**
+   * 分页列表
+   */
   getPageList(
     query: getPageListQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<IPage<MessageSettingResponse>>>;
-  // 测试发送邮箱消息
+  ): Promise<IPage<MessageSettingResponse>>;
+  /**
+   * 测试发送邮箱消息
+   */
   postSendEmailMessage(
     data: SendEmailMessageRequest,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<boolean>>;
-  // 测试发送企业微信、钉钉、飞书消息
+  ): Promise<boolean>;
+  /**
+   * 测试发送企业微信、钉钉、飞书消息
+   */
   postSendMessage(
     data: SendMessageRequest,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<boolean>>;
-  // 修改
+  ): Promise<boolean>;
+  /**
+   * 修改
+   */
   putId(
-    query: putIdQuery,
+    path: putIdPathParams,
     data: MessageSettingRequest,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
+  ): Promise<string>;
 }

package/es/platform/service/apis/minio-file.service.d.ts

@@ -2,17 +2,24 @@ import type { AxiosRequestConfig } from 'axios';
 import type { Base64UploadPlatFormRequest } from '../entities';
 
 export interface getDownloadQuery {
-  fileUrl: string; // fileUrl
+  /**
+   * fileUrl
+   */
+  fileUrl: string;
 }
 export interface MinioFileService {
-  // base64文件上传minio
+  /**
+   * base64文件上传minio
+   */
   postBase64Upload(
     data: Base64UploadPlatFormRequest,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
-  // minIO获取文件公用接口
+  ): Promise<string>;
+  /**
+   * minIO获取文件公用接口
+   */
   getDownload(
     query: getDownloadQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<unknown>>;
+  ): Promise<unknown>;
 }

package/es/platform/service/apis/model-provider.service.d.ts

@@ -2,47 +2,71 @@ import type { AxiosRequestConfig } from 'axios';
 import type { ModelProviderRequest, ModelProviderResponse } 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 ModelProviderService {
-  // 保存
+  /**
+   * 保存
+   */
   post(
     data: ModelProviderRequest,
     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<ModelProviderResponse>>;
-  // 列表
+  ): Promise<ModelProviderResponse>;
+  /**
+   * 列表
+   */
   getList(
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<ModelProviderResponse[]>>;
-  // 分页列表
+  ): Promise<ModelProviderResponse[]>;
+  /**
+   * 分页列表
+   */
   getPageList(
     query: getPageListQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<IPage<ModelProviderResponse>>>;
-  // 修改
+  ): Promise<IPage<ModelProviderResponse>>;
+  /**
+   * 修改
+   */
   putId(
-    query: putIdQuery,
+    path: putIdPathParams,
     data: ModelProviderRequest,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
+  ): Promise<string>;
 }

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

@@ -2,47 +2,69 @@ import type { AxiosRequestConfig } from 'axios';
 import type { ModelRequest, ModelResponse } 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 ModelService {
-  // 保存
+  /**
+   * 保存
+   */
   post(
     data: ModelRequest,
     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<ModelResponse>>;
-  // 列表
-  getList(
-    config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<ModelResponse[]>>;
-  // 分页列表
+  ): Promise<ModelResponse>;
+  /**
+   * 列表
+   */
+  getList(config?: Partial<AxiosRequestConfig>): Promise<ModelResponse[]>;
+  /**
+   * 分页列表
+   */
   getPageList(
     query: getPageListQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<IPage<ModelResponse>>>;
-  // 修改
+  ): Promise<IPage<ModelResponse>>;
+  /**
+   * 修改
+   */
   putId(
-    query: putIdQuery,
+    path: putIdPathParams,
     data: ModelRequest,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
+  ): Promise<string>;
 }

package/es/platform/service/apis/nav-menu.service.d.ts

@@ -6,61 +6,93 @@ 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 NavMenuService {
-  // 保存
+  /**
+   * 保存
+   */
   post(
     data: NavMenuRequest,
     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<NavMenuResponse>>;
-  // 详情
+  ): Promise<NavMenuResponse>;
+  /**
+   * 详情
+   */
   getInfo(
     query: getInfoQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<NavMenuResponse>>;
-  // 列表
-  getList(
-    config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<NavMenuResponse[]>>;
-  // 分页列表
+  ): Promise<NavMenuResponse>;
+  /**
+   * 列表
+   */
+  getList(config?: Partial<AxiosRequestConfig>): Promise<NavMenuResponse[]>;
+  /**
+   * 分页列表
+   */
   getPageList(
     query: getPageListQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<IPage<NavMenuResponse>>>;
-  // 选中页面，不传id代表都不选中
+  ): Promise<IPage<NavMenuResponse>>;
+  /**
+   * 选中页面，不传id代表都不选中
+   */
   postSelect(
     data: SingleRequest,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
-  // 修改页面设计Json
+  ): Promise<string>;
+  /**
+   * 修改页面设计Json
+   */
   putUpdateDesignerJsonId(
+    path: putUpdateDesignerJsonIdPathParams,
     data: NavMenuRequest,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
-  // 修改
+  ): Promise<string>;
+  /**
+   * 修改
+   */
   putId(
-    query: putIdQuery,
+    path: putIdPathParams,
     data: NavMenuRequest,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
+  ): Promise<string>;
 }