@proveanything/smartlinks 1.0.33 → 1.0.35

package/API_SUMMARY.md

@@ -190,6 +190,8 @@ interface ProductResponse {
   name: string
   collectionId: string
   description: string
+  gtin?: string
+  type?: string
   heroImage: {
   url: string
   thumbnails: {
@@ -207,6 +209,10 @@ interface ProductResponse {
 }
 ```
 
+**ProductCreateRequest** = `Omit<ProductResponse, 'id' | 'collectionId'>`
+
+**ProductUpdateRequest** = `Partial<Omit<ProductResponse, 'id' | 'collectionId'>>`
+
 ### proof
 
 **ProofResponse** (interface)
@@ -806,13 +812,13 @@ Retrieves a single Product Item by Collection ID and Product ID.
 List all Product Items for a Collection.
 
 **create**(collectionId: string,
-    data: any) → `Promise<ProductResponse>`
-Create a new product for a collection (admin only).
+    data: ProductCreateRequest) → `Promise<ProductResponse>`
+Create a new product for a collection (admin only). The `data` payload follows the same shape as ProductResponse minus `id` and `collectionId`.
 
 **update**(collectionId: string,
     productId: string,
-    data: any) → `Promise<ProductResponse>`
-Update a product for a collection (admin only).
+    data: ProductUpdateRequest) → `Promise<ProductResponse>`
+Update a product for a collection (admin only). The `data` payload is a partial of ProductResponse minus `id` and `collectionId`.
 
 **remove**(collectionId: string,
     productId: string) → `Promise<void>`
@@ -839,13 +845,13 @@ Retrieves a single Product Item by Collection ID and Product ID.
 List all Product Items for a Collection.
 
 **create**(collectionId: string,
-    data: any) → `Promise<ProductResponse>`
-Create a new product for a collection (admin only).
+    data: ProductCreateRequest) → `Promise<ProductResponse>`
+Create a new product for a collection (admin only). The `data` payload follows the same shape as ProductResponse minus `id` and `collectionId`.
 
 **update**(collectionId: string,
     productId: string,
-    data: any) → `Promise<ProductResponse>`
-Update a product for a collection (admin only).
+    data: ProductUpdateRequest) → `Promise<ProductResponse>`
+Update a product for a collection (admin only). The `data` payload is a partial of ProductResponse minus `id` and `collectionId`.
 
 **remove**(collectionId: string,
     productId: string) → `Promise<void>`

package/dist/api/product.d.ts

@@ -1,4 +1,4 @@
-import { ProductResponse } from "../types/product";
+import { ProductResponse, ProductCreateRequest, ProductUpdateRequest } from "../types/product";
 export declare namespace product {
     /**
      * Retrieves a single Product Item by Collection ID and Product ID.
@@ -19,21 +19,23 @@ export declare namespace product {
     function list(collectionId: string, admin?: boolean): Promise<ProductResponse[]>;
     /**
      * Create a new product for a collection (admin only).
+     * The `data` payload follows the same shape as ProductResponse minus `id` and `collectionId`.
      * @param collectionId – Identifier of the parent collection
-     * @param data – Product creation data
+     * @param data – Product creation data (see ProductCreateRequest)
      * @returns Promise resolving to a ProductResponse object
      * @throws ErrorResponse if the request fails
      */
-    function create(collectionId: string, data: any): Promise<ProductResponse>;
+    function create(collectionId: string, data: ProductCreateRequest): Promise<ProductResponse>;
     /**
      * Update a product for a collection (admin only).
+     * The `data` payload is a partial of ProductResponse minus `id` and `collectionId`.
      * @param collectionId – Identifier of the parent collection
      * @param productId – Identifier of the product
-     * @param data – Product update data
+     * @param data – Product update data (see ProductUpdateRequest)
      * @returns Promise resolving to a ProductResponse object
      * @throws ErrorResponse if the request fails
      */
-    function update(collectionId: string, productId: string, data: any): Promise<ProductResponse>;
+    function update(collectionId: string, productId: string, data: ProductUpdateRequest): Promise<ProductResponse>;
     /**
      * Delete a product for a collection (admin only).
      * @param collectionId – Identifier of the parent collection

package/dist/api/product.js

@@ -31,8 +31,9 @@ export var product;
     product.list = list;
     /**
      * Create a new product for a collection (admin only).
+     * The `data` payload follows the same shape as ProductResponse minus `id` and `collectionId`.
      * @param collectionId – Identifier of the parent collection
-     * @param data – Product creation data
+     * @param data – Product creation data (see ProductCreateRequest)
      * @returns Promise resolving to a ProductResponse object
      * @throws ErrorResponse if the request fails
      */
@@ -43,9 +44,10 @@ export var product;
     product.create = create;
     /**
      * Update a product for a collection (admin only).
+     * The `data` payload is a partial of ProductResponse minus `id` and `collectionId`.
      * @param collectionId – Identifier of the parent collection
      * @param productId – Identifier of the product
-     * @param data – Product update data
+     * @param data – Product update data (see ProductUpdateRequest)
      * @returns Promise resolving to a ProductResponse object
      * @throws ErrorResponse if the request fails
      */

package/dist/index.d.ts

@@ -6,3 +6,4 @@ export type { AttestationResponse, AttestationCreateRequest, AttestationUpdateRe
 export type { BatchResponse, BatchCreateRequest, BatchUpdateRequest, } from "./types/batch";
 export type { VariantResponse, VariantCreateRequest, VariantUpdateRequest, } from "./types/variant";
 export type { AppConfigOptions } from "./api/appConfiguration";
+export type { ProductCreateRequest, ProductUpdateRequest, } from "./types/product";

package/dist/types/product.d.ts

@@ -10,6 +10,10 @@ export interface ProductResponse {
     collectionId: string;
     /** Detailed description of the product */
     description: string;
+    /** A product GTIN (Global Trade Item Number) */
+    gtin?: string;
+    /** An optional product type from the standard smartlinks types */
+    type?: string;
     /** Hero image asset object */
     heroImage: {
         /** URL to the asset */
@@ -30,3 +34,5 @@ export interface ProductResponse {
         [key: string]: any;
     };
 }
+export type ProductCreateRequest = Omit<ProductResponse, 'id' | 'collectionId'>;
+export type ProductUpdateRequest = Partial<Omit<ProductResponse, 'id' | 'collectionId'>>;

package/package.json

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