@bentonow/bento-node-sdk 0.1.14 → 0.2.0

package/README.md

@@ -271,8 +271,8 @@ bento.V1.track({
   email: 'test@bentonow.com',
   type: '$custom.event',
   fields: {
-        firstName: 'Custom Name',
-        lastName: 'Custom Name',
+    firstName: 'Custom Name',
+    lastName: 'Custom Name',
   },
   details: {
     fromCustomEvent: true,
@@ -286,7 +286,7 @@ bento.V1.track({
 
 ### `Batch.importSubscribers(parameters: BatchImportSubscribersParameter<S>): Promise<number>`
 
-**This does not trigger automations!** - If you wish to trigger automations, please batch import events with the type set to `BentoEvents.SUBSCRIBE`, or `$subscribe`. Note that the batch event import cannot attach custom fields and will ignore everything except the email.
+**This does not trigger automations!** - If you wish to trigger automations, please batch import events.
 
 Creates a batch job to import subscribers into the system. You can pass in between 1 and 1,000 subscribers to import. Each subscriber must have an email, and may optionally have any additional fields. The additional fields are added as custom fields on the subscriber.
 
@@ -305,6 +305,8 @@ bento.V1.Batch.importSubscribers({
     },
     {
       email: 'test2@bentonow.com',
+      some_custom_variable: 'tester-123',
+      primary_user: true,
     },
     {
       email: 'test3@bentonow.com',
@@ -320,7 +322,7 @@ bento.V1.Batch.importSubscribers({
 
 ### `Batch.importEvents(parameters: BatchImportEventsParameter<S, E>): Promise<number>`
 
-Creates a batch job to import events into the system. You can pass in between 1 and 1,000 events to import. Each event must have an email and a type. In addition to this, you my pass in additional data in the `details` property,
+Creates a batch job to import events into the system. You can pass in between 1 and 100 events to import. Each event must have an email and a type. In addition to this, you my pass in additional data in the `details` property,
 
 Returns the number of events that were imported.
 
@@ -364,6 +366,37 @@ bento.V1.Batch.importEvents({
   .catch(error => console.error(error));
 ```
 
+---
+
+### `Batch.sendTransactionalEmails(parameters: BatchsendTransactionalEmailsParameter<S, E>): Promise<number>`
+
+Creates a batch job to send transactional emails from Bento's infrastructure. You can pass in between 1 and 100 emails to send. Each email must have a `to` address, a `from` address, a `subject`, an `html_body` and `transactional: true`.
+
+In addition you can add a `personalizations` object to provide liquid tags that will be injected into the email.
+
+Requests are instant and queued into a priority queue. Most requests will be processed within 30 seconds. We currently limit this endpoint to 60 emails per minute.
+
+Returns the number of emails that were imported.
+
+```ts
+bento.V1.Batch.sendTransactionalEmails({
+  emails: [
+    {
+      to: 'test@bentonow.com', // required — if no user with this email exists in your account they will be created.
+      from: 'jesse@bentonow.com', // required — must be an email author in your account.
+      subject: 'Reset Password', // required
+      html_body: '<p>Here is a link to reset your password ... {{ link }}</p>', // required - can also use text_body if you want to use our plain text theme.
+      transactional: true, // IMPORTANT — this bypasses the subscription status of a user. Abuse will lead to account shutdown.
+      personalizations: {
+        link: 'https://example.com/test',
+      }, // optional — provide your own Liquid tags to be injected into the email.
+    },
+  ],
+})
+  .then(result => console.log(result))
+  .catch(error => console.error(error));
+```
+
 ## Commands
 
 ### `Commands.addTag(parameters: AddTagParameters): Promise<Subscriber<S> | null>`

package/dist/bento-node-sdk.cjs.development.js

@@ -979,10 +979,45 @@ var TooManyEventsError = /*#__PURE__*/function (_Error4) {
 
   return TooManyEventsError;
 }( /*#__PURE__*/_wrapNativeSuper(Error));
+var TooFewEmailsError = /*#__PURE__*/function (_Error5) {
+  _inheritsLoose(TooFewEmailsError, _Error5);
+
+  function TooFewEmailsError(message) {
+    var _this5;
+
+    if (message === void 0) {
+      message = 'Too few emails';
+    }
+
+    _this5 = _Error5.call(this, message) || this;
+    _this5.name = 'TooFewEmailsError';
+    return _this5;
+  }
+
+  return TooFewEmailsError;
+}( /*#__PURE__*/_wrapNativeSuper(Error));
+var TooManyEmailsError = /*#__PURE__*/function (_Error6) {
+  _inheritsLoose(TooManyEmailsError, _Error6);
+
+  function TooManyEmailsError(message) {
+    var _this6;
+
+    if (message === void 0) {
+      message = 'Too many emails';
+    }
+
+    _this6 = _Error6.call(this, message) || this;
+    _this6.name = 'TooManyEmailsError';
+    return _this6;
+  }
+
+  return TooManyEmailsError;
+}( /*#__PURE__*/_wrapNativeSuper(Error));
 
 var BentoBatch = /*#__PURE__*/function () {
   function BentoBatch(_client) {
     this._client = void 0;
+    this._maxEmailBatchSize = 100;
     this._maxBatchSize = 1000;
     this._url = '/batch';
     this._client = _client;
@@ -1117,6 +1152,70 @@ var BentoBatch = /*#__PURE__*/function () {
     }
 
     return importEvents;
+  }()
+  /**
+   * Creates a batch job to send transactional emails from Bento's infrastructure. You can pass in
+   * between 1 and 100 emails to send.
+   *
+   * Each email must have a `to` address, a `from` address, a `subject`, an `html_body`
+   * and `transactional: true`.
+   * In addition you can add a `personalizations` object to provide
+   * liquid tsags that will be injected into the email.
+   *
+   * Returns the number of events that were imported.
+   *
+   * @param parameters
+   * @returns Promise\<number\>
+   */
+  ;
+
+  _proto.sendTransactionalEmails =
+  /*#__PURE__*/
+  function () {
+    var _sendTransactionalEmails = /*#__PURE__*/_asyncToGenerator( /*#__PURE__*/runtime_1.mark(function _callee3(parameters) {
+      var result;
+      return runtime_1.wrap(function _callee3$(_context3) {
+        while (1) {
+          switch (_context3.prev = _context3.next) {
+            case 0:
+              if (!(parameters.emails.length === 0)) {
+                _context3.next = 2;
+                break;
+              }
+
+              throw new TooFewEmailsError("You must send between 1 and 100 emails.");
+
+            case 2:
+              if (!(parameters.emails.length > this._maxEmailBatchSize)) {
+                _context3.next = 4;
+                break;
+              }
+
+              throw new TooManyEmailsError("You must send between 1 and 100 emails.");
+
+            case 4:
+              _context3.next = 6;
+              return this._client.post(this._url + "/emails", {
+                emails: parameters.emails
+              });
+
+            case 6:
+              result = _context3.sent;
+              return _context3.abrupt("return", result.results);
+
+            case 8:
+            case "end":
+              return _context3.stop();
+          }
+        }
+      }, _callee3, this);
+    }));
+
+    function sendTransactionalEmails(_x3) {
+      return _sendTransactionalEmails.apply(this, arguments);
+    }
+
+    return sendTransactionalEmails;
   }();
 
   return BentoBatch;