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

package/README.md

@@ -81,7 +81,7 @@ async function getMarketplaceParticipations() {
 getMarketplaceParticipations();
 ```
 
-Alternatively, you can go to `@amazon-sp-api-release/amazon-sp-api-sdk-js/sample-node-app` and copy over and modify `index.js` and `app.config.mjs` files and give them a try. You can see multiple API operation call sampleswith various way of retrieving token, as well how to set up rate limiter and retry logic when making API calls.
+Alternatively, you can go to `@amazon-sp-api-release/amazon-sp-api-sdk-js/sample-node-app` and copy over and modify `index.js` and `app.config.mjs` files and give them a try. You can see multiple API operation call samples with various way of retrieving token, as well how to set up rate limiter and retry logic when making API calls. Note that the rate limiter is turned on by default to protect your API calls from 429 errors.
 
 ##### Additional Note: 
 This Amazon Selling Partner API JavaScript SDK is fully compatible with ECMAScript modules (ESM). You can use modern ES6+ import/export syntax as demonstrated in the example code:

package/helper/DefaultRateLimitFetcher.mjs

@@ -1,29 +1,12 @@
-import { parse } from 'yaml';
-import { readFile } from 'fs/promises';
 import { RateLimitConfiguration } from './RateLimitConfiguration.mjs';
-import { fileURLToPath } from 'url';
-import { dirname } from 'path';
-import { join } from 'path';
+import { defaultRateLimitMap } from './DefaultRateLimitMap.mjs';
 
 export class DefaultRateLimitFetcher {
 
     #defaultRateLimitMap;
 
     constructor() {
-        this.#defaultRateLimitMap = null;
-    }
-
-    // Initialize the configuration by loading the YAML file
-    async init() {
-        const fileName = fileURLToPath(import.meta.url);
-        const dirName = dirname(fileName);
-        try {
-            const fileContents = await readFile(join(dirName, 'rate-limits.yml'), 'utf8');            
-            this.#defaultRateLimitMap = parse(fileContents);
-        } catch (error) {
-            this.#defaultRateLimitMap = {};
-            throw new error('Error loading rate-limits.yml:', error);
-        }
+        this.#defaultRateLimitMap = defaultRateLimitMap;
     }
 
     getLimit(operation) {
@@ -40,20 +23,4 @@ export class DefaultRateLimitFetcher {
         }
         return 1;
     }
-
-    // Singleton implementation
-    static #instance = null;
-
-    static async create() {
-        const instance = new DefaultRateLimitFetcher();
-        await instance.init();
-        return instance;
-    }
-
-    static async getInstance() {
-        if (!DefaultRateLimitFetcher.#instance) {
-            DefaultRateLimitFetcher.#instance = await DefaultRateLimitFetcher.create();
-        }
-        return DefaultRateLimitFetcher.#instance;
-    }
 }

package/helper/DefaultRateLimitMap.mjs

@@ -0,0 +1,266 @@
+export const defaultRateLimitMap = {
+  "AwdApi-getInboundShipment": [2, 2],
+  "AwdApi-listInboundShipments": [1, 1],
+  "AwdApi-listInventory": [2, 2],
+  "AwdApi-createInbound": [1, 1],
+  "AwdApi-getInbound": [2, 2],
+  "AwdApi-updateInbound": [1, 1],
+  "AwdApi-cancelInbound": [1, 1],
+  "AwdApi-confirmInbound": [1, 1],
+  "AwdApi-getInboundShipmentLabels": [1, 2],
+  "AwdApi-updateInboundShipmentTransportDetails": [1, 1],
+  "AwdApi-checkInboundEligibility": [1, 1],
+  "AplusContentApi-searchContentDocuments": [5, 5],
+  "AplusContentApi-createContentDocument": [5, 5],
+  "AplusContentApi-getContentDocument": [5, 5],
+  "AplusContentApi-updateContentDocument": [5, 5],
+  "AplusContentApi-listContentDocumentAsinRelations": [5, 5],
+  "AplusContentApi-postContentDocumentAsinRelations": [5, 5],
+  "AplusContentApi-validateContentDocumentAsinRelations": [5, 5],
+  "AplusContentApi-searchContentPublishRecords": [5, 5],
+  "AplusContentApi-postContentDocumentApprovalSubmission": [5, 5],
+  "AplusContentApi-postContentDocumentSuspendSubmission": [5, 5],
+  "AppIntegrationsApi-createNotification": [1, 5],
+  "AppIntegrationsApi-deleteNotifications": [1, 5],
+  "AppIntegrationsApi-recordActionFeedback": [1, 5],
+  "ApplicationsApi-rotateApplicationClientSecret": [1, 1, 60],
+  "CatalogApi-getCatalogItem": [2, 2],
+  "CatalogApi-searchCatalogItems": [2, 2],
+  "QueriesApi-getQueries": [1, 15, 60],
+  "QueriesApi-createQuery": [1, 15, 60],
+  "QueriesApi-getQuery": [2, 15],
+  "QueriesApi-cancelQuery": [2, 15],
+  "QueriesApi-getDocument": [1, 15, 60],
+  "EasyShip-listHandoverSlots": [1, 5],
+  "EasyShip-getScheduledPackage": [1, 5],
+  "EasyShip-createScheduledPackage": [1, 5],
+  "EasyShip-updateScheduledPackages": [1, 5],
+  "EasyShip-createScheduledPackageBulk": [1, 5],
+  "FbaInboundApi-getItemEligibilityPreview": [1, 1],
+  "FbaInventoryApi-getInventorySummaries": [2, 2],
+  "FbaInventoryApi-createInventoryItem": [2, 3],
+  "FbaInventoryApi-deleteInventoryItem": [2, 3],
+  "FbaInventoryApi-addInventory": [2, 3],
+  "FeedsApi-cancelFeed": [2, 15],
+  "FeedsApi-createFeed": [1, 15, 120],
+  "FeedsApi-createFeedDocument": [1, 15, 2],
+  "FeedsApi-getFeed": [2, 15],
+  "FeedsApi-getFeeds": [1, 10, 45],
+  "FeedsApi-getFeedDocument": [1, 10, 45],
+  "DefaultApi-listFinancialEventGroups": [1, 30, 2],
+  "DefaultApi-listFinancialEventsByGroupId": [1, 30, 2],
+  "DefaultApi-listFinancialEventsByOrderId": [1, 30, 2],
+  "DefaultApi-listFinancialEvents": [1, 30, 2],
+  "DefaultApi-initiatePayout": [1, 2, 60],
+  "DefaultApi-getPaymentMethods": [1, 30, 2],
+  "FbaInboundApi-getPrepInstructions": [2, 30],
+  "FbaInboundApi-getLabels": [2, 30],
+  "FbaInboundApi-getBillOfLading": [2, 30],
+  "FbaInboundApi-getShipments": [2, 30],
+  "FbaInboundApi-getShipmentItemsByShipmentId": [2, 30],
+  "FbaInboundApi-getShipmentItems": [2, 30],
+  "FbaInboundApi-listInboundPlans": [2, 6],
+  "FbaInboundApi-createInboundPlan": [2, 2],
+  "FbaInboundApi-getInboundPlan": [2, 6],
+  "FbaInboundApi-listInboundPlanBoxes": [2, 6],
+  "FbaInboundApi-cancelInboundPlan": [2, 2],
+  "FbaInboundApi-listInboundPlanItems": [2, 6],
+  "FbaInboundApi-updateInboundPlanName": [2, 30],
+  "FbaInboundApi-listPackingGroupBoxes": [2, 30],
+  "FbaInboundApi-listPackingGroupItems": [2, 30],
+  "FbaInboundApi-setPackingInformation": [2, 2],
+  "FbaInboundApi-listPackingOptions": [2, 6],
+  "FbaInboundApi-generatePackingOptions": [2, 2],
+  "FbaInboundApi-confirmPackingOption": [2, 2],
+  "FbaInboundApi-listInboundPlanPallets": [2, 6],
+  "FbaInboundApi-listPlacementOptions": [2, 6],
+  "FbaInboundApi-generatePlacementOptions": [2, 2],
+  "FbaInboundApi-confirmPlacementOption": [2, 2],
+  "FbaInboundApi-getShipment": [2, 6],
+  "FbaInboundApi-listShipmentBoxes": [2, 30],
+  "FbaInboundApi-listShipmentContentUpdatePreviews": [2, 30],
+  "FbaInboundApi-generateShipmentContentUpdatePreviews": [2, 30],
+  "FbaInboundApi-getShipmentContentUpdatePreview": [2, 30],
+  "FbaInboundApi-confirmShipmentContentUpdatePreview": [2, 30],
+  "FbaInboundApi-getDeliveryChallanDocument": [2, 6],
+  "FbaInboundApi-listDeliveryWindowOptions": [2, 30],
+  "FbaInboundApi-generateDeliveryWindowOptions": [2, 30],
+  "FbaInboundApi-confirmDeliveryWindowOptions": [2, 30],
+  "FbaInboundApi-listShipmentItems": [2, 30],
+  "FbaInboundApi-updateShipmentName": [2, 30],
+  "FbaInboundApi-listShipmentPallets": [2, 30],
+  "FbaInboundApi-cancelSelfShipAppointment": [2, 30],
+  "FbaInboundApi-getSelfShipAppointmentSlots": [2, 6],
+  "FbaInboundApi-generateSelfShipAppointmentSlots": [2, 2],
+  "FbaInboundApi-scheduleSelfShipAppointment": [2, 2],
+  "FbaInboundApi-updateShipmentSourceAddress": [2, 30],
+  "FbaInboundApi-updateShipmentTrackingDetails": [2, 2],
+  "FbaInboundApi-listTransportationOptions": [2, 6],
+  "FbaInboundApi-generateTransportationOptions": [2, 2],
+  "FbaInboundApi-confirmTransportationOptions": [2, 2],
+  "FbaInboundApi-listItemComplianceDetails": [2, 6],
+  "FbaInboundApi-updateItemComplianceDetails": [2, 2],
+  "FbaInboundApi-createMarketplaceItemLabels": [2, 30],
+  "FbaInboundApi-listPrepDetails": [2, 30],
+  "FbaInboundApi-setPrepDetails": [2, 30],
+  "FbaInboundApi-getInboundOperationStatus": [2, 6],
+  "FbaOutboundApi-getFulfillmentPreview": [2, 30],
+  "FbaOutboundApi-deliveryOffers": [10, 30],
+  "FbaOutboundApi-listAllFulfillmentOrders": [2, 30],
+  "FbaOutboundApi-createFulfillmentOrder": [2, 30],
+  "FbaOutboundApi-getPackageTrackingDetails": [2, 30],
+  "FbaOutboundApi-listReturnReasonCodes": [2, 30],
+  "FbaOutboundApi-createFulfillmentReturn": [2, 30],
+  "FbaOutboundApi-getFulfillmentOrder": [2, 30],
+  "FbaOutboundApi-updateFulfillmentOrder": [2, 30],
+  "FbaOutboundApi-cancelFulfillmentOrder": [2, 30],
+  "FbaOutboundApi-submitFulfillmentOrderStatusUpdate": [1, 1],
+  "FbaOutboundApi-getFeatures": [2, 30],
+  "FbaOutboundApi-getFeatureInventory": [2, 30],
+  "FbaOutboundApi-getFeatureSKU": [2, 30],
+  "InvoicesApi-getInvoicesAttributes": [1, 1],
+  "InvoicesApi-getInvoicesDocument": [1, 1, 60],
+  "InvoicesApi-createInvoicesExport": [1, 1, 60],
+  "InvoicesApi-getInvoicesExports": [1, 20, 10],
+  "InvoicesApi-getInvoicesExport": [2, 15],
+  "InvoicesApi-getInvoices": [1, 20, 10],
+  "InvoicesApi-getInvoice": [2, 15],
+  "ListingsApi-deleteListingsItem": [5, 5],
+  "ListingsApi-getListingsItem": [5, 5],
+  "ListingsApi-patchListingsItem": [5, 5],
+  "ListingsApi-putListingsItem": [5, 5],
+  "ListingsApi-searchListingsItems": [5, 5],
+  "ListingsApi-getListingsRestrictions": [5, 10],
+  "MerchantFulfillmentApi-getEligibleShipmentServices": [6, 12],
+  "MerchantFulfillmentApi-getShipment": [5, 10],
+  "MerchantFulfillmentApi-cancelShipment": [5, 10],
+  "MerchantFulfillmentApi-createShipment": [5, 10],
+  "MerchantFulfillmentApi-getAdditionalSellerInputs": [5, 10],
+  "MessagingApi-getMessagingActionsForOrder": [1, 5],
+  "MessagingApi-confirmCustomizationDetails": [1, 5],
+  "MessagingApi-createConfirmDeliveryDetails": [1, 5],
+  "MessagingApi-createLegalDisclosure": [1, 5],
+  "MessagingApi-createNegativeFeedbackRemoval": [1, 5],
+  "MessagingApi-createConfirmOrderDetails": [1, 5],
+  "MessagingApi-createConfirmServiceDetails": [1, 5],
+  "MessagingApi-CreateAmazonMotors": [1, 5],
+  "MessagingApi-CreateWarranty": [1, 5],
+  "MessagingApi-GetAttributes": [1, 5],
+  "MessagingApi-createDigitalAccessKey": [1, 5],
+  "MessagingApi-createUnexpectedProblem": [1, 5],
+  "MessagingApi-sendInvoice": [1, 5],
+  "NotificationsApi-getSubscription": [1, 5],
+  "NotificationsApi-createSubscription": [1, 5],
+  "NotificationsApi-getSubscriptionById": [1, 5],
+  "NotificationsApi-deleteSubscriptionById": [1, 5],
+  "NotificationsApi-getDestinations": [1, 5],
+  "NotificationsApi-createDestination": [1, 5],
+  "NotificationsApi-getDestination": [1, 5],
+  "NotificationsApi-deleteDestination": [1, 5],
+  "OrdersV0Api-confirmShipment": [2, 10],
+  "OrdersV0Api-getOrder": [1, 30, 2],
+  "OrdersV0Api-getOrderAddress": [1, 30, 2],
+  "OrdersV0Api-getOrderBuyerInfo": [1, 30, 2],
+  "OrdersV0Api-getOrderItems": [1, 30, 2],
+  "OrdersV0Api-getOrderItemsBuyerInfo": [1, 30, 2],
+  "OrdersV0Api-getOrderRegulatedInfo": [1, 30, 2],
+  "OrdersV0Api-getOrders": [1, 20, 60],
+  "ShipmentApi-updateShipmentStatus": [5, 15],
+  "OrdersV0Api-updateVerificationStatus": [1, 30, 2],
+  "FeesApi-getMyFeesEstimateForSKU": [1, 2],
+  "FeesApi-getMyFeesEstimateForASIN": [1, 2],
+  "FeesApi-getMyFeesEstimates": [1, 1, 2],
+  "ProductPricingApi-getFeaturedOfferExpectedPriceBatch": [1, 1, 30],
+  "ProductPricingApi-getCompetitiveSummary": [1, 1, 30],
+  "ProductPricingApi-getPricing": [1, 1, 2],
+  "ProductPricingApi-getCompetitivePricing": [1, 1, 2],
+  "ProductPricingApi-getListingOffers": [1, 2],
+  "ProductPricingApi-getItemOffers": [1, 1, 2],
+  "ProductPricingApi-getItemOffersBatch": [1, 1, 10],
+  "ProductPricingApi-getListingOffersBatch": [1, 1, 2],
+  "DefinitionsApi-getDefinitionsProductType": [5, 5],
+  "DefinitionsApi-searchDefinitionsProductTypes": [5, 5],
+  "SellingpartnersApi-getSellingPartnerMetrics": [1, 1],
+  "OffersApi-listOfferMetrics": [1, 1],
+  "OffersApi-listOffers": [1, 1],
+  "ReportsApi-getReports": [1, 10, 45],
+  "ReportsApi-createReport": [1, 15, 60],
+  "ReportsApi-cancelReport": [1, 10, 45],
+  "ReportsApi-getReport": [2, 15],
+  "ReportsApi-getReportSchedules": [1, 10, 45],
+  "ReportsApi-createReportSchedule": [1, 10, 45],
+  "ReportsApi-cancelReportSchedule": [1, 10, 45],
+  "ReportsApi-getReportSchedule": [1, 10, 45],
+  "ReportsApi-getReportDocument": [1, 15, 60],
+  "SalesApi-getOrderMetrics": [1, 15, 2],
+  "SellersApi-getMarketplaceParticipations": [1, 15, 60],
+  "SellersApi-getAccount": [1, 30, 2],
+  "ServiceApi-getServiceJobByServiceJobId": [20, 40],
+  "ServiceApi-cancelServiceJobByServiceJobId": [5, 20],
+  "ServiceApi-completeServiceJobByServiceJobId": [5, 20],
+  "ServiceApi-getServiceJobs": [10, 40],
+  "ServiceApi-addAppointmentForServiceJobByServiceJobId": [5, 20],
+  "ServiceApi-rescheduleAppointmentForServiceJobByServiceJobId": [5, 20],
+  "ServiceApi-assignAppointmentResources": [5, 20],
+  "ServiceApi-setAppointmentFulfillmentData": [5, 20],
+  "ServiceApi-getRangeSlotCapacity": [5, 20],
+  "ServiceApi-getFixedSlotCapacity": [5, 20],
+  "ServiceApi-updateSchedule": [5, 20],
+  "ServiceApi-createReservation": [5, 20],
+  "ServiceApi-updateReservation": [5, 20],
+  "ServiceApi-cancelReservation": [5, 20],
+  "ServiceApi-getAppointmmentSlotsByJobId": [5, 20],
+  "ServiceApi-getAppointmentSlots": [5, 20],
+  "ServiceApi-createServiceDocumentUploadDestination": [5, 20],
+  "ShipmentInvoiceApi-getShipmentDetails": [1.133, 25],
+  "ShipmentInvoiceApi-submitInvoice": [1.133, 25],
+  "ShipmentInvoiceApi-getInvoiceStatus": [1.133, 25],
+  "ShippingApi-createShipment": [5, 15],
+  "ShippingApi-getShipment": [5, 15],
+  "ShippingApi-cancelShipment": [5, 15],
+  "ShippingApi-purchaseLabels": [5, 15],
+  "ShippingApi-retrieveShippingLabel": [5, 15],
+  "ShippingApi-purchaseShipment": [5, 15],
+  "ShippingApi-getRates": [5, 15],
+  "ShippingApi-getAccount": [5, 15],
+  "ShippingApi-getTrackingInformation": [1, 1],
+  "SolicitationsApi-getSolicitationActionsForOrder": [1, 5],
+  "SolicitationsApi-createProductReviewAndSellerFeedbackSolicitation": [1, 5],
+  "SupplySourcesApi-getSupplySources": [10, 10],
+  "SupplySourcesApi-createSupplySource": [2, 2],
+  "SupplySourcesApi-getSupplySource": [40, 40],
+  "SupplySourcesApi-updateSupplySource": [1, 1],
+  "SupplySourcesApi-archiveSupplySource": [20, 20],
+  "SupplySourcesApi-updateSupplySourceStatus": [20, 20],
+  "TokensApi-createRestrictedDataToken": [1, 10],
+  "UploadsApi-createUploadDestinationForResource": [5, 5],
+  "AutomotiveApi-getVehicles": [20, 5],
+  "VehiclesApi-getVehicles": [20, 5],
+  "UpdateInventoryApi-submitInventoryUpdate": [10, 10],
+  "VendorOrdersApi-getOrders": [10, 10],
+  "VendorOrdersApi-getOrder": [10, 10],
+  "VendorOrdersApi-submitAcknowledgement": [10, 10],
+  "VendorInvoiceApi-submitInvoice": [10, 10],
+  "VendorShippingLabelsApi-getShippingLabels": [10, 10],
+  "VendorShippingLabelsApi-submitShippingLabelRequest": [10, 10],
+  "VendorShippingLabelsApi-getShippingLabel": [10, 10],
+  "VendorShippingLabelsApi-createShippingLabels": [10, 10],
+  "VendorShippingApi-submitShipmentConfirmations": [10, 10],
+  "VendorShippingApi-submitShipmentStatusUpdates": [10, 10],
+  "CustomerInvoicesApi-getCustomerInvoices": [10, 10],
+  "CustomerInvoicesApi-getCustomerInvoice": [10, 10],
+  "VendorShippingApi-getPackingSlips": [10, 10],
+  "VendorShippingApi-getPackingSlip": [10, 10],
+  "CreateContainerLabelApi-createContainerLabel": [10, 10],
+  "VendorTransactionsApi-getTransactionStatus": [10, 10],
+  "VendorPaymentsApi-submitInvoices": [10, 10],
+  "VendorOrdersApi-getPurchaseOrders": [10, 10],
+  "VendorOrdersApi-getPurchaseOrder": [10, 10],
+  "VendorOrdersApi-getPurchaseOrdersStatus": [10, 10],
+  "VendorShippingApi-SubmitShipmentConfirmations": [10, 10],
+  "VendorShippingApi-SubmitShipments": [10, 10],
+  "VendorShippingApi-GetShipmentDetails": [10, 10],
+  "VendorShippingApi-GetShipmentLabels": [10, 10],
+  "VendorTransactionApi-getTransaction": [10, 10]
+}
+

package/helper/SuperagentRateLimiter.mjs

@@ -1,5 +1,5 @@
 import Bottleneck from 'bottleneck';
-import { RateLimitConfiguration } from "./RateLimitConfiguration.mjs";
+import { RateLimitConfiguration } from './RateLimitConfiguration.mjs';
 
 export class SuperagentRateLimiter {
     /** @type {Bottleneck} */
@@ -22,9 +22,12 @@ export class SuperagentRateLimiter {
 
         this.#limiter = new Bottleneck({
             reservoir: burstRequests,  // Initial capacity
-            reservoirRefreshAmount: refreshAmount, // How many tokens to add during each refresh
-            reservoirRefreshInterval: refreshInterval, // Refresh interval in milliseconds
-            maxConcurrent: burstRequests // Maximum number of requests running at the same time
+            reservoirIncreaseAmount: refreshAmount, // How many tokens to increase during each refresh
+            reservoirIncreaseInterval: refreshInterval, // increase interval in milliseconds
+            reservoirIncreaseMaximum: burstRequests, // maximum token bucket size
+            maxConcurrent: burstRequests, // Maximum number of requests running at the same time
+            highWater: 0,
+            strategy: Bottleneck.strategy.BLOCK, // Block requests when rate limit reached
         });
           
     }
@@ -35,17 +38,26 @@ export class SuperagentRateLimiter {
      */
     getPlugin() {
         return (request) => {
-            // Add rate limiting before the request is sent
-            request.on('request', async () => {
-                try {
-                    // Schedule the request
-                    await this.#limiter.schedule(async () => {
-                        return Promise.resolve();
-                    });
-                } catch (error) {
-                    throw new Error(`Rate limit exceed error: ${error.message}`);
-                }
+            // Create a promise that must resolve before the request is sent
+            const rateLimitPromise = new Promise((resolve, reject) => {
+                this.#limiter.schedule(async () => {
+                    resolve();
+                }).catch(error => {
+                    reject(new Error(`Rate limit exceed error: ${error.message}`));
+                });
             });
+
+            // Modify the request to wait for rate limiting
+            const originalEnd = request.end;
+            request.end = function (fn) {
+                rateLimitPromise
+                    .then(() => {
+                        originalEnd.call(request, fn);
+                    })
+                    .catch(error => {
+                        fn(error);
+                    });
+            };
         };
     }
 }

package/package.json

@@ -4,7 +4,7 @@
   "license": "Apache License 2.0",
   "main": "./index.js",
   "type": "module",
-  "version": "1.0.0-rc8",
+  "version": "1.0.0",
   "scripts": {
     "test": "echo \"No test specified\" && exit 1"
   },

package/sample-node-app/index.js

@@ -18,8 +18,9 @@ async function getMarketplaceParticipations() {
   try {
       //Configure Sellers ApiClient
       const sellersApiClient = new SellersSpApi.ApiClient(AppConfig.spApiNAEndpoint);
-      sellersApiClient.enableAutoRetrievalAccessToken(AppConfig.lwaClientId, AppConfig.lwaClientSecret, AppConfig.lwaRefreshToken, null);
       const sellersApi = new SellersSpApi.SellersApi(sellersApiClient);
+
+      sellersApiClient.enableAutoRetrievalAccessToken(AppConfig.lwaClientId, AppConfig.lwaClientSecret, AppConfig.lwaRefreshToken, null);
       
       //Call GetMarkerplaceParticipations API
       const participations = await sellersApi.getMarketplaceParticipations();
@@ -41,10 +42,11 @@ async function getMarketplaceParticipations() {
 */
 async function createDestination() {
   try {
-    //Configure Notifications ApiClient
+    //Configure Notifications ApiClient and notification Api
     const notificationsApiClient = new NotificationsSpApi.ApiClient(AppConfig.spApiNAEndpoint);
-    notificationsApiClient.enableAutoRetrievalAccessToken(AppConfig.lwaClientId, AppConfig.lwaClientSecret, null, ScopeConstants.SCOPE_NOTIFICATION_API);
     const notificationsApi = new NotificationsSpApi.NotificationsApi(notificationsApiClient);
+
+    notificationsApiClient.enableAutoRetrievalAccessToken(AppConfig.lwaClientId, AppConfig.lwaClientSecret, null, ScopeConstants.SCOPE_NOTIFICATION_API);
     
     //Build createDestination request
     const sqsResource = new NotificationsSpApi.SqsResource('<REPLACE_WITH_YOUR_SQS_QUEUE_ARN>');
@@ -74,12 +76,13 @@ async function getOrders() {
       //Set up LwaAuthClient instance
       const lwaAuthClient = new LwaAuthClient(AppConfig.lwaClientId, AppConfig.lwaClientSecret, AppConfig.lwaRefreshToken, null);
 
-      //Configure Orders ApiClient
+      //Configure Orders ApiClient and Order Api instance
       const ordersApiClient = new OrdersSpApi.ApiClient(AppConfig.spApiNAEndpoint);
+      const ordersApi = new OrdersSpApi.OrdersV0Api(ordersApiClient);
+
       ordersApiClient.applyXAmzAccessTokenToRequest(
         await lwaAuthClient.getAccessToken()
       );
-      const ordersApi = new OrdersSpApi.OrdersV0Api(ordersApiClient);
       
       //Call GetOrders API
       const marketPlaceIds = ['ATVPDKIKX0DER'];
@@ -99,23 +102,34 @@ async function getOrders() {
 
 /**
  * We support a built in rate limiter.
- * Here is a sample SDK usage of calling Orders listTransactions API with a rate limiter and retry logic.
+ * Here is a sample SDK usage of calling Orders getOrders API with a rate limiter and retry logic.
  */
-async function getOrdersWithRateLimiterAndRetry(rateLimitPermit, waitTimeOutInMilliSeconds, burstRequests, retryCount) {
+async function getOrdersWithRateLimiterAndRetry(retryCount) {
   const ordersApiClient = new OrdersSpApi.ApiClient(AppConfig.spApiNAEndpoint);
+  const ordersApi = new OrdersSpApi.OrdersV0Api(ordersApiClient);
+
   ordersApiClient.enableAutoRetrievalAccessToken(AppConfig.lwaClientId, AppConfig.lwaClientSecret, AppConfig.lwaRefreshToken);
 
-  // Option1: Use our default rate limiter. Our rate limiter uses the rate limit and burst values in our official document.
-  ordersApiClient.enableDefaultRateLimiter();
+  /**
+   * [Recommended] Option1: Use our default rate limiter. Our rate limiter uses the rate limit and burst values in our official document.
+   * It is turned on by default.
+   * /
+
+  /**
+   * Option2: Use your customized rate limiter, you need to replace <RateLimit> and <BurstValue> with actual numbers.
+   * Then call setCustomizedRateLimiterForOperation(), please refer to helper/rate-limit.yml when specifying operation name.
+   * Note that for other operations that you did not configure customized rate limiter, they still use default rate limiter.
+   */
 
-  // Option2: Use your customized rate limiter, you need to replace <RateLimit> and <BurstValue> with actual numbers.
   // const rateLimitConfig = new RateLimitConfiguration(<RateLimit>, <BurstValue>);
-  // ordersApiClient.enableCustomizedRateLimiter(rateLimitConfig);
+  // ordersApiClient.setCustomizedRateLimiterForOperation('OrdersV0Api-getOrders', rateLimitConfig);
+
+  /**
+   * [For dynamic usage plan APIs] Option3: Disable rate limiter. By calling this function, you are disabling both default and customized rate limiter.
+   */
 
-  // Option3: Disable rate limit
   // ordersApiClient.disableRatelimiter();
 
-  const ordersApi = new OrdersSpApi.OrdersV0Api(ordersApiClient);
   const marketPlaceIds = ['ATVPDKIKX0DER'];
   const opts = {
     createdAfter: '2024-01-01'

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