@congminh1254/shopee-sdk 0.6.0 → 0.8.0

package/lib/managers/account-health.manager.d.ts

@@ -0,0 +1,208 @@
+import { ShopeeConfig } from "../sdk.js";
+import { BaseManager } from "./base.manager.js";
+import { GetShopPenaltyResponse, GetShopPerformanceResponse, GetMetricSourceDetailParams, GetMetricSourceDetailResponse, GetPenaltyPointHistoryParams, GetPenaltyPointHistoryResponse, GetPunishmentHistoryParams, GetPunishmentHistoryResponse, GetListingsWithIssuesParams, GetListingsWithIssuesResponse, GetLateOrdersParams, GetLateOrdersResponse } from "../schemas/account-health.js";
+export declare class AccountHealthManager extends BaseManager {
+    constructor(config: ShopeeConfig);
+    /**
+     * Get the information of shop penalty
+     * @returns {Promise<GetShopPenaltyResponse>} Response containing penalty points and ongoing punishments
+     *
+     * This API returns the seller's shop penalty information, including:
+     *
+     * - Penalty points that remain on record till the end of a quarter (reset on the first Monday of each quarter)
+     *   - Overall penalty points total
+     *   - Points from non-fulfillment rate issues
+     *   - Points from late shipment issues
+     *   - Points from listing violations
+     *   - Points from OPFR (Order Pick-up Failure Rate) violations
+     *   - Points from other violations
+     *
+     * - List of ongoing punishments with details about:
+     *   - Punishment tier (1-5)
+     *   - Days left in the punishment period
+     *   - Name of the punishment (e.g., "deboost")
+     *
+     * Use this API to monitor your shop's health status and take proactive measures
+     * to address any issues that could affect your shop's performance.
+     */
+    getShopPenalty(): Promise<GetShopPenaltyResponse>;
+    /**
+     * Get data metrics of shop performance
+     * @returns {Promise<GetShopPerformanceResponse>} Response containing shop performance metrics
+     *
+     * This API returns comprehensive data metrics about a shop's performance across three
+     * key dimensions:
+     *
+     * 1. Fulfillment Performance - Metrics related to order processing and logistics:
+     *    - Late Shipment Rate
+     *    - Non-Fulfillment Rate
+     *    - Preparation Time
+     *    - Fast Handover Rate
+     *    - Cancellation Rate
+     *    - Return-refund Rate
+     *    - On-time Pickup Failure Rate
+     *
+     * 2. Listing Performance - Metrics related to product listings quality:
+     *    - Severe Listing Violations (Prohibited, Counterfeit/IP infringement, Spam)
+     *    - Pre-order Listing percentage and days in violation
+     *    - Other Listing Violations
+     *
+     * 3. Customer Service Performance - Metrics related to customer interactions:
+     *    - Chat Response Rate
+     *    - Response Time
+     *    - Shop Rating
+     *    - Non-Responded Chats
+     *
+     * The response includes both overall performance ratings and detailed metrics with:
+     * - Current and previous period performance values
+     * - Target values with comparators (e.g., "<", ">=") to meet performance standards
+     * - Units of measurement (percentage, number, days, etc.)
+     * - Parent-child relationship between metrics
+     *
+     * Use this API to gain insights into shop performance and identify areas
+     * for improvement to maintain good shop health.
+     */
+    getShopPerformance(): Promise<GetShopPerformanceResponse>;
+    /**
+     * Get the Affected Orders / Relevant Listings / Relevant Violations details of metrics
+     * @param {GetMetricSourceDetailParams} params Request parameters
+     * @param {number} params.metric_id ID of metric to get details for
+     * @param {number} [params.page_no] Page number, starting from 1 (default: 1)
+     * @param {number} [params.page_size] Number of items per page, 1-100 (default: 10)
+     * @returns {Promise<GetMetricSourceDetailResponse>} Response containing detailed information about the metric
+     *
+     * This API returns detailed information about specific metrics, including affected orders,
+     * relevant listings, or violation details. The response structure varies based on the
+     * metric_id provided:
+     *
+     * - Non-Fulfillment Rate metrics (3, 88): Returns `nfr_order_list` with affected orders
+     * - Cancellation Rate metrics (42, 91): Returns `cancellation_order_list` with affected orders
+     * - Return-refund Rate metrics (43, 92): Returns `return_refund_order_list` with affected orders
+     * - Late Shipment Rate metrics (1, 85): Returns `lsr_order_list` with late shipment details
+     * - Fast Handover Rate metrics (25, 2001-2003): Returns `fhr_order_list` with handover details
+     * - On-time Pickup Failure Rate (28): Returns `opfr_day_detail_data_list` with daily violation data
+     * - Listing Violations (52, 53): Returns `violation_listing_list` with problematic listings
+     * - Pre-order Listing Violation (15): Returns `pre_order_listing_violation_data_list` with daily data
+     * - Pre-order Listing % (12): Returns `pre_order_listing_list` with pre-order listings
+     * - NDD Listings % (97): Returns `ndd_listing_list` with NDD-enabled listings
+     *
+     * The response is paginated - use page_no and page_size to navigate through the results.
+     * The total_count field indicates the total number of items available across all pages.
+     *
+     * Use this API to identify specific orders or listings that are affecting your shop's
+     * performance metrics and take corrective actions.
+     */
+    getMetricSourceDetail(params: GetMetricSourceDetailParams): Promise<GetMetricSourceDetailResponse>;
+    /**
+     * Get the penalty point records generated in the current quarter
+     * @param {GetPenaltyPointHistoryParams} [params] Optional request parameters
+     * @param {number} [params.page_no] Page number, starting from 1 (default: 1)
+     * @param {number} [params.page_size] Number of items per page, 1-100 (default: 10)
+     * @param {number} [params.violation_type] Filter by specific violation type (see ViolationType enum)
+     * @returns {Promise<GetPenaltyPointHistoryResponse>} Response containing penalty point records
+     *
+     * This API returns detailed records of penalty points that have been issued to the shop
+     * during the current quarter. Each record includes:
+     *
+     * - The time when the penalty points were issued
+     * - The number of points (both original and current after any adjustments via appeals)
+     * - A unique reference ID for the penalty
+     * - The type of violation that triggered the penalty
+     *
+     * Use this API to track and analyze penalty points history, which can help in:
+     * - Understanding what types of violations are impacting your shop health
+     * - Monitoring the effects of appeals on penalty points
+     * - Tracking progress over time in reducing violations
+     *
+     * The response is paginated - use page_no and page_size to navigate through the results.
+     * You can also filter by violation_type to focus on specific types of issues.
+     *
+     * Note: Penalty points reset at the beginning of each quarter (on the first Monday).
+     */
+    getPenaltyPointHistory(params?: GetPenaltyPointHistoryParams): Promise<GetPenaltyPointHistoryResponse>;
+    /**
+     * Get the punishment records generated in the current quarter
+     * @param {GetPunishmentHistoryParams} params Request parameters
+     * @param {number} params.punishment_status Status of punishments to retrieve (1=Ongoing, 2=Ended)
+     * @param {number} [params.page_no] Page number, starting from 1 (default: 1)
+     * @param {number} [params.page_size] Number of items per page, 1-100 (default: 10)
+     * @returns {Promise<GetPunishmentHistoryResponse>} Response containing punishment records
+     *
+     * This API returns detailed records of punishments that have been applied to the shop
+     * during the current quarter. Each punishment record includes:
+     *
+     * - The time when the punishment was issued
+     * - Start and end times of the punishment period
+     * - Type of punishment (e.g., listing restrictions, marketing restrictions)
+     * - Reason for the punishment (typically indicates the tier level)
+     * - A unique reference ID for the punishment
+     * - For listing limit punishments: the specific listing limit value
+     * - For order limit punishments: the percentage applied to order limits
+     *
+     * You can retrieve either ongoing punishments (punishment_status=1) or
+     * ended punishments (punishment_status=2).
+     *
+     * Common punishment types include:
+     * - Listings not displayed in search or category browsing
+     * - Unable to create or edit listings
+     * - Unable to join marketing campaigns
+     * - No shipping subsidies
+     * - Account suspension
+     * - Listing limit reductions
+     * - Order limits
+     *
+     * The response is paginated - use page_no and page_size to navigate through the results.
+     *
+     * Use this API to understand current restrictions on your shop and when they will expire.
+     */
+    getPunishmentHistory(params: GetPunishmentHistoryParams): Promise<GetPunishmentHistoryResponse>;
+    /**
+     * Get the listings that have issues and need improvement
+     * @param {GetListingsWithIssuesParams} [params] Optional request parameters
+     * @param {number} [params.page_no] Page number, starting from 1 (default: 1)
+     * @param {number} [params.page_size] Number of items per page, 1-100 (default: 10)
+     * @returns {Promise<GetListingsWithIssuesResponse>} Response containing listings with issues
+     *
+     * This API returns details of problematic listings that need improvement. Each listing record includes:
+     *
+     * - The item ID of the problematic listing
+     * - The reason for the issue, with possible values including:
+     *   - Prohibited (1): Listing violates Shopee's prohibited items policy
+     *   - Counterfeit (2): Listing is flagged as potentially counterfeit
+     *   - Spam (3): Listing is identified as spam content
+     *   - Inappropriate Image (4): Listing contains inappropriate images
+     *   - Insufficient Info (5): Listing lacks required information
+     *   - Mall Listing Improvement (6): Mall listing requiring improvement
+     *   - Other Listing Improvement (7): Other issues requiring attention
+     *
+     * The response is paginated - use page_no and page_size to navigate through the results.
+     * The total_count field indicates the total number of listings with issues across all pages.
+     *
+     * Use this API to identify listings that need improvement to maintain good shop health
+     * and avoid potential penalties or restrictions on your shop.
+     */
+    getListingsWithIssues(params?: GetListingsWithIssuesParams): Promise<GetListingsWithIssuesResponse>;
+    /**
+     * Get the late orders to take action to avoid order cancellation and penalty points
+     * @param {GetLateOrdersParams} [params] Optional request parameters
+     * @param {number} [params.page_no] Page number, starting from 1 (default: 1)
+     * @param {number} [params.page_size] Number of items per page, 1-100 (default: 10)
+     * @returns {Promise<GetLateOrdersResponse>} Response containing late orders information
+     *
+     * This API returns a list of orders that are late for shipping and require immediate
+     * attention to avoid potential cancellations and resulting penalty points.
+     * Each late order record includes:
+     *
+     * - The order SN (order number)
+     * - The shipping deadline timestamp
+     * - The number of days the order is late by
+     *
+     * The response is paginated - use page_no and page_size to navigate through the results.
+     * The total_count field indicates the total number of late orders across all pages.
+     *
+     * Use this API to prioritize shipping for late orders and take action to minimize
+     * late shipment rates, which can affect your shop's performance metrics and potentially
+     * result in penalties or restrictions on your shop.
+     */
+    getLateOrders(params?: GetLateOrdersParams): Promise<GetLateOrdersResponse>;
+}

package/lib/managers/account-health.manager.js

@@ -0,0 +1,257 @@
+import { BaseManager } from "./base.manager.js";
+import { ShopeeFetch } from "../fetch.js";
+export class AccountHealthManager extends BaseManager {
+    constructor(config) {
+        super(config);
+    }
+    /**
+     * Get the information of shop penalty
+     * @returns {Promise<GetShopPenaltyResponse>} Response containing penalty points and ongoing punishments
+     *
+     * This API returns the seller's shop penalty information, including:
+     *
+     * - Penalty points that remain on record till the end of a quarter (reset on the first Monday of each quarter)
+     *   - Overall penalty points total
+     *   - Points from non-fulfillment rate issues
+     *   - Points from late shipment issues
+     *   - Points from listing violations
+     *   - Points from OPFR (Order Pick-up Failure Rate) violations
+     *   - Points from other violations
+     *
+     * - List of ongoing punishments with details about:
+     *   - Punishment tier (1-5)
+     *   - Days left in the punishment period
+     *   - Name of the punishment (e.g., "deboost")
+     *
+     * Use this API to monitor your shop's health status and take proactive measures
+     * to address any issues that could affect your shop's performance.
+     */
+    async getShopPenalty() {
+        const response = await ShopeeFetch.fetch(this.config, "/account_health/shop_penalty", {
+            method: "GET",
+            auth: true,
+        });
+        return response;
+    }
+    /**
+     * Get data metrics of shop performance
+     * @returns {Promise<GetShopPerformanceResponse>} Response containing shop performance metrics
+     *
+     * This API returns comprehensive data metrics about a shop's performance across three
+     * key dimensions:
+     *
+     * 1. Fulfillment Performance - Metrics related to order processing and logistics:
+     *    - Late Shipment Rate
+     *    - Non-Fulfillment Rate
+     *    - Preparation Time
+     *    - Fast Handover Rate
+     *    - Cancellation Rate
+     *    - Return-refund Rate
+     *    - On-time Pickup Failure Rate
+     *
+     * 2. Listing Performance - Metrics related to product listings quality:
+     *    - Severe Listing Violations (Prohibited, Counterfeit/IP infringement, Spam)
+     *    - Pre-order Listing percentage and days in violation
+     *    - Other Listing Violations
+     *
+     * 3. Customer Service Performance - Metrics related to customer interactions:
+     *    - Chat Response Rate
+     *    - Response Time
+     *    - Shop Rating
+     *    - Non-Responded Chats
+     *
+     * The response includes both overall performance ratings and detailed metrics with:
+     * - Current and previous period performance values
+     * - Target values with comparators (e.g., "<", ">=") to meet performance standards
+     * - Units of measurement (percentage, number, days, etc.)
+     * - Parent-child relationship between metrics
+     *
+     * Use this API to gain insights into shop performance and identify areas
+     * for improvement to maintain good shop health.
+     */
+    async getShopPerformance() {
+        const response = await ShopeeFetch.fetch(this.config, "/account_health/get_shop_performance", {
+            method: "GET",
+            auth: true,
+        });
+        return response;
+    }
+    /**
+     * Get the Affected Orders / Relevant Listings / Relevant Violations details of metrics
+     * @param {GetMetricSourceDetailParams} params Request parameters
+     * @param {number} params.metric_id ID of metric to get details for
+     * @param {number} [params.page_no] Page number, starting from 1 (default: 1)
+     * @param {number} [params.page_size] Number of items per page, 1-100 (default: 10)
+     * @returns {Promise<GetMetricSourceDetailResponse>} Response containing detailed information about the metric
+     *
+     * This API returns detailed information about specific metrics, including affected orders,
+     * relevant listings, or violation details. The response structure varies based on the
+     * metric_id provided:
+     *
+     * - Non-Fulfillment Rate metrics (3, 88): Returns `nfr_order_list` with affected orders
+     * - Cancellation Rate metrics (42, 91): Returns `cancellation_order_list` with affected orders
+     * - Return-refund Rate metrics (43, 92): Returns `return_refund_order_list` with affected orders
+     * - Late Shipment Rate metrics (1, 85): Returns `lsr_order_list` with late shipment details
+     * - Fast Handover Rate metrics (25, 2001-2003): Returns `fhr_order_list` with handover details
+     * - On-time Pickup Failure Rate (28): Returns `opfr_day_detail_data_list` with daily violation data
+     * - Listing Violations (52, 53): Returns `violation_listing_list` with problematic listings
+     * - Pre-order Listing Violation (15): Returns `pre_order_listing_violation_data_list` with daily data
+     * - Pre-order Listing % (12): Returns `pre_order_listing_list` with pre-order listings
+     * - NDD Listings % (97): Returns `ndd_listing_list` with NDD-enabled listings
+     *
+     * The response is paginated - use page_no and page_size to navigate through the results.
+     * The total_count field indicates the total number of items available across all pages.
+     *
+     * Use this API to identify specific orders or listings that are affecting your shop's
+     * performance metrics and take corrective actions.
+     */
+    async getMetricSourceDetail(params) {
+        const response = await ShopeeFetch.fetch(this.config, "/account_health/get_metric_source_detail", {
+            method: "GET",
+            auth: true,
+            params,
+        });
+        return response;
+    }
+    /**
+     * Get the penalty point records generated in the current quarter
+     * @param {GetPenaltyPointHistoryParams} [params] Optional request parameters
+     * @param {number} [params.page_no] Page number, starting from 1 (default: 1)
+     * @param {number} [params.page_size] Number of items per page, 1-100 (default: 10)
+     * @param {number} [params.violation_type] Filter by specific violation type (see ViolationType enum)
+     * @returns {Promise<GetPenaltyPointHistoryResponse>} Response containing penalty point records
+     *
+     * This API returns detailed records of penalty points that have been issued to the shop
+     * during the current quarter. Each record includes:
+     *
+     * - The time when the penalty points were issued
+     * - The number of points (both original and current after any adjustments via appeals)
+     * - A unique reference ID for the penalty
+     * - The type of violation that triggered the penalty
+     *
+     * Use this API to track and analyze penalty points history, which can help in:
+     * - Understanding what types of violations are impacting your shop health
+     * - Monitoring the effects of appeals on penalty points
+     * - Tracking progress over time in reducing violations
+     *
+     * The response is paginated - use page_no and page_size to navigate through the results.
+     * You can also filter by violation_type to focus on specific types of issues.
+     *
+     * Note: Penalty points reset at the beginning of each quarter (on the first Monday).
+     */
+    async getPenaltyPointHistory(params) {
+        const response = await ShopeeFetch.fetch(this.config, "/account_health/get_penalty_point_history", {
+            method: "GET",
+            auth: true,
+            params,
+        });
+        return response;
+    }
+    /**
+     * Get the punishment records generated in the current quarter
+     * @param {GetPunishmentHistoryParams} params Request parameters
+     * @param {number} params.punishment_status Status of punishments to retrieve (1=Ongoing, 2=Ended)
+     * @param {number} [params.page_no] Page number, starting from 1 (default: 1)
+     * @param {number} [params.page_size] Number of items per page, 1-100 (default: 10)
+     * @returns {Promise<GetPunishmentHistoryResponse>} Response containing punishment records
+     *
+     * This API returns detailed records of punishments that have been applied to the shop
+     * during the current quarter. Each punishment record includes:
+     *
+     * - The time when the punishment was issued
+     * - Start and end times of the punishment period
+     * - Type of punishment (e.g., listing restrictions, marketing restrictions)
+     * - Reason for the punishment (typically indicates the tier level)
+     * - A unique reference ID for the punishment
+     * - For listing limit punishments: the specific listing limit value
+     * - For order limit punishments: the percentage applied to order limits
+     *
+     * You can retrieve either ongoing punishments (punishment_status=1) or
+     * ended punishments (punishment_status=2).
+     *
+     * Common punishment types include:
+     * - Listings not displayed in search or category browsing
+     * - Unable to create or edit listings
+     * - Unable to join marketing campaigns
+     * - No shipping subsidies
+     * - Account suspension
+     * - Listing limit reductions
+     * - Order limits
+     *
+     * The response is paginated - use page_no and page_size to navigate through the results.
+     *
+     * Use this API to understand current restrictions on your shop and when they will expire.
+     */
+    async getPunishmentHistory(params) {
+        const response = await ShopeeFetch.fetch(this.config, "/account_health/get_punishment_history", {
+            method: "GET",
+            auth: true,
+            params,
+        });
+        return response;
+    }
+    /**
+     * Get the listings that have issues and need improvement
+     * @param {GetListingsWithIssuesParams} [params] Optional request parameters
+     * @param {number} [params.page_no] Page number, starting from 1 (default: 1)
+     * @param {number} [params.page_size] Number of items per page, 1-100 (default: 10)
+     * @returns {Promise<GetListingsWithIssuesResponse>} Response containing listings with issues
+     *
+     * This API returns details of problematic listings that need improvement. Each listing record includes:
+     *
+     * - The item ID of the problematic listing
+     * - The reason for the issue, with possible values including:
+     *   - Prohibited (1): Listing violates Shopee's prohibited items policy
+     *   - Counterfeit (2): Listing is flagged as potentially counterfeit
+     *   - Spam (3): Listing is identified as spam content
+     *   - Inappropriate Image (4): Listing contains inappropriate images
+     *   - Insufficient Info (5): Listing lacks required information
+     *   - Mall Listing Improvement (6): Mall listing requiring improvement
+     *   - Other Listing Improvement (7): Other issues requiring attention
+     *
+     * The response is paginated - use page_no and page_size to navigate through the results.
+     * The total_count field indicates the total number of listings with issues across all pages.
+     *
+     * Use this API to identify listings that need improvement to maintain good shop health
+     * and avoid potential penalties or restrictions on your shop.
+     */
+    async getListingsWithIssues(params) {
+        const response = await ShopeeFetch.fetch(this.config, "/account_health/get_listings_with_issues", {
+            method: "GET",
+            auth: true,
+            params,
+        });
+        return response;
+    }
+    /**
+     * Get the late orders to take action to avoid order cancellation and penalty points
+     * @param {GetLateOrdersParams} [params] Optional request parameters
+     * @param {number} [params.page_no] Page number, starting from 1 (default: 1)
+     * @param {number} [params.page_size] Number of items per page, 1-100 (default: 10)
+     * @returns {Promise<GetLateOrdersResponse>} Response containing late orders information
+     *
+     * This API returns a list of orders that are late for shipping and require immediate
+     * attention to avoid potential cancellations and resulting penalty points.
+     * Each late order record includes:
+     *
+     * - The order SN (order number)
+     * - The shipping deadline timestamp
+     * - The number of days the order is late by
+     *
+     * The response is paginated - use page_no and page_size to navigate through the results.
+     * The total_count field indicates the total number of late orders across all pages.
+     *
+     * Use this API to prioritize shipping for late orders and take action to minimize
+     * late shipment rates, which can affect your shop's performance metrics and potentially
+     * result in penalties or restrictions on your shop.
+     */
+    async getLateOrders(params) {
+        const response = await ShopeeFetch.fetch(this.config, "/account_health/get_late_orders", {
+            method: "GET",
+            auth: true,
+            params,
+        });
+        return response;
+    }
+}
+//# sourceMappingURL=account-health.manager.js.map

package/lib/managers/account-health.manager.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"account-health.manager.js","sourceRoot":"","sources":["../../src/managers/account-health.manager.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAChD,OAAO,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAgB1C,MAAM,OAAO,oBAAqB,SAAQ,WAAW;IACnD,YAAY,MAAoB;QAC9B,KAAK,CAAC,MAAM,CAAC,CAAC;IAChB,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,KAAK,CAAC,cAAc;QAClB,MAAM,QAAQ,GAAG,MAAM,WAAW,CAAC,KAAK,CACtC,IAAI,CAAC,MAAM,EACX,8BAA8B,EAC9B;YACE,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,IAAI;SACX,CACF,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAmCG;IACH,KAAK,CAAC,kBAAkB;QACtB,MAAM,QAAQ,GAAG,MAAM,WAAW,CAAC,KAAK,CACtC,IAAI,CAAC,MAAM,EACX,sCAAsC,EACtC;YACE,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,IAAI;SACX,CACF,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;IACH,KAAK,CAAC,qBAAqB,CACzB,MAAmC;QAEnC,MAAM,QAAQ,GAAG,MAAM,WAAW,CAAC,KAAK,CACtC,IAAI,CAAC,MAAM,EACX,0CAA0C,EAC1C;YACE,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,IAAI;YACV,MAAM;SACP,CACF,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACH,KAAK,CAAC,sBAAsB,CAC1B,MAAqC;QAErC,MAAM,QAAQ,GAAG,MAAM,WAAW,CAAC,KAAK,CACtC,IAAI,CAAC,MAAM,EACX,2CAA2C,EAC3C;YACE,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,IAAI;YACV,MAAM;SACP,CACF,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkCG;IACH,KAAK,CAAC,oBAAoB,CACxB,MAAkC;QAElC,MAAM,QAAQ,GAAG,MAAM,WAAW,CAAC,KAAK,CACtC,IAAI,CAAC,MAAM,EACX,wCAAwC,EACxC;YACE,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,IAAI;YACV,MAAM;SACP,CACF,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACH,KAAK,CAAC,qBAAqB,CACzB,MAAoC;QAEpC,MAAM,QAAQ,GAAG,MAAM,WAAW,CAAC,KAAK,CACtC,IAAI,CAAC,MAAM,EACX,0CAA0C,EAC1C;YACE,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,IAAI;YACV,MAAM;SACP,CACF,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,KAAK,CAAC,aAAa,CAAC,MAA4B;QAC9C,MAAM,QAAQ,GAAG,MAAM,WAAW,CAAC,KAAK,CACtC,IAAI,CAAC,MAAM,EACX,iCAAiC,EACjC;YACE,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,IAAI;YACV,MAAM;SACP,CACF,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;CACF"}

package/lib/managers/index.d.ts

@@ -8,3 +8,4 @@ export * from "./public.manager.js";
 export * from "./push.manager.js";
 export * from "./voucher.manager.js";
 export * from "./ads.manager.js";
+export * from "./account-health.manager.js";

package/lib/managers/index.js

@@ -8,4 +8,5 @@ export * from "./public.manager.js";
 export * from "./push.manager.js";
 export * from "./voucher.manager.js";
 export * from "./ads.manager.js";
+export * from "./account-health.manager.js";
 //# sourceMappingURL=index.js.map

package/lib/managers/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/managers/index.ts"],"names":[],"mappings":"AAAA,cAAc,mBAAmB,CAAC;AAClC,cAAc,mBAAmB,CAAC;AAClC,cAAc,wBAAwB,CAAC;AACvC,cAAc,oBAAoB,CAAC;AACnC,cAAc,oBAAoB,CAAC;AACnC,cAAc,sBAAsB,CAAC;AACrC,cAAc,qBAAqB,CAAC;AACpC,cAAc,mBAAmB,CAAC;AAClC,cAAc,sBAAsB,CAAC;AACrC,cAAc,kBAAkB,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/managers/index.ts"],"names":[],"mappings":"AAAA,cAAc,mBAAmB,CAAC;AAClC,cAAc,mBAAmB,CAAC;AAClC,cAAc,wBAAwB,CAAC;AACvC,cAAc,oBAAoB,CAAC;AACnC,cAAc,oBAAoB,CAAC;AACnC,cAAc,sBAAsB,CAAC;AACrC,cAAc,qBAAqB,CAAC;AACpC,cAAc,mBAAmB,CAAC;AAClC,cAAc,sBAAsB,CAAC;AACrC,cAAc,kBAAkB,CAAC;AACjC,cAAc,6BAA6B,CAAC"}

package/lib/managers/product.manager.d.ts

@@ -1,6 +1,6 @@
 import { BaseManager } from "./base.manager.js";
 import { ShopeeConfig } from "../sdk.js";
-import { GetCommentParams, GetCommentResponse, ReplyCommentParams, ReplyCommentResponse, GetItemListParams, GetItemListResponse, GetItemBaseInfoParams, GetItemBaseInfoResponse } from "../schemas/product.js";
+import { GetCommentParams, GetCommentResponse, ReplyCommentParams, ReplyCommentResponse, GetItemListParams, GetItemListResponse, GetItemBaseInfoParams, GetItemBaseInfoResponse, GetModelListParams, GetModelListResponse } from "../schemas/product.js";
 export declare class ProductManager extends BaseManager {
     constructor(config: ShopeeConfig);
     /**
@@ -111,4 +111,23 @@ export declare class ProductManager extends BaseManager {
      * - error_query_over_itemid_size: Too many item_ids in list
      */
     getItemBaseInfo(params: GetItemBaseInfoParams): Promise<GetItemBaseInfoResponse>;
+    /**
+     * Get model list of an item
+     *
+     * Use this API to get model list of an item.
+     *
+     * @param params - The parameters for getting the model list
+     * @param params.item_id - The ID of the item
+     *
+     * @returns A promise that resolves to the model list response containing:
+     * - tier_variation: Variation config of item with option_list and name
+     * - model: List of model information including price_info, model_id, tier_index, model_sku, model_status, etc.
+     * - standardise_tier_variation: Standardise variation config of item (if available)
+     *
+     * @throws {Error} When the API request fails or returns an error:
+     * - error_item_not_found: Item_id is not found
+     * - error_param_shop_id_not_found: Shop_id is not found
+     * - error_item_not_found: Product not found
+     */
+    getModelList(params: GetModelListParams): Promise<GetModelListResponse>;
 }

package/lib/managers/product.manager.js

@@ -143,5 +143,31 @@ export class ProductManager extends BaseManager {
         });
         return response;
     }
+    /**
+     * Get model list of an item
+     *
+     * Use this API to get model list of an item.
+     *
+     * @param params - The parameters for getting the model list
+     * @param params.item_id - The ID of the item
+     *
+     * @returns A promise that resolves to the model list response containing:
+     * - tier_variation: Variation config of item with option_list and name
+     * - model: List of model information including price_info, model_id, tier_index, model_sku, model_status, etc.
+     * - standardise_tier_variation: Standardise variation config of item (if available)
+     *
+     * @throws {Error} When the API request fails or returns an error:
+     * - error_item_not_found: Item_id is not found
+     * - error_param_shop_id_not_found: Shop_id is not found
+     * - error_item_not_found: Product not found
+     */
+    async getModelList(params) {
+        const response = await ShopeeFetch.fetch(this.config, "/product/get_model_list", {
+            method: "GET",
+            auth: true,
+            params,
+        });
+        return response;
+    }
 }
 //# sourceMappingURL=product.manager.js.map

package/lib/managers/product.manager.js.map

@@ -1 +1 @@
-{"version":3,"file":"product.manager.js","sourceRoot":"","sources":["../../src/managers/product.manager.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAEhD,OAAO,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAY1C,MAAM,OAAO,cAAe,SAAQ,WAAW;IAC7C,YAAY,MAAoB;QAC9B,KAAK,CAAC,MAAM,CAAC,CAAC;IAChB,CAAC;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACH,KAAK,CAAC,UAAU,CAAC,MAAwB;QACvC,MAAM,QAAQ,GAAG,MAAM,WAAW,CAAC,KAAK,CACtC,IAAI,CAAC,MAAM,EACX,sBAAsB,EACtB;YACE,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,IAAI;YACV,MAAM;SACP,CACF,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,KAAK,CAAC,YAAY,CAAC,MAA0B;QAC3C,MAAM,QAAQ,GAAG,MAAM,WAAW,CAAC,KAAK,CACtC,IAAI,CAAC,MAAM,EACX,wBAAwB,EACxB;YACE,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,IAAI;YACV,IAAI,EAAE,MAAM;SACb,CACF,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,KAAK,CAAC,WAAW,CAAC,MAAyB;QACzC,MAAM,QAAQ,GAAG,MAAM,WAAW,CAAC,KAAK,CACtC,IAAI,CAAC,MAAM,EACX,wBAAwB,EACxB;YACE,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,IAAI;YACV,MAAM;SACP,CACF,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAqCG;IACH,KAAK,CAAC,eAAe,CAAC,MAA6B;QACjD,MAAM,QAAQ,GAAG,MAAM,WAAW,CAAC,KAAK,CACtC,IAAI,CAAC,MAAM,EACX,6BAA6B,EAC7B;YACE,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,IAAI;YACV,MAAM,EAAE;gBACN,GAAG,MAAM;gBACT,YAAY,EAAE,MAAM,CAAC,YAAY,CAAC,IAAI,CAAC,GAAG,CAAC;aAC5C;SACF,CACF,CAAC;QACF,OAAO,QAAQ,CAAC;IAClB,CAAC;CACF"}
+{"version":3,"file":"product.manager.js","sourceRoot":"","sources":["../../src/managers/product.manager.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAEhD,OAAO,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAc1C,MAAM,OAAO,cAAe,SAAQ,WAAW;IAC7C,YAAY,MAAoB;QAC9B,KAAK,CAAC,MAAM,CAAC,CAAC;IAChB,CAAC;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACH,KAAK,CAAC,UAAU,CAAC,MAAwB;QACvC,MAAM,QAAQ,GAAG,MAAM,WAAW,CAAC,KAAK,CACtC,IAAI,CAAC,MAAM,EACX,sBAAsB,EACtB;YACE,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,IAAI;YACV,MAAM;SACP,CACF,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,KAAK,CAAC,YAAY,CAAC,MAA0B;QAC3C,MAAM,QAAQ,GAAG,MAAM,WAAW,CAAC,KAAK,CACtC,IAAI,CAAC,MAAM,EACX,wBAAwB,EACxB;YACE,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,IAAI;YACV,IAAI,EAAE,MAAM;SACb,CACF,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,KAAK,CAAC,WAAW,CAAC,MAAyB;QACzC,MAAM,QAAQ,GAAG,MAAM,WAAW,CAAC,KAAK,CACtC,IAAI,CAAC,MAAM,EACX,wBAAwB,EACxB;YACE,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,IAAI;YACV,MAAM;SACP,CACF,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAqCG;IACH,KAAK,CAAC,eAAe,CAAC,MAA6B;QACjD,MAAM,QAAQ,GAAG,MAAM,WAAW,CAAC,KAAK,CACtC,IAAI,CAAC,MAAM,EACX,6BAA6B,EAC7B;YACE,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,IAAI;YACV,MAAM,EAAE;gBACN,GAAG,MAAM;gBACT,YAAY,EAAE,MAAM,CAAC,YAAY,CAAC,IAAI,CAAC,GAAG,CAAC;aAC5C;SACF,CACF,CAAC;QACF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED;;;;;;;;;;;;;;;;;OAiBG;IACH,KAAK,CAAC,YAAY,CAAC,MAA0B;QAC3C,MAAM,QAAQ,GAAG,MAAM,WAAW,CAAC,KAAK,CACtC,IAAI,CAAC,MAAM,EACX,yBAAyB,EACzB;YACE,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,IAAI;YACV,MAAM;SACP,CACF,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;CACF"}