@dhyasama/totem-models 9.59.0 → 9.61.0

package/lib/LimitedPartnerCommunication.js

@@ -2,15 +2,12 @@
 
 module.exports = function(mongoose, config) {
 
-  const
-
-    Schema = mongoose.Schema,
-    _ = require('underscore');
+  const Schema = mongoose.Schema;
 
   const LimitedPartnerCommunication = new Schema({
 
-    // name of the communication, e.g., "2022 Annual Audit"
-    name: { type: String, trim: true, required: true },
+    // name of the campaign, e.g., "2022 Annual Audit"
+    campaign: { type: String, trim: true, required: true },
 
     // customer sending this communication
     customer: { type: Schema.ObjectId, ref: 'Organization', required: true },
@@ -18,91 +15,101 @@ module.exports = function(mongoose, config) {
     // date and time to send
     sendOn: { type: Date, required: true },
 
-    // email subject
-    subject: { type: String, trim: true, required: true },
-
-    // email body
-    body: { type: String, trim: true, required: true },
-
-    // job was added to queue to send individual emails
-    sentToQueue: { type: Boolean, required: true, default: false },
+    // email content
+    email: {
 
-    documents: [{
+      // email subject
+      subject: { type: String, trim: true, required: true },
 
-      // the lp this doc is for
-      limitedPartner: { type: Schema.ObjectId, ref: 'LimitedPartner', required: true },
-
-      // unique id for this document
-      uuid: { type: String, trim: true, required: true },
+      // email body
+      body: { type: String, trim: true, required: true },
 
-      // email of recipient for notification and access
-      email: { type: String, trim: true, required: true },
+    },
 
-      // attach document to email
-      attachToEmail: { type: Boolean, required: true, default: false },
+    limitedPartners: [{
 
-      // when notification was sent
-      sentOn: { type: Date, required: false },
+      // the lp it's for
+      limitedPartner: { type: Schema.ObjectId, ref: 'LimitedPartner', required: true },
 
-      // email reference
-      postmarkMessageId: { type: String, trim: true, required: false },
+      // attach documents to email (only option currently supported)
+      attachToEmail: { type: Boolean, required: true, default: true },
 
-      emailStatus: { type: String, enum: [null, 'Sent', 'Bounced', 'Delivered', 'Opened', 'Clicked'], required: false },
+      // the documents included in this communication
+      documents: [{
 
-      // OTP used to access the document
-      oneTimePassword: { type: String, trim: true, required: true },
+        fileName: { type: String, trim: true, required: true },
 
-      // OTP only good for limited time and then a new one must be requested
-      oneTimePasswordExpiration: { type: Date, trim: true, required: true },
+        // file type
+        contentType: { type: String, trim: true, required: true },
 
-      fileName: { type: String, trim: true, required: true },
+        // file size
+        contentLength: { type: String, trim: true, required: true },
 
-      // file type
-      contentType: { 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 }
+        }
 
-      // 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 }
-      }
+      // emails of recipients
+      emails: [{ type: String, trim: true, required: true }],
+      
+      notifications: [{
+        sendTo: { type: String, trim: true },
+        sendOn: { type: Date, required: false },
+        sentOn: { type: Date, required: false },
+        sentToQueue: { type: Boolean, default: false },
+        postmarkMessageId: { type: String, trim: true },
+        status: { type: String, enum: [null, 'Sent', 'Bounced', 'Delivered', 'Opened', 'Clicked']}
+      }],
 
     }]
 
   });
 
-  // Get a full communication for a customer
-  // Use 1: Customer can use while setting up or viewing a batch
-  // Use 2: Also, use this to get doc when an lp requests it. Use comm id from url to get it here,
-  // then in BLL use the uuid from url to select the doc. At that point, we can serve up
-  // the doc or go through the OTP process.
-  LimitedPartnerCommunication.statics.getById = function getById(id, options, cb) {
+  // So we can put these on lp pages
+  LimitedPartnerCommunication.statics.getForLimitedPartner = function getForLimitedPartner(lpid, options, cb) {
 
     const self = this;
 
     if (!cb) { throw new Error('cb is required'); }
-    if (!id) { return cb(new Error('id is required'), null); }
-    if (!mongoose.Types.ObjectId.isValid(id)) { return cb(new Error('id is not a valid ObjectId'), null); }
+    if (!lpid) { return cb(new Error('lpid is required'), null); }
+    if (!mongoose.Types.ObjectId.isValid(lpid)) { return cb(new Error('lpid is not a valid ObjectId'), null); }
     if (!options) { return cb(new Error('options is required'), null); }
     if (!options.CUSTOMER_ID) { return cb(new Error('options.CUSTOMER_ID is required'), null); }
     if (!mongoose.Types.ObjectId.isValid(options.CUSTOMER_ID)) { return cb(new Error('options.CUSTOMER_ID is not a valid ObjectId'), null); }
 
-    let query = self.findOne({
-      '_id': id,
-      'customer': options.CUSTOMER_ID
+    let query = self.find({
+      limitedPartner: lpid,
+      customer: options.CUSTOMER_ID
     });
 
-    query.populate('customer');
-    query.populate('documents.limitedPartner', 'name');
+    query.exec(cb);
+
+  };
+
+  // Get all communications that haven't been sent but are scheduled to go
+  // Scheduled worker jobs will use this and add them to the queue to send
+  LimitedPartnerCommunication.statics.getReadyToSend = function getReadyToSend(options, cb) {
+
+    const self = this;
+    const now = new Date();
+
+    if (!cb) { throw new Error('cb is required'); }
+
+    let query = self.find({
+      sentToQueue: false,
+      sendOn: { $lte: now }
+    });
 
     query.exec(cb);
 
   };
 
-  // Get all communications for a customer
-  LimitedPartnerCommunication.statics.getForCustomer = function getForCustomer(customerId, options, cb) {
+  // For the "Historical" page
+  LimitedPartnerCommunication.statics.getSentForCustomer = function getSentForCustomer(customerId, options, cb) {
 
     const self = this;
 
@@ -111,25 +118,26 @@ module.exports = function(mongoose, config) {
     if (!mongoose.Types.ObjectId.isValid(customerId)) { return cb(new Error('customerId is not a valid ObjectId'), null); }
 
     let query = self.find({
-      'customer': customerId
+      customer: customerId,
+      sentOn: { $ne: null }
     });
 
     query.exec(cb);
 
   };
 
-  // Get all batches that haven't been sent but are scheduled to go
-  // Use case 1: Worker pulls this list and sends docs to lps
-  LimitedPartnerCommunication.statics.getReadyToSend = function getReadyToSend(options, cb) {
+  // For the "Scheduled" page
+  LimitedPartnerCommunication.statics.getUnsentForCustomer = function getUnsentForCustomer(customerId, options, cb) {
 
     const self = this;
-    const now = new Date();
 
     if (!cb) { throw new Error('cb is required'); }
+    if (!customerId) { return cb(new Error('customerId is required'), null); }
+    if (!mongoose.Types.ObjectId.isValid(customerId)) { return cb(new Error('customerId is not a valid ObjectId'), null); }
 
     let query = self.find({
-      'sentToQueue': false,
-      'sendOn': { $lte: now }
+      customer: customerId,
+      sentOn: null
     });
 
     query.exec(cb);

package/package.json

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