@proveanything/smartlinks 1.3.24 → 1.3.26

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,6 +1,6 @@
1
1
  # Smartlinks API Summary
2
2
 
3
- Version: 1.3.24 | Generated: 2026-02-13T14:31:22.778Z
3
+ Version: 1.3.26 | Generated: 2026-02-14T08:48:11.873Z
4
4
 
5
5
  This is a concise summary of all available API functions and types.
6
6
 
@@ -924,6 +924,7 @@ interface Collection {
924
924
  redirectUrl?: string // Whether the collection has a custom domain
925
925
  shortId: string, // The shortId of this collection
926
926
  dark?: boolean // if dark mode is enabled for this collection
927
+ portalUrl?: string // URL for the collection's portal (if applicable)
927
928
  }
928
929
  ```
929
930
 
@@ -2877,6 +2878,17 @@ interface AblyTokenRequest {
2877
2878
 
2878
2879
  ### segments
2879
2880
 
2881
+ **InteractionFilterValue** (interface)
2882
+ ```typescript
2883
+ interface InteractionFilterValue {
2884
+ interactionId: string
2885
+ scope?: string // ← NEW: Scope filtering
2886
+ outcome?: string
2887
+ from?: string // ISO date string
2888
+ to?: string // ISO date string
2889
+ }
2890
+ ```
2891
+
2880
2892
  **SegmentRecord** (interface)
2881
2893
  ```typescript
2882
2894
  interface SegmentRecord {
@@ -2889,7 +2901,7 @@ interface SegmentRecord {
2889
2901
  lastCalculatedAt?: string
2890
2902
  createdAt: string
2891
2903
  data?: {
2892
- filterRules: any[]
2904
+ filterRules: SegmentFilterRule[]
2893
2905
  description?: string
2894
2906
  staticContactIds?: string[]
2895
2907
  [key: string]: unknown
@@ -2937,6 +2949,8 @@ interface SegmentRecipientsResponse {
2937
2949
  }
2938
2950
  ```
2939
2951
 
2952
+ **SegmentFilterRule** = ``
2953
+
2940
2954
  ### tags
2941
2955
 
2942
2956
  **Tag** (interface)
@@ -62,6 +62,7 @@ export interface Collection {
62
62
  shortId: string;
63
63
  /** if dark mode is enabled for this collection */
64
64
  dark?: boolean;
65
+ portalUrl?: string;
65
66
  }
66
67
  export type CollectionResponse = Collection;
67
68
  export type CollectionCreateRequest = Omit<Collection, 'id' | 'shortId'>;
@@ -1,3 +1,41 @@
1
+ export interface InteractionFilterValue {
2
+ interactionId: string;
3
+ scope?: string;
4
+ outcome?: string;
5
+ from?: string;
6
+ to?: string;
7
+ }
8
+ export type SegmentFilterRule = {
9
+ field: 'interaction';
10
+ op: 'had' | 'exists';
11
+ value: InteractionFilterValue;
12
+ } | {
13
+ field: 'tags';
14
+ op: 'hasSome';
15
+ value: string[];
16
+ } | {
17
+ field: 'locale';
18
+ op: 'equals';
19
+ value: string;
20
+ } | {
21
+ field: 'source';
22
+ op: 'equals';
23
+ value: string;
24
+ } | {
25
+ field: 'createdAt';
26
+ op: 'between';
27
+ value: {
28
+ from?: string;
29
+ to?: string;
30
+ };
31
+ } | {
32
+ type: 'interaction';
33
+ interactionId: string;
34
+ scope?: string;
35
+ outcome?: string;
36
+ from?: string;
37
+ to?: string;
38
+ };
1
39
  export interface SegmentRecord {
2
40
  id: string;
3
41
  collectionId: string;
@@ -8,7 +46,7 @@ export interface SegmentRecord {
8
46
  lastCalculatedAt?: string;
9
47
  createdAt: string;
10
48
  data?: {
11
- filterRules: any[];
49
+ filterRules: SegmentFilterRule[];
12
50
  description?: string;
13
51
  staticContactIds?: string[];
14
52
  [key: string]: unknown;
@@ -1,6 +1,6 @@
1
1
  # Smartlinks API Summary
2
2
 
3
- Version: 1.3.24 | Generated: 2026-02-13T14:31:22.778Z
3
+ Version: 1.3.26 | Generated: 2026-02-14T08:48:11.873Z
4
4
 
5
5
  This is a concise summary of all available API functions and types.
6
6
 
@@ -924,6 +924,7 @@ interface Collection {
924
924
  redirectUrl?: string // Whether the collection has a custom domain
925
925
  shortId: string, // The shortId of this collection
926
926
  dark?: boolean // if dark mode is enabled for this collection
927
+ portalUrl?: string // URL for the collection's portal (if applicable)
927
928
  }
928
929
  ```
929
930
 
@@ -2877,6 +2878,17 @@ interface AblyTokenRequest {
2877
2878
 
2878
2879
  ### segments
2879
2880
 
2881
+ **InteractionFilterValue** (interface)
2882
+ ```typescript
2883
+ interface InteractionFilterValue {
2884
+ interactionId: string
2885
+ scope?: string // ← NEW: Scope filtering
2886
+ outcome?: string
2887
+ from?: string // ISO date string
2888
+ to?: string // ISO date string
2889
+ }
2890
+ ```
2891
+
2880
2892
  **SegmentRecord** (interface)
2881
2893
  ```typescript
2882
2894
  interface SegmentRecord {
@@ -2889,7 +2901,7 @@ interface SegmentRecord {
2889
2901
  lastCalculatedAt?: string
2890
2902
  createdAt: string
2891
2903
  data?: {
2892
- filterRules: any[]
2904
+ filterRules: SegmentFilterRule[]
2893
2905
  description?: string
2894
2906
  staticContactIds?: string[]
2895
2907
  [key: string]: unknown
@@ -2937,6 +2949,8 @@ interface SegmentRecipientsResponse {
2937
2949
  }
2938
2950
  ```
2939
2951
 
2952
+ **SegmentFilterRule** = ``
2953
+
2940
2954
  ### tags
2941
2955
 
2942
2956
  **Tag** (interface)
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@proveanything/smartlinks",
3
- "version": "1.3.24",
3
+ "version": "1.3.26",
4
4
  "description": "Official JavaScript/TypeScript SDK for the Smartlinks API",
5
5
  "main": "dist/index.js",
6
6
  "types": "dist/index.d.ts",