@sp-api-sdk/vendor-direct-fulfillment-shipping-api-v1 1.7.5 → 1.7.9

package/README.md

@@ -2,6 +2,15 @@
 
 The Selling Partner API for Direct Fulfillment Shipping provides programmatic access to a direct fulfillment vendor's shipping data.
 
+[![npm version](https://badgen.net/npm/v/@sp-api-sdk/vendor-direct-fulfillment-shipping-api-v1)](https://www.npmjs.com/package/@sp-api-sdk/vendor-direct-fulfillment-shipping-api-v1)
+[![XO code style](https://badgen.net/badge/code%20style/XO/cyan)](https://github.com/xojs/xo)
+
+## Documentation
+
+Learn more about this Selling Partner API by visiting the [official documentation](https://github.com/amzn/selling-partner-api-docs/tree/main/references/vendor-direct-fulfillment-shipping-api/vendorDirectFulfillmentShippingV1.md).
+
+Also, see the [generated documentation](https://bizon.github.io/selling-partner-api-sdk/modules/_sp_api_sdk_vendor_direct_fulfillment_shipping_api_v1.html) for this API client.
+
 ## Installing
 
 ```sh
@@ -19,26 +28,25 @@ import {SellingPartnerApiAuth} from '@sp-api-sdk/auth'
 import {VendorDirectFulfillmentShippingApiClient} from '@sp-api-sdk/vendor-direct-fulfillment-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 VendorDirectFulfillmentShippingApiClient({
   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 VendorDirectFulfillmentShippingApiClient({
@@ -46,13 +54,28 @@ const client = new VendorDirectFulfillmentShippingApiClient({
   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/vendor-direct-fulfillment-shipping-api/vendorDirectFulfillmentShippingV1.md)).
+
+## License
+
+MIT
 
-## API documentation
+## Miscellaneous
 
-See [here](https://github.com/amzn/selling-partner-api-docs/tree/main/references/vendor-direct-fulfillment-shipping-api/vendorDirectFulfillmentShippingV1.md)
+```
+    ╚⊙ ⊙╝
+  ╚═(███)═╝
+ ╚═(███)═╝
+╚═(███)═╝
+ ╚═(███)═╝
+  ╚═(███)═╝
+   ╚═(███)═╝
+```

package/dist/cjs/src/client.js

@@ -1,11 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.VendorDirectFulfillmentShippingApiClient = exports.RATE_LIMITS = void 0;
+exports.VendorDirectFulfillmentShippingApiClient = exports.clientRateLimits = void 0;
 /* eslint-disable prefer-regex-literals */
 const common_1 = require("@sp-api-sdk/common");
 const api_model_1 = require("./api-model");
 const error_1 = require("./error");
-exports.RATE_LIMITS = [
+exports.clientRateLimits = [
     {
         method: 'get',
         urlRegex: new RegExp('^/vendor/directFulfillment/shipping/v1/shippingLabels$'),
@@ -63,20 +63,23 @@ exports.RATE_LIMITS = [
 ];
 class VendorDirectFulfillmentShippingApiClient extends api_model_1.VendorShippingLabelsApi {
     constructor(parameters) {
-        const region = common_1.awsRegionByCode[parameters.region] ?? parameters.region;
+        const config = common_1.sellingPartnerRegions[parameters.region];
+        if (!config) {
+            throw new error_1.VendorDirectFulfillmentShippingApiError(`Unknown region: ${parameters.region}`);
+        }
         const { rateLimiting, ...clientParameters } = parameters;
-        const axiosParameters = { ...clientParameters, region };
+        const axiosParameters = {
+            ...clientParameters,
+            region: config.awsRegion,
+        };
         if (rateLimiting?.retry) {
-            axiosParameters.rateLimits = exports.RATE_LIMITS;
+            axiosParameters.rateLimits = exports.clientRateLimits;
             axiosParameters.onRetry = rateLimiting.onRetry;
         }
         const axiosInstance = (0, common_1.createAxiosInstance)(axiosParameters);
         const configuration = new api_model_1.Configuration();
         const environment = parameters.sandbox ? 'sandbox' : 'production';
-        const endpoint = common_1.endpoints[environment][region];
-        if (!endpoint) {
-            throw new error_1.VendorDirectFulfillmentShippingApiError(`Unknown region : ${region}`);
-        }
+        const endpoint = config.endpoints[environment];
         super(configuration, endpoint, axiosInstance);
     }
 }

package/dist/es/src/client.js

@@ -1,8 +1,8 @@
 /* eslint-disable prefer-regex-literals */
-import { endpoints, awsRegionByCode, createAxiosInstance } from '@sp-api-sdk/common';
+import { sellingPartnerRegions, createAxiosInstance } from '@sp-api-sdk/common';
 import { Configuration, VendorShippingLabelsApi } from './api-model';
 import { VendorDirectFulfillmentShippingApiError } from './error';
-export const RATE_LIMITS = [
+export const clientRateLimits = [
     {
         method: 'get',
         urlRegex: new RegExp('^/vendor/directFulfillment/shipping/v1/shippingLabels$'),
@@ -60,20 +60,23 @@ export const RATE_LIMITS = [
 ];
 export class VendorDirectFulfillmentShippingApiClient extends VendorShippingLabelsApi {
     constructor(parameters) {
-        const region = awsRegionByCode[parameters.region] ?? parameters.region;
+        const config = sellingPartnerRegions[parameters.region];
+        if (!config) {
+            throw new VendorDirectFulfillmentShippingApiError(`Unknown region: ${parameters.region}`);
+        }
         const { rateLimiting, ...clientParameters } = parameters;
-        const axiosParameters = { ...clientParameters, region };
+        const axiosParameters = {
+            ...clientParameters,
+            region: config.awsRegion,
+        };
         if (rateLimiting?.retry) {
-            axiosParameters.rateLimits = RATE_LIMITS;
+            axiosParameters.rateLimits = clientRateLimits;
             axiosParameters.onRetry = rateLimiting.onRetry;
         }
         const axiosInstance = createAxiosInstance(axiosParameters);
         const configuration = new Configuration();
         const environment = parameters.sandbox ? 'sandbox' : 'production';
-        const endpoint = endpoints[environment][region];
-        if (!endpoint) {
-            throw new VendorDirectFulfillmentShippingApiError(`Unknown region : ${region}`);
-        }
+        const endpoint = config.endpoints[environment];
         super(configuration, endpoint, axiosInstance);
     }
 }

package/dist/types/src/api-model/api/customer-invoices-api.d.ts

@@ -159,7 +159,7 @@ export declare class CustomerInvoicesApi extends BaseAPI {
      * @throws {RequiredError}
      * @memberof CustomerInvoicesApi
      */
-    getCustomerInvoice(requestParameters: CustomerInvoicesApiGetCustomerInvoiceRequest, options?: any): Promise<import("axios").AxiosResponse<GetCustomerInvoiceResponse>>;
+    getCustomerInvoice(requestParameters: CustomerInvoicesApiGetCustomerInvoiceRequest, options?: any): Promise<import("axios").AxiosResponse<GetCustomerInvoiceResponse, any>>;
     /**
      * Returns a list of customer invoices created during a time frame that you specify. You define the  time frame using the createdAfter and createdBefore parameters. You must use both of these parameters. The date range to search must be no more than 7 days.  **Usage Plans:**  | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 10 | 10 | |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.
      * @param {CustomerInvoicesApiGetCustomerInvoicesRequest} requestParameters Request parameters.
@@ -167,5 +167,5 @@ export declare class CustomerInvoicesApi extends BaseAPI {
      * @throws {RequiredError}
      * @memberof CustomerInvoicesApi
      */
-    getCustomerInvoices(requestParameters: CustomerInvoicesApiGetCustomerInvoicesRequest, options?: any): Promise<import("axios").AxiosResponse<GetCustomerInvoicesResponse>>;
+    getCustomerInvoices(requestParameters: CustomerInvoicesApiGetCustomerInvoicesRequest, options?: any): Promise<import("axios").AxiosResponse<GetCustomerInvoicesResponse, any>>;
 }

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

@@ -231,7 +231,7 @@ export declare class VendorShippingApi extends BaseAPI {
      * @throws {RequiredError}
      * @memberof VendorShippingApi
      */
-    getPackingSlip(requestParameters: VendorShippingApiGetPackingSlipRequest, options?: any): Promise<import("axios").AxiosResponse<GetPackingSlipResponse>>;
+    getPackingSlip(requestParameters: VendorShippingApiGetPackingSlipRequest, options?: any): Promise<import("axios").AxiosResponse<GetPackingSlipResponse, any>>;
     /**
      * Returns a list of packing slips for the purchase orders that match the criteria specified. Date range to search must not be more than 7 days.  **Usage Plans:**  | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 10 | 10 | |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.
      * @param {VendorShippingApiGetPackingSlipsRequest} requestParameters Request parameters.
@@ -239,7 +239,7 @@ export declare class VendorShippingApi extends BaseAPI {
      * @throws {RequiredError}
      * @memberof VendorShippingApi
      */
-    getPackingSlips(requestParameters: VendorShippingApiGetPackingSlipsRequest, options?: any): Promise<import("axios").AxiosResponse<GetPackingSlipListResponse>>;
+    getPackingSlips(requestParameters: VendorShippingApiGetPackingSlipsRequest, options?: any): Promise<import("axios").AxiosResponse<GetPackingSlipListResponse, any>>;
     /**
      * Submits one or more shipment confirmations for vendor orders.  **Usage Plans:**  | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 10 | 10 | |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.
      * @param {VendorShippingApiSubmitShipmentConfirmationsRequest} requestParameters Request parameters.
@@ -247,7 +247,7 @@ export declare class VendorShippingApi extends BaseAPI {
      * @throws {RequiredError}
      * @memberof VendorShippingApi
      */
-    submitShipmentConfirmations(requestParameters: VendorShippingApiSubmitShipmentConfirmationsRequest, options?: any): Promise<import("axios").AxiosResponse<SubmitShipmentConfirmationsResponse>>;
+    submitShipmentConfirmations(requestParameters: VendorShippingApiSubmitShipmentConfirmationsRequest, options?: any): Promise<import("axios").AxiosResponse<SubmitShipmentConfirmationsResponse, any>>;
     /**
      * This API call is only to be used by Vendor-Own-Carrier (VOC) vendors. Calling this API will submit a shipment status update for the package that a vendor has shipped. It will provide the Amazon customer visibility on their order, when the package is outside of Amazon Network visibility.  **Usage Plans:**  | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 10 | 10 | |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.
      * @param {VendorShippingApiSubmitShipmentStatusUpdatesRequest} requestParameters Request parameters.
@@ -255,5 +255,5 @@ export declare class VendorShippingApi extends BaseAPI {
      * @throws {RequiredError}
      * @memberof VendorShippingApi
      */
-    submitShipmentStatusUpdates(requestParameters: VendorShippingApiSubmitShipmentStatusUpdatesRequest, options?: any): Promise<import("axios").AxiosResponse<SubmitShipmentStatusUpdatesResponse>>;
+    submitShipmentStatusUpdates(requestParameters: VendorShippingApiSubmitShipmentStatusUpdatesRequest, options?: any): Promise<import("axios").AxiosResponse<SubmitShipmentStatusUpdatesResponse, any>>;
 }

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

@@ -195,7 +195,7 @@ export declare class VendorShippingLabelsApi extends BaseAPI {
      * @throws {RequiredError}
      * @memberof VendorShippingLabelsApi
      */
-    getShippingLabel(requestParameters: VendorShippingLabelsApiGetShippingLabelRequest, options?: any): Promise<import("axios").AxiosResponse<GetShippingLabelResponse>>;
+    getShippingLabel(requestParameters: VendorShippingLabelsApiGetShippingLabelRequest, options?: any): Promise<import("axios").AxiosResponse<GetShippingLabelResponse, any>>;
     /**
      * Returns a list of shipping labels created during the time frame that you specify. You define that time frame using the createdAfter and createdBefore parameters. You must use both of these parameters. The date range to search must not be more than 7 days.  **Usage Plans:**  | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 10 | 10 | |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.
      * @param {VendorShippingLabelsApiGetShippingLabelsRequest} requestParameters Request parameters.
@@ -203,7 +203,7 @@ export declare class VendorShippingLabelsApi extends BaseAPI {
      * @throws {RequiredError}
      * @memberof VendorShippingLabelsApi
      */
-    getShippingLabels(requestParameters: VendorShippingLabelsApiGetShippingLabelsRequest, options?: any): Promise<import("axios").AxiosResponse<GetShippingLabelListResponse>>;
+    getShippingLabels(requestParameters: VendorShippingLabelsApiGetShippingLabelsRequest, options?: any): Promise<import("axios").AxiosResponse<GetShippingLabelListResponse, any>>;
     /**
      * Creates a shipping label for a purchase order and returns a transactionId for reference.  **Usage Plans:**  | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 10 | 10 | |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.
      * @param {VendorShippingLabelsApiSubmitShippingLabelRequestRequest} requestParameters Request parameters.
@@ -211,5 +211,5 @@ export declare class VendorShippingLabelsApi extends BaseAPI {
      * @throws {RequiredError}
      * @memberof VendorShippingLabelsApi
      */
-    submitShippingLabelRequest(requestParameters: VendorShippingLabelsApiSubmitShippingLabelRequestRequest, options?: any): Promise<import("axios").AxiosResponse<SubmitShippingLabelsResponse>>;
+    submitShippingLabelRequest(requestParameters: VendorShippingLabelsApiSubmitShippingLabelRequestRequest, options?: any): Promise<import("axios").AxiosResponse<SubmitShippingLabelsResponse, 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,11 @@
-import { onRetry } from '@sp-api-sdk/common';
-import type { ClientConfiguration, RateLimit } from '@sp-api-sdk/common';
+import type { ClientConfiguration, SellingPartnerRegion, RateLimit, OnRetryHandler } from '@sp-api-sdk/common';
 import { VendorShippingLabelsApi } from './api-model';
-export declare const RATE_LIMITS: RateLimit[];
+export declare const clientRateLimits: RateLimit[];
 export interface ClientParameters extends Omit<ClientConfiguration, 'rateLimits' | 'onRetry'> {
+    region: SellingPartnerRegion;
     rateLimiting?: {
         retry: boolean;
-        onRetry?: onRetry;
+        onRetry?: OnRetryHandler;
     };
 }
 export declare class VendorDirectFulfillmentShippingApiClient extends VendorShippingLabelsApi {

package/package.json

@@ -2,7 +2,7 @@
   "name": "@sp-api-sdk/vendor-direct-fulfillment-shipping-api-v1",
   "author": "Vincent Mesquita <vincent.mesquita@bizon.solutions>",
   "description": "The Selling Partner API for Direct Fulfillment Shipping provides programmatic access to a direct fulfillment vendor's shipping data.",
-  "version": "1.7.5",
+  "version": "1.7.9",
   "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.7",
+    "@sp-api-sdk/common": "^1.7.9",
+    "axios": "^0.24.0"
   },
   "repository": {
     "type": "git",
@@ -48,5 +48,5 @@
     "sp sdk",
     "vendor direct fulfillment shipping api"
   ],
-  "gitHead": "5dbdf09e0f74182eaa9b6c5f9ef0c931b0aa3089"
+  "gitHead": "dd52e8a895f590c62d06f19f4d8715eb7740df66"
 }

package/dist/cjs/src/api-model/models/package.js

@@ -1,15 +0,0 @@
-"use strict";
-/* tslint:disable */
-/* eslint-disable */
-/**
- * Selling Partner API for Direct Fulfillment Shipping
- * The Selling Partner API for Direct Fulfillment Shipping provides programmatic access to a direct fulfillment vendor\'s shipping data.
- *
- * The version of the OpenAPI document: v1
- *
- *
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
- * https://openapi-generator.tech
- * Do not edit the class manually.
- */
-Object.defineProperty(exports, "__esModule", { value: true });

package/dist/es/src/api-model/models/package.js

@@ -1,14 +0,0 @@
-/* tslint:disable */
-/* eslint-disable */
-/**
- * Selling Partner API for Direct Fulfillment Shipping
- * The Selling Partner API for Direct Fulfillment Shipping provides programmatic access to a direct fulfillment vendor\'s shipping data.
- *
- * The version of the OpenAPI document: v1
- *
- *
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
- * https://openapi-generator.tech
- * Do not edit the class manually.
- */
-export {};

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

@@ -1,62 +0,0 @@
-/**
- * Selling Partner API for Direct Fulfillment Shipping
- * The Selling Partner API for Direct Fulfillment Shipping provides programmatic access to a direct fulfillment vendor\'s shipping data.
- *
- * The version of the OpenAPI document: v1
- *
- *
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
- * https://openapi-generator.tech
- * Do not edit the class manually.
- */
-import { Dimensions } from './dimensions';
-import { Weight } from './weight';
-/**
- * Details of the package being shipped.
- * @export
- * @interface Package
- */
-export interface Package {
-    /**
-     * Package identifier for the package. The first package will be 001, the second 002, and so on. This number is used as a reference to refer to this package from the pallet level.
-     * @type {string}
-     * @memberof Package
-     */
-    packageIdentifier: string;
-    /**
-     * This is required to be provided for every package in the small parcel shipments.
-     * @type {string}
-     * @memberof Package
-     */
-    trackingNumber?: string;
-    /**
-     * Carrier manifest Id (Applicable for LTL shipments).
-     * @type {string}
-     * @memberof Package
-     */
-    manifestId?: string;
-    /**
-     * Carrier manifest Date (Applicable for LTL shipments).
-     * @type {string}
-     * @memberof Package
-     */
-    manifestDate?: string;
-    /**
-     * Shipment method.
-     * @type {string}
-     * @memberof Package
-     */
-    shipMethod?: string;
-    /**
-     *
-     * @type {Weight}
-     * @memberof Package
-     */
-    weight: Weight;
-    /**
-     *
-     * @type {Dimensions}
-     * @memberof Package
-     */
-    dimensions?: Dimensions;
-}