@proveanything/smartlinks 1.1.17 → 1.1.19

package/API_SUMMARY.md

@@ -1,6 +1,6 @@
 # Smartlinks API Summary
 
-Version: 1.1.17  |  Generated: 2026-01-03T21:07:47.591Z
+Version: 1.1.19  |  Generated: 2026-01-04T13:24:27.030Z
 
 This is a concise summary of all available API functions and types.
 
@@ -766,18 +766,23 @@ interface ErrorResponse {
 
 ### interaction
 
-**AdminInteractionsByUserRequest** (interface)
+**AdminInteractionsQueryRequest** (interface)
 ```typescript
-interface AdminInteractionsByUserRequest {
+interface AdminInteractionsQueryRequest {
   userId?: string
   contactId?: string
   appId?: string
   interactionId?: string
+  interactionIds?: string[]
   broadcastId?: string
   outcome?: string | null
   from?: string
   to?: string
   limit?: number
+  includeDeleted?: boolean
+  latestPerEventId?: boolean
+  order?: 'ASC' | 'DESC'
+  include?: Array<'interaction'>
 }
 ```
 
@@ -794,19 +799,6 @@ interface AdminInteractionsCountsByOutcomeRequest {
 }
 ```
 
-**AdminActorIdsByInteractionRequest** (interface)
-```typescript
-interface AdminActorIdsByInteractionRequest {
-  interactionId: string
-  idField?: IdField
-  outcome?: string | null
-  includeOutcome?: boolean
-  from?: string
-  to?: string
-  limit?: number
-}
-```
-
 **PublicInteractionsCountsByOutcomeRequest** (interface)
 ```typescript
 interface PublicInteractionsCountsByOutcomeRequest {
@@ -853,13 +845,6 @@ interface OutcomeCount {
 }
 ```
 
-**ActorWithOutcome** (interface)
-```typescript
-interface ActorWithOutcome {
-  id: string; outcome: string | null
-}
-```
-
 **InteractionEventBase** (interface)
 ```typescript
 interface InteractionEventBase {
@@ -966,8 +951,6 @@ interface ListInteractionTypesQuery {
 }
 ```
 
-**ActorId** = `string`
-
 ### journeys
 
 **JourneyRecord** (interface)
@@ -1336,7 +1319,7 @@ interface SegmentList {
 **SegmentCalculateResult** (interface)
 ```typescript
 interface SegmentCalculateResult {
-  scheduled: true
+  scheduled: boolean
   lastCalculatedAt?: string
   estimatedCount?: number | null
   note?: string
@@ -1346,7 +1329,7 @@ interface SegmentCalculateResult {
 **SegmentRecipientsResponse** (interface)
 ```typescript
 interface SegmentRecipientsResponse {
-  items: string[]
+  items: import('./contact').Contact[]
   limit: number
   offset: number
   total: number
@@ -1985,18 +1968,14 @@ Delete a form for a collection (admin only).
 
 ### interactions
 
-**byUser**(collectionId: string,
-    query: AdminInteractionsByUserRequest = {}) → `Promise<InteractionEventRow[]>`
-POST /admin/collection/:collectionId/interactions/by-user Returns BigQuery interaction rows, newest first.
+**query**(collectionId: string,
+    body: AdminInteractionsQueryRequest) → `Promise<InteractionEventRow[]>`
+POST /admin/collection/:collectionId/interactions/query Flexible query for interaction events with optional includes.
 
 **countsByOutcome**(collectionId: string,
     query: AdminInteractionsCountsByOutcomeRequest = {}) → `Promise<OutcomeCount[]>`
 POST /admin/collection/:collectionId/interactions/counts-by-outcome Returns array of { outcome, count }.
 
-**actorIdsByInteraction**(collectionId: string,
-    query: AdminActorIdsByInteractionRequest) → `Promise<ActorId[] | ActorWithOutcome[]>`
-POST /admin/collection/:collectionId/interactions/actor-ids/by-interaction Returns list of IDs, optionally with outcome when includeOutcome=true.
-
 **appendEvent**(collectionId: string,
     body: AppendInteractionBody) → `Promise<`
 POST /admin/collection/:collectionId/interactions/append Appends one interaction event.

package/dist/api/interactions.d.ts

@@ -1,20 +1,15 @@
-import type { AdminInteractionsByUserRequest, AdminInteractionsCountsByOutcomeRequest, AdminActorIdsByInteractionRequest, AppendInteractionBody, UpdateInteractionBody, OutcomeCount, ActorId, ActorWithOutcome, InteractionEventRow, PublicInteractionsCountsByOutcomeRequest, PublicInteractionsByUserRequest, CreateInteractionTypeBody, UpdateInteractionTypeBody, ListInteractionTypesQuery, InteractionTypeRecord, InteractionTypeList } from "../types/interaction";
+import type { AdminInteractionsCountsByOutcomeRequest, AdminInteractionsQueryRequest, AppendInteractionBody, UpdateInteractionBody, OutcomeCount, InteractionEventRow, PublicInteractionsCountsByOutcomeRequest, PublicInteractionsByUserRequest, CreateInteractionTypeBody, UpdateInteractionTypeBody, ListInteractionTypesQuery, InteractionTypeRecord, InteractionTypeList } from "../types/interaction";
 export declare namespace interactions {
     /**
-     * POST /admin/collection/:collectionId/interactions/by-user
-     * Returns BigQuery interaction rows, newest first.
+     * POST /admin/collection/:collectionId/interactions/query
+     * Flexible query for interaction events with optional includes.
      */
-    function byUser(collectionId: string, query?: AdminInteractionsByUserRequest): Promise<InteractionEventRow[]>;
+    function query(collectionId: string, body: AdminInteractionsQueryRequest): Promise<InteractionEventRow[]>;
     /**
      * POST /admin/collection/:collectionId/interactions/counts-by-outcome
      * Returns array of { outcome, count }.
      */
     function countsByOutcome(collectionId: string, query?: AdminInteractionsCountsByOutcomeRequest): Promise<OutcomeCount[]>;
-    /**
-     * POST /admin/collection/:collectionId/interactions/actor-ids/by-interaction
-     * Returns list of IDs, optionally with outcome when includeOutcome=true.
-     */
-    function actorIdsByInteraction(collectionId: string, query: AdminActorIdsByInteractionRequest): Promise<ActorId[] | ActorWithOutcome[]>;
     /**
      * POST /admin/collection/:collectionId/interactions/append
      * Appends one interaction event.

package/dist/api/interactions.js

@@ -18,14 +18,14 @@ function encodeQuery(params) {
 export var interactions;
 (function (interactions) {
     /**
-     * POST /admin/collection/:collectionId/interactions/by-user
-     * Returns BigQuery interaction rows, newest first.
+     * POST /admin/collection/:collectionId/interactions/query
+     * Flexible query for interaction events with optional includes.
      */
-    async function byUser(collectionId, query = {}) {
-        const path = `/admin/collection/${encodeURIComponent(collectionId)}/interactions/by-user`;
-        return post(path, query);
+    async function query(collectionId, body) {
+        const path = `/admin/collection/${encodeURIComponent(collectionId)}/interactions/query`;
+        return post(path, body);
     }
-    interactions.byUser = byUser;
+    interactions.query = query;
     /**
      * POST /admin/collection/:collectionId/interactions/counts-by-outcome
      * Returns array of { outcome, count }.
@@ -35,15 +35,7 @@ export var interactions;
         return post(path, query);
     }
     interactions.countsByOutcome = countsByOutcome;
-    /**
-     * POST /admin/collection/:collectionId/interactions/actor-ids/by-interaction
-     * Returns list of IDs, optionally with outcome when includeOutcome=true.
-     */
-    async function actorIdsByInteraction(collectionId, query) {
-        const path = `/admin/collection/${encodeURIComponent(collectionId)}/interactions/actor-ids/by-interaction`;
-        return post(path, query);
-    }
-    interactions.actorIdsByInteraction = actorIdsByInteraction;
+    // Deprecated endpoint removed: actorIdsByInteraction
     /**
      * POST /admin/collection/:collectionId/interactions/append
      * Appends one interaction event.
@@ -60,7 +52,7 @@ export var interactions;
         if (!body.userId && !body.contactId) {
             throw new Error("AppendInteractionBody must include one of userId or contactId");
         }
-        const path = `/admin/collection/${encodeURIComponent(collectionId)}/interactions/append`;
+        const path = `/admin/collection/${encodeURIComponent(collectionId)}/interactions/events/update`;
         return post(path, body);
     }
     interactions.updateEvent = updateEvent;

package/dist/types/interaction.d.ts

@@ -1,14 +1,19 @@
 import type { IdField } from './common';
-export interface AdminInteractionsByUserRequest {
+export interface AdminInteractionsQueryRequest {
     userId?: string;
     contactId?: string;
     appId?: string;
     interactionId?: string;
+    interactionIds?: string[];
     broadcastId?: string;
     outcome?: string | null;
     from?: string;
     to?: string;
     limit?: number;
+    includeDeleted?: boolean;
+    latestPerEventId?: boolean;
+    order?: 'ASC' | 'DESC';
+    include?: Array<'interaction'>;
 }
 export interface AdminInteractionsCountsByOutcomeRequest {
     appId?: string;
@@ -19,15 +24,6 @@ export interface AdminInteractionsCountsByOutcomeRequest {
     dedupeLatest?: boolean;
     idField?: IdField;
 }
-export interface AdminActorIdsByInteractionRequest {
-    interactionId: string;
-    idField?: IdField;
-    outcome?: string | null;
-    includeOutcome?: boolean;
-    from?: string;
-    to?: string;
-    limit?: number;
-}
 export interface PublicInteractionsCountsByOutcomeRequest {
     appId: string;
     interactionId: string;
@@ -59,11 +55,6 @@ export interface OutcomeCount {
     outcome: string | null;
     count: number;
 }
-export type ActorId = string;
-export interface ActorWithOutcome {
-    id: string;
-    outcome: string | null;
-}
 export interface InteractionEventBase {
     collectionId: string;
     orgId?: 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('./contact').Contact[];
     limit: number;
     offset: number;
     total: number;

package/package.json

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