@sp-api-sdk/solicitations-api-v1 1.8.1 → 1.9.0

package/README.md

@@ -64,6 +64,29 @@ const client = new SolicitationsApiClient({
 
 The rate limits used for each route are specified in the [API documentation](https://developer-docs.amazon.com/sp-api/docs).
 
+## Logging
+
+You can enable logging for both SP-API requests and responses by configuring the `logging.request` and `logging.response` properties.
+
+```javascript
+const client = new SolicitationsApiClient({
+  auth,
+  region: 'eu',
+  logging: {
+    request: {
+      logger: console.debug
+    },
+    response: {
+      logger: console.debug
+    }
+  },
+})
+```
+
+Specifying `true` will use the default options, specifying an object will allow you to override the default options.  
+This uses [axios-logger](https://github.com/hg-pyun/axios-logger) under the hood.
+
+
 ## License
 
 MIT

package/dist/cjs/index.js

@@ -2,5 +2,4 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const tslib_1 = require("tslib");
 tslib_1.__exportStar(require("./src/client"), exports);
-tslib_1.__exportStar(require("./src/error"), exports);
 tslib_1.__exportStar(require("./src/api-model/models"), exports);

package/dist/cjs/src/client.js

@@ -1,44 +1,28 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SolicitationsApiClient = exports.clientRateLimits = void 0;
-/* eslint-disable prefer-regex-literals */
 const common_1 = require("@sp-api-sdk/common");
 const api_model_1 = require("./api-model");
-const error_1 = require("./error");
 exports.clientRateLimits = [
     {
         method: 'get',
+        // eslint-disable-next-line prefer-regex-literals
         urlRegex: new RegExp('^/solicitations/v1/orders/[^/]*$'),
         rate: 1,
         burst: 5,
     },
     {
         method: 'post',
+        // eslint-disable-next-line prefer-regex-literals
         urlRegex: new RegExp('^/solicitations/v1/orders/[^/]*/solicitations/productReviewAndSellerFeedback$'),
         rate: 1,
         burst: 5,
     },
 ];
 class SolicitationsApiClient extends api_model_1.SolicitationsApi {
-    constructor(parameters) {
-        const config = common_1.sellingPartnerRegions[parameters.region];
-        if (!config) {
-            throw new error_1.SolicitationsApiError(`Unknown region: ${parameters.region}`);
-        }
-        const { rateLimiting, ...clientParameters } = parameters;
-        const axiosParameters = {
-            ...clientParameters,
-            region: config.awsRegion,
-        };
-        if (rateLimiting?.retry) {
-            axiosParameters.rateLimits = exports.clientRateLimits;
-            axiosParameters.onRetry = rateLimiting.onRetry;
-        }
-        const axiosInstance = (0, common_1.createAxiosInstance)(axiosParameters);
-        const configuration = new api_model_1.Configuration();
-        const environment = parameters.sandbox ? 'sandbox' : 'production';
-        const endpoint = config.endpoints[environment];
-        super(configuration, endpoint, axiosInstance);
+    constructor(configuration) {
+        const { axios, endpoint } = (0, common_1.createAxiosInstance)(configuration, exports.clientRateLimits);
+        super(new api_model_1.Configuration(), endpoint, axios);
     }
 }
 exports.SolicitationsApiClient = SolicitationsApiClient;

package/dist/es/index.js

@@ -1,3 +1,2 @@
 export * from './src/client';
-export * from './src/error';
 export * from './src/api-model/models';

package/dist/es/src/client.js

@@ -1,40 +1,24 @@
-/* eslint-disable prefer-regex-literals */
-import { sellingPartnerRegions, createAxiosInstance } from '@sp-api-sdk/common';
+import { createAxiosInstance } from '@sp-api-sdk/common';
 import { Configuration, SolicitationsApi } from './api-model';
-import { SolicitationsApiError } from './error';
 export const clientRateLimits = [
     {
         method: 'get',
+        // eslint-disable-next-line prefer-regex-literals
         urlRegex: new RegExp('^/solicitations/v1/orders/[^/]*$'),
         rate: 1,
         burst: 5,
     },
     {
         method: 'post',
+        // eslint-disable-next-line prefer-regex-literals
         urlRegex: new RegExp('^/solicitations/v1/orders/[^/]*/solicitations/productReviewAndSellerFeedback$'),
         rate: 1,
         burst: 5,
     },
 ];
 export class SolicitationsApiClient extends SolicitationsApi {
-    constructor(parameters) {
-        const config = sellingPartnerRegions[parameters.region];
-        if (!config) {
-            throw new SolicitationsApiError(`Unknown region: ${parameters.region}`);
-        }
-        const { rateLimiting, ...clientParameters } = parameters;
-        const axiosParameters = {
-            ...clientParameters,
-            region: config.awsRegion,
-        };
-        if (rateLimiting?.retry) {
-            axiosParameters.rateLimits = clientRateLimits;
-            axiosParameters.onRetry = rateLimiting.onRetry;
-        }
-        const axiosInstance = createAxiosInstance(axiosParameters);
-        const configuration = new Configuration();
-        const environment = parameters.sandbox ? 'sandbox' : 'production';
-        const endpoint = config.endpoints[environment];
-        super(configuration, endpoint, axiosInstance);
+    constructor(configuration) {
+        const { axios, endpoint } = createAxiosInstance(configuration, clientRateLimits);
+        super(new Configuration(), endpoint, axios);
     }
 }

package/dist/types/index.d.ts

@@ -1,3 +1,2 @@
 export * from './src/client';
-export * from './src/error';
 export * from './src/api-model/models';

package/dist/types/src/client.d.ts

@@ -1,13 +1,6 @@
-import type { ClientConfiguration, SellingPartnerRegion, RateLimit, OnRetryHandler } from '@sp-api-sdk/common';
+import { type ClientConfiguration, type RateLimit } from '@sp-api-sdk/common';
 import { SolicitationsApi } from './api-model';
 export declare const clientRateLimits: RateLimit[];
-export interface ClientParameters extends Omit<ClientConfiguration, 'rateLimits' | 'onRetry'> {
-    region: SellingPartnerRegion;
-    rateLimiting?: {
-        retry: boolean;
-        onRetry?: OnRetryHandler;
-    };
-}
 export declare class SolicitationsApiClient extends SolicitationsApi {
-    constructor(parameters: ClientParameters);
+    constructor(configuration: ClientConfiguration);
 }

package/package.json

@@ -2,10 +2,11 @@
   "name": "@sp-api-sdk/solicitations-api-v1",
   "author": "Vincent Mesquita <vincent.mesquita@bizon.solutions>",
   "description": "With the Solicitations API you can build applications that send non-critical solicitations to buyers. You can get a list of solicitation types that are available for an order that you specify, then call an operation that sends a solicitation to the buyer for that order. Buyers cannot respond to solicitations sent by this API, and these solicitations do not appear in the Messaging section of Seller Central or in the recipient's Message Center. The Solicitations API returns responses that are formed according to the JSON Hypertext Application Language (HAL) standard.",
-  "version": "1.8.1",
+  "version": "1.9.0",
   "main": "dist/cjs/index.js",
   "module": "dist/es/index.js",
   "types": "dist/types/index.d.ts",
+  "typedocMain": "./index.ts",
   "license": "MIT",
   "publishConfig": {
     "access": "public"
@@ -26,9 +27,9 @@
     "test": "NODE_ENV='test' yarn jest"
   },
   "dependencies": {
-    "@sp-api-sdk/auth": "^1.9.10",
-    "@sp-api-sdk/common": "^1.7.12",
-    "axios": "^0.26.1"
+    "@sp-api-sdk/auth": "^1.9.13",
+    "@sp-api-sdk/common": "^1.8.0",
+    "axios": "^0.27.2"
   },
   "repository": {
     "type": "git",
@@ -49,5 +50,5 @@
     "sp sdk",
     "solicitations api"
   ],
-  "gitHead": "f09167d8924ae85f4012978fb5872c3e9e1c4cf1"
+  "gitHead": "975705017de9384bf28b85e97d93f866d4d71611"
 }

package/dist/cjs/src/error.js

@@ -1,10 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.SolicitationsApiError = void 0;
-class SolicitationsApiError extends Error {
-    constructor(message) {
-        super(message);
-        this.name = 'SolicitationsApiError';
-    }
-}
-exports.SolicitationsApiError = SolicitationsApiError;

package/dist/es/src/error.js

@@ -1,6 +0,0 @@
-export class SolicitationsApiError extends Error {
-    constructor(message) {
-        super(message);
-        this.name = 'SolicitationsApiError';
-    }
-}

package/dist/types/src/error.d.ts

@@ -1,3 +0,0 @@
-export declare class SolicitationsApiError extends Error {
-    constructor(message: string);
-}