ebay-api 8.4.1 → 8.5.1

package/lib/api/restful/sell/metadata/index.d.ts

@@ -1,77 +1,78 @@
-import Restful from '../../index.js';
-/**
- * The Metadata API has operations that retrieve configuration details pertaining to the different eBay marketplaces.
- */
-export default class Metadata extends Restful {
-    static id: string;
-    get basePath(): string;
-    /**
-     * This method retrieves all the sales tax jurisdictions for the country that you specify in the countryCode path
-     * parameter.
-     *
-     * @param countryCode This path parameter specifies the two-letter ISO 3166-1 Alpha-2 country code for the country
-     *     whose jurisdictions you want to retrieve.
-     */
-    getSalesTaxJurisdictions(countryCode: string): Promise<any>;
-    /**
-     * This method returns the eBay policies that define how to list automotive-parts-compatibility items in the
-     * categories of a specific marketplace.
-     *
-     * @param marketplaceId This path parameter specifies the eBay marketplace for which policy information is
-     *     retrieved.
-     * @param filter This query parameter limits the response by returning eBay policy information for only the leaf
-     *     categories specified by this parameter.
-     */
-    getAutomotivePartsCompatibilityPolicies(marketplaceId: string, filter?: string): Promise<any>;
-    /**
-     * This method returns the eBay policies that define how to specify item conditions in the categories of a specific
-     * marketplace.
-     *
-     * @param marketplaceId This path parameter specifies the eBay marketplace for which policy information is
-     *     retrieved.
-     * @param filter This query parameter limits the response by returning eBay policy information for only the leaf
-     *     categories specified by this parameter.
-     */
-    getItemConditionPolicies(marketplaceId: string, filter?: string): Promise<any>;
-    /**
-     * This method returns the eBay policies that define the allowed listing structures for the categories of a
-     * specific marketplace.
-     *
-     * @param marketplaceId This path parameter specifies the eBay marketplace for which policy information is
-     *     retrieved.
-     * @param filter This query parameter limits the response by returning eBay policy information for only the leaf
-     *     categories specified by this parameter.
-     */
-    getListingStructurePolicies(marketplaceId: string, filter?: string): Promise<any>;
-    /**
-     * This method returns the eBay policies that define the supported negotiated price features (like &quot;best
-     * offer&quot;) for the categories of a specific marketplace.
-     *
-     * @param marketplaceId This path parameter specifies the eBay marketplace for which policy information is
-     *     retrieved.
-     * @param filter This query parameter limits the response by returning eBay policy information for only the leaf
-     *     categories specified by this parameter.
-     */
-    getNegotiatedPricePolicies(marketplaceId: string, filter?: string): Promise<any>;
-    /**
-     * This method retrieves a list of leaf categories for a marketplace and identifies the categories that require
-     * items to have an eBay product ID value in order to be listed in those categories.
-     *
-     * @param marketplaceId This path parameter specifies the eBay marketplace for which policy information is
-     *     retrieved.
-     * @param filter This query parameter limits the response by returning eBay policy information for only the leaf
-     *     categories specified by this parameter.
-     */
-    getProductAdoptionPolicies(marketplaceId: string, filter?: string): Promise<any>;
-    /**
-     * This method returns the eBay policies that define whether or not you must include a return policy for the
-     * items you list in the categories of a specific marketplace, plus the guidelines for creating domestic and
-     * international return policies in the different eBay categories.
-     *
-     * @param marketplaceId This path parameter specifies the eBay marketplace for which policy information is
-     *     retrieved.
-     * @param filter This query parameter limits the response by returning eBay policy information for only the leaf
-     *     categories specified by this parameter.
-     */
-    getReturnPolicies(marketplaceId: string, filter?: string): Promise<any>;
-}
+import { operations } from '../../../../types/restful/specs/sell_metadata_v1_oas3.js';
+import Restful, { OpenApi } from '../../index.js';
+/**
+ * The Metadata API has operations that retrieve configuration details pertaining to the different eBay marketplaces.
+ */
+export default class Metadata extends Restful implements OpenApi<operations> {
+    static id: string;
+    get basePath(): string;
+    /**
+     * This method retrieves all the sales tax jurisdictions for the country that you specify in the countryCode path
+     * parameter.
+     *
+     * @param countryCode This path parameter specifies the two-letter ISO 3166-1 Alpha-2 country code for the country
+     *     whose jurisdictions you want to retrieve.
+     */
+    getSalesTaxJurisdictions(countryCode: string): Promise<any>;
+    /**
+     * This method returns the eBay policies that define how to list automotive-parts-compatibility items in the
+     * categories of a specific marketplace.
+     *
+     * @param marketplaceId This path parameter specifies the eBay marketplace for which policy information is
+     *     retrieved.
+     * @param filter This query parameter limits the response by returning eBay policy information for only the leaf
+     *     categories specified by this parameter.
+     */
+    getAutomotivePartsCompatibilityPolicies(marketplaceId: string, filter?: string): Promise<any>;
+    /**
+     * This method returns the eBay policies that define how to specify item conditions in the categories of a specific
+     * marketplace.
+     *
+     * @param marketplaceId This path parameter specifies the eBay marketplace for which policy information is
+     *     retrieved.
+     * @param filter This query parameter limits the response by returning eBay policy information for only the leaf
+     *     categories specified by this parameter.
+     */
+    getItemConditionPolicies(marketplaceId: string, filter?: string): Promise<any>;
+    /**
+     * This method returns the eBay policies that define the allowed listing structures for the categories of a
+     * specific marketplace.
+     *
+     * @param marketplaceId This path parameter specifies the eBay marketplace for which policy information is
+     *     retrieved.
+     * @param filter This query parameter limits the response by returning eBay policy information for only the leaf
+     *     categories specified by this parameter.
+     */
+    getListingStructurePolicies(marketplaceId: string, filter?: string): Promise<any>;
+    /**
+     * This method returns the eBay policies that define the supported negotiated price features (like &quot;best
+     * offer&quot;) for the categories of a specific marketplace.
+     *
+     * @param marketplaceId This path parameter specifies the eBay marketplace for which policy information is
+     *     retrieved.
+     * @param filter This query parameter limits the response by returning eBay policy information for only the leaf
+     *     categories specified by this parameter.
+     */
+    getNegotiatedPricePolicies(marketplaceId: string, filter?: string): Promise<any>;
+    /**
+     * This method retrieves a list of leaf categories for a marketplace and identifies the categories that require
+     * items to have an eBay product ID value in order to be listed in those categories.
+     *
+     * @param marketplaceId This path parameter specifies the eBay marketplace for which policy information is
+     *     retrieved.
+     * @param filter This query parameter limits the response by returning eBay policy information for only the leaf
+     *     categories specified by this parameter.
+     */
+    getProductAdoptionPolicies(marketplaceId: string, filter?: string): Promise<any>;
+    /**
+     * This method returns the eBay policies that define whether or not you must include a return policy for the
+     * items you list in the categories of a specific marketplace, plus the guidelines for creating domestic and
+     * international return policies in the different eBay categories.
+     *
+     * @param marketplaceId This path parameter specifies the eBay marketplace for which policy information is
+     *     retrieved.
+     * @param filter This query parameter limits the response by returning eBay policy information for only the leaf
+     *     categories specified by this parameter.
+     */
+    getReturnPolicies(marketplaceId: string, filter?: string): Promise<any>;
+}

package/lib/api/restful/sell/metadata/index.js

@@ -1,130 +1,130 @@
-"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 Metadata API has operations that retrieve configuration details pertaining to the different eBay marketplaces.
- */
-class Metadata extends index_js_1.default {
-    get basePath() {
-        return '/sell/metadata/v1';
-    }
-    /**
-     * This method retrieves all the sales tax jurisdictions for the country that you specify in the countryCode path
-     * parameter.
-     *
-     * @param countryCode This path parameter specifies the two-letter ISO 3166-1 Alpha-2 country code for the country
-     *     whose jurisdictions you want to retrieve.
-     */
-    getSalesTaxJurisdictions(countryCode) {
-        countryCode = encodeURIComponent(countryCode);
-        return this.get(`/country/${countryCode}/sales_tax_jurisdiction`);
-    }
-    /**
-     * This method returns the eBay policies that define how to list automotive-parts-compatibility items in the
-     * categories of a specific marketplace.
-     *
-     * @param marketplaceId This path parameter specifies the eBay marketplace for which policy information is
-     *     retrieved.
-     * @param filter This query parameter limits the response by returning eBay policy information for only the leaf
-     *     categories specified by this parameter.
-     */
-    getAutomotivePartsCompatibilityPolicies(marketplaceId, filter) {
-        marketplaceId = encodeURIComponent(marketplaceId);
-        return this.get(`/marketplace/${marketplaceId}/get_automotive_parts_compatibility_policies`, {
-            params: {
-                filter
-            }
-        });
-    }
-    /**
-     * This method returns the eBay policies that define how to specify item conditions in the categories of a specific
-     * marketplace.
-     *
-     * @param marketplaceId This path parameter specifies the eBay marketplace for which policy information is
-     *     retrieved.
-     * @param filter This query parameter limits the response by returning eBay policy information for only the leaf
-     *     categories specified by this parameter.
-     */
-    getItemConditionPolicies(marketplaceId, filter) {
-        marketplaceId = encodeURIComponent(marketplaceId);
-        return this.get(`/marketplace/${marketplaceId}/get_item_condition_policies`, {
-            params: {
-                filter
-            }
-        });
-    }
-    /**
-     * This method returns the eBay policies that define the allowed listing structures for the categories of a
-     * specific marketplace.
-     *
-     * @param marketplaceId This path parameter specifies the eBay marketplace for which policy information is
-     *     retrieved.
-     * @param filter This query parameter limits the response by returning eBay policy information for only the leaf
-     *     categories specified by this parameter.
-     */
-    getListingStructurePolicies(marketplaceId, filter) {
-        marketplaceId = encodeURIComponent(marketplaceId);
-        return this.get(`/marketplace/${marketplaceId}/get_listing_structure_policies`, {
-            params: {
-                filter
-            }
-        });
-    }
-    /**
-     * This method returns the eBay policies that define the supported negotiated price features (like "best
-     * offer") for the categories of a specific marketplace.
-     *
-     * @param marketplaceId This path parameter specifies the eBay marketplace for which policy information is
-     *     retrieved.
-     * @param filter This query parameter limits the response by returning eBay policy information for only the leaf
-     *     categories specified by this parameter.
-     */
-    getNegotiatedPricePolicies(marketplaceId, filter) {
-        marketplaceId = encodeURIComponent(marketplaceId);
-        return this.get(`/marketplace/${marketplaceId}/get_negotiated_price_policies`, {
-            params: {
-                filter
-            }
-        });
-    }
-    /**
-     * This method retrieves a list of leaf categories for a marketplace and identifies the categories that require
-     * items to have an eBay product ID value in order to be listed in those categories.
-     *
-     * @param marketplaceId This path parameter specifies the eBay marketplace for which policy information is
-     *     retrieved.
-     * @param filter This query parameter limits the response by returning eBay policy information for only the leaf
-     *     categories specified by this parameter.
-     */
-    getProductAdoptionPolicies(marketplaceId, filter) {
-        marketplaceId = encodeURIComponent(marketplaceId);
-        return this.get(`/marketplace/${marketplaceId}/get_product_adoption_policies`, {
-            params: {
-                filter
-            }
-        });
-    }
-    /**
-     * This method returns the eBay policies that define whether or not you must include a return policy for the
-     * items you list in the categories of a specific marketplace, plus the guidelines for creating domestic and
-     * international return policies in the different eBay categories.
-     *
-     * @param marketplaceId This path parameter specifies the eBay marketplace for which policy information is
-     *     retrieved.
-     * @param filter This query parameter limits the response by returning eBay policy information for only the leaf
-     *     categories specified by this parameter.
-     */
-    getReturnPolicies(marketplaceId, filter) {
-        marketplaceId = encodeURIComponent(marketplaceId);
-        return this.get(`/marketplace/${marketplaceId}/get_return_policies`, {
-            params: {
-                filter
-            }
-        });
-    }
-}
-exports.default = Metadata;
-Metadata.id = 'Metadata';
+"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 Metadata API has operations that retrieve configuration details pertaining to the different eBay marketplaces.
+ */
+class Metadata extends index_js_1.default {
+    get basePath() {
+        return '/sell/metadata/v1';
+    }
+    /**
+     * This method retrieves all the sales tax jurisdictions for the country that you specify in the countryCode path
+     * parameter.
+     *
+     * @param countryCode This path parameter specifies the two-letter ISO 3166-1 Alpha-2 country code for the country
+     *     whose jurisdictions you want to retrieve.
+     */
+    getSalesTaxJurisdictions(countryCode) {
+        countryCode = encodeURIComponent(countryCode);
+        return this.get(`/country/${countryCode}/sales_tax_jurisdiction`);
+    }
+    /**
+     * This method returns the eBay policies that define how to list automotive-parts-compatibility items in the
+     * categories of a specific marketplace.
+     *
+     * @param marketplaceId This path parameter specifies the eBay marketplace for which policy information is
+     *     retrieved.
+     * @param filter This query parameter limits the response by returning eBay policy information for only the leaf
+     *     categories specified by this parameter.
+     */
+    getAutomotivePartsCompatibilityPolicies(marketplaceId, filter) {
+        marketplaceId = encodeURIComponent(marketplaceId);
+        return this.get(`/marketplace/${marketplaceId}/get_automotive_parts_compatibility_policies`, {
+            params: {
+                filter
+            }
+        });
+    }
+    /**
+     * This method returns the eBay policies that define how to specify item conditions in the categories of a specific
+     * marketplace.
+     *
+     * @param marketplaceId This path parameter specifies the eBay marketplace for which policy information is
+     *     retrieved.
+     * @param filter This query parameter limits the response by returning eBay policy information for only the leaf
+     *     categories specified by this parameter.
+     */
+    getItemConditionPolicies(marketplaceId, filter) {
+        marketplaceId = encodeURIComponent(marketplaceId);
+        return this.get(`/marketplace/${marketplaceId}/get_item_condition_policies`, {
+            params: {
+                filter
+            }
+        });
+    }
+    /**
+     * This method returns the eBay policies that define the allowed listing structures for the categories of a
+     * specific marketplace.
+     *
+     * @param marketplaceId This path parameter specifies the eBay marketplace for which policy information is
+     *     retrieved.
+     * @param filter This query parameter limits the response by returning eBay policy information for only the leaf
+     *     categories specified by this parameter.
+     */
+    getListingStructurePolicies(marketplaceId, filter) {
+        marketplaceId = encodeURIComponent(marketplaceId);
+        return this.get(`/marketplace/${marketplaceId}/get_listing_structure_policies`, {
+            params: {
+                filter
+            }
+        });
+    }
+    /**
+     * This method returns the eBay policies that define the supported negotiated price features (like "best
+     * offer") for the categories of a specific marketplace.
+     *
+     * @param marketplaceId This path parameter specifies the eBay marketplace for which policy information is
+     *     retrieved.
+     * @param filter This query parameter limits the response by returning eBay policy information for only the leaf
+     *     categories specified by this parameter.
+     */
+    getNegotiatedPricePolicies(marketplaceId, filter) {
+        marketplaceId = encodeURIComponent(marketplaceId);
+        return this.get(`/marketplace/${marketplaceId}/get_negotiated_price_policies`, {
+            params: {
+                filter
+            }
+        });
+    }
+    /**
+     * This method retrieves a list of leaf categories for a marketplace and identifies the categories that require
+     * items to have an eBay product ID value in order to be listed in those categories.
+     *
+     * @param marketplaceId This path parameter specifies the eBay marketplace for which policy information is
+     *     retrieved.
+     * @param filter This query parameter limits the response by returning eBay policy information for only the leaf
+     *     categories specified by this parameter.
+     */
+    getProductAdoptionPolicies(marketplaceId, filter) {
+        marketplaceId = encodeURIComponent(marketplaceId);
+        return this.get(`/marketplace/${marketplaceId}/get_product_adoption_policies`, {
+            params: {
+                filter
+            }
+        });
+    }
+    /**
+     * This method returns the eBay policies that define whether or not you must include a return policy for the
+     * items you list in the categories of a specific marketplace, plus the guidelines for creating domestic and
+     * international return policies in the different eBay categories.
+     *
+     * @param marketplaceId This path parameter specifies the eBay marketplace for which policy information is
+     *     retrieved.
+     * @param filter This query parameter limits the response by returning eBay policy information for only the leaf
+     *     categories specified by this parameter.
+     */
+    getReturnPolicies(marketplaceId, filter) {
+        marketplaceId = encodeURIComponent(marketplaceId);
+        return this.get(`/marketplace/${marketplaceId}/get_return_policies`, {
+            params: {
+                filter
+            }
+        });
+    }
+}
+Metadata.id = 'Metadata';
+exports.default = Metadata;

package/lib/api/restful/sell/negotiation/index.d.ts

@@ -1,24 +1,25 @@
-import Restful from '../../index.js';
-/**
- * The <b>Negotiations API</b> gives sellers the ability to proactively send discount offers to buyers who have shown an "interest" in their listings.
- */
-export default class Negotiation extends Restful {
-    static id: string;
-    get basePath(): string;
-    /**
-     * This method evaluates a seller's current listings and returns the set of IDs that are eligible for a seller-initiated discount offer to a buyer.
-     *
-     * @param limit This query parameter specifies the maximum number of items to return from the result set on a page in the paginated response.
-     * @param offset This query parameter specifies the number of results to skip in the result set before returning the first result in the paginated response.
-     */
-    findEligibleItems({ limit, offset }?: {
-        limit?: string;
-        offset?: string;
-    }): Promise<any>;
-    /**
-     * This method sends eligible buyers offers to purchase items in a listing at a discount.
-     *
-     * @param data The CreateOffersRequest
-     */
-    sendOfferToInterestedBuyers(data: any): Promise<any>;
-}
+import { operations } from '../../../../types/restful/specs/sell_negotiation_v1_oas3.js';
+import Restful, { OpenApi } from '../../index.js';
+/**
+ * The <b>Negotiations API</b> gives sellers the ability to proactively send discount offers to buyers who have shown an "interest" in their listings.
+ */
+export default class Negotiation extends Restful implements OpenApi<operations> {
+    static id: string;
+    get basePath(): string;
+    /**
+     * This method evaluates a seller's current listings and returns the set of IDs that are eligible for a seller-initiated discount offer to a buyer.
+     *
+     * @param limit This query parameter specifies the maximum number of items to return from the result set on a page in the paginated response.
+     * @param offset This query parameter specifies the number of results to skip in the result set before returning the first result in the paginated response.
+     */
+    findEligibleItems({ limit, offset }?: {
+        limit?: string;
+        offset?: string;
+    }): Promise<any>;
+    /**
+     * This method sends eligible buyers offers to purchase items in a listing at a discount.
+     *
+     * @param data The CreateOffersRequest
+     */
+    sendOfferToInterestedBuyers(data: any): Promise<any>;
+}

package/lib/api/restful/sell/negotiation/index.js

@@ -1,38 +1,38 @@
-"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 <b>Negotiations API</b> gives sellers the ability to proactively send discount offers to buyers who have shown an "interest" in their listings.
- */
-class Negotiation extends index_js_1.default {
-    get basePath() {
-        return '/sell/negotiation/v1';
-    }
-    /**
-     * This method evaluates a seller's current listings and returns the set of IDs that are eligible for a seller-initiated discount offer to a buyer.
-     *
-     * @param limit This query parameter specifies the maximum number of items to return from the result set on a page in the paginated response.
-     * @param offset This query parameter specifies the number of results to skip in the result set before returning the first result in the paginated response.
-     */
-    findEligibleItems({ limit, offset } = {}) {
-        return this.get(`/find_eligible_items`, {
-            params: {
-                limit,
-                offset
-            }
-        });
-    }
-    /**
-     * This method sends eligible buyers offers to purchase items in a listing at a discount.
-     *
-     * @param data The CreateOffersRequest
-     */
-    sendOfferToInterestedBuyers(data) {
-        return this.post(`/send_offer_to_interested_buyers`, data);
-    }
-}
-exports.default = Negotiation;
-Negotiation.id = 'Negotiation';
+"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 <b>Negotiations API</b> gives sellers the ability to proactively send discount offers to buyers who have shown an "interest" in their listings.
+ */
+class Negotiation extends index_js_1.default {
+    get basePath() {
+        return '/sell/negotiation/v1';
+    }
+    /**
+     * This method evaluates a seller's current listings and returns the set of IDs that are eligible for a seller-initiated discount offer to a buyer.
+     *
+     * @param limit This query parameter specifies the maximum number of items to return from the result set on a page in the paginated response.
+     * @param offset This query parameter specifies the number of results to skip in the result set before returning the first result in the paginated response.
+     */
+    findEligibleItems({ limit, offset } = {}) {
+        return this.get(`/find_eligible_items`, {
+            params: {
+                limit,
+                offset
+            }
+        });
+    }
+    /**
+     * This method sends eligible buyers offers to purchase items in a listing at a discount.
+     *
+     * @param data The CreateOffersRequest
+     */
+    sendOfferToInterestedBuyers(data) {
+        return this.post(`/send_offer_to_interested_buyers`, data);
+    }
+}
+Negotiation.id = 'Negotiation';
+exports.default = Negotiation;

package/lib/api/restful/sell/recommendation/index.d.ts

@@ -1,26 +1,27 @@
-import Restful from '../../index.js';
-import { FindListingRecommendationRequest } from '../../../../types/index.js';
-/**
- * The <b>Recommendation API</b> returns information that sellers can use to optimize the configuration of their
- * listings on eBay.
- */
-export default class Recommendation extends Restful {
-    static id: string;
-    get basePath(): string;
-    /**
-     * The find method returns recommendations and information that sellers can use to optimize their listing
-     * configurations.
-     *
-     * @param filter Provide a list of key-value pairs to specify the criteria you want to use to filter the response.
-     * @param limit Use this query parameter to set the maximum number of ads to return on a page from the paginated
-     *     response. Default: 10 Maximum: 500
-     * @param offset Specifies the number of ads to skip in the result set before returning the first ad in the
-     *     paginated response.
-     * @param body FindListingRecommendationRequest
-     */
-    findListingRecommendations({ filter, limit, offset }?: {
-        filter?: string;
-        limit?: number;
-        offset?: number;
-    }, body?: FindListingRecommendationRequest): Promise<any>;
-}
+import { FindListingRecommendationRequest } from '../../../../types/index.js';
+import { operations } from '../../../../types/restful/specs/sell_recommendation_v1_oas3.js';
+import Restful, { OpenApi } from '../../index.js';
+/**
+ * The <b>Recommendation API</b> returns information that sellers can use to optimize the configuration of their
+ * listings on eBay.
+ */
+export default class Recommendation extends Restful implements OpenApi<operations> {
+    static id: string;
+    get basePath(): string;
+    /**
+     * The find method returns recommendations and information that sellers can use to optimize their listing
+     * configurations.
+     *
+     * @param filter Provide a list of key-value pairs to specify the criteria you want to use to filter the response.
+     * @param limit Use this query parameter to set the maximum number of ads to return on a page from the paginated
+     *     response. Default: 10 Maximum: 500
+     * @param offset Specifies the number of ads to skip in the result set before returning the first ad in the
+     *     paginated response.
+     * @param body FindListingRecommendationRequest
+     */
+    findListingRecommendations({ filter, limit, offset }?: {
+        filter?: string;
+        limit?: number;
+        offset?: number;
+    }, body?: FindListingRecommendationRequest): Promise<any>;
+}