@medusajs/medusa 1.3.3 → 1.3.6-next.0

package/dist/models/payment.d.ts

@@ -1,8 +1,8 @@
-import { Swap } from "./swap";
-import { Currency } from "./currency";
+import { BaseEntity } from "../interfaces/models/base-entity";
 import { Cart } from "./cart";
+import { Currency } from "./currency";
 import { Order } from "./order";
-import { BaseEntity } from "../interfaces/models/base-entity";
+import { Swap } from "./swap";
 export declare class Payment extends BaseEntity {
     swap_id: string;
     swap: Swap;
@@ -16,8 +16,8 @@ export declare class Payment extends BaseEntity {
     amount_refunded: number;
     provider_id: string;
     data: Record<string, unknown>;
-    captured_at: Date;
-    canceled_at: Date;
+    captured_at: Date | string;
+    canceled_at: Date | string;
     metadata: Record<string, unknown>;
     idempotency_key: string;
     private beforeInsert;
@@ -27,34 +27,61 @@ export declare class Payment extends BaseEntity {
  * title: "Payment"
  * description: "Payments represent an amount authorized with a given payment method, Payments can be captured, canceled or refunded."
  * x-resourceId: payment
+ * required:
+ *   - amount
+ *   - currency_code
+ *   - provider_id
  * properties:
  *   id:
- *     description: "The id of the Payment. This value will be prefixed with `pay_`."
  *     type: string
+ *     description: The payment's ID
+ *     example: pay_01G2SJNT6DEEWDFNAJ4XWDTHKE
  *   swap_id:
- *     description: "The id of the Swap that the Payment is used for."
- *     type: string
- *   order_id:
- *     description: "The id of the Order that the Payment is used for."
+ *     description: "The ID of the Swap that the Payment is used for."
  *     type: string
+ *     example: null
+ *   swap:
+ *     description: A swap object. Available if the relation `swap` is expanded.
+ *     type: object
  *   cart_id:
  *     description: "The id of the Cart that the Payment Session is created for."
  *     type: string
+ *   cart:
+ *     description: A cart object. Available if the relation `cart` is expanded.
+ *     type: object
+ *   order_id:
+ *     description: "The ID of the Order that the Payment is used for."
+ *     type: string
+ *     example: order_01G8TJSYT9M6AVS5N4EMNFS1EK
+ *   order:
+ *     description: An order object. Available if the relation `order` is expanded.
+ *     type: object
  *   amount:
  *     description: "The amount that the Payment has been authorized for."
  *     type: integer
+ *     example: 100
  *   currency_code:
  *     description: "The 3 character ISO currency code that the Payment is completed in."
  *     type: string
+ *     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"
  *   amount_refunded:
  *     description: "The amount of the original Payment amount that has been refunded back to the Customer."
  *     type: integer
+ *     example: 0
  *   provider_id:
  *     description: "The id of the Payment Provider that is responsible for the Payment"
  *     type: string
+ *     example: manual
  *   data:
  *     description: "The data required for the Payment Provider to identify, modify and process the Payment. 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: {}
  *   captured_at:
  *     description: "The date with timezone at which the Payment was captured."
  *     type: string
@@ -63,15 +90,22 @@ export declare class Payment extends BaseEntity {
  *     description: "The date with timezone at which the Payment was canceled."
  *     type: string
  *     format: date-time
+ *   idempotency_key:
+ *     type: string
+ *     description: Randomly generated key used to continue the completion of a payment 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
  *   metadata:
- *     description: "An optional key-value map with additional information."
  *     type: object
+ *     description: An optional key-value map with additional details
+ *     example: {car: "white"}
  */

package/dist/models/payment.js

@@ -27,11 +27,11 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.Payment = void 0;
 var typeorm_1 = require("typeorm");
 var db_aware_column_1 = require("../utils/db-aware-column");
-var swap_1 = require("./swap");
-var currency_1 = require("./currency");
+var base_entity_1 = require("../interfaces/models/base-entity");
 var cart_1 = require("./cart");
+var currency_1 = require("./currency");
 var order_1 = require("./order");
-var base_entity_1 = require("../interfaces/models/base-entity");
+var swap_1 = require("./swap");
 var generate_entity_id_1 = require("../utils/generate-entity-id");
 var Payment = /** @class */ (function (_super) {
     __extends(Payment, _super);
@@ -99,11 +99,11 @@ var Payment = /** @class */ (function (_super) {
     ], Payment.prototype, "data", void 0);
     __decorate([
         (0, typeorm_1.Column)({ type: (0, db_aware_column_1.resolveDbType)("timestamptz"), nullable: true }),
-        __metadata("design:type", Date)
+        __metadata("design:type", Object)
     ], Payment.prototype, "captured_at", void 0);
     __decorate([
         (0, typeorm_1.Column)({ type: (0, db_aware_column_1.resolveDbType)("timestamptz"), nullable: true }),
-        __metadata("design:type", Date)
+        __metadata("design:type", Object)
     ], Payment.prototype, "canceled_at", void 0);
     __decorate([
         (0, db_aware_column_1.DbAwareColumn)({ type: "jsonb", nullable: true }),
@@ -130,34 +130,61 @@ exports.Payment = Payment;
  * title: "Payment"
  * description: "Payments represent an amount authorized with a given payment method, Payments can be captured, canceled or refunded."
  * x-resourceId: payment
+ * required:
+ *   - amount
+ *   - currency_code
+ *   - provider_id
  * properties:
  *   id:
- *     description: "The id of the Payment. This value will be prefixed with `pay_`."
  *     type: string
+ *     description: The payment's ID
+ *     example: pay_01G2SJNT6DEEWDFNAJ4XWDTHKE
  *   swap_id:
- *     description: "The id of the Swap that the Payment is used for."
- *     type: string
- *   order_id:
- *     description: "The id of the Order that the Payment is used for."
+ *     description: "The ID of the Swap that the Payment is used for."
  *     type: string
+ *     example: null
+ *   swap:
+ *     description: A swap object. Available if the relation `swap` is expanded.
+ *     type: object
  *   cart_id:
  *     description: "The id of the Cart that the Payment Session is created for."
  *     type: string
+ *   cart:
+ *     description: A cart object. Available if the relation `cart` is expanded.
+ *     type: object
+ *   order_id:
+ *     description: "The ID of the Order that the Payment is used for."
+ *     type: string
+ *     example: order_01G8TJSYT9M6AVS5N4EMNFS1EK
+ *   order:
+ *     description: An order object. Available if the relation `order` is expanded.
+ *     type: object
  *   amount:
  *     description: "The amount that the Payment has been authorized for."
  *     type: integer
+ *     example: 100
  *   currency_code:
  *     description: "The 3 character ISO currency code that the Payment is completed in."
  *     type: string
+ *     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"
  *   amount_refunded:
  *     description: "The amount of the original Payment amount that has been refunded back to the Customer."
  *     type: integer
+ *     example: 0
  *   provider_id:
  *     description: "The id of the Payment Provider that is responsible for the Payment"
  *     type: string
+ *     example: manual
  *   data:
  *     description: "The data required for the Payment Provider to identify, modify and process the Payment. 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: {}
  *   captured_at:
  *     description: "The date with timezone at which the Payment was captured."
  *     type: string
@@ -166,16 +193,23 @@ exports.Payment = Payment;
  *     description: "The date with timezone at which the Payment was canceled."
  *     type: string
  *     format: date-time
+ *   idempotency_key:
+ *     type: string
+ *     description: Randomly generated key used to continue the completion of a payment 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
  *   metadata:
- *     description: "An optional key-value map with additional information."
  *     type: object
+ *     description: An optional key-value map with additional details
+ *     example: {car: "white"}
  */
 //# sourceMappingURL=payment.js.map

package/dist/models/payment.js.map

@@ -1 +1 @@
-{"version":3,"file":"payment.js","sourceRoot":"","sources":["../../src/models/payment.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,mCAQgB;AAChB,4DAAuE;AAEvE,+BAA6B;AAC7B,uCAAqC;AACrC,+BAA6B;AAC7B,iCAA+B;AAC/B,gEAA6D;AAC7D,kEAA8D;AAG9D;IAA6B,2BAAU;IAAvC;;IA6DA,CAAC;IAHS,8BAAY,GAApB;QACE,IAAI,CAAC,EAAE,GAAG,IAAA,qCAAgB,EAAC,IAAI,CAAC,EAAE,EAAE,KAAK,CAAC,CAAA;IAC5C,CAAC;IAzDD;QAFC,IAAA,eAAK,GAAE;QACP,IAAA,gBAAM,EAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;4CACZ;IAIf;QAFC,IAAA,kBAAQ,EAAC,cAAM,OAAA,WAAI,EAAJ,CAAI,CAAC;QACpB,IAAA,oBAAU,EAAC,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC;kCAC1B,WAAI;yCAAA;IAIV;QAFC,IAAA,eAAK,GAAE;QACP,IAAA,gBAAM,EAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;4CACZ;IAIf;QAFC,IAAA,kBAAQ,EAAC,cAAM,OAAA,WAAI,EAAJ,CAAI,CAAC;QACpB,IAAA,oBAAU,EAAC,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC;kCAC1B,WAAI;yCAAA;IAIV;QAFC,IAAA,eAAK,GAAE;QACP,IAAA,gBAAM,EAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;6CACX;IAIhB;QAFC,IAAA,mBAAS,EAAC,cAAM,OAAA,aAAK,EAAL,CAAK,EAAE,UAAC,KAAK,IAAK,OAAA,KAAK,CAAC,QAAQ,EAAd,CAAc,CAAC;QACjD,IAAA,oBAAU,EAAC,EAAE,IAAI,EAAE,UAAU,EAAE,CAAC;kCAC1B,aAAK;0CAAA;IAGZ;QADC,IAAA,gBAAM,EAAC,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC;;2CACV;IAGd;QADC,IAAA,gBAAM,GAAE;;kDACY;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;6CAAA;IAGlB;QADC,IAAA,gBAAM,EAAC,EAAE,IAAI,EAAE,KAAK,EAAE,OAAO,EAAE,CAAC,EAAE,CAAC;;oDACb;IAIvB;QAFC,IAAA,eAAK,GAAE;QACP,IAAA,gBAAM,GAAE;;gDACU;IAGnB;QADC,IAAA,+BAAa,EAAC,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC;;yCACJ;IAG7B;QADC,IAAA,gBAAM,EAAC,EAAE,IAAI,EAAE,IAAA,+BAAa,EAAC,aAAa,CAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;kCAClD,IAAI;gDAAA;IAGjB;QADC,IAAA,gBAAM,EAAC,EAAE,IAAI,EAAE,IAAA,+BAAa,EAAC,aAAa,CAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;kCAClD,IAAI;gDAAA;IAGjB;QADC,IAAA,+BAAa,EAAC,EAAE,IAAI,EAAE,OAAO,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;6CAChB;IAGjC;QADC,IAAA,gBAAM,EAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;oDACJ;IAGvB;QADC,IAAA,sBAAY,GAAE;;;;+CAGd;IA5DU,OAAO;QADnB,IAAA,gBAAM,GAAE;OACI,OAAO,CA6DnB;IAAD,cAAC;CAAA,AA7DD,CAA6B,wBAAU,GA6DtC;AA7DY,0BAAO;AA+DpB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoDG"}
+{"version":3,"file":"payment.js","sourceRoot":"","sources":["../../src/models/payment.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,mCAQgB;AAChB,4DAAuE;AAEvE,gEAA6D;AAC7D,+BAA6B;AAC7B,uCAAqC;AACrC,iCAA+B;AAC/B,+BAA6B;AAC7B,kEAA8D;AAG9D;IAA6B,2BAAU;IAAvC;;IA6DA,CAAC;IAHS,8BAAY,GAApB;QACE,IAAI,CAAC,EAAE,GAAG,IAAA,qCAAgB,EAAC,IAAI,CAAC,EAAE,EAAE,KAAK,CAAC,CAAA;IAC5C,CAAC;IAzDD;QAFC,IAAA,eAAK,GAAE;QACP,IAAA,gBAAM,EAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;4CACZ;IAIf;QAFC,IAAA,kBAAQ,EAAC,cAAM,OAAA,WAAI,EAAJ,CAAI,CAAC;QACpB,IAAA,oBAAU,EAAC,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC;kCAC1B,WAAI;yCAAA;IAIV;QAFC,IAAA,eAAK,GAAE;QACP,IAAA,gBAAM,EAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;4CACZ;IAIf;QAFC,IAAA,kBAAQ,EAAC,cAAM,OAAA,WAAI,EAAJ,CAAI,CAAC;QACpB,IAAA,oBAAU,EAAC,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC;kCAC1B,WAAI;yCAAA;IAIV;QAFC,IAAA,eAAK,GAAE;QACP,IAAA,gBAAM,EAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;6CACX;IAIhB;QAFC,IAAA,mBAAS,EAAC,cAAM,OAAA,aAAK,EAAL,CAAK,EAAE,UAAC,KAAK,IAAK,OAAA,KAAK,CAAC,QAAQ,EAAd,CAAc,CAAC;QACjD,IAAA,oBAAU,EAAC,EAAE,IAAI,EAAE,UAAU,EAAE,CAAC;kCAC1B,aAAK;0CAAA;IAGZ;QADC,IAAA,gBAAM,EAAC,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC;;2CACV;IAGd;QADC,IAAA,gBAAM,GAAE;;kDACY;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;6CAAA;IAGlB;QADC,IAAA,gBAAM,EAAC,EAAE,IAAI,EAAE,KAAK,EAAE,OAAO,EAAE,CAAC,EAAE,CAAC;;oDACb;IAIvB;QAFC,IAAA,eAAK,GAAE;QACP,IAAA,gBAAM,GAAE;;gDACU;IAGnB;QADC,IAAA,+BAAa,EAAC,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC;;yCACJ;IAG7B;QADC,IAAA,gBAAM,EAAC,EAAE,IAAI,EAAE,IAAA,+BAAa,EAAC,aAAa,CAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;gDACrC;IAG1B;QADC,IAAA,gBAAM,EAAC,EAAE,IAAI,EAAE,IAAA,+BAAa,EAAC,aAAa,CAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;gDACrC;IAG1B;QADC,IAAA,+BAAa,EAAC,EAAE,IAAI,EAAE,OAAO,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;6CAChB;IAGjC;QADC,IAAA,gBAAM,EAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;oDACJ;IAGvB;QADC,IAAA,sBAAY,GAAE;;;;+CAGd;IA5DU,OAAO;QADnB,IAAA,gBAAM,GAAE;OACI,OAAO,CA6DnB;IAAD,cAAC;CAAA,AA7DD,CAA6B,wBAAU,GA6DtC;AA7DY,0BAAO;AA+DpB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAsFG"}

package/dist/models/price-list.d.ts

@@ -18,37 +18,65 @@ export declare class PriceList extends SoftDeletableEntity {
  * title: "Price List"
  * description: "Price Lists represents a set of prices that overrides the default price for one or more product variants."
  * x-resourceId: price_list
+ * required:
+ *   - name
+ *   - description
  * properties:
  *   id:
- *     description: "The id of the Price List. This value will be prefixed by `pl_`."
  *     type: string
+ *     description: The price list's ID
+ *     example: pl_01G8X3CKJXCG5VXVZ87H9KC09W
+ *   name:
+ *     type: string
+ *     description: The price list's name
+ *     example: VIP Prices
+ *   description:
+ *     type: string
+ *     description: The price list's description
+ *     example: Prices for VIP customers
  *   type:
  *     description: "The type of Price List. This can be one of either `sale` or `override`."
  *     type: string
  *     enum:
  *       - sale
  *       - override
+ *     default: sale
+ *   status:
+ *     description: "The status of the Price List"
+ *     type: string
+ *     enum:
+ *       - active
+ *       - draft
+ *     default: draft
  *   starts_at:
  *     description: "The date with timezone that the Price List starts being valid."
- *     type: date-time
+ *     type: string
+ *     format: date-time
  *   ends_at:
  *     description: "The date with timezone that the Price List stops being valid."
- *     type: date-time
+ *     type: string
+ *     format: date-time
  *   customer_groups:
- *     description: "The Customer Groups that the Price List applies to."
+ *     description: The Customer Groups that the Price List applies to. Available if the relation `customer_groups` is expanded.
+ *     type: array
+ *     items:
+ *       type: object
+ *       description: A customer group object.
+ *   prices:
+ *     description: The Money Amounts that are associated with the Price List. Available if the relation `prices` is expanded.
  *     type: array
  *     items:
- *       $ref: "#/components/schemas/customer_group"
+ *       $ref: "#/components/schemas/money_amount"
  *   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
  *   deleted_at:
- *     description: "The date with timezone at which the resource was deleted."
  *     type: string
+ *     description: "The date with timezone at which the resource was deleted."
  *     format: date-time
  */

package/dist/models/price-list.js

@@ -26,8 +26,8 @@ var __metadata = (this && this.__metadata) || function (k, v) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.PriceList = void 0;
 var typeorm_1 = require("typeorm");
-var price_list_1 = require("../types/price-list");
 var db_aware_column_1 = require("../utils/db-aware-column");
+var price_list_1 = require("../types/price-list");
 var customer_group_1 = require("./customer-group");
 var money_amount_1 = require("./money-amount");
 var soft_deletable_entity_1 = require("../interfaces/models/soft-deletable-entity");
@@ -107,38 +107,66 @@ exports.PriceList = PriceList;
  * title: "Price List"
  * description: "Price Lists represents a set of prices that overrides the default price for one or more product variants."
  * x-resourceId: price_list
+ * required:
+ *   - name
+ *   - description
  * properties:
  *   id:
- *     description: "The id of the Price List. This value will be prefixed by `pl_`."
  *     type: string
+ *     description: The price list's ID
+ *     example: pl_01G8X3CKJXCG5VXVZ87H9KC09W
+ *   name:
+ *     type: string
+ *     description: The price list's name
+ *     example: VIP Prices
+ *   description:
+ *     type: string
+ *     description: The price list's description
+ *     example: Prices for VIP customers
  *   type:
  *     description: "The type of Price List. This can be one of either `sale` or `override`."
  *     type: string
  *     enum:
  *       - sale
  *       - override
+ *     default: sale
+ *   status:
+ *     description: "The status of the Price List"
+ *     type: string
+ *     enum:
+ *       - active
+ *       - draft
+ *     default: draft
  *   starts_at:
  *     description: "The date with timezone that the Price List starts being valid."
- *     type: date-time
+ *     type: string
+ *     format: date-time
  *   ends_at:
  *     description: "The date with timezone that the Price List stops being valid."
- *     type: date-time
+ *     type: string
+ *     format: date-time
  *   customer_groups:
- *     description: "The Customer Groups that the Price List applies to."
+ *     description: The Customer Groups that the Price List applies to. Available if the relation `customer_groups` is expanded.
+ *     type: array
+ *     items:
+ *       type: object
+ *       description: A customer group object.
+ *   prices:
+ *     description: The Money Amounts that are associated with the Price List. Available if the relation `prices` is expanded.
  *     type: array
  *     items:
- *       $ref: "#/components/schemas/customer_group"
+ *       $ref: "#/components/schemas/money_amount"
  *   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
  *   deleted_at:
- *     description: "The date with timezone at which the resource was deleted."
  *     type: string
+ *     description: "The date with timezone at which the resource was deleted."
  *     format: date-time
  */
 //# sourceMappingURL=price-list.js.map

package/dist/models/price-list.js.map

@@ -1 +1 @@
-{"version":3,"file":"price-list.js","sourceRoot":"","sources":["../../src/models/price-list.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,mCAOgB;AAChB,kDAAoE;AACpE,4DAAuE;AACvE,mDAAgD;AAChD,+CAA4C;AAC5C,oFAAgF;AAChF,kEAA8D;AAG9D;IAA+B,6BAAmB;IAAlD;;IA+CA,CAAC;IAHS,gCAAY,GAApB;QACE,IAAI,CAAC,EAAE,GAAG,IAAA,qCAAgB,EAAC,IAAI,CAAC,EAAE,EAAE,IAAI,CAAC,CAAA;IAC3C,CAAC;IA5CD;QADC,IAAA,gBAAM,GAAE;;2CACG;IAGZ;QADC,IAAA,gBAAM,GAAE;;kDACU;IAGnB;QADC,IAAA,+BAAa,EAAC,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,0BAAa,EAAE,OAAO,EAAE,MAAM,EAAE,CAAC;;2CACnD;IAGnB;QADC,IAAA,+BAAa,EAAC,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,4BAAe,EAAE,OAAO,EAAE,OAAO,EAAE,CAAC;;6CAClD;IAMvB;QAJC,IAAA,gBAAM,EAAC;YACN,IAAI,EAAE,IAAA,+BAAa,EAAC,aAAa,CAAC;YAClC,QAAQ,EAAE,IAAI;SACf,CAAC;;gDACoB;IAGtB;QADC,IAAA,gBAAM,EAAC,EAAE,IAAI,EAAE,IAAA,+BAAa,EAAC,aAAa,CAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;8CAC3C;IAgBpB;QAdC,IAAA,mBAAS,EAAC;YACT,IAAI,EAAE,4BAA4B;YAClC,UAAU,EAAE;gBACV,IAAI,EAAE,eAAe;gBACrB,oBAAoB,EAAE,IAAI;aAC3B;YACD,iBAAiB,EAAE;gBACjB,IAAI,EAAE,mBAAmB;gBACzB,oBAAoB,EAAE,IAAI;aAC3B;SACF,CAAC;QACD,IAAA,oBAAU,EAAC,cAAM,OAAA,8BAAa,EAAb,CAAa,EAAE,UAAC,EAAE,IAAK,OAAA,EAAE,CAAC,WAAW,EAAd,CAAc,EAAE;YACvD,QAAQ,EAAE,SAAS;SACpB,CAAC;;sDAC8B;IAKhC;QAHC,IAAA,mBAAS,EAAC,cAAM,OAAA,0BAAW,EAAX,CAAW,EAAE,UAAC,WAAW,IAAK,OAAA,WAAW,CAAC,UAAU,EAAtB,CAAsB,EAAE;YACrE,QAAQ,EAAE,SAAS;SACpB,CAAC;;6CACmB;IAGrB;QADC,IAAA,sBAAY,GAAE;;;;iDAGd;IA9CU,SAAS;QADrB,IAAA,gBAAM,GAAE;OACI,SAAS,CA+CrB;IAAD,gBAAC;CAAA,AA/CD,CAA+B,2CAAmB,GA+CjD;AA/CY,8BAAS;AAiDtB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAsCG"}
+{"version":3,"file":"price-list.js","sourceRoot":"","sources":["../../src/models/price-list.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,mCAOgB;AAChB,4DAAuE;AACvE,kDAAoE;AAEpE,mDAAgD;AAChD,+CAA4C;AAC5C,oFAAgF;AAChF,kEAA8D;AAG9D;IAA+B,6BAAmB;IAAlD;;IA+CA,CAAC;IAHS,gCAAY,GAApB;QACE,IAAI,CAAC,EAAE,GAAG,IAAA,qCAAgB,EAAC,IAAI,CAAC,EAAE,EAAE,IAAI,CAAC,CAAA;IAC3C,CAAC;IA5CD;QADC,IAAA,gBAAM,GAAE;;2CACG;IAGZ;QADC,IAAA,gBAAM,GAAE;;kDACU;IAGnB;QADC,IAAA,+BAAa,EAAC,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,0BAAa,EAAE,OAAO,EAAE,MAAM,EAAE,CAAC;;2CACnD;IAGnB;QADC,IAAA,+BAAa,EAAC,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,4BAAe,EAAE,OAAO,EAAE,OAAO,EAAE,CAAC;;6CAClD;IAMvB;QAJC,IAAA,gBAAM,EAAC;YACN,IAAI,EAAE,IAAA,+BAAa,EAAC,aAAa,CAAC;YAClC,QAAQ,EAAE,IAAI;SACf,CAAC;;gDACoB;IAGtB;QADC,IAAA,gBAAM,EAAC,EAAE,IAAI,EAAE,IAAA,+BAAa,EAAC,aAAa,CAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;8CAC3C;IAgBpB;QAdC,IAAA,mBAAS,EAAC;YACT,IAAI,EAAE,4BAA4B;YAClC,UAAU,EAAE;gBACV,IAAI,EAAE,eAAe;gBACrB,oBAAoB,EAAE,IAAI;aAC3B;YACD,iBAAiB,EAAE;gBACjB,IAAI,EAAE,mBAAmB;gBACzB,oBAAoB,EAAE,IAAI;aAC3B;SACF,CAAC;QACD,IAAA,oBAAU,EAAC,cAAM,OAAA,8BAAa,EAAb,CAAa,EAAE,UAAC,EAAE,IAAK,OAAA,EAAE,CAAC,WAAW,EAAd,CAAc,EAAE;YACvD,QAAQ,EAAE,SAAS;SACpB,CAAC;;sDAC8B;IAKhC;QAHC,IAAA,mBAAS,EAAC,cAAM,OAAA,0BAAW,EAAX,CAAW,EAAE,UAAC,WAAW,IAAK,OAAA,WAAW,CAAC,UAAU,EAAtB,CAAsB,EAAE;YACrE,QAAQ,EAAE,SAAS;SACpB,CAAC;;6CACmB;IAGrB;QADC,IAAA,sBAAY,GAAE;;;;iDAGd;IA9CU,SAAS;QADrB,IAAA,gBAAM,GAAE;OACI,SAAS,CA+CrB;IAAD,gBAAC;CAAA,AA/CD,CAA+B,2CAAmB,GA+CjD;AA/CY,8BAAS;AAiDtB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkEG"}

package/dist/models/product-collection.d.ts

@@ -12,34 +12,41 @@ export declare class ProductCollection extends SoftDeletableEntity {
  * title: "Product Collection"
  * description: "Product Collections represents a group of Products that are related."
  * x-resourceId: product_collection
+ * required:
+ *   - title
  * properties:
  *   id:
- *     description: "The id of the Product Collection. This value will be prefixed with `pcol_`."
  *     type: string
+ *     description: The product collection's ID
+ *     example: pcol_01F0YESBFAZ0DV6V831JXWH0BG
  *   title:
  *     description: "The title that the Product Collection is identified by."
  *     type: string
+ *     example: Summer Collection
  *   handle:
  *     description: "A unique string that identifies the Product Collection - can for example be used in slug structures."
  *     type: string
+ *     example: summer-collection
  *   products:
- *     description: "The Products contained in the Product Collection."
+ *     description: The Products contained in the Product Collection. Available if the relation `products` is expanded.
  *     type: array
  *     items:
  *       type: object
+ *       description: A product collection object.
  *   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
  *   deleted_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 deleted."
  *     format: date-time
  *   metadata:
- *     description: "An optional key-value map with additional information."
  *     type: object
+ *     description: An optional key-value map with additional details
+ *     example: {car: "white"}
  */

package/dist/models/product-collection.js

@@ -29,10 +29,10 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ProductCollection = void 0;
 var typeorm_1 = require("typeorm");
-var lodash_1 = __importDefault(require("lodash"));
+var db_aware_column_1 = require("../utils/db-aware-column");
 var product_1 = require("./product");
 var soft_deletable_entity_1 = require("../interfaces/models/soft-deletable-entity");
-var db_aware_column_1 = require("../utils/db-aware-column");
+var lodash_1 = __importDefault(require("lodash"));
 var generate_entity_id_1 = require("../utils/generate-entity-id");
 var ProductCollection = /** @class */ (function (_super) {
     __extends(ProductCollection, _super);
@@ -81,35 +81,42 @@ exports.ProductCollection = ProductCollection;
  * title: "Product Collection"
  * description: "Product Collections represents a group of Products that are related."
  * x-resourceId: product_collection
+ * required:
+ *   - title
  * properties:
  *   id:
- *     description: "The id of the Product Collection. This value will be prefixed with `pcol_`."
  *     type: string
+ *     description: The product collection's ID
+ *     example: pcol_01F0YESBFAZ0DV6V831JXWH0BG
  *   title:
  *     description: "The title that the Product Collection is identified by."
  *     type: string
+ *     example: Summer Collection
  *   handle:
  *     description: "A unique string that identifies the Product Collection - can for example be used in slug structures."
  *     type: string
+ *     example: summer-collection
  *   products:
- *     description: "The Products contained in the Product Collection."
+ *     description: The Products contained in the Product Collection. Available if the relation `products` is expanded.
  *     type: array
  *     items:
  *       type: object
+ *       description: A product collection object.
  *   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
  *   deleted_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 deleted."
  *     format: date-time
  *   metadata:
- *     description: "An optional key-value map with additional information."
  *     type: object
+ *     description: An optional key-value map with additional details
+ *     example: {car: "white"}
  */
 //# sourceMappingURL=product-collection.js.map

package/dist/models/product-collection.js.map

@@ -1 +1 @@
-{"version":3,"file":"product-collection.js","sourceRoot":"","sources":["../../src/models/product-collection.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,mCAAwE;AACxE,kDAAsB;AAEtB,qCAAmC;AACnC,oFAAgF;AAChF,4DAAwD;AACxD,kEAA8D;AAG9D;IAAuC,qCAAmB;IAA1D;;IAuBA,CAAC;IARS,qDAAyB,GAAjC;QACE,IAAI,IAAI,CAAC,EAAE;YAAE,OAAM;QAEnB,IAAI,CAAC,EAAE,GAAG,IAAA,qCAAgB,EAAC,IAAI,CAAC,EAAE,EAAE,MAAM,CAAC,CAAA;QAC3C,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE;YAChB,IAAI,CAAC,MAAM,GAAG,gBAAC,CAAC,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;SACtC;IACH,CAAC;IApBD;QADC,IAAA,gBAAM,GAAE;;oDACI;IAIb;QAFC,IAAA,eAAK,EAAC,EAAE,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,oBAAoB,EAAE,CAAC;QACpD,IAAA,gBAAM,EAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;qDACb;IAGd;QADC,IAAA,mBAAS,EAAC,cAAM,OAAA,iBAAO,EAAP,CAAO,EAAE,UAAC,OAAO,IAAK,OAAA,OAAO,CAAC,UAAU,EAAlB,CAAkB,CAAC;;uDACvC;IAGnB;QADC,IAAA,+BAAa,EAAC,EAAE,IAAI,EAAE,OAAO,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;uDAChB;IAGjC;QADC,IAAA,sBAAY,GAAE;;;;sEAQd;IAtBU,iBAAiB;QAD7B,IAAA,gBAAM,GAAE;OACI,iBAAiB,CAuB7B;IAAD,wBAAC;CAAA,AAvBD,CAAuC,2CAAmB,GAuBzD;AAvBY,8CAAiB;AAyB9B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmCG"}
+{"version":3,"file":"product-collection.js","sourceRoot":"","sources":["../../src/models/product-collection.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,mCAAwE;AAExE,4DAAwD;AACxD,qCAAmC;AACnC,oFAAgF;AAChF,kDAAsB;AACtB,kEAA8D;AAG9D;IAAuC,qCAAmB;IAA1D;;IAuBA,CAAC;IARS,qDAAyB,GAAjC;QACE,IAAI,IAAI,CAAC,EAAE;YAAE,OAAM;QAEnB,IAAI,CAAC,EAAE,GAAG,IAAA,qCAAgB,EAAC,IAAI,CAAC,EAAE,EAAE,MAAM,CAAC,CAAA;QAC3C,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE;YAChB,IAAI,CAAC,MAAM,GAAG,gBAAC,CAAC,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;SACtC;IACH,CAAC;IApBD;QADC,IAAA,gBAAM,GAAE;;oDACI;IAIb;QAFC,IAAA,eAAK,EAAC,EAAE,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,oBAAoB,EAAE,CAAC;QACpD,IAAA,gBAAM,EAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;qDACb;IAGd;QADC,IAAA,mBAAS,EAAC,cAAM,OAAA,iBAAO,EAAP,CAAO,EAAE,UAAC,OAAO,IAAK,OAAA,OAAO,CAAC,UAAU,EAAlB,CAAkB,CAAC;;uDACvC;IAGnB;QADC,IAAA,+BAAa,EAAC,EAAE,IAAI,EAAE,OAAO,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;uDAChB;IAGjC;QADC,IAAA,sBAAY,GAAE;;;;sEAQd;IAtBU,iBAAiB;QAD7B,IAAA,gBAAM,GAAE;OACI,iBAAiB,CAuB7B;IAAD,wBAAC;CAAA,AAvBD,CAAuC,2CAAmB,GAuBzD;AAvBY,8CAAiB;AAyB9B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA0CG"}

package/dist/models/product-option-value.d.ts

@@ -15,32 +15,47 @@ export declare class ProductOptionValue extends SoftDeletableEntity {
  * title: "Product Option Value"
  * description: "A value given to a Product Variant's option set. Product Variant have a Product Option Value for each of the Product Options defined on the Product."
  * x-resourceId: product_option_value
+ * required:
+ *   - value
+ *   - option_id
+ *   - variant_id
  * properties:
  *   id:
- *     description: "The id of the Product Option Value. This value will be prefixed with `optval_`."
  *     type: string
+ *     description: The product option value's ID
+ *     example: optval_01F0YESHR7S6ECD03RF6W12DSJ
  *   value:
  *     description: "The value that the Product Variant has defined for the specific Product Option (e.g. if the Product Option is \"Size\" this value could be \"Small\", \"Medium\" or \"Large\")."
  *     type: string
+ *     example: large
  *   option_id:
- *     description: "The id of the Product Option that the Product Option Value is defined for."
+ *     description: "The ID of the Product Option that the Product Option Value is defined for."
  *     type: string
+ *     example: opt_01F0YESHQBZVKCEXJ24BS6PCX3
+ *   option:
+ *     description: Available if the relation `option` is expanded.
+ *     $ref: "#/components/schemas/product_option"
  *   variant_id:
- *     description: "The id of the Product Variant that the Product Option Value is defined for."
+ *     description: "The ID of the Product Variant that the Product Option Value is defined for."
  *     type: string
+ *     example: variant_01G1G5V2MRX2V3PVSR2WXYPFB6
+ *   variant:
+ *     description: Available if the relation `variant` is expanded.
+ *     $ref: "#/components/schemas/product_variant"
  *   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
  *   deleted_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 deleted."
  *     format: date-time
  *   metadata:
- *     description: "An optional key-value map with additional information."
  *     type: object
+ *     description: An optional key-value map with additional details
+ *     example: {car: "white"}
  */

package/dist/models/product-option-value.js

@@ -26,10 +26,10 @@ var __metadata = (this && this.__metadata) || function (k, v) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ProductOptionValue = void 0;
 var typeorm_1 = require("typeorm");
+var db_aware_column_1 = require("../utils/db-aware-column");
 var product_option_1 = require("./product-option");
 var product_variant_1 = require("./product-variant");
 var soft_deletable_entity_1 = require("../interfaces/models/soft-deletable-entity");
-var db_aware_column_1 = require("../utils/db-aware-column");
 var generate_entity_id_1 = require("../utils/generate-entity-id");
 var ProductOptionValue = /** @class */ (function (_super) {
     __extends(ProductOptionValue, _super);
@@ -86,33 +86,48 @@ exports.ProductOptionValue = ProductOptionValue;
  * title: "Product Option Value"
  * description: "A value given to a Product Variant's option set. Product Variant have a Product Option Value for each of the Product Options defined on the Product."
  * x-resourceId: product_option_value
+ * required:
+ *   - value
+ *   - option_id
+ *   - variant_id
  * properties:
  *   id:
- *     description: "The id of the Product Option Value. This value will be prefixed with `optval_`."
  *     type: string
+ *     description: The product option value's ID
+ *     example: optval_01F0YESHR7S6ECD03RF6W12DSJ
  *   value:
  *     description: "The value that the Product Variant has defined for the specific Product Option (e.g. if the Product Option is \"Size\" this value could be \"Small\", \"Medium\" or \"Large\")."
  *     type: string
+ *     example: large
  *   option_id:
- *     description: "The id of the Product Option that the Product Option Value is defined for."
+ *     description: "The ID of the Product Option that the Product Option Value is defined for."
  *     type: string
+ *     example: opt_01F0YESHQBZVKCEXJ24BS6PCX3
+ *   option:
+ *     description: Available if the relation `option` is expanded.
+ *     $ref: "#/components/schemas/product_option"
  *   variant_id:
- *     description: "The id of the Product Variant that the Product Option Value is defined for."
+ *     description: "The ID of the Product Variant that the Product Option Value is defined for."
  *     type: string
+ *     example: variant_01G1G5V2MRX2V3PVSR2WXYPFB6
+ *   variant:
+ *     description: Available if the relation `variant` is expanded.
+ *     $ref: "#/components/schemas/product_variant"
  *   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
  *   deleted_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 deleted."
  *     format: date-time
  *   metadata:
- *     description: "An optional key-value map with additional information."
  *     type: object
+ *     description: An optional key-value map with additional details
+ *     example: {car: "white"}
  */
 //# sourceMappingURL=product-option-value.js.map