ebay-api 8.5.1 → 8.6.0

package/lib/types/restful/specs/buy_feed_v1_beta_oas3.js

@@ -1,6 +1,2 @@
 "use strict";
-/**
- * This file was auto-generated by openapi-typescript.
- * Do not make direct changes to the file.
- */
 Object.defineProperty(exports, "__esModule", { value: true });

package/lib/types/restful/specs/buy_marketing_v1_beta_oas3.d.ts

@@ -1,142 +1,69 @@
-/**
- * This file was auto-generated by openapi-typescript.
- * Do not make direct changes to the file.
- */
 export interface paths {
     "/merchandised_product/get_also_bought_products": {
-        /** @description This call returns products that were also bought when shoppers bought the product specified in the request. Showing 'also bought' products inspires up-selling and cross-selling. You specify the product by one of the following: epid - eBay Product ID gtin - Global Trade Item Number (UPC, ISBN, EAN) brand (brand name, such as Nike) plus mpn (Manufacturer's Part Number) Restrictions For a list of supported sites and other restrictions, see API Restrictions. Note: A maximum of 12 products are returned. The call will return up to 12 products, but it can be less than 12. If the number of products found is less than 12, the call will return all of the products matching the criteria. */
         get: operations["getAlsoBoughtByProduct"];
     };
     "/merchandised_product/get_also_viewed_products": {
-        /** @description This call returns products that were also viewed when shoppers viewed the product specified in the request. Showing 'also viewed' products encourages up-selling and cross-selling. You specify the product by one of the following: epid - eBay Product ID gtin - Global Trade Item Number (UPC, ISBN, EAN) brand (brand name, such as Nike) plus mpn (Manufacturer's Part Number) Restrictions For a list of supported sites and other restrictions, see API Restrictions. Note: A maximum of 12 products are returned. The call will return up to 12 products, but it can be less than 12. If the number of products found is less than 12, the call will return all of the products matching the criteria. */
         get: operations["getAlsoViewedByProduct"];
     };
     "/merchandised_product": {
-        /** @description This call returns an array of products based on the category and metric specified. This includes details of the product, such as the eBay product ID (EPID), title, and user reviews and ratings for the product. You can use the epid returned by this call in the Browse API search call to retrieve items for this product. Restrictions For a list of supported sites and other restrictions, see API Restrictions. */
         get: operations["getMerchandisedProducts"];
     };
 }
 export type webhooks = Record<string, never>;
 export interface components {
     schemas: {
-        /** @description The type that defines the fields that can be returned in an error. */
         Error: {
-            /** @description This string value indicates the error category. There are three categories of errors: request errors, application errors, and system errors. */
             category?: string;
-            /** @description The name of the primary system where the error occurred. This is relevant for application errors. */
             domain?: string;
-            /**
-             * Format: int32
-             * @description A unique code that identifies the particular error or warning that occurred. Your application can use error codes as identifiers in your customized error-handling algorithms.
-             */
             errorId?: number;
-            /** @description An array of reference IDs that identify the specific request elements most closely associated to the error or warning, if any. */
             inputRefIds?: (string)[];
-            /** @description A detailed description of the condition that caused the error or warning, and information on what to do to correct the problem. */
             longMessage?: string;
-            /** @description A description of the condition that caused the error or warning. */
             message?: string;
-            /** @description An array of reference IDs that identify the specific response elements most closely associated to the error or warning, if any. */
             outputRefIds?: (string)[];
-            /** @description An array of warning and error messages that return one or more variables contextual information about the error or warning. This is often the field or value that triggered the error or warning. */
             parameters?: (components["schemas"]["ErrorParameter"])[];
-            /** @description The name of the subdomain in which the error or warning occurred. */
             subdomain?: string;
         };
-        /** @description An array of name/value pairs that provide more details regarding error condition. */
         ErrorParameter: {
-            /** @description This is the name of input field that caused an issue with the call request. */
             name?: string;
-            /** @description This is the actual value that was passed in for the element specified in the name field. */
             value?: string;
         };
-        /** @description This type defines the monetary value of an amount and the currency used. */
         Amount: {
-            /** @description A three-letter ISO 4217 code that indicates the currency of the amount in the value field. For implementation help, refer to <a href='https://developer.ebay.com/devzone/rest/api-ref/marketing/types/CurrencyCodeEnum.html'>eBay API documentation</a> */
             currency?: string;
-            /** @description The monetary amount, in the currency specified by the currency field. */
             value?: string;
         };
-        /** @description The type that defines the fields for the best selling product information. */
         BestSellingProductResponse: {
-            /** @description An array of containers for the products. */
             merchandisedProducts?: (components["schemas"]["MerchandisedProduct"])[];
-            /** @description The container with all the warnings for the input request. */
             warnings?: (components["schemas"]["Error"])[];
         };
-        /** @description Type the defines the details of an image, such as size and URL. Currently only imageUrl is getting populated. The height and width were added for future use. */
         Image: {
-            /**
-             * Format: int32
-             * @description Reserved for future use.
-             */
             height?: number;
-            /** @description The URL of the image. */
             imageUrl?: string;
-            /**
-             * Format: int32
-             * @description Reserved for future use.
-             */
             width?: number;
         };
-        /** @description The type that defines the fields for details about the product, such as condition and estimated start price. */
         MarketPriceDetail: {
-            /** @description The name for the condition of the product. For example: NEW */
             conditionGroup?: string;
-            /** @description An array of condition identifiers for the product. */
             conditionIds?: (string)[];
-            /** @description The lowest priced active item for this product on eBay. */
             estimatedStartPrice?: components["schemas"]["Amount"];
         };
-        /** @description The type that defines the fields for product information, including price, condition, ratings, etc. */
         MerchandisedProduct: {
-            /** @description The average rating for the product based on eBay user ratings. */
             averageRating?: string;
-            /** @description The eBay product identifier of a product from the eBay product catalog. You can use this value in the Browse API search call to retrieve items for this product. */
             epid?: string;
-            /** @description The container for the product image. */
             image?: components["schemas"]["Image"];
-            /** @description An array of containers for the product market price details, such as condition and market price. */
             marketPriceDetails?: (components["schemas"]["MarketPriceDetail"])[];
-            /** @description An array of containers for ratings of the product aspects, such as &quot;Is it a good value&quot;. */
             ratingAspects?: (components["schemas"]["RatingAspect"])[];
-            /**
-             * Format: int32
-             * @description The total number of eBay users that rated the product.
-             */
             ratingCount?: number;
-            /**
-             * Format: int32
-             * @description The total number of eBay users that wrote a review for the product.
-             */
             reviewCount?: number;
-            /** @description The title of the product. */
             title?: string;
         };
-        /** @description The type that defines the fields for the product aspect ratings. */
         RatingAspect: {
-            /**
-             * Format: int32
-             * @description The number of eBay users that rated the product on this aspect.
-             */
             count?: number;
-            /** @description The name of the rating aspect. Camping tent examples: Is it lightweight? or Is it easy to set up? */
             description?: string;
-            /** @description The answer or value of the rating aspect. Camping tent examples: Lightweight or Easy to set up */
             name?: string;
-            /** @description The container for the details of the aspect rating. The details show the aspect rating value, usually TRUE or FALSE and the user count and percentage. */
             ratingAspectDistributions?: (components["schemas"]["RatingAspectDistribution"])[];
         };
-        /** @description The type that defines the field for the aspect rating details, such as the aspect rating value, usually TRUE or FALSE and the user count and percentage. */
         RatingAspectDistribution: {
-            /**
-             * Format: int32
-             * @description The number of eBay users that choose this rating aspect value.
-             */
             count?: number;
-            /** @description The percentage of the aspect rating value. ratingAspectDistributions.percentage = ratingAspectDistributions.count / ratingAspects.count */
             percentage?: string;
-            /** @description The rating aspect. For example: TRUE or FALSE */
             value?: string;
         };
     };
@@ -148,30 +75,22 @@ export interface components {
 }
 export type external = Record<string, never>;
 export interface operations {
-    /** @description This call returns products that were also bought when shoppers bought the product specified in the request. Showing 'also bought' products inspires up-selling and cross-selling. You specify the product by one of the following: epid - eBay Product ID gtin - Global Trade Item Number (UPC, ISBN, EAN) brand (brand name, such as Nike) plus mpn (Manufacturer's Part Number) Restrictions For a list of supported sites and other restrictions, see API Restrictions. Note: A maximum of 12 products are returned. The call will return up to 12 products, but it can be less than 12. If the number of products found is less than 12, the call will return all of the products matching the criteria. */
     getAlsoBoughtByProduct: {
         parameters: {
             query?: {
-                /** @description The brand of the product. Restriction: This must be used along with mpn. Required: You must specify one epid, or one gtin, or one brand plus mpn pair. */
                 brand?: string;
-                /** @description The eBay product identifier of a product. Required: You must specify one epid, or one gtin, or one brand plus mpn pair. */
                 epid?: string;
-                /** @description The unique Global Trade Item Number of the item as defined by http://www.gtin.info. This can be a UPC (Universal Product Code), EAN (European Article Number), or an ISBN (International Standard Book Number value. Required: You must specify one epid, or one gtin, or one brand plus mpn pair. */
                 gtin?: string;
-                /** @description The manufacturer part number of the product. Restriction: This must be used along with brand. Required: You must specify one epid, or one gtin, or one brand plus mpn pair. */
                 mpn?: string;
             };
         };
         responses: {
-            /** @description This call returns products that were also bought when shoppers bought the product specified in the request. Showing 'also bought' products inspires up-selling and cross-selling. You specify the product by one of the following: epid - eBay Product ID gtin - Global Trade Item Number (UPC, ISBN, EAN) brand (brand name, such as Nike) plus mpn (Manufacturer's Part Number) Restrictions For a list of supported sites and other restrictions, see API Restrictions. Note: A maximum of 12 products are returned. The call will return up to 12 products, but it can be less than 12. If the number of products found is less than 12, the call will return all of the products matching the criteria. */
             200: {
                 content: {
                     "application/json": components["schemas"]["BestSellingProductResponse"];
                 };
             };
-            /** @description No Content */
             204: never;
-            /** @description Bad Request */
             400: {
                 content: {
                     "application/json": {
@@ -179,7 +98,6 @@ export interface operations {
                     };
                 };
             };
-            /** @description Conflict */
             409: {
                 content: {
                     "application/json": {
@@ -187,7 +105,6 @@ export interface operations {
                     };
                 };
             };
-            /** @description Internal Server Error */
             500: {
                 content: {
                     "application/json": {
@@ -197,30 +114,22 @@ export interface operations {
             };
         };
     };
-    /** @description This call returns products that were also viewed when shoppers viewed the product specified in the request. Showing 'also viewed' products encourages up-selling and cross-selling. You specify the product by one of the following: epid - eBay Product ID gtin - Global Trade Item Number (UPC, ISBN, EAN) brand (brand name, such as Nike) plus mpn (Manufacturer's Part Number) Restrictions For a list of supported sites and other restrictions, see API Restrictions. Note: A maximum of 12 products are returned. The call will return up to 12 products, but it can be less than 12. If the number of products found is less than 12, the call will return all of the products matching the criteria. */
     getAlsoViewedByProduct: {
         parameters: {
             query?: {
-                /** @description The brand of the product. Restriction: This must be used along with mpn. Required: You must specify one epid, or one gtin, or one brand plus mpn pair. */
                 brand?: string;
-                /** @description The eBay product identifier of a product. Required: You must specify one epid, or one gtin, or one brand plus mpn pair. */
                 epid?: string;
-                /** @description The unique Global Trade Item Number of the item as defined by http://www.gtin.info. This can be a UPC (Universal Product Code), EAN (European Article Number), or an ISBN (International Standard Book Number value. Required: You must specify one epid, or one gtin, or one brand plus mpn pair. */
                 gtin?: string;
-                /** @description The manufacturer part number of the product. Restriction: This must be used along with brand. */
                 mpn?: string;
             };
         };
         responses: {
-            /** @description This call returns products that were also viewed when shoppers viewed the product specified in the request. Showing 'also viewed' products encourages up-selling and cross-selling. You specify the product by one of the following: epid - eBay Product ID gtin - Global Trade Item Number (UPC, ISBN, EAN) brand (brand name, such as Nike) plus mpn (Manufacturer's Part Number) Restrictions For a list of supported sites and other restrictions, see API Restrictions. Note: A maximum of 12 products are returned. The call will return up to 12 products, but it can be less than 12. If the number of products found is less than 12, the call will return all of the products matching the criteria. */
             200: {
                 content: {
                     "application/json": components["schemas"]["BestSellingProductResponse"];
                 };
             };
-            /** @description No Content */
             204: never;
-            /** @description Bad Request */
             400: {
                 content: {
                     "application/json": {
@@ -228,7 +137,6 @@ export interface operations {
                     };
                 };
             };
-            /** @description Conflict */
             409: {
                 content: {
                     "application/json": {
@@ -236,7 +144,6 @@ export interface operations {
                     };
                 };
             };
-            /** @description Internal Server Error */
             500: {
                 content: {
                     "application/json": {
@@ -246,28 +153,21 @@ export interface operations {
             };
         };
     };
-    /** @description This call returns an array of products based on the category and metric specified. This includes details of the product, such as the eBay product ID (EPID), title, and user reviews and ratings for the product. You can use the epid returned by this call in the Browse API search call to retrieve items for this product. Restrictions For a list of supported sites and other restrictions, see API Restrictions. */
     getMerchandisedProducts: {
         parameters: {
             query: {
-                /** @description The aspect name/value pairs used to further refine product results. For example: &nbsp;&nbsp;&nbsp;/buy/marketing/v1_beta/merchandised_product?category_id=31388&amp;metric_name=BEST_SELLING&amp;aspect_filter=Brand:Canon You can use the Browse API search call with the fieldgroups=ASPECT_REFINEMENTS field to return the aspects of a product. For implementation help, refer to eBay API documentation at https://developer.ebay.com/devzone/rest/api-ref/marketing/types/MarketingAspectFilter.html */
                 aspect_filter?: string;
-                /** @description This query parameter limits the products returned to a specific eBay category. The list of eBay category IDs is not published and category IDs are not all the same across all the eBay maketplace. You can use the following techniques to find a category by site: Use the Category Changes page. Use the Taxonomy API. For details see Get Categories for Buy APIs. Use the Browse API and submit the following call to get the dominantCategoryId for an item. /buy/browse/v1/item_summary/search?q=keyword&amp;fieldgroups=ASPECT_REFINEMENTS Maximum: 1 Required: 1 */
                 category_id: string;
-                /** @description This value specifies the maximum number of products to return in a result set. Note: Maximum value means the call will return up to that many products per set, but it can be less than this value. If the number of products found is less than this value, the call will return all of the products matching the criteria. Default: 8 Maximum: 100 */
                 limit?: string;
-                /** @description This value filters the result set by the specified metric. Only products in this metric are returned. Currently, the only metric supported is BEST_SELLING. Default: BEST_SELLING Maximum: 1 Required: 1 */
                 metric_name: string;
             };
         };
         responses: {
-            /** @description This call returns an array of products based on the category and metric specified. This includes details of the product, such as the eBay product ID (EPID), title, and user reviews and ratings for the product. You can use the epid returned by this call in the Browse API search call to retrieve items for this product. Restrictions For a list of supported sites and other restrictions, see API Restrictions. */
             200: {
                 content: {
                     "application/json": components["schemas"]["BestSellingProductResponse"];
                 };
             };
-            /** @description Bad Request */
             400: {
                 content: {
                     "application/json": {
@@ -275,7 +175,6 @@ export interface operations {
                     };
                 };
             };
-            /** @description Internal Server Error */
             500: {
                 content: {
                     "application/json": {

package/lib/types/restful/specs/buy_marketing_v1_beta_oas3.js

@@ -1,6 +1,2 @@
 "use strict";
-/**
- * This file was auto-generated by openapi-typescript.
- * Do not make direct changes to the file.
- */
 Object.defineProperty(exports, "__esModule", { value: true });

package/lib/types/restful/specs/buy_marketplace_insights_v1_beta_oas3.d.ts

@@ -1,254 +1,119 @@
-/**
- * This file was auto-generated by openapi-typescript.
- * Do not make direct changes to the file.
- */
 export interface paths {
     "/item_sales/search": {
-        /** @description (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. This method also supports the following: Filtering by the value of one or multiple fields, such as listing format, item condition, price range, location, and more. For the fields supported by this method, see the filter parameter. Retrieving the refinements (metadata) of an item , such as item aspects (color, brand), condition, category, etc. using the fieldgroups parameter. Filtering by item aspects and other refinements using the aspect_filter parameter. Creating aspects histograms, which enables shoppers to drill down in each refinement narrowing the search results. For details and examples of these capabilities, see Browse API in the Buying Integration Guide. Pagination and sort controls There are pagination controls (limit and offset fields) and sort query parameters that control/sort the data that is returned. By default, the results are sorted by "Best Match". For more information about Best Match, see the eBay help page Best Match. URLs for this method Production URL: https://api.ebay.com/buy/marketplace_insights/v1_beta/item_sales/ Sandbox URL: https://api.sandbox.ebay.com/buy/marketplace_insights/v1_beta/item_sales/ Request headers You will want to use the X-EBAY-C-ENDUSERCTX request header with this method. If you are an eBay Network Partner you must use affiliateCampaignId=ePNCampaignId,affiliateReferenceId=referenceId in the header in order to be paid for selling eBay items on your site . For details see, Request headers in the Buy APIs Overview. URL Encoding for Parameters Query parameter values need to be URL encoded. For details, see URL encoding query parameter values. Restrictions For a list of supported sites and other restrictions, see API Restrictions. */
         get: operations["search"];
     };
 }
 export type webhooks = Record<string, never>;
 export interface components {
     schemas: {
-        /** @description The type that define the fields for the aspect information. Aspects are the variations of an item, such as color, size, etc. */
         AspectDistribution: {
-            /** @description An array of containers for the various values of the aspect and the match count and a HATEOAS reference ( refinementHref) for this aspect. */
             aspectValueDistributions?: (components["schemas"]["AspectValueDistribution"])[];
-            /** @description Name of an aspect, such as Brand, Color, etc. */
             localizedAspectName?: string;
         };
-        /** @description The container that defines the fields for the conditions refinements. This container is returned when fieldgroups is set to ASPECT_REFINEMENTS or FULL in the request. */
         AspectValueDistribution: {
-            /** @description The value of an aspect. For example, Red is a value for the aspect Color. */
             localizedAspectValue?: string;
-            /**
-             * Format: int32
-             * @description The number of items with this aspect.
-             */
             matchCount?: number;
-            /** @description A HATEOAS reference for this aspect. */
             refinementHref?: string;
         };
-        /** @description The container that defines the fields for the buying options refinements. This container is returned when fieldgroups is set to BUYING_OPTION_REFINEMENTS or FULL in the request. */
         BuyingOptionDistribution: {
             buyingOption?: string;
-            /**
-             * Format: int32
-             * @description The number of items having this buying option.
-             */
             matchCount?: number;
-            /** @description The HATEOAS reference for this buying option. */
             refinementHref?: string;
         };
-        /** @description This type is used by the categories container in the response of the search method, and contains the primary item category ID of the item, as well as the secondary item category if the item was listed in two categories. */
         Category: {
-            /** @description The unique identifier of the primary item category of the item, as well as the secondary item category if item was listed in two categories. */
             categoryId?: string;
         };
-        /** @description The container that defines the fields for the category refinements. This container is returned when fieldgroups is set to CATEGORY_REFINEMENTS or FULL in the request. */
         CategoryDistribution: {
-            /** @description The identifier of the category. */
             categoryId?: string;
-            /** @description The name of the category, such as Baby &amp; Toddler Clothing. */
             categoryName?: string;
-            /**
-             * Format: int32
-             * @description The number of items in this category.
-             */
             matchCount?: number;
-            /** @description The HATEOAS reference of this category. */
             refinementHref?: string;
         };
-        /** @description The container that defines the fields for the conditions refinements. This container is returned when fieldgroups is set to CONDITION_REFINEMENTS or FULL in the request. */
         ConditionDistribution: {
-            /** @description The text describing the condition of the item, such as New or Used. For a list of condition names, see ConditionEnum. Code so that your app gracefully handles any future changes to this list. */
             condition?: string;
-            /** @description The identifier of the condition. For example, 1000 is the identifier for NEW. */
             conditionId?: string;
-            /**
-             * Format: int32
-             * @description The number of items having the condition.
-             */
             matchCount?: number;
-            /** @description The HATEOAS reference of this condition. */
             refinementHref?: string;
         };
         ConvertedAmount: {
-            /** @description A three-letter ISO 4217 code that indicates the currency of the amount in the convertedFromValue field. This value represents the pre-conversion currency. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/buy/marketplace_insights/types/ba:CurrencyCodeEnum'>eBay API documentation</a> */
             convertedFromCurrency?: string;
-            /** @description The monetary amount before any conversion is performed, in the currency specified by the convertedFromCurrency field. The value field contains the converted amount of this value, in the currency specified by the currency field. */
             convertedFromValue?: string;
-            /** @description A three-letter ISO 4217 code that indicates the currency of the amount in the value field. This value represents the post-conversion currency of the amount in the value field. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/buy/marketplace_insights/types/ba:CurrencyCodeEnum'>eBay API documentation</a> */
             currency?: string;
-            /** @description The monetary value in the currency specified in the currency field. */
             value?: string;
         };
-        /** @description This type defines the fields that can be returned in an error. */
         Error: {
-            /** @description Identifies the type of erro. */
             category?: string;
-            /** @description Name for the primary system where the error occurred. This is relevant for application errors. */
             domain?: string;
-            /**
-             * Format: int32
-             * @description A unique number to identify the error.
-             */
             errorId?: number;
-            /** @description An array of request elements most closely associated to the error. */
             inputRefIds?: (string)[];
-            /** @description A more detailed explanation of the error. */
             longMessage?: string;
-            /** @description Information on how to correct the problem, in the end user's terms and language where applicable. */
             message?: string;
-            /** @description An array of request elements most closely associated to the error. */
             outputRefIds?: (string)[];
-            /** @description An array of name/value pairs that describe details the error condition. These are useful when multiple errors are returned. */
             parameters?: (components["schemas"]["ErrorParameter"])[];
-            /** @description Further helps indicate which subsystem the error is coming from. System subcategories include: Initialization, Serialization, Security, Monitoring, Rate Limiting, etc. */
             subdomain?: string;
         };
         ErrorParameter: {
-            /** @description The object of the error. */
             name?: string;
-            /** @description The value of the object. */
             value?: string;
         };
-        /** @description Type the defines the details of an image, such as size and image URL. Currently only imageUrl is populated. The height and width were added for future use. */
         Image: {
-            /**
-             * Format: int32
-             * @description Reserved for future use.
-             */
             height?: number;
-            /** @description The URL of the image. */
             imageUrl?: string;
-            /**
-             * Format: int32
-             * @description Reserved for future use.
-             */
             width?: number;
         };
-        /** @description The type that defines the fields for the locaton of an item, including postal code, county, state/province, street address, city, and country (2-digit ISO code). */
         ItemLocation: {
-            /** @description The first line of the street address. */
             addressLine1?: string;
-            /** @description The second line of the street address. This field may contain such values as an apartment or suite number. */
             addressLine2?: string;
-            /** @description The city in which the item is located. */
             city?: string;
-            /** @description The two-letter ISO 3166 standard code that indicates the country in which the item is located. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/buy/marketplace_insights/types/ba:CountryCodeEnum'>eBay API documentation</a> */
             country?: string;
-            /** @description The county in which the item is located. */
             county?: string;
-            /** @description The postal code (or zip code in US) where the item is located. Note: Beginning in late January 2020, the displayed postal code will be masked to all users. Different countries will mask postal/zip codes in slightly different ways, but an example would be 951**. */
             postalCode?: string;
-            /** @description The state or province in which the item is located. */
             stateOrProvince?: string;
         };
-        /** @description This type defines the fields for the sold items sales history information. */
         ItemSales: {
-            /** @description An array of containers with the URLs for the images that are in addition to the primary image. The primary image is returned in the image.imageUrl field. */
             additionalImages?: (components["schemas"]["Image"])[];
-            /** @description This indicates if the item is for adults only. For more information about adult-only items on eBay, see Adult items policy for sellers and Adult-Only items on eBay for buyers. */
             adultOnly?: boolean;
-            /**
-             * Format: int32
-             * @description This integer value indicates the total number of bids that have been placed for an auction item. This field is only returned for auction items.
-             */
             bidCount?: number;
-            /** @description A comma separated list of the purchase options available for the item, such as FIXED_PRICE, AUCTION. FIXED_PRICE - Returned for fixed-price items (non-auction) AUCTION - Returned for auction items without Buy It Now feature FIXED_PRICE and AUCTION - Returned for auction items enabled with the Buy It Now feature Code so that your app gracefully handles any future changes to this list. */
             buyingOptions?: (string)[];
-            /** @description This container returns the primary category ID of the item, as well as the secondary category if the item was listed in two categories. */
             categories?: (components["schemas"]["Category"])[];
-            /** @description The text describing the condition of the item, such as New or Used. For a list of condition names, see Item Condition IDs and Names. Code so that your app gracefully handles any future changes to this list. */
             condition?: string;
-            /** @description The identifier of the condition of the item. For example, 1000 is the identifier for NEW. For a list of condition names and IDs, see Item Condition IDs and Names. Code so that your app gracefully handles any future changes to this list. */
             conditionId?: string;
-            /** @description An ePID is the eBay product identifier of a product from the eBay product catalog. This indicates the product in which the item belongs. */
             epid?: string;
-            /** @description The URL to the primary image of the item. */
             image?: components["schemas"]["Image"];
-            /** @description The URL to the View Item page of the item, which includes the affiliate tracking ID. This field is only returned if the eBay partner enables affiliate tracking for the item by including the X-EBAY-C-ENDUSERCTX request header in the method. */
             itemAffiliateWebUrl?: string;
-            /** @description The HATEOAS reference of the parent page of the item group. An item group is an item that has various aspect differences, such as color, size, storage capacity, etc. Note: This field is returned only for item groups. */
             itemGroupHref?: string;
-            /** @description Indicates the item group type. An item group is an item that has various aspect differences, such as color, size, storage capacity, etc. Currently, only the SELLER_DEFINED_VARIATIONS group type is supported and indicates that this is an item group created by the seller. Note: This field is returned only for item groups. Code so that your app gracefully handles any future changes to this list. */
             itemGroupType?: string;
-            /** @description The URI of the item. */
             itemHref?: string;
-            /** @description The unique RESTful identifier of the item. */
             itemId?: string;
-            /** @description This container returns the postal code and country of the location of the item. */
             itemLocation?: components["schemas"]["ItemLocation"];
-            /** @description The URL to the View Item page of the item. */
             itemWebUrl?: string;
-            /** @description The date the last item was purchased within the last 90 days. The totalSoldQuantity returns the total number of items that were sold. This field returns the date the last item in that group was sold. */
             lastSoldDate?: string;
-            /** @description The sold price of the last item purchased within the last 90 days. The totalSoldQuantity returns the total number of items that were sold. This field returns the date the last item in that group was sold.. */
             lastSoldPrice?: components["schemas"]["ConvertedAmount"];
-            /** @description This container returns basic information about the seller of the item, such as name, feedback score, etc. */
             seller?: components["schemas"]["Seller"];
-            /** @description An array of thumbnail images for the item. */
             thumbnailImages?: (components["schemas"]["Image"])[];
-            /** @description The seller-created title of the item. Maximum Length: 80 characters */
             title?: string;
-            /**
-             * Format: int32
-             * @description The total number of this item that have been sold.
-             */
             totalSoldQuantity?: number;
         };
-        /** @description This type defines the fields for the various refinements of an item. You can use the information in this container to create histograms, which help shoppers choose exactly what they want. */
         Refinement: {
-            /** @description A array of containers for the all the aspect refinements. */
             aspectDistributions?: (components["schemas"]["AspectDistribution"])[];
-            /** @description A array of containers for the all the buying option refinements. */
             buyingOptionDistributions?: (components["schemas"]["BuyingOptionDistribution"])[];
-            /** @description A array of containers for the all the category refinements. */
             categoryDistributions?: (components["schemas"]["CategoryDistribution"])[];
-            /** @description A array of containers for the all the condition refinements. */
             conditionDistributions?: (components["schemas"]["ConditionDistribution"])[];
-            /** @description The identifier of the category that most of the items are part of. */
             dominantCategoryId?: string;
         };
         SalesHistoryPagedCollection: {
-            /** @description The URI of the current page of results from the result set. The following example returns items 1 thru 5 from the list of items found. https://api.ebay.com/buy/marketplace_insights/v1_beta/item_sales/search?q=shirt&amp;&amp;limit=5&amp;offset=0 */
             href?: string;
-            /** @description The type that defines the fields for a paginated result set of the sold items. The response consists of 0 or more sequenced result sets where each result sets has 0 or more items. Note: For items with multiple quantities that might result in multiple transactions, and items with the SELLER_DEFINED_VARIATIONS group type that might result in multiple transactions, only one deduped transaction is returned in the search results. */
             itemSales?: (components["schemas"]["ItemSales"])[];
-            /**
-             * Format: int32
-             * @description The number of items returned on a single page from the result set. This value can be set in the request with the limit query parameter.
-             */
             limit?: number;
-            /** @description The URI for the following page of results. This value is returned only if there is an additional page of results to display from the result set. Max length: 2048 */
             next?: string;
-            /**
-             * Format: int32
-             * @description The number of results skipped in the result set before listing the first returned result. This value can be set in the request with the offset query parameter.
-             */
             offset?: number;
-            /** @description The URI for the preceding page of results. This value is returned only if there is a previous page of results to display from the result set. Max length: 2048 */
             prev?: string;
-            /** @description The container for all the search refinements. */
             refinement?: components["schemas"]["Refinement"];
-            /**
-             * Format: int32
-             * @description The total number of items retrieved in the result set. If no items are found, this field is returned with a value of 0.
-             */
             total?: number;
         };
-        /** @description The type that defines the fields for basic information about the seller of the item. */
         Seller: {
-            /** @description The percentage of the total positive feedback. */
             feedbackPercentage?: string;
-            /**
-             * Format: int32
-             * @description The feedback score of the seller. This value is based on the ratings from eBay members that bought items from this seller.
-             */
             feedbackScore?: number;
-            /** @description The username created by the seller for use on eBay. */
             username?: string;
         };
     };
@@ -260,44 +125,29 @@ export interface components {
 }
 export type external = Record<string, never>;
 export interface operations {
-    /** @description (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. This method also supports the following: Filtering by the value of one or multiple fields, such as listing format, item condition, price range, location, and more. For the fields supported by this method, see the filter parameter. Retrieving the refinements (metadata) of an item , such as item aspects (color, brand), condition, category, etc. using the fieldgroups parameter. Filtering by item aspects and other refinements using the aspect_filter parameter. Creating aspects histograms, which enables shoppers to drill down in each refinement narrowing the search results. For details and examples of these capabilities, see Browse API in the Buying Integration Guide. Pagination and sort controls There are pagination controls (limit and offset fields) and sort query parameters that control/sort the data that is returned. By default, the results are sorted by &quot;Best Match&quot;. For more information about Best Match, see the eBay help page Best Match. URLs for this method Production URL: https://api.ebay.com/buy/marketplace_insights/v1_beta/item_sales/ Sandbox URL: https://api.sandbox.ebay.com/buy/marketplace_insights/v1_beta/item_sales/ Request headers You will want to use the X-EBAY-C-ENDUSERCTX request header with this method. If you are an eBay Network Partner you must use affiliateCampaignId=ePNCampaignId,affiliateReferenceId=referenceId in the header in order to be paid for selling eBay items on your site . For details see, Request headers in the Buy APIs Overview. URL Encoding for Parameters Query parameter values need to be URL encoded. For details, see URL encoding query parameter values. Restrictions For a list of supported sites and other restrictions, see API Restrictions. */
     search: {
         parameters: {
             query?: {
-                /** @description This field lets you filter by item aspects. The aspect name/value pairs and category, which is required, is used to limit the results to specific aspects of the item. For example, in a clothing category one aspect pair would be Color/Red. The results are returned in the refinement container. For example, the method below uses the category ID for Women's Clothing. This will return only sold items for a woman's red or blue shirt. /buy/marketplace_insights/v1_beta/item_sales/search?q=shirt&amp;category_ids=15724&amp;aspect_filter=categoryId:15724,Color:{Red|Blue} To get a list of the aspects pairs and the category, which is returned in the dominantCategoryId field, set fieldgroups to ASPECT_REFINEMENTS. /buy/marketplace_insights/v1_beta/item_sales/search?q=shirt&amp;category_ids=15724&amp;fieldgroups=ASPECT_REFINEMENTS Format: aspectName:{value1|value2} Required: The category ID is required twice; once as a URI parameter and as part of the aspect_filter parameter. For implementation help, refer to eBay API documentation at https://developer.ebay.com/api-docs/buy/marketplace_insights/types/gct:AspectFilter */
                 aspect_filter?: string;
-                /** @description The category ID is required and is used to limit the results. For example, if you search for 'shirt' the result set will be very large. But if you also include the category ID 137084, the results will be limited to 'Men's Athletic Apparel'. For example: /buy/marketplace-insights/v1_beta/item_sales/search?q=shirt&amp;category_ids=137084 The list of eBay category IDs is not published and category IDs are not the same across all the eBay marketplaces. You can use the following techniques to find a category by site: For the US marketplace, use the Category Changes page. Use the Taxonomy API. For details see Get Categories for Buy APIs. Usage: This field can have one category ID or a comma separated list of IDs. You can use category_ids by itself or use it with any combination of the gtin, epid, and q fields, which gives you additional control over the result set. Restrictions: Partners will be given a list of categories they can use. To use a top-level (L1) category, you must also include the q, or gtin, or epid query parameter. Maximum number of categories: 4 */
                 category_ids?: string;
-                /** @description The ePID is the eBay product identifier of a product from the eBay product catalog. This field limits the results to only items in the specified ePID. /buy/marketplace-insights/v1_beta/item_sales/search?epid=241986085&amp;category_ids=168058 You can use the product_summary/search method in the Catalog API to search for the ePID of the product. Required: At least 1 category_ids Maximum: 1 epid Optional: Any combination of epid, gtin, or q */
                 epid?: string;
-                /** @description This field lets you control what is to be returned in the response and accepts a comma separated list of values. The default is MATCHING_ITEMS, which returns the items that match the keyword or category specified. The other values return data that can be used to create histograms. For code examples see, aspect_filter. Valid Values: ASPECT_REFINEMENTS - This returns the aspectDistributions container, which has the dominantCategoryId, matchCount, and refinementHref for the various aspects of the items found. For example, if you searched for 'Mustang', some of the aspect would be Model Year, Exterior Color, Vehicle Mileage, etc. Note: ASPECT_REFINEMENTS are category specific. BUYING_OPTION_REFINEMENTS - This returns the buyingOptionDistributions container, which has the matchCount and refinementHref for AUCTION and FIXED_PRICE (Buy It Now) items. Note: Classified items are not supported. CATEGORY_REFINEMENTS - This returns the categoryDistributions container, which has the categories that the item is in. CONDITION_REFINEMENTS - This returns the conditionDistributions container, such as NEW, USED, etc. Within these groups are multiple states of the condition. For example, New can be New without tag, New in box, New without box, etc. MATCHING_ITEMS - This is meant to be used with one or more of the refinement values above. You use this to return the specified refinements and all the matching items. FULL - This returns all the refinement containers and all the matching items. Code so that your app gracefully handles any future changes to this list. Default: MATCHING_ITEMS */
                 fieldgroups?: string;
-                /** @description This field supports multiple field filters that can be used to limit/customize the result set. The following lists the supported filters. For details and examples for all the filters, see Buy API Field Filters. buyingOptions conditionIds conditions itemLocationCountry lastSoldDate price priceCurrency The following example filters the result set by price. Note: To filter by price, price and priceCurrency must always be used together. /buy/marketplace-insights/v1_beta/item_sales/search?q=iphone&amp;category_ids=15724&amp;filter=price:[50..500],priceCurrency:USD For implementation help, refer to eBay API documentation at https://developer.ebay.com/api-docs/buy/marketplace_insights/types/cos:FilterField */
                 filter?: string;
-                /** @description This field lets you search by the Global Trade Item Number of the item as defined by https://www.gtin.info. This can be a UPC (Universal Product Code), EAN (European Article Number), or an ISBN (International Standard Book Number) value. /buy/marketplace-insights/v1_beta/item_sales/search?gtin=241986085&amp;category_ids=9355 Required: At least 1 category_ids Maximum: 1 gtin Optional: Any combination of epid, gtin, or q */
                 gtin?: string;
-                /** @description The number of items, from the result set, returned in a single page. Default: 50 Maximum number of items per page (limit): 200 Maximum number of items in a result set: 10,000 */
                 limit?: string;
-                /** @description Specifies the number of items to skip in the result set. This is used with the limit field to control the pagination of the output. If offset is 0 and limit is 10, the method will retrieve items 1-10 from the list of items returned, if offset is 10 and limit is 10, the method will retrieve items 11 thru 20 from the list of items returned. Valid Values: 0-10,000 (inclusive) Default: 0 Maximum number of items returned: 10,000 */
                 offset?: string;
-                /** @description A string consisting of one or more keywords that are used to search for items on eBay. The keywords are handled as follows: If the keywords are separated by a comma, it is treated as an AND. In the following example, the query returns items that have iphone AND ipad. /buy/marketplace-insights/v1_beta/item_sales/search?q=iphone,ipad&amp;category_ids=15724 If the keywords are separated by a space, it is treated as an OR. In the following examples, the query returns items that have iphone OR ipad. /buy/marketplace-insights/v1_beta/item_sales/search?q=iphone&amp;category_ids=15724&nbsp;ipad /buy/marketplace-insights/v1_beta/item_sales/search?q=iphone,&nbsp;ipad&amp;category_ids=15724 Restriction: The * wildcard character is not allowed in this field. Required: At least 1 category_ids Optional: Any combination of epid, gtin, or q */
                 q?: string;
-                /** @description This field specifies the order and the field name to use to sort the items. To sort in descending order use - before the field name. Currently, you can only sort by price (in ascending or descending order). If no sort parameter is submitted, the result set is sorted by &quot;Best Match&quot;. The following are examples of using the sort query parameter. Sort Result &amp;sort=price Sorts by price in ascending order (lowest price first) &amp;sort=-price Sorts by price in descending order (highest price first) Default: ascending For implementation help, refer to eBay API documentation at https://developer.ebay.com/api-docs/buy/marketplace_insights/types/cos:SortField */
                 sort?: string;
             };
         };
         responses: {
-            /** @description Success */
             200: {
                 content: {
                     "application/json": components["schemas"]["SalesHistoryPagedCollection"];
                 };
             };
-            /** @description Bad Request */
             400: never;
-            /** @description Conflict */
             409: never;
-            /** @description Internal Server Error */
             500: never;
         };
     };

package/lib/types/restful/specs/buy_marketplace_insights_v1_beta_oas3.js

@@ -1,6 +1,2 @@
 "use strict";
-/**
- * This file was auto-generated by openapi-typescript.
- * Do not make direct changes to the file.
- */
 Object.defineProperty(exports, "__esModule", { value: true });