ebay-api 1.13.4 → 6.0.0

package/lib/api/restful/postOrder/return/index.js

@@ -0,0 +1,361 @@
+"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("../../"));
+/**
+ * Post-Order Return API
+ */
+class Return extends __1.default {
+    get basePath() {
+        return '/post-order/v2';
+    }
+    get useIaf() {
+        return true;
+    }
+    /**
+     * Create or update a shipping label provided by the seller.
+     *
+     * @param returnId The unique eBay-assigned ID of the return.
+     * @param payload the ProvideLabelRequest
+     */
+    addShippingLabelInfo(returnId, payload) {
+        const id = encodeURIComponent(returnId);
+        return this.post(`/return/${id}/add_shipping_label`, payload);
+    }
+    /**
+     * Cancel a return request.
+     *
+     * @param returnId    The unique eBay-assigned ID of the return request.
+     * @param payload    The CloseReturnRequest.
+     */
+    cancelReturnRequest(returnId, payload) {
+        const id = encodeURIComponent(returnId);
+        if (payload && payload.buyerCloseReason) {
+            payload.buyerCloseReason = payload.buyerCloseReason.trim();
+        }
+        return this.post(`/return/${id}/cancel`, payload);
+    }
+    /**
+     * Check to see if an item is eligible for a return.
+     *
+     * @param payload the CheckEligibilityRequest
+     */
+    checkReturnEligibility(payload) {
+        return this.post(`/return/check_eligibility`, payload);
+    }
+    /**
+     * Validate the eligibility of an existing shipping label.
+     *
+     * @param returnId The unique eBay-assigned ID of the return.
+     */
+    checkShippingLabelEligibility(returnId) {
+        const id = encodeURIComponent(returnId);
+        return this.get(`/return/${id}/check_label_print_eligibility`);
+    }
+    /**
+     * Create a return draft.
+     *
+     * @param payload the SetReturnCreationSessionRequest
+     */
+    createReturnDraft(payload) {
+        return this.post(`/return/draft`, payload);
+    }
+    /**
+     * Request a return for an item.
+     *
+     * @param payload the CreateReturnRequest
+     * @param fieldGroups can be used in the call URI to control the detail level that is returned in response.
+     */
+    createReturnRequest(payload, fieldGroups) {
+        return this.post(`/return`, payload, {
+            params: {
+                fieldgroups: fieldGroups
+            }
+        });
+    }
+    /**
+     * Create an eBay shipping label for the buyer.
+     *
+     * @param returnId The unique eBay-assigned ID of the return.
+     */
+    createReturnShippingLabel(returnId) {
+        const id = encodeURIComponent(returnId);
+        return this.post(`/return/${id}/initiate_shipping_label`);
+    }
+    /**
+     * Delete a file associated with a return draft.
+     *
+     * @param draftId    The unique eBay-assigned ID of the return draft.
+     * @param fileId The unique eBay-assigned ID of the draft file.
+     */
+    deleteReturnDraftFile(draftId, fileId) {
+        draftId = encodeURIComponent(draftId);
+        fileId = encodeURIComponent(fileId);
+        return this.delete(`/return/draft/${draftId}/file/${fileId}`);
+    }
+    /**
+     * Escalate an existing return to eBay customer support.
+     *
+     * @param returnId The unique eBay-assigned ID of the return request.
+     * @param payload the EscalateRequest
+     */
+    escalateReturn(returnId, payload) {
+        const id = encodeURIComponent(returnId);
+        return this.post(`/return/${id}/escalate`, payload);
+    }
+    /**
+     * Retrieve the details of a specific return.
+     *
+     * @param returnId The unique eBay-assigned ID of the return request.
+     * @param fieldGroups can be used in the call URI to control the detail level that is returned in response.
+     */
+    getReturn(returnId, fieldGroups) {
+        returnId = encodeURIComponent(returnId);
+        return this.get(`/return/${returnId}`, {
+            params: {
+                fieldgroups: fieldGroups
+            }
+        });
+    }
+    /**
+     * Retrieve a return draft.
+     *
+     * @param returnId The unique eBay-assigned ID of the return request.
+     */
+    getReturnDraft(returnId) {
+        const id = encodeURIComponent(returnId);
+        return this.get(`/return/draft/${id}`);
+    }
+    /**
+     * Retrieve the files associated with a return draft.
+     *
+     * @param returnId    The unique eBay-assigned ID of the return draft.
+     */
+    getReturnDraftFiles(returnId) {
+        const id = encodeURIComponent(returnId);
+        return this.get(`/return/draft/${id}/files`);
+    }
+    /**
+     * Retrieve the cost estimate of a refund with its shipping cost.
+     *
+     * @param payload the GetEstimateRequest
+     */
+    getReturnEstimate(payload) {
+        return this.post(`/return/estimate`, payload);
+    }
+    /**
+     * Retrieve the cost estimate of a refund with its shipping cost.
+     *
+     * @param returnId The unique eBay-assigned ID of the return.
+     */
+    getReturnFiles(returnId) {
+        const id = encodeURIComponent(returnId);
+        return this.get(`/return/${id}/files`);
+    }
+    /**
+     * Retrieve seller's return preferences.
+     */
+    getReturnPreferences() {
+        return this.get(`/return/preference`);
+    }
+    /**
+     * Retrieve the data for an existing shipping label.
+     *
+     * @param returnId The unique eBay-assigned ID of the return.
+     */
+    getReturnShippingLabel(returnId) {
+        returnId = encodeURIComponent(returnId);
+        return this.get(`/return/${returnId}/get_shipping_label`);
+    }
+    /**
+     * Retrieve shipment tracking activity for a return.
+     *
+     * @param returnId The unique eBay-assigned ID of the return.
+     * @param carrierUsed The shipping carrier used to to ship the package.
+     * @param trackingNumber The tracking number of the package.
+     */
+    getShipmentTrackingInfo(returnId, carrierUsed, trackingNumber) {
+        returnId = encodeURIComponent(returnId);
+        return this.get(`/return/${returnId}/tracking`, {
+            params: {
+                carrier_used: carrierUsed,
+                tracking_number: trackingNumber
+            }
+        });
+    }
+    /**
+     * Issue a refund.
+     *
+     * @param returnId The unique eBay-assigned ID of the return.
+     * @param payload The IssueRefundRequest.
+     */
+    issueReturnRefund(returnId, payload) {
+        returnId = encodeURIComponent(returnId);
+        return this.post(`/return/${returnId}/issue_refund`, payload);
+    }
+    /**
+     * Mark a returned item as received.
+     *
+     * @param returnId The unique eBay-assigned ID of the return.
+     * @param payload the MarkAsReceivedRequest
+     */
+    markReturnReceived(returnId, payload) {
+        returnId = encodeURIComponent(returnId);
+        return this.post(`/return/${returnId}/mark_as_received`, payload);
+    }
+    /**
+     * Mark a refund as received.
+     *
+     * @param returnId The unique eBay-assigned ID of the return.
+     */
+    markReturnRefundReceived(returnId) {
+        returnId = encodeURIComponent(returnId);
+        return this.post(`/return/${returnId}/mark_refund_received`);
+    }
+    /**
+     * Notify the buyer that a refund has been issued.
+     *
+     * @param returnId The unique eBay-assigned ID of the return.
+     * @param payload the MarkRefundSentRequest
+     */
+    markReturnRefundSent(returnId, payload) {
+        returnId = encodeURIComponent(returnId);
+        return this.post(`/return/${returnId}/mark_refund_sent`, payload);
+    }
+    /**
+     * Mark a return as shipped.
+     *
+     * @param returnId    The unique eBay-assigned ID of the return.
+     * @param payload the MarkAsShippedRequest
+     */
+    markReturnShipped(returnId, payload) {
+        returnId = encodeURIComponent(returnId);
+        return this.post(`/return/${returnId}/mark_as_shipped`, payload);
+    }
+    /**
+     * Perform an action on a return, such as APPROVE.
+     *
+     * @param returnId The unique eBay-assigned ID of the return.
+     * @param payload the DecideReturnRequest
+     */
+    processReturnRequest(returnId, payload) {
+        returnId = encodeURIComponent(returnId);
+        return this.post(`/return/${returnId}/decide`, payload);
+    }
+    /**
+     * Retrieve details on items being returned.
+     *
+     * @param params the SearchReturnParams
+     */
+    search(params) {
+        return this.get(`/return/search`, {
+            params
+        });
+    }
+    /**
+     * Send a message to the buyer or seller regarding a return.
+     *
+     * @param returnId The unique eBay-assigned ID of the return.
+     * @param payload the SendMessageRequest
+     */
+    sendReturnMessage(returnId, payload) {
+        returnId = encodeURIComponent(returnId);
+        return this.post(`/return/${returnId}/send_message`, payload);
+    }
+    /**
+     * Send a shipping label to an email address.
+     *
+     * @param returnId    The unique eBay-assigned ID of the return.
+     * @param toEmailAddress The recipient's email address is specified in this field.
+     */
+    sendReturnShippingLabel(returnId, toEmailAddress) {
+        returnId = encodeURIComponent(returnId);
+        return this.post(`/return/${returnId}/send_shipping_label`, {}, {
+            params: {
+                to_email_address: toEmailAddress
+            }
+        });
+    }
+    /**
+     * Send a shipping label to an email address.
+     *
+     * @param rmaRequired This field is included and set to true if the seller wishes to require that the buyer provide
+     *     a Return Merchandise Authorization (RMA) when returning an item.
+     */
+    setReturnPreferences(rmaRequired) {
+        return this.post(`/return/preference`, {
+            rmaRequired
+        });
+    }
+    /**
+     * Activate the files associated with a return.
+     *
+     * @param returnId    The unique eBay-assigned ID of the return.
+     * @param filePurpose This value is used to indicate if the file(s) are being used to provide more information
+     *     about the condition of the item, or intended to provide more information about shipment tracking or about
+     *     the shipping label.
+     */
+    submitReturnFile(returnId, filePurpose) {
+        returnId = encodeURIComponent(returnId);
+        return this.post(`/return/${returnId}/file/submit`, {
+            filePurpose
+        });
+    }
+    /**
+     * Update an existing return draft.
+     *
+     * @param draftId The unique eBay-assigned ID of the return draft.
+     * @param returnRequest the ReturnRequestType
+     */
+    updateReturnDraft(draftId, returnRequest) {
+        draftId = encodeURIComponent(draftId);
+        return this.put(`/return/draft/${draftId}`, {
+            returnRequest
+        });
+    }
+    /**
+     * Update shipment tracking information.
+     *
+     * @param returnId The unique eBay-assigned ID of the return request.
+     * @param payload the UpdateTrackingRequest
+     */
+    updateShipmentTrackingInfo(returnId, payload) {
+        returnId = encodeURIComponent(returnId);
+        return this.put(`/return/${returnId}/update_tracking`, payload);
+    }
+    /**
+     * Upload the files relating to a return draft.
+     *
+     * @param draftId The unique eBay-assigned ID of the return draft.
+     * @param payload the UploadFileRequest
+     */
+    uploadReturnDraftFile(draftId, payload) {
+        draftId = encodeURIComponent(draftId);
+        return this.post(`/return/draft/${draftId}/file/upload`, payload);
+    }
+    /**
+     * Upload the files relating to a return.
+     *
+     * @param returnId The unique eBay-assigned ID of the return.
+     * @param payload the UploadFileRequest
+     */
+    uploadReturnFile(returnId, payload) {
+        returnId = encodeURIComponent(returnId);
+        return this.post(`/return/${returnId}/file/upload`, payload);
+    }
+    /**
+     * Void a shipping label.
+     *
+     * @param returnId The unique eBay-assigned ID of the return.
+     * @param payload the VoidLabelRequest
+     */
+    voidShippingLabel(returnId, payload) {
+        returnId = encodeURIComponent(returnId);
+        return this.post(`/return/${returnId}/void_shipping_label`, payload);
+    }
+}
+exports.default = Return;
+Return.id = 'Return';
+//# sourceMappingURL=index.js.map

package/lib/api/restful/postOrder/return/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../src/api/restful/postOrder/return/index.ts"],"names":[],"mappings":";;;;;AAAA,+CAA6B;AAuB7B;;GAEG;AACH,MAAqB,MAAO,SAAQ,WAAO;IAIzC,IAAI,QAAQ;QACV,OAAO,gBAAgB,CAAC;IAC1B,CAAC;IAED,IAAI,MAAM;QACR,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;OAKG;IACI,oBAAoB,CAAC,QAAgB,EAAE,OAA4B;QACxE,MAAM,EAAE,GAAG,kBAAkB,CAAC,QAAQ,CAAC,CAAC;QACxC,OAAO,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,qBAAqB,EAAE,OAAO,CAAC,CAAC;IAChE,CAAC;IAED;;;;;OAKG;IACI,mBAAmB,CAAC,QAAgB,EAAE,OAA4B;QACvE,MAAM,EAAE,GAAG,kBAAkB,CAAC,QAAQ,CAAC,CAAC;QACxC,IAAI,OAAO,IAAI,OAAO,CAAC,gBAAgB,EAAE;YACvC,OAAO,CAAC,gBAAgB,GAAG,OAAO,CAAC,gBAAgB,CAAC,IAAI,EAAE,CAAC;SAC5D;QACD,OAAO,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,SAAS,EAAE,OAAO,CAAC,CAAC;IACpD,CAAC;IAED;;;;OAIG;IACI,sBAAsB,CAAC,OAAgC;QAC5D,OAAO,IAAI,CAAC,IAAI,CAAC,2BAA2B,EAAE,OAAO,CAAC,CAAC;IACzD,CAAC;IAED;;;;OAIG;IACI,6BAA6B,CAAC,QAAgB;QACnD,MAAM,EAAE,GAAG,kBAAkB,CAAC,QAAQ,CAAC,CAAC;QACxC,OAAO,IAAI,CAAC,GAAG,CAAC,WAAW,EAAE,gCAAgC,CAAC,CAAC;IACjE,CAAC;IAED;;;;OAIG;IACI,iBAAiB,CAAC,OAAwC;QAC/D,OAAO,IAAI,CAAC,IAAI,CAAC,eAAe,EAAE,OAAO,CAAC,CAAC;IAC7C,CAAC;IAED;;;;;OAKG;IACI,mBAAmB,CAAC,OAA4B,EAAE,WAAqC;QAC5F,OAAO,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,OAAO,EAAE;YACnC,MAAM,EAAE;gBACN,WAAW,EAAE,WAAW;aACzB;SACF,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IACI,yBAAyB,CAAC,QAAgB;QAC/C,MAAM,EAAE,GAAG,kBAAkB,CAAC,QAAQ,CAAC,CAAC;QACxC,OAAO,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,0BAA0B,CAAC,CAAC;IAC5D,CAAC;IAED;;;;;OAKG;IACI,qBAAqB,CAAC,OAAe,EAAE,MAAc;QAC1D,OAAO,GAAG,kBAAkB,CAAC,OAAO,CAAC,CAAC;QACtC,MAAM,GAAG,kBAAkB,CAAC,MAAM,CAAC,CAAC;QAEpC,OAAO,IAAI,CAAC,MAAM,CAAC,iBAAiB,OAAO,SAAS,MAAM,EAAE,CAAC,CAAC;IAChE,CAAC;IAED;;;;;OAKG;IACI,cAAc,CAAC,QAAgB,EAAE,OAAyB;QAC/D,MAAM,EAAE,GAAG,kBAAkB,CAAC,QAAQ,CAAC,CAAC;QACxC,OAAO,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,WAAW,EAAE,OAAO,CAAC,CAAC;IACtD,CAAC;IAED;;;;;OAKG;IACI,SAAS,CAAC,QAAgB,EAAE,WAAqC;QACtE,QAAQ,GAAG,kBAAkB,CAAC,QAAQ,CAAC,CAAC;QACxC,OAAO,IAAI,CAAC,GAAG,CAAC,WAAW,QAAQ,EAAE,EAAE;YACrC,MAAM,EAAE;gBACN,WAAW,EAAE,WAAW;aACzB;SACF,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IACI,cAAc,CAAC,QAAgB;QACpC,MAAM,EAAE,GAAG,kBAAkB,CAAC,QAAQ,CAAC,CAAC;QACxC,OAAO,IAAI,CAAC,GAAG,CAAC,iBAAiB,EAAE,EAAE,CAAC,CAAC;IACzC,CAAC;IAED;;;;OAIG;IACI,mBAAmB,CAAC,QAAgB;QACzC,MAAM,EAAE,GAAG,kBAAkB,CAAC,QAAQ,CAAC,CAAC;QACxC,OAAO,IAAI,CAAC,GAAG,CAAC,iBAAiB,EAAE,QAAQ,CAAC,CAAC;IAC/C,CAAC;IAED;;;;OAIG;IACI,iBAAiB,CAAC,OAA2B;QAClD,OAAO,IAAI,CAAC,IAAI,CAAC,kBAAkB,EAAE,OAAO,CAAC,CAAC;IAChD,CAAC;IAED;;;;OAIG;IACI,cAAc,CAAC,QAAgB;QACpC,MAAM,EAAE,GAAG,kBAAkB,CAAC,QAAQ,CAAC,CAAC;QACxC,OAAO,IAAI,CAAC,GAAG,CAAC,WAAW,EAAE,QAAQ,CAAC,CAAC;IACzC,CAAC;IAED;;OAEG;IACI,oBAAoB;QACzB,OAAO,IAAI,CAAC,GAAG,CAAC,oBAAoB,CAAC,CAAC;IACxC,CAAC;IAED;;;;OAIG;IACI,sBAAsB,CAAC,QAAgB;QAC5C,QAAQ,GAAG,kBAAkB,CAAC,QAAQ,CAAC,CAAC;QACxC,OAAO,IAAI,CAAC,GAAG,CAAC,WAAW,QAAQ,qBAAqB,CAAC,CAAC;IAC5D,CAAC;IAED;;;;;;OAMG;IACI,uBAAuB,CAAC,QAAgB,EAAE,WAAmB,EAAE,cAAsB;QAC1F,QAAQ,GAAG,kBAAkB,CAAC,QAAQ,CAAC,CAAC;QACxC,OAAO,IAAI,CAAC,GAAG,CAAC,WAAW,QAAQ,WAAW,EAAE;YAC9C,MAAM,EAAE;gBACN,YAAY,EAAE,WAAW;gBACzB,eAAe,EAAE,cAAc;aAChC;SACF,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACI,iBAAiB,CAAC,QAAgB,EAAE,OAAoC;QAC7E,QAAQ,GAAG,kBAAkB,CAAC,QAAQ,CAAC,CAAC;QACxC,OAAO,IAAI,CAAC,IAAI,CAAC,WAAW,QAAQ,eAAe,EAAE,OAAO,CAAC,CAAC;IAChE,CAAC;IAED;;;;;OAKG;IACI,kBAAkB,CAAC,QAAgB,EAAE,OAA+B;QACzE,QAAQ,GAAG,kBAAkB,CAAC,QAAQ,CAAC,CAAC;QACxC,OAAO,IAAI,CAAC,IAAI,CAAC,WAAW,QAAQ,mBAAmB,EAAE,OAAO,CAAC,CAAC;IACpE,CAAC;IAED;;;;OAIG;IACI,wBAAwB,CAAC,QAAgB;QAC9C,QAAQ,GAAG,kBAAkB,CAAC,QAAQ,CAAC,CAAC;QACxC,OAAO,IAAI,CAAC,IAAI,CAAC,WAAW,QAAQ,uBAAuB,CAAC,CAAC;IAC/D,CAAC;IAED;;;;;OAKG;IACI,oBAAoB,CAAC,QAAgB,EAAE,OAA8B;QAC1E,QAAQ,GAAG,kBAAkB,CAAC,QAAQ,CAAC,CAAC;QACxC,OAAO,IAAI,CAAC,IAAI,CAAC,WAAW,QAAQ,mBAAmB,EAAE,OAAO,CAAC,CAAC;IACpE,CAAC;IAED;;;;;OAKG;IACI,iBAAiB,CAAC,QAAgB,EAAE,OAA8B;QACvE,QAAQ,GAAG,kBAAkB,CAAC,QAAQ,CAAC,CAAC;QACxC,OAAO,IAAI,CAAC,IAAI,CAAC,WAAW,QAAQ,kBAAkB,EAAE,OAAO,CAAC,CAAC;IACnE,CAAC;IAED;;;;;OAKG;IACI,oBAAoB,CAAC,QAAgB,EAAE,OAA4B;QACxE,QAAQ,GAAG,kBAAkB,CAAC,QAAQ,CAAC,CAAC;QACxC,OAAO,IAAI,CAAC,IAAI,CAAC,WAAW,QAAQ,SAAS,EAAE,OAAO,CAAC,CAAC;IAC1D,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,MAA0B;QACtC,OAAO,IAAI,CAAC,GAAG,CAAC,gBAAgB,EAAE;YAChC,MAAM;SACP,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACI,iBAAiB,CAAC,QAAgB,EAAE,OAA4B;QACrE,QAAQ,GAAG,kBAAkB,CAAC,QAAQ,CAAC,CAAC;QACxC,OAAO,IAAI,CAAC,IAAI,CAAC,WAAW,QAAQ,eAAe,EAAE,OAAO,CAAC,CAAC;IAChE,CAAC;IAED;;;;;OAKG;IACI,uBAAuB,CAAC,QAAgB,EAAE,cAAuB;QACtE,QAAQ,GAAG,kBAAkB,CAAC,QAAQ,CAAC,CAAC;QACxC,OAAO,IAAI,CAAC,IAAI,CAAC,WAAW,QAAQ,sBAAsB,EAAE,EAAE,EAAE;YAC9D,MAAM,EAAE;gBACN,gBAAgB,EAAE,cAAc;aACjC;SACF,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACI,oBAAoB,CAAC,WAAoB;QAC9C,OAAO,IAAI,CAAC,IAAI,CAAC,oBAAoB,EAAE;YACrC,WAAW;SACZ,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;OAOG;IACI,gBAAgB,CAAC,QAAgB,EAAE,WAAyB;QACjE,QAAQ,GAAG,kBAAkB,CAAC,QAAQ,CAAC,CAAC;QACxC,OAAO,IAAI,CAAC,IAAI,CAAC,WAAW,QAAQ,cAAc,EAAE;YAClD,WAAW;SACZ,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACI,iBAAiB,CAAC,OAAe,EAAE,aAAgC;QACxE,OAAO,GAAG,kBAAkB,CAAC,OAAO,CAAC,CAAC;QACtC,OAAO,IAAI,CAAC,GAAG,CAAC,iBAAiB,OAAO,EAAE,EAAE;YAC1C,aAAa;SACd,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACI,0BAA0B,CAAC,QAAgB,EAAE,OAA8B;QAChF,QAAQ,GAAG,kBAAkB,CAAC,QAAQ,CAAC,CAAC;QACxC,OAAO,IAAI,CAAC,GAAG,CAAC,WAAW,QAAQ,kBAAkB,EAAE,OAAO,CAAC,CAAC;IAClE,CAAC;IAED;;;;;OAKG;IACI,qBAAqB,CAAC,OAAe,EAAE,OAA0B;QACtE,OAAO,GAAG,kBAAkB,CAAC,OAAO,CAAC,CAAC;QACtC,OAAO,IAAI,CAAC,IAAI,CAAC,iBAAiB,OAAO,cAAc,EAAE,OAAO,CAAC,CAAC;IACpE,CAAC;IAED;;;;;OAKG;IACI,gBAAgB,CAAC,QAAgB,EAAE,OAA0B;QAClE,QAAQ,GAAG,kBAAkB,CAAC,QAAQ,CAAC,CAAC;QACxC,OAAO,IAAI,CAAC,IAAI,CAAC,WAAW,QAAQ,cAAc,EAAE,OAAO,CAAC,CAAC;IAC/D,CAAC;IAED;;;;;OAKG;IACI,iBAAiB,CAAC,QAAgB,EAAE,OAAyB;QAClE,QAAQ,GAAG,kBAAkB,CAAC,QAAQ,CAAC,CAAC;QACxC,OAAO,IAAI,CAAC,IAAI,CAAC,WAAW,QAAQ,sBAAsB,EAAE,OAAO,CAAC,CAAC;IACvE,CAAC;;AAjYH,yBAkYC;AAhYQ,SAAE,GAAG,QAAQ,CAAC"}

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

@@ -0,0 +1,217 @@
+import Restful from '../../';
+import { FulfillmentPolicyRequest, PaymentPolicyRequest, Program, ReturnPolicyRequest, SalesTaxBase } from '../../../../types';
+import { PaymentsProgramType } from '../../../../enums';
+/**
+ * The <b>Account API</b> gives sellers the ability to configure their eBay seller accounts,
+ * including the seller's policies (the Fulfillment Policy, Payment Policy, and Return Policy),
+ * opt in and out of eBay seller programs, configure sales tax tables, and get account information.
+ */
+export default class Account extends Restful {
+    static id: string;
+    get basePath(): string;
+    /**
+     * This method retrieves all the fulfillment policies configured for the marketplace you specify using the
+     * marketplace_id query parameter.
+     *
+     * @param marketplaceId This query parameter specifies the eBay marketplace of the policies you want to retrieve.
+     */
+    getFulfillmentPolicies(marketplaceId: string): Promise<any>;
+    /**
+     * This method creates a new fulfillment policy where the policy encapsulates seller's terms for fulfilling item
+     * purchases.
+     *
+     * @param body Request to create a seller account fulfillment policy.
+     */
+    createFulfillmentPolicy(body: FulfillmentPolicyRequest): Promise<any>;
+    /**
+     * This method updates an existing fulfillment policy.
+     *
+     * @param fulfillmentPolicyId This path parameter specifies the ID of the fulfillment policy you want to update.
+     * @param body Request to create a seller account fulfillment policy.
+     */
+    updateFulfillmentPolicy(fulfillmentPolicyId: string, body: FulfillmentPolicyRequest): Promise<any>;
+    /**
+     * This method deletes a fulfillment policy.
+     *
+     * @param fulfillmentPolicyId This path parameter specifies the ID of the fulfillment policy to delete.
+     */
+    deleteFulfillmentPolicy(fulfillmentPolicyId: string): Promise<any>;
+    /**
+     * This method retrieves the complete details of a fulfillment policy.
+     * Supply the ID of the policy you want to retrieve using the fulfillmentPolicyId path parameter.
+     *
+     * @param fulfillmentPolicyId This path parameter specifies the ID of the fulfillment policy you want to retrieve.
+     */
+    getFulfillmentPolicy(fulfillmentPolicyId: string): Promise<any>;
+    /**
+     * This method retrieves the complete details for a single fulfillment policy.
+     *
+     * @param marketplaceId This query parameter specifies the eBay marketplace of the policy you want to retrieve.
+     * @param name This query parameter specifies the user-defined name of the fulfillment policy you want to retrieve.
+     */
+    getFulfillmentPolicyByName(marketplaceId: string, name: string): Promise<any>;
+    /**
+     * This method retrieves all the payment policies configured for the marketplace you specify using the
+     * marketplace_id query parameter.
+     *
+     * @param marketplaceId This query parameter specifies the eBay marketplace of the policy you want to retrieve.
+     */
+    getPaymentPolicies(marketplaceId: string): Promise<any>;
+    /**
+     * This method retrieves the complete details of a payment policy. Supply the ID of the policy you want to retrieve
+     * using the paymentPolicyId path parameter.
+     *
+     * @param paymentPolicyId This path parameter specifies the ID of the payment policy you want to retrieve.
+     */
+    getPaymentPolicy(paymentPolicyId: string): Promise<any>;
+    /**
+     * This method creates a new payment policy where the policy encapsulates seller's terms for purchase payments.
+     *
+     * @param body Payment policy request
+     */
+    createPaymentPolicy(body: PaymentPolicyRequest): Promise<any>;
+    /**
+     * This method updates an existing payment policy.
+     *
+     * @param paymentPolicyId This path parameter specifies the ID of the payment policy you want to update.
+     * @param body Payment policy request
+     */
+    updatePaymentPolicy(paymentPolicyId: string, body: PaymentPolicyRequest): Promise<any>;
+    /**
+     * This method updates an existing payment policy.
+     *
+     * @param paymentPolicyId This path parameter specifies the ID of the payment policy you want to delete.
+     */
+    deletePaymentPolicy(paymentPolicyId: string): Promise<any>;
+    /**
+     * This method retrieves the complete details of a single payment policy.
+     *
+     * @param marketplaceId This query parameter specifies the eBay marketplace of the policy you want to retrieve.
+     * @param name This query parameter specifies the user-defined name of the payment policy you want to retrieve.
+     */
+    getPaymentPolicyByName(marketplaceId: string, name: string): Promise<any>;
+    /**
+     * This method returns whether or not the user is opted-in to the payment program.
+     *
+     * @param marketplaceId This query parameter specifies the eBay marketplace of the policy you want to retrieve.
+     * @param paymentsProgramType This path parameter specifies the payments program whose status is returned by the
+     *     call.
+     */
+    getPaymentsProgram(marketplaceId: string, paymentsProgramType: PaymentsProgramType): Promise<any>;
+    /**
+     * This method retrieves a seller's onboarding status of eBay managed payments for a specified marketplace.
+     *
+     * @param marketplaceId This query parameter specifies the eBay marketplace of the policy you want to retrieve.
+     * @param paymentsProgramType This path parameter specifies the payments program whose status is returned by the
+     *     call.
+     */
+    getPaymentsProgramOnboarding(marketplaceId: string, paymentsProgramType: PaymentsProgramType): Promise<any>;
+    /**
+     * This method retrieves the seller's current set of privileges.
+     */
+    getPrivileges(): Promise<any>;
+    /**
+     * This method gets a list of the seller programs that the seller has opted-in to.
+     */
+    getOptedInPrograms(): Promise<any>;
+    /**
+     * This method opts the seller in to an eBay seller program.
+     *
+     * @param body Program being opted-in to.
+     */
+    optInToProgram(body?: Program): Promise<any>;
+    /**
+     * This method opts the seller out of a seller program to which you have previously opted-in to.
+     *
+     * @param body Program being opted-out of.
+     */
+    optOutOfProgram(body?: Program): Promise<any>;
+    /**
+     * This method retrieves a seller's shipping rate tables for the country specified in the country_code query
+     * parameter.
+     *
+     * @param countryCode This query parameter specifies the two-letter ISO 3166-1 Alpha-2 code of country for which
+     *     you want shipping-rate table information.
+     */
+    getRateTables(countryCode?: string): Promise<any>;
+    /**
+     * This method retrieves all the return policies configured for the marketplace you specify using the
+     * marketplace_id query parameter.
+     *
+     * @param marketplaceId This query parameter specifies the ID of the eBay marketplace of the policy you want to
+     *     retrieve.
+     */
+    getReturnPolicies(marketplaceId: string): Promise<any>;
+    /**
+     * This method retrieves the complete details of the return policy specified by the returnPolicyId path parameter.
+     *
+     * @param returnPolicyId This path parameter specifies the of the return policy you want to retrieve.
+     */
+    getReturnPolicy(returnPolicyId: string): Promise<any>;
+    /**
+     * This method creates a new return policy where the policy encapsulates seller's terms for returning items.
+     *
+     * @param body Return policy request
+     */
+    createReturnPolicy(body: ReturnPolicyRequest): Promise<any>;
+    /**
+     * This method creates a new return policy where the policy encapsulates seller's terms for returning items.
+     *
+     *  @param returnPolicyId This path parameter specifies the ID of the return policy you want to update.
+     * @param body Return policy request
+     */
+    updateReturnPolicy(returnPolicyId: string, body: ReturnPolicyRequest): Promise<any>;
+    /**
+     * This method deletes a return policy.
+     *
+     * @param returnPolicyId This path parameter specifies the ID of the return policy you want to delete.
+     */
+    deleteReturnPolicy(returnPolicyId: string): Promise<any>;
+    /**
+     * This method retrieves the complete details of a single return policy.
+     *
+     * @param marketplaceId This query parameter specifies the ID of the eBay marketplace of the policy you want to
+     *     retrieve.
+     * @param name This query parameter specifies the user-defined name of the return policy you want to retrieve.
+     */
+    getReturnPolicyByName(marketplaceId: string, name: string): Promise<any>;
+    /**
+     * This call gets the current tax table entry for a specific tax jurisdiction.
+     *
+     * @param countryCode This path parameter specifies the two-letter ISO 3166-1 Alpha-2 code for the country whose
+     *     tax table you want to retrieve.
+     * @param jurisdictionId This path parameter specifies the ID of the sales tax jurisdiction for the tax table entry
+     *     you want to retrieve.
+     */
+    getSalesTax(countryCode: string, jurisdictionId: string): Promise<any>;
+    /**
+     * This method creates or updates a sales tax table entry for a jurisdiction.
+     *
+     * @param countryCode This path parameter specifies the two-letter ISO 3166-1 Alpha-2 code for the country for
+     *     which you want to create tax table entry.
+     * @param jurisdictionId This path parameter specifies the ID of the sales-tax jurisdiction for the table entry you
+     *     want to create.
+     * @param body A container that describes the how the sales tax is calculated.
+     */
+    createOrReplaceSalesTax(countryCode: string, jurisdictionId: string, body: SalesTaxBase): Promise<any>;
+    /**
+     * This call deletes a tax table entry for a jurisdiction.
+     *
+     * @param countryCode This path parameter specifies the two-letter ISO 3166-1 Alpha-2 code for the country for
+     *     which you want to create tax table entry.
+     * @param jurisdictionId This path parameter specifies the ID of the sales-tax jurisdiction for the table entry you
+     *     want to delete.
+     */
+    deleteSalesTax(countryCode: string, jurisdictionId: string): Promise<any>;
+    /**
+     * Use this call to retrieve a sales tax table that the seller established for a specific country.
+     *
+     * @param countryCode This path parameter specifies the two-letter ISO 3166-1 Alpha-2 code for the country whose
+     *     tax table you want to retrieve.
+     */
+    getSalesTaxes(countryCode: string): Promise<any>;
+    /**
+     * his method is used by sellers onboarded for eBay managed payments, or sellers who are currently going through, or who are eligible for onboarding for eBay managed payments.
+     */
+    getKYC(): Promise<any>;
+}