ebay-api 8.4.1 → 8.5.0

package/dist/api/restful/buy/deal/index.js

@@ -1,73 +1,74 @@
-import Restful from '../../index.js';
-/**
- * This API allows third-party developers to search for and retrieve details about eBay deals and events, as well as the items associated with those deals and events.
- */
-export default class Deal extends Restful {
-    get basePath() {
-        return '/buy/deal/v1';
-    }
-    /**
-     * This method retrieves a paginated set of deal items.
-     *
-     * @param categoryIds The unique identifier of the eBay category for the search.
-     * @param commissionable A filter for commissionable deals. Restriction: This filter is currently only supported for the US marketplace.
-     * @param deliveryCountry A filter for items that can be shipped to the specified country.
-     * @param limit The maximum number of items, from the current result set, returned on a single page.
-     * @param offset The number of items that will be skipped in the result set.
-     */
-    getDealItems({ categoryIds, commissionable, deliveryCountry, limit, offset }) {
-        return this.get(`/deal_item`, {
-            params: {
-                category_ids: categoryIds,
-                commissionable,
-                delivery_country: deliveryCountry,
-                limit,
-                offset
-            }
-        });
-    }
-    /**
-     * This method retrieves the details for an eBay event.
-     *
-     * @param eventId The unique identifier for the eBay event.
-     */
-    getEvent(eventId) {
-        eventId = encodeURIComponent(eventId);
-        return this.get(`/event/${eventId}`);
-    }
-    /**
-     * This method returns paginated results containing all eBay events for the specified marketplace.
-     *
-     * @param limit The maximum number of items, from the current result set, returned on a single page. Default: 20 Maximum Value: 100
-     * @param offset The number of items that will be skipped in the result set.
-     */
-    getEvents({ limit, offset }) {
-        return this.get(`/event`, {
-            params: {
-                limit,
-                offset
-            }
-        });
-    }
-    /**
-     * This method returns paginated results containing all eBay events for the specified marketplace.
-     *
-     * @param eventIds The unique identifiers for the eBay events. Maximum Value: 1
-     * @param categoryIds The unique identifier of the eBay category for the search. Maximum Value: 1
-     * @param deliveryCountry A filter for items that can be shipped to the specified country.
-     * @param limit The maximum number of items, from the current result set, returned on a single page. Default: 20 Maximum Value: 100
-     * @param offset The number of items that will be skipped in the result set.
-     */
-    getEventItems(eventIds, { categoryIds, deliveryCountry, limit, offset } = {}) {
-        return this.get(`/event_item`, {
-            params: {
-                event_ids: eventIds,
-                limit,
-                offset,
-                category_ids: categoryIds,
-                delivery_country: deliveryCountry
-            }
-        });
-    }
-}
-Deal.id = 'Deal';
+import Restful from '../../index.js';
+/**
+ * This API allows third-party developers to search for and retrieve details about eBay deals and events, as well as the items associated with those deals and events.
+ */
+class Deal extends Restful {
+    get basePath() {
+        return '/buy/deal/v1';
+    }
+    /**
+     * This method retrieves a paginated set of deal items.
+     *
+     * @param categoryIds The unique identifier of the eBay category for the search.
+     * @param commissionable A filter for commissionable deals. Restriction: This filter is currently only supported for the US marketplace.
+     * @param deliveryCountry A filter for items that can be shipped to the specified country.
+     * @param limit The maximum number of items, from the current result set, returned on a single page.
+     * @param offset The number of items that will be skipped in the result set.
+     */
+    getDealItems({ categoryIds, commissionable, deliveryCountry, limit, offset }) {
+        return this.get(`/deal_item`, {
+            params: {
+                category_ids: categoryIds,
+                commissionable,
+                delivery_country: deliveryCountry,
+                limit,
+                offset
+            }
+        });
+    }
+    /**
+     * This method retrieves the details for an eBay event.
+     *
+     * @param eventId The unique identifier for the eBay event.
+     */
+    getEvent(eventId) {
+        eventId = encodeURIComponent(eventId);
+        return this.get(`/event/${eventId}`);
+    }
+    /**
+     * This method returns paginated results containing all eBay events for the specified marketplace.
+     *
+     * @param limit The maximum number of items, from the current result set, returned on a single page. Default: 20 Maximum Value: 100
+     * @param offset The number of items that will be skipped in the result set.
+     */
+    getEvents({ limit, offset }) {
+        return this.get(`/event`, {
+            params: {
+                limit,
+                offset
+            }
+        });
+    }
+    /**
+     * This method returns paginated results containing all eBay events for the specified marketplace.
+     *
+     * @param eventIds The unique identifiers for the eBay events. Maximum Value: 1
+     * @param categoryIds The unique identifier of the eBay category for the search. Maximum Value: 1
+     * @param deliveryCountry A filter for items that can be shipped to the specified country.
+     * @param limit The maximum number of items, from the current result set, returned on a single page. Default: 20 Maximum Value: 100
+     * @param offset The number of items that will be skipped in the result set.
+     */
+    getEventItems(eventIds, { categoryIds, deliveryCountry, limit, offset } = {}) {
+        return this.get(`/event_item`, {
+            params: {
+                event_ids: eventIds,
+                limit,
+                offset,
+                category_ids: categoryIds,
+                delivery_country: deliveryCountry
+            }
+        });
+    }
+}
+Deal.id = 'Deal';
+export default Deal;

package/dist/api/restful/buy/feed/index.d.ts

@@ -1,43 +1,44 @@
-import Restful from '../../index.js';
-import { BuyFeedParams } from '../../../../types/index.js';
-/**
- * The Feed API provides the ability to download TSV_GZIP feed files containing eBay items and an hourly snapshot file
- * of the items that have changed within an hour for a specific category, date and marketplace.
- */
-export default class Feed extends Restful {
-    static id: string;
-    get basePath(): string;
-    /**
-     * This method lets you download a TSV_GZIP (tab separated value gzip) Item feed file.
-     *
-     * @param {BuyFeedParams} params
-     * @param range his header specifies the range in bytes of the chunks of the gzip file being returned.
-     *          Format: bytes=startpos-endpos For example, the following retrieves the first 10 MBs of the feed file.
-     */
-    getItemFeed(params: BuyFeedParams, range: string): Promise<any>;
-    /**
-     * This method lets you download a TSV_GZIP (tab separated value gzip) Item Group feed file.
-     * @param {BuyFeedParams} params
-     * @param range his header specifies the range in bytes of the chunks of the gzip file being returned.
-     *          Format: bytes=startpos-endpos For example, the following retrieves the first 10 MBs of the feed file.
-     */
-    getItemGroupFeed(params: BuyFeedParams, range: string): Promise<any>;
-    /**
-     * The Hourly Snapshot feed file is generated each hour every day for all categories.
-     *
-     * @param {BuyFeedParams} params
-     * @param {String} snapshotDate
-     * @param range his header specifies the range in bytes of the chunks of the gzip file being returned.
-     *          Format: bytes=startpos-endpos For example, the following retrieves the first 10 MBs of the feed file.
-     */
-    getItemSnapshotFeed(params: BuyFeedParams, snapshotDate: string, range: string): Promise<any>;
-    /**
-     * The Hourly Snapshot feed file is generated each hour every day for all categories.
-     *
-     * @param {BuyFeedParams} params
-     * @param {String} snapshotDate
-     * @param range his header specifies the range in bytes of the chunks of the gzip file being returned.
-     *          Format: bytes=startpos-endpos For example, the following retrieves the first 10 MBs of the feed file.
-     */
-    getProductFeed(params: BuyFeedParams, snapshotDate: string, range: string): Promise<any>;
-}
+import { BuyFeedParams } from '../../../../types/index.js';
+import { operations } from '../../../../types/restful/specs/buy_feed_v1_beta_oas3.js';
+import Restful, { OpenApi } from '../../index.js';
+/**
+ * The Feed API provides the ability to download TSV_GZIP feed files containing eBay items and an hourly snapshot file
+ * of the items that have changed within an hour for a specific category, date and marketplace.
+ */
+export default class Feed extends Restful implements OpenApi<operations> {
+    static id: string;
+    get basePath(): string;
+    /**
+     * This method lets you download a TSV_GZIP (tab separated value gzip) Item feed file.
+     *
+     * @param {BuyFeedParams} params
+     * @param range his header specifies the range in bytes of the chunks of the gzip file being returned.
+     *          Format: bytes=startpos-endpos For example, the following retrieves the first 10 MBs of the feed file.
+     */
+    getItemFeed(params: BuyFeedParams, range: string): Promise<any>;
+    /**
+     * This method lets you download a TSV_GZIP (tab separated value gzip) Item Group feed file.
+     * @param {BuyFeedParams} params
+     * @param range his header specifies the range in bytes of the chunks of the gzip file being returned.
+     *          Format: bytes=startpos-endpos For example, the following retrieves the first 10 MBs of the feed file.
+     */
+    getItemGroupFeed(params: BuyFeedParams, range: string): Promise<any>;
+    /**
+     * The Hourly Snapshot feed file is generated each hour every day for all categories.
+     *
+     * @param {BuyFeedParams} params
+     * @param {String} snapshotDate
+     * @param range his header specifies the range in bytes of the chunks of the gzip file being returned.
+     *          Format: bytes=startpos-endpos For example, the following retrieves the first 10 MBs of the feed file.
+     */
+    getItemSnapshotFeed(params: BuyFeedParams, snapshotDate: string, range: string): Promise<any>;
+    /**
+     * The Hourly Snapshot feed file is generated each hour every day for all categories.
+     *
+     * @param {BuyFeedParams} params
+     * @param {String} snapshotDate
+     * @param range his header specifies the range in bytes of the chunks of the gzip file being returned.
+     *          Format: bytes=startpos-endpos For example, the following retrieves the first 10 MBs of the feed file.
+     */
+    getProductFeed(params: BuyFeedParams, snapshotDate: string, range: string): Promise<any>;
+}

package/dist/api/restful/buy/feed/index.js

@@ -1,78 +1,79 @@
-import Restful from '../../index.js';
-/**
- * The Feed API provides the ability to download TSV_GZIP feed files containing eBay items and an hourly snapshot file
- * of the items that have changed within an hour for a specific category, date and marketplace.
- */
-export default class Feed extends Restful {
-    get basePath() {
-        return '/buy/feed/v1_beta';
-    }
-    /**
-     * This method lets you download a TSV_GZIP (tab separated value gzip) Item feed file.
-     *
-     * @param {BuyFeedParams} params
-     * @param range his header specifies the range in bytes of the chunks of the gzip file being returned.
-     *          Format: bytes=startpos-endpos For example, the following retrieves the first 10 MBs of the feed file.
-     */
-    getItemFeed(params, range) {
-        return this.get(`/item`, {
-            params,
-            headers: {
-                'Range': range
-            }
-        });
-    }
-    /**
-     * This method lets you download a TSV_GZIP (tab separated value gzip) Item Group feed file.
-     * @param {BuyFeedParams} params
-     * @param range his header specifies the range in bytes of the chunks of the gzip file being returned.
-     *          Format: bytes=startpos-endpos For example, the following retrieves the first 10 MBs of the feed file.
-     */
-    getItemGroupFeed(params, range) {
-        return this.get(`/item_group`, {
-            params,
-            headers: {
-                'Range': range
-            }
-        });
-    }
-    /**
-     * The Hourly Snapshot feed file is generated each hour every day for all categories.
-     *
-     * @param {BuyFeedParams} params
-     * @param {String} snapshotDate
-     * @param range his header specifies the range in bytes of the chunks of the gzip file being returned.
-     *          Format: bytes=startpos-endpos For example, the following retrieves the first 10 MBs of the feed file.
-     */
-    getItemSnapshotFeed(params, snapshotDate, range) {
-        return this.get(`/item_snapshot`, {
-            params: {
-                ...params,
-                snapshot_date: snapshotDate
-            },
-            headers: {
-                'Range': range
-            }
-        });
-    }
-    /**
-     * The Hourly Snapshot feed file is generated each hour every day for all categories.
-     *
-     * @param {BuyFeedParams} params
-     * @param {String} snapshotDate
-     * @param range his header specifies the range in bytes of the chunks of the gzip file being returned.
-     *          Format: bytes=startpos-endpos For example, the following retrieves the first 10 MBs of the feed file.
-     */
-    getProductFeed(params, snapshotDate, range) {
-        return this.get(`/product`, {
-            params: {
-                ...params,
-                snapshot_date: snapshotDate
-            },
-            headers: {
-                'Range': range
-            }
-        });
-    }
-}
-Feed.id = 'Feed';
+import Restful from '../../index.js';
+/**
+ * The Feed API provides the ability to download TSV_GZIP feed files containing eBay items and an hourly snapshot file
+ * of the items that have changed within an hour for a specific category, date and marketplace.
+ */
+class Feed extends Restful {
+    get basePath() {
+        return '/buy/feed/v1_beta';
+    }
+    /**
+     * This method lets you download a TSV_GZIP (tab separated value gzip) Item feed file.
+     *
+     * @param {BuyFeedParams} params
+     * @param range his header specifies the range in bytes of the chunks of the gzip file being returned.
+     *          Format: bytes=startpos-endpos For example, the following retrieves the first 10 MBs of the feed file.
+     */
+    getItemFeed(params, range) {
+        return this.get(`/item`, {
+            params,
+            headers: {
+                'Range': range
+            }
+        });
+    }
+    /**
+     * This method lets you download a TSV_GZIP (tab separated value gzip) Item Group feed file.
+     * @param {BuyFeedParams} params
+     * @param range his header specifies the range in bytes of the chunks of the gzip file being returned.
+     *          Format: bytes=startpos-endpos For example, the following retrieves the first 10 MBs of the feed file.
+     */
+    getItemGroupFeed(params, range) {
+        return this.get(`/item_group`, {
+            params,
+            headers: {
+                'Range': range
+            }
+        });
+    }
+    /**
+     * The Hourly Snapshot feed file is generated each hour every day for all categories.
+     *
+     * @param {BuyFeedParams} params
+     * @param {String} snapshotDate
+     * @param range his header specifies the range in bytes of the chunks of the gzip file being returned.
+     *          Format: bytes=startpos-endpos For example, the following retrieves the first 10 MBs of the feed file.
+     */
+    getItemSnapshotFeed(params, snapshotDate, range) {
+        return this.get(`/item_snapshot`, {
+            params: {
+                ...params,
+                snapshot_date: snapshotDate
+            },
+            headers: {
+                'Range': range
+            }
+        });
+    }
+    /**
+     * The Hourly Snapshot feed file is generated each hour every day for all categories.
+     *
+     * @param {BuyFeedParams} params
+     * @param {String} snapshotDate
+     * @param range his header specifies the range in bytes of the chunks of the gzip file being returned.
+     *          Format: bytes=startpos-endpos For example, the following retrieves the first 10 MBs of the feed file.
+     */
+    getProductFeed(params, snapshotDate, range) {
+        return this.get(`/product`, {
+            params: {
+                ...params,
+                snapshot_date: snapshotDate
+            },
+            headers: {
+                'Range': range
+            }
+        });
+    }
+}
+Feed.id = 'Feed';
+export default Feed;

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

@@ -1,17 +1,17 @@
-import Browse from './browse/index.js';
-import Feed from './feed/index.js';
-import Marketing from './marketing/index.js';
-import Offer from './offer/index.js';
-import Order from './order/index.js';
-import Deal from './deal/index.js';
-import MarketplaceInsights from './marketplaceInsights/index.js';
-export type Buy = {
-    browse: Browse;
-    deal: Deal;
-    feed: Feed;
-    marketing: Marketing;
-    marketplaceInsights: MarketplaceInsights;
-    offer: Offer;
-    order: Order;
-};
-export { Browse, Deal, Feed, Marketing, MarketplaceInsights, Offer, Order };
+import Browse from './browse/index.js';
+import Feed from './feed/index.js';
+import Marketing from './marketing/index.js';
+import Offer from './offer/index.js';
+import Order from './order/index.js';
+import Deal from './deal/index.js';
+import MarketplaceInsights from './marketplaceInsights/index.js';
+export type Buy = {
+    browse: Browse;
+    deal: Deal;
+    feed: Feed;
+    marketing: Marketing;
+    marketplaceInsights: MarketplaceInsights;
+    offer: Offer;
+    order: Order;
+};
+export { Browse, Deal, Feed, Marketing, MarketplaceInsights, Offer, Order };

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

@@ -1,8 +1,8 @@
-import Browse from './browse/index.js';
-import Feed from './feed/index.js';
-import Marketing from './marketing/index.js';
-import Offer from './offer/index.js';
-import Order from './order/index.js';
-import Deal from './deal/index.js';
-import MarketplaceInsights from './marketplaceInsights/index.js';
-export { Browse, Deal, Feed, Marketing, MarketplaceInsights, Offer, Order };
+import Browse from './browse/index.js';
+import Feed from './feed/index.js';
+import Marketing from './marketing/index.js';
+import Offer from './offer/index.js';
+import Order from './order/index.js';
+import Deal from './deal/index.js';
+import MarketplaceInsights from './marketplaceInsights/index.js';
+export { Browse, Deal, Feed, Marketing, MarketplaceInsights, Offer, Order };

package/dist/api/restful/buy/marketing/index.d.ts

@@ -1,27 +1,28 @@
-import Restful from '../../index.js';
-import { AlsoBoughtByProductParams, AlsoViewedByProductParams, MerchandisedProductsParams } from '../../../../types/index.js';
-/**
- * The Marketing API retrieves eBay products based on a metric, such as Best Selling, as well as products that were
- * also bought and also viewed.
- */
-export default class Marketing extends Restful {
-    static id: string;
-    get basePath(): string;
-    /**
-     * This call returns products that were also bought when shoppers bought the product specified in the request.
-     * @param params
-     */
-    getAlsoBoughtByProduct(params: AlsoBoughtByProductParams): Promise<any>;
-    /**
-     * This call returns products that were also viewed when shoppers viewed the product specified in the request.
-     *
-     * @param params
-     */
-    getAlsoViewedByProduct(params: AlsoViewedByProductParams): Promise<any>;
-    /**
-     * This call returns an array of products based on the category and metric specified.
-     *
-     * @param params
-     */
-    getMerchandisedProducts(params: MerchandisedProductsParams): Promise<any>;
-}
+import { BuyMarketingGetAlsoBoughtByProductParams, BuyMarketingGetAlsoViewedByProductParams, BuyMarketingGetMerchandisedProductsParams } from '../../../../types/index.js';
+import { operations } from '../../../../types/restful/specs/buy_marketing_v1_beta_oas3.js';
+import Restful, { OpenApi } from '../../index.js';
+/**
+ * The Marketing API retrieves eBay products based on a metric, such as Best Selling, as well as products that were
+ * also bought and also viewed.
+ */
+export default class Marketing extends Restful implements OpenApi<operations> {
+    static id: string;
+    get basePath(): string;
+    /**
+     * This call returns products that were also bought when shoppers bought the product specified in the request.
+     * @param params
+     */
+    getAlsoBoughtByProduct(params: BuyMarketingGetAlsoBoughtByProductParams): Promise<any>;
+    /**
+     * This call returns products that were also viewed when shoppers viewed the product specified in the request.
+     *
+     * @param params
+     */
+    getAlsoViewedByProduct(params: BuyMarketingGetAlsoViewedByProductParams): Promise<any>;
+    /**
+     * This call returns an array of products based on the category and metric specified.
+     *
+     * @param params
+     */
+    getMerchandisedProducts(params: BuyMarketingGetMerchandisedProductsParams): Promise<any>;
+}

package/dist/api/restful/buy/marketing/index.js

@@ -1,44 +1,45 @@
-import Restful from '../../index.js';
-/**
- * The Marketing API retrieves eBay products based on a metric, such as Best Selling, as well as products that were
- * also bought and also viewed.
- */
-export default class Marketing extends Restful {
-    get basePath() {
-        return '/buy/marketing/v1_beta';
-    }
-    //
-    // Marketing
-    // Client Credentials: https://api.ebay.com/oauth/api_scope/buy.marketing
-    //
-    /**
-     * This call returns products that were also bought when shoppers bought the product specified in the request.
-     * @param params
-     */
-    getAlsoBoughtByProduct(params) {
-        return this.get(`/merchandised_product/get_also_bought_products`, {
-            params
-        });
-    }
-    /**
-     * This call returns products that were also viewed when shoppers viewed the product specified in the request.
-     *
-     * @param params
-     */
-    getAlsoViewedByProduct(params) {
-        return this.get(`/merchandised_product/get_also_viewed_products`, {
-            params
-        });
-    }
-    /**
-     * This call returns an array of products based on the category and metric specified.
-     *
-     * @param params
-     */
-    getMerchandisedProducts(params) {
-        return this.get(`/merchandised_product`, {
-            params
-        });
-    }
-}
-Marketing.id = 'Marketing';
+import Restful from '../../index.js';
+/**
+ * The Marketing API retrieves eBay products based on a metric, such as Best Selling, as well as products that were
+ * also bought and also viewed.
+ */
+class Marketing extends Restful {
+    get basePath() {
+        return '/buy/marketing/v1_beta';
+    }
+    //
+    // Marketing
+    // Client Credentials: https://api.ebay.com/oauth/api_scope/buy.marketing
+    //
+    /**
+     * This call returns products that were also bought when shoppers bought the product specified in the request.
+     * @param params
+     */
+    getAlsoBoughtByProduct(params) {
+        return this.get(`/merchandised_product/get_also_bought_products`, {
+            params
+        });
+    }
+    /**
+     * This call returns products that were also viewed when shoppers viewed the product specified in the request.
+     *
+     * @param params
+     */
+    getAlsoViewedByProduct(params) {
+        return this.get(`/merchandised_product/get_also_viewed_products`, {
+            params
+        });
+    }
+    /**
+     * This call returns an array of products based on the category and metric specified.
+     *
+     * @param params
+     */
+    getMerchandisedProducts(params) {
+        return this.get(`/merchandised_product`, {
+            params
+        });
+    }
+}
+Marketing.id = 'Marketing';
+export default Marketing;