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

package/es/platform/service/apis/device-interconnection-param.service.d.ts

@@ -6,56 +6,83 @@ import type {
 } from '../entities';
 
 export interface deleteQuery {
-  id: string; // id
+  /**
+   * id
+   */
+  id: string;
 }
 export interface getInfoQuery {
-  id: string; // id
+  /**
+   * id
+   */
+  id: string;
 }
 export interface getPageListQuery {
-  keyword?: string; // 搜索关键字
-  pageNo: number; // 页码
-  pageSize: number; // 每页数据条数
+  /**
+   * 搜索关键字
+   */
+  keyword?: string;
+  /**
+   * 页码
+   */
+  pageNo: number;
+  /**
+   * 每页数据条数
+   */
+  pageSize: number;
 }
-export interface putIdQuery {
-  id: string; // 数据主键
+export interface putIdPathParams {
+  id: string;
 }
 export interface DeviceInterconnectionParamService {
-  // 新建
+  /**
+   * 新建
+   */
   post(
     data: DeviceInterconnectionParamRequest,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
-  // 删除
+  ): Promise<string>;
+  /**
+   * 删除
+   */
   delete(
     query: deleteQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
-  // 导出
-  postExport(
-    config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<ResponseEntity>>;
-  // 导入
-  postImport(
-    config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
-  // 详情
+  ): Promise<string>;
+  /**
+   * 导出
+   */
+  postExport(config?: Partial<AxiosRequestConfig>): Promise<ResponseEntity>;
+  /**
+   * 导入
+   */
+  postImport(config?: Partial<AxiosRequestConfig>): Promise<string>;
+  /**
+   * 详情
+   */
   getInfo(
     query: getInfoQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<DeviceInterconnectionParamResponse>>;
-  // 列表
+  ): Promise<DeviceInterconnectionParamResponse>;
+  /**
+   * 列表
+   */
   getList(
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<DeviceInterconnectionParamResponse[]>>;
-  // 分页列表
+  ): Promise<DeviceInterconnectionParamResponse[]>;
+  /**
+   * 分页列表
+   */
   getPageList(
     query: getPageListQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<IPage<DeviceInterconnectionParamResponse>>>;
-  // 编辑
+  ): Promise<IPage<DeviceInterconnectionParamResponse>>;
+  /**
+   * 编辑
+   */
   putId(
-    query: putIdQuery,
+    path: putIdPathParams,
     data: DeviceInterconnectionParamRequest,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
+  ): Promise<string>;
 }

package/es/platform/service/apis/device-interconnection.service.d.ts

@@ -5,64 +5,96 @@ import type {
 } from '../entities';
 
 export interface deleteQuery {
-  id: string; // 删除的id
+  /**
+   * 删除的id
+   */
+  id: string;
 }
 export interface getDataQuery {
-  deviceId: string; // 设备的id
+  /**
+   * 设备的id
+   */
+  deviceId: string;
 }
 export interface getInfoQuery {
-  id: string; // id
+  /**
+   * id
+   */
+  id: string;
 }
 export interface getPageListQuery {
-  keyword?: string; // 设备编号或名称
-  pageNo: number; // 页码
-  pageSize: number; // 每页数据条数
+  /**
+   * 设备编号或名称
+   */
+  keyword?: string;
+  /**
+   * 页码
+   */
+  pageNo: number;
+  /**
+   * 每页数据条数
+   */
+  pageSize: number;
 }
-export interface putIdQuery {
-  id: string; // 数据主键
+export interface putIdPathParams {
+  id: string;
 }
 export interface DeviceInterconnectionService {
-  // 新建
+  /**
+   * 新建
+   */
   post(
     data: DeviceInterconnectionRequest,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
-  // 删除
+  ): Promise<string>;
+  /**
+   * 删除
+   */
   delete(
     query: deleteQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<boolean>>;
-  // 获取设备数据（仅仅支持连接流）
+  ): Promise<boolean>;
+  /**
+   * 获取设备数据（仅仅支持连接流）
+   */
   getData(
     query: getDataQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
-  // 批量导出
-  postExport(
-    config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<unknown>>;
-  // 导入
-  postImport(
-    config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
-  // 详情
+  ): Promise<string>;
+  /**
+   * 批量导出
+   */
+  postExport(config?: Partial<AxiosRequestConfig>): Promise<unknown>;
+  /**
+   * 导入
+   */
+  postImport(config?: Partial<AxiosRequestConfig>): Promise<string>;
+  /**
+   * 详情
+   */
   getInfo(
     query: getInfoQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<DeviceInterconnectionResponse>>;
-  // 列表
+  ): Promise<DeviceInterconnectionResponse>;
+  /**
+   * 列表
+   */
   getList(
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<DeviceInterconnectionResponse[]>>;
-  // 分页列表
+  ): Promise<DeviceInterconnectionResponse[]>;
+  /**
+   * 分页列表
+   */
   getPageList(
     query: getPageListQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<IPage<DeviceInterconnectionResponse>>>;
-  // 编辑
+  ): Promise<IPage<DeviceInterconnectionResponse>>;
+  /**
+   * 编辑
+   */
   putId(
-    query: putIdQuery,
+    path: putIdPathParams,
     data: DeviceInterconnectionRequest,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
+  ): Promise<string>;
 }

package/es/platform/service/apis/device-param-ref.service.d.ts

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

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

@@ -1,59 +1,88 @@
 import type { AxiosRequestConfig } from 'axios';
 export interface getQuery {
-  pageTemplateId?: string; // pageTemplateId
+  /**
+   * pageTemplateId
+   */
+  pageTemplateId?: string;
 }
 export interface headQuery {
-  pageTemplateId?: string; // pageTemplateId
+  /**
+   * pageTemplateId
+   */
+  pageTemplateId?: string;
 }
 export interface postQuery {
-  pageTemplateId?: string; // pageTemplateId
+  /**
+   * pageTemplateId
+   */
+  pageTemplateId?: string;
 }
 export interface putQuery {
-  pageTemplateId?: string; // pageTemplateId
+  /**
+   * pageTemplateId
+   */
+  pageTemplateId?: string;
 }
 export interface deleteQuery {
-  pageTemplateId?: string; // pageTemplateId
+  /**
+   * pageTemplateId
+   */
+  pageTemplateId?: string;
 }
 export interface optionsQuery {
-  pageTemplateId?: string; // pageTemplateId
+  /**
+   * pageTemplateId
+   */
+  pageTemplateId?: string;
 }
 export interface patchQuery {
-  pageTemplateId?: string; // pageTemplateId
+  /**
+   * pageTemplateId
+   */
+  pageTemplateId?: string;
 }
 export interface ExportTemplateService {
-  // 导出模板
-  get(
-    query: getQuery,
-    config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<unknown>>;
-  // 导出模板
+  /**
+   * 导出模板
+   */
+  get(query: getQuery, config?: Partial<AxiosRequestConfig>): Promise<unknown>;
+  /**
+   * 导出模板
+   */
   head(
     query: headQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<unknown>>;
-  // 导出模板
+  ): Promise<unknown>;
+  /**
+   * 导出模板
+   */
   post(
     query: postQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<unknown>>;
-  // 导出模板
-  put(
-    query: putQuery,
-    config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<unknown>>;
-  // 导出模板
+  ): Promise<unknown>;
+  /**
+   * 导出模板
+   */
+  put(query: putQuery, config?: Partial<AxiosRequestConfig>): Promise<unknown>;
+  /**
+   * 导出模板
+   */
   delete(
     query: deleteQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<unknown>>;
-  // 导出模板
+  ): Promise<unknown>;
+  /**
+   * 导出模板
+   */
   options(
     query: optionsQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<unknown>>;
-  // 导出模板
+  ): Promise<unknown>;
+  /**
+   * 导出模板
+   */
   patch(
     query: patchQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<unknown>>;
+  ): Promise<unknown>;
 }

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

@@ -5,47 +5,71 @@ 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 ExternalMessageService {
-  // 保存
+  /**
+   * 保存
+   */
   post(
     data: ExternalMessageRequest,
     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<ExternalMessageResponse>>;
-  // 列表
+  ): Promise<ExternalMessageResponse>;
+  /**
+   * 列表
+   */
   getList(
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<ExternalMessageResponse[]>>;
-  // 分页列表
+  ): Promise<ExternalMessageResponse[]>;
+  /**
+   * 分页列表
+   */
   getPageList(
     query: getPageListQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<IPage<ExternalMessageResponse>>>;
-  // 修改
+  ): Promise<IPage<ExternalMessageResponse>>;
+  /**
+   * 修改
+   */
   putId(
-    query: putIdQuery,
+    path: putIdPathParams,
     data: ExternalMessageRequest,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
+  ): Promise<string>;
 }

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

@@ -6,66 +6,125 @@ import type {
 } from '../entities';
 
 export interface deleteQuery {
-  ids: string; // 删除的id，多个按','分割
+  /**
+   * 删除的id，多个按','分割
+   */
+  ids: string;
 }
 export interface getInfoQuery {
-  id: string; // id
+  /**
+   * id
+   */
+  id: string;
 }
 export interface getListQuery {
-  formTaskName?: string; // 单据任务名称
-  materialNo?: string; // 批次号
-  name?: string; // 文件名称
-  relationType?: string; // 文件类型(类型(EDHR/FORM))
-  status?: string; // 文件状态(文件生成状态: WAITING/PROCESSING/TIMEOUT/SUCCEED/FAIL)
+  /**
+   * 单据任务名称
+   */
+  formTaskName?: string;
+  /**
+   * 批次号
+   */
+  materialNo?: string;
+  /**
+   * 文件名称
+   */
+  name?: string;
+  /**
+   * 文件类型(类型(EDHR/FORM))
+   */
+  relationType?: string;
+  /**
+   * 文件状态(文件生成状态: WAITING/PROCESSING/TIMEOUT/SUCCEED/FAIL)
+   */
+  status?: string;
 }
 export interface getPageListQuery {
-  formTaskName?: string; // 单据任务名称
-  materialNo?: string; // 批次号
-  my?: boolean; // 我的
-  name?: string; // 文件名称
-  pageNo?: number; // 页码
-  pageSize?: number; // 每页数据条数
-  relationType?: string; // 文件类型(类型(EDHR/FORM))
-  status?: string; // 文件状态(文件生成状态: WAITING/PROCESSING/TIMEOUT/SUCCEED/FAIL)
+  /**
+   * 单据任务名称
+   */
+  formTaskName?: string;
+  /**
+   * 批次号
+   */
+  materialNo?: string;
+  /**
+   * 我的
+   */
+  my?: boolean;
+  /**
+   * 文件名称
+   */
+  name?: string;
+  /**
+   * 页码
+   */
+  pageNo?: number;
+  /**
+   * 每页数据条数
+   */
+  pageSize?: number;
+  /**
+   * 文件类型(类型(EDHR/FORM))
+   */
+  relationType?: string;
+  /**
+   * 文件状态(文件生成状态: WAITING/PROCESSING/TIMEOUT/SUCCEED/FAIL)
+   */
+  status?: string;
 }
-export interface putIdQuery {
-  id: string; // 数据主键
+export interface putIdPathParams {
+  id: string;
 }
 export interface FileTaskService {
-  // 保存
+  /**
+   * 保存
+   */
   post(
     data: FileTaskRequest,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
-  // 删除
+  ): Promise<string>;
+  /**
+   * 删除
+   */
   delete(
     query: deleteQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
-  // 批量下载
+  ): Promise<string>;
+  /**
+   * 批量下载
+   */
   postBatchDownload(
     data: FileTaskBatchDownloadReq,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<unknown>>;
-  // 详情
+  ): Promise<unknown>;
+  /**
+   * 详情
+   */
   getInfo(
     query: getInfoQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<FileTaskResponse>>;
-  // 列表
+  ): Promise<FileTaskResponse>;
+  /**
+   * 列表
+   */
   getList(
     query: getListQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<FileTaskResponse[]>>;
-  // 分页列表
+  ): Promise<FileTaskResponse[]>;
+  /**
+   * 分页列表
+   */
   getPageList(
     query: getPageListQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<IPage<FileTaskResponse>>>;
-  // 修改
+  ): Promise<IPage<FileTaskResponse>>;
+  /**
+   * 修改
+   */
   putId(
-    query: putIdQuery,
+    path: putIdPathParams,
     data: FileTaskRequest,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
+  ): Promise<string>;
 }