migma 1.3.3 → 1.3.4

package/README.md

@@ -126,6 +126,7 @@ Every method returns `{ data, error }` instead of throwing. TypeScript narrows t
 ```typescript
 const { data, error } = await migma.contacts.create({
   email: 'john@example.com',
+  status: 'subscribed', // only for contacts with marketing consent
   projectId: 'proj_abc123',
 });
 
@@ -206,7 +207,7 @@ const { data: contact } = await migma.contacts.create({
 // List with filters
 const { data: contacts } = await migma.contacts.list({
   projectId: 'proj_abc123',
-  status: 'active',
+  status: 'subscribed',
   tags: 'newsletter',
   limit: 50,
 });
@@ -219,6 +220,19 @@ const { data: result } = await migma.contacts.bulkImport({
   ],
   projectId: 'proj_abc123',
 });
+
+// Batch delete by email (up to 1000; unmatched emails come back in notFound)
+const { data: deletion } = await migma.contacts.bulkDeleteByEmail({
+  emails: ['a@example.com', 'b@example.com'],
+  projectId: 'proj_abc123',
+});
+
+// Safe retries: pass an Idempotency-Key so a retried write never duplicates.
+// Same key + same body within 24h replays the original response.
+await migma.contacts.create(
+  { email: 'jane@example.com', projectId: 'proj_abc123' },
+  { idempotencyKey: 'signup-jane@example.com-1779292800' },
+);
 ```
 
 [Contacts API Reference](https://docs.migma.ai/api-reference/contacts/get-contact)
@@ -297,6 +311,123 @@ await migma.emails.edit('email_abc123', {
 });
 ```
 
+### Campaigns
+
+Create a campaign from a generated email, send or schedule it, then read its
+engagement stats and per-recipient logs.
+
+```typescript
+// Create from a generated email
+const { data: campaign } = await migma.campaigns.create({
+  projectId: 'proj_abc123',
+  name: 'Spring Launch',
+  conversationId: 'conv_abc123',
+  emailId: 'email_abc123',
+  subject: 'Spring is here',
+  from: 'hello@yourdomain.com',
+  fromName: 'Your Brand',
+  recipientType: 'audience',
+  recipientId: 'aud_abc123',
+});
+
+// Send now (idempotency key recommended — see below)
+await migma.campaigns.send(campaign.id, {
+  idempotencyKey: `campaign-send-${campaign.id}`,
+});
+
+// Or schedule for later
+await migma.campaigns.schedule(
+  campaign.id,
+  { scheduledAt: '2026-07-01T15:00:00Z', scheduledTimezone: 'America/New_York' },
+  { idempotencyKey: `campaign-send-${campaign.id}` },
+);
+
+// Aggregated engagement metrics (cached, may be slightly stale)
+const { data: stats } = await migma.campaigns.stats(campaign.id);
+console.log(stats?.openRate, stats?.clickRate, stats?.lastUpdated);
+
+// Per-recipient logs, cursor-paginated and optionally filtered by status
+const { data: logs } = await migma.campaigns.logs(campaign.id, {
+  status: 'opened',
+  limit: 50,
+});
+for (const row of logs?.emails ?? []) {
+  console.log(row.to_email, row.status, row.opened_at);
+}
+if (logs?.hasMore) {
+  await migma.campaigns.logs(campaign.id, { cursor: logs.nextCursor ?? undefined });
+}
+```
+
+Campaign stats are sourced from the email tracking worker and cached on the
+campaign, so they can lag live activity. `botOpens`, `botClicks`, and `mppOpens`
+reflect Apple Mail Privacy Protection and bot detection when that data is
+available. Log rows come straight from the tracking store, so their field names
+are `snake_case` (`to_email`, `opened_at`, `bounce_type`) unlike the rest of the
+API.
+
+[Campaigns Guide](https://docs.migma.ai/campaigns/overview)
+
+### Idempotency
+
+Write methods accept an optional trailing `CallOptions` argument carrying an
+`idempotencyKey`. The key is sent as the `Idempotency-Key` header (max 100
+characters) and is scoped to your API key for 24 hours:
+
+- **Same key + same body** within 24h replays the original response (the server
+  marks the replay with an `Idempotent-Replayed: true` header).
+- **Same key + different body** returns `409 IDEMPOTENCY_CONFLICT`.
+- `429` and `5xx` responses are never cached, so they stay safe to retry — and
+  the SDK reuses your key across its own automatic retries, so a retried call
+  never duplicates.
+
+```typescript
+// Sending — key on the recipient + send time
+await migma.sending.send(
+  {
+    recipientType: 'email',
+    recipientEmail: 'user@example.com',
+    from: 'hello@yourdomain.com',
+    fromName: 'Your Brand',
+    subject: 'Welcome!',
+    emailId: 'email_abc123',
+  },
+  { idempotencyKey: 'send-email_abc123-user@example.com-now' },
+);
+
+// Campaign send — one key per campaign send
+await migma.campaigns.send('camp_abc123', {
+  idempotencyKey: 'campaign-send-camp_abc123',
+});
+
+// Email generation — key on project + the turn/prompt
+await migma.emails.generate(
+  { projectId: 'proj_abc123', prompt: 'Welcome email' },
+  { idempotencyKey: 'email-gen-proj_abc123-welcome' },
+);
+
+// Contact add — key on the email
+await migma.contacts.create(
+  { email: 'jane@example.com', projectId: 'proj_abc123' },
+  { idempotencyKey: 'contact-jane@example.com' },
+);
+```
+
+**Choose a deterministic key** so the same logical operation produces the same
+key on every attempt:
+
+- send: `send-<emailId>-<recipientId|to>-<scheduledAt|"now">`
+- campaign send: `campaign-send-<campaignId>`
+- email generate: `email-gen-<projectId>-<turnOrPromptHash>`
+- contact add: `contact-<email>`
+
+**Anti-patterns to avoid:**
+
+- Don't generate the key with `uuid()` or `Date.now()` per call — a fresh key
+  every attempt defeats deduplication across retries and process restarts.
+- Don't hash the request body to build the key — identical retries you *want*
+  deduplicated would each get a different key, and you lose the conflict signal.
+
 ### Email Validation
 
 Run preflight checks — compatibility, links, spelling, and deliverability.
@@ -374,6 +505,14 @@ const { data: avail } = await migma.domains.checkAvailability('mycompany');
 if (avail.available) {
   await migma.domains.createManaged({ prefix: 'mycompany' });
 }
+
+// Provision a transactional stream (notify.example.com) to isolate
+// transactional reputation from marketing, then publish the returned DNS records
+await migma.domains.provisionStream({ rootDomain: 'example.com', stream: 'transactional' });
+
+// Or provision both streams (send. marketing + notify. transactional) in one call
+const { data } = await migma.domains.setup({ rootDomain: 'example.com' });
+// data.marketing, data.transactional
 ```
 
 [Domains API Reference](https://docs.migma.ai/api-reference/domains/list-domains)
@@ -391,7 +530,19 @@ const { data: tag } = await migma.tags.create({
 // Segments
 const { data: segment } = await migma.segments.create({
   name: 'Active US Customers',
-  filters: { status: 'subscribed', customFields: { country: ['US'] } },
+  filters: {
+    status: 'subscribed',
+    fields: [{ key: 'country', mode: 'is', values: ['US'] }],
+    activity: [{ action: 'opened', channel: 'email', mode: 'within', unit: 'days', amount: 30 }],
+  },
+  projectId: 'proj_abc123',
+});
+
+const { data: campaignSegment } = await migma.segments.create({
+  name: 'Campaign openers',
+  filters: {
+    activity: [{ action: 'opened', channel: 'email', mode: 'within', unit: 'days', amount: 14, campaignId: 'cmp_123' }],
+  },
   projectId: 'proj_abc123',
 });
 
@@ -456,11 +607,11 @@ await migma.images.updateLogos('proj_abc123', {
 | `migma.sending` | `send` `getBatchStatus` | [Sending](https://docs.migma.ai/api-reference/sending/send-email) |
 | `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.campaigns` | `list` `create` `get` `send` `schedule` `cancel` `stats` `logs` `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) |
-| `migma.domains` | `create` `list` `get` `verify` `update` `remove` `checkAvailability` `listManaged` `createManaged` `removeManaged` | [Domains](https://docs.migma.ai/api-reference/domains/list-domains) |
+| `migma.domains` | `create` `list` `get` `verify` `update` `remove` `checkAvailability` `listManaged` `createManaged` `removeManaged` `provisionStream` `setup` | [Domains](https://docs.migma.ai/api-reference/domains/list-domains) |
 | `migma.webhooks` | `create` `list` `get` `update` `remove` `test` `getDeliveries` `getEvents` `getStats` | [Webhooks](https://docs.migma.ai/webhooks) |
 | `migma.knowledgeBase` | `list` `add` `update` `remove` | [API Ref](https://docs.migma.ai/api-reference/introduction) |
 | `migma.images` | `add` `update` `remove` `updateLogos` | [API Ref](https://docs.migma.ai/api-reference/introduction) |

package/dist/index.d.mts

@@ -60,6 +60,16 @@ interface RequestOptions {
     path: string;
     body?: Record<string, unknown>;
     query?: Record<string, string | number | boolean | undefined>;
+    headers?: Record<string, string>;
+}
+/** Per-call options for write methods (POST/PATCH/DELETE). */
+interface CallOptions {
+    /**
+     * Optional Idempotency-Key (max 100 chars). Same key + same body within 24h
+     * replays the original response; a different body returns 409 IDEMPOTENCY_CONFLICT.
+     * Reused across the SDK's own automatic retries so a retried call never duplicates.
+     */
+    idempotencyKey?: string;
 }
 declare class MigmaClient {
     private readonly apiKey;
@@ -80,16 +90,17 @@ declare class MigmaClient {
         data: T;
         count: number;
     }>>;
-    post<T>(path: string, body?: Record<string, unknown>): Promise<MigmaResult<T>>;
-    patch<T>(path: string, body?: Record<string, unknown>): Promise<MigmaResult<T>>;
+    post<T>(path: string, body?: Record<string, unknown>, options?: CallOptions): Promise<MigmaResult<T>>;
+    patch<T>(path: string, body?: Record<string, unknown>, options?: CallOptions): Promise<MigmaResult<T>>;
     put<T>(path: string, body?: Record<string, unknown>): Promise<MigmaResult<T>>;
-    delete<T>(path: string, query?: Record<string, string | number | boolean | undefined>): Promise<MigmaResult<T>>;
+    delete<T>(path: string, query?: Record<string, string | number | boolean | undefined>, options?: CallOptions): Promise<MigmaResult<T>>;
+    private callHeaders;
     private buildUrl;
     private parseRetryAfter;
     private sleep;
 }
 
-type ContactStatus = 'active' | 'unsubscribed' | 'bounced' | 'complained';
+type ContactStatus = 'subscribed' | 'unsubscribed' | 'bounced' | 'non-subscribed';
 interface Contact {
     id: string;
     email: string;
@@ -116,6 +127,7 @@ interface CreateContactParams {
     language?: string;
     tags?: string[];
     customFields?: Record<string, unknown>;
+    status?: ContactStatus;
     projectId: string;
 }
 interface UpdateContactParams {
@@ -150,6 +162,7 @@ interface BulkImportContactItem {
     language?: string;
     tags?: string[];
     customFields?: Record<string, unknown>;
+    status?: ContactStatus;
 }
 interface BulkImportParams {
     subscribers: BulkImportContactItem[];
@@ -178,6 +191,17 @@ interface BulkImportJobStatus {
     createdAt: string;
     completedAt: string | null;
 }
+interface BatchDeleteContactsParams {
+    /** Email addresses to delete (1-1000 per request). */
+    emails: string[];
+    projectId: string;
+}
+interface BatchDeleteResponse {
+    /** Number of contacts actually deleted. */
+    deleted: number;
+    /** Submitted emails with no matching contact (not an error). */
+    notFound: string[];
+}
 interface ChangeStatusParams {
     email: string;
     status: 'subscribed' | 'unsubscribed' | 'bounced' | 'non-subscribed';
@@ -189,14 +213,16 @@ interface ChangeStatusParams {
 declare class Contacts {
     private readonly client;
     constructor(client: MigmaClient);
-    create(params: CreateContactParams): Promise<MigmaResult<Contact>>;
+    create(params: CreateContactParams, options?: CallOptions): Promise<MigmaResult<Contact>>;
     list(params: ListContactsParams): Promise<MigmaResult<ListContactsResponse>>;
     get(id: string, projectId: string): Promise<MigmaResult<Contact>>;
-    update(id: string, params: UpdateContactParams): Promise<MigmaResult<Contact>>;
-    remove(id: string, projectId: string): Promise<MigmaResult<DeleteResponse>>;
-    bulkImport(params: BulkImportParams): Promise<MigmaResult<BulkImportResponse>>;
+    update(id: string, params: UpdateContactParams, options?: CallOptions): Promise<MigmaResult<Contact>>;
+    remove(id: string, projectId: string, options?: CallOptions): Promise<MigmaResult<DeleteResponse>>;
+    bulkImport(params: BulkImportParams, options?: CallOptions): Promise<MigmaResult<BulkImportResponse>>;
     getBulkImportStatus(jobId: string): Promise<MigmaResult<BulkImportJobStatus>>;
-    changeStatus(params: ChangeStatusParams): Promise<MigmaResult<{
+    /** Batch delete contacts by email (up to 1000). Emails with no match come back in `notFound`. */
+    bulkDeleteByEmail(params: BatchDeleteContactsParams, options?: CallOptions): Promise<MigmaResult<BatchDeleteResponse>>;
+    changeStatus(params: ChangeStatusParams, options?: CallOptions): Promise<MigmaResult<{
         success: boolean;
     }>>;
 }
@@ -248,11 +274,15 @@ declare class Tags {
 
 interface SegmentFieldFilter {
     key: string;
-    mode?: 'is' | 'is_not';
+    /** Exact match (is/is_not) or pattern match (starts_with/ends_with/contains/not_contains,
+     *  compiled to anchored case-insensitive regex). Pattern modes keep a value group
+     *  like "email ends_with .vc" accurate as new contacts arrive. */
+    mode?: 'is' | 'is_not' | 'starts_with' | 'ends_with' | 'contains' | 'not_contains';
     values: string[];
 }
 interface SegmentActivityFilter {
     action: 'sent' | 'opened' | 'clicked';
+    channel?: 'email';
     mode: 'within' | 'before' | 'never' | 'between';
     unit?: 'hours' | 'days';
     amount?: number;
@@ -430,7 +460,7 @@ interface BatchStatus {
 declare class Sending {
     private readonly client;
     constructor(client: MigmaClient);
-    send(params: SendEmailParams): Promise<MigmaResult<SendEmailResponse>>;
+    send(params: SendEmailParams, options?: CallOptions): Promise<MigmaResult<SendEmailResponse>>;
     getBatchStatus(batchId: string): Promise<MigmaResult<BatchStatus>>;
 }
 
@@ -684,7 +714,7 @@ declare class Emails {
     /** List emails for a project */
     list(params: ListEmailsParams): Promise<MigmaResult<ListEmailsResponse>>;
     /** Start async email generation */
-    generate(params: GenerateEmailParams): Promise<MigmaResult<GenerateEmailResponse>>;
+    generate(params: GenerateEmailParams, options?: CallOptions): Promise<MigmaResult<GenerateEmailResponse>>;
     /** Check email generation status */
     getGenerationStatus(conversationId: string): Promise<MigmaResult<EmailGenerationStatus>>;
     /** Fetch one generated email by email id */
@@ -695,7 +725,7 @@ declare class Emails {
      * Generate an email and wait for completion.
      * Polls getGenerationStatus until status is 'completed' or 'failed'.
      */
-    generateAndWait(params: GenerateEmailParams, options?: PollingOptions): Promise<MigmaResult<EmailGenerationStatus>>;
+    generateAndWait(params: GenerateEmailParams, options?: PollingOptions, callOptions?: CallOptions): Promise<MigmaResult<EmailGenerationStatus>>;
     /** Send a test email from a completed conversation */
     sendTest(params: SendTestEmailParams): Promise<MigmaResult<SendTestEmailResponse>>;
 }
@@ -1011,6 +1041,34 @@ interface CreateManagedDomainParams {
     prefix: string;
     region?: string;
 }
+type DomainStream = 'transactional' | 'marketing';
+interface ProvisionStreamParams {
+    /** Apex domain you own, e.g. 'acme.com'. */
+    rootDomain: string;
+    /** 'transactional' provisions notify.<rootDomain>; 'marketing' provisions send.<rootDomain>. */
+    stream: DomainStream;
+    region?: 'us-east-1' | 'eu-west-1';
+    /** Show the apex domain in the From header when its DMARC passes. */
+    vanityRootFrom?: boolean;
+}
+interface SetupDomainParams {
+    /** Apex domain you own, e.g. 'acme.com'. */
+    rootDomain: string;
+    region?: 'us-east-1' | 'eu-west-1';
+    /** Default From display name applied to both provisioned streams. */
+    fromName?: string;
+    /** Associate the provisioned streams with a project. */
+    projectId?: string;
+    /** Show the apex domain in the From header when its DMARC passes. Defaults to true. */
+    vanityRootFrom?: boolean;
+}
+/** Both stream identities provisioned for a root domain by `domains.setup`. */
+interface SetupDomainResponse {
+    /** send.<rootDomain> marketing stream identity. */
+    marketing: Domain;
+    /** notify.<rootDomain> transactional stream identity. */
+    transactional: Domain;
+}
 interface DomainDeleteResponse {
     domain: string;
     deleted: boolean;
@@ -1029,6 +1087,18 @@ declare class Domains {
     listManaged(): Promise<MigmaResult<Domain[]>>;
     createManaged(params: CreateManagedDomainParams): Promise<MigmaResult<Domain>>;
     removeManaged(domain: string): Promise<MigmaResult<DomainDeleteResponse>>;
+    /**
+     * Provision a transactional or marketing stream identity on a domain you own.
+     * Creates notify.<rootDomain> (transactional) or send.<rootDomain> (marketing)
+     * to isolate transactional reputation from marketing. Returns DNS records to publish.
+     */
+    provisionStream(params: ProvisionStreamParams): Promise<MigmaResult<Domain>>;
+    /**
+     * Provision BOTH stream identities for a domain you own in one call:
+     * send.<rootDomain> (marketing) and notify.<rootDomain> (transactional).
+     * Idempotent. Returns both domains with DNS records to publish.
+     */
+    setup(params: SetupDomainParams): Promise<MigmaResult<SetupDomainResponse>>;
 }
 
 type WebhookEventType = 'email.generation.started' | 'email.generation.completed' | 'email.generation.failed' | 'email.test.sent' | 'project.import.started' | 'project.import.processing' | 'project.import.completed' | 'project.import.failed' | 'export.completed' | 'export.failed' | 'subscriber.added' | 'subscriber.updated' | 'subscriber.unsubscribed' | 'subscriber.bulk_imported' | 'api_key.created' | 'api_key.revoked';
@@ -1050,10 +1120,19 @@ interface Webhook {
     url: string;
     events: WebhookEventType[];
     active: boolean;
-    secret: string;
+    /** Whether a signing secret is configured. Returned by create and get. */
+    secretConfigured?: boolean;
     description?: string;
     createdAt: string;
 }
+interface CreateWebhookResponse extends Webhook {
+    /**
+     * The signing secret, returned ONCE at creation. Store it now — GET and list
+     * never return it. To rotate, delete and recreate the webhook.
+     */
+    secret: string;
+    secretConfigured: boolean;
+}
 interface WebhookDetail extends Webhook {
     customHeaders?: Record<string, string>;
     successCount: number;
@@ -1098,7 +1177,7 @@ declare class Webhooks {
     private readonly client;
     constructor(client: MigmaClient);
     list(): Promise<MigmaResult<ListWebhooksResponse>>;
-    create(params: CreateWebhookParams): Promise<MigmaResult<Webhook>>;
+    create(params: CreateWebhookParams): Promise<MigmaResult<CreateWebhookResponse>>;
     get(webhookId: string): Promise<MigmaResult<WebhookDetail>>;
     update(webhookId: string, params: UpdateWebhookParams): Promise<MigmaResult<{
         updated: boolean;
@@ -1241,16 +1320,84 @@ interface ScheduleCampaignParams {
     scheduledAt: string;
     scheduledTimezone?: string;
 }
+/**
+ * Aggregated engagement metrics for a campaign.
+ *
+ * Sourced from the email tracking worker and cached on the campaign, so values
+ * may be slightly stale. `botOpens`, `botClicks`, and `mppOpens` are present
+ * when Apple Mail Privacy Protection / bot detection data is available.
+ */
+interface CampaignStats {
+    totalSent: number;
+    totalDelivered: number;
+    uniqueOpens: number;
+    totalOpens: number;
+    uniqueClicks: number;
+    totalClicks: number;
+    unsubscribes: number;
+    bounces: number;
+    /** 0-100 */
+    openRate: number;
+    /** 0-100 */
+    clickRate: number;
+    /** ISO 8601 timestamp of when these stats were last refreshed. */
+    lastUpdated: string;
+    botOpens?: number;
+    botClicks?: number;
+    mppOpens?: number;
+}
+/**
+ * A single per-recipient email log row for a campaign. Returned directly from
+ * the tracking worker's D1 `emails` table, so the field names are snake_case
+ * (unlike the rest of the API).
+ */
+interface CampaignLog {
+    id: number;
+    tracking_id: string;
+    user_id: string;
+    domain: string;
+    from_email: string;
+    to_email: string;
+    subscriber_id: string | null;
+    subject: string | null;
+    /** Delivery status, e.g. 'sent', 'delivered', 'bounced', 'suppressed'. */
+    status: string;
+    opened_at: string | null;
+    clicked_at: string | null;
+    open_count: number;
+    click_count: number;
+    bounce_type: string | null;
+    complaint_type: string | null;
+    suppression_type: string | null;
+    suppression_reason: string | null;
+    conversation_id: string | null;
+    campaign_id: string | null;
+    created_at: string;
+}
+interface CampaignLogsParams {
+    limit?: number;
+    cursor?: string;
+    status?: 'delivered' | 'opened' | 'clicked' | 'bounced' | 'spam_report';
+}
+interface CampaignLogsResponse {
+    emails: CampaignLog[];
+    nextCursor: string | null;
+    hasMore: boolean;
+}
 
 declare class Campaigns {
     private readonly client;
     constructor(client: MigmaClient);
     list(params: ListCampaignsParams): Promise<MigmaResult<ListCampaignsResponse>>;
-    create(params: CreateCampaignParams): Promise<MigmaResult<Campaign>>;
+    create(params: CreateCampaignParams, options?: CallOptions): Promise<MigmaResult<Campaign>>;
     get(id: string): Promise<MigmaResult<Campaign>>;
-    send(id: string): Promise<MigmaResult<Campaign>>;
-    schedule(id: string, params: ScheduleCampaignParams): Promise<MigmaResult<Campaign>>;
-    cancel(id: string): Promise<MigmaResult<Campaign>>;
+    send(id: string, options?: CallOptions): Promise<MigmaResult<Campaign>>;
+    schedule(id: string, params: ScheduleCampaignParams, options?: CallOptions): Promise<MigmaResult<Campaign>>;
+    cancel(id: string, options?: CallOptions): Promise<MigmaResult<Campaign>>;
+    /** Aggregated engagement metrics for a campaign (cached, may be slightly stale). */
+    stats(id: string): Promise<MigmaResult<CampaignStats>>;
+    /** Per-recipient email logs for a campaign (cursor-paginated). */
+    logs(id: string, params?: CampaignLogsParams): Promise<MigmaResult<CampaignLogsResponse>>;
     archive(id: string): Promise<MigmaResult<Campaign>>;
     unarchive(id: string): Promise<MigmaResult<Campaign>>;
 }
@@ -1283,4 +1430,4 @@ declare class Migma {
     constructor(apiKey: string, config?: MigmaConfig);
 }
 
-export { type AddImageParams, type AddKnowledgeBaseParams, type AnalyzeDeliverabilityParams, type AnalyzeLinksParams, type ApiResponse, type BatchStatus, type BulkImportAsyncResponse, type BulkImportContactItem, type BulkImportJobStatus, type BulkImportParams, type BulkImportResponse, type BulkImportSyncResponse, type Campaign, type CampaignStatus, type ChangeStatusParams, type CheckCompatibilityParams, type CheckSpellingParams, type CheckedLink, type ClientConfig, type CompatibilityResponse, type Contact, type ContactStatus, type CreateCampaignParams, type CreateContactParams, type CreateDomainParams, type CreateManagedDomainParams, type CreatePreviewParams, type CreatePreviewResponse, type CreateSegmentParams, type CreateTagParams, type CreateTopicParams, type CreateWebhookParams, type DeleteResponse, type DeliverabilityResponse, type DeviceCategoriesResponse, type DnsRecord, type Domain, type DomainAvailability, type DomainDeleteResponse, type DomainVerificationResult, type EditEmailParams, type Email, type EmailGenerationResult, type EmailGenerationStatus, type EmailImage, type ExportFile, type ExportFormat, type ExportFormatsResponse, type ExportResult, type ExportStatusResponse, type FieldCatalogEntry, type FieldCatalogEntryType, type FieldCatalogParams, type FieldCatalogResponse, type GenerateEmailParams, type GenerateEmailResponse, type GeneratedEmail, type GetDevicePreviewResponse, type GetPreviewResponse, type GetPreviewStatusResponse, type GetSupportedDevicesResponse, type HubspotExportParams, type ImportProjectParams, type ImportProjectResponse, type ImportStatusResponse, type KnowledgeBaseEntry, type KnowledgeBaseListResponse, type LinkAnalysisResponse, type ListCampaignsParams, type ListCampaignsResponse, type ListContactsParams, type ListContactsResponse, type ListEmailsEmail, type ListEmailsParams, type ListEmailsResponse, type ListProjectsParams, type ListProjectsResponse, type ListSegmentsResponse, type ListTagsParams, type ListTagsResponse, type ListTopicsParams, type ListTopicsResponse, type ListWebhooksResponse, type LogosResponse, type MessageResponse, Migma, MigmaClient, type MigmaConfig, MigmaError, MigmaErrorCode, type MigmaResult, type PollingOptions, type PreviewDevice, type PreviewDeviceCategory, type PreviewDeviceStatus, type PreviewMetadata, type PreviewStatus, type Project, type ProjectImage, type ProviderType, type RecipientType, type RetryImportResponse, type ScheduleCampaignParams, type Segment, type SegmentActivityFilter, type SegmentFieldFilter, type SegmentFilters, type SendEmailParams, type SendEmailResponse, type SendTestEmailParams, type SendTestEmailResponse, type SpellingResponse, type SupportedDevice, type Tag, type Topic, type TopicSubscriptionParams, type TopicSubscriptionResponse, type UpdateContactParams, type UpdateDomainParams, type UpdateImageParams, type UpdateKnowledgeBaseParams, type UpdateLogosParams, type UpdateSegmentParams, type UpdateTagParams, type UpdateTopicParams, type UpdateWebhookParams, type ValidateAllParams, type ValidateAllResponse, type Webhook, type WebhookDeliveriesResponse, type WebhookDelivery, type WebhookDetail, type WebhookEvent, type WebhookEventType, type WebhookEventsResponse, type WebhookTestResult, poll };
+export { type AddImageParams, type AddKnowledgeBaseParams, type AnalyzeDeliverabilityParams, type AnalyzeLinksParams, type ApiResponse, type BatchDeleteContactsParams, type BatchDeleteResponse, type BatchStatus, type BulkImportAsyncResponse, type BulkImportContactItem, type BulkImportJobStatus, type BulkImportParams, type BulkImportResponse, type BulkImportSyncResponse, type Campaign, type CampaignLog, type CampaignLogsParams, type CampaignLogsResponse, type CampaignStats, type CampaignStatus, type ChangeStatusParams, type CheckCompatibilityParams, type CheckSpellingParams, type CheckedLink, type ClientConfig, type CompatibilityResponse, type Contact, type ContactStatus, type CreateCampaignParams, type CreateContactParams, type CreateDomainParams, type CreateManagedDomainParams, type CreatePreviewParams, type CreatePreviewResponse, type CreateSegmentParams, type CreateTagParams, type CreateTopicParams, type CreateWebhookParams, type CreateWebhookResponse, type DeleteResponse, type DeliverabilityResponse, type DeviceCategoriesResponse, type DnsRecord, type Domain, type DomainAvailability, type DomainDeleteResponse, type DomainStream, type DomainVerificationResult, type EditEmailParams, type Email, type EmailGenerationResult, type EmailGenerationStatus, type EmailImage, type ExportFile, type ExportFormat, type ExportFormatsResponse, type ExportResult, type ExportStatusResponse, type FieldCatalogEntry, type FieldCatalogEntryType, type FieldCatalogParams, type FieldCatalogResponse, type GenerateEmailParams, type GenerateEmailResponse, type GeneratedEmail, type GetDevicePreviewResponse, type GetPreviewResponse, type GetPreviewStatusResponse, type GetSupportedDevicesResponse, type HubspotExportParams, type ImportProjectParams, type ImportProjectResponse, type ImportStatusResponse, type KnowledgeBaseEntry, type KnowledgeBaseListResponse, type LinkAnalysisResponse, type ListCampaignsParams, type ListCampaignsResponse, type ListContactsParams, type ListContactsResponse, type ListEmailsEmail, type ListEmailsParams, type ListEmailsResponse, type ListProjectsParams, type ListProjectsResponse, type ListSegmentsResponse, type ListTagsParams, type ListTagsResponse, type ListTopicsParams, type ListTopicsResponse, type ListWebhooksResponse, type LogosResponse, type MessageResponse, Migma, MigmaClient, type MigmaConfig, MigmaError, MigmaErrorCode, type MigmaResult, type PollingOptions, type PreviewDevice, type PreviewDeviceCategory, type PreviewDeviceStatus, type PreviewMetadata, type PreviewStatus, type Project, type ProjectImage, type ProviderType, type ProvisionStreamParams, type RecipientType, type RetryImportResponse, type ScheduleCampaignParams, type Segment, type SegmentActivityFilter, type SegmentFieldFilter, type SegmentFilters, type SendEmailParams, type SendEmailResponse, type SendTestEmailParams, type SendTestEmailResponse, type SetupDomainParams, type SetupDomainResponse, type SpellingResponse, type SupportedDevice, type Tag, type Topic, type TopicSubscriptionParams, type TopicSubscriptionResponse, type UpdateContactParams, type UpdateDomainParams, type UpdateImageParams, type UpdateKnowledgeBaseParams, type UpdateLogosParams, type UpdateSegmentParams, type UpdateTagParams, type UpdateTopicParams, type UpdateWebhookParams, type ValidateAllParams, type ValidateAllResponse, type Webhook, type WebhookDeliveriesResponse, type WebhookDelivery, type WebhookDetail, type WebhookEvent, type WebhookEventType, type WebhookEventsResponse, type WebhookTestResult, poll };