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

package/lib/platform/service/apis/user.service.d.ts

@@ -12,170 +12,269 @@ import type {
 } from '../entities';
 
 export interface deleteQuery {
-  ids: string; // 删除的id，多个按','分割
+  /**
+   * 删除的id，多个按','分割
+   */
+  ids: string;
+}
+export interface getInfoIdPathParams {
+  id: string;
 }
 export interface getInfoByIdsQuery {
-  ids: string; // 删除的id，多个按','分割
+  /**
+   * 删除的id，多个按','分割
+   */
+  ids: string;
 }
 export interface getListQuery {
-  keyword?: string; // keyword
+  /**
+   * keyword
+   */
+  keyword?: string;
 }
 export interface getListByTenantIdQuery {
-  fullname?: string; // 姓名
-  username?: string; // 账号
+  /**
+   * 姓名
+   */
+  fullname?: string;
+  /**
+   * 账号
+   */
+  username?: string;
 }
 export interface postOrgPlatImportQuery {
-  orgId: string; // 导入的部门Id
+  /**
+   * 导入的部门Id
+   */
+  orgId: string;
 }
 export interface postOrgTenantImportQuery {
-  orgId: string; // 导入的部门Id
+  /**
+   * 导入的部门Id
+   */
+  orgId: string;
 }
 export interface postOrgTenantImport4AppQuery {
-  orgId: string; // 导入的部门Id
+  /**
+   * 导入的部门Id
+   */
+  orgId: string;
 }
 export interface getPageListQuery {
-  endTime?: string; // 创建结束时间
-  fullname?: string; // 姓名
-  mobile?: string; // 手机号码
-  pageNo?: number; // 页码
-  pageSize?: number; // 分页大小
-  sortField?: string; // 排序字段
-  sortType?: string; // 排序方式：ASC/DESC， 不传默认 ASC
-  startTime?: string; // 创建开始时间
-  username?: string; // 账号
+  /**
+   * 创建结束时间
+   */
+  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 UserService {
-  // 新增用户
+  /**
+   * 新增用户
+   */
   post(
     data: UserSaveRequest,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
-  // 删除
+  ): Promise<string>;
+  /**
+   * 删除
+   */
   delete(
     query: deleteQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
-  // 获取用户信息
-  getInfo(
-    config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<UserLoginResp>>;
-  // 详情
+  ): Promise<string>;
+  /**
+   * 获取用户信息
+   */
+  getInfo(config?: Partial<AxiosRequestConfig>): Promise<UserLoginResp>;
+  /**
+   * 详情
+   */
   getInfoId(
+    path: getInfoIdPathParams,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<UserResponse>>;
-  // 多用户详情
+  ): Promise<UserResponse>;
+  /**
+   * 多用户详情
+   */
   getInfoByIds(
     query: getInfoByIdsQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<UserResponse[]>>;
-  // 查询用户上次修改密码信息
-  getLastResetPwd(
-    config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<PasswordInfo>>;
-  // 列表
+  ): Promise<UserResponse[]>;
+  /**
+   * 查询用户上次修改密码信息
+   */
+  getLastResetPwd(config?: Partial<AxiosRequestConfig>): Promise<PasswordInfo>;
+  /**
+   * 列表
+   */
   getList(
     query: getListQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<UserResponse[]>>;
-  // 当前租户下的用户列表
+  ): Promise<UserResponse[]>;
+  /**
+   * 当前租户下的用户列表
+   */
   getListByTenantId(
     query: getListByTenantIdQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<UserResponse[]>>;
-  // (平台管理)组织成员 导入人员
+  ): Promise<UserResponse[]>;
+  /**
+   * (平台管理)组织成员 导入人员
+   */
   postOrgPlatImport(
     query: postOrgPlatImportQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<object>>;
-  // (平台管理)组织成员 导出部门人员
+  ): Promise<object>;
+  /**
+   * (平台管理)组织成员 导出部门人员
+   */
   postOrgPlatTmpl(
     data: ExcelOrgUserSearchReq,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<unknown>>;
-  // (租户管理后台)组织成员 导入人员
+  ): Promise<unknown>;
+  /**
+   * (租户管理后台)组织成员 导入人员
+   */
   postOrgTenantImport(
     query: postOrgTenantImportQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<object>>;
-  // (租户管理后台)组织成员 导入人员
+  ): Promise<object>;
+  /**
+   * (租户管理后台)组织成员 导入人员
+   */
   postOrgTenantImport4App(
     query: postOrgTenantImport4AppQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<object>>;
-  // (租户管理后台)组织成员 导出部门人员
+  ): Promise<object>;
+  /**
+   * (租户管理后台)组织成员 导出部门人员
+   */
   postOrgTenantTmpl(
     data: ExcelOrgUserSearchReq,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<unknown>>;
-  // (租户管理后台)组织成员 导出部门人员
+  ): Promise<unknown>;
+  /**
+   * (租户管理后台)组织成员 导出部门人员
+   */
   postOrgTenantTmpl4App(
     data: ExcelOrgUserSearchReq,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<unknown>>;
-  // 分页列表
+  ): Promise<unknown>;
+  /**
+   * 分页列表
+   */
   getPageList(
     query: getPageListQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<IPage<UserResponse>>>;
-  // (平台管理)用户管理 导入(平台/公司)人员
-  postPlatImport(
-    config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<object>>;
-  // (平台管理)用户管理 导出人员
+  ): Promise<IPage<UserResponse>>;
+  /**
+   * (平台管理)用户管理 导入(平台/公司)人员
+   */
+  postPlatImport(config?: Partial<AxiosRequestConfig>): Promise<object>;
+  /**
+   * (平台管理)用户管理 导出人员
+   */
   postPlatTmpl(
     data: ExcelUserSearchReq,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<unknown>>;
-  // 修改密码与签名密码
+  ): Promise<unknown>;
+  /**
+   * 修改密码与签名密码
+   */
   postResetAllpwd(
     data: UserCodeDTO,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
-  // 重置登录密码
+  ): Promise<string>;
+  /**
+   * 重置登录密码
+   */
   postResetDefaultPwd(
     data: UserIdsDTO,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
-  // 重置签名密码
+  ): Promise<string>;
+  /**
+   * 重置签名密码
+   */
   postResetDefaultSignPwd(
     data: UserIdsDTO,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
-  // 修改密码
+  ): Promise<string>;
+  /**
+   * 修改密码
+   */
   postResetPwd(
     data: UserCodeDTO,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
-  // 用户设置
+  ): Promise<string>;
+  /**
+   * 用户设置
+   */
   postSettings(
     data: UserSettingsDTO,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
-  // (租户管理后台)用户管理 导入(平台/公司)人员
-  postTenantImport(
-    config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<object>>;
-  // (租户管理后台)用户管理 导入(平台/公司)人员
-  postTenantImport4App(
-    config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<object>>;
-  // (租户管理后台)用户管理 导出人员
+  ): Promise<string>;
+  /**
+   * (租户管理后台)用户管理 导入(平台/公司)人员
+   */
+  postTenantImport(config?: Partial<AxiosRequestConfig>): Promise<object>;
+  /**
+   * (租户管理后台)用户管理 导入(平台/公司)人员
+   */
+  postTenantImport4App(config?: Partial<AxiosRequestConfig>): Promise<object>;
+  /**
+   * (租户管理后台)用户管理 导出人员
+   */
   postTenantTmpl(
     data: ExcelUserSearchReq,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<unknown>>;
-  // (租户管理后台)用户管理 导出人员
+  ): Promise<unknown>;
+  /**
+   * (租户管理后台)用户管理 导出人员
+   */
   postTenantTmpl4App(
     data: ExcelUserSearchReq,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<unknown>>;
-  // 编辑用户信息
+  ): Promise<unknown>;
+  /**
+   * 编辑用户信息
+   */
   putId(
-    query: putIdQuery,
+    path: putIdPathParams,
     data: UserSaveRequest,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
+  ): Promise<string>;
 }

package/lib/platform/service/apis/workbench-component-relation.service.d.ts

@@ -7,69 +7,109 @@ 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 {
-  enabled: boolean; // enabled
+  /**
+   * enabled
+   */
+  enabled: boolean;
 }
 export interface getPageListQuery {
-  pageNo?: number; // 页码
-  pageSize?: number; // 每页数据条数
+  /**
+   * 页码
+   */
+  pageNo?: number;
+  /**
+   * 每页数据条数
+   */
+  pageSize?: number;
 }
 export interface putWorkbenchComponentActiveIdQuery {
-  enabled: number; // enabled
+  /**
+   * enabled
+   */
+  enabled: number;
 }
-export interface putIdQuery {
-  id: string; // 数据主键
+export interface putWorkbenchComponentActiveIdPathParams {
+  id: string;
+}
+export interface putIdPathParams {
+  id: string;
 }
 export interface WorkbenchComponentRelationService {
-  // 保存
+  /**
+   * 保存
+   */
   post(
     data: WorkbenchComponentRelationRequest,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
-  // 删除
+  ): Promise<string>;
+  /**
+   * 删除
+   */
   delete(
     query: deleteQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
-  // 拖拽
+  ): Promise<string>;
+  /**
+   * 拖拽
+   */
   postDrag(
     data: WorkbenchComponentRelationDragRequest,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
-  // 详情
+  ): Promise<string>;
+  /**
+   * 详情
+   */
   getInfo(
     query: getInfoQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<WorkbenchComponentRelationResponse>>;
-  // 列表
+  ): Promise<WorkbenchComponentRelationResponse>;
+  /**
+   * 列表
+   */
   getList(
     query: getListQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<WorkbenchComponentRelationResponse[]>>;
-  // 分页列表
+  ): Promise<WorkbenchComponentRelationResponse[]>;
+  /**
+   * 分页列表
+   */
   getPageList(
     query: getPageListQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<IPage<WorkbenchComponentRelationResponse>>>;
-  // 修改位置信息
+  ): Promise<IPage<WorkbenchComponentRelationResponse>>;
+  /**
+   * 修改位置信息
+   */
   putUpdatePositionJson(
     data: WorkbenchComponentRelationBatchRequest,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
-  // 开启&关闭
+  ): Promise<string>;
+  /**
+   * 开启&关闭
+   */
   putWorkbenchComponentActiveId(
+    path: putWorkbenchComponentActiveIdPathParams,
     query: putWorkbenchComponentActiveIdQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
-  // 修改
+  ): Promise<string>;
+  /**
+   * 修改
+   */
   putId(
-    query: putIdQuery,
+    path: putIdPathParams,
     data: WorkbenchComponentRelationRequest,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
+  ): Promise<string>;
 }

package/lib/platform/service/apis/workbench-component.service.d.ts

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