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

package/src/vendororders_v1/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 vendororders_v1/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/vendororders_v1/api/VendorOrdersApi.js

@@ -11,12 +11,14 @@
  *
  */
 
-import {ApiClient} from "../ApiClient.js";
+import {ApiClient} from '../ApiClient.js';
 import {GetPurchaseOrderResponse} from '../model/GetPurchaseOrderResponse.js';
 import {GetPurchaseOrdersResponse} from '../model/GetPurchaseOrdersResponse.js';
 import {GetPurchaseOrdersStatusResponse} from '../model/GetPurchaseOrdersStatusResponse.js';
 import {SubmitAcknowledgementRequest} from '../model/SubmitAcknowledgementRequest.js';
 import {SubmitAcknowledgementResponse} from '../model/SubmitAcknowledgementResponse.js';
+import {SuperagentRateLimiter} from '../../../helper/SuperagentRateLimiter.mjs';
+import {DefaultRateLimitFetcher} from '../../../helper/DefaultRateLimitFetcher.mjs';
 
 /**
 * VendorOrders service.
@@ -25,6 +27,9 @@ import {SubmitAcknowledgementResponse} from '../model/SubmitAcknowledgementRespo
 */
 export class VendorOrdersApi {
 
+    // Private memeber stores the default rate limiters
+    #defaultRateLimiterMap;
+
     /**
     * Constructs a new VendorOrdersApi. 
     * @alias module:vendororders_v1/api/VendorOrdersApi
@@ -34,6 +39,34 @@ export class VendorOrdersApi {
     */
     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 = [
+            'VendorOrdersApi-getPurchaseOrder',
+            'VendorOrdersApi-getPurchaseOrders',
+            'VendorOrdersApi-getPurchaseOrdersStatus',
+            'VendorOrdersApi-submitAcknowledgement',
+        ];
+
+        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);
     }
 
 
@@ -69,7 +102,7 @@ export class VendorOrdersApi {
       return this.apiClient.callApi( 'VendorOrdersApi-getPurchaseOrder',
         '/vendor/orders/v1/purchaseOrders/{purchaseOrderNumber}', 'GET',
         pathParams, queryParams, headerParams, formParams, postBody,
-        contentTypes, accepts, returnType
+        contentTypes, accepts, returnType, this.getRateLimiter('VendorOrdersApi-getPurchaseOrder')
       );
     }
 
@@ -136,7 +169,7 @@ export class VendorOrdersApi {
       return this.apiClient.callApi( 'VendorOrdersApi-getPurchaseOrders',
         '/vendor/orders/v1/purchaseOrders', 'GET',
         pathParams, queryParams, headerParams, formParams, postBody,
-        contentTypes, accepts, returnType
+        contentTypes, accepts, returnType, this.getRateLimiter('VendorOrdersApi-getPurchaseOrders')
       );
     }
 
@@ -217,7 +250,7 @@ export class VendorOrdersApi {
       return this.apiClient.callApi( 'VendorOrdersApi-getPurchaseOrdersStatus',
         '/vendor/orders/v1/purchaseOrdersStatus', 'GET',
         pathParams, queryParams, headerParams, formParams, postBody,
-        contentTypes, accepts, returnType
+        contentTypes, accepts, returnType, this.getRateLimiter('VendorOrdersApi-getPurchaseOrdersStatus')
       );
     }
 
@@ -277,7 +310,7 @@ export class VendorOrdersApi {
       return this.apiClient.callApi( 'VendorOrdersApi-submitAcknowledgement',
         '/vendor/orders/v1/acknowledgements', 'POST',
         pathParams, queryParams, headerParams, formParams, postBody,
-        contentTypes, accepts, returnType
+        contentTypes, accepts, returnType, this.getRateLimiter('VendorOrdersApi-submitAcknowledgement')
       );
     }
 

package/src/vendorshipments_v1/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 vendorshipments_v1/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/vendorshipments_v1/api/VendorShippingApi.js

@@ -11,12 +11,14 @@
  *
  */
 
-import {ApiClient} from "../ApiClient.js";
+import {ApiClient} from '../ApiClient.js';
 import {GetShipmentDetailsResponse} from '../model/GetShipmentDetailsResponse.js';
 import {GetShipmentLabels} from '../model/GetShipmentLabels.js';
 import {SubmitShipmentConfirmationsRequest} from '../model/SubmitShipmentConfirmationsRequest.js';
 import {SubmitShipmentConfirmationsResponse} from '../model/SubmitShipmentConfirmationsResponse.js';
 import {SubmitShipments} from '../model/SubmitShipments.js';
+import {SuperagentRateLimiter} from '../../../helper/SuperagentRateLimiter.mjs';
+import {DefaultRateLimitFetcher} from '../../../helper/DefaultRateLimitFetcher.mjs';
 
 /**
 * VendorShipping service.
@@ -25,6 +27,9 @@ import {SubmitShipments} from '../model/SubmitShipments.js';
 */
 export class VendorShippingApi {
 
+    // Private memeber stores the default rate limiters
+    #defaultRateLimiterMap;
+
     /**
     * Constructs a new VendorShippingApi. 
     * @alias module:vendorshipments_v1/api/VendorShippingApi
@@ -34,6 +39,34 @@ export class VendorShippingApi {
     */
     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 = [
+            'VendorShippingApi-getShipmentDetails',
+            'VendorShippingApi-getShipmentLabels',
+            'VendorShippingApi-submitShipmentConfirmations',
+            'VendorShippingApi-submitShipments',
+        ];
+
+        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);
     }
 
 
@@ -113,7 +146,7 @@ export class VendorShippingApi {
       return this.apiClient.callApi( 'VendorShippingApi-getShipmentDetails',
         '/vendor/shipping/v1/shipments', 'GET',
         pathParams, queryParams, headerParams, formParams, postBody,
-        contentTypes, accepts, returnType
+        contentTypes, accepts, returnType, this.getRateLimiter('VendorShippingApi-getShipmentDetails')
       );
     }
 
@@ -197,7 +230,7 @@ export class VendorShippingApi {
       return this.apiClient.callApi( 'VendorShippingApi-getShipmentLabels',
         '/vendor/shipping/v1/transportLabels', 'GET',
         pathParams, queryParams, headerParams, formParams, postBody,
-        contentTypes, accepts, returnType
+        contentTypes, accepts, returnType, this.getRateLimiter('VendorShippingApi-getShipmentLabels')
       );
     }
 
@@ -253,7 +286,7 @@ export class VendorShippingApi {
       return this.apiClient.callApi( 'VendorShippingApi-submitShipmentConfirmations',
         '/vendor/shipping/v1/shipmentConfirmations', 'POST',
         pathParams, queryParams, headerParams, formParams, postBody,
-        contentTypes, accepts, returnType
+        contentTypes, accepts, returnType, this.getRateLimiter('VendorShippingApi-submitShipmentConfirmations')
       );
     }
 
@@ -302,7 +335,7 @@ export class VendorShippingApi {
       return this.apiClient.callApi( 'VendorShippingApi-submitShipments',
         '/vendor/shipping/v1/shipments', 'POST',
         pathParams, queryParams, headerParams, formParams, postBody,
-        contentTypes, accepts, returnType
+        contentTypes, accepts, returnType, this.getRateLimiter('VendorShippingApi-submitShipments')
       );
     }
 

package/src/vendortransactionstatus_v1/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 vendortransactionstatus_v1/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) {