@pushwoosh/rpc-gateway-journey-data 0.26.206
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/commonTypes.d.ts +1 -0
- package/commonTypes.js +2 -0
- package/data.d.ts +2 -0
- package/data.js +3199 -0
- package/google_api.d.ts +40 -0
- package/google_api.js +2 -0
- package/google_protobuf.d.ts +255 -0
- package/google_protobuf.js +2 -0
- package/index.d.ts +7 -0
- package/index.js +2 -0
- package/package.json +19 -0
- package/pushwoosh_cj_journey.d.ts +1178 -0
- package/pushwoosh_cj_journey.js +2 -0
- package/pushwoosh_cj_journey_category.d.ts +31 -0
- package/pushwoosh_cj_journey_category.js +2 -0
- package/types.d.ts +46 -0
- package/types.js +1 -0
|
@@ -0,0 +1,1178 @@
|
|
|
1
|
+
import { DoubleValue as google_protobuf_DoubleValue } from './google_protobuf';
|
|
2
|
+
export interface Journey {
|
|
3
|
+
GetJourneysList(request: GetJourneysListRequest): Promise<GetJourneysListResponse>;
|
|
4
|
+
GetJourneyByUUID(request: GetJourneyByUUIDRequest): Promise<GetJourneyByUUIDResponse>;
|
|
5
|
+
MoveJourneysToCategory(request: MoveJourneysToCategoryRequest): Promise<MoveJourneysToCategoryResponse>;
|
|
6
|
+
ValidateJourney(request: GetJourneyByUUIDRequest): Promise<ValidateJourneyResponse>;
|
|
7
|
+
StartJourney(request: GetJourneyByUUIDRequest): Promise<GetJourneyByUUIDResponse>;
|
|
8
|
+
PauseJourney(request: GetJourneyByUUIDRequest): Promise<GetJourneyByUUIDResponse>;
|
|
9
|
+
FinishJourney(request: GetJourneyByUUIDRequest): Promise<GetJourneyByUUIDResponse>;
|
|
10
|
+
DraftJourney(request: GetJourneyByUUIDRequest): Promise<GetJourneyByUUIDResponse>;
|
|
11
|
+
ArchiveJourney(request: GetJourneyByUUIDRequest): Promise<GetJourneyByUUIDResponse>;
|
|
12
|
+
UpdateJourney(request: UpdateJourneyRequest): Promise<GetJourneyByUUIDResponse>;
|
|
13
|
+
UpdateAndResumeJourney(request: UpdateJourneyRequest): Promise<GetJourneyByUUIDResponseWithErrors>;
|
|
14
|
+
GetHistory(request: GetHistoryRequest): Promise<GetHistoryResponse>;
|
|
15
|
+
Create(request: CreateRequest): Promise<GetJourneyByUUIDResponse>;
|
|
16
|
+
Rename(request: RenameRequest): Promise<GetJourneyByUUIDResponse>;
|
|
17
|
+
Delete(request: DeleteRequest): Promise<{}>;
|
|
18
|
+
GetUserFlow(request: GetUserFlowRequest): Promise<GetUserFlowResponse>;
|
|
19
|
+
GetJourneyQuickStatsByPoints(request: GetJourneyQuickStatsByPointsRequest): Promise<GetJourneyQuickStatsByPointsResponse>;
|
|
20
|
+
GetJourneyStats(request: GetJourneyStatsRequest): Promise<GetJourneyStatsResponse>;
|
|
21
|
+
GetJourneyStatsByPointsExternal(request: GetJourneyStatsByPointsExternalRequest): Promise<GetJourneyStatsByPointsExternalResponse>;
|
|
22
|
+
GetJourneyStatsByPoint(request: GetJourneyStatsByPointRequest): Promise<GetJourneyStatsByPointResponse>;
|
|
23
|
+
CloneJourneys(request: CloneJourneysRequest): Promise<CloneJourneysResponse>;
|
|
24
|
+
UpdateABSSplitterParams(request: UpdateABSSplitterParamsRequest): Promise<GetJourneyByUUIDResponse>;
|
|
25
|
+
GetTags(request: GetTagsRequest): Promise<GetTagsResponse>;
|
|
26
|
+
GetTagsAutocomplete(request: TagsAutocompleteRequest): Promise<TagsAutocompleteResponse>;
|
|
27
|
+
GetPlaceholders(request: GetPlaceholdersRequest): Promise<GetPlaceholdersResponse>;
|
|
28
|
+
GetAccountRestrictionValues(request: GetAccountRestrictionValuesRequest): Promise<GetAccountRestrictionValuesResponse>;
|
|
29
|
+
GetJourneyGeneralTimeStatistics(request: GetJourneyGeneralTimeStatisticsRequest): Promise<GetJourneyGeneralTimeStatisticsResponse>;
|
|
30
|
+
GetJourneyUsers(request: GetJourneyUsersRequest): Promise<GetJourneyUsersResponse>;
|
|
31
|
+
GetVoucherPools(request: GetVoucherPoolsRequest): Promise<GetVoucherPoolsResponse>;
|
|
32
|
+
}
|
|
33
|
+
export type GetPlaceholdersRequest = {
|
|
34
|
+
templateCode?: string;
|
|
35
|
+
};
|
|
36
|
+
export type GetPlaceholdersResponse = {
|
|
37
|
+
items: string[];
|
|
38
|
+
};
|
|
39
|
+
export type GetTagsRequest = {};
|
|
40
|
+
export type TagResponse = {
|
|
41
|
+
id: number;
|
|
42
|
+
name: string;
|
|
43
|
+
type: TagType;
|
|
44
|
+
isApplication: boolean;
|
|
45
|
+
isUserSpecific: boolean;
|
|
46
|
+
isSystem: boolean;
|
|
47
|
+
};
|
|
48
|
+
export type GetTagsResponse = {
|
|
49
|
+
payload: TagResponse[];
|
|
50
|
+
};
|
|
51
|
+
export type TagsAutocompleteRequest = {
|
|
52
|
+
query?: string;
|
|
53
|
+
tagName?: string;
|
|
54
|
+
tagType?: TagType;
|
|
55
|
+
};
|
|
56
|
+
export type TagsAutocompleteResponse = {
|
|
57
|
+
payload: TagsAutocompleteResponsePayload;
|
|
58
|
+
};
|
|
59
|
+
export type TagsAutocompleteResponsePayload = {
|
|
60
|
+
values: AutocompleteValue[];
|
|
61
|
+
};
|
|
62
|
+
export type AutocompleteValue_kind_intValue = {
|
|
63
|
+
type: 'intValue';
|
|
64
|
+
data: number;
|
|
65
|
+
};
|
|
66
|
+
export type AutocompleteValue_kind_floatValue = {
|
|
67
|
+
type: 'floatValue';
|
|
68
|
+
data: number;
|
|
69
|
+
};
|
|
70
|
+
export type AutocompleteValue_kind_boolValue = {
|
|
71
|
+
type: 'boolValue';
|
|
72
|
+
data: boolean;
|
|
73
|
+
};
|
|
74
|
+
export type AutocompleteValue_kind_stringValue = {
|
|
75
|
+
type: 'stringValue';
|
|
76
|
+
data: string;
|
|
77
|
+
};
|
|
78
|
+
export type AutocompleteValue_kind = AutocompleteValue_kind_intValue | AutocompleteValue_kind_floatValue | AutocompleteValue_kind_boolValue | AutocompleteValue_kind_stringValue;
|
|
79
|
+
export type AutocompleteValue = {
|
|
80
|
+
kind: AutocompleteValue_kind;
|
|
81
|
+
};
|
|
82
|
+
export type UpdateABSSplitterParamsRequest = {
|
|
83
|
+
journeyUuid?: string;
|
|
84
|
+
pointUuid?: string;
|
|
85
|
+
params?: number[];
|
|
86
|
+
autoSelectWinner?: boolean;
|
|
87
|
+
};
|
|
88
|
+
export type CloneJourneysRequest = {
|
|
89
|
+
journeyUuids?: string[];
|
|
90
|
+
sourceAppCode?: string;
|
|
91
|
+
destAppCodes?: string[];
|
|
92
|
+
cloneWithContent?: boolean;
|
|
93
|
+
title?: string;
|
|
94
|
+
};
|
|
95
|
+
export type CloneJourneysResponse = {
|
|
96
|
+
clonedJourneys: Record<string, JourneyUUIDs>;
|
|
97
|
+
};
|
|
98
|
+
export type JourneyUUIDs = {
|
|
99
|
+
journeyUuids: string[];
|
|
100
|
+
};
|
|
101
|
+
export type GetJourneyQuickStatsByPointsRequest = {
|
|
102
|
+
uuid?: string;
|
|
103
|
+
fromDate?: string;
|
|
104
|
+
toDate?: string;
|
|
105
|
+
};
|
|
106
|
+
export type GetJourneyQuickStatsByPointsResponse = {
|
|
107
|
+
metadata: JourneyStatsByPointMeta;
|
|
108
|
+
payload: JourneyQuickStatsByPointsResponsePayload;
|
|
109
|
+
};
|
|
110
|
+
export type JourneyStatsByPointMeta = {
|
|
111
|
+
fromDate: Date;
|
|
112
|
+
toDate: Date;
|
|
113
|
+
};
|
|
114
|
+
export type JourneyQuickStatsByPointsResponsePayload = {
|
|
115
|
+
points: JourneyQuickStatsByPointsItemGet[];
|
|
116
|
+
};
|
|
117
|
+
export type JourneyQuickStatsByPointsItemGet = {
|
|
118
|
+
pointId: string;
|
|
119
|
+
pointTitle: string;
|
|
120
|
+
pointType: string;
|
|
121
|
+
pointStat: PointStat;
|
|
122
|
+
};
|
|
123
|
+
export type PointStat_pointStat_sendPush = {
|
|
124
|
+
type: 'sendPush';
|
|
125
|
+
data: PointStatSendPush;
|
|
126
|
+
};
|
|
127
|
+
export type PointStat_pointStat_inApp = {
|
|
128
|
+
type: 'inApp';
|
|
129
|
+
data: PointStatInApp;
|
|
130
|
+
};
|
|
131
|
+
export type PointStat_pointStat_sendSms = {
|
|
132
|
+
type: 'sendSms';
|
|
133
|
+
data: PointStatSendSms;
|
|
134
|
+
};
|
|
135
|
+
export type PointStat_pointStat_sendWhatsapp = {
|
|
136
|
+
type: 'sendWhatsapp';
|
|
137
|
+
data: PointStatSendWhatsApp;
|
|
138
|
+
};
|
|
139
|
+
export type PointStat_pointStat_sendData = {
|
|
140
|
+
type: 'sendData';
|
|
141
|
+
data: PointStatSendData;
|
|
142
|
+
};
|
|
143
|
+
export type PointStat_pointStat_sendEmail = {
|
|
144
|
+
type: 'sendEmail';
|
|
145
|
+
data: PointStatSendEmail;
|
|
146
|
+
};
|
|
147
|
+
export type PointStat_pointStat_messageBus = {
|
|
148
|
+
type: 'messageBus';
|
|
149
|
+
data: PointStatMessageBus;
|
|
150
|
+
};
|
|
151
|
+
export type PointStat_pointStat_goalEvent = {
|
|
152
|
+
type: 'goalEvent';
|
|
153
|
+
data: PointStatGoalEvent;
|
|
154
|
+
};
|
|
155
|
+
export type PointStat_pointStat_terminator = {
|
|
156
|
+
type: 'terminator';
|
|
157
|
+
data: PointStatTerminator;
|
|
158
|
+
};
|
|
159
|
+
export type PointStat_pointStat_delay = {
|
|
160
|
+
type: 'delay';
|
|
161
|
+
data: PointStatDelay;
|
|
162
|
+
};
|
|
163
|
+
export type PointStat_pointStat_booleanSplitter = {
|
|
164
|
+
type: 'booleanSplitter';
|
|
165
|
+
data: PointStatBooleanSplitter;
|
|
166
|
+
};
|
|
167
|
+
export type PointStat_pointStat_waitEvent = {
|
|
168
|
+
type: 'waitEvent';
|
|
169
|
+
data: PointStatWaitEvent;
|
|
170
|
+
};
|
|
171
|
+
export type PointStat_pointStat_sendLine = {
|
|
172
|
+
type: 'sendLine';
|
|
173
|
+
data: PointStatSendLine;
|
|
174
|
+
};
|
|
175
|
+
export type PointStat_pointStat = PointStat_pointStat_sendPush | PointStat_pointStat_inApp | PointStat_pointStat_sendSms | PointStat_pointStat_sendWhatsapp | PointStat_pointStat_sendData | PointStat_pointStat_sendEmail | PointStat_pointStat_messageBus | PointStat_pointStat_goalEvent | PointStat_pointStat_terminator | PointStat_pointStat_delay | PointStat_pointStat_booleanSplitter | PointStat_pointStat_waitEvent | PointStat_pointStat_sendLine;
|
|
176
|
+
export type PointStat = {
|
|
177
|
+
pointStat: PointStat_pointStat;
|
|
178
|
+
};
|
|
179
|
+
export type PointStatSendPush = {
|
|
180
|
+
sent: number;
|
|
181
|
+
opened: number;
|
|
182
|
+
conversion: number;
|
|
183
|
+
skipped: number;
|
|
184
|
+
skippedDueCappingSettings: number;
|
|
185
|
+
};
|
|
186
|
+
export type PointStatInApp = {
|
|
187
|
+
shows: number;
|
|
188
|
+
interactions: number;
|
|
189
|
+
skipped: number;
|
|
190
|
+
sends: number;
|
|
191
|
+
opened: number;
|
|
192
|
+
};
|
|
193
|
+
export type PointStatSendSms = {
|
|
194
|
+
sent: number;
|
|
195
|
+
delivered: number;
|
|
196
|
+
skipped: number;
|
|
197
|
+
};
|
|
198
|
+
export type PointStatSendLine = {
|
|
199
|
+
sent: number;
|
|
200
|
+
delivered: number;
|
|
201
|
+
};
|
|
202
|
+
export type PointStatSendWhatsApp = {
|
|
203
|
+
sent: number;
|
|
204
|
+
totalOpened: number;
|
|
205
|
+
skipped: number;
|
|
206
|
+
};
|
|
207
|
+
export type PointStatSendData = {
|
|
208
|
+
sent: number;
|
|
209
|
+
delivered: number;
|
|
210
|
+
skipped: number;
|
|
211
|
+
};
|
|
212
|
+
export type PointStatSendEmail = {
|
|
213
|
+
sent: number;
|
|
214
|
+
opened: number;
|
|
215
|
+
clicked: number;
|
|
216
|
+
unsubscribed: number;
|
|
217
|
+
hardBounces: number;
|
|
218
|
+
softBounces: number;
|
|
219
|
+
complaints: number;
|
|
220
|
+
skipped: number;
|
|
221
|
+
};
|
|
222
|
+
export type PointStatMessageBus = {};
|
|
223
|
+
export type PointStatGoalEvent = {};
|
|
224
|
+
export type PointStatTerminator = {};
|
|
225
|
+
export type PointStatDelay = {};
|
|
226
|
+
export type PointStatBooleanSplitter = {};
|
|
227
|
+
export type PointStatWaitEvent = {};
|
|
228
|
+
export type GetJourneyStatsRequest = {
|
|
229
|
+
journeyIds?: string[];
|
|
230
|
+
};
|
|
231
|
+
export type GetJourneyStatsResponse = {
|
|
232
|
+
metadata: JourneyStatsMeta;
|
|
233
|
+
payload: JourneyStatsPayloadGet;
|
|
234
|
+
};
|
|
235
|
+
export type JourneyStatsMeta = {
|
|
236
|
+
journeyIds: string[];
|
|
237
|
+
};
|
|
238
|
+
export type JourneyStatsPayloadGet = {
|
|
239
|
+
items: Record<string, JourneySummaryStats>;
|
|
240
|
+
};
|
|
241
|
+
export type JourneySummaryStats = {
|
|
242
|
+
in: number;
|
|
243
|
+
goals: number;
|
|
244
|
+
avrCTR: google_protobuf_DoubleValue;
|
|
245
|
+
};
|
|
246
|
+
export type RenameRequest = {
|
|
247
|
+
uuid?: string;
|
|
248
|
+
title?: string;
|
|
249
|
+
};
|
|
250
|
+
export type DeleteRequest = {
|
|
251
|
+
uuid?: string;
|
|
252
|
+
};
|
|
253
|
+
export type CreateRequest = {
|
|
254
|
+
title?: string;
|
|
255
|
+
params?: JourneyParams;
|
|
256
|
+
points?: Point[];
|
|
257
|
+
comments?: JourneyComment[];
|
|
258
|
+
};
|
|
259
|
+
export type GetHistoryRequest = {
|
|
260
|
+
uuid?: string;
|
|
261
|
+
userId?: number;
|
|
262
|
+
pageSize?: number;
|
|
263
|
+
page?: number;
|
|
264
|
+
};
|
|
265
|
+
export type GetHistoryResponse = {
|
|
266
|
+
items: HistoryItem[];
|
|
267
|
+
total: number;
|
|
268
|
+
currentPage: number;
|
|
269
|
+
nextPage: number;
|
|
270
|
+
lastPage: number;
|
|
271
|
+
firstPage: number;
|
|
272
|
+
};
|
|
273
|
+
export type HistoryItem = {
|
|
274
|
+
uuid: string;
|
|
275
|
+
user: User;
|
|
276
|
+
createdAt: Date;
|
|
277
|
+
version: number;
|
|
278
|
+
isApplied: boolean;
|
|
279
|
+
changelog: Changelog;
|
|
280
|
+
};
|
|
281
|
+
export type Change_from_boolFrom = {
|
|
282
|
+
type: 'boolFrom';
|
|
283
|
+
data: boolean;
|
|
284
|
+
};
|
|
285
|
+
export type Change_from_stringFrom = {
|
|
286
|
+
type: 'stringFrom';
|
|
287
|
+
data: string;
|
|
288
|
+
};
|
|
289
|
+
export type Change_from_floatFrom = {
|
|
290
|
+
type: 'floatFrom';
|
|
291
|
+
data: number;
|
|
292
|
+
};
|
|
293
|
+
export type Change_from_intFrom = {
|
|
294
|
+
type: 'intFrom';
|
|
295
|
+
data: number;
|
|
296
|
+
};
|
|
297
|
+
export type Change_from_stringArrayFrom = {
|
|
298
|
+
type: 'stringArrayFrom';
|
|
299
|
+
data: StringArray;
|
|
300
|
+
};
|
|
301
|
+
export type Change_from_stringMapFrom = {
|
|
302
|
+
type: 'stringMapFrom';
|
|
303
|
+
data: StringMap;
|
|
304
|
+
};
|
|
305
|
+
export type Change_from_floatArrayFrom = {
|
|
306
|
+
type: 'floatArrayFrom';
|
|
307
|
+
data: FloatArray;
|
|
308
|
+
};
|
|
309
|
+
export type Change_from = Change_from_boolFrom | Change_from_stringFrom | Change_from_floatFrom | Change_from_intFrom | Change_from_stringArrayFrom | Change_from_stringMapFrom | Change_from_floatArrayFrom;
|
|
310
|
+
export type Change_to_boolTo = {
|
|
311
|
+
type: 'boolTo';
|
|
312
|
+
data: boolean;
|
|
313
|
+
};
|
|
314
|
+
export type Change_to_stringTo = {
|
|
315
|
+
type: 'stringTo';
|
|
316
|
+
data: string;
|
|
317
|
+
};
|
|
318
|
+
export type Change_to_floatTo = {
|
|
319
|
+
type: 'floatTo';
|
|
320
|
+
data: number;
|
|
321
|
+
};
|
|
322
|
+
export type Change_to_intTo = {
|
|
323
|
+
type: 'intTo';
|
|
324
|
+
data: number;
|
|
325
|
+
};
|
|
326
|
+
export type Change_to_stringArrayTo = {
|
|
327
|
+
type: 'stringArrayTo';
|
|
328
|
+
data: StringArray;
|
|
329
|
+
};
|
|
330
|
+
export type Change_to_stringMapTo = {
|
|
331
|
+
type: 'stringMapTo';
|
|
332
|
+
data: StringMap;
|
|
333
|
+
};
|
|
334
|
+
export type Change_to_floatArrayTo = {
|
|
335
|
+
type: 'floatArrayTo';
|
|
336
|
+
data: FloatArray;
|
|
337
|
+
};
|
|
338
|
+
export type Change_to = Change_to_boolTo | Change_to_stringTo | Change_to_floatTo | Change_to_intTo | Change_to_stringArrayTo | Change_to_stringMapTo | Change_to_floatArrayTo;
|
|
339
|
+
export type Change = {
|
|
340
|
+
type: string;
|
|
341
|
+
path: string[];
|
|
342
|
+
from: Change_from;
|
|
343
|
+
to: Change_to;
|
|
344
|
+
};
|
|
345
|
+
export type StringArray = {
|
|
346
|
+
values: string[];
|
|
347
|
+
};
|
|
348
|
+
export type FloatArray = {
|
|
349
|
+
values: number[];
|
|
350
|
+
};
|
|
351
|
+
export type StringMap = {
|
|
352
|
+
values: Record<string, string>;
|
|
353
|
+
};
|
|
354
|
+
export type ChangelogRecords = {
|
|
355
|
+
changes: Change[];
|
|
356
|
+
};
|
|
357
|
+
export type PointChangelogRecords = {
|
|
358
|
+
pointType: string;
|
|
359
|
+
changes: Change[];
|
|
360
|
+
title: string;
|
|
361
|
+
};
|
|
362
|
+
export type Changelog = {
|
|
363
|
+
journey: ChangelogRecords;
|
|
364
|
+
points: Record<string, PointsChangelog>;
|
|
365
|
+
comments: Record<string, CommentsChangelog>;
|
|
366
|
+
};
|
|
367
|
+
export type PointsChangelog = {
|
|
368
|
+
point: PointChangelogRecords;
|
|
369
|
+
pointParams: ChangelogRecords;
|
|
370
|
+
pointPositions: ChangelogRecords;
|
|
371
|
+
pointOutputs: ChangelogRecords;
|
|
372
|
+
};
|
|
373
|
+
export type CommentsChangelog = {
|
|
374
|
+
comments: ChangelogRecords;
|
|
375
|
+
commentPositions: ChangelogRecords;
|
|
376
|
+
};
|
|
377
|
+
export type UpdateJourneyRequest = {
|
|
378
|
+
uuid?: string;
|
|
379
|
+
title?: string;
|
|
380
|
+
params?: JourneyParams;
|
|
381
|
+
points?: Point[];
|
|
382
|
+
comments?: JourneyComment[];
|
|
383
|
+
autosave?: boolean;
|
|
384
|
+
};
|
|
385
|
+
export type GetJourneysListRequest = {
|
|
386
|
+
applicationCode?: string;
|
|
387
|
+
statuses?: JourneyStatus[];
|
|
388
|
+
categoryUuids?: string[];
|
|
389
|
+
filterTitle?: string;
|
|
390
|
+
sorting?: Sorting[];
|
|
391
|
+
page?: number;
|
|
392
|
+
pageSize?: number;
|
|
393
|
+
campaignTypes?: CampaignType[];
|
|
394
|
+
uuidList?: string[];
|
|
395
|
+
};
|
|
396
|
+
export type GetJourneysListResponse = {
|
|
397
|
+
journeys: Info[];
|
|
398
|
+
total: number;
|
|
399
|
+
};
|
|
400
|
+
export type GetJourneyByUUIDRequest = {
|
|
401
|
+
uuid?: string;
|
|
402
|
+
};
|
|
403
|
+
export type GetJourneyByUUIDResponse = {
|
|
404
|
+
info: Info;
|
|
405
|
+
points: Point[];
|
|
406
|
+
comments: JourneyComment[];
|
|
407
|
+
};
|
|
408
|
+
export type GetJourneyByUUIDResponseWithErrors = {
|
|
409
|
+
response: GetJourneyByUUIDResponse;
|
|
410
|
+
validation: ValidateJourneyResponse;
|
|
411
|
+
};
|
|
412
|
+
export type MoveJourneysToCategoryRequest = {
|
|
413
|
+
journeyUuids?: string[];
|
|
414
|
+
categoryUuid?: string;
|
|
415
|
+
applicationCode?: string;
|
|
416
|
+
};
|
|
417
|
+
export type MoveJourneysToCategoryResponse = {
|
|
418
|
+
journeys: Info[];
|
|
419
|
+
};
|
|
420
|
+
export type ValidateJourneyResponse = {
|
|
421
|
+
valid: boolean;
|
|
422
|
+
journeyErrors: JourneyValidationError[];
|
|
423
|
+
pointErrors: PointValidationError[];
|
|
424
|
+
};
|
|
425
|
+
export type JourneyValidationError = {
|
|
426
|
+
message: string;
|
|
427
|
+
};
|
|
428
|
+
export type PointValidationError = {
|
|
429
|
+
uuid: string;
|
|
430
|
+
message: string;
|
|
431
|
+
};
|
|
432
|
+
export type GetUserFlowRequest = {
|
|
433
|
+
uuid?: string;
|
|
434
|
+
userId?: string;
|
|
435
|
+
};
|
|
436
|
+
export type GetUserFlowResponse_Status = 'success' | 'error' | 'break_path';
|
|
437
|
+
export type GetUserFlowResponse_Point = {
|
|
438
|
+
uuid: string;
|
|
439
|
+
timestamp: Date;
|
|
440
|
+
status: GetUserFlowResponse_Status;
|
|
441
|
+
message: string;
|
|
442
|
+
};
|
|
443
|
+
export type GetUserFlowResponse_Flow = {
|
|
444
|
+
points: GetUserFlowResponse_Point[];
|
|
445
|
+
status: GetUserFlowResponse_Status;
|
|
446
|
+
enterTime: Date;
|
|
447
|
+
};
|
|
448
|
+
export type GetUserFlowResponse = {
|
|
449
|
+
flows: GetUserFlowResponse_Flow[];
|
|
450
|
+
};
|
|
451
|
+
export type Sorting = {
|
|
452
|
+
field: string;
|
|
453
|
+
direction: string;
|
|
454
|
+
};
|
|
455
|
+
export type JourneyStatus = 'STATUS_DRAFT' | 'STATUS_RUNNING' | 'STATUS_FINISHED' | 'STATUS_ARCHIVED' | 'STATUS_PAUSED' | 'STATUS_UNKNOWN';
|
|
456
|
+
export type PointEventAttributeType = 'ATTRIBUTE_UNKNOWN' | 'INTEGER' | 'STRING' | 'LIST' | 'DATE' | 'BOOLEAN' | 'FLOAT';
|
|
457
|
+
export type PointEventConditionOperator = 'OPERATOR_UNKNOWN' | 'EQ' | 'LTE' | 'GTE' | 'NOTEQ' | 'IN' | 'NOTIN' | 'BETWEEN';
|
|
458
|
+
export type PointEventCondition_value_int = {
|
|
459
|
+
type: 'int';
|
|
460
|
+
data: PointEventConditionValueInt;
|
|
461
|
+
};
|
|
462
|
+
export type PointEventCondition_value_intRange = {
|
|
463
|
+
type: 'intRange';
|
|
464
|
+
data: PointEventConditionValueIntRange;
|
|
465
|
+
};
|
|
466
|
+
export type PointEventCondition_value_str = {
|
|
467
|
+
type: 'str';
|
|
468
|
+
data: PointEventConditionValueStr;
|
|
469
|
+
};
|
|
470
|
+
export type PointEventCondition_value_strRange = {
|
|
471
|
+
type: 'strRange';
|
|
472
|
+
data: PointEventConditionValueStrRange;
|
|
473
|
+
};
|
|
474
|
+
export type PointEventCondition_value_bool = {
|
|
475
|
+
type: 'bool';
|
|
476
|
+
data: PointEventConditionValueBool;
|
|
477
|
+
};
|
|
478
|
+
export type PointEventCondition_value_float = {
|
|
479
|
+
type: 'float';
|
|
480
|
+
data: PointEventConditionValueFloat;
|
|
481
|
+
};
|
|
482
|
+
export type PointEventCondition_value_floatRange = {
|
|
483
|
+
type: 'floatRange';
|
|
484
|
+
data: PointEventConditionValueFloatRange;
|
|
485
|
+
};
|
|
486
|
+
export type PointEventCondition_value = PointEventCondition_value_int | PointEventCondition_value_intRange | PointEventCondition_value_str | PointEventCondition_value_strRange | PointEventCondition_value_bool | PointEventCondition_value_float | PointEventCondition_value_floatRange;
|
|
487
|
+
export type PointEventCondition = {
|
|
488
|
+
attributeName: string;
|
|
489
|
+
type: PointEventAttributeType;
|
|
490
|
+
operator: PointEventConditionOperator;
|
|
491
|
+
value: PointEventCondition_value;
|
|
492
|
+
};
|
|
493
|
+
export type PointEventConditionValueInt = {
|
|
494
|
+
value: number;
|
|
495
|
+
};
|
|
496
|
+
export type PointEventConditionValueIntRange = {
|
|
497
|
+
value: number[];
|
|
498
|
+
};
|
|
499
|
+
export type PointEventConditionValueFloat = {
|
|
500
|
+
value: number;
|
|
501
|
+
};
|
|
502
|
+
export type PointEventConditionValueFloatRange = {
|
|
503
|
+
value: number[];
|
|
504
|
+
};
|
|
505
|
+
export type PointEventConditionValueStr = {
|
|
506
|
+
value: string;
|
|
507
|
+
};
|
|
508
|
+
export type PointEventConditionValueStrRange = {
|
|
509
|
+
value: string[];
|
|
510
|
+
};
|
|
511
|
+
export type PointEventConditionValueBool = {
|
|
512
|
+
value: boolean;
|
|
513
|
+
};
|
|
514
|
+
export type Info = {
|
|
515
|
+
uuid: string;
|
|
516
|
+
title: string;
|
|
517
|
+
status: JourneyStatus;
|
|
518
|
+
createdAt: string;
|
|
519
|
+
updatedAt: string;
|
|
520
|
+
isFirstActivated: boolean;
|
|
521
|
+
params: JourneyParams;
|
|
522
|
+
categoryUuid: string;
|
|
523
|
+
pointCounts: Record<string, number>;
|
|
524
|
+
campaignType: CampaignType;
|
|
525
|
+
stopReason: string;
|
|
526
|
+
lastEditedBy: User;
|
|
527
|
+
};
|
|
528
|
+
export type User = {
|
|
529
|
+
id: number;
|
|
530
|
+
email: string;
|
|
531
|
+
username: string;
|
|
532
|
+
};
|
|
533
|
+
export type Point = {
|
|
534
|
+
uuid: string;
|
|
535
|
+
title: string;
|
|
536
|
+
type: string;
|
|
537
|
+
outputs: PointOutput[];
|
|
538
|
+
position: Position;
|
|
539
|
+
pointData: PointDataWrapper;
|
|
540
|
+
};
|
|
541
|
+
export type PointDataWrapper_data_messageBus = {
|
|
542
|
+
type: 'messageBus';
|
|
543
|
+
data: PointParamsMessageBus;
|
|
544
|
+
};
|
|
545
|
+
export type PointDataWrapper_data_delay = {
|
|
546
|
+
type: 'delay';
|
|
547
|
+
data: PointParamsDelay;
|
|
548
|
+
};
|
|
549
|
+
export type PointDataWrapper_data_terminator = {
|
|
550
|
+
type: 'terminator';
|
|
551
|
+
data: PointParamsTerminator;
|
|
552
|
+
};
|
|
553
|
+
export type PointDataWrapper_data_sendPush = {
|
|
554
|
+
type: 'sendPush';
|
|
555
|
+
data: PointParamsSendPush;
|
|
556
|
+
};
|
|
557
|
+
export type PointDataWrapper_data_goalEvent = {
|
|
558
|
+
type: 'goalEvent';
|
|
559
|
+
data: PointParamsGoalEvent;
|
|
560
|
+
};
|
|
561
|
+
export type PointDataWrapper_data_sendEmail = {
|
|
562
|
+
type: 'sendEmail';
|
|
563
|
+
data: PointParamsSendEmail;
|
|
564
|
+
};
|
|
565
|
+
export type PointDataWrapper_data_booleanSplitter = {
|
|
566
|
+
type: 'booleanSplitter';
|
|
567
|
+
data: PointParamsBooleanSplitter;
|
|
568
|
+
};
|
|
569
|
+
export type PointDataWrapper_data_waitEvent = {
|
|
570
|
+
type: 'waitEvent';
|
|
571
|
+
data: PointParamsWaitEvent;
|
|
572
|
+
};
|
|
573
|
+
export type PointDataWrapper_data_inapp = {
|
|
574
|
+
type: 'inapp';
|
|
575
|
+
data: PointParamsInapp;
|
|
576
|
+
};
|
|
577
|
+
export type PointDataWrapper_data_startBySegment = {
|
|
578
|
+
type: 'startBySegment';
|
|
579
|
+
data: PointParamsStartBySegment;
|
|
580
|
+
};
|
|
581
|
+
export type PointDataWrapper_data_abSplitter = {
|
|
582
|
+
type: 'abSplitter';
|
|
583
|
+
data: PointParamsABSplitter;
|
|
584
|
+
};
|
|
585
|
+
export type PointDataWrapper_data_setTags = {
|
|
586
|
+
type: 'setTags';
|
|
587
|
+
data: PointParamsSetTags;
|
|
588
|
+
};
|
|
589
|
+
export type PointDataWrapper_data_webHook = {
|
|
590
|
+
type: 'webHook';
|
|
591
|
+
data: PointParamsWebHook;
|
|
592
|
+
};
|
|
593
|
+
export type PointDataWrapper_data_filter = {
|
|
594
|
+
type: 'filter';
|
|
595
|
+
data: PointParamsFilter;
|
|
596
|
+
};
|
|
597
|
+
export type PointDataWrapper_data_sendSms = {
|
|
598
|
+
type: 'sendSms';
|
|
599
|
+
data: PointParamsSendSms;
|
|
600
|
+
};
|
|
601
|
+
export type PointDataWrapper_data_startByApi = {
|
|
602
|
+
type: 'startByApi';
|
|
603
|
+
data: PointParamsStartByAPI;
|
|
604
|
+
};
|
|
605
|
+
export type PointDataWrapper_data_sendWhatsapp = {
|
|
606
|
+
type: 'sendWhatsapp';
|
|
607
|
+
data: PointParamsSendWhatsApp;
|
|
608
|
+
};
|
|
609
|
+
export type PointDataWrapper_data_sendData = {
|
|
610
|
+
type: 'sendData';
|
|
611
|
+
data: PointParamsSendData;
|
|
612
|
+
};
|
|
613
|
+
export type PointDataWrapper_data_sendLine = {
|
|
614
|
+
type: 'sendLine';
|
|
615
|
+
data: PointParamsSendLine;
|
|
616
|
+
};
|
|
617
|
+
export type PointDataWrapper_data = PointDataWrapper_data_messageBus | PointDataWrapper_data_delay | PointDataWrapper_data_terminator | PointDataWrapper_data_sendPush | PointDataWrapper_data_goalEvent | PointDataWrapper_data_sendEmail | PointDataWrapper_data_booleanSplitter | PointDataWrapper_data_waitEvent | PointDataWrapper_data_inapp | PointDataWrapper_data_startBySegment | PointDataWrapper_data_abSplitter | PointDataWrapper_data_setTags | PointDataWrapper_data_webHook | PointDataWrapper_data_filter | PointDataWrapper_data_sendSms | PointDataWrapper_data_startByApi | PointDataWrapper_data_sendWhatsapp | PointDataWrapper_data_sendData | PointDataWrapper_data_sendLine;
|
|
618
|
+
export type PointDataWrapper = {
|
|
619
|
+
data: PointDataWrapper_data;
|
|
620
|
+
};
|
|
621
|
+
export type Time = {
|
|
622
|
+
hour: number;
|
|
623
|
+
minute: number;
|
|
624
|
+
};
|
|
625
|
+
export type JourneyParamsSilentHours = {
|
|
626
|
+
inappParams: SilentHoursParams;
|
|
627
|
+
pushParams: SilentHoursParams;
|
|
628
|
+
emailParams: SilentHoursParams;
|
|
629
|
+
smsParams: SilentHoursParams;
|
|
630
|
+
whatsappParams: SilentHoursParams;
|
|
631
|
+
lineParams: SilentHoursParams;
|
|
632
|
+
fromTime: Time;
|
|
633
|
+
toTime: Time;
|
|
634
|
+
weekDays: boolean[];
|
|
635
|
+
};
|
|
636
|
+
export type SilentHoursBehavior = 'WaitAndSend' | 'DropAndGo' | 'WaitAndDrop';
|
|
637
|
+
export type SilentHoursParams = {
|
|
638
|
+
enabled: boolean;
|
|
639
|
+
fromTime: Time;
|
|
640
|
+
toTime: Time;
|
|
641
|
+
weekDays: boolean[];
|
|
642
|
+
behavior: SilentHoursBehavior;
|
|
643
|
+
};
|
|
644
|
+
export type CampaignType = 'Unknown' | 'Mixed' | 'TriggerBased' | 'AudienceBased' | 'APIBased';
|
|
645
|
+
export type JourneyParamsEntryCapping = {
|
|
646
|
+
isEnabled: boolean;
|
|
647
|
+
period: number;
|
|
648
|
+
};
|
|
649
|
+
export type JourneyParamsConversionWindow = {
|
|
650
|
+
seconds: number;
|
|
651
|
+
};
|
|
652
|
+
export type JourneyParams = {
|
|
653
|
+
silentHours: JourneyParamsSilentHours;
|
|
654
|
+
capping: JourneyParamsEntryCapping;
|
|
655
|
+
applicationCode: string;
|
|
656
|
+
conversionWindow: JourneyParamsConversionWindow;
|
|
657
|
+
};
|
|
658
|
+
export type JourneyComment = {
|
|
659
|
+
id: string;
|
|
660
|
+
message: string;
|
|
661
|
+
createdAt: string;
|
|
662
|
+
deleted: boolean;
|
|
663
|
+
position: Position;
|
|
664
|
+
index: number;
|
|
665
|
+
};
|
|
666
|
+
export type PointParamsMessageBus = {
|
|
667
|
+
eventName: string;
|
|
668
|
+
applicationCode: string;
|
|
669
|
+
eventConditions: PointEventCondition[];
|
|
670
|
+
activePeriod: Period;
|
|
671
|
+
};
|
|
672
|
+
export type Period = {
|
|
673
|
+
enabled: boolean;
|
|
674
|
+
start: Date;
|
|
675
|
+
end: Date;
|
|
676
|
+
};
|
|
677
|
+
export type PointParamsSendPush = {
|
|
678
|
+
presetCode: string;
|
|
679
|
+
content: string;
|
|
680
|
+
title: string;
|
|
681
|
+
applicationCode: string;
|
|
682
|
+
campaignCode: string;
|
|
683
|
+
campaignUid: number;
|
|
684
|
+
splitParams: BehaviorSplitter;
|
|
685
|
+
sendByUserId: boolean;
|
|
686
|
+
waitOptimalTime: boolean;
|
|
687
|
+
defaultOptimalTime: ExactTime;
|
|
688
|
+
liquidTemplateParams: LiquidTemplateParams;
|
|
689
|
+
personalise: PersonalisedParams;
|
|
690
|
+
capping: Capping;
|
|
691
|
+
inboxOptions: InboxOptions;
|
|
692
|
+
vouchersParams: VoucherParams;
|
|
693
|
+
};
|
|
694
|
+
export type PointParamsSendSms = {
|
|
695
|
+
presetCode: string;
|
|
696
|
+
content: string;
|
|
697
|
+
applicationCode: string;
|
|
698
|
+
campaignCode: string;
|
|
699
|
+
campaignUid: number;
|
|
700
|
+
splitParams: BehaviorSplitter;
|
|
701
|
+
sendByUserId: boolean;
|
|
702
|
+
liquidTemplateParams: LiquidTemplateParams;
|
|
703
|
+
personalise: PersonalisedParams;
|
|
704
|
+
capping: Capping;
|
|
705
|
+
};
|
|
706
|
+
export type PointParamsSendLine = {
|
|
707
|
+
presetCode: string;
|
|
708
|
+
content: string;
|
|
709
|
+
applicationCode: string;
|
|
710
|
+
campaignCode: string;
|
|
711
|
+
campaignUid: number;
|
|
712
|
+
splitParams: BehaviorSplitter;
|
|
713
|
+
sendByUserId: boolean;
|
|
714
|
+
liquidTemplateParams: LiquidTemplateParams;
|
|
715
|
+
personalise: PersonalisedParams;
|
|
716
|
+
capping: Capping;
|
|
717
|
+
};
|
|
718
|
+
export type WhatsAppPersonalisedParams = {
|
|
719
|
+
enabled: boolean;
|
|
720
|
+
placeholders: WhatsAppPlaceholder[];
|
|
721
|
+
};
|
|
722
|
+
export type WhatsAppPlaceholder = {
|
|
723
|
+
name: string;
|
|
724
|
+
pointId: string;
|
|
725
|
+
eventName: string;
|
|
726
|
+
attribute: string;
|
|
727
|
+
tagName: string;
|
|
728
|
+
tagModifier: string;
|
|
729
|
+
isButton: boolean;
|
|
730
|
+
buttonIndex: number;
|
|
731
|
+
buttonUrl: string;
|
|
732
|
+
component: string;
|
|
733
|
+
type: string;
|
|
734
|
+
value: string;
|
|
735
|
+
};
|
|
736
|
+
export type PointParamsSendWhatsApp = {
|
|
737
|
+
presetCode: string;
|
|
738
|
+
content: string;
|
|
739
|
+
applicationCode: string;
|
|
740
|
+
campaignCode: string;
|
|
741
|
+
campaignUid: number;
|
|
742
|
+
splitParams: BehaviorSplitter;
|
|
743
|
+
sendByUserId: boolean;
|
|
744
|
+
personalise: WhatsAppPersonalisedParams;
|
|
745
|
+
capping: Capping;
|
|
746
|
+
};
|
|
747
|
+
export type PointParamsSendEmail = {
|
|
748
|
+
applicationCode: string;
|
|
749
|
+
presetCode: string;
|
|
750
|
+
campaignCode: string;
|
|
751
|
+
campaignUid: number;
|
|
752
|
+
splitParams: BehaviorSplitter;
|
|
753
|
+
sendOnlyToSubscribed: boolean;
|
|
754
|
+
liquidTemplateParams: LiquidTemplateParams;
|
|
755
|
+
personalise: PersonalisedParams;
|
|
756
|
+
title: string;
|
|
757
|
+
subjects: Record<string, string>;
|
|
758
|
+
bcc: string[];
|
|
759
|
+
unsubscribedPolicy: UnsubscribedPolicy;
|
|
760
|
+
capping: Capping;
|
|
761
|
+
from: From;
|
|
762
|
+
replyTo: ReplyTo;
|
|
763
|
+
vouchersParams: VoucherParams;
|
|
764
|
+
};
|
|
765
|
+
export type From = {
|
|
766
|
+
name: string;
|
|
767
|
+
email: string;
|
|
768
|
+
};
|
|
769
|
+
export type ReplyTo = {
|
|
770
|
+
name: string;
|
|
771
|
+
email: string;
|
|
772
|
+
};
|
|
773
|
+
export type PointParamsSendData = {
|
|
774
|
+
content: string;
|
|
775
|
+
applicationCode: string;
|
|
776
|
+
campaignCode: string;
|
|
777
|
+
campaignUid: number;
|
|
778
|
+
sendByUserId: boolean;
|
|
779
|
+
liquidTemplateParams: LiquidTemplateParams;
|
|
780
|
+
personalise: PersonalisedParams;
|
|
781
|
+
};
|
|
782
|
+
export type UnsubscribedPolicy = 'UNKNOWN' | 'IGNORE' | 'SEND';
|
|
783
|
+
export type PointParamsBooleanSplitter = {
|
|
784
|
+
filterCode: string;
|
|
785
|
+
};
|
|
786
|
+
export type PointParamsWaitEvent = {
|
|
787
|
+
events: PointWaitEventInfo[];
|
|
788
|
+
conditionsScript: string;
|
|
789
|
+
};
|
|
790
|
+
export type PointWaitEventInfo = {
|
|
791
|
+
eventName: string;
|
|
792
|
+
applicationCode: string;
|
|
793
|
+
intervalSec: number;
|
|
794
|
+
eventConditions: PointEventCondition[];
|
|
795
|
+
intervalFixed: boolean;
|
|
796
|
+
};
|
|
797
|
+
export type PointParamsInapp = {
|
|
798
|
+
richmediaCode: string;
|
|
799
|
+
applicationCode: string;
|
|
800
|
+
campaignCode: string;
|
|
801
|
+
campaignUid: number;
|
|
802
|
+
expireInDays: number;
|
|
803
|
+
capping: Capping;
|
|
804
|
+
};
|
|
805
|
+
export type Filter = 'CUSTOM' | 'EMAIL_EXISTS' | 'PUSH_TOKEN_EXISTS' | 'SMS_TOKEN_EXISTS' | 'WHATSAPP_TOKEN_EXISTS' | 'LINE_TOKEN_EXISTS';
|
|
806
|
+
export type PointParamsFilter = {
|
|
807
|
+
filter: Filter;
|
|
808
|
+
filterRaw: string;
|
|
809
|
+
};
|
|
810
|
+
export type BehaviorSplitter = {
|
|
811
|
+
enabled: boolean;
|
|
812
|
+
interval: number;
|
|
813
|
+
};
|
|
814
|
+
export type LiquidTemplateParams = {
|
|
815
|
+
enabled: boolean;
|
|
816
|
+
eventName: string;
|
|
817
|
+
};
|
|
818
|
+
export type VoucherParams = {
|
|
819
|
+
enabled: boolean;
|
|
820
|
+
voucherPool: string;
|
|
821
|
+
};
|
|
822
|
+
export type PersonalisedParams = {
|
|
823
|
+
enabled: boolean;
|
|
824
|
+
placeholders: Placeholder[];
|
|
825
|
+
};
|
|
826
|
+
export type Placeholder = {
|
|
827
|
+
name: string;
|
|
828
|
+
pointId: string;
|
|
829
|
+
attribute: string;
|
|
830
|
+
eventName: string;
|
|
831
|
+
tagName: string;
|
|
832
|
+
tagModifier: string;
|
|
833
|
+
};
|
|
834
|
+
export type ExactTime = {
|
|
835
|
+
hour: number;
|
|
836
|
+
minute: number;
|
|
837
|
+
};
|
|
838
|
+
export type ExactDateTime = {
|
|
839
|
+
year: number;
|
|
840
|
+
month: number;
|
|
841
|
+
day: number;
|
|
842
|
+
hour: number;
|
|
843
|
+
minute: number;
|
|
844
|
+
};
|
|
845
|
+
export type ExactWeekDaysTime = {
|
|
846
|
+
days: Record<number, ExactTime>;
|
|
847
|
+
};
|
|
848
|
+
export type DynamicTimeFrom = 'TAG' | 'EVENT';
|
|
849
|
+
export type DynamicTimeDirection = 'RIGHT_ON_TIME' | 'AFTER' | 'BEFORE';
|
|
850
|
+
export type DynamicTimeUnit = 'HOURS' | 'DAYS' | 'MINUTES';
|
|
851
|
+
export type DynamicTime = {
|
|
852
|
+
from: DynamicTimeFrom;
|
|
853
|
+
direction: DynamicTimeDirection;
|
|
854
|
+
duration: number;
|
|
855
|
+
unit: DynamicTimeUnit;
|
|
856
|
+
splitBranches: boolean;
|
|
857
|
+
pointId: string;
|
|
858
|
+
eventName: string;
|
|
859
|
+
eventAttribute: string;
|
|
860
|
+
tagName: string;
|
|
861
|
+
};
|
|
862
|
+
export type PointParamsGoalEvent = {
|
|
863
|
+
eventName: string;
|
|
864
|
+
applicationCode: string;
|
|
865
|
+
eventConditions: PointEventCondition[];
|
|
866
|
+
isThrowOut: boolean;
|
|
867
|
+
};
|
|
868
|
+
export type PointParamsDelay_interval_sec = {
|
|
869
|
+
type: 'sec';
|
|
870
|
+
data: number;
|
|
871
|
+
};
|
|
872
|
+
export type PointParamsDelay_interval_exactTime = {
|
|
873
|
+
type: 'exactTime';
|
|
874
|
+
data: ExactTime;
|
|
875
|
+
};
|
|
876
|
+
export type PointParamsDelay_interval_dynamicTime = {
|
|
877
|
+
type: 'dynamicTime';
|
|
878
|
+
data: DynamicTime;
|
|
879
|
+
};
|
|
880
|
+
export type PointParamsDelay_interval_exactDateTime = {
|
|
881
|
+
type: 'exactDateTime';
|
|
882
|
+
data: ExactDateTime;
|
|
883
|
+
};
|
|
884
|
+
export type PointParamsDelay_interval_exactWeekDaysTime = {
|
|
885
|
+
type: 'exactWeekDaysTime';
|
|
886
|
+
data: ExactWeekDaysTime;
|
|
887
|
+
};
|
|
888
|
+
export type PointParamsDelay_interval = PointParamsDelay_interval_sec | PointParamsDelay_interval_exactTime | PointParamsDelay_interval_dynamicTime | PointParamsDelay_interval_exactDateTime | PointParamsDelay_interval_exactWeekDaysTime;
|
|
889
|
+
export type PointParamsDelay = {
|
|
890
|
+
interval: PointParamsDelay_interval;
|
|
891
|
+
};
|
|
892
|
+
export type PointOutput = {
|
|
893
|
+
identity: PointOutputIdentity;
|
|
894
|
+
info: PointOutputInfo;
|
|
895
|
+
};
|
|
896
|
+
export type PointOutputIdentity = {
|
|
897
|
+
key: string;
|
|
898
|
+
order: number;
|
|
899
|
+
};
|
|
900
|
+
export type PointOutputInfo = {
|
|
901
|
+
title: string;
|
|
902
|
+
nextPointUuid: string;
|
|
903
|
+
};
|
|
904
|
+
export type PointParamsWebHook = {
|
|
905
|
+
method: string;
|
|
906
|
+
url: string;
|
|
907
|
+
requestTemplate: string;
|
|
908
|
+
headers: Record<string, string>;
|
|
909
|
+
};
|
|
910
|
+
export type PointParamsStartBySegment = {
|
|
911
|
+
filterCode: string;
|
|
912
|
+
applicationCode: string;
|
|
913
|
+
entryLimitsEnabled: boolean;
|
|
914
|
+
entryLimitsPerSecond: number;
|
|
915
|
+
repeat: SegmentRepeat;
|
|
916
|
+
isDeactivated: boolean;
|
|
917
|
+
filterTitle: string;
|
|
918
|
+
applicationTitle: string;
|
|
919
|
+
};
|
|
920
|
+
export type SegmentRepeat = {
|
|
921
|
+
enabled: boolean;
|
|
922
|
+
type: string;
|
|
923
|
+
frequency: string;
|
|
924
|
+
every: number;
|
|
925
|
+
dates: string[];
|
|
926
|
+
time: SegmentRepeatTime;
|
|
927
|
+
};
|
|
928
|
+
export type SegmentRepeatTime_PastTimezonesBehaviour = 'PAST_TIMEZONES_BEHAVIOUR_DEFAULT' | 'PAST_TIMEZONES_BEHAVIOUR_SEND_IMMEDIATELY' | 'PAST_TIMEZONES_BEHAVIOUR_DO_NOT_SEND' | 'PAST_TIMEZONES_BEHAVIOUR_NEXT_DAY';
|
|
929
|
+
export type SegmentRepeatTime = {
|
|
930
|
+
hour: number;
|
|
931
|
+
minute: number;
|
|
932
|
+
timezone: string;
|
|
933
|
+
followUserTimezone: boolean;
|
|
934
|
+
pastTimezonesBehaviour: SegmentRepeatTime_PastTimezonesBehaviour;
|
|
935
|
+
};
|
|
936
|
+
export type SegmentRepeatType = 'REPEAT_TYPE_UNKNOWN' | 'REPEAT_TYPE_EVERY_DAY' | 'REPEAT_TYPE_EVERY_WEEK' | 'REPEAT_TYPE_EVERY_MONTH' | 'REPEAT_TYPE_CUSTOM' | 'REPEAT_TYPE_DATES_SPECIFIED';
|
|
937
|
+
export type PointParamsABSplitter = {
|
|
938
|
+
split: number[];
|
|
939
|
+
autoSelectWinner: boolean;
|
|
940
|
+
winnerSplit: number;
|
|
941
|
+
};
|
|
942
|
+
export type TagType = 'TYPE_UNKNOWN' | 'TYPE_INTEGER' | 'TYPE_STRING' | 'TYPE_LIST' | 'TYPE_DATE' | 'TYPE_BOOLEAN' | 'TYPE_PRICE' | 'TYPE_VERSION' | 'TYPE_DYNAMIC' | 'TYPE_LIST_APPEND';
|
|
943
|
+
export type Tag_value_int = {
|
|
944
|
+
type: 'int';
|
|
945
|
+
data: number;
|
|
946
|
+
};
|
|
947
|
+
export type Tag_value_str = {
|
|
948
|
+
type: 'str';
|
|
949
|
+
data: string;
|
|
950
|
+
};
|
|
951
|
+
export type Tag_value_list = {
|
|
952
|
+
type: 'list';
|
|
953
|
+
data: TagValueList;
|
|
954
|
+
};
|
|
955
|
+
export type Tag_value_date = {
|
|
956
|
+
type: 'date';
|
|
957
|
+
data: Date;
|
|
958
|
+
};
|
|
959
|
+
export type Tag_value_bool = {
|
|
960
|
+
type: 'bool';
|
|
961
|
+
data: boolean;
|
|
962
|
+
};
|
|
963
|
+
export type Tag_value_price = {
|
|
964
|
+
type: 'price';
|
|
965
|
+
data: number;
|
|
966
|
+
};
|
|
967
|
+
export type Tag_value_version = {
|
|
968
|
+
type: 'version';
|
|
969
|
+
data: string;
|
|
970
|
+
};
|
|
971
|
+
export type Tag_value_dynamic = {
|
|
972
|
+
type: 'dynamic';
|
|
973
|
+
data: TagValueDynamic;
|
|
974
|
+
};
|
|
975
|
+
export type Tag_value_timezone = {
|
|
976
|
+
type: 'timezone';
|
|
977
|
+
data: string;
|
|
978
|
+
};
|
|
979
|
+
export type Tag_value = Tag_value_int | Tag_value_str | Tag_value_list | Tag_value_date | Tag_value_bool | Tag_value_price | Tag_value_version | Tag_value_dynamic | Tag_value_timezone;
|
|
980
|
+
export type Tag = {
|
|
981
|
+
id: number;
|
|
982
|
+
type: TagType;
|
|
983
|
+
name: string;
|
|
984
|
+
dynamicModification: boolean;
|
|
985
|
+
setTagOperation: SetTagOperation;
|
|
986
|
+
value: Tag_value;
|
|
987
|
+
};
|
|
988
|
+
export type SetTagOperation = 'SetTagOperationUnknown' | 'SetTagOperationOverwrite' | 'SetTagOperationAppend' | 'SetTagOperationRemove' | 'SetTagOperationIncrement' | 'SetTagOperationDecrement';
|
|
989
|
+
export type TagValueList = {
|
|
990
|
+
value: string[];
|
|
991
|
+
};
|
|
992
|
+
export type TagValueDynamic = {
|
|
993
|
+
pointId: string;
|
|
994
|
+
eventName: string;
|
|
995
|
+
attribute: string;
|
|
996
|
+
applicationCode: string;
|
|
997
|
+
};
|
|
998
|
+
export type PointParamsSetTags = {
|
|
999
|
+
applicationCode: string;
|
|
1000
|
+
tags: Tag[];
|
|
1001
|
+
};
|
|
1002
|
+
export type Position = {
|
|
1003
|
+
x: number;
|
|
1004
|
+
y: number;
|
|
1005
|
+
};
|
|
1006
|
+
export type PointParamsStartByAPI = {
|
|
1007
|
+
applicationCode: string;
|
|
1008
|
+
entryLimitsEnabled: boolean;
|
|
1009
|
+
entryLimitsPerSecond: number;
|
|
1010
|
+
isDeactivated: boolean;
|
|
1011
|
+
attributes: string[];
|
|
1012
|
+
};
|
|
1013
|
+
export type PointParamsTerminator = {};
|
|
1014
|
+
export type Capping = {
|
|
1015
|
+
enabled: boolean;
|
|
1016
|
+
count: number;
|
|
1017
|
+
days: number;
|
|
1018
|
+
doNotIncrease: boolean;
|
|
1019
|
+
};
|
|
1020
|
+
export type InboxOptions = {
|
|
1021
|
+
enabled: boolean;
|
|
1022
|
+
expireAtDate: Date;
|
|
1023
|
+
expireInDays: number;
|
|
1024
|
+
imgUrl: string;
|
|
1025
|
+
richMediaCode: string;
|
|
1026
|
+
};
|
|
1027
|
+
export type GetJourneyStatsByPointsExternalRequest = {
|
|
1028
|
+
uuid?: string;
|
|
1029
|
+
fromDate?: string;
|
|
1030
|
+
toDate?: string;
|
|
1031
|
+
};
|
|
1032
|
+
export type GetJourneyStatsByPointsExternalResponse = {
|
|
1033
|
+
payload: JourneyStatsByPointsExternalResponsePayload;
|
|
1034
|
+
};
|
|
1035
|
+
export type JourneyStatsByPointsExternalResponsePayload = {
|
|
1036
|
+
points: JourneyStatsByPointsExternalItemGet[];
|
|
1037
|
+
title: string;
|
|
1038
|
+
};
|
|
1039
|
+
export type JourneyStatsByPointsExternalItemGet = {
|
|
1040
|
+
pointTitle: string;
|
|
1041
|
+
campaignCode: string;
|
|
1042
|
+
presetCode: string;
|
|
1043
|
+
pointStat: PointStat;
|
|
1044
|
+
};
|
|
1045
|
+
export type GetJourneyStatsByPointRequest = {
|
|
1046
|
+
uuid?: string;
|
|
1047
|
+
fromDate?: string;
|
|
1048
|
+
toDate?: string;
|
|
1049
|
+
};
|
|
1050
|
+
export type GetJourneyStatsByPointResponse = {
|
|
1051
|
+
metadata: JourneyStatsByPointMeta;
|
|
1052
|
+
payload: JourneyStatsByPointsResponsePayload;
|
|
1053
|
+
};
|
|
1054
|
+
export type JourneyStatsByPointsResponsePayload = {
|
|
1055
|
+
points: JourneyStatsByPointsItemGet[];
|
|
1056
|
+
journey: JourneyStatItems;
|
|
1057
|
+
};
|
|
1058
|
+
export type JourneyStatsByPointsItemGet = {
|
|
1059
|
+
pointId: string;
|
|
1060
|
+
pointType: string;
|
|
1061
|
+
journeyId: string;
|
|
1062
|
+
pointStat: PointStat;
|
|
1063
|
+
pointOutputStat: PointOutputStat[];
|
|
1064
|
+
waitingTravellers: number;
|
|
1065
|
+
entries: number;
|
|
1066
|
+
};
|
|
1067
|
+
export type JourneyStatItems = {
|
|
1068
|
+
total: number;
|
|
1069
|
+
uniqueUsersCount: number;
|
|
1070
|
+
avgCtr: number;
|
|
1071
|
+
left: number;
|
|
1072
|
+
leftByError: number;
|
|
1073
|
+
inside: number;
|
|
1074
|
+
achievedGoal: number;
|
|
1075
|
+
goals: Record<string, number>;
|
|
1076
|
+
goalsByPoints: Record<string, number>;
|
|
1077
|
+
goalsToPointsMap: Record<string, GoalPointStats>;
|
|
1078
|
+
pointsToGoalsMap: Record<string, GoalPointStats>;
|
|
1079
|
+
abSplitStats: Record<string, ABSplitStat>;
|
|
1080
|
+
totalSkipped: number;
|
|
1081
|
+
};
|
|
1082
|
+
export type PointOutputStat = {
|
|
1083
|
+
key: string;
|
|
1084
|
+
nextPointId: string;
|
|
1085
|
+
count: number;
|
|
1086
|
+
errors: Record<string, number>;
|
|
1087
|
+
};
|
|
1088
|
+
export type ABSplitStat = {
|
|
1089
|
+
id: string;
|
|
1090
|
+
outputs: Record<string, ABOutputStats>;
|
|
1091
|
+
};
|
|
1092
|
+
export type ABOutputStats = {
|
|
1093
|
+
items: ABOutputStat[];
|
|
1094
|
+
};
|
|
1095
|
+
export type ABOutputStat = {
|
|
1096
|
+
visits: number;
|
|
1097
|
+
goals: number;
|
|
1098
|
+
goalUuid: string;
|
|
1099
|
+
conversion: number;
|
|
1100
|
+
uplift: number;
|
|
1101
|
+
zScore: number;
|
|
1102
|
+
pValue: number;
|
|
1103
|
+
betterThanControl: boolean;
|
|
1104
|
+
significant: boolean;
|
|
1105
|
+
message: string;
|
|
1106
|
+
};
|
|
1107
|
+
export type GoalPointStats = {
|
|
1108
|
+
items: GoalPointStat[];
|
|
1109
|
+
};
|
|
1110
|
+
export type GoalPointStat = {
|
|
1111
|
+
pointUuid: string;
|
|
1112
|
+
count: number;
|
|
1113
|
+
};
|
|
1114
|
+
export type GetAccountRestrictionValuesRequest = {};
|
|
1115
|
+
export type GetAccountRestrictionValuesResponse = {
|
|
1116
|
+
payload: AccountRestrictionValues;
|
|
1117
|
+
};
|
|
1118
|
+
export type AccountRestrictionValues = {
|
|
1119
|
+
allowCjSms: boolean;
|
|
1120
|
+
allowCjWhatsapp: boolean;
|
|
1121
|
+
allowCjDynamicSetTagsInUpdateProfile: boolean;
|
|
1122
|
+
allowCjAddBranchesInWaitForTrigger: boolean;
|
|
1123
|
+
allowCjEmailBcc: boolean;
|
|
1124
|
+
allowCjLine: boolean;
|
|
1125
|
+
};
|
|
1126
|
+
export type GetJourneyGeneralTimeStatisticsRequest = {
|
|
1127
|
+
uuid?: string;
|
|
1128
|
+
application?: string;
|
|
1129
|
+
timestampFrom?: string;
|
|
1130
|
+
timestampTo?: string;
|
|
1131
|
+
};
|
|
1132
|
+
export type GetJourneyGeneralTimeStatisticsResponse_MetricTimeseries = {
|
|
1133
|
+
breakdown: string;
|
|
1134
|
+
values: number[];
|
|
1135
|
+
};
|
|
1136
|
+
export type GetJourneyGeneralTimeStatisticsResponse = {
|
|
1137
|
+
timestamps: string[];
|
|
1138
|
+
entrances: GetJourneyGeneralTimeStatisticsResponse_MetricTimeseries[];
|
|
1139
|
+
sendsByChannel: GetJourneyGeneralTimeStatisticsResponse_MetricTimeseries[];
|
|
1140
|
+
dropOffs: GetJourneyGeneralTimeStatisticsResponse_MetricTimeseries[];
|
|
1141
|
+
goals: GetJourneyGeneralTimeStatisticsResponse_MetricTimeseries[];
|
|
1142
|
+
totalEntrances: number;
|
|
1143
|
+
totalSends: number;
|
|
1144
|
+
totalOpens: number;
|
|
1145
|
+
totalDropOffs: number;
|
|
1146
|
+
recipients: number;
|
|
1147
|
+
};
|
|
1148
|
+
export type GetJourneyUsersRequest = {
|
|
1149
|
+
uuid?: string;
|
|
1150
|
+
application?: string;
|
|
1151
|
+
search?: string;
|
|
1152
|
+
timestampFrom?: string;
|
|
1153
|
+
timestampTo?: string;
|
|
1154
|
+
pageSize?: number;
|
|
1155
|
+
page?: number;
|
|
1156
|
+
};
|
|
1157
|
+
export type UserStatus = 'unknown' | 'inJourneyNow' | 'exited' | 'droppedOff';
|
|
1158
|
+
export type GetJourneyUsersResponse_UserPoint = {
|
|
1159
|
+
userId: string;
|
|
1160
|
+
lastPointType: string;
|
|
1161
|
+
lastPointName: string;
|
|
1162
|
+
status: UserStatus;
|
|
1163
|
+
enterPointType: string;
|
|
1164
|
+
enterPointName: string;
|
|
1165
|
+
};
|
|
1166
|
+
export type GetJourneyUsersResponse = {
|
|
1167
|
+
users: GetJourneyUsersResponse_UserPoint[];
|
|
1168
|
+
totals: number;
|
|
1169
|
+
};
|
|
1170
|
+
export type GetVoucherPoolsRequest = {
|
|
1171
|
+
applicationCode?: string;
|
|
1172
|
+
};
|
|
1173
|
+
export type GetVoucherPoolsResponse = {
|
|
1174
|
+
payload: VoucherPool[];
|
|
1175
|
+
};
|
|
1176
|
+
export type VoucherPool = {
|
|
1177
|
+
name: string;
|
|
1178
|
+
};
|