ebay-api 8.4.1 → 8.5.1

package/dist/api/restful/commerce/taxonomy/index.d.ts

@@ -1,78 +1,79 @@
-/// <reference types="node" resolution-mode="require"/>
-import Restful from '../../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.
- */
-export default class Taxonomy extends Restful {
-    static id: string;
-    get basePath(): string;
-    /**
-     * 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: string): Promise<any>;
-    /**
-     * This call retrieves the complete category tree that is identified by the category_tree_id parameter.
-     *
-     * @param categoryTreeId
-     */
-    getCategoryTree(categoryTreeId: string): Promise<any>;
-    /**
-     * 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: string, categoryId: string): Promise<any>;
-    /**
-     * 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: string, q: string): Promise<any>;
-    /**
-     * 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: string, categoryId: string): Promise<any>;
-    /**
-     * 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: string, categoryId: string): Promise<any>;
-    /**
-     * 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: string, categoryId: string, compatibilityProperty: string): Promise<any>;
-    /**
-     * 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: string): Promise<Buffer>;
-}
+/// <reference types="node" resolution-mode="require"/>
+import { operations } from '../../../../types/restful/specs/commerce_taxonomy_v1_oas3.js';
+import Restful, { OpenApi } from '../../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.
+ */
+export default class Taxonomy extends Restful implements OpenApi<operations> {
+    static id: string;
+    get basePath(): string;
+    /**
+     * 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: string): Promise<any>;
+    /**
+     * This call retrieves the complete category tree that is identified by the category_tree_id parameter.
+     *
+     * @param categoryTreeId
+     */
+    getCategoryTree(categoryTreeId: string): Promise<any>;
+    /**
+     * 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: string, categoryId: string): Promise<any>;
+    /**
+     * 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: string, q: string): Promise<any>;
+    /**
+     * 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: string, categoryId: string): Promise<any>;
+    /**
+     * 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: string, categoryId: string): Promise<any>;
+    /**
+     * 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: string, categoryId: string, compatibilityProperty: string): Promise<any>;
+    /**
+     * 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: string): Promise<Buffer>;
+}

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

@@ -1,128 +1,129 @@
-import Restful from '../../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.
- */
-export default class Taxonomy extends Restful {
-    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: {
-                marketplace_id: marketplaceId
-            }
-        });
-    }
-    /**
-     * 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`, {
-            params: {
-                category_id: categoryId
-            }
-        });
-    }
-    /**
-     * 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: {
-                q
-            }
-        });
-    }
-    /**
-     * 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`, {
-            params: {
-                category_id: categoryId
-            }
-        });
-    }
-    /**
-     * 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`, {
-            params: {
-                category_id: categoryId
-            }
-        });
-    }
-    /**
-     * 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`, {
-            params: {
-                category_id: categoryId,
-                compatibility_property: compatibilityProperty
-            }
-        });
-    }
-    /**
-     * 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`, {
-            responseType: 'arraybuffer'
-        });
-    }
-}
-Taxonomy.id = 'Taxonomy';
+import Restful from '../../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 Restful {
+    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: {
+                marketplace_id: marketplaceId
+            }
+        });
+    }
+    /**
+     * 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`, {
+            params: {
+                category_id: categoryId
+            }
+        });
+    }
+    /**
+     * 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: {
+                q
+            }
+        });
+    }
+    /**
+     * 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`, {
+            params: {
+                category_id: categoryId
+            }
+        });
+    }
+    /**
+     * 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`, {
+            params: {
+                category_id: categoryId
+            }
+        });
+    }
+    /**
+     * 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`, {
+            params: {
+                category_id: categoryId,
+                compatibility_property: compatibilityProperty
+            }
+        });
+    }
+    /**
+     * 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`, {
+            responseType: 'arraybuffer'
+        });
+    }
+}
+Taxonomy.id = 'Taxonomy';
+export default Taxonomy;

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

@@ -1,15 +1,16 @@
-import Restful from '../../index.js';
-import { TranslateRequest } from '../../../../types/index.js';
-/**
- * This API allows 3rd party developers to translate item title, description, search query.
- */
-export default class Translation extends Restful {
-    static id: string;
-    get basePath(): string;
-    /**
-     * Translates input text inot a given language.
-     *
-     * @param body TranslateRequest
-     */
-    translate(body: TranslateRequest): Promise<any>;
-}
+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/dist/api/restful/commerce/translation/index.js

@@ -1,18 +1,19 @@
-import Restful from '../../index.js';
-/**
- * This API allows 3rd party developers to translate item title, description, search query.
- */
-export default class Translation extends Restful {
-    get basePath() {
-        return '/commerce/translation/v1_beta';
-    }
-    /**
-     * Translates input text inot a given language.
-     *
-     * @param body TranslateRequest
-     */
-    translate(body) {
-        return this.post(`/translate`, body);
-    }
-}
-Translation.id = 'Translation';
+import Restful from '../../index.js';
+/**
+ * This API allows 3rd party developers to translate item title, description, search query.
+ */
+class Translation extends Restful {
+    get basePath() {
+        return '/commerce/translation/v1_beta';
+    }
+    /**
+     * Translates input text inot a given language.
+     *
+     * @param body TranslateRequest
+     */
+    translate(body) {
+        return this.post(`/translate`, body);
+    }
+}
+Translation.id = 'Translation';
+export default Translation;

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

@@ -1,22 +1,23 @@
-import Restful from '../../index.js';
-/**
- * This method retrieves the call limit and utilization data for an application.
- */
-export default class Analytics extends Restful {
-    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>;
-}
+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/dist/api/restful/developer/analytics/index.js

@@ -1,38 +1,39 @@
-import Restful from '../../index.js';
-/**
- * This method retrieves the call limit and utilization data for an application.
- */
-export default class Analytics extends Restful {
-    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: {
-                api_context: apiContext,
-                api_name: apiName
-            }
-        });
-    }
-    /**
-     * 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: {
-                api_context: apiContext,
-                api_name: apiName
-            }
-        });
-    }
-}
-Analytics.id = 'Analytics';
+import Restful from '../../index.js';
+/**
+ * This method retrieves the call limit and utilization data for an application.
+ */
+class Analytics extends Restful {
+    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: {
+                api_context: apiContext,
+                api_name: apiName
+            }
+        });
+    }
+    /**
+     * 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: {
+                api_context: apiContext,
+                api_name: apiName
+            }
+        });
+    }
+}
+Analytics.id = 'Analytics';
+export default Analytics;

package/dist/api/restful/developer/index.d.ts

@@ -1,7 +1,7 @@
-import Analytics from './analytics/index.js';
-import KeyManagement from './keyManagement/index.js';
-export type Developer = {
-    analytics: Analytics;
-    keyManagement: KeyManagement;
-};
-export { Analytics, KeyManagement };
+import Analytics from './analytics/index.js';
+import KeyManagement from './keyManagement/index.js';
+export type Developer = {
+    analytics: Analytics;
+    keyManagement: KeyManagement;
+};
+export { Analytics, KeyManagement };

package/dist/api/restful/developer/index.js

@@ -1,3 +1,3 @@
-import Analytics from './analytics/index.js';
-import KeyManagement from './keyManagement/index.js';
-export { Analytics, KeyManagement };
+import Analytics from './analytics/index.js';
+import KeyManagement from './keyManagement/index.js';
+export { Analytics, KeyManagement };