@commercetools/importapi-sdk 6.3.0 → 6.5.0

package/dist/declarations/src/generated/models/inventories.d.ts

@@ -6,47 +6,47 @@
 import { ChannelKeyReference, ImportResource } from "./common.js";
 import { Custom } from "./customfields.js";
 /**
- *	The data representation for an Inventory to be imported that is persisted as a [Inventory](ctp:api:type:InventoryEntry) in the Project.
+ *	Represents the data used to import an InventoryEntry. Once imported, this data is persisted as a [InventoryEntry](ctp:api:type:InventoryEntry) in the Project.
  *
  */
 export interface InventoryImport extends ImportResource {
     /**
-     *	User-defined unique identifier. If an [InventoryEntry](ctp:api:type:InventoryEntry) with this `key` exists, it will be updated with the imported data.
+     *	User-defined unique identifier. If an [InventoryEntry](ctp:api:type:InventoryEntry) with this `key` exists, it is updated with the imported data.
      *
      */
     readonly key: string;
     /**
-     *	Maps to `Inventory.sku`
+     *	Maps to `InventoryEntry.sku`
      *
      *
      */
     readonly sku: string;
     /**
-     *	Maps to `Inventory.quantityOnStock`
+     *	Maps to `InventoryEntry.quantityOnStock`
      *
      *
      */
     readonly quantityOnStock: number;
     /**
-     *	Maps to `Inventory.restockableInDays`
+     *	Maps to `InventoryEntry.restockableInDays`
      *
      *
      */
     readonly restockableInDays?: number;
     /**
-     *	Maps to `Inventory.expectedDelivery`
+     *	Maps to `InventoryEntry.expectedDelivery`
      *
      *
      */
     readonly expectedDelivery?: string;
     /**
-     *	Maps to `Inventory.supplyChannel`
+     *	Maps to `InventoryEntry.supplyChannel`. If the referenced [Channel](ctp:api:type:Channel) does not exist, the `state` of the [ImportOperation](ctp:import:type:ImportOperation) will be set to `unresolved` until the referenced Channel is created.
      *
      *
      */
     readonly supplyChannel?: ChannelKeyReference;
     /**
-     *	Maps to `Inventory.custom`.
+     *	Maps to `InventoryEntry.custom`.
      *
      *
      */

package/dist/declarations/src/generated/models/order-patches.d.ts

@@ -17,125 +17,174 @@ export declare enum ReturnShipmentStateValues {
 export type ReturnShipmentState = 'Advised' | 'BackInStock' | 'Returned' | 'Unusable' | (string & {});
 export interface ReturnItemDraft {
     /**
+     *	Number of Line Items or Custom Line Items to return.
+     *
      *
      */
     readonly quantity: number;
     /**
+     *	`id` of the [LineItem](ctp:api:type:LineItem) to return.
+     *
+     *	Required if Line Items are returned, to create a [LineItemReturnItem](ctp:api:type:LineItemReturnItem).
+     *
      *
      */
     readonly lineItemId?: string;
     /**
+     *	`id` of the [CustomLineItem](ctp:api:type:CustomLineItem) to return.
+     *
+     *	Required if Custom Line Items are returned, to create a [CustomLineItemReturnItem](ctp:api:type:CustomLineItemReturnItem).
+     *
      *
      */
     readonly customLineItemId?: string;
     /**
+     *	User-defined description for the return.
+     *
      *
      */
     readonly comment?: string;
     /**
-     *	Maps to `ReturnItem.shipmentState`
+     *	Shipment status of the item to be returned.
+     *
      *
      */
     readonly shipmentState: ReturnShipmentState;
 }
 export interface ReturnInfo {
     /**
+     *	Information on the Line Items or Custom Line Items returned.
+     *
      *
      */
     readonly items: ReturnItemDraft[];
     /**
-     *	Maps to `ReturnInfo.returnTrackingId`
+     *	User-defined identifier to track the return.
+     *
      *
      */
     readonly returnTrackingId?: string;
     /**
-     *	Maps to `ReturnInfo.returnDate`
+     *	Date and time (UTC) the return is initiated.
+     *
      *
      */
     readonly returnDate?: string;
 }
 export interface DeliveryParcel {
     /**
+     *	Unique identifier of the Delivery.
      *
      */
     readonly deliveryId: string;
     /**
+     *	Information about the dimensions of the Parcel.
+     *
      *
      */
     readonly measurements?: ParcelMeasurements;
     /**
+     *	Shipment tracking information of the Parcel.
+     *
      *
      */
     readonly trackingData?: TrackingData;
     /**
+     *	Line Items or Custom Line Items delivered in this Parcel.
+     *
      *
      */
     readonly items?: DeliveryItem[];
 }
 export interface DeliveryParcelDraft {
     /**
+     *	Information about the dimensions for the Parcel.
+     *
      *
      */
     readonly measurements?: ParcelMeasurements;
     /**
+     *	Shipment tracking information for the Parcel.
+     *
      *
      */
     readonly trackingData?: TrackingData;
     /**
+     *	Line Items or Custom Line Items delivered in this Parcel.
+     *
      *
      */
     readonly items?: DeliveryItem[];
 }
 export interface DeliveryDraft {
     /**
+     *	Line Items or Custom Line Items to deliver. It can also be specified individually for each [Parcel](ctp:api:type:Parcel).
+     *
      *
      */
     readonly items: DeliveryItem[];
     /**
+     *	Address to which the Parcels are delivered.
+     *
      *
      */
     readonly address?: Address;
     /**
+     *	Information regarding the appearance, content, and shipment of a parcel.
+     *
      *
      */
     readonly parcels: DeliveryParcelDraft[];
 }
 export interface DeliveryAddressDraft {
     /**
+     *	Unique identifier of the Delivery.
      *
      */
     readonly deliveryId: string;
     /**
+     *	Address to which Parcels are delivered.
      *
      */
     readonly address?: Address;
 }
 export interface ParcelMeasurementDraft {
     /**
+     *	`id` of an existing [Parcel](ctp:api:type:Parcel).
+     *
      *
      */
     readonly parcelId: string;
     /**
+     *	Information about the dimensions of the Parcel.
+     *
      *
      */
     readonly measurements?: ParcelMeasurements;
 }
 export interface ParcelTrackingData {
     /**
+     *	`id` of an existing [Parcel](ctp:api:type:Parcel).
+     *
      *
      */
     readonly parcelId: string;
     /**
+     *	Information that helps track a Parcel.
+     *
      *
      */
     readonly trackingData?: TrackingData;
 }
 export interface ParcelItems {
     /**
+     *	`id` of an existing [Parcel](ctp:api:type:Parcel).
+     *
      *
      */
     readonly parcelId: string;
     /**
+     *	Items in the Parcel.
      *
      */
     readonly items?: DeliveryItem[];
@@ -148,6 +197,8 @@ export interface RemoveDeliveryDraft {
 }
 export interface RemoveParcelFromDeliveryDraft {
     /**
+     *	`id` of the [Parcel](ctp:api:type:Parcel) to be removed from the Delivery.
+     *
      *
      */
     readonly parcelId: string;
@@ -213,19 +264,18 @@ export interface OrderField {
     readonly setParcelItems?: ParcelItems[];
 }
 /**
- *	Representation for an update of an [Order](ctp:api:type:Order). Use this type to import updates for existing
- *	[Orders](ctp:api:type:Order) in a Project.
+ *	Represents the data used to update an [Order](ctp:api:type:Order) in a Project.
  *
  */
 export interface OrderPatchImport {
     /**
-     *	Maps to `Order.orderNumber`, String that uniquely identifies an order, unique across a project.
+     *	User-defined unique identifier. If an [Order](ctp:api:type:Order) with this `orderNumber` exists, it is updated with the imported data.
      *
      *
      */
     readonly orderNumber: string;
     /**
-     *	Each field referenced must be defined in an already existing order in the project or the import operation state is set to `validationFailed`.
+     *	Each field referenced must be defined in an existing [Order](ctp:api:type:Order) or the [ImportOperationState](ctp:import:type:ImportOperationState) is set to `validationFailed`.
      *
      *
      */

package/dist/declarations/src/generated/models/order-patches.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"order-patches.d.ts","sourceRoot":"../../../../../src/generated/models","sources":["order-patches.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,OAAO,EAAE,oBAAgB;AAClC,OAAO,EAAE,YAAY,EAAE,kBAAkB,EAAE,YAAY,EAAE,oBAAgB;AAEzE;;GAEG;AACH,oBAAY,yBAAyB;IACnC,OAAO,YAAY;IACnB,WAAW,gBAAgB;IAC3B,QAAQ,aAAa;IACrB,QAAQ,aAAa;CACtB;AAED,MAAM,MAAM,mBAAmB,GAC3B,SAAS,GACT,aAAa,GACb,UAAU,GACV,UAAU,GACV,CAAC,MAAM,GAAG,EAAE,CAAC,CAAA;AACjB,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAA;IACzB;;OAEG;IACH,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,CAAA;IAC5B;;OAEG;IACH,QAAQ,CAAC,gBAAgB,CAAC,EAAE,MAAM,CAAA;IAClC;;OAEG;IACH,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,CAAA;IACzB;;;OAGG;IACH,QAAQ,CAAC,aAAa,EAAE,mBAAmB,CAAA;CAC5C;AACD,MAAM,WAAW,UAAU;IACzB;;OAEG;IACH,QAAQ,CAAC,KAAK,EAAE,eAAe,EAAE,CAAA;IACjC;;;OAGG;IACH,QAAQ,CAAC,gBAAgB,CAAC,EAAE,MAAM,CAAA;IAClC;;;OAGG;IACH,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,CAAA;CAC7B;AACD,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAA;IAC3B;;OAEG;IACH,QAAQ,CAAC,YAAY,CAAC,EAAE,kBAAkB,CAAA;IAC1C;;OAEG;IACH,QAAQ,CAAC,YAAY,CAAC,EAAE,YAAY,CAAA;IACpC;;OAEG;IACH,QAAQ,CAAC,KAAK,CAAC,EAAE,YAAY,EAAE,CAAA;CAChC;AACD,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,QAAQ,CAAC,YAAY,CAAC,EAAE,kBAAkB,CAAA;IAC1C;;OAEG;IACH,QAAQ,CAAC,YAAY,CAAC,EAAE,YAAY,CAAA;IACpC;;OAEG;IACH,QAAQ,CAAC,KAAK,CAAC,EAAE,YAAY,EAAE,CAAA;CAChC;AACD,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,QAAQ,CAAC,KAAK,EAAE,YAAY,EAAE,CAAA;IAC9B;;OAEG;IACH,QAAQ,CAAC,OAAO,CAAC,EAAE,OAAO,CAAA;IAC1B;;OAEG;IACH,QAAQ,CAAC,OAAO,EAAE,mBAAmB,EAAE,CAAA;CACxC;AACD,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAA;IAC3B;;OAEG;IACH,QAAQ,CAAC,OAAO,CAAC,EAAE,OAAO,CAAA;CAC3B;AACD,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAA;IACzB;;OAEG;IACH,QAAQ,CAAC,YAAY,CAAC,EAAE,kBAAkB,CAAA;CAC3C;AACD,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAA;IACzB;;OAEG;IACH,QAAQ,CAAC,YAAY,CAAC,EAAE,YAAY,CAAA;CACrC;AACD,MAAM,WAAW,WAAW;IAC1B;;OAEG;IACH,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAA;IACzB;;OAEG;IACH,QAAQ,CAAC,KAAK,CAAC,EAAE,YAAY,EAAE,CAAA;CAChC;AACD,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAA;CACpB;AACD,MAAM,WAAW,6BAA6B;IAC5C;;OAEG;IACH,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAA;CAC1B;AACD;;;GAGG;AACH,MAAM,WAAW,UAAU;IACzB;;;;OAIG;IACH,QAAQ,CAAC,aAAa,CAAC,EAAE,UAAU,CAAA;IACnC;;;;OAIG;IACH,QAAQ,CAAC,mBAAmB,CAAC,EAAE,cAAc,CAAA;IAC7C;;;;OAIG;IACH,QAAQ,CAAC,aAAa,CAAC,EAAE,aAAa,EAAE,CAAA;IACxC;;;;OAIG;IACH,QAAQ,CAAC,cAAc,CAAC,EAAE,mBAAmB,CAAA;IAC7C;;;;OAIG;IACH,QAAQ,CAAC,wBAAwB,CAAC,EAAE,6BAA6B,CAAA;IACjE;;;;OAIG;IACH,QAAQ,CAAC,kBAAkB,CAAC,EAAE,oBAAoB,CAAA;IAClD;;;;OAIG;IACH,QAAQ,CAAC,qBAAqB,CAAC,EAAE,sBAAsB,CAAA;IACvD;;;;OAIG;IACH,QAAQ,CAAC,qBAAqB,CAAC,EAAE,kBAAkB,CAAA;IACnD;;;;OAIG;IACH,QAAQ,CAAC,cAAc,CAAC,EAAE,WAAW,EAAE,CAAA;CACxC;AACD;;;;GAIG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;;;OAIG;IACH,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAA;IAC5B;;;;OAIG;IACH,QAAQ,CAAC,MAAM,EAAE,UAAU,CAAA;CAC5B"}
+{"version":3,"file":"order-patches.d.ts","sourceRoot":"../../../../../src/generated/models","sources":["order-patches.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,OAAO,EAAE,oBAAgB;AAClC,OAAO,EAAE,YAAY,EAAE,kBAAkB,EAAE,YAAY,EAAE,oBAAgB;AAEzE;;GAEG;AACH,oBAAY,yBAAyB;IACnC,OAAO,YAAY;IACnB,WAAW,gBAAgB;IAC3B,QAAQ,aAAa;IACrB,QAAQ,aAAa;CACtB;AAED,MAAM,MAAM,mBAAmB,GAC3B,SAAS,GACT,aAAa,GACb,UAAU,GACV,UAAU,GACV,CAAC,MAAM,GAAG,EAAE,CAAC,CAAA;AACjB,MAAM,WAAW,eAAe;IAC9B;;;;OAIG;IACH,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAA;IACzB;;;;;;OAMG;IACH,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,CAAA;IAC5B;;;;;;OAMG;IACH,QAAQ,CAAC,gBAAgB,CAAC,EAAE,MAAM,CAAA;IAClC;;;;OAIG;IACH,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,CAAA;IACzB;;;;OAIG;IACH,QAAQ,CAAC,aAAa,EAAE,mBAAmB,CAAA;CAC5C;AACD,MAAM,WAAW,UAAU;IACzB;;;;OAIG;IACH,QAAQ,CAAC,KAAK,EAAE,eAAe,EAAE,CAAA;IACjC;;;;OAIG;IACH,QAAQ,CAAC,gBAAgB,CAAC,EAAE,MAAM,CAAA;IAClC;;;;OAIG;IACH,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,CAAA;CAC7B;AACD,MAAM,WAAW,cAAc;IAC7B;;;OAGG;IACH,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAA;IAC3B;;;;OAIG;IACH,QAAQ,CAAC,YAAY,CAAC,EAAE,kBAAkB,CAAA;IAC1C;;;;OAIG;IACH,QAAQ,CAAC,YAAY,CAAC,EAAE,YAAY,CAAA;IACpC;;;;OAIG;IACH,QAAQ,CAAC,KAAK,CAAC,EAAE,YAAY,EAAE,CAAA;CAChC;AACD,MAAM,WAAW,mBAAmB;IAClC;;;;OAIG;IACH,QAAQ,CAAC,YAAY,CAAC,EAAE,kBAAkB,CAAA;IAC1C;;;;OAIG;IACH,QAAQ,CAAC,YAAY,CAAC,EAAE,YAAY,CAAA;IACpC;;;;OAIG;IACH,QAAQ,CAAC,KAAK,CAAC,EAAE,YAAY,EAAE,CAAA;CAChC;AACD,MAAM,WAAW,aAAa;IAC5B;;;;OAIG;IACH,QAAQ,CAAC,KAAK,EAAE,YAAY,EAAE,CAAA;IAC9B;;;;OAIG;IACH,QAAQ,CAAC,OAAO,CAAC,EAAE,OAAO,CAAA;IAC1B;;;;OAIG;IACH,QAAQ,CAAC,OAAO,EAAE,mBAAmB,EAAE,CAAA;CACxC;AACD,MAAM,WAAW,oBAAoB;IACnC;;;OAGG;IACH,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAA;IAC3B;;;OAGG;IACH,QAAQ,CAAC,OAAO,CAAC,EAAE,OAAO,CAAA;CAC3B;AACD,MAAM,WAAW,sBAAsB;IACrC;;;;OAIG;IACH,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAA;IACzB;;;;OAIG;IACH,QAAQ,CAAC,YAAY,CAAC,EAAE,kBAAkB,CAAA;CAC3C;AACD,MAAM,WAAW,kBAAkB;IACjC;;;;OAIG;IACH,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAA;IACzB;;;;OAIG;IACH,QAAQ,CAAC,YAAY,CAAC,EAAE,YAAY,CAAA;CACrC;AACD,MAAM,WAAW,WAAW;IAC1B;;;;OAIG;IACH,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAA;IACzB;;;OAGG;IACH,QAAQ,CAAC,KAAK,CAAC,EAAE,YAAY,EAAE,CAAA;CAChC;AACD,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAA;CACpB;AACD,MAAM,WAAW,6BAA6B;IAC5C;;;;OAIG;IACH,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAA;CAC1B;AACD;;;GAGG;AACH,MAAM,WAAW,UAAU;IACzB;;;;OAIG;IACH,QAAQ,CAAC,aAAa,CAAC,EAAE,UAAU,CAAA;IACnC;;;;OAIG;IACH,QAAQ,CAAC,mBAAmB,CAAC,EAAE,cAAc,CAAA;IAC7C;;;;OAIG;IACH,QAAQ,CAAC,aAAa,CAAC,EAAE,aAAa,EAAE,CAAA;IACxC;;;;OAIG;IACH,QAAQ,CAAC,cAAc,CAAC,EAAE,mBAAmB,CAAA;IAC7C;;;;OAIG;IACH,QAAQ,CAAC,wBAAwB,CAAC,EAAE,6BAA6B,CAAA;IACjE;;;;OAIG;IACH,QAAQ,CAAC,kBAAkB,CAAC,EAAE,oBAAoB,CAAA;IAClD;;;;OAIG;IACH,QAAQ,CAAC,qBAAqB,CAAC,EAAE,sBAAsB,CAAA;IACvD;;;;OAIG;IACH,QAAQ,CAAC,qBAAqB,CAAC,EAAE,kBAAkB,CAAA;IACnD;;;;OAIG;IACH,QAAQ,CAAC,cAAc,CAAC,EAAE,WAAW,EAAE,CAAA;CACxC;AACD;;;GAGG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;;;OAIG;IACH,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAA;IAC5B;;;;OAIG;IACH,QAAQ,CAAC,MAAM,EAAE,UAAU,CAAA;CAC5B"}