commandbar 1.9.0 → 1.10.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (50) hide show
  1. package/build/{internal/src/client → commandbar/src/shared/services/analytics}/EventHandler.d.ts +32 -10
  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 +4 -0
  6. package/build/internal/src/client/CommandBarClientSDK.d.ts +46 -13
  7. package/build/internal/src/client/CommandBarSDK.d.ts +15 -10
  8. package/build/internal/src/client/SDKConfig.d.ts +3 -2
  9. package/build/internal/src/client/symbols.d.ts +3 -1
  10. package/build/internal/src/middleware/CommandFromClientV.d.ts +22 -10
  11. package/build/internal/src/middleware/IRecordSettings.d.ts +3 -0
  12. package/build/internal/src/middleware/OrganizationV.d.ts +200 -6
  13. package/build/internal/src/middleware/{ResourceSettingsV.d.ts → RecordSettingsV.d.ts} +2 -2
  14. package/build/internal/src/middleware/additionalResource.d.ts +96 -15
  15. package/build/internal/src/middleware/billing.d.ts +0 -2
  16. package/build/internal/src/middleware/chat.d.ts +2196 -176
  17. package/build/internal/src/middleware/checklist.d.ts +504 -63
  18. package/build/internal/src/middleware/command.d.ts +1809 -385
  19. package/build/internal/src/middleware/endUser.d.ts +33 -5
  20. package/build/internal/src/middleware/entityChanges.d.ts +17 -0
  21. package/build/internal/src/middleware/experienceTemplate.d.ts +59 -0
  22. package/build/internal/src/middleware/experiencesSearch.d.ts +3579 -0
  23. package/build/internal/src/middleware/flags.d.ts +20 -0
  24. package/build/internal/src/middleware/helpDocsIntegration.d.ts +9 -0
  25. package/build/internal/src/middleware/helpDocsSearch.d.ts +371 -35
  26. package/build/internal/src/middleware/helpers/actions.d.ts +66 -16
  27. package/build/internal/src/middleware/helpers/commandTemplate.d.ts +70 -8
  28. package/build/internal/src/middleware/helpers/copilotPersonality.d.ts +12 -0
  29. package/build/internal/src/middleware/helpers/goals.d.ts +4 -2
  30. package/build/internal/src/middleware/helpers/pushTrigger.d.ts +22 -0
  31. package/build/internal/src/middleware/helpers/rules.d.ts +45 -36
  32. package/build/internal/src/middleware/network.d.ts +9 -0
  33. package/build/internal/src/middleware/nudge.d.ts +1103 -124
  34. package/build/internal/src/middleware/organization.d.ts +1295 -68
  35. package/build/internal/src/middleware/organizationSettings.d.ts +320 -12
  36. package/build/internal/src/middleware/profile.d.ts +2 -0
  37. package/build/internal/src/middleware/recommendationSet.d.ts +96 -15
  38. package/build/internal/src/middleware/releases.d.ts +1 -1
  39. package/build/internal/src/middleware/theme.d.ts +425 -0
  40. package/build/internal/src/middleware/types.d.ts +51 -15
  41. package/build/internal/src/middleware/user.d.ts +1 -0
  42. package/build/internal/src/util/dispatchCustomEvent.d.ts +3 -3
  43. package/build/internal/src/util/operatingSystem.d.ts +2 -4
  44. package/package.json +1 -1
  45. package/src/index.ts +2 -2
  46. package/src/init.ts +11 -6
  47. package/src/snippet.ts +2 -2
  48. package/build/internal/src/client/AnalyticsEventTypes.d.ts +0 -1
  49. package/build/internal/src/middleware/IResourceSettings.d.ts +0 -3
  50. package/build/internal/src/middleware/dashboardFlags.d.ts +0 -9
package/build/internal/src/middleware/nudge.d.ts CHANGED
@@ -29,11 +29,21 @@ export declare const NudgeContentVideoBlockV: t.TypeC<{
29
29
  export declare const NudgeContentListBlockV: t.TypeC<{
30
30
  type: t.LiteralC<"survey_list">;
31
31
  sort_key: t.UnionC<[t.NumberC, t.UndefinedC]>;
32
- meta: t.TypeC<{
32
+ meta: t.IntersectionC<[t.TypeC<{
33
33
  options: t.ArrayC<t.StringC>;
34
34
  list_type: t.UnionC<[t.LiteralC<"single">, t.LiteralC<"multiple">]>;
35
35
  display_type: t.UnionC<[t.LiteralC<"dropdown">, t.LiteralC<"list">, t.LiteralC<"grid">]>;
36
- }>;
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
+ }>]>;
37
47
  }>;
38
48
  export declare const NudgeContentHelpDocBlockV: t.TypeC<{
39
49
  type: t.LiteralC<"help_doc_command">;
@@ -44,14 +54,19 @@ export declare const NudgeContentHelpDocBlockV: t.TypeC<{
44
54
  }>;
45
55
  export declare const NudgeButtonActionV: t.UnionC<[t.TypeC<{
46
56
  type: t.LiteralC<"execute_command">;
47
- meta: t.TypeC<{
57
+ meta: t.IntersectionC<[t.TypeC<{
48
58
  command: t.StringC;
49
- }>;
59
+ }>, t.PartialC<{
60
+ type: t.UnionC<[t.LiteralC<"action">, t.LiteralC<"link">, t.LiteralC<"helpdoc">, t.LiteralC<"video">]>;
61
+ }>]>;
50
62
  }>, t.TypeC<{
51
63
  type: t.LiteralC<"no_action">;
52
64
  }>, t.TypeC<{
53
65
  type: t.LiteralC<"click">;
54
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>;
55
70
  }>, t.IntersectionC<[t.TypeC<{
56
71
  type: t.LiteralC<"link">;
57
72
  value: t.StringC;
@@ -60,7 +75,7 @@ export declare const NudgeButtonActionV: t.UnionC<[t.TypeC<{
60
75
  }>]>, t.TypeC<{
61
76
  type: t.LiteralC<"open_chat">;
62
77
  meta: t.TypeC<{
63
- type: t.StringC;
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<"">]>;
64
79
  }>;
65
80
  }>, t.TypeC<{
66
81
  type: t.LiteralC<"dismiss">;
@@ -82,20 +97,29 @@ export declare const NudgeButtonActionV: t.UnionC<[t.TypeC<{
82
97
  }>, t.PartialC<{
83
98
  value: t.StringC;
84
99
  categoryFilter: t.NumberC;
85
- }>]>]>;
100
+ }>]>, t.TypeC<{
101
+ type: t.LiteralC<"open_helphub">;
102
+ }>, t.TypeC<{
103
+ type: t.LiteralC<"open_copilot">;
104
+ }>]>;
86
105
  export declare const NudgeConditionalActionV: t.TypeC<{
87
106
  operator: t.UnionC<[t.LiteralC<"eq">, t.LiteralC<"neq">, t.LiteralC<"gt">, t.LiteralC<"lt">]>;
88
107
  operand: t.UnionC<[t.StringC, t.NumberC]>;
89
108
  action: t.UnionC<[t.TypeC<{
90
109
  type: t.LiteralC<"execute_command">;
91
- meta: t.TypeC<{
110
+ meta: t.IntersectionC<[t.TypeC<{
92
111
  command: t.StringC;
93
- }>;
112
+ }>, t.PartialC<{
113
+ type: t.UnionC<[t.LiteralC<"action">, t.LiteralC<"link">, t.LiteralC<"helpdoc">, t.LiteralC<"video">]>;
114
+ }>]>;
94
115
  }>, t.TypeC<{
95
116
  type: t.LiteralC<"no_action">;
96
117
  }>, t.TypeC<{
97
118
  type: t.LiteralC<"click">;
98
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>;
99
123
  }>, t.IntersectionC<[t.TypeC<{
100
124
  type: t.LiteralC<"link">;
101
125
  value: t.StringC;
@@ -104,7 +128,7 @@ export declare const NudgeConditionalActionV: t.TypeC<{
104
128
  }>]>, t.TypeC<{
105
129
  type: t.LiteralC<"open_chat">;
106
130
  meta: t.TypeC<{
107
- type: t.StringC;
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<"">]>;
108
132
  }>;
109
133
  }>, t.TypeC<{
110
134
  type: t.LiteralC<"dismiss">;
@@ -126,7 +150,11 @@ export declare const NudgeConditionalActionV: t.TypeC<{
126
150
  }>, t.PartialC<{
127
151
  value: t.StringC;
128
152
  categoryFilter: t.NumberC;
129
- }>]>]>;
153
+ }>]>, t.TypeC<{
154
+ type: t.LiteralC<"open_helphub">;
155
+ }>, t.TypeC<{
156
+ type: t.LiteralC<"open_copilot">;
157
+ }>]>;
130
158
  }>;
131
159
  export declare const NudgeContentButtonBlockV: t.TypeC<{
132
160
  type: t.LiteralC<"button">;
@@ -135,14 +163,19 @@ export declare const NudgeContentButtonBlockV: t.TypeC<{
135
163
  label: t.StringC;
136
164
  action: t.UnionC<[t.TypeC<{
137
165
  type: t.LiteralC<"execute_command">;
138
- meta: t.TypeC<{
166
+ meta: t.IntersectionC<[t.TypeC<{
139
167
  command: t.StringC;
140
- }>;
168
+ }>, t.PartialC<{
169
+ type: t.UnionC<[t.LiteralC<"action">, t.LiteralC<"link">, t.LiteralC<"helpdoc">, t.LiteralC<"video">]>;
170
+ }>]>;
141
171
  }>, t.TypeC<{
142
172
  type: t.LiteralC<"no_action">;
143
173
  }>, t.TypeC<{
144
174
  type: t.LiteralC<"click">;
145
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>;
146
179
  }>, t.IntersectionC<[t.TypeC<{
147
180
  type: t.LiteralC<"link">;
148
181
  value: t.StringC;
@@ -151,7 +184,7 @@ export declare const NudgeContentButtonBlockV: t.TypeC<{
151
184
  }>]>, t.TypeC<{
152
185
  type: t.LiteralC<"open_chat">;
153
186
  meta: t.TypeC<{
154
- 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<"">]>;
155
188
  }>;
156
189
  }>, t.TypeC<{
157
190
  type: t.LiteralC<"dismiss">;
@@ -173,21 +206,30 @@ export declare const NudgeContentButtonBlockV: t.TypeC<{
173
206
  }>, t.PartialC<{
174
207
  value: t.StringC;
175
208
  categoryFilter: t.NumberC;
176
- }>]>]>;
209
+ }>]>, t.TypeC<{
210
+ type: t.LiteralC<"open_helphub">;
211
+ }>, t.TypeC<{
212
+ type: t.LiteralC<"open_copilot">;
213
+ }>]>;
177
214
  button_type: t.UnionC<[t.LiteralC<"primary">, t.LiteralC<"secondary">, t.LiteralC<"snooze">]>;
178
215
  conditional_actions: t.ArrayC<t.TypeC<{
179
216
  operator: t.UnionC<[t.LiteralC<"eq">, t.LiteralC<"neq">, t.LiteralC<"gt">, t.LiteralC<"lt">]>;
180
217
  operand: t.UnionC<[t.StringC, t.NumberC]>;
181
218
  action: t.UnionC<[t.TypeC<{
182
219
  type: t.LiteralC<"execute_command">;
183
- meta: t.TypeC<{
220
+ meta: t.IntersectionC<[t.TypeC<{
184
221
  command: t.StringC;
185
- }>;
222
+ }>, t.PartialC<{
223
+ type: t.UnionC<[t.LiteralC<"action">, t.LiteralC<"link">, t.LiteralC<"helpdoc">, t.LiteralC<"video">]>;
224
+ }>]>;
186
225
  }>, t.TypeC<{
187
226
  type: t.LiteralC<"no_action">;
188
227
  }>, t.TypeC<{
189
228
  type: t.LiteralC<"click">;
190
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>;
191
233
  }>, t.IntersectionC<[t.TypeC<{
192
234
  type: t.LiteralC<"link">;
193
235
  value: t.StringC;
@@ -196,7 +238,7 @@ export declare const NudgeContentButtonBlockV: t.TypeC<{
196
238
  }>]>, t.TypeC<{
197
239
  type: t.LiteralC<"open_chat">;
198
240
  meta: t.TypeC<{
199
- type: t.StringC;
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<"">]>;
200
242
  }>;
201
243
  }>, t.TypeC<{
202
244
  type: t.LiteralC<"dismiss">;
@@ -218,28 +260,52 @@ export declare const NudgeContentButtonBlockV: t.TypeC<{
218
260
  }>, t.PartialC<{
219
261
  value: t.StringC;
220
262
  categoryFilter: t.NumberC;
221
- }>]>]>;
263
+ }>]>, t.TypeC<{
264
+ type: t.LiteralC<"open_helphub">;
265
+ }>, t.TypeC<{
266
+ type: t.LiteralC<"open_copilot">;
267
+ }>]>;
222
268
  }>>;
223
269
  }>, t.NullC]>;
224
270
  }>;
225
271
  export declare const NudgeContentSurveyTextBlockV: t.TypeC<{
226
272
  type: t.LiteralC<"survey_text">;
227
- meta: t.TypeC<{
273
+ meta: t.IntersectionC<[t.TypeC<{
228
274
  prompt: t.StringC;
229
- }>;
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
+ }>]>;
230
286
  sort_key: t.UnionC<[t.NumberC, t.UndefinedC]>;
231
287
  }>;
232
288
  export declare const NudgeStepContentSurveyTextShortBlockTypeV: t.TypeC<{
233
289
  type: t.LiteralC<"survey_text_short">;
234
- meta: t.TypeC<{
290
+ meta: t.IntersectionC<[t.TypeC<{
235
291
  prompt: t.StringC;
236
- }>;
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
+ }>]>;
237
303
  sort_key: t.UnionC<[t.NumberC, t.UndefinedC]>;
238
304
  }>;
239
305
  export declare const NudgeContentSurveyRatingBlockV: t.TypeC<{
240
306
  type: t.LiteralC<"survey_rating">;
241
307
  sort_key: t.UnionC<[t.NumberC, t.UndefinedC]>;
242
- meta: t.UnionC<[t.TypeC<{
308
+ meta: t.IntersectionC<[t.UnionC<[t.TypeC<{
243
309
  type: t.LiteralC<"emojis">;
244
310
  lower_label: t.StringC;
245
311
  upper_label: t.StringC;
@@ -255,6 +321,16 @@ export declare const NudgeContentSurveyRatingBlockV: t.TypeC<{
255
321
  lower_label: t.StringC;
256
322
  upper_label: t.StringC;
257
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
+ }>;
258
334
  }>]>;
259
335
  }>;
260
336
  export declare const NudgeContentBlockV: t.UnionC<[t.TypeC<{
@@ -294,14 +370,19 @@ export declare const NudgeContentBlockV: t.UnionC<[t.TypeC<{
294
370
  label: t.StringC;
295
371
  action: t.UnionC<[t.TypeC<{
296
372
  type: t.LiteralC<"execute_command">;
297
- meta: t.TypeC<{
373
+ meta: t.IntersectionC<[t.TypeC<{
298
374
  command: t.StringC;
299
- }>;
375
+ }>, t.PartialC<{
376
+ type: t.UnionC<[t.LiteralC<"action">, t.LiteralC<"link">, t.LiteralC<"helpdoc">, t.LiteralC<"video">]>;
377
+ }>]>;
300
378
  }>, t.TypeC<{
301
379
  type: t.LiteralC<"no_action">;
302
380
  }>, t.TypeC<{
303
381
  type: t.LiteralC<"click">;
304
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>;
305
386
  }>, t.IntersectionC<[t.TypeC<{
306
387
  type: t.LiteralC<"link">;
307
388
  value: t.StringC;
@@ -310,7 +391,7 @@ export declare const NudgeContentBlockV: t.UnionC<[t.TypeC<{
310
391
  }>]>, t.TypeC<{
311
392
  type: t.LiteralC<"open_chat">;
312
393
  meta: t.TypeC<{
313
- 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<"">]>;
314
395
  }>;
315
396
  }>, t.TypeC<{
316
397
  type: t.LiteralC<"dismiss">;
@@ -332,21 +413,30 @@ export declare const NudgeContentBlockV: t.UnionC<[t.TypeC<{
332
413
  }>, t.PartialC<{
333
414
  value: t.StringC;
334
415
  categoryFilter: t.NumberC;
335
- }>]>]>;
416
+ }>]>, t.TypeC<{
417
+ type: t.LiteralC<"open_helphub">;
418
+ }>, t.TypeC<{
419
+ type: t.LiteralC<"open_copilot">;
420
+ }>]>;
336
421
  button_type: t.UnionC<[t.LiteralC<"primary">, t.LiteralC<"secondary">, t.LiteralC<"snooze">]>;
337
422
  conditional_actions: t.ArrayC<t.TypeC<{
338
423
  operator: t.UnionC<[t.LiteralC<"eq">, t.LiteralC<"neq">, t.LiteralC<"gt">, t.LiteralC<"lt">]>;
339
424
  operand: t.UnionC<[t.StringC, t.NumberC]>;
340
425
  action: t.UnionC<[t.TypeC<{
341
426
  type: t.LiteralC<"execute_command">;
342
- meta: t.TypeC<{
427
+ meta: t.IntersectionC<[t.TypeC<{
343
428
  command: t.StringC;
344
- }>;
429
+ }>, t.PartialC<{
430
+ type: t.UnionC<[t.LiteralC<"action">, t.LiteralC<"link">, t.LiteralC<"helpdoc">, t.LiteralC<"video">]>;
431
+ }>]>;
345
432
  }>, t.TypeC<{
346
433
  type: t.LiteralC<"no_action">;
347
434
  }>, t.TypeC<{
348
435
  type: t.LiteralC<"click">;
349
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>;
350
440
  }>, t.IntersectionC<[t.TypeC<{
351
441
  type: t.LiteralC<"link">;
352
442
  value: t.StringC;
@@ -355,7 +445,7 @@ export declare const NudgeContentBlockV: t.UnionC<[t.TypeC<{
355
445
  }>]>, t.TypeC<{
356
446
  type: t.LiteralC<"open_chat">;
357
447
  meta: t.TypeC<{
358
- type: t.StringC;
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<"">]>;
359
449
  }>;
360
450
  }>, t.TypeC<{
361
451
  type: t.LiteralC<"dismiss">;
@@ -377,25 +467,49 @@ export declare const NudgeContentBlockV: t.UnionC<[t.TypeC<{
377
467
  }>, t.PartialC<{
378
468
  value: t.StringC;
379
469
  categoryFilter: t.NumberC;
380
- }>]>]>;
470
+ }>]>, t.TypeC<{
471
+ type: t.LiteralC<"open_helphub">;
472
+ }>, t.TypeC<{
473
+ type: t.LiteralC<"open_copilot">;
474
+ }>]>;
381
475
  }>>;
382
476
  }>, t.NullC]>;
383
477
  }>, t.TypeC<{
384
478
  type: t.LiteralC<"survey_text">;
385
- meta: t.TypeC<{
479
+ meta: t.IntersectionC<[t.TypeC<{
386
480
  prompt: t.StringC;
387
- }>;
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
+ }>]>;
388
492
  sort_key: t.UnionC<[t.NumberC, t.UndefinedC]>;
389
493
  }>, t.TypeC<{
390
494
  type: t.LiteralC<"survey_text_short">;
391
- meta: t.TypeC<{
495
+ meta: t.IntersectionC<[t.TypeC<{
392
496
  prompt: t.StringC;
393
- }>;
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
+ }>]>;
394
508
  sort_key: t.UnionC<[t.NumberC, t.UndefinedC]>;
395
509
  }>, t.TypeC<{
396
510
  type: t.LiteralC<"survey_rating">;
397
511
  sort_key: t.UnionC<[t.NumberC, t.UndefinedC]>;
398
- meta: t.UnionC<[t.TypeC<{
512
+ meta: t.IntersectionC<[t.UnionC<[t.TypeC<{
399
513
  type: t.LiteralC<"emojis">;
400
514
  lower_label: t.StringC;
401
515
  upper_label: t.StringC;
@@ -411,15 +525,35 @@ export declare const NudgeContentBlockV: t.UnionC<[t.TypeC<{
411
525
  lower_label: t.StringC;
412
526
  upper_label: t.StringC;
413
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
+ }>;
414
538
  }>]>;
415
539
  }>, t.TypeC<{
416
540
  type: t.LiteralC<"survey_list">;
417
541
  sort_key: t.UnionC<[t.NumberC, t.UndefinedC]>;
418
- meta: t.TypeC<{
542
+ meta: t.IntersectionC<[t.TypeC<{
419
543
  options: t.ArrayC<t.StringC>;
420
544
  list_type: t.UnionC<[t.LiteralC<"single">, t.LiteralC<"multiple">]>;
421
545
  display_type: t.UnionC<[t.LiteralC<"dropdown">, t.LiteralC<"list">, t.LiteralC<"grid">]>;
422
- }>;
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
+ }>;
556
+ }>]>;
423
557
  }>]>;
424
558
  export declare const NudgeStepV: t.IntersectionC<[t.TypeC<{
425
559
  id: t.NumberC;
@@ -461,14 +595,19 @@ export declare const NudgeStepV: t.IntersectionC<[t.TypeC<{
461
595
  label: t.StringC;
462
596
  action: t.UnionC<[t.TypeC<{
463
597
  type: t.LiteralC<"execute_command">;
464
- meta: t.TypeC<{
598
+ meta: t.IntersectionC<[t.TypeC<{
465
599
  command: t.StringC;
466
- }>;
600
+ }>, t.PartialC<{
601
+ type: t.UnionC<[t.LiteralC<"action">, t.LiteralC<"link">, t.LiteralC<"helpdoc">, t.LiteralC<"video">]>;
602
+ }>]>;
467
603
  }>, t.TypeC<{
468
604
  type: t.LiteralC<"no_action">;
469
605
  }>, t.TypeC<{
470
606
  type: t.LiteralC<"click">;
471
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>;
472
611
  }>, t.IntersectionC<[t.TypeC<{
473
612
  type: t.LiteralC<"link">;
474
613
  value: t.StringC;
@@ -477,7 +616,7 @@ export declare const NudgeStepV: t.IntersectionC<[t.TypeC<{
477
616
  }>]>, t.TypeC<{
478
617
  type: t.LiteralC<"open_chat">;
479
618
  meta: t.TypeC<{
480
- 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<"">]>;
481
620
  }>;
482
621
  }>, t.TypeC<{
483
622
  type: t.LiteralC<"dismiss">;
@@ -499,21 +638,30 @@ export declare const NudgeStepV: t.IntersectionC<[t.TypeC<{
499
638
  }>, t.PartialC<{
500
639
  value: t.StringC;
501
640
  categoryFilter: t.NumberC;
502
- }>]>]>;
641
+ }>]>, t.TypeC<{
642
+ type: t.LiteralC<"open_helphub">;
643
+ }>, t.TypeC<{
644
+ type: t.LiteralC<"open_copilot">;
645
+ }>]>;
503
646
  button_type: t.UnionC<[t.LiteralC<"primary">, t.LiteralC<"secondary">, t.LiteralC<"snooze">]>;
504
647
  conditional_actions: t.ArrayC<t.TypeC<{
505
648
  operator: t.UnionC<[t.LiteralC<"eq">, t.LiteralC<"neq">, t.LiteralC<"gt">, t.LiteralC<"lt">]>;
506
649
  operand: t.UnionC<[t.StringC, t.NumberC]>;
507
650
  action: t.UnionC<[t.TypeC<{
508
651
  type: t.LiteralC<"execute_command">;
509
- meta: t.TypeC<{
652
+ meta: t.IntersectionC<[t.TypeC<{
510
653
  command: t.StringC;
511
- }>;
654
+ }>, t.PartialC<{
655
+ type: t.UnionC<[t.LiteralC<"action">, t.LiteralC<"link">, t.LiteralC<"helpdoc">, t.LiteralC<"video">]>;
656
+ }>]>;
512
657
  }>, t.TypeC<{
513
658
  type: t.LiteralC<"no_action">;
514
659
  }>, t.TypeC<{
515
660
  type: t.LiteralC<"click">;
516
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>;
517
665
  }>, t.IntersectionC<[t.TypeC<{
518
666
  type: t.LiteralC<"link">;
519
667
  value: t.StringC;
@@ -522,7 +670,7 @@ export declare const NudgeStepV: t.IntersectionC<[t.TypeC<{
522
670
  }>]>, t.TypeC<{
523
671
  type: t.LiteralC<"open_chat">;
524
672
  meta: t.TypeC<{
525
- type: t.StringC;
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<"">]>;
526
674
  }>;
527
675
  }>, t.TypeC<{
528
676
  type: t.LiteralC<"dismiss">;
@@ -544,25 +692,49 @@ export declare const NudgeStepV: t.IntersectionC<[t.TypeC<{
544
692
  }>, t.PartialC<{
545
693
  value: t.StringC;
546
694
  categoryFilter: t.NumberC;
547
- }>]>]>;
695
+ }>]>, t.TypeC<{
696
+ type: t.LiteralC<"open_helphub">;
697
+ }>, t.TypeC<{
698
+ type: t.LiteralC<"open_copilot">;
699
+ }>]>;
548
700
  }>>;
549
701
  }>, t.NullC]>;
550
702
  }>, t.TypeC<{
551
703
  type: t.LiteralC<"survey_text">;
552
- meta: t.TypeC<{
704
+ meta: t.IntersectionC<[t.TypeC<{
553
705
  prompt: t.StringC;
554
- }>;
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
+ }>]>;
555
717
  sort_key: t.UnionC<[t.NumberC, t.UndefinedC]>;
556
718
  }>, t.TypeC<{
557
719
  type: t.LiteralC<"survey_text_short">;
558
- meta: t.TypeC<{
720
+ meta: t.IntersectionC<[t.TypeC<{
559
721
  prompt: t.StringC;
560
- }>;
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
+ }>]>;
561
733
  sort_key: t.UnionC<[t.NumberC, t.UndefinedC]>;
562
734
  }>, t.TypeC<{
563
735
  type: t.LiteralC<"survey_rating">;
564
736
  sort_key: t.UnionC<[t.NumberC, t.UndefinedC]>;
565
- meta: t.UnionC<[t.TypeC<{
737
+ meta: t.IntersectionC<[t.UnionC<[t.TypeC<{
566
738
  type: t.LiteralC<"emojis">;
567
739
  lower_label: t.StringC;
568
740
  upper_label: t.StringC;
@@ -578,15 +750,35 @@ export declare const NudgeStepV: t.IntersectionC<[t.TypeC<{
578
750
  lower_label: t.StringC;
579
751
  upper_label: t.StringC;
580
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
+ }>;
581
763
  }>]>;
582
764
  }>, t.TypeC<{
583
765
  type: t.LiteralC<"survey_list">;
584
766
  sort_key: t.UnionC<[t.NumberC, t.UndefinedC]>;
585
- meta: t.TypeC<{
767
+ meta: t.IntersectionC<[t.TypeC<{
586
768
  options: t.ArrayC<t.StringC>;
587
769
  list_type: t.UnionC<[t.LiteralC<"single">, t.LiteralC<"multiple">]>;
588
770
  display_type: t.UnionC<[t.LiteralC<"dropdown">, t.LiteralC<"list">, t.LiteralC<"grid">]>;
589
- }>;
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
+ }>;
781
+ }>]>;
590
782
  }>]>>;
591
783
  is_live: t.BooleanC;
592
784
  }>, t.IntersectionC<[t.TypeC<{
@@ -606,7 +798,28 @@ export declare const NudgeStepV: t.IntersectionC<[t.TypeC<{
606
798
  x: t.StringC;
607
799
  y: t.StringC;
608
800
  }>;
609
- }>]>]>;
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
+ }>]>;
610
823
  }>, t.PartialC<{
611
824
  has_survey_response: t.BooleanC;
612
825
  }>]>]>;
@@ -631,6 +844,7 @@ export declare const NudgeV: t.IntersectionC<[t.IntersectionC<[t.TypeC<{
631
844
  type: t.LiteralC<"on_event">;
632
845
  meta: t.TypeC<{
633
846
  event: t.StringC;
847
+ condition_group: t.UnionC<[t.Type<import("./helpers/rules").RuleExpression, import("./helpers/rules").RuleExpression, unknown>, t.NullC, t.UndefinedC]>;
634
848
  }>;
635
849
  }>, t.TypeC<{
636
850
  type: t.LiteralC<"when_element_appears">;
@@ -643,8 +857,20 @@ export declare const NudgeV: t.IntersectionC<[t.IntersectionC<[t.TypeC<{
643
857
  type: t.LiteralC<"on_rage_click">;
644
858
  }>, t.TypeC<{
645
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
+ }>;
646
866
  }>, t.TypeC<{
647
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
+ }>;
648
874
  }>]>;
649
875
  frequency_limit: t.UnionC<[t.LiteralC<"no_limit">, t.LiteralC<"once_per_session">, t.LiteralC<"once_per_user">, t.LiteralC<"until_interaction">]>;
650
876
  steps: t.ArrayC<t.IntersectionC<[t.TypeC<{
@@ -687,14 +913,19 @@ export declare const NudgeV: t.IntersectionC<[t.IntersectionC<[t.TypeC<{
687
913
  label: t.StringC;
688
914
  action: t.UnionC<[t.TypeC<{
689
915
  type: t.LiteralC<"execute_command">;
690
- meta: t.TypeC<{
916
+ meta: t.IntersectionC<[t.TypeC<{
691
917
  command: t.StringC;
692
- }>;
918
+ }>, t.PartialC<{
919
+ type: t.UnionC<[t.LiteralC<"action">, t.LiteralC<"link">, t.LiteralC<"helpdoc">, t.LiteralC<"video">]>;
920
+ }>]>;
693
921
  }>, t.TypeC<{
694
922
  type: t.LiteralC<"no_action">;
695
923
  }>, t.TypeC<{
696
924
  type: t.LiteralC<"click">;
697
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>;
698
929
  }>, t.IntersectionC<[t.TypeC<{
699
930
  type: t.LiteralC<"link">;
700
931
  value: t.StringC;
@@ -703,7 +934,7 @@ export declare const NudgeV: t.IntersectionC<[t.IntersectionC<[t.TypeC<{
703
934
  }>]>, t.TypeC<{
704
935
  type: t.LiteralC<"open_chat">;
705
936
  meta: t.TypeC<{
706
- 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<"">]>;
707
938
  }>;
708
939
  }>, t.TypeC<{
709
940
  type: t.LiteralC<"dismiss">;
@@ -725,21 +956,30 @@ export declare const NudgeV: t.IntersectionC<[t.IntersectionC<[t.TypeC<{
725
956
  }>, t.PartialC<{
726
957
  value: t.StringC;
727
958
  categoryFilter: t.NumberC;
728
- }>]>]>;
959
+ }>]>, t.TypeC<{
960
+ type: t.LiteralC<"open_helphub">;
961
+ }>, t.TypeC<{
962
+ type: t.LiteralC<"open_copilot">;
963
+ }>]>;
729
964
  button_type: t.UnionC<[t.LiteralC<"primary">, t.LiteralC<"secondary">, t.LiteralC<"snooze">]>;
730
965
  conditional_actions: t.ArrayC<t.TypeC<{
731
966
  operator: t.UnionC<[t.LiteralC<"eq">, t.LiteralC<"neq">, t.LiteralC<"gt">, t.LiteralC<"lt">]>;
732
967
  operand: t.UnionC<[t.StringC, t.NumberC]>;
733
968
  action: t.UnionC<[t.TypeC<{
734
969
  type: t.LiteralC<"execute_command">;
735
- meta: t.TypeC<{
970
+ meta: t.IntersectionC<[t.TypeC<{
736
971
  command: t.StringC;
737
- }>;
972
+ }>, t.PartialC<{
973
+ type: t.UnionC<[t.LiteralC<"action">, t.LiteralC<"link">, t.LiteralC<"helpdoc">, t.LiteralC<"video">]>;
974
+ }>]>;
738
975
  }>, t.TypeC<{
739
976
  type: t.LiteralC<"no_action">;
740
977
  }>, t.TypeC<{
741
978
  type: t.LiteralC<"click">;
742
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>;
743
983
  }>, t.IntersectionC<[t.TypeC<{
744
984
  type: t.LiteralC<"link">;
745
985
  value: t.StringC;
@@ -748,7 +988,7 @@ export declare const NudgeV: t.IntersectionC<[t.IntersectionC<[t.TypeC<{
748
988
  }>]>, t.TypeC<{
749
989
  type: t.LiteralC<"open_chat">;
750
990
  meta: t.TypeC<{
751
- type: t.StringC;
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<"">]>;
752
992
  }>;
753
993
  }>, t.TypeC<{
754
994
  type: t.LiteralC<"dismiss">;
@@ -770,25 +1010,49 @@ export declare const NudgeV: t.IntersectionC<[t.IntersectionC<[t.TypeC<{
770
1010
  }>, t.PartialC<{
771
1011
  value: t.StringC;
772
1012
  categoryFilter: t.NumberC;
773
- }>]>]>;
1013
+ }>]>, t.TypeC<{
1014
+ type: t.LiteralC<"open_helphub">;
1015
+ }>, t.TypeC<{
1016
+ type: t.LiteralC<"open_copilot">;
1017
+ }>]>;
774
1018
  }>>;
775
1019
  }>, t.NullC]>;
776
1020
  }>, t.TypeC<{
777
1021
  type: t.LiteralC<"survey_text">;
778
- meta: t.TypeC<{
1022
+ meta: t.IntersectionC<[t.TypeC<{
779
1023
  prompt: t.StringC;
780
- }>;
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
+ }>]>;
781
1035
  sort_key: t.UnionC<[t.NumberC, t.UndefinedC]>;
782
1036
  }>, t.TypeC<{
783
1037
  type: t.LiteralC<"survey_text_short">;
784
- meta: t.TypeC<{
1038
+ meta: t.IntersectionC<[t.TypeC<{
785
1039
  prompt: t.StringC;
786
- }>;
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
+ }>]>;
787
1051
  sort_key: t.UnionC<[t.NumberC, t.UndefinedC]>;
788
1052
  }>, t.TypeC<{
789
1053
  type: t.LiteralC<"survey_rating">;
790
1054
  sort_key: t.UnionC<[t.NumberC, t.UndefinedC]>;
791
- meta: t.UnionC<[t.TypeC<{
1055
+ meta: t.IntersectionC<[t.UnionC<[t.TypeC<{
792
1056
  type: t.LiteralC<"emojis">;
793
1057
  lower_label: t.StringC;
794
1058
  upper_label: t.StringC;
@@ -804,15 +1068,35 @@ export declare const NudgeV: t.IntersectionC<[t.IntersectionC<[t.TypeC<{
804
1068
  lower_label: t.StringC;
805
1069
  upper_label: t.StringC;
806
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
+ }>;
807
1081
  }>]>;
808
1082
  }>, t.TypeC<{
809
1083
  type: t.LiteralC<"survey_list">;
810
1084
  sort_key: t.UnionC<[t.NumberC, t.UndefinedC]>;
811
- meta: t.TypeC<{
1085
+ meta: t.IntersectionC<[t.TypeC<{
812
1086
  options: t.ArrayC<t.StringC>;
813
1087
  list_type: t.UnionC<[t.LiteralC<"single">, t.LiteralC<"multiple">]>;
814
1088
  display_type: t.UnionC<[t.LiteralC<"dropdown">, t.LiteralC<"list">, t.LiteralC<"grid">]>;
815
- }>;
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
+ }>;
1099
+ }>]>;
816
1100
  }>]>>;
817
1101
  is_live: t.BooleanC;
818
1102
  }>, t.IntersectionC<[t.TypeC<{
@@ -832,7 +1116,28 @@ export declare const NudgeV: t.IntersectionC<[t.IntersectionC<[t.TypeC<{
832
1116
  x: t.StringC;
833
1117
  y: t.StringC;
834
1118
  }>;
835
- }>]>]>;
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
+ }>]>;
836
1141
  }>, t.PartialC<{
837
1142
  has_survey_response: t.BooleanC;
838
1143
  }>]>]>>;
@@ -859,8 +1164,10 @@ export declare const NudgeV: t.IntersectionC<[t.IntersectionC<[t.TypeC<{
859
1164
  show_step_counter: t.BooleanC;
860
1165
  dismissible: t.BooleanC;
861
1166
  snoozable: t.BooleanC;
862
- share_page_url: t.StringC;
1167
+ share_page_url_or_path: t.StringC;
863
1168
  copilot_suggest: t.BooleanC;
1169
+ show_in_spotlight_search: t.BooleanC;
1170
+ show_in_helphub_search: t.BooleanC;
864
1171
  copilot_cta_label: t.StringC;
865
1172
  copilot_description: t.StringC;
866
1173
  is_scheduled: t.BooleanC;
@@ -868,6 +1175,7 @@ export declare const NudgeV: t.IntersectionC<[t.IntersectionC<[t.TypeC<{
868
1175
  scheduled_end_time: t.UnionC<[t.StringC, t.NullC, t.UndefinedC]>;
869
1176
  snooze_label: t.StringC;
870
1177
  type: t.UnionC<[t.LiteralC<"announcement">, t.LiteralC<"product_tour">, t.LiteralC<"survey">, t.NullC]>;
1178
+ editor_tags: t.ArrayC<t.StringC>;
871
1179
  }>]>;
872
1180
  export declare const OldNudgeBaseV: t.IntersectionC<[t.TypeC<{
873
1181
  id: t.NumberC;
@@ -886,6 +1194,7 @@ export declare const OldNudgeBaseV: t.IntersectionC<[t.TypeC<{
886
1194
  type: t.LiteralC<"on_event">;
887
1195
  meta: t.TypeC<{
888
1196
  event: t.StringC;
1197
+ condition_group: t.UnionC<[t.Type<import("./helpers/rules").RuleExpression, import("./helpers/rules").RuleExpression, unknown>, t.NullC, t.UndefinedC]>;
889
1198
  }>;
890
1199
  }>, t.TypeC<{
891
1200
  type: t.LiteralC<"when_share_link_viewed">;
@@ -894,9 +1203,11 @@ export declare const OldNudgeBaseV: t.IntersectionC<[t.TypeC<{
894
1203
  type: t.LiteralC<"no_action">;
895
1204
  }>, t.TypeC<{
896
1205
  type: t.LiteralC<"execute_command">;
897
- meta: t.TypeC<{
1206
+ meta: t.IntersectionC<[t.TypeC<{
898
1207
  command: t.StringC;
899
- }>;
1208
+ }>, t.PartialC<{
1209
+ type: t.UnionC<[t.LiteralC<"action">, t.LiteralC<"link">, t.LiteralC<"helpdoc">, t.LiteralC<"video">]>;
1210
+ }>]>;
900
1211
  }>]>;
901
1212
  timeout_ms: t.UnionC<[t.NumberC, t.NullC]>;
902
1213
  frequency_limit: t.UnionC<[t.LiteralC<"no_limit">, t.LiteralC<"once_per_session">, t.LiteralC<"once_per_user">, t.LiteralC<"until_interaction">]>;
@@ -950,6 +1261,7 @@ export declare const OldNudgeV: t.IntersectionC<[t.IntersectionC<[t.TypeC<{
950
1261
  type: t.LiteralC<"on_event">;
951
1262
  meta: t.TypeC<{
952
1263
  event: t.StringC;
1264
+ condition_group: t.UnionC<[t.Type<import("./helpers/rules").RuleExpression, import("./helpers/rules").RuleExpression, unknown>, t.NullC, t.UndefinedC]>;
953
1265
  }>;
954
1266
  }>, t.TypeC<{
955
1267
  type: t.LiteralC<"when_share_link_viewed">;
@@ -958,9 +1270,11 @@ export declare const OldNudgeV: t.IntersectionC<[t.IntersectionC<[t.TypeC<{
958
1270
  type: t.LiteralC<"no_action">;
959
1271
  }>, t.TypeC<{
960
1272
  type: t.LiteralC<"execute_command">;
961
- meta: t.TypeC<{
1273
+ meta: t.IntersectionC<[t.TypeC<{
962
1274
  command: t.StringC;
963
- }>;
1275
+ }>, t.PartialC<{
1276
+ type: t.UnionC<[t.LiteralC<"action">, t.LiteralC<"link">, t.LiteralC<"helpdoc">, t.LiteralC<"video">]>;
1277
+ }>]>;
964
1278
  }>]>;
965
1279
  timeout_ms: t.UnionC<[t.NumberC, t.NullC]>;
966
1280
  frequency_limit: t.UnionC<[t.LiteralC<"no_limit">, t.LiteralC<"once_per_session">, t.LiteralC<"once_per_user">, t.LiteralC<"until_interaction">]>;
@@ -1018,6 +1332,7 @@ export declare class Nudge {
1018
1332
  type: "on_event";
1019
1333
  meta: {
1020
1334
  event: string;
1335
+ condition_group: import("./helpers/rules").RuleExpression | null | undefined;
1021
1336
  };
1022
1337
  } | {
1023
1338
  type: "when_element_appears";
@@ -1030,8 +1345,20 @@ export declare class Nudge {
1030
1345
  type: "on_rage_click";
1031
1346
  } | {
1032
1347
  type: "smart_delay";
1348
+ } | {
1349
+ type: "after_time";
1350
+ meta: {
1351
+ unit: "minute" | "second";
1352
+ value: number;
1353
+ };
1033
1354
  } | {
1034
1355
  type: "when_share_link_viewed";
1356
+ } | {
1357
+ type: "scheduled";
1358
+ meta: {
1359
+ interval: "day" | "month" | "week";
1360
+ value: number;
1361
+ };
1035
1362
  };
1036
1363
  frequency_limit: "no_limit" | "once_per_session" | "once_per_user" | "until_interaction";
1037
1364
  steps: ({
@@ -1076,12 +1403,17 @@ export declare class Nudge {
1076
1403
  type: "execute_command";
1077
1404
  meta: {
1078
1405
  command: string;
1406
+ } & {
1407
+ type?: "link" | "video" | "action" | "helpdoc" | undefined;
1079
1408
  };
1080
1409
  } | {
1081
1410
  type: "no_action";
1082
1411
  } | {
1083
1412
  type: "click";
1084
1413
  value: string;
1414
+ } | {
1415
+ type: "click" | "clickBySelector" | "clickByXpath";
1416
+ value: string[];
1085
1417
  } | ({
1086
1418
  type: "link";
1087
1419
  value: string;
@@ -1090,7 +1422,7 @@ export declare class Nudge {
1090
1422
  }) | {
1091
1423
  type: "open_chat";
1092
1424
  meta: {
1093
- type: string;
1425
+ type: "" | "intercom" | "helpscout" | "freshdesk" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "hubspot" | "drift";
1094
1426
  };
1095
1427
  } | {
1096
1428
  type: "dismiss";
@@ -1112,7 +1444,11 @@ export declare class Nudge {
1112
1444
  } & {
1113
1445
  value?: string | undefined;
1114
1446
  categoryFilter?: number | undefined;
1115
- }) | undefined;
1447
+ }) | {
1448
+ type: "open_helphub";
1449
+ } | {
1450
+ type: "open_copilot";
1451
+ } | undefined;
1116
1452
  button_type?: "snooze" | "primary" | "secondary" | undefined;
1117
1453
  conditional_actions?: {
1118
1454
  operator: "eq" | "neq" | "gt" | "lt";
@@ -1121,12 +1457,17 @@ export declare class Nudge {
1121
1457
  type: "execute_command";
1122
1458
  meta: {
1123
1459
  command: string;
1460
+ } & {
1461
+ type?: "link" | "video" | "action" | "helpdoc" | undefined;
1124
1462
  };
1125
1463
  } | {
1126
1464
  type: "no_action";
1127
1465
  } | {
1128
1466
  type: "click";
1129
1467
  value: string;
1468
+ } | {
1469
+ type: "click" | "clickBySelector" | "clickByXpath";
1470
+ value: string[];
1130
1471
  } | ({
1131
1472
  type: "link";
1132
1473
  value: string;
@@ -1135,7 +1476,7 @@ export declare class Nudge {
1135
1476
  }) | {
1136
1477
  type: "open_chat";
1137
1478
  meta: {
1138
- type: string;
1479
+ type: "" | "intercom" | "helpscout" | "freshdesk" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "hubspot" | "drift";
1139
1480
  };
1140
1481
  } | {
1141
1482
  type: "dismiss";
@@ -1157,25 +1498,49 @@ export declare class Nudge {
1157
1498
  } & {
1158
1499
  value?: string | undefined;
1159
1500
  categoryFilter?: number | undefined;
1160
- });
1501
+ }) | {
1502
+ type: "open_helphub";
1503
+ } | {
1504
+ type: "open_copilot";
1505
+ };
1161
1506
  }[] | undefined;
1162
1507
  } | null;
1163
1508
  } | {
1164
1509
  type: "survey_text";
1165
1510
  meta: {
1166
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;
1167
1522
  };
1168
1523
  sort_key: number | undefined;
1169
1524
  } | {
1170
1525
  type: "survey_text_short";
1171
1526
  meta: {
1172
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;
1173
1538
  };
1174
1539
  sort_key: number | undefined;
1175
1540
  } | {
1176
1541
  type: "survey_rating";
1177
1542
  sort_key: number | undefined;
1178
- meta: {
1543
+ meta: ({
1179
1544
  type: "emojis";
1180
1545
  lower_label: string;
1181
1546
  upper_label: string;
@@ -1191,6 +1556,16 @@ export declare class Nudge {
1191
1556
  lower_label: string;
1192
1557
  upper_label: string;
1193
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;
1194
1569
  };
1195
1570
  } | {
1196
1571
  type: "survey_list";
@@ -1199,6 +1574,16 @@ export declare class Nudge {
1199
1574
  options: string[];
1200
1575
  list_type: "multiple" | "single";
1201
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;
1202
1587
  };
1203
1588
  })[];
1204
1589
  is_live: boolean;
@@ -1219,7 +1604,28 @@ export declare class Nudge {
1219
1604
  x: string;
1220
1605
  y: string;
1221
1606
  } | undefined;
1222
- });
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
+ };
1223
1629
  } & {
1224
1630
  has_survey_response?: boolean | undefined;
1225
1631
  })[];
@@ -1246,8 +1652,10 @@ export declare class Nudge {
1246
1652
  show_step_counter: boolean;
1247
1653
  dismissible: boolean;
1248
1654
  snoozable: boolean;
1249
- share_page_url: string;
1655
+ share_page_url_or_path: string;
1250
1656
  copilot_suggest: boolean;
1657
+ show_in_spotlight_search: boolean;
1658
+ show_in_helphub_search: boolean;
1251
1659
  copilot_cta_label: string;
1252
1660
  copilot_description: string;
1253
1661
  is_scheduled: boolean;
@@ -1255,6 +1663,7 @@ export declare class Nudge {
1255
1663
  scheduled_end_time: string | null | undefined;
1256
1664
  snooze_label: string;
1257
1665
  type: "announcement" | "product_tour" | "survey" | null;
1666
+ editor_tags: string[];
1258
1667
  };
1259
1668
  static create: (object: {
1260
1669
  slug: string;
@@ -1277,6 +1686,7 @@ export declare class Nudge {
1277
1686
  type: "on_event";
1278
1687
  meta: {
1279
1688
  event: string;
1689
+ condition_group: import("./helpers/rules").RuleExpression | null | undefined;
1280
1690
  };
1281
1691
  } | {
1282
1692
  type: "when_element_appears";
@@ -1289,8 +1699,20 @@ export declare class Nudge {
1289
1699
  type: "on_rage_click";
1290
1700
  } | {
1291
1701
  type: "smart_delay";
1702
+ } | {
1703
+ type: "after_time";
1704
+ meta: {
1705
+ unit: "minute" | "second";
1706
+ value: number;
1707
+ };
1292
1708
  } | {
1293
1709
  type: "when_share_link_viewed";
1710
+ } | {
1711
+ type: "scheduled";
1712
+ meta: {
1713
+ interval: "day" | "month" | "week";
1714
+ value: number;
1715
+ };
1294
1716
  };
1295
1717
  frequency_limit: "no_limit" | "once_per_session" | "once_per_user" | "until_interaction";
1296
1718
  steps: ({
@@ -1335,12 +1757,17 @@ export declare class Nudge {
1335
1757
  type: "execute_command";
1336
1758
  meta: {
1337
1759
  command: string;
1760
+ } & {
1761
+ type?: "link" | "video" | "action" | "helpdoc" | undefined;
1338
1762
  };
1339
1763
  } | {
1340
1764
  type: "no_action";
1341
1765
  } | {
1342
1766
  type: "click";
1343
1767
  value: string;
1768
+ } | {
1769
+ type: "click" | "clickBySelector" | "clickByXpath";
1770
+ value: string[];
1344
1771
  } | ({
1345
1772
  type: "link";
1346
1773
  value: string;
@@ -1349,7 +1776,7 @@ export declare class Nudge {
1349
1776
  }) | {
1350
1777
  type: "open_chat";
1351
1778
  meta: {
1352
- type: string;
1779
+ type: "" | "intercom" | "helpscout" | "freshdesk" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "hubspot" | "drift";
1353
1780
  };
1354
1781
  } | {
1355
1782
  type: "dismiss";
@@ -1371,7 +1798,11 @@ export declare class Nudge {
1371
1798
  } & {
1372
1799
  value?: string | undefined;
1373
1800
  categoryFilter?: number | undefined;
1374
- }) | undefined;
1801
+ }) | {
1802
+ type: "open_helphub";
1803
+ } | {
1804
+ type: "open_copilot";
1805
+ } | undefined;
1375
1806
  button_type?: "snooze" | "primary" | "secondary" | undefined;
1376
1807
  conditional_actions?: {
1377
1808
  operator: "eq" | "neq" | "gt" | "lt";
@@ -1380,12 +1811,17 @@ export declare class Nudge {
1380
1811
  type: "execute_command";
1381
1812
  meta: {
1382
1813
  command: string;
1814
+ } & {
1815
+ type?: "link" | "video" | "action" | "helpdoc" | undefined;
1383
1816
  };
1384
1817
  } | {
1385
1818
  type: "no_action";
1386
1819
  } | {
1387
1820
  type: "click";
1388
1821
  value: string;
1822
+ } | {
1823
+ type: "click" | "clickBySelector" | "clickByXpath";
1824
+ value: string[];
1389
1825
  } | ({
1390
1826
  type: "link";
1391
1827
  value: string;
@@ -1394,7 +1830,7 @@ export declare class Nudge {
1394
1830
  }) | {
1395
1831
  type: "open_chat";
1396
1832
  meta: {
1397
- type: string;
1833
+ type: "" | "intercom" | "helpscout" | "freshdesk" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "hubspot" | "drift";
1398
1834
  };
1399
1835
  } | {
1400
1836
  type: "dismiss";
@@ -1416,25 +1852,49 @@ export declare class Nudge {
1416
1852
  } & {
1417
1853
  value?: string | undefined;
1418
1854
  categoryFilter?: number | undefined;
1419
- });
1855
+ }) | {
1856
+ type: "open_helphub";
1857
+ } | {
1858
+ type: "open_copilot";
1859
+ };
1420
1860
  }[] | undefined;
1421
1861
  } | null;
1422
1862
  } | {
1423
1863
  type: "survey_text";
1424
1864
  meta: {
1425
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;
1426
1876
  };
1427
1877
  sort_key: number | undefined;
1428
1878
  } | {
1429
1879
  type: "survey_text_short";
1430
1880
  meta: {
1431
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;
1432
1892
  };
1433
1893
  sort_key: number | undefined;
1434
1894
  } | {
1435
1895
  type: "survey_rating";
1436
1896
  sort_key: number | undefined;
1437
- meta: {
1897
+ meta: ({
1438
1898
  type: "emojis";
1439
1899
  lower_label: string;
1440
1900
  upper_label: string;
@@ -1450,6 +1910,16 @@ export declare class Nudge {
1450
1910
  lower_label: string;
1451
1911
  upper_label: string;
1452
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;
1453
1923
  };
1454
1924
  } | {
1455
1925
  type: "survey_list";
@@ -1458,6 +1928,16 @@ export declare class Nudge {
1458
1928
  options: string[];
1459
1929
  list_type: "multiple" | "single";
1460
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;
1461
1941
  };
1462
1942
  })[];
1463
1943
  is_live: boolean;
@@ -1478,7 +1958,28 @@ export declare class Nudge {
1478
1958
  x: string;
1479
1959
  y: string;
1480
1960
  } | undefined;
1481
- });
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
+ };
1482
1983
  } & {
1483
1984
  has_survey_response?: boolean | undefined;
1484
1985
  })[];
@@ -1505,8 +2006,10 @@ export declare class Nudge {
1505
2006
  show_step_counter: boolean;
1506
2007
  dismissible: boolean;
1507
2008
  snoozable: boolean;
1508
- share_page_url: string;
2009
+ share_page_url_or_path: string;
1509
2010
  copilot_suggest: boolean;
2011
+ show_in_spotlight_search: boolean;
2012
+ show_in_helphub_search: boolean;
1510
2013
  copilot_cta_label: string;
1511
2014
  copilot_description: string;
1512
2015
  is_scheduled: boolean;
@@ -1514,6 +2017,7 @@ export declare class Nudge {
1514
2017
  scheduled_end_time: string | null | undefined;
1515
2018
  snooze_label: string;
1516
2019
  type: "announcement" | "product_tour" | "survey" | null;
2020
+ editor_tags: string[];
1517
2021
  }, onSuccess?: (() => void) | undefined, onError?: ((err: string) => void) | undefined) => Promise<{
1518
2022
  slug: string;
1519
2023
  id: string | number;
@@ -1535,6 +2039,7 @@ export declare class Nudge {
1535
2039
  type: "on_event";
1536
2040
  meta: {
1537
2041
  event: string;
2042
+ condition_group: import("./helpers/rules").RuleExpression | null | undefined;
1538
2043
  };
1539
2044
  } | {
1540
2045
  type: "when_element_appears";
@@ -1547,8 +2052,20 @@ export declare class Nudge {
1547
2052
  type: "on_rage_click";
1548
2053
  } | {
1549
2054
  type: "smart_delay";
2055
+ } | {
2056
+ type: "after_time";
2057
+ meta: {
2058
+ unit: "minute" | "second";
2059
+ value: number;
2060
+ };
1550
2061
  } | {
1551
2062
  type: "when_share_link_viewed";
2063
+ } | {
2064
+ type: "scheduled";
2065
+ meta: {
2066
+ interval: "day" | "month" | "week";
2067
+ value: number;
2068
+ };
1552
2069
  };
1553
2070
  frequency_limit: "no_limit" | "once_per_session" | "once_per_user" | "until_interaction";
1554
2071
  steps: ({
@@ -1593,12 +2110,17 @@ export declare class Nudge {
1593
2110
  type: "execute_command";
1594
2111
  meta: {
1595
2112
  command: string;
2113
+ } & {
2114
+ type?: "link" | "video" | "action" | "helpdoc" | undefined;
1596
2115
  };
1597
2116
  } | {
1598
2117
  type: "no_action";
1599
2118
  } | {
1600
2119
  type: "click";
1601
2120
  value: string;
2121
+ } | {
2122
+ type: "click" | "clickBySelector" | "clickByXpath";
2123
+ value: string[];
1602
2124
  } | ({
1603
2125
  type: "link";
1604
2126
  value: string;
@@ -1607,7 +2129,7 @@ export declare class Nudge {
1607
2129
  }) | {
1608
2130
  type: "open_chat";
1609
2131
  meta: {
1610
- type: string;
2132
+ type: "" | "intercom" | "helpscout" | "freshdesk" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "hubspot" | "drift";
1611
2133
  };
1612
2134
  } | {
1613
2135
  type: "dismiss";
@@ -1629,7 +2151,11 @@ export declare class Nudge {
1629
2151
  } & {
1630
2152
  value?: string | undefined;
1631
2153
  categoryFilter?: number | undefined;
1632
- }) | undefined;
2154
+ }) | {
2155
+ type: "open_helphub";
2156
+ } | {
2157
+ type: "open_copilot";
2158
+ } | undefined;
1633
2159
  button_type?: "snooze" | "primary" | "secondary" | undefined;
1634
2160
  conditional_actions?: {
1635
2161
  operator: "eq" | "neq" | "gt" | "lt";
@@ -1638,12 +2164,17 @@ export declare class Nudge {
1638
2164
  type: "execute_command";
1639
2165
  meta: {
1640
2166
  command: string;
2167
+ } & {
2168
+ type?: "link" | "video" | "action" | "helpdoc" | undefined;
1641
2169
  };
1642
2170
  } | {
1643
2171
  type: "no_action";
1644
2172
  } | {
1645
2173
  type: "click";
1646
2174
  value: string;
2175
+ } | {
2176
+ type: "click" | "clickBySelector" | "clickByXpath";
2177
+ value: string[];
1647
2178
  } | ({
1648
2179
  type: "link";
1649
2180
  value: string;
@@ -1652,7 +2183,7 @@ export declare class Nudge {
1652
2183
  }) | {
1653
2184
  type: "open_chat";
1654
2185
  meta: {
1655
- type: string;
2186
+ type: "" | "intercom" | "helpscout" | "freshdesk" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "hubspot" | "drift";
1656
2187
  };
1657
2188
  } | {
1658
2189
  type: "dismiss";
@@ -1674,25 +2205,49 @@ export declare class Nudge {
1674
2205
  } & {
1675
2206
  value?: string | undefined;
1676
2207
  categoryFilter?: number | undefined;
1677
- });
2208
+ }) | {
2209
+ type: "open_helphub";
2210
+ } | {
2211
+ type: "open_copilot";
2212
+ };
1678
2213
  }[] | undefined;
1679
2214
  } | null;
1680
2215
  } | {
1681
2216
  type: "survey_text";
1682
2217
  meta: {
1683
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;
1684
2229
  };
1685
2230
  sort_key: number | undefined;
1686
2231
  } | {
1687
2232
  type: "survey_text_short";
1688
2233
  meta: {
1689
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;
1690
2245
  };
1691
2246
  sort_key: number | undefined;
1692
2247
  } | {
1693
2248
  type: "survey_rating";
1694
2249
  sort_key: number | undefined;
1695
- meta: {
2250
+ meta: ({
1696
2251
  type: "emojis";
1697
2252
  lower_label: string;
1698
2253
  upper_label: string;
@@ -1708,6 +2263,16 @@ export declare class Nudge {
1708
2263
  lower_label: string;
1709
2264
  upper_label: string;
1710
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;
1711
2276
  };
1712
2277
  } | {
1713
2278
  type: "survey_list";
@@ -1716,6 +2281,16 @@ export declare class Nudge {
1716
2281
  options: string[];
1717
2282
  list_type: "multiple" | "single";
1718
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;
1719
2294
  };
1720
2295
  })[];
1721
2296
  is_live: boolean;
@@ -1736,7 +2311,28 @@ export declare class Nudge {
1736
2311
  x: string;
1737
2312
  y: string;
1738
2313
  } | undefined;
1739
- });
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
+ };
1740
2336
  } & {
1741
2337
  has_survey_response?: boolean | undefined;
1742
2338
  })[];
@@ -1763,8 +2359,10 @@ export declare class Nudge {
1763
2359
  show_step_counter: boolean;
1764
2360
  dismissible: boolean;
1765
2361
  snoozable: boolean;
1766
- share_page_url: string;
2362
+ share_page_url_or_path: string;
1767
2363
  copilot_suggest: boolean;
2364
+ show_in_spotlight_search: boolean;
2365
+ show_in_helphub_search: boolean;
1768
2366
  copilot_cta_label: string;
1769
2367
  copilot_description: string;
1770
2368
  is_scheduled: boolean;
@@ -1772,6 +2370,7 @@ export declare class Nudge {
1772
2370
  scheduled_end_time: string | null | undefined;
1773
2371
  snooze_label: string;
1774
2372
  type: "announcement" | "product_tour" | "survey" | null;
2373
+ editor_tags: string[];
1775
2374
  }>;
1776
2375
  static update: (object: {
1777
2376
  slug: string;
@@ -1794,6 +2393,7 @@ export declare class Nudge {
1794
2393
  type: "on_event";
1795
2394
  meta: {
1796
2395
  event: string;
2396
+ condition_group: import("./helpers/rules").RuleExpression | null | undefined;
1797
2397
  };
1798
2398
  } | {
1799
2399
  type: "when_element_appears";
@@ -1806,8 +2406,20 @@ export declare class Nudge {
1806
2406
  type: "on_rage_click";
1807
2407
  } | {
1808
2408
  type: "smart_delay";
2409
+ } | {
2410
+ type: "after_time";
2411
+ meta: {
2412
+ unit: "minute" | "second";
2413
+ value: number;
2414
+ };
1809
2415
  } | {
1810
2416
  type: "when_share_link_viewed";
2417
+ } | {
2418
+ type: "scheduled";
2419
+ meta: {
2420
+ interval: "day" | "month" | "week";
2421
+ value: number;
2422
+ };
1811
2423
  };
1812
2424
  frequency_limit: "no_limit" | "once_per_session" | "once_per_user" | "until_interaction";
1813
2425
  steps: ({
@@ -1852,12 +2464,17 @@ export declare class Nudge {
1852
2464
  type: "execute_command";
1853
2465
  meta: {
1854
2466
  command: string;
2467
+ } & {
2468
+ type?: "link" | "video" | "action" | "helpdoc" | undefined;
1855
2469
  };
1856
2470
  } | {
1857
2471
  type: "no_action";
1858
2472
  } | {
1859
2473
  type: "click";
1860
2474
  value: string;
2475
+ } | {
2476
+ type: "click" | "clickBySelector" | "clickByXpath";
2477
+ value: string[];
1861
2478
  } | ({
1862
2479
  type: "link";
1863
2480
  value: string;
@@ -1866,7 +2483,7 @@ export declare class Nudge {
1866
2483
  }) | {
1867
2484
  type: "open_chat";
1868
2485
  meta: {
1869
- type: string;
2486
+ type: "" | "intercom" | "helpscout" | "freshdesk" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "hubspot" | "drift";
1870
2487
  };
1871
2488
  } | {
1872
2489
  type: "dismiss";
@@ -1888,7 +2505,11 @@ export declare class Nudge {
1888
2505
  } & {
1889
2506
  value?: string | undefined;
1890
2507
  categoryFilter?: number | undefined;
1891
- }) | undefined;
2508
+ }) | {
2509
+ type: "open_helphub";
2510
+ } | {
2511
+ type: "open_copilot";
2512
+ } | undefined;
1892
2513
  button_type?: "snooze" | "primary" | "secondary" | undefined;
1893
2514
  conditional_actions?: {
1894
2515
  operator: "eq" | "neq" | "gt" | "lt";
@@ -1897,12 +2518,17 @@ export declare class Nudge {
1897
2518
  type: "execute_command";
1898
2519
  meta: {
1899
2520
  command: string;
2521
+ } & {
2522
+ type?: "link" | "video" | "action" | "helpdoc" | undefined;
1900
2523
  };
1901
2524
  } | {
1902
2525
  type: "no_action";
1903
2526
  } | {
1904
2527
  type: "click";
1905
2528
  value: string;
2529
+ } | {
2530
+ type: "click" | "clickBySelector" | "clickByXpath";
2531
+ value: string[];
1906
2532
  } | ({
1907
2533
  type: "link";
1908
2534
  value: string;
@@ -1911,7 +2537,7 @@ export declare class Nudge {
1911
2537
  }) | {
1912
2538
  type: "open_chat";
1913
2539
  meta: {
1914
- type: string;
2540
+ type: "" | "intercom" | "helpscout" | "freshdesk" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "hubspot" | "drift";
1915
2541
  };
1916
2542
  } | {
1917
2543
  type: "dismiss";
@@ -1933,25 +2559,49 @@ export declare class Nudge {
1933
2559
  } & {
1934
2560
  value?: string | undefined;
1935
2561
  categoryFilter?: number | undefined;
1936
- });
2562
+ }) | {
2563
+ type: "open_helphub";
2564
+ } | {
2565
+ type: "open_copilot";
2566
+ };
1937
2567
  }[] | undefined;
1938
2568
  } | null;
1939
2569
  } | {
1940
2570
  type: "survey_text";
1941
2571
  meta: {
1942
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;
1943
2583
  };
1944
2584
  sort_key: number | undefined;
1945
2585
  } | {
1946
2586
  type: "survey_text_short";
1947
2587
  meta: {
1948
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;
1949
2599
  };
1950
2600
  sort_key: number | undefined;
1951
2601
  } | {
1952
2602
  type: "survey_rating";
1953
2603
  sort_key: number | undefined;
1954
- meta: {
2604
+ meta: ({
1955
2605
  type: "emojis";
1956
2606
  lower_label: string;
1957
2607
  upper_label: string;
@@ -1967,6 +2617,16 @@ export declare class Nudge {
1967
2617
  lower_label: string;
1968
2618
  upper_label: string;
1969
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;
1970
2630
  };
1971
2631
  } | {
1972
2632
  type: "survey_list";
@@ -1975,6 +2635,16 @@ export declare class Nudge {
1975
2635
  options: string[];
1976
2636
  list_type: "multiple" | "single";
1977
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;
1978
2648
  };
1979
2649
  })[];
1980
2650
  is_live: boolean;
@@ -1995,7 +2665,28 @@ export declare class Nudge {
1995
2665
  x: string;
1996
2666
  y: string;
1997
2667
  } | undefined;
1998
- });
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
+ };
1999
2690
  } & {
2000
2691
  has_survey_response?: boolean | undefined;
2001
2692
  })[];
@@ -2022,8 +2713,10 @@ export declare class Nudge {
2022
2713
  show_step_counter: boolean;
2023
2714
  dismissible: boolean;
2024
2715
  snoozable: boolean;
2025
- share_page_url: string;
2716
+ share_page_url_or_path: string;
2026
2717
  copilot_suggest: boolean;
2718
+ show_in_spotlight_search: boolean;
2719
+ show_in_helphub_search: boolean;
2027
2720
  copilot_cta_label: string;
2028
2721
  copilot_description: string;
2029
2722
  is_scheduled: boolean;
@@ -2031,6 +2724,7 @@ export declare class Nudge {
2031
2724
  scheduled_end_time: string | null | undefined;
2032
2725
  snooze_label: string;
2033
2726
  type: "announcement" | "product_tour" | "survey" | null;
2727
+ editor_tags: string[];
2034
2728
  }, onSuccess?: (() => void) | undefined, onError?: ((err: string) => void) | undefined) => Promise<{
2035
2729
  slug: string;
2036
2730
  id: string | number;
@@ -2052,6 +2746,7 @@ export declare class Nudge {
2052
2746
  type: "on_event";
2053
2747
  meta: {
2054
2748
  event: string;
2749
+ condition_group: import("./helpers/rules").RuleExpression | null | undefined;
2055
2750
  };
2056
2751
  } | {
2057
2752
  type: "when_element_appears";
@@ -2064,8 +2759,20 @@ export declare class Nudge {
2064
2759
  type: "on_rage_click";
2065
2760
  } | {
2066
2761
  type: "smart_delay";
2762
+ } | {
2763
+ type: "after_time";
2764
+ meta: {
2765
+ unit: "minute" | "second";
2766
+ value: number;
2767
+ };
2067
2768
  } | {
2068
2769
  type: "when_share_link_viewed";
2770
+ } | {
2771
+ type: "scheduled";
2772
+ meta: {
2773
+ interval: "day" | "month" | "week";
2774
+ value: number;
2775
+ };
2069
2776
  };
2070
2777
  frequency_limit: "no_limit" | "once_per_session" | "once_per_user" | "until_interaction";
2071
2778
  steps: ({
@@ -2110,12 +2817,17 @@ export declare class Nudge {
2110
2817
  type: "execute_command";
2111
2818
  meta: {
2112
2819
  command: string;
2820
+ } & {
2821
+ type?: "link" | "video" | "action" | "helpdoc" | undefined;
2113
2822
  };
2114
2823
  } | {
2115
2824
  type: "no_action";
2116
2825
  } | {
2117
2826
  type: "click";
2118
2827
  value: string;
2828
+ } | {
2829
+ type: "click" | "clickBySelector" | "clickByXpath";
2830
+ value: string[];
2119
2831
  } | ({
2120
2832
  type: "link";
2121
2833
  value: string;
@@ -2124,7 +2836,7 @@ export declare class Nudge {
2124
2836
  }) | {
2125
2837
  type: "open_chat";
2126
2838
  meta: {
2127
- type: string;
2839
+ type: "" | "intercom" | "helpscout" | "freshdesk" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "hubspot" | "drift";
2128
2840
  };
2129
2841
  } | {
2130
2842
  type: "dismiss";
@@ -2146,7 +2858,11 @@ export declare class Nudge {
2146
2858
  } & {
2147
2859
  value?: string | undefined;
2148
2860
  categoryFilter?: number | undefined;
2149
- }) | undefined;
2861
+ }) | {
2862
+ type: "open_helphub";
2863
+ } | {
2864
+ type: "open_copilot";
2865
+ } | undefined;
2150
2866
  button_type?: "snooze" | "primary" | "secondary" | undefined;
2151
2867
  conditional_actions?: {
2152
2868
  operator: "eq" | "neq" | "gt" | "lt";
@@ -2155,12 +2871,17 @@ export declare class Nudge {
2155
2871
  type: "execute_command";
2156
2872
  meta: {
2157
2873
  command: string;
2874
+ } & {
2875
+ type?: "link" | "video" | "action" | "helpdoc" | undefined;
2158
2876
  };
2159
2877
  } | {
2160
2878
  type: "no_action";
2161
2879
  } | {
2162
2880
  type: "click";
2163
2881
  value: string;
2882
+ } | {
2883
+ type: "click" | "clickBySelector" | "clickByXpath";
2884
+ value: string[];
2164
2885
  } | ({
2165
2886
  type: "link";
2166
2887
  value: string;
@@ -2169,7 +2890,7 @@ export declare class Nudge {
2169
2890
  }) | {
2170
2891
  type: "open_chat";
2171
2892
  meta: {
2172
- type: string;
2893
+ type: "" | "intercom" | "helpscout" | "freshdesk" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "hubspot" | "drift";
2173
2894
  };
2174
2895
  } | {
2175
2896
  type: "dismiss";
@@ -2191,25 +2912,49 @@ export declare class Nudge {
2191
2912
  } & {
2192
2913
  value?: string | undefined;
2193
2914
  categoryFilter?: number | undefined;
2194
- });
2915
+ }) | {
2916
+ type: "open_helphub";
2917
+ } | {
2918
+ type: "open_copilot";
2919
+ };
2195
2920
  }[] | undefined;
2196
2921
  } | null;
2197
2922
  } | {
2198
2923
  type: "survey_text";
2199
2924
  meta: {
2200
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;
2201
2936
  };
2202
2937
  sort_key: number | undefined;
2203
2938
  } | {
2204
2939
  type: "survey_text_short";
2205
2940
  meta: {
2206
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;
2207
2952
  };
2208
2953
  sort_key: number | undefined;
2209
2954
  } | {
2210
2955
  type: "survey_rating";
2211
2956
  sort_key: number | undefined;
2212
- meta: {
2957
+ meta: ({
2213
2958
  type: "emojis";
2214
2959
  lower_label: string;
2215
2960
  upper_label: string;
@@ -2225,6 +2970,16 @@ export declare class Nudge {
2225
2970
  lower_label: string;
2226
2971
  upper_label: string;
2227
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;
2228
2983
  };
2229
2984
  } | {
2230
2985
  type: "survey_list";
@@ -2233,6 +2988,16 @@ export declare class Nudge {
2233
2988
  options: string[];
2234
2989
  list_type: "multiple" | "single";
2235
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;
2236
3001
  };
2237
3002
  })[];
2238
3003
  is_live: boolean;
@@ -2253,7 +3018,28 @@ export declare class Nudge {
2253
3018
  x: string;
2254
3019
  y: string;
2255
3020
  } | undefined;
2256
- });
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
+ };
2257
3043
  } & {
2258
3044
  has_survey_response?: boolean | undefined;
2259
3045
  })[];
@@ -2280,8 +3066,10 @@ export declare class Nudge {
2280
3066
  show_step_counter: boolean;
2281
3067
  dismissible: boolean;
2282
3068
  snoozable: boolean;
2283
- share_page_url: string;
3069
+ share_page_url_or_path: string;
2284
3070
  copilot_suggest: boolean;
3071
+ show_in_spotlight_search: boolean;
3072
+ show_in_helphub_search: boolean;
2285
3073
  copilot_cta_label: string;
2286
3074
  copilot_description: string;
2287
3075
  is_scheduled: boolean;
@@ -2289,6 +3077,7 @@ export declare class Nudge {
2289
3077
  scheduled_end_time: string | null | undefined;
2290
3078
  snooze_label: string;
2291
3079
  type: "announcement" | "product_tour" | "survey" | null;
3080
+ editor_tags: string[];
2292
3081
  }>;
2293
3082
  static delete: (id: string | number, params?: Record<string, string> | undefined, onSuccess?: (() => void) | undefined, onError?: ((err: string) => void) | undefined) => Promise<void>;
2294
3083
  static list: (onSuccess?: (() => void) | undefined, onError?: ((err: string) => void) | undefined) => Promise<({
@@ -2312,6 +3101,7 @@ export declare class Nudge {
2312
3101
  type: "on_event";
2313
3102
  meta: {
2314
3103
  event: string;
3104
+ condition_group: import("./helpers/rules").RuleExpression | null | undefined;
2315
3105
  };
2316
3106
  } | {
2317
3107
  type: "when_element_appears";
@@ -2324,8 +3114,20 @@ export declare class Nudge {
2324
3114
  type: "on_rage_click";
2325
3115
  } | {
2326
3116
  type: "smart_delay";
3117
+ } | {
3118
+ type: "after_time";
3119
+ meta: {
3120
+ unit: "minute" | "second";
3121
+ value: number;
3122
+ };
2327
3123
  } | {
2328
3124
  type: "when_share_link_viewed";
3125
+ } | {
3126
+ type: "scheduled";
3127
+ meta: {
3128
+ interval: "day" | "month" | "week";
3129
+ value: number;
3130
+ };
2329
3131
  };
2330
3132
  frequency_limit: "no_limit" | "once_per_session" | "once_per_user" | "until_interaction";
2331
3133
  steps: ({
@@ -2370,12 +3172,17 @@ export declare class Nudge {
2370
3172
  type: "execute_command";
2371
3173
  meta: {
2372
3174
  command: string;
3175
+ } & {
3176
+ type?: "link" | "video" | "action" | "helpdoc" | undefined;
2373
3177
  };
2374
3178
  } | {
2375
3179
  type: "no_action";
2376
3180
  } | {
2377
3181
  type: "click";
2378
3182
  value: string;
3183
+ } | {
3184
+ type: "click" | "clickBySelector" | "clickByXpath";
3185
+ value: string[];
2379
3186
  } | ({
2380
3187
  type: "link";
2381
3188
  value: string;
@@ -2384,7 +3191,7 @@ export declare class Nudge {
2384
3191
  }) | {
2385
3192
  type: "open_chat";
2386
3193
  meta: {
2387
- type: string;
3194
+ type: "" | "intercom" | "helpscout" | "freshdesk" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "hubspot" | "drift";
2388
3195
  };
2389
3196
  } | {
2390
3197
  type: "dismiss";
@@ -2406,7 +3213,11 @@ export declare class Nudge {
2406
3213
  } & {
2407
3214
  value?: string | undefined;
2408
3215
  categoryFilter?: number | undefined;
2409
- }) | undefined;
3216
+ }) | {
3217
+ type: "open_helphub";
3218
+ } | {
3219
+ type: "open_copilot";
3220
+ } | undefined;
2410
3221
  button_type?: "snooze" | "primary" | "secondary" | undefined;
2411
3222
  conditional_actions?: {
2412
3223
  operator: "eq" | "neq" | "gt" | "lt";
@@ -2415,12 +3226,17 @@ export declare class Nudge {
2415
3226
  type: "execute_command";
2416
3227
  meta: {
2417
3228
  command: string;
3229
+ } & {
3230
+ type?: "link" | "video" | "action" | "helpdoc" | undefined;
2418
3231
  };
2419
3232
  } | {
2420
3233
  type: "no_action";
2421
3234
  } | {
2422
3235
  type: "click";
2423
3236
  value: string;
3237
+ } | {
3238
+ type: "click" | "clickBySelector" | "clickByXpath";
3239
+ value: string[];
2424
3240
  } | ({
2425
3241
  type: "link";
2426
3242
  value: string;
@@ -2429,7 +3245,7 @@ export declare class Nudge {
2429
3245
  }) | {
2430
3246
  type: "open_chat";
2431
3247
  meta: {
2432
- type: string;
3248
+ type: "" | "intercom" | "helpscout" | "freshdesk" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "hubspot" | "drift";
2433
3249
  };
2434
3250
  } | {
2435
3251
  type: "dismiss";
@@ -2451,25 +3267,49 @@ export declare class Nudge {
2451
3267
  } & {
2452
3268
  value?: string | undefined;
2453
3269
  categoryFilter?: number | undefined;
2454
- });
3270
+ }) | {
3271
+ type: "open_helphub";
3272
+ } | {
3273
+ type: "open_copilot";
3274
+ };
2455
3275
  }[] | undefined;
2456
3276
  } | null;
2457
3277
  } | {
2458
3278
  type: "survey_text";
2459
3279
  meta: {
2460
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;
2461
3291
  };
2462
3292
  sort_key: number | undefined;
2463
3293
  } | {
2464
3294
  type: "survey_text_short";
2465
3295
  meta: {
2466
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;
2467
3307
  };
2468
3308
  sort_key: number | undefined;
2469
3309
  } | {
2470
3310
  type: "survey_rating";
2471
3311
  sort_key: number | undefined;
2472
- meta: {
3312
+ meta: ({
2473
3313
  type: "emojis";
2474
3314
  lower_label: string;
2475
3315
  upper_label: string;
@@ -2485,6 +3325,16 @@ export declare class Nudge {
2485
3325
  lower_label: string;
2486
3326
  upper_label: string;
2487
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;
2488
3338
  };
2489
3339
  } | {
2490
3340
  type: "survey_list";
@@ -2493,6 +3343,16 @@ export declare class Nudge {
2493
3343
  options: string[];
2494
3344
  list_type: "multiple" | "single";
2495
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;
2496
3356
  };
2497
3357
  })[];
2498
3358
  is_live: boolean;
@@ -2513,7 +3373,28 @@ export declare class Nudge {
2513
3373
  x: string;
2514
3374
  y: string;
2515
3375
  } | undefined;
2516
- });
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
+ };
2517
3398
  } & {
2518
3399
  has_survey_response?: boolean | undefined;
2519
3400
  })[];
@@ -2540,8 +3421,10 @@ export declare class Nudge {
2540
3421
  show_step_counter: boolean;
2541
3422
  dismissible: boolean;
2542
3423
  snoozable: boolean;
2543
- share_page_url: string;
3424
+ share_page_url_or_path: string;
2544
3425
  copilot_suggest: boolean;
3426
+ show_in_spotlight_search: boolean;
3427
+ show_in_helphub_search: boolean;
2545
3428
  copilot_cta_label: string;
2546
3429
  copilot_description: string;
2547
3430
  is_scheduled: boolean;
@@ -2549,6 +3432,7 @@ export declare class Nudge {
2549
3432
  scheduled_end_time: string | null | undefined;
2550
3433
  snooze_label: string;
2551
3434
  type: "announcement" | "product_tour" | "survey" | null;
3435
+ editor_tags: string[];
2552
3436
  })[]>;
2553
3437
  static read: (arg0: string, params?: Record<string, string> | undefined, callbacks?: {
2554
3438
  onSuccess?: (() => void) | undefined;
@@ -2574,6 +3458,7 @@ export declare class Nudge {
2574
3458
  type: "on_event";
2575
3459
  meta: {
2576
3460
  event: string;
3461
+ condition_group: import("./helpers/rules").RuleExpression | null | undefined;
2577
3462
  };
2578
3463
  } | {
2579
3464
  type: "when_element_appears";
@@ -2586,8 +3471,20 @@ export declare class Nudge {
2586
3471
  type: "on_rage_click";
2587
3472
  } | {
2588
3473
  type: "smart_delay";
3474
+ } | {
3475
+ type: "after_time";
3476
+ meta: {
3477
+ unit: "minute" | "second";
3478
+ value: number;
3479
+ };
2589
3480
  } | {
2590
3481
  type: "when_share_link_viewed";
3482
+ } | {
3483
+ type: "scheduled";
3484
+ meta: {
3485
+ interval: "day" | "month" | "week";
3486
+ value: number;
3487
+ };
2591
3488
  };
2592
3489
  frequency_limit: "no_limit" | "once_per_session" | "once_per_user" | "until_interaction";
2593
3490
  steps: ({
@@ -2632,12 +3529,17 @@ export declare class Nudge {
2632
3529
  type: "execute_command";
2633
3530
  meta: {
2634
3531
  command: string;
3532
+ } & {
3533
+ type?: "link" | "video" | "action" | "helpdoc" | undefined;
2635
3534
  };
2636
3535
  } | {
2637
3536
  type: "no_action";
2638
3537
  } | {
2639
3538
  type: "click";
2640
3539
  value: string;
3540
+ } | {
3541
+ type: "click" | "clickBySelector" | "clickByXpath";
3542
+ value: string[];
2641
3543
  } | ({
2642
3544
  type: "link";
2643
3545
  value: string;
@@ -2646,7 +3548,7 @@ export declare class Nudge {
2646
3548
  }) | {
2647
3549
  type: "open_chat";
2648
3550
  meta: {
2649
- type: string;
3551
+ type: "" | "intercom" | "helpscout" | "freshdesk" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "hubspot" | "drift";
2650
3552
  };
2651
3553
  } | {
2652
3554
  type: "dismiss";
@@ -2668,7 +3570,11 @@ export declare class Nudge {
2668
3570
  } & {
2669
3571
  value?: string | undefined;
2670
3572
  categoryFilter?: number | undefined;
2671
- }) | undefined;
3573
+ }) | {
3574
+ type: "open_helphub";
3575
+ } | {
3576
+ type: "open_copilot";
3577
+ } | undefined;
2672
3578
  button_type?: "snooze" | "primary" | "secondary" | undefined;
2673
3579
  conditional_actions?: {
2674
3580
  operator: "eq" | "neq" | "gt" | "lt";
@@ -2677,12 +3583,17 @@ export declare class Nudge {
2677
3583
  type: "execute_command";
2678
3584
  meta: {
2679
3585
  command: string;
3586
+ } & {
3587
+ type?: "link" | "video" | "action" | "helpdoc" | undefined;
2680
3588
  };
2681
3589
  } | {
2682
3590
  type: "no_action";
2683
3591
  } | {
2684
3592
  type: "click";
2685
3593
  value: string;
3594
+ } | {
3595
+ type: "click" | "clickBySelector" | "clickByXpath";
3596
+ value: string[];
2686
3597
  } | ({
2687
3598
  type: "link";
2688
3599
  value: string;
@@ -2691,7 +3602,7 @@ export declare class Nudge {
2691
3602
  }) | {
2692
3603
  type: "open_chat";
2693
3604
  meta: {
2694
- type: string;
3605
+ type: "" | "intercom" | "helpscout" | "freshdesk" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "hubspot" | "drift";
2695
3606
  };
2696
3607
  } | {
2697
3608
  type: "dismiss";
@@ -2713,25 +3624,49 @@ export declare class Nudge {
2713
3624
  } & {
2714
3625
  value?: string | undefined;
2715
3626
  categoryFilter?: number | undefined;
2716
- });
3627
+ }) | {
3628
+ type: "open_helphub";
3629
+ } | {
3630
+ type: "open_copilot";
3631
+ };
2717
3632
  }[] | undefined;
2718
3633
  } | null;
2719
3634
  } | {
2720
3635
  type: "survey_text";
2721
3636
  meta: {
2722
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;
2723
3648
  };
2724
3649
  sort_key: number | undefined;
2725
3650
  } | {
2726
3651
  type: "survey_text_short";
2727
3652
  meta: {
2728
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;
2729
3664
  };
2730
3665
  sort_key: number | undefined;
2731
3666
  } | {
2732
3667
  type: "survey_rating";
2733
3668
  sort_key: number | undefined;
2734
- meta: {
3669
+ meta: ({
2735
3670
  type: "emojis";
2736
3671
  lower_label: string;
2737
3672
  upper_label: string;
@@ -2747,6 +3682,16 @@ export declare class Nudge {
2747
3682
  lower_label: string;
2748
3683
  upper_label: string;
2749
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;
2750
3695
  };
2751
3696
  } | {
2752
3697
  type: "survey_list";
@@ -2755,6 +3700,16 @@ export declare class Nudge {
2755
3700
  options: string[];
2756
3701
  list_type: "multiple" | "single";
2757
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;
2758
3713
  };
2759
3714
  })[];
2760
3715
  is_live: boolean;
@@ -2775,7 +3730,28 @@ export declare class Nudge {
2775
3730
  x: string;
2776
3731
  y: string;
2777
3732
  } | undefined;
2778
- });
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
+ };
2779
3755
  } & {
2780
3756
  has_survey_response?: boolean | undefined;
2781
3757
  })[];
@@ -2802,8 +3778,10 @@ export declare class Nudge {
2802
3778
  show_step_counter: boolean;
2803
3779
  dismissible: boolean;
2804
3780
  snoozable: boolean;
2805
- share_page_url: string;
3781
+ share_page_url_or_path: string;
2806
3782
  copilot_suggest: boolean;
3783
+ show_in_spotlight_search: boolean;
3784
+ show_in_helphub_search: boolean;
2807
3785
  copilot_cta_label: string;
2808
3786
  copilot_description: string;
2809
3787
  is_scheduled: boolean;
@@ -2811,6 +3789,7 @@ export declare class Nudge {
2811
3789
  scheduled_end_time: string | null | undefined;
2812
3790
  snooze_label: string;
2813
3791
  type: "announcement" | "product_tour" | "survey" | null;
3792
+ editor_tags: string[];
2814
3793
  }>;
2815
3794
  /**
2816
3795
  * Returns true if the nudge is new (not yet saved to the backend)