ebay-api 8.4.1 → 8.5.1

package/dist/api/traditional/finding/index.d.ts

@@ -1,12 +1,12 @@
-declare enum calls {
-    findCompletedItems = 0,
-    findItemsAdvanced = 1,
-    findItemsByCategory = 2,
-    findItemsByKeywords = 3,
-    findItemsByProduct = 4,
-    findItemsIneBayStores = 5,
-    getHistograms = 6,
-    getSearchKeywordsRecommendation = 7,
-    getVersion = 8
-}
-export default calls;
+declare enum calls {
+    findCompletedItems = 0,
+    findItemsAdvanced = 1,
+    findItemsByCategory = 2,
+    findItemsByKeywords = 3,
+    findItemsByProduct = 4,
+    findItemsIneBayStores = 5,
+    getHistograms = 6,
+    getSearchKeywordsRecommendation = 7,
+    getVersion = 8
+}
+export default calls;

package/dist/api/traditional/finding/index.js

@@ -1,13 +1,13 @@
-var calls;
-(function (calls) {
-    calls[calls["findCompletedItems"] = 0] = "findCompletedItems";
-    calls[calls["findItemsAdvanced"] = 1] = "findItemsAdvanced";
-    calls[calls["findItemsByCategory"] = 2] = "findItemsByCategory";
-    calls[calls["findItemsByKeywords"] = 3] = "findItemsByKeywords";
-    calls[calls["findItemsByProduct"] = 4] = "findItemsByProduct";
-    calls[calls["findItemsIneBayStores"] = 5] = "findItemsIneBayStores";
-    calls[calls["getHistograms"] = 6] = "getHistograms";
-    calls[calls["getSearchKeywordsRecommendation"] = 7] = "getSearchKeywordsRecommendation";
-    calls[calls["getVersion"] = 8] = "getVersion";
-})(calls || (calls = {}));
-export default calls;
+var calls;
+(function (calls) {
+    calls[calls["findCompletedItems"] = 0] = "findCompletedItems";
+    calls[calls["findItemsAdvanced"] = 1] = "findItemsAdvanced";
+    calls[calls["findItemsByCategory"] = 2] = "findItemsByCategory";
+    calls[calls["findItemsByKeywords"] = 3] = "findItemsByKeywords";
+    calls[calls["findItemsByProduct"] = 4] = "findItemsByProduct";
+    calls[calls["findItemsIneBayStores"] = 5] = "findItemsIneBayStores";
+    calls[calls["getHistograms"] = 6] = "getHistograms";
+    calls[calls["getSearchKeywordsRecommendation"] = 7] = "getSearchKeywordsRecommendation";
+    calls[calls["getVersion"] = 8] = "getVersion";
+})(calls || (calls = {}));
+export default calls;

package/dist/api/traditional/index.d.ts

@@ -1,17 +1,17 @@
-import { ClientAlerts, Finding, Merchandising, Shopping, Trading } from '../../types/index.js';
-import Api from '../index.js';
-/**
- * Traditional eBay API.
- */
-export default class Traditional extends Api {
-    createTradingApi(): Trading;
-    createShoppingApi(): Shopping;
-    createFindingApi(): Finding;
-    createClientAlertsApi(): ClientAlerts;
-    createMerchandisingApi(): Merchandising;
-    createBusinessPolicyManagementApi(): void;
-    private createXMLRequest;
-    private request;
-    private getConfig;
-    private createTraditionalXMLApi;
-}
+import { ClientAlerts, Finding, Merchandising, Shopping, Trading } from '../../types/index.js';
+import Api from '../index.js';
+/**
+ * Traditional eBay API.
+ */
+export default class Traditional extends Api {
+    createTradingApi(): Trading;
+    createShoppingApi(): Shopping;
+    createFindingApi(): Finding;
+    createClientAlertsApi(): ClientAlerts;
+    createMerchandisingApi(): Merchandising;
+    createBusinessPolicyManagementApi(): void;
+    private createXMLRequest;
+    private request;
+    private getConfig;
+    private createTraditionalXMLApi;
+}

package/dist/api/traditional/index.js

@@ -1,191 +1,191 @@
-import { stringify } from 'qs';
-import { EBayIAFTokenExpired, EBayIAFTokenInvalid, handleEBayError } from '../../errors/index.js';
-import Api from '../index.js';
-import ClientAlertsCalls from './clientAlerts/index.js';
-import FindingCalls from './finding/index.js';
-import MerchandisingCalls from './merchandising/index.js';
-import ShoppingCalls from './shopping/index.js';
-import TradingCalls from './trading/index.js';
-import XMLRequest, { defaultApiConfig } from './XMLRequest.js';
-/**
- * Traditional eBay API.
- */
-export default class Traditional extends Api {
-    constructor() {
-        super(...arguments);
-        this.createXMLRequest = (callName, api) => async (fields, opts) => {
-            const apiConfig = { ...defaultApiConfig, ...opts };
-            try {
-                return await this.request(apiConfig, api, callName, fields);
-            }
-            catch (error) {
-                // Try to refresh the token.
-                if (this.config.autoRefreshToken && (error.name === EBayIAFTokenExpired.name || error.name === EBayIAFTokenInvalid.name)) {
-                    return await this.request(apiConfig, api, callName, fields, true);
-                }
-                throw error;
-            }
-        };
-    }
-    createTradingApi() {
-        if (typeof this.config.siteId !== 'number') {
-            throw new Error('siteId is required for trading API.');
-        }
-        return this.createTraditionalXMLApi({
-            endpoint: {
-                production: 'api.ebay.com',
-                sandbox: 'api.sandbox.ebay.com'
-            },
-            path: '/ws/api.dll',
-            calls: TradingCalls,
-            xmlns: 'urn:ebay:apis:eBLBaseComponents',
-            headers: (callName, accessToken) => ({
-                'X-EBAY-API-CALL-NAME': callName,
-                'X-EBAY-API-CERT-NAME': this.config.certId,
-                'X-EBAY-API-APP-NAME': this.config.appId,
-                'X-EBAY-API-DEV-NAME': this.config.devId,
-                'X-EBAY-API-SITEID': this.config.siteId,
-                'X-EBAY-API-COMPATIBILITY-LEVEL': 967,
-                ...(accessToken && { 'X-EBAY-API-IAF-TOKEN': accessToken })
-            })
-        });
-    }
-    createShoppingApi() {
-        if (typeof this.config.siteId !== 'number') {
-            throw new Error('siteId is required for shopping API.');
-        }
-        return this.createTraditionalXMLApi({
-            endpoint: {
-                production: 'open.api.ebay.com',
-                sandbox: 'open.api.sandbox.ebay.com'
-            },
-            path: '/shopping',
-            xmlns: 'urn:ebay:apis:eBLBaseComponents',
-            calls: ShoppingCalls,
-            headers: (callName, accessToken) => ({
-                'X-EBAY-API-CALL-NAME': callName,
-                // 'X-EBAY-API-APP-ID': this.config.appId, deprecated  on June 30, 2021
-                'X-EBAY-API-SITE-ID': this.config.siteId,
-                'X-EBAY-API-VERSION': 863,
-                'X-EBAY-API-REQUEST-ENCODING': 'xml',
-                ...(accessToken && { 'X-EBAY-API-IAF-TOKEN': accessToken })
-            })
-        });
-    }
-    createFindingApi() {
-        return this.createTraditionalXMLApi({
-            endpoint: {
-                production: 'svcs.ebay.com',
-                sandbox: 'svcs.sandbox.ebay.com'
-            },
-            path: '/services/search/FindingService/v1',
-            xmlns: 'http://www.ebay.com/marketplace/search/v1/services',
-            calls: FindingCalls,
-            headers: (callName) => ({
-                'X-EBAY-SOA-SECURITY-APPNAME': this.config.appId,
-                'X-EBAY-SOA-OPERATION-NAME': callName
-            })
-        });
-    }
-    createClientAlertsApi() {
-        if (typeof this.config.siteId !== 'number') {
-            throw new Error('siteId is required for client alerts API.');
-        }
-        const api = {
-            endpoint: {
-                production: 'clientalerts.ebay.com',
-                sandbox: 'clientalerts.sandbox.ebay.com'
-            },
-            path: '/ws/ecasvc/ClientAlerts',
-            calls: ClientAlertsCalls
-        };
-        const endpoint = api.endpoint[this.config.sandbox ? 'sandbox' : 'production'];
-        const paramsSerializer = (args) => {
-            return stringify(args, { allowDots: true })
-                .replace(/%5B/gi, '(')
-                .replace(/%5D/gi, ')');
-        };
-        const params = {
-            appid: this.config.appId,
-            siteid: this.config.siteId,
-            version: 643
-        };
-        const service = {};
-        Object.keys(api.calls).forEach((callName) => {
-            service[callName] = async (fields) => {
-                return this.req.get(endpoint, {
-                    paramsSerializer: {
-                        serialize: paramsSerializer
-                    },
-                    params: {
-                        ...params,
-                        ...fields,
-                        callname: callName
-                    }
-                });
-            };
-        });
-        return service;
-    }
-    createMerchandisingApi() {
-        return this.createTraditionalXMLApi({
-            endpoint: {
-                production: 'svcs.ebay.com',
-                sandbox: 'svcs.sandbox.ebay.com'
-            },
-            path: '/MerchandisingService',
-            xmlns: 'http://www.ebay.com/marketplace/services',
-            calls: MerchandisingCalls,
-            headers: (callName) => ({
-                'EBAY-SOA-CONSUMER-ID': this.config.appId,
-                'X-EBAY-SOA-OPERATION-NAME': callName
-            })
-        });
-    }
-    createBusinessPolicyManagementApi() {
-        throw new Error('Important! This API is deprecated and will be decommissioned on January 31, 2022. We recommend that you migrate to the fulfillment_policy, payment_policy, and return_policy resources of the Account API to set up and manage all of your fulfillment, payment, and return business policies.');
-    }
-    async request(apiConfig, api, callName, fields, refreshToken = false) {
-        try {
-            if (refreshToken) {
-                await this.auth.OAuth2.refreshToken();
-            }
-            const config = await this.getConfig(api, callName, apiConfig);
-            const xmlRequest = new XMLRequest(callName, fields, config, this.req);
-            return await xmlRequest.request();
-        }
-        catch (e) {
-            handleEBayError(e);
-        }
-    }
-    async getConfig(api, callName, apiConfig) {
-        const eBayAuthToken = this.auth.authNAuth.eBayAuthToken;
-        const accessToken = !eBayAuthToken && apiConfig.useIaf ? (await this.auth.OAuth2.getAccessToken()) : null;
-        const useIaf = !eBayAuthToken && accessToken;
-        const host = this.config.sandbox ? api.endpoint.sandbox : api.endpoint.production;
-        return {
-            ...apiConfig,
-            xmlns: api.xmlns,
-            endpoint: `https://${host}${api.path}`,
-            headers: {
-                ...api.headers(callName, useIaf ? accessToken : null),
-                ...apiConfig.headers
-            },
-            digitalSignatureHeaders: payload => {
-                return apiConfig.sign ? this.getDigitalSignatureHeaders({
-                    method: 'POST',
-                    authority: host,
-                    path: api.path
-                }, payload) : {};
-            },
-            ...(!useIaf ? { eBayAuthToken } : {})
-        };
-    }
-    createTraditionalXMLApi(traditionalApi) {
-        const api = {};
-        Object.keys(traditionalApi.calls).forEach((callName) => {
-            api[callName] = this.createXMLRequest(callName, traditionalApi);
-        });
-        return api;
-    }
-}
+import { stringify } from 'qs';
+import { EBayIAFTokenExpired, EBayIAFTokenInvalid, handleEBayError } from '../../errors/index.js';
+import Api from '../index.js';
+import ClientAlertsCalls from './clientAlerts/index.js';
+import FindingCalls from './finding/index.js';
+import MerchandisingCalls from './merchandising/index.js';
+import ShoppingCalls from './shopping/index.js';
+import TradingCalls from './trading/index.js';
+import XMLRequest, { defaultApiConfig } from './XMLRequest.js';
+/**
+ * Traditional eBay API.
+ */
+export default class Traditional extends Api {
+    constructor() {
+        super(...arguments);
+        this.createXMLRequest = (callName, api) => async (fields, opts) => {
+            const apiConfig = { ...defaultApiConfig, ...opts };
+            try {
+                return await this.request(apiConfig, api, callName, fields);
+            }
+            catch (error) {
+                // Try to refresh the token.
+                if (this.config.autoRefreshToken && (error.name === EBayIAFTokenExpired.name || error.name === EBayIAFTokenInvalid.name)) {
+                    return await this.request(apiConfig, api, callName, fields, true);
+                }
+                throw error;
+            }
+        };
+    }
+    createTradingApi() {
+        if (typeof this.config.siteId !== 'number') {
+            throw new Error('siteId is required for trading API.');
+        }
+        return this.createTraditionalXMLApi({
+            endpoint: {
+                production: 'api.ebay.com',
+                sandbox: 'api.sandbox.ebay.com'
+            },
+            path: '/ws/api.dll',
+            calls: TradingCalls,
+            xmlns: 'urn:ebay:apis:eBLBaseComponents',
+            headers: (callName, accessToken) => ({
+                'X-EBAY-API-CALL-NAME': callName,
+                'X-EBAY-API-CERT-NAME': this.config.certId,
+                'X-EBAY-API-APP-NAME': this.config.appId,
+                'X-EBAY-API-DEV-NAME': this.config.devId,
+                'X-EBAY-API-SITEID': this.config.siteId,
+                'X-EBAY-API-COMPATIBILITY-LEVEL': 967,
+                ...(accessToken && { 'X-EBAY-API-IAF-TOKEN': accessToken })
+            })
+        });
+    }
+    createShoppingApi() {
+        if (typeof this.config.siteId !== 'number') {
+            throw new Error('siteId is required for shopping API.');
+        }
+        return this.createTraditionalXMLApi({
+            endpoint: {
+                production: 'open.api.ebay.com',
+                sandbox: 'open.api.sandbox.ebay.com'
+            },
+            path: '/shopping',
+            xmlns: 'urn:ebay:apis:eBLBaseComponents',
+            calls: ShoppingCalls,
+            headers: (callName, accessToken) => ({
+                'X-EBAY-API-CALL-NAME': callName,
+                // 'X-EBAY-API-APP-ID': this.config.appId, deprecated  on June 30, 2021
+                'X-EBAY-API-SITE-ID': this.config.siteId,
+                'X-EBAY-API-VERSION': 863,
+                'X-EBAY-API-REQUEST-ENCODING': 'xml',
+                ...(accessToken && { 'X-EBAY-API-IAF-TOKEN': accessToken })
+            })
+        });
+    }
+    createFindingApi() {
+        return this.createTraditionalXMLApi({
+            endpoint: {
+                production: 'svcs.ebay.com',
+                sandbox: 'svcs.sandbox.ebay.com'
+            },
+            path: '/services/search/FindingService/v1',
+            xmlns: 'http://www.ebay.com/marketplace/search/v1/services',
+            calls: FindingCalls,
+            headers: (callName) => ({
+                'X-EBAY-SOA-SECURITY-APPNAME': this.config.appId,
+                'X-EBAY-SOA-OPERATION-NAME': callName
+            })
+        });
+    }
+    createClientAlertsApi() {
+        if (typeof this.config.siteId !== 'number') {
+            throw new Error('siteId is required for client alerts API.');
+        }
+        const api = {
+            endpoint: {
+                production: 'clientalerts.ebay.com',
+                sandbox: 'clientalerts.sandbox.ebay.com'
+            },
+            path: '/ws/ecasvc/ClientAlerts',
+            calls: ClientAlertsCalls
+        };
+        const endpoint = api.endpoint[this.config.sandbox ? 'sandbox' : 'production'];
+        const paramsSerializer = (args) => {
+            return stringify(args, { allowDots: true })
+                .replace(/%5B/gi, '(')
+                .replace(/%5D/gi, ')');
+        };
+        const params = {
+            appid: this.config.appId,
+            siteid: this.config.siteId,
+            version: 643
+        };
+        const service = {};
+        Object.keys(api.calls).forEach((callName) => {
+            service[callName] = async (fields) => {
+                return this.req.get(endpoint, {
+                    paramsSerializer: {
+                        serialize: paramsSerializer
+                    },
+                    params: {
+                        ...params,
+                        ...fields,
+                        callname: callName
+                    }
+                });
+            };
+        });
+        return service;
+    }
+    createMerchandisingApi() {
+        return this.createTraditionalXMLApi({
+            endpoint: {
+                production: 'svcs.ebay.com',
+                sandbox: 'svcs.sandbox.ebay.com'
+            },
+            path: '/MerchandisingService',
+            xmlns: 'http://www.ebay.com/marketplace/services',
+            calls: MerchandisingCalls,
+            headers: (callName) => ({
+                'EBAY-SOA-CONSUMER-ID': this.config.appId,
+                'X-EBAY-SOA-OPERATION-NAME': callName
+            })
+        });
+    }
+    createBusinessPolicyManagementApi() {
+        throw new Error('Important! This API is deprecated and will be decommissioned on January 31, 2022. We recommend that you migrate to the fulfillment_policy, payment_policy, and return_policy resources of the Account API to set up and manage all of your fulfillment, payment, and return business policies.');
+    }
+    async request(apiConfig, api, callName, fields, refreshToken = false) {
+        try {
+            if (refreshToken) {
+                await this.auth.OAuth2.refreshToken();
+            }
+            const config = await this.getConfig(api, callName, apiConfig);
+            const xmlRequest = new XMLRequest(callName, fields, config, this.req);
+            return await xmlRequest.request();
+        }
+        catch (e) {
+            handleEBayError(e);
+        }
+    }
+    async getConfig(api, callName, apiConfig) {
+        const eBayAuthToken = this.auth.authNAuth.eBayAuthToken;
+        const accessToken = !eBayAuthToken && apiConfig.useIaf ? (await this.auth.OAuth2.getAccessToken()) : null;
+        const useIaf = !eBayAuthToken && accessToken;
+        const host = this.config.sandbox ? api.endpoint.sandbox : api.endpoint.production;
+        return {
+            ...apiConfig,
+            xmlns: api.xmlns,
+            endpoint: `https://${host}${api.path}`,
+            headers: {
+                ...api.headers(callName, useIaf ? accessToken : null),
+                ...apiConfig.headers
+            },
+            digitalSignatureHeaders: payload => {
+                return apiConfig.sign ? this.getDigitalSignatureHeaders({
+                    method: 'POST',
+                    authority: host,
+                    path: api.path
+                }, payload) : {};
+            },
+            ...(!useIaf ? { eBayAuthToken } : {})
+        };
+    }
+    createTraditionalXMLApi(traditionalApi) {
+        const api = {};
+        Object.keys(traditionalApi.calls).forEach((callName) => {
+            api[callName] = this.createXMLRequest(callName, traditionalApi);
+        });
+        return api;
+    }
+}

package/dist/api/traditional/merchandising/index.d.ts

@@ -1,7 +1,7 @@
-declare enum calls {
-    getMostWatchedItems = 0,
-    getRelatedCategoryItems = 1,
-    getSimilarItems = 2,
-    getVersion = 3
-}
-export default calls;
+declare enum calls {
+    getMostWatchedItems = 0,
+    getRelatedCategoryItems = 1,
+    getSimilarItems = 2,
+    getVersion = 3
+}
+export default calls;

package/dist/api/traditional/merchandising/index.js

@@ -1,8 +1,8 @@
-var calls;
-(function (calls) {
-    calls[calls["getMostWatchedItems"] = 0] = "getMostWatchedItems";
-    calls[calls["getRelatedCategoryItems"] = 1] = "getRelatedCategoryItems";
-    calls[calls["getSimilarItems"] = 2] = "getSimilarItems";
-    calls[calls["getVersion"] = 3] = "getVersion";
-})(calls || (calls = {}));
-export default calls;
+var calls;
+(function (calls) {
+    calls[calls["getMostWatchedItems"] = 0] = "getMostWatchedItems";
+    calls[calls["getRelatedCategoryItems"] = 1] = "getRelatedCategoryItems";
+    calls[calls["getSimilarItems"] = 2] = "getSimilarItems";
+    calls[calls["getVersion"] = 3] = "getVersion";
+})(calls || (calls = {}));
+export default calls;

package/dist/api/traditional/shopping/index.d.ts

@@ -1,11 +1,11 @@
-declare enum calls {
-    FindProducts = 0,
-    GetCategoryInfo = 1,
-    GeteBayTime = 2,
-    GetItemStatus = 3,
-    GetMultipleItems = 4,
-    GetShippingCosts = 5,
-    GetSingleItem = 6,
-    GetUserProfile = 7
-}
-export default calls;
+declare enum calls {
+    FindProducts = 0,
+    GetCategoryInfo = 1,
+    GeteBayTime = 2,
+    GetItemStatus = 3,
+    GetMultipleItems = 4,
+    GetShippingCosts = 5,
+    GetSingleItem = 6,
+    GetUserProfile = 7
+}
+export default calls;

package/dist/api/traditional/shopping/index.js

@@ -1,13 +1,13 @@
-// https://developer.ebay.com/devzone/shopping/docs/callref/index.html
-var calls;
-(function (calls) {
-    calls[calls["FindProducts"] = 0] = "FindProducts";
-    calls[calls["GetCategoryInfo"] = 1] = "GetCategoryInfo";
-    calls[calls["GeteBayTime"] = 2] = "GeteBayTime";
-    calls[calls["GetItemStatus"] = 3] = "GetItemStatus";
-    calls[calls["GetMultipleItems"] = 4] = "GetMultipleItems";
-    calls[calls["GetShippingCosts"] = 5] = "GetShippingCosts";
-    calls[calls["GetSingleItem"] = 6] = "GetSingleItem";
-    calls[calls["GetUserProfile"] = 7] = "GetUserProfile";
-})(calls || (calls = {}));
-export default calls;
+// https://developer.ebay.com/devzone/shopping/docs/callref/index.html
+var calls;
+(function (calls) {
+    calls[calls["FindProducts"] = 0] = "FindProducts";
+    calls[calls["GetCategoryInfo"] = 1] = "GetCategoryInfo";
+    calls[calls["GeteBayTime"] = 2] = "GeteBayTime";
+    calls[calls["GetItemStatus"] = 3] = "GetItemStatus";
+    calls[calls["GetMultipleItems"] = 4] = "GetMultipleItems";
+    calls[calls["GetShippingCosts"] = 5] = "GetShippingCosts";
+    calls[calls["GetSingleItem"] = 6] = "GetSingleItem";
+    calls[calls["GetUserProfile"] = 7] = "GetUserProfile";
+})(calls || (calls = {}));
+export default calls;