@cakemail-org/ui-components-v2 2.0.38

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

@@ -0,0 +1,14 @@
+import { TSenderModel } from "./types";
+export declare class SenderModel {
+    readonly id: number;
+    name: string;
+    readonly email: string;
+    confirmed: boolean;
+    confirmed_on: number;
+    language: string;
+    last_confirmation_sent_on: number;
+    constructor({ id, name, email, confirmed, confirmed_on, language, last_confirmation_sent_on }: TSenderModel);
+    toJson(): any;
+    set<T extends keyof this>(property: T, value: this[T]): void;
+}
+export * from "./types";

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

@@ -0,0 +1,9 @@
+export type TSenderModel = {
+    readonly id: number;
+    name: string;
+    readonly email: string;
+    confirmed: boolean;
+    confirmed_on: number;
+    language: string;
+    last_confirmation_sent_on: number;
+};

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

@@ -0,0 +1,12 @@
+import { TSystemEmail } from "./types";
+export declare class SystemEmailsModel {
+    account_confirm?: TSystemEmail[];
+    user_confirm?: TSystemEmail[];
+    sender_confirm?: TSystemEmail[];
+    password_reset?: TSystemEmail[];
+    contact_double_opt_in?: TSystemEmail[];
+    constructor({ account_confirm, user_confirm, sender_confirm, password_reset, contact_double_opt_in, }: Partial<SystemEmailsModel>);
+    toJson(): any;
+    set<T extends keyof this>(property: T, value: this[T]): void;
+}
+export * from "./types";

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

@@ -0,0 +1,17 @@
+import { EApiLanguages } from "../../types";
+export type TSystemEmailsModel = {
+    account_confirm?: TSystemEmail[];
+    user_confirm?: TSystemEmail[];
+    sender_confirm?: TSystemEmail[];
+    password_reset?: TSystemEmail[];
+    contact_double_opt_in?: TSystemEmail[];
+};
+export type TSystemEmail = {
+    language: EApiLanguages;
+    template?: {
+        id: number;
+    };
+    sender?: {
+        id: string;
+    };
+};

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

@@ -0,0 +1,40 @@
+import { TDeleteApiResource, TNumStr } from "../../types/generic";
+import { TListTemplateModel, TTemplateContent, TTemplateModel, TTemplateSharedAccount, TTemplateSharePayload } from "./types";
+export declare class ListTemplateModel {
+    readonly id: TNumStr;
+    is_owner: boolean;
+    name: string;
+    readonly created_on: number;
+    readonly updated_on: number;
+    tags: string[];
+    sharing?: {
+        shared: boolean;
+    };
+    thumbnail_url: string;
+    description: string;
+    constructor(params: Partial<TListTemplateModel>);
+    toJson(): any;
+    set<T extends keyof this>(property: T, value: this[T]): void;
+    get(): Promise<TemplateModel>;
+    delete(): Promise<TDeleteApiResource>;
+    render({ brandAccountId }: {
+        brandAccountId?: TNumStr;
+    }): Promise<string>;
+    share({ accounts, everyone, automatic }?: TTemplateSharePayload): Promise<void>;
+    unshare(): Promise<void>;
+}
+export declare class TemplateModel extends ListTemplateModel {
+    content: TTemplateContent;
+    sharing: {
+        accounts: TTemplateSharedAccount[];
+        shared: boolean;
+        automatic: boolean;
+    };
+    constructor(params: Partial<TTemplateModel>);
+    toJson(): any;
+    set<T extends keyof this>(property: T, value: this[T]): void;
+    update(template: Partial<TTemplateModel>): Promise<{
+        data: TemplateModel;
+    }>;
+}
+export * from "./types";

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

@@ -0,0 +1,41 @@
+import { TNumStr } from "../../types/generic";
+export type TListTemplateModel = {
+    id: TNumStr;
+    name: string;
+    created_on: number;
+    updated_on: number;
+    tags: string[];
+    sharing?: {
+        shared: boolean;
+    };
+    thumbnail_url: string;
+    description: string;
+    is_owner: boolean;
+};
+export type TTemplateContent = {
+    type?: "html" | "text" | "bee" | "custom";
+    subject?: string;
+    html?: string;
+    text?: string;
+    json?: any;
+};
+export interface TTemplateModel extends TListTemplateModel {
+    content: TTemplateContent;
+    sharing: {
+        accounts: TTemplateSharedAccount[];
+        shared: boolean;
+        automatic: boolean;
+    };
+}
+export interface TTemplateSharedAccount extends TTemplateShareAccounPayload {
+    company_name: string;
+}
+export type TTemplateShareAccounPayload = {
+    account_id: number;
+    visible: boolean;
+};
+export type TTemplateSharePayload = {
+    accounts?: TTemplateShareAccounPayload[];
+    everyone?: boolean;
+    automatic?: boolean;
+};

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

@@ -0,0 +1,21 @@
+import { TUserModel } from "./types";
+export declare class UserModel {
+    readonly id: number;
+    readonly email: string;
+    readonly status: string;
+    created_on: number;
+    last_activity_on: number;
+    expires_on: number;
+    first_name: string;
+    last_name: string;
+    title: string;
+    language: string;
+    timezone: string;
+    office_phone: string;
+    mobile_phone: string;
+    constructor({ id, email, status, created_on, last_activity_on, expires_on, first_name, last_name, title, language, timezone, office_phone, mobile_phone }: Partial<TUserModel>);
+    toJson(): any;
+    set<T extends keyof this>(property: T, value: this[T]): void;
+    update(): Promise<UserModel>;
+}
+export * from "./types";

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

@@ -0,0 +1,22 @@
+export type TUserModel = {
+    readonly id: number;
+    readonly email: string;
+    readonly status: string;
+    created_on: number;
+    last_activity_on: number;
+    expires_on: number;
+    first_name: string;
+    last_name: string;
+    title: string;
+    language: string;
+    timezone: string;
+    office_phone: string;
+    mobile_phone: string;
+};
+export type TUserModelUpdate = TUserModel & {
+    password?: {
+        current: string;
+        new: string;
+        password_strength_requirement: "VERY_WEAK" | "WEAK" | "MODERATE" | "STRONG" | "VERY_STRONG";
+    };
+};

package/dist/esm/services/accounts/index.d.ts

@@ -0,0 +1,22 @@
+import { TAccountModel, TCreateAccount } from "../../models/account/types";
+import { TNumStr } from "../../types";
+import { TGenericListLogsParams, TGenericListParams } from "../../types/services";
+export declare function whoAmi(): Promise<any>;
+export declare function getAccountReport({ ...options }: Pick<TGenericListLogsParams, "accountId" | "startTime" | "endTime">): Promise<any>;
+export declare function createAccount({ partnerId, account }: {
+    partnerId: TNumStr;
+    account: Partial<TCreateAccount>;
+}): Promise<any>;
+export declare function updateAccount({ account }: {
+    account: Partial<TAccountModel>;
+}): Promise<any>;
+export declare function listAccounts({ ...options }: TGenericListParams): Promise<any>;
+export declare function getAccount({ id }: {
+    id: TNumStr;
+}): Promise<any>;
+export declare function impersonateService({ id, byContext }: {
+    id: TNumStr;
+    byContext?: boolean;
+}): Promise<any>;
+export declare function logOutService(): Promise<any>;
+export * from "./types";

package/dist/esm/services/accounts/types.d.ts

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

package/dist/esm/services/auth/index.d.ts

@@ -0,0 +1,4 @@
+import { TLoginService } from "../../types/services";
+export declare function amILoggedInService(): Promise<any>;
+export declare function loginService({ ...options }: TLoginService): Promise<any>;
+export * from "./types";

package/dist/esm/services/auth/types.d.ts

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

package/dist/esm/services/automations/index.d.ts

@@ -0,0 +1,7 @@
+import { TAutomationStatsParam } from "../../factories/automations/types";
+import { TGenericListParams } from "../../types";
+export declare function getAutomationStats({ ...options }: TAutomationStatsParam): Promise<any>;
+export declare function list({ ...options }: TGenericListParams): Promise<any>;
+export declare function getAutomationExecutionsCount({ id }: {
+    id: string;
+}): Promise<any>;

package/dist/esm/services/billing/index.d.ts

@@ -0,0 +1,10 @@
+import { TNumStr } from "../../types";
+export declare function getCustomerProfile({ id, useImpersonationTree }: {
+    id: TNumStr;
+    useImpersonationTree?: boolean;
+}): Promise<any>;
+export declare function searchCustomerProfiles({ query }: {
+    query: string;
+    useImpersonationTree?: boolean;
+}): Promise<any>;
+export * from "./types";

package/dist/esm/services/billing/types.d.ts

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

package/dist/esm/services/brands/index.d.ts

@@ -0,0 +1,20 @@
+import { TNumStr } from "../../types";
+export declare function getBrand({ id, compiled }: {
+    id: TNumStr;
+    compiled: Boolean;
+}): Promise<any>;
+export declare function createBrand({ id, brand, query }: {
+    id: TNumStr;
+    brand?: any;
+    query?: any;
+}): Promise<any>;
+export declare function enrichProfile({ email }: {
+    email: string;
+}): Promise<any>;
+export declare function enrichOrganization({ domain }: {
+    domain: string;
+}): Promise<any>;
+export declare function enrichBrand({ domain }: {
+    domain: string;
+}): Promise<any>;
+export * from "./types";

package/dist/esm/services/brands/types.d.ts

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

package/dist/esm/services/campaigns/index.d.ts

@@ -0,0 +1,102 @@
+import { TCampaignUpdate } from "../../models/campaign/types";
+import { TGenericListLogsParams, TGenericListParams } from "../../types";
+export declare function listCampaigns({ useImpersonationTree, ...options }: TGenericListParams): Promise<any>;
+export declare function createCampaign({ campaign }: {
+    campaign: Partial<TCampaignUpdate>;
+}): Promise<any>;
+export declare function getCampaign({ id, revisionId }: {
+    id: number;
+    revisionId?: number;
+}): Promise<any>;
+export declare function deleteCampaign({ id }: {
+    id: number;
+}): Promise<any>;
+export declare function updateCampaign({ id, campaign }: {
+    id: number;
+    campaign: Partial<TCampaignUpdate>;
+}): Promise<any>;
+export declare function renderCampaign({ id, contactId }: {
+    id: number;
+    contactId?: number;
+}): Promise<any>;
+export declare function sendCampaignTest({ id, email, type }: {
+    id: number;
+    email: string;
+    type?: "merged" | "separated";
+}): Promise<any>;
+export declare function scheduleCampaign({ id, date, htmlEmpty }: {
+    id: number;
+    date: string;
+    htmlEmpty?: boolean;
+}): Promise<any>;
+export declare function unScheduleCampaign({ id }: {
+    id: number;
+}): Promise<any>;
+export declare function reScheduleCampaign({ id, date, htmlEmpty }: {
+    id: number;
+    date: string;
+    htmlEmpty?: boolean;
+}): Promise<any>;
+export declare function suspendCampaign({ id }: {
+    id: number;
+}): Promise<any>;
+export declare function resumeCampaign({ id }: {
+    id: number;
+}): Promise<any>;
+export declare function cancelCampaign({ id }: {
+    id: number;
+}): Promise<any>;
+export declare function archiveCampaign({ id }: {
+    id: number;
+}): Promise<any>;
+export declare function unArchiveCampaign({ id }: {
+    id: number;
+}): Promise<any>;
+export declare function getCampaignRevisions({ id, options }: {
+    id: number;
+    options: TGenericListParams;
+}): Promise<any>;
+export declare function getCampaignLinks({ id, options }: {
+    id: number;
+    options: TGenericListParams;
+}): Promise<any>;
+export declare function getCampaignLogs({ id, options }: {
+    id: number;
+    options: TGenericListLogsParams;
+}): Promise<any>;
+export declare function getCampaignLogsExports({ id, options }: {
+    id: number;
+    options: Omit<TGenericListParams, "filter" | "sort">;
+}): Promise<any>;
+export declare function createCampaignLogsExports({ id, description, filter }: {
+    id: number;
+    description?: string;
+    filter?: string;
+}): Promise<any>;
+export declare function downloadCampaignLogExport({ campaignId, exportId }: {
+    campaignId: number;
+    exportId: string;
+}): Promise<any>;
+export declare function getCampaignReport({ id }: {
+    id: number;
+}): Promise<any>;
+export declare function getCampaignLinksReport({ id, options }: {
+    id: number;
+    options: TGenericListLogsParams;
+}): Promise<any>;
+export declare function listCampaignsReportsExports({ options }: {
+    options: TGenericListParams;
+}): Promise<any>;
+export declare function getCampaignsReportsExport({ exportId }: {
+    exportId: string;
+}): Promise<any>;
+export declare function deleteCampaignsReportsExport({ exportId }: {
+    exportId: string;
+}): Promise<any>;
+export declare function createCampaignsReportsExport({ description }: {
+    description?: string;
+}): Promise<any>;
+export declare function downloadCampaignsReportsExport({ exportId }: {
+    exportId: string;
+}): Promise<any>;
+export * from "./types";

package/dist/esm/services/campaigns/types.d.ts

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

package/dist/esm/services/contacts/index.d.ts

@@ -0,0 +1,3 @@
+import { TListContacts } from "./types";
+export declare function listContacts({ listId, useImpersonationTree, ...options }: TListContacts): Promise<any>;
+export * from "./types";

package/dist/esm/services/contacts/types.d.ts

@@ -0,0 +1,7 @@
+import { TGenericListParams } from "../../types/services";
+export type TListContacts = TGenericListParams & {
+    query?: string;
+    json?: any;
+    fiql?: string;
+    listId: number;
+};

package/dist/esm/services/domains/index.d.ts

@@ -0,0 +1,10 @@
+import { TNumStr } from "../../types";
+export declare function getDomainsService({ id }: {
+    id?: TNumStr;
+}): Promise<any>;
+export declare function isDomainValidService({ domain, useImpersonationTree, query }: {
+    domain: string;
+    useImpersonationTree?: boolean;
+    query?: any;
+}): Promise<any>;
+export * from "./types";

package/dist/esm/services/domains/types.d.ts

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

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

@@ -0,0 +1,10 @@
+import { TGenericListParams } from "../../types";
+import { TGetEmailActivitySummary, TGetEmailReport, TListEmailLogs } from "./types";
+export declare function lisTEmailTags({ ...options }: TGenericListParams): Promise<any>;
+export declare function listEmailLogs({ ...options }: TListEmailLogs): Promise<any>;
+export declare function getEmailReport({ ...options }: TGetEmailReport): Promise<any>;
+export declare function getEmailActivitySummary({ ...options }: TGetEmailActivitySummary): Promise<any>;
+export declare function getEmail({ id }: {
+    id: string;
+}): Promise<any>;
+export * from "./types";

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

@@ -0,0 +1,60 @@
+import { TGenericListLogsParams, TGenericListParams, TTimeInterval } from "../../types";
+export declare enum EEmailLogTypeParam {
+    "all" = "all",
+    "submitted" = "submitted",
+    "rejected" = "rejected",
+    "error" = "error",
+    "queued" = "queued",
+    "delivered" = "delivered",
+    "open" = "open",
+    "click" = "click",
+    "bounce" = "bounce",
+    "unsubscribe" = "unsubscribe",
+    "global_unsubscribe" = "global_unsubscribe",
+    "spam" = "spam"
+}
+export type TListEmailLogs = Omit<TGenericListParams, "withCount" | "filter"> & Omit<TGenericListLogsParams, "cursor"> & {
+    logType?: EEmailLogTypeParam;
+    emailId?: string;
+    isoTime?: boolean;
+    tags?: any;
+    providers?: any;
+};
+export type TGetEmailReport = {
+    interval?: TTimeInterval;
+    isoTime?: boolean;
+    accountId?: number;
+    startTime?: number;
+    endTime?: number;
+    tags?: any;
+    providers?: any;
+};
+export declare enum EEmailSummaryEngagement {
+    "click" = "click",
+    "open" = "open",
+    "none" = "none",
+    "open_not_click" = "open_not_click"
+}
+export type TGetEmailActivitySummary = {
+    emailId?: string;
+    engagement?: EEmailSummaryEngagement;
+    status?: "submitted" | "delivered" | "queued" | "rejected" | "error" | "bounced" | "spam" | "unsubscribed" | "global_unsubscribed" | "other";
+    isoTime?: boolean;
+    tags?: any;
+    providers?: any;
+    email?: string;
+} & Omit<TGenericListParams, "filter" | "withCount"> & Omit<TGenericListLogsParams, "cursor">;
+export declare enum EEmailProviders {
+    outlook = "Outlook",
+    gmail = "Gmail",
+    proton = "Proton",
+    aol = "AOL",
+    yahoo = "Yahoo",
+    icloud = "iCloud",
+    videotron = "Videotron",
+    rogers = "Rogers",
+    bell = "Bell Canada",
+    comcast = "Comcast",
+    other = "Other",
+    unknown = "unknown"
+}

package/dist/esm/services/forms/index.d.ts

@@ -0,0 +1,6 @@
+import { TGenericListParams } from "../../types";
+export declare function listForms({ useImpersonationTree, ...options }: TGenericListParams): Promise<any>;
+export declare function getForm({ id }: {
+    id: string;
+}): Promise<any>;
+export * from "./types";

package/dist/esm/services/forms/types.d.ts

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

package/dist/esm/services/hidden/index.d.ts

@@ -0,0 +1,3 @@
+import { TRequestSupportService } from "./types";
+export declare function requestSupportService({ ...requestOptions }: TRequestSupportService): Promise<any>;
+export declare function connectToZendeskSupportService(): Promise<any>;

package/dist/esm/services/hidden/types.d.ts

@@ -0,0 +1,5 @@
+export type TRequestSupportService = {
+    type: 'upgrade' | 'downgrade' | 'support' | 'induction';
+    message: string;
+    subject?: string;
+};

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

@@ -0,0 +1,15 @@
+export * from "./accounts";
+export * from "./auth";
+export * from "./billing";
+export * from "./brands";
+export * from "./campaigns";
+export * from "./contacts";
+export * from "./domains";
+export * from "./emailAPI";
+export * from "./forms";
+export * from "./hidden";
+export * from "./lists";
+export * from "./senders";
+export * from "./systemEmails";
+export * from "./templates";
+export * from "./users";

package/dist/esm/services/lists/index.d.ts

@@ -0,0 +1,13 @@
+import { TGenericListLogsParams, TGenericListParams } from "../../types";
+export declare function listList({ ...options }: TGenericListParams): Promise<any>;
+export declare function getList({ id }: {
+    id: number;
+}): Promise<any>;
+export declare function getListReport({ id }: {
+    id: number;
+}): Promise<any>;
+export declare function getListLogs({ id, options }: {
+    id: number;
+    options?: TGenericListLogsParams;
+}): Promise<any>;
+export * from "./types";

package/dist/esm/services/lists/types.d.ts

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

package/dist/esm/services/senders/index.d.ts

@@ -0,0 +1,9 @@
+import { TNumStr } from "../../types";
+import { TGenericListParams } from "../../types/services";
+export declare function listSenders({ useImpersonationTree, ...options }: TGenericListParams & {
+    useImpersonationTree?: boolean;
+}): Promise<any>;
+export declare function getSender({ id }: {
+    id: TNumStr;
+}): Promise<any>;
+export * from "./types";

package/dist/esm/services/senders/types.d.ts

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

package/dist/esm/services/systemEmails/index.d.ts

@@ -0,0 +1,5 @@
+import { TSystemEmailsModel } from "../../models/systemEmails";
+export declare function listSystemEmails({}?: {}): Promise<any>;
+export declare function updateSystemEmails({ systemEmails }: {
+    systemEmails: TSystemEmailsModel;
+}): Promise<any>;

package/dist/esm/services/templates/index.d.ts

@@ -0,0 +1,30 @@
+import { TemplateModel, TTemplateShareAccounPayload } from "../../models/templates";
+import { TNumStr } from "../../types/generic";
+import { TGenericListParams } from "../../types/services";
+export declare function listTemplates({ useImpersonationTree, ...options }: TGenericListParams): Promise<any>;
+export declare function getTemplate({ id }: {
+    id: TNumStr;
+}): Promise<any>;
+export declare function createTemplate({ template }: {
+    template: Partial<TemplateModel>;
+}): Promise<any>;
+export declare function updateTemplate({ id, template }: {
+    id: TNumStr;
+    template: Partial<TemplateModel>;
+}): Promise<any>;
+export declare function deleteTemplate({ id }: {
+    id: TNumStr;
+}): Promise<any>;
+export declare function renderTemplate({ id, brandAccountId }: {
+    id: TNumStr;
+    brandAccountId?: TNumStr;
+}): Promise<any>;
+export declare function shareTemplate({ id, accounts, everyone, automatic }: {
+    id: TNumStr;
+    accounts?: TTemplateShareAccounPayload[];
+    everyone?: boolean;
+    automatic?: boolean;
+}): Promise<any>;
+export declare function unshareTemplate({ id }: {
+    id: TNumStr;
+}): Promise<any>;

package/dist/esm/services/templates/types.d.ts

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

package/dist/esm/services/users/index.d.ts

@@ -0,0 +1,11 @@
+import { TUserModelUpdate } from "../../models";
+import { TGenericListParams } from "../../types";
+export declare function listUsers({ useImpersonationTree, ...options }: TGenericListParams): Promise<any>;
+export declare function getUser({ id }: {
+    id: string;
+}): Promise<any>;
+export declare function updateUser({ id, data }: {
+    id: number;
+    data: TUserModelUpdate;
+}): Promise<any>;
+export * from "./types";

package/dist/esm/services/users/types.d.ts

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

package/dist/esm/stories/assets/SignInUp.d.ts

@@ -0,0 +1,4 @@
+import React from "react";
+export declare function SignInUp({ submitForm }: {
+    submitForm: Function;
+}): React.JSX.Element;

package/dist/esm/stories/assets/app.d.ts

@@ -0,0 +1,2 @@
+import React from "react";
+export declare function App({ children }: any): React.JSX.Element;

package/dist/esm/types/api.d.ts

@@ -0,0 +1,19 @@
+export type TApiV2LogType = "clickthru" | "click" | "open" | "bounce" | "bounce_ac" | "bounce_cr" | "bounce_df" | "bounce_fm" | "bounce_hb" | "bounce_mb" | "bounce_sb" | "bounce_tr" | "bounce_ar" | "forward" | "skipped" | "spam" | "subscribe" | "unsubscribe" | "view" | "share" | "in_queue" | "generating" | "received" | "sent" | "schedule" | "update" | "global_unsubscribe" | "unsub_reason" | "other" | "auto_responder";
+export type TApiV2LogUserAgent = {
+    ip: string;
+    os: {
+        family: string;
+        version: string;
+    };
+    browser: {
+        family: string;
+        version: string;
+    };
+    device: {
+        family: string;
+        brand: string;
+        model: string;
+    };
+    is_bot: boolean;
+    raw: string;
+};