@sp-api-sdk/orders-api-v0 1.13.1 → 1.15.1

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

@@ -0,0 +1,30 @@
+/**
+ * Selling Partner API for Orders
+ * The Selling Partner API for Orders helps you programmatically retrieve order information. These APIs let you develop fast, flexible, custom applications in areas like order synchronization, order research, and demand-based decision support tools.
+ *
+ * The version of the OpenAPI document: v0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ *
+ * @export
+ * @interface OrderItemsInner
+ */
+export interface OrderItemsInner {
+    /**
+     * The unique identifier of the order item.
+     * @type {string}
+     * @memberof OrderItemsInner
+     */
+    'orderItemId'?: string;
+    /**
+     * The quantity for which to update the shipment status.
+     * @type {number}
+     * @memberof OrderItemsInner
+     */
+    'quantity'?: number;
+}

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

@@ -30,7 +30,7 @@ export interface OrderRegulatedInfo {
      */
     'RegulatedInformation': RegulatedInformation;
     /**
-     * Whether the order requires attaching a dosage information label when shipped.
+     * When true, the order requires attaching a dosage information label when shipped.
      * @type {boolean}
      * @memberof OrderRegulatedInfo
      */

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

@@ -42,7 +42,7 @@ export interface Order {
      */
     'PurchaseDate': string;
     /**
-     * The date when the order was last updated.  Note: LastUpdateDate is returned with an incorrect date for orders that were last updated before 2009-04-01.
+     * The date when the order was last updated.  __Note__: LastUpdateDate is returned with an incorrect date for orders that were last updated before 2009-04-01.
      * @type {string}
      * @memberof Order
      */
@@ -144,13 +144,13 @@ export interface Order {
      */
     'OrderType'?: OrderOrderTypeEnum;
     /**
-     * The start of the time period within which you have committed to ship the order. In ISO 8601 date time format. Returned only for seller-fulfilled orders.  Note: EarliestShipDate might not be returned for orders placed before February 1, 2013.
+     * The start of the time period within which you have committed to ship the order. In ISO 8601 date time format. Returned only for seller-fulfilled orders.  __Note__: EarliestShipDate might not be returned for orders placed before February 1, 2013.
      * @type {string}
      * @memberof Order
      */
     'EarliestShipDate'?: string;
     /**
-     * The end of the time period within which you have committed to ship the order. In ISO 8601 date time format. Returned only for seller-fulfilled orders.  Note: LatestShipDate might not be returned for orders placed before February 1, 2013.
+     * The end of the time period within which you have committed to ship the order. In ISO 8601 date time format. Returned only for seller-fulfilled orders.  __Note__: LatestShipDate might not be returned for orders placed before February 1, 2013.
      * @type {string}
      * @memberof Order
      */

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

@@ -22,19 +22,19 @@ export interface RegulatedInformationField {
      */
     'FieldId': string;
     /**
-     * The human-readable name for the field.
+     * The name for the field.
      * @type {string}
      * @memberof RegulatedInformationField
      */
     'FieldLabel': string;
     /**
-     * The type of field the field.
+     * The type of field.
      * @type {string}
      * @memberof RegulatedInformationField
      */
     'FieldType': RegulatedInformationFieldFieldTypeEnum;
     /**
-     * The content of the field as collected in regulatory form. Note that FileAttachment type fields will contain an URL to download the attachment here.
+     * The content of the field as collected in regulatory form. Note that FileAttachment type fields will contain a URL to download the attachment here.
      * @type {string}
      * @memberof RegulatedInformationField
      */

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

@@ -24,7 +24,7 @@ export interface RegulatedOrderVerificationStatus {
      */
     'Status': VerificationStatus;
     /**
-     * Whether the regulated information provided in the order requires a review by the merchant.
+     * When true, the regulated information provided in the order requires a review by the merchant.
      * @type {boolean}
      * @memberof RegulatedOrderVerificationStatus
      */

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

@@ -22,7 +22,7 @@ export interface RejectionReason {
      */
     'RejectionReasonId': string;
     /**
-     * The human-readable description of this rejection reason.
+     * The description of this rejection reason.
      * @type {string}
      * @memberof RejectionReason
      */

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

@@ -10,7 +10,7 @@
  * Do not edit the class manually.
  */
 /**
- * the status of the shipment of the order to be updated
+ * The shipment status to apply.
  * @export
  * @enum {string}
  */

package/dist/types/src/api-model/models/update-shipment-status-request.d.ts

@@ -9,15 +9,16 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
+import { OrderItemsInner } from './order-items-inner';
 import { ShipmentStatus } from './shipment-status';
 /**
- * Request to update the status of shipment of an order.
+ * The request body for the updateShipmentStatus operation.
  * @export
  * @interface UpdateShipmentStatusRequest
  */
 export interface UpdateShipmentStatusRequest {
     /**
-     * the unobfuscated marketplace ID
+     * The unobfuscated marketplace identifier.
      * @type {string}
      * @memberof UpdateShipmentStatusRequest
      */
@@ -29,9 +30,9 @@ export interface UpdateShipmentStatusRequest {
      */
     'shipmentStatus': ShipmentStatus;
     /**
-     * the list of order items and quantities when the seller wants to partially update the shipment status of the order
-     * @type {Array<object>}
+     * For partial shipment status updates, the list of order items and quantities to be updated.
+     * @type {Array<OrderItemsInner>}
      * @memberof UpdateShipmentStatusRequest
      */
-    'orderItems'?: Array<object>;
+    'orderItems'?: Array<OrderItemsInner>;
 }

package/package.json

@@ -2,11 +2,10 @@
   "name": "@sp-api-sdk/orders-api-v0",
   "author": "Vincent Mesquita <vincent.mesquita@bizon.solutions>",
   "description": "The Selling Partner API for Orders helps you programmatically retrieve order information. These APIs let you develop fast, flexible, custom applications in areas like order synchronization, order research, and demand-based decision support tools.",
-  "version": "1.13.1",
+  "version": "1.15.1",
   "main": "dist/cjs/index.js",
   "module": "dist/es/index.js",
   "types": "dist/types/index.d.ts",
-  "typedocMain": "./index.ts",
   "license": "MIT",
   "publishConfig": {
     "access": "public"
@@ -27,8 +26,8 @@
     "test": "jest"
   },
   "dependencies": {
-    "@sp-api-sdk/auth": "^1.9.17",
-    "@sp-api-sdk/common": "^1.9.3",
+    "@sp-api-sdk/auth": "^1.9.20",
+    "@sp-api-sdk/common": "^1.9.6",
     "axios": "^0.27.2"
   },
   "repository": {
@@ -50,5 +49,8 @@
     "sp sdk",
     "orders api"
   ],
-  "gitHead": "d4f265d3c6a4e05e45025a46effa023a56a54e9c"
+  "typedoc": {
+    "entryPoint": "./index.ts"
+  },
+  "gitHead": "c28c9ce8bfa10271bba79c0067c5c9f63a5f6dc0"
 }