@hogsend/client 0.6.0

package/dist/index.d.cts

@@ -0,0 +1,335 @@
+import { TemplateRegistryMap } from '@hogsend/email';
+
+/**
+ * A non-2xx response — or a transport-level failure — from the Hogsend data
+ * plane. `status` is the HTTP status code, or `0` when the request never
+ * reached the server (DNS/connect/timeout). `body` is the parsed JSON body when
+ * available, else the raw text, else `undefined`.
+ */
+declare class HogsendAPIError extends Error {
+    readonly status: number;
+    readonly body: unknown;
+    constructor(message: string, status: number, body: unknown);
+}
+/**
+ * A `429 Too Many Requests` response. `retryAfter` is the parsed `Retry-After`
+ * header in seconds when present (the server sends it on 429 for `/v1/emails`).
+ */
+declare class RateLimitError extends HogsendAPIError {
+    readonly retryAfter?: number;
+    constructor(message: string, body: unknown, retryAfter?: number);
+}
+
+/** Query params accepted by `get` — undefined values are dropped. */
+type Query = Record<string, string | number | undefined>;
+/** Per-request extras (currently just an idempotency header passthrough). */
+interface RequestExtras {
+    /** Sent as the `Idempotency-Key` header when set. */
+    idempotencyKey?: string;
+}
+/** A minimal, self-contained data-plane HTTP client over native fetch. */
+interface HttpClient {
+    get<T = unknown>(path: string, query?: Query): Promise<T>;
+    post<T = unknown>(path: string, body: unknown, extras?: RequestExtras): Promise<T>;
+    put<T = unknown>(path: string, body: unknown, extras?: RequestExtras): Promise<T>;
+    del<T = unknown>(path: string, body?: unknown): Promise<T>;
+}
+
+/**
+ * At least one resolvable identity key. Either `email` or `userId` (external id)
+ * must be present; both may be supplied. Enforced at the type level by the union
+ * and at runtime by `assertIdentity`.
+ */
+type Identity = {
+    email: string;
+    userId?: string;
+} | {
+    email?: string;
+    userId: string;
+};
+interface HogsendOptions {
+    /** Base URL of the Hogsend API, e.g. `https://api.example.com`. */
+    baseUrl: string;
+    /** A data-plane API key (`hsk_…`) with the `ingest` scope. */
+    apiKey: string;
+    /** Override the global `fetch` (tests, custom agents). Defaults to `fetch`. */
+    fetch?: typeof fetch;
+    /** Per-request timeout in milliseconds. Default `30_000`. */
+    timeoutMs?: number;
+    /** Extra headers merged onto every request (e.g. a tracing header). */
+    headers?: Record<string, string>;
+}
+/** The serialized contact shape returned by `/v1/contacts/find` (§2.5). */
+interface Contact {
+    id: string;
+    externalId: string | null;
+    email: string | null;
+    properties: Record<string, unknown>;
+    firstSeenAt: string;
+    lastSeenAt: string;
+    createdAt: string;
+    updatedAt: string;
+}
+/** Result of a single exit-condition evaluation, returned by `/v1/events`. */
+interface ExitResult {
+    journeyId: string;
+    stateId: string;
+    exited: boolean;
+}
+/** Result body of `POST /v1/events`. */
+interface IngestResult {
+    stored: boolean;
+    exits: ExitResult[];
+    /**
+     * Present only when the event was ingested but the (non-atomic, post-ingest)
+     * list-membership write failed. The event itself is durably stored.
+     */
+    listsError?: string;
+}
+/** Result of `contacts.upsert`. */
+interface UpsertContactResult {
+    id: string;
+    created: boolean;
+    linked: boolean;
+}
+/** Result of `contacts.delete`. */
+interface DeleteContactResult {
+    deleted: boolean;
+}
+/** A list as returned by `GET /v1/lists`. */
+interface ListSummary {
+    id: string;
+    name: string;
+    description?: string;
+    defaultOptIn: boolean;
+}
+/** Result of `emails.send`. */
+interface SendEmailResult {
+    emailSendId: string;
+    status: string;
+    reason?: string;
+}
+/** Lifecycle status of a campaign (broadcast). */
+type CampaignStatus = "queued" | "sending" | "sent" | "failed";
+/** Whether a campaign targets a list or a bucket. */
+type CampaignAudienceKind = "list" | "bucket";
+/** Result of `campaigns.send` (the 202 enqueue ack from `POST /v1/campaigns`). */
+interface SendCampaignResult {
+    campaignId: string;
+    status: CampaignStatus;
+}
+/** A campaign as returned by `GET /v1/campaigns/{id}`. */
+interface Campaign {
+    id: string;
+    name: string;
+    status: CampaignStatus;
+    audienceKind: CampaignAudienceKind;
+    audienceId: string;
+    templateKey: string;
+    totalRecipients: number;
+    sentCount: number;
+    skippedCount: number;
+    failedCount: number;
+    startedAt: string | null;
+    completedAt: string | null;
+    createdAt: string;
+}
+type UpsertContactInput = Identity & {
+    properties?: Record<string, unknown>;
+    lists?: Record<string, boolean>;
+};
+type FindContactsInput = {
+    email: string;
+} | {
+    userId: string;
+};
+type DeleteContactInput = Identity;
+type SendEventInput = Identity & {
+    name: string;
+    eventProperties?: Record<string, unknown>;
+    contactProperties?: Record<string, unknown>;
+    lists?: Record<string, boolean>;
+    idempotencyKey?: string;
+};
+type SubscribeInput = Identity & {
+    list: string;
+};
+/** Result of `lists.subscribe` / `lists.unsubscribe`. */
+interface SubscribeResult {
+    subscribed: boolean;
+}
+interface UnsubscribeResult {
+    unsubscribed: boolean;
+}
+/**
+ * `true` when `TemplateRegistryMap` carries no augmented keys (consumer has not
+ * declared their templates). `[keyof TemplateRegistryMap] extends [never]` is
+ * the distribution-safe "is `never`" check.
+ */
+type IsEmptyRegistry = [keyof TemplateRegistryMap] extends [never] ? true : false;
+/** Recipient + envelope fields shared by every `emails.send` call. */
+type SendEmailEnvelope = {
+    to?: string;
+    userId?: string;
+    from?: string;
+    subject?: string;
+    replyTo?: string;
+    category?: string;
+    skipPreferenceCheck?: boolean;
+    idempotencyKey?: string;
+};
+/** One `{ template, props }` variant for a single known template key. */
+type TypedTemplateVariant = {
+    [K in keyof TemplateRegistryMap]: SendEmailEnvelope & {
+        template: K;
+        props: TemplateRegistryMap[K];
+    };
+}[keyof TemplateRegistryMap];
+/** Fallback shape when `@hogsend/email` is absent/un-augmented. */
+type UntypedTemplateVariant = SendEmailEnvelope & {
+    template: string;
+    props?: Record<string, unknown>;
+};
+/**
+ * Input to `emails.send`. When the consumer augments `TemplateRegistryMap`,
+ * `template`/`props` are fully type-checked per known key; otherwise it degrades
+ * to a permissive `{ template: string; props? }`.
+ */
+type SendEmailInput = IsEmptyRegistry extends true ? UntypedTemplateVariant : TypedTemplateVariant;
+/**
+ * Audience selector: exactly one of `list` or `bucket` (a list id or a bucket
+ * id). Modelled as a union so passing both is a type error, mirroring the
+ * server's "exactly one of list|bucket required" validation.
+ */
+type CampaignAudience = {
+    list: string;
+    bucket?: never;
+} | {
+    bucket: string;
+    list?: never;
+};
+/** Envelope fields shared by every `campaigns.send` call. */
+type CampaignEnvelope = {
+    /** Human label for the campaign. Server defaults it when omitted. */
+    name?: string;
+    /** Override the default From address for this broadcast. */
+    from?: string;
+    /** Override the rendered subject for this broadcast. */
+    subject?: string;
+};
+/** One `{ template, props }` variant for a single known template key. */
+type TypedCampaignTemplate = {
+    [K in keyof TemplateRegistryMap]: CampaignEnvelope & CampaignAudience & {
+        template: K;
+        props: TemplateRegistryMap[K];
+    };
+}[keyof TemplateRegistryMap];
+/** Fallback shape when `@hogsend/email` is absent/un-augmented. */
+type UntypedCampaignTemplate = CampaignEnvelope & CampaignAudience & {
+    template: string;
+    props?: Record<string, unknown>;
+};
+/**
+ * Input to `campaigns.send`. Requires exactly one of `list` | `bucket` plus a
+ * `template`. When the consumer augments `TemplateRegistryMap`,
+ * `template`/`props` are fully type-checked per known key; otherwise it degrades
+ * to a permissive `{ template: string; props? }`.
+ */
+type SendCampaignInput = IsEmptyRegistry extends true ? UntypedCampaignTemplate : TypedCampaignTemplate;
+
+/** The `campaigns.*` resource bound to an {@link HttpClient}. */
+declare class CampaignsResource {
+    private readonly http;
+    constructor(http: HttpClient);
+    /**
+     * Queue a broadcast: durably send one template to every subscribed member of
+     * a `list` (or every active member of a `bucket`). Exactly one of `list` /
+     * `bucket` must be set; `template`/`props` are type-checked against the
+     * augmented `TemplateRegistryMap` when `@hogsend/email` is installed, else
+     * degrade to `{ template: string; props? }`.
+     *
+     * Returns the 202 enqueue ack (`{ campaignId, status }`); the actual sends run
+     * asynchronously in the worker. Poll {@link CampaignsResource.get} for counts.
+     */
+    send(input: SendCampaignInput): Promise<SendCampaignResult>;
+    /** Fetch a campaign's current status + send counts. */
+    get(id: string): Promise<Campaign>;
+}
+
+/** The `contacts.*` resource bound to an {@link HttpClient}. */
+declare class ContactsResource {
+    private readonly http;
+    constructor(http: HttpClient);
+    /**
+     * Upsert a contact by identity. Resolves/merges server-side and optionally
+     * applies list membership. Returns `{ id, created, linked }`.
+     */
+    upsert(input: UpsertContactInput): Promise<UpsertContactResult>;
+    /** Find non-deleted contacts by `email` or `userId`. */
+    find(input: FindContactsInput): Promise<Contact[]>;
+    /** Soft-delete a contact by identity. */
+    delete(input: DeleteContactInput): Promise<DeleteContactResult>;
+}
+
+/** The `emails.*` resource bound to an {@link HttpClient}. */
+declare class EmailsResource {
+    private readonly http;
+    constructor(http: HttpClient);
+    /**
+     * Send a transactional email by template. Recipient is `to` (raw address) or
+     * `userId` (resolved server-side). `template`/`props` are type-checked against
+     * the augmented `TemplateRegistryMap` when `@hogsend/email` is installed,
+     * else degrade to `{ template: string; props? }`.
+     */
+    send(input: SendEmailInput): Promise<SendEmailResult>;
+}
+
+/** The `events.*` resource bound to an {@link HttpClient}. */
+declare class EventsResource {
+    private readonly http;
+    constructor(http: HttpClient);
+    /**
+     * Send an event through the ingestion pipeline. The two property bags are
+     * kept distinct: `eventProperties` feed `trigger.where`/`exitOn`,
+     * `contactProperties` merge onto the contact. Optionally apply list
+     * membership. Returns the ingest result (stored + exit evaluations).
+     *
+     * `idempotencyKey` is sent both as the `Idempotency-Key` header (which wins
+     * server-side) and in the body, matching `POST /v1/events`.
+     */
+    send(input: SendEventInput): Promise<IngestResult>;
+    /** Alias of {@link EventsResource.send}. */
+    track(input: SendEventInput): Promise<IngestResult>;
+}
+
+/** The `lists.*` resource bound to an {@link HttpClient}. */
+declare class ListsResource {
+    private readonly http;
+    constructor(http: HttpClient);
+    /** List all code-defined lists. */
+    list(): Promise<ListSummary[]>;
+    /** Subscribe an identity to a list. */
+    subscribe(input: SubscribeInput): Promise<SubscribeResult>;
+    /** Unsubscribe an identity from a list. */
+    unsubscribe(input: SubscribeInput): Promise<UnsubscribeResult>;
+}
+
+/**
+ * Typed HTTP client for the Hogsend data plane.
+ *
+ * ```ts
+ * const hs = new Hogsend({ baseUrl: "https://api.example.com", apiKey: "hsk_…" });
+ * await hs.contacts.upsert({ email: "a@b.com", properties: { plan: "pro" } });
+ * await hs.events.send({ userId: "u_1", name: "signup" });
+ * ```
+ */
+declare class Hogsend {
+    readonly contacts: ContactsResource;
+    readonly events: EventsResource;
+    readonly emails: EmailsResource;
+    readonly lists: ListsResource;
+    readonly campaigns: CampaignsResource;
+    constructor(opts: HogsendOptions);
+}
+
+export { type Campaign, type CampaignAudienceKind, type CampaignStatus, type Contact, type DeleteContactInput, type DeleteContactResult, type ExitResult, type FindContactsInput, Hogsend, HogsendAPIError, type HogsendOptions, type Identity, type IngestResult, type ListSummary, RateLimitError, type SendCampaignInput, type SendCampaignResult, type SendEmailInput, type SendEmailResult, type SendEventInput, type SubscribeInput, type SubscribeResult, type UnsubscribeResult, type UpsertContactInput, type UpsertContactResult };

package/dist/index.d.ts

@@ -0,0 +1,335 @@
+import { TemplateRegistryMap } from '@hogsend/email';
+
+/**
+ * A non-2xx response — or a transport-level failure — from the Hogsend data
+ * plane. `status` is the HTTP status code, or `0` when the request never
+ * reached the server (DNS/connect/timeout). `body` is the parsed JSON body when
+ * available, else the raw text, else `undefined`.
+ */
+declare class HogsendAPIError extends Error {
+    readonly status: number;
+    readonly body: unknown;
+    constructor(message: string, status: number, body: unknown);
+}
+/**
+ * A `429 Too Many Requests` response. `retryAfter` is the parsed `Retry-After`
+ * header in seconds when present (the server sends it on 429 for `/v1/emails`).
+ */
+declare class RateLimitError extends HogsendAPIError {
+    readonly retryAfter?: number;
+    constructor(message: string, body: unknown, retryAfter?: number);
+}
+
+/** Query params accepted by `get` — undefined values are dropped. */
+type Query = Record<string, string | number | undefined>;
+/** Per-request extras (currently just an idempotency header passthrough). */
+interface RequestExtras {
+    /** Sent as the `Idempotency-Key` header when set. */
+    idempotencyKey?: string;
+}
+/** A minimal, self-contained data-plane HTTP client over native fetch. */
+interface HttpClient {
+    get<T = unknown>(path: string, query?: Query): Promise<T>;
+    post<T = unknown>(path: string, body: unknown, extras?: RequestExtras): Promise<T>;
+    put<T = unknown>(path: string, body: unknown, extras?: RequestExtras): Promise<T>;
+    del<T = unknown>(path: string, body?: unknown): Promise<T>;
+}
+
+/**
+ * At least one resolvable identity key. Either `email` or `userId` (external id)
+ * must be present; both may be supplied. Enforced at the type level by the union
+ * and at runtime by `assertIdentity`.
+ */
+type Identity = {
+    email: string;
+    userId?: string;
+} | {
+    email?: string;
+    userId: string;
+};
+interface HogsendOptions {
+    /** Base URL of the Hogsend API, e.g. `https://api.example.com`. */
+    baseUrl: string;
+    /** A data-plane API key (`hsk_…`) with the `ingest` scope. */
+    apiKey: string;
+    /** Override the global `fetch` (tests, custom agents). Defaults to `fetch`. */
+    fetch?: typeof fetch;
+    /** Per-request timeout in milliseconds. Default `30_000`. */
+    timeoutMs?: number;
+    /** Extra headers merged onto every request (e.g. a tracing header). */
+    headers?: Record<string, string>;
+}
+/** The serialized contact shape returned by `/v1/contacts/find` (§2.5). */
+interface Contact {
+    id: string;
+    externalId: string | null;
+    email: string | null;
+    properties: Record<string, unknown>;
+    firstSeenAt: string;
+    lastSeenAt: string;
+    createdAt: string;
+    updatedAt: string;
+}
+/** Result of a single exit-condition evaluation, returned by `/v1/events`. */
+interface ExitResult {
+    journeyId: string;
+    stateId: string;
+    exited: boolean;
+}
+/** Result body of `POST /v1/events`. */
+interface IngestResult {
+    stored: boolean;
+    exits: ExitResult[];
+    /**
+     * Present only when the event was ingested but the (non-atomic, post-ingest)
+     * list-membership write failed. The event itself is durably stored.
+     */
+    listsError?: string;
+}
+/** Result of `contacts.upsert`. */
+interface UpsertContactResult {
+    id: string;
+    created: boolean;
+    linked: boolean;
+}
+/** Result of `contacts.delete`. */
+interface DeleteContactResult {
+    deleted: boolean;
+}
+/** A list as returned by `GET /v1/lists`. */
+interface ListSummary {
+    id: string;
+    name: string;
+    description?: string;
+    defaultOptIn: boolean;
+}
+/** Result of `emails.send`. */
+interface SendEmailResult {
+    emailSendId: string;
+    status: string;
+    reason?: string;
+}
+/** Lifecycle status of a campaign (broadcast). */
+type CampaignStatus = "queued" | "sending" | "sent" | "failed";
+/** Whether a campaign targets a list or a bucket. */
+type CampaignAudienceKind = "list" | "bucket";
+/** Result of `campaigns.send` (the 202 enqueue ack from `POST /v1/campaigns`). */
+interface SendCampaignResult {
+    campaignId: string;
+    status: CampaignStatus;
+}
+/** A campaign as returned by `GET /v1/campaigns/{id}`. */
+interface Campaign {
+    id: string;
+    name: string;
+    status: CampaignStatus;
+    audienceKind: CampaignAudienceKind;
+    audienceId: string;
+    templateKey: string;
+    totalRecipients: number;
+    sentCount: number;
+    skippedCount: number;
+    failedCount: number;
+    startedAt: string | null;
+    completedAt: string | null;
+    createdAt: string;
+}
+type UpsertContactInput = Identity & {
+    properties?: Record<string, unknown>;
+    lists?: Record<string, boolean>;
+};
+type FindContactsInput = {
+    email: string;
+} | {
+    userId: string;
+};
+type DeleteContactInput = Identity;
+type SendEventInput = Identity & {
+    name: string;
+    eventProperties?: Record<string, unknown>;
+    contactProperties?: Record<string, unknown>;
+    lists?: Record<string, boolean>;
+    idempotencyKey?: string;
+};
+type SubscribeInput = Identity & {
+    list: string;
+};
+/** Result of `lists.subscribe` / `lists.unsubscribe`. */
+interface SubscribeResult {
+    subscribed: boolean;
+}
+interface UnsubscribeResult {
+    unsubscribed: boolean;
+}
+/**
+ * `true` when `TemplateRegistryMap` carries no augmented keys (consumer has not
+ * declared their templates). `[keyof TemplateRegistryMap] extends [never]` is
+ * the distribution-safe "is `never`" check.
+ */
+type IsEmptyRegistry = [keyof TemplateRegistryMap] extends [never] ? true : false;
+/** Recipient + envelope fields shared by every `emails.send` call. */
+type SendEmailEnvelope = {
+    to?: string;
+    userId?: string;
+    from?: string;
+    subject?: string;
+    replyTo?: string;
+    category?: string;
+    skipPreferenceCheck?: boolean;
+    idempotencyKey?: string;
+};
+/** One `{ template, props }` variant for a single known template key. */
+type TypedTemplateVariant = {
+    [K in keyof TemplateRegistryMap]: SendEmailEnvelope & {
+        template: K;
+        props: TemplateRegistryMap[K];
+    };
+}[keyof TemplateRegistryMap];
+/** Fallback shape when `@hogsend/email` is absent/un-augmented. */
+type UntypedTemplateVariant = SendEmailEnvelope & {
+    template: string;
+    props?: Record<string, unknown>;
+};
+/**
+ * Input to `emails.send`. When the consumer augments `TemplateRegistryMap`,
+ * `template`/`props` are fully type-checked per known key; otherwise it degrades
+ * to a permissive `{ template: string; props? }`.
+ */
+type SendEmailInput = IsEmptyRegistry extends true ? UntypedTemplateVariant : TypedTemplateVariant;
+/**
+ * Audience selector: exactly one of `list` or `bucket` (a list id or a bucket
+ * id). Modelled as a union so passing both is a type error, mirroring the
+ * server's "exactly one of list|bucket required" validation.
+ */
+type CampaignAudience = {
+    list: string;
+    bucket?: never;
+} | {
+    bucket: string;
+    list?: never;
+};
+/** Envelope fields shared by every `campaigns.send` call. */
+type CampaignEnvelope = {
+    /** Human label for the campaign. Server defaults it when omitted. */
+    name?: string;
+    /** Override the default From address for this broadcast. */
+    from?: string;
+    /** Override the rendered subject for this broadcast. */
+    subject?: string;
+};
+/** One `{ template, props }` variant for a single known template key. */
+type TypedCampaignTemplate = {
+    [K in keyof TemplateRegistryMap]: CampaignEnvelope & CampaignAudience & {
+        template: K;
+        props: TemplateRegistryMap[K];
+    };
+}[keyof TemplateRegistryMap];
+/** Fallback shape when `@hogsend/email` is absent/un-augmented. */
+type UntypedCampaignTemplate = CampaignEnvelope & CampaignAudience & {
+    template: string;
+    props?: Record<string, unknown>;
+};
+/**
+ * Input to `campaigns.send`. Requires exactly one of `list` | `bucket` plus a
+ * `template`. When the consumer augments `TemplateRegistryMap`,
+ * `template`/`props` are fully type-checked per known key; otherwise it degrades
+ * to a permissive `{ template: string; props? }`.
+ */
+type SendCampaignInput = IsEmptyRegistry extends true ? UntypedCampaignTemplate : TypedCampaignTemplate;
+
+/** The `campaigns.*` resource bound to an {@link HttpClient}. */
+declare class CampaignsResource {
+    private readonly http;
+    constructor(http: HttpClient);
+    /**
+     * Queue a broadcast: durably send one template to every subscribed member of
+     * a `list` (or every active member of a `bucket`). Exactly one of `list` /
+     * `bucket` must be set; `template`/`props` are type-checked against the
+     * augmented `TemplateRegistryMap` when `@hogsend/email` is installed, else
+     * degrade to `{ template: string; props? }`.
+     *
+     * Returns the 202 enqueue ack (`{ campaignId, status }`); the actual sends run
+     * asynchronously in the worker. Poll {@link CampaignsResource.get} for counts.
+     */
+    send(input: SendCampaignInput): Promise<SendCampaignResult>;
+    /** Fetch a campaign's current status + send counts. */
+    get(id: string): Promise<Campaign>;
+}
+
+/** The `contacts.*` resource bound to an {@link HttpClient}. */
+declare class ContactsResource {
+    private readonly http;
+    constructor(http: HttpClient);
+    /**
+     * Upsert a contact by identity. Resolves/merges server-side and optionally
+     * applies list membership. Returns `{ id, created, linked }`.
+     */
+    upsert(input: UpsertContactInput): Promise<UpsertContactResult>;
+    /** Find non-deleted contacts by `email` or `userId`. */
+    find(input: FindContactsInput): Promise<Contact[]>;
+    /** Soft-delete a contact by identity. */
+    delete(input: DeleteContactInput): Promise<DeleteContactResult>;
+}
+
+/** The `emails.*` resource bound to an {@link HttpClient}. */
+declare class EmailsResource {
+    private readonly http;
+    constructor(http: HttpClient);
+    /**
+     * Send a transactional email by template. Recipient is `to` (raw address) or
+     * `userId` (resolved server-side). `template`/`props` are type-checked against
+     * the augmented `TemplateRegistryMap` when `@hogsend/email` is installed,
+     * else degrade to `{ template: string; props? }`.
+     */
+    send(input: SendEmailInput): Promise<SendEmailResult>;
+}
+
+/** The `events.*` resource bound to an {@link HttpClient}. */
+declare class EventsResource {
+    private readonly http;
+    constructor(http: HttpClient);
+    /**
+     * Send an event through the ingestion pipeline. The two property bags are
+     * kept distinct: `eventProperties` feed `trigger.where`/`exitOn`,
+     * `contactProperties` merge onto the contact. Optionally apply list
+     * membership. Returns the ingest result (stored + exit evaluations).
+     *
+     * `idempotencyKey` is sent both as the `Idempotency-Key` header (which wins
+     * server-side) and in the body, matching `POST /v1/events`.
+     */
+    send(input: SendEventInput): Promise<IngestResult>;
+    /** Alias of {@link EventsResource.send}. */
+    track(input: SendEventInput): Promise<IngestResult>;
+}
+
+/** The `lists.*` resource bound to an {@link HttpClient}. */
+declare class ListsResource {
+    private readonly http;
+    constructor(http: HttpClient);
+    /** List all code-defined lists. */
+    list(): Promise<ListSummary[]>;
+    /** Subscribe an identity to a list. */
+    subscribe(input: SubscribeInput): Promise<SubscribeResult>;
+    /** Unsubscribe an identity from a list. */
+    unsubscribe(input: SubscribeInput): Promise<UnsubscribeResult>;
+}
+
+/**
+ * Typed HTTP client for the Hogsend data plane.
+ *
+ * ```ts
+ * const hs = new Hogsend({ baseUrl: "https://api.example.com", apiKey: "hsk_…" });
+ * await hs.contacts.upsert({ email: "a@b.com", properties: { plan: "pro" } });
+ * await hs.events.send({ userId: "u_1", name: "signup" });
+ * ```
+ */
+declare class Hogsend {
+    readonly contacts: ContactsResource;
+    readonly events: EventsResource;
+    readonly emails: EmailsResource;
+    readonly lists: ListsResource;
+    readonly campaigns: CampaignsResource;
+    constructor(opts: HogsendOptions);
+}
+
+export { type Campaign, type CampaignAudienceKind, type CampaignStatus, type Contact, type DeleteContactInput, type DeleteContactResult, type ExitResult, type FindContactsInput, Hogsend, HogsendAPIError, type HogsendOptions, type Identity, type IngestResult, type ListSummary, RateLimitError, type SendCampaignInput, type SendCampaignResult, type SendEmailInput, type SendEmailResult, type SendEventInput, type SubscribeInput, type SubscribeResult, type UnsubscribeResult, type UpsertContactInput, type UpsertContactResult };