@medusajs/types 1.12.0-snapshot-20240403120107 → 1.12.0-snapshot-20240405154416

package/dist/http/fulfillment/admin/shipping-option.d.ts

@@ -0,0 +1,31 @@
+import { ShippingOptionPriceType } from "../../../fulfillment";
+import { AdminServiceZoneResponse } from "./service-zone";
+import { AdminShippingOptionTypeResponse } from "./shipping-option-type";
+import { AdminShippingOptionRuleResponse } from "./shipping-option-rule";
+import { AdminShippingProfileResponse } from "./shipping-profile";
+import { AdminFulfillmentProviderResponse } from "./fulfillment-provider";
+import { AdminFulfillmentResponse } from "./fulfillment";
+/**
+ * @experimental
+ */
+export interface AdminShippingOptionResponse {
+    id: string;
+    name: string;
+    price_type: ShippingOptionPriceType;
+    service_zone_id: string;
+    shipping_profile_id: string;
+    provider_id: string;
+    shipping_option_type_id: string | null;
+    data: Record<string, unknown> | null;
+    metadata: Record<string, unknown> | null;
+    service_zone: AdminServiceZoneResponse;
+    shipping_profile: AdminShippingProfileResponse;
+    fulfillment_provider: AdminFulfillmentProviderResponse;
+    type: AdminShippingOptionTypeResponse;
+    rules: AdminShippingOptionRuleResponse[];
+    fulfillments: AdminFulfillmentResponse[];
+    created_at: Date;
+    updated_at: Date;
+    deleted_at: Date | null;
+}
+//# sourceMappingURL=shipping-option.d.ts.map

package/dist/http/fulfillment/admin/shipping-option.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"shipping-option.d.ts","sourceRoot":"","sources":["../../../../src/http/fulfillment/admin/shipping-option.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,uBAAuB,EAAE,MAAM,sBAAsB,CAAA;AAC9D,OAAO,EAAE,wBAAwB,EAAE,MAAM,gBAAgB,CAAA;AACzD,OAAO,EAAE,+BAA+B,EAAE,MAAM,wBAAwB,CAAA;AACxE,OAAO,EAAE,+BAA+B,EAAE,MAAM,wBAAwB,CAAA;AACxE,OAAO,EAAE,4BAA4B,EAAE,MAAM,oBAAoB,CAAA;AACjE,OAAO,EAAE,gCAAgC,EAAE,MAAM,wBAAwB,CAAA;AACzE,OAAO,EAAE,wBAAwB,EAAE,MAAM,eAAe,CAAA;AAExD;;GAEG;AACH,MAAM,WAAW,2BAA2B;IAC1C,EAAE,EAAE,MAAM,CAAA;IACV,IAAI,EAAE,MAAM,CAAA;IACZ,UAAU,EAAE,uBAAuB,CAAA;IACnC,eAAe,EAAE,MAAM,CAAA;IACvB,mBAAmB,EAAE,MAAM,CAAA;IAC3B,WAAW,EAAE,MAAM,CAAA;IACnB,uBAAuB,EAAE,MAAM,GAAG,IAAI,CAAA;IACtC,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAA;IACpC,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAA;IACxC,YAAY,EAAE,wBAAwB,CAAA;IACtC,gBAAgB,EAAE,4BAA4B,CAAA;IAC9C,oBAAoB,EAAE,gCAAgC,CAAA;IACtD,IAAI,EAAE,+BAA+B,CAAA;IACrC,KAAK,EAAE,+BAA+B,EAAE,CAAA;IACxC,YAAY,EAAE,wBAAwB,EAAE,CAAA;IACxC,UAAU,EAAE,IAAI,CAAA;IAChB,UAAU,EAAE,IAAI,CAAA;IAChB,UAAU,EAAE,IAAI,GAAG,IAAI,CAAA;CACxB"}

package/dist/http/fulfillment/admin/shipping-option.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=shipping-option.js.map

package/dist/http/fulfillment/admin/shipping-option.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"shipping-option.js","sourceRoot":"","sources":["../../../../src/http/fulfillment/admin/shipping-option.ts"],"names":[],"mappings":""}

package/dist/http/fulfillment/admin/shipping-profile.d.ts

@@ -0,0 +1,13 @@
+/**
+ * @experimental
+ */
+export interface AdminShippingProfileResponse {
+    id: string;
+    name: string;
+    type: string;
+    metadata: Record<string, unknown> | null;
+    created_at: Date;
+    updated_at: Date;
+    deleted_at: Date | null;
+}
+//# sourceMappingURL=shipping-profile.d.ts.map

package/dist/http/fulfillment/admin/shipping-profile.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"shipping-profile.d.ts","sourceRoot":"","sources":["../../../../src/http/fulfillment/admin/shipping-profile.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,WAAW,4BAA4B;IAC3C,EAAE,EAAE,MAAM,CAAA;IACV,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,EAAE,MAAM,CAAA;IACZ,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAA;IACxC,UAAU,EAAE,IAAI,CAAA;IAChB,UAAU,EAAE,IAAI,CAAA;IAChB,UAAU,EAAE,IAAI,GAAG,IAAI,CAAA;CACxB"}

package/dist/http/fulfillment/admin/shipping-profile.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=shipping-profile.js.map

package/dist/http/fulfillment/admin/shipping-profile.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"shipping-profile.js","sourceRoot":"","sources":["../../../../src/http/fulfillment/admin/shipping-profile.ts"],"names":[],"mappings":""}

package/dist/http/fulfillment/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./admin";
+//# sourceMappingURL=index.d.ts.map

package/dist/http/fulfillment/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/http/fulfillment/index.ts"],"names":[],"mappings":"AAAA,cAAc,SAAS,CAAA"}

package/dist/http/fulfillment/index.js

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./admin"), exports);
+//# sourceMappingURL=index.js.map

package/dist/http/fulfillment/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/http/fulfillment/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,0CAAuB"}

package/dist/http/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./fulfillment";
+//# sourceMappingURL=index.d.ts.map

package/dist/http/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/http/index.ts"],"names":[],"mappings":"AAAA,cAAc,eAAe,CAAA"}

package/dist/http/index.js

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./fulfillment"), exports);
+//# sourceMappingURL=index.js.map

package/dist/http/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/http/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,gDAA6B"}

package/dist/index.d.ts

@@ -35,4 +35,6 @@ export * from "./transaction-base";
 export * from "./user";
 export * from "./workflow";
 export * from "./currency";
+export * from "./http";
+export * from "./file";
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,WAAW,CAAA;AACzB,cAAc,WAAW,CAAA;AACzB,cAAc,QAAQ,CAAA;AACtB,cAAc,WAAW,CAAA;AACzB,cAAc,SAAS,CAAA;AACvB,cAAc,QAAQ,CAAA;AACtB,cAAc,UAAU,CAAA;AACxB,cAAc,YAAY,CAAA;AAC1B,cAAc,OAAO,CAAA;AACrB,cAAc,aAAa,CAAA;AAC3B,cAAc,gBAAgB,CAAA;AAC9B,cAAc,gBAAgB,CAAA;AAC9B,cAAc,eAAe,CAAA;AAC7B,cAAc,aAAa,CAAA;AAC3B,cAAc,UAAU,CAAA;AACxB,cAAc,gBAAgB,CAAA;AAC9B,cAAc,UAAU,CAAA;AACxB,cAAc,eAAe,CAAA;AAC7B,cAAc,SAAS,CAAA;AACvB,cAAc,WAAW,CAAA;AACzB,cAAc,WAAW,CAAA;AACzB,cAAc,WAAW,CAAA;AACzB,cAAc,oBAAoB,CAAA;AAClC,cAAc,aAAa,CAAA;AAC3B,cAAc,UAAU,CAAA;AACxB,cAAc,kBAAkB,CAAA;AAChC,cAAc,iBAAiB,CAAA;AAC/B,cAAc,UAAU,CAAA;AACxB,cAAc,kBAAkB,CAAA;AAChC,cAAc,kBAAkB,CAAA;AAChC,cAAc,SAAS,CAAA;AACvB,cAAc,OAAO,CAAA;AACrB,cAAc,UAAU,CAAA;AACxB,cAAc,oBAAoB,CAAA;AAClC,cAAc,QAAQ,CAAA;AACtB,cAAc,YAAY,CAAA;AAC1B,cAAc,YAAY,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,WAAW,CAAA;AACzB,cAAc,WAAW,CAAA;AACzB,cAAc,QAAQ,CAAA;AACtB,cAAc,WAAW,CAAA;AACzB,cAAc,SAAS,CAAA;AACvB,cAAc,QAAQ,CAAA;AACtB,cAAc,UAAU,CAAA;AACxB,cAAc,YAAY,CAAA;AAC1B,cAAc,OAAO,CAAA;AACrB,cAAc,aAAa,CAAA;AAC3B,cAAc,gBAAgB,CAAA;AAC9B,cAAc,gBAAgB,CAAA;AAC9B,cAAc,eAAe,CAAA;AAC7B,cAAc,aAAa,CAAA;AAC3B,cAAc,UAAU,CAAA;AACxB,cAAc,gBAAgB,CAAA;AAC9B,cAAc,UAAU,CAAA;AACxB,cAAc,eAAe,CAAA;AAC7B,cAAc,SAAS,CAAA;AACvB,cAAc,WAAW,CAAA;AACzB,cAAc,WAAW,CAAA;AACzB,cAAc,WAAW,CAAA;AACzB,cAAc,oBAAoB,CAAA;AAClC,cAAc,aAAa,CAAA;AAC3B,cAAc,UAAU,CAAA;AACxB,cAAc,kBAAkB,CAAA;AAChC,cAAc,iBAAiB,CAAA;AAC/B,cAAc,UAAU,CAAA;AACxB,cAAc,kBAAkB,CAAA;AAChC,cAAc,kBAAkB,CAAA;AAChC,cAAc,SAAS,CAAA;AACvB,cAAc,OAAO,CAAA;AACrB,cAAc,UAAU,CAAA;AACxB,cAAc,oBAAoB,CAAA;AAClC,cAAc,QAAQ,CAAA;AACtB,cAAc,YAAY,CAAA;AAC1B,cAAc,YAAY,CAAA;AAC1B,cAAc,QAAQ,CAAA;AACtB,cAAc,QAAQ,CAAA"}

package/dist/index.js

@@ -51,4 +51,6 @@ __exportStar(require("./transaction-base"), exports);
 __exportStar(require("./user"), exports);
 __exportStar(require("./workflow"), exports);
 __exportStar(require("./currency"), exports);
+__exportStar(require("./http"), exports);
+__exportStar(require("./file"), exports);
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,4CAAyB;AACzB,4CAAyB;AACzB,yCAAsB;AACtB,4CAAyB;AACzB,0CAAuB;AACvB,yCAAsB;AACtB,2CAAwB;AACxB,6CAA0B;AAC1B,wCAAqB;AACrB,8CAA2B;AAC3B,iDAA8B;AAC9B,iDAA8B;AAC9B,gDAA6B;AAC7B,8CAA2B;AAC3B,2CAAwB;AACxB,iDAA8B;AAC9B,2CAAwB;AACxB,gDAA6B;AAC7B,0CAAuB;AACvB,4CAAyB;AACzB,4CAAyB;AACzB,4CAAyB;AACzB,qDAAkC;AAClC,8CAA2B;AAC3B,2CAAwB;AACxB,mDAAgC;AAChC,kDAA+B;AAC/B,2CAAwB;AACxB,mDAAgC;AAChC,mDAAgC;AAChC,0CAAuB;AACvB,wCAAqB;AACrB,2CAAwB;AACxB,qDAAkC;AAClC,yCAAsB;AACtB,6CAA0B;AAC1B,6CAA0B"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,4CAAyB;AACzB,4CAAyB;AACzB,yCAAsB;AACtB,4CAAyB;AACzB,0CAAuB;AACvB,yCAAsB;AACtB,2CAAwB;AACxB,6CAA0B;AAC1B,wCAAqB;AACrB,8CAA2B;AAC3B,iDAA8B;AAC9B,iDAA8B;AAC9B,gDAA6B;AAC7B,8CAA2B;AAC3B,2CAAwB;AACxB,iDAA8B;AAC9B,2CAAwB;AACxB,gDAA6B;AAC7B,0CAAuB;AACvB,4CAAyB;AACzB,4CAAyB;AACzB,4CAAyB;AACzB,qDAAkC;AAClC,8CAA2B;AAC3B,2CAAwB;AACxB,mDAAgC;AAChC,kDAA+B;AAC/B,2CAAwB;AACxB,mDAAgC;AAChC,mDAAgC;AAChC,0CAAuB;AACvB,wCAAqB;AACrB,2CAAwB;AACxB,qDAAkC;AAClC,yCAAsB;AACtB,6CAA0B;AAC1B,6CAA0B;AAC1B,yCAAsB;AACtB,yCAAsB"}

package/dist/inventory/common/inventory-item.d.ts

@@ -1,88 +1,79 @@
 import { StringComparisonOperator } from "../../common";
 /**
- * @schema InventoryItemDTO
- * type: object
- * required:
- *   - sku
- * properties:
- *   id:
- *     description: The inventory item's ID.
- *     type: string
- *     example: "iitem_12334"
- *   sku:
- *     description: The Stock Keeping Unit (SKU) code of the Inventory Item.
- *     type: string
- *   hs_code:
- *     description: The Harmonized System code of the Inventory Item. May be used by Fulfillment Providers to pass customs information to shipping carriers.
- *     type: string
- *   origin_country:
- *     description: The country in which the Inventory Item was produced. May be used by Fulfillment Providers to pass customs information to shipping carriers.
- *     type: string
- *   mid_code:
- *     description: The Manufacturers Identification code that identifies the manufacturer of the Inventory Item. May be used by Fulfillment Providers to pass customs information to shipping carriers.
- *     type: string
- *   title:
- *     description: "Title of the inventory item"
- *     type: string
- *   description:
- *     description: "Description of the inventory item"
- *     type: string
- *   thumbnail:
- *     description: "Thumbnail for the inventory item"
- *     type: string
- *   material:
- *     description: The material and composition that the Inventory Item is made of, May be used by Fulfillment Providers to pass customs information to shipping carriers.
- *     type: string
- *   weight:
- *     description: The weight of the Inventory Item. May be used in shipping rate calculations.
- *     type: number
- *   height:
- *     description: The height of the Inventory Item. May be used in shipping rate calculations.
- *     type: number
- *   width:
- *     description: The width of the Inventory Item. May be used in shipping rate calculations.
- *     type: number
- *   length:
- *     description: The length of the Inventory Item. May be used in shipping rate calculations.
- *     type: number
- *   requires_shipping:
- *     description: Whether the item requires shipping.
- *     type: boolean
- *   metadata:
- *     type: object
- *     description: An optional key-value map with additional details
- *     example: {car: "white"}
- *   created_at:
- *     type: string
- *     description: "The date with timezone at which the resource was created."
- *     format: date-time
- *   updated_at:
- *     type: string
- *     description: "The date with timezone at which the resource was updated."
- *     format: date-time
- *   deleted_at:
- *     type: string
- *     description: "The date with timezone at which the resource was deleted."
- *     format: date-time
+ * The inventory item details.
  */
 export interface InventoryItemDTO {
+    /**
+     * The ID of the inventory item.
+     */
     id: string;
+    /**
+     * The SKU of the inventory item.
+     */
     sku?: string | null;
+    /**
+     * The origin country of the inventory item.
+     */
     origin_country?: string | null;
+    /**
+     * The HS code of the inventory item.
+     */
     hs_code?: string | null;
+    /**
+     * Whether the inventory item requires shipping.
+     */
     requires_shipping: boolean;
+    /**
+     * The mid code of the inventory item.
+     */
     mid_code?: string | null;
+    /**
+     * The material of the inventory item.
+     */
     material?: string | null;
+    /**
+     * The weight of the inventory item.
+     */
     weight?: number | null;
+    /**
+     * The length of the inventory item.
+     */
     length?: number | null;
+    /**
+     * The height of the inventory item.
+     */
     height?: number | null;
+    /**
+     * The width of the inventory item.
+     */
     width?: number | null;
+    /**
+     * The title of the inventory item.
+     */
     title?: string | null;
+    /**
+     * The description of the inventory item.
+     */
     description?: string | null;
+    /**
+     * The thumbnail of the inventory item.
+     */
     thumbnail?: string | null;
+    /**
+     * Holds custom data in key-value pairs.
+     */
     metadata?: Record<string, unknown> | null;
+    /**
+     * The creation date of the inventory item.
+     */
     created_at: string | Date;
+    /**
+     * The update date of the inventory item.
+     */
     updated_at: string | Date;
+    /**
+     * The deletion date of the inventory item.
+     */
     deleted_at: string | Date | null;
 }
 /**

package/dist/inventory/common/inventory-item.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"inventory-item.d.ts","sourceRoot":"","sources":["../../../src/inventory/common/inventory-item.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,wBAAwB,EAAE,MAAM,cAAc,CAAA;AAEvD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiEG;AACH,MAAM,WAAW,gBAAgB;IAC/B,EAAE,EAAE,MAAM,CAAA;IACV,GAAG,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACnB,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAC9B,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACvB,iBAAiB,EAAE,OAAO,CAAA;IAC1B,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACxB,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACxB,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACtB,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACtB,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACtB,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACrB,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACrB,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAC3B,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACzB,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAA;IACzC,UAAU,EAAE,MAAM,GAAG,IAAI,CAAA;IACzB,UAAU,EAAE,MAAM,GAAG,IAAI,CAAA;IACzB,UAAU,EAAE,MAAM,GAAG,IAAI,GAAG,IAAI,CAAA;CACjC;AAED;;;;GAIG;AACH,MAAM,WAAW,4BAA4B;IAC3C;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IACtB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IAC/B;;OAEG;IACH,CAAC,CAAC,EAAE,MAAM,CAAA;IACV;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,wBAAwB,CAAA;IAClD;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IAClC;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,wBAAwB,CAAA;IACtD;;OAEG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAA;CAC5B"}
+{"version":3,"file":"inventory-item.d.ts","sourceRoot":"","sources":["../../../src/inventory/common/inventory-item.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,wBAAwB,EAAE,MAAM,cAAc,CAAA;AAEvD;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAA;IAEV;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAEnB;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAE9B;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAEvB;;OAEG;IACH,iBAAiB,EAAE,OAAO,CAAA;IAE1B;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAExB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAExB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAEtB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAEtB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAEtB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAErB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAErB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAE3B;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAEzB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAA;IAEzC;;OAEG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAA;IAEzB;;OAEG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAA;IAEzB;;OAEG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,GAAG,IAAI,CAAA;CACjC;AAED;;;;GAIG;AACH,MAAM,WAAW,4BAA4B;IAC3C;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IAEtB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IAE/B;;OAEG;IACH,CAAC,CAAC,EAAE,MAAM,CAAA;IAEV;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,wBAAwB,CAAA;IAElD;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IAElC;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,wBAAwB,CAAA;IAEtD;;OAEG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAA;CAC5B"}

package/dist/inventory/common/inventory-level.d.ts

@@ -1,56 +1,56 @@
 import { BaseFilterable, OperatorMap } from "../../dal";
 /**
- * @schema InventoryLevelDTO
- * type: object
- * required:
- *   - inventory_item_id
- *   - location_id
- *   - stocked_quantity
- *   - reserved_quantity
- *   - incoming_quantity
- * properties:
- *   location_id:
- *     description: the item location ID
- *     type: string
- *   stocked_quantity:
- *     description: the total stock quantity of an inventory item at the given location ID
- *     type: number
- *   reserved_quantity:
- *     description: the reserved stock quantity of an inventory item at the given location ID
- *     type: number
- *   incoming_quantity:
- *     description: the incoming stock quantity of an inventory item at the given location ID
- *     type: number
- *   metadata:
- *     type: object
- *     description: An optional key-value map with additional details
- *     example: {car: "white"}
- *   created_at:
- *     type: string
- *     description: "The date with timezone at which the resource was created."
- *     format: date-time
- *   updated_at:
- *     type: string
- *     description: "The date with timezone at which the resource was updated."
- *     format: date-time
- *   deleted_at:
- *     type: string
- *     description: "The date with timezone at which the resource was deleted."
- *     format: date-time
+ * The inventory level details.
  */
 export interface InventoryLevelDTO {
+    /**
+     * The ID of the inventory level.
+     */
     id: string;
+    /**
+     * The associated inventory item's ID.
+     */
     inventory_item_id: string;
+    /**
+     * The associated location's ID.
+     */
     location_id: string;
+    /**
+     * The stocked quantity of the inventory level.
+     */
     stocked_quantity: number;
+    /**
+     * The reserved quantity of the inventory level.
+     */
     reserved_quantity: number;
+    /**
+     * The incoming quantity of the inventory level.
+     */
     incoming_quantity: number;
+    /**
+     * The available quantity of the inventory level.
+     */
     available_quantity: number;
+    /**
+     * Holds custom data in key-value pairs.
+     */
     metadata: Record<string, unknown> | null;
+    /**
+     * The creation date of the inventory level.
+     */
     created_at: string | Date;
+    /**
+     * The update date of the inventory level.
+     */
     updated_at: string | Date;
+    /**
+     * The deletion date of the inventory level.
+     */
     deleted_at: string | Date | null;
 }
+/**
+ * The filters to apply on the retrieved inventory levels.
+ */
 export interface FilterableInventoryLevelProps extends BaseFilterable<FilterableInventoryLevelProps> {
     /**
      * Filter inventory levels by the ID of their associated inventory item.

package/dist/inventory/common/inventory-level.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"inventory-level.d.ts","sourceRoot":"","sources":["../../../src/inventory/common/inventory-level.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,WAAW,EAAE,MAAM,WAAW,CAAA;AAIvD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAsCG;AACH,MAAM,WAAW,iBAAiB;IAChC,EAAE,EAAE,MAAM,CAAA;IACV,iBAAiB,EAAE,MAAM,CAAA;IACzB,WAAW,EAAE,MAAM,CAAA;IACnB,gBAAgB,EAAE,MAAM,CAAA;IACxB,iBAAiB,EAAE,MAAM,CAAA;IACzB,iBAAiB,EAAE,MAAM,CAAA;IACzB,kBAAkB,EAAE,MAAM,CAAA;IAC1B,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAA;IACxC,UAAU,EAAE,MAAM,GAAG,IAAI,CAAA;IACzB,UAAU,EAAE,MAAM,GAAG,IAAI,CAAA;IACzB,UAAU,EAAE,MAAM,GAAG,IAAI,GAAG,IAAI,CAAA;CACjC;AAED,MAAM,WAAW,6BACf,SAAQ,cAAc,CAAC,6BAA6B,CAAC;IACrD;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IACrC;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IAC/B;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,GAAG,WAAW,CAAC,MAAM,CAAC,CAAA;IAC/C;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,GAAG,WAAW,CAAC,MAAM,CAAC,CAAA;IAChD;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,GAAG,WAAW,CAAC,MAAM,CAAC,CAAA;CACjD"}
+{"version":3,"file":"inventory-level.d.ts","sourceRoot":"","sources":["../../../src/inventory/common/inventory-level.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,WAAW,EAAE,MAAM,WAAW,CAAA;AAIvD;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAA;IAEV;;OAEG;IACH,iBAAiB,EAAE,MAAM,CAAA;IAEzB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAA;IAEnB;;OAEG;IACH,gBAAgB,EAAE,MAAM,CAAA;IAExB;;OAEG;IACH,iBAAiB,EAAE,MAAM,CAAA;IAEzB;;OAEG;IACH,iBAAiB,EAAE,MAAM,CAAA;IAEzB;;OAEG;IACH,kBAAkB,EAAE,MAAM,CAAA;IAE1B;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAA;IAExC;;OAEG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAA;IAEzB;;OAEG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAA;IAEzB;;OAEG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,GAAG,IAAI,CAAA;CACjC;AAED;;GAEG;AACH,MAAM,WAAW,6BACf,SAAQ,cAAc,CAAC,6BAA6B,CAAC;IACrD;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IAErC;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IAE/B;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,GAAG,WAAW,CAAC,MAAM,CAAC,CAAA;IAE/C;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,GAAG,WAAW,CAAC,MAAM,CAAC,CAAA;IAEhD;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,GAAG,WAAW,CAAC,MAAM,CAAC,CAAA;CACjD"}

package/dist/inventory/common/reservation-item.d.ts

@@ -1,61 +1,51 @@
 import { NumericalComparisonOperator, StringComparisonOperator } from "../../common";
 /**
- * @schema ReservationItemDTO
- * title: "Reservation item"
- * description: "Represents a reservation of an inventory item at a stock location"
- * type: object
- * required:
- * - id
- * - location_id
- * - inventory_item_id
- * - quantity
- * properties:
- *   id:
- *     description: "The id of the reservation item"
- *     type: string
- *   location_id:
- *     description: "The id of the location of the reservation"
- *     type: string
- *   inventory_item_id:
- *     description: "The id of the inventory item the reservation relates to"
- *     type: string
- *   description:
- *     description: "Description of the reservation item"
- *     type: string
- *   created_by:
- *     description: "UserId of user who created the reservation item"
- *     type: string
- *   quantity:
- *     description: "The id of the reservation item"
- *     type: number
- *   metadata:
- *     type: object
- *     description: An optional key-value map with additional details
- *     example: {car: "white"}
- *   created_at:
- *     type: string
- *     description: "The date with timezone at which the resource was created."
- *     format: date-time
- *   updated_at:
- *     type: string
- *     description: "The date with timezone at which the resource was updated."
- *     format: date-time
- *   deleted_at:
- *     type: string
- *     description: "The date with timezone at which the resource was deleted."
- *     format: date-time
+ * The reservation item details.
  */
 export interface ReservationItemDTO {
+    /**
+     * The ID of the reservation item.
+     */
     id: string;
+    /**
+     * The associated location's ID.
+     */
     location_id: string;
+    /**
+     * The associated inventory item's ID.
+     */
     inventory_item_id: string;
+    /**
+     * The quantity of the reservation item.
+     */
     quantity: number;
+    /**
+     * The associated line item's ID.
+     */
     line_item_id?: string | null;
+    /**
+     * The description of the reservation item.
+     */
     description?: string | null;
+    /**
+     * The created by of the reservation item.
+     */
     created_by?: string | null;
+    /**
+     * Holds custom data in key-value pairs.
+     */
     metadata: Record<string, unknown> | null;
+    /**
+     * The creation date of the reservation item.
+     */
     created_at: string | Date;
+    /**
+     * The update date of the reservation item.
+     */
     updated_at: string | Date;
+    /**
+     * The deletion date of the reservation item.
+     */
     deleted_at: string | Date | null;
 }
 /**

package/dist/inventory/common/reservation-item.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"reservation-item.d.ts","sourceRoot":"","sources":["../../../src/inventory/common/reservation-item.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,2BAA2B,EAC3B,wBAAwB,EACzB,MAAM,cAAc,CAAA;AAErB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6CG;AACH,MAAM,WAAW,kBAAkB;IACjC,EAAE,EAAE,MAAM,CAAA;IACV,WAAW,EAAE,MAAM,CAAA;IACnB,iBAAiB,EAAE,MAAM,CAAA;IACzB,QAAQ,EAAE,MAAM,CAAA;IAChB,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAC5B,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAC3B,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAC1B,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAA;IACxC,UAAU,EAAE,MAAM,GAAG,IAAI,CAAA;IACzB,UAAU,EAAE,MAAM,GAAG,IAAI,CAAA;IACzB,UAAU,EAAE,MAAM,GAAG,IAAI,GAAG,IAAI,CAAA;CACjC;AAED;;;;GAIG;AACH,MAAM,WAAW,8BAA8B;IAC7C;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IACtB;;;;;OAKG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IACxB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IAChC;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IACrC;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IAC/B;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,wBAAwB,CAAA;IAC/C;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IAC9B;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,2BAA2B,CAAA;CAChD"}
+{"version":3,"file":"reservation-item.d.ts","sourceRoot":"","sources":["../../../src/inventory/common/reservation-item.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,2BAA2B,EAC3B,wBAAwB,EACzB,MAAM,cAAc,CAAA;AAErB;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAA;IAEV;;OAEG;IACH,WAAW,EAAE,MAAM,CAAA;IAEnB;;OAEG;IACH,iBAAiB,EAAE,MAAM,CAAA;IAEzB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAA;IAEhB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAE5B;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAE3B;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAE1B;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAA;IAExC;;OAEG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAA;IAEzB;;OAEG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAA;IAEzB;;OAEG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,GAAG,IAAI,CAAA;CACjC;AAED;;;;GAIG;AACH,MAAM,WAAW,8BAA8B;IAC7C;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IAEtB;;;;;OAKG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IAExB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IAEhC;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IAErC;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IAE/B;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,wBAAwB,CAAA;IAE/C;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IAE9B;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,2BAA2B,CAAA;CAChD"}