diff --git a/ghost/offers/lib/OfferRepository.js b/ghost/offers/lib/OfferRepository.js index ef1d4583a7..ad91f780fb 100644 --- a/ghost/offers/lib/OfferRepository.js +++ b/ghost/offers/lib/OfferRepository.js @@ -9,7 +9,7 @@ const Offer = require('./domain/models/Offer'); /** * @param {any} json - * @returns {Offer.OfferProps} + * @returns {Offer.OfferCreateProps} */ function toDomain(json) { return { diff --git a/ghost/offers/lib/domain/models/Offer.js b/ghost/offers/lib/domain/models/Offer.js index 8c956bcd1e..63595bf1f9 100644 --- a/ghost/offers/lib/domain/models/Offer.js +++ b/ghost/offers/lib/domain/models/Offer.js @@ -27,6 +27,22 @@ const OfferCurrency = require('./OfferCurrency'); * @prop {OfferTier} tier */ +/** + * @typedef {object} OfferCreateProps + * @prop {string} id + * @prop {string} name + * @prop {string} code + * @prop {string} display_title + * @prop {string} display_description + * @prop {string} cadence + * @prop {string} type + * @prop {number} amount + * @prop {string} duration + * @prop {string} currency + * @prop {string} [stripe_coupon_id] + * @prop {TierProps|OfferTier} tier + */ + /** * @typedef {object} UniqueChecker * @prop {(code: OfferCode) => Promise} isUniqueCode