ebay-api 8.5.1 → 8.6.0

package/dist/types/restful/specs/return_oas3.d.ts

@@ -1,134 +1,97 @@
-/**
- * This file was auto-generated by openapi-typescript.
- * Do not make direct changes to the file.
- */
 export interface paths {
     "/return/{returnId}/add_shipping_label": {
-        /** @description Create or update a shipping label provided by the seller */
         post: operations["addShippingLabelInfo"];
     };
     "/return/{returnId}/cancel": {
-        /** @description Cancel a return request */
         post: operations["cancelReturnRequest"];
     };
     "/return/check_eligibility": {
-        /** @description Check to see if an item is eligible for a return */
         post: operations["checkReturnEligibility"];
     };
     "/return/{returnId}/check_label_print_eligibility": {
-        /** @description Validate the eligibility of an existing shipping label */
         get: operations["checkShippingLabelEligibility"];
     };
     "/return/draft": {
-        /** @description Create a return draft */
         post: operations["createReturnDraft"];
     };
     "/return": {
-        /** @description Request a return for an item */
         post: operations["createReturnRequest"];
     };
     "/return/{returnId}/initiate_shipping_label": {
-        /** @description Create an eBay shipping label for the buyer */
         post: operations["createReturnShippingLabel"];
     };
     "/return/draft/{draftId}/file/{fileId}": {
-        /** @description Delete a file associated with a return draft */
         delete: operations["deleteReturnDraftFile"];
     };
     "/return/{returnId}/escalate": {
-        /** @description Escalate an existing return to eBay customer support */
         post: operations["escalateReturn"];
     };
     "/return/{returnId}": {
-        /** @description Retrieve the details of a specific return */
         get: operations["getReturn"];
     };
     "/return/draft/{draftId}": {
-        /** @description Retrieve a return draft */
         get: operations["getReturnDraft"];
-        /** @description Update an existing return draft */
         put: operations["updateReturnDraft"];
     };
     "/return/draft/{draftId}/files": {
-        /** @description Retrieve the files associated with a return draft */
         get: operations["getReturnDraftFiles"];
     };
     "/return/estimate": {
-        /** @description Buyer-facing call to retrieve the estimated refund amount and return shipping costs associated with returning an item. */
         post: operations["getReturnEstimate"];
     };
     "/return/{returnId}/files": {
-        /** @description Retrieve the files associated with a return */
         get: operations["getReturnFiles"];
     };
     "/return/preference": {
-        /** @description Retrieve seller's return preferences */
         get: operations["getReturnPreferences"];
-        /** @description Set seller's return preferences */
         post: operations["setReturnPreferences"];
     };
     "/return/{returnId}/get_shipping_label": {
-        /** @description Retrieve the data for an existing shipping label */
         get: operations["getReturnShippingLabel"];
     };
     "/return/{returnId}/tracking": {
-        /** @description Retrieve shipment tracking activity for a return */
         get: operations["getShipmentTrackingInfo"];
     };
     "/return/{returnId}/issue_refund": {
-        /** @description Issue a refund */
         post: operations["issueReturnRefund"];
     };
     "/return/{returnId}/mark_as_received": {
-        /** @description Mark a returned item as received */
         post: operations["markReturnReceived"];
     };
     "/return/{returnId}/mark_refund_received": {
-        /** @description Mark a refund as received */
         post: operations["markReturnRefundReceived"];
     };
     "/return/{returnId}/mark_refund_sent": {
-        /** @description Notify the buyer that a refund has been issued */
         post: operations["markReturnRefundSent"];
     };
     "/return/{returnId}/mark_as_shipped": {
-        /** @description Mark a return as shipped */
         post: operations["markReturnShipped"];
     };
     "/return/{returnId}/decide": {
-        /** @description Perform an action on a return, such as APPROVE */
         post: operations["processReturnRequest"];
     };
     "/return/search": {
-        /** @description Retrieve details on items being returned */
         get: operations["search"];
     };
     "/return/{returnId}/send_message": {
-        /** @description Send a message to the buyer or seller regarding a return */
         post: operations["sendReturnMessage"];
     };
     "/return/{returnId}/send_shipping_label": {
-        /** @description Send a shipping label to an email address */
         post: operations["sendReturnShippingLabel"];
     };
     "/return/{returnId}/file/submit": {
-        /** @description Activate the files associated with a return */
         post: operations["submitReturnFile"];
     };
     "/return/{returnId}/update_tracking": {
-        /** @description Update shipment tracking information for an item being returned. */
         put: operations["updateShipmentTrackingInfo"];
     };
     "/return/draft/{draftId}/file/upload": {
-        /** @description Upload the files relating to a return draft */
         post: operations["uploadReturnDraftFile"];
     };
     "/return/{returnId}/file/upload": {
-        /** @description Upload the files relating to a return */
         post: operations["uploadReturnFile"];
     };
     "/return/{returnId}/void_shipping_label": {
-        /** @description Void a shipping label */
         post: operations["voidShippingLabel"];
     };
 }
@@ -136,392 +99,299 @@ export type webhooks = Record<string, never>;
 export type components = Record<string, never>;
 export type external = Record<string, never>;
 export interface operations {
-    /** @description Create or update a shipping label provided by the seller */
     addShippingLabelInfo: {
         parameters: {
             path: {
-                /** @description The unique eBay-assigned ID of the return. The returnId value is required to identify the return for which a return shipping label is being created. */
                 returnId: string;
             };
         };
         responses: {
-            /** @description OK */
             200: never;
         };
     };
-    /** @description Cancel a return request */
     cancelReturnRequest: {
         parameters: {
             path: {
-                /** @description The unique eBay-assigned ID of the return. The returnId value is required to identify the return for which a return shipping label is being created. */
                 returnId: string;
             };
         };
         responses: {
-            /** @description OK */
             200: never;
         };
     };
-    /** @description Check to see if an item is eligible for a return */
     checkReturnEligibility: {
         responses: {
-            /** @description OK */
             200: never;
         };
     };
-    /** @description Validate the eligibility of an existing shipping label */
     checkShippingLabelEligibility: {
         parameters: {
             path: {
-                /** @description The unique eBay-assigned ID of the return. The returnId value is required to identify the return for which a return shipping label is being created. */
                 returnId: string;
             };
         };
         responses: {
-            /** @description OK */
             200: never;
         };
     };
-    /** @description Create a return draft */
     createReturnDraft: {
         responses: {
-            /** @description OK */
             200: never;
         };
     };
-    /** @description Request a return for an item */
     createReturnRequest: {
         responses: {
-            /** @description OK */
             200: never;
         };
     };
-    /** @description Create an eBay shipping label for the buyer */
     createReturnShippingLabel: {
         parameters: {
             path: {
-                /** @description The unique eBay-assigned ID of the return. The returnId value is required to identify the return for which a return shipping label is being created. */
                 returnId: string;
             };
         };
         responses: {
-            /** @description OK */
             200: never;
         };
     };
-    /** @description Delete a file associated with a return draft */
     deleteReturnDraftFile: {
         parameters: {
             path: {
-                /** @description The unique eBay-assigned ID of the return draft. The draftId value is required to identify the return draft containing the file to be deleted. */
                 draftId: string;
-                /** @description The unique eBay-assigned ID of the draft file. The fileId value is required to identify the the file to be deleted. */
                 fileId: string;
             };
         };
         responses: {
-            /** @description OK */
             200: never;
         };
     };
-    /** @description Escalate an existing return to eBay customer support */
     escalateReturn: {
         parameters: {
             path: {
-                /** @description The unique eBay-assigned ID of the return. The returnId value is required to identify the return for which a return shipping label is being created. */
                 returnId: string;
             };
         };
         responses: {
-            /** @description OK */
             200: never;
         };
     };
-    /** @description Retrieve the details of a specific return */
     getReturn: {
         parameters: {
             path: {
-                /** @description The unique eBay-assigned ID of the return. The returnId value is required to identify the return for which a return shipping label is being created. */
                 returnId: string;
             };
         };
         responses: {
-            /** @description OK */
             200: never;
         };
     };
-    /** @description Retrieve a return draft */
     getReturnDraft: {
         parameters: {
             path: {
-                /** @description The unique eBay-assigned ID of the return draft. The draftId value is required to identify the return draft containing the file to be deleted. */
                 draftId: string;
             };
         };
         responses: {
-            /** @description OK */
             200: never;
         };
     };
-    /** @description Update an existing return draft */
     updateReturnDraft: {
         parameters: {
             path: {
-                /** @description The unique eBay-assigned ID of the return draft. The draftId value is required to identify the return draft containing the file to be deleted. */
                 draftId: string;
             };
         };
         responses: {
-            /** @description OK */
             200: never;
         };
     };
-    /** @description Retrieve the files associated with a return draft */
     getReturnDraftFiles: {
         parameters: {
             path: {
-                /** @description The unique eBay-assigned ID of the return draft. The draftId value is required to identify the return draft containing the file to be deleted. */
                 draftId: string;
             };
         };
         responses: {
-            /** @description OK */
             200: never;
         };
     };
-    /** @description Buyer-facing call to retrieve the estimated refund amount and return shipping costs associated with returning an item. */
     getReturnEstimate: {
         responses: {
-            /** @description OK */
             200: never;
         };
     };
-    /** @description Retrieve the files associated with a return */
     getReturnFiles: {
         parameters: {
             path: {
-                /** @description The unique eBay-assigned ID of the return. The returnId value is required to identify the return for which a return shipping label is being created. */
                 returnId: string;
             };
         };
         responses: {
-            /** @description OK */
             200: never;
         };
     };
-    /** @description Retrieve seller's return preferences */
     getReturnPreferences: {
         responses: {
-            /** @description OK */
             200: never;
         };
     };
-    /** @description Set seller's return preferences */
     setReturnPreferences: {
         responses: {
-            /** @description OK */
             200: never;
         };
     };
-    /** @description Retrieve the data for an existing shipping label */
     getReturnShippingLabel: {
         parameters: {
             path: {
-                /** @description The unique eBay-assigned ID of the return. The returnId value is required to identify the return for which a return shipping label is being created. */
                 returnId: string;
             };
         };
         responses: {
-            /** @description OK */
             200: never;
         };
     };
-    /** @description Retrieve shipment tracking activity for a return */
     getShipmentTrackingInfo: {
         parameters: {
             path: {
-                /** @description The unique eBay-assigned ID of the return. The returnId value is required to identify the return for which a return shipping label is being created. */
                 returnId: string;
             };
         };
         responses: {
-            /** @description OK */
             200: never;
         };
     };
-    /** @description Issue a refund */
     issueReturnRefund: {
         parameters: {
             path: {
-                /** @description The unique eBay-assigned ID of the return. The returnId value is required to identify the return for which a return shipping label is being created. */
                 returnId: string;
             };
         };
         responses: {
-            /** @description OK */
             200: never;
         };
     };
-    /** @description Mark a returned item as received */
     markReturnReceived: {
         parameters: {
             path: {
-                /** @description The unique eBay-assigned ID of the return. The returnId value is required to identify the return for which a return shipping label is being created. */
                 returnId: string;
             };
         };
         responses: {
-            /** @description OK */
             200: never;
         };
     };
-    /** @description Mark a refund as received */
     markReturnRefundReceived: {
         parameters: {
             path: {
-                /** @description The unique eBay-assigned ID of the return. The returnId value is required to identify the return for which a return shipping label is being created. */
                 returnId: string;
             };
         };
         responses: {
-            /** @description OK */
             200: never;
         };
     };
-    /** @description Notify the buyer that a refund has been issued */
     markReturnRefundSent: {
         parameters: {
             path: {
-                /** @description The unique eBay-assigned ID of the return. The returnId value is required to identify the return for which a return shipping label is being created. */
                 returnId: string;
             };
         };
         responses: {
-            /** @description OK */
             200: never;
         };
     };
-    /** @description Mark a return as shipped */
     markReturnShipped: {
         parameters: {
             path: {
-                /** @description The unique eBay-assigned ID of the return. The returnId value is required to identify the return for which a return shipping label is being created. */
                 returnId: string;
             };
         };
         responses: {
-            /** @description OK */
             200: never;
         };
     };
-    /** @description Perform an action on a return, such as APPROVE */
     processReturnRequest: {
         parameters: {
             path: {
-                /** @description The unique eBay-assigned ID of the return. The returnId value is required to identify the return for which a return shipping label is being created. */
                 returnId: string;
             };
         };
         responses: {
-            /** @description OK */
             200: never;
         };
     };
-    /** @description Retrieve details on items being returned */
     search: {
         responses: {
-            /** @description OK */
             200: never;
         };
     };
-    /** @description Send a message to the buyer or seller regarding a return */
     sendReturnMessage: {
         parameters: {
             path: {
-                /** @description The unique eBay-assigned ID of the return. The returnId value is required to identify the return for which a return shipping label is being created. */
                 returnId: string;
             };
         };
         responses: {
-            /** @description OK */
             200: never;
         };
     };
-    /** @description Send a shipping label to an email address */
     sendReturnShippingLabel: {
         parameters: {
             path: {
-                /** @description The unique eBay-assigned ID of the return. The returnId value is required to identify the return for which a return shipping label is being created. */
                 returnId: string;
             };
         };
         responses: {
-            /** @description OK */
             200: never;
         };
     };
-    /** @description Activate the files associated with a return */
     submitReturnFile: {
         parameters: {
             path: {
-                /** @description The unique eBay-assigned ID of the return. The returnId value is required to identify the return for which a return shipping label is being created. */
                 returnId: string;
             };
         };
         responses: {
-            /** @description OK */
             200: never;
         };
     };
-    /** @description Update shipment tracking information for an item being returned. */
     updateShipmentTrackingInfo: {
         parameters: {
             path: {
-                /** @description The unique eBay-assigned ID of the return. The returnId value is required to identify the return for which a return shipping label is being created. */
                 returnId: string;
             };
         };
         responses: {
-            /** @description OK */
             200: never;
         };
     };
-    /** @description Upload the files relating to a return draft */
     uploadReturnDraftFile: {
         parameters: {
             path: {
-                /** @description The unique eBay-assigned ID of the return. The returnId value is required to identify the return for which a return shipping label is being created. */
                 returnId: string;
             };
         };
         responses: {
-            /** @description OK */
             200: never;
         };
     };
-    /** @description Upload the files relating to a return */
     uploadReturnFile: {
         parameters: {
             path: {
-                /** @description The unique eBay-assigned ID of the return. The returnId value is required to identify the return for which a return shipping label is being created. */
                 returnId: string;
             };
         };
         responses: {
-            /** @description OK */
             200: never;
         };
     };
-    /** @description Void a shipping label */
     voidShippingLabel: {
         parameters: {
             path: {
-                /** @description The unique eBay-assigned ID of the return. The returnId value is required to identify the return for which a return shipping label is being created. */
                 returnId: string;
             };
         };
         responses: {
-            /** @description OK */
             200: never;
         };
     };

package/dist/types/restful/specs/return_oas3.js

@@ -1,5 +1 @@
-/**
- * This file was auto-generated by openapi-typescript.
- * Do not make direct changes to the file.
- */
 export {};