@proveanything/smartlinks 1.1.0 → 1.1.1

package/API_SUMMARY.md

@@ -1,6 +1,6 @@
 # Smartlinks API Summary
 
-Version: 1.1.0  |  Generated: 2025-12-18T21:46:20.895Z
+Version: 1.1.1  |  Generated: 2025-12-18T22:33:00.019Z
 
 This is a concise summary of all available API functions and types.
 
@@ -532,127 +532,6 @@ interface AuthKitConfig {
 
 ### broadcasts
 
-**BroadcastEvent** (interface)
-```typescript
-interface BroadcastEvent {
-  orgId: string
-  broadcastId: string
-  userId?: string
-  contactId?: string
-  channel?: string
-  timestamp: string
-  [k: string]: any
-}
-```
-
-**BroadcastQueryByUser** (interface)
-```typescript
-interface BroadcastQueryByUser {
-  userId?: string
-  contactId?: string
-  from?: string
-  to?: string
-  limit?: number
-}
-```
-
-**RecipientIdsQuery** (interface)
-```typescript
-interface RecipientIdsQuery {
-  broadcastId: string
-  idField?: IdField
-  from?: string
-  to?: string
-  limit?: number
-}
-```
-
-**RecipientsWithoutActionQuery** (interface)
-```typescript
-interface RecipientsWithoutActionQuery {
-  broadcastId: string
-  actionId?: string
-  appId?: string
-  idField?: IdField
-  from?: string
-  to?: string
-  limit?: number
-}
-```
-
-**RecipientsWithActionQuery** (interface)
-```typescript
-interface RecipientsWithActionQuery {
-  broadcastId: string
-  actionId?: string
-  appId?: string
-  outcome?: string
-  idField?: IdField
-  includeOutcome?: boolean
-  from?: string
-  to?: string
-  limit?: number
-}
-```
-
-**RecipientWithOutcome** (interface)
-```typescript
-interface RecipientWithOutcome {
-  id: string; outcome: string
-}
-```
-
-**AppendBroadcastBody** (interface)
-```typescript
-interface AppendBroadcastBody {
-  broadcastId: string
-  userId?: string
-  contactId?: string
-  channel?: string
-  timestamp?: string
-  [k: string]: any
-}
-```
-
-**AppendBroadcastBulkBody** (interface)
-```typescript
-interface AppendBroadcastBulkBody {
-  params: { broadcastId: string; [k: string]: any }
-  ids: string[]
-  idField?: IdField
-}
-```
-
-**AppendResult** (interface)
-```typescript
-interface AppendResult {
-  success: true
-}
-```
-
-**AppendBulkResult** (interface)
-```typescript
-interface AppendBulkResult {
-  success: true; count: number
-}
-```
-
-**CreateBroadcastBody** (interface)
-```typescript
-interface CreateBroadcastBody {
-  appId: string
-  data?: Record<string, any>
-}
-```
-
-**UpdateBroadcastBody** (interface)
-```typescript
-interface UpdateBroadcastBody {
-  appId?: string
-  data?: Record<string, any>
-}
-```
-
 **ListBroadcastsQuery** (interface)
 ```typescript
 interface ListBroadcastsQuery {
@@ -668,11 +547,11 @@ interface BroadcastRecord {
   id: string
   collectionId: string
   appId: string
-  templateId?: string
-  segmentId?: string
-  status?: 'draft' | 'scheduled' | 'sending' | 'sent' | string
-  scheduledAt?: string
-  sentAt?: string
+  templateId?: string | null
+  segmentId?: string | null
+  status?: string | null
+  scheduledAt?: string | null
+  sentAt?: string | null
   data?: {
   display?: {
   title?: string
@@ -696,8 +575,6 @@ interface BroadcastList {
 }
 ```
 
-**RecipientId** = `string`
-
 ### claimSet
 
 **ClaimCodeRef** (interface)
@@ -865,6 +742,119 @@ interface SendNotificationResponse {
 }
 ```
 
+**CommunicationEvent** (interface)
+```typescript
+interface CommunicationEvent {
+  orgId: string
+  sourceId?: string
+  userId?: string
+  contactId?: string
+  channel?: string
+  timestamp: string
+  eventType?: string
+  outcome?: string | null
+  templateId?: string | null
+  [k: string]: any
+}
+```
+
+**CommsQueryByUser** (interface)
+```typescript
+interface CommsQueryByUser {
+  userId?: string
+  contactId?: string
+  from?: string
+  to?: string
+  limit?: number
+}
+```
+
+**RecipientWithOutcome** (interface)
+```typescript
+interface RecipientWithOutcome {
+  id: string; outcome: string
+}
+```
+
+**CommsRecipientIdsQuery** (interface)
+```typescript
+interface CommsRecipientIdsQuery {
+  sourceId: string
+  idField?: 'userId' | 'contactId'
+  from?: string
+  to?: string
+  limit?: number
+}
+```
+
+**CommsRecipientsWithoutActionQuery** (interface)
+```typescript
+interface CommsRecipientsWithoutActionQuery {
+  sourceId: string
+  actionId?: string
+  appId?: string
+  idField?: 'userId' | 'contactId'
+  from?: string
+  to?: string
+  limit?: number
+}
+```
+
+**CommsRecipientsWithActionQuery** (interface)
+```typescript
+interface CommsRecipientsWithActionQuery {
+  sourceId: string
+  actionId?: string
+  appId?: string
+  outcome?: string
+  idField?: 'userId' | 'contactId'
+  includeOutcome?: boolean
+  from?: string
+  to?: string
+  limit?: number
+}
+```
+
+**LogCommunicationEventBody** (interface)
+```typescript
+interface LogCommunicationEventBody {
+  sourceId: string
+  userId?: string
+  contactId?: string
+  channel?: string
+  eventType?: string
+  outcome?: string
+  templateId?: string
+  timestamp?: string
+  [k: string]: any
+}
+```
+
+**LogBulkCommunicationEventsBody** (interface)
+```typescript
+interface LogBulkCommunicationEventsBody {
+  params: { sourceId: string; [k: string]: any }
+  ids: string[]
+  idField?: 'userId' | 'contactId'
+}
+```
+
+**AppendResult** (interface)
+```typescript
+interface AppendResult {
+  success: true
+}
+```
+
+**AppendBulkResult** (interface)
+```typescript
+interface AppendBulkResult {
+  success: true; count: number
+}
+```
+
+**RecipientId** = `string`
+
 ### contact
 
 **ContactResponse** (interface)
@@ -1633,50 +1623,21 @@ Look up a serial number by code for a batch (admin only).
 
 ### broadcasts
 
-**byUser**(collectionId: string,
-    query: BroadcastQueryByUser = {}) → `Promise<BroadcastEvent[]>`
-POST /admin/collection/:collectionId/broadcasts/by-user Returns broadcast events array, newest first.
-
-**recipientIds**(collectionId: string,
-    query: RecipientIdsQuery) → `Promise<RecipientId[]>`
-POST /admin/collection/:collectionId/broadcasts/recipient-ids Returns recipient IDs for a broadcast.
-
-**recipientsWithoutAction**(collectionId: string,
-    query: RecipientsWithoutActionQuery) → `Promise<RecipientId[]>`
-POST /admin/collection/:collectionId/broadcasts/recipients/without-action Returns IDs who received the broadcast but did not perform an action.
-
-**recipientsWithAction**(collectionId: string,
-    query: RecipientsWithActionQuery) → `Promise<RecipientId[] | RecipientWithOutcome[]>`
-POST /admin/collection/:collectionId/broadcasts/recipients/with-action Returns IDs who received the broadcast and performed an action; optionally includes outcome.
-
-**append**(collectionId: string,
-    body: AppendBroadcastBody) → `Promise<AppendResult>`
-POST /admin/collection/:collectionId/broadcasts/append Appends one broadcast event.
-
-**appendBulk**(collectionId: string,
-    body: AppendBroadcastBulkBody | ({ broadcastId: string; ids: string[]; idField?: 'userId'|'contactId'; [k: string]: any }) → `void`
-POST /admin/collection/:collectionId/broadcasts/append/bulk Appends many broadcast recipients. Accepts preferred body shape with params + ids, and legacy flat shape.
-
 **create**(collectionId: string,
-    body: CreateBroadcastBody) → `Promise<BroadcastRecord>`
-POST /admin/collection/:collectionId/broadcasts/append/bulk Appends many broadcast recipients. Accepts preferred body shape with params + ids, and legacy flat shape.
+    body: Omit<BroadcastRecord, 'id' | 'collectionId' | 'createdAt'>) → `Promise<BroadcastRecord>`
 
 **list**(collectionId: string,
     query: ListBroadcastsQuery = {}) → `Promise<BroadcastList>`
-POST /admin/collection/:collectionId/broadcasts/append/bulk Appends many broadcast recipients. Accepts preferred body shape with params + ids, and legacy flat shape.
 
 **get**(collectionId: string,
     id: string) → `Promise<BroadcastRecord>`
-POST /admin/collection/:collectionId/broadcasts/append/bulk Appends many broadcast recipients. Accepts preferred body shape with params + ids, and legacy flat shape.
 
 **update**(collectionId: string,
     id: string,
-    body: UpdateBroadcastBody) → `Promise<BroadcastRecord>`
-POST /admin/collection/:collectionId/broadcasts/append/bulk Appends many broadcast recipients. Accepts preferred body shape with params + ids, and legacy flat shape.
+    body: Partial<Omit<BroadcastRecord, 'id' | 'collectionId' | 'createdAt'>>) → `Promise<BroadcastRecord>`
 
 **remove**(collectionId: string,
     id: string) → `Promise<void>`
-POST /admin/collection/:collectionId/broadcasts/append/bulk Appends many broadcast recipients. Accepts preferred body shape with params + ids, and legacy flat shape.
 
 ### claimSet
 
@@ -1762,6 +1723,30 @@ Assign a value to a serial number for a collection (admin only).
     request: SendNotificationRequest) → `Promise<SendNotificationResponse>`
 Send a notification to specified targets within a collection. Supports multiple delivery methods including push notifications, email, and wallet pass updates. The notification will be delivered based on user preferences and the specified delivery mode. ```typescript const result = await comms.sendNotification('my-collection', { subjectTargets: [{ type: 'product', id: 'prod_123' }], severity: 'important', mode: 'preferred', template: { push: { title: 'Update available', body: 'We\'ve shipped an important update.', icon: 'https://cdn.example.com/brand/logo-128.png' }, email: { subject: 'Important update for your product', body: 'There\'s an important update. Open your pass or profile to learn more.' }, walletUpdate: { textModulesData: [ { id: 'notice', header: 'Update', body: 'Open your wallet pass for details.' } ] } } }) if (result.ok) { console.log('Notification queued:', result.notificationId) console.log('Totals:', result.status.totals) } ```
 
+**queryByUser**(collectionId: string,
+    body: CommsQueryByUser = {}) → `Promise<CommunicationEvent[]>`
+Analytics: Query communication events by user or contact. POST /admin/collection/:collectionId/comm/query/by-user
+
+**queryRecipientIds**(collectionId: string,
+    body: CommsRecipientIdsQuery) → `Promise<RecipientId[]>`
+Analytics: Recipient IDs for a communication source. POST /admin/collection/:collectionId/comm/query/recipient-ids
+
+**queryRecipientsWithoutAction**(collectionId: string,
+    body: CommsRecipientsWithoutActionQuery) → `Promise<RecipientId[]>`
+Analytics: Recipients who did not perform an action. POST /admin/collection/:collectionId/comm/query/recipients/without-action
+
+**queryRecipientsWithAction**(collectionId: string,
+    body: CommsRecipientsWithActionQuery) → `Promise<RecipientId[] | RecipientWithOutcome[]>`
+Analytics: Recipients who performed an action, optionally with outcome. POST /admin/collection/:collectionId/comm/query/recipients/with-action
+
+**logCommunicationEvent**(collectionId: string,
+    body: LogCommunicationEventBody) → `Promise<AppendResult>`
+Logging: Append a single communication event. POST /admin/collection/:collectionId/comm/log
+
+**logBulkCommunicationEvents**(collectionId: string,
+    body: LogBulkCommunicationEventsBody | ({ sourceId: string; ids: string[]; idField?: 'userId'|'contactId'; [k: string]: any }) → `void`
+Logging: Append many communication events for a list of IDs. POST /admin/collection/:collectionId/comm/log/bulk
+
 ### contact
 
 **create**(collectionId: string, data: ContactCreateRequest) → `Promise<ContactResponse>`

package/dist/api/broadcasts.d.ts

@@ -1,44 +1,8 @@
-import type { BroadcastQueryByUser, RecipientIdsQuery, RecipientsWithoutActionQuery, RecipientsWithActionQuery, AppendBroadcastBody, AppendBroadcastBulkBody, BroadcastEvent, RecipientId, RecipientWithOutcome, AppendResult, AppendBulkResult, CreateBroadcastBody, UpdateBroadcastBody, ListBroadcastsQuery, BroadcastRecord, BroadcastList } from "../types/broadcasts";
+import type { ListBroadcastsQuery, BroadcastRecord, BroadcastList } from "../types/broadcasts";
 export declare namespace broadcasts {
-    /**
-     * POST /admin/collection/:collectionId/broadcasts/by-user
-     * Returns broadcast events array, newest first.
-     */
-    function byUser(collectionId: string, query?: BroadcastQueryByUser): Promise<BroadcastEvent[]>;
-    /**
-     * POST /admin/collection/:collectionId/broadcasts/recipient-ids
-     * Returns recipient IDs for a broadcast.
-     */
-    function recipientIds(collectionId: string, query: RecipientIdsQuery): Promise<RecipientId[]>;
-    /**
-     * POST /admin/collection/:collectionId/broadcasts/recipients/without-action
-     * Returns IDs who received the broadcast but did not perform an action.
-     */
-    function recipientsWithoutAction(collectionId: string, query: RecipientsWithoutActionQuery): Promise<RecipientId[]>;
-    /**
-     * POST /admin/collection/:collectionId/broadcasts/recipients/with-action
-     * Returns IDs who received the broadcast and performed an action; optionally includes outcome.
-     */
-    function recipientsWithAction(collectionId: string, query: RecipientsWithActionQuery): Promise<RecipientId[] | RecipientWithOutcome[]>;
-    /**
-     * POST /admin/collection/:collectionId/broadcasts/append
-     * Appends one broadcast event.
-     */
-    function append(collectionId: string, body: AppendBroadcastBody): Promise<AppendResult>;
-    /**
-     * POST /admin/collection/:collectionId/broadcasts/append/bulk
-     * Appends many broadcast recipients.
-     * Accepts preferred body shape with params + ids, and legacy flat shape.
-     */
-    function appendBulk(collectionId: string, body: AppendBroadcastBulkBody | ({
-        broadcastId: string;
-        ids: string[];
-        idField?: 'userId' | 'contactId';
-        [k: string]: any;
-    })): Promise<AppendBulkResult>;
-    function create(collectionId: string, body: CreateBroadcastBody): Promise<BroadcastRecord>;
+    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: UpdateBroadcastBody): 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>;
 }

package/dist/api/broadcasts.js

@@ -17,61 +17,6 @@ function encodeQuery(params) {
 }
 export var broadcasts;
 (function (broadcasts) {
-    /**
-     * POST /admin/collection/:collectionId/broadcasts/by-user
-     * Returns broadcast events array, newest first.
-     */
-    async function byUser(collectionId, query = {}) {
-        const path = `/admin/collection/${encodeURIComponent(collectionId)}/broadcasts/by-user`;
-        return post(path, query);
-    }
-    broadcasts.byUser = byUser;
-    /**
-     * POST /admin/collection/:collectionId/broadcasts/recipient-ids
-     * Returns recipient IDs for a broadcast.
-     */
-    async function recipientIds(collectionId, query) {
-        const path = `/admin/collection/${encodeURIComponent(collectionId)}/broadcasts/recipient-ids`;
-        return post(path, query);
-    }
-    broadcasts.recipientIds = recipientIds;
-    /**
-     * POST /admin/collection/:collectionId/broadcasts/recipients/without-action
-     * Returns IDs who received the broadcast but did not perform an action.
-     */
-    async function recipientsWithoutAction(collectionId, query) {
-        const path = `/admin/collection/${encodeURIComponent(collectionId)}/broadcasts/recipients/without-action`;
-        return post(path, query);
-    }
-    broadcasts.recipientsWithoutAction = recipientsWithoutAction;
-    /**
-     * POST /admin/collection/:collectionId/broadcasts/recipients/with-action
-     * Returns IDs who received the broadcast and performed an action; optionally includes outcome.
-     */
-    async function recipientsWithAction(collectionId, query) {
-        const path = `/admin/collection/${encodeURIComponent(collectionId)}/broadcasts/recipients/with-action`;
-        return post(path, query);
-    }
-    broadcasts.recipientsWithAction = recipientsWithAction;
-    /**
-     * POST /admin/collection/:collectionId/broadcasts/append
-     * Appends one broadcast event.
-     */
-    async function append(collectionId, body) {
-        const path = `/admin/collection/${encodeURIComponent(collectionId)}/broadcasts/append`;
-        return post(path, body);
-    }
-    broadcasts.append = append;
-    /**
-     * POST /admin/collection/:collectionId/broadcasts/append/bulk
-     * Appends many broadcast recipients.
-     * Accepts preferred body shape with params + ids, and legacy flat shape.
-     */
-    async function appendBulk(collectionId, body) {
-        const path = `/admin/collection/${encodeURIComponent(collectionId)}/broadcasts/append/bulk`;
-        return post(path, body);
-    }
-    broadcasts.appendBulk = appendBulk;
     // CRUD: Create broadcast
     async function create(collectionId, body) {
         const path = `/admin/collection/${encodeURIComponent(collectionId)}/broadcasts/`;

package/dist/api/comms.d.ts

@@ -1,4 +1,4 @@
-import type { SendNotificationRequest, SendNotificationResponse } from "../types/comms";
+import type { SendNotificationRequest, SendNotificationResponse, CommunicationEvent, CommsQueryByUser, CommsRecipientIdsQuery, CommsRecipientsWithoutActionQuery, CommsRecipientsWithActionQuery, RecipientId, RecipientWithOutcome, LogCommunicationEventBody, LogBulkCommunicationEventsBody, AppendResult, AppendBulkResult } from "../types/comms";
 /**
  * Communications namespace for sending notifications and managing user communications
  */
@@ -44,4 +44,39 @@ export declare namespace comms {
      * ```
      */
     function sendNotification(collectionId: string, request: SendNotificationRequest): Promise<SendNotificationResponse>;
+    /**
+     * Analytics: Query communication events by user or contact.
+     * POST /admin/collection/:collectionId/comm/query/by-user
+     */
+    function queryByUser(collectionId: string, body?: CommsQueryByUser): Promise<CommunicationEvent[]>;
+    /**
+     * Analytics: Recipient IDs for a communication source.
+     * POST /admin/collection/:collectionId/comm/query/recipient-ids
+     */
+    function queryRecipientIds(collectionId: string, body: CommsRecipientIdsQuery): Promise<RecipientId[]>;
+    /**
+     * Analytics: Recipients who did not perform an action.
+     * POST /admin/collection/:collectionId/comm/query/recipients/without-action
+     */
+    function queryRecipientsWithoutAction(collectionId: string, body: CommsRecipientsWithoutActionQuery): Promise<RecipientId[]>;
+    /**
+     * Analytics: Recipients who performed an action, optionally with outcome.
+     * POST /admin/collection/:collectionId/comm/query/recipients/with-action
+     */
+    function queryRecipientsWithAction(collectionId: string, body: CommsRecipientsWithActionQuery): Promise<RecipientId[] | RecipientWithOutcome[]>;
+    /**
+     * Logging: Append a single communication event.
+     * POST /admin/collection/:collectionId/comm/log
+     */
+    function logCommunicationEvent(collectionId: string, body: LogCommunicationEventBody): Promise<AppendResult>;
+    /**
+     * Logging: Append many communication events for a list of IDs.
+     * POST /admin/collection/:collectionId/comm/log/bulk
+     */
+    function logBulkCommunicationEvents(collectionId: string, body: LogBulkCommunicationEventsBody | ({
+        sourceId: string;
+        ids: string[];
+        idField?: 'userId' | 'contactId';
+        [k: string]: any;
+    })): Promise<AppendBulkResult>;
 }

package/dist/api/comms.js

@@ -51,4 +51,58 @@ export var comms;
         return post(path, request);
     }
     comms.sendNotification = sendNotification;
+    /**
+     * Analytics: Query communication events by user or contact.
+     * POST /admin/collection/:collectionId/comm/query/by-user
+     */
+    async function queryByUser(collectionId, body = {}) {
+        const path = `/admin/collection/${encodeURIComponent(collectionId)}/comm/query/by-user`;
+        return post(path, body);
+    }
+    comms.queryByUser = queryByUser;
+    /**
+     * Analytics: Recipient IDs for a communication source.
+     * POST /admin/collection/:collectionId/comm/query/recipient-ids
+     */
+    async function queryRecipientIds(collectionId, body) {
+        const path = `/admin/collection/${encodeURIComponent(collectionId)}/comm/query/recipient-ids`;
+        return post(path, body);
+    }
+    comms.queryRecipientIds = queryRecipientIds;
+    /**
+     * Analytics: Recipients who did not perform an action.
+     * POST /admin/collection/:collectionId/comm/query/recipients/without-action
+     */
+    async function queryRecipientsWithoutAction(collectionId, body) {
+        const path = `/admin/collection/${encodeURIComponent(collectionId)}/comm/query/recipients/without-action`;
+        return post(path, body);
+    }
+    comms.queryRecipientsWithoutAction = queryRecipientsWithoutAction;
+    /**
+     * Analytics: Recipients who performed an action, optionally with outcome.
+     * POST /admin/collection/:collectionId/comm/query/recipients/with-action
+     */
+    async function queryRecipientsWithAction(collectionId, body) {
+        const path = `/admin/collection/${encodeURIComponent(collectionId)}/comm/query/recipients/with-action`;
+        return post(path, body);
+    }
+    comms.queryRecipientsWithAction = queryRecipientsWithAction;
+    /**
+     * Logging: Append a single communication event.
+     * POST /admin/collection/:collectionId/comm/log
+     */
+    async function logCommunicationEvent(collectionId, body) {
+        const path = `/admin/collection/${encodeURIComponent(collectionId)}/comm/log`;
+        return post(path, body);
+    }
+    comms.logCommunicationEvent = logCommunicationEvent;
+    /**
+     * Logging: Append many communication events for a list of IDs.
+     * POST /admin/collection/:collectionId/comm/log/bulk
+     */
+    async function logBulkCommunicationEvents(collectionId, body) {
+        const path = `/admin/collection/${encodeURIComponent(collectionId)}/comm/log/bulk`;
+        return post(path, body);
+    }
+    comms.logBulkCommunicationEvents = logBulkCommunicationEvents;
 })(comms || (comms = {}));

package/dist/types/broadcasts.d.ts

@@ -1,83 +1,3 @@
-import type { IdField } from './common';
-export interface BroadcastEvent {
-    orgId: string;
-    broadcastId: string;
-    userId?: string;
-    contactId?: string;
-    channel?: string;
-    timestamp: string;
-    [k: string]: any;
-}
-export interface BroadcastQueryByUser {
-    userId?: string;
-    contactId?: string;
-    from?: string;
-    to?: string;
-    limit?: number;
-}
-export interface RecipientIdsQuery {
-    broadcastId: string;
-    idField?: IdField;
-    from?: string;
-    to?: string;
-    limit?: number;
-}
-export interface RecipientsWithoutActionQuery {
-    broadcastId: string;
-    actionId?: string;
-    appId?: string;
-    idField?: IdField;
-    from?: string;
-    to?: string;
-    limit?: number;
-}
-export interface RecipientsWithActionQuery {
-    broadcastId: string;
-    actionId?: string;
-    appId?: string;
-    outcome?: string;
-    idField?: IdField;
-    includeOutcome?: boolean;
-    from?: string;
-    to?: string;
-    limit?: number;
-}
-export type RecipientId = string;
-export interface RecipientWithOutcome {
-    id: string;
-    outcome: string;
-}
-export interface AppendBroadcastBody {
-    broadcastId: string;
-    userId?: string;
-    contactId?: string;
-    channel?: string;
-    timestamp?: string;
-    [k: string]: any;
-}
-export interface AppendBroadcastBulkBody {
-    params: {
-        broadcastId: string;
-        [k: string]: any;
-    };
-    ids: string[];
-    idField?: IdField;
-}
-export interface AppendResult {
-    success: true;
-}
-export interface AppendBulkResult {
-    success: true;
-    count: number;
-}
-export interface CreateBroadcastBody {
-    appId: string;
-    data?: Record<string, any>;
-}
-export interface UpdateBroadcastBody {
-    appId?: string;
-    data?: Record<string, any>;
-}
 export interface ListBroadcastsQuery {
     limit?: number;
     offset?: number;
@@ -87,11 +7,11 @@ export interface BroadcastRecord {
     id: string;
     collectionId: string;
     appId: string;
-    templateId?: string;
-    segmentId?: string;
-    status?: 'draft' | 'scheduled' | 'sending' | 'sent' | string;
-    scheduledAt?: string;
-    sentAt?: string;
+    templateId?: string | null;
+    segmentId?: string | null;
+    status?: string | null;
+    scheduledAt?: string | null;
+    sentAt?: string | null;
     data?: {
         display?: {
             title?: string;

package/dist/types/comms.d.ts

@@ -104,3 +104,80 @@ export interface SendNotificationResponse {
         };
     };
 }
+export interface CommunicationEvent {
+    orgId: string;
+    sourceId?: string;
+    userId?: string;
+    contactId?: string;
+    channel?: string;
+    timestamp: string;
+    eventType?: string;
+    outcome?: string | null;
+    templateId?: string | null;
+    [k: string]: any;
+}
+export interface CommsQueryByUser {
+    userId?: string;
+    contactId?: string;
+    from?: string;
+    to?: string;
+    limit?: number;
+}
+export type RecipientId = string;
+export interface RecipientWithOutcome {
+    id: string;
+    outcome: string;
+}
+export interface CommsRecipientIdsQuery {
+    sourceId: string;
+    idField?: 'userId' | 'contactId';
+    from?: string;
+    to?: string;
+    limit?: number;
+}
+export interface CommsRecipientsWithoutActionQuery {
+    sourceId: string;
+    actionId?: string;
+    appId?: string;
+    idField?: 'userId' | 'contactId';
+    from?: string;
+    to?: string;
+    limit?: number;
+}
+export interface CommsRecipientsWithActionQuery {
+    sourceId: string;
+    actionId?: string;
+    appId?: string;
+    outcome?: string;
+    idField?: 'userId' | 'contactId';
+    includeOutcome?: boolean;
+    from?: string;
+    to?: string;
+    limit?: number;
+}
+export interface LogCommunicationEventBody {
+    sourceId: string;
+    userId?: string;
+    contactId?: string;
+    channel?: string;
+    eventType?: string;
+    outcome?: string;
+    templateId?: string;
+    timestamp?: string;
+    [k: string]: any;
+}
+export interface LogBulkCommunicationEventsBody {
+    params: {
+        sourceId: string;
+        [k: string]: any;
+    };
+    ids: string[];
+    idField?: 'userId' | 'contactId';
+}
+export interface AppendResult {
+    success: true;
+}
+export interface AppendBulkResult {
+    success: true;
+    count: number;
+}

package/package.json

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