commandbar 1.8.7 → 1.10.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (61) hide show
  1. package/build/{internal/src/client → commandbar/src/shared/services/analytics}/EventHandler.d.ts +51 -15
  2. package/build/commandbar/src/shared/services/analytics/types.d.ts +77 -0
  3. package/build/commandbar-js/src/index.d.ts +2 -2
  4. package/build/commandbar-js/src/index.js +1 -1
  5. package/build/internal/src/client/AddContextOptions.d.ts +8 -0
  6. package/build/internal/src/client/CommandBarClientSDK.d.ts +70 -19
  7. package/build/internal/src/client/CommandBarProxySDK.d.ts +3 -3
  8. package/build/internal/src/client/CommandBarSDK.d.ts +34 -18
  9. package/build/internal/src/client/SDKConfig.d.ts +3 -2
  10. package/build/internal/src/client/globals.d.ts +6 -0
  11. package/build/internal/src/client/symbols.d.ts +13 -6
  12. package/build/internal/src/middleware/CommandFromClientV.d.ts +88 -18
  13. package/build/internal/src/middleware/IRecordSettings.d.ts +3 -0
  14. package/build/internal/src/middleware/OrganizationV.d.ts +320 -22
  15. package/build/internal/src/middleware/{ResourceSettingsV.d.ts → RecordSettingsV.d.ts} +2 -2
  16. package/build/internal/src/middleware/additionalResource.d.ts +270 -27
  17. package/build/internal/src/middleware/billing.d.ts +31 -0
  18. package/build/internal/src/middleware/chat.d.ts +12933 -0
  19. package/build/internal/src/middleware/checklist.d.ts +589 -70
  20. package/build/internal/src/middleware/command.d.ts +5433 -677
  21. package/build/internal/src/middleware/detailPreview.d.ts +12 -1
  22. package/build/internal/src/middleware/endUser.d.ts +132 -0
  23. package/build/internal/src/middleware/entityChanges.d.ts +17 -0
  24. package/build/internal/src/middleware/experienceTemplate.d.ts +59 -0
  25. package/build/internal/src/middleware/experiencesSearch.d.ts +3579 -0
  26. package/build/internal/src/middleware/flags.d.ts +20 -0
  27. package/build/internal/src/middleware/generics.d.ts +12 -11
  28. package/build/internal/src/middleware/helpDocsIntegration.d.ts +63 -8
  29. package/build/internal/src/middleware/helpDocsSearch.d.ts +2540 -0
  30. package/build/internal/src/middleware/helpHub.d.ts +26 -0
  31. package/build/internal/src/middleware/helpers/actions.d.ts +174 -16
  32. package/build/internal/src/middleware/helpers/commandTemplate.d.ts +144 -2
  33. package/build/internal/src/middleware/helpers/copilotPersonality.d.ts +12 -0
  34. package/build/internal/src/middleware/helpers/goals.d.ts +4 -2
  35. package/build/internal/src/middleware/helpers/pushTrigger.d.ts +28 -0
  36. package/build/internal/src/middleware/helpers/rules.d.ts +318 -50
  37. package/build/internal/src/middleware/network.d.ts +27 -3
  38. package/build/internal/src/middleware/nudge.d.ts +2220 -91
  39. package/build/internal/src/middleware/organization.d.ts +2289 -152
  40. package/build/internal/src/middleware/organizationSettings.d.ts +435 -20
  41. package/build/internal/src/middleware/profile.d.ts +2 -0
  42. package/build/internal/src/middleware/recommendationSet.d.ts +489 -1007
  43. package/build/internal/src/middleware/releases.d.ts +1 -1
  44. package/build/internal/src/middleware/theme.d.ts +425 -0
  45. package/build/internal/src/middleware/types.d.ts +88 -34
  46. package/build/internal/src/middleware/user.d.ts +1 -0
  47. package/build/internal/src/util/dispatchCustomEvent.d.ts +5 -3
  48. package/build/internal/src/util/operatingSystem.d.ts +11 -0
  49. package/build/internal/src/util/sentry.d.ts +23 -0
  50. package/package.json +3 -3
  51. package/src/index.ts +2 -2
  52. package/src/init.ts +11 -6
  53. package/src/snippet.ts +2 -2
  54. package/build/internal/src/client/AnalyticsEventTypes.d.ts +0 -1
  55. package/build/internal/src/client/SentryReporter.d.ts +0 -63
  56. package/build/internal/src/middleware/IResourceSettings.d.ts +0 -3
  57. package/build/internal/src/middleware/chatAnalytics.d.ts +0 -2601
  58. package/build/internal/src/middleware/dashboardFlags.d.ts +0 -9
  59. package/build/internal/src/middleware/helpers/endUser.d.ts +0 -11
  60. package/build/internal/src/middleware/qaPair.d.ts +0 -676
  61. package/build/internal/src/util/integrations.d.ts +0 -1
@@ -1,12 +1,14 @@
1
1
  import * as t from 'io-ts';
2
2
  export declare const NudgeContentMarkdownBlockV: t.TypeC<{
3
3
  type: t.LiteralC<"markdown">;
4
+ sort_key: t.UnionC<[t.NumberC, t.UndefinedC]>;
4
5
  meta: t.TypeC<{
5
6
  value: t.StringC;
6
7
  }>;
7
8
  }>;
8
9
  export declare const NudgeContentImageBlockV: t.TypeC<{
9
10
  type: t.LiteralC<"image">;
11
+ sort_key: t.UnionC<[t.NumberC, t.UndefinedC]>;
10
12
  meta: t.TypeC<{
11
13
  src: t.StringC;
12
14
  file_name: t.StringC;
@@ -15,6 +17,7 @@ export declare const NudgeContentImageBlockV: t.TypeC<{
15
17
  }>;
16
18
  export declare const NudgeContentVideoBlockV: t.TypeC<{
17
19
  type: t.LiteralC<"video">;
20
+ sort_key: t.UnionC<[t.NumberC, t.UndefinedC]>;
18
21
  meta: t.UnionC<[t.TypeC<{
19
22
  type: t.LiteralC<"url">;
20
23
  src: t.StringC;
@@ -23,26 +26,156 @@ export declare const NudgeContentVideoBlockV: t.TypeC<{
23
26
  command: t.StringC;
24
27
  }>]>;
25
28
  }>;
29
+ export declare const NudgeContentListBlockV: t.TypeC<{
30
+ type: t.LiteralC<"survey_list">;
31
+ sort_key: t.UnionC<[t.NumberC, t.UndefinedC]>;
32
+ meta: t.IntersectionC<[t.TypeC<{
33
+ options: t.ArrayC<t.StringC>;
34
+ list_type: t.UnionC<[t.LiteralC<"single">, t.LiteralC<"multiple">]>;
35
+ display_type: t.UnionC<[t.LiteralC<"dropdown">, t.LiteralC<"list">, t.LiteralC<"grid">]>;
36
+ }>, t.PartialC<{
37
+ validation: t.PartialC<{
38
+ required: t.UnionC<[t.TypeC<{
39
+ value: t.LiteralC<true>;
40
+ message: t.StringC;
41
+ }>, t.TypeC<{
42
+ value: t.LiteralC<false>;
43
+ message: t.NullC;
44
+ }>]>;
45
+ }>;
46
+ }>]>;
47
+ }>;
26
48
  export declare const NudgeContentHelpDocBlockV: t.TypeC<{
27
49
  type: t.LiteralC<"help_doc_command">;
50
+ sort_key: t.UnionC<[t.NumberC, t.UndefinedC]>;
28
51
  meta: t.TypeC<{
29
52
  command: t.StringC;
30
53
  }>;
31
54
  }>;
55
+ export declare const NudgeButtonActionV: t.UnionC<[t.TypeC<{
56
+ type: t.LiteralC<"execute_command">;
57
+ meta: t.IntersectionC<[t.TypeC<{
58
+ command: t.StringC;
59
+ }>, t.PartialC<{
60
+ type: t.UnionC<[t.LiteralC<"action">, t.LiteralC<"link">, t.LiteralC<"helpdoc">, t.LiteralC<"video">]>;
61
+ }>]>;
62
+ }>, t.TypeC<{
63
+ type: t.LiteralC<"no_action">;
64
+ }>, t.TypeC<{
65
+ type: t.LiteralC<"click">;
66
+ value: t.StringC;
67
+ }>, t.TypeC<{
68
+ type: t.UnionC<[t.LiteralC<"click">, t.LiteralC<"clickBySelector">, t.LiteralC<"clickByXpath">]>;
69
+ value: t.ArrayC<t.StringC>;
70
+ }>, t.IntersectionC<[t.TypeC<{
71
+ type: t.LiteralC<"link">;
72
+ value: t.StringC;
73
+ }>, t.PartialC<{
74
+ operation: t.UnionC<[t.LiteralC<"router">, t.LiteralC<"self">, t.LiteralC<"blank">, t.UndefinedC]>;
75
+ }>]>, t.TypeC<{
76
+ type: t.LiteralC<"open_chat">;
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<"">]>;
79
+ }>;
80
+ }>, t.TypeC<{
81
+ type: t.LiteralC<"dismiss">;
82
+ }>, t.TypeC<{
83
+ type: t.LiteralC<"snooze">;
84
+ }>, t.TypeC<{
85
+ type: t.LiteralC<"questlist">;
86
+ value: t.NumberC;
87
+ }>, t.TypeC<{
88
+ type: t.LiteralC<"step_back">;
89
+ }>, t.TypeC<{
90
+ type: t.LiteralC<"nudge">;
91
+ value: t.NumberC;
92
+ }>, t.TypeC<{
93
+ type: t.LiteralC<"go_to_step">;
94
+ value: t.NumberC;
95
+ }>, t.IntersectionC<[t.TypeC<{
96
+ type: t.LiteralC<"open_bar">;
97
+ }>, t.PartialC<{
98
+ value: t.StringC;
99
+ categoryFilter: t.NumberC;
100
+ }>]>, t.TypeC<{
101
+ type: t.LiteralC<"open_helphub">;
102
+ }>, t.TypeC<{
103
+ type: t.LiteralC<"open_copilot">;
104
+ }>]>;
105
+ export declare const NudgeConditionalActionV: t.TypeC<{
106
+ operator: t.UnionC<[t.LiteralC<"eq">, t.LiteralC<"neq">, t.LiteralC<"gt">, t.LiteralC<"lt">]>;
107
+ operand: t.UnionC<[t.StringC, t.NumberC]>;
108
+ action: t.UnionC<[t.TypeC<{
109
+ type: t.LiteralC<"execute_command">;
110
+ meta: t.IntersectionC<[t.TypeC<{
111
+ command: t.StringC;
112
+ }>, t.PartialC<{
113
+ type: t.UnionC<[t.LiteralC<"action">, t.LiteralC<"link">, t.LiteralC<"helpdoc">, t.LiteralC<"video">]>;
114
+ }>]>;
115
+ }>, t.TypeC<{
116
+ type: t.LiteralC<"no_action">;
117
+ }>, t.TypeC<{
118
+ type: t.LiteralC<"click">;
119
+ value: t.StringC;
120
+ }>, t.TypeC<{
121
+ type: t.UnionC<[t.LiteralC<"click">, t.LiteralC<"clickBySelector">, t.LiteralC<"clickByXpath">]>;
122
+ value: t.ArrayC<t.StringC>;
123
+ }>, t.IntersectionC<[t.TypeC<{
124
+ type: t.LiteralC<"link">;
125
+ value: t.StringC;
126
+ }>, t.PartialC<{
127
+ operation: t.UnionC<[t.LiteralC<"router">, t.LiteralC<"self">, t.LiteralC<"blank">, t.UndefinedC]>;
128
+ }>]>, t.TypeC<{
129
+ type: t.LiteralC<"open_chat">;
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<"">]>;
132
+ }>;
133
+ }>, t.TypeC<{
134
+ type: t.LiteralC<"dismiss">;
135
+ }>, t.TypeC<{
136
+ type: t.LiteralC<"snooze">;
137
+ }>, t.TypeC<{
138
+ type: t.LiteralC<"questlist">;
139
+ value: t.NumberC;
140
+ }>, t.TypeC<{
141
+ type: t.LiteralC<"step_back">;
142
+ }>, t.TypeC<{
143
+ type: t.LiteralC<"nudge">;
144
+ value: t.NumberC;
145
+ }>, t.TypeC<{
146
+ type: t.LiteralC<"go_to_step">;
147
+ value: t.NumberC;
148
+ }>, t.IntersectionC<[t.TypeC<{
149
+ type: t.LiteralC<"open_bar">;
150
+ }>, t.PartialC<{
151
+ value: t.StringC;
152
+ categoryFilter: t.NumberC;
153
+ }>]>, t.TypeC<{
154
+ type: t.LiteralC<"open_helphub">;
155
+ }>, t.TypeC<{
156
+ type: t.LiteralC<"open_copilot">;
157
+ }>]>;
158
+ }>;
32
159
  export declare const NudgeContentButtonBlockV: t.TypeC<{
33
160
  type: t.LiteralC<"button">;
161
+ sort_key: t.UnionC<[t.NumberC, t.UndefinedC]>;
34
162
  meta: t.UnionC<[t.PartialC<{
35
163
  label: t.StringC;
36
164
  action: t.UnionC<[t.TypeC<{
37
165
  type: t.LiteralC<"execute_command">;
38
- meta: t.TypeC<{
166
+ meta: t.IntersectionC<[t.TypeC<{
39
167
  command: t.StringC;
40
- }>;
168
+ }>, t.PartialC<{
169
+ type: t.UnionC<[t.LiteralC<"action">, t.LiteralC<"link">, t.LiteralC<"helpdoc">, t.LiteralC<"video">]>;
170
+ }>]>;
41
171
  }>, t.TypeC<{
42
172
  type: t.LiteralC<"no_action">;
43
173
  }>, t.TypeC<{
44
174
  type: t.LiteralC<"click">;
45
175
  value: t.StringC;
176
+ }>, t.TypeC<{
177
+ type: t.UnionC<[t.LiteralC<"click">, t.LiteralC<"clickBySelector">, t.LiteralC<"clickByXpath">]>;
178
+ value: t.ArrayC<t.StringC>;
46
179
  }>, t.IntersectionC<[t.TypeC<{
47
180
  type: t.LiteralC<"link">;
48
181
  value: t.StringC;
@@ -51,23 +184,128 @@ export declare const NudgeContentButtonBlockV: t.TypeC<{
51
184
  }>]>, t.TypeC<{
52
185
  type: t.LiteralC<"open_chat">;
53
186
  meta: t.TypeC<{
54
- type: t.StringC;
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<"">]>;
55
188
  }>;
56
189
  }>, t.TypeC<{
57
190
  type: t.LiteralC<"dismiss">;
191
+ }>, t.TypeC<{
192
+ type: t.LiteralC<"snooze">;
193
+ }>, t.TypeC<{
194
+ type: t.LiteralC<"questlist">;
195
+ value: t.NumberC;
196
+ }>, t.TypeC<{
197
+ type: t.LiteralC<"step_back">;
198
+ }>, t.TypeC<{
199
+ type: t.LiteralC<"nudge">;
200
+ value: t.NumberC;
201
+ }>, t.TypeC<{
202
+ type: t.LiteralC<"go_to_step">;
203
+ value: t.NumberC;
204
+ }>, t.IntersectionC<[t.TypeC<{
205
+ type: t.LiteralC<"open_bar">;
206
+ }>, t.PartialC<{
207
+ value: t.StringC;
208
+ categoryFilter: t.NumberC;
209
+ }>]>, t.TypeC<{
210
+ type: t.LiteralC<"open_helphub">;
211
+ }>, t.TypeC<{
212
+ type: t.LiteralC<"open_copilot">;
58
213
  }>]>;
59
- button_type: t.UnionC<[t.LiteralC<"primary">, t.LiteralC<"secondary">]>;
214
+ button_type: t.UnionC<[t.LiteralC<"primary">, t.LiteralC<"secondary">, t.LiteralC<"snooze">]>;
215
+ conditional_actions: t.ArrayC<t.TypeC<{
216
+ operator: t.UnionC<[t.LiteralC<"eq">, t.LiteralC<"neq">, t.LiteralC<"gt">, t.LiteralC<"lt">]>;
217
+ operand: t.UnionC<[t.StringC, t.NumberC]>;
218
+ action: t.UnionC<[t.TypeC<{
219
+ type: t.LiteralC<"execute_command">;
220
+ meta: t.IntersectionC<[t.TypeC<{
221
+ command: t.StringC;
222
+ }>, t.PartialC<{
223
+ type: t.UnionC<[t.LiteralC<"action">, t.LiteralC<"link">, t.LiteralC<"helpdoc">, t.LiteralC<"video">]>;
224
+ }>]>;
225
+ }>, t.TypeC<{
226
+ type: t.LiteralC<"no_action">;
227
+ }>, t.TypeC<{
228
+ type: t.LiteralC<"click">;
229
+ value: t.StringC;
230
+ }>, t.TypeC<{
231
+ type: t.UnionC<[t.LiteralC<"click">, t.LiteralC<"clickBySelector">, t.LiteralC<"clickByXpath">]>;
232
+ value: t.ArrayC<t.StringC>;
233
+ }>, t.IntersectionC<[t.TypeC<{
234
+ type: t.LiteralC<"link">;
235
+ value: t.StringC;
236
+ }>, t.PartialC<{
237
+ operation: t.UnionC<[t.LiteralC<"router">, t.LiteralC<"self">, t.LiteralC<"blank">, t.UndefinedC]>;
238
+ }>]>, t.TypeC<{
239
+ type: t.LiteralC<"open_chat">;
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<"">]>;
242
+ }>;
243
+ }>, t.TypeC<{
244
+ type: t.LiteralC<"dismiss">;
245
+ }>, t.TypeC<{
246
+ type: t.LiteralC<"snooze">;
247
+ }>, t.TypeC<{
248
+ type: t.LiteralC<"questlist">;
249
+ value: t.NumberC;
250
+ }>, t.TypeC<{
251
+ type: t.LiteralC<"step_back">;
252
+ }>, t.TypeC<{
253
+ type: t.LiteralC<"nudge">;
254
+ value: t.NumberC;
255
+ }>, t.TypeC<{
256
+ type: t.LiteralC<"go_to_step">;
257
+ value: t.NumberC;
258
+ }>, t.IntersectionC<[t.TypeC<{
259
+ type: t.LiteralC<"open_bar">;
260
+ }>, t.PartialC<{
261
+ value: t.StringC;
262
+ categoryFilter: t.NumberC;
263
+ }>]>, t.TypeC<{
264
+ type: t.LiteralC<"open_helphub">;
265
+ }>, t.TypeC<{
266
+ type: t.LiteralC<"open_copilot">;
267
+ }>]>;
268
+ }>>;
60
269
  }>, t.NullC]>;
61
270
  }>;
62
271
  export declare const NudgeContentSurveyTextBlockV: t.TypeC<{
63
272
  type: t.LiteralC<"survey_text">;
64
- meta: t.TypeC<{
273
+ meta: t.IntersectionC<[t.TypeC<{
65
274
  prompt: t.StringC;
66
- }>;
275
+ }>, t.PartialC<{
276
+ validation: t.PartialC<{
277
+ required: t.UnionC<[t.TypeC<{
278
+ value: t.LiteralC<true>;
279
+ message: t.StringC;
280
+ }>, t.TypeC<{
281
+ value: t.LiteralC<false>;
282
+ message: t.NullC;
283
+ }>]>;
284
+ }>;
285
+ }>]>;
286
+ sort_key: t.UnionC<[t.NumberC, t.UndefinedC]>;
287
+ }>;
288
+ export declare const NudgeStepContentSurveyTextShortBlockTypeV: t.TypeC<{
289
+ type: t.LiteralC<"survey_text_short">;
290
+ meta: t.IntersectionC<[t.TypeC<{
291
+ prompt: t.StringC;
292
+ }>, t.PartialC<{
293
+ validation: t.PartialC<{
294
+ required: t.UnionC<[t.TypeC<{
295
+ value: t.LiteralC<true>;
296
+ message: t.StringC;
297
+ }>, t.TypeC<{
298
+ value: t.LiteralC<false>;
299
+ message: t.NullC;
300
+ }>]>;
301
+ }>;
302
+ }>]>;
303
+ sort_key: t.UnionC<[t.NumberC, t.UndefinedC]>;
67
304
  }>;
68
305
  export declare const NudgeContentSurveyRatingBlockV: t.TypeC<{
69
306
  type: t.LiteralC<"survey_rating">;
70
- meta: t.UnionC<[t.TypeC<{
307
+ sort_key: t.UnionC<[t.NumberC, t.UndefinedC]>;
308
+ meta: t.IntersectionC<[t.UnionC<[t.TypeC<{
71
309
  type: t.LiteralC<"emojis">;
72
310
  lower_label: t.StringC;
73
311
  upper_label: t.StringC;
@@ -83,15 +321,27 @@ export declare const NudgeContentSurveyRatingBlockV: t.TypeC<{
83
321
  lower_label: t.StringC;
84
322
  upper_label: t.StringC;
85
323
  options: t.NumberC;
324
+ }>]>, t.PartialC<{
325
+ validation: t.PartialC<{
326
+ required: t.UnionC<[t.TypeC<{
327
+ value: t.LiteralC<true>;
328
+ message: t.StringC;
329
+ }>, t.TypeC<{
330
+ value: t.LiteralC<false>;
331
+ message: t.NullC;
332
+ }>]>;
333
+ }>;
86
334
  }>]>;
87
335
  }>;
88
336
  export declare const NudgeContentBlockV: t.UnionC<[t.TypeC<{
89
337
  type: t.LiteralC<"markdown">;
338
+ sort_key: t.UnionC<[t.NumberC, t.UndefinedC]>;
90
339
  meta: t.TypeC<{
91
340
  value: t.StringC;
92
341
  }>;
93
342
  }>, t.TypeC<{
94
343
  type: t.LiteralC<"image">;
344
+ sort_key: t.UnionC<[t.NumberC, t.UndefinedC]>;
95
345
  meta: t.TypeC<{
96
346
  src: t.StringC;
97
347
  file_name: t.StringC;
@@ -99,6 +349,7 @@ export declare const NudgeContentBlockV: t.UnionC<[t.TypeC<{
99
349
  }>;
100
350
  }>, t.TypeC<{
101
351
  type: t.LiteralC<"video">;
352
+ sort_key: t.UnionC<[t.NumberC, t.UndefinedC]>;
102
353
  meta: t.UnionC<[t.TypeC<{
103
354
  type: t.LiteralC<"url">;
104
355
  src: t.StringC;
@@ -108,23 +359,30 @@ export declare const NudgeContentBlockV: t.UnionC<[t.TypeC<{
108
359
  }>]>;
109
360
  }>, t.TypeC<{
110
361
  type: t.LiteralC<"help_doc_command">;
362
+ sort_key: t.UnionC<[t.NumberC, t.UndefinedC]>;
111
363
  meta: t.TypeC<{
112
364
  command: t.StringC;
113
365
  }>;
114
366
  }>, t.TypeC<{
115
367
  type: t.LiteralC<"button">;
368
+ sort_key: t.UnionC<[t.NumberC, t.UndefinedC]>;
116
369
  meta: t.UnionC<[t.PartialC<{
117
370
  label: t.StringC;
118
371
  action: t.UnionC<[t.TypeC<{
119
372
  type: t.LiteralC<"execute_command">;
120
- meta: t.TypeC<{
373
+ meta: t.IntersectionC<[t.TypeC<{
121
374
  command: t.StringC;
122
- }>;
375
+ }>, t.PartialC<{
376
+ type: t.UnionC<[t.LiteralC<"action">, t.LiteralC<"link">, t.LiteralC<"helpdoc">, t.LiteralC<"video">]>;
377
+ }>]>;
123
378
  }>, t.TypeC<{
124
379
  type: t.LiteralC<"no_action">;
125
380
  }>, t.TypeC<{
126
381
  type: t.LiteralC<"click">;
127
382
  value: t.StringC;
383
+ }>, t.TypeC<{
384
+ type: t.UnionC<[t.LiteralC<"click">, t.LiteralC<"clickBySelector">, t.LiteralC<"clickByXpath">]>;
385
+ value: t.ArrayC<t.StringC>;
128
386
  }>, t.IntersectionC<[t.TypeC<{
129
387
  type: t.LiteralC<"link">;
130
388
  value: t.StringC;
@@ -133,21 +391,125 @@ export declare const NudgeContentBlockV: t.UnionC<[t.TypeC<{
133
391
  }>]>, t.TypeC<{
134
392
  type: t.LiteralC<"open_chat">;
135
393
  meta: t.TypeC<{
136
- type: t.StringC;
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<"">]>;
137
395
  }>;
138
396
  }>, t.TypeC<{
139
397
  type: t.LiteralC<"dismiss">;
398
+ }>, t.TypeC<{
399
+ type: t.LiteralC<"snooze">;
400
+ }>, t.TypeC<{
401
+ type: t.LiteralC<"questlist">;
402
+ value: t.NumberC;
403
+ }>, t.TypeC<{
404
+ type: t.LiteralC<"step_back">;
405
+ }>, t.TypeC<{
406
+ type: t.LiteralC<"nudge">;
407
+ value: t.NumberC;
408
+ }>, t.TypeC<{
409
+ type: t.LiteralC<"go_to_step">;
410
+ value: t.NumberC;
411
+ }>, t.IntersectionC<[t.TypeC<{
412
+ type: t.LiteralC<"open_bar">;
413
+ }>, t.PartialC<{
414
+ value: t.StringC;
415
+ categoryFilter: t.NumberC;
416
+ }>]>, t.TypeC<{
417
+ type: t.LiteralC<"open_helphub">;
418
+ }>, t.TypeC<{
419
+ type: t.LiteralC<"open_copilot">;
140
420
  }>]>;
141
- button_type: t.UnionC<[t.LiteralC<"primary">, t.LiteralC<"secondary">]>;
421
+ button_type: t.UnionC<[t.LiteralC<"primary">, t.LiteralC<"secondary">, t.LiteralC<"snooze">]>;
422
+ conditional_actions: t.ArrayC<t.TypeC<{
423
+ operator: t.UnionC<[t.LiteralC<"eq">, t.LiteralC<"neq">, t.LiteralC<"gt">, t.LiteralC<"lt">]>;
424
+ operand: t.UnionC<[t.StringC, t.NumberC]>;
425
+ action: t.UnionC<[t.TypeC<{
426
+ type: t.LiteralC<"execute_command">;
427
+ meta: t.IntersectionC<[t.TypeC<{
428
+ command: t.StringC;
429
+ }>, t.PartialC<{
430
+ type: t.UnionC<[t.LiteralC<"action">, t.LiteralC<"link">, t.LiteralC<"helpdoc">, t.LiteralC<"video">]>;
431
+ }>]>;
432
+ }>, t.TypeC<{
433
+ type: t.LiteralC<"no_action">;
434
+ }>, t.TypeC<{
435
+ type: t.LiteralC<"click">;
436
+ value: t.StringC;
437
+ }>, t.TypeC<{
438
+ type: t.UnionC<[t.LiteralC<"click">, t.LiteralC<"clickBySelector">, t.LiteralC<"clickByXpath">]>;
439
+ value: t.ArrayC<t.StringC>;
440
+ }>, t.IntersectionC<[t.TypeC<{
441
+ type: t.LiteralC<"link">;
442
+ value: t.StringC;
443
+ }>, t.PartialC<{
444
+ operation: t.UnionC<[t.LiteralC<"router">, t.LiteralC<"self">, t.LiteralC<"blank">, t.UndefinedC]>;
445
+ }>]>, t.TypeC<{
446
+ type: t.LiteralC<"open_chat">;
447
+ 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<"">]>;
449
+ }>;
450
+ }>, t.TypeC<{
451
+ type: t.LiteralC<"dismiss">;
452
+ }>, t.TypeC<{
453
+ type: t.LiteralC<"snooze">;
454
+ }>, t.TypeC<{
455
+ type: t.LiteralC<"questlist">;
456
+ value: t.NumberC;
457
+ }>, t.TypeC<{
458
+ type: t.LiteralC<"step_back">;
459
+ }>, t.TypeC<{
460
+ type: t.LiteralC<"nudge">;
461
+ value: t.NumberC;
462
+ }>, t.TypeC<{
463
+ type: t.LiteralC<"go_to_step">;
464
+ value: t.NumberC;
465
+ }>, t.IntersectionC<[t.TypeC<{
466
+ type: t.LiteralC<"open_bar">;
467
+ }>, t.PartialC<{
468
+ value: t.StringC;
469
+ categoryFilter: t.NumberC;
470
+ }>]>, t.TypeC<{
471
+ type: t.LiteralC<"open_helphub">;
472
+ }>, t.TypeC<{
473
+ type: t.LiteralC<"open_copilot">;
474
+ }>]>;
475
+ }>>;
142
476
  }>, t.NullC]>;
143
477
  }>, t.TypeC<{
144
478
  type: t.LiteralC<"survey_text">;
145
- meta: t.TypeC<{
479
+ meta: t.IntersectionC<[t.TypeC<{
146
480
  prompt: t.StringC;
147
- }>;
481
+ }>, t.PartialC<{
482
+ validation: t.PartialC<{
483
+ required: t.UnionC<[t.TypeC<{
484
+ value: t.LiteralC<true>;
485
+ message: t.StringC;
486
+ }>, t.TypeC<{
487
+ value: t.LiteralC<false>;
488
+ message: t.NullC;
489
+ }>]>;
490
+ }>;
491
+ }>]>;
492
+ sort_key: t.UnionC<[t.NumberC, t.UndefinedC]>;
493
+ }>, t.TypeC<{
494
+ type: t.LiteralC<"survey_text_short">;
495
+ meta: t.IntersectionC<[t.TypeC<{
496
+ prompt: t.StringC;
497
+ }>, t.PartialC<{
498
+ validation: t.PartialC<{
499
+ required: t.UnionC<[t.TypeC<{
500
+ value: t.LiteralC<true>;
501
+ message: t.StringC;
502
+ }>, t.TypeC<{
503
+ value: t.LiteralC<false>;
504
+ message: t.NullC;
505
+ }>]>;
506
+ }>;
507
+ }>]>;
508
+ sort_key: t.UnionC<[t.NumberC, t.UndefinedC]>;
148
509
  }>, t.TypeC<{
149
510
  type: t.LiteralC<"survey_rating">;
150
- meta: t.UnionC<[t.TypeC<{
511
+ sort_key: t.UnionC<[t.NumberC, t.UndefinedC]>;
512
+ meta: t.IntersectionC<[t.UnionC<[t.TypeC<{
151
513
  type: t.LiteralC<"emojis">;
152
514
  lower_label: t.StringC;
153
515
  upper_label: t.StringC;
@@ -163,6 +525,34 @@ export declare const NudgeContentBlockV: t.UnionC<[t.TypeC<{
163
525
  lower_label: t.StringC;
164
526
  upper_label: t.StringC;
165
527
  options: t.NumberC;
528
+ }>]>, t.PartialC<{
529
+ validation: t.PartialC<{
530
+ required: t.UnionC<[t.TypeC<{
531
+ value: t.LiteralC<true>;
532
+ message: t.StringC;
533
+ }>, t.TypeC<{
534
+ value: t.LiteralC<false>;
535
+ message: t.NullC;
536
+ }>]>;
537
+ }>;
538
+ }>]>;
539
+ }>, t.TypeC<{
540
+ type: t.LiteralC<"survey_list">;
541
+ sort_key: t.UnionC<[t.NumberC, t.UndefinedC]>;
542
+ meta: t.IntersectionC<[t.TypeC<{
543
+ options: t.ArrayC<t.StringC>;
544
+ list_type: t.UnionC<[t.LiteralC<"single">, t.LiteralC<"multiple">]>;
545
+ display_type: t.UnionC<[t.LiteralC<"dropdown">, t.LiteralC<"list">, t.LiteralC<"grid">]>;
546
+ }>, t.PartialC<{
547
+ validation: t.PartialC<{
548
+ required: t.UnionC<[t.TypeC<{
549
+ value: t.LiteralC<true>;
550
+ message: t.StringC;
551
+ }>, t.TypeC<{
552
+ value: t.LiteralC<false>;
553
+ message: t.NullC;
554
+ }>]>;
555
+ }>;
166
556
  }>]>;
167
557
  }>]>;
168
558
  export declare const NudgeStepV: t.IntersectionC<[t.TypeC<{
@@ -170,11 +560,13 @@ export declare const NudgeStepV: t.IntersectionC<[t.TypeC<{
170
560
  title: t.StringC;
171
561
  content: t.ArrayC<t.UnionC<[t.TypeC<{
172
562
  type: t.LiteralC<"markdown">;
563
+ sort_key: t.UnionC<[t.NumberC, t.UndefinedC]>;
173
564
  meta: t.TypeC<{
174
565
  value: t.StringC;
175
566
  }>;
176
567
  }>, t.TypeC<{
177
568
  type: t.LiteralC<"image">;
569
+ sort_key: t.UnionC<[t.NumberC, t.UndefinedC]>;
178
570
  meta: t.TypeC<{
179
571
  src: t.StringC;
180
572
  file_name: t.StringC;
@@ -182,6 +574,7 @@ export declare const NudgeStepV: t.IntersectionC<[t.TypeC<{
182
574
  }>;
183
575
  }>, t.TypeC<{
184
576
  type: t.LiteralC<"video">;
577
+ sort_key: t.UnionC<[t.NumberC, t.UndefinedC]>;
185
578
  meta: t.UnionC<[t.TypeC<{
186
579
  type: t.LiteralC<"url">;
187
580
  src: t.StringC;
@@ -191,23 +584,30 @@ export declare const NudgeStepV: t.IntersectionC<[t.TypeC<{
191
584
  }>]>;
192
585
  }>, t.TypeC<{
193
586
  type: t.LiteralC<"help_doc_command">;
587
+ sort_key: t.UnionC<[t.NumberC, t.UndefinedC]>;
194
588
  meta: t.TypeC<{
195
589
  command: t.StringC;
196
590
  }>;
197
591
  }>, t.TypeC<{
198
592
  type: t.LiteralC<"button">;
593
+ sort_key: t.UnionC<[t.NumberC, t.UndefinedC]>;
199
594
  meta: t.UnionC<[t.PartialC<{
200
595
  label: t.StringC;
201
596
  action: t.UnionC<[t.TypeC<{
202
597
  type: t.LiteralC<"execute_command">;
203
- meta: t.TypeC<{
598
+ meta: t.IntersectionC<[t.TypeC<{
204
599
  command: t.StringC;
205
- }>;
600
+ }>, t.PartialC<{
601
+ type: t.UnionC<[t.LiteralC<"action">, t.LiteralC<"link">, t.LiteralC<"helpdoc">, t.LiteralC<"video">]>;
602
+ }>]>;
206
603
  }>, t.TypeC<{
207
604
  type: t.LiteralC<"no_action">;
208
605
  }>, t.TypeC<{
209
606
  type: t.LiteralC<"click">;
210
607
  value: t.StringC;
608
+ }>, t.TypeC<{
609
+ type: t.UnionC<[t.LiteralC<"click">, t.LiteralC<"clickBySelector">, t.LiteralC<"clickByXpath">]>;
610
+ value: t.ArrayC<t.StringC>;
211
611
  }>, t.IntersectionC<[t.TypeC<{
212
612
  type: t.LiteralC<"link">;
213
613
  value: t.StringC;
@@ -216,21 +616,125 @@ export declare const NudgeStepV: t.IntersectionC<[t.TypeC<{
216
616
  }>]>, t.TypeC<{
217
617
  type: t.LiteralC<"open_chat">;
218
618
  meta: t.TypeC<{
219
- type: t.StringC;
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<"">]>;
220
620
  }>;
221
621
  }>, t.TypeC<{
222
622
  type: t.LiteralC<"dismiss">;
623
+ }>, t.TypeC<{
624
+ type: t.LiteralC<"snooze">;
625
+ }>, t.TypeC<{
626
+ type: t.LiteralC<"questlist">;
627
+ value: t.NumberC;
628
+ }>, t.TypeC<{
629
+ type: t.LiteralC<"step_back">;
630
+ }>, t.TypeC<{
631
+ type: t.LiteralC<"nudge">;
632
+ value: t.NumberC;
633
+ }>, t.TypeC<{
634
+ type: t.LiteralC<"go_to_step">;
635
+ value: t.NumberC;
636
+ }>, t.IntersectionC<[t.TypeC<{
637
+ type: t.LiteralC<"open_bar">;
638
+ }>, t.PartialC<{
639
+ value: t.StringC;
640
+ categoryFilter: t.NumberC;
641
+ }>]>, t.TypeC<{
642
+ type: t.LiteralC<"open_helphub">;
643
+ }>, t.TypeC<{
644
+ type: t.LiteralC<"open_copilot">;
223
645
  }>]>;
224
- button_type: t.UnionC<[t.LiteralC<"primary">, t.LiteralC<"secondary">]>;
646
+ button_type: t.UnionC<[t.LiteralC<"primary">, t.LiteralC<"secondary">, t.LiteralC<"snooze">]>;
647
+ conditional_actions: t.ArrayC<t.TypeC<{
648
+ operator: t.UnionC<[t.LiteralC<"eq">, t.LiteralC<"neq">, t.LiteralC<"gt">, t.LiteralC<"lt">]>;
649
+ operand: t.UnionC<[t.StringC, t.NumberC]>;
650
+ action: t.UnionC<[t.TypeC<{
651
+ type: t.LiteralC<"execute_command">;
652
+ meta: t.IntersectionC<[t.TypeC<{
653
+ command: t.StringC;
654
+ }>, t.PartialC<{
655
+ type: t.UnionC<[t.LiteralC<"action">, t.LiteralC<"link">, t.LiteralC<"helpdoc">, t.LiteralC<"video">]>;
656
+ }>]>;
657
+ }>, t.TypeC<{
658
+ type: t.LiteralC<"no_action">;
659
+ }>, t.TypeC<{
660
+ type: t.LiteralC<"click">;
661
+ value: t.StringC;
662
+ }>, t.TypeC<{
663
+ type: t.UnionC<[t.LiteralC<"click">, t.LiteralC<"clickBySelector">, t.LiteralC<"clickByXpath">]>;
664
+ value: t.ArrayC<t.StringC>;
665
+ }>, t.IntersectionC<[t.TypeC<{
666
+ type: t.LiteralC<"link">;
667
+ value: t.StringC;
668
+ }>, t.PartialC<{
669
+ operation: t.UnionC<[t.LiteralC<"router">, t.LiteralC<"self">, t.LiteralC<"blank">, t.UndefinedC]>;
670
+ }>]>, t.TypeC<{
671
+ type: t.LiteralC<"open_chat">;
672
+ 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<"">]>;
674
+ }>;
675
+ }>, t.TypeC<{
676
+ type: t.LiteralC<"dismiss">;
677
+ }>, t.TypeC<{
678
+ type: t.LiteralC<"snooze">;
679
+ }>, t.TypeC<{
680
+ type: t.LiteralC<"questlist">;
681
+ value: t.NumberC;
682
+ }>, t.TypeC<{
683
+ type: t.LiteralC<"step_back">;
684
+ }>, t.TypeC<{
685
+ type: t.LiteralC<"nudge">;
686
+ value: t.NumberC;
687
+ }>, t.TypeC<{
688
+ type: t.LiteralC<"go_to_step">;
689
+ value: t.NumberC;
690
+ }>, t.IntersectionC<[t.TypeC<{
691
+ type: t.LiteralC<"open_bar">;
692
+ }>, t.PartialC<{
693
+ value: t.StringC;
694
+ categoryFilter: t.NumberC;
695
+ }>]>, t.TypeC<{
696
+ type: t.LiteralC<"open_helphub">;
697
+ }>, t.TypeC<{
698
+ type: t.LiteralC<"open_copilot">;
699
+ }>]>;
700
+ }>>;
225
701
  }>, t.NullC]>;
226
702
  }>, t.TypeC<{
227
703
  type: t.LiteralC<"survey_text">;
228
- meta: t.TypeC<{
704
+ meta: t.IntersectionC<[t.TypeC<{
229
705
  prompt: t.StringC;
230
- }>;
706
+ }>, t.PartialC<{
707
+ validation: t.PartialC<{
708
+ required: t.UnionC<[t.TypeC<{
709
+ value: t.LiteralC<true>;
710
+ message: t.StringC;
711
+ }>, t.TypeC<{
712
+ value: t.LiteralC<false>;
713
+ message: t.NullC;
714
+ }>]>;
715
+ }>;
716
+ }>]>;
717
+ sort_key: t.UnionC<[t.NumberC, t.UndefinedC]>;
718
+ }>, t.TypeC<{
719
+ type: t.LiteralC<"survey_text_short">;
720
+ meta: t.IntersectionC<[t.TypeC<{
721
+ prompt: t.StringC;
722
+ }>, t.PartialC<{
723
+ validation: t.PartialC<{
724
+ required: t.UnionC<[t.TypeC<{
725
+ value: t.LiteralC<true>;
726
+ message: t.StringC;
727
+ }>, t.TypeC<{
728
+ value: t.LiteralC<false>;
729
+ message: t.NullC;
730
+ }>]>;
731
+ }>;
732
+ }>]>;
733
+ sort_key: t.UnionC<[t.NumberC, t.UndefinedC]>;
231
734
  }>, t.TypeC<{
232
735
  type: t.LiteralC<"survey_rating">;
233
- meta: t.UnionC<[t.TypeC<{
736
+ sort_key: t.UnionC<[t.NumberC, t.UndefinedC]>;
737
+ meta: t.IntersectionC<[t.UnionC<[t.TypeC<{
234
738
  type: t.LiteralC<"emojis">;
235
739
  lower_label: t.StringC;
236
740
  upper_label: t.StringC;
@@ -246,6 +750,34 @@ export declare const NudgeStepV: t.IntersectionC<[t.TypeC<{
246
750
  lower_label: t.StringC;
247
751
  upper_label: t.StringC;
248
752
  options: t.NumberC;
753
+ }>]>, t.PartialC<{
754
+ validation: t.PartialC<{
755
+ required: t.UnionC<[t.TypeC<{
756
+ value: t.LiteralC<true>;
757
+ message: t.StringC;
758
+ }>, t.TypeC<{
759
+ value: t.LiteralC<false>;
760
+ message: t.NullC;
761
+ }>]>;
762
+ }>;
763
+ }>]>;
764
+ }>, t.TypeC<{
765
+ type: t.LiteralC<"survey_list">;
766
+ sort_key: t.UnionC<[t.NumberC, t.UndefinedC]>;
767
+ meta: t.IntersectionC<[t.TypeC<{
768
+ options: t.ArrayC<t.StringC>;
769
+ list_type: t.UnionC<[t.LiteralC<"single">, t.LiteralC<"multiple">]>;
770
+ display_type: t.UnionC<[t.LiteralC<"dropdown">, t.LiteralC<"list">, t.LiteralC<"grid">]>;
771
+ }>, t.PartialC<{
772
+ validation: t.PartialC<{
773
+ required: t.UnionC<[t.TypeC<{
774
+ value: t.LiteralC<true>;
775
+ message: t.StringC;
776
+ }>, t.TypeC<{
777
+ value: t.LiteralC<false>;
778
+ message: t.NullC;
779
+ }>]>;
780
+ }>;
249
781
  }>]>;
250
782
  }>]>>;
251
783
  is_live: t.BooleanC;
@@ -260,11 +792,34 @@ export declare const NudgeStepV: t.IntersectionC<[t.TypeC<{
260
792
  anchor: t.StringC;
261
793
  }>, t.PartialC<{
262
794
  is_open_by_default: t.BooleanC;
795
+ is_showing_mask: t.BooleanC;
796
+ advance_trigger: t.StringC;
263
797
  offset: t.TypeC<{
264
798
  x: t.StringC;
265
799
  y: t.StringC;
266
800
  }>;
267
- }>]>]>;
801
+ }>]>, t.TypeC<{
802
+ type: t.LiteralC<"tooltip">;
803
+ anchor: t.StringC;
804
+ show_on: t.UnionC<[t.LiteralC<"hover">, t.LiteralC<"click">]>;
805
+ marker: t.IntersectionC<[t.UnionC<[t.TypeC<{
806
+ type: t.LiteralC<"beacon">;
807
+ }>, t.TypeC<{
808
+ type: t.LiteralC<"icon">;
809
+ icon: t.UnionC<[t.LiteralC<"helpCircle">, t.LiteralC<"helpSquare">, t.LiteralC<"infoCircle">, t.LiteralC<"bookClosed">, t.LiteralC<"lightBulb">, t.LiteralC<"lightning">]>;
810
+ }>, t.TypeC<{
811
+ type: t.LiteralC<"image">;
812
+ source: t.StringC;
813
+ }>]>, t.TypeC<{
814
+ positioning: t.TypeC<{
815
+ position: t.UnionC<[t.LiteralC<"left">, t.LiteralC<"right">, t.LiteralC<"inline_left">, t.LiteralC<"inline_right">]>;
816
+ offset: t.TypeC<{
817
+ x: t.StringC;
818
+ y: t.StringC;
819
+ }>;
820
+ }>;
821
+ }>]>;
822
+ }>]>;
268
823
  }>, t.PartialC<{
269
824
  has_survey_response: t.BooleanC;
270
825
  }>]>]>;
@@ -289,14 +844,33 @@ export declare const NudgeV: t.IntersectionC<[t.IntersectionC<[t.TypeC<{
289
844
  type: t.LiteralC<"on_event">;
290
845
  meta: t.TypeC<{
291
846
  event: t.StringC;
847
+ condition_group: t.UnionC<[t.Type<import("./helpers/rules").RuleExpression, import("./helpers/rules").RuleExpression, unknown>, t.NullC, t.UndefinedC]>;
292
848
  }>;
293
849
  }>, t.TypeC<{
294
850
  type: t.LiteralC<"when_element_appears">;
295
851
  meta: t.TypeC<{
296
852
  selector: t.StringC;
297
853
  }>;
854
+ }>, t.TypeC<{
855
+ type: t.LiteralC<"on_user_confusion">;
856
+ }>, t.TypeC<{
857
+ type: t.LiteralC<"on_rage_click">;
858
+ }>, t.TypeC<{
859
+ type: t.LiteralC<"smart_delay">;
860
+ }>, t.TypeC<{
861
+ type: t.LiteralC<"after_time">;
862
+ meta: t.TypeC<{
863
+ unit: t.UnionC<[t.LiteralC<"minute">, t.LiteralC<"second">]>;
864
+ value: t.NumberC;
865
+ }>;
298
866
  }>, t.TypeC<{
299
867
  type: t.LiteralC<"when_share_link_viewed">;
868
+ }>, t.TypeC<{
869
+ type: t.LiteralC<"scheduled">;
870
+ meta: t.TypeC<{
871
+ interval: t.UnionC<[t.LiteralC<"day">, t.LiteralC<"week">, t.LiteralC<"month">]>;
872
+ value: t.NumberC;
873
+ }>;
300
874
  }>]>;
301
875
  frequency_limit: t.UnionC<[t.LiteralC<"no_limit">, t.LiteralC<"once_per_session">, t.LiteralC<"once_per_user">, t.LiteralC<"until_interaction">]>;
302
876
  steps: t.ArrayC<t.IntersectionC<[t.TypeC<{
@@ -304,11 +878,13 @@ export declare const NudgeV: t.IntersectionC<[t.IntersectionC<[t.TypeC<{
304
878
  title: t.StringC;
305
879
  content: t.ArrayC<t.UnionC<[t.TypeC<{
306
880
  type: t.LiteralC<"markdown">;
881
+ sort_key: t.UnionC<[t.NumberC, t.UndefinedC]>;
307
882
  meta: t.TypeC<{
308
883
  value: t.StringC;
309
884
  }>;
310
885
  }>, t.TypeC<{
311
886
  type: t.LiteralC<"image">;
887
+ sort_key: t.UnionC<[t.NumberC, t.UndefinedC]>;
312
888
  meta: t.TypeC<{
313
889
  src: t.StringC;
314
890
  file_name: t.StringC;
@@ -316,6 +892,7 @@ export declare const NudgeV: t.IntersectionC<[t.IntersectionC<[t.TypeC<{
316
892
  }>;
317
893
  }>, t.TypeC<{
318
894
  type: t.LiteralC<"video">;
895
+ sort_key: t.UnionC<[t.NumberC, t.UndefinedC]>;
319
896
  meta: t.UnionC<[t.TypeC<{
320
897
  type: t.LiteralC<"url">;
321
898
  src: t.StringC;
@@ -325,23 +902,30 @@ export declare const NudgeV: t.IntersectionC<[t.IntersectionC<[t.TypeC<{
325
902
  }>]>;
326
903
  }>, t.TypeC<{
327
904
  type: t.LiteralC<"help_doc_command">;
905
+ sort_key: t.UnionC<[t.NumberC, t.UndefinedC]>;
328
906
  meta: t.TypeC<{
329
907
  command: t.StringC;
330
908
  }>;
331
909
  }>, t.TypeC<{
332
910
  type: t.LiteralC<"button">;
911
+ sort_key: t.UnionC<[t.NumberC, t.UndefinedC]>;
333
912
  meta: t.UnionC<[t.PartialC<{
334
913
  label: t.StringC;
335
914
  action: t.UnionC<[t.TypeC<{
336
915
  type: t.LiteralC<"execute_command">;
337
- meta: t.TypeC<{
916
+ meta: t.IntersectionC<[t.TypeC<{
338
917
  command: t.StringC;
339
- }>;
918
+ }>, t.PartialC<{
919
+ type: t.UnionC<[t.LiteralC<"action">, t.LiteralC<"link">, t.LiteralC<"helpdoc">, t.LiteralC<"video">]>;
920
+ }>]>;
340
921
  }>, t.TypeC<{
341
922
  type: t.LiteralC<"no_action">;
342
923
  }>, t.TypeC<{
343
924
  type: t.LiteralC<"click">;
344
925
  value: t.StringC;
926
+ }>, t.TypeC<{
927
+ type: t.UnionC<[t.LiteralC<"click">, t.LiteralC<"clickBySelector">, t.LiteralC<"clickByXpath">]>;
928
+ value: t.ArrayC<t.StringC>;
345
929
  }>, t.IntersectionC<[t.TypeC<{
346
930
  type: t.LiteralC<"link">;
347
931
  value: t.StringC;
@@ -350,21 +934,125 @@ export declare const NudgeV: t.IntersectionC<[t.IntersectionC<[t.TypeC<{
350
934
  }>]>, t.TypeC<{
351
935
  type: t.LiteralC<"open_chat">;
352
936
  meta: t.TypeC<{
353
- type: t.StringC;
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<"">]>;
354
938
  }>;
355
939
  }>, t.TypeC<{
356
940
  type: t.LiteralC<"dismiss">;
941
+ }>, t.TypeC<{
942
+ type: t.LiteralC<"snooze">;
943
+ }>, t.TypeC<{
944
+ type: t.LiteralC<"questlist">;
945
+ value: t.NumberC;
946
+ }>, t.TypeC<{
947
+ type: t.LiteralC<"step_back">;
948
+ }>, t.TypeC<{
949
+ type: t.LiteralC<"nudge">;
950
+ value: t.NumberC;
951
+ }>, t.TypeC<{
952
+ type: t.LiteralC<"go_to_step">;
953
+ value: t.NumberC;
954
+ }>, t.IntersectionC<[t.TypeC<{
955
+ type: t.LiteralC<"open_bar">;
956
+ }>, t.PartialC<{
957
+ value: t.StringC;
958
+ categoryFilter: t.NumberC;
959
+ }>]>, t.TypeC<{
960
+ type: t.LiteralC<"open_helphub">;
961
+ }>, t.TypeC<{
962
+ type: t.LiteralC<"open_copilot">;
357
963
  }>]>;
358
- button_type: t.UnionC<[t.LiteralC<"primary">, t.LiteralC<"secondary">]>;
964
+ button_type: t.UnionC<[t.LiteralC<"primary">, t.LiteralC<"secondary">, t.LiteralC<"snooze">]>;
965
+ conditional_actions: t.ArrayC<t.TypeC<{
966
+ operator: t.UnionC<[t.LiteralC<"eq">, t.LiteralC<"neq">, t.LiteralC<"gt">, t.LiteralC<"lt">]>;
967
+ operand: t.UnionC<[t.StringC, t.NumberC]>;
968
+ action: t.UnionC<[t.TypeC<{
969
+ type: t.LiteralC<"execute_command">;
970
+ meta: t.IntersectionC<[t.TypeC<{
971
+ command: t.StringC;
972
+ }>, t.PartialC<{
973
+ type: t.UnionC<[t.LiteralC<"action">, t.LiteralC<"link">, t.LiteralC<"helpdoc">, t.LiteralC<"video">]>;
974
+ }>]>;
975
+ }>, t.TypeC<{
976
+ type: t.LiteralC<"no_action">;
977
+ }>, t.TypeC<{
978
+ type: t.LiteralC<"click">;
979
+ value: t.StringC;
980
+ }>, t.TypeC<{
981
+ type: t.UnionC<[t.LiteralC<"click">, t.LiteralC<"clickBySelector">, t.LiteralC<"clickByXpath">]>;
982
+ value: t.ArrayC<t.StringC>;
983
+ }>, t.IntersectionC<[t.TypeC<{
984
+ type: t.LiteralC<"link">;
985
+ value: t.StringC;
986
+ }>, t.PartialC<{
987
+ operation: t.UnionC<[t.LiteralC<"router">, t.LiteralC<"self">, t.LiteralC<"blank">, t.UndefinedC]>;
988
+ }>]>, t.TypeC<{
989
+ type: t.LiteralC<"open_chat">;
990
+ 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<"">]>;
992
+ }>;
993
+ }>, t.TypeC<{
994
+ type: t.LiteralC<"dismiss">;
995
+ }>, t.TypeC<{
996
+ type: t.LiteralC<"snooze">;
997
+ }>, t.TypeC<{
998
+ type: t.LiteralC<"questlist">;
999
+ value: t.NumberC;
1000
+ }>, t.TypeC<{
1001
+ type: t.LiteralC<"step_back">;
1002
+ }>, t.TypeC<{
1003
+ type: t.LiteralC<"nudge">;
1004
+ value: t.NumberC;
1005
+ }>, t.TypeC<{
1006
+ type: t.LiteralC<"go_to_step">;
1007
+ value: t.NumberC;
1008
+ }>, t.IntersectionC<[t.TypeC<{
1009
+ type: t.LiteralC<"open_bar">;
1010
+ }>, t.PartialC<{
1011
+ value: t.StringC;
1012
+ categoryFilter: t.NumberC;
1013
+ }>]>, t.TypeC<{
1014
+ type: t.LiteralC<"open_helphub">;
1015
+ }>, t.TypeC<{
1016
+ type: t.LiteralC<"open_copilot">;
1017
+ }>]>;
1018
+ }>>;
359
1019
  }>, t.NullC]>;
360
1020
  }>, t.TypeC<{
361
1021
  type: t.LiteralC<"survey_text">;
362
- meta: t.TypeC<{
1022
+ meta: t.IntersectionC<[t.TypeC<{
363
1023
  prompt: t.StringC;
364
- }>;
1024
+ }>, t.PartialC<{
1025
+ validation: t.PartialC<{
1026
+ required: t.UnionC<[t.TypeC<{
1027
+ value: t.LiteralC<true>;
1028
+ message: t.StringC;
1029
+ }>, t.TypeC<{
1030
+ value: t.LiteralC<false>;
1031
+ message: t.NullC;
1032
+ }>]>;
1033
+ }>;
1034
+ }>]>;
1035
+ sort_key: t.UnionC<[t.NumberC, t.UndefinedC]>;
1036
+ }>, t.TypeC<{
1037
+ type: t.LiteralC<"survey_text_short">;
1038
+ meta: t.IntersectionC<[t.TypeC<{
1039
+ prompt: t.StringC;
1040
+ }>, t.PartialC<{
1041
+ validation: t.PartialC<{
1042
+ required: t.UnionC<[t.TypeC<{
1043
+ value: t.LiteralC<true>;
1044
+ message: t.StringC;
1045
+ }>, t.TypeC<{
1046
+ value: t.LiteralC<false>;
1047
+ message: t.NullC;
1048
+ }>]>;
1049
+ }>;
1050
+ }>]>;
1051
+ sort_key: t.UnionC<[t.NumberC, t.UndefinedC]>;
365
1052
  }>, t.TypeC<{
366
1053
  type: t.LiteralC<"survey_rating">;
367
- meta: t.UnionC<[t.TypeC<{
1054
+ sort_key: t.UnionC<[t.NumberC, t.UndefinedC]>;
1055
+ meta: t.IntersectionC<[t.UnionC<[t.TypeC<{
368
1056
  type: t.LiteralC<"emojis">;
369
1057
  lower_label: t.StringC;
370
1058
  upper_label: t.StringC;
@@ -380,6 +1068,34 @@ export declare const NudgeV: t.IntersectionC<[t.IntersectionC<[t.TypeC<{
380
1068
  lower_label: t.StringC;
381
1069
  upper_label: t.StringC;
382
1070
  options: t.NumberC;
1071
+ }>]>, t.PartialC<{
1072
+ validation: t.PartialC<{
1073
+ required: t.UnionC<[t.TypeC<{
1074
+ value: t.LiteralC<true>;
1075
+ message: t.StringC;
1076
+ }>, t.TypeC<{
1077
+ value: t.LiteralC<false>;
1078
+ message: t.NullC;
1079
+ }>]>;
1080
+ }>;
1081
+ }>]>;
1082
+ }>, t.TypeC<{
1083
+ type: t.LiteralC<"survey_list">;
1084
+ sort_key: t.UnionC<[t.NumberC, t.UndefinedC]>;
1085
+ meta: t.IntersectionC<[t.TypeC<{
1086
+ options: t.ArrayC<t.StringC>;
1087
+ list_type: t.UnionC<[t.LiteralC<"single">, t.LiteralC<"multiple">]>;
1088
+ display_type: t.UnionC<[t.LiteralC<"dropdown">, t.LiteralC<"list">, t.LiteralC<"grid">]>;
1089
+ }>, t.PartialC<{
1090
+ validation: t.PartialC<{
1091
+ required: t.UnionC<[t.TypeC<{
1092
+ value: t.LiteralC<true>;
1093
+ message: t.StringC;
1094
+ }>, t.TypeC<{
1095
+ value: t.LiteralC<false>;
1096
+ message: t.NullC;
1097
+ }>]>;
1098
+ }>;
383
1099
  }>]>;
384
1100
  }>]>>;
385
1101
  is_live: t.BooleanC;
@@ -394,11 +1110,34 @@ export declare const NudgeV: t.IntersectionC<[t.IntersectionC<[t.TypeC<{
394
1110
  anchor: t.StringC;
395
1111
  }>, t.PartialC<{
396
1112
  is_open_by_default: t.BooleanC;
1113
+ is_showing_mask: t.BooleanC;
1114
+ advance_trigger: t.StringC;
397
1115
  offset: t.TypeC<{
398
1116
  x: t.StringC;
399
1117
  y: t.StringC;
400
1118
  }>;
401
- }>]>]>;
1119
+ }>]>, t.TypeC<{
1120
+ type: t.LiteralC<"tooltip">;
1121
+ anchor: t.StringC;
1122
+ show_on: t.UnionC<[t.LiteralC<"hover">, t.LiteralC<"click">]>;
1123
+ marker: t.IntersectionC<[t.UnionC<[t.TypeC<{
1124
+ type: t.LiteralC<"beacon">;
1125
+ }>, t.TypeC<{
1126
+ type: t.LiteralC<"icon">;
1127
+ icon: t.UnionC<[t.LiteralC<"helpCircle">, t.LiteralC<"helpSquare">, t.LiteralC<"infoCircle">, t.LiteralC<"bookClosed">, t.LiteralC<"lightBulb">, t.LiteralC<"lightning">]>;
1128
+ }>, t.TypeC<{
1129
+ type: t.LiteralC<"image">;
1130
+ source: t.StringC;
1131
+ }>]>, t.TypeC<{
1132
+ positioning: t.TypeC<{
1133
+ position: t.UnionC<[t.LiteralC<"left">, t.LiteralC<"right">, t.LiteralC<"inline_left">, t.LiteralC<"inline_right">]>;
1134
+ offset: t.TypeC<{
1135
+ x: t.StringC;
1136
+ y: t.StringC;
1137
+ }>;
1138
+ }>;
1139
+ }>]>;
1140
+ }>]>;
402
1141
  }>, t.PartialC<{
403
1142
  has_survey_response: t.BooleanC;
404
1143
  }>]>]>>;
@@ -424,7 +1163,19 @@ export declare const NudgeV: t.IntersectionC<[t.IntersectionC<[t.TypeC<{
424
1163
  template_source: t.StringC;
425
1164
  show_step_counter: t.BooleanC;
426
1165
  dismissible: t.BooleanC;
427
- share_page_url: t.StringC;
1166
+ snoozable: t.BooleanC;
1167
+ share_page_url_or_path: t.StringC;
1168
+ copilot_suggest: t.BooleanC;
1169
+ show_in_spotlight_search: t.BooleanC;
1170
+ show_in_helphub_search: t.BooleanC;
1171
+ copilot_cta_label: t.StringC;
1172
+ copilot_description: t.StringC;
1173
+ is_scheduled: t.BooleanC;
1174
+ scheduled_start_time: t.UnionC<[t.StringC, t.NullC, t.UndefinedC]>;
1175
+ scheduled_end_time: t.UnionC<[t.StringC, t.NullC, t.UndefinedC]>;
1176
+ snooze_label: t.StringC;
1177
+ type: t.UnionC<[t.LiteralC<"announcement">, t.LiteralC<"product_tour">, t.LiteralC<"survey">, t.NullC]>;
1178
+ editor_tags: t.ArrayC<t.StringC>;
428
1179
  }>]>;
429
1180
  export declare const OldNudgeBaseV: t.IntersectionC<[t.TypeC<{
430
1181
  id: t.NumberC;
@@ -443,6 +1194,7 @@ export declare const OldNudgeBaseV: t.IntersectionC<[t.TypeC<{
443
1194
  type: t.LiteralC<"on_event">;
444
1195
  meta: t.TypeC<{
445
1196
  event: t.StringC;
1197
+ condition_group: t.UnionC<[t.Type<import("./helpers/rules").RuleExpression, import("./helpers/rules").RuleExpression, unknown>, t.NullC, t.UndefinedC]>;
446
1198
  }>;
447
1199
  }>, t.TypeC<{
448
1200
  type: t.LiteralC<"when_share_link_viewed">;
@@ -451,9 +1203,11 @@ export declare const OldNudgeBaseV: t.IntersectionC<[t.TypeC<{
451
1203
  type: t.LiteralC<"no_action">;
452
1204
  }>, t.TypeC<{
453
1205
  type: t.LiteralC<"execute_command">;
454
- meta: t.TypeC<{
1206
+ meta: t.IntersectionC<[t.TypeC<{
455
1207
  command: t.StringC;
456
- }>;
1208
+ }>, t.PartialC<{
1209
+ type: t.UnionC<[t.LiteralC<"action">, t.LiteralC<"link">, t.LiteralC<"helpdoc">, t.LiteralC<"video">]>;
1210
+ }>]>;
457
1211
  }>]>;
458
1212
  timeout_ms: t.UnionC<[t.NumberC, t.NullC]>;
459
1213
  frequency_limit: t.UnionC<[t.LiteralC<"no_limit">, t.LiteralC<"once_per_session">, t.LiteralC<"once_per_user">, t.LiteralC<"until_interaction">]>;
@@ -507,6 +1261,7 @@ export declare const OldNudgeV: t.IntersectionC<[t.IntersectionC<[t.TypeC<{
507
1261
  type: t.LiteralC<"on_event">;
508
1262
  meta: t.TypeC<{
509
1263
  event: t.StringC;
1264
+ condition_group: t.UnionC<[t.Type<import("./helpers/rules").RuleExpression, import("./helpers/rules").RuleExpression, unknown>, t.NullC, t.UndefinedC]>;
510
1265
  }>;
511
1266
  }>, t.TypeC<{
512
1267
  type: t.LiteralC<"when_share_link_viewed">;
@@ -515,9 +1270,11 @@ export declare const OldNudgeV: t.IntersectionC<[t.IntersectionC<[t.TypeC<{
515
1270
  type: t.LiteralC<"no_action">;
516
1271
  }>, t.TypeC<{
517
1272
  type: t.LiteralC<"execute_command">;
518
- meta: t.TypeC<{
1273
+ meta: t.IntersectionC<[t.TypeC<{
519
1274
  command: t.StringC;
520
- }>;
1275
+ }>, t.PartialC<{
1276
+ type: t.UnionC<[t.LiteralC<"action">, t.LiteralC<"link">, t.LiteralC<"helpdoc">, t.LiteralC<"video">]>;
1277
+ }>]>;
521
1278
  }>]>;
522
1279
  timeout_ms: t.UnionC<[t.NumberC, t.NullC]>;
523
1280
  frequency_limit: t.UnionC<[t.LiteralC<"no_limit">, t.LiteralC<"once_per_session">, t.LiteralC<"once_per_user">, t.LiteralC<"until_interaction">]>;
@@ -575,14 +1332,33 @@ export declare class Nudge {
575
1332
  type: "on_event";
576
1333
  meta: {
577
1334
  event: string;
1335
+ condition_group: import("./helpers/rules").RuleExpression | null | undefined;
578
1336
  };
579
1337
  } | {
580
1338
  type: "when_element_appears";
581
1339
  meta: {
582
1340
  selector: string;
583
1341
  };
1342
+ } | {
1343
+ type: "on_user_confusion";
1344
+ } | {
1345
+ type: "on_rage_click";
1346
+ } | {
1347
+ type: "smart_delay";
1348
+ } | {
1349
+ type: "after_time";
1350
+ meta: {
1351
+ unit: "minute" | "second";
1352
+ value: number;
1353
+ };
584
1354
  } | {
585
1355
  type: "when_share_link_viewed";
1356
+ } | {
1357
+ type: "scheduled";
1358
+ meta: {
1359
+ interval: "day" | "month" | "week";
1360
+ value: number;
1361
+ };
586
1362
  };
587
1363
  frequency_limit: "no_limit" | "once_per_session" | "once_per_user" | "until_interaction";
588
1364
  steps: ({
@@ -590,11 +1366,13 @@ export declare class Nudge {
590
1366
  title: string;
591
1367
  content: ({
592
1368
  type: "markdown";
1369
+ sort_key: number | undefined;
593
1370
  meta: {
594
1371
  value: string;
595
1372
  };
596
1373
  } | {
597
1374
  type: "image";
1375
+ sort_key: number | undefined;
598
1376
  meta: {
599
1377
  src: string;
600
1378
  file_name: string;
@@ -602,6 +1380,7 @@ export declare class Nudge {
602
1380
  };
603
1381
  } | {
604
1382
  type: "video";
1383
+ sort_key: number | undefined;
605
1384
  meta: {
606
1385
  type: "url";
607
1386
  src: string;
@@ -611,18 +1390,30 @@ export declare class Nudge {
611
1390
  };
612
1391
  } | {
613
1392
  type: "help_doc_command";
1393
+ sort_key: number | undefined;
614
1394
  meta: {
615
1395
  command: string;
616
1396
  };
617
1397
  } | {
618
1398
  type: "button";
1399
+ sort_key: number | undefined;
619
1400
  meta: {
620
1401
  label?: string | undefined;
621
1402
  action?: {
622
1403
  type: "execute_command";
623
1404
  meta: {
624
1405
  command: string;
1406
+ } & {
1407
+ type?: "link" | "video" | "action" | "helpdoc" | undefined;
625
1408
  };
1409
+ } | {
1410
+ type: "no_action";
1411
+ } | {
1412
+ type: "click";
1413
+ value: string;
1414
+ } | {
1415
+ type: "click" | "clickBySelector" | "clickByXpath";
1416
+ value: string[];
626
1417
  } | ({
627
1418
  type: "link";
628
1419
  value: string;
@@ -631,26 +1422,125 @@ export declare class Nudge {
631
1422
  }) | {
632
1423
  type: "open_chat";
633
1424
  meta: {
634
- type: string;
1425
+ type: "" | "intercom" | "helpscout" | "freshdesk" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "hubspot" | "drift";
635
1426
  };
636
1427
  } | {
637
1428
  type: "dismiss";
638
1429
  } | {
639
- type: "no_action";
1430
+ type: "snooze";
640
1431
  } | {
641
- type: "click";
642
- value: string;
1432
+ type: "questlist";
1433
+ value: number;
1434
+ } | {
1435
+ type: "step_back";
1436
+ } | {
1437
+ type: "nudge";
1438
+ value: number;
1439
+ } | {
1440
+ type: "go_to_step";
1441
+ value: number;
1442
+ } | ({
1443
+ type: "open_bar";
1444
+ } & {
1445
+ value?: string | undefined;
1446
+ categoryFilter?: number | undefined;
1447
+ }) | {
1448
+ type: "open_helphub";
1449
+ } | {
1450
+ type: "open_copilot";
643
1451
  } | undefined;
644
- button_type?: "primary" | "secondary" | undefined;
1452
+ button_type?: "snooze" | "primary" | "secondary" | undefined;
1453
+ conditional_actions?: {
1454
+ operator: "eq" | "neq" | "gt" | "lt";
1455
+ operand: string | number;
1456
+ action: {
1457
+ type: "execute_command";
1458
+ meta: {
1459
+ command: string;
1460
+ } & {
1461
+ type?: "link" | "video" | "action" | "helpdoc" | undefined;
1462
+ };
1463
+ } | {
1464
+ type: "no_action";
1465
+ } | {
1466
+ type: "click";
1467
+ value: string;
1468
+ } | {
1469
+ type: "click" | "clickBySelector" | "clickByXpath";
1470
+ value: string[];
1471
+ } | ({
1472
+ type: "link";
1473
+ value: string;
1474
+ } & {
1475
+ operation?: "self" | "router" | "blank" | undefined;
1476
+ }) | {
1477
+ type: "open_chat";
1478
+ meta: {
1479
+ type: "" | "intercom" | "helpscout" | "freshdesk" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "hubspot" | "drift";
1480
+ };
1481
+ } | {
1482
+ type: "dismiss";
1483
+ } | {
1484
+ type: "snooze";
1485
+ } | {
1486
+ type: "questlist";
1487
+ value: number;
1488
+ } | {
1489
+ type: "step_back";
1490
+ } | {
1491
+ type: "nudge";
1492
+ value: number;
1493
+ } | {
1494
+ type: "go_to_step";
1495
+ value: number;
1496
+ } | ({
1497
+ type: "open_bar";
1498
+ } & {
1499
+ value?: string | undefined;
1500
+ categoryFilter?: number | undefined;
1501
+ }) | {
1502
+ type: "open_helphub";
1503
+ } | {
1504
+ type: "open_copilot";
1505
+ };
1506
+ }[] | undefined;
645
1507
  } | null;
646
1508
  } | {
647
1509
  type: "survey_text";
648
1510
  meta: {
649
1511
  prompt: string;
1512
+ } & {
1513
+ validation?: {
1514
+ required?: {
1515
+ value: true;
1516
+ message: string;
1517
+ } | {
1518
+ value: false;
1519
+ message: null;
1520
+ } | undefined;
1521
+ } | undefined;
650
1522
  };
1523
+ sort_key: number | undefined;
651
1524
  } | {
652
- type: "survey_rating";
1525
+ type: "survey_text_short";
653
1526
  meta: {
1527
+ prompt: string;
1528
+ } & {
1529
+ validation?: {
1530
+ required?: {
1531
+ value: true;
1532
+ message: string;
1533
+ } | {
1534
+ value: false;
1535
+ message: null;
1536
+ } | undefined;
1537
+ } | undefined;
1538
+ };
1539
+ sort_key: number | undefined;
1540
+ } | {
1541
+ type: "survey_rating";
1542
+ sort_key: number | undefined;
1543
+ meta: ({
654
1544
  type: "emojis";
655
1545
  lower_label: string;
656
1546
  upper_label: string;
@@ -666,6 +1556,34 @@ export declare class Nudge {
666
1556
  lower_label: string;
667
1557
  upper_label: string;
668
1558
  options: number;
1559
+ }) & {
1560
+ validation?: {
1561
+ required?: {
1562
+ value: true;
1563
+ message: string;
1564
+ } | {
1565
+ value: false;
1566
+ message: null;
1567
+ } | undefined;
1568
+ } | undefined;
1569
+ };
1570
+ } | {
1571
+ type: "survey_list";
1572
+ sort_key: number | undefined;
1573
+ meta: {
1574
+ options: string[];
1575
+ list_type: "multiple" | "single";
1576
+ display_type: "grid" | "list" | "dropdown";
1577
+ } & {
1578
+ validation?: {
1579
+ required?: {
1580
+ value: true;
1581
+ message: string;
1582
+ } | {
1583
+ value: false;
1584
+ message: null;
1585
+ } | undefined;
1586
+ } | undefined;
669
1587
  };
670
1588
  })[];
671
1589
  is_live: boolean;
@@ -680,11 +1598,34 @@ export declare class Nudge {
680
1598
  anchor: string;
681
1599
  } & {
682
1600
  is_open_by_default?: boolean | undefined;
1601
+ is_showing_mask?: boolean | undefined;
1602
+ advance_trigger?: string | undefined;
683
1603
  offset?: {
684
1604
  x: string;
685
1605
  y: string;
686
1606
  } | undefined;
687
- });
1607
+ }) | {
1608
+ type: "tooltip";
1609
+ anchor: string;
1610
+ show_on: "click" | "hover";
1611
+ marker: ({
1612
+ type: "beacon";
1613
+ } | {
1614
+ type: "icon";
1615
+ icon: "helpCircle" | "helpSquare" | "infoCircle" | "bookClosed" | "lightBulb" | "lightning";
1616
+ } | {
1617
+ type: "image";
1618
+ source: string;
1619
+ }) & {
1620
+ positioning: {
1621
+ position: "left" | "right" | "inline_left" | "inline_right";
1622
+ offset: {
1623
+ x: string;
1624
+ y: string;
1625
+ };
1626
+ };
1627
+ };
1628
+ };
688
1629
  } & {
689
1630
  has_survey_response?: boolean | undefined;
690
1631
  })[];
@@ -710,7 +1651,19 @@ export declare class Nudge {
710
1651
  template_source: string;
711
1652
  show_step_counter: boolean;
712
1653
  dismissible: boolean;
713
- share_page_url: string;
1654
+ snoozable: boolean;
1655
+ share_page_url_or_path: string;
1656
+ copilot_suggest: boolean;
1657
+ show_in_spotlight_search: boolean;
1658
+ show_in_helphub_search: boolean;
1659
+ copilot_cta_label: string;
1660
+ copilot_description: string;
1661
+ is_scheduled: boolean;
1662
+ scheduled_start_time: string | null | undefined;
1663
+ scheduled_end_time: string | null | undefined;
1664
+ snooze_label: string;
1665
+ type: "announcement" | "product_tour" | "survey" | null;
1666
+ editor_tags: string[];
714
1667
  };
715
1668
  static create: (object: {
716
1669
  slug: string;
@@ -733,14 +1686,33 @@ export declare class Nudge {
733
1686
  type: "on_event";
734
1687
  meta: {
735
1688
  event: string;
1689
+ condition_group: import("./helpers/rules").RuleExpression | null | undefined;
736
1690
  };
737
1691
  } | {
738
1692
  type: "when_element_appears";
739
1693
  meta: {
740
1694
  selector: string;
741
1695
  };
1696
+ } | {
1697
+ type: "on_user_confusion";
1698
+ } | {
1699
+ type: "on_rage_click";
1700
+ } | {
1701
+ type: "smart_delay";
1702
+ } | {
1703
+ type: "after_time";
1704
+ meta: {
1705
+ unit: "minute" | "second";
1706
+ value: number;
1707
+ };
742
1708
  } | {
743
1709
  type: "when_share_link_viewed";
1710
+ } | {
1711
+ type: "scheduled";
1712
+ meta: {
1713
+ interval: "day" | "month" | "week";
1714
+ value: number;
1715
+ };
744
1716
  };
745
1717
  frequency_limit: "no_limit" | "once_per_session" | "once_per_user" | "until_interaction";
746
1718
  steps: ({
@@ -748,11 +1720,13 @@ export declare class Nudge {
748
1720
  title: string;
749
1721
  content: ({
750
1722
  type: "markdown";
1723
+ sort_key: number | undefined;
751
1724
  meta: {
752
1725
  value: string;
753
1726
  };
754
1727
  } | {
755
1728
  type: "image";
1729
+ sort_key: number | undefined;
756
1730
  meta: {
757
1731
  src: string;
758
1732
  file_name: string;
@@ -760,6 +1734,7 @@ export declare class Nudge {
760
1734
  };
761
1735
  } | {
762
1736
  type: "video";
1737
+ sort_key: number | undefined;
763
1738
  meta: {
764
1739
  type: "url";
765
1740
  src: string;
@@ -769,18 +1744,30 @@ export declare class Nudge {
769
1744
  };
770
1745
  } | {
771
1746
  type: "help_doc_command";
1747
+ sort_key: number | undefined;
772
1748
  meta: {
773
1749
  command: string;
774
1750
  };
775
1751
  } | {
776
1752
  type: "button";
1753
+ sort_key: number | undefined;
777
1754
  meta: {
778
1755
  label?: string | undefined;
779
1756
  action?: {
780
1757
  type: "execute_command";
781
1758
  meta: {
782
1759
  command: string;
1760
+ } & {
1761
+ type?: "link" | "video" | "action" | "helpdoc" | undefined;
783
1762
  };
1763
+ } | {
1764
+ type: "no_action";
1765
+ } | {
1766
+ type: "click";
1767
+ value: string;
1768
+ } | {
1769
+ type: "click" | "clickBySelector" | "clickByXpath";
1770
+ value: string[];
784
1771
  } | ({
785
1772
  type: "link";
786
1773
  value: string;
@@ -789,26 +1776,125 @@ export declare class Nudge {
789
1776
  }) | {
790
1777
  type: "open_chat";
791
1778
  meta: {
792
- type: string;
1779
+ type: "" | "intercom" | "helpscout" | "freshdesk" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "hubspot" | "drift";
793
1780
  };
794
1781
  } | {
795
1782
  type: "dismiss";
796
1783
  } | {
797
- type: "no_action";
1784
+ type: "snooze";
798
1785
  } | {
799
- type: "click";
800
- value: string;
1786
+ type: "questlist";
1787
+ value: number;
1788
+ } | {
1789
+ type: "step_back";
1790
+ } | {
1791
+ type: "nudge";
1792
+ value: number;
1793
+ } | {
1794
+ type: "go_to_step";
1795
+ value: number;
1796
+ } | ({
1797
+ type: "open_bar";
1798
+ } & {
1799
+ value?: string | undefined;
1800
+ categoryFilter?: number | undefined;
1801
+ }) | {
1802
+ type: "open_helphub";
1803
+ } | {
1804
+ type: "open_copilot";
801
1805
  } | undefined;
802
- button_type?: "primary" | "secondary" | undefined;
1806
+ button_type?: "snooze" | "primary" | "secondary" | undefined;
1807
+ conditional_actions?: {
1808
+ operator: "eq" | "neq" | "gt" | "lt";
1809
+ operand: string | number;
1810
+ action: {
1811
+ type: "execute_command";
1812
+ meta: {
1813
+ command: string;
1814
+ } & {
1815
+ type?: "link" | "video" | "action" | "helpdoc" | undefined;
1816
+ };
1817
+ } | {
1818
+ type: "no_action";
1819
+ } | {
1820
+ type: "click";
1821
+ value: string;
1822
+ } | {
1823
+ type: "click" | "clickBySelector" | "clickByXpath";
1824
+ value: string[];
1825
+ } | ({
1826
+ type: "link";
1827
+ value: string;
1828
+ } & {
1829
+ operation?: "self" | "router" | "blank" | undefined;
1830
+ }) | {
1831
+ type: "open_chat";
1832
+ meta: {
1833
+ type: "" | "intercom" | "helpscout" | "freshdesk" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "hubspot" | "drift";
1834
+ };
1835
+ } | {
1836
+ type: "dismiss";
1837
+ } | {
1838
+ type: "snooze";
1839
+ } | {
1840
+ type: "questlist";
1841
+ value: number;
1842
+ } | {
1843
+ type: "step_back";
1844
+ } | {
1845
+ type: "nudge";
1846
+ value: number;
1847
+ } | {
1848
+ type: "go_to_step";
1849
+ value: number;
1850
+ } | ({
1851
+ type: "open_bar";
1852
+ } & {
1853
+ value?: string | undefined;
1854
+ categoryFilter?: number | undefined;
1855
+ }) | {
1856
+ type: "open_helphub";
1857
+ } | {
1858
+ type: "open_copilot";
1859
+ };
1860
+ }[] | undefined;
803
1861
  } | null;
804
1862
  } | {
805
1863
  type: "survey_text";
806
1864
  meta: {
807
1865
  prompt: string;
1866
+ } & {
1867
+ validation?: {
1868
+ required?: {
1869
+ value: true;
1870
+ message: string;
1871
+ } | {
1872
+ value: false;
1873
+ message: null;
1874
+ } | undefined;
1875
+ } | undefined;
808
1876
  };
1877
+ sort_key: number | undefined;
809
1878
  } | {
810
- type: "survey_rating";
1879
+ type: "survey_text_short";
811
1880
  meta: {
1881
+ prompt: string;
1882
+ } & {
1883
+ validation?: {
1884
+ required?: {
1885
+ value: true;
1886
+ message: string;
1887
+ } | {
1888
+ value: false;
1889
+ message: null;
1890
+ } | undefined;
1891
+ } | undefined;
1892
+ };
1893
+ sort_key: number | undefined;
1894
+ } | {
1895
+ type: "survey_rating";
1896
+ sort_key: number | undefined;
1897
+ meta: ({
812
1898
  type: "emojis";
813
1899
  lower_label: string;
814
1900
  upper_label: string;
@@ -824,6 +1910,34 @@ export declare class Nudge {
824
1910
  lower_label: string;
825
1911
  upper_label: string;
826
1912
  options: number;
1913
+ }) & {
1914
+ validation?: {
1915
+ required?: {
1916
+ value: true;
1917
+ message: string;
1918
+ } | {
1919
+ value: false;
1920
+ message: null;
1921
+ } | undefined;
1922
+ } | undefined;
1923
+ };
1924
+ } | {
1925
+ type: "survey_list";
1926
+ sort_key: number | undefined;
1927
+ meta: {
1928
+ options: string[];
1929
+ list_type: "multiple" | "single";
1930
+ display_type: "grid" | "list" | "dropdown";
1931
+ } & {
1932
+ validation?: {
1933
+ required?: {
1934
+ value: true;
1935
+ message: string;
1936
+ } | {
1937
+ value: false;
1938
+ message: null;
1939
+ } | undefined;
1940
+ } | undefined;
827
1941
  };
828
1942
  })[];
829
1943
  is_live: boolean;
@@ -838,11 +1952,34 @@ export declare class Nudge {
838
1952
  anchor: string;
839
1953
  } & {
840
1954
  is_open_by_default?: boolean | undefined;
1955
+ is_showing_mask?: boolean | undefined;
1956
+ advance_trigger?: string | undefined;
841
1957
  offset?: {
842
1958
  x: string;
843
1959
  y: string;
844
1960
  } | undefined;
845
- });
1961
+ }) | {
1962
+ type: "tooltip";
1963
+ anchor: string;
1964
+ show_on: "click" | "hover";
1965
+ marker: ({
1966
+ type: "beacon";
1967
+ } | {
1968
+ type: "icon";
1969
+ icon: "helpCircle" | "helpSquare" | "infoCircle" | "bookClosed" | "lightBulb" | "lightning";
1970
+ } | {
1971
+ type: "image";
1972
+ source: string;
1973
+ }) & {
1974
+ positioning: {
1975
+ position: "left" | "right" | "inline_left" | "inline_right";
1976
+ offset: {
1977
+ x: string;
1978
+ y: string;
1979
+ };
1980
+ };
1981
+ };
1982
+ };
846
1983
  } & {
847
1984
  has_survey_response?: boolean | undefined;
848
1985
  })[];
@@ -868,7 +2005,19 @@ export declare class Nudge {
868
2005
  template_source: string;
869
2006
  show_step_counter: boolean;
870
2007
  dismissible: boolean;
871
- share_page_url: string;
2008
+ snoozable: boolean;
2009
+ share_page_url_or_path: string;
2010
+ copilot_suggest: boolean;
2011
+ show_in_spotlight_search: boolean;
2012
+ show_in_helphub_search: boolean;
2013
+ copilot_cta_label: string;
2014
+ copilot_description: string;
2015
+ is_scheduled: boolean;
2016
+ scheduled_start_time: string | null | undefined;
2017
+ scheduled_end_time: string | null | undefined;
2018
+ snooze_label: string;
2019
+ type: "announcement" | "product_tour" | "survey" | null;
2020
+ editor_tags: string[];
872
2021
  }, onSuccess?: (() => void) | undefined, onError?: ((err: string) => void) | undefined) => Promise<{
873
2022
  slug: string;
874
2023
  id: string | number;
@@ -890,14 +2039,33 @@ export declare class Nudge {
890
2039
  type: "on_event";
891
2040
  meta: {
892
2041
  event: string;
2042
+ condition_group: import("./helpers/rules").RuleExpression | null | undefined;
893
2043
  };
894
2044
  } | {
895
2045
  type: "when_element_appears";
896
2046
  meta: {
897
2047
  selector: string;
898
2048
  };
2049
+ } | {
2050
+ type: "on_user_confusion";
2051
+ } | {
2052
+ type: "on_rage_click";
2053
+ } | {
2054
+ type: "smart_delay";
2055
+ } | {
2056
+ type: "after_time";
2057
+ meta: {
2058
+ unit: "minute" | "second";
2059
+ value: number;
2060
+ };
899
2061
  } | {
900
2062
  type: "when_share_link_viewed";
2063
+ } | {
2064
+ type: "scheduled";
2065
+ meta: {
2066
+ interval: "day" | "month" | "week";
2067
+ value: number;
2068
+ };
901
2069
  };
902
2070
  frequency_limit: "no_limit" | "once_per_session" | "once_per_user" | "until_interaction";
903
2071
  steps: ({
@@ -905,11 +2073,13 @@ export declare class Nudge {
905
2073
  title: string;
906
2074
  content: ({
907
2075
  type: "markdown";
2076
+ sort_key: number | undefined;
908
2077
  meta: {
909
2078
  value: string;
910
2079
  };
911
2080
  } | {
912
2081
  type: "image";
2082
+ sort_key: number | undefined;
913
2083
  meta: {
914
2084
  src: string;
915
2085
  file_name: string;
@@ -917,6 +2087,7 @@ export declare class Nudge {
917
2087
  };
918
2088
  } | {
919
2089
  type: "video";
2090
+ sort_key: number | undefined;
920
2091
  meta: {
921
2092
  type: "url";
922
2093
  src: string;
@@ -926,18 +2097,30 @@ export declare class Nudge {
926
2097
  };
927
2098
  } | {
928
2099
  type: "help_doc_command";
2100
+ sort_key: number | undefined;
929
2101
  meta: {
930
2102
  command: string;
931
2103
  };
932
2104
  } | {
933
2105
  type: "button";
2106
+ sort_key: number | undefined;
934
2107
  meta: {
935
2108
  label?: string | undefined;
936
2109
  action?: {
937
2110
  type: "execute_command";
938
2111
  meta: {
939
2112
  command: string;
2113
+ } & {
2114
+ type?: "link" | "video" | "action" | "helpdoc" | undefined;
940
2115
  };
2116
+ } | {
2117
+ type: "no_action";
2118
+ } | {
2119
+ type: "click";
2120
+ value: string;
2121
+ } | {
2122
+ type: "click" | "clickBySelector" | "clickByXpath";
2123
+ value: string[];
941
2124
  } | ({
942
2125
  type: "link";
943
2126
  value: string;
@@ -946,26 +2129,125 @@ export declare class Nudge {
946
2129
  }) | {
947
2130
  type: "open_chat";
948
2131
  meta: {
949
- type: string;
2132
+ type: "" | "intercom" | "helpscout" | "freshdesk" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "hubspot" | "drift";
950
2133
  };
951
2134
  } | {
952
2135
  type: "dismiss";
953
2136
  } | {
954
- type: "no_action";
2137
+ type: "snooze";
955
2138
  } | {
956
- type: "click";
957
- value: string;
2139
+ type: "questlist";
2140
+ value: number;
2141
+ } | {
2142
+ type: "step_back";
2143
+ } | {
2144
+ type: "nudge";
2145
+ value: number;
2146
+ } | {
2147
+ type: "go_to_step";
2148
+ value: number;
2149
+ } | ({
2150
+ type: "open_bar";
2151
+ } & {
2152
+ value?: string | undefined;
2153
+ categoryFilter?: number | undefined;
2154
+ }) | {
2155
+ type: "open_helphub";
2156
+ } | {
2157
+ type: "open_copilot";
958
2158
  } | undefined;
959
- button_type?: "primary" | "secondary" | undefined;
2159
+ button_type?: "snooze" | "primary" | "secondary" | undefined;
2160
+ conditional_actions?: {
2161
+ operator: "eq" | "neq" | "gt" | "lt";
2162
+ operand: string | number;
2163
+ action: {
2164
+ type: "execute_command";
2165
+ meta: {
2166
+ command: string;
2167
+ } & {
2168
+ type?: "link" | "video" | "action" | "helpdoc" | undefined;
2169
+ };
2170
+ } | {
2171
+ type: "no_action";
2172
+ } | {
2173
+ type: "click";
2174
+ value: string;
2175
+ } | {
2176
+ type: "click" | "clickBySelector" | "clickByXpath";
2177
+ value: string[];
2178
+ } | ({
2179
+ type: "link";
2180
+ value: string;
2181
+ } & {
2182
+ operation?: "self" | "router" | "blank" | undefined;
2183
+ }) | {
2184
+ type: "open_chat";
2185
+ meta: {
2186
+ type: "" | "intercom" | "helpscout" | "freshdesk" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "hubspot" | "drift";
2187
+ };
2188
+ } | {
2189
+ type: "dismiss";
2190
+ } | {
2191
+ type: "snooze";
2192
+ } | {
2193
+ type: "questlist";
2194
+ value: number;
2195
+ } | {
2196
+ type: "step_back";
2197
+ } | {
2198
+ type: "nudge";
2199
+ value: number;
2200
+ } | {
2201
+ type: "go_to_step";
2202
+ value: number;
2203
+ } | ({
2204
+ type: "open_bar";
2205
+ } & {
2206
+ value?: string | undefined;
2207
+ categoryFilter?: number | undefined;
2208
+ }) | {
2209
+ type: "open_helphub";
2210
+ } | {
2211
+ type: "open_copilot";
2212
+ };
2213
+ }[] | undefined;
960
2214
  } | null;
961
2215
  } | {
962
2216
  type: "survey_text";
963
2217
  meta: {
964
2218
  prompt: string;
2219
+ } & {
2220
+ validation?: {
2221
+ required?: {
2222
+ value: true;
2223
+ message: string;
2224
+ } | {
2225
+ value: false;
2226
+ message: null;
2227
+ } | undefined;
2228
+ } | undefined;
965
2229
  };
2230
+ sort_key: number | undefined;
966
2231
  } | {
967
- type: "survey_rating";
2232
+ type: "survey_text_short";
968
2233
  meta: {
2234
+ prompt: string;
2235
+ } & {
2236
+ validation?: {
2237
+ required?: {
2238
+ value: true;
2239
+ message: string;
2240
+ } | {
2241
+ value: false;
2242
+ message: null;
2243
+ } | undefined;
2244
+ } | undefined;
2245
+ };
2246
+ sort_key: number | undefined;
2247
+ } | {
2248
+ type: "survey_rating";
2249
+ sort_key: number | undefined;
2250
+ meta: ({
969
2251
  type: "emojis";
970
2252
  lower_label: string;
971
2253
  upper_label: string;
@@ -981,6 +2263,34 @@ export declare class Nudge {
981
2263
  lower_label: string;
982
2264
  upper_label: string;
983
2265
  options: number;
2266
+ }) & {
2267
+ validation?: {
2268
+ required?: {
2269
+ value: true;
2270
+ message: string;
2271
+ } | {
2272
+ value: false;
2273
+ message: null;
2274
+ } | undefined;
2275
+ } | undefined;
2276
+ };
2277
+ } | {
2278
+ type: "survey_list";
2279
+ sort_key: number | undefined;
2280
+ meta: {
2281
+ options: string[];
2282
+ list_type: "multiple" | "single";
2283
+ display_type: "grid" | "list" | "dropdown";
2284
+ } & {
2285
+ validation?: {
2286
+ required?: {
2287
+ value: true;
2288
+ message: string;
2289
+ } | {
2290
+ value: false;
2291
+ message: null;
2292
+ } | undefined;
2293
+ } | undefined;
984
2294
  };
985
2295
  })[];
986
2296
  is_live: boolean;
@@ -995,11 +2305,34 @@ export declare class Nudge {
995
2305
  anchor: string;
996
2306
  } & {
997
2307
  is_open_by_default?: boolean | undefined;
2308
+ is_showing_mask?: boolean | undefined;
2309
+ advance_trigger?: string | undefined;
998
2310
  offset?: {
999
2311
  x: string;
1000
2312
  y: string;
1001
2313
  } | undefined;
1002
- });
2314
+ }) | {
2315
+ type: "tooltip";
2316
+ anchor: string;
2317
+ show_on: "click" | "hover";
2318
+ marker: ({
2319
+ type: "beacon";
2320
+ } | {
2321
+ type: "icon";
2322
+ icon: "helpCircle" | "helpSquare" | "infoCircle" | "bookClosed" | "lightBulb" | "lightning";
2323
+ } | {
2324
+ type: "image";
2325
+ source: string;
2326
+ }) & {
2327
+ positioning: {
2328
+ position: "left" | "right" | "inline_left" | "inline_right";
2329
+ offset: {
2330
+ x: string;
2331
+ y: string;
2332
+ };
2333
+ };
2334
+ };
2335
+ };
1003
2336
  } & {
1004
2337
  has_survey_response?: boolean | undefined;
1005
2338
  })[];
@@ -1025,7 +2358,19 @@ export declare class Nudge {
1025
2358
  template_source: string;
1026
2359
  show_step_counter: boolean;
1027
2360
  dismissible: boolean;
1028
- share_page_url: string;
2361
+ snoozable: boolean;
2362
+ share_page_url_or_path: string;
2363
+ copilot_suggest: boolean;
2364
+ show_in_spotlight_search: boolean;
2365
+ show_in_helphub_search: boolean;
2366
+ copilot_cta_label: string;
2367
+ copilot_description: string;
2368
+ is_scheduled: boolean;
2369
+ scheduled_start_time: string | null | undefined;
2370
+ scheduled_end_time: string | null | undefined;
2371
+ snooze_label: string;
2372
+ type: "announcement" | "product_tour" | "survey" | null;
2373
+ editor_tags: string[];
1029
2374
  }>;
1030
2375
  static update: (object: {
1031
2376
  slug: string;
@@ -1048,14 +2393,33 @@ export declare class Nudge {
1048
2393
  type: "on_event";
1049
2394
  meta: {
1050
2395
  event: string;
2396
+ condition_group: import("./helpers/rules").RuleExpression | null | undefined;
1051
2397
  };
1052
2398
  } | {
1053
2399
  type: "when_element_appears";
1054
2400
  meta: {
1055
2401
  selector: string;
1056
2402
  };
2403
+ } | {
2404
+ type: "on_user_confusion";
2405
+ } | {
2406
+ type: "on_rage_click";
2407
+ } | {
2408
+ type: "smart_delay";
2409
+ } | {
2410
+ type: "after_time";
2411
+ meta: {
2412
+ unit: "minute" | "second";
2413
+ value: number;
2414
+ };
1057
2415
  } | {
1058
2416
  type: "when_share_link_viewed";
2417
+ } | {
2418
+ type: "scheduled";
2419
+ meta: {
2420
+ interval: "day" | "month" | "week";
2421
+ value: number;
2422
+ };
1059
2423
  };
1060
2424
  frequency_limit: "no_limit" | "once_per_session" | "once_per_user" | "until_interaction";
1061
2425
  steps: ({
@@ -1063,11 +2427,13 @@ export declare class Nudge {
1063
2427
  title: string;
1064
2428
  content: ({
1065
2429
  type: "markdown";
2430
+ sort_key: number | undefined;
1066
2431
  meta: {
1067
2432
  value: string;
1068
2433
  };
1069
2434
  } | {
1070
2435
  type: "image";
2436
+ sort_key: number | undefined;
1071
2437
  meta: {
1072
2438
  src: string;
1073
2439
  file_name: string;
@@ -1075,6 +2441,7 @@ export declare class Nudge {
1075
2441
  };
1076
2442
  } | {
1077
2443
  type: "video";
2444
+ sort_key: number | undefined;
1078
2445
  meta: {
1079
2446
  type: "url";
1080
2447
  src: string;
@@ -1084,18 +2451,30 @@ export declare class Nudge {
1084
2451
  };
1085
2452
  } | {
1086
2453
  type: "help_doc_command";
2454
+ sort_key: number | undefined;
1087
2455
  meta: {
1088
2456
  command: string;
1089
2457
  };
1090
2458
  } | {
1091
2459
  type: "button";
2460
+ sort_key: number | undefined;
1092
2461
  meta: {
1093
2462
  label?: string | undefined;
1094
2463
  action?: {
1095
2464
  type: "execute_command";
1096
2465
  meta: {
1097
2466
  command: string;
2467
+ } & {
2468
+ type?: "link" | "video" | "action" | "helpdoc" | undefined;
1098
2469
  };
2470
+ } | {
2471
+ type: "no_action";
2472
+ } | {
2473
+ type: "click";
2474
+ value: string;
2475
+ } | {
2476
+ type: "click" | "clickBySelector" | "clickByXpath";
2477
+ value: string[];
1099
2478
  } | ({
1100
2479
  type: "link";
1101
2480
  value: string;
@@ -1104,26 +2483,125 @@ export declare class Nudge {
1104
2483
  }) | {
1105
2484
  type: "open_chat";
1106
2485
  meta: {
1107
- type: string;
2486
+ type: "" | "intercom" | "helpscout" | "freshdesk" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "hubspot" | "drift";
1108
2487
  };
1109
2488
  } | {
1110
2489
  type: "dismiss";
1111
2490
  } | {
1112
- type: "no_action";
2491
+ type: "snooze";
1113
2492
  } | {
1114
- type: "click";
1115
- value: string;
2493
+ type: "questlist";
2494
+ value: number;
2495
+ } | {
2496
+ type: "step_back";
2497
+ } | {
2498
+ type: "nudge";
2499
+ value: number;
2500
+ } | {
2501
+ type: "go_to_step";
2502
+ value: number;
2503
+ } | ({
2504
+ type: "open_bar";
2505
+ } & {
2506
+ value?: string | undefined;
2507
+ categoryFilter?: number | undefined;
2508
+ }) | {
2509
+ type: "open_helphub";
2510
+ } | {
2511
+ type: "open_copilot";
1116
2512
  } | undefined;
1117
- button_type?: "primary" | "secondary" | undefined;
2513
+ button_type?: "snooze" | "primary" | "secondary" | undefined;
2514
+ conditional_actions?: {
2515
+ operator: "eq" | "neq" | "gt" | "lt";
2516
+ operand: string | number;
2517
+ action: {
2518
+ type: "execute_command";
2519
+ meta: {
2520
+ command: string;
2521
+ } & {
2522
+ type?: "link" | "video" | "action" | "helpdoc" | undefined;
2523
+ };
2524
+ } | {
2525
+ type: "no_action";
2526
+ } | {
2527
+ type: "click";
2528
+ value: string;
2529
+ } | {
2530
+ type: "click" | "clickBySelector" | "clickByXpath";
2531
+ value: string[];
2532
+ } | ({
2533
+ type: "link";
2534
+ value: string;
2535
+ } & {
2536
+ operation?: "self" | "router" | "blank" | undefined;
2537
+ }) | {
2538
+ type: "open_chat";
2539
+ meta: {
2540
+ type: "" | "intercom" | "helpscout" | "freshdesk" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "hubspot" | "drift";
2541
+ };
2542
+ } | {
2543
+ type: "dismiss";
2544
+ } | {
2545
+ type: "snooze";
2546
+ } | {
2547
+ type: "questlist";
2548
+ value: number;
2549
+ } | {
2550
+ type: "step_back";
2551
+ } | {
2552
+ type: "nudge";
2553
+ value: number;
2554
+ } | {
2555
+ type: "go_to_step";
2556
+ value: number;
2557
+ } | ({
2558
+ type: "open_bar";
2559
+ } & {
2560
+ value?: string | undefined;
2561
+ categoryFilter?: number | undefined;
2562
+ }) | {
2563
+ type: "open_helphub";
2564
+ } | {
2565
+ type: "open_copilot";
2566
+ };
2567
+ }[] | undefined;
1118
2568
  } | null;
1119
2569
  } | {
1120
2570
  type: "survey_text";
1121
2571
  meta: {
1122
2572
  prompt: string;
2573
+ } & {
2574
+ validation?: {
2575
+ required?: {
2576
+ value: true;
2577
+ message: string;
2578
+ } | {
2579
+ value: false;
2580
+ message: null;
2581
+ } | undefined;
2582
+ } | undefined;
1123
2583
  };
2584
+ sort_key: number | undefined;
1124
2585
  } | {
1125
- type: "survey_rating";
2586
+ type: "survey_text_short";
1126
2587
  meta: {
2588
+ prompt: string;
2589
+ } & {
2590
+ validation?: {
2591
+ required?: {
2592
+ value: true;
2593
+ message: string;
2594
+ } | {
2595
+ value: false;
2596
+ message: null;
2597
+ } | undefined;
2598
+ } | undefined;
2599
+ };
2600
+ sort_key: number | undefined;
2601
+ } | {
2602
+ type: "survey_rating";
2603
+ sort_key: number | undefined;
2604
+ meta: ({
1127
2605
  type: "emojis";
1128
2606
  lower_label: string;
1129
2607
  upper_label: string;
@@ -1139,6 +2617,34 @@ export declare class Nudge {
1139
2617
  lower_label: string;
1140
2618
  upper_label: string;
1141
2619
  options: number;
2620
+ }) & {
2621
+ validation?: {
2622
+ required?: {
2623
+ value: true;
2624
+ message: string;
2625
+ } | {
2626
+ value: false;
2627
+ message: null;
2628
+ } | undefined;
2629
+ } | undefined;
2630
+ };
2631
+ } | {
2632
+ type: "survey_list";
2633
+ sort_key: number | undefined;
2634
+ meta: {
2635
+ options: string[];
2636
+ list_type: "multiple" | "single";
2637
+ display_type: "grid" | "list" | "dropdown";
2638
+ } & {
2639
+ validation?: {
2640
+ required?: {
2641
+ value: true;
2642
+ message: string;
2643
+ } | {
2644
+ value: false;
2645
+ message: null;
2646
+ } | undefined;
2647
+ } | undefined;
1142
2648
  };
1143
2649
  })[];
1144
2650
  is_live: boolean;
@@ -1153,11 +2659,34 @@ export declare class Nudge {
1153
2659
  anchor: string;
1154
2660
  } & {
1155
2661
  is_open_by_default?: boolean | undefined;
2662
+ is_showing_mask?: boolean | undefined;
2663
+ advance_trigger?: string | undefined;
1156
2664
  offset?: {
1157
2665
  x: string;
1158
2666
  y: string;
1159
2667
  } | undefined;
1160
- });
2668
+ }) | {
2669
+ type: "tooltip";
2670
+ anchor: string;
2671
+ show_on: "click" | "hover";
2672
+ marker: ({
2673
+ type: "beacon";
2674
+ } | {
2675
+ type: "icon";
2676
+ icon: "helpCircle" | "helpSquare" | "infoCircle" | "bookClosed" | "lightBulb" | "lightning";
2677
+ } | {
2678
+ type: "image";
2679
+ source: string;
2680
+ }) & {
2681
+ positioning: {
2682
+ position: "left" | "right" | "inline_left" | "inline_right";
2683
+ offset: {
2684
+ x: string;
2685
+ y: string;
2686
+ };
2687
+ };
2688
+ };
2689
+ };
1161
2690
  } & {
1162
2691
  has_survey_response?: boolean | undefined;
1163
2692
  })[];
@@ -1183,7 +2712,19 @@ export declare class Nudge {
1183
2712
  template_source: string;
1184
2713
  show_step_counter: boolean;
1185
2714
  dismissible: boolean;
1186
- share_page_url: string;
2715
+ snoozable: boolean;
2716
+ share_page_url_or_path: string;
2717
+ copilot_suggest: boolean;
2718
+ show_in_spotlight_search: boolean;
2719
+ show_in_helphub_search: boolean;
2720
+ copilot_cta_label: string;
2721
+ copilot_description: string;
2722
+ is_scheduled: boolean;
2723
+ scheduled_start_time: string | null | undefined;
2724
+ scheduled_end_time: string | null | undefined;
2725
+ snooze_label: string;
2726
+ type: "announcement" | "product_tour" | "survey" | null;
2727
+ editor_tags: string[];
1187
2728
  }, onSuccess?: (() => void) | undefined, onError?: ((err: string) => void) | undefined) => Promise<{
1188
2729
  slug: string;
1189
2730
  id: string | number;
@@ -1205,14 +2746,33 @@ export declare class Nudge {
1205
2746
  type: "on_event";
1206
2747
  meta: {
1207
2748
  event: string;
2749
+ condition_group: import("./helpers/rules").RuleExpression | null | undefined;
1208
2750
  };
1209
2751
  } | {
1210
2752
  type: "when_element_appears";
1211
2753
  meta: {
1212
2754
  selector: string;
1213
2755
  };
2756
+ } | {
2757
+ type: "on_user_confusion";
2758
+ } | {
2759
+ type: "on_rage_click";
2760
+ } | {
2761
+ type: "smart_delay";
2762
+ } | {
2763
+ type: "after_time";
2764
+ meta: {
2765
+ unit: "minute" | "second";
2766
+ value: number;
2767
+ };
1214
2768
  } | {
1215
2769
  type: "when_share_link_viewed";
2770
+ } | {
2771
+ type: "scheduled";
2772
+ meta: {
2773
+ interval: "day" | "month" | "week";
2774
+ value: number;
2775
+ };
1216
2776
  };
1217
2777
  frequency_limit: "no_limit" | "once_per_session" | "once_per_user" | "until_interaction";
1218
2778
  steps: ({
@@ -1220,11 +2780,13 @@ export declare class Nudge {
1220
2780
  title: string;
1221
2781
  content: ({
1222
2782
  type: "markdown";
2783
+ sort_key: number | undefined;
1223
2784
  meta: {
1224
2785
  value: string;
1225
2786
  };
1226
2787
  } | {
1227
2788
  type: "image";
2789
+ sort_key: number | undefined;
1228
2790
  meta: {
1229
2791
  src: string;
1230
2792
  file_name: string;
@@ -1232,6 +2794,7 @@ export declare class Nudge {
1232
2794
  };
1233
2795
  } | {
1234
2796
  type: "video";
2797
+ sort_key: number | undefined;
1235
2798
  meta: {
1236
2799
  type: "url";
1237
2800
  src: string;
@@ -1241,18 +2804,30 @@ export declare class Nudge {
1241
2804
  };
1242
2805
  } | {
1243
2806
  type: "help_doc_command";
2807
+ sort_key: number | undefined;
1244
2808
  meta: {
1245
2809
  command: string;
1246
2810
  };
1247
2811
  } | {
1248
2812
  type: "button";
2813
+ sort_key: number | undefined;
1249
2814
  meta: {
1250
2815
  label?: string | undefined;
1251
2816
  action?: {
1252
2817
  type: "execute_command";
1253
2818
  meta: {
1254
2819
  command: string;
2820
+ } & {
2821
+ type?: "link" | "video" | "action" | "helpdoc" | undefined;
1255
2822
  };
2823
+ } | {
2824
+ type: "no_action";
2825
+ } | {
2826
+ type: "click";
2827
+ value: string;
2828
+ } | {
2829
+ type: "click" | "clickBySelector" | "clickByXpath";
2830
+ value: string[];
1256
2831
  } | ({
1257
2832
  type: "link";
1258
2833
  value: string;
@@ -1261,26 +2836,125 @@ export declare class Nudge {
1261
2836
  }) | {
1262
2837
  type: "open_chat";
1263
2838
  meta: {
1264
- type: string;
2839
+ type: "" | "intercom" | "helpscout" | "freshdesk" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "hubspot" | "drift";
1265
2840
  };
1266
2841
  } | {
1267
2842
  type: "dismiss";
1268
2843
  } | {
1269
- type: "no_action";
2844
+ type: "snooze";
1270
2845
  } | {
1271
- type: "click";
1272
- value: string;
2846
+ type: "questlist";
2847
+ value: number;
2848
+ } | {
2849
+ type: "step_back";
2850
+ } | {
2851
+ type: "nudge";
2852
+ value: number;
2853
+ } | {
2854
+ type: "go_to_step";
2855
+ value: number;
2856
+ } | ({
2857
+ type: "open_bar";
2858
+ } & {
2859
+ value?: string | undefined;
2860
+ categoryFilter?: number | undefined;
2861
+ }) | {
2862
+ type: "open_helphub";
2863
+ } | {
2864
+ type: "open_copilot";
1273
2865
  } | undefined;
1274
- button_type?: "primary" | "secondary" | undefined;
2866
+ button_type?: "snooze" | "primary" | "secondary" | undefined;
2867
+ conditional_actions?: {
2868
+ operator: "eq" | "neq" | "gt" | "lt";
2869
+ operand: string | number;
2870
+ action: {
2871
+ type: "execute_command";
2872
+ meta: {
2873
+ command: string;
2874
+ } & {
2875
+ type?: "link" | "video" | "action" | "helpdoc" | undefined;
2876
+ };
2877
+ } | {
2878
+ type: "no_action";
2879
+ } | {
2880
+ type: "click";
2881
+ value: string;
2882
+ } | {
2883
+ type: "click" | "clickBySelector" | "clickByXpath";
2884
+ value: string[];
2885
+ } | ({
2886
+ type: "link";
2887
+ value: string;
2888
+ } & {
2889
+ operation?: "self" | "router" | "blank" | undefined;
2890
+ }) | {
2891
+ type: "open_chat";
2892
+ meta: {
2893
+ type: "" | "intercom" | "helpscout" | "freshdesk" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "hubspot" | "drift";
2894
+ };
2895
+ } | {
2896
+ type: "dismiss";
2897
+ } | {
2898
+ type: "snooze";
2899
+ } | {
2900
+ type: "questlist";
2901
+ value: number;
2902
+ } | {
2903
+ type: "step_back";
2904
+ } | {
2905
+ type: "nudge";
2906
+ value: number;
2907
+ } | {
2908
+ type: "go_to_step";
2909
+ value: number;
2910
+ } | ({
2911
+ type: "open_bar";
2912
+ } & {
2913
+ value?: string | undefined;
2914
+ categoryFilter?: number | undefined;
2915
+ }) | {
2916
+ type: "open_helphub";
2917
+ } | {
2918
+ type: "open_copilot";
2919
+ };
2920
+ }[] | undefined;
1275
2921
  } | null;
1276
2922
  } | {
1277
2923
  type: "survey_text";
1278
2924
  meta: {
1279
2925
  prompt: string;
2926
+ } & {
2927
+ validation?: {
2928
+ required?: {
2929
+ value: true;
2930
+ message: string;
2931
+ } | {
2932
+ value: false;
2933
+ message: null;
2934
+ } | undefined;
2935
+ } | undefined;
1280
2936
  };
2937
+ sort_key: number | undefined;
1281
2938
  } | {
1282
- type: "survey_rating";
2939
+ type: "survey_text_short";
1283
2940
  meta: {
2941
+ prompt: string;
2942
+ } & {
2943
+ validation?: {
2944
+ required?: {
2945
+ value: true;
2946
+ message: string;
2947
+ } | {
2948
+ value: false;
2949
+ message: null;
2950
+ } | undefined;
2951
+ } | undefined;
2952
+ };
2953
+ sort_key: number | undefined;
2954
+ } | {
2955
+ type: "survey_rating";
2956
+ sort_key: number | undefined;
2957
+ meta: ({
1284
2958
  type: "emojis";
1285
2959
  lower_label: string;
1286
2960
  upper_label: string;
@@ -1296,6 +2970,34 @@ export declare class Nudge {
1296
2970
  lower_label: string;
1297
2971
  upper_label: string;
1298
2972
  options: number;
2973
+ }) & {
2974
+ validation?: {
2975
+ required?: {
2976
+ value: true;
2977
+ message: string;
2978
+ } | {
2979
+ value: false;
2980
+ message: null;
2981
+ } | undefined;
2982
+ } | undefined;
2983
+ };
2984
+ } | {
2985
+ type: "survey_list";
2986
+ sort_key: number | undefined;
2987
+ meta: {
2988
+ options: string[];
2989
+ list_type: "multiple" | "single";
2990
+ display_type: "grid" | "list" | "dropdown";
2991
+ } & {
2992
+ validation?: {
2993
+ required?: {
2994
+ value: true;
2995
+ message: string;
2996
+ } | {
2997
+ value: false;
2998
+ message: null;
2999
+ } | undefined;
3000
+ } | undefined;
1299
3001
  };
1300
3002
  })[];
1301
3003
  is_live: boolean;
@@ -1310,11 +3012,34 @@ export declare class Nudge {
1310
3012
  anchor: string;
1311
3013
  } & {
1312
3014
  is_open_by_default?: boolean | undefined;
3015
+ is_showing_mask?: boolean | undefined;
3016
+ advance_trigger?: string | undefined;
1313
3017
  offset?: {
1314
3018
  x: string;
1315
3019
  y: string;
1316
3020
  } | undefined;
1317
- });
3021
+ }) | {
3022
+ type: "tooltip";
3023
+ anchor: string;
3024
+ show_on: "click" | "hover";
3025
+ marker: ({
3026
+ type: "beacon";
3027
+ } | {
3028
+ type: "icon";
3029
+ icon: "helpCircle" | "helpSquare" | "infoCircle" | "bookClosed" | "lightBulb" | "lightning";
3030
+ } | {
3031
+ type: "image";
3032
+ source: string;
3033
+ }) & {
3034
+ positioning: {
3035
+ position: "left" | "right" | "inline_left" | "inline_right";
3036
+ offset: {
3037
+ x: string;
3038
+ y: string;
3039
+ };
3040
+ };
3041
+ };
3042
+ };
1318
3043
  } & {
1319
3044
  has_survey_response?: boolean | undefined;
1320
3045
  })[];
@@ -1340,7 +3065,19 @@ export declare class Nudge {
1340
3065
  template_source: string;
1341
3066
  show_step_counter: boolean;
1342
3067
  dismissible: boolean;
1343
- share_page_url: string;
3068
+ snoozable: boolean;
3069
+ share_page_url_or_path: string;
3070
+ copilot_suggest: boolean;
3071
+ show_in_spotlight_search: boolean;
3072
+ show_in_helphub_search: boolean;
3073
+ copilot_cta_label: string;
3074
+ copilot_description: string;
3075
+ is_scheduled: boolean;
3076
+ scheduled_start_time: string | null | undefined;
3077
+ scheduled_end_time: string | null | undefined;
3078
+ snooze_label: string;
3079
+ type: "announcement" | "product_tour" | "survey" | null;
3080
+ editor_tags: string[];
1344
3081
  }>;
1345
3082
  static delete: (id: string | number, params?: Record<string, string> | undefined, onSuccess?: (() => void) | undefined, onError?: ((err: string) => void) | undefined) => Promise<void>;
1346
3083
  static list: (onSuccess?: (() => void) | undefined, onError?: ((err: string) => void) | undefined) => Promise<({
@@ -1364,14 +3101,33 @@ export declare class Nudge {
1364
3101
  type: "on_event";
1365
3102
  meta: {
1366
3103
  event: string;
3104
+ condition_group: import("./helpers/rules").RuleExpression | null | undefined;
1367
3105
  };
1368
3106
  } | {
1369
3107
  type: "when_element_appears";
1370
3108
  meta: {
1371
3109
  selector: string;
1372
3110
  };
3111
+ } | {
3112
+ type: "on_user_confusion";
3113
+ } | {
3114
+ type: "on_rage_click";
3115
+ } | {
3116
+ type: "smart_delay";
3117
+ } | {
3118
+ type: "after_time";
3119
+ meta: {
3120
+ unit: "minute" | "second";
3121
+ value: number;
3122
+ };
1373
3123
  } | {
1374
3124
  type: "when_share_link_viewed";
3125
+ } | {
3126
+ type: "scheduled";
3127
+ meta: {
3128
+ interval: "day" | "month" | "week";
3129
+ value: number;
3130
+ };
1375
3131
  };
1376
3132
  frequency_limit: "no_limit" | "once_per_session" | "once_per_user" | "until_interaction";
1377
3133
  steps: ({
@@ -1379,11 +3135,13 @@ export declare class Nudge {
1379
3135
  title: string;
1380
3136
  content: ({
1381
3137
  type: "markdown";
3138
+ sort_key: number | undefined;
1382
3139
  meta: {
1383
3140
  value: string;
1384
3141
  };
1385
3142
  } | {
1386
3143
  type: "image";
3144
+ sort_key: number | undefined;
1387
3145
  meta: {
1388
3146
  src: string;
1389
3147
  file_name: string;
@@ -1391,6 +3149,7 @@ export declare class Nudge {
1391
3149
  };
1392
3150
  } | {
1393
3151
  type: "video";
3152
+ sort_key: number | undefined;
1394
3153
  meta: {
1395
3154
  type: "url";
1396
3155
  src: string;
@@ -1400,18 +3159,30 @@ export declare class Nudge {
1400
3159
  };
1401
3160
  } | {
1402
3161
  type: "help_doc_command";
3162
+ sort_key: number | undefined;
1403
3163
  meta: {
1404
3164
  command: string;
1405
3165
  };
1406
3166
  } | {
1407
3167
  type: "button";
3168
+ sort_key: number | undefined;
1408
3169
  meta: {
1409
3170
  label?: string | undefined;
1410
3171
  action?: {
1411
3172
  type: "execute_command";
1412
3173
  meta: {
1413
3174
  command: string;
3175
+ } & {
3176
+ type?: "link" | "video" | "action" | "helpdoc" | undefined;
1414
3177
  };
3178
+ } | {
3179
+ type: "no_action";
3180
+ } | {
3181
+ type: "click";
3182
+ value: string;
3183
+ } | {
3184
+ type: "click" | "clickBySelector" | "clickByXpath";
3185
+ value: string[];
1415
3186
  } | ({
1416
3187
  type: "link";
1417
3188
  value: string;
@@ -1420,26 +3191,125 @@ export declare class Nudge {
1420
3191
  }) | {
1421
3192
  type: "open_chat";
1422
3193
  meta: {
1423
- type: string;
3194
+ type: "" | "intercom" | "helpscout" | "freshdesk" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "hubspot" | "drift";
1424
3195
  };
1425
3196
  } | {
1426
3197
  type: "dismiss";
1427
3198
  } | {
1428
- type: "no_action";
3199
+ type: "snooze";
1429
3200
  } | {
1430
- type: "click";
1431
- value: string;
3201
+ type: "questlist";
3202
+ value: number;
3203
+ } | {
3204
+ type: "step_back";
3205
+ } | {
3206
+ type: "nudge";
3207
+ value: number;
3208
+ } | {
3209
+ type: "go_to_step";
3210
+ value: number;
3211
+ } | ({
3212
+ type: "open_bar";
3213
+ } & {
3214
+ value?: string | undefined;
3215
+ categoryFilter?: number | undefined;
3216
+ }) | {
3217
+ type: "open_helphub";
3218
+ } | {
3219
+ type: "open_copilot";
1432
3220
  } | undefined;
1433
- button_type?: "primary" | "secondary" | undefined;
3221
+ button_type?: "snooze" | "primary" | "secondary" | undefined;
3222
+ conditional_actions?: {
3223
+ operator: "eq" | "neq" | "gt" | "lt";
3224
+ operand: string | number;
3225
+ action: {
3226
+ type: "execute_command";
3227
+ meta: {
3228
+ command: string;
3229
+ } & {
3230
+ type?: "link" | "video" | "action" | "helpdoc" | undefined;
3231
+ };
3232
+ } | {
3233
+ type: "no_action";
3234
+ } | {
3235
+ type: "click";
3236
+ value: string;
3237
+ } | {
3238
+ type: "click" | "clickBySelector" | "clickByXpath";
3239
+ value: string[];
3240
+ } | ({
3241
+ type: "link";
3242
+ value: string;
3243
+ } & {
3244
+ operation?: "self" | "router" | "blank" | undefined;
3245
+ }) | {
3246
+ type: "open_chat";
3247
+ meta: {
3248
+ type: "" | "intercom" | "helpscout" | "freshdesk" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "hubspot" | "drift";
3249
+ };
3250
+ } | {
3251
+ type: "dismiss";
3252
+ } | {
3253
+ type: "snooze";
3254
+ } | {
3255
+ type: "questlist";
3256
+ value: number;
3257
+ } | {
3258
+ type: "step_back";
3259
+ } | {
3260
+ type: "nudge";
3261
+ value: number;
3262
+ } | {
3263
+ type: "go_to_step";
3264
+ value: number;
3265
+ } | ({
3266
+ type: "open_bar";
3267
+ } & {
3268
+ value?: string | undefined;
3269
+ categoryFilter?: number | undefined;
3270
+ }) | {
3271
+ type: "open_helphub";
3272
+ } | {
3273
+ type: "open_copilot";
3274
+ };
3275
+ }[] | undefined;
1434
3276
  } | null;
1435
3277
  } | {
1436
3278
  type: "survey_text";
1437
3279
  meta: {
1438
3280
  prompt: string;
3281
+ } & {
3282
+ validation?: {
3283
+ required?: {
3284
+ value: true;
3285
+ message: string;
3286
+ } | {
3287
+ value: false;
3288
+ message: null;
3289
+ } | undefined;
3290
+ } | undefined;
1439
3291
  };
3292
+ sort_key: number | undefined;
1440
3293
  } | {
1441
- type: "survey_rating";
3294
+ type: "survey_text_short";
1442
3295
  meta: {
3296
+ prompt: string;
3297
+ } & {
3298
+ validation?: {
3299
+ required?: {
3300
+ value: true;
3301
+ message: string;
3302
+ } | {
3303
+ value: false;
3304
+ message: null;
3305
+ } | undefined;
3306
+ } | undefined;
3307
+ };
3308
+ sort_key: number | undefined;
3309
+ } | {
3310
+ type: "survey_rating";
3311
+ sort_key: number | undefined;
3312
+ meta: ({
1443
3313
  type: "emojis";
1444
3314
  lower_label: string;
1445
3315
  upper_label: string;
@@ -1455,6 +3325,34 @@ export declare class Nudge {
1455
3325
  lower_label: string;
1456
3326
  upper_label: string;
1457
3327
  options: number;
3328
+ }) & {
3329
+ validation?: {
3330
+ required?: {
3331
+ value: true;
3332
+ message: string;
3333
+ } | {
3334
+ value: false;
3335
+ message: null;
3336
+ } | undefined;
3337
+ } | undefined;
3338
+ };
3339
+ } | {
3340
+ type: "survey_list";
3341
+ sort_key: number | undefined;
3342
+ meta: {
3343
+ options: string[];
3344
+ list_type: "multiple" | "single";
3345
+ display_type: "grid" | "list" | "dropdown";
3346
+ } & {
3347
+ validation?: {
3348
+ required?: {
3349
+ value: true;
3350
+ message: string;
3351
+ } | {
3352
+ value: false;
3353
+ message: null;
3354
+ } | undefined;
3355
+ } | undefined;
1458
3356
  };
1459
3357
  })[];
1460
3358
  is_live: boolean;
@@ -1469,11 +3367,34 @@ export declare class Nudge {
1469
3367
  anchor: string;
1470
3368
  } & {
1471
3369
  is_open_by_default?: boolean | undefined;
3370
+ is_showing_mask?: boolean | undefined;
3371
+ advance_trigger?: string | undefined;
1472
3372
  offset?: {
1473
3373
  x: string;
1474
3374
  y: string;
1475
3375
  } | undefined;
1476
- });
3376
+ }) | {
3377
+ type: "tooltip";
3378
+ anchor: string;
3379
+ show_on: "click" | "hover";
3380
+ marker: ({
3381
+ type: "beacon";
3382
+ } | {
3383
+ type: "icon";
3384
+ icon: "helpCircle" | "helpSquare" | "infoCircle" | "bookClosed" | "lightBulb" | "lightning";
3385
+ } | {
3386
+ type: "image";
3387
+ source: string;
3388
+ }) & {
3389
+ positioning: {
3390
+ position: "left" | "right" | "inline_left" | "inline_right";
3391
+ offset: {
3392
+ x: string;
3393
+ y: string;
3394
+ };
3395
+ };
3396
+ };
3397
+ };
1477
3398
  } & {
1478
3399
  has_survey_response?: boolean | undefined;
1479
3400
  })[];
@@ -1499,7 +3420,19 @@ export declare class Nudge {
1499
3420
  template_source: string;
1500
3421
  show_step_counter: boolean;
1501
3422
  dismissible: boolean;
1502
- share_page_url: string;
3423
+ snoozable: boolean;
3424
+ share_page_url_or_path: string;
3425
+ copilot_suggest: boolean;
3426
+ show_in_spotlight_search: boolean;
3427
+ show_in_helphub_search: boolean;
3428
+ copilot_cta_label: string;
3429
+ copilot_description: string;
3430
+ is_scheduled: boolean;
3431
+ scheduled_start_time: string | null | undefined;
3432
+ scheduled_end_time: string | null | undefined;
3433
+ snooze_label: string;
3434
+ type: "announcement" | "product_tour" | "survey" | null;
3435
+ editor_tags: string[];
1503
3436
  })[]>;
1504
3437
  static read: (arg0: string, params?: Record<string, string> | undefined, callbacks?: {
1505
3438
  onSuccess?: (() => void) | undefined;
@@ -1525,14 +3458,33 @@ export declare class Nudge {
1525
3458
  type: "on_event";
1526
3459
  meta: {
1527
3460
  event: string;
3461
+ condition_group: import("./helpers/rules").RuleExpression | null | undefined;
1528
3462
  };
1529
3463
  } | {
1530
3464
  type: "when_element_appears";
1531
3465
  meta: {
1532
3466
  selector: string;
1533
3467
  };
3468
+ } | {
3469
+ type: "on_user_confusion";
3470
+ } | {
3471
+ type: "on_rage_click";
3472
+ } | {
3473
+ type: "smart_delay";
3474
+ } | {
3475
+ type: "after_time";
3476
+ meta: {
3477
+ unit: "minute" | "second";
3478
+ value: number;
3479
+ };
1534
3480
  } | {
1535
3481
  type: "when_share_link_viewed";
3482
+ } | {
3483
+ type: "scheduled";
3484
+ meta: {
3485
+ interval: "day" | "month" | "week";
3486
+ value: number;
3487
+ };
1536
3488
  };
1537
3489
  frequency_limit: "no_limit" | "once_per_session" | "once_per_user" | "until_interaction";
1538
3490
  steps: ({
@@ -1540,11 +3492,13 @@ export declare class Nudge {
1540
3492
  title: string;
1541
3493
  content: ({
1542
3494
  type: "markdown";
3495
+ sort_key: number | undefined;
1543
3496
  meta: {
1544
3497
  value: string;
1545
3498
  };
1546
3499
  } | {
1547
3500
  type: "image";
3501
+ sort_key: number | undefined;
1548
3502
  meta: {
1549
3503
  src: string;
1550
3504
  file_name: string;
@@ -1552,6 +3506,7 @@ export declare class Nudge {
1552
3506
  };
1553
3507
  } | {
1554
3508
  type: "video";
3509
+ sort_key: number | undefined;
1555
3510
  meta: {
1556
3511
  type: "url";
1557
3512
  src: string;
@@ -1561,18 +3516,30 @@ export declare class Nudge {
1561
3516
  };
1562
3517
  } | {
1563
3518
  type: "help_doc_command";
3519
+ sort_key: number | undefined;
1564
3520
  meta: {
1565
3521
  command: string;
1566
3522
  };
1567
3523
  } | {
1568
3524
  type: "button";
3525
+ sort_key: number | undefined;
1569
3526
  meta: {
1570
3527
  label?: string | undefined;
1571
3528
  action?: {
1572
3529
  type: "execute_command";
1573
3530
  meta: {
1574
3531
  command: string;
3532
+ } & {
3533
+ type?: "link" | "video" | "action" | "helpdoc" | undefined;
1575
3534
  };
3535
+ } | {
3536
+ type: "no_action";
3537
+ } | {
3538
+ type: "click";
3539
+ value: string;
3540
+ } | {
3541
+ type: "click" | "clickBySelector" | "clickByXpath";
3542
+ value: string[];
1576
3543
  } | ({
1577
3544
  type: "link";
1578
3545
  value: string;
@@ -1581,26 +3548,125 @@ export declare class Nudge {
1581
3548
  }) | {
1582
3549
  type: "open_chat";
1583
3550
  meta: {
1584
- type: string;
3551
+ type: "" | "intercom" | "helpscout" | "freshdesk" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "hubspot" | "drift";
1585
3552
  };
1586
3553
  } | {
1587
3554
  type: "dismiss";
1588
3555
  } | {
1589
- type: "no_action";
3556
+ type: "snooze";
1590
3557
  } | {
1591
- type: "click";
1592
- value: string;
3558
+ type: "questlist";
3559
+ value: number;
3560
+ } | {
3561
+ type: "step_back";
3562
+ } | {
3563
+ type: "nudge";
3564
+ value: number;
3565
+ } | {
3566
+ type: "go_to_step";
3567
+ value: number;
3568
+ } | ({
3569
+ type: "open_bar";
3570
+ } & {
3571
+ value?: string | undefined;
3572
+ categoryFilter?: number | undefined;
3573
+ }) | {
3574
+ type: "open_helphub";
3575
+ } | {
3576
+ type: "open_copilot";
1593
3577
  } | undefined;
1594
- button_type?: "primary" | "secondary" | undefined;
3578
+ button_type?: "snooze" | "primary" | "secondary" | undefined;
3579
+ conditional_actions?: {
3580
+ operator: "eq" | "neq" | "gt" | "lt";
3581
+ operand: string | number;
3582
+ action: {
3583
+ type: "execute_command";
3584
+ meta: {
3585
+ command: string;
3586
+ } & {
3587
+ type?: "link" | "video" | "action" | "helpdoc" | undefined;
3588
+ };
3589
+ } | {
3590
+ type: "no_action";
3591
+ } | {
3592
+ type: "click";
3593
+ value: string;
3594
+ } | {
3595
+ type: "click" | "clickBySelector" | "clickByXpath";
3596
+ value: string[];
3597
+ } | ({
3598
+ type: "link";
3599
+ value: string;
3600
+ } & {
3601
+ operation?: "self" | "router" | "blank" | undefined;
3602
+ }) | {
3603
+ type: "open_chat";
3604
+ meta: {
3605
+ type: "" | "intercom" | "helpscout" | "freshdesk" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "hubspot" | "drift";
3606
+ };
3607
+ } | {
3608
+ type: "dismiss";
3609
+ } | {
3610
+ type: "snooze";
3611
+ } | {
3612
+ type: "questlist";
3613
+ value: number;
3614
+ } | {
3615
+ type: "step_back";
3616
+ } | {
3617
+ type: "nudge";
3618
+ value: number;
3619
+ } | {
3620
+ type: "go_to_step";
3621
+ value: number;
3622
+ } | ({
3623
+ type: "open_bar";
3624
+ } & {
3625
+ value?: string | undefined;
3626
+ categoryFilter?: number | undefined;
3627
+ }) | {
3628
+ type: "open_helphub";
3629
+ } | {
3630
+ type: "open_copilot";
3631
+ };
3632
+ }[] | undefined;
1595
3633
  } | null;
1596
3634
  } | {
1597
3635
  type: "survey_text";
1598
3636
  meta: {
1599
3637
  prompt: string;
3638
+ } & {
3639
+ validation?: {
3640
+ required?: {
3641
+ value: true;
3642
+ message: string;
3643
+ } | {
3644
+ value: false;
3645
+ message: null;
3646
+ } | undefined;
3647
+ } | undefined;
1600
3648
  };
3649
+ sort_key: number | undefined;
1601
3650
  } | {
1602
- type: "survey_rating";
3651
+ type: "survey_text_short";
1603
3652
  meta: {
3653
+ prompt: string;
3654
+ } & {
3655
+ validation?: {
3656
+ required?: {
3657
+ value: true;
3658
+ message: string;
3659
+ } | {
3660
+ value: false;
3661
+ message: null;
3662
+ } | undefined;
3663
+ } | undefined;
3664
+ };
3665
+ sort_key: number | undefined;
3666
+ } | {
3667
+ type: "survey_rating";
3668
+ sort_key: number | undefined;
3669
+ meta: ({
1604
3670
  type: "emojis";
1605
3671
  lower_label: string;
1606
3672
  upper_label: string;
@@ -1616,6 +3682,34 @@ export declare class Nudge {
1616
3682
  lower_label: string;
1617
3683
  upper_label: string;
1618
3684
  options: number;
3685
+ }) & {
3686
+ validation?: {
3687
+ required?: {
3688
+ value: true;
3689
+ message: string;
3690
+ } | {
3691
+ value: false;
3692
+ message: null;
3693
+ } | undefined;
3694
+ } | undefined;
3695
+ };
3696
+ } | {
3697
+ type: "survey_list";
3698
+ sort_key: number | undefined;
3699
+ meta: {
3700
+ options: string[];
3701
+ list_type: "multiple" | "single";
3702
+ display_type: "grid" | "list" | "dropdown";
3703
+ } & {
3704
+ validation?: {
3705
+ required?: {
3706
+ value: true;
3707
+ message: string;
3708
+ } | {
3709
+ value: false;
3710
+ message: null;
3711
+ } | undefined;
3712
+ } | undefined;
1619
3713
  };
1620
3714
  })[];
1621
3715
  is_live: boolean;
@@ -1630,11 +3724,34 @@ export declare class Nudge {
1630
3724
  anchor: string;
1631
3725
  } & {
1632
3726
  is_open_by_default?: boolean | undefined;
3727
+ is_showing_mask?: boolean | undefined;
3728
+ advance_trigger?: string | undefined;
1633
3729
  offset?: {
1634
3730
  x: string;
1635
3731
  y: string;
1636
3732
  } | undefined;
1637
- });
3733
+ }) | {
3734
+ type: "tooltip";
3735
+ anchor: string;
3736
+ show_on: "click" | "hover";
3737
+ marker: ({
3738
+ type: "beacon";
3739
+ } | {
3740
+ type: "icon";
3741
+ icon: "helpCircle" | "helpSquare" | "infoCircle" | "bookClosed" | "lightBulb" | "lightning";
3742
+ } | {
3743
+ type: "image";
3744
+ source: string;
3745
+ }) & {
3746
+ positioning: {
3747
+ position: "left" | "right" | "inline_left" | "inline_right";
3748
+ offset: {
3749
+ x: string;
3750
+ y: string;
3751
+ };
3752
+ };
3753
+ };
3754
+ };
1638
3755
  } & {
1639
3756
  has_survey_response?: boolean | undefined;
1640
3757
  })[];
@@ -1660,7 +3777,19 @@ export declare class Nudge {
1660
3777
  template_source: string;
1661
3778
  show_step_counter: boolean;
1662
3779
  dismissible: boolean;
1663
- share_page_url: string;
3780
+ snoozable: boolean;
3781
+ share_page_url_or_path: string;
3782
+ copilot_suggest: boolean;
3783
+ show_in_spotlight_search: boolean;
3784
+ show_in_helphub_search: boolean;
3785
+ copilot_cta_label: string;
3786
+ copilot_description: string;
3787
+ is_scheduled: boolean;
3788
+ scheduled_start_time: string | null | undefined;
3789
+ scheduled_end_time: string | null | undefined;
3790
+ snooze_label: string;
3791
+ type: "announcement" | "product_tour" | "survey" | null;
3792
+ editor_tags: string[];
1664
3793
  }>;
1665
3794
  /**
1666
3795
  * Returns true if the nudge is new (not yet saved to the backend)