ebay-api 8.7.2-RC.0 → 9.0.0

package/README.md

@@ -18,6 +18,7 @@ It supports `client credentials grant` and `authorization code grant` \(Auth'N'A
 
 * [eBay API Explorer](https://developer.ebay.com/my/api_test_tool)
 * [eBay API Docs](https://developer.ebay.com/docs)
+* [eBay API Status](https://entwickler.ebay.de/support/api-status/production)
 
 ## Changelog
 
@@ -34,7 +35,7 @@ It supports `client credentials grant` and `authorization code grant` \(Auth'N'A
 | **Commerce API**   | ✔ Catalog API `v1_beta.3.1`<br>✔ Charity API `v1.2.0`<br>✔ Identity API `v1.0.0`<br>✔ Notification API `v1.2.0`<br>✔ Taxonomy API `v1.0.0`<br>✔ Translation API `v1_beta.1.4`<br>✔ Media API `v1_beta.1.0`                                                                                                                                                                   |
 | **Developer API**  | ✔ Analytics API                                                                                                                                                                                                                                                                                                                                                              |
 | **Post Order API** | ✔ Cancellation API<br>✔ Case Management API<br>✔ Inquiry API<br>✔ Return API                                                                                                                                                                                                                                                                                                 |
-| **Sell API**       | ✔ Account API `v1.9.0`<br>✔ Analytics API `v1.3.0`<br>✔ Compliance API `v1.4.1`<br>✔ Feed API `v1.3.1`<br>✔ Finance API `v1.9.0`<br>✔ Fulfillment API `v1.19.10`<br>✔ Inventory API `v1.14.0`<br>✔ Listing API `v1_beta.2.1`<br>✔ Logistics API `v1_beta.0.0`<br>✔ Marketing API `v1.17.0`<br>✔ Metadata API `v1.4.2`<br>✔ Negotiation API `v1.1.0`<br>✔ Recommendation API `v1.1.0` |
+| **Sell API**       | ✔ Account API `v1.9.0`<br>✔ Analytics API `v1.3.0`<br>✔ Compliance API `v1.4.1`<br>✔ Feed API `v1.3.1`<br>✔ Finance API `v1.9.0`<br>✔ Fulfillment API `v1.19.10`<br>✔ Inventory API `v1.14.0`<br>✔ Listing API `v1_beta.2.1`<br>✔ Logistics API `v1_beta.0.0`<br>✔ Marketing API `v1.17.0`<br>✔ Metadata API `v1.7.1`<br>✔ Negotiation API `v1.1.0`<br>✔ Recommendation API `v1.1.0` |
 
 ### Traditional API
 
@@ -270,8 +271,8 @@ app.get('/success', async function (req, res) {
     // 5. Start using the API
     const orders = await eBay.sell.fulfillment.getOrders()
     res.send(orders);
-  } catch (e) {
-    console.error(e)
+  } catch (error) {
+    console.error(error)
     res.sendStatus(400)
   }
 });
@@ -301,8 +302,8 @@ app.get('/orders/:id', async function (req, res) {
     // 5. Start using the API
     const order = await eBay.sell.fulfillment.getOrder(id);
     res.send(order);
-  } catch (e) {
-    console.error(e)
+  } catch (error) {
+    console.error(error)
     res.sendStatus(400)
   }
 });
@@ -492,8 +493,8 @@ try {
   const result = await toString(data);
 
   console.log(result)
-} catch (e) {
-  console.error(e);
+} catch (error) {
+  console.error(error);
 }
 ```
 

package/dist/api/digitalSignature.js

@@ -1,4 +1,5 @@
 import { createHash, sign } from 'crypto';
+import { EBayError } from '../errors/index.js';
 const beginPrivateKey = '-----BEGIN PRIVATE KEY-----';
 const endPrivateKey = '-----END PRIVATE KEY-----';
 export const getUnixTimestamp = () => Math.floor(Date.now() / 1000);
@@ -48,8 +49,8 @@ export function generateBaseString(headers, signatureComponents, payload, timest
         baseString += `"@signature-params": (${getSignatureParamsValue(payload)});created=${timestamp}`;
         return baseString;
     }
-    catch (ex) {
-        throw new Error(`Error calculating signature base: ${ex.message}`);
+    catch (error) {
+        throw new EBayError(`Error calculating signature base: ${error.message}`);
     }
 }
 export const generateSignatureInput = (payload, timestamp = getUnixTimestamp()) => `sig1=(${getSignatureParamsValue(payload)});created=${timestamp}`;

package/dist/api/restful/index.js

@@ -151,8 +151,8 @@ export default class Restful extends Api {
                 return response.data;
             }
         }
-        catch (ex) {
-            handleEBayError(ex);
+        catch (error) {
+            handleEBayError(error);
         }
     }
 }

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

@@ -5,9 +5,11 @@ export default class Metadata extends Restful implements OpenApi<operations> {
     get basePath(): string;
     getSalesTaxJurisdictions(countryCode: string): Promise<any>;
     getAutomotivePartsCompatibilityPolicies(marketplaceId: string, filter?: string): Promise<any>;
+    getExtendedProducerResponsibilityPolicies(marketplaceId: string, filter?: string): Promise<any>;
     getItemConditionPolicies(marketplaceId: string, filter?: string): Promise<any>;
     getListingStructurePolicies(marketplaceId: string, filter?: string): Promise<any>;
     getNegotiatedPricePolicies(marketplaceId: string, filter?: string): Promise<any>;
     getProductAdoptionPolicies(marketplaceId: string, filter?: string): Promise<any>;
     getReturnPolicies(marketplaceId: string, filter?: string): Promise<any>;
+    getHazardousMaterialsLabels(marketplaceId: string): Promise<any>;
 }

package/dist/api/restful/sell/metadata/index.js

@@ -15,6 +15,14 @@ class Metadata extends Restful {
             }
         });
     }
+    getExtendedProducerResponsibilityPolicies(marketplaceId, filter) {
+        marketplaceId = encodeURIComponent(marketplaceId);
+        return this.get(`/marketplace/${marketplaceId}/get_extended_producer_responsibility_policies`, {
+            params: {
+                filter
+            }
+        });
+    }
     getItemConditionPolicies(marketplaceId, filter) {
         marketplaceId = encodeURIComponent(marketplaceId);
         return this.get(`/marketplace/${marketplaceId}/get_item_condition_policies`, {
@@ -55,6 +63,10 @@ class Metadata extends Restful {
             }
         });
     }
+    getHazardousMaterialsLabels(marketplaceId) {
+        marketplaceId = encodeURIComponent(marketplaceId);
+        return this.get(`/marketplace/${marketplaceId}/get_hazardous_materials_labels`);
+    }
 }
 Metadata.id = 'Metadata';
 export default Metadata;

package/dist/api/traditional/XMLRequest.js

@@ -1,6 +1,6 @@
 import debug from 'debug';
 import { XMLBuilder, XMLParser } from 'fast-xml-parser';
-import { checkEBayResponse, EbayNoCallError } from '../../errors/index.js';
+import { checkEBayTraditionalResponse, EBayNoCallError } from '../../errors/index.js';
 const log = debug('ebay:xml:request');
 export const defaultJSON2XMLOptions = {
     attributeNamePrefix: '@_',
@@ -42,7 +42,7 @@ export const defaultHeaders = {
 class XMLRequest {
     constructor(callName, fields, config, req) {
         if (!callName) {
-            throw new EbayNoCallError();
+            throw new EBayNoCallError();
         }
         this.callName = callName;
         this.fields = fields || {};
@@ -109,14 +109,14 @@ class XMLRequest {
                 return data;
             }
             const json = this.xml2JSON(data);
-            checkEBayResponse(json);
+            checkEBayTraditionalResponse(response, json);
             return json;
         }
         catch (error) {
             log('error', error);
             if (error.response?.data) {
                 const json = this.toJSON(error.response.data);
-                checkEBayResponse(json);
+                checkEBayTraditionalResponse(error.response, json);
             }
             throw error;
         }

package/dist/api/traditional/index.js

@@ -157,8 +157,8 @@ export default class Traditional extends Api {
             const xmlRequest = new XMLRequest(callName, fields, config, this.req);
             return await xmlRequest.request();
         }
-        catch (e) {
-            handleEBayError(e);
+        catch (error) {
+            handleEBayError(error);
         }
     }
     async getConfig(api, callName, apiConfig) {

package/dist/auth/oAuth2.d.ts

@@ -4,13 +4,13 @@ import { IEBayApiRequest } from '../request.js';
 import { AppConfig, Scope } from '../types/index.js';
 export type Token = {
     access_token: string;
-    expires_in: number;
-    token_type: string;
+    expires_in?: number;
+    token_type?: string;
 };
 export type ClientToken = Token;
 export type AuthToken = Token & {
     refresh_token: string;
-    refresh_token_expires_in: number;
+    refresh_token_expires_in?: number;
 };
 export default class OAuth2 extends Base {
     static readonly IDENTITY_ENDPOINT: Record<string, string>;
@@ -22,19 +22,19 @@ export default class OAuth2 extends Base {
     private _authToken?;
     constructor(config: AppConfig, req: IEBayApiRequest);
     on(event: string, callback: EventCallback): () => void;
-    static generateAuthUrl(sandbox: boolean, appId: string, ruName: string, scope: string[], state?: string): string;
     get identityEndpoint(): string;
+    static generateAuthUrl(sandbox: boolean, appId: string, ruName: string, scope: string[], state?: string): string;
+    generateAuthUrl(ruName?: string, scope?: string[], state?: string): string;
     getAccessToken(): Promise<string>;
     getUserAccessToken(): string | null;
     getApplicationAccessToken(): Promise<string>;
+    getScope(): string[];
     setClientToken(clientToken?: Token): void;
     setScope(scope: Scope): void;
-    getScope(): string[];
     mintApplicationAccessToken(): Promise<ClientToken>;
     obtainApplicationAccessToken(): Promise<ClientToken>;
-    generateAuthUrl(ruName?: string, scope?: string[], state?: string): string;
-    mintUserAccessToken(code: string, ruName?: string | undefined): Promise<any>;
-    getToken(code: string, ruName?: string | undefined): Promise<any>;
+    mintUserAccessToken(code: string, ruName?: string | undefined): Promise<AuthToken>;
+    getToken(code: string, ruName?: string | undefined): Promise<AuthToken>;
     refreshUserAccessToken(): Promise<AuthToken>;
     obtainToken(code: string): Promise<AuthToken>;
     getCredentials(): AuthToken | ClientToken | null;

package/dist/auth/oAuth2.js

@@ -11,6 +11,9 @@ class OAuth2 extends Base {
     on(event, callback) {
         return this.emitter.on(event, callback);
     }
+    get identityEndpoint() {
+        return this.config.sandbox ? OAuth2.IDENTITY_ENDPOINT.sandbox : OAuth2.IDENTITY_ENDPOINT.production;
+    }
     static generateAuthUrl(sandbox, appId, ruName, scope, state = '') {
         return [
             sandbox ? OAuth2.AUTHORIZE_ENDPOINT.sandbox : OAuth2.AUTHORIZE_ENDPOINT.production,
@@ -21,8 +24,12 @@ class OAuth2 extends Base {
             '&scope=', encodeURIComponent(scope.join(' '))
         ].join('');
     }
-    get identityEndpoint() {
-        return this.config.sandbox ? OAuth2.IDENTITY_ENDPOINT.sandbox : OAuth2.IDENTITY_ENDPOINT.production;
+    generateAuthUrl(ruName, scope = this.scope, state = '') {
+        ruName = ruName || this.config.ruName;
+        if (!ruName) {
+            throw new Error('RuName is required.');
+        }
+        return OAuth2.generateAuthUrl(this.config.sandbox, this.config.appId, ruName, scope, state);
     }
     async getAccessToken() {
         return this.getUserAccessToken() || this.getApplicationAccessToken();
@@ -43,15 +50,15 @@ class OAuth2 extends Base {
             throw error;
         }
     }
+    getScope() {
+        return [...this.scope];
+    }
     setClientToken(clientToken) {
         this._clientToken = clientToken;
     }
     setScope(scope) {
         this.scope = scope;
     }
-    getScope() {
-        return [...this.scope];
-    }
     async mintApplicationAccessToken() {
         if (!this.config.appId) {
             throw new Error('Missing App ID (Client Id)');
@@ -90,13 +97,6 @@ class OAuth2 extends Base {
             throw error;
         }
     }
-    generateAuthUrl(ruName, scope = this.scope, state = '') {
-        ruName = ruName || this.config.ruName;
-        if (!ruName) {
-            throw new Error('RuName is required.');
-        }
-        return OAuth2.generateAuthUrl(this.config.sandbox, this.config.appId, ruName, scope, state);
-    }
     async mintUserAccessToken(code, ruName = this.config.ruName) {
         if (!this.config.appId) {
             throw new Error('Missing App ID (Client Id)');