@bentonow/bento-node-sdk 0.1.13 → 0.2.0

package/dist/sdk/batch/index.d.ts

@@ -1,7 +1,8 @@
-import { BatchImportEventsParameter, BatchImportSubscribersParameter } from './types';
-import { BentoClient } from '../client';
-export declare class BentoBatch<S, E> {
+import type { BentoClient } from '../client';
+import type { BatchSendTransactionalEmailsParameter, BatchImportEventsParameter, BatchImportSubscribersParameter } from './types';
+export declare class BentoBatch<S, E extends string> {
     private readonly _client;
+    private readonly _maxEmailBatchSize;
     private readonly _maxBatchSize;
     private readonly _url;
     constructor(_client: BentoClient);
@@ -36,4 +37,19 @@ export declare class BentoBatch<S, E> {
      * @returns Promise\<number\>
      */
     importEvents(parameters: BatchImportEventsParameter<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 tsags that will be injected into the email.
+     *
+     * Returns the number of events that were imported.
+     *
+     * @param parameters
+     * @returns Promise\<number\>
+     */
+    sendTransactionalEmails(parameters: BatchSendTransactionalEmailsParameter): Promise<number>;
 }

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

@@ -0,0 +1,37 @@
+import type { BentoEvent } from './events';
+/**
+ * Batch Method Parameter Types
+ */
+export declare type BatchImportSubscribersParameter<S> = {
+    subscribers: ({
+        email: string;
+    } & Partial<S>)[];
+};
+export declare type BatchImportEventsParameter<S, E extends string> = {
+    events: BentoEvent<S, E>[];
+};
+export declare type TransactionalEmail = {
+    to: string;
+    from: string;
+    subject: string;
+    html_body: string;
+    transactional: boolean;
+    personalizations?: {
+        [key: string]: string | number | boolean;
+    };
+};
+export declare type BatchSendTransactionalEmailsParameter = {
+    emails: TransactionalEmail[];
+};
+/**
+ * Batch Method Response Types
+ */
+export declare type BatchImportSubscribersResponse = {
+    results: number;
+};
+export declare type BatchImportEventsResponse = {
+    results: number;
+};
+export declare type BatchsendTransactionalEmailsResponse = {
+    results: number;
+};

package/dist/sdk/client/errors.d.ts

@@ -1,4 +1,6 @@
 export declare class NotAuthorizedError extends Error {
+    constructor(message?: string);
 }
 export declare class RateLimitedError extends Error {
+    constructor(message?: string);
 }

package/dist/sdk/client/index.d.ts

@@ -1,4 +1,4 @@
-import { AnalyticsOptions } from '../interfaces';
+import type { AnalyticsOptions } from '../interfaces';
 export declare class BentoClient {
     private readonly _headers;
     private readonly _baseUrl;
@@ -13,7 +13,7 @@ export declare class BentoClient {
      * @param payload object
      * @returns Promise\<T\>
      * */
-    get<T>(endpoint: string, payload?: object): Promise<T>;
+    get<T>(endpoint: string, payload?: Record<string, unknown>): Promise<T>;
     /**
      * Wraps a POST request to the Bento API and automatically adds the required
      * headers.
@@ -22,7 +22,7 @@ export declare class BentoClient {
      * @param payload object
      * @returns Promise\<T\>
      * */
-    post<T>(endpoint: string, payload?: object): Promise<T>;
+    post<T>(endpoint: string, payload?: Record<string, unknown>): Promise<T>;
     /**
      * Extracts the `publishableKey` and `secretKey` from the `authentication` options and
      * adds the `Authorization` header.

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

@@ -0,0 +1,3 @@
+export declare type DataResponse<T> = {
+    data: T;
+};

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

@@ -1,6 +1,6 @@
-import { BentoClient } from '../client';
-import { Subscriber } from '../subscribers/types';
-import { AddFieldParameters, AddTagParameters, ChangeEmailParameters, RemoveFieldParameters, RemoveTagParameters, SubscribeParameters, UnsubscribeParameters } from './types';
+import type { BentoClient } from '../client';
+import type { Subscriber } from '../subscribers/types';
+import type { AddFieldParameters, AddTagParameters, ChangeEmailParameters, RemoveFieldParameters, RemoveTagParameters, SubscribeParameters, UnsubscribeParameters } from './types';
 export declare class BentoCommands<S> {
     private readonly _client;
     private readonly _url;

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

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

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

@@ -1,6 +1,6 @@
-import { BlacklistParameters, BlacklistResponse, GeolocateParameters, GuessGenderParameters, GuessGenderResponse, ValidateEmailParameters } from './types';
-import { BentoClient } from '../client';
-import { LocationData } from '../types';
+import type { BentoClient } from '../client';
+import type { LocationData } from '../types';
+import type { BlacklistParameters, BlacklistResponse, GeolocateParameters, GuessGenderParameters, GuessGenderResponse, ValidateEmailParameters } from './types';
 export declare class BentoExperimental {
     private readonly _client;
     private readonly _url;

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

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

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

@@ -1,5 +1,5 @@
-import { BentoClient } from '../client';
-import { CreateFieldParameters, Field } from './types';
+import type { BentoClient } from '../client';
+import type { CreateFieldParameters, Field } from './types';
 export declare class BentoFields {
     private readonly _client;
     private readonly _url;

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

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

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

@@ -1,5 +1,5 @@
-import { BentoClient } from '../client';
-import { FormResponse } from './types';
+import type { BentoClient } from '../client';
+import type { FormResponse } from './types';
 export declare class BentoForms {
     private readonly _client;
     private readonly _url;

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

@@ -0,0 +1,28 @@
+import type { BaseEntity, BrowserData, IdentityData, LocationData, PageData } from '../types';
+/**
+ * Core Form Types
+ */
+export declare type FormResponseData = {
+    browser: BrowserData;
+    date: string;
+    details: {
+        [key: string]: unknown;
+    };
+    fields: {
+        [key: string]: unknown;
+    };
+    id: string;
+    identity: IdentityData;
+    ip: string;
+    location: LocationData;
+    page: PageData;
+    site: string;
+    type: string;
+    visit: string;
+    visitor: string;
+};
+export declare type FormResponseAttributes = {
+    data: FormResponseData;
+    uuid: string;
+};
+export declare type FormResponse = BaseEntity<FormResponseAttributes>;

package/dist/sdk/interfaces.d.ts

@@ -0,0 +1,13 @@
+export interface AnalyticsOptions {
+    authentication: AuthenticationOptions;
+    clientOptions?: ClientOptions;
+    logErrors?: boolean;
+    siteUuid: string;
+}
+export interface AuthenticationOptions {
+    publishableKey: string;
+    secretKey: string;
+}
+export interface ClientOptions {
+    baseUrl?: string;
+}

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

@@ -1,5 +1,5 @@
-import { BentoClient } from '../client';
-import { CreateSubscriberParameters, GetSubscribersParameters, Subscriber } from './types';
+import type { BentoClient } from '../client';
+import type { CreateSubscriberParameters, GetSubscribersParameters, Subscriber } from './types';
 export declare class BentoSubscribers<S> {
     private readonly _client;
     private readonly _url;

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

@@ -0,0 +1,25 @@
+import type { BaseEntity } from '../types';
+/**
+ * Subscriber Method Parameter Types
+ */
+export declare type GetSubscribersParameters = {
+    email?: never;
+    uuid: string;
+} | {
+    email: string;
+    uuid?: never;
+} | never;
+export declare type CreateSubscriberParameters = {
+    email: string;
+};
+/**
+ * Core Subscriber Types
+ */
+export declare 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>>;

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

@@ -1,5 +1,5 @@
-import { BentoClient } from '../client';
-import { CreateTagParameters, Tag } from './types';
+import type { BentoClient } from '../client';
+import type { CreateTagParameters, Tag } from './types';
 export declare class BentoTags {
     private readonly _client;
     private readonly _url;

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

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

package/dist/sdk/types.d.ts

@@ -0,0 +1,41 @@
+/**
+ * Core Types
+ */
+import type { EntityType } from "./enums";
+export declare type BaseEntity<T> = {
+    attributes: T;
+    id: string;
+    type: EntityType;
+};
+/**
+ * Utility Types
+ */
+export declare type BrowserData = {
+    height: string;
+    user_agent: string;
+    width: string;
+};
+export declare type IdentityData = {
+    email: string;
+};
+export declare type LocationData = {
+    city_name: string;
+    continent_code: string;
+    country_code2: string;
+    country_code3: string;
+    country_name: string;
+    ip: string;
+    latitude: number;
+    longitude: number;
+    postal_code: string;
+    real_region_name: string;
+    region_name: string;
+    request: string;
+};
+export declare type PageData = {
+    host: string;
+    path: string;
+    protocol: string;
+    referrer: string;
+    url: string;
+};

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

@@ -1,9 +1,9 @@
 import { BentoBatch, BentoCommands, BentoExperimental, BentoFields, BentoForms, BentoSubscribers, BentoTags } from '../../sdk';
-import { AnalyticsOptions } from '../../sdk/interfaces';
-import { AddSubscriberParameters, RemoveSubscriberParameters, TagSubscriberParameters, TrackParameters, TrackPurchaseParameters, UpdateFieldsParameters } from './types';
+import type { AnalyticsOptions } from '../../sdk/interfaces';
+import type { AddSubscriberParameters, RemoveSubscriberParameters, TagSubscriberParameters, TrackParameters, TrackPurchaseParameters, UpdateFieldsParameters } from './types';
 export declare class BentoAPIV1<S = {
-    [key: string]: any;
-}, E = '$custom'> {
+    [key: string]: unknown;
+}, E extends string = '$custom'> {
     private readonly _client;
     readonly Batch: BentoBatch<S, E>;
     readonly Commands: BentoCommands<S>;

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

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

package/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "0.1.13",
+  "version": "0.2.00",
   "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",
@@ -57,11 +51,13 @@
     "@size-limit/preset-small-lib": "^5.0.3",
     "@types/isomorphic-fetch": "^0.0.35",
     "@types/jest": "^27.0.1",
-    "@typescript-eslint/eslint-plugin": "^4.29.2",
-    "@typescript-eslint/parser": "^4.29.2",
+    "@typescript-eslint/eslint-plugin": "^5.30.7",
+    "@typescript-eslint/parser": "^5.30.7",
     "@weiran.zsd/tsdx": "^0.15.2",
+    "eslint": "^7.32.0",
     "husky": "^7.0.1",
     "msw": "^0.34.0",
+    "prettier": "^2.7.1",
     "size-limit": "^5.0.3",
     "tslib": "^2.3.1",
     "typescript": "^4.3.5"

package/src/index.ts

@@ -1,7 +1,7 @@
-import { AnalyticsOptions } from './sdk/interfaces';
+import type { AnalyticsOptions } from './sdk/interfaces';
 import { BentoAPIV1 } from './versions/v1';
 
-export class Analytics<S = { [key: string]: any }, E = '$custom'> {
+export class Analytics<S = { [key: string]: unknown }, E extends string = ''> {
   public readonly V1: BentoAPIV1<S, E>;
 
   constructor(options: AnalyticsOptions) {

package/src/sdk/batch/errors.ts

@@ -1,4 +1,41 @@
-export class TooFewSubscribersError extends Error {}
-export class TooManySubscribersError extends Error {}
-export class TooFewEventsError extends Error {}
-export class TooManyEventsError extends Error {}
+export class TooFewSubscribersError extends Error {
+  constructor(message = 'Too few subscribers') {
+    super(message);
+    this.name = 'TooFewSubscribersError';
+  }
+}
+
+export class TooManySubscribersError extends Error {
+  constructor(message = 'Too many subscribers') {
+    super(message);
+    this.name = 'TooManySubscribersError';
+  }
+}
+
+export class TooFewEventsError extends Error {
+  constructor(message = 'Too few events') {
+    super(message);
+    this.name = 'TooFewEventsError';
+  }
+}
+
+export class TooManyEventsError extends Error {
+  constructor(message = 'Too many events') {
+    super(message);
+    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/{events.d.ts → events.ts}

@@ -1,4 +1,4 @@
-import { BentoEvents } from './enums';
+import type { BentoEvents } from './enums';
 
 export type PurchaseItem = {
   product_sku?: string;
@@ -77,12 +77,11 @@ export type InternalEvents<S> =
   | UnsubscribeEvent
   | UpdateFieldsEvent<S>;
 
-export type BaseEvent<E> = {
+export type BaseEvent<E extends string> = {
   date?: Date;
-  details?: { [key: string]: any };
+  details?: Record<string, unknown>;
   email: string;
-  /* eslint-disable */
   type: `${E}${string}`;
 };
 
-export type BentoEvent<S, E> = InternalEvents<S> | BaseEvent<E>;
+export type BentoEvent<S, E extends string> = InternalEvents<S> | BaseEvent<E>;