@gct-paas/api 0.1.0-dev.0

package/es/platform/service/apis/knowledge-base-chunk.service.d.ts

@@ -0,0 +1,50 @@
+import type {
+  KnowledgeBaseChunkRequest,
+  KnowledgeBaseChunkResponse,
+} from '../entities';
+
+export interface deleteQuery {
+  ids: string; // 删除的id，多个按','分割
+}
+export interface getInfoQuery {
+  id: string; // id
+}
+export interface getPageListQuery {
+  pageNo?: number; // 页码
+  pageSize?: number; // 每页数据条数
+}
+export interface putIdQuery {
+  id: string; // 数据主键
+}
+export interface KnowledgeBaseChunkService {
+  // 保存
+  post(
+    data: KnowledgeBaseChunkRequest,
+    config?: Record<string, string>,
+  ): Promise<IHttpResponse<string>>;
+  // 删除
+  delete(
+    query: deleteQuery,
+    config?: Record<string, string>,
+  ): Promise<IHttpResponse<string>>;
+  // 详情
+  getInfo(
+    query: getInfoQuery,
+    config?: Record<string, string>,
+  ): Promise<IHttpResponse<KnowledgeBaseChunkResponse>>;
+  // 列表
+  getList(
+    config?: Record<string, string>,
+  ): Promise<IHttpResponse<KnowledgeBaseChunkResponse[]>>;
+  // 分页列表
+  getPageList(
+    query: getPageListQuery,
+    config?: Record<string, string>,
+  ): Promise<IHttpResponse<IPage<KnowledgeBaseChunkResponse>>>;
+  // 修改
+  putId(
+    query: putIdQuery,
+    data: KnowledgeBaseChunkRequest,
+    config?: Record<string, string>,
+  ): Promise<IHttpResponse<string>>;
+}

package/es/platform/service/apis/knowledge-base-doc.service.d.ts

@@ -0,0 +1,50 @@
+import type {
+  KnowledgeBaseDocRequest,
+  KnowledgeBaseDocResponse,
+} from '../entities';
+
+export interface deleteQuery {
+  ids: string; // 删除的id，多个按','分割
+}
+export interface getInfoQuery {
+  id: string; // id
+}
+export interface getPageListQuery {
+  pageNo?: number; // 页码
+  pageSize?: number; // 每页数据条数
+}
+export interface putIdQuery {
+  id: string; // 数据主键
+}
+export interface KnowledgeBaseDocService {
+  // 保存
+  post(
+    data: KnowledgeBaseDocRequest,
+    config?: Record<string, string>,
+  ): Promise<IHttpResponse<string>>;
+  // 删除
+  delete(
+    query: deleteQuery,
+    config?: Record<string, string>,
+  ): Promise<IHttpResponse<string>>;
+  // 详情
+  getInfo(
+    query: getInfoQuery,
+    config?: Record<string, string>,
+  ): Promise<IHttpResponse<KnowledgeBaseDocResponse>>;
+  // 列表
+  getList(
+    config?: Record<string, string>,
+  ): Promise<IHttpResponse<KnowledgeBaseDocResponse[]>>;
+  // 分页列表
+  getPageList(
+    query: getPageListQuery,
+    config?: Record<string, string>,
+  ): Promise<IHttpResponse<IPage<KnowledgeBaseDocResponse>>>;
+  // 修改
+  putId(
+    query: putIdQuery,
+    data: KnowledgeBaseDocRequest,
+    config?: Record<string, string>,
+  ): Promise<IHttpResponse<string>>;
+}

package/es/platform/service/apis/knowledge-base.service.d.ts

@@ -0,0 +1,47 @@
+import type { KnowledgeBaseRequest, KnowledgeBaseResponse } from '../entities';
+
+export interface deleteQuery {
+  ids: string; // 删除的id，多个按','分割
+}
+export interface getInfoQuery {
+  id: string; // id
+}
+export interface getPageListQuery {
+  pageNo?: number; // 页码
+  pageSize?: number; // 每页数据条数
+}
+export interface putIdQuery {
+  id: string; // 数据主键
+}
+export interface KnowledgeBaseService {
+  // 保存
+  post(
+    data: KnowledgeBaseRequest,
+    config?: Record<string, string>,
+  ): Promise<IHttpResponse<string>>;
+  // 删除
+  delete(
+    query: deleteQuery,
+    config?: Record<string, string>,
+  ): Promise<IHttpResponse<string>>;
+  // 详情
+  getInfo(
+    query: getInfoQuery,
+    config?: Record<string, string>,
+  ): Promise<IHttpResponse<KnowledgeBaseResponse>>;
+  // 列表
+  getList(
+    config?: Record<string, string>,
+  ): Promise<IHttpResponse<KnowledgeBaseResponse[]>>;
+  // 分页列表
+  getPageList(
+    query: getPageListQuery,
+    config?: Record<string, string>,
+  ): Promise<IHttpResponse<IPage<KnowledgeBaseResponse>>>;
+  // 修改
+  putId(
+    query: putIdQuery,
+    data: KnowledgeBaseRequest,
+    config?: Record<string, string>,
+  ): Promise<IHttpResponse<string>>;
+}

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

@@ -0,0 +1,6 @@
+export interface LdapService {
+  // 文件上传minio
+  postUploadCertificate(
+    config?: Record<string, string>,
+  ): Promise<IHttpResponse<string>>;
+}

package/es/platform/service/apis/license-unbind-log.service.d.ts

@@ -0,0 +1,9 @@
+import type { LicenseUnbindLogRequest } from '../entities';
+
+export interface LicenseUnbindLogService {
+  // 保存
+  post(
+    data: LicenseUnbindLogRequest,
+    config?: Record<string, string>,
+  ): Promise<IHttpResponse<string>>;
+}

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

@@ -0,0 +1,128 @@
+import type {
+  ClientsDto,
+  AuthBasicInfo,
+  LicenseExpireMsg,
+  LicenseLimitResponse,
+  AcLicenseResponse,
+} from '../entities';
+
+export interface getActivateQuery {
+  appId?: string; // 应用id
+  authorizationCode: string; // 激活码
+  increment?: boolean; // 增量激活
+  suiteKey?: string; // 应用Key
+  version?: string; // 平台版本
+}
+export interface postActivatesQuery {
+  increment?: boolean; // 增量激活
+}
+export interface postActivatesOfflineQuery {
+  appId?: string; // 应用id
+  productType: string; // 应用Key
+}
+export interface getClientsQuery {
+  appId: string; // appId
+}
+export interface getGetAppBasicInfoQuery {
+  appId?: string; // 应用id
+}
+export interface getGetExpireMsgQuery {
+  appId?: string; // 应用id
+  env?: string; // 授权环境
+}
+export interface getGetUsersQuery {
+  appId?: string; // 应用id
+  clientId: string; // 客户端id
+  env?: string; // 环境
+}
+export interface getInfoQuery {
+  licenseId: string; // licenseId授权信息id
+}
+export interface getPageListQuery {
+  appId?: string; // 应用id
+  env?: string; // 授权环境
+  pageNo?: number; // 页码
+  pageSize?: number; // 每页数据条数
+  productType?: string; // 产品类型
+}
+export interface getShareTagQuery {
+  appId?: string; // 应用id
+}
+export interface getSourceTagQuery {
+  appId?: string; // 应用id
+}
+export interface getUnbindQuery {
+  appId?: string; // appId
+  env?: string; // 授权环境
+  licenseId: string; // licenseId授权信息id
+}
+export interface LicenseService {
+  // 平台和应用激活
+  getActivate(
+    query: getActivateQuery,
+    config?: Record<string, string>,
+  ): Promise<IHttpResponse<string>>;
+  // 平台和应用激活
+  postActivates(
+    query: postActivatesQuery,
+    config?: Record<string, string>,
+  ): Promise<IHttpResponse<string>>;
+  // 平台和应用激活
+  postActivatesOffline(
+    query: postActivatesOfflineQuery,
+    config?: Record<string, string>,
+  ): Promise<IHttpResponse<string>>;
+  // 证书校验，用于平台登录前判断是否在有效期
+  getCheckLicense(
+    config?: Record<string, string>,
+  ): Promise<IHttpResponse<boolean>>;
+  // 获取在线客户端
+  getClients(
+    query: getClientsQuery,
+    config?: Record<string, string>,
+  ): Promise<IHttpResponse<ClientsDto[]>>;
+  // 离线授权获取二维码信息
+  getGetAppBasicInfo(
+    query: getGetAppBasicInfoQuery,
+    config?: Record<string, string>,
+  ): Promise<IHttpResponse<AuthBasicInfo>>;
+  // 获取过期提醒
+  getGetExpireMsg(
+    query: getGetExpireMsgQuery,
+    config?: Record<string, string>,
+  ): Promise<IHttpResponse<LicenseExpireMsg[]>>;
+  // 判断是否满足用户数授权条件
+  getGetUsers(
+    query: getGetUsersQuery,
+    config?: Record<string, string>,
+  ): Promise<IHttpResponse<boolean>>;
+  // 平台应用，授权详情
+  getInfo(
+    query: getInfoQuery,
+    config?: Record<string, string>,
+  ): Promise<IHttpResponse<LicenseLimitResponse[]>>;
+  // 平台/应用，授权列表
+  getPageList(
+    query: getPageListQuery,
+    config?: Record<string, string>,
+  ): Promise<IHttpResponse<IPage<AcLicenseResponse>>>;
+  // 判断是否为被共享应用
+  getShareTag(
+    query: getShareTagQuery,
+    config?: Record<string, string>,
+  ): Promise<IHttpResponse<boolean>>;
+  // 判断是否为共享应用
+  getSourceTag(
+    query: getSourceTagQuery,
+    config?: Record<string, string>,
+  ): Promise<IHttpResponse<boolean>>;
+  // 授权解绑
+  getUnbind(
+    query: getUnbindQuery,
+    config?: Record<string, string>,
+  ): Promise<IHttpResponse<boolean>>;
+  // 执行shell脚本并清空授权
+  getUninstall(config?: Record<string, string>): Promise<IHttpResponse<string>>;
+  // 环境校验
+  getVerify(config?: Record<string, string>): Promise<IHttpResponse<boolean>>;
+}

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

@@ -0,0 +1,17 @@
+import type { LoginLogResponse } from '../entities';
+
+export interface getPageListQuery {
+  endTime?: string; // 截止时间
+  ip?: string; // IP地址
+  pageNo?: number; // 页码
+  pageSize?: number; // 每页数据条数
+  sourceEnum?: string; // 客户端
+  startTime?: string; // 开始时间
+}
+export interface LoginLogService {
+  // 登录足迹分页列表
+  getPageList(
+    query: getPageListQuery,
+    config?: Record<string, string>,
+  ): Promise<IHttpResponse<IPage<LoginLogResponse>>>;
+}

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

@@ -0,0 +1,43 @@
+import type {
+  ThirdAppConfigReq,
+  SmsDto,
+  UserBaseReq,
+  UserLoginResp,
+} from '../entities';
+
+export interface getSignOutQuery {
+  appId?: string; // 应用id
+  env?: string; // 应用环境
+  platform?: string; // 页面SystemTypeEnum
+}
+export interface getUserAppAuthQuery {
+  appId: string; // 应用id
+  clientId: string; // 客户端id
+}
+export interface LoginService {
+  // 验证第三方平台是否注册正常
+  postCheckApp(
+    data: ThirdAppConfigReq,
+    config?: Record<string, string>,
+  ): Promise<IHttpResponse<string>>;
+  // 短信登录发送短信
+  postSendMsg(
+    data: SmsDto,
+    config?: Record<string, string>,
+  ): Promise<IHttpResponse<string>>;
+  // 登录api
+  postSign(
+    data: UserBaseReq,
+    config?: Record<string, string>,
+  ): Promise<IHttpResponse<UserLoginResp>>;
+  // 退出登录
+  getSignOut(
+    query: getSignOutQuery,
+    config?: Record<string, string>,
+  ): Promise<IHttpResponse<string>>;
+  // 当前人员登录app时是否有权限
+  getUserAppAuth(
+    query: getUserAppAuthQuery,
+    config?: Record<string, string>,
+  ): Promise<IHttpResponse<boolean>>;
+}

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

@@ -0,0 +1,22 @@
+import type { ManagerBean } from '../entities';
+
+export interface getPlatPageListQuery {
+  pageNo?: number; // 页码
+  pageSize?: number; // 每页数据条数
+}
+export interface getTenantPageListQuery {
+  pageNo?: number; // 页码
+  pageSize?: number; // 每页数据条数
+}
+export interface ManagerService {
+  // (平台管理)管理员分页列表
+  getPlatPageList(
+    query: getPlatPageListQuery,
+    config?: Record<string, string>,
+  ): Promise<IHttpResponse<IPage<ManagerBean>>>;
+  // (租户管理后台)管理员分页列表
+  getTenantPageList(
+    query: getTenantPageListQuery,
+    config?: Record<string, string>,
+  ): Promise<IHttpResponse<IPage<ManagerBean>>>;
+}

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

@@ -0,0 +1,85 @@
+import type {
+  MessageSettingRequest,
+  MessageSettingCountResponse,
+  MessageSettingResponse,
+  SendMessageRequest,
+  SendEmailMessageRequest,
+} from '../entities';
+
+export interface deleteQuery {
+  ids: string; // 删除的id，多个按','分割
+}
+export interface getInfoQuery {
+  id: string; // id
+}
+export interface getListQuery {
+  type?: string; // type
+}
+export interface getPageListQuery {
+  endTime?: string; // 结束时间
+  key?: string; // key
+  name?: string; // 名称
+  pageNo?: number; // 页码
+  pageSize?: number; // 分页大小
+  remark?: string; // 备注
+  serviceType?: string; // 服务类型
+  sortField?: string; // 排序字段
+  sortType?: string; // 排序方式：ASC/DESC， 不传默认 ASC
+  startTime?: string; // 开始时间
+  type?: string; // 消息分类
+}
+export interface putIdQuery {
+  id: string; // 数据主键
+}
+export interface MessageSettingService {
+  // 保存
+  post(
+    data: MessageSettingRequest,
+    config?: Record<string, string>,
+  ): Promise<IHttpResponse<string>>;
+  // 删除
+  delete(
+    query: deleteQuery,
+    config?: Record<string, string>,
+  ): Promise<IHttpResponse<string>>;
+  // 获取各个类型的数据条数
+  getGetTypeCount(
+    config?: Record<string, string>,
+  ): Promise<IHttpResponse<MessageSettingCountResponse>>;
+  // 详情
+  getInfo(
+    query: getInfoQuery,
+    config?: Record<string, string>,
+  ): Promise<IHttpResponse<MessageSettingResponse>>;
+  // 列表
+  getList(
+    query: getListQuery,
+    config?: Record<string, string>,
+  ): Promise<IHttpResponse<MessageSettingResponse[]>>;
+  // 调试用api测试发送MQTT消息
+  postMqttSend(
+    data: SendMessageRequest,
+    config?: Record<string, string>,
+  ): Promise<IHttpResponse<string>>;
+  // 分页列表
+  getPageList(
+    query: getPageListQuery,
+    config?: Record<string, string>,
+  ): Promise<IHttpResponse<IPage<MessageSettingResponse>>>;
+  // 测试发送邮箱消息
+  postSendEmailMessage(
+    data: SendEmailMessageRequest,
+    config?: Record<string, string>,
+  ): Promise<IHttpResponse<boolean>>;
+  // 测试发送企业微信、钉钉、飞书消息
+  postSendMessage(
+    data: SendMessageRequest,
+    config?: Record<string, string>,
+  ): Promise<IHttpResponse<boolean>>;
+  // 修改
+  putId(
+    query: putIdQuery,
+    data: MessageSettingRequest,
+    config?: Record<string, string>,
+  ): Promise<IHttpResponse<string>>;
+}

package/es/platform/service/apis/minio-file.service.d.ts

@@ -0,0 +1,17 @@
+import type { Base64UploadPlatFormRequest } from '../entities';
+
+export interface getDownloadQuery {
+  fileUrl: string; // fileUrl
+}
+export interface MinioFileService {
+  // base64文件上传minio
+  postBase64Upload(
+    data: Base64UploadPlatFormRequest,
+    config?: Record<string, string>,
+  ): Promise<IHttpResponse<string>>;
+  // minIO获取文件公用接口
+  getDownload(
+    query: getDownloadQuery,
+    config?: Record<string, string>,
+  ): Promise<IHttpResponse<unknown>>;
+}

package/es/platform/service/apis/model-provider.service.d.ts

@@ -0,0 +1,47 @@
+import type { ModelProviderRequest, ModelProviderResponse } from '../entities';
+
+export interface deleteQuery {
+  ids: string; // 删除的id，多个按','分割
+}
+export interface getInfoQuery {
+  id: string; // id
+}
+export interface getPageListQuery {
+  pageNo?: number; // 页码
+  pageSize?: number; // 每页数据条数
+}
+export interface putIdQuery {
+  id: string; // 数据主键
+}
+export interface ModelProviderService {
+  // 保存
+  post(
+    data: ModelProviderRequest,
+    config?: Record<string, string>,
+  ): Promise<IHttpResponse<string>>;
+  // 删除
+  delete(
+    query: deleteQuery,
+    config?: Record<string, string>,
+  ): Promise<IHttpResponse<string>>;
+  // 详情
+  getInfo(
+    query: getInfoQuery,
+    config?: Record<string, string>,
+  ): Promise<IHttpResponse<ModelProviderResponse>>;
+  // 列表
+  getList(
+    config?: Record<string, string>,
+  ): Promise<IHttpResponse<ModelProviderResponse[]>>;
+  // 分页列表
+  getPageList(
+    query: getPageListQuery,
+    config?: Record<string, string>,
+  ): Promise<IHttpResponse<IPage<ModelProviderResponse>>>;
+  // 修改
+  putId(
+    query: putIdQuery,
+    data: ModelProviderRequest,
+    config?: Record<string, string>,
+  ): Promise<IHttpResponse<string>>;
+}

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

@@ -0,0 +1,47 @@
+import type { ModelRequest, ModelResponse } from '../entities';
+
+export interface deleteQuery {
+  ids: string; // 删除的id，多个按','分割
+}
+export interface getInfoQuery {
+  id: string; // id
+}
+export interface getPageListQuery {
+  pageNo?: number; // 页码
+  pageSize?: number; // 每页数据条数
+}
+export interface putIdQuery {
+  id: string; // 数据主键
+}
+export interface ModelService {
+  // 保存
+  post(
+    data: ModelRequest,
+    config?: Record<string, string>,
+  ): Promise<IHttpResponse<string>>;
+  // 删除
+  delete(
+    query: deleteQuery,
+    config?: Record<string, string>,
+  ): Promise<IHttpResponse<string>>;
+  // 详情
+  getInfo(
+    query: getInfoQuery,
+    config?: Record<string, string>,
+  ): Promise<IHttpResponse<ModelResponse>>;
+  // 列表
+  getList(
+    config?: Record<string, string>,
+  ): Promise<IHttpResponse<ModelResponse[]>>;
+  // 分页列表
+  getPageList(
+    query: getPageListQuery,
+    config?: Record<string, string>,
+  ): Promise<IHttpResponse<IPage<ModelResponse>>>;
+  // 修改
+  putId(
+    query: putIdQuery,
+    data: ModelRequest,
+    config?: Record<string, string>,
+  ): Promise<IHttpResponse<string>>;
+}

package/es/platform/service/apis/nav-menu.service.d.ts

@@ -0,0 +1,65 @@
+import type {
+  NavMenuRequest,
+  NavMenuResponse,
+  SingleRequest,
+} from '../entities';
+
+export interface deleteQuery {
+  ids: string; // 删除的id，多个按','分割
+}
+export interface getInfoQuery {
+  id: string; // id
+}
+export interface getPageListQuery {
+  pageNo?: number; // 页码
+  pageSize?: number; // 每页数据条数
+}
+export interface putIdQuery {
+  id: string; // 数据主键
+}
+export interface NavMenuService {
+  // 保存
+  post(
+    data: NavMenuRequest,
+    config?: Record<string, string>,
+  ): Promise<IHttpResponse<string>>;
+  // 删除
+  delete(
+    query: deleteQuery,
+    config?: Record<string, string>,
+  ): Promise<IHttpResponse<string>>;
+  // 查询选中的
+  getGetSelected(
+    config?: Record<string, string>,
+  ): Promise<IHttpResponse<NavMenuResponse>>;
+  // 详情
+  getInfo(
+    query: getInfoQuery,
+    config?: Record<string, string>,
+  ): Promise<IHttpResponse<NavMenuResponse>>;
+  // 列表
+  getList(
+    config?: Record<string, string>,
+  ): Promise<IHttpResponse<NavMenuResponse[]>>;
+  // 分页列表
+  getPageList(
+    query: getPageListQuery,
+    config?: Record<string, string>,
+  ): Promise<IHttpResponse<IPage<NavMenuResponse>>>;
+  // 选中页面，不传id代表都不选中
+  postSelect(
+    data: SingleRequest,
+    config?: Record<string, string>,
+  ): Promise<IHttpResponse<string>>;
+  // 修改页面设计Json
+  putUpdateDesignerJsonId(
+    data: NavMenuRequest,
+    config?: Record<string, string>,
+  ): Promise<IHttpResponse<string>>;
+  // 修改
+  putId(
+    query: putIdQuery,
+    data: NavMenuRequest,
+    config?: Record<string, string>,
+  ): Promise<IHttpResponse<string>>;
+}