@proveanything/smartlinks 1.8.11 → 1.9.0

package/dist/api/facets.d.ts

@@ -0,0 +1,26 @@
+import type { FacetDefinition, FacetDefinitionWriteInput, FacetGetParams, FacetListParams, FacetListResponse, FacetQueryRequest, FacetQueryResponse, FacetValueGetParams, FacetValueListParams, FacetValueListResponse, FacetValueResponse, FacetValueWriteInput, PublicFacetListParams } from "../types/facets";
+/**
+ * Facet management and aggregation endpoints.
+ *
+ * Facets are collection-scoped resources mounted directly under `/facets`.
+ * Use this namespace to manage facet definitions and values, and to fetch
+ * aggregation buckets for browse and filter UIs.
+ */
+export declare namespace facets {
+    function list(collectionId: string, params?: FacetListParams): Promise<FacetListResponse>;
+    function create(collectionId: string, data: FacetDefinitionWriteInput): Promise<FacetDefinition>;
+    function get(collectionId: string, facetKey: string, params?: FacetGetParams): Promise<FacetDefinition>;
+    function update(collectionId: string, facetKey: string, data: FacetDefinitionWriteInput): Promise<FacetDefinition>;
+    function remove(collectionId: string, facetKey: string): Promise<void>;
+    function listValues(collectionId: string, facetKey: string, params?: FacetValueListParams): Promise<FacetValueListResponse>;
+    function createValue(collectionId: string, facetKey: string, data: FacetValueWriteInput): Promise<FacetValueResponse>;
+    function getValue(collectionId: string, facetKey: string, valueKey: string, params?: FacetValueGetParams): Promise<FacetValueResponse>;
+    function updateValue(collectionId: string, facetKey: string, valueKey: string, data: FacetValueWriteInput): Promise<FacetValueResponse>;
+    function removeValue(collectionId: string, facetKey: string, valueKey: string): Promise<void>;
+    function query(collectionId: string, body: FacetQueryRequest): Promise<FacetQueryResponse>;
+    function publicList(collectionId: string, params?: PublicFacetListParams): Promise<FacetListResponse>;
+    function publicGet(collectionId: string, facetKey: string, params?: PublicFacetListParams): Promise<FacetDefinition>;
+    function publicListValues(collectionId: string, facetKey: string): Promise<FacetValueListResponse>;
+    function publicGetValue(collectionId: string, facetKey: string, valueKey: string): Promise<FacetValueResponse>;
+    function publicQuery(collectionId: string, body: FacetQueryRequest): Promise<FacetQueryResponse>;
+}

package/dist/api/facets.js

@@ -0,0 +1,106 @@
+import { del, post, put, request } from "../http";
+function appendSearchParam(searchParams, key, value) {
+    if (value === undefined || value === null)
+        return;
+    searchParams.set(key, String(value));
+}
+function buildQueryString(params) {
+    if (!params)
+        return "";
+    const searchParams = new URLSearchParams();
+    for (const [key, value] of Object.entries(params)) {
+        appendSearchParam(searchParams, key, value);
+    }
+    const query = searchParams.toString();
+    return query ? `?${query}` : "";
+}
+/**
+ * Facet management and aggregation endpoints.
+ *
+ * Facets are collection-scoped resources mounted directly under `/facets`.
+ * Use this namespace to manage facet definitions and values, and to fetch
+ * aggregation buckets for browse and filter UIs.
+ */
+export var facets;
+(function (facets) {
+    async function list(collectionId, params) {
+        const path = `/admin/collection/${encodeURIComponent(collectionId)}/facets${buildQueryString(params)}`;
+        return request(path);
+    }
+    facets.list = list;
+    async function create(collectionId, data) {
+        const path = `/admin/collection/${encodeURIComponent(collectionId)}/facets`;
+        return post(path, data);
+    }
+    facets.create = create;
+    async function get(collectionId, facetKey, params) {
+        const path = `/admin/collection/${encodeURIComponent(collectionId)}/facets/${encodeURIComponent(facetKey)}${buildQueryString(params)}`;
+        return request(path);
+    }
+    facets.get = get;
+    async function update(collectionId, facetKey, data) {
+        const path = `/admin/collection/${encodeURIComponent(collectionId)}/facets/${encodeURIComponent(facetKey)}`;
+        return put(path, data);
+    }
+    facets.update = update;
+    async function remove(collectionId, facetKey) {
+        const path = `/admin/collection/${encodeURIComponent(collectionId)}/facets/${encodeURIComponent(facetKey)}`;
+        return del(path);
+    }
+    facets.remove = remove;
+    async function listValues(collectionId, facetKey, params) {
+        const path = `/admin/collection/${encodeURIComponent(collectionId)}/facets/${encodeURIComponent(facetKey)}/values${buildQueryString(params)}`;
+        return request(path);
+    }
+    facets.listValues = listValues;
+    async function createValue(collectionId, facetKey, data) {
+        const path = `/admin/collection/${encodeURIComponent(collectionId)}/facets/${encodeURIComponent(facetKey)}/values`;
+        return post(path, data);
+    }
+    facets.createValue = createValue;
+    async function getValue(collectionId, facetKey, valueKey, params) {
+        const path = `/admin/collection/${encodeURIComponent(collectionId)}/facets/${encodeURIComponent(facetKey)}/values/${encodeURIComponent(valueKey)}${buildQueryString(params)}`;
+        return request(path);
+    }
+    facets.getValue = getValue;
+    async function updateValue(collectionId, facetKey, valueKey, data) {
+        const path = `/admin/collection/${encodeURIComponent(collectionId)}/facets/${encodeURIComponent(facetKey)}/values/${encodeURIComponent(valueKey)}`;
+        return put(path, data);
+    }
+    facets.updateValue = updateValue;
+    async function removeValue(collectionId, facetKey, valueKey) {
+        const path = `/admin/collection/${encodeURIComponent(collectionId)}/facets/${encodeURIComponent(facetKey)}/values/${encodeURIComponent(valueKey)}`;
+        return del(path);
+    }
+    facets.removeValue = removeValue;
+    async function query(collectionId, body) {
+        const path = `/admin/collection/${encodeURIComponent(collectionId)}/facets/query`;
+        return post(path, body);
+    }
+    facets.query = query;
+    async function publicList(collectionId, params) {
+        const path = `/public/collection/${encodeURIComponent(collectionId)}/facets${buildQueryString(params)}`;
+        return request(path);
+    }
+    facets.publicList = publicList;
+    async function publicGet(collectionId, facetKey, params) {
+        const path = `/public/collection/${encodeURIComponent(collectionId)}/facets/${encodeURIComponent(facetKey)}${buildQueryString(params)}`;
+        return request(path);
+    }
+    facets.publicGet = publicGet;
+    async function publicListValues(collectionId, facetKey) {
+        const path = `/public/collection/${encodeURIComponent(collectionId)}/facets/${encodeURIComponent(facetKey)}/values`;
+        return request(path);
+    }
+    facets.publicListValues = publicListValues;
+    async function publicGetValue(collectionId, facetKey, valueKey) {
+        const path = `/public/collection/${encodeURIComponent(collectionId)}/facets/${encodeURIComponent(facetKey)}/values/${encodeURIComponent(valueKey)}`;
+        return request(path);
+    }
+    facets.publicGetValue = publicGetValue;
+    async function publicQuery(collectionId, body) {
+        const path = `/public/collection/${encodeURIComponent(collectionId)}/facets/query`;
+        return post(path, body);
+    }
+    facets.publicQuery = publicQuery;
+})(facets || (facets = {}));

package/dist/api/index.d.ts

@@ -1,5 +1,7 @@
 export { collection } from "./collection";
+export { facets } from "./facets";
 export { product } from "./product";
+export { products } from "./products";
 export { proof } from "./proof";
 export { appConfiguration, userAppData } from "./appConfiguration";
 export { asset } from "./asset";
@@ -32,3 +34,4 @@ export { order } from "./order";
 export { app } from "./appObjects";
 export { attestations } from "./attestations";
 export { containers } from "./containers";
+export { loyalty } from "./loyalty";

package/dist/api/index.js

@@ -1,7 +1,9 @@
 // src/api/index.ts
 // Re-export all resource namespaces so the consumer can import them in one line.
 export { collection } from "./collection";
+export { facets } from "./facets";
 export { product } from "./product";
+export { products } from "./products";
 export { proof } from "./proof";
 export { appConfiguration, userAppData } from "./appConfiguration";
 export { asset } from "./asset";
@@ -35,3 +37,4 @@ export { order } from "./order";
 export { app } from "./appObjects";
 export { attestations } from "./attestations";
 export { containers } from "./containers";
+export { loyalty } from "./loyalty";

package/dist/api/loyalty.d.ts

@@ -0,0 +1,65 @@
+import type { LoyaltyScheme, LoyaltyMember, LoyaltyTransaction, LoyaltyEarningRule, LoyaltySchemeWithMembership, LoyaltyTransactionResult, LoyaltyPaginationParams, LoyaltyPaginatedResult, CreateLoyaltySchemeBody, UpdateLoyaltySchemeBody, CreateLoyaltyEarningRuleBody, UpdateLoyaltyEarningRuleBody, RecordLoyaltyTransactionBody } from "../types/loyalty";
+export declare namespace loyalty {
+    function list(collectionId: string, params?: {
+        includeDeleted?: boolean;
+    }): Promise<LoyaltyScheme[]>;
+    function get(collectionId: string, schemeId: string): Promise<LoyaltyScheme>;
+    function create(collectionId: string, body: CreateLoyaltySchemeBody): Promise<LoyaltyScheme>;
+    function update(collectionId: string, schemeId: string, body: UpdateLoyaltySchemeBody): Promise<LoyaltyScheme>;
+    function remove(collectionId: string, schemeId: string): Promise<LoyaltyScheme>;
+    function listEarningRules(collectionId: string, schemeId: string): Promise<LoyaltyEarningRule[]>;
+    function getEarningRule(collectionId: string, schemeId: string, ruleId: string): Promise<LoyaltyEarningRule>;
+    function createEarningRule(collectionId: string, schemeId: string, body: CreateLoyaltyEarningRuleBody): Promise<LoyaltyEarningRule>;
+    function updateEarningRule(collectionId: string, schemeId: string, ruleId: string, body: UpdateLoyaltyEarningRuleBody): Promise<LoyaltyEarningRule>;
+    function removeEarningRule(collectionId: string, schemeId: string, ruleId: string): Promise<LoyaltyEarningRule>;
+    function listMembers(collectionId: string, schemeId: string, params?: LoyaltyPaginationParams): Promise<LoyaltyPaginatedResult<LoyaltyMember>>;
+    function getMember(collectionId: string, schemeId: string, contactId: string): Promise<LoyaltyMember>;
+    /**
+     * Manually award or deduct points for a contact.
+     *
+     * - `points` must be a non-zero integer
+     * - Positive = award, negative = deduct
+     * - Deducting below zero returns HTTP 422 `INSUFFICIENT_BALANCE`
+     * - Supply `idempotencyKey` to safely retry without double-crediting
+     *
+     * Points earned via interaction events are awarded automatically by the
+     * server — this endpoint is for manual adjustments and admin overrides.
+     */
+    function recordTransaction(collectionId: string, schemeId: string, contactId: string, body: RecordLoyaltyTransactionBody): Promise<LoyaltyTransactionResult>;
+    function getMemberHistory(collectionId: string, schemeId: string, contactId: string, params?: LoyaltyPaginationParams): Promise<LoyaltyPaginatedResult<LoyaltyTransaction>>;
+    /**
+     * List active schemes for a collection. No authentication required.
+     */
+    function publicList(collectionId: string): Promise<LoyaltyScheme[]>;
+    /**
+     * Get a single active scheme. No authentication required.
+     */
+    function publicGet(collectionId: string, schemeId: string): Promise<LoyaltyScheme>;
+    /**
+     * List active earning rules for a scheme — useful for showing "how to earn"
+     * in a loyalty UI. No authentication required.
+     */
+    function publicListEarningRules(collectionId: string, schemeId: string): Promise<LoyaltyEarningRule[]>;
+    /**
+     * Get all active schemes with the caller's membership embedded in each.
+     *
+     * This is the primary entry point for a loyalty widget — one call gives
+     * you everything needed to render a user's loyalty status across all
+     * programs in a collection.
+     *
+     * - Authenticated: `member` is populated with balance + lifetimePoints
+     *   (or null if not yet enrolled in that scheme)
+     * - Unauthenticated: `member` is null on all schemes
+     */
+    function publicGetMe(collectionId: string): Promise<LoyaltySchemeWithMembership[]>;
+    /**
+     * Get the authenticated caller's membership (balance + lifetimePoints)
+     * on a specific scheme. Requires authentication.
+     */
+    function publicGetMine(collectionId: string, schemeId: string): Promise<LoyaltyMember>;
+    /**
+     * Get the authenticated caller's transaction history on a specific scheme.
+     * Ordered newest first. Requires authentication.
+     */
+    function publicGetMineHistory(collectionId: string, schemeId: string, params?: LoyaltyPaginationParams): Promise<LoyaltyPaginatedResult<LoyaltyTransaction>>;
+}

package/dist/api/loyalty.js

@@ -0,0 +1,139 @@
+// src/api/loyalty.ts
+import { request, post, patch, del } from "../http";
+function encodeQuery(params) {
+    const q = new URLSearchParams();
+    for (const [k, v] of Object.entries(params)) {
+        if (v !== undefined)
+            q.set(k, String(v));
+    }
+    const s = q.toString();
+    return s ? `?${s}` : "";
+}
+export var loyalty;
+(function (loyalty) {
+    // ── Admin — Schemes ───────────────────────────────────────────────────────────
+    async function list(collectionId, params = {}) {
+        return request(`/admin/collection/${encodeURIComponent(collectionId)}/loyaltyScheme${encodeQuery(params)}`);
+    }
+    loyalty.list = list;
+    async function get(collectionId, schemeId) {
+        return request(`/admin/collection/${encodeURIComponent(collectionId)}/loyaltyScheme/${encodeURIComponent(schemeId)}`);
+    }
+    loyalty.get = get;
+    async function create(collectionId, body) {
+        return post(`/admin/collection/${encodeURIComponent(collectionId)}/loyaltyScheme`, body);
+    }
+    loyalty.create = create;
+    async function update(collectionId, schemeId, body) {
+        return patch(`/admin/collection/${encodeURIComponent(collectionId)}/loyaltyScheme/${encodeURIComponent(schemeId)}`, body);
+    }
+    loyalty.update = update;
+    async function remove(collectionId, schemeId) {
+        return del(`/admin/collection/${encodeURIComponent(collectionId)}/loyaltyScheme/${encodeURIComponent(schemeId)}`);
+    }
+    loyalty.remove = remove;
+    // ── Admin — Earning Rules ─────────────────────────────────────────────────────
+    async function listEarningRules(collectionId, schemeId) {
+        return request(`/admin/collection/${encodeURIComponent(collectionId)}/loyaltyScheme/${encodeURIComponent(schemeId)}/earningRule`);
+    }
+    loyalty.listEarningRules = listEarningRules;
+    async function getEarningRule(collectionId, schemeId, ruleId) {
+        return request(`/admin/collection/${encodeURIComponent(collectionId)}/loyaltyScheme/${encodeURIComponent(schemeId)}/earningRule/${encodeURIComponent(ruleId)}`);
+    }
+    loyalty.getEarningRule = getEarningRule;
+    async function createEarningRule(collectionId, schemeId, body) {
+        return post(`/admin/collection/${encodeURIComponent(collectionId)}/loyaltyScheme/${encodeURIComponent(schemeId)}/earningRule`, body);
+    }
+    loyalty.createEarningRule = createEarningRule;
+    async function updateEarningRule(collectionId, schemeId, ruleId, body) {
+        return patch(`/admin/collection/${encodeURIComponent(collectionId)}/loyaltyScheme/${encodeURIComponent(schemeId)}/earningRule/${encodeURIComponent(ruleId)}`, body);
+    }
+    loyalty.updateEarningRule = updateEarningRule;
+    async function removeEarningRule(collectionId, schemeId, ruleId) {
+        return del(`/admin/collection/${encodeURIComponent(collectionId)}/loyaltyScheme/${encodeURIComponent(schemeId)}/earningRule/${encodeURIComponent(ruleId)}`);
+    }
+    loyalty.removeEarningRule = removeEarningRule;
+    // ── Admin — Members ───────────────────────────────────────────────────────────
+    async function listMembers(collectionId, schemeId, params = {}) {
+        return request(`/admin/collection/${encodeURIComponent(collectionId)}/loyaltyScheme/${encodeURIComponent(schemeId)}/member${encodeQuery(params)}`);
+    }
+    loyalty.listMembers = listMembers;
+    async function getMember(collectionId, schemeId, contactId) {
+        return request(`/admin/collection/${encodeURIComponent(collectionId)}/loyaltyScheme/${encodeURIComponent(schemeId)}/member/${encodeURIComponent(contactId)}`);
+    }
+    loyalty.getMember = getMember;
+    // ── Admin — Transactions ──────────────────────────────────────────────────────
+    /**
+     * Manually award or deduct points for a contact.
+     *
+     * - `points` must be a non-zero integer
+     * - Positive = award, negative = deduct
+     * - Deducting below zero returns HTTP 422 `INSUFFICIENT_BALANCE`
+     * - Supply `idempotencyKey` to safely retry without double-crediting
+     *
+     * Points earned via interaction events are awarded automatically by the
+     * server — this endpoint is for manual adjustments and admin overrides.
+     */
+    async function recordTransaction(collectionId, schemeId, contactId, body) {
+        return post(`/admin/collection/${encodeURIComponent(collectionId)}/loyaltyScheme/${encodeURIComponent(schemeId)}/member/${encodeURIComponent(contactId)}/transaction`, body);
+    }
+    loyalty.recordTransaction = recordTransaction;
+    async function getMemberHistory(collectionId, schemeId, contactId, params = {}) {
+        return request(`/admin/collection/${encodeURIComponent(collectionId)}/loyaltyScheme/${encodeURIComponent(schemeId)}/member/${encodeURIComponent(contactId)}/history${encodeQuery(params)}`);
+    }
+    loyalty.getMemberHistory = getMemberHistory;
+    // ── Public ────────────────────────────────────────────────────────────────────
+    /**
+     * List active schemes for a collection. No authentication required.
+     */
+    async function publicList(collectionId) {
+        return request(`/public/collection/${encodeURIComponent(collectionId)}/loyaltyScheme`);
+    }
+    loyalty.publicList = publicList;
+    /**
+     * Get a single active scheme. No authentication required.
+     */
+    async function publicGet(collectionId, schemeId) {
+        return request(`/public/collection/${encodeURIComponent(collectionId)}/loyaltyScheme/${encodeURIComponent(schemeId)}`);
+    }
+    loyalty.publicGet = publicGet;
+    /**
+     * List active earning rules for a scheme — useful for showing "how to earn"
+     * in a loyalty UI. No authentication required.
+     */
+    async function publicListEarningRules(collectionId, schemeId) {
+        return request(`/public/collection/${encodeURIComponent(collectionId)}/loyaltyScheme/${encodeURIComponent(schemeId)}/earningRule`);
+    }
+    loyalty.publicListEarningRules = publicListEarningRules;
+    /**
+     * Get all active schemes with the caller's membership embedded in each.
+     *
+     * This is the primary entry point for a loyalty widget — one call gives
+     * you everything needed to render a user's loyalty status across all
+     * programs in a collection.
+     *
+     * - Authenticated: `member` is populated with balance + lifetimePoints
+     *   (or null if not yet enrolled in that scheme)
+     * - Unauthenticated: `member` is null on all schemes
+     */
+    async function publicGetMe(collectionId) {
+        return request(`/public/collection/${encodeURIComponent(collectionId)}/loyaltyScheme/me`);
+    }
+    loyalty.publicGetMe = publicGetMe;
+    /**
+     * Get the authenticated caller's membership (balance + lifetimePoints)
+     * on a specific scheme. Requires authentication.
+     */
+    async function publicGetMine(collectionId, schemeId) {
+        return request(`/public/collection/${encodeURIComponent(collectionId)}/loyaltyScheme/${encodeURIComponent(schemeId)}/member/me`);
+    }
+    loyalty.publicGetMine = publicGetMine;
+    /**
+     * Get the authenticated caller's transaction history on a specific scheme.
+     * Ordered newest first. Requires authentication.
+     */
+    async function publicGetMineHistory(collectionId, schemeId, params = {}) {
+        return request(`/public/collection/${encodeURIComponent(collectionId)}/loyaltyScheme/${encodeURIComponent(schemeId)}/member/me/history${encodeQuery(params)}`);
+    }
+    loyalty.publicGetMineHistory = publicGetMineHistory;
+})(loyalty || (loyalty = {}));

package/dist/api/product.d.ts

@@ -1,6 +1,8 @@
-import { ProductResponse, ProductCreateRequest, ProductUpdateRequest } from "../types/product";
+import { JsonValue, ProductClaimCreateRequestBody, ProductCreateRequest, ProductQueryRequest, ProductQueryResponse, ProductResponse, ProductUpdateRequest } from "../types/product";
+type ProductPublicFindParams = Record<string, string | number | boolean | null | undefined | Array<string | number | boolean>>;
 export declare namespace product {
     /**
+    * @deprecated Use `products.get(...)`.
      * 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
@@ -10,6 +12,7 @@ export declare namespace product {
      */
     function get(collectionId: string, productId: string, admin?: boolean): Promise<ProductResponse>;
     /**
+     * @deprecated Use `products.list(...)`.
      * List all Product Items for a Collection.
      * @param collectionId – Identifier of the parent collection
      * @param admin        – If true, use admin endpoint; otherwise, use public
@@ -18,6 +21,7 @@ export declare namespace product {
      */
     function list(collectionId: string, admin?: boolean): Promise<ProductResponse[]>;
     /**
+     * @deprecated Use `products.create(...)`.
      * Create a new product for a collection (admin only).
      * The `data` payload follows the same shape as ProductResponse minus `id` and `collectionId`.
      *
@@ -45,6 +49,7 @@ export declare namespace product {
      */
     function create(collectionId: string, data: ProductCreateRequest): Promise<ProductResponse>;
     /**
+     * @deprecated Use `products.update(...)`.
      * Update a product for a collection (admin only).
      * The `data` payload is a partial of ProductResponse minus `id` and `collectionId`.
      *
@@ -69,6 +74,7 @@ export declare namespace product {
      */
     function update(collectionId: string, productId: string, data: ProductUpdateRequest): Promise<ProductResponse>;
     /**
+     * @deprecated Use `products.remove(...)`.
      * Delete a product for a collection (admin only).
      * @param collectionId – Identifier of the parent collection
      * @param productId – Identifier of the product
@@ -77,6 +83,39 @@ export declare namespace product {
      */
     function remove(collectionId: string, productId: string): Promise<void>;
     /**
+     * @deprecated Use `products.query(...)`.
+     */
+    function query(collectionId: string, body: ProductQueryRequest): Promise<ProductQueryResponse>;
+    /**
+     * @deprecated Use `products.find(...)` for admin or `products.publicFind(...)` for public access.
+     */
+    function find(collectionId: string, body: ProductQueryRequest): Promise<ProductQueryResponse>;
+    /**
+     * @deprecated Use `products.publicFind(...)`.
+     */
+    function publicFind(collectionId: string, params?: ProductPublicFindParams): Promise<ProductResponse[]>;
+    /**
+     * @deprecated Use `products.clone(...)`.
+     */
+    function clone(collectionId: string, productId: string, body?: Record<string, JsonValue>): Promise<ProductResponse>;
+    /**
+     * @deprecated Use `products.listAssets(...)`.
+     */
+    function listAssets(collectionId: string, productId: string, admin?: boolean): Promise<unknown>;
+    /**
+     * @deprecated Use `products.createClaimWindow(...)`.
+     */
+    function createClaimWindow(collectionId: string, productId: string, body: Record<string, JsonValue>): Promise<unknown>;
+    /**
+     * @deprecated Use `products.updateClaimWindow(...)`.
+     */
+    function updateClaimWindow(collectionId: string, productId: string, claimId: string, body: Record<string, JsonValue>): Promise<unknown>;
+    /**
+     * @deprecated Use `products.refresh(...)`.
+     */
+    function refresh(collectionId: string, productId: string): Promise<ProductResponse>;
+    /**
+     * @deprecated Use `products.getSN(...)`.
      * Get serial numbers for a product (admin only).
      * @param collectionId - Identifier of the parent collection
      * @param productId - Identifier of the product
@@ -85,8 +124,9 @@ export declare namespace product {
      * @returns Promise resolving to serial number data
      * @throws ErrorResponse if the request fails
      */
-    function getSN(collectionId: string, productId: string, startIndex?: number, count?: number): Promise<any>;
+    function getSN(collectionId: string, productId: string, startIndex?: number, count?: number): Promise<unknown>;
     /**
+     * @deprecated Use `products.lookupSN(...)`.
      * Look up a serial number by code for a product (admin only).
      * @param collectionId - Identifier of the parent collection
      * @param productId - Identifier of the product
@@ -94,5 +134,14 @@ export declare namespace product {
      * @returns Promise resolving to serial number lookup data
      * @throws ErrorResponse if the request fails
      */
-    function lookupSN(collectionId: string, productId: string, codeId: string): Promise<any>;
+    function lookupSN(collectionId: string, productId: string, codeId: string): Promise<unknown>;
+    /**
+     * @deprecated Use `products.publicLookupClaim(...)`.
+     */
+    function publicLookupClaim(collectionId: string, productId: string, claimId: string): Promise<unknown>;
+    /**
+     * @deprecated Use `products.publicCreateClaim(...)`.
+     */
+    function publicCreateClaim(collectionId: string, productId: string, body: ProductClaimCreateRequestBody): Promise<unknown>;
 }
+export {};

package/dist/api/product.js

@@ -3,6 +3,7 @@ import { request, post, put, del } from "../http";
 export var product;
 (function (product) {
     /**
+    * @deprecated Use `products.get(...)`.
      * 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
@@ -17,6 +18,7 @@ export var product;
     }
     product.get = get;
     /**
+     * @deprecated Use `products.list(...)`.
      * List all Product Items for a Collection.
      * @param collectionId – Identifier of the parent collection
      * @param admin        – If true, use admin endpoint; otherwise, use public
@@ -30,6 +32,7 @@ export var product;
     }
     product.list = list;
     /**
+     * @deprecated Use `products.create(...)`.
      * Create a new product for a collection (admin only).
      * The `data` payload follows the same shape as ProductResponse minus `id` and `collectionId`.
      *
@@ -61,6 +64,7 @@ export var product;
     }
     product.create = create;
     /**
+     * @deprecated Use `products.update(...)`.
      * Update a product for a collection (admin only).
      * The `data` payload is a partial of ProductResponse minus `id` and `collectionId`.
      *
@@ -89,6 +93,7 @@ export var product;
     }
     product.update = update;
     /**
+     * @deprecated Use `products.remove(...)`.
      * Delete a product for a collection (admin only).
      * @param collectionId – Identifier of the parent collection
      * @param productId – Identifier of the product
@@ -101,6 +106,87 @@ export var product;
     }
     product.remove = remove;
     /**
+     * @deprecated Use `products.query(...)`.
+     */
+    async function query(collectionId, body) {
+        const path = `/admin/collection/${encodeURIComponent(collectionId)}/product/query`;
+        return post(path, body);
+    }
+    product.query = query;
+    /**
+     * @deprecated Use `products.find(...)` for admin or `products.publicFind(...)` for public access.
+     */
+    async function find(collectionId, body) {
+        const path = `/admin/collection/${encodeURIComponent(collectionId)}/product/find`;
+        return post(path, body);
+    }
+    product.find = find;
+    /**
+     * @deprecated Use `products.publicFind(...)`.
+     */
+    async function publicFind(collectionId, params) {
+        const searchParams = new URLSearchParams();
+        if (params) {
+            for (const [key, value] of Object.entries(params)) {
+                if (value === undefined || value === null)
+                    continue;
+                if (Array.isArray(value)) {
+                    for (const item of value)
+                        searchParams.append(key, String(item));
+                }
+                else {
+                    searchParams.set(key, String(value));
+                }
+            }
+        }
+        const query = searchParams.toString();
+        const path = `/public/collection/${encodeURIComponent(collectionId)}/product/find${query ? `?${query}` : ''}`;
+        return request(path);
+    }
+    product.publicFind = publicFind;
+    /**
+     * @deprecated Use `products.clone(...)`.
+     */
+    async function clone(collectionId, productId, body = {}) {
+        const path = `/admin/collection/${encodeURIComponent(collectionId)}/product/${encodeURIComponent(productId)}/clone`;
+        return post(path, body);
+    }
+    product.clone = clone;
+    /**
+     * @deprecated Use `products.listAssets(...)`.
+     */
+    async function listAssets(collectionId, productId, admin) {
+        const base = admin ? '/admin' : '/public';
+        const path = `${base}/collection/${encodeURIComponent(collectionId)}/product/${encodeURIComponent(productId)}/asset`;
+        return request(path);
+    }
+    product.listAssets = listAssets;
+    /**
+     * @deprecated Use `products.createClaimWindow(...)`.
+     */
+    async function createClaimWindow(collectionId, productId, body) {
+        const path = `/admin/collection/${encodeURIComponent(collectionId)}/product/${encodeURIComponent(productId)}/claimWindow`;
+        return post(path, body);
+    }
+    product.createClaimWindow = createClaimWindow;
+    /**
+     * @deprecated Use `products.updateClaimWindow(...)`.
+     */
+    async function updateClaimWindow(collectionId, productId, claimId, body) {
+        const path = `/admin/collection/${encodeURIComponent(collectionId)}/product/${encodeURIComponent(productId)}/claimWindow/${encodeURIComponent(claimId)}`;
+        return put(path, body);
+    }
+    product.updateClaimWindow = updateClaimWindow;
+    /**
+     * @deprecated Use `products.refresh(...)`.
+     */
+    async function refresh(collectionId, productId) {
+        const path = `/admin/collection/${encodeURIComponent(collectionId)}/product/${encodeURIComponent(productId)}/refresh`;
+        return request(path);
+    }
+    product.refresh = refresh;
+    /**
+     * @deprecated Use `products.getSN(...)`.
      * Get serial numbers for a product (admin only).
      * @param collectionId - Identifier of the parent collection
      * @param productId - Identifier of the product
@@ -119,6 +205,7 @@ export var product;
     }
     product.getSN = getSN;
     /**
+     * @deprecated Use `products.lookupSN(...)`.
      * Look up a serial number by code for a product (admin only).
      * @param collectionId - Identifier of the parent collection
      * @param productId - Identifier of the product
@@ -131,4 +218,20 @@ export var product;
         return request(path);
     }
     product.lookupSN = lookupSN;
+    /**
+     * @deprecated Use `products.publicLookupClaim(...)`.
+     */
+    async function publicLookupClaim(collectionId, productId, claimId) {
+        const path = `/public/collection/${encodeURIComponent(collectionId)}/product/${encodeURIComponent(productId)}/lookupClaim/${encodeURIComponent(claimId)}`;
+        return request(path);
+    }
+    product.publicLookupClaim = publicLookupClaim;
+    /**
+     * @deprecated Use `products.publicCreateClaim(...)`.
+     */
+    async function publicCreateClaim(collectionId, productId, body) {
+        const path = `/public/collection/${encodeURIComponent(collectionId)}/product/${encodeURIComponent(productId)}/createClaim`;
+        return post(path, body);
+    }
+    product.publicCreateClaim = publicCreateClaim;
 })(product || (product = {}));

package/dist/api/products.d.ts

@@ -0,0 +1,21 @@
+import { JsonValue, ProductClaimCreateRequestBody, ProductCreateRequest, ProductQueryRequest, ProductQueryResponse, ProductResponse, ProductUpdateRequest } from "../types/product";
+export type ProductPublicFindParams = Record<string, string | number | boolean | null | undefined | Array<string | number | boolean>>;
+export declare namespace products {
+    function get(collectionId: string, productId: string, admin?: boolean): Promise<ProductResponse>;
+    function list(collectionId: string, admin?: boolean): Promise<ProductResponse[]>;
+    function create(collectionId: string, data: ProductCreateRequest): Promise<ProductResponse>;
+    function update(collectionId: string, productId: string, data: ProductUpdateRequest): Promise<ProductResponse>;
+    function remove(collectionId: string, productId: string): Promise<void>;
+    function query(collectionId: string, body: ProductQueryRequest): Promise<ProductQueryResponse>;
+    function find(collectionId: string, body: ProductQueryRequest | Record<string, JsonValue>): Promise<ProductQueryResponse>;
+    function publicFind(collectionId: string, params?: ProductPublicFindParams): Promise<ProductResponse[]>;
+    function clone(collectionId: string, productId: string, body?: Record<string, JsonValue>): Promise<ProductResponse>;
+    function listAssets(collectionId: string, productId: string, admin?: boolean): Promise<unknown>;
+    function createClaimWindow(collectionId: string, productId: string, body: Record<string, JsonValue>): Promise<unknown>;
+    function updateClaimWindow(collectionId: string, productId: string, claimId: string, body: Record<string, JsonValue>): Promise<unknown>;
+    function refresh(collectionId: string, productId: string): Promise<ProductResponse>;
+    function getSN(collectionId: string, productId: string, startIndex?: number, count?: number): Promise<unknown>;
+    function lookupSN(collectionId: string, productId: string, codeId: string): Promise<unknown>;
+    function publicLookupClaim(collectionId: string, productId: string, claimId: string): Promise<unknown>;
+    function publicCreateClaim(collectionId: string, productId: string, body: ProductClaimCreateRequestBody): Promise<unknown>;
+}