ebay-api 7.1.3 → 8.0.0

package/README.md

@@ -20,7 +20,7 @@ It supports `client credentials grant` and `authorization code grant` \(Auth'N'A
 
 ## Changelog
 
-* `v7.1.3` is the latest release.
+* `v8.0.0-RC.0` is the latest release.
 * See [here](https://github.com/hendt/ebay-api/blob/master/CHANGELOG.md) for the full changelog.
 
 ## Implementation status
@@ -76,6 +76,7 @@ console.log(JSON.stringify(item, null, 2));
 ```
 
 #### Detailed configuration example
+
 ```javascript
 import eBayApi from 'ebay-api';
 
@@ -85,15 +86,15 @@ const eBay = new eBayApi({
   sandbox: false,
 
   siteId: eBayApi.SiteId.EBAY_US, // required for traditional APIs, see https://developer.ebay.com/DevZone/merchandising/docs/Concepts/SiteIDToGlobalID.html
-  
-  marketplaceId:  eBayApi.MarketplaceId.EBAY_US, // defautl. required for RESTful APIs
+
+  marketplaceId: eBayApi.MarketplaceId.EBAY_US, // defautl. required for RESTful APIs
   acceptLanguage: eBayApi.Locale.en_US, // defautl
   contentLanguage: eBayApi.ContentLanguage.en_US, // defautl.
 
   // optional parameters, should be omitted if not used
   devId: '-- devId --', // required for traditional Trading API
   ruName: '-- eBay Redirect URL name --', // 'RuName' (eBay Redirect URL name) required for authorization code grant
-  
+
   authToken: '--  Auth\'n\'Auth for traditional API (used by trading) --', // can be set to use traditional API without code grant
 });
 ```
@@ -106,28 +107,28 @@ For testing purpose you can use `https://ebay.hendt.workers.dev/` url as proxy.
 
 Or use [https://github.com/Rob--W/cors-anywhere](CORS Anywhere is a NodeJS proxy) (works very well with heroku.com).
 
-
 ```html
+
 <script type="text/javascript" src="https://cdn.jsdelivr.net/npm/ebay-api@latest/lib/ebay-api.min.js"></script>
 <script>
   const eBay = new eBayApi({
-    appId: 'appId',
-    certId: 'certId',
-    sandbox: false
-  });
+        appId: 'appId',
+        certId: 'certId',
+        sandbox: false
+    });
 
-  // eBay.req.instance is AxiosInstance per default
-  eBay.req.instance.interceptors.request.use((request) => {
-      // Add Proxy
-      request.url = 'https://ebay.hendt.workers.dev/' + request.url;
-      return request;
-  });
+    // eBay.req.instance is AxiosInstance per default
+    eBay.req.instance.interceptors.request.use((request) => {
+        // Add Proxy
+        request.url = 'https://ebay.hendt.workers.dev/' + request.url;
+        return request;
+    });
 
-  eBay.buy.browse.getItem('v1|254188828753|0').then(item => {
-      console.log(JSON.stringify(item, null, 2));
-  }).catch(e => {
-      console.error(e);
-  });
+    eBay.buy.browse.getItem('v1|254188828753|0').then(item => {
+        console.log(JSON.stringify(item, null, 2));
+    }).catch(e => {
+        console.error(e);
+    });
 </script>
 ```
 
@@ -237,7 +238,7 @@ app.get('/success', async function(req, res) {
     // 5. Start using the API
     const orders = await eBay.sell.fulfillment.getOrders()
     res.send(orders);
-  } catch(e) {
+  } catch (e) {
     console.error(e)
     res.sendStatus(400)
   }
@@ -258,17 +259,17 @@ app.get('/orders/:id', async function(req, res) {
   }
 
   eBay.OAuth2.setCredentials(token);
-  
+
   // If token get's refreshed
   eBay.OAuth2.on('refreshAuthToken', (token) => {
     req.session.token = token;
   });
-  
+
   try {
     // 5. Start using the API
     const order = await eBay.sell.fulfillment.getOrder(id);
     res.send(order);
-  } catch(e) {
+  } catch (e) {
     console.error(e)
     res.sendStatus(400)
   }
@@ -342,14 +343,17 @@ You have multiple options to do this.
 
 
 ### RESTful API headers
+
 ```javascript
   const eBay = new eBayApi();
 
-  eBay.buy.browse.api({headers: {
-      'X-EBAY-SOA-GLOBAL-ID': 'EBAY-DE'
-  }}).getItem('v1|382282567190|651094235351').then((item) => {
-    console.log(item)
-  })
+eBay.buy.browse.api({
+  headers: {
+    'X-EBAY-SOA-GLOBAL-ID': 'EBAY-DE'
+  }
+}).getItem('v1|382282567190|651094235351').then((item) => {
+  console.log(item)
+})
 ```
 
 ### Traditional API headers
@@ -370,15 +374,17 @@ eBay.trading.AddFixedPriceItem({
 ```
 
 ### Low level: use the Axios interceptor to manipulate the request
+
 ```javascript
-  import eBayApi from 'ebay-api';
-  const eBay = new eBayApi(/* {  your config here } */);
-
-  eBay.req.instance.interceptors.request.use((request) => {
-    // Add Header
-    request.headers['X-EBAY-SOA-GLOBAL-ID'] = 'EBAY-DE';
-    return request;
-  })
+import eBayApi from 'ebay-api';
+
+const eBay = new eBayApi(/* {  your config here } */);
+
+eBay.req.instance.interceptors.request.use((request) => {
+  // Add Header
+  request.headers['X-EBAY-SOA-GLOBAL-ID'] = 'EBAY-DE';
+  return request;
+})
 ```
 
 ### Handle JSON GZIP response e.g fetchItemAspects
@@ -389,26 +395,26 @@ npm install zlib # or yarn add zlib
 ```
 
 ```javascript
-  import eBayApi from 'ebay-api';
-  import zlib from 'zlib';
+import eBayApi from 'ebay-api';
+import zlib from 'zlib';
 
-  const toString = (data) => new Promise((resolve) => {
-    zlib.gunzip(data, (err, output) => {
-      if (err) throw err;
-      resolve(output.toString());
-    });
+const toString = (data) => new Promise((resolve) => {
+  zlib.gunzip(data, (err, output) => {
+    if (err) throw err;
+    resolve(output.toString());
   });
+});
 
-  const eBay = new eBayApi(/* {  your config here } */);
+const eBay = new eBayApi(/* {  your config here } */);
 
-  try {
-    const data = await eBay.commerce.taxonomy.fetchItemAspects(/* categoryTreeId */);
-    const result = await toString(data);
-    
-    console.log(result)
-  } catch (e) {
-    console.error(e);
-  }
+try {
+  const data = await eBay.commerce.taxonomy.fetchItemAspects(/* categoryTreeId */);
+  const result = await toString(data);
+
+  console.log(result)
+} catch (e) {
+  console.error(e);
+}
 ```
 
 ## Controlling Traditional XML request and response

package/dist/api/apiFactory.d.ts

@@ -0,0 +1,27 @@
+import { ClientAlerts, Finding, Shopping, Trading, Merchandising } from '../types/index.js';
+import Api from './index.js';
+import { Buy } from './restful/buy/index.js';
+import { Commerce } from './restful/commerce/index.js';
+import { Developer } from './restful/developer/index.js';
+import { PostOrder } from './restful/postOrder/index.js';
+import { Sell } from './restful/sell/index.js';
+import Traditional from './traditional/index.js';
+/**
+ * Factory class to create RESTFul API or Traditional API.
+ */
+export default class ApiFactory extends Api {
+    private _traditional?;
+    private _restful;
+    createBuyApi(): Buy;
+    createCommerceApi(): Commerce;
+    createDeveloperApi(): Developer;
+    createPostOrderApi(): PostOrder;
+    createSellApi(): Sell;
+    get traditional(): Traditional;
+    createTradingApi(): Trading;
+    createShoppingApi(): Shopping;
+    createFindingApi(): Finding;
+    createClientAlertsApi(): ClientAlerts;
+    createMerchandisingApi(): Merchandising;
+    private createRestfulApi;
+}

package/dist/api/apiFactory.js

@@ -0,0 +1,94 @@
+import Api from './index.js';
+import { Browse, Deal, Feed, Marketing as BuyMarketing, MarketplaceInsights, Offer, Order } from './restful/buy/index.js';
+import { Catalog, Charity, Identity, Notification, Taxonomy, Translation } from './restful/commerce/index.js';
+import { Analytics as DeveloperAnalytics, KeyManagement } from './restful/developer/index.js';
+import { Cancellation, Case, Inquiry, Return, } from './restful/postOrder/index.js';
+import { Account, Analytics as SellAnalytics, Compliance, Feed as SellFeed, Finances, Fulfillment, Inventory, Listing, Logistics, Marketing as SellMarketing, Metadata, Negotiation, Recommendation } from './restful/sell/index.js';
+import Traditional from './traditional/index.js';
+/**
+ * Factory class to create RESTFul API or Traditional API.
+ */
+export default class ApiFactory extends Api {
+    constructor() {
+        super(...arguments);
+        this._restful = {};
+    }
+    createBuyApi() {
+        return {
+            browse: this.createRestfulApi(Browse),
+            feed: this.createRestfulApi(Feed),
+            marketing: this.createRestfulApi(BuyMarketing),
+            offer: this.createRestfulApi(Offer),
+            order: this.createRestfulApi(Order),
+            deal: this.createRestfulApi(Deal),
+            marketplaceInsights: this.createRestfulApi(MarketplaceInsights),
+        };
+    }
+    createCommerceApi() {
+        return {
+            catalog: this.createRestfulApi(Catalog),
+            identity: this.createRestfulApi(Identity),
+            taxonomy: this.createRestfulApi(Taxonomy),
+            translation: this.createRestfulApi(Translation),
+            charity: this.createRestfulApi(Charity),
+            notification: this.createRestfulApi(Notification),
+        };
+    }
+    createDeveloperApi() {
+        return {
+            analytics: this.createRestfulApi(DeveloperAnalytics),
+            keyManagement: this.createRestfulApi(KeyManagement),
+        };
+    }
+    createPostOrderApi() {
+        return {
+            cancellation: this.createRestfulApi(Cancellation),
+            case: this.createRestfulApi(Case),
+            inquiry: this.createRestfulApi(Inquiry),
+            return: this.createRestfulApi(Return),
+        };
+    }
+    createSellApi() {
+        return {
+            account: this.createRestfulApi(Account),
+            analytics: this.createRestfulApi(SellAnalytics),
+            compliance: this.createRestfulApi(Compliance),
+            fulfillment: this.createRestfulApi(Fulfillment),
+            inventory: this.createRestfulApi(Inventory),
+            marketing: this.createRestfulApi(SellMarketing),
+            metadata: this.createRestfulApi(Metadata),
+            recommendation: this.createRestfulApi(Recommendation),
+            finances: this.createRestfulApi(Finances),
+            feed: this.createRestfulApi(SellFeed),
+            logistics: this.createRestfulApi(Logistics),
+            negotiation: this.createRestfulApi(Negotiation),
+            listing: this.createRestfulApi(Listing),
+        };
+    }
+    get traditional() {
+        if (this._traditional) {
+            return this._traditional;
+        }
+        return (this._traditional = new Traditional(this.config, this.req, this.auth));
+    }
+    createTradingApi() {
+        return this.traditional.createTradingApi();
+    }
+    createShoppingApi() {
+        return this.traditional.createShoppingApi();
+    }
+    createFindingApi() {
+        return this.traditional.createFindingApi();
+    }
+    createClientAlertsApi() {
+        return this.traditional.createClientAlertsApi();
+    }
+    createMerchandisingApi() {
+        return this.traditional.createMerchandisingApi();
+    }
+    // tslint:disable-next-line:variable-name
+    createRestfulApi(RestfulApiClass) {
+        const id = RestfulApiClass.id;
+        return (this._restful[id] || (this._restful[id] = new RestfulApiClass(this.config, this.req, this.auth)));
+    }
+}

package/dist/api/base.d.ts

@@ -0,0 +1,10 @@
+import { IEBayApiRequest } from '../request.js';
+import { AppConfig } from '../types/index.js';
+/**
+ * Abstract superclass.
+ */
+export default abstract class Base {
+    readonly config: AppConfig;
+    readonly req: IEBayApiRequest;
+    protected constructor(config: AppConfig, req?: IEBayApiRequest);
+}

package/dist/api/base.js

@@ -0,0 +1,10 @@
+import { AxiosRequest } from '../request.js';
+/**
+ * Abstract superclass.
+ */
+export default class Base {
+    constructor(config, req = new AxiosRequest(config.axiosConfig)) {
+        this.config = config;
+        this.req = req;
+    }
+}

package/dist/api/index.d.ts

@@ -0,0 +1,11 @@
+import Auth from '../auth/index.js';
+import { IEBayApiRequest } from '../request.js';
+import { AppConfig } from '../types/index.js';
+import Base from './base.js';
+/**
+ * Superclass with Auth container.
+ */
+export default abstract class Api extends Base {
+    readonly auth: Auth;
+    constructor(config: AppConfig, req?: IEBayApiRequest, auth?: Auth);
+}

package/dist/api/index.js

@@ -0,0 +1,11 @@
+import Auth from '../auth/index.js';
+import Base from './base.js';
+/**
+ * Superclass with Auth container.
+ */
+export default class Api extends Base {
+    constructor(config, req, auth) {
+        super(config, req);
+        this.auth = auth || new Auth(this.config, this.req);
+    }
+}

package/dist/api/restful/buy/browse/index.d.ts

@@ -0,0 +1,84 @@
+import Restful from '../../index.js';
+import { AddCartItemInput, BrowseSearchParams, CompatibilityPayload, ItemsParams, LegacyItemParams, RemoveCartItemInput, SearchByImageParams, UpdateCartItemInput } from '../../../../types/index.js';
+/**
+ * The Browse API has the following resources: item_summary: Lets shoppers search for specific items by keyword, GTIN,
+ * category, charity, product, or item aspects and refine the results by using filters, such as aspects, compatibility,
+ * and fields values.
+ */
+export default class Browse extends Restful {
+    static id: string;
+    get basePath(): string;
+    /**
+     * This method searches for eBay items by various query parameters and retrieves summaries of the items.
+     *
+     * @param {BrowseSearchParams} params
+     */
+    search(params: BrowseSearchParams): Promise<any>;
+    /**
+     * This is an Experimental method. This method searches for eBay items based on a image and retrieves summaries of
+     * the items.
+     *
+     * @param {BrowseSearchParams} params
+     * @param {Object} body The container for the image information fields.
+     */
+    searchByImage(params: SearchByImageParams, body?: {}): Promise<any>;
+    /**
+     * This method retrieves the details of specific items that the buyer needs to make a purchasing decision.
+     *
+     * @param itemIds A list of item IDs. Item IDs are the eBay RESTful identifier of items.
+     * @param itemGroupIds A list of item group IDs.
+     */
+    getItems({ itemIds: item_ids, itemGroupIds: item_group_ids }: ItemsParams): Promise<any>;
+    /**
+     * This method retrieves the details of a specific item, such as description, price, category, all item aspects,
+     * condition, return policies, seller feedback and score, shipping options, shipping costs, estimated delivery,
+     * and other information the buyer needs to make a purchasing decision.
+     *
+     * @param {String} itemId The eBay RESTful identifier of an item.
+     * @param {String} fieldgroups
+     */
+    getItem(itemId: string, fieldgroups?: string): Promise<any>;
+    /**
+     * This method is a bridge between the eBay legacy APIs, such as Shopping, and Finding and the eBay Api APIs.
+     *
+     * @param {LegacyItemParams} params
+     */
+    getItemByLegacyId(params: LegacyItemParams): Promise<any>;
+    /**
+     * This method retrieves the details of the individual items in an item group.
+     *
+     * @param itemGroupId
+     */
+    getItemsByItemGroup(itemGroupId: string): Promise<any>;
+    /**
+     * This method checks if a product is compatible with the specified item.
+     * @param {String} itemId The eBay RESTful identifier of an item (such as a part you want to check).
+     * @param {Object} body CompatibilityPayload
+     */
+    checkCompatibility(itemId: string, body?: CompatibilityPayload): Promise<any>;
+    /**
+     * This is an Experimental method. This method creates an eBay cart for the eBay member, if one does not exist, and
+     * adds items to that cart.
+     *
+     * @param {Object} item AddCartItemInput
+     */
+    addItem(item: AddCartItemInput): Promise<any>;
+    /**
+     * This is an experimental method. This method retrieves all the items in the eBay member's cart;
+     * items added to the cart while on ebay.com as well as items added to the cart using the Browse API.
+     */
+    getShoppingCart(): Promise<any>;
+    /**
+     * This is an experimental method. This method removes a specific item from the eBay member's cart.
+     *
+     *  @param {Object} item RemoveCartItemInput
+     */
+    removeItem(item: RemoveCartItemInput): Promise<any>;
+    /**
+     * This is an experimental method. This method updates the quantity value of a specific item in the eBay member's
+     * cart.
+     *
+     * @param {UpdateCartItemInput} item UpdateCartItemInput
+     */
+    updateQuantity(item: UpdateCartItemInput): Promise<any>;
+}

package/dist/api/restful/buy/browse/index.js

@@ -0,0 +1,135 @@
+import Restful from '../../index.js';
+/**
+ * The Browse API has the following resources: item_summary: Lets shoppers search for specific items by keyword, GTIN,
+ * category, charity, product, or item aspects and refine the results by using filters, such as aspects, compatibility,
+ * and fields values.
+ */
+export default class Browse extends Restful {
+    get basePath() {
+        return '/buy/browse/v1';
+    }
+    //
+    // Item
+    // Client Credentials: https://api.ebay.com/oauth/api_scope
+    //
+    /**
+     * This method searches for eBay items by various query parameters and retrieves summaries of the items.
+     *
+     * @param {BrowseSearchParams} params
+     */
+    search(params) {
+        return this.get(`/item_summary/search`, {
+            params
+        });
+    }
+    /**
+     * This is an Experimental method. This method searches for eBay items based on a image and retrieves summaries of
+     * the items.
+     *
+     * @param {BrowseSearchParams} params
+     * @param {Object} body The container for the image information fields.
+     */
+    searchByImage(params, body = {}) {
+        return this.post(`/item_summary/search_by_image`, body, {
+            params
+        });
+    }
+    /**
+     * This method retrieves the details of specific items that the buyer needs to make a purchasing decision.
+     *
+     * @param itemIds A list of item IDs. Item IDs are the eBay RESTful identifier of items.
+     * @param itemGroupIds A list of item group IDs.
+     */
+    getItems({ itemIds: item_ids, itemGroupIds: item_group_ids }) {
+        return this.get(`/item/`, {
+            params: {
+                item_ids,
+                item_group_ids
+            }
+        });
+    }
+    /**
+     * This method retrieves the details of a specific item, such as description, price, category, all item aspects,
+     * condition, return policies, seller feedback and score, shipping options, shipping costs, estimated delivery,
+     * and other information the buyer needs to make a purchasing decision.
+     *
+     * @param {String} itemId The eBay RESTful identifier of an item.
+     * @param {String} fieldgroups
+     */
+    getItem(itemId, fieldgroups) {
+        const id = encodeURIComponent(itemId);
+        return this.get(`/item/${id}`, {
+            params: {
+                fieldgroups
+            }
+        });
+    }
+    /**
+     * This method is a bridge between the eBay legacy APIs, such as Shopping, and Finding and the eBay Api APIs.
+     *
+     * @param {LegacyItemParams} params
+     */
+    getItemByLegacyId(params) {
+        return this.get(`/item/get_item_by_legacy_id`, {
+            params
+        });
+    }
+    /**
+     * This method retrieves the details of the individual items in an item group.
+     *
+     * @param itemGroupId
+     */
+    getItemsByItemGroup(itemGroupId) {
+        return this.get(`/item/get_items_by_item_group`, {
+            params: {
+                item_group_id: itemGroupId
+            }
+        });
+    }
+    /**
+     * This method checks if a product is compatible with the specified item.
+     * @param {String} itemId The eBay RESTful identifier of an item (such as a part you want to check).
+     * @param {Object} body CompatibilityPayload
+     */
+    checkCompatibility(itemId, body) {
+        const id = encodeURIComponent(itemId);
+        return this.post(`/item/${id}/check_compatibility`, body);
+    }
+    //
+    // Shopping Cart
+    //
+    /**
+     * This is an Experimental method. This method creates an eBay cart for the eBay member, if one does not exist, and
+     * adds items to that cart.
+     *
+     * @param {Object} item AddCartItemInput
+     */
+    addItem(item) {
+        return this.post(`/shopping_cart/add_item`, item);
+    }
+    /**
+     * This is an experimental method. This method retrieves all the items in the eBay member's cart;
+     * items added to the cart while on ebay.com as well as items added to the cart using the Browse API.
+     */
+    getShoppingCart() {
+        return this.get(`/shopping_cart/`);
+    }
+    /**
+     * This is an experimental method. This method removes a specific item from the eBay member's cart.
+     *
+     *  @param {Object} item RemoveCartItemInput
+     */
+    removeItem(item) {
+        return this.post(`/shopping_cart/remove_item`, item);
+    }
+    /**
+     * This is an experimental method. This method updates the quantity value of a specific item in the eBay member's
+     * cart.
+     *
+     * @param {UpdateCartItemInput} item UpdateCartItemInput
+     */
+    updateQuantity(item) {
+        return this.post(`/shopping_cart/update_quantity`, item);
+    }
+}
+Browse.id = 'Browse';

package/dist/api/restful/buy/deal/index.d.ts

@@ -0,0 +1,55 @@
+import Restful from '../../index.js';
+/**
+ * This API allows third-party developers to search for and retrieve details about eBay deals and events, as well as the items associated with those deals and events.
+ */
+export default class Deal extends Restful {
+    static id: string;
+    get basePath(): string;
+    /**
+     * This method retrieves a paginated set of deal items.
+     *
+     * @param categoryIds The unique identifier of the eBay category for the search.
+     * @param commissionable A filter for commissionable deals. Restriction: This filter is currently only supported for the US marketplace.
+     * @param deliveryCountry A filter for items that can be shipped to the specified country.
+     * @param limit The maximum number of items, from the current result set, returned on a single page.
+     * @param offset The number of items that will be skipped in the result set.
+     */
+    getDealItems({ categoryIds, commissionable, deliveryCountry, limit, offset }: {
+        categoryIds?: string;
+        commissionable?: string;
+        deliveryCountry?: string;
+        limit?: string;
+        offset?: string;
+    }): Promise<any>;
+    /**
+     * This method retrieves the details for an eBay event.
+     *
+     * @param eventId The unique identifier for the eBay event.
+     */
+    getEvent(eventId: string): Promise<any>;
+    /**
+     * This method returns paginated results containing all eBay events for the specified marketplace.
+     *
+     * @param limit The maximum number of items, from the current result set, returned on a single page. Default: 20 Maximum Value: 100
+     * @param offset The number of items that will be skipped in the result set.
+     */
+    getEvents({ limit, offset }: {
+        limit?: string;
+        offset?: string;
+    }): Promise<any>;
+    /**
+     * This method returns paginated results containing all eBay events for the specified marketplace.
+     *
+     * @param eventIds The unique identifiers for the eBay events. Maximum Value: 1
+     * @param categoryIds The unique identifier of the eBay category for the search. Maximum Value: 1
+     * @param deliveryCountry A filter for items that can be shipped to the specified country.
+     * @param limit The maximum number of items, from the current result set, returned on a single page. Default: 20 Maximum Value: 100
+     * @param offset The number of items that will be skipped in the result set.
+     */
+    getEventItems(eventIds: string, { categoryIds, deliveryCountry, limit, offset }?: {
+        categoryIds?: string;
+        deliveryCountry?: string;
+        limit?: string;
+        offset?: string;
+    }): Promise<any>;
+}