Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More →
ae_sdk - npm Package Compare versions
Comparing version 0.3.1 to 0.3.2
| # ae_sdk | ||
| ## 0.3.2 | ||
| ### Patch Changes | ||
| - Finish affiliate API methods | ||
| ## 0.3.1 | ||
@@ -4,0 +10,0 @@ |
@@ -13,3 +13,3 @@ /** | ||
| type DS_API_NAMES = "aliexpress.ds.recommend.feed.get" | "aliexpress.ds.product.get" | "aliexpress.postproduct.redefining.findaeproductbyidfordropshipper" | "aliexpress.trade.buy.placeorder" | "aliexpress.ds.trade.order.get" | "aliexpress.logistics.buyer.freight.calculate" | "aliexpress.logistics.ds.trackinginfo.query"; | ||
| type AFFILIATE_API_NAMES = "aliexpress.affiliate.link.generate" | "aliexpress.affiliate.category.get" | "aliexpress.affiliate.featuredpromo.get" | "aliexpress.affiliate.featuredpromo.products.get" | "aliexpress.affiliate.hotproduct.query" | "aliexpress.affiliate.order.get" | "aliexpress.affiliate.productdetail.get" | "aliexpress.affiliate.product.query"; | ||
| type AFFILIATE_API_NAMES = "aliexpress.affiliate.link.generate" | "aliexpress.affiliate.category.get" | "aliexpress.affiliate.featuredpromo.get" | "aliexpress.affiliate.featuredpromo.products.get" | "aliexpress.affiliate.hotproduct.download" | "aliexpress.affiliate.hotproduct.query" | "aliexpress.affiliate.order.get" | "aliexpress.affiliate.order.list" | "aliexpress.affiliate.order.listbyindex" | "aliexpress.affiliate.productdetail.get" | "aliexpress.affiliate.product.query" | "aliexpress.affiliate.product.smartmatch"; | ||
| type SYSTEM_API_NAMES = "/auth/token/security/create" | "/auth/token/create" | "/auth/token/security/refresh" | "/auth/token/refresh"; | ||
@@ -22,3 +22,3 @@ type AE_EXECUTE_FN_METHODS<T extends AE_SERVICE> = T extends AE_DROPSHIPPING_SERVICE ? DS_API_NAMES : T extends AE_SYSTEM_SERVICE ? SYSTEM_API_NAMES : AFFILIATE_API_NAMES; | ||
| type AE_DS_EXECUTE_FN_PARAMS<T extends DS_API_NAMES> = T extends "aliexpress.ds.recommend.feed.get" ? DS_ProductAPI_Recommended_Products_Params : T extends "aliexpress.ds.product.get" ? DS_ProductAPI_Product_Params : T extends "aliexpress.postproduct.redefining.findaeproductbyidfordropshipper" ? DS_ProductAPI_Product_Detail_Params : T extends "aliexpress.trade.buy.placeorder" ? DS_OrderAPI_Place_Order_Params : T extends "aliexpress.ds.trade.order.get" ? DS_OrderAPI_Get_Order_Params : T extends "aliexpress.logistics.buyer.freight.calculate" ? DS_ShippingAPI_Shipping_Info_Params : T extends "aliexpress.logistics.ds.trackinginfo.query" ? DS_ShippingAPI_Tracking_Info_Params : unknown; | ||
| type AE_AFFILIATE_EXECUTE_FN_PARAMS<T extends AFFILIATE_API_NAMES> = T extends "aliexpress.affiliate.link.generate" ? Affiliate_Generate_Affiliate_Links_Params : T extends "aliexpress.affiliate.category.get" ? Affiliate_Categories_Params : T extends "aliexpress.affiliate.featuredpromo.get" ? Affiliate_Featuredpromo_Info_Params : T extends "aliexpress.affiliate.featuredpromo.products.get" ? Affiliate_Featured_Promo_Products_Params : T extends "aliexpress.affiliate.hotproduct.query" ? Affiliate_Hotproducts_Params : T extends "aliexpress.affiliate.order.get" ? Affiliate_Order_Info_Params : T extends "aliexpress.affiliate.productdetail.get" ? Affiliate_Product_Details_Params : T extends "aliexpress.affiliate.product.query" ? Affiliate_Products_Params : unknown; | ||
| type AE_AFFILIATE_EXECUTE_FN_PARAMS<T extends AFFILIATE_API_NAMES> = T extends "aliexpress.affiliate.link.generate" ? Affiliate_Generate_Affiliate_Links_Params : T extends "aliexpress.affiliate.category.get" ? Affiliate_Categories_Params : T extends "aliexpress.affiliate.featuredpromo.get" ? Affiliate_Featuredpromo_Info_Params : T extends "aliexpress.affiliate.featuredpromo.products.get" ? Affiliate_Featured_Promo_Products_Params : T extends "aliexpress.affiliate.hotproduct.download" ? Affiliate_Hotproducts_Download_Params : T extends "aliexpress.affiliate.hotproduct.query" ? Affiliate_Hotproducts_Params : T extends "aliexpress.affiliate.order.get" ? Affiliate_Order_Info_Params : T extends "aliexpress.affiliate.order.list" ? Affiliate_Order_List_Params : T extends "aliexpress.affiliate.order.listbyindex" ? Affiliate_Order_List_ByIdx_Params : T extends "aliexpress.affiliate.productdetail.get" ? Affiliate_Product_Details_Params : T extends "aliexpress.affiliate.product.query" ? Affiliate_Products_Params : T extends "aliexpress.affiliate.product.smartmatch" ? Affiliate_Smart_Match_Products_Params : unknown; | ||
| type AE_EXECUTE_FN_PARAMS<T extends AE_API_NAMES> = T extends DS_API_NAMES ? AE_DS_EXECUTE_FN_PARAMS<T> : T extends AFFILIATE_API_NAMES ? AE_AFFILIATE_EXECUTE_FN_PARAMS<T> : T extends SYSTEM_API_NAMES ? AE_SYSTEM_EXECUTE_FN_PARAMS<T> : unknown; | ||
@@ -30,3 +30,3 @@ /** | ||
| type AE_DS_EXECUTE_FN_RESULT<T extends DS_API_NAMES> = T extends "aliexpress.ds.recommend.feed.get" ? DS_ProductAPI_Recommended_Products_Result : T extends "aliexpress.ds.product.get" ? DS_ProductAPI_Product_Result : T extends "aliexpress.postproduct.redefining.findaeproductbyidfordropshipper" ? DS_ProductAPI_Product_Detail_Result : T extends "aliexpress.trade.buy.placeorder" ? DS_OrderAPI_Place_Order_Result : T extends "aliexpress.ds.trade.order.get" ? DS_OrderAPI_Get_Order_Result : T extends "aliexpress.logistics.buyer.freight.calculate" ? DS_ShippingAPI_Shipping_Info_Result : T extends "aliexpress.logistics.ds.trackinginfo.query" ? DS_ShippingAPI_Tracking_Info_Result : unknown; | ||
| type AE_AFFILIATE_EXECUTE_FN_RESULT<T extends AFFILIATE_API_NAMES> = T extends "aliexpress.affiliate.link.generate" ? Affiliate_Generate_Affiliate_Links_Result : T extends "aliexpress.affiliate.category.get" ? Affiliate_Categories_Result : T extends "aliexpress.affiliate.featuredpromo.get" ? Affiliate_Featuredpromo_Info_Result : T extends "aliexpress.affiliate.featuredpromo.products.get" ? Affiliate_Featured_Promo_Products_Result : T extends "aliexpress.affiliate.hotproduct.query" ? Affiliate_Hotproducts_Result : T extends "aliexpress.affiliate.order.get" ? Affiliate_Order_Info_Result : T extends "aliexpress.affiliate.productdetail.get" ? Affiliate_Product_Details_Result : T extends "aliexpress.affiliate.product.query" ? Affiliate_Products_Result : unknown; | ||
| type AE_AFFILIATE_EXECUTE_FN_RESULT<T extends AFFILIATE_API_NAMES> = T extends "aliexpress.affiliate.link.generate" ? Affiliate_Generate_Affiliate_Links_Result : T extends "aliexpress.affiliate.category.get" ? Affiliate_Categories_Result : T extends "aliexpress.affiliate.featuredpromo.get" ? Affiliate_Featuredpromo_Info_Result : T extends "aliexpress.affiliate.featuredpromo.products.get" ? Affiliate_Featured_Promo_Products_Result : T extends "aliexpress.affiliate.hotproduct.download" ? Affiliate_Hotproducts_Download_Result : T extends "aliexpress.affiliate.hotproduct.query" ? Affiliate_Hotproducts_Result : T extends "aliexpress.affiliate.order.get" ? Affiliate_Order_Info_Result : T extends "aliexpress.affiliate.order.list" ? Affiliate_Order_List_Result : T extends "aliexpress.affiliate.order.listbyindex" ? Affiliate_Order_List_ByIdx_Result : T extends "aliexpress.affiliate.productdetail.get" ? Affiliate_Product_Details_Result : T extends "aliexpress.affiliate.product.query" ? Affiliate_Products_Result : T extends "aliexpress.affiliate.product.smartmatch" ? Affiliate_Smart_Match_Products_Result : unknown; | ||
| type AE_EXECUTE_FN_RESULT<T extends AE_API_NAMES> = T extends DS_API_NAMES ? AE_DS_EXECUTE_FN_RESULT<T> : T extends AFFILIATE_API_NAMES ? AE_AFFILIATE_EXECUTE_FN_RESULT<T> : T extends SYSTEM_API_NAMES ? AE_SYSTEM_EXECUTE_FN_RESULT<T> : unknown; | ||
@@ -837,2 +837,142 @@ /** | ||
| } | ||
| /** | ||
| * AFFILIATE API | ||
| * GET ORDER LIST | ||
| */ | ||
| interface Affiliate_Order_List_Params { | ||
| /** The type of time you are querying: Payment Completed Time(The time of payment for the order), Buyer Confirmed Receipt Time(The time when the buyer confirms receipt) Completed Settlement Time(The time when commission is paid into Account Balance) */ | ||
| time_type?: string; | ||
| /** API signature */ | ||
| app_signature?: string; | ||
| /** End time, PST time */ | ||
| end_time: string; | ||
| /** Respond parameter list. eg: commission_rate,sale_price */ | ||
| fields?: string; | ||
| locale_site?: string; | ||
| page_no?: number; | ||
| page_size?: number; | ||
| /** Start time, PST time */ | ||
| start_time: string; | ||
| /** Order status: Payment Completed(Buyer paid successfully), Buyer Confirmed Receipt(This status only change when:Buyer confirms receipt and settlement task begins which is manually executed by our operation team), Completed Settlement(Orders have been verified and commission has been paid), Invalid(Orders will not be settled including buyer refunds, order risks, antispam/penalty appeal failed, antispam/penalty appeal overdue, order not settled being over 180 days apart from the Completed Payment Time (such as in abnormal state like dispute), etc.) */ | ||
| status: string; | ||
| } | ||
| interface Affiliate_Order_List { | ||
| total_page_no: number; | ||
| total_record_count: number; | ||
| current_page_no: number; | ||
| current_record_count: number; | ||
| orders: Affiliate_Order_Details[]; | ||
| } | ||
| interface Affiliate_Order_List_Result { | ||
| resp_result: { | ||
| result: Affiliate_Order_List; | ||
| resp_code?: number; | ||
| resp_msg?: string; | ||
| }; | ||
| } | ||
| /** | ||
| * AFFILIATE API | ||
| * GET ORDER LIST BY INDEX | ||
| */ | ||
| interface Affiliate_Order_List_ByIdx_Params { | ||
| /** The type of time you are querying: Payment Completed Time(The time of payment for the order), Buyer Confirmed Receipt Time(The time when the buyer confirms receipt) Completed Settlement Time(The time when commission is paid into Account Balance) */ | ||
| time_type?: string; | ||
| /** API signature */ | ||
| app_signature?: string; | ||
| /** End time, PST time */ | ||
| end_time: string; | ||
| /** Respond parameter list. eg: commission_rate,sale_price */ | ||
| fields?: string; | ||
| page_size?: number; | ||
| /** Start time, PST time */ | ||
| start_time: string; | ||
| /** Order status: Payment Completed(Buyer paid successfully), Buyer Confirmed Receipt(This status only change when:Buyer confirms receipt and settlement task begins which is manually executed by our operation team), Completed Settlement(Orders have been verified and commission has been paid), Invalid(Orders will not be settled including buyer refunds, order risks, antispam/penalty appeal failed, antispam/penalty appeal overdue, order not settled being over 180 days apart from the Completed Payment Time (such as in abnormal state like dispute), etc.) */ | ||
| status: string; | ||
| /** Query index start value: if not passed, You can only check the first page */ | ||
| start_query_index_id?: string; | ||
| } | ||
| interface Affiliate_Order_List_ByIdx { | ||
| min_query_index_id: string; | ||
| max_query_index_id: string; | ||
| current_record_count: number; | ||
| orders: Affiliate_Order_Details[]; | ||
| } | ||
| interface Affiliate_Order_List_ByIdx_Result { | ||
| resp_result: { | ||
| result: Affiliate_Order_List_ByIdx; | ||
| resp_code?: number; | ||
| resp_msg?: string; | ||
| }; | ||
| } | ||
| /** | ||
| * AFFILIATE API | ||
| * GET HOTPRODUCT DOWNLOAD | ||
| */ | ||
| interface Affiliate_Hotproducts_Download_Params { | ||
| /** API signature */ | ||
| app_signature?: string; | ||
| /** Category ID, you can get category ID via "get category" API https://developers.aliexpress.com/en/doc.htm?docId=45801&docType=2 */ | ||
| category_id: string; | ||
| /** Respond parameter list. eg: commission_rate,sale_price */ | ||
| fields?: string; | ||
| /** Local site：global, it_site, es_site, ru_site */ | ||
| locale_site?: string; | ||
| page_no?: number; | ||
| page_size?: number; | ||
| /** Target Currency:USD, GBP, CAD, EUR, UAH, MXN, TRY, RUB, BRL, AUD, INR, JPY, IDR, SEK,KRW,ILS,THB,CLP,VND */ | ||
| target_currency?: string; | ||
| /** Target Language:EN,RU,PT,ES,FR,ID,IT,TH,JA,AR,VI,TR,DE,HE,KO,NL,PL,MX,CL,IN */ | ||
| target_language?: string; | ||
| /** Your trackingID */ | ||
| tracking_id?: string; | ||
| /** The Ship to country. Filter products that can be sent to that country; Returns the price according to the country’s tax rate policy.*/ | ||
| country?: string; | ||
| } | ||
| interface Affiliate_Hotproducts_Download { | ||
| current_page_no: number; | ||
| current_record_count: number; | ||
| products: Affiliate_Base_Product_Details[]; | ||
| } | ||
| interface Affiliate_Hotproducts_Download_Result { | ||
| resp_result: { | ||
| result: Affiliate_Hotproducts_Download; | ||
| resp_code?: number; | ||
| resp_msg?: string; | ||
| }; | ||
| } | ||
| /** | ||
| * AFFILIATE API | ||
| * SMART MATCH PRODUCTS | ||
| */ | ||
| interface Affiliate_Smart_Match_Products_Params { | ||
| /** App information */ | ||
| app?: string; | ||
| /** API signature */ | ||
| app_signature?: string; | ||
| /** Device infomation */ | ||
| device?: string; | ||
| /** adid or idfa, for more information please refer to https://support.google.com/admanager/answer/6238701 Can be null, if it is null, it can be recommended based on keywords or product ID */ | ||
| device_id: string; | ||
| /** Respond parameter list, eg: commission_rate,sale_price */ | ||
| fields?: string; | ||
| /** Recommend products by keywords. eg: mp3 */ | ||
| keywords?: string; | ||
| /** Request page number */ | ||
| page_no?: number; | ||
| /** Product ID, matching related products product ID */ | ||
| product_id?: string; | ||
| /** site information */ | ||
| site?: string; | ||
| /** Target Currency: USD, GBP, CAD, EUR, UAH, MXN, TRY, RUB, BRL, AUD, INR, JPY, IDR, SEK,KRW,ILS,THB,CLP,VND */ | ||
| target_currency?: string; | ||
| /** Target Languages: EN,RU,PT,ES,FR,ID,IT,TH,JA,AR,VI,TR,DE,HE,KO,NL,PL,MX,CL,IN */ | ||
| target_language?: string; | ||
| tracking_id?: string; | ||
| /** user id */ | ||
| user?: string; | ||
| /** The Ship to country. Filter products that can be sent to that country; Returns the price according to the country’s tax rate policy. */ | ||
| country?: string; | ||
| } | ||
| interface Affiliate_Smart_Match_Products_Result extends Affiliate_Hotproducts_Download_Result { | ||
| } | ||
@@ -871,3 +1011,3 @@ declare class AEBaseClient implements AE_Base_Client { | ||
| */ | ||
| getFeaturedPromoInfo(args: Affiliate_Featuredpromo_Info_Params): Promise<Affiliate_Featuredpromo_Info_Result | undefined>; | ||
| featuredPromoInfo(args: Affiliate_Featuredpromo_Info_Params): Promise<Affiliate_Featuredpromo_Info_Result | undefined>; | ||
| /** | ||
@@ -878,3 +1018,3 @@ * | ||
| */ | ||
| getFeaturedPromoProducts(args: Affiliate_Featured_Promo_Products_Params): Promise<Affiliate_Featured_Promo_Products_Result | undefined>; | ||
| featuredPromoProducts(args: Affiliate_Featured_Promo_Products_Params): Promise<Affiliate_Featured_Promo_Products_Result | undefined>; | ||
| /** | ||
@@ -885,2 +1025,3 @@ * | ||
| */ | ||
| getHotProductsDownload(args: Affiliate_Hotproducts_Download_Params): Promise<Affiliate_Hotproducts_Download_Result | undefined>; | ||
| /** | ||
@@ -897,13 +1038,15 @@ * | ||
| */ | ||
| getOrderInfo(args: Affiliate_Order_Info_Params): Promise<Affiliate_Order_Info_Result | undefined>; | ||
| orderInfo(args: Affiliate_Order_Info_Params): Promise<Affiliate_Order_Info_Result | undefined>; | ||
| /** | ||
| * @link https://open.aliexpress.com/doc/api.htm#/api?cid=21407&path=aliexpress.affiliate.order.list&methodType=GET/POST | ||
| */ | ||
| ordersList(args: Affiliate_Order_List_Params): Promise<Affiliate_Order_List_Result | undefined>; | ||
| /** | ||
| * @link https://open.aliexpress.com/doc/api.htm#/api?cid=21407&path=aliexpress.affiliate.order.listbyindex&methodType=GET/POST | ||
| */ | ||
| ordersListByIndex(args: Affiliate_Order_List_ByIdx_Params): Promise<Affiliate_Order_List_ByIdx_Result | undefined>; | ||
| /** | ||
| * @link https://open.aliexpress.com/doc/api.htm#/api?cid=21407&path=aliexpress.affiliate.productdetail.get&methodType=GET/POST | ||
| */ | ||
| getProductDetails(args: Affiliate_Product_Details_Params): Promise<Affiliate_Product_Details_Result | undefined>; | ||
| productDetails(args: Affiliate_Product_Details_Params): Promise<Affiliate_Product_Details_Result | undefined>; | ||
| /** | ||
@@ -913,2 +1056,6 @@ * @link https://open.aliexpress.com/doc/api.htm#/api?cid=21407&path=aliexpress.affiliate.product.query&methodType=GET/POST | ||
| queryProducts(args: Affiliate_Products_Params): Promise<Affiliate_Products_Result | undefined>; | ||
| /** | ||
| * @link https://open.aliexpress.com/doc/api.htm#/api?cid=21407&path=aliexpress.affiliate.product.smartmatch&methodType=GET/POST | ||
| */ | ||
| smartMatchProducts(args: Affiliate_Smart_Match_Products_Params): Promise<Affiliate_Smart_Match_Products_Result | undefined>; | ||
| } | ||
@@ -993,2 +1140,2 @@ | ||
| export { AEAffiliateClient, AEDSClient, AES_Access_Token_Result, AES_Base_Access_Token_Result, AES_Generate_Security_Token_Params, AES_Generate_Security_Token_Result, AES_Generate_Token_Params, AES_Generate_Token_Result, AES_Refresh_Security_Token_Params, AES_Refresh_Security_Token_Result, AES_Refresh_Token_Params, AES_Refresh_Token_Result, AE_AFFILIATE_EXECUTE_FN_PARAMS, AE_AFFILIATE_EXECUTE_FN_RESULT, AE_AFFILIATE_SERVICE, AE_API_NAMES, AE_Base_Client, AE_DROPSHIPPING_SERVICE, AE_DS_EXECUTE_FN_PARAMS, AE_DS_EXECUTE_FN_RESULT, AE_EXECUTE_FN_METHODS, AE_EXECUTE_FN_PARAMS, AE_EXECUTE_FN_RESULT, AE_Error_Response, AE_Logistics_Address, AE_Platform_Type, AE_Product_Item, AE_Response_Format, AE_SERVICE, AE_SYSTEM_EXECUTE_FN_PARAMS, AE_SYSTEM_EXECUTE_FN_RESULT, AE_SYSTEM_SERVICE, AFFILIATE_API_NAMES, Affiliate_Base_Product_Details, Affiliate_Base_Product_Params, Affiliate_Categories, Affiliate_Categories_Params, Affiliate_Categories_Result, Affiliate_Category_Details, Affiliate_Featured_Promo_Product, Affiliate_Featured_Promo_Products_Params, Affiliate_Featured_Promo_Products_Result, Affiliate_Featuredpromo_Details, Affiliate_Featuredpromo_Info, Affiliate_Featuredpromo_Info_Params, Affiliate_Featuredpromo_Info_Result, Affiliate_Generate_Affiliate_Links, Affiliate_Generate_Affiliate_Links_Params, Affiliate_Generate_Affiliate_Links_Result, Affiliate_Hotproducts, Affiliate_Hotproducts_Params, Affiliate_Hotproducts_Result, Affiliate_Order_Details, Affiliate_Order_Info, Affiliate_Order_Info_Params, Affiliate_Order_Info_Result, Affiliate_Product_Details, Affiliate_Product_Details_Params, Affiliate_Product_Details_Result, Affiliate_Product_Promo_Code_Info, Affiliate_Products, Affiliate_Products_Params, Affiliate_Products_Result, Affiliate_Promo_Link, DS_API_NAMES, DS_OrderAPI_Get_Order, DS_OrderAPI_Get_Order_Params, DS_OrderAPI_Get_Order_Result, DS_OrderAPI_Logistics_Info, DS_OrderAPI_Place_Order_Params, DS_OrderAPI_Place_Order_Result, DS_OrderAPI_Price, DS_OrderAPI_Product_Info, DS_OrderAPI_Store_Info, DS_ProductAPI_Product, DS_ProductAPI_Product_Attributes, DS_ProductAPI_Product_Base_Info, DS_ProductAPI_Product_Detail_Params, DS_ProductAPI_Product_Detail_Result, DS_ProductAPI_Product_Details, DS_ProductAPI_Product_Id_Converter, DS_ProductAPI_Product_Multimedia, DS_ProductAPI_Product_Multimedia_Videos, DS_ProductAPI_Product_Package_Info, DS_ProductAPI_Product_Params, DS_ProductAPI_Product_Result, DS_ProductAPI_Product_SKU_Properties, DS_ProductAPI_Product_SKU_Variation, DS_ProductAPI_Product_Shipping_Info, DS_ProductAPI_Product_Store_Info, DS_ProductAPI_Recommended_Product, DS_ProductAPI_Recommended_Products, DS_ProductAPI_Recommended_Products_Params, DS_ProductAPI_Recommended_Products_Result, DS_ProductAPI_Store_Info, DS_ShippingAPI_Freight_Info, DS_ShippingAPI_Shipping_Details, DS_ShippingAPI_Shipping_Info_Params, DS_ShippingAPI_Shipping_Info_Result, DS_ShippingAPI_Tracking_Event, DS_ShippingAPI_Tracking_Info_Params, DS_ShippingAPI_Tracking_Info_Result, PublicParams, SYSTEM_API_NAMES }; | ||
| export { AEAffiliateClient, AEDSClient, AES_Access_Token_Result, AES_Base_Access_Token_Result, AES_Generate_Security_Token_Params, AES_Generate_Security_Token_Result, AES_Generate_Token_Params, AES_Generate_Token_Result, AES_Refresh_Security_Token_Params, AES_Refresh_Security_Token_Result, AES_Refresh_Token_Params, AES_Refresh_Token_Result, AE_AFFILIATE_EXECUTE_FN_PARAMS, AE_AFFILIATE_EXECUTE_FN_RESULT, AE_AFFILIATE_SERVICE, AE_API_NAMES, AE_Base_Client, AE_DROPSHIPPING_SERVICE, AE_DS_EXECUTE_FN_PARAMS, AE_DS_EXECUTE_FN_RESULT, AE_EXECUTE_FN_METHODS, AE_EXECUTE_FN_PARAMS, AE_EXECUTE_FN_RESULT, AE_Error_Response, AE_Logistics_Address, AE_Platform_Type, AE_Product_Item, AE_Response_Format, AE_SERVICE, AE_SYSTEM_EXECUTE_FN_PARAMS, AE_SYSTEM_EXECUTE_FN_RESULT, AE_SYSTEM_SERVICE, AFFILIATE_API_NAMES, Affiliate_Base_Product_Details, Affiliate_Base_Product_Params, Affiliate_Categories, Affiliate_Categories_Params, Affiliate_Categories_Result, Affiliate_Category_Details, Affiliate_Featured_Promo_Product, Affiliate_Featured_Promo_Products_Params, Affiliate_Featured_Promo_Products_Result, Affiliate_Featuredpromo_Details, Affiliate_Featuredpromo_Info, Affiliate_Featuredpromo_Info_Params, Affiliate_Featuredpromo_Info_Result, Affiliate_Generate_Affiliate_Links, Affiliate_Generate_Affiliate_Links_Params, Affiliate_Generate_Affiliate_Links_Result, Affiliate_Hotproducts, Affiliate_Hotproducts_Download, Affiliate_Hotproducts_Download_Params, Affiliate_Hotproducts_Download_Result, Affiliate_Hotproducts_Params, Affiliate_Hotproducts_Result, Affiliate_Order_Details, Affiliate_Order_Info, Affiliate_Order_Info_Params, Affiliate_Order_Info_Result, Affiliate_Order_List, Affiliate_Order_List_ByIdx, Affiliate_Order_List_ByIdx_Params, Affiliate_Order_List_ByIdx_Result, Affiliate_Order_List_Params, Affiliate_Order_List_Result, Affiliate_Product_Details, Affiliate_Product_Details_Params, Affiliate_Product_Details_Result, Affiliate_Product_Promo_Code_Info, Affiliate_Products, Affiliate_Products_Params, Affiliate_Products_Result, Affiliate_Promo_Link, Affiliate_Smart_Match_Products_Params, Affiliate_Smart_Match_Products_Result, DS_API_NAMES, DS_OrderAPI_Get_Order, DS_OrderAPI_Get_Order_Params, DS_OrderAPI_Get_Order_Result, DS_OrderAPI_Logistics_Info, DS_OrderAPI_Place_Order_Params, DS_OrderAPI_Place_Order_Result, DS_OrderAPI_Price, DS_OrderAPI_Product_Info, DS_OrderAPI_Store_Info, DS_ProductAPI_Product, DS_ProductAPI_Product_Attributes, DS_ProductAPI_Product_Base_Info, DS_ProductAPI_Product_Detail_Params, DS_ProductAPI_Product_Detail_Result, DS_ProductAPI_Product_Details, DS_ProductAPI_Product_Id_Converter, DS_ProductAPI_Product_Multimedia, DS_ProductAPI_Product_Multimedia_Videos, DS_ProductAPI_Product_Package_Info, DS_ProductAPI_Product_Params, DS_ProductAPI_Product_Result, DS_ProductAPI_Product_SKU_Properties, DS_ProductAPI_Product_SKU_Variation, DS_ProductAPI_Product_Shipping_Info, DS_ProductAPI_Product_Store_Info, DS_ProductAPI_Recommended_Product, DS_ProductAPI_Recommended_Products, DS_ProductAPI_Recommended_Products_Params, DS_ProductAPI_Recommended_Products_Result, DS_ProductAPI_Store_Info, DS_ShippingAPI_Freight_Info, DS_ShippingAPI_Shipping_Details, DS_ShippingAPI_Shipping_Info_Params, DS_ShippingAPI_Shipping_Info_Result, DS_ShippingAPI_Tracking_Event, DS_ShippingAPI_Tracking_Info_Params, DS_ShippingAPI_Tracking_Info_Result, PublicParams, SYSTEM_API_NAMES }; |
@@ -151,3 +151,3 @@ "use strict"; | ||
| */ | ||
| getFeaturedPromoInfo(args) { | ||
| featuredPromoInfo(args) { | ||
| return __async(this, null, function* () { | ||
@@ -162,3 +162,3 @@ return yield this.execute("aliexpress.affiliate.featuredpromo.get", args); | ||
| */ | ||
| getFeaturedPromoProducts(args) { | ||
| featuredPromoProducts(args) { | ||
| return __async(this, null, function* () { | ||
@@ -176,3 +176,7 @@ return yield this.execute( | ||
| */ | ||
| // todo: add get hotproduct download | ||
| getHotProductsDownload(args) { | ||
| return __async(this, null, function* () { | ||
| return yield this.execute("aliexpress.affiliate.hotproduct.download", args); | ||
| }); | ||
| } | ||
| /** | ||
@@ -193,3 +197,3 @@ * | ||
| */ | ||
| getOrderInfo(args) { | ||
| orderInfo(args) { | ||
| return __async(this, null, function* () { | ||
@@ -202,11 +206,19 @@ return yield this.execute("aliexpress.affiliate.order.get", args); | ||
| */ | ||
| // todo: add get order list | ||
| ordersList(args) { | ||
| return __async(this, null, function* () { | ||
| return yield this.execute("aliexpress.affiliate.order.list", args); | ||
| }); | ||
| } | ||
| /** | ||
| * @link https://open.aliexpress.com/doc/api.htm#/api?cid=21407&path=aliexpress.affiliate.order.listbyindex&methodType=GET/POST | ||
| */ | ||
| // todo: add get order list by index | ||
| ordersListByIndex(args) { | ||
| return __async(this, null, function* () { | ||
| return yield this.execute("aliexpress.affiliate.order.listbyindex", args); | ||
| }); | ||
| } | ||
| /** | ||
| * @link https://open.aliexpress.com/doc/api.htm#/api?cid=21407&path=aliexpress.affiliate.productdetail.get&methodType=GET/POST | ||
| */ | ||
| getProductDetails(args) { | ||
| productDetails(args) { | ||
| return __async(this, null, function* () { | ||
@@ -227,3 +239,7 @@ return yield this.execute("aliexpress.affiliate.productdetail.get", args); | ||
| */ | ||
| // todo: add smart match products | ||
| smartMatchProducts(args) { | ||
| return __async(this, null, function* () { | ||
| return yield this.execute("aliexpress.affiliate.product.smartmatch", args); | ||
| }); | ||
| } | ||
| }; | ||
@@ -230,0 +246,0 @@ |
| { | ||
| "name": "ae_sdk", | ||
| "version": "0.3.1", | ||
| "version": "0.3.2", | ||
| "description": "A simple SDK for Aliexpress (dropshipping and affiliate) APIs.", | ||
@@ -5,0 +5,0 @@ "private": false, |
| # AE_SDK | ||
| A simple SDK for Aliexpress (system tools, dropshipping and affiliate) APIs. | ||
| A simple and type-safe SDK for Aliexpress (system tools, dropshipping and affiliate) APIs. | ||
| ## Todo | ||
| ## Disclamer | ||
| - Update affiliate and ds APIs according to [aliexpress official website](https://open.aliexpress.com/doc/api.htm#/api); | ||
| - Add better error handling and fix resp_result / error_result; | ||
| - Add in code documentation using `jsdoc`; | ||
| - Add unit tests; | ||
| This library is currently under heavy development. More endpoints and documentation will be coming. | ||
@@ -26,1 +23,22 @@ ## Installation | ||
| ## Usage | ||
| ```ts | ||
| // step 1: import the AE affiliate (`AEAffiliateClient`) or dropshipping (`AEDSClient`) client | ||
| import { AEAffiliateClient /* AEDSClient */ } from "ae_sdk"; | ||
| // step 2: initilize the client | ||
| const client = new AEAffiliateClient({ | ||
| app_key: "123", | ||
| app_secret: "123456abcdef", | ||
| session: "oauth_access_token", | ||
| }); | ||
| // step 3: you are all set ! | ||
| ``` | ||
| ## Todo | ||
| - Update ds APIs according to [aliexpress official website](https://open.aliexpress.com/doc/api.htm#/api); | ||
| - Add better error handling and fix resp_result / error_result; | ||
| - Add in code documentation using `jsdoc`; | ||
| - Add unit tests; |
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
New alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Fixed alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Improved metrics
- Total package byte prevSize
- increased by16.65%
122395
- Lines of code
- increased by10.92%
1890
- Number of lines in readme file
- increased by69.23%
44
No dependency changes