ebay-api 8.5.0 → 8.6.0

package/dist/api/restful/index.js

@@ -3,7 +3,6 @@ import Api from '../index.js';
 export const defaultApiHeaders = {
     'Content-Type': 'application/json',
     'Cache-Control': 'no-cache',
-    // @ts-ignore
     ...(typeof window === 'undefined' ? {
         'Accept-Encoding': 'application/gzip'
     } : {})
@@ -25,9 +24,6 @@ export default class Restful extends Api {
     static buildServerUrl(schema, subdomain, sandbox, tld) {
         return `${schema}${subdomain}.${sandbox ? 'sandbox.' : ''}${tld}`;
     }
-    /**
-     * Enable to supports the use of OAuth tokens for user authorization.
-     */
     get useIaf() {
         return false;
     }
@@ -60,29 +56,15 @@ export default class Restful extends Api {
     get baseUrl() {
         return this.getServerUrl(this.apiConfig);
     }
-    /**
-     * Create a new instances of it self with specified api config.
-     * @param apiConfig
-     */
     api(apiConfig) {
-        // @ts-ignore
         return new this.constructor(this.config, this.req, this.auth, apiConfig);
     }
-    /**
-     * Use "apix" subdomain
-     */
     get apix() {
         return this.api({ subdomain: 'apix' });
     }
-    /**
-     * Use "apiz" subdomain
-     */
     get apiz() {
         return this.api({ subdomain: 'apiz' });
     }
-    /**
-     * Sign request
-     */
     get sign() {
         return this.api({ sign: true });
     }
@@ -100,10 +82,8 @@ export default class Restful extends Api {
     }
     get additionalHeaders() {
         return Object.keys(additionalHeaders)
-            // @ts-ignore
             .filter(key => typeof this.config[key] !== 'undefined')
             .reduce((headers, key) => {
-            // @ts-ignore
             headers[additionalHeaders[key]] = this.config[key];
             return headers;
         }, {});
@@ -136,8 +116,7 @@ export default class Restful extends Api {
         }
         catch (error) {
             if (this.shouldRefreshToken(error)) {
-                // Try again and refresh token
-                return await this.request(payload, apiConfig, true /* refresh token */);
+                return await this.request(payload, apiConfig, true);
             }
             throw error;
         }
@@ -164,7 +143,6 @@ export default class Restful extends Api {
             }
             const enrichedConfig = await this.enrichRequestConfig(apiRequest, data, apiCfg);
             const args = ['get', 'delete'].includes(method) ? [enrichedConfig] : [data, enrichedConfig];
-            // @ts-ignore
             const response = await this.req[method](endpoint, ...args);
             if (this.apiConfig.returnResponse) {
                 return response;

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

@@ -1,57 +1,14 @@
 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/dist/api/restful/postOrder/cancellation/index.js

@@ -1,7 +1,4 @@
 import Restful from '../../index.js';
-/**
- * Post-Order Cancellation API
- */
 class Cancellation extends Restful {
     get basePath() {
         return '/post-order/v2';
@@ -9,51 +6,22 @@ class Cancellation extends Restful {
     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}`, {
@@ -62,21 +30,10 @@ class Cancellation extends Restful {
             }
         });
     }
-    /**
-     * 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: {

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

@@ -1,63 +1,17 @@
 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/dist/api/restful/postOrder/case/index.js

@@ -1,7 +1,4 @@
 import Restful from '../../index.js';
-/**
- * Post-Order Case Management API
- */
 class Case extends Restful {
     get basePath() {
         return '/post-order/v2';
@@ -9,54 +6,22 @@ class Case extends Restful {
     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`, {
@@ -64,21 +29,10 @@ class Case extends Restful {
             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

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

@@ -1,82 +1,18 @@
 import Restful from '../../index.js';
 import { BuyerCloseInquiryRequest, CheckInquiryEligibilityRequest, CreateInquiryRequest, EscalateInquiryRequest, InquirySearchParams, InquiryVoluntaryRefundRequest, SellerProvideRefundInfoRequest, SendMessageRequest, ShipmentInfoRequest } from '../../../../types/index.js';
-/**
- * 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/dist/api/restful/postOrder/inquiry/index.js

@@ -1,7 +1,4 @@
 import Restful from '../../index.js';
-/**
- * Post-Order Inquiry API
- */
 class Inquiry extends Restful {
     get basePath() {
         return '/post-order/v2';
@@ -9,20 +6,9 @@ class Inquiry extends Restful {
     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') {
@@ -30,92 +16,42 @@ class Inquiry extends Restful {
         }
         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);