@gct-paas/api 0.1.0-word.2 → 0.1.0

package/es/apaas/service/apis/app-user.service.d.ts

@@ -1,3 +1,4 @@
+import type { AxiosRequestConfig } from 'axios';
 import type {
   UserSaveRequest,
   TenantUserRemoveRequest,
@@ -7,75 +8,135 @@ import type {
 } from '../entities';
 
 export interface putDisableQuery {
-  ids: string; // ids
+  /**
+   * ids
+   */
+  ids: string;
 }
 export interface putEnableQuery {
-  ids: string; // ids
+  /**
+   * ids
+   */
+  ids: string;
+}
+export interface getInfoIdPathParams {
+  id: string;
 }
 export interface getPageListQuery {
-  enabled?: number; // 是否启用
-  endTime?: string; // 创建结束时间
-  fullname?: string; // 姓名
-  mobile?: string; // 手机号码
-  pageNo?: number; // 页码
-  pageSize?: number; // 分页大小
-  sortField?: string; // 排序字段
-  sortType?: string; // 排序方式：ASC/DESC， 不传默认 ASC
-  startTime?: string; // 创建开始时间
-  username?: string; // 账号
+  /**
+   * 是否启用
+   */
+  enabled?: number;
+  /**
+   * 创建结束时间
+   */
+  endTime?: string;
+  /**
+   * 姓名
+   */
+  fullname?: string;
+  /**
+   * 手机号码
+   */
+  mobile?: string;
+  /**
+   * 页码
+   */
+  pageNo?: number;
+  /**
+   * 分页大小
+   */
+  pageSize?: number;
+  /**
+   * 排序字段
+   */
+  sortField?: string;
+  /**
+   * 排序方式：ASC/DESC， 不传默认 ASC
+   */
+  sortType?: string;
+  /**
+   * 创建开始时间
+   */
+  startTime?: string;
+  /**
+   * 账号
+   */
+  username?: string;
 }
-export interface putIdQuery {
-  id: string; // 数据主键
+export interface putIdPathParams {
+  id: string;
 }
 export interface AppUserService {
-  // 保存
+  /**
+   * 保存
+   */
   post(
     data: UserSaveRequest,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<string>>;
-  // 删除
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<string>;
+  /**
+   * 删除
+   */
   delete(
     data: TenantUserRemoveRequest,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<string>>;
-  // 禁用
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<string>;
+  /**
+   * 禁用
+   */
   putDisable(
     query: putDisableQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<string>>;
-  // 启用
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<string>;
+  /**
+   * 启用
+   */
   putEnable(
     query: putEnableQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<string>>;
-  // 详情
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<string>;
+  /**
+   * 详情
+   */
   getInfoId(
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<OrgUserResponse>>;
-  // 分页列表
+    path: getInfoIdPathParams,
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<OrgUserResponse>;
+  /**
+   * 分页列表
+   */
   getPageList(
     query: getPageListQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<IPage<UserWithUserExtraDTO>>>;
-  // 移除
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<IPage<UserWithUserExtraDTO>>;
+  /**
+   * 移除
+   */
   postRemove(
     data: TenantUserRemoveRequest,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<string>>;
-  // 重置密码
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<string>;
+  /**
+   * 重置密码
+   */
   postResetDefaultPwd(
     data: UserIdsDTO,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<string>>;
-  // 重置签名密码
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<string>;
+  /**
+   * 重置签名密码
+   */
   postResetDefaultSignPwd(
     data: UserIdsDTO,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<string>>;
-  // 修改
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<string>;
+  /**
+   * 修改
+   */
   putId(
-    query: putIdQuery,
+    path: putIdPathParams,
     data: UserSaveRequest,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<string>>;
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<string>;
 }

package/es/apaas/service/apis/approval-log.service.d.ts

@@ -1,47 +1,70 @@
+import type { AxiosRequestConfig } from 'axios';
 import type { ApprovalLogRequest, ApprovalLogResponse } 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 ApprovalLogService {
-  // 保存
+  /**
+   * 保存
+   */
   post(
     data: ApprovalLogRequest,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<string>>;
-  // 删除
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<string>;
+  /**
+   * 删除
+   */
   delete(
     query: deleteQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<string>>;
-  // 详情
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<string>;
+  /**
+   * 详情
+   */
   getInfo(
     query: getInfoQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<ApprovalLogResponse>>;
-  // 列表
-  getList(
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<ApprovalLogResponse[]>>;
-  // 分页列表
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<ApprovalLogResponse>;
+  /**
+   * 列表
+   */
+  getList(config?: Partial<AxiosRequestConfig>): Promise<ApprovalLogResponse[]>;
+  /**
+   * 分页列表
+   */
   getPageList(
     query: getPageListQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<IPage<ApprovalLogResponse>>>;
-  // 修改
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<IPage<ApprovalLogResponse>>;
+  /**
+   * 修改
+   */
   putId(
-    query: putIdQuery,
+    path: putIdPathParams,
     data: ApprovalLogRequest,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<string>>;
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<string>;
 }

package/es/apaas/service/apis/audit-log.service.d.ts

@@ -1,3 +1,4 @@
+import type { AxiosRequestConfig } from 'axios';
 import type {
   AuditLogSearchRequest,
   AuditLogResponse,
@@ -7,41 +8,52 @@ import type {
 } from '../entities';
 
 export interface getInfoQuery {
-  id: string; // id
-}
-export interface getOperateTypesQuery {
-  module: string; // 功能模块
+  /**
+   * id
+   */
+  id: string;
 }
 export interface AuditLogService {
-  // 导出
+  /**
+   * 导出
+   */
   postExport(
     data: AuditLogSearchRequest,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<string>>;
-  // 详情
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<string>;
+  /**
+   * 详情
+   */
   getInfo(
     query: getInfoQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<AuditLogResponse>>;
-  // 功能模块
-  getModules(config?: Record<string, string>): Promise<IHttpResponse<string[]>>;
-  // 操作类型
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<AuditLogResponse>;
+  /**
+   * 功能模块
+   */
+  getModules(config?: Partial<AxiosRequestConfig>): Promise<string[]>;
+  /**
+   * 操作类型
+   */
   getOperateTypes(
-    query: getOperateTypesQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<OperateTypeDTO[]>>;
-  // 操作人
-  getOperators(
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<UserBaseInfo[]>>;
-  // 分页列表
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<OperateTypeDTO[]>;
+  /**
+   * 操作人
+   */
+  getOperators(config?: Partial<AxiosRequestConfig>): Promise<UserBaseInfo[]>;
+  /**
+   * 分页列表
+   */
   postPageList(
     data: AuditLogSearchRequest,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<IPage<AuditLogResponse>>>;
-  // 保存
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<IPage<AuditLogResponse>>;
+  /**
+   * 保存
+   */
   postSave(
     data: AuditLogRequest,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<string>>;
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<string>;
 }

package/es/apaas/service/apis/basic-config.service.d.ts

@@ -1,3 +1,4 @@
+import type { AxiosRequestConfig } from 'axios';
 import type {
   BasicConfigRequest,
   SysConfigResponse,
@@ -6,44 +7,66 @@ import type {
 } from '../entities';
 
 export interface getDetailQuery {
-  configEnum: string; // 配置枚举(THEME_CFG/主题设置)
+  /**
+   * 配置枚举(THEME_CFG/主题设置)
+   */
+  configEnum: string;
 }
 export interface getInfoQuery {
-  pageType: string; // pageType
+  /**
+   * pageType
+   */
+  pageType: string;
+}
+export interface putKeyPathParams {
+  key: string;
 }
 export interface BasicConfigService {
-  // 基础配置保存/修改
+  /**
+   * 基础配置保存/修改
+   */
   post(
     data: BasicConfigRequest,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<string>>;
-  // 是否启用ai知识库
-  getAiRagEnabled(
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<boolean>>;
-  // 主题等配置查询
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<string>;
+  /**
+   * 是否启用ai知识库
+   */
+  getAiRagEnabled(config?: Partial<AxiosRequestConfig>): Promise<boolean>;
+  /**
+   * 主题等配置查询
+   */
   getDetail(
     query: getDetailQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<SysConfigResponse>>;
-  // 全局设置 保存/更新
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<SysConfigResponse>;
+  /**
+   * 全局设置 保存/更新
+   */
   postGlobal(
     data: SysConfigRequest,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<string>>;
-  // 基础配置信息
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<string>;
+  /**
+   * 基础配置信息
+   */
   getInfo(
     query: getInfoQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<BasicConfigResponse>>;
-  // 主题设置 保存/更新
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<BasicConfigResponse>;
+  /**
+   * 主题设置 保存/更新
+   */
   postTheme(
     data: SysConfigRequest,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<string>>;
-  // 修改
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<string>;
+  /**
+   * 修改
+   */
   putKey(
+    path: putKeyPathParams,
     data: BasicConfigRequest,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<string>>;
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<string>;
 }

package/es/apaas/service/apis/biz-event.service.d.ts

@@ -1,52 +1,83 @@
+import type { AxiosRequestConfig } from 'axios';
 import type { BizEventRequest, BizEventResponse } from '../entities';
 
 export interface deleteQuery {
-  ids: string; // 删除的id，多个按','分割
+  /**
+   * 删除的id，多个按','分割
+   */
+  ids: string;
 }
 export interface getInfoQuery {
-  id: string; // id
+  /**
+   * id
+   */
+  id: string;
 }
 export interface getListQuery {
-  modelKey: string; // 模型key
+  /**
+   * 模型key
+   */
+  modelKey: string;
 }
 export interface getPageListQuery {
-  modelKey: string; // 模型key
-  pageNo?: number; // 页码
-  pageSize?: number; // 每页数据条数
+  /**
+   * 模型key
+   */
+  modelKey: string;
+  /**
+   * 页码
+   */
+  pageNo?: number;
+  /**
+   * 每页数据条数
+   */
+  pageSize?: number;
 }
-export interface putIdQuery {
-  id: string; // 数据主键
+export interface putIdPathParams {
+  id: string;
 }
 export interface BizEventService {
-  // 业务服务保存
+  /**
+   * 业务服务保存
+   */
   post(
     data: BizEventRequest,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<string>>;
-  // 事件删除
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<string>;
+  /**
+   * 事件删除
+   */
   delete(
     query: deleteQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<string>>;
-  // 业务服务详情
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<string>;
+  /**
+   * 业务服务详情
+   */
   getInfo(
     query: getInfoQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<BizEventResponse>>;
-  // 业务服务列表
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<BizEventResponse>;
+  /**
+   * 业务服务列表
+   */
   getList(
     query: getListQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<BizEventResponse[]>>;
-  // 业务服务分页列表
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<BizEventResponse[]>;
+  /**
+   * 业务服务分页列表
+   */
   getPageList(
     query: getPageListQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<IPage<BizEventResponse>>>;
-  // 修改
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<IPage<BizEventResponse>>;
+  /**
+   * 修改
+   */
   putId(
-    query: putIdQuery,
+    path: putIdPathParams,
     data: BizEventRequest,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<string>>;
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<string>;
 }