@congminh1254/shopee-sdk 1.4.0 → 1.5.2

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

@@ -1134,3 +1134,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/product.d.ts

@@ -1912,3 +1912,142 @@ export interface SearchUnpackagedModelListResponse extends FetchResponse<{
     model_list: any[];
 }> {
 }
+/**
+ * Parameters for get mart item mapping by id
+ */
+export type GetMartItemMappingByIdParams = {
+    /** The item ID of the item in the Mart shop */
+    mart_item_id: number;
+    /** A list of outlet shop IDs used to filter the mapping results */
+    outlet_shop_id_list: number[];
+};
+/**
+ * Model mapping information
+ */
+export interface ModelMapping {
+    /** The model ID of the product in the Mart shop */
+    mart_model_id?: number;
+    /** The model ID of the corresponding product in the outlet shop */
+    outlet_model_id?: number;
+}
+/**
+ * Item mapping information
+ */
+export interface ItemMapping {
+    /** The item ID of the item in the Mart shop */
+    mart_item_id?: number;
+    /** The item ID of the corresponding item in the outlet shop */
+    outlet_item_id?: number;
+    /** The mapping relationship between Mart models and outlet models under the mapped items */
+    model_mapping?: ModelMapping[];
+}
+/**
+ * Response for get mart item mapping by id API
+ */
+export interface GetMartItemMappingByIdResponse extends BaseResponse {
+    /** Warning details */
+    warning?: string;
+    response?: {
+        /** A list of item mapping records between the Mart item and its corresponding outlet items */
+        item_mapping_list?: ItemMapping[];
+    };
+}
+/**
+ * Seller stock information for publishing to outlet
+ */
+export interface OutletSellerStock {
+    /** The location ID where the stock is stored */
+    location_id?: string;
+    /** The available stock quantity for the model */
+    stock: number;
+}
+/**
+ * Pre-order configuration for publishing to outlet
+ */
+export interface OutletPreOrder {
+    /** Indicates whether the model is sold as a pre-order item */
+    is_pre_order: boolean;
+    /** The number of days required to ship the item after an order is placed */
+    days_to_ship?: number;
+}
+/**
+ * Model information for publishing
+ */
+export interface PublishModel {
+    /** The model ID in the Mart shop that this outlet model is associated with. model_id=0 for items with only the default model(no variations) */
+    relate_mart_model_id: number;
+    /** The status of model */
+    model_status?: string;
+    /** The original price of the model */
+    original_price?: number;
+    /** Stock information for the model, set in outlet sku level */
+    seller_stock?: OutletSellerStock[];
+    /** Pre-order configuration, set in outlet sku level */
+    pre_order?: OutletPreOrder;
+}
+/**
+ * Logistics channel configuration for outlet
+ */
+export interface OutletLogisticInfo {
+    /** The logistics channel ID used for shipping the item */
+    logistic_id: number;
+    /** Indicates whether the logistics channel is enabled for the item */
+    enabled: boolean;
+    /** The shipping fee charged to the buyer for this logistics channel */
+    shipping_fee?: number;
+    /** The parcel size ID used to calculate shipping fees */
+    size_id?: number;
+    /** Indicates whether free shipping is applied for this logistics channel */
+    is_free?: boolean;
+}
+/**
+ * Maximum purchase limit configuration
+ */
+export interface MaxPurchaseLimit {
+    /** The maximum quantity that a buyer is allowed to purchase per order */
+    purchase_limit: number;
+}
+/**
+ * Purchase limit information
+ */
+export interface PurchaseLimitInfo {
+    /** The minimum quantity that a buyer is allowed to purchase per order */
+    min_purchase_limit: number;
+    /** The maximum purchase quantity configuration for the item */
+    max_purchase_limit: MaxPurchaseLimit;
+}
+/**
+ * Item publishing configuration
+ */
+export interface PublishItemConfig {
+    /** The outlet item ID */
+    outlet_item_id?: number;
+    /** A list of models to be published to the outlet shop, mapped from the corresponding Mart shop models */
+    model?: PublishModel[];
+    /** Logistic channel setting; can set for each outlet shop */
+    logistic_info?: OutletLogisticInfo[];
+    /** Purchase quantity limits applied to the item in the outlet shop */
+    purchase_limit_info?: PurchaseLimitInfo;
+}
+/**
+ * Parameters for publish item to outlet shop
+ */
+export type PublishItemToOutletShopParams = {
+    /** The item ID of the product in the Mart shop to be published to the outlet shop */
+    mart_item_id: number;
+    /** The shop ID of the outlet shop where the product will be published */
+    outlet_shop_id: number;
+    /** Configuration details for publishing the product to the outlet shop, including model mapping, pricing, stock, logistics, and purchase limits */
+    publish_item: PublishItemConfig;
+};
+/**
+ * Response for publish item to outlet shop API
+ */
+export interface PublishItemToOutletShopResponse extends BaseResponse {
+    /** Warning message */
+    warning?: string;
+    response?: {
+        /** The outlet item ID */
+        item_id?: number;
+    };
+}

package/lib/schemas/shop.d.ts

@@ -248,3 +248,101 @@ export type GetAuthorisedResellerBrandResponse = BaseResponse & {
     /** Authorised reseller brand data */
     response: AuthorisedResellerBrandData;
 };
+/**
+ * Parameters for getting BR shop onboarding info
+ */
+export type GetBRShopOnboardingInfoParams = Record<string, never>;
+/**
+ * Billing address information
+ */
+export type BillingAddress = {
+    /** State of the billing address */
+    state?: string;
+    /** City of the billing address */
+    city?: string;
+    /** Specific detail of the billing address */
+    address?: string;
+    /** ZIP code of the billing address */
+    zipcode?: string;
+    /** Neighborhood of the billing address */
+    neighborhood?: string;
+};
+/**
+ * BR shop onboarding information
+ */
+export type BRShopOnboardingInfo = {
+    /** Type of the shop's tax ID. 1: Personal seller (CPF), 2: Company seller (CNPJ) */
+    tax_id_type?: number;
+    /** The shop's tax ID. When tax_id_type = 1 (Personal seller), it is CPF. When tax_id_type = 2 (Company seller), it is CNPJ. */
+    tax_id?: string;
+    /** CPF number of the individual seller. Valid only when tax_id_type = 1. */
+    cpf_id?: string;
+    /** CNPJ number of the company seller. Valid only when tax_id_type = 2. */
+    cnpj_id?: string;
+    /** Full name of the individual seller. Valid only when tax_id_type = 1. */
+    name?: string;
+    /** Legal name of the company seller. Valid only when tax_id_type = 2. */
+    legal_entity_name?: string;
+    /** Birthday of the individual seller (stored as Unix timestamp). Valid only when tax_id_type = 1. */
+    birthday?: number;
+    /** Birthday of the individual seller (formatted as YYYY-MM-DD). Valid only when tax_id_type = 1. */
+    birthday_str?: string;
+    /** State registration number of the shop */
+    state_registration?: string;
+    /** Shop's billing address details */
+    billing_address?: BillingAddress;
+    /** Status of the shop's current KYC onboarding process. 0: None, 1: Regis Processing, 2: Regis Validated, 3: Regis Rejected, 4: KYC Pending, 5: KYC Processing, 6: KYC Processing Manually, 7: KYC Validated, 8: KYC Rejected */
+    onboarding_status?: number;
+    /** Timestamp when the onboarding information was submitted */
+    submission_time?: number;
+    /** Nationality of the individual seller. Valid only when tax_id_type=1. */
+    nationality?: string;
+    /** Main CNAE code */
+    cnae_main?: string;
+    /** Secondary CNAE code */
+    cnae_secondary?: string;
+    /** MEI verification result. 0: No, 1: Yes */
+    mei_check?: string;
+    /** Indicate if the shop has passed KYC verification */
+    onboarding_passed?: boolean;
+};
+/**
+ * Response for getting BR shop onboarding info
+ */
+export type GetBRShopOnboardingInfoResponse = BaseResponse & {
+    /** Onboarding information of the Shop */
+    response?: BRShopOnboardingInfo;
+};
+/**
+ * Parameters for getting shop holiday mode
+ */
+export type GetShopHolidayModeParams = Record<string, never>;
+/**
+ * Response for getting shop holiday mode
+ */
+export type GetShopHolidayModeResponse = BaseResponse & {
+    response?: {
+        /** Indicate whether the shop has enabled holiday mode. true means ON, false means OFF. */
+        holiday_mode_on?: boolean;
+        /** The last time the holiday mode was modified */
+        holiday_mode_mtime?: number;
+        /** Debug message */
+        debug_msg?: string;
+    };
+};
+/**
+ * Parameters for setting shop holiday mode
+ */
+export type SetShopHolidayModeParams = {
+    /** Indicate whether to enable holiday mode for the shop. true means turn ON, false means turn OFF. */
+    holiday_mode_on: boolean;
+};
+/**
+ * Response for setting shop holiday mode
+ */
+export type SetShopHolidayModeResponse = BaseResponse & {
+    response?: {
+        /** Debug message */
+        debug_msg?: string;
+    };
+};