ebay-api 8.5.1 → 8.6.1

package/lib/types/restful/specs/buy_browse_v1_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_deal_v1_oas3.d.ts

@@ -1,297 +1,146 @@
-/**
- * This file was auto-generated by openapi-typescript.
- * Do not make direct changes to the file.
- */
 export interface paths {
     "/deal_item": {
-        /** @description This method retrieves a paginated set of deal items. The result set contains all deal items associated with the specified search criteria and marketplace ID. Request headers This method uses the X-EBAY-C-ENDUSERCTX request header to support revenue sharing for eBay Partner Networks and to improve the accuracy of shipping and delivery time estimations. For details see, Request headers in the Buying Integration Guide. Restrictions This method can return a maximum of 10,000 items. For a list of supported sites and other restrictions, see API Restrictions. eBay Partner Network: In order to receive a commission for your sales, you must use the URL returned in the itemAffiliateWebUrl field to forward your buyer to the ebay.com site. */
         get: operations["getDealItems"];
     };
     "/event/{event_id}": {
-        /** @description This method retrieves the details for an eBay event. The result set contains detailed information associated with the specified event ID, such as applicable coupons, start and end dates, and event terms. Request headers This method uses the X-EBAY-C-ENDUSERCTX request header to support revenue sharing for eBay Partner Networks and to improve the accuracy of shipping and delivery time estimations. For details see, Request headers in the Buying Integration Guide. Restrictions This method can return a maximum of 10,000 items. For a list of supported sites and other restrictions, see API Restrictions. eBay Partner Network: In order to receive a commission for your sales, you must use the URL returned in the itemAffiliateWebUrl field to forward your buyer to the ebay.com site. */
         get: operations["getEvent"];
     };
     "/event": {
-        /** @description This method returns paginated results containing all eBay events for the specified marketplace. Request headers This method uses the X-EBAY-C-ENDUSERCTX request header to support revenue sharing for eBay Partner Networks and to improve the accuracy of shipping and delivery time estimations. For details see, Request headers in the Buying Integration Guide. Restrictions This method can return a maximum of 10,000 items. For a list of supported sites and other restrictions, see API Restrictions. eBay Partner Network: In order to receive a commission for your sales, you must use the URL returned in the itemAffiliateWebUrl field to forward your buyer to the ebay.com site. */
         get: operations["getEvents"];
     };
     "/event_item": {
-        /** @description This method returns a paginated set of event items. The result set contains all event items associated with the specified search criteria and marketplace ID. Request headers This method uses the X-EBAY-C-ENDUSERCTX request header to support revenue sharing for eBay Partner Networks and to improve the accuracy of shipping and delivery time estimations. For details see, Request headers in the Buying Integration Guide. Restrictions This method can return a maximum of 10,000 items. For a list of supported sites and other restrictions, see API Restrictions. eBay Partner Network: In order to receive a commission for your sales, you must use the URL returned in the itemAffiliateWebUrl field to forward your buyer to the ebay.com site. */
         get: operations["getEventItems"];
     };
 }
 export type webhooks = Record<string, never>;
 export interface components {
     schemas: {
-        /** @description The currency and value of the item. */
         Amount: {
-            /** @description The three-letter ISO 4217 code representing the currency of the amount in the value field. Default: The currency of the authenticated user's country. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/buy/deal/types/bas:CurrencyCodeEnum'>eBay API documentation</a> */
             currency?: string;
-            /** @description The monetary value, in the currency specified by the currency field. */
             value?: string;
         };
-        /** @description The details for the coupon available for the item. */
         Coupon: {
-            /** @description The coupon code. */
             redemptionCode?: string;
-            /** @description The terms of use associated with the coupon. */
             terms?: components["schemas"]["Terms"];
         };
-        /** @description The detailed data returned for the deal item. */
         DealItem: {
-            /** @description The additional images for the deal item. */
             additionalImages?: (components["schemas"]["Image"])[];
-            /** @description The IDs of the ancestors for the primary category. */
             categoryAncestorIds?: (string)[];
-            /** @description The ID of the leaf category for the deal item. A leaf category is the lowest level in a category and has no children. */
             categoryId?: string;
-            /** @description A boolean value specifying whether the listing has commission. */
             commissionable?: boolean;
-            /** @description The deal associated with the item with affiliate attribution. */
             dealAffiliateWebUrl?: string;
-            /** @description The date after which the deal ends. */
             dealEndDate?: string;
-            /** @description The date on which the deal starts. */
             dealStartDate?: string;
-            /** @description The web URL for the deal associated with the item. */
             dealWebUrl?: string;
-            /** @description A string value specifying the Energy Efficiency class. */
             energyEfficiencyClass?: string;
-            /** @description The primary image for the deal item. */
             image?: components["schemas"]["Image"];
-            /** @description The item web URL with affiliate attribution. */
             itemAffiliateWebUrl?: string;
-            /** @description The unique identifier for the deal item group. This is the parent item ID for the seller-defined variations. Note: This field is returned for multiple-SKU items. */
             itemGroupId?: string;
-            /** @description An enumeration value that indicates the type of item group. An item group contains items that have various aspect differences, such as color, size, or storage capacity. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/buy/deal/types/api:ItemGroupTypeEnum'>eBay API documentation</a> */
             itemGroupType?: string;
-            /** @description The unique identifier for the deal item. Note: This field is only returned for single-SKU items. */
             itemId?: string;
-            /** @description The web URL for the deal item. */
             itemWebUrl?: string;
-            /** @description The legacy item ID associated with the deal item. */
             legacyItemId?: string;
-            /** @description The original price for the deal item, and the discount amount and percentage. */
             marketingPrice?: components["schemas"]["MarketingPrice"];
-            /** @description The price for the deal item. Note: The price does include the value-added tax (VAT) for applicable jurisdictions when requested from supported marketplaces. In this case, users must pass the X-EBAY-C-MARKETPLACE-ID request header specifying the supported marketplace (such as EBAY_GB) to see the VAT-inclusive pricing. For more information on VAT, refer to VAT Obligations in the EU. */
             price?: components["schemas"]["Amount"];
-            /** @description A list of programs applicable to the item. */
             qualifiedPrograms?: (string)[];
-            /** @description The cost required to ship the deal item. */
             shippingOptions?: (components["schemas"]["ShippingOption"])[];
-            /** @description The title of the deal item. */
             title?: string;
-            /** @description The price per unit for the deal item. Some European countries require listings for certain types of products to include the price per unit so that buyers can accurately compare prices. For example: &quot;unitPricingMeasure&quot;: &quot;100g&quot;, &quot;unitPrice&quot;: { &nbsp;&nbsp;&quot;value&quot;: &quot;7.99&quot;, &nbsp;&nbsp;&quot;currency&quot;: &quot;GBP&quot; */
             unitPrice?: components["schemas"]["Amount"];
-            /** @description The designation used to specify the quantity of the deal item, such as size, weight, volume, and count. This helps buyers compare prices. For example, the following tells the buyer that the item is 7.99 per 100 grams. &quot;unitPricingMeasure&quot;: &quot;100g&quot;, &quot;unitPrice&quot;: { &nbsp;&nbsp;&quot;value&quot;: &quot;7.99&quot;, &nbsp;&nbsp;&quot;currency&quot;: &quot;GBP&quot; */
             unitPricingMeasure?: string;
         };
-        /** @description The result set for the deal item search. */
         DealItemSearchResponse: {
-            /** @description A list of deal items that match the search criteria. */
             dealItems?: (components["schemas"]["DealItem"])[];
-            /** @description The relative path to the current set of results. */
             href?: string;
-            /**
-             * Format: int32
-             * @description The maximum number of items, from the current result set, returned on a single page. Default: 20
-             */
             limit?: number;
-            /** @description The relative path to the next set of results. */
             next?: string;
-            /**
-             * Format: int32
-             * @description The number of items that will be skipped in the result set. This is used with the limit field to control the pagination of the output. For example, if the offset is set to 0 and the limit is set to 10, the method will retrieve items 1 through 10 from the list of items returned. If the offset is set to 10 and the limit is set to 10, the method will retrieve items 11 through 20 from the list of items returned. Default: 0
-             */
             offset?: number;
-            /** @description The relative path to the previous set of results. */
             prev?: string;
-            /**
-             * Format: int32
-             * @description The total number of matches for the search criteria.
-             */
             total?: number;
         };
-        /** @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 The result set for the event search. */
         Event: {
-            /** @description A list of coupons associated with the event. */
             applicableCoupons?: (components["schemas"]["Coupon"])[];
-            /** @description The event description. */
             description?: string;
-            /** @description The end date for the event. */
             endDate?: string;
-            /** @description The URL of the View Event page for the event, which includes the affiliate tracking ID. */
             eventAffiliateWebUrl?: string;
-            /** @description The unique identifier for the event. */
             eventId?: string;
-            /** @description The web URL for the event. */
             eventWebUrl?: string;
-            /** @description The images for the event. */
             images?: (components["schemas"]["Image"])[];
-            /** @description The start date for the event. */
             startDate?: string;
-            /** @description The terms associated with the event. */
             terms?: components["schemas"]["Terms"];
-            /** @description The title of the event. */
             title?: string;
         };
-        /** @description The detailed data returned for the event item. */
         EventItem: {
-            /** @description The additional images for the event item. */
             additionalImages?: (components["schemas"]["Image"])[];
-            /** @description The IDs of the ancestors for the primary category. */
             categoryAncestorIds?: (string)[];
-            /** @description The ID of the leaf category for the event item. A leaf category is the lowest level in a category and has no children. */
             categoryId?: string;
-            /** @description A string value specifying the Energy Efficiency class. */
             energyEfficiencyClass?: string;
-            /** @description The unique event identifier associated with the item. */
             eventId?: string;
-            /** @description The image for the event item. */
             image?: components["schemas"]["Image"];
-            /** @description The item web URL with affiliate attribution. */
             itemAffiliateWebUrl?: string;
-            /** @description The unique identifier for the event item group. This is the parent item ID for the seller-defined variations. Note: This field is returned for multiple-SKU items. */
             itemGroupId?: string;
-            /** @description An enumeration value that indicates the type of item group. An item group contains items that have various aspect differences, such as color, size, or storage capacity. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/buy/deal/types/api:ItemGroupTypeEnum'>eBay API documentation</a> */
             itemGroupType?: string;
-            /** @description The unique identifier for the event item. Note: This field is only returned for single-SKU items. */
             itemId?: string;
-            /** @description The web URL for the event item. */
             itemWebUrl?: string;
-            /** @description The legacy item ID associated with the event item. */
             legacyItemId?: string;
-            /** @description The original price for the event item, and the discount amount and percentage. */
             marketingPrice?: components["schemas"]["MarketingPrice"];
-            /** @description The applicable price for the event item. */
             price?: components["schemas"]["Amount"];
-            /** @description A list of programs applicable to the event item. */
             qualifiedPrograms?: (string)[];
-            /** @description The cost required to ship the event item. */
             shippingOptions?: (components["schemas"]["ShippingOption"])[];
-            /** @description The title of the event item. */
             title?: string;
-            /** @description The price per unit for the event item. Some European countries require listings for certain types of products to include the price per unit so that buyers can accurately compare prices. For example: &quot;unitPricingMeasure&quot;: &quot;100g&quot;, &quot;unitPrice&quot;: { &nbsp;&nbsp;&quot;value&quot;: &quot;7.99&quot;, &nbsp;&nbsp;&quot;currency&quot;: &quot;GBP&quot; */
             unitPrice?: components["schemas"]["Amount"];
-            /** @description The designation used to specify the quantity of the event item, such as size, weight, volume, and count. This helps buyers compare prices. For example, the following tells the buyer that the item is 7.99 per 100 grams. &quot;unitPricingMeasure&quot;: &quot;100g&quot;, &quot;unitPrice&quot;: { &nbsp;&nbsp;&quot;value&quot;: &quot;7.99&quot;, &nbsp;&nbsp;&quot;currency&quot;: &quot;GBP&quot; */
             unitPricingMeasure?: string;
         };
-        /** @description The result set for the event item search. */
         EventItemSearchResponse: {
-            /** @description A list of event items that match the search criteria. */
             eventItems?: (components["schemas"]["EventItem"])[];
-            /** @description The relative path to the current set of results. */
             href?: string;
-            /**
-             * Format: int32
-             * @description The maximum number of items, from the current result set, returned on a single page. Default: 20
-             */
             limit?: number;
-            /** @description The relative path to the next set of results. */
             next?: string;
-            /**
-             * Format: int32
-             * @description The number of items that will be skipped in the result set. This is used with the limit field to control the pagination of the output. For example, if the offset is set to 0 and the limit is set to 10, the method will retrieve items 1 through 10 from the list of items returned. If the offset is set to 10 and the limit is set to 10, the method will retrieve items 11 through 20 from the list of items returned. Default: 0
-             */
             offset?: number;
-            /** @description The relative path to the previous set of results. */
             prev?: string;
-            /**
-             * Format: int32
-             * @description The total number of matches for the specified search criteria.
-             */
             total?: number;
         };
-        /** @description The result set for the specified event search criteria. */
         EventSearchResponse: {
-            /** @description A list of results that match the search criteria. */
             events?: (components["schemas"]["Event"])[];
-            /** @description The relative path to the current set of results. */
             href?: string;
-            /**
-             * Format: int32
-             * @description The maximum number of items, from the current result set, returned on a single page. Default: 20
-             */
             limit?: number;
-            /** @description The relative path to the next set of results. */
             next?: string;
-            /**
-             * Format: int32
-             * @description The number of items that will be skipped in the result set. This is used with the limit field to control the pagination of the output. For example, if the offset is set to 0 and the limit is set to 10, the method will retrieve items 1 through 10 from the list of items returned. If the offset is set to 10 and the limit is set to 10, the method will retrieve items 11 through 20 from the list of items returned. Default: 0
-             */
             offset?: number;
-            /** @description The relative path to the previous set of results. */
             prev?: string;
-            /**
-             * Format: int32
-             * @description The total number of matches for the specified search criteria.
-             */
             total?: number;
         };
-        /** @description The type that defines the details of an image, such as size and URL. */
         Image: {
-            /** @description The height of the image. */
             height?: string;
-            /** @description The relative path to the image location. */
             imageUrl?: string;
-            /** @description The text associated with the image. */
             text?: string;
-            /** @description The width of the image. */
             width?: string;
         };
-        /** @description A type that describes the seller discount. */
         MarketingPrice: {
-            /** @description The monetary value of the seller discount. */
             discountAmount?: components["schemas"]["Amount"];
-            /** @description The percentage of the seller discount based on the value returned in the originalPrice field. */
             discountPercentage?: string;
-            /** @description The monetary value of the item prior to the discount. */
             originalPrice?: components["schemas"]["Amount"];
-            /** @description The pricing treatment (discount) that was applied to the price of the item. Note: The pricing treatment affects how and where the discounted price can be displayed. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/buy/deal/types/api:PriceTreatmentEnum'>eBay API documentation</a> */
             priceTreatment?: string;
         };
-        /** @description The details provided for the shipping provider, such as shipping cost and type. */
         ShippingOption: {
-            /** @description The final shipping cost for all items after all discounts are applied. Note: The price does include the value-added tax (VAT) for applicable jurisdictions when requested from supported marketplaces. In this case, users must pass the X-EBAY-C-MARKETPLACE-ID request header specifying the supported marketplace (such as EBAY_GB) to see the VAT-inclusive pricing. For more information on VAT, refer to VAT Obligations in the EU. */
             shippingCost?: components["schemas"]["Amount"];
-            /** @description The class of the shipping cost. Valid Values: FIXED or CALCULATED Code so that your app gracefully handles any future changes to this list. */
             shippingCostType?: string;
         };
-        /** @description The terms for the event, provided in a full-text description and summary. */
         Terms: {
-            /** @description A full-text description of the terms. */
             fullText?: string;
-            /** @description A summarized description of the terms. */
             summary?: string;
         };
     };
@@ -303,131 +152,93 @@ export interface components {
 }
 export type external = Record<string, never>;
 export interface operations {
-    /** @description This method retrieves a paginated set of deal items. The result set contains all deal items associated with the specified search criteria and marketplace ID. Request headers This method uses the X-EBAY-C-ENDUSERCTX request header to support revenue sharing for eBay Partner Networks and to improve the accuracy of shipping and delivery time estimations. For details see, Request headers in the Buying Integration Guide. Restrictions This method can return a maximum of 10,000 items. For a list of supported sites and other restrictions, see API Restrictions. eBay Partner Network: In order to receive a commission for your sales, you must use the URL returned in the itemAffiliateWebUrl field to forward your buyer to the ebay.com site. */
     getDealItems: {
         parameters: {
             query?: {
-                /** @description The unique identifier of the eBay category for the search. */
                 category_ids?: string;
-                /** @description A filter for commissionable deals. Restriction: This filter is currently only supported for the US marketplace. */
                 commissionable?: string;
-                /** @description A filter for items that can be shipped to the specified country. */
                 delivery_country?: string;
-                /** @description The maximum number of items, from the current result set, returned on a single page. */
                 limit?: string;
-                /** @description The number of items that will be skipped in the result set. This is used with the limit field to control the pagination of the output. For example, if the offset is set to 0 and the limit is set to 10, the method will retrieve items 1 through 10 from the list of items returned. If the offset is set to 10 and the limit is set to 10, the method will retrieve items 11 through 20 from the list of items returned. Default: 0 */
                 offset?: string;
             };
             header: {
-                /** @description A header used to specify the eBay marketplace ID. */
                 "X-EBAY-C-MARKETPLACE-ID": string;
             };
         };
         responses: {
-            /** @description OK */
             200: {
                 content: {
                     "application/json": components["schemas"]["DealItemSearchResponse"];
                 };
             };
-            /** @description Bad Request */
             400: never;
-            /** @description Forbidden */
             403: never;
-            /** @description Internal Server Error */
             500: never;
         };
     };
-    /** @description This method retrieves the details for an eBay event. The result set contains detailed information associated with the specified event ID, such as applicable coupons, start and end dates, and event terms. Request headers This method uses the X-EBAY-C-ENDUSERCTX request header to support revenue sharing for eBay Partner Networks and to improve the accuracy of shipping and delivery time estimations. For details see, Request headers in the Buying Integration Guide. Restrictions This method can return a maximum of 10,000 items. For a list of supported sites and other restrictions, see API Restrictions. eBay Partner Network: In order to receive a commission for your sales, you must use the URL returned in the itemAffiliateWebUrl field to forward your buyer to the ebay.com site. */
     getEvent: {
         parameters: {
             header: {
-                /** @description A header used to specify the eBay marketplace ID. */
                 "X-EBAY-C-MARKETPLACE-ID": string;
             };
             path: {
-                /** @description The unique identifier for the eBay event. */
                 event_id: string;
             };
         };
         responses: {
-            /** @description OK */
             200: {
                 content: {
                     "application/json": components["schemas"]["Event"];
                 };
             };
-            /** @description Bad Request */
             400: never;
-            /** @description Forbidden */
             403: never;
-            /** @description Not Found */
             404: never;
-            /** @description Internal Server Error */
             500: never;
         };
     };
-    /** @description This method returns paginated results containing all eBay events for the specified marketplace. Request headers This method uses the X-EBAY-C-ENDUSERCTX request header to support revenue sharing for eBay Partner Networks and to improve the accuracy of shipping and delivery time estimations. For details see, Request headers in the Buying Integration Guide. Restrictions This method can return a maximum of 10,000 items. For a list of supported sites and other restrictions, see API Restrictions. eBay Partner Network: In order to receive a commission for your sales, you must use the URL returned in the itemAffiliateWebUrl field to forward your buyer to the ebay.com site. */
     getEvents: {
         parameters: {
             query?: {
-                /** @description The maximum number of items, from the current result set, returned on a single page. Default: 20 Maximum Value: 100 */
                 limit?: string;
-                /** @description The number of items that will be skipped in the result set. This is used with the limit field to control the pagination of the output. For example, if the offset is set to 0 and the limit is set to 10, the method will retrieve items 1 through 10 from the list of items returned. If the offset is set to 10 and the limit is set to 10, the method will retrieve items 11 through 20 from the list of items returned. Default: 0 */
                 offset?: string;
             };
             header: {
-                /** @description A header used to specify the eBay marketplace ID. */
                 "X-EBAY-C-MARKETPLACE-ID": string;
             };
         };
         responses: {
-            /** @description OK */
             200: {
                 content: {
                     "application/json": components["schemas"]["EventSearchResponse"];
                 };
             };
-            /** @description Bad Request */
             400: never;
-            /** @description Forbidden */
             403: never;
-            /** @description Internal Server Error */
             500: never;
         };
     };
-    /** @description This method returns a paginated set of event items. The result set contains all event items associated with the specified search criteria and marketplace ID. Request headers This method uses the X-EBAY-C-ENDUSERCTX request header to support revenue sharing for eBay Partner Networks and to improve the accuracy of shipping and delivery time estimations. For details see, Request headers in the Buying Integration Guide. Restrictions This method can return a maximum of 10,000 items. For a list of supported sites and other restrictions, see API Restrictions. eBay Partner Network: In order to receive a commission for your sales, you must use the URL returned in the itemAffiliateWebUrl field to forward your buyer to the ebay.com site. */
     getEventItems: {
         parameters: {
             query: {
-                /** @description The unique identifier of the eBay category for the search. Maximum Value: 1 */
                 category_ids?: string;
-                /** @description A filter for items that can be shipped to the specified country. */
                 delivery_country?: string;
-                /** @description The unique identifiers for the eBay events. Maximum Value: 1 */
                 event_ids: string;
-                /** @description The maximum number of items, from the current result set, returned on a single page. Default: 20 */
                 limit?: string;
-                /** @description The number of items that will be skipped in the result set. This is used with the limit field to control the pagination of the output. For example, if the offset is set to 0 and the limit is set to 10, the method will retrieve items 1 through 10 from the list of items returned. If the offset is set to 10 and the limit is set to 10, the method will retrieve items 11 through 20 from the list of items returned. Default: 0 */
                 offset?: string;
             };
             header: {
-                /** @description A header used to specify the eBay marketplace ID. */
                 "X-EBAY-C-MARKETPLACE-ID": string;
             };
         };
         responses: {
-            /** @description OK */
             200: {
                 content: {
                     "application/json": components["schemas"]["EventItemSearchResponse"];
                 };
             };
-            /** @description Bad Request */
             400: never;
-            /** @description Forbidden */
             403: never;
-            /** @description Internal Server Error */
             500: never;
         };
     };

package/lib/types/restful/specs/buy_deal_v1_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 });