SDK Reference

    @proveanything/smartlinks

    npm install @proveanything/smartlinks
    View on npm →

    Namespaces

    Messaging & Audience

    broadcasts

    Define broadcast campaigns; append recipients/events; analytics and CRUD.

    12 functions13 types

    preview

    public
    preview(collectionId: string,
    id: string,
    body: ) → Promise<BroadcastPreviewResponse>

    send

    public
    send(collectionId: string,
    id: string,
    body:  = {}) → Promise<

    sendTest

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

    sendManual

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

    append

    public
    append(collectionId: string,
    body: ) → Promise<>

    appendBulk

    public
    appendBulk(collectionId: string,
    body: ) → 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>

    recipients

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