Thanks for joining us.
',\n recipientType: 'all',\n status: 'draft'\n});\n\nconsole.log(campaign.id);\nconsole.log(campaign.status);\n```\n\n```typescript\nawait notify.campaigns.create({\n name: 'Flash Sale Alert',\n channel: 'sms',\n text_content: '🔥 24hr flash sale! Get 20% off with code FLASH20. Shop now: https://example.com/sale',\n recipientType: 'tags',\n recipientTags: ['vip', 'active_shopper'],\n status: 'draft'\n});\n```\n\n```typescript\nawait notify.campaigns.create({\n name: 'Cart Reminder Push',\n channel: 'push',\n push_title: 'You left something behind!',\n push_body: 'Your cart is waiting — complete your purchase now.',\n push_image_url: 'https://cdn.example.com/images/cart-reminder.png',\n push_action_url: 'https://example.com/cart',\n push_data: { cartId: 'abc123', source: 'campaign' },\n recipientType: 'segment',\n recipientSegment: 'abandoned_cart_users',\n status: 'draft'\n});\n```\n\n```typescript\nawait notify.campaigns.create({\n name: 'New Feature Announcement',\n channel: 'in_app',\n inapp_title: 'Introducing Dark Mode',\n inapp_body: 'Switch to dark mode from your settings menu.',\n inapp_image_url: 'https://cdn.example.com/images/dark-mode.png',\n inapp_action_url: '/settings/appearance',\n inapp_action_text: 'Try it now',\n recipientType: 'all',\n status: 'draft'\n});\n```\n\nUse `templateId` instead of inline content to send a pre-built template on any channel:\n\n```typescript\nawait notify.campaigns.create({\n name: 'Monthly Newsletter',\n channel: 'email',\n templateId: '3f1e2a4b-5c6d-7e8f-9a0b-1c2d3e4f5a6b',\n recipientType: 'all',\n status: 'scheduled',\n scheduledAt: '2026-09-01T09:00:00.000Z'\n});\n```\n\n**Recipient targeting**\n\n| `recipientType` | Additional fields |\n|------------------|--------------------|\n| `all` | — |\n| `tags` | `recipientTags: string[]` |\n| `segment` | `recipientSegment: string` |\n\n### Contacts\n\nCreate a contact for the app resolved from your API key. If a contact with the same email already exists for the app, it's updated instead of duplicated — so this also covers newsletter re-subscribes.\n\n```typescript\nconst contact = await notify.contacts.create({\n email: 'jane@client.com',\n firstName: 'Jane',\n lastName: 'Doe',\n company: 'Acme Corp',\n subject: 'Pricing question',\n message: 'Do you offer annual plans?',\n source: 'contact_form'\n});\n\nconsole.log(contact.id);\nconsole.log(contact.subscribed);\n```\n\nSetting `source: 'contact_form'` tags the contact `contact_form` and, if the account has a `CONTACT_FORM_AUTOREPLY` template configured, triggers an automatic reply email.\n\nFor a newsletter signup, use `source: 'newsletter'` and set `subscribed`:\n\n```typescript\nawait notify.contacts.create({\n email: 'reader@example.com',\n source: 'newsletter',\n subscribed: true,\n tags: ['newsletter']\n});\n```\n\nTo unsubscribe, create the contact again with `subscribed: false`.\n\n## Configuration\n\n```typescript\nconst notify = new Notify({\n apiKey: 'your_api_key', // required\n baseUrl: 'https://...', // optional, defaults to production API\n timeout: 30000, // optional, request timeout in ms (default: 30000)\n retries: 3 // optional, number of retries (default: 3)\n});\n```\n\n## Channels\n\n| Channel | `to` field | Description |\n|---------|------------|-------------|\n| `email` | Email address | Send email notifications |\n| `sms` | Phone number (E.164) | Send SMS messages |\n| `whatsapp` | Phone number (E.164) | Send WhatsApp messages |\n| `push` | Device token | Send push notifications |\n| `in_app` | User ID | Send in-app notifications |\n\n## Priority Levels\n\n| Priority | Description |\n|----------|-------------|\n| `low` | Background notifications |\n| `normal` | Standard delivery (default) |\n| `high` | Priority delivery |\n| `urgent` | Immediate delivery |\n\n## Error Handling\n\n```typescript\nimport {\n Notify,\n NotifyError,\n NotifyAuthenticationError,\n NotifyValidationError,\n NotifyRateLimitError,\n NotifyNetworkError\n} from '@afrisinc/notify-sdk';\n\ntry {\n await notify.send({ ... });\n} catch (error) {\n if (error instanceof NotifyAuthenticationError) {\n console.error('Invalid API key');\n } else if (error instanceof NotifyValidationError) {\n console.error('Validation failed:', error.message);\n } else if (error instanceof NotifyRateLimitError) {\n console.error('Rate limited. Retry after:', error.retryAfter);\n } else if (error instanceof NotifyNetworkError) {\n console.error('Network error:', error.message);\n } else if (error instanceof NotifyError) {\n console.error('Error:', error.code, error.message);\n }\n}\n```\n\n## TypeScript\n\nFull TypeScript support with exported types:\n\n```typescript\nimport type {\n NotifyConfig,\n Channel,\n Priority,\n NotificationStatus,\n SendParams,\n SendResponse,\n BulkParams,\n BulkResponse,\n Notification,\n ListParams,\n ListResponse\n} from '@afrisinc/notify-sdk';\n```\n\n## License\n\nMIT\n","readmeFilename":"README.md"}