zmp-sdk 2.52.1-beta.1 → 2.52.1-beta.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/index.d.ts CHANGED
@@ -1443,80 +1443,66 @@ type VoucherAction = {
1443
1443
  cta: string;
1444
1444
  };
1445
1445
  type AddVoucherData = {
1446
- /**
1447
- * Tiêu đề hiển thị trên card.
1448
- */
1449
- title: string;
1450
- /**
1451
- * Nội dung encode vào QR hoặc barcode.
1452
- */
1453
- code: string;
1454
- /**
1455
- * Loại mã hiển thị. Mặc định là `qr_code`.
1456
- */
1457
- display?: VoucherDisplayType;
1458
1446
  /**
1459
1447
  * Tên voucher / ưu đãi.
1460
1448
  */
1461
1449
  name: string;
1462
1450
  /**
1463
- * Tên chủ thẻ hiển thị phụ dưới tên voucher. Mặc định dùng `ownerName`.
1451
+ * Điều kiện áp dụng (chính), hiển thị trên chi tiết vé.
1464
1452
  */
1465
- desc?: string;
1466
- /**
1467
- * Logo hiển thị trên card. Mặc định dùng `merchantLogoUrl`.
1468
- */
1469
- avatarUrl?: string;
1453
+ condition: string;
1470
1454
  /**
1471
- * Nguồn phát hành voucher.
1455
+ * Điều kiện áp dụng chi tiết (phụ).
1472
1456
  */
1473
- partner?: string;
1457
+ conditionDetail?: string;
1474
1458
  /**
1475
- * Tên thương hiệu / cửa hàng phát hành voucher.
1459
+ * Thời gian bắt đầu hiệu lực, epoch milliseconds.
1476
1460
  */
1477
- merchantName: string;
1461
+ validAt?: number;
1478
1462
  /**
1479
- * OA ID của merchant trên Zalo.
1463
+ * Hạn sử dụng, epoch milliseconds.
1480
1464
  */
1481
- merchantOaId: string;
1465
+ expiredAt: number;
1482
1466
  /**
1483
- * Logo merchant.
1467
+ * Mã voucher; không truyền thì tự sinh QR OA của merchant.
1484
1468
  */
1485
- merchantLogoUrl?: string;
1469
+ code?: string;
1486
1470
  /**
1487
- * Tên người nhận voucher.
1471
+ * Loại mã hiển thị. Mặc định là `qr_code`.
1488
1472
  */
1489
- ownerName: string;
1473
+ display?: VoucherDisplayType;
1490
1474
  /**
1491
- * Điều kiện sử dụng tóm tắt.
1475
+ * Token để merchant gửi tin nhắn không tốn phí. Lấy từ callback
1476
+ * `onDataReceived` của `showFunctionButtonWidget`.
1492
1477
  */
1493
- condition: string;
1478
+ interactToken?: string;
1494
1479
  /**
1495
- * Điều kiện sử dụng đầy đủ.
1480
+ * Tên khách hàng sở hữu; không truyền thì không hiển thị trên vé.
1496
1481
  */
1497
- conditionDetail?: string;
1482
+ ownerName?: string;
1498
1483
  /**
1499
- * Thời điểm bắt đầu hiệu lực, epoch milliseconds.
1484
+ * OA ID của merchant trên Zalo.
1500
1485
  */
1501
- validAt?: number;
1486
+ merchantOaId: string;
1502
1487
  /**
1503
- * Thời điểm hết hạn, epoch milliseconds.
1488
+ * Tên OA / thương hiệu phát hành voucher.
1504
1489
  */
1505
- expiredAt: number;
1490
+ merchantName: string;
1506
1491
  /**
1507
- * Thời điểm gửi nhắc hạn, epoch milliseconds.
1492
+ * Logo OA, dùng làm logo hiển thị trên voucher.
1508
1493
  */
1509
- remindAt?: number;
1494
+ merchantLogoUrl: string;
1510
1495
  /**
1511
- * Danh sách CTA hiển thị trên thẻ.
1496
+ * Danh sách CTA hiển thị trên thẻ (tối đa 2).
1512
1497
  */
1513
1498
  actions?: VoucherAction[];
1514
1499
  };
1515
1500
  type AddVoucherReturns = {
1516
1501
  /**
1517
- * ID thẻ voucher trong Ví QR.
1502
+ * Token để merchant gửi tin nhắn OA cho người dùng; chuỗi rỗng nếu server
1503
+ * không trả về.
1518
1504
  */
1519
- id: string | number;
1505
+ oa_message_token: string;
1520
1506
  };
1521
1507
  type TempFile = {
1522
1508
  /**
@@ -5366,39 +5352,64 @@ declare function addRating(args?: AsyncVoidCallback): Promise<void>;
5366
5352
  * API này gửi dữ liệu voucher từ Mini App về server trung gian. Server trung gian
5367
5353
  * chịu trách nhiệm đăng nhập Ví QR, mã hoá dữ liệu bằng `secureKey`, sau đó trả về
5368
5354
  * deeplink thêm thẻ vào Ví QR. SDK sẽ tự mở deeplink này bằng `openWebview` để đưa
5369
- * người dùng tới màn hình thêm thẻ; deeplink không được trả về cho bên gọi.
5355
+ * người dùng tới màn hình thêm thẻ; deeplink không được trả về cho bên gọi, chỉ
5356
+ * trả về `oa_message_token`.
5370
5357
  *
5371
5358
  * @zaloOnly Chỉ hoạt động khi chạy bên trong ứng dụng Zalo mobile.
5372
5359
  *
5373
5360
  * @param {string} name Tên voucher / ưu đãi.
5374
- * @param {string} code Nội dung encode vào QR hoặc barcode.
5375
- * @param {"qr_code" | "bar_code"} [display="qr_code"] Loại mã hiển thị.
5376
- * @param {string} merchantName Tên thương hiệu / cửa hàng phát hành voucher.
5361
+ * @param {string} condition Điều kiện áp dụng (chính), hiển thị trên chi tiết vé.
5362
+ * @param {number} expiredAt Hạn sử dụng, epoch milliseconds.
5377
5363
  * @param {string} merchantOaId OA ID của merchant trên Zalo.
5378
- * @param {string} ownerName Tên người nhận voucher.
5379
- * @param {string} condition Điều kiện sử dụng tóm tắt.
5380
- * @param {number} expiredAt Thời điểm hết hạn, epoch milliseconds.
5381
- * @param {number} [remindAt] Thời điểm gửi nhắc hạn, epoch milliseconds.
5382
- * @param {VoucherAction[]} [actions] Danh sách CTA hiển thị trên thẻ.
5364
+ * @param {string} merchantName Tên OA / thương hiệu phát hành voucher.
5365
+ * @param {string} merchantLogoUrl Logo OA, dùng làm logo hiển thị trên voucher.
5366
+ * @param {string} [conditionDetail] Điều kiện áp dụng chi tiết (phụ).
5367
+ * @param {number} [validAt] Thời gian bắt đầu hiệu lực, epoch milliseconds.
5368
+ * @param {string} [code] Mã voucher; không truyền thì tự sinh QR OA của merchant.
5369
+ * @param {"qr_code" | "bar_code"} [display="qr_code"] Loại mã hiển thị.
5370
+ * @param {string} [ownerName] Tên khách hàng sở hữu; không truyền thì không hiển thị trên vé.
5371
+ * @param {string} [interactToken] Token để merchant gửi tin nhắn không tốn phí.
5372
+ * Lấy từ callback `onDataReceived` của {@link showFunctionButtonWidget} khi
5373
+ * người dùng nhấn vào Function Button Widget.
5374
+ * @param {VoucherAction[]} [actions] Danh sách CTA hiển thị trên thẻ (tối đa 2).
5383
5375
  *
5384
- * @returns {Promise<void>} Promise resolve khi tạo thẻ thành công và deeplink đã
5385
- * được mở; reject kèm mã lỗi từ server nếu thất bại.
5376
+ * @returns {Promise<AddVoucherReturns>} Promise resolve khi tạo thẻ thành công và
5377
+ * deeplink đã được mở, trả về `oa_message_token` (chuỗi rỗng nếu server không
5378
+ * trả về); reject kèm mã lỗi từ server nếu thất bại.
5386
5379
  *
5387
5380
  * @example Thêm voucher vào Ví QR:
5388
5381
  * ```ts
5389
5382
  * await addVoucher({
5390
- * name: "Giảm 50k cho đơn từ 150k",
5391
- * code: "SPFOOD50K",
5392
- * merchantName: "Shopee Food",
5393
- * merchantOaId: "2712772826697148176",
5394
- * ownerName: "Nguyễn Văn A",
5395
- * condition: "Áp dụng cho đơn từ 150.000đ.",
5396
- * expiredAt: 1751299200000,
5397
- * remindAt: 1751212800000,
5383
+ * name: "Giảm 50% giá trị đơn hàng",
5384
+ * condition: "Áp dụng cho hóa đơn trên 200.000đ",
5385
+ * expiredAt: 1743440399000,
5386
+ * merchantOaId: "2646373759294038927",
5387
+ * merchantName: "The Face Shop",
5388
+ * merchantLogoUrl: "https://static.example.com/logo.png",
5389
+ * });
5390
+ * ```
5391
+ *
5392
+ * @example Gửi kèm `interactToken` lấy từ Function Button Widget:
5393
+ * ```ts
5394
+ * showFunctionButtonWidget({
5395
+ * id: "orderButton",
5396
+ * type: "ORDER",
5397
+ * text: "Tạo đơn hàng",
5398
+ * onDataReceived: async (interactToken) => {
5399
+ * await addVoucher({
5400
+ * name: "Giảm 50% giá trị đơn hàng",
5401
+ * condition: "Áp dụng cho hóa đơn trên 200.000đ",
5402
+ * expiredAt: 1743440399000,
5403
+ * merchantOaId: "2646373759294038927",
5404
+ * merchantName: "The Face Shop",
5405
+ * merchantLogoUrl: "https://static.example.com/logo.png",
5406
+ * interactToken,
5407
+ * });
5408
+ * },
5398
5409
  * });
5399
5410
  * ```
5400
5411
  */
5401
- declare function addVoucher(args: AsyncCallback<void> & AddVoucherData): Promise<void>;
5412
+ declare function addVoucher(args: AsyncCallback<AddVoucherReturns> & AddVoucherData): Promise<AddVoucherReturns>;
5402
5413
 
5403
5414
  declare const interactOAArgs$1: ZodObject<{
5404
5415
  oaId: ZodString;