ebay-api 8.4.0 → 8.5.0

package/README.md

@@ -9,7 +9,7 @@
 [![npm](https://img.shields.io/npm/dt/ebay-api.svg?style=flat-square)](https://www.npmjs.com/package/ebay-api)
 
 This eBay API implements both Traditional \(xml\) and the RESTful eBay API.
-It supports `client credentials grant` and `authorization code grant` \(Auth'N'Auth, OAuth2 and IAF\).
+It supports `client credentials grant` and `authorization code grant` \(Auth'N'Auth, OAuth2 and IAF\). Digital Signature is supported too.
 
 * [API Browser Examples](https://hendt.github.io/ebay-api/)
 * [API Documentation](https://hendt.gitbook.io/ebay-api/)
@@ -21,7 +21,7 @@ It supports `client credentials grant` and `authorization code grant` \(Auth'N'A
 
 ## Changelog
 
-* `v8.4.0` is the latest release.
+* `v8.5.0` is the latest release.
 * See [here](https://github.com/hendt/ebay-api/blob/master/CHANGELOG.md) for the full changelog.
 
 ## Implementation status
@@ -88,9 +88,9 @@ const eBay = new eBayApi({
 
   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
-  acceptLanguage: eBayApi.Locale.en_US, // defautl
-  contentLanguage: eBayApi.ContentLanguage.en_US, // defautl.
+  marketplaceId: eBayApi.MarketplaceId.EBAY_US, // default. required for RESTful APIs
+  acceptLanguage: eBayApi.Locale.en_US, // default
+  contentLanguage: eBayApi.ContentLanguage.en_US, // default.
 
   // optional parameters, should be omitted if not used
   devId: '-- devId --', // required for traditional Trading API
@@ -254,6 +254,8 @@ This is how it would look like if you use `express`:
 ```javascript
 import eBayApi from 'ebay-api';
 
+
+// This is your RUName endpoint like https://your-ebay.app/success
 app.get('/success', async function (req, res) {
   // 3. Get the parameter code that is placed as query parameter in redirected page
   const code = req.query.code; // this is provided from eBay
@@ -309,16 +311,16 @@ app.get('/orders/:id', async function (req, res) {
 ## Digital Signature
 Signatures are required when the call is made for EU- or UK-domiciled sellers, and only for the following APIs/methods:
 
-* All methods in the Finances API
-* issueRefund in the Fulfillment API
-* GetAccount in the Trading API
+* All methods in the Finances API -> (`eBay.finances.XXX.sign.YYY()`)
+* issueRefund in the Fulfillment API -> (`eBay.sell.fulfillment.sign.issueRefund()`)
+* GetAccount in the Trading API -> (`eBay.trading.GetAccount(null, { sign: true }))`)
 * The following methods in the Post-Order API:
-  - Issue Inquiry Refund
-  - Issue case refund
-  - Issue return refund
-  - Process Return Request
-  - Create Cancellation Request
-  - Approve Cancellation Request
+  - Issue Inquiry Refund -> (`eBay.postOrder.inquiry.sign.issueInquiryRefund()`)
+  - Issue case refund -> (`eBay.postOrder.inquiry.sign.issueCaseRefund()`)
+  - Issue return refund -> (`eBay.postOrder.inquiry.sign.issueReturnRefund()`)
+  - Process Return Request -> (`eBay.postOrder.inquiry.sign.processReturnRequest()`)
+  - Create Cancellation Request -> (`eBay.postOrder.inquiry.sign.createCancellation()`)
+  - Approve Cancellation Request -> (`eBay.postOrder.inquiry.sign.approveCancellationRequest()`)
 
 ### How to use Digital Signature
 ```js
@@ -375,7 +377,7 @@ In any case eBay adds a new subdomain, it's also possible to configure whatever
   eBay.buy.browse.api({subdomain: 'apiy'}).getItem() // now it will use https://apiy.ebay.com
 ```
 
-### Change RESTful API call config
+### Return raw RESTful API response
 
 ```javascript
   eBay.buy.browse.api({
@@ -403,8 +405,8 @@ eBay.OAuth2.on('refreshClientToken', (token) => {
 });
 ```
 
-To manuel refresh the auth token use `eBay.OAuth2.refreshAuthToken()` and for the client
-token `eBay.OAuth2.refreshClientToken()`.
+To manual refresh the auth token use `eBay.OAuth2.refreshAuthToken()` and for the client
+token use `eBay.OAuth2.refreshClientToken()`.
 Keep in mind that you need the 'refresh_token' value set.
 
 ```javascript

package/dist/api/apiFactory.d.ts

@@ -1,27 +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;
-}
+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

@@ -1,94 +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)));
-    }
-}
+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

@@ -1,10 +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);
-}
+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

@@ -1,10 +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;
-    }
-}
+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/digitalSignature.d.ts

@@ -1,43 +1,43 @@
-import { Cipher, Headers } from '../types/index.js';
-/**
- * Generates the 'Content-Digest' header value for the input payload.
- *
- * @param {any} payload The request payload.
- * @param {string} cipher The algorithm used to calculate the digest.
- * @returns {string} contentDigest The 'Content-Digest' header value.
- */
-export declare const generateContentDigestValue: (payload: unknown, cipher?: Cipher) => string;
-export type SignatureComponents = {
-    method: string;
-    authority: string;
-    path: string;
-};
-/**
- * Generates the base string.
- *
- * @param {any} headers The HTTP request headers.
- * @param {SignatureComponents} signatureComponents The config.
- * @param {any} payload The payload.
- * @param {number} timestamp The timestamp.
- * @returns {string} payload The base string.
- */
-export declare function generateBaseString(headers: Headers, signatureComponents: SignatureComponents, payload: any, timestamp?: number): string;
-/**
- * Generates the Signature-Input header value for the input payload.
- *
- * @param {any} payload The input config.
- * @param {number} timestamp The timestamp.
- * @returns {string} the 'Signature-Input' header value.
- */
-export declare const generateSignatureInput: (payload: any, timestamp?: number) => string;
-/**
- * Generates the 'Signature' header.
- *
- * @param {any} headers The HTTP headers.
- * @param {string} privateKey The HTTP headers.
- * @param {SignatureComponents} signatureComponents The signature components
- * @param {any} payload The payload
- * @param {number} timestamp The payload
- * @returns {string} the signature header value.
- */
-export declare function generateSignature(headers: any, privateKey: string, signatureComponents: SignatureComponents, payload: any, timestamp?: number): string;
+import { Cipher, Headers } from '../types/index.js';
+/**
+ * Generates the 'Content-Digest' header value for the input payload.
+ *
+ * @param {any} payload The request payload.
+ * @param {string} cipher The algorithm used to calculate the digest.
+ * @returns {string} contentDigest The 'Content-Digest' header value.
+ */
+export declare const generateContentDigestValue: (payload: unknown, cipher?: Cipher) => string;
+export type SignatureComponents = {
+    method: string;
+    authority: string;
+    path: string;
+};
+/**
+ * Generates the base string.
+ *
+ * @param {any} headers The HTTP request headers.
+ * @param {SignatureComponents} signatureComponents The config.
+ * @param {any} payload The payload.
+ * @param {number} timestamp The timestamp.
+ * @returns {string} payload The base string.
+ */
+export declare function generateBaseString(headers: Headers, signatureComponents: SignatureComponents, payload: any, timestamp?: number): string;
+/**
+ * Generates the Signature-Input header value for the input payload.
+ *
+ * @param {any} payload The input config.
+ * @param {number} timestamp The timestamp.
+ * @returns {string} the 'Signature-Input' header value.
+ */
+export declare const generateSignatureInput: (payload: any, timestamp?: number) => string;
+/**
+ * Generates the 'Signature' header.
+ *
+ * @param {any} headers The HTTP headers.
+ * @param {string} privateKey The HTTP headers.
+ * @param {SignatureComponents} signatureComponents The signature components
+ * @param {any} payload The payload
+ * @param {number} timestamp The payload
+ * @returns {string} the signature header value.
+ */
+export declare function generateSignature(headers: any, privateKey: string, signatureComponents: SignatureComponents, payload: any, timestamp?: number): string;