@proveanything/smartlinks 1.3.19 → 1.3.20

package/dist/api/crate.d.ts

@@ -1,22 +1,111 @@
+import { GetCrateResponse, CreateCrateRequest, CreateCrateResponse, UpdateCrateRequest, UpdateCrateResponse, DeleteCrateResponse, ListCratesRequest, ListCratesResponse } from "../types/crate";
+/**
+ * Crate Management API
+ *
+ * Manage crates (containers for tags/products) within collections.
+ */
 export declare namespace crate {
     /**
-     * Get a single crate by ID for a collection (admin only).
+     * List crates for a collection with pagination support.
+     * Returns crates in pages, with support for soft-deleted crates.
+     *
+     * @param collectionId - Identifier of the parent collection
+     * @param params - Optional query parameters for pagination and filtering
+     * @returns Promise resolving to a ListCratesResponse object
+     * @throws ErrorResponse if the request fails
+     *
+     * @example
+     * ```typescript
+     * // Get first page
+     * const page1 = await crate.list('coll_123', { limit: 100 })
+     * console.log(`Found ${page1.items.length} crates`)
+     *
+     * // Get next page
+     * if (page1.hasMore) {
+     *   const page2 = await crate.list('coll_123', {
+     *     limit: 100,
+     *     startAfter: page1.lastId
+     *   })
+     * }
+     *
+     * // Include soft-deleted crates
+     * const withDeleted = await crate.list('coll_123', {
+     *   includeDeleted: true
+     * })
+     * ```
      */
-    function get(collectionId: string, crateId: string): Promise<any>;
+    function list(collectionId: string, params?: ListCratesRequest): Promise<ListCratesResponse>;
     /**
-     * List all crates for a collection (admin only).
+     * Get a single crate by ID for a collection (admin only).
+     *
+     * @param collectionId - Identifier of the parent collection
+     * @param crateId - Crate ID
+     * @returns Promise resolving to a GetCrateResponse object
+     * @throws ErrorResponse if the request fails
+     *
+     * @example
+     * ```typescript
+     * const crate = await crate.get('coll_123', 'crate_abc123')
+     * console.log(`Crate has ${crate.items?.length ?? 0} items`)
+     * ```
      */
-    function list(collectionId: string): Promise<any[]>;
+    function get(collectionId: string, crateId: string): Promise<GetCrateResponse>;
     /**
      * Create a new crate for a collection (admin only).
+     *
+     * @param collectionId - Identifier of the parent collection
+     * @param data - Crate creation data
+     * @returns Promise resolving to a CreateCrateResponse object
+     * @throws ErrorResponse if the request fails
+     *
+     * @example
+     * ```typescript
+     * const newCrate = await crate.create('coll_123', {
+     *   items: [
+     *     {
+     *       id: 'tag_001',
+     *       codeId: 'ABC123',
+     *       productId: 'prod_1',
+     *       productName: 'Product Name'
+     *     }
+     *   ]
+     * })
+     * console.log(`Created crate ${newCrate.id}`)
+     * ```
      */
-    function create(collectionId: string, data: any): Promise<any>;
+    function create(collectionId: string, data: CreateCrateRequest): Promise<CreateCrateResponse>;
     /**
      * Update a crate for a collection (admin only).
+     *
+     * @param collectionId - Identifier of the parent collection
+     * @param crateId - Crate ID
+     * @param data - Update data
+     * @returns Promise resolving to an UpdateCrateResponse object
+     * @throws ErrorResponse if the request fails
+     *
+     * @example
+     * ```typescript
+     * const updated = await crate.update('coll_123', 'crate_abc123', {
+     *   items: [
+     *     { id: 'tag_002', codeId: 'XYZ789', productId: 'prod_2' }
+     *   ]
+     * })
+     * ```
      */
-    function update(collectionId: string, crateId: string, data: any): Promise<any>;
+    function update(collectionId: string, crateId: string, data: UpdateCrateRequest): Promise<UpdateCrateResponse>;
     /**
      * Delete a crate for a collection (admin only).
+     * This performs a soft delete.
+     *
+     * @param collectionId - Identifier of the parent collection
+     * @param crateId - Crate ID
+     * @returns Promise resolving to a DeleteCrateResponse object
+     * @throws ErrorResponse if the request fails
+     *
+     * @example
+     * ```typescript
+     * await crate.remove('coll_123', 'crate_abc123')
+     * ```
      */
-    function remove(collectionId: string, crateId: string): Promise<void>;
+    function remove(collectionId: string, crateId: string): Promise<DeleteCrateResponse>;
 }

package/dist/api/crate.js

@@ -1,24 +1,94 @@
 import { request, post, put, del } from "../http";
+/**
+ * Crate Management API
+ *
+ * Manage crates (containers for tags/products) within collections.
+ */
 export var crate;
 (function (crate) {
     /**
-     * Get a single crate by ID for a collection (admin only).
+     * List crates for a collection with pagination support.
+     * Returns crates in pages, with support for soft-deleted crates.
+     *
+     * @param collectionId - Identifier of the parent collection
+     * @param params - Optional query parameters for pagination and filtering
+     * @returns Promise resolving to a ListCratesResponse object
+     * @throws ErrorResponse if the request fails
+     *
+     * @example
+     * ```typescript
+     * // Get first page
+     * const page1 = await crate.list('coll_123', { limit: 100 })
+     * console.log(`Found ${page1.items.length} crates`)
+     *
+     * // Get next page
+     * if (page1.hasMore) {
+     *   const page2 = await crate.list('coll_123', {
+     *     limit: 100,
+     *     startAfter: page1.lastId
+     *   })
+     * }
+     *
+     * // Include soft-deleted crates
+     * const withDeleted = await crate.list('coll_123', {
+     *   includeDeleted: true
+     * })
+     * ```
      */
-    async function get(collectionId, crateId) {
-        const path = `/admin/collection/${encodeURIComponent(collectionId)}/crate/${encodeURIComponent(crateId)}`;
+    async function list(collectionId, params) {
+        const queryParams = new URLSearchParams();
+        if (params === null || params === void 0 ? void 0 : params.limit)
+            queryParams.append('limit', params.limit.toString());
+        if (params === null || params === void 0 ? void 0 : params.startAfter)
+            queryParams.append('startAfter', params.startAfter);
+        if (params === null || params === void 0 ? void 0 : params.includeDeleted)
+            queryParams.append('includeDeleted', 'true');
+        const query = queryParams.toString();
+        const path = `/admin/collection/${encodeURIComponent(collectionId)}/crate${query ? `?${query}` : ''}`;
         return request(path);
     }
-    crate.get = get;
+    crate.list = list;
     /**
-     * List all crates for a collection (admin only).
+     * Get a single crate by ID for a collection (admin only).
+     *
+     * @param collectionId - Identifier of the parent collection
+     * @param crateId - Crate ID
+     * @returns Promise resolving to a GetCrateResponse object
+     * @throws ErrorResponse if the request fails
+     *
+     * @example
+     * ```typescript
+     * const crate = await crate.get('coll_123', 'crate_abc123')
+     * console.log(`Crate has ${crate.items?.length ?? 0} items`)
+     * ```
      */
-    async function list(collectionId) {
-        const path = `/admin/collection/${encodeURIComponent(collectionId)}/crate`;
+    async function get(collectionId, crateId) {
+        const path = `/admin/collection/${encodeURIComponent(collectionId)}/crate/${encodeURIComponent(crateId)}`;
         return request(path);
     }
-    crate.list = list;
+    crate.get = get;
     /**
      * Create a new crate for a collection (admin only).
+     *
+     * @param collectionId - Identifier of the parent collection
+     * @param data - Crate creation data
+     * @returns Promise resolving to a CreateCrateResponse object
+     * @throws ErrorResponse if the request fails
+     *
+     * @example
+     * ```typescript
+     * const newCrate = await crate.create('coll_123', {
+     *   items: [
+     *     {
+     *       id: 'tag_001',
+     *       codeId: 'ABC123',
+     *       productId: 'prod_1',
+     *       productName: 'Product Name'
+     *     }
+     *   ]
+     * })
+     * console.log(`Created crate ${newCrate.id}`)
+     * ```
      */
     async function create(collectionId, data) {
         const path = `/admin/collection/${encodeURIComponent(collectionId)}/crate`;
@@ -27,6 +97,21 @@ export var crate;
     crate.create = create;
     /**
      * Update a crate for a collection (admin only).
+     *
+     * @param collectionId - Identifier of the parent collection
+     * @param crateId - Crate ID
+     * @param data - Update data
+     * @returns Promise resolving to an UpdateCrateResponse object
+     * @throws ErrorResponse if the request fails
+     *
+     * @example
+     * ```typescript
+     * const updated = await crate.update('coll_123', 'crate_abc123', {
+     *   items: [
+     *     { id: 'tag_002', codeId: 'XYZ789', productId: 'prod_2' }
+     *   ]
+     * })
+     * ```
      */
     async function update(collectionId, crateId, data) {
         const path = `/admin/collection/${encodeURIComponent(collectionId)}/crate/${encodeURIComponent(crateId)}`;
@@ -35,6 +120,17 @@ export var crate;
     crate.update = update;
     /**
      * Delete a crate for a collection (admin only).
+     * This performs a soft delete.
+     *
+     * @param collectionId - Identifier of the parent collection
+     * @param crateId - Crate ID
+     * @returns Promise resolving to a DeleteCrateResponse object
+     * @throws ErrorResponse if the request fails
+     *
+     * @example
+     * ```typescript
+     * await crate.remove('coll_123', 'crate_abc123')
+     * ```
      */
     async function remove(collectionId, crateId) {
         const path = `/admin/collection/${encodeURIComponent(collectionId)}/crate/${encodeURIComponent(crateId)}`;

package/dist/docs/API_SUMMARY.md

@@ -1,6 +1,6 @@
 # Smartlinks API Summary
 
-Version: 1.3.19  |  Generated: 2026-02-08T09:16:59.107Z
+Version: 1.3.20  |  Generated: 2026-02-08T14:25:23.483Z
 
 This is a concise summary of all available API functions and types.
 
@@ -1493,6 +1493,74 @@ interface ContactSchema {
 
 **FieldType** = ``
 
+### crate
+
+**CrateItem** (interface)
+```typescript
+interface CrateItem {
+  id: string                      // Item ID (tag ID)
+  codeId: string                  // Code identifier
+  batchId?: string                // Batch identifier
+  productId?: string              // Product identifier
+  claimId?: string                // Claim identifier
+  productName?: string            // Product name
+  productGtin?: string            // Product GTIN
+  productImage?: string           // Product image URL
+  data?: Record<string, any>      // Additional item data
+}
+```
+
+**Crate** (interface)
+```typescript
+interface Crate {
+  id: string                      // Crate ID
+  items?: CrateItem[]             // Array of items in the crate
+  deleted?: boolean               // Whether the crate is soft-deleted
+  deletedAt?: string | null       // ISO 8601 timestamp when deleted
+}
+```
+
+**ListCratesRequest** (interface)
+```typescript
+interface ListCratesRequest {
+  limit?: number                  // Number of results per page (default: 100, max: 100)
+  startAfter?: string             // Crate ID to start after for pagination
+  includeDeleted?: boolean        // Include soft-deleted crates (default: false)
+}
+```
+
+**ListCratesResponse** (interface)
+```typescript
+interface ListCratesResponse {
+  items: Crate[]                  // Array of crates
+  hasMore: boolean                // Whether more results are available
+  lastId: string | null           // ID of last crate (use as startAfter for next page)
+}
+```
+
+**CreateCrateRequest** (interface)
+```typescript
+interface CreateCrateRequest {
+  items?: CrateItem[]             // Initial items for the crate
+  [key: string]: any              // Additional fields
+}
+```
+
+**UpdateCrateRequest** (interface)
+```typescript
+interface UpdateCrateRequest {
+  items?: CrateItem[]             // Updated items
+  [key: string]: any              // Additional fields
+}
+```
+
+**DeleteCrateResponse** (interface)
+```typescript
+interface DeleteCrateResponse {
+  success: boolean
+}
+```
+
 ### error
 
 **ErrorResponse** (interface)
@@ -4123,20 +4191,26 @@ Public: Get contact update schema for a collection Fetches the public contact sc
 
 ### crate
 
-**get**(collectionId: string, crateId: string) → `Promise<any>`
-Get a single crate by ID for a collection (admin only).
+**list**(collectionId: string,
+    params?: ListCratesRequest) → `Promise<ListCratesResponse>`
+List crates for a collection with pagination support. Returns crates in pages, with support for soft-deleted crates. ```typescript // Get first page const page1 = await crate.list('coll_123', { limit: 100 }) console.log(`Found ${page1.items.length} crates`) // Get next page if (page1.hasMore) { const page2 = await crate.list('coll_123', { limit: 100, startAfter: page1.lastId }) } // Include soft-deleted crates const withDeleted = await crate.list('coll_123', { includeDeleted: true }) ```
 
-**list**(collectionId: string) → `Promise<any[]>`
-List all crates for a collection (admin only).
+**get**(collectionId: string,
+    crateId: string) → `Promise<GetCrateResponse>`
+Get a single crate by ID for a collection (admin only). ```typescript const crate = await crate.get('coll_123', 'crate_abc123') console.log(`Crate has ${crate.items?.length ?? 0} items`) ```
 
-**create**(collectionId: string, data: any) → `Promise<any>`
-Create a new crate for a collection (admin only).
+**create**(collectionId: string,
+    data: CreateCrateRequest) → `Promise<CreateCrateResponse>`
+Create a new crate for a collection (admin only). ```typescript const newCrate = await crate.create('coll_123', { items: [ { id: 'tag_001', codeId: 'ABC123', productId: 'prod_1', productName: 'Product Name' } ] }) console.log(`Created crate ${newCrate.id}`) ```
 
-**update**(collectionId: string, crateId: string, data: any) → `Promise<any>`
-Update a crate for a collection (admin only).
+**update**(collectionId: string,
+    crateId: string,
+    data: UpdateCrateRequest) → `Promise<UpdateCrateResponse>`
+Update a crate for a collection (admin only). ```typescript const updated = await crate.update('coll_123', 'crate_abc123', { items: [ { id: 'tag_002', codeId: 'XYZ789', productId: 'prod_2' } ] }) ```
 
-**remove**(collectionId: string, crateId: string) → `Promise<void>`
-Delete a crate for a collection (admin only).
+**remove**(collectionId: string,
+    crateId: string) → `Promise<DeleteCrateResponse>`
+Delete a crate for a collection (admin only). This performs a soft delete. ```typescript await crate.remove('coll_123', 'crate_abc123') ```
 
 ### form
 

package/dist/types/crate.d.ts

@@ -0,0 +1,79 @@
+/**
+ * Crate Management Types
+ *
+ * Types for managing crates (containers for tags/products).
+ */
+/**
+ * Item within a crate.
+ */
+export interface CrateItem {
+    id: string;
+    codeId: string;
+    batchId?: string;
+    productId?: string;
+    claimId?: string;
+    productName?: string;
+    productGtin?: string;
+    productImage?: string;
+    data?: Record<string, any>;
+}
+/**
+ * Represents a crate containing items.
+ */
+export interface Crate {
+    id: string;
+    items?: CrateItem[];
+    deleted?: boolean;
+    deletedAt?: string | null;
+}
+/**
+ * Query parameters for listing crates.
+ */
+export interface ListCratesRequest {
+    limit?: number;
+    startAfter?: string;
+    includeDeleted?: boolean;
+}
+/**
+ * Response from listing crates.
+ */
+export interface ListCratesResponse {
+    items: Crate[];
+    hasMore: boolean;
+    lastId: string | null;
+}
+/**
+ * Response from getting a single crate.
+ */
+export interface GetCrateResponse extends Crate {
+}
+/**
+ * Request to create a crate.
+ */
+export interface CreateCrateRequest {
+    items?: CrateItem[];
+    [key: string]: any;
+}
+/**
+ * Response from creating a crate.
+ */
+export interface CreateCrateResponse extends Crate {
+}
+/**
+ * Request to update a crate.
+ */
+export interface UpdateCrateRequest {
+    items?: CrateItem[];
+    [key: string]: any;
+}
+/**
+ * Response from updating a crate.
+ */
+export interface UpdateCrateResponse extends Crate {
+}
+/**
+ * Response from deleting a crate.
+ */
+export interface DeleteCrateResponse {
+    success: boolean;
+}

package/dist/types/crate.js

@@ -0,0 +1,6 @@
+/**
+ * Crate Management Types
+ *
+ * Types for managing crates (containers for tags/products).
+ */
+export {};

package/dist/types/index.d.ts

@@ -24,4 +24,5 @@ export * from "./jobs";
 export * from "./realtime";
 export * from "./tags";
 export * from "./order";
+export * from "./crate";
 export * from "./iframeResponder";

package/dist/types/index.js

@@ -26,4 +26,5 @@ export * from "./jobs";
 export * from "./realtime";
 export * from "./tags";
 export * from "./order";
+export * from "./crate";
 export * from "./iframeResponder";

package/docs/API_SUMMARY.md

@@ -1,6 +1,6 @@
 # Smartlinks API Summary
 
-Version: 1.3.19  |  Generated: 2026-02-08T09:16:59.107Z
+Version: 1.3.20  |  Generated: 2026-02-08T14:25:23.483Z
 
 This is a concise summary of all available API functions and types.
 
@@ -1493,6 +1493,74 @@ interface ContactSchema {
 
 **FieldType** = ``
 
+### crate
+
+**CrateItem** (interface)
+```typescript
+interface CrateItem {
+  id: string                      // Item ID (tag ID)
+  codeId: string                  // Code identifier
+  batchId?: string                // Batch identifier
+  productId?: string              // Product identifier
+  claimId?: string                // Claim identifier
+  productName?: string            // Product name
+  productGtin?: string            // Product GTIN
+  productImage?: string           // Product image URL
+  data?: Record<string, any>      // Additional item data
+}
+```
+
+**Crate** (interface)
+```typescript
+interface Crate {
+  id: string                      // Crate ID
+  items?: CrateItem[]             // Array of items in the crate
+  deleted?: boolean               // Whether the crate is soft-deleted
+  deletedAt?: string | null       // ISO 8601 timestamp when deleted
+}
+```
+
+**ListCratesRequest** (interface)
+```typescript
+interface ListCratesRequest {
+  limit?: number                  // Number of results per page (default: 100, max: 100)
+  startAfter?: string             // Crate ID to start after for pagination
+  includeDeleted?: boolean        // Include soft-deleted crates (default: false)
+}
+```
+
+**ListCratesResponse** (interface)
+```typescript
+interface ListCratesResponse {
+  items: Crate[]                  // Array of crates
+  hasMore: boolean                // Whether more results are available
+  lastId: string | null           // ID of last crate (use as startAfter for next page)
+}
+```
+
+**CreateCrateRequest** (interface)
+```typescript
+interface CreateCrateRequest {
+  items?: CrateItem[]             // Initial items for the crate
+  [key: string]: any              // Additional fields
+}
+```
+
+**UpdateCrateRequest** (interface)
+```typescript
+interface UpdateCrateRequest {
+  items?: CrateItem[]             // Updated items
+  [key: string]: any              // Additional fields
+}
+```
+
+**DeleteCrateResponse** (interface)
+```typescript
+interface DeleteCrateResponse {
+  success: boolean
+}
+```
+
 ### error
 
 **ErrorResponse** (interface)
@@ -4123,20 +4191,26 @@ Public: Get contact update schema for a collection Fetches the public contact sc
 
 ### crate
 
-**get**(collectionId: string, crateId: string) → `Promise<any>`
-Get a single crate by ID for a collection (admin only).
+**list**(collectionId: string,
+    params?: ListCratesRequest) → `Promise<ListCratesResponse>`
+List crates for a collection with pagination support. Returns crates in pages, with support for soft-deleted crates. ```typescript // Get first page const page1 = await crate.list('coll_123', { limit: 100 }) console.log(`Found ${page1.items.length} crates`) // Get next page if (page1.hasMore) { const page2 = await crate.list('coll_123', { limit: 100, startAfter: page1.lastId }) } // Include soft-deleted crates const withDeleted = await crate.list('coll_123', { includeDeleted: true }) ```
 
-**list**(collectionId: string) → `Promise<any[]>`
-List all crates for a collection (admin only).
+**get**(collectionId: string,
+    crateId: string) → `Promise<GetCrateResponse>`
+Get a single crate by ID for a collection (admin only). ```typescript const crate = await crate.get('coll_123', 'crate_abc123') console.log(`Crate has ${crate.items?.length ?? 0} items`) ```
 
-**create**(collectionId: string, data: any) → `Promise<any>`
-Create a new crate for a collection (admin only).
+**create**(collectionId: string,
+    data: CreateCrateRequest) → `Promise<CreateCrateResponse>`
+Create a new crate for a collection (admin only). ```typescript const newCrate = await crate.create('coll_123', { items: [ { id: 'tag_001', codeId: 'ABC123', productId: 'prod_1', productName: 'Product Name' } ] }) console.log(`Created crate ${newCrate.id}`) ```
 
-**update**(collectionId: string, crateId: string, data: any) → `Promise<any>`
-Update a crate for a collection (admin only).
+**update**(collectionId: string,
+    crateId: string,
+    data: UpdateCrateRequest) → `Promise<UpdateCrateResponse>`
+Update a crate for a collection (admin only). ```typescript const updated = await crate.update('coll_123', 'crate_abc123', { items: [ { id: 'tag_002', codeId: 'XYZ789', productId: 'prod_2' } ] }) ```
 
-**remove**(collectionId: string, crateId: string) → `Promise<void>`
-Delete a crate for a collection (admin only).
+**remove**(collectionId: string,
+    crateId: string) → `Promise<DeleteCrateResponse>`
+Delete a crate for a collection (admin only). This performs a soft delete. ```typescript await crate.remove('coll_123', 'crate_abc123') ```
 
 ### form
 

package/package.json

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