@bentonow/bento-node-sdk 0.2.1 → 1.0.5

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

@@ -1,8 +1,8 @@
-export declare enum BentoEvents {
-    PURCHASE = "$purchase",
-    SUBSCRIBE = "$subscribe",
-    TAG = "$tag",
-    REMOVE_TAG = "$remove_tag",
-    UNSUBSCRIBE = "$unsubscribe",
-    UPDATE_FIELDS = "$update_fields"
-}
+export declare enum BentoEvents {
+    PURCHASE = "$purchase",
+    SUBSCRIBE = "$subscribe",
+    TAG = "$tag",
+    REMOVE_TAG = "$remove_tag",
+    UNSUBSCRIBE = "$unsubscribe",
+    UPDATE_FIELDS = "$update_fields"
+}

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

@@ -1,18 +1,18 @@
-export declare class TooFewSubscribersError extends Error {
-    constructor(message?: string);
-}
-export declare class TooManySubscribersError extends Error {
-    constructor(message?: string);
-}
-export declare class TooFewEventsError extends Error {
-    constructor(message?: string);
-}
-export declare class TooManyEventsError extends Error {
-    constructor(message?: string);
-}
-export declare class TooFewEmailsError extends Error {
-    constructor(message?: string);
-}
-export declare class TooManyEmailsError extends Error {
-    constructor(message?: string);
-}
+export declare class TooFewSubscribersError extends Error {
+    constructor(message?: string);
+}
+export declare class TooManySubscribersError extends Error {
+    constructor(message?: string);
+}
+export declare class TooFewEventsError extends Error {
+    constructor(message?: string);
+}
+export declare class TooManyEventsError extends Error {
+    constructor(message?: string);
+}
+export declare class TooFewEmailsError extends Error {
+    constructor(message?: string);
+}
+export declare class TooManyEmailsError extends Error {
+    constructor(message?: string);
+}

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

@@ -1,71 +1,71 @@
-import type { BentoEvents } from './enums';
-export type PurchaseItem = {
-    product_sku?: string;
-    product_name?: string;
-    quantity?: number;
-    product_price?: number;
-    product_id?: string;
-} & {
-    [key: string]: string;
-};
-export type PurchaseCart = {
-    abandoned_checkout_url?: string;
-    items?: PurchaseItem[];
-};
-export type PurchaseDetails = {
-    unique: {
-        key: string | number;
-    };
-    value: {
-        currency: string;
-        amount: number;
-    };
-    cart?: PurchaseCart;
-};
-export type PurchaseEvent = {
-    date?: Date;
-    details: PurchaseDetails;
-    email: string;
-    type: BentoEvents.PURCHASE | '$purchase';
-};
-export type SubscribeEvent<S> = {
-    date?: Date;
-    email: string;
-    fields?: Partial<S>;
-    type: BentoEvents.SUBSCRIBE | '$subscribe';
-};
-export type TagEvent = {
-    date?: Date;
-    details: {
-        tag: string;
-    };
-    email: string;
-    type: BentoEvents.TAG | '$tag';
-};
-export type TagRemoveEvent = {
-    date?: Date;
-    details: {
-        tag: string;
-    };
-    email: string;
-    type: BentoEvents.REMOVE_TAG | '$remove_tag';
-};
-export type UnsubscribeEvent = {
-    date?: Date;
-    email: string;
-    type: BentoEvents.UNSUBSCRIBE | '$unsubscribe';
-};
-export type UpdateFieldsEvent<S> = {
-    date?: Date;
-    email: string;
-    type: BentoEvents.UPDATE_FIELDS | '$update_fields';
-    fields: Partial<S>;
-};
-export type InternalEvents<S> = PurchaseEvent | SubscribeEvent<S> | TagEvent | TagRemoveEvent | UnsubscribeEvent | UpdateFieldsEvent<S>;
-export type BaseEvent<E extends string> = {
-    date?: Date;
-    details?: Record<string, unknown>;
-    email: string;
-    type: `${E}${string}`;
-};
-export type BentoEvent<S, E extends string> = InternalEvents<S> | BaseEvent<E>;
+import type { BentoEvents } from './enums';
+export type PurchaseItem = {
+    product_sku?: string;
+    product_name?: string;
+    quantity?: number;
+    product_price?: number;
+    product_id?: string;
+} & {
+    [key: string]: string | number;
+};
+export type PurchaseCart = {
+    abandoned_checkout_url?: string;
+    items?: PurchaseItem[];
+};
+export type PurchaseDetails = {
+    unique: {
+        key: string | number;
+    };
+    value: {
+        currency: string;
+        amount: number;
+    };
+    cart?: PurchaseCart;
+};
+export type PurchaseEvent = {
+    date?: Date;
+    details: PurchaseDetails;
+    email: string;
+    type: BentoEvents.PURCHASE | '$purchase';
+};
+export type SubscribeEvent<S> = {
+    date?: Date;
+    email: string;
+    fields?: Partial<S>;
+    type: BentoEvents.SUBSCRIBE | '$subscribe';
+};
+export type TagEvent = {
+    date?: Date;
+    details: {
+        tag: string;
+    };
+    email: string;
+    type: BentoEvents.TAG | '$tag';
+};
+export type TagRemoveEvent = {
+    date?: Date;
+    details: {
+        tag: string;
+    };
+    email: string;
+    type: BentoEvents.REMOVE_TAG | '$remove_tag';
+};
+export type UnsubscribeEvent = {
+    date?: Date;
+    email: string;
+    type: BentoEvents.UNSUBSCRIBE | '$unsubscribe';
+};
+export type UpdateFieldsEvent<S> = {
+    date?: Date;
+    email: string;
+    type: BentoEvents.UPDATE_FIELDS | '$update_fields';
+    fields: Partial<S>;
+};
+export type InternalEvents<S> = PurchaseEvent | SubscribeEvent<S> | TagEvent | TagRemoveEvent | UnsubscribeEvent | UpdateFieldsEvent<S>;
+export type BaseEvent<E extends string> = {
+    date?: Date;
+    details?: Record<string, unknown>;
+    email: string;
+    type: `${E}${string}`;
+};
+export type BentoEvent<S, E extends string> = InternalEvents<S> | BaseEvent<E>;

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

@@ -1,55 +1,55 @@
-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);
-    /**
-     * **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.
-     *
-     * 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.
-     *
-     * This method is processed by the Bento import queues and it may take between 1 and
-     * 5 minutes for the results to appear in your dashboard.
-     *
-     * Returns the number of subscribers that were imported.
-     *
-     * @param parameters
-     * @returns Promise\<number\>
-     */
-    importSubscribers(parameters: BatchImportSubscribersParameter<S>): 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.
-     *
-     * Returns the number of events that were imported.
-     *
-     * @param parameters
-     * @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>;
-}
+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);
+    /**
+     * **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.
+     *
+     * 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.
+     *
+     * This method is processed by the Bento import queues and it may take between 1 and
+     * 5 minutes for the results to appear in your dashboard.
+     *
+     * Returns the number of subscribers that were imported.
+     *
+     * @param parameters
+     * @returns Promise\<number\>
+     */
+    importSubscribers(parameters: BatchImportSubscribersParameter<S>): 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.
+     *
+     * Returns the number of events that were imported.
+     *
+     * @param parameters
+     * @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 tags 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

@@ -1,37 +1,37 @@
-import type { BentoEvent } from './events';
-/**
- * Batch Method Parameter Types
- */
-export type BatchImportSubscribersParameter<S> = {
-    subscribers: ({
-        email: string;
-    } & Partial<S>)[];
-};
-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
- */
-export type BatchImportSubscribersResponse = {
-    results: number;
-};
-export type BatchImportEventsResponse = {
-    results: number;
-};
-export type BatchsendTransactionalEmailsResponse = {
-    results: number;
-};
+import type { BentoEvent } from './events';
+/**
+ * Batch Method Parameter Types
+ */
+export type BatchImportSubscribersParameter<S> = {
+    subscribers: ({
+        email: string;
+    } & Partial<S>)[];
+};
+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
+ */
+export type BatchImportSubscribersResponse = {
+    results: number;
+};
+export type BatchImportEventsResponse = {
+    results: number;
+};
+export type BatchsendTransactionalEmailsResponse = {
+    results: number;
+};

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

@@ -0,0 +1,26 @@
+import type { BentoClient } from '../client';
+import type { Broadcast, CreateBroadcastInput, EmailData } from './types';
+export declare class BentoBroadcasts {
+    private readonly _client;
+    private readonly _fetchUrl;
+    private readonly _batchUrl;
+    private readonly _emailsUrl;
+    constructor(_client: BentoClient);
+    /**
+     * Creates transactional emails in batch
+     * @param emails Array of email data to send
+     * @returns Promise<number> Number of emails successfully created
+     */
+    createEmails(emails: EmailData[]): Promise<number>;
+    /**
+     * Retrieves all broadcasts for the site
+     * @returns Promise<Broadcast[]>
+     */
+    getBroadcasts(): Promise<Broadcast[]>;
+    /**
+     * Creates new broadcast campaigns
+     * @param broadcasts Array of broadcast data to create
+     * @returns Promise<Broadcast[]>
+     */
+    createBroadcast(broadcasts: CreateBroadcastInput[]): Promise<Broadcast[]>;
+}

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

@@ -0,0 +1,32 @@
+import type { BaseEntity } from '../types';
+export type BroadcastType = 'plain' | 'html' | 'markdown';
+export type ContactData = {
+    name: string;
+    email: string;
+};
+export type BroadcastAttributes = {
+    name: string;
+    subject: string;
+    content: string;
+    type: BroadcastType;
+    from: ContactData;
+    inclusive_tags?: string;
+    exclusive_tags?: string;
+    segment_id?: string;
+    batch_size_per_hour: number;
+    created_at: string;
+};
+export type Broadcast = BaseEntity<BroadcastAttributes>;
+export type CreateBroadcastInput = Omit<BroadcastAttributes, 'created_at'>;
+/**
+ * Email data for transactional emails.
+ * Note: This is the same structure as TransactionalEmail in batch/types.ts
+ */
+export type EmailData = {
+    to: string;
+    from: string;
+    subject: string;
+    html_body: string;
+    transactional: boolean;
+    personalizations?: Record<string, string | number | boolean>;
+};

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

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

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

@@ -1,64 +1,94 @@
-import type { AnalyticsOptions } from '../interfaces';
-export declare class BentoClient {
-    private readonly _headers;
-    private readonly _baseUrl;
-    private readonly _siteUuid;
-    private readonly _logErrors;
-    constructor(options: AnalyticsOptions);
-    /**
-     * Wraps a GET request to the Bento API and automatically adds the required
-     * headers.
-     *
-     * @param endpoint string
-     * @param payload object
-     * @returns 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.
-     *
-     * @param endpoint string
-     * @param payload object
-     * @returns 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.
-     *
-     * @param authentication AuthenticationOptions
-     * @returns HeadersInit
-     */
-    private _extractHeaders;
-    /**
-     * Takes the existing payload and adds the `site_uuid` to it, then returns
-     * it out as a JSON string so that it can be sent alongside the request.
-     *
-     * @param payload object
-     * @returns string
-     */
-    private _getBody;
-    /**
-     * Takes the existing payload and adds the `site_uuid` to it, converts the
-     * object to a query string so that it can be sent alongside a GET request.
-     *
-     * @param payload object
-     * @returns string
-     */
-    private _getQueryParameters;
-    /**
-     * Filters down the status codes to those that are considered a 'success'.
-     *
-     * @param statusCode number
-     * @returns boolean
-     */
-    private _isSuccessfulStatus;
-    /**
-     * Returns an appropriate error to be thrown given the received response.
-     *
-     * @param response Response
-     * @returns Error
-     */
-    private _getErrorForResponse;
-}
+import type { AnalyticsOptions } from '../interfaces';
+interface RequestOptions {
+    timeout?: number | null;
+}
+export declare class BentoClient {
+    private readonly _headers;
+    private readonly _baseUrl;
+    private readonly _siteUuid;
+    private readonly _logErrors;
+    private readonly _timeout;
+    constructor(options: AnalyticsOptions);
+    /**
+     * Wraps a GET request to the Bento API and automatically adds the required
+     * headers.
+     *
+     * @param endpoint string
+     * @param payload object
+     * @returns Promise\<T\>
+     * */
+    get<T>(endpoint: string, payload?: Record<string, unknown>, requestOptions?: RequestOptions): Promise<T>;
+    /**
+     * Wraps a POST request to the Bento API and automatically adds the required
+     * headers.
+     *
+     * @param endpoint string
+     * @param payload object
+     * @returns Promise\<T\>
+     * */
+    post<T>(endpoint: string, payload?: Record<string, unknown>, requestOptions?: RequestOptions): Promise<T>;
+    /**
+     * Wraps a PATCH request to the Bento API and automatically adds the required
+     * headers.
+     *
+     * @param endpoint string
+     * @param payload object
+     * @returns Promise\<T\>
+     * */
+    patch<T>(endpoint: string, payload?: Record<string, unknown>, requestOptions?: RequestOptions): Promise<T>;
+    /**
+     * Performs a fetch request with a configurable timeout.
+     *
+     * @param url The URL to fetch
+     * @param options Fetch options
+     * @returns Promise<Response>
+     */
+    private _fetchWithTimeout;
+    /**
+     * Handles the response from a fetch request, parsing JSON or throwing appropriate errors.
+     *
+     * @param response The fetch Response object
+     * @returns Promise<T> The parsed response data
+     */
+    private _handleResponse;
+    /**
+     * Extracts the `publishableKey` and `secretKey` from the `authentication` options,
+     * adds the `Authorization` header, and includes a `User-Agent` header with the site UUID.
+     *
+     * @param authentication AuthenticationOptions
+     * @param siteUuid string The site UUID to be included in the User-Agent header
+     * @returns HeadersInit
+     */
+    private _extractHeaders;
+    /**
+     * Takes the existing payload and adds the `site_uuid` to it, then returns
+     * it out as a JSON string so that it can be sent alongside the request.
+     *
+     * @param payload object
+     * @returns string
+     */
+    private _getBody;
+    /**
+     * Takes the existing payload and adds the `site_uuid` to it, converts the
+     * object to a query string so that it can be sent alongside a GET request.
+     *
+     * @param payload object
+     * @returns string
+     */
+    private _getQueryParameters;
+    /**
+     * Filters down the status codes to those that are considered a 'success'.
+     *
+     * @param statusCode number
+     * @returns boolean
+     */
+    private _isSuccessfulStatus;
+    /**
+     * Returns an appropriate error to be thrown given the received response.
+     *
+     * @param response Response
+     * @returns Error
+     */
+    private _getErrorForResponse;
+}
+export {};

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

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

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

@@ -1,12 +1,12 @@
-/**
- * Command Enums
- */
-export declare enum CommandTypes {
-    ADD_FIELD = "add_field",
-    ADD_TAG = "add_tag",
-    CHANGE_EMAIL = "change_email",
-    REMOVE_FIELD = "remove_field",
-    REMOVE_TAG = "remove_tag",
-    SUBSCRIBE = "subscribe",
-    UNSUBSCRIBE = "unsubscribe"
-}
+/**
+ * Command Enums
+ */
+export declare enum CommandTypes {
+    ADD_FIELD = "add_field",
+    ADD_TAG = "add_tag",
+    CHANGE_EMAIL = "change_email",
+    REMOVE_FIELD = "remove_field",
+    REMOVE_TAG = "remove_tag",
+    SUBSCRIBE = "subscribe",
+    UNSUBSCRIBE = "unsubscribe"
+}