@congminh1254/shopee-sdk 1.4.0 → 1.5.3

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

@@ -0,0 +1,166 @@
+import { BaseManager } from "./base.manager.js";
+import { ShopeeConfig } from "../sdk.js";
+import { DeleteVideoParams, DeleteVideoResponse, EditVideoInfoParams, EditVideoInfoResponse, GetCoverListParams, GetCoverListResponse, GetMetricTrendParams, GetMetricTrendResponse, GetOverviewPerformanceParams, GetOverviewPerformanceResponse, GetProductPerformanceListParams, GetProductPerformanceListResponse, GetUserDemographicsParams, GetUserDemographicsResponse, GetVideoDetailParams, GetVideoDetailResponse, GetVideoDetailAudienceDistributionParams, GetVideoDetailAudienceDistributionResponse, GetVideoDetailMetricTrendParams, GetVideoDetailMetricTrendResponse, GetVideoDetailPerformanceParams, GetVideoDetailPerformanceResponse, GetVideoDetailProductPerformanceParams, GetVideoDetailProductPerformanceResponse, GetVideoListParams, GetVideoListResponse, GetVideoPerformanceListParams, GetVideoPerformanceListResponse, PostVideoParams, PostVideoResponse } from "../schemas/video.js";
+export declare class VideoManager extends BaseManager {
+    constructor(config: ShopeeConfig);
+    /**
+     * Delete video
+     *
+     * Use this API to delete videos. You can delete videos with draft status or post status.
+     *
+     * @param params - Parameters for deleting video
+     * @param params.videoUploadIdList - List of video_upload_ids to delete (for draft status)
+     * @param params.postIdList - List of post_ids to delete (for post status)
+     *
+     * @returns A promise that resolves to the delete response containing:
+     * - successList: List of videos deleted successfully
+     * - failureList: List of videos that failed to delete
+     */
+    deleteVideo(params: DeleteVideoParams): Promise<DeleteVideoResponse>;
+    /**
+     * Edit video information
+     *
+     * Use this API to edit video information including caption, cover image, linked products, and schedule settings.
+     *
+     * @param params - Parameters for editing video info
+     * @param params.videoUploadList - List of videos to edit (max 5)
+     *
+     * @returns A promise that resolves to the edit response containing:
+     * - successList: List of video_upload_ids edited successfully
+     * - failureList: List of video_upload_ids that failed to edit
+     */
+    editVideoInfo(params: EditVideoInfoParams): Promise<EditVideoInfoResponse>;
+    /**
+     * Get cover list
+     *
+     * Use this API to get available cover images for a video.
+     *
+     * @param params - Parameters for getting cover list
+     * @param params.videoUploadId - ID of uploaded video
+     *
+     * @returns A promise that resolves to the cover list response
+     */
+    getCoverList(params: GetCoverListParams): Promise<GetCoverListResponse>;
+    /**
+     * Get metric trend
+     *
+     * Use this API to get metric trends for videos over a time period.
+     *
+     * @param params - Parameters for getting metric trend
+     *
+     * @returns A promise that resolves to the metric trend response
+     */
+    getMetricTrend(params: GetMetricTrendParams): Promise<GetMetricTrendResponse>;
+    /**
+     * Get overview performance
+     *
+     * Use this API to get overview performance metrics for videos.
+     *
+     * @param params - Parameters for getting overview performance
+     *
+     * @returns A promise that resolves to the overview performance response
+     */
+    getOverviewPerformance(params: GetOverviewPerformanceParams): Promise<GetOverviewPerformanceResponse>;
+    /**
+     * Get product performance list
+     *
+     * Use this API to get performance metrics for products linked to videos.
+     *
+     * @param params - Parameters for getting product performance list
+     *
+     * @returns A promise that resolves to the product performance list response
+     */
+    getProductPerformanceList(params: GetProductPerformanceListParams): Promise<GetProductPerformanceListResponse>;
+    /**
+     * Get user demographics
+     *
+     * Use this API to get demographic information of video viewers.
+     *
+     * @param params - Optional parameters (currently no parameters required)
+     *
+     * @returns A promise that resolves to the user demographics response
+     */
+    getUserDemographics(params?: GetUserDemographicsParams): Promise<GetUserDemographicsResponse>;
+    /**
+     * Get video detail
+     *
+     * Use this API to get detailed information about a video.
+     *
+     * @param params - Parameters for getting video detail
+     *
+     * @returns A promise that resolves to the video detail response
+     */
+    getVideoDetail(params: GetVideoDetailParams): Promise<GetVideoDetailResponse>;
+    /**
+     * Get video detail audience distribution
+     *
+     * Use this API to get audience distribution for a specific video.
+     *
+     * @param params - Parameters for getting video detail audience distribution
+     *
+     * @returns A promise that resolves to the video detail audience distribution response
+     */
+    getVideoDetailAudienceDistribution(params: GetVideoDetailAudienceDistributionParams): Promise<GetVideoDetailAudienceDistributionResponse>;
+    /**
+     * Get video detail metric trend
+     *
+     * Use this API to get metric trends for a specific video.
+     *
+     * @param params - Parameters for getting video detail metric trend
+     *
+     * @returns A promise that resolves to the video detail metric trend response
+     */
+    getVideoDetailMetricTrend(params: GetVideoDetailMetricTrendParams): Promise<GetVideoDetailMetricTrendResponse>;
+    /**
+     * Get video detail performance
+     *
+     * Use this API to get performance metrics for a specific video.
+     *
+     * @param params - Parameters for getting video detail performance
+     *
+     * @returns A promise that resolves to the video detail performance response
+     */
+    getVideoDetailPerformance(params: GetVideoDetailPerformanceParams): Promise<GetVideoDetailPerformanceResponse>;
+    /**
+     * Get video detail product performance
+     *
+     * Use this API to get performance metrics for products linked to a specific video.
+     *
+     * @param params - Parameters for getting video detail product performance
+     *
+     * @returns A promise that resolves to the video detail product performance response
+     */
+    getVideoDetailProductPerformance(params: GetVideoDetailProductPerformanceParams): Promise<GetVideoDetailProductPerformanceResponse>;
+    /**
+     * Get video list
+     *
+     * Use this API to get a list of videos.
+     *
+     * @param params - Parameters for getting video list
+     *
+     * @returns A promise that resolves to the video list response
+     */
+    getVideoList(params: GetVideoListParams): Promise<GetVideoListResponse>;
+    /**
+     * Get video performance list
+     *
+     * Use this API to get performance metrics for multiple videos.
+     *
+     * @param params - Parameters for getting video performance list
+     *
+     * @returns A promise that resolves to the video performance list response
+     */
+    getVideoPerformanceList(params: GetVideoPerformanceListParams): Promise<GetVideoPerformanceListResponse>;
+    /**
+     * Post video
+     *
+     * Use this API to post videos to Shopee Video.
+     *
+     * @param params - Parameters for posting video
+     *
+     * @returns A promise that resolves to the post video response containing:
+     * - successList: List of videos posted successfully
+     * - failureList: List of videos that failed to post
+     */
+    postVideo(params: PostVideoParams): Promise<PostVideoResponse>;
+}

package/lib/managers/video.manager.js

@@ -0,0 +1,273 @@
+import { BaseManager } from "./base.manager.js";
+import { ShopeeFetch } from "../fetch.js";
+export class VideoManager extends BaseManager {
+    constructor(config) {
+        super(config);
+    }
+    /**
+     * Delete video
+     *
+     * Use this API to delete videos. You can delete videos with draft status or post status.
+     *
+     * @param params - Parameters for deleting video
+     * @param params.videoUploadIdList - List of video_upload_ids to delete (for draft status)
+     * @param params.postIdList - List of post_ids to delete (for post status)
+     *
+     * @returns A promise that resolves to the delete response containing:
+     * - successList: List of videos deleted successfully
+     * - failureList: List of videos that failed to delete
+     */
+    async deleteVideo(params) {
+        const response = await ShopeeFetch.fetch(this.config, `/video/delete_video`, {
+            method: "POST",
+            auth: true,
+            body: params,
+        });
+        return response;
+    }
+    /**
+     * Edit video information
+     *
+     * Use this API to edit video information including caption, cover image, linked products, and schedule settings.
+     *
+     * @param params - Parameters for editing video info
+     * @param params.videoUploadList - List of videos to edit (max 5)
+     *
+     * @returns A promise that resolves to the edit response containing:
+     * - successList: List of video_upload_ids edited successfully
+     * - failureList: List of video_upload_ids that failed to edit
+     */
+    async editVideoInfo(params) {
+        const response = await ShopeeFetch.fetch(this.config, `/video/edit_video_info`, {
+            method: "POST",
+            auth: true,
+            body: params,
+        });
+        return response;
+    }
+    /**
+     * Get cover list
+     *
+     * Use this API to get available cover images for a video.
+     *
+     * @param params - Parameters for getting cover list
+     * @param params.videoUploadId - ID of uploaded video
+     *
+     * @returns A promise that resolves to the cover list response
+     */
+    async getCoverList(params) {
+        const response = await ShopeeFetch.fetch(this.config, `/video/get_cover_list`, {
+            method: "GET",
+            auth: true,
+            params: params,
+        });
+        return response;
+    }
+    /**
+     * Get metric trend
+     *
+     * Use this API to get metric trends for videos over a time period.
+     *
+     * @param params - Parameters for getting metric trend
+     *
+     * @returns A promise that resolves to the metric trend response
+     */
+    async getMetricTrend(params) {
+        const response = await ShopeeFetch.fetch(this.config, `/video/get_metric_trend`, {
+            method: "GET",
+            auth: true,
+            params: params,
+        });
+        return response;
+    }
+    /**
+     * Get overview performance
+     *
+     * Use this API to get overview performance metrics for videos.
+     *
+     * @param params - Parameters for getting overview performance
+     *
+     * @returns A promise that resolves to the overview performance response
+     */
+    async getOverviewPerformance(params) {
+        const response = await ShopeeFetch.fetch(this.config, `/video/get_overview_performance`, {
+            method: "GET",
+            auth: true,
+            params: params,
+        });
+        return response;
+    }
+    /**
+     * Get product performance list
+     *
+     * Use this API to get performance metrics for products linked to videos.
+     *
+     * @param params - Parameters for getting product performance list
+     *
+     * @returns A promise that resolves to the product performance list response
+     */
+    async getProductPerformanceList(params) {
+        const response = await ShopeeFetch.fetch(this.config, `/video/get_product_performance_list`, {
+            method: "GET",
+            auth: true,
+            params: params,
+        });
+        return response;
+    }
+    /**
+     * Get user demographics
+     *
+     * Use this API to get demographic information of video viewers.
+     *
+     * @param params - Optional parameters (currently no parameters required)
+     *
+     * @returns A promise that resolves to the user demographics response
+     */
+    async getUserDemographics(params) {
+        const response = await ShopeeFetch.fetch(this.config, `/video/get_user_demographics`, {
+            method: "GET",
+            auth: true,
+            params: (params || {}),
+        });
+        return response;
+    }
+    /**
+     * Get video detail
+     *
+     * Use this API to get detailed information about a video.
+     *
+     * @param params - Parameters for getting video detail
+     *
+     * @returns A promise that resolves to the video detail response
+     */
+    async getVideoDetail(params) {
+        const response = await ShopeeFetch.fetch(this.config, `/video/get_video_detail`, {
+            method: "GET",
+            auth: true,
+            params: params,
+        });
+        return response;
+    }
+    /**
+     * Get video detail audience distribution
+     *
+     * Use this API to get audience distribution for a specific video.
+     *
+     * @param params - Parameters for getting video detail audience distribution
+     *
+     * @returns A promise that resolves to the video detail audience distribution response
+     */
+    async getVideoDetailAudienceDistribution(params) {
+        const response = await ShopeeFetch.fetch(this.config, `/video/get_video_detail_audience_distribution`, {
+            method: "GET",
+            auth: true,
+            params: params,
+        });
+        return response;
+    }
+    /**
+     * Get video detail metric trend
+     *
+     * Use this API to get metric trends for a specific video.
+     *
+     * @param params - Parameters for getting video detail metric trend
+     *
+     * @returns A promise that resolves to the video detail metric trend response
+     */
+    async getVideoDetailMetricTrend(params) {
+        const response = await ShopeeFetch.fetch(this.config, `/video/get_video_detail_metric_trend`, {
+            method: "GET",
+            auth: true,
+            params: params,
+        });
+        return response;
+    }
+    /**
+     * Get video detail performance
+     *
+     * Use this API to get performance metrics for a specific video.
+     *
+     * @param params - Parameters for getting video detail performance
+     *
+     * @returns A promise that resolves to the video detail performance response
+     */
+    async getVideoDetailPerformance(params) {
+        const response = await ShopeeFetch.fetch(this.config, `/video/get_video_detail_performance`, {
+            method: "GET",
+            auth: true,
+            params: params,
+        });
+        return response;
+    }
+    /**
+     * Get video detail product performance
+     *
+     * Use this API to get performance metrics for products linked to a specific video.
+     *
+     * @param params - Parameters for getting video detail product performance
+     *
+     * @returns A promise that resolves to the video detail product performance response
+     */
+    async getVideoDetailProductPerformance(params) {
+        const response = await ShopeeFetch.fetch(this.config, `/video/get_video_detail_product_performance`, {
+            method: "GET",
+            auth: true,
+            params: params,
+        });
+        return response;
+    }
+    /**
+     * Get video list
+     *
+     * Use this API to get a list of videos.
+     *
+     * @param params - Parameters for getting video list
+     *
+     * @returns A promise that resolves to the video list response
+     */
+    async getVideoList(params) {
+        const response = await ShopeeFetch.fetch(this.config, `/video/get_video_list`, {
+            method: "GET",
+            auth: true,
+            params: params,
+        });
+        return response;
+    }
+    /**
+     * Get video performance list
+     *
+     * Use this API to get performance metrics for multiple videos.
+     *
+     * @param params - Parameters for getting video performance list
+     *
+     * @returns A promise that resolves to the video performance list response
+     */
+    async getVideoPerformanceList(params) {
+        const response = await ShopeeFetch.fetch(this.config, `/video/get_video_performance_list`, {
+            method: "GET",
+            auth: true,
+            params: params,
+        });
+        return response;
+    }
+    /**
+     * Post video
+     *
+     * Use this API to post videos to Shopee Video.
+     *
+     * @param params - Parameters for posting video
+     *
+     * @returns A promise that resolves to the post video response containing:
+     * - successList: List of videos posted successfully
+     * - failureList: List of videos that failed to post
+     */
+    async postVideo(params) {
+        const response = await ShopeeFetch.fetch(this.config, `/video/post_video`, {
+            method: "POST",
+            auth: true,
+            body: params,
+        });
+        return response;
+    }
+}
+//# sourceMappingURL=video.manager.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"video.manager.js","sourceRoot":"","sources":["../../src/managers/video.manager.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAEhD,OAAO,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAkC1C,MAAM,OAAO,YAAa,SAAQ,WAAW;IAC3C,YAAY,MAAoB;QAC9B,KAAK,CAAC,MAAM,CAAC,CAAC;IAChB,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,KAAK,CAAC,WAAW,CAAC,MAAyB;QACzC,MAAM,QAAQ,GAAG,MAAM,WAAW,CAAC,KAAK,CACtC,IAAI,CAAC,MAAM,EACX,qBAAqB,EACrB;YACE,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,IAAI;YACV,IAAI,EAAE,MAAM;SACb,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,wBAAwB,EACxB;YACE,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,IAAI;YACV,IAAI,EAAE,MAAM;SACb,CACF,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED;;;;;;;;;OASG;IACH,KAAK,CAAC,YAAY,CAAC,MAA0B;QAC3C,MAAM,QAAQ,GAAG,MAAM,WAAW,CAAC,KAAK,CACtC,IAAI,CAAC,MAAM,EACX,uBAAuB,EACvB;YACE,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,IAAI;YACV,MAAM,EAAE,MAGP;SACF,CACF,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,cAAc,CAAC,MAA4B;QAC/C,MAAM,QAAQ,GAAG,MAAM,WAAW,CAAC,KAAK,CACtC,IAAI,CAAC,MAAM,EACX,yBAAyB,EACzB;YACE,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,IAAI;YACV,MAAM,EAAE,MAGP;SACF,CACF,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,sBAAsB,CAC1B,MAAoC;QAEpC,MAAM,QAAQ,GAAG,MAAM,WAAW,CAAC,KAAK,CACtC,IAAI,CAAC,MAAM,EACX,iCAAiC,EACjC;YACE,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,IAAI;YACV,MAAM,EAAE,MAGP;SACF,CACF,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,yBAAyB,CAC7B,MAAuC;QAEvC,MAAM,QAAQ,GAAG,MAAM,WAAW,CAAC,KAAK,CACtC,IAAI,CAAC,MAAM,EACX,qCAAqC,EACrC;YACE,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,IAAI;YACV,MAAM,EAAE,MAGP;SACF,CACF,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,mBAAmB,CACvB,MAAkC;QAElC,MAAM,QAAQ,GAAG,MAAM,WAAW,CAAC,KAAK,CACtC,IAAI,CAAC,MAAM,EACX,8BAA8B,EAC9B;YACE,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,IAAI;YACV,MAAM,EAAE,CAAC,MAAM,IAAI,EAAE,CAGpB;SACF,CACF,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,cAAc,CAAC,MAA4B;QAC/C,MAAM,QAAQ,GAAG,MAAM,WAAW,CAAC,KAAK,CACtC,IAAI,CAAC,MAAM,EACX,yBAAyB,EACzB;YACE,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,IAAI;YACV,MAAM,EAAE,MAGP;SACF,CACF,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,kCAAkC,CACtC,MAAgD;QAEhD,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,EAAE,MAGP;SACF,CACF,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,yBAAyB,CAC7B,MAAuC;QAEvC,MAAM,QAAQ,GAAG,MAAM,WAAW,CAAC,KAAK,CACtC,IAAI,CAAC,MAAM,EACX,sCAAsC,EACtC;YACE,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,IAAI;YACV,MAAM,EAAE,MAGP;SACF,CACF,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,yBAAyB,CAC7B,MAAuC;QAEvC,MAAM,QAAQ,GAAG,MAAM,WAAW,CAAC,KAAK,CACtC,IAAI,CAAC,MAAM,EACX,qCAAqC,EACrC;YACE,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,IAAI;YACV,MAAM,EAAE,MAGP;SACF,CACF,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,gCAAgC,CACpC,MAA8C;QAE9C,MAAM,QAAQ,GAAG,MAAM,WAAW,CAAC,KAAK,CACtC,IAAI,CAAC,MAAM,EACX,6CAA6C,EAC7C;YACE,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,IAAI;YACV,MAAM,EAAE,MAGP;SACF,CACF,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,YAAY,CAAC,MAA0B;QAC3C,MAAM,QAAQ,GAAG,MAAM,WAAW,CAAC,KAAK,CACtC,IAAI,CAAC,MAAM,EACX,uBAAuB,EACvB;YACE,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,IAAI;YACV,MAAM,EAAE,MAGP;SACF,CACF,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,uBAAuB,CAC3B,MAAqC;QAErC,MAAM,QAAQ,GAAG,MAAM,WAAW,CAAC,KAAK,CACtC,IAAI,CAAC,MAAM,EACX,mCAAmC,EACnC;YACE,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,IAAI;YACV,MAAM,EAAE,MAGP;SACF,CACF,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED;;;;;;;;;;OAUG;IACH,KAAK,CAAC,SAAS,CAAC,MAAuB;QACrC,MAAM,QAAQ,GAAG,MAAM,WAAW,CAAC,KAAK,CAAoB,IAAI,CAAC,MAAM,EAAE,mBAAmB,EAAE;YAC5F,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,IAAI;YACV,IAAI,EAAE,MAAM;SACb,CAAC,CAAC;QAEH,OAAO,QAAQ,CAAC;IAClB,CAAC;CACF"}

package/lib/schemas/logistics.d.ts

@@ -733,20 +733,20 @@ export interface CreateShippingDocumentResponse extends BaseResponse {
  * Parameters for download shipping document
  */
 export type DownloadShippingDocumentParams = {
-    /** List of order SNs */
-    order_sn_list: string[];
+    /** List of orders to download documents for */
+    order_list: Array<{
+        /** Order SN */
+        order_sn: string;
+        /** Package number (optional) */
+        package_number?: string;
+    }>;
     /** Document type */
     shipping_document_type: string;
-} & Record<string, string | number | boolean | null | undefined>;
+};
 /**
- * Response for download shipping document API
+ * Response for download shipping document API (returns raw binary PDF)
  */
-export interface DownloadShippingDocumentResponse extends BaseResponse {
-    response?: {
-        /** URL to download document */
-        result?: string;
-    };
-}
+export type DownloadShippingDocumentResponse = Buffer;
 /**
  * Parameters for get shipping document parameter
  */
@@ -835,14 +835,9 @@ export type DownloadBookingShippingDocumentParams = {
     shipping_document_type: string;
 } & Record<string, string | number | boolean | null | undefined>;
 /**
- * Response for download booking shipping document API
+ * Response for download booking shipping document API (returns raw binary PDF)
  */
-export interface DownloadBookingShippingDocumentResponse extends BaseResponse {
-    response?: {
-        /** URL to download document */
-        result?: string;
-    };
-}
+export type DownloadBookingShippingDocumentResponse = Buffer;
 /**
  * Parameters for get booking shipping document parameter
  */
@@ -1134,3 +1129,70 @@ export type BatchUpdateTPFWarehouseTrackingStatusParams = {
 export interface BatchUpdateTPFWarehouseTrackingStatusResponse extends BaseResponse {
     response?: Record<string, never>;
 }
+/**
+ * Parameters for check polygon update status
+ */
+export type CheckPolygonUpdateStatusParams = {
+    /** ID that needs to be checked. Please pass the task_id returned via the v2.logistics.upload_serviceable_polygon. */
+    task_id: string;
+} & Record<string, string | number | boolean | object | null | undefined>;
+/**
+ * Response for check polygon update status API
+ */
+export interface CheckPolygonUpdateStatusResponse extends BaseResponse {
+    response?: {
+        /** Serviceable polygon file upload status. 0: Task completed, 1: Task in progress, 2: KML file related errors */
+        status?: number;
+        /** Details of the upload status, e.g "task in progress" */
+        message?: string;
+    };
+}
+/**
+ * Parameters for update address
+ */
+export type UpdateAddressParams = {
+    /** Unique identifier for the address. You can get the address_id via v2.logistics.get_address_list. */
+    address_id: number;
+    /** The region of the address. Note: Do not allow to update the region of the address. */
+    region?: string;
+    /** The state of the address. */
+    state?: string;
+    /** The city of the address. */
+    city?: string;
+    /** The district of the address. */
+    district?: string;
+    /** The town of the address. */
+    town?: string;
+    /** The detailed address description of the address. */
+    address?: string;
+    /** The zipcode of the address. */
+    zipcode?: string;
+    /** Recipient's name at this address. */
+    name?: string;
+    /** Contact phone number for the recipient. */
+    phone?: string;
+    /** Geolocation information for the address. Type: JSON string. To clear existing geo info, pass "" or {}. To keep existing geo info, do not include this field. */
+    geo_info?: string;
+} & Record<string, string | number | boolean | object | null | undefined>;
+/**
+ * Response for update address API
+ */
+export interface UpdateAddressResponse extends BaseResponse {
+    response?: Record<string, never>;
+}
+/**
+ * Parameters for upload serviceable polygon
+ */
+export type UploadServiceablePolygonParams = {
+    /** The .kml file to be uploaded to denote the serviceability area of the shops. */
+    file: File | Blob;
+} & Record<string, string | number | boolean | object | null | undefined>;
+/**
+ * Response for upload serviceable polygon API
+ */
+export interface UploadServiceablePolygonResponse extends BaseResponse {
+    response?: {
+        /** Use the task_id to call v2.logistics.check_polygon_update_status to check if the upload job has been completed. */
+        task_id?: string;
+    };
+}

package/lib/schemas/order.js.map

@@ -1 +1 @@
-{"version":3,"file":"order.js","sourceRoot":"","sources":["../../src/schemas/order.ts"],"names":[],"mappings":"AAoXA,MAAM,CAAC,MAAM,iBAAiB,GAC5B,qbAAqb,CAAC"}
+{"version":3,"file":"order.js","sourceRoot":"","sources":["../../src/schemas/order.ts"],"names":[],"mappings":"AAmXA,MAAM,CAAC,MAAM,iBAAiB,GAC5B,qbAAqb,CAAC"}

package/lib/schemas/payment.d.ts

@@ -366,28 +366,41 @@ export interface GetEscrowDetailBatchResponse extends BaseResponse {
  * Parameters for getting wallet transaction list
  */
 export type GetWalletTransactionListParams = {
+    /** Specifies the starting entry of data to return in the current call. Default is 1 */
+    page_no: number;
+    /** The number of records returned per page, min 1, max 100, default 40 */
+    page_size: number;
     /** The start time of the query, timestamp */
-    create_time_from: number;
+    create_time_from?: number;
     /** The end time of the query, timestamp */
-    create_time_to: number;
-    /** Offset for pagination, start from 0 */
-    page_no?: number;
-    /** The number of records returned per page, min 1, max 100, default 40 */
-    page_size?: number;
-    /** Transaction types filter */
-    transaction_type?: number;
+    create_time_to?: number;
+    /** This field indicates the wallet type */
+    wallet_type?: string;
+    /** Transaction type filter */
+    transaction_type?: string;
+    /** Indicates whether user wants to return only MONEY_IN or MONEY_OUT transactions */
+    money_flow?: string;
+    /** Transaction tab type filter. Only 1 value can be provided per request */
+    transaction_tab_type?: string;
 };
+/**
+ * Pay order item within a wallet transaction
+ */
+export interface WalletTransactionPayOrder {
+    /** Shopee's unique identifier for an order */
+    order_sn: string;
+    /** Name of the shop */
+    shop_name: string;
+}
 /**
  * Wallet transaction item
  */
 export interface WalletTransaction {
-    /** Transaction ID */
-    transaction_id: number;
-    /** Transaction type */
-    transaction_type: string;
     /** Transaction status */
     status: string;
-    /** Amount */
+    /** Transaction type */
+    transaction_type: string;
+    /** Transaction amount */
     amount: number;
     /** Current balance after this transaction */
     current_balance: number;
@@ -395,10 +408,32 @@ export interface WalletTransaction {
     create_time: number;
     /** Order SN if related to order */
     order_sn?: string;
+    /** The serial number of return */
+    refund_sn?: string;
+    /** The type of withdrawal */
+    withdrawal_type?: string;
+    /** Transaction fee */
+    transaction_fee?: number;
+    /** Detailed description of TOPUP SUCCESS and TOPUP FAILED */
+    description?: string;
+    /** The name of buyer */
+    buyer_name?: string;
+    /** List of pay orders associated with this transaction */
+    pay_order_list?: WalletTransactionPayOrder[];
+    /** Name of the shop */
+    shop_name?: string;
     /** Withdrawal ID if related to withdrawal */
     withdrawal_id?: number;
     /** Reason for transaction */
-    reason: string;
+    reason?: string;
+    /** Indicates the event where a withdrawal is split into several withdrawals due to withdrawal limit */
+    root_withdrawal_id?: number;
+    /** Updated transaction tab type */
+    transaction_tab_type?: string;
+    /** Money flow direction: MONEY_IN or MONEY_OUT */
+    money_flow?: string;
+    /** The outlet shop name where this outlet transaction came from */
+    outlet_shop_name?: string;
 }
 /**
  * Response for get wallet transaction list API