@proveanything/smartlinks 1.0.38 → 1.0.39

package/API_SUMMARY.md

@@ -1,6 +1,6 @@
 # Smartlinks API Summary
 
-Version: 1.0.38  |  Generated: 2025-10-04T11:16:35.687Z
+Version: 1.0.39  |  Generated: 2025-10-07T14:54:51.574Z
 
 This is a concise summary of all available API functions and types.
 
@@ -129,6 +129,38 @@ interface AttestationUpdateRequest {
 
 **BatchUpdateRequest** = `any`
 
+### claimSet
+
+**ClaimCodeRef** (interface)
+```typescript
+interface ClaimCodeRef {
+  codeId: string
+  claimId: string
+}
+```
+
+**UpdateClaimDataRequest** (interface)
+```typescript
+interface UpdateClaimDataRequest {
+  data: Record<string, any>
+  codes: ClaimCodeRef[]
+}
+```
+
+**AssignClaimsRequest** (interface)
+```typescript
+interface AssignClaimsRequest {
+  id: string
+  collectionId: string
+  productId: string
+  batchId?: string
+  start?: number
+  end?: number
+  codeId?: string
+  data?: Record<string, any>
+}
+```
+
 ### collection
 
 **CollectionResponse** (interface)
@@ -743,10 +775,10 @@ Update a claim set for a collection.
 **makeClaim**(collectionId: string, params: any) → `Promise<any>`
 Make a claim for a claim set.
 
-**assignClaims**(collectionId: string, data: any) → `Promise<any>`
-Assign claims to a claim set.
+**assignClaims**(collectionId: string, data: AssignClaimsRequest) → `Promise<any>`
+Assign claims to a claim set. { id: string,          // claim set id (required) collectionId: string,// required productId: string,   // required batchId?: string,    // optional start?: number,      // optional bulk range start end?: number,        // optional bulk range end codeId?: string,     // optional single code data?: { [k: string]: any } // optional claim key/values }
 
-**updateClaimData**(collectionId: string, data: any) → `Promise<any>`
+**updateClaimData**(collectionId: string, data: UpdateClaimDataRequest) → `Promise<any>`
 Update claim data for a collection.
 
 **getAllForCollection**(collectionId: string) → `Promise<any[]>`
@@ -779,10 +811,10 @@ Update a claim set for a collection.
 **makeClaim**(collectionId: string, params: any) → `Promise<any>`
 Make a claim for a claim set.
 
-**assignClaims**(collectionId: string, data: any) → `Promise<any>`
-Assign claims to a claim set.
+**assignClaims**(collectionId: string, data: AssignClaimsRequest) → `Promise<any>`
+Assign claims to a claim set. { id: string,          // claim set id (required) collectionId: string,// required productId: string,   // required batchId?: string,    // optional start?: number,      // optional bulk range start end?: number,        // optional bulk range end codeId?: string,     // optional single code data?: { [k: string]: any } // optional claim key/values }
 
-**updateClaimData**(collectionId: string, data: any) → `Promise<any>`
+**updateClaimData**(collectionId: string, data: UpdateClaimDataRequest) → `Promise<any>`
 Update claim data for a collection.
 
 ### collection
@@ -793,6 +825,12 @@ Retrieves a single Collection by its ID.
 **list**(admin?: boolean) → `Promise<CollectionResponse[]>`
 Retrieves all Collections.
 
+**getShortId**(shortId: string) → `Promise<CollectionResponse>`
+Retrieve a collection by its shortId (public endpoint).
+
+**getSettings**(collectionId: string, settingGroup: string) → `Promise<any>`
+Retrieve a specific settings group for a collection (public endpoint).
+
 **create**(data: any) → `Promise<CollectionResponse>`
 Create a new collection (admin only).
 
@@ -822,6 +860,12 @@ Retrieves a single Collection by its ID.
 **list**(admin?: boolean) → `Promise<CollectionResponse[]>`
 Retrieves all Collections.
 
+**getShortId**(shortId: string) → `Promise<CollectionResponse>`
+Retrieve a collection by its shortId (public endpoint).
+
+**getSettings**(collectionId: string, settingGroup: string) → `Promise<any>`
+Retrieve a specific settings group for a collection (public endpoint).
+
 **create**(data: any) → `Promise<CollectionResponse>`
 Create a new collection (admin only).
 

package/dist/api/claimSet.d.ts

@@ -1,3 +1,4 @@
+import { UpdateClaimDataRequest, AssignClaimsRequest } from "../types";
 export declare namespace claimSet {
     /**
      * Get all claim sets for a collection.
@@ -71,12 +72,22 @@ export declare namespace claimSet {
      * Assign claims to a claim set.
      * @param collectionId – The collection identifier
      * @param data – The claims data to assign
+     *  {
+     *    id: string,          // claim set id (required)
+     *    collectionId: string,// required
+     *    productId: string,   // required
+     *    batchId?: string,    // optional
+     *    start?: number,      // optional bulk range start
+     *    end?: number,        // optional bulk range end
+     *    codeId?: string,     // optional single code
+     *    data?: { [k: string]: any } // optional claim key/values
+     *  }
      */
-    function assignClaims(collectionId: string, data: any): Promise<any>;
+    function assignClaims(collectionId: string, data: AssignClaimsRequest): Promise<any>;
     /**
      * Update claim data for a collection.
      * @param collectionId – The collection identifier
      * @param data – The claim data to update
      */
-    function updateClaimData(collectionId: string, data: any): Promise<any>;
+    function updateClaimData(collectionId: string, data: UpdateClaimDataRequest): Promise<any>;
 }

package/dist/api/claimSet.js

@@ -113,6 +113,16 @@ export var claimSet;
      * Assign claims to a claim set.
      * @param collectionId – The collection identifier
      * @param data – The claims data to assign
+     *  {
+     *    id: string,          // claim set id (required)
+     *    collectionId: string,// required
+     *    productId: string,   // required
+     *    batchId?: string,    // optional
+     *    start?: number,      // optional bulk range start
+     *    end?: number,        // optional bulk range end
+     *    codeId?: string,     // optional single code
+     *    data?: { [k: string]: any } // optional claim key/values
+     *  }
      */
     async function assignClaims(collectionId, data) {
         const path = `/admin/collection/${encodeURIComponent(collectionId)}/claimSet/${encodeURIComponent(data.id)}/assignClaims`;

package/dist/api/collection.d.ts

@@ -15,6 +15,19 @@ export declare namespace collection {
      * @throws ErrorResponse if the request fails
      */
     function list(admin?: boolean): Promise<CollectionResponse[]>;
+    /**
+     * Retrieve a collection by its shortId (public endpoint).
+     * @param shortId – The short identifier of the collection
+     * @returns Promise resolving to a CollectionResponse object
+     */
+    function getShortId(shortId: string): Promise<CollectionResponse>;
+    /**
+     * Retrieve a specific settings group for a collection (public endpoint).
+     * @param collectionId – Identifier of the collection
+     * @param settingGroup – The settings group name
+     * @returns Promise resolving to the settings object
+     */
+    function getSettings(collectionId: string, settingGroup: string): Promise<any>;
     /**
      * Create a new collection (admin only).
      * @param data – Collection creation data

package/dist/api/collection.js

@@ -27,6 +27,27 @@ export var collection;
         return request(path);
     }
     collection.list = list;
+    /**
+     * Retrieve a collection by its shortId (public endpoint).
+     * @param shortId – The short identifier of the collection
+     * @returns Promise resolving to a CollectionResponse object
+     */
+    async function getShortId(shortId) {
+        const path = `/public/collection/getShortId/${encodeURIComponent(shortId)}`;
+        return request(path);
+    }
+    collection.getShortId = getShortId;
+    /**
+     * Retrieve a specific settings group for a collection (public endpoint).
+     * @param collectionId – Identifier of the collection
+     * @param settingGroup – The settings group name
+     * @returns Promise resolving to the settings object
+     */
+    async function getSettings(collectionId, settingGroup) {
+        const path = `/public/collection/${encodeURIComponent(collectionId)}/settings/${encodeURIComponent(settingGroup)}`;
+        return request(path);
+    }
+    collection.getSettings = getSettings;
     /**
      * Create a new collection (admin only).
      * @param data – Collection creation data

package/dist/types/claimSet.d.ts

@@ -0,0 +1,40 @@
+/**
+ * Reference to a specific claim attached to a code/tag.
+ */
+export interface ClaimCodeRef {
+    /** Identifier of the code (e.g., tag or QR code) */
+    codeId: string;
+    /** Identifier of the claim within the claim set */
+    claimId: string;
+}
+/**
+ * Request body for updating claim data on a claim set.
+ * Contains arbitrary key/value pairs and a list of code+claim references to update.
+ */
+export interface UpdateClaimDataRequest {
+    /** Arbitrary key/value pairs for the claim data update */
+    data: Record<string, any>;
+    /** Array of code+claim references affected by this update */
+    codes: ClaimCodeRef[];
+}
+/**
+ * Request body for assigning claims to codes or ranges within a collection.
+ */
+export interface AssignClaimsRequest {
+    /** The claim set ID (required) */
+    id: string;
+    /** The collection ID (required) */
+    collectionId: string;
+    /** The product ID (required) */
+    productId: string;
+    /** Optional batch identifier */
+    batchId?: string;
+    /** Optional start index for bulk assignment */
+    start?: number;
+    /** Optional end index for bulk assignment */
+    end?: number;
+    /** Optional single code identifier for single assignment */
+    codeId?: string;
+    /** Optional key/value pairs to set on the claim */
+    data?: Record<string, any>;
+}

package/dist/types/claimSet.js

@@ -0,0 +1 @@
+export {};

package/dist/types/index.d.ts

@@ -6,3 +6,4 @@ export * from "./error";
 export * from "./asset";
 export * from "./batch";
 export * from "./variant";
+export * from "./claimSet";

package/dist/types/index.js

@@ -8,3 +8,4 @@ export * from "./error";
 export * from "./asset";
 export * from "./batch";
 export * from "./variant";
+export * from "./claimSet";

package/package.json

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