@cakemail-org/ui-components-v2 2.0.38

package/dist/esm/models/account/index.d.ts

@@ -0,0 +1,33 @@
+import { TAccountAddress, TAccountDomains, TAccountLimits, TAccountModel, TAccountReport, TGetAccountReport } from "./types";
+export declare class AccountModel {
+    readonly id: number;
+    readonly lineage: string;
+    readonly status: string;
+    name: string;
+    address: TAccountAddress;
+    fax: string;
+    phone: string;
+    website: string;
+    logo: string;
+    usage_limits: TAccountLimits;
+    last_activity_on: number;
+    created_on: number;
+    partner: boolean;
+    organization: boolean;
+    overrides: any;
+    stripe_customer_id: string;
+    constructor(params: Partial<TAccountModel>);
+    toJson(): any;
+    set<T extends keyof this>(property: T, value: this[T]): void;
+    getReport({ ...options }: TGetAccountReport): Promise<TAccountReport>;
+    impersonate(byContext?: boolean): Promise<any>;
+    getDomains(): Promise<TAccountDomains>;
+    getCustomer(): Promise<import("..").CustomerModel>;
+    update(account: Partial<TAccountModel>): Promise<{
+        data: AccountModel;
+        warning: any;
+    }>;
+    logOut(): Promise<any>;
+    isPartnerOrOrganization(): boolean;
+}
+export * from "./types";

package/dist/esm/models/account/types.d.ts

@@ -0,0 +1,108 @@
+export interface TAccountModel {
+    readonly id: number;
+    readonly lineage: string;
+    readonly status: string;
+    name: string;
+    address: TAccountAddress;
+    fax: string;
+    phone: string;
+    website: string;
+    logo: string;
+    usage_limits: TAccountLimits;
+    last_activity_on: number;
+    created_on: number;
+    partner: boolean;
+    overrides: any;
+    stripe_customer_id: string;
+    organization: boolean;
+}
+export interface TCreateAccount {
+    name: string;
+    address?: TAccountAddress;
+    account_owner?: {
+        first_name: string;
+        last_name: string;
+        title?: string;
+        office_phone?: string;
+        mobile_phone?: string;
+        language?: string;
+        timezone?: string;
+        password?: string;
+        email: string;
+        password_strength_requirement: "VERY_WEAK" | "WEAK" | "MODERATE" | "STRONG" | "VERY_STRONG";
+    };
+    fax?: string;
+    phone?: string;
+    usage_limits?: TAccountLimits;
+    website?: string;
+    domains?: TAccountDomains;
+    trial?: boolean;
+    partner?: boolean;
+}
+export type TAccountReport = {
+    readonly active_contacts: number;
+    readonly sent_emails: number;
+    readonly sent_campaign_emails: number;
+    readonly sent_action_emails: number;
+    readonly sent_email_emails: number;
+    readonly open_rate: number;
+    readonly bounce_rate: number;
+    readonly click_rate: number;
+    readonly spam_rate: number;
+    readonly unsubscribe_rate: number;
+    readonly emails_usage: number;
+    readonly contacts_usage: number;
+    readonly bounces_hard: number;
+    readonly bounce_hard_rate: number;
+    readonly spams: number;
+    readonly current_lists: number;
+    readonly email_api?: {
+        readonly submitted: number;
+        readonly delivered: number;
+    };
+};
+export type TAccountAddress = {
+    address1?: string;
+    address2?: string;
+    city?: string;
+    country?: string;
+    postal_code?: string;
+    province?: string;
+};
+export type TAccountLimits = {
+    starts_on: number;
+    per_campaign: number;
+    per_month: number;
+    remaining?: number;
+    maximum_contacts: number;
+    lists: number;
+    users: number;
+    campaign_blueprints: number;
+    automation_conditions: number;
+    use_campaign_blueprints: boolean;
+    use_ab_split: boolean;
+    use_automation_conditions: boolean;
+    use_automation_customwebhooks: boolean;
+    use_html_editor: boolean;
+    use_contact_export: boolean;
+    use_custom_merge_tags: boolean;
+    use_list_redirection: boolean;
+    use_behavioral_segmentation: boolean;
+    use_smart_email_resource: boolean;
+    use_smart_blueprint: boolean;
+    use_brand: boolean;
+    use_tags_in_automation: boolean;
+    use_tags: boolean;
+    use_email_api: boolean;
+    insert_reseller_logo: boolean;
+};
+export type TGetAccountReport = {
+    startTime?: number;
+    endTime?: number;
+};
+export type TAccountDomains = {
+    auth: "string";
+    bounce: "string";
+    dkim: "string";
+    tracking: "string";
+};

package/dist/esm/models/brand/index.d.ts

@@ -0,0 +1,2 @@
+export {};
+export * from "./types";

package/dist/esm/models/brand/types.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/esm/models/campaign/index.d.ts

@@ -0,0 +1,72 @@
+import { TActionApiResource, TDeleteApiResource, TGenericListLogsParams, TGenericListParams, TGenericListReturn, TGenericReturn } from "../../types";
+import { TExportsDownload } from "../exports";
+import { ECampaignStatuses, TCampaignAudience, TCampaignContent, TCampaignLinkReport, TCampaignLinks, TCampaignLogs, TCampaignLogsExport, TCampaignModel, TCampaignReport, TCampaignSendTestReturn, TCampaignSendTestType, TCampaignTracking, TCampaignUpdate, TListCampaignModel } from "./types";
+export declare class ListCampaignModel {
+    readonly id: number;
+    name: string;
+    audience?: TCampaignAudience;
+    type: "standard" | "recurring" | "absplit";
+    created_on: number;
+    scheduled_for: number;
+    scheduled_on: number;
+    updated_on: number;
+    sender?: {
+        name?: string;
+        email: string;
+    };
+    next_building_step: string;
+    status: ECampaignStatuses;
+    suspended: boolean;
+    web_email_link: string;
+    thumbnail_url: string;
+    constructor(params: Partial<TListCampaignModel>);
+    toJson(): any;
+    set<T extends keyof this>(property: T, value: this[T]): void;
+    delete(): Promise<TDeleteApiResource>;
+    update({ campaign }: {
+        campaign: Partial<TCampaignUpdate>;
+    }): Promise<CampaignModel>;
+    render({ contactId }: {
+        contactId?: number;
+    }): Promise<string>;
+    sendTest({ email, type }: {
+        email: string;
+        type: TCampaignSendTestType;
+    }): Promise<TCampaignSendTestReturn>;
+    schedule({ date, htmlEmpty }: {
+        date: string;
+        htmlEmpty?: boolean;
+    }): Promise<TActionApiResource>;
+    unSchedule(): Promise<TActionApiResource>;
+    reSchedule({ date, htmlEmpty }: {
+        date: string;
+        htmlEmpty?: boolean;
+    }): Promise<TActionApiResource>;
+    suspend(): Promise<TActionApiResource>;
+    resume(): Promise<TActionApiResource>;
+    cancel(): Promise<TActionApiResource>;
+    archive(): Promise<TActionApiResource>;
+    unArchive(): Promise<TActionApiResource>;
+    getRevisions({ ...options }: TGenericListParams): Promise<string>;
+    listLinks({ ...options }: TGenericListParams): Promise<TGenericListReturn<TCampaignLinks>>;
+    listLogs({ ...options }: TGenericListLogsParams): Promise<TGenericListReturn<TCampaignLogs>>;
+    listLogExports({ ...options }: TGenericListParams): Promise<TGenericListReturn<TCampaignLogsExport>>;
+    createLogExports({ description, filter }: {
+        description?: string;
+        filter?: string;
+    }): Promise<TGenericListReturn<TCampaignLogsExport>>;
+    downloadLogExport({ exportId }: {
+        exportId: string;
+    }): Promise<TExportsDownload>;
+    getReport(): Promise<TGenericReturn<TCampaignReport>>;
+    getLinkReport({ ...options }: TGenericListLogsParams): Promise<TGenericReturn<TCampaignLinkReport>>;
+}
+export declare class CampaignModel extends ListCampaignModel {
+    tracking: TCampaignTracking;
+    delivery_finished_on: number;
+    reply_to_email: string;
+    content: TCampaignContent;
+    heatmap_link: string;
+    constructor(params: Partial<TCampaignModel>);
+}
+export * from "./types";

package/dist/esm/models/campaign/types.d.ts

@@ -0,0 +1,131 @@
+import { TApiV2LogType, TApiV2LogUserAgent } from "../../types";
+import { TExport } from "../exports/types";
+export declare enum ECampaignStatuses {
+    "active" = "active",
+    "delivering" = "delivering",
+    "delivered" = "delivered",
+    "archived" = "archived",
+    "deleted" = "deleted",
+    "incomplete" = "incomplete",
+    "scheduled" = "scheduled"
+}
+export type TListCampaignModel = {
+    id: number;
+    name: string;
+    audience?: TCampaignAudience;
+    type: "standard" | "recurring" | "absplit";
+    created_on: number;
+    scheduled_for: number;
+    scheduled_on: number;
+    updated_on: number;
+    sender?: {
+        name?: string;
+        email: string;
+    };
+    next_building_step: string;
+    status: ECampaignStatuses;
+    suspended: boolean;
+    web_email_link: string;
+    thumbnail_url: string;
+};
+export interface TCampaignModel extends TListCampaignModel {
+    tracking?: TCampaignTracking;
+    delivery_finished_on?: number;
+    reply_to_email?: string;
+    content?: TCampaignContent;
+    heatmap_link?: string;
+}
+export type TCampaignUpdate = Pick<TCampaignModel, "name" | "content" | "audience" | "tracking" | "reply_to_email"> & {
+    sender?: {
+        id: number;
+        name?: string;
+    };
+};
+export type TCampaignContent = {
+    subject?: string;
+    html?: string;
+    text?: string;
+    json?: any;
+    type?: "html" | "bee" | "custom";
+    hash?: string;
+    last_updated_on?: number;
+    encoding?: "utf-8" | "armscii-8" | "ascii" | "big-5" | "cp51932" | "cp866" | "cp936" | "euc-cn" | "euc-jp" | "eucjp-win" | "euc-kr" | "euc-tw" | "hz" | "iso-2022-jp" | "iso-2022-jp-ms" | "iso-2022-kr" | "iso-8859-1" | "iso-8859-10" | "iso-8859-13" | "iso-8859-14" | "iso-8859-15" | "iso-8859-16" | "iso-8859-2" | "iso-8859-3" | "iso-8859-4" | "iso-8859-5" | "iso-8859-6" | "iso-8859-7" | "iso-8859-8" | "iso-8859-9" | "jis" | "koi8-r" | "sjis" | "sjis-win" | "uhc" | "windows-1251" | "windows-1252" | "other";
+    default_unsubscribe_link?: boolean;
+    social_bar?: boolean;
+    footer?: string;
+};
+export type TCampaignAudience = {
+    list_id?: number;
+    segment_id?: number;
+};
+export type TCampaignTracking = {
+    opens?: boolean;
+    clicks_html?: boolean;
+    clicks_text?: boolean;
+    additional_params?: string;
+};
+export type TCampaignSendTestType = "merged" | "separated";
+export type TCampaignSendTestReturn = {
+    email: string;
+    type: TCampaignSendTestType;
+    object: string;
+    sent: boolean;
+};
+export type TCampaignLinks = {
+    id: number;
+    status: string;
+    link_to: string;
+};
+export type TCampaignLogs = {
+    id: number;
+    contact_id: number;
+    email: string;
+    type: TCampaignLogType;
+    timestamp: number;
+    occurrences: number;
+    clickthru_url: string;
+    user_agent: TCampaignUserAgent;
+};
+export interface TCampaignLogsExport extends TExport {
+    campaign_id: number;
+}
+export type TCampaignLogType = TApiV2LogType;
+export type TCampaignUserAgent = TApiV2LogUserAgent;
+export type TCampaignReport = {
+    active_emails: number;
+    bounces: number;
+    bounce_rate: number;
+    bounces_address_changed: number;
+    bounces_challenge_response: number;
+    bounces_dns_failure: number;
+    bounces_full_mailbox: number;
+    bounces_hard: number;
+    bounces_mail_blocked: number;
+    bounces_soft: number;
+    bounces_transient: number;
+    clicks: number;
+    click_rate: number;
+    clickthru_rate: number;
+    forwards: number;
+    implied_opens: number;
+    opens: number;
+    open_rate: number;
+    spams: number;
+    unique_clicks: number;
+    unique_opens: number;
+    unopens: number;
+    unopen_rate: number;
+    unsubscribes: number;
+    unsubscribe_rate: number;
+    spam_rate: number;
+    sent_emails: number;
+    sent_rate: number;
+};
+export type TCampaignLinkReport = {
+    id: number;
+    link: string;
+    unique: number;
+    total: number;
+    unique_rate: number;
+    total_rate: number;
+};

package/dist/esm/models/contact/index.d.ts

@@ -0,0 +1,16 @@
+import { TContactCustomAttribute, TContactModel } from "./types";
+export declare class ContactModel {
+    readonly id: number;
+    readonly email: string;
+    readonly status: string;
+    readonly subscribed_on: number;
+    readonly last_bounce_type: string;
+    readonly bounces_count: number;
+    custom_attributes: TContactCustomAttribute[];
+    tags: string[];
+    interests: string[];
+    constructor(params: TContactModel);
+    toJson(): any;
+    set<T extends keyof this>(property: T, value: this[T]): void;
+}
+export * from "./types";

package/dist/esm/models/contact/types.d.ts

@@ -0,0 +1,15 @@
+export type TContactModel = {
+    id: number;
+    email: string;
+    status: string;
+    subscribed_on: number;
+    last_bounce_type: string;
+    bounces_count: number;
+    custom_attributes: TContactCustomAttribute[];
+    tags: string[];
+    interests: string[];
+};
+export type TContactCustomAttribute = {
+    name: string;
+    value: string;
+};

package/dist/esm/models/customer/index.d.ts

@@ -0,0 +1,11 @@
+import { TStripeSubscription } from "./types";
+export declare class CustomerModel {
+    readonly id: string;
+    readonly language: string;
+    readonly profile: any;
+    readonly subscriptions: TStripeSubscription[];
+    constructor({ id, language, profile, subscriptions }: CustomerModel);
+    toJson(): any;
+    set<T extends keyof this>(property: T, value: this[T]): void;
+}
+export * from "./types";

package/dist/esm/models/customer/types.d.ts

@@ -0,0 +1,29 @@
+import { TAccountLimits } from "../account/types";
+export type TStripeSubscription = {
+    currentPeriodEnd: number;
+    id: string;
+    items: TStripeSubscriptionItem[];
+    status: string;
+    legacy: boolean;
+    [key: string]: any;
+};
+export type TStripeSubscriptionItem = {
+    id: string;
+    price: TStripeSubscriptionPrice;
+};
+export type TStripeSubscriptionPrice = {
+    active: boolean;
+    currency: string;
+    id: string;
+    metadata: {
+        active: boolean;
+        added: string;
+        category: "growth" | "free" | "premium";
+        id: string;
+        updated: string;
+        usage_limits: TAccountLimits;
+    };
+    name: string;
+    product: string;
+    unit_amount: number;
+};

package/dist/esm/models/emailAPI/index.d.ts

@@ -0,0 +1,35 @@
+import { TEmailLog, TEmailReport } from "../../factories";
+import { TGetEmailReport, TListEmailLogs } from "../../services/emailAPI";
+import { TGenericListReturn } from "../../types";
+import { TEmail, TEmailAttachement } from "./types";
+export declare class Email {
+    readonly id: number;
+    readonly email: string;
+    readonly sender: {
+        id: string;
+        name: string;
+        email: string;
+    };
+    readonly content: {
+        subject: string;
+        template_id: number;
+        html: string;
+        text: string;
+    };
+    readonly tracking: {
+        opens: boolean;
+        clicks_html: boolean;
+        clicks_text: boolean;
+    };
+    readonly additional_headers: any[];
+    readonly group_id: number;
+    readonly tags: string[];
+    readonly queue_id: number;
+    readonly attachments: TEmailAttachement[];
+    constructor(params: TEmail);
+    toJson(): any;
+    set<T extends keyof this>(property: T, value: this[T]): void;
+    listLogs({ ...options }: TListEmailLogs): Promise<TGenericListReturn<TEmailLog>>;
+    getReport({ ...options }: TGetEmailReport): Promise<TEmailReport[]>;
+}
+export * from "./types";

package/dist/esm/models/emailAPI/types.d.ts

@@ -0,0 +1,41 @@
+export type TEmail = {
+    id: number;
+    email: string;
+    sender: {
+        id: string;
+        name: string;
+        email: string;
+    };
+    content: {
+        subject: string;
+        template_id: number;
+        html: string;
+        text: string;
+    };
+    tracking: {
+        opens: boolean;
+        clicks_html: boolean;
+        clicks_text: boolean;
+    };
+    additional_headers: any[];
+    group_id: number;
+    tags: string[];
+    queue_id: number;
+    attachments: TEmailAttachement[];
+};
+export type TEmailAttachement = {
+    filename: string;
+    type: EEmailAttachementTypes;
+    content: string;
+};
+export declare enum EEmailAttachementTypes {
+    "csv" = "csv",
+    "doc" = "doc",
+    "docx" = "docx",
+    "calendar" = "calendar",
+    "jpeg" = "jpeg",
+    "pdf" = "pdf",
+    "png" = "png",
+    "xls" = "xls",
+    "xlsx" = "xlsx"
+}

package/dist/esm/models/exports/index.d.ts

@@ -0,0 +1 @@
+export * from "./types";

package/dist/esm/models/exports/types.d.ts

@@ -0,0 +1,20 @@
+export type TExport = {
+    id: string;
+    status: "pending" | "ready" | "deleted" | "failed";
+    description: string;
+    requested_by: {
+        id: number;
+        email: string;
+    };
+    created_on: number;
+    expires_on: number;
+    progress: number;
+};
+export type TExportsDownload = {
+    expires_on: number;
+    url: string;
+};
+export interface TExports extends TExport {
+    type: "contactsexport" | "campaignlogexport" | "campaignsreportsexport" | "suppressedemailsexport" | "listlogsexport" | "unknown";
+    payload: any;
+}

package/dist/esm/models/form/index.d.ts

@@ -0,0 +1,30 @@
+import { EApiLanguages } from "../../types";
+import { TFormModel } from "./types";
+export declare class FormModel {
+    readonly id: number;
+    name: string;
+    readonly status: string;
+    content: {
+        linked: string;
+        embedded: string;
+    };
+    language: EApiLanguages;
+    readonly created_on: number;
+    readonly last_updated_on: number;
+    url: {
+        linked: string;
+        embedded: string;
+    };
+    readonly thumbnail_url: string;
+    redirections: {
+        after_opt_in: string;
+        after_double_opt_in: string;
+        after_opt_out: string;
+    };
+    list_id: number;
+    double_opt_in: boolean;
+    constructor({ id, name, status, content, language, created_on, last_updated_on, url, thumbnail_url, redirections, list_id, double_opt_in, }: TFormModel);
+    toJson(): any;
+    set<T extends keyof this>(property: T, value: this[T]): void;
+}
+export * from "./types";

package/dist/esm/models/form/types.d.ts

@@ -0,0 +1,25 @@
+import { EApiLanguages } from "../../types";
+export type TFormModel = {
+    readonly id: number;
+    name: string;
+    readonly status: string;
+    content: {
+        linked: string;
+        embedded: string;
+    };
+    language: EApiLanguages;
+    readonly created_on: number;
+    readonly last_updated_on: number;
+    url: {
+        linked: string;
+        embedded: string;
+    };
+    readonly thumbnail_url: string;
+    redirections: {
+        after_opt_in: string;
+        after_double_opt_in: string;
+        after_opt_out: string;
+    };
+    list_id: number;
+    double_opt_in: boolean;
+};

package/dist/esm/models/index.d.ts

@@ -0,0 +1,12 @@
+export * from "./account";
+export * from "./campaign";
+export * from "./contact";
+export * from "./customer";
+export * from "./emailAPI";
+export * from "./exports";
+export * from "./form";
+export * from "./list";
+export * from "./sender";
+export * from "./systemEmails";
+export * from "./templates";
+export * from "./user";

package/dist/esm/models/list/index.d.ts

@@ -0,0 +1,18 @@
+import { EApiLanguages } from "../../types";
+import { TListModel, TListPages, TListRedirections, TListSender, TListWebhook } from "./types";
+export declare class ListModel {
+    readonly id: number;
+    name: string;
+    readonly status: string;
+    readonly policy_accepted: string;
+    language: EApiLanguages;
+    readonly created_on: number;
+    default_sender: TListSender;
+    redirections: TListRedirections;
+    pages: TListPages;
+    webhook: TListWebhook;
+    constructor(params: TListModel);
+    toJson(): any;
+    set<T extends keyof this>(property: T, value: this[T]): void;
+}
+export * from "./types";

package/dist/esm/models/list/types.d.ts

@@ -0,0 +1,63 @@
+import { EApiLanguages, TApiV2LogType, TApiV2LogUserAgent } from "../../types";
+export type TListModel = {
+    id: number;
+    name: string;
+    status: string;
+    policy_accepted: string;
+    language: EApiLanguages;
+    created_on: number;
+    default_sender: TListSender;
+    redirections: TListRedirections;
+    pages: TListPages;
+    webhook: TListWebhook;
+};
+export type TListSender = {
+    name: string;
+    email: string;
+};
+export type TListRedirections = {
+    after_opt_in: string;
+    after_double_opt_in: string;
+    after_opt_out: string;
+};
+export type TListPages = {
+    opt_in: string;
+    opt_out: string;
+    subscribe: string;
+    unsubscribe: string;
+};
+export type TListWebhook = {
+    url: string;
+    actions: "all" | "subscribe" | "unsubscribe" | "update" | "delete" | "spam" | "bounce" | "bounce_ac" | "bounce_cr" | "bounce_df" | "bounce_fm" | "bounce_hb" | "bounce_mb" | "bounce_sb" | "bounce_tr" | "bounce_ar";
+};
+export type TListReport = {
+    active_contacts: number;
+    pending_contacts: number;
+    invalid_contacts: number;
+    unsubscribed_contacts: number;
+    flagged_contacts: number;
+    deleted_contacts: number;
+    sent_emails: number;
+    open_rate: number;
+    bounce_rate: number;
+    click_rate: number;
+    clickthru_rate: number;
+    unsubscribe_rate: number;
+    spam_rate: number;
+};
+export type TListLog = {
+    id: number;
+    contact_id: number;
+    email: string;
+    type: TListLogType;
+    timestamp: number;
+    occurrences: number;
+    user_agent: TListLogUserAgent;
+    campaign_id: number;
+    clickthru_url: string;
+    dsn_message: string;
+    unsub_reason: string;
+    subscription_type: "resubscribe" | "subscription_confirmation";
+};
+export type TListLogType = TApiV2LogType;
+export type TListLogUserAgent = TApiV2LogUserAgent;