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
package/build/internal/src/middleware/helpDocsSearch.d.ts CHANGED
@@ -17,6 +17,9 @@ export declare const HelpDocHitV: t.TypeC<{
17
17
  object?: string | undefined;
18
18
  hoverTooltip?: boolean | undefined;
19
19
  operation?: "self" | "router" | "blank" | "help_hub" | undefined;
20
+ metadata?: {
21
+ [key: string]: unknown;
22
+ } | undefined;
20
23
  }) | ({
21
24
  type: "callback";
22
25
  value: string;
@@ -25,6 +28,9 @@ export declare const HelpDocHitV: t.TypeC<{
25
28
  object?: string | undefined;
26
29
  hoverTooltip?: boolean | undefined;
27
30
  operation?: "self" | "router" | "blank" | "help_hub" | undefined;
31
+ metadata?: {
32
+ [key: string]: unknown;
33
+ } | undefined;
28
34
  }) | ({
29
35
  type: "link";
30
36
  value: string;
@@ -35,14 +41,20 @@ export declare const HelpDocHitV: t.TypeC<{
35
41
  object?: string | undefined;
36
42
  hoverTooltip?: boolean | undefined;
37
43
  operation?: "self" | "router" | "blank" | "help_hub" | undefined;
44
+ metadata?: {
45
+ [key: string]: unknown;
46
+ } | undefined;
38
47
  }) | ({
39
- type: "click" | "clickByXpath" | "clickBySelector";
48
+ type: "click" | "clickBySelector" | "clickByXpath";
40
49
  value: string[];
41
50
  } & {} & {
42
51
  commandType?: "object" | "help" | "independent" | undefined;
43
52
  object?: string | undefined;
44
53
  hoverTooltip?: boolean | undefined;
45
54
  operation?: "self" | "router" | "blank" | "help_hub" | undefined;
55
+ metadata?: {
56
+ [key: string]: unknown;
57
+ } | undefined;
46
58
  }) | ({
47
59
  type: "builtin";
48
60
  value: string;
@@ -51,6 +63,9 @@ export declare const HelpDocHitV: t.TypeC<{
51
63
  object?: string | undefined;
52
64
  hoverTooltip?: boolean | undefined;
53
65
  operation?: "self" | "router" | "blank" | "help_hub" | undefined;
66
+ metadata?: {
67
+ [key: string]: unknown;
68
+ } | undefined;
54
69
  }) | ({
55
70
  type: "webhook";
56
71
  value: string;
@@ -59,6 +74,9 @@ export declare const HelpDocHitV: t.TypeC<{
59
74
  object?: string | undefined;
60
75
  hoverTooltip?: boolean | undefined;
61
76
  operation?: "self" | "router" | "blank" | "help_hub" | undefined;
77
+ metadata?: {
78
+ [key: string]: unknown;
79
+ } | undefined;
62
80
  }) | ({
63
81
  type: "script";
64
82
  value: string;
@@ -67,6 +85,9 @@ export declare const HelpDocHitV: t.TypeC<{
67
85
  object?: string | undefined;
68
86
  hoverTooltip?: boolean | undefined;
69
87
  operation?: "self" | "router" | "blank" | "help_hub" | undefined;
88
+ metadata?: {
89
+ [key: string]: unknown;
90
+ } | undefined;
70
91
  }) | ({
71
92
  type: "request";
72
93
  value: {
@@ -88,6 +109,9 @@ export declare const HelpDocHitV: t.TypeC<{
88
109
  object?: string | undefined;
89
110
  hoverTooltip?: boolean | undefined;
90
111
  operation?: "self" | "router" | "blank" | "help_hub" | undefined;
112
+ metadata?: {
113
+ [key: string]: unknown;
114
+ } | undefined;
91
115
  }) | ({
92
116
  type: "appcues";
93
117
  value: string;
@@ -96,6 +120,20 @@ export declare const HelpDocHitV: t.TypeC<{
96
120
  object?: string | undefined;
97
121
  hoverTooltip?: boolean | undefined;
98
122
  operation?: "self" | "router" | "blank" | "help_hub" | undefined;
123
+ metadata?: {
124
+ [key: string]: unknown;
125
+ } | undefined;
126
+ }) | ({
127
+ type: "pendo_guide";
128
+ value: string;
129
+ } & {} & {
130
+ commandType?: "object" | "help" | "independent" | undefined;
131
+ object?: string | undefined;
132
+ hoverTooltip?: boolean | undefined;
133
+ operation?: "self" | "router" | "blank" | "help_hub" | undefined;
134
+ metadata?: {
135
+ [key: string]: unknown;
136
+ } | undefined;
99
137
  }) | ({
100
138
  type: "video";
101
139
  value: string;
@@ -104,6 +142,9 @@ export declare const HelpDocHitV: t.TypeC<{
104
142
  object?: string | undefined;
105
143
  hoverTooltip?: boolean | undefined;
106
144
  operation?: "self" | "router" | "blank" | "help_hub" | undefined;
145
+ metadata?: {
146
+ [key: string]: unknown;
147
+ } | undefined;
107
148
  }) | ({
108
149
  type: "helpdoc";
109
150
  value: string;
@@ -120,16 +161,24 @@ export declare const HelpDocHitV: t.TypeC<{
120
161
  object?: string | undefined;
121
162
  hoverTooltip?: boolean | undefined;
122
163
  operation?: "self" | "router" | "blank" | "help_hub" | undefined;
164
+ metadata?: {
165
+ [key: string]: unknown;
166
+ } | undefined;
123
167
  }) | ({
124
168
  type: "trigger";
125
169
  value: {
126
170
  type: "execute_command";
127
171
  meta: {
128
172
  command: string;
173
+ } & {
174
+ type?: "link" | "video" | "action" | "helpdoc" | undefined;
129
175
  };
130
176
  } | {
131
177
  type: "click";
132
178
  value: string;
179
+ } | {
180
+ type: "click" | "clickBySelector" | "clickByXpath";
181
+ value: string[];
133
182
  } | ({
134
183
  type: "link";
135
184
  value: string;
@@ -138,7 +187,7 @@ export declare const HelpDocHitV: t.TypeC<{
138
187
  }) | {
139
188
  type: "open_chat";
140
189
  meta: {
141
- type: string;
190
+ type: "" | "intercom" | "helpscout" | "freshdesk" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "hubspot" | "drift";
142
191
  };
143
192
  } | {
144
193
  type: "dismiss";
@@ -161,6 +210,10 @@ export declare const HelpDocHitV: t.TypeC<{
161
210
  value?: string | undefined;
162
211
  categoryFilter?: number | undefined;
163
212
  }) | {
213
+ type: "open_helphub";
214
+ } | {
215
+ type: "open_copilot";
216
+ } | {
164
217
  type: "no_action";
165
218
  };
166
219
  } & {} & {
@@ -168,6 +221,9 @@ export declare const HelpDocHitV: t.TypeC<{
168
221
  object?: string | undefined;
169
222
  hoverTooltip?: boolean | undefined;
170
223
  operation?: "self" | "router" | "blank" | "help_hub" | undefined;
224
+ metadata?: {
225
+ [key: string]: unknown;
226
+ } | undefined;
171
227
  });
172
228
  } & {
173
229
  disabledReason?: string | undefined;
@@ -257,8 +313,8 @@ export declare const HelpDocHitV: t.TypeC<{
257
313
  };
258
314
  tags: string[];
259
315
  availability_rules: (({
260
- type: "url" | "element" | "context" | "device_type" | "sessions" | "hostname" | "executions" | "shortcuts" | "last_seen" | "first_seen" | "opens" | "deadends" | "heap" | "hubspot";
261
- operator: "includes" | "endsWith" | "startsWith" | "is" | "isTrue" | "isFalse" | "isTruthy" | "isFalsy" | "matchesRegex" | "isGreaterThan" | "isLessThan" | "isBefore" | "isAfter" | "isDefined" | "isNotDefined" | "classnameOnPage" | "idOnPage" | "selectorOnPage" | "classnameNotOnPage" | "idNotOnPage" | "selectorNotOnPage" | "doesNotInclude" | "isNot";
316
+ 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";
317
+ operator: "includes" | "endsWith" | "startsWith" | "is" | "isTrue" | "isFalse" | "isTruthy" | "isFalsy" | "matchesRegex" | "isDefined" | "isNotDefined" | "classnameOnPage" | "idOnPage" | "selectorOnPage" | "classnameNotOnPage" | "idNotOnPage" | "selectorNotOnPage" | "doesNotInclude" | "isNot" | "isGreaterThan" | "isLessThan";
262
318
  } & {
263
319
  field?: string | undefined;
264
320
  value?: string | undefined;
@@ -286,8 +342,8 @@ export declare const HelpDocHitV: t.TypeC<{
286
342
  reason?: string | undefined;
287
343
  }))[];
288
344
  recommend_rules: (({
289
- type: "url" | "element" | "context" | "device_type" | "sessions" | "hostname" | "executions" | "shortcuts" | "last_seen" | "first_seen" | "opens" | "deadends" | "heap" | "hubspot";
290
- operator: "includes" | "endsWith" | "startsWith" | "is" | "isTrue" | "isFalse" | "isTruthy" | "isFalsy" | "matchesRegex" | "isGreaterThan" | "isLessThan" | "isBefore" | "isAfter" | "isDefined" | "isNotDefined" | "classnameOnPage" | "idOnPage" | "selectorOnPage" | "classnameNotOnPage" | "idNotOnPage" | "selectorNotOnPage" | "doesNotInclude" | "isNot";
345
+ 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";
346
+ operator: "includes" | "endsWith" | "startsWith" | "is" | "isTrue" | "isFalse" | "isTruthy" | "isFalsy" | "matchesRegex" | "isDefined" | "isNotDefined" | "classnameOnPage" | "idOnPage" | "selectorOnPage" | "classnameNotOnPage" | "idNotOnPage" | "selectorNotOnPage" | "doesNotInclude" | "isNot" | "isGreaterThan" | "isLessThan";
291
347
  } & {
292
348
  field?: string | undefined;
293
349
  value?: string | undefined;
@@ -384,10 +440,15 @@ export declare const HelpDocHitV: t.TypeC<{
384
440
  type: "execute_command";
385
441
  meta: {
386
442
  command: string;
443
+ } & {
444
+ type?: "link" | "video" | "action" | "helpdoc" | undefined;
387
445
  };
388
446
  } | {
389
447
  type: "click";
390
448
  value: string;
449
+ } | {
450
+ type: "click" | "clickBySelector" | "clickByXpath";
451
+ value: string[];
391
452
  } | ({
392
453
  type: "link";
393
454
  value: string;
@@ -396,7 +457,7 @@ export declare const HelpDocHitV: t.TypeC<{
396
457
  }) | {
397
458
  type: "open_chat";
398
459
  meta: {
399
- type: string;
460
+ type: "" | "intercom" | "helpscout" | "freshdesk" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "hubspot" | "drift";
400
461
  };
401
462
  } | {
402
463
  type: "dismiss";
@@ -419,6 +480,10 @@ export declare const HelpDocHitV: t.TypeC<{
419
480
  value?: string | undefined;
420
481
  categoryFilter?: number | undefined;
421
482
  }) | {
483
+ type: "open_helphub";
484
+ } | {
485
+ type: "open_copilot";
486
+ } | {
422
487
  type: "no_action";
423
488
  };
424
489
  })[];
@@ -429,6 +494,8 @@ export declare const HelpDocHitV: t.TypeC<{
429
494
  size: string;
430
495
  } | null;
431
496
  copilot_suggest: boolean;
497
+ show_in_spotlight_search: boolean;
498
+ show_in_helphub_search: boolean;
432
499
  copilot_cta_label: string;
433
500
  copilot_description: string;
434
501
  } & {
@@ -450,6 +517,9 @@ export declare const HelpDocHitV: t.TypeC<{
450
517
  object?: string | undefined;
451
518
  hoverTooltip?: boolean | undefined;
452
519
  operation?: "self" | "router" | "blank" | "help_hub" | undefined;
520
+ metadata?: {
521
+ [key: string]: unknown;
522
+ } | undefined;
453
523
  }) | ({
454
524
  type: "callback";
455
525
  value: string;
@@ -458,6 +528,9 @@ export declare const HelpDocHitV: t.TypeC<{
458
528
  object?: string | undefined;
459
529
  hoverTooltip?: boolean | undefined;
460
530
  operation?: "self" | "router" | "blank" | "help_hub" | undefined;
531
+ metadata?: {
532
+ [key: string]: unknown;
533
+ } | undefined;
461
534
  }) | ({
462
535
  type: "link";
463
536
  value: string;
@@ -468,14 +541,20 @@ export declare const HelpDocHitV: t.TypeC<{
468
541
  object?: string | undefined;
469
542
  hoverTooltip?: boolean | undefined;
470
543
  operation?: "self" | "router" | "blank" | "help_hub" | undefined;
544
+ metadata?: {
545
+ [key: string]: unknown;
546
+ } | undefined;
471
547
  }) | ({
472
- type: "click" | "clickByXpath" | "clickBySelector";
548
+ type: "click" | "clickBySelector" | "clickByXpath";
473
549
  value: string[];
474
550
  } & {} & {
475
551
  commandType?: "object" | "help" | "independent" | undefined;
476
552
  object?: string | undefined;
477
553
  hoverTooltip?: boolean | undefined;
478
554
  operation?: "self" | "router" | "blank" | "help_hub" | undefined;
555
+ metadata?: {
556
+ [key: string]: unknown;
557
+ } | undefined;
479
558
  }) | ({
480
559
  type: "builtin";
481
560
  value: string;
@@ -484,6 +563,9 @@ export declare const HelpDocHitV: t.TypeC<{
484
563
  object?: string | undefined;
485
564
  hoverTooltip?: boolean | undefined;
486
565
  operation?: "self" | "router" | "blank" | "help_hub" | undefined;
566
+ metadata?: {
567
+ [key: string]: unknown;
568
+ } | undefined;
487
569
  }) | ({
488
570
  type: "webhook";
489
571
  value: string;
@@ -492,6 +574,9 @@ export declare const HelpDocHitV: t.TypeC<{
492
574
  object?: string | undefined;
493
575
  hoverTooltip?: boolean | undefined;
494
576
  operation?: "self" | "router" | "blank" | "help_hub" | undefined;
577
+ metadata?: {
578
+ [key: string]: unknown;
579
+ } | undefined;
495
580
  }) | ({
496
581
  type: "script";
497
582
  value: string;
@@ -500,6 +585,9 @@ export declare const HelpDocHitV: t.TypeC<{
500
585
  object?: string | undefined;
501
586
  hoverTooltip?: boolean | undefined;
502
587
  operation?: "self" | "router" | "blank" | "help_hub" | undefined;
588
+ metadata?: {
589
+ [key: string]: unknown;
590
+ } | undefined;
503
591
  }) | ({
504
592
  type: "request";
505
593
  value: {
@@ -521,6 +609,9 @@ export declare const HelpDocHitV: t.TypeC<{
521
609
  object?: string | undefined;
522
610
  hoverTooltip?: boolean | undefined;
523
611
  operation?: "self" | "router" | "blank" | "help_hub" | undefined;
612
+ metadata?: {
613
+ [key: string]: unknown;
614
+ } | undefined;
524
615
  }) | ({
525
616
  type: "appcues";
526
617
  value: string;
@@ -529,6 +620,20 @@ export declare const HelpDocHitV: t.TypeC<{
529
620
  object?: string | undefined;
530
621
  hoverTooltip?: boolean | undefined;
531
622
  operation?: "self" | "router" | "blank" | "help_hub" | undefined;
623
+ metadata?: {
624
+ [key: string]: unknown;
625
+ } | undefined;
626
+ }) | ({
627
+ type: "pendo_guide";
628
+ value: string;
629
+ } & {} & {
630
+ commandType?: "object" | "help" | "independent" | undefined;
631
+ object?: string | undefined;
632
+ hoverTooltip?: boolean | undefined;
633
+ operation?: "self" | "router" | "blank" | "help_hub" | undefined;
634
+ metadata?: {
635
+ [key: string]: unknown;
636
+ } | undefined;
532
637
  }) | ({
533
638
  type: "video";
534
639
  value: string;
@@ -537,6 +642,9 @@ export declare const HelpDocHitV: t.TypeC<{
537
642
  object?: string | undefined;
538
643
  hoverTooltip?: boolean | undefined;
539
644
  operation?: "self" | "router" | "blank" | "help_hub" | undefined;
645
+ metadata?: {
646
+ [key: string]: unknown;
647
+ } | undefined;
540
648
  }) | ({
541
649
  type: "helpdoc";
542
650
  value: string;
@@ -553,16 +661,24 @@ export declare const HelpDocHitV: t.TypeC<{
553
661
  object?: string | undefined;
554
662
  hoverTooltip?: boolean | undefined;
555
663
  operation?: "self" | "router" | "blank" | "help_hub" | undefined;
664
+ metadata?: {
665
+ [key: string]: unknown;
666
+ } | undefined;
556
667
  }) | ({
557
668
  type: "trigger";
558
669
  value: {
559
670
  type: "execute_command";
560
671
  meta: {
561
672
  command: string;
673
+ } & {
674
+ type?: "link" | "video" | "action" | "helpdoc" | undefined;
562
675
  };
563
676
  } | {
564
677
  type: "click";
565
678
  value: string;
679
+ } | {
680
+ type: "click" | "clickBySelector" | "clickByXpath";
681
+ value: string[];
566
682
  } | ({
567
683
  type: "link";
568
684
  value: string;
@@ -571,7 +687,7 @@ export declare const HelpDocHitV: t.TypeC<{
571
687
  }) | {
572
688
  type: "open_chat";
573
689
  meta: {
574
- type: string;
690
+ type: "" | "intercom" | "helpscout" | "freshdesk" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "hubspot" | "drift";
575
691
  };
576
692
  } | {
577
693
  type: "dismiss";
@@ -594,6 +710,10 @@ export declare const HelpDocHitV: t.TypeC<{
594
710
  value?: string | undefined;
595
711
  categoryFilter?: number | undefined;
596
712
  }) | {
713
+ type: "open_helphub";
714
+ } | {
715
+ type: "open_copilot";
716
+ } | {
597
717
  type: "no_action";
598
718
  };
599
719
  } & {} & {
@@ -601,6 +721,9 @@ export declare const HelpDocHitV: t.TypeC<{
601
721
  object?: string | undefined;
602
722
  hoverTooltip?: boolean | undefined;
603
723
  operation?: "self" | "router" | "blank" | "help_hub" | undefined;
724
+ metadata?: {
725
+ [key: string]: unknown;
726
+ } | undefined;
604
727
  });
605
728
  } & {
606
729
  disabledReason?: string | undefined;
@@ -690,8 +813,8 @@ export declare const HelpDocHitV: t.TypeC<{
690
813
  };
691
814
  tags: string[];
692
815
  availability_rules: (({
693
- type: "url" | "element" | "context" | "device_type" | "sessions" | "hostname" | "executions" | "shortcuts" | "last_seen" | "first_seen" | "opens" | "deadends" | "heap" | "hubspot";
694
- operator: "includes" | "endsWith" | "startsWith" | "is" | "isTrue" | "isFalse" | "isTruthy" | "isFalsy" | "matchesRegex" | "isGreaterThan" | "isLessThan" | "isBefore" | "isAfter" | "isDefined" | "isNotDefined" | "classnameOnPage" | "idOnPage" | "selectorOnPage" | "classnameNotOnPage" | "idNotOnPage" | "selectorNotOnPage" | "doesNotInclude" | "isNot";
816
+ 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";
817
+ operator: "includes" | "endsWith" | "startsWith" | "is" | "isTrue" | "isFalse" | "isTruthy" | "isFalsy" | "matchesRegex" | "isDefined" | "isNotDefined" | "classnameOnPage" | "idOnPage" | "selectorOnPage" | "classnameNotOnPage" | "idNotOnPage" | "selectorNotOnPage" | "doesNotInclude" | "isNot" | "isGreaterThan" | "isLessThan";
695
818
  } & {
696
819
  field?: string | undefined;
697
820
  value?: string | undefined;
@@ -719,8 +842,8 @@ export declare const HelpDocHitV: t.TypeC<{
719
842
  reason?: string | undefined;
720
843
  }))[];
721
844
  recommend_rules: (({
722
- type: "url" | "element" | "context" | "device_type" | "sessions" | "hostname" | "executions" | "shortcuts" | "last_seen" | "first_seen" | "opens" | "deadends" | "heap" | "hubspot";
723
- operator: "includes" | "endsWith" | "startsWith" | "is" | "isTrue" | "isFalse" | "isTruthy" | "isFalsy" | "matchesRegex" | "isGreaterThan" | "isLessThan" | "isBefore" | "isAfter" | "isDefined" | "isNotDefined" | "classnameOnPage" | "idOnPage" | "selectorOnPage" | "classnameNotOnPage" | "idNotOnPage" | "selectorNotOnPage" | "doesNotInclude" | "isNot";
845
+ 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";
846
+ operator: "includes" | "endsWith" | "startsWith" | "is" | "isTrue" | "isFalse" | "isTruthy" | "isFalsy" | "matchesRegex" | "isDefined" | "isNotDefined" | "classnameOnPage" | "idOnPage" | "selectorOnPage" | "classnameNotOnPage" | "idNotOnPage" | "selectorNotOnPage" | "doesNotInclude" | "isNot" | "isGreaterThan" | "isLessThan";
724
847
  } & {
725
848
  field?: string | undefined;
726
849
  value?: string | undefined;
@@ -817,10 +940,15 @@ export declare const HelpDocHitV: t.TypeC<{
817
940
  type: "execute_command";
818
941
  meta: {
819
942
  command: string;
943
+ } & {
944
+ type?: "link" | "video" | "action" | "helpdoc" | undefined;
820
945
  };
821
946
  } | {
822
947
  type: "click";
823
948
  value: string;
949
+ } | {
950
+ type: "click" | "clickBySelector" | "clickByXpath";
951
+ value: string[];
824
952
  } | ({
825
953
  type: "link";
826
954
  value: string;
@@ -829,7 +957,7 @@ export declare const HelpDocHitV: t.TypeC<{
829
957
  }) | {
830
958
  type: "open_chat";
831
959
  meta: {
832
- type: string;
960
+ type: "" | "intercom" | "helpscout" | "freshdesk" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "hubspot" | "drift";
833
961
  };
834
962
  } | {
835
963
  type: "dismiss";
@@ -852,6 +980,10 @@ export declare const HelpDocHitV: t.TypeC<{
852
980
  value?: string | undefined;
853
981
  categoryFilter?: number | undefined;
854
982
  }) | {
983
+ type: "open_helphub";
984
+ } | {
985
+ type: "open_copilot";
986
+ } | {
855
987
  type: "no_action";
856
988
  };
857
989
  })[];
@@ -862,6 +994,8 @@ export declare const HelpDocHitV: t.TypeC<{
862
994
  size: string;
863
995
  } | null;
864
996
  copilot_suggest: boolean;
997
+ show_in_spotlight_search: boolean;
998
+ show_in_helphub_search: boolean;
865
999
  copilot_cta_label: string;
866
1000
  copilot_description: string;
867
1001
  } & {
@@ -890,6 +1024,9 @@ export declare const SearchHelpDocsResponseV: t.TypeC<{
890
1024
  object?: string | undefined;
891
1025
  hoverTooltip?: boolean | undefined;
892
1026
  operation?: "self" | "router" | "blank" | "help_hub" | undefined;
1027
+ metadata?: {
1028
+ [key: string]: unknown;
1029
+ } | undefined;
893
1030
  }) | ({
894
1031
  type: "callback";
895
1032
  value: string;
@@ -898,6 +1035,9 @@ export declare const SearchHelpDocsResponseV: t.TypeC<{
898
1035
  object?: string | undefined;
899
1036
  hoverTooltip?: boolean | undefined;
900
1037
  operation?: "self" | "router" | "blank" | "help_hub" | undefined;
1038
+ metadata?: {
1039
+ [key: string]: unknown;
1040
+ } | undefined;
901
1041
  }) | ({
902
1042
  type: "link";
903
1043
  value: string;
@@ -908,14 +1048,20 @@ export declare const SearchHelpDocsResponseV: t.TypeC<{
908
1048
  object?: string | undefined;
909
1049
  hoverTooltip?: boolean | undefined;
910
1050
  operation?: "self" | "router" | "blank" | "help_hub" | undefined;
1051
+ metadata?: {
1052
+ [key: string]: unknown;
1053
+ } | undefined;
911
1054
  }) | ({
912
- type: "click" | "clickByXpath" | "clickBySelector";
1055
+ type: "click" | "clickBySelector" | "clickByXpath";
913
1056
  value: string[];
914
1057
  } & {} & {
915
1058
  commandType?: "object" | "help" | "independent" | undefined;
916
1059
  object?: string | undefined;
917
1060
  hoverTooltip?: boolean | undefined;
918
1061
  operation?: "self" | "router" | "blank" | "help_hub" | undefined;
1062
+ metadata?: {
1063
+ [key: string]: unknown;
1064
+ } | undefined;
919
1065
  }) | ({
920
1066
  type: "builtin";
921
1067
  value: string;
@@ -924,6 +1070,9 @@ export declare const SearchHelpDocsResponseV: t.TypeC<{
924
1070
  object?: string | undefined;
925
1071
  hoverTooltip?: boolean | undefined;
926
1072
  operation?: "self" | "router" | "blank" | "help_hub" | undefined;
1073
+ metadata?: {
1074
+ [key: string]: unknown;
1075
+ } | undefined;
927
1076
  }) | ({
928
1077
  type: "webhook";
929
1078
  value: string;
@@ -932,6 +1081,9 @@ export declare const SearchHelpDocsResponseV: t.TypeC<{
932
1081
  object?: string | undefined;
933
1082
  hoverTooltip?: boolean | undefined;
934
1083
  operation?: "self" | "router" | "blank" | "help_hub" | undefined;
1084
+ metadata?: {
1085
+ [key: string]: unknown;
1086
+ } | undefined;
935
1087
  }) | ({
936
1088
  type: "script";
937
1089
  value: string;
@@ -940,6 +1092,9 @@ export declare const SearchHelpDocsResponseV: t.TypeC<{
940
1092
  object?: string | undefined;
941
1093
  hoverTooltip?: boolean | undefined;
942
1094
  operation?: "self" | "router" | "blank" | "help_hub" | undefined;
1095
+ metadata?: {
1096
+ [key: string]: unknown;
1097
+ } | undefined;
943
1098
  }) | ({
944
1099
  type: "request";
945
1100
  value: {
@@ -961,6 +1116,9 @@ export declare const SearchHelpDocsResponseV: t.TypeC<{
961
1116
  object?: string | undefined;
962
1117
  hoverTooltip?: boolean | undefined;
963
1118
  operation?: "self" | "router" | "blank" | "help_hub" | undefined;
1119
+ metadata?: {
1120
+ [key: string]: unknown;
1121
+ } | undefined;
964
1122
  }) | ({
965
1123
  type: "appcues";
966
1124
  value: string;
@@ -969,6 +1127,20 @@ export declare const SearchHelpDocsResponseV: t.TypeC<{
969
1127
  object?: string | undefined;
970
1128
  hoverTooltip?: boolean | undefined;
971
1129
  operation?: "self" | "router" | "blank" | "help_hub" | undefined;
1130
+ metadata?: {
1131
+ [key: string]: unknown;
1132
+ } | undefined;
1133
+ }) | ({
1134
+ type: "pendo_guide";
1135
+ value: string;
1136
+ } & {} & {
1137
+ commandType?: "object" | "help" | "independent" | undefined;
1138
+ object?: string | undefined;
1139
+ hoverTooltip?: boolean | undefined;
1140
+ operation?: "self" | "router" | "blank" | "help_hub" | undefined;
1141
+ metadata?: {
1142
+ [key: string]: unknown;
1143
+ } | undefined;
972
1144
  }) | ({
973
1145
  type: "video";
974
1146
  value: string;
@@ -977,6 +1149,9 @@ export declare const SearchHelpDocsResponseV: t.TypeC<{
977
1149
  object?: string | undefined;
978
1150
  hoverTooltip?: boolean | undefined;
979
1151
  operation?: "self" | "router" | "blank" | "help_hub" | undefined;
1152
+ metadata?: {
1153
+ [key: string]: unknown;
1154
+ } | undefined;
980
1155
  }) | ({
981
1156
  type: "helpdoc";
982
1157
  value: string;
@@ -993,16 +1168,24 @@ export declare const SearchHelpDocsResponseV: t.TypeC<{
993
1168
  object?: string | undefined;
994
1169
  hoverTooltip?: boolean | undefined;
995
1170
  operation?: "self" | "router" | "blank" | "help_hub" | undefined;
1171
+ metadata?: {
1172
+ [key: string]: unknown;
1173
+ } | undefined;
996
1174
  }) | ({
997
1175
  type: "trigger";
998
1176
  value: {
999
1177
  type: "execute_command";
1000
1178
  meta: {
1001
1179
  command: string;
1180
+ } & {
1181
+ type?: "link" | "video" | "action" | "helpdoc" | undefined;
1002
1182
  };
1003
1183
  } | {
1004
1184
  type: "click";
1005
1185
  value: string;
1186
+ } | {
1187
+ type: "click" | "clickBySelector" | "clickByXpath";
1188
+ value: string[];
1006
1189
  } | ({
1007
1190
  type: "link";
1008
1191
  value: string;
@@ -1011,7 +1194,7 @@ export declare const SearchHelpDocsResponseV: t.TypeC<{
1011
1194
  }) | {
1012
1195
  type: "open_chat";
1013
1196
  meta: {
1014
- type: string;
1197
+ type: "" | "intercom" | "helpscout" | "freshdesk" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "hubspot" | "drift";
1015
1198
  };
1016
1199
  } | {
1017
1200
  type: "dismiss";
@@ -1034,6 +1217,10 @@ export declare const SearchHelpDocsResponseV: t.TypeC<{
1034
1217
  value?: string | undefined;
1035
1218
  categoryFilter?: number | undefined;
1036
1219
  }) | {
1220
+ type: "open_helphub";
1221
+ } | {
1222
+ type: "open_copilot";
1223
+ } | {
1037
1224
  type: "no_action";
1038
1225
  };
1039
1226
  } & {} & {
@@ -1041,6 +1228,9 @@ export declare const SearchHelpDocsResponseV: t.TypeC<{
1041
1228
  object?: string | undefined;
1042
1229
  hoverTooltip?: boolean | undefined;
1043
1230
  operation?: "self" | "router" | "blank" | "help_hub" | undefined;
1231
+ metadata?: {
1232
+ [key: string]: unknown;
1233
+ } | undefined;
1044
1234
  });
1045
1235
  } & {
1046
1236
  disabledReason?: string | undefined;
@@ -1130,8 +1320,8 @@ export declare const SearchHelpDocsResponseV: t.TypeC<{
1130
1320
  };
1131
1321
  tags: string[];
1132
1322
  availability_rules: (({
1133
- type: "url" | "element" | "context" | "device_type" | "sessions" | "hostname" | "executions" | "shortcuts" | "last_seen" | "first_seen" | "opens" | "deadends" | "heap" | "hubspot";
1134
- operator: "includes" | "endsWith" | "startsWith" | "is" | "isTrue" | "isFalse" | "isTruthy" | "isFalsy" | "matchesRegex" | "isGreaterThan" | "isLessThan" | "isBefore" | "isAfter" | "isDefined" | "isNotDefined" | "classnameOnPage" | "idOnPage" | "selectorOnPage" | "classnameNotOnPage" | "idNotOnPage" | "selectorNotOnPage" | "doesNotInclude" | "isNot";
1323
+ 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";
1324
+ operator: "includes" | "endsWith" | "startsWith" | "is" | "isTrue" | "isFalse" | "isTruthy" | "isFalsy" | "matchesRegex" | "isDefined" | "isNotDefined" | "classnameOnPage" | "idOnPage" | "selectorOnPage" | "classnameNotOnPage" | "idNotOnPage" | "selectorNotOnPage" | "doesNotInclude" | "isNot" | "isGreaterThan" | "isLessThan";
1135
1325
  } & {
1136
1326
  field?: string | undefined;
1137
1327
  value?: string | undefined;
@@ -1159,8 +1349,8 @@ export declare const SearchHelpDocsResponseV: t.TypeC<{
1159
1349
  reason?: string | undefined;
1160
1350
  }))[];
1161
1351
  recommend_rules: (({
1162
- type: "url" | "element" | "context" | "device_type" | "sessions" | "hostname" | "executions" | "shortcuts" | "last_seen" | "first_seen" | "opens" | "deadends" | "heap" | "hubspot";
1163
- operator: "includes" | "endsWith" | "startsWith" | "is" | "isTrue" | "isFalse" | "isTruthy" | "isFalsy" | "matchesRegex" | "isGreaterThan" | "isLessThan" | "isBefore" | "isAfter" | "isDefined" | "isNotDefined" | "classnameOnPage" | "idOnPage" | "selectorOnPage" | "classnameNotOnPage" | "idNotOnPage" | "selectorNotOnPage" | "doesNotInclude" | "isNot";
1352
+ 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";
1353
+ operator: "includes" | "endsWith" | "startsWith" | "is" | "isTrue" | "isFalse" | "isTruthy" | "isFalsy" | "matchesRegex" | "isDefined" | "isNotDefined" | "classnameOnPage" | "idOnPage" | "selectorOnPage" | "classnameNotOnPage" | "idNotOnPage" | "selectorNotOnPage" | "doesNotInclude" | "isNot" | "isGreaterThan" | "isLessThan";
1164
1354
  } & {
1165
1355
  field?: string | undefined;
1166
1356
  value?: string | undefined;
@@ -1257,10 +1447,15 @@ export declare const SearchHelpDocsResponseV: t.TypeC<{
1257
1447
  type: "execute_command";
1258
1448
  meta: {
1259
1449
  command: string;
1450
+ } & {
1451
+ type?: "link" | "video" | "action" | "helpdoc" | undefined;
1260
1452
  };
1261
1453
  } | {
1262
1454
  type: "click";
1263
1455
  value: string;
1456
+ } | {
1457
+ type: "click" | "clickBySelector" | "clickByXpath";
1458
+ value: string[];
1264
1459
  } | ({
1265
1460
  type: "link";
1266
1461
  value: string;
@@ -1269,7 +1464,7 @@ export declare const SearchHelpDocsResponseV: t.TypeC<{
1269
1464
  }) | {
1270
1465
  type: "open_chat";
1271
1466
  meta: {
1272
- type: string;
1467
+ type: "" | "intercom" | "helpscout" | "freshdesk" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "hubspot" | "drift";
1273
1468
  };
1274
1469
  } | {
1275
1470
  type: "dismiss";
@@ -1292,6 +1487,10 @@ export declare const SearchHelpDocsResponseV: t.TypeC<{
1292
1487
  value?: string | undefined;
1293
1488
  categoryFilter?: number | undefined;
1294
1489
  }) | {
1490
+ type: "open_helphub";
1491
+ } | {
1492
+ type: "open_copilot";
1493
+ } | {
1295
1494
  type: "no_action";
1296
1495
  };
1297
1496
  })[];
@@ -1302,6 +1501,8 @@ export declare const SearchHelpDocsResponseV: t.TypeC<{
1302
1501
  size: string;
1303
1502
  } | null;
1304
1503
  copilot_suggest: boolean;
1504
+ show_in_spotlight_search: boolean;
1505
+ show_in_helphub_search: boolean;
1305
1506
  copilot_cta_label: string;
1306
1507
  copilot_description: string;
1307
1508
  } & {
@@ -1323,6 +1524,9 @@ export declare const SearchHelpDocsResponseV: t.TypeC<{
1323
1524
  object?: string | undefined;
1324
1525
  hoverTooltip?: boolean | undefined;
1325
1526
  operation?: "self" | "router" | "blank" | "help_hub" | undefined;
1527
+ metadata?: {
1528
+ [key: string]: unknown;
1529
+ } | undefined;
1326
1530
  }) | ({
1327
1531
  type: "callback";
1328
1532
  value: string;
@@ -1331,6 +1535,9 @@ export declare const SearchHelpDocsResponseV: t.TypeC<{
1331
1535
  object?: string | undefined;
1332
1536
  hoverTooltip?: boolean | undefined;
1333
1537
  operation?: "self" | "router" | "blank" | "help_hub" | undefined;
1538
+ metadata?: {
1539
+ [key: string]: unknown;
1540
+ } | undefined;
1334
1541
  }) | ({
1335
1542
  type: "link";
1336
1543
  value: string;
@@ -1341,14 +1548,20 @@ export declare const SearchHelpDocsResponseV: t.TypeC<{
1341
1548
  object?: string | undefined;
1342
1549
  hoverTooltip?: boolean | undefined;
1343
1550
  operation?: "self" | "router" | "blank" | "help_hub" | undefined;
1551
+ metadata?: {
1552
+ [key: string]: unknown;
1553
+ } | undefined;
1344
1554
  }) | ({
1345
- type: "click" | "clickByXpath" | "clickBySelector";
1555
+ type: "click" | "clickBySelector" | "clickByXpath";
1346
1556
  value: string[];
1347
1557
  } & {} & {
1348
1558
  commandType?: "object" | "help" | "independent" | undefined;
1349
1559
  object?: string | undefined;
1350
1560
  hoverTooltip?: boolean | undefined;
1351
1561
  operation?: "self" | "router" | "blank" | "help_hub" | undefined;
1562
+ metadata?: {
1563
+ [key: string]: unknown;
1564
+ } | undefined;
1352
1565
  }) | ({
1353
1566
  type: "builtin";
1354
1567
  value: string;
@@ -1357,6 +1570,9 @@ export declare const SearchHelpDocsResponseV: t.TypeC<{
1357
1570
  object?: string | undefined;
1358
1571
  hoverTooltip?: boolean | undefined;
1359
1572
  operation?: "self" | "router" | "blank" | "help_hub" | undefined;
1573
+ metadata?: {
1574
+ [key: string]: unknown;
1575
+ } | undefined;
1360
1576
  }) | ({
1361
1577
  type: "webhook";
1362
1578
  value: string;
@@ -1365,6 +1581,9 @@ export declare const SearchHelpDocsResponseV: t.TypeC<{
1365
1581
  object?: string | undefined;
1366
1582
  hoverTooltip?: boolean | undefined;
1367
1583
  operation?: "self" | "router" | "blank" | "help_hub" | undefined;
1584
+ metadata?: {
1585
+ [key: string]: unknown;
1586
+ } | undefined;
1368
1587
  }) | ({
1369
1588
  type: "script";
1370
1589
  value: string;
@@ -1373,6 +1592,9 @@ export declare const SearchHelpDocsResponseV: t.TypeC<{
1373
1592
  object?: string | undefined;
1374
1593
  hoverTooltip?: boolean | undefined;
1375
1594
  operation?: "self" | "router" | "blank" | "help_hub" | undefined;
1595
+ metadata?: {
1596
+ [key: string]: unknown;
1597
+ } | undefined;
1376
1598
  }) | ({
1377
1599
  type: "request";
1378
1600
  value: {
@@ -1394,6 +1616,9 @@ export declare const SearchHelpDocsResponseV: t.TypeC<{
1394
1616
  object?: string | undefined;
1395
1617
  hoverTooltip?: boolean | undefined;
1396
1618
  operation?: "self" | "router" | "blank" | "help_hub" | undefined;
1619
+ metadata?: {
1620
+ [key: string]: unknown;
1621
+ } | undefined;
1397
1622
  }) | ({
1398
1623
  type: "appcues";
1399
1624
  value: string;
@@ -1402,6 +1627,20 @@ export declare const SearchHelpDocsResponseV: t.TypeC<{
1402
1627
  object?: string | undefined;
1403
1628
  hoverTooltip?: boolean | undefined;
1404
1629
  operation?: "self" | "router" | "blank" | "help_hub" | undefined;
1630
+ metadata?: {
1631
+ [key: string]: unknown;
1632
+ } | undefined;
1633
+ }) | ({
1634
+ type: "pendo_guide";
1635
+ value: string;
1636
+ } & {} & {
1637
+ commandType?: "object" | "help" | "independent" | undefined;
1638
+ object?: string | undefined;
1639
+ hoverTooltip?: boolean | undefined;
1640
+ operation?: "self" | "router" | "blank" | "help_hub" | undefined;
1641
+ metadata?: {
1642
+ [key: string]: unknown;
1643
+ } | undefined;
1405
1644
  }) | ({
1406
1645
  type: "video";
1407
1646
  value: string;
@@ -1410,6 +1649,9 @@ export declare const SearchHelpDocsResponseV: t.TypeC<{
1410
1649
  object?: string | undefined;
1411
1650
  hoverTooltip?: boolean | undefined;
1412
1651
  operation?: "self" | "router" | "blank" | "help_hub" | undefined;
1652
+ metadata?: {
1653
+ [key: string]: unknown;
1654
+ } | undefined;
1413
1655
  }) | ({
1414
1656
  type: "helpdoc";
1415
1657
  value: string;
@@ -1426,16 +1668,24 @@ export declare const SearchHelpDocsResponseV: t.TypeC<{
1426
1668
  object?: string | undefined;
1427
1669
  hoverTooltip?: boolean | undefined;
1428
1670
  operation?: "self" | "router" | "blank" | "help_hub" | undefined;
1671
+ metadata?: {
1672
+ [key: string]: unknown;
1673
+ } | undefined;
1429
1674
  }) | ({
1430
1675
  type: "trigger";
1431
1676
  value: {
1432
1677
  type: "execute_command";
1433
1678
  meta: {
1434
1679
  command: string;
1680
+ } & {
1681
+ type?: "link" | "video" | "action" | "helpdoc" | undefined;
1435
1682
  };
1436
1683
  } | {
1437
1684
  type: "click";
1438
1685
  value: string;
1686
+ } | {
1687
+ type: "click" | "clickBySelector" | "clickByXpath";
1688
+ value: string[];
1439
1689
  } | ({
1440
1690
  type: "link";
1441
1691
  value: string;
@@ -1444,7 +1694,7 @@ export declare const SearchHelpDocsResponseV: t.TypeC<{
1444
1694
  }) | {
1445
1695
  type: "open_chat";
1446
1696
  meta: {
1447
- type: string;
1697
+ type: "" | "intercom" | "helpscout" | "freshdesk" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "hubspot" | "drift";
1448
1698
  };
1449
1699
  } | {
1450
1700
  type: "dismiss";
@@ -1467,6 +1717,10 @@ export declare const SearchHelpDocsResponseV: t.TypeC<{
1467
1717
  value?: string | undefined;
1468
1718
  categoryFilter?: number | undefined;
1469
1719
  }) | {
1720
+ type: "open_helphub";
1721
+ } | {
1722
+ type: "open_copilot";
1723
+ } | {
1470
1724
  type: "no_action";
1471
1725
  };
1472
1726
  } & {} & {
@@ -1474,6 +1728,9 @@ export declare const SearchHelpDocsResponseV: t.TypeC<{
1474
1728
  object?: string | undefined;
1475
1729
  hoverTooltip?: boolean | undefined;
1476
1730
  operation?: "self" | "router" | "blank" | "help_hub" | undefined;
1731
+ metadata?: {
1732
+ [key: string]: unknown;
1733
+ } | undefined;
1477
1734
  });
1478
1735
  } & {
1479
1736
  disabledReason?: string | undefined;
@@ -1563,8 +1820,8 @@ export declare const SearchHelpDocsResponseV: t.TypeC<{
1563
1820
  };
1564
1821
  tags: string[];
1565
1822
  availability_rules: (({
1566
- type: "url" | "element" | "context" | "device_type" | "sessions" | "hostname" | "executions" | "shortcuts" | "last_seen" | "first_seen" | "opens" | "deadends" | "heap" | "hubspot";
1567
- operator: "includes" | "endsWith" | "startsWith" | "is" | "isTrue" | "isFalse" | "isTruthy" | "isFalsy" | "matchesRegex" | "isGreaterThan" | "isLessThan" | "isBefore" | "isAfter" | "isDefined" | "isNotDefined" | "classnameOnPage" | "idOnPage" | "selectorOnPage" | "classnameNotOnPage" | "idNotOnPage" | "selectorNotOnPage" | "doesNotInclude" | "isNot";
1823
+ 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";
1824
+ operator: "includes" | "endsWith" | "startsWith" | "is" | "isTrue" | "isFalse" | "isTruthy" | "isFalsy" | "matchesRegex" | "isDefined" | "isNotDefined" | "classnameOnPage" | "idOnPage" | "selectorOnPage" | "classnameNotOnPage" | "idNotOnPage" | "selectorNotOnPage" | "doesNotInclude" | "isNot" | "isGreaterThan" | "isLessThan";
1568
1825
  } & {
1569
1826
  field?: string | undefined;
1570
1827
  value?: string | undefined;
@@ -1592,8 +1849,8 @@ export declare const SearchHelpDocsResponseV: t.TypeC<{
1592
1849
  reason?: string | undefined;
1593
1850
  }))[];
1594
1851
  recommend_rules: (({
1595
- type: "url" | "element" | "context" | "device_type" | "sessions" | "hostname" | "executions" | "shortcuts" | "last_seen" | "first_seen" | "opens" | "deadends" | "heap" | "hubspot";
1596
- operator: "includes" | "endsWith" | "startsWith" | "is" | "isTrue" | "isFalse" | "isTruthy" | "isFalsy" | "matchesRegex" | "isGreaterThan" | "isLessThan" | "isBefore" | "isAfter" | "isDefined" | "isNotDefined" | "classnameOnPage" | "idOnPage" | "selectorOnPage" | "classnameNotOnPage" | "idNotOnPage" | "selectorNotOnPage" | "doesNotInclude" | "isNot";
1852
+ 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";
1853
+ operator: "includes" | "endsWith" | "startsWith" | "is" | "isTrue" | "isFalse" | "isTruthy" | "isFalsy" | "matchesRegex" | "isDefined" | "isNotDefined" | "classnameOnPage" | "idOnPage" | "selectorOnPage" | "classnameNotOnPage" | "idNotOnPage" | "selectorNotOnPage" | "doesNotInclude" | "isNot" | "isGreaterThan" | "isLessThan";
1597
1854
  } & {
1598
1855
  field?: string | undefined;
1599
1856
  value?: string | undefined;
@@ -1690,10 +1947,15 @@ export declare const SearchHelpDocsResponseV: t.TypeC<{
1690
1947
  type: "execute_command";
1691
1948
  meta: {
1692
1949
  command: string;
1950
+ } & {
1951
+ type?: "link" | "video" | "action" | "helpdoc" | undefined;
1693
1952
  };
1694
1953
  } | {
1695
1954
  type: "click";
1696
1955
  value: string;
1956
+ } | {
1957
+ type: "click" | "clickBySelector" | "clickByXpath";
1958
+ value: string[];
1697
1959
  } | ({
1698
1960
  type: "link";
1699
1961
  value: string;
@@ -1702,7 +1964,7 @@ export declare const SearchHelpDocsResponseV: t.TypeC<{
1702
1964
  }) | {
1703
1965
  type: "open_chat";
1704
1966
  meta: {
1705
- type: string;
1967
+ type: "" | "intercom" | "helpscout" | "freshdesk" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "hubspot" | "drift";
1706
1968
  };
1707
1969
  } | {
1708
1970
  type: "dismiss";
@@ -1725,6 +1987,10 @@ export declare const SearchHelpDocsResponseV: t.TypeC<{
1725
1987
  value?: string | undefined;
1726
1988
  categoryFilter?: number | undefined;
1727
1989
  }) | {
1990
+ type: "open_helphub";
1991
+ } | {
1992
+ type: "open_copilot";
1993
+ } | {
1728
1994
  type: "no_action";
1729
1995
  };
1730
1996
  })[];
@@ -1735,6 +2001,8 @@ export declare const SearchHelpDocsResponseV: t.TypeC<{
1735
2001
  size: string;
1736
2002
  } | null;
1737
2003
  copilot_suggest: boolean;
2004
+ show_in_spotlight_search: boolean;
2005
+ show_in_helphub_search: boolean;
1738
2006
  copilot_cta_label: string;
1739
2007
  copilot_description: string;
1740
2008
  } & {
@@ -1753,6 +2021,7 @@ export declare const SearchHelpDocsResponseV: t.TypeC<{
1753
2021
  export declare const SearchHelpDocsPayloadV: t.PartialC<{
1754
2022
  query: t.StringC;
1755
2023
  include_additional_docs: t.UnionC<[t.BooleanC, t.UndefinedC]>;
2024
+ expand_rules: t.UnionC<[t.BooleanC, t.UndefinedC]>;
1756
2025
  doc_id: t.UnionC<[t.NumberC, t.StringC, t.UndefinedC]>;
1757
2026
  filter: t.UnionC<[t.PartialC<{
1758
2027
  labels: t.ArrayC<t.StringC>;
@@ -1774,6 +2043,9 @@ export declare class HelpDocsSearch {
1774
2043
  object?: string | undefined;
1775
2044
  hoverTooltip?: boolean | undefined;
1776
2045
  operation?: "self" | "router" | "blank" | "help_hub" | undefined;
2046
+ metadata?: {
2047
+ [key: string]: unknown;
2048
+ } | undefined;
1777
2049
  }) | ({
1778
2050
  type: "callback";
1779
2051
  value: string;
@@ -1782,6 +2054,9 @@ export declare class HelpDocsSearch {
1782
2054
  object?: string | undefined;
1783
2055
  hoverTooltip?: boolean | undefined;
1784
2056
  operation?: "self" | "router" | "blank" | "help_hub" | undefined;
2057
+ metadata?: {
2058
+ [key: string]: unknown;
2059
+ } | undefined;
1785
2060
  }) | ({
1786
2061
  type: "link";
1787
2062
  value: string;
@@ -1792,14 +2067,20 @@ export declare class HelpDocsSearch {
1792
2067
  object?: string | undefined;
1793
2068
  hoverTooltip?: boolean | undefined;
1794
2069
  operation?: "self" | "router" | "blank" | "help_hub" | undefined;
2070
+ metadata?: {
2071
+ [key: string]: unknown;
2072
+ } | undefined;
1795
2073
  }) | ({
1796
- type: "click" | "clickByXpath" | "clickBySelector";
2074
+ type: "click" | "clickBySelector" | "clickByXpath";
1797
2075
  value: string[];
1798
2076
  } & {} & {
1799
2077
  commandType?: "object" | "help" | "independent" | undefined;
1800
2078
  object?: string | undefined;
1801
2079
  hoverTooltip?: boolean | undefined;
1802
2080
  operation?: "self" | "router" | "blank" | "help_hub" | undefined;
2081
+ metadata?: {
2082
+ [key: string]: unknown;
2083
+ } | undefined;
1803
2084
  }) | ({
1804
2085
  type: "builtin";
1805
2086
  value: string;
@@ -1808,6 +2089,9 @@ export declare class HelpDocsSearch {
1808
2089
  object?: string | undefined;
1809
2090
  hoverTooltip?: boolean | undefined;
1810
2091
  operation?: "self" | "router" | "blank" | "help_hub" | undefined;
2092
+ metadata?: {
2093
+ [key: string]: unknown;
2094
+ } | undefined;
1811
2095
  }) | ({
1812
2096
  type: "webhook";
1813
2097
  value: string;
@@ -1816,6 +2100,9 @@ export declare class HelpDocsSearch {
1816
2100
  object?: string | undefined;
1817
2101
  hoverTooltip?: boolean | undefined;
1818
2102
  operation?: "self" | "router" | "blank" | "help_hub" | undefined;
2103
+ metadata?: {
2104
+ [key: string]: unknown;
2105
+ } | undefined;
1819
2106
  }) | ({
1820
2107
  type: "script";
1821
2108
  value: string;
@@ -1824,6 +2111,9 @@ export declare class HelpDocsSearch {
1824
2111
  object?: string | undefined;
1825
2112
  hoverTooltip?: boolean | undefined;
1826
2113
  operation?: "self" | "router" | "blank" | "help_hub" | undefined;
2114
+ metadata?: {
2115
+ [key: string]: unknown;
2116
+ } | undefined;
1827
2117
  }) | ({
1828
2118
  type: "request";
1829
2119
  value: {
@@ -1845,6 +2135,9 @@ export declare class HelpDocsSearch {
1845
2135
  object?: string | undefined;
1846
2136
  hoverTooltip?: boolean | undefined;
1847
2137
  operation?: "self" | "router" | "blank" | "help_hub" | undefined;
2138
+ metadata?: {
2139
+ [key: string]: unknown;
2140
+ } | undefined;
1848
2141
  }) | ({
1849
2142
  type: "appcues";
1850
2143
  value: string;
@@ -1853,6 +2146,20 @@ export declare class HelpDocsSearch {
1853
2146
  object?: string | undefined;
1854
2147
  hoverTooltip?: boolean | undefined;
1855
2148
  operation?: "self" | "router" | "blank" | "help_hub" | undefined;
2149
+ metadata?: {
2150
+ [key: string]: unknown;
2151
+ } | undefined;
2152
+ }) | ({
2153
+ type: "pendo_guide";
2154
+ value: string;
2155
+ } & {} & {
2156
+ commandType?: "object" | "help" | "independent" | undefined;
2157
+ object?: string | undefined;
2158
+ hoverTooltip?: boolean | undefined;
2159
+ operation?: "self" | "router" | "blank" | "help_hub" | undefined;
2160
+ metadata?: {
2161
+ [key: string]: unknown;
2162
+ } | undefined;
1856
2163
  }) | ({
1857
2164
  type: "video";
1858
2165
  value: string;
@@ -1861,6 +2168,9 @@ export declare class HelpDocsSearch {
1861
2168
  object?: string | undefined;
1862
2169
  hoverTooltip?: boolean | undefined;
1863
2170
  operation?: "self" | "router" | "blank" | "help_hub" | undefined;
2171
+ metadata?: {
2172
+ [key: string]: unknown;
2173
+ } | undefined;
1864
2174
  }) | ({
1865
2175
  type: "helpdoc";
1866
2176
  value: string;
@@ -1877,16 +2187,24 @@ export declare class HelpDocsSearch {
1877
2187
  object?: string | undefined;
1878
2188
  hoverTooltip?: boolean | undefined;
1879
2189
  operation?: "self" | "router" | "blank" | "help_hub" | undefined;
2190
+ metadata?: {
2191
+ [key: string]: unknown;
2192
+ } | undefined;
1880
2193
  }) | ({
1881
2194
  type: "trigger";
1882
2195
  value: {
1883
2196
  type: "execute_command";
1884
2197
  meta: {
1885
2198
  command: string;
2199
+ } & {
2200
+ type?: "link" | "video" | "action" | "helpdoc" | undefined;
1886
2201
  };
1887
2202
  } | {
1888
2203
  type: "click";
1889
2204
  value: string;
2205
+ } | {
2206
+ type: "click" | "clickBySelector" | "clickByXpath";
2207
+ value: string[];
1890
2208
  } | ({
1891
2209
  type: "link";
1892
2210
  value: string;
@@ -1895,7 +2213,7 @@ export declare class HelpDocsSearch {
1895
2213
  }) | {
1896
2214
  type: "open_chat";
1897
2215
  meta: {
1898
- type: string;
2216
+ type: "" | "intercom" | "helpscout" | "freshdesk" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "hubspot" | "drift";
1899
2217
  };
1900
2218
  } | {
1901
2219
  type: "dismiss";
@@ -1918,6 +2236,10 @@ export declare class HelpDocsSearch {
1918
2236
  value?: string | undefined;
1919
2237
  categoryFilter?: number | undefined;
1920
2238
  }) | {
2239
+ type: "open_helphub";
2240
+ } | {
2241
+ type: "open_copilot";
2242
+ } | {
1921
2243
  type: "no_action";
1922
2244
  };
1923
2245
  } & {} & {
@@ -1925,6 +2247,9 @@ export declare class HelpDocsSearch {
1925
2247
  object?: string | undefined;
1926
2248
  hoverTooltip?: boolean | undefined;
1927
2249
  operation?: "self" | "router" | "blank" | "help_hub" | undefined;
2250
+ metadata?: {
2251
+ [key: string]: unknown;
2252
+ } | undefined;
1928
2253
  });
1929
2254
  } & {
1930
2255
  disabledReason?: string | undefined;
@@ -2014,8 +2339,8 @@ export declare class HelpDocsSearch {
2014
2339
  };
2015
2340
  tags: string[];
2016
2341
  availability_rules: (({
2017
- type: "url" | "element" | "context" | "device_type" | "sessions" | "hostname" | "executions" | "shortcuts" | "last_seen" | "first_seen" | "opens" | "deadends" | "heap" | "hubspot";
2018
- operator: "includes" | "endsWith" | "startsWith" | "is" | "isTrue" | "isFalse" | "isTruthy" | "isFalsy" | "matchesRegex" | "isGreaterThan" | "isLessThan" | "isBefore" | "isAfter" | "isDefined" | "isNotDefined" | "classnameOnPage" | "idOnPage" | "selectorOnPage" | "classnameNotOnPage" | "idNotOnPage" | "selectorNotOnPage" | "doesNotInclude" | "isNot";
2342
+ 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";
2343
+ operator: "includes" | "endsWith" | "startsWith" | "is" | "isTrue" | "isFalse" | "isTruthy" | "isFalsy" | "matchesRegex" | "isDefined" | "isNotDefined" | "classnameOnPage" | "idOnPage" | "selectorOnPage" | "classnameNotOnPage" | "idNotOnPage" | "selectorNotOnPage" | "doesNotInclude" | "isNot" | "isGreaterThan" | "isLessThan";
2019
2344
  } & {
2020
2345
  field?: string | undefined;
2021
2346
  value?: string | undefined;
@@ -2043,8 +2368,8 @@ export declare class HelpDocsSearch {
2043
2368
  reason?: string | undefined;
2044
2369
  }))[];
2045
2370
  recommend_rules: (({
2046
- type: "url" | "element" | "context" | "device_type" | "sessions" | "hostname" | "executions" | "shortcuts" | "last_seen" | "first_seen" | "opens" | "deadends" | "heap" | "hubspot";
2047
- operator: "includes" | "endsWith" | "startsWith" | "is" | "isTrue" | "isFalse" | "isTruthy" | "isFalsy" | "matchesRegex" | "isGreaterThan" | "isLessThan" | "isBefore" | "isAfter" | "isDefined" | "isNotDefined" | "classnameOnPage" | "idOnPage" | "selectorOnPage" | "classnameNotOnPage" | "idNotOnPage" | "selectorNotOnPage" | "doesNotInclude" | "isNot";
2371
+ 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";
2372
+ operator: "includes" | "endsWith" | "startsWith" | "is" | "isTrue" | "isFalse" | "isTruthy" | "isFalsy" | "matchesRegex" | "isDefined" | "isNotDefined" | "classnameOnPage" | "idOnPage" | "selectorOnPage" | "classnameNotOnPage" | "idNotOnPage" | "selectorNotOnPage" | "doesNotInclude" | "isNot" | "isGreaterThan" | "isLessThan";
2048
2373
  } & {
2049
2374
  field?: string | undefined;
2050
2375
  value?: string | undefined;
@@ -2141,10 +2466,15 @@ export declare class HelpDocsSearch {
2141
2466
  type: "execute_command";
2142
2467
  meta: {
2143
2468
  command: string;
2469
+ } & {
2470
+ type?: "link" | "video" | "action" | "helpdoc" | undefined;
2144
2471
  };
2145
2472
  } | {
2146
2473
  type: "click";
2147
2474
  value: string;
2475
+ } | {
2476
+ type: "click" | "clickBySelector" | "clickByXpath";
2477
+ value: string[];
2148
2478
  } | ({
2149
2479
  type: "link";
2150
2480
  value: string;
@@ -2153,7 +2483,7 @@ export declare class HelpDocsSearch {
2153
2483
  }) | {
2154
2484
  type: "open_chat";
2155
2485
  meta: {
2156
- type: string;
2486
+ type: "" | "intercom" | "helpscout" | "freshdesk" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "hubspot" | "drift";
2157
2487
  };
2158
2488
  } | {
2159
2489
  type: "dismiss";
@@ -2176,6 +2506,10 @@ export declare class HelpDocsSearch {
2176
2506
  value?: string | undefined;
2177
2507
  categoryFilter?: number | undefined;
2178
2508
  }) | {
2509
+ type: "open_helphub";
2510
+ } | {
2511
+ type: "open_copilot";
2512
+ } | {
2179
2513
  type: "no_action";
2180
2514
  };
2181
2515
  })[];
@@ -2186,6 +2520,8 @@ export declare class HelpDocsSearch {
2186
2520
  size: string;
2187
2521
  } | null;
2188
2522
  copilot_suggest: boolean;
2523
+ show_in_spotlight_search: boolean;
2524
+ show_in_helphub_search: boolean;
2189
2525
  copilot_cta_label: string;
2190
2526
  copilot_description: string;
2191
2527
  } & {