@proveanything/smartlinks 1.0.37 → 1.0.39

package/API_SUMMARY.md

@@ -1,6 +1,6 @@
 # Smartlinks API Summary
 
-Version: 1.0.37  |  Generated: 2025-09-17T14:45:53.635Z
+Version: 1.0.39  |  Generated: 2025-10-07T14:54:51.574Z
 
 This is a concise summary of all available API functions and types.
 
@@ -8,6 +8,7 @@ This is a concise summary of all available API functions and types.
 
 The Smartlinks SDK is organized into the following namespaces:
 
+- **ai** - Functions for ai operations
 - **appConfiguration** - Application configuration and settings management
 - **appRecord** - Functions for appRecord operations
 - **asset** - File upload and asset management for collections, products, and proofs
@@ -128,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)
@@ -202,7 +235,7 @@ interface ProductResponse {
   x512: string
   }
   }
-  groupTags: {
+  tags: {
   [tagName: string]: boolean
   }
   data: {
@@ -238,6 +271,52 @@ interface ProofResponse {
 
 **VariantUpdateRequest** = `any`
 
+### ai
+
+**AIGenerateContentRequest** (interface)
+```typescript
+interface AIGenerateContentRequest {
+  contents: string | any
+  responseMimeType?: string
+  systemInstruction?: string
+  provider?: string
+  model?: string
+  [key: string]: any
+}
+```
+
+**AIGenerateImageRequest** (interface)
+```typescript
+interface AIGenerateImageRequest {
+  prompt: string
+  provider?: string
+  model?: string
+  size?: string
+  [key: string]: any
+}
+```
+
+**AISearchPhotosRequest** (interface)
+```typescript
+interface AISearchPhotosRequest {
+  query: string
+  per_page?: number
+  orientation?: 'landscape' | 'portrait' | 'squarish'
+  [key: string]: any
+}
+```
+
+**AISearchPhotosPhoto** (interface)
+```typescript
+interface AISearchPhotosPhoto {
+  url: string
+  alt?: string
+  photographer?: string
+  photographerUrl?: string
+  [key: string]: any
+}
+```
+
 **AppConfigOptions** = `{
   appId: string
   collectionId?: string
@@ -306,6 +385,50 @@ interface ProofResponse {
 
 ## API Functions
 
+### ai
+
+**generateContent**(collectionId: string,
+    params: AIGenerateContentRequest,
+    admin: boolean = true) → `Promise<any>`
+Generate text/content via AI (admin)
+
+**generateImage**(collectionId: string, params: AIGenerateImageRequest) → `Promise<any>`
+Generate an image via AI (admin)
+
+**searchPhotos**(collectionId: string,
+    params: AISearchPhotosRequest) → `Promise<AISearchPhotosPhoto[]>`
+Search stock photos or similar via AI (admin)
+
+**uploadFile**(collectionId: string, params: any) → `Promise<any>`
+Upload a file for AI usage (admin). Pass FormData for binary uploads.
+
+**createCache**(collectionId: string, params: any) → `Promise<any>`
+Create or warm a cache for AI (admin)
+
+**postChat**(collectionId: string, params: any, admin: boolean = true) → `Promise<any>`
+Post a chat message to the AI (admin or public)
+
+**generateContent**(collectionId: string,
+    params: AIGenerateContentRequest,
+    admin: boolean = true) → `Promise<any>`
+Generate text/content via AI (admin)
+
+**generateImage**(collectionId: string, params: AIGenerateImageRequest) → `Promise<any>`
+Generate an image via AI (admin)
+
+**searchPhotos**(collectionId: string,
+    params: AISearchPhotosRequest) → `Promise<AISearchPhotosPhoto[]>`
+Search stock photos or similar via AI (admin)
+
+**uploadFile**(collectionId: string, params: any) → `Promise<any>`
+Upload a file for AI usage (admin). Pass FormData for binary uploads.
+
+**createCache**(collectionId: string, params: any) → `Promise<any>`
+Create or warm a cache for AI (admin)
+
+**postChat**(collectionId: string, params: any, admin: boolean = true) → `Promise<any>`
+Post a chat message to the AI (admin or public)
+
 ### appConfiguration
 
 **getConfig**(opts: AppConfigOptions) → `Promise<any>`
@@ -652,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[]>`
@@ -688,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
@@ -702,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).
 
@@ -731,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/ai.d.ts

@@ -0,0 +1,74 @@
+export interface AIGenerateContentRequest {
+    /** The prompt or message contents sent to the AI */
+    contents: string | any;
+    /** Desired MIME type of the response payload (e.g. 'application/json', 'text/plain') */
+    responseMimeType?: string;
+    /** Optional system instruction or system prompt to steer the model */
+    systemInstruction?: string;
+    /** AI provider identifier (e.g. 'openai', 'google', 'anthropic') */
+    provider?: string;
+    /** The model name to use (e.g. 'gpt-4o', 'gemini-1.5-pro') */
+    model?: string;
+    /** Allow passing additional provider/model-specific options */
+    [key: string]: any;
+}
+export interface AIGenerateImageRequest {
+    /** Text prompt describing the desired image */
+    prompt: string;
+    /** AI provider identifier (e.g. 'openai', 'google', 'stability') */
+    provider?: string;
+    /** Optional model name to use for image generation */
+    model?: string;
+    /** Requested image size, e.g. '1024x1024' */
+    size?: string;
+    /** Additional provider/model-specific options */
+    [key: string]: any;
+}
+export interface AISearchPhotosRequest {
+    /** Search query keyword(s) */
+    query: string;
+    /** Number of results to return per page (e.g. 1) */
+    per_page?: number;
+    /** Desired orientation of photos */
+    orientation?: 'landscape' | 'portrait' | 'squarish';
+    /** Additional provider-specific options */
+    [key: string]: any;
+}
+export interface AISearchPhotosPhoto {
+    /** Direct image URL */
+    url: string;
+    /** Alt text/description for accessibility */
+    alt?: string;
+    /** Photographer display name */
+    photographer?: string;
+    /** Link to the photographer profile */
+    photographerUrl?: string;
+    /** Allow extra fields */
+    [key: string]: any;
+}
+export declare namespace ai {
+    /**
+     * Generate text/content via AI (admin)
+     */
+    function generateContent(collectionId: string, params: AIGenerateContentRequest, admin?: boolean): Promise<any>;
+    /**
+     * Generate an image via AI (admin)
+     */
+    function generateImage(collectionId: string, params: AIGenerateImageRequest): Promise<any>;
+    /**
+     * Search stock photos or similar via AI (admin)
+     */
+    function searchPhotos(collectionId: string, params: AISearchPhotosRequest): Promise<AISearchPhotosPhoto[]>;
+    /**
+     * Upload a file for AI usage (admin). Pass FormData for binary uploads.
+     */
+    function uploadFile(collectionId: string, params: any): Promise<any>;
+    /**
+     * Create or warm a cache for AI (admin)
+     */
+    function createCache(collectionId: string, params: any): Promise<any>;
+    /**
+     * Post a chat message to the AI (admin or public)
+     */
+    function postChat(collectionId: string, params: any, admin?: boolean): Promise<any>;
+}

package/dist/api/ai.js

@@ -0,0 +1,56 @@
+// src/api/ai.ts
+// AI endpoints: public and admin helpers
+import { post } from "../http";
+export var ai;
+(function (ai) {
+    /**
+     * Generate text/content via AI (admin)
+     */
+    async function generateContent(collectionId, params, admin = true) {
+        const base = admin ? '/admin' : '/public';
+        const path = `${base}/collection/${encodeURIComponent(collectionId)}/ai/generateContent`;
+        return post(path, params);
+    }
+    ai.generateContent = generateContent;
+    /**
+     * Generate an image via AI (admin)
+     */
+    async function generateImage(collectionId, params) {
+        const path = `/admin/collection/${encodeURIComponent(collectionId)}/ai/generateImage`;
+        return post(path, params);
+    }
+    ai.generateImage = generateImage;
+    /**
+     * Search stock photos or similar via AI (admin)
+     */
+    async function searchPhotos(collectionId, params) {
+        const path = `/admin/collection/${encodeURIComponent(collectionId)}/ai/searchPhotos`;
+        return post(path, params);
+    }
+    ai.searchPhotos = searchPhotos;
+    /**
+     * Upload a file for AI usage (admin). Pass FormData for binary uploads.
+     */
+    async function uploadFile(collectionId, params) {
+        const path = `/admin/collection/${encodeURIComponent(collectionId)}/ai/uploadFile`;
+        return post(path, params);
+    }
+    ai.uploadFile = uploadFile;
+    /**
+     * Create or warm a cache for AI (admin)
+     */
+    async function createCache(collectionId, params) {
+        const path = `/admin/collection/${encodeURIComponent(collectionId)}/ai/createCache`;
+        return post(path, params);
+    }
+    ai.createCache = createCache;
+    /**
+     * Post a chat message to the AI (admin or public)
+     */
+    async function postChat(collectionId, params, admin = true) {
+        const base = admin ? '/admin' : '/public';
+        const path = `${base}/collection/${encodeURIComponent(collectionId)}/ai/postChat`;
+        return post(path, params);
+    }
+    ai.postChat = postChat;
+})(ai || (ai = {}));

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/api/index.d.ts

@@ -11,3 +11,5 @@ export { claimSet } from "./claimSet";
 export { crate } from "./crate";
 export { batch } from "./batch";
 export { variant } from "./variant";
+export { ai } from "./ai";
+export type { AIGenerateContentRequest, AIGenerateImageRequest, AISearchPhotosRequest, AISearchPhotosPhoto } from "./ai";

package/dist/api/index.js

@@ -13,3 +13,4 @@ export { claimSet } from "./claimSet";
 export { crate } from "./crate";
 export { batch } from "./batch";
 export { variant } from "./variant";
+export { ai } from "./ai";

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/dist/types/product.d.ts

@@ -26,7 +26,7 @@ export interface ProductResponse {
         };
     };
     /** Flexible map of tags with true/false values */
-    groupTags: {
+    tags: {
         [tagName: string]: boolean;
     };
     /** Flexible key/value data map */

package/package.json

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