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

package/src/reports_v2021_06_30/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 reports_v2021_06_30/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/reports_v2021_06_30/api/ReportsApi.js

@@ -11,7 +11,7 @@
  *
  */
 
-import {ApiClient} from "../ApiClient.js";
+import {ApiClient} from '../ApiClient.js';
 import {CreateReportResponse} from '../model/CreateReportResponse.js';
 import {CreateReportScheduleResponse} from '../model/CreateReportScheduleResponse.js';
 import {CreateReportScheduleSpecification} from '../model/CreateReportScheduleSpecification.js';
@@ -22,6 +22,8 @@ import {Report} from '../model/Report.js';
 import {ReportDocument} from '../model/ReportDocument.js';
 import {ReportSchedule} from '../model/ReportSchedule.js';
 import {ReportScheduleList} from '../model/ReportScheduleList.js';
+import {SuperagentRateLimiter} from '../../../helper/SuperagentRateLimiter.mjs';
+import {DefaultRateLimitFetcher} from '../../../helper/DefaultRateLimitFetcher.mjs';
 
 /**
 * Reports service.
@@ -30,6 +32,9 @@ import {ReportScheduleList} from '../model/ReportScheduleList.js';
 */
 export class ReportsApi {
 
+    // Private memeber stores the default rate limiters
+    #defaultRateLimiterMap;
+
     /**
     * Constructs a new ReportsApi. 
     * @alias module:reports_v2021_06_30/api/ReportsApi
@@ -39,6 +44,39 @@ export class ReportsApi {
     */
     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 = [
+            'ReportsApi-cancelReport',
+            'ReportsApi-cancelReportSchedule',
+            'ReportsApi-createReport',
+            'ReportsApi-createReportSchedule',
+            'ReportsApi-getReport',
+            'ReportsApi-getReportDocument',
+            'ReportsApi-getReportSchedule',
+            'ReportsApi-getReportSchedules',
+            'ReportsApi-getReports',
+        ];
+
+        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);
     }
 
 
@@ -74,7 +112,7 @@ export class ReportsApi {
       return this.apiClient.callApi( 'ReportsApi-cancelReport',
         '/reports/2021-06-30/reports/{reportId}', 'DELETE',
         pathParams, queryParams, headerParams, formParams, postBody,
-        contentTypes, accepts, returnType
+        contentTypes, accepts, returnType, this.getRateLimiter('ReportsApi-cancelReport')
       );
     }
 
@@ -122,7 +160,7 @@ export class ReportsApi {
       return this.apiClient.callApi( 'ReportsApi-cancelReportSchedule',
         '/reports/2021-06-30/schedules/{reportScheduleId}', 'DELETE',
         pathParams, queryParams, headerParams, formParams, postBody,
-        contentTypes, accepts, returnType
+        contentTypes, accepts, returnType, this.getRateLimiter('ReportsApi-cancelReportSchedule')
       );
     }
 
@@ -169,7 +207,7 @@ export class ReportsApi {
       return this.apiClient.callApi( 'ReportsApi-createReport',
         '/reports/2021-06-30/reports', 'POST',
         pathParams, queryParams, headerParams, formParams, postBody,
-        contentTypes, accepts, returnType
+        contentTypes, accepts, returnType, this.getRateLimiter('ReportsApi-createReport')
       );
     }
 
@@ -216,7 +254,7 @@ export class ReportsApi {
       return this.apiClient.callApi( 'ReportsApi-createReportSchedule',
         '/reports/2021-06-30/schedules', 'POST',
         pathParams, queryParams, headerParams, formParams, postBody,
-        contentTypes, accepts, returnType
+        contentTypes, accepts, returnType, this.getRateLimiter('ReportsApi-createReportSchedule')
       );
     }
 
@@ -264,7 +302,7 @@ export class ReportsApi {
       return this.apiClient.callApi( 'ReportsApi-getReport',
         '/reports/2021-06-30/reports/{reportId}', 'GET',
         pathParams, queryParams, headerParams, formParams, postBody,
-        contentTypes, accepts, returnType
+        contentTypes, accepts, returnType, this.getRateLimiter('ReportsApi-getReport')
       );
     }
 
@@ -312,7 +350,7 @@ export class ReportsApi {
       return this.apiClient.callApi( 'ReportsApi-getReportDocument',
         '/reports/2021-06-30/documents/{reportDocumentId}', 'GET',
         pathParams, queryParams, headerParams, formParams, postBody,
-        contentTypes, accepts, returnType
+        contentTypes, accepts, returnType, this.getRateLimiter('ReportsApi-getReportDocument')
       );
     }
 
@@ -360,7 +398,7 @@ export class ReportsApi {
       return this.apiClient.callApi( 'ReportsApi-getReportSchedule',
         '/reports/2021-06-30/schedules/{reportScheduleId}', 'GET',
         pathParams, queryParams, headerParams, formParams, postBody,
-        contentTypes, accepts, returnType
+        contentTypes, accepts, returnType, this.getRateLimiter('ReportsApi-getReportSchedule')
       );
     }
 
@@ -408,7 +446,7 @@ export class ReportsApi {
       return this.apiClient.callApi( 'ReportsApi-getReportSchedules',
         '/reports/2021-06-30/schedules', 'GET',
         pathParams, queryParams, headerParams, formParams, postBody,
-        contentTypes, accepts, returnType
+        contentTypes, accepts, returnType, this.getRateLimiter('ReportsApi-getReportSchedules')
       );
     }
 
@@ -465,7 +503,7 @@ export class ReportsApi {
       return this.apiClient.callApi( 'ReportsApi-getReports',
         '/reports/2021-06-30/reports', 'GET',
         pathParams, queryParams, headerParams, formParams, postBody,
-        contentTypes, accepts, returnType
+        contentTypes, accepts, returnType, this.getRateLimiter('ReportsApi-getReports')
       );
     }
 

package/src/sales_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 sales_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/sales_v1/api/SalesApi.js

@@ -11,8 +11,10 @@
  *
  */
 
-import {ApiClient} from "../ApiClient.js";
+import {ApiClient} from '../ApiClient.js';
 import {GetOrderMetricsResponse} from '../model/GetOrderMetricsResponse.js';
+import {SuperagentRateLimiter} from '../../../helper/SuperagentRateLimiter.mjs';
+import {DefaultRateLimitFetcher} from '../../../helper/DefaultRateLimitFetcher.mjs';
 
 /**
 * Sales service.
@@ -21,6 +23,9 @@ import {GetOrderMetricsResponse} from '../model/GetOrderMetricsResponse.js';
 */
 export class SalesApi {
 
+    // Private memeber stores the default rate limiters
+    #defaultRateLimiterMap;
+
     /**
     * Constructs a new SalesApi. 
     * @alias module:sales_v1/api/SalesApi
@@ -30,6 +35,31 @@ export class SalesApi {
     */
     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 = [
+            'SalesApi-getOrderMetrics',
+        ];
+
+        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);
     }
 
 
@@ -93,7 +123,7 @@ export class SalesApi {
       return this.apiClient.callApi( 'SalesApi-getOrderMetrics',
         '/sales/v1/orderMetrics', 'GET',
         pathParams, queryParams, headerParams, formParams, postBody,
-        contentTypes, accepts, returnType
+        contentTypes, accepts, returnType, this.getRateLimiter('SalesApi-getOrderMetrics')
       );
     }
 

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