zmp-sdk 2.44.4-2 → 2.45.0-28

package/index.d.ts

@@ -978,6 +978,13 @@ declare enum Events {
     AppClose = "h5.event.action.close",
     PaymentCallback = "payment.callback",
     PaymentResult = "action.payment.result",
+    /** Người dùng đã hoàn thành quy trình thanh toán ở CheckoutSDK
+     * * Lưu ý: Event sẽ được gửi khi người dùng hoàn tất hoặc hủy quy trình thanh toán.
+     * * Đối tác cần sử dụng API checkTransaction để kiểm tra trạng thái thanh toán mới nhất.
+     *
+     * @link https://mini.zalo.me/documents/checkout-sdk/integration-process/overview/receive-transaction-ma/
+     *  */
+    PaymentDone = "action.payment.done",
     PaymentClose = "action.payment.close",
     DownloadProgress = "h5.event.webview.download.progress"
 }
@@ -1323,7 +1330,24 @@ declare const ACTION: {
     HIDE_KEYBOARD: {};
     OPEN_PHONE: {};
     OPEN_QR: {};
-    OPEN_SMS: {};
+    OPEN_SMS: {
+        errorList: {
+            iOS: {
+                "-9": {
+                    mapTo: {
+                        code: number;
+                        message: string;
+                    };
+                };
+                "-10": {
+                    mapTo: {
+                        code: number;
+                        message: string;
+                    };
+                };
+            };
+        };
+    };
     VIEW_MYQR: {
         haveCallback: boolean;
         timeout: boolean;
@@ -3250,6 +3274,7 @@ declare const createOrderArgs: ZodObject<{
     amount: ZodUnion<[ZodString, ZodNumber]>;
     item: ZodArray<ZodRecord<ZodString, ZodAny>, "many">;
     desc: ZodString;
+    mac: ZodString;
     extradata: ZodOptional<ZodAny>;
     payload: ZodOptional<ZodAny>;
     method: ZodOptional<ZodUnion<[ZodString, ZodObject<{
@@ -3262,7 +3287,6 @@ declare const createOrderArgs: ZodObject<{
         id: string;
         isCustom: boolean;
     }>]>>;
-    mac: ZodOptional<ZodString>;
 }, "strip", ZodTypeAny, {
     method?: string | {
         id: string;
@@ -3270,10 +3294,10 @@ declare const createOrderArgs: ZodObject<{
     } | undefined;
     extradata?: any;
     payload?: any;
-    mac?: string | undefined;
     desc: string;
     amount: string | number;
     item: Record<string, any>[];
+    mac: string;
 }, {
     method?: string | {
         id: string;
@@ -3281,11 +3305,16 @@ declare const createOrderArgs: ZodObject<{
     } | undefined;
     extradata?: any;
     payload?: any;
-    mac?: string | undefined;
     desc: string;
     amount: string | number;
     item: Record<string, any>[];
+    mac: string;
 }>[];
+/**
+ * Tạo yêu cầu thanh toán, mở giao diện chọn phương thức thanh toán
+ * @link https://mini.zalo.me/documents/checkout-sdk/createOrder/
+ * @param args
+ */
 declare function createOrder(args: AsyncCallback<CreateOrderReturns> & TypeOf<(typeof createOrderArgs)[0]>): Promise<CreateOrderReturns>;
 
 declare const purchaseArgs: ZodObject<{
@@ -3307,6 +3336,11 @@ declare const purchaseArgs: ZodObject<{
     desc: string;
     amount: string | number;
 }>[];
+/**
+ *  Gửi thông tin thanh toán đến CheckoutSDK
+ * @link https://mini.zalo.me/documents/checkout-sdk/purchase/
+ * @param args
+ */
 declare function purchase(args: AsyncCallback<CreateOrderReturns> & TypeOf<(typeof purchaseArgs)[0]>): Promise<CreateOrderReturns>;
 
 declare const selectPaymentMethodArgs: ZodOptional<ZodObject<{
@@ -3357,12 +3391,30 @@ declare const selectPaymentMethodArgs: ZodOptional<ZodObject<{
 declare function selectPaymentMethod(args: AsyncCallback<SelectPaymentMethodReturns> & TypeOf<(typeof selectPaymentMethodArgs)[0]>): Promise<SelectPaymentMethodReturns>;
 
 declare const checkTransactionArgs: ZodObject<{
-    data: ZodUnion<[ZodString, ZodRecord<ZodString, ZodString>]>;
+    data: ZodUnion<[ZodString, ZodRecord<ZodString, ZodOptional<ZodNullable<ZodString>>>]>;
 }, "strip", ZodTypeAny, {
-    data: string | Record<string, string>;
+    data: string | Record<string, string | null | undefined>;
 }, {
-    data: string | Record<string, string>;
+    data: string | Record<string, string | null | undefined>;
 }>[];
+/**
+ * Kiểm tra trạng thái giao dịch
+ * @link https://mini.zalo.me/documents/checkout-sdk/checkTransaction/
+ * @param args
+ * @example
+ * ```ts
+ * import { CheckoutSDK } from "zmp-sdk/apis";
+ * // Kiểm tra bằng `orderId` tạo bởi Checkout SDK
+ * const result = await CheckoutSDK.checkTransaction({
+ *   data: { orderId: "123456"}
+ * });
+ *
+ * // Kiểm tra bằng `transId` tạo bởi đối tác thanh toán
+ * const result = await CheckoutSDK.checkTransaction({
+ *  data: { transId: "123456"}
+ * });
+ *
+ */
 declare function checkTransaction(args: AsyncCallback<CheckTransactionReturns> & TypeOf<(typeof checkTransactionArgs)[0]>): Promise<CheckTransactionReturns>;
 
 declare const createOrderIAPArgs: ZodObject<{
@@ -3707,15 +3759,20 @@ declare const showOAWidgetArgs: ZodObject<{
     guidingText: ZodOptional<ZodString>;
     color: ZodOptional<ZodString>;
     onStatusChange: ZodOptional<ZodFunction<ZodTuple<[], ZodUnknown>, ZodUnknown>>;
-}, "strip", ZodTypeAny, {
+    onError: ZodOptional<ZodFunction<ZodTuple<[], ZodUnknown>, ZodUnknown>>;
+}, "strip", ZodAny, {
+    [x: string]: any;
     color?: string | undefined;
     guidingText?: string | undefined;
     onStatusChange?: ((...args: unknown[]) => unknown) | undefined;
+    onError?: ((...args: unknown[]) => unknown) | undefined;
     id: string;
 }, {
+    [x: string]: any;
     color?: string | undefined;
     guidingText?: string | undefined;
     onStatusChange?: ((...args: unknown[]) => unknown) | undefined;
+    onError?: ((...args: unknown[]) => unknown) | undefined;
     id: string;
 }>[];
 declare function showOAWidget(args: AsyncVoidCallback & TypeOf<(typeof showOAWidgetArgs)[0]>): Promise<void>;
@@ -3731,18 +3788,18 @@ declare const showFunctionButtonWidgetArgs: ZodObject<{
 }, "strip", ZodAny, {
     [x: string]: any;
     color?: string | undefined;
+    onError?: ((...args: unknown[]) => unknown) | undefined;
     disabled?: boolean | undefined;
     onDataReceived?: ((...args: unknown[]) => unknown) | undefined;
-    onError?: ((...args: unknown[]) => unknown) | undefined;
     text: string;
     type: string;
     id: string;
 }, {
     [x: string]: any;
     color?: string | undefined;
+    onError?: ((...args: unknown[]) => unknown) | undefined;
     disabled?: boolean | undefined;
     onDataReceived?: ((...args: unknown[]) => unknown) | undefined;
-    onError?: ((...args: unknown[]) => unknown) | undefined;
     text: string;
     type: string;
     id: string;
@@ -3782,6 +3839,7 @@ declare const nativeStorage: {
 };
 
 declare const Payment: {
+    purchase: typeof purchase;
     createOrder: typeof createOrder;
     checkTransaction: typeof checkTransaction;
     createOrderIAP: typeof createOrderIAP;
@@ -3789,6 +3847,9 @@ declare const Payment: {
 };
 declare const CheckoutSDK: {
     purchase: typeof purchase;
+    createOrder: typeof createOrder;
+    checkTransaction: typeof checkTransaction;
+    createOrderIAP: typeof createOrderIAP;
     selectPaymentMethod: typeof selectPaymentMethod;
 };
 
@@ -3911,6 +3972,7 @@ declare const otherApis: {
         getStorageInfo: typeof getStorageInfoSync;
     };
     Payment: {
+        purchase: typeof purchase;
         createOrder: typeof createOrder;
         checkTransaction: typeof checkTransaction;
         createOrderIAP: typeof createOrderIAP;
@@ -3918,6 +3980,9 @@ declare const otherApis: {
     };
     CheckoutSDK: {
         purchase: typeof purchase;
+        createOrder: typeof createOrder;
+        checkTransaction: typeof checkTransaction;
+        createOrderIAP: typeof createOrderIAP;
         selectPaymentMethod: typeof selectPaymentMethod;
     };
     downloadFile: typeof downloadFile;