@gradientedge/commercetools-utils 5.29.0 → 5.31.0

package/dist/mjs/types/models/inventory.d.ts

@@ -4,7 +4,7 @@
  * For more information about the commercetools platform APIs, visit https://docs.commercetools.com/.
  */
 import { ChannelReference, ChannelResourceIdentifier } from './channel.js';
-import { BaseResource, CreatedBy, LastModifiedBy } from './common.js';
+import { BaseResource, CreatedBy, IReference, IResourceIdentifier, LastModifiedBy } from './common.js';
 import { CustomFields, CustomFieldsDraft, FieldContainer, TypeResourceIdentifier } from './type.js';
 export interface InventoryEntry extends BaseResource {
     /**
@@ -99,7 +99,7 @@ export interface InventoryEntryDraft {
     /**
      *	User-defined unique identifier for the InventoryEntry.
      *
-     *	This field is optional for backwards compatibility reasons, but we strongly recommend setting it. Keys are mandatory for importing InventoryEntries with the [Import API](/../import-export/) and the [Merchant Center](/../merchant-center/import-data).
+     *	This field is optional for backwards compatibility reasons, but we strongly recommend setting it. Keys are mandatory for importing InventoryEntries with the [Import API](/../api/import-export/overview) and the [Merchant Center](/../merchant-center/import-data).
      *
      *
      */
@@ -139,7 +139,7 @@ export interface InventoryEntryDraft {
  *	[Reference](ctp:api:type:Reference) to an [InventoryEntry](ctp:api:type:InventoryEntry).
  *
  */
-export interface InventoryEntryReference {
+export interface InventoryEntryReference extends IReference {
     readonly typeId: 'inventory-entry';
     /**
      *	Unique identifier of the referenced [InventoryEntry](ctp:api:type:InventoryEntry).
@@ -158,7 +158,7 @@ export interface InventoryEntryReference {
  *	[ResourceIdentifier](ctp:api:type:ResourceIdentifier) to an [InventoryEntry](ctp:api:type:InventoryEntry). Either `id` or `key` is required. If both are set, an [InvalidJsonInput](/../api/errors#invalidjsoninput) error is returned.
  *
  */
-export interface InventoryEntryResourceIdentifier {
+export interface InventoryEntryResourceIdentifier extends IResourceIdentifier {
     readonly typeId: 'inventory-entry';
     /**
      *	Unique identifier of the referenced [InventoryEntry](ctp:api:type:InventoryEntry). Required if `key` is absent.
@@ -189,6 +189,12 @@ export interface InventoryEntryUpdate {
     readonly actions: InventoryEntryUpdateAction[];
 }
 export type InventoryEntryUpdateAction = InventoryEntryAddQuantityAction | InventoryEntryChangeQuantityAction | InventoryEntryRemoveQuantityAction | InventoryEntrySetCustomFieldAction | InventoryEntrySetCustomTypeAction | InventoryEntrySetExpectedDeliveryAction | InventoryEntrySetKeyAction | InventoryEntrySetRestockableInDaysAction | InventoryEntrySetSupplyChannelAction;
+export interface IInventoryEntryUpdateAction {
+    /**
+     *
+     */
+    readonly action: string;
+}
 export interface InventoryPagedQueryResponse {
     /**
      *	Number of [results requested](/../api/general-concepts#limit).
@@ -228,7 +234,7 @@ export interface InventoryPagedQueryResponse {
 /**
  *	Updates `availableQuantity` based on the new `quantityOnStock` and amount of active reservations.
  */
-export interface InventoryEntryAddQuantityAction {
+export interface InventoryEntryAddQuantityAction extends IInventoryEntryUpdateAction {
     readonly action: 'addQuantity';
     /**
      *	Value to add to `quantityOnStock`.
@@ -239,7 +245,7 @@ export interface InventoryEntryAddQuantityAction {
 /**
  *	Updates `availableQuantity` based on the new `quantityOnStock` and amount of active reservations.
  */
-export interface InventoryEntryChangeQuantityAction {
+export interface InventoryEntryChangeQuantityAction extends IInventoryEntryUpdateAction {
     readonly action: 'changeQuantity';
     /**
      *	Value to set for `quantityOnStock`.
@@ -250,7 +256,7 @@ export interface InventoryEntryChangeQuantityAction {
 /**
  *	Updates `availableQuantity` based on the new `quantityOnStock` and amount of active reservations.
  */
-export interface InventoryEntryRemoveQuantityAction {
+export interface InventoryEntryRemoveQuantityAction extends IInventoryEntryUpdateAction {
     readonly action: 'removeQuantity';
     /**
      *	Value to remove from `quantityOnStock`.
@@ -258,7 +264,7 @@ export interface InventoryEntryRemoveQuantityAction {
      */
     readonly quantity: number;
 }
-export interface InventoryEntrySetCustomFieldAction {
+export interface InventoryEntrySetCustomFieldAction extends IInventoryEntryUpdateAction {
     readonly action: 'setCustomField';
     /**
      *	Name of the [Custom Field](/../api/projects/custom-fields).
@@ -275,7 +281,7 @@ export interface InventoryEntrySetCustomFieldAction {
      */
     readonly value?: any;
 }
-export interface InventoryEntrySetCustomTypeAction {
+export interface InventoryEntrySetCustomTypeAction extends IInventoryEntryUpdateAction {
     readonly action: 'setCustomType';
     /**
      *	Defines the [Type](ctp:api:type:Type) that extends the InventoryEntry with [Custom Fields](/../api/projects/custom-fields).
@@ -291,7 +297,7 @@ export interface InventoryEntrySetCustomTypeAction {
      */
     readonly fields?: FieldContainer;
 }
-export interface InventoryEntrySetExpectedDeliveryAction {
+export interface InventoryEntrySetExpectedDeliveryAction extends IInventoryEntryUpdateAction {
     readonly action: 'setExpectedDelivery';
     /**
      *	Value to set. If empty, any existing value will be removed.
@@ -299,7 +305,7 @@ export interface InventoryEntrySetExpectedDeliveryAction {
      */
     readonly expectedDelivery?: string;
 }
-export interface InventoryEntrySetKeyAction {
+export interface InventoryEntrySetKeyAction extends IInventoryEntryUpdateAction {
     readonly action: 'setKey';
     /**
      *	Value to set. If empty, any existing value will be removed.
@@ -308,7 +314,7 @@ export interface InventoryEntrySetKeyAction {
      */
     readonly key?: string;
 }
-export interface InventoryEntrySetRestockableInDaysAction {
+export interface InventoryEntrySetRestockableInDaysAction extends IInventoryEntryUpdateAction {
     readonly action: 'setRestockableInDays';
     /**
      *	Value to set. If empty, any existing value will be removed.
@@ -319,7 +325,7 @@ export interface InventoryEntrySetRestockableInDaysAction {
 /**
  *	If an entry with the same `sku` and `supplyChannel` already exists, an [DuplicateField](ctp:api:type:DuplicateFieldError) error is returned.
  */
-export interface InventoryEntrySetSupplyChannelAction {
+export interface InventoryEntrySetSupplyChannelAction extends IInventoryEntryUpdateAction {
     readonly action: 'setSupplyChannel';
     /**
      *	Value to set. If empty, any existing value will be removed.

package/dist/mjs/types/models/inventory.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"inventory.d.ts","sourceRoot":"","sources":["../../../../src/lib/types/models/inventory.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,gBAAgB,EAAE,yBAAyB,EAAE,MAAM,cAAc,CAAA;AAC1E,OAAO,EAAE,YAAY,EAAE,SAAS,EAAE,cAAc,EAAE,MAAM,aAAa,CAAA;AACrE,OAAO,EAAE,YAAY,EAAE,iBAAiB,EAAE,cAAc,EAAE,sBAAsB,EAAE,MAAM,WAAW,CAAA;AAEnG,MAAM,WAAW,cAAe,SAAQ,YAAY;IAClD;;;;OAIG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAA;IACnB;;;;OAIG;IACH,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAA;IACxB;;;;OAIG;IACH,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAA;IAC1B;;;OAGG;IACH,QAAQ,CAAC,cAAc,EAAE,MAAM,CAAA;IAC/B;;;;OAIG;IACH,QAAQ,CAAC,cAAc,CAAC,EAAE,cAAc,CAAA;IACxC;;;;OAIG;IACH,QAAQ,CAAC,SAAS,CAAC,EAAE,SAAS,CAAA;IAC9B;;;;OAIG;IACH,QAAQ,CAAC,GAAG,CAAC,EAAE,MAAM,CAAA;IACrB;;;;OAIG;IACH,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAA;IACpB;;;;OAIG;IACH,QAAQ,CAAC,aAAa,CAAC,EAAE,gBAAgB,CAAA;IACzC;;;OAGG;IACH,QAAQ,CAAC,eAAe,EAAE,MAAM,CAAA;IAChC;;;;OAIG;IACH,QAAQ,CAAC,iBAAiB,EAAE,MAAM,CAAA;IAClC;;;OAGG;IACH,QAAQ,CAAC,iBAAiB,CAAC,EAAE,MAAM,CAAA;IACnC;;;;OAIG;IACH,QAAQ,CAAC,gBAAgB,CAAC,EAAE,MAAM,CAAA;IAClC;;;;OAIG;IACH,QAAQ,CAAC,MAAM,CAAC,EAAE,YAAY,CAAA;CAC/B;AACD,MAAM,WAAW,mBAAmB;IAClC;;;;OAIG;IACH,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAA;IACpB;;;;;;OAMG;IACH,QAAQ,CAAC,GAAG,CAAC,EAAE,MAAM,CAAA;IACrB;;;;OAIG;IACH,QAAQ,CAAC,aAAa,CAAC,EAAE,yBAAyB,CAAA;IAClD;;;;OAIG;IACH,QAAQ,CAAC,eAAe,EAAE,MAAM,CAAA;IAChC;;;;OAIG;IACH,QAAQ,CAAC,iBAAiB,CAAC,EAAE,MAAM,CAAA;IACnC;;;;OAIG;IACH,QAAQ,CAAC,gBAAgB,CAAC,EAAE,MAAM,CAAA;IAClC;;;;OAIG;IACH,QAAQ,CAAC,MAAM,CAAC,EAAE,iBAAiB,CAAA;CACpC;AACD;;;GAGG;AACH,MAAM,WAAW,uBAAuB;IACtC,QAAQ,CAAC,MAAM,EAAE,iBAAiB,CAAA;IAClC;;;;OAIG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAA;IACnB;;;;OAIG;IACH,QAAQ,CAAC,GAAG,CAAC,EAAE,cAAc,CAAA;CAC9B;AACD;;;GAGG;AACH,MAAM,WAAW,gCAAgC;IAC/C,QAAQ,CAAC,MAAM,EAAE,iBAAiB,CAAA;IAClC;;;;OAIG;IACH,QAAQ,CAAC,EAAE,CAAC,EAAE,MAAM,CAAA;IACpB;;;;OAIG;IACH,QAAQ,CAAC,GAAG,CAAC,EAAE,MAAM,CAAA;CACtB;AACD,MAAM,WAAW,oBAAoB;IACnC;;;;;OAKG;IACH,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAA;IACxB;;;;OAIG;IACH,QAAQ,CAAC,OAAO,EAAE,0BAA0B,EAAE,CAAA;CAC/C;AACD,MAAM,MAAM,0BAA0B,GAClC,+BAA+B,GAC/B,kCAAkC,GAClC,kCAAkC,GAClC,kCAAkC,GAClC,iCAAiC,GACjC,uCAAuC,GACvC,0BAA0B,GAC1B,wCAAwC,GACxC,oCAAoC,CAAA;AACxC,MAAM,WAAW,2BAA2B;IAC1C;;;;OAIG;IACH,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAA;IACtB;;;;OAIG;IACH,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAA;IACvB;;;;OAIG;IACH,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAA;IACtB;;;;;;;;OAQG;IACH,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,CAAA;IACvB;;;;OAIG;IACH,QAAQ,CAAC,OAAO,EAAE,cAAc,EAAE,CAAA;CACnC;AACD;;GAEG;AACH,MAAM,WAAW,+BAA+B;IAC9C,QAAQ,CAAC,MAAM,EAAE,aAAa,CAAA;IAC9B;;;OAGG;IACH,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAA;CAC1B;AACD;;GAEG;AACH,MAAM,WAAW,kCAAkC;IACjD,QAAQ,CAAC,MAAM,EAAE,gBAAgB,CAAA;IACjC;;;OAGG;IACH,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAA;CAC1B;AACD;;GAEG;AACH,MAAM,WAAW,kCAAkC;IACjD,QAAQ,CAAC,MAAM,EAAE,gBAAgB,CAAA;IACjC;;;OAGG;IACH,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAA;CAC1B;AACD,MAAM,WAAW,kCAAkC;IACjD,QAAQ,CAAC,MAAM,EAAE,gBAAgB,CAAA;IACjC;;;;OAIG;IACH,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;IACrB;;;;;;OAMG;IACH,QAAQ,CAAC,KAAK,CAAC,EAAE,GAAG,CAAA;CACrB;AACD,MAAM,WAAW,iCAAiC;IAChD,QAAQ,CAAC,MAAM,EAAE,eAAe,CAAA;IAChC;;;;;OAKG;IACH,QAAQ,CAAC,IAAI,CAAC,EAAE,sBAAsB,CAAA;IACtC;;;;OAIG;IACH,QAAQ,CAAC,MAAM,CAAC,EAAE,cAAc,CAAA;CACjC;AACD,MAAM,WAAW,uCAAuC;IACtD,QAAQ,CAAC,MAAM,EAAE,qBAAqB,CAAA;IACtC;;;OAGG;IACH,QAAQ,CAAC,gBAAgB,CAAC,EAAE,MAAM,CAAA;CACnC;AACD,MAAM,WAAW,0BAA0B;IACzC,QAAQ,CAAC,MAAM,EAAE,QAAQ,CAAA;IACzB;;;;OAIG;IACH,QAAQ,CAAC,GAAG,CAAC,EAAE,MAAM,CAAA;CACtB;AACD,MAAM,WAAW,wCAAwC;IACvD,QAAQ,CAAC,MAAM,EAAE,sBAAsB,CAAA;IACvC;;;OAGG;IACH,QAAQ,CAAC,iBAAiB,CAAC,EAAE,MAAM,CAAA;CACpC;AACD;;GAEG;AACH,MAAM,WAAW,oCAAoC;IACnD,QAAQ,CAAC,MAAM,EAAE,kBAAkB,CAAA;IACnC;;;OAGG;IACH,QAAQ,CAAC,aAAa,CAAC,EAAE,yBAAyB,CAAA;CACnD"}
+{"version":3,"file":"inventory.d.ts","sourceRoot":"","sources":["../../../../src/lib/types/models/inventory.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,gBAAgB,EAAE,yBAAyB,EAAE,MAAM,cAAc,CAAA;AAC1E,OAAO,EAAE,YAAY,EAAE,SAAS,EAAE,UAAU,EAAE,mBAAmB,EAAE,cAAc,EAAE,MAAM,aAAa,CAAA;AACtG,OAAO,EAAE,YAAY,EAAE,iBAAiB,EAAE,cAAc,EAAE,sBAAsB,EAAE,MAAM,WAAW,CAAA;AAEnG,MAAM,WAAW,cAAe,SAAQ,YAAY;IAClD;;;;OAIG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAA;IACnB;;;;OAIG;IACH,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAA;IACxB;;;;OAIG;IACH,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAA;IAC1B;;;OAGG;IACH,QAAQ,CAAC,cAAc,EAAE,MAAM,CAAA;IAC/B;;;;OAIG;IACH,QAAQ,CAAC,cAAc,CAAC,EAAE,cAAc,CAAA;IACxC;;;;OAIG;IACH,QAAQ,CAAC,SAAS,CAAC,EAAE,SAAS,CAAA;IAC9B;;;;OAIG;IACH,QAAQ,CAAC,GAAG,CAAC,EAAE,MAAM,CAAA;IACrB;;;;OAIG;IACH,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAA;IACpB;;;;OAIG;IACH,QAAQ,CAAC,aAAa,CAAC,EAAE,gBAAgB,CAAA;IACzC;;;OAGG;IACH,QAAQ,CAAC,eAAe,EAAE,MAAM,CAAA;IAChC;;;;OAIG;IACH,QAAQ,CAAC,iBAAiB,EAAE,MAAM,CAAA;IAClC;;;OAGG;IACH,QAAQ,CAAC,iBAAiB,CAAC,EAAE,MAAM,CAAA;IACnC;;;;OAIG;IACH,QAAQ,CAAC,gBAAgB,CAAC,EAAE,MAAM,CAAA;IAClC;;;;OAIG;IACH,QAAQ,CAAC,MAAM,CAAC,EAAE,YAAY,CAAA;CAC/B;AACD,MAAM,WAAW,mBAAmB;IAClC;;;;OAIG;IACH,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAA;IACpB;;;;;;OAMG;IACH,QAAQ,CAAC,GAAG,CAAC,EAAE,MAAM,CAAA;IACrB;;;;OAIG;IACH,QAAQ,CAAC,aAAa,CAAC,EAAE,yBAAyB,CAAA;IAClD;;;;OAIG;IACH,QAAQ,CAAC,eAAe,EAAE,MAAM,CAAA;IAChC;;;;OAIG;IACH,QAAQ,CAAC,iBAAiB,CAAC,EAAE,MAAM,CAAA;IACnC;;;;OAIG;IACH,QAAQ,CAAC,gBAAgB,CAAC,EAAE,MAAM,CAAA;IAClC;;;;OAIG;IACH,QAAQ,CAAC,MAAM,CAAC,EAAE,iBAAiB,CAAA;CACpC;AACD;;;GAGG;AACH,MAAM,WAAW,uBAAwB,SAAQ,UAAU;IACzD,QAAQ,CAAC,MAAM,EAAE,iBAAiB,CAAA;IAClC;;;;OAIG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAA;IACnB;;;;OAIG;IACH,QAAQ,CAAC,GAAG,CAAC,EAAE,cAAc,CAAA;CAC9B;AACD;;;GAGG;AACH,MAAM,WAAW,gCAAiC,SAAQ,mBAAmB;IAC3E,QAAQ,CAAC,MAAM,EAAE,iBAAiB,CAAA;IAClC;;;;OAIG;IACH,QAAQ,CAAC,EAAE,CAAC,EAAE,MAAM,CAAA;IACpB;;;;OAIG;IACH,QAAQ,CAAC,GAAG,CAAC,EAAE,MAAM,CAAA;CACtB;AACD,MAAM,WAAW,oBAAoB;IACnC;;;;;OAKG;IACH,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAA;IACxB;;;;OAIG;IACH,QAAQ,CAAC,OAAO,EAAE,0BAA0B,EAAE,CAAA;CAC/C;AACD,MAAM,MAAM,0BAA0B,GAClC,+BAA+B,GAC/B,kCAAkC,GAClC,kCAAkC,GAClC,kCAAkC,GAClC,iCAAiC,GACjC,uCAAuC,GACvC,0BAA0B,GAC1B,wCAAwC,GACxC,oCAAoC,CAAA;AACxC,MAAM,WAAW,2BAA2B;IAC1C;;OAEG;IACH,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAA;CACxB;AACD,MAAM,WAAW,2BAA2B;IAC1C;;;;OAIG;IACH,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAA;IACtB;;;;OAIG;IACH,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAA;IACvB;;;;OAIG;IACH,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAA;IACtB;;;;;;;;OAQG;IACH,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,CAAA;IACvB;;;;OAIG;IACH,QAAQ,CAAC,OAAO,EAAE,cAAc,EAAE,CAAA;CACnC;AACD;;GAEG;AACH,MAAM,WAAW,+BAAgC,SAAQ,2BAA2B;IAClF,QAAQ,CAAC,MAAM,EAAE,aAAa,CAAA;IAC9B;;;OAGG;IACH,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAA;CAC1B;AACD;;GAEG;AACH,MAAM,WAAW,kCAAmC,SAAQ,2BAA2B;IACrF,QAAQ,CAAC,MAAM,EAAE,gBAAgB,CAAA;IACjC;;;OAGG;IACH,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAA;CAC1B;AACD;;GAEG;AACH,MAAM,WAAW,kCAAmC,SAAQ,2BAA2B;IACrF,QAAQ,CAAC,MAAM,EAAE,gBAAgB,CAAA;IACjC;;;OAGG;IACH,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAA;CAC1B;AACD,MAAM,WAAW,kCAAmC,SAAQ,2BAA2B;IACrF,QAAQ,CAAC,MAAM,EAAE,gBAAgB,CAAA;IACjC;;;;OAIG;IACH,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;IACrB;;;;;;OAMG;IACH,QAAQ,CAAC,KAAK,CAAC,EAAE,GAAG,CAAA;CACrB;AACD,MAAM,WAAW,iCAAkC,SAAQ,2BAA2B;IACpF,QAAQ,CAAC,MAAM,EAAE,eAAe,CAAA;IAChC;;;;;OAKG;IACH,QAAQ,CAAC,IAAI,CAAC,EAAE,sBAAsB,CAAA;IACtC;;;;OAIG;IACH,QAAQ,CAAC,MAAM,CAAC,EAAE,cAAc,CAAA;CACjC;AACD,MAAM,WAAW,uCAAwC,SAAQ,2BAA2B;IAC1F,QAAQ,CAAC,MAAM,EAAE,qBAAqB,CAAA;IACtC;;;OAGG;IACH,QAAQ,CAAC,gBAAgB,CAAC,EAAE,MAAM,CAAA;CACnC;AACD,MAAM,WAAW,0BAA2B,SAAQ,2BAA2B;IAC7E,QAAQ,CAAC,MAAM,EAAE,QAAQ,CAAA;IACzB;;;;OAIG;IACH,QAAQ,CAAC,GAAG,CAAC,EAAE,MAAM,CAAA;CACtB;AACD,MAAM,WAAW,wCAAyC,SAAQ,2BAA2B;IAC3F,QAAQ,CAAC,MAAM,EAAE,sBAAsB,CAAA;IACvC;;;OAGG;IACH,QAAQ,CAAC,iBAAiB,CAAC,EAAE,MAAM,CAAA;CACpC;AACD;;GAEG;AACH,MAAM,WAAW,oCAAqC,SAAQ,2BAA2B;IACvF,QAAQ,CAAC,MAAM,EAAE,kBAAkB,CAAA;IACnC;;;OAGG;IACH,QAAQ,CAAC,aAAa,CAAC,EAAE,yBAAyB,CAAA;CACnD"}