@sp-api-sdk/fba-inbound-eligibility-api-v1 1.6.19 → 1.6.23

package/README.md

@@ -2,6 +2,15 @@
 
 With the FBA Inbound Eligibility API, you can build applications that let sellers get eligibility previews for items before shipping them to Amazon's fulfillment centers. With this API you can find out if an item is eligible for inbound shipment to Amazon's fulfillment centers in a specific marketplace. You can also find out if an item is eligible for using the manufacturer barcode for FBA inventory tracking. Sellers can use this information to inform their decisions about which items to ship Amazon's fulfillment centers.
 
+[![npm version](https://badgen.net/npm/v/@sp-api-sdk/fba-inbound-eligibility-api-v1)](https://www.npmjs.com/package/@sp-api-sdk/fba-inbound-eligibility-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/fba-inbound-eligibility-api/fbaInbound.md).
+
+Also, see the [generated documentation](https://bizon.github.io/selling-partner-api-sdk/modules/_sp_api_sdk_fba_inbound_eligibility_api_v1.html) for this API client.
+
 ## Installing
 
 ```sh
@@ -19,26 +28,25 @@ import {SellingPartnerApiAuth} from '@sp-api-sdk/auth'
 import {FbaInboundEligibilityApiClient} from '@sp-api-sdk/fba-inbound-eligibility-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 FbaInboundEligibilityApiClient({
   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 FbaInboundEligibilityApiClient({
@@ -46,13 +54,28 @@ const client = new FbaInboundEligibilityApiClient({
   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/fba-inbound-eligibility-api/fbaInbound.md)).
+
+## License
+
+MIT
 
-## API documentation
+## Miscellaneous
 
-See [here](https://github.com/amzn/selling-partner-api-docs/tree/main/references/fba-inbound-eligibility-api/fbaInbound.md)
+```
+    ╚⊙ ⊙╝
+  ╚═(███)═╝
+ ╚═(███)═╝
+╚═(███)═╝
+ ╚═(███)═╝
+  ╚═(███)═╝
+   ╚═(███)═╝
+```

package/dist/cjs/src/client.js

@@ -1,11 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.FbaInboundEligibilityApiClient = exports.RATE_LIMITS = void 0;
+exports.FbaInboundEligibilityApiClient = 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('^/fba/inbound/v1/eligibility/itemPreview$'),
@@ -15,20 +15,23 @@ exports.RATE_LIMITS = [
 ];
 class FbaInboundEligibilityApiClient extends api_model_1.FbaInboundApi {
     constructor(parameters) {
-        const region = common_1.awsRegionByCode[parameters.region] ?? parameters.region;
+        const config = common_1.sellingPartnerRegions[parameters.region];
+        if (!config) {
+            throw new error_1.FbaInboundEligibilityApiError(`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.FbaInboundEligibilityApiError(`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, FbaInboundApi } from './api-model';
 import { FbaInboundEligibilityApiError } from './error';
-export const RATE_LIMITS = [
+export const clientRateLimits = [
     {
         method: 'get',
         urlRegex: new RegExp('^/fba/inbound/v1/eligibility/itemPreview$'),
@@ -12,20 +12,23 @@ export const RATE_LIMITS = [
 ];
 export class FbaInboundEligibilityApiClient extends FbaInboundApi {
     constructor(parameters) {
-        const region = awsRegionByCode[parameters.region] ?? parameters.region;
+        const config = sellingPartnerRegions[parameters.region];
+        if (!config) {
+            throw new FbaInboundEligibilityApiError(`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 FbaInboundEligibilityApiError(`Unknown region : ${region}`);
-        }
+        const endpoint = config.endpoints[environment];
         super(configuration, endpoint, axiosInstance);
     }
 }

package/dist/types/src/api-model/api/fba-inbound-api.d.ts

@@ -97,5 +97,5 @@ export declare class FbaInboundApi extends BaseAPI {
      * @throws {RequiredError}
      * @memberof FbaInboundApi
      */
-    getItemEligibilityPreview(requestParameters: FbaInboundApiGetItemEligibilityPreviewRequest, options?: any): Promise<import("axios").AxiosResponse<GetItemEligibilityPreviewResponse>>;
+    getItemEligibilityPreview(requestParameters: FbaInboundApiGetItemEligibilityPreviewRequest, options?: any): Promise<import("axios").AxiosResponse<GetItemEligibilityPreviewResponse, 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 { FbaInboundApi } 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 FbaInboundEligibilityApiClient extends FbaInboundApi {

package/package.json

@@ -2,7 +2,7 @@
   "name": "@sp-api-sdk/fba-inbound-eligibility-api-v1",
   "author": "Vincent Mesquita <vincent.mesquita@bizon.solutions>",
   "description": "With the FBA Inbound Eligibility API, you can build applications that let sellers get eligibility previews for items before shipping them to Amazon's fulfillment centers. With this API you can find out if an item is eligible for inbound shipment to Amazon's fulfillment centers in a specific marketplace. You can also find out if an item is eligible for using the manufacturer barcode for FBA inventory tracking. Sellers can use this information to inform their decisions about which items to ship Amazon's fulfillment centers.",
-  "version": "1.6.19",
+  "version": "1.6.23",
   "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",
     "fba inbound eligibility api"
   ],
-  "gitHead": "634245dca301dd9c49f6b53447e0aa9bdb752c1a"
+  "gitHead": "dd52e8a895f590c62d06f19f4d8715eb7740df66"
 }