JavaScript/TypeScript SDK for Bodhveda

Official JavaScript/TypeScript SDK for Bodhveda.

It offers a simple and type-safe way to work with Bodhveda APIs in both browser and server environments.

Index

• Installation
• Quick Start
• Notifications
• Recipients
  • Recipient Notifications
  • Recipient Preferences
• License

Installation

npm install bodhveda

Quick Start

import { Bodhveda } from "bodhveda";

const bodhveda = new Bodhveda("YOUR_API_KEY");

// Create a recipient
await bodhveda.recipients.create({
    id: "user-123",
    name: "Elon Zuckerberg",
});

// Send a notification
await bodhveda.notifications.send({
    recipient_id: "user-123",
    payload: { message: "Hello, world!" },
});

// List notifications for a recipient
const notifications = await bodhveda.recipients.notifications.list("user-123");

Notifications

Send a notification

Send a notification to a recipient or broadcast to a target.

await bodhveda.notifications.send({
    recipient_id: "user-123",
    payload: { message: "Hello, world!" },
});

Recipients

Create a recipient

Create a new recipient.

await bodhveda.recipients.create({
    id: "user-123",
    name: "Alice",
});

Create multiple recipients (batch)

Create multiple recipients in a single request.

await bodhveda.recipients.createBatch({
    recipients: [
        { id: "user-1", name: "Alice" },
        { id: "user-2", name: "Bob" },
    ],
});

Get a recipient

Retrieve details of a recipient by ID.

const recipient = await bodhveda.recipients.get("user-123");

Update a recipient

Update recipient details.

await bodhveda.recipients.update("user-123", { name: "Alice Updated" });

Delete a recipient

Delete a recipient by ID.

await bodhveda.recipients.delete("user-123");

Recipient Notifications

List notifications

List notifications for a recipient.

const notifications = await bodhveda.recipients.notifications.list("user-123");

Get unread notification count

Get the count of unread notifications for a recipient.

const { unread_count } = await bodhveda.recipients.notifications.unreadCount(
    "user-123"
);

Update notification state

Update the state (e.g., mark as read) of notifications for a recipient.

await bodhveda.recipients.notifications.updateState("user-123", {
    ids: [1, 2, 3],
    state: { read: true },
});

Delete notifications

Delete notifications for a recipient.

await bodhveda.recipients.notifications.delete("user-123", {
    ids: [1, 2, 3],
});

Recipient Preferences

List preferences

List all preferences for a recipient.

const preferences = await bodhveda.recipients.preferences.list("user-123");

Set a preference

Set a notification preference for a recipient.

await bodhveda.recipients.preferences.set("user-123", {
    target: { channel: "email", topic: "news", event: "daily" },
    state: { enabled: true },
});

Check a preference

Check the state of a specific preference for a recipient.

const result = await bodhveda.recipients.preferences.check("user-123", {
    target: { channel: "email", topic: "news", event: "daily" },
});

License

MIT