@proveanything/smartlinks 1.1.9 → 1.1.11

package/API_SUMMARY.md

@@ -1,6 +1,6 @@
 # Smartlinks API Summary
 
-Version: 1.1.9  |  Generated: 2025-12-24T13:18:43.320Z
+Version: 1.1.11  |  Generated: 2025-12-26T15:12:34.830Z
 
 This is a concise summary of all available API functions and types.
 
@@ -30,7 +30,7 @@ The Smartlinks SDK is organized into the following namespaces:
 - **segments** - Define dynamic/static audience segments; estimate and list recipients; schedule calculations.
 
 — Analytics & Events —
-- **actions** - Log and analyze actions/outcomes; aggregates and actor lists; action definition CRUD.
+- **interactions** - Log and analyze interactions/outcomes; aggregates and actor lists; interaction definition CRUD.
 
 — Automation —
 - **journeys** - Configure automated flows triggered by events or schedules; steps, rules; full CRUD.
@@ -108,192 +108,6 @@ Sends a custom proxy message to the parent Smartlinks application when running i
 
 ## Types
 
-### actions
-
-**AdminByUserRequest** (interface)
-```typescript
-interface AdminByUserRequest {
-  userId?: string
-  contactId?: string
-  appId?: string
-  actionId?: string
-  broadcastId?: string
-  outcome?: string | null
-  from?: string
-  to?: string
-  limit?: number
-}
-```
-
-**AdminCountsByOutcomeRequest** (interface)
-```typescript
-interface AdminCountsByOutcomeRequest {
-  appId?: string
-  actionId?: string
-  from?: string
-  to?: string
-  limit?: number
-  dedupeLatest?: boolean
-  idField?: IdField
-}
-```
-
-**AdminActorIdsByActionRequest** (interface)
-```typescript
-interface AdminActorIdsByActionRequest {
-  actionId: string
-  idField?: IdField
-  outcome?: string | null
-  includeOutcome?: boolean
-  from?: string
-  to?: string
-  limit?: number
-}
-```
-
-**PublicCountsByOutcomeRequest** (interface)
-```typescript
-interface PublicCountsByOutcomeRequest {
-  appId: string
-  actionId: string
-  from?: string
-  to?: string
-  limit?: number
-}
-```
-
-**PublicByUserRequest** (interface)
-```typescript
-interface PublicByUserRequest {
-  appId: string
-  actionId: string
-  from?: string
-  to?: string
-  limit?: number
-}
-```
-
-**ActionEventRow** (interface)
-```typescript
-interface ActionEventRow {
-  orgId: string
-  collectionId: string
-  timestamp: string
-  appId?: string
-  actionId?: string
-  broadcastId?: string
-  userId?: string
-  contactId?: string
-  outcome?: string | null
-  metadata?: Record<string, unknown>
-  [k: string]: unknown
-}
-```
-
-**OutcomeCount** (interface)
-```typescript
-interface OutcomeCount {
-  outcome: string | null; count: number
-}
-```
-
-**ActorWithOutcome** (interface)
-```typescript
-interface ActorWithOutcome {
-  id: string; outcome: string | null
-}
-```
-
-**AppendActionBody** (interface)
-```typescript
-interface AppendActionBody {
-  userId?: string
-  contactId?: string
-  actionId: string
-  appId?: string
-  broadcastId?: string
-  outcome?: string
-  timestamp?: string
-  metadata?: Record<string, unknown>
-  [k: string]: any
-}
-```
-
-**ActionPermissions** (interface)
-```typescript
-interface ActionPermissions {
-  allowOwnRead?: boolean
-  allowPublicSummary?: boolean
-  allowAuthenticatedSummary?: boolean
-}
-```
-
-**ActionRecord** (interface)
-```typescript
-interface ActionRecord {
-  id?: string
-  collectionId: string
-  appId: string
-  permissions?: ActionPermissions
-  data?: {
-  display?: {
-  title?: string
-  description?: string
-  icon?: string
-  color?: string
-  }
-  actionType?: string
-  [key: string]: unknown
-  }
-  createdAt: string
-}
-```
-
-**ActionList** (interface)
-```typescript
-interface ActionList {
-  items: ActionRecord[]
-  limit: number
-  offset: number
-}
-```
-
-**CreateActionBody** (interface)
-```typescript
-interface CreateActionBody {
-  id: string
-  appId: string
-  permissions?: ActionPermissions
-  data?: Record<string, unknown>
-}
-```
-
-**UpdateActionBody** (interface)
-```typescript
-interface UpdateActionBody {
-  appId?: string
-  permissions?: ActionPermissions
-  data?: Record<string, unknown>
-}
-```
-
-**ListActionsQuery** (interface)
-```typescript
-interface ListActionsQuery {
-  appId?: string
-  limit?: number
-  offset?: number
-}
-```
-
-**ActorId** = `string`
-
-**ActionQueryByUser** = `AdminByUserRequest`
-
-**ActionCountsQuery** = `AdminCountsByOutcomeRequest`
-
-**ActorIdsByActionQuery** = `AdminActorIdsByActionRequest`
-
 ### appConfiguration
 
 **AppConfigurationResponse** (interface)
@@ -963,6 +777,210 @@ interface ErrorResponse {
 }
 ```
 
+### interaction
+
+**AdminInteractionsByUserRequest** (interface)
+```typescript
+interface AdminInteractionsByUserRequest {
+  userId?: string
+  contactId?: string
+  appId?: string
+  interactionId?: string
+  broadcastId?: string
+  outcome?: string | null
+  from?: string
+  to?: string
+  limit?: number
+}
+```
+
+**AdminInteractionsCountsByOutcomeRequest** (interface)
+```typescript
+interface AdminInteractionsCountsByOutcomeRequest {
+  appId?: string
+  interactionId?: string
+  from?: string
+  to?: string
+  limit?: number
+  dedupeLatest?: boolean
+  idField?: IdField
+}
+```
+
+**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 {
+  appId: string
+  interactionId: string
+  from?: string
+  to?: string
+  limit?: number
+}
+```
+
+**PublicInteractionsByUserRequest** (interface)
+```typescript
+interface PublicInteractionsByUserRequest {
+  appId: string
+  interactionId: string
+  from?: string
+  to?: string
+  limit?: number
+}
+```
+
+**InteractionEventRow** (interface)
+```typescript
+interface InteractionEventRow {
+  orgId: string
+  collectionId: string
+  timestamp: string
+  appId?: string
+  interactionId?: string
+  broadcastId?: string
+  userId?: string
+  contactId?: string
+  outcome?: string | null
+  metadata?: Record<string, unknown>
+  [k: string]: unknown
+}
+```
+
+**OutcomeCount** (interface)
+```typescript
+interface OutcomeCount {
+  outcome: string | null; count: number
+}
+```
+
+**ActorWithOutcome** (interface)
+```typescript
+interface ActorWithOutcome {
+  id: string; outcome: string | null
+}
+```
+
+**InteractionEventBase** (interface)
+```typescript
+interface InteractionEventBase {
+  collectionId: string,
+  ordId: string,
+  userId?: string
+  contactId?: string
+  interactionId: string
+  appId?: string
+  broadcastId?: string
+  journeyId?: string
+  productId?: string
+  proofId?: string
+  variantId?: string
+  batchId?: string
+  source?: string,
+  eventType?: string
+  outcome?: string
+  timestamp?: string
+  metadata?: Record<string, unknown>
+  [k: string]: any
+}
+```
+
+**InteractionPermissions** (interface)
+```typescript
+interface InteractionPermissions {
+  enabled?: boolean
+  requireAuth?: boolean
+  allowPublicSubmit?: boolean
+  allowAnonymousSubmit?: boolean
+  allowedOrigins?: string[]
+  startAt?: string
+  endAt?: string
+  * Enforce uniqueness per user: prevent duplicate submissions for this interaction.
+  * If true, optionally use `uniquePerUserWindowSeconds` to scope the window.
+  uniquePerUser?: boolean
+  uniquePerUserWindowSeconds?: number
+  uniqueOutcome?: string
+  * Public summary visibility (counts, aggregates) without auth.
+  * If false, summaries require `allowAuthenticatedSummary` + user auth.
+  allowPublicSummary?: boolean
+  * Authenticated summary visibility (counts, aggregates) when user is signed in.
+  allowAuthenticatedSummary?: boolean
+  allowOwnRead?: boolean
+}
+```
+
+**InteractionTypeRecord** (interface)
+```typescript
+interface InteractionTypeRecord {
+  id?: string
+  collectionId: string
+  appId: string
+  permissions?: InteractionPermissions
+  data?: {
+  display?: {
+  title?: string
+  description?: string
+  icon?: string
+  color?: string
+  }
+  interactionType?: string
+  [key: string]: unknown
+  }
+  createdAt: string
+}
+```
+
+**InteractionTypeList** (interface)
+```typescript
+interface InteractionTypeList {
+  items: InteractionTypeRecord[]
+  limit: number
+  offset: number
+}
+```
+
+**CreateInteractionTypeBody** (interface)
+```typescript
+interface CreateInteractionTypeBody {
+  id: string
+  appId: string
+  permissions?: InteractionPermissions
+  data?: Record<string, unknown>
+}
+```
+
+**UpdateInteractionTypeBody** (interface)
+```typescript
+interface UpdateInteractionTypeBody {
+  appId?: string
+  permissions?: InteractionPermissions
+  data?: Record<string, unknown>
+}
+```
+
+**ListInteractionTypesQuery** (interface)
+```typescript
+interface ListInteractionTypesQuery {
+  appId?: string
+  limit?: number
+  offset?: number
+}
+```
+
+**ActorId** = `string`
+
 ### journeys
 
 **JourneyRecord** (interface)
@@ -1403,55 +1421,6 @@ type AccountInfoResponse = {
 
 ## API Functions
 
-### actions
-
-**byUser**(collectionId: string,
-    query: AdminByUserRequest | ActionQueryByUser = {}) → `Promise<ActionEventRow[]>`
-POST /admin/collection/:collectionId/actions/by-user Returns BigQuery action rows, newest first.
-
-**countsByOutcome**(collectionId: string,
-    query: AdminCountsByOutcomeRequest | ActionCountsQuery = {}) → `Promise<OutcomeCount[]>`
-POST /admin/collection/:collectionId/actions/counts-by-outcome Returns array of { outcome, count }.
-
-**actorIdsByAction**(collectionId: string,
-    query: AdminActorIdsByActionRequest | ActorIdsByActionQuery) → `Promise<ActorId[] | ActorWithOutcome[]>`
-POST /admin/collection/:collectionId/actions/actor-ids/by-action Returns list of IDs, optionally with outcome when includeOutcome=true.
-
-**append**(collectionId: string,
-    body: AppendActionBody) → `Promise<`
-POST /admin/collection/:collectionId/actions/append Appends one action event.
-
-**create**(collectionId: string,
-    body: CreateActionBody) → `Promise<ActionRecord>`
-POST /admin/collection/:collectionId/actions/append Appends one action event.
-
-**list**(collectionId: string,
-    query: ListActionsQuery = {}) → `Promise<ActionList>`
-POST /admin/collection/:collectionId/actions/append Appends one action event.
-
-**get**(collectionId: string,
-    id: string) → `Promise<ActionRecord>`
-POST /admin/collection/:collectionId/actions/append Appends one action event.
-
-**update**(collectionId: string,
-    id: string,
-    patchBody: UpdateActionBody) → `Promise<ActionRecord>`
-POST /admin/collection/:collectionId/actions/append Appends one action event.
-
-**remove**(collectionId: string,
-    id: string) → `Promise<void>`
-POST /admin/collection/:collectionId/actions/append Appends one action event.
-
-**publicCountsByOutcome**(collectionId: string,
-    body: PublicCountsByOutcomeRequest,
-    authToken?: string) → `Promise<OutcomeCount[]>`
-POST /admin/collection/:collectionId/actions/append Appends one action event.
-
-**publicMyActions**(collectionId: string,
-    body: PublicByUserRequest,
-    authToken?: string) → `Promise<ActionEventRow[]>`
-POST /admin/collection/:collectionId/actions/append Appends one action event.
-
 ### ai
 
 **generateContent**(collectionId: string,
@@ -1909,6 +1878,63 @@ Update a form for a collection (admin only).
 **remove**(collectionId: string, formId: string) → `Promise<void>`
 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.
+
+**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.
+
+**updateEvent**(collectionId: string,
+    body: UpdateInteractionBody) → `Promise<`
+POST /admin/collection/:collectionId/interactions/append Appends one interaction event.
+
+**submitPublicEvent**(collectionId: string,
+    body: AppendInteractionBody) → `Promise<`
+Appends one interaction event from a public source.
+
+**create**(collectionId: string,
+    body: CreateInteractionTypeBody) → `Promise<InteractionTypeRecord>`
+Appends one interaction event from a public source.
+
+**list**(collectionId: string,
+    query: ListInteractionTypesQuery = {}) → `Promise<InteractionTypeList>`
+Appends one interaction event from a public source.
+
+**get**(collectionId: string,
+    id: string) → `Promise<InteractionTypeRecord>`
+Appends one interaction event from a public source.
+
+**update**(collectionId: string,
+    id: string,
+    patchBody: UpdateInteractionTypeBody) → `Promise<InteractionTypeRecord>`
+Appends one interaction event from a public source.
+
+**remove**(collectionId: string,
+    id: string) → `Promise<void>`
+Appends one interaction event from a public source.
+
+**publicCountsByOutcome**(collectionId: string,
+    body: PublicInteractionsCountsByOutcomeRequest,
+    authToken?: string) → `Promise<OutcomeCount[]>`
+Appends one interaction event from a public source.
+
+**publicMyInteractions**(collectionId: string,
+    body: PublicInteractionsByUserRequest,
+    authToken?: string) → `Promise<InteractionEventRow[]>`
+Appends one interaction event from a public source.
+
 ### journeys
 
 **create**(collectionId: string,

package/dist/api/index.d.ts

@@ -16,10 +16,10 @@ export { ai } from "./ai";
 export { comms } from "./comms";
 export { nfc } from "./nfc";
 export { contact } from "./contact";
-export { actions } from "./actions";
 export { broadcasts } from "./broadcasts";
 export { segments } from "./segments";
 export { journeys } from "./journeys";
 export { qr } from "./qr";
 export { template } from "./template";
+export { interactions } from "./interactions";
 export type { AIGenerateContentRequest, AIGenerateImageRequest, AISearchPhotosRequest, AISearchPhotosPhoto } from "./ai";

package/dist/api/index.js

@@ -18,9 +18,9 @@ export { ai } from "./ai";
 export { comms } from "./comms";
 export { nfc } from "./nfc";
 export { contact } from "./contact";
-export { actions } from "./actions";
 export { broadcasts } from "./broadcasts";
 export { segments } from "./segments";
 export { journeys } from "./journeys";
 export { qr } from "./qr";
 export { template } from "./template";
+export { interactions } from "./interactions";

package/dist/api/interactions.d.ts

@@ -0,0 +1,41 @@
+import type { AdminInteractionsByUserRequest, AdminInteractionsCountsByOutcomeRequest, AdminActorIdsByInteractionRequest, AppendInteractionBody, UpdateInteractionBody, OutcomeCount, ActorId, ActorWithOutcome, 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.
+     */
+    function byUser(collectionId: string, query?: AdminInteractionsByUserRequest): 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.
+     */
+    function appendEvent(collectionId: string, body: AppendInteractionBody): Promise<{
+        success: true;
+    }>;
+    function updateEvent(collectionId: string, body: UpdateInteractionBody): Promise<{
+        success: true;
+    }>;
+    /**
+       * Appends one interaction event from a public source.
+       */
+    function submitPublicEvent(collectionId: string, body: AppendInteractionBody): Promise<{
+        success: true;
+    }>;
+    function create(collectionId: string, body: CreateInteractionTypeBody): Promise<InteractionTypeRecord>;
+    function list(collectionId: string, query?: ListInteractionTypesQuery): Promise<InteractionTypeList>;
+    function get(collectionId: string, id: string): Promise<InteractionTypeRecord>;
+    function update(collectionId: string, id: string, patchBody: UpdateInteractionTypeBody): Promise<InteractionTypeRecord>;
+    function remove(collectionId: string, id: string): Promise<void>;
+    function publicCountsByOutcome(collectionId: string, body: PublicInteractionsCountsByOutcomeRequest, authToken?: string): Promise<OutcomeCount[]>;
+    function publicMyInteractions(collectionId: string, body: PublicInteractionsByUserRequest, authToken?: string): Promise<InteractionEventRow[]>;
+}

package/dist/api/interactions.js

@@ -0,0 +1,118 @@
+// src/api/interactions.ts
+import { request, post, patch, del } from "../http";
+function encodeQuery(params) {
+    const search = new URLSearchParams();
+    for (const [key, value] of Object.entries(params)) {
+        if (value === undefined || value === null || value === "")
+            continue;
+        if (typeof value === "boolean") {
+            search.set(key, value ? "true" : "false");
+        }
+        else {
+            search.set(key, String(value));
+        }
+    }
+    const qs = search.toString();
+    return qs ? `?${qs}` : "";
+}
+export var interactions;
+(function (interactions) {
+    /**
+     * POST /admin/collection/:collectionId/interactions/by-user
+     * Returns BigQuery interaction rows, newest first.
+     */
+    async function byUser(collectionId, query = {}) {
+        const path = `/admin/collection/${encodeURIComponent(collectionId)}/interactions/by-user`;
+        return post(path, query);
+    }
+    interactions.byUser = byUser;
+    /**
+     * POST /admin/collection/:collectionId/interactions/counts-by-outcome
+     * Returns array of { outcome, count }.
+     */
+    async function countsByOutcome(collectionId, query = {}) {
+        const path = `/admin/collection/${encodeURIComponent(collectionId)}/interactions/counts-by-outcome`;
+        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;
+    /**
+     * POST /admin/collection/:collectionId/interactions/append
+     * Appends one interaction event.
+     */
+    async function appendEvent(collectionId, body) {
+        if (!body.userId && !body.contactId) {
+            throw new Error("AppendInteractionBody must include one of userId or contactId");
+        }
+        const path = `/admin/collection/${encodeURIComponent(collectionId)}/interactions/append`;
+        return post(path, body);
+    }
+    interactions.appendEvent = appendEvent;
+    async function updateEvent(collectionId, body) {
+        if (!body.userId && !body.contactId) {
+            throw new Error("AppendInteractionBody must include one of userId or contactId");
+        }
+        const path = `/admin/collection/${encodeURIComponent(collectionId)}/interactions/append`;
+        return post(path, body);
+    }
+    interactions.updateEvent = updateEvent;
+    /**
+       * Appends one interaction event from a public source.
+       */
+    async function submitPublicEvent(collectionId, body) {
+        if (!body.userId && !body.contactId) {
+            throw new Error("AppendInteractionBody must include one of userId or contactId");
+        }
+        const path = `/public/collection/${encodeURIComponent(collectionId)}/interactions/submit`;
+        return post(path, body);
+    }
+    interactions.submitPublicEvent = submitPublicEvent;
+    // CRUD: Interaction Types (Postgres)
+    async function create(collectionId, body) {
+        const path = `/admin/collection/${encodeURIComponent(collectionId)}/interactions/`;
+        return post(path, body);
+    }
+    interactions.create = create;
+    async function list(collectionId, query = {}) {
+        const qs = encodeQuery(query);
+        const path = `/admin/collection/${encodeURIComponent(collectionId)}/interactions/${qs}`;
+        return request(path);
+    }
+    interactions.list = list;
+    async function get(collectionId, id) {
+        const path = `/admin/collection/${encodeURIComponent(collectionId)}/interactions/${encodeURIComponent(id)}`;
+        return request(path);
+    }
+    interactions.get = get;
+    async function update(collectionId, id, patchBody) {
+        const path = `/admin/collection/${encodeURIComponent(collectionId)}/interactions/${encodeURIComponent(id)}`;
+        return patch(path, patchBody);
+    }
+    interactions.update = update;
+    async function remove(collectionId, id) {
+        const path = `/admin/collection/${encodeURIComponent(collectionId)}/interactions/${encodeURIComponent(id)}`;
+        return del(path);
+    }
+    interactions.remove = remove;
+    // Public endpoints (permission-aware)
+    async function publicCountsByOutcome(collectionId, body, authToken) {
+        const path = `/public/collection/${encodeURIComponent(collectionId)}/interactions/counts-by-outcome`;
+        const headers = authToken ? { AUTHORIZATION: `Bearer ${authToken}` } : undefined;
+        return post(path, body, headers);
+    }
+    interactions.publicCountsByOutcome = publicCountsByOutcome;
+    async function publicMyInteractions(collectionId, body, authToken) {
+        const path = `/public/collection/${encodeURIComponent(collectionId)}/interactions/by-user`;
+        const headers = authToken ? { AUTHORIZATION: `Bearer ${authToken}` } : undefined;
+        return post(path, body, headers);
+    }
+    interactions.publicMyInteractions = publicMyInteractions;
+})(interactions || (interactions = {}));

package/dist/types/index.d.ts

@@ -11,10 +11,10 @@ export * from "./auth";
 export * from "./comms";
 export * from "./nfc";
 export * from "./contact";
-export * from "./actions";
 export * from "./broadcasts";
 export * from "./segments";
 export * from "./common";
 export * from "./journeys";
 export * from "./qr";
 export * from "./template";
+export * from "./interaction";

package/dist/types/index.js

@@ -13,10 +13,10 @@ export * from "./auth";
 export * from "./comms";
 export * from "./nfc";
 export * from "./contact";
-export * from "./actions";
 export * from "./broadcasts";
 export * from "./segments";
 export * from "./common";
 export * from "./journeys";
 export * from "./qr";
 export * from "./template";
+export * from "./interaction";

package/dist/types/interaction.d.ts

@@ -0,0 +1,172 @@
+import type { IdField } from './common';
+export interface AdminInteractionsByUserRequest {
+    userId?: string;
+    contactId?: string;
+    appId?: string;
+    interactionId?: string;
+    broadcastId?: string;
+    outcome?: string | null;
+    from?: string;
+    to?: string;
+    limit?: number;
+}
+export interface AdminInteractionsCountsByOutcomeRequest {
+    appId?: string;
+    interactionId?: string;
+    from?: string;
+    to?: string;
+    limit?: number;
+    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;
+    from?: string;
+    to?: string;
+    limit?: number;
+}
+export interface PublicInteractionsByUserRequest {
+    appId: string;
+    interactionId: string;
+    from?: string;
+    to?: string;
+    limit?: number;
+}
+export interface InteractionEventRow {
+    orgId: string;
+    collectionId: string;
+    timestamp: string;
+    appId?: string;
+    interactionId?: string;
+    broadcastId?: string;
+    userId?: string;
+    contactId?: string;
+    outcome?: string | null;
+    metadata?: Record<string, unknown>;
+    [k: string]: unknown;
+}
+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;
+    ordId: string;
+    userId?: string;
+    contactId?: string;
+    interactionId: string;
+    appId?: string;
+    broadcastId?: string;
+    journeyId?: string;
+    productId?: string;
+    proofId?: string;
+    variantId?: string;
+    batchId?: string;
+    source?: string;
+    eventType?: string;
+    outcome?: string;
+    timestamp?: string;
+    metadata?: Record<string, unknown>;
+    [k: string]: any;
+}
+export interface AppendInteractionBody extends InteractionEventBase {
+}
+export interface UpdateInteractionBody extends InteractionEventBase {
+    eventId: string;
+    status?: 'active' | 'deleted';
+}
+/**
+ * InteractionPermissions: configuration for public + authenticated interaction behavior.
+ *
+ * Stored under the `permissions` JSON for an interaction definition (Postgres `interactions` table).
+ * These keys control whether submissions are allowed, visibility of summaries, and guardrails.
+ */
+export interface InteractionPermissions {
+    /** Enable/disable submissions globally for this interaction (default: enabled). */
+    enabled?: boolean;
+    /** Require an authenticated user to submit. If true, anonymous/public submissions are blocked. */
+    requireAuth?: boolean;
+    /** Allow public (non-auth) submissions in general. */
+    allowPublicSubmit?: boolean;
+    /** Allow anonymous submissions even without a session (subset of public). */
+    allowAnonymousSubmit?: boolean;
+    /** Restrict submissions to matching origins (e.g., site domains). Uses substring match. */
+    allowedOrigins?: string[];
+    /** ISO datetime: submissions allowed at or after this time. */
+    startAt?: string;
+    /** ISO datetime: submissions allowed up to and including this time. */
+    endAt?: string;
+    /**
+     * Enforce uniqueness per user: prevent duplicate submissions for this interaction.
+     * If true, optionally use `uniquePerUserWindowSeconds` to scope the window.
+     */
+    uniquePerUser?: boolean;
+    /** Time window in seconds for uniqueness checks (e.g., 86400 for one day). */
+    uniquePerUserWindowSeconds?: number;
+    /** Optional outcome tag used when checking duplicates (e.g., "submitted"). */
+    uniqueOutcome?: string;
+    /**
+     * Public summary visibility (counts, aggregates) without auth.
+     * If false, summaries require `allowAuthenticatedSummary` + user auth.
+     */
+    allowPublicSummary?: boolean;
+    /**
+     * Authenticated summary visibility (counts, aggregates) when user is signed in.
+     */
+    allowAuthenticatedSummary?: boolean;
+    /** Allow an authenticated user to read their own interaction history via the public API. */
+    allowOwnRead?: boolean;
+}
+export interface InteractionTypeRecord {
+    id?: string;
+    collectionId: string;
+    appId: string;
+    permissions?: InteractionPermissions;
+    data?: {
+        display?: {
+            title?: string;
+            description?: string;
+            icon?: string;
+            color?: string;
+        };
+        interactionType?: string;
+        [key: string]: unknown;
+    };
+    createdAt: string;
+}
+export interface InteractionTypeList {
+    items: InteractionTypeRecord[];
+    limit: number;
+    offset: number;
+}
+export interface CreateInteractionTypeBody {
+    id: string;
+    appId: string;
+    permissions?: InteractionPermissions;
+    data?: Record<string, unknown>;
+}
+export interface UpdateInteractionTypeBody {
+    appId?: string;
+    permissions?: InteractionPermissions;
+    data?: Record<string, unknown>;
+}
+export interface ListInteractionTypesQuery {
+    appId?: string;
+    limit?: number;
+    offset?: number;
+}

package/dist/types/interaction.js

@@ -0,0 +1,2 @@
+// src/types/interaction.ts
+export {};

package/package.json

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