groundmail 0.0.0-stage → 0.14.1

package/dist/client-DdrSVDkA.d.ts

@@ -0,0 +1,950 @@
+type ApiErrorCode = 'validation_error' | 'unauthorized' | 'forbidden' | 'not_found' | 'conflict' | 'plan_limit' | 'domain_limit' | 'idempotency_conflict' | 'rate_limited' | 'upstream_error' | 'not_configured' | 'internal_error';
+type SendEmailParams = {
+    from: string | {
+        email: string;
+        name?: string;
+    };
+    to: string | string[];
+    /** Required unless `template` supplies the subject. */
+    subject?: string;
+    html?: string;
+    htmlBody?: string;
+    html_body?: string;
+    text?: string;
+    textBody?: string;
+    text_body?: string;
+    plain_body?: string;
+    /**
+     * React Email element (third-party MIT project — see https://react.email).
+     * Compiled to HTML via optional peer `@react-email/render` in your app before
+     * the request is sent. Mutually exclusive with `html` / `text` / `template`.
+     */
+    react?: unknown;
+    /** Send using a published template (id or alias). Mutually exclusive with html/text/react. */
+    template?: {
+        id: string;
+        variables?: Record<string, string | number | boolean>;
+    };
+    replyTo?: string | string[];
+    reply_to?: string | string[];
+    cc?: string | string[];
+    bcc?: string | string[];
+    tags?: Array<{
+        name: string;
+        value: string;
+    }> | Record<string, string>;
+    headers?: Record<string, string>;
+    tag?: string;
+    attachments?: Array<{
+        name?: string;
+        filename?: string;
+        content_type?: string;
+        contentType?: string;
+        data?: string;
+        content?: string;
+        content_id?: string;
+        contentId?: string;
+    }>;
+    scheduledAt?: string | Date;
+    scheduled_at?: string | Date;
+    /** Optional Idempotency-Key (24h TTL). */
+    idempotencyKey?: string;
+    /** Opt in to managed unsubscribe for this send. */
+    unsubscribe?: boolean;
+    /** Optional category override for preference management. */
+    category?: 'transactional' | 'product' | 'newsletter';
+};
+type SendEmailResult = {
+    id: string;
+    status: string;
+};
+type BatchSendEmailResult = {
+    data: Array<{
+        index: number;
+        id?: string;
+        status?: string;
+        error?: {
+            message: string;
+            code?: string;
+            details?: unknown;
+            status_code?: number;
+        };
+    }>;
+};
+type UpdateEmailParams = {
+    scheduledAt?: string | Date;
+    scheduled_at?: string | Date;
+    cancel?: boolean;
+};
+type EmailListItem = {
+    id: string;
+    from: string;
+    to: string[];
+    cc: string[];
+    bcc: string[];
+    reply_to: string[];
+    subject: string;
+    status: string;
+    last_event: string | null;
+    bounce_reason: string | null;
+    tags: unknown;
+    scheduled_at: string | null;
+    cancelled_at: string | null;
+    created_at: string;
+    sent_at: string | null;
+    delivered_at: string | null;
+    bounced_at: string | null;
+};
+type ReceivedEmailAttachmentMeta = {
+    filename: string;
+    content_type: string;
+    size: number;
+    content_id?: string | null;
+};
+type ReceivedEmailAttachment = ReceivedEmailAttachmentMeta & {
+    data?: string;
+};
+type ReceivedEmail = {
+    id: string;
+    domain_id: string;
+    domain_name: string;
+    status: 'received' | string;
+    rcpt_to: string;
+    mail_from: string | null;
+    from: string;
+    to: string[];
+    cc: string[];
+    subject: string;
+    spam_status: string | null;
+    bounced: boolean;
+    received_with_ssl: boolean | null;
+    message_id: string | null;
+    in_reply_to: string | null;
+    references: string[];
+    attachment_count: number;
+    attachments: ReceivedEmailAttachment[];
+    text_body: string | null;
+    html_body: string | null;
+    auto_submitted: string | null;
+    received_at: string;
+    created_at: string;
+};
+type ListReceivedEmailsParams = {
+    limit?: number;
+    cursor?: string;
+    domain?: string;
+};
+type ListReceivedEmailsResult = {
+    received_emails: ReceivedEmail[];
+    has_more: boolean;
+    next_cursor: string | null;
+};
+type ListEmailsParams = {
+    limit?: number;
+    cursor?: string;
+};
+type ListEmailsResult = {
+    emails: EmailListItem[];
+    has_more: boolean;
+    next_cursor: string | null;
+};
+type DeliverabilityWindow = '7d' | '30d';
+type DeliverabilityBucket = {
+    total_emails: number;
+    attempted: number;
+    sent: number;
+    delivered: number;
+    bounced: number;
+    complained: number;
+    failed: number;
+    suppressed: number;
+    scheduled: number;
+    opened: number;
+    clicked: number;
+    bounce_rate: number;
+    complaint_rate: number;
+    delivery_rate: number;
+    open_rate: number;
+    click_rate: number;
+};
+type DeliverabilityMailServerRelay = {
+    window_days: number;
+    total_messages: number;
+    sent: number;
+    bounced: number;
+    failed: number;
+    delayed: number;
+};
+type DeliverabilityDomainInsight = DeliverabilityBucket & {
+    domain: string;
+    mail_server_relay?: DeliverabilityMailServerRelay;
+};
+type DeliverabilityInsightsResult = {
+    window: DeliverabilityWindow;
+    window_start: string;
+    generated_at: string;
+    summary: DeliverabilityBucket;
+    by_domain: DeliverabilityDomainInsight[];
+    top_bounce_reasons: Array<{
+        reason: string;
+        count: number;
+    }>;
+    notes: string[];
+};
+type ApiKeyScope = 'full' | 'sending';
+type ApiKey = {
+    id: string;
+    name: string;
+    scope: ApiKeyScope;
+    prefix: string;
+    created_at: string;
+    last_used_at: string | null;
+};
+type ListApiKeysParams = {
+    limit?: number;
+    cursor?: string;
+};
+type ListApiKeysResult = {
+    data: ApiKey[];
+    has_more: boolean;
+    next_cursor: string | null;
+};
+type CreateApiKeyParams = {
+    name?: string;
+    scope?: ApiKeyScope;
+};
+type CreateApiKeyResult = {
+    id: string;
+    name: string;
+    scope: ApiKeyScope;
+    prefix: string;
+    token: string;
+    created_at: string;
+};
+type SmtpCredential = {
+    id: string;
+    name: string;
+    password_prefix: string;
+    username: string;
+    host: string;
+    port: number;
+    last_used_at: string | null;
+    revoked_at: string | null;
+    created_at: string;
+};
+type ListSmtpCredentialsParams = {
+    limit?: number;
+    cursor?: string;
+};
+type ListSmtpCredentialsResult = {
+    data: SmtpCredential[];
+    has_more: boolean;
+    next_cursor: string | null;
+};
+type CreateSmtpCredentialParams = {
+    name?: string;
+};
+type CreateSmtpCredentialResult = SmtpCredential & {
+    password: string;
+};
+type WebhookEventType = 'email.received' | 'email.sent' | 'email.delivered' | 'email.delivery_delayed' | 'email.bounced' | 'email.complained' | 'email.opened' | 'email.clicked' | 'email.failed' | 'email.suppressed' | 'email.scheduled' | 'contact.unsubscribed' | 'automation.started' | 'automation.step_completed' | 'automation.completed' | 'automation.failed';
+/** `contact.unsubscribed` webhook payload (`scope` distinguishes global vs category opt-out). */
+type ContactWebhookEventPayload = {
+    type: 'contact.unsubscribed';
+    created_at: string;
+    data: {
+        email: string;
+        source: 'unsubscribe';
+        scope: 'all' | 'category';
+        category?: 'product' | 'newsletter' | null;
+        category_label?: string | null;
+        suppression_id?: string | null;
+        category_opt_out_id?: string | null;
+        email_id?: string | null;
+    };
+};
+/** `details` on `POST /emails` 422 when recipients opted out of a category. */
+type CategoryUnsubscribedErrorDetails = {
+    category_unsubscribed: string[];
+    category: 'product' | 'newsletter' | string;
+    email_id: string;
+};
+/** `details` on `POST /emails` 422 when recipients are globally suppressed. */
+type SuppressedErrorDetails = {
+    suppressed: string[];
+    email_id: string;
+};
+/** Event types accepted by `POST /emails/test`. */
+type EmailWebhookEventType = 'email.received' | 'email.sent' | 'email.delivered' | 'email.delivery_delayed' | 'email.bounced' | 'email.complained' | 'email.opened' | 'email.clicked' | 'email.failed' | 'email.suppressed' | 'email.scheduled';
+type TestEmailWebhookParams = {
+    event: EmailWebhookEventType;
+    email_id?: string;
+    webhook_id?: string;
+    /** When true, deliver synchronously and return per-endpoint results. */
+    sync?: boolean;
+    /** When true (default), enqueue delivery to account webhooks. */
+    deliver?: boolean;
+};
+type WebhookTestDelivery = {
+    endpoint_id: string;
+    url: string;
+    success: boolean;
+    status?: number;
+    error?: string;
+};
+type TestEmailWebhookResult = {
+    ok: boolean;
+    payload: unknown;
+    delivered: boolean;
+    deliveries: WebhookTestDelivery[];
+};
+type TriggerEventParams = {
+    name?: string;
+    type?: string;
+    user_id?: string;
+    userId?: string;
+    email?: string;
+    data?: Record<string, unknown>;
+    idempotencyKey?: string;
+};
+type EventRecord = {
+    id: string;
+    name: string;
+    user_id: string | null;
+    email: string | null;
+    data: Record<string, unknown>;
+    source: string;
+    created_at: string;
+};
+type TriggerEventResult = {
+    event: EventRecord;
+    matched_automations: number;
+    resumed_runs: number;
+    cancelled_runs: number;
+};
+type AutomationStatus = 'draft' | 'active' | 'paused';
+type AutomationTrigger = {
+    type: 'event';
+    event: string;
+    cancel_on_events?: string[];
+};
+type AutomationStep = {
+    type: 'delay' | 'send_email' | 'send_sms' | 'condition' | 'wait_for_event';
+    [key: string]: unknown;
+};
+type TwilioIntegrationStatus = {
+    connected: boolean;
+    hint: string | null;
+    connectedAt: string | null;
+    defaultFrom: string | null;
+    messagingServiceSid: string | null;
+};
+type TwilioIntegrationResponse = {
+    twilio: TwilioIntegrationStatus;
+};
+type ConnectTwilioParams = {
+    accountSid: string;
+    authToken: string;
+    defaultFrom?: string;
+    messagingServiceSid?: string;
+};
+type Automation = {
+    id: string;
+    name: string;
+    status: AutomationStatus;
+    trigger: AutomationTrigger;
+    steps: AutomationStep[];
+    created_at: string;
+    updated_at: string;
+};
+type CreateAutomationParams = {
+    name: string;
+    trigger: AutomationTrigger;
+    steps: AutomationStep[];
+};
+type UpdateAutomationParams = {
+    name?: string;
+    trigger?: AutomationTrigger;
+    steps?: AutomationStep[];
+};
+type ListAutomationsResult = {
+    automations: Automation[];
+};
+type AutomationRunStatus = 'queued' | 'running' | 'waiting' | 'completed' | 'failed' | 'cancelled';
+type AutomationRunStepStatus = 'started' | 'waiting' | 'completed' | 'failed';
+type AutomationRunStep = {
+    id: string;
+    step_index: number;
+    step_type: AutomationStep['type'] | string;
+    status: AutomationRunStepStatus | string;
+    output: unknown;
+    error: string | null;
+    started_at: string;
+    completed_at: string | null;
+    created_at: string;
+    updated_at: string;
+};
+type AutomationRun = {
+    id: string;
+    automation_id: string;
+    trigger_event_id: string | null;
+    status: AutomationRunStatus | string;
+    current_step: number;
+    waiting_for_event: string | null;
+    wait_timeout_at: string | null;
+    context: Record<string, unknown>;
+    last_error: string | null;
+    cancel_requested_at: string | null;
+    started_at: string | null;
+    completed_at: string | null;
+    created_at: string;
+    updated_at: string;
+    automation?: Automation;
+    trigger_event?: EventRecord;
+    steps?: AutomationRunStep[];
+};
+type AutomationRunResponse = {
+    run: AutomationRun;
+};
+type ListAutomationRunsParams = {
+    automation_id?: string;
+};
+type ListAutomationRunsResult = {
+    runs: AutomationRun[];
+};
+type WebhookEndpoint = {
+    id: string;
+    url: string;
+    events: string[];
+    enabled: boolean;
+    created_at: string;
+    updated_at: string;
+};
+type CreateWebhookParams = {
+    url: string;
+    events?: WebhookEventType[];
+};
+type UpdateWebhookParams = {
+    url?: string;
+    events?: WebhookEventType[];
+    enabled?: boolean;
+};
+type WebhookEndpointWithSecret = {
+    webhook: WebhookEndpoint;
+    secret: string;
+};
+type Suppression = {
+    id: string;
+    email: string;
+    reason: string | null;
+    source: string;
+    created_at: string;
+    updated_at: string;
+};
+type ListSuppressionsParams = {
+    limit?: number;
+    cursor?: string;
+    email?: string;
+};
+type ListSuppressionsResult = {
+    data: Suppression[];
+    has_more: boolean;
+    next_cursor: string | null;
+};
+type CreateSuppressionParams = {
+    email: string;
+    reason?: string;
+};
+type TemplateStatus = 'draft' | 'published';
+type TemplateFormat = 'html' | 'blocks';
+type TemplateLintWarning = {
+    code: 'svg_image' | 'relative_image_url' | 'data_uri_image' | 'missing_alt' | 'non_https_image' | 'empty_href' | 'raw_html_block' | 'low_contrast' | 'html_too_large';
+    message: string;
+    detail?: string;
+};
+type Template = {
+    id: string;
+    name: string;
+    alias: string | null;
+    status: TemplateStatus | string;
+    format: TemplateFormat | string;
+    subject: string;
+    preheader: string | null;
+    html: string | null;
+    text: string | null;
+    design: Record<string, unknown> | null;
+    variables: string[] | null;
+    unsubscribe_enabled: boolean;
+    category: 'transactional' | 'product' | 'newsletter' | string;
+    published_version_id: string | null;
+    published_at: string | null;
+    created_at: string;
+    updated_at: string;
+    warnings?: TemplateLintWarning[];
+};
+type TemplateVersion = {
+    id: string;
+    template_id: string;
+    version: number;
+    format: 'html' | 'blocks';
+    subject: string;
+    preheader: string | null;
+    design: Record<string, unknown> | null;
+    html: string | null;
+    text: string | null;
+    variables: string[] | null;
+    created_by_user_id: string | null;
+    label: string | null;
+    created_at: string;
+};
+type Asset = {
+    id: string;
+    key: string;
+    url: string;
+    content_type: string;
+    bytes: number;
+    width: number | null;
+    height: number | null;
+    created_at: string;
+};
+type ListTemplatesParams = {
+    limit?: number;
+    cursor?: string;
+    status?: TemplateStatus;
+};
+type ListTemplatesResult = {
+    data: Template[];
+    has_more: boolean;
+    next_cursor: string | null;
+};
+type CreateTemplateParams = {
+    name: string;
+    subject: string;
+    format?: TemplateFormat;
+    preheader?: string;
+    html?: string;
+    text?: string;
+    design?: Record<string, unknown>;
+    alias?: string;
+    variables?: string[];
+    unsubscribe_enabled?: boolean;
+    category?: 'transactional' | 'product' | 'newsletter';
+};
+type TemplateStarter = {
+    alias: string;
+    name: string;
+    description: string;
+    subject: string;
+    preheader?: string | null;
+    html: string;
+    text: string;
+    design?: Record<string, unknown> | null;
+    variables: string[];
+    unsubscribe_enabled: boolean;
+};
+type UpdateTemplateParams = {
+    name?: string;
+    subject?: string;
+    format?: TemplateFormat;
+    preheader?: string | null;
+    html?: string | null;
+    text?: string | null;
+    design?: Record<string, unknown> | null;
+    alias?: string | null;
+    variables?: string[] | null;
+    unsubscribe_enabled?: boolean;
+    category?: 'transactional' | 'product' | 'newsletter' | null;
+};
+type GroundmailOptions = {
+    baseUrl?: string;
+    fetch?: typeof fetch;
+};
+type DomainStatus = 'pending' | 'verified' | 'failed';
+type DomainTlsMode = 'opportunistic' | 'enforced';
+type DomainDmarcAnalysis = {
+    host: string;
+    configured: boolean;
+    record: string | null;
+    policy: string | null;
+    rua: string[];
+    guidance: string;
+};
+type DomainBimiAnalysis = {
+    host: string;
+    configured: boolean;
+    record: string | null;
+    location: string | null;
+    authority: string | null;
+    requires_dmarc_enforcement: boolean;
+    guidance: string;
+};
+type DomainDnsAnalysis = {
+    dmarc: DomainDmarcAnalysis;
+    bimi: DomainBimiAnalysis;
+};
+type DomainTrackingDns = {
+    required: boolean;
+    host: string | null;
+    target: string | null;
+    ok: boolean | null;
+};
+type Domain = {
+    id: string;
+    name: string;
+    status: DomainStatus | string;
+    created_at: string;
+    verified_at: string | null;
+    open_tracking: boolean;
+    click_tracking: boolean;
+    tls_mode: DomainTlsMode | string;
+    inbound_enabled: boolean;
+    inbound_status: 'disabled' | 'pending' | 'active' | 'error' | string;
+    inbound_error: string | null;
+};
+type DnsRecord = {
+    type: string;
+    host: string;
+    value: string;
+    purpose: string;
+    /** MX preference when `type` is `MX`. Mail hostname is in `value`. */
+    priority?: number;
+};
+type CreateDomainParams = {
+    name: string;
+    inbound_enabled?: boolean;
+    inboundEnabled?: boolean;
+};
+type ListDomainsParams = {
+    limit?: number;
+    cursor?: string;
+    inbound_enabled?: boolean;
+    inboundEnabled?: boolean;
+};
+type ListDomainsResult = {
+    domains: Domain[];
+    has_more: boolean;
+    next_cursor: string | null;
+};
+type CreateDomainResult = {
+    domain: Domain;
+    records: DnsRecord[];
+    inbound_records: DnsRecord[];
+    inbound_note: string;
+    mail_server_dns_synced?: boolean;
+    mail_server_dns_error?: string;
+};
+type DomainDetailResult = {
+    domain: Domain;
+    records: DnsRecord[];
+    analysis: DomainDnsAnalysis;
+    inbound_records: DnsRecord[];
+    inbound_note: string;
+    inbound_configured?: boolean;
+    inbound_pending?: boolean;
+    inbound_error?: string | null;
+    tracking_dns?: DomainTrackingDns;
+    tracking_error?: string | null;
+    tls_error?: string | null;
+};
+type MailServerSigningStatus = {
+    dkim_ok?: boolean;
+    return_path_ok?: boolean;
+    dkim_status?: string | null;
+    return_path_status?: string | null;
+};
+type VerifyDomainResult = {
+    domain: Domain;
+    records: DnsRecord[];
+    analysis?: DomainDnsAnalysis;
+    inbound_records?: DnsRecord[];
+    inbound_note?: string;
+    verified: boolean;
+    checks?: {
+        ownership: boolean;
+        spf: boolean;
+        dkim: boolean;
+        dmarc: boolean;
+    };
+    auto?: boolean;
+    inbound_configured?: boolean;
+    inbound_pending?: boolean;
+    inbound_error?: string | null;
+    signing_ready?: boolean;
+    mail_server_signing?: MailServerSigningStatus;
+};
+type UpdateDomainParams = {
+    open_tracking?: boolean;
+    openTracking?: boolean;
+    click_tracking?: boolean;
+    clickTracking?: boolean;
+    tls_mode?: DomainTlsMode;
+    tlsMode?: DomainTlsMode;
+    inbound_enabled?: boolean;
+    inboundEnabled?: boolean;
+};
+type DnsProviderName = 'cloudflare' | 'godaddy' | 'vercel';
+type RemoteApplyDnsCredentials = {
+    /** Inline Cloudflare token instead of the stored dashboard integration. */
+    apiToken?: string;
+    zoneId?: string;
+    cloudflareApiToken?: string;
+    cloudflareZoneId?: string;
+    /** GoDaddy one-time credentials. */
+    apiKey?: string;
+    apiSecret?: string;
+    godaddyApiKey?: string;
+    godaddyApiSecret?: string;
+    vercelApiToken?: string;
+    vercelTeamId?: string;
+};
+type ApplyDnsParams = {
+    provider: DnsProviderName;
+    /** Domain id or name (fetched from Groundmail for DNS records). */
+    idOrName: string;
+    cloudflareApiToken?: string;
+    cloudflareZoneId?: string;
+    godaddyApiKey?: string;
+    godaddyApiSecret?: string;
+    vercelApiToken?: string;
+    vercelTeamId?: string;
+};
+type ApplyDnsRecordResult = {
+    purpose: string;
+    host: string;
+    action: 'created' | 'updated' | 'unchanged' | 'merged';
+    detail?: string;
+};
+type ApplyDnsResult = {
+    provider: DnsProviderName;
+    domain: string;
+    results: ApplyDnsRecordResult[];
+};
+type ApiErrorBody = {
+    error?: string | {
+        message?: string;
+        details?: unknown;
+        code?: string;
+        upgrade_url?: string;
+    };
+};
+
+declare class AutomationsResource {
+    private readonly client;
+    constructor(client: Groundmail);
+    list(): Promise<ListAutomationsResult>;
+    get(id: string): Promise<{
+        automation: Automation;
+    }>;
+    create(params: CreateAutomationParams): Promise<{
+        automation: Automation;
+    }>;
+    update(id: string, params: UpdateAutomationParams): Promise<{
+        automation: Automation;
+    }>;
+    remove(id: string): Promise<{
+        ok: boolean;
+    }>;
+    activate(id: string): Promise<{
+        automation: Automation;
+    }>;
+    pause(id: string): Promise<{
+        automation: Automation;
+    }>;
+    listRuns(params?: ListAutomationRunsParams): Promise<ListAutomationRunsResult>;
+    getRun(id: string): Promise<AutomationRunResponse>;
+    cancelRun(id: string): Promise<AutomationRunResponse>;
+    retryRun(id: string): Promise<AutomationRunResponse>;
+}
+
+declare class DomainsResource {
+    private readonly client;
+    constructor(client: Groundmail);
+    list(params?: ListDomainsParams): Promise<ListDomainsResult>;
+    get(idOrName: string): Promise<DomainDetailResult>;
+    create(params: CreateDomainParams): Promise<CreateDomainResult>;
+    verify(idOrName: string): Promise<VerifyDomainResult>;
+    update(idOrName: string, params: UpdateDomainParams): Promise<DomainDetailResult>;
+    delete(idOrName: string): Promise<{
+        ok: boolean;
+    }>;
+    /**
+     * Apply DNS using the public API. Cloudflare, Vercel, and GoDaddy can use stored dashboard
+     * credentials; GoDaddy also accepts one-time credentials on the request.
+     */
+    apply(idOrName: string, options?: {
+        provider?: 'cloudflare' | 'godaddy' | 'vercel';
+        credentials?: RemoteApplyDnsCredentials;
+    }): Promise<ApplyDnsResult>;
+    /**
+     * Fetch Groundmail DNS records, then write them at Cloudflare, Vercel, or GoDaddy
+     * using the caller's provider credentials (never sent to Groundmail).
+     */
+    applyDns(params: ApplyDnsParams): Promise<ApplyDnsResult>;
+}
+
+declare class EmailsResource {
+    private readonly client;
+    constructor(client: Groundmail);
+    list(params?: ListEmailsParams): Promise<ListEmailsResult>;
+    get(id: string): Promise<{
+        email: EmailListItem;
+    }>;
+    insights(window?: DeliverabilityWindow): Promise<DeliverabilityInsightsResult>;
+    send(params: SendEmailParams): Promise<SendEmailResult>;
+    batch(emails: SendEmailParams[]): Promise<BatchSendEmailResult>;
+    update(id: string, params: UpdateEmailParams): Promise<SendEmailResult>;
+    cancel(id: string): Promise<SendEmailResult>;
+    /** Create a new send from a previously stored email (new `msg_…` id). */
+    resend(id: string): Promise<SendEmailResult>;
+    /** Simulate a webhook event for CI / local testing (`POST /emails/test`). */
+    testWebhook(params: TestEmailWebhookParams): Promise<TestEmailWebhookResult>;
+    private serializeSendParams;
+}
+
+declare class EventsResource {
+    private readonly client;
+    constructor(client: Groundmail);
+    trigger(params: TriggerEventParams): Promise<TriggerEventResult>;
+}
+
+declare class IntegrationsResource {
+    private readonly client;
+    constructor(client: Groundmail);
+    getTwilio(): Promise<TwilioIntegrationResponse>;
+    connectTwilio(params: ConnectTwilioParams): Promise<TwilioIntegrationResponse>;
+    disconnectTwilio(): Promise<TwilioIntegrationResponse>;
+}
+
+declare class KeysResource {
+    private readonly client;
+    constructor(client: Groundmail);
+    list(params?: ListApiKeysParams): Promise<ListApiKeysResult>;
+    create(params?: CreateApiKeyParams): Promise<CreateApiKeyResult>;
+    remove(id: string): Promise<{
+        ok: boolean;
+    }>;
+}
+
+declare class SmtpCredentialsResource {
+    private readonly client;
+    constructor(client: Groundmail);
+    list(params?: ListSmtpCredentialsParams): Promise<ListSmtpCredentialsResult>;
+    create(params?: CreateSmtpCredentialParams): Promise<CreateSmtpCredentialResult>;
+    remove(id: string): Promise<{
+        ok: boolean;
+    }>;
+}
+
+declare class ReceivedEmailsResource {
+    private readonly client;
+    constructor(client: Groundmail);
+    list(params?: ListReceivedEmailsParams): Promise<ListReceivedEmailsResult>;
+    get(id: string): Promise<{
+        received_email: ReceivedEmail;
+    }>;
+}
+
+declare class SuppressionsResource {
+    private readonly client;
+    constructor(client: Groundmail);
+    list(params?: ListSuppressionsParams): Promise<ListSuppressionsResult>;
+    create(params: CreateSuppressionParams): Promise<{
+        suppression: Suppression;
+    }>;
+    /** Remove by suppression id or email address. */
+    remove(idOrEmail: string): Promise<{
+        ok: boolean;
+    }>;
+}
+
+declare class TemplatesResource {
+    private readonly client;
+    constructor(client: Groundmail);
+    list(params?: ListTemplatesParams): Promise<ListTemplatesResult>;
+    get(idOrAlias: string): Promise<{
+        template: Template;
+    }>;
+    create(params: CreateTemplateParams): Promise<{
+        template: Template;
+    }>;
+    update(idOrAlias: string, params: UpdateTemplateParams): Promise<{
+        template: Template;
+    }>;
+    remove(idOrAlias: string): Promise<{
+        ok: boolean;
+    }>;
+    publish(idOrAlias: string): Promise<{
+        template: Template;
+    }>;
+    duplicate(idOrAlias: string, params?: {
+        name?: string;
+    }): Promise<{
+        template: Template;
+    }>;
+    listStarters(): Promise<{
+        data: TemplateStarter[];
+    }>;
+    fromStarter(alias: string): Promise<{
+        template: Template;
+    }>;
+    listVersions(idOrAlias: string): Promise<{
+        data: TemplateVersion[];
+        published_version_id: string | null;
+    }>;
+    restoreVersion(idOrAlias: string, version: number): Promise<{
+        template: Template;
+    }>;
+    testSend(idOrAlias: string, params: {
+        to: string;
+        from: string;
+        variables?: Record<string, unknown>;
+    }): Promise<unknown>;
+}
+
+declare class WebhooksResource {
+    private readonly client;
+    constructor(client: Groundmail);
+    list(params?: {
+        limit?: number;
+        cursor?: string;
+    }): Promise<{
+        webhooks: WebhookEndpoint[];
+        has_more: boolean;
+        next_cursor: string | null;
+    }>;
+    get(id: string): Promise<{
+        webhook: WebhookEndpoint;
+    }>;
+    create(params: CreateWebhookParams): Promise<WebhookEndpointWithSecret>;
+    update(id: string, params: UpdateWebhookParams): Promise<{
+        webhook: WebhookEndpoint;
+    }>;
+    delete(id: string): Promise<{
+        ok: boolean;
+    }>;
+    /** Verify an incoming webhook signature (same as `verifyWebhookSignature`). */
+    verify(secret: string, payload: string, header: string | null | undefined, toleranceSec?: number): boolean;
+}
+
+declare const DEFAULT_API_BASE_URL = "https://api.groundmail.dev";
+declare class Groundmail {
+    private readonly apiKey;
+    private readonly options;
+    readonly domains: DomainsResource;
+    readonly emails: EmailsResource;
+    readonly receivedEmails: ReceivedEmailsResource;
+    readonly events: EventsResource;
+    readonly automations: AutomationsResource;
+    readonly webhooks: WebhooksResource;
+    readonly integrations: IntegrationsResource;
+    readonly apiKeys: KeysResource;
+    readonly smtpCredentials: SmtpCredentialsResource;
+    readonly suppressions: SuppressionsResource;
+    readonly templates: TemplatesResource;
+    constructor(apiKey: string, options?: GroundmailOptions);
+    get baseUrl(): string;
+    get fetchImpl(): typeof fetch;
+    request<T>(path: string, init: RequestInit): Promise<T>;
+}
+
+export { type ListAutomationRunsParams as $, type ApiErrorBody as A, type BatchSendEmailResult as B, type CategoryUnsubscribedErrorDetails as C, type DnsRecord as D, DEFAULT_API_BASE_URL as E, type DeliverabilityBucket as F, Groundmail as G, type DeliverabilityDomainInsight as H, type DeliverabilityInsightsResult as I, type DeliverabilityMailServerRelay as J, type DeliverabilityWindow as K, type DnsProviderName as L, type Domain as M, type DomainBimiAnalysis as N, type DomainDetailResult as O, type DomainDmarcAnalysis as P, type DomainDnsAnalysis as Q, type DomainStatus as R, type SendEmailResult as S, type DomainTlsMode as T, type DomainTrackingDns as U, type EmailListItem as V, type EmailWebhookEventType as W, type EventRecord as X, type GroundmailOptions as Y, type ListApiKeysParams as Z, type ListApiKeysResult as _, type ApiErrorCode as a, type ListAutomationRunsResult as a0, type ListAutomationsResult as a1, type ListDomainsParams as a2, type ListDomainsResult as a3, type ListEmailsParams as a4, type ListEmailsResult as a5, type ListReceivedEmailsParams as a6, type ListReceivedEmailsResult as a7, type ListSuppressionsParams as a8, type ListSuppressionsResult as a9, type UpdateWebhookParams as aA, type VerifyDomainResult as aB, type WebhookEndpoint as aC, type WebhookEndpointWithSecret as aD, type WebhookEventType as aE, type ListTemplatesParams as aa, type ListTemplatesResult as ab, type MailServerSigningStatus as ac, type ReceivedEmail as ad, type ReceivedEmailAttachment as ae, type ReceivedEmailAttachmentMeta as af, type RemoteApplyDnsCredentials as ag, type SendEmailParams as ah, type SuppressedErrorDetails as ai, type Suppression as aj, type Template as ak, type TemplateFormat as al, type TemplateLintWarning as am, type TemplateStarter as an, type TemplateStatus as ao, type TemplateVersion as ap, type TestEmailWebhookParams as aq, type TestEmailWebhookResult as ar, type TriggerEventParams as as, type TriggerEventResult as at, type TwilioIntegrationResponse as au, type TwilioIntegrationStatus as av, type UpdateAutomationParams as aw, type UpdateDomainParams as ax, type UpdateEmailParams as ay, type UpdateTemplateParams as az, type ApiKey as b, type ApiKeyScope as c, type ApplyDnsParams as d, type ApplyDnsRecordResult as e, type ApplyDnsResult as f, type Asset as g, type Automation as h, type AutomationRun as i, type AutomationRunResponse as j, type AutomationRunStatus as k, type AutomationRunStep as l, type AutomationRunStepStatus as m, type AutomationStatus as n, type AutomationStep as o, type AutomationTrigger as p, type ConnectTwilioParams as q, type ContactWebhookEventPayload as r, type CreateApiKeyParams as s, type CreateApiKeyResult as t, type CreateAutomationParams as u, type CreateDomainParams as v, type CreateDomainResult as w, type CreateSuppressionParams as x, type CreateTemplateParams as y, type CreateWebhookParams as z };