@sp-api-sdk/fulfillment-outbound-api-2020-07-01 1.7.1 → 1.7.2

package/README.md

@@ -2,6 +2,12 @@
 
 The Selling Partner API for Fulfillment Outbound lets you create applications that help a seller fulfill Multi-Channel Fulfillment orders using their inventory in Amazon's fulfillment network. You can get information on both potential and existing fulfillment orders.
 
+## Documentation
+
+Learn more about this Selling Partner API by visiting the [official documentation](https://github.com/amzn/selling-partner-api-docs/tree/main/references/fulfillment-outbound-api/fulfillmentOutbound_2020-07-01.md).
+
+Also, see the [generated documentation](https://bizon.github.io/selling-partner-api-sdk/modules/_sp_api_sdk_fulfillment_outbound_api_2020_07_01.html) for this API client.
+
 ## Installing
 
 ```sh
@@ -19,26 +25,25 @@ import {SellingPartnerApiAuth} from '@sp-api-sdk/auth'
 import {FulfillmentOutboundApiClient} from '@sp-api-sdk/fulfillment-outbound-api-2020-07-01'
 
 const auth = new SellingPartnerApiAuth({
-  clientId: '',
-  clientSecret: '',
-  refreshToken: '',
-  secretAccessKey: '',
+  clientId: process.env.LWA_CLIENT_ID,
+  clientSecret: process.env.LWA_CLIENT_SECRET,
+  refreshToken: 'Atzr|…',
   accessKeyId: '',
-  region: '',
+  secretAccessKey: '',
   role: {
-    arn: '',
-  }
+    arn: 'arn:aws:iam::…',
+  },
 })
 
 const client = new FulfillmentOutboundApiClient({
   auth,
-  region: 'eu' // or 'eu-west-1'
+  region: 'eu',
 })
 ```
 
-## Handle Rate Limiting
+## Rate Limiting
 
-If you want to let the SDK retry after each 429 responses, instanciate the client like this:
+In order to retry rate limited requests (HTTP 429), you can configure the API client as such:
 
 ```javascript
 const client = new FulfillmentOutboundApiClient({
@@ -46,13 +51,28 @@ const client = new FulfillmentOutboundApiClient({
   region: 'eu',
   rateLimiting: {
     retry: true,
-    onRetry: (retryInfo) => console.log(retryInfo) // Optional
-  }
+    // Optionally specify a callback that will be called on every retry.
+    onRetry: (retryInfo) => {
+      console.log(retryInfo)
+    },
+  },
 })
 ```
 
-The SDK gets the rate limits for each routes from the API documentation
+The rate limits used for each route are specified in the [API documentation]((https://github.com/amzn/selling-partner-api-docs/tree/main/references/fulfillment-outbound-api/fulfillmentOutbound_2020-07-01.md)).
+
+## License
+
+MIT
 
-## API documentation
+## Miscellaneous
 
-See [here](https://github.com/amzn/selling-partner-api-docs/tree/main/references/fulfillment-outbound-api/fulfillmentOutbound_2020-07-01.md)
+```
+    ╚⊙ ⊙╝
+  ╚═(███)═╝
+ ╚═(███)═╝
+╚═(███)═╝
+ ╚═(███)═╝
+  ╚═(███)═╝
+   ╚═(███)═╝
+```

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

@@ -558,7 +558,7 @@ export declare class FbaOutboundApi extends BaseAPI {
      * @throws {RequiredError}
      * @memberof FbaOutboundApi
      */
-    cancelFulfillmentOrder(requestParameters: FbaOutboundApiCancelFulfillmentOrderRequest, options?: any): Promise<import("axios").AxiosResponse<CancelFulfillmentOrderResponse>>;
+    cancelFulfillmentOrder(requestParameters: FbaOutboundApiCancelFulfillmentOrderRequest, options?: any): Promise<import("axios").AxiosResponse<CancelFulfillmentOrderResponse, any>>;
     /**
      * Requests that Amazon ship items from the seller\'s inventory in Amazon\'s fulfillment network to a destination address.  **Usage Plan:**  | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 |  For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
      * @param {FbaOutboundApiCreateFulfillmentOrderRequest} requestParameters Request parameters.
@@ -566,7 +566,7 @@ export declare class FbaOutboundApi extends BaseAPI {
      * @throws {RequiredError}
      * @memberof FbaOutboundApi
      */
-    createFulfillmentOrder(requestParameters: FbaOutboundApiCreateFulfillmentOrderRequest, options?: any): Promise<import("axios").AxiosResponse<CreateFulfillmentOrderResponse>>;
+    createFulfillmentOrder(requestParameters: FbaOutboundApiCreateFulfillmentOrderRequest, options?: any): Promise<import("axios").AxiosResponse<CreateFulfillmentOrderResponse, any>>;
     /**
      * Creates a fulfillment return.   **Usage Plan:**  | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 |  For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
      * @param {FbaOutboundApiCreateFulfillmentReturnRequest} requestParameters Request parameters.
@@ -574,7 +574,7 @@ export declare class FbaOutboundApi extends BaseAPI {
      * @throws {RequiredError}
      * @memberof FbaOutboundApi
      */
-    createFulfillmentReturn(requestParameters: FbaOutboundApiCreateFulfillmentReturnRequest, options?: any): Promise<import("axios").AxiosResponse<CreateFulfillmentReturnResponse>>;
+    createFulfillmentReturn(requestParameters: FbaOutboundApiCreateFulfillmentReturnRequest, options?: any): Promise<import("axios").AxiosResponse<CreateFulfillmentReturnResponse, any>>;
     /**
      * Returns a list of inventory items that are eligible for the fulfillment feature you specify.  **Usage Plan:**  | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 |  For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
      * @param {FbaOutboundApiGetFeatureInventoryRequest} requestParameters Request parameters.
@@ -582,7 +582,7 @@ export declare class FbaOutboundApi extends BaseAPI {
      * @throws {RequiredError}
      * @memberof FbaOutboundApi
      */
-    getFeatureInventory(requestParameters: FbaOutboundApiGetFeatureInventoryRequest, options?: any): Promise<import("axios").AxiosResponse<GetFeatureInventoryResponse>>;
+    getFeatureInventory(requestParameters: FbaOutboundApiGetFeatureInventoryRequest, options?: any): Promise<import("axios").AxiosResponse<GetFeatureInventoryResponse, any>>;
     /**
      * Returns the number of items with the sellerSKU you specify that can have orders fulfilled using the specified feature. Note that if the sellerSKU isn\'t eligible, the response will contain an empty skuInfo object.  **Usage Plan:**  | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 |  For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
      * @param {FbaOutboundApiGetFeatureSKURequest} requestParameters Request parameters.
@@ -590,7 +590,7 @@ export declare class FbaOutboundApi extends BaseAPI {
      * @throws {RequiredError}
      * @memberof FbaOutboundApi
      */
-    getFeatureSKU(requestParameters: FbaOutboundApiGetFeatureSKURequest, options?: any): Promise<import("axios").AxiosResponse<GetFeatureSkuResponse>>;
+    getFeatureSKU(requestParameters: FbaOutboundApiGetFeatureSKURequest, options?: any): Promise<import("axios").AxiosResponse<GetFeatureSkuResponse, any>>;
     /**
      * Returns a list of features available for Multi-Channel Fulfillment orders in the marketplace you specify, and whether the seller for which you made the call is enrolled for each feature.  **Usage Plan:**  | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 |  For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
      * @param {FbaOutboundApiGetFeaturesRequest} requestParameters Request parameters.
@@ -598,7 +598,7 @@ export declare class FbaOutboundApi extends BaseAPI {
      * @throws {RequiredError}
      * @memberof FbaOutboundApi
      */
-    getFeatures(requestParameters: FbaOutboundApiGetFeaturesRequest, options?: any): Promise<import("axios").AxiosResponse<GetFeaturesResponse>>;
+    getFeatures(requestParameters: FbaOutboundApiGetFeaturesRequest, options?: any): Promise<import("axios").AxiosResponse<GetFeaturesResponse, any>>;
     /**
      * Returns the fulfillment order indicated by the specified order identifier.  **Usage Plan:**  | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 |  For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
      * @param {FbaOutboundApiGetFulfillmentOrderRequest} requestParameters Request parameters.
@@ -606,7 +606,7 @@ export declare class FbaOutboundApi extends BaseAPI {
      * @throws {RequiredError}
      * @memberof FbaOutboundApi
      */
-    getFulfillmentOrder(requestParameters: FbaOutboundApiGetFulfillmentOrderRequest, options?: any): Promise<import("axios").AxiosResponse<GetFulfillmentOrderResponse>>;
+    getFulfillmentOrder(requestParameters: FbaOutboundApiGetFulfillmentOrderRequest, options?: any): Promise<import("axios").AxiosResponse<GetFulfillmentOrderResponse, any>>;
     /**
      * Returns a list of fulfillment order previews based on shipping criteria that you specify.  **Usage Plan:**  | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 |  For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
      * @param {FbaOutboundApiGetFulfillmentPreviewRequest} requestParameters Request parameters.
@@ -614,7 +614,7 @@ export declare class FbaOutboundApi extends BaseAPI {
      * @throws {RequiredError}
      * @memberof FbaOutboundApi
      */
-    getFulfillmentPreview(requestParameters: FbaOutboundApiGetFulfillmentPreviewRequest, options?: any): Promise<import("axios").AxiosResponse<GetFulfillmentPreviewResponse>>;
+    getFulfillmentPreview(requestParameters: FbaOutboundApiGetFulfillmentPreviewRequest, options?: any): Promise<import("axios").AxiosResponse<GetFulfillmentPreviewResponse, any>>;
     /**
      * Returns delivery tracking information for a package in an outbound shipment for a Multi-Channel Fulfillment order.  **Usage Plan:**  | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 |  For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
      * @param {FbaOutboundApiGetPackageTrackingDetailsRequest} requestParameters Request parameters.
@@ -622,7 +622,7 @@ export declare class FbaOutboundApi extends BaseAPI {
      * @throws {RequiredError}
      * @memberof FbaOutboundApi
      */
-    getPackageTrackingDetails(requestParameters: FbaOutboundApiGetPackageTrackingDetailsRequest, options?: any): Promise<import("axios").AxiosResponse<GetPackageTrackingDetailsResponse>>;
+    getPackageTrackingDetails(requestParameters: FbaOutboundApiGetPackageTrackingDetailsRequest, options?: any): Promise<import("axios").AxiosResponse<GetPackageTrackingDetailsResponse, any>>;
     /**
      * Returns a list of fulfillment orders fulfilled after (or at) a specified date-time, or indicated by the next token parameter.  **Usage Plan:**  | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 |  For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
      * @param {FbaOutboundApiListAllFulfillmentOrdersRequest} requestParameters Request parameters.
@@ -630,7 +630,7 @@ export declare class FbaOutboundApi extends BaseAPI {
      * @throws {RequiredError}
      * @memberof FbaOutboundApi
      */
-    listAllFulfillmentOrders(requestParameters?: FbaOutboundApiListAllFulfillmentOrdersRequest, options?: any): Promise<import("axios").AxiosResponse<ListAllFulfillmentOrdersResponse>>;
+    listAllFulfillmentOrders(requestParameters?: FbaOutboundApiListAllFulfillmentOrdersRequest, options?: any): Promise<import("axios").AxiosResponse<ListAllFulfillmentOrdersResponse, any>>;
     /**
      * Returns a list of return reason codes for a seller SKU in a given marketplace.  **Usage Plan:**  | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 |  For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
      * @param {FbaOutboundApiListReturnReasonCodesRequest} requestParameters Request parameters.
@@ -638,7 +638,7 @@ export declare class FbaOutboundApi extends BaseAPI {
      * @throws {RequiredError}
      * @memberof FbaOutboundApi
      */
-    listReturnReasonCodes(requestParameters: FbaOutboundApiListReturnReasonCodesRequest, options?: any): Promise<import("axios").AxiosResponse<ListReturnReasonCodesResponse>>;
+    listReturnReasonCodes(requestParameters: FbaOutboundApiListReturnReasonCodesRequest, options?: any): Promise<import("axios").AxiosResponse<ListReturnReasonCodesResponse, any>>;
     /**
      * Updates and/or requests shipment for a fulfillment order with an order hold on it.  **Usage Plan:**  | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 |  For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
      * @param {FbaOutboundApiUpdateFulfillmentOrderRequest} requestParameters Request parameters.
@@ -646,5 +646,5 @@ export declare class FbaOutboundApi extends BaseAPI {
      * @throws {RequiredError}
      * @memberof FbaOutboundApi
      */
-    updateFulfillmentOrder(requestParameters: FbaOutboundApiUpdateFulfillmentOrderRequest, options?: any): Promise<import("axios").AxiosResponse<UpdateFulfillmentOrderResponse>>;
+    updateFulfillmentOrder(requestParameters: FbaOutboundApiUpdateFulfillmentOrderRequest, options?: any): Promise<import("axios").AxiosResponse<UpdateFulfillmentOrderResponse, any>>;
 }

package/dist/types/src/api-model/common.d.ts

@@ -62,4 +62,4 @@ export declare const toPathString: (url: URL) => string;
  *
  * @export
  */
-export declare const createRequestFunction: (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration | undefined) => (axios?: AxiosInstance, basePath?: string) => Promise<import("axios").AxiosResponse<any>>;
+export declare const createRequestFunction: (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration | undefined) => (axios?: AxiosInstance, basePath?: string) => Promise<import("axios").AxiosResponse<any, any>>;

package/dist/types/src/client.d.ts

@@ -1,11 +1,10 @@
-import { onRetry } from '@sp-api-sdk/common';
-import type { ClientConfiguration, RateLimit } from '@sp-api-sdk/common';
+import type { ClientConfiguration, RateLimit, OnRetryHandler } from '@sp-api-sdk/common';
 import { FbaOutboundApi } from './api-model';
 export declare const RATE_LIMITS: RateLimit[];
 export interface ClientParameters extends Omit<ClientConfiguration, 'rateLimits' | 'onRetry'> {
     rateLimiting?: {
         retry: boolean;
-        onRetry?: onRetry;
+        onRetry?: OnRetryHandler;
     };
 }
 export declare class FulfillmentOutboundApiClient extends FbaOutboundApi {

package/package.json

@@ -2,7 +2,7 @@
   "name": "@sp-api-sdk/fulfillment-outbound-api-2020-07-01",
   "author": "Vincent Mesquita <vincent.mesquita@bizon.solutions>",
   "description": "The Selling Partner API for Fulfillment Outbound lets you create applications that help a seller fulfill Multi-Channel Fulfillment orders using their inventory in Amazon's fulfillment network. You can get information on both potential and existing fulfillment orders.",
-  "version": "1.7.1",
+  "version": "1.7.2",
   "main": "dist/cjs/index.js",
   "module": "dist/es/index.js",
   "types": "dist/types/index.d.ts",
@@ -25,9 +25,9 @@
     "test": "NODE_ENV='test' yarn jest"
   },
   "dependencies": {
-    "@sp-api-sdk/auth": "^1.9.4",
-    "@sp-api-sdk/common": "^1.7.6",
-    "axios": "^0.21.1"
+    "@sp-api-sdk/auth": "^1.9.5",
+    "@sp-api-sdk/common": "^1.7.7",
+    "axios": "^0.24.0"
   },
   "repository": {
     "type": "git",
@@ -48,5 +48,5 @@
     "sp sdk",
     "fulfillment outbound api"
   ],
-  "gitHead": "5dbdf09e0f74182eaa9b6c5f9ef0c931b0aa3089"
+  "gitHead": "e8c21d7d481263e8a6663ee11f6708d4dc6968b6"
 }