Last Updated: 1/27/2026

Changelog

All notable changes to the SDK.

[1.2.0] - 2024-01-15

Added

• Webhook support - Real-time event notifications

const webhook = await client.webhooks.create({
  url: 'https://yourapp.com/webhook',
  events: ['user.created', 'payment.completed'],
});

• Async iterators - Memory-efficient pagination

for await (const user of client.users.iterate()) {
  console.log(user.name);
}

:::tip Upgrade to 1.2.0 for improved memory usage when processing large datasets. :::

Changed

• Improved error messages with request IDs
• Default timeout increased from 10s to 30s

Fixed

• Rate limit retry logic now respects Retry-After header
• TypeScript types for nested objects

[1.1.0] - 2024-01-01

Added

• OAuth2 support - User authorization flow

const oauth = new OAuth2Client({
  clientId: process.env.CLIENT_ID!,
  redirectUri: 'https://yourapp.com/callback',
});

• Batch operations - Process multiple items at once

const results = await client.users.batchCreate([
  { name: 'Alice', email: 'alice@example.com' },
  { name: 'Bob', email: 'bob@example.com' },
]);

:::info Batch operations are limited to 100 items per request. :::

Changed

• Minimum Node.js version is now 18 (was 16)

Deprecated

• client.getUser() - Use client.users.get() instead

:::warning Deprecated methods will be removed in version 2.0. :::

[1.0.0] - 2023-12-01

Added

• Initial release
• User management API
• API key authentication
• TypeScript support

import { createClient } from '@example/sdk';
 
const client = createClient({
  apiKey: process.env.API_KEY!,
});

:::note This is the first stable release. APIs will follow semantic versioning. :::

Migration Guides

Upgrading to 1.2.0

No breaking changes. Update your package:

npm install @example/sdk@1.2.0

Upgrading to 1.1.0

Update Node.js to version 18:

nvm install 18
nvm use 18

Replace deprecated methods:

- const user = await client.getUser('user_123');
+ const user = await client.users.get('user_123');

:::danger Node.js 16 is no longer supported in version 1.1.0 and later. :::