@bentonow/bento-node-sdk 0.2.1 → 1.0.4

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

@@ -1,14 +1,14 @@
-import type { BentoClient } from '../client';
-import type { FormResponse } from './types';
-export declare class BentoForms {
-    private readonly _client;
-    private readonly _url;
-    constructor(_client: BentoClient);
-    /**
-     * Returns all of the responses for the form with the specified identifier.
-     *
-     * @param formIdentifier string
-     * @returns Promise\<FormResponse[] | null\>
-     */
-    getResponses(formIdentifier: string): Promise<FormResponse[] | null>;
-}
+import type { BentoClient } from '../client';
+import type { FormResponse } from './types';
+export declare class BentoForms {
+    private readonly _client;
+    private readonly _url;
+    constructor(_client: BentoClient);
+    /**
+     * Returns all of the responses for the form with the specified identifier.
+     *
+     * @param formIdentifier string
+     * @returns Promise\<FormResponse[] | null\>
+     */
+    getResponses(formIdentifier: string): Promise<FormResponse[] | null>;
+}

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

@@ -1,28 +1,28 @@
-import type { BaseEntity, BrowserData, IdentityData, LocationData, PageData } from '../types';
-/**
- * Core Form Types
- */
-export 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 type FormResponseAttributes = {
-    data: FormResponseData;
-    uuid: string;
-};
-export type FormResponse = BaseEntity<FormResponseAttributes>;
+import type { BaseEntity, BrowserData, IdentityData, LocationData, PageData } from '../types';
+/**
+ * Core Form Types
+ */
+export 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 type FormResponseAttributes = {
+    data: FormResponseData;
+    uuid: string;
+};
+export type FormResponse = BaseEntity<FormResponseAttributes>;

package/dist/sdk/index.d.ts

@@ -1,8 +1,11 @@
-export * from './batch';
-export * from './client';
-export * from './commands';
-export * from './experimental';
-export * from './fields';
-export * from './forms';
-export * from './subscribers';
-export * from './tags';
+export * from './batch';
+export * from './client';
+export * from './commands';
+export * from './email-templates';
+export * from './experimental';
+export * from './fields';
+export * from './forms';
+export * from './sequences';
+export * from './subscribers';
+export * from './tags';
+export * from './workflows';

package/dist/sdk/interfaces.d.ts

@@ -1,13 +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;
-}
+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/sequences/index.d.ts

@@ -0,0 +1,13 @@
+import type { BentoClient } from '../client';
+import type { Sequence } from './types';
+export declare class BentoSequences {
+    private readonly _client;
+    private readonly _url;
+    constructor(_client: BentoClient);
+    /**
+     * Returns all of the sequences for the site, including their email templates.
+     *
+     * @returns Promise\<Sequence[] | null\>
+     */
+    getSequences(): Promise<Sequence[] | null>;
+}

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

@@ -0,0 +1,18 @@
+import type { BaseEntity } from '../types';
+/**
+ * Embedded Email Template in Sequence
+ */
+export type SequenceEmailTemplate = {
+    id: number;
+    subject: string;
+    stats: Record<string, unknown> | null;
+};
+/**
+ * Core Sequence Types
+ */
+export type SequenceAttributes = {
+    name: string;
+    created_at: string;
+    email_templates: SequenceEmailTemplate[];
+};
+export type Sequence = BaseEntity<SequenceAttributes>;

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

@@ -0,0 +1,24 @@
+import type { BentoClient } from '../client';
+import type { SiteStats, SegmentStats, ReportStats } from './types';
+export declare class BentoStats {
+    private readonly _client;
+    private readonly _url;
+    constructor(_client: BentoClient);
+    /**
+     * Retrieves overall statistics for the site
+     * @returns Promise<SiteStats>
+     */
+    getSiteStats(): Promise<SiteStats>;
+    /**
+     * Retrieves statistics for a specific segment
+     * @param segmentId ID of the segment to get stats for
+     * @returns Promise<SegmentStats>
+     */
+    getSegmentStats(segmentId: string): Promise<SegmentStats>;
+    /**
+     * Retrieves statistics for a specific report
+     * @param reportId ID of the report to get stats for
+     * @returns Promise<ReportStats>
+     */
+    getReportStats(reportId: string): Promise<ReportStats>;
+}

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

@@ -0,0 +1,26 @@
+export type SiteStats = {
+    total_subscribers: number;
+    active_subscribers: number;
+    unsubscribed_count: number;
+    broadcast_count: number;
+    average_open_rate: number;
+    average_click_rate: number;
+};
+export type SegmentStats = {
+    segment_id: string;
+    subscriber_count: number;
+    growth_rate: number;
+    engagement_rate: number;
+    last_updated: string;
+};
+export type ReportStats = {
+    report_id: string;
+    total_sent: number;
+    total_opens: number;
+    unique_opens: number;
+    total_clicks: number;
+    unique_clicks: number;
+    unsubscribes: number;
+    spam_reports: number;
+    created_at: string;
+};

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

@@ -1,20 +1,20 @@
-import type { BentoClient } from '../client';
-import type { CreateSubscriberParameters, GetSubscribersParameters, Subscriber } from './types';
-export declare class BentoSubscribers<S> {
-    private readonly _client;
-    private readonly _url;
-    constructor(_client: BentoClient);
-    /**
-     * Returns the subscriber with the specified email or UUID.
-     *
-     * @returns Promise\<Subscriber\<S\> | null\>
-     */
-    getSubscribers(parameters?: GetSubscribersParameters): Promise<Subscriber<S> | null>;
-    /**
-     * Creates a subscriber inside of Bento.
-     *
-     * @param parameters CreateSubscriberParameters
-     * @returns Promise\<Subscriber\<S\> | null\>
-     */
-    createSubscriber(parameters: CreateSubscriberParameters): Promise<Subscriber<S> | null>;
-}
+import type { BentoClient } from '../client';
+import type { CreateSubscriberParameters, GetSubscribersParameters, Subscriber } from './types';
+export declare class BentoSubscribers<S> {
+    private readonly _client;
+    private readonly _url;
+    constructor(_client: BentoClient);
+    /**
+     * Returns the subscriber with the specified email or UUID.
+     *
+     * @returns Promise\<Subscriber\<S\> | null\>
+     */
+    getSubscribers(parameters?: GetSubscribersParameters): Promise<Subscriber<S> | null>;
+    /**
+     * Creates a subscriber inside of Bento.
+     *
+     * @param parameters CreateSubscriberParameters
+     * @returns Promise\<Subscriber\<S\> | null\>
+     */
+    createSubscriber(parameters: CreateSubscriberParameters): Promise<Subscriber<S> | null>;
+}

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

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

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

@@ -1,20 +1,20 @@
-import type { BentoClient } from '../client';
-import type { CreateTagParameters, Tag } from './types';
-export declare class BentoTags {
-    private readonly _client;
-    private readonly _url;
-    constructor(_client: BentoClient);
-    /**
-     * Returns all of the fields for the site.
-     *
-     * @returns Promise\<Tag[] | null\>
-     */
-    getTags(): Promise<Tag[] | null>;
-    /**
-     * Creates a tag inside of Bento.
-     *
-     * @param parameters CreateTagParameters
-     * @returns Promise\<Tag[] | null\>
-     */
-    createTag(parameters: CreateTagParameters): Promise<Tag[] | null>;
-}
+import type { BentoClient } from '../client';
+import type { CreateTagParameters, Tag } from './types';
+export declare class BentoTags {
+    private readonly _client;
+    private readonly _url;
+    constructor(_client: BentoClient);
+    /**
+     * Returns all of the fields for the site.
+     *
+     * @returns Promise\<Tag[] | null\>
+     */
+    getTags(): Promise<Tag[] | null>;
+    /**
+     * Creates a tag inside of Bento.
+     *
+     * @param parameters CreateTagParameters
+     * @returns Promise\<Tag[] | null\>
+     */
+    createTag(parameters: CreateTagParameters): Promise<Tag[] | null>;
+}

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

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

package/dist/sdk/types.d.ts

@@ -1,41 +1,41 @@
-/**
- * Core Types
- */
-import type { EntityType } from "./enums";
-export type BaseEntity<T> = {
-    attributes: T;
-    id: string;
-    type: EntityType;
-};
-/**
- * Utility Types
- */
-export type BrowserData = {
-    height: string;
-    user_agent: string;
-    width: string;
-};
-export type IdentityData = {
-    email: string;
-};
-export 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 type PageData = {
-    host: string;
-    path: string;
-    protocol: string;
-    referrer: string;
-    url: string;
-};
+/**
+ * Core Types
+ */
+import type { EntityType } from './enums';
+export type BaseEntity<T> = {
+    attributes: T;
+    id: string;
+    type: EntityType;
+};
+/**
+ * Utility Types
+ */
+export type BrowserData = {
+    height: string;
+    user_agent: string;
+    width: string;
+};
+export type IdentityData = {
+    email: string;
+};
+export 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 type PageData = {
+    host: string;
+    path: string;
+    protocol: string;
+    referrer: string;
+    url: string;
+};

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

@@ -0,0 +1,13 @@
+import type { BentoClient } from '../client';
+import type { Workflow } from './types';
+export declare class BentoWorkflows {
+    private readonly _client;
+    private readonly _url;
+    constructor(_client: BentoClient);
+    /**
+     * Returns all of the workflows for the site, including their email templates.
+     *
+     * @returns Promise\<Workflow[] | null\>
+     */
+    getWorkflows(): Promise<Workflow[] | null>;
+}

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

@@ -0,0 +1,18 @@
+import type { BaseEntity } from '../types';
+/**
+ * Embedded Email Template in Workflow
+ */
+export type WorkflowEmailTemplate = {
+    id: number;
+    subject: string;
+    stats: Record<string, unknown> | null;
+};
+/**
+ * Core Workflow Types
+ */
+export type WorkflowAttributes = {
+    name: string;
+    created_at: string;
+    email_templates: WorkflowEmailTemplate[];
+};
+export type Workflow = BaseEntity<WorkflowAttributes>;