@medusajs/medusa 1.3.3 → 1.3.6-next.0

package/dist/models/order.js

@@ -62,10 +62,10 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Order = exports.PaymentStatus = exports.FulfillmentStatus = exports.OrderStatus = void 0;
 var typeorm_1 = require("typeorm");
-var base_entity_1 = require("../interfaces/models/base-entity");
 var db_aware_column_1 = require("../utils/db-aware-column");
-var manual_auto_increment_1 = require("../utils/manual-auto-increment");
+var feature_flag_decorators_1 = require("../utils/feature-flag-decorators");
 var address_1 = require("./address");
+var base_entity_1 = require("../interfaces/models/base-entity");
 var cart_1 = require("./cart");
 var claim_order_1 = require("./claim-order");
 var currency_1 = require("./currency");
@@ -80,9 +80,11 @@ var payment_1 = require("./payment");
 var refund_1 = require("./refund");
 var region_1 = require("./region");
 var return_1 = require("./return");
+var sales_channel_1 = require("./sales-channel");
 var shipping_method_1 = require("./shipping-method");
 var swap_1 = require("./swap");
 var generate_entity_id_1 = require("../utils/generate-entity-id");
+var manual_auto_increment_1 = require("../utils/manual-auto-increment");
 var OrderStatus;
 (function (OrderStatus) {
     OrderStatus["PENDING"] = "pending";
@@ -330,6 +332,19 @@ var Order = /** @class */ (function (_super) {
         (0, typeorm_1.Column)({ type: "varchar", nullable: true }),
         __metadata("design:type", Object)
     ], Order.prototype, "external_id", void 0);
+    __decorate([
+        (0, feature_flag_decorators_1.FeatureFlagColumn)("sales_channels", { type: "varchar", nullable: true }),
+        __metadata("design:type", Object)
+    ], Order.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
+        // Total fields
+        )
+    ], Order.prototype, "sales_channel", void 0);
     __decorate([
         (0, typeorm_1.BeforeInsert)(),
         __metadata("design:type", Function),
@@ -347,19 +362,29 @@ exports.Order = Order;
  * title: "Order"
  * description: "Represents an order"
  * x-resourceId: order
+ * required:
+ *   - customer_id
+ *   - email
+ *   - region_id
+ *   - currency_code
  * properties:
  *   id:
  *     type: string
+ *     description: The order's ID
+ *     example: order_01G8TJSYT9M6AVS5N4EMNFS1EK
  *   status:
  *     type: string
+ *     description: The order's status
  *     enum:
  *       - pending
  *       - completed
  *       - archived
  *       - canceled
  *       - requires_action
+ *     default: pending
  *   fulfillment_status:
  *     type: string
+ *     description: The order's fulfillment status
  *     enum:
  *       - not_fulfilled
  *       - partially_fulfilled
@@ -370,8 +395,10 @@ exports.Order = Order;
  *       - returned
  *       - canceled
  *       - requires_action
+ *     default: not_fulfilled
  *   payment_status:
  *     type: string
+ *     description: The order's payment status
  *     enum:
  *       - not_paid
  *       - awaiting
@@ -380,117 +407,196 @@ exports.Order = Order;
  *       - refuneded
  *       - canceled
  *       - requires_action
+ *     default: not_paid
  *   display_id:
  *     type: integer
+ *     description: The order's display ID
+ *     example: 2
  *   cart_id:
  *     type: string
- *   currency_code:
+ *     description: The ID of the cart associated with the order
+ *     example: cart_01G8ZH853Y6TFXWPG5EYE81X63
+ *   cart:
+ *     description: A cart object. Available if the relation `cart` is expanded.
+ *     type: object
+ *   customer_id:
  *     type: string
- *   tax_rate:
- *     type: number
- *   discounts:
- *     type: array
- *     items:
- *       $ref: "#/components/schemas/discount"
+ *     description: The ID of the customer associated with the order
+ *     example: cus_01G2SG30J8C85S4A5CHM2S1NS2
+ *   customer:
+ *     description: A customer object. Available if the relation `customer` is expanded.
+ *     type: object
  *   email:
+ *     description: The email associated with the order
  *     type: string
+ *     format: email
  *   billing_address_id:
  *     type: string
+ *     description: The ID of the billing address associated with the order
+ *     example: addr_01G8ZH853YPY9B94857DY91YGW
  *   billing_address:
- *     anyOf:
- *       - $ref: "#/components/schemas/address"
+ *     description: Available if the relation `billing_address` is expanded.
+ *     $ref: "#/components/schemas/address"
  *   shipping_address_id:
  *     type: string
+ *     description: The ID of the shipping address associated with the order
+ *     example: addr_01G8ZH853YPY9B94857DY91YGW
  *   shipping_address:
- *     anyOf:
- *       - $ref: "#/components/schemas/address"
- *   items:
- *     type: array
- *     items:
- *       $ref: "#/components/schemas/line_item"
+ *     description: Available if the relation `shipping_address` is expanded.
+ *     $ref: "#/components/schemas/address"
  *   region_id:
  *     type: string
+ *     description: The region's ID
+ *     example: reg_01G1G5V26T9H8Y0M4JNE3YGA4G
  *   region:
- *     anyOf:
- *       - $ref: "#/components/schemas/region"
- *   gift_cards:
- *     type: array
- *     items:
- *       $ref: "#/components/schemas/gift_card"
- *   customer_id:
+ *     description: A region object. Available if the relation `region` is expanded.
+ *     type: object
+ *   currency_code:
+ *     description: "The 3 character currency code that is used in the order"
  *     type: string
- *   customer:
- *     anyOf:
- *       - $ref: "#/components/schemas/customer"
- *   payment_session:
- *     anyOf:
- *       - $ref: "#/components/schemas/payment_session"
- *   payment_sessions:
+ *     example: usd
+ *     externalDocs:
+ *       url: https://en.wikipedia.org/wiki/ISO_4217#Active_codes
+ *       description: See a list of codes.
+ *   currency:
+ *     description: Available if the relation `currency` is expanded.
+ *     $ref: "#/components/schemas/currency"
+ *   tax_rate:
+ *     description: The order's tax rate
+ *     type: number
+ *     example: 0
+ *   discounts:
  *     type: array
+ *     description: The discounts used in the order. Available if the relation `discounts` is expanded.
  *     items:
- *       $ref: "#/components/schemas/payment_session"
- *   payments:
+ *       type: object
+ *       description: A discount object.
+ *   gift_cards:
  *     type: array
+ *     description: The gift cards used in the order. Available if the relation `gift_cards` is expanded.
  *     items:
- *       $ref: "#/components/schemas/payment"
+ *       type: object
+ *       description: A gift card object.
  *   shipping_methods:
  *     type: array
+ *     description: The shipping methods used in the order. Available if the relation `shipping_methods` is expanded.
  *     items:
  *       $ref: "#/components/schemas/shipping_method"
+ *   payments:
+ *     type: array
+ *     description: The payments used in the order. Available if the relation `payments` is expanded.
+ *     items:
+ *       $ref: "#/components/schemas/payment"
  *   fulfillments:
  *     type: array
+ *     description: The fulfillments used in the order. Available if the relation `fulfillments` is expanded.
  *     items:
  *       $ref: "#/components/schemas/fulfillment"
  *   returns:
  *     type: array
+ *     description: The returns associated with the order. Available if the relation `returns` is expanded.
  *     items:
- *       $ref: "#/components/schemas/return"
+ *       type: object
+ *       description: A return object.
  *   claims:
  *     type: array
+ *     description: The claims associated with the order. Available if the relation `claims` is expanded.
  *     items:
- *       $ref: "#/components/schemas/claim_order"
+ *       type: object
+ *       description: A claim order object.
  *   refunds:
  *     type: array
+ *     description: The refunds associated with the order. Available if the relation `refunds` is expanded.
  *     items:
- *       $ref: "#/components/schemas/refund"
+ *       type: object
+ *       description: A refund object.
  *   swaps:
  *     type: array
+ *     description: The swaps associated with the order. Available if the relation `swaps` is expanded.
  *     items:
- *       $ref: "#/components/schemas/refund"
+ *       type: object
+ *       description: A swap object.
+ *   draft_order_id:
+ *     type: string
+ *     description: The ID of the draft order this order is associated with.
+ *     example: null
+ *   draft_order:
+ *     description: A draft order object. Available if the relation `draft_order` is expanded.
+ *     type: object
+ *   items:
+ *     type: array
+ *     description: The line items that belong to the order. Available if the relation `items` is expanded.
+ *     items:
+ *       $ref: "#/components/schemas/line_item"
  *   gift_card_transactions:
  *     type: array
+ *     description: The gift card transactions used in the order. Available if the relation `gift_card_transactions` is expanded.
  *     items:
  *       $ref: "#/components/schemas/gift_card_transaction"
  *   canceled_at:
  *     type: string
+ *     description: The date the order was canceled on.
  *     format: date-time
- *   created_at:
+ *   no_notification:
+ *     description: "Flag for describing whether or not notifications related to this should be send."
+ *     type: boolean
+ *     example: false
+ *   idempotency_key:
  *     type: string
- *     format: date-time
- *   update_at:
+ *     description: Randomly generated key used to continue the processing of the order 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.
+ *   external_id:
+ *     description: The ID of an external order.
  *     type: string
- *     format: date-time
- *   deleted_at:
+ *     example: null
+ *   sales_channel_id:
  *     type: string
- *     format: date-time
- *   metadata:
+ *     description: The ID of the sales channel this order is associated with.
+ *     example: null
+ *   sales_channel:
+ *     description: A sales channel object. Available if the relation `sales_channel` is expanded.
  *     type: object
  *   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 is returned.
+ *     example: 0
+ *   total:
+ *     type: integer
+ *     description: The total amount of the order
+ *     example: 8200
  *   subtotal:
  *     type: integer
+ *     description: The subtotal of the order
+ *     example: 8000
+ *   paid_total:
+ *     type: integer
+ *     description: The total amount paid
+ *     example: 8000
  *   refundable_amount:
  *     type: integer
+ *     description: The amount that can be refunded
+ *     example: 8200
  *   gift_card_total:
  *     type: integer
- *   paid_total:
+ *     description: The total of gift cards
+ *     example: 0
+ *   gift_card_tax_total:
  *     type: integer
- *   no_notification:
- *     description: "Flag for describing whether or not notifications related to this should be send."
- *     type: boolean
+ *     description: The total of gift cards with taxes
+ *     example: 0
  */
 //# sourceMappingURL=order.js.map

package/dist/models/order.js.map

@@ -1 +1 @@
-{"version":3,"file":"order.js","sourceRoot":"","sources":["../../src/models/order.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,mCAYgB;AAChB,gEAA6D;AAC7D,4DAIiC;AACjC,wEAAoE;AACpE,qCAAmC;AACnC,+BAA6B;AAC7B,6CAA0C;AAC1C,uCAAqC;AACrC,uCAAqC;AACrC,uCAAqC;AACrC,6CAA0C;AAC1C,6CAA2C;AAC3C,yCAAsC;AACtC,iEAA6D;AAC7D,yCAAsC;AACtC,qCAAmC;AACnC,mCAAiC;AACjC,mCAAiC;AACjC,mCAAiC;AACjC,qDAAkD;AAClD,+BAA6B;AAC7B,kEAA8D;AAE9D,IAAY,WAMX;AAND,WAAY,WAAW;IACrB,kCAAmB,CAAA;IACnB,sCAAuB,CAAA;IACvB,oCAAqB,CAAA;IACrB,oCAAqB,CAAA;IACrB,kDAAmC,CAAA;AACrC,CAAC,EANW,WAAW,GAAX,mBAAW,KAAX,mBAAW,QAMtB;AAED,IAAY,iBAUX;AAVD,WAAY,iBAAiB;IAC3B,oDAA+B,CAAA;IAC/B,gEAA2C,CAAA;IAC3C,4CAAuB,CAAA;IACvB,4DAAuC,CAAA;IACvC,wCAAmB,CAAA;IACnB,8DAAyC,CAAA;IACzC,0CAAqB,CAAA;IACrB,0CAAqB,CAAA;IACrB,wDAAmC,CAAA;AACrC,CAAC,EAVW,iBAAiB,GAAjB,yBAAiB,KAAjB,yBAAiB,QAU5B;AAED,IAAY,aAQX;AARD,WAAY,aAAa;IACvB,sCAAqB,CAAA;IACrB,sCAAqB,CAAA;IACrB,sCAAqB,CAAA;IACrB,0DAAyC,CAAA;IACzC,sCAAqB,CAAA;IACrB,sCAAqB,CAAA;IACrB,oDAAmC,CAAA;AACrC,CAAC,EARW,aAAa,GAAb,qBAAa,KAAb,qBAAa,QAQxB;AAGD;IAA2B,yBAAU;IAArC;QAAA,qEAoLC;QAnLU,YAAM,GAAG,OAAO,CAAA;;IAmL3B,CAAC;IAXe,4BAAY,GAA1B;;;;;;wBACE,IAAI,CAAC,EAAE,GAAG,IAAA,qCAAgB,EAAC,IAAI,CAAC,EAAE,EAAE,OAAO,CAAC,CAAA;6BAExC,CAAA,OAAO,CAAC,GAAG,CAAC,QAAQ,KAAK,aAAa,IAAI,CAAC,IAAI,CAAC,UAAU,CAAA,EAA1D,wBAA0D;wBAC9C,qBAAM,IAAA,2CAAmB,EAAC,OAAO,CAAC,EAAA;;wBAA1C,KAAK,GAAG,SAAkC;wBAEhD,IAAI,KAAK,EAAE;4BACT,IAAI,CAAC,UAAU,GAAG,KAAK,CAAA;yBACxB;;;;;;KAEJ;IA/KD;QADC,IAAA,+BAAa,EAAC,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,WAAW,EAAE,OAAO,EAAE,SAAS,EAAE,CAAC;;yCACpD;IAOnB;QALC,IAAA,+BAAa,EAAC;YACb,IAAI,EAAE,MAAM;YACZ,IAAI,EAAE,iBAAiB;YACvB,OAAO,EAAE,eAAe;SACzB,CAAC;;qDACmC;IAGrC;QADC,IAAA,+BAAa,EAAC,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,aAAa,EAAE,OAAO,EAAE,UAAU,EAAE,CAAC;;iDAC7C;IAK7B;QAHC,IAAA,eAAK,GAAE;QACP,IAAA,gBAAM,GAAE;QACR,IAAA,mBAAS,EAAC,IAAA,6CAA2B,EAAC,WAAW,CAAC,CAAC;;6CAClC;IAIlB;QAFC,IAAA,eAAK,GAAE;QACP,IAAA,gBAAM,EAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;0CACZ;IAIf;QAFC,IAAA,kBAAQ,EAAC,cAAM,OAAA,WAAI,EAAJ,CAAI,CAAC;QACpB,IAAA,oBAAU,EAAC,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC;kCAC1B,WAAI;uCAAA;IAIV;QAFC,IAAA,eAAK,GAAE;QACP,IAAA,gBAAM,GAAE;;8CACU;IAInB;QAFC,IAAA,mBAAS,EAAC,cAAM,OAAA,mBAAQ,EAAR,CAAQ,EAAE,EAAE,OAAO,EAAE,CAAC,QAAQ,CAAC,EAAE,CAAC;QAClD,IAAA,oBAAU,EAAC,EAAE,IAAI,EAAE,aAAa,EAAE,CAAC;kCAC1B,mBAAQ;2CAAA;IAGlB;QADC,IAAA,gBAAM,GAAE;;wCACI;IAIb;QAFC,IAAA,eAAK,GAAE;QACP,IAAA,gBAAM,EAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;qDACD;IAI1B;QAFC,IAAA,mBAAS,EAAC,cAAM,OAAA,iBAAO,EAAP,CAAO,EAAE,EAAE,OAAO,EAAE,CAAC,QAAQ,CAAC,EAAE,CAAC;QACjD,IAAA,oBAAU,EAAC,EAAE,IAAI,EAAE,oBAAoB,EAAE,CAAC;kCAC1B,iBAAO;kDAAA;IAIxB;QAFC,IAAA,eAAK,GAAE;QACP,IAAA,gBAAM,EAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;sDACA;IAI3B;QAFC,IAAA,mBAAS,EAAC,cAAM,OAAA,iBAAO,EAAP,CAAO,EAAE,EAAE,OAAO,EAAE,CAAC,QAAQ,CAAC,EAAE,CAAC;QACjD,IAAA,oBAAU,EAAC,EAAE,IAAI,EAAE,qBAAqB,EAAE,CAAC;kCAC1B,iBAAO;mDAAA;IAIzB;QAFC,IAAA,eAAK,GAAE;QACP,IAAA,gBAAM,GAAE;;4CACQ;IAIjB;QAFC,IAAA,mBAAS,EAAC,cAAM,OAAA,eAAM,EAAN,CAAM,CAAC;QACvB,IAAA,oBAAU,EAAC,EAAE,IAAI,EAAE,WAAW,EAAE,CAAC;kCAC1B,eAAM;yCAAA;IAGd;QADC,IAAA,gBAAM,GAAE;;gDACY;IAIrB;QAFC,IAAA,mBAAS,EAAC,cAAM,OAAA,mBAAQ,EAAR,CAAQ,CAAC;QACzB,IAAA,oBAAU,EAAC,EAAE,IAAI,EAAE,eAAe,EAAE,oBAAoB,EAAE,MAAM,EAAE,CAAC;kCAC1D,mBAAQ;2CAAA;IAGlB;QADC,IAAA,gBAAM,EAAC,EAAE,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;2CAClB;IAcvB;QAZC,IAAA,oBAAU,EAAC,cAAM,OAAA,mBAAQ,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,UAAU;gBAChB,oBAAoB,EAAE,IAAI;aAC3B;YACD,iBAAiB,EAAE;gBACjB,IAAI,EAAE,aAAa;gBACnB,oBAAoB,EAAE,IAAI;aAC3B;SACF,CAAC;;4CACmB;IAcrB;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,kBAAkB;YACxB,UAAU,EAAE;gBACV,IAAI,EAAE,UAAU;gBAChB,oBAAoB,EAAE,IAAI;aAC3B;YACD,iBAAiB,EAAE;gBACjB,IAAI,EAAE,cAAc;gBACpB,oBAAoB,EAAE,IAAI;aAC3B;SACF,CAAC;;6CACoB;IAKtB;QAHC,IAAA,mBAAS,EAAC,cAAM,OAAA,gCAAc,EAAd,CAAc,EAAE,UAAC,MAAM,IAAK,OAAA,MAAM,CAAC,KAAK,EAAZ,CAAY,EAAE;YACzD,OAAO,EAAE,CAAC,QAAQ,CAAC;SACpB,CAAC;;mDACgC;IAGlC;QADC,IAAA,mBAAS,EAAC,cAAM,OAAA,iBAAO,EAAP,CAAO,EAAE,UAAC,OAAO,IAAK,OAAA,OAAO,CAAC,KAAK,EAAb,CAAa,EAAE,EAAE,OAAO,EAAE,CAAC,QAAQ,CAAC,EAAE,CAAC;;2CAC3D;IAKnB;QAHC,IAAA,mBAAS,EAAC,cAAM,OAAA,yBAAW,EAAX,CAAW,EAAE,UAAC,WAAW,IAAK,OAAA,WAAW,CAAC,KAAK,EAAjB,CAAiB,EAAE;YAChE,OAAO,EAAE,CAAC,QAAQ,CAAC;SACpB,CAAC;;+CACyB;IAG3B;QADC,IAAA,mBAAS,EAAC,cAAM,OAAA,eAAM,EAAN,CAAM,EAAE,UAAC,GAAG,IAAK,OAAA,GAAG,CAAC,KAAK,EAAT,CAAS,EAAE,EAAE,OAAO,EAAE,CAAC,QAAQ,CAAC,EAAE,CAAC;;0CACpD;IAGjB;QADC,IAAA,mBAAS,EAAC,cAAM,OAAA,wBAAU,EAAV,CAAU,EAAE,UAAC,EAAE,IAAK,OAAA,EAAE,CAAC,KAAK,EAAR,CAAQ,EAAE,EAAE,OAAO,EAAE,CAAC,QAAQ,CAAC,EAAE,CAAC;;yCACnD;IAGpB;QADC,IAAA,mBAAS,EAAC,cAAM,OAAA,eAAM,EAAN,CAAM,EAAE,UAAC,GAAG,IAAK,OAAA,GAAG,CAAC,KAAK,EAAT,CAAS,EAAE,EAAE,OAAO,EAAE,CAAC,QAAQ,CAAC,EAAE,CAAC;;0CACpD;IAGjB;QADC,IAAA,mBAAS,EAAC,cAAM,OAAA,WAAI,EAAJ,CAAI,EAAE,UAAC,IAAI,IAAK,OAAA,IAAI,CAAC,KAAK,EAAV,CAAU,EAAE,EAAE,OAAO,EAAE,CAAC,QAAQ,CAAC,EAAE,CAAC;;wCACxD;IAGb;QADC,IAAA,gBAAM,EAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;iDACL;IAItB;QAFC,IAAA,kBAAQ,EAAC,cAAM,OAAA,wBAAU,EAAV,CAAU,CAAC;QAC1B,IAAA,oBAAU,EAAC,EAAE,IAAI,EAAE,gBAAgB,EAAE,CAAC;kCAC1B,wBAAU;8CAAA;IAKvB;QAHC,IAAA,mBAAS,EAAC,cAAM,OAAA,oBAAQ,EAAR,CAAQ,EAAE,UAAC,QAAQ,IAAK,OAAA,QAAQ,CAAC,KAAK,EAAd,CAAc,EAAE;YACvD,OAAO,EAAE,CAAC,QAAQ,CAAC;SACpB,CAAC;;wCACe;IAGjB;QADC,IAAA,mBAAS,EAAC,cAAM,OAAA,2CAAmB,EAAnB,CAAmB,EAAE,UAAC,EAAE,IAAK,OAAA,EAAE,CAAC,KAAK,EAAR,CAAQ,CAAC;;yDACV;IAG7C;QADC,IAAA,gBAAM,EAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,IAAI,EAAE,IAAA,+BAAa,EAAC,aAAa,CAAC,EAAE,CAAC;kCAClD,IAAI;8CAAA;IAGjB;QADC,IAAA,+BAAa,EAAC,EAAE,IAAI,EAAE,OAAO,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;2CAChB;IAGjC;QADC,IAAA,gBAAM,EAAC,EAAE,IAAI,EAAE,SAAS,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;kDACpB;IAGxB;QADC,IAAA,gBAAM,EAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;kDACJ;IAGvB;QADC,IAAA,gBAAM,EAAC,EAAE,IAAI,EAAE,SAAS,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;8CAClB;IAc1B;QADC,IAAA,sBAAY,GAAE;;;;6CAWd;IAnLU,KAAK;QADjB,IAAA,gBAAM,GAAE;OACI,KAAK,CAoLjB;IAAD,YAAC;CAAA,AApLD,CAA2B,wBAAU,GAoLpC;AApLY,sBAAK;AAsLlB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAsJG"}
+{"version":3,"file":"order.js","sourceRoot":"","sources":["../../src/models/order.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,mCAYgB;AAChB,4DAIiC;AACjC,4EAGyC;AAEzC,qCAAmC;AACnC,gEAA6D;AAC7D,+BAA6B;AAC7B,6CAA0C;AAC1C,uCAAqC;AACrC,uCAAqC;AACrC,uCAAqC;AACrC,6CAA0C;AAC1C,6CAA2C;AAC3C,yCAAsC;AACtC,iEAA6D;AAC7D,yCAAsC;AACtC,qCAAmC;AACnC,mCAAiC;AACjC,mCAAiC;AACjC,mCAAiC;AACjC,iDAA8C;AAC9C,qDAAkD;AAClD,+BAA6B;AAC7B,kEAA8D;AAC9D,wEAAoE;AAEpE,IAAY,WAMX;AAND,WAAY,WAAW;IACrB,kCAAmB,CAAA;IACnB,sCAAuB,CAAA;IACvB,oCAAqB,CAAA;IACrB,oCAAqB,CAAA;IACrB,kDAAmC,CAAA;AACrC,CAAC,EANW,WAAW,GAAX,mBAAW,KAAX,mBAAW,QAMtB;AAED,IAAY,iBAUX;AAVD,WAAY,iBAAiB;IAC3B,oDAA+B,CAAA;IAC/B,gEAA2C,CAAA;IAC3C,4CAAuB,CAAA;IACvB,4DAAuC,CAAA;IACvC,wCAAmB,CAAA;IACnB,8DAAyC,CAAA;IACzC,0CAAqB,CAAA;IACrB,0CAAqB,CAAA;IACrB,wDAAmC,CAAA;AACrC,CAAC,EAVW,iBAAiB,GAAjB,yBAAiB,KAAjB,yBAAiB,QAU5B;AAED,IAAY,aAQX;AARD,WAAY,aAAa;IACvB,sCAAqB,CAAA;IACrB,sCAAqB,CAAA;IACrB,sCAAqB,CAAA;IACrB,0DAAyC,CAAA;IACzC,sCAAqB,CAAA;IACrB,sCAAqB,CAAA;IACrB,oDAAmC,CAAA;AACrC,CAAC,EARW,aAAa,GAAb,qBAAa,KAAb,qBAAa,QAQxB;AAGD;IAA2B,yBAAU;IAArC;QAAA,qEA8LC;QA7LU,YAAM,GAAG,OAAO,CAAA;;IA6L3B,CAAC;IAXe,4BAAY,GAA1B;;;;;;wBACE,IAAI,CAAC,EAAE,GAAG,IAAA,qCAAgB,EAAC,IAAI,CAAC,EAAE,EAAE,OAAO,CAAC,CAAA;6BAExC,CAAA,OAAO,CAAC,GAAG,CAAC,QAAQ,KAAK,aAAa,IAAI,CAAC,IAAI,CAAC,UAAU,CAAA,EAA1D,wBAA0D;wBAC9C,qBAAM,IAAA,2CAAmB,EAAC,OAAO,CAAC,EAAA;;wBAA1C,KAAK,GAAG,SAAkC;wBAEhD,IAAI,KAAK,EAAE;4BACT,IAAI,CAAC,UAAU,GAAG,KAAK,CAAA;yBACxB;;;;;;KAEJ;IAzLD;QADC,IAAA,+BAAa,EAAC,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,WAAW,EAAE,OAAO,EAAE,SAAS,EAAE,CAAC;;yCACpD;IAOnB;QALC,IAAA,+BAAa,EAAC;YACb,IAAI,EAAE,MAAM;YACZ,IAAI,EAAE,iBAAiB;YACvB,OAAO,EAAE,eAAe;SACzB,CAAC;;qDACmC;IAGrC;QADC,IAAA,+BAAa,EAAC,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,aAAa,EAAE,OAAO,EAAE,UAAU,EAAE,CAAC;;iDAC7C;IAK7B;QAHC,IAAA,eAAK,GAAE;QACP,IAAA,gBAAM,GAAE;QACR,IAAA,mBAAS,EAAC,IAAA,6CAA2B,EAAC,WAAW,CAAC,CAAC;;6CAClC;IAIlB;QAFC,IAAA,eAAK,GAAE;QACP,IAAA,gBAAM,EAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;0CACZ;IAIf;QAFC,IAAA,kBAAQ,EAAC,cAAM,OAAA,WAAI,EAAJ,CAAI,CAAC;QACpB,IAAA,oBAAU,EAAC,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC;kCAC1B,WAAI;uCAAA;IAIV;QAFC,IAAA,eAAK,GAAE;QACP,IAAA,gBAAM,GAAE;;8CACU;IAInB;QAFC,IAAA,mBAAS,EAAC,cAAM,OAAA,mBAAQ,EAAR,CAAQ,EAAE,EAAE,OAAO,EAAE,CAAC,QAAQ,CAAC,EAAE,CAAC;QAClD,IAAA,oBAAU,EAAC,EAAE,IAAI,EAAE,aAAa,EAAE,CAAC;kCAC1B,mBAAQ;2CAAA;IAGlB;QADC,IAAA,gBAAM,GAAE;;wCACI;IAIb;QAFC,IAAA,eAAK,GAAE;QACP,IAAA,gBAAM,EAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;qDACD;IAI1B;QAFC,IAAA,mBAAS,EAAC,cAAM,OAAA,iBAAO,EAAP,CAAO,EAAE,EAAE,OAAO,EAAE,CAAC,QAAQ,CAAC,EAAE,CAAC;QACjD,IAAA,oBAAU,EAAC,EAAE,IAAI,EAAE,oBAAoB,EAAE,CAAC;kCAC1B,iBAAO;kDAAA;IAIxB;QAFC,IAAA,eAAK,GAAE;QACP,IAAA,gBAAM,EAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;sDACA;IAI3B;QAFC,IAAA,mBAAS,EAAC,cAAM,OAAA,iBAAO,EAAP,CAAO,EAAE,EAAE,OAAO,EAAE,CAAC,QAAQ,CAAC,EAAE,CAAC;QACjD,IAAA,oBAAU,EAAC,EAAE,IAAI,EAAE,qBAAqB,EAAE,CAAC;kCAC1B,iBAAO;mDAAA;IAIzB;QAFC,IAAA,eAAK,GAAE;QACP,IAAA,gBAAM,GAAE;;4CACQ;IAIjB;QAFC,IAAA,mBAAS,EAAC,cAAM,OAAA,eAAM,EAAN,CAAM,CAAC;QACvB,IAAA,oBAAU,EAAC,EAAE,IAAI,EAAE,WAAW,EAAE,CAAC;kCAC1B,eAAM;yCAAA;IAGd;QADC,IAAA,gBAAM,GAAE;;gDACY;IAIrB;QAFC,IAAA,mBAAS,EAAC,cAAM,OAAA,mBAAQ,EAAR,CAAQ,CAAC;QACzB,IAAA,oBAAU,EAAC,EAAE,IAAI,EAAE,eAAe,EAAE,oBAAoB,EAAE,MAAM,EAAE,CAAC;kCAC1D,mBAAQ;2CAAA;IAGlB;QADC,IAAA,gBAAM,EAAC,EAAE,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;2CAClB;IAcvB;QAZC,IAAA,oBAAU,EAAC,cAAM,OAAA,mBAAQ,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,UAAU;gBAChB,oBAAoB,EAAE,IAAI;aAC3B;YACD,iBAAiB,EAAE;gBACjB,IAAI,EAAE,aAAa;gBACnB,oBAAoB,EAAE,IAAI;aAC3B;SACF,CAAC;;4CACmB;IAcrB;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,kBAAkB;YACxB,UAAU,EAAE;gBACV,IAAI,EAAE,UAAU;gBAChB,oBAAoB,EAAE,IAAI;aAC3B;YACD,iBAAiB,EAAE;gBACjB,IAAI,EAAE,cAAc;gBACpB,oBAAoB,EAAE,IAAI;aAC3B;SACF,CAAC;;6CACoB;IAKtB;QAHC,IAAA,mBAAS,EAAC,cAAM,OAAA,gCAAc,EAAd,CAAc,EAAE,UAAC,MAAM,IAAK,OAAA,MAAM,CAAC,KAAK,EAAZ,CAAY,EAAE;YACzD,OAAO,EAAE,CAAC,QAAQ,CAAC;SACpB,CAAC;;mDACgC;IAGlC;QADC,IAAA,mBAAS,EAAC,cAAM,OAAA,iBAAO,EAAP,CAAO,EAAE,UAAC,OAAO,IAAK,OAAA,OAAO,CAAC,KAAK,EAAb,CAAa,EAAE,EAAE,OAAO,EAAE,CAAC,QAAQ,CAAC,EAAE,CAAC;;2CAC3D;IAKnB;QAHC,IAAA,mBAAS,EAAC,cAAM,OAAA,yBAAW,EAAX,CAAW,EAAE,UAAC,WAAW,IAAK,OAAA,WAAW,CAAC,KAAK,EAAjB,CAAiB,EAAE;YAChE,OAAO,EAAE,CAAC,QAAQ,CAAC;SACpB,CAAC;;+CACyB;IAG3B;QADC,IAAA,mBAAS,EAAC,cAAM,OAAA,eAAM,EAAN,CAAM,EAAE,UAAC,GAAG,IAAK,OAAA,GAAG,CAAC,KAAK,EAAT,CAAS,EAAE,EAAE,OAAO,EAAE,CAAC,QAAQ,CAAC,EAAE,CAAC;;0CACpD;IAGjB;QADC,IAAA,mBAAS,EAAC,cAAM,OAAA,wBAAU,EAAV,CAAU,EAAE,UAAC,EAAE,IAAK,OAAA,EAAE,CAAC,KAAK,EAAR,CAAQ,EAAE,EAAE,OAAO,EAAE,CAAC,QAAQ,CAAC,EAAE,CAAC;;yCACnD;IAGpB;QADC,IAAA,mBAAS,EAAC,cAAM,OAAA,eAAM,EAAN,CAAM,EAAE,UAAC,GAAG,IAAK,OAAA,GAAG,CAAC,KAAK,EAAT,CAAS,EAAE,EAAE,OAAO,EAAE,CAAC,QAAQ,CAAC,EAAE,CAAC;;0CACpD;IAGjB;QADC,IAAA,mBAAS,EAAC,cAAM,OAAA,WAAI,EAAJ,CAAI,EAAE,UAAC,IAAI,IAAK,OAAA,IAAI,CAAC,KAAK,EAAV,CAAU,EAAE,EAAE,OAAO,EAAE,CAAC,QAAQ,CAAC,EAAE,CAAC;;wCACxD;IAGb;QADC,IAAA,gBAAM,EAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;iDACL;IAItB;QAFC,IAAA,kBAAQ,EAAC,cAAM,OAAA,wBAAU,EAAV,CAAU,CAAC;QAC1B,IAAA,oBAAU,EAAC,EAAE,IAAI,EAAE,gBAAgB,EAAE,CAAC;kCAC1B,wBAAU;8CAAA;IAKvB;QAHC,IAAA,mBAAS,EAAC,cAAM,OAAA,oBAAQ,EAAR,CAAQ,EAAE,UAAC,QAAQ,IAAK,OAAA,QAAQ,CAAC,KAAK,EAAd,CAAc,EAAE;YACvD,OAAO,EAAE,CAAC,QAAQ,CAAC;SACpB,CAAC;;wCACe;IAGjB;QADC,IAAA,mBAAS,EAAC,cAAM,OAAA,2CAAmB,EAAnB,CAAmB,EAAE,UAAC,EAAE,IAAK,OAAA,EAAE,CAAC,KAAK,EAAR,CAAQ,CAAC;;yDACV;IAG7C;QADC,IAAA,gBAAM,EAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,IAAI,EAAE,IAAA,+BAAa,EAAC,aAAa,CAAC,EAAE,CAAC;kCAClD,IAAI;8CAAA;IAGjB;QADC,IAAA,+BAAa,EAAC,EAAE,IAAI,EAAE,OAAO,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;2CAChB;IAGjC;QADC,IAAA,gBAAM,EAAC,EAAE,IAAI,EAAE,SAAS,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;kDACpB;IAGxB;QADC,IAAA,gBAAM,EAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;kDACJ;IAGvB;QADC,IAAA,gBAAM,EAAC,EAAE,IAAI,EAAE,SAAS,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;8CAClB;IAG1B;QADC,IAAA,2CAAiB,EAAC,gBAAgB,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;mDAC1C;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;QAE3B,eAAe;;gDAFY;IAe3B;QADC,IAAA,sBAAY,GAAE;;;;6CAWd;IA7LU,KAAK;QADjB,IAAA,gBAAM,GAAE;OACI,KAAK,CA8LjB;IAAD,YAAC;CAAA,AA9LD,CAA2B,wBAAU,GA8LpC;AA9LY,sBAAK;AAgMlB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiPG"}

package/dist/models/payment-provider.d.ts

@@ -7,11 +7,15 @@ export declare class PaymentProvider {
  * title: "Payment Provider"
  * description: "Represents a Payment Provider plugin and holds its installation status."
  * x-resourceId: payment_provider
+ * required:
+ *   - id
  * properties:
  *   id:
  *     description: "The id of the payment provider as given by the plugin."
  *     type: string
+ *     example: manual
  *   is_installed:
  *     description: "Whether the plugin is installed in the current version. Plugins that are no longer installed are not deleted by will have this field set to `false`."
  *     type: boolean
+ *     default: true
  */

package/dist/models/payment-provider.js

@@ -33,12 +33,16 @@ exports.PaymentProvider = PaymentProvider;
  * title: "Payment Provider"
  * description: "Represents a Payment Provider plugin and holds its installation status."
  * x-resourceId: payment_provider
+ * required:
+ *   - id
  * properties:
  *   id:
  *     description: "The id of the payment provider as given by the plugin."
  *     type: string
+ *     example: manual
  *   is_installed:
  *     description: "Whether the plugin is installed in the current version. Plugins that are no longer installed are not deleted by will have this field set to `false`."
  *     type: boolean
+ *     default: true
  */
 //# sourceMappingURL=payment-provider.js.map

package/dist/models/payment-provider.js.map

@@ -1 +1 @@
-{"version":3,"file":"payment-provider.js","sourceRoot":"","sources":["../../src/models/payment-provider.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,mCAAuD;AAGvD;IAAA;IAMA,CAAC;IAJC;QADC,IAAA,uBAAa,GAAE;;+CACN;IAGV;QADC,IAAA,gBAAM,EAAC,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC;;yDACL;IALV,eAAe;QAD3B,IAAA,gBAAM,GAAE;OACI,eAAe,CAM3B;IAAD,sBAAC;CAAA,AAND,IAMC;AANY,0CAAe;AAQ5B;;;;;;;;;;;;GAYG"}
+{"version":3,"file":"payment-provider.js","sourceRoot":"","sources":["../../src/models/payment-provider.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,mCAAuD;AAGvD;IAAA;IAMA,CAAC;IAJC;QADC,IAAA,uBAAa,GAAE;;+CACN;IAGV;QADC,IAAA,gBAAM,EAAC,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC;;yDACL;IALV,eAAe;QAD3B,IAAA,gBAAM,GAAE;OACI,eAAe,CAM3B;IAAD,sBAAC;CAAA,AAND,IAMC;AANY,0CAAe;AAQ5B;;;;;;;;;;;;;;;;GAgBG"}

package/dist/models/payment-session.d.ts

@@ -1,4 +1,4 @@
-import { BaseEntity } from "../interfaces/models/base-entity";
+import { BaseEntity } from "../interfaces";
 import { Cart } from "./cart";
 export declare enum PaymentSessionStatus {
     AUTHORIZED = "authorized",
@@ -22,19 +22,30 @@ export declare class PaymentSession extends BaseEntity {
  * title: "Payment Session"
  * description: "Payment Sessions are created when a Customer initilizes the checkout flow, and can be used to hold the state of a payment flow. Each Payment Session is controlled by a Payment Provider, who is responsible for the communication with external payment services. Authorized Payment Sessions will eventually get promoted to Payments to indicate that they are authorized for capture/refunds/etc."
  * x-resourceId: payment_session
+ * required:
+ *   - cart_id
+ *   - provider_id
+ *   - status
  * properties:
  *   id:
- *     description: "The id of the Payment Session. This value will be prefixed with `ps_`."
  *     type: string
+ *     description: The payment session's ID
+ *     example: ps_01G901XNSRM2YS3ASN9H5KG3FZ
  *   cart_id:
  *     description: "The id of the Cart that the Payment Session is created for."
  *     type: string
+ *     example: cart_01G8ZH853Y6TFXWPG5EYE81X63
+ *   cart:
+ *     description: A cart object. Available if the relation `cart` is expanded.
+ *     type: object
  *   provider_id:
  *     description: "The id of the Payment Provider that is responsible for the Payment Session"
  *     type: string
+ *     example: manual
  *   is_selected:
  *     description: "A flag to indicate if the Payment Session has been selected as the method that will be used to complete the purchase."
  *     type: boolean
+ *     example: true
  *   status:
  *     description: "Indicates the status of the Payment Session. Will default to `pending`, and will eventually become `authorized`. Payment Sessions may have the status of `requires_more` to indicate that further actions are to be completed by the Customer."
  *     type: string
@@ -44,15 +55,23 @@ export declare class PaymentSession extends BaseEntity {
  *       - requires_more
  *       - error
  *       - canceled
+ *     example: pending
  *   data:
  *     description: "The data required for the Payment Provider to identify, modify and process the Payment Session. Typically this will be an object that holds an id to the external payment session, but can be an empty object if the Payment Provider doesn't hold any state."
  *     type: object
+ *     example: {}
+ *   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.
  *   created_at:
- *     description: "The date with timezone at which the resource was created."
  *     type: string
+ *     description: "The date with timezone at which the resource was created."
  *     format: date-time
  *   updated_at:
- *     description: "The date with timezone at which the resource was last updated."
  *     type: string
+ *     description: "The date with timezone at which the resource was updated."
  *     format: date-time
  */

package/dist/models/payment-session.js

@@ -26,10 +26,10 @@ var __metadata = (this && this.__metadata) || function (k, v) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.PaymentSession = exports.PaymentSessionStatus = void 0;
 var typeorm_1 = require("typeorm");
-var base_entity_1 = require("../interfaces/models/base-entity");
-var db_aware_column_1 = require("../utils/db-aware-column");
+var interfaces_1 = require("../interfaces");
 var cart_1 = require("./cart");
-var generate_entity_id_1 = require("../utils/generate-entity-id");
+var db_aware_column_1 = require("../utils/db-aware-column");
+var utils_1 = require("../utils");
 var PaymentSessionStatus;
 (function (PaymentSessionStatus) {
     PaymentSessionStatus["AUTHORIZED"] = "authorized";
@@ -44,7 +44,7 @@ var PaymentSession = /** @class */ (function (_super) {
         return _super !== null && _super.apply(this, arguments) || this;
     }
     PaymentSession.prototype.beforeInsert = function () {
-        this.id = (0, generate_entity_id_1.generateEntityId)(this.id, "ps");
+        this.id = (0, utils_1.generateEntityId)(this.id, "ps");
     };
     __decorate([
         (0, typeorm_1.Index)(),
@@ -85,29 +85,41 @@ var PaymentSession = /** @class */ (function (_super) {
     ], PaymentSession.prototype, "beforeInsert", null);
     PaymentSession = __decorate([
         (0, typeorm_1.Unique)("OneSelected", ["cart_id", "is_selected"]),
+        (0, typeorm_1.Unique)("UniqPaymentSessionCartIdProviderId", ["cart_id", "provider_id"]),
         (0, typeorm_1.Entity)()
     ], PaymentSession);
     return PaymentSession;
-}(base_entity_1.BaseEntity));
+}(interfaces_1.BaseEntity));
 exports.PaymentSession = PaymentSession;
 /**
  * @schema payment_session
  * title: "Payment Session"
  * description: "Payment Sessions are created when a Customer initilizes the checkout flow, and can be used to hold the state of a payment flow. Each Payment Session is controlled by a Payment Provider, who is responsible for the communication with external payment services. Authorized Payment Sessions will eventually get promoted to Payments to indicate that they are authorized for capture/refunds/etc."
  * x-resourceId: payment_session
+ * required:
+ *   - cart_id
+ *   - provider_id
+ *   - status
  * properties:
  *   id:
- *     description: "The id of the Payment Session. This value will be prefixed with `ps_`."
  *     type: string
+ *     description: The payment session's ID
+ *     example: ps_01G901XNSRM2YS3ASN9H5KG3FZ
  *   cart_id:
  *     description: "The id of the Cart that the Payment Session is created for."
  *     type: string
+ *     example: cart_01G8ZH853Y6TFXWPG5EYE81X63
+ *   cart:
+ *     description: A cart object. Available if the relation `cart` is expanded.
+ *     type: object
  *   provider_id:
  *     description: "The id of the Payment Provider that is responsible for the Payment Session"
  *     type: string
+ *     example: manual
  *   is_selected:
  *     description: "A flag to indicate if the Payment Session has been selected as the method that will be used to complete the purchase."
  *     type: boolean
+ *     example: true
  *   status:
  *     description: "Indicates the status of the Payment Session. Will default to `pending`, and will eventually become `authorized`. Payment Sessions may have the status of `requires_more` to indicate that further actions are to be completed by the Customer."
  *     type: string
@@ -117,16 +129,24 @@ exports.PaymentSession = PaymentSession;
  *       - requires_more
  *       - error
  *       - canceled
+ *     example: pending
  *   data:
  *     description: "The data required for the Payment Provider to identify, modify and process the Payment Session. Typically this will be an object that holds an id to the external payment session, but can be an empty object if the Payment Provider doesn't hold any state."
  *     type: object
+ *     example: {}
+ *   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.
  *   created_at:
- *     description: "The date with timezone at which the resource was created."
  *     type: string
+ *     description: "The date with timezone at which the resource was created."
  *     format: date-time
  *   updated_at:
- *     description: "The date with timezone at which the resource was last updated."
  *     type: string
+ *     description: "The date with timezone at which the resource was updated."
  *     format: date-time
  */
 //# sourceMappingURL=payment-session.js.map

package/dist/models/payment-session.js.map

@@ -1 +1 @@
-{"version":3,"file":"payment-session.js","sourceRoot":"","sources":["../../src/models/payment-session.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,mCAQgB;AAChB,gEAA6D;AAC7D,4DAAwD;AACxD,+BAA6B;AAC7B,kEAA8D;AAE9D,IAAY,oBAMX;AAND,WAAY,oBAAoB;IAC9B,iDAAyB,CAAA;IACzB,2CAAmB,CAAA;IACnB,uDAA+B,CAAA;IAC/B,uCAAe,CAAA;IACf,6CAAqB,CAAA;AACvB,CAAC,EANW,oBAAoB,GAApB,4BAAoB,KAApB,4BAAoB,QAM/B;AAID;IAAoC,kCAAU;IAA9C;;IA6BA,CAAC;IAHS,qCAAY,GAApB;QACE,IAAI,CAAC,EAAE,GAAG,IAAA,qCAAgB,EAAC,IAAI,CAAC,EAAE,EAAE,IAAI,CAAC,CAAA;IAC3C,CAAC;IAzBD;QAFC,IAAA,eAAK,GAAE;QACP,IAAA,gBAAM,GAAE;;mDACM;IAIf;QAFC,IAAA,mBAAS,EAAC,cAAM,OAAA,WAAI,EAAJ,CAAI,EAAE,UAAC,IAAI,IAAK,OAAA,IAAI,CAAC,gBAAgB,EAArB,CAAqB,CAAC;QACtD,IAAA,oBAAU,EAAC,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC;kCAC1B,WAAI;gDAAA;IAIV;QAFC,IAAA,eAAK,GAAE;QACP,IAAA,gBAAM,GAAE;;uDACU;IAGnB;QADC,IAAA,gBAAM,EAAC,EAAE,IAAI,EAAE,SAAS,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;uDACjB;IAG3B;QADC,IAAA,+BAAa,EAAC,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,oBAAoB,EAAE,CAAC;;kDAC9C;IAGd;QADC,IAAA,+BAAa,EAAC,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC;;gDACJ;IAG7B;QADC,IAAA,gBAAM,EAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;2DACJ;IAGvB;QADC,IAAA,sBAAY,GAAE;;;;sDAGd;IA5BU,cAAc;QAF1B,IAAA,gBAAM,EAAC,aAAa,EAAE,CAAC,SAAS,EAAE,aAAa,CAAC,CAAC;QACjD,IAAA,gBAAM,GAAE;OACI,cAAc,CA6B1B;IAAD,qBAAC;CAAA,AA7BD,CAAoC,wBAAU,GA6B7C;AA7BY,wCAAc;AA+B3B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAsCG"}
+{"version":3,"file":"payment-session.js","sourceRoot":"","sources":["../../src/models/payment-session.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,mCAQgB;AAEhB,4CAA0C;AAC1C,+BAA6B;AAC7B,4DAAwD;AACxD,kCAA2C;AAE3C,IAAY,oBAMX;AAND,WAAY,oBAAoB;IAC9B,iDAAyB,CAAA;IACzB,2CAAmB,CAAA;IACnB,uDAA+B,CAAA;IAC/B,uCAAe,CAAA;IACf,6CAAqB,CAAA;AACvB,CAAC,EANW,oBAAoB,GAApB,4BAAoB,KAApB,4BAAoB,QAM/B;AAKD;IAAoC,kCAAU;IAA9C;;IA6BA,CAAC;IAHS,qCAAY,GAApB;QACE,IAAI,CAAC,EAAE,GAAG,IAAA,wBAAgB,EAAC,IAAI,CAAC,EAAE,EAAE,IAAI,CAAC,CAAA;IAC3C,CAAC;IAzBD;QAFC,IAAA,eAAK,GAAE;QACP,IAAA,gBAAM,GAAE;;mDACM;IAIf;QAFC,IAAA,mBAAS,EAAC,cAAM,OAAA,WAAI,EAAJ,CAAI,EAAE,UAAC,IAAI,IAAK,OAAA,IAAI,CAAC,gBAAgB,EAArB,CAAqB,CAAC;QACtD,IAAA,oBAAU,EAAC,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC;kCAC1B,WAAI;gDAAA;IAIV;QAFC,IAAA,eAAK,GAAE;QACP,IAAA,gBAAM,GAAE;;uDACU;IAGnB;QADC,IAAA,gBAAM,EAAC,EAAE,IAAI,EAAE,SAAS,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;uDACjB;IAG3B;QADC,IAAA,+BAAa,EAAC,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,oBAAoB,EAAE,CAAC;;kDAC9C;IAGd;QADC,IAAA,+BAAa,EAAC,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC;;gDACJ;IAG7B;QADC,IAAA,gBAAM,EAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;2DACJ;IAGvB;QADC,IAAA,sBAAY,GAAE;;;;sDAGd;IA5BU,cAAc;QAH1B,IAAA,gBAAM,EAAC,aAAa,EAAE,CAAC,SAAS,EAAE,aAAa,CAAC,CAAC;QACjD,IAAA,gBAAM,EAAC,oCAAoC,EAAE,CAAC,SAAS,EAAE,aAAa,CAAC,CAAC;QACxE,IAAA,gBAAM,GAAE;OACI,cAAc,CA6B1B;IAAD,qBAAC;CAAA,AA7BD,CAAoC,uBAAU,GA6B7C;AA7BY,wCAAc;AA+B3B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAyDG"}