migma 1.3.1 → 1.3.3

package/README.md

@@ -27,7 +27,7 @@ const { data: project } = await migma.projects.importAndWait({
   urls: ['https://yourcompany.com'],
 });
 
-// Generate an email design with AI — returns the finished HTML directly
+// Generate an email design with AI — returns the finished HTML directly.
 const { data: email } = await migma.emails.generateAndWait({
   projectId: project.projectId,
   prompt: 'Create a welcome email for new subscribers',
@@ -35,7 +35,8 @@ const { data: email } = await migma.emails.generateAndWait({
 
 if (email?.status === 'completed') {
   console.log('Subject:', email.result.subject);
-  console.log('HTML:', email.result.html); // production-ready HTML
+  console.log('HTML:', email.result.html); // primary email HTML
+  console.log('Email ID:', email.result.emails[0].emailId);
 }
 ```
 
@@ -63,18 +64,22 @@ const { data: email } = await migma.emails.generateAndWait({
   prompt: 'Create a summer sale email with 30% off everything',
 });
 
-// 3. Send it — conversationId works for single-email conversations
+if (!email?.result) throw new Error('Email generation failed');
+
+// 3. Send it — emailId works for single emails and series slots
+const selectedEmail = email.result.emails[0];
+if (!selectedEmail.emailId) throw new Error('No emailId returned');
 await migma.sending.send({
   recipientType: 'email',
   recipientEmail: 'sarah@example.com',
   from: 'hello@yourcompany.migma.email',
   fromName: 'Your Company',
-  subject: email.result.subject,
-  conversationId: email.conversationId,
+  subject: selectedEmail.subject,
+  emailId: selectedEmail.emailId,
 });
 
-// For multi-slot emails or series, use the selected slot's artifactId instead.
-// Copy it from Publish -> Send via API in the app.
+// conversationId also works for single-email conversations.
+// For multi-slot emails or series, use result.emails[].emailId.
 ```
 
 [Full OpenClaw tutorial](https://docs.migma.ai/tutorials/send-emails-from-openclaw)
@@ -92,7 +97,7 @@ await migma.sending.send({
 
 ## Features
 
-- Full coverage of all Migma API v1 endpoints (80+ methods across 14 resources)
+- Full coverage of all Migma API v1 endpoints (80+ methods across 15 resources)
 - TypeScript-first with complete type definitions
 - `{ data, error }` return pattern — methods never throw
 - Automatic retries with exponential backoff on 5xx/429
@@ -223,25 +228,23 @@ const { data: result } = await migma.contacts.bulkImport({
 Send to a single recipient, segment, tag, or full audience.
 
 ```typescript
-// Send a single-email conversation by conversationId
+// Send a generated email by emailId
 await migma.sending.send({
   recipientType: 'email',
   recipientEmail: 'user@example.com',
   from: 'hello@yourdomain.com',
   fromName: 'Your Company',
   subject: 'Welcome!',
-  conversationId: 'conv_abc123',
+  emailId: 'email_abc123',
 });
 
-// For a multi-slot conversation or series, send one slot by artifactId.
-// In the app, open the focused slot and use Publish -> Send via API to copy it.
+// Single-email conversations can also be sent by conversationId.
 await migma.sending.send({
   recipientType: 'email',
   recipientEmail: 'user@example.com',
   from: 'hello@yourdomain.com',
   fromName: 'Your Company',
   subject: 'Welcome!',
-  artifactId: 'artifact_abc123',
   conversationId: 'conv_abc123',
 });
 
@@ -252,7 +255,7 @@ await migma.sending.send({
   from: 'hello@yourdomain.com',
   fromName: 'Your Company',
   subject: 'Big Announcement',
-  conversationId: 'conv_abc123',
+  emailId: 'email_abc123',
 });
 
 // Single sends are automatically transactional — no flag needed
@@ -263,13 +266,37 @@ await migma.sending.send({
   from: 'noreply@yourdomain.com',
   fromName: 'Your Company',
   subject: 'Your subscription renews tomorrow',
-  artifactId: 'artifact_abc123',
+  emailId: 'email_abc123',
   transactional: true,
 });
 ```
 
 [Sending API Reference](https://docs.migma.ai/api-reference/sending/send-email)
 
+### Generated Series and Editing
+
+Generate a series with `count`, then use each email's `emailId` to fetch, prompt-edit, or send one email.
+
+```typescript
+const { data: series } = await migma.emails.generateAndWait({
+  projectId: 'proj_abc123',
+  prompt: 'Create a three-email onboarding series',
+  count: 3,
+});
+
+for (const generated of series?.result?.emails ?? []) {
+  console.log(generated.slot, generated.emailId, generated.html);
+  console.log(generated.screenshotUrl);
+}
+
+const { data: email } = await migma.emails.get('email_abc123');
+console.log(email?.html);
+
+await migma.emails.edit('email_abc123', {
+  prompt: 'Change the CTA from "Start now" to "Start your trial"',
+});
+```
+
 ### Email Validation
 
 Run preflight checks — compatibility, links, spelling, and deliverability.
@@ -427,8 +454,9 @@ await migma.images.updateLogos('proj_abc123', {
 | `migma.segments` | `create` `list` `get` `update` `remove` | [Segments](https://docs.migma.ai/api-reference/audiences/list-audiences) |
 | `migma.topics` | `create` `list` `get` `update` `remove` `subscribe` `unsubscribe` | [Topics](https://docs.migma.ai/api-reference/topics/list-topics) |
 | `migma.sending` | `send` `getBatchStatus` | [Sending](https://docs.migma.ai/api-reference/sending/send-email) |
-| `migma.projects` | `list` `get` `import` `getImportStatus` `retryImport` `importAndWait` | [Projects](https://docs.migma.ai/api-reference/projects/list-projects) |
-| `migma.emails` | `generate` `getGenerationStatus` `generateAndWait` `sendTest` | [Email Generation](https://docs.migma.ai/api-reference/email/generate-email-async) |
+| `migma.projects` | `list` `get` `import` `getImportStatus` `retryImport` `fieldCatalog` `importAndWait` | [Projects](https://docs.migma.ai/api-reference/projects/list-projects) |
+| `migma.emails` | `generate` `getGenerationStatus` `generateAndWait` `sendTest` `get` `edit` | [Email Generation](https://docs.migma.ai/api-reference/email/generate-email-async) |
+| `migma.campaigns` | `list` `create` `get` `send` `schedule` `cancel` `archive` `unarchive` | [Campaigns](https://docs.migma.ai/campaigns/overview) |
 | `migma.validation` | `all` `compatibility` `links` `spelling` `deliverability` | [Validation](https://docs.migma.ai/api-reference/email-validation/run-all-validation-checks) |
 | `migma.previews` | `create` `get` `getStatus` `getDevice` `getSupportedDevices` `createAndWait` | [Previews](https://docs.migma.ai/api-reference/email-previews/create-email-preview) |
 | `migma.export` | `getFormats` `getStatus` `html` `mjml` `pdf` `klaviyo` `mailchimp` `hubspot` | [Export](https://docs.migma.ai/api-reference/export/list-export-formats) |