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

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

@@ -1,3 +1,4 @@
+import type { AxiosRequestConfig } from 'axios';
 import type {
   CommitLogRequest,
   CommitRequest,
@@ -6,93 +7,141 @@ 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 getReleaseInfoQuery {
-  releaseTag: string; // releaseTag
+  /**
+   * releaseTag
+   */
+  releaseTag: string;
 }
 export interface getReleasePageListQuery {
-  pageNo?: number; // 页码
-  pageSize?: number; // 每页数据条数
+  /**
+   * 页码
+   */
+  pageNo?: number;
+  /**
+   * 每页数据条数
+   */
+  pageSize?: number;
 }
 export interface getViewDetailQuery {
-  commitId: string; // 提交id
+  /**
+   * 提交id
+   */
+  commitId: string;
 }
-export interface putIdQuery {
-  id: string; // 数据主键
+export interface putIdPathParams {
+  id: string;
 }
 export interface CommitLogService {
-  // 保存
+  /**
+   * 保存
+   */
   post(
     data: CommitLogRequest,
-    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>;
+  /**
+   * 可发布生产的发行标识列表查询
+   */
   getCanPublishProdReleaseTagList(
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<string[]>>;
-  // 能发行的提交标识列表
-  getCanReleaseTagList(
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<string[]>>;
-  // 提交
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<string[]>;
+  /**
+   * 能发行的提交标识列表
+   */
+  getCanReleaseTagList(config?: Partial<AxiosRequestConfig>): Promise<string[]>;
+  /**
+   * 提交
+   */
   postCommit(
     data: CommitRequest,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<string>>;
-  // 查看最新提交信息
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<string>;
+  /**
+   * 查看最新提交信息
+   */
   getGetLatestCommit(
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<CommitLogResponse>>;
-  // 详情
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<CommitLogResponse>;
+  /**
+   * 详情
+   */
   getInfo(
     query: getInfoQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<CommitLogResponse>>;
-  // 列表
-  getList(
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<CommitLogResponse[]>>;
-  // 分页列表
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<CommitLogResponse>;
+  /**
+   * 列表
+   */
+  getList(config?: Partial<AxiosRequestConfig>): Promise<CommitLogResponse[]>;
+  /**
+   * 分页列表
+   */
   getPageList(
     query: getPageListQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<IPage<CommitLogResponse>>>;
-  // 发行记录详情
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<IPage<CommitLogResponse>>;
+  /**
+   * 发行记录详情
+   */
   getReleaseInfo(
     query: getReleaseInfoQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<CommitLogResponse>>;
-  // 发行记录分页列表
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<CommitLogResponse>;
+  /**
+   * 发行记录分页列表
+   */
   getReleasePageList(
     query: getReleasePageListQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<IPage<CommitLogResponse>>>;
-  // 浏览提交详情
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<IPage<CommitLogResponse>>;
+  /**
+   * 浏览提交详情
+   */
   getViewDetail(
     query: getViewDetailQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<ReadableCommitDetailDTO[]>>;
-  // 浏览草稿
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<ReadableCommitDetailDTO[]>;
+  /**
+   * 浏览草稿
+   */
   getViewDraft(
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<ReadableCommitDetailDTO[]>>;
-  // 修改
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<ReadableCommitDetailDTO[]>;
+  /**
+   * 修改
+   */
   putId(
-    query: putIdQuery,
+    path: putIdPathParams,
     data: CommitLogRequest,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<string>>;
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<string>;
 }

package/lib/apaas/service/apis/common-info-card.service.d.ts

@@ -1,62 +1,94 @@
+import type { AxiosRequestConfig } from 'axios';
 import type {
   CommonInfoCardRequest,
   CommonInfoCardResponse,
 } from '../entities';
 
 export interface deleteQuery {
-  ids: string; // 删除的id，多个按','分割
+  /**
+   * 删除的id，多个按','分割
+   */
+  ids: string;
 }
 export interface getGetByIdQuery {
-  id: string; // id
-  modelKey: string; // modelKey
-  type: string; // type
+  /**
+   * id
+   */
+  id: string;
+  /**
+   * modelKey
+   */
+  modelKey: string;
+  /**
+   * type
+   */
+  type: string;
 }
 export interface getInfoQuery {
-  id: string; // id
+  /**
+   * id
+   */
+  id: string;
 }
-export interface putIdQuery {
-  id: string; // 数据主键
+export interface putIdPathParams {
+  id: string;
 }
 export interface CommonInfoCardService {
-  // 保存
+  /**
+   * 保存
+   */
   post(
     data: CommonInfoCardRequest,
-    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>;
+  /**
+   * 查找信息卡
+   */
   getGetById(
     query: getGetByIdQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<CommonInfoCardResponse>>;
-  // 详情
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<CommonInfoCardResponse>;
+  /**
+   * 详情
+   */
   getInfo(
     query: getInfoQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<CommonInfoCardResponse>>;
-  // 列表
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<CommonInfoCardResponse>;
+  /**
+   * 列表
+   */
   postList(
     data: CommonInfoCardRequest,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<CommonInfoCardResponse[]>>;
-  // 分页列表
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<CommonInfoCardResponse[]>;
+  /**
+   * 分页列表
+   */
   postPageList(
     data: CommonInfoCardRequest,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<IPage<CommonInfoCardResponse>>>;
-  // 名称修改
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<IPage<CommonInfoCardResponse>>;
+  /**
+   * 名称修改
+   */
   postUpdateName(
     data: CommonInfoCardRequest,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<string>>;
-  // 修改
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<string>;
+  /**
+   * 修改
+   */
   putId(
-    query: putIdQuery,
+    path: putIdPathParams,
     data: CommonInfoCardRequest,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<string>>;
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<string>;
 }

package/lib/apaas/service/apis/control-config.service.d.ts

@@ -1,3 +1,4 @@
+import type { AxiosRequestConfig } from 'axios';
 import type {
   ControlConfigRequest,
   DocControlCategoryCompleteVO,
@@ -5,67 +6,118 @@ import type {
 } from '../entities';
 
 export interface deleteQuery {
-  ids: string; // 删除的refId，多个按','分割
+  /**
+   * 删除的refId，多个按','分割
+   */
+  ids: string;
 }
 export interface getCategoryListQuery {
-  moduleType: string; // moduleType
+  /**
+   * moduleType
+   */
+  moduleType: string;
 }
 export interface getInfoQuery {
-  id: string; // id
+  /**
+   * id
+   */
+  id: string;
+}
+export interface getInfoTypeRefIdPathParams {
+  type: string;
+  refId: string;
 }
 export interface getListQuery {
-  type: string; // 单据分类:ONLINE_FORM_CATEGORY/eDHR分类:EDHR_CATEGORY/特殊表单:ONLINE_FORM_CFG/特殊eDHR:EDHR_CFG
+  /**
+   * 单据分类:ONLINE_FORM_CATEGORY/eDHR分类:EDHR_CATEGORY/特殊表单:ONLINE_FORM_CFG/特殊eDHR:EDHR_CFG
+   */
+  type: string;
 }
 export interface getSpecialPageListQuery {
-  code?: string; // 表单编码
-  name?: string; // 表单名称
-  pageNo?: number; // 页码
-  pageSize?: number; // 每页数据条数
-  type: string; // 特殊表单:ONLINE_FORM_CFG/特殊eDHR:EDHR_CFG
-  version?: string; // 表单版本搜索
+  /**
+   * 表单编码
+   */
+  code?: string;
+  /**
+   * 表单名称
+   */
+  name?: string;
+  /**
+   * 页码
+   */
+  pageNo?: number;
+  /**
+   * 每页数据条数
+   */
+  pageSize?: number;
+  /**
+   * 特殊表单:ONLINE_FORM_CFG/特殊eDHR:EDHR_CFG
+   */
+  type: string;
+  /**
+   * 表单版本搜索
+   */
+  version?: string;
 }
-export interface putIdQuery {
-  id: string; // 数据主键
+export interface putIdPathParams {
+  id: string;
 }
 export interface ControlConfigService {
-  // 保存或更新
+  /**
+   * 保存或更新
+   */
   post(
     data: ControlConfigRequest,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<string>>;
-  // 删除
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<string>;
+  /**
+   * 删除
+   */
   delete(
     query: deleteQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<string>>;
-  // 在线表单/eDHR 受控配置分类树
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<string>;
+  /**
+   * 在线表单/eDHR 受控配置分类树
+   */
   getCategoryList(
     query: getCategoryListQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<DocControlCategoryCompleteVO[]>>;
-  // 详情
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<DocControlCategoryCompleteVO[]>;
+  /**
+   * 详情
+   */
   getInfo(
     query: getInfoQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<ControlConfigResponse>>;
-  // 详情
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<ControlConfigResponse>;
+  /**
+   * 详情
+   */
   getInfoTypeRefId(
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<ControlConfigResponse>>;
-  // 列表
+    path: getInfoTypeRefIdPathParams,
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<ControlConfigResponse>;
+  /**
+   * 列表
+   */
   getList(
     query: getListQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<ControlConfigResponse[]>>;
-  // 特殊分类配置分页列表
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<ControlConfigResponse[]>;
+  /**
+   * 特殊分类配置分页列表
+   */
   getSpecialPageList(
     query: getSpecialPageListQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<IPage<ControlConfigResponse>>>;
-  // 修改
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<IPage<ControlConfigResponse>>;
+  /**
+   * 修改
+   */
   putId(
-    query: putIdQuery,
+    path: putIdPathParams,
     data: ControlConfigRequest,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<string>>;
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<string>;
 }

package/lib/apaas/service/apis/customer-complaint.service.d.ts

@@ -1,64 +1,108 @@
+import type { AxiosRequestConfig } from 'axios';
 import type {
   CustomerComplaintRequest,
   CustomerComplaintResponse,
 } from '../entities';
 
 export interface deleteQuery {
-  ids: string; // 删除的id，多个按','分割
+  /**
+   * 删除的id，多个按','分割
+   */
+  ids: string;
 }
 export interface getInfoQuery {
-  id: string; // id
+  /**
+   * id
+   */
+  id: string;
 }
 export interface getPageListQuery {
-  batchNumber?: string; // batchNumber
-  pageNo?: number; // 页码
-  pageSize?: number; // 每页数据条数
-  productName?: string; // productName
-  specificationModel?: string; // specificationModel
+  /**
+   * batchNumber
+   */
+  batchNumber?: string;
+  /**
+   * 页码
+   */
+  pageNo?: number;
+  /**
+   * 每页数据条数
+   */
+  pageSize?: number;
+  /**
+   * productName
+   */
+  productName?: string;
+  /**
+   * specificationModel
+   */
+  specificationModel?: string;
 }
 export interface getUpdateFeishuQuery {
-  recordId: string; // 更新地址
-  url: string; // 更新地址
+  /**
+   * 更新地址
+   */
+  recordId: string;
+  /**
+   * 更新地址
+   */
+  url: string;
 }
-export interface putIdQuery {
-  id: string; // 数据主键
+export interface putIdPathParams {
+  id: string;
 }
 export interface CustomerComplaintService {
-  // 保存
+  /**
+   * 保存
+   */
   post(
     data: CustomerComplaintRequest,
-    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>;
+  /**
+   * 详情
+   */
   getInfo(
     query: getInfoQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<CustomerComplaintResponse>>;
-  // 列表
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<CustomerComplaintResponse>;
+  /**
+   * 列表
+   */
   getList(
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<CustomerComplaintResponse[]>>;
-  // 分页列表
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<CustomerComplaintResponse[]>;
+  /**
+   * 分页列表
+   */
   getPageList(
     query: getPageListQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<IPage<CustomerComplaintResponse>>>;
-  // 同步数据
-  getSync(config?: Record<string, string>): Promise<IHttpResponse<string>>;
-  // 更新飞书数据
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<IPage<CustomerComplaintResponse>>;
+  /**
+   * 同步数据
+   */
+  getSync(config?: Partial<AxiosRequestConfig>): Promise<string>;
+  /**
+   * 更新飞书数据
+   */
   getUpdateFeishu(
     query: getUpdateFeishuQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<string>>;
-  // 修改
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<string>;
+  /**
+   * 修改
+   */
   putId(
-    query: putIdQuery,
+    path: putIdPathParams,
     data: CustomerComplaintRequest,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<string>>;
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<string>;
 }