migma 1.3.4 → 1.4.0

package/README.md

@@ -97,7 +97,7 @@ await migma.sending.send({
 
 ## Features
 
-- Full coverage of all Migma API v1 endpoints (80+ methods across 15 resources)
+- Full coverage of all Migma API v1 endpoints (80+ methods across 16 resources)
 - TypeScript-first with complete type definitions
 - `{ data, error }` return pattern — methods never throw
 - Automatic retries with exponential backoff on 5xx/429
@@ -227,6 +227,27 @@ const { data: deletion } = await migma.contacts.bulkDeleteByEmail({
   projectId: 'proj_abc123',
 });
 
+// Import contacts from a CSV file (multipart upload, processed in the background).
+// `file` accepts a Blob/File, a Buffer, or a ReadableStream.
+import { readFileSync } from 'node:fs';
+
+const { data: job } = await migma.contacts.imports.create({
+  file: readFileSync('./contacts.csv'),
+  projectId: 'proj_abc123',
+  columnMap: {
+    email: 'Email',
+    firstName: 'First Name',
+    customFields: { plan: 'Plan' },
+  },
+  onConflict: 'upsert',
+  tags: ['newsletter'],
+});
+
+// Poll for status + counts until the import finishes.
+const { data: status } = await migma.contacts.imports.get(job!.id);
+// status.status → 'pending' | 'processing' | 'completed' | 'failed'
+// status.counts → { total, created, updated, skipped, failed }
+
 // 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(
@@ -287,6 +308,23 @@ await migma.sending.send({
 
 [Sending API Reference](https://docs.migma.ai/api-reference/sending/send-email)
 
+### Sending Metrics
+
+Read account sending totals, delivery outcomes, and remaining daily and monthly capacity.
+
+```typescript
+const { data: metrics } = await migma.metrics.sending({ months: 6 });
+
+console.log(metrics?.period, metrics?.monthly.sent, metrics?.remainingMonth);
+console.log(metrics?.today.sent, metrics?.today.remainingToday);
+
+for (const month of metrics?.history ?? []) {
+  console.log(month.period, month.sent, month.delivered, month.bounced, month.complained);
+}
+```
+
+Omit `months` when you only need the current month and today's capacity.
+
 ### Generated Series and Editing
 
 Generate a series with `count`, then use each email's `emailId` to fetch, prompt-edit, or send one email.
@@ -601,10 +639,12 @@ await migma.images.updateLogos('proj_abc123', {
 | Resource | Methods | Docs |
 |----------|---------|------|
 | `migma.contacts` | `create` `list` `get` `update` `remove` `bulkImport` `getBulkImportStatus` `changeStatus` | [Contacts](https://docs.migma.ai/api-reference/contacts/get-contact) |
+| `migma.contacts.imports` | `create` `get` | [Contact imports](https://docs.migma.ai/api-reference/contacts/get-contact) |
 | `migma.tags` | `create` `list` `get` `update` `remove` | [Tags](https://docs.migma.ai/api-reference/tags/list-tags) |
 | `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.metrics` | `sending` | [API Reference](https://docs.migma.ai/api-reference/introduction) |
 | `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` `stats` `logs` `archive` `unarchive` | [Campaigns](https://docs.migma.ai/campaigns/overview) |

package/dist/index.d.mts

@@ -429,6 +429,14 @@ interface SendEmailResponse {
     status: string;
     sentCount?: number;
     message?: string;
+    /** Real tracking id for a single send — use with emails.metrics()/logs() and the activity view. Absent for batch sends. */
+    sendId?: string;
+    /** Batch id for an audience/tag send. Absent for single sends. */
+    batchId?: string;
+    /** Echoes the generated email id this send was tagged with, when provided. */
+    emailId?: string;
+    /** Conversation this send belongs to, when known. */
+    conversationId?: string;
 }
 interface BatchStatus {
     batchId: string;
@@ -707,6 +715,88 @@ interface EditEmailParams {
     prompt: string;
     label?: string;
 }
+interface EmailMetricsSummary {
+    totalEmails: number;
+    delivered: number;
+    opened: number;
+    clicked: number;
+    bounced: number;
+    complained: number;
+    unsubscribed: number;
+    /** 0-100 */
+    deliveryRate: number;
+    /** 0-100 */
+    openRate: number;
+    /** 0-100 */
+    clickRate: number;
+    /** 0-100 */
+    bounceRate: number;
+    /** 0-100 */
+    complaintRate: number;
+    /** 0-100 */
+    unsubscribeRate: number;
+}
+interface EmailMetricsTimePoint {
+    date: string;
+    sent: number;
+    delivered: number;
+    opened: number;
+    clicked: number;
+    bounced: number;
+    complained: number;
+}
+interface EmailMetricsCountry {
+    country: string;
+    count: number;
+}
+/**
+ * Aggregate performance for one generated email across every API send of it,
+ * plus a daily time series and country breakdown.
+ *
+ * Sourced from the email tracking worker, so values may be slightly stale and
+ * cover roughly the last 30 days of raw send history (aggregates persist
+ * longer). Opens are directional — Apple Mail Privacy Protection and bots
+ * inflate them; clicks and delivery events are stronger signals.
+ */
+interface EmailMetrics {
+    summary: EmailMetricsSummary;
+    timeSeries: EmailMetricsTimePoint[];
+    countryBreakdown: EmailMetricsCountry[];
+    /** ISO 8601 timestamp of when these stats were last refreshed. */
+    lastUpdated: string;
+    cached: boolean;
+}
+/**
+ * A single per-recipient send row for one generated email. Returned directly
+ * from the tracking worker's D1 table, so field names are snake_case.
+ */
+interface EmailSendLog {
+    id: number;
+    tracking_id: string;
+    domain: string;
+    from_email: string;
+    to_email: string;
+    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;
+    created_at: string;
+}
+interface EmailLogsParams {
+    limit?: number;
+    cursor?: string;
+    status?: 'delivered' | 'opened' | 'clicked' | 'bounced' | 'complained' | 'suppressed' | 'sent';
+}
+interface EmailLogsResponse {
+    emails: EmailSendLog[];
+    nextCursor: string | null;
+    hasMore: boolean;
+}
 
 declare class Emails {
     private readonly client;
@@ -728,6 +818,15 @@ declare class Emails {
     generateAndWait(params: GenerateEmailParams, options?: PollingOptions, callOptions?: CallOptions): Promise<MigmaResult<EmailGenerationStatus>>;
     /** Send a test email from a completed conversation */
     sendTest(params: SendTestEmailParams): Promise<MigmaResult<SendTestEmailResponse>>;
+    /**
+     * Aggregate performance for one generated email across every API send of it:
+     * delivery, opens, clicks, bounces, complaints, unsubscribes + a daily time
+     * series. Events arrive asynchronously; opens are directional while clicks
+     * and delivery events are stronger signals.
+     */
+    metrics(emailId: string): Promise<MigmaResult<EmailMetrics>>;
+    /** Per-recipient send log for one generated email (cursor-paginated). */
+    logs(emailId: string, params?: EmailLogsParams): Promise<MigmaResult<EmailLogsResponse>>;
 }
 
 interface CheckCompatibilityParams {
@@ -1005,6 +1104,7 @@ interface DnsRecord {
 }
 interface Domain {
     domain: string;
+    /** AWS region the domain sends from. Automatically assigned at creation. */
     region: string;
     status: string;
     isVerified?: boolean;
@@ -1020,7 +1120,6 @@ interface Domain {
 }
 interface CreateDomainParams {
     domain: string;
-    region?: 'us-east-1' | 'eu-west-1';
 }
 interface UpdateDomainParams {
     openTracking?: boolean;
@@ -1039,7 +1138,6 @@ interface DomainAvailability {
 }
 interface CreateManagedDomainParams {
     prefix: string;
-    region?: string;
 }
 type DomainStream = 'transactional' | 'marketing';
 interface ProvisionStreamParams {
@@ -1047,14 +1145,12 @@ interface ProvisionStreamParams {
     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. */
@@ -1257,7 +1353,7 @@ declare class Images {
     updateLogos(projectId: string, params: UpdateLogosParams): Promise<MigmaResult<LogosResponse>>;
 }
 
-type CampaignStatus = 'draft' | 'scheduled' | 'sending' | 'throttled' | 'ab_testing' | 'sent' | 'failed' | 'cancelled';
+type CampaignStatus = 'draft' | 'pending_review' | 'scheduled' | 'sending' | 'throttled' | 'ab_testing' | 'sent' | 'failed' | 'cancelled';
 interface Campaign {
     id: string;
     projectId: string;
@@ -1377,7 +1473,7 @@ interface CampaignLog {
 interface CampaignLogsParams {
     limit?: number;
     cursor?: string;
-    status?: 'delivered' | 'opened' | 'clicked' | 'bounced' | 'spam_report';
+    status?: 'delivered' | 'opened' | 'clicked' | 'bounced' | 'complained';
 }
 interface CampaignLogsResponse {
     emails: CampaignLog[];
@@ -1402,6 +1498,39 @@ declare class Campaigns {
     unarchive(id: string): Promise<MigmaResult<Campaign>>;
 }
 
+interface SendingMetricsParams {
+    months?: number;
+}
+interface SendingMetricsCounts {
+    sent: number;
+    delivered: number;
+    bounced: number;
+    complained: number;
+}
+interface SendingMetricsToday {
+    sent: number;
+    reserved: number;
+    dailyLimit: number;
+    remainingToday: number;
+}
+interface SendingMetricsHistoryEntry extends SendingMetricsCounts {
+    period: string;
+}
+interface SendingMetrics {
+    period: string;
+    monthly: SendingMetricsCounts;
+    today: SendingMetricsToday;
+    monthlyLimit: number;
+    remainingMonth: number;
+    history?: SendingMetricsHistoryEntry[];
+}
+
+declare class Metrics {
+    private readonly client;
+    constructor(client: MigmaClient);
+    sending(params?: SendingMetricsParams): Promise<MigmaResult<SendingMetrics>>;
+}
+
 interface MigmaConfig {
     /** API base URL. Default: 'https://api.migma.ai/v1' */
     baseUrl?: string;
@@ -1427,7 +1556,8 @@ declare class Migma {
     readonly knowledgeBase: KnowledgeBase;
     readonly images: Images;
     readonly campaigns: Campaigns;
+    readonly metrics: Metrics;
     constructor(apiKey: string, config?: MigmaConfig);
 }
 
-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 };
+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 EmailLogsParams, type EmailLogsResponse, type EmailMetrics, type EmailMetricsCountry, type EmailMetricsSummary, type EmailMetricsTimePoint, type EmailSendLog, 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 SendingMetrics, type SendingMetricsCounts, type SendingMetricsHistoryEntry, type SendingMetricsParams, type SendingMetricsToday, 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 };

package/dist/index.d.ts

@@ -429,6 +429,14 @@ interface SendEmailResponse {
     status: string;
     sentCount?: number;
     message?: string;
+    /** Real tracking id for a single send — use with emails.metrics()/logs() and the activity view. Absent for batch sends. */
+    sendId?: string;
+    /** Batch id for an audience/tag send. Absent for single sends. */
+    batchId?: string;
+    /** Echoes the generated email id this send was tagged with, when provided. */
+    emailId?: string;
+    /** Conversation this send belongs to, when known. */
+    conversationId?: string;
 }
 interface BatchStatus {
     batchId: string;
@@ -707,6 +715,88 @@ interface EditEmailParams {
     prompt: string;
     label?: string;
 }
+interface EmailMetricsSummary {
+    totalEmails: number;
+    delivered: number;
+    opened: number;
+    clicked: number;
+    bounced: number;
+    complained: number;
+    unsubscribed: number;
+    /** 0-100 */
+    deliveryRate: number;
+    /** 0-100 */
+    openRate: number;
+    /** 0-100 */
+    clickRate: number;
+    /** 0-100 */
+    bounceRate: number;
+    /** 0-100 */
+    complaintRate: number;
+    /** 0-100 */
+    unsubscribeRate: number;
+}
+interface EmailMetricsTimePoint {
+    date: string;
+    sent: number;
+    delivered: number;
+    opened: number;
+    clicked: number;
+    bounced: number;
+    complained: number;
+}
+interface EmailMetricsCountry {
+    country: string;
+    count: number;
+}
+/**
+ * Aggregate performance for one generated email across every API send of it,
+ * plus a daily time series and country breakdown.
+ *
+ * Sourced from the email tracking worker, so values may be slightly stale and
+ * cover roughly the last 30 days of raw send history (aggregates persist
+ * longer). Opens are directional — Apple Mail Privacy Protection and bots
+ * inflate them; clicks and delivery events are stronger signals.
+ */
+interface EmailMetrics {
+    summary: EmailMetricsSummary;
+    timeSeries: EmailMetricsTimePoint[];
+    countryBreakdown: EmailMetricsCountry[];
+    /** ISO 8601 timestamp of when these stats were last refreshed. */
+    lastUpdated: string;
+    cached: boolean;
+}
+/**
+ * A single per-recipient send row for one generated email. Returned directly
+ * from the tracking worker's D1 table, so field names are snake_case.
+ */
+interface EmailSendLog {
+    id: number;
+    tracking_id: string;
+    domain: string;
+    from_email: string;
+    to_email: string;
+    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;
+    created_at: string;
+}
+interface EmailLogsParams {
+    limit?: number;
+    cursor?: string;
+    status?: 'delivered' | 'opened' | 'clicked' | 'bounced' | 'complained' | 'suppressed' | 'sent';
+}
+interface EmailLogsResponse {
+    emails: EmailSendLog[];
+    nextCursor: string | null;
+    hasMore: boolean;
+}
 
 declare class Emails {
     private readonly client;
@@ -728,6 +818,15 @@ declare class Emails {
     generateAndWait(params: GenerateEmailParams, options?: PollingOptions, callOptions?: CallOptions): Promise<MigmaResult<EmailGenerationStatus>>;
     /** Send a test email from a completed conversation */
     sendTest(params: SendTestEmailParams): Promise<MigmaResult<SendTestEmailResponse>>;
+    /**
+     * Aggregate performance for one generated email across every API send of it:
+     * delivery, opens, clicks, bounces, complaints, unsubscribes + a daily time
+     * series. Events arrive asynchronously; opens are directional while clicks
+     * and delivery events are stronger signals.
+     */
+    metrics(emailId: string): Promise<MigmaResult<EmailMetrics>>;
+    /** Per-recipient send log for one generated email (cursor-paginated). */
+    logs(emailId: string, params?: EmailLogsParams): Promise<MigmaResult<EmailLogsResponse>>;
 }
 
 interface CheckCompatibilityParams {
@@ -1005,6 +1104,7 @@ interface DnsRecord {
 }
 interface Domain {
     domain: string;
+    /** AWS region the domain sends from. Automatically assigned at creation. */
     region: string;
     status: string;
     isVerified?: boolean;
@@ -1020,7 +1120,6 @@ interface Domain {
 }
 interface CreateDomainParams {
     domain: string;
-    region?: 'us-east-1' | 'eu-west-1';
 }
 interface UpdateDomainParams {
     openTracking?: boolean;
@@ -1039,7 +1138,6 @@ interface DomainAvailability {
 }
 interface CreateManagedDomainParams {
     prefix: string;
-    region?: string;
 }
 type DomainStream = 'transactional' | 'marketing';
 interface ProvisionStreamParams {
@@ -1047,14 +1145,12 @@ interface ProvisionStreamParams {
     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. */
@@ -1257,7 +1353,7 @@ declare class Images {
     updateLogos(projectId: string, params: UpdateLogosParams): Promise<MigmaResult<LogosResponse>>;
 }
 
-type CampaignStatus = 'draft' | 'scheduled' | 'sending' | 'throttled' | 'ab_testing' | 'sent' | 'failed' | 'cancelled';
+type CampaignStatus = 'draft' | 'pending_review' | 'scheduled' | 'sending' | 'throttled' | 'ab_testing' | 'sent' | 'failed' | 'cancelled';
 interface Campaign {
     id: string;
     projectId: string;
@@ -1377,7 +1473,7 @@ interface CampaignLog {
 interface CampaignLogsParams {
     limit?: number;
     cursor?: string;
-    status?: 'delivered' | 'opened' | 'clicked' | 'bounced' | 'spam_report';
+    status?: 'delivered' | 'opened' | 'clicked' | 'bounced' | 'complained';
 }
 interface CampaignLogsResponse {
     emails: CampaignLog[];
@@ -1402,6 +1498,39 @@ declare class Campaigns {
     unarchive(id: string): Promise<MigmaResult<Campaign>>;
 }
 
+interface SendingMetricsParams {
+    months?: number;
+}
+interface SendingMetricsCounts {
+    sent: number;
+    delivered: number;
+    bounced: number;
+    complained: number;
+}
+interface SendingMetricsToday {
+    sent: number;
+    reserved: number;
+    dailyLimit: number;
+    remainingToday: number;
+}
+interface SendingMetricsHistoryEntry extends SendingMetricsCounts {
+    period: string;
+}
+interface SendingMetrics {
+    period: string;
+    monthly: SendingMetricsCounts;
+    today: SendingMetricsToday;
+    monthlyLimit: number;
+    remainingMonth: number;
+    history?: SendingMetricsHistoryEntry[];
+}
+
+declare class Metrics {
+    private readonly client;
+    constructor(client: MigmaClient);
+    sending(params?: SendingMetricsParams): Promise<MigmaResult<SendingMetrics>>;
+}
+
 interface MigmaConfig {
     /** API base URL. Default: 'https://api.migma.ai/v1' */
     baseUrl?: string;
@@ -1427,7 +1556,8 @@ declare class Migma {
     readonly knowledgeBase: KnowledgeBase;
     readonly images: Images;
     readonly campaigns: Campaigns;
+    readonly metrics: Metrics;
     constructor(apiKey: string, config?: MigmaConfig);
 }
 
-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 };
+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 EmailLogsParams, type EmailLogsResponse, type EmailMetrics, type EmailMetricsCountry, type EmailMetricsSummary, type EmailMetricsTimePoint, type EmailSendLog, 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 SendingMetrics, type SendingMetricsCounts, type SendingMetricsHistoryEntry, type SendingMetricsParams, type SendingMetricsToday, 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 };

package/dist/index.js

@@ -524,6 +524,23 @@ var Emails = class {
       params
     );
   }
+  /**
+   * Aggregate performance for one generated email across every API send of it:
+   * delivery, opens, clicks, bounces, complaints, unsubscribes + a daily time
+   * series. Events arrive asynchronously; opens are directional while clicks
+   * and delivery events are stronger signals.
+   */
+  async metrics(emailId) {
+    return this.client.get(`/emails/${emailId}/metrics`);
+  }
+  /** Per-recipient send log for one generated email (cursor-paginated). */
+  async logs(emailId, params) {
+    return this.client.get(`/emails/${emailId}/logs`, {
+      limit: params?.limit,
+      cursor: params?.cursor,
+      status: params?.status
+    });
+  }
 };
 
 // src/resources/validation.ts
@@ -852,6 +869,18 @@ var Campaigns = class {
   }
 };
 
+// src/resources/metrics.ts
+var Metrics = class {
+  constructor(client) {
+    this.client = client;
+  }
+  async sending(params) {
+    return this.client.get("/metrics/sending", {
+      months: params?.months
+    });
+  }
+};
+
 // src/migma.ts
 var Migma = class {
   client;
@@ -870,6 +899,7 @@ var Migma = class {
   knowledgeBase;
   images;
   campaigns;
+  metrics;
   constructor(apiKey, config) {
     if (!apiKey) {
       throw new Error(
@@ -896,6 +926,7 @@ var Migma = class {
     this.knowledgeBase = new KnowledgeBase(this.client);
     this.images = new Images(this.client);
     this.campaigns = new Campaigns(this.client);
+    this.metrics = new Metrics(this.client);
   }
 };