ebay-api 8.4.0 → 8.5.0

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;

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

@@ -1,28 +1,29 @@
-import Restful from '../../index.js';
-import { MarketingInsightsSearchParams } from '../../../../types/index.js';
-/**
- * (Limited Release) The Marketplace Insights API provides the ability to search for sold items on eBay by keyword,
- * GTIN, category, and product and returns the of sales history of those items.
- */
-export default class MarketplaceInsights extends Restful {
-    static id: string;
-    get basePath(): string;
-    /**
-     * (Limited Release) This method searches for sold eBay items by various URI query parameters and retrieves the sales
-     * history of the items for the last 90 days. You can search by keyword, category, eBay product ID (ePID), or GTIN,
-     * or a combination of these.
-     *
-     * @param itemId
-     * @param aspectFilter This field lets you filter by item aspects.
-     * @param categoryIds The category ID is required and is used to limit the results.
-     * @param epid The ePID is the eBay product identifier of a product from the eBay product catalog.
-     * @param fieldgroups This field lets you control what is to be returned in the response and accepts a comma separated list of values.
-     * @param filter This field supports multiple field filters that can be used to limit/customize the result set.
-     * @param gtin This field lets you search by the Global Trade Item Number of the item as defined by https://www.gtin.info.
-     * @param limit The number of items, from the result set, returned in a single page.
-     * @param offset Specifies the number of items to skip in the result set.
-     * @param q A string consisting of one or more keywords that are used to search for items on eBay.
-     * @param sort This field specifies the order and the field name to use to sort the items.
-     */
-    search({ aspectFilter, categoryIds, epid, fieldgroups, filter, gtin, limit, offset, q, sort, }: MarketingInsightsSearchParams): Promise<any>;
-}
+import { MarketingInsightsSearchParams } from '../../../../types/index.js';
+import { operations } from '../../../../types/restful/specs/buy_marketplace_insights_v1_beta_oas3.js';
+import Restful, { OpenApi } from '../../index.js';
+/**
+ * (Limited Release) The Marketplace Insights API provides the ability to search for sold items on eBay by keyword,
+ * GTIN, category, and product and returns the of sales history of those items.
+ */
+export default class MarketplaceInsights extends Restful implements OpenApi<operations> {
+    static id: string;
+    get basePath(): string;
+    /**
+     * (Limited Release) This method searches for sold eBay items by various URI query parameters and retrieves the sales
+     * history of the items for the last 90 days. You can search by keyword, category, eBay product ID (ePID), or GTIN,
+     * or a combination of these.
+     *
+     * @param itemId
+     * @param aspectFilter This field lets you filter by item aspects.
+     * @param categoryIds The category ID is required and is used to limit the results.
+     * @param epid The ePID is the eBay product identifier of a product from the eBay product catalog.
+     * @param fieldgroups This field lets you control what is to be returned in the response and accepts a comma separated list of values.
+     * @param filter This field supports multiple field filters that can be used to limit/customize the result set.
+     * @param gtin This field lets you search by the Global Trade Item Number of the item as defined by https://www.gtin.info.
+     * @param limit The number of items, from the result set, returned in a single page.
+     * @param offset Specifies the number of items to skip in the result set.
+     * @param q A string consisting of one or more keywords that are used to search for items on eBay.
+     * @param sort This field specifies the order and the field name to use to sort the items.
+     */
+    search({ aspectFilter, categoryIds, epid, fieldgroups, filter, gtin, limit, offset, q, sort, }: MarketingInsightsSearchParams): Promise<any>;
+}

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

@@ -1,44 +1,45 @@
-import Restful from '../../index.js';
-/**
- * (Limited Release) The Marketplace Insights API provides the ability to search for sold items on eBay by keyword,
- * GTIN, category, and product and returns the of sales history of those items.
- */
-export default class MarketplaceInsights extends Restful {
-    get basePath() {
-        return '/buy/marketplace_insights/v1_beta';
-    }
-    /**
-     * (Limited Release) This method searches for sold eBay items by various URI query parameters and retrieves the sales
-     * history of the items for the last 90 days. You can search by keyword, category, eBay product ID (ePID), or GTIN,
-     * or a combination of these.
-     *
-     * @param itemId
-     * @param aspectFilter This field lets you filter by item aspects.
-     * @param categoryIds The category ID is required and is used to limit the results.
-     * @param epid The ePID is the eBay product identifier of a product from the eBay product catalog.
-     * @param fieldgroups This field lets you control what is to be returned in the response and accepts a comma separated list of values.
-     * @param filter This field supports multiple field filters that can be used to limit/customize the result set.
-     * @param gtin This field lets you search by the Global Trade Item Number of the item as defined by https://www.gtin.info.
-     * @param limit The number of items, from the result set, returned in a single page.
-     * @param offset Specifies the number of items to skip in the result set.
-     * @param q A string consisting of one or more keywords that are used to search for items on eBay.
-     * @param sort This field specifies the order and the field name to use to sort the items.
-     */
-    search({ aspectFilter, categoryIds, epid, fieldgroups, filter, gtin, limit, offset, q, sort, }) {
-        return this.get(`/item_sales/search`, {
-            params: {
-                aspect_filter: aspectFilter,
-                category_ids: categoryIds,
-                epid,
-                fieldgroups,
-                filter,
-                gtin,
-                limit,
-                offset,
-                q,
-                sort,
-            }
-        });
-    }
-}
-MarketplaceInsights.id = 'MarketplaceInsights';
+import Restful from '../../index.js';
+/**
+ * (Limited Release) The Marketplace Insights API provides the ability to search for sold items on eBay by keyword,
+ * GTIN, category, and product and returns the of sales history of those items.
+ */
+class MarketplaceInsights extends Restful {
+    get basePath() {
+        return '/buy/marketplace_insights/v1_beta';
+    }
+    /**
+     * (Limited Release) This method searches for sold eBay items by various URI query parameters and retrieves the sales
+     * history of the items for the last 90 days. You can search by keyword, category, eBay product ID (ePID), or GTIN,
+     * or a combination of these.
+     *
+     * @param itemId
+     * @param aspectFilter This field lets you filter by item aspects.
+     * @param categoryIds The category ID is required and is used to limit the results.
+     * @param epid The ePID is the eBay product identifier of a product from the eBay product catalog.
+     * @param fieldgroups This field lets you control what is to be returned in the response and accepts a comma separated list of values.
+     * @param filter This field supports multiple field filters that can be used to limit/customize the result set.
+     * @param gtin This field lets you search by the Global Trade Item Number of the item as defined by https://www.gtin.info.
+     * @param limit The number of items, from the result set, returned in a single page.
+     * @param offset Specifies the number of items to skip in the result set.
+     * @param q A string consisting of one or more keywords that are used to search for items on eBay.
+     * @param sort This field specifies the order and the field name to use to sort the items.
+     */
+    search({ aspectFilter, categoryIds, epid, fieldgroups, filter, gtin, limit, offset, q, sort, }) {
+        return this.get(`/item_sales/search`, {
+            params: {
+                aspect_filter: aspectFilter,
+                category_ids: categoryIds,
+                epid,
+                fieldgroups,
+                filter,
+                gtin,
+                limit,
+                offset,
+                q,
+                sort,
+            }
+        });
+    }
+}
+MarketplaceInsights.id = 'MarketplaceInsights';
+export default MarketplaceInsights;

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

@@ -1,23 +1,24 @@
-import Restful from '../../index.js';
-import { PlaceProxyBidRequest } from '../../../../types/index.js';
-/**
- * The Api Offer API enables Partners to place proxy bids for a buyer and retrieve the auctions where the buyer is
- * bidding. Client Credentials: https://api.ebay.com/oauth/api_scope/buy.offer.auction
- */
-export default class Offer extends Restful {
-    static id: string;
-    get basePath(): string;
-    /**
-     * This method retrieves the bidding details that are specific to the buyer of the specified auction.
-     *
-     * @param itemId
-     */
-    getBidding(itemId: string): Promise<any>;
-    /**
-     * This method uses a user access token to place a proxy bid for the buyer on a specific auction item.
-     *
-     * @param itemId
-     * @param {PlaceProxyBidRequest} body
-     */
-    placeProxyBid(itemId: string, body?: PlaceProxyBidRequest): Promise<any>;
-}
+import { PlaceProxyBidRequest } from '../../../../types/index.js';
+import { operations } from '../../../../types/restful/specs/buy_offer_v1_beta_oas3.js';
+import Restful, { OpenApi } from '../../index.js';
+/**
+ * The Api Offer API enables Partners to place proxy bids for a buyer and retrieve the auctions where the buyer is
+ * bidding. Client Credentials: https://api.ebay.com/oauth/api_scope/buy.offer.auction
+ */
+export default class Offer extends Restful implements OpenApi<operations> {
+    static id: string;
+    get basePath(): string;
+    /**
+     * This method retrieves the bidding details that are specific to the buyer of the specified auction.
+     *
+     * @param itemId
+     */
+    getBidding(itemId: string): Promise<any>;
+    /**
+     * This method uses a user access token to place a proxy bid for the buyer on a specific auction item.
+     *
+     * @param itemId
+     * @param {PlaceProxyBidRequest} body
+     */
+    placeProxyBid(itemId: string, body?: PlaceProxyBidRequest): Promise<any>;
+}

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

@@ -1,30 +1,31 @@
-import Restful from '../../index.js';
-/**
- * The Api Offer API enables Partners to place proxy bids for a buyer and retrieve the auctions where the buyer is
- * bidding. Client Credentials: https://api.ebay.com/oauth/api_scope/buy.offer.auction
- */
-export default class Offer extends Restful {
-    get basePath() {
-        return '/buy/offer/v1_beta';
-    }
-    /**
-     * This method retrieves the bidding details that are specific to the buyer of the specified auction.
-     *
-     * @param itemId
-     */
-    getBidding(itemId) {
-        const id = encodeURIComponent(itemId);
-        return this.get(`/bidding/${id}`);
-    }
-    /**
-     * This method uses a user access token to place a proxy bid for the buyer on a specific auction item.
-     *
-     * @param itemId
-     * @param {PlaceProxyBidRequest} body
-     */
-    placeProxyBid(itemId, body) {
-        const id = encodeURIComponent(itemId);
-        return this.post(`/bidding/${id}/place_proxy_bid`, body);
-    }
-}
-Offer.id = 'Offer';
+import Restful from '../../index.js';
+/**
+ * The Api Offer API enables Partners to place proxy bids for a buyer and retrieve the auctions where the buyer is
+ * bidding. Client Credentials: https://api.ebay.com/oauth/api_scope/buy.offer.auction
+ */
+class Offer extends Restful {
+    get basePath() {
+        return '/buy/offer/v1_beta';
+    }
+    /**
+     * This method retrieves the bidding details that are specific to the buyer of the specified auction.
+     *
+     * @param itemId
+     */
+    getBidding(itemId) {
+        const id = encodeURIComponent(itemId);
+        return this.get(`/bidding/${id}`);
+    }
+    /**
+     * This method uses a user access token to place a proxy bid for the buyer on a specific auction item.
+     *
+     * @param itemId
+     * @param {PlaceProxyBidRequest} body
+     */
+    placeProxyBid(itemId, body) {
+        const id = encodeURIComponent(itemId);
+        return this.post(`/bidding/${id}/place_proxy_bid`, body);
+    }
+}
+Offer.id = 'Offer';
+export default Offer;