ebay-api 1.13.5 → 6.1.0

package/lib/api/restful/buy/order/index.js

@@ -0,0 +1,369 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const __1 = __importDefault(require("../../"));
+/**
+ * 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
+ */
+class Order extends __1.default {
+    get basePath() {
+        return '/buy/order/v1';
+    }
+    /**
+     * (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, body) {
+        checkoutSessionId = encodeURIComponent(checkoutSessionId);
+        return this.post(`/checkout_session/${checkoutSessionId}/apply_coupon`, body);
+    }
+    /**
+     * 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) {
+        checkoutSessionId = encodeURIComponent(checkoutSessionId);
+        return this.get(`/checkout_session/${checkoutSessionId}`);
+    }
+    /**
+     * 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) {
+        return this.post(`/checkout_session/initiate`, body);
+    }
+    /**
+     * 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) {
+        checkoutSessionId = encodeURIComponent(checkoutSessionId);
+        return this.post(`/checkout_session/${checkoutSessionId}/place_order`);
+    }
+    /**
+     * (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, body) {
+        checkoutSessionId = encodeURIComponent(checkoutSessionId);
+        return this.post(`/checkout_session/${checkoutSessionId}/remove_coupon`, body);
+    }
+    /**
+     * 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, body) {
+        checkoutSessionId = encodeURIComponent(checkoutSessionId);
+        return this.post(`/checkout_session/${checkoutSessionId}/update_payment_info`, body);
+    }
+    /**
+     * 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, body) {
+        checkoutSessionId = encodeURIComponent(checkoutSessionId);
+        return this.post(`/checkout_session/${checkoutSessionId}/update_quantity`, body);
+    }
+    /**
+     * 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, body) {
+        checkoutSessionId = encodeURIComponent(checkoutSessionId);
+        return this.post(`/checkout_session/${checkoutSessionId}/update_quantity`, body);
+    }
+    /**
+     * 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, body) {
+        checkoutSessionId = encodeURIComponent(checkoutSessionId);
+        return this.post(`/checkout_session/${checkoutSessionId}/update_shipping_address`, body);
+    }
+    /**
+     * 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, body) {
+        checkoutSessionId = encodeURIComponent(checkoutSessionId);
+        return this.post(`/checkout_session/${checkoutSessionId}/update_shipping_option`, body);
+    }
+    /**
+     * (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, body) {
+        checkoutSessionId = encodeURIComponent(checkoutSessionId);
+        return this.post(`/guest_checkout_session/${checkoutSessionId}/apply_coupon`, body);
+    }
+    /**
+     * 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) {
+        checkoutSessionId = encodeURIComponent(checkoutSessionId);
+        return this.get(`/guest_checkout_session/${checkoutSessionId}`);
+    }
+    /**
+     * This method creates an eBay guest checkout session, which is the first step in performing a checkout.
+     *
+     * @param body CheckoutSessionRequest
+     */
+    initiateGuestCheckoutSession(body) {
+        return this.post(`/guest_checkout_session/initiate`, body);
+    }
+    /**
+     * 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, body) {
+        checkoutSessionId = encodeURIComponent(checkoutSessionId);
+        return this.post(`/guest_checkout_session/${checkoutSessionId}/initiate_payment`, body);
+    }
+    /**
+     * 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, body) {
+        checkoutSessionId = encodeURIComponent(checkoutSessionId);
+        return this.post(`/guest_checkout_session/${checkoutSessionId}/place_order`, body);
+    }
+    /**
+     * (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, body) {
+        checkoutSessionId = encodeURIComponent(checkoutSessionId);
+        return this.post(`/guest_checkout_session/${checkoutSessionId}/remove_coupon`, body);
+    }
+    /**
+     * 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, body) {
+        checkoutSessionId = encodeURIComponent(checkoutSessionId);
+        return this.post(`/guest_checkout_session/${checkoutSessionId}/update_payment_info`, body);
+    }
+    /**
+     * 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, body) {
+        checkoutSessionId = encodeURIComponent(checkoutSessionId);
+        return this.post(`/guest_checkout_session/${checkoutSessionId}/update_quantity`, body);
+    }
+    /**
+     * 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, body) {
+        checkoutSessionId = encodeURIComponent(checkoutSessionId);
+        return this.post(`/guest_checkout_session/${checkoutSessionId}/update_shipping_address`, body);
+    }
+    /**
+     * 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, body) {
+        checkoutSessionId = encodeURIComponent(checkoutSessionId);
+        return this.post(`/guest_checkout_session/${checkoutSessionId}/update_shipping_option`, body);
+    }
+    /**
+     * (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, body) {
+        checkoutSessionId = encodeURIComponent(checkoutSessionId);
+        return this.post(`/proxy_guest_checkout_session/${checkoutSessionId}/apply_coupon`, body);
+    }
+    /**
+     * 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) {
+        checkoutSessionId = encodeURIComponent(checkoutSessionId);
+        return this.get(`/proxy_guest_checkout_session/${checkoutSessionId}`);
+    }
+    /**
+     * This method creates an eBay proxy guest checkout session, which is a payment flow that requires integration
+     * 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) {
+        return this.post(`/proxy_guest_checkout_session/initiate`, body);
+    }
+    /**
+     * 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, body) {
+        checkoutSessionId = encodeURIComponent(checkoutSessionId);
+        return this.post(`/proxy_guest_checkout_session/${checkoutSessionId}/place_order`, body);
+    }
+    /**
+     * (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, body) {
+        checkoutSessionId = encodeURIComponent(checkoutSessionId);
+        return this.post(`/proxy_guest_checkout_session/${checkoutSessionId}/remove_coupon`, body);
+    }
+    /**
+     * 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, authorization, date, requestNonce, signature, body) {
+        checkoutSessionId = encodeURIComponent(checkoutSessionId);
+        return this.post(`/proxy_guest_checkout_session/${checkoutSessionId}/update_payment_info`, body, {
+            headers: {
+                'Authorization': authorization,
+                'X-EBAY-C-DATE': date,
+                'X-EBAY-C-REQUEST-NONCE': requestNonce,
+                'X-EBAY-C-SIGNATURE': signature
+            }
+        });
+    }
+    /**
+     * 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, body) {
+        checkoutSessionId = encodeURIComponent(checkoutSessionId);
+        return this.post(`/proxy_guest_checkout_session/${checkoutSessionId}/update_quantity`, body);
+    }
+    /**
+     * 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, body) {
+        checkoutSessionId = encodeURIComponent(checkoutSessionId);
+        return this.post(`/proxy_guest_checkout_session/${checkoutSessionId}/update_shipping_address`, body);
+    }
+    /**
+     * 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, body) {
+        checkoutSessionId = encodeURIComponent(checkoutSessionId);
+        return this.post(`/proxy_guest_checkout_session/${checkoutSessionId}/update_shipping_option`, body);
+    }
+    /**
+     * 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) {
+        purchaseOrderId = encodeURIComponent(purchaseOrderId);
+        return this.get(`/guest_purchase_order/${purchaseOrderId}`);
+    }
+    /**
+     * 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) {
+        purchaseOrderId = encodeURIComponent(purchaseOrderId);
+        return this.get(`/purchase_order/${purchaseOrderId}`);
+    }
+}
+exports.default = Order;
+Order.id = 'Order';
+//# sourceMappingURL=index.js.map

package/lib/api/restful/buy/order/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../src/api/restful/buy/order/index.ts"],"names":[],"mappings":";;;;;AAAA,+CAAyB;AAazB;;;GAGG;AACH,MAAqB,KAAM,SAAQ,WAAG;IAIpC,IAAI,QAAQ;QACV,OAAO,eAAe,CAAC;IACzB,CAAC;IAED;;;;;;;;OAQG;IACI,WAAW,CAAC,iBAAyB,EAAE,IAAmB;QAC/D,iBAAiB,GAAG,kBAAkB,CAAC,iBAAiB,CAAC,CAAC;QAC1D,OAAO,IAAI,CAAC,IAAI,CAAC,qBAAqB,iBAAiB,eAAe,EAAE,IAAI,CAAC,CAAC;IAChF,CAAC;IAED;;;;;OAKG;IACI,kBAAkB,CAAC,iBAAyB;QACjD,iBAAiB,GAAG,kBAAkB,CAAC,iBAAiB,CAAC,CAAC;QAC1D,OAAO,IAAI,CAAC,GAAG,CAAC,qBAAqB,iBAAiB,EAAE,CAAC,CAAC;IAC5D,CAAC;IAED;;;;OAIG;IACI,uBAAuB,CAAC,IAAyC;QACtE,OAAO,IAAI,CAAC,IAAI,CAAC,4BAA4B,EAAE,IAAI,CAAC,CAAC;IACvD,CAAC;IAED;;;;;;OAMG;IACI,UAAU,CAAC,iBAAyB;QACzC,iBAAiB,GAAG,kBAAkB,CAAC,iBAAiB,CAAC,CAAC;QAC1D,OAAO,IAAI,CAAC,IAAI,CAAC,qBAAqB,iBAAiB,cAAc,CAAC,CAAC;IACzE,CAAC;IAED;;;;;;;OAOG;IACI,YAAY,CAAC,iBAAyB,EAAE,IAAoB;QACjE,iBAAiB,GAAG,kBAAkB,CAAC,iBAAiB,CAAC,CAAC;QAC1D,OAAO,IAAI,CAAC,IAAI,CAAC,qBAAqB,iBAAiB,gBAAgB,EAAE,IAAI,CAAC,CAAC;IACjF,CAAC;IAED;;;;;;OAMG;IACI,iBAAiB,CAAC,iBAAyB,EAAE,IAA+B;QACjF,iBAAiB,GAAG,kBAAkB,CAAC,iBAAiB,CAAC,CAAC;QAC1D,OAAO,IAAI,CAAC,IAAI,CAAC,qBAAqB,iBAAiB,sBAAsB,EAAE,IAAI,CAAC,CAAC;IACvF,CAAC;IAED;;;;;;OAMG;IACI,cAAc,CAAC,iBAAyB,EAAE,IAAqB;QACpE,iBAAiB,GAAG,kBAAkB,CAAC,iBAAiB,CAAC,CAAC;QAC1D,OAAO,IAAI,CAAC,IAAI,CAAC,qBAAqB,iBAAiB,kBAAkB,EAAE,IAAI,CAAC,CAAC;IACnF,CAAC;IAED;;;;;;OAMG;IACI,iBAAiB,CAAC,iBAAyB,EAAE,IAAqB;QACvE,iBAAiB,GAAG,kBAAkB,CAAC,iBAAiB,CAAC,CAAC;QAC1D,OAAO,IAAI,CAAC,IAAI,CAAC,qBAAqB,iBAAiB,kBAAkB,EAAE,IAAI,CAAC,CAAC;IACnF,CAAC;IAED;;;;;;OAMG;IACI,qBAAqB,CAAC,iBAAyB,EAAE,IAA0B;QAChF,iBAAiB,GAAG,kBAAkB,CAAC,iBAAiB,CAAC,CAAC;QAC1D,OAAO,IAAI,CAAC,IAAI,CAAC,qBAAqB,iBAAiB,0BAA0B,EAAE,IAAI,CAAC,CAAC;IAC3F,CAAC;IAED;;;;;;OAMG;IACI,oBAAoB,CAAC,iBAAyB,EAAE,IAA2B;QAChF,iBAAiB,GAAG,kBAAkB,CAAC,iBAAiB,CAAC,CAAC;QAC1D,OAAO,IAAI,CAAC,IAAI,CAAC,qBAAqB,iBAAiB,yBAAyB,EAAE,IAAI,CAAC,CAAC;IAC1F,CAAC;IAED;;;;;;;;OAQG;IACI,gBAAgB,CAAC,iBAAyB,EAAE,IAAoB;QACrE,iBAAiB,GAAG,kBAAkB,CAAC,iBAAiB,CAAC,CAAC;QAC1D,OAAO,IAAI,CAAC,IAAI,CAAC,2BAA2B,iBAAiB,eAAe,EAAE,IAAI,CAAC,CAAC;IACtF,CAAC;IAED;;;;;;OAMG;IACI,uBAAuB,CAAC,iBAAyB;QACtD,iBAAiB,GAAG,kBAAkB,CAAC,iBAAiB,CAAC,CAAC;QAC1D,OAAO,IAAI,CAAC,GAAG,CAAC,2BAA2B,iBAAiB,EAAE,CAAC,CAAC;IAClE,CAAC;IAED;;;;OAIG;IACI,4BAA4B,CAAC,IAA6B;QAC/D,OAAO,IAAI,CAAC,IAAI,CAAC,kCAAkC,EAAE,IAAI,CAAC,CAAC;IAC7D,CAAC;IAED;;;;;;OAMG;IACI,oBAAoB,CAAC,iBAAyB,EAAE,IAA6B;QAClF,iBAAiB,GAAG,kBAAkB,CAAC,iBAAiB,CAAC,CAAC;QAC1D,OAAO,IAAI,CAAC,IAAI,CAAC,2BAA2B,iBAAiB,mBAAmB,EAAE,IAAI,CAAC,CAAC;IAC1F,CAAC;IAED;;;;;;OAMG;IACI,eAAe,CAAC,iBAAyB,EAAE,IAA6B;QAC7E,iBAAiB,GAAG,kBAAkB,CAAC,iBAAiB,CAAC,CAAC;QAC1D,OAAO,IAAI,CAAC,IAAI,CAAC,2BAA2B,iBAAiB,cAAc,EAAE,IAAI,CAAC,CAAC;IACrF,CAAC;IAED;;;;;;;OAOG;IACI,iBAAiB,CAAC,iBAAyB,EAAE,IAAoB;QACtE,iBAAiB,GAAG,kBAAkB,CAAC,iBAAiB,CAAC,CAAC;QAC1D,OAAO,IAAI,CAAC,IAAI,CAAC,2BAA2B,iBAAiB,gBAAgB,EAAE,IAAI,CAAC,CAAC;IACvF,CAAC;IAED;;;;;;OAMG;IACI,sBAAsB,CAAC,iBAAyB,EAAE,IAA+B;QACtF,iBAAiB,GAAG,kBAAkB,CAAC,iBAAiB,CAAC,CAAC;QAC1D,OAAO,IAAI,CAAC,IAAI,CAAC,2BAA2B,iBAAiB,sBAAsB,EAAE,IAAI,CAAC,CAAC;IAC7F,CAAC;IAED;;;;;;OAMG;IACI,mBAAmB,CAAC,iBAAyB,EAAE,IAAqB;QACzE,iBAAiB,GAAG,kBAAkB,CAAC,iBAAiB,CAAC,CAAC;QAC1D,OAAO,IAAI,CAAC,IAAI,CAAC,2BAA2B,iBAAiB,kBAAkB,EAAE,IAAI,CAAC,CAAC;IACzF,CAAC;IAED;;;;;;OAMG;IACI,0BAA0B,CAAC,iBAAyB,EAAE,IAA0B;QACrF,iBAAiB,GAAG,kBAAkB,CAAC,iBAAiB,CAAC,CAAC;QAC1D,OAAO,IAAI,CAAC,IAAI,CAAC,2BAA2B,iBAAiB,0BAA0B,EAAE,IAAI,CAAC,CAAC;IACjG,CAAC;IAED;;;;;;OAMG;IACI,yBAAyB,CAAC,iBAAyB,EAAE,IAA2B;QACrF,iBAAiB,GAAG,kBAAkB,CAAC,iBAAiB,CAAC,CAAC;QAC1D,OAAO,IAAI,CAAC,IAAI,CAAC,2BAA2B,iBAAiB,yBAAyB,EAAE,IAAI,CAAC,CAAC;IAChG,CAAC;IAED;;;;;;;OAOG;IACI,qBAAqB,CAAC,iBAAyB,EAAE,IAAoB;QAC1E,iBAAiB,GAAG,kBAAkB,CAAC,iBAAiB,CAAC,CAAC;QAC1D,OAAO,IAAI,CAAC,IAAI,CAAC,iCAAiC,iBAAiB,eAAe,EAAE,IAAI,CAAC,CAAC;IAC5F,CAAC;IAED;;;;;OAKG;IACI,4BAA4B,CAAC,iBAAyB;QAC3D,iBAAiB,GAAG,kBAAkB,CAAC,iBAAiB,CAAC,CAAC;QAC1D,OAAO,IAAI,CAAC,GAAG,CAAC,iCAAiC,iBAAiB,EAAE,CAAC,CAAC;IACxE,CAAC;IAED;;;;;;OAMG;IACI,iCAAiC,CAAC,IAA6B;QACpE,OAAO,IAAI,CAAC,IAAI,CAAC,wCAAwC,EAAE,IAAI,CAAC,CAAC;IACnE,CAAC;IAED;;;;;;;OAOG;IACI,oBAAoB,CAAC,iBAAyB,EAAE,IAA6B;QAClF,iBAAiB,GAAG,kBAAkB,CAAC,iBAAiB,CAAC,CAAC;QAC1D,OAAO,IAAI,CAAC,IAAI,CAAC,iCAAiC,iBAAiB,cAAc,EAAE,IAAI,CAAC,CAAC;IAC3F,CAAC;IAED;;;;;;;OAOG;IACI,sBAAsB,CAAC,iBAAyB,EAAE,IAAoB;QAC3E,iBAAiB,GAAG,kBAAkB,CAAC,iBAAiB,CAAC,CAAC;QAC1D,OAAO,IAAI,CAAC,IAAI,CAAC,iCAAiC,iBAAiB,gBAAgB,EAAE,IAAI,CAAC,CAAC;IAC7F,CAAC;IAED;;;;;;;;;;;OAWG;IACI,2BAA2B,CAChC,iBAAyB,EACzB,aAAqB,EACrB,IAAY,EACZ,YAAoB,EACpB,SAAiB,EACjB,IAA+B;QAE/B,iBAAiB,GAAG,kBAAkB,CAAC,iBAAiB,CAAC,CAAC;QAC1D,OAAO,IAAI,CAAC,IAAI,CAAC,iCAAiC,iBAAiB,sBAAsB,EAAE,IAAI,EAAE;YAC/F,OAAO,EAAE;gBACP,eAAe,EAAE,aAAa;gBAC9B,eAAe,EAAE,IAAI;gBACrB,wBAAwB,EAAE,YAAY;gBACtC,oBAAoB,EAAE,SAAS;aAChC;SACF,CAAC,CAAC;IACL,CAAC;IAED;;;;;;OAMG;IACI,wBAAwB,CAAC,iBAAyB,EAAE,IAAqB;QAC9E,iBAAiB,GAAG,kBAAkB,CAAC,iBAAiB,CAAC,CAAC;QAC1D,OAAO,IAAI,CAAC,IAAI,CAAC,iCAAiC,iBAAiB,kBAAkB,EAAE,IAAI,CAAC,CAAC;IAC/F,CAAC;IAED;;;;;;OAMG;IACI,+BAA+B,CAAC,iBAAyB,EAAE,IAA0B;QAC1F,iBAAiB,GAAG,kBAAkB,CAAC,iBAAiB,CAAC,CAAC;QAC1D,OAAO,IAAI,CAAC,IAAI,CAAC,iCAAiC,iBAAiB,0BAA0B,EAAE,IAAI,CAAC,CAAC;IACvG,CAAC;IAED;;;;;;OAMG;IACI,8BAA8B,CAAC,iBAAyB,EAAE,IAA2B;QAC1F,iBAAiB,GAAE,kBAAkB,CAAC,iBAAiB,CAAC,CAAC;QACzD,OAAO,IAAI,CAAC,IAAI,CAAC,iCAAiC,iBAAiB,yBAAyB,EAAE,IAAI,CAAC,CAAC;IACtG,CAAC;IAED;;;;;OAKG;IACI,qBAAqB,CAAC,eAAuB;QAClD,eAAe,GAAG,kBAAkB,CAAC,eAAe,CAAC,CAAC;QACtD,OAAO,IAAI,CAAC,GAAG,CAAC,yBAAyB,eAAe,EAAE,CAAC,CAAC;IAC9D,CAAC;IAED;;;;;OAKG;IACI,gBAAgB,CAAC,eAAuB;QAC7C,eAAe,GAAG,kBAAkB,CAAC,eAAe,CAAC,CAAC;QACtD,OAAO,IAAI,CAAC,GAAG,CAAC,mBAAmB,eAAe,EAAE,CAAC,CAAC;IACxD,CAAC;;AA3YH,wBA4YC;AA1YQ,QAAE,GAAG,OAAO,CAAC"}

package/lib/api/restful/commerce/catalog/index.d.ts

@@ -0,0 +1,73 @@
+import Restful from '../../';
+import { CatalogSearchParams } from '../../../../types';
+/**
+ * Use the Catalog API to search the eBay catalog for products on which to base a seller's item listing;
+ */
+export default class Catalog extends Restful {
+    static id: string;
+    get basePath(): string;
+    /**
+     * Note: The three catalog change request methods in the Catalog API are deprecated, and are scheduled to be
+     * decommissioned in Q1 of 2020.
+     *
+     * @param changeRequestId The unique identifier of the change request being requested.
+     */
+    getChangeRequest(changeRequestId: string): Promise<any>;
+    /**
+     * Note: The three catalog change request methods in the Catalog API are deprecated, and are scheduled to be
+     * decommissioned in Q1 of 2020.
+     *
+     * @param filter One or more comma-separated criteria for narrowing down the collection of change requests returned
+     *     by this call.
+     * @param limit The number of change requests to return. This is the result set, a subset of the full collection of
+     *     change requests that match the filter criteria of this call.
+     * @param offset The first change request to return based on its position in the returned collection of change
+     *     requests.
+     */
+    getChangeRequests({ filter, limit, offset }?: {
+        filter?: string;
+        limit?: number;
+        offset?: number;
+    }): Promise<any>;
+    /**
+     * This call retrieves details of the catalog product identified by the eBay product identifier (ePID) specified in
+     * the request.
+     *
+     * @param epid The ePID of the product being requested.
+     */
+    getProduct(epid: string): Promise<any>;
+    /**
+     * This call searches for and retrieves summaries of one or more products in the eBay catalog that match the search
+     * criteria provided by a seller.
+     *
+     * @param params SearchCatalogParams
+     */
+    search(params?: CatalogSearchParams): Promise<any>;
+    /**
+     * This call retrieves an array of all supported aspects, aspect constraints, and aspect values for the specified
+     * catalog product and its associated or suggested categories, as well as the values currently associated with that
+     * product.
+     *
+     * @param epid The unique eBay product identifier of the catalog product that you want to update.
+     * @param acceptLanguage This request header sets the natural language that will be provided in the field values of
+     *     the response payload.
+     * @param otherApplicableCategoryIds Use only if you are also including the primary_category_id parameter in the
+     *     request.
+     * @param primaryCategoryId Use only if the seller believes this product is associated with the wrong primary
+     *     category.
+     * @param marketplaceId Use this header to specify the eBay marketplace identifier.
+     */
+    getProductMetadata(epid: string, { otherApplicableCategoryIds, primaryCategoryId }?: {
+        otherApplicableCategoryIds?: string;
+        primaryCategoryId?: string;
+    }): Promise<any>;
+    /**
+     * This call retrieves an array of all supported aspects, aspect constraints, and aspect values for the specified
+     * eBay categories.
+     *
+     * @param primaryCategoryId The unique identifier of the primary eBay category for which you will retrieve product
+     *     aspects.
+     * @param otherApplicableCategoryIds A string of comma-separated category IDs.
+     */
+    getProductMetadataForCategories(primaryCategoryId: string, otherApplicableCategoryIds?: string): Promise<any>;
+}

package/lib/api/restful/commerce/catalog/index.js

@@ -0,0 +1,108 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const __1 = __importDefault(require("../../"));
+/**
+ * Use the Catalog API to search the eBay catalog for products on which to base a seller's item listing;
+ */
+class Catalog extends __1.default {
+    get basePath() {
+        return '/commerce/catalog/v1_beta';
+    }
+    /**
+     * Note: The three catalog change request methods in the Catalog API are deprecated, and are scheduled to be
+     * decommissioned in Q1 of 2020.
+     *
+     * @param changeRequestId The unique identifier of the change request being requested.
+     */
+    getChangeRequest(changeRequestId) {
+        return this.get(`/change_request/${changeRequestId}`);
+    }
+    /**
+     * Note: The three catalog change request methods in the Catalog API are deprecated, and are scheduled to be
+     * decommissioned in Q1 of 2020.
+     *
+     * @param filter One or more comma-separated criteria for narrowing down the collection of change requests returned
+     *     by this call.
+     * @param limit The number of change requests to return. This is the result set, a subset of the full collection of
+     *     change requests that match the filter criteria of this call.
+     * @param offset The first change request to return based on its position in the returned collection of change
+     *     requests.
+     */
+    getChangeRequests({ filter, limit, offset } = {}) {
+        return this.get(`/change_request`, {
+            params: {
+                filter,
+                limit,
+                offset
+            }
+        });
+    }
+    /**
+     * This call retrieves details of the catalog product identified by the eBay product identifier (ePID) specified in
+     * the request.
+     *
+     * @param epid The ePID of the product being requested.
+     */
+    getProduct(epid) {
+        const e = encodeURIComponent(epid);
+        return this.get(`/product/${e}`);
+    }
+    /**
+     * This call searches for and retrieves summaries of one or more products in the eBay catalog that match the search
+     * criteria provided by a seller.
+     *
+     * @param params SearchCatalogParams
+     */
+    search(params) {
+        return this.get(`/product_summary/search`, {
+            params: {
+                ...(params && params)
+            }
+        });
+    }
+    /**
+     * This call retrieves an array of all supported aspects, aspect constraints, and aspect values for the specified
+     * catalog product and its associated or suggested categories, as well as the values currently associated with that
+     * product.
+     *
+     * @param epid The unique eBay product identifier of the catalog product that you want to update.
+     * @param acceptLanguage This request header sets the natural language that will be provided in the field values of
+     *     the response payload.
+     * @param otherApplicableCategoryIds Use only if you are also including the primary_category_id parameter in the
+     *     request.
+     * @param primaryCategoryId Use only if the seller believes this product is associated with the wrong primary
+     *     category.
+     * @param marketplaceId Use this header to specify the eBay marketplace identifier.
+     */
+    getProductMetadata(epid, { otherApplicableCategoryIds, primaryCategoryId } = {}) {
+        return this.get(`/get_product_metadata`, {
+            params: {
+                epid,
+                other_applicable_category_ids: otherApplicableCategoryIds,
+                primary_category_id: primaryCategoryId
+            }
+        });
+    }
+    /**
+     * This call retrieves an array of all supported aspects, aspect constraints, and aspect values for the specified
+     * eBay categories.
+     *
+     * @param primaryCategoryId The unique identifier of the primary eBay category for which you will retrieve product
+     *     aspects.
+     * @param otherApplicableCategoryIds A string of comma-separated category IDs.
+     */
+    getProductMetadataForCategories(primaryCategoryId, otherApplicableCategoryIds) {
+        return this.get(`/get_product_metadata_for_categories`, {
+            params: {
+                primary_category_id: primaryCategoryId,
+                other_applicable_category_ids: otherApplicableCategoryIds
+            }
+        });
+    }
+}
+exports.default = Catalog;
+Catalog.id = 'Catalog';
+//# sourceMappingURL=index.js.map

package/lib/api/restful/commerce/catalog/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../src/api/restful/commerce/catalog/index.ts"],"names":[],"mappings":";;;;;AAAA,+CAA6B;AAG7B;;GAEG;AACH,MAAqB,OAAQ,SAAQ,WAAO;IAI1C,IAAI,QAAQ;QACV,OAAO,2BAA2B,CAAC;IACrC,CAAC;IAED;;;;;OAKG;IACI,gBAAgB,CAAC,eAAuB;QAC7C,OAAO,IAAI,CAAC,GAAG,CAAC,mBAAmB,eAAe,EAAE,CAAC,CAAC;IACxD,CAAC;IAED;;;;;;;;;;OAUG;IACI,iBAAiB,CAAC,EAAC,MAAM,EAAE,KAAK,EAAE,MAAM,KAA0D,EAAE;QACzG,OAAO,IAAI,CAAC,GAAG,CAAC,iBAAiB,EAAE;YACjC,MAAM,EAAE;gBACN,MAAM;gBACN,KAAK;gBACL,MAAM;aACP;SACF,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACI,UAAU,CAAC,IAAY;QAC5B,MAAM,CAAC,GAAG,kBAAkB,CAAC,IAAI,CAAC,CAAC;QACnC,OAAO,IAAI,CAAC,GAAG,CAAC,YAAY,CAAC,EAAE,CAAC,CAAC;IACnC,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,MAA4B;QACxC,OAAO,IAAI,CAAC,GAAG,CAAC,yBAAyB,EAAE;YACzC,MAAM,EAAE;gBACN,GAAG,CAAC,MAAM,IAAI,MAAM,CAAC;aACtB;SACF,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;OAaG;IACI,kBAAkB,CAAC,IAAY,EACZ,EAAC,0BAA0B,EAAE,iBAAiB,KAG1C,EAAE;QAC9B,OAAO,IAAI,CAAC,GAAG,CAAC,uBAAuB,EAAE;YACvC,MAAM,EAAE;gBACN,IAAI;gBACJ,6BAA6B,EAAE,0BAA0B;gBACzD,mBAAmB,EAAE,iBAAiB;aACvC;SACF,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;OAOG;IACI,+BAA+B,CAAC,iBAAyB,EAAE,0BAAmC;QACnG,OAAO,IAAI,CAAC,GAAG,CAAC,sCAAsC,EAAE;YACtD,MAAM,EAAE;gBACN,mBAAmB,EAAE,iBAAiB;gBACtC,6BAA6B,EAAE,0BAA0B;aAC1D;SACF,CAAC,CAAC;IACL,CAAC;;AA3GH,0BA4GC;AA1GQ,UAAE,GAAG,SAAS,CAAC"}

package/lib/api/restful/commerce/charity/index.d.ts

@@ -0,0 +1,34 @@
+import Restful from '../../';
+/**
+ * The Charity API allows third-party developers to search for and access details on supported charitable organizations.
+ */
+export default class Charity extends Restful {
+    static id: string;
+    get basePath(): string;
+    /**
+     * This call is used to retrieve detailed information about supported charitable organizations.
+     *
+     * @param charityOrgId The unique ID of the charitable organization.
+     */
+    getCharityOrg(charityOrgId: string): Promise<any>;
+    /**
+     * This call is used to retrieve detailed information about supported charitable organizations.
+     *
+     * @param limit The number of items, from the result set, returned in a single page. Valid Values: 1-100 Default: 20
+     * @param offset The number of items that will be skipped in the result set.
+     * @param q A query string that matches the keywords in name, mission statement, or description.
+     * @param registrationIds A comma-separated list of charitable organization registration IDs.
+     */
+    getCharityOrgs({ limit, offset, q, registrationIds }: {
+        limit?: string;
+        offset?: string;
+        q?: string;
+        registrationIds?: string;
+    }): Promise<any>;
+    /**
+     * This call allows users to retrieve the details for a specific charitable organization using its legacy charity ID, which has also been referred to as the charity number, external ID, and PayPal Giving Fund ID.
+     *
+     * @param legacyCharityOrgId The legacy ID of the charitable organization.
+     */
+    getCharityOrgByLegacyId(legacyCharityOrgId: string): Promise<any>;
+}

package/lib/api/restful/commerce/charity/index.js

@@ -0,0 +1,56 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const __1 = __importDefault(require("../../"));
+/**
+ * The Charity API allows third-party developers to search for and access details on supported charitable organizations.
+ */
+class Charity extends __1.default {
+    get basePath() {
+        return '/commerce/charity/v1';
+    }
+    /**
+     * This call is used to retrieve detailed information about supported charitable organizations.
+     *
+     * @param charityOrgId The unique ID of the charitable organization.
+     */
+    getCharityOrg(charityOrgId) {
+        charityOrgId = encodeURIComponent(charityOrgId);
+        return this.get(`/charity_org/${charityOrgId}`);
+    }
+    /**
+     * This call is used to retrieve detailed information about supported charitable organizations.
+     *
+     * @param limit The number of items, from the result set, returned in a single page. Valid Values: 1-100 Default: 20
+     * @param offset The number of items that will be skipped in the result set.
+     * @param q A query string that matches the keywords in name, mission statement, or description.
+     * @param registrationIds A comma-separated list of charitable organization registration IDs.
+     */
+    getCharityOrgs({ limit, offset, q, registrationIds }) {
+        return this.get(`/charity_org`, {
+            params: {
+                limit,
+                offset,
+                q,
+                registration_ids: registrationIds
+            }
+        });
+    }
+    /**
+     * This call allows users to retrieve the details for a specific charitable organization using its legacy charity ID, which has also been referred to as the charity number, external ID, and PayPal Giving Fund ID.
+     *
+     * @param legacyCharityOrgId The legacy ID of the charitable organization.
+     */
+    getCharityOrgByLegacyId(legacyCharityOrgId) {
+        return this.get(`/charity_org/get_charity_org_by_legacy_id`, {
+            params: {
+                legacy_charity_org_id: legacyCharityOrgId
+            }
+        });
+    }
+}
+exports.default = Charity;
+Charity.id = 'Charity';
+//# sourceMappingURL=index.js.map

package/lib/api/restful/commerce/charity/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../src/api/restful/commerce/charity/index.ts"],"names":[],"mappings":";;;;;AAAA,+CAA6B;AAE7B;;GAEG;AACH,MAAqB,OAAQ,SAAQ,WAAO;IAI1C,IAAI,QAAQ;QACV,OAAO,sBAAsB,CAAC;IAChC,CAAC;IAED;;;;OAIG;IACI,aAAa,CAAC,YAAoB;QACvC,YAAY,GAAG,kBAAkB,CAAC,YAAY,CAAC,CAAA;QAC/C,OAAO,IAAI,CAAC,GAAG,CAAC,gBAAgB,YAAY,EAAE,CAAC,CAAC;IAClD,CAAC;IAED;;;;;;;OAOG;IACI,cAAc,CAAC,EACpB,KAAK,EACL,MAAM,EACN,CAAC,EACD,eAAe,EAC2D;QAC1E,OAAO,IAAI,CAAC,GAAG,CAAC,cAAc,EAAE;YAC9B,MAAM,EAAE;gBACN,KAAK;gBACL,MAAM;gBACN,CAAC;gBACD,gBAAgB,EAAE,eAAe;aAClC;SACF,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IACI,uBAAuB,CAAC,kBAA0B;QACvD,OAAO,IAAI,CAAC,GAAG,CAAC,2CAA2C,EAAE;YAC3D,MAAM,EAAE;gBACN,qBAAqB,EAAE,kBAAkB;aAC1C;SACF,CAAC,CAAC;IACL,CAAC;;AArDH,0BAsDC;AApDQ,UAAE,GAAG,SAAS,CAAC"}