ebay-api 1.13.7 → 6.2.0

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

@@ -0,0 +1,15 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Return = exports.Inquiry = exports.Case = exports.Cancellation = void 0;
+const cancellation_1 = __importDefault(require("./cancellation"));
+exports.Cancellation = cancellation_1.default;
+const case_1 = __importDefault(require("./case"));
+exports.Case = case_1.default;
+const inquiry_1 = __importDefault(require("./inquiry"));
+exports.Inquiry = inquiry_1.default;
+const return_1 = __importDefault(require("./return"));
+exports.Return = return_1.default;
+//# sourceMappingURL=index.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/api/restful/postOrder/index.ts"],"names":[],"mappings":";;;;;;AAAA,kEAA0C;AAaxC,uBAbK,sBAAY,CAaL;AAZd,kDAA0B;AAaxB,eAbK,cAAI,CAaL;AAZN,wDAAgC;AAa9B,kBAbK,iBAAO,CAaL;AAZT,sDAA8B;AAa5B,iBAbK,gBAAM,CAaL"}

package/lib/api/restful/postOrder/inquiry/index.d.ts

@@ -0,0 +1,82 @@
+import Restful from '../../';
+import { BuyerCloseInquiryRequest, CheckInquiryEligibilityRequest, CreateInquiryRequest, EscalateInquiryRequest, InquirySearchParams, InquiryVoluntaryRefundRequest, SellerProvideRefundInfoRequest, SendMessageRequest, ShipmentInfoRequest } from '../../../../types';
+/**
+ * Post-Order Inquiry API
+ */
+export default class Inquiry extends Restful {
+    static id: string;
+    get basePath(): string;
+    get useIaf(): boolean;
+    /**
+     * Check if a buyer is eligible to open an inquiry on an order.
+     *
+     * @param payload the CheckInquiryEligibilityRequest
+     */
+    checkInquiryEligibility(payload: CheckInquiryEligibilityRequest): Promise<any>;
+    /**
+     * Close an inquiry for the buyer
+     *
+     * @param inquiryId The unique ID of the inquiry to be closed.
+     * @param payload the BuyerCloseInquiryRequest
+     */
+    closeInquiry(inquiryId: string, payload?: BuyerCloseInquiryRequest): Promise<any>;
+    /**
+     * Buyer confirms the refund from an inquiry was received
+     *
+     * @param inquiryId The unique identifier of a case.
+     */
+    confirmInquiryRefund(inquiryId: string): Promise<any>;
+    /**
+     * Create an inquiry for the buyer.
+     *
+     * @param payload the CreateInquiryRequest
+     */
+    createInquiry(payload: CreateInquiryRequest): Promise<any>;
+    /**
+     * Escalate an inquiry to an INR case.
+     *
+     * @param inquiryId the unique identifier of the inquiry to be escalated.
+     * @param payload the EscalateInquiryRequest
+     */
+    escalateInquiry(inquiryId: string, payload: EscalateInquiryRequest): Promise<any>;
+    /**
+     * Retrieve the history and details related to a specific inquiry.
+     *
+     * @param inquiryId the unique ID of the inquiry for which details and history are to be retrieved.
+     */
+    getInquiry(inquiryId: string): Promise<any>;
+    /**
+     * Issue a refund for an inquiry.
+     *
+     * @param inquiryId the unique ID of the inquiry for which a refund is to be issued.
+     * @param payload   the InquiryVoluntaryRefundRequest
+     */
+    issueInquiryRefund(inquiryId: string, payload?: InquiryVoluntaryRefundRequest): Promise<any>;
+    /**
+     * Provide refund information about an inquiry to the buyer.
+     *
+     * @param inquiryId The unique ID of the inquiry for which to provide refund information.
+     * @param payload   the InquiryVoluntaryRefundRequest
+     */
+    provideInquiryRefundInfo(inquiryId: string, payload: SellerProvideRefundInfoRequest): Promise<any>;
+    /**
+     * Provide shipment information for an inquiry.
+     *
+     * @param inquiryId The unique ID of the inquiry for which to provide shipment information.
+     * @param payload the  ShipmentInfoRequest
+     */
+    provideInquiryShipmentInfo(inquiryId: string, payload?: ShipmentInfoRequest): Promise<any>;
+    /**
+     * This call is used to search for inquiries using multiple filter types.
+     *
+     * @param params the  InquirySearchParams
+     */
+    search(params?: InquirySearchParams): Promise<any>;
+    /**
+     * Contact the buyer or seller about an inquiry.
+     *
+     * @param inquiryId The unique ID of the inquiry being discussed.
+     * @param payload the SendMessageRequest
+     */
+    sendInquiryMessage(inquiryId: string, payload: SendMessageRequest): Promise<any>;
+}

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

@@ -0,0 +1,131 @@
+"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 Inquiry API
+ */
+class Inquiry extends __1.default {
+    get basePath() {
+        return '/post-order/v2';
+    }
+    get useIaf() {
+        return true;
+    }
+    /**
+     * Check if a buyer is eligible to open an inquiry on an order.
+     *
+     * @param payload the CheckInquiryEligibilityRequest
+     */
+    checkInquiryEligibility(payload) {
+        return this.post(`/inquiry/check_eligibility`, payload);
+    }
+    /**
+     * Close an inquiry for the buyer
+     *
+     * @param inquiryId The unique ID of the inquiry to be closed.
+     * @param payload the BuyerCloseInquiryRequest
+     */
+    closeInquiry(inquiryId, payload) {
+        inquiryId = encodeURIComponent(inquiryId);
+        if (typeof payload?.closeReason === 'string') {
+            payload.closeReason = payload.closeReason.trim();
+        }
+        return this.post(`/inquiry/${inquiryId}/close`, payload);
+    }
+    /**
+     * Buyer confirms the refund from an inquiry was received
+     *
+     * @param inquiryId The unique identifier of a case.
+     */
+    confirmInquiryRefund(inquiryId) {
+        inquiryId = encodeURIComponent(inquiryId);
+        return this.post(`/inquiry/${inquiryId}/confirm_refund`);
+    }
+    /**
+     * Create an inquiry for the buyer.
+     *
+     * @param payload the CreateInquiryRequest
+     */
+    createInquiry(payload) {
+        if (typeof payload.desiredOutcome === 'string') {
+            payload.desiredOutcome = payload.desiredOutcome.trim();
+        }
+        return this.post(`/inquiry`, payload);
+    }
+    /**
+     * Escalate an inquiry to an INR case.
+     *
+     * @param inquiryId the unique identifier of the inquiry to be escalated.
+     * @param payload the EscalateInquiryRequest
+     */
+    escalateInquiry(inquiryId, payload) {
+        inquiryId = encodeURIComponent(inquiryId);
+        payload.escalateInquiryReason = payload.escalateInquiryReason.trim();
+        return this.post(`/inquiry/${inquiryId}/escalate`, payload);
+    }
+    /**
+     * Retrieve the history and details related to a specific inquiry.
+     *
+     * @param inquiryId the unique ID of the inquiry for which details and history are to be retrieved.
+     */
+    getInquiry(inquiryId) {
+        inquiryId = encodeURIComponent(inquiryId);
+        return this.get(`/inquiry/${inquiryId}`);
+    }
+    /**
+     * Issue a refund for an inquiry.
+     *
+     * @param inquiryId the unique ID of the inquiry for which a refund is to be issued.
+     * @param payload   the InquiryVoluntaryRefundRequest
+     */
+    issueInquiryRefund(inquiryId, payload) {
+        inquiryId = encodeURIComponent(inquiryId);
+        return this.post(`/inquiry/${inquiryId}/issue_refund`, payload);
+    }
+    /**
+     * Provide refund information about an inquiry to the buyer.
+     *
+     * @param inquiryId The unique ID of the inquiry for which to provide refund information.
+     * @param payload   the InquiryVoluntaryRefundRequest
+     */
+    provideInquiryRefundInfo(inquiryId, payload) {
+        inquiryId = encodeURIComponent(inquiryId);
+        return this.post(`/inquiry/${inquiryId}/provide_refund_info`, payload);
+    }
+    /**
+     * Provide shipment information for an inquiry.
+     *
+     * @param inquiryId The unique ID of the inquiry for which to provide shipment information.
+     * @param payload the  ShipmentInfoRequest
+     */
+    provideInquiryShipmentInfo(inquiryId, payload) {
+        inquiryId = encodeURIComponent(inquiryId);
+        return this.post(`/inquiry/${inquiryId}/provide_shipment_info`, payload);
+    }
+    /**
+     * This call is used to search for inquiries using multiple filter types.
+     *
+     * @param params the  InquirySearchParams
+     */
+    search(params) {
+        return this.get(`/inquiry/search`, {
+            params
+        });
+    }
+    /**
+     * Contact the buyer or seller about an inquiry.
+     *
+     * @param inquiryId The unique ID of the inquiry being discussed.
+     * @param payload the SendMessageRequest
+     */
+    sendInquiryMessage(inquiryId, payload) {
+        inquiryId = encodeURIComponent(inquiryId);
+        return this.post(`/inquiry/${inquiryId}/send_message`, payload);
+    }
+}
+exports.default = Inquiry;
+Inquiry.id = 'Inquiry';
+//# sourceMappingURL=index.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../src/api/restful/postOrder/inquiry/index.ts"],"names":[],"mappings":";;;;;AAAA,+CAA6B;AAa7B;;GAEG;AACH,MAAqB,OAAQ,SAAQ,WAAO;IAI1C,IAAI,QAAQ;QACV,OAAO,gBAAgB,CAAC;IAC1B,CAAC;IAED,IAAI,MAAM;QACR,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;OAIG;IACI,uBAAuB,CAAC,OAAuC;QACpE,OAAO,IAAI,CAAC,IAAI,CAAC,4BAA4B,EAAE,OAAO,CAAC,CAAC;IAC1D,CAAC;IAED;;;;;OAKG;IACI,YAAY,CAAC,SAAiB,EAAE,OAAkC;QACvE,SAAS,GAAG,kBAAkB,CAAC,SAAS,CAAC,CAAC;QAC1C,IAAI,OAAO,OAAO,EAAE,WAAW,KAAK,QAAQ,EAAE;YAC5C,OAAO,CAAC,WAAW,GAAG,OAAO,CAAC,WAAW,CAAC,IAAI,EAAE,CAAC;SAClD;QACD,OAAO,IAAI,CAAC,IAAI,CAAC,YAAY,SAAS,QAAQ,EAAE,OAAO,CAAC,CAAC;IAC3D,CAAC;IAED;;;;OAIG;IACI,oBAAoB,CAAC,SAAiB;QAC3C,SAAS,GAAG,kBAAkB,CAAC,SAAS,CAAC,CAAC;QAC1C,OAAO,IAAI,CAAC,IAAI,CAAC,YAAY,SAAS,iBAAiB,CAAC,CAAC;IAC3D,CAAC;IAED;;;;OAIG;IACI,aAAa,CAAC,OAA6B;QAChD,IAAI,OAAO,OAAO,CAAC,cAAc,KAAK,QAAQ,EAAE;YAC9C,OAAO,CAAC,cAAc,GAAG,OAAO,CAAC,cAAc,CAAC,IAAI,EAAE,CAAC;SACxD;QACD,OAAO,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC;IACxC,CAAC;IAED;;;;;OAKG;IACI,eAAe,CAAC,SAAiB,EAAE,OAA+B;QACvE,SAAS,GAAG,kBAAkB,CAAC,SAAS,CAAC,CAAC;QAC1C,OAAO,CAAC,qBAAqB,GAAG,OAAO,CAAC,qBAAqB,CAAC,IAAI,EAAE,CAAC;QACrE,OAAO,IAAI,CAAC,IAAI,CAAC,YAAY,SAAS,WAAW,EAAE,OAAO,CAAC,CAAC;IAC9D,CAAC;IAED;;;;OAIG;IACI,UAAU,CAAC,SAAiB;QACjC,SAAS,GAAG,kBAAkB,CAAC,SAAS,CAAC,CAAC;QAC1C,OAAO,IAAI,CAAC,GAAG,CAAC,YAAY,SAAS,EAAE,CAAC,CAAC;IAC3C,CAAC;IAED;;;;;OAKG;IACI,kBAAkB,CAAC,SAAiB,EAAE,OAAuC;QAClF,SAAS,GAAG,kBAAkB,CAAC,SAAS,CAAC,CAAC;QAC1C,OAAO,IAAI,CAAC,IAAI,CAAC,YAAY,SAAS,eAAe,EAAE,OAAO,CAAC,CAAC;IAClE,CAAC;IAED;;;;;OAKG;IACI,wBAAwB,CAAC,SAAiB,EAAE,OAAuC;QACxF,SAAS,GAAG,kBAAkB,CAAC,SAAS,CAAC,CAAC;QAC1C,OAAO,IAAI,CAAC,IAAI,CAAC,YAAY,SAAS,sBAAsB,EAAE,OAAO,CAAC,CAAC;IACzE,CAAC;IAED;;;;;OAKG;IACI,0BAA0B,CAAC,SAAiB,EAAE,OAA6B;QAChF,SAAS,GAAG,kBAAkB,CAAC,SAAS,CAAC,CAAC;QAC1C,OAAO,IAAI,CAAC,IAAI,CAAC,YAAY,SAAS,wBAAwB,EAAE,OAAO,CAAC,CAAC;IAC3E,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,MAA4B;QACxC,OAAO,IAAI,CAAC,GAAG,CAAC,iBAAiB,EAAE;YACjC,MAAM;SACP,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACI,kBAAkB,CAAC,SAAiB,EAAE,OAA2B;QACtE,SAAS,GAAG,kBAAkB,CAAC,SAAS,CAAC,CAAC;QAC1C,OAAO,IAAI,CAAC,IAAI,CAAC,YAAY,SAAS,eAAe,EAAE,OAAO,CAAC,CAAC;IAClE,CAAC;;AApIH,0BAqIC;AAnIQ,UAAE,GAAG,SAAS,CAAC"}

package/lib/api/restful/postOrder/return/index.d.ts

@@ -0,0 +1,231 @@
+import Restful from '../../';
+import { FilePurpose, GetReturnFieldGroupEnum } from '../../../../enums';
+import { CheckEligibilityRequest, CloseReturnRequest, CreateReturnRequest, DecideReturnRequest, EscalateRequest, GetEstimateRequest, MarkAsReceivedRequest, MarkAsShippedRequest, MarkRefundSentRequest, PostOrderIssueRefundRequest, ProvideLabelRequest, ReturnRequestType, SearchReturnParams, SendMessageRequest, SetReturnCreationSessionRequest, UpdateTrackingRequest, UploadFileRequest, VoidLabelRequest } from '../../../../types';
+/**
+ * Post-Order Return API
+ */
+export default class Return extends Restful {
+    static id: string;
+    get basePath(): string;
+    get useIaf(): boolean;
+    /**
+     * 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: string, payload: ProvideLabelRequest): Promise<any>;
+    /**
+     * Cancel a return request.
+     *
+     * @param returnId    The unique eBay-assigned ID of the return request.
+     * @param payload    The CloseReturnRequest.
+     */
+    cancelReturnRequest(returnId: string, payload?: CloseReturnRequest): Promise<any>;
+    /**
+     * Check to see if an item is eligible for a return.
+     *
+     * @param payload the CheckEligibilityRequest
+     */
+    checkReturnEligibility(payload: CheckEligibilityRequest): Promise<any>;
+    /**
+     * Validate the eligibility of an existing shipping label.
+     *
+     * @param returnId The unique eBay-assigned ID of the return.
+     */
+    checkShippingLabelEligibility(returnId: string): Promise<any>;
+    /**
+     * Create a return draft.
+     *
+     * @param payload the SetReturnCreationSessionRequest
+     */
+    createReturnDraft(payload: SetReturnCreationSessionRequest): Promise<any>;
+    /**
+     * 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: CreateReturnRequest, fieldGroups?: GetReturnFieldGroupEnum): Promise<any>;
+    /**
+     * Create an eBay shipping label for the buyer.
+     *
+     * @param returnId The unique eBay-assigned ID of the return.
+     */
+    createReturnShippingLabel(returnId: string): Promise<any>;
+    /**
+     * 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: string, fileId: string): Promise<any>;
+    /**
+     * 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: string, payload?: EscalateRequest): Promise<any>;
+    /**
+     * 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: string, fieldGroups?: GetReturnFieldGroupEnum): Promise<any>;
+    /**
+     * Retrieve a return draft.
+     *
+     * @param returnId The unique eBay-assigned ID of the return request.
+     */
+    getReturnDraft(returnId: string): Promise<any>;
+    /**
+     * Retrieve the files associated with a return draft.
+     *
+     * @param returnId    The unique eBay-assigned ID of the return draft.
+     */
+    getReturnDraftFiles(returnId: string): Promise<any>;
+    /**
+     * Retrieve the cost estimate of a refund with its shipping cost.
+     *
+     * @param payload the GetEstimateRequest
+     */
+    getReturnEstimate(payload: GetEstimateRequest): Promise<any>;
+    /**
+     * Retrieve the cost estimate of a refund with its shipping cost.
+     *
+     * @param returnId The unique eBay-assigned ID of the return.
+     */
+    getReturnFiles(returnId: string): Promise<any>;
+    /**
+     * Retrieve seller's return preferences.
+     */
+    getReturnPreferences(): Promise<any>;
+    /**
+     * Retrieve the data for an existing shipping label.
+     *
+     * @param returnId The unique eBay-assigned ID of the return.
+     */
+    getReturnShippingLabel(returnId: string): Promise<any>;
+    /**
+     * 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: string, carrierUsed: string, trackingNumber: string): Promise<any>;
+    /**
+     * Issue a refund.
+     *
+     * @param returnId The unique eBay-assigned ID of the return.
+     * @param payload The IssueRefundRequest.
+     */
+    issueReturnRefund(returnId: string, payload: PostOrderIssueRefundRequest): Promise<any>;
+    /**
+     * Mark a returned item as received.
+     *
+     * @param returnId The unique eBay-assigned ID of the return.
+     * @param payload the MarkAsReceivedRequest
+     */
+    markReturnReceived(returnId: string, payload?: MarkAsReceivedRequest): Promise<any>;
+    /**
+     * Mark a refund as received.
+     *
+     * @param returnId The unique eBay-assigned ID of the return.
+     */
+    markReturnRefundReceived(returnId: string): Promise<any>;
+    /**
+     * 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: string, payload: MarkRefundSentRequest): Promise<any>;
+    /**
+     * Mark a return as shipped.
+     *
+     * @param returnId    The unique eBay-assigned ID of the return.
+     * @param payload the MarkAsShippedRequest
+     */
+    markReturnShipped(returnId: string, payload?: MarkAsShippedRequest): Promise<any>;
+    /**
+     * 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: string, payload: DecideReturnRequest): Promise<any>;
+    /**
+     * Retrieve details on items being returned.
+     *
+     * @param params the SearchReturnParams
+     */
+    search(params: SearchReturnParams): Promise<any>;
+    /**
+     * 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: string, payload?: SendMessageRequest): Promise<any>;
+    /**
+     * 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: string, toEmailAddress?: string): Promise<any>;
+    /**
+     * 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: boolean): Promise<any>;
+    /**
+     * 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: string, filePurpose?: FilePurpose): Promise<any>;
+    /**
+     * Update an existing return draft.
+     *
+     * @param draftId The unique eBay-assigned ID of the return draft.
+     * @param returnRequest the ReturnRequestType
+     */
+    updateReturnDraft(draftId: string, returnRequest: ReturnRequestType): Promise<any>;
+    /**
+     * Update shipment tracking information.
+     *
+     * @param returnId The unique eBay-assigned ID of the return request.
+     * @param payload the UpdateTrackingRequest
+     */
+    updateShipmentTrackingInfo(returnId: string, payload: UpdateTrackingRequest): Promise<any>;
+    /**
+     * 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: string, payload: UploadFileRequest): Promise<any>;
+    /**
+     * Upload the files relating to a return.
+     *
+     * @param returnId The unique eBay-assigned ID of the return.
+     * @param payload the UploadFileRequest
+     */
+    uploadReturnFile(returnId: string, payload: UploadFileRequest): Promise<any>;
+    /**
+     * Void a shipping label.
+     *
+     * @param returnId The unique eBay-assigned ID of the return.
+     * @param payload the VoidLabelRequest
+     */
+    voidShippingLabel(returnId: string, payload: VoidLabelRequest): Promise<any>;
+}