ebay-api 8.5.1 → 8.6.1

package/lib/auth/oAuth2.js

@@ -7,12 +7,6 @@ const debug_1 = __importDefault(require("debug"));
 const nanoevents_js_1 = require("../nanoevents.js");
 const base_js_1 = __importDefault(require("../api/base.js"));
 const log = (0, debug_1.default)('ebay:oauth2');
-/**
- * https://developer.ebay.com/api-docs/static/oauth-tokens.html
- *
- * Client credentials grant flow mints a new Application access token that you can use to access the resources owned by the application.
- * Authorization code grant flow mints a new User access token that you can use to access the resources owned by the user.
- */
 class OAuth2 extends base_js_1.default {
     constructor(config, req) {
         super(config, req);
@@ -35,10 +29,6 @@ class OAuth2 extends base_js_1.default {
     get identityEndpoint() {
         return this.config.sandbox ? OAuth2.IDENTITY_ENDPOINT.sandbox : OAuth2.IDENTITY_ENDPOINT.production;
     }
-    /**
-     * Return the access token.
-     * First return user access token, if not set Application Access Token.
-     */
     async getAccessToken() {
         return this.getUserAccessToken() || this.getApplicationAccessToken();
     }
@@ -67,9 +57,6 @@ class OAuth2 extends base_js_1.default {
     getScope() {
         return [...this.scope];
     }
-    /**
-     * Client credentials grant flow.
-     */
     async mintApplicationAccessToken() {
         if (!this.config.appId) {
             throw new Error('Missing App ID (Client Id)');
@@ -94,9 +81,6 @@ class OAuth2 extends base_js_1.default {
             throw error;
         }
     }
-    /**
-     * Client credentials grant flow.
-     */
     async obtainApplicationAccessToken() {
         log('Obtain a new application access token with scope: ', this.scope.join(','));
         try {
@@ -111,13 +95,6 @@ class OAuth2 extends base_js_1.default {
             throw error;
         }
     }
-    /**
-     * Generates URL for consent page landing.
-     *
-     * @param ruName RuName
-     * @param scope the scopes
-     * @param state state parameter returned in the redirect URL
-     */
     generateAuthUrl(ruName, scope = this.scope, state = '') {
         ruName = ruName || this.config.ruName;
         if (!ruName) {
@@ -125,14 +102,6 @@ class OAuth2 extends base_js_1.default {
         }
         return OAuth2.generateAuthUrl(this.config.sandbox, this.config.appId, ruName, scope, state);
     }
-    /**
-     * Authorization code grant flow.
-     *
-     * Mint the user access token for the given code.
-     *
-     * @param code the code
-     * @param ruName the redirectUri
-     */
     async mintUserAccessToken(code, ruName = this.config.ruName) {
         try {
             const response = await this.req.postForm(this.identityEndpoint, {
@@ -154,20 +123,9 @@ class OAuth2 extends base_js_1.default {
             throw error;
         }
     }
-    /**
-     * Authorization code grant flow.
-     *
-     * Mint the access token for the given code.
-     *
-     * @param code the code
-     * @param ruName the redirectUri
-     */
     async getToken(code, ruName = this.config.ruName) {
         return await this.mintUserAccessToken(code, ruName);
     }
-    /**
-     * Authorization code grant flow.
-     */
     async refreshUserAccessToken() {
         if (!this._authToken || !this._authToken.refresh_token) {
             log('Tried to refresh user access token before it was set.');
@@ -199,13 +157,6 @@ class OAuth2 extends base_js_1.default {
             throw error;
         }
     }
-    /**
-     * Gets and sets the user access token for the given code.
-     *
-     * Authorization code grant flow.
-     *
-     * @param code the code
-     */
     async obtainToken(code) {
         const token = await this.getToken(code);
         log('Obtain user access token', token);
@@ -239,9 +190,6 @@ class OAuth2 extends base_js_1.default {
             this._authToken = authToken;
         }
     }
-    /**
-     * Refresh the user access token if set or application access token
-     */
     async refreshToken() {
         if (this._authToken) {
             return await this.refreshUserAccessToken();
@@ -252,7 +200,6 @@ class OAuth2 extends base_js_1.default {
         throw new Error('Missing credentials. To refresh a token an application access token or user access token must be already set.');
     }
 }
-// If all the calls in our application require just an Application access token we can use this endpoint
 OAuth2.IDENTITY_ENDPOINT = {
     production: 'https://api.ebay.com/identity/v1/oauth2/token',
     sandbox: 'https://api.sandbox.ebay.com/identity/v1/oauth2/token'

package/lib/eBayApi.d.ts

@@ -17,13 +17,6 @@ export default class eBayApi extends Api {
     static readonly MarketplaceId: typeof enums.MarketplaceId;
     static readonly ContentLanguage: typeof enums.Locale;
     static readonly Locale: typeof enums.Locale;
-    /**
-     * Loads config from `process.env`
-     *
-     * @return {eBayApi} a new eBayApi instance
-     * @param {request} req request
-     * @throws {ApiEnvError}
-     */
     static fromEnv(req?: IEBayApiRequest): eBayApi;
     readonly authNAuth: AuthNAuth;
     readonly oAuth2: OAuth2;
@@ -39,10 +32,6 @@ export default class eBayApi extends Api {
     private _shopping?;
     private _merchandising?;
     private _clientAlerts?;
-    /**
-     * @param {AppConfig} config the app config
-     * @param {IEBayApiRequest} req the request
-     */
     constructor(config: AppConfig, req?: IEBayApiRequest);
     get buy(): Buy;
     get commerce(): Commerce;

package/lib/eBayApi.js

@@ -49,15 +49,7 @@ const defaultConfig = {
     acceptLanguage: index_js_2.Locale.en_US,
     contentLanguage: index_js_2.ContentLanguage.en_US
 };
-// tslint:disable-next-line:class-name
 class eBayApi extends index_js_1.default {
-    /**
-     * Loads config from `process.env`
-     *
-     * @return {eBayApi} a new eBayApi instance
-     * @param {request} req request
-     * @throws {ApiEnvError}
-     */
     static fromEnv(req) {
         if (!process.env.EBAY_APP_ID) {
             throw new index_js_3.ApiEnvError('EBAY_APP_ID');
@@ -86,14 +78,9 @@ class eBayApi extends index_js_1.default {
             signature
         }, req);
     }
-    /**
-     * @param {AppConfig} config the app config
-     * @param {IEBayApiRequest} req the request
-     */
     constructor(config, req) {
         super({ ...defaultConfig, ...config }, req);
         this.factory = new apiFactory_js_1.default(this.config, this.req, this.auth);
-        // Shortcuts
         this.authNAuth = this.auth.authNAuth;
         this.OAuth2 = this.auth.OAuth2;
         this.oAuth2 = this.OAuth2;
@@ -113,7 +100,6 @@ class eBayApi extends index_js_1.default {
     get sell() {
         return this._sell || (this._sell = this.factory.createSellApi());
     }
-    // Traditional
     get trading() {
         return this._trading || (this._trading = this.factory.createTradingApi());
     }