@proveanything/smartlinks 1.1.1 → 1.1.2
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.
- package/API_SUMMARY.md +18 -13
- package/dist/types/comms.d.ts +19 -12
- package/dist/types/comms.js +0 -2
- package/package.json +1 -1
package/API_SUMMARY.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# Smartlinks API Summary
|
|
2
2
|
|
|
3
|
-
Version: 1.1.
|
|
3
|
+
Version: 1.1.2 | Generated: 2025-12-18T22:42:25.982Z
|
|
4
4
|
|
|
5
5
|
This is a concise summary of all available API functions and types.
|
|
6
6
|
|
|
@@ -746,12 +746,13 @@ interface SendNotificationResponse {
|
|
|
746
746
|
```typescript
|
|
747
747
|
interface CommunicationEvent {
|
|
748
748
|
orgId: string
|
|
749
|
-
|
|
749
|
+
broadcastId?: string
|
|
750
|
+
journeyId?: string
|
|
750
751
|
userId?: string
|
|
751
752
|
contactId?: string
|
|
752
753
|
channel?: string
|
|
753
754
|
timestamp: string
|
|
754
|
-
eventType
|
|
755
|
+
eventType: string
|
|
755
756
|
outcome?: string | null
|
|
756
757
|
templateId?: string | null
|
|
757
758
|
[k: string]: any
|
|
@@ -779,8 +780,9 @@ interface RecipientWithOutcome {
|
|
|
779
780
|
**CommsRecipientIdsQuery** (interface)
|
|
780
781
|
```typescript
|
|
781
782
|
interface CommsRecipientIdsQuery {
|
|
782
|
-
|
|
783
|
-
|
|
783
|
+
broadcastId?: string
|
|
784
|
+
journeyId?: string
|
|
785
|
+
idField?: IdField
|
|
784
786
|
from?: string
|
|
785
787
|
to?: string
|
|
786
788
|
limit?: number
|
|
@@ -790,10 +792,11 @@ interface CommsRecipientIdsQuery {
|
|
|
790
792
|
**CommsRecipientsWithoutActionQuery** (interface)
|
|
791
793
|
```typescript
|
|
792
794
|
interface CommsRecipientsWithoutActionQuery {
|
|
793
|
-
|
|
795
|
+
broadcastId?: string
|
|
796
|
+
journeyId?: string
|
|
794
797
|
actionId?: string
|
|
795
798
|
appId?: string
|
|
796
|
-
idField?:
|
|
799
|
+
idField?: IdField
|
|
797
800
|
from?: string
|
|
798
801
|
to?: string
|
|
799
802
|
limit?: number
|
|
@@ -803,11 +806,12 @@ interface CommsRecipientsWithoutActionQuery {
|
|
|
803
806
|
**CommsRecipientsWithActionQuery** (interface)
|
|
804
807
|
```typescript
|
|
805
808
|
interface CommsRecipientsWithActionQuery {
|
|
806
|
-
|
|
809
|
+
broadcastId?: string
|
|
810
|
+
journeyId?: string
|
|
807
811
|
actionId?: string
|
|
808
812
|
appId?: string
|
|
809
813
|
outcome?: string
|
|
810
|
-
idField?:
|
|
814
|
+
idField?: IdField
|
|
811
815
|
includeOutcome?: boolean
|
|
812
816
|
from?: string
|
|
813
817
|
to?: string
|
|
@@ -818,11 +822,12 @@ interface CommsRecipientsWithActionQuery {
|
|
|
818
822
|
**LogCommunicationEventBody** (interface)
|
|
819
823
|
```typescript
|
|
820
824
|
interface LogCommunicationEventBody {
|
|
821
|
-
|
|
825
|
+
broadcastId?: string
|
|
826
|
+
journeyId?: string
|
|
822
827
|
userId?: string
|
|
823
828
|
contactId?: string
|
|
824
829
|
channel?: string
|
|
825
|
-
eventType
|
|
830
|
+
eventType: string
|
|
826
831
|
outcome?: string
|
|
827
832
|
templateId?: string
|
|
828
833
|
timestamp?: string
|
|
@@ -833,9 +838,9 @@ interface LogCommunicationEventBody {
|
|
|
833
838
|
**LogBulkCommunicationEventsBody** (interface)
|
|
834
839
|
```typescript
|
|
835
840
|
interface LogBulkCommunicationEventsBody {
|
|
836
|
-
params: {
|
|
841
|
+
params: { broadcastId?: string; journeyId?: string; [k: string]: any }
|
|
837
842
|
ids: string[]
|
|
838
|
-
idField?:
|
|
843
|
+
idField?: IdField
|
|
839
844
|
}
|
|
840
845
|
```
|
|
841
846
|
|
package/dist/types/comms.d.ts
CHANGED
|
@@ -1,3 +1,4 @@
|
|
|
1
|
+
import type { IdField } from './common';
|
|
1
2
|
/**
|
|
2
3
|
* Target subject for notifications (product, collection, etc.)
|
|
3
4
|
*/
|
|
@@ -106,12 +107,13 @@ export interface SendNotificationResponse {
|
|
|
106
107
|
}
|
|
107
108
|
export interface CommunicationEvent {
|
|
108
109
|
orgId: string;
|
|
109
|
-
|
|
110
|
+
broadcastId?: string;
|
|
111
|
+
journeyId?: string;
|
|
110
112
|
userId?: string;
|
|
111
113
|
contactId?: string;
|
|
112
114
|
channel?: string;
|
|
113
115
|
timestamp: string;
|
|
114
|
-
eventType
|
|
116
|
+
eventType: string;
|
|
115
117
|
outcome?: string | null;
|
|
116
118
|
templateId?: string | null;
|
|
117
119
|
[k: string]: any;
|
|
@@ -129,38 +131,42 @@ export interface RecipientWithOutcome {
|
|
|
129
131
|
outcome: string;
|
|
130
132
|
}
|
|
131
133
|
export interface CommsRecipientIdsQuery {
|
|
132
|
-
|
|
133
|
-
|
|
134
|
+
broadcastId?: string;
|
|
135
|
+
journeyId?: string;
|
|
136
|
+
idField?: IdField;
|
|
134
137
|
from?: string;
|
|
135
138
|
to?: string;
|
|
136
139
|
limit?: number;
|
|
137
140
|
}
|
|
138
141
|
export interface CommsRecipientsWithoutActionQuery {
|
|
139
|
-
|
|
142
|
+
broadcastId?: string;
|
|
143
|
+
journeyId?: string;
|
|
140
144
|
actionId?: string;
|
|
141
145
|
appId?: string;
|
|
142
|
-
idField?:
|
|
146
|
+
idField?: IdField;
|
|
143
147
|
from?: string;
|
|
144
148
|
to?: string;
|
|
145
149
|
limit?: number;
|
|
146
150
|
}
|
|
147
151
|
export interface CommsRecipientsWithActionQuery {
|
|
148
|
-
|
|
152
|
+
broadcastId?: string;
|
|
153
|
+
journeyId?: string;
|
|
149
154
|
actionId?: string;
|
|
150
155
|
appId?: string;
|
|
151
156
|
outcome?: string;
|
|
152
|
-
idField?:
|
|
157
|
+
idField?: IdField;
|
|
153
158
|
includeOutcome?: boolean;
|
|
154
159
|
from?: string;
|
|
155
160
|
to?: string;
|
|
156
161
|
limit?: number;
|
|
157
162
|
}
|
|
158
163
|
export interface LogCommunicationEventBody {
|
|
159
|
-
|
|
164
|
+
broadcastId?: string;
|
|
165
|
+
journeyId?: string;
|
|
160
166
|
userId?: string;
|
|
161
167
|
contactId?: string;
|
|
162
168
|
channel?: string;
|
|
163
|
-
eventType
|
|
169
|
+
eventType: string;
|
|
164
170
|
outcome?: string;
|
|
165
171
|
templateId?: string;
|
|
166
172
|
timestamp?: string;
|
|
@@ -168,11 +174,12 @@ export interface LogCommunicationEventBody {
|
|
|
168
174
|
}
|
|
169
175
|
export interface LogBulkCommunicationEventsBody {
|
|
170
176
|
params: {
|
|
171
|
-
|
|
177
|
+
broadcastId?: string;
|
|
178
|
+
journeyId?: string;
|
|
172
179
|
[k: string]: any;
|
|
173
180
|
};
|
|
174
181
|
ids: string[];
|
|
175
|
-
idField?:
|
|
182
|
+
idField?: IdField;
|
|
176
183
|
}
|
|
177
184
|
export interface AppendResult {
|
|
178
185
|
success: true;
|
package/dist/types/comms.js
CHANGED