@pushwoosh/rpc-gateway-journey-data 0.27.224 → 0.27.226

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/data.js CHANGED
@@ -419,6 +419,12 @@ export const data = {
419
419
  "method": "post",
420
420
  "path": "/api/v2/journeygateway/test-webhook"
421
421
  },
422
+ "PreviewWebPlacement": {
423
+ "request": "pushwoosh.cj.journey.PreviewWebPlacementRequest",
424
+ "response": "pushwoosh.cj.journey.PreviewWebPlacementResponse",
425
+ "method": "post",
426
+ "path": "/api/v2/journeygateway/preview-web-placement"
427
+ },
422
428
  "GetApplicationsByAccountId": {
423
429
  "request": "pushwoosh.cj.journey.GetApplicationsByAccountIdRequest",
424
430
  "response": "pushwoosh.cj.journey.GetApplicationsByAccountIdResponse",
@@ -958,6 +964,9 @@ export const data = {
958
964
  },
959
965
  "sendLiveActivity": {
960
966
  "type": "pushwoosh.cj.journey.PointStatSendLiveActivity"
967
+ },
968
+ "webPlacement": {
969
+ "type": "pushwoosh.cj.journey.PointStatWebPlacement"
961
970
  }
962
971
  },
963
972
  "oneofs": {
@@ -985,7 +994,8 @@ export const data = {
985
994
  "sendInbox",
986
995
  "sendFbMessenger",
987
996
  "webhook",
988
- "sendLiveActivity"
997
+ "sendLiveActivity",
998
+ "webPlacement"
989
999
  ]
990
1000
  }
991
1001
  }
@@ -1430,6 +1440,17 @@ export const data = {
1430
1440
  }
1431
1441
  }
1432
1442
  },
1443
+ "pushwoosh.cj.journey.PointStatWebPlacement": {
1444
+ "type": "I",
1445
+ "fields": {
1446
+ "shows": {
1447
+ "type": "number"
1448
+ },
1449
+ "interactions": {
1450
+ "type": "number"
1451
+ }
1452
+ }
1453
+ },
1433
1454
  "pushwoosh.cj.journey.PointStatSendLiveActivity": {
1434
1455
  "type": "I",
1435
1456
  "fields": {
@@ -2766,7 +2787,8 @@ export const data = {
2766
2787
  "POINT_TYPE_SEND_FB_MESSENGER",
2767
2788
  "POINT_TYPE_HOLDOUT_SPLIT",
2768
2789
  "POINT_TYPE_SEND_LIVE_ACTIVITY",
2769
- "POINT_TYPE_LOOP"
2790
+ "POINT_TYPE_LOOP",
2791
+ "POINT_TYPE_WEB_PLACEMENT"
2770
2792
  ]
2771
2793
  },
2772
2794
  "pushwoosh.cj.journey.Point": {
@@ -2891,6 +2913,9 @@ export const data = {
2891
2913
  },
2892
2914
  "loop": {
2893
2915
  "type": "pushwoosh.cj.journey.PointParamsLoop"
2916
+ },
2917
+ "webPlacement": {
2918
+ "type": "pushwoosh.cj.journey.PointParamsWebPlacement"
2894
2919
  }
2895
2920
  },
2896
2921
  "oneofs": {
@@ -2925,7 +2950,8 @@ export const data = {
2925
2950
  "sendFbMessenger",
2926
2951
  "holdoutSplit",
2927
2952
  "sendLiveActivity",
2928
- "loop"
2953
+ "loop",
2954
+ "webPlacement"
2929
2955
  ]
2930
2956
  }
2931
2957
  }
@@ -4643,6 +4669,69 @@ export const data = {
4643
4669
  }
4644
4670
  }
4645
4671
  },
4672
+ "pushwoosh.cj.journey.WebPlacementKind": {
4673
+ "type": "E",
4674
+ "values": [
4675
+ "WEB_PLACEMENT_KIND_POPUP",
4676
+ "WEB_PLACEMENT_KIND_EMBEDDED"
4677
+ ]
4678
+ },
4679
+ "pushwoosh.cj.journey.WebPlacementPriority": {
4680
+ "type": "E",
4681
+ "values": [
4682
+ "WEB_PLACEMENT_PRIORITY_MEDIUM",
4683
+ "WEB_PLACEMENT_PRIORITY_LOW",
4684
+ "WEB_PLACEMENT_PRIORITY_HIGH"
4685
+ ]
4686
+ },
4687
+ "pushwoosh.cj.journey.PointParamsWebPlacement": {
4688
+ "type": "I",
4689
+ "fields": {
4690
+ "applicationCode": {
4691
+ "type": "string"
4692
+ },
4693
+ "contentCode": {
4694
+ "type": "string"
4695
+ },
4696
+ "kind": {
4697
+ "type": "pushwoosh.cj.journey.WebPlacementKind"
4698
+ },
4699
+ "cssSelector": {
4700
+ "type": "string"
4701
+ },
4702
+ "width": {
4703
+ "type": "string"
4704
+ },
4705
+ "priority": {
4706
+ "type": "pushwoosh.cj.journey.WebPlacementPriority"
4707
+ },
4708
+ "expireInMinutes": {
4709
+ "type": "number"
4710
+ },
4711
+ "triggerEvent": {
4712
+ "type": "pushwoosh.cj.journey.PointInappTriggerEvent",
4713
+ "optional": true
4714
+ },
4715
+ "hideEvent": {
4716
+ "type": "pushwoosh.cj.journey.PointInappTriggerEvent",
4717
+ "optional": true
4718
+ },
4719
+ "dismissible": {
4720
+ "type": "boolean"
4721
+ },
4722
+ "campaignCode": {
4723
+ "type": "string",
4724
+ "optional": true
4725
+ },
4726
+ "campaignUid": {
4727
+ "type": "number",
4728
+ "optional": true
4729
+ },
4730
+ "maxShowsPerDay": {
4731
+ "type": "number"
4732
+ }
4733
+ }
4734
+ },
4646
4735
  "pushwoosh.cj.journey.PointParamsSendInbox": {
4647
4736
  "type": "I",
4648
4737
  "fields": {
@@ -5917,6 +6006,9 @@ export const data = {
5917
6006
  },
5918
6007
  "allowJourneyLoopPoint": {
5919
6008
  "type": "boolean"
6009
+ },
6010
+ "allowWebPlacement": {
6011
+ "type": "boolean"
5920
6012
  }
5921
6013
  }
5922
6014
  },
@@ -7622,6 +7714,28 @@ export const data = {
7622
7714
  }
7623
7715
  }
7624
7716
  },
7717
+ "pushwoosh.cj.journey.PreviewWebPlacementRequest": {
7718
+ "type": "I",
7719
+ "fields": {
7720
+ "applicationCode": {
7721
+ "type": "string"
7722
+ },
7723
+ "hwid": {
7724
+ "type": "string"
7725
+ },
7726
+ "params": {
7727
+ "type": "pushwoosh.cj.journey.PointParamsWebPlacement"
7728
+ }
7729
+ }
7730
+ },
7731
+ "pushwoosh.cj.journey.PreviewWebPlacementResponse": {
7732
+ "type": "I",
7733
+ "fields": {
7734
+ "userId": {
7735
+ "type": "string"
7736
+ }
7737
+ }
7738
+ },
7625
7739
  "pushwoosh.cj.journey.GetEventsByApplicationCodeRequest": {
7626
7740
  "type": "I",
7627
7741
  "fields": {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@pushwoosh/rpc-gateway-journey-data",
3
- "version": "0.27.224",
3
+ "version": "0.27.226",
4
4
  "description": "CJ api gateway HTTP API Types and Data",
5
5
  "main": "index.js",
6
6
  "module": "index.js",
@@ -69,6 +69,7 @@ export type Journey_GetEventAttributeValues = RpcMethod<GetEventAttributeValuesR
69
69
  export type Journey_GetRichMediaByApplicationCode = RpcMethod<GetRichMediaByApplicationCodeRequest, GetRichMediaByApplicationCodeResponse>;
70
70
  export type Journey_GetRichMediaByCode = RpcMethod<GetRichMediaByCodeRequest, GetRichMediaByCodeResponse>;
71
71
  export type Journey_TestWebhook = RpcMethod<TestWebhookRequest, TestWebhookResponse>;
72
+ export type Journey_PreviewWebPlacement = RpcMethod<PreviewWebPlacementRequest, PreviewWebPlacementResponse>;
72
73
  export type Journey_GetApplicationsByAccountId = RpcMethod<GetApplicationsByAccountIdRequest, GetApplicationsByAccountIdResponse>;
73
74
  export type Journey_GetFiltersByAccountId = RpcMethod<GetFiltersByAccountIdRequest, GetFiltersByAccountIdResponse>;
74
75
  export type Journey_GetEventsByApplicationCodes = RpcMethod<GetEventsByApplicationCodesRequest, GetEventsByApplicationCodesResponse>;
@@ -258,6 +259,8 @@ export interface Journey {
258
259
  GetRichMediaByCode: Journey_GetRichMediaByCode;
259
260
  /** Fires a test HTTP request to a customer-supplied webhook URL and returns the live response status and body. Reaches an external endpoint; use to verify a journey webhook point before saving. */
260
261
  TestWebhook: Journey_TestWebhook;
262
+ /** Shows a web placement, as configured in the point form, on one test device of the application: it appears on the device's next page view for an hour, outside any journey and its statistics. */
263
+ PreviewWebPlacement: Journey_PreviewWebPlacement;
261
264
  /** Returns the applications available to the current account for journey building. Read-only lookup used to populate app pickers. */
262
265
  GetApplicationsByAccountId: Journey_GetApplicationsByAccountId;
263
266
  /** Returns the filters/segments available to the current account for use in journey audience and split points. Read-only lookup. */
@@ -639,7 +642,11 @@ export type PointStat_pointStat_sendLiveActivity = {
639
642
  type: 'sendLiveActivity';
640
643
  data: PointStatSendLiveActivity;
641
644
  };
642
- 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 | PointStat_pointStat_sendViber | PointStat_pointStat_smartContent | PointStat_pointStat_issueWalletPass | PointStat_pointStat_sendInbox | PointStat_pointStat_sendFbMessenger | PointStat_pointStat_webhook | PointStat_pointStat_sendLiveActivity;
645
+ export type PointStat_pointStat_webPlacement = {
646
+ type: 'webPlacement';
647
+ data: PointStatWebPlacement;
648
+ };
649
+ 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 | PointStat_pointStat_sendViber | PointStat_pointStat_smartContent | PointStat_pointStat_issueWalletPass | PointStat_pointStat_sendInbox | PointStat_pointStat_sendFbMessenger | PointStat_pointStat_webhook | PointStat_pointStat_sendLiveActivity | PointStat_pointStat_webPlacement;
643
650
  /** PointStat contains statistics specific to the point type */
644
651
  export type PointStat = {
645
652
  pointStat: PointStat_pointStat;
@@ -939,6 +946,13 @@ export type PointStatIssueWalletPass = {
939
946
  /** Number of travelers skipped: anonymous or the issuing call failed */
940
947
  skipped: number;
941
948
  };
949
+ /** PointStatWebPlacement contains statistics for web placement points */
950
+ export type PointStatWebPlacement = {
951
+ /** Number of times the placement was shown */
952
+ shows: number;
953
+ /** Number of clicks inside the placement */
954
+ interactions: number;
955
+ };
942
956
  /** PointStatSendLiveActivity contains statistics for Live Activity points */
943
957
  export type PointStatSendLiveActivity = {
944
958
  /** Number of travelers the card action was pushed for */
@@ -1858,7 +1872,9 @@ export type PointType =
1858
1872
  /** Holdout split point (holds a share of travelers out of the journey) */
1859
1873
  | 'POINT_TYPE_HOLDOUT_SPLIT'
1860
1874
  /** Live Activity card point */
1861
- | 'POINT_TYPE_SEND_LIVE_ACTIVITY' | 'POINT_TYPE_LOOP';
1875
+ | 'POINT_TYPE_SEND_LIVE_ACTIVITY' | 'POINT_TYPE_LOOP'
1876
+ /** Web popup or inline block shown on the customer's website */
1877
+ | 'POINT_TYPE_WEB_PLACEMENT';
1862
1878
  /** Point represents a single node in the journey */
1863
1879
  export type Point = {
1864
1880
  /** Unique identifier (UUID) of the point */
@@ -1998,7 +2014,11 @@ export type PointDataWrapper_data_loop = {
1998
2014
  type: 'loop';
1999
2015
  data: PointParamsLoop;
2000
2016
  };
2001
- 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 | PointDataWrapper_data_sendViber | PointDataWrapper_data_smartContent | PointDataWrapper_data_issueWalletPass | PointDataWrapper_data_sendInbox | PointDataWrapper_data_sendFbMessenger | PointDataWrapper_data_holdoutSplit | PointDataWrapper_data_sendLiveActivity | PointDataWrapper_data_loop;
2017
+ export type PointDataWrapper_data_webPlacement = {
2018
+ type: 'webPlacement';
2019
+ data: PointParamsWebPlacement;
2020
+ };
2021
+ 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 | PointDataWrapper_data_sendViber | PointDataWrapper_data_smartContent | PointDataWrapper_data_issueWalletPass | PointDataWrapper_data_sendInbox | PointDataWrapper_data_sendFbMessenger | PointDataWrapper_data_holdoutSplit | PointDataWrapper_data_sendLiveActivity | PointDataWrapper_data_loop | PointDataWrapper_data_webPlacement;
2002
2022
  /** PointDataWrapper contains point-specific configuration based on type */
2003
2023
  export type PointDataWrapper = {
2004
2024
  data: PointDataWrapper_data;
@@ -2046,9 +2066,9 @@ export type LiveActivityID = {
2046
2066
  export type PointParamsSendLiveActivity = {
2047
2067
  /** Application code */
2048
2068
  applicationCode: string;
2049
- /** Campaign code for statistics */
2069
+ /** Campaign code, assigned when the journey starts. Leave empty in Create and in new points, except for the system campaign created for this point; in existing points, leave empty or as read. Otherwise the request is rejected. */
2050
2070
  campaignCode: string;
2051
- /** Campaign uid for statistics */
2071
+ /** Campaign UID, assigned when the journey starts. Leave empty in Create and in new points, except for the system campaign created for this point; in existing points, leave empty or as read. Otherwise the request is rejected. */
2052
2072
  campaignUid: number;
2053
2073
  /** What the point does to the card */
2054
2074
  event: LiveActivityEvent;
@@ -2176,9 +2196,9 @@ export type PointParamsIssueWalletPass = {
2176
2196
  export type PointParamsSmartContent = {
2177
2197
  /** Application code */
2178
2198
  applicationCode: string;
2179
- /** Campaign code for tracking (created automatically if empty) */
2199
+ /** Campaign code, assigned when the journey starts. Leave empty in Create and in new points, except for the system campaign created for this point; in existing points, leave empty or as read. Otherwise the request is rejected. */
2180
2200
  campaignCode?: string;
2181
- /** Campaign UID for tracking (created automatically if empty) */
2201
+ /** Campaign UID, assigned when the journey starts. Leave empty in Create and in new points, except for the system campaign created for this point; in existing points, leave empty or as read. Otherwise the request is rejected. */
2182
2202
  campaignUid?: number;
2183
2203
  /** Candidate push presets the bandit chooses between (>= 2) */
2184
2204
  arms: SmartContentArm[];
@@ -2384,9 +2404,9 @@ export type PointParamsSendPush = {
2384
2404
  title: string;
2385
2405
  /** Application code */
2386
2406
  applicationCode: string;
2387
- /** Campaign code for tracking (will be created automatically if empty) */
2407
+ /** Campaign code, assigned when the journey starts. Leave empty in Create and in new points, except for the system campaign created for this point; in existing points, leave empty or as read. Otherwise the request is rejected. */
2388
2408
  campaignCode?: string;
2389
- /** Campaign UID for tracking (will be created automatically if empty) */
2409
+ /** Campaign UID, assigned when the journey starts. Leave empty in Create and in new points, except for the system campaign created for this point; in existing points, leave empty or as read. Otherwise the request is rejected. */
2390
2410
  campaignUid?: number;
2391
2411
  /** Behavior splitter configuration (wait for interaction) */
2392
2412
  splitParams: BehaviorSplitter;
@@ -2434,9 +2454,9 @@ export type PointParamsSendSms = {
2434
2454
  content: string;
2435
2455
  /** Application code */
2436
2456
  applicationCode: string;
2437
- /** Campaign code for tracking (will be created automatically if empty) */
2457
+ /** Campaign code, assigned when the journey starts. Leave empty in Create and in new points, except for the system campaign created for this point; in existing points, leave empty or as read. Otherwise the request is rejected. */
2438
2458
  campaignCode?: string;
2439
- /** Campaign UID for tracking (will be created automatically if empty) */
2459
+ /** Campaign UID, assigned when the journey starts. Leave empty in Create and in new points, except for the system campaign created for this point; in existing points, leave empty or as read. Otherwise the request is rejected. */
2440
2460
  campaignUid?: number;
2441
2461
  /** Behavior splitter configuration */
2442
2462
  splitParams: BehaviorSplitter;
@@ -2462,9 +2482,9 @@ export type PointParamsSendLine = {
2462
2482
  content: string;
2463
2483
  /** Application code */
2464
2484
  applicationCode: string;
2465
- /** Campaign code for tracking (will be created automatically if empty) */
2485
+ /** Campaign code, assigned when the journey starts. Leave empty in Create and in new points, except for the system campaign created for this point; in existing points, leave empty or as read. Otherwise the request is rejected. */
2466
2486
  campaignCode?: string;
2467
- /** Campaign UID for tracking (will be created automatically if empty) */
2487
+ /** Campaign UID, assigned when the journey starts. Leave empty in Create and in new points, except for the system campaign created for this point; in existing points, leave empty or as read. Otherwise the request is rejected. */
2468
2488
  campaignUid?: number;
2469
2489
  /** Behavior splitter configuration */
2470
2490
  splitParams: BehaviorSplitter;
@@ -2485,9 +2505,9 @@ export type PointParamsSendKakao = {
2485
2505
  presetCode: string;
2486
2506
  /** Application code */
2487
2507
  applicationCode: string;
2488
- /** Campaign code for tracking (will be created automatically if empty) */
2508
+ /** Campaign code, assigned when the journey starts. Leave empty in Create and in new points, except for the system campaign created for this point; in existing points, leave empty or as read. Otherwise the request is rejected. */
2489
2509
  campaignCode?: string;
2490
- /** Campaign UID for tracking (will be created automatically if empty) */
2510
+ /** Campaign UID, assigned when the journey starts. Leave empty in Create and in new points, except for the system campaign created for this point; in existing points, leave empty or as read. Otherwise the request is rejected. */
2491
2511
  campaignUid?: number;
2492
2512
  /** Personalization with dynamic content */
2493
2513
  personalise: PersonalisedParams;
@@ -2506,9 +2526,9 @@ export type PointParamsSendTelegram = {
2506
2526
  content: string;
2507
2527
  /** Application code */
2508
2528
  applicationCode: string;
2509
- /** Campaign code for tracking (will be created automatically if empty) */
2529
+ /** Campaign code, assigned when the journey starts. Leave empty in Create and in new points, except for the system campaign created for this point; in existing points, leave empty or as read. Otherwise the request is rejected. */
2510
2530
  campaignCode?: string;
2511
- /** Campaign UID for tracking (will be created automatically if empty) */
2531
+ /** Campaign UID, assigned when the journey starts. Leave empty in Create and in new points, except for the system campaign created for this point; in existing points, leave empty or as read. Otherwise the request is rejected. */
2512
2532
  campaignUid?: number;
2513
2533
  /** Personalization with dynamic content */
2514
2534
  personalise: PersonalisedParams;
@@ -2527,9 +2547,9 @@ export type PointParamsSendFBMessenger = {
2527
2547
  content: string;
2528
2548
  /** Application code */
2529
2549
  applicationCode: string;
2530
- /** Campaign code for tracking (will be created automatically if empty) */
2550
+ /** Campaign code, assigned when the journey starts. Leave empty in Create and in new points, except for the system campaign created for this point; in existing points, leave empty or as read. Otherwise the request is rejected. */
2531
2551
  campaignCode?: string;
2532
- /** Campaign UID for tracking (will be created automatically if empty) */
2552
+ /** Campaign UID, assigned when the journey starts. Leave empty in Create and in new points, except for the system campaign created for this point; in existing points, leave empty or as read. Otherwise the request is rejected. */
2533
2553
  campaignUid?: number;
2534
2554
  /** Personalization with dynamic content */
2535
2555
  personalise: PersonalisedParams;
@@ -2559,9 +2579,9 @@ export type PointParamsSendViber = {
2559
2579
  templateLang: string;
2560
2580
  /** Application code */
2561
2581
  applicationCode: string;
2562
- /** Campaign code for tracking (will be created automatically if empty) */
2582
+ /** Campaign code, assigned when the journey starts. Leave empty in Create and in new points, except for the system campaign created for this point; in existing points, leave empty or as read. Otherwise the request is rejected. */
2563
2583
  campaignCode?: string;
2564
- /** Campaign UID for tracking (will be created automatically if empty) */
2584
+ /** Campaign UID, assigned when the journey starts. Leave empty in Create and in new points, except for the system campaign created for this point; in existing points, leave empty or as read. Otherwise the request is rejected. */
2565
2585
  campaignUid?: number;
2566
2586
  /** Personalization with dynamic content */
2567
2587
  personalise: PersonalisedParams;
@@ -2670,9 +2690,9 @@ export type PointParamsSendWhatsApp = {
2670
2690
  content: string;
2671
2691
  /** Application code */
2672
2692
  applicationCode: string;
2673
- /** Campaign code for tracking (will be created automatically if empty) */
2693
+ /** Campaign code, assigned when the journey starts. Leave empty in Create and in new points, except for the system campaign created for this point; in existing points, leave empty or as read. Otherwise the request is rejected. */
2674
2694
  campaignCode?: string;
2675
- /** Campaign UID for tracking (will be created automatically if empty) */
2695
+ /** Campaign UID, assigned when the journey starts. Leave empty in Create and in new points, except for the system campaign created for this point; in existing points, leave empty or as read. Otherwise the request is rejected. */
2676
2696
  campaignUid?: number;
2677
2697
  /** Behavior splitter configuration */
2678
2698
  splitParams: BehaviorSplitter;
@@ -2697,9 +2717,9 @@ export type PointParamsSendEmail = {
2697
2717
  applicationCode: string;
2698
2718
  /** Preset code (template) to use */
2699
2719
  presetCode: string;
2700
- /** Campaign code for tracking (will be created automatically if empty) */
2720
+ /** Campaign code, assigned when the journey starts. Leave empty in Create and in new points, except for the system campaign created for this point; in existing points, leave empty or as read. Otherwise the request is rejected. */
2701
2721
  campaignCode?: string;
2702
- /** Campaign UID for tracking (will be created automatically if empty) */
2722
+ /** Campaign UID, assigned when the journey starts. Leave empty in Create and in new points, except for the system campaign created for this point; in existing points, leave empty or as read. Otherwise the request is rejected. */
2703
2723
  campaignUid?: number;
2704
2724
  /** Behavior splitter configuration */
2705
2725
  splitParams: BehaviorSplitter;
@@ -2777,9 +2797,9 @@ export type PointParamsSendData = {
2777
2797
  content: string;
2778
2798
  /** Application code */
2779
2799
  applicationCode: string;
2780
- /** Campaign code for tracking (will be created automatically if empty) */
2800
+ /** Campaign code, assigned when the journey starts. Leave empty in Create and in new points, except for the system campaign created for this point; in existing points, leave empty or as read. Otherwise the request is rejected. */
2781
2801
  campaignCode?: string;
2782
- /** Campaign UID for tracking (will be created automatically if empty) */
2802
+ /** Campaign UID, assigned when the journey starts. Leave empty in Create and in new points, except for the system campaign created for this point; in existing points, leave empty or as read. Otherwise the request is rejected. */
2783
2803
  campaignUid?: number;
2784
2804
  /** Whether to send by user ID */
2785
2805
  sendByUserId: boolean;
@@ -3140,9 +3160,9 @@ export type PointParamsInapp = {
3140
3160
  richmediaCode: string;
3141
3161
  /** Application code */
3142
3162
  applicationCode: string;
3143
- /** Campaign code for tracking (will be created automatically if empty) */
3163
+ /** Campaign code, assigned when the journey starts. Leave empty in Create and in new points, except for the system campaign created for this point; in existing points, leave empty or as read. Otherwise the request is rejected. */
3144
3164
  campaignCode?: string;
3145
- /** Campaign UID for tracking (will be created automatically if empty) */
3165
+ /** Campaign UID, assigned when the journey starts. Leave empty in Create and in new points, except for the system campaign created for this point; in existing points, leave empty or as read. Otherwise the request is rejected. */
3146
3166
  campaignUid?: number;
3147
3167
  /** Expiration time in days */
3148
3168
  expireInDays: number;
@@ -3160,15 +3180,52 @@ export type PointInappTriggerEvent = {
3160
3180
  /** Conditions to match event attributes, all must hold */
3161
3181
  eventConditions: PointEventCondition[];
3162
3182
  };
3183
+ /** WebPlacementKind is how the placement is shown on the website */
3184
+ export type WebPlacementKind =
3185
+ /** Modal popup over the page */
3186
+ 'WEB_PLACEMENT_KIND_POPUP'
3187
+ /** Inline block inserted into a page element */
3188
+ | 'WEB_PLACEMENT_KIND_EMBEDDED';
3189
+ /** WebPlacementPriority picks one placement when several target the same element */
3190
+ export type WebPlacementPriority = 'WEB_PLACEMENT_PRIORITY_MEDIUM' | 'WEB_PLACEMENT_PRIORITY_LOW' | 'WEB_PLACEMENT_PRIORITY_HIGH';
3191
+ /** PointParamsWebPlacement shows a web popup content on the user's next page view or on an event */
3192
+ export type PointParamsWebPlacement = {
3193
+ /** Application code (must have a web platform) */
3194
+ applicationCode: string;
3195
+ /** Web popup content code (kind CONTENT, without form fields) */
3196
+ contentCode: string;
3197
+ /** Popup or inline block */
3198
+ kind: WebPlacementKind;
3199
+ /** CSS selector of the page element an inline block goes into; required for EMBEDDED, empty for POPUP */
3200
+ cssSelector: string;
3201
+ /** CSS width of the block; empty keeps the element's own width */
3202
+ width: string;
3203
+ /** Priority among placements targeting the same element */
3204
+ priority: WebPlacementPriority;
3205
+ /** How long the placement waits and stays on the site, 1..10080 minutes */
3206
+ expireInMinutes: number;
3207
+ /** Event that shows the placement; unset shows it on the next page view */
3208
+ triggerEvent?: PointInappTriggerEvent;
3209
+ /** Event that removes the placement */
3210
+ hideEvent?: PointInappTriggerEvent;
3211
+ /** Whether the visitor can close the placement */
3212
+ dismissible: boolean;
3213
+ /** Campaign code, assigned when the journey starts. Leave empty in Create and in new points, except for the system campaign created for this point; in existing points, leave empty or as read. Otherwise the request is rejected. */
3214
+ campaignCode?: string;
3215
+ /** Campaign UID, assigned when the journey starts. Leave empty in Create and in new points, except for the system campaign created for this point; in existing points, leave empty or as read. Otherwise the request is rejected. */
3216
+ campaignUid?: number;
3217
+ /** Popups only: shows per visitor per day, 0..100; 0 is no cap. Inline blocks keep 0 */
3218
+ maxShowsPerDay: number;
3219
+ };
3163
3220
  /** PointParamsSendInbox contains App Inbox message point configuration */
3164
3221
  export type PointParamsSendInbox = {
3165
3222
  /** App Inbox preset code (message content) */
3166
3223
  presetCode: string;
3167
3224
  /** Application code */
3168
3225
  applicationCode: string;
3169
- /** Campaign code for tracking (will be created automatically if empty) */
3226
+ /** Campaign code, assigned when the journey starts. Leave empty in Create and in new points, except for the system campaign created for this point; in existing points, leave empty or as read. Otherwise the request is rejected. */
3170
3227
  campaignCode?: string;
3171
- /** Campaign UID for tracking (will be created automatically if empty) */
3228
+ /** Campaign UID, assigned when the journey starts. Leave empty in Create and in new points, except for the system campaign created for this point; in existing points, leave empty or as read. Otherwise the request is rejected. */
3172
3229
  campaignUid?: number;
3173
3230
  /** Exact expiration date of the inbox message */
3174
3231
  expireAtDate: Date;
@@ -4044,6 +4101,8 @@ export type AccountRestrictionValues = {
4044
4101
  allowJourneyPointTemplates: boolean;
4045
4102
  /** Whether the Loop point can be placed on the canvas */
4046
4103
  allowJourneyLoopPoint: boolean;
4104
+ /** Whether the Web placement point can be placed on the canvas */
4105
+ allowWebPlacement: boolean;
4047
4106
  };
4048
4107
  /**
4049
4108
  * SavePointTemplateRequest carries one manifest version. A published (slug, version) is immutable:
@@ -5043,6 +5102,20 @@ export type TestWebhookResponse = {
5043
5102
  statusCode: number;
5044
5103
  body: string;
5045
5104
  };
5105
+ /** PreviewWebPlacementRequest shows the placement of an unsaved or saved point to a test device */
5106
+ export type PreviewWebPlacementRequest = {
5107
+ /** Application code; params.application_code must match it */
5108
+ applicationCode?: string;
5109
+ /** HWID of a test device registered in the application */
5110
+ hwid?: string;
5111
+ /** The placement as configured in the point form */
5112
+ params?: PointParamsWebPlacement;
5113
+ };
5114
+ /** PreviewWebPlacementResponse names who the placement was queued for */
5115
+ export type PreviewWebPlacementResponse = {
5116
+ /** User ID the placement waits under: the device's user, or its HWID when it has none */
5117
+ userId: string;
5118
+ };
5046
5119
  /** GetEventsByApplicationCodeRequest requests events for an application */
5047
5120
  export type GetEventsByApplicationCodeRequest = {
5048
5121
  /** Application code */