zmp-sdk 2.46.0-beta.1 → 2.46.0-beta.2

package/index.d.ts

@@ -2036,7 +2036,15 @@ type GetStorageReturns = {
     [key: string]: any;
 };
 type StorageInfo = {
+    /**
+     * Không gian hiện tại bị chiếm (tính bằng KB)
+     * @minimumVersion 2.43.0
+     */
     currentSize: number;
+    /**
+     * Giới hạn kích thước không gian (tính bằng KB)
+     * @minimumVersion 2.43.0
+     */
     limitSize: number;
 };
 type RemoveStorageReturns = {
@@ -2289,11 +2297,11 @@ type ChooseImageReturns = {
     /**
      * Đường dẫn các file đã chọn.
      */
-    filePaths: Array<string>;
+    filePaths: string[];
     /**
      * Thông tin các temp files.
      */
-    tempFiles: Array<TempFile>;
+    tempFiles: TempFile[];
 };
 type CreateOrderReturns = {
     orderId: string;
@@ -2330,13 +2338,13 @@ type GetSettingReturn = {
     /**
      * Thông tin cấp quyền, tham khảo bảng Scopes.
      *
-     * | Scope                 | Corresponding APIs                                               | Description                     |
-     * |-----------------------|------------------------------------------------------------------|---------------------------------|
-     * | scope.userInfo        | [getUserInfo](../user-information/getUserInfo.md)                | Thông tin user (tên, avatar...) |
-     * | scope.userLocation    | [getLocation](../../location/getLocation.md)                     | Thông tin vị trí user           |
-     * | scope.userPhonenumber | [getPhoneNumber](../user-information/getPhoneNumber.md)          | Số điện thoại                   |
-     * | scope.camera          | [createCameraContext](../../media/camera/createCameraContext.md) | Camera                          |
-     * | scope.micro           | [createCameraContext](../../media/camera/createCameraContext.md) | Micro                           |
+     * | Scope                 | Corresponding APIs    | Description                     |
+     * | --------------------- | --------------------- | ------------------------------- |
+     * | scope.userInfo        | `getUserInfo`         | Thông tin user (tên, avatar...) |
+     * | scope.userLocation    | `getLocation`         | Thông tin vị trí user           |
+     * | scope.userPhonenumber | `getPhoneNumber`      | Số điện thoại                   |
+     * | scope.camera          | `createCameraContext` | Camera                          |
+     * | scope.micro           | `createCameraContext` | Micro                           |
      *
      * Với các scope có giá trị trả về là `true`, tương ứng với việc người dùng đã cấp quyền sử dụng API trước đó, Mini Apps có thể truy xuất thông tin một cách trực tiếp.
      */
@@ -2399,7 +2407,7 @@ type PhotoConstraint = {
     minScreenshotHeight?: number;
 };
 
-/***
+/**
  * Lấy thông tin của cache theo cơ chế đồng bộ.
  *
  * @minimumVersion 2.43.0
@@ -2421,7 +2429,7 @@ declare const removeItemArgs: ZodString[];
  * @minimumVersion 2.43.0
  * @behavior Ở môi trường phát triển, nhóm API Native Storage sẽ fallback về Local Storage để lưu trữ dữ liệu. Khi chạy bên trong ứng dụng Zalo mobile, Native Storage lưu trữ dữ liệu trong bộ nhớ của ứng dụng Zalo.
  *
- * @param {string} key Tên khóa của dữ liệu cần lấy
+ * @param {string} key Tên khóa của dữ liệu cần xoá
  *
  * @example Xoá từ khoá tìm kiếm cũ khỏi bộ nhớ:
  * ```ts
@@ -2631,8 +2639,7 @@ declare function login(args?: AsyncCallback<string>): Promise<string>;
  * @important Cập nhật
  * Từ phiên bản SDK 2.35.0, ứng dụng mặc định có quyền truy xuất access tokens mà không cần người dùng xác nhận đồng ý. Thông qua access tokens này, ứng dụng chỉ có thể xuất ID người sử dụng. Nếu ứng dụng có nhu cầu sử dụng Tên và Ảnh đại diện, vui lòng sử dụng API authorize để yêu cầu người dùng cho phép truy cập scope.userInfo trước khi sử dụng API này. Lưu ý: Với các Zalo App có nhiều hơn 1 Mini App, hệ thống vẫn yêu cầu người dùng xác nhận khi truy xuất access tokens cho từng Mini App.
  *
- * @param args
- * @returns {string} `accessToken`
+ * @returns {string} `accessToken`.
  * @example
  * ```ts
  * const accessToken = await getAccessToken();
@@ -2644,6 +2651,7 @@ declare function getVersion(): string;
 
 /**
  * API truy xuất thông tin hệ thống, thiết bị đang sử dụng.
+ * @minimumVersion 2.4.0
  * @returns {SystemInfo} các thông tin về phiên bản, ngôn ngữ, theme của hệ thống.
  * @example Lấy các thông tin phiên bản:
  * ```ts
@@ -2845,7 +2853,7 @@ declare function getUserInfo(args?: AsyncCallback<GetUserInfoReturns> & TypeOf<(
 /**
  * API truy xuất kiểu kết nối mạng hiện tại.
  *
- * @returns {GetNetworkTypeReturns} chứa kiểu kết nối mạng hiện tại.
+ * @returns {GetNetworkTypeReturns} kiểu kết nối mạng hiện tại.
  *
  * @example Lấy kiểu kết nối mạng hiện tại:
  * ```ts
@@ -3023,11 +3031,11 @@ declare const openProfileArgs: ZodOptional<ZodObject<{
  * @minimumVersion 2.5.3
  * @zaloOnly Chỉ hoạt động khi chạy bên trong ứng dụng Zalo mobile.
  *
- * @param {string} type - Nhận các giá trị sau:
+ * @param {"user" | "oa" | "aliasOA"} type Nhận các giá trị sau:
  * - `user`: Mở profile User.
  * - `oa`: Mở profile OA.
  * - `aliasOA`: Mở profile OA bằng Alias (field id truyền lên là alias của OA).
- * @param {string} id - Id của User hoặc OA.
+ * @param {string} id Id của User hoặc OA.
  *
  * @example Mở cửa sổ chat với người dùng:
  * ```ts
@@ -3188,13 +3196,13 @@ declare const openPostFeedArgs: ZodUnion<[ZodObject<{
  * @minimumVersion 2.5.3
  * @zaloOnly Chỉ hoạt động khi chạy bên trong ứng dụng Zalo mobile.
  *
- * @param {string} type - Nhận các giá trị sau:
+ * @param {"image" | "link" | "profile"} type Nhận các giá trị sau:
  * - `image`: Chia sẻ hình ảnh.
  * - `link`: Chia sẻ liên kết.
  * - `profile`: Chia sẻ profile OA.
- * @param {Object} data - Nội dung cần chia sẻ, tùy thuộc vào `type`.
+ * @param {Object} data Nội dung cần chia sẻ, tùy thuộc vào `type`.
  *
- * @returns {OpenPostFeedReturns} chứa thông tin kết quả chia sẻ.
+ * @returns {OpenPostFeedReturns} thông tin kết quả chia sẻ.
  *
  * @example Chia sẻ hình ảnh:
  * ```ts
@@ -3247,7 +3255,7 @@ declare const followOAArgs: ZodOptional<ZodObject<{
  * @minimumVersion 2.5.3
  * @zaloOnly Chỉ hoạt động khi chạy bên trong ứng dụng Zalo mobile.
  *
- * @param {string} id - Id của Official Account cần theo dõi.
+ * @param {string} id Id của Official Account cần theo dõi.
  *
  * @example Theo dõi Official Account:
  * ```ts
@@ -3504,17 +3512,29 @@ declare const openShareSheetArgs: ZodUnion<[ZodObject<{
  * @minimumVersion 2.5.3
  * @zaloOnly Chỉ hoạt động khi chạy bên trong ứng dụng Zalo mobile.
  *
- * @param {"image" | "link" | "oa" | "gif" | "video" | "zmp" | "zmp_deep_link"} type Nhận các giá trị sau:
- *   `image`: Chia sẻ hình ảnh.
- *   `link`: Chia sẻ liên kết.
- *   `oa`: Chia sẻ Official Account.
- *   `gif`: Chia sẻ ảnh động.
- *   `video`: Chia sẻ video.
- *   `zmp`: Chia sẻ page hiện tại của Zalo Mini App.
- *   `zmp_deep_link`: Chia sẻ page hiện tại của Zalo Mini App thông qua deep link (hỗ trợ từ API 2.25.7).
+ * @param {"text" | "image" | "link" | "oa" | "gif" | "video" | "zmp" | "zmp_deep_link"} type Nhận các giá trị sau:
+ * - `text`: Chia sẻ văn bản.
+ * - `image`: Chia sẻ hình ảnh.
+ * - `link`: Chia sẻ liên kết.
+ * - `oa`: Chia sẻ Official Account.
+ * - `gif`: Chia sẻ ảnh động.
+ * - `video`: Chia sẻ video.
+ * - `zmp`: Chia sẻ page hiện tại của Zalo Mini App.
+ * - `zmp_deep_link`: Chia sẻ page hiện tại của Zalo Mini App thông qua deep link (hỗ trợ từ API 2.25.7).
  * @param {object} data Nội dung cần chia sẻ, tùy thuộc vào `type`.
  *
- * @returns {OpenShareSheetReturns} Promise chứa thông tin kết quả chia sẻ.
+ * @returns {OpenShareSheetReturns} thông tin kết quả chia sẻ.
+ *
+ * @example Chia sẻ văn bản:
+ * ```ts
+ * const data = await openShareSheet({
+ *   type: "text",
+ *   data: {
+ *     text: "My Zalo Mini App - HomePage",
+ *   },
+ * });
+ * console.log(data);
+ * ```
  *
  * @example Chia sẻ hình ảnh:
  * ```ts
@@ -3625,7 +3645,7 @@ declare const createShortcutArgs: ZodOptional<ZodObject<{
  * @minimumVersion 2.16.3: hỗ trợ thêm params vào shortcut.
  * @zaloOnly Chỉ hoạt động khi chạy bên trong ứng dụng Zalo mobile.
  *
- * @param {Record<string, string>} [params] - Params cần thêm vào Zalo Mini App khi mở..
+ * @param {Record<string, string>} [params] Params cần thêm vào Zalo Mini App khi mở..
  *
  * @example Tạo shortcut đơn giản:
  * ```ts
@@ -3690,6 +3710,8 @@ declare const showToastArgs: ZodOptional<ZodObject<{
 /**
  * API hiển thị một thông báo ngắn trên màn hình.
  *
+ * @minimumVersion 2.5.3
+ *
  * @param {string} message Nội dung thông báo cần hiển thị.
  *
  * @example Hiện thông báo đặt hàng thành công:
@@ -3727,7 +3749,7 @@ declare const openPhoneArgs: ZodObject<{
  * @minimumVersion 2.5.3
  * @zaloOnly Chỉ hoạt động khi chạy bên trong ứng dụng Zalo mobile.
  *
- * @param {string} phoneNumber - Số điện thoại cần gọi.
+ * @param {string} phoneNumber Số điện thoại cần gọi.
  *
  * @example Mở màn hình cuộc gọi với số điện thoại cụ thể:
  * ```ts
@@ -4018,7 +4040,7 @@ declare const vibrateArgs: ZodObject<{
  *
  * @example Rung thiết bị trong 1 giây:
  * ```ts
- * vibrate({
+ * await vibrate({
  *   type: "oneShot",
  *   milliseconds: 1000
  * })
@@ -4195,7 +4217,7 @@ declare function sendDataToPreviousMiniApp(args: AsyncVoidCallback & TypeOf<(typ
  * @requirePermission Cần xin Cấp quyền sử dụng các API này cho Mini App ID tại trang Quản lý ứng dụng. Nếu không, sẽ bị [lỗi với người dùng bình thường, mặc dù Developer/Admin thì không bị](https://mini.zalo.me/community/8746968970844796879/loi-chi-xay-ra-voi-nguoi-dung-binh-thuong-con-developer-admin-thi-khong-bi).
  * @zaloOnly Chỉ hoạt động khi chạy bên trong ứng dụng Zalo mobile.
  *
- * @returns {GetPhoneNumberReturns} chứa token để truy xuất thông tin số điện thoại.
+ * @returns {GetPhoneNumberReturns} token để truy xuất thông tin số điện thoại.
  *
  * @example
  * 1. Ở Zalo Mini App, gọi API này để lấy token số điện thoại:
@@ -4220,11 +4242,11 @@ declare const openProfilePickerArgs: ZodObject<{
  * @minimumVersion 2.16.1
  * @zaloOnly Chỉ hoạt động khi chạy bên trong ứng dụng Zalo mobile.
  *
- * @param {number} [maxProfile=1] - Số lượng bạn bè tối đa được chọn. Giới hạn trong khoảng 1 đến 10.
+ * @param {number} [maxProfile=1] Số lượng bạn bè tối đa được chọn. Giới hạn trong khoảng 1 đến 10.
  *
- * @returns {OpenProfilePickerReturns} chứa danh sách những bạn bè được chọn.
+ * @returns {OpenProfilePickerReturns} danh sách những bạn bè được chọn.
  *
- * @example Mở cửa sổ chọn bạn bè và lấy danh sách người dùng được chọn:
+ * @example Chọn tối đa 2 bạn bè trong danh sách bạn bè của người dùng:
  * ```ts
  * const { users } = await openProfilePicker({
  *   maxProfile: 2,
@@ -4297,7 +4319,7 @@ declare const openMediaPickerArgs: ZodObject<{
  * @zaloOnly Chỉ hoạt động khi chạy bên trong ứng dụng Zalo mobile.
  *
  * @param {string} serverUploadUrl Đường dẫn upload media. Server phải hỗ trợ upload media qua POST và trả về kết quả dạng JSON. Xem ví dụ về server tại [đây](https://mini.zalo.me/documents/api/openMediaPicker/#server).
- * @param {"photo" | "file" | "video" | "zcamera" | "zcamera_photo" | "zcamera_video" | "zcamera_scan"} typeLoại media cần chọn. Các giá trị:
+ * @param {"photo" | "file" | "video" | "zcamera" | "zcamera_photo" | "zcamera_video" | "zcamera_scan"} type Loại media cần chọn. Các giá trị:
  * - 'photo': Mở cửa sổ chọn ảnh.
  * - 'file': Mở cửa sổ chọn file.
  * - 'video': Mở cửa sổ chọn video.
@@ -4315,7 +4337,7 @@ declare const openMediaPickerArgs: ZodObject<{
  * @param {boolean} [editView.enable=true] Hiển thị view chỉnh sửa ảnh.
  * @param {string} [editView.aspectRatio="1:1"] Cắt ảnh theo tỉ lệ đã chỉ định. Tỉ lệ truyền vào theo format `width:height` (phân số tối giản quy định tỉ lệ width/height).
  *
- * @returns {OpenMediaPickerReturns} chứa kết quả trả về.
+ * @returns {OpenMediaPickerReturns} kết quả trả về.
  *
  * @example Mở cửa sổ chọn ảnh nhận kết quả trả về dạng JSON:
  * ```ts
@@ -4416,6 +4438,7 @@ declare function getDeviceId(): string;
 
 /**
  * API trả về chuỗi Device ID của thiết bị đã được hash. Các tài khoản người dùng khác nhau đăng nhập trên cùng 1 thiết bị và sử dụng cùng 1 Mini App (hoặc các Mini App có chung Zalo App ID) sẽ có giá trị Device ID giống nhau. Nếu không lấy được Device ID thì giá trị trả về là `unknown`.
+ * @minimumVersion 2.20.0
  * @returns {string} chuỗi Device ID của thiết bị đã được hash.
  * @example Sử dụng kết hợp với `await`:
  * ```ts
@@ -4430,6 +4453,8 @@ declare function getContext(): ContextInfo | null;
  * API trả về thông tin ngữ cảnh của người dùng hoặc nhóm khi Mini App được mở từ Menu mở rộng trong cửa sổ chat Zalo.
  * Nếu ngữ cảnh không hợp lệ hoặc phiên bản Zalo không hỗ trợ, giá trị trả về sẽ rỗng.
  *
+ * @minimumVersion Zalo Android: 22.06.02
+ * @minimumVersion ZMP SDK: 2.22.0
  * @returns {ContextInfo} ngữ cảnh hiện tại.
  * @example Kiểm tra ngữ cảnh hợp lệ và trả về thông tin ngữ cảnh:
  * ```ts
@@ -4476,9 +4501,9 @@ declare const chooseImageArgs: ZodObject<{
  * @minimumVersion 2.23.4
  *
  * @param {("album" | "camera")[]} [sourceType] Nguồn chọn hình ảnh. Có thể chọn từ album/tệp (`album`), chụp ảnh mới từ camera (`camera`), hoặc cả hai.
- * @param {("back" | "front")} [cameraType] Xác định camera cần mở là camera trước hay sau.
+ * @param {"back" | "front"} [cameraType] Xác định camera cần mở là camera trước hay sau.
  * @param {number} [count] Số lượng hình ảnh tối đa có thể chọn.
- * @returns {ChooseImageReturns} chứa đường dẫn tới hình ảnh đã chọn.
+ * @returns {ChooseImageReturns} đường dẫn tới hình ảnh đã chọn.
  * @example Chụp hình ảnh từ camera trước:
  * ```ts
  * const { filePaths } = await chooseImage({
@@ -4514,7 +4539,7 @@ declare function chooseImage(args: AsyncCallback<ChooseImageReturns> & TypeOf<(t
  * @zaloOnly Chỉ hoạt động khi chạy bên trong ứng dụng Zalo mobile.
  * @behavior Ở môi trường phát triển, API này sẽ luôn thành công và trả về token rỗng (`""`). Khi chạy bên trong ứng dụng Zalo mobile, API này sẽ hiển thị thông báo xin cấp quyền, và trả về token hợp lệ nếu người dùng đồng ý hoặc lỗi nếu người dùng từ chối.
  *
- * @returns {GetLocationReturns} chứa token vị trí.
+ * @returns {GetLocationReturns} token vị trí.
  * @example
  * 1. Ở Zalo Mini App, gọi API này để lấy token vị trí:
  * ```ts
@@ -4836,7 +4861,6 @@ declare function configAppView(args: AsyncVoidCallback & TypeOf<(typeof configAp
  * ![Thu nhỏ ứng dụng](https://mini.zalo.me/documents/img/ZMA-Floating.png)
  *
  * @minimumVersion 2.26.1
- * @requirePermission Cần xin Cấp quyền sử dụng các API này cho Mini App ID tại trang Quản lý ứng dụng. Nếu không, sẽ bị [lỗi với người dùng bình thường, mặc dù Developer/Admin thì không bị](https://mini.zalo.me/community/8746968970844796879/loi-chi-xay-ra-voi-nguoi-dung-binh-thuong-con-developer-admin-thi-khong-bi).
  * @zaloOnly Chỉ hoạt động khi chạy bên trong ứng dụng Zalo mobile.
  *
  * @example Thu nhỏ ứng dụng:
@@ -4852,8 +4876,6 @@ declare function minimizeApp(args?: AsyncVoidCallback): Promise<void>;
  * @minimumVersion 2.27.1
  * @zaloOnly Chỉ hoạt động khi chạy bên trong ứng dụng Zalo mobile.
  *
- * @returns {Promise<void>} Promise không trả về giá trị.
- *
  * @example Mở cửa sổ cài đặt quyền:
  * ```ts
  * await openPermissionSetting();
@@ -4917,7 +4939,7 @@ declare const interactOAArgs$1: ZodObject<{
  * @minimumVersion 2.28.8
  * @zaloOnly Chỉ hoạt động khi chạy bên trong ứng dụng Zalo mobile.
  *
- * @param {string} oaId - Id của Official Account.
+ * @param {string} oaId Id của Official Account.
  *
  * @example Yêu cầu người dùng cho phép gửi thông báo thông qua Official Account:
  * ```ts
@@ -4960,7 +4982,7 @@ declare function checkIsAllowedInteractWithOA(args: AsyncVoidCallback & TypeOf<(
  * @minimumVersion 2.31.0
  * @zaloOnly Chỉ hoạt động khi chạy bên trong ứng dụng Zalo mobile.
  *
- * @returns {GetSettingReturn} chứa thông tin cài đặt hiện tại của người dùng.
+ * @returns {GetSettingReturn} thông tin cài đặt hiện tại của người dùng.
  *
  * @example Lấy thông tin cài đặt hiện tại của người dùng:
  * ```ts
@@ -4977,11 +4999,6 @@ declare const authorizeArgs: ZodOptional<ZodObject<{
     scopes?: ("scope.userInfo" | "scope.userLocation" | "scope.userPhonenumber")[] | undefined;
 }>>[];
 /**
- * @minimumVersion Zalo iOS: 23.12.02 (573)
- * @minimumVersion Zalo Android: 23.12.02 (724)
- * @minimumVersion ZMP SDK: 2.34.0
- * @zaloOnly Chỉ hoạt động khi chạy bên trong ứng dụng Zalo mobile.
- *
  * ### Cấp quyền sử dụng API
  *
  * Một số API cần sự cho phép của người dùng trước khi có thể được gọi. Các API này được chia thành nhiều phạm vi (Scope) tương ứng với từng mục đích sử dụng, mô tả chi tiết tham khảo bảng Scopes:
@@ -5015,9 +5032,13 @@ declare const authorizeArgs: ZodOptional<ZodObject<{
  * - Chỉ khởi tạo yêu cầu cấp quyền khi cần thiết, giải thích rõ ràng lý do tại sao bạn muốn sử dụng nó trong yêu cầu cấp quyền.
  * - Sử dụng API `getSetting` trước để lấy trạng thái cho phép hiện tại của người dùng, sau đó yêu cầu xin cấp thêm các quyền còn thiếu.
  *
- * @param {string[]} scopes Danh sách các quyền cần được cấp, tham khảo bảng Scopes.
+ * @minimumVersion Zalo iOS: 23.12.02 (573)
+ * @minimumVersion Zalo Android: 23.12.02 (724)
+ * @minimumVersion ZMP SDK: 2.34.0
+ * @zaloOnly Chỉ hoạt động khi chạy bên trong ứng dụng Zalo mobile.
  *
- * @returns {Promise<Scopes>} chứa các trạng thái của các quyền được cấp.
+ * @param {string[]} scopes Danh sách các quyền cần được cấp, tham khảo bảng Scopes.
+ * @returns {Scopes} các trạng thái của các quyền được cấp.
  * @property {boolean} scope.userInfo Trạng thái quyền thông tin user.
  * @property {boolean} scope.userLocation Trạng thái quyền vị trí user.
  * @property {boolean} scope.userPhonenumber Trạng thái quyền số điện thoại.
@@ -5050,7 +5071,7 @@ declare function checkZaloCameraPermission(args?: AsyncCallback<CheckZaloCameraP
  * @minimumVersion 2.32.2
  * @zaloOnly Chỉ hoạt động khi chạy bên trong ứng dụng Zalo mobile.
  *
- * @returns {string} chứa ID người dùng.
+ * @returns {string} ID người dùng.
  *
  * @example Truy xuất ID người dùng:
  * ```ts
@@ -5253,12 +5274,13 @@ declare const loadAdArgs: ZodObject<{
 /**
  * API dùng để tải quảng cáo. Có các loại quảng cáo sau đây:
  *
- * ID              Size
- * ZMA_Masthead    480x270
- * ZMA_Middle      300x250
- * ZMA_Fullscreen  Toàn màn hình
- * ZMA_Reward      Toàn màn hình
- * ZMA_Bottom      Tùy chỉnh
+ * | ID             | Size          |
+ * | -------------- | ------------- |
+ * | ZMA_Masthead   | 480x270       |
+ * | ZMA_Middle     | 300x250       |
+ * | ZMA_Fullscreen | Toàn màn hình |
+ * | ZMA_Reward     | Toàn màn hình |
+ * | ZMA_Bottom     | Tùy chỉnh     |
  *
  * Mặc định quảng cáo sẽ được hiển thị sau khi tải xong. Vị trí hiển thị quảng cáo sẽ được xác định theo ID của từng loại.
  *
@@ -5391,8 +5413,7 @@ declare const showOAWidgetArgs: ZodObject<{
  * @param {string} id ID của element, nơi cần hiển thị widget.
  * @param {string} [guidingText="Nhận thông báo khuyến mãi mới nhất từ cửa hàng"] Chuỗi dùng để thông báo cho người dùng.
  * @param {string} [color="#0068FF"] Màu chủ đạo của widget. Giá trị phải là chuỗi hex.
- * @param {function} [onStatusChange] Trả về trạng thái khi nhấn theo dõi OA.
- * @param {function} [onError] Trả về lỗi khi thao tác widget.
+ * @param {(status: boolean) => void} [onStatusChange] Callback được gọi khi người dùng nhấn theo dõi OA. Trạng thái theo dõi mới được truyền vào tham số của callback.
  *
  * @example Hiển thị Widget Quan tâm OA:
  * ```ts
@@ -5478,8 +5499,8 @@ declare const showFunctionButtonWidgetArgs: ZodObject<{
  * @param {string} [color="#0068FF"] Màu chủ đạo của widget. Giá trị phải là chuỗi hex.
  * @param {string} [textColor="#FFFFFF"] Màu chữ trong button. Giá trị phải là chuỗi hex.
  * @param {string} [borderRadius="48px"] Bo góc (bo tròn các góc của button).
- * @param {function} [onDataReceived] Trả về `messageToken` khi click widget.
- * @param {function} [onError] Trả về `error` khi click widget.
+ * @param {(messageToken: string) => void} [onDataReceived] Callback được gọi khi người dùng nhấn vào widget. Callback này chứa `messageToken` là một token được dùng để gửi tin nhắn tới người dùng. Có giá trị trong 7 ngày.
+ * @param {(error: string) => void} [onError] Callback được gọi khi có lỗi xảy ra khi người dùng nhấn vào widget. Callback này chứa `error` là thông tin về lỗi.
  *
  * @example Hiển thị Widget Function Button:
  * ```ts
@@ -5585,8 +5606,8 @@ declare const downloadFileArgs: ZodOptional<ZodObject<{
  * @requirePermission Cần xin Cấp quyền sử dụng các API này cho Mini App ID tại trang Quản lý ứng dụng. Nếu không, sẽ bị [lỗi với người dùng bình thường, mặc dù Developer/Admin thì không bị](https://mini.zalo.me/community/8746968970844796879/loi-chi-xay-ra-voi-nguoi-dung-binh-thuong-con-developer-admin-thi-khong-bi).
  * @zaloOnly Chỉ hoạt động khi chạy bên trong ứng dụng Zalo mobile.
  *
- * @param {string} url - Đường dẫn của file muốn download.
- * @param {(progress: number) => void} [onProgress] - Callback function tiến độ tải file. Với `progress` là số từ 0 đến 100%.
+ * @param {string} url Đường dẫn của file muốn download.
+ * @param {(progress: number) => void} [onProgress] Callback function tiến độ tải file. Với `progress` là số từ 0 đến 100%.
  *
  * @example Thông báo một lần sau khi tải file xong:
  * ```ts
@@ -5625,6 +5646,100 @@ declare const trackingManager: {
     logEvent: typeof logEvent;
 };
 
+declare const showCustomOAWidgetArgs: ZodObject<{
+    id: ZodString;
+    textColor: ZodOptional<ZodString>;
+    fontSize: ZodOptional<ZodString>;
+    buttonHeight: ZodOptional<ZodString>;
+    buttonColor: ZodOptional<ZodString>;
+    buttonTextColor: ZodOptional<ZodString>;
+    buttonRadius: ZodOptional<ZodString>;
+    buttonText: ZodOptional<ZodString>;
+    checkboxBGColor: ZodOptional<ZodString>;
+    checkboxCheckmarkColor: ZodOptional<ZodString>;
+    onClick: ZodOptional<ZodFunction<ZodTuple<[], ZodUnknown>, ZodUnknown>>;
+    onStatusChange: ZodOptional<ZodFunction<ZodTuple<[], ZodUnknown>, ZodUnknown>>;
+    onError: ZodOptional<ZodFunction<ZodTuple<[], ZodUnknown>, ZodUnknown>>;
+}, "strip", ZodAny, {
+    [x: string]: any;
+    textColor?: string | undefined;
+    onStatusChange?: ((...args: unknown[]) => unknown) | undefined;
+    onError?: ((...args: unknown[]) => unknown) | undefined;
+    fontSize?: string | undefined;
+    buttonHeight?: string | undefined;
+    buttonColor?: string | undefined;
+    buttonTextColor?: string | undefined;
+    buttonRadius?: string | undefined;
+    buttonText?: string | undefined;
+    checkboxBGColor?: string | undefined;
+    checkboxCheckmarkColor?: string | undefined;
+    onClick?: ((...args: unknown[]) => unknown) | undefined;
+    id: string;
+}, {
+    [x: string]: any;
+    textColor?: string | undefined;
+    onStatusChange?: ((...args: unknown[]) => unknown) | undefined;
+    onError?: ((...args: unknown[]) => unknown) | undefined;
+    fontSize?: string | undefined;
+    buttonHeight?: string | undefined;
+    buttonColor?: string | undefined;
+    buttonTextColor?: string | undefined;
+    buttonRadius?: string | undefined;
+    buttonText?: string | undefined;
+    checkboxBGColor?: string | undefined;
+    checkboxCheckmarkColor?: string | undefined;
+    onClick?: ((...args: unknown[]) => unknown) | undefined;
+    id: string;
+}>[];
+/**
+ * Nhằm tối ưu hiệu quả tăng follower của OA cho nhóm đối tác nội bộ, đồng thời đảm bảo trải nghiệm của User, không cảm thấy confuse, spam, Platform đã hỗ trợ cho nhóm đối tác nội bộ tool Widget "Quan tâm OA custom".
+ * Đối tác có thể chỉnh sửa và gắn widget vào Mini App.
+ *
+ * @minimumVersion 2.46.0
+ * @zaloOnly Chỉ hoạt động khi chạy bên trong ứng dụng Zalo mobile.
+ *
+ * @param {string} id - ID của element, nơi cần hiển thị widget.
+ * @param {string} [textColor='#6F7071'] - Màu chữ của checkbox ("Đồng ý theo dõi OA").
+ * @param {string} [fontSize='12px'] - Kích thước chữ cho checkbox
+ * @param {string} [buttonHeight='48px'] - Chiều cao của nút CTA.
+ * @param {string} [buttonColor='#0068FF'] - Màu nền của nút CTA.
+ * @param {string} [buttonTextColor='#FFFFFF'] - Màu chữ của nút CTA.
+ * @param {string} [buttonRadius='9999px'] - Border radius của nút CTA.
+ * @param {string} [buttonText='Đồng ý'] - Nội dung hiển thị trên nút CTA.
+ * @param {string} [checkboxBGColor='#0068FF'] - Màu nền của ô checkbox.
+ * @param {string} [checkboxCheckmarkColor='#FFFFFF'] - Màu của dấu check (checkmark) trong checkbox.
+ * @param {(status: boolean) => void} [onClick] - Callback được gọi khi người dùng nhấn nút CTA. Trả về `true` nếu checkbox được tick, ngược lại `false`.
+ * @param {(error: string) => void} [onError] - Callback được gọi khi có lỗi xảy ra trong quá trình tương tác với widget.
+ *
+ * @example Hiển thị Widget Quan tâm OA Custom:
+ * ```ts
+ * import React, { useEffect } from "react";
+ * import { showCustomOAWidget } from "zmp-sdk/apis";
+ *
+ * function HomePage() {
+ *   useEffect(() => {
+ *     showCustomOAWidget({
+ *       id: "oaCustomWidget",
+ *       onClick: (status) => {
+ *         console.log(status);
+ *       },
+ *     });
+ *   }, []);
+ *
+ *   return (
+ *     <>
+ *       ...
+ *       <div id="oaCustomWidget" />
+ *       ...
+ *     </>
+ *   );
+ * }
+ *
+ * export default HomePage;
+ * ```
+ */
+declare function showCustomOAWidget(args: AsyncVoidCallback & TypeOf<(typeof showCustomOAWidgetArgs)[0]>): Promise<void>;
+
 declare class AppError {
     code: number;
     message: string | string[];
@@ -5759,6 +5874,7 @@ declare const otherApis: {
     trackingManager: {
         logEvent: typeof logEvent;
     };
+    showCustomOAWidget: typeof showCustomOAWidget;
     FacingMode: typeof FacingMode;
     PhotoFormat: typeof PhotoFormat;
     PhotoQuality: typeof PhotoQuality;
@@ -5766,4 +5882,4 @@ declare const otherApis: {
     ZMACameraImp: typeof ZMACameraImp;
 };
 
-export { Action, AndroidBottomNavigationBarType, AppError, AsyncCallback, AsyncCallbackFailObject, AsyncProgressCallback, AsyncVoidCallback, AuthorizeType, CameraEvents, CameraParams, ChatType, CheckStateBioAuthenticationReturns, CheckTransactionReturns, CheckZaloCameraPermissionReturns, CheckoutSDK, ChooseImageReturns, Common, ContextInfo, CreateOrderIAPReturns, CreateOrderReturns, Events as EventName, Events, FacingMode, FunctionProps, GetAppInfoReturns, GetAuthCodeReturns, GetBeaconDiscoveryReturns, GetLocationReturns, GetNetworkTypeReturns, GetPhoneNumberReturns, GetSettingReturn, GetStorageReturns, GetUserInfoReturns, GetZPITokenReturns, IAPMethodType, IAPPayType, IAPPayTypeType, IOSSafeAreaBottomType, JumpStatus, KeepScreenReturns, LogData, MediaConstraints, MediaDevice, MediaPickerType, NativeCallBackData, NetworkType, OpenBioAuthenticationReturns, OpenMediaPickerReturns, OpenPostFeedReturns, OpenProfilePickerReturns, 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, 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, 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, showFunctionButtonWidget, showOAWidget, showToast, startBeaconDiscovery, stopBeaconDiscovery, trackingManager, unfollowOA, vibrate, viewOAQr };
+export { Action, AndroidBottomNavigationBarType, AppError, AsyncCallback, AsyncCallbackFailObject, AsyncProgressCallback, AsyncVoidCallback, AuthorizeType, CameraEvents, CameraParams, ChatType, CheckStateBioAuthenticationReturns, CheckTransactionReturns, CheckZaloCameraPermissionReturns, CheckoutSDK, ChooseImageReturns, Common, ContextInfo, CreateOrderIAPReturns, CreateOrderReturns, Events as EventName, Events, FacingMode, FunctionProps, GetAppInfoReturns, GetAuthCodeReturns, GetBeaconDiscoveryReturns, GetLocationReturns, GetNetworkTypeReturns, GetPhoneNumberReturns, GetSettingReturn, GetStorageReturns, GetUserInfoReturns, GetZPITokenReturns, IAPMethodType, IAPPayType, IAPPayTypeType, IOSSafeAreaBottomType, JumpStatus, KeepScreenReturns, LogData, MediaConstraints, MediaDevice, MediaPickerType, NativeCallBackData, NetworkType, OpenBioAuthenticationReturns, OpenMediaPickerReturns, OpenPostFeedReturns, OpenProfilePickerReturns, 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, 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, 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 };