@gct-paas/api 0.1.0-dev.6 → 0.1.0-dev.8

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

@@ -29,72 +29,180 @@ export interface putEnableIdPathParams {
   id: string;
 }
 export interface getGetTenantIdByAppIdQuery {
-  appId: string; // 应用id
+  /**
+   * 应用id
+   */
+  appId: string;
 }
 export interface getGetTencentByDomainQuery {
-  domain?: string; // domain
+  /**
+   * domain
+   */
+  domain?: string;
 }
 export interface getInfoByPortOrDomainQuery {
-  domain?: string; // domain
-  port?: string; // port
+  /**
+   * domain
+   */
+  domain?: string;
+  /**
+   * port
+   */
+  port?: string;
 }
 export interface getInfoIdPathParams {
   id: string;
 }
 export interface getListQuery {
-  enabled?: number; // 状态，0：禁用；1：启用；不传：不限制状态
-  endTime?: string; // 结束时间
-  name?: string; // 租户名称
-  startTime?: string; // 开始时间
+  /**
+   * 状态，0：禁用；1：启用；不传：不限制状态
+   */
+  enabled?: number;
+  /**
+   * 结束时间
+   */
+  endTime?: string;
+  /**
+   * 租户名称
+   */
+  name?: string;
+  /**
+   * 开始时间
+   */
+  startTime?: string;
 }
 export interface deleteManagementOrgQuery {
-  ids: string; // 删除的id，多个按','分割
+  /**
+   * 删除的id，多个按','分割
+   */
+  ids: string;
 }
 export interface getManagementOrgInfoIdPathParams {
   id: string;
 }
 export interface getManagementOrgUserInfoQuery {
-  orgId: string; // 组织id
-  userId: string; // 用户id
+  /**
+   * 组织id
+   */
+  orgId: string;
+  /**
+   * 用户id
+   */
+  userId: string;
 }
 export interface getManagementOrgUserPageListQuery {
-  allUserOption?: number; // 是否显示下级
-  enabled?: number; // 是否启用
-  endTime?: string; // 创建结束时间
-  fullname?: string; // 姓名
-  mobile?: string; // 手机号码
-  orgId: string; // 部门id
-  pageNo?: number; // 页码
-  pageSize?: number; // 分页大小
-  sortField?: string; // 排序字段
-  sortType?: string; // 排序方式：ASC/DESC， 不传默认 ASC
-  source?: number; // 参数来源，0企业后台管理、1租户后台管理
-  startTime?: string; // 创建开始时间
-  username?: string; // 账号
+  /**
+   * 是否显示下级
+   */
+  allUserOption?: number;
+  /**
+   * 是否启用
+   */
+  enabled?: number;
+  /**
+   * 创建结束时间
+   */
+  endTime?: string;
+  /**
+   * 姓名
+   */
+  fullname?: string;
+  /**
+   * 手机号码
+   */
+  mobile?: string;
+  /**
+   * 部门id
+   */
+  orgId: string;
+  /**
+   * 页码
+   */
+  pageNo?: number;
+  /**
+   * 分页大小
+   */
+  pageSize?: number;
+  /**
+   * 排序字段
+   */
+  sortField?: string;
+  /**
+   * 排序方式：ASC/DESC， 不传默认 ASC
+   */
+  sortType?: string;
+  /**
+   * 参数来源，0企业后台管理、1租户后台管理
+   */
+  source?: number;
+  /**
+   * 创建开始时间
+   */
+  startTime?: string;
+  /**
+   * 账号
+   */
+  username?: string;
 }
 export interface putManagementOrgIdPathParams {
   id: string;
 }
 export interface putManagementUserDisableQuery {
-  ids: string; // ids
+  /**
+   * ids
+   */
+  ids: string;
 }
 export interface putManagementUserEnableQuery {
-  ids: string; // ids
+  /**
+   * ids
+   */
+  ids: string;
 }
 export interface getManagementUserInfoIdPathParams {
   id: string;
 }
 export interface getManagementUserPageListQuery {
-  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 putManagementUserIdPathParams {
   id: string;
@@ -103,192 +211,269 @@ export interface putUpdateDomainIdPathParams {
   id: string;
 }
 export interface deleteUserRoleQuery {
-  userId: string; // 删除的userId
+  /**
+   * 删除的userId
+   */
+  userId: string;
 }
 export interface putIdPathParams {
   id: string;
 }
 export interface TenantService {
-  // 锁定租户
+  /**
+   * 锁定租户
+   */
   putDisableId(
     path: putDisableIdPathParams,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<string>;
-  // 解锁租户
+  /**
+   * 解锁租户
+   */
   putEnableId(
     path: putEnableIdPathParams,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<string>;
-  // 根据appId获取租户id
+  /**
+   * 根据appId获取租户id
+   */
   getGetTenantIdByAppId(
     query: getGetTenantIdByAppIdQuery,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<string>;
-  // 根据域名获取租户信息
+  /**
+   * 根据域名获取租户信息
+   */
   getGetTencentByDomain(
     query: getGetTencentByDomainQuery,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<Tenant>;
-  // 根据域名或端口获取租户信息
+  /**
+   * 根据域名或端口获取租户信息
+   */
   getInfoByPortOrDomain(
     query: getInfoByPortOrDomainQuery,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<Tenant>;
-  // 详情
+  /**
+   * 详情
+   */
   getInfoId(
     path: getInfoIdPathParams,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<TenantResponse>;
-  // 列表
+  /**
+   * 列表
+   */
   getList(
     query: getListQuery,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<TenantResponse[]>;
-  // 保存
+  /**
+   * 保存
+   */
   postManagementOrg(
     data: OrgRequest,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<string>;
-  // 删除
+  /**
+   * 删除
+   */
   deleteManagementOrg(
     query: deleteManagementOrgQuery,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<string>;
-  // 拖拽
+  /**
+   * 拖拽
+   */
   postManagementOrgDrag(
     data: OrgDragRequest,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<string>;
-  // 详情
+  /**
+   * 详情
+   */
   getManagementOrgInfoId(
     path: getManagementOrgInfoIdPathParams,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<OrgResponse>;
-  // 列表
+  /**
+   * 列表
+   */
   getManagementOrgList(
     config?: Partial<AxiosRequestConfig>,
   ): Promise<OrgResponse[]>;
-  // 转移并删除
+  /**
+   * 转移并删除
+   */
   postManagementOrgTransferAndDelete(
     data: OrgTransferAndDeleteRequest,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<string>;
-  // 添加用户
+  /**
+   * 添加用户
+   */
   postManagementOrgUserAdd(
     data: OrgAddOrUpdateUserRequest,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<string>;
-  // 创建并添加用户
+  /**
+   * 创建并添加用户
+   */
   postManagementOrgUserCreateAndAdd(
     data: OrgCreateAndAddUserRequest,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<string>;
-  // 查询用户详情
+  /**
+   * 查询用户详情
+   */
   getManagementOrgUserInfo(
     query: getManagementOrgUserInfoQuery,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<OrgUserResponse>;
-  // 移动用户
+  /**
+   * 移动用户
+   */
   postManagementOrgUserMove(
     data: OrgMoveUserRequest,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<string>;
-  // 组织用户分页查询
+  /**
+   * 组织用户分页查询
+   */
   getManagementOrgUserPageList(
     query: getManagementOrgUserPageListQuery,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<IPage<OrgUserResponse>>;
-  // 移除用户
+  /**
+   * 移除用户
+   */
   postManagementOrgUserRemove(
     data: OrgRemoveUserRequest,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<string>;
-  // 编辑用户
+  /**
+   * 编辑用户
+   */
   postManagementOrgUserUpdate(
     data: OrgAddOrUpdateUserRequest,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<string>;
-  // 修改
+  /**
+   * 修改
+   */
   putManagementOrgId(
     path: putManagementOrgIdPathParams,
     data: OrgRequest,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<string>;
-  // 保存
+  /**
+   * 保存
+   */
   postManagementUser(
     data: UserSaveRequest,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<string>;
-  // 删除
+  /**
+   * 删除
+   */
   deleteManagementUser(
     data: TenantUserRemoveRequest,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<string>;
-  // 禁用
+  /**
+   * 禁用
+   */
   putManagementUserDisable(
     query: putManagementUserDisableQuery,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<string>;
-  // 启用
+  /**
+   * 启用
+   */
   putManagementUserEnable(
     query: putManagementUserEnableQuery,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<string>;
-  // 详情
+  /**
+   * 详情
+   */
   getManagementUserInfoId(
     path: getManagementUserInfoIdPathParams,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<OrgUserResponse>;
-  // 分页列表
+  /**
+   * 分页列表
+   */
   getManagementUserPageList(
     query: getManagementUserPageListQuery,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<IPage<UserWithUserExtraDTO>>;
-  // 移除
+  /**
+   * 移除
+   */
   postManagementUserRemove(
     data: TenantUserRemoveRequest,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<string>;
-  // 重置登录密码
+  /**
+   * 重置登录密码
+   */
   postManagementUserResetDefaultPwd(
     data: UserIdsDTO,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<string>;
-  // 重置签名密码
+  /**
+   * 重置签名密码
+   */
   postManagementUserResetDefaultSignPwd(
     data: UserIdsDTO,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<string>;
-  // 修改
+  /**
+   * 修改
+   */
   putManagementUserId(
     path: putManagementUserIdPathParams,
     data: UserSaveRequest,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<string>;
-  // 修改租户域名
+  /**
+   * 修改租户域名
+   */
   putUpdateDomainId(
     path: putUpdateDomainIdPathParams,
     data: TenantDomainRequest,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<string>;
-  // (租户管理后台)添加管理员 保存
+  /**
+   * (租户管理后台)添加管理员 保存
+   */
   postUserRole(
     data: UserRoleRequest,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<string>;
-  // (租户管理后台)管理员角色删除
+  /**
+   * (租户管理后台)管理员角色删除
+   */
   deleteUserRole(
     query: deleteUserRoleQuery,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<string>;
-  // (租户管理后台)管理员角色编辑
+  /**
+   * (租户管理后台)管理员角色编辑
+   */
   postUserRoleReset(
     data: UserRoles4Update,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<string>;
-  // 获取用户信息
+  /**
+   * 获取用户信息
+   */
   getUserInfo(config?: Partial<AxiosRequestConfig>): Promise<UserOfTenantDTO>;
-  // 修改
+  /**
+   * 修改
+   */
   putId(
     path: putIdPathParams,
     data: TenantRequest,

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

@@ -1,10 +1,13 @@
+/* eslint-disable @typescript-eslint/no-explicit-any */
 import type { AxiosRequestConfig } from 'axios';
 import type { 页面模板查询参数 } from '../entities';
 
 export interface ToggleEnabledService {
-  // 切换页面模板的激活状态
+  /**
+   * 切换页面模板的激活状态
+   */
   post(
     data: 页面模板查询参数,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<unknown>;
+  ): Promise<any>;
 }

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

@@ -1,10 +1,13 @@
+/* eslint-disable @typescript-eslint/no-explicit-any */
 import type { AxiosRequestConfig } from 'axios';
 import type { 操作日志查询参数 } from '../entities';
 
 export interface UncompressLogOperateLayoutStrService {
-  // 解密日志中的页面布局数据
+  /**
+   * 解密日志中的页面布局数据
+   */
   post(
     data: 操作日志查询参数,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<unknown>;
+  ): Promise<any>;
 }

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

@@ -1,60 +1,108 @@
+/* eslint-disable @typescript-eslint/no-explicit-any */
 import type { AxiosRequestConfig } from 'axios';
 export interface getQuery {
-  groupId?: string; // groupId
-  projectId?: string; // projectId
+  /**
+   * groupId
+   */
+  groupId?: string;
+  /**
+   * projectId
+   */
+  projectId?: string;
 }
 export interface headQuery {
-  groupId?: string; // groupId
-  projectId?: string; // projectId
+  /**
+   * groupId
+   */
+  groupId?: string;
+  /**
+   * projectId
+   */
+  projectId?: string;
 }
 export interface postQuery {
-  groupId?: string; // groupId
-  projectId?: string; // projectId
+  /**
+   * groupId
+   */
+  groupId?: string;
+  /**
+   * projectId
+   */
+  projectId?: string;
 }
 export interface putQuery {
-  groupId?: string; // groupId
-  projectId?: string; // projectId
+  /**
+   * groupId
+   */
+  groupId?: string;
+  /**
+   * projectId
+   */
+  projectId?: string;
 }
 export interface deleteQuery {
-  groupId?: string; // groupId
-  projectId?: string; // projectId
+  /**
+   * groupId
+   */
+  groupId?: string;
+  /**
+   * projectId
+   */
+  projectId?: string;
 }
 export interface optionsQuery {
-  groupId?: string; // groupId
-  projectId?: string; // projectId
+  /**
+   * groupId
+   */
+  groupId?: string;
+  /**
+   * projectId
+   */
+  projectId?: string;
 }
 export interface patchQuery {
-  groupId?: string; // groupId
-  projectId?: string; // projectId
+  /**
+   * groupId
+   */
+  groupId?: string;
+  /**
+   * projectId
+   */
+  projectId?: string;
 }
 export interface UploadFilesService {
-  // 上传资源
-  get(query: getQuery, config?: Partial<AxiosRequestConfig>): Promise<unknown>;
-  // 上传资源
-  head(
-    query: headQuery,
-    config?: Partial<AxiosRequestConfig>,
-  ): Promise<unknown>;
-  // 上传资源
-  post(
-    query: postQuery,
-    config?: Partial<AxiosRequestConfig>,
-  ): Promise<unknown>;
-  // 上传资源
-  put(query: putQuery, config?: Partial<AxiosRequestConfig>): Promise<unknown>;
-  // 上传资源
+  /**
+   * 上传资源
+   */
+  get(query: getQuery, config?: Partial<AxiosRequestConfig>): Promise<any>;
+  /**
+   * 上传资源
+   */
+  head(query: headQuery, config?: Partial<AxiosRequestConfig>): Promise<any>;
+  /**
+   * 上传资源
+   */
+  post(query: postQuery, config?: Partial<AxiosRequestConfig>): Promise<any>;
+  /**
+   * 上传资源
+   */
+  put(query: putQuery, config?: Partial<AxiosRequestConfig>): Promise<any>;
+  /**
+   * 上传资源
+   */
   delete(
     query: deleteQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<unknown>;
-  // 上传资源
+  ): Promise<any>;
+  /**
+   * 上传资源
+   */
   options(
     query: optionsQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<unknown>;
-  // 上传资源
-  patch(
-    query: patchQuery,
-    config?: Partial<AxiosRequestConfig>,
-  ): Promise<unknown>;
+  ): Promise<any>;
+  /**
+   * 上传资源
+   */
+  patch(query: patchQuery, config?: Partial<AxiosRequestConfig>): Promise<any>;
 }