@proveanything/smartlinks 1.15.23 → 1.15.24

package/dist/docs/API_SUMMARY.md

@@ -1,6 +1,6 @@
 # Smartlinks API Summary
 
-Version: 1.15.23  |  Generated: 2026-08-28T10:57:24.158Z
+Version: 1.15.24  |  Generated: 2026-08-31T17:50:11.496Z
 
 This is a concise summary of all available API functions and types.
 
@@ -7531,6 +7531,23 @@ interface InteractionFilterValue {
 }
 ```
 
+**OwnershipAttributePredicate** (interface)
+```typescript
+interface OwnershipAttributePredicate {
+  path: string
+  operator: OwnershipAttributeOperator
+  value?: string | number
+}
+```
+
+**OwnershipFacetSelector** (interface)
+```typescript
+interface OwnershipFacetSelector {
+  key: string
+  value: string
+}
+```
+
 **SegmentRecord** (interface)
 ```typescript
 interface SegmentRecord {
@@ -7591,6 +7608,10 @@ interface SegmentRecipientsResponse {
 }
 ```
 
+**CustomFieldOperator** = ``
+
+**OwnershipAttributeOperator** = `'equals' | 'exists' | 'gt' | 'gte' | 'lt' | 'lte'`
+
 **SegmentFilterRule** = ``
 
 ### tags
@@ -8283,7 +8304,12 @@ interface Gs1DigitalLinkParams {
   gtin?: string
   product?: Product
   ownGtin?: boolean
+  * A real GS1 **Consumer Product Variant** code (AI 22). Use this when the brand has a
+  * genuine CPV. Takes precedence over `variant` when both are given.
   cpv?: string | { id: string }
+  * Internal variant id, emitted as AI 22 (the SmartLinks resolver reads path segment 22
+  * as the variant). Prefer `cpv` when you have a real GS1 CPV code — a non-CPV variant id
+  * in AI 22 is only meaningful to the SmartLinks resolver, not to third-party GS1 resolvers.
   variant?: string | { id: string }
   lot?: string | { id: string }
   batch?: BatchResponse | string

package/dist/docs/utils.md

@@ -233,7 +233,8 @@ otherwise).
 | Input | AI | Notes |
 |-------|----|-------|
 | `gtin` / `product.gtin` | 01 | Primary identifier (required) |
-| `cpv` / `variant` | 22 | Consumer Product Variant (path) |
+| `cpv` | 22 | Real GS1 Consumer Product Variant code (path). Wins over `variant`. |
+| `variant` | 22 | Internal variant id, emitted as AI 22 for the SmartLinks resolver. Use `cpv` for a genuine GS1 CPV. |
 | `lot` / `batch` | 10 | Batch/lot (path); a batch object also supplies its expiry |
 | `serial` | 21 | Specific item — a string, or an object (`serialNumber` ?? `id`, e.g. a proof / serial / virtual id) |
 | `expiry` | 17 | Date → `YYMMDD` (query) |

package/dist/openapi.yaml

@@ -25340,6 +25340,29 @@ components:
           type: string
       required:
         - interactionId
+    OwnershipAttributePredicate:
+      type: object
+      properties:
+        path:
+          type: string
+        operator:
+          $ref: "#/components/schemas/OwnershipAttributeOperator"
+        value:
+          type: object
+          additionalProperties: true
+      required:
+        - path
+        - operator
+    OwnershipFacetSelector:
+      type: object
+      properties:
+        key:
+          type: string
+        value:
+          type: string
+      required:
+        - key
+        - value
     SegmentRecord:
       type: object
       properties:
@@ -25445,6 +25468,25 @@ components:
         - limit
         - offset
         - total
+    CustomFieldOperator:
+      type: string
+      enum:
+        - equals
+        - exists
+        - gt
+        - gte
+        - lt
+        - lte
+        - before
+        - after
+        - within_days
+        - older_than_days
+        - "s JSON. Numeric ops (gt/gte/lt/lte) compare as a number. export type OwnershipAttributeOperator = "
+        - " | "
+        - " | "
+        - " | "
+        - " | "
+        - " | "
     Tag:
       type: object
       properties:

package/dist/types/segments.d.ts

@@ -5,6 +5,18 @@ export interface InteractionFilterValue {
     from?: string;
     to?: string;
 }
+export type CustomFieldOperator = 'equals' | 'exists' | 'gt' | 'gte' | 'lt' | 'lte' | 'before' | 'after' | 'within_days' | 'older_than_days';
+export type OwnershipAttributeOperator = 'equals' | 'exists' | 'gt' | 'gte' | 'lt' | 'lte';
+export interface OwnershipAttributePredicate {
+    path: string;
+    operator: OwnershipAttributeOperator;
+    /** Operand: a number for gt/gte/lt/lte, a string for equals; omitted for exists. */
+    value?: string | number;
+}
+export interface OwnershipFacetSelector {
+    key: string;
+    value: string;
+}
 export type SegmentFilterRule = {
     field: 'interaction';
     op: 'had' | 'exists';
@@ -28,6 +40,19 @@ export type SegmentFilterRule = {
         from?: string;
         to?: string;
     };
+} | {
+    type: 'custom_field';
+    field: string;
+    operator: CustomFieldOperator;
+    value?: string | number;
+} | {
+    type: 'ownership';
+    productId?: string;
+    facet?: OwnershipFacetSelector;
+    attribute?: OwnershipAttributePredicate;
+    olderThanDays?: number;
+    withinDays?: number;
+    includeDeleted?: boolean;
 } | {
     type: 'interaction';
     interactionId: string;

package/dist/utils/paths.d.ts

@@ -116,11 +116,18 @@ export interface Gs1DigitalLinkParams {
     product?: Product;
     /** Override the global-owner flag; otherwise read from `product.ownGtin`. */
     ownGtin?: boolean;
-    /** Consumer Product Variant (AI 22). A string or an object with `id`. */
+    /**
+     * A real GS1 **Consumer Product Variant** code (AI 22). Use this when the brand has a
+     * genuine CPV. Takes precedence over `variant` when both are given.
+     */
     cpv?: string | {
         id: string;
     };
-    /** Alias of `cpv` (AI 22). */
+    /**
+     * Internal variant id, emitted as AI 22 (the SmartLinks resolver reads path segment 22
+     * as the variant). Prefer `cpv` when you have a real GS1 CPV code — a non-CPV variant id
+     * in AI 22 is only meaningful to the SmartLinks resolver, not to third-party GS1 resolvers.
+     */
     variant?: string | {
         id: string;
     };

package/docs/API_SUMMARY.md

@@ -1,6 +1,6 @@
 # Smartlinks API Summary
 
-Version: 1.15.23  |  Generated: 2026-08-28T10:57:24.158Z
+Version: 1.15.24  |  Generated: 2026-08-31T17:50:11.496Z
 
 This is a concise summary of all available API functions and types.
 
@@ -7531,6 +7531,23 @@ interface InteractionFilterValue {
 }
 ```
 
+**OwnershipAttributePredicate** (interface)
+```typescript
+interface OwnershipAttributePredicate {
+  path: string
+  operator: OwnershipAttributeOperator
+  value?: string | number
+}
+```
+
+**OwnershipFacetSelector** (interface)
+```typescript
+interface OwnershipFacetSelector {
+  key: string
+  value: string
+}
+```
+
 **SegmentRecord** (interface)
 ```typescript
 interface SegmentRecord {
@@ -7591,6 +7608,10 @@ interface SegmentRecipientsResponse {
 }
 ```
 
+**CustomFieldOperator** = ``
+
+**OwnershipAttributeOperator** = `'equals' | 'exists' | 'gt' | 'gte' | 'lt' | 'lte'`
+
 **SegmentFilterRule** = ``
 
 ### tags
@@ -8283,7 +8304,12 @@ interface Gs1DigitalLinkParams {
   gtin?: string
   product?: Product
   ownGtin?: boolean
+  * A real GS1 **Consumer Product Variant** code (AI 22). Use this when the brand has a
+  * genuine CPV. Takes precedence over `variant` when both are given.
   cpv?: string | { id: string }
+  * Internal variant id, emitted as AI 22 (the SmartLinks resolver reads path segment 22
+  * as the variant). Prefer `cpv` when you have a real GS1 CPV code — a non-CPV variant id
+  * in AI 22 is only meaningful to the SmartLinks resolver, not to third-party GS1 resolvers.
   variant?: string | { id: string }
   lot?: string | { id: string }
   batch?: BatchResponse | string

package/docs/utils.md

@@ -233,7 +233,8 @@ otherwise).
 | Input | AI | Notes |
 |-------|----|-------|
 | `gtin` / `product.gtin` | 01 | Primary identifier (required) |
-| `cpv` / `variant` | 22 | Consumer Product Variant (path) |
+| `cpv` | 22 | Real GS1 Consumer Product Variant code (path). Wins over `variant`. |
+| `variant` | 22 | Internal variant id, emitted as AI 22 for the SmartLinks resolver. Use `cpv` for a genuine GS1 CPV. |
 | `lot` / `batch` | 10 | Batch/lot (path); a batch object also supplies its expiry |
 | `serial` | 21 | Specific item — a string, or an object (`serialNumber` ?? `id`, e.g. a proof / serial / virtual id) |
 | `expiry` | 17 | Date → `YYMMDD` (query) |

package/openapi.yaml

@@ -25340,6 +25340,29 @@ components:
           type: string
       required:
         - interactionId
+    OwnershipAttributePredicate:
+      type: object
+      properties:
+        path:
+          type: string
+        operator:
+          $ref: "#/components/schemas/OwnershipAttributeOperator"
+        value:
+          type: object
+          additionalProperties: true
+      required:
+        - path
+        - operator
+    OwnershipFacetSelector:
+      type: object
+      properties:
+        key:
+          type: string
+        value:
+          type: string
+      required:
+        - key
+        - value
     SegmentRecord:
       type: object
       properties:
@@ -25445,6 +25468,25 @@ components:
         - limit
         - offset
         - total
+    CustomFieldOperator:
+      type: string
+      enum:
+        - equals
+        - exists
+        - gt
+        - gte
+        - lt
+        - lte
+        - before
+        - after
+        - within_days
+        - older_than_days
+        - "s JSON. Numeric ops (gt/gte/lt/lte) compare as a number. export type OwnershipAttributeOperator = "
+        - " | "
+        - " | "
+        - " | "
+        - " | "
+        - " | "
     Tag:
       type: object
       properties:

package/package.json

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