@bentonow/bento-node-sdk 0.1.13 → 0.2.0

package/README.md

@@ -270,6 +270,10 @@ Reference Types: [TrackParameters<S, E>](#trackparametersse)
 bento.V1.track({
   email: 'test@bentonow.com',
   type: '$custom.event',
+  fields: {
+    firstName: 'Custom Name',
+    lastName: 'Custom Name',
+  },
   details: {
     fromCustomEvent: true,
   },
@@ -282,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.
 
@@ -301,6 +305,8 @@ bento.V1.Batch.importSubscribers({
     },
     {
       email: 'test2@bentonow.com',
+      some_custom_variable: 'tester-123',
+      primary_user: true,
     },
     {
       email: 'test3@bentonow.com',
@@ -316,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.
 
@@ -360,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>`