@medusajs/medusa 1.3.3 → 1.3.6-next.0

package/dist/models/money-amount.d.ts

@@ -22,42 +22,71 @@ export declare class MoneyAmount extends SoftDeletableEntity {
  * title: "Money Amount"
  * description: "Money Amounts represents an amount that a given Product Variant can be purcased for. Each Money Amount either has a Currency or Region associated with it to indicate the pricing in a given Currency or, for fully region-based pricing, the given price in a specific Region. If region-based pricing is used the amount will be in the currency defined for the Reigon."
  * x-resourceId: money_amount
+ * required:
+ *   - currency_code
+ *   - amount
  * properties:
  *   id:
- *     description: "The id of the Money Amount. This value will be prefixed by `ma_`."
  *     type: string
+ *     description: The money amount's ID
+ *     example: ma_01F0YESHRFQNH5S8Q0PK84YYZN
  *   currency_code:
  *     description: "The 3 character currency code that the Money Amount is given in."
  *     type: string
+ *     example: usd
+ *     externalDocs:
+ *       url: https://en.wikipedia.org/wiki/ISO_4217#Active_codes
+ *       description: See a list of codes.
+ *   currency:
+ *     description: Available if the relation `currency` is expanded.
+ *     $ref: "#/components/schemas/currency"
  *   amount:
  *     description: "The amount in the smallest currecny unit (e.g. cents 100 cents to charge $1) that the Product Variant will cost."
  *     type: integer
+ *     example: 100
  *   min_quantity:
  *     description: "The minimum quantity that the Money Amount applies to. If this value is not set, the Money Amount applies to all quantities."
  *     type: integer
+ *     example: 1
  *   max_quantity:
  *     description: "The maximum quantity that the Money Amount applies to. If this value is not set, the Money Amount applies to all quantities."
  *     type: integer
+ *     example: 1
+ *   price_list_id:
+ *     type: string
+ *     description: The ID of the price list associated with the money amount
+ *     example: pl_01G8X3CKJXCG5VXVZ87H9KC09W
+ *   price_list:
+ *     description: Available if the relation `price_list` is expanded.
+ *     $ref: "#/components/schemas/price_list"
  *   variant_id:
- *     description: "The id of the Product Variant that the Money Amount belongs to."
+ *     description: "The id of the Product Variant contained in the Line Item."
  *     type: string
+ *     example: variant_01G1G5V2MRX2V3PVSR2WXYPFB6
+ *   variant:
+ *     description: The Product Variant contained in the Line Item. Available if the relation `variant` is expanded.
+ *     type: object
  *   region_id:
- *     description: "The id of the Region that the Money Amount is defined for."
  *     type: string
+ *     description: The region's ID
+ *     example: reg_01G1G5V26T9H8Y0M4JNE3YGA4G
  *   region:
- *     description: "The Region that the Money Amount is defined for."
- *     anyOf:
- *       - $ref: "#/components/schemas/region"
+ *     description: A region object. Available if the relation `region` 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:
+ *     type: object
+ *     description: An optional key-value map with additional details
+ *     example: {car: "white"}
  */

package/dist/models/money-amount.js

@@ -112,43 +112,72 @@ exports.MoneyAmount = MoneyAmount;
  * title: "Money Amount"
  * description: "Money Amounts represents an amount that a given Product Variant can be purcased for. Each Money Amount either has a Currency or Region associated with it to indicate the pricing in a given Currency or, for fully region-based pricing, the given price in a specific Region. If region-based pricing is used the amount will be in the currency defined for the Reigon."
  * x-resourceId: money_amount
+ * required:
+ *   - currency_code
+ *   - amount
  * properties:
  *   id:
- *     description: "The id of the Money Amount. This value will be prefixed by `ma_`."
  *     type: string
+ *     description: The money amount's ID
+ *     example: ma_01F0YESHRFQNH5S8Q0PK84YYZN
  *   currency_code:
  *     description: "The 3 character currency code that the Money Amount is given in."
  *     type: string
+ *     example: usd
+ *     externalDocs:
+ *       url: https://en.wikipedia.org/wiki/ISO_4217#Active_codes
+ *       description: See a list of codes.
+ *   currency:
+ *     description: Available if the relation `currency` is expanded.
+ *     $ref: "#/components/schemas/currency"
  *   amount:
  *     description: "The amount in the smallest currecny unit (e.g. cents 100 cents to charge $1) that the Product Variant will cost."
  *     type: integer
+ *     example: 100
  *   min_quantity:
  *     description: "The minimum quantity that the Money Amount applies to. If this value is not set, the Money Amount applies to all quantities."
  *     type: integer
+ *     example: 1
  *   max_quantity:
  *     description: "The maximum quantity that the Money Amount applies to. If this value is not set, the Money Amount applies to all quantities."
  *     type: integer
+ *     example: 1
+ *   price_list_id:
+ *     type: string
+ *     description: The ID of the price list associated with the money amount
+ *     example: pl_01G8X3CKJXCG5VXVZ87H9KC09W
+ *   price_list:
+ *     description: Available if the relation `price_list` is expanded.
+ *     $ref: "#/components/schemas/price_list"
  *   variant_id:
- *     description: "The id of the Product Variant that the Money Amount belongs to."
+ *     description: "The id of the Product Variant contained in the Line Item."
  *     type: string
+ *     example: variant_01G1G5V2MRX2V3PVSR2WXYPFB6
+ *   variant:
+ *     description: The Product Variant contained in the Line Item. Available if the relation `variant` is expanded.
+ *     type: object
  *   region_id:
- *     description: "The id of the Region that the Money Amount is defined for."
  *     type: string
+ *     description: The region's ID
+ *     example: reg_01G1G5V26T9H8Y0M4JNE3YGA4G
  *   region:
- *     description: "The Region that the Money Amount is defined for."
- *     anyOf:
- *       - $ref: "#/components/schemas/region"
+ *     description: A region object. Available if the relation `region` 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:
+ *     type: object
+ *     description: An optional key-value map with additional details
+ *     example: {car: "white"}
  */
 //# sourceMappingURL=money-amount.js.map

package/dist/models/money-amount.js.map

@@ -1 +1 @@
-{"version":3,"file":"money-amount.js","sourceRoot":"","sources":["../../src/models/money-amount.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,mCAOgB;AAChB,uCAAqC;AACrC,2CAAwC;AACxC,qDAAkD;AAClD,mCAAiC;AACjC,oFAAgF;AAChF,kEAA8D;AAG9D;IAAiC,+BAAmB;IAApD;;IAiDA,CAAC;IAHS,kCAAY,GAApB;QACE,IAAI,CAAC,EAAE,GAAG,IAAA,qCAAgB,EAAC,IAAI,CAAC,EAAE,EAAE,IAAI,CAAC,CAAA;IAC3C,CAAC;IA9CD;QADC,IAAA,gBAAM,GAAE;;sDACY;IAIrB;QAFC,IAAA,mBAAS,EAAC,cAAM,OAAA,mBAAQ,EAAR,CAAQ,CAAC;QACzB,IAAA,oBAAU,EAAC,EAAE,IAAI,EAAE,eAAe,EAAE,oBAAoB,EAAE,MAAM,EAAE,CAAC;kCAC1D,mBAAQ;iDAAA;IAGlB;QADC,IAAA,gBAAM,EAAC,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC;;+CACV;IAGd;QADC,IAAA,gBAAM,EAAC,EAAE,IAAI,EAAE,KAAK,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;qDACb;IAG3B;QADC,IAAA,gBAAM,EAAC,EAAE,IAAI,EAAE,KAAK,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;qDACb;IAG3B;QADC,IAAA,gBAAM,EAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;sDACC;IAO5B;QALC,IAAA,mBAAS,EAAC,cAAM,OAAA,sBAAS,EAAT,CAAS,EAAE,UAAC,SAAS,IAAK,OAAA,SAAS,CAAC,MAAM,EAAhB,CAAgB,EAAE;YAC3D,OAAO,EAAE,IAAI;YACb,QAAQ,EAAE,SAAS;SACpB,CAAC;QACD,IAAA,oBAAU,EAAC,EAAE,IAAI,EAAE,eAAe,EAAE,CAAC;;mDACV;IAI5B;QAFC,IAAA,eAAK,GAAE;QACP,IAAA,gBAAM,EAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;mDACT;IAMlB;QAJC,IAAA,mBAAS,EAAC,cAAM,OAAA,gCAAc,EAAd,CAAc,EAAE,UAAC,OAAO,IAAK,OAAA,OAAO,CAAC,MAAM,EAAd,CAAc,EAAE;YAC5D,QAAQ,EAAE,SAAS;SACpB,CAAC;QACD,IAAA,oBAAU,EAAC,EAAE,IAAI,EAAE,YAAY,EAAE,CAAC;kCAC1B,gCAAc;gDAAA;IAIvB;QAFC,IAAA,eAAK,GAAE;QACP,IAAA,gBAAM,EAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;kDACV;IAIjB;QAFC,IAAA,mBAAS,EAAC,cAAM,OAAA,eAAM,EAAN,CAAM,CAAC;QACvB,IAAA,oBAAU,EAAC,EAAE,IAAI,EAAE,WAAW,EAAE,CAAC;kCAC1B,eAAM;+CAAA;IAGd;QADC,IAAA,sBAAY,GAAE;;;;mDAGd;IAhDU,WAAW;QADvB,IAAA,gBAAM,GAAE;OACI,WAAW,CAiDvB;IAAD,kBAAC;CAAA,AAjDD,CAAiC,2CAAmB,GAiDnD;AAjDY,kCAAW;AAmDxB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2CG"}
+{"version":3,"file":"money-amount.js","sourceRoot":"","sources":["../../src/models/money-amount.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,mCAOgB;AAEhB,uCAAqC;AACrC,2CAAwC;AACxC,qDAAkD;AAClD,mCAAiC;AACjC,oFAAgF;AAChF,kEAA8D;AAG9D;IAAiC,+BAAmB;IAApD;;IAiDA,CAAC;IAHS,kCAAY,GAApB;QACE,IAAI,CAAC,EAAE,GAAG,IAAA,qCAAgB,EAAC,IAAI,CAAC,EAAE,EAAE,IAAI,CAAC,CAAA;IAC3C,CAAC;IA9CD;QADC,IAAA,gBAAM,GAAE;;sDACY;IAIrB;QAFC,IAAA,mBAAS,EAAC,cAAM,OAAA,mBAAQ,EAAR,CAAQ,CAAC;QACzB,IAAA,oBAAU,EAAC,EAAE,IAAI,EAAE,eAAe,EAAE,oBAAoB,EAAE,MAAM,EAAE,CAAC;kCAC1D,mBAAQ;iDAAA;IAGlB;QADC,IAAA,gBAAM,EAAC,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC;;+CACV;IAGd;QADC,IAAA,gBAAM,EAAC,EAAE,IAAI,EAAE,KAAK,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;qDACb;IAG3B;QADC,IAAA,gBAAM,EAAC,EAAE,IAAI,EAAE,KAAK,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;qDACb;IAG3B;QADC,IAAA,gBAAM,EAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;sDACC;IAO5B;QALC,IAAA,mBAAS,EAAC,cAAM,OAAA,sBAAS,EAAT,CAAS,EAAE,UAAC,SAAS,IAAK,OAAA,SAAS,CAAC,MAAM,EAAhB,CAAgB,EAAE;YAC3D,OAAO,EAAE,IAAI;YACb,QAAQ,EAAE,SAAS;SACpB,CAAC;QACD,IAAA,oBAAU,EAAC,EAAE,IAAI,EAAE,eAAe,EAAE,CAAC;;mDACV;IAI5B;QAFC,IAAA,eAAK,GAAE;QACP,IAAA,gBAAM,EAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;mDACT;IAMlB;QAJC,IAAA,mBAAS,EAAC,cAAM,OAAA,gCAAc,EAAd,CAAc,EAAE,UAAC,OAAO,IAAK,OAAA,OAAO,CAAC,MAAM,EAAd,CAAc,EAAE;YAC5D,QAAQ,EAAE,SAAS;SACpB,CAAC;QACD,IAAA,oBAAU,EAAC,EAAE,IAAI,EAAE,YAAY,EAAE,CAAC;kCAC1B,gCAAc;gDAAA;IAIvB;QAFC,IAAA,eAAK,GAAE;QACP,IAAA,gBAAM,EAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;kDACV;IAIjB;QAFC,IAAA,mBAAS,EAAC,cAAM,OAAA,eAAM,EAAN,CAAM,CAAC;QACvB,IAAA,oBAAU,EAAC,EAAE,IAAI,EAAE,WAAW,EAAE,CAAC;kCAC1B,eAAM;+CAAA;IAGd;QADC,IAAA,sBAAY,GAAE;;;;mDAGd;IAhDU,WAAW;QADvB,IAAA,gBAAM,GAAE;OACI,WAAW,CAiDvB;IAAD,kBAAC;CAAA,AAjDD,CAAiC,2CAAmB,GAiDnD;AAjDY,kCAAW;AAmDxB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAwEG"}

package/dist/models/note.d.ts

@@ -1,5 +1,5 @@
-import { User } from "./user";
 import { SoftDeletableEntity } from "../interfaces/models/soft-deletable-entity";
+import { User } from "./user";
 export declare class Note extends SoftDeletableEntity {
     value: string;
     resource_type: string;
@@ -14,36 +14,48 @@ export declare class Note extends SoftDeletableEntity {
  * title: "Note"
  * description: "Notes are elements which we can use in association with different resources to allow users to describe additional information in relation to these."
  * x-resourceId: note
+ * required:
+ *   - value
+ *   - resource_type
+ *   - resource_id
  * properties:
  *   id:
- *     description: "The id of the Note. This value will be prefixed by `note_`."
  *     type: string
+ *     description: The note's ID
+ *     example: note_01G8TM8ENBMC7R90XRR1G6H26Q
  *   resource_type:
  *     description: "The type of resource that the Note refers to."
  *     type: string
+ *     example: order
  *   resource_id:
- *     description: "The id of the resource that the Note refers to."
+ *     description: "The ID of the resource that the Note refers to."
  *     type: string
+ *     example: order_01G8TJSYT9M6AVS5N4EMNFS1EK
  *   value:
  *     description: "The contents of the note."
  *     type: string
+ *     example: This order must be fulfilled on Monday
+ *   author_id:
+ *     type: string
+ *     description: The ID of the author (user)
+ *     example: usr_01G1G5V26F5TB3GPAPNJ8X1S3V
  *   author:
- *     description: "The author of the note."
- *     anyOf:
- *       - $ref: "#/components/schemas/user"
+ *     description: Available if the relation `author` is expanded.
+ *     $ref: "#/components/schemas/user"
  *   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/note.js

@@ -26,9 +26,9 @@ var __metadata = (this && this.__metadata) || function (k, v) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Note = void 0;
 var typeorm_1 = require("typeorm");
-var user_1 = require("./user");
-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 user_1 = require("./user");
 var generate_entity_id_1 = require("../utils/generate-entity-id");
 var Note = /** @class */ (function (_super) {
     __extends(Note, _super);
@@ -82,37 +82,49 @@ exports.Note = Note;
  * title: "Note"
  * description: "Notes are elements which we can use in association with different resources to allow users to describe additional information in relation to these."
  * x-resourceId: note
+ * required:
+ *   - value
+ *   - resource_type
+ *   - resource_id
  * properties:
  *   id:
- *     description: "The id of the Note. This value will be prefixed by `note_`."
  *     type: string
+ *     description: The note's ID
+ *     example: note_01G8TM8ENBMC7R90XRR1G6H26Q
  *   resource_type:
  *     description: "The type of resource that the Note refers to."
  *     type: string
+ *     example: order
  *   resource_id:
- *     description: "The id of the resource that the Note refers to."
+ *     description: "The ID of the resource that the Note refers to."
  *     type: string
+ *     example: order_01G8TJSYT9M6AVS5N4EMNFS1EK
  *   value:
  *     description: "The contents of the note."
  *     type: string
+ *     example: This order must be fulfilled on Monday
+ *   author_id:
+ *     type: string
+ *     description: The ID of the author (user)
+ *     example: usr_01G1G5V26F5TB3GPAPNJ8X1S3V
  *   author:
- *     description: "The author of the note."
- *     anyOf:
- *       - $ref: "#/components/schemas/user"
+ *     description: Available if the relation `author` is expanded.
+ *     $ref: "#/components/schemas/user"
  *   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=note.js.map

package/dist/models/note.js.map

@@ -1 +1 @@
-{"version":3,"file":"note.js","sourceRoot":"","sources":["../../src/models/note.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,mCAOgB;AAChB,+BAA6B;AAC7B,oFAAgF;AAChF,4DAAwD;AACxD,kEAA8D;AAG9D;IAA0B,wBAAmB;IAA7C;;IA0BA,CAAC;IAHS,2BAAY,GAApB;QACE,IAAI,CAAC,EAAE,GAAG,IAAA,qCAAgB,EAAC,IAAI,CAAC,EAAE,EAAE,MAAM,CAAC,CAAA;IAC7C,CAAC;IAvBD;QADC,IAAA,gBAAM,GAAE;;uCACI;IAIb;QAFC,IAAA,eAAK,GAAE;QACP,IAAA,gBAAM,GAAE;;+CACY;IAIrB;QAFC,IAAA,eAAK,GAAE;QACP,IAAA,gBAAM,GAAE;;6CACU;IAGnB;QADC,IAAA,gBAAM,EAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;2CACV;IAIjB;QAFC,IAAA,mBAAS,EAAC,cAAM,OAAA,WAAI,EAAJ,CAAI,CAAC;QACrB,IAAA,oBAAU,EAAC,EAAE,IAAI,EAAE,WAAW,EAAE,CAAC;kCAC1B,WAAI;wCAAA;IAGZ;QADC,IAAA,+BAAa,EAAC,EAAE,IAAI,EAAE,OAAO,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;0CAChB;IAGjC;QADC,IAAA,sBAAY,GAAE;;;;4CAGd;IAzBU,IAAI;QADhB,IAAA,gBAAM,GAAE;OACI,IAAI,CA0BhB;IAAD,WAAC;CAAA,AA1BD,CAA0B,2CAAmB,GA0B5C;AA1BY,oBAAI;AA4BjB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAqCG"}
+{"version":3,"file":"note.js","sourceRoot":"","sources":["../../src/models/note.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,mCAOgB;AAEhB,4DAAwD;AACxD,oFAAgF;AAChF,+BAA6B;AAC7B,kEAA8D;AAG9D;IAA0B,wBAAmB;IAA7C;;IA0BA,CAAC;IAHS,2BAAY,GAApB;QACE,IAAI,CAAC,EAAE,GAAG,IAAA,qCAAgB,EAAC,IAAI,CAAC,EAAE,EAAE,MAAM,CAAC,CAAA;IAC7C,CAAC;IAvBD;QADC,IAAA,gBAAM,GAAE;;uCACI;IAIb;QAFC,IAAA,eAAK,GAAE;QACP,IAAA,gBAAM,GAAE;;+CACY;IAIrB;QAFC,IAAA,eAAK,GAAE;QACP,IAAA,gBAAM,GAAE;;6CACU;IAGnB;QADC,IAAA,gBAAM,EAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;2CACV;IAIjB;QAFC,IAAA,mBAAS,EAAC,cAAM,OAAA,WAAI,EAAJ,CAAI,CAAC;QACrB,IAAA,oBAAU,EAAC,EAAE,IAAI,EAAE,WAAW,EAAE,CAAC;kCAC1B,WAAI;wCAAA;IAGZ;QADC,IAAA,+BAAa,EAAC,EAAE,IAAI,EAAE,OAAO,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;0CAChB;IAGjC;QADC,IAAA,sBAAY,GAAE;;;;4CAGd;IAzBU,IAAI;QADhB,IAAA,gBAAM,GAAE;OACI,IAAI,CA0BhB;IAAD,WAAC;CAAA,AA1BD,CAA0B,2CAAmB,GA0B5C;AA1BY,oBAAI;AA4BjB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiDG"}

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

@@ -7,11 +7,15 @@ export declare class NotificationProvider {
  * title: "Notification Provider"
  * description: "Represents a notification provider plugin and holds its installation status."
  * x-resourceId: notification_provider
+ * required:
+ *   - id
  * properties:
  *   id:
  *     description: "The id of the notification provider as given by the plugin."
  *     type: string
+ *     example: sendgrid
  *   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
+ *     default: true
  */

package/dist/models/notification-provider.js

@@ -33,12 +33,16 @@ exports.NotificationProvider = NotificationProvider;
  * title: "Notification Provider"
  * description: "Represents a notification provider plugin and holds its installation status."
  * x-resourceId: notification_provider
+ * required:
+ *   - id
  * properties:
  *   id:
  *     description: "The id of the notification provider as given by the plugin."
  *     type: string
+ *     example: sendgrid
  *   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
+ *     default: true
  */
 //# sourceMappingURL=notification-provider.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"notification-provider.js","sourceRoot":"","sources":["../../src/models/notification-provider.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,mCAAuD;AAGvD;IAAA;IAMA,CAAC;IAJC;QADC,IAAA,uBAAa,GAAE;;oDACN;IAGV;QADC,IAAA,gBAAM,EAAC,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC;;8DACL;IALV,oBAAoB;QADhC,IAAA,gBAAM,GAAE;OACI,oBAAoB,CAMhC;IAAD,2BAAC;CAAA,AAND,IAMC;AANY,oDAAoB;AAQjC;;;;;;;;;;;;GAYG"}
+{"version":3,"file":"notification-provider.js","sourceRoot":"","sources":["../../src/models/notification-provider.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,mCAAuD;AAGvD;IAAA;IAMA,CAAC;IAJC;QADC,IAAA,uBAAa,GAAE;;oDACN;IAGV;QADC,IAAA,gBAAM,EAAC,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC;;8DACL;IALV,oBAAoB;QADhC,IAAA,gBAAM,GAAE;OACI,oBAAoB,CAMhC;IAAD,2BAAC;CAAA,AAND,IAMC;AANY,oDAAoB;AAQjC;;;;;;;;;;;;;;;;GAgBG"}

package/dist/models/notification.d.ts

@@ -5,7 +5,7 @@ export declare class Notification extends BaseEntity {
     event_name: string;
     resource_type: string;
     resource_id: string;
-    customer_id: string;
+    customer_id: string | null;
     customer: Customer;
     to: string;
     data: Record<string, unknown>;
@@ -21,35 +21,42 @@ export declare class Notification extends BaseEntity {
  * title: "Notification"
  * description: "Notifications a communications sent via Notification Providers as a reaction to internal events such as `order.placed`. Notifications can be used to show a chronological timeline for communications sent to a Customer regarding an Order, and enables resends."
  * x-resourceId: notification
+ * required:
+ *   - resource_type
+ *   - resource_id
+ *   - to
  * properties:
  *   id:
- *     description: "The id of the Notification. This value will be prefixed by `noti_`."
  *     type: string
+ *     description: The notification's ID
+ *     example: noti_01G53V9Y6CKMCGBM1P0X7C28RX
  *   event_name:
  *     description: "The name of the event that the notification was sent for."
  *     type: string
+ *     example: order.placed
  *   resource_type:
  *     description: "The type of resource that the Notification refers to."
  *     type: string
+ *     example: order
  *   resource_id:
- *     description: "The id of the resource that the Notification refers to."
+ *     description: "The ID of the resource that the Notification refers to."
  *     type: string
+ *     example: order_01G8TJSYT9M6AVS5N4EMNFS1EK
  *   customer_id:
- *     description: "The id of the Customer that the Notification was sent to."
+ *     description: "The ID of the Customer that the Notification was sent to."
  *     type: string
+ *     example: cus_01G2SG30J8C85S4A5CHM2S1NS2
  *   customer:
- *     description: "The Customer that the Notification was sent to."
- *     anyOf:
- *       - $ref: "#/components/schemas/customer"
+ *     description: A customer object. Available if the relation `customer` is expanded.
+ *     type: object
  *   to:
  *     description: "The address that the Notification was sent to. This will usually be an email address, but represent other addresses such as a chat bot user id"
  *     type: string
+ *     example: "user@example.com"
  *   data:
  *     description: "The data that the Notification was sent with. This contains all the data necessary for the Notification Provider to initiate a resend."
  *     type: object
- *   parent_id:
- *     description: "The id of the Notification that was originally sent."
- *     type: string
+ *     example: {}
  *   resends:
  *     description: "The resends that have been completed after the original Notification."
  *     type: array
@@ -58,13 +65,17 @@ export declare class Notification extends BaseEntity {
  *   provider_id:
  *     description: "The id of the Notification Provider that handles the Notification."
  *     type: string
+ *     example: sengrid
+ *   provider:
+ *     description: Available if the relation `provider` is expanded.
+ *     $ref: "#/components/schemas/notification_provider"
  *   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
  */
 /**
@@ -74,35 +85,56 @@ export declare class Notification extends BaseEntity {
  * x-resourceId: notification_resend
  * properties:
  *   id:
- *     description: "The id of the Notification. This value will be prefixed by `noti_`."
+ *     description: The notification resend's ID
  *     type: string
+ *     example: noti_01F0YET45G9NHP08Z66CE4QKBS
  *   event_name:
  *     description: "The name of the event that the notification was sent for."
  *     type: string
+ *     example: order.placed
  *   resource_type:
  *     description: "The type of resource that the Notification refers to."
  *     type: string
+ *     example: order
  *   resource_id:
- *     description: "The id of the resource that the Notification refers to."
+ *     description: "The ID of the resource that the Notification refers to."
+ *     type: string
+ *     example: order_01G8TJSYT9M6AVS5N4EMNFS1EK
+ *   customer_id:
+ *     description: "The ID of the Customer that the Notification was sent to."
  *     type: string
+ *     example: cus_01G2SG30J8C85S4A5CHM2S1NS2
+ *   customer:
+ *     description: A customer object. Available if the relation `customer` is expanded.
+ *     type: object
  *   to:
  *     description: "The address that the Notification was sent to. This will usually be an email address, but represent other addresses such as a chat bot user id"
  *     type: string
+ *     example: "user@example.com"
  *   data:
  *     description: "The data that the Notification was sent with. This contains all the data necessary for the Notification Provider to initiate a resend."
  *     type: object
+ *     example: {}
  *   parent_id:
- *     description: "The id of the Notification that was originally sent."
+ *     description: "The ID of the Notification that was originally sent."
  *     type: string
+ *     example: noti_01G53V9Y6CKMCGBM1P0X7C28RX
+ *   parent_notification:
+ *     description: Available if the relation `parent_notification` is expanded.
+ *     $ref: "#/components/schemas/notification"
  *   provider_id:
- *     description: "The id of the Notification Provider that handles the Notification."
+ *     description: "The ID of the Notification Provider that handles the Notification."
  *     type: string
+ *     example: sengrid
+ *   provider:
+ *     description: Available if the relation `provider` is expanded.
+ *     $ref: "#/components/schemas/notification_provider"
  *   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
  */

package/dist/models/notification.js

@@ -27,8 +27,8 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.Notification = 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 customer_1 = require("./customer");
+var db_aware_column_1 = require("../utils/db-aware-column");
 var notification_provider_1 = require("./notification-provider");
 var generate_entity_id_1 = require("../utils/generate-entity-id");
 var Notification = /** @class */ (function (_super) {
@@ -58,7 +58,7 @@ var Notification = /** @class */ (function (_super) {
     __decorate([
         (0, typeorm_1.Index)(),
         (0, typeorm_1.Column)({ nullable: true }),
-        __metadata("design:type", String)
+        __metadata("design:type", Object)
     ], Notification.prototype, "customer_id", void 0);
     __decorate([
         (0, typeorm_1.ManyToOne)(function () { return customer_1.Customer; }),
@@ -112,35 +112,42 @@ exports.Notification = Notification;
  * title: "Notification"
  * description: "Notifications a communications sent via Notification Providers as a reaction to internal events such as `order.placed`. Notifications can be used to show a chronological timeline for communications sent to a Customer regarding an Order, and enables resends."
  * x-resourceId: notification
+ * required:
+ *   - resource_type
+ *   - resource_id
+ *   - to
  * properties:
  *   id:
- *     description: "The id of the Notification. This value will be prefixed by `noti_`."
  *     type: string
+ *     description: The notification's ID
+ *     example: noti_01G53V9Y6CKMCGBM1P0X7C28RX
  *   event_name:
  *     description: "The name of the event that the notification was sent for."
  *     type: string
+ *     example: order.placed
  *   resource_type:
  *     description: "The type of resource that the Notification refers to."
  *     type: string
+ *     example: order
  *   resource_id:
- *     description: "The id of the resource that the Notification refers to."
+ *     description: "The ID of the resource that the Notification refers to."
  *     type: string
+ *     example: order_01G8TJSYT9M6AVS5N4EMNFS1EK
  *   customer_id:
- *     description: "The id of the Customer that the Notification was sent to."
+ *     description: "The ID of the Customer that the Notification was sent to."
  *     type: string
+ *     example: cus_01G2SG30J8C85S4A5CHM2S1NS2
  *   customer:
- *     description: "The Customer that the Notification was sent to."
- *     anyOf:
- *       - $ref: "#/components/schemas/customer"
+ *     description: A customer object. Available if the relation `customer` is expanded.
+ *     type: object
  *   to:
  *     description: "The address that the Notification was sent to. This will usually be an email address, but represent other addresses such as a chat bot user id"
  *     type: string
+ *     example: "user@example.com"
  *   data:
  *     description: "The data that the Notification was sent with. This contains all the data necessary for the Notification Provider to initiate a resend."
  *     type: object
- *   parent_id:
- *     description: "The id of the Notification that was originally sent."
- *     type: string
+ *     example: {}
  *   resends:
  *     description: "The resends that have been completed after the original Notification."
  *     type: array
@@ -149,13 +156,17 @@ exports.Notification = Notification;
  *   provider_id:
  *     description: "The id of the Notification Provider that handles the Notification."
  *     type: string
+ *     example: sengrid
+ *   provider:
+ *     description: Available if the relation `provider` is expanded.
+ *     $ref: "#/components/schemas/notification_provider"
  *   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
  */
 /**
@@ -165,36 +176,57 @@ exports.Notification = Notification;
  * x-resourceId: notification_resend
  * properties:
  *   id:
- *     description: "The id of the Notification. This value will be prefixed by `noti_`."
+ *     description: The notification resend's ID
  *     type: string
+ *     example: noti_01F0YET45G9NHP08Z66CE4QKBS
  *   event_name:
  *     description: "The name of the event that the notification was sent for."
  *     type: string
+ *     example: order.placed
  *   resource_type:
  *     description: "The type of resource that the Notification refers to."
  *     type: string
+ *     example: order
  *   resource_id:
- *     description: "The id of the resource that the Notification refers to."
+ *     description: "The ID of the resource that the Notification refers to."
+ *     type: string
+ *     example: order_01G8TJSYT9M6AVS5N4EMNFS1EK
+ *   customer_id:
+ *     description: "The ID of the Customer that the Notification was sent to."
  *     type: string
+ *     example: cus_01G2SG30J8C85S4A5CHM2S1NS2
+ *   customer:
+ *     description: A customer object. Available if the relation `customer` is expanded.
+ *     type: object
  *   to:
  *     description: "The address that the Notification was sent to. This will usually be an email address, but represent other addresses such as a chat bot user id"
  *     type: string
+ *     example: "user@example.com"
  *   data:
  *     description: "The data that the Notification was sent with. This contains all the data necessary for the Notification Provider to initiate a resend."
  *     type: object
+ *     example: {}
  *   parent_id:
- *     description: "The id of the Notification that was originally sent."
+ *     description: "The ID of the Notification that was originally sent."
  *     type: string
+ *     example: noti_01G53V9Y6CKMCGBM1P0X7C28RX
+ *   parent_notification:
+ *     description: Available if the relation `parent_notification` is expanded.
+ *     $ref: "#/components/schemas/notification"
  *   provider_id:
- *     description: "The id of the Notification Provider that handles the Notification."
+ *     description: "The ID of the Notification Provider that handles the Notification."
  *     type: string
+ *     example: sengrid
+ *   provider:
+ *     description: Available if the relation `provider` is expanded.
+ *     $ref: "#/components/schemas/notification_provider"
  *   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
  */
 //# sourceMappingURL=notification.js.map