@congminh1254/shopee-sdk 0.4.0

package/lib/managers/public.manager.js

@@ -0,0 +1,34 @@
+import { ShopeeFetch } from '../fetch.js';
+import { BaseManager } from './base.manager.js';
+export class PublicManager extends BaseManager {
+    constructor(config) {
+        super(config);
+    }
+    async getShopsByPartner(params) {
+        const response = await ShopeeFetch.fetch(this.config, '/public/get_shops_by_partner', {
+            method: 'GET',
+            params: {
+                partner_id: this.config.partner_id,
+                ...params,
+            },
+        });
+        return response;
+    }
+    async getMerchantsByPartner(params) {
+        const response = await ShopeeFetch.fetch(this.config, '/public/get_merchants_by_partner', {
+            method: 'GET',
+            params: {
+                partner_id: this.config.partner_id,
+                ...params,
+            },
+        });
+        return response;
+    }
+    async getShopeeIpRange() {
+        const response = await ShopeeFetch.fetch(this.config, '/public/get_shopee_ip_ranges', {
+            method: 'GET',
+        });
+        return response;
+    }
+}
+//# sourceMappingURL=public.manager.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"public.manager.js","sourceRoot":"","sources":["../../src/managers/public.manager.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAQ1C,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAEhD,MAAM,OAAO,aAAc,SAAQ,WAAW;IAC5C,YAAY,MAAoB;QAC9B,KAAK,CAAC,MAAM,CAAC,CAAC;IAChB,CAAC;IAEM,KAAK,CAAC,iBAAiB,CAC5B,MAAgC;QAEhC,MAAM,QAAQ,GAAG,MAAM,WAAW,CAAC,KAAK,CACtC,IAAI,CAAC,MAAM,EACX,8BAA8B,EAC9B;YACE,MAAM,EAAE,KAAK;YACb,MAAM,EAAE;gBACN,UAAU,EAAE,IAAI,CAAC,MAAM,CAAC,UAAU;gBAClC,GAAG,MAAM;aACV;SACF,CACF,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAEM,KAAK,CAAC,qBAAqB,CAChC,MAAoC;QAEpC,MAAM,QAAQ,GAAG,MAAM,WAAW,CAAC,KAAK,CACtC,IAAI,CAAC,MAAM,EACX,kCAAkC,EAClC;YACE,MAAM,EAAE,KAAK;YACb,MAAM,EAAE;gBACN,UAAU,EAAE,IAAI,CAAC,MAAM,CAAC,UAAU;gBAClC,GAAG,MAAM;aACV;SACF,CACF,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAEM,KAAK,CAAC,gBAAgB;QAC3B,MAAM,QAAQ,GAAG,MAAM,WAAW,CAAC,KAAK,CACtC,IAAI,CAAC,MAAM,EACX,8BAA8B,EAC9B;YACE,MAAM,EAAE,KAAK;SACd,CACF,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;CACF"}

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

@@ -0,0 +1,36 @@
+import { ShopeeConfig } from '../sdk.js';
+import { SetAppPushConfigParams, SetAppPushConfigResponse, GetAppPushConfigResponse, GetLostPushMessageResponse, ConfirmConsumedLostPushMessageParams, ConfirmConsumedLostPushMessageResponse } from '../schemas/push.js';
+import { BaseManager } from './base.manager.js';
+export declare class PushManager extends BaseManager {
+    constructor(config: ShopeeConfig);
+    setAppPushConfig(params: SetAppPushConfigParams): Promise<SetAppPushConfigResponse>;
+    getAppPushConfig(): Promise<GetAppPushConfigResponse>;
+    /**
+     * Get the lost push messages that were lost within 3 days of the current time and not confirmed to have been consumed
+     * @returns {Promise<GetLostPushMessageResponse>} Response containing up to 100 lost push messages
+     *
+     * This API retrieves the earliest 100 lost push messages from the past 3 days that haven't been confirmed as consumed.
+     * If there are more than 100 messages, the response will indicate this via the has_next_page field,
+     * and you'll need to make additional calls to retrieve the remaining messages.
+     *
+     * The returned messages contain:
+     * - shop_id: The shop identifier (absent for partner level pushes)
+     * - code: The push notification identifier
+     * - timestamp: When the message was lost
+     * - data: The actual push message content (as a JSON string)
+     */
+    getLostPushMessage(): Promise<GetLostPushMessageResponse>;
+    /**
+     * Confirm that lost push messages have been consumed up to a specific message ID
+     * @param {ConfirmConsumedLostPushMessageParams} params - Parameters for confirming consumed lost push messages
+     * @param {number} params.last_message_id - The last_message_id returned by getLostPushMessage
+     * @returns {Promise<ConfirmConsumedLostPushMessageResponse>} Response indicating the confirmation result
+     *
+     * This API confirms that all lost push messages up to and including the specified last_message_id
+     * have been successfully consumed/processed by your application. After confirmation, these messages
+     * will no longer be returned by the getLostPushMessage API.
+     *
+     * Use this method after you have successfully processed the messages returned by getLostPushMessage.
+     */
+    confirmConsumedLostPushMessage(params: ConfirmConsumedLostPushMessageParams): Promise<ConfirmConsumedLostPushMessageResponse>;
+}

package/lib/managers/push.manager.js

@@ -0,0 +1,60 @@
+import { ShopeeFetch } from '../fetch.js';
+import { BaseManager } from './base.manager.js';
+export class PushManager extends BaseManager {
+    constructor(config) {
+        super(config);
+    }
+    async setAppPushConfig(params) {
+        const response = await ShopeeFetch.fetch(this.config, '/push/set_app_push_config', {
+            method: 'POST',
+            body: params
+        });
+        return response;
+    }
+    async getAppPushConfig() {
+        const response = await ShopeeFetch.fetch(this.config, '/push/get_app_push_config', {
+            method: 'GET',
+        });
+        return response;
+    }
+    /**
+     * Get the lost push messages that were lost within 3 days of the current time and not confirmed to have been consumed
+     * @returns {Promise<GetLostPushMessageResponse>} Response containing up to 100 lost push messages
+     *
+     * This API retrieves the earliest 100 lost push messages from the past 3 days that haven't been confirmed as consumed.
+     * If there are more than 100 messages, the response will indicate this via the has_next_page field,
+     * and you'll need to make additional calls to retrieve the remaining messages.
+     *
+     * The returned messages contain:
+     * - shop_id: The shop identifier (absent for partner level pushes)
+     * - code: The push notification identifier
+     * - timestamp: When the message was lost
+     * - data: The actual push message content (as a JSON string)
+     */
+    async getLostPushMessage() {
+        const response = await ShopeeFetch.fetch(this.config, '/push/get_lost_push_message', {
+            method: 'GET',
+        });
+        return response;
+    }
+    /**
+     * Confirm that lost push messages have been consumed up to a specific message ID
+     * @param {ConfirmConsumedLostPushMessageParams} params - Parameters for confirming consumed lost push messages
+     * @param {number} params.last_message_id - The last_message_id returned by getLostPushMessage
+     * @returns {Promise<ConfirmConsumedLostPushMessageResponse>} Response indicating the confirmation result
+     *
+     * This API confirms that all lost push messages up to and including the specified last_message_id
+     * have been successfully consumed/processed by your application. After confirmation, these messages
+     * will no longer be returned by the getLostPushMessage API.
+     *
+     * Use this method after you have successfully processed the messages returned by getLostPushMessage.
+     */
+    async confirmConsumedLostPushMessage(params) {
+        const response = await ShopeeFetch.fetch(this.config, '/push/confirm_consumed_lost_push_message', {
+            method: 'POST',
+            body: params,
+        });
+        return response;
+    }
+}
+//# sourceMappingURL=push.manager.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"push.manager.js","sourceRoot":"","sources":["../../src/managers/push.manager.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAS1C,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAEhD,MAAM,OAAO,WAAY,SAAQ,WAAW;IACxC,YAAY,MAAoB;QAC5B,KAAK,CAAC,MAAM,CAAC,CAAC;IAClB,CAAC;IAEM,KAAK,CAAC,gBAAgB,CAAC,MAA8B;QACxD,MAAM,QAAQ,GAAG,MAAM,WAAW,CAAC,KAAK,CACpC,IAAI,CAAC,MAAM,EACX,2BAA2B,EAC3B;YACI,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,MAAmD;SAC5D,CACJ,CAAC;QAEF,OAAO,QAAQ,CAAC;IACpB,CAAC;IAEM,KAAK,CAAC,gBAAgB;QACzB,MAAM,QAAQ,GAAG,MAAM,WAAW,CAAC,KAAK,CACpC,IAAI,CAAC,MAAM,EACX,2BAA2B,EAC3B;YACI,MAAM,EAAE,KAAK;SAChB,CACJ,CAAC;QAEF,OAAO,QAAQ,CAAC;IACpB,CAAC;IAED;;;;;;;;;;;;;OAaG;IACI,KAAK,CAAC,kBAAkB;QAC3B,MAAM,QAAQ,GAAG,MAAM,WAAW,CAAC,KAAK,CACpC,IAAI,CAAC,MAAM,EACX,6BAA6B,EAC7B;YACI,MAAM,EAAE,KAAK;SAChB,CACJ,CAAC;QAEF,OAAO,QAAQ,CAAC;IACpB,CAAC;IAED;;;;;;;;;;;OAWG;IACI,KAAK,CAAC,8BAA8B,CACvC,MAA4C;QAE5C,MAAM,QAAQ,GAAG,MAAM,WAAW,CAAC,KAAK,CACpC,IAAI,CAAC,MAAM,EACX,0CAA0C,EAC1C;YACI,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,MAAM;SACf,CACJ,CAAC;QAEF,OAAO,QAAQ,CAAC;IACpB,CAAC;CACJ"}

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

@@ -0,0 +1,70 @@
+import { ShopeeConfig } from "../sdk.js";
+import { BaseManager } from "./base.manager.js";
+import { AddVoucherParams, AddVoucherResponse, DeleteVoucherParams, DeleteVoucherResponse, EndVoucherParams, EndVoucherResponse, UpdateVoucherParams, UpdateVoucherResponse, GetVoucherParams, GetVoucherResponse, GetVoucherListParams, GetVoucherListResponse } from "../schemas/voucher.js";
+export declare class VoucherManager extends BaseManager {
+    constructor(config: ShopeeConfig);
+    /**
+     * Add a new voucher
+     * @param {AddVoucherParams} params - Parameters for creating a new voucher
+     * @returns {Promise<AddVoucherResponse>} The response containing the created voucher ID
+     */
+    addVoucher(params: AddVoucherParams): Promise<AddVoucherResponse>;
+    /**
+     * Delete an existing voucher
+     * @param {DeleteVoucherParams} params - Parameters for deleting a voucher
+     * @returns {Promise<DeleteVoucherResponse>} The response containing the deleted voucher ID
+     *
+     * Note: Can only delete upcoming vouchers that haven't started yet.
+     * Will return an error if attempting to delete a voucher that has already started.
+     */
+    deleteVoucher(params: DeleteVoucherParams): Promise<DeleteVoucherResponse>;
+    /**
+     * End an ongoing voucher immediately
+     * @param {EndVoucherParams} params - Parameters for ending a voucher
+     * @returns {Promise<EndVoucherResponse>} The response containing the ended voucher ID
+     *
+     * Note: Can only end vouchers that are currently ongoing/active.
+     * Will return an error if attempting to end an upcoming or expired voucher.
+     */
+    endVoucher(params: EndVoucherParams): Promise<EndVoucherResponse>;
+    /**
+     * Update an existing voucher
+     * @param {UpdateVoucherParams} params - Parameters for updating a voucher
+     * @returns {Promise<UpdateVoucherResponse>} The response containing the updated voucher ID
+     *
+     * Note: For ongoing vouchers, only these fields can be modified:
+     * - voucher_name
+     * - usage_quantity (can only be increased)
+     * - end_time (can only be shortened, not extended)
+     * - display_channel_list
+     * - item_id_list
+     */
+    updateVoucher(params: UpdateVoucherParams): Promise<UpdateVoucherResponse>;
+    /**
+     * Get detailed information about a voucher
+     * @param {GetVoucherParams} params - Parameters for getting voucher details
+     * @returns {Promise<GetVoucherResponse>} The response containing comprehensive voucher information
+     *
+     * The response includes:
+     * - Basic voucher details (ID, code, name, type, etc.)
+     * - Usage information (total quantity, current usage)
+     * - Timing details (start time, end time, display time)
+     * - Reward specifics (reward type, discount amount/percentage, min basket price)
+     * - Display settings (channels where voucher is shown)
+     * - For product vouchers: list of applicable items
+     */
+    getVoucher(params: GetVoucherParams): Promise<GetVoucherResponse>;
+    /**
+     * Get a list of vouchers with pagination
+     * @param {GetVoucherListParams} params - Parameters for retrieving voucher list
+     * @param {VoucherStatus} params.status - Filter by voucher status (UPCOMING, ONGOING, EXPIRED, or ALL)
+     * @param {number} [params.page_no] - Page number to retrieve (default: 1, range: 1-5000)
+     * @param {number} [params.page_size] - Number of items per page (default: 20, range: 1-100)
+     * @returns {Promise<GetVoucherListResponse>} The response containing a paginated list of vouchers
+     *
+     * The response includes:
+     * - Pagination information (more: boolean indicating if there are more pages)
+     * - A list of vouchers with details such as ID, code, name, type, usage statistics, timing, and reward information
+     */
+    getVoucherList(params: GetVoucherListParams): Promise<GetVoucherListResponse>;
+}

package/lib/managers/voucher.manager.js

@@ -0,0 +1,114 @@
+import { BaseManager } from "./base.manager.js";
+import { ShopeeFetch } from "../fetch.js";
+export class VoucherManager extends BaseManager {
+    constructor(config) {
+        super(config);
+    }
+    /**
+     * Add a new voucher
+     * @param {AddVoucherParams} params - Parameters for creating a new voucher
+     * @returns {Promise<AddVoucherResponse>} The response containing the created voucher ID
+     */
+    async addVoucher(params) {
+        const response = await ShopeeFetch.fetch(this.config, '/voucher/add_voucher', {
+            method: 'POST',
+            auth: true,
+            body: params,
+        });
+        return response;
+    }
+    /**
+     * Delete an existing voucher
+     * @param {DeleteVoucherParams} params - Parameters for deleting a voucher
+     * @returns {Promise<DeleteVoucherResponse>} The response containing the deleted voucher ID
+     *
+     * Note: Can only delete upcoming vouchers that haven't started yet.
+     * Will return an error if attempting to delete a voucher that has already started.
+     */
+    async deleteVoucher(params) {
+        const response = await ShopeeFetch.fetch(this.config, '/voucher/delete_voucher', {
+            method: 'POST',
+            auth: true,
+            body: params,
+        });
+        return response;
+    }
+    /**
+     * End an ongoing voucher immediately
+     * @param {EndVoucherParams} params - Parameters for ending a voucher
+     * @returns {Promise<EndVoucherResponse>} The response containing the ended voucher ID
+     *
+     * Note: Can only end vouchers that are currently ongoing/active.
+     * Will return an error if attempting to end an upcoming or expired voucher.
+     */
+    async endVoucher(params) {
+        const response = await ShopeeFetch.fetch(this.config, '/voucher/end_voucher', {
+            method: 'POST',
+            auth: true,
+            body: params,
+        });
+        return response;
+    }
+    /**
+     * Update an existing voucher
+     * @param {UpdateVoucherParams} params - Parameters for updating a voucher
+     * @returns {Promise<UpdateVoucherResponse>} The response containing the updated voucher ID
+     *
+     * Note: For ongoing vouchers, only these fields can be modified:
+     * - voucher_name
+     * - usage_quantity (can only be increased)
+     * - end_time (can only be shortened, not extended)
+     * - display_channel_list
+     * - item_id_list
+     */
+    async updateVoucher(params) {
+        const response = await ShopeeFetch.fetch(this.config, '/voucher/update_voucher', {
+            method: 'POST',
+            auth: true,
+            body: params,
+        });
+        return response;
+    }
+    /**
+     * Get detailed information about a voucher
+     * @param {GetVoucherParams} params - Parameters for getting voucher details
+     * @returns {Promise<GetVoucherResponse>} The response containing comprehensive voucher information
+     *
+     * The response includes:
+     * - Basic voucher details (ID, code, name, type, etc.)
+     * - Usage information (total quantity, current usage)
+     * - Timing details (start time, end time, display time)
+     * - Reward specifics (reward type, discount amount/percentage, min basket price)
+     * - Display settings (channels where voucher is shown)
+     * - For product vouchers: list of applicable items
+     */
+    async getVoucher(params) {
+        const response = await ShopeeFetch.fetch(this.config, '/voucher/get_voucher', {
+            method: 'GET',
+            auth: true,
+            params,
+        });
+        return response;
+    }
+    /**
+     * Get a list of vouchers with pagination
+     * @param {GetVoucherListParams} params - Parameters for retrieving voucher list
+     * @param {VoucherStatus} params.status - Filter by voucher status (UPCOMING, ONGOING, EXPIRED, or ALL)
+     * @param {number} [params.page_no] - Page number to retrieve (default: 1, range: 1-5000)
+     * @param {number} [params.page_size] - Number of items per page (default: 20, range: 1-100)
+     * @returns {Promise<GetVoucherListResponse>} The response containing a paginated list of vouchers
+     *
+     * The response includes:
+     * - Pagination information (more: boolean indicating if there are more pages)
+     * - A list of vouchers with details such as ID, code, name, type, usage statistics, timing, and reward information
+     */
+    async getVoucherList(params) {
+        const response = await ShopeeFetch.fetch(this.config, '/voucher/get_voucher_list', {
+            method: 'GET',
+            auth: true,
+            params,
+        });
+        return response;
+    }
+}
+//# sourceMappingURL=voucher.manager.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"voucher.manager.js","sourceRoot":"","sources":["../../src/managers/voucher.manager.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAgBhD,OAAO,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAE1C,MAAM,OAAO,cAAe,SAAQ,WAAW;IAC3C,YAAY,MAAoB;QAC9B,KAAK,CAAC,MAAM,CAAC,CAAC;IAChB,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,UAAU,CAAC,MAAwB;QACvC,MAAM,QAAQ,GAAG,MAAM,WAAW,CAAC,KAAK,CACtC,IAAI,CAAC,MAAM,EACX,sBAAsB,EACtB;YACI,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,IAAI;YACV,IAAI,EAAE,MAAM;SACf,CACF,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,aAAa,CAAC,MAA2B;QAC7C,MAAM,QAAQ,GAAG,MAAM,WAAW,CAAC,KAAK,CACtC,IAAI,CAAC,MAAM,EACX,yBAAyB,EACzB;YACI,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,IAAI;YACV,IAAI,EAAE,MAAM;SACf,CACF,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,UAAU,CAAC,MAAwB;QACvC,MAAM,QAAQ,GAAG,MAAM,WAAW,CAAC,KAAK,CACtC,IAAI,CAAC,MAAM,EACX,sBAAsB,EACtB;YACI,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,IAAI;YACV,IAAI,EAAE,MAAM;SACf,CACF,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED;;;;;;;;;;;OAWG;IACH,KAAK,CAAC,aAAa,CAAC,MAA2B;QAC7C,MAAM,QAAQ,GAAG,MAAM,WAAW,CAAC,KAAK,CACtC,IAAI,CAAC,MAAM,EACX,yBAAyB,EACzB;YACI,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,IAAI;YACV,IAAI,EAAE,MAAM;SACf,CACF,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,KAAK,CAAC,UAAU,CAAC,MAAwB;QACvC,MAAM,QAAQ,GAAG,MAAM,WAAW,CAAC,KAAK,CACtC,IAAI,CAAC,MAAM,EACX,sBAAsB,EACtB;YACI,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,IAAI;YACV,MAAM;SACT,CACF,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED;;;;;;;;;;;OAWG;IACH,KAAK,CAAC,cAAc,CAAC,MAA4B;QAC/C,MAAM,QAAQ,GAAG,MAAM,WAAW,CAAC,KAAK,CACtC,IAAI,CAAC,MAAM,EACX,2BAA2B,EAC3B;YACI,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,IAAI;YACV,MAAM;SACT,CACF,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;CACJ"}

package/lib/schemas/access-token.d.ts

@@ -0,0 +1,27 @@
+export interface AccessToken {
+    refresh_token: string;
+    access_token: string;
+    expire_in: number;
+    request_id: string;
+    error: string;
+    message: string;
+    shop_id?: number;
+    merchant_id_list?: number[];
+    shop_id_list?: number[];
+    supplier_id_list?: number[];
+}
+export interface RefreshedAccessToken extends Omit<AccessToken, 'merchant_id_list' | 'shop_id_list' | 'supplier_id_list'> {
+    partner_id: number;
+    shop_id?: number;
+    merchant_id?: number;
+}
+export interface TokenByResendCode {
+    request_id: string;
+    error: string;
+    message: string;
+    shop_id_list?: number[];
+    merchant_id_list?: number[];
+    refresh_token: string;
+    access_token: string;
+    expire_in: number;
+}

package/lib/schemas/access-token.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=access-token.js.map

package/lib/schemas/access-token.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"access-token.js","sourceRoot":"","sources":["../../src/schemas/access-token.ts"],"names":[],"mappings":""}

package/lib/schemas/ads.d.ts

@@ -0,0 +1,62 @@
+import { BaseResponse } from "./base.js";
+/**
+ * Response for the get total balance API
+ */
+export interface GetTotalBalanceResponse extends BaseResponse {
+    response: {
+        /** Timestamp indicating when the total balance snapshot was taken */
+        data_timestamp: number;
+        /** Seller's total ads credit balance, including paid credits and free credits */
+        total_balance: number;
+    };
+    /** Optional warning message if some data cannot be responded normally */
+    warning?: string;
+}
+/**
+ * Response for the get shop toggle info API
+ */
+export interface GetShopToggleInfoResponse extends BaseResponse {
+    response: {
+        /** Timestamp of data in response */
+        data_timestamp: number;
+        /** Auto top-up toggle on/off */
+        auto_top_up: boolean;
+        /** Campaign surge toggle on/off */
+        campaign_surge: boolean;
+    };
+    /** Optional warning message if some data cannot be responded normally */
+    warning?: string;
+}
+/**
+ * Parameters for the get recommended keyword list API
+ */
+export type GetRecommendedKeywordListParams = {
+    /** Shopee's unique identifier for an item */
+    item_id: number;
+    /** The keyword seller typed in the manually add keyword window */
+    input_keyword?: string;
+};
+/**
+ * Response for the get recommended keyword list API
+ */
+export interface GetRecommendedKeywordListResponse extends BaseResponse {
+    response: {
+        /** Shopee's unique identifier for an item */
+        item_id: number;
+        /** The keyword seller typed in the manually add keyword window */
+        input_keyword?: string;
+        /** Suggested keywords recommended from product */
+        suggested_keywords: Array<{
+            /** Keyword value (Only return the highly recommended keywords, will be sightly different from Seller Center) */
+            keyword: string;
+            /** This is a measure of how attractive your ad is and its relevance to the keyword. The higher the quality score, the higher your ad rank. Ad rank is based on this score and your bid price. */
+            quality_score: number;
+            /** The number of times the keyword has been searched on Shopee in the last 30 days. The larger the search volume, the more impressions your ad will receive. */
+            search_volume: number;
+            /** This is bid price suggested by Shopee algorithm for the keyword in local currency. */
+            suggested_bid: number;
+        }>;
+    };
+    /** Optional warning message if some data cannot be responded normally */
+    warning?: string;
+}

package/lib/schemas/ads.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=ads.js.map

package/lib/schemas/ads.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ads.js","sourceRoot":"","sources":["../../src/schemas/ads.ts"],"names":[],"mappings":""}

package/lib/schemas/api-range.d.ts

@@ -0,0 +1 @@
+export type ApiRange = string[];

package/lib/schemas/api-range.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=api-range.js.map

package/lib/schemas/api-range.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"api-range.js","sourceRoot":"","sources":["../../src/schemas/api-range.ts"],"names":[],"mappings":""}

package/lib/schemas/attribute.d.ts

@@ -0,0 +1,33 @@
+export type InputValidationType = 'INT_TYPE' | 'STRING_TYPE' | 'ENUM_TYPE' | 'FLOAT_TYPE' | 'DATE_TYPE' | 'TIMESTAMP_TYPE';
+export type FormatType = 'NORMAL' | 'QUANTITATIVE';
+export type DateFormatType = 'YEAR_MONTH_DATE' | 'YEAR_MONTH';
+export type InputType = 'DROP_DOWN' | 'MULTIPLE_SELECT' | 'TEXT_FILED' | 'COMBO_BOX' | 'MULTIPLE_SELECT_COMBO_BOX';
+export interface AttributeValue {
+    value_id: number;
+    original_value_name: string;
+    display_value_name: string;
+    value_unit?: string;
+    parent_attribute_list: ParentAttribute[];
+    parent_brand_list: ParentBrand[];
+}
+export interface ParentAttribute {
+    parent_attribute_id: number;
+    parent_value_id: number;
+}
+export interface ParentBrand {
+    parent_brand_id: number;
+}
+export interface Attribute {
+    attribute_id: number;
+    original_attribute_name: string;
+    display_attribute_name: string;
+    is_mandatory: boolean;
+    input_validation_type: InputValidationType;
+    format_type: FormatType;
+    date_format_type?: DateFormatType;
+    input_type: InputType;
+    attribute_unit: string[];
+    attribute_value_list: AttributeValue[];
+    max_input_value_number: number;
+    introduction?: string;
+}

package/lib/schemas/attribute.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=attribute.js.map

package/lib/schemas/attribute.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"attribute.js","sourceRoot":"","sources":["../../src/schemas/attribute.ts"],"names":[],"mappings":""}

package/lib/schemas/authed-merchant.d.ts

@@ -0,0 +1,6 @@
+export interface AuthedMerchant {
+    region: string;
+    merchant_id: number;
+    auth_time: number;
+    expire_time: number;
+}

package/lib/schemas/authed-merchant.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=authed-merchant.js.map

package/lib/schemas/authed-merchant.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"authed-merchant.js","sourceRoot":"","sources":["../../src/schemas/authed-merchant.ts"],"names":[],"mappings":""}

package/lib/schemas/authed-shop.d.ts

@@ -0,0 +1,11 @@
+export interface SipAffiliateShop {
+    region: string;
+    affi_shop_id: number;
+}
+export interface AuthedShop {
+    region: string;
+    shop_id: number;
+    auth_time: number;
+    expire_time: number;
+    sip_affi_shops: SipAffiliateShop[];
+}

package/lib/schemas/authed-shop.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=authed-shop.js.map

package/lib/schemas/authed-shop.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"authed-shop.js","sourceRoot":"","sources":["../../src/schemas/authed-shop.ts"],"names":[],"mappings":""}

package/lib/schemas/base.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Base response interface that all API responses extend
+ */
+export interface BaseResponse {
+    /** The identifier for an API request for error tracking */
+    request_id: string;
+    /** Error code if any error occurred */
+    error: string;
+    /** Error message if any error occurred */
+    message: string;
+}

package/lib/schemas/base.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=base.js.map

package/lib/schemas/base.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"base.js","sourceRoot":"","sources":["../../src/schemas/base.ts"],"names":[],"mappings":""}

package/lib/schemas/category.d.ts

@@ -0,0 +1,12 @@
+export interface Category {
+    category_id: number;
+    parent_category_id: number;
+    original_category_name: string;
+    display_category_name: string;
+    has_children: boolean;
+    children?: Category[];
+}
+export interface GetCategoryParams {
+    language?: string;
+    shopId?: number;
+}

package/lib/schemas/category.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=category.js.map

package/lib/schemas/category.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"category.js","sourceRoot":"","sources":["../../src/schemas/category.ts"],"names":[],"mappings":""}

package/lib/schemas/fetch.d.ts

@@ -0,0 +1,13 @@
+import { RequestInit } from 'node-fetch';
+export type FetchOptions = Omit<RequestInit, 'body'> & {
+    params?: Record<string, string | number | boolean | undefined | null | (string | number | boolean)[]>;
+    body?: unknown;
+    auth?: boolean;
+};
+export interface FetchResponse<T> {
+    result: T;
+    response: T;
+    request_id: string;
+    error: string;
+    message: string;
+}

package/lib/schemas/fetch.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=fetch.js.map

package/lib/schemas/fetch.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"fetch.js","sourceRoot":"","sources":["../../src/schemas/fetch.ts"],"names":[],"mappings":""}

package/lib/schemas/index.d.ts

@@ -0,0 +1,11 @@
+export * from './access-token.js';
+export * from './attribute.js';
+export * from './authed-merchant.js';
+export * from './authed-shop.js';
+export * from './category.js';
+export * from './fetch.js';
+export * from './order.js';
+export * from './product.js';
+export * from './public.js';
+export * from './push.js';
+export * from './region.js';

package/lib/schemas/index.js

@@ -0,0 +1,12 @@
+export * from './access-token.js';
+export * from './attribute.js';
+export * from './authed-merchant.js';
+export * from './authed-shop.js';
+export * from './category.js';
+export * from './fetch.js';
+export * from './order.js';
+export * from './product.js';
+export * from './public.js';
+export * from './push.js';
+export * from './region.js';
+//# sourceMappingURL=index.js.map

package/lib/schemas/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/schemas/index.ts"],"names":[],"mappings":"AAAA,cAAc,mBAAmB,CAAC;AAClC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,sBAAsB,CAAC;AACrC,cAAc,kBAAkB,CAAC;AACjC,cAAc,eAAe,CAAC;AAC9B,cAAc,YAAY,CAAC;AAC3B,cAAc,YAAY,CAAC;AAC3B,cAAc,cAAc,CAAC;AAC7B,cAAc,aAAa,CAAC;AAC5B,cAAc,WAAW,CAAC;AAC1B,cAAc,aAAa,CAAC"}