@bentonow/bento-node-sdk 0.1.14 → 0.2.1

package/dist/sdk/commands/types.d.ts

@@ -1,32 +1,32 @@
 /**
  * Command Method Parameter Types
  */
-export declare type AddTagParameters = {
+export type AddTagParameters = {
     email: string;
     tagName: string;
 };
-export declare type RemoveTagParameters = {
+export type RemoveTagParameters = {
     email: string;
     tagName: string;
 };
-export declare type AddFieldParameters<S> = {
+export type AddFieldParameters<S> = {
     email: string;
     field: {
         key: keyof S;
         value: unknown;
     };
 };
-export declare type RemoveFieldParameters<S> = {
+export type RemoveFieldParameters<S> = {
     email: string;
     fieldName: keyof S;
 };
-export declare type SubscribeParameters = {
+export type SubscribeParameters = {
     email: string;
 };
-export declare type UnsubscribeParameters = {
+export type UnsubscribeParameters = {
     email: string;
 };
-export declare type ChangeEmailParameters = {
+export type ChangeEmailParameters = {
     oldEmail: string;
     newEmail: string;
 };

package/dist/sdk/experimental/types.d.ts

@@ -2,19 +2,19 @@ import type { LocationData } from '../types';
 /**
  * Experimental Method Parameter Types
  */
-export declare type ValidateEmailParameters = {
+export type ValidateEmailParameters = {
     email: string;
     ip?: string;
     name?: string;
     userAgent?: string;
 };
-export declare type GuessGenderParameters = {
+export type GuessGenderParameters = {
     name: string;
 };
-export declare type GeolocateParameters = {
+export type GeolocateParameters = {
     ip: string;
 };
-export declare type BlacklistParameters = {
+export type BlacklistParameters = {
     domain: string;
     ip?: never;
 } | {
@@ -24,15 +24,15 @@ export declare type BlacklistParameters = {
 /**
  * Experimental Method Response Types
  */
-export declare type ValidateEmailResponse = {
+export type ValidateEmailResponse = {
     valid: boolean;
 };
-export declare type GuessGenderResponse = {
+export type GuessGenderResponse = {
     confidence: number | null;
     gender: string | null;
 };
-export declare type GeolocateResponse = Partial<LocationData>;
-export declare type BlacklistResponse = {
+export type GeolocateResponse = Partial<LocationData>;
+export type BlacklistResponse = {
     description: string;
     query: string;
     results: {

package/dist/sdk/fields/types.d.ts

@@ -2,16 +2,16 @@ import type { BaseEntity } from '../types';
 /**
  * Field Method Parameter Types
  */
-export declare type CreateFieldParameters = {
+export type CreateFieldParameters = {
     key: string;
 };
 /**
  * Core Field Types
  */
-export declare type FieldAttributes = {
+export type FieldAttributes = {
     created_at: string;
     key: string;
     name: string;
     whitelisted: boolean | null;
 };
-export declare type Field = BaseEntity<FieldAttributes>;
+export type Field = BaseEntity<FieldAttributes>;

package/dist/sdk/forms/types.d.ts

@@ -2,7 +2,7 @@ import type { BaseEntity, BrowserData, IdentityData, LocationData, PageData } fr
 /**
  * Core Form Types
  */
-export declare type FormResponseData = {
+export type FormResponseData = {
     browser: BrowserData;
     date: string;
     details: {
@@ -21,8 +21,8 @@ export declare type FormResponseData = {
     visit: string;
     visitor: string;
 };
-export declare type FormResponseAttributes = {
+export type FormResponseAttributes = {
     data: FormResponseData;
     uuid: string;
 };
-export declare type FormResponse = BaseEntity<FormResponseAttributes>;
+export type FormResponse = BaseEntity<FormResponseAttributes>;

package/dist/sdk/subscribers/types.d.ts

@@ -2,24 +2,24 @@ import type { BaseEntity } from '../types';
 /**
  * Subscriber Method Parameter Types
  */
-export declare type GetSubscribersParameters = {
+export type GetSubscribersParameters = {
     email?: never;
     uuid: string;
 } | {
     email: string;
     uuid?: never;
 } | never;
-export declare type CreateSubscriberParameters = {
+export type CreateSubscriberParameters = {
     email: string;
 };
 /**
  * Core Subscriber Types
  */
-export declare type SubscriberAttributes<S> = {
+export type SubscriberAttributes<S> = {
     cached_tag_ids: string[];
     email: string;
     fields: S | null;
     unsubscribed_at: string | null;
     uuid: string;
 };
-export declare type Subscriber<S> = BaseEntity<SubscriberAttributes<S>>;
+export type Subscriber<S> = BaseEntity<SubscriberAttributes<S>>;

package/dist/sdk/tags/types.d.ts

@@ -2,16 +2,16 @@ import type { BaseEntity } from '../types';
 /**
  * Tag Method Parameter Types
  */
-export declare type CreateTagParameters = {
+export type CreateTagParameters = {
     name: string;
 };
 /**
  * Core Tag Types
  */
-export declare type TagAttributes = {
+export type TagAttributes = {
     created_at: string;
     discarded_at: string | null;
     name: string | null;
     site_id: number;
 };
-export declare type Tag = BaseEntity<TagAttributes>;
+export type Tag = BaseEntity<TagAttributes>;

package/dist/sdk/types.d.ts

@@ -2,7 +2,7 @@
  * Core Types
  */
 import type { EntityType } from "./enums";
-export declare type BaseEntity<T> = {
+export type BaseEntity<T> = {
     attributes: T;
     id: string;
     type: EntityType;
@@ -10,15 +10,15 @@ export declare type BaseEntity<T> = {
 /**
  * Utility Types
  */
-export declare type BrowserData = {
+export type BrowserData = {
     height: string;
     user_agent: string;
     width: string;
 };
-export declare type IdentityData = {
+export type IdentityData = {
     email: string;
 };
-export declare type LocationData = {
+export type LocationData = {
     city_name: string;
     continent_code: string;
     country_code2: string;
@@ -32,7 +32,7 @@ export declare type LocationData = {
     region_name: string;
     request: string;
 };
-export declare type PageData = {
+export type PageData = {
     host: string;
     path: string;
     protocol: string;

package/dist/versions/v1/types.d.ts

@@ -2,30 +2,30 @@ import type { BaseEvent, PurchaseDetails } from '../../sdk/batch/events';
 /**
  * API Method Parameter Types
  */
-export declare type TagSubscriberParameters = {
+export type TagSubscriberParameters = {
     date?: Date;
     email: string;
     tagName: string;
 };
-export declare type AddSubscriberParameters<S> = {
+export type AddSubscriberParameters<S> = {
     date?: Date;
     email: string;
     fields?: Partial<S>;
 };
-export declare type RemoveSubscriberParameters = {
+export type RemoveSubscriberParameters = {
     date?: Date;
     email: string;
 };
-export declare type TrackPurchaseParameters = {
+export type TrackPurchaseParameters = {
     date?: Date;
     email: string;
     purchaseDetails: PurchaseDetails;
 };
-export declare type UpdateFieldsParameters<S> = {
+export type UpdateFieldsParameters<S> = {
     date?: Date;
     email: string;
     fields: Partial<S>;
 };
-export declare type TrackParameters<S, E extends string> = BaseEvent<E> & {
+export type TrackParameters<S, E extends string> = BaseEvent<E> & {
     fields: Partial<S>;
 };

package/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "0.1.14",
+  "version": "0.2.1",
   "license": "MIT",
   "main": "dist/index.js",
   "typings": "dist/index.d.ts",
@@ -25,12 +25,6 @@
       "pre-commit": "tsdx lint"
     }
   },
-  "prettier": {
-    "printWidth": 80,
-    "semi": true,
-    "singleQuote": true,
-    "trailingComma": "es5"
-  },
   "name": "@bentonow/bento-node-sdk",
   "author": "Backpack Internet",
   "module": "dist/bento-node-sdk.esm.js",
@@ -69,6 +63,6 @@
     "typescript": "^4.3.5"
   },
   "dependencies": {
-    "isomorphic-fetch": "^3.0.0"
+    "cross-fetch": "^4.0.0"
   }
-}
+}

package/src/sdk/batch/errors.ts

@@ -25,3 +25,17 @@ export class TooManyEventsError extends Error {
     this.name = 'TooManyEventsError';
   }
 }
+
+export class TooFewEmailsError extends Error {
+  constructor(message = 'Too few emails') {
+    super(message);
+    this.name = 'TooFewEmailsError';
+  }
+}
+
+export class TooManyEmailsError extends Error {
+  constructor(message = 'Too many emails') {
+    super(message);
+    this.name = 'TooManyEmailsError';
+  }
+}

package/src/sdk/batch/index.ts

@@ -1,11 +1,15 @@
 import type { BentoClient } from '../client';
 import {
+  TooFewEmailsError,
   TooFewEventsError,
   TooFewSubscribersError,
+  TooManyEmailsError,
   TooManyEventsError,
   TooManySubscribersError,
 } from './errors';
 import type {
+  BatchSendTransactionalEmailsParameter,
+  BatchsendTransactionalEmailsResponse,
   BatchImportEventsParameter,
   BatchImportEventsResponse,
   BatchImportSubscribersParameter,
@@ -13,6 +17,7 @@ import type {
 } from './types';
 
 export class BentoBatch<S, E extends string> {
+  private readonly _maxEmailBatchSize = 100;
   private readonly _maxBatchSize = 1000;
   private readonly _url = '/batch';
 
@@ -92,4 +97,40 @@ export class BentoBatch<S, E extends string> {
 
     return result.results;
   }
+
+  /**
+   * 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\>
+   */
+  public async sendTransactionalEmails(
+    parameters: BatchSendTransactionalEmailsParameter
+  ): Promise<number> {
+    if (parameters.emails.length === 0) {
+      throw new TooFewEmailsError(`You must send between 1 and 100 emails.`);
+    }
+
+    if (parameters.emails.length > this._maxEmailBatchSize) {
+      throw new TooManyEmailsError(`You must send between 1 and 100 emails.`);
+    }
+
+    const result =
+      await this._client.post<BatchsendTransactionalEmailsResponse>(
+        `${this._url}/emails`,
+        {
+          emails: parameters.emails,
+        }
+      );
+
+    return result.results;
+  }
 }

package/src/sdk/batch/types.ts

@@ -13,6 +13,21 @@ export type BatchImportEventsParameter<S, E extends string> = {
   events: BentoEvent<S, E>[];
 };
 
+export type TransactionalEmail = {
+  to: string;
+  from: string;
+  subject: string;
+  html_body: string;
+  transactional: boolean;
+  personalizations?: {
+    [key: string]: string | number | boolean;
+  };
+};
+
+export type BatchSendTransactionalEmailsParameter = {
+  emails: TransactionalEmail[];
+};
+
 /**
  * Batch Method Response Types
  */
@@ -23,3 +38,7 @@ export type BatchImportSubscribersResponse = {
 export type BatchImportEventsResponse = {
   results: number;
 };
+
+export type BatchsendTransactionalEmailsResponse = {
+  results: number;
+};

package/src/sdk/client/index.ts

@@ -1,4 +1,4 @@
-import fetch from 'isomorphic-fetch';
+import fetch from 'cross-fetch';
 import type { AnalyticsOptions, AuthenticationOptions } from '../interfaces';
 import { NotAuthorizedError, RateLimitedError } from './errors';
 
@@ -34,15 +34,15 @@ export class BentoClient {
         method: 'GET',
         headers: this._headers,
       })
-        .then(async (result) => {
+        .then(async result => {
           if (this._isSuccessfulStatus(result.status)) {
             return result.json();
           }
 
           throw await this._getErrorForResponse(result);
         })
-        .then((data) => resolve(data))
-        .catch((error) => reject(error));
+        .then(data => resolve(data))
+        .catch(error => reject(error));
     });
   }
 
@@ -69,15 +69,15 @@ export class BentoClient {
         },
         body,
       })
-        .then(async (result) => {
+        .then(async result => {
           if (this._isSuccessfulStatus(result.status)) {
             return result.json();
           }
 
           throw await this._getErrorForResponse(result);
         })
-        .then((data) => resolve(data))
-        .catch((error) => reject(error));
+        .then(data => resolve(data))
+        .catch(error => reject(error));
     });
   }