ebay-api 8.4.0 → 8.5.0

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

@@ -1,57 +1,57 @@
-import Restful from '../../index.js';
-import { CancellationSearchParams, ConfirmRefundRequest, CreateCancelRequest, RejectCancelRequest } from '../../../../types/index.js';
-/**
- * Post-Order Cancellation API
- */
-export default class Cancellation extends Restful {
-    static id: string;
-    get basePath(): string;
-    get useIaf(): boolean;
-    /**
-     * Seller approves a cancellation request
-     *
-     * @param cancelId The unique eBay-assigned identifier of the cancellation request to be approved.
-     */
-    approveCancellationRequest(cancelId: string): Promise<any>;
-    /**
-     * Check the eligibility of an order cancellation
-     *
-     * @param legacyOrderId The unique ID of the order being canceled or the order being considered for cancellation.
-     */
-    checkCancellationEligibility(legacyOrderId: string): Promise<any>;
-    /**
-     * Buyer confirms the refund from a cancellation was received
-     *
-     * @param cancelId The unique eBay-assigned identifier of the cancellation/refund being confirmed.
-     * @param payload the ConfirmRefundReceivedPayload
-     */
-    confirmRefundReceived(cancelId: string, payload?: ConfirmRefundRequest): Promise<any>;
-    /**
-     * Request or perform an order cancellation.
-     *
-     * @param payload the CreateCancelRequest
-     */
-    createCancellation(payload: CreateCancelRequest): Promise<any>;
-    /**
-     * Retrieve the details of an order cancellation.
-     *
-     * @param cancelId Supply in this path parameter the unique eBay-assigned ID of the cancellation request to
-     *     retrieve.
-     * @param fieldGroups    The value set in this query parameter controls the level of detail that is returned in the
-     *     response.
-     */
-    getCancellation(cancelId: string, fieldGroups?: string): Promise<any>;
-    /**
-     * Seller rejects a cancellation request.
-     *
-     * @param cancelId The unique eBay-assigned identifier of the cancellation request to be rejected.
-     * @param payload the RejectCancelRequest
-     */
-    rejectCancellationRequest(cancelId: string, payload?: RejectCancelRequest): Promise<any>;
-    /**
-     * Search for cancellations.
-     *
-     * @param params the SearchParams
-     */
-    search(params: CancellationSearchParams): Promise<any>;
-}
+import Restful from '../../index.js';
+import { CancellationSearchParams, ConfirmRefundRequest, CreateCancelRequest, RejectCancelRequest } from '../../../../types/index.js';
+/**
+ * Post-Order Cancellation API
+ */
+export default class Cancellation extends Restful {
+    static id: string;
+    get basePath(): string;
+    get useIaf(): boolean;
+    /**
+     * Seller approves a cancellation request
+     *
+     * @param cancelId The unique eBay-assigned identifier of the cancellation request to be approved.
+     */
+    approveCancellationRequest(cancelId: string): Promise<any>;
+    /**
+     * Check the eligibility of an order cancellation
+     *
+     * @param legacyOrderId The unique ID of the order being canceled or the order being considered for cancellation.
+     */
+    checkCancellationEligibility(legacyOrderId: string): Promise<any>;
+    /**
+     * Buyer confirms the refund from a cancellation was received
+     *
+     * @param cancelId The unique eBay-assigned identifier of the cancellation/refund being confirmed.
+     * @param payload the ConfirmRefundReceivedPayload
+     */
+    confirmRefundReceived(cancelId: string, payload?: ConfirmRefundRequest): Promise<any>;
+    /**
+     * Request or perform an order cancellation.
+     *
+     * @param payload the CreateCancelRequest
+     */
+    createCancellation(payload: CreateCancelRequest): Promise<any>;
+    /**
+     * Retrieve the details of an order cancellation.
+     *
+     * @param cancelId Supply in this path parameter the unique eBay-assigned ID of the cancellation request to
+     *     retrieve.
+     * @param fieldGroups    The value set in this query parameter controls the level of detail that is returned in the
+     *     response.
+     */
+    getCancellation(cancelId: string, fieldGroups?: string): Promise<any>;
+    /**
+     * Seller rejects a cancellation request.
+     *
+     * @param cancelId The unique eBay-assigned identifier of the cancellation request to be rejected.
+     * @param payload the RejectCancelRequest
+     */
+    rejectCancellationRequest(cancelId: string, payload?: RejectCancelRequest): Promise<any>;
+    /**
+     * Search for cancellations.
+     *
+     * @param params the SearchParams
+     */
+    search(params: CancellationSearchParams): Promise<any>;
+}

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

@@ -1,94 +1,94 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const index_js_1 = __importDefault(require("../../index.js"));
-/**
- * Post-Order Cancellation API
- */
-class Cancellation extends index_js_1.default {
-    get basePath() {
-        return '/post-order/v2';
-    }
-    get useIaf() {
-        return true;
-    }
-    /**
-     * Seller approves a cancellation request
-     *
-     * @param cancelId The unique eBay-assigned identifier of the cancellation request to be approved.
-     */
-    approveCancellationRequest(cancelId) {
-        cancelId = encodeURIComponent(cancelId);
-        return this.post(`/cancellation/${cancelId}/approve`);
-    }
-    /**
-     * Check the eligibility of an order cancellation
-     *
-     * @param legacyOrderId The unique ID of the order being canceled or the order being considered for cancellation.
-     */
-    checkCancellationEligibility(legacyOrderId) {
-        return this.post(`/cancellation/check_eligibility`, {
-            legacyOrderId
-        });
-    }
-    /**
-     * Buyer confirms the refund from a cancellation was received
-     *
-     * @param cancelId The unique eBay-assigned identifier of the cancellation/refund being confirmed.
-     * @param payload the ConfirmRefundReceivedPayload
-     */
-    confirmRefundReceived(cancelId, payload) {
-        cancelId = encodeURIComponent(cancelId);
-        return this.post(`/cancellation/${cancelId}/confirm`, payload);
-    }
-    /**
-     * Request or perform an order cancellation.
-     *
-     * @param payload the CreateCancelRequest
-     */
-    createCancellation(payload) {
-        return this.post(`/cancellation`, payload);
-    }
-    /**
-     * Retrieve the details of an order cancellation.
-     *
-     * @param cancelId Supply in this path parameter the unique eBay-assigned ID of the cancellation request to
-     *     retrieve.
-     * @param fieldGroups    The value set in this query parameter controls the level of detail that is returned in the
-     *     response.
-     */
-    getCancellation(cancelId, fieldGroups) {
-        cancelId = encodeURIComponent(cancelId);
-        return this.get(`/cancellation/${cancelId}`, {
-            params: {
-                fieldgroups: fieldGroups
-            }
-        });
-    }
-    /**
-     * Seller rejects a cancellation request.
-     *
-     * @param cancelId The unique eBay-assigned identifier of the cancellation request to be rejected.
-     * @param payload the RejectCancelRequest
-     */
-    rejectCancellationRequest(cancelId, payload) {
-        cancelId = encodeURIComponent(cancelId);
-        return this.post(`/cancellation/${cancelId}/reject`, payload);
-    }
-    /**
-     * Search for cancellations.
-     *
-     * @param params the SearchParams
-     */
-    search(params) {
-        return this.get(`/cancellation/search`, {
-            params: {
-                params
-            }
-        });
-    }
-}
-exports.default = Cancellation;
-Cancellation.id = 'Cancellation';
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const index_js_1 = __importDefault(require("../../index.js"));
+/**
+ * Post-Order Cancellation API
+ */
+class Cancellation extends index_js_1.default {
+    get basePath() {
+        return '/post-order/v2';
+    }
+    get useIaf() {
+        return true;
+    }
+    /**
+     * Seller approves a cancellation request
+     *
+     * @param cancelId The unique eBay-assigned identifier of the cancellation request to be approved.
+     */
+    approveCancellationRequest(cancelId) {
+        cancelId = encodeURIComponent(cancelId);
+        return this.post(`/cancellation/${cancelId}/approve`);
+    }
+    /**
+     * Check the eligibility of an order cancellation
+     *
+     * @param legacyOrderId The unique ID of the order being canceled or the order being considered for cancellation.
+     */
+    checkCancellationEligibility(legacyOrderId) {
+        return this.post(`/cancellation/check_eligibility`, {
+            legacyOrderId
+        });
+    }
+    /**
+     * Buyer confirms the refund from a cancellation was received
+     *
+     * @param cancelId The unique eBay-assigned identifier of the cancellation/refund being confirmed.
+     * @param payload the ConfirmRefundReceivedPayload
+     */
+    confirmRefundReceived(cancelId, payload) {
+        cancelId = encodeURIComponent(cancelId);
+        return this.post(`/cancellation/${cancelId}/confirm`, payload);
+    }
+    /**
+     * Request or perform an order cancellation.
+     *
+     * @param payload the CreateCancelRequest
+     */
+    createCancellation(payload) {
+        return this.post(`/cancellation`, payload);
+    }
+    /**
+     * Retrieve the details of an order cancellation.
+     *
+     * @param cancelId Supply in this path parameter the unique eBay-assigned ID of the cancellation request to
+     *     retrieve.
+     * @param fieldGroups    The value set in this query parameter controls the level of detail that is returned in the
+     *     response.
+     */
+    getCancellation(cancelId, fieldGroups) {
+        cancelId = encodeURIComponent(cancelId);
+        return this.get(`/cancellation/${cancelId}`, {
+            params: {
+                fieldgroups: fieldGroups
+            }
+        });
+    }
+    /**
+     * Seller rejects a cancellation request.
+     *
+     * @param cancelId The unique eBay-assigned identifier of the cancellation request to be rejected.
+     * @param payload the RejectCancelRequest
+     */
+    rejectCancellationRequest(cancelId, payload) {
+        cancelId = encodeURIComponent(cancelId);
+        return this.post(`/cancellation/${cancelId}/reject`, payload);
+    }
+    /**
+     * Search for cancellations.
+     *
+     * @param params the SearchParams
+     */
+    search(params) {
+        return this.get(`/cancellation/search`, {
+            params: {
+                params
+            }
+        });
+    }
+}
+Cancellation.id = 'Cancellation';
+exports.default = Cancellation;

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

@@ -1,63 +1,63 @@
-import Restful from '../../index.js';
-import { AppealRequest, BuyerCloseCaseRequest, CaseSearchParams, ReturnAddressRequest, Text } from '../../../../types/index.js';
-/**
- * Post-Order Case Management API
- */
-export default class Case extends Restful {
-    static id: string;
-    get basePath(): string;
-    get useIaf(): boolean;
-    /**
-     * Buyer or seller appeals a case decision.
-     *
-     * @param caseId The unique identifier of a case.
-     * @param payload the AppealRequest
-     */
-    appealCaseDecision(caseId: string, payload?: AppealRequest): Promise<any>;
-    /**
-     * Check the eligibility of an order cancellation.
-     *
-     * @param caseId The unique identifier of a case.
-     * @param payload the BuyerCloseCaseRequest
-     */
-    closeCase(caseId: string, payload: BuyerCloseCaseRequest): Promise<any>;
-    /**
-     * Retrieve the details related to a specific case.
-     *
-     * @param caseId The unique identifier of a case.
-     */
-    getCase(caseId: string): Promise<any>;
-    /**
-     * Seller issues a refund for a case.
-     *
-     * @param caseId The unique identifier of a case.
-     * @param payload the CaseVoluntaryRefundRequest (Text)
-     */
-    issueCaseRefund(caseId: string, payload?: Text): Promise<any>;
-    /**
-     * This call allows the buyer to provide shipment tracking information for the item that is being returned to the
-     * seller.
-     *
-     * @param caseId The unique identifier of a case.
-     * @param shippingCarrierName The shipping carrier that is used to ship the item, such as 'FedEx', 'UPS', or
-     *     'USPS'.
-     * @param trackingNumber The tracking number assigned by the shipping carrier to the item shipment.
-     */
-    provideReturnShipmentInfo(caseId: string, { shippingCarrierName, trackingNumber }: {
-        shippingCarrierName: string;
-        trackingNumber: string;
-    }): Promise<any>;
-    /**
-     * Seller provides a return address to the buyer.
-     *
-     * @param cancelId The unique eBay-assigned identifier of the cancellation request to be rejected.
-     * @param payload the ReturnAddressRequest
-     */
-    providesReturnAddress(cancelId: string, payload?: ReturnAddressRequest): Promise<any>;
-    /**
-     * This call is used to search for cases using multiple filter types.
-     *
-     * @param params the SearchParams
-     */
-    search(params: CaseSearchParams): Promise<any>;
-}
+import { AppealRequest, BuyerCloseCaseRequest, CaseSearchParams, ReturnAddressRequest, Text } from '../../../../types/index.js';
+import Restful from '../../index.js';
+/**
+ * Post-Order Case Management API
+ */
+export default class Case extends Restful {
+    static id: string;
+    get basePath(): string;
+    get useIaf(): boolean;
+    /**
+     * Buyer or seller appeals a case decision.
+     *
+     * @param caseId The unique identifier of a case.
+     * @param payload the AppealRequest
+     */
+    appealCaseDecision(caseId: string, payload?: AppealRequest): Promise<any>;
+    /**
+     * Check the eligibility of an order cancellation.
+     *
+     * @param caseId The unique identifier of a case.
+     * @param payload the BuyerCloseCaseRequest
+     */
+    closeCase(caseId: string, payload: BuyerCloseCaseRequest): Promise<any>;
+    /**
+     * Retrieve the details related to a specific case.
+     *
+     * @param caseId The unique identifier of a case.
+     */
+    getCase(caseId: string): Promise<any>;
+    /**
+     * Seller issues a refund for a case.
+     *
+     * @param caseId The unique identifier of a case.
+     * @param payload the CaseVoluntaryRefundRequest (Text)
+     */
+    issueCaseRefund(caseId: string, payload?: Text): Promise<any>;
+    /**
+     * This call allows the buyer to provide shipment tracking information for the item that is being returned to the
+     * seller.
+     *
+     * @param caseId The unique identifier of a case.
+     * @param shippingCarrierName The shipping carrier that is used to ship the item, such as 'FedEx', 'UPS', or
+     *     'USPS'.
+     * @param trackingNumber The tracking number assigned by the shipping carrier to the item shipment.
+     */
+    provideReturnShipmentInfo(caseId: string, { shippingCarrierName, trackingNumber }: {
+        shippingCarrierName: string;
+        trackingNumber: string;
+    }): Promise<any>;
+    /**
+     * Seller provides a return address to the buyer.
+     *
+     * @param cancelId The unique eBay-assigned identifier of the cancellation request to be rejected.
+     * @param payload the ReturnAddressRequest
+     */
+    providesReturnAddress(cancelId: string, payload?: ReturnAddressRequest): Promise<any>;
+    /**
+     * This call is used to search for cases using multiple filter types.
+     *
+     * @param params the SearchParams
+     */
+    search(params: CaseSearchParams): Promise<any>;
+}

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

@@ -1,94 +1,94 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const index_js_1 = __importDefault(require("../../index.js"));
-/**
- * Post-Order Case Management API
- */
-class Case extends index_js_1.default {
-    get basePath() {
-        return '/post-order/v2';
-    }
-    get useIaf() {
-        return true;
-    }
-    /**
-     * Buyer or seller appeals a case decision.
-     *
-     * @param caseId The unique identifier of a case.
-     * @param payload the AppealRequest
-     */
-    appealCaseDecision(caseId, payload) {
-        const id = encodeURIComponent(caseId);
-        return this.post(`/casemanagement/${id}/appeal`, payload);
-    }
-    /**
-     * Check the eligibility of an order cancellation.
-     *
-     * @param caseId The unique identifier of a case.
-     * @param payload the BuyerCloseCaseRequest
-     */
-    closeCase(caseId, payload) {
-        const id = encodeURIComponent(caseId);
-        return this.post(`/casemanagement/${id}/close`, payload);
-    }
-    /**
-     * Retrieve the details related to a specific case.
-     *
-     * @param caseId The unique identifier of a case.
-     */
-    getCase(caseId) {
-        const id = encodeURIComponent(caseId);
-        return this.get(`/casemanagement/${id}`);
-    }
-    /**
-     * Seller issues a refund for a case.
-     *
-     * @param caseId The unique identifier of a case.
-     * @param payload the CaseVoluntaryRefundRequest (Text)
-     */
-    issueCaseRefund(caseId, payload) {
-        const id = encodeURIComponent(caseId);
-        return this.post(`/casemanagement/${id}/issue_refund`, payload);
-    }
-    /**
-     * This call allows the buyer to provide shipment tracking information for the item that is being returned to the
-     * seller.
-     *
-     * @param caseId The unique identifier of a case.
-     * @param shippingCarrierName The shipping carrier that is used to ship the item, such as 'FedEx', 'UPS', or
-     *     'USPS'.
-     * @param trackingNumber The tracking number assigned by the shipping carrier to the item shipment.
-     */
-    provideReturnShipmentInfo(caseId, { shippingCarrierName, trackingNumber }) {
-        const id = encodeURIComponent(caseId);
-        return this.post(`/casemanagement/${id}/provide_shipment_info`, {
-            shippingCarrierName,
-            trackingNumber
-        });
-    }
-    /**
-     * Seller provides a return address to the buyer.
-     *
-     * @param cancelId The unique eBay-assigned identifier of the cancellation request to be rejected.
-     * @param payload the ReturnAddressRequest
-     */
-    providesReturnAddress(cancelId, payload) {
-        const id = encodeURIComponent(cancelId);
-        return this.post(`/casemanagement/${id}/provide_return_address`, payload);
-    }
-    /**
-     * This call is used to search for cases using multiple filter types.
-     *
-     * @param params the SearchParams
-     */
-    search(params) {
-        return this.get(`/casemanagement/search`, {
-            params
-        });
-    }
-}
-exports.default = Case;
-Case.id = 'Case';
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const index_js_1 = __importDefault(require("../../index.js"));
+/**
+ * Post-Order Case Management API
+ */
+class Case extends index_js_1.default {
+    get basePath() {
+        return '/post-order/v2';
+    }
+    get useIaf() {
+        return true;
+    }
+    /**
+     * Buyer or seller appeals a case decision.
+     *
+     * @param caseId The unique identifier of a case.
+     * @param payload the AppealRequest
+     */
+    appealCaseDecision(caseId, payload) {
+        const id = encodeURIComponent(caseId);
+        return this.post(`/casemanagement/${id}/appeal`, payload);
+    }
+    /**
+     * Check the eligibility of an order cancellation.
+     *
+     * @param caseId The unique identifier of a case.
+     * @param payload the BuyerCloseCaseRequest
+     */
+    closeCase(caseId, payload) {
+        const id = encodeURIComponent(caseId);
+        return this.post(`/casemanagement/${id}/close`, payload);
+    }
+    /**
+     * Retrieve the details related to a specific case.
+     *
+     * @param caseId The unique identifier of a case.
+     */
+    getCase(caseId) {
+        const id = encodeURIComponent(caseId);
+        return this.get(`/casemanagement/${id}`);
+    }
+    /**
+     * Seller issues a refund for a case.
+     *
+     * @param caseId The unique identifier of a case.
+     * @param payload the CaseVoluntaryRefundRequest (Text)
+     */
+    issueCaseRefund(caseId, payload) {
+        const id = encodeURIComponent(caseId);
+        return this.post(`/casemanagement/${id}/issue_refund`, payload);
+    }
+    /**
+     * This call allows the buyer to provide shipment tracking information for the item that is being returned to the
+     * seller.
+     *
+     * @param caseId The unique identifier of a case.
+     * @param shippingCarrierName The shipping carrier that is used to ship the item, such as 'FedEx', 'UPS', or
+     *     'USPS'.
+     * @param trackingNumber The tracking number assigned by the shipping carrier to the item shipment.
+     */
+    provideReturnShipmentInfo(caseId, { shippingCarrierName, trackingNumber }) {
+        const id = encodeURIComponent(caseId);
+        return this.post(`/casemanagement/${id}/provide_shipment_info`, {
+            shippingCarrierName,
+            trackingNumber
+        });
+    }
+    /**
+     * Seller provides a return address to the buyer.
+     *
+     * @param cancelId The unique eBay-assigned identifier of the cancellation request to be rejected.
+     * @param payload the ReturnAddressRequest
+     */
+    providesReturnAddress(cancelId, payload) {
+        const id = encodeURIComponent(cancelId);
+        return this.post(`/casemanagement/${id}/provide_return_address`, payload);
+    }
+    /**
+     * This call is used to search for cases using multiple filter types.
+     *
+     * @param params the SearchParams
+     */
+    search(params) {
+        return this.get(`/casemanagement/search`, {
+            params
+        });
+    }
+}
+Case.id = 'Case';
+exports.default = Case;

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

@@ -1,11 +1,11 @@
-import Cancellation from './cancellation/index.js';
-import Case from './case/index.js';
-import Inquiry from './inquiry/index.js';
-import Return from './return/index.js';
-export type PostOrder = {
-    cancellation: Cancellation;
-    case: Case;
-    inquiry: Inquiry;
-    return: Return;
-};
-export { Cancellation, Case, Inquiry, Return };
+import Cancellation from './cancellation/index.js';
+import Case from './case/index.js';
+import Inquiry from './inquiry/index.js';
+import Return from './return/index.js';
+export type PostOrder = {
+    cancellation: Cancellation;
+    case: Case;
+    inquiry: Inquiry;
+    return: Return;
+};
+export { Cancellation, Case, Inquiry, Return };