bloomreach-transactional-email/dist/send-email.d.ts

A nonofficial, feature complete, client library for sending transactional emails via Bloomreach.

export interface Auth {
    username: string;
    password: string;
    baseUrl: string;
    projectToken: string;
}
export interface HtmlContent {
    html: string;
    subject: string;
}
export interface TemplateContent {
    templateId: string;
    params?: any;
}
export interface Integration {
    id: string;
    senderAddress: string;
}
export interface Options {
    integrationId?: string;
    integrations?: Integration[];
    email?: string;
    language?: string;
    senderAddress?: string;
    senderName?: string;
    transferIdentity?: 'enabled' | 'disabled' | 'first_click';
}
export interface Attachment {
    filename: string;
    content: string;
    contentType: string;
}
export interface AlphaNumericDictionary {
    [name: string | number]: string | number;
}
export interface CustomEventProperties extends AlphaNumericDictionary {
}
export interface CustomHeaders extends AlphaNumericDictionary {
}
export interface UrlParams extends AlphaNumericDictionary {
}
export interface Settings {
    customEventProperties?: CustomEventProperties;
    customHeaders?: CustomHeaders;
    urlParams?: UrlParams;
    transferUserIdentity?: 'enabled' | 'disabled' | 'first_click';
    consentCategory?: string;
    consentCategoryTracking?: string;
}
export declare const sendEmail: (auth: Auth, campaignName: string, customerIds: any, emailContent: HtmlContent | TemplateContent, options?: Options, attachments?: Attachment[], settings?: Settings) => Promise<any>;