@gct-paas/api 0.1.0-word.2 → 0.1.0

package/lib/apaas/service/apis/global-method.service.d.ts

@@ -1,3 +1,4 @@
+import type { AxiosRequestConfig } from 'axios';
 import type {
   GlobalMethodRequest,
   LocalDateTime,
@@ -5,51 +6,75 @@ import type {
 } 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 GlobalMethodService {
-  // 保存
+  /**
+   * 保存
+   */
   post(
     data: GlobalMethodRequest,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<string>>;
-  // 删除
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<string>;
+  /**
+   * 删除
+   */
   delete(
     query: deleteQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<string>>;
-  // 获取当前时间
-  getCurrentTime(
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<LocalDateTime>>;
-  // 详情
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<string>;
+  /**
+   * 获取当前时间
+   */
+  getCurrentTime(config?: Partial<AxiosRequestConfig>): Promise<LocalDateTime>;
+  /**
+   * 详情
+   */
   getInfo(
     query: getInfoQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<GlobalMethodResponse>>;
-  // 列表
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<GlobalMethodResponse>;
+  /**
+   * 列表
+   */
   getList(
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<GlobalMethodResponse[]>>;
-  // 分页列表
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<GlobalMethodResponse[]>;
+  /**
+   * 分页列表
+   */
   getPageList(
     query: getPageListQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<IPage<GlobalMethodResponse>>>;
-  // 修改
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<IPage<GlobalMethodResponse>>;
+  /**
+   * 修改
+   */
   putId(
-    query: putIdQuery,
+    path: putIdPathParams,
     data: GlobalMethodRequest,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<string>>;
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<string>;
 }

package/lib/apaas/service/apis/i18n-info.service.d.ts

@@ -1,48 +1,84 @@
+/* eslint-disable @typescript-eslint/no-explicit-any */
+import type { AxiosRequestConfig } from 'axios';
 import type { I18nInfoRequest, I18nInfoResponse } from '../entities';
 
 export interface deleteQuery {
-  ids: string; // 删除的id，多个按','分割
+  /**
+   * 删除的id，多个按','分割
+   */
+  ids: string;
 }
 export interface getLangDownloadQuery {
-  exportData?: boolean; // 是否导出数据 false 不导出,true 导出数据
+  /**
+   * 是否导出数据 false 不导出,true 导出数据
+   */
+  exportData?: boolean;
 }
 export interface postLangUploadQuery {
-  skipValid?: boolean; // skipValid
+  /**
+   * skipValid
+   */
+  skipValid?: boolean;
 }
 export interface getPageListQuery {
-  pageNo?: number; // 页码
-  pageSize?: number; // 每页数据条数
-  searchKey?: string; // searchKey
+  /**
+   * 页码
+   */
+  pageNo?: number;
+  /**
+   * 每页数据条数
+   */
+  pageSize?: number;
+  /**
+   * searchKey
+   */
+  searchKey?: string;
+}
+export interface putKeyPathParams {
+  key: string;
 }
 export interface I18NInfoService {
-  // 保存
+  /**
+   * 保存
+   */
   post(
     data: I18nInfoRequest,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<string>>;
-  // 删除
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<string>;
+  /**
+   * 删除
+   */
   delete(
     query: deleteQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<string>>;
-  // 导出多语言/或导出模板
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<string>;
+  /**
+   * 导出多语言/或导出模板
+   */
   getLangDownload(
     query: getLangDownloadQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<unknown>>;
-  // 多语言导入
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<any>;
+  /**
+   * 多语言导入
+   */
   postLangUpload(
     query: postLangUploadQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<object>>;
-  // 分页列表
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<object>;
+  /**
+   * 分页列表
+   */
   getPageList(
     query: getPageListQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<IPage<I18nInfoResponse>>>;
-  // 修改
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<IPage<I18nInfoResponse>>;
+  /**
+   * 修改
+   */
   putKey(
+    path: putKeyPathParams,
     data: I18nInfoRequest,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<string>>;
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<string>;
 }

package/lib/apaas/service/apis/import-report.service.d.ts

@@ -0,0 +1,41 @@
+import type { AxiosRequestConfig } from 'axios';
+import type { ImportReportResponse } from '../entities';
+
+export interface getInfoQuery {
+  /**
+   * id
+   */
+  id: string;
+}
+export interface getPageListQuery {
+  /**
+   * 页码
+   */
+  pageNo?: number;
+  /**
+   * 每页数据条数
+   */
+  pageSize?: number;
+}
+export interface ImportReportService {
+  /**
+   * 详情
+   */
+  getInfo(
+    query: getInfoQuery,
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<ImportReportResponse>;
+  /**
+   * 列表
+   */
+  getList(
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<ImportReportResponse[]>;
+  /**
+   * 分页列表
+   */
+  getPageList(
+    query: getPageListQuery,
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<IPage<ImportReportResponse>>;
+}

package/lib/apaas/service/apis/instance-relation.service.d.ts

@@ -1,52 +1,89 @@
+import type { AxiosRequestConfig } from 'axios';
 import type {
   InstanceRelationRequest,
   InstanceRelationResponse,
 } from '../entities';
 
 export interface getInfoQuery {
-  id: string; // id
+  /**
+   * id
+   */
+  id: string;
 }
 export interface getPageListQuery {
-  pageNo?: number; // 页码
-  pageSize?: number; // 每页数据条数
+  /**
+   * 页码
+   */
+  pageNo?: number;
+  /**
+   * 每页数据条数
+   */
+  pageSize?: number;
 }
 export interface deleteUnbindQuery {
-  instId: string; // 关联实例id
-  materialNo: string; // 批次号
+  /**
+   * 关联实例id
+   */
+  instId: string;
+  /**
+   * 批次号
+   */
+  materialNo: string;
 }
 export interface putUpdateTitleQuery {
-  materialNo: string; // materialNo
-  ofInstId: string; // ofInstId
-  title: string; // title
+  /**
+   * materialNo
+   */
+  materialNo: string;
+  /**
+   * ofInstId
+   */
+  ofInstId: string;
+  /**
+   * title
+   */
+  title: string;
 }
 export interface InstanceRelationService {
-  // 绑定表单任务实例
+  /**
+   * 绑定表单任务实例
+   */
   postBind(
     data: InstanceRelationRequest,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<string>>;
-  // 详情
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<string>;
+  /**
+   * 详情
+   */
   getInfo(
     query: getInfoQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<InstanceRelationResponse>>;
-  // 列表
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<InstanceRelationResponse>;
+  /**
+   * 列表
+   */
   getList(
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<InstanceRelationResponse[]>>;
-  // 分页列表
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<InstanceRelationResponse[]>;
+  /**
+   * 分页列表
+   */
   getPageList(
     query: getPageListQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<IPage<InstanceRelationResponse>>>;
-  // 解绑表单任务实例
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<IPage<InstanceRelationResponse>>;
+  /**
+   * 解绑表单任务实例
+   */
   deleteUnbind(
     query: deleteUnbindQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<string>>;
-  // 修改标题-附录
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<string>;
+  /**
+   * 修改标题-附录
+   */
   putUpdateTitle(
     query: putUpdateTitleQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<boolean>>;
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<boolean>;
 }

package/lib/apaas/service/apis/ipaas.service.d.ts

@@ -1,9 +1,12 @@
+import type { AxiosRequestConfig } from 'axios';
 import type { WebhookRequest } from '../entities';
 
 export interface IpaasService {
-  // 调用webhook
+  /**
+   * 调用webhook
+   */
   postWebhook(
     data: WebhookRequest,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<object>>;
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<object>;
 }

package/lib/apaas/service/apis/job-log.service.d.ts

@@ -1,31 +1,63 @@
+import type { AxiosRequestConfig } from 'axios';
 import type { JobLogResponse } from '../entities';
 
 export interface getInfoQuery {
-  id: string; // id
+  /**
+   * id
+   */
+  id: string;
 }
 export interface getPageListQuery {
-  endTime?: string; // 触发截止时间
-  keyword?: string; // 定时任务名称搜索
-  operator?: string; // 操作人
-  pageNo?: number; // 页码
-  pageSize?: number; // 每页数据条数
-  startTime?: string; // 触发开始时间
-  status?: string; // 触发结果(成功 SUCCEED/失败 FAILURE)
-  triggerMode?: string; // 触发方式(手动触发 MANUAL/定时触发 AUTO)
+  /**
+   * 触发截止时间
+   */
+  endTime?: string;
+  /**
+   * 定时任务名称搜索
+   */
+  keyword?: string;
+  /**
+   * 操作人
+   */
+  operator?: string;
+  /**
+   * 页码
+   */
+  pageNo?: number;
+  /**
+   * 每页数据条数
+   */
+  pageSize?: number;
+  /**
+   * 触发开始时间
+   */
+  startTime?: string;
+  /**
+   * 触发结果(成功 SUCCEED/失败 FAILURE)
+   */
+  status?: string;
+  /**
+   * 触发方式(手动触发 MANUAL/定时触发 AUTO)
+   */
+  triggerMode?: string;
 }
 export interface JobLogService {
-  // 详情
+  /**
+   * 详情
+   */
   getInfo(
     query: getInfoQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<JobLogResponse>>;
-  // 列表
-  getList(
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<JobLogResponse[]>>;
-  // 分页查询日志列表
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<JobLogResponse>;
+  /**
+   * 列表
+   */
+  getList(config?: Partial<AxiosRequestConfig>): Promise<JobLogResponse[]>;
+  /**
+   * 分页查询日志列表
+   */
   getPageList(
     query: getPageListQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<IPage<JobLogResponse>>>;
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<IPage<JobLogResponse>>;
 }

package/lib/apaas/service/apis/job.service.d.ts

@@ -1,77 +1,133 @@
+import type { AxiosRequestConfig } from 'axios';
 import type { JobRequest, CronDTO, JobResponse } from '../entities';
 
 export interface deleteQuery {
-  ids: string; // 删除的id，多个按','分割
+  /**
+   * 删除的id，多个按','分割
+   */
+  ids: string;
 }
 export interface postExecQuery {
-  id: string; // 定时任务id
+  /**
+   * 定时任务id
+   */
+  id: string;
 }
 export interface getInfoQuery {
-  id: string; // id
+  /**
+   * id
+   */
+  id: string;
 }
 export interface getListQuery {
-  keyword?: string; // 查询条件
+  /**
+   * 查询条件
+   */
+  keyword?: string;
 }
 export interface getPageListQuery {
-  keyword?: string; // 定时任务名称
-  pageNo?: number; // 页码
-  pageSize?: number; // 每页数据条数
-  resourceName?: string; // 触发方式服务名称
-  resourceType?: string; // 触发方式(js脚本:SCRIPT_SERVICE/服务编排:SO_SERVICE)
-  status?: string; // 状态(启用 ENABLED/禁用 DISABLED)
-  triggerPolicy?: string; // 触发类型(单次触发 ONCE/重复触发 REPEAT/ CRON)
+  /**
+   * 定时任务名称
+   */
+  keyword?: string;
+  /**
+   * 页码
+   */
+  pageNo?: number;
+  /**
+   * 每页数据条数
+   */
+  pageSize?: number;
+  /**
+   * 触发方式服务名称
+   */
+  resourceName?: string;
+  /**
+   * 触发方式(js脚本:SCRIPT_SERVICE/服务编排:SO_SERVICE)
+   */
+  resourceType?: string;
+  /**
+   * 状态(启用 ENABLED/禁用 DISABLED)
+   */
+  status?: string;
+  /**
+   * 触发类型(单次触发 ONCE/重复触发 REPEAT/ CRON)
+   */
+  triggerPolicy?: string;
 }
 export interface putStatusIdQuery {
-  status: string; // 启用禁用 ENABLED/DISABLED
+  /**
+   * 启用禁用 ENABLED/DISABLED
+   */
+  status: string;
 }
-export interface putIdQuery {
-  id: string; // 数据主键
+export interface putStatusIdPathParams {
+  id: string;
+}
+export interface putIdPathParams {
+  id: string;
 }
 export interface JobService {
-  // 定时任务保存
-  post(
-    data: JobRequest,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<string>>;
-  // 定时任务删除
+  /**
+   * 定时任务保存
+   */
+  post(data: JobRequest, config?: Partial<AxiosRequestConfig>): Promise<string>;
+  /**
+   * 定时任务删除
+   */
   delete(
     query: deleteQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<string>>;
-  // cron 表达式校验
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<string>;
+  /**
+   * cron 表达式校验
+   */
   postCronValid(
     data: CronDTO,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<string>>;
-  // 单次触发定时任务
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<string>;
+  /**
+   * 单次触发定时任务
+   */
   postExec(
     query: postExecQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<string>>;
-  // 定时任务详情
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<string>;
+  /**
+   * 定时任务详情
+   */
   getInfo(
     query: getInfoQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<JobResponse>>;
-  // 定时任务列表
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<JobResponse>;
+  /**
+   * 定时任务列表
+   */
   getList(
     query: getListQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<JobResponse[]>>;
-  // 定时任务分页列表
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<JobResponse[]>;
+  /**
+   * 定时任务分页列表
+   */
   getPageList(
     query: getPageListQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<IPage<JobResponse>>>;
-  // 定时任务启用禁用
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<IPage<JobResponse>>;
+  /**
+   * 定时任务启用禁用
+   */
   putStatusId(
+    path: putStatusIdPathParams,
     query: putStatusIdQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<string>>;
-  // 定时任务修改
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<string>;
+  /**
+   * 定时任务修改
+   */
   putId(
-    query: putIdQuery,
+    path: putIdPathParams,
     data: JobRequest,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<string>>;
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<string>;
 }