@sp-api-sdk/notifications-api-v1 1.9.0 → 1.9.4

package/README.md

@@ -4,6 +4,15 @@ The Selling Partner API for Notifications lets you subscribe to notifications th
 
 For more information, see the [Notifications Use Case Guide](https://github.com/amzn/selling-partner-api-docs/blob/main/guides/en-US/use-case-guides/notifications-api-use-case-guide/notifications-use-case-guide-v1.md)
 
+[![npm version](https://badgen.net/npm/v/@sp-api-sdk/notifications-api-v1)](https://www.npmjs.com/package/@sp-api-sdk/notifications-api-v1)
+[![XO code style](https://badgen.net/badge/code%20style/XO/cyan)](https://github.com/xojs/xo)
+
+## Documentation
+
+Learn more about this Selling Partner API by visiting the [official documentation](https://github.com/amzn/selling-partner-api-docs/tree/main/references/notifications-api/notifications.md).
+
+Also, see the [generated documentation](https://bizon.github.io/selling-partner-api-sdk/modules/_sp_api_sdk_notifications_api_v1.html) for this API client.
+
 ## Installing
 
 ```sh
@@ -23,21 +32,20 @@ import {SellingPartnerApiAuth, AuthorizationScope} from '@sp-api-sdk/auth'
 import {NotificationsApiClient} from '@sp-api-sdk/notifications-api-v1'
 
 const auth = new SellingPartnerApiAuth({
-  clientId: '',
-  clientSecret: '',
+  clientId: process.env.LWA_CLIENT_ID,
+  clientSecret: process.env.LWA_CLIENT_SECRET,
   scopes: [AuthorizationScope.NOTIFICATIONS],
-  secretAccessKey: '',
   accessKeyId: '',
-  region: '',
+  secretAccessKey: '',
   role: {
-    arn: '',
+    arn: 'arn:aws:iam::…',
   }
 })
 
 
 const client = new NotificationsApiClient({
   auth,
-  region: 'eu' // or 'eu-west-1'
+  region: 'eu'
 })
 ```
 
@@ -48,26 +56,25 @@ import {SellingPartnerApiAuth} from '@sp-api-sdk/auth'
 import {NotificationsApiClient} from '@sp-api-sdk/notifications-api-v1'
 
 const auth = new SellingPartnerApiAuth({
-  clientId: '',
-  clientSecret: '',
-  refreshToken: '',
-  secretAccessKey: '',
+  clientId: process.env.LWA_CLIENT_ID,
+  clientSecret: process.env.LWA_CLIENT_SECRET,
+  refreshToken: 'Atzr|…',
   accessKeyId: '',
-  region: '',
+  secretAccessKey: '',
   role: {
-    arn: '',
-  }
+    arn: 'arn:aws:iam::…',
+  },
 })
 
 const client = new NotificationsApiClient({
   auth,
-  region: 'eu' // or 'eu-west-1'
+  region: 'eu',
 })
 ```
 
-## Handle Rate Limiting
+## Rate Limiting
 
-If you want to let the SDK retry after each 429 responses, instanciate the client like this:
+In order to retry rate limited requests (HTTP 429), you can configure the API client as such:
 
 ```javascript
 const client = new NotificationsApiClient({
@@ -75,13 +82,28 @@ const client = new NotificationsApiClient({
   region: 'eu',
   rateLimiting: {
     retry: true,
-    onRetry: (retryInfo) => console.log(retryInfo) // Optional
-  }
+    // Optionally specify a callback that will be called on every retry.
+    onRetry: (retryInfo) => {
+      console.log(retryInfo)
+    },
+  },
 })
 ```
 
-The SDK gets the rate limits for each routes from the API documentation
+The rate limits used for each route are specified in the [API documentation]((https://github.com/amzn/selling-partner-api-docs/tree/main/references/notifications-api/notifications.md)).
+
+## License
 
-## API documentation
+MIT
 
-See [here](https://github.com/amzn/selling-partner-api-docs/tree/main/references/notifications-api/notifications.md)
+## Miscellaneous
+
+```
+    ╚⊙ ⊙╝
+  ╚═(███)═╝
+ ╚═(███)═╝
+╚═(███)═╝
+ ╚═(███)═╝
+  ╚═(███)═╝
+   ╚═(███)═╝
+```

package/dist/cjs/src/client.js

@@ -1,11 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.NotificationsApiClient = exports.RATE_LIMITS = void 0;
+exports.NotificationsApiClient = 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.RATE_LIMITS = [
+exports.clientRateLimits = [
     {
         method: 'get',
         urlRegex: new RegExp('^/notifications/v1/subscriptions/[^/]*$'),
@@ -57,20 +57,23 @@ exports.RATE_LIMITS = [
 ];
 class NotificationsApiClient extends api_model_1.NotificationsApi {
     constructor(parameters) {
-        const region = common_1.awsRegionByCode[parameters.region] ?? parameters.region;
+        const config = common_1.sellingPartnerRegions[parameters.region];
+        if (!config) {
+            throw new error_1.NotificationsApiError(`Unknown region: ${parameters.region}`);
+        }
         const { rateLimiting, ...clientParameters } = parameters;
-        const axiosParameters = { ...clientParameters, region };
+        const axiosParameters = {
+            ...clientParameters,
+            region: config.awsRegion,
+        };
         if (rateLimiting?.retry) {
-            axiosParameters.rateLimits = exports.RATE_LIMITS;
+            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 = common_1.endpoints[environment][region];
-        if (!endpoint) {
-            throw new error_1.NotificationsApiError(`Unknown region : ${region}`);
-        }
+        const endpoint = config.endpoints[environment];
         super(configuration, endpoint, axiosInstance);
     }
 }

package/dist/es/src/client.js

@@ -1,8 +1,8 @@
 /* eslint-disable prefer-regex-literals */
-import { endpoints, awsRegionByCode, createAxiosInstance } from '@sp-api-sdk/common';
+import { sellingPartnerRegions, createAxiosInstance } from '@sp-api-sdk/common';
 import { Configuration, NotificationsApi } from './api-model';
 import { NotificationsApiError } from './error';
-export const RATE_LIMITS = [
+export const clientRateLimits = [
     {
         method: 'get',
         urlRegex: new RegExp('^/notifications/v1/subscriptions/[^/]*$'),
@@ -54,20 +54,23 @@ export const RATE_LIMITS = [
 ];
 export class NotificationsApiClient extends NotificationsApi {
     constructor(parameters) {
-        const region = awsRegionByCode[parameters.region] ?? parameters.region;
+        const config = sellingPartnerRegions[parameters.region];
+        if (!config) {
+            throw new NotificationsApiError(`Unknown region: ${parameters.region}`);
+        }
         const { rateLimiting, ...clientParameters } = parameters;
-        const axiosParameters = { ...clientParameters, region };
+        const axiosParameters = {
+            ...clientParameters,
+            region: config.awsRegion,
+        };
         if (rateLimiting?.retry) {
-            axiosParameters.rateLimits = RATE_LIMITS;
+            axiosParameters.rateLimits = clientRateLimits;
             axiosParameters.onRetry = rateLimiting.onRetry;
         }
         const axiosInstance = createAxiosInstance(axiosParameters);
         const configuration = new Configuration();
         const environment = parameters.sandbox ? 'sandbox' : 'production';
-        const endpoint = endpoints[environment][region];
-        if (!endpoint) {
-            throw new NotificationsApiError(`Unknown region : ${region}`);
-        }
+        const endpoint = config.endpoints[environment];
         super(configuration, endpoint, axiosInstance);
     }
 }

package/dist/types/src/api-model/api/notifications-api.d.ts

@@ -337,7 +337,7 @@ export declare class NotificationsApi extends BaseAPI {
      * @throws {RequiredError}
      * @memberof NotificationsApi
      */
-    createDestination(requestParameters: NotificationsApiCreateDestinationRequest, options?: any): Promise<import("axios").AxiosResponse<CreateDestinationResponse>>;
+    createDestination(requestParameters: NotificationsApiCreateDestinationRequest, options?: any): Promise<import("axios").AxiosResponse<CreateDestinationResponse, any>>;
     /**
      * Creates a subscription for the specified notification type to be delivered to the specified destination. Before you can subscribe, you must first create the destination by calling the createDestination operation.  **Usage Plan:**  | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 |  For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
      * @param {NotificationsApiCreateSubscriptionRequest} requestParameters Request parameters.
@@ -345,7 +345,7 @@ export declare class NotificationsApi extends BaseAPI {
      * @throws {RequiredError}
      * @memberof NotificationsApi
      */
-    createSubscription(requestParameters: NotificationsApiCreateSubscriptionRequest, options?: any): Promise<import("axios").AxiosResponse<CreateSubscriptionResponse>>;
+    createSubscription(requestParameters: NotificationsApiCreateSubscriptionRequest, options?: any): Promise<import("axios").AxiosResponse<CreateSubscriptionResponse, any>>;
     /**
      * Deletes the destination that you specify. The deleteDestination API is grantless. For more information, see \"Grantless operations\" in the Selling Partner API Developer Guide.  **Usage Plan:**  | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 |  For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
      * @param {NotificationsApiDeleteDestinationRequest} requestParameters Request parameters.
@@ -353,7 +353,7 @@ export declare class NotificationsApi extends BaseAPI {
      * @throws {RequiredError}
      * @memberof NotificationsApi
      */
-    deleteDestination(requestParameters: NotificationsApiDeleteDestinationRequest, options?: any): Promise<import("axios").AxiosResponse<DeleteDestinationResponse>>;
+    deleteDestination(requestParameters: NotificationsApiDeleteDestinationRequest, options?: any): Promise<import("axios").AxiosResponse<DeleteDestinationResponse, any>>;
     /**
      * Deletes the subscription indicated by the subscription identifier and notification type that you specify. The subscription identifier can be for any subscription associated with your application. After you successfully call this operation, notifications will stop being sent for the associated subscription. The deleteSubscriptionById API is grantless. For more information, see \"Grantless operations\" in the Selling Partner API Developer Guide.  **Usage Plan:**  | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 |  For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
      * @param {NotificationsApiDeleteSubscriptionByIdRequest} requestParameters Request parameters.
@@ -361,7 +361,7 @@ export declare class NotificationsApi extends BaseAPI {
      * @throws {RequiredError}
      * @memberof NotificationsApi
      */
-    deleteSubscriptionById(requestParameters: NotificationsApiDeleteSubscriptionByIdRequest, options?: any): Promise<import("axios").AxiosResponse<DeleteSubscriptionByIdResponse>>;
+    deleteSubscriptionById(requestParameters: NotificationsApiDeleteSubscriptionByIdRequest, options?: any): Promise<import("axios").AxiosResponse<DeleteSubscriptionByIdResponse, any>>;
     /**
      * Returns information about the destination that you specify. The getDestination API is grantless. For more information, see \"Grantless operations\" in the Selling Partner API Developer Guide.  **Usage Plan:**  | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 |  For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
      * @param {NotificationsApiGetDestinationRequest} requestParameters Request parameters.
@@ -369,14 +369,14 @@ export declare class NotificationsApi extends BaseAPI {
      * @throws {RequiredError}
      * @memberof NotificationsApi
      */
-    getDestination(requestParameters: NotificationsApiGetDestinationRequest, options?: any): Promise<import("axios").AxiosResponse<GetDestinationResponse>>;
+    getDestination(requestParameters: NotificationsApiGetDestinationRequest, options?: any): Promise<import("axios").AxiosResponse<GetDestinationResponse, any>>;
     /**
      * Returns information about all destinations. The getDestinations API is grantless. For more information, see \"Grantless operations\" in the Selling Partner API Developer Guide.  **Usage Plan:**  | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 |  For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof NotificationsApi
      */
-    getDestinations(options?: any): Promise<import("axios").AxiosResponse<GetDestinationsResponse>>;
+    getDestinations(options?: any): Promise<import("axios").AxiosResponse<GetDestinationsResponse, any>>;
     /**
      * Returns information about subscriptions of the specified notification type. You can use this API to get subscription information when you do not have a subscription identifier.  **Usage Plan:**  | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 |  For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
      * @param {NotificationsApiGetSubscriptionRequest} requestParameters Request parameters.
@@ -384,7 +384,7 @@ export declare class NotificationsApi extends BaseAPI {
      * @throws {RequiredError}
      * @memberof NotificationsApi
      */
-    getSubscription(requestParameters: NotificationsApiGetSubscriptionRequest, options?: any): Promise<import("axios").AxiosResponse<GetSubscriptionResponse>>;
+    getSubscription(requestParameters: NotificationsApiGetSubscriptionRequest, options?: any): Promise<import("axios").AxiosResponse<GetSubscriptionResponse, any>>;
     /**
      * Returns information about a subscription for the specified notification type. The getSubscriptionById API is grantless. For more information, see \"Grantless operations\" in the Selling Partner API Developer Guide.  **Usage Plan:**  | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 |  For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
      * @param {NotificationsApiGetSubscriptionByIdRequest} requestParameters Request parameters.
@@ -392,5 +392,5 @@ export declare class NotificationsApi extends BaseAPI {
      * @throws {RequiredError}
      * @memberof NotificationsApi
      */
-    getSubscriptionById(requestParameters: NotificationsApiGetSubscriptionByIdRequest, options?: any): Promise<import("axios").AxiosResponse<GetSubscriptionByIdResponse>>;
+    getSubscriptionById(requestParameters: NotificationsApiGetSubscriptionByIdRequest, options?: any): Promise<import("axios").AxiosResponse<GetSubscriptionByIdResponse, any>>;
 }

package/dist/types/src/api-model/common.d.ts

@@ -62,4 +62,4 @@ export declare const toPathString: (url: URL) => string;
  *
  * @export
  */
-export declare const createRequestFunction: (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration | undefined) => (axios?: AxiosInstance, basePath?: string) => Promise<import("axios").AxiosResponse<any>>;
+export declare const createRequestFunction: (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration | undefined) => (axios?: AxiosInstance, basePath?: string) => Promise<import("axios").AxiosResponse<any, any>>;

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

@@ -1,11 +1,11 @@
-import { onRetry } from '@sp-api-sdk/common';
-import type { ClientConfiguration, RateLimit } from '@sp-api-sdk/common';
+import type { ClientConfiguration, SellingPartnerRegion, RateLimit, OnRetryHandler } from '@sp-api-sdk/common';
 import { NotificationsApi } from './api-model';
-export declare const RATE_LIMITS: RateLimit[];
+export declare const clientRateLimits: RateLimit[];
 export interface ClientParameters extends Omit<ClientConfiguration, 'rateLimits' | 'onRetry'> {
+    region: SellingPartnerRegion;
     rateLimiting?: {
         retry: boolean;
-        onRetry?: onRetry;
+        onRetry?: OnRetryHandler;
     };
 }
 export declare class NotificationsApiClient extends NotificationsApi {

package/package.json

@@ -2,7 +2,7 @@
   "name": "@sp-api-sdk/notifications-api-v1",
   "author": "Vincent Mesquita <vincent.mesquita@bizon.solutions>",
   "description": "The Selling Partner API for Notifications lets you subscribe to notifications that are relevant to a selling partner's business. Using this API you can create a destination to receive notifications, subscribe to notifications, delete notification subscriptions, and more. For more information, see the Notifications Use Case Guide",
-  "version": "1.9.0",
+  "version": "1.9.4",
   "main": "dist/cjs/index.js",
   "module": "dist/es/index.js",
   "types": "dist/types/index.d.ts",
@@ -25,9 +25,9 @@
     "test": "NODE_ENV='test' yarn jest"
   },
   "dependencies": {
-    "@sp-api-sdk/auth": "^1.9.4",
-    "@sp-api-sdk/common": "^1.7.5",
-    "axios": "^0.21.1"
+    "@sp-api-sdk/auth": "^1.9.7",
+    "@sp-api-sdk/common": "^1.7.9",
+    "axios": "^0.24.0"
   },
   "repository": {
     "type": "git",
@@ -48,5 +48,5 @@
     "sp sdk",
     "notifications api"
   ],
-  "gitHead": "35cb2e6d2318bd6ccfc94de87ef5572a2aa0aa32"
+  "gitHead": "dd52e8a895f590c62d06f19f4d8715eb7740df66"
 }