@amazon-sp-api-release/amazon-sp-api-sdk-js 1.0.0-rc8 → 1.0.0

package/src/invoicing_v0/ApiClient.js

@@ -11,12 +11,11 @@
  *
  */
 
-import superagent from "superagent";
-import querystring from "querystring";
-import { URL } from 'node:url';
-import { RateLimitConfiguration } from "../../helper/RateLimitConfiguration.mjs";
-import { SuperagentRateLimiter } from "../../helper/SuperagentRateLimiter.mjs";
-import { DefaultRateLimitFetcher } from "../../helper/DefaultRateLimitFetcher.mjs";
+import superagent from 'superagent';
+import querystring from 'querystring';
+import {URL} from 'node:url';
+import {RateLimitConfiguration} from '../../helper/RateLimitConfiguration.mjs';
+import {SuperagentRateLimiter} from '../../helper/SuperagentRateLimiter.mjs';
 
 /**
 * @module invoicing_v0/ApiClient
@@ -193,9 +192,8 @@ export class ApiClient {
     #tokenForApiCall = null;
     #lwaClient = null;
     #rdtClient = null;
-    #defaultRateLimitFetcher = null;
-    #customizedRateLimiter = null;
-    #useDefaultRateLimiter = false;
+    #customizedRateLimiterMap = null;
+    #useRateLimiter = true;
 
     /**
     * Constructs a new ApiClient.
@@ -259,42 +257,54 @@ export class ApiClient {
          * Allow user to override superagent agent
          */
          this.requestAgent = null;
+
+         /*
+         * Initialize customized rate limiter map
+         */
+        this.#customizedRateLimiterMap = new Map();
     }
 
     /**
-    * Initialize #defaultRateLimitFetcher
+    * Set customized rate limiter for one operation
+    * For operations that customized rate limiter are not set
+    * Will use default rate limiter
+    * @param {String} operationName
+    * @param {RateLimitConfiguration} config
     */
-    async initializeDefaultRateLimit() {
-        try {
-            this.#defaultRateLimitFetcher = await DefaultRateLimitFetcher.getInstance();
-        } catch (err) {
-            throw new Error('Error reading default rate limit:', err);
-        } 
+    setCustomizedRateLimiterForOperation(operationName, config) {
+        this.#customizedRateLimiterMap.set(operationName, new SuperagentRateLimiter(config));
     }
 
     /**
-    * Enable default rate limiter
+    * Disable customized rate limiter for one operation
+    * Fall back to default rate limiter
+    * @param {String} operationName
     */
-    enableDefaultRateLimiter() {
-        this.#useDefaultRateLimiter = true;
-        this.#customizedRateLimiter = null;
+    disableCustomizedRatelimiterForOperation(operationName) {
+        this.#customizedRateLimiterMap.delete(operationName);
     }
 
     /**
-    * Set customized rate limiter
-    * @param {RateLimitConfiguration} config
+    * Clear customized rate limiter for all operations
+    * All operations will fall back to default rate limiter
+    * @param {String} operationName
+    */
+    disableCustomizedRatelimiterForAll() {
+        this.#customizedRateLimiterMap.clear();
+    }
+
+    /**
+    * Disable both default and customized rate limiter for all operations
     */
-    enableCustomizedRateLimiter(config) {
-        this.#customizedRateLimiter = new SuperagentRateLimiter(config);
-        this.#useDefaultRateLimiter = false;
+    disableRateLimiter() {
+        this.#useRateLimiter = false;
     }
 
     /**
-    * Disable both customized and default rate limiter
+    * Enable default or customized rate limiter for all operations
     */
-    disableRatelimiter() {
-        this.#customizedRateLimiter = null;
-        this.defaultRateLimiter = false;
+    enableRateLimiter() {
+        this.#useRateLimiter = true;
     }
 
     /**
@@ -597,11 +607,12 @@ export class ApiClient {
     * @param {Array<String>} accepts An array of acceptable response MIME types.
     * @param {(String|Array|ObjectFunction)} returnType The required type to return; can be a string for simple types or the
     * constructor for a complex type.
+    * @param {SuperagentRateLimiter} defaultRateLimiter The default rate limiter. 
     * @returns {Promise} A {@link https://www.promisejs.org/|Promise} object.
     */
     async callApi(operation, path, httpMethod, pathParams,
         queryParams, headerParams, formParams, bodyParam, contentTypes, accepts,
-        returnType) {
+        returnType, defaultRateLimiter) {
 
         var url = this.buildUrl(path, pathParams);
         var request = superagent(httpMethod, url);
@@ -609,15 +620,14 @@ export class ApiClient {
             throw new Error('none of accessToken, RDT token and auto-retrieval is set.');
         }
 
-        //Set rate limiter
-        if (this.#useDefaultRateLimiter) {
-            await this.initializeDefaultRateLimit();
-            const defaultRateLimiter = new SuperagentRateLimiter(this.#defaultRateLimitFetcher.getLimit(operation));
-            request.use(defaultRateLimiter.getPlugin());
-        } else if (this.#customizedRateLimiter) {
-            request.use(this.#customizedRateLimiter.getPlugin());
+        if (this.#useRateLimiter) {
+            //Set rate limiter
+            if (this.#customizedRateLimiterMap.get(operation)) {
+                request.use(this.#customizedRateLimiterMap.get(operation).getPlugin());
+            } else if (defaultRateLimiter) {
+                request.use(defaultRateLimiter.getPlugin());
+            }
         }
-        
 
         // set query parameters
         if (httpMethod.toUpperCase() === 'GET' && this.cache === false) {

package/src/invoicing_v0/api/ShipmentInvoiceApi.js

@@ -11,11 +11,13 @@
  *
  */
 
-import {ApiClient} from "../ApiClient.js";
+import {ApiClient} from '../ApiClient.js';
 import {GetInvoiceStatusResponse} from '../model/GetInvoiceStatusResponse.js';
 import {GetShipmentDetailsResponse} from '../model/GetShipmentDetailsResponse.js';
 import {SubmitInvoiceRequest} from '../model/SubmitInvoiceRequest.js';
 import {SubmitInvoiceResponse} from '../model/SubmitInvoiceResponse.js';
+import {SuperagentRateLimiter} from '../../../helper/SuperagentRateLimiter.mjs';
+import {DefaultRateLimitFetcher} from '../../../helper/DefaultRateLimitFetcher.mjs';
 
 /**
 * ShipmentInvoice service.
@@ -24,6 +26,9 @@ import {SubmitInvoiceResponse} from '../model/SubmitInvoiceResponse.js';
 */
 export class ShipmentInvoiceApi {
 
+    // Private memeber stores the default rate limiters
+    #defaultRateLimiterMap;
+
     /**
     * Constructs a new ShipmentInvoiceApi. 
     * @alias module:invoicing_v0/api/ShipmentInvoiceApi
@@ -33,6 +38,33 @@ export class ShipmentInvoiceApi {
     */
     constructor(apiClient) {
         this.apiClient = apiClient || ApiClient.instance;
+        this.initializeDefaultRateLimiterMap();
+    }
+
+    /**
+     * Initialize rate limiters for API operations
+     */
+    initializeDefaultRateLimiterMap() {
+        this.#defaultRateLimiterMap = new Map()
+        const defaultRateLimitFetcher = new DefaultRateLimitFetcher();
+        const operations = [
+            'ShipmentInvoiceApi-getInvoiceStatus',
+            'ShipmentInvoiceApi-getShipmentDetails',
+            'ShipmentInvoiceApi-submitInvoice',
+        ];
+
+        for (const operation of operations) {
+            const config = defaultRateLimitFetcher.getLimit(operation);
+            this.#defaultRateLimiterMap.set(operation, new SuperagentRateLimiter(config));
+        }
+    }
+
+    /**
+     * Get rate limiter for a specific operation
+     * @param {String} operation name
+     */
+    getRateLimiter(operation) {
+        return this.#defaultRateLimiterMap.get(operation);
     }
 
 
@@ -68,7 +100,7 @@ export class ShipmentInvoiceApi {
       return this.apiClient.callApi( 'ShipmentInvoiceApi-getInvoiceStatus',
         '/fba/outbound/brazil/v0/shipments/{shipmentId}/invoice/status', 'GET',
         pathParams, queryParams, headerParams, formParams, postBody,
-        contentTypes, accepts, returnType
+        contentTypes, accepts, returnType, this.getRateLimiter('ShipmentInvoiceApi-getInvoiceStatus')
       );
     }
 
@@ -116,7 +148,7 @@ export class ShipmentInvoiceApi {
       return this.apiClient.callApi( 'ShipmentInvoiceApi-getShipmentDetails',
         '/fba/outbound/brazil/v0/shipments/{shipmentId}', 'GET',
         pathParams, queryParams, headerParams, formParams, postBody,
-        contentTypes, accepts, returnType
+        contentTypes, accepts, returnType, this.getRateLimiter('ShipmentInvoiceApi-getShipmentDetails')
       );
     }
 
@@ -170,7 +202,7 @@ export class ShipmentInvoiceApi {
       return this.apiClient.callApi( 'ShipmentInvoiceApi-submitInvoice',
         '/fba/outbound/brazil/v0/shipments/{shipmentId}/invoice', 'POST',
         pathParams, queryParams, headerParams, formParams, postBody,
-        contentTypes, accepts, returnType
+        contentTypes, accepts, returnType, this.getRateLimiter('ShipmentInvoiceApi-submitInvoice')
       );
     }
 

package/src/listingsitems_v2021_08_01/ApiClient.js

@@ -11,12 +11,11 @@
  *
  */
 
-import superagent from "superagent";
-import querystring from "querystring";
-import { URL } from 'node:url';
-import { RateLimitConfiguration } from "../../helper/RateLimitConfiguration.mjs";
-import { SuperagentRateLimiter } from "../../helper/SuperagentRateLimiter.mjs";
-import { DefaultRateLimitFetcher } from "../../helper/DefaultRateLimitFetcher.mjs";
+import superagent from 'superagent';
+import querystring from 'querystring';
+import {URL} from 'node:url';
+import {RateLimitConfiguration} from '../../helper/RateLimitConfiguration.mjs';
+import {SuperagentRateLimiter} from '../../helper/SuperagentRateLimiter.mjs';
 
 /**
 * @module listingsitems_v2021_08_01/ApiClient
@@ -193,9 +192,8 @@ export class ApiClient {
     #tokenForApiCall = null;
     #lwaClient = null;
     #rdtClient = null;
-    #defaultRateLimitFetcher = null;
-    #customizedRateLimiter = null;
-    #useDefaultRateLimiter = false;
+    #customizedRateLimiterMap = null;
+    #useRateLimiter = true;
 
     /**
     * Constructs a new ApiClient.
@@ -259,42 +257,54 @@ export class ApiClient {
          * Allow user to override superagent agent
          */
          this.requestAgent = null;
+
+         /*
+         * Initialize customized rate limiter map
+         */
+        this.#customizedRateLimiterMap = new Map();
     }
 
     /**
-    * Initialize #defaultRateLimitFetcher
+    * Set customized rate limiter for one operation
+    * For operations that customized rate limiter are not set
+    * Will use default rate limiter
+    * @param {String} operationName
+    * @param {RateLimitConfiguration} config
     */
-    async initializeDefaultRateLimit() {
-        try {
-            this.#defaultRateLimitFetcher = await DefaultRateLimitFetcher.getInstance();
-        } catch (err) {
-            throw new Error('Error reading default rate limit:', err);
-        } 
+    setCustomizedRateLimiterForOperation(operationName, config) {
+        this.#customizedRateLimiterMap.set(operationName, new SuperagentRateLimiter(config));
     }
 
     /**
-    * Enable default rate limiter
+    * Disable customized rate limiter for one operation
+    * Fall back to default rate limiter
+    * @param {String} operationName
     */
-    enableDefaultRateLimiter() {
-        this.#useDefaultRateLimiter = true;
-        this.#customizedRateLimiter = null;
+    disableCustomizedRatelimiterForOperation(operationName) {
+        this.#customizedRateLimiterMap.delete(operationName);
     }
 
     /**
-    * Set customized rate limiter
-    * @param {RateLimitConfiguration} config
+    * Clear customized rate limiter for all operations
+    * All operations will fall back to default rate limiter
+    * @param {String} operationName
+    */
+    disableCustomizedRatelimiterForAll() {
+        this.#customizedRateLimiterMap.clear();
+    }
+
+    /**
+    * Disable both default and customized rate limiter for all operations
     */
-    enableCustomizedRateLimiter(config) {
-        this.#customizedRateLimiter = new SuperagentRateLimiter(config);
-        this.#useDefaultRateLimiter = false;
+    disableRateLimiter() {
+        this.#useRateLimiter = false;
     }
 
     /**
-    * Disable both customized and default rate limiter
+    * Enable default or customized rate limiter for all operations
     */
-    disableRatelimiter() {
-        this.#customizedRateLimiter = null;
-        this.defaultRateLimiter = false;
+    enableRateLimiter() {
+        this.#useRateLimiter = true;
     }
 
     /**
@@ -597,11 +607,12 @@ export class ApiClient {
     * @param {Array<String>} accepts An array of acceptable response MIME types.
     * @param {(String|Array|ObjectFunction)} returnType The required type to return; can be a string for simple types or the
     * constructor for a complex type.
+    * @param {SuperagentRateLimiter} defaultRateLimiter The default rate limiter. 
     * @returns {Promise} A {@link https://www.promisejs.org/|Promise} object.
     */
     async callApi(operation, path, httpMethod, pathParams,
         queryParams, headerParams, formParams, bodyParam, contentTypes, accepts,
-        returnType) {
+        returnType, defaultRateLimiter) {
 
         var url = this.buildUrl(path, pathParams);
         var request = superagent(httpMethod, url);
@@ -609,15 +620,14 @@ export class ApiClient {
             throw new Error('none of accessToken, RDT token and auto-retrieval is set.');
         }
 
-        //Set rate limiter
-        if (this.#useDefaultRateLimiter) {
-            await this.initializeDefaultRateLimit();
-            const defaultRateLimiter = new SuperagentRateLimiter(this.#defaultRateLimitFetcher.getLimit(operation));
-            request.use(defaultRateLimiter.getPlugin());
-        } else if (this.#customizedRateLimiter) {
-            request.use(this.#customizedRateLimiter.getPlugin());
+        if (this.#useRateLimiter) {
+            //Set rate limiter
+            if (this.#customizedRateLimiterMap.get(operation)) {
+                request.use(this.#customizedRateLimiterMap.get(operation).getPlugin());
+            } else if (defaultRateLimiter) {
+                request.use(defaultRateLimiter.getPlugin());
+            }
         }
-        
 
         // set query parameters
         if (httpMethod.toUpperCase() === 'GET' && this.cache === false) {

package/src/listingsitems_v2021_08_01/api/ListingsApi.js

@@ -11,13 +11,15 @@
  *
  */
 
-import {ApiClient} from "../ApiClient.js";
+import {ApiClient} from '../ApiClient.js';
 import {ErrorList} from '../model/ErrorList.js';
 import {Item} from '../model/Item.js';
 import {ItemSearchResults} from '../model/ItemSearchResults.js';
 import {ListingsItemPatchRequest} from '../model/ListingsItemPatchRequest.js';
 import {ListingsItemPutRequest} from '../model/ListingsItemPutRequest.js';
 import {ListingsItemSubmissionResponse} from '../model/ListingsItemSubmissionResponse.js';
+import {SuperagentRateLimiter} from '../../../helper/SuperagentRateLimiter.mjs';
+import {DefaultRateLimitFetcher} from '../../../helper/DefaultRateLimitFetcher.mjs';
 
 /**
 * Listings service.
@@ -26,6 +28,9 @@ import {ListingsItemSubmissionResponse} from '../model/ListingsItemSubmissionRes
 */
 export class ListingsApi {
 
+    // Private memeber stores the default rate limiters
+    #defaultRateLimiterMap;
+
     /**
     * Constructs a new ListingsApi. 
     * @alias module:listingsitems_v2021_08_01/api/ListingsApi
@@ -35,6 +40,35 @@ export class ListingsApi {
     */
     constructor(apiClient) {
         this.apiClient = apiClient || ApiClient.instance;
+        this.initializeDefaultRateLimiterMap();
+    }
+
+    /**
+     * Initialize rate limiters for API operations
+     */
+    initializeDefaultRateLimiterMap() {
+        this.#defaultRateLimiterMap = new Map()
+        const defaultRateLimitFetcher = new DefaultRateLimitFetcher();
+        const operations = [
+            'ListingsApi-deleteListingsItem',
+            'ListingsApi-getListingsItem',
+            'ListingsApi-patchListingsItem',
+            'ListingsApi-putListingsItem',
+            'ListingsApi-searchListingsItems',
+        ];
+
+        for (const operation of operations) {
+            const config = defaultRateLimitFetcher.getLimit(operation);
+            this.#defaultRateLimiterMap.set(operation, new SuperagentRateLimiter(config));
+        }
+    }
+
+    /**
+     * Get rate limiter for a specific operation
+     * @param {String} operation name
+     */
+    getRateLimiter(operation) {
+        return this.#defaultRateLimiterMap.get(operation);
     }
 
 
@@ -88,7 +122,7 @@ export class ListingsApi {
       return this.apiClient.callApi( 'ListingsApi-deleteListingsItem',
         '/listings/2021-08-01/items/{sellerId}/{sku}', 'DELETE',
         pathParams, queryParams, headerParams, formParams, postBody,
-        contentTypes, accepts, returnType
+        contentTypes, accepts, returnType, this.getRateLimiter('ListingsApi-deleteListingsItem')
       );
     }
 
@@ -160,7 +194,7 @@ export class ListingsApi {
       return this.apiClient.callApi( 'ListingsApi-getListingsItem',
         '/listings/2021-08-01/items/{sellerId}/{sku}', 'GET',
         pathParams, queryParams, headerParams, formParams, postBody,
-        contentTypes, accepts, returnType
+        contentTypes, accepts, returnType, this.getRateLimiter('ListingsApi-getListingsItem')
       );
     }
 
@@ -241,7 +275,7 @@ export class ListingsApi {
       return this.apiClient.callApi( 'ListingsApi-patchListingsItem',
         '/listings/2021-08-01/items/{sellerId}/{sku}', 'PATCH',
         pathParams, queryParams, headerParams, formParams, postBody,
-        contentTypes, accepts, returnType
+        contentTypes, accepts, returnType, this.getRateLimiter('ListingsApi-patchListingsItem')
       );
     }
 
@@ -324,7 +358,7 @@ export class ListingsApi {
       return this.apiClient.callApi( 'ListingsApi-putListingsItem',
         '/listings/2021-08-01/items/{sellerId}/{sku}', 'PUT',
         pathParams, queryParams, headerParams, formParams, postBody,
-        contentTypes, accepts, returnType
+        contentTypes, accepts, returnType, this.getRateLimiter('ListingsApi-putListingsItem')
       );
     }
 
@@ -422,7 +456,7 @@ export class ListingsApi {
       return this.apiClient.callApi( 'ListingsApi-searchListingsItems',
         '/listings/2021-08-01/items/{sellerId}', 'GET',
         pathParams, queryParams, headerParams, formParams, postBody,
-        contentTypes, accepts, returnType
+        contentTypes, accepts, returnType, this.getRateLimiter('ListingsApi-searchListingsItems')
       );
     }
 

package/src/listingsrestrictions_v2021_08_01/ApiClient.js

@@ -11,12 +11,11 @@
  *
  */
 
-import superagent from "superagent";
-import querystring from "querystring";
-import { URL } from 'node:url';
-import { RateLimitConfiguration } from "../../helper/RateLimitConfiguration.mjs";
-import { SuperagentRateLimiter } from "../../helper/SuperagentRateLimiter.mjs";
-import { DefaultRateLimitFetcher } from "../../helper/DefaultRateLimitFetcher.mjs";
+import superagent from 'superagent';
+import querystring from 'querystring';
+import {URL} from 'node:url';
+import {RateLimitConfiguration} from '../../helper/RateLimitConfiguration.mjs';
+import {SuperagentRateLimiter} from '../../helper/SuperagentRateLimiter.mjs';
 
 /**
 * @module listingsrestrictions_v2021_08_01/ApiClient
@@ -193,9 +192,8 @@ export class ApiClient {
     #tokenForApiCall = null;
     #lwaClient = null;
     #rdtClient = null;
-    #defaultRateLimitFetcher = null;
-    #customizedRateLimiter = null;
-    #useDefaultRateLimiter = false;
+    #customizedRateLimiterMap = null;
+    #useRateLimiter = true;
 
     /**
     * Constructs a new ApiClient.
@@ -259,42 +257,54 @@ export class ApiClient {
          * Allow user to override superagent agent
          */
          this.requestAgent = null;
+
+         /*
+         * Initialize customized rate limiter map
+         */
+        this.#customizedRateLimiterMap = new Map();
     }
 
     /**
-    * Initialize #defaultRateLimitFetcher
+    * Set customized rate limiter for one operation
+    * For operations that customized rate limiter are not set
+    * Will use default rate limiter
+    * @param {String} operationName
+    * @param {RateLimitConfiguration} config
     */
-    async initializeDefaultRateLimit() {
-        try {
-            this.#defaultRateLimitFetcher = await DefaultRateLimitFetcher.getInstance();
-        } catch (err) {
-            throw new Error('Error reading default rate limit:', err);
-        } 
+    setCustomizedRateLimiterForOperation(operationName, config) {
+        this.#customizedRateLimiterMap.set(operationName, new SuperagentRateLimiter(config));
     }
 
     /**
-    * Enable default rate limiter
+    * Disable customized rate limiter for one operation
+    * Fall back to default rate limiter
+    * @param {String} operationName
     */
-    enableDefaultRateLimiter() {
-        this.#useDefaultRateLimiter = true;
-        this.#customizedRateLimiter = null;
+    disableCustomizedRatelimiterForOperation(operationName) {
+        this.#customizedRateLimiterMap.delete(operationName);
     }
 
     /**
-    * Set customized rate limiter
-    * @param {RateLimitConfiguration} config
+    * Clear customized rate limiter for all operations
+    * All operations will fall back to default rate limiter
+    * @param {String} operationName
+    */
+    disableCustomizedRatelimiterForAll() {
+        this.#customizedRateLimiterMap.clear();
+    }
+
+    /**
+    * Disable both default and customized rate limiter for all operations
     */
-    enableCustomizedRateLimiter(config) {
-        this.#customizedRateLimiter = new SuperagentRateLimiter(config);
-        this.#useDefaultRateLimiter = false;
+    disableRateLimiter() {
+        this.#useRateLimiter = false;
     }
 
     /**
-    * Disable both customized and default rate limiter
+    * Enable default or customized rate limiter for all operations
     */
-    disableRatelimiter() {
-        this.#customizedRateLimiter = null;
-        this.defaultRateLimiter = false;
+    enableRateLimiter() {
+        this.#useRateLimiter = true;
     }
 
     /**
@@ -597,11 +607,12 @@ export class ApiClient {
     * @param {Array<String>} accepts An array of acceptable response MIME types.
     * @param {(String|Array|ObjectFunction)} returnType The required type to return; can be a string for simple types or the
     * constructor for a complex type.
+    * @param {SuperagentRateLimiter} defaultRateLimiter The default rate limiter. 
     * @returns {Promise} A {@link https://www.promisejs.org/|Promise} object.
     */
     async callApi(operation, path, httpMethod, pathParams,
         queryParams, headerParams, formParams, bodyParam, contentTypes, accepts,
-        returnType) {
+        returnType, defaultRateLimiter) {
 
         var url = this.buildUrl(path, pathParams);
         var request = superagent(httpMethod, url);
@@ -609,15 +620,14 @@ export class ApiClient {
             throw new Error('none of accessToken, RDT token and auto-retrieval is set.');
         }
 
-        //Set rate limiter
-        if (this.#useDefaultRateLimiter) {
-            await this.initializeDefaultRateLimit();
-            const defaultRateLimiter = new SuperagentRateLimiter(this.#defaultRateLimitFetcher.getLimit(operation));
-            request.use(defaultRateLimiter.getPlugin());
-        } else if (this.#customizedRateLimiter) {
-            request.use(this.#customizedRateLimiter.getPlugin());
+        if (this.#useRateLimiter) {
+            //Set rate limiter
+            if (this.#customizedRateLimiterMap.get(operation)) {
+                request.use(this.#customizedRateLimiterMap.get(operation).getPlugin());
+            } else if (defaultRateLimiter) {
+                request.use(defaultRateLimiter.getPlugin());
+            }
         }
-        
 
         // set query parameters
         if (httpMethod.toUpperCase() === 'GET' && this.cache === false) {