@congminh1254/shopee-sdk
Version:
Shopee SDK maintaining by community
151 lines (150 loc) • 8.7 kB
TypeScript
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>;
}