ebay-api 8.5.1 → 8.6.0

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

@@ -1,28 +1,10 @@
 import { BuyMarketingGetAlsoBoughtByProductParams, BuyMarketingGetAlsoViewedByProductParams, BuyMarketingGetMerchandisedProductsParams } from '../../../../types/index.js';
 import { operations } from '../../../../types/restful/specs/buy_marketing_v1_beta_oas3.js';
 import Restful, { OpenApi } from '../../index.js';
-/**
- * The Marketing API retrieves eBay products based on a metric, such as Best Selling, as well as products that were
- * also bought and also viewed.
- */
 export default class Marketing extends Restful implements OpenApi<operations> {
     static id: string;
     get basePath(): string;
-    /**
-     * This call returns products that were also bought when shoppers bought the product specified in the request.
-     * @param params
-     */
     getAlsoBoughtByProduct(params: BuyMarketingGetAlsoBoughtByProductParams): Promise<any>;
-    /**
-     * This call returns products that were also viewed when shoppers viewed the product specified in the request.
-     *
-     * @param params
-     */
     getAlsoViewedByProduct(params: BuyMarketingGetAlsoViewedByProductParams): Promise<any>;
-    /**
-     * This call returns an array of products based on the category and metric specified.
-     *
-     * @param params
-     */
     getMerchandisedProducts(params: BuyMarketingGetMerchandisedProductsParams): Promise<any>;
 }

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

@@ -1,40 +1,18 @@
 import Restful from '../../index.js';
-/**
- * The Marketing API retrieves eBay products based on a metric, such as Best Selling, as well as products that were
- * also bought and also viewed.
- */
 class Marketing extends Restful {
     get basePath() {
         return '/buy/marketing/v1_beta';
     }
-    //
-    // Marketing
-    // Client Credentials: https://api.ebay.com/oauth/api_scope/buy.marketing
-    //
-    /**
-     * This call returns products that were also bought when shoppers bought the product specified in the request.
-     * @param params
-     */
     getAlsoBoughtByProduct(params) {
         return this.get(`/merchandised_product/get_also_bought_products`, {
             params
         });
     }
-    /**
-     * This call returns products that were also viewed when shoppers viewed the product specified in the request.
-     *
-     * @param params
-     */
     getAlsoViewedByProduct(params) {
         return this.get(`/merchandised_product/get_also_viewed_products`, {
             params
         });
     }
-    /**
-     * This call returns an array of products based on the category and metric specified.
-     *
-     * @param params
-     */
     getMerchandisedProducts(params) {
         return this.get(`/merchandised_product`, {
             params

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

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

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

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

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

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

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

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

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

@@ -1,265 +1,38 @@
 import { CheckoutSessionRequestWithoutPayment, CouponRequest, CreateGuestCheckoutSessionRequest, CreateSignInCheckoutSessionRequest, GuestPlaceOrderRequest, InitiatePaymentRequest, ShippingAddressImpl, UpdatePaymentInformation, UpdateQuantity, UpdateShippingOption } from '../../../../types/index.js';
 import { operations } from '../../../../types/restful/specs/buy_order_v1_beta_oas3.js';
 import Api, { OpenApi } from '../../index.js';
-/**
- * The Order API provides interfaces that lets shoppers pay for items (for both eBay guest and eBay member buyers).
- * Client Credentials: https://api.ebay.com/oauth/api_scope/buy.order
- */
 export default class Order extends Api implements OpenApi<operations> {
     static id: string;
     get basePath(): string;
-    /**
-     * (Limited Release) You must be whitelisted to use this method.
-     * This method adds a coupon to an eBay proxy guest checkout session and applies it to all the eligible items in
-     * the order.
-     *
-     * @param {String} checkoutSessionId The eBay-assigned session ID, for a specific eBay marketplace, that is
-     *     returned by the initiateCheckoutSession method.
-     * @param body The container for the fields used to apply a coupon to a checkout session.
-     */
     applyCoupon(checkoutSessionId: string, body: CouponRequest): Promise<any>;
-    /**
-     * This method returns the details of the specified eBay member checkout session.
-     *
-     * @param {String} checkoutSessionId The eBay-assigned session ID, for a specific eBay marketplace, that is
-     *     returned by the initiateCheckoutSession method.
-     */
     getCheckoutSession(checkoutSessionId: string): Promise<any>;
-    /**
-     * This method creates a eBay member checkout session, which is the first step in performing a checkout.
-     *
-     * @param body The container for the fields used by the initiateCheckoutSession method.
-     */
     initiateCheckoutSession(body?: CreateSignInCheckoutSessionRequest): Promise<any>;
-    /**
-     * This method creates the purchase order, pays for the items, and terminates the specified eBay member checkout
-     * session.
-     *
-     * @param checkoutSessionId The eBay-assigned session ID, for a specific eBay marketplace, that is returned by the
-     *     initiateCheckoutSession method.
-     */
     placeOrder(checkoutSessionId: string): Promise<any>;
-    /**
-     * (Limited Release) You must be whitelisted to use this method. This method removes a coupon from an eBay member
-     * checkout session.
-     *
-     * @param checkoutSessionId The eBay-assigned session ID, for a specific eBay marketplace, that is returned by the
-     *     initiateCheckoutSession method.
-     * @param body CouponRequest
-     */
     removeCoupon(checkoutSessionId: string, body?: CouponRequest): Promise<any>;
-    /**
-     * This method changes the payment method information of the specified eBay member checkout session.
-     *
-     * @param checkoutSessionId The eBay-assigned session ID, for a specific eBay marketplace, that is returned by the
-     *     initiateCheckoutSession method.
-     * @param body UpdatePaymentInformation
-     */
     updatePaymentInfo(checkoutSessionId: string, body?: UpdatePaymentInformation): Promise<any>;
-    /**
-     * This method changes the quantity of the specified line item in an eBay member checkout session.
-     *
-     * @param checkoutSessionId The eBay-assigned session ID, for a specific eBay marketplace, that is returned by the
-     *     initiateCheckoutSession method.
-     * @param body UpdateQuantity
-     */
     updateQuantity(checkoutSessionId: string, body?: UpdateQuantity): Promise<any>;
-    /**
-     * This method changes the quantity of the specified line item in an eBay member checkout session.
-     *
-     * @param checkoutSessionId The eBay-assigned session ID, for a specific eBay marketplace, that is returned by the
-     *     initiateCheckoutSession method.
-     * @param body UpdateQuantity
-     */
     checkoutSessionId(checkoutSessionId: string, body?: UpdateQuantity): Promise<any>;
-    /**
-     * This method changes the shipping address for in an eBay member checkout session.
-     *
-     * @param checkoutSessionId The eBay-assigned session ID, for a specific eBay marketplace, that is returned by the
-     *     initiateCheckoutSession method.
-     * @param body ShippingAddressImpl
-     */
     updateShippingAddress(checkoutSessionId: string, body?: ShippingAddressImpl): Promise<any>;
-    /**
-     * This method changes the shipping method for the specified line item in an eBay member checkout session.
-     *
-     * @param checkoutSessionId The eBay-assigned session ID, for a specific eBay marketplace, that is returned by the
-     *     initiateCheckoutSession method.
-     * @param body UpdateShippingOption
-     */
     updateShippingOption(checkoutSessionId: string, body?: UpdateShippingOption): Promise<any>;
-    /**
-     * (Limited Release) You must be whitelisted to use this method. This method adds a coupon to an eBay guest
-     * checkout
-     *  session and applies it to all the eligible items in the order.
-     *
-     * @param checkoutSessionId The eBay-assigned session ID, for a specific eBay marketplace, that is returned by the
-     *     initiateCheckoutSession method.
-     * @param body CouponRequest
-     */
     applyGuestCoupon(checkoutSessionId: string, body?: CouponRequest): Promise<any>;
-    /**
-     * This method returns the details of the specified guest checkout session. The checkoutSessionId is passed in as a
-     * URI parameter and is required.
-     *
-     * @param checkoutSessionId The eBay-assigned session ID, for a specific eBay marketplace, that is returned by the
-     *     initiateCheckoutSession method.
-     */
     getGuestCheckoutSession(checkoutSessionId: string): Promise<any>;
-    /**
-     * This method creates an eBay guest checkout session, which is the first step in performing a checkout.
-     *
-     * @param body CheckoutSessionRequest
-     */
     initiateGuestCheckoutSession(body?: CreateGuestCheckoutSessionRequest): Promise<any>;
-    /**
-     * This method is used only in the PayPal Smart Button eBay guest payment flow.
-     *
-     *  @param checkoutSessionId The eBay-assigned session ID, for a specific eBay marketplace, that is returned by the
-     *     initiateCheckoutSession method.
-     *  @param body InitiatePaymentRequest
-     */
     initiateGuestPayment(checkoutSessionId: string, body?: InitiatePaymentRequest): Promise<any>;
-    /**
-     * This method creates the purchase order, pays for the items, and terminates the specified guest checkout session.
-     *
-     * @param checkoutSessionId The eBay-assigned session ID, for a specific eBay marketplace, that is returned by the
-     *     initiateCheckoutSession method.
-     * @param body GuestPlaceOrderRequest
-     */
     placeGuestOrder(checkoutSessionId: string, body?: GuestPlaceOrderRequest): Promise<any>;
-    /**
-     * (Limited Release) You must be whitelisted to use this method. This method removes a coupon from an eBay guest
-     * checkout session.
-     *
-     * @param checkoutSessionId The eBay-assigned session ID, for a specific eBay marketplace, that is returned by the
-     *     initiateCheckoutSession method.
-     * @param body CouponRequest
-     */
     removeGuestCoupon(checkoutSessionId: string, body?: CouponRequest): Promise<any>;
-    /**
-     * This method changes the payment method information of the specified guest checkout session.
-     *
-     * @param checkoutSessionId The eBay-assigned session ID, for a specific eBay marketplace, that is returned by the
-     *     initiateCheckoutSession method.
-     * @param body UpdatePaymentInformation
-     */
     updateGuestPaymentInfo(checkoutSessionId: string, body?: UpdatePaymentInformation): Promise<any>;
-    /**
-     * This method changes the quantity of the specified line item in an eBay guest checkout session.
-     *
-     * @param checkoutSessionId The eBay-assigned session ID, for a specific eBay marketplace, that is returned by the
-     *     initiateCheckoutSession method.
-     * @param body UpdateQuantity
-     */
     updateGuestQuantity(checkoutSessionId: string, body?: UpdateQuantity): Promise<any>;
-    /**
-     * This method changes the shipping address for the order in an eBay guest checkout session.
-     *
-     * @param checkoutSessionId The eBay-assigned session ID, for a specific eBay marketplace, that is returned by the
-     *     initiateCheckoutSession method.
-     * @param body ShippingAddressImpl
-     */
     updateGuestShippingAddress(checkoutSessionId: string, body?: ShippingAddressImpl): Promise<any>;
-    /**
-     * This method changes the shipping method for the specified line item in an eBay guest checkout session.
-     *
-     * @param checkoutSessionId The eBay-assigned session ID, for a specific eBay marketplace, that is returned by the
-     *     initiateCheckoutSession method.
-     * @param body UpdateShippingOption
-     */
     updateGuestShippingOption(checkoutSessionId: string, body?: UpdateShippingOption): Promise<any>;
-    /**
-     * (Limited Release) You must be whitelisted to use this method. This method adds a coupon to an eBay proxy guest
-     * checkout session and applies it to all the eligible items in the order.
-     *
-     * @param checkoutSessionId The eBay-assigned session ID, for a specific eBay marketplace, that is returned by the
-     *     initiateCheckoutSession method.
-     * @param body CouponRequest
-     */
     applyProxyGuestCoupon(checkoutSessionId: string, body?: CouponRequest): Promise<any>;
-    /**
-     * This method returns the details of the specified eBay proxy guest checkout session.
-     *
-     * @param checkoutSessionId The eBay-assigned session ID, for a specific eBay marketplace, that is returned by the
-     *     initiateCheckoutSession method.
-     */
     getProxyGuestCheckoutSession(checkoutSessionId: string): Promise<any>;
-    /**
-     * This method creates an eBay proxy guest checkout session, which is a payment flow that requires apps
-     * with a VSP (vault service provider), such as Braintree. The VSP handles only the methods within this flow that
-     * contain payment information.
-     *
-     * @param body CheckoutSessionRequest
-     */
     initiateProxyGuestCheckoutSession(body?: CheckoutSessionRequestWithoutPayment): Promise<any>;
-    /**
-     * This method creates the proxy guest purchase order, pays for the items, and terminates the specified guest
-     * checkout session.
-     *
-     * @param checkoutSessionId The eBay-assigned session ID, for a specific eBay marketplace, that is returned by the
-     *     initiateCheckoutSession method.
-     * @param body GuestPlaceOrderRequest
-     */
     placeProxyGuestOrder(checkoutSessionId: string, body?: GuestPlaceOrderRequest): Promise<any>;
-    /**
-     * (Limited Release) You must be whitelisted to use this method. This method removes a coupon from an eBay proxy
-     * guest checkout session. The checkoutSessionId is passed in as a URI parameter and is required.
-     *
-     * @param checkoutSessionId The eBay-assigned session ID, for a specific eBay marketplace, that is returned by the
-     *     initiateCheckoutSession method.
-     * @param body CouponRequest
-     */
     removeProxyGuestCoupon(checkoutSessionId: string, body?: CouponRequest): Promise<any>;
-    /**
-     * This method adds or changes the payment information of the specified proxy guest checkout session.
-     *
-     * @param checkoutSessionId The eBay-assigned session ID, for a specific eBay marketplace, that is returned by the
-     *     initiateCheckoutSession method.
-     * @param authorization The oAuth2 token. Note: The eBay partner must include this header in the request.
-     * @param date The UTC timestamp of the request, which is generated and added to the request by the VSP.
-     * @param requestNonce A UUID (a 128-bit universal unique ID), which is generated and added to the request by the
-     *     VSP.
-     * @param signature The HMAC signature, which is generated and added to the request by the VSP.
-     * @param body UpdatePaymentInformation
-     */
     updateProxyGuestPaymentInfo(checkoutSessionId: string, authorization: string, date: string, requestNonce: string, signature: string, body?: UpdatePaymentInformation): Promise<any>;
-    /**
-     * This method changes the quantity of the specified line item in an eBay proxy guest checkout session.
-     *
-     * @param checkoutSessionId The eBay-assigned session ID, for a specific eBay marketplace, that is returned by the
-     *     initiateCheckoutSession method.
-     * @param body UpdateQuantity
-     */
     updateProxyGuestQuantity(checkoutSessionId: string, body?: UpdateQuantity): Promise<any>;
-    /**
-     * This method changes the shipping address for the order in an eBay proxy guest checkout session.
-     *
-     * @param checkoutSessionId The eBay-assigned session ID, for a specific eBay marketplace, that is returned by the
-     *     initiateCheckoutSession method.
-     * @param body ShippingAddressImpl
-     */
     updateProxyGuestShippingAddress(checkoutSessionId: string, body?: ShippingAddressImpl): Promise<any>;
-    /**
-     * This method changes the shipping method for the specified line item in an eBay proxy guest checkout session.
-     *
-     * @param checkoutSessionId The eBay-assigned session ID, for a specific eBay marketplace, that is returned by the
-     *     initiateCheckoutSession method.
-     * @param body UpdateShippingOption
-     */
     updateProxyGuestShippingOption(checkoutSessionId: string, body?: UpdateShippingOption): Promise<any>;
-    /**
-     * This method retrieves the details about a specific guest purchase order.
-     *
-     * @param purchaseOrderId The unique identifier of a purchase order made by a guest buyer, for which details are to
-     *     be retrieved.
-     */
     getGuestPurchaseOrder(purchaseOrderId: string): Promise<any>;
-    /**
-     * This method retrieves the details about a specific eBay member purchase order.
-     *
-     * @param purchaseOrderId The unique identifier of a purchase order made by an eBay member, for which details are
-     *     to be retrieved.
-     */
     getPurchaseOrder(purchaseOrderId: string): Promise<any>;
 }