@medusajs/medusa 1.3.3 → 1.3.6-next.0

package/dist/models/gift-card-transaction.js

@@ -11,10 +11,10 @@ var __metadata = (this && this.__metadata) || function (k, v) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.GiftCardTransaction = void 0;
 var typeorm_1 = require("typeorm");
-var db_aware_column_1 = require("../utils/db-aware-column");
 var gift_card_1 = require("./gift-card");
 var order_1 = require("./order");
 var generate_entity_id_1 = require("../utils/generate-entity-id");
+var db_aware_column_1 = require("../utils/db-aware-column");
 var GiftCardTransaction = /** @class */ (function () {
     function GiftCardTransaction() {
     }
@@ -52,6 +52,14 @@ var GiftCardTransaction = /** @class */ (function () {
         (0, typeorm_1.CreateDateColumn)({ type: (0, db_aware_column_1.resolveDbType)("timestamptz") }),
         __metadata("design:type", Date)
     ], GiftCardTransaction.prototype, "created_at", void 0);
+    __decorate([
+        (0, typeorm_1.Column)({ nullable: true }),
+        __metadata("design:type", Boolean)
+    ], GiftCardTransaction.prototype, "is_taxable", void 0);
+    __decorate([
+        (0, typeorm_1.Column)({ type: "real", nullable: true }),
+        __metadata("design:type", Object)
+    ], GiftCardTransaction.prototype, "tax_rate", void 0);
     __decorate([
         (0, typeorm_1.BeforeInsert)(),
         __metadata("design:type", Function),
@@ -70,26 +78,43 @@ exports.GiftCardTransaction = GiftCardTransaction;
  * title: "Gift Card Transaction"
  * description: "Gift Card Transactions are created once a Customer uses a Gift Card to pay for their Order"
  * x-resourceId: gift_card_transaction
+ * required:
+ *   - gift_card_id
+ *   - amount
  * properties:
  *   id:
- *     description: "The id of the Gift Card Transaction. This value will be prefixed by `gct_`."
  *     type: string
+ *     description: The gift card transaction's ID
+ *     example: gct_01G8X9A7ESKAJXG2H0E6F1MW7A
  *   gift_card_id:
- *     description: "The id of the Gift Card that was used in the transaction."
+ *     description: "The ID of the Gift Card that was used in the transaction."
  *     type: string
+ *     example: gift_01G8XKBPBQY2R7RBET4J7E0XQZ
  *   gift_card:
- *     description: "The Gift Card that was used in the transaction."
- *     anyOf:
- *       - $ref: "#/components/schemas/gift_card"
+ *     description: A gift card object. Available if the relation `gift_card` is expanded.
+ *     type: object
  *   order_id:
- *     description: "The id of the Order that the Gift Card was used to pay for."
+ *     description: "The ID of the Order that the Gift Card was used to pay 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 was used from the Gift Card."
  *     type: integer
+ *     example: 10
  *   created_at:
  *     description: "The date with timezone at which the resource was created."
  *     type: string
  *     format: date-time
+ *   is_taxable:
+ *     description: "Whether the transaction is taxable or not."
+ *     type: boolean
+ *     example: false
+ *   tax_rate:
+ *     description: "The tax rate of the transaction"
+ *     type: number
+ *     example: 0
  */
 //# sourceMappingURL=gift-card-transaction.js.map

package/dist/models/gift-card-transaction.js.map

@@ -1 +1 @@
-{"version":3,"file":"gift-card-transaction.js","sourceRoot":"","sources":["../../src/models/gift-card-transaction.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,mCAUgB;AAChB,4DAAwD;AAExD,yCAAsC;AACtC,iCAA+B;AAC/B,kEAA8D;AAI9D;IAAA;IA6BA,CAAC;IAHS,0CAAY,GAApB;QACE,IAAI,CAAC,EAAE,GAAG,IAAA,qCAAgB,EAAC,IAAI,CAAC,EAAE,EAAE,KAAK,CAAC,CAAA;IAC5C,CAAC;IA1BD;QADC,IAAA,uBAAa,GAAE;;mDACN;IAGV;QADC,IAAA,gBAAM,GAAE;;6DACW;IAIpB;QAFC,IAAA,mBAAS,EAAC,cAAM,OAAA,oBAAQ,EAAR,CAAQ,CAAC;QACzB,IAAA,oBAAU,EAAC,EAAE,IAAI,EAAE,cAAc,EAAE,CAAC;kCAC1B,oBAAQ;0DAAA;IAInB;QAFC,IAAA,eAAK,GAAE;QACP,IAAA,gBAAM,GAAE;;yDACO;IAIhB;QAFC,IAAA,mBAAS,EAAC,cAAM,OAAA,aAAK,EAAL,CAAK,CAAC;QACtB,IAAA,oBAAU,EAAC,EAAE,IAAI,EAAE,UAAU,EAAE,CAAC;kCAC1B,aAAK;sDAAA;IAGZ;QADC,IAAA,gBAAM,EAAC,KAAK,CAAC;;uDACA;IAGd;QADC,IAAA,0BAAgB,EAAC,EAAE,IAAI,EAAE,IAAA,+BAAa,EAAC,aAAa,CAAC,EAAE,CAAC;kCAC7C,IAAI;2DAAA;IAGhB;QADC,IAAA,sBAAY,GAAE;;;;2DAGd;IA5BU,mBAAmB;QAF/B,IAAA,gBAAM,EAAC,QAAQ,EAAE,CAAC,cAAc,EAAE,UAAU,CAAC,CAAC;QAC9C,IAAA,gBAAM,GAAE;OACI,mBAAmB,CA6B/B;IAAD,0BAAC;CAAA,AA7BD,IA6BC;AA7BY,kDAAmB;AA+BhC;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG"}
+{"version":3,"file":"gift-card-transaction.js","sourceRoot":"","sources":["../../src/models/gift-card-transaction.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,mCAUgB;AAEhB,yCAAsC;AACtC,iCAA+B;AAC/B,kEAA8D;AAC9D,4DAAwD;AAIxD;IAAA;IAmCA,CAAC;IAHS,0CAAY,GAApB;QACE,IAAI,CAAC,EAAE,GAAG,IAAA,qCAAgB,EAAC,IAAI,CAAC,EAAE,EAAE,KAAK,CAAC,CAAA;IAC5C,CAAC;IAhCD;QADC,IAAA,uBAAa,GAAE;;mDACN;IAGV;QADC,IAAA,gBAAM,GAAE;;6DACW;IAIpB;QAFC,IAAA,mBAAS,EAAC,cAAM,OAAA,oBAAQ,EAAR,CAAQ,CAAC;QACzB,IAAA,oBAAU,EAAC,EAAE,IAAI,EAAE,cAAc,EAAE,CAAC;kCAC1B,oBAAQ;0DAAA;IAInB;QAFC,IAAA,eAAK,GAAE;QACP,IAAA,gBAAM,GAAE;;yDACO;IAIhB;QAFC,IAAA,mBAAS,EAAC,cAAM,OAAA,aAAK,EAAL,CAAK,CAAC;QACtB,IAAA,oBAAU,EAAC,EAAE,IAAI,EAAE,UAAU,EAAE,CAAC;kCAC1B,aAAK;sDAAA;IAGZ;QADC,IAAA,gBAAM,EAAC,KAAK,CAAC;;uDACA;IAGd;QADC,IAAA,0BAAgB,EAAC,EAAE,IAAI,EAAE,IAAA,+BAAa,EAAC,aAAa,CAAC,EAAE,CAAC;kCAC7C,IAAI;2DAAA;IAGhB;QADC,IAAA,gBAAM,EAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;2DACR;IAGnB;QADC,IAAA,gBAAM,EAAC,EAAE,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;yDAClB;IAGvB;QADC,IAAA,sBAAY,GAAE;;;;2DAGd;IAlCU,mBAAmB;QAF/B,IAAA,gBAAM,EAAC,QAAQ,EAAE,CAAC,cAAc,EAAE,UAAU,CAAC,CAAC;QAC9C,IAAA,gBAAM,GAAE;OACI,mBAAmB,CAmC/B;IAAD,0BAAC;CAAA,AAnCD,IAmCC;AAnCY,kDAAmB;AAqChC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2CG"}

package/dist/models/gift-card.d.ts

@@ -1,5 +1,5 @@
-import { Region } from "./region";
 import { Order } from "./order";
+import { Region } from "./region";
 import { SoftDeletableEntity } from "../interfaces/models/soft-deletable-entity";
 export declare class GiftCard extends SoftDeletableEntity {
     code: string;
@@ -19,49 +19,64 @@ export declare class GiftCard extends SoftDeletableEntity {
  * title: "Gift Card"
  * description: "Gift Cards are redeemable and represent a value that can be used towards the payment of an Order."
  * x-resourceId: gift_card
+ * required:
+ *   - code
+ *   - value
+ *   - balance
+ *   - region_id
  * properties:
  *   id:
- *     description: "The id of the Gift Card. This value will be prefixed by `gift_`."
  *     type: string
+ *     description: The cart's ID
+ *     example: gift_01G8XKBPBQY2R7RBET4J7E0XQZ
  *   code:
  *     description: "The unique code that identifies the Gift Card. This is used by the Customer to redeem the value of the Gift Card."
  *     type: string
+ *     example: 3RFT-MH2C-Y4YZ-XMN4
  *   value:
  *     description: "The value that the Gift Card represents."
  *     type: integer
+ *     example: 10
  *   balance:
  *     description: "The remaining value on the Gift Card."
  *     type: integer
+ *     example: 10
  *   region_id:
- *     description: "The id of the Region in which the Gift Card is available."
  *     type: string
+ *     description: "The id of the Region in which the Gift Card is available."
+ *     example: reg_01G1G5V26T9H8Y0M4JNE3YGA4G
  *   region:
- *     description: "The Region in which the Gift Card is available."
- *     anyOf:
- *       - $ref: "#/components/schemas/region"
+ *     description: A region object. Available if the relation `region` is expanded.
+ *     type: object
  *   order_id:
- *     description: "The id of the Order that the Gift Card was purchased in."
  *     type: string
+ *     description: "The id of the Order that the Gift Card was purchased in."
+ *     example: order_01G8TJSYT9M6AVS5N4EMNFS1EK
+ *   order:
+ *     description: An order object. Available if the relation `order` is expanded.
+ *     type: object
  *   is_disabled:
  *     description: "Whether the Gift Card has been disabled. Disabled Gift Cards cannot be applied to carts."
  *     type: boolean
+ *     example: false
  *   ends_at:
  *     description: "The time at which the Gift Card can no longer be used."
  *     type: string
  *     format: date-time
  *   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
  *   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/gift-card.js

@@ -27,8 +27,8 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.GiftCard = void 0;
 var typeorm_1 = require("typeorm");
 var db_aware_column_1 = require("../utils/db-aware-column");
-var region_1 = require("./region");
 var order_1 = require("./order");
+var region_1 = require("./region");
 var soft_deletable_entity_1 = require("../interfaces/models/soft-deletable-entity");
 var generate_entity_id_1 = require("../utils/generate-entity-id");
 var GiftCard = /** @class */ (function (_super) {
@@ -104,50 +104,65 @@ exports.GiftCard = GiftCard;
  * title: "Gift Card"
  * description: "Gift Cards are redeemable and represent a value that can be used towards the payment of an Order."
  * x-resourceId: gift_card
+ * required:
+ *   - code
+ *   - value
+ *   - balance
+ *   - region_id
  * properties:
  *   id:
- *     description: "The id of the Gift Card. This value will be prefixed by `gift_`."
  *     type: string
+ *     description: The cart's ID
+ *     example: gift_01G8XKBPBQY2R7RBET4J7E0XQZ
  *   code:
  *     description: "The unique code that identifies the Gift Card. This is used by the Customer to redeem the value of the Gift Card."
  *     type: string
+ *     example: 3RFT-MH2C-Y4YZ-XMN4
  *   value:
  *     description: "The value that the Gift Card represents."
  *     type: integer
+ *     example: 10
  *   balance:
  *     description: "The remaining value on the Gift Card."
  *     type: integer
+ *     example: 10
  *   region_id:
- *     description: "The id of the Region in which the Gift Card is available."
  *     type: string
+ *     description: "The id of the Region in which the Gift Card is available."
+ *     example: reg_01G1G5V26T9H8Y0M4JNE3YGA4G
  *   region:
- *     description: "The Region in which the Gift Card is available."
- *     anyOf:
- *       - $ref: "#/components/schemas/region"
+ *     description: A region object. Available if the relation `region` is expanded.
+ *     type: object
  *   order_id:
- *     description: "The id of the Order that the Gift Card was purchased in."
  *     type: string
+ *     description: "The id of the Order that the Gift Card was purchased in."
+ *     example: order_01G8TJSYT9M6AVS5N4EMNFS1EK
+ *   order:
+ *     description: An order object. Available if the relation `order` is expanded.
+ *     type: object
  *   is_disabled:
  *     description: "Whether the Gift Card has been disabled. Disabled Gift Cards cannot be applied to carts."
  *     type: boolean
+ *     example: false
  *   ends_at:
  *     description: "The time at which the Gift Card can no longer be used."
  *     type: string
  *     format: date-time
  *   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
  *   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=gift-card.js.map

package/dist/models/gift-card.js.map

@@ -1 +1 @@
-{"version":3,"file":"gift-card.js","sourceRoot":"","sources":["../../src/models/gift-card.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,mCAOgB;AAChB,4DAAuE;AAEvE,mCAAiC;AACjC,iCAA+B;AAC/B,oFAAgF;AAChF,kEAA8D;AAG9D;IAA8B,4BAAmB;IAAjD;;IA2CA,CAAC;IAHS,+BAAY,GAApB;QACE,IAAI,CAAC,EAAE,GAAG,IAAA,qCAAgB,EAAC,IAAI,CAAC,EAAE,EAAE,MAAM,CAAC,CAAA;IAC7C,CAAC;IAvCD;QAFC,IAAA,eAAK,EAAC,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC;QACvB,IAAA,gBAAM,GAAE;;0CACG;IAGZ;QADC,IAAA,gBAAM,EAAC,KAAK,CAAC;;2CACD;IAGb;QADC,IAAA,gBAAM,EAAC,KAAK,CAAC;;6CACC;IAIf;QAFC,IAAA,eAAK,GAAE;QACP,IAAA,gBAAM,GAAE;;+CACQ;IAIjB;QAFC,IAAA,mBAAS,EAAC,cAAM,OAAA,eAAM,EAAN,CAAM,CAAC;QACvB,IAAA,oBAAU,EAAC,EAAE,IAAI,EAAE,WAAW,EAAE,CAAC;kCAC1B,eAAM;4CAAA;IAId;QAFC,IAAA,eAAK,GAAE;QACP,IAAA,gBAAM,EAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;8CACX;IAIhB;QAFC,IAAA,mBAAS,EAAC,cAAM,OAAA,aAAK,EAAL,CAAK,CAAC;QACtB,IAAA,oBAAU,EAAC,EAAE,IAAI,EAAE,UAAU,EAAE,CAAC;kCAC1B,aAAK;2CAAA;IAGZ;QADC,IAAA,gBAAM,EAAC,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC;;iDACP;IAMpB;QAJC,IAAA,gBAAM,EAAC;YACN,IAAI,EAAE,IAAA,+BAAa,EAAC,aAAa,CAAC;YAClC,QAAQ,EAAE,IAAI;SACf,CAAC;kCACO,IAAI;6CAAA;IAGb;QADC,IAAA,+BAAa,EAAC,EAAE,IAAI,EAAE,OAAO,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;8CAChB;IAGjC;QADC,IAAA,sBAAY,GAAE;;;;gDAGd;IA1CU,QAAQ;QADpB,IAAA,gBAAM,GAAE;OACI,QAAQ,CA2CpB;IAAD,eAAC;CAAA,AA3CD,CAA8B,2CAAmB,GA2ChD;AA3CY,4BAAQ;AA6CrB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkDG"}
+{"version":3,"file":"gift-card.js","sourceRoot":"","sources":["../../src/models/gift-card.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,mCAOgB;AAChB,4DAAuE;AAEvE,iCAA+B;AAC/B,mCAAiC;AACjC,oFAAgF;AAChF,kEAA8D;AAG9D;IAA8B,4BAAmB;IAAjD;;IA2CA,CAAC;IAHS,+BAAY,GAApB;QACE,IAAI,CAAC,EAAE,GAAG,IAAA,qCAAgB,EAAC,IAAI,CAAC,EAAE,EAAE,MAAM,CAAC,CAAA;IAC7C,CAAC;IAvCD;QAFC,IAAA,eAAK,EAAC,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC;QACvB,IAAA,gBAAM,GAAE;;0CACG;IAGZ;QADC,IAAA,gBAAM,EAAC,KAAK,CAAC;;2CACD;IAGb;QADC,IAAA,gBAAM,EAAC,KAAK,CAAC;;6CACC;IAIf;QAFC,IAAA,eAAK,GAAE;QACP,IAAA,gBAAM,GAAE;;+CACQ;IAIjB;QAFC,IAAA,mBAAS,EAAC,cAAM,OAAA,eAAM,EAAN,CAAM,CAAC;QACvB,IAAA,oBAAU,EAAC,EAAE,IAAI,EAAE,WAAW,EAAE,CAAC;kCAC1B,eAAM;4CAAA;IAId;QAFC,IAAA,eAAK,GAAE;QACP,IAAA,gBAAM,EAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;8CACX;IAIhB;QAFC,IAAA,mBAAS,EAAC,cAAM,OAAA,aAAK,EAAL,CAAK,CAAC;QACtB,IAAA,oBAAU,EAAC,EAAE,IAAI,EAAE,UAAU,EAAE,CAAC;kCAC1B,aAAK;2CAAA;IAGZ;QADC,IAAA,gBAAM,EAAC,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC;;iDACP;IAMpB;QAJC,IAAA,gBAAM,EAAC;YACN,IAAI,EAAE,IAAA,+BAAa,EAAC,aAAa,CAAC;YAClC,QAAQ,EAAE,IAAI;SACf,CAAC;kCACO,IAAI;6CAAA;IAGb;QADC,IAAA,+BAAa,EAAC,EAAE,IAAI,EAAE,OAAO,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;8CAChB;IAGjC;QADC,IAAA,sBAAY,GAAE;;;;gDAGd;IA1CU,QAAQ;QADpB,IAAA,gBAAM,GAAE;OACI,QAAQ,CA2CpB;IAAD,eAAC;CAAA,AA3CD,CAA8B,2CAAmB,GA2ChD;AA3CY,4BAAQ;AA6CrB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiEG"}

package/dist/models/idempotency-key.d.ts

@@ -11,3 +11,56 @@ export declare class IdempotencyKey {
     recovery_point: string;
     private beforeInsert;
 }
+/**
+ * @schema idempotency_key
+ * title: "Idempotency Key"
+ * description: "Idempotency Key is used to continue a process in case of any failure that might occur."
+ * x-resourceId: idempotency_key
+ * required:
+ *   - idempotency_key
+ * properties:
+ *   id:
+ *     type: string
+ *     description: The idempotency key's ID
+ *     example: ikey_01G8X9A7ESKAJXG2H0E6F1MW7A
+ *   idempotency_key:
+ *     description: "The unique randomly generated key used to determine the state of a process."
+ *     type: string
+ *     externalDocs:
+ *       url: https://docs.medusajs.com/advanced/backend/payment/overview#idempotency-key
+ *       description: Learn more how to use the idempotency key.
+ *   created_at:
+ *     description: Date which the idempotency key was locked.
+ *     type: string
+ *     format: date-time
+ *   locked_at:
+ *     description: Date which the idempotency key was locked.
+ *     type: string
+ *     format: date-time
+ *   request_method:
+ *     description: "The method of the request"
+ *     type: string
+ *     example: POST
+ *   request_params:
+ *     type: object
+ *     description: "The parameters passed to the request"
+ *     example:
+ *       id: cart_01G8ZH853Y6TFXWPG5EYE81X63
+ *   request_path:
+ *     description: "The request's path"
+ *     type: string
+ *     example: /store/carts/cart_01G8ZH853Y6TFXWPG5EYE81X63/complete
+ *   response_code:
+ *     type: string
+ *     description: "The response's code."
+ *     example: 200
+ *   response_body:
+ *     type: object
+ *     description: "The response's body"
+ *     example:
+ *       id: cart_01G8ZH853Y6TFXWPG5EYE81X63
+ *   recovery_point:
+ *     type: string
+ *     description: "Where to continue from."
+ *     default: started
+ */ 

package/dist/models/idempotency-key.js

@@ -72,4 +72,57 @@ var IdempotencyKey = /** @class */ (function () {
     return IdempotencyKey;
 }());
 exports.IdempotencyKey = IdempotencyKey;
+/**
+ * @schema idempotency_key
+ * title: "Idempotency Key"
+ * description: "Idempotency Key is used to continue a process in case of any failure that might occur."
+ * x-resourceId: idempotency_key
+ * required:
+ *   - idempotency_key
+ * properties:
+ *   id:
+ *     type: string
+ *     description: The idempotency key's ID
+ *     example: ikey_01G8X9A7ESKAJXG2H0E6F1MW7A
+ *   idempotency_key:
+ *     description: "The unique randomly generated key used to determine the state of a process."
+ *     type: string
+ *     externalDocs:
+ *       url: https://docs.medusajs.com/advanced/backend/payment/overview#idempotency-key
+ *       description: Learn more how to use the idempotency key.
+ *   created_at:
+ *     description: Date which the idempotency key was locked.
+ *     type: string
+ *     format: date-time
+ *   locked_at:
+ *     description: Date which the idempotency key was locked.
+ *     type: string
+ *     format: date-time
+ *   request_method:
+ *     description: "The method of the request"
+ *     type: string
+ *     example: POST
+ *   request_params:
+ *     type: object
+ *     description: "The parameters passed to the request"
+ *     example:
+ *       id: cart_01G8ZH853Y6TFXWPG5EYE81X63
+ *   request_path:
+ *     description: "The request's path"
+ *     type: string
+ *     example: /store/carts/cart_01G8ZH853Y6TFXWPG5EYE81X63/complete
+ *   response_code:
+ *     type: string
+ *     description: "The response's code."
+ *     example: 200
+ *   response_body:
+ *     type: object
+ *     description: "The response's body"
+ *     example:
+ *       id: cart_01G8ZH853Y6TFXWPG5EYE81X63
+ *   recovery_point:
+ *     type: string
+ *     description: "Where to continue from."
+ *     default: started
+ */ 
 //# sourceMappingURL=idempotency-key.js.map

package/dist/models/idempotency-key.js.map

@@ -1 +1 @@
-{"version":3,"file":"idempotency-key.js","sourceRoot":"","sources":["../../src/models/idempotency-key.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,mCAOgB;AAChB,4DAAuE;AACvE,kEAA8D;AAG9D;IAAA;IAoCA,CAAC;IAHS,qCAAY,GAApB;QACE,IAAI,CAAC,EAAE,GAAG,IAAA,qCAAgB,EAAC,IAAI,CAAC,EAAE,EAAE,MAAM,CAAC,CAAA;IAC7C,CAAC;IAjCD;QADC,IAAA,uBAAa,GAAE;;8CACN;IAIV;QAFC,IAAA,eAAK,EAAC,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC;QACvB,IAAA,gBAAM,GAAE;;2DACc;IAGvB;QADC,IAAA,0BAAgB,EAAC,EAAE,IAAI,EAAE,IAAA,+BAAa,EAAC,aAAa,CAAC,EAAE,CAAC;kCAC7C,IAAI;sDAAA;IAGhB;QADC,IAAA,+BAAa,EAAC,EAAE,IAAI,EAAE,aAAa,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;kCAC5C,IAAI;qDAAA;IAGf;QADC,IAAA,gBAAM,EAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;0DACL;IAGtB;QADC,IAAA,+BAAa,EAAC,EAAE,IAAI,EAAE,OAAO,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;0DACV;IAGvC;QADC,IAAA,gBAAM,EAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;wDACP;IAGpB;QADC,IAAA,gBAAM,EAAC,EAAE,IAAI,EAAE,KAAK,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;yDACnB;IAGrB;QADC,IAAA,+BAAa,EAAC,EAAE,IAAI,EAAE,OAAO,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;yDACX;IAGtC;QADC,IAAA,gBAAM,EAAC,EAAE,OAAO,EAAE,SAAS,EAAE,CAAC;;0DACT;IAGtB;QADC,IAAA,sBAAY,GAAE;;;;sDAGd;IAnCU,cAAc;QAD1B,IAAA,gBAAM,GAAE;OACI,cAAc,CAoC1B;IAAD,qBAAC;CAAA,AApCD,IAoCC;AApCY,wCAAc"}
+{"version":3,"file":"idempotency-key.js","sourceRoot":"","sources":["../../src/models/idempotency-key.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,mCAOgB;AAChB,4DAAuE;AAEvE,kEAA8D;AAG9D;IAAA;IAoCA,CAAC;IAHS,qCAAY,GAApB;QACE,IAAI,CAAC,EAAE,GAAG,IAAA,qCAAgB,EAAC,IAAI,CAAC,EAAE,EAAE,MAAM,CAAC,CAAA;IAC7C,CAAC;IAjCD;QADC,IAAA,uBAAa,GAAE;;8CACN;IAIV;QAFC,IAAA,eAAK,EAAC,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC;QACvB,IAAA,gBAAM,GAAE;;2DACc;IAGvB;QADC,IAAA,0BAAgB,EAAC,EAAE,IAAI,EAAE,IAAA,+BAAa,EAAC,aAAa,CAAC,EAAE,CAAC;kCAC7C,IAAI;sDAAA;IAGhB;QADC,IAAA,+BAAa,EAAC,EAAE,IAAI,EAAE,aAAa,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;kCAC5C,IAAI;qDAAA;IAGf;QADC,IAAA,gBAAM,EAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;0DACL;IAGtB;QADC,IAAA,+BAAa,EAAC,EAAE,IAAI,EAAE,OAAO,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;0DACV;IAGvC;QADC,IAAA,gBAAM,EAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;wDACP;IAGpB;QADC,IAAA,gBAAM,EAAC,EAAE,IAAI,EAAE,KAAK,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;yDACnB;IAGrB;QADC,IAAA,+BAAa,EAAC,EAAE,IAAI,EAAE,OAAO,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;yDACX;IAGtC;QADC,IAAA,gBAAM,EAAC,EAAE,OAAO,EAAE,SAAS,EAAE,CAAC;;0DACT;IAGtB;QADC,IAAA,sBAAY,GAAE;;;;sDAGd;IAnCU,cAAc;QAD1B,IAAA,gBAAM,GAAE;OACI,cAAc,CAoC1B;IAAD,qBAAC;CAAA,AApCD,IAoCC;AApCY,wCAAc;AAsC3B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoDG"}

package/dist/models/image.d.ts

@@ -9,26 +9,31 @@ export declare class Image extends SoftDeletableEntity {
  * title: "Image"
  * description: "Images holds a reference to a URL at which the image file can be found."
  * x-resourceId: image
+ * required:
+ *   - url
  * properties:
  *   id:
- *     description: "The id of the Image. This value will be prefixed by `img_`."
  *     type: string
+ *     description: The image's ID
+ *     example: img_01G749BFYR6T8JTVW6SGW3K3E6
  *   url:
  *     description: "The URL at which the image file can be found."
  *     type: string
+ *     format: uri
  *   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
- *   update_at:
- *     description: "The date with timezone at which the resource was last updated."
+ *   updated_at:
  *     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
  *   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/image.js

@@ -26,8 +26,8 @@ var __metadata = (this && this.__metadata) || function (k, v) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Image = void 0;
 var typeorm_1 = require("typeorm");
-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 Image = /** @class */ (function (_super) {
     __extends(Image, _super);
@@ -62,27 +62,32 @@ exports.Image = Image;
  * title: "Image"
  * description: "Images holds a reference to a URL at which the image file can be found."
  * x-resourceId: image
+ * required:
+ *   - url
  * properties:
  *   id:
- *     description: "The id of the Image. This value will be prefixed by `img_`."
  *     type: string
+ *     description: The image's ID
+ *     example: img_01G749BFYR6T8JTVW6SGW3K3E6
  *   url:
  *     description: "The URL at which the image file can be found."
  *     type: string
+ *     format: uri
  *   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
- *   update_at:
- *     description: "The date with timezone at which the resource was last updated."
+ *   updated_at:
  *     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
  *   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=image.js.map

package/dist/models/image.js.map

@@ -1 +1 @@
-{"version":3,"file":"image.js","sourceRoot":"","sources":["../../src/models/image.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,mCAAsD;AACtD,oFAAgF;AAChF,4DAAwD;AACxD,kEAA8D;AAG9D;IAA2B,yBAAmB;IAA9C;;IAWA,CAAC;IAHS,4BAAY,GAApB;QACE,IAAI,CAAC,EAAE,GAAG,IAAA,qCAAgB,EAAC,IAAI,CAAC,EAAE,EAAE,KAAK,CAAC,CAAA;IAC5C,CAAC;IARD;QADC,IAAA,gBAAM,GAAE;;sCACE;IAGX;QADC,IAAA,+BAAa,EAAC,EAAE,IAAI,EAAE,OAAO,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;2CAChB;IAGjC;QADC,IAAA,sBAAY,GAAE;;;;6CAGd;IAVU,KAAK;QADjB,IAAA,gBAAM,GAAE;OACI,KAAK,CAWjB;IAAD,YAAC;CAAA,AAXD,CAA2B,2CAAmB,GAW7C;AAXY,sBAAK;AAalB;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG"}
+{"version":3,"file":"image.js","sourceRoot":"","sources":["../../src/models/image.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,mCAAsD;AAEtD,4DAAwD;AACxD,oFAAgF;AAChF,kEAA8D;AAG9D;IAA2B,yBAAmB;IAA9C;;IAWA,CAAC;IAHS,4BAAY,GAApB;QACE,IAAI,CAAC,EAAE,GAAG,IAAA,qCAAgB,EAAC,IAAI,CAAC,EAAE,EAAE,KAAK,CAAC,CAAA;IAC5C,CAAC;IARD;QADC,IAAA,gBAAM,GAAE;;sCACE;IAGX;QADC,IAAA,+BAAa,EAAC,EAAE,IAAI,EAAE,OAAO,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;2CAChB;IAGjC;QADC,IAAA,sBAAY,GAAE;;;;6CAGd;IAVU,KAAK;QADjB,IAAA,gBAAM,GAAE;OACI,KAAK,CAWjB;IAAD,YAAC;CAAA,AAXD,CAA2B,2CAAmB,GAW7C;AAXY,sBAAK;AAalB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgCG"}

package/dist/models/index.d.ts

@@ -53,6 +53,7 @@ export * from "./region";
 export * from "./return";
 export * from "./return-item";
 export * from "./return-reason";
+export * from "./sales-channel";
 export * from "./shipping-method";
 export * from "./shipping-method-tax-line";
 export * from "./shipping-option";
@@ -64,4 +65,5 @@ export * from "./store";
 export * from "./swap";
 export * from "./tax-provider";
 export * from "./tax-rate";
+export * from "./tracking-link";
 export * from "./user";

package/dist/models/index.js

@@ -1,7 +1,11 @@
 "use strict";
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
 }) : (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     o[k2] = m[k];
@@ -65,6 +69,7 @@ __exportStar(require("./region"), exports);
 __exportStar(require("./return"), exports);
 __exportStar(require("./return-item"), exports);
 __exportStar(require("./return-reason"), exports);
+__exportStar(require("./sales-channel"), exports);
 __exportStar(require("./shipping-method"), exports);
 __exportStar(require("./shipping-method-tax-line"), exports);
 __exportStar(require("./shipping-option"), exports);
@@ -76,5 +81,6 @@ __exportStar(require("./store"), exports);
 __exportStar(require("./swap"), exports);
 __exportStar(require("./tax-provider"), exports);
 __exportStar(require("./tax-rate"), exports);
+__exportStar(require("./tracking-link"), exports);
 __exportStar(require("./user"), exports);
 //# sourceMappingURL=index.js.map

package/dist/models/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/models/index.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,4CAAyB;AACzB,8CAA2B;AAC3B,yCAAsB;AACtB,gDAA6B;AAC7B,+CAA4B;AAC5B,gDAA6B;AAC7B,8CAA2B;AAC3B,4CAAyB;AACzB,6CAA0B;AAC1B,2DAAwC;AACxC,6CAA0B;AAC1B,mDAAgC;AAChC,6CAA0B;AAC1B,uDAAoC;AACpC,sEAAmD;AACnD,+DAA4C;AAC5C,0EAAuD;AACvD,mEAAgD;AAChD,oEAAiD;AACjD,kDAA+B;AAC/B,gDAA6B;AAC7B,gDAA6B;AAC7B,qDAAkC;AAClC,yDAAsC;AACtC,8CAA2B;AAC3B,0DAAuC;AACvC,oDAAiC;AACjC,0CAAuB;AACvB,2CAAwB;AACxB,8CAA2B;AAC3B,yDAAsC;AACtC,uDAAoC;AACpC,iDAA8B;AAC9B,yCAAsB;AACtB,iDAA8B;AAC9B,0CAAuB;AACvB,0CAAuB;AACvB,4CAAyB;AACzB,qDAAkC;AAClC,oDAAiC;AACjC,+CAA4B;AAC5B,4CAAyB;AACzB,uDAAoC;AACpC,mDAAgC;AAChC,yDAAsC;AACtC,gDAA6B;AAC7B,qDAAkC;AAClC,iDAA8B;AAC9B,0DAAuC;AACvC,oDAAiC;AACjC,2CAAwB;AACxB,2CAAwB;AACxB,2CAAwB;AACxB,gDAA6B;AAC7B,kDAA+B;AAC/B,oDAAiC;AACjC,6DAA0C;AAC1C,oDAAiC;AACjC,gEAA6C;AAC7C,qDAAkC;AAClC,sDAAmC;AACnC,+CAA4B;AAC5B,0CAAuB;AACvB,yCAAsB;AACtB,iDAA8B;AAC9B,6CAA0B;AAC1B,yCAAsB"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/models/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,4CAAyB;AACzB,8CAA2B;AAC3B,yCAAsB;AACtB,gDAA6B;AAC7B,+CAA4B;AAC5B,gDAA6B;AAC7B,8CAA2B;AAC3B,4CAAyB;AACzB,6CAA0B;AAC1B,2DAAwC;AACxC,6CAA0B;AAC1B,mDAAgC;AAChC,6CAA0B;AAC1B,uDAAoC;AACpC,sEAAmD;AACnD,+DAA4C;AAC5C,0EAAuD;AACvD,mEAAgD;AAChD,oEAAiD;AACjD,kDAA+B;AAC/B,gDAA6B;AAC7B,gDAA6B;AAC7B,qDAAkC;AAClC,yDAAsC;AACtC,8CAA2B;AAC3B,0DAAuC;AACvC,oDAAiC;AACjC,0CAAuB;AACvB,2CAAwB;AACxB,8CAA2B;AAC3B,yDAAsC;AACtC,uDAAoC;AACpC,iDAA8B;AAC9B,yCAAsB;AACtB,iDAA8B;AAC9B,0CAAuB;AACvB,0CAAuB;AACvB,4CAAyB;AACzB,qDAAkC;AAClC,oDAAiC;AACjC,+CAA4B;AAC5B,4CAAyB;AACzB,uDAAoC;AACpC,mDAAgC;AAChC,yDAAsC;AACtC,gDAA6B;AAC7B,qDAAkC;AAClC,iDAA8B;AAC9B,0DAAuC;AACvC,oDAAiC;AACjC,2CAAwB;AACxB,2CAAwB;AACxB,2CAAwB;AACxB,gDAA6B;AAC7B,kDAA+B;AAC/B,kDAA+B;AAC/B,oDAAiC;AACjC,6DAA0C;AAC1C,oDAAiC;AACjC,gEAA6C;AAC7C,qDAAkC;AAClC,sDAAmC;AACnC,+CAA4B;AAC5B,0CAAuB;AACvB,yCAAsB;AACtB,iDAA8B;AAC9B,6CAA0B;AAC1B,kDAA+B;AAC/B,yCAAsB"}

package/dist/models/invite.d.ts

@@ -1,5 +1,5 @@
-import { UserRoles } from "./user";
 import { SoftDeletableEntity } from "../interfaces/models/soft-deletable-entity";
+import { UserRoles } from "./user";
 export declare class Invite extends SoftDeletableEntity {
     user_email: string;
     role: UserRoles;
@@ -9,3 +9,55 @@ export declare class Invite extends SoftDeletableEntity {
     metadata: Record<string, unknown>;
     private beforeInsert;
 }
+/**
+ * @schema invite
+ * title: "Invite"
+ * description: "Represents an invite"
+ * x-resourceId: invite
+ * required:
+ *   - user_email
+ * properties:
+ *   id:
+ *     type: string
+ *     description: The invite's ID
+ *     example: invite_01G8TKE4XYCTHSCK2GDEP47RE1
+ *   user_email:
+ *     type: string
+ *     description: The email of the user being invited.
+ *     format: email
+ *   role:
+ *     type: string
+ *     description: The user's role.
+ *     enum:
+ *       - admin
+ *       - member
+ *       - developer
+ *     default: member
+ *   accepted:
+ *     type: boolean
+ *     description: Whether the invite was accepted or not.
+ *     example: false
+ *   token:
+ *     type: string
+ *     description: The token used to accept the invite.
+ *   expores_at:
+ *     type: string
+ *     description: The date the invite expires at.
+ *     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"}
+ */

package/dist/models/invite.js

@@ -27,8 +27,8 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.Invite = void 0;
 var typeorm_1 = require("typeorm");
 var db_aware_column_1 = require("../utils/db-aware-column");
-var user_1 = require("./user");
 var soft_deletable_entity_1 = require("../interfaces/models/soft-deletable-entity");
+var user_1 = require("./user");
 var generate_entity_id_1 = require("../utils/generate-entity-id");
 var Invite = /** @class */ (function (_super) {
     __extends(Invite, _super);
@@ -80,4 +80,56 @@ var Invite = /** @class */ (function (_super) {
     return Invite;
 }(soft_deletable_entity_1.SoftDeletableEntity));
 exports.Invite = Invite;
+/**
+ * @schema invite
+ * title: "Invite"
+ * description: "Represents an invite"
+ * x-resourceId: invite
+ * required:
+ *   - user_email
+ * properties:
+ *   id:
+ *     type: string
+ *     description: The invite's ID
+ *     example: invite_01G8TKE4XYCTHSCK2GDEP47RE1
+ *   user_email:
+ *     type: string
+ *     description: The email of the user being invited.
+ *     format: email
+ *   role:
+ *     type: string
+ *     description: The user's role.
+ *     enum:
+ *       - admin
+ *       - member
+ *       - developer
+ *     default: member
+ *   accepted:
+ *     type: boolean
+ *     description: Whether the invite was accepted or not.
+ *     example: false
+ *   token:
+ *     type: string
+ *     description: The token used to accept the invite.
+ *   expores_at:
+ *     type: string
+ *     description: The date the invite expires at.
+ *     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"}
+ */
 //# sourceMappingURL=invite.js.map