@pushwoosh/rpc-gateway-journey-data 0.26.506 → 0.27.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.
@@ -1,4 +1,4 @@
1
- import { DoubleValue as google_protobuf_DoubleValue } from './google_protobuf';
1
+ import { FilterExpression as pushwoosh_objects_filters_v1_FilterExpression } from './pushwoosh_objects_filters_v1';
2
2
  export interface Journey {
3
3
  GetJourneysList(request: GetJourneysListRequest): Promise<GetJourneysListResponse>;
4
4
  GetJourneyByUUID(request: GetJourneyByUUIDRequest): Promise<GetJourneyByUUIDResponse>;
@@ -28,7 +28,35 @@ export interface Journey {
28
28
  GetAccountRestrictionValues(request: GetAccountRestrictionValuesRequest): Promise<GetAccountRestrictionValuesResponse>;
29
29
  GetJourneyGeneralTimeStatistics(request: GetJourneyGeneralTimeStatisticsRequest): Promise<GetJourneyGeneralTimeStatisticsResponse>;
30
30
  GetJourneyUsers(request: GetJourneyUsersRequest): Promise<GetJourneyUsersResponse>;
31
+ GetJourneyMetrics(request: GetJourneyMetricsRequest): Promise<GetJourneyMetricsResponse>;
32
+ GetJourneyDeliveryReport(request: GetJourneyDeliveryReportRequest): Promise<GetJourneyDeliveryReportResponse>;
31
33
  GetVoucherPools(request: GetVoucherPoolsRequest): Promise<GetVoucherPoolsResponse>;
34
+ StartJourneyV2(request: StartJourneyV2Request): Promise<StartJourneyResponse>;
35
+ PauseJourneyV2(request: PauseJourneyV2Request): Promise<PauseJourneyResponse>;
36
+ FinishJourneyV2(request: FinishJourneyV2Request): Promise<FinishJourneyResponse>;
37
+ DraftJourneyV2(request: DraftJourneyV2Request): Promise<DraftJourneyResponse>;
38
+ ArchiveJourneyV2(request: ArchiveJourneyV2Request): Promise<ArchiveJourneyResponse>;
39
+ UpdateJourneyV2(request: UpdateJourneyV2Request): Promise<UpdateJourneyResponse>;
40
+ UpdateAndResumeJourneyV2(request: UpdateAndResumeJourneyV2Request): Promise<UpdateAndResumeJourneyResponseV2>;
41
+ CreateV2(request: CreateV2Request): Promise<CreateJourneyResponse>;
42
+ RenameV2(request: RenameV2Request): Promise<RenameJourneyResponse>;
43
+ UpdateABSSplitterParamsV2(request: UpdateABSSplitterParamsV2Request): Promise<UpdateABSSplitterParamsResponse>;
44
+ ValidateJourneyV2(request: ValidateJourneyV2Request): Promise<ValidateJourneyResponse>;
45
+ GetWhatsAppPresetsByAppCode(request: GetWhatsAppPresetsByAppCodeRequest): Promise<GetWhatsAppPresetsByAppCodeResponse>;
46
+ GetEmailPresetsByAppCode(request: GetEmailPresetsByAppCodeRequest): Promise<GetEmailPresetsByAppCodeResponse>;
47
+ GetLinePresetsByAppCode(request: GetLinePresetsByAppCodeRequest): Promise<GetLinePresetsByAppCodeResponse>;
48
+ GetSmsPresetsByAppCode(request: GetSmsPresetsByAppCodeRequest): Promise<GetSmsPresetsByAppCodeResponse>;
49
+ GetPushPresetsByAppCode(request: GetPushPresetsByAppCodeRequest): Promise<GetPushPresetsByAppCodeResponse>;
50
+ GetEventsByApplicationCode(request: GetEventsByApplicationCodeRequest): Promise<GetEventsByApplicationCodeResponse>;
51
+ GetEventAttributeValues(request: GetEventAttributeValuesRequest): Promise<GetEventAttributeValuesResponse>;
52
+ GetRichMediaByApplicationCode(request: GetRichMediaByApplicationCodeRequest): Promise<GetRichMediaByApplicationCodeResponse>;
53
+ GetRichMediaByCode(request: GetRichMediaByCodeRequest): Promise<GetRichMediaByCodeResponse>;
54
+ TestWebhook(request: TestWebhookRequest): Promise<TestWebhookResponse>;
55
+ GetApplicationsByAccountId(request: GetApplicationsByAccountIdRequest): Promise<GetApplicationsByAccountIdResponse>;
56
+ GetFiltersByAccountId(request: GetFiltersByAccountIdRequest): Promise<GetFiltersByAccountIdResponse>;
57
+ GetEventsByApplicationCodes(request: GetEventsByApplicationCodesRequest): Promise<GetEventsByApplicationCodesResponse>;
58
+ GetMetaAdAccounts(request: GetMetaAdAccountsRequest): Promise<GetMetaAdAccountsResponse>;
59
+ GetMetaAudiences(request: GetMetaAudiencesRequest): Promise<GetMetaAudiencesResponse>;
32
60
  }
33
61
  export type GetPlaceholdersRequest = {
34
62
  templateCode?: string;
@@ -79,11 +107,14 @@ export type AutocompleteValue_kind = AutocompleteValue_kind_intValue | Autocompl
79
107
  export type AutocompleteValue = {
80
108
  kind: AutocompleteValue_kind;
81
109
  };
110
+ export type WinnerStrategy = 'ANY_GOAL' | 'SPECIFIC_GOAL';
82
111
  export type UpdateABSSplitterParamsRequest = {
83
112
  journeyUuid?: string;
84
113
  pointUuid?: string;
85
114
  params?: number[];
86
115
  autoSelectWinner?: boolean;
116
+ winnerStrategy?: WinnerStrategy;
117
+ goalUuid?: string;
87
118
  };
88
119
  export type CloneJourneysRequest = {
89
120
  journeyUuids?: string[];
@@ -172,7 +203,19 @@ export type PointStat_pointStat_sendLine = {
172
203
  type: 'sendLine';
173
204
  data: PointStatSendLine;
174
205
  };
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;
206
+ export type PointStat_pointStat_sendKakao = {
207
+ type: 'sendKakao';
208
+ data: PointStatSendKakao;
209
+ };
210
+ export type PointStat_pointStat_sendTelegram = {
211
+ type: 'sendTelegram';
212
+ data: PointStatSendTelegram;
213
+ };
214
+ export type PointStat_pointStat_audienceSync = {
215
+ type: 'audienceSync';
216
+ data: PointStatAudienceSync;
217
+ };
218
+ 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 | PointStat_pointStat_sendKakao | PointStat_pointStat_sendTelegram | PointStat_pointStat_audienceSync;
176
219
  export type PointStat = {
177
220
  pointStat: PointStat_pointStat;
178
221
  };
@@ -182,6 +225,15 @@ export type PointStatSendPush = {
182
225
  conversion: number;
183
226
  skipped: number;
184
227
  skippedDueCappingSettings: number;
228
+ errors: number;
229
+ unshowableSends: number;
230
+ recipients: number;
231
+ voucherStats: VoucherPoolStats;
232
+ delivered: number;
233
+ notDelivered: number;
234
+ notOpened: number;
235
+ frequencyCappingUniqueUsers: number;
236
+ frequencyCappingSuppressions: number;
185
237
  };
186
238
  export type PointStatInApp = {
187
239
  shows: number;
@@ -194,20 +246,50 @@ export type PointStatSendSms = {
194
246
  sent: number;
195
247
  delivered: number;
196
248
  skipped: number;
249
+ errors: number;
250
+ recipients: number;
251
+ voucherStats: VoucherPoolStats;
252
+ frequencyCappingUniqueUsers: number;
253
+ frequencyCappingSuppressions: number;
197
254
  };
198
255
  export type PointStatSendLine = {
199
256
  sent: number;
200
257
  delivered: number;
258
+ errors: number;
259
+ recipients: number;
260
+ voucherStats: VoucherPoolStats;
261
+ frequencyCappingUniqueUsers: number;
262
+ frequencyCappingSuppressions: number;
263
+ };
264
+ export type PointStatSendKakao = {
265
+ sent: number;
266
+ delivered: number;
267
+ errors: number;
268
+ recipients: number;
269
+ voucherStats: VoucherPoolStats;
270
+ };
271
+ export type PointStatSendTelegram = {
272
+ sent: number;
273
+ delivered: number;
274
+ errors: number;
275
+ recipients: number;
276
+ voucherStats: VoucherPoolStats;
201
277
  };
202
278
  export type PointStatSendWhatsApp = {
203
279
  sent: number;
204
280
  totalOpened: number;
205
281
  skipped: number;
282
+ errors: number;
283
+ recipients: number;
284
+ voucherStats: VoucherPoolStats;
285
+ frequencyCappingUniqueUsers: number;
286
+ frequencyCappingSuppressions: number;
206
287
  };
207
288
  export type PointStatSendData = {
208
289
  sent: number;
209
290
  delivered: number;
210
291
  skipped: number;
292
+ voucherStats: VoucherPoolStats;
211
293
  };
212
294
  export type PointStatSendEmail = {
213
295
  sent: number;
@@ -218,6 +300,16 @@ export type PointStatSendEmail = {
218
300
  softBounces: number;
219
301
  complaints: number;
220
302
  skipped: number;
303
+ errors: number;
304
+ recipients: number;
305
+ voucherStats: VoucherPoolStats;
306
+ totalOpened: number;
307
+ frequencyCappingUniqueUsers: number;
308
+ frequencyCappingSuppressions: number;
309
+ };
310
+ export type PointStatAudienceSync = {
311
+ synced: number;
312
+ skipped: number;
221
313
  };
222
314
  export type PointStatMessageBus = {};
223
315
  export type PointStatGoalEvent = {};
@@ -225,6 +317,10 @@ export type PointStatTerminator = {};
225
317
  export type PointStatDelay = {};
226
318
  export type PointStatBooleanSplitter = {};
227
319
  export type PointStatWaitEvent = {};
320
+ export type VoucherPoolStats = {
321
+ total: number;
322
+ free: number;
323
+ };
228
324
  export type GetJourneyStatsRequest = {
229
325
  journeyIds?: string[];
230
326
  };
@@ -241,7 +337,7 @@ export type JourneyStatsPayloadGet = {
241
337
  export type JourneySummaryStats = {
242
338
  in: number;
243
339
  goals: number;
244
- avrCTR: google_protobuf_DoubleValue;
340
+ avrCTR: number;
245
341
  };
246
342
  export type RenameRequest = {
247
343
  uuid?: string;
@@ -351,15 +447,20 @@ export type FloatArray = {
351
447
  export type StringMap = {
352
448
  values: Record<string, string>;
353
449
  };
450
+ export type JourneyChangelogRecords = {
451
+ changes: Change[];
452
+ goals: Record<string, PointsChangelog>;
453
+ };
354
454
  export type ChangelogRecords = {
355
455
  changes: Change[];
356
456
  };
357
457
  export type PointChangelogRecords = {
358
458
  pointType: string;
359
459
  changes: Change[];
460
+ title: string;
360
461
  };
361
462
  export type Changelog = {
362
- journey: ChangelogRecords;
463
+ journey: JourneyChangelogRecords;
363
464
  points: Record<string, PointsChangelog>;
364
465
  comments: Record<string, CommentsChangelog>;
365
466
  };
@@ -386,11 +487,14 @@ export type GetJourneysListRequest = {
386
487
  statuses?: JourneyStatus[];
387
488
  categoryUuids?: string[];
388
489
  filterTitle?: string;
389
- sorting?: Sorting[];
490
+ sortField?: string;
390
491
  page?: number;
391
492
  pageSize?: number;
392
493
  campaignTypes?: CampaignType[];
393
494
  uuidList?: string[];
495
+ sortOrder?: string;
496
+ activatedAtFrom?: Date;
497
+ activatedAtTo?: Date;
394
498
  };
395
499
  export type GetJourneysListResponse = {
396
500
  journeys: Info[];
@@ -408,6 +512,112 @@ export type GetJourneyByUUIDResponseWithErrors = {
408
512
  response: GetJourneyByUUIDResponse;
409
513
  validation: ValidateJourneyResponse;
410
514
  };
515
+ export type StartJourneyResponse = {
516
+ info: Info;
517
+ points: Point[];
518
+ comments: JourneyComment[];
519
+ };
520
+ export type PauseJourneyResponse = {
521
+ info: Info;
522
+ points: Point[];
523
+ comments: JourneyComment[];
524
+ };
525
+ export type FinishJourneyResponse = {
526
+ info: Info;
527
+ points: Point[];
528
+ comments: JourneyComment[];
529
+ };
530
+ export type DraftJourneyResponse = {
531
+ info: Info;
532
+ points: Point[];
533
+ comments: JourneyComment[];
534
+ };
535
+ export type ArchiveJourneyResponse = {
536
+ info: Info;
537
+ points: Point[];
538
+ comments: JourneyComment[];
539
+ };
540
+ export type UpdateJourneyResponse = {
541
+ info: Info;
542
+ points: Point[];
543
+ comments: JourneyComment[];
544
+ };
545
+ export type CreateJourneyResponse = {
546
+ info: Info;
547
+ points: Point[];
548
+ comments: JourneyComment[];
549
+ };
550
+ export type RenameJourneyResponse = {
551
+ info: Info;
552
+ points: Point[];
553
+ comments: JourneyComment[];
554
+ };
555
+ export type UpdateABSSplitterParamsResponse = {
556
+ info: Info;
557
+ points: Point[];
558
+ comments: JourneyComment[];
559
+ };
560
+ export type UpdateAndResumeJourneyInfo = {
561
+ info: Info;
562
+ points: Point[];
563
+ comments: JourneyComment[];
564
+ };
565
+ export type UpdateAndResumeJourneyResponseV2 = {
566
+ response: UpdateAndResumeJourneyInfo;
567
+ validation: ValidateJourneyResponse;
568
+ };
569
+ export type StartJourneyV2Request = {
570
+ uuid?: string;
571
+ };
572
+ export type PauseJourneyV2Request = {
573
+ uuid?: string;
574
+ };
575
+ export type FinishJourneyV2Request = {
576
+ uuid?: string;
577
+ };
578
+ export type DraftJourneyV2Request = {
579
+ uuid?: string;
580
+ };
581
+ export type ArchiveJourneyV2Request = {
582
+ uuid?: string;
583
+ };
584
+ export type UpdateJourneyV2Request = {
585
+ uuid?: string;
586
+ title?: string;
587
+ params?: JourneyParams;
588
+ points?: Point[];
589
+ comments?: JourneyComment[];
590
+ autosave?: boolean;
591
+ };
592
+ export type UpdateAndResumeJourneyV2Request = {
593
+ uuid?: string;
594
+ title?: string;
595
+ params?: JourneyParams;
596
+ points?: Point[];
597
+ comments?: JourneyComment[];
598
+ autosave?: boolean;
599
+ };
600
+ export type CreateV2Request = {
601
+ title?: string;
602
+ params?: JourneyParams;
603
+ points?: Point[];
604
+ comments?: JourneyComment[];
605
+ };
606
+ export type RenameV2Request = {
607
+ uuid?: string;
608
+ title?: string;
609
+ };
610
+ export type UpdateABSSplitterParamsV2Request = {
611
+ journeyUuid?: string;
612
+ pointUuid?: string;
613
+ params?: number[];
614
+ autoSelectWinner?: boolean;
615
+ winnerStrategy?: WinnerStrategy;
616
+ goalUuid?: string;
617
+ };
618
+ export type ValidateJourneyV2Request = {
619
+ uuid?: string;
620
+ };
411
621
  export type MoveJourneysToCategoryRequest = {
412
622
  journeyUuids?: string[];
413
623
  categoryUuid?: string;
@@ -447,13 +657,9 @@ export type GetUserFlowResponse_Flow = {
447
657
  export type GetUserFlowResponse = {
448
658
  flows: GetUserFlowResponse_Flow[];
449
659
  };
450
- export type Sorting = {
451
- field: string;
452
- direction: string;
453
- };
454
660
  export type JourneyStatus = 'STATUS_DRAFT' | 'STATUS_RUNNING' | 'STATUS_FINISHED' | 'STATUS_ARCHIVED' | 'STATUS_PAUSED' | 'STATUS_UNKNOWN';
455
661
  export type PointEventAttributeType = 'ATTRIBUTE_UNKNOWN' | 'INTEGER' | 'STRING' | 'LIST' | 'DATE' | 'BOOLEAN' | 'FLOAT';
456
- export type PointEventConditionOperator = 'OPERATOR_UNKNOWN' | 'EQ' | 'LTE' | 'GTE' | 'NOTEQ' | 'IN' | 'NOTIN' | 'BETWEEN';
662
+ export type PointEventConditionOperator = 'OPERATOR_UNKNOWN' | 'EQ' | 'LTE' | 'GTE' | 'NOTEQ' | 'IN' | 'NOTIN' | 'BETWEEN' | 'STARTS_WITH' | 'ENDS_WITH' | 'CONTAINS';
457
663
  export type PointEventCondition_value_int = {
458
664
  type: 'int';
459
665
  data: PointEventConditionValueInt;
@@ -523,12 +729,14 @@ export type Info = {
523
729
  campaignType: CampaignType;
524
730
  stopReason: string;
525
731
  lastEditedBy: User;
732
+ dynamicEntry: boolean;
526
733
  };
527
734
  export type User = {
528
735
  id: number;
529
736
  email: string;
530
737
  username: string;
531
738
  };
739
+ export type PointType = 'POINT_TYPE_UNKNOWN' | 'POINT_TYPE_WAIT' | 'POINT_TYPE_EVENT' | 'POINT_TYPE_EXIT' | 'POINT_TYPE_SEND_PUSH' | 'POINT_TYPE_GOAL_EVENT' | 'POINT_TYPE_SEND_EMAIL' | 'POINT_TYPE_SEND_SMS' | 'POINT_TYPE_SEND_WHATSAPP' | 'POINT_TYPE_SEND_LINE' | 'POINT_TYPE_SEND_DATA' | 'POINT_TYPE_BOOLEAN_SPLITTER' | 'POINT_TYPE_FILTER' | 'POINT_TYPE_WAIT_EVENT' | 'POINT_TYPE_INAPP' | 'POINT_TYPE_START_BY_SEGMENT' | 'POINT_TYPE_AB_SPLITTER' | 'POINT_TYPE_SET_TAGS' | 'POINT_TYPE_WEBHOOK' | 'POINT_TYPE_START_BY_API' | 'POINT_TYPE_SEND_KAKAO' | 'POINT_TYPE_SEND_TELEGRAM' | 'POINT_TYPE_AUDIENCE_SYNC';
532
740
  export type Point = {
533
741
  uuid: string;
534
742
  title: string;
@@ -536,6 +744,7 @@ export type Point = {
536
744
  outputs: PointOutput[];
537
745
  position: Position;
538
746
  pointData: PointDataWrapper;
747
+ pointType: PointType;
539
748
  };
540
749
  export type PointDataWrapper_data_messageBus = {
541
750
  type: 'messageBus';
@@ -613,7 +822,19 @@ export type PointDataWrapper_data_sendLine = {
613
822
  type: 'sendLine';
614
823
  data: PointParamsSendLine;
615
824
  };
616
- 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;
825
+ export type PointDataWrapper_data_sendKakao = {
826
+ type: 'sendKakao';
827
+ data: PointParamsSendKakao;
828
+ };
829
+ export type PointDataWrapper_data_sendTelegram = {
830
+ type: 'sendTelegram';
831
+ data: PointParamsSendTelegram;
832
+ };
833
+ export type PointDataWrapper_data_audienceSync = {
834
+ type: 'audienceSync';
835
+ data: PointParamsAudienceSync;
836
+ };
837
+ 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 | PointDataWrapper_data_sendKakao | PointDataWrapper_data_sendTelegram | PointDataWrapper_data_audienceSync;
617
838
  export type PointDataWrapper = {
618
839
  data: PointDataWrapper_data;
619
840
  };
@@ -648,11 +869,13 @@ export type JourneyParamsEntryCapping = {
648
869
  export type JourneyParamsConversionWindow = {
649
870
  seconds: number;
650
871
  };
872
+ export type UserIDTrackChangePolicy = 'DEFAULT' | 'TRACK' | 'DROP';
651
873
  export type JourneyParams = {
652
874
  silentHours: JourneyParamsSilentHours;
653
875
  capping: JourneyParamsEntryCapping;
654
876
  applicationCode: string;
655
877
  conversionWindow: JourneyParamsConversionWindow;
878
+ userIdTrackChangePolicy: UserIDTrackChangePolicy;
656
879
  };
657
880
  export type JourneyComment = {
658
881
  id: string;
@@ -667,19 +890,28 @@ export type PointParamsMessageBus = {
667
890
  applicationCode: string;
668
891
  eventConditions: PointEventCondition[];
669
892
  activePeriod: Period;
893
+ multiEntry: MultiEntry;
894
+ attributeEntry: AttributeEntry;
895
+ allowReenter: boolean;
670
896
  };
671
897
  export type Period = {
672
898
  enabled: boolean;
673
899
  start: Date;
674
900
  end: Date;
901
+ timezone: string;
902
+ };
903
+ export type SendRate_Policy = 'UNKNOWN' | 'GLOBAL' | 'CUSTOM' | 'IGNORE';
904
+ export type SendRate = {
905
+ policy: SendRate_Policy;
906
+ sendRate: number;
675
907
  };
676
908
  export type PointParamsSendPush = {
677
909
  presetCode: string;
678
910
  content: string;
679
911
  title: string;
680
912
  applicationCode: string;
681
- campaignCode: string;
682
- campaignUid: number;
913
+ campaignCode?: string;
914
+ campaignUid?: number;
683
915
  splitParams: BehaviorSplitter;
684
916
  sendByUserId: boolean;
685
917
  waitOptimalTime: boolean;
@@ -689,30 +921,61 @@ export type PointParamsSendPush = {
689
921
  capping: Capping;
690
922
  inboxOptions: InboxOptions;
691
923
  vouchersParams: VoucherParams;
924
+ sendRate: SendRate;
925
+ messageType: MessageType;
926
+ deliverySplitParams: BehaviorSplitter;
927
+ ttl: number;
928
+ useLatestUserDevice: boolean;
692
929
  };
693
930
  export type PointParamsSendSms = {
694
931
  presetCode: string;
695
932
  content: string;
696
933
  applicationCode: string;
697
- campaignCode: string;
698
- campaignUid: number;
934
+ campaignCode?: string;
935
+ campaignUid?: number;
699
936
  splitParams: BehaviorSplitter;
700
937
  sendByUserId: boolean;
701
938
  liquidTemplateParams: LiquidTemplateParams;
702
939
  personalise: PersonalisedParams;
703
940
  capping: Capping;
941
+ vouchersParams: VoucherParams;
942
+ sendRate: SendRate;
943
+ messageType: MessageType;
704
944
  };
705
945
  export type PointParamsSendLine = {
706
946
  presetCode: string;
707
947
  content: string;
708
948
  applicationCode: string;
709
- campaignCode: string;
710
- campaignUid: number;
949
+ campaignCode?: string;
950
+ campaignUid?: number;
711
951
  splitParams: BehaviorSplitter;
712
952
  sendByUserId: boolean;
713
953
  liquidTemplateParams: LiquidTemplateParams;
714
954
  personalise: PersonalisedParams;
715
955
  capping: Capping;
956
+ vouchersParams: VoucherParams;
957
+ };
958
+ export type PointParamsSendKakao = {
959
+ presetCode: string;
960
+ applicationCode: string;
961
+ campaignCode?: string;
962
+ campaignUid?: number;
963
+ personalise: PersonalisedParams;
964
+ vouchersParams: VoucherParams;
965
+ sendByUserId: boolean;
966
+ capping: Capping;
967
+ sendRate: SendRate;
968
+ };
969
+ export type PointParamsSendTelegram = {
970
+ content: string;
971
+ applicationCode: string;
972
+ campaignCode?: string;
973
+ campaignUid?: number;
974
+ personalise: PersonalisedParams;
975
+ vouchersParams: VoucherParams;
976
+ sendByUserId: boolean;
977
+ capping: Capping;
978
+ sendRate: SendRate;
716
979
  };
717
980
  export type WhatsAppPersonalisedParams = {
718
981
  enabled: boolean;
@@ -731,23 +994,45 @@ export type WhatsAppPlaceholder = {
731
994
  component: string;
732
995
  type: string;
733
996
  value: string;
997
+ default: string;
998
+ actions?: Actions;
999
+ };
1000
+ export type Actions = {
1001
+ actions: ActionType[];
1002
+ };
1003
+ export type ActionType = {
1004
+ type: string;
1005
+ action: Action;
1006
+ };
1007
+ export type Action = {
1008
+ thumbnailProductRetailerId: string;
1009
+ sections: Section[];
1010
+ };
1011
+ export type Section = {
1012
+ title: string;
1013
+ productItems: ProductListItem[];
1014
+ };
1015
+ export type ProductListItem = {
1016
+ productRetailerId: string;
734
1017
  };
735
1018
  export type PointParamsSendWhatsApp = {
736
1019
  presetCode: string;
737
1020
  content: string;
738
1021
  applicationCode: string;
739
- campaignCode: string;
740
- campaignUid: number;
1022
+ campaignCode?: string;
1023
+ campaignUid?: number;
741
1024
  splitParams: BehaviorSplitter;
742
1025
  sendByUserId: boolean;
743
1026
  personalise: WhatsAppPersonalisedParams;
744
1027
  capping: Capping;
1028
+ vouchersParams: VoucherParams;
1029
+ messageType: MessageType;
745
1030
  };
746
1031
  export type PointParamsSendEmail = {
747
1032
  applicationCode: string;
748
1033
  presetCode: string;
749
- campaignCode: string;
750
- campaignUid: number;
1034
+ campaignCode?: string;
1035
+ campaignUid?: number;
751
1036
  splitParams: BehaviorSplitter;
752
1037
  sendOnlyToSubscribed: boolean;
753
1038
  liquidTemplateParams: LiquidTemplateParams;
@@ -755,12 +1040,20 @@ export type PointParamsSendEmail = {
755
1040
  title: string;
756
1041
  subjects: Record<string, string>;
757
1042
  bcc: string[];
758
- unsubscribedPolicy: UnsubscribedPolicy;
1043
+ unsubscribedPolicy?: UnsubscribedPolicy;
759
1044
  capping: Capping;
760
1045
  from: From;
761
1046
  replyTo: ReplyTo;
762
1047
  vouchersParams: VoucherParams;
1048
+ waitOptimalTime: boolean;
1049
+ defaultOptimalTime: ExactTime;
1050
+ sendRate: SendRate;
1051
+ emailType: string;
1052
+ emailCategory: string;
1053
+ subjectSource: ValueSource;
1054
+ senderInfoSource: ValueSource;
763
1055
  };
1056
+ export type ValueSource = 'VALUE_SOURCE_DEFAULT' | 'VALUE_SOURCE_FROM_POINT' | 'VALUE_SOURCE_FROM_PRESET';
764
1057
  export type From = {
765
1058
  name: string;
766
1059
  email: string;
@@ -772,19 +1065,175 @@ export type ReplyTo = {
772
1065
  export type PointParamsSendData = {
773
1066
  content: string;
774
1067
  applicationCode: string;
775
- campaignCode: string;
776
- campaignUid: number;
1068
+ campaignCode?: string;
1069
+ campaignUid?: number;
777
1070
  sendByUserId: boolean;
778
1071
  liquidTemplateParams: LiquidTemplateParams;
779
1072
  personalise: PersonalisedParams;
1073
+ vouchersParams: VoucherParams;
780
1074
  };
781
1075
  export type UnsubscribedPolicy = 'UNKNOWN' | 'IGNORE' | 'SEND';
1076
+ export type MessageType = 'Marketing' | 'Transactional';
1077
+ export type IntTagValueList = {
1078
+ value: number[];
1079
+ };
1080
+ export type StrTagValueList = {
1081
+ value: string[];
1082
+ };
1083
+ export type DateTagValueList = {
1084
+ value: Date[];
1085
+ };
1086
+ export type PriceTagValueList = {
1087
+ value: number[];
1088
+ };
1089
+ export type VersionTagValueList = {
1090
+ value: string[];
1091
+ };
1092
+ export type TimezoneTagValueList = {
1093
+ value: number[];
1094
+ };
1095
+ export type TagSplitterConditionGroup = {
1096
+ conditions: TagSplitterCondition[];
1097
+ };
1098
+ export type TagSplitterCondition_TagSplitterTagType = 'TAG_SPLITTER_TYPE_UNKNOWN' | 'TAG_SPLITTER_TYPE_INTEGER' | 'TAG_SPLITTER_TYPE_STRING' | 'TAG_SPLITTER_TYPE_LIST' | 'TAG_SPLITTER_TYPE_DATE' | 'TAG_SPLITTER_TYPE_BOOLEAN' | 'TAG_SPLITTER_TYPE_PRICE' | 'TAG_SPLITTER_TYPE_VERSION' | 'TAG_SPLITTER_TYPE_TIMEZONE';
1099
+ export type TagSplitterCondition_value_int = {
1100
+ type: 'int';
1101
+ data: number;
1102
+ };
1103
+ export type TagSplitterCondition_value_intRange = {
1104
+ type: 'intRange';
1105
+ data: IntTagValueList;
1106
+ };
1107
+ export type TagSplitterCondition_value_str = {
1108
+ type: 'str';
1109
+ data: string;
1110
+ };
1111
+ export type TagSplitterCondition_value_strRange = {
1112
+ type: 'strRange';
1113
+ data: StrTagValueList;
1114
+ };
1115
+ export type TagSplitterCondition_value_date = {
1116
+ type: 'date';
1117
+ data: Date;
1118
+ };
1119
+ export type TagSplitterCondition_value_dateRange = {
1120
+ type: 'dateRange';
1121
+ data: DateTagValueList;
1122
+ };
1123
+ export type TagSplitterCondition_value_bool = {
1124
+ type: 'bool';
1125
+ data: boolean;
1126
+ };
1127
+ export type TagSplitterCondition_value_price = {
1128
+ type: 'price';
1129
+ data: number;
1130
+ };
1131
+ export type TagSplitterCondition_value_priceRange = {
1132
+ type: 'priceRange';
1133
+ data: PriceTagValueList;
1134
+ };
1135
+ export type TagSplitterCondition_value_version = {
1136
+ type: 'version';
1137
+ data: string;
1138
+ };
1139
+ export type TagSplitterCondition_value_versionRange = {
1140
+ type: 'versionRange';
1141
+ data: VersionTagValueList;
1142
+ };
1143
+ export type TagSplitterCondition_value_timezone = {
1144
+ type: 'timezone';
1145
+ data: number;
1146
+ };
1147
+ export type TagSplitterCondition_value_timezoneRange = {
1148
+ type: 'timezoneRange';
1149
+ data: TimezoneTagValueList;
1150
+ };
1151
+ export type TagSplitterCondition_value = TagSplitterCondition_value_int | TagSplitterCondition_value_intRange | TagSplitterCondition_value_str | TagSplitterCondition_value_strRange | TagSplitterCondition_value_date | TagSplitterCondition_value_dateRange | TagSplitterCondition_value_bool | TagSplitterCondition_value_price | TagSplitterCondition_value_priceRange | TagSplitterCondition_value_version | TagSplitterCondition_value_versionRange | TagSplitterCondition_value_timezone | TagSplitterCondition_value_timezoneRange;
1152
+ export type TagSplitterCondition = {
1153
+ tagId: number;
1154
+ tagType: TagSplitterCondition_TagSplitterTagType;
1155
+ operator: string;
1156
+ value: TagSplitterCondition_value;
1157
+ };
1158
+ export type DateFilterMode = 'DATE_FILTER_MODE_UNKNOWN' | 'DATE_FILTER_MODE_DAYS_AGO' | 'DATE_FILTER_MODE_HOURS_AGO' | 'DATE_FILTER_MODE_MINUTES_AGO';
1159
+ export type EventConditionValueInt = {
1160
+ value: number;
1161
+ };
1162
+ export type EventConditionValueIntRange = {
1163
+ value: number[];
1164
+ };
1165
+ export type EventConditionValueFloat = {
1166
+ value: number;
1167
+ };
1168
+ export type EventConditionValueFloatRange = {
1169
+ value: number[];
1170
+ };
1171
+ export type EventConditionValueStr = {
1172
+ value: string;
1173
+ };
1174
+ export type EventConditionValueStrRange = {
1175
+ value: string[];
1176
+ };
1177
+ export type EventConditionValueBool = {
1178
+ value: boolean;
1179
+ };
1180
+ export type BooleanSplitterEventCondition_value_int = {
1181
+ type: 'int';
1182
+ data: EventConditionValueInt;
1183
+ };
1184
+ export type BooleanSplitterEventCondition_value_intRange = {
1185
+ type: 'intRange';
1186
+ data: EventConditionValueIntRange;
1187
+ };
1188
+ export type BooleanSplitterEventCondition_value_str = {
1189
+ type: 'str';
1190
+ data: EventConditionValueStr;
1191
+ };
1192
+ export type BooleanSplitterEventCondition_value_strRange = {
1193
+ type: 'strRange';
1194
+ data: EventConditionValueStrRange;
1195
+ };
1196
+ export type BooleanSplitterEventCondition_value_bool = {
1197
+ type: 'bool';
1198
+ data: EventConditionValueBool;
1199
+ };
1200
+ export type BooleanSplitterEventCondition_value_float = {
1201
+ type: 'float';
1202
+ data: EventConditionValueFloat;
1203
+ };
1204
+ export type BooleanSplitterEventCondition_value_floatRange = {
1205
+ type: 'floatRange';
1206
+ data: EventConditionValueFloatRange;
1207
+ };
1208
+ export type BooleanSplitterEventCondition_value = BooleanSplitterEventCondition_value_int | BooleanSplitterEventCondition_value_intRange | BooleanSplitterEventCondition_value_str | BooleanSplitterEventCondition_value_strRange | BooleanSplitterEventCondition_value_bool | BooleanSplitterEventCondition_value_float | BooleanSplitterEventCondition_value_floatRange;
1209
+ export type BooleanSplitterEventCondition = {
1210
+ attributeName: string;
1211
+ type: PointEventAttributeType;
1212
+ operator: PointEventConditionOperator;
1213
+ dateFilterMode: DateFilterMode;
1214
+ value: BooleanSplitterEventCondition_value;
1215
+ };
1216
+ export type BooleanSplitterEventConditions = {
1217
+ conditions: BooleanSplitterEventCondition[];
1218
+ };
1219
+ export type BooleanSplitterEventInfo = {
1220
+ eventName: string;
1221
+ eventConditions?: BooleanSplitterEventConditions;
1222
+ };
1223
+ export type PointParamsBooleanSplitter_LoadPolicy = 'UNKNOWN' | 'ALL' | 'FILTER';
1224
+ export type PointParamsBooleanSplitter_SplitStrategy = 'SPLIT_FILTER' | 'SPLIT_TAGS' | 'SPLIT_EVENTS';
782
1225
  export type PointParamsBooleanSplitter = {
783
1226
  filterCode: string;
1227
+ loadPolicy: PointParamsBooleanSplitter_LoadPolicy;
1228
+ splitStrategy: PointParamsBooleanSplitter_SplitStrategy;
1229
+ filterExpressions: pushwoosh_objects_filters_v1_FilterExpression[];
1230
+ event?: BooleanSplitterEventInfo;
784
1231
  };
785
1232
  export type PointParamsWaitEvent = {
786
1233
  events: PointWaitEventInfo[];
787
1234
  conditionsScript: string;
1235
+ multiEntry: MultiEntry;
1236
+ isTravelerPresenceExtendable?: boolean;
788
1237
  };
789
1238
  export type PointWaitEventInfo = {
790
1239
  eventName: string;
@@ -796,10 +1245,11 @@ export type PointWaitEventInfo = {
796
1245
  export type PointParamsInapp = {
797
1246
  richmediaCode: string;
798
1247
  applicationCode: string;
799
- campaignCode: string;
800
- campaignUid: number;
1248
+ campaignCode?: string;
1249
+ campaignUid?: number;
801
1250
  expireInDays: number;
802
1251
  capping: Capping;
1252
+ messageType: MessageType;
803
1253
  };
804
1254
  export type Filter = 'CUSTOM' | 'EMAIL_EXISTS' | 'PUSH_TOKEN_EXISTS' | 'SMS_TOKEN_EXISTS' | 'WHATSAPP_TOKEN_EXISTS' | 'LINE_TOKEN_EXISTS';
805
1255
  export type PointParamsFilter = {
@@ -813,10 +1263,12 @@ export type BehaviorSplitter = {
813
1263
  export type LiquidTemplateParams = {
814
1264
  enabled: boolean;
815
1265
  eventName: string;
1266
+ eventEntryPointUuid: string;
816
1267
  };
817
1268
  export type VoucherParams = {
818
1269
  enabled: boolean;
819
1270
  voucherPool: string;
1271
+ voucherTag: string;
820
1272
  };
821
1273
  export type PersonalisedParams = {
822
1274
  enabled: boolean;
@@ -863,6 +1315,8 @@ export type PointParamsGoalEvent = {
863
1315
  applicationCode: string;
864
1316
  eventConditions: PointEventCondition[];
865
1317
  isThrowOut: boolean;
1318
+ multiEntry: MultiEntry;
1319
+ isCancelEvent: boolean;
866
1320
  };
867
1321
  export type PointParamsDelay_interval_sec = {
868
1322
  type: 'sec';
@@ -886,6 +1340,7 @@ export type PointParamsDelay_interval_exactWeekDaysTime = {
886
1340
  };
887
1341
  export type PointParamsDelay_interval = PointParamsDelay_interval_sec | PointParamsDelay_interval_exactTime | PointParamsDelay_interval_dynamicTime | PointParamsDelay_interval_exactDateTime | PointParamsDelay_interval_exactWeekDaysTime;
888
1342
  export type PointParamsDelay = {
1343
+ isTravelerPresenceExtendable?: boolean;
889
1344
  interval: PointParamsDelay_interval;
890
1345
  };
891
1346
  export type PointOutput = {
@@ -905,17 +1360,30 @@ export type PointParamsWebHook = {
905
1360
  url: string;
906
1361
  requestTemplate: string;
907
1362
  headers: Record<string, string>;
1363
+ disabled: boolean;
1364
+ reactivate: boolean;
1365
+ };
1366
+ export type AudienceSyncAction = 'AUDIENCE_SYNC_ACTION_UNSPECIFIED' | 'AUDIENCE_SYNC_ACTION_ADD' | 'AUDIENCE_SYNC_ACTION_REMOVE';
1367
+ export type PointParamsAudienceSync = {
1368
+ adAccountId: string;
1369
+ adAccountName: string;
1370
+ audienceId: string;
1371
+ audienceName: string;
1372
+ action: AudienceSyncAction;
908
1373
  };
909
1374
  export type PointParamsStartBySegment = {
910
1375
  filterCode: string;
911
1376
  applicationCode: string;
912
- entryLimitsEnabled: boolean;
913
- entryLimitsPerSecond: number;
1377
+ entryLimitsEnabled?: boolean;
1378
+ entryLimitsPerSecond?: number;
914
1379
  repeat: SegmentRepeat;
915
1380
  isDeactivated: boolean;
916
1381
  filterTitle: string;
917
1382
  applicationTitle: string;
1383
+ startAt: Date;
1384
+ entryMode: EntryMode;
918
1385
  };
1386
+ export type EntryMode = 'ENTRY_MODE_UNKNOWN' | 'ENTRY_MODE_EXISTING_ONLY' | 'ENTRY_MODE_EXISTING_AND_NEW' | 'ENTRY_MODE_NEW_ONLY';
919
1387
  export type SegmentRepeat = {
920
1388
  enabled: boolean;
921
1389
  type: string;
@@ -937,8 +1405,12 @@ export type PointParamsABSplitter = {
937
1405
  split: number[];
938
1406
  autoSelectWinner: boolean;
939
1407
  winnerSplit: number;
1408
+ winnerStrategy: WinnerStrategy;
1409
+ goalUuid: string;
1410
+ winnerOutputKey: string;
1411
+ winnerGoalUuid: string;
940
1412
  };
941
- export type TagType = 'TYPE_UNKNOWN' | 'TYPE_INTEGER' | 'TYPE_STRING' | 'TYPE_LIST' | 'TYPE_DATE' | 'TYPE_BOOLEAN' | 'TYPE_PRICE' | 'TYPE_VERSION' | 'TYPE_DYNAMIC' | 'TYPE_LIST_APPEND';
1413
+ export type TagType = 'TYPE_UNKNOWN' | 'TYPE_INTEGER' | 'TYPE_STRING' | 'TYPE_LIST' | 'TYPE_DATE' | 'TYPE_BOOLEAN' | 'TYPE_PRICE' | 'TYPE_VERSION' | 'TYPE_DYNAMIC' | 'TYPE_LIST_APPEND' | 'TYPE_TIMEZONE' | 'TYPE_LIST_REMOVE' | 'TYPE_DYNAMIC_APPEND' | 'TYPE_DYNAMIC_REMOVE' | 'TYPE_INCREMENT' | 'TYPE_DECREMENT' | 'TYPE_DYNAMIC_INCREMENT' | 'TYPE_DYNAMIC_DECREMENT';
942
1414
  export type Tag_value_int = {
943
1415
  type: 'int';
944
1416
  data: number;
@@ -980,11 +1452,8 @@ export type Tag = {
980
1452
  id: number;
981
1453
  type: TagType;
982
1454
  name: string;
983
- dynamicModification: boolean;
984
- setTagOperation: SetTagOperation;
985
1455
  value: Tag_value;
986
1456
  };
987
- export type SetTagOperation = 'SetTagOperationUnknown' | 'SetTagOperationOverwrite' | 'SetTagOperationAppend' | 'SetTagOperationRemove' | 'SetTagOperationIncrement' | 'SetTagOperationDecrement';
988
1457
  export type TagValueList = {
989
1458
  value: string[];
990
1459
  };
@@ -1004,8 +1473,8 @@ export type Position = {
1004
1473
  };
1005
1474
  export type PointParamsStartByAPI = {
1006
1475
  applicationCode: string;
1007
- entryLimitsEnabled: boolean;
1008
- entryLimitsPerSecond: number;
1476
+ entryLimitsEnabled?: boolean;
1477
+ entryLimitsPerSecond?: number;
1009
1478
  isDeactivated: boolean;
1010
1479
  attributes: string[];
1011
1480
  };
@@ -1018,8 +1487,8 @@ export type Capping = {
1018
1487
  };
1019
1488
  export type InboxOptions = {
1020
1489
  enabled: boolean;
1021
- expireAtDate: Date;
1022
- expireInDays: number;
1490
+ expireAtDate?: Date;
1491
+ expireInDays?: number;
1023
1492
  imgUrl: string;
1024
1493
  richMediaCode: string;
1025
1494
  };
@@ -1062,6 +1531,21 @@ export type JourneyStatsByPointsItemGet = {
1062
1531
  pointOutputStat: PointOutputStat[];
1063
1532
  waitingTravellers: number;
1064
1533
  entries: number;
1534
+ dropped: number;
1535
+ };
1536
+ export type ChannelStat = {
1537
+ channel: string;
1538
+ sends: number;
1539
+ openRate: number;
1540
+ shown: number;
1541
+ interactions: number;
1542
+ opens: number;
1543
+ recipients: number;
1544
+ clicks: number;
1545
+ softbounce: number;
1546
+ hardbounce: number;
1547
+ complaint: number;
1548
+ unsubscribed: number;
1065
1549
  };
1066
1550
  export type JourneyStatItems = {
1067
1551
  total: number;
@@ -1069,6 +1553,7 @@ export type JourneyStatItems = {
1069
1553
  avgCtr: number;
1070
1554
  left: number;
1071
1555
  leftByError: number;
1556
+ dropped: number;
1072
1557
  inside: number;
1073
1558
  achievedGoal: number;
1074
1559
  goals: Record<string, number>;
@@ -1077,6 +1562,8 @@ export type JourneyStatItems = {
1077
1562
  pointsToGoalsMap: Record<string, GoalPointStats>;
1078
1563
  abSplitStats: Record<string, ABSplitStat>;
1079
1564
  totalSkipped: number;
1565
+ sendingErrors: number;
1566
+ channelsStat: Record<string, ChannelStat>;
1080
1567
  };
1081
1568
  export type PointOutputStat = {
1082
1569
  key: string;
@@ -1153,7 +1640,7 @@ export type GetJourneyUsersRequest = {
1153
1640
  pageSize?: number;
1154
1641
  page?: number;
1155
1642
  };
1156
- export type UserStatus = 'unknown' | 'inJourneyNow' | 'exited' | 'droppedOff';
1643
+ export type UserStatus = 'unknown' | 'inJourneyNow' | 'exited' | 'droppedOff' | 'goalReached';
1157
1644
  export type GetJourneyUsersResponse_UserPoint = {
1158
1645
  userId: string;
1159
1646
  lastPointType: string;
@@ -1166,6 +1653,162 @@ export type GetJourneyUsersResponse = {
1166
1653
  users: GetJourneyUsersResponse_UserPoint[];
1167
1654
  totals: number;
1168
1655
  };
1656
+ export type Channel = 'CHANNEL_UNSPECIFIED' | 'PUSH' | 'EMAIL' | 'WHATSAPP' | 'SMS' | 'IN_APP' | 'LINE';
1657
+ export type GetJourneyMetricsRequest = {
1658
+ uuid?: string;
1659
+ application?: string;
1660
+ timestampFrom?: Date;
1661
+ timestampTo?: Date;
1662
+ timezone?: string;
1663
+ };
1664
+ export type GetJourneyMetricsResponse_PushMetrics = {
1665
+ sends: number[];
1666
+ opens: number[];
1667
+ deliveryIssues: number[];
1668
+ successfulSends: number[];
1669
+ totalOpens: number[];
1670
+ };
1671
+ export type GetJourneyMetricsResponse_EmailMetrics = {
1672
+ sends: number[];
1673
+ opens: number[];
1674
+ deliveryIssues: number[];
1675
+ clicks: number[];
1676
+ successfulSends: number[];
1677
+ totalOpens: number[];
1678
+ };
1679
+ export type GetJourneyMetricsResponse_WhatsAppMetrics = {
1680
+ sends: number[];
1681
+ read: number[];
1682
+ deliveryIssues: number[];
1683
+ successfulSends: number[];
1684
+ totalRead: number[];
1685
+ };
1686
+ export type GetJourneyMetricsResponse_SMSMetrics = {
1687
+ sends: number[];
1688
+ deliveries: number[];
1689
+ deliveryIssues: number[];
1690
+ successfulSends: number[];
1691
+ };
1692
+ export type GetJourneyMetricsResponse_LineMetrics = {
1693
+ sends: number[];
1694
+ deliveryIssues: number[];
1695
+ successfulSends: number[];
1696
+ };
1697
+ export type GetJourneyMetricsResponse_InAppMetrics = {
1698
+ impressions: number[];
1699
+ interactions: number[];
1700
+ deliveryIssues: number[];
1701
+ };
1702
+ export type GetJourneyMetricsResponse_ChannelMetrics = {
1703
+ push: GetJourneyMetricsResponse_PushMetrics;
1704
+ email: GetJourneyMetricsResponse_EmailMetrics;
1705
+ whatsapp: GetJourneyMetricsResponse_WhatsAppMetrics;
1706
+ sms: GetJourneyMetricsResponse_SMSMetrics;
1707
+ inApp: GetJourneyMetricsResponse_InAppMetrics;
1708
+ line: GetJourneyMetricsResponse_LineMetrics;
1709
+ };
1710
+ export type GetJourneyMetricsResponse_PushTotals = {
1711
+ sent: number;
1712
+ recipients: number;
1713
+ opened: number;
1714
+ deliveryIssues: number;
1715
+ successfulSends: number;
1716
+ totalOpened: number;
1717
+ frequencyCappingUniqueUsers: number;
1718
+ frequencyCappingSuppressions: number;
1719
+ };
1720
+ export type GetJourneyMetricsResponse_EmailTotals = {
1721
+ sent: number;
1722
+ recipients: number;
1723
+ opened: number;
1724
+ deliveryIssues: number;
1725
+ hardBounces: number;
1726
+ softBounces: number;
1727
+ complaints: number;
1728
+ clicks: number;
1729
+ unsubscribes: number;
1730
+ successfulSends: number;
1731
+ totalOpened: number;
1732
+ deliveries: number;
1733
+ totalDeliveries: number;
1734
+ frequencyCappingUniqueUsers: number;
1735
+ frequencyCappingSuppressions: number;
1736
+ };
1737
+ export type GetJourneyMetricsResponse_WhatsAppTotals = {
1738
+ sent: number;
1739
+ recipients: number;
1740
+ read: number;
1741
+ errors: number;
1742
+ deliveries: number;
1743
+ successfulSends: number;
1744
+ totalRead: number;
1745
+ frequencyCappingUniqueUsers: number;
1746
+ frequencyCappingSuppressions: number;
1747
+ };
1748
+ export type GetJourneyMetricsResponse_SMSTotals = {
1749
+ sent: number;
1750
+ recipients: number;
1751
+ deliveries: number;
1752
+ errors: number;
1753
+ successfulSends: number;
1754
+ frequencyCappingUniqueUsers: number;
1755
+ frequencyCappingSuppressions: number;
1756
+ };
1757
+ export type GetJourneyMetricsResponse_LineTotals = {
1758
+ sent: number;
1759
+ recipients: number;
1760
+ errors: number;
1761
+ successfulSends: number;
1762
+ frequencyCappingUniqueUsers: number;
1763
+ frequencyCappingSuppressions: number;
1764
+ };
1765
+ export type GetJourneyMetricsResponse_InAppTotals = {
1766
+ impressions: number;
1767
+ interactions: number;
1768
+ errors: number;
1769
+ };
1770
+ export type GetJourneyMetricsResponse_ChannelTotals = {
1771
+ push: GetJourneyMetricsResponse_PushTotals;
1772
+ email: GetJourneyMetricsResponse_EmailTotals;
1773
+ whatsapp: GetJourneyMetricsResponse_WhatsAppTotals;
1774
+ sms: GetJourneyMetricsResponse_SMSTotals;
1775
+ inApp: GetJourneyMetricsResponse_InAppTotals;
1776
+ line: GetJourneyMetricsResponse_LineTotals;
1777
+ };
1778
+ export type GetJourneyMetricsResponse = {
1779
+ timestamps: Date[];
1780
+ channelMetrics: GetJourneyMetricsResponse_ChannelMetrics;
1781
+ totals: GetJourneyMetricsResponse_ChannelTotals;
1782
+ };
1783
+ export type GetJourneyDeliveryReportRequest = {
1784
+ application?: string;
1785
+ uuid?: string;
1786
+ timestampFrom?: Date;
1787
+ timestampTo?: Date;
1788
+ timezone?: string;
1789
+ };
1790
+ export type GetJourneyDeliveryReportResponse_DeliveryError = {
1791
+ name: string;
1792
+ description: string;
1793
+ count: number;
1794
+ userDrop: boolean;
1795
+ statusCode: number;
1796
+ };
1797
+ export type GetJourneyDeliveryReportResponse = {
1798
+ push: GetJourneyDeliveryReportResponse_DeliveryError[];
1799
+ email: GetJourneyDeliveryReportResponse_DeliveryError[];
1800
+ whatsapp: GetJourneyDeliveryReportResponse_DeliveryError[];
1801
+ sms: GetJourneyDeliveryReportResponse_DeliveryError[];
1802
+ inApp: GetJourneyDeliveryReportResponse_DeliveryError[];
1803
+ };
1804
+ export type MultiEntry = {
1805
+ enabled: boolean;
1806
+ attributeName: string;
1807
+ };
1808
+ export type AttributeEntry = {
1809
+ enabled: boolean;
1810
+ attributeName: string;
1811
+ };
1169
1812
  export type GetVoucherPoolsRequest = {
1170
1813
  applicationCode?: string;
1171
1814
  };
@@ -1175,3 +1818,244 @@ export type GetVoucherPoolsResponse = {
1175
1818
  export type VoucherPool = {
1176
1819
  name: string;
1177
1820
  };
1821
+ export type GetWhatsAppPresetsByAppCodeRequest = {
1822
+ code?: string;
1823
+ };
1824
+ export type GetWhatsAppPresetsByAppCodeResponse = {
1825
+ payload: WhatsAppPresetsByAppCodePayload;
1826
+ };
1827
+ export type WhatsAppPresetsByAppCodePayload = {
1828
+ items: WhatsAppPresetByAppCodeItem[];
1829
+ };
1830
+ export type WhatsAppPresetByAppCodeItem = {
1831
+ content: string;
1832
+ code: string;
1833
+ name: string;
1834
+ headerType: string;
1835
+ headerVariables: string[];
1836
+ headerText: string;
1837
+ variables: string[];
1838
+ quickReplies: WhatsAppPresetQuickReply[];
1839
+ buttonUrlVariables: WhatsAppButtonURLVariables[];
1840
+ };
1841
+ export type WhatsAppPresetQuickReply = {
1842
+ name: string;
1843
+ output: string;
1844
+ };
1845
+ export type WhatsAppButtonURLVariables = {
1846
+ index: number;
1847
+ text: string;
1848
+ url: string;
1849
+ type: string;
1850
+ variable: string;
1851
+ };
1852
+ export type GetEmailPresetsByAppCodeRequest = {
1853
+ code?: string;
1854
+ };
1855
+ export type GetEmailPresetsByAppCodeResponse = {
1856
+ payload: EmailPresetsByAppCodePayload;
1857
+ };
1858
+ export type EmailPresetsByAppCodePayload = {
1859
+ items: EmailPresetByAppCodeItem[];
1860
+ };
1861
+ export type EmailPresetByAppCodeItem = {
1862
+ uid: number;
1863
+ code: string;
1864
+ subjects: Record<string, string>;
1865
+ sendFrom: SendFrom;
1866
+ template: string;
1867
+ campaign: string;
1868
+ name: string;
1869
+ replyTo: ReplyTo;
1870
+ };
1871
+ export type SendFrom = {
1872
+ name: string;
1873
+ email: string;
1874
+ };
1875
+ export type TestWebhookRequest_TemplateData = {
1876
+ hwid: string;
1877
+ userId: string;
1878
+ appCode: string;
1879
+ tags: Record<string, string>;
1880
+ eventAttributes: Record<string, string>;
1881
+ };
1882
+ export type TestWebhookRequest = {
1883
+ method?: string;
1884
+ url?: string;
1885
+ template?: string;
1886
+ headers?: Record<string, string>;
1887
+ templateData?: TestWebhookRequest_TemplateData;
1888
+ };
1889
+ export type TestWebhookResponse = {
1890
+ ok: boolean;
1891
+ statusCode: number;
1892
+ body: string;
1893
+ };
1894
+ export type GetEventsByApplicationCodeRequest = {
1895
+ code?: string;
1896
+ };
1897
+ export type GetEventsByApplicationCodeResponse = {
1898
+ payload: EventsByApplicationCodePayload;
1899
+ };
1900
+ export type EventsByApplicationCodePayload = {
1901
+ items: EventItem[];
1902
+ };
1903
+ export type EventItem = {
1904
+ id: number;
1905
+ name: string;
1906
+ description: string;
1907
+ attributes: EventAttributeItem[];
1908
+ };
1909
+ export type EventAttributeItem = {
1910
+ id: number;
1911
+ name: string;
1912
+ type: number;
1913
+ };
1914
+ export type GetEventAttributeValuesRequest = {
1915
+ code?: string;
1916
+ eventId?: number;
1917
+ attribute?: string;
1918
+ limit?: number;
1919
+ searchValue?: string;
1920
+ };
1921
+ export type GetEventAttributeValuesResponse = {
1922
+ payload: EventAttributeValuesPayload;
1923
+ };
1924
+ export type EventAttributeValuesPayload = {
1925
+ values: string[];
1926
+ };
1927
+ export type GetRichMediaByApplicationCodeRequest = {
1928
+ code?: string;
1929
+ noContent?: boolean;
1930
+ noParams?: boolean;
1931
+ search?: string;
1932
+ };
1933
+ export type GetRichMediaByApplicationCodeResponse = {
1934
+ payload: RichMediaByApplicationCodePayload;
1935
+ };
1936
+ export type RichMediaByApplicationCodePayload = {
1937
+ items: RichMediaItem[];
1938
+ };
1939
+ export type RichMediaItem = {
1940
+ name: string;
1941
+ uid: number;
1942
+ params: string;
1943
+ code: string;
1944
+ applicationId: number;
1945
+ applicationCode: string;
1946
+ defaultLanguage: string;
1947
+ businessCase: string;
1948
+ fileHash: string;
1949
+ isSystem: boolean;
1950
+ zipContent: string;
1951
+ };
1952
+ export type GetRichMediaByCodeRequest = {
1953
+ code?: string;
1954
+ rmcode?: string;
1955
+ };
1956
+ export type GetRichMediaByCodeResponse = {
1957
+ payload: RichMediaItem;
1958
+ };
1959
+ export type GetLinePresetsByAppCodeRequest = {
1960
+ code?: string;
1961
+ };
1962
+ export type GetLinePresetsByAppCodeResponse = {
1963
+ payload: LinePresetsByAppCodePayload;
1964
+ };
1965
+ export type LinePresetsByAppCodePayload = {
1966
+ items: LinePresetByAppCodeItem[];
1967
+ };
1968
+ export type LinePresetByAppCodeItem = {
1969
+ code: string;
1970
+ name: string;
1971
+ content: string;
1972
+ };
1973
+ export type GetSmsPresetsByAppCodeRequest = {
1974
+ code?: string;
1975
+ };
1976
+ export type GetSmsPresetsByAppCodeResponse = {
1977
+ payload: SmsPresetsByAppCodePayload;
1978
+ };
1979
+ export type SmsPresetsByAppCodePayload = {
1980
+ items: SmsPresetByAppCodeItem[];
1981
+ };
1982
+ export type SmsPresetByAppCodeItem = {
1983
+ code: string;
1984
+ name: string;
1985
+ content: string;
1986
+ };
1987
+ export type GetPushPresetsByAppCodeRequest = {
1988
+ code?: string;
1989
+ journeyUuid?: string;
1990
+ };
1991
+ export type GetPushPresetsByAppCodeResponse = {
1992
+ payload: PushPresetsByAppCodePayload;
1993
+ };
1994
+ export type PushPresetsByAppCodePayload = {
1995
+ items: PushPresetByAppCodeItem[];
1996
+ };
1997
+ export type PushPresetByAppCodeItem = {
1998
+ code: string;
1999
+ name: string;
2000
+ content: string;
2001
+ title: string;
2002
+ url: string;
2003
+ variables: PushPresetVariables;
2004
+ };
2005
+ export type PushPresetVariables = {
2006
+ title: string[];
2007
+ content: string[];
2008
+ url: string[];
2009
+ };
2010
+ export type GetApplicationsByAccountIdRequest = {};
2011
+ export type GetApplicationsByAccountIdResponse = {
2012
+ payload: ApplicationItem[];
2013
+ };
2014
+ export type ApplicationItem = {
2015
+ title: string;
2016
+ code: string;
2017
+ icon: string;
2018
+ platforms: ApplicationPlatform[];
2019
+ };
2020
+ export type ApplicationPlatform = {
2021
+ type: string;
2022
+ isEnabled: boolean;
2023
+ isConfigured: boolean;
2024
+ };
2025
+ export type GetFiltersByAccountIdRequest = {};
2026
+ export type GetFiltersByAccountIdResponse = {
2027
+ payload: FilterItem[];
2028
+ };
2029
+ export type FilterItem = {
2030
+ id: number;
2031
+ accountId: number;
2032
+ applicationId: number;
2033
+ name: string;
2034
+ code: string;
2035
+ };
2036
+ export type GetEventsByApplicationCodesRequest = {
2037
+ applicationCodes?: string[];
2038
+ };
2039
+ export type GetEventsByApplicationCodesResponse = {
2040
+ payload: Record<string, EventsByApplicationCodePayload>;
2041
+ };
2042
+ export type MetaAdAccountStatus = 'META_AD_ACCOUNT_STATUS_UNSPECIFIED' | 'META_AD_ACCOUNT_STATUS_CONNECTED' | 'META_AD_ACCOUNT_STATUS_DISCONNECTED' | 'META_AD_ACCOUNT_STATUS_PENDING';
2043
+ export type MetaAdAccount = {
2044
+ id: string;
2045
+ name: string;
2046
+ status: MetaAdAccountStatus;
2047
+ };
2048
+ export type MetaCustomAudience = {
2049
+ id: string;
2050
+ name: string;
2051
+ };
2052
+ export type GetMetaAdAccountsRequest = {};
2053
+ export type GetMetaAdAccountsResponse = {
2054
+ adAccounts: MetaAdAccount[];
2055
+ };
2056
+ export type GetMetaAudiencesRequest = {
2057
+ adAccountId?: string;
2058
+ };
2059
+ export type GetMetaAudiencesResponse = {
2060
+ audiences: MetaCustomAudience[];
2061
+ };