@sp-api-sdk/vendor-direct-fulfillment-orders-api-v1 - npm Package Compare versions

Comparing version 1.9.9 to 1.9.10

dist/cjs/src/api-model/api/vendor-orders-api.js

@@ -210,33 +210,26 @@ "use strict";
          * Returns purchase order information for the purchaseOrderNumber that you specify.  **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 {string} purchaseOrderNumber The order identifier for the purchase order that you want. Formatting Notes: alpha-numeric code.
+         * @param {VendorOrdersApiGetOrderRequest} requestParameters Request parameters.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        getOrder(purchaseOrderNumber, options) {
-            return localVarFp.getOrder(purchaseOrderNumber, options).then((request) => request(axios, basePath));
+        getOrder(requestParameters, options) {
+            return localVarFp.getOrder(requestParameters.purchaseOrderNumber, options).then((request) => request(axios, basePath));
         },
         /**
          * Returns a list of purchase orders created during the time frame that you specify. You define the time frame using the createdAfter and createdBefore parameters. You must use both parameters. You can choose to get only the purchase order numbers by setting the includeDetails parameter to false. In that case, the operation returns a list of purchase order numbers. You can then call the getOrder operation to return the details of a specific order.  **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 {string} createdAfter Purchase orders that became available after this date and time will be included in the result. Must be in ISO-8601 date/time format.
-         * @param {string} createdBefore Purchase orders that became available before this date and time will be included in the result. Must be in ISO-8601 date/time format.
-         * @param {string} [shipFromPartyId] The vendor warehouse identifier for the fulfillment warehouse. If not specified, the result will contain orders for all warehouses.
-         * @param {'NEW' | 'SHIPPED' | 'ACCEPTED' | 'CANCELLED'} [status] Returns only the purchase orders that match the specified status. If not specified, the result will contain orders that match any status.
-         * @param {number} [limit] The limit to the number of purchase orders returned.
-         * @param {'ASC' | 'DESC'} [sortOrder] Sort the list in ascending or descending order by order creation date.
-         * @param {string} [nextToken] Used for pagination when there are more orders than the specified result size limit. The token value is returned in the previous API call.
-         * @param {boolean} [includeDetails] When true, returns the complete purchase order details. Otherwise, only purchase order numbers are returned.
+         * @param {VendorOrdersApiGetOrdersRequest} requestParameters Request parameters.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        getOrders(createdAfter, createdBefore, shipFromPartyId, status, limit, sortOrder, nextToken, includeDetails, options) {
-            return localVarFp.getOrders(createdAfter, createdBefore, shipFromPartyId, status, limit, sortOrder, nextToken, includeDetails, options).then((request) => request(axios, basePath));
+        getOrders(requestParameters, options) {
+            return localVarFp.getOrders(requestParameters.createdAfter, requestParameters.createdBefore, requestParameters.shipFromPartyId, requestParameters.status, requestParameters.limit, requestParameters.sortOrder, requestParameters.nextToken, requestParameters.includeDetails, options).then((request) => request(axios, basePath));
         },
         /**
          * Submits acknowledgements for one or more purchase 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 {SubmitAcknowledgementRequest} body
+         * @param {VendorOrdersApiSubmitAcknowledgementRequest} requestParameters Request parameters.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        submitAcknowledgement(body, options) {
-            return localVarFp.submitAcknowledgement(body, options).then((request) => request(axios, basePath));
+        submitAcknowledgement(requestParameters, options) {
+            return localVarFp.submitAcknowledgement(requestParameters.body, options).then((request) => request(axios, basePath));
         },
@@ -243,0 +236,0 @@ };

dist/cjs/src/api-model/base.js

@@ -18,4 +18,2 @@ "use strict";
 const tslib_1 = require("tslib");
-// Some imports not used depending on template conditions
-// @ts-ignore
 const axios_1 = tslib_1.__importDefault(require("axios"));
@@ -61,8 +59,8 @@ exports.BASE_PATH = "https://sellingpartnerapi-na.amazon.com".replace(/\/+$/, "");
     field;
-    name = "RequiredError";
     constructor(field, msg) {
         super(msg);
         this.field = field;
+        this.name = "RequiredError";
     }
 }
 exports.RequiredError = RequiredError;

dist/cjs/src/api-model/common.js

@@ -84,2 +84,4 @@ "use strict";
 function setFlattenedQueryParams(urlSearchParams, parameter, key = "") {
+    if (parameter == null)
+        return;
     if (typeof parameter === "object") {
@@ -86,0 +88,0 @@ if (Array.isArray(parameter)) {

dist/es/src/api-model/api/vendor-orders-api.js

@@ -204,33 +204,26 @@ /* tslint:disable */
          * Returns purchase order information for the purchaseOrderNumber that you specify.  **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 {string} purchaseOrderNumber The order identifier for the purchase order that you want. Formatting Notes: alpha-numeric code.
+         * @param {VendorOrdersApiGetOrderRequest} requestParameters Request parameters.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        getOrder(purchaseOrderNumber, options) {
-            return localVarFp.getOrder(purchaseOrderNumber, options).then((request) => request(axios, basePath));
+        getOrder(requestParameters, options) {
+            return localVarFp.getOrder(requestParameters.purchaseOrderNumber, options).then((request) => request(axios, basePath));
         },
         /**
          * Returns a list of purchase orders created during the time frame that you specify. You define the time frame using the createdAfter and createdBefore parameters. You must use both parameters. You can choose to get only the purchase order numbers by setting the includeDetails parameter to false. In that case, the operation returns a list of purchase order numbers. You can then call the getOrder operation to return the details of a specific order.  **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 {string} createdAfter Purchase orders that became available after this date and time will be included in the result. Must be in ISO-8601 date/time format.
-         * @param {string} createdBefore Purchase orders that became available before this date and time will be included in the result. Must be in ISO-8601 date/time format.
-         * @param {string} [shipFromPartyId] The vendor warehouse identifier for the fulfillment warehouse. If not specified, the result will contain orders for all warehouses.
-         * @param {'NEW' | 'SHIPPED' | 'ACCEPTED' | 'CANCELLED'} [status] Returns only the purchase orders that match the specified status. If not specified, the result will contain orders that match any status.
-         * @param {number} [limit] The limit to the number of purchase orders returned.
-         * @param {'ASC' | 'DESC'} [sortOrder] Sort the list in ascending or descending order by order creation date.
-         * @param {string} [nextToken] Used for pagination when there are more orders than the specified result size limit. The token value is returned in the previous API call.
-         * @param {boolean} [includeDetails] When true, returns the complete purchase order details. Otherwise, only purchase order numbers are returned.
+         * @param {VendorOrdersApiGetOrdersRequest} requestParameters Request parameters.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        getOrders(createdAfter, createdBefore, shipFromPartyId, status, limit, sortOrder, nextToken, includeDetails, options) {
-            return localVarFp.getOrders(createdAfter, createdBefore, shipFromPartyId, status, limit, sortOrder, nextToken, includeDetails, options).then((request) => request(axios, basePath));
+        getOrders(requestParameters, options) {
+            return localVarFp.getOrders(requestParameters.createdAfter, requestParameters.createdBefore, requestParameters.shipFromPartyId, requestParameters.status, requestParameters.limit, requestParameters.sortOrder, requestParameters.nextToken, requestParameters.includeDetails, options).then((request) => request(axios, basePath));
         },
         /**
          * Submits acknowledgements for one or more purchase 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 {SubmitAcknowledgementRequest} body
+         * @param {VendorOrdersApiSubmitAcknowledgementRequest} requestParameters Request parameters.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        submitAcknowledgement(body, options) {
-            return localVarFp.submitAcknowledgement(body, options).then((request) => request(axios, basePath));
+        submitAcknowledgement(requestParameters, options) {
+            return localVarFp.submitAcknowledgement(requestParameters.body, options).then((request) => request(axios, basePath));
         },
@@ -237,0 +230,0 @@ };

dist/es/src/api-model/base.js

@@ -14,4 +14,2 @@ /* tslint:disable */
  */
-// Some imports not used depending on template conditions
-// @ts-ignore
 import globalAxios from 'axios';
@@ -56,7 +54,7 @@ export const BASE_PATH = "https://sellingpartnerapi-na.amazon.com".replace(/\/+$/, "");
     field;
-    name = "RequiredError";
     constructor(field, msg) {
         super(msg);
         this.field = field;
+        this.name = "RequiredError";
     }
 }

dist/es/src/api-model/common.js

@@ -76,2 +76,4 @@ /* tslint:disable */
 function setFlattenedQueryParams(urlSearchParams, parameter, key = "") {
+    if (parameter == null)
+        return;
     if (typeof parameter === "object") {
@@ -78,0 +80,0 @@ if (Array.isArray(parameter)) {

dist/types/src/api-model/api/vendor-orders-api.d.ts

@@ -12,4 +12,4 @@ /**
  */
-import { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
-import { Configuration } from '../configuration';
+import type { Configuration } from '../configuration';
+import type { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
 import { RequestArgs, BaseAPI } from '../base';
@@ -95,28 +95,21 @@ import { GetOrderResponse } from '../models';
      * Returns purchase order information for the purchaseOrderNumber that you specify.  **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 {string} purchaseOrderNumber The order identifier for the purchase order that you want. Formatting Notes: alpha-numeric code.
+     * @param {VendorOrdersApiGetOrderRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getOrder(purchaseOrderNumber: string, options?: any): AxiosPromise<GetOrderResponse>;
+    getOrder(requestParameters: VendorOrdersApiGetOrderRequest, options?: AxiosRequestConfig): AxiosPromise<GetOrderResponse>;
     /**
      * Returns a list of purchase orders created during the time frame that you specify. You define the time frame using the createdAfter and createdBefore parameters. You must use both parameters. You can choose to get only the purchase order numbers by setting the includeDetails parameter to false. In that case, the operation returns a list of purchase order numbers. You can then call the getOrder operation to return the details of a specific order.  **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 {string} createdAfter Purchase orders that became available after this date and time will be included in the result. Must be in ISO-8601 date/time format.
-     * @param {string} createdBefore Purchase orders that became available before this date and time will be included in the result. Must be in ISO-8601 date/time format.
-     * @param {string} [shipFromPartyId] The vendor warehouse identifier for the fulfillment warehouse. If not specified, the result will contain orders for all warehouses.
-     * @param {'NEW' | 'SHIPPED' | 'ACCEPTED' | 'CANCELLED'} [status] Returns only the purchase orders that match the specified status. If not specified, the result will contain orders that match any status.
-     * @param {number} [limit] The limit to the number of purchase orders returned.
-     * @param {'ASC' | 'DESC'} [sortOrder] Sort the list in ascending or descending order by order creation date.
-     * @param {string} [nextToken] Used for pagination when there are more orders than the specified result size limit. The token value is returned in the previous API call.
-     * @param {boolean} [includeDetails] When true, returns the complete purchase order details. Otherwise, only purchase order numbers are returned.
+     * @param {VendorOrdersApiGetOrdersRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getOrders(createdAfter: string, createdBefore: string, shipFromPartyId?: string, status?: 'NEW' | 'SHIPPED' | 'ACCEPTED' | 'CANCELLED', limit?: number, sortOrder?: 'ASC' | 'DESC', nextToken?: string, includeDetails?: boolean, options?: any): AxiosPromise<GetOrdersResponse>;
+    getOrders(requestParameters: VendorOrdersApiGetOrdersRequest, options?: AxiosRequestConfig): AxiosPromise<GetOrdersResponse>;
     /**
      * Submits acknowledgements for one or more purchase 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 {SubmitAcknowledgementRequest} body
+     * @param {VendorOrdersApiSubmitAcknowledgementRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    submitAcknowledgement(body: SubmitAcknowledgementRequest, options?: any): AxiosPromise<SubmitAcknowledgementResponse>;
+    submitAcknowledgement(requestParameters: VendorOrdersApiSubmitAcknowledgementRequest, options?: AxiosRequestConfig): AxiosPromise<SubmitAcknowledgementResponse>;
 };
@@ -123,0 +116,0 @@ /**

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

@@ -12,4 +12,4 @@ /**
  */
-import { Configuration } from "./configuration";
-import { AxiosInstance, AxiosRequestConfig } from 'axios';
+import type { Configuration } from './configuration';
+import type { AxiosInstance, AxiosRequestConfig } from 'axios';
 export declare const BASE_PATH: string;
@@ -54,4 +54,3 @@ /**
     field: string;
-    name: "RequiredError";
     constructor(field: string, msg?: string);
 }

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

@@ -13,5 +13,5 @@ /**
 /// <reference types="node" />
-import { Configuration } from "./configuration";
-import { RequestArgs } from "./base";
-import { AxiosInstance, AxiosResponse } from 'axios';
+import type { Configuration } from "./configuration";
+import type { RequestArgs } from "./base";
+import type { AxiosInstance, AxiosResponse } from 'axios';
 /**
@@ -18,0 +18,0 @@ *

package.json

@@ -5,3 +5,3 @@ {
   "description": "The Selling Partner API for Direct Fulfillment Orders provides programmatic access to a direct fulfillment vendor's order data.",
-  "version": "1.9.9",
+  "version": "1.9.10",
   "main": "dist/cjs/index.js",
@@ -30,3 +30,3 @@ "module": "dist/es/index.js",
   "dependencies": {
-    "@sp-api-sdk/common": "^1.9.21",
+    "@sp-api-sdk/common": "^1.9.22",
     "axios": "^0.27.2"
@@ -56,3 +56,3 @@ },
   },
-  "gitHead": "4aae180b5a1395b37b673b93c285065ddba25470"
+  "gitHead": "19982f06cbbd770bfc7b9f1bc8a42f59b57baead"
 }

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Worsened metrics

Total package byte prevSize

163690

decreased by-2.05%

Lines of code

3743

decreased by-0.53%

Dependency changes

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