ebay-api 8.4.1 → 8.5.0

package/dist/api/index.js

@@ -1,29 +1,29 @@
-import Auth from '../auth/index.js';
-import Base from './base.js';
-import { generateContentDigestValue, generateSignature, generateSignatureInput } from './digitalSignature.js';
-/**
- * Superclass with Auth container.
- */
-export default class Api extends Base {
-    constructor(config, req, auth) {
-        super(config, req);
-        this.auth = auth || new Auth(this.config, this.req);
-    }
-    getDigitalSignatureHeaders(signatureComponents, payload) {
-        if (!this.config.signature) {
-            return {};
-        }
-        const digitalSignatureHeaders = {
-            'x-ebay-enforce-signature': true,
-            'x-ebay-signature-key': this.config.signature.jwe,
-            ...payload ? {
-                'content-digest': generateContentDigestValue(payload, this.config.signature.cipher ?? 'sha256')
-            } : {},
-            'signature-input': generateSignatureInput(payload)
-        };
-        return {
-            ...digitalSignatureHeaders,
-            'signature': generateSignature(digitalSignatureHeaders, this.config.signature.privateKey, signatureComponents, payload)
-        };
-    }
-}
+import Auth from '../auth/index.js';
+import Base from './base.js';
+import { generateContentDigestValue, generateSignature, generateSignatureInput } from './digitalSignature.js';
+/**
+ * Superclass with Auth container.
+ */
+export default class Api extends Base {
+    constructor(config, req, auth) {
+        super(config, req);
+        this.auth = auth || new Auth(this.config, this.req);
+    }
+    getDigitalSignatureHeaders(signatureComponents, payload) {
+        if (!this.config.signature) {
+            return {};
+        }
+        const digitalSignatureHeaders = {
+            'x-ebay-enforce-signature': true,
+            'x-ebay-signature-key': this.config.signature.jwe,
+            ...payload ? {
+                'content-digest': generateContentDigestValue(payload, this.config.signature.cipher ?? 'sha256')
+            } : {},
+            'signature-input': generateSignatureInput(payload)
+        };
+        return {
+            ...digitalSignatureHeaders,
+            'signature': generateSignature(digitalSignatureHeaders, this.config.signature.privateKey, signatureComponents, payload)
+        };
+    }
+}

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

@@ -1,84 +1,84 @@
-import Restful from '../../index.js';
-import { AddCartItemInput, BrowseSearchParams, CompatibilityPayload, ItemsParams, LegacyItemParams, RemoveCartItemInput, SearchByImageParams, UpdateCartItemInput } from '../../../../types/index.js';
-/**
- * The Browse API has the following resources: item_summary: Lets shoppers search for specific items by keyword, GTIN,
- * category, charity, product, or item aspects and refine the results by using filters, such as aspects, compatibility,
- * and fields values.
- */
-export default class Browse extends Restful {
-    static id: string;
-    get basePath(): string;
-    /**
-     * This method searches for eBay items by various query parameters and retrieves summaries of the items.
-     *
-     * @param {BrowseSearchParams} params
-     */
-    search(params: BrowseSearchParams): Promise<any>;
-    /**
-     * This is an Experimental method. This method searches for eBay items based on a image and retrieves summaries of
-     * the items.
-     *
-     * @param {BrowseSearchParams} params
-     * @param {Object} body The container for the image information fields.
-     */
-    searchByImage(params: SearchByImageParams, body?: {}): Promise<any>;
-    /**
-     * This method retrieves the details of specific items that the buyer needs to make a purchasing decision.
-     *
-     * @param itemIds A list of item IDs. Item IDs are the eBay RESTful identifier of items.
-     * @param itemGroupIds A list of item group IDs.
-     */
-    getItems({ itemIds: item_ids, itemGroupIds: item_group_ids }: ItemsParams): Promise<any>;
-    /**
-     * This method retrieves the details of a specific item, such as description, price, category, all item aspects,
-     * condition, return policies, seller feedback and score, shipping options, shipping costs, estimated delivery,
-     * and other information the buyer needs to make a purchasing decision.
-     *
-     * @param {String} itemId The eBay RESTful identifier of an item.
-     * @param {String} fieldgroups
-     */
-    getItem(itemId: string, fieldgroups?: string): Promise<any>;
-    /**
-     * This method is a bridge between the eBay legacy APIs, such as Shopping, and Finding and the eBay Api APIs.
-     *
-     * @param {LegacyItemParams} params
-     */
-    getItemByLegacyId(params: LegacyItemParams): Promise<any>;
-    /**
-     * This method retrieves the details of the individual items in an item group.
-     *
-     * @param itemGroupId
-     */
-    getItemsByItemGroup(itemGroupId: string): Promise<any>;
-    /**
-     * This method checks if a product is compatible with the specified item.
-     * @param {String} itemId The eBay RESTful identifier of an item (such as a part you want to check).
-     * @param {Object} body CompatibilityPayload
-     */
-    checkCompatibility(itemId: string, body?: CompatibilityPayload): Promise<any>;
-    /**
-     * This is an Experimental method. This method creates an eBay cart for the eBay member, if one does not exist, and
-     * adds items to that cart.
-     *
-     * @param {Object} item AddCartItemInput
-     */
-    addItem(item: AddCartItemInput): Promise<any>;
-    /**
-     * This is an experimental method. This method retrieves all the items in the eBay member's cart;
-     * items added to the cart while on ebay.com as well as items added to the cart using the Browse API.
-     */
-    getShoppingCart(): Promise<any>;
-    /**
-     * This is an experimental method. This method removes a specific item from the eBay member's cart.
-     *
-     *  @param {Object} item RemoveCartItemInput
-     */
-    removeItem(item: RemoveCartItemInput): Promise<any>;
-    /**
-     * This is an experimental method. This method updates the quantity value of a specific item in the eBay member's
-     * cart.
-     *
-     * @param {UpdateCartItemInput} item UpdateCartItemInput
-     */
-    updateQuantity(item: UpdateCartItemInput): Promise<any>;
-}
+import { AddCartItemInput, BuyBrowseGetItemsParams, BuyBrowseItemByLegacyIdParams, BuyBrowseSearchByImageParams, BuyBrowseSearchParams, CompatibilityPayload, RemoveCartItemInput, SearchByImageRequest, UpdateCartItemInput } from '../../../../types/index.js';
+import { operations } from '../../../../types/restful/specs/buy_browse_v1_oas3.js';
+import Restful, { OpenApi } from '../../index.js';
+/**
+ * The Browse API has the following resources: item_summary: Lets shoppers search for specific items by keyword, GTIN,
+ * category, charity, product, or item aspects and refine the results by using filters, such as aspects, compatibility,
+ * and fields values.
+ */
+export default class Browse extends Restful implements OpenApi<operations> {
+    static id: string;
+    get basePath(): string;
+    /**
+     * This method searches for eBay items by various query parameters and retrieves summaries of the items.
+     *
+     * @param {BrowseSearchParams} params
+     */
+    search(params: BuyBrowseSearchParams): Promise<any>;
+    /**
+     * This is an Experimental method. This method searches for eBay items based on a image and retrieves summaries of
+     * the items.
+     *
+     * @param {params} params
+     * @param {Object} body The container for the image information fields.
+     */
+    searchByImage(params: BuyBrowseSearchByImageParams, body?: SearchByImageRequest): Promise<any>;
+    /**
+     * This method retrieves the details of specific items that the buyer needs to make a purchasing decision.
+     *
+     * @param {params} params
+     */
+    getItems(params: BuyBrowseGetItemsParams): Promise<any>;
+    /**
+     * This method retrieves the details of a specific item, such as description, price, category, all item aspects,
+     * condition, return policies, seller feedback and score, shipping options, shipping costs, estimated delivery,
+     * and other information the buyer needs to make a purchasing decision.
+     *
+     * @param {String} itemId The eBay RESTful identifier of an item.
+     * @param {String} fieldgroups
+     */
+    getItem(itemId: string, fieldgroups?: string): Promise<any>;
+    /**
+     * This method is a bridge between the eBay legacy APIs, such as Shopping, and Finding and the eBay Api APIs.
+     *
+     * @param {LegacyItemParams} params
+     */
+    getItemByLegacyId(params: BuyBrowseItemByLegacyIdParams): Promise<any>;
+    /**
+     * This method retrieves the details of the individual items in an item group.
+     *
+     * @param itemGroupId
+     */
+    getItemsByItemGroup(itemGroupId: string): Promise<any>;
+    /**
+     * This method checks if a product is compatible with the specified item.
+     * @param {String} itemId The eBay RESTful identifier of an item (such as a part you want to check).
+     * @param {Object} body CompatibilityPayload
+     */
+    checkCompatibility(itemId: string, body?: CompatibilityPayload): Promise<any>;
+    /**
+     * This is an Experimental method. This method creates an eBay cart for the eBay member, if one does not exist, and
+     * adds items to that cart.
+     *
+     * @param {Object} item AddCartItemInput
+     */
+    addItem(item: AddCartItemInput): Promise<any>;
+    /**
+     * This is an experimental method. This method retrieves all the items in the eBay member's cart;
+     * items added to the cart while on ebay.com as well as items added to the cart using the Browse API.
+     */
+    getShoppingCart(): Promise<any>;
+    /**
+     * This is an experimental method. This method removes a specific item from the eBay member's cart.
+     *
+     *  @param {Object} item RemoveCartItemInput
+     */
+    removeItem(item: RemoveCartItemInput): Promise<any>;
+    /**
+     * This is an experimental method. This method updates the quantity value of a specific item in the eBay member's
+     * cart.
+     *
+     * @param {UpdateCartItemInput} item UpdateCartItemInput
+     */
+    updateQuantity(item: UpdateCartItemInput): Promise<any>;
+}

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

@@ -1,135 +1,132 @@
-import Restful from '../../index.js';
-/**
- * The Browse API has the following resources: item_summary: Lets shoppers search for specific items by keyword, GTIN,
- * category, charity, product, or item aspects and refine the results by using filters, such as aspects, compatibility,
- * and fields values.
- */
-export default class Browse extends Restful {
-    get basePath() {
-        return '/buy/browse/v1';
-    }
-    //
-    // Item
-    // Client Credentials: https://api.ebay.com/oauth/api_scope
-    //
-    /**
-     * This method searches for eBay items by various query parameters and retrieves summaries of the items.
-     *
-     * @param {BrowseSearchParams} params
-     */
-    search(params) {
-        return this.get(`/item_summary/search`, {
-            params
-        });
-    }
-    /**
-     * This is an Experimental method. This method searches for eBay items based on a image and retrieves summaries of
-     * the items.
-     *
-     * @param {BrowseSearchParams} params
-     * @param {Object} body The container for the image information fields.
-     */
-    searchByImage(params, body = {}) {
-        return this.post(`/item_summary/search_by_image`, body, {
-            params
-        });
-    }
-    /**
-     * This method retrieves the details of specific items that the buyer needs to make a purchasing decision.
-     *
-     * @param itemIds A list of item IDs. Item IDs are the eBay RESTful identifier of items.
-     * @param itemGroupIds A list of item group IDs.
-     */
-    getItems({ itemIds: item_ids, itemGroupIds: item_group_ids }) {
-        return this.get(`/item/`, {
-            params: {
-                item_ids,
-                item_group_ids
-            }
-        });
-    }
-    /**
-     * This method retrieves the details of a specific item, such as description, price, category, all item aspects,
-     * condition, return policies, seller feedback and score, shipping options, shipping costs, estimated delivery,
-     * and other information the buyer needs to make a purchasing decision.
-     *
-     * @param {String} itemId The eBay RESTful identifier of an item.
-     * @param {String} fieldgroups
-     */
-    getItem(itemId, fieldgroups) {
-        const id = encodeURIComponent(itemId);
-        return this.get(`/item/${id}`, {
-            params: {
-                fieldgroups
-            }
-        });
-    }
-    /**
-     * This method is a bridge between the eBay legacy APIs, such as Shopping, and Finding and the eBay Api APIs.
-     *
-     * @param {LegacyItemParams} params
-     */
-    getItemByLegacyId(params) {
-        return this.get(`/item/get_item_by_legacy_id`, {
-            params
-        });
-    }
-    /**
-     * This method retrieves the details of the individual items in an item group.
-     *
-     * @param itemGroupId
-     */
-    getItemsByItemGroup(itemGroupId) {
-        return this.get(`/item/get_items_by_item_group`, {
-            params: {
-                item_group_id: itemGroupId
-            }
-        });
-    }
-    /**
-     * This method checks if a product is compatible with the specified item.
-     * @param {String} itemId The eBay RESTful identifier of an item (such as a part you want to check).
-     * @param {Object} body CompatibilityPayload
-     */
-    checkCompatibility(itemId, body) {
-        const id = encodeURIComponent(itemId);
-        return this.post(`/item/${id}/check_compatibility`, body);
-    }
-    //
-    // Shopping Cart
-    //
-    /**
-     * This is an Experimental method. This method creates an eBay cart for the eBay member, if one does not exist, and
-     * adds items to that cart.
-     *
-     * @param {Object} item AddCartItemInput
-     */
-    addItem(item) {
-        return this.post(`/shopping_cart/add_item`, item);
-    }
-    /**
-     * This is an experimental method. This method retrieves all the items in the eBay member's cart;
-     * items added to the cart while on ebay.com as well as items added to the cart using the Browse API.
-     */
-    getShoppingCart() {
-        return this.get(`/shopping_cart/`);
-    }
-    /**
-     * This is an experimental method. This method removes a specific item from the eBay member's cart.
-     *
-     *  @param {Object} item RemoveCartItemInput
-     */
-    removeItem(item) {
-        return this.post(`/shopping_cart/remove_item`, item);
-    }
-    /**
-     * This is an experimental method. This method updates the quantity value of a specific item in the eBay member's
-     * cart.
-     *
-     * @param {UpdateCartItemInput} item UpdateCartItemInput
-     */
-    updateQuantity(item) {
-        return this.post(`/shopping_cart/update_quantity`, item);
-    }
-}
-Browse.id = 'Browse';
+import Restful from '../../index.js';
+/**
+ * The Browse API has the following resources: item_summary: Lets shoppers search for specific items by keyword, GTIN,
+ * category, charity, product, or item aspects and refine the results by using filters, such as aspects, compatibility,
+ * and fields values.
+ */
+class Browse extends Restful {
+    get basePath() {
+        return '/buy/browse/v1';
+    }
+    //
+    // Item
+    // Client Credentials: https://api.ebay.com/oauth/api_scope
+    //
+    /**
+     * This method searches for eBay items by various query parameters and retrieves summaries of the items.
+     *
+     * @param {BrowseSearchParams} params
+     */
+    search(params) {
+        return this.get(`/item_summary/search`, {
+            params
+        });
+    }
+    /**
+     * This is an Experimental method. This method searches for eBay items based on a image and retrieves summaries of
+     * the items.
+     *
+     * @param {params} params
+     * @param {Object} body The container for the image information fields.
+     */
+    searchByImage(params, body) {
+        return this.post(`/item_summary/search_by_image`, body, {
+            params
+        });
+    }
+    /**
+     * This method retrieves the details of specific items that the buyer needs to make a purchasing decision.
+     *
+     * @param {params} params
+     */
+    getItems(params) {
+        return this.get(`/item/`, {
+            params
+        });
+    }
+    /**
+     * This method retrieves the details of a specific item, such as description, price, category, all item aspects,
+     * condition, return policies, seller feedback and score, shipping options, shipping costs, estimated delivery,
+     * and other information the buyer needs to make a purchasing decision.
+     *
+     * @param {String} itemId The eBay RESTful identifier of an item.
+     * @param {String} fieldgroups
+     */
+    getItem(itemId, fieldgroups) {
+        const id = encodeURIComponent(itemId);
+        return this.get(`/item/${id}`, {
+            params: {
+                fieldgroups
+            }
+        });
+    }
+    /**
+     * This method is a bridge between the eBay legacy APIs, such as Shopping, and Finding and the eBay Api APIs.
+     *
+     * @param {LegacyItemParams} params
+     */
+    getItemByLegacyId(params) {
+        return this.get(`/item/get_item_by_legacy_id`, {
+            params
+        });
+    }
+    /**
+     * This method retrieves the details of the individual items in an item group.
+     *
+     * @param itemGroupId
+     */
+    getItemsByItemGroup(itemGroupId) {
+        return this.get(`/item/get_items_by_item_group`, {
+            params: {
+                item_group_id: itemGroupId
+            }
+        });
+    }
+    /**
+     * This method checks if a product is compatible with the specified item.
+     * @param {String} itemId The eBay RESTful identifier of an item (such as a part you want to check).
+     * @param {Object} body CompatibilityPayload
+     */
+    checkCompatibility(itemId, body) {
+        const id = encodeURIComponent(itemId);
+        return this.post(`/item/${id}/check_compatibility`, body);
+    }
+    //
+    // Shopping Cart
+    //
+    /**
+     * This is an Experimental method. This method creates an eBay cart for the eBay member, if one does not exist, and
+     * adds items to that cart.
+     *
+     * @param {Object} item AddCartItemInput
+     */
+    addItem(item) {
+        return this.post(`/shopping_cart/add_item`, item);
+    }
+    /**
+     * This is an experimental method. This method retrieves all the items in the eBay member's cart;
+     * items added to the cart while on ebay.com as well as items added to the cart using the Browse API.
+     */
+    getShoppingCart() {
+        return this.get(`/shopping_cart/`);
+    }
+    /**
+     * This is an experimental method. This method removes a specific item from the eBay member's cart.
+     *
+     *  @param {Object} item RemoveCartItemInput
+     */
+    removeItem(item) {
+        return this.post(`/shopping_cart/remove_item`, item);
+    }
+    /**
+     * This is an experimental method. This method updates the quantity value of a specific item in the eBay member's
+     * cart.
+     *
+     * @param {UpdateCartItemInput} item UpdateCartItemInput
+     */
+    updateQuantity(item) {
+        return this.post(`/shopping_cart/update_quantity`, item);
+    }
+}
+Browse.id = 'Browse';
+export default Browse;

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

@@ -1,55 +1,56 @@
-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 {
-    static id: string;
-    get basePath(): string;
-    /**
-     * 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 }: {
-        categoryIds?: string;
-        commissionable?: string;
-        deliveryCountry?: string;
-        limit?: string;
-        offset?: string;
-    }): Promise<any>;
-    /**
-     * This method retrieves the details for an eBay event.
-     *
-     * @param eventId The unique identifier for the eBay event.
-     */
-    getEvent(eventId: string): Promise<any>;
-    /**
-     * 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 }: {
-        limit?: string;
-        offset?: string;
-    }): Promise<any>;
-    /**
-     * 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: string, { categoryIds, deliveryCountry, limit, offset }?: {
-        categoryIds?: string;
-        deliveryCountry?: string;
-        limit?: string;
-        offset?: string;
-    }): Promise<any>;
-}
+import { operations } from '../../../../types/restful/specs/buy_deal_v1_oas3.js';
+import Restful, { OpenApi } 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 implements OpenApi<operations> {
+    static id: string;
+    get basePath(): string;
+    /**
+     * 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 }: {
+        categoryIds?: string;
+        commissionable?: string;
+        deliveryCountry?: string;
+        limit?: string;
+        offset?: string;
+    }): Promise<any>;
+    /**
+     * This method retrieves the details for an eBay event.
+     *
+     * @param eventId The unique identifier for the eBay event.
+     */
+    getEvent(eventId: string): Promise<any>;
+    /**
+     * 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 }: {
+        limit?: string;
+        offset?: string;
+    }): Promise<any>;
+    /**
+     * 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: string, { categoryIds, deliveryCountry, limit, offset }?: {
+        categoryIds?: string;
+        deliveryCountry?: string;
+        limit?: string;
+        offset?: string;
+    }): Promise<any>;
+}