@agentisend/sdk-node 0.5.0 → 0.5.2

package/dist/types.d.ts

@@ -16,7 +16,11 @@ export interface Attachment {
     content_id?: string;
 }
 export interface SendEmailPayload {
-    from: string;
+    /**
+     * Required unless `template_id` or `template` names a published template
+     * with a default sender. A `from` here overrides the template's.
+     */
+    from?: string;
     to: AddressList;
     /** Required unless `template_id` or `template` names a published template with a subject. */
     subject?: string;
@@ -44,10 +48,10 @@ export interface SendEmailPayload {
     topic_id?: string;
     /** Resend Node SDK name for `topic_id`. */
     topicId?: string;
-    /** Published template to render, instead of html or text. */
+    /** Id or alias of a published template to render, instead of html or text. */
     template_id?: string;
     template_values?: Record<string, unknown>;
-    /** Resend's send shape: `{id, variables}` instead of sibling `template_id`/`template_values`. */
+    /** Resend's send shape: `{id, variables}`; `id` is the template's id or its alias. */
     template?: {
         id: string;
         variables?: Record<string, string | number>;
@@ -55,6 +59,34 @@ export interface SendEmailPayload {
     /** When a held send stops waiting for a person. At most 7 days ahead. */
     expires_at?: string;
 }
+/** A template variable as Resend writes it: a key, a type, and an optional fallback. */
+export interface TemplateVariableInput {
+    key: string;
+    type: 'string' | 'number' | 'boolean';
+    /** With no fallback the variable is required when sending. */
+    fallback_value?: string | number | boolean;
+}
+/**
+ * POST /templates. Send `html` the way Resend does, or `content` for markdown
+ * and blocks. `variables` take Resend's `{key, type, fallback_value}` or the
+ * native `{name, type, required, default}`.
+ */
+export interface TemplateCreatePayload {
+    name: string;
+    /** Unique on the account. Use it wherever a template id is taken. */
+    alias?: string;
+    /** Default sender, such as `Acme <hello@acme.com>`. A send's own `from` overrides it. */
+    from?: string;
+    subject?: string;
+    /** Default Reply-To. A send's own `reply_to` overrides it. */
+    reply_to?: string | string[];
+    html?: string;
+    /** Native body: `{mode: 'markdown' | 'html', source}` or `{mode: 'block', blocks}`. */
+    content?: unknown;
+    /** Plain-text part. Left out, one is made from the HTML; `''` sends no text part. */
+    text?: string;
+    variables?: Array<TemplateVariableInput | Record<string, unknown>>;
+}
 export type MessageStatus = 'queued' | 'scheduled' | 'sent' | 'delivered' | 'delivery_delayed' | 'bounced' | 'complained' | 'opened' | 'clicked' | 'failed' | 'canceled' | 'suppressed';
 export interface AttachmentView {
     filename: string;
@@ -64,6 +96,7 @@ export interface AttachmentView {
     path: string | null;
 }
 export interface Email {
+    object?: 'email';
     id: string;
     from: string;
     to: string[];
@@ -71,6 +104,8 @@ export interface Email {
     bcc: string[] | null;
     reply_to: string[] | null;
     subject: string;
+    /** The Message-ID header the message carries, angle brackets included. */
+    message_id?: string | null;
     html: string | null;
     text: string | null;
     headers: Record<string, string> | null;
@@ -109,14 +144,59 @@ export interface ListQuery {
     /** Resend's previous-page cursor. Mutually exclusive with cursor/after. */
     before?: string;
 }
-/** GET /metrics and GET /emails/metrics (W4.10). */
+/**
+ * GET /metrics and GET /emails/metrics (W4.10).
+ *
+ * `since` and `until` (and `group_by`, `event`, `domain`, `api_key_id` on the
+ * route) select this API's own shape. `start_date`, `end_date` and the rest
+ * select Resend's: totals, or rows broken down by `dimensions`.
+ */
 export interface MetricsQuery {
     since?: string;
     until?: string;
-    /** Resend's name for `since`. A YYYY-MM-DD date is 00:00 UTC. */
+    /** The start of the range: an ISO 8601 date or datetime. Defaults to 6 days before `end_date`. */
     start_date?: string;
-    /** Resend's name for `until`. A YYYY-MM-DD date is 23:59:59.999 UTC. */
+    /** The end of the range. A date covers that whole day. A future value is clamped to now. */
     end_date?: string;
+    /** IANA timezone that buckets periods when `period` is a dimension. Default UTC. */
+    timezone?: string;
+    /** Bucket size when `period` is a dimension. Default daily. At most 10,000 periods. */
+    granularity?: 'hourly' | 'daily' | 'weekly' | 'monthly';
+    /** Metrics to return (a list, or a comma-separated string). Omit for all. */
+    metrics?: string | string[];
+    /** Any of period, domain, email, broadcast. `email` cannot be combined with `broadcast`. */
+    dimensions?: string | string[];
+    /** Up to 100 sending domain ids. */
+    domain_id?: string | string[];
+    /** Up to 100 email ids. Not with the broadcast dimension or `broadcast_id`. */
+    email_id?: string | string[];
+    /** Up to 100 broadcast ids. Not with the email dimension or `email_id`. */
+    broadcast_id?: string | string[];
+}
+/** GET /broadcasts/{id}/recipients (Resend: list-broadcast-recipients). */
+export interface BroadcastRecipientsQuery {
+    type: 'sent' | 'delivered' | 'opened' | 'clicked' | 'bounced' | 'complained' | 'unsubscribed' | 'suppressed';
+    /** Keep recipients whose email contains this value. */
+    email?: string;
+    /** Only with `type: 'bounced'`. */
+    bounce_type?: 'permanent' | 'transient' | 'undetermined';
+    /** 1 to 100. Default 20. */
+    limit?: number;
+    after?: string;
+    before?: string;
+}
+/** GET /broadcasts/{id}/clicked-links (Resend: list-broadcast-clicked-links). */
+export interface BroadcastClickedLinksQuery {
+    /** 1 to 100. Default 20. */
+    limit?: number;
+    after?: string;
+    before?: string;
+}
+/** Resend's list envelope for the broadcast engagement routes. */
+export interface EngagementList<T> {
+    object: 'list';
+    has_more: boolean;
+    data: T[];
 }
 /** One component on the public status page, and what it reports about itself. */
 export interface ServiceComponent {
@@ -131,13 +211,18 @@ export interface ServiceStatus {
 }
 /** One API call this account made, as the request log recorded it (M5.9). */
 export interface RequestLogEntry {
+    object?: 'log';
     id: string;
     request_id: string;
     method: string;
     path: string;
+    /** Resend's name for `path`. */
+    endpoint?: string;
     /** The route template — what you group by when one id is not the question. */
     route: string | null;
     status: number;
+    /** Resend's name for `status`. */
+    response_status?: number;
     duration_ms: number;
     /** The catalogue code on a refusal; null when nothing refused. */
     error_code: string | null;
@@ -147,25 +232,43 @@ export interface RequestLogEntry {
     user_agent: string | null;
     created_at: string;
 }
-/** One attachment on a message you sent (M5.10). Ids are stable positions. */
+/**
+ * One attachment on a message you sent (M5.10). The id is a stable uuid; the
+ * position ("0", "1", …) this API returned before is still accepted.
+ */
 export interface SentAttachment {
     id: string;
     filename: string;
     content_type: string | null;
     size_bytes: number | null;
+    /** Resend's name for `size_bytes`. */
+    size?: number | null;
     content_id: string | null;
+    content_disposition?: 'inline' | 'attachment';
+    /** Downloads the bytes with no API key until `expires_at`. Null once the bytes are gone. */
+    download_url?: string | null;
+    expires_at?: string | null;
     /** Set when you sent a URL instead of bytes — nothing was stored here. */
     path: string | null;
     /** False for a URL attachment, and once retention has taken the message. */
     bytes_available: boolean;
 }
-/** One attachment on a received message (M5.8). Ids are stable positions. */
+/**
+ * One attachment on a received message (M5.8). The id is a stable uuid; the
+ * position ("0", "1", …) this API returned before is still accepted.
+ */
 export interface ReceivedAttachment {
     id: string;
     filename: string;
     content_type: string;
     size_bytes: number;
+    /** Resend's name for `size_bytes`. */
+    size?: number;
     content_id: string | null;
+    content_disposition?: 'inline' | 'attachment';
+    /** On the attachments endpoints: downloads the bytes with no API key until `expires_at`. */
+    download_url?: string;
+    expires_at?: string;
 }
 /** Received mail grouped by Message-ID / In-Reply-To / References (W4.9a). */
 export interface ReceivedThread {
@@ -175,21 +278,50 @@ export interface ReceivedThread {
     message_count: number;
     last_received_at: string;
     latest_id: string;
+    /** The label on the newest message in the thread. */
+    verdict?: 'clear' | 'review' | 'unavailable';
 }
 /** A message someone sent to one of your domains. */
 export interface ReceivedEmail {
+    object?: 'email';
     id: string;
     from: string;
+    /** The address on your domain this copy was delivered to. */
     to: string;
     subject: string | null;
     received_at: string;
+    /** Resend's name for `received_at`. */
+    created_at?: string;
+    /** The message's own Message-ID header, or null. */
+    message_id?: string | null;
+    cc?: string[];
+    /** Always empty: a received message carries no Bcc list. */
+    bcc?: string[];
+    reply_to?: string[];
     size_bytes: number;
     attachment_count: number;
+    attachments?: ReceivedAttachment[];
+    /** Present on the single read: the envelope recipient this copy was delivered for. */
+    received_for?: string[];
     /** Present on the single read. Data as it arrived — this SDK renders nothing. */
     headers?: Record<string, string>;
     text?: string | null;
     html?: string | null;
-    attachments?: ReceivedAttachment[];
+    /** The reply with quoted history removed. Null when it could not be produced. Present on the single read. */
+    extracted_text?: string | null;
+    /** The same cut, in HTML. Present on the single read. */
+    extracted_html?: string | null;
+    /** clear, review, or unavailable. */
+    verdict?: 'clear' | 'review' | 'unavailable';
+    /** Why the message was labeled. Empty when it is clear. */
+    reasons?: string[];
+    /** True while a person has not released a message the domain is holding. */
+    held?: boolean;
+    /** Present on the single read and on the arrival webhook. */
+    inbound_verdict?: {
+        verdict: 'clear' | 'review' | 'unavailable';
+        reasons: string[];
+    };
 }
 /** The types a declared event field can take (M5.7). */
 export type EventFieldType = 'string' | 'number' | 'boolean' | 'date' | 'enum';
@@ -207,31 +339,62 @@ export interface EventDefinition {
     updated_at: string;
 }
 /** One step of one automation run, and what it did (M5.6). */
+/** A graph step (Resend's shape): `config` depends on `type`. */
+export interface AutomationGraphStep {
+    key: string;
+    type: 'trigger' | 'delay' | 'send_email' | 'wait_for_event' | 'condition' | 'contact_update' | 'contact_delete' | 'add_to_segment';
+    config: Record<string, unknown>;
+}
+/** A link between two graph steps, by key. `type` defaults to `default`. */
+export interface AutomationConnection {
+    from: string;
+    to: string;
+    type?: 'default' | 'condition_met' | 'condition_not_met' | 'timeout' | 'event_received';
+}
 export interface AutomationRunStep {
     index: number;
     kind: string;
+    /** A graph step's key; null on a linear run. */
+    key: string | null;
+    type: string;
     /**
-     * `skipped` is a real outcome: a step that did nothing on purpose.
-     * `waiting`: sending is paused for every account; the step runs again after
-     * `output.retry_at`, and the run stays `running` until it does.
+     * Linear: succeeded, skipped, failed, or waiting (sending is paused for
+     * every account; the step runs again after `output.retry_at`). Graph:
+     * completed, skipped, failed, or waiting (a delay or a wait for an event).
      */
-    status: 'succeeded' | 'skipped' | 'failed' | 'waiting';
+    status: 'succeeded' | 'completed' | 'skipped' | 'failed' | 'waiting' | 'pending' | 'running';
     output: Record<string, unknown> | null;
-    error: string | null;
+    /** A linear run's sentence, or a graph run's `{ message }`. */
+    error: string | {
+        message: string;
+    } | null;
     started_at: string;
     finished_at: string | null;
+    completed_at: string | null;
+    created_at: string;
 }
 /** One execution of one automation. `steps` is present on the single read. */
 export interface AutomationRun {
+    object: 'automation_run';
     id: string;
     automation_id: string;
     version_number: number | null;
     trigger_type: string;
     event_name: string | null;
     contact_id: string | null;
-    status: 'running' | 'succeeded' | 'failed';
+    /** Linear: running, succeeded or failed. Graph: running, completed, failed or cancelled. */
+    status: 'running' | 'succeeded' | 'completed' | 'failed' | 'cancelled';
     started_at: string;
     finished_at: string | null;
+    completed_at: string | null;
+    created_at: string;
+    /** Graph runs: the step the run is on. */
+    current_step: string | null;
+    /** Graph runs: the event a wait holds for, and when a delay or timeout ends. */
+    waiting_for: {
+        event: string | null;
+        until: string | null;
+    } | null;
     steps?: AutomationRunStep[];
 }
 /** One item's outcome in a suppression batch (M5.5). */
@@ -249,6 +412,7 @@ export interface SuppressionBatchItem {
 }
 /** M5.4 — a subscription topic: the kind of mail a contact consented to. */
 export interface Topic {
+    object?: 'topic';
     id: string;
     name: string;
     description: string | null;
@@ -305,10 +469,15 @@ export interface CreatedApiKey {
 }
 export type EventType = string;
 export interface WebhookEndpoint {
+    object?: 'webhook';
     id: string;
     url: string;
+    /** Resend's name for `url`. */
+    endpoint?: string;
     events: EventType[];
     disabled: boolean;
+    /** Resend's name for `disabled`. */
+    status?: 'enabled' | 'disabled';
     /** True when deliveries also carry svix-id / -timestamp / -signature (M5.11). */
     svix_compat: boolean;
     created_at: string;
@@ -459,7 +628,35 @@ export interface DomainRecord {
     /** What to do about this record, the alternative accepted forms included. */
     fix: string;
 }
+/** What a domain does. Sending defaults to enabled, receiving to disabled. */
+export interface DomainCapabilities {
+    sending?: 'enabled' | 'disabled';
+    receiving?: 'enabled' | 'disabled';
+}
+/** `POST /domains/claim`, `GET /domains/:id/claim` and `POST /domains/:id/claim/verify`. */
+export interface DomainClaim {
+    object: 'domain_claim';
+    id: string;
+    name: string;
+    status: 'pending' | 'verified' | 'completed' | 'blocked' | 'expired' | 'superseded' | 'canceled' | 'failed';
+    /** The placeholder domain the claim created on your account. */
+    domain_id: string | null;
+    region: DomainRegion | null;
+    /** The TXT record to publish at your DNS to prove you control the domain. */
+    record: {
+        type: 'TXT';
+        name: string;
+        value: string;
+        ttl: string;
+    };
+    blocked_reason: 'grace_period' | 'recent_owner_activity' | 'pending_scheduled_emails' | null;
+    failure_reason: string | null;
+    created_at: string;
+    expires_at: string;
+}
 export interface Domain {
+    /** `domain` on a retrieved domain; absent on list items. */
+    object?: 'domain';
     id: string;
     name: string;
     zone?: string;
@@ -471,6 +668,13 @@ export interface Domain {
     open_tracking: boolean;
     tracking_subdomain: string;
     return_path_subdomain?: string;
+    /** Whether the domain sends and whether it receives. */
+    capabilities?: {
+        sending: 'enabled' | 'disabled';
+        receiving: 'enabled' | 'disabled';
+    };
+    /** monitor labels received mail. hold keeps a review message until a person releases it. */
+    inbound_hold_mode?: 'monitor' | 'hold';
     /**
      * DNS sheet. Present on create, get, verify, and update. `list()` omits it
      * (research/01-resend-api-baseline.md:182); call `get(id)` for the records.
@@ -520,6 +724,8 @@ export interface DomainSetup {
     deep_link: string | null;
 }
 export interface Deleted {
+    /** The type of what was deleted, e.g. `domain`, `webhook`, `topic`. */
+    object?: string;
     id: string;
     deleted: boolean;
 }

package/dist/version.d.ts

@@ -5,4 +5,4 @@
  * JSON import and no bundler has to resolve one. It cannot drift silently:
  * `sdk_node_is_publishable_standalone` compares it to the manifest.
  */
-export declare const SDK_VERSION = "0.5.0";
+export declare const SDK_VERSION = "0.5.2";

package/dist/version.js

@@ -5,5 +5,5 @@
  * JSON import and no bundler has to resolve one. It cannot drift silently:
  * `sdk_node_is_publishable_standalone` compares it to the manifest.
  */
-export const SDK_VERSION = '0.5.0';
+export const SDK_VERSION = '0.5.2';
 //# sourceMappingURL=version.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@agentisend/sdk-node",
-  "version": "0.5.0",
+  "version": "0.5.2",
   "description": "AgentiSend is a transactional email API for AI agents. This is its typed Node client.",
   "author": "AgentiSend <hello@agentisend.com>",
   "type": "module",
@@ -57,7 +57,6 @@
     "README.md"
   ],
   "devDependencies": {
-    "resend": "6.30.0",
     "typescript": "^5.6.0",
     "vitest": "^3.0.0"
   },