SDK Reference

    @proveanything/smartlinks

    npm install @proveanything/smartlinks
    View on npm →

    Namespaces

    Messaging & Audience

    segments

    Define dynamic/static audience segments; estimate and list recipients; schedule calculations.

    7 functions6 types

    calculate

    public
    calculate(collectionId: string,
    id: string) → Promise<>

    recipients

    public
    recipients(collectionId: string,
    id: string,
    query: { limit?: number; offset?: number } = {}) → Promise<>

    create

    public
    create(collectionId: string,
    body: Omit<, 'id' | 'collectionId' | 'createdAt'>) → Promise<>

    list

    public
    list(collectionId: string,
    query:  = {}) → Promise<>

    get

    public
    get(collectionId: string,
    id: string) → Promise<>

    update

    public
    update(collectionId: string,
    id: string,
    body: Partial<Omit<, 'id' | 'collectionId' | 'createdAt'>>) → Promise<>

    remove

    public
    remove(collectionId: string,
    id: string) → Promise<void>