@bentonow/bento-node-sdk 0.2.1 → 1.0.5

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

@@ -1,79 +1,79 @@
-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;
-    constructor(_client: BentoClient);
-    /**
-     * **This does not trigger automations!** - If you wish to trigger automations, please use the
-     * core module's `tagSubscriber` method.
-     *
-     * Adds a tag to the subscriber with the matching email.
-     *
-     * Note that both the tag and the subscriber will be created if either is missing
-     * from system.
-     *
-     *
-     * @param parameters \{ email: string, tagName: string \}
-     * @returns Promise\<Subscriber | null\>
-     */
-    addTag(parameters: AddTagParameters): Promise<Subscriber<S> | null>;
-    /**
-     * Removes the specified tag from the subscriber with the matching email.
-     *
-     * @param parameters \{ email: string, tagName: string \}
-     * @returns Promise\<Subscriber | null\>
-     */
-    removeTag(parameters: RemoveTagParameters): Promise<Subscriber<S> | null>;
-    /**
-     * **This does not trigger automations!** - If you wish to trigger automations, please use the
-     * core module's `updateFields` method.
-     *
-     * Adds a field to the subscriber with the matching email.
-     *
-     * Note that both the field and the subscriber will be created if either is missing
-     * from system.
-     *
-     * @param parameters \{ email: string, field: \{ key: string; value: string; \} \}
-     * @returns Promise\<Subscriber | null\>
-     */
-    addField(parameters: AddFieldParameters<S>): Promise<Subscriber<S> | null>;
-    /**
-     * Removes a field to the subscriber with the matching email.
-     *
-     * @param parameters \{ email: string, fieldName: string \}
-     * @returns Promise\<Subscriber | null\>
-     */
-    removeField(parameters: RemoveFieldParameters<S>): Promise<Subscriber<S> | null>;
-    /**
-     * **This does not trigger automations!** - If you wish to trigger automations, please use the
-     * core module's `addSubscriber` method.
-     *
-     * Subscribes the supplied email to Bento. If the email does not exist, it is created.
-     * If the subscriber had previously unsubscribed, they will be re-subscribed.
-     *
-     * @param parameters \{ email: string \}
-     * @returns Promise\<Subscriber | null\>
-     */
-    subscribe(parameters: SubscribeParameters): Promise<Subscriber<S> | null>;
-    /**
-     * **This does not trigger automations!** - If you wish to trigger automations, please use the
-     * core module's `removeSubscriber` method.
-     *
-     * Unsubscribes the supplied email to Bento. If the email does not exist, it is created and
-     * immediately unsubscribed. If they had already unsubscribed, the `unsubscribed_at` property
-     * is updated.
-     *
-     * @param parameters \{ email: string \}
-     * @returns Promise\<Subscriber | null\>
-     */
-    unsubscribe(parameters: UnsubscribeParameters): Promise<Subscriber<S> | null>;
-    /**
-     * Updates the email of a user in Bento.
-     *
-     * @param parameters \{ oldEmail: string, newEmail: string \}
-     * @returns Promise\<Subscriber | null\>
-     */
-    changeEmail(parameters: ChangeEmailParameters): Promise<Subscriber<S> | null>;
-}
+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;
+    constructor(_client: BentoClient);
+    /**
+     * **This does not trigger automations!** - If you wish to trigger automations, please use the
+     * core module's `tagSubscriber` method.
+     *
+     * Adds a tag to the subscriber with the matching email.
+     *
+     * Note that both the tag and the subscriber will be created if either is missing
+     * from system.
+     *
+     *
+     * @param parameters \{ email: string, tagName: string \}
+     * @returns Promise\<Subscriber | null\>
+     */
+    addTag(parameters: AddTagParameters): Promise<Subscriber<S> | null>;
+    /**
+     * Removes the specified tag from the subscriber with the matching email.
+     *
+     * @param parameters \{ email: string, tagName: string \}
+     * @returns Promise\<Subscriber | null\>
+     */
+    removeTag(parameters: RemoveTagParameters): Promise<Subscriber<S> | null>;
+    /**
+     * **This does not trigger automations!** - If you wish to trigger automations, please use the
+     * core module's `updateFields` method.
+     *
+     * Adds a field to the subscriber with the matching email.
+     *
+     * Note that both the field and the subscriber will be created if either is missing
+     * from system.
+     *
+     * @param parameters \{ email: string, field: \{ key: string; value: string; \} \}
+     * @returns Promise\<Subscriber | null\>
+     */
+    addField(parameters: AddFieldParameters<S>): Promise<Subscriber<S> | null>;
+    /**
+     * Removes a field to the subscriber with the matching email.
+     *
+     * @param parameters \{ email: string, fieldName: string \}
+     * @returns Promise\<Subscriber | null\>
+     */
+    removeField(parameters: RemoveFieldParameters<S>): Promise<Subscriber<S> | null>;
+    /**
+     * **This does not trigger automations!** - If you wish to trigger automations, please use the
+     * core module's `addSubscriber` method.
+     *
+     * Subscribes the supplied email to Bento. If the email does not exist, it is created.
+     * If the subscriber had previously unsubscribed, they will be re-subscribed.
+     *
+     * @param parameters \{ email: string \}
+     * @returns Promise\<Subscriber | null\>
+     */
+    subscribe(parameters: SubscribeParameters): Promise<Subscriber<S> | null>;
+    /**
+     * **This does not trigger automations!** - If you wish to trigger automations, please use the
+     * core module's `removeSubscriber` method.
+     *
+     * Unsubscribes the supplied email to Bento. If the email does not exist, it is created and
+     * immediately unsubscribed. If they had already unsubscribed, the `unsubscribed_at` property
+     * is updated.
+     *
+     * @param parameters \{ email: string \}
+     * @returns Promise\<Subscriber | null\>
+     */
+    unsubscribe(parameters: UnsubscribeParameters): Promise<Subscriber<S> | null>;
+    /**
+     * Updates the email of a user in Bento.
+     *
+     * @param parameters \{ oldEmail: string, newEmail: string \}
+     * @returns Promise\<Subscriber | null\>
+     */
+    changeEmail(parameters: ChangeEmailParameters): Promise<Subscriber<S> | null>;
+}

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

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

package/dist/sdk/email-templates/index.d.ts

@@ -0,0 +1,21 @@
+import type { BentoClient } from '../client';
+import type { EmailTemplate, GetEmailTemplateParameters, UpdateEmailTemplateParameters } from './types';
+export declare class BentoEmailTemplates {
+    private readonly _client;
+    private readonly _url;
+    constructor(_client: BentoClient);
+    /**
+     * Returns a single email template by ID.
+     *
+     * @param parameters GetEmailTemplateParameters
+     * @returns Promise\<EmailTemplate | null\>
+     */
+    getEmailTemplate(parameters: GetEmailTemplateParameters): Promise<EmailTemplate | null>;
+    /**
+     * Updates an email template's subject and/or HTML content.
+     *
+     * @param parameters UpdateEmailTemplateParameters
+     * @returns Promise\<EmailTemplate | null\>
+     */
+    updateEmailTemplate(parameters: UpdateEmailTemplateParameters): Promise<EmailTemplate | null>;
+}

package/dist/sdk/email-templates/types.d.ts

@@ -0,0 +1,23 @@
+import type { BaseEntity } from '../types';
+/**
+ * Email Template Method Parameter Types
+ */
+export type GetEmailTemplateParameters = {
+    id: number;
+};
+export type UpdateEmailTemplateParameters = {
+    id: number;
+    subject?: string;
+    html?: string;
+};
+/**
+ * Core Email Template Types
+ */
+export type EmailTemplateAttributes = {
+    name: string;
+    subject: string;
+    html: string;
+    created_at: string;
+    stats: Record<string, unknown> | null;
+};
+export type EmailTemplate = BaseEntity<EmailTemplateAttributes>;

package/dist/sdk/enums.d.ts

@@ -1,9 +1,12 @@
-/**
- * Core Enums
- */
-export declare enum EntityType {
-    EVENTS = "events",
-    TAGS = "tags",
-    VISITORS = "visitors",
-    VISITORS_FIELDS = "visitors-fields"
-}
+/**
+ * Core Enums
+ */
+export declare enum EntityType {
+    EVENTS = "events",
+    TAGS = "tags",
+    VISITORS = "visitors",
+    VISITORS_FIELDS = "visitors-fields",
+    SEQUENCES = "sequences",
+    WORKFLOWS = "workflows",
+    EMAIL_TEMPLATES = "email_templates"
+}

package/dist/sdk/errors.d.ts

@@ -1,2 +1,2 @@
-export * from './batch/errors';
-export * from './client/errors';
+export * from './batch/errors';
+export * from './client/errors';

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

@@ -1,57 +1,75 @@
-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;
-    constructor(_client: BentoClient);
-    /**
-     * **EXPERIMENTAL** -
-     * This functionality is experimental and may change or stop working at any time.
-     *
-     * Attempts to validate the email. You can provide additional information to further
-     * refine the validation.
-     *
-     * If a name is provided, it compares it against the US Census Data, and so the results
-     * may be biased.
-     *
-     * @param parameters
-     * @returns Promise\<boolean\>
-     */
-    validateEmail(parameters: ValidateEmailParameters): Promise<boolean>;
-    /**
-     * **EXPERIMENTAL** -
-     * This functionality is experimental and may change or stop working at any time.
-     *
-     * Attempts to guess the gender of the person given a provided name. It compares
-     * the name against the US Census Data, and so the results may be biased.
-     *
-     * It is possible for the gender to be unknown if the system cannot confidently
-     * conclude what gender it may be.
-     *
-     * @param parameters
-     * @returns Promise\<GuessGenderResponse\>
-     */
-    guessGender(parameters: GuessGenderParameters): Promise<GuessGenderResponse>;
-    /**
-     * **EXPERIMENTAL** -
-     * This functionality is experimental and may change or stop working at any time.
-     *
-     * Attempts to provide location data given a provided IP address.
-     *
-     * @param parameters
-     * @returns Promise\<GeolocateResponse\>
-     */
-    geolocate(parameters: GeolocateParameters): Promise<LocationData | null>;
-    /**
-     * **EXPERIMENTAL** -
-     * This functionality is experimental and may change or stop working at any time.
-     *
-     * Looks up the provided URL or IP Address against various blacklists to see if the site has been
-     * blacklisted anywhere.
-     *
-     * @param parameters
-     * @returns Promise\<BlacklistResponse\>
-     */
-    checkBlacklist(parameters: BlacklistParameters): Promise<BlacklistResponse>;
-}
+import type { BentoClient } from '../client';
+import type { LocationData } from '../types';
+import type { BlacklistCheckInput, BlacklistParameters, BlacklistResponse, BlacklistResult, ContentModerationResult, GeolocateParameters, GuessGenderParameters, GuessGenderResponse, ValidateEmailParameters } from './types';
+export declare class BentoExperimental {
+    private readonly _client;
+    private readonly _url;
+    constructor(_client: BentoClient);
+    /**
+     * **EXPERIMENTAL** -
+     * This functionality is experimental and may change or stop working at any time.
+     *
+     * Attempts to validate the email. You can provide additional information to further
+     * refine the validation.
+     *
+     * If a name is provided, it compares it against the US Census Data, and so the results
+     * may be biased.
+     *
+     * @param parameters
+     * @returns Promise\<boolean\>
+     */
+    validateEmail(parameters: ValidateEmailParameters): Promise<boolean>;
+    /**
+     * **EXPERIMENTAL** -
+     * This functionality is experimental and may change or stop working at any time.
+     *
+     * Attempts to guess the gender of the person given a provided name. It compares
+     * the name against the US Census Data, and so the results may be biased.
+     *
+     * It is possible for the gender to be unknown if the system cannot confidently
+     * conclude what gender it may be.
+     *
+     * @param parameters
+     * @returns Promise\<GuessGenderResponse\>
+     */
+    guessGender(parameters: GuessGenderParameters): Promise<GuessGenderResponse>;
+    /**
+     * **EXPERIMENTAL** -
+     * This functionality is experimental and may change or stop working at any time.
+     *
+     * Attempts to provide location data given a provided IP address.
+     *
+     * @param parameters
+     * @returns Promise\<GeolocateResponse\>
+     */
+    geolocate(parameters: GeolocateParameters): Promise<LocationData | null>;
+    /**
+     * **EXPERIMENTAL** -
+     * This functionality is experimental and may change or stop working at any time.
+     *
+     * Looks up the provided URL or IP Address against various blacklists to see if the site has been
+     * blacklisted anywhere.
+     *
+     * @param parameters
+     * @returns Promise\<BlacklistResponse\>
+     */
+    checkBlacklist(parameters: BlacklistParameters): Promise<BlacklistResponse>;
+    /**
+     * Checks if a domain or IP is blacklisted
+     * @param input Domain or IP to check
+     * @returns Promise<BlacklistResult>
+     */
+    getBlacklistStatus(input: BlacklistCheckInput): Promise<BlacklistResult>;
+    /**
+     * Performs content moderation on provided text
+     * @param content Text content to moderate
+     * @returns Promise<ContentModerationResult>
+     */
+    getContentModeration(content: string): Promise<ContentModerationResult>;
+    /**
+     * Gets geolocation data for an IP address
+     * @param ipAddress IP address to geolocate
+     * @returns Promise<LocationData>
+     */
+    geoLocateIP(ipAddress: string): Promise<LocationData>;
+}

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

@@ -1,41 +1,71 @@
-import type { LocationData } from '../types';
-/**
- * Experimental Method Parameter Types
- */
-export type ValidateEmailParameters = {
-    email: string;
-    ip?: string;
-    name?: string;
-    userAgent?: string;
-};
-export type GuessGenderParameters = {
-    name: string;
-};
-export type GeolocateParameters = {
-    ip: string;
-};
-export type BlacklistParameters = {
-    domain: string;
-    ip?: never;
-} | {
-    domain?: never;
-    ip: string;
-};
-/**
- * Experimental Method Response Types
- */
-export type ValidateEmailResponse = {
-    valid: boolean;
-};
-export type GuessGenderResponse = {
-    confidence: number | null;
-    gender: string | null;
-};
-export type GeolocateResponse = Partial<LocationData>;
-export type BlacklistResponse = {
-    description: string;
-    query: string;
-    results: {
-        [key: string]: boolean;
-    };
-};
+import type { LocationData } from '../types';
+/**
+ * Experimental Method Parameter Types
+ */
+export type ValidateEmailParameters = {
+    email: string;
+    ip?: string;
+    name?: string;
+    userAgent?: string;
+};
+export type GuessGenderParameters = {
+    name: string;
+};
+export type GeolocateParameters = {
+    ip: string;
+};
+export type BlacklistParameters = {
+    domain: string;
+    ip?: never;
+} | {
+    domain?: never;
+    ip: string;
+};
+export type BlacklistCheckInput = {
+    domain?: string;
+    ipAddress?: string;
+};
+/**
+ * Experimental Method Response Types
+ */
+export type ValidateEmailResponse = {
+    valid: boolean;
+};
+export type GuessGenderResponse = {
+    confidence: number | null;
+    gender: string | null;
+};
+export type GeolocateResponse = Partial<LocationData>;
+export type BlacklistResponse = {
+    description: string;
+    query: string;
+    results: {
+        [key: string]: boolean;
+    };
+};
+export type BlacklistResult = {
+    description: string;
+    query: string;
+    results: Record<string, boolean>;
+};
+export type ContentModerationResult = {
+    flagged: boolean;
+    categories: {
+        hate: boolean;
+        'hate/threatening': boolean;
+        'self-harm': boolean;
+        sexual: boolean;
+        'sexual/minors': boolean;
+        violence: boolean;
+        'violence/graphic': boolean;
+    };
+    category_scores: {
+        hate: number;
+        'hate/threatening': number;
+        'self-harm': number;
+        sexual: number;
+        'sexual/minors': number;
+        violence: number;
+        'violence/graphic': number;
+    };
+};

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

@@ -1,29 +1,29 @@
-import type { BentoClient } from '../client';
-import type { CreateFieldParameters, Field } from './types';
-export declare class BentoFields {
-    private readonly _client;
-    private readonly _url;
-    constructor(_client: BentoClient);
-    /**
-     * Returns all of the fields for the site.
-     *
-     * @returns Promise<Field[]>
-     */
-    getFields(): Promise<Field[] | null>;
-    /**
-     * Creates a field inside of Bento. The name of the field is automatically generated
-     * from the key that is passed in upon creation. For example
-     *  - Key: `thisIsAKey`
-     *    Name: `This Is A Key`
-     *  - Key: `this is a key`
-     *    Name: `This Is A Key`
-     *  - Key: `this-is-a-key`
-     *    Name: `This Is A Key`
-     *  - Key: `this_is_a_key`
-     *    Name: `This Is A Key`
-     *
-     * @param parameters \{ key: string \}
-     * @returns Promise<Field[]>
-     */
-    createField(parameters: CreateFieldParameters): Promise<Field[] | null>;
-}
+import type { BentoClient } from '../client';
+import type { CreateFieldParameters, Field } from './types';
+export declare class BentoFields {
+    private readonly _client;
+    private readonly _url;
+    constructor(_client: BentoClient);
+    /**
+     * Returns all of the fields for the site.
+     *
+     * @returns Promise<Field[]>
+     */
+    getFields(): Promise<Field[] | null>;
+    /**
+     * Creates a field inside of Bento. The name of the field is automatically generated
+     * from the key that is passed in upon creation. For example
+     *  - Key: `thisIsAKey`
+     *    Name: `This Is A Key`
+     *  - Key: `this is a key`
+     *    Name: `This Is A Key`
+     *  - Key: `this-is-a-key`
+     *    Name: `This Is A Key`
+     *  - Key: `this_is_a_key`
+     *    Name: `This Is A Key`
+     *
+     * @param parameters \{ key: string \}
+     * @returns Promise<Field[]>
+     */
+    createField(parameters: CreateFieldParameters): Promise<Field[] | null>;
+}

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

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