commandbar 1.10.2 → 1.11.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (52) hide show
  1. package/build/commandbar/src/shared/services/analytics/EventHandler.d.ts +7 -2
  2. package/build/commandbar/src/shared/services/analytics/event-queue.d.ts +13 -0
  3. package/build/commandbar/src/shared/services/analytics/types.d.ts +1 -1
  4. package/build/commandbar/src/shared/services/analytics/v2/client.d.ts +54 -0
  5. package/build/commandbar/src/shared/services/analytics/v2/helpers.d.ts +6 -0
  6. package/build/commandbar/src/shared/services/analytics/v2/schema.d.ts +152 -0
  7. package/build/commandbar/src/shared/services/analytics/v2/types.d.ts +4 -0
  8. package/build/commandbar-js/src/index.d.ts +0 -1
  9. package/build/commandbar-js/src/index.js +1 -1
  10. package/build/commandbar-js/src/snippet.d.ts +7 -1
  11. package/build/internal/src/client/CommandBarClientSDK.d.ts +12 -0
  12. package/build/internal/src/client/CommandBarProxySDK.d.ts +1 -4
  13. package/build/internal/src/client/CommandBarSDK.d.ts +5 -3
  14. package/build/internal/src/client/SDKConfig.d.ts +3 -1
  15. package/build/internal/src/client/globals.d.ts +1 -0
  16. package/build/internal/src/client/symbols.d.ts +3 -1
  17. package/build/internal/src/middleware/CommandFromClientV.d.ts +16 -2
  18. package/build/internal/src/middleware/OrganizationV.d.ts +34 -8
  19. package/build/internal/src/middleware/additionalResource.d.ts +9 -9
  20. package/build/internal/src/middleware/api.d.ts +173 -0
  21. package/build/internal/src/middleware/billing.d.ts +10 -0
  22. package/build/internal/src/middleware/chat.d.ts +3662 -172
  23. package/build/internal/src/middleware/checklist.d.ts +18 -10
  24. package/build/internal/src/middleware/command.d.ts +540 -140
  25. package/build/internal/src/middleware/endUser.d.ts +2 -0
  26. package/build/internal/src/middleware/experienceTemplate.d.ts +2874 -8
  27. package/build/internal/src/middleware/experiencesSearch.d.ts +233 -28
  28. package/build/internal/src/middleware/flags.d.ts +14 -1
  29. package/build/internal/src/middleware/generics.d.ts +1 -0
  30. package/build/internal/src/middleware/helpDocsIntegration.d.ts +98 -0
  31. package/build/internal/src/middleware/helpDocsSearch.d.ts +165 -20
  32. package/build/internal/src/middleware/helpDocsSync.d.ts +4 -0
  33. package/build/internal/src/middleware/helpers/actions.d.ts +6 -6
  34. package/build/internal/src/middleware/helpers/commandTemplate.d.ts +2 -2
  35. package/build/internal/src/middleware/helpers/rules.d.ts +7 -7
  36. package/build/internal/src/middleware/localizedMessage.d.ts +50 -0
  37. package/build/internal/src/middleware/network.d.ts +1 -0
  38. package/build/internal/src/middleware/nudge.d.ts +96 -24
  39. package/build/internal/src/middleware/organization.d.ts +180 -62
  40. package/build/internal/src/middleware/organizationSettings.d.ts +8 -8
  41. package/build/internal/src/middleware/profile.d.ts +8 -0
  42. package/build/internal/src/middleware/recommendationSet.d.ts +18 -9
  43. package/build/internal/src/middleware/theme.d.ts +7 -0
  44. package/build/internal/src/middleware/types.d.ts +23 -5
  45. package/build/internal/src/middleware/user.d.ts +9 -1
  46. package/build/internal/src/middleware/workflow.d.ts +69 -0
  47. package/package.json +5 -2
  48. package/src/index.ts +0 -1
  49. package/src/init.ts +27 -13
  50. package/src/snippet.ts +79 -74
  51. package/build/internal/src/client/OrgConfig.d.ts +0 -5
  52. package/build/internal/src/middleware/guide.d.ts +0 -37
@@ -75,7 +75,7 @@ export declare const NudgeButtonActionV: t.UnionC<[t.TypeC<{
75
75
  }>]>, t.TypeC<{
76
76
  type: t.LiteralC<"open_chat">;
77
77
  meta: t.TypeC<{
78
- type: t.UnionC<[t.LiteralC<"intercom">, t.LiteralC<"helpscout">, t.LiteralC<"freshdesk">, t.LiteralC<"crisp">, t.LiteralC<"zendesk">, t.LiteralC<"liveChat">, t.LiteralC<"gist">, t.LiteralC<"olark">, t.LiteralC<"hubspot">, t.LiteralC<"drift">, t.LiteralC<"">]>;
78
+ type: t.UnionC<[t.LiteralC<"intercom">, t.LiteralC<"helpscout">, t.LiteralC<"freshdesk">, t.LiteralC<"freshchat">, t.LiteralC<"crisp">, t.LiteralC<"zendesk">, t.LiteralC<"liveChat">, t.LiteralC<"gist">, t.LiteralC<"olark">, t.LiteralC<"hubspot">, t.LiteralC<"drift">, t.LiteralC<"zendesk_handoff">, t.LiteralC<"">]>;
79
79
  }>;
80
80
  }>, t.TypeC<{
81
81
  type: t.LiteralC<"dismiss">;
@@ -128,7 +128,7 @@ export declare const NudgeConditionalActionV: t.TypeC<{
128
128
  }>]>, t.TypeC<{
129
129
  type: t.LiteralC<"open_chat">;
130
130
  meta: t.TypeC<{
131
- type: t.UnionC<[t.LiteralC<"intercom">, t.LiteralC<"helpscout">, t.LiteralC<"freshdesk">, t.LiteralC<"crisp">, t.LiteralC<"zendesk">, t.LiteralC<"liveChat">, t.LiteralC<"gist">, t.LiteralC<"olark">, t.LiteralC<"hubspot">, t.LiteralC<"drift">, t.LiteralC<"">]>;
131
+ type: t.UnionC<[t.LiteralC<"intercom">, t.LiteralC<"helpscout">, t.LiteralC<"freshdesk">, t.LiteralC<"freshchat">, t.LiteralC<"crisp">, t.LiteralC<"zendesk">, t.LiteralC<"liveChat">, t.LiteralC<"gist">, t.LiteralC<"olark">, t.LiteralC<"hubspot">, t.LiteralC<"drift">, t.LiteralC<"zendesk_handoff">, t.LiteralC<"">]>;
132
132
  }>;
133
133
  }>, t.TypeC<{
134
134
  type: t.LiteralC<"dismiss">;
@@ -184,7 +184,7 @@ export declare const NudgeContentButtonBlockV: t.TypeC<{
184
184
  }>]>, t.TypeC<{
185
185
  type: t.LiteralC<"open_chat">;
186
186
  meta: t.TypeC<{
187
- type: t.UnionC<[t.LiteralC<"intercom">, t.LiteralC<"helpscout">, t.LiteralC<"freshdesk">, t.LiteralC<"crisp">, t.LiteralC<"zendesk">, t.LiteralC<"liveChat">, t.LiteralC<"gist">, t.LiteralC<"olark">, t.LiteralC<"hubspot">, t.LiteralC<"drift">, t.LiteralC<"">]>;
187
+ type: t.UnionC<[t.LiteralC<"intercom">, t.LiteralC<"helpscout">, t.LiteralC<"freshdesk">, t.LiteralC<"freshchat">, t.LiteralC<"crisp">, t.LiteralC<"zendesk">, t.LiteralC<"liveChat">, t.LiteralC<"gist">, t.LiteralC<"olark">, t.LiteralC<"hubspot">, t.LiteralC<"drift">, t.LiteralC<"zendesk_handoff">, t.LiteralC<"">]>;
188
188
  }>;
189
189
  }>, t.TypeC<{
190
190
  type: t.LiteralC<"dismiss">;
@@ -238,7 +238,7 @@ export declare const NudgeContentButtonBlockV: t.TypeC<{
238
238
  }>]>, t.TypeC<{
239
239
  type: t.LiteralC<"open_chat">;
240
240
  meta: t.TypeC<{
241
- type: t.UnionC<[t.LiteralC<"intercom">, t.LiteralC<"helpscout">, t.LiteralC<"freshdesk">, t.LiteralC<"crisp">, t.LiteralC<"zendesk">, t.LiteralC<"liveChat">, t.LiteralC<"gist">, t.LiteralC<"olark">, t.LiteralC<"hubspot">, t.LiteralC<"drift">, t.LiteralC<"">]>;
241
+ type: t.UnionC<[t.LiteralC<"intercom">, t.LiteralC<"helpscout">, t.LiteralC<"freshdesk">, t.LiteralC<"freshchat">, t.LiteralC<"crisp">, t.LiteralC<"zendesk">, t.LiteralC<"liveChat">, t.LiteralC<"gist">, t.LiteralC<"olark">, t.LiteralC<"hubspot">, t.LiteralC<"drift">, t.LiteralC<"zendesk_handoff">, t.LiteralC<"">]>;
242
242
  }>;
243
243
  }>, t.TypeC<{
244
244
  type: t.LiteralC<"dismiss">;
@@ -321,6 +321,11 @@ export declare const NudgeContentSurveyRatingBlockV: t.TypeC<{
321
321
  lower_label: t.StringC;
322
322
  upper_label: t.StringC;
323
323
  options: t.NumberC;
324
+ }>, t.TypeC<{
325
+ type: t.LiteralC<"nps">;
326
+ lower_label: t.StringC;
327
+ upper_label: t.StringC;
328
+ options: t.NumberC;
324
329
  }>]>, t.PartialC<{
325
330
  validation: t.PartialC<{
326
331
  required: t.UnionC<[t.TypeC<{
@@ -391,7 +396,7 @@ export declare const NudgeContentBlockV: t.UnionC<[t.TypeC<{
391
396
  }>]>, t.TypeC<{
392
397
  type: t.LiteralC<"open_chat">;
393
398
  meta: t.TypeC<{
394
- type: t.UnionC<[t.LiteralC<"intercom">, t.LiteralC<"helpscout">, t.LiteralC<"freshdesk">, t.LiteralC<"crisp">, t.LiteralC<"zendesk">, t.LiteralC<"liveChat">, t.LiteralC<"gist">, t.LiteralC<"olark">, t.LiteralC<"hubspot">, t.LiteralC<"drift">, t.LiteralC<"">]>;
399
+ type: t.UnionC<[t.LiteralC<"intercom">, t.LiteralC<"helpscout">, t.LiteralC<"freshdesk">, t.LiteralC<"freshchat">, t.LiteralC<"crisp">, t.LiteralC<"zendesk">, t.LiteralC<"liveChat">, t.LiteralC<"gist">, t.LiteralC<"olark">, t.LiteralC<"hubspot">, t.LiteralC<"drift">, t.LiteralC<"zendesk_handoff">, t.LiteralC<"">]>;
395
400
  }>;
396
401
  }>, t.TypeC<{
397
402
  type: t.LiteralC<"dismiss">;
@@ -445,7 +450,7 @@ export declare const NudgeContentBlockV: t.UnionC<[t.TypeC<{
445
450
  }>]>, t.TypeC<{
446
451
  type: t.LiteralC<"open_chat">;
447
452
  meta: t.TypeC<{
448
- type: t.UnionC<[t.LiteralC<"intercom">, t.LiteralC<"helpscout">, t.LiteralC<"freshdesk">, t.LiteralC<"crisp">, t.LiteralC<"zendesk">, t.LiteralC<"liveChat">, t.LiteralC<"gist">, t.LiteralC<"olark">, t.LiteralC<"hubspot">, t.LiteralC<"drift">, t.LiteralC<"">]>;
453
+ type: t.UnionC<[t.LiteralC<"intercom">, t.LiteralC<"helpscout">, t.LiteralC<"freshdesk">, t.LiteralC<"freshchat">, t.LiteralC<"crisp">, t.LiteralC<"zendesk">, t.LiteralC<"liveChat">, t.LiteralC<"gist">, t.LiteralC<"olark">, t.LiteralC<"hubspot">, t.LiteralC<"drift">, t.LiteralC<"zendesk_handoff">, t.LiteralC<"">]>;
449
454
  }>;
450
455
  }>, t.TypeC<{
451
456
  type: t.LiteralC<"dismiss">;
@@ -525,6 +530,11 @@ export declare const NudgeContentBlockV: t.UnionC<[t.TypeC<{
525
530
  lower_label: t.StringC;
526
531
  upper_label: t.StringC;
527
532
  options: t.NumberC;
533
+ }>, t.TypeC<{
534
+ type: t.LiteralC<"nps">;
535
+ lower_label: t.StringC;
536
+ upper_label: t.StringC;
537
+ options: t.NumberC;
528
538
  }>]>, t.PartialC<{
529
539
  validation: t.PartialC<{
530
540
  required: t.UnionC<[t.TypeC<{
@@ -616,7 +626,7 @@ export declare const NudgeStepV: t.IntersectionC<[t.TypeC<{
616
626
  }>]>, t.TypeC<{
617
627
  type: t.LiteralC<"open_chat">;
618
628
  meta: t.TypeC<{
619
- type: t.UnionC<[t.LiteralC<"intercom">, t.LiteralC<"helpscout">, t.LiteralC<"freshdesk">, t.LiteralC<"crisp">, t.LiteralC<"zendesk">, t.LiteralC<"liveChat">, t.LiteralC<"gist">, t.LiteralC<"olark">, t.LiteralC<"hubspot">, t.LiteralC<"drift">, t.LiteralC<"">]>;
629
+ type: t.UnionC<[t.LiteralC<"intercom">, t.LiteralC<"helpscout">, t.LiteralC<"freshdesk">, t.LiteralC<"freshchat">, t.LiteralC<"crisp">, t.LiteralC<"zendesk">, t.LiteralC<"liveChat">, t.LiteralC<"gist">, t.LiteralC<"olark">, t.LiteralC<"hubspot">, t.LiteralC<"drift">, t.LiteralC<"zendesk_handoff">, t.LiteralC<"">]>;
620
630
  }>;
621
631
  }>, t.TypeC<{
622
632
  type: t.LiteralC<"dismiss">;
@@ -670,7 +680,7 @@ export declare const NudgeStepV: t.IntersectionC<[t.TypeC<{
670
680
  }>]>, t.TypeC<{
671
681
  type: t.LiteralC<"open_chat">;
672
682
  meta: t.TypeC<{
673
- type: t.UnionC<[t.LiteralC<"intercom">, t.LiteralC<"helpscout">, t.LiteralC<"freshdesk">, t.LiteralC<"crisp">, t.LiteralC<"zendesk">, t.LiteralC<"liveChat">, t.LiteralC<"gist">, t.LiteralC<"olark">, t.LiteralC<"hubspot">, t.LiteralC<"drift">, t.LiteralC<"">]>;
683
+ type: t.UnionC<[t.LiteralC<"intercom">, t.LiteralC<"helpscout">, t.LiteralC<"freshdesk">, t.LiteralC<"freshchat">, t.LiteralC<"crisp">, t.LiteralC<"zendesk">, t.LiteralC<"liveChat">, t.LiteralC<"gist">, t.LiteralC<"olark">, t.LiteralC<"hubspot">, t.LiteralC<"drift">, t.LiteralC<"zendesk_handoff">, t.LiteralC<"">]>;
674
684
  }>;
675
685
  }>, t.TypeC<{
676
686
  type: t.LiteralC<"dismiss">;
@@ -750,6 +760,11 @@ export declare const NudgeStepV: t.IntersectionC<[t.TypeC<{
750
760
  lower_label: t.StringC;
751
761
  upper_label: t.StringC;
752
762
  options: t.NumberC;
763
+ }>, t.TypeC<{
764
+ type: t.LiteralC<"nps">;
765
+ lower_label: t.StringC;
766
+ upper_label: t.StringC;
767
+ options: t.NumberC;
753
768
  }>]>, t.PartialC<{
754
769
  validation: t.PartialC<{
755
770
  required: t.UnionC<[t.TypeC<{
@@ -781,6 +796,7 @@ export declare const NudgeStepV: t.IntersectionC<[t.TypeC<{
781
796
  }>]>;
782
797
  }>]>>;
783
798
  is_live: t.BooleanC;
799
+ preview_url: t.UnionC<[t.StringC, t.NullC, t.UndefinedC]>;
784
800
  }>, t.IntersectionC<[t.TypeC<{
785
801
  form_factor: t.UnionC<[t.TypeC<{
786
802
  type: t.LiteralC<"modal">;
@@ -934,7 +950,7 @@ export declare const NudgeV: t.IntersectionC<[t.IntersectionC<[t.TypeC<{
934
950
  }>]>, t.TypeC<{
935
951
  type: t.LiteralC<"open_chat">;
936
952
  meta: t.TypeC<{
937
- type: t.UnionC<[t.LiteralC<"intercom">, t.LiteralC<"helpscout">, t.LiteralC<"freshdesk">, t.LiteralC<"crisp">, t.LiteralC<"zendesk">, t.LiteralC<"liveChat">, t.LiteralC<"gist">, t.LiteralC<"olark">, t.LiteralC<"hubspot">, t.LiteralC<"drift">, t.LiteralC<"">]>;
953
+ type: t.UnionC<[t.LiteralC<"intercom">, t.LiteralC<"helpscout">, t.LiteralC<"freshdesk">, t.LiteralC<"freshchat">, t.LiteralC<"crisp">, t.LiteralC<"zendesk">, t.LiteralC<"liveChat">, t.LiteralC<"gist">, t.LiteralC<"olark">, t.LiteralC<"hubspot">, t.LiteralC<"drift">, t.LiteralC<"zendesk_handoff">, t.LiteralC<"">]>;
938
954
  }>;
939
955
  }>, t.TypeC<{
940
956
  type: t.LiteralC<"dismiss">;
@@ -988,7 +1004,7 @@ export declare const NudgeV: t.IntersectionC<[t.IntersectionC<[t.TypeC<{
988
1004
  }>]>, t.TypeC<{
989
1005
  type: t.LiteralC<"open_chat">;
990
1006
  meta: t.TypeC<{
991
- type: t.UnionC<[t.LiteralC<"intercom">, t.LiteralC<"helpscout">, t.LiteralC<"freshdesk">, t.LiteralC<"crisp">, t.LiteralC<"zendesk">, t.LiteralC<"liveChat">, t.LiteralC<"gist">, t.LiteralC<"olark">, t.LiteralC<"hubspot">, t.LiteralC<"drift">, t.LiteralC<"">]>;
1007
+ type: t.UnionC<[t.LiteralC<"intercom">, t.LiteralC<"helpscout">, t.LiteralC<"freshdesk">, t.LiteralC<"freshchat">, t.LiteralC<"crisp">, t.LiteralC<"zendesk">, t.LiteralC<"liveChat">, t.LiteralC<"gist">, t.LiteralC<"olark">, t.LiteralC<"hubspot">, t.LiteralC<"drift">, t.LiteralC<"zendesk_handoff">, t.LiteralC<"">]>;
992
1008
  }>;
993
1009
  }>, t.TypeC<{
994
1010
  type: t.LiteralC<"dismiss">;
@@ -1068,6 +1084,11 @@ export declare const NudgeV: t.IntersectionC<[t.IntersectionC<[t.TypeC<{
1068
1084
  lower_label: t.StringC;
1069
1085
  upper_label: t.StringC;
1070
1086
  options: t.NumberC;
1087
+ }>, t.TypeC<{
1088
+ type: t.LiteralC<"nps">;
1089
+ lower_label: t.StringC;
1090
+ upper_label: t.StringC;
1091
+ options: t.NumberC;
1071
1092
  }>]>, t.PartialC<{
1072
1093
  validation: t.PartialC<{
1073
1094
  required: t.UnionC<[t.TypeC<{
@@ -1099,6 +1120,7 @@ export declare const NudgeV: t.IntersectionC<[t.IntersectionC<[t.TypeC<{
1099
1120
  }>]>;
1100
1121
  }>]>>;
1101
1122
  is_live: t.BooleanC;
1123
+ preview_url: t.UnionC<[t.StringC, t.NullC, t.UndefinedC]>;
1102
1124
  }>, t.IntersectionC<[t.TypeC<{
1103
1125
  form_factor: t.UnionC<[t.TypeC<{
1104
1126
  type: t.LiteralC<"modal">;
@@ -1176,6 +1198,7 @@ export declare const NudgeV: t.IntersectionC<[t.IntersectionC<[t.TypeC<{
1176
1198
  snooze_label: t.StringC;
1177
1199
  type: t.UnionC<[t.LiteralC<"announcement">, t.LiteralC<"product_tour">, t.LiteralC<"survey">, t.NullC]>;
1178
1200
  editor_tags: t.ArrayC<t.StringC>;
1201
+ preview_url: t.UnionC<[t.StringC, t.NullC, t.UndefinedC]>;
1179
1202
  }>]>;
1180
1203
  export declare const OldNudgeBaseV: t.IntersectionC<[t.TypeC<{
1181
1204
  id: t.NumberC;
@@ -1422,7 +1445,7 @@ export declare class Nudge {
1422
1445
  }) | {
1423
1446
  type: "open_chat";
1424
1447
  meta: {
1425
- type: "" | "intercom" | "helpscout" | "freshdesk" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "hubspot" | "drift";
1448
+ type: "" | "intercom" | "helpscout" | "freshdesk" | "freshchat" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "hubspot" | "drift" | "zendesk_handoff";
1426
1449
  };
1427
1450
  } | {
1428
1451
  type: "dismiss";
@@ -1476,7 +1499,7 @@ export declare class Nudge {
1476
1499
  }) | {
1477
1500
  type: "open_chat";
1478
1501
  meta: {
1479
- type: "" | "intercom" | "helpscout" | "freshdesk" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "hubspot" | "drift";
1502
+ type: "" | "intercom" | "helpscout" | "freshdesk" | "freshchat" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "hubspot" | "drift" | "zendesk_handoff";
1480
1503
  };
1481
1504
  } | {
1482
1505
  type: "dismiss";
@@ -1556,6 +1579,11 @@ export declare class Nudge {
1556
1579
  lower_label: string;
1557
1580
  upper_label: string;
1558
1581
  options: number;
1582
+ } | {
1583
+ type: "nps";
1584
+ lower_label: string;
1585
+ upper_label: string;
1586
+ options: number;
1559
1587
  }) & {
1560
1588
  validation?: {
1561
1589
  required?: {
@@ -1587,6 +1615,7 @@ export declare class Nudge {
1587
1615
  };
1588
1616
  })[];
1589
1617
  is_live: boolean;
1618
+ preview_url: string | null | undefined;
1590
1619
  } & {
1591
1620
  form_factor: {
1592
1621
  type: "modal";
@@ -1664,6 +1693,7 @@ export declare class Nudge {
1664
1693
  snooze_label: string;
1665
1694
  type: "announcement" | "product_tour" | "survey" | null;
1666
1695
  editor_tags: string[];
1696
+ preview_url: string | null | undefined;
1667
1697
  };
1668
1698
  static create: (object: {
1669
1699
  slug: string;
@@ -1776,7 +1806,7 @@ export declare class Nudge {
1776
1806
  }) | {
1777
1807
  type: "open_chat";
1778
1808
  meta: {
1779
- type: "" | "intercom" | "helpscout" | "freshdesk" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "hubspot" | "drift";
1809
+ type: "" | "intercom" | "helpscout" | "freshdesk" | "freshchat" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "hubspot" | "drift" | "zendesk_handoff";
1780
1810
  };
1781
1811
  } | {
1782
1812
  type: "dismiss";
@@ -1830,7 +1860,7 @@ export declare class Nudge {
1830
1860
  }) | {
1831
1861
  type: "open_chat";
1832
1862
  meta: {
1833
- type: "" | "intercom" | "helpscout" | "freshdesk" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "hubspot" | "drift";
1863
+ type: "" | "intercom" | "helpscout" | "freshdesk" | "freshchat" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "hubspot" | "drift" | "zendesk_handoff";
1834
1864
  };
1835
1865
  } | {
1836
1866
  type: "dismiss";
@@ -1910,6 +1940,11 @@ export declare class Nudge {
1910
1940
  lower_label: string;
1911
1941
  upper_label: string;
1912
1942
  options: number;
1943
+ } | {
1944
+ type: "nps";
1945
+ lower_label: string;
1946
+ upper_label: string;
1947
+ options: number;
1913
1948
  }) & {
1914
1949
  validation?: {
1915
1950
  required?: {
@@ -1941,6 +1976,7 @@ export declare class Nudge {
1941
1976
  };
1942
1977
  })[];
1943
1978
  is_live: boolean;
1979
+ preview_url: string | null | undefined;
1944
1980
  } & {
1945
1981
  form_factor: {
1946
1982
  type: "modal";
@@ -2018,6 +2054,7 @@ export declare class Nudge {
2018
2054
  snooze_label: string;
2019
2055
  type: "announcement" | "product_tour" | "survey" | null;
2020
2056
  editor_tags: string[];
2057
+ preview_url: string | null | undefined;
2021
2058
  }, onSuccess?: (() => void) | undefined, onError?: ((err: string) => void) | undefined) => Promise<{
2022
2059
  slug: string;
2023
2060
  id: string | number;
@@ -2129,7 +2166,7 @@ export declare class Nudge {
2129
2166
  }) | {
2130
2167
  type: "open_chat";
2131
2168
  meta: {
2132
- type: "" | "intercom" | "helpscout" | "freshdesk" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "hubspot" | "drift";
2169
+ type: "" | "intercom" | "helpscout" | "freshdesk" | "freshchat" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "hubspot" | "drift" | "zendesk_handoff";
2133
2170
  };
2134
2171
  } | {
2135
2172
  type: "dismiss";
@@ -2183,7 +2220,7 @@ export declare class Nudge {
2183
2220
  }) | {
2184
2221
  type: "open_chat";
2185
2222
  meta: {
2186
- type: "" | "intercom" | "helpscout" | "freshdesk" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "hubspot" | "drift";
2223
+ type: "" | "intercom" | "helpscout" | "freshdesk" | "freshchat" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "hubspot" | "drift" | "zendesk_handoff";
2187
2224
  };
2188
2225
  } | {
2189
2226
  type: "dismiss";
@@ -2263,6 +2300,11 @@ export declare class Nudge {
2263
2300
  lower_label: string;
2264
2301
  upper_label: string;
2265
2302
  options: number;
2303
+ } | {
2304
+ type: "nps";
2305
+ lower_label: string;
2306
+ upper_label: string;
2307
+ options: number;
2266
2308
  }) & {
2267
2309
  validation?: {
2268
2310
  required?: {
@@ -2294,6 +2336,7 @@ export declare class Nudge {
2294
2336
  };
2295
2337
  })[];
2296
2338
  is_live: boolean;
2339
+ preview_url: string | null | undefined;
2297
2340
  } & {
2298
2341
  form_factor: {
2299
2342
  type: "modal";
@@ -2371,6 +2414,7 @@ export declare class Nudge {
2371
2414
  snooze_label: string;
2372
2415
  type: "announcement" | "product_tour" | "survey" | null;
2373
2416
  editor_tags: string[];
2417
+ preview_url: string | null | undefined;
2374
2418
  }>;
2375
2419
  static update: (object: {
2376
2420
  slug: string;
@@ -2483,7 +2527,7 @@ export declare class Nudge {
2483
2527
  }) | {
2484
2528
  type: "open_chat";
2485
2529
  meta: {
2486
- type: "" | "intercom" | "helpscout" | "freshdesk" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "hubspot" | "drift";
2530
+ type: "" | "intercom" | "helpscout" | "freshdesk" | "freshchat" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "hubspot" | "drift" | "zendesk_handoff";
2487
2531
  };
2488
2532
  } | {
2489
2533
  type: "dismiss";
@@ -2537,7 +2581,7 @@ export declare class Nudge {
2537
2581
  }) | {
2538
2582
  type: "open_chat";
2539
2583
  meta: {
2540
- type: "" | "intercom" | "helpscout" | "freshdesk" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "hubspot" | "drift";
2584
+ type: "" | "intercom" | "helpscout" | "freshdesk" | "freshchat" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "hubspot" | "drift" | "zendesk_handoff";
2541
2585
  };
2542
2586
  } | {
2543
2587
  type: "dismiss";
@@ -2617,6 +2661,11 @@ export declare class Nudge {
2617
2661
  lower_label: string;
2618
2662
  upper_label: string;
2619
2663
  options: number;
2664
+ } | {
2665
+ type: "nps";
2666
+ lower_label: string;
2667
+ upper_label: string;
2668
+ options: number;
2620
2669
  }) & {
2621
2670
  validation?: {
2622
2671
  required?: {
@@ -2648,6 +2697,7 @@ export declare class Nudge {
2648
2697
  };
2649
2698
  })[];
2650
2699
  is_live: boolean;
2700
+ preview_url: string | null | undefined;
2651
2701
  } & {
2652
2702
  form_factor: {
2653
2703
  type: "modal";
@@ -2725,6 +2775,7 @@ export declare class Nudge {
2725
2775
  snooze_label: string;
2726
2776
  type: "announcement" | "product_tour" | "survey" | null;
2727
2777
  editor_tags: string[];
2778
+ preview_url: string | null | undefined;
2728
2779
  }, onSuccess?: (() => void) | undefined, onError?: ((err: string) => void) | undefined) => Promise<{
2729
2780
  slug: string;
2730
2781
  id: string | number;
@@ -2836,7 +2887,7 @@ export declare class Nudge {
2836
2887
  }) | {
2837
2888
  type: "open_chat";
2838
2889
  meta: {
2839
- type: "" | "intercom" | "helpscout" | "freshdesk" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "hubspot" | "drift";
2890
+ type: "" | "intercom" | "helpscout" | "freshdesk" | "freshchat" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "hubspot" | "drift" | "zendesk_handoff";
2840
2891
  };
2841
2892
  } | {
2842
2893
  type: "dismiss";
@@ -2890,7 +2941,7 @@ export declare class Nudge {
2890
2941
  }) | {
2891
2942
  type: "open_chat";
2892
2943
  meta: {
2893
- type: "" | "intercom" | "helpscout" | "freshdesk" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "hubspot" | "drift";
2944
+ type: "" | "intercom" | "helpscout" | "freshdesk" | "freshchat" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "hubspot" | "drift" | "zendesk_handoff";
2894
2945
  };
2895
2946
  } | {
2896
2947
  type: "dismiss";
@@ -2970,6 +3021,11 @@ export declare class Nudge {
2970
3021
  lower_label: string;
2971
3022
  upper_label: string;
2972
3023
  options: number;
3024
+ } | {
3025
+ type: "nps";
3026
+ lower_label: string;
3027
+ upper_label: string;
3028
+ options: number;
2973
3029
  }) & {
2974
3030
  validation?: {
2975
3031
  required?: {
@@ -3001,6 +3057,7 @@ export declare class Nudge {
3001
3057
  };
3002
3058
  })[];
3003
3059
  is_live: boolean;
3060
+ preview_url: string | null | undefined;
3004
3061
  } & {
3005
3062
  form_factor: {
3006
3063
  type: "modal";
@@ -3078,6 +3135,7 @@ export declare class Nudge {
3078
3135
  snooze_label: string;
3079
3136
  type: "announcement" | "product_tour" | "survey" | null;
3080
3137
  editor_tags: string[];
3138
+ preview_url: string | null | undefined;
3081
3139
  }>;
3082
3140
  static delete: (id: string | number, params?: Record<string, string> | undefined, onSuccess?: (() => void) | undefined, onError?: ((err: string) => void) | undefined) => Promise<void>;
3083
3141
  static list: (onSuccess?: (() => void) | undefined, onError?: ((err: string) => void) | undefined) => Promise<({
@@ -3191,7 +3249,7 @@ export declare class Nudge {
3191
3249
  }) | {
3192
3250
  type: "open_chat";
3193
3251
  meta: {
3194
- type: "" | "intercom" | "helpscout" | "freshdesk" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "hubspot" | "drift";
3252
+ type: "" | "intercom" | "helpscout" | "freshdesk" | "freshchat" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "hubspot" | "drift" | "zendesk_handoff";
3195
3253
  };
3196
3254
  } | {
3197
3255
  type: "dismiss";
@@ -3245,7 +3303,7 @@ export declare class Nudge {
3245
3303
  }) | {
3246
3304
  type: "open_chat";
3247
3305
  meta: {
3248
- type: "" | "intercom" | "helpscout" | "freshdesk" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "hubspot" | "drift";
3306
+ type: "" | "intercom" | "helpscout" | "freshdesk" | "freshchat" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "hubspot" | "drift" | "zendesk_handoff";
3249
3307
  };
3250
3308
  } | {
3251
3309
  type: "dismiss";
@@ -3325,6 +3383,11 @@ export declare class Nudge {
3325
3383
  lower_label: string;
3326
3384
  upper_label: string;
3327
3385
  options: number;
3386
+ } | {
3387
+ type: "nps";
3388
+ lower_label: string;
3389
+ upper_label: string;
3390
+ options: number;
3328
3391
  }) & {
3329
3392
  validation?: {
3330
3393
  required?: {
@@ -3356,6 +3419,7 @@ export declare class Nudge {
3356
3419
  };
3357
3420
  })[];
3358
3421
  is_live: boolean;
3422
+ preview_url: string | null | undefined;
3359
3423
  } & {
3360
3424
  form_factor: {
3361
3425
  type: "modal";
@@ -3433,6 +3497,7 @@ export declare class Nudge {
3433
3497
  snooze_label: string;
3434
3498
  type: "announcement" | "product_tour" | "survey" | null;
3435
3499
  editor_tags: string[];
3500
+ preview_url: string | null | undefined;
3436
3501
  })[]>;
3437
3502
  static read: (arg0: string, params?: Record<string, string> | undefined, callbacks?: {
3438
3503
  onSuccess?: (() => void) | undefined;
@@ -3548,7 +3613,7 @@ export declare class Nudge {
3548
3613
  }) | {
3549
3614
  type: "open_chat";
3550
3615
  meta: {
3551
- type: "" | "intercom" | "helpscout" | "freshdesk" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "hubspot" | "drift";
3616
+ type: "" | "intercom" | "helpscout" | "freshdesk" | "freshchat" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "hubspot" | "drift" | "zendesk_handoff";
3552
3617
  };
3553
3618
  } | {
3554
3619
  type: "dismiss";
@@ -3602,7 +3667,7 @@ export declare class Nudge {
3602
3667
  }) | {
3603
3668
  type: "open_chat";
3604
3669
  meta: {
3605
- type: "" | "intercom" | "helpscout" | "freshdesk" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "hubspot" | "drift";
3670
+ type: "" | "intercom" | "helpscout" | "freshdesk" | "freshchat" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "hubspot" | "drift" | "zendesk_handoff";
3606
3671
  };
3607
3672
  } | {
3608
3673
  type: "dismiss";
@@ -3682,6 +3747,11 @@ export declare class Nudge {
3682
3747
  lower_label: string;
3683
3748
  upper_label: string;
3684
3749
  options: number;
3750
+ } | {
3751
+ type: "nps";
3752
+ lower_label: string;
3753
+ upper_label: string;
3754
+ options: number;
3685
3755
  }) & {
3686
3756
  validation?: {
3687
3757
  required?: {
@@ -3713,6 +3783,7 @@ export declare class Nudge {
3713
3783
  };
3714
3784
  })[];
3715
3785
  is_live: boolean;
3786
+ preview_url: string | null | undefined;
3716
3787
  } & {
3717
3788
  form_factor: {
3718
3789
  type: "modal";
@@ -3790,6 +3861,7 @@ export declare class Nudge {
3790
3861
  snooze_label: string;
3791
3862
  type: "announcement" | "product_tour" | "survey" | null;
3792
3863
  editor_tags: string[];
3864
+ preview_url: string | null | undefined;
3793
3865
  }>;
3794
3866
  /**
3795
3867
  * Returns true if the nudge is new (not yet saved to the backend)