@congminh1254/shopee-sdk 0.10.0 → 1.0.0

package/lib/managers/first-mile.manager.d.ts

@@ -0,0 +1,150 @@
+import { ShopeeConfig } from "../sdk.js";
+import { BaseManager } from "./base.manager.js";
+import { BindCourierDeliveryFirstMileTrackingNumberParams, BindCourierDeliveryFirstMileTrackingNumberResponse, BindFirstMileTrackingNumberParams, BindFirstMileTrackingNumberResponse, GenerateAndBindFirstMileTrackingNumberParams, GenerateAndBindFirstMileTrackingNumberResponse, GenerateFirstMileTrackingNumberParams, GenerateFirstMileTrackingNumberResponse, GetChannelListParams, GetChannelListResponse, GetCourierDeliveryChannelListParams, GetCourierDeliveryChannelListResponse, GetCourierDeliveryDetailParams, GetCourierDeliveryDetailResponse, GetCourierDeliveryTrackingNumberListParams, GetCourierDeliveryTrackingNumberListResponse, GetCourierDeliveryWaybillParams, GetCourierDeliveryWaybillResponse, GetDetailParams, GetDetailResponse, GetTrackingNumberListParams, GetTrackingNumberListResponse, GetTransitWarehouseListParams, GetTransitWarehouseListResponse, GetUnbindOrderListParams, GetUnbindOrderListResponse, GetWaybillParams, GetWaybillResponse, UnbindFirstMileTrackingNumberParams, UnbindFirstMileTrackingNumberResponse, UnbindFirstMileTrackingNumberAllParams, UnbindFirstMileTrackingNumberAllResponse } from "../schemas/first-mile.js";
+export declare class FirstMileManager extends BaseManager {
+    constructor(config: ShopeeConfig);
+    /**
+     * Use this api to bind first mile tracking number for courier delivery method.
+     *
+     * @param params - Parameters for binding courier delivery first mile tracking number
+     * @returns A promise that resolves to the bind response
+     *
+     * @see https://open.shopee.com/documents/v2/v2.first_mile.bind_courier_delivery_first_mile_tracking_number
+     */
+    bindCourierDeliveryFirstMileTrackingNumber(params: BindCourierDeliveryFirstMileTrackingNumberParams): Promise<BindCourierDeliveryFirstMileTrackingNumberResponse>;
+    /**
+     * Use this api to bind first mile tracking number.
+     *
+     * @param params - Parameters for binding first mile tracking number
+     * @returns A promise that resolves to the bind response
+     *
+     * @see https://open.shopee.com/documents/v2/v2.first_mile.bind_first_mile_tracking_number
+     */
+    bindFirstMileTrackingNumber(params: BindFirstMileTrackingNumberParams): Promise<BindFirstMileTrackingNumberResponse>;
+    /**
+     * Use this api to generate first mile tracking number for courier delivery method.
+     *
+     * @param params - Parameters for generating and binding first mile tracking number
+     * @returns A promise that resolves to the generate and bind response
+     *
+     * @see https://open.shopee.com/documents/v2/v2.first_mile.generate_and_bind_first_mile_tracking_number
+     */
+    generateAndBindFirstMileTrackingNumber(params: GenerateAndBindFirstMileTrackingNumberParams): Promise<GenerateAndBindFirstMileTrackingNumberResponse>;
+    /**
+     * Use this api to generate first mile tracking number.
+     *
+     * @param params - Parameters for generating first mile tracking number
+     * @returns A promise that resolves to the generate response
+     *
+     * @see https://open.shopee.com/documents/v2/v2.first_mile.generate_first_mile_tracking_number
+     */
+    generateFirstMileTrackingNumber(params: GenerateFirstMileTrackingNumberParams): Promise<GenerateFirstMileTrackingNumberResponse>;
+    /**
+     * Use this api to get first mile channel list.
+     *
+     * @param params - Parameters for getting channel list (optional region filter)
+     * @returns A promise that resolves to the channel list response
+     *
+     * @see https://open.shopee.com/documents/v2/v2.first_mile.get_channel_list
+     */
+    getChannelList(params?: GetChannelListParams): Promise<GetChannelListResponse>;
+    /**
+     * Use this api to get courier information for courier delivery method.
+     *
+     * @param params - Parameters for getting courier delivery channel list (optional region filter)
+     * @returns A promise that resolves to the courier delivery channel list response
+     *
+     * @see https://open.shopee.com/documents/v2/v2.first_mile.get_courier_delivery_channel_list
+     */
+    getCourierDeliveryChannelList(params?: GetCourierDeliveryChannelListParams): Promise<GetCourierDeliveryChannelListResponse>;
+    /**
+     * Use this api to get first mile detail for courier delivery method.
+     *
+     * @param params - Parameters for getting courier delivery detail
+     * @returns A promise that resolves to the courier delivery detail response
+     *
+     * @see https://open.shopee.com/documents/v2/v2.first_mile.get_courier_delivery_detail
+     */
+    getCourierDeliveryDetail(params: GetCourierDeliveryDetailParams): Promise<GetCourierDeliveryDetailResponse>;
+    /**
+     * Use this api to get tracking number for courier delivery method.
+     *
+     * @param params - Parameters for getting courier delivery tracking number list
+     * @returns A promise that resolves to the courier delivery tracking number list response
+     *
+     * @see https://open.shopee.com/documents/v2/v2.first_mile.get_courier_delivery_tracking_number_list
+     */
+    getCourierDeliveryTrackingNumberList(params: GetCourierDeliveryTrackingNumberListParams): Promise<GetCourierDeliveryTrackingNumberListResponse>;
+    /**
+     * Use this api to get first mile waybill file for courier delivery method.
+     *
+     * @param params - Parameters for getting courier delivery waybill
+     * @returns A promise that resolves to the courier delivery waybill response
+     *
+     * @see https://open.shopee.com/documents/v2/v2.first_mile.get_courier_delivery_waybill
+     */
+    getCourierDeliveryWaybill(params: GetCourierDeliveryWaybillParams): Promise<GetCourierDeliveryWaybillResponse>;
+    /**
+     * Use this api to get first mile detail.
+     *
+     * @param params - Parameters for getting first mile detail
+     * @returns A promise that resolves to the first mile detail response
+     *
+     * @see https://open.shopee.com/documents/v2/v2.first_mile.get_detail
+     */
+    getDetail(params: GetDetailParams): Promise<GetDetailResponse>;
+    /**
+     * Use this api to get first mile tracking number list.
+     *
+     * @param params - Parameters for getting tracking number list
+     * @returns A promise that resolves to the tracking number list response
+     *
+     * @see https://open.shopee.com/documents/v2/v2.first_mile.get_tracking_number_list
+     */
+    getTrackingNumberList(params: GetTrackingNumberListParams): Promise<GetTrackingNumberListResponse>;
+    /**
+     * Use this api to get transit warehouse list which is used for first mile tracking number generation for courier delivery method.
+     *
+     * @param params - Parameters for getting transit warehouse list (optional region filter)
+     * @returns A promise that resolves to the transit warehouse list response
+     *
+     * @see https://open.shopee.com/documents/v2/v2.first_mile.get_transit_warehouse_list
+     */
+    getTransitWarehouseList(params?: GetTransitWarehouseListParams): Promise<GetTransitWarehouseListResponse>;
+    /**
+     * Use this api to get unbind order list.
+     *
+     * @param params - Parameters for getting unbind order list
+     * @returns A promise that resolves to the unbind order list response
+     *
+     * @see https://open.shopee.com/documents/v2/v2.first_mile.get_unbind_order_list
+     */
+    getUnbindOrderList(params?: GetUnbindOrderListParams): Promise<GetUnbindOrderListResponse>;
+    /**
+     * Use this api to get first mile waybill file.
+     *
+     * @param params - Parameters for getting waybill
+     * @returns A promise that resolves to the waybill response
+     *
+     * @see https://open.shopee.com/documents/v2/v2.first_mile.get_waybill
+     */
+    getWaybill(params: GetWaybillParams): Promise<GetWaybillResponse>;
+    /**
+     * Use this api to unbind first mile.
+     *
+     * @param params - Parameters for unbinding first mile tracking number
+     * @returns A promise that resolves to the unbind response
+     *
+     * @see https://open.shopee.com/documents/v2/v2.first_mile.unbind_first_mile_tracking_number
+     */
+    unbindFirstMileTrackingNumber(params: UnbindFirstMileTrackingNumberParams): Promise<UnbindFirstMileTrackingNumberResponse>;
+    /**
+     * Use this api to unbind orders from first mile tracking number or binding ID.
+     *
+     * @param params - Parameters for unbinding all first mile tracking numbers
+     * @returns A promise that resolves to the unbind response
+     *
+     * @see https://open.shopee.com/documents/v2/v2.first_mile.unbind_first_mile_tracking_number_all
+     */
+    unbindFirstMileTrackingNumberAll(params: UnbindFirstMileTrackingNumberAllParams): Promise<UnbindFirstMileTrackingNumberAllResponse>;
+}

package/lib/managers/first-mile.manager.js

@@ -0,0 +1,264 @@
+import { BaseManager } from "./base.manager.js";
+import { ShopeeFetch } from "../fetch.js";
+export class FirstMileManager extends BaseManager {
+    constructor(config) {
+        super(config);
+    }
+    /**
+     * Use this api to bind first mile tracking number for courier delivery method.
+     *
+     * @param params - Parameters for binding courier delivery first mile tracking number
+     * @returns A promise that resolves to the bind response
+     *
+     * @see https://open.shopee.com/documents/v2/v2.first_mile.bind_courier_delivery_first_mile_tracking_number
+     */
+    async bindCourierDeliveryFirstMileTrackingNumber(params) {
+        const response = await ShopeeFetch.fetch(this.config, "/first_mile/bind_courier_delivery_first_mile_tracking_number", {
+            method: "POST",
+            auth: true,
+            body: params,
+        });
+        return response;
+    }
+    /**
+     * Use this api to bind first mile tracking number.
+     *
+     * @param params - Parameters for binding first mile tracking number
+     * @returns A promise that resolves to the bind response
+     *
+     * @see https://open.shopee.com/documents/v2/v2.first_mile.bind_first_mile_tracking_number
+     */
+    async bindFirstMileTrackingNumber(params) {
+        const response = await ShopeeFetch.fetch(this.config, "/first_mile/bind_first_mile_tracking_number", {
+            method: "POST",
+            auth: true,
+            body: params,
+        });
+        return response;
+    }
+    /**
+     * Use this api to generate first mile tracking number for courier delivery method.
+     *
+     * @param params - Parameters for generating and binding first mile tracking number
+     * @returns A promise that resolves to the generate and bind response
+     *
+     * @see https://open.shopee.com/documents/v2/v2.first_mile.generate_and_bind_first_mile_tracking_number
+     */
+    async generateAndBindFirstMileTrackingNumber(params) {
+        const response = await ShopeeFetch.fetch(this.config, "/first_mile/generate_and_bind_first_mile_tracking_number", {
+            method: "POST",
+            auth: true,
+            body: params,
+        });
+        return response;
+    }
+    /**
+     * Use this api to generate first mile tracking number.
+     *
+     * @param params - Parameters for generating first mile tracking number
+     * @returns A promise that resolves to the generate response
+     *
+     * @see https://open.shopee.com/documents/v2/v2.first_mile.generate_first_mile_tracking_number
+     */
+    async generateFirstMileTrackingNumber(params) {
+        const response = await ShopeeFetch.fetch(this.config, "/first_mile/generate_first_mile_tracking_number", {
+            method: "POST",
+            auth: true,
+            body: params,
+        });
+        return response;
+    }
+    /**
+     * Use this api to get first mile channel list.
+     *
+     * @param params - Parameters for getting channel list (optional region filter)
+     * @returns A promise that resolves to the channel list response
+     *
+     * @see https://open.shopee.com/documents/v2/v2.first_mile.get_channel_list
+     */
+    async getChannelList(params) {
+        const response = await ShopeeFetch.fetch(this.config, "/first_mile/get_channel_list", {
+            method: "GET",
+            auth: true,
+            params,
+        });
+        return response;
+    }
+    /**
+     * Use this api to get courier information for courier delivery method.
+     *
+     * @param params - Parameters for getting courier delivery channel list (optional region filter)
+     * @returns A promise that resolves to the courier delivery channel list response
+     *
+     * @see https://open.shopee.com/documents/v2/v2.first_mile.get_courier_delivery_channel_list
+     */
+    async getCourierDeliveryChannelList(params) {
+        const response = await ShopeeFetch.fetch(this.config, "/first_mile/get_courier_delivery_channel_list", {
+            method: "GET",
+            auth: true,
+            params,
+        });
+        return response;
+    }
+    /**
+     * Use this api to get first mile detail for courier delivery method.
+     *
+     * @param params - Parameters for getting courier delivery detail
+     * @returns A promise that resolves to the courier delivery detail response
+     *
+     * @see https://open.shopee.com/documents/v2/v2.first_mile.get_courier_delivery_detail
+     */
+    async getCourierDeliveryDetail(params) {
+        const response = await ShopeeFetch.fetch(this.config, "/first_mile/get_courier_delivery_detail", {
+            method: "GET",
+            auth: true,
+            params,
+        });
+        return response;
+    }
+    /**
+     * Use this api to get tracking number for courier delivery method.
+     *
+     * @param params - Parameters for getting courier delivery tracking number list
+     * @returns A promise that resolves to the courier delivery tracking number list response
+     *
+     * @see https://open.shopee.com/documents/v2/v2.first_mile.get_courier_delivery_tracking_number_list
+     */
+    async getCourierDeliveryTrackingNumberList(params) {
+        const response = await ShopeeFetch.fetch(this.config, "/first_mile/get_courier_delivery_tracking_number_list", {
+            method: "POST",
+            auth: true,
+            body: params,
+        });
+        return response;
+    }
+    /**
+     * Use this api to get first mile waybill file for courier delivery method.
+     *
+     * @param params - Parameters for getting courier delivery waybill
+     * @returns A promise that resolves to the courier delivery waybill response
+     *
+     * @see https://open.shopee.com/documents/v2/v2.first_mile.get_courier_delivery_waybill
+     */
+    async getCourierDeliveryWaybill(params) {
+        const response = await ShopeeFetch.fetch(this.config, "/first_mile/get_courier_delivery_waybill", {
+            method: "POST",
+            auth: true,
+            body: params,
+        });
+        return response;
+    }
+    /**
+     * Use this api to get first mile detail.
+     *
+     * @param params - Parameters for getting first mile detail
+     * @returns A promise that resolves to the first mile detail response
+     *
+     * @see https://open.shopee.com/documents/v2/v2.first_mile.get_detail
+     */
+    async getDetail(params) {
+        const response = await ShopeeFetch.fetch(this.config, "/first_mile/get_detail", {
+            method: "GET",
+            auth: true,
+            params,
+        });
+        return response;
+    }
+    /**
+     * Use this api to get first mile tracking number list.
+     *
+     * @param params - Parameters for getting tracking number list
+     * @returns A promise that resolves to the tracking number list response
+     *
+     * @see https://open.shopee.com/documents/v2/v2.first_mile.get_tracking_number_list
+     */
+    async getTrackingNumberList(params) {
+        const response = await ShopeeFetch.fetch(this.config, "/first_mile/get_tracking_number_list", {
+            method: "GET",
+            auth: true,
+            params,
+        });
+        return response;
+    }
+    /**
+     * Use this api to get transit warehouse list which is used for first mile tracking number generation for courier delivery method.
+     *
+     * @param params - Parameters for getting transit warehouse list (optional region filter)
+     * @returns A promise that resolves to the transit warehouse list response
+     *
+     * @see https://open.shopee.com/documents/v2/v2.first_mile.get_transit_warehouse_list
+     */
+    async getTransitWarehouseList(params) {
+        const response = await ShopeeFetch.fetch(this.config, "/first_mile/get_transit_warehouse_list", {
+            method: "GET",
+            auth: true,
+            params,
+        });
+        return response;
+    }
+    /**
+     * Use this api to get unbind order list.
+     *
+     * @param params - Parameters for getting unbind order list
+     * @returns A promise that resolves to the unbind order list response
+     *
+     * @see https://open.shopee.com/documents/v2/v2.first_mile.get_unbind_order_list
+     */
+    async getUnbindOrderList(params) {
+        const response = await ShopeeFetch.fetch(this.config, "/first_mile/get_unbind_order_list", {
+            method: "GET",
+            auth: true,
+            params,
+        });
+        return response;
+    }
+    /**
+     * Use this api to get first mile waybill file.
+     *
+     * @param params - Parameters for getting waybill
+     * @returns A promise that resolves to the waybill response
+     *
+     * @see https://open.shopee.com/documents/v2/v2.first_mile.get_waybill
+     */
+    async getWaybill(params) {
+        const response = await ShopeeFetch.fetch(this.config, "/first_mile/get_waybill", {
+            method: "POST",
+            auth: true,
+            body: params,
+        });
+        return response;
+    }
+    /**
+     * Use this api to unbind first mile.
+     *
+     * @param params - Parameters for unbinding first mile tracking number
+     * @returns A promise that resolves to the unbind response
+     *
+     * @see https://open.shopee.com/documents/v2/v2.first_mile.unbind_first_mile_tracking_number
+     */
+    async unbindFirstMileTrackingNumber(params) {
+        const response = await ShopeeFetch.fetch(this.config, "/first_mile/unbind_first_mile_tracking_number", {
+            method: "POST",
+            auth: true,
+            body: params,
+        });
+        return response;
+    }
+    /**
+     * Use this api to unbind orders from first mile tracking number or binding ID.
+     *
+     * @param params - Parameters for unbinding all first mile tracking numbers
+     * @returns A promise that resolves to the unbind response
+     *
+     * @see https://open.shopee.com/documents/v2/v2.first_mile.unbind_first_mile_tracking_number_all
+     */
+    async unbindFirstMileTrackingNumberAll(params) {
+        const response = await ShopeeFetch.fetch(this.config, "/first_mile/unbind_first_mile_tracking_number_all", {
+            method: "POST",
+            auth: true,
+            body: params,
+        });
+        return response;
+    }
+}
+//# sourceMappingURL=first-mile.manager.js.map

package/lib/managers/first-mile.manager.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"first-mile.manager.js","sourceRoot":"","sources":["../../src/managers/first-mile.manager.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAmChD,OAAO,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAE1C,MAAM,OAAO,gBAAiB,SAAQ,WAAW;IAC/C,YAAY,MAAoB;QAC9B,KAAK,CAAC,MAAM,CAAC,CAAC;IAChB,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,0CAA0C,CAC9C,MAAwD;QAExD,MAAM,QAAQ,GAAG,MAAM,WAAW,CAAC,KAAK,CACtC,IAAI,CAAC,MAAM,EACX,8DAA8D,EAC9D;YACE,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,IAAI;YACV,IAAI,EAAE,MAAM;SACb,CACF,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,2BAA2B,CAC/B,MAAyC;QAEzC,MAAM,QAAQ,GAAG,MAAM,WAAW,CAAC,KAAK,CACtC,IAAI,CAAC,MAAM,EACX,6CAA6C,EAC7C;YACE,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,IAAI;YACV,IAAI,EAAE,MAAM;SACb,CACF,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,sCAAsC,CAC1C,MAAoD;QAEpD,MAAM,QAAQ,GAAG,MAAM,WAAW,CAAC,KAAK,CACtC,IAAI,CAAC,MAAM,EACX,0DAA0D,EAC1D;YACE,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,IAAI;YACV,IAAI,EAAE,MAAM;SACb,CACF,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,+BAA+B,CACnC,MAA6C;QAE7C,MAAM,QAAQ,GAAG,MAAM,WAAW,CAAC,KAAK,CACtC,IAAI,CAAC,MAAM,EACX,iDAAiD,EACjD;YACE,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,IAAI;YACV,IAAI,EAAE,MAAM;SACb,CACF,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,cAAc,CAAC,MAA6B;QAChD,MAAM,QAAQ,GAAG,MAAM,WAAW,CAAC,KAAK,CACtC,IAAI,CAAC,MAAM,EACX,8BAA8B,EAC9B;YACE,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,IAAI;YACV,MAAM;SACP,CACF,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,6BAA6B,CACjC,MAA4C;QAE5C,MAAM,QAAQ,GAAG,MAAM,WAAW,CAAC,KAAK,CACtC,IAAI,CAAC,MAAM,EACX,+CAA+C,EAC/C;YACE,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,IAAI;YACV,MAAM;SACP,CACF,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,wBAAwB,CAC5B,MAAsC;QAEtC,MAAM,QAAQ,GAAG,MAAM,WAAW,CAAC,KAAK,CACtC,IAAI,CAAC,MAAM,EACX,yCAAyC,EACzC;YACE,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,IAAI;YACV,MAAM;SACP,CACF,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,oCAAoC,CACxC,MAAkD;QAElD,MAAM,QAAQ,GAAG,MAAM,WAAW,CAAC,KAAK,CACtC,IAAI,CAAC,MAAM,EACX,uDAAuD,EACvD;YACE,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,IAAI;YACV,IAAI,EAAE,MAAM;SACb,CACF,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,yBAAyB,CAC7B,MAAuC;QAEvC,MAAM,QAAQ,GAAG,MAAM,WAAW,CAAC,KAAK,CACtC,IAAI,CAAC,MAAM,EACX,0CAA0C,EAC1C;YACE,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,IAAI;YACV,IAAI,EAAE,MAAM;SACb,CACF,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,SAAS,CAAC,MAAuB;QACrC,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;;;;;;;OAOG;IACH,KAAK,CAAC,qBAAqB,CACzB,MAAmC;QAEnC,MAAM,QAAQ,GAAG,MAAM,WAAW,CAAC,KAAK,CACtC,IAAI,CAAC,MAAM,EACX,sCAAsC,EACtC;YACE,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,IAAI;YACV,MAAM;SACP,CACF,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,uBAAuB,CAC3B,MAAsC;QAEtC,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;;;;;;;OAOG;IACH,KAAK,CAAC,kBAAkB,CAAC,MAAiC;QACxD,MAAM,QAAQ,GAAG,MAAM,WAAW,CAAC,KAAK,CACtC,IAAI,CAAC,MAAM,EACX,mCAAmC,EACnC;YACE,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,IAAI;YACV,MAAM;SACP,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,yBAAyB,EACzB;YACE,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,IAAI;YACV,IAAI,EAAE,MAAM;SACb,CACF,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,6BAA6B,CACjC,MAA2C;QAE3C,MAAM,QAAQ,GAAG,MAAM,WAAW,CAAC,KAAK,CACtC,IAAI,CAAC,MAAM,EACX,+CAA+C,EAC/C;YACE,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,IAAI;YACV,IAAI,EAAE,MAAM;SACb,CACF,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,gCAAgC,CACpC,MAA8C;QAE9C,MAAM,QAAQ,GAAG,MAAM,WAAW,CAAC,KAAK,CACtC,IAAI,CAAC,MAAM,EACX,mDAAmD,EACnD;YACE,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,IAAI;YACV,IAAI,EAAE,MAAM;SACb,CACF,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;CACF"}

package/lib/managers/follow-prize.manager.d.ts

@@ -0,0 +1,108 @@
+import { ShopeeConfig } from "../sdk.js";
+import { BaseManager } from "./base.manager.js";
+import { AddFollowPrizeParams, AddFollowPrizeResponse, DeleteFollowPrizeParams, DeleteFollowPrizeResponse, EndFollowPrizeParams, EndFollowPrizeResponse, GetFollowPrizeDetailParams, GetFollowPrizeDetailResponse, GetFollowPrizeListParams, GetFollowPrizeListResponse, UpdateFollowPrizeParams, UpdateFollowPrizeResponse } from "../schemas/follow-prize.js";
+export declare class FollowPrizeManager extends BaseManager {
+    constructor(config: ShopeeConfig);
+    /**
+     * Add a new follow prize activity
+     * @param {AddFollowPrizeParams} params - Parameters for creating a new follow prize
+     * @returns {Promise<AddFollowPrizeResponse>} The response containing the created follow prize ID
+     *
+     * The follow prize allows shops to reward followers with vouchers when they follow the shop.
+     *
+     * @throws {Error} When the API request fails or returns an error
+     * - follow_prize.campaign_num_max_limit: Max number of follow prizes reached (1000 ongoing and upcoming)
+     * - follow_prize.campaign_overlap: Another follow prize already exists during this time period
+     * - follow_prize.name_length_limit: Please input up to 20 characters
+     * - follow_prize.percentage_RANGE: Please enter a value between 1 and 99
+     * - follow_prize.end_time_min_limit: End time must be at least 1 day after start time
+     * - follow_prize.quota_out_range: Please enter a value between 1 and 200000
+     * - follow_prize.start_time_min_limit: Start time must be later than current time
+     * - follow_prize.time_future_limit: Start/end time should not exceed 2037-12-31 23:59:59
+     */
+    addFollowPrize(params: AddFollowPrizeParams): Promise<AddFollowPrizeResponse>;
+    /**
+     * Delete an existing follow prize activity
+     * @param {DeleteFollowPrizeParams} params - Parameters for deleting a follow prize
+     * @returns {Promise<DeleteFollowPrizeResponse>} The response containing the deleted follow prize ID
+     *
+     * @throws {Error} When the API request fails or returns an error
+     * - follow_prize.campaign_none: The promotion id does not exist
+     * - follow_prize.delete_type: Only upcoming promotions can be deleted
+     */
+    deleteFollowPrize(params: DeleteFollowPrizeParams): Promise<DeleteFollowPrizeResponse>;
+    /**
+     * End an ongoing follow prize activity immediately
+     * @param {EndFollowPrizeParams} params - Parameters for ending a follow prize
+     * @returns {Promise<EndFollowPrizeResponse>} The response containing the ended follow prize ID
+     *
+     * @throws {Error} When the API request fails or returns an error
+     * - follow_prize.campaign_none: The promotion id does not exist
+     * - follow_prize.end_type: Only ongoing follow prizes can be ended
+     */
+    endFollowPrize(params: EndFollowPrizeParams): Promise<EndFollowPrizeResponse>;
+    /**
+     * Get detailed information about a follow prize activity
+     * @param {GetFollowPrizeDetailParams} params - Parameters for getting follow prize details
+     * @returns {Promise<GetFollowPrizeDetailResponse>} The response containing comprehensive follow prize information
+     *
+     * The response includes:
+     * - campaign_status: The status of the follow prize (upcoming/ongoing/expired)
+     * - campaign_id: The unique identifier for the follow prize
+     * - follow_prize_name: The name of the follow prize
+     * - start_time: When the follow prize becomes valid
+     * - end_time: When the follow prize expires
+     * - usage_quantity: The total quantity available
+     * - min_spend: Minimum basket price required
+     * - reward_type: Type of reward (1: fix amount, 2: percentage, 3: coin cash back)
+     * - discount_amount/percentage/max_price: Reward details based on reward_type
+     *
+     * @throws {Error} When the API request fails or returns an error
+     * - follow_prize.campaign_none: The promotion id does not exist
+     */
+    getFollowPrizeDetail(params: GetFollowPrizeDetailParams): Promise<GetFollowPrizeDetailResponse>;
+    /**
+     * Get a list of follow prize activities with pagination
+     * @param {GetFollowPrizeListParams} params - Parameters for retrieving follow prize list
+     * @param {FollowPrizeStatus} params.status - Filter by follow prize status (upcoming/ongoing/expired/all)
+     * @param {number} [params.page_no] - Page number to retrieve (default: 1)
+     * @param {number} [params.page_size] - Number of items per page (default: 20, max: 100)
+     * @returns {Promise<GetFollowPrizeListResponse>} The response containing a paginated list of follow prizes
+     *
+     * The response includes:
+     * - more: Boolean indicating if there are more pages
+     * - follow_prize_list: Array of follow prize information containing:
+     *   - campaign_id: The unique identifier
+     *   - campaign_status: Current status
+     *   - follow_prize_name: Name of the follow prize
+     *   - start_time/end_time: Validity period
+     *   - usage_quantity: Total quantity
+     *   - claimed: Quantity already claimed
+     */
+    getFollowPrizeList(params: GetFollowPrizeListParams): Promise<GetFollowPrizeListResponse>;
+    /**
+     * Update an existing follow prize activity
+     * @param {UpdateFollowPrizeParams} params - Parameters for updating a follow prize
+     * @returns {Promise<UpdateFollowPrizeResponse>} The response containing the updated follow prize ID
+     *
+     * Update restrictions:
+     * - Cannot rename ongoing follow prizes
+     * - Cannot update minimum basket price for ongoing follow prizes
+     * - Cannot update start time for ongoing follow prizes
+     * - Start time can only be changed to a later timing (for upcoming)
+     * - End time can only be changed to an earlier timing
+     * - Cannot reduce dispatch quantity
+     * - Cannot update expired follow prizes
+     *
+     * @throws {Error} When the API request fails or returns an error
+     * - follow_prize.campaign_none: The promotion id does not exist
+     * - follow_prize.update_expired_campaign: Cannot update expired follow prizes
+     * - follow_prize.update_prize_name_ongoing: Cannot rename ongoing follow prizes
+     * - follow_prize.update_min_spend_ongoing: Cannot update minimum basket price for ongoing
+     * - follow_prize.update_start_time_ongoing: Cannot update start time for ongoing
+     * - follow_prize.update_start_time_earlier: Start time can only be changed to later
+     * - follow_prize.update_end_time_later: End time can only be changed to earlier
+     * - follow_prize.update_quantity_reduce: Cannot reduce dispatch quantity
+     */
+    updateFollowPrize(params: UpdateFollowPrizeParams): Promise<UpdateFollowPrizeResponse>;
+}