@sp-api-sdk/shipping-api-v1 3.0.1 → 3.1.0

package/dist/cjs/api-model/api/shipping-api.js

@@ -31,7 +31,7 @@ const ShippingApiAxiosParamCreator = function (configuration) {
     return {
         /**
          * Cancel a shipment by the given 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 {string} shipmentId
+         * @param {string} shipmentId Shipment Id to cancel a shipment
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
@@ -59,7 +59,7 @@ const ShippingApiAxiosParamCreator = function (configuration) {
         },
         /**
          * Create a new shipment.  **Usage Plan:**  | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 15 |  The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
-         * @param {CreateShipmentRequest} body
+         * @param {CreateShipmentRequest} body CreateShipmentRequest Body
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
@@ -112,7 +112,7 @@ const ShippingApiAxiosParamCreator = function (configuration) {
         },
         /**
          * 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 {GetRatesRequest} body
+         * @param {GetRatesRequest} body GetRatesRequest body
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
@@ -141,7 +141,7 @@ const ShippingApiAxiosParamCreator = function (configuration) {
         },
         /**
          * 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 {string} shipmentId
+         * @param {string} shipmentId Shipment id to return the entire shipment object
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
@@ -169,7 +169,7 @@ const ShippingApiAxiosParamCreator = function (configuration) {
         },
         /**
          * 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 {string} trackingId
+         * @param {string} trackingId Tracking Id
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
@@ -197,8 +197,8 @@ const ShippingApiAxiosParamCreator = function (configuration) {
         },
         /**
          * 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 {string} shipmentId
-         * @param {PurchaseLabelsRequest} body
+         * @param {string} shipmentId Shipment id for purchase shipping label
+         * @param {PurchaseLabelsRequest} body PurchaseShippingLabelRequest body
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
@@ -230,7 +230,7 @@ const ShippingApiAxiosParamCreator = function (configuration) {
         },
         /**
          * 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 {PurchaseShipmentRequest} body
+         * @param {PurchaseShipmentRequest} body PurchaseShipmentRequest body
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
@@ -259,9 +259,9 @@ const ShippingApiAxiosParamCreator = function (configuration) {
         },
         /**
          * 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 {string} shipmentId
-         * @param {string} trackingId
-         * @param {RetrieveShippingLabelRequest} body
+         * @param {string} shipmentId Shipment Id to retreive label
+         * @param {string} trackingId Tracking Id
+         * @param {RetrieveShippingLabelRequest} body RetrieveShippingLabelRequest body
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
@@ -306,7 +306,7 @@ const ShippingApiFp = function (configuration) {
     return {
         /**
          * Cancel a shipment by the given 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 {string} shipmentId
+         * @param {string} shipmentId Shipment Id to cancel a shipment
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
@@ -318,7 +318,7 @@ const ShippingApiFp = function (configuration) {
         },
         /**
          * Create a new shipment.  **Usage Plan:**  | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 15 |  The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
-         * @param {CreateShipmentRequest} body
+         * @param {CreateShipmentRequest} body CreateShipmentRequest Body
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
@@ -341,7 +341,7 @@ const ShippingApiFp = function (configuration) {
         },
         /**
          * 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 {GetRatesRequest} body
+         * @param {GetRatesRequest} body GetRatesRequest body
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
@@ -353,7 +353,7 @@ const ShippingApiFp = function (configuration) {
         },
         /**
          * 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 {string} shipmentId
+         * @param {string} shipmentId Shipment id to return the entire shipment object
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
@@ -365,7 +365,7 @@ const ShippingApiFp = function (configuration) {
         },
         /**
          * 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 {string} trackingId
+         * @param {string} trackingId Tracking Id
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
@@ -377,8 +377,8 @@ const ShippingApiFp = function (configuration) {
         },
         /**
          * 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 {string} shipmentId
-         * @param {PurchaseLabelsRequest} body
+         * @param {string} shipmentId Shipment id for purchase shipping label
+         * @param {PurchaseLabelsRequest} body PurchaseShippingLabelRequest body
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
@@ -390,7 +390,7 @@ const ShippingApiFp = function (configuration) {
         },
         /**
          * 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 {PurchaseShipmentRequest} body
+         * @param {PurchaseShipmentRequest} body PurchaseShipmentRequest body
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
@@ -402,9 +402,9 @@ const ShippingApiFp = function (configuration) {
         },
         /**
          * 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 {string} shipmentId
-         * @param {string} trackingId
-         * @param {RetrieveShippingLabelRequest} body
+         * @param {string} shipmentId Shipment Id to retreive label
+         * @param {string} trackingId Tracking Id
+         * @param {RetrieveShippingLabelRequest} body RetrieveShippingLabelRequest body
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */

package/dist/cjs/api-model/configuration.js

@@ -79,11 +79,10 @@ class Configuration {
         this.basePath = param.basePath;
         this.serverIndex = param.serverIndex;
         this.baseOptions = {
+            ...param.baseOptions,
             headers: {
                 ...param.baseOptions?.headers,
-                'User-Agent': "OpenAPI-Generator/typescript-axios"
             },
-            ...param.baseOptions
         };
         this.formDataCtor = param.formDataCtor;
     }

package/dist/es/api-model/api/shipping-api.js

@@ -25,7 +25,7 @@ export const ShippingApiAxiosParamCreator = function (configuration) {
     return {
         /**
          * Cancel a shipment by the given 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 {string} shipmentId
+         * @param {string} shipmentId Shipment Id to cancel a shipment
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
@@ -53,7 +53,7 @@ export const ShippingApiAxiosParamCreator = function (configuration) {
         },
         /**
          * Create a new shipment.  **Usage Plan:**  | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 15 |  The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
-         * @param {CreateShipmentRequest} body
+         * @param {CreateShipmentRequest} body CreateShipmentRequest Body
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
@@ -106,7 +106,7 @@ export const ShippingApiAxiosParamCreator = function (configuration) {
         },
         /**
          * 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 {GetRatesRequest} body
+         * @param {GetRatesRequest} body GetRatesRequest body
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
@@ -135,7 +135,7 @@ export const ShippingApiAxiosParamCreator = function (configuration) {
         },
         /**
          * 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 {string} shipmentId
+         * @param {string} shipmentId Shipment id to return the entire shipment object
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
@@ -163,7 +163,7 @@ export const ShippingApiAxiosParamCreator = function (configuration) {
         },
         /**
          * 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 {string} trackingId
+         * @param {string} trackingId Tracking Id
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
@@ -191,8 +191,8 @@ export const ShippingApiAxiosParamCreator = function (configuration) {
         },
         /**
          * 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 {string} shipmentId
-         * @param {PurchaseLabelsRequest} body
+         * @param {string} shipmentId Shipment id for purchase shipping label
+         * @param {PurchaseLabelsRequest} body PurchaseShippingLabelRequest body
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
@@ -224,7 +224,7 @@ export const ShippingApiAxiosParamCreator = function (configuration) {
         },
         /**
          * 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 {PurchaseShipmentRequest} body
+         * @param {PurchaseShipmentRequest} body PurchaseShipmentRequest body
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
@@ -253,9 +253,9 @@ export const ShippingApiAxiosParamCreator = function (configuration) {
         },
         /**
          * 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 {string} shipmentId
-         * @param {string} trackingId
-         * @param {RetrieveShippingLabelRequest} body
+         * @param {string} shipmentId Shipment Id to retreive label
+         * @param {string} trackingId Tracking Id
+         * @param {RetrieveShippingLabelRequest} body RetrieveShippingLabelRequest body
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
@@ -299,7 +299,7 @@ export const ShippingApiFp = function (configuration) {
     return {
         /**
          * Cancel a shipment by the given 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 {string} shipmentId
+         * @param {string} shipmentId Shipment Id to cancel a shipment
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
@@ -311,7 +311,7 @@ export const ShippingApiFp = function (configuration) {
         },
         /**
          * Create a new shipment.  **Usage Plan:**  | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 15 |  The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
-         * @param {CreateShipmentRequest} body
+         * @param {CreateShipmentRequest} body CreateShipmentRequest Body
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
@@ -334,7 +334,7 @@ export const ShippingApiFp = function (configuration) {
         },
         /**
          * 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 {GetRatesRequest} body
+         * @param {GetRatesRequest} body GetRatesRequest body
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
@@ -346,7 +346,7 @@ export const ShippingApiFp = function (configuration) {
         },
         /**
          * 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 {string} shipmentId
+         * @param {string} shipmentId Shipment id to return the entire shipment object
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
@@ -358,7 +358,7 @@ export const ShippingApiFp = function (configuration) {
         },
         /**
          * 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 {string} trackingId
+         * @param {string} trackingId Tracking Id
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
@@ -370,8 +370,8 @@ export const ShippingApiFp = function (configuration) {
         },
         /**
          * 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 {string} shipmentId
-         * @param {PurchaseLabelsRequest} body
+         * @param {string} shipmentId Shipment id for purchase shipping label
+         * @param {PurchaseLabelsRequest} body PurchaseShippingLabelRequest body
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
@@ -383,7 +383,7 @@ export const ShippingApiFp = function (configuration) {
         },
         /**
          * 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 {PurchaseShipmentRequest} body
+         * @param {PurchaseShipmentRequest} body PurchaseShipmentRequest body
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
@@ -395,9 +395,9 @@ export const ShippingApiFp = function (configuration) {
         },
         /**
          * 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 {string} shipmentId
-         * @param {string} trackingId
-         * @param {RetrieveShippingLabelRequest} body
+         * @param {string} shipmentId Shipment Id to retreive label
+         * @param {string} trackingId Tracking Id
+         * @param {RetrieveShippingLabelRequest} body RetrieveShippingLabelRequest body
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */

package/dist/es/api-model/configuration.js

@@ -76,11 +76,10 @@ export class Configuration {
         this.basePath = param.basePath;
         this.serverIndex = param.serverIndex;
         this.baseOptions = {
+            ...param.baseOptions,
             headers: {
                 ...param.baseOptions?.headers,
-                'User-Agent': "OpenAPI-Generator/typescript-axios"
             },
-            ...param.baseOptions
         };
         this.formDataCtor = param.formDataCtor;
     }

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

@@ -34,14 +34,14 @@ import type { RetrieveShippingLabelResponse } from '../models';
 export declare const ShippingApiAxiosParamCreator: (configuration?: Configuration) => {
     /**
      * Cancel a shipment by the given 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 {string} shipmentId
+     * @param {string} shipmentId Shipment Id to cancel a shipment
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
     cancelShipment: (shipmentId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * Create a new shipment.  **Usage Plan:**  | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 15 |  The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
-     * @param {CreateShipmentRequest} body
+     * @param {CreateShipmentRequest} body CreateShipmentRequest Body
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
@@ -54,45 +54,45 @@ export declare const ShippingApiAxiosParamCreator: (configuration?: Configuratio
     getAccount: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * 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 {GetRatesRequest} body
+     * @param {GetRatesRequest} body GetRatesRequest body
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
     getRates: (body: GetRatesRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * 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 {string} shipmentId
+     * @param {string} shipmentId Shipment id to return the entire shipment object
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
     getShipment: (shipmentId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * 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 {string} trackingId
+     * @param {string} trackingId Tracking Id
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
     getTrackingInformation: (trackingId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * 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 {string} shipmentId
-     * @param {PurchaseLabelsRequest} body
+     * @param {string} shipmentId Shipment id for purchase shipping label
+     * @param {PurchaseLabelsRequest} body PurchaseShippingLabelRequest body
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
     purchaseLabels: (shipmentId: string, body: PurchaseLabelsRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * 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 {PurchaseShipmentRequest} body
+     * @param {PurchaseShipmentRequest} body PurchaseShipmentRequest body
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
     purchaseShipment: (body: PurchaseShipmentRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * 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 {string} shipmentId
-     * @param {string} trackingId
-     * @param {RetrieveShippingLabelRequest} body
+     * @param {string} shipmentId Shipment Id to retreive label
+     * @param {string} trackingId Tracking Id
+     * @param {RetrieveShippingLabelRequest} body RetrieveShippingLabelRequest body
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
@@ -105,14 +105,14 @@ export declare const ShippingApiAxiosParamCreator: (configuration?: Configuratio
 export declare const ShippingApiFp: (configuration?: Configuration) => {
     /**
      * Cancel a shipment by the given 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 {string} shipmentId
+     * @param {string} shipmentId Shipment Id to cancel a shipment
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
     cancelShipment(shipmentId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CancelShipmentResponse>>;
     /**
      * Create a new shipment.  **Usage Plan:**  | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 15 |  The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
-     * @param {CreateShipmentRequest} body
+     * @param {CreateShipmentRequest} body CreateShipmentRequest Body
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
@@ -125,45 +125,45 @@ export declare const ShippingApiFp: (configuration?: Configuration) => {
     getAccount(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetAccountResponse>>;
     /**
      * 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 {GetRatesRequest} body
+     * @param {GetRatesRequest} body GetRatesRequest body
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
     getRates(body: GetRatesRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetRatesResponse>>;
     /**
      * 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 {string} shipmentId
+     * @param {string} shipmentId Shipment id to return the entire shipment object
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
     getShipment(shipmentId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetShipmentResponse>>;
     /**
      * 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 {string} trackingId
+     * @param {string} trackingId Tracking Id
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
     getTrackingInformation(trackingId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetTrackingInformationResponse>>;
     /**
      * 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 {string} shipmentId
-     * @param {PurchaseLabelsRequest} body
+     * @param {string} shipmentId Shipment id for purchase shipping label
+     * @param {PurchaseLabelsRequest} body PurchaseShippingLabelRequest body
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
     purchaseLabels(shipmentId: string, body: PurchaseLabelsRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PurchaseLabelsResponse>>;
     /**
      * 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 {PurchaseShipmentRequest} body
+     * @param {PurchaseShipmentRequest} body PurchaseShipmentRequest body
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
     purchaseShipment(body: PurchaseShipmentRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PurchaseShipmentResponse>>;
     /**
      * 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 {string} shipmentId
-     * @param {string} trackingId
-     * @param {RetrieveShippingLabelRequest} body
+     * @param {string} shipmentId Shipment Id to retreive label
+     * @param {string} trackingId Tracking Id
+     * @param {RetrieveShippingLabelRequest} body RetrieveShippingLabelRequest body
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
@@ -244,7 +244,7 @@ export declare const ShippingApiFactory: (configuration?: Configuration, basePat
  */
 export interface ShippingApiCancelShipmentRequest {
     /**
-     *
+     * Shipment Id to cancel a shipment
      * @type {string}
      * @memberof ShippingApiCancelShipment
      */
@@ -257,7 +257,7 @@ export interface ShippingApiCancelShipmentRequest {
  */
 export interface ShippingApiCreateShipmentRequest {
     /**
-     *
+     * CreateShipmentRequest Body
      * @type {CreateShipmentRequest}
      * @memberof ShippingApiCreateShipment
      */
@@ -270,7 +270,7 @@ export interface ShippingApiCreateShipmentRequest {
  */
 export interface ShippingApiGetRatesRequest {
     /**
-     *
+     * GetRatesRequest body
      * @type {GetRatesRequest}
      * @memberof ShippingApiGetRates
      */
@@ -283,7 +283,7 @@ export interface ShippingApiGetRatesRequest {
  */
 export interface ShippingApiGetShipmentRequest {
     /**
-     *
+     * Shipment id to return the entire shipment object
      * @type {string}
      * @memberof ShippingApiGetShipment
      */
@@ -296,7 +296,7 @@ export interface ShippingApiGetShipmentRequest {
  */
 export interface ShippingApiGetTrackingInformationRequest {
     /**
-     *
+     * Tracking Id
      * @type {string}
      * @memberof ShippingApiGetTrackingInformation
      */
@@ -309,13 +309,13 @@ export interface ShippingApiGetTrackingInformationRequest {
  */
 export interface ShippingApiPurchaseLabelsRequest {
     /**
-     *
+     * Shipment id for purchase shipping label
      * @type {string}
      * @memberof ShippingApiPurchaseLabels
      */
     readonly shipmentId: string;
     /**
-     *
+     * PurchaseShippingLabelRequest body
      * @type {PurchaseLabelsRequest}
      * @memberof ShippingApiPurchaseLabels
      */
@@ -328,7 +328,7 @@ export interface ShippingApiPurchaseLabelsRequest {
  */
 export interface ShippingApiPurchaseShipmentRequest {
     /**
-     *
+     * PurchaseShipmentRequest body
      * @type {PurchaseShipmentRequest}
      * @memberof ShippingApiPurchaseShipment
      */
@@ -341,19 +341,19 @@ export interface ShippingApiPurchaseShipmentRequest {
  */
 export interface ShippingApiRetrieveShippingLabelRequest {
     /**
-     *
+     * Shipment Id to retreive label
      * @type {string}
      * @memberof ShippingApiRetrieveShippingLabel
      */
     readonly shipmentId: string;
     /**
-     *
+     * Tracking Id
      * @type {string}
      * @memberof ShippingApiRetrieveShippingLabel
      */
     readonly trackingId: string;
     /**
-     *
+     * RetrieveShippingLabelRequest body
      * @type {RetrieveShippingLabelRequest}
      * @memberof ShippingApiRetrieveShippingLabel
      */

package/dist/types/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) => <T = unknown, R = AxiosResponse<T, any>>(axios?: AxiosInstance, basePath?: string) => Promise<R>;
+export declare const createRequestFunction: (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) => <T = unknown, R = AxiosResponse<T>>(axios?: AxiosInstance, basePath?: string) => Promise<R>;

package/dist/types/api-model/models/model-error.d.ts

@@ -16,13 +16,13 @@
  */
 export interface ModelError {
     /**
-     * An error code that identifies the type of error that occured.
+     * An error code that identifies the type of error that occurred.
      * @type {string}
      * @memberof ModelError
      */
     'code': string;
     /**
-     * A message that describes the error condition in a human-readable form.
+     * A message that describes the error condition.
      * @type {string}
      * @memberof ModelError
      */

package/package.json

@@ -2,7 +2,7 @@
   "name": "@sp-api-sdk/shipping-api-v1",
   "author": "Bertrand Marron <bertrand@bizon.solutions>",
   "description": "Provides programmatic access to Amazon Shipping APIs. Note: If you are new to the Amazon Shipping API, refer to the latest version of Amazon Shipping API (v2) on the Amazon Shipping Developer Documentation site.",
-  "version": "3.0.1",
+  "version": "3.1.0",
   "main": "dist/cjs/index.js",
   "module": "dist/es/index.js",
   "types": "dist/types/index.d.ts",
@@ -18,8 +18,8 @@
     "dist/**/*.d.ts"
   ],
   "dependencies": {
-    "@sp-api-sdk/common": "2.1.10",
-    "axios": "^1.7.9"
+    "@sp-api-sdk/common": "2.1.11",
+    "axios": "^1.8.1"
   },
   "repository": {
     "type": "git",
@@ -40,5 +40,5 @@
     "sp sdk",
     "shipping api"
   ],
-  "gitHead": "4098c9f3375b3b56212baa3bf21c18dd987baab2"
+  "gitHead": "b5799742765e819f70161d2ac1905d8e570de8c0"
 }