Thanks for signing up.
',\r\n text: 'Hello John! Thanks for signing up.',\r\n fromName: 'Support Team',\r\n replyTo: 'support@yourcompany.com',\r\n});\r\n```\r\n\r\n### Send Batch Emails (Marketing)\r\n\r\n```typescript\r\nconst result = await client.sendBatch({\r\n recipients: [\r\n { email: 'user1@example.com', name: 'User 1', firstName: 'User' },\r\n { email: 'user2@example.com', name: 'User 2', firstName: 'User' },\r\n ],\r\n subject: 'Hello %%First Name%%!',\r\n html: 'Check out our latest offers.
',\r\n preheader: 'Exclusive deals inside',\r\n fromName: 'Marketing Team',\r\n});\r\n\r\nconsole.log(`Queued ${result.queued} emails. Task ID: ${result.taskId}`);\r\n```\r\n\r\n### Campaign Management\r\n\r\n```typescript\r\n// Create a campaign\r\nconst campaign = await client.createCampaign({\r\n name: 'Newsletter Q1 2025',\r\n subject: 'Monthly Update',\r\n html: 'Latest news...
',\r\n preheader: 'Your monthly update is here',\r\n});\r\n\r\n// Get all campaigns\r\nconst campaigns = await client.getCampaigns();\r\n\r\n// Update a campaign\r\nawait client.updateCampaign(campaign.id, {\r\n subject: 'Updated Subject',\r\n});\r\n\r\n// Delete a campaign\r\nawait client.deleteCampaign(campaign.id);\r\n```\r\n\r\n### Contact Lists\r\n\r\n```typescript\r\n// Create a list\r\nconst list = await client.createList({\r\n name: 'Newsletter Subscribers',\r\n type: 1, // 1 = email\r\n});\r\n\r\n// Add contacts\r\nawait client.addContacts(list.id, [\r\n { email: 'john@example.com', firstName: 'John', lastName: 'Doe' },\r\n { email: 'jane@example.com', firstName: 'Jane', lastName: 'Smith' },\r\n]);\r\n\r\n// Get contacts\r\nconst contacts = await client.getContacts(list.id, 100, 0);\r\n\r\n// Remove contacts\r\nawait client.removeContacts(list.id, ['john@example.com']);\r\n```\r\n\r\n### Schedule Sending\r\n\r\n```typescript\r\n// Create a schedule\r\nconst schedule = await client.createSchedule({\r\n campaignId: 45,\r\n listId: 123,\r\n serverId: 1,\r\n senderName: 'John from Company',\r\n schedule: '2025-12-15 10:00:00',\r\n});\r\n\r\n// Pause/Resume/Stop\r\nawait client.pauseSchedule(schedule.id);\r\nawait client.resumeSchedule(schedule.id);\r\nawait client.stopSchedule(schedule.id);\r\n```\r\n\r\n### Statistics\r\n\r\n```typescript\r\n// Get overview stats\r\nconst overview = await client.getOverviewStats();\r\nconsole.log(`Total sent: ${overview.sent}, Opens: ${overview.opens}`);\r\n\r\n// Get campaign-specific stats\r\nconst stats = await client.getCampaignStats(taskId);\r\n\r\n// Get geographic stats\r\nconst countries = await client.getCountryStats(taskId);\r\n\r\n// Get provider breakdown\r\nconst providers = await client.getProviderStats(taskId);\r\n\r\n// Get bounce details\r\nconst bounces = await client.getBounceDetails(taskId);\r\n\r\n// Get events\r\nconst opens = await client.getEvents(taskId, 'open', 100, 0);\r\n```\r\n\r\n### Domain Verification\r\n\r\n```typescript\r\nconst verification = await client.verifyDomain(serverId);\r\nconsole.log('SPF valid:', verification.spf.valid);\r\nconsole.log('DKIM valid:', verification.dkim.valid);\r\nconsole.log('DMARC valid:', verification.dmarc.valid);\r\n```\r\n\r\n### Suppression Check\r\n\r\n```typescript\r\nconst result = await client.checkSuppression('user@example.com');\r\nif (result.suppressed) {\r\n console.log(`Email is suppressed: ${result.reason}`);\r\n}\r\n```\r\n\r\n## Configuration\r\n\r\n```typescript\r\nconst client = new ADSMedia({\r\n apiKey: 'your-api-key', // Required\r\n baseUrl: 'https://api.adsmedia.live/v1', // Optional (default)\r\n timeout: 30000, // Optional: request timeout in ms (default: 30000)\r\n});\r\n```\r\n\r\n## Error Handling\r\n\r\n```typescript\r\nimport ADSMedia, { ADSMediaError } from '@adsmedia/sdk';\r\n\r\ntry {\r\n await client.send({ /* ... */ });\r\n} catch (error) {\r\n if (error instanceof ADSMediaError) {\r\n console.error(`API Error: ${error.message}`);\r\n console.error(`Status Code: ${error.statusCode}`);\r\n } else {\r\n throw error;\r\n }\r\n}\r\n```\r\n\r\n## Personalization Placeholders\r\n\r\nUse these placeholders in your email content:\r\n\r\n| Placeholder | Description |\r\n|-------------|-------------|\r\n| `%%First Name%%` | Recipient's first name |\r\n| `%%Last Name%%` | Recipient's last name |\r\n| `%%emailaddress%%` | Recipient's email address |\r\n| `%%Sender Name%%` | Sender display name |\r\n| `%%unsubscribelink%%` | Unsubscribe URL |\r\n| `%%webversion%%` | View in browser link |\r\n\r\n## TypeScript\r\n\r\nThe SDK is written in TypeScript and provides full type definitions:\r\n\r\n```typescript\r\nimport ADSMedia, {\r\n SendEmailOptions,\r\n SendBatchOptions,\r\n Campaign,\r\n ContactList,\r\n Schedule,\r\n Stats,\r\n ADSMediaError,\r\n} from '@adsmedia/sdk';\r\n```\r\n\r\n## Rate Limits\r\n\r\n- 100 requests per minute per API key\r\n- HTTP 429 returned when exceeded\r\n\r\n## Links\r\n\r\n- [API Documentation](https://www.adsmedia.ai/api-docs)\r\n- [GitHub Repository](https://github.com/ADSMedia-ai/ADSMedia)\r\n- [Report Issues](https://github.com/ADSMedia-ai/ADSMedia/issues)\r\n\r\n## License\r\n\r\nMIT © [ADSMedia](https://www.adsmedia.ai)\r\n\r\n","readmeFilename":"README.md","_rev":"1-ad18dcc8e95b3e6af9ccc7384fb19a9e"}