@sp-api-sdk/vendor-orders-api-v1 2.4.2 → 2.5.1

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

@@ -223,7 +223,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 preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [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 Submits acknowledgements for one or more purchase orders from a vendor.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
@@ -321,7 +321,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 preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [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 Submits acknowledgements for one or more purchase orders from a vendor.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */

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

@@ -217,7 +217,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 preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [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 Submits acknowledgements for one or more purchase orders from a vendor.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
@@ -314,7 +314,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 preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [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 Submits acknowledgements for one or more purchase orders from a vendor.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */

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

@@ -69,7 +69,7 @@ export declare const VendorOrdersApiAxiosParamCreator: (configuration?: Configur
     getPurchaseOrdersStatus: (limit?: number, sortOrder?: GetPurchaseOrdersStatusSortOrderEnum, nextToken?: string, createdAfter?: string, createdBefore?: string, updatedAfter?: string, updatedBefore?: string, purchaseOrderNumber?: string, purchaseOrderStatus?: GetPurchaseOrdersStatusPurchaseOrderStatusEnum, itemConfirmationStatus?: GetPurchaseOrdersStatusItemConfirmationStatusEnum, itemReceiveStatus?: GetPurchaseOrdersStatusItemReceiveStatusEnum, orderingVendorCode?: string, shipToPartyId?: string, 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 preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [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 Submits acknowledgements for one or more purchase orders from a vendor.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
@@ -126,7 +126,7 @@ export declare const VendorOrdersApiFp: (configuration?: Configuration) => {
     getPurchaseOrdersStatus(limit?: number, sortOrder?: GetPurchaseOrdersStatusSortOrderEnum, nextToken?: string, createdAfter?: string, createdBefore?: string, updatedAfter?: string, updatedBefore?: string, purchaseOrderNumber?: string, purchaseOrderStatus?: GetPurchaseOrdersStatusPurchaseOrderStatusEnum, itemConfirmationStatus?: GetPurchaseOrdersStatusItemConfirmationStatusEnum, itemReceiveStatus?: GetPurchaseOrdersStatusItemReceiveStatusEnum, orderingVendorCode?: string, shipToPartyId?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetPurchaseOrdersStatusResponse>>;
     /**
      * 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 preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [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 Submits acknowledgements for one or more purchase orders from a vendor.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
@@ -350,7 +350,7 @@ export interface VendorOrdersApiGetPurchaseOrdersStatusRequest {
  */
 export interface VendorOrdersApiSubmitAcknowledgementRequest {
     /**
-     *
+     * Submits acknowledgements for one or more purchase orders from a vendor.
      * @type {SubmitAcknowledgementRequest}
      * @memberof VendorOrdersApiSubmitAcknowledgement
      */

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

@@ -12,7 +12,7 @@
 import type { OrderAcknowledgementItem } from './order-acknowledgement-item';
 import type { PartyIdentification } from './party-identification';
 /**
- *
+ * Represents an acknowledgement for an order, including the purchase order number, selling party details, acknowledgement date, and a list of acknowledged items.
  * @export
  * @interface OrderAcknowledgement
  */

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

@@ -11,7 +11,7 @@
  */
 import type { ItemQuantity } from './item-quantity';
 /**
- *
+ * Represents the acknowledgement details for an individual order item, including the acknowledgement code, acknowledged quantity, scheduled ship and delivery dates, and rejection reason (if applicable).
  * @export
  * @interface OrderItemAcknowledgement
  */

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

@@ -14,7 +14,7 @@ import type { OrderItemStatusAcknowledgementStatus } from './order-item-status-a
 import type { OrderItemStatusOrderedQuantity } from './order-item-status-ordered-quantity';
 import type { OrderItemStatusReceivingStatus } from './order-item-status-receiving-status';
 /**
- *
+ * Represents the current status of an order item, including acknowledgement and receiving details.
  * @export
  * @interface OrderItemStatus
  */

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

@@ -12,7 +12,7 @@
 import type { ItemQuantity } from './item-quantity';
 import type { Money } from './money';
 /**
- *
+ * Represents an individual item in an order, including item details, quantities, pricing, and backorder information.
  * @export
  * @interface OrderItem
  */

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

@@ -12,7 +12,7 @@
 import type { OrderStatus } from './order-status';
 import type { Pagination } from './pagination';
 /**
- *
+ * A list of order statuses.
  * @export
  * @interface OrderListStatus
  */
@@ -24,7 +24,7 @@ export interface OrderListStatus {
      */
     'pagination'?: Pagination;
     /**
-     *
+     * Represents an order status within the OrderListStatus.
      * @type {Array<OrderStatus>}
      * @memberof OrderListStatus
      */

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

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

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

@@ -11,7 +11,7 @@
  */
 import type { OrderDetails } from './order-details';
 /**
- *
+ * Represents an order placed by Amazon, including the purchase order number, current state, and order details.
  * @export
  * @interface Order
  */

package/dist/types/api-model/models/ordered-quantity-details.d.ts

@@ -11,7 +11,7 @@
  */
 import type { ItemQuantity } from './item-quantity';
 /**
- * Details of item quantity ordered
+ * Details of item quantity ordered.
  * @export
  * @interface OrderedQuantityDetails
  */

package/dist/types/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/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/api-model/models/submit-acknowledgement-request.d.ts

@@ -17,7 +17,7 @@ import type { OrderAcknowledgement } from './order-acknowledgement';
  */
 export interface SubmitAcknowledgementRequest {
     /**
-     *
+     * An array of order acknowledgements to be submitted.
      * @type {Array<OrderAcknowledgement>}
      * @memberof SubmitAcknowledgementRequest
      */

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

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

package/package.json

@@ -2,7 +2,7 @@
   "name": "@sp-api-sdk/vendor-orders-api-v1",
   "author": "Bertrand Marron <bertrand@bizon.solutions>",
   "description": "The Selling Partner API for Retail Procurement Orders provides programmatic access to vendor orders data.",
-  "version": "2.4.2",
+  "version": "2.5.1",
   "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.1.2",
+    "@sp-api-sdk/common": "2.1.3",
     "axios": "^1.7.7"
   },
   "repository": {
@@ -40,5 +40,5 @@
     "sp sdk",
     "vendor orders api"
   ],
-  "gitHead": "cde6991012a79a8483a72ecb1c71d92087f390a6"
+  "gitHead": "197cba539b751c24eb5cfc1dccf6fa4b1d8d4116"
 }