ebay-api 8.4.0 → 8.5.0

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

@@ -1,15 +1,15 @@
-import Catalog from './catalog/index.js';
-import Charity from './charity/index.js';
-import Identity from './identity/index.js';
-import Notification from './notification/index.js';
-import Taxonomy from './taxonomy/index.js';
-import Translation from './translation/index.js';
-export type Commerce = {
-    catalog: Catalog;
-    charity: Charity;
-    identity: Identity;
-    notification: Notification;
-    taxonomy: Taxonomy;
-    translation: Translation;
-};
-export { Catalog, Charity, Identity, Notification, Taxonomy, Translation };
+import Catalog from './catalog/index.js';
+import Charity from './charity/index.js';
+import Identity from './identity/index.js';
+import Notification from './notification/index.js';
+import Taxonomy from './taxonomy/index.js';
+import Translation from './translation/index.js';
+export type Commerce = {
+    catalog: Catalog;
+    charity: Charity;
+    identity: Identity;
+    notification: Notification;
+    taxonomy: Taxonomy;
+    translation: Translation;
+};
+export { Catalog, Charity, Identity, Notification, Taxonomy, Translation };

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

@@ -1,18 +1,18 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Translation = exports.Taxonomy = exports.Notification = exports.Identity = exports.Charity = exports.Catalog = void 0;
-const index_js_1 = __importDefault(require("./catalog/index.js"));
-exports.Catalog = index_js_1.default;
-const index_js_2 = __importDefault(require("./charity/index.js"));
-exports.Charity = index_js_2.default;
-const index_js_3 = __importDefault(require("./identity/index.js"));
-exports.Identity = index_js_3.default;
-const index_js_4 = __importDefault(require("./notification/index.js"));
-exports.Notification = index_js_4.default;
-const index_js_5 = __importDefault(require("./taxonomy/index.js"));
-exports.Taxonomy = index_js_5.default;
-const index_js_6 = __importDefault(require("./translation/index.js"));
-exports.Translation = index_js_6.default;
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Translation = exports.Taxonomy = exports.Notification = exports.Identity = exports.Charity = exports.Catalog = void 0;
+const index_js_1 = __importDefault(require("./catalog/index.js"));
+exports.Catalog = index_js_1.default;
+const index_js_2 = __importDefault(require("./charity/index.js"));
+exports.Charity = index_js_2.default;
+const index_js_3 = __importDefault(require("./identity/index.js"));
+exports.Identity = index_js_3.default;
+const index_js_4 = __importDefault(require("./notification/index.js"));
+exports.Notification = index_js_4.default;
+const index_js_5 = __importDefault(require("./taxonomy/index.js"));
+exports.Taxonomy = index_js_5.default;
+const index_js_6 = __importDefault(require("./translation/index.js"));
+exports.Translation = index_js_6.default;

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

@@ -1,117 +1,118 @@
-import Restful from '../../index.js';
-import { CreateSubscriptionRequest, DestinationRequest, NotificationConfig, NotificationParams, UpdateSubscriptionRequest } from '../../../../types/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.
- */
-export default class Notification extends Restful {
-    static id: string;
-    get basePath(): string;
-    /**
-     * 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: string): Promise<any>;
-    /**
-     * 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: string): Promise<any>;
-    /**
-     * 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 }: NotificationParams): Promise<any>;
-    /**
-     * 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 }: NotificationParams): Promise<any>;
-    /**
-     * This method allows applications to retrieve a list of all subscriptions.
-     *
-     * @param body The create subscription request.
-     */
-    createSubscription(body: CreateSubscriptionRequest): Promise<any>;
-    /**
-     * This method allows applications to retrieve subscription details for the specified subscription.
-     *
-     * @param subscriptionId The unique identifier for the subscription.
-     */
-    getSubscription(subscriptionId: string): Promise<any>;
-    /**
-     * 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: string, body: UpdateSubscriptionRequest): Promise<any>;
-    /**
-     * This method allows applications to delete a subscription.
-     *
-     * @param subscriptionId The unique identifier for the subscription.
-     */
-    deleteSubscription(subscriptionId: string): Promise<any>;
-    /**
-     * This method allows applications to enable a disabled subscription.
-     *
-     * @param subscriptionId The unique identifier for the subscription.
-     */
-    enableSubscription(subscriptionId: string): Promise<any>;
-    /**
-     * This method disables a subscription, which prevents the subscription from providing notifications.
-     * @param subscriptionId The unique identifier for the subscription.
-     */
-    disableSubscription(subscriptionId: string): Promise<any>;
-    /**
-     * 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: string): Promise<any>;
-    /**
-     * 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 }: NotificationParams): Promise<any>;
-    /**
-     * This method allows applications to create a destination.
-     *
-     * @param body The create destination request.
-     */
-    createDestination(body: DestinationRequest): Promise<any>;
-    /**
-     * This method allows applications to fetch the details for a destination.
-     *
-     * @param destinationId The unique identifier for the destination.
-     */
-    getDestination(destinationId: string): Promise<any>;
-    /**
-     * This method allows applications to update a destination.
-     *
-     * @param destinationId The unique identifier for the destination.
-     * @param body The create subscription request.
-     */
-    updateDestination(destinationId: string, body: DestinationRequest): Promise<any>;
-    /**
-     * his method provides applications a way to delete a destination.
-     *
-     * @param destinationId The unique identifier for the destination.
-     */
-    deleteDestination(destinationId: string): Promise<any>;
-    /**
-     * This method allows applications to retrieve a previously created configuration.
-     */
-    getConfig(): Promise<any>;
-    /**
-     * This method allows applications to create a new configuration or update an existing configuration.
-     *
-     * @param body The configurations for this application.
-     */
-    updateConfig(body: NotificationConfig): Promise<any>;
-}
+import { CommerceNotificationConfig, CreateSubscriptionRequest, DestinationRequest, NotificationParams, UpdateSubscriptionRequest } from '../../../../types/index.js';
+import { operations } from '../../../../types/restful/specs/commerce_notification_v1_oas3.js';
+import Restful, { OpenApi } from '../../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.
+ */
+export default class Notification extends Restful implements OpenApi<operations> {
+    static id: string;
+    get basePath(): string;
+    /**
+     * 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: string): Promise<any>;
+    /**
+     * 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: string): Promise<any>;
+    /**
+     * 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 }: NotificationParams): Promise<any>;
+    /**
+     * 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 }: NotificationParams): Promise<any>;
+    /**
+     * This method allows applications to retrieve a list of all subscriptions.
+     *
+     * @param body The create subscription request.
+     */
+    createSubscription(body: CreateSubscriptionRequest): Promise<any>;
+    /**
+     * This method allows applications to retrieve subscription details for the specified subscription.
+     *
+     * @param subscriptionId The unique identifier for the subscription.
+     */
+    getSubscription(subscriptionId: string): Promise<any>;
+    /**
+     * 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: string, body: UpdateSubscriptionRequest): Promise<any>;
+    /**
+     * This method allows applications to delete a subscription.
+     *
+     * @param subscriptionId The unique identifier for the subscription.
+     */
+    deleteSubscription(subscriptionId: string): Promise<any>;
+    /**
+     * This method allows applications to enable a disabled subscription.
+     *
+     * @param subscriptionId The unique identifier for the subscription.
+     */
+    enableSubscription(subscriptionId: string): Promise<any>;
+    /**
+     * This method disables a subscription, which prevents the subscription from providing notifications.
+     * @param subscriptionId The unique identifier for the subscription.
+     */
+    disableSubscription(subscriptionId: string): Promise<any>;
+    /**
+     * 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: string): Promise<any>;
+    /**
+     * 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 }: NotificationParams): Promise<any>;
+    /**
+     * This method allows applications to create a destination.
+     *
+     * @param body The create destination request.
+     */
+    createDestination(body: DestinationRequest): Promise<any>;
+    /**
+     * This method allows applications to fetch the details for a destination.
+     *
+     * @param destinationId The unique identifier for the destination.
+     */
+    getDestination(destinationId: string): Promise<any>;
+    /**
+     * This method allows applications to update a destination.
+     *
+     * @param destinationId The unique identifier for the destination.
+     * @param body The create subscription request.
+     */
+    updateDestination(destinationId: string, body: DestinationRequest): Promise<any>;
+    /**
+     * his method provides applications a way to delete a destination.
+     *
+     * @param destinationId The unique identifier for the destination.
+     */
+    deleteDestination(destinationId: string): Promise<any>;
+    /**
+     * This method allows applications to retrieve a previously created configuration.
+     */
+    getConfig(): Promise<any>;
+    /**
+     * This method allows applications to create a new configuration or update an existing configuration.
+     *
+     * @param body The configurations for this application.
+     */
+    updateConfig(body: CommerceNotificationConfig): Promise<any>;
+}