ebay-api 7.1.3 → 8.0.0

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

@@ -0,0 +1,231 @@
+import Restful from '../../index.js';
+import { FilePurpose, GetReturnFieldGroupEnum } from '../../../../enums/index.js';
+import { CheckEligibilityRequest, CloseReturnRequest, CreateReturnRequest, DecideReturnRequest, EscalateRequest, GetEstimateRequest, MarkAsReceivedRequest, MarkAsShippedRequest, MarkRefundSentRequest, PostOrderIssueRefundRequest, ProvideLabelRequest, ReturnRequestType, SearchReturnParams, SendMessageRequest, SetReturnCreationSessionRequest, UpdateTrackingRequest, UploadFileRequest, VoidLabelRequest } from '../../../../types/index.js';
+/**
+ * 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>;
+}

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

@@ -0,0 +1,354 @@
+import Restful from '../../index.js';
+/**
+ * Post-Order Return API
+ */
+export default class Return extends Restful {
+    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);
+    }
+}
+Return.id = 'Return';