commandbar 1.10.2 → 1.11.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (52) hide show
  1. package/build/commandbar/src/shared/services/analytics/EventHandler.d.ts +7 -2
  2. package/build/commandbar/src/shared/services/analytics/event-queue.d.ts +13 -0
  3. package/build/commandbar/src/shared/services/analytics/types.d.ts +1 -1
  4. package/build/commandbar/src/shared/services/analytics/v2/client.d.ts +54 -0
  5. package/build/commandbar/src/shared/services/analytics/v2/helpers.d.ts +6 -0
  6. package/build/commandbar/src/shared/services/analytics/v2/schema.d.ts +152 -0
  7. package/build/commandbar/src/shared/services/analytics/v2/types.d.ts +4 -0
  8. package/build/commandbar-js/src/index.d.ts +0 -1
  9. package/build/commandbar-js/src/index.js +1 -1
  10. package/build/commandbar-js/src/snippet.d.ts +7 -1
  11. package/build/internal/src/client/CommandBarClientSDK.d.ts +12 -0
  12. package/build/internal/src/client/CommandBarProxySDK.d.ts +1 -4
  13. package/build/internal/src/client/CommandBarSDK.d.ts +5 -3
  14. package/build/internal/src/client/SDKConfig.d.ts +3 -1
  15. package/build/internal/src/client/globals.d.ts +1 -0
  16. package/build/internal/src/client/symbols.d.ts +3 -1
  17. package/build/internal/src/middleware/CommandFromClientV.d.ts +16 -2
  18. package/build/internal/src/middleware/OrganizationV.d.ts +34 -8
  19. package/build/internal/src/middleware/additionalResource.d.ts +9 -9
  20. package/build/internal/src/middleware/api.d.ts +173 -0
  21. package/build/internal/src/middleware/billing.d.ts +10 -0
  22. package/build/internal/src/middleware/chat.d.ts +3662 -172
  23. package/build/internal/src/middleware/checklist.d.ts +18 -10
  24. package/build/internal/src/middleware/command.d.ts +540 -140
  25. package/build/internal/src/middleware/endUser.d.ts +2 -0
  26. package/build/internal/src/middleware/experienceTemplate.d.ts +2874 -8
  27. package/build/internal/src/middleware/experiencesSearch.d.ts +233 -28
  28. package/build/internal/src/middleware/flags.d.ts +14 -1
  29. package/build/internal/src/middleware/generics.d.ts +1 -0
  30. package/build/internal/src/middleware/helpDocsIntegration.d.ts +98 -0
  31. package/build/internal/src/middleware/helpDocsSearch.d.ts +165 -20
  32. package/build/internal/src/middleware/helpDocsSync.d.ts +4 -0
  33. package/build/internal/src/middleware/helpers/actions.d.ts +6 -6
  34. package/build/internal/src/middleware/helpers/commandTemplate.d.ts +2 -2
  35. package/build/internal/src/middleware/helpers/rules.d.ts +7 -7
  36. package/build/internal/src/middleware/localizedMessage.d.ts +50 -0
  37. package/build/internal/src/middleware/network.d.ts +1 -0
  38. package/build/internal/src/middleware/nudge.d.ts +96 -24
  39. package/build/internal/src/middleware/organization.d.ts +180 -62
  40. package/build/internal/src/middleware/organizationSettings.d.ts +8 -8
  41. package/build/internal/src/middleware/profile.d.ts +8 -0
  42. package/build/internal/src/middleware/recommendationSet.d.ts +18 -9
  43. package/build/internal/src/middleware/theme.d.ts +7 -0
  44. package/build/internal/src/middleware/types.d.ts +23 -5
  45. package/build/internal/src/middleware/user.d.ts +9 -1
  46. package/build/internal/src/middleware/workflow.d.ts +69 -0
  47. package/package.json +5 -2
  48. package/src/index.ts +0 -1
  49. package/src/init.ts +27 -13
  50. package/src/snippet.ts +79 -74
  51. package/build/internal/src/client/OrgConfig.d.ts +0 -5
  52. package/build/internal/src/middleware/guide.d.ts +0 -37
@@ -2,40 +2,2190 @@ import * as t from 'io-ts';
2
2
  export declare const ExperienceTemplateV: t.TypeC<{
3
3
  id: t.NumberC;
4
4
  type: t.UnionC<[t.LiteralC<"announcement">, t.LiteralC<"product_tour">, t.LiteralC<"survey">]>;
5
- data: t.RecordC<t.StringC, t.AnyC>;
5
+ data: t.IntersectionC<[t.IntersectionC<[t.TypeC<{
6
+ slug: t.StringC;
7
+ id: t.UnionC<[t.NumberC, t.StringC]>;
8
+ organization: t.StringC;
9
+ show_expression: t.Type<import("./helpers/rules").RuleExpression, import("./helpers/rules").RuleExpression, unknown>;
10
+ trigger: t.UnionC<[t.TypeC<{
11
+ type: t.LiteralC<"when_conditions_pass">;
12
+ }>, t.TypeC<{
13
+ type: t.LiteralC<"when_page_reached">;
14
+ meta: t.TypeC<{
15
+ url: t.StringC;
16
+ }>;
17
+ }>, t.TypeC<{
18
+ type: t.LiteralC<"on_command_execution">;
19
+ meta: t.TypeC<{
20
+ command: t.StringC;
21
+ }>;
22
+ }>, t.TypeC<{
23
+ type: t.LiteralC<"on_event">;
24
+ meta: t.TypeC<{
25
+ event: t.StringC;
26
+ condition_group: t.UnionC<[t.Type<import("./helpers/rules").RuleExpression, import("./helpers/rules").RuleExpression, unknown>, t.NullC, t.UndefinedC]>;
27
+ }>;
28
+ }>, t.TypeC<{
29
+ type: t.LiteralC<"when_element_appears">;
30
+ meta: t.TypeC<{
31
+ selector: t.StringC;
32
+ }>;
33
+ }>, t.TypeC<{
34
+ type: t.LiteralC<"on_user_confusion">;
35
+ }>, t.TypeC<{
36
+ type: t.LiteralC<"on_rage_click">;
37
+ }>, t.TypeC<{
38
+ type: t.LiteralC<"smart_delay">;
39
+ }>, t.TypeC<{
40
+ type: t.LiteralC<"after_time">;
41
+ meta: t.TypeC<{
42
+ unit: t.UnionC<[t.LiteralC<"minute">, t.LiteralC<"second">]>;
43
+ value: t.NumberC;
44
+ }>;
45
+ }>, t.TypeC<{
46
+ type: t.LiteralC<"when_share_link_viewed">;
47
+ }>, t.TypeC<{
48
+ type: t.LiteralC<"scheduled">;
49
+ meta: t.TypeC<{
50
+ interval: t.UnionC<[t.LiteralC<"day">, t.LiteralC<"week">, t.LiteralC<"month">]>;
51
+ value: t.NumberC;
52
+ }>;
53
+ }>]>;
54
+ frequency_limit: t.UnionC<[t.LiteralC<"no_limit">, t.LiteralC<"once_per_session">, t.LiteralC<"once_per_user">, t.LiteralC<"until_interaction">]>;
55
+ steps: t.ArrayC<t.IntersectionC<[t.TypeC<{
56
+ id: t.NumberC;
57
+ title: t.StringC;
58
+ content: t.ArrayC<t.UnionC<[t.TypeC<{
59
+ type: t.LiteralC<"markdown">;
60
+ sort_key: t.UnionC<[t.NumberC, t.UndefinedC]>;
61
+ meta: t.TypeC<{
62
+ value: t.StringC;
63
+ }>;
64
+ }>, t.TypeC<{
65
+ type: t.LiteralC<"image">;
66
+ sort_key: t.UnionC<[t.NumberC, t.UndefinedC]>;
67
+ meta: t.TypeC<{
68
+ src: t.StringC;
69
+ file_name: t.StringC;
70
+ size: t.StringC;
71
+ }>;
72
+ }>, t.TypeC<{
73
+ type: t.LiteralC<"video">;
74
+ sort_key: t.UnionC<[t.NumberC, t.UndefinedC]>;
75
+ meta: t.UnionC<[t.TypeC<{
76
+ type: t.LiteralC<"url">;
77
+ src: t.StringC;
78
+ }>, t.TypeC<{
79
+ type: t.LiteralC<"command">;
80
+ command: t.StringC;
81
+ }>]>;
82
+ }>, t.TypeC<{
83
+ type: t.LiteralC<"help_doc_command">;
84
+ sort_key: t.UnionC<[t.NumberC, t.UndefinedC]>;
85
+ meta: t.TypeC<{
86
+ command: t.StringC;
87
+ }>;
88
+ }>, t.TypeC<{
89
+ type: t.LiteralC<"button">;
90
+ sort_key: t.UnionC<[t.NumberC, t.UndefinedC]>;
91
+ meta: t.UnionC<[t.PartialC<{
92
+ label: t.StringC;
93
+ action: t.UnionC<[t.TypeC<{
94
+ type: t.LiteralC<"execute_command">;
95
+ meta: t.IntersectionC<[t.TypeC<{
96
+ command: t.StringC;
97
+ }>, t.PartialC<{
98
+ type: t.UnionC<[t.LiteralC<"action">, t.LiteralC<"link">, t.LiteralC<"helpdoc">, t.LiteralC<"video">]>;
99
+ }>]>;
100
+ }>, t.TypeC<{
101
+ type: t.LiteralC<"no_action">;
102
+ }>, t.TypeC<{
103
+ type: t.LiteralC<"click">;
104
+ value: t.StringC;
105
+ }>, t.TypeC<{
106
+ type: t.UnionC<[t.LiteralC<"click">, t.LiteralC<"clickBySelector">, t.LiteralC<"clickByXpath">]>;
107
+ value: t.ArrayC<t.StringC>;
108
+ }>, t.IntersectionC<[t.TypeC<{
109
+ type: t.LiteralC<"link">;
110
+ value: t.StringC;
111
+ }>, t.PartialC<{
112
+ operation: t.UnionC<[t.LiteralC<"router">, t.LiteralC<"self">, t.LiteralC<"blank">, t.UndefinedC]>;
113
+ }>]>, t.TypeC<{
114
+ type: t.LiteralC<"open_chat">;
115
+ meta: t.TypeC<{
116
+ type: t.UnionC<[t.LiteralC<"intercom">, t.LiteralC<"helpscout">, t.LiteralC<"freshdesk">, t.LiteralC<"freshchat">, t.LiteralC<"crisp">, t.LiteralC<"zendesk">, t.LiteralC<"liveChat">, t.LiteralC<"gist">, t.LiteralC<"olark">, t.LiteralC<"hubspot">, t.LiteralC<"drift">, t.LiteralC<"zendesk_handoff">, t.LiteralC<"">]>;
117
+ }>;
118
+ }>, t.TypeC<{
119
+ type: t.LiteralC<"dismiss">;
120
+ }>, t.TypeC<{
121
+ type: t.LiteralC<"snooze">;
122
+ }>, t.TypeC<{
123
+ type: t.LiteralC<"questlist">;
124
+ value: t.NumberC;
125
+ }>, t.TypeC<{
126
+ type: t.LiteralC<"step_back">;
127
+ }>, t.TypeC<{
128
+ type: t.LiteralC<"nudge">;
129
+ value: t.NumberC;
130
+ }>, t.TypeC<{
131
+ type: t.LiteralC<"go_to_step">;
132
+ value: t.NumberC;
133
+ }>, t.IntersectionC<[t.TypeC<{
134
+ type: t.LiteralC<"open_bar">;
135
+ }>, t.PartialC<{
136
+ value: t.StringC;
137
+ categoryFilter: t.NumberC;
138
+ }>]>, t.TypeC<{
139
+ type: t.LiteralC<"open_helphub">;
140
+ }>, t.TypeC<{
141
+ type: t.LiteralC<"open_copilot">;
142
+ }>]>;
143
+ button_type: t.UnionC<[t.LiteralC<"primary">, t.LiteralC<"secondary">, t.LiteralC<"snooze">]>;
144
+ conditional_actions: t.ArrayC<t.TypeC<{
145
+ operator: t.UnionC<[t.LiteralC<"eq">, t.LiteralC<"neq">, t.LiteralC<"gt">, t.LiteralC<"lt">]>;
146
+ operand: t.UnionC<[t.StringC, t.NumberC]>;
147
+ action: t.UnionC<[t.TypeC<{
148
+ type: t.LiteralC<"execute_command">;
149
+ meta: t.IntersectionC<[t.TypeC<{
150
+ command: t.StringC;
151
+ }>, t.PartialC<{
152
+ type: t.UnionC<[t.LiteralC<"action">, t.LiteralC<"link">, t.LiteralC<"helpdoc">, t.LiteralC<"video">]>;
153
+ }>]>;
154
+ }>, t.TypeC<{
155
+ type: t.LiteralC<"no_action">;
156
+ }>, t.TypeC<{
157
+ type: t.LiteralC<"click">;
158
+ value: t.StringC;
159
+ }>, t.TypeC<{
160
+ type: t.UnionC<[t.LiteralC<"click">, t.LiteralC<"clickBySelector">, t.LiteralC<"clickByXpath">]>;
161
+ value: t.ArrayC<t.StringC>;
162
+ }>, t.IntersectionC<[t.TypeC<{
163
+ type: t.LiteralC<"link">;
164
+ value: t.StringC;
165
+ }>, t.PartialC<{
166
+ operation: t.UnionC<[t.LiteralC<"router">, t.LiteralC<"self">, t.LiteralC<"blank">, t.UndefinedC]>;
167
+ }>]>, t.TypeC<{
168
+ type: t.LiteralC<"open_chat">;
169
+ meta: t.TypeC<{
170
+ type: t.UnionC<[t.LiteralC<"intercom">, t.LiteralC<"helpscout">, t.LiteralC<"freshdesk">, t.LiteralC<"freshchat">, t.LiteralC<"crisp">, t.LiteralC<"zendesk">, t.LiteralC<"liveChat">, t.LiteralC<"gist">, t.LiteralC<"olark">, t.LiteralC<"hubspot">, t.LiteralC<"drift">, t.LiteralC<"zendesk_handoff">, t.LiteralC<"">]>;
171
+ }>;
172
+ }>, t.TypeC<{
173
+ type: t.LiteralC<"dismiss">;
174
+ }>, t.TypeC<{
175
+ type: t.LiteralC<"snooze">;
176
+ }>, t.TypeC<{
177
+ type: t.LiteralC<"questlist">;
178
+ value: t.NumberC;
179
+ }>, t.TypeC<{
180
+ type: t.LiteralC<"step_back">;
181
+ }>, t.TypeC<{
182
+ type: t.LiteralC<"nudge">;
183
+ value: t.NumberC;
184
+ }>, t.TypeC<{
185
+ type: t.LiteralC<"go_to_step">;
186
+ value: t.NumberC;
187
+ }>, t.IntersectionC<[t.TypeC<{
188
+ type: t.LiteralC<"open_bar">;
189
+ }>, t.PartialC<{
190
+ value: t.StringC;
191
+ categoryFilter: t.NumberC;
192
+ }>]>, t.TypeC<{
193
+ type: t.LiteralC<"open_helphub">;
194
+ }>, t.TypeC<{
195
+ type: t.LiteralC<"open_copilot">;
196
+ }>]>;
197
+ }>>;
198
+ }>, t.NullC]>;
199
+ }>, t.TypeC<{
200
+ type: t.LiteralC<"survey_text">;
201
+ meta: t.IntersectionC<[t.TypeC<{
202
+ prompt: t.StringC;
203
+ }>, t.PartialC<{
204
+ validation: t.PartialC<{
205
+ required: t.UnionC<[t.TypeC<{
206
+ value: t.LiteralC<true>;
207
+ message: t.StringC;
208
+ }>, t.TypeC<{
209
+ value: t.LiteralC<false>;
210
+ message: t.NullC;
211
+ }>]>;
212
+ }>;
213
+ }>]>;
214
+ sort_key: t.UnionC<[t.NumberC, t.UndefinedC]>;
215
+ }>, t.TypeC<{
216
+ type: t.LiteralC<"survey_text_short">;
217
+ meta: t.IntersectionC<[t.TypeC<{
218
+ prompt: t.StringC;
219
+ }>, t.PartialC<{
220
+ validation: t.PartialC<{
221
+ required: t.UnionC<[t.TypeC<{
222
+ value: t.LiteralC<true>;
223
+ message: t.StringC;
224
+ }>, t.TypeC<{
225
+ value: t.LiteralC<false>;
226
+ message: t.NullC;
227
+ }>]>;
228
+ }>;
229
+ }>]>;
230
+ sort_key: t.UnionC<[t.NumberC, t.UndefinedC]>;
231
+ }>, t.TypeC<{
232
+ type: t.LiteralC<"survey_rating">;
233
+ sort_key: t.UnionC<[t.NumberC, t.UndefinedC]>;
234
+ meta: t.IntersectionC<[t.UnionC<[t.TypeC<{
235
+ type: t.LiteralC<"emojis">;
236
+ lower_label: t.StringC;
237
+ upper_label: t.StringC;
238
+ options: t.NumberC;
239
+ emojis: t.ArrayC<t.StringC>;
240
+ }>, t.TypeC<{
241
+ type: t.LiteralC<"numbers">;
242
+ lower_label: t.StringC;
243
+ upper_label: t.StringC;
244
+ options: t.NumberC;
245
+ }>, t.TypeC<{
246
+ type: t.LiteralC<"stars">;
247
+ lower_label: t.StringC;
248
+ upper_label: t.StringC;
249
+ options: t.NumberC;
250
+ }>, t.TypeC<{
251
+ type: t.LiteralC<"nps">;
252
+ lower_label: t.StringC;
253
+ upper_label: t.StringC;
254
+ options: t.NumberC;
255
+ }>]>, t.PartialC<{
256
+ validation: t.PartialC<{
257
+ required: t.UnionC<[t.TypeC<{
258
+ value: t.LiteralC<true>;
259
+ message: t.StringC;
260
+ }>, t.TypeC<{
261
+ value: t.LiteralC<false>;
262
+ message: t.NullC;
263
+ }>]>;
264
+ }>;
265
+ }>]>;
266
+ }>, t.TypeC<{
267
+ type: t.LiteralC<"survey_list">;
268
+ sort_key: t.UnionC<[t.NumberC, t.UndefinedC]>;
269
+ meta: t.IntersectionC<[t.TypeC<{
270
+ options: t.ArrayC<t.StringC>;
271
+ list_type: t.UnionC<[t.LiteralC<"single">, t.LiteralC<"multiple">]>;
272
+ display_type: t.UnionC<[t.LiteralC<"dropdown">, t.LiteralC<"list">, t.LiteralC<"grid">]>;
273
+ }>, t.PartialC<{
274
+ validation: t.PartialC<{
275
+ required: t.UnionC<[t.TypeC<{
276
+ value: t.LiteralC<true>;
277
+ message: t.StringC;
278
+ }>, t.TypeC<{
279
+ value: t.LiteralC<false>;
280
+ message: t.NullC;
281
+ }>]>;
282
+ }>;
283
+ }>]>;
284
+ }>]>>;
285
+ is_live: t.BooleanC;
286
+ preview_url: t.UnionC<[t.StringC, t.NullC, t.UndefinedC]>;
287
+ }>, t.IntersectionC<[t.TypeC<{
288
+ form_factor: t.UnionC<[t.TypeC<{
289
+ type: t.LiteralC<"modal">;
290
+ }>, t.TypeC<{
291
+ type: t.LiteralC<"popover">;
292
+ position: t.UnionC<[t.LiteralC<"top-left">, t.LiteralC<"top-right">, t.LiteralC<"bottom-right">, t.LiteralC<"bottom-left">, t.LiteralC<"center">]>;
293
+ }>, t.IntersectionC<[t.TypeC<{
294
+ type: t.LiteralC<"pin">;
295
+ anchor: t.StringC;
296
+ }>, t.PartialC<{
297
+ is_open_by_default: t.BooleanC;
298
+ is_showing_mask: t.BooleanC;
299
+ advance_trigger: t.StringC;
300
+ offset: t.TypeC<{
301
+ x: t.StringC;
302
+ y: t.StringC;
303
+ }>;
304
+ }>]>, t.TypeC<{
305
+ type: t.LiteralC<"tooltip">;
306
+ anchor: t.StringC;
307
+ show_on: t.UnionC<[t.LiteralC<"hover">, t.LiteralC<"click">]>;
308
+ marker: t.IntersectionC<[t.UnionC<[t.TypeC<{
309
+ type: t.LiteralC<"beacon">;
310
+ }>, t.TypeC<{
311
+ type: t.LiteralC<"icon">;
312
+ icon: t.UnionC<[t.LiteralC<"helpCircle">, t.LiteralC<"helpSquare">, t.LiteralC<"infoCircle">, t.LiteralC<"bookClosed">, t.LiteralC<"lightBulb">, t.LiteralC<"lightning">]>;
313
+ }>, t.TypeC<{
314
+ type: t.LiteralC<"image">;
315
+ source: t.StringC;
316
+ }>]>, t.TypeC<{
317
+ positioning: t.TypeC<{
318
+ position: t.UnionC<[t.LiteralC<"left">, t.LiteralC<"right">, t.LiteralC<"inline_left">, t.LiteralC<"inline_right">]>;
319
+ offset: t.TypeC<{
320
+ x: t.StringC;
321
+ y: t.StringC;
322
+ }>;
323
+ }>;
324
+ }>]>;
325
+ }>]>;
326
+ }>, t.PartialC<{
327
+ has_survey_response: t.BooleanC;
328
+ }>]>]>>;
329
+ is_live: t.BooleanC;
330
+ }>, t.PartialC<{
331
+ old_nudge_id: t.UnionC<[t.NumberC, t.NullC]>;
332
+ archived: t.BooleanC;
333
+ audience: t.UnionC<[t.UnionC<[t.TypeC<{
334
+ type: t.LiteralC<"all_users">;
335
+ }>, t.TypeC<{
336
+ type: t.LiteralC<"rule_expression">;
337
+ expression: t.Type<import("./helpers/rules").RuleExpression, import("./helpers/rules").RuleExpression, unknown>;
338
+ }>, t.TypeC<{
339
+ type: t.LiteralC<"named_rule_reference">;
340
+ rule_reference: t.IntersectionC<[t.TypeC<{
341
+ type: t.LiteralC<"named_rule">;
342
+ rule_id: t.UnionC<[t.NumberC, t.StringC]>;
343
+ }>, t.PartialC<{
344
+ reason: t.StringC;
345
+ }>]>;
346
+ }>]>, t.NullC]>;
347
+ }>]>, t.TypeC<{
348
+ template_source: t.StringC;
349
+ show_step_counter: t.BooleanC;
350
+ dismissible: t.BooleanC;
351
+ snoozable: t.BooleanC;
352
+ share_page_url_or_path: t.StringC;
353
+ copilot_suggest: t.BooleanC;
354
+ show_in_spotlight_search: t.BooleanC;
355
+ show_in_helphub_search: t.BooleanC;
356
+ copilot_cta_label: t.StringC;
357
+ copilot_description: t.StringC;
358
+ is_scheduled: t.BooleanC;
359
+ scheduled_start_time: t.UnionC<[t.StringC, t.NullC, t.UndefinedC]>;
360
+ scheduled_end_time: t.UnionC<[t.StringC, t.NullC, t.UndefinedC]>;
361
+ snooze_label: t.StringC;
362
+ type: t.UnionC<[t.LiteralC<"announcement">, t.LiteralC<"product_tour">, t.LiteralC<"survey">, t.NullC]>;
363
+ editor_tags: t.ArrayC<t.StringC>;
364
+ preview_url: t.UnionC<[t.StringC, t.NullC, t.UndefinedC]>;
365
+ }>]>;
6
366
  }>;
7
367
  export declare class ExperienceTemplate {
8
368
  static decode: (data: any) => {
9
369
  id: number;
10
370
  type: "announcement" | "product_tour" | "survey";
11
371
  data: {
12
- [x: string]: any;
372
+ slug: string;
373
+ id: string | number;
374
+ organization: string;
375
+ show_expression: import("./helpers/rules").RuleExpression;
376
+ trigger: {
377
+ type: "when_conditions_pass";
378
+ } | {
379
+ type: "when_page_reached";
380
+ meta: {
381
+ url: string;
382
+ };
383
+ } | {
384
+ type: "on_command_execution";
385
+ meta: {
386
+ command: string;
387
+ };
388
+ } | {
389
+ type: "on_event";
390
+ meta: {
391
+ event: string;
392
+ condition_group: import("./helpers/rules").RuleExpression | null | undefined;
393
+ };
394
+ } | {
395
+ type: "when_element_appears";
396
+ meta: {
397
+ selector: string;
398
+ };
399
+ } | {
400
+ type: "on_user_confusion";
401
+ } | {
402
+ type: "on_rage_click";
403
+ } | {
404
+ type: "smart_delay";
405
+ } | {
406
+ type: "after_time";
407
+ meta: {
408
+ unit: "minute" | "second";
409
+ value: number;
410
+ };
411
+ } | {
412
+ type: "when_share_link_viewed";
413
+ } | {
414
+ type: "scheduled";
415
+ meta: {
416
+ interval: "day" | "month" | "week";
417
+ value: number;
418
+ };
419
+ };
420
+ frequency_limit: "no_limit" | "once_per_session" | "once_per_user" | "until_interaction";
421
+ steps: ({
422
+ id: number;
423
+ title: string;
424
+ content: ({
425
+ type: "markdown";
426
+ sort_key: number | undefined;
427
+ meta: {
428
+ value: string;
429
+ };
430
+ } | {
431
+ type: "image";
432
+ sort_key: number | undefined;
433
+ meta: {
434
+ src: string;
435
+ file_name: string;
436
+ size: string;
437
+ };
438
+ } | {
439
+ type: "video";
440
+ sort_key: number | undefined;
441
+ meta: {
442
+ type: "url";
443
+ src: string;
444
+ } | {
445
+ type: "command";
446
+ command: string;
447
+ };
448
+ } | {
449
+ type: "help_doc_command";
450
+ sort_key: number | undefined;
451
+ meta: {
452
+ command: string;
453
+ };
454
+ } | {
455
+ type: "button";
456
+ sort_key: number | undefined;
457
+ meta: {
458
+ label?: string | undefined;
459
+ action?: {
460
+ type: "execute_command";
461
+ meta: {
462
+ command: string;
463
+ } & {
464
+ type?: "link" | "video" | "action" | "helpdoc" | undefined;
465
+ };
466
+ } | {
467
+ type: "no_action";
468
+ } | {
469
+ type: "click";
470
+ value: string;
471
+ } | {
472
+ type: "click" | "clickBySelector" | "clickByXpath";
473
+ value: string[];
474
+ } | ({
475
+ type: "link";
476
+ value: string;
477
+ } & {
478
+ operation?: "self" | "router" | "blank" | undefined;
479
+ }) | {
480
+ type: "open_chat";
481
+ meta: {
482
+ type: "" | "intercom" | "helpscout" | "freshdesk" | "freshchat" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "hubspot" | "drift" | "zendesk_handoff";
483
+ };
484
+ } | {
485
+ type: "dismiss";
486
+ } | {
487
+ type: "snooze";
488
+ } | {
489
+ type: "questlist";
490
+ value: number;
491
+ } | {
492
+ type: "step_back";
493
+ } | {
494
+ type: "nudge";
495
+ value: number;
496
+ } | {
497
+ type: "go_to_step";
498
+ value: number;
499
+ } | ({
500
+ type: "open_bar";
501
+ } & {
502
+ value?: string | undefined;
503
+ categoryFilter?: number | undefined;
504
+ }) | {
505
+ type: "open_helphub";
506
+ } | {
507
+ type: "open_copilot";
508
+ } | undefined;
509
+ button_type?: "snooze" | "primary" | "secondary" | undefined;
510
+ conditional_actions?: {
511
+ operator: "eq" | "neq" | "gt" | "lt";
512
+ operand: string | number;
513
+ action: {
514
+ type: "execute_command";
515
+ meta: {
516
+ command: string;
517
+ } & {
518
+ type?: "link" | "video" | "action" | "helpdoc" | undefined;
519
+ };
520
+ } | {
521
+ type: "no_action";
522
+ } | {
523
+ type: "click";
524
+ value: string;
525
+ } | {
526
+ type: "click" | "clickBySelector" | "clickByXpath";
527
+ value: string[];
528
+ } | ({
529
+ type: "link";
530
+ value: string;
531
+ } & {
532
+ operation?: "self" | "router" | "blank" | undefined;
533
+ }) | {
534
+ type: "open_chat";
535
+ meta: {
536
+ type: "" | "intercom" | "helpscout" | "freshdesk" | "freshchat" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "hubspot" | "drift" | "zendesk_handoff";
537
+ };
538
+ } | {
539
+ type: "dismiss";
540
+ } | {
541
+ type: "snooze";
542
+ } | {
543
+ type: "questlist";
544
+ value: number;
545
+ } | {
546
+ type: "step_back";
547
+ } | {
548
+ type: "nudge";
549
+ value: number;
550
+ } | {
551
+ type: "go_to_step";
552
+ value: number;
553
+ } | ({
554
+ type: "open_bar";
555
+ } & {
556
+ value?: string | undefined;
557
+ categoryFilter?: number | undefined;
558
+ }) | {
559
+ type: "open_helphub";
560
+ } | {
561
+ type: "open_copilot";
562
+ };
563
+ }[] | undefined;
564
+ } | null;
565
+ } | {
566
+ type: "survey_text";
567
+ meta: {
568
+ prompt: string;
569
+ } & {
570
+ validation?: {
571
+ required?: {
572
+ value: true;
573
+ message: string;
574
+ } | {
575
+ value: false;
576
+ message: null;
577
+ } | undefined;
578
+ } | undefined;
579
+ };
580
+ sort_key: number | undefined;
581
+ } | {
582
+ type: "survey_text_short";
583
+ meta: {
584
+ prompt: string;
585
+ } & {
586
+ validation?: {
587
+ required?: {
588
+ value: true;
589
+ message: string;
590
+ } | {
591
+ value: false;
592
+ message: null;
593
+ } | undefined;
594
+ } | undefined;
595
+ };
596
+ sort_key: number | undefined;
597
+ } | {
598
+ type: "survey_rating";
599
+ sort_key: number | undefined;
600
+ meta: ({
601
+ type: "emojis";
602
+ lower_label: string;
603
+ upper_label: string;
604
+ options: number;
605
+ emojis: string[];
606
+ } | {
607
+ type: "numbers";
608
+ lower_label: string;
609
+ upper_label: string;
610
+ options: number;
611
+ } | {
612
+ type: "stars";
613
+ lower_label: string;
614
+ upper_label: string;
615
+ options: number;
616
+ } | {
617
+ type: "nps";
618
+ lower_label: string;
619
+ upper_label: string;
620
+ options: number;
621
+ }) & {
622
+ validation?: {
623
+ required?: {
624
+ value: true;
625
+ message: string;
626
+ } | {
627
+ value: false;
628
+ message: null;
629
+ } | undefined;
630
+ } | undefined;
631
+ };
632
+ } | {
633
+ type: "survey_list";
634
+ sort_key: number | undefined;
635
+ meta: {
636
+ options: string[];
637
+ list_type: "multiple" | "single";
638
+ display_type: "grid" | "list" | "dropdown";
639
+ } & {
640
+ validation?: {
641
+ required?: {
642
+ value: true;
643
+ message: string;
644
+ } | {
645
+ value: false;
646
+ message: null;
647
+ } | undefined;
648
+ } | undefined;
649
+ };
650
+ })[];
651
+ is_live: boolean;
652
+ preview_url: string | null | undefined;
653
+ } & {
654
+ form_factor: {
655
+ type: "modal";
656
+ } | {
657
+ type: "popover";
658
+ position: "center" | "top-left" | "top-right" | "bottom-right" | "bottom-left";
659
+ } | ({
660
+ type: "pin";
661
+ anchor: string;
662
+ } & {
663
+ is_open_by_default?: boolean | undefined;
664
+ is_showing_mask?: boolean | undefined;
665
+ advance_trigger?: string | undefined;
666
+ offset?: {
667
+ x: string;
668
+ y: string;
669
+ } | undefined;
670
+ }) | {
671
+ type: "tooltip";
672
+ anchor: string;
673
+ show_on: "click" | "hover";
674
+ marker: ({
675
+ type: "beacon";
676
+ } | {
677
+ type: "icon";
678
+ icon: "helpCircle" | "helpSquare" | "infoCircle" | "bookClosed" | "lightBulb" | "lightning";
679
+ } | {
680
+ type: "image";
681
+ source: string;
682
+ }) & {
683
+ positioning: {
684
+ position: "left" | "right" | "inline_left" | "inline_right";
685
+ offset: {
686
+ x: string;
687
+ y: string;
688
+ };
689
+ };
690
+ };
691
+ };
692
+ } & {
693
+ has_survey_response?: boolean | undefined;
694
+ })[];
695
+ is_live: boolean;
696
+ } & {
697
+ old_nudge_id?: number | null | undefined;
698
+ archived?: boolean | undefined;
699
+ audience?: {
700
+ type: "all_users";
701
+ } | {
702
+ type: "rule_expression";
703
+ expression: import("./helpers/rules").RuleExpression;
704
+ } | {
705
+ type: "named_rule_reference";
706
+ rule_reference: {
707
+ type: "named_rule";
708
+ rule_id: string | number;
709
+ } & {
710
+ reason?: string | undefined;
711
+ };
712
+ } | null | undefined;
713
+ } & {
714
+ template_source: string;
715
+ show_step_counter: boolean;
716
+ dismissible: boolean;
717
+ snoozable: boolean;
718
+ share_page_url_or_path: string;
719
+ copilot_suggest: boolean;
720
+ show_in_spotlight_search: boolean;
721
+ show_in_helphub_search: boolean;
722
+ copilot_cta_label: string;
723
+ copilot_description: string;
724
+ is_scheduled: boolean;
725
+ scheduled_start_time: string | null | undefined;
726
+ scheduled_end_time: string | null | undefined;
727
+ snooze_label: string;
728
+ type: "announcement" | "product_tour" | "survey" | null;
729
+ editor_tags: string[];
730
+ preview_url: string | null | undefined;
13
731
  };
14
732
  };
15
733
  static create: (object: {
16
734
  id: number;
17
735
  type: "announcement" | "product_tour" | "survey";
18
736
  data: {
19
- [x: string]: any;
737
+ slug: string;
738
+ id: string | number;
739
+ organization: string;
740
+ show_expression: import("./helpers/rules").RuleExpression;
741
+ trigger: {
742
+ type: "when_conditions_pass";
743
+ } | {
744
+ type: "when_page_reached";
745
+ meta: {
746
+ url: string;
747
+ };
748
+ } | {
749
+ type: "on_command_execution";
750
+ meta: {
751
+ command: string;
752
+ };
753
+ } | {
754
+ type: "on_event";
755
+ meta: {
756
+ event: string;
757
+ condition_group: import("./helpers/rules").RuleExpression | null | undefined;
758
+ };
759
+ } | {
760
+ type: "when_element_appears";
761
+ meta: {
762
+ selector: string;
763
+ };
764
+ } | {
765
+ type: "on_user_confusion";
766
+ } | {
767
+ type: "on_rage_click";
768
+ } | {
769
+ type: "smart_delay";
770
+ } | {
771
+ type: "after_time";
772
+ meta: {
773
+ unit: "minute" | "second";
774
+ value: number;
775
+ };
776
+ } | {
777
+ type: "when_share_link_viewed";
778
+ } | {
779
+ type: "scheduled";
780
+ meta: {
781
+ interval: "day" | "month" | "week";
782
+ value: number;
783
+ };
784
+ };
785
+ frequency_limit: "no_limit" | "once_per_session" | "once_per_user" | "until_interaction";
786
+ steps: ({
787
+ id: number;
788
+ title: string;
789
+ content: ({
790
+ type: "markdown";
791
+ sort_key: number | undefined;
792
+ meta: {
793
+ value: string;
794
+ };
795
+ } | {
796
+ type: "image";
797
+ sort_key: number | undefined;
798
+ meta: {
799
+ src: string;
800
+ file_name: string;
801
+ size: string;
802
+ };
803
+ } | {
804
+ type: "video";
805
+ sort_key: number | undefined;
806
+ meta: {
807
+ type: "url";
808
+ src: string;
809
+ } | {
810
+ type: "command";
811
+ command: string;
812
+ };
813
+ } | {
814
+ type: "help_doc_command";
815
+ sort_key: number | undefined;
816
+ meta: {
817
+ command: string;
818
+ };
819
+ } | {
820
+ type: "button";
821
+ sort_key: number | undefined;
822
+ meta: {
823
+ label?: string | undefined;
824
+ action?: {
825
+ type: "execute_command";
826
+ meta: {
827
+ command: string;
828
+ } & {
829
+ type?: "link" | "video" | "action" | "helpdoc" | undefined;
830
+ };
831
+ } | {
832
+ type: "no_action";
833
+ } | {
834
+ type: "click";
835
+ value: string;
836
+ } | {
837
+ type: "click" | "clickBySelector" | "clickByXpath";
838
+ value: string[];
839
+ } | ({
840
+ type: "link";
841
+ value: string;
842
+ } & {
843
+ operation?: "self" | "router" | "blank" | undefined;
844
+ }) | {
845
+ type: "open_chat";
846
+ meta: {
847
+ type: "" | "intercom" | "helpscout" | "freshdesk" | "freshchat" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "hubspot" | "drift" | "zendesk_handoff";
848
+ };
849
+ } | {
850
+ type: "dismiss";
851
+ } | {
852
+ type: "snooze";
853
+ } | {
854
+ type: "questlist";
855
+ value: number;
856
+ } | {
857
+ type: "step_back";
858
+ } | {
859
+ type: "nudge";
860
+ value: number;
861
+ } | {
862
+ type: "go_to_step";
863
+ value: number;
864
+ } | ({
865
+ type: "open_bar";
866
+ } & {
867
+ value?: string | undefined;
868
+ categoryFilter?: number | undefined;
869
+ }) | {
870
+ type: "open_helphub";
871
+ } | {
872
+ type: "open_copilot";
873
+ } | undefined;
874
+ button_type?: "snooze" | "primary" | "secondary" | undefined;
875
+ conditional_actions?: {
876
+ operator: "eq" | "neq" | "gt" | "lt";
877
+ operand: string | number;
878
+ action: {
879
+ type: "execute_command";
880
+ meta: {
881
+ command: string;
882
+ } & {
883
+ type?: "link" | "video" | "action" | "helpdoc" | undefined;
884
+ };
885
+ } | {
886
+ type: "no_action";
887
+ } | {
888
+ type: "click";
889
+ value: string;
890
+ } | {
891
+ type: "click" | "clickBySelector" | "clickByXpath";
892
+ value: string[];
893
+ } | ({
894
+ type: "link";
895
+ value: string;
896
+ } & {
897
+ operation?: "self" | "router" | "blank" | undefined;
898
+ }) | {
899
+ type: "open_chat";
900
+ meta: {
901
+ type: "" | "intercom" | "helpscout" | "freshdesk" | "freshchat" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "hubspot" | "drift" | "zendesk_handoff";
902
+ };
903
+ } | {
904
+ type: "dismiss";
905
+ } | {
906
+ type: "snooze";
907
+ } | {
908
+ type: "questlist";
909
+ value: number;
910
+ } | {
911
+ type: "step_back";
912
+ } | {
913
+ type: "nudge";
914
+ value: number;
915
+ } | {
916
+ type: "go_to_step";
917
+ value: number;
918
+ } | ({
919
+ type: "open_bar";
920
+ } & {
921
+ value?: string | undefined;
922
+ categoryFilter?: number | undefined;
923
+ }) | {
924
+ type: "open_helphub";
925
+ } | {
926
+ type: "open_copilot";
927
+ };
928
+ }[] | undefined;
929
+ } | null;
930
+ } | {
931
+ type: "survey_text";
932
+ meta: {
933
+ prompt: string;
934
+ } & {
935
+ validation?: {
936
+ required?: {
937
+ value: true;
938
+ message: string;
939
+ } | {
940
+ value: false;
941
+ message: null;
942
+ } | undefined;
943
+ } | undefined;
944
+ };
945
+ sort_key: number | undefined;
946
+ } | {
947
+ type: "survey_text_short";
948
+ meta: {
949
+ prompt: string;
950
+ } & {
951
+ validation?: {
952
+ required?: {
953
+ value: true;
954
+ message: string;
955
+ } | {
956
+ value: false;
957
+ message: null;
958
+ } | undefined;
959
+ } | undefined;
960
+ };
961
+ sort_key: number | undefined;
962
+ } | {
963
+ type: "survey_rating";
964
+ sort_key: number | undefined;
965
+ meta: ({
966
+ type: "emojis";
967
+ lower_label: string;
968
+ upper_label: string;
969
+ options: number;
970
+ emojis: string[];
971
+ } | {
972
+ type: "numbers";
973
+ lower_label: string;
974
+ upper_label: string;
975
+ options: number;
976
+ } | {
977
+ type: "stars";
978
+ lower_label: string;
979
+ upper_label: string;
980
+ options: number;
981
+ } | {
982
+ type: "nps";
983
+ lower_label: string;
984
+ upper_label: string;
985
+ options: number;
986
+ }) & {
987
+ validation?: {
988
+ required?: {
989
+ value: true;
990
+ message: string;
991
+ } | {
992
+ value: false;
993
+ message: null;
994
+ } | undefined;
995
+ } | undefined;
996
+ };
997
+ } | {
998
+ type: "survey_list";
999
+ sort_key: number | undefined;
1000
+ meta: {
1001
+ options: string[];
1002
+ list_type: "multiple" | "single";
1003
+ display_type: "grid" | "list" | "dropdown";
1004
+ } & {
1005
+ validation?: {
1006
+ required?: {
1007
+ value: true;
1008
+ message: string;
1009
+ } | {
1010
+ value: false;
1011
+ message: null;
1012
+ } | undefined;
1013
+ } | undefined;
1014
+ };
1015
+ })[];
1016
+ is_live: boolean;
1017
+ preview_url: string | null | undefined;
1018
+ } & {
1019
+ form_factor: {
1020
+ type: "modal";
1021
+ } | {
1022
+ type: "popover";
1023
+ position: "center" | "top-left" | "top-right" | "bottom-right" | "bottom-left";
1024
+ } | ({
1025
+ type: "pin";
1026
+ anchor: string;
1027
+ } & {
1028
+ is_open_by_default?: boolean | undefined;
1029
+ is_showing_mask?: boolean | undefined;
1030
+ advance_trigger?: string | undefined;
1031
+ offset?: {
1032
+ x: string;
1033
+ y: string;
1034
+ } | undefined;
1035
+ }) | {
1036
+ type: "tooltip";
1037
+ anchor: string;
1038
+ show_on: "click" | "hover";
1039
+ marker: ({
1040
+ type: "beacon";
1041
+ } | {
1042
+ type: "icon";
1043
+ icon: "helpCircle" | "helpSquare" | "infoCircle" | "bookClosed" | "lightBulb" | "lightning";
1044
+ } | {
1045
+ type: "image";
1046
+ source: string;
1047
+ }) & {
1048
+ positioning: {
1049
+ position: "left" | "right" | "inline_left" | "inline_right";
1050
+ offset: {
1051
+ x: string;
1052
+ y: string;
1053
+ };
1054
+ };
1055
+ };
1056
+ };
1057
+ } & {
1058
+ has_survey_response?: boolean | undefined;
1059
+ })[];
1060
+ is_live: boolean;
1061
+ } & {
1062
+ old_nudge_id?: number | null | undefined;
1063
+ archived?: boolean | undefined;
1064
+ audience?: {
1065
+ type: "all_users";
1066
+ } | {
1067
+ type: "rule_expression";
1068
+ expression: import("./helpers/rules").RuleExpression;
1069
+ } | {
1070
+ type: "named_rule_reference";
1071
+ rule_reference: {
1072
+ type: "named_rule";
1073
+ rule_id: string | number;
1074
+ } & {
1075
+ reason?: string | undefined;
1076
+ };
1077
+ } | null | undefined;
1078
+ } & {
1079
+ template_source: string;
1080
+ show_step_counter: boolean;
1081
+ dismissible: boolean;
1082
+ snoozable: boolean;
1083
+ share_page_url_or_path: string;
1084
+ copilot_suggest: boolean;
1085
+ show_in_spotlight_search: boolean;
1086
+ show_in_helphub_search: boolean;
1087
+ copilot_cta_label: string;
1088
+ copilot_description: string;
1089
+ is_scheduled: boolean;
1090
+ scheduled_start_time: string | null | undefined;
1091
+ scheduled_end_time: string | null | undefined;
1092
+ snooze_label: string;
1093
+ type: "announcement" | "product_tour" | "survey" | null;
1094
+ editor_tags: string[];
1095
+ preview_url: string | null | undefined;
20
1096
  };
21
1097
  }, onSuccess?: (() => void) | undefined, onError?: ((err: string) => void) | undefined) => Promise<{
22
1098
  id: number;
23
1099
  type: "announcement" | "product_tour" | "survey";
24
1100
  data: {
25
- [x: string]: any;
1101
+ slug: string;
1102
+ id: string | number;
1103
+ organization: string;
1104
+ show_expression: import("./helpers/rules").RuleExpression;
1105
+ trigger: {
1106
+ type: "when_conditions_pass";
1107
+ } | {
1108
+ type: "when_page_reached";
1109
+ meta: {
1110
+ url: string;
1111
+ };
1112
+ } | {
1113
+ type: "on_command_execution";
1114
+ meta: {
1115
+ command: string;
1116
+ };
1117
+ } | {
1118
+ type: "on_event";
1119
+ meta: {
1120
+ event: string;
1121
+ condition_group: import("./helpers/rules").RuleExpression | null | undefined;
1122
+ };
1123
+ } | {
1124
+ type: "when_element_appears";
1125
+ meta: {
1126
+ selector: string;
1127
+ };
1128
+ } | {
1129
+ type: "on_user_confusion";
1130
+ } | {
1131
+ type: "on_rage_click";
1132
+ } | {
1133
+ type: "smart_delay";
1134
+ } | {
1135
+ type: "after_time";
1136
+ meta: {
1137
+ unit: "minute" | "second";
1138
+ value: number;
1139
+ };
1140
+ } | {
1141
+ type: "when_share_link_viewed";
1142
+ } | {
1143
+ type: "scheduled";
1144
+ meta: {
1145
+ interval: "day" | "month" | "week";
1146
+ value: number;
1147
+ };
1148
+ };
1149
+ frequency_limit: "no_limit" | "once_per_session" | "once_per_user" | "until_interaction";
1150
+ steps: ({
1151
+ id: number;
1152
+ title: string;
1153
+ content: ({
1154
+ type: "markdown";
1155
+ sort_key: number | undefined;
1156
+ meta: {
1157
+ value: string;
1158
+ };
1159
+ } | {
1160
+ type: "image";
1161
+ sort_key: number | undefined;
1162
+ meta: {
1163
+ src: string;
1164
+ file_name: string;
1165
+ size: string;
1166
+ };
1167
+ } | {
1168
+ type: "video";
1169
+ sort_key: number | undefined;
1170
+ meta: {
1171
+ type: "url";
1172
+ src: string;
1173
+ } | {
1174
+ type: "command";
1175
+ command: string;
1176
+ };
1177
+ } | {
1178
+ type: "help_doc_command";
1179
+ sort_key: number | undefined;
1180
+ meta: {
1181
+ command: string;
1182
+ };
1183
+ } | {
1184
+ type: "button";
1185
+ sort_key: number | undefined;
1186
+ meta: {
1187
+ label?: string | undefined;
1188
+ action?: {
1189
+ type: "execute_command";
1190
+ meta: {
1191
+ command: string;
1192
+ } & {
1193
+ type?: "link" | "video" | "action" | "helpdoc" | undefined;
1194
+ };
1195
+ } | {
1196
+ type: "no_action";
1197
+ } | {
1198
+ type: "click";
1199
+ value: string;
1200
+ } | {
1201
+ type: "click" | "clickBySelector" | "clickByXpath";
1202
+ value: string[];
1203
+ } | ({
1204
+ type: "link";
1205
+ value: string;
1206
+ } & {
1207
+ operation?: "self" | "router" | "blank" | undefined;
1208
+ }) | {
1209
+ type: "open_chat";
1210
+ meta: {
1211
+ type: "" | "intercom" | "helpscout" | "freshdesk" | "freshchat" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "hubspot" | "drift" | "zendesk_handoff";
1212
+ };
1213
+ } | {
1214
+ type: "dismiss";
1215
+ } | {
1216
+ type: "snooze";
1217
+ } | {
1218
+ type: "questlist";
1219
+ value: number;
1220
+ } | {
1221
+ type: "step_back";
1222
+ } | {
1223
+ type: "nudge";
1224
+ value: number;
1225
+ } | {
1226
+ type: "go_to_step";
1227
+ value: number;
1228
+ } | ({
1229
+ type: "open_bar";
1230
+ } & {
1231
+ value?: string | undefined;
1232
+ categoryFilter?: number | undefined;
1233
+ }) | {
1234
+ type: "open_helphub";
1235
+ } | {
1236
+ type: "open_copilot";
1237
+ } | undefined;
1238
+ button_type?: "snooze" | "primary" | "secondary" | undefined;
1239
+ conditional_actions?: {
1240
+ operator: "eq" | "neq" | "gt" | "lt";
1241
+ operand: string | number;
1242
+ action: {
1243
+ type: "execute_command";
1244
+ meta: {
1245
+ command: string;
1246
+ } & {
1247
+ type?: "link" | "video" | "action" | "helpdoc" | undefined;
1248
+ };
1249
+ } | {
1250
+ type: "no_action";
1251
+ } | {
1252
+ type: "click";
1253
+ value: string;
1254
+ } | {
1255
+ type: "click" | "clickBySelector" | "clickByXpath";
1256
+ value: string[];
1257
+ } | ({
1258
+ type: "link";
1259
+ value: string;
1260
+ } & {
1261
+ operation?: "self" | "router" | "blank" | undefined;
1262
+ }) | {
1263
+ type: "open_chat";
1264
+ meta: {
1265
+ type: "" | "intercom" | "helpscout" | "freshdesk" | "freshchat" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "hubspot" | "drift" | "zendesk_handoff";
1266
+ };
1267
+ } | {
1268
+ type: "dismiss";
1269
+ } | {
1270
+ type: "snooze";
1271
+ } | {
1272
+ type: "questlist";
1273
+ value: number;
1274
+ } | {
1275
+ type: "step_back";
1276
+ } | {
1277
+ type: "nudge";
1278
+ value: number;
1279
+ } | {
1280
+ type: "go_to_step";
1281
+ value: number;
1282
+ } | ({
1283
+ type: "open_bar";
1284
+ } & {
1285
+ value?: string | undefined;
1286
+ categoryFilter?: number | undefined;
1287
+ }) | {
1288
+ type: "open_helphub";
1289
+ } | {
1290
+ type: "open_copilot";
1291
+ };
1292
+ }[] | undefined;
1293
+ } | null;
1294
+ } | {
1295
+ type: "survey_text";
1296
+ meta: {
1297
+ prompt: string;
1298
+ } & {
1299
+ validation?: {
1300
+ required?: {
1301
+ value: true;
1302
+ message: string;
1303
+ } | {
1304
+ value: false;
1305
+ message: null;
1306
+ } | undefined;
1307
+ } | undefined;
1308
+ };
1309
+ sort_key: number | undefined;
1310
+ } | {
1311
+ type: "survey_text_short";
1312
+ meta: {
1313
+ prompt: string;
1314
+ } & {
1315
+ validation?: {
1316
+ required?: {
1317
+ value: true;
1318
+ message: string;
1319
+ } | {
1320
+ value: false;
1321
+ message: null;
1322
+ } | undefined;
1323
+ } | undefined;
1324
+ };
1325
+ sort_key: number | undefined;
1326
+ } | {
1327
+ type: "survey_rating";
1328
+ sort_key: number | undefined;
1329
+ meta: ({
1330
+ type: "emojis";
1331
+ lower_label: string;
1332
+ upper_label: string;
1333
+ options: number;
1334
+ emojis: string[];
1335
+ } | {
1336
+ type: "numbers";
1337
+ lower_label: string;
1338
+ upper_label: string;
1339
+ options: number;
1340
+ } | {
1341
+ type: "stars";
1342
+ lower_label: string;
1343
+ upper_label: string;
1344
+ options: number;
1345
+ } | {
1346
+ type: "nps";
1347
+ lower_label: string;
1348
+ upper_label: string;
1349
+ options: number;
1350
+ }) & {
1351
+ validation?: {
1352
+ required?: {
1353
+ value: true;
1354
+ message: string;
1355
+ } | {
1356
+ value: false;
1357
+ message: null;
1358
+ } | undefined;
1359
+ } | undefined;
1360
+ };
1361
+ } | {
1362
+ type: "survey_list";
1363
+ sort_key: number | undefined;
1364
+ meta: {
1365
+ options: string[];
1366
+ list_type: "multiple" | "single";
1367
+ display_type: "grid" | "list" | "dropdown";
1368
+ } & {
1369
+ validation?: {
1370
+ required?: {
1371
+ value: true;
1372
+ message: string;
1373
+ } | {
1374
+ value: false;
1375
+ message: null;
1376
+ } | undefined;
1377
+ } | undefined;
1378
+ };
1379
+ })[];
1380
+ is_live: boolean;
1381
+ preview_url: string | null | undefined;
1382
+ } & {
1383
+ form_factor: {
1384
+ type: "modal";
1385
+ } | {
1386
+ type: "popover";
1387
+ position: "center" | "top-left" | "top-right" | "bottom-right" | "bottom-left";
1388
+ } | ({
1389
+ type: "pin";
1390
+ anchor: string;
1391
+ } & {
1392
+ is_open_by_default?: boolean | undefined;
1393
+ is_showing_mask?: boolean | undefined;
1394
+ advance_trigger?: string | undefined;
1395
+ offset?: {
1396
+ x: string;
1397
+ y: string;
1398
+ } | undefined;
1399
+ }) | {
1400
+ type: "tooltip";
1401
+ anchor: string;
1402
+ show_on: "click" | "hover";
1403
+ marker: ({
1404
+ type: "beacon";
1405
+ } | {
1406
+ type: "icon";
1407
+ icon: "helpCircle" | "helpSquare" | "infoCircle" | "bookClosed" | "lightBulb" | "lightning";
1408
+ } | {
1409
+ type: "image";
1410
+ source: string;
1411
+ }) & {
1412
+ positioning: {
1413
+ position: "left" | "right" | "inline_left" | "inline_right";
1414
+ offset: {
1415
+ x: string;
1416
+ y: string;
1417
+ };
1418
+ };
1419
+ };
1420
+ };
1421
+ } & {
1422
+ has_survey_response?: boolean | undefined;
1423
+ })[];
1424
+ is_live: boolean;
1425
+ } & {
1426
+ old_nudge_id?: number | null | undefined;
1427
+ archived?: boolean | undefined;
1428
+ audience?: {
1429
+ type: "all_users";
1430
+ } | {
1431
+ type: "rule_expression";
1432
+ expression: import("./helpers/rules").RuleExpression;
1433
+ } | {
1434
+ type: "named_rule_reference";
1435
+ rule_reference: {
1436
+ type: "named_rule";
1437
+ rule_id: string | number;
1438
+ } & {
1439
+ reason?: string | undefined;
1440
+ };
1441
+ } | null | undefined;
1442
+ } & {
1443
+ template_source: string;
1444
+ show_step_counter: boolean;
1445
+ dismissible: boolean;
1446
+ snoozable: boolean;
1447
+ share_page_url_or_path: string;
1448
+ copilot_suggest: boolean;
1449
+ show_in_spotlight_search: boolean;
1450
+ show_in_helphub_search: boolean;
1451
+ copilot_cta_label: string;
1452
+ copilot_description: string;
1453
+ is_scheduled: boolean;
1454
+ scheduled_start_time: string | null | undefined;
1455
+ scheduled_end_time: string | null | undefined;
1456
+ snooze_label: string;
1457
+ type: "announcement" | "product_tour" | "survey" | null;
1458
+ editor_tags: string[];
1459
+ preview_url: string | null | undefined;
26
1460
  };
27
1461
  }>;
28
1462
  static update: (object: {
29
1463
  id: number;
30
1464
  type: "announcement" | "product_tour" | "survey";
31
1465
  data: {
32
- [x: string]: any;
1466
+ slug: string;
1467
+ id: string | number;
1468
+ organization: string;
1469
+ show_expression: import("./helpers/rules").RuleExpression;
1470
+ trigger: {
1471
+ type: "when_conditions_pass";
1472
+ } | {
1473
+ type: "when_page_reached";
1474
+ meta: {
1475
+ url: string;
1476
+ };
1477
+ } | {
1478
+ type: "on_command_execution";
1479
+ meta: {
1480
+ command: string;
1481
+ };
1482
+ } | {
1483
+ type: "on_event";
1484
+ meta: {
1485
+ event: string;
1486
+ condition_group: import("./helpers/rules").RuleExpression | null | undefined;
1487
+ };
1488
+ } | {
1489
+ type: "when_element_appears";
1490
+ meta: {
1491
+ selector: string;
1492
+ };
1493
+ } | {
1494
+ type: "on_user_confusion";
1495
+ } | {
1496
+ type: "on_rage_click";
1497
+ } | {
1498
+ type: "smart_delay";
1499
+ } | {
1500
+ type: "after_time";
1501
+ meta: {
1502
+ unit: "minute" | "second";
1503
+ value: number;
1504
+ };
1505
+ } | {
1506
+ type: "when_share_link_viewed";
1507
+ } | {
1508
+ type: "scheduled";
1509
+ meta: {
1510
+ interval: "day" | "month" | "week";
1511
+ value: number;
1512
+ };
1513
+ };
1514
+ frequency_limit: "no_limit" | "once_per_session" | "once_per_user" | "until_interaction";
1515
+ steps: ({
1516
+ id: number;
1517
+ title: string;
1518
+ content: ({
1519
+ type: "markdown";
1520
+ sort_key: number | undefined;
1521
+ meta: {
1522
+ value: string;
1523
+ };
1524
+ } | {
1525
+ type: "image";
1526
+ sort_key: number | undefined;
1527
+ meta: {
1528
+ src: string;
1529
+ file_name: string;
1530
+ size: string;
1531
+ };
1532
+ } | {
1533
+ type: "video";
1534
+ sort_key: number | undefined;
1535
+ meta: {
1536
+ type: "url";
1537
+ src: string;
1538
+ } | {
1539
+ type: "command";
1540
+ command: string;
1541
+ };
1542
+ } | {
1543
+ type: "help_doc_command";
1544
+ sort_key: number | undefined;
1545
+ meta: {
1546
+ command: string;
1547
+ };
1548
+ } | {
1549
+ type: "button";
1550
+ sort_key: number | undefined;
1551
+ meta: {
1552
+ label?: string | undefined;
1553
+ action?: {
1554
+ type: "execute_command";
1555
+ meta: {
1556
+ command: string;
1557
+ } & {
1558
+ type?: "link" | "video" | "action" | "helpdoc" | undefined;
1559
+ };
1560
+ } | {
1561
+ type: "no_action";
1562
+ } | {
1563
+ type: "click";
1564
+ value: string;
1565
+ } | {
1566
+ type: "click" | "clickBySelector" | "clickByXpath";
1567
+ value: string[];
1568
+ } | ({
1569
+ type: "link";
1570
+ value: string;
1571
+ } & {
1572
+ operation?: "self" | "router" | "blank" | undefined;
1573
+ }) | {
1574
+ type: "open_chat";
1575
+ meta: {
1576
+ type: "" | "intercom" | "helpscout" | "freshdesk" | "freshchat" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "hubspot" | "drift" | "zendesk_handoff";
1577
+ };
1578
+ } | {
1579
+ type: "dismiss";
1580
+ } | {
1581
+ type: "snooze";
1582
+ } | {
1583
+ type: "questlist";
1584
+ value: number;
1585
+ } | {
1586
+ type: "step_back";
1587
+ } | {
1588
+ type: "nudge";
1589
+ value: number;
1590
+ } | {
1591
+ type: "go_to_step";
1592
+ value: number;
1593
+ } | ({
1594
+ type: "open_bar";
1595
+ } & {
1596
+ value?: string | undefined;
1597
+ categoryFilter?: number | undefined;
1598
+ }) | {
1599
+ type: "open_helphub";
1600
+ } | {
1601
+ type: "open_copilot";
1602
+ } | undefined;
1603
+ button_type?: "snooze" | "primary" | "secondary" | undefined;
1604
+ conditional_actions?: {
1605
+ operator: "eq" | "neq" | "gt" | "lt";
1606
+ operand: string | number;
1607
+ action: {
1608
+ type: "execute_command";
1609
+ meta: {
1610
+ command: string;
1611
+ } & {
1612
+ type?: "link" | "video" | "action" | "helpdoc" | undefined;
1613
+ };
1614
+ } | {
1615
+ type: "no_action";
1616
+ } | {
1617
+ type: "click";
1618
+ value: string;
1619
+ } | {
1620
+ type: "click" | "clickBySelector" | "clickByXpath";
1621
+ value: string[];
1622
+ } | ({
1623
+ type: "link";
1624
+ value: string;
1625
+ } & {
1626
+ operation?: "self" | "router" | "blank" | undefined;
1627
+ }) | {
1628
+ type: "open_chat";
1629
+ meta: {
1630
+ type: "" | "intercom" | "helpscout" | "freshdesk" | "freshchat" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "hubspot" | "drift" | "zendesk_handoff";
1631
+ };
1632
+ } | {
1633
+ type: "dismiss";
1634
+ } | {
1635
+ type: "snooze";
1636
+ } | {
1637
+ type: "questlist";
1638
+ value: number;
1639
+ } | {
1640
+ type: "step_back";
1641
+ } | {
1642
+ type: "nudge";
1643
+ value: number;
1644
+ } | {
1645
+ type: "go_to_step";
1646
+ value: number;
1647
+ } | ({
1648
+ type: "open_bar";
1649
+ } & {
1650
+ value?: string | undefined;
1651
+ categoryFilter?: number | undefined;
1652
+ }) | {
1653
+ type: "open_helphub";
1654
+ } | {
1655
+ type: "open_copilot";
1656
+ };
1657
+ }[] | undefined;
1658
+ } | null;
1659
+ } | {
1660
+ type: "survey_text";
1661
+ meta: {
1662
+ prompt: string;
1663
+ } & {
1664
+ validation?: {
1665
+ required?: {
1666
+ value: true;
1667
+ message: string;
1668
+ } | {
1669
+ value: false;
1670
+ message: null;
1671
+ } | undefined;
1672
+ } | undefined;
1673
+ };
1674
+ sort_key: number | undefined;
1675
+ } | {
1676
+ type: "survey_text_short";
1677
+ meta: {
1678
+ prompt: string;
1679
+ } & {
1680
+ validation?: {
1681
+ required?: {
1682
+ value: true;
1683
+ message: string;
1684
+ } | {
1685
+ value: false;
1686
+ message: null;
1687
+ } | undefined;
1688
+ } | undefined;
1689
+ };
1690
+ sort_key: number | undefined;
1691
+ } | {
1692
+ type: "survey_rating";
1693
+ sort_key: number | undefined;
1694
+ meta: ({
1695
+ type: "emojis";
1696
+ lower_label: string;
1697
+ upper_label: string;
1698
+ options: number;
1699
+ emojis: string[];
1700
+ } | {
1701
+ type: "numbers";
1702
+ lower_label: string;
1703
+ upper_label: string;
1704
+ options: number;
1705
+ } | {
1706
+ type: "stars";
1707
+ lower_label: string;
1708
+ upper_label: string;
1709
+ options: number;
1710
+ } | {
1711
+ type: "nps";
1712
+ lower_label: string;
1713
+ upper_label: string;
1714
+ options: number;
1715
+ }) & {
1716
+ validation?: {
1717
+ required?: {
1718
+ value: true;
1719
+ message: string;
1720
+ } | {
1721
+ value: false;
1722
+ message: null;
1723
+ } | undefined;
1724
+ } | undefined;
1725
+ };
1726
+ } | {
1727
+ type: "survey_list";
1728
+ sort_key: number | undefined;
1729
+ meta: {
1730
+ options: string[];
1731
+ list_type: "multiple" | "single";
1732
+ display_type: "grid" | "list" | "dropdown";
1733
+ } & {
1734
+ validation?: {
1735
+ required?: {
1736
+ value: true;
1737
+ message: string;
1738
+ } | {
1739
+ value: false;
1740
+ message: null;
1741
+ } | undefined;
1742
+ } | undefined;
1743
+ };
1744
+ })[];
1745
+ is_live: boolean;
1746
+ preview_url: string | null | undefined;
1747
+ } & {
1748
+ form_factor: {
1749
+ type: "modal";
1750
+ } | {
1751
+ type: "popover";
1752
+ position: "center" | "top-left" | "top-right" | "bottom-right" | "bottom-left";
1753
+ } | ({
1754
+ type: "pin";
1755
+ anchor: string;
1756
+ } & {
1757
+ is_open_by_default?: boolean | undefined;
1758
+ is_showing_mask?: boolean | undefined;
1759
+ advance_trigger?: string | undefined;
1760
+ offset?: {
1761
+ x: string;
1762
+ y: string;
1763
+ } | undefined;
1764
+ }) | {
1765
+ type: "tooltip";
1766
+ anchor: string;
1767
+ show_on: "click" | "hover";
1768
+ marker: ({
1769
+ type: "beacon";
1770
+ } | {
1771
+ type: "icon";
1772
+ icon: "helpCircle" | "helpSquare" | "infoCircle" | "bookClosed" | "lightBulb" | "lightning";
1773
+ } | {
1774
+ type: "image";
1775
+ source: string;
1776
+ }) & {
1777
+ positioning: {
1778
+ position: "left" | "right" | "inline_left" | "inline_right";
1779
+ offset: {
1780
+ x: string;
1781
+ y: string;
1782
+ };
1783
+ };
1784
+ };
1785
+ };
1786
+ } & {
1787
+ has_survey_response?: boolean | undefined;
1788
+ })[];
1789
+ is_live: boolean;
1790
+ } & {
1791
+ old_nudge_id?: number | null | undefined;
1792
+ archived?: boolean | undefined;
1793
+ audience?: {
1794
+ type: "all_users";
1795
+ } | {
1796
+ type: "rule_expression";
1797
+ expression: import("./helpers/rules").RuleExpression;
1798
+ } | {
1799
+ type: "named_rule_reference";
1800
+ rule_reference: {
1801
+ type: "named_rule";
1802
+ rule_id: string | number;
1803
+ } & {
1804
+ reason?: string | undefined;
1805
+ };
1806
+ } | null | undefined;
1807
+ } & {
1808
+ template_source: string;
1809
+ show_step_counter: boolean;
1810
+ dismissible: boolean;
1811
+ snoozable: boolean;
1812
+ share_page_url_or_path: string;
1813
+ copilot_suggest: boolean;
1814
+ show_in_spotlight_search: boolean;
1815
+ show_in_helphub_search: boolean;
1816
+ copilot_cta_label: string;
1817
+ copilot_description: string;
1818
+ is_scheduled: boolean;
1819
+ scheduled_start_time: string | null | undefined;
1820
+ scheduled_end_time: string | null | undefined;
1821
+ snooze_label: string;
1822
+ type: "announcement" | "product_tour" | "survey" | null;
1823
+ editor_tags: string[];
1824
+ preview_url: string | null | undefined;
33
1825
  };
34
1826
  }, onSuccess?: (() => void) | undefined, onError?: ((err: string) => void) | undefined) => Promise<{
35
1827
  id: number;
36
1828
  type: "announcement" | "product_tour" | "survey";
37
1829
  data: {
38
- [x: string]: any;
1830
+ slug: string;
1831
+ id: string | number;
1832
+ organization: string;
1833
+ show_expression: import("./helpers/rules").RuleExpression;
1834
+ trigger: {
1835
+ type: "when_conditions_pass";
1836
+ } | {
1837
+ type: "when_page_reached";
1838
+ meta: {
1839
+ url: string;
1840
+ };
1841
+ } | {
1842
+ type: "on_command_execution";
1843
+ meta: {
1844
+ command: string;
1845
+ };
1846
+ } | {
1847
+ type: "on_event";
1848
+ meta: {
1849
+ event: string;
1850
+ condition_group: import("./helpers/rules").RuleExpression | null | undefined;
1851
+ };
1852
+ } | {
1853
+ type: "when_element_appears";
1854
+ meta: {
1855
+ selector: string;
1856
+ };
1857
+ } | {
1858
+ type: "on_user_confusion";
1859
+ } | {
1860
+ type: "on_rage_click";
1861
+ } | {
1862
+ type: "smart_delay";
1863
+ } | {
1864
+ type: "after_time";
1865
+ meta: {
1866
+ unit: "minute" | "second";
1867
+ value: number;
1868
+ };
1869
+ } | {
1870
+ type: "when_share_link_viewed";
1871
+ } | {
1872
+ type: "scheduled";
1873
+ meta: {
1874
+ interval: "day" | "month" | "week";
1875
+ value: number;
1876
+ };
1877
+ };
1878
+ frequency_limit: "no_limit" | "once_per_session" | "once_per_user" | "until_interaction";
1879
+ steps: ({
1880
+ id: number;
1881
+ title: string;
1882
+ content: ({
1883
+ type: "markdown";
1884
+ sort_key: number | undefined;
1885
+ meta: {
1886
+ value: string;
1887
+ };
1888
+ } | {
1889
+ type: "image";
1890
+ sort_key: number | undefined;
1891
+ meta: {
1892
+ src: string;
1893
+ file_name: string;
1894
+ size: string;
1895
+ };
1896
+ } | {
1897
+ type: "video";
1898
+ sort_key: number | undefined;
1899
+ meta: {
1900
+ type: "url";
1901
+ src: string;
1902
+ } | {
1903
+ type: "command";
1904
+ command: string;
1905
+ };
1906
+ } | {
1907
+ type: "help_doc_command";
1908
+ sort_key: number | undefined;
1909
+ meta: {
1910
+ command: string;
1911
+ };
1912
+ } | {
1913
+ type: "button";
1914
+ sort_key: number | undefined;
1915
+ meta: {
1916
+ label?: string | undefined;
1917
+ action?: {
1918
+ type: "execute_command";
1919
+ meta: {
1920
+ command: string;
1921
+ } & {
1922
+ type?: "link" | "video" | "action" | "helpdoc" | undefined;
1923
+ };
1924
+ } | {
1925
+ type: "no_action";
1926
+ } | {
1927
+ type: "click";
1928
+ value: string;
1929
+ } | {
1930
+ type: "click" | "clickBySelector" | "clickByXpath";
1931
+ value: string[];
1932
+ } | ({
1933
+ type: "link";
1934
+ value: string;
1935
+ } & {
1936
+ operation?: "self" | "router" | "blank" | undefined;
1937
+ }) | {
1938
+ type: "open_chat";
1939
+ meta: {
1940
+ type: "" | "intercom" | "helpscout" | "freshdesk" | "freshchat" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "hubspot" | "drift" | "zendesk_handoff";
1941
+ };
1942
+ } | {
1943
+ type: "dismiss";
1944
+ } | {
1945
+ type: "snooze";
1946
+ } | {
1947
+ type: "questlist";
1948
+ value: number;
1949
+ } | {
1950
+ type: "step_back";
1951
+ } | {
1952
+ type: "nudge";
1953
+ value: number;
1954
+ } | {
1955
+ type: "go_to_step";
1956
+ value: number;
1957
+ } | ({
1958
+ type: "open_bar";
1959
+ } & {
1960
+ value?: string | undefined;
1961
+ categoryFilter?: number | undefined;
1962
+ }) | {
1963
+ type: "open_helphub";
1964
+ } | {
1965
+ type: "open_copilot";
1966
+ } | undefined;
1967
+ button_type?: "snooze" | "primary" | "secondary" | undefined;
1968
+ conditional_actions?: {
1969
+ operator: "eq" | "neq" | "gt" | "lt";
1970
+ operand: string | number;
1971
+ action: {
1972
+ type: "execute_command";
1973
+ meta: {
1974
+ command: string;
1975
+ } & {
1976
+ type?: "link" | "video" | "action" | "helpdoc" | undefined;
1977
+ };
1978
+ } | {
1979
+ type: "no_action";
1980
+ } | {
1981
+ type: "click";
1982
+ value: string;
1983
+ } | {
1984
+ type: "click" | "clickBySelector" | "clickByXpath";
1985
+ value: string[];
1986
+ } | ({
1987
+ type: "link";
1988
+ value: string;
1989
+ } & {
1990
+ operation?: "self" | "router" | "blank" | undefined;
1991
+ }) | {
1992
+ type: "open_chat";
1993
+ meta: {
1994
+ type: "" | "intercom" | "helpscout" | "freshdesk" | "freshchat" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "hubspot" | "drift" | "zendesk_handoff";
1995
+ };
1996
+ } | {
1997
+ type: "dismiss";
1998
+ } | {
1999
+ type: "snooze";
2000
+ } | {
2001
+ type: "questlist";
2002
+ value: number;
2003
+ } | {
2004
+ type: "step_back";
2005
+ } | {
2006
+ type: "nudge";
2007
+ value: number;
2008
+ } | {
2009
+ type: "go_to_step";
2010
+ value: number;
2011
+ } | ({
2012
+ type: "open_bar";
2013
+ } & {
2014
+ value?: string | undefined;
2015
+ categoryFilter?: number | undefined;
2016
+ }) | {
2017
+ type: "open_helphub";
2018
+ } | {
2019
+ type: "open_copilot";
2020
+ };
2021
+ }[] | undefined;
2022
+ } | null;
2023
+ } | {
2024
+ type: "survey_text";
2025
+ meta: {
2026
+ prompt: string;
2027
+ } & {
2028
+ validation?: {
2029
+ required?: {
2030
+ value: true;
2031
+ message: string;
2032
+ } | {
2033
+ value: false;
2034
+ message: null;
2035
+ } | undefined;
2036
+ } | undefined;
2037
+ };
2038
+ sort_key: number | undefined;
2039
+ } | {
2040
+ type: "survey_text_short";
2041
+ meta: {
2042
+ prompt: string;
2043
+ } & {
2044
+ validation?: {
2045
+ required?: {
2046
+ value: true;
2047
+ message: string;
2048
+ } | {
2049
+ value: false;
2050
+ message: null;
2051
+ } | undefined;
2052
+ } | undefined;
2053
+ };
2054
+ sort_key: number | undefined;
2055
+ } | {
2056
+ type: "survey_rating";
2057
+ sort_key: number | undefined;
2058
+ meta: ({
2059
+ type: "emojis";
2060
+ lower_label: string;
2061
+ upper_label: string;
2062
+ options: number;
2063
+ emojis: string[];
2064
+ } | {
2065
+ type: "numbers";
2066
+ lower_label: string;
2067
+ upper_label: string;
2068
+ options: number;
2069
+ } | {
2070
+ type: "stars";
2071
+ lower_label: string;
2072
+ upper_label: string;
2073
+ options: number;
2074
+ } | {
2075
+ type: "nps";
2076
+ lower_label: string;
2077
+ upper_label: string;
2078
+ options: number;
2079
+ }) & {
2080
+ validation?: {
2081
+ required?: {
2082
+ value: true;
2083
+ message: string;
2084
+ } | {
2085
+ value: false;
2086
+ message: null;
2087
+ } | undefined;
2088
+ } | undefined;
2089
+ };
2090
+ } | {
2091
+ type: "survey_list";
2092
+ sort_key: number | undefined;
2093
+ meta: {
2094
+ options: string[];
2095
+ list_type: "multiple" | "single";
2096
+ display_type: "grid" | "list" | "dropdown";
2097
+ } & {
2098
+ validation?: {
2099
+ required?: {
2100
+ value: true;
2101
+ message: string;
2102
+ } | {
2103
+ value: false;
2104
+ message: null;
2105
+ } | undefined;
2106
+ } | undefined;
2107
+ };
2108
+ })[];
2109
+ is_live: boolean;
2110
+ preview_url: string | null | undefined;
2111
+ } & {
2112
+ form_factor: {
2113
+ type: "modal";
2114
+ } | {
2115
+ type: "popover";
2116
+ position: "center" | "top-left" | "top-right" | "bottom-right" | "bottom-left";
2117
+ } | ({
2118
+ type: "pin";
2119
+ anchor: string;
2120
+ } & {
2121
+ is_open_by_default?: boolean | undefined;
2122
+ is_showing_mask?: boolean | undefined;
2123
+ advance_trigger?: string | undefined;
2124
+ offset?: {
2125
+ x: string;
2126
+ y: string;
2127
+ } | undefined;
2128
+ }) | {
2129
+ type: "tooltip";
2130
+ anchor: string;
2131
+ show_on: "click" | "hover";
2132
+ marker: ({
2133
+ type: "beacon";
2134
+ } | {
2135
+ type: "icon";
2136
+ icon: "helpCircle" | "helpSquare" | "infoCircle" | "bookClosed" | "lightBulb" | "lightning";
2137
+ } | {
2138
+ type: "image";
2139
+ source: string;
2140
+ }) & {
2141
+ positioning: {
2142
+ position: "left" | "right" | "inline_left" | "inline_right";
2143
+ offset: {
2144
+ x: string;
2145
+ y: string;
2146
+ };
2147
+ };
2148
+ };
2149
+ };
2150
+ } & {
2151
+ has_survey_response?: boolean | undefined;
2152
+ })[];
2153
+ is_live: boolean;
2154
+ } & {
2155
+ old_nudge_id?: number | null | undefined;
2156
+ archived?: boolean | undefined;
2157
+ audience?: {
2158
+ type: "all_users";
2159
+ } | {
2160
+ type: "rule_expression";
2161
+ expression: import("./helpers/rules").RuleExpression;
2162
+ } | {
2163
+ type: "named_rule_reference";
2164
+ rule_reference: {
2165
+ type: "named_rule";
2166
+ rule_id: string | number;
2167
+ } & {
2168
+ reason?: string | undefined;
2169
+ };
2170
+ } | null | undefined;
2171
+ } & {
2172
+ template_source: string;
2173
+ show_step_counter: boolean;
2174
+ dismissible: boolean;
2175
+ snoozable: boolean;
2176
+ share_page_url_or_path: string;
2177
+ copilot_suggest: boolean;
2178
+ show_in_spotlight_search: boolean;
2179
+ show_in_helphub_search: boolean;
2180
+ copilot_cta_label: string;
2181
+ copilot_description: string;
2182
+ is_scheduled: boolean;
2183
+ scheduled_start_time: string | null | undefined;
2184
+ scheduled_end_time: string | null | undefined;
2185
+ snooze_label: string;
2186
+ type: "announcement" | "product_tour" | "survey" | null;
2187
+ editor_tags: string[];
2188
+ preview_url: string | null | undefined;
39
2189
  };
40
2190
  }>;
41
2191
  static delete: (id: string | number, params?: Record<string, string> | undefined, onSuccess?: (() => void) | undefined, onError?: ((err: string) => void) | undefined) => Promise<void>;
@@ -43,7 +2193,365 @@ export declare class ExperienceTemplate {
43
2193
  id: number;
44
2194
  type: "announcement" | "product_tour" | "survey";
45
2195
  data: {
46
- [x: string]: any;
2196
+ slug: string;
2197
+ id: string | number;
2198
+ organization: string;
2199
+ show_expression: import("./helpers/rules").RuleExpression;
2200
+ trigger: {
2201
+ type: "when_conditions_pass";
2202
+ } | {
2203
+ type: "when_page_reached";
2204
+ meta: {
2205
+ url: string;
2206
+ };
2207
+ } | {
2208
+ type: "on_command_execution";
2209
+ meta: {
2210
+ command: string;
2211
+ };
2212
+ } | {
2213
+ type: "on_event";
2214
+ meta: {
2215
+ event: string;
2216
+ condition_group: import("./helpers/rules").RuleExpression | null | undefined;
2217
+ };
2218
+ } | {
2219
+ type: "when_element_appears";
2220
+ meta: {
2221
+ selector: string;
2222
+ };
2223
+ } | {
2224
+ type: "on_user_confusion";
2225
+ } | {
2226
+ type: "on_rage_click";
2227
+ } | {
2228
+ type: "smart_delay";
2229
+ } | {
2230
+ type: "after_time";
2231
+ meta: {
2232
+ unit: "minute" | "second";
2233
+ value: number;
2234
+ };
2235
+ } | {
2236
+ type: "when_share_link_viewed";
2237
+ } | {
2238
+ type: "scheduled";
2239
+ meta: {
2240
+ interval: "day" | "month" | "week";
2241
+ value: number;
2242
+ };
2243
+ };
2244
+ frequency_limit: "no_limit" | "once_per_session" | "once_per_user" | "until_interaction";
2245
+ steps: ({
2246
+ id: number;
2247
+ title: string;
2248
+ content: ({
2249
+ type: "markdown";
2250
+ sort_key: number | undefined;
2251
+ meta: {
2252
+ value: string;
2253
+ };
2254
+ } | {
2255
+ type: "image";
2256
+ sort_key: number | undefined;
2257
+ meta: {
2258
+ src: string;
2259
+ file_name: string;
2260
+ size: string;
2261
+ };
2262
+ } | {
2263
+ type: "video";
2264
+ sort_key: number | undefined;
2265
+ meta: {
2266
+ type: "url";
2267
+ src: string;
2268
+ } | {
2269
+ type: "command";
2270
+ command: string;
2271
+ };
2272
+ } | {
2273
+ type: "help_doc_command";
2274
+ sort_key: number | undefined;
2275
+ meta: {
2276
+ command: string;
2277
+ };
2278
+ } | {
2279
+ type: "button";
2280
+ sort_key: number | undefined;
2281
+ meta: {
2282
+ label?: string | undefined;
2283
+ action?: {
2284
+ type: "execute_command";
2285
+ meta: {
2286
+ command: string;
2287
+ } & {
2288
+ type?: "link" | "video" | "action" | "helpdoc" | undefined;
2289
+ };
2290
+ } | {
2291
+ type: "no_action";
2292
+ } | {
2293
+ type: "click";
2294
+ value: string;
2295
+ } | {
2296
+ type: "click" | "clickBySelector" | "clickByXpath";
2297
+ value: string[];
2298
+ } | ({
2299
+ type: "link";
2300
+ value: string;
2301
+ } & {
2302
+ operation?: "self" | "router" | "blank" | undefined;
2303
+ }) | {
2304
+ type: "open_chat";
2305
+ meta: {
2306
+ type: "" | "intercom" | "helpscout" | "freshdesk" | "freshchat" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "hubspot" | "drift" | "zendesk_handoff";
2307
+ };
2308
+ } | {
2309
+ type: "dismiss";
2310
+ } | {
2311
+ type: "snooze";
2312
+ } | {
2313
+ type: "questlist";
2314
+ value: number;
2315
+ } | {
2316
+ type: "step_back";
2317
+ } | {
2318
+ type: "nudge";
2319
+ value: number;
2320
+ } | {
2321
+ type: "go_to_step";
2322
+ value: number;
2323
+ } | ({
2324
+ type: "open_bar";
2325
+ } & {
2326
+ value?: string | undefined;
2327
+ categoryFilter?: number | undefined;
2328
+ }) | {
2329
+ type: "open_helphub";
2330
+ } | {
2331
+ type: "open_copilot";
2332
+ } | undefined;
2333
+ button_type?: "snooze" | "primary" | "secondary" | undefined;
2334
+ conditional_actions?: {
2335
+ operator: "eq" | "neq" | "gt" | "lt";
2336
+ operand: string | number;
2337
+ action: {
2338
+ type: "execute_command";
2339
+ meta: {
2340
+ command: string;
2341
+ } & {
2342
+ type?: "link" | "video" | "action" | "helpdoc" | undefined;
2343
+ };
2344
+ } | {
2345
+ type: "no_action";
2346
+ } | {
2347
+ type: "click";
2348
+ value: string;
2349
+ } | {
2350
+ type: "click" | "clickBySelector" | "clickByXpath";
2351
+ value: string[];
2352
+ } | ({
2353
+ type: "link";
2354
+ value: string;
2355
+ } & {
2356
+ operation?: "self" | "router" | "blank" | undefined;
2357
+ }) | {
2358
+ type: "open_chat";
2359
+ meta: {
2360
+ type: "" | "intercom" | "helpscout" | "freshdesk" | "freshchat" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "hubspot" | "drift" | "zendesk_handoff";
2361
+ };
2362
+ } | {
2363
+ type: "dismiss";
2364
+ } | {
2365
+ type: "snooze";
2366
+ } | {
2367
+ type: "questlist";
2368
+ value: number;
2369
+ } | {
2370
+ type: "step_back";
2371
+ } | {
2372
+ type: "nudge";
2373
+ value: number;
2374
+ } | {
2375
+ type: "go_to_step";
2376
+ value: number;
2377
+ } | ({
2378
+ type: "open_bar";
2379
+ } & {
2380
+ value?: string | undefined;
2381
+ categoryFilter?: number | undefined;
2382
+ }) | {
2383
+ type: "open_helphub";
2384
+ } | {
2385
+ type: "open_copilot";
2386
+ };
2387
+ }[] | undefined;
2388
+ } | null;
2389
+ } | {
2390
+ type: "survey_text";
2391
+ meta: {
2392
+ prompt: string;
2393
+ } & {
2394
+ validation?: {
2395
+ required?: {
2396
+ value: true;
2397
+ message: string;
2398
+ } | {
2399
+ value: false;
2400
+ message: null;
2401
+ } | undefined;
2402
+ } | undefined;
2403
+ };
2404
+ sort_key: number | undefined;
2405
+ } | {
2406
+ type: "survey_text_short";
2407
+ meta: {
2408
+ prompt: string;
2409
+ } & {
2410
+ validation?: {
2411
+ required?: {
2412
+ value: true;
2413
+ message: string;
2414
+ } | {
2415
+ value: false;
2416
+ message: null;
2417
+ } | undefined;
2418
+ } | undefined;
2419
+ };
2420
+ sort_key: number | undefined;
2421
+ } | {
2422
+ type: "survey_rating";
2423
+ sort_key: number | undefined;
2424
+ meta: ({
2425
+ type: "emojis";
2426
+ lower_label: string;
2427
+ upper_label: string;
2428
+ options: number;
2429
+ emojis: string[];
2430
+ } | {
2431
+ type: "numbers";
2432
+ lower_label: string;
2433
+ upper_label: string;
2434
+ options: number;
2435
+ } | {
2436
+ type: "stars";
2437
+ lower_label: string;
2438
+ upper_label: string;
2439
+ options: number;
2440
+ } | {
2441
+ type: "nps";
2442
+ lower_label: string;
2443
+ upper_label: string;
2444
+ options: number;
2445
+ }) & {
2446
+ validation?: {
2447
+ required?: {
2448
+ value: true;
2449
+ message: string;
2450
+ } | {
2451
+ value: false;
2452
+ message: null;
2453
+ } | undefined;
2454
+ } | undefined;
2455
+ };
2456
+ } | {
2457
+ type: "survey_list";
2458
+ sort_key: number | undefined;
2459
+ meta: {
2460
+ options: string[];
2461
+ list_type: "multiple" | "single";
2462
+ display_type: "grid" | "list" | "dropdown";
2463
+ } & {
2464
+ validation?: {
2465
+ required?: {
2466
+ value: true;
2467
+ message: string;
2468
+ } | {
2469
+ value: false;
2470
+ message: null;
2471
+ } | undefined;
2472
+ } | undefined;
2473
+ };
2474
+ })[];
2475
+ is_live: boolean;
2476
+ preview_url: string | null | undefined;
2477
+ } & {
2478
+ form_factor: {
2479
+ type: "modal";
2480
+ } | {
2481
+ type: "popover";
2482
+ position: "center" | "top-left" | "top-right" | "bottom-right" | "bottom-left";
2483
+ } | ({
2484
+ type: "pin";
2485
+ anchor: string;
2486
+ } & {
2487
+ is_open_by_default?: boolean | undefined;
2488
+ is_showing_mask?: boolean | undefined;
2489
+ advance_trigger?: string | undefined;
2490
+ offset?: {
2491
+ x: string;
2492
+ y: string;
2493
+ } | undefined;
2494
+ }) | {
2495
+ type: "tooltip";
2496
+ anchor: string;
2497
+ show_on: "click" | "hover";
2498
+ marker: ({
2499
+ type: "beacon";
2500
+ } | {
2501
+ type: "icon";
2502
+ icon: "helpCircle" | "helpSquare" | "infoCircle" | "bookClosed" | "lightBulb" | "lightning";
2503
+ } | {
2504
+ type: "image";
2505
+ source: string;
2506
+ }) & {
2507
+ positioning: {
2508
+ position: "left" | "right" | "inline_left" | "inline_right";
2509
+ offset: {
2510
+ x: string;
2511
+ y: string;
2512
+ };
2513
+ };
2514
+ };
2515
+ };
2516
+ } & {
2517
+ has_survey_response?: boolean | undefined;
2518
+ })[];
2519
+ is_live: boolean;
2520
+ } & {
2521
+ old_nudge_id?: number | null | undefined;
2522
+ archived?: boolean | undefined;
2523
+ audience?: {
2524
+ type: "all_users";
2525
+ } | {
2526
+ type: "rule_expression";
2527
+ expression: import("./helpers/rules").RuleExpression;
2528
+ } | {
2529
+ type: "named_rule_reference";
2530
+ rule_reference: {
2531
+ type: "named_rule";
2532
+ rule_id: string | number;
2533
+ } & {
2534
+ reason?: string | undefined;
2535
+ };
2536
+ } | null | undefined;
2537
+ } & {
2538
+ template_source: string;
2539
+ show_step_counter: boolean;
2540
+ dismissible: boolean;
2541
+ snoozable: boolean;
2542
+ share_page_url_or_path: string;
2543
+ copilot_suggest: boolean;
2544
+ show_in_spotlight_search: boolean;
2545
+ show_in_helphub_search: boolean;
2546
+ copilot_cta_label: string;
2547
+ copilot_description: string;
2548
+ is_scheduled: boolean;
2549
+ scheduled_start_time: string | null | undefined;
2550
+ scheduled_end_time: string | null | undefined;
2551
+ snooze_label: string;
2552
+ type: "announcement" | "product_tour" | "survey" | null;
2553
+ editor_tags: string[];
2554
+ preview_url: string | null | undefined;
47
2555
  };
48
2556
  }[]>;
49
2557
  static read: (arg0: string, params?: Record<string, string> | undefined, callbacks?: {
@@ -53,7 +2561,365 @@ export declare class ExperienceTemplate {
53
2561
  id: number;
54
2562
  type: "announcement" | "product_tour" | "survey";
55
2563
  data: {
56
- [x: string]: any;
2564
+ slug: string;
2565
+ id: string | number;
2566
+ organization: string;
2567
+ show_expression: import("./helpers/rules").RuleExpression;
2568
+ trigger: {
2569
+ type: "when_conditions_pass";
2570
+ } | {
2571
+ type: "when_page_reached";
2572
+ meta: {
2573
+ url: string;
2574
+ };
2575
+ } | {
2576
+ type: "on_command_execution";
2577
+ meta: {
2578
+ command: string;
2579
+ };
2580
+ } | {
2581
+ type: "on_event";
2582
+ meta: {
2583
+ event: string;
2584
+ condition_group: import("./helpers/rules").RuleExpression | null | undefined;
2585
+ };
2586
+ } | {
2587
+ type: "when_element_appears";
2588
+ meta: {
2589
+ selector: string;
2590
+ };
2591
+ } | {
2592
+ type: "on_user_confusion";
2593
+ } | {
2594
+ type: "on_rage_click";
2595
+ } | {
2596
+ type: "smart_delay";
2597
+ } | {
2598
+ type: "after_time";
2599
+ meta: {
2600
+ unit: "minute" | "second";
2601
+ value: number;
2602
+ };
2603
+ } | {
2604
+ type: "when_share_link_viewed";
2605
+ } | {
2606
+ type: "scheduled";
2607
+ meta: {
2608
+ interval: "day" | "month" | "week";
2609
+ value: number;
2610
+ };
2611
+ };
2612
+ frequency_limit: "no_limit" | "once_per_session" | "once_per_user" | "until_interaction";
2613
+ steps: ({
2614
+ id: number;
2615
+ title: string;
2616
+ content: ({
2617
+ type: "markdown";
2618
+ sort_key: number | undefined;
2619
+ meta: {
2620
+ value: string;
2621
+ };
2622
+ } | {
2623
+ type: "image";
2624
+ sort_key: number | undefined;
2625
+ meta: {
2626
+ src: string;
2627
+ file_name: string;
2628
+ size: string;
2629
+ };
2630
+ } | {
2631
+ type: "video";
2632
+ sort_key: number | undefined;
2633
+ meta: {
2634
+ type: "url";
2635
+ src: string;
2636
+ } | {
2637
+ type: "command";
2638
+ command: string;
2639
+ };
2640
+ } | {
2641
+ type: "help_doc_command";
2642
+ sort_key: number | undefined;
2643
+ meta: {
2644
+ command: string;
2645
+ };
2646
+ } | {
2647
+ type: "button";
2648
+ sort_key: number | undefined;
2649
+ meta: {
2650
+ label?: string | undefined;
2651
+ action?: {
2652
+ type: "execute_command";
2653
+ meta: {
2654
+ command: string;
2655
+ } & {
2656
+ type?: "link" | "video" | "action" | "helpdoc" | undefined;
2657
+ };
2658
+ } | {
2659
+ type: "no_action";
2660
+ } | {
2661
+ type: "click";
2662
+ value: string;
2663
+ } | {
2664
+ type: "click" | "clickBySelector" | "clickByXpath";
2665
+ value: string[];
2666
+ } | ({
2667
+ type: "link";
2668
+ value: string;
2669
+ } & {
2670
+ operation?: "self" | "router" | "blank" | undefined;
2671
+ }) | {
2672
+ type: "open_chat";
2673
+ meta: {
2674
+ type: "" | "intercom" | "helpscout" | "freshdesk" | "freshchat" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "hubspot" | "drift" | "zendesk_handoff";
2675
+ };
2676
+ } | {
2677
+ type: "dismiss";
2678
+ } | {
2679
+ type: "snooze";
2680
+ } | {
2681
+ type: "questlist";
2682
+ value: number;
2683
+ } | {
2684
+ type: "step_back";
2685
+ } | {
2686
+ type: "nudge";
2687
+ value: number;
2688
+ } | {
2689
+ type: "go_to_step";
2690
+ value: number;
2691
+ } | ({
2692
+ type: "open_bar";
2693
+ } & {
2694
+ value?: string | undefined;
2695
+ categoryFilter?: number | undefined;
2696
+ }) | {
2697
+ type: "open_helphub";
2698
+ } | {
2699
+ type: "open_copilot";
2700
+ } | undefined;
2701
+ button_type?: "snooze" | "primary" | "secondary" | undefined;
2702
+ conditional_actions?: {
2703
+ operator: "eq" | "neq" | "gt" | "lt";
2704
+ operand: string | number;
2705
+ action: {
2706
+ type: "execute_command";
2707
+ meta: {
2708
+ command: string;
2709
+ } & {
2710
+ type?: "link" | "video" | "action" | "helpdoc" | undefined;
2711
+ };
2712
+ } | {
2713
+ type: "no_action";
2714
+ } | {
2715
+ type: "click";
2716
+ value: string;
2717
+ } | {
2718
+ type: "click" | "clickBySelector" | "clickByXpath";
2719
+ value: string[];
2720
+ } | ({
2721
+ type: "link";
2722
+ value: string;
2723
+ } & {
2724
+ operation?: "self" | "router" | "blank" | undefined;
2725
+ }) | {
2726
+ type: "open_chat";
2727
+ meta: {
2728
+ type: "" | "intercom" | "helpscout" | "freshdesk" | "freshchat" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "hubspot" | "drift" | "zendesk_handoff";
2729
+ };
2730
+ } | {
2731
+ type: "dismiss";
2732
+ } | {
2733
+ type: "snooze";
2734
+ } | {
2735
+ type: "questlist";
2736
+ value: number;
2737
+ } | {
2738
+ type: "step_back";
2739
+ } | {
2740
+ type: "nudge";
2741
+ value: number;
2742
+ } | {
2743
+ type: "go_to_step";
2744
+ value: number;
2745
+ } | ({
2746
+ type: "open_bar";
2747
+ } & {
2748
+ value?: string | undefined;
2749
+ categoryFilter?: number | undefined;
2750
+ }) | {
2751
+ type: "open_helphub";
2752
+ } | {
2753
+ type: "open_copilot";
2754
+ };
2755
+ }[] | undefined;
2756
+ } | null;
2757
+ } | {
2758
+ type: "survey_text";
2759
+ meta: {
2760
+ prompt: string;
2761
+ } & {
2762
+ validation?: {
2763
+ required?: {
2764
+ value: true;
2765
+ message: string;
2766
+ } | {
2767
+ value: false;
2768
+ message: null;
2769
+ } | undefined;
2770
+ } | undefined;
2771
+ };
2772
+ sort_key: number | undefined;
2773
+ } | {
2774
+ type: "survey_text_short";
2775
+ meta: {
2776
+ prompt: string;
2777
+ } & {
2778
+ validation?: {
2779
+ required?: {
2780
+ value: true;
2781
+ message: string;
2782
+ } | {
2783
+ value: false;
2784
+ message: null;
2785
+ } | undefined;
2786
+ } | undefined;
2787
+ };
2788
+ sort_key: number | undefined;
2789
+ } | {
2790
+ type: "survey_rating";
2791
+ sort_key: number | undefined;
2792
+ meta: ({
2793
+ type: "emojis";
2794
+ lower_label: string;
2795
+ upper_label: string;
2796
+ options: number;
2797
+ emojis: string[];
2798
+ } | {
2799
+ type: "numbers";
2800
+ lower_label: string;
2801
+ upper_label: string;
2802
+ options: number;
2803
+ } | {
2804
+ type: "stars";
2805
+ lower_label: string;
2806
+ upper_label: string;
2807
+ options: number;
2808
+ } | {
2809
+ type: "nps";
2810
+ lower_label: string;
2811
+ upper_label: string;
2812
+ options: number;
2813
+ }) & {
2814
+ validation?: {
2815
+ required?: {
2816
+ value: true;
2817
+ message: string;
2818
+ } | {
2819
+ value: false;
2820
+ message: null;
2821
+ } | undefined;
2822
+ } | undefined;
2823
+ };
2824
+ } | {
2825
+ type: "survey_list";
2826
+ sort_key: number | undefined;
2827
+ meta: {
2828
+ options: string[];
2829
+ list_type: "multiple" | "single";
2830
+ display_type: "grid" | "list" | "dropdown";
2831
+ } & {
2832
+ validation?: {
2833
+ required?: {
2834
+ value: true;
2835
+ message: string;
2836
+ } | {
2837
+ value: false;
2838
+ message: null;
2839
+ } | undefined;
2840
+ } | undefined;
2841
+ };
2842
+ })[];
2843
+ is_live: boolean;
2844
+ preview_url: string | null | undefined;
2845
+ } & {
2846
+ form_factor: {
2847
+ type: "modal";
2848
+ } | {
2849
+ type: "popover";
2850
+ position: "center" | "top-left" | "top-right" | "bottom-right" | "bottom-left";
2851
+ } | ({
2852
+ type: "pin";
2853
+ anchor: string;
2854
+ } & {
2855
+ is_open_by_default?: boolean | undefined;
2856
+ is_showing_mask?: boolean | undefined;
2857
+ advance_trigger?: string | undefined;
2858
+ offset?: {
2859
+ x: string;
2860
+ y: string;
2861
+ } | undefined;
2862
+ }) | {
2863
+ type: "tooltip";
2864
+ anchor: string;
2865
+ show_on: "click" | "hover";
2866
+ marker: ({
2867
+ type: "beacon";
2868
+ } | {
2869
+ type: "icon";
2870
+ icon: "helpCircle" | "helpSquare" | "infoCircle" | "bookClosed" | "lightBulb" | "lightning";
2871
+ } | {
2872
+ type: "image";
2873
+ source: string;
2874
+ }) & {
2875
+ positioning: {
2876
+ position: "left" | "right" | "inline_left" | "inline_right";
2877
+ offset: {
2878
+ x: string;
2879
+ y: string;
2880
+ };
2881
+ };
2882
+ };
2883
+ };
2884
+ } & {
2885
+ has_survey_response?: boolean | undefined;
2886
+ })[];
2887
+ is_live: boolean;
2888
+ } & {
2889
+ old_nudge_id?: number | null | undefined;
2890
+ archived?: boolean | undefined;
2891
+ audience?: {
2892
+ type: "all_users";
2893
+ } | {
2894
+ type: "rule_expression";
2895
+ expression: import("./helpers/rules").RuleExpression;
2896
+ } | {
2897
+ type: "named_rule_reference";
2898
+ rule_reference: {
2899
+ type: "named_rule";
2900
+ rule_id: string | number;
2901
+ } & {
2902
+ reason?: string | undefined;
2903
+ };
2904
+ } | null | undefined;
2905
+ } & {
2906
+ template_source: string;
2907
+ show_step_counter: boolean;
2908
+ dismissible: boolean;
2909
+ snoozable: boolean;
2910
+ share_page_url_or_path: string;
2911
+ copilot_suggest: boolean;
2912
+ show_in_spotlight_search: boolean;
2913
+ show_in_helphub_search: boolean;
2914
+ copilot_cta_label: string;
2915
+ copilot_description: string;
2916
+ is_scheduled: boolean;
2917
+ scheduled_start_time: string | null | undefined;
2918
+ scheduled_end_time: string | null | undefined;
2919
+ snooze_label: string;
2920
+ type: "announcement" | "product_tour" | "survey" | null;
2921
+ editor_tags: string[];
2922
+ preview_url: string | null | undefined;
57
2923
  };
58
2924
  }>;
59
2925
  }