@orchestree/developer

Developer tools and API management for Orchestree. Create webhooks, manage sandboxes, monitor API usage, and test endpoints.

Installation

npm install @orchestree/developer

Quick Start

const { DeveloperClient } = require('@orchestree/developer');

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

// Create a webhook
const webhook = await client.createWebhook({
  url: 'https://your-server.com/webhook',
  events: ['user.created', 'order.completed'],
});

// Test endpoint
const testResult = await client.testEndpoint(
  'https://api.example.com/endpoint',
  { test: true }
);

// Get API usage
const usage = await client.getAPIUsage({
  days: 30,
});

// Create sandbox
const sandbox = await client.createSandbox({
  name: 'Development Sandbox',
});

// Get webhook logs
const logs = await client.getWebhookLogs(webhook.id, { limit: 50 });

API Reference

DeveloperClient

createWebhook(webhookDef)

Create a webhook.

const webhook = await client.createWebhook({
  url: 'https://webhook.example.com/events',
  events: ['*.created', '*.updated'],
  active: true,
});

listWebhooks(filters)

List all webhooks.

const webhooks = await client.listWebhooks({ active: true });

testEndpoint(endpoint, payload)

Test an API endpoint.

const result = await client.testEndpoint(
  'https://api.example.com/test',
  { data: 'test' }
);

getAPIUsage(filters)

Get API usage statistics.

const usage = await client.getAPIUsage({
  startDate: '2024-04-01',
  endDate: '2024-04-30',
});

createSandbox(sandboxDef)

Create a sandbox environment.

const sandbox = await client.createSandbox({
  name: 'Testing',
  expiresAt: '2024-05-01',
});

getWebhookLogs(webhookId, filters)

Get webhook execution logs.

const logs = await client.getWebhookLogs(webhook.id, {
  limit: 100,
  status: 'failed',
});

License

MIT