@be-link/ecommerce-backend-bff-service-node-sdk 0.0.112 → 0.0.114

package/esm/bff/modules/pandora/coupon/types.d.ts

@@ -0,0 +1,403 @@
+import { PROMOTION_SERVICE_ENUM } from '../../../../enums';
+import { StandardResponse } from '../../../../types';
+export declare namespace CouponService {
+    namespace Entity {
+        /** 券生命周期 */
+        interface CouponLifeCycle {
+            /** 固定生效时间（时间戳） */
+            effectAt?: number;
+            /** 固定过期时间（时间戳） */
+            expireAt?: number;
+            /** 相对生效天数（自领券后开始计算，与生效&过期时间互斥） */
+            effectiveDays?: number;
+        }
+        /** 券使用限制 */
+        interface CouponUsageLimit {
+            /** 类型：FEE-金额 */
+            type: PROMOTION_SERVICE_ENUM.COUPON_ENUM.USAGE_LIMIT_TYPE;
+            /** 限制值 */
+            value: number;
+            /** 生效类型：ITEM-单份商品 */
+            effectType: string;
+        }
+        /** 优惠规则额外信息 */
+        interface DiscountRuleExtra {
+            /** 阶梯序号 */
+            tier?: number;
+            /** 门槛金额（分） */
+            floor?: number;
+            /** 上限金额（分，-1表示无上限） */
+            ceiling?: number;
+            /** 是否可叠加 */
+            stackable?: boolean;
+            /** 最大叠加次数 */
+            maxStack?: number;
+        }
+        /** 券领取限制 */
+        interface CouponReceiveLimit {
+            /** 自增主键 */
+            id?: number;
+            /** 券ID */
+            couponId: string;
+            /** 限制维度 */
+            type: PROMOTION_SERVICE_ENUM.COUPON_ENUM.RECEIVE_LIMIT_TYPE;
+            /** 限制值 */
+            limitValue: number;
+            /** 创建时间 */
+            createdAt?: number;
+            /** 更新时间 */
+            updatedAt?: number;
+            /** 删除时间 */
+            deletedAt?: number;
+        }
+        /** 券优惠规则 */
+        interface CouponDiscountRule {
+            /** 自增主键 */
+            id?: number;
+            /** 券ID */
+            couponId: string;
+            /** 优惠类型 */
+            type: PROMOTION_SERVICE_ENUM.COUPON_ENUM.DISCOUNT_RULE_TYPE;
+            /** 优惠值（金额：分，折扣：0-100） */
+            discountValue: number;
+            /** 优惠级别 */
+            level: PROMOTION_SERVICE_ENUM.COUPON_ENUM.DISCOUNT_LEVEL;
+            /** 同级多规则时的排序 */
+            priority: number;
+            /** 规则信息 */
+            extra?: Entity.DiscountRuleExtra;
+            /** 创建时间 */
+            createdAt?: number;
+            /** 更新时间 */
+            updatedAt?: number;
+            /** 删除时间 */
+            deletedAt?: number;
+        }
+        /** 券适用范围 */
+        interface CouponScope {
+            /** ID */
+            id?: string;
+            /** 创建时间 */
+            createdAt?: number;
+            /** 更新时间 */
+            updatedAt?: number;
+            /** 删除时间 */
+            deletedAt?: number;
+            /** 券ID */
+            couponId: string;
+            /** 是否可用 */
+            available: boolean;
+            /** 标签ID */
+            tagId: string;
+        }
+        /** 券操作记录 */
+        interface CouponOperateLog {
+            /** ID */
+            id?: string;
+            /** 创建时间 */
+            createdAt?: number;
+            /** 更新时间 */
+            updatedAt?: number;
+            /** 删除时间 */
+            deletedAt?: number;
+            /** 操作类型 */
+            operateType: PROMOTION_SERVICE_ENUM.COUPON_ENUM.OPERATE_TYPE;
+            /** 操作详情 */
+            operateDetail?: any;
+            /** 操作人 */
+            operator: string;
+            /** 券ID */
+            couponId: string;
+        }
+        /** 券库存流水 */
+        interface CouponStockFlow {
+            /** 主键ID */
+            id?: string;
+            /** 创建时间 */
+            createdAt?: number;
+            /** 更新时间 */
+            updatedAt?: number;
+            /** 删除时间 */
+            deletedAt?: number;
+            /** 券ID */
+            couponId: string;
+            /** 渠道 */
+            channel: PROMOTION_SERVICE_ENUM.COUPON_ENUM.STOCK_CHANNEL;
+            /** 库存变更量（正数） */
+            changeStock: number;
+            /** 变动类型 */
+            changeType: PROMOTION_SERVICE_ENUM.COUPON_ENUM.STOCK_CHANGE_TYPE;
+            /** 业务ID */
+            bizId: string;
+            /** 操作人 */
+            operator: string;
+        }
+        /** 券模版 */
+        interface CouponTemplate {
+            /** ID */
+            id?: string;
+            /** 创建时间 */
+            createdAt?: number;
+            /** 更新时间 */
+            updatedAt?: number;
+            /** 删除时间 */
+            deletedAt?: number;
+            /** 创建人ID */
+            creatorId: string;
+            /** 券名称 */
+            name: string;
+            /** 券类型 */
+            couponType: PROMOTION_SERVICE_ENUM.COUPON_ENUM.COUPON_TYPE;
+            /** 券状态 */
+            status?: PROMOTION_SERVICE_ENUM.COUPON_ENUM.COUPON_STATUS;
+            /** 初始数量（-1为无限） */
+            originalQty: number;
+            /** 剩余数量（-1为无限） */
+            lastQty?: number;
+            /** 使用说明 */
+            instructions: string;
+            /** 券生命周期 */
+            lifeCycle: CouponLifeCycle;
+            /** 使用限制 */
+            usageLimit?: CouponUsageLimit;
+            /** 领取限制列表 */
+            receiveLimits?: CouponReceiveLimit[];
+            /** 优惠规则列表 */
+            discountRules?: CouponDiscountRule[];
+            /** 适用范围列表 */
+            scopes?: CouponScope[];
+        }
+    }
+    namespace Request {
+        /** 创建券模版 */
+        interface createCouponTemplate {
+            /** 券名称 */
+            name: string;
+            /** 券类型 */
+            couponType: PROMOTION_SERVICE_ENUM.COUPON_ENUM.COUPON_TYPE;
+            /** 初始数量（-1为无限） */
+            originalQty: number;
+            /** 使用说明 */
+            instructions: string;
+            /** 券生命周期 */
+            lifeCycle: Entity.CouponLifeCycle;
+            /** 使用限制 */
+            usageLimit?: Entity.CouponUsageLimit;
+            /** 领取限制列表 */
+            receiveLimits?: Array<{
+                /** 限制维度 */
+                type: PROMOTION_SERVICE_ENUM.COUPON_ENUM.RECEIVE_LIMIT_TYPE;
+                /** 限制值 */
+                limitValue: number;
+            }>;
+            /** 优惠规则列表 */
+            discountRules?: Array<{
+                /** 优惠类型 */
+                type: PROMOTION_SERVICE_ENUM.COUPON_ENUM.DISCOUNT_RULE_TYPE;
+                /** 优惠值（金额：分，折扣：0-100） */
+                discountValue: number;
+                /** 优惠级别 */
+                level: PROMOTION_SERVICE_ENUM.COUPON_ENUM.DISCOUNT_LEVEL;
+                /** 同级多规则时的排序 */
+                priority: number;
+                /** 规则信息 */
+                extra?: Entity.DiscountRuleExtra;
+            }>;
+            /** 适用范围列表 */
+            scopes: {
+                /** 是否可用 */
+                available: boolean;
+                /** 范围值 */
+                scopeValue?: string;
+                /** 商品列表 */
+                idList?: string[];
+                /** 范围类型 */
+                scopeType: PROMOTION_SERVICE_ENUM.COUPON_ENUM.SCOPE_TYPE;
+            };
+        }
+        /** 作废券模版 */
+        interface abandonCouponTemplate {
+            /** 券ID */
+            couponId: string;
+        }
+        /** 券模版列表查询 */
+        interface getCouponTemplateList {
+            /** 页码 */
+            pageIndex?: number;
+            /** 每页数量 */
+            pageSize?: number;
+            /** 券名称（模糊查询） */
+            name?: string;
+            /** 券类型 */
+            couponType?: PROMOTION_SERVICE_ENUM.COUPON_ENUM.COUPON_TYPE;
+            /** 券状态 */
+            status?: PROMOTION_SERVICE_ENUM.COUPON_ENUM.COUPON_STATUS;
+        }
+        /** 增加券库存 */
+        interface addCouponStock {
+            /** 券ID */
+            couponId: string;
+            /** 增加数量 */
+            addQty: number;
+            /** 渠道 */
+            channel?: PROMOTION_SERVICE_ENUM.COUPON_ENUM.STOCK_CHANNEL;
+            /** 备注 */
+            remark?: string;
+        }
+        /** 获取券模版详情 */
+        interface getCouponTemplateDetail {
+            /** 券ID */
+            couponId: string;
+        }
+        /** 同步券至火山 */
+        interface syncCouponToLive {
+            /** 券ID */
+            couponId: string;
+        }
+        /** 修改券模版适用商品 */
+        interface updateCouponTemplateProduct {
+            /** 券ID */
+            couponId: string;
+            /** 适用范围 */
+            idList?: string[];
+            /** 适用范围类型 */
+            scopeType: PROMOTION_SERVICE_ENUM.COUPON_ENUM.SCOPE_TYPE;
+            /** 是否可用 */
+            available: boolean;
+        }
+        /** 获取券模版的使用商品 */
+        interface getProductScopeList {
+            /** 券ID */
+            couponId: string;
+        }
+    }
+    namespace Response {
+        /** 券模版列表项 */
+        interface CouponTemplateListItem {
+            /** 优惠券ID */
+            id: string;
+            /** 名称 */
+            name: string;
+            /** 类型 */
+            couponType: PROMOTION_SERVICE_ENUM.COUPON_ENUM.COUPON_TYPE;
+            /** 优惠内容（格式化后的文本，如"满100减20"） */
+            discountContent: string;
+            /** 适用商品（格式化后的文本，如"全部商品"） */
+            applicableScope: string;
+            /** 已领取数量 */
+            receivedCount: number;
+            /** 未领取数量 */
+            unreceivedCount: number;
+            /** 状态 */
+            status: PROMOTION_SERVICE_ENUM.COUPON_ENUM.COUPON_STATUS;
+            /** 创建时间 */
+            createdAt: number;
+            /** 更新时间 */
+            updatedAt: number;
+        }
+        /** 券模版列表响应 */
+        interface getCouponTemplateList {
+            /** 总数 */
+            total: number;
+            /** 券模版列表 */
+            list: CouponTemplateListItem[];
+            /** 当前页码 */
+            pageIndex: number;
+            /** 每页数量 */
+            pageSize: number;
+        }
+        /** 增加券库存响应 */
+        interface addCouponStock {
+            /** 是否成功 */
+            success: boolean;
+            /** 券ID */
+            couponId: string;
+            /** 增加前的库存 */
+            beforeStock: number;
+            /** 增加后的库存 */
+            afterStock: number;
+            /** 库存流水ID */
+            stockFlowId?: string;
+        }
+        /** 获取券模版详情响应 */
+        interface getCouponTemplateDetail {
+            /** 券ID */
+            id: string;
+            /** 券名称 */
+            name: string;
+            /** 券类型 */
+            couponType: PROMOTION_SERVICE_ENUM.COUPON_ENUM.COUPON_TYPE;
+            /** 初始数量（-1为无限） */
+            originalQty: number;
+            /** 使用说明 */
+            instructions: string;
+            /** 券生命周期 */
+            lifeCycle: Entity.CouponLifeCycle;
+            /** 使用限制 */
+            usageLimit?: Entity.CouponUsageLimit;
+            /** 领取限制列表 */
+            receiveLimits?: Array<{
+                /** 限制维度 */
+                type: PROMOTION_SERVICE_ENUM.COUPON_ENUM.RECEIVE_LIMIT_TYPE;
+                /** 限制值 */
+                limitValue: number;
+            }>;
+            /** 优惠规则列表 */
+            discountRules?: Array<{
+                /** 优惠类型 */
+                type: PROMOTION_SERVICE_ENUM.COUPON_ENUM.DISCOUNT_RULE_TYPE;
+                /** 优惠值（金额：分，折扣：0-100） */
+                discountValue: number;
+                /** 优惠级别 */
+                level: PROMOTION_SERVICE_ENUM.COUPON_ENUM.DISCOUNT_LEVEL;
+                /** 同级多规则时的排序 */
+                priority: number;
+                /** 规则信息 */
+                extra?: Entity.DiscountRuleExtra;
+            }>;
+            /** 适用范围列表 */
+            scopes?: Array<{
+                /** 是否可用 */
+                available: boolean;
+                /** 范围值 */
+                scopeValue?: string;
+                /** 范围类型 */
+                scopeType: PROMOTION_SERVICE_ENUM.COUPON_ENUM.SCOPE_TYPE;
+                /** 商品列表 */
+                idList: string[];
+            }>;
+        }
+        /** 扣减券库存响应 */
+        interface deductCouponStock {
+            /** 是否成功 */
+            success: boolean;
+            /** 失败消息 */
+            message?: string;
+        }
+        /** 获取券模版的使用商品响应 */
+        interface getProductScopeList {
+            /** ID列表 */
+            idList: string[];
+            /** 类型 */
+            idType?: PROMOTION_SERVICE_ENUM.COUPON_ENUM.SCOPE_TYPE;
+        }
+    }
+    interface CouponTemplateController {
+        /** 创建券模版 */
+        createCouponTemplate(request: CouponService.Request.createCouponTemplate): Promise<StandardResponse<void>>;
+        /** 作废券模版 */
+        abandonCouponTemplate(request: CouponService.Request.abandonCouponTemplate): Promise<StandardResponse<void>>;
+        /** 获取券模版列表 */
+        getCouponTemplateList(request: CouponService.Request.getCouponTemplateList): Promise<StandardResponse<CouponService.Response.getCouponTemplateList>>;
+        /** 增加券库存 */
+        addCouponStock(request: CouponService.Request.addCouponStock): Promise<StandardResponse<void>>;
+        /** 获取券模版详情 */
+        getCouponTemplateDetail(request: CouponService.Request.getCouponTemplateDetail): Promise<StandardResponse<CouponService.Response.getCouponTemplateDetail>>;
+        /** 同步券至火山直播 */
+        syncCouponToLive(request: CouponService.Request.syncCouponToLive): Promise<StandardResponse<void>>;
+        /** 修改券模版适用商品 */
+        updateCouponTemplateScope(request: CouponService.Request.updateCouponTemplateProduct): Promise<StandardResponse<void>>;
+        /** 获取券模版的使用商品 */
+        getProductScopeList(request: CouponService.Request.getProductScopeList): Promise<StandardResponse<CouponService.Response.getProductScopeList>>;
+    }
+}

package/esm/bff/modules/pandora/coupon/types.mjs

@@ -0,0 +1 @@
+export {};

package/esm/bff/modules/pandora/franchisee/service.d.ts

@@ -0,0 +1,19 @@
+import { PandoraFranchiseeService as Service } from './types';
+import BaseService from '../../BaseService';
+import type { StandardResponse } from '../../../../types';
+/**
+ * PandoraFranchiseeService - Pandora Franchisee 服务模块
+ * 提供 Pandora Franchisee 相关的 API 方法
+ * 平台: pandora
+ */
+export declare class PandoraFranchiseeService extends BaseService implements Service.FranchiseeController {
+    protected prefixUrl: string;
+    createFranchisee(request: Service.Request.createFranchisee): Promise<StandardResponse<Service.Response.createFranchisee>>;
+    updateFranchisee(request: Service.Request.updateFranchisee): Promise<StandardResponse<Service.Response.updateFranchisee>>;
+    listFranchisees(request: Service.Request.listFranchisees): Promise<StandardResponse<Service.Response.listFranchisees>>;
+    getFranchiseeDetail(request: Service.Request.getFranchiseeDetail): Promise<StandardResponse<Service.Response.getFranchiseeDetail>>;
+    getFranchiseeEditHistory(request: Service.Request.getFranchiseeEditHistory): Promise<StandardResponse<Service.Response.getFranchiseeEditHistory>>;
+    checkAndUpdateAccountInfo(request: Service.Request.checkAndUpdateAccountInfo): Promise<StandardResponse<Service.Response.checkAndUpdateAccountInfo>>;
+    getFranchiseeIdByUserId(request: Service.Request.getFranchiseeIdByUserId): Promise<StandardResponse<Service.Response.getFranchiseeIdByUserId>>;
+    updateStatus(request: Service.Request.updateStatus): Promise<StandardResponse<Service.Response.updateStatus>>;
+}

package/esm/bff/modules/pandora/franchisee/service.mjs

@@ -0,0 +1,36 @@
+import BaseService from '../../BaseService.mjs';
+/**
+ * PandoraFranchiseeService - Pandora Franchisee 服务模块
+ * 提供 Pandora Franchisee 相关的 API 方法
+ * 平台: pandora
+ */
+export class PandoraFranchiseeService extends BaseService {
+    constructor() {
+        super(...arguments);
+        this.prefixUrl = '/pandora/franchisee';
+    }
+    createFranchisee(request) {
+        return this.request(this.createFranchisee, request);
+    }
+    updateFranchisee(request) {
+        return this.request(this.updateFranchisee, request);
+    }
+    listFranchisees(request) {
+        return this.request(this.listFranchisees, request);
+    }
+    getFranchiseeDetail(request) {
+        return this.request(this.getFranchiseeDetail, request);
+    }
+    getFranchiseeEditHistory(request) {
+        return this.request(this.getFranchiseeEditHistory, request);
+    }
+    checkAndUpdateAccountInfo(request) {
+        return this.request(this.checkAndUpdateAccountInfo, request);
+    }
+    getFranchiseeIdByUserId(request) {
+        return this.request(this.getFranchiseeIdByUserId, request);
+    }
+    updateStatus(request) {
+        return this.request(this.updateStatus, request);
+    }
+}

package/esm/bff/modules/pandora/franchisee/types.d.ts

@@ -0,0 +1,204 @@
+import { StandardResponse } from '../../../../types';
+export declare namespace PandoraFranchiseeService {
+    namespace Request {
+        /**
+         * 创建加盟商
+         */
+        interface createFranchisee {
+            name: string;
+            directorName: string;
+            directorPhone: string;
+            bdDirector?: string;
+            stores: string[];
+            settleCycle: string;
+            financeGroup?: string;
+        }
+        /**
+         * 查询加盟商列表
+         */
+        interface listFranchisees {
+            pageIndex?: number;
+            pageSize?: number;
+            name?: string;
+            directorName?: string;
+            directorPhone?: string;
+            bdDirector?: string;
+            status?: 'VALID' | 'INVALID';
+            approvalStatus?: string;
+            financeGroup?: string;
+        }
+        /**
+         * 查询加盟商详情
+         */
+        interface getFranchiseeDetail {
+            id: string;
+        }
+        /**
+         * 查询加盟商编辑历史
+         */
+        interface getFranchiseeEditHistory {
+            id: string;
+        }
+        /**
+         * 更新加盟商（基础信息）
+         */
+        interface updateFranchisee {
+            id: string;
+            name?: string;
+            directorName?: string;
+            directorPhone?: string;
+            bdDirector?: string;
+            stores?: string[];
+            type?: 'STORE_BIND_FRANCHISEE';
+            settleCycle?: string;
+            lastEditor: string;
+            financeGroup?: string;
+        }
+        /**
+         * 校验并更新加盟商账户信息
+         */
+        interface checkAndUpdateAccountInfo {
+            id: string;
+            userId: string;
+            enterpriseName?: string;
+            enterpriseType?: string;
+            legalRepresentative?: string;
+            businessLicense?: string;
+            supplementalAgreement?: string[];
+            accountName?: string;
+            accountNumber?: string;
+            bankName?: string;
+            bankBranchName?: string;
+            contactMobile?: string;
+            lastEditor?: string;
+        }
+        /**
+         * 根据用户ID获取加盟商ID
+         */
+        interface getFranchiseeIdByUserId {
+            userId: string;
+        }
+        /**
+         * 更新加盟商状态
+         */
+        interface updateStatus {
+            id: string;
+            status: 'VALID' | 'INVALID';
+        }
+    }
+    namespace Response {
+        /**
+         * 创建加盟商响应
+         */
+        interface createFranchisee {
+            id: string;
+        }
+        /**
+         * 更新加盟商响应
+         */
+        interface updateFranchisee {
+            success: boolean;
+        }
+        /**
+         * 加盟商列表项
+         */
+        interface franchiseeListItem {
+            id: string;
+            name: string;
+            directorName: string;
+            directorPhone: string;
+            bdDirector: string;
+            status: string;
+            stores: Array<{
+                storeId: string;
+                storeName: string;
+            }>;
+            settleCycle: string;
+            updatedAt: number;
+            lastEditor: string;
+            username: string;
+            approvalStatus: string;
+            financeGroup: string;
+        }
+        /**
+         * 加盟商列表响应
+         */
+        interface listFranchisees {
+            list: franchiseeListItem[];
+            total: number;
+            pageIndex: number;
+            pageSize: number;
+        }
+        /**
+         * 加盟商详情响应
+         */
+        interface getFranchiseeDetail {
+            id: string;
+            name: string;
+            directorName: string;
+            directorPhone: string;
+            bdDirector: string;
+            userId: string;
+            status: string;
+            createdAt: number;
+            updatedAt: number;
+            enterpriseName: string;
+            enterpriseType: string;
+            legalRepresentative: string;
+            businessLicense: string;
+            supplementalAgreement: string[];
+            accountName: string;
+            accountNumber: string;
+            bankName: string;
+            bankBranchName: string;
+            contactMobile: string;
+            approvalStatus: string;
+            lastEditor: string;
+        }
+        /**
+         * 编辑历史项
+         */
+        interface editHistoryItem {
+            relatedType: string;
+            operator: string;
+            createdAt: number;
+        }
+        /**
+         * 加盟商编辑历史响应
+         */
+        interface getFranchiseeEditHistory {
+            list: editHistoryItem[];
+        }
+        /**
+         * 校验并更新加盟商账户信息响应
+         */
+        interface checkAndUpdateAccountInfo {
+            success: boolean;
+        }
+        /**
+         * 根据用户ID获取加盟商ID响应
+         */
+        interface getFranchiseeIdByUserId {
+            id: string;
+        }
+        /**
+         * 更新加盟商状态响应
+         */
+        interface updateStatus {
+            success: boolean;
+        }
+    }
+    /**
+     * Franchisee Controller 接口定义
+     */
+    interface FranchiseeController {
+        createFranchisee(request: Request.createFranchisee): Promise<StandardResponse<Response.createFranchisee>>;
+        updateFranchisee(request: Request.updateFranchisee): Promise<StandardResponse<Response.updateFranchisee>>;
+        listFranchisees(request: Request.listFranchisees): Promise<StandardResponse<Response.listFranchisees>>;
+        getFranchiseeDetail(request: Request.getFranchiseeDetail): Promise<StandardResponse<Response.getFranchiseeDetail>>;
+        getFranchiseeEditHistory(request: Request.getFranchiseeEditHistory): Promise<StandardResponse<Response.getFranchiseeEditHistory>>;
+        checkAndUpdateAccountInfo(request: Request.checkAndUpdateAccountInfo): Promise<StandardResponse<Response.checkAndUpdateAccountInfo>>;
+        getFranchiseeIdByUserId(request: Request.getFranchiseeIdByUserId): Promise<StandardResponse<Response.getFranchiseeIdByUserId>>;
+        updateStatus(request: Request.updateStatus): Promise<StandardResponse<Response.updateStatus>>;
+    }
+}

package/esm/bff/modules/pandora/franchisee/types.mjs

@@ -0,0 +1 @@
+export {};