@medusajs/medusa 1.3.3 → 1.3.6-next.0

package/dist/models/cart.js

@@ -7,80 +7,166 @@
  * properties:
  *   id:
  *     type: string
+ *     description: The cart's ID
+ *     example: cart_01G8ZH853Y6TFXWPG5EYE81X63
  *   email:
  *     type: string
+ *     description: The email associated with the cart
+ *     format: email
  *   billing_address_id:
  *     type: string
+ *     description: The billing address's ID
+ *     example: addr_01G8ZH853YPY9B94857DY91YGW
  *   billing_address:
+ *     description: Available if the relation `billing_address` is expanded.
  *     $ref: "#/components/schemas/address"
  *   shipping_address_id:
  *     type: string
+ *     description: The shipping address's ID
+ *     example: addr_01G8ZH853YPY9B94857DY91YGW
  *   shipping_address:
+ *     description: Available if the relation `shipping_address` is expanded.
  *     $ref: "#/components/schemas/address"
  *   items:
+ *     description: Available if the relation `items` is expanded.
  *     type: array
  *     items:
  *       $ref: "#/components/schemas/line_item"
  *   region_id:
  *     type: string
+ *     description: The region's ID
+ *     example: reg_01G1G5V26T9H8Y0M4JNE3YGA4G
  *   region:
- *     $ref: "#/components/schemas/region"
+ *     description: A region object. Available if the relation `region` is expanded.
+ *     type: object
  *   discounts:
  *     type: array
+ *     description: Available if the relation `discounts` is expanded.
  *     items:
- *       $ref: "#/components/schemas/region"
+ *       type: object
+ *       description: A discount object.
  *   gift_cards:
  *     type: array
+ *     description: Available if the relation `gift_cards` is expanded.
  *     items:
- *       $ref: "#/components/schemas/gift_card"
+ *       type: object
+ *       description: A gift card object.
  *   customer_id:
  *     type: string
+ *     description: The customer's ID
+ *     example: cus_01G2SG30J8C85S4A5CHM2S1NS2
  *   customer:
- *     $ref: "#/components/schemas/customer"
+ *     description: A customer object. Available if the relation `customer` is expanded.
+ *     type: object
  *   payment_session:
+ *     description: The selected payment session in the cart.
  *     $ref: "#/components/schemas/payment_session"
  *   payment_sessions:
  *     type: array
+ *     description: The payment sessions created on the cart.
  *     items:
  *       $ref: "#/components/schemas/payment_session"
+ *   payment_id:
+ *     type: string
+ *     description: The payment's ID if available
+ *     example: pay_01G8ZCC5W42ZNY842124G7P5R9
  *   payment:
+ *     description: Available if the relation `payment` is expanded.
  *     $ref: "#/components/schemas/payment"
  *   shipping_methods:
  *     type: array
+ *     description: The shipping methods added to the cart.
  *     items:
  *       $ref: "#/components/schemas/shipping_method"
  *   type:
  *     type: string
+ *     description: The cart's type.
  *     enum:
  *       - default
  *       - swap
+ *       - draft_order
  *       - payment_link
+ *       - claim
+ *     default: default
  *   completed_at:
  *     type: string
+ *     description: "The date with timezone at which the cart was completed."
+ *     format: date-time
+ *   payment_authorized_at:
+ *     type: string
+ *     description: "The date with timezone at which the payment was authorized."
  *     format: date-time
+ *   idempotency_key:
+ *     type: string
+ *     description: Randomly generated key used to continue the completion of a cart in case of failure.
+ *     externalDocs:
+ *       url: https://docs.medusajs.com/advanced/backend/payment/overview#idempotency-key
+ *       description: Learn more how to use the idempotency key.
+ *   context:
+ *     type: object
+ *     description: "The context of the cart which can include info like IP or user agent."
+ *     example:
+ *       ip: "::1"
+ *       user_agent: "PostmanRuntime/7.29.2"
+ *   sales_channel_id:
+ *     type: string
+ *     description: The sales channel ID the cart is associated with.
+ *     example: null
+ *   sales_channel:
+ *     description: A sales channel object. Available if the relation `sales_channel` is expanded.
+ *     type: object
  *   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
  *   metadata:
  *     type: object
+ *     description: An optional key-value map with additional details
+ *     example: {car: "white"}
  *   shipping_total:
  *     type: integer
+ *     description: The total of shipping
+ *     example: 1000
  *   discount_total:
  *     type: integer
+ *     description: The total of discount
+ *     example: 800
  *   tax_total:
  *     type: integer
+ *     description: The total of tax
+ *     example: 0
+ *   refunded_total:
+ *     type: integer
+ *     description: The total amount refunded if the order associated with this cart is returned.
+ *     example: 0
+ *   total:
+ *     type: integer
+ *     description: The total amount of the cart
+ *     example: 8200
  *   subtotal:
  *     type: integer
+ *     description: The subtotal of the cart
+ *     example: 8000
  *   refundable_amount:
  *     type: integer
+ *     description: The amount that can be refunded
+ *     example: 8200
  *   gift_card_total:
  *     type: integer
+ *     description: The total of gift cards
+ *     example: 0
+ *   gift_card_tax_total:
+ *     type: integer
+ *     description: The total of gift cards with taxes
+ *     example: 0
  */
 var __extends = (this && this.__extends) || (function () {
     var extendStatics = function (d, b) {
@@ -110,6 +196,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.Cart = exports.CartType = void 0;
 var typeorm_1 = require("typeorm");
 var db_aware_column_1 = require("../utils/db-aware-column");
+var feature_flag_decorators_1 = require("../utils/feature-flag-decorators");
 var address_1 = require("./address");
 var customer_1 = require("./customer");
 var discount_1 = require("./discount");
@@ -118,6 +205,7 @@ var line_item_1 = require("./line-item");
 var payment_1 = require("./payment");
 var payment_session_1 = require("./payment-session");
 var region_1 = require("./region");
+var sales_channel_1 = require("./sales-channel");
 var shipping_method_1 = require("./shipping-method");
 var soft_deletable_entity_1 = require("../interfaces/models/soft-deletable-entity");
 var generate_entity_id_1 = require("../utils/generate-entity-id");
@@ -274,6 +362,17 @@ var Cart = /** @class */ (function (_super) {
         (0, db_aware_column_1.DbAwareColumn)({ type: "jsonb", nullable: true }),
         __metadata("design:type", Object)
     ], Cart.prototype, "metadata", void 0);
+    __decorate([
+        (0, feature_flag_decorators_1.FeatureFlagColumn)("sales_channels", { type: "varchar", nullable: true }),
+        __metadata("design:type", Object)
+    ], Cart.prototype, "sales_channel_id", void 0);
+    __decorate([
+        (0, feature_flag_decorators_1.FeatureFlagDecorators)("sales_channels", [
+            (0, typeorm_1.ManyToOne)(function () { return sales_channel_1.SalesChannel; }),
+            (0, typeorm_1.JoinColumn)({ name: "sales_channel_id" }),
+        ]),
+        __metadata("design:type", sales_channel_1.SalesChannel)
+    ], Cart.prototype, "sales_channel", void 0);
     __decorate([
         (0, typeorm_1.AfterLoad)(),
         __metadata("design:type", Function),

package/dist/models/cart.js.map

@@ -1 +1 @@
-{"version":3,"file":"cart.js","sourceRoot":"","sources":["../../src/models/cart.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkFG;;;;;;;;;;;;;;;;;;;;;;;;;;;AAEH,mCAYgB;AAChB,4DAAuE;AACvE,qCAAmC;AACnC,uCAAqC;AACrC,uCAAqC;AACrC,yCAAsC;AACtC,yCAAsC;AACtC,qCAAmC;AACnC,qDAAkD;AAClD,mCAAiC;AACjC,qDAAkD;AAClD,oFAAgF;AAChF,kEAA8D;AAE9D,IAAY,QAMX;AAND,WAAY,QAAQ;IAClB,+BAAmB,CAAA;IACnB,yBAAa,CAAA;IACb,uCAA2B,CAAA;IAC3B,yCAA6B,CAAA;IAC7B,2BAAe,CAAA;AACjB,CAAC,EANW,QAAQ,GAAR,gBAAQ,KAAR,gBAAQ,QAMnB;AAGD;IAA0B,wBAAmB;IAA7C;QAAA,qEAqIC;QApIU,YAAM,GAAG,MAAM,CAAA;;IAoI1B,CAAC;IAVS,wBAAS,GAAjB;QACE,IAAI,IAAI,CAAC,gBAAgB,EAAE;YACzB,IAAI,CAAC,eAAe,GAAG,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,UAAC,CAAC,IAAK,OAAA,CAAC,CAAC,WAAW,EAAb,CAAa,CAAE,CAAA;SACzE;IACH,CAAC;IAGO,2BAAY,GAApB;QACE,IAAI,CAAC,EAAE,GAAG,IAAA,qCAAgB,EAAC,IAAI,CAAC,EAAE,EAAE,MAAM,CAAC,CAAA;IAC7C,CAAC;IAhID;QADC,IAAA,gBAAM,EAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;uCACd;IAIb;QAFC,IAAA,eAAK,GAAE;QACP,IAAA,gBAAM,EAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;oDACD;IAM1B;QAJC,IAAA,mBAAS,EAAC,cAAM,OAAA,iBAAO,EAAP,CAAO,EAAE;YACxB,OAAO,EAAE,CAAC,QAAQ,EAAE,QAAQ,EAAE,aAAa,CAAC;SAC7C,CAAC;QACD,IAAA,oBAAU,EAAC,EAAE,IAAI,EAAE,oBAAoB,EAAE,CAAC;kCAC1B,iBAAO;iDAAA;IAIxB;QAFC,IAAA,eAAK,GAAE;QACP,IAAA,gBAAM,EAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;qDACA;IAM3B;QAJC,IAAA,mBAAS,EAAC,cAAM,OAAA,iBAAO,EAAP,CAAO,EAAE;YACxB,OAAO,EAAE,CAAC,QAAQ,EAAE,QAAQ,EAAE,aAAa,CAAC;SAC7C,CAAC;QACD,IAAA,oBAAU,EAAC,EAAE,IAAI,EAAE,qBAAqB,EAAE,CAAC;;kDACZ;IAKhC;QAHC,IAAA,mBAAS,EAAC,cAAM,OAAA,oBAAQ,EAAR,CAAQ,EAAE,UAAC,QAAQ,IAAK,OAAA,QAAQ,CAAC,IAAI,EAAb,CAAa,EAAE;YACtD,OAAO,EAAE,CAAC,QAAQ,EAAE,QAAQ,CAAC;SAC9B,CAAC;;uCACe;IAIjB;QAFC,IAAA,eAAK,GAAE;QACP,IAAA,gBAAM,GAAE;;2CACQ;IAIjB;QAFC,IAAA,mBAAS,EAAC,cAAM,OAAA,eAAM,EAAN,CAAM,CAAC;QACvB,IAAA,oBAAU,EAAC,EAAE,IAAI,EAAE,WAAW,EAAE,CAAC;kCAC1B,eAAM;wCAAA;IAcd;QAZC,IAAA,oBAAU,EAAC,cAAM,OAAA,mBAAQ,EAAR,CAAQ,CAAC;QAC1B,IAAA,mBAAS,EAAC;YACT,IAAI,EAAE,gBAAgB;YACtB,UAAU,EAAE;gBACV,IAAI,EAAE,SAAS;gBACf,oBAAoB,EAAE,IAAI;aAC3B;YACD,iBAAiB,EAAE;gBACjB,IAAI,EAAE,aAAa;gBACnB,oBAAoB,EAAE,IAAI;aAC3B;SACF,CAAC;;2CACmB;IAcrB;QAZC,IAAA,oBAAU,EAAC,cAAM,OAAA,oBAAQ,EAAR,CAAQ,CAAC;QAC1B,IAAA,mBAAS,EAAC;YACT,IAAI,EAAE,iBAAiB;YACvB,UAAU,EAAE;gBACV,IAAI,EAAE,SAAS;gBACf,oBAAoB,EAAE,IAAI;aAC3B;YACD,iBAAiB,EAAE;gBACjB,IAAI,EAAE,cAAc;gBACpB,oBAAoB,EAAE,IAAI;aAC3B;SACF,CAAC;;4CACoB;IAItB;QAFC,IAAA,eAAK,GAAE;QACP,IAAA,gBAAM,EAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;6CACR;IAInB;QAFC,IAAA,mBAAS,EAAC,cAAM,OAAA,mBAAQ,EAAR,CAAQ,CAAC;QACzB,IAAA,oBAAU,EAAC,EAAE,IAAI,EAAE,aAAa,EAAE,CAAC;kCAC1B,mBAAQ;0CAAA;IAOlB;QAHC,IAAA,mBAAS,EAAC,cAAM,OAAA,gCAAc,EAAd,CAAc,EAAE,UAAC,cAAc,IAAK,OAAA,cAAc,CAAC,IAAI,EAAnB,CAAmB,EAAE;YACxE,OAAO,EAAE,IAAI;SACd,CAAC;;kDACgC;IAIlC;QAFC,IAAA,eAAK,GAAE;QACP,IAAA,gBAAM,EAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;4CACT;IAIlB;QAFC,IAAA,kBAAQ,EAAC,cAAM,OAAA,iBAAO,EAAP,CAAO,CAAC;QACvB,IAAA,oBAAU,EAAC,EAAE,IAAI,EAAE,YAAY,EAAE,CAAC;kCAC1B,iBAAO;yCAAA;IAKhB;QAHC,IAAA,mBAAS,EAAC,cAAM,OAAA,gCAAc,EAAd,CAAc,EAAE,UAAC,MAAM,IAAK,OAAA,MAAM,CAAC,IAAI,EAAX,CAAW,EAAE;YACxD,OAAO,EAAE,CAAC,aAAa,EAAE,QAAQ,CAAC;SACnC,CAAC;;kDACgC;IAGlC;QADC,IAAA,+BAAa,EAAC,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,QAAQ,EAAE,OAAO,EAAE,SAAS,EAAE,CAAC;;sCACtD;IAGd;QADC,IAAA,gBAAM,EAAC,EAAE,IAAI,EAAE,IAAA,+BAAa,EAAC,aAAa,CAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;kCACjD,IAAI;8CAAA;IAGlB;QADC,IAAA,gBAAM,EAAC,EAAE,IAAI,EAAE,IAAA,+BAAa,EAAC,aAAa,CAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;kCACxC,IAAI;uDAAA;IAG3B;QADC,IAAA,gBAAM,EAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;iDACJ;IAGvB;QADC,IAAA,+BAAa,EAAC,EAAE,IAAI,EAAE,OAAO,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;yCACjB;IAGhC;QADC,IAAA,+BAAa,EAAC,EAAE,IAAI,EAAE,OAAO,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;0CAChB;IAYjC;QADC,IAAA,mBAAS,GAAE;;;;yCAKX;IAGD;QADC,IAAA,sBAAY,GAAE;;;;4CAGd;IApIU,IAAI;QADhB,IAAA,gBAAM,GAAE;OACI,IAAI,CAqIhB;IAAD,WAAC;CAAA,AArID,CAA0B,2CAAmB,GAqI5C;AArIY,oBAAI"}
+{"version":3,"file":"cart.js","sourceRoot":"","sources":["../../src/models/cart.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAwKG;;;;;;;;;;;;;;;;;;;;;;;;;;;AAEH,mCAYgB;AAChB,4DAAuE;AACvE,4EAGyC;AAEzC,qCAAmC;AACnC,uCAAqC;AACrC,uCAAqC;AACrC,yCAAsC;AACtC,yCAAsC;AACtC,qCAAmC;AACnC,qDAAkD;AAClD,mCAAiC;AACjC,iDAA8C;AAC9C,qDAAkD;AAClD,oFAAgF;AAChF,kEAA8D;AAE9D,IAAY,QAMX;AAND,WAAY,QAAQ;IAClB,+BAAmB,CAAA;IACnB,yBAAa,CAAA;IACb,uCAA2B,CAAA;IAC3B,yCAA6B,CAAA;IAC7B,2BAAe,CAAA;AACjB,CAAC,EANW,QAAQ,GAAR,gBAAQ,KAAR,gBAAQ,QAMnB;AAGD;IAA0B,wBAAmB;IAA7C;QAAA,qEA+IC;QA9IU,YAAM,GAAG,MAAM,CAAA;;IA8I1B,CAAC;IAVS,wBAAS,GAAjB;QACE,IAAI,IAAI,CAAC,gBAAgB,EAAE;YACzB,IAAI,CAAC,eAAe,GAAG,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,UAAC,CAAC,IAAK,OAAA,CAAC,CAAC,WAAW,EAAb,CAAa,CAAE,CAAA;SACzE;IACH,CAAC;IAGO,2BAAY,GAApB;QACE,IAAI,CAAC,EAAE,GAAG,IAAA,qCAAgB,EAAC,IAAI,CAAC,EAAE,EAAE,MAAM,CAAC,CAAA;IAC7C,CAAC;IA1ID;QADC,IAAA,gBAAM,EAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;uCACd;IAIb;QAFC,IAAA,eAAK,GAAE;QACP,IAAA,gBAAM,EAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;oDACD;IAM1B;QAJC,IAAA,mBAAS,EAAC,cAAM,OAAA,iBAAO,EAAP,CAAO,EAAE;YACxB,OAAO,EAAE,CAAC,QAAQ,EAAE,QAAQ,EAAE,aAAa,CAAC;SAC7C,CAAC;QACD,IAAA,oBAAU,EAAC,EAAE,IAAI,EAAE,oBAAoB,EAAE,CAAC;kCAC1B,iBAAO;iDAAA;IAIxB;QAFC,IAAA,eAAK,GAAE;QACP,IAAA,gBAAM,EAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;qDACA;IAM3B;QAJC,IAAA,mBAAS,EAAC,cAAM,OAAA,iBAAO,EAAP,CAAO,EAAE;YACxB,OAAO,EAAE,CAAC,QAAQ,EAAE,QAAQ,EAAE,aAAa,CAAC;SAC7C,CAAC;QACD,IAAA,oBAAU,EAAC,EAAE,IAAI,EAAE,qBAAqB,EAAE,CAAC;;kDACZ;IAKhC;QAHC,IAAA,mBAAS,EAAC,cAAM,OAAA,oBAAQ,EAAR,CAAQ,EAAE,UAAC,QAAQ,IAAK,OAAA,QAAQ,CAAC,IAAI,EAAb,CAAa,EAAE;YACtD,OAAO,EAAE,CAAC,QAAQ,EAAE,QAAQ,CAAC;SAC9B,CAAC;;uCACe;IAIjB;QAFC,IAAA,eAAK,GAAE;QACP,IAAA,gBAAM,GAAE;;2CACQ;IAIjB;QAFC,IAAA,mBAAS,EAAC,cAAM,OAAA,eAAM,EAAN,CAAM,CAAC;QACvB,IAAA,oBAAU,EAAC,EAAE,IAAI,EAAE,WAAW,EAAE,CAAC;kCAC1B,eAAM;wCAAA;IAcd;QAZC,IAAA,oBAAU,EAAC,cAAM,OAAA,mBAAQ,EAAR,CAAQ,CAAC;QAC1B,IAAA,mBAAS,EAAC;YACT,IAAI,EAAE,gBAAgB;YACtB,UAAU,EAAE;gBACV,IAAI,EAAE,SAAS;gBACf,oBAAoB,EAAE,IAAI;aAC3B;YACD,iBAAiB,EAAE;gBACjB,IAAI,EAAE,aAAa;gBACnB,oBAAoB,EAAE,IAAI;aAC3B;SACF,CAAC;;2CACmB;IAcrB;QAZC,IAAA,oBAAU,EAAC,cAAM,OAAA,oBAAQ,EAAR,CAAQ,CAAC;QAC1B,IAAA,mBAAS,EAAC;YACT,IAAI,EAAE,iBAAiB;YACvB,UAAU,EAAE;gBACV,IAAI,EAAE,SAAS;gBACf,oBAAoB,EAAE,IAAI;aAC3B;YACD,iBAAiB,EAAE;gBACjB,IAAI,EAAE,cAAc;gBACpB,oBAAoB,EAAE,IAAI;aAC3B;SACF,CAAC;;4CACoB;IAItB;QAFC,IAAA,eAAK,GAAE;QACP,IAAA,gBAAM,EAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;6CACR;IAInB;QAFC,IAAA,mBAAS,EAAC,cAAM,OAAA,mBAAQ,EAAR,CAAQ,CAAC;QACzB,IAAA,oBAAU,EAAC,EAAE,IAAI,EAAE,aAAa,EAAE,CAAC;kCAC1B,mBAAQ;0CAAA;IAOlB;QAHC,IAAA,mBAAS,EAAC,cAAM,OAAA,gCAAc,EAAd,CAAc,EAAE,UAAC,cAAc,IAAK,OAAA,cAAc,CAAC,IAAI,EAAnB,CAAmB,EAAE;YACxE,OAAO,EAAE,IAAI;SACd,CAAC;;kDACgC;IAIlC;QAFC,IAAA,eAAK,GAAE;QACP,IAAA,gBAAM,EAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;4CACT;IAIlB;QAFC,IAAA,kBAAQ,EAAC,cAAM,OAAA,iBAAO,EAAP,CAAO,CAAC;QACvB,IAAA,oBAAU,EAAC,EAAE,IAAI,EAAE,YAAY,EAAE,CAAC;kCAC1B,iBAAO;yCAAA;IAKhB;QAHC,IAAA,mBAAS,EAAC,cAAM,OAAA,gCAAc,EAAd,CAAc,EAAE,UAAC,MAAM,IAAK,OAAA,MAAM,CAAC,IAAI,EAAX,CAAW,EAAE;YACxD,OAAO,EAAE,CAAC,aAAa,EAAE,QAAQ,CAAC;SACnC,CAAC;;kDACgC;IAGlC;QADC,IAAA,+BAAa,EAAC,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,QAAQ,EAAE,OAAO,EAAE,SAAS,EAAE,CAAC;;sCACtD;IAGd;QADC,IAAA,gBAAM,EAAC,EAAE,IAAI,EAAE,IAAA,+BAAa,EAAC,aAAa,CAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;kCACjD,IAAI;8CAAA;IAGlB;QADC,IAAA,gBAAM,EAAC,EAAE,IAAI,EAAE,IAAA,+BAAa,EAAC,aAAa,CAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;kCACxC,IAAI;uDAAA;IAG3B;QADC,IAAA,gBAAM,EAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;iDACJ;IAGvB;QADC,IAAA,+BAAa,EAAC,EAAE,IAAI,EAAE,OAAO,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;yCACjB;IAGhC;QADC,IAAA,+BAAa,EAAC,EAAE,IAAI,EAAE,OAAO,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;0CAChB;IAGjC;QADC,IAAA,2CAAiB,EAAC,gBAAgB,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;kDAC1C;IAM/B;QAJC,IAAA,+CAAqB,EAAC,gBAAgB,EAAE;YACvC,IAAA,mBAAS,EAAC,cAAM,OAAA,4BAAY,EAAZ,CAAY,CAAC;YAC7B,IAAA,oBAAU,EAAC,EAAE,IAAI,EAAE,kBAAkB,EAAE,CAAC;SACzC,CAAC;kCACa,4BAAY;+CAAA;IAa3B;QADC,IAAA,mBAAS,GAAE;;;;yCAKX;IAGD;QADC,IAAA,sBAAY,GAAE;;;;4CAGd;IA9IU,IAAI;QADhB,IAAA,gBAAM,GAAE;OACI,IAAI,CA+IhB;IAAD,WAAC;CAAA,AA/ID,CAA0B,2CAAmB,GA+I5C;AA/IY,oBAAI"}

package/dist/models/claim-image.d.ts

@@ -12,22 +12,38 @@ export declare class ClaimImage extends SoftDeletableEntity {
  * title: "Claim Image"
  * description: "Represents photo documentation of a claim."
  * x-resourceId: claim_image
+ * required:
+ *  - claim_item_id
+ *  - url
  * properties:
  *   id:
  *     type: string
+ *     description: The claim image's ID
+ *     example: cimg_01G8ZH853Y6TFXWPG5EYE81X63
  *   claim_item_id:
  *     type: string
+ *     description: The ID of the claim item associated with the image
+ *   claim_item:
+ *     description: A claim item object. Available if the relation `claim_item` is expanded.
+ *     type: object
  *   url:
  *     type: string
+ *     description: The URL of the image
+ *     format: uri
  *   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
  *   metadata:
  *     type: object
+ *     description: An optional key-value map with additional details
+ *     example: {car: "white"}
  */

package/dist/models/claim-image.js

@@ -27,8 +27,8 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.ClaimImage = void 0;
 var typeorm_1 = require("typeorm");
 var claim_item_1 = require("./claim-item");
-var soft_deletable_entity_1 = require("../interfaces/models/soft-deletable-entity");
 var db_aware_column_1 = require("../utils/db-aware-column");
+var soft_deletable_entity_1 = require("../interfaces/models/soft-deletable-entity");
 var generate_entity_id_1 = require("../utils/generate-entity-id");
 var ClaimImage = /** @class */ (function (_super) {
     __extends(ClaimImage, _super);
@@ -73,23 +73,39 @@ exports.ClaimImage = ClaimImage;
  * title: "Claim Image"
  * description: "Represents photo documentation of a claim."
  * x-resourceId: claim_image
+ * required:
+ *  - claim_item_id
+ *  - url
  * properties:
  *   id:
  *     type: string
+ *     description: The claim image's ID
+ *     example: cimg_01G8ZH853Y6TFXWPG5EYE81X63
  *   claim_item_id:
  *     type: string
+ *     description: The ID of the claim item associated with the image
+ *   claim_item:
+ *     description: A claim item object. Available if the relation `claim_item` is expanded.
+ *     type: object
  *   url:
  *     type: string
+ *     description: The URL of the image
+ *     format: uri
  *   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
  *   metadata:
  *     type: object
+ *     description: An optional key-value map with additional details
+ *     example: {car: "white"}
  */
 //# sourceMappingURL=claim-image.js.map

package/dist/models/claim-image.js.map

@@ -1 +1 @@
-{"version":3,"file":"claim-image.js","sourceRoot":"","sources":["../../src/models/claim-image.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,mCAOgB;AAChB,2CAAwC;AACxC,oFAAgF;AAChF,4DAAwD;AACxD,kEAA8D;AAG9D;IAAgC,8BAAmB;IAAnD;;IAmBA,CAAC;IAHS,iCAAY,GAApB;QACE,IAAI,CAAC,EAAE,GAAG,IAAA,qCAAgB,EAAC,IAAI,CAAC,EAAE,EAAE,MAAM,CAAC,CAAA;IAC7C,CAAC;IAfD;QAFC,IAAA,eAAK,GAAE;QACP,IAAA,gBAAM,GAAE;;qDACY;IAIrB;QAFC,IAAA,mBAAS,EAAC,cAAM,OAAA,sBAAS,EAAT,CAAS,EAAE,UAAC,EAAE,IAAK,OAAA,EAAE,CAAC,MAAM,EAAT,CAAS,CAAC;QAC7C,IAAA,oBAAU,EAAC,EAAE,IAAI,EAAE,eAAe,EAAE,CAAC;kCAC1B,sBAAS;kDAAA;IAGrB;QADC,IAAA,gBAAM,GAAE;;2CACE;IAGX;QADC,IAAA,+BAAa,EAAC,EAAE,IAAI,EAAE,OAAO,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;gDAChB;IAGjC;QADC,IAAA,sBAAY,GAAE;;;;kDAGd;IAlBU,UAAU;QADtB,IAAA,gBAAM,GAAE;OACI,UAAU,CAmBtB;IAAD,iBAAC;CAAA,AAnBD,CAAgC,2CAAmB,GAmBlD;AAnBY,gCAAU;AAqBvB;;;;;;;;;;;;;;;;;;;;;;;GAuBG"}
+{"version":3,"file":"claim-image.js","sourceRoot":"","sources":["../../src/models/claim-image.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,mCAOgB;AAEhB,2CAAwC;AACxC,4DAAwD;AACxD,oFAAgF;AAChF,kEAA8D;AAG9D;IAAgC,8BAAmB;IAAnD;;IAmBA,CAAC;IAHS,iCAAY,GAApB;QACE,IAAI,CAAC,EAAE,GAAG,IAAA,qCAAgB,EAAC,IAAI,CAAC,EAAE,EAAE,MAAM,CAAC,CAAA;IAC7C,CAAC;IAfD;QAFC,IAAA,eAAK,GAAE;QACP,IAAA,gBAAM,GAAE;;qDACY;IAIrB;QAFC,IAAA,mBAAS,EAAC,cAAM,OAAA,sBAAS,EAAT,CAAS,EAAE,UAAC,EAAE,IAAK,OAAA,EAAE,CAAC,MAAM,EAAT,CAAS,CAAC;QAC7C,IAAA,oBAAU,EAAC,EAAE,IAAI,EAAE,eAAe,EAAE,CAAC;kCAC1B,sBAAS;kDAAA;IAGrB;QADC,IAAA,gBAAM,GAAE;;2CACE;IAGX;QADC,IAAA,+BAAa,EAAC,EAAE,IAAI,EAAE,OAAO,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;gDAChB;IAGjC;QADC,IAAA,sBAAY,GAAE;;;;kDAGd;IAlBU,UAAU;QADtB,IAAA,gBAAM,GAAE;OACI,UAAU,CAmBtB;IAAD,iBAAC;CAAA,AAnBD,CAAgC,2CAAmB,GAmBlD;AAnBY,gCAAU;AAqBvB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAuCG"}

package/dist/models/claim-item.d.ts

@@ -1,7 +1,7 @@
-import { LineItem } from "./line-item";
 import { ClaimImage } from "./claim-image";
-import { ClaimTag } from "./claim-tag";
 import { ClaimOrder } from "./claim-order";
+import { ClaimTag } from "./claim-tag";
+import { LineItem } from "./line-item";
 import { ProductVariant } from "./product-variant";
 import { SoftDeletableEntity } from "../interfaces/models/soft-deletable-entity";
 export declare enum ClaimReason {
@@ -30,25 +30,42 @@ export declare class ClaimItem extends SoftDeletableEntity {
  * title: "Claim Item"
  * description: "Represents a claimed item along with information about the reasons for the claim."
  * x-resourceId: claim_item
+ * required:
+ *   - claim_order_id
+ *   - item_id
+ *   - variant_id
+ *   - reason
+ *   - quantity
  * properties:
  *   id:
  *     type: string
+ *     description: The claim item's ID
+ *     example: citm_01G8ZH853Y6TFXWPG5EYE81X63
  *   images:
  *     type: array
+ *     description: Available if the relation `images` is expanded.
  *     items:
  *       $ref: "#/components/schemas/claim_image"
  *   claim_order_id:
+ *     description: The ID of the claim this item is associated with.
  *     type: string
+ *   claim_order:
+ *     description: A claim order object. Available if the relation `claim_order` is expanded.
+ *     type: object
  *   item_id:
+ *     description: The ID of the line item that the claim item refers to.
  *     type: string
+ *     example: item_01G8ZM25TN49YV9EQBE2NC27KC
  *   item:
- *     description: "The Line Item that the claim refers to"
+ *     description: Available if the relation `item` is expanded.
  *     $ref: "#/components/schemas/line_item"
  *   variant_id:
+ *     description: "The ID of the product variant that is claimed."
  *     type: string
+ *     example: variant_01G1G5V2MRX2V3PVSR2WXYPFB6
  *   variant:
- *     description: "The Product Variant that is claimed."
- *     $ref: "#/components/schemas/product_variant"
+ *     description: A variant object. Available if the relation `variant` is expanded.
+ *     type: object
  *   reason:
  *     description: "The reason for the claim"
  *     type: string
@@ -60,23 +77,30 @@ export declare class ClaimItem extends SoftDeletableEntity {
  *   note:
  *     description: "An optional note about the claim, for additional information"
  *     type: string
+ *     example: "I don't like it."
  *   quantity:
  *     description: "The quantity of the item that is being claimed; must be less than or equal to the amount purchased in the original order."
  *     type: integer
+ *     example: 1
  *   tags:
- *     description: "User defined tags for easy filtering and grouping."
+ *     description: "User defined tags for easy filtering and grouping. Available if the relation 'tags' is expanded."
  *     type: array
  *     items:
  *       $ref: "#/components/schemas/claim_tag"
  *   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
  *   metadata:
  *     type: object
+ *     description: An optional key-value map with additional details
+ *     example: {car: "white"}
  */

package/dist/models/claim-item.js

@@ -26,11 +26,11 @@ var __metadata = (this && this.__metadata) || function (k, v) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ClaimItem = exports.ClaimReason = void 0;
 var typeorm_1 = require("typeorm");
-var db_aware_column_1 = require("../utils/db-aware-column");
-var line_item_1 = require("./line-item");
 var claim_image_1 = require("./claim-image");
-var claim_tag_1 = require("./claim-tag");
 var claim_order_1 = require("./claim-order");
+var claim_tag_1 = require("./claim-tag");
+var db_aware_column_1 = require("../utils/db-aware-column");
+var line_item_1 = require("./line-item");
 var product_variant_1 = require("./product-variant");
 var soft_deletable_entity_1 = require("../interfaces/models/soft-deletable-entity");
 var generate_entity_id_1 = require("../utils/generate-entity-id");
@@ -133,25 +133,42 @@ exports.ClaimItem = ClaimItem;
  * title: "Claim Item"
  * description: "Represents a claimed item along with information about the reasons for the claim."
  * x-resourceId: claim_item
+ * required:
+ *   - claim_order_id
+ *   - item_id
+ *   - variant_id
+ *   - reason
+ *   - quantity
  * properties:
  *   id:
  *     type: string
+ *     description: The claim item's ID
+ *     example: citm_01G8ZH853Y6TFXWPG5EYE81X63
  *   images:
  *     type: array
+ *     description: Available if the relation `images` is expanded.
  *     items:
  *       $ref: "#/components/schemas/claim_image"
  *   claim_order_id:
+ *     description: The ID of the claim this item is associated with.
  *     type: string
+ *   claim_order:
+ *     description: A claim order object. Available if the relation `claim_order` is expanded.
+ *     type: object
  *   item_id:
+ *     description: The ID of the line item that the claim item refers to.
  *     type: string
+ *     example: item_01G8ZM25TN49YV9EQBE2NC27KC
  *   item:
- *     description: "The Line Item that the claim refers to"
+ *     description: Available if the relation `item` is expanded.
  *     $ref: "#/components/schemas/line_item"
  *   variant_id:
+ *     description: "The ID of the product variant that is claimed."
  *     type: string
+ *     example: variant_01G1G5V2MRX2V3PVSR2WXYPFB6
  *   variant:
- *     description: "The Product Variant that is claimed."
- *     $ref: "#/components/schemas/product_variant"
+ *     description: A variant object. Available if the relation `variant` is expanded.
+ *     type: object
  *   reason:
  *     description: "The reason for the claim"
  *     type: string
@@ -163,24 +180,31 @@ exports.ClaimItem = ClaimItem;
  *   note:
  *     description: "An optional note about the claim, for additional information"
  *     type: string
+ *     example: "I don't like it."
  *   quantity:
  *     description: "The quantity of the item that is being claimed; must be less than or equal to the amount purchased in the original order."
  *     type: integer
+ *     example: 1
  *   tags:
- *     description: "User defined tags for easy filtering and grouping."
+ *     description: "User defined tags for easy filtering and grouping. Available if the relation 'tags' is expanded."
  *     type: array
  *     items:
  *       $ref: "#/components/schemas/claim_tag"
  *   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
  *   metadata:
  *     type: object
+ *     description: An optional key-value map with additional details
+ *     example: {car: "white"}
  */
 //# sourceMappingURL=claim-item.js.map

package/dist/models/claim-item.js.map

@@ -1 +1 @@
-{"version":3,"file":"claim-item.js","sourceRoot":"","sources":["../../src/models/claim-item.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,mCAUgB;AAChB,4DAAwD;AAExD,yCAAsC;AACtC,6CAA0C;AAC1C,yCAAsC;AACtC,6CAA0C;AAC1C,qDAAkD;AAClD,oFAAgF;AAChF,kEAA8D;AAE9D,IAAY,WAKX;AALD,WAAY,WAAW;IACrB,4CAA6B,CAAA;IAC7B,wCAAyB,CAAA;IACzB,wDAAyC,CAAA;IACzC,8BAAe,CAAA;AACjB,CAAC,EALW,WAAW,GAAX,mBAAW,KAAX,mBAAW,QAKtB;AAGD;IAA+B,6BAAmB;IAAlD;;IA4DA,CAAC;IAHS,gCAAY,GAApB;QACE,IAAI,CAAC,EAAE,GAAG,IAAA,qCAAgB,EAAC,IAAI,CAAC,EAAE,EAAE,MAAM,CAAC,CAAA;IAC7C,CAAC;IAvDD;QAHC,IAAA,mBAAS,EAAC,cAAM,OAAA,wBAAU,EAAV,CAAU,EAAE,UAAC,EAAE,IAAK,OAAA,EAAE,CAAC,UAAU,EAAb,CAAa,EAAE;YAClD,OAAO,EAAE,CAAC,QAAQ,EAAE,QAAQ,CAAC;SAC9B,CAAC;;6CACkB;IAIpB;QAFC,IAAA,eAAK,GAAE;QACP,IAAA,gBAAM,GAAE;;qDACa;IAItB;QAFC,IAAA,mBAAS,EAAC,cAAM,OAAA,wBAAU,EAAV,CAAU,EAAE,UAAC,EAAE,IAAK,OAAA,EAAE,CAAC,WAAW,EAAd,CAAc,CAAC;QACnD,IAAA,oBAAU,EAAC,EAAE,IAAI,EAAE,gBAAgB,EAAE,CAAC;kCAC1B,wBAAU;kDAAA;IAIvB;QAFC,IAAA,eAAK,GAAE;QACP,IAAA,gBAAM,GAAE;;8CACM;IAIf;QAFC,IAAA,mBAAS,EAAC,cAAM,OAAA,oBAAQ,EAAR,CAAQ,CAAC;QACzB,IAAA,oBAAU,EAAC,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC;kCAC1B,oBAAQ;2CAAA;IAId;QAFC,IAAA,eAAK,GAAE;QACP,IAAA,gBAAM,GAAE;;iDACS;IAIlB;QAFC,IAAA,mBAAS,EAAC,cAAM,OAAA,gCAAc,EAAd,CAAc,CAAC;QAC/B,IAAA,oBAAU,EAAC,EAAE,IAAI,EAAE,YAAY,EAAE,CAAC;kCAC1B,gCAAc;8CAAA;IAGvB;QADC,IAAA,+BAAa,EAAC,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,WAAW,EAAE,CAAC;;6CAChC;IAGnB;QADC,IAAA,gBAAM,EAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;2CACf;IAGZ;QADC,IAAA,gBAAM,EAAC,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC;;+CACR;IAchB;QAZC,IAAA,oBAAU,EAAC,cAAM,OAAA,oBAAQ,EAAR,CAAQ,EAAE,EAAE,OAAO,EAAE,CAAC,QAAQ,CAAC,EAAE,CAAC;QACnD,IAAA,mBAAS,EAAC;YACT,IAAI,EAAE,iBAAiB;YACvB,UAAU,EAAE;gBACV,IAAI,EAAE,SAAS;gBACf,oBAAoB,EAAE,IAAI;aAC3B;YACD,iBAAiB,EAAE;gBACjB,IAAI,EAAE,QAAQ;gBACd,oBAAoB,EAAE,IAAI;aAC3B;SACF,CAAC;;2CACc;IAGhB;QADC,IAAA,+BAAa,EAAC,EAAE,IAAI,EAAE,OAAO,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;+CAChB;IAGjC;QADC,IAAA,sBAAY,GAAE;;;;iDAGd;IA3DU,SAAS;QADrB,IAAA,gBAAM,GAAE;OACI,SAAS,CA4DrB;IAAD,gBAAC;CAAA,AA5DD,CAA+B,2CAAmB,GA4DjD;AA5DY,8BAAS;AA8DtB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAsDG"}
+{"version":3,"file":"claim-item.js","sourceRoot":"","sources":["../../src/models/claim-item.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,mCAUgB;AAEhB,6CAA0C;AAC1C,6CAA0C;AAC1C,yCAAsC;AACtC,4DAAwD;AACxD,yCAAsC;AACtC,qDAAkD;AAClD,oFAAgF;AAChF,kEAA8D;AAE9D,IAAY,WAKX;AALD,WAAY,WAAW;IACrB,4CAA6B,CAAA;IAC7B,wCAAyB,CAAA;IACzB,wDAAyC,CAAA;IACzC,8BAAe,CAAA;AACjB,CAAC,EALW,WAAW,GAAX,mBAAW,KAAX,mBAAW,QAKtB;AAGD;IAA+B,6BAAmB;IAAlD;;IA4DA,CAAC;IAHS,gCAAY,GAApB;QACE,IAAI,CAAC,EAAE,GAAG,IAAA,qCAAgB,EAAC,IAAI,CAAC,EAAE,EAAE,MAAM,CAAC,CAAA;IAC7C,CAAC;IAvDD;QAHC,IAAA,mBAAS,EAAC,cAAM,OAAA,wBAAU,EAAV,CAAU,EAAE,UAAC,EAAE,IAAK,OAAA,EAAE,CAAC,UAAU,EAAb,CAAa,EAAE;YAClD,OAAO,EAAE,CAAC,QAAQ,EAAE,QAAQ,CAAC;SAC9B,CAAC;;6CACkB;IAIpB;QAFC,IAAA,eAAK,GAAE;QACP,IAAA,gBAAM,GAAE;;qDACa;IAItB;QAFC,IAAA,mBAAS,EAAC,cAAM,OAAA,wBAAU,EAAV,CAAU,EAAE,UAAC,EAAE,IAAK,OAAA,EAAE,CAAC,WAAW,EAAd,CAAc,CAAC;QACnD,IAAA,oBAAU,EAAC,EAAE,IAAI,EAAE,gBAAgB,EAAE,CAAC;kCAC1B,wBAAU;kDAAA;IAIvB;QAFC,IAAA,eAAK,GAAE;QACP,IAAA,gBAAM,GAAE;;8CACM;IAIf;QAFC,IAAA,mBAAS,EAAC,cAAM,OAAA,oBAAQ,EAAR,CAAQ,CAAC;QACzB,IAAA,oBAAU,EAAC,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC;kCAC1B,oBAAQ;2CAAA;IAId;QAFC,IAAA,eAAK,GAAE;QACP,IAAA,gBAAM,GAAE;;iDACS;IAIlB;QAFC,IAAA,mBAAS,EAAC,cAAM,OAAA,gCAAc,EAAd,CAAc,CAAC;QAC/B,IAAA,oBAAU,EAAC,EAAE,IAAI,EAAE,YAAY,EAAE,CAAC;kCAC1B,gCAAc;8CAAA;IAGvB;QADC,IAAA,+BAAa,EAAC,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,WAAW,EAAE,CAAC;;6CAChC;IAGnB;QADC,IAAA,gBAAM,EAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;2CACf;IAGZ;QADC,IAAA,gBAAM,EAAC,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC;;+CACR;IAchB;QAZC,IAAA,oBAAU,EAAC,cAAM,OAAA,oBAAQ,EAAR,CAAQ,EAAE,EAAE,OAAO,EAAE,CAAC,QAAQ,CAAC,EAAE,CAAC;QACnD,IAAA,mBAAS,EAAC;YACT,IAAI,EAAE,iBAAiB;YACvB,UAAU,EAAE;gBACV,IAAI,EAAE,SAAS;gBACf,oBAAoB,EAAE,IAAI;aAC3B;YACD,iBAAiB,EAAE;gBACjB,IAAI,EAAE,QAAQ;gBACd,oBAAoB,EAAE,IAAI;aAC3B;SACF,CAAC;;2CACc;IAGhB;QADC,IAAA,+BAAa,EAAC,EAAE,IAAI,EAAE,OAAO,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;+CAChB;IAGjC;QADC,IAAA,sBAAY,GAAE;;;;iDAGd;IA3DU,SAAS;QADrB,IAAA,gBAAM,GAAE;OACI,SAAS,CA4DrB;IAAD,gBAAC;CAAA,AA5DD,CAA+B,2CAAmB,GA4DjD;AA5DY,8BAAS;AA8DtB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8EG"}

package/dist/models/claim-order.d.ts

@@ -1,10 +1,10 @@
+import { Address } from "./address";
+import { ClaimItem } from "./claim-item";
 import { Fulfillment } from "./fulfillment";
 import { LineItem } from "./line-item";
-import { ClaimItem } from "./claim-item";
 import { Order } from "./order";
 import { Return } from "./return";
 import { ShippingMethod } from "./shipping-method";
-import { Address } from "./address";
 import { SoftDeletableEntity } from "../interfaces/models/soft-deletable-entity";
 export declare enum ClaimType {
     REFUND = "refund",
@@ -54,9 +54,14 @@ export declare class ClaimOrder extends SoftDeletableEntity {
  * title: "Claim Order"
  * description: "Claim Orders represent a group of faulty or missing items. Each claim order consists of a subset of items associated with an original order, and can contain additional information about fulfillments and returns."
  * x-resourceId: claim_order
+ * required:
+ *   - type
+ *   - order_id
  * properties:
  *   id:
  *     type: string
+ *     description: The claim's ID
+ *     example: claim_01G8ZH853Y6TFXWPG5EYE81X63
  *   type:
  *     type: string
  *     enum:
@@ -64,10 +69,12 @@ export declare class ClaimOrder extends SoftDeletableEntity {
  *       - replace
  *   payment_status:
  *     type: string
+ *     description: The status of the claim's payment
  *     enum:
  *       - na
  *       - not_refunded
  *       - refunded
+ *     default: na
  *   fulfillment_status:
  *     type: string
  *     enum:
@@ -80,6 +87,7 @@ export declare class ClaimOrder extends SoftDeletableEntity {
  *       - returned
  *       - canceled
  *       - requires_action
+ *     default: not_fulfilled
  *   claim_items:
  *     description: "The items that have been claimed"
  *     type: array
@@ -91,16 +99,21 @@ export declare class ClaimOrder extends SoftDeletableEntity {
  *     items:
  *       $ref: "#/components/schemas/line_item"
  *   order_id:
- *     description: "The id of the order that the claim comes from."
+ *     description: "The ID of the order that the claim comes from."
  *     type: string
+ *     example: order_01G8TJSYT9M6AVS5N4EMNFS1EK
+ *   order:
+ *     description: An order object. Available if the relation `order` is expanded.
+ *     type: object
  *   return_order:
- *     description: "Holds information about the return if the claim is to be returned"
- *     $ref: "#/components/schemas/return"
+ *     description: "A return object. Holds information about the return if the claim is to be returned. Available if the relation 'return_order' is expanded"
+ *     type: object
  *   shipping_address_id:
- *     description: "The id of the address that the new items should be shipped to"
+ *     description: "The ID of the address that the new items should be shipped to"
  *     type: string
+ *     example: addr_01G8ZH853YPY9B94857DY91YGW
  *   shipping_address:
- *     description: "The address that the new items should be shipped to"
+ *     description: Available if the relation `shipping_address` is expanded.
  *     $ref: "#/components/schemas/address"
  *   shipping_methods:
  *     description: "The shipping methods that the claim order will be shipped with."
@@ -115,22 +128,35 @@ export declare class ClaimOrder extends SoftDeletableEntity {
  *   refund_amount:
  *     description: "The amount that will be refunded in conjunction with the claim"
  *     type: integer
+ *     example: 1000
  *   canceled_at:
- *     description: "The date with timezone at which the Swap was canceled."
+ *     description: "The date with timezone at which the claim was canceled."
  *     type: string
  *     format: date-time
  *   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
+ *   metadata:
+ *     type: object
+ *     description: An optional key-value map with additional details
+ *     example: {car: "white"}
  *   no_notification:
  *     description: "Flag for describing whether or not notifications related to this should be send."
  *     type: boolean
- *   metadata:
- *     type: object
+ *     example: false
+ *   idempotency_key:
+ *     type: string
+ *     description: Randomly generated key used to continue the completion of the cart associated with the claim in case of failure.
+ *     externalDocs:
+ *       url: https://docs.medusajs.com/advanced/backend/payment/overview#idempotency-key
+ *       description: Learn more how to use the idempotency key.
  */