@sp-api-sdk/shipping-api-v1 1.6.19 → 1.6.20

package/README.md

@@ -2,6 +2,12 @@
 
 Provides programmatic access to Amazon Shipping APIs.
 
+## Documentation
+
+Learn more about this Selling Partner API by visiting the [official documentation](https://github.com/amzn/selling-partner-api-docs/tree/main/references/shipping-api/shipping.md).
+
+Also, see the [generated documentation](https://bizon.github.io/selling-partner-api-sdk/modules/_sp_api_sdk_shipping_api_v1.html) for this API client.
+
 ## Installing
 
 ```sh
@@ -19,26 +25,25 @@ import {SellingPartnerApiAuth} from '@sp-api-sdk/auth'
 import {ShippingApiClient} from '@sp-api-sdk/shipping-api-v1'
 
 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 ShippingApiClient({
   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 ShippingApiClient({
@@ -46,13 +51,28 @@ const client = new ShippingApiClient({
   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/shipping-api/shipping.md)).
+
+## License
+
+MIT
 
-## API documentation
+## Miscellaneous
 
-See [here](https://github.com/amzn/selling-partner-api-docs/tree/main/references/shipping-api/shipping.md)
+```
+    ╚⊙ ⊙╝
+  ╚═(███)═╝
+ ╚═(███)═╝
+╚═(███)═╝
+ ╚═(███)═╝
+  ╚═(███)═╝
+   ╚═(███)═╝
+```

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

@@ -375,7 +375,7 @@ export declare class ShippingApi extends BaseAPI {
      * @throws {RequiredError}
      * @memberof ShippingApi
      */
-    cancelShipment(requestParameters: ShippingApiCancelShipmentRequest, options?: any): Promise<import("axios").AxiosResponse<CancelShipmentResponse>>;
+    cancelShipment(requestParameters: ShippingApiCancelShipmentRequest, options?: any): Promise<import("axios").AxiosResponse<CancelShipmentResponse, any>>;
     /**
      * Create a new shipment.  **Usage Plan:**  | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 15 |  For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
      * @param {ShippingApiCreateShipmentRequest} requestParameters Request parameters.
@@ -383,14 +383,14 @@ export declare class ShippingApi extends BaseAPI {
      * @throws {RequiredError}
      * @memberof ShippingApi
      */
-    createShipment(requestParameters: ShippingApiCreateShipmentRequest, options?: any): Promise<import("axios").AxiosResponse<CreateShipmentResponse>>;
+    createShipment(requestParameters: ShippingApiCreateShipmentRequest, options?: any): Promise<import("axios").AxiosResponse<CreateShipmentResponse, any>>;
     /**
      * Verify if the current account is valid.  **Usage Plan:**  | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 15 |  For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof ShippingApi
      */
-    getAccount(options?: any): Promise<import("axios").AxiosResponse<GetAccountResponse>>;
+    getAccount(options?: any): Promise<import("axios").AxiosResponse<GetAccountResponse, any>>;
     /**
      * Get service rates.  **Usage Plan:**  | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 15 |  For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
      * @param {ShippingApiGetRatesRequest} requestParameters Request parameters.
@@ -398,7 +398,7 @@ export declare class ShippingApi extends BaseAPI {
      * @throws {RequiredError}
      * @memberof ShippingApi
      */
-    getRates(requestParameters: ShippingApiGetRatesRequest, options?: any): Promise<import("axios").AxiosResponse<GetRatesResponse>>;
+    getRates(requestParameters: ShippingApiGetRatesRequest, options?: any): Promise<import("axios").AxiosResponse<GetRatesResponse, any>>;
     /**
      * Return the entire shipment object for the shipmentId.  **Usage Plan:**  | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 15 |  For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
      * @param {ShippingApiGetShipmentRequest} requestParameters Request parameters.
@@ -406,7 +406,7 @@ export declare class ShippingApi extends BaseAPI {
      * @throws {RequiredError}
      * @memberof ShippingApi
      */
-    getShipment(requestParameters: ShippingApiGetShipmentRequest, options?: any): Promise<import("axios").AxiosResponse<GetShipmentResponse>>;
+    getShipment(requestParameters: ShippingApiGetShipmentRequest, options?: any): Promise<import("axios").AxiosResponse<GetShipmentResponse, any>>;
     /**
      * Return the tracking information of a shipment.  **Usage Plan:**  | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 |  For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
      * @param {ShippingApiGetTrackingInformationRequest} requestParameters Request parameters.
@@ -414,7 +414,7 @@ export declare class ShippingApi extends BaseAPI {
      * @throws {RequiredError}
      * @memberof ShippingApi
      */
-    getTrackingInformation(requestParameters: ShippingApiGetTrackingInformationRequest, options?: any): Promise<import("axios").AxiosResponse<GetTrackingInformationResponse>>;
+    getTrackingInformation(requestParameters: ShippingApiGetTrackingInformationRequest, options?: any): Promise<import("axios").AxiosResponse<GetTrackingInformationResponse, any>>;
     /**
      * Purchase shipping labels based on a given rate.  **Usage Plan:**  | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 15 |  For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
      * @param {ShippingApiPurchaseLabelsRequest} requestParameters Request parameters.
@@ -422,7 +422,7 @@ export declare class ShippingApi extends BaseAPI {
      * @throws {RequiredError}
      * @memberof ShippingApi
      */
-    purchaseLabels(requestParameters: ShippingApiPurchaseLabelsRequest, options?: any): Promise<import("axios").AxiosResponse<PurchaseLabelsResponse>>;
+    purchaseLabels(requestParameters: ShippingApiPurchaseLabelsRequest, options?: any): Promise<import("axios").AxiosResponse<PurchaseLabelsResponse, any>>;
     /**
      * Purchase shipping labels.  **Usage Plan:**  | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 15 |  For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
      * @param {ShippingApiPurchaseShipmentRequest} requestParameters Request parameters.
@@ -430,7 +430,7 @@ export declare class ShippingApi extends BaseAPI {
      * @throws {RequiredError}
      * @memberof ShippingApi
      */
-    purchaseShipment(requestParameters: ShippingApiPurchaseShipmentRequest, options?: any): Promise<import("axios").AxiosResponse<PurchaseShipmentResponse>>;
+    purchaseShipment(requestParameters: ShippingApiPurchaseShipmentRequest, options?: any): Promise<import("axios").AxiosResponse<PurchaseShipmentResponse, any>>;
     /**
      * Retrieve shipping label based on the shipment id and tracking id.  **Usage Plan:**  | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 15 |  For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
      * @param {ShippingApiRetrieveShippingLabelRequest} requestParameters Request parameters.
@@ -438,5 +438,5 @@ export declare class ShippingApi extends BaseAPI {
      * @throws {RequiredError}
      * @memberof ShippingApi
      */
-    retrieveShippingLabel(requestParameters: ShippingApiRetrieveShippingLabelRequest, options?: any): Promise<import("axios").AxiosResponse<RetrieveShippingLabelResponse>>;
+    retrieveShippingLabel(requestParameters: ShippingApiRetrieveShippingLabelRequest, options?: any): Promise<import("axios").AxiosResponse<RetrieveShippingLabelResponse, 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 { ShippingApi } 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 ShippingApiClient extends ShippingApi {

package/package.json

@@ -2,7 +2,7 @@
   "name": "@sp-api-sdk/shipping-api-v1",
   "author": "Vincent Mesquita <vincent.mesquita@bizon.solutions>",
   "description": "Provides programmatic access to Amazon Shipping APIs.",
-  "version": "1.6.19",
+  "version": "1.6.20",
   "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",
     "shipping api"
   ],
-  "gitHead": "5dbdf09e0f74182eaa9b6c5f9ef0c931b0aa3089"
+  "gitHead": "e8c21d7d481263e8a6663ee11f6708d4dc6968b6"
 }