@medusajs/medusa 1.3.3 → 1.3.6-next.0

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

@@ -27,42 +27,65 @@ export declare class DraftOrder extends BaseEntity {
  * properties:
  *   id:
  *     type: string
+ *     description: The draft order's ID
+ *     example: dorder_01G8TJFKBG38YYFQ035MSVG03C
  *   status:
  *     type: string
+ *     description: The status of the draft order
  *     enum:
  *       - open
  *       - completed
+ *     default: open
  *   display_id:
  *     type: string
+ *     description: The draft order's display ID
+ *     example: 2
  *   cart_id:
  *     type: string
+ *     description: "The ID of the cart associated with the draft order."
+ *     example: cart_01G8ZH853Y6TFXWPG5EYE81X63
  *   cart:
- *     anyOf:
- *       - $ref: "#/components/schemas/cart"
+ *     description: A cart object. Available if the relation `cart` is expanded.
+ *     type: object
  *   order_id:
  *     type: string
+ *     description: "The ID of the order associated with the draft order."
+ *     example: order_01G8TJSYT9M6AVS5N4EMNFS1EK
  *   order:
- *     anyOf:
- *       - $ref: "#/components/schemas/order"
+ *     description: An order object. Available if the relation `order` is expanded.
+ *     type: object
  *   canceled_at:
  *     type: string
+ *     description: The date the draft order was canceled at.
  *     format: date-time
- *   created_at:
+ *   completed_at:
  *     type: string
+ *     description: The date the draft order was completed at.
  *     format: date-time
- *   update_at:
+ *   no_notification_order:
+ *     type: boolean
+ *     description: Whether to send the customer notifications regarding order updates.
+ *     example: false
+ *   idempotency_key:
+ *     type: string
+ *     description: Randomly generated key used to continue the completion of the cart associated with the draft 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.
+ *   created_at:
  *     type: string
+ *     description: "The date with timezone at which the resource was created."
  *     format: date-time
- *   deleted_at:
+ *   updated_at:
  *     type: string
+ *     description: "The date with timezone at which the resource was updated."
  *     format: date-time
- *   completed_at:
+ *   deleted_at:
  *     type: string
+ *     description: "The date with timezone at which the resource was deleted."
  *     format: date-time
- *   no_notification_order:
- *     type: boolean
  *   metadata:
  *     type: object
- *   idempotency_key:
- *     type: string
+ *     description: An optional key-value map with additional details
+ *     example: {car: "white"}
  */

package/dist/models/draft-order.js

@@ -62,12 +62,12 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.DraftOrder = exports.DraftOrderStatus = 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 base_entity_1 = require("../interfaces/models/base-entity");
 var cart_1 = require("./cart");
 var order_1 = require("./order");
 var generate_entity_id_1 = require("../utils/generate-entity-id");
+var manual_auto_increment_1 = require("../utils/manual-auto-increment");
 var DraftOrderStatus;
 (function (DraftOrderStatus) {
     DraftOrderStatus["OPEN"] = "open";
@@ -168,43 +168,66 @@ exports.DraftOrder = DraftOrder;
  * properties:
  *   id:
  *     type: string
+ *     description: The draft order's ID
+ *     example: dorder_01G8TJFKBG38YYFQ035MSVG03C
  *   status:
  *     type: string
+ *     description: The status of the draft order
  *     enum:
  *       - open
  *       - completed
+ *     default: open
  *   display_id:
  *     type: string
+ *     description: The draft order's display ID
+ *     example: 2
  *   cart_id:
  *     type: string
+ *     description: "The ID of the cart associated with the draft order."
+ *     example: cart_01G8ZH853Y6TFXWPG5EYE81X63
  *   cart:
- *     anyOf:
- *       - $ref: "#/components/schemas/cart"
+ *     description: A cart object. Available if the relation `cart` is expanded.
+ *     type: object
  *   order_id:
  *     type: string
+ *     description: "The ID of the order associated with the draft order."
+ *     example: order_01G8TJSYT9M6AVS5N4EMNFS1EK
  *   order:
- *     anyOf:
- *       - $ref: "#/components/schemas/order"
+ *     description: An order object. Available if the relation `order` is expanded.
+ *     type: object
  *   canceled_at:
  *     type: string
+ *     description: The date the draft order was canceled at.
  *     format: date-time
- *   created_at:
+ *   completed_at:
  *     type: string
+ *     description: The date the draft order was completed at.
  *     format: date-time
- *   update_at:
+ *   no_notification_order:
+ *     type: boolean
+ *     description: Whether to send the customer notifications regarding order updates.
+ *     example: false
+ *   idempotency_key:
+ *     type: string
+ *     description: Randomly generated key used to continue the completion of the cart associated with the draft 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.
+ *   created_at:
  *     type: string
+ *     description: "The date with timezone at which the resource was created."
  *     format: date-time
- *   deleted_at:
+ *   updated_at:
  *     type: string
+ *     description: "The date with timezone at which the resource was updated."
  *     format: date-time
- *   completed_at:
+ *   deleted_at:
  *     type: string
+ *     description: "The date with timezone at which the resource was deleted."
  *     format: date-time
- *   no_notification_order:
- *     type: boolean
  *   metadata:
  *     type: object
- *   idempotency_key:
- *     type: string
+ *     description: An optional key-value map with additional details
+ *     example: {car: "white"}
  */
 //# sourceMappingURL=draft-order.js.map

package/dist/models/draft-order.js.map

@@ -1 +1 @@
-{"version":3,"file":"draft-order.js","sourceRoot":"","sources":["../../src/models/draft-order.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,mCAQgB;AAChB,gEAA6D;AAC7D,4DAIiC;AACjC,wEAAoE;AACpE,+BAA6B;AAC7B,iCAA+B;AAC/B,kEAA8D;AAE9D,IAAY,gBAGX;AAHD,WAAY,gBAAgB;IAC1B,iCAAa,CAAA;IACb,2CAAuB,CAAA;AACzB,CAAC,EAHW,gBAAgB,GAAhB,wBAAgB,KAAhB,wBAAgB,QAG3B;AAGD;IAAgC,8BAAU;IAA1C;;IAoDA,CAAC;IAXe,iCAAY,GAA1B;;;;;;wBACE,IAAI,CAAC,EAAE,GAAG,IAAA,qCAAgB,EAAC,IAAI,CAAC,EAAE,EAAE,QAAQ,CAAC,CAAA;6BAEzC,CAAA,OAAO,CAAC,GAAG,CAAC,QAAQ,KAAK,aAAa,IAAI,CAAC,IAAI,CAAC,UAAU,CAAA,EAA1D,wBAA0D;wBAC9C,qBAAM,IAAA,2CAAmB,EAAC,aAAa,CAAC,EAAA;;wBAAhD,KAAK,GAAG,SAAwC;wBAEtD,IAAI,KAAK,EAAE;4BACT,IAAI,CAAC,UAAU,GAAG,KAAK,CAAA;yBACxB;;;;;;KAEJ;IAjDD;QADC,IAAA,+BAAa,EAAC,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,gBAAgB,EAAE,OAAO,EAAE,MAAM,EAAE,CAAC;;8CACjD;IAKxB;QAHC,IAAA,eAAK,GAAE;QACP,IAAA,gBAAM,GAAE;QACR,IAAA,mBAAS,EAAC,IAAA,6CAA2B,EAAC,WAAW,CAAC,CAAC;;kDAClC;IAIlB;QAFC,IAAA,eAAK,GAAE;QACP,IAAA,gBAAM,EAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;+CACZ;IAIf;QAFC,IAAA,kBAAQ,EAAC,cAAM,OAAA,WAAI,EAAJ,CAAI,EAAE,EAAE,QAAQ,EAAE,SAAS,EAAE,CAAC;QAC7C,IAAA,oBAAU,EAAC,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC;kCAC1B,WAAI;4CAAA;IAIV;QAFC,IAAA,eAAK,GAAE;QACP,IAAA,gBAAM,EAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;gDACX;IAIhB;QAFC,IAAA,kBAAQ,EAAC,cAAM,OAAA,aAAK,EAAL,CAAK,CAAC;QACrB,IAAA,oBAAU,EAAC,EAAE,IAAI,EAAE,UAAU,EAAE,CAAC;kCAC1B,aAAK;6CAAA;IAGZ;QADC,IAAA,gBAAM,EAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,IAAI,EAAE,IAAA,+BAAa,EAAC,aAAa,CAAC,EAAE,CAAC;kCAClD,IAAI;mDAAA;IAGjB;QADC,IAAA,gBAAM,EAAC,EAAE,IAAI,EAAE,IAAA,+BAAa,EAAC,aAAa,CAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;kCACjD,IAAI;oDAAA;IAGlB;QADC,IAAA,gBAAM,EAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;6DACG;IAG9B;QADC,IAAA,+BAAa,EAAC,EAAE,IAAI,EAAE,OAAO,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;gDAChB;IAGjC;QADC,IAAA,gBAAM,EAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;uDACJ;IAGvB;QADC,IAAA,sBAAY,GAAE;;;;kDAWd;IAnDU,UAAU;QADtB,IAAA,gBAAM,GAAE;OACI,UAAU,CAoDtB;IAAD,iBAAC;CAAA,AApDD,CAAgC,wBAAU,GAoDzC;AApDY,gCAAU;AAsDvB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8CG"}
+{"version":3,"file":"draft-order.js","sourceRoot":"","sources":["../../src/models/draft-order.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,mCAQgB;AAChB,4DAIiC;AAEjC,gEAA6D;AAC7D,+BAA6B;AAC7B,iCAA+B;AAC/B,kEAA8D;AAC9D,wEAAoE;AAEpE,IAAY,gBAGX;AAHD,WAAY,gBAAgB;IAC1B,iCAAa,CAAA;IACb,2CAAuB,CAAA;AACzB,CAAC,EAHW,gBAAgB,GAAhB,wBAAgB,KAAhB,wBAAgB,QAG3B;AAGD;IAAgC,8BAAU;IAA1C;;IAoDA,CAAC;IAXe,iCAAY,GAA1B;;;;;;wBACE,IAAI,CAAC,EAAE,GAAG,IAAA,qCAAgB,EAAC,IAAI,CAAC,EAAE,EAAE,QAAQ,CAAC,CAAA;6BAEzC,CAAA,OAAO,CAAC,GAAG,CAAC,QAAQ,KAAK,aAAa,IAAI,CAAC,IAAI,CAAC,UAAU,CAAA,EAA1D,wBAA0D;wBAC9C,qBAAM,IAAA,2CAAmB,EAAC,aAAa,CAAC,EAAA;;wBAAhD,KAAK,GAAG,SAAwC;wBAEtD,IAAI,KAAK,EAAE;4BACT,IAAI,CAAC,UAAU,GAAG,KAAK,CAAA;yBACxB;;;;;;KAEJ;IAjDD;QADC,IAAA,+BAAa,EAAC,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,gBAAgB,EAAE,OAAO,EAAE,MAAM,EAAE,CAAC;;8CACjD;IAKxB;QAHC,IAAA,eAAK,GAAE;QACP,IAAA,gBAAM,GAAE;QACR,IAAA,mBAAS,EAAC,IAAA,6CAA2B,EAAC,WAAW,CAAC,CAAC;;kDAClC;IAIlB;QAFC,IAAA,eAAK,GAAE;QACP,IAAA,gBAAM,EAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;+CACZ;IAIf;QAFC,IAAA,kBAAQ,EAAC,cAAM,OAAA,WAAI,EAAJ,CAAI,EAAE,EAAE,QAAQ,EAAE,SAAS,EAAE,CAAC;QAC7C,IAAA,oBAAU,EAAC,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC;kCAC1B,WAAI;4CAAA;IAIV;QAFC,IAAA,eAAK,GAAE;QACP,IAAA,gBAAM,EAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;gDACX;IAIhB;QAFC,IAAA,kBAAQ,EAAC,cAAM,OAAA,aAAK,EAAL,CAAK,CAAC;QACrB,IAAA,oBAAU,EAAC,EAAE,IAAI,EAAE,UAAU,EAAE,CAAC;kCAC1B,aAAK;6CAAA;IAGZ;QADC,IAAA,gBAAM,EAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,IAAI,EAAE,IAAA,+BAAa,EAAC,aAAa,CAAC,EAAE,CAAC;kCAClD,IAAI;mDAAA;IAGjB;QADC,IAAA,gBAAM,EAAC,EAAE,IAAI,EAAE,IAAA,+BAAa,EAAC,aAAa,CAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;kCACjD,IAAI;oDAAA;IAGlB;QADC,IAAA,gBAAM,EAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;6DACG;IAG9B;QADC,IAAA,+BAAa,EAAC,EAAE,IAAI,EAAE,OAAO,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;gDAChB;IAGjC;QADC,IAAA,gBAAM,EAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;uDACJ;IAGvB;QADC,IAAA,sBAAY,GAAE;;;;kDAWd;IAnDU,UAAU;QADtB,IAAA,gBAAM,GAAE;OACI,UAAU,CAoDtB;IAAD,iBAAC;CAAA,AApDD,CAAgC,wBAAU,GAoDzC;AApDY,gCAAU;AAsDvB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAqEG"}

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

@@ -12,18 +12,27 @@ export declare class FulfillmentItem {
  * title: "Fulfillment Item"
  * description: "Correlates a Line Item with a Fulfillment, keeping track of the quantity of the Line Item."
  * x-resourceId: fulfillment_item
+ * required:
+ *   - fulfillment_id
+ *   - item_id
+ *   - quantity
  * properties:
  *   fulfillment_id:
  *     description: "The id of the Fulfillment that the Fulfillment Item belongs to."
  *     type: string
+ *     example: ful_01G8ZRTMQCA76TXNAT81KPJZRF
  *   item_id:
  *     description: "The id of the Line Item that the Fulfillment Item references."
  *     type: string
+ *     example: item_01G8ZC9GWT6B2GP5FSXRXNFNGN
+ *   fulfillment:
+ *     description: A fulfillment object. Available if the relation `fulfillment` is expanded.
+ *     type: object
  *   item:
- *     description: "The Line Item that the Fulfillment Item references."
- *     anyOf:
- *       - $ref: "#/components/schemas/line_item"
+ *     description: Available if the relation `item` is expanded.
+ *     $ref: "#/components/schemas/line_item"
  *   quantity:
  *     description: "The quantity of the Line Item that is included in the Fulfillment."
  *     type: integer
+ *     example: 1
  */

package/dist/models/fulfillment-item.js

@@ -49,19 +49,28 @@ exports.FulfillmentItem = FulfillmentItem;
  * title: "Fulfillment Item"
  * description: "Correlates a Line Item with a Fulfillment, keeping track of the quantity of the Line Item."
  * x-resourceId: fulfillment_item
+ * required:
+ *   - fulfillment_id
+ *   - item_id
+ *   - quantity
  * properties:
  *   fulfillment_id:
  *     description: "The id of the Fulfillment that the Fulfillment Item belongs to."
  *     type: string
+ *     example: ful_01G8ZRTMQCA76TXNAT81KPJZRF
  *   item_id:
  *     description: "The id of the Line Item that the Fulfillment Item references."
  *     type: string
+ *     example: item_01G8ZC9GWT6B2GP5FSXRXNFNGN
+ *   fulfillment:
+ *     description: A fulfillment object. Available if the relation `fulfillment` is expanded.
+ *     type: object
  *   item:
- *     description: "The Line Item that the Fulfillment Item references."
- *     anyOf:
- *       - $ref: "#/components/schemas/line_item"
+ *     description: Available if the relation `item` is expanded.
+ *     $ref: "#/components/schemas/line_item"
  *   quantity:
  *     description: "The quantity of the Line Item that is included in the Fulfillment."
  *     type: integer
+ *     example: 1
  */
 //# sourceMappingURL=fulfillment-item.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"fulfillment-item.js","sourceRoot":"","sources":["../../src/models/fulfillment-item.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,mCAA8E;AAE9E,6CAA2C;AAC3C,yCAAsC;AAGtC;IAAA;IAiBA,CAAC;IAfC;QADC,IAAA,uBAAa,GAAE;;2DACM;IAGtB;QADC,IAAA,uBAAa,GAAE;;oDACD;IAIf;QAFC,IAAA,mBAAS,EAAC,cAAM,OAAA,yBAAW,EAAX,CAAW,CAAC;QAC5B,IAAA,oBAAU,EAAC,EAAE,IAAI,EAAE,gBAAgB,EAAE,CAAC;kCAC1B,yBAAW;wDAAA;IAIxB;QAFC,IAAA,mBAAS,EAAC,cAAM,OAAA,oBAAQ,EAAR,CAAQ,CAAC;QACzB,IAAA,oBAAU,EAAC,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC;kCAC1B,oBAAQ;iDAAA;IAGd;QADC,IAAA,gBAAM,EAAC,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC;;qDACR;IAhBL,eAAe;QAD3B,IAAA,gBAAM,GAAE;OACI,eAAe,CAiB3B;IAAD,sBAAC;CAAA,AAjBD,IAiBC;AAjBY,0CAAe;AAmB5B;;;;;;;;;;;;;;;;;;;GAmBG"}
+{"version":3,"file":"fulfillment-item.js","sourceRoot":"","sources":["../../src/models/fulfillment-item.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,mCAA8E;AAE9E,6CAA2C;AAC3C,yCAAsC;AAGtC;IAAA;IAiBA,CAAC;IAfC;QADC,IAAA,uBAAa,GAAE;;2DACM;IAGtB;QADC,IAAA,uBAAa,GAAE;;oDACD;IAIf;QAFC,IAAA,mBAAS,EAAC,cAAM,OAAA,yBAAW,EAAX,CAAW,CAAC;QAC5B,IAAA,oBAAU,EAAC,EAAE,IAAI,EAAE,gBAAgB,EAAE,CAAC;kCAC1B,yBAAW;wDAAA;IAIxB;QAFC,IAAA,mBAAS,EAAC,cAAM,OAAA,oBAAQ,EAAR,CAAQ,CAAC;QACzB,IAAA,oBAAU,EAAC,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC;kCAC1B,oBAAQ;iDAAA;IAGd;QADC,IAAA,gBAAM,EAAC,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC;;qDACR;IAhBL,eAAe;QAD3B,IAAA,gBAAM,GAAE;OACI,eAAe,CAiB3B;IAAD,sBAAC;CAAA,AAjBD,IAiBC;AAjBY,0CAAe;AAmB5B;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG"}

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

@@ -11,7 +11,9 @@ export declare class FulfillmentProvider {
  *   id:
  *     description: "The id of the fulfillment 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
+ *     example: true
  */

package/dist/models/fulfillment-provider.js

@@ -37,8 +37,10 @@ exports.FulfillmentProvider = FulfillmentProvider;
  *   id:
  *     description: "The id of the fulfillment 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
+ *     example: true
  */
 //# sourceMappingURL=fulfillment-provider.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"fulfillment-provider.js","sourceRoot":"","sources":["../../src/models/fulfillment-provider.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,mCAAuD;AAGvD;IAAA;IAMA,CAAC;IAJC;QADC,IAAA,uBAAa,GAAE;;mDACN;IAGV;QADC,IAAA,gBAAM,EAAC,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC;;6DACL;IALV,mBAAmB;QAD/B,IAAA,gBAAM,GAAE;OACI,mBAAmB,CAM/B;IAAD,0BAAC;CAAA,AAND,IAMC;AANY,kDAAmB;AAQhC;;;;;;;;;;;;GAYG"}
+{"version":3,"file":"fulfillment-provider.js","sourceRoot":"","sources":["../../src/models/fulfillment-provider.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,mCAAuD;AAGvD;IAAA;IAMA,CAAC;IAJC;QADC,IAAA,uBAAa,GAAE;;mDACN;IAGV;QADC,IAAA,gBAAM,EAAC,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC;;6DACL;IALV,mBAAmB;QAD/B,IAAA,gBAAM,GAAE;OACI,mBAAmB,CAM/B;IAAD,0BAAC;CAAA,AAND,IAMC;AANY,kDAAmB;AAQhC;;;;;;;;;;;;;;GAcG"}

package/dist/models/fulfillment.d.ts

@@ -1,10 +1,10 @@
-import { Order } from "./order";
-import { FulfillmentProvider } from "./fulfillment-provider";
+import { BaseEntity } from "../interfaces/models/base-entity";
+import { ClaimOrder } from "./claim-order";
 import { FulfillmentItem } from "./fulfillment-item";
+import { FulfillmentProvider } from "./fulfillment-provider";
+import { Order } from "./order";
 import { Swap } from "./swap";
-import { ClaimOrder } from "./claim-order";
 import { TrackingLink } from "./tracking-link";
-import { BaseEntity } from "../interfaces/models/base-entity";
 export declare class Fulfillment extends BaseEntity {
     claim_order_id: string;
     claim_order: ClaimOrder;
@@ -30,38 +30,61 @@ export declare class Fulfillment extends BaseEntity {
  * title: "Fulfillment"
  * description: "Fulfillments are created once store operators can prepare the purchased goods. Fulfillments will eventually be shipped and hold information about how to track shipments. Fulfillments are created through a provider, which is typically an external shipping aggregator, shipping partner og 3PL, most plugins will have asynchronous communications with these providers through webhooks in order to automatically update and synchronize the state of Fulfillments."
  * x-resourceId: fulfillment
+ * required:
+ *  - provider_id
  * properties:
  *   id:
- *     description: "The id of the Fulfillment. This value will be prefixed by `ful_`."
  *     type: string
+ *     description: The cart's ID
+ *     example: ful_01G8ZRTMQCA76TXNAT81KPJZRF
  *   claim_order_id:
  *     description: "The id of the Claim that the Fulfillment belongs to."
  *     type: string
+ *     example: null
+ *   claim_order:
+ *     description: A claim order object. Available if the relation `claim_order` is expanded.
+ *     type: object
  *   swap_id:
  *     description: "The id of the Swap that the Fulfillment belongs to."
  *     type: string
+ *     example: null
+ *   swap:
+ *     description: A swap object. Available if the relation `swap` is expanded.
+ *     type: object
  *   order_id:
  *     description: "The id of the Order that the Fulfillment belongs to."
  *     type: string
+ *     example: order_01G8TJSYT9M6AVS5N4EMNFS1EK
+ *   order:
+ *     description: An order object. Available if the relation `order` is expanded.
+ *     type: object
  *   provider_id:
  *     description: "The id of the Fulfillment Provider responsible for handling the fulfillment"
  *     type: string
+ *     example: manual
+ *   provider:
+ *     description: Available if the relation `provider` is expanded.
+ *     $ref: "#/components/schemas/fulfillment_provider"
  *   items:
- *     description: "The Fulfillment Items in the Fulfillment - these hold information about how many of each Line Item has been fulfilled."
+ *     description: The Fulfillment Items in the Fulfillment - these hold information about how many of each Line Item has been fulfilled. Available if the relation `items` is expanded.
  *     type: array
  *     items:
  *       $ref: "#/components/schemas/fulfillment_item"
  *   tracking_links:
- *     description: "The Tracking Links that can be used to track the status of the Fulfillment, these will usually be provided by the Fulfillment Provider."
+ *     description: The Tracking Links that can be used to track the status of the Fulfillment, these will usually be provided by the Fulfillment Provider. Available if the relation `tracking_links` is expanded.
  *     type: array
  *     items:
  *       $ref: "#/components/schemas/tracking_link"
  *   tracking_numbers:
  *     deprecated: true
- *     description: "The tracking numbers that can be used to track the status of the fulfillment."
+ *     description: The tracking numbers that can be used to track the status of the fulfillment.
  *     type: array
  *     items:
  *       type: string
+ *   data:
+ *     description: This contains all the data necessary for the Fulfillment provider to handle the fulfillment.
+ *     type: object
+ *     example: {}
  *   shipped_at:
  *     description: "The date with timezone at which the Fulfillment was shipped."
  *     type: string
@@ -69,19 +92,31 @@ export declare class Fulfillment extends BaseEntity {
  *   no_notification:
  *     description: "Flag for describing whether or not notifications related to this should be send."
  *     type: boolean
+ *     example: false
  *   canceled_at:
  *     description: "The date with timezone at which the Fulfillment was canceled."
  *     type: string
  *     format: date-time
+ *   idempotency_key:
+ *     type: string
+ *     description: Randomly generated key used to continue the completion of the fulfillment 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
+ *   deleted_at:
+ *     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/fulfillment.js

@@ -27,13 +27,13 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.Fulfillment = void 0;
 var typeorm_1 = require("typeorm");
 var db_aware_column_1 = require("../utils/db-aware-column");
-var order_1 = require("./order");
-var fulfillment_provider_1 = require("./fulfillment-provider");
+var base_entity_1 = require("../interfaces/models/base-entity");
+var claim_order_1 = require("./claim-order");
 var fulfillment_item_1 = require("./fulfillment-item");
+var fulfillment_provider_1 = require("./fulfillment-provider");
+var order_1 = require("./order");
 var swap_1 = require("./swap");
-var claim_order_1 = require("./claim-order");
 var tracking_link_1 = require("./tracking-link");
-var base_entity_1 = require("../interfaces/models/base-entity");
 var generate_entity_id_1 = require("../utils/generate-entity-id");
 var Fulfillment = /** @class */ (function (_super) {
     __extends(Fulfillment, _super);
@@ -141,38 +141,61 @@ exports.Fulfillment = Fulfillment;
  * title: "Fulfillment"
  * description: "Fulfillments are created once store operators can prepare the purchased goods. Fulfillments will eventually be shipped and hold information about how to track shipments. Fulfillments are created through a provider, which is typically an external shipping aggregator, shipping partner og 3PL, most plugins will have asynchronous communications with these providers through webhooks in order to automatically update and synchronize the state of Fulfillments."
  * x-resourceId: fulfillment
+ * required:
+ *  - provider_id
  * properties:
  *   id:
- *     description: "The id of the Fulfillment. This value will be prefixed by `ful_`."
  *     type: string
+ *     description: The cart's ID
+ *     example: ful_01G8ZRTMQCA76TXNAT81KPJZRF
  *   claim_order_id:
  *     description: "The id of the Claim that the Fulfillment belongs to."
  *     type: string
+ *     example: null
+ *   claim_order:
+ *     description: A claim order object. Available if the relation `claim_order` is expanded.
+ *     type: object
  *   swap_id:
  *     description: "The id of the Swap that the Fulfillment belongs to."
  *     type: string
+ *     example: null
+ *   swap:
+ *     description: A swap object. Available if the relation `swap` is expanded.
+ *     type: object
  *   order_id:
  *     description: "The id of the Order that the Fulfillment belongs to."
  *     type: string
+ *     example: order_01G8TJSYT9M6AVS5N4EMNFS1EK
+ *   order:
+ *     description: An order object. Available if the relation `order` is expanded.
+ *     type: object
  *   provider_id:
  *     description: "The id of the Fulfillment Provider responsible for handling the fulfillment"
  *     type: string
+ *     example: manual
+ *   provider:
+ *     description: Available if the relation `provider` is expanded.
+ *     $ref: "#/components/schemas/fulfillment_provider"
  *   items:
- *     description: "The Fulfillment Items in the Fulfillment - these hold information about how many of each Line Item has been fulfilled."
+ *     description: The Fulfillment Items in the Fulfillment - these hold information about how many of each Line Item has been fulfilled. Available if the relation `items` is expanded.
  *     type: array
  *     items:
  *       $ref: "#/components/schemas/fulfillment_item"
  *   tracking_links:
- *     description: "The Tracking Links that can be used to track the status of the Fulfillment, these will usually be provided by the Fulfillment Provider."
+ *     description: The Tracking Links that can be used to track the status of the Fulfillment, these will usually be provided by the Fulfillment Provider. Available if the relation `tracking_links` is expanded.
  *     type: array
  *     items:
  *       $ref: "#/components/schemas/tracking_link"
  *   tracking_numbers:
  *     deprecated: true
- *     description: "The tracking numbers that can be used to track the status of the fulfillment."
+ *     description: The tracking numbers that can be used to track the status of the fulfillment.
  *     type: array
  *     items:
  *       type: string
+ *   data:
+ *     description: This contains all the data necessary for the Fulfillment provider to handle the fulfillment.
+ *     type: object
+ *     example: {}
  *   shipped_at:
  *     description: "The date with timezone at which the Fulfillment was shipped."
  *     type: string
@@ -180,20 +203,32 @@ exports.Fulfillment = Fulfillment;
  *   no_notification:
  *     description: "Flag for describing whether or not notifications related to this should be send."
  *     type: boolean
+ *     example: false
  *   canceled_at:
  *     description: "The date with timezone at which the Fulfillment was canceled."
  *     type: string
  *     format: date-time
+ *   idempotency_key:
+ *     type: string
+ *     description: Randomly generated key used to continue the completion of the fulfillment 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
+ *   deleted_at:
+ *     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=fulfillment.js.map

package/dist/models/fulfillment.js.map

@@ -1 +1 @@
-{"version":3,"file":"fulfillment.js","sourceRoot":"","sources":["../../src/models/fulfillment.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,mCAQgB;AAChB,4DAAuE;AAEvE,iCAA+B;AAC/B,+DAA4D;AAC5D,uDAAoD;AACpD,+BAA6B;AAC7B,6CAA0C;AAC1C,iDAA8C;AAC9C,gEAA6D;AAC7D,kEAA8D;AAG9D;IAAiC,+BAAU;IAA3C;;IAqEA,CAAC;IAHS,kCAAY,GAApB;QACE,IAAI,CAAC,EAAE,GAAG,IAAA,qCAAgB,EAAC,IAAI,CAAC,EAAE,EAAE,KAAK,CAAC,CAAA;IAC5C,CAAC;IAjED;QAFC,IAAA,eAAK,GAAE;QACP,IAAA,gBAAM,EAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;uDACL;IAItB;QAFC,IAAA,mBAAS,EAAC,cAAM,OAAA,wBAAU,EAAV,CAAU,EAAE,UAAC,EAAE,IAAK,OAAA,EAAE,CAAC,YAAY,EAAf,CAAe,CAAC;QACpD,IAAA,oBAAU,EAAC,EAAE,IAAI,EAAE,gBAAgB,EAAE,CAAC;kCAC1B,wBAAU;oDAAA;IAIvB;QAFC,IAAA,eAAK,GAAE;QACP,IAAA,gBAAM,EAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;gDACZ;IAIf;QAFC,IAAA,mBAAS,EAAC,cAAM,OAAA,WAAI,EAAJ,CAAI,EAAE,UAAC,IAAI,IAAK,OAAA,IAAI,CAAC,YAAY,EAAjB,CAAiB,CAAC;QAClD,IAAA,oBAAU,EAAC,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC;kCAC1B,WAAI;6CAAA;IAIV;QAFC,IAAA,eAAK,GAAE;QACP,IAAA,gBAAM,EAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;iDACX;IAIhB;QAFC,IAAA,mBAAS,EAAC,cAAM,OAAA,aAAK,EAAL,CAAK,EAAE,UAAC,CAAC,IAAK,OAAA,CAAC,CAAC,YAAY,EAAd,CAAc,CAAC;QAC7C,IAAA,oBAAU,EAAC,EAAE,IAAI,EAAE,UAAU,EAAE,CAAC;kCAC1B,aAAK;8CAAA;IAGZ;QADC,IAAA,gBAAM,EAAC,EAAE,IAAI,EAAE,SAAS,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;wDACpB;IAIxB;QAFC,IAAA,eAAK,GAAE;QACP,IAAA,gBAAM,GAAE;;oDACU;IAInB;QAFC,IAAA,mBAAS,EAAC,cAAM,OAAA,0CAAmB,EAAnB,CAAmB,CAAC;QACpC,IAAA,oBAAU,EAAC,EAAE,IAAI,EAAE,aAAa,EAAE,CAAC;kCAC1B,0CAAmB;iDAAA;IAM7B;QAJC,IAAA,mBAAS,EAAC,cAAM,OAAA,kCAAe,EAAf,CAAe,EAAE,UAAC,CAAC,IAAK,OAAA,CAAC,CAAC,WAAW,EAAb,CAAa,EAAE;YACtD,KAAK,EAAE,IAAI;YACX,OAAO,EAAE,IAAI;SACd,CAAC;;8CACsB;IAKxB;QAHC,IAAA,mBAAS,EAAC,cAAM,OAAA,4BAAY,EAAZ,CAAY,EAAE,UAAC,EAAE,IAAK,OAAA,EAAE,CAAC,WAAW,EAAd,CAAc,EAAE;YACrD,OAAO,EAAE,CAAC,QAAQ,CAAC;SACpB,CAAC;;uDAC4B;IAG9B;QADC,IAAA,+BAAa,EAAC,EAAE,IAAI,EAAE,OAAO,EAAE,OAAO,EAAE,EAAE,EAAE,CAAC;;yDACpB;IAG1B;QADC,IAAA,+BAAa,EAAC,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC;;6CACJ;IAG7B;QADC,IAAA,gBAAM,EAAC,EAAE,IAAI,EAAE,IAAA,+BAAa,EAAC,aAAa,CAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;kCACnD,IAAI;mDAAA;IAGhB;QADC,IAAA,gBAAM,EAAC,EAAE,IAAI,EAAE,IAAA,+BAAa,EAAC,aAAa,CAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;kCAClD,IAAI;oDAAA;IAGjB;QADC,IAAA,+BAAa,EAAC,EAAE,IAAI,EAAE,OAAO,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;iDAChB;IAGjC;QADC,IAAA,gBAAM,EAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;wDACJ;IAGvB;QADC,IAAA,sBAAY,GAAE;;;;mDAGd;IApEU,WAAW;QADvB,IAAA,gBAAM,GAAE;OACI,WAAW,CAqEvB;IAAD,kBAAC;CAAA,AArED,CAAiC,wBAAU,GAqE1C;AArEY,kCAAW;AAuExB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2DG"}
+{"version":3,"file":"fulfillment.js","sourceRoot":"","sources":["../../src/models/fulfillment.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,mCAQgB;AAChB,4DAAuE;AAEvE,gEAA6D;AAC7D,6CAA0C;AAC1C,uDAAoD;AACpD,+DAA4D;AAC5D,iCAA+B;AAC/B,+BAA6B;AAC7B,iDAA8C;AAC9C,kEAA8D;AAG9D;IAAiC,+BAAU;IAA3C;;IAqEA,CAAC;IAHS,kCAAY,GAApB;QACE,IAAI,CAAC,EAAE,GAAG,IAAA,qCAAgB,EAAC,IAAI,CAAC,EAAE,EAAE,KAAK,CAAC,CAAA;IAC5C,CAAC;IAjED;QAFC,IAAA,eAAK,GAAE;QACP,IAAA,gBAAM,EAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;uDACL;IAItB;QAFC,IAAA,mBAAS,EAAC,cAAM,OAAA,wBAAU,EAAV,CAAU,EAAE,UAAC,EAAE,IAAK,OAAA,EAAE,CAAC,YAAY,EAAf,CAAe,CAAC;QACpD,IAAA,oBAAU,EAAC,EAAE,IAAI,EAAE,gBAAgB,EAAE,CAAC;kCAC1B,wBAAU;oDAAA;IAIvB;QAFC,IAAA,eAAK,GAAE;QACP,IAAA,gBAAM,EAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;gDACZ;IAIf;QAFC,IAAA,mBAAS,EAAC,cAAM,OAAA,WAAI,EAAJ,CAAI,EAAE,UAAC,IAAI,IAAK,OAAA,IAAI,CAAC,YAAY,EAAjB,CAAiB,CAAC;QAClD,IAAA,oBAAU,EAAC,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC;kCAC1B,WAAI;6CAAA;IAIV;QAFC,IAAA,eAAK,GAAE;QACP,IAAA,gBAAM,EAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;iDACX;IAIhB;QAFC,IAAA,mBAAS,EAAC,cAAM,OAAA,aAAK,EAAL,CAAK,EAAE,UAAC,CAAC,IAAK,OAAA,CAAC,CAAC,YAAY,EAAd,CAAc,CAAC;QAC7C,IAAA,oBAAU,EAAC,EAAE,IAAI,EAAE,UAAU,EAAE,CAAC;kCAC1B,aAAK;8CAAA;IAGZ;QADC,IAAA,gBAAM,EAAC,EAAE,IAAI,EAAE,SAAS,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;wDACpB;IAIxB;QAFC,IAAA,eAAK,GAAE;QACP,IAAA,gBAAM,GAAE;;oDACU;IAInB;QAFC,IAAA,mBAAS,EAAC,cAAM,OAAA,0CAAmB,EAAnB,CAAmB,CAAC;QACpC,IAAA,oBAAU,EAAC,EAAE,IAAI,EAAE,aAAa,EAAE,CAAC;kCAC1B,0CAAmB;iDAAA;IAM7B;QAJC,IAAA,mBAAS,EAAC,cAAM,OAAA,kCAAe,EAAf,CAAe,EAAE,UAAC,CAAC,IAAK,OAAA,CAAC,CAAC,WAAW,EAAb,CAAa,EAAE;YACtD,KAAK,EAAE,IAAI;YACX,OAAO,EAAE,IAAI;SACd,CAAC;;8CACsB;IAKxB;QAHC,IAAA,mBAAS,EAAC,cAAM,OAAA,4BAAY,EAAZ,CAAY,EAAE,UAAC,EAAE,IAAK,OAAA,EAAE,CAAC,WAAW,EAAd,CAAc,EAAE;YACrD,OAAO,EAAE,CAAC,QAAQ,CAAC;SACpB,CAAC;;uDAC4B;IAG9B;QADC,IAAA,+BAAa,EAAC,EAAE,IAAI,EAAE,OAAO,EAAE,OAAO,EAAE,EAAE,EAAE,CAAC;;yDACpB;IAG1B;QADC,IAAA,+BAAa,EAAC,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC;;6CACJ;IAG7B;QADC,IAAA,gBAAM,EAAC,EAAE,IAAI,EAAE,IAAA,+BAAa,EAAC,aAAa,CAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;kCACnD,IAAI;mDAAA;IAGhB;QADC,IAAA,gBAAM,EAAC,EAAE,IAAI,EAAE,IAAA,+BAAa,EAAC,aAAa,CAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;kCAClD,IAAI;oDAAA;IAGjB;QADC,IAAA,+BAAa,EAAC,EAAE,IAAI,EAAE,OAAO,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;iDAChB;IAGjC;QADC,IAAA,gBAAM,EAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;wDACJ;IAGvB;QADC,IAAA,sBAAY,GAAE;;;;mDAGd;IApEU,WAAW;QADvB,IAAA,gBAAM,GAAE;OACI,WAAW,CAqEvB;IAAD,kBAAC;CAAA,AArED,CAAiC,wBAAU,GAqE1C;AArEY,kCAAW;AAuExB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8FG"}

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

@@ -8,6 +8,8 @@ export declare class GiftCardTransaction {
     order: Order;
     amount: number;
     created_at: Date;
+    is_taxable: boolean;
+    tax_rate: number | null;
     private beforeInsert;
 }
 /**
@@ -15,25 +17,42 @@ export declare class 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
  */