ebay-api 8.4.1 → 8.5.1

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

@@ -1,38 +1,38 @@
-"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"));
-/**
- * The <b>Recommendation API</b> returns information that sellers can use to optimize the configuration of their
- * listings on eBay.
- */
-class Recommendation extends index_js_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';
+"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"));
+/**
+ * The <b>Recommendation API</b> returns information that sellers can use to optimize the configuration of their
+ * listings on eBay.
+ */
+class Recommendation extends index_js_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
+            }
+        });
+    }
+}
+Recommendation.id = 'Recommendation';
+exports.default = Recommendation;

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

@@ -1,109 +1,109 @@
-import { XMLBuilder } from 'fast-xml-parser';
-import { IEBayApiRequest } from '../../request.js';
-import { ApiRequestConfig, Headers } from '../../types/index.js';
-import { Fields } from './fields.js';
-export declare const defaultJSON2XMLOptions: {
-    attributeNamePrefix: string;
-    textNodeName: string;
-    ignoreAttributes: boolean;
-    cdataTagName: string;
-    cdataPositionChar: string;
-    format: boolean;
-    indentBy: string;
-    suppressEmptyNode: boolean;
-    cdataPropName: string;
-};
-export declare const defaultXML2JSONParseOptions: {
-    attributeNamePrefix: string;
-    textNodeName: string;
-    ignoreAttributes: boolean;
-    parseAttributeValue: boolean;
-    parseNodeValue: boolean;
-    numberParseOptions: {
-        hex: boolean;
-        leadingZeros: boolean;
-    };
-    removeNSPrefix: boolean;
-    isArray: (name: string, jpath: string) => boolean;
-};
-export type BodyHeaders = {
-    body: any;
-    headers: Headers;
-};
-export type TraditionalApiConfig = {
-    raw?: boolean;
-    parseOptions?: object;
-    useIaf?: boolean;
-    sign?: boolean;
-    hook?: (xml: string) => BodyHeaders;
-} & ApiRequestConfig;
-export type XMLReqConfig = TraditionalApiConfig & {
-    endpoint: string;
-    xmlns: string;
-    eBayAuthToken?: string | null;
-    digitalSignatureHeaders?: (payload: any) => Headers;
-};
-export declare const defaultApiConfig: Required<Omit<TraditionalApiConfig, '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: XMLBuilder;
-    /**
-     * 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 | null, 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;
-}
+import { XMLBuilder } from 'fast-xml-parser';
+import { IEBayApiRequest } from '../../request.js';
+import { ApiRequestConfig, Headers } from '../../types/index.js';
+import { Fields } from './fields.js';
+export declare const defaultJSON2XMLOptions: {
+    attributeNamePrefix: string;
+    textNodeName: string;
+    ignoreAttributes: boolean;
+    cdataTagName: string;
+    cdataPositionChar: string;
+    format: boolean;
+    indentBy: string;
+    suppressEmptyNode: boolean;
+    cdataPropName: string;
+};
+export declare const defaultXML2JSONParseOptions: {
+    attributeNamePrefix: string;
+    textNodeName: string;
+    ignoreAttributes: boolean;
+    parseAttributeValue: boolean;
+    parseNodeValue: boolean;
+    numberParseOptions: {
+        hex: boolean;
+        leadingZeros: boolean;
+    };
+    removeNSPrefix: boolean;
+    isArray: (name: string, jpath: string) => boolean;
+};
+export type BodyHeaders = {
+    body: any;
+    headers: Headers;
+};
+export type TraditionalApiConfig = {
+    raw?: boolean;
+    parseOptions?: object;
+    useIaf?: boolean;
+    sign?: boolean;
+    hook?: (xml: string) => BodyHeaders;
+} & ApiRequestConfig;
+export type XMLReqConfig = TraditionalApiConfig & {
+    endpoint: string;
+    xmlns: string;
+    eBayAuthToken?: string | null;
+    digitalSignatureHeaders?: (payload: any) => Headers;
+};
+export declare const defaultApiConfig: Required<Omit<TraditionalApiConfig, '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: XMLBuilder;
+    /**
+     * 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 | null, 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;
+}

package/lib/api/traditional/XMLRequest.js

@@ -1,182 +1,182 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.defaultHeaders = exports.defaultApiConfig = exports.defaultXML2JSONParseOptions = exports.defaultJSON2XMLOptions = void 0;
-const debug_1 = __importDefault(require("debug"));
-const fast_xml_parser_1 = require("fast-xml-parser");
-const index_js_1 = require("../../errors/index.js");
-const log = (0, debug_1.default)('ebay:xml:request');
-exports.defaultJSON2XMLOptions = {
-    attributeNamePrefix: '@_',
-    textNodeName: '#value',
-    ignoreAttributes: false,
-    cdataTagName: '__cdata',
-    cdataPositionChar: '\\c',
-    format: false,
-    indentBy: '  ',
-    suppressEmptyNode: false,
-    cdataPropName: '__cdata'
-};
-exports.defaultXML2JSONParseOptions = {
-    attributeNamePrefix: '',
-    textNodeName: 'value',
-    ignoreAttributes: false,
-    parseAttributeValue: true,
-    parseNodeValue: true,
-    numberParseOptions: {
-        hex: false,
-        leadingZeros: false
-    },
-    removeNSPrefix: true,
-    isArray: (name, jpath) => {
-        return /Array$/.test(jpath.slice(0, -name.length - 1));
-    }
-};
-exports.defaultApiConfig = {
-    raw: false,
-    parseOptions: exports.defaultXML2JSONParseOptions,
-    useIaf: true,
-    sign: false,
-    headers: {},
-    returnResponse: false
-};
-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 index_js_1.EbayNoCallError();
-        }
-        this.callName = callName;
-        this.fields = fields || {};
-        this.config = { ...exports.defaultApiConfig, ...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 new fast_xml_parser_1.XMLParser(parseOptions).parse(xml);
-    }
-    /**
-     * 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.build({
-            [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(),
-                    ...this.config.digitalSignatureHeaders ? this.config.digitalSignatureHeaders(body) : {},
-                    ...(headers ? headers : {})
-                }
-            };
-            log('config', config);
-            const response = await this.req.post(this.config.endpoint, body, config);
-            log('response', response);
-            if (this.config.returnResponse) {
-                return response;
-            }
-            const { data } = response;
-            // return raw XML
-            if (this.config.raw) {
-                return data;
-            }
-            const json = this.xml2JSON(data);
-            (0, index_js_1.checkEBayResponse)(json);
-            return json;
-        }
-        catch (error) {
-            log('error', error);
-            if (error.response?.data) {
-                const json = this.toJSON(error.response.data);
-                (0, index_js_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.XMLBuilder(exports.defaultJSON2XMLOptions);
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.defaultHeaders = exports.defaultApiConfig = exports.defaultXML2JSONParseOptions = exports.defaultJSON2XMLOptions = void 0;
+const debug_1 = __importDefault(require("debug"));
+const fast_xml_parser_1 = require("fast-xml-parser");
+const index_js_1 = require("../../errors/index.js");
+const log = (0, debug_1.default)('ebay:xml:request');
+exports.defaultJSON2XMLOptions = {
+    attributeNamePrefix: '@_',
+    textNodeName: '#value',
+    ignoreAttributes: false,
+    cdataTagName: '__cdata',
+    cdataPositionChar: '\\c',
+    format: false,
+    indentBy: '  ',
+    suppressEmptyNode: false,
+    cdataPropName: '__cdata'
+};
+exports.defaultXML2JSONParseOptions = {
+    attributeNamePrefix: '',
+    textNodeName: 'value',
+    ignoreAttributes: false,
+    parseAttributeValue: true,
+    parseNodeValue: true,
+    numberParseOptions: {
+        hex: false,
+        leadingZeros: false
+    },
+    removeNSPrefix: true,
+    isArray: (name, jpath) => {
+        return /Array$/.test(jpath.slice(0, -name.length - 1));
+    }
+};
+exports.defaultApiConfig = {
+    raw: false,
+    parseOptions: exports.defaultXML2JSONParseOptions,
+    useIaf: true,
+    sign: false,
+    headers: {},
+    returnResponse: false
+};
+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 index_js_1.EbayNoCallError();
+        }
+        this.callName = callName;
+        this.fields = fields || {};
+        this.config = { ...exports.defaultApiConfig, ...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 new fast_xml_parser_1.XMLParser(parseOptions).parse(xml);
+    }
+    /**
+     * 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.build({
+            [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(),
+                    ...this.config.digitalSignatureHeaders ? this.config.digitalSignatureHeaders(body) : {},
+                    ...(headers ? headers : {})
+                }
+            };
+            log('config', config);
+            const response = await this.req.post(this.config.endpoint, body, config);
+            log('response', response);
+            if (this.config.returnResponse) {
+                return response;
+            }
+            const { data } = response;
+            // return raw XML
+            if (this.config.raw) {
+                return data;
+            }
+            const json = this.xml2JSON(data);
+            (0, index_js_1.checkEBayResponse)(json);
+            return json;
+        }
+        catch (error) {
+            log('error', error);
+            if (error.response?.data) {
+                const json = this.toJSON(error.response.data);
+                (0, index_js_1.checkEBayResponse)(json);
+            }
+            throw error;
+        }
+    }
+    xml2JSON(xml) {
+        const json = this.toJSON(xml);
+        // Unwrap
+        return json[this.getResponseWrapper()] ?? json;
+    }
+}
+XMLRequest.j2x = new fast_xml_parser_1.XMLBuilder(exports.defaultJSON2XMLOptions);
+exports.default = XMLRequest;