@gradientedge/commercetools-utils 5.27.1 → 5.28.0

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

@@ -0,0 +1,330 @@
+/**
+ * Code generated by [commercetools RMF-Codegen](https://github.com/commercetools/rmf-codegen). DO NOT EDIT.
+ * Please don't change this file manually but run `rmf-codegen generate raml_file_path -o output_path -t typescript_client` to update it.
+ * 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 { CustomFields, CustomFieldsDraft, FieldContainer, TypeResourceIdentifier } from './type.js';
+export interface InventoryEntry extends BaseResource {
+    /**
+     *	Unique identifier of the InventoryEntry.
+     *
+     *
+     */
+    readonly id: string;
+    /**
+     *	Current version of the InventoryEntry.
+     *
+     *
+     */
+    readonly version: number;
+    /**
+     *	Date and time (UTC) the InventoryEntry was initially created.
+     *
+     *
+     */
+    readonly createdAt: string;
+    /**
+     *	Date and time (UTC) the InventoryEntry was last updated.
+     *
+     */
+    readonly lastModifiedAt: string;
+    /**
+     *	IDs and references that last modified the InventoryEntry.
+     *
+     *
+     */
+    readonly lastModifiedBy?: LastModifiedBy;
+    /**
+     *	IDs and references that created the InventoryEntry.
+     *
+     *
+     */
+    readonly createdBy?: CreatedBy;
+    /**
+     *	User-defined unique identifier of the InventoryEntry.
+     *
+     *
+     */
+    readonly key?: string;
+    /**
+     *	[ProductVariant](ctp:api:type:ProductVariant) `sku` of the InventoryEntry.
+     *
+     *
+     */
+    readonly sku: string;
+    /**
+     *	[Channel](ctp:api:type:Channel) that supplies this InventoryEntry.
+     *
+     *
+     */
+    readonly supplyChannel?: ChannelReference;
+    /**
+     *	Overall amount of stock (`availableQuantity` + reserved).
+     *
+     */
+    readonly quantityOnStock: number;
+    /**
+     *	Available amount of stock (`quantityOnStock` - reserved).
+     *
+     *
+     */
+    readonly availableQuantity: number;
+    /**
+     *	How often the InventoryEntry is restocked (in days).
+     *
+     */
+    readonly restockableInDays?: number;
+    /**
+     *	Date and time of the next restock.
+     *
+     *
+     */
+    readonly expectedDelivery?: string;
+    /**
+     *	Custom Fields of the InventoryEntry.
+     *
+     *
+     */
+    readonly custom?: CustomFields;
+}
+export interface InventoryEntryDraft {
+    /**
+     *	[ProductVariant](ctp:api:type:ProductVariant) `sku` of the InventoryEntry.
+     *
+     *
+     */
+    readonly sku: string;
+    /**
+     *	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).
+     *
+     *
+     */
+    readonly key?: string;
+    /**
+     *	[Channel](ctp:api:type:Channel) that supplies this InventoryEntry.
+     *
+     *
+     */
+    readonly supplyChannel?: ChannelResourceIdentifier;
+    /**
+     *	Overall amount of stock.
+     *
+     *
+     */
+    readonly quantityOnStock: number;
+    /**
+     *	How often the InventoryEntry is restocked (in days).
+     *
+     *
+     */
+    readonly restockableInDays?: number;
+    /**
+     *	Date and time of the next restock.
+     *
+     *
+     */
+    readonly expectedDelivery?: string;
+    /**
+     *	Custom Fields of the InventoryEntry.
+     *
+     *
+     */
+    readonly custom?: CustomFieldsDraft;
+}
+/**
+ *	[Reference](ctp:api:type:Reference) to an [InventoryEntry](ctp:api:type:InventoryEntry).
+ *
+ */
+export interface InventoryEntryReference {
+    readonly typeId: 'inventory-entry';
+    /**
+     *	Unique identifier of the referenced [InventoryEntry](ctp:api:type:InventoryEntry).
+     *
+     *
+     */
+    readonly id: string;
+    /**
+     *	Contains the representation of the expanded InventoryEntry. Only present in responses to requests with [Reference Expansion](/../api/general-concepts#reference-expansion) for InventoryEntries.
+     *
+     *
+     */
+    readonly obj?: InventoryEntry;
+}
+/**
+ *	[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 {
+    readonly typeId: 'inventory-entry';
+    /**
+     *	Unique identifier of the referenced [InventoryEntry](ctp:api:type:InventoryEntry). Required if `key` is absent.
+     *
+     *
+     */
+    readonly id?: string;
+    /**
+     *	User-defined unique identifier of the referenced [InventoryEntry](ctp:api:type:InventoryEntry). Required if `id` is absent.
+     *
+     *
+     */
+    readonly key?: string;
+}
+export interface InventoryEntryUpdate {
+    /**
+     *	Expected version of the InventoryEntry on which the changes should be applied.
+     *	If the expected version does not match the actual version, a [ConcurrentModification](ctp:api:type:ConcurrentModificationError) error will be returned.
+     *
+     *
+     */
+    readonly version: number;
+    /**
+     *	Update actions to be performed on the InventoryEntry.
+     *
+     *
+     */
+    readonly actions: InventoryEntryUpdateAction[];
+}
+export type InventoryEntryUpdateAction = InventoryEntryAddQuantityAction | InventoryEntryChangeQuantityAction | InventoryEntryRemoveQuantityAction | InventoryEntrySetCustomFieldAction | InventoryEntrySetCustomTypeAction | InventoryEntrySetExpectedDeliveryAction | InventoryEntrySetKeyAction | InventoryEntrySetRestockableInDaysAction | InventoryEntrySetSupplyChannelAction;
+export interface InventoryPagedQueryResponse {
+    /**
+     *	Number of [results requested](/../api/general-concepts#limit).
+     *
+     *
+     */
+    readonly limit: number;
+    /**
+     *	Number of [elements skipped](/../api/general-concepts#offset).
+     *
+     *
+     */
+    readonly offset: number;
+    /**
+     *	Actual number of results returned.
+     *
+     *
+     */
+    readonly count: number;
+    /**
+     *	Total number of results matching the query.
+     *	This number is an estimation that is not [strongly consistent](/../api/general-concepts#strong-consistency).
+     *	This field is returned by default.
+     *	For improved performance, calculating this field can be deactivated by using the query parameter `withTotal=false`.
+     *	When the results are filtered with a [Query Predicate](/../api/predicates/query), `total` is subject to a [limit](/../api/limits#queries).
+     *
+     *
+     */
+    readonly total?: number;
+    /**
+     *	[Inventory entries](ctp:api:type:InventoryEntry) matching the query.
+     *
+     *
+     */
+    readonly results: InventoryEntry[];
+}
+/**
+ *	Updates `availableQuantity` based on the new `quantityOnStock` and amount of active reservations.
+ */
+export interface InventoryEntryAddQuantityAction {
+    readonly action: 'addQuantity';
+    /**
+     *	Value to add to `quantityOnStock`.
+     *
+     */
+    readonly quantity: number;
+}
+/**
+ *	Updates `availableQuantity` based on the new `quantityOnStock` and amount of active reservations.
+ */
+export interface InventoryEntryChangeQuantityAction {
+    readonly action: 'changeQuantity';
+    /**
+     *	Value to set for `quantityOnStock`.
+     *
+     */
+    readonly quantity: number;
+}
+/**
+ *	Updates `availableQuantity` based on the new `quantityOnStock` and amount of active reservations.
+ */
+export interface InventoryEntryRemoveQuantityAction {
+    readonly action: 'removeQuantity';
+    /**
+     *	Value to remove from `quantityOnStock`.
+     *
+     */
+    readonly quantity: number;
+}
+export interface InventoryEntrySetCustomFieldAction {
+    readonly action: 'setCustomField';
+    /**
+     *	Name of the [Custom Field](/../api/projects/custom-fields).
+     *
+     *
+     */
+    readonly name: string;
+    /**
+     *	If `value` is absent or `null`, this field will be removed if it exists.
+     *	Removing a field that does not exist returns an [InvalidOperation](ctp:api:type:InvalidOperationError) error.
+     *	If `value` is provided, it is set for the field defined by `name`.
+     *
+     *
+     */
+    readonly value?: any;
+}
+export interface InventoryEntrySetCustomTypeAction {
+    readonly action: 'setCustomType';
+    /**
+     *	Defines the [Type](ctp:api:type:Type) that extends the InventoryEntry with [Custom Fields](/../api/projects/custom-fields).
+     *	If absent, any existing Type and Custom Fields are removed from the InventoryEntry.
+     *
+     *
+     */
+    readonly type?: TypeResourceIdentifier;
+    /**
+     *	Sets the [Custom Fields](/../api/projects/custom-fields) fields for the InventoryEntry.
+     *
+     *
+     */
+    readonly fields?: FieldContainer;
+}
+export interface InventoryEntrySetExpectedDeliveryAction {
+    readonly action: 'setExpectedDelivery';
+    /**
+     *	Value to set. If empty, any existing value will be removed.
+     *
+     */
+    readonly expectedDelivery?: string;
+}
+export interface InventoryEntrySetKeyAction {
+    readonly action: 'setKey';
+    /**
+     *	Value to set. If empty, any existing value will be removed.
+     *
+     *
+     */
+    readonly key?: string;
+}
+export interface InventoryEntrySetRestockableInDaysAction {
+    readonly action: 'setRestockableInDays';
+    /**
+     *	Value to set. If empty, any existing value will be removed.
+     *
+     */
+    readonly restockableInDays?: number;
+}
+/**
+ *	If an entry with the same `sku` and `supplyChannel` already exists, an [DuplicateField](ctp:api:type:DuplicateFieldError) error is returned.
+ */
+export interface InventoryEntrySetSupplyChannelAction {
+    readonly action: 'setSupplyChannel';
+    /**
+     *	Value to set. If empty, any existing value will be removed.
+     *
+     */
+    readonly supplyChannel?: ChannelResourceIdentifier;
+}
+//# sourceMappingURL=inventory.d.ts.map

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

@@ -0,0 +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"}

package/dist/mjs/types/models/inventory.js

@@ -0,0 +1,7 @@
+/**
+ * Code generated by [commercetools RMF-Codegen](https://github.com/commercetools/rmf-codegen). DO NOT EDIT.
+ * Please don't change this file manually but run `rmf-codegen generate raml_file_path -o output_path -t typescript_client` to update it.
+ * For more information about the commercetools platform APIs, visit https://docs.commercetools.com/.
+ */
+export {};
+//# sourceMappingURL=inventory.js.map

package/dist/mjs/types/models/inventory.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"inventory.js","sourceRoot":"","sources":["../../../../src/lib/types/models/inventory.ts"],"names":[],"mappings":"AAAA;;;;GAIG"}