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

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

@@ -2,7 +2,9 @@ import type { AxiosRequestConfig } from 'axios';
 import type { 地图GeoJson表实体类Req } from '../entities';
 
 export interface SaveMapGeoJsonService {
-  // 保存地图GeoJson数据
+  /**
+   * 保存地图GeoJson数据
+   */
   post(
     data: 地图GeoJson表实体类Req,
     config?: Partial<AxiosRequestConfig>,

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

@@ -2,7 +2,9 @@ import type { AxiosRequestConfig } from 'axios';
 import type { 页面快照表实体类 } from '../entities';
 
 export interface SavePageSnapshootService {
-  // 保存快照
+  /**
+   * 保存快照
+   */
   post(
     data: 页面快照表实体类,
     config?: Partial<AxiosRequestConfig>,

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

@@ -2,7 +2,9 @@ import type { AxiosRequestConfig } from 'axios';
 import type { 页面模板表实体类 } from '../entities';
 
 export interface SavePageTemplateService {
-  // 保存页面模板
+  /**
+   * 保存页面模板
+   */
   post(
     data: 页面模板表实体类,
     config?: Partial<AxiosRequestConfig>,

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

@@ -2,7 +2,9 @@ import type { AxiosRequestConfig } from 'axios';
 import type { 资源分组表实体类 } from '../entities';
 
 export interface SavePnResourceGroupService {
-  // 保存资源分组
+  /**
+   * 保存资源分组
+   */
   post(
     data: 资源分组表实体类,
     config?: Partial<AxiosRequestConfig>,

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

@@ -2,7 +2,9 @@ import type { AxiosRequestConfig } from 'axios';
 import type { 共享自定义组件实体类 } from '../entities';
 
 export interface SaveShareCustomCompService {
-  // 保存共享自定义组件
+  /**
+   * 保存共享自定义组件
+   */
   post(
     data: 共享自定义组件实体类,
     config?: Partial<AxiosRequestConfig>,

package/es/platform/service/apis/seal-management.service.d.ts

@@ -5,53 +5,78 @@ import type {
 } from '../entities';
 
 export interface deleteQuery {
-  ids: string; // 删除的id，多个按','分割
+  /**
+   * 删除的id，多个按','分割
+   */
+  ids: string;
 }
 export interface getCheckNameQuery {
-  name: string; // 名称
+  /**
+   * 名称
+   */
+  name: string;
 }
 export interface getInfoQuery {
-  id: string; // id
+  /**
+   * id
+   */
+  id: string;
 }
 export interface putIdPathParams {
   id: string;
 }
 export interface SealManagementService {
-  // 保存
+  /**
+   * 保存
+   */
   post(
     data: SealManagementRequest,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<string>;
-  // 删除
+  /**
+   * 删除
+   */
   delete(
     query: deleteQuery,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<string>;
-  // 判断名称是否重复
+  /**
+   * 判断名称是否重复
+   */
   getCheckName(
     query: getCheckNameQuery,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<boolean>;
-  // 详情
+  /**
+   * 详情
+   */
   getInfo(
     query: getInfoQuery,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<SealManagementResponse>;
-  // 列表
+  /**
+   * 列表
+   */
   getList(
     config?: Partial<AxiosRequestConfig>,
   ): Promise<SealManagementResponse[]>;
-  // 分页列表
+  /**
+   * 分页列表
+   */
   postPageList(
     data: SealManagementRequest,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<IPage<SealManagementResponse>>;
-  // 修改密码
+  /**
+   * 修改密码
+   */
   postUpdatePassword(
     data: SealManagementRequest,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<string>;
-  // 编辑
+  /**
+   * 编辑
+   */
   putId(
     path: putIdPathParams,
     data: SealManagementRequest,

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

@@ -2,7 +2,9 @@ import type { AxiosRequestConfig } from 'axios';
 import type { 组件收藏表实体类 } from '../entities';
 
 export interface SearchEnshrineCompService {
-  // 搜索收藏组件
+  /**
+   * 搜索收藏组件
+   */
   post(
     data: 组件收藏表实体类,
     config?: Partial<AxiosRequestConfig>,

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

@@ -3,7 +3,9 @@ export interface getCloseIdPathParams {
   id: string;
 }
 export interface SeatMessageService {
-  // 消息关闭
+  /**
+   * 消息关闭
+   */
   getCloseId(
     path: getCloseIdPathParams,
     config?: Partial<AxiosRequestConfig>,

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

@@ -7,51 +7,94 @@ import type {
 } from '../entities';
 
 export interface getListAuthedQuery {
-  pageNo?: number; // 页码
-  pageSize?: number; // 每页数据条数
-  tenantId?: string; // 租户id
-  type?: string; // 类型：平台-platform；套件
-  username?: string; // 用户名或账号
+  /**
+   * 页码
+   */
+  pageNo?: number;
+  /**
+   * 每页数据条数
+   */
+  pageSize?: number;
+  /**
+   * 租户id
+   */
+  tenantId?: string;
+  /**
+   * 类型：平台-platform；套件
+   */
+  type?: string;
+  /**
+   * 用户名或账号
+   */
+  username?: string;
 }
 export interface getListNotAuthQuery {
-  tenantId?: string; // 租户
-  type?: string; // 类型：平台-platform；套件
-  username?: string; // 用户名或账号
+  /**
+   * 租户
+   */
+  tenantId?: string;
+  /**
+   * 类型：平台-platform；套件
+   */
+  type?: string;
+  /**
+   * 用户名或账号
+   */
+  username?: string;
 }
 export interface postRemoveAuthQuery {
-  type?: string; // 类型：平台-platform；套件
+  /**
+   * 类型：平台-platform；套件
+   */
+  type?: string;
 }
 export interface SeatService {
-  // 获取应用可见组织
+  /**
+   * 获取应用可见组织
+   */
   getAppGetVisibleOrg(
     config?: Partial<AxiosRequestConfig>,
   ): Promise<PickerOrgDTO[]>;
-  // 获取应用可见组织下的人员
+  /**
+   * 获取应用可见组织下的人员
+   */
   postAppGetVisibleOrgUser(
     data: AppOrgUserPageRequest,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<IPage<PickerUserDTO>>;
-  // 获取应用可见用户
+  /**
+   * 获取应用可见用户
+   */
   getAppGetVisibleUser(
     config?: Partial<AxiosRequestConfig>,
   ): Promise<PickerUserDTO[]>;
-  // 用户授权
+  /**
+   * 用户授权
+   */
   postAuth(config?: Partial<AxiosRequestConfig>): Promise<string>;
-  // 已授权用户列表
+  /**
+   * 已授权用户列表
+   */
   getListAuthed(
     query: getListAuthedQuery,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<IPage<UserResponse>>;
-  // 查询未经授权的用户列表
+  /**
+   * 查询未经授权的用户列表
+   */
   getListNotAuth(
     query: getListNotAuthQuery,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<UserResponse[]>;
-  // 移除已授权用户
+  /**
+   * 移除已授权用户
+   */
   postRemoveAuth(
     query: postRemoveAuthQuery,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<string>;
-  // 席位总数/剩余可用信息
+  /**
+   * 席位总数/剩余可用信息
+   */
   getTotalinfos(config?: Partial<AxiosRequestConfig>): Promise<IObject>;
 }

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

@@ -2,7 +2,9 @@ import type { AxiosRequestConfig } from 'axios';
 import type { 设置快照状态表单数据 } from '../entities';
 
 export interface SetPageSnapshootEnabledService {
-  // 设置指定快照的状态
+  /**
+   * 设置指定快照的状态
+   */
   post(
     data: 设置快照状态表单数据,
     config?: Partial<AxiosRequestConfig>,

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

@@ -2,7 +2,9 @@ import type { AxiosRequestConfig } from 'axios';
 import type { 设置快照状态表单数据 } from '../entities';
 
 export interface SetPageSnapshootEnabledByPageIdService {
-  // 设置指定页面下的快照状态
+  /**
+   * 设置指定页面下的快照状态
+   */
   post(
     data: 设置快照状态表单数据,
     config?: Partial<AxiosRequestConfig>,

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

@@ -6,63 +6,121 @@ import type {
 } from '../entities';
 
 export interface deleteMenuQuery {
-  ids: string; // 删除的id，多个按','分割
+  /**
+   * 删除的id，多个按','分割
+   */
+  ids: string;
 }
 export interface getMenuInfoQuery {
-  id: string; // id
+  /**
+   * id
+   */
+  id: string;
 }
 export interface getMenuListAppMenuQuery {
-  appId: string; // appId
-  terminalType: string; // terminalType
+  /**
+   * appId
+   */
+  appId: string;
+  /**
+   * terminalType
+   */
+  terminalType: string;
 }
 export interface getMenuPageListQuery {
-  appId?: string; // 应用id
-  endTime?: string; // 结束时间
-  env?: string; //
-  menuId?: string; // 菜单id
-  pageNo?: number; // 页码
-  pageSize?: number; // 分页大小
-  sortField?: string; // 排序字段
-  sortType?: string; // 排序方式：ASC/DESC， 不传默认 ASC
-  startTime?: string; // 开始时间
-  terminalType?: string; // 快捷菜单类型（WEB/MOBILE）
+  /**
+   * 应用id
+   */
+  appId?: string;
+  /**
+   * 结束时间
+   */
+  endTime?: string;
+  /**
+   *
+   */
+  env?: string;
+  /**
+   * 菜单id
+   */
+  menuId?: string;
+  /**
+   * 页码
+   */
+  pageNo?: number;
+  /**
+   * 分页大小
+   */
+  pageSize?: number;
+  /**
+   * 排序字段
+   */
+  sortField?: string;
+  /**
+   * 排序方式：ASC/DESC， 不传默认 ASC
+   */
+  sortType?: string;
+  /**
+   * 开始时间
+   */
+  startTime?: string;
+  /**
+   * 快捷菜单类型（WEB/MOBILE）
+   */
+  terminalType?: string;
 }
 export interface putMenuIdPathParams {
   id: string;
 }
 export interface ShortcutService {
-  // 保存
+  /**
+   * 保存
+   */
   postMenu(
     data: ShortcutMenuRequest,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<string>;
-  // 删除
+  /**
+   * 删除
+   */
   deleteMenu(
     query: deleteMenuQuery,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<string>;
-  // 详情
+  /**
+   * 详情
+   */
   getMenuInfo(
     query: getMenuInfoQuery,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<ShortcutMenuDtoResponse>;
-  // 列表
+  /**
+   * 列表
+   */
   getMenuList(
     config?: Partial<AxiosRequestConfig>,
   ): Promise<ShortcutMenuDtoResponse[]>;
-  // 获取应用菜单列表
+  /**
+   * 获取应用菜单列表
+   */
   getMenuListAppMenu(
     query: getMenuListAppMenuQuery,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<object>;
-  // 分页列表
+  /**
+   * 分页列表
+   */
   getMenuPageList(
     query: getMenuPageListQuery,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<IPage<ShortcutMenuResponse>>;
-  // 批量保存
+  /**
+   * 批量保存
+   */
   postMenuSaveBatch(config?: Partial<AxiosRequestConfig>): Promise<string>;
-  // 修改
+  /**
+   * 修改
+   */
   putMenuId(
     path: putMenuIdPathParams,
     data: ShortcutMenuRequest,

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

@@ -7,43 +7,63 @@ import type {
 } from '../entities';
 
 export interface deleteQuery {
-  ids: string; // 删除的id，多个按','分割
+  /**
+   * 删除的id，多个按','分割
+   */
+  ids: string;
 }
 export interface getInfoQuery {
-  id: string; // id
+  /**
+   * id
+   */
+  id: string;
 }
 export interface putIdPathParams {
   id: string;
 }
 export interface SignLogService {
-  // 保存
+  /**
+   * 保存
+   */
   post(
     data: SignLogRequestDTO,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<string>;
-  // 删除
+  /**
+   * 删除
+   */
   delete(
     query: deleteQuery,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<string>;
-  // 详情
+  /**
+   * 详情
+   */
   getInfo(
     query: getInfoQuery,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<SignLogResponse>;
-  // 列表
+  /**
+   * 列表
+   */
   getList(config?: Partial<AxiosRequestConfig>): Promise<SignLogResponse[]>;
-  // 操作人
+  /**
+   * 操作人
+   */
   postOperators(
     data: SignLogRequest,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<UserInfo[]>;
-  // 分页列表
+  /**
+   * 分页列表
+   */
   postPageList(
     data: SignLogRequest,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<IPage<SignLogResponse>>;
-  // 修改
+  /**
+   * 修改
+   */
   putId(
     path: putIdPathParams,
     data: SignLogRequest,

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

@@ -2,12 +2,16 @@ import type { AxiosRequestConfig } from 'axios';
 import type { SmsDto } from '../entities';
 
 export interface SmsService {
-  // 获取短信功能的签名与短信模板
+  /**
+   * 获取短信功能的签名与短信模板
+   */
   postGetSignsAndTemplates(
     data: SmsDto,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<IObject>;
-  // 发送短消息
+  /**
+   * 发送短消息
+   */
   postSendMsg(
     data: SmsDto,
     config?: Partial<AxiosRequestConfig>,

package/es/platform/service/apis/started-process.service.d.ts

@@ -2,34 +2,63 @@ import type { AxiosRequestConfig } from 'axios';
 import type { StartedProcessResponse, AppProcess } from '../entities';
 
 export interface deleteQuery {
-  ids: string; // 删除的id，多个按','分割
+  /**
+   * 删除的id，多个按','分割
+   */
+  ids: string;
 }
 export interface getInfoQuery {
-  id: string; // id
+  /**
+   * id
+   */
+  id: string;
 }
 export interface getPageListQuery {
-  finished?: boolean; // 已完成
-  pageNo?: number; // 页码
-  pageSize?: number; // 每页数据条数
-  processId?: string; // 流程ID
-  processTitle?: string; // 流程标题
+  /**
+   * 已完成
+   */
+  finished?: boolean;
+  /**
+   * 页码
+   */
+  pageNo?: number;
+  /**
+   * 每页数据条数
+   */
+  pageSize?: number;
+  /**
+   * 流程ID
+   */
+  processId?: string;
+  /**
+   * 流程标题
+   */
+  processTitle?: string;
 }
 export interface StartedProcessService {
-  // 删除
+  /**
+   * 删除
+   */
   delete(
     query: deleteQuery,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<string>;
-  // 详情
+  /**
+   * 详情
+   */
   getInfo(
     query: getInfoQuery,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<StartedProcessResponse>;
-  // 分页列表
+  /**
+   * 分页列表
+   */
   getPageList(
     query: getPageListQuery,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<IPage<StartedProcessResponse>>;
-  // 我的流程
+  /**
+   * 我的流程
+   */
   getProcess(config?: Partial<AxiosRequestConfig>): Promise<AppProcess[]>;
 }