@be-link/ecommerce-promotion-service-node-sdk 0.1.57 → 0.1.59

package/enum.d.ts

@@ -498,6 +498,24 @@ export declare namespace ENUM {
             SUCCESS = "\u53D1\u653E\u6210\u529F",
             FAILED = "\u53D1\u653E\u5931\u8D25"
         }
+        /** 会员权益领取状态（前端展示口径） */
+        enum BENEFIT_CLAIM_STATUS {
+            /** 未领取 */
+            UNCLAIMED = "UNCLAIMED",
+            /** 已领取未使用 */
+            UNUSED = "UNUSED",
+            /** 已使用 */
+            USED = "USED",
+            /** 已失效 */
+            INVALID = "INVALID"
+        }
+        /** 会员权益领取状态中文 */
+        enum BENEFIT_CLAIM_STATUS_CHINESE {
+            UNCLAIMED = "\u672A\u9886\u53D6",
+            UNUSED = "\u672A\u4F7F\u7528",
+            USED = "\u5DF2\u4F7F\u7528",
+            INVALID = "\u5DF2\u5931\u6548"
+        }
         /** 权益回收状态 */
         enum RECOVERY_STATUS {
             /** 待回收 */

package/enum.js

@@ -565,6 +565,26 @@ var ENUM;
             BENEFIT_RECORD_STATUS_CHINESE["SUCCESS"] = "\u53D1\u653E\u6210\u529F";
             BENEFIT_RECORD_STATUS_CHINESE["FAILED"] = "\u53D1\u653E\u5931\u8D25";
         })(BENEFIT_RECORD_STATUS_CHINESE = MEMBER_ENUM.BENEFIT_RECORD_STATUS_CHINESE || (MEMBER_ENUM.BENEFIT_RECORD_STATUS_CHINESE = {}));
+        /** 会员权益领取状态（前端展示口径） */
+        let BENEFIT_CLAIM_STATUS;
+        (function (BENEFIT_CLAIM_STATUS) {
+            /** 未领取 */
+            BENEFIT_CLAIM_STATUS["UNCLAIMED"] = "UNCLAIMED";
+            /** 已领取未使用 */
+            BENEFIT_CLAIM_STATUS["UNUSED"] = "UNUSED";
+            /** 已使用 */
+            BENEFIT_CLAIM_STATUS["USED"] = "USED";
+            /** 已失效 */
+            BENEFIT_CLAIM_STATUS["INVALID"] = "INVALID";
+        })(BENEFIT_CLAIM_STATUS = MEMBER_ENUM.BENEFIT_CLAIM_STATUS || (MEMBER_ENUM.BENEFIT_CLAIM_STATUS = {}));
+        /** 会员权益领取状态中文 */
+        let BENEFIT_CLAIM_STATUS_CHINESE;
+        (function (BENEFIT_CLAIM_STATUS_CHINESE) {
+            BENEFIT_CLAIM_STATUS_CHINESE["UNCLAIMED"] = "\u672A\u9886\u53D6";
+            BENEFIT_CLAIM_STATUS_CHINESE["UNUSED"] = "\u672A\u4F7F\u7528";
+            BENEFIT_CLAIM_STATUS_CHINESE["USED"] = "\u5DF2\u4F7F\u7528";
+            BENEFIT_CLAIM_STATUS_CHINESE["INVALID"] = "\u5DF2\u5931\u6548";
+        })(BENEFIT_CLAIM_STATUS_CHINESE = MEMBER_ENUM.BENEFIT_CLAIM_STATUS_CHINESE || (MEMBER_ENUM.BENEFIT_CLAIM_STATUS_CHINESE = {}));
         /** 权益回收状态 */
         let RECOVERY_STATUS;
         (function (RECOVERY_STATUS) {

package/modules/benefit/service.d.ts

@@ -12,6 +12,7 @@ declare class BenefitService extends BaseService implements Service.BenefitContr
     deleteConfig(request: Service.Request.deleteConfig): Promise<Service.Response.deleteConfig>;
     listConfigsByTemplate(request: Service.Request.listConfigsByTemplate): Promise<Service.Response.listConfigsByTemplate>;
     getBenefitStatus(request: Service.Request.getBenefitStatus): Promise<Service.Response.getBenefitStatus>;
+    getBenefitStatusByUserId(request: Service.Request.getBenefitStatusByUserId): Promise<Service.Response.getBenefitStatusByUserId>;
     getBlackDiamondTemplateIdByCity(request: Service.Request.getBlackDiamondTemplateIdByCity): Promise<Service.Response.getBlackDiamondTemplateIdByCity>;
 }
 export declare const benefitService: BenefitService;

package/modules/benefit/service.js

@@ -51,6 +51,9 @@ let BenefitService = class BenefitService extends BaseService_1.default {
     getBenefitStatus(request) {
         return (0, http_1.callApi)(this.getApiUrl(this.getBenefitStatus), request);
     }
+    getBenefitStatusByUserId(request) {
+        return (0, http_1.callApi)(this.getApiUrl(this.getBenefitStatusByUserId), request);
+    }
     getBlackDiamondTemplateIdByCity(request) {
         return (0, http_1.callApi)(this.getApiUrl(this.getBlackDiamondTemplateIdByCity), request);
     }
@@ -105,6 +108,11 @@ __decorate([
     (0, tsoa_1.Post)('get-benefit-status'),
     __param(0, (0, tsoa_1.Body)())
 ], BenefitService.prototype, "getBenefitStatus", null);
+__decorate([
+    (0, tsoa_1.OperationId)('按用户查询当前会员权益状态'),
+    (0, tsoa_1.Post)('get-benefit-status-by-user-id'),
+    __param(0, (0, tsoa_1.Body)())
+], BenefitService.prototype, "getBenefitStatusByUserId", null);
 __decorate([
     (0, tsoa_1.OperationId)('按城市查询黑钻模板ID'),
     (0, tsoa_1.Post)('get-black-diamond-template-id-by-city'),

package/modules/benefit/types.d.ts

@@ -48,8 +48,8 @@ export declare namespace Service {
             triggerType: string;
             /** 生命周期最多领取次数，null 为不限 */
             maxReceiveCount: number | null;
-            /** 关联券模板ID（券权益时使用） */
-            couponTemplateId: string;
+            /** 券候选ID集合（N选1，最多3个） */
+            couponCandidateIds: string[];
             /** 发放数量（券权益时生效） */
             quantity: number;
             /** 发放积分数量 */
@@ -74,14 +74,23 @@ export declare namespace Service {
                 status: string;
                 amount?: number;
             };
-            /** 券权益状态 */
-            coupon?: {
-                status: string;
-            };
+            /**
+             * 券权益状态：与定价/用户券 {@link ENUM.PRICING_CALCULATION_ENUM.COUPON_STATUS} 一致；
+             * 中文仅取自 {@link ENUM.PRICING_CALCULATION_ENUM.COUPON_STATUS_CHINESE}，不做业务侧再映射。
+             */
+            couponStatus?: ENUM.PRICING_CALCULATION_ENUM.COUPON_STATUS;
+            couponStatusChinese?: ENUM.PRICING_CALCULATION_ENUM.COUPON_STATUS_CHINESE;
             /** 酒旅权益状态 */
             hotelTravel?: {
                 status: string;
             };
+            /** 权益领取态列表 */
+            benefitClaims?: Array<{
+                benefitId: string;
+                benefitSubType: ENUM.MEMBER_ENUM.BENEFIT_SUB_TYPE;
+                claimStatus: ENUM.MEMBER_ENUM.BENEFIT_CLAIM_STATUS;
+                selectedCouponId?: string;
+            }>;
         }
     }
     namespace Request {
@@ -176,8 +185,8 @@ export declare namespace Service {
             triggerType: string;
             /** 生命周期最多领取次数，null 为不限 */
             maxReceiveCount?: number | null;
-            /** 关联券模板ID（券权益时使用） */
-            couponTemplateId?: string;
+            /** 券候选ID集合（N选1，最多3个） */
+            couponCandidateIds?: string[];
             /** 发放数量（券权益时生效） */
             quantity?: number;
             /** 发放积分数量 */
@@ -201,8 +210,8 @@ export declare namespace Service {
             triggerType?: string;
             /** 生命周期最多领取次数，null 为不限 */
             maxReceiveCount?: number | null;
-            /** 关联券模板ID（券权益时使用） */
-            couponTemplateId?: string;
+            /** 券候选ID集合（N选1，最多3个） */
+            couponCandidateIds?: string[];
             /** 发放数量（券权益时生效） */
             quantity?: number;
             /** 发放积分数量 */
@@ -229,6 +238,11 @@ export declare namespace Service {
             /** 会员订单号 */
             memberOrderId: string;
         }
+        /** 按用户查询当前会员权益状态 */
+        interface getBenefitStatusByUserId {
+            /** 用户ID */
+            userId: string;
+        }
         /** 按城市查询黑钻模板ID */
         interface getBlackDiamondTemplateIdByCity {
             /** 城市ID */
@@ -298,6 +312,8 @@ export declare namespace Service {
         type listConfigsByTemplate = Entity.BenefitConfig[];
         /** 会员订单权益状态 */
         type getBenefitStatus = Entity.BenefitStatus;
+        /** 按用户查询当前会员权益状态 */
+        type getBenefitStatusByUserId = Entity.BenefitStatus;
         /** 按城市查询黑钻模板ID */
         interface getBlackDiamondTemplateIdByCity {
             /** 模板ID */
@@ -315,6 +331,7 @@ export declare namespace Service {
         deleteConfig(request: Request.deleteConfig): Promise<Response.deleteConfig>;
         listConfigsByTemplate(request: Request.listConfigsByTemplate): Promise<Response.listConfigsByTemplate>;
         getBenefitStatus(request: Request.getBenefitStatus): Promise<Response.getBenefitStatus>;
+        getBenefitStatusByUserId(request: Request.getBenefitStatusByUserId): Promise<Response.getBenefitStatusByUserId>;
         getBlackDiamondTemplateIdByCity(request: Request.getBlackDiamondTemplateIdByCity): Promise<Response.getBlackDiamondTemplateIdByCity>;
     }
 }

package/modules/member/service.d.ts

@@ -5,6 +5,8 @@ declare class MemberService extends BaseService implements Service.MemberControl
     triggerMemberOrderPaid(request: Service.Request.triggerMemberOrderPaid): Promise<Service.Response.triggerMemberOrderPaid>;
     recoverMemberOrderRefund(request: Service.Request.recoverMemberOrderRefund): Promise<Service.Response.recoverMemberOrderRefund>;
     listBenefitOfficers(request: Service.Request.listBenefitOfficers): Promise<Service.Response.listBenefitOfficers>;
+    listClaimableBenefits(request: Service.Request.listClaimableBenefits): Promise<Service.Response.listClaimableBenefits>;
+    claimMemberBenefit(request: Service.Request.claimMemberBenefit): Promise<Service.Response.claimMemberBenefit>;
 }
 export declare const memberService: MemberService;
 export default memberService;

package/modules/member/service.js

@@ -30,6 +30,12 @@ let MemberService = class MemberService extends BaseService_1.default {
     listBenefitOfficers(request) {
         return (0, http_1.callApi)(this.getApiUrl(this.listBenefitOfficers), request);
     }
+    listClaimableBenefits(request) {
+        return (0, http_1.callApi)(this.getApiUrl(this.listClaimableBenefits), request);
+    }
+    claimMemberBenefit(request) {
+        return (0, http_1.callApi)(this.getApiUrl(this.claimMemberBenefit), request);
+    }
 };
 __decorate([
     (0, tsoa_1.OperationId)('会员正向触发（mock trade）'),
@@ -46,6 +52,16 @@ __decorate([
     (0, tsoa_1.Post)('list-benefit-officers'),
     __param(0, (0, tsoa_1.Body)())
 ], MemberService.prototype, "listBenefitOfficers", null);
+__decorate([
+    (0, tsoa_1.OperationId)('查询会员可领取权益列表'),
+    (0, tsoa_1.Post)('list-claimable-benefits'),
+    __param(0, (0, tsoa_1.Body)())
+], MemberService.prototype, "listClaimableBenefits", null);
+__decorate([
+    (0, tsoa_1.OperationId)('手动领取会员权益'),
+    (0, tsoa_1.Post)('claim-member-benefit'),
+    __param(0, (0, tsoa_1.Body)())
+], MemberService.prototype, "claimMemberBenefit", null);
 MemberService = __decorate([
     (0, tsoa_1.Route)('member'),
     (0, tsoa_1.Tags)('Member')

package/modules/member/types.d.ts

@@ -1,3 +1,4 @@
+import { ENUM } from '../../enum';
 export declare namespace Service {
     namespace Entity {
         /** 会员权益发放/回收记录 */
@@ -14,6 +15,18 @@ export declare namespace Service {
             membershipType: string;
             /** 权益类型 */
             benefitType: string;
+            /** 权益ID */
+            benefitId: string;
+            /** 领取状态 */
+            claimStatus: ENUM.MEMBER_ENUM.BENEFIT_CLAIM_STATUS;
+            /** 用户选择券ID */
+            selectedCouponId: string;
+            /** 权益模板ID */
+            templateId: string;
+            /** 券候选ID集合 */
+            couponCandidateIds: string[];
+            /** 过期时间 */
+            expireAt: number;
             /** 创建时间（时间戳，毫秒） */
             createdAt: number;
             /** 更新时间（时间戳，毫秒） */
@@ -44,17 +57,22 @@ export declare namespace Service {
         }
         /** 会员订单退款回收结果 */
         interface RecoverMemberOrderRefundResult {
-            /** 券回收结果 */
+            /**
+             * 券回收结果：英文 + 中文。
+             * 正常为用户券 `COUPON_STATUS` / `COUPON_STATUS_CHINESE`；查询失败等兜底为 `RECOVERY_STATUS` / `RECOVERY_STATUS_CHINESE`。
+             */
             coupon: {
-                status: string;
+                status: ENUM.PRICING_CALCULATION_ENUM.COUPON_STATUS | ENUM.MEMBER_ENUM.RECOVERY_STATUS;
+                statusChinese: ENUM.PRICING_CALCULATION_ENUM.COUPON_STATUS_CHINESE | ENUM.MEMBER_ENUM.RECOVERY_STATUS_CHINESE;
             };
             /** 积分回收结果 */
             points: {
                 recoveredAmount: number;
             };
-            /** 酒旅权益回收结果 */
+            /** 酒旅权益回收结果：英文 + 中文 */
             hotelTravel: {
-                status: string;
+                status: ENUM.MEMBER_ENUM.RECOVERY_STATUS;
+                statusChinese: ENUM.MEMBER_ENUM.RECOVERY_STATUS_CHINESE;
             };
         }
     }
@@ -86,23 +104,52 @@ export declare namespace Service {
             userId: string;
             /** 逆向单号（退款单号） */
             reverseOrderId: string;
-            /** 触发回收时交易侧感知的券状态（需与用户侧实时状态一致） */
-            couponStatus: string;
+            /**
+             * 用户券状态英文枚举（`ENUM.PRICING_CALCULATION_ENUM.COUPON_STATUS`），须与用户服务返回的 `couponBenefitCouponStatus` 一致
+             */
+            couponStatus: ENUM.PRICING_CALCULATION_ENUM.COUPON_STATUS;
         }
         /** 查询用户所属福利官 */
         interface listBenefitOfficers {
             /** 用户ID */
             userId: string;
         }
+        /** 查询可领取权益列表 */
+        interface listClaimableBenefits {
+            /** 用户ID */
+            userId: string;
+            /** 会员订单号（不传默认最新） */
+            orderNo?: string;
+        }
+        /** 手动领取权益 */
+        interface claimMemberBenefit {
+            /** 用户ID */
+            userId: string;
+            /** 会员订单号 */
+            orderNo: string;
+            /** 权益ID */
+            benefitId: string;
+            /** 券权益选择的券ID */
+            couponId?: string;
+        }
     }
     namespace Response {
         type triggerMemberOrderPaid = void;
         type recoverMemberOrderRefund = Entity.RecoverMemberOrderRefundResult;
         type listBenefitOfficers = Entity.BenefitOfficerRelation[];
+        interface listClaimableBenefits {
+            orderNo: string;
+            list: Entity.MemberBenefitRecordDTO[];
+        }
+        interface claimMemberBenefit {
+            claimStatus: string;
+        }
     }
     interface MemberController {
         triggerMemberOrderPaid(request: Request.triggerMemberOrderPaid): Promise<Response.triggerMemberOrderPaid>;
         recoverMemberOrderRefund(request: Request.recoverMemberOrderRefund): Promise<Response.recoverMemberOrderRefund>;
         listBenefitOfficers(request: Request.listBenefitOfficers): Promise<Response.listBenefitOfficers>;
+        listClaimableBenefits(request: Request.listClaimableBenefits): Promise<Response.listClaimableBenefits>;
+        claimMemberBenefit(request: Request.claimMemberBenefit): Promise<Response.claimMemberBenefit>;
     }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@be-link/ecommerce-promotion-service-node-sdk",
-  "version": "0.1.57",
+  "version": "0.1.59",
   "description": "EcommercePromotionService Node.js SDK",
   "main": "index.js",
   "types": "index.d.ts",