SDK Documentation

const vaults = await client.vaults.list();
console.log(vaults);

const vault = await client.vaults.get('vault-123');
console.log('Vault name:', vault.name);

const vault = await client.vaults.create({
  name: 'My Notes',
  description: 'Personal knowledge base',
});
console.log('Created vault:', vault.id);

const updated = await client.vaults.update('vault-123', {
  name: 'Updated Vault Name',
  description: null, // Clear description
});

await client.vaults.delete('vault-123');
console.log('Vault deleted');

// List all documents
const docs = await client.documents.list('vault-123');

// List documents in a specific directory
const notes = await client.documents.list('vault-123', 'notes/');

const result = await client.documents.get(
  'vault-123',
  'notes/hello.md'
);
console.log('Title:', result.document.title);
console.log('Content:', result.content);

const doc = await client.documents.put(
  'vault-123',
  'notes/hello.md',
  '# Hello World\n\nThis is my note.'
);
console.log('Document saved:', doc.path);

await client.documents.delete('vault-123', 'notes/old.md');
console.log('Document deleted');

const result = await client.documents.move(
  'vault-123',
  'drafts/post.md',
  'published/post.md',
  true // overwrite if exists
);
console.log(result.message);

const result = await client.documents.copy(
  'vault-123',
  'templates/meeting.md',
  'meetings/2024-02-14.md'
);
console.log(result.message);

// Basic search
const results = await client.search.search({
  q: 'typescript tutorial',
});

// Search within a vault with filters
const filtered = await client.search.search({
  q: 'api documentation',
  vault: 'vault-123',
  tags: 'backend,nodejs',
  limit: 20,
  offset: 0,
});

console.log(`Found ${filtered.total} results`);
filtered.results.forEach(result => {
  console.log(`${result.path}: ${result.snippet}`);
});

const response = await client.ai.chat({
  message: 'Summarize my recent notes about TypeScript',
  vaultId: 'vault-123',
});

console.log('AI:', response.message.content);
console.log('Sources:', response.message.sources);
console.log('Session ID:', response.sessionId);

const sessions = await client.ai.listSessions();
sessions.forEach(session => {
  console.log(`${session.title} - ${session.createdAt}`);
});

const { session, messages } = await client.ai.getSession('session-123');
console.log('Session:', session.title);
messages.forEach(msg => {
  console.log(`${msg.role}: ${msg.content}`);
});

await client.ai.deleteSession('session-123');
console.log('Session deleted');

const result = await client.ai.summarize(
  'vault-123',
  'research/paper.md'
);

console.log('Summary:', result.summary);
console.log('Key Topics:', result.keyTopics.join(', '));
console.log('Tokens Used:', result.tokensUsed);

const keys = await client.apiKeys.list();
keys.forEach(key => {
  console.log(`${key.name}: ${key.prefix}... (active: ${key.isActive})`);
});

const key = await client.apiKeys.get('key-123');
console.log('Key name:', key.name);
console.log('Scopes:', key.scopes);

const key = await client.apiKeys.create({
  name: 'CI/CD Pipeline',
  scopes: ['documents:read', 'documents:write'],
  vaultId: 'vault-123',
  expiresAt: '2025-12-31',
});

console.log('API Key:', key.key);
console.log('Save this key securely - it cannot be retrieved again!');

// Deactivate a key
const updated = await client.apiKeys.update('key-123', {
  isActive: false,
});

console.log('Key deactivated:', updated.name);

await client.apiKeys.delete('key-123');
console.log('API key deleted');

const user = await client.user.me();
console.log('Email:', user.email);
console.log('Name:', user.name);
console.log('Role:', user.role);
console.log('Tier:', user.subscriptionTier);

const storage = await client.user.getStorage();
console.log('Total bytes:', storage.totalBytes);
console.log('Total MB:', (storage.totalBytes / 1024 / 1024).toFixed(2));

storage.vaults.forEach(vault => {
  console.log(`  ${vault.name}: ${vault.sizeBytes} bytes`);
});

const subscription = await client.subscription.get();
console.log('Tier:', subscription.tier);
console.log('Active:', subscription.isActive);
console.log('Expires:', subscription.expiresAt);
console.log('Usage:', subscription.usage);

const plans = await client.subscription.listPlans();
plans.forEach(plan => {
  console.log(`${plan.name}: $${plan.priceMonthly}/month`);
  console.log('Features:', plan.features);
});

const session = await client.subscription.createCheckoutSession(
  'pro',
  'https://myapp.com/settings/subscription'
);

// Redirect user to checkout URL
window.location.href = session.url;

await client.subscription.cancel('Switching to self-hosted');
console.log('Subscription cancelled');

const portal = await client.subscription.createPortalSession(
  'https://myapp.com/settings/subscription'
);

// Redirect to billing portal
window.location.href = portal.url;

const invoices = await client.subscription.listInvoices();
invoices.forEach(invoice => {
  console.log(`${invoice.date}: $${invoice.amount} - ${invoice.status}`);
});

const teams = await client.teams.list();
teams.forEach(team => {
  console.log(`${team.name} - Role: ${team.myRole}`);
});

const team = await client.teams.get('team-123');
console.log('Team:', team.name);
console.log('Description:', team.description);

const team = await client.teams.create({
  name: 'Engineering',
  description: 'Backend engineering team',
});
console.log('Team created:', team.id);

const updated = await client.teams.update('team-123', {
  description: 'Updated team description',
});

await client.teams.delete('team-123');
console.log('Team deleted');

const members = await client.teams.listMembers('team-123');
members.forEach(member => {
  console.log(`${member.name} (${member.email}) - ${member.role}`);
});

const member = await client.teams.updateMemberRole(
  'team-123',
  'user-456',
  'admin'
);
console.log('Updated role to:', member.role);

await client.teams.removeMember('team-123', 'user-456');
console.log('Member removed');

await client.teams.leave('team-123');
console.log('Left team');

const invitation = await client.teams.inviteMember(
  'team-123',
  'alice@example.com',
  'member'
);
console.log('Invitation sent:', invitation.id);

const invitations = await client.teams.listInvitations('team-123');
invitations.forEach(inv => {
  console.log(`${inv.email} - ${inv.status}`);
});

await client.teams.revokeInvitation('team-123', 'inv-456');
console.log('Invitation revoked');

const vault = await client.teams.createVault('team-123', {
  name: 'Shared Documentation',
  description: 'Team knowledge base',
});
console.log('Team vault created:', vault);

const vaults = await client.teams.listVaults('team-123');
console.log('Team vaults:', vaults);

const shares = await client.shares.list('vault-123', 'notes/doc.md');
shares.forEach(share => {
  console.log(`Token: ${share.token}, Views: ${share.viewCount}/${share.maxViews ?? '∞'}`);
});

const share = await client.shares.create(
  'vault-123',
  'notes/doc.md',
  {
    permission: 'view',
    password: 'secret123',
    expiresAt: '2025-12-31',
    maxViews: 10,
  }
);

console.log('Share URL:', `https://vault.example.com/share/${share.token}`);

await client.shares.revoke('vault-123', 'share-456');
console.log('Share link revoked');

const published = await client.publish.listMine('vault-123');
published.forEach(doc => {
  console.log(`${doc.slug}: ${doc.seoTitle}`);
  console.log(`  URL: https://vault.example.com/${doc.profileSlug}/${doc.slug}`);
});

const published = await client.publish.create(
  'vault-123',
  'blog/my-post.md',
  {
    slug: 'my-first-post',
    seoTitle: 'My First Blog Post',
    seoDescription: 'An introduction to my blog',
    ogImage: 'https://example.com/og-image.png',
  }
);

console.log('Published at:', `/${published.profileSlug}/${published.slug}`);

const updated = await client.publish.update(
  'vault-123',
  'blog/my-post.md',
  {
    seoTitle: 'Updated Title',
    seoDescription: 'Updated description',
  }
);

await client.publish.delete('vault-123', 'blog/my-post.md');
console.log('Document unpublished');

// List all connectors
const connectors = await client.connectors.list();

// List connectors for a specific vault
const vaultConnectors = await client.connectors.list('vault-123');

connectors.forEach(conn => {
  console.log(`${conn.name} (${conn.provider}): ${conn.direction}`);
});

const connector = await client.connectors.get('conn-123');
console.log('Provider:', connector.provider);
console.log('Direction:', connector.direction);
console.log('Last sync:', connector.lastSyncAt);

const connector = await client.connectors.create({
  provider: 'google_drive',
  name: 'My Google Drive',
  vaultId: 'vault-123',
  direction: 'bidirectional',
  config: {
    folderId: 'google-folder-id-here',
    credentials: { /* OAuth tokens */ },
  },
});

console.log('Connector created:', connector.id);

const updated = await client.connectors.update('conn-123', {
  name: 'Updated Connector Name',
  isActive: true,
});

await client.connectors.delete('conn-123');
console.log('Connector deleted');

const result = await client.connectors.test('conn-123');
if (result.success) {
  console.log('Connection successful');
} else {
  console.error('Connection failed:', result.error);
}

const result = await client.connectors.sync('conn-123');
console.log('Sync triggered:', result.jobId);

const logs = await client.connectors.logs('conn-123');
logs.forEach(log => {
  console.log(`${log.startedAt}: ${log.status}`);
  console.log(`  Added: ${log.itemsAdded}, Updated: ${log.itemsUpdated}, Failed: ${log.itemsFailed}`);
  if (log.error) console.log(`  Error: ${log.error}`);
});

const hooks = await client.hooks.list('vault-123');
hooks.forEach(hook => {
  console.log(`${hook.name}: ${hook.event} -> ${hook.action}`);
});

const hook = await client.hooks.create('vault-123', {
  name: 'Auto-tag new docs',
  event: 'document.create',
  action: 'auto-tag',
  config: { tags: ['new', 'unreviewed'] },
});
console.log('Hook created:', hook.id);

const updated = await client.hooks.update('vault-123', 'hook-456', {
  isActive: false,
});
console.log('Hook deactivated');

await client.hooks.delete('vault-123', 'hook-456');
console.log('Hook deleted');

const executions = await client.hooks.listExecutions('vault-123', 'hook-456');
executions.forEach(exec => {
  console.log(`${exec.createdAt}: ${exec.status}`);
  if (exec.error) console.log('Error:', exec.error);
});

const webhooks = await client.webhooks.list('vault-123');
webhooks.forEach(webhook => {
  console.log(`${webhook.url}: ${webhook.events.join(', ')}`);
});

const webhook = await client.webhooks.create('vault-123', {
  url: 'https://example.com/webhook',
  events: ['document.create', 'document.update', 'document.delete'],
  description: 'Sync to external system',
});

console.log('Webhook URL:', webhook.url);
console.log('Secret (save securely):', webhook.secret);

const updated = await client.webhooks.update('vault-123', 'webhook-456', {
  events: ['document.create', 'document.update'],
  isActive: true,
});

await client.webhooks.delete('vault-123', 'webhook-456');
console.log('Webhook deleted');

const deliveries = await client.webhooks.listDeliveries('vault-123', 'webhook-456');
deliveries.forEach(delivery => {
  console.log(`${delivery.createdAt}: ${delivery.status} (${delivery.statusCode})`);
  if (delivery.error) console.log('Error:', delivery.error);
});

const stats = await client.admin.getStats();
console.log('Total users:', stats.totalUsers);
console.log('Total documents:', stats.totalDocuments);
console.log('Total storage (GB):', (stats.totalStorageBytes / 1024 / 1024 / 1024).toFixed(2));

const data = await client.admin.getTimeseries('signups', '30d');
data.dataPoints.forEach(point => {
  console.log(`${point.date}: ${point.value}`);
});

const result = await client.admin.listUsers({
  tier: 'pro',
  limit: 50,
  offset: 0,
});

console.log(`Found ${result.total} pro users`);
result.users.forEach(user => {
  console.log(`${user.email} - ${user.subscriptionTier}`);
});

const user = await client.admin.getUser('user-123');
console.log('Email:', user.email);
console.log('Role:', user.role);
console.log('Tier:', user.subscriptionTier);
console.log('Storage:', user.storageUsage);

const updated = await client.admin.updateUser('user-123', {
  role: 'admin',
  subscriptionTier: 'business',
});

console.log('User updated:', updated.email);

const activity = await client.admin.getActivity(50);
activity.forEach(entry => {
  console.log(`${entry.timestamp}: ${entry.action} by ${entry.userEmail}`);
});

const summary = await client.admin.getSubscriptionSummary();
console.log('Free users:', summary.tiers.free);
console.log('Pro users:', summary.tiers.pro);
console.log('Business users:', summary.tiers.business);
console.log('Total MRR:', summary.totalMRR);

const health = await client.admin.getHealth();
console.log('Database:', health.database.status);
console.log('Redis:', health.redis.status);
console.log('Overall:', health.status);