@medusajs/medusa 1.3.3 → 1.3.6-next.0

package/dist/models/product-variant.js

@@ -26,11 +26,11 @@ var __metadata = (this && this.__metadata) || function (k, v) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ProductVariant = void 0;
 var typeorm_1 = require("typeorm");
-var product_1 = require("./product");
+var db_aware_column_1 = require("../utils/db-aware-column");
 var money_amount_1 = require("./money-amount");
+var product_1 = require("./product");
 var product_option_value_1 = require("./product-option-value");
 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 ProductVariant = /** @class */ (function (_super) {
     __extends(ProductVariant, _super);
@@ -156,85 +156,115 @@ exports.ProductVariant = ProductVariant;
  * title: "Product Variant"
  * description: "Product Variants represent a Product with a specific set of Product Option configurations. The maximum number of Product Variants that a Product can have is given by the number of available Product Option combinations."
  * x-resourceId: product_variant
+ * required:
+ *   - title
+ *   - product_id
+ *   - inventory_quantity
  * properties:
  *   id:
- *     description: "The id of the Product Variant. This value will be prefixed with `variant_`."
  *     type: string
+ *     description: The product variant's ID
+ *     example: variant_01G1G5V2MRX2V3PVSR2WXYPFB6
  *   title:
  *     description: "A title that can be displayed for easy identification of the Product Variant."
  *     type: string
+ *     example: Small
  *   product_id:
- *     description: "The id of the Product that the Product Variant belongs to."
+ *     description: "The ID of the Product that the Product Variant belongs to."
  *     type: string
+ *     example: prod_01G1G5V2MBA328390B5AXJ610F
+ *   product:
+ *     description: A product object. Available if the relation `product` is expanded.
+ *     type: object
  *   prices:
- *     description: "The Money Amounts defined for the Product Variant. Each Money Amount represents a price in a given currency or a price in a specific Region."
+ *     description: The Money Amounts defined for the Product Variant. Each Money Amount represents a price in a given currency or a price in a specific Region. Available if the relation `prices` is expanded.
  *     type: array
  *     items:
  *       $ref: "#/components/schemas/money_amount"
  *   sku:
  *     description: "The unique stock keeping unit used to identify the Product Variant. This will usually be a unqiue identifer for the item that is to be shipped, and can be referenced across multiple systems."
  *     type: string
+ *     example: shirt-123
  *   barcode:
  *     description: "A generic field for a GTIN number that can be used to identify the Product Variant."
  *     type: string
+ *     example: null
  *   ean:
  *     description: "An EAN barcode number that can be used to identify the Product Variant."
  *     type: string
+ *     example: null
  *   upc:
  *     description: "A UPC barcode number that can be used to identify the Product Variant."
  *     type: string
+ *     example: null
+ *   variant_rank:
+ *     description: The ranking of this variant
+ *     type: number
+ *     default: 0
  *   inventory_quantity:
  *     description: "The current quantity of the item that is stocked."
  *     type: integer
+ *     example: 100
  *   allow_backorder:
  *     description: "Whether the Product Variant should be purchasable when `inventory_quantity` is 0."
  *     type: boolean
+ *     default: false
  *   manage_inventory:
  *     description: "Whether Medusa should manage inventory for the Product Variant."
  *     type: boolean
+ *     default: true
  *   hs_code:
  *     description: "The Harmonized System code of the Product Variant. May be used by Fulfillment Providers to pass customs information to shipping carriers."
  *     type: string
+ *     example: null
  *   origin_country:
  *     description: "The country in which the Product Variant was produced. May be used by Fulfillment Providers to pass customs information to shipping carriers."
  *     type: string
+ *     example: null
  *   mid_code:
  *     description: "The Manufacturers Identification code that identifies the manufacturer of the Product Variant. May be used by Fulfillment Providers to pass customs information to shipping carriers."
  *     type: string
+ *     example: null
  *   material:
  *     description: "The material and composition that the Product Variant is made of, May be used by Fulfillment Providers to pass customs information to shipping carriers."
  *     type: string
+ *     example: null
  *   weight:
  *     description: "The weight of the Product Variant. May be used in shipping rate calculations."
- *     type: string
+ *     type: number
+ *     example: null
  *   height:
  *     description: "The height of the Product Variant. May be used in shipping rate calculations."
- *     type: string
+ *     type: number
+ *     example: null
  *   width:
  *     description: "The width of the Product Variant. May be used in shipping rate calculations."
- *     type: string
+ *     type: number
+ *     example: null
  *   length:
  *     description: "The length of the Product Variant. May be used in shipping rate calculations."
- *     type: string
+ *     type: number
+ *     example: null
  *   options:
- *     description: "The Product Option Values specified for the Product Variant."
+ *     description: The Product Option Values specified for the Product Variant. Available if the relation `options` is expanded.
  *     type: array
  *     items:
  *       $ref: "#/components/schemas/product_option_value"
  *   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=product-variant.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"product-variant.js","sourceRoot":"","sources":["../../src/models/product-variant.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,mCAQgB;AAEhB,qCAAmC;AACnC,+CAA4C;AAC5C,+DAA2D;AAC3D,oFAAgF;AAChF,4DAAwD;AACxD,kEAA8D;AAG9D;IAAoC,kCAAmB;IAAvD;;IAkFA,CAAC;IAHS,qCAAY,GAApB;QACE,IAAI,CAAC,EAAE,GAAG,IAAA,qCAAgB,EAAC,IAAI,CAAC,EAAE,EAAE,SAAS,CAAC,CAAA;IAChD,CAAC;IA/ED;QADC,IAAA,gBAAM,GAAE;;iDACI;IAIb;QAFC,IAAA,eAAK,GAAE;QACP,IAAA,gBAAM,GAAE;;sDACS;IAIlB;QAFC,IAAA,mBAAS,EAAC,cAAM,OAAA,iBAAO,EAAP,CAAO,EAAE,UAAC,OAAO,IAAK,OAAA,OAAO,CAAC,QAAQ,EAAhB,CAAgB,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC;QACxE,IAAA,oBAAU,EAAC,EAAE,IAAI,EAAE,YAAY,EAAE,CAAC;kCAC1B,iBAAO;mDAAA;IAMhB;QAJC,IAAA,mBAAS,EAAC,cAAM,OAAA,0BAAW,EAAX,CAAW,EAAE,UAAC,EAAE,IAAK,OAAA,EAAE,CAAC,OAAO,EAAV,CAAU,EAAE;YAChD,OAAO,EAAE,IAAI;YACb,QAAQ,EAAE,SAAS;SACpB,CAAC;;kDACmB;IAIrB;QAFC,IAAA,gBAAM,EAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;QAC1B,IAAA,eAAK,EAAC,EAAE,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,oBAAoB,EAAE,CAAC;;+CAC1C;IAIX;QAFC,IAAA,gBAAM,EAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;QAC1B,IAAA,eAAK,EAAC,EAAE,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,oBAAoB,EAAE,CAAC;;mDACtC;IAIf;QAFC,IAAA,gBAAM,EAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;QAC1B,IAAA,eAAK,EAAC,EAAE,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,oBAAoB,EAAE,CAAC;;+CAC1C;IAIX;QAFC,IAAA,gBAAM,EAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;QAC1B,IAAA,eAAK,EAAC,EAAE,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,oBAAoB,EAAE,CAAC;;+CAC1C;IAGX;QADC,IAAA,gBAAM,EAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC;;wDAClC;IAGpB;QADC,IAAA,gBAAM,EAAC,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC;;8DACE;IAG1B;QADC,IAAA,gBAAM,EAAC,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC;;2DACH;IAGxB;QADC,IAAA,gBAAM,EAAC,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC;;4DACD;IAGzB;QADC,IAAA,gBAAM,EAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;mDACZ;IAGf;QADC,IAAA,gBAAM,EAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;0DACL;IAGtB;QADC,IAAA,gBAAM,EAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;oDACX;IAGhB;QADC,IAAA,gBAAM,EAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;oDACX;IAGhB;QADC,IAAA,gBAAM,EAAC,EAAE,IAAI,EAAE,KAAK,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;kDAC1B;IAGd;QADC,IAAA,gBAAM,EAAC,EAAE,IAAI,EAAE,KAAK,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;kDAC1B;IAGd;QADC,IAAA,gBAAM,EAAC,EAAE,IAAI,EAAE,KAAK,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;kDAC1B;IAGd;QADC,IAAA,gBAAM,EAAC,EAAE,IAAI,EAAE,KAAK,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;iDAC3B;IAKb;QAHC,IAAA,mBAAS,EAAC,cAAM,OAAA,yCAAkB,EAAlB,CAAkB,EAAE,UAAC,WAAW,IAAK,OAAA,WAAW,CAAC,OAAO,EAAnB,CAAmB,EAAE;YACzE,OAAO,EAAE,IAAI;SACd,CAAC;;mDAC2B;IAG7B;QADC,IAAA,+BAAa,EAAC,EAAE,IAAI,EAAE,OAAO,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;oDAChB;IAGjC;QADC,IAAA,sBAAY,GAAE;;;;sDAGd;IAjFU,cAAc;QAD1B,IAAA,gBAAM,GAAE;OACI,cAAc,CAkF1B;IAAD,qBAAC;CAAA,AAlFD,CAAoC,2CAAmB,GAkFtD;AAlFY,wCAAc;AAoF3B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAqFG"}
+{"version":3,"file":"product-variant.js","sourceRoot":"","sources":["../../src/models/product-variant.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,mCAQgB;AAEhB,4DAAwD;AACxD,+CAA4C;AAC5C,qCAAmC;AACnC,+DAA2D;AAC3D,oFAAgF;AAChF,kEAA8D;AAG9D;IAAoC,kCAAmB;IAAvD;;IAkFA,CAAC;IAHS,qCAAY,GAApB;QACE,IAAI,CAAC,EAAE,GAAG,IAAA,qCAAgB,EAAC,IAAI,CAAC,EAAE,EAAE,SAAS,CAAC,CAAA;IAChD,CAAC;IA/ED;QADC,IAAA,gBAAM,GAAE;;iDACI;IAIb;QAFC,IAAA,eAAK,GAAE;QACP,IAAA,gBAAM,GAAE;;sDACS;IAIlB;QAFC,IAAA,mBAAS,EAAC,cAAM,OAAA,iBAAO,EAAP,CAAO,EAAE,UAAC,OAAO,IAAK,OAAA,OAAO,CAAC,QAAQ,EAAhB,CAAgB,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC;QACxE,IAAA,oBAAU,EAAC,EAAE,IAAI,EAAE,YAAY,EAAE,CAAC;kCAC1B,iBAAO;mDAAA;IAMhB;QAJC,IAAA,mBAAS,EAAC,cAAM,OAAA,0BAAW,EAAX,CAAW,EAAE,UAAC,EAAE,IAAK,OAAA,EAAE,CAAC,OAAO,EAAV,CAAU,EAAE;YAChD,OAAO,EAAE,IAAI;YACb,QAAQ,EAAE,SAAS;SACpB,CAAC;;kDACmB;IAIrB;QAFC,IAAA,gBAAM,EAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;QAC1B,IAAA,eAAK,EAAC,EAAE,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,oBAAoB,EAAE,CAAC;;+CAC1C;IAIX;QAFC,IAAA,gBAAM,EAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;QAC1B,IAAA,eAAK,EAAC,EAAE,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,oBAAoB,EAAE,CAAC;;mDACtC;IAIf;QAFC,IAAA,gBAAM,EAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;QAC1B,IAAA,eAAK,EAAC,EAAE,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,oBAAoB,EAAE,CAAC;;+CAC1C;IAIX;QAFC,IAAA,gBAAM,EAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;QAC1B,IAAA,eAAK,EAAC,EAAE,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,oBAAoB,EAAE,CAAC;;+CAC1C;IAGX;QADC,IAAA,gBAAM,EAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC;;wDAClC;IAGpB;QADC,IAAA,gBAAM,EAAC,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC;;8DACE;IAG1B;QADC,IAAA,gBAAM,EAAC,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC;;2DACH;IAGxB;QADC,IAAA,gBAAM,EAAC,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC;;4DACD;IAGzB;QADC,IAAA,gBAAM,EAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;mDACZ;IAGf;QADC,IAAA,gBAAM,EAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;0DACL;IAGtB;QADC,IAAA,gBAAM,EAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;oDACX;IAGhB;QADC,IAAA,gBAAM,EAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;oDACX;IAGhB;QADC,IAAA,gBAAM,EAAC,EAAE,IAAI,EAAE,KAAK,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;kDAC1B;IAGd;QADC,IAAA,gBAAM,EAAC,EAAE,IAAI,EAAE,KAAK,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;kDAC1B;IAGd;QADC,IAAA,gBAAM,EAAC,EAAE,IAAI,EAAE,KAAK,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;kDAC1B;IAGd;QADC,IAAA,gBAAM,EAAC,EAAE,IAAI,EAAE,KAAK,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;iDAC3B;IAKb;QAHC,IAAA,mBAAS,EAAC,cAAM,OAAA,yCAAkB,EAAlB,CAAkB,EAAE,UAAC,WAAW,IAAK,OAAA,WAAW,CAAC,OAAO,EAAnB,CAAmB,EAAE;YACzE,OAAO,EAAE,IAAI;SACd,CAAC;;mDAC2B;IAG7B;QADC,IAAA,+BAAa,EAAC,EAAE,IAAI,EAAE,OAAO,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;oDAChB;IAGjC;QADC,IAAA,sBAAY,GAAE;;;;sDAGd;IAjFU,cAAc;QAD1B,IAAA,gBAAM,GAAE;OACI,cAAc,CAkF1B;IAAD,qBAAC;CAAA,AAlFD,CAAoC,2CAAmB,GAkFtD;AAlFY,wCAAc;AAoF3B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmHG"}

package/dist/models/product.d.ts

@@ -4,6 +4,7 @@ import { ProductOption } from "./product-option";
 import { ProductTag } from "./product-tag";
 import { ProductType } from "./product-type";
 import { ProductVariant } from "./product-variant";
+import { SalesChannel } from "./sales-channel";
 import { ShippingProfile } from "./shipping-profile";
 import { SoftDeletableEntity } from "../interfaces/models/soft-deletable-entity";
 export declare enum ProductStatus {
@@ -41,6 +42,7 @@ export declare class Product extends SoftDeletableEntity {
     discountable: boolean;
     external_id: string | null;
     metadata: Record<string, unknown> | null;
+    sales_channels: SalesChannel[];
     private beforeInsert;
 }
 /**
@@ -48,99 +50,147 @@ export declare class Product extends SoftDeletableEntity {
  * title: "Product"
  * description: "Products are a grouping of Product Variants that have common properties such as images and descriptions. Products can have multiple options which define the properties that Product Variants differ by."
  * x-resourceId: product
+ * required:
+ *   - title
+ *   - profile_id
  * properties:
  *   id:
- *     description: "The id of the Product. This value will be prefixed with `prod_`."
  *     type: string
+ *     description: The product's ID
+ *     example: prod_01G1G5V2MBA328390B5AXJ610F
  *   title:
  *     description: "A title that can be displayed for easy identification of the Product."
  *     type: string
+ *     example: Medusa Coffee Mug
  *   subtitle:
  *     description: "An optional subtitle that can be used to further specify the Product."
  *     type: string
  *   description:
  *     description: "A short description of the Product."
  *     type: string
+ *     example: Every programmer's best friend.
  *   handle:
  *     description: "A unique identifier for the Product (e.g. for slug structure)."
  *     type: string
+ *     example: coffee-mug
  *   is_giftcard:
  *     description: "Whether the Product represents a Gift Card. Products that represent Gift Cards will automatically generate a redeemable Gift Card code once they are purchased."
  *     type: boolean
- *   discountable:
- *     description: "Whether the Product can be discounted. Discounts will not apply to Line Items of this Product when this flag is set to `false`."
- *     type: boolean
+ *     default: false
+ *   status:
+ *     description: The status of the product
+ *     type: string
+ *     enum:
+ *       - draft
+ *       - proposed
+ *       - published
+ *       - rejected
+ *     default: draft
  *   images:
- *     description: "Images of the Product"
+ *     description: Images of the Product. Available if the relation `images` is expanded.
  *     type: array
  *     items:
  *       $ref: "#/components/schemas/image"
  *   thumbnail:
  *     description: "A URL to an image file that can be used to identify the Product."
  *     type: string
+ *     format: uri
  *   options:
- *     description: "The Product Options that are defined for the Product. Product Variants of the Product will have a unique combination of Product Option Values."
+ *     description: The Product Options that are defined for the Product. Product Variants of the Product will have a unique combination of Product Option Values. Available if the relation `options` is expanded.
  *     type: array
  *     items:
  *       $ref: "#/components/schemas/product_option"
  *   variants:
- *     description: "The Product Variants that belong to the Product. Each will have a unique combination of Product Option Values."
+ *     description: The Product Variants that belong to the Product. Each will have a unique combination of Product Option Values. Available if the relation `variants` is expanded.
  *     type: array
  *     items:
  *       $ref: "#/components/schemas/product_variant"
  *   profile_id:
- *     description: "The id of the Shipping Profile that the Product belongs to. Shipping Profiles have a set of defined Shipping Options that can be used to Fulfill a given set of Products."
+ *     description: "The ID of the Shipping Profile that the Product belongs to. Shipping Profiles have a set of defined Shipping Options that can be used to Fulfill a given set of Products."
  *     type: string
+ *     example: sp_01G1G5V239ENSZ5MV4JAR737BM
+ *   profile:
+ *     description: Available if the relation `profile` is expanded.
+ *     $ref: "#/components/schemas/shipping_profile"
+ *   weight:
+ *     description: "The weight of the Product Variant. May be used in shipping rate calculations."
+ *     type: number
+ *     example: null
+ *   height:
+ *     description: "The height of the Product Variant. May be used in shipping rate calculations."
+ *     type: number
+ *     example: null
+ *   width:
+ *     description: "The width of the Product Variant. May be used in shipping rate calculations."
+ *     type: number
+ *     example: null
+ *   length:
+ *     description: "The length of the Product Variant. May be used in shipping rate calculations."
+ *     type: number
+ *     example: null
  *   hs_code:
  *     description: "The Harmonized System code of the Product Variant. May be used by Fulfillment Providers to pass customs information to shipping carriers."
  *     type: string
+ *     example: null
  *   origin_country:
  *     description: "The country in which the Product Variant was produced. May be used by Fulfillment Providers to pass customs information to shipping carriers."
  *     type: string
+ *     example: null
  *   mid_code:
  *     description: "The Manufacturers Identification code that identifies the manufacturer of the Product Variant. May be used by Fulfillment Providers to pass customs information to shipping carriers."
  *     type: string
+ *     example: null
  *   material:
  *     description: "The material and composition that the Product Variant is made of, May be used by Fulfillment Providers to pass customs information to shipping carriers."
  *     type: string
- *   weight:
- *     description: "The weight of the Product Variant. May be used in shipping rate calculations."
- *     type: string
- *   height:
- *     description: "The height of the Product Variant. May be used in shipping rate calculations."
- *     type: string
- *   width:
- *     description: "The width of the Product Variant. May be used in shipping rate calculations."
+ *     example: null
+ *   collection_id:
  *     type: string
- *   length:
- *     description: "The length of the Product Variant. May be used in shipping rate calculations."
+ *     description: The Product Collection that the Product belongs to
+ *     example: pcol_01F0YESBFAZ0DV6V831JXWH0BG
+ *   collection:
+ *     description: A product collection object. Available if the relation `collection` is expanded.
+ *     type: object
+ *   type_id:
  *     type: string
+ *     description: The Product type that the Product belongs to
+ *     example: ptyp_01G8X9A7ESKAJXG2H0E6F1MW7A
  *   type:
- *     description: "The Product Type of the Product (e.g. \"Clothing\")"
- *     anyOf:
- *       - $ref: "#/components/schemas/product_type"
- *   collection:
- *     description: "The Product Collection that the Product belongs to (e.g. \"SS20\")"
- *     anyOf:
- *       - $ref: "#/components/schemas/product_collection"
+ *     description: Available if the relation `type` is expanded.
+ *     $ref: "#/components/schemas/product_type"
  *   tags:
- *     description: "The Product Tags assigned to the Product."
+ *     description: The Product Tags assigned to the Product. Available if the relation `tags` is expanded.
  *     type: array
  *     items:
  *       $ref: "#/components/schemas/product_tag"
+ *   discountable:
+ *     description: "Whether the Product can be discounted. Discounts will not apply to Line Items of this Product when this flag is set to `false`."
+ *     type: boolean
+ *     default: true
+ *   external_id:
+ *     description: The external ID of the product
+ *     type: string
+ *     example: null
+ *   sales_channels:
+ *     description: The sales channels the product is associated with. Available if the relation `sales_channels` is expanded.
+ *     type: array
+ *     items:
+ *       type: object
+ *       description: A sales channel 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/product.js

@@ -28,17 +28,19 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Product = exports.ProductStatus = void 0;
-var lodash_1 = __importDefault(require("lodash"));
 var typeorm_1 = require("typeorm");
 var db_aware_column_1 = require("../utils/db-aware-column");
+var feature_flag_decorators_1 = require("../utils/feature-flag-decorators");
 var image_1 = require("./image");
 var product_collection_1 = require("./product-collection");
 var product_option_1 = require("./product-option");
 var product_tag_1 = require("./product-tag");
 var product_type_1 = require("./product-type");
 var product_variant_1 = require("./product-variant");
+var sales_channel_1 = require("./sales-channel");
 var shipping_profile_1 = require("./shipping-profile");
 var soft_deletable_entity_1 = require("../interfaces/models/soft-deletable-entity");
+var lodash_1 = __importDefault(require("lodash"));
 var generate_entity_id_1 = require("../utils/generate-entity-id");
 var ProductStatus;
 (function (ProductStatus) {
@@ -201,6 +203,23 @@ var Product = /** @class */ (function (_super) {
         (0, db_aware_column_1.DbAwareColumn)({ type: "jsonb", nullable: true }),
         __metadata("design:type", Object)
     ], Product.prototype, "metadata", void 0);
+    __decorate([
+        (0, feature_flag_decorators_1.FeatureFlagDecorators)("sales_channels", [
+            (0, typeorm_1.ManyToMany)(function () { return sales_channel_1.SalesChannel; }, { cascade: ["remove", "soft-remove"] }),
+            (0, typeorm_1.JoinTable)({
+                name: "product_sales_channel",
+                joinColumn: {
+                    name: "product_id",
+                    referencedColumnName: "id",
+                },
+                inverseJoinColumn: {
+                    name: "sales_channel_id",
+                    referencedColumnName: "id",
+                },
+            }),
+        ]),
+        __metadata("design:type", Array)
+    ], Product.prototype, "sales_channels", void 0);
     __decorate([
         (0, typeorm_1.BeforeInsert)(),
         __metadata("design:type", Function),
@@ -218,100 +237,148 @@ exports.Product = Product;
  * title: "Product"
  * description: "Products are a grouping of Product Variants that have common properties such as images and descriptions. Products can have multiple options which define the properties that Product Variants differ by."
  * x-resourceId: product
+ * required:
+ *   - title
+ *   - profile_id
  * properties:
  *   id:
- *     description: "The id of the Product. This value will be prefixed with `prod_`."
  *     type: string
+ *     description: The product's ID
+ *     example: prod_01G1G5V2MBA328390B5AXJ610F
  *   title:
  *     description: "A title that can be displayed for easy identification of the Product."
  *     type: string
+ *     example: Medusa Coffee Mug
  *   subtitle:
  *     description: "An optional subtitle that can be used to further specify the Product."
  *     type: string
  *   description:
  *     description: "A short description of the Product."
  *     type: string
+ *     example: Every programmer's best friend.
  *   handle:
  *     description: "A unique identifier for the Product (e.g. for slug structure)."
  *     type: string
+ *     example: coffee-mug
  *   is_giftcard:
  *     description: "Whether the Product represents a Gift Card. Products that represent Gift Cards will automatically generate a redeemable Gift Card code once they are purchased."
  *     type: boolean
- *   discountable:
- *     description: "Whether the Product can be discounted. Discounts will not apply to Line Items of this Product when this flag is set to `false`."
- *     type: boolean
+ *     default: false
+ *   status:
+ *     description: The status of the product
+ *     type: string
+ *     enum:
+ *       - draft
+ *       - proposed
+ *       - published
+ *       - rejected
+ *     default: draft
  *   images:
- *     description: "Images of the Product"
+ *     description: Images of the Product. Available if the relation `images` is expanded.
  *     type: array
  *     items:
  *       $ref: "#/components/schemas/image"
  *   thumbnail:
  *     description: "A URL to an image file that can be used to identify the Product."
  *     type: string
+ *     format: uri
  *   options:
- *     description: "The Product Options that are defined for the Product. Product Variants of the Product will have a unique combination of Product Option Values."
+ *     description: The Product Options that are defined for the Product. Product Variants of the Product will have a unique combination of Product Option Values. Available if the relation `options` is expanded.
  *     type: array
  *     items:
  *       $ref: "#/components/schemas/product_option"
  *   variants:
- *     description: "The Product Variants that belong to the Product. Each will have a unique combination of Product Option Values."
+ *     description: The Product Variants that belong to the Product. Each will have a unique combination of Product Option Values. Available if the relation `variants` is expanded.
  *     type: array
  *     items:
  *       $ref: "#/components/schemas/product_variant"
  *   profile_id:
- *     description: "The id of the Shipping Profile that the Product belongs to. Shipping Profiles have a set of defined Shipping Options that can be used to Fulfill a given set of Products."
+ *     description: "The ID of the Shipping Profile that the Product belongs to. Shipping Profiles have a set of defined Shipping Options that can be used to Fulfill a given set of Products."
  *     type: string
+ *     example: sp_01G1G5V239ENSZ5MV4JAR737BM
+ *   profile:
+ *     description: Available if the relation `profile` is expanded.
+ *     $ref: "#/components/schemas/shipping_profile"
+ *   weight:
+ *     description: "The weight of the Product Variant. May be used in shipping rate calculations."
+ *     type: number
+ *     example: null
+ *   height:
+ *     description: "The height of the Product Variant. May be used in shipping rate calculations."
+ *     type: number
+ *     example: null
+ *   width:
+ *     description: "The width of the Product Variant. May be used in shipping rate calculations."
+ *     type: number
+ *     example: null
+ *   length:
+ *     description: "The length of the Product Variant. May be used in shipping rate calculations."
+ *     type: number
+ *     example: null
  *   hs_code:
  *     description: "The Harmonized System code of the Product Variant. May be used by Fulfillment Providers to pass customs information to shipping carriers."
  *     type: string
+ *     example: null
  *   origin_country:
  *     description: "The country in which the Product Variant was produced. May be used by Fulfillment Providers to pass customs information to shipping carriers."
  *     type: string
+ *     example: null
  *   mid_code:
  *     description: "The Manufacturers Identification code that identifies the manufacturer of the Product Variant. May be used by Fulfillment Providers to pass customs information to shipping carriers."
  *     type: string
+ *     example: null
  *   material:
  *     description: "The material and composition that the Product Variant is made of, May be used by Fulfillment Providers to pass customs information to shipping carriers."
  *     type: string
- *   weight:
- *     description: "The weight of the Product Variant. May be used in shipping rate calculations."
+ *     example: null
+ *   collection_id:
  *     type: string
- *   height:
- *     description: "The height of the Product Variant. May be used in shipping rate calculations."
- *     type: string
- *   width:
- *     description: "The width of the Product Variant. May be used in shipping rate calculations."
- *     type: string
- *   length:
- *     description: "The length of the Product Variant. May be used in shipping rate calculations."
+ *     description: The Product Collection that the Product belongs to
+ *     example: pcol_01F0YESBFAZ0DV6V831JXWH0BG
+ *   collection:
+ *     description: A product collection object. Available if the relation `collection` is expanded.
+ *     type: object
+ *   type_id:
  *     type: string
+ *     description: The Product type that the Product belongs to
+ *     example: ptyp_01G8X9A7ESKAJXG2H0E6F1MW7A
  *   type:
- *     description: "The Product Type of the Product (e.g. \"Clothing\")"
- *     anyOf:
- *       - $ref: "#/components/schemas/product_type"
- *   collection:
- *     description: "The Product Collection that the Product belongs to (e.g. \"SS20\")"
- *     anyOf:
- *       - $ref: "#/components/schemas/product_collection"
+ *     description: Available if the relation `type` is expanded.
+ *     $ref: "#/components/schemas/product_type"
  *   tags:
- *     description: "The Product Tags assigned to the Product."
+ *     description: The Product Tags assigned to the Product. Available if the relation `tags` is expanded.
  *     type: array
  *     items:
  *       $ref: "#/components/schemas/product_tag"
+ *   discountable:
+ *     description: "Whether the Product can be discounted. Discounts will not apply to Line Items of this Product when this flag is set to `false`."
+ *     type: boolean
+ *     default: true
+ *   external_id:
+ *     description: The external ID of the product
+ *     type: string
+ *     example: null
+ *   sales_channels:
+ *     description: The sales channels the product is associated with. Available if the relation `sales_channels` is expanded.
+ *     type: array
+ *     items:
+ *       type: object
+ *       description: A sales channel 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=product.js.map

package/dist/models/product.js.map

@@ -1 +1 @@
-{"version":3,"file":"product.js","sourceRoot":"","sources":["../../src/models/product.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,kDAAsB;AACtB,mCAUgB;AAChB,4DAAwD;AACxD,iCAA+B;AAC/B,2DAAwD;AACxD,mDAAgD;AAChD,6CAA0C;AAC1C,+CAA4C;AAC5C,qDAAkD;AAClD,uDAAoD;AACpD,oFAAgF;AAChF,kEAA8D;AAE9D,IAAY,aAKX;AALD,WAAY,aAAa;IACvB,gCAAe,CAAA;IACf,sCAAqB,CAAA;IACrB,wCAAuB,CAAA;IACvB,sCAAqB,CAAA;AACvB,CAAC,EALW,aAAa,GAAb,qBAAa,KAAb,qBAAa,QAKxB;AAGD;IAA6B,2BAAmB;IAAhD;;IAkIA,CAAC;IARS,8BAAY,GAApB;QACE,IAAI,IAAI,CAAC,EAAE;YAAE,OAAM;QAEnB,IAAI,CAAC,EAAE,GAAG,IAAA,qCAAgB,EAAC,IAAI,CAAC,EAAE,EAAE,MAAM,CAAC,CAAA;QAC3C,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE;YAChB,IAAI,CAAC,MAAM,GAAG,gBAAC,CAAC,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;SACtC;IACH,CAAC;IA/HD;QADC,IAAA,gBAAM,GAAE;;0CACI;IAGb;QADC,IAAA,gBAAM,EAAC,EAAE,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;6CAClB;IAGvB;QADC,IAAA,gBAAM,EAAC,EAAE,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;gDACf;IAI1B;QAFC,IAAA,eAAK,EAAC,EAAE,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,oBAAoB,EAAE,CAAC;QACpD,IAAA,gBAAM,EAAC,EAAE,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;2CACpB;IAGrB;QADC,IAAA,gBAAM,EAAC,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC;;gDACP;IAGpB;QADC,IAAA,+BAAa,EAAC,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,aAAa,EAAE,OAAO,EAAE,OAAO,EAAE,CAAC;;2CAClD;IAcrB;QAZC,IAAA,oBAAU,EAAC,cAAM,OAAA,aAAK,EAAL,CAAK,EAAE,EAAE,OAAO,EAAE,CAAC,QAAQ,CAAC,EAAE,CAAC;QAChD,IAAA,mBAAS,EAAC;YACT,IAAI,EAAE,gBAAgB;YACtB,UAAU,EAAE;gBACV,IAAI,EAAE,YAAY;gBAClB,oBAAoB,EAAE,IAAI;aAC3B;YACD,iBAAiB,EAAE;gBACjB,IAAI,EAAE,UAAU;gBAChB,oBAAoB,EAAE,IAAI;aAC3B;SACF,CAAC;;2CACa;IAGf;QADC,IAAA,gBAAM,EAAC,EAAE,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;8CACjB;IAMxB;QAJC,IAAA,mBAAS,EACR,cAAM,OAAA,8BAAa,EAAb,CAAa,EACnB,UAAC,aAAa,IAAK,OAAA,aAAa,CAAC,OAAO,EAArB,CAAqB,CACzC;;4CACuB;IASxB;QAPC,IAAA,mBAAS,EACR,cAAM,OAAA,gCAAc,EAAd,CAAc,EACpB,UAAC,OAAO,IAAK,OAAA,OAAO,CAAC,OAAO,EAAf,CAAe,EAC5B;YACE,OAAO,EAAE,IAAI;SACd,CACF;;6CACyB;IAI1B;QAFC,IAAA,eAAK,GAAE;QACP,IAAA,gBAAM,GAAE;;+CACS;IAIlB;QAFC,IAAA,mBAAS,EAAC,cAAM,OAAA,kCAAe,EAAf,CAAe,CAAC;QAChC,IAAA,oBAAU,EAAC,EAAE,IAAI,EAAE,YAAY,EAAE,CAAC;kCAC1B,kCAAe;4CAAA;IAGxB;QADC,IAAA,gBAAM,EAAC,EAAE,IAAI,EAAE,KAAK,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;2CACnB;IAGrB;QADC,IAAA,gBAAM,EAAC,EAAE,IAAI,EAAE,KAAK,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;2CACnB;IAGrB;QADC,IAAA,gBAAM,EAAC,EAAE,IAAI,EAAE,KAAK,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;2CACnB;IAGrB;QADC,IAAA,gBAAM,EAAC,EAAE,IAAI,EAAE,KAAK,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;0CACpB;IAGpB;QADC,IAAA,gBAAM,EAAC,EAAE,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;4CACnB;IAGtB;QADC,IAAA,gBAAM,EAAC,EAAE,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;mDACZ;IAG7B;QADC,IAAA,gBAAM,EAAC,EAAE,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;6CAClB;IAGvB;QADC,IAAA,gBAAM,EAAC,EAAE,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;6CAClB;IAGvB;QADC,IAAA,gBAAM,EAAC,EAAE,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;kDACb;IAI5B;QAFC,IAAA,mBAAS,EAAC,cAAM,OAAA,sCAAiB,EAAjB,CAAiB,CAAC;QAClC,IAAA,oBAAU,EAAC,EAAE,IAAI,EAAE,eAAe,EAAE,CAAC;kCAC1B,sCAAiB;+CAAA;IAG7B;QADC,IAAA,gBAAM,EAAC,EAAE,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;4CACnB;IAItB;QAFC,IAAA,mBAAS,EAAC,cAAM,OAAA,0BAAW,EAAX,CAAW,CAAC;QAC5B,IAAA,oBAAU,EAAC,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC;kCAC1B,0BAAW;yCAAA;IAcjB;QAZC,IAAA,oBAAU,EAAC,cAAM,OAAA,wBAAU,EAAV,CAAU,CAAC;QAC5B,IAAA,mBAAS,EAAC;YACT,IAAI,EAAE,cAAc;YACpB,UAAU,EAAE;gBACV,IAAI,EAAE,YAAY;gBAClB,oBAAoB,EAAE,IAAI;aAC3B;YACD,iBAAiB,EAAE;gBACjB,IAAI,EAAE,gBAAgB;gBACtB,oBAAoB,EAAE,IAAI;aAC3B;SACF,CAAC;;yCACgB;IAGlB;QADC,IAAA,gBAAM,EAAC,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC;;iDACL;IAGrB;QADC,IAAA,gBAAM,EAAC,EAAE,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;gDACf;IAG1B;QADC,IAAA,+BAAa,EAAC,EAAE,IAAI,EAAE,OAAO,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;6CACT;IAGxC;QADC,IAAA,sBAAY,GAAE;;;;+CAQd;IAjIU,OAAO;QADnB,IAAA,gBAAM,GAAE;OACI,OAAO,CAkInB;IAAD,cAAC;CAAA,AAlID,CAA6B,2CAAmB,GAkI/C;AAlIY,0BAAO;AAoIpB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoGG"}
+{"version":3,"file":"product.js","sourceRoot":"","sources":["../../src/models/product.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,mCAUgB;AAEhB,4DAAwD;AACxD,4EAAwE;AACxE,iCAA+B;AAC/B,2DAAwD;AACxD,mDAAgD;AAChD,6CAA0C;AAC1C,+CAA4C;AAC5C,qDAAkD;AAClD,iDAA8C;AAC9C,uDAAoD;AACpD,oFAAgF;AAChF,kDAAsB;AACtB,kEAA8D;AAE9D,IAAY,aAKX;AALD,WAAY,aAAa;IACvB,gCAAe,CAAA;IACf,sCAAqB,CAAA;IACrB,wCAAuB,CAAA;IACvB,sCAAqB,CAAA;AACvB,CAAC,EALW,aAAa,GAAb,qBAAa,KAAb,qBAAa,QAKxB;AAGD;IAA6B,2BAAmB;IAAhD;;IA2IA,CAAC;IARS,8BAAY,GAApB;QACE,IAAI,IAAI,CAAC,EAAE;YAAE,OAAM;QAEnB,IAAI,CAAC,EAAE,GAAG,IAAA,qCAAgB,EAAC,IAAI,CAAC,EAAE,EAAE,MAAM,CAAC,CAAA;QAC3C,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE;YAChB,IAAI,CAAC,MAAM,GAAG,gBAAC,CAAC,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;SACtC;IACH,CAAC;IAxID;QADC,IAAA,gBAAM,GAAE;;0CACI;IAGb;QADC,IAAA,gBAAM,EAAC,EAAE,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;6CAClB;IAGvB;QADC,IAAA,gBAAM,EAAC,EAAE,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;gDACf;IAI1B;QAFC,IAAA,eAAK,EAAC,EAAE,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,oBAAoB,EAAE,CAAC;QACpD,IAAA,gBAAM,EAAC,EAAE,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;2CACpB;IAGrB;QADC,IAAA,gBAAM,EAAC,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC;;gDACP;IAGpB;QADC,IAAA,+BAAa,EAAC,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,aAAa,EAAE,OAAO,EAAE,OAAO,EAAE,CAAC;;2CAClD;IAcrB;QAZC,IAAA,oBAAU,EAAC,cAAM,OAAA,aAAK,EAAL,CAAK,EAAE,EAAE,OAAO,EAAE,CAAC,QAAQ,CAAC,EAAE,CAAC;QAChD,IAAA,mBAAS,EAAC;YACT,IAAI,EAAE,gBAAgB;YACtB,UAAU,EAAE;gBACV,IAAI,EAAE,YAAY;gBAClB,oBAAoB,EAAE,IAAI;aAC3B;YACD,iBAAiB,EAAE;gBACjB,IAAI,EAAE,UAAU;gBAChB,oBAAoB,EAAE,IAAI;aAC3B;SACF,CAAC;;2CACa;IAGf;QADC,IAAA,gBAAM,EAAC,EAAE,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;8CACjB;IAGxB;QADC,IAAA,mBAAS,EAAC,cAAM,OAAA,8BAAa,EAAb,CAAa,EAAE,UAAC,aAAa,IAAK,OAAA,aAAa,CAAC,OAAO,EAArB,CAAqB,CAAC;;4CACjD;IAKxB;QAHC,IAAA,mBAAS,EAAC,cAAM,OAAA,gCAAc,EAAd,CAAc,EAAE,UAAC,OAAO,IAAK,OAAA,OAAO,CAAC,OAAO,EAAf,CAAe,EAAE;YAC7D,OAAO,EAAE,IAAI;SACd,CAAC;;6CACwB;IAI1B;QAFC,IAAA,eAAK,GAAE;QACP,IAAA,gBAAM,GAAE;;+CACS;IAIlB;QAFC,IAAA,mBAAS,EAAC,cAAM,OAAA,kCAAe,EAAf,CAAe,CAAC;QAChC,IAAA,oBAAU,EAAC,EAAE,IAAI,EAAE,YAAY,EAAE,CAAC;kCAC1B,kCAAe;4CAAA;IAGxB;QADC,IAAA,gBAAM,EAAC,EAAE,IAAI,EAAE,KAAK,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;2CACnB;IAGrB;QADC,IAAA,gBAAM,EAAC,EAAE,IAAI,EAAE,KAAK,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;2CACnB;IAGrB;QADC,IAAA,gBAAM,EAAC,EAAE,IAAI,EAAE,KAAK,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;2CACnB;IAGrB;QADC,IAAA,gBAAM,EAAC,EAAE,IAAI,EAAE,KAAK,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;0CACpB;IAGpB;QADC,IAAA,gBAAM,EAAC,EAAE,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;4CACnB;IAGtB;QADC,IAAA,gBAAM,EAAC,EAAE,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;mDACZ;IAG7B;QADC,IAAA,gBAAM,EAAC,EAAE,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;6CAClB;IAGvB;QADC,IAAA,gBAAM,EAAC,EAAE,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;6CAClB;IAGvB;QADC,IAAA,gBAAM,EAAC,EAAE,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;kDACb;IAI5B;QAFC,IAAA,mBAAS,EAAC,cAAM,OAAA,sCAAiB,EAAjB,CAAiB,CAAC;QAClC,IAAA,oBAAU,EAAC,EAAE,IAAI,EAAE,eAAe,EAAE,CAAC;kCAC1B,sCAAiB;+CAAA;IAG7B;QADC,IAAA,gBAAM,EAAC,EAAE,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;4CACnB;IAItB;QAFC,IAAA,mBAAS,EAAC,cAAM,OAAA,0BAAW,EAAX,CAAW,CAAC;QAC5B,IAAA,oBAAU,EAAC,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC;kCAC1B,0BAAW;yCAAA;IAcjB;QAZC,IAAA,oBAAU,EAAC,cAAM,OAAA,wBAAU,EAAV,CAAU,CAAC;QAC5B,IAAA,mBAAS,EAAC;YACT,IAAI,EAAE,cAAc;YACpB,UAAU,EAAE;gBACV,IAAI,EAAE,YAAY;gBAClB,oBAAoB,EAAE,IAAI;aAC3B;YACD,iBAAiB,EAAE;gBACjB,IAAI,EAAE,gBAAgB;gBACtB,oBAAoB,EAAE,IAAI;aAC3B;SACF,CAAC;;yCACgB;IAGlB;QADC,IAAA,gBAAM,EAAC,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC;;iDACL;IAGrB;QADC,IAAA,gBAAM,EAAC,EAAE,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;gDACf;IAG1B;QADC,IAAA,+BAAa,EAAC,EAAE,IAAI,EAAE,OAAO,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;6CACT;IAgBxC;QAdC,IAAA,+CAAqB,EAAC,gBAAgB,EAAE;YACvC,IAAA,oBAAU,EAAC,cAAM,OAAA,4BAAY,EAAZ,CAAY,EAAE,EAAE,OAAO,EAAE,CAAC,QAAQ,EAAE,aAAa,CAAC,EAAE,CAAC;YACtE,IAAA,mBAAS,EAAC;gBACR,IAAI,EAAE,uBAAuB;gBAC7B,UAAU,EAAE;oBACV,IAAI,EAAE,YAAY;oBAClB,oBAAoB,EAAE,IAAI;iBAC3B;gBACD,iBAAiB,EAAE;oBACjB,IAAI,EAAE,kBAAkB;oBACxB,oBAAoB,EAAE,IAAI;iBAC3B;aACF,CAAC;SACH,CAAC;;mDAC4B;IAG9B;QADC,IAAA,sBAAY,GAAE;;;;+CAQd;IA1IU,OAAO;QADnB,IAAA,gBAAM,GAAE;OACI,OAAO,CA2InB;IAAD,cAAC;CAAA,AA3ID,CAA6B,2CAAmB,GA2I/C;AA3IY,0BAAO;AA6IpB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoJG"}

package/dist/models/refund.d.ts

@@ -22,19 +22,26 @@ export declare class Refund extends BaseEntity {
  * title: "Refund"
  * description: "Refund represent an amount of money transfered back to the Customer for a given reason. Refunds may occur in relation to Returns, Swaps and Claims, but can also be initiated by a store operator."
  * x-resourceId: refund
+ * required:
+ *   - order_id
+ *   - amount
  * properties:
  *   id:
- *     description: "The id of the Refund. This value will be prefixed with `ref_`."
  *     type: string
+ *     description: The refund's ID
+ *     example: ref_01G1G5V27GYX4QXNARRQCW1N8T
  *   order_id:
  *     description: "The id of the Order that the Refund is related to."
  *     type: string
+ *     example: order_01G8TJSYT9M6AVS5N4EMNFS1EK
  *   amount:
  *     description: "The amount that has be refunded to the Customer."
  *     type: integer
+ *     example: 1000
  *   note:
  *     description: "An optional note explaining why the amount was refunded."
  *     type: string
+ *     example: I didn't like it
  *   reason:
  *     description: "The reason given for the Refund, will automatically be set when processed as part of a Swap, Claim or Return."
  *     type: string
@@ -44,15 +51,27 @@ export declare class Refund extends BaseEntity {
  *       - swap
  *       - claim
  *       - other
+ *     example: return
+ *   idempotency_key:
+ *     type: string
+ *     description: Randomly generated key used to continue the completion of the refund 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"}
  */