@orchestree/inbox

Notification and message management for Orchestree. Manage feeds, triage notifications, and generate intelligent digests.

Installation

npm install @orchestree/inbox

Quick Start

const { InboxClient } = require('@orchestree/inbox');

const client = new InboxClient({
  apiKey: 'your-api-key',
});

// Get feed
const feed = await client.getFeed({ limit: 20 });

// Mark as read
await client.markRead(feed[0].id);

// Triage items
await client.triageItems([feed[1].id, feed[2].id], 'alerts');

// Generate digest
const digest = await client.generateDigest({ period: 'daily' });

API Reference

InboxClient

getFeed(filters)

Get inbox feed.

const items = await client.getFeed({
  priority: 'high',
  limit: 30,
});

markRead(itemId)

Mark item as read.

await client.markRead('item-123');

triageItems(itemIds, category)

Categorize multiple items.

await client.triageItems(['item-1', 'item-2'], 'important');

generateDigest(options)

Generate a digest of items.

const digest = await client.generateDigest({
  period: 'daily',
  includeCategories: ['alerts', 'updates'],
});

License

MIT