Iterable API Client

TypeScript client library for the Iterable API.

Installation

npm install @iterable/api

Quick Start

import { IterableClient } from '@iterable/api';

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

const user = await client.getUserByEmail('user@example.com');

// Track event
await client.trackEvent({
  email: 'user@example.com',
  eventName: 'purchase',
  dataFields: { amount: 99.99 }
});

// Send email
await client.sendEmail({
  campaignId: 123456,
  recipientEmail: 'user@example.com'
});

Configuration

// From environment variables
const client = new IterableClient(createIterableConfig());

// Or configure directly
const client = new IterableClient({
  apiKey: 'your-api-key',
  baseUrl: 'https://api.iterable.com', // optional
  timeout: 30000, // optional
  debug: false // optional
});

Environment Variables

ITERABLE_API_KEY=your-api-key     # Required
ITERABLE_DEBUG=true               # Optional: Enable debug logging
LOG_LEVEL=info                    # Optional: Log level
LOG_FILE=./logs/iterable.log      # Optional: Log to file

Development

pnpm install
pnpm build          # Build with linting
pnpm test           # Run all tests
pnpm test:unit      # Unit tests only

# Integration tests (requires API key)
ITERABLE_API_KEY=your-key pnpm test:integration

License

This project is licensed under the MIT License - see the LICENSE file for details.