@proveanything/smartlinks 1.1.1 → 1.1.3

package/API_SUMMARY.md

@@ -1,6 +1,6 @@
 # Smartlinks API Summary
 
-Version: 1.1.1  |  Generated: 2025-12-18T22:33:00.019Z
+Version: 1.1.3  |  Generated: 2025-12-19T16:03:17.326Z
 
 This is a concise summary of all available API functions and types.
 
@@ -344,22 +344,15 @@ interface AttestationUpdateRequest {
 
 ### auth
 
-**UserAccountRegistrationRequest** (type)
+**UserAccountRegistrationRequest** (interface)
 ```typescript
-type UserAccountRegistrationRequest = {
-  /** User's display name */
+interface UserAccountRegistrationRequest {
   name: string
-  /** Optional user email */
   email?: string
-  /** Optional user phone number */
   phone?: string
-  /** Optional password for email login */
   password?: string
-  /** Send confirmation email after registration */
   sendAccountConfirmation?: boolean
-  /** Optional collection context for registration */
   collectionId?: string,
-  /** Desired token type returned */
   tokenType?: 'bearer' | 'firebase'
 }
 ```
@@ -609,9 +602,9 @@ interface AssignClaimsRequest {
 
 ### collection
 
-**CollectionResponse** (interface)
+**Collection** (interface)
 ```typescript
-interface CollectionResponse {
+interface Collection {
   id: string
   title: string
   description: string
@@ -652,6 +645,12 @@ interface CollectionResponse {
 }
 ```
 
+**CollectionResponse** = `Collection`
+
+**CollectionCreateRequest** = `Omit<Collection, 'id' | 'shortId'>`
+
+**CollectionUpdateRequest** = `Partial<Omit<Collection, 'id' | 'shortId'>>`
+
 ### common
 
 **IdField** = `'userId' | 'contactId'`
@@ -746,12 +745,13 @@ interface SendNotificationResponse {
 ```typescript
 interface CommunicationEvent {
   orgId: string
-  sourceId?: string
+  broadcastId?: string
+  journeyId?: string
   userId?: string
   contactId?: string
   channel?: string
   timestamp: string
-  eventType?: string
+  eventType: string
   outcome?: string | null
   templateId?: string | null
   [k: string]: any
@@ -779,8 +779,9 @@ interface RecipientWithOutcome {
 **CommsRecipientIdsQuery** (interface)
 ```typescript
 interface CommsRecipientIdsQuery {
-  sourceId: string
-  idField?: 'userId' | 'contactId'
+  broadcastId?: string
+  journeyId?: string
+  idField?: IdField
   from?: string
   to?: string
   limit?: number
@@ -790,10 +791,11 @@ interface CommsRecipientIdsQuery {
 **CommsRecipientsWithoutActionQuery** (interface)
 ```typescript
 interface CommsRecipientsWithoutActionQuery {
-  sourceId: string
+  broadcastId?: string
+  journeyId?: string
   actionId?: string
   appId?: string
-  idField?: 'userId' | 'contactId'
+  idField?: IdField
   from?: string
   to?: string
   limit?: number
@@ -803,11 +805,12 @@ interface CommsRecipientsWithoutActionQuery {
 **CommsRecipientsWithActionQuery** (interface)
 ```typescript
 interface CommsRecipientsWithActionQuery {
-  sourceId: string
+  broadcastId?: string
+  journeyId?: string
   actionId?: string
   appId?: string
   outcome?: string
-  idField?: 'userId' | 'contactId'
+  idField?: IdField
   includeOutcome?: boolean
   from?: string
   to?: string
@@ -818,11 +821,12 @@ interface CommsRecipientsWithActionQuery {
 **LogCommunicationEventBody** (interface)
 ```typescript
 interface LogCommunicationEventBody {
-  sourceId: string
+  broadcastId?: string
+  journeyId?: string
   userId?: string
   contactId?: string
   channel?: string
-  eventType?: string
+  eventType: string
   outcome?: string
   templateId?: string
   timestamp?: string
@@ -833,9 +837,9 @@ interface LogCommunicationEventBody {
 **LogBulkCommunicationEventsBody** (interface)
 ```typescript
 interface LogBulkCommunicationEventsBody {
-  params: { sourceId: string; [k: string]: any }
+  params: { broadcastId?: string; journeyId?: string; [k: string]: any }
   ids: string[]
-  idField?: 'userId' | 'contactId'
+  idField?: IdField
 }
 ```
 
@@ -1058,9 +1062,9 @@ interface NfcClaimTagRequest {
 
 ### product
 
-**ProductResponse** (interface)
+**Product** (interface)
 ```typescript
-interface ProductResponse {
+interface Product {
   id: string
   name: string
   collectionId: string
@@ -1084,15 +1088,17 @@ interface ProductResponse {
 }
 ```
 
-**ProductCreateRequest** = `Omit<ProductResponse, 'id' | 'collectionId'>`
+**ProductResponse** = `Product`
 
-**ProductUpdateRequest** = `Partial<Omit<ProductResponse, 'id' | 'collectionId'>>`
+**ProductCreateRequest** = `Omit<Product, 'id' | 'collectionId'>`
+
+**ProductUpdateRequest** = `Partial<Omit<Product, 'id' | 'collectionId'>>`
 
 ### proof
 
-**ProofResponse** (interface)
+**Proof** (interface)
 ```typescript
-interface ProofResponse {
+interface Proof {
   collectionId: string
   createdAt: string
   id: string
@@ -1105,6 +1111,21 @@ interface ProofResponse {
 }
 ```
 
+**ProofCreateRequest** (interface)
+```typescript
+interface ProofCreateRequest {
+  values: Record<string, any>
+  claimable?: boolean
+  transient?: boolean
+}
+```
+
+**ProofResponse** = `Proof`
+
+**ProofUpdateRequest** = `Partial<ProofCreateRequest>`
+
+**ProofClaimRequest** = `Record<string, any>`
+
 ### segments
 
 **SegmentRecord** (interface)
@@ -1694,10 +1715,10 @@ Retrieve a specific settings group for a collection (public endpoint).
 **updateSettings**(collectionId: string, settingGroup: string, settings: any) → `Promise<any>`
 Update a specific settings group for a collection (admin endpoint).
 
-**create**(data: any) → `Promise<CollectionResponse>`
+**create**(data: CollectionCreateRequest) → `Promise<CollectionResponse>`
 Create a new collection (admin only).
 
-**update**(collectionId: string, data: any) → `Promise<CollectionResponse>`
+**update**(collectionId: string, data: CollectionUpdateRequest) → `Promise<CollectionResponse>`
 Update a collection (admin only).
 
 **remove**(collectionId: string) → `Promise<void>`
@@ -1885,19 +1906,19 @@ List all Proofs for a Collection.
 
 **create**(collectionId: string,
     productId: string,
-    values: any) → `Promise<ProofResponse>`
+    values: ProofCreateRequest) → `Promise<ProofResponse>`
 Create a proof for a product (admin only). POST /admin/collection/:collectionId/product/:productId/proof
 
 **update**(collectionId: string,
     productId: string,
     proofId: string,
-    values: any) → `Promise<ProofResponse>`
+    values: ProofUpdateRequest) → `Promise<ProofResponse>`
 Update a proof for a product (admin only). PUT /admin/collection/:collectionId/product/:productId/proof/:proofId
 
 **claim**(collectionId: string,
     productId: string,
     proofId: string,
-    values: any) → `Promise<ProofResponse>`
+    values: ProofClaimRequest) → `Promise<ProofResponse>`
 Claim a proof for a product. PUT /public/collection/:collectionId/product/:productId/proof/:proofId
 
 **remove**(collectionId: string,

package/dist/api/collection.d.ts

@@ -1,4 +1,4 @@
-import { CollectionResponse } from "../types/collection";
+import { CollectionResponse, CollectionCreateRequest, CollectionUpdateRequest } from "../types/collection";
 export declare namespace collection {
     /**
      * Retrieves a single Collection by its ID.
@@ -42,7 +42,7 @@ export declare namespace collection {
      * @returns Promise resolving to a CollectionResponse object
      * @throws ErrorResponse if the request fails
      */
-    function create(data: any): Promise<CollectionResponse>;
+    function create(data: CollectionCreateRequest): Promise<CollectionResponse>;
     /**
      * Update a collection (admin only).
      * @param collectionId – Identifier of the collection
@@ -50,7 +50,7 @@ export declare namespace collection {
      * @returns Promise resolving to a CollectionResponse object
      * @throws ErrorResponse if the request fails
      */
-    function update(collectionId: string, data: any): Promise<CollectionResponse>;
+    function update(collectionId: string, data: CollectionUpdateRequest): Promise<CollectionResponse>;
     /**
      * Delete a collection (admin only).
      * @param collectionId – Identifier of the collection

package/dist/api/proof.d.ts

@@ -1,4 +1,4 @@
-import { ProofResponse } from "../types/proof";
+import { ProofResponse, ProofCreateRequest, ProofUpdateRequest, ProofClaimRequest } from "../types/proof";
 export declare namespace proof {
     /**
      * Retrieves a single Proof by Collection ID, Product ID, and Proof ID.
@@ -13,17 +13,17 @@ export declare namespace proof {
      * Create a proof for a product (admin only).
      * POST /admin/collection/:collectionId/product/:productId/proof
      */
-    function create(collectionId: string, productId: string, values: any): Promise<ProofResponse>;
+    function create(collectionId: string, productId: string, values: ProofCreateRequest): Promise<ProofResponse>;
     /**
      * Update a proof for a product (admin only).
      * PUT /admin/collection/:collectionId/product/:productId/proof/:proofId
      */
-    function update(collectionId: string, productId: string, proofId: string, values: any): Promise<ProofResponse>;
+    function update(collectionId: string, productId: string, proofId: string, values: ProofUpdateRequest): Promise<ProofResponse>;
     /**
      * Claim a proof for a product.
      * PUT /public/collection/:collectionId/product/:productId/proof/:proofId
      */
-    function claim(collectionId: string, productId: string, proofId: string, values: any): Promise<ProofResponse>;
+    function claim(collectionId: string, productId: string, proofId: string, values: ProofClaimRequest): Promise<ProofResponse>;
     /**
      * Delete a proof for a product (admin only).
      * DELETE /admin/collection/:collectionId/product/:productId/proof/:proofId

package/dist/index.d.ts

@@ -4,9 +4,11 @@ export * from "./types";
 export { iframe } from "./iframe";
 export type { LoginResponse, VerifyTokenResponse, AccountInfoResponse, } from "./api/auth";
 export type { UserAccountRegistrationRequest, } from "./types/auth";
-export type { SendNotificationRequest, SendNotificationResponse, NotificationSubjectTarget, NotificationTemplate, PushNotificationTemplate, EmailNotificationTemplate, WalletUpdateTemplate, } from "./types/comms";
+export type { SendNotificationRequest, SendNotificationResponse, NotificationSubjectTarget, NotificationTemplate, PushNotificationTemplate, EmailNotificationTemplate, WalletUpdateTemplate, CommunicationEvent, CommsQueryByUser, CommsRecipientIdsQuery, CommsRecipientsWithoutActionQuery, CommsRecipientsWithActionQuery, RecipientId, RecipientWithOutcome, LogCommunicationEventBody, LogBulkCommunicationEventsBody, AppendResult, AppendBulkResult, } from "./types/comms";
 export type { AttestationResponse, AttestationCreateRequest, AttestationUpdateRequest, } from "./types/attestation";
 export type { BatchResponse, BatchCreateRequest, BatchUpdateRequest, } from "./types/batch";
 export type { VariantResponse, VariantCreateRequest, VariantUpdateRequest, } from "./types/variant";
 export type { AppConfigOptions } from "./api/appConfiguration";
-export type { ProductCreateRequest, ProductUpdateRequest, } from "./types/product";
+export type { ProductCreateRequest, ProductUpdateRequest, Product, } from "./types/product";
+export type { Collection, CollectionResponse, CollectionCreateRequest, CollectionUpdateRequest, } from "./types/collection";
+export type { Proof, ProofResponse, ProofCreateRequest, ProofUpdateRequest, ProofClaimRequest, } from "./types/proof";

package/dist/types/auth.d.ts

@@ -1,4 +1,4 @@
-export type UserAccountRegistrationRequest = {
+export interface UserAccountRegistrationRequest {
     /** User's display name */
     name: string;
     /** Optional user email */
@@ -13,4 +13,4 @@ export type UserAccountRegistrationRequest = {
     collectionId?: string;
     /** Desired token type returned */
     tokenType?: 'bearer' | 'firebase';
-};
+}

package/dist/types/collection.d.ts

@@ -1,7 +1,7 @@
 /**
  * Represents a Collection object.
  */
-export interface CollectionResponse {
+export interface Collection {
     /** Unique identifier for the collection */
     id: string;
     /** Human-readable title of the collection */
@@ -63,3 +63,6 @@ export interface CollectionResponse {
     /** if dark mode is enabled for this collection */
     dark?: boolean;
 }
+export type CollectionResponse = Collection;
+export type CollectionCreateRequest = Omit<Collection, 'id' | 'shortId'>;
+export type CollectionUpdateRequest = Partial<Omit<Collection, 'id' | 'shortId'>>;

package/dist/types/comms.d.ts

@@ -1,3 +1,4 @@
+import type { IdField } from './common';
 /**
  * Target subject for notifications (product, collection, etc.)
  */
@@ -106,12 +107,13 @@ export interface SendNotificationResponse {
 }
 export interface CommunicationEvent {
     orgId: string;
-    sourceId?: string;
+    broadcastId?: string;
+    journeyId?: string;
     userId?: string;
     contactId?: string;
     channel?: string;
     timestamp: string;
-    eventType?: string;
+    eventType: string;
     outcome?: string | null;
     templateId?: string | null;
     [k: string]: any;
@@ -129,38 +131,42 @@ export interface RecipientWithOutcome {
     outcome: string;
 }
 export interface CommsRecipientIdsQuery {
-    sourceId: string;
-    idField?: 'userId' | 'contactId';
+    broadcastId?: string;
+    journeyId?: string;
+    idField?: IdField;
     from?: string;
     to?: string;
     limit?: number;
 }
 export interface CommsRecipientsWithoutActionQuery {
-    sourceId: string;
+    broadcastId?: string;
+    journeyId?: string;
     actionId?: string;
     appId?: string;
-    idField?: 'userId' | 'contactId';
+    idField?: IdField;
     from?: string;
     to?: string;
     limit?: number;
 }
 export interface CommsRecipientsWithActionQuery {
-    sourceId: string;
+    broadcastId?: string;
+    journeyId?: string;
     actionId?: string;
     appId?: string;
     outcome?: string;
-    idField?: 'userId' | 'contactId';
+    idField?: IdField;
     includeOutcome?: boolean;
     from?: string;
     to?: string;
     limit?: number;
 }
 export interface LogCommunicationEventBody {
-    sourceId: string;
+    broadcastId?: string;
+    journeyId?: string;
     userId?: string;
     contactId?: string;
     channel?: string;
-    eventType?: string;
+    eventType: string;
     outcome?: string;
     templateId?: string;
     timestamp?: string;
@@ -168,11 +174,12 @@ export interface LogCommunicationEventBody {
 }
 export interface LogBulkCommunicationEventsBody {
     params: {
-        sourceId: string;
+        broadcastId?: string;
+        journeyId?: string;
         [k: string]: any;
     };
     ids: string[];
-    idField?: 'userId' | 'contactId';
+    idField?: IdField;
 }
 export interface AppendResult {
     success: true;

package/dist/types/comms.js

@@ -1,3 +1 @@
-// src/types/comms.ts
-// Communication and notification types for the Smartlinks API
 export {};

package/dist/types/product.d.ts

@@ -1,7 +1,7 @@
 /**
- * Represents a Product Item object.
+ * Product domain model.
  */
-export interface ProductResponse {
+export interface Product {
     /** Unique identifier for the product */
     id: string;
     /** Name of the product */
@@ -34,5 +34,6 @@ export interface ProductResponse {
         [key: string]: any;
     };
 }
-export type ProductCreateRequest = Omit<ProductResponse, 'id' | 'collectionId'>;
-export type ProductUpdateRequest = Partial<Omit<ProductResponse, 'id' | 'collectionId'>>;
+export type ProductResponse = Product;
+export type ProductCreateRequest = Omit<Product, 'id' | 'collectionId'>;
+export type ProductUpdateRequest = Partial<Omit<Product, 'id' | 'collectionId'>>;

package/dist/types/proof.d.ts

@@ -1,7 +1,7 @@
 /**
  * Represents a Proof object.
  */
-export interface ProofResponse {
+export interface Proof {
     /** Unique identifier for the collection */
     collectionId: string;
     /** Creation timestamp */
@@ -21,3 +21,11 @@ export interface ProofResponse {
     /** Arbitrary key-value pairs for proof values */
     values: Record<string, any>;
 }
+export type ProofResponse = Proof;
+export interface ProofCreateRequest {
+    values: Record<string, any>;
+    claimable?: boolean;
+    transient?: boolean;
+}
+export type ProofUpdateRequest = Partial<ProofCreateRequest>;
+export type ProofClaimRequest = Record<string, any>;

package/package.json

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