ebay-api 8.4.1 → 8.5.0

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

@@ -1,186 +1,186 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const index_js_1 = __importDefault(require("../../index.js"));
-/**
- * The eBay  Notification API allows third-party developers and applications to process eBay notifications and verify the integrity of the notification message payload.
- */
-class Notification extends index_js_1.default {
-    get basePath() {
-        return '/commerce/notification/v1';
-    }
-    /**
-     * This method allows users to retrieve a public key using a specified key ID.
-     *
-     * @param publicKeyId The unique key ID that is used to retrieve the public key
-     */
-    getPublicKey(publicKeyId) {
-        publicKeyId = encodeURIComponent(publicKeyId);
-        return this.get(`/public_key/${publicKeyId}`);
-    }
-    /**
-     * This method allows applications to retrieve details for the specified topic.
-     *
-     * @param topicId The ID of the topic for which to retrieve the details.
-     */
-    getTopic(topicId) {
-        topicId = encodeURIComponent(topicId);
-        return this.get(`/topic/${topicId}`);
-    }
-    /**
-     * This method returns a paginated collection of all supported topics, along with the details for the topics.
-     *
-     * @param limit The maximum number of items to return per page from the result set.
-     * @param continuationToken The token used to access the next set of results.
-     */
-    getTopics({ limit, continuationToken: continuation_token }) {
-        return this.get(`/topic`, {
-            params: {
-                limit,
-                continuation_token
-            }
-        });
-    }
-    /**
-     * This method allows applications to retrieve a list of all subscriptions.
-     *
-     * @param limit The number of items, from the result set, returned in a single page.
-     * @param continuation_token The continuation token for the next set of results.
-     */
-    getSubscriptions({ limit, continuationToken: continuation_token }) {
-        return this.get(`/subscription`, {
-            params: {
-                limit,
-                continuation_token
-            }
-        });
-    }
-    /**
-     * This method allows applications to retrieve a list of all subscriptions.
-     *
-     * @param body The create subscription request.
-     */
-    createSubscription(body) {
-        return this.post(`/subscription`, body);
-    }
-    /**
-     * This method allows applications to retrieve subscription details for the specified subscription.
-     *
-     * @param subscriptionId The unique identifier for the subscription.
-     */
-    getSubscription(subscriptionId) {
-        subscriptionId = encodeURIComponent(subscriptionId);
-        return this.get(`/subscription/${subscriptionId}`);
-    }
-    /**
-     * This method allows applications to retrieve subscription details for the specified subscription.
-     *
-     * @param subscriptionId The unique identifier for the subscription.
-     * @param body The update subscription request.
-     */
-    updateSubscription(subscriptionId, body) {
-        subscriptionId = encodeURIComponent(subscriptionId);
-        return this.put(`/subscription/${subscriptionId}`, body);
-    }
-    /**
-     * This method allows applications to delete a subscription.
-     *
-     * @param subscriptionId The unique identifier for the subscription.
-     */
-    deleteSubscription(subscriptionId) {
-        subscriptionId = encodeURIComponent(subscriptionId);
-        return this.delete(`/subscription/${subscriptionId}`);
-    }
-    /**
-     * This method allows applications to enable a disabled subscription.
-     *
-     * @param subscriptionId The unique identifier for the subscription.
-     */
-    enableSubscription(subscriptionId) {
-        subscriptionId = encodeURIComponent(subscriptionId);
-        return this.post(`/subscription/${subscriptionId}/enable`);
-    }
-    /**
-     * This method disables a subscription, which prevents the subscription from providing notifications.
-     * @param subscriptionId The unique identifier for the subscription.
-     */
-    disableSubscription(subscriptionId) {
-        subscriptionId = encodeURIComponent(subscriptionId);
-        return this.post(`/subscription/${subscriptionId}/disable`);
-    }
-    /**
-     * This method triggers a mocked test payload that includes a notification ID, publish date, and so on.
-     *
-     * @param subscriptionId The unique identifier for the subscription.
-     */
-    test(subscriptionId) {
-        subscriptionId = encodeURIComponent(subscriptionId);
-        return this.post(`/subscription/${subscriptionId}/test`);
-    }
-    /**
-     * This method allows applications to retrieve a paginated collection of destination resources and related details.
-     * @param subscriptionId The unique identifier for the subscription.
-     */
-    getDestinations({ limit, continuationToken: continuation_token }) {
-        return this.get(`/destination`, {
-            params: {
-                limit,
-                continuation_token
-            }
-        });
-    }
-    /**
-     * This method allows applications to create a destination.
-     *
-     * @param body The create destination request.
-     */
-    createDestination(body) {
-        return this.post(`/destination`, body);
-    }
-    /**
-     * This method allows applications to fetch the details for a destination.
-     *
-     * @param destinationId The unique identifier for the destination.
-     */
-    getDestination(destinationId) {
-        destinationId = encodeURIComponent(destinationId);
-        return this.get(`/destination/${destinationId}`);
-    }
-    /**
-     * This method allows applications to update a destination.
-     *
-     * @param destinationId The unique identifier for the destination.
-     * @param body The create subscription request.
-     */
-    updateDestination(destinationId, body) {
-        destinationId = encodeURIComponent(destinationId);
-        return this.put(`/destination/${destinationId}`, body);
-    }
-    /**
-     * his method provides applications a way to delete a destination.
-     *
-     * @param destinationId The unique identifier for the destination.
-     */
-    deleteDestination(destinationId) {
-        destinationId = encodeURIComponent(destinationId);
-        return this.delete(`/destination/${destinationId}`);
-    }
-    /**
-     * This method allows applications to retrieve a previously created configuration.
-     */
-    getConfig() {
-        return this.get(`/config`);
-    }
-    /**
-     * This method allows applications to create a new configuration or update an existing configuration.
-     *
-     * @param body The configurations for this application.
-     */
-    updateConfig(body) {
-        return this.put(`/config`, body);
-    }
-}
-exports.default = Notification;
-Notification.id = 'Notification';
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const index_js_1 = __importDefault(require("../../index.js"));
+/**
+ * The eBay  Notification API allows third-party developers and applications to process eBay notifications and verify the integrity of the notification message payload.
+ */
+class Notification extends index_js_1.default {
+    get basePath() {
+        return '/commerce/notification/v1';
+    }
+    /**
+     * This method allows users to retrieve a public key using a specified key ID.
+     *
+     * @param publicKeyId The unique key ID that is used to retrieve the public key
+     */
+    getPublicKey(publicKeyId) {
+        publicKeyId = encodeURIComponent(publicKeyId);
+        return this.get(`/public_key/${publicKeyId}`);
+    }
+    /**
+     * This method allows applications to retrieve details for the specified topic.
+     *
+     * @param topicId The ID of the topic for which to retrieve the details.
+     */
+    getTopic(topicId) {
+        topicId = encodeURIComponent(topicId);
+        return this.get(`/topic/${topicId}`);
+    }
+    /**
+     * This method returns a paginated collection of all supported topics, along with the details for the topics.
+     *
+     * @param limit The maximum number of items to return per page from the result set.
+     * @param continuationToken The token used to access the next set of results.
+     */
+    getTopics({ limit, continuationToken: continuation_token }) {
+        return this.get(`/topic`, {
+            params: {
+                limit,
+                continuation_token
+            }
+        });
+    }
+    /**
+     * This method allows applications to retrieve a list of all subscriptions.
+     *
+     * @param limit The number of items, from the result set, returned in a single page.
+     * @param continuation_token The continuation token for the next set of results.
+     */
+    getSubscriptions({ limit, continuationToken: continuation_token }) {
+        return this.get(`/subscription`, {
+            params: {
+                limit,
+                continuation_token
+            }
+        });
+    }
+    /**
+     * This method allows applications to retrieve a list of all subscriptions.
+     *
+     * @param body The create subscription request.
+     */
+    createSubscription(body) {
+        return this.post(`/subscription`, body);
+    }
+    /**
+     * This method allows applications to retrieve subscription details for the specified subscription.
+     *
+     * @param subscriptionId The unique identifier for the subscription.
+     */
+    getSubscription(subscriptionId) {
+        subscriptionId = encodeURIComponent(subscriptionId);
+        return this.get(`/subscription/${subscriptionId}`);
+    }
+    /**
+     * This method allows applications to retrieve subscription details for the specified subscription.
+     *
+     * @param subscriptionId The unique identifier for the subscription.
+     * @param body The update subscription request.
+     */
+    updateSubscription(subscriptionId, body) {
+        subscriptionId = encodeURIComponent(subscriptionId);
+        return this.put(`/subscription/${subscriptionId}`, body);
+    }
+    /**
+     * This method allows applications to delete a subscription.
+     *
+     * @param subscriptionId The unique identifier for the subscription.
+     */
+    deleteSubscription(subscriptionId) {
+        subscriptionId = encodeURIComponent(subscriptionId);
+        return this.delete(`/subscription/${subscriptionId}`);
+    }
+    /**
+     * This method allows applications to enable a disabled subscription.
+     *
+     * @param subscriptionId The unique identifier for the subscription.
+     */
+    enableSubscription(subscriptionId) {
+        subscriptionId = encodeURIComponent(subscriptionId);
+        return this.post(`/subscription/${subscriptionId}/enable`);
+    }
+    /**
+     * This method disables a subscription, which prevents the subscription from providing notifications.
+     * @param subscriptionId The unique identifier for the subscription.
+     */
+    disableSubscription(subscriptionId) {
+        subscriptionId = encodeURIComponent(subscriptionId);
+        return this.post(`/subscription/${subscriptionId}/disable`);
+    }
+    /**
+     * This method triggers a mocked test payload that includes a notification ID, publish date, and so on.
+     *
+     * @param subscriptionId The unique identifier for the subscription.
+     */
+    test(subscriptionId) {
+        subscriptionId = encodeURIComponent(subscriptionId);
+        return this.post(`/subscription/${subscriptionId}/test`);
+    }
+    /**
+     * This method allows applications to retrieve a paginated collection of destination resources and related details.
+     * @param subscriptionId The unique identifier for the subscription.
+     */
+    getDestinations({ limit, continuationToken: continuation_token }) {
+        return this.get(`/destination`, {
+            params: {
+                limit,
+                continuation_token
+            }
+        });
+    }
+    /**
+     * This method allows applications to create a destination.
+     *
+     * @param body The create destination request.
+     */
+    createDestination(body) {
+        return this.post(`/destination`, body);
+    }
+    /**
+     * This method allows applications to fetch the details for a destination.
+     *
+     * @param destinationId The unique identifier for the destination.
+     */
+    getDestination(destinationId) {
+        destinationId = encodeURIComponent(destinationId);
+        return this.get(`/destination/${destinationId}`);
+    }
+    /**
+     * This method allows applications to update a destination.
+     *
+     * @param destinationId The unique identifier for the destination.
+     * @param body The create subscription request.
+     */
+    updateDestination(destinationId, body) {
+        destinationId = encodeURIComponent(destinationId);
+        return this.put(`/destination/${destinationId}`, body);
+    }
+    /**
+     * his method provides applications a way to delete a destination.
+     *
+     * @param destinationId The unique identifier for the destination.
+     */
+    deleteDestination(destinationId) {
+        destinationId = encodeURIComponent(destinationId);
+        return this.delete(`/destination/${destinationId}`);
+    }
+    /**
+     * This method allows applications to retrieve a previously created configuration.
+     */
+    getConfig() {
+        return this.get(`/config`);
+    }
+    /**
+     * This method allows applications to create a new configuration or update an existing configuration.
+     *
+     * @param body The configurations for this application.
+     */
+    updateConfig(body) {
+        return this.put(`/config`, body);
+    }
+}
+Notification.id = 'Notification';
+exports.default = Notification;

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

@@ -1,78 +1,79 @@
-/// <reference types="node" />
-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" />
+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>;
+}