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

package/lib/apaas/service/apis/app-branch.service.d.ts

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

package/lib/apaas/service/apis/app-global-settings.service.d.ts

@@ -5,46 +5,73 @@ import type {
 } from '../entities';
 
 export interface deleteQuery {
-  ids: string; // 删除的id，多个按','分割
+  /**
+   * 删除的id，多个按','分割
+   */
+  ids: string;
 }
 export interface getInfoQuery {
-  fullInfo?: boolean; // 查询全量信息时传 true，否则只查询简要信息
-  ids?: string; // 查询的id，多个按','分割
-  keys?: string; // 查询的key，多个按','分割
+  /**
+   * 查询全量信息时传 true，否则只查询简要信息
+   */
+  fullInfo?: boolean;
+  /**
+   * 查询的id，多个按','分割
+   */
+  ids?: string;
+  /**
+   * 查询的key，多个按','分割
+   */
+  keys?: string;
 }
 export interface getListQuery {
-  fullInfo?: boolean; // 查询全量信息时传 true，否则只查询简要信息
-  source?: string; // 来源
-  type: string; // 类型
+  /**
+   * 查询全量信息时传 true，否则只查询简要信息
+   */
+  fullInfo?: boolean;
+  /**
+   * 类型
+   */
+  type: string;
 }
-export interface putIdQuery {
-  id: string; // 数据主键
+export interface putIdPathParams {
+  id: string;
 }
 export interface AppGlobalSettingsService {
-  // 保存
+  /**
+   * 保存
+   */
   post(
     data: AppGlobalSettingsRequest,
     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<AppGlobalSettingsResponse[]>>;
-  // 列表
+  ): Promise<AppGlobalSettingsResponse[]>;
+  /**
+   * 列表
+   */
   getList(
     query: getListQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<AppGlobalSettingsResponse[]>>;
-  // 修改
+  ): Promise<AppGlobalSettingsResponse[]>;
+  /**
+   * 修改
+   */
   putId(
-    query: putIdQuery,
+    path: putIdPathParams,
     data: AppGlobalSettingsRequest,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
+  ): Promise<string>;
 }

package/lib/apaas/service/apis/app-granted-user.service.d.ts

@@ -7,47 +7,80 @@ import type {
 } from '../entities';
 
 export interface getPageListQuery {
-  fullname?: string; // 姓名
-  pageNo?: number; // 页码
-  pageSize?: number; // 每页数据条数
-  searchTag?: number; // 普通查询0/授权用户1/共享用户2
-  username?: string; // 用户名
+  /**
+   * 姓名
+   */
+  fullname?: string;
+  /**
+   * 页码
+   */
+  pageNo?: number;
+  /**
+   * 每页数据条数
+   */
+  pageSize?: number;
+  /**
+   * 普通查询0/授权用户1/共享用户2
+   */
+  searchTag?: number;
+  /**
+   * 用户名
+   */
+  username?: string;
 }
 export interface getRemoveAndTransferQuery {
-  sUserId: string; // 源用户id
-  tUserId: string; // 目标用户id
+  /**
+   * 源用户id
+   */
+  sUserId: string;
+  /**
+   * 目标用户id
+   */
+  tUserId: string;
 }
 export interface AppGrantedUserService {
-  // 保存
+  /**
+   * 保存
+   */
   post(
     data: AppGrantedUserRequest,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
-  // 批量保存
+  ): Promise<string>;
+  /**
+   * 批量保存
+   */
   postBatch(
     data: AppGrantedUserBatchRequest,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
-  // 获取应用授权统计信息
+  ): Promise<string>;
+  /**
+   * 获取应用授权统计信息
+   */
   getGrantedStatistic(
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<AppGrantedStatisticDTO>>;
-  // 列表
-  getList(
-    config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<UserResponse[]>>;
-  // 分页列表
+  ): Promise<AppGrantedStatisticDTO>;
+  /**
+   * 列表
+   */
+  getList(config?: Partial<AxiosRequestConfig>): Promise<UserResponse[]>;
+  /**
+   * 分页列表
+   */
   getPageList(
     query: getPageListQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<IPage<UserResponse>>>;
-  // 席位移除和转移
+  ): Promise<IPage<UserResponse>>;
+  /**
+   * 席位移除和转移
+   */
   getRemoveAndTransfer(
     query: getRemoveAndTransferQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
-  // 未授权用户列表
+  ): Promise<string>;
+  /**
+   * 未授权用户列表
+   */
   getUngrantedList(
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<UserResponse[]>>;
+  ): Promise<UserResponse[]>;
 }

package/lib/apaas/service/apis/app-org.service.d.ts

@@ -12,98 +12,173 @@ import type {
 } from '../entities';
 
 export interface deleteQuery {
-  ids: string; // 删除的id，多个按','分割
+  /**
+   * 删除的id，多个按','分割
+   */
+  ids: string;
+}
+export interface getInfoIdPathParams {
+  id: string;
 }
 export interface getUserInfoQuery {
-  orgId: string; // 组织id
-  userId: string; // 用户id
+  /**
+   * 组织id
+   */
+  orgId: string;
+  /**
+   * 用户id
+   */
+  userId: string;
 }
 export interface getUserPageListQuery {
-  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 putIdQuery {
-  id: string; // 数据主键
+export interface putIdPathParams {
+  id: string;
 }
 export interface AppOrgService {
-  // 保存
-  post(
-    data: OrgRequest,
-    config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
-  // 删除
+  /**
+   * 保存
+   */
+  post(data: OrgRequest, config?: Partial<AxiosRequestConfig>): Promise<string>;
+  /**
+   * 删除
+   */
   delete(
     query: deleteQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
-  // 拖拽
+  ): Promise<string>;
+  /**
+   * 拖拽
+   */
   postDrag(
     data: OrgDragRequest,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
-  // 详情
+  ): Promise<string>;
+  /**
+   * 详情
+   */
   getInfoId(
+    path: getInfoIdPathParams,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<OrgResponse>>;
-  // 列表
-  getList(
-    config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<OrgResponse[]>>;
-  // 转移并删除
+  ): Promise<OrgResponse>;
+  /**
+   * 列表
+   */
+  getList(config?: Partial<AxiosRequestConfig>): Promise<OrgResponse[]>;
+  /**
+   * 转移并删除
+   */
   postTransferAndDelete(
     data: OrgTransferAndDeleteRequest,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
-  // 添加用户
+  ): Promise<string>;
+  /**
+   * 添加用户
+   */
   postUserAdd(
     data: OrgAddOrUpdateUserRequest,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
-  // 创建并添加用户
+  ): Promise<string>;
+  /**
+   * 创建并添加用户
+   */
   postUserCreateAndAdd(
     data: OrgCreateAndAddUserRequest,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
-  // 查询用户详情
+  ): Promise<string>;
+  /**
+   * 查询用户详情
+   */
   getUserInfo(
     query: getUserInfoQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<OrgUserResponse>>;
-  // 移动用户
+  ): Promise<OrgUserResponse>;
+  /**
+   * 移动用户
+   */
   postUserMove(
     data: OrgMoveUserRequest,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
-  // 组织用户分页查询
+  ): Promise<string>;
+  /**
+   * 组织用户分页查询
+   */
   getUserPageList(
     query: getUserPageListQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<IPage<OrgUserResponse>>>;
-  // 移除用户
+  ): Promise<IPage<OrgUserResponse>>;
+  /**
+   * 移除用户
+   */
   postUserRemove(
     data: OrgRemoveUserRequest,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
-  // 编辑用户
+  ): Promise<string>;
+  /**
+   * 编辑用户
+   */
   postUserUpdate(
     data: OrgAddOrUpdateUserRequest,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
-  // 修改
+  ): Promise<string>;
+  /**
+   * 修改
+   */
   putId(
-    query: putIdQuery,
+    path: putIdPathParams,
     data: OrgRequest,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
+  ): Promise<string>;
 }

package/lib/apaas/service/apis/app-publish-log.service.d.ts

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

package/lib/apaas/service/apis/app-state.service.d.ts

@@ -2,8 +2,10 @@ import type { AxiosRequestConfig } from 'axios';
 import type { AppEditStatusResponse } from '../entities';
 
 export interface AppStateService {
-  // 查询应用草稿态标志
+  /**
+   * 查询应用草稿态标志
+   */
   getDraft(
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<AppEditStatusResponse>>;
+  ): Promise<AppEditStatusResponse>;
 }