shcp-api-lib 1.0.1 → 1.0.2

package/dist/types/src/api/app-client-page-config-api.d.ts

@@ -1,5 +1,9 @@
 import { AppClientPageConfigDTO, AppClientPageConfigQuery } from '../type/model/mine-model';
 import { CommonRes } from '../type/net-types';
 export declare class AppClientPageConfigApi {
+    /**
+     * 查询列表
+     * URL: /api/blade-system/${ShcpApiSdk.getApiSuffix()}/appClient/pageConfig/list
+     */
     static getList(data: AppClientPageConfigQuery): Promise<CommonRes<AppClientPageConfigDTO[]>>;
 }

package/dist/types/src/api/app-client-setting-api.d.ts

@@ -1,5 +1,9 @@
 import { CommonRes } from '../type/net-types';
 import { AppClientSettingDTO, AppClientSettingQuery } from '../type/model/app-client-setting-model';
 export declare class AppClientSettingApi {
+    /**
+     * 查询单个
+     * URL: /api/blade-system/${ShcpApiSdk.getApiSuffix()}/appClient/setting/get
+     */
     static get(data: AppClientSettingQuery): Promise<CommonRes<AppClientSettingDTO>>;
 }

package/dist/types/src/api/common-dict-api.d.ts

@@ -1,6 +1,10 @@
 import type { CommonRes } from '../type/net-types';
 import type { DictBiz, DictBizVO } from '../type/model/common-dict-model';
 export declare class CommonDictApi {
+    /**
+     * 查询单个详情
+     * URL: /api/blade-system/dict/detail
+     */
     static getDetail(data: DictBiz): Promise<CommonRes<DictBizVO>>;
     /**
      * 列表

package/dist/types/src/api/common-right-api.d.ts

@@ -1,11 +1,35 @@
 import type { CommonRes, PagedList } from '../type/net-types';
 import type { MetricExceptionDTO, MetricExceptionQuery, MetricExceptionUpdateRequests, MetricExceptionUserCountDTO, Operator, RightDTO, RightRequest, ServiceFlowConfigDTO, ServiceFlowConfigQuery, ServiceFlowDTO, ServiceFlowQuery, ServiceStartDTO, ServiceTaskDeleteRequest, ServiceTaskDTO, ServiceTaskQuery, ServiceTaskUserCountDTO } from '../type/model/common-right-model';
 export declare class CommonRightApi {
+    /**
+     * 获取权益列表
+     * URL: /api/shcp-healthcare/${ShcpApiSdk.getApiSuffix()}/right/list
+     */
     static getRightList(data: RightRequest): Promise<CommonRes<RightDTO[]>>;
+    /**
+     * 服务流程分页查询
+     * URL: /api/shcp-healthcare/${ShcpApiSdk.getApiSuffix()}/serviceFlow/page
+     */
     static flowPage(data: ServiceFlowQuery): Promise<CommonRes<PagedList<ServiceFlowDTO>>>;
+    /**
+     * 服务任务分页查询
+     * URL: /api/shcp-healthcare/${ShcpApiSdk.getApiSuffix()}/serviceTask/page
+     */
     static taskPage(data: ServiceTaskQuery): Promise<CommonRes<PagedList<ServiceFlowDTO>>>;
+    /**
+     * 服务流程.列表查询
+     * URL: /api/shcp-healthcare/${ShcpApiSdk.getApiSuffix()}/serviceFlow/list
+     */
     static listServiceFlow(query: ServiceFlowQuery): Promise<CommonRes<ServiceFlowDTO[]>>;
+    /**
+     * 服务流程配置详情
+     * URL: /api/shcp-healthcare/${ShcpApiSdk.getApiSuffix()}/serviceFlow/config/detail
+     */
     static detailServiceFlowConfig(flowId: number | string): Promise<CommonRes<ServiceFlowConfigDTO>>;
+    /**
+     * 服务任务用户分页查询
+     * URL: /api/shcp-healthcare/${ShcpApiSdk.getApiSuffix()}/serviceTask/user/page
+     */
     static pageServiceTaskUser(data: ServiceTaskQuery): Promise<CommonRes<ServiceTaskUserCountDTO>>;
     /**
      * 任务维度
@@ -22,6 +46,10 @@ export declare class CommonRightApi {
      * URL: /api/shcp-healthcare/${ShcpApiSdk.getApiSuffix()}/metricException/update
      */
     static updateMetricException(data: MetricExceptionUpdateRequests): Promise<CommonRes<MetricExceptionDTO>>;
+    /**
+     * 通用任务启动
+     * URL: /api/shcp-healthcare/${ShcpApiSdk.getApiSuffix()}/${serviceTypeEnName}/start
+     */
     static commonTaskStart(serviceTypeEnName: string, data: {
         consumerId: string | number;
         rightId: string | number;

package/dist/types/src/api/consumer-api.d.ts

@@ -1,30 +1,122 @@
 import type { CommonRes, PagedList } from '../type/net-types';
 import type { ConsumerCreateRequest, ConsumerDTO, ConsumerGroupDeleteRequest, ConsumerGroupDTO, ConsumerGroupMemberCreateRequest, ConsumerGroupMemberDTO, ConsumerGroupMemberQuery, ConsumerGroupMemberUpdateRequest, ConsumerGroupQuery, ConsumerGroupUpdateRequest, ConsumerQuery, ConsumerRightCreateRequest, ConsumerRightDeleteRequest, ConsumerRightDoctorDTO, ConsumerRightDoctorQuery, ConsumerRightDTO, ConsumerRightQuery, ConsumerUpdateRequest } from '../type/model/consumer-model';
 export declare class ConsumerApi {
+    /**
+     * 获取医生列表
+     * URL: /api/shcp-consumer/${ShcpApiSdk.getApiSuffix()}/consumerRight/listDoctor
+     */
     static getDoctorList(data: ConsumerRightDoctorQuery): Promise<CommonRes<ConsumerRightDoctorDTO[]>>;
+    /**
+     * 获取成员分页
+     * URL: /api/shcp-consumer/${ShcpApiSdk.getApiSuffix()}/consumer/group/member/page
+     */
     static getMemberPage(data: ConsumerGroupMemberQuery): Promise<CommonRes<PagedList<ConsumerGroupMemberDTO>>>;
+    /**
+     * 批量新增
+     * URL: /api/shcp-consumer/${ShcpApiSdk.getApiSuffix()}/consumer/group/member/create
+     */
     static batchCreateMember(data: ConsumerGroupMemberCreateRequest[]): Promise<CommonRes<ConsumerGroupMemberDTO[]>>;
+    /**
+     * 列表查询成员
+     * URL: /api/shcp-consumer/${ShcpApiSdk.getApiSuffix()}/consumer/group/member/list
+     */
     static listMember(data: ConsumerGroupMemberQuery): Promise<CommonRes<ConsumerGroupMemberDTO[]>>;
+    /**
+     * 更新成员
+     * URL: /api/shcp-consumer/${ShcpApiSdk.getApiSuffix()}/consumer/group/member/update
+     */
     static updateMember(data: ConsumerGroupMemberUpdateRequest): Promise<CommonRes<ConsumerGroupMemberDTO>>;
+    /**
+     * 获取组详情
+     * URL: /api/shcp-consumer/${ShcpApiSdk.getApiSuffix()}/consumer/group/detail
+     */
     static getGroupDetail(id: number): Promise<CommonRes<ConsumerGroupDTO>>;
+    /**
+     * 获取组分页
+     * URL: /api/shcp-consumer/${ShcpApiSdk.getApiSuffix()}/consumer/group/page
+     */
     static getGroupPage(data: ConsumerGroupQuery): Promise<CommonRes<PagedList<ConsumerGroupDTO>>>;
+    /**
+     * 根据ID列表查询
+     * URL: /api/shcp-consumer/${ShcpApiSdk.getApiSuffix()}/consumer/group/listByIds
+     */
     static getListByIds(data: ConsumerGroupQuery): Promise<CommonRes<ConsumerGroupDTO>>;
+    /**
+     * 获取树形结构
+     * URL: /api/shcp-consumer/${ShcpApiSdk.getApiSuffix()}/consumer/group/tree
+     */
     static getTree(data: {
         rootId: number | string;
     }): Promise<CommonRes<ConsumerGroupDTO>>;
+    /**
+     * 更新组
+     * URL: /api/shcp-consumer/${ShcpApiSdk.getApiSuffix()}/consumer/group/update
+     */
     static updateGroup(data: ConsumerGroupUpdateRequest): Promise<CommonRes<ConsumerGroupDTO>>;
+    /**
+     * 创建组
+     * URL: /api/shcp-consumer/${ShcpApiSdk.getApiSuffix()}/consumer/group/create
+     */
     static createGroup(data: ConsumerGroupUpdateRequest): Promise<CommonRes<ConsumerGroupDTO>>;
+    /**
+     * 删除组
+     * URL: /api/shcp-consumer/${ShcpApiSdk.getApiSuffix()}/consumer/group/delete
+     */
     static deleteGroup(data: ConsumerGroupDeleteRequest): Promise<CommonRes<boolean>>;
+    /**
+     * 更新消费者
+     * URL: /api/shcp-consumer/${ShcpApiSdk.getApiSuffix()}/consumer/update
+     */
     static update(data: ConsumerUpdateRequest): Promise<CommonRes<ConsumerDTO>>;
+    /**
+     * 创建消费者
+     * URL: /api/shcp-consumer/${ShcpApiSdk.getApiSuffix()}/consumer/create
+     */
     static create(data: ConsumerCreateRequest): Promise<CommonRes<ConsumerDTO>>;
+    /**
+     * 查询消费者列表
+     * URL: /api/shcp-consumer/${ShcpApiSdk.getApiSuffix()}/consumer/list
+     */
     static list(data: ConsumerQuery): Promise<CommonRes<ConsumerDTO[]>>;
+    /**
+     * 查询单个消费者
+     * URL: /api/shcp-consumer/${ShcpApiSdk.getApiSuffix()}/consumer/get
+     */
     static get(data: ConsumerQuery): Promise<CommonRes<ConsumerDTO>>;
+    /**
+     * 查询消费用户权益
+     * URL: /api/shcp-consumer/${ShcpApiSdk.getApiSuffix()}/consumerRight/detail
+     */
     static getRightDetail(id: number): Promise<CommonRes<ConsumerRightDTO>>;
+    /**
+     * 查询消费用户权益
+     * URL: /api/shcp-consumer/${ShcpApiSdk.getApiSuffix()}/consumerRight/get
+     */
     static getRight(data: ConsumerRightQuery): Promise<CommonRes<ConsumerRightDTO>>;
+    /**
+     * 查询消费用户权益
+     * URL: /api/shcp-consumer/${ShcpApiSdk.getApiSuffix()}/consumerRight/list
+     */
     static getRightList(data: ConsumerRightQuery): Promise<CommonRes<ConsumerRightDTO[]>>;
+    /**
+     * 查询消费用户权益
+     * URL: /api/shcp-consumer/${ShcpApiSdk.getApiSuffix()}/consumerRight/page
+     */
     static getRightPage(data: ConsumerRightQuery): Promise<CommonRes<PagedList<ConsumerRightDTO>>>;
+    /**
+     * 创建消费用户权益
+     * URL: /api/shcp-consumer/${ShcpApiSdk.getApiSuffix()}/consumerRight/create
+     */
     static createRight(data: ConsumerRightCreateRequest): Promise<CommonRes<ConsumerRightDTO>>;
+    /**
+     * 批量创建消费用户权益
+     * URL: /api/shcp-consumer/${ShcpApiSdk.getApiSuffix()}/consumerRight/batchCreate
+     */
     static batchCreateRight(data: ConsumerRightCreateRequest[]): Promise<CommonRes<ConsumerRightDTO[]>>;
+    /**
+     * 删除消费用户权益
+     * URL: /api/shcp-consumer/${ShcpApiSdk.getApiSuffix()}/consumerRight/delete
+     */
     static deleteRight(data: ConsumerRightDeleteRequest): Promise<CommonRes<boolean>>;
 }
 export declare const crudConsumerGroupApi: {

package/dist/types/src/api/consumer-bind-api.d.ts

@@ -1,15 +1,47 @@
 import type { CommonRes } from '../type/net-types';
 import { ConsumerBindActiveRequest, ConsumerBindCreateRequest, ConsumerBindDeleteRequest, ConsumerBindDTO, ConsumerBindQuery, ConsumerBindSendSmsCodeRequest, ConsumerBindUpdateRequest } from '../type/model/consumer-bind-model';
 export declare class ConsumerBindApi {
+    /**
+     * 更改
+     * URL: /api/shcp-consumer/consumerBind/update
+     */
     static update(data: ConsumerBindUpdateRequest): Promise<CommonRes<ConsumerBindDTO>>;
+    /**
+     * 新增
+     * URL: /api/shcp-consumer/consumerBind/bind
+     */
     static create(data: ConsumerBindCreateRequest): Promise<CommonRes<ConsumerBindDTO>>;
+    /**
+     * 删除
+     * URL: /api/shcp-consumer/consumerBind/delete
+     */
     static delete(data: ConsumerBindDeleteRequest): Promise<CommonRes<any>>;
+    /**
+     * 设备用户绑定的消费用户列表
+     * URL: /api/shcp-consumer/consumerBind/list
+     */
     static getList(params: ConsumerBindQuery): Promise<CommonRes<ConsumerBindDTO[]>>;
+    /**
+     * 发送绑定用户验证码
+     * URL: /api/shcp-consumer/consumerBind/sendSMSCode
+     */
     static sendSMSCode(params: ConsumerBindSendSmsCodeRequest): Promise<CommonRes<any>>;
+    /**
+     * 验证码校验
+     * URL: /api/shcp-consumer/consumerBind/verifySMSCode
+     */
     static verifySMSCode(params: {
         code: string;
         phone: string;
     }): Promise<CommonRes<any>>;
+    /**
+     * 激活
+     * URL: /api/shcp-consumer/consumerBind/active
+     */
     static active(data: ConsumerBindActiveRequest): Promise<CommonRes<ConsumerBindDTO>>;
+    /**
+     * 单个查询
+     * URL: /api/shcp-consumer/consumerBind/get
+     */
     static get(params: ConsumerBindQuery): Promise<CommonRes<ConsumerBindDTO>>;
 }

package/dist/types/src/api/consumer-favorite-api.d.ts

@@ -1,8 +1,24 @@
 import type { CommonRes, PagedList } from '../type/net-types';
 import { ConsumerFavoriteCreateRequest, ConsumerFavoriteDeleteRequest, ConsumerFavoriteDTO, ConsumerFavoriteQuery } from '../type/model/consumer-favorite-model';
 export declare class ConsumerFavoriteApi {
+    /**
+     * 消费用户收藏列表
+     * URL: /api/shcp-consumer/${ShcpApiSdk.getApiSuffix()}/consumer/favorite/page
+     */
     static getPage(data: ConsumerFavoriteQuery): Promise<CommonRes<PagedList<ConsumerFavoriteDTO>>>;
+    /**
+     * 创建消费用户收藏
+     * URL: /api/shcp-consumer/${ShcpApiSdk.getApiSuffix()}/consumer/favorite/create
+     */
     static create(data: ConsumerFavoriteCreateRequest): Promise<CommonRes<any>>;
+    /**
+     * 检查是否收藏
+     * URL: /api/shcp-consumer/${ShcpApiSdk.getApiSuffix()}/consumer/favorite/checkFavorite
+     */
     static checkFavorite(params: ConsumerFavoriteQuery): Promise<CommonRes<any>>;
+    /**
+     * 取消收藏
+     * URL: /api/shcp-consumer/${ShcpApiSdk.getApiSuffix()}/consumer/favorite/delete
+     */
     static delete(data: ConsumerFavoriteDeleteRequest): Promise<CommonRes<any>>;
 }

package/dist/types/src/api/health-common-api.d.ts

@@ -2,14 +2,54 @@ import type { MetricExceptionDTO, MetricExceptionQuery, MetricExceptionUserCount
 import type { HealthMetricTrendDTO, HealthMetricTrendQuery } from '../type/model/health-metric-model';
 import type { CommonRes, PagedList } from '../type/net-types';
 export declare class HealthCommonApi {
+    /**
+     * 服务流程.分页查询
+     * URL: /api/shcp-healthcare/${ShcpApiSdk.getApiSuffix()}/serviceFlow/page
+     */
     static pageServiceFlow(data: ServiceFlowQuery): Promise<CommonRes<PagedList<ServiceFlowDTO>>>;
+    /**
+     * 服务流程.统计, 用户所参与流程统计
+     * URL: /api/shcp-healthcare/${ShcpApiSdk.getApiSuffix()}/serviceFlow/statistics
+     */
     static statsServiceFlow(data: ServiceFlowStatisticsQuery): Promise<CommonRes<ServiceFlowStatisticsDTO[]>>;
+    /**
+     * 服务任务的权益.列表查询, 列表查询
+     * URL: /api/shcp-healthcare/${ShcpApiSdk.getApiSuffix()}/serviceTask/right/list
+     */
     static listServiceTaskRight(data: ServiceTaskRightQuery): Promise<CommonRes<RightDTO[]>>;
+    /**
+     * 服务任务.分页查询
+     * URL: /api/shcp-healthcare/${ShcpApiSdk.getApiSuffix()}/serviceTask/page
+     */
     static pageServiceTask(data: ServiceTaskQuery): Promise<CommonRes<PagedList<ServiceTaskDTO>>>;
+    /**
+     * 服务任务.单个查询（按ID）
+     * URL: /api/shcp-healthcare/${ShcpApiSdk.getApiSuffix()}/serviceTask/detail
+     */
     static detailServiceTask(id: number): Promise<CommonRes<ServiceTaskDTO>>;
+    /**
+     * 服务任务.单个查询（按条件）
+     * URL: /api/shcp-healthcare/${ShcpApiSdk.getApiSuffix()}/serviceTask/get
+     */
     static getServiceTask(data: ServiceTaskQuery): Promise<CommonRes<ServiceTaskDTO>>;
+    /**
+     * 服务任务.统计, 用户所参与任务统计
+     * URL: /api/shcp-healthcare/${ShcpApiSdk.getApiSuffix()}/serviceTask/statistics
+     */
     static statsServiceTask(data: ServiceTaskStatisticsQuery): Promise<CommonRes<ServiceTaskStatisticsDTO[]>>;
+    /**
+     * 健康指标趋势.列表查询
+     * URL: /api/shcp-healthcare/${ShcpApiSdk.getApiSuffix()}/healthMetricTrend/list
+     */
     static listMetricTrend(data: HealthMetricTrendQuery): Promise<CommonRes<HealthMetricTrendDTO[]>>;
+    /**
+     * 指标异常记录.分页查询, 任务维度
+     * URL: /api/shcp-healthcare/${ShcpApiSdk.getApiSuffix()}/metricException/page
+     */
     static metricExceptionPage(data: MetricExceptionQuery): Promise<CommonRes<PagedList<MetricExceptionDTO>>>;
+    /**
+     * 指标异常记录.用户分页查询, 用户维度
+     * URL: /api/shcp-healthcare/${ShcpApiSdk.getApiSuffix()}/metricException/user/page
+     */
     static metricExceptionUserPage(data: MetricExceptionQuery): Promise<CommonRes<MetricExceptionUserCountDTO>>;
 }

package/dist/types/src/api/health-metric-api.d.ts

@@ -1,9 +1,29 @@
 import type { CommonRes, PagedList } from '../type/net-types';
 import type { HealthMetricDTO, HealthMetricLogDTO, HealthMetricQuery, HealthMetricTrendDTO, HealthMetricTrendQuery } from '../type/model/health-metric-model';
 export declare class HealthMetricApi {
+    /**
+     * 获取健康指标
+     * URL: /api/shcp-healthcare/${ShcpApiSdk.getApiSuffix()}/healthMetric/get
+     */
     static getMetric(data: HealthMetricQuery): Promise<CommonRes<HealthMetricDTO>>;
+    /**
+     * 获取健康指标列表
+     * URL: /api/shcp-healthcare/${ShcpApiSdk.getApiSuffix()}/healthMetric/list
+     */
     static listMetric(data: HealthMetricQuery): Promise<CommonRes<HealthMetricDTO[]>>;
+    /**
+     * 健康指标分页查询
+     * URL: /api/shcp-healthcare/${ShcpApiSdk.getApiSuffix()}/healthMetric/page
+     */
     static pageMetric(data: HealthMetricQuery): Promise<CommonRes<PagedList<HealthMetricDTO>>>;
+    /**
+     * 健康指标趋势列表
+     * URL: /api/shcp-healthcare/${ShcpApiSdk.getApiSuffix()}/healthMetricTrend/list
+     */
     static listTrend(data: HealthMetricTrendQuery): Promise<CommonRes<HealthMetricTrendDTO[]>>;
+    /**
+     * 健康指标日志列表
+     * URL: /api/shcp-healthcare/${ShcpApiSdk.getApiSuffix()}/healthMetricLog/list
+     */
     static listLog(data: HealthMetricQuery): Promise<CommonRes<HealthMetricLogDTO[]>>;
 }

package/dist/types/src/api/health-profile-api.d.ts

@@ -1,8 +1,24 @@
 import type { CommonRes } from '../type/net-types';
 import type { DiaryTaskDTO, DiaryTaskFetch, DiaryTaskSubmit, ReportTaskDTO, ReportTaskFetch, ReportTaskSubmit } from '../type/model/health-profile-model';
 export declare class HealthProfileApi {
+    /**
+     * 获取日记任务
+     * URL: /api/shcp-healthcare/${ShcpApiSdk.getApiSuffix()}/healthProfile/diaryTask/fetch
+     */
     static fetchDiaryTask(data: DiaryTaskFetch): Promise<CommonRes<DiaryTaskDTO>>;
+    /**
+     * 提交日记任务
+     * URL: /api/shcp-healthcare/${ShcpApiSdk.getApiSuffix()}/healthProfile/diaryTask/submit
+     */
     static submitDiaryTask(data: DiaryTaskSubmit): Promise<CommonRes<boolean>>;
+    /**
+     * 提交报告任务
+     * URL: /api/shcp-healthcare/${ShcpApiSdk.getApiSuffix()}/healthProfile/reportTask/submit
+     */
     static submitReportTask(data: ReportTaskSubmit): Promise<CommonRes<ReportTaskDTO>>;
+    /**
+     * 获取报告任务
+     * URL: /api/shcp-healthcare/${ShcpApiSdk.getApiSuffix()}/healthProfile/reportTask/fetch
+     */
     static fetchReportTask(data: ReportTaskFetch): Promise<CommonRes<ReportTaskDTO>>;
 }

package/dist/types/src/api/health-self-assess-api.d.ts

@@ -2,7 +2,19 @@ import type { ServiceStartRequest, ServiceTaskRequests } from '../type/model/com
 import type { AssessmentTaskDTO } from '../type/model/health-self-assess-model';
 import type { CommonRes } from '../type/net-types';
 export declare class HealthSelfAssessApi {
+    /**
+     * 启动健康自评
+     * URL: /api/shcp-healthcare/${ShcpApiSdk.getApiSuffix()}/healthSelfAssess/start
+     */
     static start(data: ServiceStartRequest): Promise<CommonRes<AssessmentTaskDTO>>;
+    /**
+     * 提交评估任务
+     * URL: /api/shcp-healthcare/${ShcpApiSdk.getApiSuffix()}/healthSelfAssess/task/submit
+     */
     static submitTask(data: ServiceTaskRequests.Submit): Promise<CommonRes<boolean>>;
+    /**
+     * 获取评估任务
+     * URL: /api/shcp-healthcare/${ShcpApiSdk.getApiSuffix()}/healthSelfAssess/task/fetch
+     */
     static fetchTask(data: ServiceTaskRequests.Fetch): Promise<CommonRes<AssessmentTaskDTO>>;
 }

package/dist/types/src/api/help-center.d.ts

@@ -1,4 +1,8 @@
 import { CommonRes } from '../type/net-types';
 export declare class HelpCenterApi {
+    /**
+     * 获取帮助中心配置
+     * URL: /api/blade-system/${ShcpApiSdk.getApiSuffix()}/helpCenter/get
+     */
     static getConfig(clientType: string | number): Promise<CommonRes<any>>;
 }

package/dist/types/src/api/im-user-api.d.ts

@@ -1,7 +1,19 @@
 import type { CommonRes } from '../type/net-types';
 import type { IMUserDTO, IMUserQuery, IMUserRequest } from '../type/model/im-user-model';
 export declare class ImUserApi {
+    /**
+     * 用户登录
+     * URL: /api/shcp-message/${ShcpApiSdk.getApiSuffix()}/message/im/login
+     */
     static login(data: IMUserRequest): Promise<CommonRes<IMUserDTO>>;
+    /**
+     * 获取对话用户信息
+     * URL: /api/shcp-message/${ShcpApiSdk.getApiSuffix()}/message/im/getUser
+     */
     static getUser(data: IMUserRequest): Promise<CommonRes<IMUserDTO>>;
+    /**
+     * 获取对话用户信息
+     * URL: /api/shcp-message/${ShcpApiSdk.getApiSuffix()}/message/im/getUserList
+     */
     static getUserList(data: IMUserQuery): Promise<CommonRes<IMUserDTO[]>>;
 }

package/dist/types/src/api/km-article-api.d.ts

@@ -1,9 +1,24 @@
 import type { CommonRes, PagedList } from '../type/net-types';
 import { ArticleCategoryDTO, ArticleCategoryTreeRequest, ArticleDTO, ArticleQuery, ArticleTagDTO, ArticleTagQuery } from '../type/model/km-article-model';
 export declare class KmArticleApi {
+    /**
+     * 查询文章分类树
+     */
     static getCategoryTree(data: ArticleCategoryTreeRequest): Promise<CommonRes<ArticleCategoryDTO>>;
+    /**
+     * 查询文章分页列表
+     */
     static getPage(data: ArticleQuery): Promise<CommonRes<PagedList<ArticleDTO>>>;
+    /**
+     * 文章内容查询
+     */
     static getContent(id: number | string): Promise<CommonRes<ArticleDTO>>;
+    /**
+     * 查询标签分类树
+     */
     static getTagCategoryTree(data: ArticleCategoryTreeRequest): Promise<CommonRes<ArticleCategoryDTO>>;
+    /**
+     * 查询标签分页列表
+     */
     static getTagPage(data: ArticleTagQuery): Promise<CommonRes<PagedList<ArticleTagDTO>>>;
 }

package/dist/types/src/api/km-form-api.d.ts

@@ -1,6 +1,10 @@
 import type { CommonRes } from '../type/net-types';
 import { KMForm } from '../type/model/km-form-model';
 export declare class KmFormApi {
+    /**
+     * 获取表单内容
+     * URL: /api/shcp-km/${ShcpApiSdk.getApiSuffix()}/form/content/query
+     */
     static getContent(formId: number | string): Promise<CommonRes<KMForm.FormResultDTO>>;
     /**
      * 根据用户传参进行智能辅助填充

package/dist/types/src/api/km-form-rule-relation-api.d.ts

@@ -1,6 +1,14 @@
 import type { CommonRes } from '../type/net-types';
 import { FormRuleRelationDTO, FormRuleRelationQuery } from '../type/model/km-form-rule-relation-model';
 export declare class KmFormRuleRelationApi {
+    /**
+     * 单个查询
+     * URL: /api/shcp-km/${ShcpApiSdk.getApiSuffix()}/form/rule/get
+     */
     static get(data: FormRuleRelationQuery): Promise<CommonRes<FormRuleRelationDTO>>;
+    /**
+     * 列表查询
+     * URL: /api/shcp-km/${ShcpApiSdk.getApiSuffix()}/form/rule/list
+     */
     static getList(data: FormRuleRelationQuery): Promise<CommonRes<FormRuleRelationDTO[]>>;
 }

package/dist/types/src/api/login-api.d.ts

@@ -1,18 +1,46 @@
 import type { AppClientLoginRequest, PotentialCustomerCreateRequest, PotentialCustomerDTO, SaleDTO, Tenant } from '../type/model/login-model';
 import type { CommonRes } from '../type/net-types';
 export declare class LoginApi {
+    /**
+     * 新增
+     * URL: /api/blade-system/${ShcpApiSdk.getApiSuffix()}/potentialCustomer/create
+     */
     static createApplyAccount(data: PotentialCustomerCreateRequest): Promise<CommonRes<PotentialCustomerDTO>>;
+    /**
+     * 获取申请结果
+     * URL: /api/blade-system/${ShcpApiSdk.getApiSuffix()}/salesConfig/get
+     */
     static getApplyResult(): Promise<CommonRes<SaleDTO>>;
+    /**
+     * 刷新token
+     * URL: /api/blade-auth/oauth/token
+     */
     static refreshToken(data: {
         tenantId: string;
         refresh_token: string;
     }): any;
+    /**
+     * 用户登录
+     * URL: /api/blade-auth/oauth/token
+     */
     static toLogin(data: {
         tenantId: string;
         username: string;
         password: string;
     }): any;
+    /**
+     * 应用客户端登录
+     * URL: /api/blade-auth/appClient/login
+     */
     static appClientLogin(data: AppClientLoginRequest): Promise<CommonRes<any>>;
+    /**
+     * 获取租户列表
+     * URL: /api/blade-system/tenant/selectTenant
+     */
     static getTenantList(): Promise<CommonRes<Tenant>>;
+    /**
+     * 获取关联租户列表
+     * URL: /api/blade-system/${ShcpApiSdk.getApiSuffix()}/appClient/list
+     */
     static getRelatedTenantList(relateTenantId: string): any;
 }

package/dist/types/src/api/marketing-api.d.ts

@@ -1,16 +1,64 @@
 import type { CommonRes, PagedList } from '../type/net-types';
 import type { MarketingContentCreateRequest as MarketingContentSaveRequest, MarketingContentDTO, MarketingCreateRequest, MarketingDeleteRequest, MarketingDTO, MarketingQuery, MarketingTaskDTO, MarketingTaskLogCreateRequest, MarketingTaskLogDTO, MarketingTaskLogQuery, MarketingTaskQuery, MarketingUpdateRequest, MessageTemplateDTO, MessageTemplateQuery, marketingSendContentRequest } from '../type/model/marketing-model';
 export declare class MarketingApi {
+    /**
+     * 保存营销内容
+     * URL: /api/shcp-marketing/${ShcpApiSdk.getApiSuffix()}/marketing/content/save
+     */
     static saveContent(data: MarketingContentSaveRequest): Promise<CommonRes<MarketingContentDTO[]>>;
+    /**
+     * 创建营销活动
+     * URL: /api/shcp-marketing/${ShcpApiSdk.getApiSuffix()}/marketing/create
+     */
     static create(data: MarketingCreateRequest): Promise<CommonRes<MarketingDTO>>;
+    /**
+     * 更新营销活动
+     * URL: /api/shcp-marketing/${ShcpApiSdk.getApiSuffix()}/marketing/update
+     */
     static update(data: MarketingUpdateRequest): Promise<CommonRes<MarketingDTO>>;
+    /**
+     * 获取营销活动分页
+     * URL: /api/shcp-marketing/${ShcpApiSdk.getApiSuffix()}/marketing/page
+     */
     static getPage(data: MarketingQuery): Promise<CommonRes<PagedList<MarketingDTO>>>;
+    /**
+     * 删除营销活动
+     * URL: /api/shcp-marketing/${ShcpApiSdk.getApiSuffix()}/marketing/delete
+     */
     static delete(data: MarketingDeleteRequest): Promise<CommonRes<void>>;
+    /**
+     * 获取营销活动详情
+     * URL: /api/shcp-marketing/${ShcpApiSdk.getApiSuffix()}/marketing/detail
+     */
     static getDetail(id: number): Promise<CommonRes<MarketingDTO>>;
+    /**
+     * 获取营销任务分页
+     * URL: /api/shcp-marketing/${ShcpApiSdk.getApiSuffix()}/marketing/task/page
+     */
     static getTaskPage(data: MarketingTaskQuery): Promise<CommonRes<PagedList<MarketingTaskDTO>>>;
+    /**
+     * 获取营销任务日志分页
+     * URL: /api/shcp-marketing/${ShcpApiSdk.getApiSuffix()}/marketing/task/log/page
+     */
     static getTaskLogPage(data: MarketingTaskLogQuery): Promise<CommonRes<PagedList<MarketingTaskLogDTO>>>;
+    /**
+     * 创建营销任务日志
+     * URL: /api/shcp-marketing/${ShcpApiSdk.getApiSuffix()}/marketing/task/log/create
+     */
     static createTaskLogs(data: MarketingTaskLogCreateRequest[]): Promise<CommonRes<MarketingTaskLogDTO[]>>;
+    /**
+     * 获取消息模板列表
+     * URL: /api/shcp-marketing/${ShcpApiSdk.getApiSuffix()}/message/template/list
+     */
     static getMessageTemplateList(data: MessageTemplateQuery): Promise<CommonRes<MessageTemplateDTO[]>>;
+    /**
+     * 获取消息模板详情
+     * URL: /api/shcp-marketing/${ShcpApiSdk.getApiSuffix()}/message/template/detail
+     */
     static getMessageTemplateDetail(id: number): Promise<CommonRes<MessageTemplateDTO>>;
+    /**
+     * 获取模版列表数据
+     * URL: /api/shcp-marketing/${ShcpApiSdk.getApiSuffix()}/marketing/content/list
+     */
     static getSendContent(data: marketingSendContentRequest): Promise<CommonRes<boolean>>;
 }

package/dist/types/src/api/message-record-api.d.ts

@@ -1,7 +1,19 @@
 import type { CommonRes, PagedList } from '../type/net-types';
 import type { MessageRecordDTO, MessageRecordQuery, MessageRecordUpdateRequest, WrapperMessageRecordDTO } from '../type/model/message-record-model';
 export declare class MessageRecordApi {
+    /**
+     * 获取消息记录详情
+     * URL: /api/shcp-message/${ShcpApiSdk.getApiSuffix()}/message/record/detail
+     */
     static getDetail(id: number): Promise<CommonRes<MessageRecordDTO>>;
+    /**
+     * 按天分组获取消息记录分页
+     * URL: /api/shcp-message/${ShcpApiSdk.getApiSuffix()}/message/record/pageGroupedByDay
+     */
     static getPageGroupedByDay(data: MessageRecordQuery): Promise<CommonRes<PagedList<WrapperMessageRecordDTO>>>;
+    /**
+     * 更新消息记录
+     * URL: /api/shcp-message/${ShcpApiSdk.getApiSuffix()}/message/record/update
+     */
     static update(data: MessageRecordUpdateRequest): Promise<CommonRes<boolean>>;
 }

package/dist/types/src/api/mine-api.d.ts

@@ -1,8 +1,24 @@
 import type { CommonRes } from '../type/net-types';
 import type { AppClientPageConfigDTO, AppClientPageConfigQuery, UserInfo } from '../type/model/mine-model';
 export declare class MineApi {
+    /**
+     * 获取用户信息
+     * URL: /api/blade-system/user/info
+     */
     static getUserInfo: (id: string | number) => Promise<CommonRes<UserInfo>>;
+    /**
+     * 更新用户信息
+     * URL: /api/blade-system/user/update-info
+     */
     static updateInfo: (data: any) => Promise<any>;
+    /**
+     * 获取我的页面配置
+     * URL: /api/blade-system/${ShcpApiSdk.getApiSuffix()}/appClient/pageConfig/get
+     */
     static getMyPageConfig: (data: AppClientPageConfigQuery) => Promise<CommonRes<AppClientPageConfigDTO>>;
+    /**
+     * 获取详情内容
+     * URL: /api/shcp-km/${ShcpApiSdk.getApiSuffix()}/article/content/query
+     */
     static getArticleContent: (id: string) => Promise<any>;
 }