zmp-sdk 2.51.5 → 2.52.0-beta.1

package/index.d.ts

@@ -1426,6 +1426,98 @@ type GetZPITokenReturns = {
     zpp: string;
     zpt: string;
 };
+type VoucherDisplayType = "qr_code" | "bar_code";
+type VoucherActionType = "url" | "phone";
+type VoucherAction = {
+    /**
+     * Loại CTA hiển thị trên thẻ voucher.
+     */
+    type: VoucherActionType;
+    /**
+     * URL khi `type=url`, hoặc số điện thoại khi `type=phone`.
+     */
+    value: string;
+    /**
+     * Nội dung hiển thị trên button CTA.
+     */
+    cta: string;
+};
+type AddVoucherData = {
+    /**
+     * Tiêu đề hiển thị trên card.
+     */
+    title: string;
+    /**
+     * Tên voucher / ưu đãi.
+     */
+    name: string;
+    /**
+     * Tên chủ thẻ hiển thị phụ dưới tên voucher. Mặc định dùng `ownerName`.
+     */
+    desc?: string;
+    /**
+     * Logo hiển thị trên card. Mặc định dùng `merchantLogoUrl`.
+     */
+    avatarUrl?: string;
+    /**
+     * Nội dung encode vào QR hoặc barcode.
+     */
+    code: string;
+    /**
+     * Loại mã hiển thị. Mặc định là `qr_code`.
+     */
+    display?: VoucherDisplayType;
+    /**
+     * Nguồn phát hành voucher.
+     */
+    partner?: string;
+    /**
+     * Tên thương hiệu / cửa hàng phát hành voucher.
+     */
+    merchantName: string;
+    /**
+     * OA ID của merchant trên Zalo.
+     */
+    merchantOaId: string;
+    /**
+     * Logo merchant.
+     */
+    merchantLogoUrl?: string;
+    /**
+     * Tên người nhận voucher.
+     */
+    ownerName: string;
+    /**
+     * Điều kiện sử dụng tóm tắt.
+     */
+    condition: string;
+    /**
+     * Điều kiện sử dụng đầy đủ.
+     */
+    conditionDetail?: string;
+    /**
+     * Thời điểm bắt đầu hiệu lực, epoch milliseconds.
+     */
+    validAt?: number;
+    /**
+     * Thời điểm hết hạn, epoch milliseconds.
+     */
+    expiredAt: number;
+    /**
+     * Thời điểm gửi nhắc hạn, epoch milliseconds.
+     */
+    remindAt?: number;
+    /**
+     * Danh sách CTA hiển thị trên thẻ.
+     */
+    actions?: VoucherAction[];
+};
+type AddVoucherReturns = {
+    /**
+     * ID thẻ voucher trong Ví QR.
+     */
+    id: string | number;
+};
 type TempFile = {
     /**
      * Đường dẫn các temp file đã chọn.
@@ -5268,6 +5360,46 @@ declare function requestSendNotification(args?: AsyncVoidCallback): Promise<void
  */
 declare function addRating(args?: AsyncVoidCallback): Promise<void>;
 
+/**
+ * Lưu voucher vào Ví QR của người dùng.
+ *
+ * API này gửi dữ liệu voucher từ Mini App về server trung gian. Server trung gian
+ * chịu trách nhiệm đăng nhập Ví QR, mã hoá dữ liệu bằng `secureKey`, sau đó trả về
+ * deeplink thêm thẻ vào Ví QR. SDK sẽ tự mở deeplink này bằng `openWebview` để đưa
+ * người dùng tới màn hình thêm thẻ; deeplink không được trả về cho bên gọi.
+ *
+ * @zaloOnly Chỉ hoạt động khi chạy bên trong ứng dụng Zalo mobile.
+ *
+ * @param {string} name Tên voucher / ưu đãi.
+ * @param {string} code Nội dung encode vào QR hoặc barcode.
+ * @param {"qr_code" | "bar_code"} [display="qr_code"] Loại mã hiển thị.
+ * @param {string} merchantName Tên thương hiệu / cửa hàng phát hành voucher.
+ * @param {string} merchantOaId OA ID của merchant trên Zalo.
+ * @param {string} ownerName Tên người nhận voucher.
+ * @param {string} condition Điều kiện sử dụng tóm tắt.
+ * @param {number} expiredAt Thời điểm hết hạn, epoch milliseconds.
+ * @param {number} [remindAt] Thời điểm gửi nhắc hạn, epoch milliseconds.
+ * @param {VoucherAction[]} [actions] Danh sách CTA hiển thị trên thẻ.
+ *
+ * @returns {Promise<void>} Promise resolve khi tạo thẻ thành công và deeplink đã
+ * được mở; reject kèm mã lỗi từ server nếu thất bại.
+ *
+ * @example Thêm voucher vào Ví QR:
+ * ```ts
+ * await addVoucher({
+ *   name: "Giảm 50k cho đơn từ 150k",
+ *   code: "SPFOOD50K",
+ *   merchantName: "Shopee Food",
+ *   merchantOaId: "2712772826697148176",
+ *   ownerName: "Nguyễn Văn A",
+ *   condition: "Áp dụng cho đơn từ 150.000đ.",
+ *   expiredAt: 1751299200000,
+ *   remindAt: 1751212800000,
+ * });
+ * ```
+ */
+declare function addVoucher(args: AsyncCallback<void> & AddVoucherData): Promise<void>;
+
 declare const interactOAArgs$1: ZodObject<{
     oaId: ZodString;
 }, "strip", ZodTypeAny, {
@@ -6154,6 +6286,7 @@ declare const otherApis: {
     openGroupList: typeof openGroupList;
     requestSendNotification: typeof requestSendNotification;
     addRating: typeof addRating;
+    addVoucher: typeof addVoucher;
     interactOA: typeof interactOA;
     interactOa: typeof interactOA;
     isAllowedInteractWithOA: typeof checkIsAllowedInteractWithOA;
@@ -6220,4 +6353,4 @@ declare const otherApis: {
     ZMACameraImp: typeof ZMACameraImp;
 };
 
-export { Action, AndroidBottomNavigationBarType, AppError, AsyncCallback, AsyncCallbackFailObject, AsyncProgressCallback, AsyncVoidCallback, AuthorizeType, CameraEvents, CameraParams, ChatType, CheckStateBioAuthenticationReturns, CheckTransactionReturns, CheckZaloCameraPermissionReturns, CheckoutKit, CheckoutPopupOpenParams, CheckoutPopupResponseData, CheckoutSDK, ChooseImageReturns, Common, ContextInfo, CreateOrderIAPReturns, CreateOrderReturns, Events as EventName, Events, FacingMode, FileInfo, FunctionProps, GetAppInfoReturns, GetAuthCodeReturns, GetBeaconDiscoveryReturns, GetDeviceInfoReturn, GetFileInfoReturns, GetLocationReturns, GetNetworkTypeReturns, GetPhoneNumberReturns, GetSettingReturn, GetStorageReturns, GetUserInfoReturns, GetZPITokenReturns, IAPMethodType, IAPPayType, IAPPayTypeType, IOSSafeAreaBottomType, IsSupportReturns, JumpStatus, KeepScreenReturns, LFSStorage, ListFile, LogData, MediaConstraints, MediaDevice, MediaPickerType, NativeCallBackData, NetworkType, OpenBioAuthenticationReturns, OpenMediaPickerReturns, OpenPostFeedReturns, OpenProfilePickerReturns, OpenProfilePickerType, OpenShareSheetReturns, OpenWebviewReturns, OrientationType, Payment, PhotoConstraint, PhotoFormat, PhotoFrame, PhotoQuality, PickAttr, PickedProfile, PlatformType, PostFeedType, ProfileInfo, ProfileType, ProrationMode, ProrationModeType, RemoveStorageReturns, RequestCameraPermissionReturns, SaveFileReturns, ScanNFCType, ScanQRCodeReturns, SelectPaymentMethodReturns, SetStorageReturns, ShareSheetType, StatusBarType, StorageInfo, StreamType, SystemInfo, TempFile, TextAlignType, UserInfo, VibrateType, ZMACamera, ZMACameraImp, addRating, authorize, checkNFC, checkStateBioAuthentication, checkTransaction, checkZaloCameraPermission, chooseImage, clearStorage, closeApp, closeLoading, configAppView, connectWifi, createCameraContext, createOrder, createOrderIAP, createShortcut, otherApis as default, displayAd, downloadFile, events, favoriteApp, followOA, getAccessToken, getAppInfo, getAuthCode, getBeacons, getContext, getContextAsync, getDeviceId, getDeviceIdAsync, getDeviceInfo, getEntrySource, getIDToken, getLocation, getNetworkType, getPhoneNumber, getRouteParams, getSetting, getShareableLink, getStorage, getStorageInfo, getSystemInfo, getUserID, getUserInfo, getVersion, getZPIToken, hideKeyboard, iBeaconInfo, interactOA, interactOA as interactOa, checkIsAllowedInteractWithOA as isAllowedInteractWithOA, keepScreen, loadAd, login, minimizeApp, nativeStorage, offConfirmToExit, offKeepScreen, onCallbackData, onConfirmToExit, onKeepScreen, onNetworkStatusChange, openBioAuthentication, openChat, openDocument, openGroupList, openMediaPicker, openMiniApp, openOutApp, openPermissionSetting, openPhone, openPostFeed, openProfile, openProfilePicker, openSMS, openShareSheet, openWebview, purchase, refreshAd, removeStorage, requestCameraPermission, requestSendNotification, requestUpdateZalo, saveImageToGallery, saveVideoToGallery, scanNFC, scanQRCode, selectPaymentMethod, sendDataToPreviousMiniApp, setAccessToken, setAndroidBottomNavigationBar, setIOSBottomSafeArea, setNavigationBarColor, setNavigationBarLeftButton, setNavigationBarTitle, setStatusBar, setStorage, setupAd, showCustomOAWidget, showFunctionButtonWidget, showOAWidget, showToast, startBeaconDiscovery, stopBeaconDiscovery, trackingManager, unfollowOA, vibrate, viewOAQr };
+export { Action, AddVoucherData, AddVoucherReturns, AndroidBottomNavigationBarType, AppError, AsyncCallback, AsyncCallbackFailObject, AsyncProgressCallback, AsyncVoidCallback, AuthorizeType, CameraEvents, CameraParams, ChatType, CheckStateBioAuthenticationReturns, CheckTransactionReturns, CheckZaloCameraPermissionReturns, CheckoutKit, CheckoutPopupOpenParams, CheckoutPopupResponseData, CheckoutSDK, ChooseImageReturns, Common, ContextInfo, CreateOrderIAPReturns, CreateOrderReturns, Events as EventName, Events, FacingMode, FileInfo, FunctionProps, GetAppInfoReturns, GetAuthCodeReturns, GetBeaconDiscoveryReturns, GetDeviceInfoReturn, GetFileInfoReturns, GetLocationReturns, GetNetworkTypeReturns, GetPhoneNumberReturns, GetSettingReturn, GetStorageReturns, GetUserInfoReturns, GetZPITokenReturns, IAPMethodType, IAPPayType, IAPPayTypeType, IOSSafeAreaBottomType, IsSupportReturns, JumpStatus, KeepScreenReturns, LFSStorage, ListFile, LogData, MediaConstraints, MediaDevice, MediaPickerType, NativeCallBackData, NetworkType, OpenBioAuthenticationReturns, OpenMediaPickerReturns, OpenPostFeedReturns, OpenProfilePickerReturns, OpenProfilePickerType, OpenShareSheetReturns, OpenWebviewReturns, OrientationType, Payment, PhotoConstraint, PhotoFormat, PhotoFrame, PhotoQuality, PickAttr, PickedProfile, PlatformType, PostFeedType, ProfileInfo, ProfileType, ProrationMode, ProrationModeType, RemoveStorageReturns, RequestCameraPermissionReturns, SaveFileReturns, ScanNFCType, ScanQRCodeReturns, SelectPaymentMethodReturns, SetStorageReturns, ShareSheetType, StatusBarType, StorageInfo, StreamType, SystemInfo, TempFile, TextAlignType, UserInfo, VibrateType, VoucherAction, VoucherActionType, VoucherDisplayType, ZMACamera, ZMACameraImp, addRating, addVoucher, authorize, checkNFC, checkStateBioAuthentication, checkTransaction, checkZaloCameraPermission, chooseImage, clearStorage, closeApp, closeLoading, configAppView, connectWifi, createCameraContext, createOrder, createOrderIAP, createShortcut, otherApis as default, displayAd, downloadFile, events, favoriteApp, followOA, getAccessToken, getAppInfo, getAuthCode, getBeacons, getContext, getContextAsync, getDeviceId, getDeviceIdAsync, getDeviceInfo, getEntrySource, getIDToken, getLocation, getNetworkType, getPhoneNumber, getRouteParams, getSetting, getShareableLink, getStorage, getStorageInfo, getSystemInfo, getUserID, getUserInfo, getVersion, getZPIToken, hideKeyboard, iBeaconInfo, interactOA, interactOA as interactOa, checkIsAllowedInteractWithOA as isAllowedInteractWithOA, keepScreen, loadAd, login, minimizeApp, nativeStorage, offConfirmToExit, offKeepScreen, onCallbackData, onConfirmToExit, onKeepScreen, onNetworkStatusChange, openBioAuthentication, openChat, openDocument, openGroupList, openMediaPicker, openMiniApp, openOutApp, openPermissionSetting, openPhone, openPostFeed, openProfile, openProfilePicker, openSMS, openShareSheet, openWebview, purchase, refreshAd, removeStorage, requestCameraPermission, requestSendNotification, requestUpdateZalo, saveImageToGallery, saveVideoToGallery, scanNFC, scanQRCode, selectPaymentMethod, sendDataToPreviousMiniApp, setAccessToken, setAndroidBottomNavigationBar, setIOSBottomSafeArea, setNavigationBarColor, setNavigationBarLeftButton, setNavigationBarTitle, setStatusBar, setStorage, setupAd, showCustomOAWidget, showFunctionButtonWidget, showOAWidget, showToast, startBeaconDiscovery, stopBeaconDiscovery, trackingManager, unfollowOA, vibrate, viewOAQr };