@proveanything/smartlinks 1.0.29 → 1.0.31

package/API_SUMMARY.md

@@ -2,6 +2,67 @@
 
 This is a concise summary of all available API functions and types.
 
+## API Namespaces
+
+The Smartlinks SDK is organized into the following namespaces:
+
+- **appConfiguration** - Application configuration and settings management
+- **appRecord** - Functions for appRecord operations
+- **asset** - File upload and asset management for collections, products, and proofs
+- **attestation** - Digital attestations and verification for products
+- **auth** - Authentication, login, and user account management
+- **batch** - Product batch management and tracking
+- **claimSet** - Claim creation, management, and verification
+- **collection** - Collection CRUD operations and management
+- **crate** - Container/crate management for organizing products
+- **form** - Dynamic form creation and submission
+- **product** - Product CRUD operations and management within collections
+- **proof** - Product proof retrieval and validation
+- **serialNumber** - Functions for serialNumber operations
+- **variant** - Product variant management and tracking
+
+## HTTP Utilities
+
+Core HTTP functions for API configuration and communication:
+
+**initializeApi**(options: {
+  baseURL: string
+  apiKey?: string
+  bearerToken?: string
+  proxyMode?: boolean
+}) → `void`
+Call this once (e.g. at app startup) to configure baseURL/auth.
+
+**setBearerToken**(token: string | undefined) → `void`
+Allows setting the bearerToken at runtime (e.g. after login/logout).
+
+**request**(path: string) → `Promise<T>`
+Internal helper that performs a GET request to \`\${baseURL}\${path}\`, injecting headers for apiKey or bearerToken if present. Returns the parsed JSON as T, or throws an Error.
+
+**post**(path: string,
+  body: any,
+  extraHeaders?: Record<string, string>) → `Promise<T>`
+Internal helper that performs a POST request to `${baseURL}${path}`, injecting headers for apiKey or bearerToken if present. If body is FormData, Content-Type is not set. Returns the parsed JSON as T, or throws an Error.
+
+**put**(path: string,
+  body: any,
+  extraHeaders?: Record<string, string>) → `Promise<T>`
+Internal helper that performs a PUT request to `${baseURL}${path}`, injecting headers for apiKey or bearerToken if present. If body is FormData, Content-Type is not set. Returns the parsed JSON as T, or throws an Error.
+
+**requestWithOptions**(path: string,
+  options: RequestInit) → `Promise<T>`
+Internal helper that performs a request to `${baseURL}${path}` with custom options, injecting headers for apiKey or bearerToken if present. Returns the parsed JSON as T, or throws an Error.
+
+**del**(path: string,
+  extraHeaders?: Record<string, string>) → `Promise<T>`
+Internal helper that performs a DELETE request to `${baseURL}${path}`, injecting headers for apiKey or bearerToken if present. Returns the parsed JSON as T, or throws an Error.
+
+**getApiHeaders**() → `Record<string, string>`
+Returns the common headers used for API requests, including apiKey and bearerToken if set.
+
+**sendCustomProxyMessage**(request: string, params: any) → `Promise<T>`
+Sends a custom proxy message to the parent Smartlinks application when running in an iframe. This function is used to communicate with the parent window when the SDK is embedded in an iframe and proxyMode is enabled. It sends a message to the parent and waits for a response.
+
 ## Types
 
 ### appConfiguration
@@ -9,9 +70,9 @@ This is a concise summary of all available API functions and types.
 **AppConfigurationResponse** (interface)
 ```typescript
 interface AppConfigurationResponse {
-  id: string;
-  name: string;
-  settings?: Record<string, any>;
+  id: string
+  name: string
+  settings?: Record<string, any>
 }
 ```
 
@@ -20,9 +81,9 @@ interface AppConfigurationResponse {
 **AssetResponse** (interface)
 ```typescript
 interface AssetResponse {
-  id: string;
-  name: string;
-  url: string;
+  id: string
+  name: string
+  url: string
 }
 ```
 
@@ -31,29 +92,29 @@ interface AssetResponse {
 **AttestationResponse** (interface)
 ```typescript
 interface AttestationResponse {
-  id: string;
-  createdAt: string;
-  updatedAt: string;
-  public: Record<string, any>;
-  private: Record<string, any>;
-  proof: Record<string, any>;
+  id: string
+  createdAt: string
+  updatedAt: string
+  public: Record<string, any>
+  private: Record<string, any>
+  proof: Record<string, any>
 }
 ```
 
 **AttestationCreateRequest** (interface)
 ```typescript
 interface AttestationCreateRequest {
-  public: Record<string, any>;
-  private: Record<string, any>;
-  proof: Record<string, any>;
+  public: Record<string, any>
+  private: Record<string, any>
+  proof: Record<string, any>
 }
 ```
 
 **AttestationUpdateRequest** (interface)
 ```typescript
 interface AttestationUpdateRequest {
-  type?: string;
-  data?: Record<string, any>;
+  type?: string
+  data?: Record<string, any>
 }
 ```
 
@@ -70,42 +131,43 @@ interface AttestationUpdateRequest {
 **CollectionResponse** (interface)
 ```typescript
 interface CollectionResponse {
-  id: string;
-  title: string;
-  description: string;
+  id: string
+  title: string
+  description: string
   headerImage?: {
-    url: string;
-    thumbnails: {
-      x100: string;
-      x200: string;
-      x512: string;
-    };
-  };
+  url: string
+  thumbnails: {
+  x100: string
+  x200: string
+  x512: string
+  }
+  }
   logoImage?: {
-    url: string;
-    thumbnails: {
-      x100: string;
-      x200: string;
-      x512: string;
-    };
-  };
+  url: string
+  thumbnails: {
+  x100: string
+  x200: string
+  x512: string
+  }
+  }
   loaderImage?: {
-    overwriteName: string;
-    name: string;
-    type: string;
-    url: string;
-  };
+  overwriteName: string
+  name: string
+  type: string
+  url: string
+  }
   languages?: {
-    code: string;
-    lang: string;
-    supported: boolean;
-  };
+  code: string
+  lang: string
+  supported: boolean
+  }[],
   roles: {
-  };
-  groupTags?: string[];
-  redirectUrl?: string;
-  shortId: string;
-  dark?: boolean;
+  [userId: string]: string
+  }
+  groupTags?: string[]
+  redirectUrl?: string
+  shortId: string,
+  dark?: boolean
 }
 ```
 
@@ -114,8 +176,8 @@ interface CollectionResponse {
 **ErrorResponse** (interface)
 ```typescript
 interface ErrorResponse {
-  code: number;
-  message: string;
+  code: number
+  message: string
 }
 ```
 
@@ -124,22 +186,24 @@ interface ErrorResponse {
 **ProductResponse** (interface)
 ```typescript
 interface ProductResponse {
-  id: string;
-  name: string;
-  collectionId: string;
-  description: string;
+  id: string
+  name: string
+  collectionId: string
+  description: string
   heroImage: {
-    url: string;
-    thumbnails: {
-      x100: string;
-      x200: string;
-      x512: string;
-    };
-  };
+  url: string
+  thumbnails: {
+  x100: string
+  x200: string
+  x512: string
+  }
+  }
   groupTags: {
-  };
+  [tagName: string]: boolean
+  }
   data: {
-  };
+  [key: string]: any
+  }
 }
 ```
 
@@ -148,13 +212,13 @@ interface ProductResponse {
 **ProofResponse** (interface)
 ```typescript
 interface ProofResponse {
-  collectionId: string;
-  createdAt: string;
-  id: string;
-  productId: string;
-  tokenId: string;
-  userId: string;
-  values: Record<string, any>;
+  collectionId: string
+  createdAt: string
+  id: string
+  productId: string
+  tokenId: string
+  userId: string
+  values: Record<string, any>
 }
 ```
 
@@ -166,247 +230,741 @@ interface ProofResponse {
 
 **VariantUpdateRequest** = `any`
 
+**AppConfigOptions** = `{
+  appId: string
+  collectionId?: string
+  productId?: string
+  variantId?: string
+  batchId?: string
+  itemId?: string
+  user?: boolean
+  userData?: boolean
+  admin?: boolean
+  config?: any
+  data?: any
+}`
+
+### auth
+
+**LoginResponse** = `{
+  id: string
+  name: string
+  email: string
+  bearerToken: string
+  account: Record<string, any>
+}`
+
+**VerifyTokenResponse** = `{
+  valid: boolean
+  id?: string
+  name?: string
+  email?: string
+  account?: Record<string, any>
+}`
+
+**AccountInfoResponse** = `{
+  jwtToken: string;
+  jwtExpiry: number;
+  accessType: string;
+  analyticsCode: string;
+  analyticsId: string;
+  auth_time: number;
+  baseCollectionId: string;
+  clientType: string;
+  email: string;
+  email_verified: boolean;
+  features: {
+    actionLogger: boolean;
+    adminCollections: boolean;
+    adminApps: boolean;
+    apiKeys: boolean;
+    adminUsers: boolean;
+    [key: string]: boolean;
+  };
+  iat: number;
+  id: string;
+  iss: string;
+  location: string | null;
+  name: string;
+  picture: string;
+  sites: {
+    [siteName: string]: boolean;
+  };
+  sub: string;
+  uid: string;
+  user_id: string;
+  whitelabel: {
+    [key: string]: any;
+  }
+}`
+
 ## API Functions
 
 ### appConfiguration
 
-**getConfig**(opts: AppConfigOptions) → `any`
+**getConfig**(opts: AppConfigOptions) → `Promise<any>`
+
+**setConfig**(opts: AppConfigOptions) → `Promise<any>`
+
+**deleteConfig**(opts: AppConfigOptions) → `Promise<void>`
+
+**getData**(opts: AppConfigOptions) → `Promise<any[]>`
+
+**getDataItem**(opts: AppConfigOptions) → `Promise<any>`
+
+**setDataItem**(opts: AppConfigOptions) → `Promise<any>`
+
+**deleteDataItem**(opts: AppConfigOptions) → `Promise<void>`
+
+**getConfig**(opts: AppConfigOptions) → `Promise<any>`
+
+**setConfig**(opts: AppConfigOptions) → `Promise<any>`
+
+**deleteConfig**(opts: AppConfigOptions) → `Promise<void>`
+
+**getData**(opts: AppConfigOptions) → `Promise<any[]>`
+
+**getDataItem**(opts: AppConfigOptions) → `Promise<any>`
+
+**setDataItem**(opts: AppConfigOptions) → `Promise<any>`
+
+**deleteDataItem**(opts: AppConfigOptions) → `Promise<void>`
 
-**setConfig**(opts: AppConfigOptions) → `any`
+### appRecord
 
-**deleteConfig**(opts: AppConfigOptions) → `void`
+**get**(collectionId: string, appId: string) → `Promise<any>`
 
-**getData**(opts: AppConfigOptions) → `any[]`
+**create**(collectionId: string, appId: string, data: any) → `Promise<any>`
 
-**getDataItem**(opts: AppConfigOptions) → `any`
+**update**(collectionId: string, appId: string, data: any) → `Promise<any>`
 
-**setDataItem**(opts: AppConfigOptions) → `any`
+**remove**(collectionId: string, appId: string) → `Promise<void>`
 
-**deleteDataItem**(opts: AppConfigOptions) → `void`
+**get**(collectionId: string, appId: string) → `Promise<any>`
+
+**create**(collectionId: string, appId: string, data: any) → `Promise<any>`
+
+**update**(collectionId: string, appId: string, data: any) → `Promise<any>`
+
+**remove**(collectionId: string, appId: string) → `Promise<void>`
 
 ### asset
 
-**getForCollection**(collectionId: string, assetId: string) → `AssetResponse`
+**getForCollection**(collectionId: string,
+    assetId: string) → `Promise<AssetResponse>`
 
-**listForCollection**(collectionId: string) → `AssetResponse[]`
+**listForCollection**(collectionId: string) → `Promise<AssetResponse[]>`
 
-**getForProduct**(collectionId: string, productId: string, assetId: string) → `AssetResponse`
+**getForProduct**(collectionId: string,
+    productId: string,
+    assetId: string) → `Promise<AssetResponse>`
 
-**listForProduct**(collectionId: string, productId: string) → `AssetResponse[]`
+**listForProduct**(collectionId: string,
+    productId: string) → `Promise<AssetResponse[]>`
 
-**getForProof**(collectionId: string, productId: string, proofId: string, assetId: string) → `AssetResponse`
+**getForProof**(collectionId: string,
+    productId: string,
+    proofId: string,
+    assetId: string) → `Promise<AssetResponse>`
 
-**listForProof**(collectionId: string, productId: string, proofId: string, appId?: string) → `AssetResponse[]`
+**listForProof**(collectionId: string,
+    productId: string,
+    proofId: string,
+    appId?: string) → `Promise<AssetResponse[]>`
 
-**uploadAsset**(collectionId: string, productId: string, proofId: string, file: File, extraData?: Record<string, any>, onProgress?: (percent: number) => void) → `AssetResponse`
-Uploads an asset file to a proof, with optional extraData as JSON. Supports progress reporting via onProgress callback (browser only). @param collectionId - The collection ID @param productId - The product ID @param proofId - The proof ID @param file - The file to upload @param extraData - Arbitrary extra data to include (will be stringified as JSON) @param onProgress - Optional callback for upload progress (0-100) @returns Promise resolving to an AssetResponse object
+**uploadAsset**(collectionId: string,
+    productId: string,
+    proofId: string,
+    file: File,
+    extraData?: Record<string, any>,
+    onProgress?: (percent: number) → `void`
+Uploads an asset file to a proof, with optional extraData as JSON. Supports progress reporting via onProgress callback (browser only).
 
-### attestation
+**getForCollection**(collectionId: string,
+    assetId: string) → `Promise<AssetResponse>`
 
-**list**(collectionId: string, productId: string, proofId: string) → `AttestationResponse[]`
-List all attestations for a proof.
+**listForCollection**(collectionId: string) → `Promise<AssetResponse[]>`
 
-**get**(collectionId: string, productId: string, proofId: string, attestationId: string) → `AttestationResponse`
-List all attestations for a proof.
+**getForProduct**(collectionId: string,
+    productId: string,
+    assetId: string) → `Promise<AssetResponse>`
 
-**create**(collectionId: string, productId: string, proofId: string, data: AttestationCreateRequest) → `AttestationResponse`
-List all attestations for a proof.
+**listForProduct**(collectionId: string,
+    productId: string) → `Promise<AssetResponse[]>`
+
+**getForProof**(collectionId: string,
+    productId: string,
+    proofId: string,
+    assetId: string) → `Promise<AssetResponse>`
+
+**listForProof**(collectionId: string,
+    productId: string,
+    proofId: string,
+    appId?: string) → `Promise<AssetResponse[]>`
 
-**update**(collectionId: string, productId: string, proofId: string, attestationId: string, data: AttestationUpdateRequest) → `AttestationResponse`
+**uploadAsset**(collectionId: string,
+    productId: string,
+    proofId: string,
+    file: File,
+    extraData?: Record<string, any>,
+    onProgress?: (percent: number) → `void`
+Uploads an asset file to a proof, with optional extraData as JSON. Supports progress reporting via onProgress callback (browser only).
+
+### attestation
+
+**list**(collectionId: string,
+    productId: string,
+    proofId: string) → `Promise<AttestationResponse[]>`
 List all attestations for a proof.
 
-**remove**(collectionId: string, productId: string, proofId: string, attestationId: string) → `void`
+**get**(collectionId: string,
+    productId: string,
+    proofId: string,
+    attestationId: string) → `Promise<AttestationResponse>`
+Get a single attestation by ID.
+
+**create**(collectionId: string,
+    productId: string,
+    proofId: string,
+    data: AttestationCreateRequest) → `Promise<AttestationResponse>`
+Create a new attestation for a proof.
+
+**update**(collectionId: string,
+    productId: string,
+    proofId: string,
+    attestationId: string,
+    data: AttestationUpdateRequest) → `Promise<AttestationResponse>`
+Update an attestation.
+
+**remove**(collectionId: string,
+    productId: string,
+    proofId: string,
+    attestationId: string) → `Promise<void>`
+Delete an attestation.
+
+**list**(collectionId: string,
+    productId: string,
+    proofId: string) → `Promise<AttestationResponse[]>`
 List all attestations for a proof.
 
+**get**(collectionId: string,
+    productId: string,
+    proofId: string,
+    attestationId: string) → `Promise<AttestationResponse>`
+Get a single attestation by ID.
+
+**create**(collectionId: string,
+    productId: string,
+    proofId: string,
+    data: AttestationCreateRequest) → `Promise<AttestationResponse>`
+Create a new attestation for a proof.
+
+**update**(collectionId: string,
+    productId: string,
+    proofId: string,
+    attestationId: string,
+    data: AttestationUpdateRequest) → `Promise<AttestationResponse>`
+Update an attestation.
+
+**remove**(collectionId: string,
+    productId: string,
+    proofId: string,
+    attestationId: string) → `Promise<void>`
+Delete an attestation.
+
 ### auth
 
-**login**(email: string, password: string) → `LoginResponse`
+**login**(email: string, password: string) → `Promise<LoginResponse>`
 Login with email and password. Sets the bearerToken for subsequent API calls.
 
-**verifyToken**(token?: string) → `VerifyTokenResponse`
-Login with email and password. Sets the bearerToken for subsequent API calls.
+**logout**() → `void`
+Logout (clears bearerToken for future API calls).
+
+**verifyToken**(token?: string) → `Promise<VerifyTokenResponse>`
+Verifies the current bearerToken (or a provided token). Returns user/account info if valid.
+
+**requestAdminJWT**(collectionId: string) → `Promise<VerifyTokenResponse>`
+Requests an admin JWT for the current user and a specific collection Returns JWT if valid.
+
+**requestPublicJWT**(collectionId: string, productId: string, proofId: string) → `Promise<VerifyTokenResponse>`
+Requests a JWT for the current user and a specific collection/product/proof Validates if the user has access to the resource, and returns a JWT
 
-**getAccount**() → `AccountInfoResponse`
+**getAccount**() → `Promise<AccountInfoResponse>`
+Gets current account information for the logged in user. Returns user, owner, account, and location objects.
+
+**login**(email: string, password: string) → `Promise<LoginResponse>`
 Login with email and password. Sets the bearerToken for subsequent API calls.
 
+**logout**() → `void`
+Logout (clears bearerToken for future API calls).
+
+**verifyToken**(token?: string) → `Promise<VerifyTokenResponse>`
+Verifies the current bearerToken (or a provided token). Returns user/account info if valid.
+
+**requestAdminJWT**(collectionId: string) → `Promise<VerifyTokenResponse>`
+Requests an admin JWT for the current user and a specific collection Returns JWT if valid.
+
+**requestPublicJWT**(collectionId: string, productId: string, proofId: string) → `Promise<VerifyTokenResponse>`
+Requests a JWT for the current user and a specific collection/product/proof Validates if the user has access to the resource, and returns a JWT
+
+**getAccount**() → `Promise<AccountInfoResponse>`
+Gets current account information for the logged in user. Returns user, owner, account, and location objects.
+
 ### batch
 
-**get**(collectionId: string, productId: string, batchId: string) → `BatchResponse`
-Get a single batch by ID for a collection and product (admin only). @param collectionId - Identifier of the parent collection @param productId - Identifier of the parent product @param batchId - Identifier of the batch @returns Promise resolving to a BatchResponse object @throws ErrorResponse if the request fails
+**get**(collectionId: string,
+    productId: string,
+    batchId: string) → `Promise<BatchResponse>`
+Get a single batch by ID for a collection and product (admin only).
+
+**list**(collectionId: string,
+    productId: string) → `Promise<BatchResponse[]>`
+List all batches for a collection and product (admin only).
+
+**create**(collectionId: string,
+    productId: string,
+    data: BatchCreateRequest) → `Promise<BatchResponse>`
+Create a new batch for a collection and product (admin only).
+
+**update**(collectionId: string,
+    productId: string,
+    batchId: string,
+    data: BatchUpdateRequest) → `Promise<BatchResponse>`
+Update a batch for a collection and product (admin only).
+
+**remove**(collectionId: string,
+    productId: string,
+    batchId: string) → `Promise<void>`
+Delete a batch for a collection and product (admin only).
+
+**getPublic**(collectionId: string,
+    productId: string,
+    batchId: string) → `Promise<BatchResponse>`
+Get a single batch by ID for a collection and product (public endpoint).
+
+**getSN**(collectionId: string,
+    productId: string,
+    batchId: string,
+    startIndex: number = 0,
+    count: number = 10) → `Promise<any>`
+Get serial numbers for a batch (admin only).
+
+**lookupSN**(collectionId: string,
+    productId: string,
+    batchId: string,
+    codeId: string) → `Promise<any>`
+Look up a serial number by code for a batch (admin only).
+
+**get**(collectionId: string,
+    productId: string,
+    batchId: string) → `Promise<BatchResponse>`
+Get a single batch by ID for a collection and product (admin only).
+
+**list**(collectionId: string,
+    productId: string) → `Promise<BatchResponse[]>`
+List all batches for a collection and product (admin only).
+
+**create**(collectionId: string,
+    productId: string,
+    data: BatchCreateRequest) → `Promise<BatchResponse>`
+Create a new batch for a collection and product (admin only).
+
+**update**(collectionId: string,
+    productId: string,
+    batchId: string,
+    data: BatchUpdateRequest) → `Promise<BatchResponse>`
+Update a batch for a collection and product (admin only).
+
+**remove**(collectionId: string,
+    productId: string,
+    batchId: string) → `Promise<void>`
+Delete a batch for a collection and product (admin only).
+
+**getPublic**(collectionId: string,
+    productId: string,
+    batchId: string) → `Promise<BatchResponse>`
+Get a single batch by ID for a collection and product (public endpoint).
+
+**getSN**(collectionId: string,
+    productId: string,
+    batchId: string,
+    startIndex: number = 0,
+    count: number = 10) → `Promise<any>`
+Get serial numbers for a batch (admin only).
+
+**lookupSN**(collectionId: string,
+    productId: string,
+    batchId: string,
+    codeId: string) → `Promise<any>`
+Look up a serial number by code for a batch (admin only).
+
+### claimSet
 
-**list**(collectionId: string, productId: string) → `BatchResponse[]`
-Get a single batch by ID for a collection and product (admin only). @param collectionId - Identifier of the parent collection @param productId - Identifier of the parent product @param batchId - Identifier of the batch @returns Promise resolving to a BatchResponse object @throws ErrorResponse if the request fails
+**getAllForCollection**(collectionId: string) → `Promise<any[]>`
+Get all claim sets for a collection.
 
-**create**(collectionId: string, productId: string, data: BatchCreateRequest) → `BatchResponse`
-Get a single batch by ID for a collection and product (admin only). @param collectionId - Identifier of the parent collection @param productId - Identifier of the parent product @param batchId - Identifier of the batch @returns Promise resolving to a BatchResponse object @throws ErrorResponse if the request fails
+**getForCollection**(collectionId: string, claimSetId: string) → `Promise<any>`
+Get a specific claim set for a collection.
 
-**update**(collectionId: string, productId: string, batchId: string, data: BatchUpdateRequest) → `BatchResponse`
-Get a single batch by ID for a collection and product (admin only). @param collectionId - Identifier of the parent collection @param productId - Identifier of the parent product @param batchId - Identifier of the batch @returns Promise resolving to a BatchResponse object @throws ErrorResponse if the request fails
+**getAllTags**(collectionId: string, claimSetId: string) → `Promise<any[]>`
+Get all tags for a claim set.
 
-**remove**(collectionId: string, productId: string, batchId: string) → `void`
-Get a single batch by ID for a collection and product (admin only). @param collectionId - Identifier of the parent collection @param productId - Identifier of the parent product @param batchId - Identifier of the batch @returns Promise resolving to a BatchResponse object @throws ErrorResponse if the request fails
+**getReport**(collectionId: string, claimSetId: string) → `Promise<any>`
+Get a report for a claim set.
 
-**getPublic**(collectionId: string, productId: string, batchId: string) → `BatchResponse`
-Get a single batch by ID for a collection and product (admin only). @param collectionId - Identifier of the parent collection @param productId - Identifier of the parent product @param batchId - Identifier of the batch @returns Promise resolving to a BatchResponse object @throws ErrorResponse if the request fails
+**getAssignedTags**(collectionId: string, claimSetId: string) → `Promise<any>`
+Get assigned tags for a claim set.
 
-**getSN**(collectionId: string, productId: string, batchId: string, startIndex: number = 0, count: number = 10) → `any`
-Get a single batch by ID for a collection and product (admin only). @param collectionId - Identifier of the parent collection @param productId - Identifier of the parent product @param batchId - Identifier of the batch @returns Promise resolving to a BatchResponse object @throws ErrorResponse if the request fails
+**getTagSummary**(collectionId: string) → `Promise<any>`
+Get tag summary for a collection.
 
-**lookupSN**(collectionId: string, productId: string, batchId: string, codeId: string) → `any`
-Get a single batch by ID for a collection and product (admin only). @param collectionId - Identifier of the parent collection @param productId - Identifier of the parent product @param batchId - Identifier of the batch @returns Promise resolving to a BatchResponse object @throws ErrorResponse if the request fails
+**tagQuery**(collectionId: string, data: any) → `Promise<any>`
+Perform a tag query for a collection.
 
-### claimSet
+**createForCollection**(collectionId: string, params: any) → `Promise<any>`
+Create a new claim set for a collection.
 
-**getAllForCollection**(collectionId: string) → `any[]`
-Get all claim sets for a collection. @param collectionId – The collection identifier @returns Promise resolving to an array of claim sets
+**updateForCollection**(collectionId: string, params: any) → `Promise<any>`
+Update a claim set for a collection.
 
-**getForCollection**(collectionId: string, claimSetId: string) → `any`
-Get all claim sets for a collection. @param collectionId – The collection identifier @returns Promise resolving to an array of claim sets
+**makeClaim**(collectionId: string, params: any) → `Promise<any>`
+Make a claim for a claim set.
 
-**getAllTags**(collectionId: string, claimSetId: string) → `any[]`
-Get all claim sets for a collection. @param collectionId – The collection identifier @returns Promise resolving to an array of claim sets
+**assignClaims**(collectionId: string, data: any) → `Promise<any>`
+Assign claims to a claim set.
 
-**getReport**(collectionId: string, claimSetId: string) → `any`
-Get all claim sets for a collection. @param collectionId – The collection identifier @returns Promise resolving to an array of claim sets
+**updateClaimData**(collectionId: string, data: any) → `Promise<any>`
+Update claim data for a collection.
 
-**getAssignedTags**(collectionId: string, claimSetId: string) → `any`
-Get all claim sets for a collection. @param collectionId – The collection identifier @returns Promise resolving to an array of claim sets
+**getAllForCollection**(collectionId: string) → `Promise<any[]>`
+Get all claim sets for a collection.
 
-**getTagSummary**(collectionId: string) → `any`
-Get all claim sets for a collection. @param collectionId – The collection identifier @returns Promise resolving to an array of claim sets
+**getForCollection**(collectionId: string, claimSetId: string) → `Promise<any>`
+Get a specific claim set for a collection.
 
-**tagQuery**(collectionId: string, data: any) → `any`
-Get all claim sets for a collection. @param collectionId – The collection identifier @returns Promise resolving to an array of claim sets
+**getAllTags**(collectionId: string, claimSetId: string) → `Promise<any[]>`
+Get all tags for a claim set.
 
-**createForCollection**(collectionId: string, params: any) → `any`
-Get all claim sets for a collection. @param collectionId – The collection identifier @returns Promise resolving to an array of claim sets
+**getReport**(collectionId: string, claimSetId: string) → `Promise<any>`
+Get a report for a claim set.
 
-**updateForCollection**(collectionId: string, params: any) → `any`
-Get all claim sets for a collection. @param collectionId – The collection identifier @returns Promise resolving to an array of claim sets
+**getAssignedTags**(collectionId: string, claimSetId: string) → `Promise<any>`
+Get assigned tags for a claim set.
 
-**makeClaim**(collectionId: string, params: any) → `any`
-Get all claim sets for a collection. @param collectionId – The collection identifier @returns Promise resolving to an array of claim sets
+**getTagSummary**(collectionId: string) → `Promise<any>`
+Get tag summary for a collection.
 
-**assignClaims**(collectionId: string, data: any) → `any`
-Get all claim sets for a collection. @param collectionId – The collection identifier @returns Promise resolving to an array of claim sets
+**tagQuery**(collectionId: string, data: any) → `Promise<any>`
+Perform a tag query for a collection.
 
-**updateClaimData**(collectionId: string, data: any) → `any`
-Get all claim sets for a collection. @param collectionId – The collection identifier @returns Promise resolving to an array of claim sets
+**createForCollection**(collectionId: string, params: any) → `Promise<any>`
+Create a new claim set for a collection.
+
+**updateForCollection**(collectionId: string, params: any) → `Promise<any>`
+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.
+
+**updateClaimData**(collectionId: string, data: any) → `Promise<any>`
+Update claim data for a collection.
 
 ### collection
 
-**get**(collectionId: string, admin?: boolean) → `CollectionResponse`
-Retrieves a single Collection by its ID. @param collectionId – Identifier of the collection @param admin – If true, fetches from the admin endpoint @returns Promise resolving to a CollectionResponse object @throws ErrorResponse if the request fails
+**get**(collectionId: string, admin?: boolean) → `Promise<CollectionResponse>`
+Retrieves a single Collection by its ID.
 
-**list**(admin?: boolean) → `CollectionResponse[]`
-Retrieves a single Collection by its ID. @param collectionId – Identifier of the collection @param admin – If true, fetches from the admin endpoint @returns Promise resolving to a CollectionResponse object @throws ErrorResponse if the request fails
+**list**(admin?: boolean) → `Promise<CollectionResponse[]>`
+Retrieves all Collections.
 
-**create**(data: any) → `CollectionResponse`
-Retrieves a single Collection by its ID. @param collectionId – Identifier of the collection @param admin – If true, fetches from the admin endpoint @returns Promise resolving to a CollectionResponse object @throws ErrorResponse if the request fails
+**create**(data: any) → `Promise<CollectionResponse>`
+Create a new collection (admin only).
 
-**update**(collectionId: string, data: any) → `CollectionResponse`
-Retrieves a single Collection by its ID. @param collectionId – Identifier of the collection @param admin – If true, fetches from the admin endpoint @returns Promise resolving to a CollectionResponse object @throws ErrorResponse if the request fails
+**update**(collectionId: string, data: any) → `Promise<CollectionResponse>`
+Update a collection (admin only).
 
-**remove**(collectionId: string) → `void`
-Retrieves a single Collection by its ID. @param collectionId – Identifier of the collection @param admin – If true, fetches from the admin endpoint @returns Promise resolving to a CollectionResponse object @throws ErrorResponse if the request fails
+**remove**(collectionId: string) → `Promise<void>`
+Delete a collection (admin only).
 
-**getSN**(collectionId: string, startIndex: number = 0, count: number = 10) → `any`
-Retrieves a single Collection by its ID. @param collectionId – Identifier of the collection @param admin – If true, fetches from the admin endpoint @returns Promise resolving to a CollectionResponse object @throws ErrorResponse if the request fails
+**getSN**(collectionId: string,
+    startIndex: number = 0,
+    count: number = 10) → `Promise<any>`
+Get serial numbers for a collection (admin only).
 
-**lookupSN**(collectionId: string, codeId: string) → `any`
-Retrieves a single Collection by its ID. @param collectionId – Identifier of the collection @param admin – If true, fetches from the admin endpoint @returns Promise resolving to a CollectionResponse object @throws ErrorResponse if the request fails
+**lookupSN**(collectionId: string,
+    codeId: string) → `Promise<any>`
+Look up a serial number by code for a collection (admin only).
 
-**assignSN**(collectionId: string, codeId: string, value: any) → `any`
-Retrieves a single Collection by its ID. @param collectionId – Identifier of the collection @param admin – If true, fetches from the admin endpoint @returns Promise resolving to a CollectionResponse object @throws ErrorResponse if the request fails
+**assignSN**(collectionId: string,
+    codeId: string,
+    value: any) → `Promise<any>`
+Assign a value to a serial number for a collection (admin only).
 
-### crate
+**get**(collectionId: string, admin?: boolean) → `Promise<CollectionResponse>`
+Retrieves a single Collection by its ID.
 
-**get**(collectionId: string, crateId: string) → `any`
-Get a single crate by ID for a collection (admin only).
+**list**(admin?: boolean) → `Promise<CollectionResponse[]>`
+Retrieves all Collections.
 
-**list**(collectionId: string) → `any[]`
-Get a single crate by ID for a collection (admin only).
+**create**(data: any) → `Promise<CollectionResponse>`
+Create a new collection (admin only).
 
-**create**(collectionId: string, data: any) → `any`
-Get a single crate by ID for a collection (admin only).
+**update**(collectionId: string, data: any) → `Promise<CollectionResponse>`
+Update a collection (admin only).
 
-**update**(collectionId: string, crateId: string, data: any) → `any`
-Get a single crate by ID for a collection (admin only).
+**remove**(collectionId: string) → `Promise<void>`
+Delete a collection (admin only).
 
-**remove**(collectionId: string, crateId: string) → `void`
+**getSN**(collectionId: string,
+    startIndex: number = 0,
+    count: number = 10) → `Promise<any>`
+Get serial numbers for a collection (admin only).
+
+**lookupSN**(collectionId: string,
+    codeId: string) → `Promise<any>`
+Look up a serial number by code for a collection (admin only).
+
+**assignSN**(collectionId: string,
+    codeId: string,
+    value: any) → `Promise<any>`
+Assign a value to a serial number for a collection (admin only).
+
+### crate
+
+**get**(collectionId: string, crateId: string) → `Promise<any>`
 Get a single crate by ID for a collection (admin only).
 
-### form
+**list**(collectionId: string) → `Promise<any[]>`
+List all crates for a collection (admin only).
 
-**get**(collectionId: string, formId: string, admin?: boolean) → `any`
-Get a single form by ID for a collection. @param collectionId – The collection identifier @param formId – The form identifier @param admin – If true, use admin endpoint; otherwise, use public
+**create**(collectionId: string, data: any) → `Promise<any>`
+Create a new crate for a collection (admin only).
 
-**list**(collectionId: string, admin?: boolean) → `any[]`
-Get a single form by ID for a collection. @param collectionId – The collection identifier @param formId – The form identifier @param admin – If true, use admin endpoint; otherwise, use public
+**update**(collectionId: string, crateId: string, data: any) → `Promise<any>`
+Update a crate for a collection (admin only).
 
-**create**(collectionId: string, data: any) → `any`
-Get a single form by ID for a collection. @param collectionId – The collection identifier @param formId – The form identifier @param admin – If true, use admin endpoint; otherwise, use public
+**remove**(collectionId: string, crateId: string) → `Promise<void>`
+Delete a crate for a collection (admin only).
 
-**update**(collectionId: string, formId: string, data: any) → `any`
-Get a single form by ID for a collection. @param collectionId – The collection identifier @param formId – The form identifier @param admin – If true, use admin endpoint; otherwise, use public
+**get**(collectionId: string, crateId: string) → `Promise<any>`
+Get a single crate by ID for a collection (admin only).
 
-**remove**(collectionId: string, formId: string) → `void`
-Get a single form by ID for a collection. @param collectionId – The collection identifier @param formId – The form identifier @param admin – If true, use admin endpoint; otherwise, use public
+**list**(collectionId: string) → `Promise<any[]>`
+List all crates for a collection (admin only).
 
-### product
+**create**(collectionId: string, data: any) → `Promise<any>`
+Create a new crate for a collection (admin only).
 
-**get**(collectionId: string, productId: string, admin?: boolean) → `ProductResponse`
-Retrieves a single Product Item by Collection ID and Product ID. @param collectionId – Identifier of the parent collection @param productId    – Identifier of the product item @param admin        – If true, use admin endpoint; otherwise, use public @returns Promise resolving to a ProductResponse object @throws ErrorResponse if the request fails
+**update**(collectionId: string, crateId: string, data: any) → `Promise<any>`
+Update a crate for a collection (admin only).
 
-**list**(collectionId: string, admin?: boolean) → `ProductResponse[]`
-Retrieves a single Product Item by Collection ID and Product ID. @param collectionId – Identifier of the parent collection @param productId    – Identifier of the product item @param admin        – If true, use admin endpoint; otherwise, use public @returns Promise resolving to a ProductResponse object @throws ErrorResponse if the request fails
+**remove**(collectionId: string, crateId: string) → `Promise<void>`
+Delete a crate for a collection (admin only).
 
-**create**(collectionId: string, data: any) → `ProductResponse`
-Retrieves a single Product Item by Collection ID and Product ID. @param collectionId – Identifier of the parent collection @param productId    – Identifier of the product item @param admin        – If true, use admin endpoint; otherwise, use public @returns Promise resolving to a ProductResponse object @throws ErrorResponse if the request fails
+### form
 
-**update**(collectionId: string, productId: string, data: any) → `ProductResponse`
-Retrieves a single Product Item by Collection ID and Product ID. @param collectionId – Identifier of the parent collection @param productId    – Identifier of the product item @param admin        – If true, use admin endpoint; otherwise, use public @returns Promise resolving to a ProductResponse object @throws ErrorResponse if the request fails
+**get**(collectionId: string, formId: string, admin?: boolean) → `Promise<any>`
+Get a single form by ID for a collection.
 
-**remove**(collectionId: string, productId: string) → `void`
-Retrieves a single Product Item by Collection ID and Product ID. @param collectionId – Identifier of the parent collection @param productId    – Identifier of the product item @param admin        – If true, use admin endpoint; otherwise, use public @returns Promise resolving to a ProductResponse object @throws ErrorResponse if the request fails
+**list**(collectionId: string, admin?: boolean) → `Promise<any[]>`
+List all forms for a collection.
 
-**getSN**(collectionId: string, productId: string, startIndex: number = 0, count: number = 10) → `any`
-Retrieves a single Product Item by Collection ID and Product ID. @param collectionId – Identifier of the parent collection @param productId    – Identifier of the product item @param admin        – If true, use admin endpoint; otherwise, use public @returns Promise resolving to a ProductResponse object @throws ErrorResponse if the request fails
+**create**(collectionId: string, data: any) → `Promise<any>`
+Create a new form for a collection (admin only).
 
-**lookupSN**(collectionId: string, productId: string, codeId: string) → `any`
-Retrieves a single Product Item by Collection ID and Product ID. @param collectionId – Identifier of the parent collection @param productId    – Identifier of the product item @param admin        – If true, use admin endpoint; otherwise, use public @returns Promise resolving to a ProductResponse object @throws ErrorResponse if the request fails
+**update**(collectionId: string, formId: string, data: any) → `Promise<any>`
+Update a form for a collection (admin only).
 
-### proof
+**remove**(collectionId: string, formId: string) → `Promise<void>`
+Delete a form for a collection (admin only).
 
-**get**(collectionId: string, proofId: string) → `ProofResponse`
-Retrieves a single Proof by Collection ID and Proof ID. @param collectionId – Identifier of the parent collection @param proofId      – Identifier of the proof @returns Promise resolving to a ProofResponse object @throws ErrorResponse if the request fails
+**get**(collectionId: string, formId: string, admin?: boolean) → `Promise<any>`
+Get a single form by ID for a collection.
 
-**list**(collectionId: string) → `ProofResponse[]`
-Retrieves a single Proof by Collection ID and Proof ID. @param collectionId – Identifier of the parent collection @param proofId      – Identifier of the proof @returns Promise resolving to a ProofResponse object @throws ErrorResponse if the request fails
+**list**(collectionId: string, admin?: boolean) → `Promise<any[]>`
+List all forms for a collection.
 
-### variant
+**create**(collectionId: string, data: any) → `Promise<any>`
+Create a new form for a collection (admin only).
+
+**update**(collectionId: string, formId: string, data: any) → `Promise<any>`
+Update a form for a collection (admin only).
+
+**remove**(collectionId: string, formId: string) → `Promise<void>`
+Delete a form for a collection (admin only).
 
-**get**(collectionId: string, productId: string, variantId: string) → `VariantResponse`
-Get a single variant by ID for a collection and product (admin only). @param collectionId - Identifier of the parent collection @param productId - Identifier of the parent product @param variantId - Identifier of the variant @returns Promise resolving to a VariantResponse object @throws ErrorResponse if the request fails
+### product
+
+**get**(collectionId: string,
+    productId: string,
+    admin?: boolean) → `Promise<ProductResponse>`
+Retrieves a single Product Item by Collection ID and Product ID.
+
+**list**(collectionId: string,
+    admin?: boolean) → `Promise<ProductResponse[]>`
+List all Product Items for a Collection.
+
+**create**(collectionId: string,
+    data: any) → `Promise<ProductResponse>`
+Create a new product for a collection (admin only).
+
+**update**(collectionId: string,
+    productId: string,
+    data: any) → `Promise<ProductResponse>`
+Update a product for a collection (admin only).
+
+**remove**(collectionId: string,
+    productId: string) → `Promise<void>`
+Delete a product for a collection (admin only).
+
+**getSN**(collectionId: string,
+    productId: string,
+    startIndex: number = 0,
+    count: number = 10) → `Promise<any>`
+Get serial numbers for a product (admin only).
+
+**lookupSN**(collectionId: string,
+    productId: string,
+    codeId: string) → `Promise<any>`
+Look up a serial number by code for a product (admin only).
+
+**get**(collectionId: string,
+    productId: string,
+    admin?: boolean) → `Promise<ProductResponse>`
+Retrieves a single Product Item by Collection ID and Product ID.
+
+**list**(collectionId: string,
+    admin?: boolean) → `Promise<ProductResponse[]>`
+List all Product Items for a Collection.
+
+**create**(collectionId: string,
+    data: any) → `Promise<ProductResponse>`
+Create a new product for a collection (admin only).
+
+**update**(collectionId: string,
+    productId: string,
+    data: any) → `Promise<ProductResponse>`
+Update a product for a collection (admin only).
+
+**remove**(collectionId: string,
+    productId: string) → `Promise<void>`
+Delete a product for a collection (admin only).
+
+**getSN**(collectionId: string,
+    productId: string,
+    startIndex: number = 0,
+    count: number = 10) → `Promise<any>`
+Get serial numbers for a product (admin only).
+
+**lookupSN**(collectionId: string,
+    productId: string,
+    codeId: string) → `Promise<any>`
+Look up a serial number by code for a product (admin only).
 
-**list**(collectionId: string, productId: string) → `VariantResponse[]`
-Get a single variant by ID for a collection and product (admin only). @param collectionId - Identifier of the parent collection @param productId - Identifier of the parent product @param variantId - Identifier of the variant @returns Promise resolving to a VariantResponse object @throws ErrorResponse if the request fails
+### proof
 
-**create**(collectionId: string, productId: string, data: VariantCreateRequest) → `VariantResponse`
-Get a single variant by ID for a collection and product (admin only). @param collectionId - Identifier of the parent collection @param productId - Identifier of the parent product @param variantId - Identifier of the variant @returns Promise resolving to a VariantResponse object @throws ErrorResponse if the request fails
+**get**(collectionId: string,
+    proofId: string) → `Promise<ProofResponse>`
+Retrieves a single Proof by Collection ID and Proof ID.
 
-**update**(collectionId: string, productId: string, variantId: string, data: VariantUpdateRequest) → `VariantResponse`
-Get a single variant by ID for a collection and product (admin only). @param collectionId - Identifier of the parent collection @param productId - Identifier of the parent product @param variantId - Identifier of the variant @returns Promise resolving to a VariantResponse object @throws ErrorResponse if the request fails
+**list**(collectionId: string) → `Promise<ProofResponse[]>`
+List all Proofs for a Collection.
 
-**remove**(collectionId: string, productId: string, variantId: string) → `void`
-Get a single variant by ID for a collection and product (admin only). @param collectionId - Identifier of the parent collection @param productId - Identifier of the parent product @param variantId - Identifier of the variant @returns Promise resolving to a VariantResponse object @throws ErrorResponse if the request fails
+**get**(collectionId: string,
+    proofId: string) → `Promise<ProofResponse>`
+Retrieves a single Proof by Collection ID and Proof ID.
 
-**getPublic**(collectionId: string, productId: string, variantId: string) → `VariantResponse`
-Get a single variant by ID for a collection and product (admin only). @param collectionId - Identifier of the parent collection @param productId - Identifier of the parent product @param variantId - Identifier of the variant @returns Promise resolving to a VariantResponse object @throws ErrorResponse if the request fails
+**list**(collectionId: string) → `Promise<ProofResponse[]>`
+List all Proofs for a Collection.
 
-**getSN**(collectionId: string, productId: string, variantId: string, startIndex: number = 0, count: number = 10) → `any`
-Get a single variant by ID for a collection and product (admin only). @param collectionId - Identifier of the parent collection @param productId - Identifier of the parent product @param variantId - Identifier of the variant @returns Promise resolving to a VariantResponse object @throws ErrorResponse if the request fails
+### variant
 
-**lookupSN**(collectionId: string, productId: string, variantId: string, codeId: string) → `any`
-Get a single variant by ID for a collection and product (admin only). @param collectionId - Identifier of the parent collection @param productId - Identifier of the parent product @param variantId - Identifier of the variant @returns Promise resolving to a VariantResponse object @throws ErrorResponse if the request fails
+**get**(collectionId: string,
+    productId: string,
+    variantId: string) → `Promise<VariantResponse>`
+Get a single variant by ID for a collection and product (admin only).
+
+**list**(collectionId: string,
+    productId: string) → `Promise<VariantResponse[]>`
+List all variants for a collection and product (admin only).
+
+**create**(collectionId: string,
+    productId: string,
+    data: VariantCreateRequest) → `Promise<VariantResponse>`
+Create a new variant for a collection and product (admin only).
+
+**update**(collectionId: string,
+    productId: string,
+    variantId: string,
+    data: VariantUpdateRequest) → `Promise<VariantResponse>`
+Update a variant for a collection and product (admin only).
+
+**remove**(collectionId: string,
+    productId: string,
+    variantId: string) → `Promise<void>`
+Delete a variant for a collection and product (admin only).
+
+**getPublic**(collectionId: string,
+    productId: string,
+    variantId: string) → `Promise<VariantResponse>`
+Get a single variant by ID for a collection and product (public endpoint).
+
+**getSN**(collectionId: string,
+    productId: string,
+    variantId: string,
+    startIndex: number = 0,
+    count: number = 10) → `Promise<any>`
+Get serial numbers for a variant (admin only).
+
+**lookupSN**(collectionId: string,
+    productId: string,
+    variantId: string,
+    codeId: string) → `Promise<any>`
+Look up a serial number by code for a variant (admin only).
+
+**get**(collectionId: string,
+    productId: string,
+    variantId: string) → `Promise<VariantResponse>`
+Get a single variant by ID for a collection and product (admin only).
+
+**list**(collectionId: string,
+    productId: string) → `Promise<VariantResponse[]>`
+List all variants for a collection and product (admin only).
+
+**create**(collectionId: string,
+    productId: string,
+    data: VariantCreateRequest) → `Promise<VariantResponse>`
+Create a new variant for a collection and product (admin only).
+
+**update**(collectionId: string,
+    productId: string,
+    variantId: string,
+    data: VariantUpdateRequest) → `Promise<VariantResponse>`
+Update a variant for a collection and product (admin only).
+
+**remove**(collectionId: string,
+    productId: string,
+    variantId: string) → `Promise<void>`
+Delete a variant for a collection and product (admin only).
+
+**getPublic**(collectionId: string,
+    productId: string,
+    variantId: string) → `Promise<VariantResponse>`
+Get a single variant by ID for a collection and product (public endpoint).
+
+**getSN**(collectionId: string,
+    productId: string,
+    variantId: string,
+    startIndex: number = 0,
+    count: number = 10) → `Promise<any>`
+Get serial numbers for a variant (admin only).
+
+**lookupSN**(collectionId: string,
+    productId: string,
+    variantId: string,
+    codeId: string) → `Promise<any>`
+Look up a serial number by code for a variant (admin only).