@medusajs/medusa 1.3.3 → 1.3.6-next.0

package/dist/models/claim-order.js

@@ -27,13 +27,13 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.ClaimOrder = exports.ClaimFulfillmentStatus = exports.ClaimPaymentStatus = exports.ClaimType = void 0;
 var typeorm_1 = require("typeorm");
 var db_aware_column_1 = require("../utils/db-aware-column");
+var address_1 = require("./address");
+var claim_item_1 = require("./claim-item");
 var fulfillment_1 = require("./fulfillment");
 var line_item_1 = require("./line-item");
-var claim_item_1 = require("./claim-item");
 var order_1 = require("./order");
 var return_1 = require("./return");
 var shipping_method_1 = require("./shipping-method");
-var address_1 = require("./address");
 var soft_deletable_entity_1 = require("../interfaces/models/soft-deletable-entity");
 var generate_entity_id_1 = require("../utils/generate-entity-id");
 var ClaimType;
@@ -180,9 +180,14 @@ exports.ClaimOrder = ClaimOrder;
  * title: "Claim Order"
  * description: "Claim Orders represent a group of faulty or missing items. Each claim order consists of a subset of items associated with an original order, and can contain additional information about fulfillments and returns."
  * x-resourceId: claim_order
+ * required:
+ *   - type
+ *   - order_id
  * properties:
  *   id:
  *     type: string
+ *     description: The claim's ID
+ *     example: claim_01G8ZH853Y6TFXWPG5EYE81X63
  *   type:
  *     type: string
  *     enum:
@@ -190,10 +195,12 @@ exports.ClaimOrder = ClaimOrder;
  *       - replace
  *   payment_status:
  *     type: string
+ *     description: The status of the claim's payment
  *     enum:
  *       - na
  *       - not_refunded
  *       - refunded
+ *     default: na
  *   fulfillment_status:
  *     type: string
  *     enum:
@@ -206,6 +213,7 @@ exports.ClaimOrder = ClaimOrder;
  *       - returned
  *       - canceled
  *       - requires_action
+ *     default: not_fulfilled
  *   claim_items:
  *     description: "The items that have been claimed"
  *     type: array
@@ -217,16 +225,21 @@ exports.ClaimOrder = ClaimOrder;
  *     items:
  *       $ref: "#/components/schemas/line_item"
  *   order_id:
- *     description: "The id of the order that the claim comes from."
+ *     description: "The ID of the order that the claim comes from."
  *     type: string
+ *     example: order_01G8TJSYT9M6AVS5N4EMNFS1EK
+ *   order:
+ *     description: An order object. Available if the relation `order` is expanded.
+ *     type: object
  *   return_order:
- *     description: "Holds information about the return if the claim is to be returned"
- *     $ref: "#/components/schemas/return"
+ *     description: "A return object. Holds information about the return if the claim is to be returned. Available if the relation 'return_order' is expanded"
+ *     type: object
  *   shipping_address_id:
- *     description: "The id of the address that the new items should be shipped to"
+ *     description: "The ID of the address that the new items should be shipped to"
  *     type: string
+ *     example: addr_01G8ZH853YPY9B94857DY91YGW
  *   shipping_address:
- *     description: "The address that the new items should be shipped to"
+ *     description: Available if the relation `shipping_address` is expanded.
  *     $ref: "#/components/schemas/address"
  *   shipping_methods:
  *     description: "The shipping methods that the claim order will be shipped with."
@@ -241,23 +254,36 @@ exports.ClaimOrder = ClaimOrder;
  *   refund_amount:
  *     description: "The amount that will be refunded in conjunction with the claim"
  *     type: integer
+ *     example: 1000
  *   canceled_at:
- *     description: "The date with timezone at which the Swap was canceled."
+ *     description: "The date with timezone at which the claim was canceled."
  *     type: string
  *     format: date-time
  *   created_at:
  *     type: string
+ *     description: "The date with timezone at which the resource was created."
  *     format: date-time
  *   updated_at:
  *     type: string
+ *     description: "The date with timezone at which the resource was updated."
  *     format: date-time
  *   deleted_at:
  *     type: string
+ *     description: "The date with timezone at which the resource was deleted."
  *     format: date-time
+ *   metadata:
+ *     type: object
+ *     description: An optional key-value map with additional details
+ *     example: {car: "white"}
  *   no_notification:
  *     description: "Flag for describing whether or not notifications related to this should be send."
  *     type: boolean
- *   metadata:
- *     type: object
+ *     example: false
+ *   idempotency_key:
+ *     type: string
+ *     description: Randomly generated key used to continue the completion of the cart associated with the claim in case of failure.
+ *     externalDocs:
+ *       url: https://docs.medusajs.com/advanced/backend/payment/overview#idempotency-key
+ *       description: Learn more how to use the idempotency key.
  */
 //# sourceMappingURL=claim-order.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"claim-order.js","sourceRoot":"","sources":["../../src/models/claim-order.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,mCAYgB;AAChB,4DAAuE;AAEvE,6CAA2C;AAC3C,yCAAsC;AACtC,2CAAwC;AACxC,iCAA+B;AAC/B,mCAAiC;AACjC,qDAAkD;AAClD,qCAAmC;AACnC,oFAAgF;AAChF,kEAA8D;AAE9D,IAAY,SAGX;AAHD,WAAY,SAAS;IACnB,8BAAiB,CAAA;IACjB,gCAAmB,CAAA;AACrB,CAAC,EAHW,SAAS,GAAT,iBAAS,KAAT,iBAAS,QAGpB;AAED,IAAY,kBAIX;AAJD,WAAY,kBAAkB;IAC5B,+BAAS,CAAA;IACT,mDAA6B,CAAA;IAC7B,2CAAqB,CAAA;AACvB,CAAC,EAJW,kBAAkB,GAAlB,0BAAkB,KAAlB,0BAAkB,QAI7B;AAED,IAAY,sBAUX;AAVD,WAAY,sBAAsB;IAChC,yDAA+B,CAAA;IAC/B,qEAA2C,CAAA;IAC3C,iDAAuB,CAAA;IACvB,iEAAuC,CAAA;IACvC,6CAAmB,CAAA;IACnB,mEAAyC,CAAA;IACzC,+CAAqB,CAAA;IACrB,+CAAqB,CAAA;IACrB,6DAAmC,CAAA;AACrC,CAAC,EAVW,sBAAsB,GAAtB,8BAAsB,KAAtB,8BAAsB,QAUjC;AAGD;IAAgC,8BAAmB;IAAnD;;IAiFA,CAAC;IAHS,iCAAY,GAApB;QACE,IAAI,CAAC,EAAE,GAAG,IAAA,qCAAgB,EAAC,IAAI,CAAC,EAAE,EAAE,OAAO,CAAC,CAAA;IAC9C,CAAC;IA1ED;QALC,IAAA,+BAAa,EAAC;YACb,IAAI,EAAE,MAAM;YACZ,IAAI,EAAE,kBAAkB;YACxB,OAAO,EAAE,kBAAkB,CAAC,EAAE;SAC/B,CAAC;;sDACgC;IAOlC;QALC,IAAA,+BAAa,EAAC;YACb,IAAI,EAAE,MAAM;YACZ,IAAI,EAAE,sBAAsB;YAC5B,OAAO,EAAE,sBAAsB,CAAC,aAAa;SAC9C,CAAC;;0DACwC;IAG1C;QADC,IAAA,mBAAS,EAAC,cAAM,OAAA,sBAAS,EAAT,CAAS,EAAE,UAAC,EAAE,IAAK,OAAA,EAAE,CAAC,WAAW,EAAd,CAAc,CAAC;;mDAC3B;IAGxB;QADC,IAAA,mBAAS,EAAC,cAAM,OAAA,oBAAQ,EAAR,CAAQ,EAAE,UAAC,EAAE,IAAK,OAAA,EAAE,CAAC,WAAW,EAAd,CAAc,EAAE,EAAE,OAAO,EAAE,CAAC,QAAQ,CAAC,EAAE,CAAC;;wDAC/C;IAG5B;QADC,IAAA,+BAAa,EAAC,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC;;4CAClC;IAIf;QAFC,IAAA,eAAK,GAAE;QACP,IAAA,gBAAM,GAAE;;gDACO;IAIhB;QAFC,IAAA,mBAAS,EAAC,cAAM,OAAA,aAAK,EAAL,CAAK,EAAE,UAAC,CAAC,IAAK,OAAA,CAAC,CAAC,MAAM,EAAR,CAAQ,CAAC;QACvC,IAAA,oBAAU,EAAC,EAAE,IAAI,EAAE,UAAU,EAAE,CAAC;kCAC1B,aAAK;6CAAA;IAGZ;QADC,IAAA,kBAAQ,EAAC,cAAM,OAAA,eAAM,EAAN,CAAM,EAAE,UAAC,GAAG,IAAK,OAAA,GAAG,CAAC,WAAW,EAAf,CAAe,CAAC;kCACnC,eAAM;oDAAA;IAIpB;QAFC,IAAA,eAAK,GAAE;QACP,IAAA,gBAAM,EAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;2DACA;IAI3B;QAFC,IAAA,mBAAS,EAAC,cAAM,OAAA,iBAAO,EAAP,CAAO,EAAE,EAAE,OAAO,EAAE,CAAC,QAAQ,CAAC,EAAE,CAAC;QACjD,IAAA,oBAAU,EAAC,EAAE,IAAI,EAAE,qBAAqB,EAAE,CAAC;kCAC1B,iBAAO;wDAAA;IAKzB;QAHC,IAAA,mBAAS,EAAC,cAAM,OAAA,gCAAc,EAAd,CAAc,EAAE,UAAC,MAAM,IAAK,OAAA,MAAM,CAAC,WAAW,EAAlB,CAAkB,EAAE;YAC/D,OAAO,EAAE,CAAC,QAAQ,CAAC;SACpB,CAAC;;wDACgC;IAKlC;QAHC,IAAA,mBAAS,EAAC,cAAM,OAAA,yBAAW,EAAX,CAAW,EAAE,UAAC,WAAW,IAAK,OAAA,WAAW,CAAC,WAAW,EAAvB,CAAuB,EAAE;YACtE,OAAO,EAAE,CAAC,QAAQ,CAAC;SACpB,CAAC;;oDACyB;IAG3B;QADC,IAAA,gBAAM,EAAC,EAAE,IAAI,EAAE,KAAK,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;qDACnB;IAGrB;QADC,IAAA,gBAAM,EAAC,EAAE,IAAI,EAAE,IAAA,+BAAa,EAAC,aAAa,CAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;kCAClD,IAAI;mDAAA;IAGjB;QADC,IAAA,0BAAgB,EAAC,EAAE,IAAI,EAAE,IAAA,+BAAa,EAAC,aAAa,CAAC,EAAE,CAAC;kCAC7C,IAAI;kDAAA;IAGhB;QADC,IAAA,0BAAgB,EAAC,EAAE,IAAI,EAAE,IAAA,+BAAa,EAAC,aAAa,CAAC,EAAE,CAAC;kCAC7C,IAAI;kDAAA;IAGhB;QADC,IAAA,0BAAgB,EAAC,EAAE,IAAI,EAAE,IAAA,+BAAa,EAAC,aAAa,CAAC,EAAE,CAAC;kCAC7C,IAAI;kDAAA;IAGhB;QADC,IAAA,gBAAM,EAAC,EAAE,IAAI,EAAE,SAAS,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;uDACpB;IAGxB;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;;;;kDAGd;IAhFU,UAAU;QADtB,IAAA,gBAAM,GAAE;OACI,UAAU,CAiFtB;IAAD,iBAAC;CAAA,AAjFD,CAAgC,2CAAmB,GAiFlD;AAjFY,gCAAU;AAmFvB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoFG"}
+{"version":3,"file":"claim-order.js","sourceRoot":"","sources":["../../src/models/claim-order.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,mCAYgB;AAChB,4DAAuE;AAEvE,qCAAmC;AACnC,2CAAwC;AACxC,6CAA2C;AAC3C,yCAAsC;AACtC,iCAA+B;AAC/B,mCAAiC;AACjC,qDAAkD;AAClD,oFAAgF;AAChF,kEAA8D;AAE9D,IAAY,SAGX;AAHD,WAAY,SAAS;IACnB,8BAAiB,CAAA;IACjB,gCAAmB,CAAA;AACrB,CAAC,EAHW,SAAS,GAAT,iBAAS,KAAT,iBAAS,QAGpB;AAED,IAAY,kBAIX;AAJD,WAAY,kBAAkB;IAC5B,+BAAS,CAAA;IACT,mDAA6B,CAAA;IAC7B,2CAAqB,CAAA;AACvB,CAAC,EAJW,kBAAkB,GAAlB,0BAAkB,KAAlB,0BAAkB,QAI7B;AAED,IAAY,sBAUX;AAVD,WAAY,sBAAsB;IAChC,yDAA+B,CAAA;IAC/B,qEAA2C,CAAA;IAC3C,iDAAuB,CAAA;IACvB,iEAAuC,CAAA;IACvC,6CAAmB,CAAA;IACnB,mEAAyC,CAAA;IACzC,+CAAqB,CAAA;IACrB,+CAAqB,CAAA;IACrB,6DAAmC,CAAA;AACrC,CAAC,EAVW,sBAAsB,GAAtB,8BAAsB,KAAtB,8BAAsB,QAUjC;AAGD;IAAgC,8BAAmB;IAAnD;;IAiFA,CAAC;IAHS,iCAAY,GAApB;QACE,IAAI,CAAC,EAAE,GAAG,IAAA,qCAAgB,EAAC,IAAI,CAAC,EAAE,EAAE,OAAO,CAAC,CAAA;IAC9C,CAAC;IA1ED;QALC,IAAA,+BAAa,EAAC;YACb,IAAI,EAAE,MAAM;YACZ,IAAI,EAAE,kBAAkB;YACxB,OAAO,EAAE,kBAAkB,CAAC,EAAE;SAC/B,CAAC;;sDACgC;IAOlC;QALC,IAAA,+BAAa,EAAC;YACb,IAAI,EAAE,MAAM;YACZ,IAAI,EAAE,sBAAsB;YAC5B,OAAO,EAAE,sBAAsB,CAAC,aAAa;SAC9C,CAAC;;0DACwC;IAG1C;QADC,IAAA,mBAAS,EAAC,cAAM,OAAA,sBAAS,EAAT,CAAS,EAAE,UAAC,EAAE,IAAK,OAAA,EAAE,CAAC,WAAW,EAAd,CAAc,CAAC;;mDAC3B;IAGxB;QADC,IAAA,mBAAS,EAAC,cAAM,OAAA,oBAAQ,EAAR,CAAQ,EAAE,UAAC,EAAE,IAAK,OAAA,EAAE,CAAC,WAAW,EAAd,CAAc,EAAE,EAAE,OAAO,EAAE,CAAC,QAAQ,CAAC,EAAE,CAAC;;wDAC/C;IAG5B;QADC,IAAA,+BAAa,EAAC,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC;;4CAClC;IAIf;QAFC,IAAA,eAAK,GAAE;QACP,IAAA,gBAAM,GAAE;;gDACO;IAIhB;QAFC,IAAA,mBAAS,EAAC,cAAM,OAAA,aAAK,EAAL,CAAK,EAAE,UAAC,CAAC,IAAK,OAAA,CAAC,CAAC,MAAM,EAAR,CAAQ,CAAC;QACvC,IAAA,oBAAU,EAAC,EAAE,IAAI,EAAE,UAAU,EAAE,CAAC;kCAC1B,aAAK;6CAAA;IAGZ;QADC,IAAA,kBAAQ,EAAC,cAAM,OAAA,eAAM,EAAN,CAAM,EAAE,UAAC,GAAG,IAAK,OAAA,GAAG,CAAC,WAAW,EAAf,CAAe,CAAC;kCACnC,eAAM;oDAAA;IAIpB;QAFC,IAAA,eAAK,GAAE;QACP,IAAA,gBAAM,EAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;2DACA;IAI3B;QAFC,IAAA,mBAAS,EAAC,cAAM,OAAA,iBAAO,EAAP,CAAO,EAAE,EAAE,OAAO,EAAE,CAAC,QAAQ,CAAC,EAAE,CAAC;QACjD,IAAA,oBAAU,EAAC,EAAE,IAAI,EAAE,qBAAqB,EAAE,CAAC;kCAC1B,iBAAO;wDAAA;IAKzB;QAHC,IAAA,mBAAS,EAAC,cAAM,OAAA,gCAAc,EAAd,CAAc,EAAE,UAAC,MAAM,IAAK,OAAA,MAAM,CAAC,WAAW,EAAlB,CAAkB,EAAE;YAC/D,OAAO,EAAE,CAAC,QAAQ,CAAC;SACpB,CAAC;;wDACgC;IAKlC;QAHC,IAAA,mBAAS,EAAC,cAAM,OAAA,yBAAW,EAAX,CAAW,EAAE,UAAC,WAAW,IAAK,OAAA,WAAW,CAAC,WAAW,EAAvB,CAAuB,EAAE;YACtE,OAAO,EAAE,CAAC,QAAQ,CAAC;SACpB,CAAC;;oDACyB;IAG3B;QADC,IAAA,gBAAM,EAAC,EAAE,IAAI,EAAE,KAAK,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;qDACnB;IAGrB;QADC,IAAA,gBAAM,EAAC,EAAE,IAAI,EAAE,IAAA,+BAAa,EAAC,aAAa,CAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;kCAClD,IAAI;mDAAA;IAGjB;QADC,IAAA,0BAAgB,EAAC,EAAE,IAAI,EAAE,IAAA,+BAAa,EAAC,aAAa,CAAC,EAAE,CAAC;kCAC7C,IAAI;kDAAA;IAGhB;QADC,IAAA,0BAAgB,EAAC,EAAE,IAAI,EAAE,IAAA,+BAAa,EAAC,aAAa,CAAC,EAAE,CAAC;kCAC7C,IAAI;kDAAA;IAGhB;QADC,IAAA,0BAAgB,EAAC,EAAE,IAAI,EAAE,IAAA,+BAAa,EAAC,aAAa,CAAC,EAAE,CAAC;kCAC7C,IAAI;kDAAA;IAGhB;QADC,IAAA,gBAAM,EAAC,EAAE,IAAI,EAAE,SAAS,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;uDACpB;IAGxB;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;;;;kDAGd;IAhFU,UAAU;QADtB,IAAA,gBAAM,GAAE;OACI,UAAU,CAiFtB;IAAD,iBAAC;CAAA,AAjFD,CAAgC,2CAAmB,GAiFlD;AAjFY,gCAAU;AAmFvB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8GG"}

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

@@ -9,26 +9,31 @@ export declare class ClaimTag extends SoftDeletableEntity {
  * title: "Claim Tag"
  * description: "Claim Tags are user defined tags that can be assigned to claim items for easy filtering and grouping."
  * x-resourceId: claim_tag
+ * required:
+ *   - value
  * properties:
  *   id:
- *     description: "The id of the claim tag. Will be prefixed by `ctag_`."
  *     type: string
+ *     description: The claim tag's ID
+ *     example: ctag_01G8ZCC5Y63B95V6B5SHBZ91S4
  *   value:
  *     description: "The value that the claim tag holds"
  *     type: string
+ *     example: Damaged
  *   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/claim-tag.js

@@ -26,8 +26,8 @@ var __metadata = (this && this.__metadata) || function (k, v) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ClaimTag = 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 ClaimTag = /** @class */ (function (_super) {
     __extends(ClaimTag, _super);
@@ -63,27 +63,32 @@ exports.ClaimTag = ClaimTag;
  * title: "Claim Tag"
  * description: "Claim Tags are user defined tags that can be assigned to claim items for easy filtering and grouping."
  * x-resourceId: claim_tag
+ * required:
+ *   - value
  * properties:
  *   id:
- *     description: "The id of the claim tag. Will be prefixed by `ctag_`."
  *     type: string
+ *     description: The claim tag's ID
+ *     example: ctag_01G8ZCC5Y63B95V6B5SHBZ91S4
  *   value:
  *     description: "The value that the claim tag holds"
  *     type: string
+ *     example: Damaged
  *   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=claim-tag.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"claim-tag.js","sourceRoot":"","sources":["../../src/models/claim-tag.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,mCAA6D;AAC7D,oFAAgF;AAChF,4DAAwD;AACxD,kEAA8D;AAG9D;IAA8B,4BAAmB;IAAjD;;IAYA,CAAC;IAHS,+BAAY,GAApB;QACE,IAAI,CAAC,EAAE,GAAG,IAAA,qCAAgB,EAAC,IAAI,CAAC,EAAE,EAAE,MAAM,CAAC,CAAA;IAC7C,CAAC;IARD;QAFC,IAAA,eAAK,GAAE;QACP,IAAA,gBAAM,GAAE;;2CACI;IAGb;QADC,IAAA,+BAAa,EAAC,EAAE,IAAI,EAAE,OAAO,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;8CAChB;IAGjC;QADC,IAAA,sBAAY,GAAE;;;;gDAGd;IAXU,QAAQ;QADpB,IAAA,gBAAM,GAAE;OACI,QAAQ,CAYpB;IAAD,eAAC;CAAA,AAZD,CAA8B,2CAAmB,GAYhD;AAZY,4BAAQ;AAcrB;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG"}
+{"version":3,"file":"claim-tag.js","sourceRoot":"","sources":["../../src/models/claim-tag.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,mCAA6D;AAE7D,4DAAwD;AACxD,oFAAgF;AAChF,kEAA8D;AAG9D;IAA8B,4BAAmB;IAAjD;;IAYA,CAAC;IAHS,+BAAY,GAApB;QACE,IAAI,CAAC,EAAE,GAAG,IAAA,qCAAgB,EAAC,IAAI,CAAC,EAAE,EAAE,MAAM,CAAC,CAAA;IAC7C,CAAC;IARD;QAFC,IAAA,eAAK,GAAE;QACP,IAAA,gBAAM,GAAE;;2CACI;IAGb;QADC,IAAA,+BAAa,EAAC,EAAE,IAAI,EAAE,OAAO,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;8CAChB;IAGjC;QADC,IAAA,sBAAY,GAAE;;;;gDAGd;IAXU,QAAQ;QADpB,IAAA,gBAAM,GAAE;OACI,QAAQ,CAYpB;IAAD,eAAC;CAAA,AAZD,CAA8B,2CAAmB,GAYhD;AAZY,4BAAQ;AAcrB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgCG"}

package/dist/models/country.d.ts

@@ -14,23 +14,51 @@ export declare class Country {
  * title: "Country"
  * description: "Country details"
  * x-resourceId: country
+ * required:
+ *   - iso_2
+ *   - iso_3
+ *   - num_code
+ *   - name
+ *   - display_name
  * properties:
- *  id:
- *    description: "The database id of the country"
- *    type: integer
- *  iso_2:
- *    description: "The 2 character ISO code for the country."
- *    type: string
- *  iso_3:
- *    description: "The 3 character ISO code for the country."
- *    type: string
- *  num_code:
- *    description: "The numerical ISO code for the country."
- *    type: string
- *  name:
- *    description: "The normalized country name; in upper case."
- *    type: string
- *  display_name:
- *    description: "The country name appropriate for display."
- *    type: string
+ *   id:
+ *     type: string
+ *     description: The country's ID
+ *     example: 109
+ *   iso_2:
+ *     type: string
+ *     description: The 2 character ISO code of the country in lower case
+ *     example: it
+ *     externalDocs:
+ *       url: https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements
+ *       description: See a list of codes.
+ *   iso_3:
+ *     type: string
+ *     description: The 2 character ISO code of the country in lower case
+ *     example: ita
+ *     externalDocs:
+ *       url: https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3#Officially_assigned_code_elements
+ *       description: See a list of codes.
+ *   num_code:
+ *     description: "The numerical ISO code for the country."
+ *     type: string
+ *     example: 380
+ *     externalDocs:
+ *       url: https://en.wikipedia.org/wiki/ISO_3166-1_numeric#Officially_assigned_code_elements
+ *       description: See a list of codes.
+ *   name:
+ *     description: "The normalized country name in upper case."
+ *     type: string
+ *     example: ITALY
+ *   display_name:
+ *     description: "The country name appropriate for display."
+ *     type: string
+ *     example: Italy
+ *   region_id:
+ *     type: string
+ *     description: The region ID this country is associated with.
+ *     example: reg_01G1G5V26T9H8Y0M4JNE3YGA4G
+ *   region:
+ *     description: A region object. Available if the relation `region` is expanded.
+ *     type: object
  */

package/dist/models/country.js

@@ -61,24 +61,52 @@ exports.Country = Country;
  * title: "Country"
  * description: "Country details"
  * x-resourceId: country
+ * required:
+ *   - iso_2
+ *   - iso_3
+ *   - num_code
+ *   - name
+ *   - display_name
  * properties:
- *  id:
- *    description: "The database id of the country"
- *    type: integer
- *  iso_2:
- *    description: "The 2 character ISO code for the country."
- *    type: string
- *  iso_3:
- *    description: "The 3 character ISO code for the country."
- *    type: string
- *  num_code:
- *    description: "The numerical ISO code for the country."
- *    type: string
- *  name:
- *    description: "The normalized country name; in upper case."
- *    type: string
- *  display_name:
- *    description: "The country name appropriate for display."
- *    type: string
+ *   id:
+ *     type: string
+ *     description: The country's ID
+ *     example: 109
+ *   iso_2:
+ *     type: string
+ *     description: The 2 character ISO code of the country in lower case
+ *     example: it
+ *     externalDocs:
+ *       url: https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements
+ *       description: See a list of codes.
+ *   iso_3:
+ *     type: string
+ *     description: The 2 character ISO code of the country in lower case
+ *     example: ita
+ *     externalDocs:
+ *       url: https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3#Officially_assigned_code_elements
+ *       description: See a list of codes.
+ *   num_code:
+ *     description: "The numerical ISO code for the country."
+ *     type: string
+ *     example: 380
+ *     externalDocs:
+ *       url: https://en.wikipedia.org/wiki/ISO_3166-1_numeric#Officially_assigned_code_elements
+ *       description: See a list of codes.
+ *   name:
+ *     description: "The normalized country name in upper case."
+ *     type: string
+ *     example: ITALY
+ *   display_name:
+ *     description: "The country name appropriate for display."
+ *     type: string
+ *     example: Italy
+ *   region_id:
+ *     type: string
+ *     description: The region ID this country is associated with.
+ *     example: reg_01G1G5V26T9H8Y0M4JNE3YGA4G
+ *   region:
+ *     description: A region object. Available if the relation `region` is expanded.
+ *     type: object
  */
 //# sourceMappingURL=country.js.map

package/dist/models/country.js.map

@@ -1 +1 @@
-{"version":3,"file":"country.js","sourceRoot":"","sources":["../../src/models/country.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,mCAOgB;AAChB,mCAAiC;AAGjC;IAAA;IA2BA,CAAC;IAzBC;QADC,IAAA,gCAAsB,GAAE;;uCACf;IAIV;QAFC,IAAA,eAAK,EAAC,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC;QACvB,IAAA,gBAAM,GAAE;;0CACI;IAGb;QADC,IAAA,gBAAM,GAAE;;0CACI;IAGb;QADC,IAAA,gBAAM,GAAE;;6CACO;IAGhB;QADC,IAAA,gBAAM,GAAE;;yCACG;IAGZ;QADC,IAAA,gBAAM,GAAE;;iDACW;IAIpB;QAFC,IAAA,eAAK,GAAE;QACP,IAAA,gBAAM,EAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;8CACH;IAIxB;QAFC,IAAA,mBAAS,EAAC,cAAM,OAAA,eAAM,EAAN,CAAM,EAAE,UAAC,CAAC,IAAK,OAAA,CAAC,CAAC,SAAS,EAAX,CAAW,CAAC;QAC3C,IAAA,oBAAU,EAAC,EAAE,IAAI,EAAE,WAAW,EAAE,CAAC;kCAC1B,eAAM;2CAAA;IA1BH,OAAO;QADnB,IAAA,gBAAM,GAAE;OACI,OAAO,CA2BnB;IAAD,cAAC;CAAA,AA3BD,IA2BC;AA3BY,0BAAO;AA6BpB;;;;;;;;;;;;;;;;;;;;;;;;GAwBG"}
+{"version":3,"file":"country.js","sourceRoot":"","sources":["../../src/models/country.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,mCAOgB;AAEhB,mCAAiC;AAGjC;IAAA;IA2BA,CAAC;IAzBC;QADC,IAAA,gCAAsB,GAAE;;uCACf;IAIV;QAFC,IAAA,eAAK,EAAC,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC;QACvB,IAAA,gBAAM,GAAE;;0CACI;IAGb;QADC,IAAA,gBAAM,GAAE;;0CACI;IAGb;QADC,IAAA,gBAAM,GAAE;;6CACO;IAGhB;QADC,IAAA,gBAAM,GAAE;;yCACG;IAGZ;QADC,IAAA,gBAAM,GAAE;;iDACW;IAIpB;QAFC,IAAA,eAAK,GAAE;QACP,IAAA,gBAAM,EAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;8CACH;IAIxB;QAFC,IAAA,mBAAS,EAAC,cAAM,OAAA,eAAM,EAAN,CAAM,EAAE,UAAC,CAAC,IAAK,OAAA,CAAC,CAAC,SAAS,EAAX,CAAW,CAAC;QAC3C,IAAA,oBAAU,EAAC,EAAE,IAAI,EAAE,WAAW,EAAE,CAAC;kCAC1B,eAAM;2CAAA;IA1BH,OAAO;QADnB,IAAA,gBAAM,GAAE;OACI,OAAO,CA2BnB;IAAD,cAAC;CAAA,AA3BD,IA2BC;AA3BY,0BAAO;AA6BpB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoDG"}

package/dist/models/currency.d.ts

@@ -9,17 +9,29 @@ export declare class Currency {
  * title: "Currency"
  * description: "Currency"
  * x-resourceId: currency
+ * required:
+ *   - code
+ *   - symbol
+ *   - symbol_native
+ *   - name
  * properties:
  *  code:
  *    description: "The 3 character ISO code for the currency."
  *    type: string
+ *    example: usd
+ *    externalDocs:
+ *      url: https://en.wikipedia.org/wiki/ISO_4217#Active_codes
+ *      description: See a list of codes.
  *  symbol:
  *    description: "The symbol used to indicate the currency."
  *    type: string
+ *    example: $
  *  symbol_native:
  *    description: "The native symbol used to indicate the currency."
  *    type: string
+ *    example: $
  *  name:
  *    description: "The written name of the currency"
  *    type: string
+ *    example: US Dollar
  */

package/dist/models/currency.js

@@ -41,18 +41,30 @@ exports.Currency = Currency;
  * title: "Currency"
  * description: "Currency"
  * x-resourceId: currency
+ * required:
+ *   - code
+ *   - symbol
+ *   - symbol_native
+ *   - name
  * properties:
  *  code:
  *    description: "The 3 character ISO code for the currency."
  *    type: string
+ *    example: usd
+ *    externalDocs:
+ *      url: https://en.wikipedia.org/wiki/ISO_4217#Active_codes
+ *      description: See a list of codes.
  *  symbol:
  *    description: "The symbol used to indicate the currency."
  *    type: string
+ *    example: $
  *  symbol_native:
  *    description: "The native symbol used to indicate the currency."
  *    type: string
+ *    example: $
  *  name:
  *    description: "The written name of the currency"
  *    type: string
+ *    example: US Dollar
  */
 //# sourceMappingURL=currency.js.map

package/dist/models/currency.js.map

@@ -1 +1 @@
-{"version":3,"file":"currency.js","sourceRoot":"","sources":["../../src/models/currency.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,mCAAuD;AAGvD;IAAA;IAYA,CAAC;IAVC;QADC,IAAA,uBAAa,GAAE;;0CACJ;IAGZ;QADC,IAAA,gBAAM,GAAE;;4CACK;IAGd;QADC,IAAA,gBAAM,GAAE;;mDACY;IAGrB;QADC,IAAA,gBAAM,GAAE;;0CACG;IAXD,QAAQ;QADpB,IAAA,gBAAM,GAAE;OACI,QAAQ,CAYpB;IAAD,eAAC;CAAA,AAZD,IAYC;AAZY,4BAAQ;AAcrB;;;;;;;;;;;;;;;;;;GAkBG"}
+{"version":3,"file":"currency.js","sourceRoot":"","sources":["../../src/models/currency.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,mCAAuD;AAGvD;IAAA;IAYA,CAAC;IAVC;QADC,IAAA,uBAAa,GAAE;;0CACJ;IAGZ;QADC,IAAA,gBAAM,GAAE;;4CACK;IAGd;QADC,IAAA,gBAAM,GAAE;;mDACY;IAGrB;QADC,IAAA,gBAAM,GAAE;;0CACG;IAXD,QAAQ;QADpB,IAAA,gBAAM,GAAE;OACI,QAAQ,CAYpB;IAAD,eAAC;CAAA,AAZD,IAYC;AAZY,4BAAQ;AAcrB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8BG"}

package/dist/models/custom-shipping-option.d.ts

@@ -15,34 +15,46 @@ export declare class CustomShippingOption extends SoftDeletableEntity {
  * title: "Custom Shipping Option"
  * description: "Custom Shipping Options are 'overriden' Shipping Options. Store managers can attach a Custom Shipping Option to a cart in order to set a custom price for a particular Shipping Option"
  * x-resourceId: custom_shipping_option
+ * required:
+ *   - price
+ *   - shipping_option_id
  * properties:
  *   id:
- *     description: "The id of the Custom Shipping Option. This value will be prefixed with `cso_`."
  *     type: string
+ *     description: The custom shipping option's ID
+ *     example: cso_01G8X99XNB77DMFBJFWX6DN9V9
  *   price:
  *     description: "The custom price set that will override the shipping option's original price"
  *     type: integer
+ *     example: 1000
  *   shipping_option_id:
- *     description: "The id of the Shipping Option that the custom shipping option overrides"
- *     anyOf:
- *       - $ref: "#/components/schemas/shipping_option"
+ *     description: "The ID of the Shipping Option that the custom shipping option overrides"
+ *     type: string
+ *     example: so_01G1G5V27GYX4QXNARRQCW1N8T
+ *   shipping_option:
+ *     description: A shipping option object. Available if the relation `shipping_option` is expanded.
+ *     type: object
  *   cart_id:
- *     description: "The id of the Cart that the custom shipping option is attached to"
- *     anyOf:
- *       - $ref: "#/components/schemas/cart"
+ *     description: "The ID of the Cart that the custom shipping option is attached to"
+ *     type: string
+ *     example: cart_01G8ZH853Y6TFXWPG5EYE81X63
+ *   cart:
+ *     description: A cart object. Available if the relation `cart` is expanded.
+ *     type: 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 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/custom-shipping-option.js

@@ -27,9 +27,9 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.CustomShippingOption = void 0;
 var typeorm_1 = require("typeorm");
 var cart_1 = require("./cart");
+var db_aware_column_1 = require("../utils/db-aware-column");
 var shipping_option_1 = require("./shipping-option");
 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 CustomShippingOption = /** @class */ (function (_super) {
     __extends(CustomShippingOption, _super);
@@ -85,35 +85,47 @@ exports.CustomShippingOption = CustomShippingOption;
  * title: "Custom Shipping Option"
  * description: "Custom Shipping Options are 'overriden' Shipping Options. Store managers can attach a Custom Shipping Option to a cart in order to set a custom price for a particular Shipping Option"
  * x-resourceId: custom_shipping_option
+ * required:
+ *   - price
+ *   - shipping_option_id
  * properties:
  *   id:
- *     description: "The id of the Custom Shipping Option. This value will be prefixed with `cso_`."
  *     type: string
+ *     description: The custom shipping option's ID
+ *     example: cso_01G8X99XNB77DMFBJFWX6DN9V9
  *   price:
  *     description: "The custom price set that will override the shipping option's original price"
  *     type: integer
+ *     example: 1000
  *   shipping_option_id:
- *     description: "The id of the Shipping Option that the custom shipping option overrides"
- *     anyOf:
- *       - $ref: "#/components/schemas/shipping_option"
+ *     description: "The ID of the Shipping Option that the custom shipping option overrides"
+ *     type: string
+ *     example: so_01G1G5V27GYX4QXNARRQCW1N8T
+ *   shipping_option:
+ *     description: A shipping option object. Available if the relation `shipping_option` is expanded.
+ *     type: object
  *   cart_id:
- *     description: "The id of the Cart that the custom shipping option is attached to"
- *     anyOf:
- *       - $ref: "#/components/schemas/cart"
+ *     description: "The ID of the Cart that the custom shipping option is attached to"
+ *     type: string
+ *     example: cart_01G8ZH853Y6TFXWPG5EYE81X63
+ *   cart:
+ *     description: A cart object. Available if the relation `cart` is expanded.
+ *     type: 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 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=custom-shipping-option.js.map

package/dist/models/custom-shipping-option.js.map

@@ -1 +1 @@
-{"version":3,"file":"custom-shipping-option.js","sourceRoot":"","sources":["../../src/models/custom-shipping-option.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,mCAQgB;AAChB,+BAA6B;AAC7B,qDAAkD;AAClD,oFAAgF;AAChF,4DAAwD;AACxD,kEAA8D;AAI9D;IAA0C,wCAAmB;IAA7D;;IA2BA,CAAC;IAHS,2CAAY,GAApB;QACE,IAAI,CAAC,EAAE,GAAG,IAAA,qCAAgB,EAAC,IAAI,CAAC,EAAE,EAAE,KAAK,CAAC,CAAA;IAC5C,CAAC;IAxBD;QADC,IAAA,gBAAM,EAAC,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC;;uDACX;IAIb;QAFC,IAAA,eAAK,GAAE;QACP,IAAA,gBAAM,GAAE;;oEACiB;IAI1B;QAFC,IAAA,mBAAS,EAAC,cAAM,OAAA,gCAAc,EAAd,CAAc,CAAC;QAC/B,IAAA,oBAAU,EAAC,EAAE,IAAI,EAAE,oBAAoB,EAAE,CAAC;kCAC1B,gCAAc;iEAAA;IAI/B;QAFC,IAAA,eAAK,GAAE;QACP,IAAA,gBAAM,EAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;yDACZ;IAIf;QAFC,IAAA,mBAAS,EAAC,cAAM,OAAA,WAAI,EAAJ,CAAI,CAAC;QACrB,IAAA,oBAAU,EAAC,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC;kCAC1B,WAAI;sDAAA;IAGV;QADC,IAAA,+BAAa,EAAC,EAAE,IAAI,EAAE,OAAO,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;0DAChB;IAGjC;QADC,IAAA,sBAAY,GAAE;;;;4DAGd;IA1BU,oBAAoB;QAFhC,IAAA,gBAAM,GAAE;QACR,IAAA,gBAAM,EAAC,CAAC,oBAAoB,EAAE,SAAS,CAAC,CAAC;OAC7B,oBAAoB,CA2BhC;IAAD,2BAAC;CAAA,AA3BD,CAA0C,2CAAmB,GA2B5D;AA3BY,oDAAoB;AA6BjC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmCG"}
+{"version":3,"file":"custom-shipping-option.js","sourceRoot":"","sources":["../../src/models/custom-shipping-option.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,mCAQgB;AAEhB,+BAA6B;AAC7B,4DAAwD;AACxD,qDAAkD;AAClD,oFAAgF;AAChF,kEAA8D;AAI9D;IAA0C,wCAAmB;IAA7D;;IA2BA,CAAC;IAHS,2CAAY,GAApB;QACE,IAAI,CAAC,EAAE,GAAG,IAAA,qCAAgB,EAAC,IAAI,CAAC,EAAE,EAAE,KAAK,CAAC,CAAA;IAC5C,CAAC;IAxBD;QADC,IAAA,gBAAM,EAAC,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC;;uDACX;IAIb;QAFC,IAAA,eAAK,GAAE;QACP,IAAA,gBAAM,GAAE;;oEACiB;IAI1B;QAFC,IAAA,mBAAS,EAAC,cAAM,OAAA,gCAAc,EAAd,CAAc,CAAC;QAC/B,IAAA,oBAAU,EAAC,EAAE,IAAI,EAAE,oBAAoB,EAAE,CAAC;kCAC1B,gCAAc;iEAAA;IAI/B;QAFC,IAAA,eAAK,GAAE;QACP,IAAA,gBAAM,EAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;yDACZ;IAIf;QAFC,IAAA,mBAAS,EAAC,cAAM,OAAA,WAAI,EAAJ,CAAI,CAAC;QACrB,IAAA,oBAAU,EAAC,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC;kCAC1B,WAAI;sDAAA;IAGV;QADC,IAAA,+BAAa,EAAC,EAAE,IAAI,EAAE,OAAO,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;0DAChB;IAGjC;QADC,IAAA,sBAAY,GAAE;;;;4DAGd;IA1BU,oBAAoB;QAFhC,IAAA,gBAAM,GAAE;QACR,IAAA,gBAAM,EAAC,CAAC,oBAAoB,EAAE,SAAS,CAAC,CAAC;OAC7B,oBAAoB,CA2BhC;IAAD,2BAAC;CAAA,AA3BD,CAA0C,2CAAmB,GA2B5D;AA3BY,oDAAoB;AA6BjC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+CG"}

package/dist/models/customer-group.d.ts

@@ -8,3 +8,47 @@ export declare class CustomerGroup extends SoftDeletableEntity {
     metadata: Record<string, unknown>;
     private beforeInsert;
 }
+/**
+ * @schema customer_group
+ * title: "Customer Group"
+ * description: "Represents a customer group"
+ * x-resourceId: customer_group
+ * required:
+ *   - name
+ * properties:
+ *   id:
+ *     type: string
+ *     description: The customer group's ID
+ *     example: cgrp_01G8ZH853Y6TFXWPG5EYE81X63
+ *   name:
+ *     type: string
+ *     description: The name of the customer group
+ *     example: VIP
+ *   customers:
+ *     type: array
+ *     description: The customers that belong to the customer group. Available if the relation `customers` is expanded.
+ *     items:
+ *       type: object
+ *       description: A customer object.
+ *   price_lists:
+ *     type: array
+ *     description: The price lists that are associated with the customer group. Available if the relation `price_lists` is expanded.
+ *     items:
+ *       $ref: "#/components/schemas/price_list"
+ *   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"}
+ */