@sp-api-sdk/orders-api-v0 1.14.0 → 1.16.0

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

@@ -0,0 +1,35 @@
+/**
+ * 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.
+ */
+/**
+ * The status of the Amazon Easy-Ship order. This property is included only for Amazon Easy-Ship orders.
+ * @export
+ * @enum {string}
+ */
+export declare const EasyShipShipmentStatus: {
+    readonly PendingSchedule: "PendingSchedule";
+    readonly PendingPickUp: "PendingPickUp";
+    readonly PendingDropOff: "PendingDropOff";
+    readonly LabelCanceled: "LabelCanceled";
+    readonly PickedUp: "PickedUp";
+    readonly DroppedOff: "DroppedOff";
+    readonly AtOriginFc: "AtOriginFC";
+    readonly AtDestinationFc: "AtDestinationFC";
+    readonly Delivered: "Delivered";
+    readonly RejectedByBuyer: "RejectedByBuyer";
+    readonly Undeliverable: "Undeliverable";
+    readonly ReturningToSeller: "ReturningToSeller";
+    readonly ReturnedToSeller: "ReturnedToSeller";
+    readonly Lost: "Lost";
+    readonly OutForDelivery: "OutForDelivery";
+    readonly Damaged: "Damaged";
+};
+export declare type EasyShipShipmentStatus = typeof EasyShipShipmentStatus[keyof typeof EasyShipShipmentStatus];

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

@@ -0,0 +1,24 @@
+/**
+ * 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.
+ */
+/**
+ * The status of the electronic invoice.
+ * @export
+ * @enum {string}
+ */
+export declare const ElectronicInvoiceStatus: {
+    readonly NotRequired: "NotRequired";
+    readonly NotFound: "NotFound";
+    readonly Processing: "Processing";
+    readonly Errored: "Errored";
+    readonly Accepted: "Accepted";
+};
+export declare type ElectronicInvoiceStatus = typeof ElectronicInvoiceStatus[keyof typeof ElectronicInvoiceStatus];

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

@@ -5,6 +5,8 @@ export * from './buyer-info';
 export * from './buyer-requested-cancel';
 export * from './buyer-tax-info';
 export * from './buyer-tax-information';
+export * from './easy-ship-shipment-status';
+export * from './electronic-invoice-status';
 export * from './fulfillment-instruction';
 export * from './get-order-address-response';
 export * from './get-order-buyer-info-response';

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

@@ -22,7 +22,7 @@ export interface ModelError {
      */
     'code': string;
     /**
-     * A message that describes the error condition in a human-readable form.
+     * A message that describes the error condition.
      * @type {string}
      * @memberof ModelError
      */

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

@@ -16,13 +16,13 @@
  */
 export interface OrderItemsInner {
     /**
-     * the unique identifier for the order item
+     * The unique identifier of the order item.
      * @type {string}
      * @memberof OrderItemsInner
      */
     'orderItemId'?: string;
     /**
-     * the quantity of items that needs an update of the shipment status
+     * The quantity for which to update the shipment status.
      * @type {number}
      * @memberof OrderItemsInner
      */

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

@@ -13,6 +13,8 @@ import { Address } from './address';
 import { AutomatedShippingSettings } from './automated-shipping-settings';
 import { BuyerInfo } from './buyer-info';
 import { BuyerTaxInformation } from './buyer-tax-information';
+import { EasyShipShipmentStatus } from './easy-ship-shipment-status';
+import { ElectronicInvoiceStatus } from './electronic-invoice-status';
 import { FulfillmentInstruction } from './fulfillment-instruction';
 import { MarketplaceTaxInfo } from './marketplace-tax-info';
 import { Money } from './money';
@@ -42,7 +44,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
      */
@@ -126,11 +128,11 @@ export interface Order {
      */
     'ShipmentServiceLevelCategory'?: string;
     /**
-     * The status of the Amazon Easy Ship order. This property is included only for Amazon Easy Ship orders.  Possible values: PendingPickUp, LabelCanceled, PickedUp, OutForDelivery, Damaged, Delivered, RejectedByBuyer, Undeliverable, ReturnedToSeller, ReturningToSeller.
-     * @type {string}
+     *
+     * @type {EasyShipShipmentStatus}
      * @memberof Order
      */
-    'EasyShipShipmentStatus'?: string;
+    'EasyShipShipmentStatus'?: EasyShipShipmentStatus;
     /**
      * Custom ship label for Checkout by Amazon (CBA).
      * @type {string}
@@ -144,13 +146,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
      */
@@ -299,6 +301,12 @@ export interface Order {
      * @memberof Order
      */
     'HasRegulatedItems'?: boolean;
+    /**
+     *
+     * @type {ElectronicInvoiceStatus}
+     * @memberof Order
+     */
+    'ElectronicInvoiceStatus'?: ElectronicInvoiceStatus;
 }
 export declare const OrderOrderStatusEnum: {
     readonly Pending: "Pending";

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

@@ -12,13 +12,13 @@
 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
      */
@@ -30,7 +30,7 @@ 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
+     * For partial shipment status updates, the list of order items and quantities to be updated.
      * @type {Array<OrderItemsInner>}
      * @memberof UpdateShipmentStatusRequest
      */

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

@@ -11,7 +11,7 @@
  */
 import { UpdateVerificationStatusRequestBody } from './update-verification-status-request-body';
 /**
- * Request to update the verification status of an order containing regulated products.
+ * The request body for the updateVerificationStatus operation.
  * @export
  * @interface UpdateVerificationStatusRequest
  */

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.14.0",
+  "version": "1.16.0",
   "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.18",
-    "@sp-api-sdk/common": "^1.9.4",
+    "@sp-api-sdk/auth": "^1.9.21",
+    "@sp-api-sdk/common": "^1.9.7",
     "axios": "^0.27.2"
   },
   "repository": {
@@ -50,5 +49,8 @@
     "sp sdk",
     "orders api"
   ],
-  "gitHead": "18efdada205f63f94bd5c11e163e758adbb93257"
+  "typedoc": {
+    "entryPoint": "./index.ts"
+  },
+  "gitHead": "87de54d3e7d47fd187a15c558350620d6c5b50af"
 }