migma 1.3.3 → 1.4.0

package/dist/index.d.ts

@@ -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;
@@ -399,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;
@@ -430,7 +468,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>>;
 }
 
@@ -677,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;
@@ -684,7 +804,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,9 +815,18 @@ 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>>;
+    /**
+     * 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 {
@@ -975,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;
@@ -990,7 +1120,6 @@ interface Domain {
 }
 interface CreateDomainParams {
     domain: string;
-    region?: 'us-east-1' | 'eu-west-1';
 }
 interface UpdateDomainParams {
     openTracking?: boolean;
@@ -1009,7 +1138,32 @@ interface DomainAvailability {
 }
 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;
+    /** 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;
+    /** 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;
@@ -1029,6 +1183,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 +1216,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 +1273,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;
@@ -1178,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;
@@ -1241,20 +1416,121 @@ 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' | 'complained';
+}
+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>>;
 }
 
+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;
@@ -1280,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 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 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 };