@proveanything/smartlinks 1.3.21 → 1.3.23

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.
Files changed (4) hide show
  1. package/dist/docs/API_SUMMARY.md +20 -8
  2. package/dist/types/interaction.d.ts +14 -6
  3. package/docs/API_SUMMARY.md +20 -8
  4. package/package.json +1 -1
package/dist/docs/API_SUMMARY.md CHANGED
@@ -1,6 +1,6 @@
1
1
  # Smartlinks API Summary
2
2
 
3
- Version: 1.3.21 | Generated: 2026-02-09T12:29:22.158Z
3
+ Version: 1.3.23 | Generated: 2026-02-13T12:09:03.041Z
4
4
 
5
5
  This is a concise summary of all available API functions and types.
6
6
 
@@ -1796,6 +1796,7 @@ interface AdminInteractionsQueryRequest {
1796
1796
  contactId?: string
1797
1797
  appId?: string
1798
1798
  interactionId?: string
1799
+ scope?: string
1799
1800
  interactionIds?: string[]
1800
1801
  broadcastId?: string
1801
1802
  outcome?: string | null
@@ -1814,6 +1815,7 @@ interface AdminInteractionsQueryRequest {
1814
1815
  interface AdminInteractionsCountsByOutcomeRequest {
1815
1816
  appId?: string
1816
1817
  interactionId?: string
1818
+ scope?: string
1817
1819
  from?: string
1818
1820
  to?: string
1819
1821
  limit?: number
@@ -1827,6 +1829,7 @@ interface AdminInteractionsCountsByOutcomeRequest {
1827
1829
  interface PublicInteractionsCountsByOutcomeRequest {
1828
1830
  appId: string
1829
1831
  interactionId: string
1832
+ scope?: string
1830
1833
  from?: string
1831
1834
  to?: string
1832
1835
  limit?: number
@@ -1838,6 +1841,7 @@ interface PublicInteractionsCountsByOutcomeRequest {
1838
1841
  interface PublicInteractionsByUserRequest {
1839
1842
  appId?: string
1840
1843
  interactionId?: string
1844
+ scope?: string
1841
1845
  from?: string
1842
1846
  to?: string
1843
1847
  limit?: number
@@ -1851,7 +1855,8 @@ interface InteractionEventRow {
1851
1855
  collectionId: string
1852
1856
  timestamp: string
1853
1857
  appId?: string
1854
- interactionId?: string
1858
+ interactionId?: string // a link to a Interaction Object
1859
+ scope?: string // a customizable string to segment interactions
1855
1860
  broadcastId?: string
1856
1861
  userId?: string
1857
1862
  contactId?: string
@@ -1876,6 +1881,7 @@ interface InteractionEventBase {
1876
1881
  userId?: string
1877
1882
  contactId?: string
1878
1883
  interactionId: string
1884
+ scope?: string
1879
1885
  appId?: string
1880
1886
  broadcastId?: string
1881
1887
  journeyId?: string
@@ -1916,6 +1922,16 @@ interface InteractionPermissions {
1916
1922
  }
1917
1923
  ```
1918
1924
 
1925
+ **InteractionDisplay** (interface)
1926
+ ```typescript
1927
+ interface InteractionDisplay {
1928
+ title?: string
1929
+ description?: string
1930
+ icon?: string
1931
+ color?: string
1932
+ }
1933
+ ```
1934
+
1919
1935
  **InteractionTypeRecord** (interface)
1920
1936
  ```typescript
1921
1937
  interface InteractionTypeRecord {
@@ -1924,12 +1940,8 @@ interface InteractionTypeRecord {
1924
1940
  appId: string
1925
1941
  permissions?: InteractionPermissions
1926
1942
  data?: {
1927
- display?: {
1928
- title?: string
1929
- description?: string
1930
- icon?: string
1931
- color?: string
1932
- }
1943
+ display?: InteractionDisplay
1944
+ scopes?: Record<string, InteractionDisplay>;
1933
1945
  interactionType?: string
1934
1946
  [key: string]: unknown
1935
1947
  }
package/dist/types/interaction.d.ts CHANGED
@@ -4,6 +4,7 @@ export interface AdminInteractionsQueryRequest {
4
4
  contactId?: string;
5
5
  appId?: string;
6
6
  interactionId?: string;
7
+ scope?: string;
7
8
  interactionIds?: string[];
8
9
  broadcastId?: string;
9
10
  outcome?: string | null;
@@ -18,6 +19,7 @@ export interface AdminInteractionsQueryRequest {
18
19
  export interface AdminInteractionsCountsByOutcomeRequest {
19
20
  appId?: string;
20
21
  interactionId?: string;
22
+ scope?: string;
21
23
  from?: string;
22
24
  to?: string;
23
25
  limit?: number;
@@ -27,6 +29,7 @@ export interface AdminInteractionsCountsByOutcomeRequest {
27
29
  export interface PublicInteractionsCountsByOutcomeRequest {
28
30
  appId: string;
29
31
  interactionId: string;
32
+ scope?: string;
30
33
  from?: string;
31
34
  to?: string;
32
35
  limit?: number;
@@ -34,6 +37,7 @@ export interface PublicInteractionsCountsByOutcomeRequest {
34
37
  export interface PublicInteractionsByUserRequest {
35
38
  appId?: string;
36
39
  interactionId?: string;
40
+ scope?: string;
37
41
  from?: string;
38
42
  to?: string;
39
43
  limit?: number;
@@ -44,6 +48,7 @@ export interface InteractionEventRow {
44
48
  timestamp: string;
45
49
  appId?: string;
46
50
  interactionId?: string;
51
+ scope?: string;
47
52
  broadcastId?: string;
48
53
  userId?: string;
49
54
  contactId?: string;
@@ -61,6 +66,7 @@ export interface InteractionEventBase {
61
66
  userId?: string;
62
67
  contactId?: string;
63
68
  interactionId: string;
69
+ scope?: string;
64
70
  appId?: string;
65
71
  broadcastId?: string;
66
72
  journeyId?: string;
@@ -123,18 +129,20 @@ export interface InteractionPermissions {
123
129
  /** Allow an authenticated user to read their own interaction history via the public API. */
124
130
  allowOwnRead?: boolean;
125
131
  }
132
+ export interface InteractionDisplay {
133
+ title?: string;
134
+ description?: string;
135
+ icon?: string;
136
+ color?: string;
137
+ }
126
138
  export interface InteractionTypeRecord {
127
139
  id?: string;
128
140
  collectionId: string;
129
141
  appId: string;
130
142
  permissions?: InteractionPermissions;
131
143
  data?: {
132
- display?: {
133
- title?: string;
134
- description?: string;
135
- icon?: string;
136
- color?: string;
137
- };
144
+ display?: InteractionDisplay;
145
+ scopes?: Record<string, InteractionDisplay>;
138
146
  interactionType?: string;
139
147
  [key: string]: unknown;
140
148
  };
package/docs/API_SUMMARY.md CHANGED
@@ -1,6 +1,6 @@
1
1
  # Smartlinks API Summary
2
2
 
3
- Version: 1.3.21 | Generated: 2026-02-09T12:29:22.158Z
3
+ Version: 1.3.23 | Generated: 2026-02-13T12:09:03.041Z
4
4
 
5
5
  This is a concise summary of all available API functions and types.
6
6
 
@@ -1796,6 +1796,7 @@ interface AdminInteractionsQueryRequest {
1796
1796
  contactId?: string
1797
1797
  appId?: string
1798
1798
  interactionId?: string
1799
+ scope?: string
1799
1800
  interactionIds?: string[]
1800
1801
  broadcastId?: string
1801
1802
  outcome?: string | null
@@ -1814,6 +1815,7 @@ interface AdminInteractionsQueryRequest {
1814
1815
  interface AdminInteractionsCountsByOutcomeRequest {
1815
1816
  appId?: string
1816
1817
  interactionId?: string
1818
+ scope?: string
1817
1819
  from?: string
1818
1820
  to?: string
1819
1821
  limit?: number
@@ -1827,6 +1829,7 @@ interface AdminInteractionsCountsByOutcomeRequest {
1827
1829
  interface PublicInteractionsCountsByOutcomeRequest {
1828
1830
  appId: string
1829
1831
  interactionId: string
1832
+ scope?: string
1830
1833
  from?: string
1831
1834
  to?: string
1832
1835
  limit?: number
@@ -1838,6 +1841,7 @@ interface PublicInteractionsCountsByOutcomeRequest {
1838
1841
  interface PublicInteractionsByUserRequest {
1839
1842
  appId?: string
1840
1843
  interactionId?: string
1844
+ scope?: string
1841
1845
  from?: string
1842
1846
  to?: string
1843
1847
  limit?: number
@@ -1851,7 +1855,8 @@ interface InteractionEventRow {
1851
1855
  collectionId: string
1852
1856
  timestamp: string
1853
1857
  appId?: string
1854
- interactionId?: string
1858
+ interactionId?: string // a link to a Interaction Object
1859
+ scope?: string // a customizable string to segment interactions
1855
1860
  broadcastId?: string
1856
1861
  userId?: string
1857
1862
  contactId?: string
@@ -1876,6 +1881,7 @@ interface InteractionEventBase {
1876
1881
  userId?: string
1877
1882
  contactId?: string
1878
1883
  interactionId: string
1884
+ scope?: string
1879
1885
  appId?: string
1880
1886
  broadcastId?: string
1881
1887
  journeyId?: string
@@ -1916,6 +1922,16 @@ interface InteractionPermissions {
1916
1922
  }
1917
1923
  ```
1918
1924
 
1925
+ **InteractionDisplay** (interface)
1926
+ ```typescript
1927
+ interface InteractionDisplay {
1928
+ title?: string
1929
+ description?: string
1930
+ icon?: string
1931
+ color?: string
1932
+ }
1933
+ ```
1934
+
1919
1935
  **InteractionTypeRecord** (interface)
1920
1936
  ```typescript
1921
1937
  interface InteractionTypeRecord {
@@ -1924,12 +1940,8 @@ interface InteractionTypeRecord {
1924
1940
  appId: string
1925
1941
  permissions?: InteractionPermissions
1926
1942
  data?: {
1927
- display?: {
1928
- title?: string
1929
- description?: string
1930
- icon?: string
1931
- color?: string
1932
- }
1943
+ display?: InteractionDisplay
1944
+ scopes?: Record<string, InteractionDisplay>;
1933
1945
  interactionType?: string
1934
1946
  [key: string]: unknown
1935
1947
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@proveanything/smartlinks",
3
- "version": "1.3.21",
3
+ "version": "1.3.23",
4
4
  "description": "Official JavaScript/TypeScript SDK for the Smartlinks API",
5
5
  "main": "dist/index.js",
6
6
  "types": "dist/index.d.ts",