@sp-api-sdk/shipment-invoicing-api-v0 - npm Package Compare versions

Comparing version 1.8.5 to 1.8.6

dist/types/src/api-model/api/shipment-invoice-api.d.ts

@@ -162,3 +162,3 @@ /**
      */
-    getInvoiceStatus(requestParameters: ShipmentInvoiceApiGetInvoiceStatusRequest, options?: any): Promise<import("axios").AxiosResponse<GetInvoiceStatusResponse>>;
+    getInvoiceStatus(requestParameters: ShipmentInvoiceApiGetInvoiceStatusRequest, options?: any): Promise<import("axios").AxiosResponse<GetInvoiceStatusResponse, any>>;
     /**
@@ -171,3 +171,3 @@ * Returns the shipment details required to issue an invoice for the specified shipment.  **Usage Plans:**  | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 1.133 | 25 | |Selling partner specific| Variable | Variable |  The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
      */
-    getShipmentDetails(requestParameters: ShipmentInvoiceApiGetShipmentDetailsRequest, options?: any): Promise<import("axios").AxiosResponse<GetShipmentDetailsResponse>>;
+    getShipmentDetails(requestParameters: ShipmentInvoiceApiGetShipmentDetailsRequest, options?: any): Promise<import("axios").AxiosResponse<GetShipmentDetailsResponse, any>>;
     /**
@@ -180,3 +180,3 @@ * Submits a shipment invoice document for a given shipment.  **Usage Plans:**  | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 1.133 | 25 | |Selling partner specific| Variable | Variable |  The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
      */
-    submitInvoice(requestParameters: ShipmentInvoiceApiSubmitInvoiceRequest, options?: any): Promise<import("axios").AxiosResponse<SubmitInvoiceResponse>>;
+    submitInvoice(requestParameters: ShipmentInvoiceApiSubmitInvoiceRequest, options?: any): Promise<import("axios").AxiosResponse<SubmitInvoiceResponse, any>>;
 }

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

@@ -65,2 +65,2 @@ /**
  */
-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>>;

dist/types/src/client.d.ts

@@ -1,3 +0,2 @@
-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 { ShipmentInvoiceApi } from './api-model';
@@ -8,3 +7,3 @@ export declare const RATE_LIMITS: RateLimit[];
         retry: boolean;
-        onRetry?: onRetry;
+        onRetry?: OnRetryHandler;
     };
@@ -11,0 +10,0 @@ }

package.json

@@ -5,3 +5,3 @@ {
   "description": "The Selling Partner API for Shipment Invoicing helps you programmatically retrieve shipment invoice information in the Brazil marketplace for a selling partner’s Fulfillment by Amazon (FBA) orders.",
-  "version": "1.8.5",
+  "version": "1.8.6",
   "main": "dist/cjs/index.js",
@@ -29,5 +29,5 @@ "module": "dist/es/index.js",
   "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"
   },
@@ -53,3 +53,3 @@ "repository": {
   ],
-  "gitHead": "5dbdf09e0f74182eaa9b6c5f9ef0c931b0aa3089"
+  "gitHead": "e8c21d7d481263e8a6663ee11f6708d4dc6968b6"
 }

README.md

@@ -5,2 +5,8 @@ # `shipment-invoicing-api-v0`
 
+## Documentation
+
+Learn more about this Selling Partner API by visiting the [official documentation](https://github.com/amzn/selling-partner-api-docs/tree/main/references/shipment-invoicing-api/shipmentInvoicingV0.md).
+
+Also, see the [generated documentation](https://bizon.github.io/selling-partner-api-sdk/modules/_sp_api_sdk_shipment_invoicing_api_v0.html) for this API client.
+
 ## Installing
@@ -23,11 +29,10 @@
 const auth = new SellingPartnerApiAuth({
-  clientId: '',
-  clientSecret: '',
-  refreshToken: '',
+  clientId: process.env.LWA_CLIENT_ID,
+  clientSecret: process.env.LWA_CLIENT_SECRET,
+  refreshToken: 'Atzr|…',
+  accessKeyId: '',
   secretAccessKey: '',
-  accessKeyId: '',
-  region: '',
   role: {
-    arn: '',
-  }
+    arn: 'arn:aws:iam::…',
+  },
 })
@@ -37,9 +42,9 @@
   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:
 
@@ -52,11 +57,26 @@ ```javascript
     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/shipment-invoicing-api/shipmentInvoicingV0.md)).
 
-## API documentation
+## License
 
-See [here](https://github.com/amzn/selling-partner-api-docs/tree/main/references/shipment-invoicing-api/shipmentInvoicingV0.md)
+MIT
+
+## Miscellaneous
+
+```
+    ╚⊙ ⊙╝
+  ╚═(███)═╝
+ ╚═(███)═╝
+╚═(███)═╝
+ ╚═(███)═╝
+  ╚═(███)═╝
+   ╚═(███)═╝
+```

No alert changes

Improved metrics

Total package byte prevSize

128171

increased by0.54%

Number of lines in readme file

79

increased by33.9%

Worsened metrics

Lines of code

2815

decreased by-0.04%

Dependency changes

• + Addedaxios@0.24.0(transitive)

• - Removedaxios@0.21.4(transitive)

• Updated@sp-api-sdk/auth@^1.9.5

• Updated@sp-api-sdk/common@^1.7.7

• Updatedaxios@^0.24.0