Welcome to {{company}}.
',\n variables: ['name', 'company'],\n});\n\n// Render template (preview without sending)\nconst rendered = await zyphr.templates.renderTemplate('template_id', {\n data: { name: 'Jane', company: 'Acme' },\n});\n\n// CRUD operations\nconst t = await zyphr.templates.getTemplate('template_id');\nawait zyphr.templates.updateTemplate('template_id', { subject: 'New subject' });\nawait zyphr.templates.deleteTemplate('template_id');\nconst all = await zyphr.templates.listTemplates(20, 0);\n```\n\n### Webhooks — `zyphr.webhooks`\n\nConfigure webhook endpoints, monitor deliveries, and manage circuit breakers.\n\n```ts\n// Create webhook\nconst webhook = await zyphr.webhooks.createWebhook({\n url: 'https://api.example.com/webhooks',\n events: ['email.delivered', 'email.bounced', 'subscriber.created'],\n active: true,\n});\n\n// Delivery management\nconst deliveries = await zyphr.webhooks.listWebhookDeliveries(\n 'webhook_id', 'failed', undefined, undefined, undefined, undefined, 20, 0\n);\nawait zyphr.webhooks.retryWebhookDelivery('webhook_id', 'delivery_id');\nawait zyphr.webhooks.bulkRetryWebhookDeliveries('webhook_id', {\n status: 'failed', startDate: new Date('2026-01-01'),\n});\n\n// Replay events\nawait zyphr.webhooks.replayWebhookEvents('webhook_id', {\n startDate: new Date('2026-01-01'), endDate: new Date('2026-01-02'),\n});\n\n// Testing\nawait zyphr.webhooks.sendWebhookTestEvent('webhook_id', {\n eventType: 'email.delivered',\n});\n\n// Metrics and health\nconst metrics = await zyphr.webhooks.getWebhookMetrics('webhook_id');\nconst circuit = await zyphr.webhooks.getWebhookCircuitState('webhook_id');\nawait zyphr.webhooks.closeWebhookCircuit('webhook_id');\n\n// Secret rotation\nawait zyphr.webhooks.rotateWebhookSecret('webhook_id');\n\n// Metadata\nconst eventTypes = await zyphr.webhooks.listWebhookEventTypes();\nconst versions = await zyphr.webhooks.listWebhookVersions();\nconst ips = await zyphr.webhooks.getWebhookIps();\n```\n\n### Topics — `zyphr.topics`\n\nGroup subscribers by interest for targeted notifications.\n\n```ts\n// Create topic\nawait zyphr.topics.createTopic({\n key: 'product-updates',\n name: 'Product Updates',\n description: 'New features and releases',\n});\n\n// Manage subscribers\nawait zyphr.topics.addTopicSubscribers('product-updates', {\n subscriberIds: ['sub_123', 'sub_456'],\n});\nawait zyphr.topics.removeTopicSubscribers('product-updates', {\n subscriberIds: ['sub_789'],\n});\n\n// CRUD\nconst topic = await zyphr.topics.getTopic('product-updates');\nawait zyphr.topics.updateTopic('product-updates', { name: 'Product News' });\nawait zyphr.topics.deleteTopic('old-topic');\nconst topics = await zyphr.topics.listTopics(50, 0);\n```\n\n### Devices — `zyphr.devices`\n\nRegister and manage push notification devices.\n\n```ts\n// Register device\nconst device = await zyphr.devices.registerDevice({\n userId: 'user_123',\n platform: 'ios',\n token: 'apns_token_xxx',\n metadata: { deviceName: 'iPhone 16 Pro' },\n});\n\n// List devices\nconst devices = await zyphr.devices.listDevices('user_123', 'ios', 20, 0);\n\n// Stats\nconst stats = await zyphr.devices.getDeviceStats();\n\n// Cleanup\nawait zyphr.devices.deleteDevice('device_id');\nawait zyphr.devices.deleteUserDevices('user_123');\n```\n\n### Authentication — `zyphr.auth.*`\n\nFull Auth-as-a-Service API for end-user authentication: registration, login, MFA, magic links, OAuth, and more.\n\n> **Important:** Auth endpoints use **Application-scoped** credentials (`X-Application-Key` + `X-Application-Secret`), which are distinct from the **Project-scoped** notification API key (`zy_live_*` / `zy_test_*`, sent as `Authorization: Bearer`). Create an application in the Zyphr dashboard first, then pass the credentials when constructing the client:\n\n```ts\nconst zyphr = new Zyphr({\n apiKey: process.env.ZYPHR_API_KEY!, // Project-scoped: zy_live_* / zy_test_*\n applicationKey: process.env.ZYPHR_APP_PUBLIC_KEY!, // Application-scoped public: za_live_pub_* / za_test_pub_*\n applicationSecret: process.env.ZYPHR_APP_SECRET_KEY!, // Application-scoped secret: za_live_sec_* / za_test_sec_*\n});\n```\n\n> Legacy `za_pub_*` / `za_sec_*` application-key prefixes are deprecated but still accepted.\n\n> **Common mistake:** `POST /v1/auth/register` creates a **platform account** (for the Zyphr dashboard). To register **end users** in your application, use `POST /v1/auth/users/register` via `zyphr.auth.registration.registerEndUser()`.\n\n```ts\n// Register an end user\nconst result = await zyphr.auth.registration.registerEndUser({\n email: 'new@example.com',\n password: 'SecureP@ss123',\n name: 'New User',\n});\n// result.data?.user — the new user\n// result.data?.tokens — { accessToken, refreshToken, expiresIn }\n\n// Login\nconst session = await zyphr.auth.login.loginEndUser({\n email: 'user@example.com',\n password: 'SecureP@ss123',\n});\n\n// User profile (requires end-user access token)\n// Use zyphr.asEndUser(token) to authenticate as the end user\nconst login = await zyphr.auth.login.loginEndUser({\n email: 'user@example.com',\n password: 'SecureP@ss123',\n});\nconst token = login.data?.tokens?.accessToken;\nif (!token) throw new Error('No access token returned');\n\nconst profile = await zyphr.auth.profile.getEndUser(zyphr.asEndUser(token));\nawait zyphr.auth.profile.updateEndUser(\n { name: 'Updated Name' },\n zyphr.asEndUser(token),\n);\n\n// Email verification (acts on the authenticated end user)\nawait zyphr.auth.emailVerification.sendEmailVerification(\n { redirectUrl: 'https://myapp.com/verified' },\n zyphr.asEndUser(token),\n);\n\n// Password reset\nawait zyphr.auth.passwordReset.forgotPassword({ email: 'user@example.com' });\n\n// Magic links\nawait zyphr.auth.magicLinks.sendMagicLink({\n email: 'user@example.com',\n redirectUrl: 'https://myapp.com/auth/callback',\n});\n\n// MFA\nconst mfaStatus = await zyphr.auth.mfa.getMfaStatus('user_123');\nawait zyphr.auth.mfa.startMfaEnrollment({ userId: 'user_123' });\n```\n\n**Available auth modules:** `login`, `registration`, `sessions`, `emailVerification`, `passwordReset`, `magicLinks`, `mfa`, `oauth`, `phone`, `webauthn`, `profile`.\n\nSee the [Auth-as-a-Service guide](https://zyphr.dev/docs/guides/auth-as-a-service) for the full setup walkthrough.\n\n### WaaS — `zyphr.waas.*`\n\nWebhooks-as-a-Service: multi-tenant webhook delivery infrastructure for your customers.\n\n```ts\n// Create a WaaS application\nconst created = await zyphr.waas.applications.createWaaSApplication({\n name: 'My SaaS',\n slug: 'my-saas',\n description: 'Webhook delivery for My SaaS customers',\n});\nconst appId = created.data?.id;\nif (!appId) throw new Error('App id missing from response');\n\n// Define event types\nawait zyphr.waas.eventTypes.createWaaSEventType(appId, {\n eventType: 'order.created',\n name: 'Order Created',\n description: 'Fired when a new order is placed',\n examplePayload: { orderId: '123', total: 99.99 },\n});\n\n// Publish events — fans out to all matching tenant endpoints\nawait zyphr.waas.events.publishWaaSEvent(appId, {\n eventType: 'order.created',\n tenantId: 'cust_abc123',\n data: { orderId: '456', total: 149.99 },\n});\n\n// Generate a tenant-scoped portal token for embedded UI\nconst portalToken = await zyphr.waas.portal.generateWaaSPortalToken(appId, {\n tenantId: 'cust_abc123',\n});\n// Pass portalToken.data?.token to @zyphr-dev/webhook-portal\n```\n\n**Available WaaS modules:** `applications`, `eventTypes`, `endpoints`, `events`, `deliveries`, `portal`.\n\n## Error Handling\n\nThe SDK provides typed error classes for different failure scenarios:\n\n```ts\nimport {\n Zyphr,\n ZyphrError,\n ZyphrValidationError,\n ZyphrAuthenticationError,\n ZyphrRateLimitError,\n ZyphrNotFoundError,\n ZyphrPayloadTooLargeError,\n} from '@zyphr-dev/node-sdk';\n\ntry {\n await zyphr.subscribers.getSubscriber('non_existent_id');\n} catch (error) {\n if (error instanceof ZyphrNotFoundError) {\n console.log('Not found:', error.message); // 404\n } else if (error instanceof ZyphrValidationError) {\n console.log('Invalid input:', error.details); // 400/422\n } else if (error instanceof ZyphrAuthenticationError) {\n console.log('Check your API key'); // 401/403\n } else if (error instanceof ZyphrPayloadTooLargeError) {\n // 413 — see https://zyphr.dev/resources/api-limits\n console.log(`Body too large: sent ${error.receivedBytes}, max ${error.limitBytes}`);\n } else if (error instanceof ZyphrRateLimitError) {\n console.log('Retry after:', error.retryAfter); // 429\n } else if (error instanceof ZyphrError) {\n console.log('API error:', error.status, error.code);\n }\n}\n```\n\n### Error Properties\n\nAll error classes extend `ZyphrError`, which extends `Error`:\n\n| Property | Type | Description |\n|----------|------|-------------|\n| `status` | `number` | HTTP status code |\n| `code` | `string \\| undefined` | Machine-readable error code |\n| `requestId` | `string \\| undefined` | Request ID for support tickets |\n| `details` | `Record