@dhyasama/totem-models 9.77.0 → 9.79.0

package/index.js

@@ -59,6 +59,7 @@ var bootstrap = function(mongoose, config) {
   require('./lib/LimitedPartnerCampaign.js')(mongoose, config);
   require('./lib/LimitedPartnerContactGroup.js')(mongoose, config);
   require('./lib/LimitedPartnerCommunication.js')(mongoose, config);
+  require('./lib/LimitedPartnerReportGenerator.js')(mongoose, config);
   require('./lib/Message.js')(mongoose, config);
   require('./lib/MessageRecipient.js')(mongoose, config);
   require('./lib/News.js')(mongoose, config);

package/lib/LimitedPartnerCampaign.js

@@ -23,6 +23,9 @@ module.exports = function(mongoose, config) {
     // email body
     body: { type: String, trim: true, required: true },
 
+    // whether the campaign is partially completed
+    draft: { type: Boolean, required: true, default: false },
+
     // sent all emails to queue
     sentEmailsToQueue: { type: Boolean, required: true, default: false },
 
@@ -48,7 +51,7 @@ module.exports = function(mongoose, config) {
   };
 
   // Scheduled but not sent
-  LimitedPartnerCampaign.statics.getScheduled = function getScheduled(customerId, options, cb) {
+  LimitedPartnerCampaign.statics.getUpcoming = function getUpcoming(customerId, options, cb) {
 
     const self = this;
     const now = new Date();

package/lib/LimitedPartnerReportGenerator.js

@@ -0,0 +1,85 @@
+'use strict';
+
+const _ = require('underscore');
+
+module.exports = function(mongoose, config) {
+
+  const Schema = mongoose.Schema;
+
+  const LimitedPartnerReportGenerator = new Schema({
+
+    // the campaign id
+    campaign: { type: Schema.ObjectId, ref: 'LimitedPartnerCampaign', required: true },
+
+    // the fund the files are associated to
+    fund: { type: Schema.ObjectId, ref: 'Fund', required: true },
+
+    // the year the files are associated to
+    year: { type: String, trim: true, required: true },
+
+    // the period the files are associated to
+    period: { type: String, trim: true, required: true },
+
+    // the documents included in this communication
+    documents: [{
+
+      // the lp id
+      limitedPartner: { type: Schema.ObjectId, ref: 'LimitedPartner', required: true },
+
+      // the file name
+      fileName: { type: String, trim: true, required: true },
+
+      // file contents, base64 encoded for postmark
+      content: { type: String, trim: true, required: false },
+
+      // file type
+      contentType: { type: String, trim: true, required: true },
+
+      // file size
+      contentLength: { type: String, trim: true, required: true },
+
+      // where to find in s3
+      s3: {
+        bucket: { type: String, required: true, trim: true },
+        key: { type: String, required: true, trim: true }
+      }
+
+    }],
+
+    // the date the request was started
+    requestedOn: { type: Date, required: true },
+
+    // the date the request was completed
+    completedOn: { type: Date }
+
+  });
+
+  LimitedPartnerReportGenerator.statics.getByCampaign = function (campaignId, options, cb) {
+
+    const self = this;
+
+    if (!cb) { throw new Error('cb is required'); }
+    if (!campaignId) { return cb(new Error('campaignId is required'), null); }
+    if (!mongoose.Types.ObjectId.isValid(campaignId)) { return cb(new Error('campaignId is not a valid ObjectId'), null); }
+
+    self.findOne({
+      'campaign': campaignId
+    }).exec(cb);
+
+  };
+
+  LimitedPartnerReportGenerator.statics.upsert = function upsert(doc, options, cb) {
+
+    if (!doc) { return cb(new Error('doc is required'), null); }
+
+    doc.save(cb);
+
+  };
+
+  LimitedPartnerReportGenerator.set('usePushEach', true);
+  LimitedPartnerReportGenerator.set('autoIndex', false);
+  LimitedPartnerReportGenerator.set('usePushEach', true);
+
+  mongoose.model('LimitedPartnerReportGenerator', LimitedPartnerReportGenerator);
+
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dhyasama/totem-models",
-  "version": "9.77.0",
+  "version": "9.79.0",
   "author": "Jason Reynolds",
   "license": "UNLICENSED",
   "description": "Models for Totem platform",