@everafter/ea-sdk/dist/index.d.ts

EverAfter SDK

import { Embed } from "./connect/Embed";
export declare class EverAfter {
    workspace: string;
    embed: Embed;
    constructor(workspace: string);
    /**
     * Returns the url to a customer's hub.
     *
     * @param {string} email   - The users email address.
     * @param {string} name    - The users name.
     * @param {string} [accountId]  - The account ID of which the user belongs to. If not provided, will try to mach account according to "Manage Users" table in account's persona screen
     * @param {string} [personaName] - The persona (role) name  of the user.If not provided, will try to mach persona according to "Manage Users" table in account's persona screen
     *
     * @returns {Promise<string>} - A url to the users customer hub
     */
    getEmbedUrl: (email: string, name: string, accountId?: string, personaName?: string) => Promise<string>;
    /**
     * ****** DEPRECATED, please use embedToElement method instead ******
     * In client side only!
     * generate an embed url and set it as the Iframe (fetched using the Iframe Id) src
     * @param {string} email   - The users email address.
     * @param {string} name    - The users name.
     * @param {string} iframeCssSelector - The css selector of the Iframe into which you would like to open the url
     * @param {string} [accountId]  - The account ID of which the user belongs to. If not provided, will try to mach account according to "Manage Users" table in account's persona screen
     * @param {string} [personaName] - The persona (role) name  of the user.If not provided, will try to mach persona according to "Manage Users" table in account's persona screen
     *
     * @returns {Promise<boolean>} - True if succeeded
     */
    EmbedToIframe: (email: string, name: string, iframeCssSelector: string, accountId?: string, personaName?: string) => Promise<boolean>;
    /**
     * In client side only!
     * generate an embed url and set it as the Iframe (fetched using the Iframe Id) src
     * @param {string} elementId  - ID of the element you want to replace with embedded Iframe.
     * @param {string} email      - The users email address.
     * @param {string} name       - The users name.
     * @param {object} [options]  - A dictionary of optional values
     * @param {string} [options.accountId] - The account ID of which the user belongs to. If not provided, will try to mach account according to "Manage Users" table in account's persona screen
     * @param {string} [options.personaName] - The persona (role) name  of the user.If not provided, will try to mach persona according to "Manage Users" table in account's persona screen
     * @param {string} [options.embedLocation] - Embed location
     * @param {string} [options.embedLocationUrl] - Embed location url is a full URL that user browsed to.
     *
     * @returns {Promise<boolean>} - True if succeeded
     */
    embedToElement: (elementId: string, email: string, name: string, options?: {
        accountId?: string | undefined;
        personaName?: string | undefined;
        embedLocation?: string | undefined;
        embedLocationUrl?: string | undefined;
        baseUrl?: string | undefined;
    } | undefined) => Promise<boolean>;
}