@proveanything/smartlinks 1.1.18 → 1.1.20

package/API_SUMMARY.md

@@ -1,6 +1,6 @@
 # Smartlinks API Summary
 
-Version: 1.1.18  |  Generated: 2026-01-04T12:18:56.152Z
+Version: 1.1.20  |  Generated: 2026-01-05T11:30:32.718Z
 
 This is a concise summary of all available API functions and types.
 
@@ -389,6 +389,98 @@ interface BroadcastList {
 }
 ```
 
+**BroadcastRecipientsResponse** (interface)
+```typescript
+interface BroadcastRecipientsResponse {
+  items: import('./comms').Recipient[]
+  total: number
+  limit: number
+  offset: number
+  note?: string
+}
+```
+
+**BroadcastPreviewRequest** (interface)
+```typescript
+interface BroadcastPreviewRequest {
+  contactId?: string
+  email?: string
+  props?: Record<string, any>
+}
+```
+
+**BroadcastPreviewResponse** (interface)
+```typescript
+interface BroadcastPreviewResponse {
+  ok: boolean; html: string
+}
+```
+
+**BroadcastSendTestRequest** (interface)
+```typescript
+interface BroadcastSendTestRequest {
+  to: string
+  subject?: string
+  props?: Record<string, any>
+}
+```
+
+**BroadcastSendTestResponse** (interface)
+```typescript
+interface BroadcastSendTestResponse {
+  ok: boolean; id?: string
+}
+```
+
+**BroadcastSendManualRequest** (interface)
+```typescript
+interface BroadcastSendManualRequest {
+  limit?: number
+  offset?: number
+  dryRun?: boolean
+  sharedContext?: Record<string, any>
+}
+```
+
+**BroadcastSendManualResponse** (interface)
+```typescript
+interface BroadcastSendManualResponse {
+  ok: boolean
+  counts: { sent: number; failed: number; skipped: number }
+  page: { limit: number; offset: number; total: number }
+  results: Array<{
+  contactId: string
+  status: 'sent' | 'failed' | 'skipped' | 'dry_run'
+  id?: string
+  error?: string
+  message?: string
+  }>
+}
+```
+
+**BroadcastAppendEventBody** (interface)
+```typescript
+interface BroadcastAppendEventBody {
+  broadcastId: string
+  contactId?: string
+  channel?: 'email'
+  templateId?: string
+  eventType: string
+  outcome?: 'success' | 'failed'
+  failureReason?: string
+  metadata?: Record<string, any>
+}
+```
+
+**BroadcastAppendBulkBody** (interface)
+```typescript
+interface BroadcastAppendBulkBody {
+  ids: string[]
+  idField?: string
+  params: Record<string, any> // merged with collectionId server-side
+}
+```
+
 ### claimSet
 
 **ClaimCodeRef** (interface)
@@ -679,8 +771,21 @@ interface AppendBulkResult {
 }
 ```
 
+**RecipientsPage** (interface)
+```typescript
+interface RecipientsPage {
+  items: Recipient[]
+  total: number
+  limit: number
+  offset: number
+  note?: string
+}
+```
+
 **RecipientId** = `string`
 
+**Recipient** = `import('./contact').Contact`
+
 ### contact
 
 **Contact** (interface)
@@ -1319,7 +1424,7 @@ interface SegmentList {
 **SegmentCalculateResult** (interface)
 ```typescript
 interface SegmentCalculateResult {
-  scheduled: true
+  scheduled: boolean
   lastCalculatedAt?: string
   estimatedCount?: number | null
   note?: string
@@ -1329,7 +1434,7 @@ interface SegmentCalculateResult {
 **SegmentRecipientsResponse** (interface)
 ```typescript
 interface SegmentRecipientsResponse {
-  items: string[]
+  items: import('./comms').Recipient[]
   limit: number
   offset: number
   total: number
@@ -1364,6 +1469,37 @@ interface TemplateBase {
 }
 ```
 
+**TemplateRenderRequest** (interface)
+```typescript
+interface TemplateRenderRequest {
+  props: Record<string, any>
+}
+```
+
+**TemplateRenderResponse** (interface)
+```typescript
+interface TemplateRenderResponse {
+  ok: boolean; html: string
+}
+```
+
+**TemplateRenderSourceRequest** (interface)
+```typescript
+interface TemplateRenderSourceRequest {
+  engine: 'liquid'
+  source: string
+  props?: Record<string, any>
+  component?: string
+}
+```
+
+**TemplateRenderSourceResponse** (interface)
+```typescript
+interface TemplateRenderSourceResponse {
+  ok: boolean; html: string
+}
+```
+
 **TemplateInput** = `Omit<TemplateBase, 'id' | 'collectionId'>`
 
 **TemplateUpdate** = `Partial<Omit<TemplateBase, 'id' | 'collectionId'>>`
@@ -1793,6 +1929,28 @@ Look up a serial number by code for a batch (admin only).
 **remove**(collectionId: string,
     id: string) → `Promise<void>`
 
+**recipients**(collectionId: string,
+    id: string,
+    query: { limit?: number; offset?: number } = {}) → `Promise<BroadcastRecipientsResponse>`
+
+**preview**(collectionId: string,
+    id: string,
+    body: BroadcastPreviewRequest) → `Promise<BroadcastPreviewResponse>`
+
+**sendTest**(collectionId: string,
+    id: string,
+    body: BroadcastSendTestRequest) → `Promise<BroadcastSendTestResponse>`
+
+**sendManual**(collectionId: string,
+    id: string,
+    body: BroadcastSendManualRequest) → `Promise<BroadcastSendManualResponse>`
+
+**append**(collectionId: string,
+    body: BroadcastAppendEventBody) → `Promise<AppendResult>`
+
+**appendBulk**(collectionId: string,
+    body: BroadcastAppendBulkBody) → `Promise<AppendBulkResult>`
+
 ### claimSet
 
 **getAllForCollection**(collectionId: string) → `Promise<any[]>`
@@ -2229,6 +2387,13 @@ Resolve a short code to related resource identifiers.
 
 **getAllowedGlobal**(collectionId: string) → `Promise<TemplatePublic[]>`
 
+**render**(collectionId: string,
+    templateId: string,
+    body: TemplateRenderRequest) → `Promise<TemplateRenderResponse>`
+
+**renderSource**(collectionId: string,
+    body: TemplateRenderSourceRequest) → `Promise<TemplateRenderSourceResponse>`
+
 ### variant
 
 **get**(collectionId: string,

package/dist/api/broadcasts.d.ts

@@ -1,8 +1,18 @@
-import type { ListBroadcastsQuery, BroadcastRecord, BroadcastList } from "../types/broadcasts";
+import type { ListBroadcastsQuery, BroadcastRecord, BroadcastList, BroadcastRecipientsResponse, BroadcastPreviewRequest, BroadcastPreviewResponse, BroadcastSendTestRequest, BroadcastSendTestResponse, BroadcastSendManualRequest, BroadcastSendManualResponse, BroadcastAppendEventBody, BroadcastAppendBulkBody } from "../types/broadcasts";
+import type { AppendResult, AppendBulkResult } from "../types/comms";
 export declare namespace broadcasts {
     function create(collectionId: string, body: Omit<BroadcastRecord, 'id' | 'collectionId' | 'createdAt'>): Promise<BroadcastRecord>;
     function list(collectionId: string, query?: ListBroadcastsQuery): Promise<BroadcastList>;
     function get(collectionId: string, id: string): Promise<BroadcastRecord>;
     function update(collectionId: string, id: string, body: Partial<Omit<BroadcastRecord, 'id' | 'collectionId' | 'createdAt'>>): Promise<BroadcastRecord>;
     function remove(collectionId: string, id: string): Promise<void>;
+    function recipients(collectionId: string, id: string, query?: {
+        limit?: number;
+        offset?: number;
+    }): Promise<BroadcastRecipientsResponse>;
+    function preview(collectionId: string, id: string, body: BroadcastPreviewRequest): Promise<BroadcastPreviewResponse>;
+    function sendTest(collectionId: string, id: string, body: BroadcastSendTestRequest): Promise<BroadcastSendTestResponse>;
+    function sendManual(collectionId: string, id: string, body: BroadcastSendManualRequest): Promise<BroadcastSendManualResponse>;
+    function append(collectionId: string, body: BroadcastAppendEventBody): Promise<AppendResult>;
+    function appendBulk(collectionId: string, body: BroadcastAppendBulkBody): Promise<AppendBulkResult>;
 }

package/dist/api/broadcasts.js

@@ -47,4 +47,41 @@ export var broadcasts;
         return del(path);
     }
     broadcasts.remove = remove;
+    // Recipients listing for a broadcast
+    async function recipients(collectionId, id, query = {}) {
+        const qs = encodeQuery(query);
+        const path = `/admin/collection/${encodeURIComponent(collectionId)}/broadcasts/${encodeURIComponent(id)}/recipients${qs}`;
+        return request(path);
+    }
+    broadcasts.recipients = recipients;
+    // Preview a broadcast template/email
+    async function preview(collectionId, id, body) {
+        const path = `/admin/collection/${encodeURIComponent(collectionId)}/broadcasts/${encodeURIComponent(id)}/preview`;
+        return post(path, body);
+    }
+    broadcasts.preview = preview;
+    // Send a single test email
+    async function sendTest(collectionId, id, body) {
+        const path = `/admin/collection/${encodeURIComponent(collectionId)}/broadcasts/${encodeURIComponent(id)}/send/test`;
+        return post(path, body);
+    }
+    broadcasts.sendTest = sendTest;
+    // Manually send a page of emails
+    async function sendManual(collectionId, id, body) {
+        const path = `/admin/collection/${encodeURIComponent(collectionId)}/broadcasts/${encodeURIComponent(id)}/send/manual`;
+        return post(path, body);
+    }
+    broadcasts.sendManual = sendManual;
+    // Append a single broadcast event
+    async function append(collectionId, body) {
+        const path = `/admin/collection/${encodeURIComponent(collectionId)}/broadcasts/append`;
+        return post(path, body);
+    }
+    broadcasts.append = append;
+    // Append many broadcast events
+    async function appendBulk(collectionId, body) {
+        const path = `/admin/collection/${encodeURIComponent(collectionId)}/broadcasts/append/bulk`;
+        return post(path, body);
+    }
+    broadcasts.appendBulk = appendBulk;
 })(broadcasts || (broadcasts = {}));

package/dist/api/template.d.ts

@@ -1,4 +1,4 @@
-import type { Template, TemplateInput, TemplateUpdate, TemplatePublic } from "../types";
+import type { Template, TemplateInput, TemplateUpdate, TemplatePublic, TemplateRenderRequest, TemplateRenderResponse, TemplateRenderSourceRequest, TemplateRenderSourceResponse } from "../types";
 export declare namespace template {
     function getAll(collectionId: string): Promise<Template[]>;
     function get(collectionId: string, templateId: string): Promise<Template>;
@@ -12,4 +12,6 @@ export declare namespace template {
     function getPublic(collectionId: string, templateId: string): Promise<TemplatePublic>;
     function getGlobal(templateId: string): Promise<TemplatePublic>;
     function getAllowedGlobal(collectionId: string): Promise<TemplatePublic[]>;
+    function render(collectionId: string, templateId: string, body: TemplateRenderRequest): Promise<TemplateRenderResponse>;
+    function renderSource(collectionId: string, body: TemplateRenderSourceRequest): Promise<TemplateRenderSourceResponse>;
 }

package/dist/api/template.js

@@ -56,4 +56,16 @@ export var template;
         return request(path);
     }
     template.getAllowedGlobal = getAllowedGlobal;
+    // Render a template by ID (admin)
+    async function render(collectionId, templateId, body) {
+        const path = `/admin/collection/${encodeURIComponent(collectionId)}/template/${encodeURIComponent(templateId)}/render`;
+        return post(path, body);
+    }
+    template.render = render;
+    // Render from source (admin)
+    async function renderSource(collectionId, body) {
+        const path = `/admin/collection/${encodeURIComponent(collectionId)}/template/render/source`;
+        return post(path, body);
+    }
+    template.renderSource = renderSource;
 })(template || (template = {}));

package/dist/types/broadcasts.d.ts

@@ -29,3 +29,69 @@ export interface BroadcastList {
     limit: number;
     offset: number;
 }
+export interface BroadcastRecipientsResponse {
+    items: import('./comms').Recipient[];
+    total: number;
+    limit: number;
+    offset: number;
+    note?: string;
+}
+export interface BroadcastPreviewRequest {
+    contactId?: string;
+    email?: string;
+    props?: Record<string, any>;
+}
+export interface BroadcastPreviewResponse {
+    ok: boolean;
+    html: string;
+}
+export interface BroadcastSendTestRequest {
+    to: string;
+    subject?: string;
+    props?: Record<string, any>;
+}
+export interface BroadcastSendTestResponse {
+    ok: boolean;
+    id?: string;
+}
+export interface BroadcastSendManualRequest {
+    limit?: number;
+    offset?: number;
+    dryRun?: boolean;
+    sharedContext?: Record<string, any>;
+}
+export interface BroadcastSendManualResponse {
+    ok: boolean;
+    counts: {
+        sent: number;
+        failed: number;
+        skipped: number;
+    };
+    page: {
+        limit: number;
+        offset: number;
+        total: number;
+    };
+    results: Array<{
+        contactId: string;
+        status: 'sent' | 'failed' | 'skipped' | 'dry_run';
+        id?: string;
+        error?: string;
+        message?: string;
+    }>;
+}
+export interface BroadcastAppendEventBody {
+    broadcastId: string;
+    contactId?: string;
+    channel?: 'email';
+    templateId?: string;
+    eventType: string;
+    outcome?: 'success' | 'failed';
+    failureReason?: string;
+    metadata?: Record<string, any>;
+}
+export interface BroadcastAppendBulkBody {
+    ids: string[];
+    idField?: string;
+    params: Record<string, any>;
+}

package/dist/types/comms.d.ts

@@ -189,3 +189,11 @@ export interface AppendBulkResult {
     success: true;
     count: number;
 }
+export type Recipient = import('./contact').Contact;
+export interface RecipientsPage {
+    items: Recipient[];
+    total: number;
+    limit: number;
+    offset: number;
+    note?: string;
+}

package/dist/types/segments.d.ts

@@ -26,13 +26,13 @@ export interface SegmentList {
     offset: number;
 }
 export interface SegmentCalculateResult {
-    scheduled: true;
+    scheduled: boolean;
     lastCalculatedAt?: string;
     estimatedCount?: number | null;
     note?: string;
 }
 export interface SegmentRecipientsResponse {
-    items: string[];
+    items: import('./comms').Recipient[];
     limit: number;
     offset: number;
     total: number;

package/dist/types/template.d.ts

@@ -28,3 +28,20 @@ export interface Template extends TemplateBase {
 export type TemplateInput = Omit<TemplateBase, 'id' | 'collectionId'>;
 export type TemplateUpdate = Partial<Omit<TemplateBase, 'id' | 'collectionId'>>;
 export type TemplatePublic = TemplateBase;
+export interface TemplateRenderRequest {
+    props: Record<string, any>;
+}
+export interface TemplateRenderResponse {
+    ok: boolean;
+    html: string;
+}
+export interface TemplateRenderSourceRequest {
+    engine: 'liquid';
+    source: string;
+    props?: Record<string, any>;
+    component?: string;
+}
+export interface TemplateRenderSourceResponse {
+    ok: boolean;
+    html: string;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@proveanything/smartlinks",
-  "version": "1.1.18",
+  "version": "1.1.20",
   "description": "Official JavaScript/TypeScript SDK for the Smartlinks API",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",