ae_sdk - npm Package Compare versions

Comparing version 0.3.0 to 0.3.1

CHANGELOG.md

 # ae_sdk
 
+## 0.3.1
+
+### Patch Changes
+
+- Add affiliate API methods
+
 ## 0.3.0
@@ -4,0 +10,0 @@

dist/index.d.ts

@@ -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.productdetail.get" | "aliexpress.affiliate.product.query" | "aliexpress.affiliate.hotproduct.query" | "aliexpress.affiliate.featuredpromo.products.get" | "aliexpress.affiliate.category.get";
+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 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.productdetail.get" ? Affiliate_Product_Details_Params : T extends "aliexpress.affiliate.product.query" ? Affiliate_Products_Params : T extends "aliexpress.affiliate.hotproduct.query" ? Affiliate_Hotproducts_Params : T extends "aliexpress.affiliate.featuredpromo.products.get" ? Affiliate_Featured_Promo_Products_Params : T extends "aliexpress.affiliate.category.get" ? null : 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_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.productdetail.get" ? Affiliate_Product_Details_Result : T extends "aliexpress.affiliate.product.query" ? Affiliate_Products_Result : T extends "aliexpress.affiliate.hotproduct.query" ? Affiliate_Hotproducts_Result : T extends "aliexpress.affiliate.featuredpromo.products.get" ? Affiliate_Featured_Promo_Products_Result : T extends "aliexpress.affiliate.category.get" ? Affiliate_Categories_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_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;
@@ -63,6 +63,8 @@ /**
 interface AE_Error_Response {
-    msg?: string;
-    code?: number;
-    sub_msg?: string;
-    sub_code?: string;
+    error_response: {
+        type: string;
+        code: string;
+        msg: string;
+        request_id: string;
+    };
 }
@@ -567,2 +569,29 @@ type AE_Response_Format = "xml" | "json";
  * AFFILIATE API
+ * GENERATE AFFILIATE LINKS
+ */
+interface Affiliate_Generate_Affiliate_Links_Params {
+    /** Promotion link type: 0 for normal link which has standard commission , and 2 for hot link which has hot product commission */
+    promotion_link_type: number;
+    source_values: string;
+    tracking_id: string;
+    app_signature?: string;
+}
+interface Affiliate_Promo_Link {
+    promotion_link: string;
+    source_value: string;
+}
+interface Affiliate_Generate_Affiliate_Links {
+    total_result_count: number;
+    tracking_id: string;
+    promotion_links: Affiliate_Promo_Link[];
+}
+interface Affiliate_Generate_Affiliate_Links_Result {
+    resp_result: {
+        resp_code?: number;
+        resp_msg?: string;
+        result: Affiliate_Generate_Affiliate_Links;
+    };
+}
+/**
+ * AFFILIATE API
  * PRODUCT DETAILS
@@ -633,5 +662,3 @@ */
     current_record_count: number;
-    products: {
-        product: Affiliate_Product_Details[];
-    };
+    products: Affiliate_Product_Details[];
 }
@@ -689,2 +716,5 @@ interface Affiliate_Product_Details_Result {
  */
+interface Affiliate_Categories_Params {
+    app_signature?: string;
+}
 interface Affiliate_Category_Details {
@@ -696,16 +726,36 @@ category_id: number;
 interface Affiliate_Categories {
-    resp_code: number;
-    resp_msg: string;
-    result: {
-        categories: Affiliate_Category_Details[];
-        total_result_count: number;
-    };
+    categories: Affiliate_Category_Details[];
+    total_result_count: number;
 }
 interface Affiliate_Categories_Result {
-    resp_result: Affiliate_Categories;
+    resp_result: {
+        resp_code: number;
+        resp_msg: string;
+        result: Affiliate_Categories;
+    };
 }
 /**
  * AFFILIATE API
- * FEATURED PROMO
+ * FEATURED PROMO INFO
  */
+interface Affiliate_Featuredpromo_Info_Params extends Affiliate_Categories_Params {
+}
+interface Affiliate_Featuredpromo_Details {
+    promo_desc: string;
+    promo_name: string;
+    product_num: number;
+}
+interface Affiliate_Featuredpromo_Info {
+    current_record_count: number;
+    promos: Affiliate_Featuredpromo_Details;
+}
+interface Affiliate_Featuredpromo_Info_Result {
+    resp_code: number;
+    resp_msg: string;
+    result: Affiliate_Featuredpromo_Info;
+}
+/**
+ * AFFILIATE API
+ * FEATURED PROMO PRODUCTS
+ */
 interface Affiliate_Featured_Promo_Products_Params extends Affiliate_Base_Product_Params {
@@ -737,2 +787,57 @@ category_id?: string;
 }
+/**
+ * AFFILIATE API
+ * GET ORDER INFO
+ */
+interface Affiliate_Order_Info_Params {
+    app_signature?: string;
+    fields?: string;
+    order_ids?: string;
+}
+interface Affiliate_Order_Details {
+    estimated_finished_commission: number;
+    product_detail_url: string;
+    estimated_paid_commission: number;
+    product_count: number;
+    order_number: number;
+    is_hot_product: "Y" | "N";
+    parent_order_number: number;
+    product_main_image_url: string;
+    order_status: string;
+    settled_currency: string;
+    category_id: number;
+    product_id: number;
+    order_type: string;
+    tracking_id: string;
+    created_time: string;
+    finished_time: string;
+    completed_settlement_time: string;
+    paid_time: string;
+    customer_parameters: string;
+    is_new_buyer: "Y" | "N";
+    ship_to_country: string;
+    sub_order_id: number;
+    product_title: string;
+    incentive_commission_rate: string;
+    new_buyer_bonus_commission: number;
+    estimated_incentive_paid_commission: number;
+    is_affiliate_product: "Y" | "N";
+    paid_amount: number;
+    effect_detail_status: string;
+    estimated_incentive_finished_commission: number;
+    commission_rate: string;
+    finished_amount: number;
+    order_id: number;
+}
+interface Affiliate_Order_Info {
+    current_record_count: number;
+    orders: Affiliate_Order_Details[];
+}
+interface Affiliate_Order_Info_Result {
+    resp_result: {
+        result: Affiliate_Order_Info;
+        resp_code?: number;
+        resp_msg?: string;
+    };
+}
 
@@ -754,7 +859,57 @@ declare class AEBaseClient implements AE_Base_Client {
     constructor(init: AE_Base_Client);
+    /**
+     *
+     * @link https://open.aliexpress.com/doc/api.htm#/api?cid=21407&path=aliexpress.affiliate.link.generate&methodType=GET/POST
+     *
+     */
+    generateAffiliateLinks(args: Affiliate_Generate_Affiliate_Links_Params): Promise<Affiliate_Generate_Affiliate_Links_Result | undefined>;
+    /**
+     *
+     * @link https://open.aliexpress.com/doc/api.htm#/api?cid=21407&path=aliexpress.affiliate.category.get&methodType=GET/POST
+     *
+     */
+    getCategories(args: Affiliate_Categories_Params): Promise<Affiliate_Categories_Result | undefined>;
+    /**
+     *
+     * @link https://open.aliexpress.com/doc/api.htm#/api?cid=21407&path=aliexpress.affiliate.featuredpromo.get&methodType=GET/POST
+     *
+     */
+    getFeaturedPromoInfo(args: Affiliate_Featuredpromo_Info_Params): Promise<Affiliate_Featuredpromo_Info_Result | undefined>;
+    /**
+     *
+     * @link https://open.aliexpress.com/doc/api.htm#/api?cid=21407&path=aliexpress.affiliate.featuredpromo.products.get&methodType=GET/POST
+     *
+     */
+    getFeaturedPromoProducts(args: Affiliate_Featured_Promo_Products_Params): Promise<Affiliate_Featured_Promo_Products_Result | undefined>;
+    /**
+     *
+     * @link https://open.aliexpress.com/doc/api.htm#/api?cid=21407&path=aliexpress.affiliate.hotproduct.download&methodType=GET/POST
+     *
+     */
+    /**
+     *
+     * @link https://open.aliexpress.com/doc/api.htm#/api?cid=21407&path=aliexpress.affiliate.hotproduct.query&methodType=GET/POST
+     *
+     */
+    getHotProducts(args: Affiliate_Products_Params): Promise<Affiliate_Products_Result | undefined>;
+    /**
+     *
+     * @link https://open.aliexpress.com/doc/api.htm#/api?cid=21407&path=aliexpress.affiliate.order.get&methodType=GET/POST
+     *
+     */
+    getOrderInfo(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
+     */
+    /**
+     * @link https://open.aliexpress.com/doc/api.htm#/api?cid=21407&path=aliexpress.affiliate.order.listbyindex&methodType=GET/POST
+     */
+    /**
+     * @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>;
+    /**
+     * @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>;
-    queryHotProducts(args: Affiliate_Products_Params): Promise<Affiliate_Products_Result | undefined>;
-    categories(): Promise<Affiliate_Categories_Result | undefined>;
-    featuredPromo(args: Affiliate_Featured_Promo_Products_Params): Promise<Affiliate_Featured_Promo_Products_Result | undefined>;
-    productDetails(args: Affiliate_Product_Details_Params): Promise<Affiliate_Product_Details_Result | undefined>;
 }
@@ -764,5 +919,25 @@
     constructor(init: AE_Base_Client);
+    /**
+     *
+     * @link https://open.aliexpress.com/doc/api.htm#/api?cid=3&path=/auth/token/security/create&methodType=GET/POST
+     *
+     */
     generateSecurityToken(args: AES_Generate_Security_Token_Params): Promise<AES_Generate_Security_Token_Result | undefined>;
+    /**
+     *
+     * @link https://open.aliexpress.com/doc/api.htm#/api?cid=3&path=/auth/token/create&methodType=GET/POST
+     *
+     */
     generateToken(args: AES_Generate_Token_Params): Promise<AES_Generate_Token_Result | undefined>;
+    /**
+     *
+     * @link https://open.aliexpress.com/doc/api.htm#/api?cid=3&path=/auth/token/security/refresh&methodType=GET/POST
+     *
+     */
     refreshSecurityToken(args: AES_Refresh_Security_Token_Params): Promise<AES_Refresh_Security_Token_Result | undefined>;
+    /**
+     *
+     * @link https://open.aliexpress.com/doc/api.htm#/api?cid=3&path=/auth/token/refresh&methodType=GET/POST
+     *
+     */
     refreshToken(args: AES_Refresh_Token_Params): Promise<AES_Refresh_Token_Result | undefined>;
@@ -773,6 +948,23 @@ }
     constructor(init: AE_Base_Client);
-    queryProducts(args: DS_ProductAPI_Recommended_Products_Params): Promise<DS_ProductAPI_Recommended_Products_Result | undefined>;
-    productDetails(args: DS_ProductAPI_Product_Params): Promise<DS_ProductAPI_Product_Result | undefined>;
+    /**
+     * @link https://open.aliexpress.com/doc/api.htm#/api?cid=21038&path=aliexpress.logistics.buyer.freight.calculate&methodType=GET/POST
+     */
     shippingInfo(args: DS_ShippingAPI_Shipping_Info_Params): Promise<DS_ShippingAPI_Shipping_Info_Result | undefined>;
+    /**
+     * @link https://open.aliexpress.com/doc/api.htm#/api?cid=21038&path=aliexpress.logistics.ds.trackinginfo.query&methodType=GET/POST
+     */
     trackingInfo(args: DS_ShippingAPI_Tracking_Info_Params): Promise<DS_ShippingAPI_Tracking_Info_Result | undefined>;
+    /**
+     * @link https://open.aliexpress.com/doc/api.htm#/api?cid=21038&path=aliexpress.ds.add.info&methodType=GET/POST
+     */
+    /**
+     * @link https://open.aliexpress.com/doc/api.htm#/api?cid=21038&path=aliexpress.ds.image.search&methodType=GET/POST
+     */
+    /**
+     * @link https://open.aliexpress.com/doc/api.htm#/api?cid=21038&path=aliexpress.ds.recommend.feed.get&methodType=GET/POST
+     */
+    queryfeaturedPromoProducts(args: DS_ProductAPI_Recommended_Products_Params): Promise<DS_ProductAPI_Recommended_Products_Result | undefined>;
+    /**
+     * @link https://open.aliexpress.com/doc/api.htm#/api?cid=21038&path=aliexpress.trade.buy.placeorder&methodType=GET/POST
+     */
     createOrder({ logistics_address, product_items, }: {
@@ -782,5 +974,24 @@ logistics_address: AE_Logistics_Address;
     }): Promise<DS_OrderAPI_Place_Order_Result | undefined>;
+    /**
+     * @link https://open.aliexpress.com/doc/api.htm#/api?cid=21038&path=aliexpress.trade.ds.order.get&methodType=GET/POST
+     */
     orderDetails(args: DS_OrderAPI_Get_Order_Params): Promise<DS_OrderAPI_Get_Order_Result | undefined>;
+    /**
+     * @link https://open.aliexpress.com/doc/api.htm#/api?cid=21038&path=aliexpress.ds.feedname.get&methodType=GET/POST
+     */
+    /**
+     * @link https://open.aliexpress.com/doc/api.htm#/api?cid=21038&path=aliexpress.ds.category.get&methodType=GET/POST
+     */
+    /**
+     * @link https://open.aliexpress.com/doc/api.htm#/api?cid=21038&path=aliexpress.ds.commissionorder.listbyindex&methodType=GET/POST
+     */
+    /**
+     * @link https://open.aliexpress.com/doc/api.htm#/api?cid=21038&path=aliexpress.ds.member.orderdata.submit&methodType=GET/POST
+     */
+    /**
+     * @link https://open.aliexpress.com/doc/api.htm#/api?cid=21038&path=aliexpress.ds.recommend.feed.get&methodType=GET/POST
+     */
+    productDetails(args: DS_ProductAPI_Product_Params): Promise<DS_ProductAPI_Product_Result | undefined>;
 }
 
-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_Result, Affiliate_Category_Details, Affiliate_Featured_Promo_Product, Affiliate_Featured_Promo_Products_Params, Affiliate_Featured_Promo_Products_Result, Affiliate_Hotproducts, Affiliate_Hotproducts_Params, Affiliate_Hotproducts_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, 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_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 };

dist/index.js

@@ -126,18 +126,38 @@ "use strict";
   }
-  queryProducts(args) {
+  /**
+   *
+   * @link https://open.aliexpress.com/doc/api.htm#/api?cid=21407&path=aliexpress.affiliate.link.generate&methodType=GET/POST
+   *
+   */
+  generateAffiliateLinks(args) {
     return __async(this, null, function* () {
-      return yield this.execute("aliexpress.affiliate.product.query", args);
+      return yield this.execute("aliexpress.affiliate.link.generate", args);
     });
   }
-  queryHotProducts(args) {
+  /**
+   *
+   * @link https://open.aliexpress.com/doc/api.htm#/api?cid=21407&path=aliexpress.affiliate.category.get&methodType=GET/POST
+   *
+   */
+  getCategories(args) {
     return __async(this, null, function* () {
-      return yield this.execute("aliexpress.affiliate.hotproduct.query", args);
+      return yield this.execute("aliexpress.affiliate.category.get", args);
     });
   }
-  categories() {
+  /**
+   *
+   * @link https://open.aliexpress.com/doc/api.htm#/api?cid=21407&path=aliexpress.affiliate.featuredpromo.get&methodType=GET/POST
+   *
+   */
+  getFeaturedPromoInfo(args) {
     return __async(this, null, function* () {
-      return yield this.execute("aliexpress.affiliate.category.get", null);
+      return yield this.execute("aliexpress.affiliate.featuredpromo.get", args);
     });
   }
-  featuredPromo(args) {
+  /**
+   *
+   * @link https://open.aliexpress.com/doc/api.htm#/api?cid=21407&path=aliexpress.affiliate.featuredpromo.products.get&methodType=GET/POST
+   *
+   */
+  getFeaturedPromoProducts(args) {
     return __async(this, null, function* () {
@@ -150,7 +170,56 @@ return yield this.execute(
   }
-  productDetails(args) {
+  /**
+   *
+   * @link https://open.aliexpress.com/doc/api.htm#/api?cid=21407&path=aliexpress.affiliate.hotproduct.download&methodType=GET/POST
+   *
+   */
+  // todo: add get hotproduct download
+  /**
+   *
+   * @link https://open.aliexpress.com/doc/api.htm#/api?cid=21407&path=aliexpress.affiliate.hotproduct.query&methodType=GET/POST
+   *
+   */
+  getHotProducts(args) {
     return __async(this, null, function* () {
+      return yield this.execute("aliexpress.affiliate.hotproduct.query", args);
+    });
+  }
+  /**
+   *
+   * @link https://open.aliexpress.com/doc/api.htm#/api?cid=21407&path=aliexpress.affiliate.order.get&methodType=GET/POST
+   *
+   */
+  getOrderInfo(args) {
+    return __async(this, null, function* () {
+      return yield this.execute("aliexpress.affiliate.order.get", args);
+    });
+  }
+  /**
+   * @link https://open.aliexpress.com/doc/api.htm#/api?cid=21407&path=aliexpress.affiliate.order.list&methodType=GET/POST
+   */
+  // todo: add get order list
+  /**
+   * @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
+  /**
+   * @link https://open.aliexpress.com/doc/api.htm#/api?cid=21407&path=aliexpress.affiliate.productdetail.get&methodType=GET/POST
+   */
+  getProductDetails(args) {
+    return __async(this, null, function* () {
       return yield this.execute("aliexpress.affiliate.productdetail.get", args);
     });
   }
+  /**
+   * @link https://open.aliexpress.com/doc/api.htm#/api?cid=21407&path=aliexpress.affiliate.product.query&methodType=GET/POST
+   */
+  queryProducts(args) {
+    return __async(this, null, function* () {
+      return yield this.execute("aliexpress.affiliate.product.query", args);
+    });
+  }
+  /**
+   * @link https://open.aliexpress.com/doc/api.htm#/api?cid=21407&path=aliexpress.affiliate.product.smartmatch&methodType=GET/POST
+   */
+  // todo: add smart match products
 };
@@ -163,2 +232,7 @@
   }
+  /**
+   *
+   * @link https://open.aliexpress.com/doc/api.htm#/api?cid=3&path=/auth/token/security/create&methodType=GET/POST
+   *
+   */
   generateSecurityToken(args) {
@@ -169,2 +243,7 @@ return __async(this, null, function* () {
   }
+  /**
+   *
+   * @link https://open.aliexpress.com/doc/api.htm#/api?cid=3&path=/auth/token/create&methodType=GET/POST
+   *
+   */
   generateToken(args) {
@@ -175,2 +254,7 @@ return __async(this, null, function* () {
   }
+  /**
+   *
+   * @link https://open.aliexpress.com/doc/api.htm#/api?cid=3&path=/auth/token/security/refresh&methodType=GET/POST
+   *
+   */
   refreshSecurityToken(args) {
@@ -181,2 +265,7 @@ return __async(this, null, function* () {
   }
+  /**
+   *
+   * @link https://open.aliexpress.com/doc/api.htm#/api?cid=3&path=/auth/token/refresh&methodType=GET/POST
+   *
+   */
   refreshToken(args) {
@@ -194,12 +283,5 @@ return __async(this, null, function* () {
   }
-  queryProducts(args) {
-    return __async(this, null, function* () {
-      return yield this.execute("aliexpress.ds.recommend.feed.get", args);
-    });
-  }
-  productDetails(args) {
-    return __async(this, null, function* () {
-      return yield this.execute("aliexpress.ds.product.get", args);
-    });
-  }
+  /**
+   * @link https://open.aliexpress.com/doc/api.htm#/api?cid=21038&path=aliexpress.logistics.buyer.freight.calculate&methodType=GET/POST
+   */
   shippingInfo(args) {
@@ -213,2 +295,5 @@ return __async(this, null, function* () {
   }
+  /**
+   * @link https://open.aliexpress.com/doc/api.htm#/api?cid=21038&path=aliexpress.logistics.ds.trackinginfo.query&methodType=GET/POST
+   */
   trackingInfo(args) {
@@ -222,2 +307,21 @@ return __async(this, null, function* () {
   }
+  /**
+   * @link https://open.aliexpress.com/doc/api.htm#/api?cid=21038&path=aliexpress.ds.add.info&methodType=GET/POST
+   */
+  // todo: add ds info
+  /**
+   * @link https://open.aliexpress.com/doc/api.htm#/api?cid=21038&path=aliexpress.ds.image.search&methodType=GET/POST
+   */
+  // todo: ae dropshiper image search
+  /**
+   * @link https://open.aliexpress.com/doc/api.htm#/api?cid=21038&path=aliexpress.ds.recommend.feed.get&methodType=GET/POST
+   */
+  queryfeaturedPromoProducts(args) {
+    return __async(this, null, function* () {
+      return yield this.execute("aliexpress.ds.recommend.feed.get", args);
+    });
+  }
+  /**
+   * @link https://open.aliexpress.com/doc/api.htm#/api?cid=21038&path=aliexpress.trade.buy.placeorder&methodType=GET/POST
+   */
   createOrder(_0) {
@@ -236,2 +340,5 @@ return __async(this, arguments, function* ({
   }
+  /**
+   * @link https://open.aliexpress.com/doc/api.htm#/api?cid=21038&path=aliexpress.trade.ds.order.get&methodType=GET/POST
+   */
   orderDetails(args) {
@@ -242,2 +349,26 @@ return __async(this, null, function* () {
   }
+  /**
+   * @link https://open.aliexpress.com/doc/api.htm#/api?cid=21038&path=aliexpress.ds.feedname.get&methodType=GET/POST
+   */
+  // todo: add ds feedname get
+  /**
+   * @link https://open.aliexpress.com/doc/api.htm#/api?cid=21038&path=aliexpress.ds.category.get&methodType=GET/POST
+   */
+  // todo: add ds get category
+  /**
+   * @link https://open.aliexpress.com/doc/api.htm#/api?cid=21038&path=aliexpress.ds.commissionorder.listbyindex&methodType=GET/POST
+   */
+  // todo: add ds order query by index
+  /**
+   * @link https://open.aliexpress.com/doc/api.htm#/api?cid=21038&path=aliexpress.ds.member.orderdata.submit&methodType=GET/POST
+   */
+  // todo: add ds order submit
+  /**
+   * @link https://open.aliexpress.com/doc/api.htm#/api?cid=21038&path=aliexpress.ds.recommend.feed.get&methodType=GET/POST
+   */
+  productDetails(args) {
+    return __async(this, null, function* () {
+      return yield this.execute("aliexpress.ds.product.get", args);
+    });
+  }
 };
@@ -244,0 +375,0 @@ // Annotate the CommonJS export names for ESM import in node:

package.json

 {
   "name": "ae_sdk",
-  "version": "0.3.0",
+  "version": "0.3.1",
   "description": "A simple SDK for Aliexpress (dropshipping and affiliate) APIs.",
@@ -5,0 +5,0 @@ "private": false,

README.md

@@ -8,2 +8,3 @@ # AE_SDK
 - 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`;
@@ -10,0 +11,0 @@ - Add unit tests;

New alerts

License Policy Violation

License

This 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

License

This 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

104925

increased by33.74%

Lines of code

1704

increased by38.99%

Number of lines in readme file

26

increased by4%

No dependency changes