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

package/lib/platform/service/apis/apk.service.d.ts

@@ -2,49 +2,60 @@ import type { AxiosRequestConfig } from 'axios';
 import type { ApkRequest, ApkResponse } from '../entities';
 
 export interface deleteQuery {
-  ids: string; // 删除的id，多个按','分割
+  /**
+   * 删除的id，多个按','分割
+   */
+  ids: string;
 }
 export interface getInfoQuery {
-  id: string; // id
+  /**
+   * id
+   */
+  id: string;
 }
-export interface putIdQuery {
-  id: string; // 数据主键
+export interface putIdPathParams {
+  id: string;
 }
 export interface ApkService {
-  // 保存
-  post(
-    data: ApkRequest,
-    config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
-  // 删除
+  /**
+   * 保存
+   */
+  post(data: ApkRequest, config?: Partial<AxiosRequestConfig>): Promise<string>;
+  /**
+   * 删除
+   */
   delete(
     query: deleteQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
-  // 获取激活版本数据信息
-  getGetActiveApp(
-    config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<ApkResponse>>;
-  // 获取IP
-  getGetIp(
-    config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
-  // 详情
+  ): Promise<string>;
+  /**
+   * 获取激活版本数据信息
+   */
+  getGetActiveApp(config?: Partial<AxiosRequestConfig>): Promise<ApkResponse>;
+  /**
+   * 获取IP
+   */
+  getGetIp(config?: Partial<AxiosRequestConfig>): Promise<string>;
+  /**
+   * 详情
+   */
   getInfo(
     query: getInfoQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<ApkResponse>>;
-  // 列表
-  getList(
-    config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<ApkResponse[]>>;
-  // 文件上传minio
-  postUploadApk(
-    config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
-  // 激活版本
+  ): Promise<ApkResponse>;
+  /**
+   * 列表
+   */
+  getList(config?: Partial<AxiosRequestConfig>): Promise<ApkResponse[]>;
+  /**
+   * 文件上传minio
+   */
+  postUploadApk(config?: Partial<AxiosRequestConfig>): Promise<string>;
+  /**
+   * 激活版本
+   */
   putId(
-    query: putIdQuery,
+    path: putIdPathParams,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
+  ): Promise<string>;
 }

package/lib/platform/service/apis/app-member.service.d.ts

@@ -2,53 +2,101 @@ import type { AxiosRequestConfig } from 'axios';
 import type { AppMemberRequest, AppMemberResponse } from '../entities';
 
 export interface deleteQuery {
-  id: string; // 删除的id
+  /**
+   * 删除的id
+   */
+  id: string;
 }
 export interface getInfoQuery {
-  id: string; // id
+  /**
+   * id
+   */
+  id: string;
 }
 export interface getListQuery {
-  appId: string; // appId
-  appMemberRole?: string; // appMemberRole
-  fullname?: string; // fullname
+  /**
+   * appId
+   */
+  appId: string;
+  /**
+   * appMemberRole
+   */
+  appMemberRole?: string;
+  /**
+   * fullname
+   */
+  fullname?: string;
 }
 export interface getPageListQuery {
-  fullname?: string; // fullname
-  pageNo?: number; // 页码
-  pageSize?: number; // 每页数据条数
+  /**
+   * fullname
+   */
+  fullname?: string;
+  /**
+   * 页码
+   */
+  pageNo?: number;
+  /**
+   * 每页数据条数
+   */
+  pageSize?: number;
+}
+export interface putTransferIdTargetUserIdPathParams {
+  id: string;
+  targetUserId: string;
+}
+export interface putIdRolePathParams {
+  id: string;
+  role: string;
 }
 export interface AppMemberService {
-  // 保存
+  /**
+   * 保存
+   */
   post(
     data: AppMemberRequest,
     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<AppMemberResponse>>;
-  // 列表
+  ): Promise<AppMemberResponse>;
+  /**
+   * 列表
+   */
   getList(
     query: getListQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<AppMemberResponse[]>>;
-  // 分页列表
+  ): Promise<AppMemberResponse[]>;
+  /**
+   * 分页列表
+   */
   getPageList(
     query: getPageListQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<IPage<AppMemberResponse>>>;
-  // 移交
+  ): Promise<IPage<AppMemberResponse>>;
+  /**
+   * 移交
+   */
   putTransferIdTargetUserId(
+    path: putTransferIdTargetUserIdPathParams,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
-  // 修改角色
+  ): Promise<string>;
+  /**
+   * 修改角色
+   */
   putIdRole(
+    path: putIdRolePathParams,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
+  ): Promise<string>;
 }

package/lib/platform/service/apis/app-setting.service.d.ts

@@ -2,62 +2,106 @@ import type { AxiosRequestConfig } from 'axios';
 import type { AppSettingDtoResponse, AppSettingDtoRequest } from '../entities';
 
 export interface deleteQuery {
-  ids: string; // 删除的id，多个按','分割
+  /**
+   * 删除的id，多个按','分割
+   */
+  ids: string;
 }
 export interface getCheckAppUserAdminQuery {
-  appEnv?: string; // appEnv
-  appId: string; // appId
-  userId: string; // userId
+  /**
+   * appEnv
+   */
+  appEnv?: string;
+  /**
+   * appId
+   */
+  appId: string;
+  /**
+   * userId
+   */
+  userId: string;
 }
 export interface getCheckAppUserVisibilityQuery {
-  appEnv?: string; // appEnv
-  appId: string; // appId
-  userId: string; // userId
+  /**
+   * appEnv
+   */
+  appEnv?: string;
+  /**
+   * appId
+   */
+  appId: string;
+  /**
+   * userId
+   */
+  userId: string;
 }
 export interface deleteDeveloperDeleteQuery {
-  ids: string; // 删除的id，多个按','分割
+  /**
+   * 删除的id，多个按','分割
+   */
+  ids: string;
 }
 export interface getInfoByAppIdQuery {
-  appEnv?: string; // appEnv
-  appId: string; // appId
+  /**
+   * appEnv
+   */
+  appEnv?: string;
+  /**
+   * appId
+   */
+  appId: string;
 }
 export interface AppSettingService {
-  // 删除
+  /**
+   * 删除
+   */
   delete(
     query: deleteQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
-  // 检查用户是否是应用管理员
+  ): Promise<string>;
+  /**
+   * 检查用户是否是应用管理员
+   */
   getCheckAppUserAdmin(
     query: getCheckAppUserAdminQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<boolean>>;
-  // 检查用户是否是属于应用可见范围内
+  ): Promise<boolean>;
+  /**
+   * 检查用户是否是属于应用可见范围内
+   */
   getCheckAppUserVisibility(
     query: getCheckAppUserVisibilityQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<boolean>>;
-  // 删除
+  ): Promise<boolean>;
+  /**
+   * 删除
+   */
   deleteDeveloperDelete(
     query: deleteDeveloperDeleteQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
-  // 批量保存
+  ): Promise<string>;
+  /**
+   * 批量保存
+   */
   postDeveloperSaveSettingBatch(
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
-  // 详情
+  ): Promise<string>;
+  /**
+   * 详情
+   */
   getInfoByAppId(
     query: getInfoByAppIdQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<AppSettingDtoResponse>>;
-  // 保存
+  ): Promise<AppSettingDtoResponse>;
+  /**
+   * 保存
+   */
   postSaveSetting(
     data: AppSettingDtoRequest,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
-  // 批量保存
-  postSaveSettingBatch(
-    config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
+  ): Promise<string>;
+  /**
+   * 批量保存
+   */
+  postSaveSettingBatch(config?: Partial<AxiosRequestConfig>): Promise<string>;
 }