shcp-api-lib 1.0.0

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

@@ -0,0 +1,31 @@
+import { FormRuleType } from '../../constants/km-const';
+export interface FormRuleRelationDTO {
+    /** id */
+    id?: number;
+    /** 租户id */
+    tenantId?: string;
+    /** 表单关联规则类型 */
+    type?: FormRuleType;
+    /** 表单id */
+    formId?: number;
+    /** 规则id */
+    ruleId?: number;
+    /** 规则代码 */
+    ruleCode?: string;
+    /** 扩展数据 */
+    extra?: string;
+}
+export interface FormRuleRelationQuery {
+    /** 租户id */
+    tenantId?: string;
+    /** 表单规则类型 */
+    type?: FormRuleType;
+    /** 表单规则类型集合 */
+    typeList?: FormRuleType[];
+    /** 表单id */
+    formId?: number;
+    /** 规则id */
+    ruleId?: number;
+    /** 使用域 */
+    extra?: string;
+}

package/dist/types/src/type/model/login-model.d.ts

@@ -0,0 +1,90 @@
+export interface PotentialCustomerCreateRequest {
+    name: string;
+    phone: string;
+    workplace: string;
+    email: string;
+}
+export interface PotentialCustomerDTO {
+    id: number;
+    name: string;
+    phone: string;
+    workplace: string;
+    email: string;
+    status: any;
+    remark: string;
+    createTime: Date;
+}
+export interface SaleDTO {
+    name: string;
+    wxQrCodeUrl: string;
+    workplace: string;
+    remark: string;
+}
+export interface Tenant {
+    tenantId: string;
+    tenantName: string;
+    tenantType: number;
+    domainUrl: string;
+    loginBackgroundUrl: string;
+    loginLogoUrl: string;
+    homePageLogoUrl: string;
+    homePageBackgroundUrl: string;
+    linkman: string;
+    contactNumber: string;
+    address: string;
+    accountNumber: number;
+    expireTime: Date;
+    packageId: number | null;
+    datasourceId: number | null;
+    licenseKey: string;
+}
+/**
+ * 客户端登录请求参数
+ */
+export interface AppClientLoginRequest {
+    /**
+     * 授权类型
+     */
+    grantType?: string;
+    /**
+     * 租户id
+     */
+    tenantId: string;
+    /**
+     * 客户端Id
+     */
+    appClientId: number | string;
+    /**
+     * 设备用户id
+     */
+    deviceUserId?: number | string;
+    /**
+     * 设备用户账号id
+     */
+    loginAccount?: string;
+    /**
+     * 设备类型
+     */
+    loginCode?: string;
+    /**
+     * 用户配置信息（rawData+signature, encryptedData+iv）
+     */
+    userProfile?: {
+        /**
+         * 原始数据
+         */
+        rawData?: string;
+        /**
+         * 签名
+         */
+        signature?: string;
+        /**
+         * 加密数据
+         */
+        encryptedData?: string;
+        /**
+         * 初始向量
+         */
+        iv?: string;
+    };
+}

package/dist/types/src/type/model/marketing-model.d.ts

@@ -0,0 +1,142 @@
+import { MarketingTaskLogStatus, MarketingTaskStatus, MessageActionLabel, MessageBizCategory, MessageChannelType, MessageStyle } from '../../constants/shcp-common';
+import type { PageRequest } from './common-model';
+import type { ConsumerDTO, ConsumerGroupDTO } from './consumer-model';
+export interface MarketingContentDTO {
+    /** 主键id  业务名contentId */
+    id: number;
+    /** 关联的营销应用ID，关联：Marketing.id */
+    marketingId: number;
+    /** 营销内容的发送渠道 */
+    channelType: number;
+    /** 营销内容配置信息，json格式 */
+    config: string;
+}
+export interface MarketingContentCreateRequest {
+    marketingId: number;
+    smsContents: SmsDTO[];
+    cAppCardContents: CAppCardDTO[];
+}
+export interface MarketingContentUpdateRequest {
+    marketingId: number;
+    smsContents: SmsDTO[];
+    cAppCardContents: CAppCardDTO[];
+}
+export interface SmsDTO {
+    templateId: number;
+    content: string;
+    templateParams: Array<Map<string, string>>;
+    time: number;
+}
+export interface CAppCardDTO {
+    templateId: number;
+    title: string;
+    subtitle: string;
+    body: string;
+    resourceId: number;
+    time: number;
+}
+export interface MarketingDTO {
+    id: number;
+    tenantId: string;
+    name: string;
+    type: number;
+    userSourceType: number;
+    pushType: number;
+    pushWay: string;
+    groupId: string;
+    consumerIds: string;
+    status: number;
+    consumerGroupDTOS: ConsumerGroupDTO[];
+    consumerDTOS: ConsumerDTO[];
+}
+export interface MarketingCreateRequest {
+    tenantId: string;
+    name: string;
+    type: number;
+    groupId: string;
+    consumerIds: string;
+}
+export interface MarketingUpdateRequest {
+    id: number;
+    tenantId: string;
+    name: string;
+    type: number;
+    pushType: number;
+    pushWay: string;
+    status: number;
+    groupId: string;
+    consumerIds: string;
+}
+export interface MarketingQuery extends PageRequest {
+    id: number;
+    tenantId: string;
+    name: string;
+    type: number;
+    userSourceType: number;
+    pushType: number;
+    pushWay: string;
+    status: number;
+}
+export interface MarketingDeleteRequest {
+    id: number;
+}
+export interface MarketingTaskDTO {
+    id: number;
+    marketingId: number;
+    contentId: number;
+    name: string;
+    execTime: number;
+    status: MarketingTaskStatus;
+    taskSendNum: number;
+    tenantId: string;
+    taskSuccessNum: number;
+    taskFailNum: number;
+}
+export interface MarketingTaskQuery extends PageRequest {
+    startCreateTime: number;
+    endCreateTime: number;
+    startActualExecTime: number;
+    endActualExecTime: number;
+    status: MarketingTaskStatus;
+    parentId: number;
+}
+export interface MarketingTaskLogDTO {
+    createTime: number;
+    consumerId: number;
+    consumerUrl: string;
+    content: string;
+    status: MarketingTaskLogStatus;
+}
+export interface MarketingTaskLogQuery extends PageRequest {
+    taskId: number;
+    consumerId: number;
+    startCreateTime: string;
+    endCreateTime: string;
+    status: MarketingTaskLogStatus;
+}
+export interface MarketingTaskLogCreateRequest {
+    status: MarketingTaskLogStatus;
+    consumerId: number;
+    consumerPhone: string;
+    taskId: number;
+}
+export interface MessageTemplateDTO {
+    name: string;
+    channelType: MessageChannelType;
+    style: MessageStyle;
+    bizCategory: MessageBizCategory;
+    title: string;
+    subtitle: string;
+    body: string;
+    actionLabel: MessageActionLabel;
+    actionUrl: string;
+    smsTemplateId: string;
+    placeHolders: Array<Map<string, string>>;
+}
+export interface MessageTemplateQuery {
+    TemplateName?: string;
+    messageChannelType?: MessageChannelType;
+}
+export interface marketingSendContentRequest {
+    marketingId: string;
+}

package/dist/types/src/type/model/message-record-model.d.ts

@@ -0,0 +1,59 @@
+import type { HealthServiceType, MessageActionLabel, MessageActionStatus, MessageBizCategory, MessageChannelType, MessageStatus, MessageStyle } from '../../constants/shcp-common';
+import type { PageRequest } from './common-model';
+export interface MessageRecordDTO {
+    id: number;
+    title: string;
+    subtitle: string;
+    body: string;
+    style: MessageStyle;
+    actionLabel: MessageActionLabel;
+    bizCategory: MessageBizCategory;
+    actionUrl: string;
+    actionStatus: MessageActionStatus;
+    extra: string;
+    status: MessageStatus;
+    readTime: string;
+    createTime: string;
+}
+export interface WrapperMessageRecordDTO {
+    dateTime: string;
+    records: MessageRecordDTO[];
+    id: string;
+}
+export interface MessageRecordQuery extends PageRequest {
+    tenantId: string | number;
+    outId: number;
+    serviceType: HealthServiceType;
+    receiverId: number | string;
+    receiverUrl: string;
+    bizCategory: MessageBizCategory;
+    channel: MessageChannelType;
+    status: MessageStatus;
+    notStatus: MessageStatus;
+    query: any;
+}
+/**
+ * 消息记录的更新请求
+ */
+export interface MessageRecordUpdateRequest {
+    /**
+     * 消息记录ID
+     */
+    id: number;
+    /**
+     * 卡片消息的动作标签名称，比如：去采集、去打卡、去查看（文章）
+     */
+    actionLabel?: MessageActionLabel;
+    /**
+     * 卡片消息的动作跳转URL
+     */
+    actionUrl?: string;
+    /**
+     * 卡片动作执行状态
+     */
+    actionStatus?: MessageActionStatus;
+    /**
+     * 消息状态
+     */
+    status?: MessageStatus;
+}

package/dist/types/src/type/model/mine-model.d.ts

@@ -0,0 +1,100 @@
+import type { AppPlatformType, ShcpUserType } from '../../constants/shcp-common';
+export interface UserInfo {
+    id: string;
+    password: string;
+    tenantName: string;
+    name: string;
+    userType: number;
+    userTypeName: string;
+    account: string;
+    avatar: string;
+    roleName: string;
+    deptName: string;
+    postName: string;
+    sexName: string;
+    userExt: string;
+    phone: string;
+    birthday: string;
+    email: string;
+    tenantId: string;
+    sex: number;
+}
+export interface DeviceUserInfo {
+    user_id: string;
+    user_name: string;
+    tenant_id: string;
+    access_token: string;
+    refresh_token: string;
+    token_type: string;
+    expires_in: number;
+    license: string;
+    nick_name: string;
+    oauth_id: string;
+    post_id: string;
+    real_name: string;
+    avatar: string;
+    gender: number;
+    role_id: string;
+    account: string;
+    role_name: string;
+    mobile?: string;
+}
+export interface AppClientPageConfigQuery {
+    id?: number;
+    consumerId?: number | string;
+    pageName?: string;
+    componentName: string;
+    appClientId?: number | string;
+    tenantId?: string;
+    platformType?: AppPlatformType;
+    usertype?: ShcpUserType;
+    componentNames?: Array<string>;
+}
+export interface AppClientPageConfigDTO {
+    id: number;
+    name: string;
+    title: string;
+    components: ComponentInfo[];
+    description: string;
+    vendorName: string;
+}
+export interface ComponentInfo {
+    id: number;
+    name: string;
+    title: string;
+    style: string;
+    config: ComponentConfig;
+    componentCoverUrl: string;
+    updateTime: string;
+    lengthNum: number;
+}
+export interface ComponentConfig {
+    id: number;
+    items: ComponentItem[];
+    verticalLayout: string;
+    horizontalLayout: string;
+    itemCountEachRow: number;
+    isSwap: string;
+    alignItems: string;
+    articleCategoryRootId: string;
+    coverImage: string;
+    mainTitle: string;
+    subTitle: string;
+    tags: string[];
+    introduction: string;
+    updateTime: string;
+}
+export interface ComponentItem {
+    id: number;
+    sort: number;
+    name: string;
+    title: string;
+    subtitle: string;
+    iconUrl: string;
+    isShow: string | number;
+    linkType: string;
+    link: string;
+    ServiceType: number;
+    updateTime: string;
+    lengthNum: number;
+}

package/dist/types/src/type/model/right-qrcode-model.d.ts

@@ -0,0 +1,143 @@
+import { HealthServiceType } from '../../constants/shcp-common';
+import type { PageRequest } from './common-model';
+/**
+ * 权益二维码创建参数
+ */
+export interface RightQrCodeRequest extends PageRequest {
+    /**
+     * 二维码关联的权益ID
+     */
+    rightId: number;
+    /**
+     * 二维码标题
+     */
+    title?: string;
+    /**
+     * 来源医生ID
+     */
+    sourceUserId?: number;
+    /**
+     * 服务医生ID
+     */
+    serviceUserId?: number;
+}
+/**
+ * 权益二维码数据传输对象
+ */
+export interface RightQrCodeDTO {
+    /**
+     * 主键ID
+     */
+    id?: number;
+    /**
+     * 二维码关联的权益ID，关联: Right.id
+     */
+    rightId?: number;
+    /**
+     * 权益名称
+     */
+    rightName?: string;
+    /**
+     * 二维码所属业务租户ID，关联: Tenant.id。注: 冗余字段
+     */
+    tenantId?: string;
+    /**
+     * 二维码标题
+     */
+    title?: string;
+    /**
+     * 来源医生ID，必须是所属服务组的用户，关联：BladeUser.id
+     */
+    sourceUserId?: number;
+    /**
+     * 来源医生名称
+     */
+    sourceUserName?: string;
+    /**
+     * 服务医生ID，必须是所属服务组的用户，关联: BladeUser.id
+     */
+    serviceUserId?: number;
+    /**
+     * 服务医生名称
+     */
+    serviceUserName?: string;
+    /**
+     * 二维码包含的目标URL，比如小程序、H5等
+     */
+    targetUrl?: string;
+    /**
+     * 二维码中logo图片
+     */
+    logo?: string;
+    /**
+     * 最终生成的二维码图片的URL
+     */
+    qrCodeImage?: string;
+    /**
+     * 服务类型
+     */
+    serviceType?: HealthServiceType;
+}
+/**
+ * 权益二维码更新参数
+ */
+export interface RightQrCodeUpdateRequest {
+    /**
+     * 主键ID
+     */
+    id: number;
+    /**
+     * 二维码关联的权益ID
+     */
+    rightId?: number;
+    /**
+     * 二维码所属业务租户ID
+     */
+    tenantId?: string;
+    /**
+     * 二维码标题
+     */
+    title?: string;
+    /**
+     * 来源医生ID
+     */
+    sourceUserId?: number;
+    /**
+     * 服务医生ID
+     */
+    serviceUserId?: number;
+    /**
+     * 二维码中logo图片
+     */
+    logo?: string;
+}
+/**
+ * 权益二维码创建参数
+ */
+export interface RightQrCodeCreateRequest {
+    /**
+     * 二维码关联的权益ID
+     */
+    rightId: number | string;
+    /**
+     * 二维码所属业务租户ID
+     */
+    tenantId: string;
+    /**
+     * 二维码标题
+     */
+    title: string;
+    /**
+     * 来源医生ID
+     */
+    sourceUserId: number | string;
+    /**
+     * 服务医生ID
+     */
+    serviceUserId: number | string;
+    /**
+     * 二维码中logo图片
+     */
+    logo?: string;
+    [x: string]: any;
+}

package/dist/types/src/type/model/right-service-config-model.d.ts

@@ -0,0 +1,2 @@
+declare const _default: {};
+export default _default;

package/dist/types/src/type/model/system-right-model.d.ts

@@ -0,0 +1,134 @@
+import { ConsumerRightStatus, HealthServiceType } from '../../constants/shcp-common';
+import { PageRequest } from './common-model';
+/**
+ * 权益查询对象
+ */
+export interface RightQuery extends PageRequest {
+    /**
+     * 权益ID
+     */
+    id?: number;
+    /**
+     * 权益ID（多个）
+     */
+    ids?: number[];
+    /**
+     * 权益所属租户ID，关联: Tenant.id
+     */
+    tenantId?: string | number;
+    /**
+     * 权益所属租户IDs,关联: Tenant.id
+     */
+    tenantIds?: string[];
+    /**
+     * 权益名称
+     */
+    name?: string;
+    /**
+     * 权益类型，参考: RightType
+     */
+    type?: number;
+    /**
+     * 权益关联的健管服务类型，参考：HealthServiceType
+     */
+    serviceType?: HealthServiceType;
+    /**
+     * 权益关联的健管服务类型，参考：HealthServiceType
+     */
+    serviceTypes?: HealthServiceType[];
+    /**
+     * 权益状态，参考：RightStatus
+     */
+    status?: ConsumerRightStatus;
+    /**
+     * 权益的消费用户组根ID，关联: ConsumerGroup.ID
+     */
+    consumerGroupRootId?: number;
+    /**
+     * 权益的消费用户组根IDs，关联: ConsumerGroup.ID
+     */
+    consumerGroupRootIds?: number[];
+    /**
+     * 权益的医生服务组根ID，关联: TenantUserGroup.id
+     */
+    tenantUserGroupRootId?: number;
+    /**
+     * 权益的医生服务组根IDs，关联: TenantUserGroup.id
+     */
+    tenantUserGroupRootIds?: number[];
+    /**
+     * 权益服务用户ids
+     */
+    tenantUserIds?: (number | string)[];
+    /**
+     * 消费者用户id
+     */
+    consumerId?: number | string;
+    /**
+     * 权益元数据
+     */
+    metadata?: Record<string, any>;
+}
+/**
+ * 权益复制响应
+ */
+export interface RightCopyResponse {
+    /**
+     * 权益映射id
+     */
+    rightIdMapping?: Record<number, number>;
+    /**
+     * 权益配置映射id
+     */
+    rightServiceConfigIdMapping?: Record<number, number>;
+}
+/**
+ * 权益复制请求
+ */
+export interface RightCopyRequest {
+    /**
+     * 模版租户ID
+     */
+    templateTenantId: string;
+    /**
+     * 新租户ID
+     */
+    newTenantId: string;
+}
+/**
+ * 复制更新权益服务配置
+ */
+export interface RightServiceConfigCopyUpdateRequest {
+    /**
+     * 模版租户ID
+     */
+    templateTenantId?: string;
+    /**
+     * 权益映射ID
+     */
+    rightIdMapping?: Record<number, number>;
+    /**
+     * 权益配置映射ID
+     */
+    rightServiceConfigIdMapping?: Record<number, number>;
+    /**
+     * 文章映射ID
+     */
+    articleIdMapping?: Record<number, number>;
+    /**
+     * 文章分类映射ID
+     */
+    articleCategoryIdMapping?: Record<number, number>;
+    /**
+     * 文章标签映射ID
+     */
+    articleTagIdMapping?: Record<number, number>;
+    /**
+     * 表单关联映射ID
+     */
+    formIdMapping?: Record<number, number>;
+    /**
+     * 规则关联映射ID
+     */
+    ruleIdMapping?: Record<number, number>;
+}