ebay-api 8.5.0 → 8.6.0

package/dist/api/restful/sell/metadata/index.d.ts

@@ -1,78 +1,13 @@
 import { operations } from '../../../../types/restful/specs/sell_metadata_v1_oas3.js';
 import Restful, { OpenApi } from '../../index.js';
-/**
- * The Metadata API has operations that retrieve configuration details pertaining to the different eBay marketplaces.
- */
 export default class Metadata extends Restful implements OpenApi<operations> {
     static id: string;
     get basePath(): string;
-    /**
-     * This method retrieves all the sales tax jurisdictions for the country that you specify in the countryCode path
-     * parameter.
-     *
-     * @param countryCode This path parameter specifies the two-letter ISO 3166-1 Alpha-2 country code for the country
-     *     whose jurisdictions you want to retrieve.
-     */
     getSalesTaxJurisdictions(countryCode: string): Promise<any>;
-    /**
-     * This method returns the eBay policies that define how to list automotive-parts-compatibility items in the
-     * categories of a specific marketplace.
-     *
-     * @param marketplaceId This path parameter specifies the eBay marketplace for which policy information is
-     *     retrieved.
-     * @param filter This query parameter limits the response by returning eBay policy information for only the leaf
-     *     categories specified by this parameter.
-     */
     getAutomotivePartsCompatibilityPolicies(marketplaceId: string, filter?: string): Promise<any>;
-    /**
-     * This method returns the eBay policies that define how to specify item conditions in the categories of a specific
-     * marketplace.
-     *
-     * @param marketplaceId This path parameter specifies the eBay marketplace for which policy information is
-     *     retrieved.
-     * @param filter This query parameter limits the response by returning eBay policy information for only the leaf
-     *     categories specified by this parameter.
-     */
     getItemConditionPolicies(marketplaceId: string, filter?: string): Promise<any>;
-    /**
-     * This method returns the eBay policies that define the allowed listing structures for the categories of a
-     * specific marketplace.
-     *
-     * @param marketplaceId This path parameter specifies the eBay marketplace for which policy information is
-     *     retrieved.
-     * @param filter This query parameter limits the response by returning eBay policy information for only the leaf
-     *     categories specified by this parameter.
-     */
     getListingStructurePolicies(marketplaceId: string, filter?: string): Promise<any>;
-    /**
-     * This method returns the eBay policies that define the supported negotiated price features (like &quot;best
-     * offer&quot;) for the categories of a specific marketplace.
-     *
-     * @param marketplaceId This path parameter specifies the eBay marketplace for which policy information is
-     *     retrieved.
-     * @param filter This query parameter limits the response by returning eBay policy information for only the leaf
-     *     categories specified by this parameter.
-     */
     getNegotiatedPricePolicies(marketplaceId: string, filter?: string): Promise<any>;
-    /**
-     * This method retrieves a list of leaf categories for a marketplace and identifies the categories that require
-     * items to have an eBay product ID value in order to be listed in those categories.
-     *
-     * @param marketplaceId This path parameter specifies the eBay marketplace for which policy information is
-     *     retrieved.
-     * @param filter This query parameter limits the response by returning eBay policy information for only the leaf
-     *     categories specified by this parameter.
-     */
     getProductAdoptionPolicies(marketplaceId: string, filter?: string): Promise<any>;
-    /**
-     * This method returns the eBay policies that define whether or not you must include a return policy for the
-     * items you list in the categories of a specific marketplace, plus the guidelines for creating domestic and
-     * international return policies in the different eBay categories.
-     *
-     * @param marketplaceId This path parameter specifies the eBay marketplace for which policy information is
-     *     retrieved.
-     * @param filter This query parameter limits the response by returning eBay policy information for only the leaf
-     *     categories specified by this parameter.
-     */
     getReturnPolicies(marketplaceId: string, filter?: string): Promise<any>;
 }

package/dist/api/restful/sell/metadata/index.js

@@ -1,31 +1,12 @@
 import Restful from '../../index.js';
-/**
- * The Metadata API has operations that retrieve configuration details pertaining to the different eBay marketplaces.
- */
 class Metadata extends Restful {
     get basePath() {
         return '/sell/metadata/v1';
     }
-    /**
-     * This method retrieves all the sales tax jurisdictions for the country that you specify in the countryCode path
-     * parameter.
-     *
-     * @param countryCode This path parameter specifies the two-letter ISO 3166-1 Alpha-2 country code for the country
-     *     whose jurisdictions you want to retrieve.
-     */
     getSalesTaxJurisdictions(countryCode) {
         countryCode = encodeURIComponent(countryCode);
         return this.get(`/country/${countryCode}/sales_tax_jurisdiction`);
     }
-    /**
-     * This method returns the eBay policies that define how to list automotive-parts-compatibility items in the
-     * categories of a specific marketplace.
-     *
-     * @param marketplaceId This path parameter specifies the eBay marketplace for which policy information is
-     *     retrieved.
-     * @param filter This query parameter limits the response by returning eBay policy information for only the leaf
-     *     categories specified by this parameter.
-     */
     getAutomotivePartsCompatibilityPolicies(marketplaceId, filter) {
         marketplaceId = encodeURIComponent(marketplaceId);
         return this.get(`/marketplace/${marketplaceId}/get_automotive_parts_compatibility_policies`, {
@@ -34,15 +15,6 @@ class Metadata extends Restful {
             }
         });
     }
-    /**
-     * This method returns the eBay policies that define how to specify item conditions in the categories of a specific
-     * marketplace.
-     *
-     * @param marketplaceId This path parameter specifies the eBay marketplace for which policy information is
-     *     retrieved.
-     * @param filter This query parameter limits the response by returning eBay policy information for only the leaf
-     *     categories specified by this parameter.
-     */
     getItemConditionPolicies(marketplaceId, filter) {
         marketplaceId = encodeURIComponent(marketplaceId);
         return this.get(`/marketplace/${marketplaceId}/get_item_condition_policies`, {
@@ -51,15 +23,6 @@ class Metadata extends Restful {
             }
         });
     }
-    /**
-     * This method returns the eBay policies that define the allowed listing structures for the categories of a
-     * specific marketplace.
-     *
-     * @param marketplaceId This path parameter specifies the eBay marketplace for which policy information is
-     *     retrieved.
-     * @param filter This query parameter limits the response by returning eBay policy information for only the leaf
-     *     categories specified by this parameter.
-     */
     getListingStructurePolicies(marketplaceId, filter) {
         marketplaceId = encodeURIComponent(marketplaceId);
         return this.get(`/marketplace/${marketplaceId}/get_listing_structure_policies`, {
@@ -68,15 +31,6 @@ class Metadata extends Restful {
             }
         });
     }
-    /**
-     * This method returns the eBay policies that define the supported negotiated price features (like "best
-     * offer") for the categories of a specific marketplace.
-     *
-     * @param marketplaceId This path parameter specifies the eBay marketplace for which policy information is
-     *     retrieved.
-     * @param filter This query parameter limits the response by returning eBay policy information for only the leaf
-     *     categories specified by this parameter.
-     */
     getNegotiatedPricePolicies(marketplaceId, filter) {
         marketplaceId = encodeURIComponent(marketplaceId);
         return this.get(`/marketplace/${marketplaceId}/get_negotiated_price_policies`, {
@@ -85,15 +39,6 @@ class Metadata extends Restful {
             }
         });
     }
-    /**
-     * This method retrieves a list of leaf categories for a marketplace and identifies the categories that require
-     * items to have an eBay product ID value in order to be listed in those categories.
-     *
-     * @param marketplaceId This path parameter specifies the eBay marketplace for which policy information is
-     *     retrieved.
-     * @param filter This query parameter limits the response by returning eBay policy information for only the leaf
-     *     categories specified by this parameter.
-     */
     getProductAdoptionPolicies(marketplaceId, filter) {
         marketplaceId = encodeURIComponent(marketplaceId);
         return this.get(`/marketplace/${marketplaceId}/get_product_adoption_policies`, {
@@ -102,16 +47,6 @@ class Metadata extends Restful {
             }
         });
     }
-    /**
-     * This method returns the eBay policies that define whether or not you must include a return policy for the
-     * items you list in the categories of a specific marketplace, plus the guidelines for creating domestic and
-     * international return policies in the different eBay categories.
-     *
-     * @param marketplaceId This path parameter specifies the eBay marketplace for which policy information is
-     *     retrieved.
-     * @param filter This query parameter limits the response by returning eBay policy information for only the leaf
-     *     categories specified by this parameter.
-     */
     getReturnPolicies(marketplaceId, filter) {
         marketplaceId = encodeURIComponent(marketplaceId);
         return this.get(`/marketplace/${marketplaceId}/get_return_policies`, {

package/dist/api/restful/sell/negotiation/index.d.ts

@@ -1,25 +1,11 @@
 import { operations } from '../../../../types/restful/specs/sell_negotiation_v1_oas3.js';
 import Restful, { OpenApi } from '../../index.js';
-/**
- * The <b>Negotiations API</b> gives sellers the ability to proactively send discount offers to buyers who have shown an "interest" in their listings.
- */
 export default class Negotiation extends Restful implements OpenApi<operations> {
     static id: string;
     get basePath(): string;
-    /**
-     * This method evaluates a seller's current listings and returns the set of IDs that are eligible for a seller-initiated discount offer to a buyer.
-     *
-     * @param limit This query parameter specifies the maximum number of items to return from the result set on a page in the paginated response.
-     * @param offset This query parameter specifies the number of results to skip in the result set before returning the first result in the paginated response.
-     */
     findEligibleItems({ limit, offset }?: {
         limit?: string;
         offset?: string;
     }): Promise<any>;
-    /**
-     * This method sends eligible buyers offers to purchase items in a listing at a discount.
-     *
-     * @param data The CreateOffersRequest
-     */
     sendOfferToInterestedBuyers(data: any): Promise<any>;
 }

package/dist/api/restful/sell/negotiation/index.js

@@ -1,17 +1,8 @@
 import Restful from '../../index.js';
-/**
- * The <b>Negotiations API</b> gives sellers the ability to proactively send discount offers to buyers who have shown an "interest" in their listings.
- */
 class Negotiation extends Restful {
     get basePath() {
         return '/sell/negotiation/v1';
     }
-    /**
-     * This method evaluates a seller's current listings and returns the set of IDs that are eligible for a seller-initiated discount offer to a buyer.
-     *
-     * @param limit This query parameter specifies the maximum number of items to return from the result set on a page in the paginated response.
-     * @param offset This query parameter specifies the number of results to skip in the result set before returning the first result in the paginated response.
-     */
     findEligibleItems({ limit, offset } = {}) {
         return this.get(`/find_eligible_items`, {
             params: {
@@ -20,11 +11,6 @@ class Negotiation extends Restful {
             }
         });
     }
-    /**
-     * This method sends eligible buyers offers to purchase items in a listing at a discount.
-     *
-     * @param data The CreateOffersRequest
-     */
     sendOfferToInterestedBuyers(data) {
         return this.post(`/send_offer_to_interested_buyers`, data);
     }

package/dist/api/restful/sell/recommendation/index.d.ts

@@ -1,24 +1,9 @@
 import { FindListingRecommendationRequest } from '../../../../types/index.js';
 import { operations } from '../../../../types/restful/specs/sell_recommendation_v1_oas3.js';
 import Restful, { OpenApi } from '../../index.js';
-/**
- * The <b>Recommendation API</b> returns information that sellers can use to optimize the configuration of their
- * listings on eBay.
- */
 export default class Recommendation extends Restful implements OpenApi<operations> {
     static id: string;
     get basePath(): string;
-    /**
-     * The find method returns recommendations and information that sellers can use to optimize their listing
-     * configurations.
-     *
-     * @param filter Provide a list of key-value pairs to specify the criteria you want to use to filter the response.
-     * @param limit Use this query parameter to set the maximum number of ads to return on a page from the paginated
-     *     response. Default: 10 Maximum: 500
-     * @param offset Specifies the number of ads to skip in the result set before returning the first ad in the
-     *     paginated response.
-     * @param body FindListingRecommendationRequest
-     */
     findListingRecommendations({ filter, limit, offset }?: {
         filter?: string;
         limit?: number;

package/dist/api/restful/sell/recommendation/index.js

@@ -1,23 +1,8 @@
 import Restful from '../../index.js';
-/**
- * The <b>Recommendation API</b> returns information that sellers can use to optimize the configuration of their
- * listings on eBay.
- */
 class Recommendation extends Restful {
     get basePath() {
         return '/sell/recommendation/v1';
     }
-    /**
-     * The find method returns recommendations and information that sellers can use to optimize their listing
-     * configurations.
-     *
-     * @param filter Provide a list of key-value pairs to specify the criteria you want to use to filter the response.
-     * @param limit Use this query parameter to set the maximum number of ads to return on a page from the paginated
-     *     response. Default: 10 Maximum: 500
-     * @param offset Specifies the number of ads to skip in the result set before returning the first ad in the
-     *     paginated response.
-     * @param body FindListingRecommendationRequest
-     */
     findListingRecommendations({ filter, limit, offset } = {}, body) {
         return this.post(`/find`, {
             data: body,

package/dist/api/traditional/XMLRequest.d.ts

@@ -47,63 +47,19 @@ export declare const defaultApiConfig: Required<Omit<TraditionalApiConfig, 'hook
 export declare const defaultHeaders: {
     'Content-Type': string;
 };
-/**
- * XML request for making eBay API call.
- */
 export default class XMLRequest {
     private readonly callName;
     private readonly fields;
     private readonly config;
     private readonly req;
     static j2x: XMLBuilder;
-    /**
-     * Creates the new Request object
-     *
-     * @private
-     * @param      {string}  callName the callname
-     * @param      {Object}  fields the fields
-     * @param      {Object} req the request
-     * @param      {XMLReqConfig}  config
-     */
     constructor(callName: string, fields: Fields | null, config: XMLReqConfig, req: IEBayApiRequest);
-    /**
-     * returns the expected name of XML node of a Request
-     *
-     * @private
-     * @return     {String}  callnameReponse
-     */
     private getResponseWrapper;
-    /**
-     * returns the XML structure for the SOAP auth
-     *
-     * @private
-     * @return     {Object}  the RequesterCredentials
-     */
     private getCredentials;
     private getParseOptions;
     private getHeaders;
-    /**
-     * Converts an XML response to JSON
-     *
-     * @param      {string}     xml     the xml
-     * @return     {JSON}         resolves to a JSON representation of the HTML
-     */
     toJSON(xml: string): any;
-    /**
-     * returns the XML document for the request
-     *
-     * @private
-     * @param      {Fields}  fields  the fields
-     * @return     {String}           The XML string of the Request
-     */
     toXML(fields: Fields): string;
-    /**
-     * Call the xml api endpoint.
-     *
-     * @private
-     * @return     {Promise}           resolves to the response
-     *
-     */
     request(): Promise<any>;
     xml2JSON(xml: string): any;
 }

package/dist/api/traditional/XMLRequest.js

@@ -39,19 +39,7 @@ export const defaultApiConfig = {
 export const defaultHeaders = {
     'Content-Type': 'text/xml'
 };
-/**
- * XML request for making eBay API call.
- */
 class XMLRequest {
-    /**
-     * Creates the new Request object
-     *
-     * @private
-     * @param      {string}  callName the callname
-     * @param      {Object}  fields the fields
-     * @param      {Object} req the request
-     * @param      {XMLReqConfig}  config
-     */
     constructor(callName, fields, config, req) {
         if (!callName) {
             throw new EbayNoCallError();
@@ -61,21 +49,9 @@ class XMLRequest {
         this.config = { ...defaultApiConfig, ...config };
         this.req = req;
     }
-    /**
-     * returns the expected name of XML node of a Request
-     *
-     * @private
-     * @return     {String}  callnameReponse
-     */
     getResponseWrapper() {
         return `${this.callName}Response`;
     }
-    /**
-     * returns the XML structure for the SOAP auth
-     *
-     * @private
-     * @return     {Object}  the RequesterCredentials
-     */
     getCredentials() {
         return this.config.eBayAuthToken ? {
             RequesterCredentials: {
@@ -95,24 +71,11 @@ class XMLRequest {
             ...this.config.headers,
         };
     }
-    /**
-     * Converts an XML response to JSON
-     *
-     * @param      {string}     xml     the xml
-     * @return     {JSON}         resolves to a JSON representation of the HTML
-     */
     toJSON(xml) {
         const parseOptions = this.getParseOptions();
         log('parseOption', parseOptions);
         return new XMLParser(parseOptions).parse(xml);
     }
-    /**
-     * returns the XML document for the request
-     *
-     * @private
-     * @param      {Fields}  fields  the fields
-     * @return     {String}           The XML string of the Request
-     */
     toXML(fields) {
         const HEADING = '<?xml version="1.0" encoding="utf-8"?>';
         return HEADING + XMLRequest.j2x.build({
@@ -123,13 +86,6 @@ class XMLRequest {
             }
         });
     }
-    /**
-     * Call the xml api endpoint.
-     *
-     * @private
-     * @return     {Promise}           resolves to the response
-     *
-     */
     async request() {
         const xml = this.toXML(this.fields);
         log('xml', xml);
@@ -149,7 +105,6 @@ class XMLRequest {
                 return response;
             }
             const { data } = response;
-            // return raw XML
             if (this.config.raw) {
                 return data;
             }
@@ -168,7 +123,6 @@ class XMLRequest {
     }
     xml2JSON(xml) {
         const json = this.toJSON(xml);
-        // Unwrap
         return json[this.getResponseWrapper()] ?? json;
     }
 }

package/dist/api/traditional/clientAlerts/index.js

@@ -1,5 +1,4 @@
 import { EventType } from './types.js';
-// https://developer.ebay.com/devzone/client-alerts/docs/CallRef/index.html
 var calls;
 (function (calls) {
     calls[calls["GetPublicAlerts"] = 0] = "GetPublicAlerts";

package/dist/api/traditional/index.d.ts

@@ -1,8 +1,5 @@
 import { ClientAlerts, Finding, Merchandising, Shopping, Trading } from '../../types/index.js';
 import Api from '../index.js';
-/**
- * Traditional eBay API.
- */
 export default class Traditional extends Api {
     createTradingApi(): Trading;
     createShoppingApi(): Shopping;

package/dist/api/traditional/index.js

@@ -7,9 +7,6 @@ import MerchandisingCalls from './merchandising/index.js';
 import ShoppingCalls from './shopping/index.js';
 import TradingCalls from './trading/index.js';
 import XMLRequest, { defaultApiConfig } from './XMLRequest.js';
-/**
- * Traditional eBay API.
- */
 export default class Traditional extends Api {
     constructor() {
         super(...arguments);
@@ -19,7 +16,6 @@ export default class Traditional extends Api {
                 return await this.request(apiConfig, api, callName, fields);
             }
             catch (error) {
-                // Try to refresh the token.
                 if (this.config.autoRefreshToken && (error.name === EBayIAFTokenExpired.name || error.name === EBayIAFTokenInvalid.name)) {
                     return await this.request(apiConfig, api, callName, fields, true);
                 }
@@ -64,7 +60,6 @@ export default class Traditional extends Api {
             calls: ShoppingCalls,
             headers: (callName, accessToken) => ({
                 'X-EBAY-API-CALL-NAME': callName,
-                // 'X-EBAY-API-APP-ID': this.config.appId, deprecated  on June 30, 2021
                 'X-EBAY-API-SITE-ID': this.config.siteId,
                 'X-EBAY-API-VERSION': 863,
                 'X-EBAY-API-REQUEST-ENCODING': 'xml',

package/dist/api/traditional/shopping/index.js

@@ -1,4 +1,3 @@
-// https://developer.ebay.com/devzone/shopping/docs/callref/index.html
 var calls;
 (function (calls) {
     calls[calls["FindProducts"] = 0] = "FindProducts";

package/dist/auth/authNAuth.d.ts

@@ -19,11 +19,6 @@ export default class AuthNAuth extends Base {
     private authToken;
     constructor(config: AppConfig, req?: IEBayApiRequest);
     get apiEndpoint(): string;
-    /**
-     * Generates URL for consent page landing.
-     *
-     * @param ruName RuName
-     */
     getSessionIdAndAuthUrl(ruName?: string): Promise<{
         sessionId: any;
         url: string;

package/dist/auth/authNAuth.js

@@ -22,11 +22,6 @@ class AuthNAuth extends Base {
     get apiEndpoint() {
         return this.config.sandbox ? AuthNAuth.API_ENDPOINT.sandbox : AuthNAuth.API_ENDPOINT.production;
     }
-    /**
-     * Generates URL for consent page landing.
-     *
-     * @param ruName RuName
-     */
     async getSessionIdAndAuthUrl(ruName) {
         if (!this.config.devId) {
             throw new Error('DevId is required.');

package/dist/auth/index.d.ts

@@ -3,9 +3,6 @@ import { IEBayApiRequest } from '../request.js';
 import { AppConfig } from '../types/index.js';
 import AuthNAuth from './authNAuth.js';
 import OAuth2 from './oAuth2.js';
-/**
- * Container with Auth'N'Auth and OAuth2.
- */
 export default class Auth extends Base {
     readonly authNAuth: AuthNAuth;
     readonly oAuth2: OAuth2;

package/dist/auth/index.js

@@ -1,9 +1,6 @@
 import Base from '../api/base.js';
 import AuthNAuth from './authNAuth.js';
 import OAuth2 from './oAuth2.js';
-/**
- * Container with Auth'N'Auth and OAuth2.
- */
 export default class Auth extends Base {
     constructor(config, req) {
         super(config, req);

package/dist/auth/oAuth2.d.ts

@@ -12,12 +12,6 @@ export type AuthToken = Token & {
     refresh_token: string;
     refresh_token_expires_in: number;
 };
-/**
- * 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.
- */
 export default class OAuth2 extends Base {
     static readonly IDENTITY_ENDPOINT: Record<string, string>;
     static readonly AUTHORIZE_ENDPOINT: Record<string, string>;
@@ -30,66 +24,20 @@ export default class OAuth2 extends Base {
     on(event: string, callback: EventCallback): () => void;
     static generateAuthUrl(sandbox: boolean, appId: string, ruName: string, scope: string[], state?: string): string;
     get identityEndpoint(): string;
-    /**
-     * Return the access token.
-     * First return user access token, if not set Application Access Token.
-     */
     getAccessToken(): Promise<string>;
     getUserAccessToken(): string | null;
     getApplicationAccessToken(): Promise<string>;
     setClientToken(clientToken?: Token): void;
     setScope(scope: Scope): void;
     getScope(): string[];
-    /**
-     * Client credentials grant flow.
-     */
     mintApplicationAccessToken(): Promise<ClientToken>;
-    /**
-     * Client credentials grant flow.
-     */
     obtainApplicationAccessToken(): Promise<ClientToken>;
-    /**
-     * Generates URL for consent page landing.
-     *
-     * @param ruName RuName
-     * @param scope the scopes
-     * @param state state parameter returned in the redirect URL
-     */
     generateAuthUrl(ruName?: string, scope?: string[], state?: string): string;
-    /**
-     * Authorization code grant flow.
-     *
-     * Mint the user access token for the given code.
-     *
-     * @param code the code
-     * @param ruName the redirectUri
-     */
     mintUserAccessToken(code: string, ruName?: string | undefined): Promise<any>;
-    /**
-     * Authorization code grant flow.
-     *
-     * Mint the access token for the given code.
-     *
-     * @param code the code
-     * @param ruName the redirectUri
-     */
     getToken(code: string, ruName?: string | undefined): Promise<any>;
-    /**
-     * Authorization code grant flow.
-     */
     refreshUserAccessToken(): Promise<AuthToken>;
-    /**
-     * Gets and sets the user access token for the given code.
-     *
-     * Authorization code grant flow.
-     *
-     * @param code the code
-     */
     obtainToken(code: string): Promise<AuthToken>;
     getCredentials(): AuthToken | ClientToken | null;
     setCredentials(authToken: AuthToken | string): void;
-    /**
-     * Refresh the user access token if set or application access token
-     */
     refreshToken(): Promise<Token>;
 }