commandbar 1.9.0 → 1.10.0

Sign up to get free protection for your applications and to get access to all the features.
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
@@ -0,0 +1,3579 @@
1
+ import * as t from 'io-ts';
2
+ import * as axiosInstance from './network';
3
+ import { IOrganizationType, ISearchExperiencesPayloadType } from './types';
4
+ export declare const FilterV: t.UnionC<[t.PartialC<{
5
+ labels: t.ArrayC<t.StringC>;
6
+ }>, t.NullC]>;
7
+ export declare const ExperienceTypeOptions: t.UnionC<[t.ArrayC<t.UnionC<[t.LiteralC<"page">, t.LiteralC<"action">, t.LiteralC<"helpdoc">, t.LiteralC<"video">, t.LiteralC<"nudge">, t.LiteralC<"checklist">]>>, t.UndefinedC]>;
8
+ export declare const CommandExperience: t.TypeC<{
9
+ type: t.UnionC<[t.LiteralC<"page">, t.LiteralC<"action">, t.LiteralC<"helpdoc">, t.LiteralC<"video">]>;
10
+ experience_id: t.NumberC;
11
+ experience: t.Type<{
12
+ id: number;
13
+ text: string;
14
+ template: ({
15
+ type: "admin";
16
+ value: string;
17
+ } & {} & {
18
+ commandType?: "object" | "help" | "independent" | undefined;
19
+ object?: string | undefined;
20
+ hoverTooltip?: boolean | undefined;
21
+ operation?: "self" | "router" | "blank" | "help_hub" | undefined;
22
+ metadata?: {
23
+ [key: string]: unknown;
24
+ } | undefined;
25
+ }) | ({
26
+ type: "callback";
27
+ value: string;
28
+ } & {} & {
29
+ commandType?: "object" | "help" | "independent" | undefined;
30
+ object?: string | undefined;
31
+ hoverTooltip?: boolean | undefined;
32
+ operation?: "self" | "router" | "blank" | "help_hub" | undefined;
33
+ metadata?: {
34
+ [key: string]: unknown;
35
+ } | undefined;
36
+ }) | ({
37
+ type: "link";
38
+ value: string;
39
+ } & {
40
+ operation?: "self" | "router" | "blank" | undefined;
41
+ } & {} & {
42
+ commandType?: "object" | "help" | "independent" | undefined;
43
+ object?: string | undefined;
44
+ hoverTooltip?: boolean | undefined;
45
+ operation?: "self" | "router" | "blank" | "help_hub" | undefined;
46
+ metadata?: {
47
+ [key: string]: unknown;
48
+ } | undefined;
49
+ }) | ({
50
+ type: "click" | "clickBySelector" | "clickByXpath";
51
+ value: string[];
52
+ } & {} & {
53
+ commandType?: "object" | "help" | "independent" | undefined;
54
+ object?: string | undefined;
55
+ hoverTooltip?: boolean | undefined;
56
+ operation?: "self" | "router" | "blank" | "help_hub" | undefined;
57
+ metadata?: {
58
+ [key: string]: unknown;
59
+ } | undefined;
60
+ }) | ({
61
+ type: "builtin";
62
+ value: string;
63
+ } & {} & {
64
+ commandType?: "object" | "help" | "independent" | undefined;
65
+ object?: string | undefined;
66
+ hoverTooltip?: boolean | undefined;
67
+ operation?: "self" | "router" | "blank" | "help_hub" | undefined;
68
+ metadata?: {
69
+ [key: string]: unknown;
70
+ } | undefined;
71
+ }) | ({
72
+ type: "webhook";
73
+ value: string;
74
+ } & {} & {
75
+ commandType?: "object" | "help" | "independent" | undefined;
76
+ object?: string | undefined;
77
+ hoverTooltip?: boolean | undefined;
78
+ operation?: "self" | "router" | "blank" | "help_hub" | undefined;
79
+ metadata?: {
80
+ [key: string]: unknown;
81
+ } | undefined;
82
+ }) | ({
83
+ type: "script";
84
+ value: string;
85
+ } & {} & {
86
+ commandType?: "object" | "help" | "independent" | undefined;
87
+ object?: string | undefined;
88
+ hoverTooltip?: boolean | undefined;
89
+ operation?: "self" | "router" | "blank" | "help_hub" | undefined;
90
+ metadata?: {
91
+ [key: string]: unknown;
92
+ } | undefined;
93
+ }) | ({
94
+ type: "request";
95
+ value: {
96
+ method: "head" | "options" | "get" | "post" | "put" | "delete" | "patch";
97
+ url: string;
98
+ } & {
99
+ headers?: {
100
+ [key: string]: unknown;
101
+ } | undefined;
102
+ body?: {
103
+ [key: string]: unknown;
104
+ } | undefined;
105
+ onSend?: string | undefined;
106
+ onSuccess?: string | undefined;
107
+ onError?: string | undefined;
108
+ };
109
+ } & {} & {
110
+ commandType?: "object" | "help" | "independent" | undefined;
111
+ object?: string | undefined;
112
+ hoverTooltip?: boolean | undefined;
113
+ operation?: "self" | "router" | "blank" | "help_hub" | undefined;
114
+ metadata?: {
115
+ [key: string]: unknown;
116
+ } | undefined;
117
+ }) | ({
118
+ type: "appcues";
119
+ value: string;
120
+ } & {} & {
121
+ commandType?: "object" | "help" | "independent" | undefined;
122
+ object?: string | undefined;
123
+ hoverTooltip?: boolean | undefined;
124
+ operation?: "self" | "router" | "blank" | "help_hub" | undefined;
125
+ metadata?: {
126
+ [key: string]: unknown;
127
+ } | undefined;
128
+ }) | ({
129
+ type: "pendo_guide";
130
+ value: string;
131
+ } & {} & {
132
+ commandType?: "object" | "help" | "independent" | undefined;
133
+ object?: string | undefined;
134
+ hoverTooltip?: boolean | undefined;
135
+ operation?: "self" | "router" | "blank" | "help_hub" | undefined;
136
+ metadata?: {
137
+ [key: string]: unknown;
138
+ } | undefined;
139
+ }) | ({
140
+ type: "video";
141
+ value: string;
142
+ } & {} & {
143
+ commandType?: "object" | "help" | "independent" | undefined;
144
+ object?: string | undefined;
145
+ hoverTooltip?: boolean | undefined;
146
+ operation?: "self" | "router" | "blank" | "help_hub" | undefined;
147
+ metadata?: {
148
+ [key: string]: unknown;
149
+ } | undefined;
150
+ }) | ({
151
+ type: "helpdoc";
152
+ value: string;
153
+ } & {
154
+ operation?: "self" | "router" | "blank" | "help_hub" | undefined;
155
+ doc_metadata?: {
156
+ content_type?: string | undefined;
157
+ date?: string | undefined;
158
+ } | undefined;
159
+ } & {
160
+ doc_type?: "answer" | "doc" | undefined;
161
+ } & {} & {
162
+ commandType?: "object" | "help" | "independent" | undefined;
163
+ object?: string | undefined;
164
+ hoverTooltip?: boolean | undefined;
165
+ operation?: "self" | "router" | "blank" | "help_hub" | undefined;
166
+ metadata?: {
167
+ [key: string]: unknown;
168
+ } | undefined;
169
+ }) | ({
170
+ type: "trigger";
171
+ value: {
172
+ type: "execute_command";
173
+ meta: {
174
+ command: string;
175
+ } & {
176
+ type?: "link" | "video" | "action" | "helpdoc" | undefined;
177
+ };
178
+ } | {
179
+ type: "click";
180
+ value: string;
181
+ } | {
182
+ type: "click" | "clickBySelector" | "clickByXpath";
183
+ value: string[];
184
+ } | ({
185
+ type: "link";
186
+ value: string;
187
+ } & {
188
+ operation?: "self" | "router" | "blank" | undefined;
189
+ }) | {
190
+ type: "open_chat";
191
+ meta: {
192
+ type: "" | "intercom" | "helpscout" | "freshdesk" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "hubspot" | "drift";
193
+ };
194
+ } | {
195
+ type: "dismiss";
196
+ } | {
197
+ type: "snooze";
198
+ } | {
199
+ type: "questlist";
200
+ value: number;
201
+ } | {
202
+ type: "step_back";
203
+ } | {
204
+ type: "nudge";
205
+ value: number;
206
+ } | {
207
+ type: "go_to_step";
208
+ value: number;
209
+ } | ({
210
+ type: "open_bar";
211
+ } & {
212
+ value?: string | undefined;
213
+ categoryFilter?: number | undefined;
214
+ }) | {
215
+ type: "open_helphub";
216
+ } | {
217
+ type: "open_copilot";
218
+ } | {
219
+ type: "no_action";
220
+ };
221
+ } & {} & {
222
+ commandType?: "object" | "help" | "independent" | undefined;
223
+ object?: string | undefined;
224
+ hoverTooltip?: boolean | undefined;
225
+ operation?: "self" | "router" | "blank" | "help_hub" | undefined;
226
+ metadata?: {
227
+ [key: string]: unknown;
228
+ } | undefined;
229
+ });
230
+ } & {
231
+ disabledReason?: string | undefined;
232
+ source?: string | undefined;
233
+ name?: string | undefined;
234
+ last_available?: string | null | undefined;
235
+ modified?: string | undefined;
236
+ isAsync?: boolean | undefined;
237
+ } & {
238
+ arguments: {
239
+ [x: string]: ({
240
+ type: "context";
241
+ value: string;
242
+ order_key: number;
243
+ } & {
244
+ label?: string | undefined;
245
+ chosen?: string | number | undefined;
246
+ selected?: any[] | undefined;
247
+ input_type?: string | undefined;
248
+ preselected_key?: string | undefined;
249
+ label_field?: string | undefined;
250
+ loaded?: any[] | undefined;
251
+ allow_create?: boolean | undefined;
252
+ allow_create_label?: string | undefined;
253
+ show_in_record_action_list?: boolean | undefined;
254
+ show_in_default_list?: boolean | undefined;
255
+ auto_choose?: boolean | undefined;
256
+ is_private?: boolean | undefined;
257
+ }) | ({
258
+ type: "set";
259
+ value: string[] | number[] | {
260
+ [key: string]: unknown;
261
+ }[];
262
+ order_key: number;
263
+ } & {
264
+ label?: string | undefined;
265
+ chosen?: string | number | undefined;
266
+ selected?: any[] | undefined;
267
+ input_type?: string | undefined;
268
+ preselected_key?: string | undefined;
269
+ label_field?: string | undefined;
270
+ loaded?: any[] | undefined;
271
+ allow_create?: boolean | undefined;
272
+ allow_create_label?: string | undefined;
273
+ auto_choose?: boolean | undefined;
274
+ is_private?: boolean | undefined;
275
+ }) | ({
276
+ type: "provided";
277
+ value: "time" | "text";
278
+ order_key: number;
279
+ } & {
280
+ label?: string | undefined;
281
+ chosen?: string | number | undefined;
282
+ selected?: any[] | undefined;
283
+ input_type?: string | undefined;
284
+ preselected_key?: string | undefined;
285
+ label_field?: string | undefined;
286
+ loaded?: any[] | undefined;
287
+ dateTimeArgumentTypeId?: number | undefined;
288
+ allow_create?: boolean | undefined;
289
+ allow_create_label?: string | undefined;
290
+ auto_choose?: boolean | undefined;
291
+ is_private?: boolean | undefined;
292
+ }) | ({
293
+ type: "html" | "video";
294
+ value: {
295
+ source: string;
296
+ } & {
297
+ title?: string | undefined;
298
+ description?: string | undefined;
299
+ url?: string | undefined;
300
+ };
301
+ order_key: number;
302
+ } & {
303
+ label?: string | undefined;
304
+ chosen?: string | number | undefined;
305
+ selected?: any[] | undefined;
306
+ input_type?: string | undefined;
307
+ preselected_key?: string | undefined;
308
+ label_field?: string | undefined;
309
+ loaded?: any[] | undefined;
310
+ allow_create?: boolean | undefined;
311
+ allow_create_label?: string | undefined;
312
+ is_private?: boolean | undefined;
313
+ auto_choose?: boolean | undefined;
314
+ });
315
+ };
316
+ tags: string[];
317
+ availability_rules: (({
318
+ type: "url" | "element" | "context" | "hubspot" | "device_type" | "sessions" | "survey_response" | "user_property" | "event_property" | "hostname" | "executions" | "shortcuts" | "last_seen" | "first_seen" | "opens" | "deadends" | "heap" | "ab_test" | "intent" | "help_doc_interaction" | "video_interaction";
319
+ operator: "includes" | "endsWith" | "startsWith" | "is" | "isTrue" | "isFalse" | "isTruthy" | "isFalsy" | "matchesRegex" | "isDefined" | "isNotDefined" | "classnameOnPage" | "idOnPage" | "selectorOnPage" | "classnameNotOnPage" | "idNotOnPage" | "selectorNotOnPage" | "doesNotInclude" | "isNot" | "isGreaterThan" | "isLessThan";
320
+ } & {
321
+ field?: string | undefined;
322
+ value?: string | undefined;
323
+ reason?: string | undefined;
324
+ rule_id?: string | number | undefined;
325
+ }) | ({
326
+ type: "nudge_interaction";
327
+ operator: "is" | "isNot";
328
+ value: "completed" | "dismissed" | "viewed";
329
+ nudge_id: number;
330
+ } & {
331
+ reason?: string | undefined;
332
+ }) | ({
333
+ type: "questlist_interaction";
334
+ operator: "is" | "isNot";
335
+ value: "completed" | "dismissed" | "viewed";
336
+ questlist_id: number;
337
+ } & {
338
+ reason?: string | undefined;
339
+ }) | ({
340
+ type: "browser" | "language" | "os";
341
+ operator: "includes" | "doesNotInclude";
342
+ values: string[];
343
+ } & {
344
+ reason?: string | undefined;
345
+ }))[];
346
+ recommend_rules: (({
347
+ type: "url" | "element" | "context" | "hubspot" | "device_type" | "sessions" | "survey_response" | "user_property" | "event_property" | "hostname" | "executions" | "shortcuts" | "last_seen" | "first_seen" | "opens" | "deadends" | "heap" | "ab_test" | "intent" | "help_doc_interaction" | "video_interaction";
348
+ operator: "includes" | "endsWith" | "startsWith" | "is" | "isTrue" | "isFalse" | "isTruthy" | "isFalsy" | "matchesRegex" | "isDefined" | "isNotDefined" | "classnameOnPage" | "idOnPage" | "selectorOnPage" | "classnameNotOnPage" | "idNotOnPage" | "selectorNotOnPage" | "doesNotInclude" | "isNot" | "isGreaterThan" | "isLessThan";
349
+ } & {
350
+ field?: string | undefined;
351
+ value?: string | undefined;
352
+ reason?: string | undefined;
353
+ rule_id?: string | number | undefined;
354
+ }) | ({
355
+ type: "nudge_interaction";
356
+ operator: "is" | "isNot";
357
+ value: "completed" | "dismissed" | "viewed";
358
+ nudge_id: number;
359
+ } & {
360
+ reason?: string | undefined;
361
+ }) | ({
362
+ type: "questlist_interaction";
363
+ operator: "is" | "isNot";
364
+ value: "completed" | "dismissed" | "viewed";
365
+ questlist_id: number;
366
+ } & {
367
+ reason?: string | undefined;
368
+ }) | ({
369
+ type: "browser" | "language" | "os";
370
+ operator: "includes" | "doesNotInclude";
371
+ values: string[];
372
+ } & {
373
+ reason?: string | undefined;
374
+ }) | ({
375
+ type: "always";
376
+ } & {
377
+ operator?: null | undefined;
378
+ field?: null | undefined;
379
+ value?: null | undefined;
380
+ reason?: null | undefined;
381
+ rule_id?: string | number | undefined;
382
+ }))[];
383
+ availability_expression: import("./helpers/rules").RuleExpression | null;
384
+ recommend_expression: import("./helpers/rules").RuleExpression | null;
385
+ always_recommend: boolean;
386
+ confirm: string;
387
+ shortcut: string[];
388
+ explanation: string;
389
+ heading: string;
390
+ is_live: boolean;
391
+ category: number | null;
392
+ sort_key: number | null;
393
+ icon: string | null;
394
+ icon_color: string | null;
395
+ image_color: string | null;
396
+ image: string | null;
397
+ celebrate: boolean | {
398
+ angle?: number | undefined;
399
+ spread?: number | undefined;
400
+ width?: string | undefined;
401
+ height?: string | undefined;
402
+ duration?: number | undefined;
403
+ dragFriction?: number | undefined;
404
+ stagger?: number | undefined;
405
+ startVelocity?: number | undefined;
406
+ elementCount?: number | undefined;
407
+ decay?: number | undefined;
408
+ colors?: string[] | undefined;
409
+ random?: any;
410
+ } | null;
411
+ recommend_sort_key: number | null;
412
+ shortcut_mac: string[];
413
+ shortcut_win: string[];
414
+ hotkey_mac: string;
415
+ hotkey_win: string;
416
+ detail: string | ({
417
+ type: "html" | "video" | "plaintext" | "markdown" | "component" | "react";
418
+ value: string;
419
+ } & {
420
+ position?: "inline" | "popover" | undefined;
421
+ }) | (string | ({
422
+ type: "html" | "video" | "plaintext" | "markdown" | "component" | "react";
423
+ value: string;
424
+ } & {
425
+ position?: "inline" | "popover" | undefined;
426
+ }))[] | null;
427
+ content: string | ({
428
+ type: "html" | "video" | "plaintext" | "markdown" | "component" | "react";
429
+ value: string;
430
+ } & {
431
+ position?: "inline" | "popover" | undefined;
432
+ }) | (string | ({
433
+ type: "html" | "video" | "plaintext" | "markdown" | "component" | "react";
434
+ value: string;
435
+ } & {
436
+ position?: "inline" | "popover" | undefined;
437
+ }))[] | null;
438
+ show_preview: boolean;
439
+ next_steps: (string | number | {
440
+ cta: string;
441
+ action: {
442
+ type: "execute_command";
443
+ meta: {
444
+ command: string;
445
+ } & {
446
+ type?: "link" | "video" | "action" | "helpdoc" | undefined;
447
+ };
448
+ } | {
449
+ type: "click";
450
+ value: string;
451
+ } | {
452
+ type: "click" | "clickBySelector" | "clickByXpath";
453
+ value: string[];
454
+ } | ({
455
+ type: "link";
456
+ value: string;
457
+ } & {
458
+ operation?: "self" | "router" | "blank" | undefined;
459
+ }) | {
460
+ type: "open_chat";
461
+ meta: {
462
+ type: "" | "intercom" | "helpscout" | "freshdesk" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "hubspot" | "drift";
463
+ };
464
+ } | {
465
+ type: "dismiss";
466
+ } | {
467
+ type: "snooze";
468
+ } | {
469
+ type: "questlist";
470
+ value: number;
471
+ } | {
472
+ type: "step_back";
473
+ } | {
474
+ type: "nudge";
475
+ value: number;
476
+ } | {
477
+ type: "go_to_step";
478
+ value: number;
479
+ } | ({
480
+ type: "open_bar";
481
+ } & {
482
+ value?: string | undefined;
483
+ categoryFilter?: number | undefined;
484
+ }) | {
485
+ type: "open_helphub";
486
+ } | {
487
+ type: "open_copilot";
488
+ } | {
489
+ type: "no_action";
490
+ };
491
+ })[];
492
+ extra: string | null;
493
+ thumbnail: {
494
+ src: string;
495
+ file_name: string;
496
+ size: string;
497
+ } | null;
498
+ copilot_suggest: boolean;
499
+ show_in_spotlight_search: boolean;
500
+ show_in_helphub_search: boolean;
501
+ copilot_cta_label: string;
502
+ copilot_description: string;
503
+ } & {
504
+ third_party_source?: string | null | undefined;
505
+ third_party_id?: string | null | undefined;
506
+ training_only?: boolean | undefined;
507
+ integration?: {
508
+ id: number;
509
+ helphub_view_article_button_hidden: boolean | undefined;
510
+ } | null | undefined;
511
+ }, {
512
+ id: number;
513
+ text: string;
514
+ template: ({
515
+ type: "admin";
516
+ value: string;
517
+ } & {} & {
518
+ commandType?: "object" | "help" | "independent" | undefined;
519
+ object?: string | undefined;
520
+ hoverTooltip?: boolean | undefined;
521
+ operation?: "self" | "router" | "blank" | "help_hub" | undefined;
522
+ metadata?: {
523
+ [key: string]: unknown;
524
+ } | undefined;
525
+ }) | ({
526
+ type: "callback";
527
+ value: string;
528
+ } & {} & {
529
+ commandType?: "object" | "help" | "independent" | undefined;
530
+ object?: string | undefined;
531
+ hoverTooltip?: boolean | undefined;
532
+ operation?: "self" | "router" | "blank" | "help_hub" | undefined;
533
+ metadata?: {
534
+ [key: string]: unknown;
535
+ } | undefined;
536
+ }) | ({
537
+ type: "link";
538
+ value: string;
539
+ } & {
540
+ operation?: "self" | "router" | "blank" | undefined;
541
+ } & {} & {
542
+ commandType?: "object" | "help" | "independent" | undefined;
543
+ object?: string | undefined;
544
+ hoverTooltip?: boolean | undefined;
545
+ operation?: "self" | "router" | "blank" | "help_hub" | undefined;
546
+ metadata?: {
547
+ [key: string]: unknown;
548
+ } | undefined;
549
+ }) | ({
550
+ type: "click" | "clickBySelector" | "clickByXpath";
551
+ value: string[];
552
+ } & {} & {
553
+ commandType?: "object" | "help" | "independent" | undefined;
554
+ object?: string | undefined;
555
+ hoverTooltip?: boolean | undefined;
556
+ operation?: "self" | "router" | "blank" | "help_hub" | undefined;
557
+ metadata?: {
558
+ [key: string]: unknown;
559
+ } | undefined;
560
+ }) | ({
561
+ type: "builtin";
562
+ value: string;
563
+ } & {} & {
564
+ commandType?: "object" | "help" | "independent" | undefined;
565
+ object?: string | undefined;
566
+ hoverTooltip?: boolean | undefined;
567
+ operation?: "self" | "router" | "blank" | "help_hub" | undefined;
568
+ metadata?: {
569
+ [key: string]: unknown;
570
+ } | undefined;
571
+ }) | ({
572
+ type: "webhook";
573
+ value: string;
574
+ } & {} & {
575
+ commandType?: "object" | "help" | "independent" | undefined;
576
+ object?: string | undefined;
577
+ hoverTooltip?: boolean | undefined;
578
+ operation?: "self" | "router" | "blank" | "help_hub" | undefined;
579
+ metadata?: {
580
+ [key: string]: unknown;
581
+ } | undefined;
582
+ }) | ({
583
+ type: "script";
584
+ value: string;
585
+ } & {} & {
586
+ commandType?: "object" | "help" | "independent" | undefined;
587
+ object?: string | undefined;
588
+ hoverTooltip?: boolean | undefined;
589
+ operation?: "self" | "router" | "blank" | "help_hub" | undefined;
590
+ metadata?: {
591
+ [key: string]: unknown;
592
+ } | undefined;
593
+ }) | ({
594
+ type: "request";
595
+ value: {
596
+ method: "head" | "options" | "get" | "post" | "put" | "delete" | "patch";
597
+ url: string;
598
+ } & {
599
+ headers?: {
600
+ [key: string]: unknown;
601
+ } | undefined;
602
+ body?: {
603
+ [key: string]: unknown;
604
+ } | undefined;
605
+ onSend?: string | undefined;
606
+ onSuccess?: string | undefined;
607
+ onError?: string | undefined;
608
+ };
609
+ } & {} & {
610
+ commandType?: "object" | "help" | "independent" | undefined;
611
+ object?: string | undefined;
612
+ hoverTooltip?: boolean | undefined;
613
+ operation?: "self" | "router" | "blank" | "help_hub" | undefined;
614
+ metadata?: {
615
+ [key: string]: unknown;
616
+ } | undefined;
617
+ }) | ({
618
+ type: "appcues";
619
+ value: string;
620
+ } & {} & {
621
+ commandType?: "object" | "help" | "independent" | undefined;
622
+ object?: string | undefined;
623
+ hoverTooltip?: boolean | undefined;
624
+ operation?: "self" | "router" | "blank" | "help_hub" | undefined;
625
+ metadata?: {
626
+ [key: string]: unknown;
627
+ } | undefined;
628
+ }) | ({
629
+ type: "pendo_guide";
630
+ value: string;
631
+ } & {} & {
632
+ commandType?: "object" | "help" | "independent" | undefined;
633
+ object?: string | undefined;
634
+ hoverTooltip?: boolean | undefined;
635
+ operation?: "self" | "router" | "blank" | "help_hub" | undefined;
636
+ metadata?: {
637
+ [key: string]: unknown;
638
+ } | undefined;
639
+ }) | ({
640
+ type: "video";
641
+ value: string;
642
+ } & {} & {
643
+ commandType?: "object" | "help" | "independent" | undefined;
644
+ object?: string | undefined;
645
+ hoverTooltip?: boolean | undefined;
646
+ operation?: "self" | "router" | "blank" | "help_hub" | undefined;
647
+ metadata?: {
648
+ [key: string]: unknown;
649
+ } | undefined;
650
+ }) | ({
651
+ type: "helpdoc";
652
+ value: string;
653
+ } & {
654
+ operation?: "self" | "router" | "blank" | "help_hub" | undefined;
655
+ doc_metadata?: {
656
+ content_type?: string | undefined;
657
+ date?: string | undefined;
658
+ } | undefined;
659
+ } & {
660
+ doc_type?: "answer" | "doc" | undefined;
661
+ } & {} & {
662
+ commandType?: "object" | "help" | "independent" | undefined;
663
+ object?: string | undefined;
664
+ hoverTooltip?: boolean | undefined;
665
+ operation?: "self" | "router" | "blank" | "help_hub" | undefined;
666
+ metadata?: {
667
+ [key: string]: unknown;
668
+ } | undefined;
669
+ }) | ({
670
+ type: "trigger";
671
+ value: {
672
+ type: "execute_command";
673
+ meta: {
674
+ command: string;
675
+ } & {
676
+ type?: "link" | "video" | "action" | "helpdoc" | undefined;
677
+ };
678
+ } | {
679
+ type: "click";
680
+ value: string;
681
+ } | {
682
+ type: "click" | "clickBySelector" | "clickByXpath";
683
+ value: string[];
684
+ } | ({
685
+ type: "link";
686
+ value: string;
687
+ } & {
688
+ operation?: "self" | "router" | "blank" | undefined;
689
+ }) | {
690
+ type: "open_chat";
691
+ meta: {
692
+ type: "" | "intercom" | "helpscout" | "freshdesk" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "hubspot" | "drift";
693
+ };
694
+ } | {
695
+ type: "dismiss";
696
+ } | {
697
+ type: "snooze";
698
+ } | {
699
+ type: "questlist";
700
+ value: number;
701
+ } | {
702
+ type: "step_back";
703
+ } | {
704
+ type: "nudge";
705
+ value: number;
706
+ } | {
707
+ type: "go_to_step";
708
+ value: number;
709
+ } | ({
710
+ type: "open_bar";
711
+ } & {
712
+ value?: string | undefined;
713
+ categoryFilter?: number | undefined;
714
+ }) | {
715
+ type: "open_helphub";
716
+ } | {
717
+ type: "open_copilot";
718
+ } | {
719
+ type: "no_action";
720
+ };
721
+ } & {} & {
722
+ commandType?: "object" | "help" | "independent" | undefined;
723
+ object?: string | undefined;
724
+ hoverTooltip?: boolean | undefined;
725
+ operation?: "self" | "router" | "blank" | "help_hub" | undefined;
726
+ metadata?: {
727
+ [key: string]: unknown;
728
+ } | undefined;
729
+ });
730
+ } & {
731
+ disabledReason?: string | undefined;
732
+ source?: string | undefined;
733
+ name?: string | undefined;
734
+ last_available?: string | null | undefined;
735
+ modified?: string | undefined;
736
+ isAsync?: boolean | undefined;
737
+ } & {
738
+ arguments: {
739
+ [x: string]: ({
740
+ type: "context";
741
+ value: string;
742
+ order_key: number;
743
+ } & {
744
+ label?: string | undefined;
745
+ chosen?: string | number | undefined;
746
+ selected?: any[] | undefined;
747
+ input_type?: string | undefined;
748
+ preselected_key?: string | undefined;
749
+ label_field?: string | undefined;
750
+ loaded?: any[] | undefined;
751
+ allow_create?: boolean | undefined;
752
+ allow_create_label?: string | undefined;
753
+ show_in_record_action_list?: boolean | undefined;
754
+ show_in_default_list?: boolean | undefined;
755
+ auto_choose?: boolean | undefined;
756
+ is_private?: boolean | undefined;
757
+ }) | ({
758
+ type: "set";
759
+ value: string[] | number[] | {
760
+ [key: string]: unknown;
761
+ }[];
762
+ order_key: number;
763
+ } & {
764
+ label?: string | undefined;
765
+ chosen?: string | number | undefined;
766
+ selected?: any[] | undefined;
767
+ input_type?: string | undefined;
768
+ preselected_key?: string | undefined;
769
+ label_field?: string | undefined;
770
+ loaded?: any[] | undefined;
771
+ allow_create?: boolean | undefined;
772
+ allow_create_label?: string | undefined;
773
+ auto_choose?: boolean | undefined;
774
+ is_private?: boolean | undefined;
775
+ }) | ({
776
+ type: "provided";
777
+ value: "time" | "text";
778
+ order_key: number;
779
+ } & {
780
+ label?: string | undefined;
781
+ chosen?: string | number | undefined;
782
+ selected?: any[] | undefined;
783
+ input_type?: string | undefined;
784
+ preselected_key?: string | undefined;
785
+ label_field?: string | undefined;
786
+ loaded?: any[] | undefined;
787
+ dateTimeArgumentTypeId?: number | undefined;
788
+ allow_create?: boolean | undefined;
789
+ allow_create_label?: string | undefined;
790
+ auto_choose?: boolean | undefined;
791
+ is_private?: boolean | undefined;
792
+ }) | ({
793
+ type: "html" | "video";
794
+ value: {
795
+ source: string;
796
+ } & {
797
+ title?: string | undefined;
798
+ description?: string | undefined;
799
+ url?: string | undefined;
800
+ };
801
+ order_key: number;
802
+ } & {
803
+ label?: string | undefined;
804
+ chosen?: string | number | undefined;
805
+ selected?: any[] | undefined;
806
+ input_type?: string | undefined;
807
+ preselected_key?: string | undefined;
808
+ label_field?: string | undefined;
809
+ loaded?: any[] | undefined;
810
+ allow_create?: boolean | undefined;
811
+ allow_create_label?: string | undefined;
812
+ is_private?: boolean | undefined;
813
+ auto_choose?: boolean | undefined;
814
+ });
815
+ };
816
+ tags: string[];
817
+ availability_rules: (({
818
+ type: "url" | "element" | "context" | "hubspot" | "device_type" | "sessions" | "survey_response" | "user_property" | "event_property" | "hostname" | "executions" | "shortcuts" | "last_seen" | "first_seen" | "opens" | "deadends" | "heap" | "ab_test" | "intent" | "help_doc_interaction" | "video_interaction";
819
+ operator: "includes" | "endsWith" | "startsWith" | "is" | "isTrue" | "isFalse" | "isTruthy" | "isFalsy" | "matchesRegex" | "isDefined" | "isNotDefined" | "classnameOnPage" | "idOnPage" | "selectorOnPage" | "classnameNotOnPage" | "idNotOnPage" | "selectorNotOnPage" | "doesNotInclude" | "isNot" | "isGreaterThan" | "isLessThan";
820
+ } & {
821
+ field?: string | undefined;
822
+ value?: string | undefined;
823
+ reason?: string | undefined;
824
+ rule_id?: string | number | undefined;
825
+ }) | ({
826
+ type: "nudge_interaction";
827
+ operator: "is" | "isNot";
828
+ value: "completed" | "dismissed" | "viewed";
829
+ nudge_id: number;
830
+ } & {
831
+ reason?: string | undefined;
832
+ }) | ({
833
+ type: "questlist_interaction";
834
+ operator: "is" | "isNot";
835
+ value: "completed" | "dismissed" | "viewed";
836
+ questlist_id: number;
837
+ } & {
838
+ reason?: string | undefined;
839
+ }) | ({
840
+ type: "browser" | "language" | "os";
841
+ operator: "includes" | "doesNotInclude";
842
+ values: string[];
843
+ } & {
844
+ reason?: string | undefined;
845
+ }))[];
846
+ recommend_rules: (({
847
+ type: "url" | "element" | "context" | "hubspot" | "device_type" | "sessions" | "survey_response" | "user_property" | "event_property" | "hostname" | "executions" | "shortcuts" | "last_seen" | "first_seen" | "opens" | "deadends" | "heap" | "ab_test" | "intent" | "help_doc_interaction" | "video_interaction";
848
+ operator: "includes" | "endsWith" | "startsWith" | "is" | "isTrue" | "isFalse" | "isTruthy" | "isFalsy" | "matchesRegex" | "isDefined" | "isNotDefined" | "classnameOnPage" | "idOnPage" | "selectorOnPage" | "classnameNotOnPage" | "idNotOnPage" | "selectorNotOnPage" | "doesNotInclude" | "isNot" | "isGreaterThan" | "isLessThan";
849
+ } & {
850
+ field?: string | undefined;
851
+ value?: string | undefined;
852
+ reason?: string | undefined;
853
+ rule_id?: string | number | undefined;
854
+ }) | ({
855
+ type: "nudge_interaction";
856
+ operator: "is" | "isNot";
857
+ value: "completed" | "dismissed" | "viewed";
858
+ nudge_id: number;
859
+ } & {
860
+ reason?: string | undefined;
861
+ }) | ({
862
+ type: "questlist_interaction";
863
+ operator: "is" | "isNot";
864
+ value: "completed" | "dismissed" | "viewed";
865
+ questlist_id: number;
866
+ } & {
867
+ reason?: string | undefined;
868
+ }) | ({
869
+ type: "browser" | "language" | "os";
870
+ operator: "includes" | "doesNotInclude";
871
+ values: string[];
872
+ } & {
873
+ reason?: string | undefined;
874
+ }) | ({
875
+ type: "always";
876
+ } & {
877
+ operator?: null | undefined;
878
+ field?: null | undefined;
879
+ value?: null | undefined;
880
+ reason?: null | undefined;
881
+ rule_id?: string | number | undefined;
882
+ }))[];
883
+ availability_expression: import("./helpers/rules").RuleExpression | null;
884
+ recommend_expression: import("./helpers/rules").RuleExpression | null;
885
+ always_recommend: boolean;
886
+ confirm: string;
887
+ shortcut: string[];
888
+ explanation: string;
889
+ heading: string;
890
+ is_live: boolean;
891
+ category: number | null;
892
+ sort_key: number | null;
893
+ icon: string | null;
894
+ icon_color: string | null;
895
+ image_color: string | null;
896
+ image: string | null;
897
+ celebrate: boolean | {
898
+ angle?: number | undefined;
899
+ spread?: number | undefined;
900
+ width?: string | undefined;
901
+ height?: string | undefined;
902
+ duration?: number | undefined;
903
+ dragFriction?: number | undefined;
904
+ stagger?: number | undefined;
905
+ startVelocity?: number | undefined;
906
+ elementCount?: number | undefined;
907
+ decay?: number | undefined;
908
+ colors?: string[] | undefined;
909
+ random?: any;
910
+ } | null;
911
+ recommend_sort_key: number | null;
912
+ shortcut_mac: string[];
913
+ shortcut_win: string[];
914
+ hotkey_mac: string;
915
+ hotkey_win: string;
916
+ detail: string | ({
917
+ type: "html" | "video" | "plaintext" | "markdown" | "component" | "react";
918
+ value: string;
919
+ } & {
920
+ position?: "inline" | "popover" | undefined;
921
+ }) | (string | ({
922
+ type: "html" | "video" | "plaintext" | "markdown" | "component" | "react";
923
+ value: string;
924
+ } & {
925
+ position?: "inline" | "popover" | undefined;
926
+ }))[] | null;
927
+ content: string | ({
928
+ type: "html" | "video" | "plaintext" | "markdown" | "component" | "react";
929
+ value: string;
930
+ } & {
931
+ position?: "inline" | "popover" | undefined;
932
+ }) | (string | ({
933
+ type: "html" | "video" | "plaintext" | "markdown" | "component" | "react";
934
+ value: string;
935
+ } & {
936
+ position?: "inline" | "popover" | undefined;
937
+ }))[] | null;
938
+ show_preview: boolean;
939
+ next_steps: (string | number | {
940
+ cta: string;
941
+ action: {
942
+ type: "execute_command";
943
+ meta: {
944
+ command: string;
945
+ } & {
946
+ type?: "link" | "video" | "action" | "helpdoc" | undefined;
947
+ };
948
+ } | {
949
+ type: "click";
950
+ value: string;
951
+ } | {
952
+ type: "click" | "clickBySelector" | "clickByXpath";
953
+ value: string[];
954
+ } | ({
955
+ type: "link";
956
+ value: string;
957
+ } & {
958
+ operation?: "self" | "router" | "blank" | undefined;
959
+ }) | {
960
+ type: "open_chat";
961
+ meta: {
962
+ type: "" | "intercom" | "helpscout" | "freshdesk" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "hubspot" | "drift";
963
+ };
964
+ } | {
965
+ type: "dismiss";
966
+ } | {
967
+ type: "snooze";
968
+ } | {
969
+ type: "questlist";
970
+ value: number;
971
+ } | {
972
+ type: "step_back";
973
+ } | {
974
+ type: "nudge";
975
+ value: number;
976
+ } | {
977
+ type: "go_to_step";
978
+ value: number;
979
+ } | ({
980
+ type: "open_bar";
981
+ } & {
982
+ value?: string | undefined;
983
+ categoryFilter?: number | undefined;
984
+ }) | {
985
+ type: "open_helphub";
986
+ } | {
987
+ type: "open_copilot";
988
+ } | {
989
+ type: "no_action";
990
+ };
991
+ })[];
992
+ extra: string | null;
993
+ thumbnail: {
994
+ src: string;
995
+ file_name: string;
996
+ size: string;
997
+ } | null;
998
+ copilot_suggest: boolean;
999
+ show_in_spotlight_search: boolean;
1000
+ show_in_helphub_search: boolean;
1001
+ copilot_cta_label: string;
1002
+ copilot_description: string;
1003
+ } & {
1004
+ third_party_source?: string | null | undefined;
1005
+ third_party_id?: string | null | undefined;
1006
+ training_only?: boolean | undefined;
1007
+ integration?: {
1008
+ id: number;
1009
+ helphub_view_article_button_hidden: boolean | undefined;
1010
+ } | null | undefined;
1011
+ }, any>;
1012
+ excerpt: t.StringC;
1013
+ score: t.ArrayC<t.NumberC>;
1014
+ }>;
1015
+ export declare const OtherExperience: t.TypeC<{
1016
+ type: t.UnionC<[t.LiteralC<"nudge">, t.LiteralC<"checklist">]>;
1017
+ experience_id: t.NumberC;
1018
+ experience: t.UndefinedC;
1019
+ excerpt: t.StringC;
1020
+ score: t.ArrayC<t.NumberC>;
1021
+ }>;
1022
+ export declare const ExperienceHitV: t.UnionC<[t.TypeC<{
1023
+ type: t.UnionC<[t.LiteralC<"page">, t.LiteralC<"action">, t.LiteralC<"helpdoc">, t.LiteralC<"video">]>;
1024
+ experience_id: t.NumberC;
1025
+ experience: t.Type<{
1026
+ id: number;
1027
+ text: string;
1028
+ template: ({
1029
+ type: "admin";
1030
+ value: string;
1031
+ } & {} & {
1032
+ commandType?: "object" | "help" | "independent" | undefined;
1033
+ object?: string | undefined;
1034
+ hoverTooltip?: boolean | undefined;
1035
+ operation?: "self" | "router" | "blank" | "help_hub" | undefined;
1036
+ metadata?: {
1037
+ [key: string]: unknown;
1038
+ } | undefined;
1039
+ }) | ({
1040
+ type: "callback";
1041
+ value: string;
1042
+ } & {} & {
1043
+ commandType?: "object" | "help" | "independent" | undefined;
1044
+ object?: string | undefined;
1045
+ hoverTooltip?: boolean | undefined;
1046
+ operation?: "self" | "router" | "blank" | "help_hub" | undefined;
1047
+ metadata?: {
1048
+ [key: string]: unknown;
1049
+ } | undefined;
1050
+ }) | ({
1051
+ type: "link";
1052
+ value: string;
1053
+ } & {
1054
+ operation?: "self" | "router" | "blank" | undefined;
1055
+ } & {} & {
1056
+ commandType?: "object" | "help" | "independent" | undefined;
1057
+ object?: string | undefined;
1058
+ hoverTooltip?: boolean | undefined;
1059
+ operation?: "self" | "router" | "blank" | "help_hub" | undefined;
1060
+ metadata?: {
1061
+ [key: string]: unknown;
1062
+ } | undefined;
1063
+ }) | ({
1064
+ type: "click" | "clickBySelector" | "clickByXpath";
1065
+ value: string[];
1066
+ } & {} & {
1067
+ commandType?: "object" | "help" | "independent" | undefined;
1068
+ object?: string | undefined;
1069
+ hoverTooltip?: boolean | undefined;
1070
+ operation?: "self" | "router" | "blank" | "help_hub" | undefined;
1071
+ metadata?: {
1072
+ [key: string]: unknown;
1073
+ } | undefined;
1074
+ }) | ({
1075
+ type: "builtin";
1076
+ value: string;
1077
+ } & {} & {
1078
+ commandType?: "object" | "help" | "independent" | undefined;
1079
+ object?: string | undefined;
1080
+ hoverTooltip?: boolean | undefined;
1081
+ operation?: "self" | "router" | "blank" | "help_hub" | undefined;
1082
+ metadata?: {
1083
+ [key: string]: unknown;
1084
+ } | undefined;
1085
+ }) | ({
1086
+ type: "webhook";
1087
+ value: string;
1088
+ } & {} & {
1089
+ commandType?: "object" | "help" | "independent" | undefined;
1090
+ object?: string | undefined;
1091
+ hoverTooltip?: boolean | undefined;
1092
+ operation?: "self" | "router" | "blank" | "help_hub" | undefined;
1093
+ metadata?: {
1094
+ [key: string]: unknown;
1095
+ } | undefined;
1096
+ }) | ({
1097
+ type: "script";
1098
+ value: string;
1099
+ } & {} & {
1100
+ commandType?: "object" | "help" | "independent" | undefined;
1101
+ object?: string | undefined;
1102
+ hoverTooltip?: boolean | undefined;
1103
+ operation?: "self" | "router" | "blank" | "help_hub" | undefined;
1104
+ metadata?: {
1105
+ [key: string]: unknown;
1106
+ } | undefined;
1107
+ }) | ({
1108
+ type: "request";
1109
+ value: {
1110
+ method: "head" | "options" | "get" | "post" | "put" | "delete" | "patch";
1111
+ url: string;
1112
+ } & {
1113
+ headers?: {
1114
+ [key: string]: unknown;
1115
+ } | undefined;
1116
+ body?: {
1117
+ [key: string]: unknown;
1118
+ } | undefined;
1119
+ onSend?: string | undefined;
1120
+ onSuccess?: string | undefined;
1121
+ onError?: string | undefined;
1122
+ };
1123
+ } & {} & {
1124
+ commandType?: "object" | "help" | "independent" | undefined;
1125
+ object?: string | undefined;
1126
+ hoverTooltip?: boolean | undefined;
1127
+ operation?: "self" | "router" | "blank" | "help_hub" | undefined;
1128
+ metadata?: {
1129
+ [key: string]: unknown;
1130
+ } | undefined;
1131
+ }) | ({
1132
+ type: "appcues";
1133
+ value: string;
1134
+ } & {} & {
1135
+ commandType?: "object" | "help" | "independent" | undefined;
1136
+ object?: string | undefined;
1137
+ hoverTooltip?: boolean | undefined;
1138
+ operation?: "self" | "router" | "blank" | "help_hub" | undefined;
1139
+ metadata?: {
1140
+ [key: string]: unknown;
1141
+ } | undefined;
1142
+ }) | ({
1143
+ type: "pendo_guide";
1144
+ value: string;
1145
+ } & {} & {
1146
+ commandType?: "object" | "help" | "independent" | undefined;
1147
+ object?: string | undefined;
1148
+ hoverTooltip?: boolean | undefined;
1149
+ operation?: "self" | "router" | "blank" | "help_hub" | undefined;
1150
+ metadata?: {
1151
+ [key: string]: unknown;
1152
+ } | undefined;
1153
+ }) | ({
1154
+ type: "video";
1155
+ value: string;
1156
+ } & {} & {
1157
+ commandType?: "object" | "help" | "independent" | undefined;
1158
+ object?: string | undefined;
1159
+ hoverTooltip?: boolean | undefined;
1160
+ operation?: "self" | "router" | "blank" | "help_hub" | undefined;
1161
+ metadata?: {
1162
+ [key: string]: unknown;
1163
+ } | undefined;
1164
+ }) | ({
1165
+ type: "helpdoc";
1166
+ value: string;
1167
+ } & {
1168
+ operation?: "self" | "router" | "blank" | "help_hub" | undefined;
1169
+ doc_metadata?: {
1170
+ content_type?: string | undefined;
1171
+ date?: string | undefined;
1172
+ } | undefined;
1173
+ } & {
1174
+ doc_type?: "answer" | "doc" | undefined;
1175
+ } & {} & {
1176
+ commandType?: "object" | "help" | "independent" | undefined;
1177
+ object?: string | undefined;
1178
+ hoverTooltip?: boolean | undefined;
1179
+ operation?: "self" | "router" | "blank" | "help_hub" | undefined;
1180
+ metadata?: {
1181
+ [key: string]: unknown;
1182
+ } | undefined;
1183
+ }) | ({
1184
+ type: "trigger";
1185
+ value: {
1186
+ type: "execute_command";
1187
+ meta: {
1188
+ command: string;
1189
+ } & {
1190
+ type?: "link" | "video" | "action" | "helpdoc" | undefined;
1191
+ };
1192
+ } | {
1193
+ type: "click";
1194
+ value: string;
1195
+ } | {
1196
+ type: "click" | "clickBySelector" | "clickByXpath";
1197
+ value: string[];
1198
+ } | ({
1199
+ type: "link";
1200
+ value: string;
1201
+ } & {
1202
+ operation?: "self" | "router" | "blank" | undefined;
1203
+ }) | {
1204
+ type: "open_chat";
1205
+ meta: {
1206
+ type: "" | "intercom" | "helpscout" | "freshdesk" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "hubspot" | "drift";
1207
+ };
1208
+ } | {
1209
+ type: "dismiss";
1210
+ } | {
1211
+ type: "snooze";
1212
+ } | {
1213
+ type: "questlist";
1214
+ value: number;
1215
+ } | {
1216
+ type: "step_back";
1217
+ } | {
1218
+ type: "nudge";
1219
+ value: number;
1220
+ } | {
1221
+ type: "go_to_step";
1222
+ value: number;
1223
+ } | ({
1224
+ type: "open_bar";
1225
+ } & {
1226
+ value?: string | undefined;
1227
+ categoryFilter?: number | undefined;
1228
+ }) | {
1229
+ type: "open_helphub";
1230
+ } | {
1231
+ type: "open_copilot";
1232
+ } | {
1233
+ type: "no_action";
1234
+ };
1235
+ } & {} & {
1236
+ commandType?: "object" | "help" | "independent" | undefined;
1237
+ object?: string | undefined;
1238
+ hoverTooltip?: boolean | undefined;
1239
+ operation?: "self" | "router" | "blank" | "help_hub" | undefined;
1240
+ metadata?: {
1241
+ [key: string]: unknown;
1242
+ } | undefined;
1243
+ });
1244
+ } & {
1245
+ disabledReason?: string | undefined;
1246
+ source?: string | undefined;
1247
+ name?: string | undefined;
1248
+ last_available?: string | null | undefined;
1249
+ modified?: string | undefined;
1250
+ isAsync?: boolean | undefined;
1251
+ } & {
1252
+ arguments: {
1253
+ [x: string]: ({
1254
+ type: "context";
1255
+ value: string;
1256
+ order_key: number;
1257
+ } & {
1258
+ label?: string | undefined;
1259
+ chosen?: string | number | undefined;
1260
+ selected?: any[] | undefined;
1261
+ input_type?: string | undefined;
1262
+ preselected_key?: string | undefined;
1263
+ label_field?: string | undefined;
1264
+ loaded?: any[] | undefined;
1265
+ allow_create?: boolean | undefined;
1266
+ allow_create_label?: string | undefined;
1267
+ show_in_record_action_list?: boolean | undefined;
1268
+ show_in_default_list?: boolean | undefined;
1269
+ auto_choose?: boolean | undefined;
1270
+ is_private?: boolean | undefined;
1271
+ }) | ({
1272
+ type: "set";
1273
+ value: string[] | number[] | {
1274
+ [key: string]: unknown;
1275
+ }[];
1276
+ order_key: number;
1277
+ } & {
1278
+ label?: string | undefined;
1279
+ chosen?: string | number | undefined;
1280
+ selected?: any[] | undefined;
1281
+ input_type?: string | undefined;
1282
+ preselected_key?: string | undefined;
1283
+ label_field?: string | undefined;
1284
+ loaded?: any[] | undefined;
1285
+ allow_create?: boolean | undefined;
1286
+ allow_create_label?: string | undefined;
1287
+ auto_choose?: boolean | undefined;
1288
+ is_private?: boolean | undefined;
1289
+ }) | ({
1290
+ type: "provided";
1291
+ value: "time" | "text";
1292
+ order_key: number;
1293
+ } & {
1294
+ label?: string | undefined;
1295
+ chosen?: string | number | undefined;
1296
+ selected?: any[] | undefined;
1297
+ input_type?: string | undefined;
1298
+ preselected_key?: string | undefined;
1299
+ label_field?: string | undefined;
1300
+ loaded?: any[] | undefined;
1301
+ dateTimeArgumentTypeId?: number | undefined;
1302
+ allow_create?: boolean | undefined;
1303
+ allow_create_label?: string | undefined;
1304
+ auto_choose?: boolean | undefined;
1305
+ is_private?: boolean | undefined;
1306
+ }) | ({
1307
+ type: "html" | "video";
1308
+ value: {
1309
+ source: string;
1310
+ } & {
1311
+ title?: string | undefined;
1312
+ description?: string | undefined;
1313
+ url?: string | undefined;
1314
+ };
1315
+ order_key: number;
1316
+ } & {
1317
+ label?: string | undefined;
1318
+ chosen?: string | number | undefined;
1319
+ selected?: any[] | undefined;
1320
+ input_type?: string | undefined;
1321
+ preselected_key?: string | undefined;
1322
+ label_field?: string | undefined;
1323
+ loaded?: any[] | undefined;
1324
+ allow_create?: boolean | undefined;
1325
+ allow_create_label?: string | undefined;
1326
+ is_private?: boolean | undefined;
1327
+ auto_choose?: boolean | undefined;
1328
+ });
1329
+ };
1330
+ tags: string[];
1331
+ availability_rules: (({
1332
+ type: "url" | "element" | "context" | "hubspot" | "device_type" | "sessions" | "survey_response" | "user_property" | "event_property" | "hostname" | "executions" | "shortcuts" | "last_seen" | "first_seen" | "opens" | "deadends" | "heap" | "ab_test" | "intent" | "help_doc_interaction" | "video_interaction";
1333
+ operator: "includes" | "endsWith" | "startsWith" | "is" | "isTrue" | "isFalse" | "isTruthy" | "isFalsy" | "matchesRegex" | "isDefined" | "isNotDefined" | "classnameOnPage" | "idOnPage" | "selectorOnPage" | "classnameNotOnPage" | "idNotOnPage" | "selectorNotOnPage" | "doesNotInclude" | "isNot" | "isGreaterThan" | "isLessThan";
1334
+ } & {
1335
+ field?: string | undefined;
1336
+ value?: string | undefined;
1337
+ reason?: string | undefined;
1338
+ rule_id?: string | number | undefined;
1339
+ }) | ({
1340
+ type: "nudge_interaction";
1341
+ operator: "is" | "isNot";
1342
+ value: "completed" | "dismissed" | "viewed";
1343
+ nudge_id: number;
1344
+ } & {
1345
+ reason?: string | undefined;
1346
+ }) | ({
1347
+ type: "questlist_interaction";
1348
+ operator: "is" | "isNot";
1349
+ value: "completed" | "dismissed" | "viewed";
1350
+ questlist_id: number;
1351
+ } & {
1352
+ reason?: string | undefined;
1353
+ }) | ({
1354
+ type: "browser" | "language" | "os";
1355
+ operator: "includes" | "doesNotInclude";
1356
+ values: string[];
1357
+ } & {
1358
+ reason?: string | undefined;
1359
+ }))[];
1360
+ recommend_rules: (({
1361
+ type: "url" | "element" | "context" | "hubspot" | "device_type" | "sessions" | "survey_response" | "user_property" | "event_property" | "hostname" | "executions" | "shortcuts" | "last_seen" | "first_seen" | "opens" | "deadends" | "heap" | "ab_test" | "intent" | "help_doc_interaction" | "video_interaction";
1362
+ operator: "includes" | "endsWith" | "startsWith" | "is" | "isTrue" | "isFalse" | "isTruthy" | "isFalsy" | "matchesRegex" | "isDefined" | "isNotDefined" | "classnameOnPage" | "idOnPage" | "selectorOnPage" | "classnameNotOnPage" | "idNotOnPage" | "selectorNotOnPage" | "doesNotInclude" | "isNot" | "isGreaterThan" | "isLessThan";
1363
+ } & {
1364
+ field?: string | undefined;
1365
+ value?: string | undefined;
1366
+ reason?: string | undefined;
1367
+ rule_id?: string | number | undefined;
1368
+ }) | ({
1369
+ type: "nudge_interaction";
1370
+ operator: "is" | "isNot";
1371
+ value: "completed" | "dismissed" | "viewed";
1372
+ nudge_id: number;
1373
+ } & {
1374
+ reason?: string | undefined;
1375
+ }) | ({
1376
+ type: "questlist_interaction";
1377
+ operator: "is" | "isNot";
1378
+ value: "completed" | "dismissed" | "viewed";
1379
+ questlist_id: number;
1380
+ } & {
1381
+ reason?: string | undefined;
1382
+ }) | ({
1383
+ type: "browser" | "language" | "os";
1384
+ operator: "includes" | "doesNotInclude";
1385
+ values: string[];
1386
+ } & {
1387
+ reason?: string | undefined;
1388
+ }) | ({
1389
+ type: "always";
1390
+ } & {
1391
+ operator?: null | undefined;
1392
+ field?: null | undefined;
1393
+ value?: null | undefined;
1394
+ reason?: null | undefined;
1395
+ rule_id?: string | number | undefined;
1396
+ }))[];
1397
+ availability_expression: import("./helpers/rules").RuleExpression | null;
1398
+ recommend_expression: import("./helpers/rules").RuleExpression | null;
1399
+ always_recommend: boolean;
1400
+ confirm: string;
1401
+ shortcut: string[];
1402
+ explanation: string;
1403
+ heading: string;
1404
+ is_live: boolean;
1405
+ category: number | null;
1406
+ sort_key: number | null;
1407
+ icon: string | null;
1408
+ icon_color: string | null;
1409
+ image_color: string | null;
1410
+ image: string | null;
1411
+ celebrate: boolean | {
1412
+ angle?: number | undefined;
1413
+ spread?: number | undefined;
1414
+ width?: string | undefined;
1415
+ height?: string | undefined;
1416
+ duration?: number | undefined;
1417
+ dragFriction?: number | undefined;
1418
+ stagger?: number | undefined;
1419
+ startVelocity?: number | undefined;
1420
+ elementCount?: number | undefined;
1421
+ decay?: number | undefined;
1422
+ colors?: string[] | undefined;
1423
+ random?: any;
1424
+ } | null;
1425
+ recommend_sort_key: number | null;
1426
+ shortcut_mac: string[];
1427
+ shortcut_win: string[];
1428
+ hotkey_mac: string;
1429
+ hotkey_win: string;
1430
+ detail: string | ({
1431
+ type: "html" | "video" | "plaintext" | "markdown" | "component" | "react";
1432
+ value: string;
1433
+ } & {
1434
+ position?: "inline" | "popover" | undefined;
1435
+ }) | (string | ({
1436
+ type: "html" | "video" | "plaintext" | "markdown" | "component" | "react";
1437
+ value: string;
1438
+ } & {
1439
+ position?: "inline" | "popover" | undefined;
1440
+ }))[] | null;
1441
+ content: string | ({
1442
+ type: "html" | "video" | "plaintext" | "markdown" | "component" | "react";
1443
+ value: string;
1444
+ } & {
1445
+ position?: "inline" | "popover" | undefined;
1446
+ }) | (string | ({
1447
+ type: "html" | "video" | "plaintext" | "markdown" | "component" | "react";
1448
+ value: string;
1449
+ } & {
1450
+ position?: "inline" | "popover" | undefined;
1451
+ }))[] | null;
1452
+ show_preview: boolean;
1453
+ next_steps: (string | number | {
1454
+ cta: string;
1455
+ action: {
1456
+ type: "execute_command";
1457
+ meta: {
1458
+ command: string;
1459
+ } & {
1460
+ type?: "link" | "video" | "action" | "helpdoc" | undefined;
1461
+ };
1462
+ } | {
1463
+ type: "click";
1464
+ value: string;
1465
+ } | {
1466
+ type: "click" | "clickBySelector" | "clickByXpath";
1467
+ value: string[];
1468
+ } | ({
1469
+ type: "link";
1470
+ value: string;
1471
+ } & {
1472
+ operation?: "self" | "router" | "blank" | undefined;
1473
+ }) | {
1474
+ type: "open_chat";
1475
+ meta: {
1476
+ type: "" | "intercom" | "helpscout" | "freshdesk" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "hubspot" | "drift";
1477
+ };
1478
+ } | {
1479
+ type: "dismiss";
1480
+ } | {
1481
+ type: "snooze";
1482
+ } | {
1483
+ type: "questlist";
1484
+ value: number;
1485
+ } | {
1486
+ type: "step_back";
1487
+ } | {
1488
+ type: "nudge";
1489
+ value: number;
1490
+ } | {
1491
+ type: "go_to_step";
1492
+ value: number;
1493
+ } | ({
1494
+ type: "open_bar";
1495
+ } & {
1496
+ value?: string | undefined;
1497
+ categoryFilter?: number | undefined;
1498
+ }) | {
1499
+ type: "open_helphub";
1500
+ } | {
1501
+ type: "open_copilot";
1502
+ } | {
1503
+ type: "no_action";
1504
+ };
1505
+ })[];
1506
+ extra: string | null;
1507
+ thumbnail: {
1508
+ src: string;
1509
+ file_name: string;
1510
+ size: string;
1511
+ } | null;
1512
+ copilot_suggest: boolean;
1513
+ show_in_spotlight_search: boolean;
1514
+ show_in_helphub_search: boolean;
1515
+ copilot_cta_label: string;
1516
+ copilot_description: string;
1517
+ } & {
1518
+ third_party_source?: string | null | undefined;
1519
+ third_party_id?: string | null | undefined;
1520
+ training_only?: boolean | undefined;
1521
+ integration?: {
1522
+ id: number;
1523
+ helphub_view_article_button_hidden: boolean | undefined;
1524
+ } | null | undefined;
1525
+ }, {
1526
+ id: number;
1527
+ text: string;
1528
+ template: ({
1529
+ type: "admin";
1530
+ value: string;
1531
+ } & {} & {
1532
+ commandType?: "object" | "help" | "independent" | undefined;
1533
+ object?: string | undefined;
1534
+ hoverTooltip?: boolean | undefined;
1535
+ operation?: "self" | "router" | "blank" | "help_hub" | undefined;
1536
+ metadata?: {
1537
+ [key: string]: unknown;
1538
+ } | undefined;
1539
+ }) | ({
1540
+ type: "callback";
1541
+ value: string;
1542
+ } & {} & {
1543
+ commandType?: "object" | "help" | "independent" | undefined;
1544
+ object?: string | undefined;
1545
+ hoverTooltip?: boolean | undefined;
1546
+ operation?: "self" | "router" | "blank" | "help_hub" | undefined;
1547
+ metadata?: {
1548
+ [key: string]: unknown;
1549
+ } | undefined;
1550
+ }) | ({
1551
+ type: "link";
1552
+ value: string;
1553
+ } & {
1554
+ operation?: "self" | "router" | "blank" | undefined;
1555
+ } & {} & {
1556
+ commandType?: "object" | "help" | "independent" | undefined;
1557
+ object?: string | undefined;
1558
+ hoverTooltip?: boolean | undefined;
1559
+ operation?: "self" | "router" | "blank" | "help_hub" | undefined;
1560
+ metadata?: {
1561
+ [key: string]: unknown;
1562
+ } | undefined;
1563
+ }) | ({
1564
+ type: "click" | "clickBySelector" | "clickByXpath";
1565
+ value: string[];
1566
+ } & {} & {
1567
+ commandType?: "object" | "help" | "independent" | undefined;
1568
+ object?: string | undefined;
1569
+ hoverTooltip?: boolean | undefined;
1570
+ operation?: "self" | "router" | "blank" | "help_hub" | undefined;
1571
+ metadata?: {
1572
+ [key: string]: unknown;
1573
+ } | undefined;
1574
+ }) | ({
1575
+ type: "builtin";
1576
+ value: string;
1577
+ } & {} & {
1578
+ commandType?: "object" | "help" | "independent" | undefined;
1579
+ object?: string | undefined;
1580
+ hoverTooltip?: boolean | undefined;
1581
+ operation?: "self" | "router" | "blank" | "help_hub" | undefined;
1582
+ metadata?: {
1583
+ [key: string]: unknown;
1584
+ } | undefined;
1585
+ }) | ({
1586
+ type: "webhook";
1587
+ value: string;
1588
+ } & {} & {
1589
+ commandType?: "object" | "help" | "independent" | undefined;
1590
+ object?: string | undefined;
1591
+ hoverTooltip?: boolean | undefined;
1592
+ operation?: "self" | "router" | "blank" | "help_hub" | undefined;
1593
+ metadata?: {
1594
+ [key: string]: unknown;
1595
+ } | undefined;
1596
+ }) | ({
1597
+ type: "script";
1598
+ value: string;
1599
+ } & {} & {
1600
+ commandType?: "object" | "help" | "independent" | undefined;
1601
+ object?: string | undefined;
1602
+ hoverTooltip?: boolean | undefined;
1603
+ operation?: "self" | "router" | "blank" | "help_hub" | undefined;
1604
+ metadata?: {
1605
+ [key: string]: unknown;
1606
+ } | undefined;
1607
+ }) | ({
1608
+ type: "request";
1609
+ value: {
1610
+ method: "head" | "options" | "get" | "post" | "put" | "delete" | "patch";
1611
+ url: string;
1612
+ } & {
1613
+ headers?: {
1614
+ [key: string]: unknown;
1615
+ } | undefined;
1616
+ body?: {
1617
+ [key: string]: unknown;
1618
+ } | undefined;
1619
+ onSend?: string | undefined;
1620
+ onSuccess?: string | undefined;
1621
+ onError?: string | undefined;
1622
+ };
1623
+ } & {} & {
1624
+ commandType?: "object" | "help" | "independent" | undefined;
1625
+ object?: string | undefined;
1626
+ hoverTooltip?: boolean | undefined;
1627
+ operation?: "self" | "router" | "blank" | "help_hub" | undefined;
1628
+ metadata?: {
1629
+ [key: string]: unknown;
1630
+ } | undefined;
1631
+ }) | ({
1632
+ type: "appcues";
1633
+ value: string;
1634
+ } & {} & {
1635
+ commandType?: "object" | "help" | "independent" | undefined;
1636
+ object?: string | undefined;
1637
+ hoverTooltip?: boolean | undefined;
1638
+ operation?: "self" | "router" | "blank" | "help_hub" | undefined;
1639
+ metadata?: {
1640
+ [key: string]: unknown;
1641
+ } | undefined;
1642
+ }) | ({
1643
+ type: "pendo_guide";
1644
+ value: string;
1645
+ } & {} & {
1646
+ commandType?: "object" | "help" | "independent" | undefined;
1647
+ object?: string | undefined;
1648
+ hoverTooltip?: boolean | undefined;
1649
+ operation?: "self" | "router" | "blank" | "help_hub" | undefined;
1650
+ metadata?: {
1651
+ [key: string]: unknown;
1652
+ } | undefined;
1653
+ }) | ({
1654
+ type: "video";
1655
+ value: string;
1656
+ } & {} & {
1657
+ commandType?: "object" | "help" | "independent" | undefined;
1658
+ object?: string | undefined;
1659
+ hoverTooltip?: boolean | undefined;
1660
+ operation?: "self" | "router" | "blank" | "help_hub" | undefined;
1661
+ metadata?: {
1662
+ [key: string]: unknown;
1663
+ } | undefined;
1664
+ }) | ({
1665
+ type: "helpdoc";
1666
+ value: string;
1667
+ } & {
1668
+ operation?: "self" | "router" | "blank" | "help_hub" | undefined;
1669
+ doc_metadata?: {
1670
+ content_type?: string | undefined;
1671
+ date?: string | undefined;
1672
+ } | undefined;
1673
+ } & {
1674
+ doc_type?: "answer" | "doc" | undefined;
1675
+ } & {} & {
1676
+ commandType?: "object" | "help" | "independent" | undefined;
1677
+ object?: string | undefined;
1678
+ hoverTooltip?: boolean | undefined;
1679
+ operation?: "self" | "router" | "blank" | "help_hub" | undefined;
1680
+ metadata?: {
1681
+ [key: string]: unknown;
1682
+ } | undefined;
1683
+ }) | ({
1684
+ type: "trigger";
1685
+ value: {
1686
+ type: "execute_command";
1687
+ meta: {
1688
+ command: string;
1689
+ } & {
1690
+ type?: "link" | "video" | "action" | "helpdoc" | undefined;
1691
+ };
1692
+ } | {
1693
+ type: "click";
1694
+ value: string;
1695
+ } | {
1696
+ type: "click" | "clickBySelector" | "clickByXpath";
1697
+ value: string[];
1698
+ } | ({
1699
+ type: "link";
1700
+ value: string;
1701
+ } & {
1702
+ operation?: "self" | "router" | "blank" | undefined;
1703
+ }) | {
1704
+ type: "open_chat";
1705
+ meta: {
1706
+ type: "" | "intercom" | "helpscout" | "freshdesk" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "hubspot" | "drift";
1707
+ };
1708
+ } | {
1709
+ type: "dismiss";
1710
+ } | {
1711
+ type: "snooze";
1712
+ } | {
1713
+ type: "questlist";
1714
+ value: number;
1715
+ } | {
1716
+ type: "step_back";
1717
+ } | {
1718
+ type: "nudge";
1719
+ value: number;
1720
+ } | {
1721
+ type: "go_to_step";
1722
+ value: number;
1723
+ } | ({
1724
+ type: "open_bar";
1725
+ } & {
1726
+ value?: string | undefined;
1727
+ categoryFilter?: number | undefined;
1728
+ }) | {
1729
+ type: "open_helphub";
1730
+ } | {
1731
+ type: "open_copilot";
1732
+ } | {
1733
+ type: "no_action";
1734
+ };
1735
+ } & {} & {
1736
+ commandType?: "object" | "help" | "independent" | undefined;
1737
+ object?: string | undefined;
1738
+ hoverTooltip?: boolean | undefined;
1739
+ operation?: "self" | "router" | "blank" | "help_hub" | undefined;
1740
+ metadata?: {
1741
+ [key: string]: unknown;
1742
+ } | undefined;
1743
+ });
1744
+ } & {
1745
+ disabledReason?: string | undefined;
1746
+ source?: string | undefined;
1747
+ name?: string | undefined;
1748
+ last_available?: string | null | undefined;
1749
+ modified?: string | undefined;
1750
+ isAsync?: boolean | undefined;
1751
+ } & {
1752
+ arguments: {
1753
+ [x: string]: ({
1754
+ type: "context";
1755
+ value: string;
1756
+ order_key: number;
1757
+ } & {
1758
+ label?: string | undefined;
1759
+ chosen?: string | number | undefined;
1760
+ selected?: any[] | undefined;
1761
+ input_type?: string | undefined;
1762
+ preselected_key?: string | undefined;
1763
+ label_field?: string | undefined;
1764
+ loaded?: any[] | undefined;
1765
+ allow_create?: boolean | undefined;
1766
+ allow_create_label?: string | undefined;
1767
+ show_in_record_action_list?: boolean | undefined;
1768
+ show_in_default_list?: boolean | undefined;
1769
+ auto_choose?: boolean | undefined;
1770
+ is_private?: boolean | undefined;
1771
+ }) | ({
1772
+ type: "set";
1773
+ value: string[] | number[] | {
1774
+ [key: string]: unknown;
1775
+ }[];
1776
+ order_key: number;
1777
+ } & {
1778
+ label?: string | undefined;
1779
+ chosen?: string | number | undefined;
1780
+ selected?: any[] | undefined;
1781
+ input_type?: string | undefined;
1782
+ preselected_key?: string | undefined;
1783
+ label_field?: string | undefined;
1784
+ loaded?: any[] | undefined;
1785
+ allow_create?: boolean | undefined;
1786
+ allow_create_label?: string | undefined;
1787
+ auto_choose?: boolean | undefined;
1788
+ is_private?: boolean | undefined;
1789
+ }) | ({
1790
+ type: "provided";
1791
+ value: "time" | "text";
1792
+ order_key: number;
1793
+ } & {
1794
+ label?: string | undefined;
1795
+ chosen?: string | number | undefined;
1796
+ selected?: any[] | undefined;
1797
+ input_type?: string | undefined;
1798
+ preselected_key?: string | undefined;
1799
+ label_field?: string | undefined;
1800
+ loaded?: any[] | undefined;
1801
+ dateTimeArgumentTypeId?: number | undefined;
1802
+ allow_create?: boolean | undefined;
1803
+ allow_create_label?: string | undefined;
1804
+ auto_choose?: boolean | undefined;
1805
+ is_private?: boolean | undefined;
1806
+ }) | ({
1807
+ type: "html" | "video";
1808
+ value: {
1809
+ source: string;
1810
+ } & {
1811
+ title?: string | undefined;
1812
+ description?: string | undefined;
1813
+ url?: string | undefined;
1814
+ };
1815
+ order_key: number;
1816
+ } & {
1817
+ label?: string | undefined;
1818
+ chosen?: string | number | undefined;
1819
+ selected?: any[] | undefined;
1820
+ input_type?: string | undefined;
1821
+ preselected_key?: string | undefined;
1822
+ label_field?: string | undefined;
1823
+ loaded?: any[] | undefined;
1824
+ allow_create?: boolean | undefined;
1825
+ allow_create_label?: string | undefined;
1826
+ is_private?: boolean | undefined;
1827
+ auto_choose?: boolean | undefined;
1828
+ });
1829
+ };
1830
+ tags: string[];
1831
+ availability_rules: (({
1832
+ type: "url" | "element" | "context" | "hubspot" | "device_type" | "sessions" | "survey_response" | "user_property" | "event_property" | "hostname" | "executions" | "shortcuts" | "last_seen" | "first_seen" | "opens" | "deadends" | "heap" | "ab_test" | "intent" | "help_doc_interaction" | "video_interaction";
1833
+ operator: "includes" | "endsWith" | "startsWith" | "is" | "isTrue" | "isFalse" | "isTruthy" | "isFalsy" | "matchesRegex" | "isDefined" | "isNotDefined" | "classnameOnPage" | "idOnPage" | "selectorOnPage" | "classnameNotOnPage" | "idNotOnPage" | "selectorNotOnPage" | "doesNotInclude" | "isNot" | "isGreaterThan" | "isLessThan";
1834
+ } & {
1835
+ field?: string | undefined;
1836
+ value?: string | undefined;
1837
+ reason?: string | undefined;
1838
+ rule_id?: string | number | undefined;
1839
+ }) | ({
1840
+ type: "nudge_interaction";
1841
+ operator: "is" | "isNot";
1842
+ value: "completed" | "dismissed" | "viewed";
1843
+ nudge_id: number;
1844
+ } & {
1845
+ reason?: string | undefined;
1846
+ }) | ({
1847
+ type: "questlist_interaction";
1848
+ operator: "is" | "isNot";
1849
+ value: "completed" | "dismissed" | "viewed";
1850
+ questlist_id: number;
1851
+ } & {
1852
+ reason?: string | undefined;
1853
+ }) | ({
1854
+ type: "browser" | "language" | "os";
1855
+ operator: "includes" | "doesNotInclude";
1856
+ values: string[];
1857
+ } & {
1858
+ reason?: string | undefined;
1859
+ }))[];
1860
+ recommend_rules: (({
1861
+ type: "url" | "element" | "context" | "hubspot" | "device_type" | "sessions" | "survey_response" | "user_property" | "event_property" | "hostname" | "executions" | "shortcuts" | "last_seen" | "first_seen" | "opens" | "deadends" | "heap" | "ab_test" | "intent" | "help_doc_interaction" | "video_interaction";
1862
+ operator: "includes" | "endsWith" | "startsWith" | "is" | "isTrue" | "isFalse" | "isTruthy" | "isFalsy" | "matchesRegex" | "isDefined" | "isNotDefined" | "classnameOnPage" | "idOnPage" | "selectorOnPage" | "classnameNotOnPage" | "idNotOnPage" | "selectorNotOnPage" | "doesNotInclude" | "isNot" | "isGreaterThan" | "isLessThan";
1863
+ } & {
1864
+ field?: string | undefined;
1865
+ value?: string | undefined;
1866
+ reason?: string | undefined;
1867
+ rule_id?: string | number | undefined;
1868
+ }) | ({
1869
+ type: "nudge_interaction";
1870
+ operator: "is" | "isNot";
1871
+ value: "completed" | "dismissed" | "viewed";
1872
+ nudge_id: number;
1873
+ } & {
1874
+ reason?: string | undefined;
1875
+ }) | ({
1876
+ type: "questlist_interaction";
1877
+ operator: "is" | "isNot";
1878
+ value: "completed" | "dismissed" | "viewed";
1879
+ questlist_id: number;
1880
+ } & {
1881
+ reason?: string | undefined;
1882
+ }) | ({
1883
+ type: "browser" | "language" | "os";
1884
+ operator: "includes" | "doesNotInclude";
1885
+ values: string[];
1886
+ } & {
1887
+ reason?: string | undefined;
1888
+ }) | ({
1889
+ type: "always";
1890
+ } & {
1891
+ operator?: null | undefined;
1892
+ field?: null | undefined;
1893
+ value?: null | undefined;
1894
+ reason?: null | undefined;
1895
+ rule_id?: string | number | undefined;
1896
+ }))[];
1897
+ availability_expression: import("./helpers/rules").RuleExpression | null;
1898
+ recommend_expression: import("./helpers/rules").RuleExpression | null;
1899
+ always_recommend: boolean;
1900
+ confirm: string;
1901
+ shortcut: string[];
1902
+ explanation: string;
1903
+ heading: string;
1904
+ is_live: boolean;
1905
+ category: number | null;
1906
+ sort_key: number | null;
1907
+ icon: string | null;
1908
+ icon_color: string | null;
1909
+ image_color: string | null;
1910
+ image: string | null;
1911
+ celebrate: boolean | {
1912
+ angle?: number | undefined;
1913
+ spread?: number | undefined;
1914
+ width?: string | undefined;
1915
+ height?: string | undefined;
1916
+ duration?: number | undefined;
1917
+ dragFriction?: number | undefined;
1918
+ stagger?: number | undefined;
1919
+ startVelocity?: number | undefined;
1920
+ elementCount?: number | undefined;
1921
+ decay?: number | undefined;
1922
+ colors?: string[] | undefined;
1923
+ random?: any;
1924
+ } | null;
1925
+ recommend_sort_key: number | null;
1926
+ shortcut_mac: string[];
1927
+ shortcut_win: string[];
1928
+ hotkey_mac: string;
1929
+ hotkey_win: string;
1930
+ detail: string | ({
1931
+ type: "html" | "video" | "plaintext" | "markdown" | "component" | "react";
1932
+ value: string;
1933
+ } & {
1934
+ position?: "inline" | "popover" | undefined;
1935
+ }) | (string | ({
1936
+ type: "html" | "video" | "plaintext" | "markdown" | "component" | "react";
1937
+ value: string;
1938
+ } & {
1939
+ position?: "inline" | "popover" | undefined;
1940
+ }))[] | null;
1941
+ content: string | ({
1942
+ type: "html" | "video" | "plaintext" | "markdown" | "component" | "react";
1943
+ value: string;
1944
+ } & {
1945
+ position?: "inline" | "popover" | undefined;
1946
+ }) | (string | ({
1947
+ type: "html" | "video" | "plaintext" | "markdown" | "component" | "react";
1948
+ value: string;
1949
+ } & {
1950
+ position?: "inline" | "popover" | undefined;
1951
+ }))[] | null;
1952
+ show_preview: boolean;
1953
+ next_steps: (string | number | {
1954
+ cta: string;
1955
+ action: {
1956
+ type: "execute_command";
1957
+ meta: {
1958
+ command: string;
1959
+ } & {
1960
+ type?: "link" | "video" | "action" | "helpdoc" | undefined;
1961
+ };
1962
+ } | {
1963
+ type: "click";
1964
+ value: string;
1965
+ } | {
1966
+ type: "click" | "clickBySelector" | "clickByXpath";
1967
+ value: string[];
1968
+ } | ({
1969
+ type: "link";
1970
+ value: string;
1971
+ } & {
1972
+ operation?: "self" | "router" | "blank" | undefined;
1973
+ }) | {
1974
+ type: "open_chat";
1975
+ meta: {
1976
+ type: "" | "intercom" | "helpscout" | "freshdesk" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "hubspot" | "drift";
1977
+ };
1978
+ } | {
1979
+ type: "dismiss";
1980
+ } | {
1981
+ type: "snooze";
1982
+ } | {
1983
+ type: "questlist";
1984
+ value: number;
1985
+ } | {
1986
+ type: "step_back";
1987
+ } | {
1988
+ type: "nudge";
1989
+ value: number;
1990
+ } | {
1991
+ type: "go_to_step";
1992
+ value: number;
1993
+ } | ({
1994
+ type: "open_bar";
1995
+ } & {
1996
+ value?: string | undefined;
1997
+ categoryFilter?: number | undefined;
1998
+ }) | {
1999
+ type: "open_helphub";
2000
+ } | {
2001
+ type: "open_copilot";
2002
+ } | {
2003
+ type: "no_action";
2004
+ };
2005
+ })[];
2006
+ extra: string | null;
2007
+ thumbnail: {
2008
+ src: string;
2009
+ file_name: string;
2010
+ size: string;
2011
+ } | null;
2012
+ copilot_suggest: boolean;
2013
+ show_in_spotlight_search: boolean;
2014
+ show_in_helphub_search: boolean;
2015
+ copilot_cta_label: string;
2016
+ copilot_description: string;
2017
+ } & {
2018
+ third_party_source?: string | null | undefined;
2019
+ third_party_id?: string | null | undefined;
2020
+ training_only?: boolean | undefined;
2021
+ integration?: {
2022
+ id: number;
2023
+ helphub_view_article_button_hidden: boolean | undefined;
2024
+ } | null | undefined;
2025
+ }, any>;
2026
+ excerpt: t.StringC;
2027
+ score: t.ArrayC<t.NumberC>;
2028
+ }>, t.TypeC<{
2029
+ type: t.UnionC<[t.LiteralC<"nudge">, t.LiteralC<"checklist">]>;
2030
+ experience_id: t.NumberC;
2031
+ experience: t.UndefinedC;
2032
+ excerpt: t.StringC;
2033
+ score: t.ArrayC<t.NumberC>;
2034
+ }>]>;
2035
+ export declare const SearchExperiencesResponseV: t.TypeC<{
2036
+ data: t.ArrayC<t.TypeC<{
2037
+ hit: t.UnionC<[t.TypeC<{
2038
+ type: t.UnionC<[t.LiteralC<"page">, t.LiteralC<"action">, t.LiteralC<"helpdoc">, t.LiteralC<"video">]>;
2039
+ experience_id: t.NumberC;
2040
+ experience: t.Type<{
2041
+ id: number;
2042
+ text: string;
2043
+ template: ({
2044
+ type: "admin";
2045
+ value: string;
2046
+ } & {} & {
2047
+ commandType?: "object" | "help" | "independent" | undefined;
2048
+ object?: string | undefined;
2049
+ hoverTooltip?: boolean | undefined;
2050
+ operation?: "self" | "router" | "blank" | "help_hub" | undefined;
2051
+ metadata?: {
2052
+ [key: string]: unknown;
2053
+ } | undefined;
2054
+ }) | ({
2055
+ type: "callback";
2056
+ value: string;
2057
+ } & {} & {
2058
+ commandType?: "object" | "help" | "independent" | undefined;
2059
+ object?: string | undefined;
2060
+ hoverTooltip?: boolean | undefined;
2061
+ operation?: "self" | "router" | "blank" | "help_hub" | undefined;
2062
+ metadata?: {
2063
+ [key: string]: unknown;
2064
+ } | undefined;
2065
+ }) | ({
2066
+ type: "link";
2067
+ value: string;
2068
+ } & {
2069
+ operation?: "self" | "router" | "blank" | undefined;
2070
+ } & {} & {
2071
+ commandType?: "object" | "help" | "independent" | undefined;
2072
+ object?: string | undefined;
2073
+ hoverTooltip?: boolean | undefined;
2074
+ operation?: "self" | "router" | "blank" | "help_hub" | undefined;
2075
+ metadata?: {
2076
+ [key: string]: unknown;
2077
+ } | undefined;
2078
+ }) | ({
2079
+ type: "click" | "clickBySelector" | "clickByXpath";
2080
+ value: string[];
2081
+ } & {} & {
2082
+ commandType?: "object" | "help" | "independent" | undefined;
2083
+ object?: string | undefined;
2084
+ hoverTooltip?: boolean | undefined;
2085
+ operation?: "self" | "router" | "blank" | "help_hub" | undefined;
2086
+ metadata?: {
2087
+ [key: string]: unknown;
2088
+ } | undefined;
2089
+ }) | ({
2090
+ type: "builtin";
2091
+ value: string;
2092
+ } & {} & {
2093
+ commandType?: "object" | "help" | "independent" | undefined;
2094
+ object?: string | undefined;
2095
+ hoverTooltip?: boolean | undefined;
2096
+ operation?: "self" | "router" | "blank" | "help_hub" | undefined;
2097
+ metadata?: {
2098
+ [key: string]: unknown;
2099
+ } | undefined;
2100
+ }) | ({
2101
+ type: "webhook";
2102
+ value: string;
2103
+ } & {} & {
2104
+ commandType?: "object" | "help" | "independent" | undefined;
2105
+ object?: string | undefined;
2106
+ hoverTooltip?: boolean | undefined;
2107
+ operation?: "self" | "router" | "blank" | "help_hub" | undefined;
2108
+ metadata?: {
2109
+ [key: string]: unknown;
2110
+ } | undefined;
2111
+ }) | ({
2112
+ type: "script";
2113
+ value: string;
2114
+ } & {} & {
2115
+ commandType?: "object" | "help" | "independent" | undefined;
2116
+ object?: string | undefined;
2117
+ hoverTooltip?: boolean | undefined;
2118
+ operation?: "self" | "router" | "blank" | "help_hub" | undefined;
2119
+ metadata?: {
2120
+ [key: string]: unknown;
2121
+ } | undefined;
2122
+ }) | ({
2123
+ type: "request";
2124
+ value: {
2125
+ method: "head" | "options" | "get" | "post" | "put" | "delete" | "patch";
2126
+ url: string;
2127
+ } & {
2128
+ headers?: {
2129
+ [key: string]: unknown;
2130
+ } | undefined;
2131
+ body?: {
2132
+ [key: string]: unknown;
2133
+ } | undefined;
2134
+ onSend?: string | undefined;
2135
+ onSuccess?: string | undefined;
2136
+ onError?: string | undefined;
2137
+ };
2138
+ } & {} & {
2139
+ commandType?: "object" | "help" | "independent" | undefined;
2140
+ object?: string | undefined;
2141
+ hoverTooltip?: boolean | undefined;
2142
+ operation?: "self" | "router" | "blank" | "help_hub" | undefined;
2143
+ metadata?: {
2144
+ [key: string]: unknown;
2145
+ } | undefined;
2146
+ }) | ({
2147
+ type: "appcues";
2148
+ value: string;
2149
+ } & {} & {
2150
+ commandType?: "object" | "help" | "independent" | undefined;
2151
+ object?: string | undefined;
2152
+ hoverTooltip?: boolean | undefined;
2153
+ operation?: "self" | "router" | "blank" | "help_hub" | undefined;
2154
+ metadata?: {
2155
+ [key: string]: unknown;
2156
+ } | undefined;
2157
+ }) | ({
2158
+ type: "pendo_guide";
2159
+ value: string;
2160
+ } & {} & {
2161
+ commandType?: "object" | "help" | "independent" | undefined;
2162
+ object?: string | undefined;
2163
+ hoverTooltip?: boolean | undefined;
2164
+ operation?: "self" | "router" | "blank" | "help_hub" | undefined;
2165
+ metadata?: {
2166
+ [key: string]: unknown;
2167
+ } | undefined;
2168
+ }) | ({
2169
+ type: "video";
2170
+ value: string;
2171
+ } & {} & {
2172
+ commandType?: "object" | "help" | "independent" | undefined;
2173
+ object?: string | undefined;
2174
+ hoverTooltip?: boolean | undefined;
2175
+ operation?: "self" | "router" | "blank" | "help_hub" | undefined;
2176
+ metadata?: {
2177
+ [key: string]: unknown;
2178
+ } | undefined;
2179
+ }) | ({
2180
+ type: "helpdoc";
2181
+ value: string;
2182
+ } & {
2183
+ operation?: "self" | "router" | "blank" | "help_hub" | undefined;
2184
+ doc_metadata?: {
2185
+ content_type?: string | undefined;
2186
+ date?: string | undefined;
2187
+ } | undefined;
2188
+ } & {
2189
+ doc_type?: "answer" | "doc" | undefined;
2190
+ } & {} & {
2191
+ commandType?: "object" | "help" | "independent" | undefined;
2192
+ object?: string | undefined;
2193
+ hoverTooltip?: boolean | undefined;
2194
+ operation?: "self" | "router" | "blank" | "help_hub" | undefined;
2195
+ metadata?: {
2196
+ [key: string]: unknown;
2197
+ } | undefined;
2198
+ }) | ({
2199
+ type: "trigger";
2200
+ value: {
2201
+ type: "execute_command";
2202
+ meta: {
2203
+ command: string;
2204
+ } & {
2205
+ type?: "link" | "video" | "action" | "helpdoc" | undefined;
2206
+ };
2207
+ } | {
2208
+ type: "click";
2209
+ value: string;
2210
+ } | {
2211
+ type: "click" | "clickBySelector" | "clickByXpath";
2212
+ value: string[];
2213
+ } | ({
2214
+ type: "link";
2215
+ value: string;
2216
+ } & {
2217
+ operation?: "self" | "router" | "blank" | undefined;
2218
+ }) | {
2219
+ type: "open_chat";
2220
+ meta: {
2221
+ type: "" | "intercom" | "helpscout" | "freshdesk" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "hubspot" | "drift";
2222
+ };
2223
+ } | {
2224
+ type: "dismiss";
2225
+ } | {
2226
+ type: "snooze";
2227
+ } | {
2228
+ type: "questlist";
2229
+ value: number;
2230
+ } | {
2231
+ type: "step_back";
2232
+ } | {
2233
+ type: "nudge";
2234
+ value: number;
2235
+ } | {
2236
+ type: "go_to_step";
2237
+ value: number;
2238
+ } | ({
2239
+ type: "open_bar";
2240
+ } & {
2241
+ value?: string | undefined;
2242
+ categoryFilter?: number | undefined;
2243
+ }) | {
2244
+ type: "open_helphub";
2245
+ } | {
2246
+ type: "open_copilot";
2247
+ } | {
2248
+ type: "no_action";
2249
+ };
2250
+ } & {} & {
2251
+ commandType?: "object" | "help" | "independent" | undefined;
2252
+ object?: string | undefined;
2253
+ hoverTooltip?: boolean | undefined;
2254
+ operation?: "self" | "router" | "blank" | "help_hub" | undefined;
2255
+ metadata?: {
2256
+ [key: string]: unknown;
2257
+ } | undefined;
2258
+ });
2259
+ } & {
2260
+ disabledReason?: string | undefined;
2261
+ source?: string | undefined;
2262
+ name?: string | undefined;
2263
+ last_available?: string | null | undefined;
2264
+ modified?: string | undefined;
2265
+ isAsync?: boolean | undefined;
2266
+ } & {
2267
+ arguments: {
2268
+ [x: string]: ({
2269
+ type: "context";
2270
+ value: string;
2271
+ order_key: number;
2272
+ } & {
2273
+ label?: string | undefined;
2274
+ chosen?: string | number | undefined;
2275
+ selected?: any[] | undefined;
2276
+ input_type?: string | undefined;
2277
+ preselected_key?: string | undefined;
2278
+ label_field?: string | undefined;
2279
+ loaded?: any[] | undefined;
2280
+ allow_create?: boolean | undefined;
2281
+ allow_create_label?: string | undefined;
2282
+ show_in_record_action_list?: boolean | undefined;
2283
+ show_in_default_list?: boolean | undefined;
2284
+ auto_choose?: boolean | undefined;
2285
+ is_private?: boolean | undefined;
2286
+ }) | ({
2287
+ type: "set";
2288
+ value: string[] | number[] | {
2289
+ [key: string]: unknown;
2290
+ }[];
2291
+ order_key: number;
2292
+ } & {
2293
+ label?: string | undefined;
2294
+ chosen?: string | number | undefined;
2295
+ selected?: any[] | undefined;
2296
+ input_type?: string | undefined;
2297
+ preselected_key?: string | undefined;
2298
+ label_field?: string | undefined;
2299
+ loaded?: any[] | undefined;
2300
+ allow_create?: boolean | undefined;
2301
+ allow_create_label?: string | undefined;
2302
+ auto_choose?: boolean | undefined;
2303
+ is_private?: boolean | undefined;
2304
+ }) | ({
2305
+ type: "provided";
2306
+ value: "time" | "text";
2307
+ order_key: number;
2308
+ } & {
2309
+ label?: string | undefined;
2310
+ chosen?: string | number | undefined;
2311
+ selected?: any[] | undefined;
2312
+ input_type?: string | undefined;
2313
+ preselected_key?: string | undefined;
2314
+ label_field?: string | undefined;
2315
+ loaded?: any[] | undefined;
2316
+ dateTimeArgumentTypeId?: number | undefined;
2317
+ allow_create?: boolean | undefined;
2318
+ allow_create_label?: string | undefined;
2319
+ auto_choose?: boolean | undefined;
2320
+ is_private?: boolean | undefined;
2321
+ }) | ({
2322
+ type: "html" | "video";
2323
+ value: {
2324
+ source: string;
2325
+ } & {
2326
+ title?: string | undefined;
2327
+ description?: string | undefined;
2328
+ url?: string | undefined;
2329
+ };
2330
+ order_key: number;
2331
+ } & {
2332
+ label?: string | undefined;
2333
+ chosen?: string | number | undefined;
2334
+ selected?: any[] | undefined;
2335
+ input_type?: string | undefined;
2336
+ preselected_key?: string | undefined;
2337
+ label_field?: string | undefined;
2338
+ loaded?: any[] | undefined;
2339
+ allow_create?: boolean | undefined;
2340
+ allow_create_label?: string | undefined;
2341
+ is_private?: boolean | undefined;
2342
+ auto_choose?: boolean | undefined;
2343
+ });
2344
+ };
2345
+ tags: string[];
2346
+ availability_rules: (({
2347
+ type: "url" | "element" | "context" | "hubspot" | "device_type" | "sessions" | "survey_response" | "user_property" | "event_property" | "hostname" | "executions" | "shortcuts" | "last_seen" | "first_seen" | "opens" | "deadends" | "heap" | "ab_test" | "intent" | "help_doc_interaction" | "video_interaction";
2348
+ operator: "includes" | "endsWith" | "startsWith" | "is" | "isTrue" | "isFalse" | "isTruthy" | "isFalsy" | "matchesRegex" | "isDefined" | "isNotDefined" | "classnameOnPage" | "idOnPage" | "selectorOnPage" | "classnameNotOnPage" | "idNotOnPage" | "selectorNotOnPage" | "doesNotInclude" | "isNot" | "isGreaterThan" | "isLessThan";
2349
+ } & {
2350
+ field?: string | undefined;
2351
+ value?: string | undefined;
2352
+ reason?: string | undefined;
2353
+ rule_id?: string | number | undefined;
2354
+ }) | ({
2355
+ type: "nudge_interaction";
2356
+ operator: "is" | "isNot";
2357
+ value: "completed" | "dismissed" | "viewed";
2358
+ nudge_id: number;
2359
+ } & {
2360
+ reason?: string | undefined;
2361
+ }) | ({
2362
+ type: "questlist_interaction";
2363
+ operator: "is" | "isNot";
2364
+ value: "completed" | "dismissed" | "viewed";
2365
+ questlist_id: number;
2366
+ } & {
2367
+ reason?: string | undefined;
2368
+ }) | ({
2369
+ type: "browser" | "language" | "os";
2370
+ operator: "includes" | "doesNotInclude";
2371
+ values: string[];
2372
+ } & {
2373
+ reason?: string | undefined;
2374
+ }))[];
2375
+ recommend_rules: (({
2376
+ type: "url" | "element" | "context" | "hubspot" | "device_type" | "sessions" | "survey_response" | "user_property" | "event_property" | "hostname" | "executions" | "shortcuts" | "last_seen" | "first_seen" | "opens" | "deadends" | "heap" | "ab_test" | "intent" | "help_doc_interaction" | "video_interaction";
2377
+ operator: "includes" | "endsWith" | "startsWith" | "is" | "isTrue" | "isFalse" | "isTruthy" | "isFalsy" | "matchesRegex" | "isDefined" | "isNotDefined" | "classnameOnPage" | "idOnPage" | "selectorOnPage" | "classnameNotOnPage" | "idNotOnPage" | "selectorNotOnPage" | "doesNotInclude" | "isNot" | "isGreaterThan" | "isLessThan";
2378
+ } & {
2379
+ field?: string | undefined;
2380
+ value?: string | undefined;
2381
+ reason?: string | undefined;
2382
+ rule_id?: string | number | undefined;
2383
+ }) | ({
2384
+ type: "nudge_interaction";
2385
+ operator: "is" | "isNot";
2386
+ value: "completed" | "dismissed" | "viewed";
2387
+ nudge_id: number;
2388
+ } & {
2389
+ reason?: string | undefined;
2390
+ }) | ({
2391
+ type: "questlist_interaction";
2392
+ operator: "is" | "isNot";
2393
+ value: "completed" | "dismissed" | "viewed";
2394
+ questlist_id: number;
2395
+ } & {
2396
+ reason?: string | undefined;
2397
+ }) | ({
2398
+ type: "browser" | "language" | "os";
2399
+ operator: "includes" | "doesNotInclude";
2400
+ values: string[];
2401
+ } & {
2402
+ reason?: string | undefined;
2403
+ }) | ({
2404
+ type: "always";
2405
+ } & {
2406
+ operator?: null | undefined;
2407
+ field?: null | undefined;
2408
+ value?: null | undefined;
2409
+ reason?: null | undefined;
2410
+ rule_id?: string | number | undefined;
2411
+ }))[];
2412
+ availability_expression: import("./helpers/rules").RuleExpression | null;
2413
+ recommend_expression: import("./helpers/rules").RuleExpression | null;
2414
+ always_recommend: boolean;
2415
+ confirm: string;
2416
+ shortcut: string[];
2417
+ explanation: string;
2418
+ heading: string;
2419
+ is_live: boolean;
2420
+ category: number | null;
2421
+ sort_key: number | null;
2422
+ icon: string | null;
2423
+ icon_color: string | null;
2424
+ image_color: string | null;
2425
+ image: string | null;
2426
+ celebrate: boolean | {
2427
+ angle?: number | undefined;
2428
+ spread?: number | undefined;
2429
+ width?: string | undefined;
2430
+ height?: string | undefined;
2431
+ duration?: number | undefined;
2432
+ dragFriction?: number | undefined;
2433
+ stagger?: number | undefined;
2434
+ startVelocity?: number | undefined;
2435
+ elementCount?: number | undefined;
2436
+ decay?: number | undefined;
2437
+ colors?: string[] | undefined;
2438
+ random?: any;
2439
+ } | null;
2440
+ recommend_sort_key: number | null;
2441
+ shortcut_mac: string[];
2442
+ shortcut_win: string[];
2443
+ hotkey_mac: string;
2444
+ hotkey_win: string;
2445
+ detail: string | ({
2446
+ type: "html" | "video" | "plaintext" | "markdown" | "component" | "react";
2447
+ value: string;
2448
+ } & {
2449
+ position?: "inline" | "popover" | undefined;
2450
+ }) | (string | ({
2451
+ type: "html" | "video" | "plaintext" | "markdown" | "component" | "react";
2452
+ value: string;
2453
+ } & {
2454
+ position?: "inline" | "popover" | undefined;
2455
+ }))[] | null;
2456
+ content: string | ({
2457
+ type: "html" | "video" | "plaintext" | "markdown" | "component" | "react";
2458
+ value: string;
2459
+ } & {
2460
+ position?: "inline" | "popover" | undefined;
2461
+ }) | (string | ({
2462
+ type: "html" | "video" | "plaintext" | "markdown" | "component" | "react";
2463
+ value: string;
2464
+ } & {
2465
+ position?: "inline" | "popover" | undefined;
2466
+ }))[] | null;
2467
+ show_preview: boolean;
2468
+ next_steps: (string | number | {
2469
+ cta: string;
2470
+ action: {
2471
+ type: "execute_command";
2472
+ meta: {
2473
+ command: string;
2474
+ } & {
2475
+ type?: "link" | "video" | "action" | "helpdoc" | undefined;
2476
+ };
2477
+ } | {
2478
+ type: "click";
2479
+ value: string;
2480
+ } | {
2481
+ type: "click" | "clickBySelector" | "clickByXpath";
2482
+ value: string[];
2483
+ } | ({
2484
+ type: "link";
2485
+ value: string;
2486
+ } & {
2487
+ operation?: "self" | "router" | "blank" | undefined;
2488
+ }) | {
2489
+ type: "open_chat";
2490
+ meta: {
2491
+ type: "" | "intercom" | "helpscout" | "freshdesk" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "hubspot" | "drift";
2492
+ };
2493
+ } | {
2494
+ type: "dismiss";
2495
+ } | {
2496
+ type: "snooze";
2497
+ } | {
2498
+ type: "questlist";
2499
+ value: number;
2500
+ } | {
2501
+ type: "step_back";
2502
+ } | {
2503
+ type: "nudge";
2504
+ value: number;
2505
+ } | {
2506
+ type: "go_to_step";
2507
+ value: number;
2508
+ } | ({
2509
+ type: "open_bar";
2510
+ } & {
2511
+ value?: string | undefined;
2512
+ categoryFilter?: number | undefined;
2513
+ }) | {
2514
+ type: "open_helphub";
2515
+ } | {
2516
+ type: "open_copilot";
2517
+ } | {
2518
+ type: "no_action";
2519
+ };
2520
+ })[];
2521
+ extra: string | null;
2522
+ thumbnail: {
2523
+ src: string;
2524
+ file_name: string;
2525
+ size: string;
2526
+ } | null;
2527
+ copilot_suggest: boolean;
2528
+ show_in_spotlight_search: boolean;
2529
+ show_in_helphub_search: boolean;
2530
+ copilot_cta_label: string;
2531
+ copilot_description: string;
2532
+ } & {
2533
+ third_party_source?: string | null | undefined;
2534
+ third_party_id?: string | null | undefined;
2535
+ training_only?: boolean | undefined;
2536
+ integration?: {
2537
+ id: number;
2538
+ helphub_view_article_button_hidden: boolean | undefined;
2539
+ } | null | undefined;
2540
+ }, {
2541
+ id: number;
2542
+ text: string;
2543
+ template: ({
2544
+ type: "admin";
2545
+ value: string;
2546
+ } & {} & {
2547
+ commandType?: "object" | "help" | "independent" | undefined;
2548
+ object?: string | undefined;
2549
+ hoverTooltip?: boolean | undefined;
2550
+ operation?: "self" | "router" | "blank" | "help_hub" | undefined;
2551
+ metadata?: {
2552
+ [key: string]: unknown;
2553
+ } | undefined;
2554
+ }) | ({
2555
+ type: "callback";
2556
+ value: string;
2557
+ } & {} & {
2558
+ commandType?: "object" | "help" | "independent" | undefined;
2559
+ object?: string | undefined;
2560
+ hoverTooltip?: boolean | undefined;
2561
+ operation?: "self" | "router" | "blank" | "help_hub" | undefined;
2562
+ metadata?: {
2563
+ [key: string]: unknown;
2564
+ } | undefined;
2565
+ }) | ({
2566
+ type: "link";
2567
+ value: string;
2568
+ } & {
2569
+ operation?: "self" | "router" | "blank" | undefined;
2570
+ } & {} & {
2571
+ commandType?: "object" | "help" | "independent" | undefined;
2572
+ object?: string | undefined;
2573
+ hoverTooltip?: boolean | undefined;
2574
+ operation?: "self" | "router" | "blank" | "help_hub" | undefined;
2575
+ metadata?: {
2576
+ [key: string]: unknown;
2577
+ } | undefined;
2578
+ }) | ({
2579
+ type: "click" | "clickBySelector" | "clickByXpath";
2580
+ value: string[];
2581
+ } & {} & {
2582
+ commandType?: "object" | "help" | "independent" | undefined;
2583
+ object?: string | undefined;
2584
+ hoverTooltip?: boolean | undefined;
2585
+ operation?: "self" | "router" | "blank" | "help_hub" | undefined;
2586
+ metadata?: {
2587
+ [key: string]: unknown;
2588
+ } | undefined;
2589
+ }) | ({
2590
+ type: "builtin";
2591
+ value: string;
2592
+ } & {} & {
2593
+ commandType?: "object" | "help" | "independent" | undefined;
2594
+ object?: string | undefined;
2595
+ hoverTooltip?: boolean | undefined;
2596
+ operation?: "self" | "router" | "blank" | "help_hub" | undefined;
2597
+ metadata?: {
2598
+ [key: string]: unknown;
2599
+ } | undefined;
2600
+ }) | ({
2601
+ type: "webhook";
2602
+ value: string;
2603
+ } & {} & {
2604
+ commandType?: "object" | "help" | "independent" | undefined;
2605
+ object?: string | undefined;
2606
+ hoverTooltip?: boolean | undefined;
2607
+ operation?: "self" | "router" | "blank" | "help_hub" | undefined;
2608
+ metadata?: {
2609
+ [key: string]: unknown;
2610
+ } | undefined;
2611
+ }) | ({
2612
+ type: "script";
2613
+ value: string;
2614
+ } & {} & {
2615
+ commandType?: "object" | "help" | "independent" | undefined;
2616
+ object?: string | undefined;
2617
+ hoverTooltip?: boolean | undefined;
2618
+ operation?: "self" | "router" | "blank" | "help_hub" | undefined;
2619
+ metadata?: {
2620
+ [key: string]: unknown;
2621
+ } | undefined;
2622
+ }) | ({
2623
+ type: "request";
2624
+ value: {
2625
+ method: "head" | "options" | "get" | "post" | "put" | "delete" | "patch";
2626
+ url: string;
2627
+ } & {
2628
+ headers?: {
2629
+ [key: string]: unknown;
2630
+ } | undefined;
2631
+ body?: {
2632
+ [key: string]: unknown;
2633
+ } | undefined;
2634
+ onSend?: string | undefined;
2635
+ onSuccess?: string | undefined;
2636
+ onError?: string | undefined;
2637
+ };
2638
+ } & {} & {
2639
+ commandType?: "object" | "help" | "independent" | undefined;
2640
+ object?: string | undefined;
2641
+ hoverTooltip?: boolean | undefined;
2642
+ operation?: "self" | "router" | "blank" | "help_hub" | undefined;
2643
+ metadata?: {
2644
+ [key: string]: unknown;
2645
+ } | undefined;
2646
+ }) | ({
2647
+ type: "appcues";
2648
+ value: string;
2649
+ } & {} & {
2650
+ commandType?: "object" | "help" | "independent" | undefined;
2651
+ object?: string | undefined;
2652
+ hoverTooltip?: boolean | undefined;
2653
+ operation?: "self" | "router" | "blank" | "help_hub" | undefined;
2654
+ metadata?: {
2655
+ [key: string]: unknown;
2656
+ } | undefined;
2657
+ }) | ({
2658
+ type: "pendo_guide";
2659
+ value: string;
2660
+ } & {} & {
2661
+ commandType?: "object" | "help" | "independent" | undefined;
2662
+ object?: string | undefined;
2663
+ hoverTooltip?: boolean | undefined;
2664
+ operation?: "self" | "router" | "blank" | "help_hub" | undefined;
2665
+ metadata?: {
2666
+ [key: string]: unknown;
2667
+ } | undefined;
2668
+ }) | ({
2669
+ type: "video";
2670
+ value: string;
2671
+ } & {} & {
2672
+ commandType?: "object" | "help" | "independent" | undefined;
2673
+ object?: string | undefined;
2674
+ hoverTooltip?: boolean | undefined;
2675
+ operation?: "self" | "router" | "blank" | "help_hub" | undefined;
2676
+ metadata?: {
2677
+ [key: string]: unknown;
2678
+ } | undefined;
2679
+ }) | ({
2680
+ type: "helpdoc";
2681
+ value: string;
2682
+ } & {
2683
+ operation?: "self" | "router" | "blank" | "help_hub" | undefined;
2684
+ doc_metadata?: {
2685
+ content_type?: string | undefined;
2686
+ date?: string | undefined;
2687
+ } | undefined;
2688
+ } & {
2689
+ doc_type?: "answer" | "doc" | undefined;
2690
+ } & {} & {
2691
+ commandType?: "object" | "help" | "independent" | undefined;
2692
+ object?: string | undefined;
2693
+ hoverTooltip?: boolean | undefined;
2694
+ operation?: "self" | "router" | "blank" | "help_hub" | undefined;
2695
+ metadata?: {
2696
+ [key: string]: unknown;
2697
+ } | undefined;
2698
+ }) | ({
2699
+ type: "trigger";
2700
+ value: {
2701
+ type: "execute_command";
2702
+ meta: {
2703
+ command: string;
2704
+ } & {
2705
+ type?: "link" | "video" | "action" | "helpdoc" | undefined;
2706
+ };
2707
+ } | {
2708
+ type: "click";
2709
+ value: string;
2710
+ } | {
2711
+ type: "click" | "clickBySelector" | "clickByXpath";
2712
+ value: string[];
2713
+ } | ({
2714
+ type: "link";
2715
+ value: string;
2716
+ } & {
2717
+ operation?: "self" | "router" | "blank" | undefined;
2718
+ }) | {
2719
+ type: "open_chat";
2720
+ meta: {
2721
+ type: "" | "intercom" | "helpscout" | "freshdesk" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "hubspot" | "drift";
2722
+ };
2723
+ } | {
2724
+ type: "dismiss";
2725
+ } | {
2726
+ type: "snooze";
2727
+ } | {
2728
+ type: "questlist";
2729
+ value: number;
2730
+ } | {
2731
+ type: "step_back";
2732
+ } | {
2733
+ type: "nudge";
2734
+ value: number;
2735
+ } | {
2736
+ type: "go_to_step";
2737
+ value: number;
2738
+ } | ({
2739
+ type: "open_bar";
2740
+ } & {
2741
+ value?: string | undefined;
2742
+ categoryFilter?: number | undefined;
2743
+ }) | {
2744
+ type: "open_helphub";
2745
+ } | {
2746
+ type: "open_copilot";
2747
+ } | {
2748
+ type: "no_action";
2749
+ };
2750
+ } & {} & {
2751
+ commandType?: "object" | "help" | "independent" | undefined;
2752
+ object?: string | undefined;
2753
+ hoverTooltip?: boolean | undefined;
2754
+ operation?: "self" | "router" | "blank" | "help_hub" | undefined;
2755
+ metadata?: {
2756
+ [key: string]: unknown;
2757
+ } | undefined;
2758
+ });
2759
+ } & {
2760
+ disabledReason?: string | undefined;
2761
+ source?: string | undefined;
2762
+ name?: string | undefined;
2763
+ last_available?: string | null | undefined;
2764
+ modified?: string | undefined;
2765
+ isAsync?: boolean | undefined;
2766
+ } & {
2767
+ arguments: {
2768
+ [x: string]: ({
2769
+ type: "context";
2770
+ value: string;
2771
+ order_key: number;
2772
+ } & {
2773
+ label?: string | undefined;
2774
+ chosen?: string | number | undefined;
2775
+ selected?: any[] | undefined;
2776
+ input_type?: string | undefined;
2777
+ preselected_key?: string | undefined;
2778
+ label_field?: string | undefined;
2779
+ loaded?: any[] | undefined;
2780
+ allow_create?: boolean | undefined;
2781
+ allow_create_label?: string | undefined;
2782
+ show_in_record_action_list?: boolean | undefined;
2783
+ show_in_default_list?: boolean | undefined;
2784
+ auto_choose?: boolean | undefined;
2785
+ is_private?: boolean | undefined;
2786
+ }) | ({
2787
+ type: "set";
2788
+ value: string[] | number[] | {
2789
+ [key: string]: unknown;
2790
+ }[];
2791
+ order_key: number;
2792
+ } & {
2793
+ label?: string | undefined;
2794
+ chosen?: string | number | undefined;
2795
+ selected?: any[] | undefined;
2796
+ input_type?: string | undefined;
2797
+ preselected_key?: string | undefined;
2798
+ label_field?: string | undefined;
2799
+ loaded?: any[] | undefined;
2800
+ allow_create?: boolean | undefined;
2801
+ allow_create_label?: string | undefined;
2802
+ auto_choose?: boolean | undefined;
2803
+ is_private?: boolean | undefined;
2804
+ }) | ({
2805
+ type: "provided";
2806
+ value: "time" | "text";
2807
+ order_key: number;
2808
+ } & {
2809
+ label?: string | undefined;
2810
+ chosen?: string | number | undefined;
2811
+ selected?: any[] | undefined;
2812
+ input_type?: string | undefined;
2813
+ preselected_key?: string | undefined;
2814
+ label_field?: string | undefined;
2815
+ loaded?: any[] | undefined;
2816
+ dateTimeArgumentTypeId?: number | undefined;
2817
+ allow_create?: boolean | undefined;
2818
+ allow_create_label?: string | undefined;
2819
+ auto_choose?: boolean | undefined;
2820
+ is_private?: boolean | undefined;
2821
+ }) | ({
2822
+ type: "html" | "video";
2823
+ value: {
2824
+ source: string;
2825
+ } & {
2826
+ title?: string | undefined;
2827
+ description?: string | undefined;
2828
+ url?: string | undefined;
2829
+ };
2830
+ order_key: number;
2831
+ } & {
2832
+ label?: string | undefined;
2833
+ chosen?: string | number | undefined;
2834
+ selected?: any[] | undefined;
2835
+ input_type?: string | undefined;
2836
+ preselected_key?: string | undefined;
2837
+ label_field?: string | undefined;
2838
+ loaded?: any[] | undefined;
2839
+ allow_create?: boolean | undefined;
2840
+ allow_create_label?: string | undefined;
2841
+ is_private?: boolean | undefined;
2842
+ auto_choose?: boolean | undefined;
2843
+ });
2844
+ };
2845
+ tags: string[];
2846
+ availability_rules: (({
2847
+ type: "url" | "element" | "context" | "hubspot" | "device_type" | "sessions" | "survey_response" | "user_property" | "event_property" | "hostname" | "executions" | "shortcuts" | "last_seen" | "first_seen" | "opens" | "deadends" | "heap" | "ab_test" | "intent" | "help_doc_interaction" | "video_interaction";
2848
+ operator: "includes" | "endsWith" | "startsWith" | "is" | "isTrue" | "isFalse" | "isTruthy" | "isFalsy" | "matchesRegex" | "isDefined" | "isNotDefined" | "classnameOnPage" | "idOnPage" | "selectorOnPage" | "classnameNotOnPage" | "idNotOnPage" | "selectorNotOnPage" | "doesNotInclude" | "isNot" | "isGreaterThan" | "isLessThan";
2849
+ } & {
2850
+ field?: string | undefined;
2851
+ value?: string | undefined;
2852
+ reason?: string | undefined;
2853
+ rule_id?: string | number | undefined;
2854
+ }) | ({
2855
+ type: "nudge_interaction";
2856
+ operator: "is" | "isNot";
2857
+ value: "completed" | "dismissed" | "viewed";
2858
+ nudge_id: number;
2859
+ } & {
2860
+ reason?: string | undefined;
2861
+ }) | ({
2862
+ type: "questlist_interaction";
2863
+ operator: "is" | "isNot";
2864
+ value: "completed" | "dismissed" | "viewed";
2865
+ questlist_id: number;
2866
+ } & {
2867
+ reason?: string | undefined;
2868
+ }) | ({
2869
+ type: "browser" | "language" | "os";
2870
+ operator: "includes" | "doesNotInclude";
2871
+ values: string[];
2872
+ } & {
2873
+ reason?: string | undefined;
2874
+ }))[];
2875
+ recommend_rules: (({
2876
+ type: "url" | "element" | "context" | "hubspot" | "device_type" | "sessions" | "survey_response" | "user_property" | "event_property" | "hostname" | "executions" | "shortcuts" | "last_seen" | "first_seen" | "opens" | "deadends" | "heap" | "ab_test" | "intent" | "help_doc_interaction" | "video_interaction";
2877
+ operator: "includes" | "endsWith" | "startsWith" | "is" | "isTrue" | "isFalse" | "isTruthy" | "isFalsy" | "matchesRegex" | "isDefined" | "isNotDefined" | "classnameOnPage" | "idOnPage" | "selectorOnPage" | "classnameNotOnPage" | "idNotOnPage" | "selectorNotOnPage" | "doesNotInclude" | "isNot" | "isGreaterThan" | "isLessThan";
2878
+ } & {
2879
+ field?: string | undefined;
2880
+ value?: string | undefined;
2881
+ reason?: string | undefined;
2882
+ rule_id?: string | number | undefined;
2883
+ }) | ({
2884
+ type: "nudge_interaction";
2885
+ operator: "is" | "isNot";
2886
+ value: "completed" | "dismissed" | "viewed";
2887
+ nudge_id: number;
2888
+ } & {
2889
+ reason?: string | undefined;
2890
+ }) | ({
2891
+ type: "questlist_interaction";
2892
+ operator: "is" | "isNot";
2893
+ value: "completed" | "dismissed" | "viewed";
2894
+ questlist_id: number;
2895
+ } & {
2896
+ reason?: string | undefined;
2897
+ }) | ({
2898
+ type: "browser" | "language" | "os";
2899
+ operator: "includes" | "doesNotInclude";
2900
+ values: string[];
2901
+ } & {
2902
+ reason?: string | undefined;
2903
+ }) | ({
2904
+ type: "always";
2905
+ } & {
2906
+ operator?: null | undefined;
2907
+ field?: null | undefined;
2908
+ value?: null | undefined;
2909
+ reason?: null | undefined;
2910
+ rule_id?: string | number | undefined;
2911
+ }))[];
2912
+ availability_expression: import("./helpers/rules").RuleExpression | null;
2913
+ recommend_expression: import("./helpers/rules").RuleExpression | null;
2914
+ always_recommend: boolean;
2915
+ confirm: string;
2916
+ shortcut: string[];
2917
+ explanation: string;
2918
+ heading: string;
2919
+ is_live: boolean;
2920
+ category: number | null;
2921
+ sort_key: number | null;
2922
+ icon: string | null;
2923
+ icon_color: string | null;
2924
+ image_color: string | null;
2925
+ image: string | null;
2926
+ celebrate: boolean | {
2927
+ angle?: number | undefined;
2928
+ spread?: number | undefined;
2929
+ width?: string | undefined;
2930
+ height?: string | undefined;
2931
+ duration?: number | undefined;
2932
+ dragFriction?: number | undefined;
2933
+ stagger?: number | undefined;
2934
+ startVelocity?: number | undefined;
2935
+ elementCount?: number | undefined;
2936
+ decay?: number | undefined;
2937
+ colors?: string[] | undefined;
2938
+ random?: any;
2939
+ } | null;
2940
+ recommend_sort_key: number | null;
2941
+ shortcut_mac: string[];
2942
+ shortcut_win: string[];
2943
+ hotkey_mac: string;
2944
+ hotkey_win: string;
2945
+ detail: string | ({
2946
+ type: "html" | "video" | "plaintext" | "markdown" | "component" | "react";
2947
+ value: string;
2948
+ } & {
2949
+ position?: "inline" | "popover" | undefined;
2950
+ }) | (string | ({
2951
+ type: "html" | "video" | "plaintext" | "markdown" | "component" | "react";
2952
+ value: string;
2953
+ } & {
2954
+ position?: "inline" | "popover" | undefined;
2955
+ }))[] | null;
2956
+ content: string | ({
2957
+ type: "html" | "video" | "plaintext" | "markdown" | "component" | "react";
2958
+ value: string;
2959
+ } & {
2960
+ position?: "inline" | "popover" | undefined;
2961
+ }) | (string | ({
2962
+ type: "html" | "video" | "plaintext" | "markdown" | "component" | "react";
2963
+ value: string;
2964
+ } & {
2965
+ position?: "inline" | "popover" | undefined;
2966
+ }))[] | null;
2967
+ show_preview: boolean;
2968
+ next_steps: (string | number | {
2969
+ cta: string;
2970
+ action: {
2971
+ type: "execute_command";
2972
+ meta: {
2973
+ command: string;
2974
+ } & {
2975
+ type?: "link" | "video" | "action" | "helpdoc" | undefined;
2976
+ };
2977
+ } | {
2978
+ type: "click";
2979
+ value: string;
2980
+ } | {
2981
+ type: "click" | "clickBySelector" | "clickByXpath";
2982
+ value: string[];
2983
+ } | ({
2984
+ type: "link";
2985
+ value: string;
2986
+ } & {
2987
+ operation?: "self" | "router" | "blank" | undefined;
2988
+ }) | {
2989
+ type: "open_chat";
2990
+ meta: {
2991
+ type: "" | "intercom" | "helpscout" | "freshdesk" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "hubspot" | "drift";
2992
+ };
2993
+ } | {
2994
+ type: "dismiss";
2995
+ } | {
2996
+ type: "snooze";
2997
+ } | {
2998
+ type: "questlist";
2999
+ value: number;
3000
+ } | {
3001
+ type: "step_back";
3002
+ } | {
3003
+ type: "nudge";
3004
+ value: number;
3005
+ } | {
3006
+ type: "go_to_step";
3007
+ value: number;
3008
+ } | ({
3009
+ type: "open_bar";
3010
+ } & {
3011
+ value?: string | undefined;
3012
+ categoryFilter?: number | undefined;
3013
+ }) | {
3014
+ type: "open_helphub";
3015
+ } | {
3016
+ type: "open_copilot";
3017
+ } | {
3018
+ type: "no_action";
3019
+ };
3020
+ })[];
3021
+ extra: string | null;
3022
+ thumbnail: {
3023
+ src: string;
3024
+ file_name: string;
3025
+ size: string;
3026
+ } | null;
3027
+ copilot_suggest: boolean;
3028
+ show_in_spotlight_search: boolean;
3029
+ show_in_helphub_search: boolean;
3030
+ copilot_cta_label: string;
3031
+ copilot_description: string;
3032
+ } & {
3033
+ third_party_source?: string | null | undefined;
3034
+ third_party_id?: string | null | undefined;
3035
+ training_only?: boolean | undefined;
3036
+ integration?: {
3037
+ id: number;
3038
+ helphub_view_article_button_hidden: boolean | undefined;
3039
+ } | null | undefined;
3040
+ }, any>;
3041
+ excerpt: t.StringC;
3042
+ score: t.ArrayC<t.NumberC>;
3043
+ }>, t.TypeC<{
3044
+ type: t.UnionC<[t.LiteralC<"nudge">, t.LiteralC<"checklist">]>;
3045
+ experience_id: t.NumberC;
3046
+ experience: t.UndefinedC;
3047
+ excerpt: t.StringC;
3048
+ score: t.ArrayC<t.NumberC>;
3049
+ }>]>;
3050
+ }>>;
3051
+ }>;
3052
+ export declare const SearchExperiencesPayloadV: t.PartialC<{
3053
+ query: t.StringC;
3054
+ widget: t.UnionC<[t.LiteralC<"helphub">, t.LiteralC<"spotlight">]>;
3055
+ experience_types: t.StringC;
3056
+ max_results: t.UnionC<[t.NumberC, t.UndefinedC]>;
3057
+ filter: t.UnionC<[t.PartialC<{
3058
+ labels: t.ArrayC<t.StringC>;
3059
+ }>, t.NullC]>;
3060
+ }>;
3061
+ export declare class ExperiencesSearch {
3062
+ static search: (orgUID: IOrganizationType['id'], payload: ISearchExperiencesPayloadType, options?: axiosInstance.FetchOptions) => Promise<{
3063
+ data: {
3064
+ hit: {
3065
+ type: "page" | "video" | "action" | "helpdoc";
3066
+ experience_id: number;
3067
+ experience: {
3068
+ id: number;
3069
+ text: string;
3070
+ template: ({
3071
+ type: "admin";
3072
+ value: string;
3073
+ } & {} & {
3074
+ commandType?: "object" | "help" | "independent" | undefined;
3075
+ object?: string | undefined;
3076
+ hoverTooltip?: boolean | undefined;
3077
+ operation?: "self" | "router" | "blank" | "help_hub" | undefined;
3078
+ metadata?: {
3079
+ [key: string]: unknown;
3080
+ } | undefined;
3081
+ }) | ({
3082
+ type: "callback";
3083
+ value: string;
3084
+ } & {} & {
3085
+ commandType?: "object" | "help" | "independent" | undefined;
3086
+ object?: string | undefined;
3087
+ hoverTooltip?: boolean | undefined;
3088
+ operation?: "self" | "router" | "blank" | "help_hub" | undefined;
3089
+ metadata?: {
3090
+ [key: string]: unknown;
3091
+ } | undefined;
3092
+ }) | ({
3093
+ type: "link";
3094
+ value: string;
3095
+ } & {
3096
+ operation?: "self" | "router" | "blank" | undefined;
3097
+ } & {} & {
3098
+ commandType?: "object" | "help" | "independent" | undefined;
3099
+ object?: string | undefined;
3100
+ hoverTooltip?: boolean | undefined;
3101
+ operation?: "self" | "router" | "blank" | "help_hub" | undefined;
3102
+ metadata?: {
3103
+ [key: string]: unknown;
3104
+ } | undefined;
3105
+ }) | ({
3106
+ type: "click" | "clickBySelector" | "clickByXpath";
3107
+ value: string[];
3108
+ } & {} & {
3109
+ commandType?: "object" | "help" | "independent" | undefined;
3110
+ object?: string | undefined;
3111
+ hoverTooltip?: boolean | undefined;
3112
+ operation?: "self" | "router" | "blank" | "help_hub" | undefined;
3113
+ metadata?: {
3114
+ [key: string]: unknown;
3115
+ } | undefined;
3116
+ }) | ({
3117
+ type: "builtin";
3118
+ value: string;
3119
+ } & {} & {
3120
+ commandType?: "object" | "help" | "independent" | undefined;
3121
+ object?: string | undefined;
3122
+ hoverTooltip?: boolean | undefined;
3123
+ operation?: "self" | "router" | "blank" | "help_hub" | undefined;
3124
+ metadata?: {
3125
+ [key: string]: unknown;
3126
+ } | undefined;
3127
+ }) | ({
3128
+ type: "webhook";
3129
+ value: string;
3130
+ } & {} & {
3131
+ commandType?: "object" | "help" | "independent" | undefined;
3132
+ object?: string | undefined;
3133
+ hoverTooltip?: boolean | undefined;
3134
+ operation?: "self" | "router" | "blank" | "help_hub" | undefined;
3135
+ metadata?: {
3136
+ [key: string]: unknown;
3137
+ } | undefined;
3138
+ }) | ({
3139
+ type: "script";
3140
+ value: string;
3141
+ } & {} & {
3142
+ commandType?: "object" | "help" | "independent" | undefined;
3143
+ object?: string | undefined;
3144
+ hoverTooltip?: boolean | undefined;
3145
+ operation?: "self" | "router" | "blank" | "help_hub" | undefined;
3146
+ metadata?: {
3147
+ [key: string]: unknown;
3148
+ } | undefined;
3149
+ }) | ({
3150
+ type: "request";
3151
+ value: {
3152
+ method: "head" | "options" | "get" | "post" | "put" | "delete" | "patch";
3153
+ url: string;
3154
+ } & {
3155
+ headers?: {
3156
+ [key: string]: unknown;
3157
+ } | undefined;
3158
+ body?: {
3159
+ [key: string]: unknown;
3160
+ } | undefined;
3161
+ onSend?: string | undefined;
3162
+ onSuccess?: string | undefined;
3163
+ onError?: string | undefined;
3164
+ };
3165
+ } & {} & {
3166
+ commandType?: "object" | "help" | "independent" | undefined;
3167
+ object?: string | undefined;
3168
+ hoverTooltip?: boolean | undefined;
3169
+ operation?: "self" | "router" | "blank" | "help_hub" | undefined;
3170
+ metadata?: {
3171
+ [key: string]: unknown;
3172
+ } | undefined;
3173
+ }) | ({
3174
+ type: "appcues";
3175
+ value: string;
3176
+ } & {} & {
3177
+ commandType?: "object" | "help" | "independent" | undefined;
3178
+ object?: string | undefined;
3179
+ hoverTooltip?: boolean | undefined;
3180
+ operation?: "self" | "router" | "blank" | "help_hub" | undefined;
3181
+ metadata?: {
3182
+ [key: string]: unknown;
3183
+ } | undefined;
3184
+ }) | ({
3185
+ type: "pendo_guide";
3186
+ value: string;
3187
+ } & {} & {
3188
+ commandType?: "object" | "help" | "independent" | undefined;
3189
+ object?: string | undefined;
3190
+ hoverTooltip?: boolean | undefined;
3191
+ operation?: "self" | "router" | "blank" | "help_hub" | undefined;
3192
+ metadata?: {
3193
+ [key: string]: unknown;
3194
+ } | undefined;
3195
+ }) | ({
3196
+ type: "video";
3197
+ value: string;
3198
+ } & {} & {
3199
+ commandType?: "object" | "help" | "independent" | undefined;
3200
+ object?: string | undefined;
3201
+ hoverTooltip?: boolean | undefined;
3202
+ operation?: "self" | "router" | "blank" | "help_hub" | undefined;
3203
+ metadata?: {
3204
+ [key: string]: unknown;
3205
+ } | undefined;
3206
+ }) | ({
3207
+ type: "helpdoc";
3208
+ value: string;
3209
+ } & {
3210
+ operation?: "self" | "router" | "blank" | "help_hub" | undefined;
3211
+ doc_metadata?: {
3212
+ content_type?: string | undefined;
3213
+ date?: string | undefined;
3214
+ } | undefined;
3215
+ } & {
3216
+ doc_type?: "answer" | "doc" | undefined;
3217
+ } & {} & {
3218
+ commandType?: "object" | "help" | "independent" | undefined;
3219
+ object?: string | undefined;
3220
+ hoverTooltip?: boolean | undefined;
3221
+ operation?: "self" | "router" | "blank" | "help_hub" | undefined;
3222
+ metadata?: {
3223
+ [key: string]: unknown;
3224
+ } | undefined;
3225
+ }) | ({
3226
+ type: "trigger";
3227
+ value: {
3228
+ type: "execute_command";
3229
+ meta: {
3230
+ command: string;
3231
+ } & {
3232
+ type?: "link" | "video" | "action" | "helpdoc" | undefined;
3233
+ };
3234
+ } | {
3235
+ type: "click";
3236
+ value: string;
3237
+ } | {
3238
+ type: "click" | "clickBySelector" | "clickByXpath";
3239
+ value: string[];
3240
+ } | ({
3241
+ type: "link";
3242
+ value: string;
3243
+ } & {
3244
+ operation?: "self" | "router" | "blank" | undefined;
3245
+ }) | {
3246
+ type: "open_chat";
3247
+ meta: {
3248
+ type: "" | "intercom" | "helpscout" | "freshdesk" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "hubspot" | "drift";
3249
+ };
3250
+ } | {
3251
+ type: "dismiss";
3252
+ } | {
3253
+ type: "snooze";
3254
+ } | {
3255
+ type: "questlist";
3256
+ value: number;
3257
+ } | {
3258
+ type: "step_back";
3259
+ } | {
3260
+ type: "nudge";
3261
+ value: number;
3262
+ } | {
3263
+ type: "go_to_step";
3264
+ value: number;
3265
+ } | ({
3266
+ type: "open_bar";
3267
+ } & {
3268
+ value?: string | undefined;
3269
+ categoryFilter?: number | undefined;
3270
+ }) | {
3271
+ type: "open_helphub";
3272
+ } | {
3273
+ type: "open_copilot";
3274
+ } | {
3275
+ type: "no_action";
3276
+ };
3277
+ } & {} & {
3278
+ commandType?: "object" | "help" | "independent" | undefined;
3279
+ object?: string | undefined;
3280
+ hoverTooltip?: boolean | undefined;
3281
+ operation?: "self" | "router" | "blank" | "help_hub" | undefined;
3282
+ metadata?: {
3283
+ [key: string]: unknown;
3284
+ } | undefined;
3285
+ });
3286
+ } & {
3287
+ disabledReason?: string | undefined;
3288
+ source?: string | undefined;
3289
+ name?: string | undefined;
3290
+ last_available?: string | null | undefined;
3291
+ modified?: string | undefined;
3292
+ isAsync?: boolean | undefined;
3293
+ } & {
3294
+ arguments: {
3295
+ [x: string]: ({
3296
+ type: "context";
3297
+ value: string;
3298
+ order_key: number;
3299
+ } & {
3300
+ label?: string | undefined;
3301
+ chosen?: string | number | undefined;
3302
+ selected?: any[] | undefined;
3303
+ input_type?: string | undefined;
3304
+ preselected_key?: string | undefined;
3305
+ label_field?: string | undefined;
3306
+ loaded?: any[] | undefined;
3307
+ allow_create?: boolean | undefined;
3308
+ allow_create_label?: string | undefined;
3309
+ show_in_record_action_list?: boolean | undefined;
3310
+ show_in_default_list?: boolean | undefined;
3311
+ auto_choose?: boolean | undefined;
3312
+ is_private?: boolean | undefined;
3313
+ }) | ({
3314
+ type: "set";
3315
+ value: string[] | number[] | {
3316
+ [key: string]: unknown;
3317
+ }[];
3318
+ order_key: number;
3319
+ } & {
3320
+ label?: string | undefined;
3321
+ chosen?: string | number | undefined;
3322
+ selected?: any[] | undefined;
3323
+ input_type?: string | undefined;
3324
+ preselected_key?: string | undefined;
3325
+ label_field?: string | undefined;
3326
+ loaded?: any[] | undefined;
3327
+ allow_create?: boolean | undefined;
3328
+ allow_create_label?: string | undefined;
3329
+ auto_choose?: boolean | undefined;
3330
+ is_private?: boolean | undefined;
3331
+ }) | ({
3332
+ type: "provided";
3333
+ value: "time" | "text";
3334
+ order_key: number;
3335
+ } & {
3336
+ label?: string | undefined;
3337
+ chosen?: string | number | undefined;
3338
+ selected?: any[] | undefined;
3339
+ input_type?: string | undefined;
3340
+ preselected_key?: string | undefined;
3341
+ label_field?: string | undefined;
3342
+ loaded?: any[] | undefined;
3343
+ dateTimeArgumentTypeId?: number | undefined;
3344
+ allow_create?: boolean | undefined;
3345
+ allow_create_label?: string | undefined;
3346
+ auto_choose?: boolean | undefined;
3347
+ is_private?: boolean | undefined;
3348
+ }) | ({
3349
+ type: "html" | "video";
3350
+ value: {
3351
+ source: string;
3352
+ } & {
3353
+ title?: string | undefined;
3354
+ description?: string | undefined;
3355
+ url?: string | undefined;
3356
+ };
3357
+ order_key: number;
3358
+ } & {
3359
+ label?: string | undefined;
3360
+ chosen?: string | number | undefined;
3361
+ selected?: any[] | undefined;
3362
+ input_type?: string | undefined;
3363
+ preselected_key?: string | undefined;
3364
+ label_field?: string | undefined;
3365
+ loaded?: any[] | undefined;
3366
+ allow_create?: boolean | undefined;
3367
+ allow_create_label?: string | undefined;
3368
+ is_private?: boolean | undefined;
3369
+ auto_choose?: boolean | undefined;
3370
+ });
3371
+ };
3372
+ tags: string[];
3373
+ availability_rules: (({
3374
+ type: "url" | "element" | "context" | "hubspot" | "device_type" | "sessions" | "survey_response" | "user_property" | "event_property" | "hostname" | "executions" | "shortcuts" | "last_seen" | "first_seen" | "opens" | "deadends" | "heap" | "ab_test" | "intent" | "help_doc_interaction" | "video_interaction";
3375
+ operator: "includes" | "endsWith" | "startsWith" | "is" | "isTrue" | "isFalse" | "isTruthy" | "isFalsy" | "matchesRegex" | "isDefined" | "isNotDefined" | "classnameOnPage" | "idOnPage" | "selectorOnPage" | "classnameNotOnPage" | "idNotOnPage" | "selectorNotOnPage" | "doesNotInclude" | "isNot" | "isGreaterThan" | "isLessThan";
3376
+ } & {
3377
+ field?: string | undefined;
3378
+ value?: string | undefined;
3379
+ reason?: string | undefined;
3380
+ rule_id?: string | number | undefined;
3381
+ }) | ({
3382
+ type: "nudge_interaction";
3383
+ operator: "is" | "isNot";
3384
+ value: "completed" | "dismissed" | "viewed";
3385
+ nudge_id: number;
3386
+ } & {
3387
+ reason?: string | undefined;
3388
+ }) | ({
3389
+ type: "questlist_interaction";
3390
+ operator: "is" | "isNot";
3391
+ value: "completed" | "dismissed" | "viewed";
3392
+ questlist_id: number;
3393
+ } & {
3394
+ reason?: string | undefined;
3395
+ }) | ({
3396
+ type: "browser" | "language" | "os";
3397
+ operator: "includes" | "doesNotInclude";
3398
+ values: string[];
3399
+ } & {
3400
+ reason?: string | undefined;
3401
+ }))[];
3402
+ recommend_rules: (({
3403
+ type: "url" | "element" | "context" | "hubspot" | "device_type" | "sessions" | "survey_response" | "user_property" | "event_property" | "hostname" | "executions" | "shortcuts" | "last_seen" | "first_seen" | "opens" | "deadends" | "heap" | "ab_test" | "intent" | "help_doc_interaction" | "video_interaction";
3404
+ operator: "includes" | "endsWith" | "startsWith" | "is" | "isTrue" | "isFalse" | "isTruthy" | "isFalsy" | "matchesRegex" | "isDefined" | "isNotDefined" | "classnameOnPage" | "idOnPage" | "selectorOnPage" | "classnameNotOnPage" | "idNotOnPage" | "selectorNotOnPage" | "doesNotInclude" | "isNot" | "isGreaterThan" | "isLessThan";
3405
+ } & {
3406
+ field?: string | undefined;
3407
+ value?: string | undefined;
3408
+ reason?: string | undefined;
3409
+ rule_id?: string | number | undefined;
3410
+ }) | ({
3411
+ type: "nudge_interaction";
3412
+ operator: "is" | "isNot";
3413
+ value: "completed" | "dismissed" | "viewed";
3414
+ nudge_id: number;
3415
+ } & {
3416
+ reason?: string | undefined;
3417
+ }) | ({
3418
+ type: "questlist_interaction";
3419
+ operator: "is" | "isNot";
3420
+ value: "completed" | "dismissed" | "viewed";
3421
+ questlist_id: number;
3422
+ } & {
3423
+ reason?: string | undefined;
3424
+ }) | ({
3425
+ type: "browser" | "language" | "os";
3426
+ operator: "includes" | "doesNotInclude";
3427
+ values: string[];
3428
+ } & {
3429
+ reason?: string | undefined;
3430
+ }) | ({
3431
+ type: "always";
3432
+ } & {
3433
+ operator?: null | undefined;
3434
+ field?: null | undefined;
3435
+ value?: null | undefined;
3436
+ reason?: null | undefined;
3437
+ rule_id?: string | number | undefined;
3438
+ }))[];
3439
+ availability_expression: import("./helpers/rules").RuleExpression | null;
3440
+ recommend_expression: import("./helpers/rules").RuleExpression | null;
3441
+ always_recommend: boolean;
3442
+ confirm: string;
3443
+ shortcut: string[];
3444
+ explanation: string;
3445
+ heading: string;
3446
+ is_live: boolean;
3447
+ category: number | null;
3448
+ sort_key: number | null;
3449
+ icon: string | null;
3450
+ icon_color: string | null;
3451
+ image_color: string | null;
3452
+ image: string | null;
3453
+ celebrate: boolean | {
3454
+ angle?: number | undefined;
3455
+ spread?: number | undefined;
3456
+ width?: string | undefined;
3457
+ height?: string | undefined;
3458
+ duration?: number | undefined;
3459
+ dragFriction?: number | undefined;
3460
+ stagger?: number | undefined;
3461
+ startVelocity?: number | undefined;
3462
+ elementCount?: number | undefined;
3463
+ decay?: number | undefined;
3464
+ colors?: string[] | undefined;
3465
+ random?: any;
3466
+ } | null;
3467
+ recommend_sort_key: number | null;
3468
+ shortcut_mac: string[];
3469
+ shortcut_win: string[];
3470
+ hotkey_mac: string;
3471
+ hotkey_win: string;
3472
+ detail: string | ({
3473
+ type: "html" | "video" | "plaintext" | "markdown" | "component" | "react";
3474
+ value: string;
3475
+ } & {
3476
+ position?: "inline" | "popover" | undefined;
3477
+ }) | (string | ({
3478
+ type: "html" | "video" | "plaintext" | "markdown" | "component" | "react";
3479
+ value: string;
3480
+ } & {
3481
+ position?: "inline" | "popover" | undefined;
3482
+ }))[] | null;
3483
+ content: string | ({
3484
+ type: "html" | "video" | "plaintext" | "markdown" | "component" | "react";
3485
+ value: string;
3486
+ } & {
3487
+ position?: "inline" | "popover" | undefined;
3488
+ }) | (string | ({
3489
+ type: "html" | "video" | "plaintext" | "markdown" | "component" | "react";
3490
+ value: string;
3491
+ } & {
3492
+ position?: "inline" | "popover" | undefined;
3493
+ }))[] | null;
3494
+ show_preview: boolean;
3495
+ next_steps: (string | number | {
3496
+ cta: string;
3497
+ action: {
3498
+ type: "execute_command";
3499
+ meta: {
3500
+ command: string;
3501
+ } & {
3502
+ type?: "link" | "video" | "action" | "helpdoc" | undefined;
3503
+ };
3504
+ } | {
3505
+ type: "click";
3506
+ value: string;
3507
+ } | {
3508
+ type: "click" | "clickBySelector" | "clickByXpath";
3509
+ value: string[];
3510
+ } | ({
3511
+ type: "link";
3512
+ value: string;
3513
+ } & {
3514
+ operation?: "self" | "router" | "blank" | undefined;
3515
+ }) | {
3516
+ type: "open_chat";
3517
+ meta: {
3518
+ type: "" | "intercom" | "helpscout" | "freshdesk" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "hubspot" | "drift";
3519
+ };
3520
+ } | {
3521
+ type: "dismiss";
3522
+ } | {
3523
+ type: "snooze";
3524
+ } | {
3525
+ type: "questlist";
3526
+ value: number;
3527
+ } | {
3528
+ type: "step_back";
3529
+ } | {
3530
+ type: "nudge";
3531
+ value: number;
3532
+ } | {
3533
+ type: "go_to_step";
3534
+ value: number;
3535
+ } | ({
3536
+ type: "open_bar";
3537
+ } & {
3538
+ value?: string | undefined;
3539
+ categoryFilter?: number | undefined;
3540
+ }) | {
3541
+ type: "open_helphub";
3542
+ } | {
3543
+ type: "open_copilot";
3544
+ } | {
3545
+ type: "no_action";
3546
+ };
3547
+ })[];
3548
+ extra: string | null;
3549
+ thumbnail: {
3550
+ src: string;
3551
+ file_name: string;
3552
+ size: string;
3553
+ } | null;
3554
+ copilot_suggest: boolean;
3555
+ show_in_spotlight_search: boolean;
3556
+ show_in_helphub_search: boolean;
3557
+ copilot_cta_label: string;
3558
+ copilot_description: string;
3559
+ } & {
3560
+ third_party_source?: string | null | undefined;
3561
+ third_party_id?: string | null | undefined;
3562
+ training_only?: boolean | undefined;
3563
+ integration?: {
3564
+ id: number;
3565
+ helphub_view_article_button_hidden: boolean | undefined;
3566
+ } | null | undefined;
3567
+ };
3568
+ excerpt: string;
3569
+ score: number[];
3570
+ } | {
3571
+ type: "nudge" | "checklist";
3572
+ experience_id: number;
3573
+ experience: undefined;
3574
+ excerpt: string;
3575
+ score: number[];
3576
+ };
3577
+ }[];
3578
+ }>;
3579
+ }