ebay-api 8.5.1 → 8.6.1

package/lib/api/restful/commerce/taxonomy/index.js

@@ -4,20 +4,10 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 const index_js_1 = __importDefault(require("../../index.js"));
-/**
- * Use the Taxonomy API to discover the most appropriate eBay categories under which sellers can offer inventory items
- * for sale, and the most likely categories under which buyers can browse or search for items to purchase.
- */
 class Taxonomy extends index_js_1.default {
     get basePath() {
         return '/commerce/taxonomy/v1';
     }
-    /**
-     * A given eBay marketplace might use multiple category trees, but one of those trees is considered to be the
-     * default for that marketplace.
-     *
-     * @param marketplaceId The ID of the eBay marketplace for which the category tree ID is being requested.
-     */
     getDefaultCategoryTreeId(marketplaceId) {
         return this.get(`/get_default_category_tree_id`, {
             params: {
@@ -25,23 +15,10 @@ class Taxonomy extends index_js_1.default {
             }
         });
     }
-    /**
-     * This call retrieves the complete category tree that is identified by the category_tree_id parameter.
-     *
-     * @param categoryTreeId
-     */
     getCategoryTree(categoryTreeId) {
         const cId = encodeURIComponent(categoryTreeId);
         return this.get(`/category_tree/${cId}`);
     }
-    /**
-     * This call retrieves the details of all nodes of the category tree hierarchy (the subtree) below a specified
-     * category of a category tree.
-     *
-     * @param categoryTreeId The unique identifier of the eBay category tree from which a category subtree is being
-     *     requested.
-     * @param categoryId The unique identifier of the category at the top of the subtree being requested.
-     */
     getCategorySubtree(categoryTreeId, categoryId) {
         categoryTreeId = encodeURIComponent(categoryTreeId);
         return this.get(`/category_tree/${categoryTreeId}/get_category_subtree`, {
@@ -50,14 +27,6 @@ class Taxonomy extends index_js_1.default {
             }
         });
     }
-    /**
-     * This call returns an array of category tree leaf nodes in the specified category tree that are considered by eBay
-     *  to most closely correspond to the query string q.
-     *
-     * @param categoryTreeId The unique identifier of the eBay category tree for which suggested nodes are being
-     *     requested.
-     * @param q A quoted string that describes or characterizes the item being offered for sale.
-     */
     getCategorySuggestions(categoryTreeId, q) {
         return this.get(`/category_tree/${categoryTreeId}/get_category_suggestions`, {
             params: {
@@ -65,14 +34,6 @@ class Taxonomy extends index_js_1.default {
             }
         });
     }
-    /**
-     * This call returns a list of aspects that are appropriate or necessary for accurately describing items in the
-     * specified leaf category.
-     *
-     * @param categoryTreeId The unique identifier of the eBay category tree from which the specified category's
-     *     aspects are being requested.
-     * @param categoryId The unique identifier of the leaf category for which aspects are being requested.
-     */
     getItemAspectsForCategory(categoryTreeId, categoryId) {
         categoryTreeId = encodeURIComponent(categoryTreeId);
         return this.get(`/category_tree/${categoryTreeId}/get_item_aspects_for_category`, {
@@ -81,15 +42,6 @@ class Taxonomy extends index_js_1.default {
             }
         });
     }
-    /**
-     * This call retrieves the compatible vehicle aspects that are used to define a motor vehicle that is compatible
-     * with a motor vehicle part or accessory.
-     *
-     * @param categoryTreeId This is the unique identifier of category tree. The following is the list of
-     * category_tree_id values and the eBay marketplaces that they represent.
-     *
-     * @param categoryId The unique identifier of an eBay category.
-     */
     getCompatibilityProperties(categoryTreeId, categoryId) {
         categoryTreeId = encodeURIComponent(categoryTreeId);
         return this.get(`/category_tree/${categoryTreeId}/get_compatibility_properties`, {
@@ -98,15 +50,6 @@ class Taxonomy extends index_js_1.default {
             }
         });
     }
-    /**
-     * This call retrieves applicable compatible vehicle property values based on the specified eBay marketplace,
-     * specified eBay category, and filters used in the request.
-     *
-     * @param categoryTreeId This is the unique identifier of the category tree.
-     * @param categoryId The unique identifier of an eBay category.
-     * @param compatibilityProperty One compatible vehicle property applicable to the specified eBay marketplace and
-     *     eBay category is specified in this required filter.
-     */
     getCompatibilityPropertyValues(categoryTreeId, categoryId, compatibilityProperty) {
         categoryTreeId = encodeURIComponent(categoryTreeId);
         return this.get(`/category_tree/${categoryTreeId}/get_compatibility_property_values`, {
@@ -116,13 +59,6 @@ class Taxonomy extends index_js_1.default {
             }
         });
     }
-    /**
-     * This call returns a complete list of aspects for all of the leaf categories that belong to an eBay marketplace.
-     *
-     * @param categoryTreeId
-     *
-     * @return A JSON GZIP compressed file buffer
-     */
     fetchItemAspects(categoryTreeId) {
         categoryTreeId = encodeURIComponent(categoryTreeId);
         return this.get(`/category_tree/${categoryTreeId}/fetch_item_aspects`, {

package/lib/api/restful/commerce/translation/index.d.ts

@@ -1,16 +1,8 @@
 import { TranslateRequest } from '../../../../types/index.js';
 import { operations } from '../../../../types/restful/specs/commerce_translation_v1_beta_oas3.js';
 import Restful, { OpenApi } from '../../index.js';
-/**
- * This API allows 3rd party developers to translate item title, description, search query.
- */
 export default class Translation extends Restful implements OpenApi<operations> {
     static id: string;
     get basePath(): string;
-    /**
-     * Translates input text inot a given language.
-     *
-     * @param body TranslateRequest
-     */
     translate(body: TranslateRequest): Promise<any>;
 }

package/lib/api/restful/commerce/translation/index.js

@@ -4,18 +4,10 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 const index_js_1 = __importDefault(require("../../index.js"));
-/**
- * This API allows 3rd party developers to translate item title, description, search query.
- */
 class Translation extends index_js_1.default {
     get basePath() {
         return '/commerce/translation/v1_beta';
     }
-    /**
-     * Translates input text inot a given language.
-     *
-     * @param body TranslateRequest
-     */
     translate(body) {
         return this.post(`/translate`, body);
     }

package/lib/api/restful/developer/analytics/index.d.ts

@@ -1,23 +1,8 @@
 import { operations } from '../../../../types/restful/specs/developer_analytics_v1_beta_oas3.js';
 import Restful, { OpenApi } from '../../index.js';
-/**
- * This method retrieves the call limit and utilization data for an application.
- */
 export default class Analytics extends Restful implements OpenApi<operations> {
     static id: string;
     get basePath(): string;
-    /**
-     * This method retrieves the call limit and utilization data for an application.
-     *
-     * @param apiContext This optional query parameter filters the result to include only the specified API context.
-     * @param apiName This optional query parameter filters the result to include only the APIs specified.
-     */
     getRateLimits(apiContext: string, apiName: string): Promise<any>;
-    /**
-     * This method retrieves the call limit and utilization data for an application user.
-     *
-     * @param apiContext This optional query parameter filters the result to include only the specified API context.
-     * @param apiName This optional query parameter filters the result to include only the APIs specified.
-     */
     getUserRateLimits(apiContext: string, apiName: string): Promise<any>;
 }

package/lib/api/restful/developer/analytics/index.js

@@ -4,19 +4,10 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 const index_js_1 = __importDefault(require("../../index.js"));
-/**
- * This method retrieves the call limit and utilization data for an application.
- */
 class Analytics extends index_js_1.default {
     get basePath() {
         return '/developer/analytics/v1_beta';
     }
-    /**
-     * This method retrieves the call limit and utilization data for an application.
-     *
-     * @param apiContext This optional query parameter filters the result to include only the specified API context.
-     * @param apiName This optional query parameter filters the result to include only the APIs specified.
-     */
     getRateLimits(apiContext, apiName) {
         return this.get(`/rate_limit/`, {
             params: {
@@ -25,12 +16,6 @@ class Analytics extends index_js_1.default {
             }
         });
     }
-    /**
-     * This method retrieves the call limit and utilization data for an application user.
-     *
-     * @param apiContext This optional query parameter filters the result to include only the specified API context.
-     * @param apiName This optional query parameter filters the result to include only the APIs specified.
-     */
     getUserRateLimits(apiContext, apiName) {
         return this.get(`/user_rate_limit/`, {
             params: {

package/lib/api/restful/developer/keyManagement/index.d.ts

@@ -1,25 +1,10 @@
 import { operations } from '../../../../types/restful/specs/developer_key_management_v1_oas3.js';
 import Restful, { OpenApi } from '../../index.js';
-/**
- * This method retrieves the call limit and utilization data for an application.
- */
 export default class KeyManagement extends Restful implements OpenApi<operations> {
     static id: string;
     get subdomain(): string;
     get basePath(): string;
-    /**
-     * This method returns the <b>Public Key</b>, <b>Public Key as JWE</b>,
-     * and metadata for all keypairs associated with the application key making the call.
-     */
     getSigningKeys(): Promise<any>;
-    /**
-     * This method creates keypairs.
-     */
     createSigningKey(signingKeyCipher: 'ED25519' | 'RSA'): Promise<any>;
-    /**
-     * This method returns the <b>Public Key</b>, <b>Public Key as JWE</b>,
-     * and metadata for a specified <code>signingKeyId</code> associated with the application key making the call.
-     * @param signingKeyId the signin key
-     */
     getSigningKey(signingKeyId: string): Promise<any>;
 }

package/lib/api/restful/developer/keyManagement/index.js

@@ -4,9 +4,6 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 const index_js_1 = __importDefault(require("../../index.js"));
-/**
- * This method retrieves the call limit and utilization data for an application.
- */
 class KeyManagement extends index_js_1.default {
     get subdomain() {
         return 'apiz';
@@ -14,26 +11,14 @@ class KeyManagement extends index_js_1.default {
     get basePath() {
         return '/developer/key_management/v1';
     }
-    /**
-     * This method returns the <b>Public Key</b>, <b>Public Key as JWE</b>,
-     * and metadata for all keypairs associated with the application key making the call.
-     */
     getSigningKeys() {
         return this.get(`/signing_key`);
     }
-    /**
-     * This method creates keypairs.
-     */
     createSigningKey(signingKeyCipher) {
         return this.post(`/signing_key`, {
             signingKeyCipher
         });
     }
-    /**
-     * This method returns the <b>Public Key</b>, <b>Public Key as JWE</b>,
-     * and metadata for a specified <code>signingKeyId</code> associated with the application key making the call.
-     * @param signingKeyId the signin key
-     */
     getSigningKey(signingKeyId) {
         return this.get(`/signing_key/${signingKeyId}`);
     }

package/lib/api/restful/index.d.ts

@@ -31,9 +31,6 @@ export default abstract class Restful extends Api {
     constructor(config: AppConfig, req?: IEBayApiRequest, auth?: Auth, apiConfig?: RestfulApiConfig);
     static buildServerUrl(schema: string, subdomain: string, sandbox: boolean, tld: string): string;
     abstract get basePath(): string;
-    /**
-     * Enable to supports the use of OAuth tokens for user authorization.
-     */
     get useIaf(): boolean;
     get schema(): string;
     get subdomain(): string;
@@ -41,22 +38,9 @@ export default abstract class Restful extends Api {
     getServerUrl({ schema, subdomain, apiVersion, basePath, sandbox, tld }: Required<RestfulApiConfig>): string;
     getApiConfig(): Required<RestfulApiConfig>;
     get baseUrl(): string;
-    /**
-     * Create a new instances of it self with specified api config.
-     * @param apiConfig
-     */
     api(apiConfig: RestfulApiConfig): this;
-    /**
-     * Use "apix" subdomain
-     */
     get apix(): this;
-    /**
-     * Use "apiz" subdomain
-     */
     get apiz(): this;
-    /**
-     * Sign request
-     */
     get sign(): this;
     get(path: string, config?: any, apiConfig?: RestfulApiConfig): Promise<any>;
     delete(path: string, config?: any, apiConfig?: RestfulApiConfig): Promise<any>;

package/lib/api/restful/index.js

@@ -9,7 +9,6 @@ const index_js_2 = __importDefault(require("../index.js"));
 exports.defaultApiHeaders = {
     'Content-Type': 'application/json',
     'Cache-Control': 'no-cache',
-    // @ts-ignore
     ...(typeof window === 'undefined' ? {
         'Accept-Encoding': 'application/gzip'
     } : {})
@@ -31,9 +30,6 @@ class Restful extends index_js_2.default {
     static buildServerUrl(schema, subdomain, sandbox, tld) {
         return `${schema}${subdomain}.${sandbox ? 'sandbox.' : ''}${tld}`;
     }
-    /**
-     * Enable to supports the use of OAuth tokens for user authorization.
-     */
     get useIaf() {
         return false;
     }
@@ -66,29 +62,15 @@ class Restful extends index_js_2.default {
     get baseUrl() {
         return this.getServerUrl(this.apiConfig);
     }
-    /**
-     * Create a new instances of it self with specified api config.
-     * @param apiConfig
-     */
     api(apiConfig) {
-        // @ts-ignore
         return new this.constructor(this.config, this.req, this.auth, apiConfig);
     }
-    /**
-     * Use "apix" subdomain
-     */
     get apix() {
         return this.api({ subdomain: 'apix' });
     }
-    /**
-     * Use "apiz" subdomain
-     */
     get apiz() {
         return this.api({ subdomain: 'apiz' });
     }
-    /**
-     * Sign request
-     */
     get sign() {
         return this.api({ sign: true });
     }
@@ -106,10 +88,8 @@ class Restful extends index_js_2.default {
     }
     get additionalHeaders() {
         return Object.keys(additionalHeaders)
-            // @ts-ignore
             .filter(key => typeof this.config[key] !== 'undefined')
             .reduce((headers, key) => {
-            // @ts-ignore
             headers[additionalHeaders[key]] = this.config[key];
             return headers;
         }, {});
@@ -142,8 +122,7 @@ class Restful extends index_js_2.default {
         }
         catch (error) {
             if (this.shouldRefreshToken(error)) {
-                // Try again and refresh token
-                return await this.request(payload, apiConfig, true /* refresh token */);
+                return await this.request(payload, apiConfig, true);
             }
             throw error;
         }
@@ -170,7 +149,6 @@ class Restful extends index_js_2.default {
             }
             const enrichedConfig = await this.enrichRequestConfig(apiRequest, data, apiCfg);
             const args = ['get', 'delete'].includes(method) ? [enrichedConfig] : [data, enrichedConfig];
-            // @ts-ignore
             const response = await this.req[method](endpoint, ...args);
             if (this.apiConfig.returnResponse) {
                 return response;

package/lib/api/restful/postOrder/cancellation/index.d.ts

@@ -1,57 +1,14 @@
 import Restful from '../../index.js';
 import { CancellationSearchParams, ConfirmRefundRequest, CreateCancelRequest, RejectCancelRequest } from '../../../../types/index.js';
-/**
- * Post-Order Cancellation API
- */
 export default class Cancellation extends Restful {
     static id: string;
     get basePath(): string;
     get useIaf(): boolean;
-    /**
-     * Seller approves a cancellation request
-     *
-     * @param cancelId The unique eBay-assigned identifier of the cancellation request to be approved.
-     */
     approveCancellationRequest(cancelId: string): Promise<any>;
-    /**
-     * Check the eligibility of an order cancellation
-     *
-     * @param legacyOrderId The unique ID of the order being canceled or the order being considered for cancellation.
-     */
     checkCancellationEligibility(legacyOrderId: string): Promise<any>;
-    /**
-     * Buyer confirms the refund from a cancellation was received
-     *
-     * @param cancelId The unique eBay-assigned identifier of the cancellation/refund being confirmed.
-     * @param payload the ConfirmRefundReceivedPayload
-     */
     confirmRefundReceived(cancelId: string, payload?: ConfirmRefundRequest): Promise<any>;
-    /**
-     * Request or perform an order cancellation.
-     *
-     * @param payload the CreateCancelRequest
-     */
     createCancellation(payload: CreateCancelRequest): Promise<any>;
-    /**
-     * Retrieve the details of an order cancellation.
-     *
-     * @param cancelId Supply in this path parameter the unique eBay-assigned ID of the cancellation request to
-     *     retrieve.
-     * @param fieldGroups    The value set in this query parameter controls the level of detail that is returned in the
-     *     response.
-     */
     getCancellation(cancelId: string, fieldGroups?: string): Promise<any>;
-    /**
-     * Seller rejects a cancellation request.
-     *
-     * @param cancelId The unique eBay-assigned identifier of the cancellation request to be rejected.
-     * @param payload the RejectCancelRequest
-     */
     rejectCancellationRequest(cancelId: string, payload?: RejectCancelRequest): Promise<any>;
-    /**
-     * Search for cancellations.
-     *
-     * @param params the SearchParams
-     */
     search(params: CancellationSearchParams): Promise<any>;
 }

package/lib/api/restful/postOrder/cancellation/index.js

@@ -4,9 +4,6 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 const index_js_1 = __importDefault(require("../../index.js"));
-/**
- * Post-Order Cancellation API
- */
 class Cancellation extends index_js_1.default {
     get basePath() {
         return '/post-order/v2';
@@ -14,51 +11,22 @@ class Cancellation extends index_js_1.default {
     get useIaf() {
         return true;
     }
-    /**
-     * Seller approves a cancellation request
-     *
-     * @param cancelId The unique eBay-assigned identifier of the cancellation request to be approved.
-     */
     approveCancellationRequest(cancelId) {
         cancelId = encodeURIComponent(cancelId);
         return this.post(`/cancellation/${cancelId}/approve`);
     }
-    /**
-     * Check the eligibility of an order cancellation
-     *
-     * @param legacyOrderId The unique ID of the order being canceled or the order being considered for cancellation.
-     */
     checkCancellationEligibility(legacyOrderId) {
         return this.post(`/cancellation/check_eligibility`, {
             legacyOrderId
         });
     }
-    /**
-     * Buyer confirms the refund from a cancellation was received
-     *
-     * @param cancelId The unique eBay-assigned identifier of the cancellation/refund being confirmed.
-     * @param payload the ConfirmRefundReceivedPayload
-     */
     confirmRefundReceived(cancelId, payload) {
         cancelId = encodeURIComponent(cancelId);
         return this.post(`/cancellation/${cancelId}/confirm`, payload);
     }
-    /**
-     * Request or perform an order cancellation.
-     *
-     * @param payload the CreateCancelRequest
-     */
     createCancellation(payload) {
         return this.post(`/cancellation`, payload);
     }
-    /**
-     * Retrieve the details of an order cancellation.
-     *
-     * @param cancelId Supply in this path parameter the unique eBay-assigned ID of the cancellation request to
-     *     retrieve.
-     * @param fieldGroups    The value set in this query parameter controls the level of detail that is returned in the
-     *     response.
-     */
     getCancellation(cancelId, fieldGroups) {
         cancelId = encodeURIComponent(cancelId);
         return this.get(`/cancellation/${cancelId}`, {
@@ -67,26 +35,13 @@ class Cancellation extends index_js_1.default {
             }
         });
     }
-    /**
-     * Seller rejects a cancellation request.
-     *
-     * @param cancelId The unique eBay-assigned identifier of the cancellation request to be rejected.
-     * @param payload the RejectCancelRequest
-     */
     rejectCancellationRequest(cancelId, payload) {
         cancelId = encodeURIComponent(cancelId);
         return this.post(`/cancellation/${cancelId}/reject`, payload);
     }
-    /**
-     * Search for cancellations.
-     *
-     * @param params the SearchParams
-     */
     search(params) {
         return this.get(`/cancellation/search`, {
-            params: {
-                params
-            }
+            params
         });
     }
 }

package/lib/api/restful/postOrder/case/index.d.ts

@@ -1,63 +1,17 @@
 import { AppealRequest, BuyerCloseCaseRequest, CaseSearchParams, ReturnAddressRequest, Text } from '../../../../types/index.js';
 import Restful from '../../index.js';
-/**
- * Post-Order Case Management API
- */
 export default class Case extends Restful {
     static id: string;
     get basePath(): string;
     get useIaf(): boolean;
-    /**
-     * Buyer or seller appeals a case decision.
-     *
-     * @param caseId The unique identifier of a case.
-     * @param payload the AppealRequest
-     */
     appealCaseDecision(caseId: string, payload?: AppealRequest): Promise<any>;
-    /**
-     * Check the eligibility of an order cancellation.
-     *
-     * @param caseId The unique identifier of a case.
-     * @param payload the BuyerCloseCaseRequest
-     */
     closeCase(caseId: string, payload: BuyerCloseCaseRequest): Promise<any>;
-    /**
-     * Retrieve the details related to a specific case.
-     *
-     * @param caseId The unique identifier of a case.
-     */
     getCase(caseId: string): Promise<any>;
-    /**
-     * Seller issues a refund for a case.
-     *
-     * @param caseId The unique identifier of a case.
-     * @param payload the CaseVoluntaryRefundRequest (Text)
-     */
     issueCaseRefund(caseId: string, payload?: Text): Promise<any>;
-    /**
-     * This call allows the buyer to provide shipment tracking information for the item that is being returned to the
-     * seller.
-     *
-     * @param caseId The unique identifier of a case.
-     * @param shippingCarrierName The shipping carrier that is used to ship the item, such as 'FedEx', 'UPS', or
-     *     'USPS'.
-     * @param trackingNumber The tracking number assigned by the shipping carrier to the item shipment.
-     */
     provideReturnShipmentInfo(caseId: string, { shippingCarrierName, trackingNumber }: {
         shippingCarrierName: string;
         trackingNumber: string;
     }): Promise<any>;
-    /**
-     * Seller provides a return address to the buyer.
-     *
-     * @param cancelId The unique eBay-assigned identifier of the cancellation request to be rejected.
-     * @param payload the ReturnAddressRequest
-     */
     providesReturnAddress(cancelId: string, payload?: ReturnAddressRequest): Promise<any>;
-    /**
-     * This call is used to search for cases using multiple filter types.
-     *
-     * @param params the SearchParams
-     */
     search(params: CaseSearchParams): Promise<any>;
 }