ebay-api 1.13.7 → 6.2.0

package/lib/api/restful/sell/metadata/index.d.ts

@@ -0,0 +1,77 @@
+import Restful from '../../';
+/**
+ * The Metadata API has operations that retrieve configuration details pertaining to the different eBay marketplaces.
+ */
+export default class Metadata extends Restful {
+    static id: string;
+    get basePath(): string;
+    /**
+     * This method retrieves all the sales tax jurisdictions for the country that you specify in the countryCode path
+     * parameter.
+     *
+     * @param countryCode This path parameter specifies the two-letter ISO 3166-1 Alpha-2 country code for the country
+     *     whose jurisdictions you want to retrieve.
+     */
+    getSalesTaxJurisdictions(countryCode: string): Promise<any>;
+    /**
+     * This method returns the eBay policies that define how to list automotive-parts-compatibility items in the
+     * categories of a specific marketplace.
+     *
+     * @param marketplaceId This path parameter specifies the eBay marketplace for which policy information is
+     *     retrieved.
+     * @param filter This query parameter limits the response by returning eBay policy information for only the leaf
+     *     categories specified by this parameter.
+     */
+    getAutomotivePartsCompatibilityPolicies(marketplaceId: string, filter?: string): Promise<any>;
+    /**
+     * This method returns the eBay policies that define how to specify item conditions in the categories of a specific
+     * marketplace.
+     *
+     * @param marketplaceId This path parameter specifies the eBay marketplace for which policy information is
+     *     retrieved.
+     * @param filter This query parameter limits the response by returning eBay policy information for only the leaf
+     *     categories specified by this parameter.
+     */
+    getItemConditionPolicies(marketplaceId: string, filter?: string): Promise<any>;
+    /**
+     * This method returns the eBay policies that define the allowed listing structures for the categories of a
+     * specific marketplace.
+     *
+     * @param marketplaceId This path parameter specifies the eBay marketplace for which policy information is
+     *     retrieved.
+     * @param filter This query parameter limits the response by returning eBay policy information for only the leaf
+     *     categories specified by this parameter.
+     */
+    getListingStructurePolicies(marketplaceId: string, filter?: string): Promise<any>;
+    /**
+     * This method returns the eBay policies that define the supported negotiated price features (like &quot;best
+     * offer&quot;) for the categories of a specific marketplace.
+     *
+     * @param marketplaceId This path parameter specifies the eBay marketplace for which policy information is
+     *     retrieved.
+     * @param filter This query parameter limits the response by returning eBay policy information for only the leaf
+     *     categories specified by this parameter.
+     */
+    getNegotiatedPricePolicies(marketplaceId: string, filter?: string): Promise<any>;
+    /**
+     * This method retrieves a list of leaf categories for a marketplace and identifies the categories that require
+     * items to have an eBay product ID value in order to be listed in those categories.
+     *
+     * @param marketplaceId This path parameter specifies the eBay marketplace for which policy information is
+     *     retrieved.
+     * @param filter This query parameter limits the response by returning eBay policy information for only the leaf
+     *     categories specified by this parameter.
+     */
+    getProductAdoptionPolicies(marketplaceId: string, filter?: string): Promise<any>;
+    /**
+     * This method returns the eBay policies that define whether or not you must include a return policy for the
+     * items you list in the categories of a specific marketplace, plus the guidelines for creating domestic and
+     * international return policies in the different eBay categories.
+     *
+     * @param marketplaceId This path parameter specifies the eBay marketplace for which policy information is
+     *     retrieved.
+     * @param filter This query parameter limits the response by returning eBay policy information for only the leaf
+     *     categories specified by this parameter.
+     */
+    getReturnPolicies(marketplaceId: string, filter?: string): Promise<any>;
+}

package/lib/api/restful/sell/metadata/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("../../"));
+/**
+ * The Metadata API has operations that retrieve configuration details pertaining to the different eBay marketplaces.
+ */
+class Metadata extends __1.default {
+    get basePath() {
+        return '/sell/metadata/v1';
+    }
+    /**
+     * This method retrieves all the sales tax jurisdictions for the country that you specify in the countryCode path
+     * parameter.
+     *
+     * @param countryCode This path parameter specifies the two-letter ISO 3166-1 Alpha-2 country code for the country
+     *     whose jurisdictions you want to retrieve.
+     */
+    getSalesTaxJurisdictions(countryCode) {
+        countryCode = encodeURIComponent(countryCode);
+        return this.get(`/country/${countryCode}/sales_tax_jurisdiction`);
+    }
+    /**
+     * This method returns the eBay policies that define how to list automotive-parts-compatibility items in the
+     * categories of a specific marketplace.
+     *
+     * @param marketplaceId This path parameter specifies the eBay marketplace for which policy information is
+     *     retrieved.
+     * @param filter This query parameter limits the response by returning eBay policy information for only the leaf
+     *     categories specified by this parameter.
+     */
+    getAutomotivePartsCompatibilityPolicies(marketplaceId, filter) {
+        marketplaceId = encodeURIComponent(marketplaceId);
+        return this.get(`/marketplace/${marketplaceId}/get_automotive_parts_compatibility_policies`, {
+            params: {
+                filter
+            }
+        });
+    }
+    /**
+     * This method returns the eBay policies that define how to specify item conditions in the categories of a specific
+     * marketplace.
+     *
+     * @param marketplaceId This path parameter specifies the eBay marketplace for which policy information is
+     *     retrieved.
+     * @param filter This query parameter limits the response by returning eBay policy information for only the leaf
+     *     categories specified by this parameter.
+     */
+    getItemConditionPolicies(marketplaceId, filter) {
+        marketplaceId = encodeURIComponent(marketplaceId);
+        return this.get(`/marketplace/${marketplaceId}/get_item_condition_policies`, {
+            params: {
+                filter
+            }
+        });
+    }
+    /**
+     * This method returns the eBay policies that define the allowed listing structures for the categories of a
+     * specific marketplace.
+     *
+     * @param marketplaceId This path parameter specifies the eBay marketplace for which policy information is
+     *     retrieved.
+     * @param filter This query parameter limits the response by returning eBay policy information for only the leaf
+     *     categories specified by this parameter.
+     */
+    getListingStructurePolicies(marketplaceId, filter) {
+        marketplaceId = encodeURIComponent(marketplaceId);
+        return this.get(`/marketplace/${marketplaceId}/get_listing_structure_policies`, {
+            params: {
+                filter
+            }
+        });
+    }
+    /**
+     * This method returns the eBay policies that define the supported negotiated price features (like "best
+     * offer") for the categories of a specific marketplace.
+     *
+     * @param marketplaceId This path parameter specifies the eBay marketplace for which policy information is
+     *     retrieved.
+     * @param filter This query parameter limits the response by returning eBay policy information for only the leaf
+     *     categories specified by this parameter.
+     */
+    getNegotiatedPricePolicies(marketplaceId, filter) {
+        marketplaceId = encodeURIComponent(marketplaceId);
+        return this.get(`/marketplace/${marketplaceId}/get_negotiated_price_policies`, {
+            params: {
+                filter
+            }
+        });
+    }
+    /**
+     * This method retrieves a list of leaf categories for a marketplace and identifies the categories that require
+     * items to have an eBay product ID value in order to be listed in those categories.
+     *
+     * @param marketplaceId This path parameter specifies the eBay marketplace for which policy information is
+     *     retrieved.
+     * @param filter This query parameter limits the response by returning eBay policy information for only the leaf
+     *     categories specified by this parameter.
+     */
+    getProductAdoptionPolicies(marketplaceId, filter) {
+        marketplaceId = encodeURIComponent(marketplaceId);
+        return this.get(`/marketplace/${marketplaceId}/get_product_adoption_policies`, {
+            params: {
+                filter
+            }
+        });
+    }
+    /**
+     * This method returns the eBay policies that define whether or not you must include a return policy for the
+     * items you list in the categories of a specific marketplace, plus the guidelines for creating domestic and
+     * international return policies in the different eBay categories.
+     *
+     * @param marketplaceId This path parameter specifies the eBay marketplace for which policy information is
+     *     retrieved.
+     * @param filter This query parameter limits the response by returning eBay policy information for only the leaf
+     *     categories specified by this parameter.
+     */
+    getReturnPolicies(marketplaceId, filter) {
+        marketplaceId = encodeURIComponent(marketplaceId);
+        return this.get(`/marketplace/${marketplaceId}/get_return_policies`, {
+            params: {
+                filter
+            }
+        });
+    }
+}
+exports.default = Metadata;
+Metadata.id = 'Metadata';
+//# sourceMappingURL=index.js.map

package/lib/api/restful/sell/metadata/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../src/api/restful/sell/metadata/index.ts"],"names":[],"mappings":";;;;;AAAA,+CAA6B;AAE7B;;GAEG;AACH,MAAqB,QAAS,SAAQ,WAAO;IAI3C,IAAI,QAAQ;QACV,OAAO,mBAAmB,CAAC;IAC7B,CAAC;IAED;;;;;;OAMG;IACI,wBAAwB,CAAC,WAAmB;QACjD,WAAW,GAAG,kBAAkB,CAAC,WAAW,CAAC,CAAC;QAC9C,OAAO,IAAI,CAAC,GAAG,CAAC,YAAY,WAAW,yBAAyB,CAAC,CAAC;IACpE,CAAC;IAED;;;;;;;;OAQG;IACI,uCAAuC,CAAC,aAAqB,EAAE,MAAe;QACnF,aAAa,GAAG,kBAAkB,CAAC,aAAa,CAAC,CAAC;QAClD,OAAO,IAAI,CAAC,GAAG,CAAC,gBAAgB,aAAa,8CAA8C,EAAE;YAC3F,MAAM,EAAE;gBACN,MAAM;aACP;SACF,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;OAQG;IACI,wBAAwB,CAAC,aAAqB,EAAE,MAAe;QACpE,aAAa,GAAG,kBAAkB,CAAC,aAAa,CAAC,CAAC;QAClD,OAAO,IAAI,CAAC,GAAG,CAAC,gBAAgB,aAAa,8BAA8B,EAAE;YAC3E,MAAM,EAAE;gBACN,MAAM;aACP;SACF,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;OAQG;IACI,2BAA2B,CAAC,aAAqB,EAAE,MAAe;QACvE,aAAa,GAAG,kBAAkB,CAAC,aAAa,CAAC,CAAC;QAClD,OAAO,IAAI,CAAC,GAAG,CAAC,gBAAgB,aAAa,iCAAiC,EAAE;YAC9E,MAAM,EAAE;gBACN,MAAM;aACP;SACF,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;OAQG;IACI,0BAA0B,CAAC,aAAqB,EAAE,MAAe;QACtE,aAAa,GAAG,kBAAkB,CAAC,aAAa,CAAC,CAAC;QAClD,OAAO,IAAI,CAAC,GAAG,CAAC,gBAAgB,aAAa,gCAAgC,EAAE;YAC7E,MAAM,EAAE;gBACN,MAAM;aACP;SACF,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;OAQG;IACI,0BAA0B,CAAC,aAAqB,EAAE,MAAe;QACtE,aAAa,GAAG,kBAAkB,CAAC,aAAa,CAAC,CAAC;QAClD,OAAO,IAAI,CAAC,GAAG,CAAC,gBAAgB,aAAa,gCAAgC,EAAE;YAC7E,MAAM,EAAE;gBACN,MAAM;aACP;SACF,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;OASG;IACI,iBAAiB,CAAC,aAAqB,EAAE,MAAe;QAC7D,aAAa,GAAG,kBAAkB,CAAC,aAAa,CAAC,CAAC;QAClD,OAAO,IAAI,CAAC,GAAG,CAAC,gBAAgB,aAAa,sBAAsB,EAAE;YACnE,MAAM,EAAE;gBACN,MAAM;aACP;SACF,CAAC,CAAC;IACL,CAAC;;AA/HH,2BAgIC;AA9HQ,WAAE,GAAG,UAAU,CAAC"}

package/lib/api/restful/sell/negotiation/index.d.ts

@@ -0,0 +1,24 @@
+import Restful from '../../';
+/**
+ * The <b>Negotiations API</b> gives sellers the ability to proactively send discount offers to buyers who have shown an "interest" in their listings.
+ */
+export default class Negotiation extends Restful {
+    static id: string;
+    get basePath(): string;
+    /**
+     * This method evaluates a seller's current listings and returns the set of IDs that are eligible for a seller-initiated discount offer to a buyer.
+     *
+     * @param limit This query parameter specifies the maximum number of items to return from the result set on a page in the paginated response.
+     * @param offset This query parameter specifies the number of results to skip in the result set before returning the first result in the paginated response.
+     */
+    findEligibleItems({ limit, offset }?: {
+        limit?: string;
+        offset?: string;
+    }): Promise<any>;
+    /**
+     * This method sends eligible buyers offers to purchase items in a listing at a discount.
+     *
+     * @param data The CreateOffersRequest
+     */
+    sendOfferToInterestedBuyers(data: any): Promise<any>;
+}

package/lib/api/restful/sell/negotiation/index.js

@@ -0,0 +1,39 @@
+"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("../../"));
+/**
+ * The <b>Negotiations API</b> gives sellers the ability to proactively send discount offers to buyers who have shown an "interest" in their listings.
+ */
+class Negotiation extends __1.default {
+    get basePath() {
+        return '/sell/negotiation/v1';
+    }
+    /**
+     * This method evaluates a seller's current listings and returns the set of IDs that are eligible for a seller-initiated discount offer to a buyer.
+     *
+     * @param limit This query parameter specifies the maximum number of items to return from the result set on a page in the paginated response.
+     * @param offset This query parameter specifies the number of results to skip in the result set before returning the first result in the paginated response.
+     */
+    findEligibleItems({ limit, offset } = {}) {
+        return this.get(`/find_eligible_items`, {
+            params: {
+                limit,
+                offset
+            }
+        });
+    }
+    /**
+     * This method sends eligible buyers offers to purchase items in a listing at a discount.
+     *
+     * @param data The CreateOffersRequest
+     */
+    sendOfferToInterestedBuyers(data) {
+        return this.post(`/send_offer_to_interested_buyers`, data);
+    }
+}
+exports.default = Negotiation;
+Negotiation.id = 'Negotiation';
+//# sourceMappingURL=index.js.map

package/lib/api/restful/sell/negotiation/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../src/api/restful/sell/negotiation/index.ts"],"names":[],"mappings":";;;;;AAAA,+CAA6B;AAE7B;;GAEG;AACH,MAAqB,WAAY,SAAQ,WAAO;IAI9C,IAAI,QAAQ;QACV,OAAO,sBAAsB,CAAC;IAChC,CAAC;IAED;;;;;OAKG;IACI,iBAAiB,CAAC,EAAC,KAAK,EAAE,MAAM,KAAyC,EAAE;QAChF,OAAO,IAAI,CAAC,GAAG,CAAC,sBAAsB,EAAE;YACtC,MAAM,EAAE;gBACN,KAAK;gBACL,MAAM;aACP;SACF,CAAC,CAAA;IACJ,CAAC;IAED;;;;OAIG;IACI,2BAA2B,CAAC,IAAS;QAC1C,OAAO,IAAI,CAAC,IAAI,CAAC,kCAAkC,EAAE,IAAI,CAAC,CAAA;IAC5D,CAAC;;AA9BH,8BA+BC;AA7BQ,cAAE,GAAG,aAAa,CAAC"}

package/lib/api/restful/sell/recommendation/index.d.ts

@@ -0,0 +1,26 @@
+import Restful from '../../';
+import { FindListingRecommendationRequest } from '../../../../types';
+/**
+ * The <b>Recommendation API</b> returns information that sellers can use to optimize the configuration of their
+ * listings on eBay.
+ */
+export default class Recommendation extends Restful {
+    static id: string;
+    get basePath(): string;
+    /**
+     * The find method returns recommendations and information that sellers can use to optimize their listing
+     * configurations.
+     *
+     * @param filter Provide a list of key-value pairs to specify the criteria you want to use to filter the response.
+     * @param limit Use this query parameter to set the maximum number of ads to return on a page from the paginated
+     *     response. Default: 10 Maximum: 500
+     * @param offset Specifies the number of ads to skip in the result set before returning the first ad in the
+     *     paginated response.
+     * @param body FindListingRecommendationRequest
+     */
+    findListingRecommendations({ filter, limit, offset }?: {
+        filter?: string;
+        limit?: number;
+        offset?: number;
+    }, body?: FindListingRecommendationRequest): Promise<any>;
+}

package/lib/api/restful/sell/recommendation/index.js

@@ -0,0 +1,39 @@
+"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("../../"));
+/**
+ * The <b>Recommendation API</b> returns information that sellers can use to optimize the configuration of their
+ * listings on eBay.
+ */
+class Recommendation extends __1.default {
+    get basePath() {
+        return '/sell/recommendation/v1';
+    }
+    /**
+     * The find method returns recommendations and information that sellers can use to optimize their listing
+     * configurations.
+     *
+     * @param filter Provide a list of key-value pairs to specify the criteria you want to use to filter the response.
+     * @param limit Use this query parameter to set the maximum number of ads to return on a page from the paginated
+     *     response. Default: 10 Maximum: 500
+     * @param offset Specifies the number of ads to skip in the result set before returning the first ad in the
+     *     paginated response.
+     * @param body FindListingRecommendationRequest
+     */
+    findListingRecommendations({ filter, limit, offset } = {}, body) {
+        return this.post(`/find`, {
+            data: body,
+            params: {
+                filter,
+                limit,
+                offset
+            }
+        });
+    }
+}
+exports.default = Recommendation;
+Recommendation.id = 'Recommendation';
+//# sourceMappingURL=index.js.map

package/lib/api/restful/sell/recommendation/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../src/api/restful/sell/recommendation/index.ts"],"names":[],"mappings":";;;;;AAAA,+CAA6B;AAG7B;;;GAGG;AACH,MAAqB,cAAe,SAAQ,WAAO;IAIjD,IAAI,QAAQ;QACV,OAAO,yBAAyB,CAAC;IACnC,CAAC;IAED;;;;;;;;;;OAUG;IACI,0BAA0B,CAAC,EAAC,MAAM,EAAE,KAAK,EAAE,MAAM,KAA0D,EAAE,EAClH,IAAuC;QAEvC,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE;YACxB,IAAI,EAAE,IAAI;YACV,MAAM,EAAE;gBACN,MAAM;gBACN,KAAK;gBACL,MAAM;aACP;SACF,CAAC,CAAC;IACL,CAAC;;AA9BH,iCA+BC;AA7BQ,iBAAE,GAAG,gBAAgB,CAAC"}

package/lib/api/traditional/XMLRequest.d.ts

@@ -0,0 +1,98 @@
+import xmlParser from 'fast-xml-parser';
+import { IEBayApiRequest } from '../../request';
+import { Fields } from './fields';
+export declare const defaultXML2JSONParseOptions: {
+    attributeNamePrefix: string;
+    textNodeName: string;
+    ignoreAttributes: boolean;
+    parseAttributeValue: boolean;
+    parseNodeValue: boolean;
+    ignoreNameSpace: boolean;
+    parseTrueNumberOnly: boolean;
+    arrayMode: (_: string, parentTageName: string) => boolean;
+};
+declare type Headers = {
+    [key: string]: string | number | undefined;
+};
+export declare type BodyHeaders = {
+    body: any;
+    headers?: Headers;
+};
+export declare type Options = {
+    raw?: boolean;
+    parseOptions?: object;
+    useIaf?: boolean;
+    headers?: Headers;
+    hook?: (xml: string) => BodyHeaders;
+};
+export declare type XMLReqConfig = Options & {
+    headers: Headers;
+    endpoint: string;
+    xmlns: string;
+    eBayAuthToken?: string | null;
+};
+export declare const defaultOptions: Required<Omit<Options, 'hook'>>;
+export declare const defaultHeaders: {
+    'Content-Type': string;
+};
+/**
+ * XML request for making eBay API call.
+ */
+export default class XMLRequest {
+    private readonly callName;
+    private readonly fields;
+    private readonly config;
+    private readonly req;
+    static j2x: xmlParser.j2xParser;
+    /**
+     * Creates the new Request object
+     *
+     * @private
+     * @param      {string}  callName the callname
+     * @param      {Object}  fields the fields
+     * @param      {Object} req the request
+     * @param      {XMLReqConfig}  config
+     */
+    constructor(callName: string, fields: Fields, config: XMLReqConfig, req: IEBayApiRequest);
+    /**
+     * returns the expected name of XML node of a Request
+     *
+     * @private
+     * @return     {String}  callnameReponse
+     */
+    private getResponseWrapper;
+    /**
+     * returns the XML structure for the SOAP auth
+     *
+     * @private
+     * @return     {Object}  the RequesterCredentials
+     */
+    private getCredentials;
+    private getParseOptions;
+    private getHeaders;
+    /**
+     * Converts an XML response to JSON
+     *
+     * @param      {string}     xml     the xml
+     * @return     {JSON}         resolves to a JSON representation of the HTML
+     */
+    toJSON(xml: string): any;
+    /**
+     * returns the XML document for the request
+     *
+     * @private
+     * @param      {Fields}  fields  the fields
+     * @return     {String}           The XML string of the Request
+     */
+    toXML(fields: Fields): string;
+    /**
+     * Call the xml api endpoint.
+     *
+     * @private
+     * @return     {Promise}           resolves to the response
+     *
+     */
+    request(): Promise<any>;
+    xml2JSON(xml: string): any;
+}
+export {};

package/lib/api/traditional/XMLRequest.js

@@ -0,0 +1,191 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.defaultHeaders = exports.defaultOptions = exports.defaultXML2JSONParseOptions = void 0;
+const debug_1 = __importDefault(require("debug"));
+const fast_xml_parser_1 = __importStar(require("fast-xml-parser"));
+const errors_1 = require("../../errors");
+const log = (0, debug_1.default)('ebay:xml:request');
+const defaultJSON2XMLOptions = {
+    attributeNamePrefix: '@_',
+    textNodeName: '#value',
+    ignoreAttributes: false,
+    cdataTagName: '__cdata',
+    cdataPositionChar: '\\c',
+    format: false,
+    indentBy: '  ',
+    suppressEmptyNode: false
+};
+exports.defaultXML2JSONParseOptions = {
+    attributeNamePrefix: '',
+    textNodeName: 'value',
+    ignoreAttributes: false,
+    parseAttributeValue: true,
+    parseNodeValue: true,
+    ignoreNameSpace: true,
+    parseTrueNumberOnly: true,
+    arrayMode: (_, parentTageName) => {
+        return /Array$/.test(parentTageName);
+    }
+};
+exports.defaultOptions = {
+    raw: false,
+    parseOptions: exports.defaultXML2JSONParseOptions,
+    useIaf: true,
+    headers: {}
+};
+exports.defaultHeaders = {
+    'Content-Type': 'text/xml'
+};
+/**
+ * XML request for making eBay API call.
+ */
+class XMLRequest {
+    /**
+     * Creates the new Request object
+     *
+     * @private
+     * @param      {string}  callName the callname
+     * @param      {Object}  fields the fields
+     * @param      {Object} req the request
+     * @param      {XMLReqConfig}  config
+     */
+    constructor(callName, fields, config, req) {
+        if (!callName) {
+            throw new errors_1.EbayNoCallError();
+        }
+        this.callName = callName;
+        this.fields = fields || {};
+        this.config = { ...exports.defaultOptions, ...config };
+        this.req = req;
+    }
+    /**
+     * returns the expected name of XML node of a Request
+     *
+     * @private
+     * @return     {String}  callnameReponse
+     */
+    getResponseWrapper() {
+        return `${this.callName}Response`;
+    }
+    /**
+     * returns the XML structure for the SOAP auth
+     *
+     * @private
+     * @return     {Object}  the RequesterCredentials
+     */
+    getCredentials() {
+        return this.config.eBayAuthToken ? {
+            RequesterCredentials: {
+                eBayAuthToken: this.config.eBayAuthToken
+            }
+        } : {};
+    }
+    getParseOptions() {
+        return {
+            ...exports.defaultXML2JSONParseOptions,
+            ...this.config.parseOptions
+        };
+    }
+    getHeaders() {
+        return {
+            ...exports.defaultHeaders,
+            ...this.config.headers,
+        };
+    }
+    /**
+     * Converts an XML response to JSON
+     *
+     * @param      {string}     xml     the xml
+     * @return     {JSON}         resolves to a JSON representation of the HTML
+     */
+    toJSON(xml) {
+        const parseOptions = this.getParseOptions();
+        log('parseOption', parseOptions);
+        return fast_xml_parser_1.default.parse(xml, parseOptions);
+    }
+    /**
+     * returns the XML document for the request
+     *
+     * @private
+     * @param      {Fields}  fields  the fields
+     * @return     {String}           The XML string of the Request
+     */
+    toXML(fields) {
+        const HEADING = '<?xml version="1.0" encoding="utf-8"?>';
+        return HEADING + XMLRequest.j2x.parse({
+            [this.callName + 'Request']: {
+                '@_xmlns': this.config.xmlns,
+                ...this.getCredentials(),
+                ...fields
+            }
+        });
+    }
+    /**
+     * Call the xml api endpoint.
+     *
+     * @private
+     * @return     {Promise}           resolves to the response
+     *
+     */
+    async request() {
+        const xml = this.toXML(this.fields);
+        log('xml', xml);
+        try {
+            const { body, headers = {} } = this.config.hook?.(xml) ?? { body: xml };
+            const config = {
+                headers: {
+                    ...this.getHeaders(),
+                    ...(headers ? headers : {})
+                }
+            };
+            log('config', config);
+            const response = await this.req.post(this.config.endpoint, body, config);
+            log('response', response);
+            // resolve to raw XML
+            if (this.config.raw) {
+                return response;
+            }
+            const json = this.xml2JSON(response);
+            (0, errors_1.checkEBayResponse)(json);
+            return json;
+        }
+        catch (error) {
+            log('error', error);
+            if (error.response?.data) {
+                const json = this.toJSON(error.response.data);
+                (0, errors_1.checkEBayResponse)(json);
+            }
+            throw error;
+        }
+    }
+    xml2JSON(xml) {
+        const json = this.toJSON(xml);
+        // Unwrap
+        return json[this.getResponseWrapper()] ?? json;
+    }
+}
+exports.default = XMLRequest;
+XMLRequest.j2x = new fast_xml_parser_1.j2xParser(defaultJSON2XMLOptions);
+//# sourceMappingURL=XMLRequest.js.map

package/lib/api/traditional/XMLRequest.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"XMLRequest.js","sourceRoot":"","sources":["../../../src/api/traditional/XMLRequest.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;AAAA,kDAA0B;AAC1B,mEAAqD;AAErD,yCAAgE;AAIhE,MAAM,GAAG,GAAG,IAAA,eAAK,EAAC,kBAAkB,CAAC,CAAC;AAEtC,MAAM,sBAAsB,GAAG;IAC7B,mBAAmB,EAAE,IAAI;IACzB,YAAY,EAAE,QAAQ;IACtB,gBAAgB,EAAE,KAAK;IACvB,YAAY,EAAE,SAAS;IACvB,iBAAiB,EAAE,KAAK;IACxB,MAAM,EAAE,KAAK;IACb,QAAQ,EAAE,IAAI;IACd,iBAAiB,EAAE,KAAK;CACzB,CAAC;AAEW,QAAA,2BAA2B,GAAG;IACzC,mBAAmB,EAAE,EAAE;IACvB,YAAY,EAAE,OAAO;IACrB,gBAAgB,EAAE,KAAK;IACvB,mBAAmB,EAAE,IAAI;IACzB,cAAc,EAAE,IAAI;IACpB,eAAe,EAAE,IAAI;IACrB,mBAAmB,EAAE,IAAI;IACzB,SAAS,EAAE,CAAC,CAAS,EAAE,cAAsB,EAAE,EAAE;QAC/C,OAAO,QAAQ,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;IACvC,CAAC;CACF,CAAC;AA0BW,QAAA,cAAc,GAAoC;IAC7D,GAAG,EAAE,KAAK;IACV,YAAY,EAAE,mCAA2B;IACzC,MAAM,EAAE,IAAI;IACZ,OAAO,EAAE,EAAE;CACZ,CAAC;AAEW,QAAA,cAAc,GAAG;IAC5B,cAAc,EAAE,UAAU;CAC3B,CAAC;AAEF;;GAEG;AACH,MAAqB,UAAU;IAQ7B;;;;;;;;OAQG;IACH,YAAY,QAAgB,EAAE,MAAc,EAAE,MAAoB,EAAE,GAAoB;QACtF,IAAI,CAAC,QAAQ,EAAE;YACb,MAAM,IAAI,wBAAe,EAAE,CAAC;SAC7B;QAED,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;QACzB,IAAI,CAAC,MAAM,GAAG,MAAM,IAAI,EAAE,CAAC;QAC3B,IAAI,CAAC,MAAM,GAAG,EAAC,GAAG,sBAAc,EAAE,GAAG,MAAM,EAAC,CAAC;QAC7C,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC;IACjB,CAAC;IAED;;;;;OAKG;IACK,kBAAkB;QACxB,OAAO,GAAG,IAAI,CAAC,QAAQ,UAAU,CAAC;IACpC,CAAC;IAED;;;;;OAKG;IACK,cAAc;QACpB,OAAO,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC,CAAC;YACjC,oBAAoB,EAAE;gBACpB,aAAa,EAAE,IAAI,CAAC,MAAM,CAAC,aAAa;aACzC;SACF,CAAC,CAAC,CAAC,EAAE,CAAC;IACT,CAAC;IAEO,eAAe;QACrB,OAAO;YACL,GAAG,mCAA2B;YAC9B,GAAG,IAAI,CAAC,MAAM,CAAC,YAAY;SAC5B,CAAC;IACJ,CAAC;IAEO,UAAU;QAChB,OAAO;YACL,GAAG,sBAAc;YACjB,GAAG,IAAI,CAAC,MAAM,CAAC,OAAO;SACvB,CAAC;IACJ,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,GAAW;QACvB,MAAM,YAAY,GAAG,IAAI,CAAC,eAAe,EAAE,CAAC;QAC5C,GAAG,CAAC,aAAa,EAAE,YAAY,CAAC,CAAC;QACjC,OAAO,yBAAS,CAAC,KAAK,CAAC,GAAG,EAAE,YAAY,CAAC,CAAC;IAC5C,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,MAAc;QACzB,MAAM,OAAO,GAAG,wCAAwC,CAAC;QACzD,OAAO,OAAO,GAAG,UAAU,CAAC,GAAG,CAAC,KAAK,CAAC;YACpC,CAAC,IAAI,CAAC,QAAQ,GAAG,SAAS,CAAC,EAAE;gBAC3B,SAAS,EAAE,IAAI,CAAC,MAAM,CAAC,KAAK;gBAC5B,GAAG,IAAI,CAAC,cAAc,EAAE;gBACxB,GAAG,MAAM;aACV;SACF,CAAC,CAAC;IACL,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,OAAO;QAClB,MAAM,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QACpC,GAAG,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC;QAEhB,IAAI;YACF,MAAM,EAAC,IAAI,EAAE,OAAO,GAAG,EAAE,EAAC,GAAG,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC,GAAG,CAAC,IAAI,EAAC,IAAI,EAAE,GAAG,EAAC,CAAC;YAEpE,MAAM,MAAM,GAAG;gBACb,OAAO,EAAE;oBACP,GAAG,IAAI,CAAC,UAAU,EAAE;oBACpB,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC;iBAC5B;aACF,CAAC;YACF,GAAG,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;YACtB,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE,IAAI,EAAE,MAAM,CAAC,CAAC;YAEzE,GAAG,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAC;YAE1B,qBAAqB;YACrB,IAAI,IAAI,CAAC,MAAM,CAAC,GAAG,EAAE;gBACnB,OAAO,QAAQ,CAAC;aACjB;YAED,MAAM,IAAI,GAAG,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;YAErC,IAAA,0BAAiB,EAAC,IAAI,CAAC,CAAC;YAExB,OAAO,IAAI,CAAC;SACb;QAAC,OAAO,KAAU,EAAE;YACnB,GAAG,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;YAEpB,IAAI,KAAK,CAAC,QAAQ,EAAE,IAAI,EAAE;gBACxB,MAAM,IAAI,GAAG,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;gBAC9C,IAAA,0BAAiB,EAAC,IAAI,CAAC,CAAC;aACzB;YAED,MAAM,KAAK,CAAC;SACb;IACH,CAAC;IAEM,QAAQ,CAAC,GAAW;QACzB,MAAM,IAAI,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QAE9B,SAAS;QACT,OAAO,IAAI,CAAC,IAAI,CAAC,kBAAkB,EAAE,CAAC,IAAI,IAAI,CAAC;IACjD,CAAC;;AApJH,6BAqJC;AA/Ie,cAAG,GAAG,IAAI,2BAAS,CAAC,sBAAsB,CAAC,CAAC"}

package/lib/api/traditional/clientAlerts/index.d.ts

@@ -0,0 +1,9 @@
+import { EventType } from './types';
+declare enum calls {
+    GetPublicAlerts = 0,
+    GetUserAlerts = 1,
+    Login = 2,
+    Logout = 3
+}
+export { EventType };
+export default calls;