@sp-api-sdk/vendor-direct-fulfillment-orders-api-v1 2.3.1 → 2.4.0

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

@@ -123,7 +123,7 @@ const VendorOrdersApiAxiosParamCreator = function (configuration) {
         },
         /**
          * Submits acknowledgements for one or more purchase orders.  **Usage Plan:**  | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 |  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 {SubmitAcknowledgementRequest} body
+         * @param {SubmitAcknowledgementRequest} body The request body that contains the order acknowledgement.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
@@ -193,7 +193,7 @@ const VendorOrdersApiFp = function (configuration) {
         },
         /**
          * Submits acknowledgements for one or more purchase orders.  **Usage Plan:**  | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 |  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 {SubmitAcknowledgementRequest} body
+         * @param {SubmitAcknowledgementRequest} body The request body that contains the order acknowledgement.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */

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

@@ -117,7 +117,7 @@ export const VendorOrdersApiAxiosParamCreator = function (configuration) {
         },
         /**
          * Submits acknowledgements for one or more purchase orders.  **Usage Plan:**  | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 |  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 {SubmitAcknowledgementRequest} body
+         * @param {SubmitAcknowledgementRequest} body The request body that contains the order acknowledgement.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
@@ -186,7 +186,7 @@ export const VendorOrdersApiFp = function (configuration) {
         },
         /**
          * Submits acknowledgements for one or more purchase orders.  **Usage Plan:**  | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 |  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 {SubmitAcknowledgementRequest} body
+         * @param {SubmitAcknowledgementRequest} body The request body that contains the order acknowledgement.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */

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

@@ -45,7 +45,7 @@ export declare const VendorOrdersApiAxiosParamCreator: (configuration?: Configur
     getOrders: (createdAfter: string, createdBefore: string, shipFromPartyId?: string, status?: GetOrdersStatusEnum, limit?: number, sortOrder?: GetOrdersSortOrderEnum, nextToken?: string, includeDetails?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * Submits acknowledgements for one or more purchase orders.  **Usage Plan:**  | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 |  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 {SubmitAcknowledgementRequest} body
+     * @param {SubmitAcknowledgementRequest} body The request body that contains the order acknowledgement.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
@@ -79,7 +79,7 @@ export declare const VendorOrdersApiFp: (configuration?: Configuration) => {
     getOrders(createdAfter: string, createdBefore: string, shipFromPartyId?: string, status?: GetOrdersStatusEnum, limit?: number, sortOrder?: GetOrdersSortOrderEnum, nextToken?: string, includeDetails?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetOrdersResponse>>;
     /**
      * Submits acknowledgements for one or more purchase orders.  **Usage Plan:**  | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 |  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 {SubmitAcknowledgementRequest} body
+     * @param {SubmitAcknowledgementRequest} body The request body that contains the order acknowledgement.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
@@ -187,7 +187,7 @@ export interface VendorOrdersApiGetOrdersRequest {
  */
 export interface VendorOrdersApiSubmitAcknowledgementRequest {
     /**
-     *
+     * The request body that contains the order acknowledgement.
      * @type {SubmitAcknowledgementRequest}
      * @memberof VendorOrdersApiSubmitAcknowledgement
      */

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

@@ -9,7 +9,6 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
-/// <reference types="node" />
 import type { Configuration } from "./configuration";
 import type { RequestArgs } from "./base";
 import type { AxiosInstance, AxiosResponse } from 'axios';

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

@@ -16,7 +16,7 @@
  */
 export interface Address {
     /**
-     * The name of the person, business or institution at that address. For Amazon label only vendors, this field will have the value `xxxxx` within the object `shipToParty`.
+     * The name of the person, business, or institution at that address. For Amazon label only vendors, this field will have the value `xxxxx` within the object `shipToParty`.
      * @type {string}
      * @memberof Address
      */
@@ -46,19 +46,19 @@ export interface Address {
      */
     'addressLine3'?: string;
     /**
-     * The city where the person, business or institution is located. For Amazon label only vendors, this field will have the value `xxxxx` within the object `shipToParty`.
+     * The city where the person, business, or institution is located. For Amazon label only vendors, this field will have the value `xxxxx` within the object `shipToParty`.
      * @type {string}
      * @memberof Address
      */
     'city'?: string;
     /**
-     * The county where person, business or institution is located. For Amazon label only vendors, this field will have the value `xxxxx` within the object `shipToParty`.
+     * The county where the person, business, or institution is located. For Amazon label only vendors, this field will have the value `xxxxx` within the object `shipToParty`.
      * @type {string}
      * @memberof Address
      */
     'county'?: string;
     /**
-     * The district where person, business or institution is located. For Amazon label only vendors, this field will have the value `xxxxx` within the object `shipToParty`.
+     * The district where the person, business, or institution is located. For Amazon label only vendors, this field will have the value `xxxxx` within the object `shipToParty`.
      * @type {string}
      * @memberof Address
      */
@@ -82,7 +82,7 @@ export interface Address {
      */
     'countryCode': string;
     /**
-     * The phone number of the person, business or institution located at that address. For Amazon label only vendors, this field will have the value `xxxxx` within the object `shipToParty`.
+     * The phone number of the person, business, or institution located at that address. For Amazon label only vendors, this field will have the value `xxxxx` within the object `shipToParty`.
      * @type {string}
      * @memberof Address
      */

package/dist/types/src/api-model/models/order-details-tax-total.d.ts

@@ -11,7 +11,7 @@
  */
 import type { TaxDetails } from './tax-details';
 /**
- *
+ * The total tax object within the shipment that relates to the order.
  * @export
  * @interface OrderDetailsTaxTotal
  */

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

@@ -11,7 +11,7 @@
  */
 import type { ItemQuantity } from './item-quantity';
 /**
- *
+ * Individual item details within the acknowledged order.
  * @export
  * @interface OrderItemAcknowledgement
  */

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

@@ -15,7 +15,7 @@ import type { Money } from './money';
 import type { OrderItemTaxDetails } from './order-item-tax-details';
 import type { ScheduledDeliveryShipment } from './scheduled-delivery-shipment';
 /**
- *
+ * An order item.
  * @export
  * @interface OrderItem
  */

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

@@ -12,7 +12,7 @@
 import type { Order } from './order';
 import type { Pagination } from './pagination';
 /**
- *
+ * A purchase orders list returned as a response.
  * @export
  * @interface OrderList
  */
@@ -24,7 +24,7 @@ export interface OrderList {
      */
     'pagination'?: Pagination;
     /**
-     *
+     * Represents a purchase order within the `OrderList`.
      * @type {Array<Order>}
      * @memberof OrderList
      */

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

@@ -11,7 +11,7 @@
  */
 import type { OrderDetails } from './order-details';
 /**
- *
+ * Represents a purchase order.
  * @export
  * @interface Order
  */

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

@@ -10,7 +10,7 @@
  * Do not edit the class manually.
  */
 /**
- *
+ * The pagination elements required to retrieve the remaining data.
  * @export
  * @interface Pagination
  */

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

@@ -12,7 +12,7 @@
 import type { Address } from './address';
 import type { TaxRegistrationDetails } from './tax-registration-details';
 /**
- *
+ * Name, address, and tax details of a party.
  * @export
  * @interface PartyIdentification
  */

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

@@ -11,7 +11,7 @@
  */
 import type { Money } from './money';
 /**
- *
+ * The order\'s tax details.
  * @export
  * @interface TaxDetails
  */

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

@@ -10,7 +10,7 @@
  * Do not edit the class manually.
  */
 /**
- *
+ * Response that contains the transaction ID.
  * @export
  * @interface TransactionId
  */

package/package.json

@@ -2,7 +2,7 @@
   "name": "@sp-api-sdk/vendor-direct-fulfillment-orders-api-v1",
   "author": "Bertrand Marron <bertrand@bizon.solutions>",
   "description": "The Selling Partner API for Direct Fulfillment Orders provides programmatic access to a direct fulfillment vendor's order data.",
-  "version": "2.3.1",
+  "version": "2.4.0",
   "main": "dist/cjs/index.js",
   "module": "dist/es/index.js",
   "types": "dist/types/index.d.ts",
@@ -18,7 +18,7 @@
     "dist/**/*.d.ts"
   ],
   "dependencies": {
-    "@sp-api-sdk/common": "2.0.9",
+    "@sp-api-sdk/common": "2.0.10",
     "axios": "^1.7.2"
   },
   "repository": {
@@ -40,5 +40,5 @@
     "sp sdk",
     "vendor direct fulfillment orders api"
   ],
-  "gitHead": "cce8c720364baf071322463e8e3ed29c322cc93a"
+  "gitHead": "c646647a684e625c54e35ff8c141791efd60417c"
 }