commandbar 1.13.0 → 1.13.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (40) hide show
  1. package/build/commandbar/src/shared/services/analytics/EventHandler.d.ts +2 -0
  2. package/build/commandbar-js/src/index.js +1 -1
  3. package/build/commandbar-js/src/init.d.ts +10 -1
  4. package/build/internal/src/client/CommandBarClientSDK.d.ts +4 -0
  5. package/build/internal/src/client/CommandBarProxySDK.d.ts +2 -3
  6. package/build/internal/src/client/SDKConfig.d.ts +1 -0
  7. package/build/internal/src/client/symbols.d.ts +2 -0
  8. package/build/internal/src/middleware/CommandFromClientV.d.ts +4 -0
  9. package/build/internal/src/middleware/OrganizationV.d.ts +56 -8
  10. package/build/internal/src/middleware/additionalResource.d.ts +200 -137
  11. package/build/internal/src/middleware/api.d.ts +7 -7
  12. package/build/internal/src/middleware/chat.d.ts +22868 -11601
  13. package/build/internal/src/middleware/checklist.d.ts +209 -139
  14. package/build/internal/src/middleware/command.d.ts +2547 -2170
  15. package/build/internal/src/middleware/endUser.d.ts +0 -32
  16. package/build/internal/src/middleware/experienceTemplate.d.ts +399 -263
  17. package/build/internal/src/middleware/experiencesSearch.d.ts +816 -718
  18. package/build/internal/src/middleware/flags.d.ts +6 -3
  19. package/build/internal/src/middleware/helpDocsSearch.d.ts +584 -514
  20. package/build/internal/src/middleware/helpers/actions.d.ts +66 -28
  21. package/build/internal/src/middleware/helpers/commandTemplate.d.ts +18 -4
  22. package/build/internal/src/middleware/helpers/rules.d.ts +19 -4
  23. package/build/internal/src/middleware/nudge.d.ts +482 -281
  24. package/build/internal/src/middleware/organization.d.ts +825 -670
  25. package/build/internal/src/middleware/organizationSettings.d.ts +210 -130
  26. package/build/internal/src/middleware/profile.d.ts +1 -1
  27. package/build/internal/src/middleware/recommendationSet.d.ts +200 -137
  28. package/build/internal/src/middleware/theme.d.ts +7 -0
  29. package/build/internal/src/middleware/types.d.ts +16 -20
  30. package/package.json +1 -1
  31. package/src/init.ts +13 -2
  32. package/build/commandbar/src/shared/services/analytics/event-queue.d.ts +0 -13
  33. package/build/commandbar/src/shared/services/analytics/v2/client.d.ts +0 -53
  34. package/build/commandbar/src/shared/services/analytics/v2/helpers.d.ts +0 -6
  35. package/build/commandbar/src/shared/services/analytics/v2/schema.d.ts +0 -152
  36. package/build/commandbar/src/shared/services/analytics/v2/types.d.ts +0 -4
  37. package/build/internal/src/client/CommandBarSDK.d.ts +0 -99
  38. package/build/internal/src/client/globals.d.ts +0 -27
  39. package/build/internal/src/util/dispatchCustomEvent.d.ts +0 -14
  40. package/build/internal/src/util/sentry.d.ts +0 -23
package/build/internal/src/middleware/helpDocsSearch.d.ts CHANGED
@@ -10,40 +10,40 @@ export declare const HelpDocHitV: t.TypeC<{
10
10
  id: number;
11
11
  text: string;
12
12
  template: ({
13
- type: "admin";
13
+ type: "callback";
14
14
  value: string;
15
15
  } & {} & {
16
16
  commandType?: "object" | "help" | "independent" | undefined;
17
17
  object?: string | undefined;
18
18
  hoverTooltip?: boolean | undefined;
19
- operation?: "self" | "router" | "blank" | "help_hub" | undefined;
19
+ operation?: "self" | "router" | "help_hub" | "blank" | undefined;
20
20
  metadata?: {
21
21
  [key: string]: unknown;
22
22
  } | undefined;
23
23
  }) | ({
24
- type: "callback";
24
+ type: "link";
25
25
  value: string;
26
+ } & {
27
+ operation?: "self" | "router" | "blank" | undefined;
28
+ meta?: {
29
+ command: string;
30
+ } | undefined;
26
31
  } & {} & {
27
32
  commandType?: "object" | "help" | "independent" | undefined;
28
33
  object?: string | undefined;
29
34
  hoverTooltip?: boolean | undefined;
30
- operation?: "self" | "router" | "blank" | "help_hub" | undefined;
35
+ operation?: "self" | "router" | "help_hub" | "blank" | undefined;
31
36
  metadata?: {
32
37
  [key: string]: unknown;
33
38
  } | undefined;
34
39
  }) | ({
35
- type: "link";
40
+ type: "webhook";
36
41
  value: string;
37
- } & {
38
- operation?: "self" | "router" | "blank" | undefined;
39
- meta?: {
40
- command: string;
41
- } | undefined;
42
42
  } & {} & {
43
43
  commandType?: "object" | "help" | "independent" | undefined;
44
44
  object?: string | undefined;
45
45
  hoverTooltip?: boolean | undefined;
46
- operation?: "self" | "router" | "blank" | "help_hub" | undefined;
46
+ operation?: "self" | "router" | "help_hub" | "blank" | undefined;
47
47
  metadata?: {
48
48
  [key: string]: unknown;
49
49
  } | undefined;
@@ -54,146 +54,153 @@ export declare const HelpDocHitV: t.TypeC<{
54
54
  commandType?: "object" | "help" | "independent" | undefined;
55
55
  object?: string | undefined;
56
56
  hoverTooltip?: boolean | undefined;
57
- operation?: "self" | "router" | "blank" | "help_hub" | undefined;
57
+ operation?: "self" | "router" | "help_hub" | "blank" | undefined;
58
58
  metadata?: {
59
59
  [key: string]: unknown;
60
60
  } | undefined;
61
61
  }) | ({
62
- type: "builtin";
63
- value: string;
62
+ type: "request";
63
+ value: {
64
+ method: "head" | "options" | "get" | "delete" | "post" | "put" | "patch";
65
+ url: string;
66
+ } & {
67
+ headers?: {
68
+ [key: string]: unknown;
69
+ } | undefined;
70
+ body?: {
71
+ [key: string]: unknown;
72
+ } | undefined;
73
+ onSend?: string | undefined;
74
+ onSuccess?: string | undefined;
75
+ onError?: string | undefined;
76
+ };
64
77
  } & {} & {
65
78
  commandType?: "object" | "help" | "independent" | undefined;
66
79
  object?: string | undefined;
67
80
  hoverTooltip?: boolean | undefined;
68
- operation?: "self" | "router" | "blank" | "help_hub" | undefined;
81
+ operation?: "self" | "router" | "help_hub" | "blank" | undefined;
69
82
  metadata?: {
70
83
  [key: string]: unknown;
71
84
  } | undefined;
72
85
  }) | ({
73
- type: "webhook";
86
+ type: "appcues";
74
87
  value: string;
75
88
  } & {} & {
76
89
  commandType?: "object" | "help" | "independent" | undefined;
77
90
  object?: string | undefined;
78
91
  hoverTooltip?: boolean | undefined;
79
- operation?: "self" | "router" | "blank" | "help_hub" | undefined;
92
+ operation?: "self" | "router" | "help_hub" | "blank" | undefined;
80
93
  metadata?: {
81
94
  [key: string]: unknown;
82
95
  } | undefined;
83
96
  }) | ({
84
- type: "script";
97
+ type: "pendo_guide";
85
98
  value: string;
86
99
  } & {} & {
87
100
  commandType?: "object" | "help" | "independent" | undefined;
88
101
  object?: string | undefined;
89
102
  hoverTooltip?: boolean | undefined;
90
- operation?: "self" | "router" | "blank" | "help_hub" | undefined;
103
+ operation?: "self" | "router" | "help_hub" | "blank" | undefined;
91
104
  metadata?: {
92
105
  [key: string]: unknown;
93
106
  } | undefined;
94
107
  }) | ({
95
- type: "request";
96
- value: {
97
- method: "head" | "options" | "get" | "post" | "put" | "delete" | "patch";
98
- url: string;
99
- } & {
100
- headers?: {
101
- [key: string]: unknown;
102
- } | undefined;
103
- body?: {
104
- [key: string]: unknown;
105
- } | undefined;
106
- onSend?: string | undefined;
107
- onSuccess?: string | undefined;
108
- onError?: string | undefined;
109
- };
108
+ type: "helpdoc";
109
+ value: string;
110
+ } & {
111
+ operation?: "self" | "router" | "help_hub" | "blank" | undefined;
112
+ doc_metadata?: {
113
+ content_type?: string | undefined;
114
+ date?: string | undefined;
115
+ } | undefined;
116
+ } & {
117
+ doc_type?: "answer" | "doc" | undefined;
110
118
  } & {} & {
111
119
  commandType?: "object" | "help" | "independent" | undefined;
112
120
  object?: string | undefined;
113
121
  hoverTooltip?: boolean | undefined;
114
- operation?: "self" | "router" | "blank" | "help_hub" | undefined;
122
+ operation?: "self" | "router" | "help_hub" | "blank" | undefined;
115
123
  metadata?: {
116
124
  [key: string]: unknown;
117
125
  } | undefined;
118
126
  }) | ({
119
- type: "appcues";
127
+ type: "admin";
120
128
  value: string;
121
129
  } & {} & {
122
130
  commandType?: "object" | "help" | "independent" | undefined;
123
131
  object?: string | undefined;
124
132
  hoverTooltip?: boolean | undefined;
125
- operation?: "self" | "router" | "blank" | "help_hub" | undefined;
133
+ operation?: "self" | "router" | "help_hub" | "blank" | undefined;
126
134
  metadata?: {
127
135
  [key: string]: unknown;
128
136
  } | undefined;
129
137
  }) | ({
130
- type: "pendo_guide";
138
+ type: "builtin";
131
139
  value: string;
132
140
  } & {} & {
133
141
  commandType?: "object" | "help" | "independent" | undefined;
134
142
  object?: string | undefined;
135
143
  hoverTooltip?: boolean | undefined;
136
- operation?: "self" | "router" | "blank" | "help_hub" | undefined;
144
+ operation?: "self" | "router" | "help_hub" | "blank" | undefined;
137
145
  metadata?: {
138
146
  [key: string]: unknown;
139
147
  } | undefined;
140
148
  }) | ({
141
- type: "video";
149
+ type: "script";
142
150
  value: string;
143
151
  } & {} & {
144
152
  commandType?: "object" | "help" | "independent" | undefined;
145
153
  object?: string | undefined;
146
154
  hoverTooltip?: boolean | undefined;
147
- operation?: "self" | "router" | "blank" | "help_hub" | undefined;
155
+ operation?: "self" | "router" | "help_hub" | "blank" | undefined;
148
156
  metadata?: {
149
157
  [key: string]: unknown;
150
158
  } | undefined;
151
159
  }) | ({
152
- type: "helpdoc";
160
+ type: "video";
153
161
  value: string;
154
- } & {
155
- operation?: "self" | "router" | "blank" | "help_hub" | undefined;
156
- doc_metadata?: {
157
- content_type?: string | undefined;
158
- date?: string | undefined;
159
- } | undefined;
160
- } & {
161
- doc_type?: "answer" | "doc" | undefined;
162
162
  } & {} & {
163
163
  commandType?: "object" | "help" | "independent" | undefined;
164
164
  object?: string | undefined;
165
165
  hoverTooltip?: boolean | undefined;
166
- operation?: "self" | "router" | "blank" | "help_hub" | undefined;
166
+ operation?: "self" | "router" | "help_hub" | "blank" | undefined;
167
167
  metadata?: {
168
168
  [key: string]: unknown;
169
169
  } | undefined;
170
170
  }) | ({
171
171
  type: "trigger";
172
- value: {
172
+ value: ({
173
+ type: "link";
174
+ value: string;
175
+ } & {
176
+ operation?: "self" | "router" | "blank" | undefined;
177
+ meta?: {
178
+ command: string;
179
+ } | undefined;
180
+ }) | {
181
+ type: "click" | "clickBySelector" | "clickByXpath";
182
+ value: string[];
183
+ } | {
173
184
  type: "execute_command";
174
185
  meta: {
175
186
  command: string;
176
187
  } & {
177
188
  type?: "link" | "video" | "action" | "helpdoc" | undefined;
178
189
  };
190
+ } | {
191
+ type: "no_action";
179
192
  } | {
180
193
  type: "click";
181
194
  value: string;
182
195
  } | {
183
- type: "click" | "clickBySelector" | "clickByXpath";
184
- value: string[];
185
- } | ({
186
- type: "link";
187
- value: string;
188
- } & {
189
- operation?: "self" | "router" | "blank" | undefined;
190
- meta?: {
191
- command: string;
192
- } | undefined;
193
- }) | {
194
196
  type: "open_chat";
195
197
  meta: {
196
- type: "" | "intercom" | "helpscout" | "freshdesk" | "freshchat" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "hubspot" | "drift" | "pylon" | "zendesk_handoff";
198
+ type: "" | "hubspot" | "intercom" | "helpscout" | "freshdesk" | "freshchat" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "drift" | "pylon" | "zendesk_handoff";
199
+ };
200
+ } | {
201
+ type: "chat_handoff";
202
+ meta: {
203
+ type: "" | "intercom" | "freshchat" | "zendesk";
197
204
  };
198
205
  } | {
199
206
  type: "dismiss";
@@ -202,14 +209,14 @@ export declare const HelpDocHitV: t.TypeC<{
202
209
  } | {
203
210
  type: "questlist";
204
211
  value: number;
205
- } | {
206
- type: "step_back";
207
212
  } | {
208
213
  type: "nudge";
209
214
  value: number;
210
215
  } | {
211
216
  type: "go_to_step";
212
217
  value: number;
218
+ } | {
219
+ type: "step_back";
213
220
  } | ({
214
221
  type: "open_bar";
215
222
  } & {
@@ -217,16 +224,16 @@ export declare const HelpDocHitV: t.TypeC<{
217
224
  categoryFilter?: number | undefined;
218
225
  }) | {
219
226
  type: "open_helphub";
220
- } | {
227
+ } | ({
221
228
  type: "open_copilot";
222
- } | {
223
- type: "no_action";
224
- };
229
+ } & {
230
+ query?: string | undefined;
231
+ });
225
232
  } & {} & {
226
233
  commandType?: "object" | "help" | "independent" | undefined;
227
234
  object?: string | undefined;
228
235
  hoverTooltip?: boolean | undefined;
229
- operation?: "self" | "router" | "blank" | "help_hub" | undefined;
236
+ operation?: "self" | "router" | "help_hub" | "blank" | undefined;
230
237
  metadata?: {
231
238
  [key: string]: unknown;
232
239
  } | undefined;
@@ -319,8 +326,8 @@ export declare const HelpDocHitV: t.TypeC<{
319
326
  };
320
327
  tags: string[];
321
328
  availability_rules: (({
322
- type: "url" | "element" | "amplitude" | "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";
323
- operator: "includes" | "endsWith" | "startsWith" | "is" | "isTrue" | "isFalse" | "isTruthy" | "isFalsy" | "matchesRegex" | "isDefined" | "isNotDefined" | "classnameOnPage" | "idOnPage" | "selectorOnPage" | "classnameNotOnPage" | "idNotOnPage" | "selectorNotOnPage" | "doesNotInclude" | "isNot" | "isGreaterThan" | "isLessThan";
329
+ type: "url" | "element" | "amplitude" | "context" | "user_property" | "event_property" | "hostname" | "executions" | "shortcuts" | "last_seen" | "first_seen" | "sessions" | "opens" | "deadends" | "heap" | "hubspot" | "device_type" | "ab_test" | "intent" | "help_doc_interaction" | "video_interaction" | "survey_response";
330
+ operator: "includes" | "endsWith" | "startsWith" | "is" | "isInList" | "isNotInList" | "isTrue" | "isFalse" | "isTruthy" | "isFalsy" | "matchesRegex" | "isDefined" | "isNotDefined" | "classnameOnPage" | "idOnPage" | "selectorOnPage" | "classnameNotOnPage" | "idNotOnPage" | "selectorNotOnPage" | "doesNotInclude" | "isNot" | "isGreaterThan" | "isLessThan";
324
331
  } & {
325
332
  field?: string | undefined;
326
333
  value?: string | undefined;
@@ -329,14 +336,14 @@ export declare const HelpDocHitV: t.TypeC<{
329
336
  }) | ({
330
337
  type: "nudge_interaction";
331
338
  operator: "is" | "isNot";
332
- value: "completed" | "dismissed" | "viewed";
339
+ value: "completed" | "viewed" | "dismissed";
333
340
  nudge_id: number;
334
341
  } & {
335
342
  reason?: string | undefined;
336
343
  }) | ({
337
344
  type: "questlist_interaction";
338
345
  operator: "is" | "isNot";
339
- value: "completed" | "dismissed" | "viewed";
346
+ value: "completed" | "viewed" | "dismissed";
340
347
  questlist_id: number;
341
348
  } & {
342
349
  reason?: string | undefined;
@@ -348,8 +355,8 @@ export declare const HelpDocHitV: t.TypeC<{
348
355
  reason?: string | undefined;
349
356
  }))[];
350
357
  recommend_rules: (({
351
- type: "url" | "element" | "amplitude" | "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";
352
- operator: "includes" | "endsWith" | "startsWith" | "is" | "isTrue" | "isFalse" | "isTruthy" | "isFalsy" | "matchesRegex" | "isDefined" | "isNotDefined" | "classnameOnPage" | "idOnPage" | "selectorOnPage" | "classnameNotOnPage" | "idNotOnPage" | "selectorNotOnPage" | "doesNotInclude" | "isNot" | "isGreaterThan" | "isLessThan";
358
+ type: "url" | "element" | "amplitude" | "context" | "user_property" | "event_property" | "hostname" | "executions" | "shortcuts" | "last_seen" | "first_seen" | "sessions" | "opens" | "deadends" | "heap" | "hubspot" | "device_type" | "ab_test" | "intent" | "help_doc_interaction" | "video_interaction" | "survey_response";
359
+ operator: "includes" | "endsWith" | "startsWith" | "is" | "isInList" | "isNotInList" | "isTrue" | "isFalse" | "isTruthy" | "isFalsy" | "matchesRegex" | "isDefined" | "isNotDefined" | "classnameOnPage" | "idOnPage" | "selectorOnPage" | "classnameNotOnPage" | "idNotOnPage" | "selectorNotOnPage" | "doesNotInclude" | "isNot" | "isGreaterThan" | "isLessThan";
353
360
  } & {
354
361
  field?: string | undefined;
355
362
  value?: string | undefined;
@@ -358,14 +365,14 @@ export declare const HelpDocHitV: t.TypeC<{
358
365
  }) | ({
359
366
  type: "nudge_interaction";
360
367
  operator: "is" | "isNot";
361
- value: "completed" | "dismissed" | "viewed";
368
+ value: "completed" | "viewed" | "dismissed";
362
369
  nudge_id: number;
363
370
  } & {
364
371
  reason?: string | undefined;
365
372
  }) | ({
366
373
  type: "questlist_interaction";
367
374
  operator: "is" | "isNot";
368
- value: "completed" | "dismissed" | "viewed";
375
+ value: "completed" | "viewed" | "dismissed";
369
376
  questlist_id: number;
370
377
  } & {
371
378
  reason?: string | undefined;
@@ -432,23 +439,23 @@ export declare const HelpDocHitV: t.TypeC<{
432
439
  hotkey_mac: string;
433
440
  hotkey_win: string;
434
441
  detail: string | ({
435
- type: "html" | "video" | "plaintext" | "markdown" | "component" | "react";
442
+ type: "html" | "video" | "plaintext" | "markdown" | "react" | "component";
436
443
  value: string;
437
444
  } & {
438
445
  position?: "inline" | "popover" | undefined;
439
446
  }) | (string | ({
440
- type: "html" | "video" | "plaintext" | "markdown" | "component" | "react";
447
+ type: "html" | "video" | "plaintext" | "markdown" | "react" | "component";
441
448
  value: string;
442
449
  } & {
443
450
  position?: "inline" | "popover" | undefined;
444
451
  }))[] | null;
445
452
  content: string | ({
446
- type: "html" | "video" | "plaintext" | "markdown" | "component" | "react";
453
+ type: "html" | "video" | "plaintext" | "markdown" | "react" | "component";
447
454
  value: string;
448
455
  } & {
449
456
  position?: "inline" | "popover" | undefined;
450
457
  }) | (string | ({
451
- type: "html" | "video" | "plaintext" | "markdown" | "component" | "react";
458
+ type: "html" | "video" | "plaintext" | "markdown" | "react" | "component";
452
459
  value: string;
453
460
  } & {
454
461
  position?: "inline" | "popover" | undefined;
@@ -456,31 +463,38 @@ export declare const HelpDocHitV: t.TypeC<{
456
463
  show_preview: boolean;
457
464
  next_steps: (string | number | {
458
465
  cta: string;
459
- action: {
466
+ action: ({
467
+ type: "link";
468
+ value: string;
469
+ } & {
470
+ operation?: "self" | "router" | "blank" | undefined;
471
+ meta?: {
472
+ command: string;
473
+ } | undefined;
474
+ }) | {
475
+ type: "click" | "clickBySelector" | "clickByXpath";
476
+ value: string[];
477
+ } | {
460
478
  type: "execute_command";
461
479
  meta: {
462
480
  command: string;
463
481
  } & {
464
482
  type?: "link" | "video" | "action" | "helpdoc" | undefined;
465
483
  };
484
+ } | {
485
+ type: "no_action";
466
486
  } | {
467
487
  type: "click";
468
488
  value: string;
469
489
  } | {
470
- type: "click" | "clickBySelector" | "clickByXpath";
471
- value: string[];
472
- } | ({
473
- type: "link";
474
- value: string;
475
- } & {
476
- operation?: "self" | "router" | "blank" | undefined;
477
- meta?: {
478
- command: string;
479
- } | undefined;
480
- }) | {
481
490
  type: "open_chat";
482
491
  meta: {
483
- type: "" | "intercom" | "helpscout" | "freshdesk" | "freshchat" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "hubspot" | "drift" | "pylon" | "zendesk_handoff";
492
+ type: "" | "hubspot" | "intercom" | "helpscout" | "freshdesk" | "freshchat" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "drift" | "pylon" | "zendesk_handoff";
493
+ };
494
+ } | {
495
+ type: "chat_handoff";
496
+ meta: {
497
+ type: "" | "intercom" | "freshchat" | "zendesk";
484
498
  };
485
499
  } | {
486
500
  type: "dismiss";
@@ -489,14 +503,14 @@ export declare const HelpDocHitV: t.TypeC<{
489
503
  } | {
490
504
  type: "questlist";
491
505
  value: number;
492
- } | {
493
- type: "step_back";
494
506
  } | {
495
507
  type: "nudge";
496
508
  value: number;
497
509
  } | {
498
510
  type: "go_to_step";
499
511
  value: number;
512
+ } | {
513
+ type: "step_back";
500
514
  } | ({
501
515
  type: "open_bar";
502
516
  } & {
@@ -504,11 +518,11 @@ export declare const HelpDocHitV: t.TypeC<{
504
518
  categoryFilter?: number | undefined;
505
519
  }) | {
506
520
  type: "open_helphub";
507
- } | {
521
+ } | ({
508
522
  type: "open_copilot";
509
- } | {
510
- type: "no_action";
511
- };
523
+ } & {
524
+ query?: string | undefined;
525
+ });
512
526
  })[];
513
527
  extra: string | null;
514
528
  thumbnail: {
@@ -548,40 +562,40 @@ export declare const HelpDocHitV: t.TypeC<{
548
562
  id: number;
549
563
  text: string;
550
564
  template: ({
551
- type: "admin";
565
+ type: "callback";
552
566
  value: string;
553
567
  } & {} & {
554
568
  commandType?: "object" | "help" | "independent" | undefined;
555
569
  object?: string | undefined;
556
570
  hoverTooltip?: boolean | undefined;
557
- operation?: "self" | "router" | "blank" | "help_hub" | undefined;
571
+ operation?: "self" | "router" | "help_hub" | "blank" | undefined;
558
572
  metadata?: {
559
573
  [key: string]: unknown;
560
574
  } | undefined;
561
575
  }) | ({
562
- type: "callback";
576
+ type: "link";
563
577
  value: string;
578
+ } & {
579
+ operation?: "self" | "router" | "blank" | undefined;
580
+ meta?: {
581
+ command: string;
582
+ } | undefined;
564
583
  } & {} & {
565
584
  commandType?: "object" | "help" | "independent" | undefined;
566
585
  object?: string | undefined;
567
586
  hoverTooltip?: boolean | undefined;
568
- operation?: "self" | "router" | "blank" | "help_hub" | undefined;
587
+ operation?: "self" | "router" | "help_hub" | "blank" | undefined;
569
588
  metadata?: {
570
589
  [key: string]: unknown;
571
590
  } | undefined;
572
591
  }) | ({
573
- type: "link";
592
+ type: "webhook";
574
593
  value: string;
575
- } & {
576
- operation?: "self" | "router" | "blank" | undefined;
577
- meta?: {
578
- command: string;
579
- } | undefined;
580
594
  } & {} & {
581
595
  commandType?: "object" | "help" | "independent" | undefined;
582
596
  object?: string | undefined;
583
597
  hoverTooltip?: boolean | undefined;
584
- operation?: "self" | "router" | "blank" | "help_hub" | undefined;
598
+ operation?: "self" | "router" | "help_hub" | "blank" | undefined;
585
599
  metadata?: {
586
600
  [key: string]: unknown;
587
601
  } | undefined;
@@ -592,146 +606,153 @@ export declare const HelpDocHitV: t.TypeC<{
592
606
  commandType?: "object" | "help" | "independent" | undefined;
593
607
  object?: string | undefined;
594
608
  hoverTooltip?: boolean | undefined;
595
- operation?: "self" | "router" | "blank" | "help_hub" | undefined;
609
+ operation?: "self" | "router" | "help_hub" | "blank" | undefined;
596
610
  metadata?: {
597
611
  [key: string]: unknown;
598
612
  } | undefined;
599
613
  }) | ({
600
- type: "builtin";
601
- value: string;
614
+ type: "request";
615
+ value: {
616
+ method: "head" | "options" | "get" | "delete" | "post" | "put" | "patch";
617
+ url: string;
618
+ } & {
619
+ headers?: {
620
+ [key: string]: unknown;
621
+ } | undefined;
622
+ body?: {
623
+ [key: string]: unknown;
624
+ } | undefined;
625
+ onSend?: string | undefined;
626
+ onSuccess?: string | undefined;
627
+ onError?: string | undefined;
628
+ };
602
629
  } & {} & {
603
630
  commandType?: "object" | "help" | "independent" | undefined;
604
631
  object?: string | undefined;
605
632
  hoverTooltip?: boolean | undefined;
606
- operation?: "self" | "router" | "blank" | "help_hub" | undefined;
633
+ operation?: "self" | "router" | "help_hub" | "blank" | undefined;
607
634
  metadata?: {
608
635
  [key: string]: unknown;
609
636
  } | undefined;
610
637
  }) | ({
611
- type: "webhook";
638
+ type: "appcues";
612
639
  value: string;
613
640
  } & {} & {
614
641
  commandType?: "object" | "help" | "independent" | undefined;
615
642
  object?: string | undefined;
616
643
  hoverTooltip?: boolean | undefined;
617
- operation?: "self" | "router" | "blank" | "help_hub" | undefined;
644
+ operation?: "self" | "router" | "help_hub" | "blank" | undefined;
618
645
  metadata?: {
619
646
  [key: string]: unknown;
620
647
  } | undefined;
621
648
  }) | ({
622
- type: "script";
649
+ type: "pendo_guide";
623
650
  value: string;
624
651
  } & {} & {
625
652
  commandType?: "object" | "help" | "independent" | undefined;
626
653
  object?: string | undefined;
627
654
  hoverTooltip?: boolean | undefined;
628
- operation?: "self" | "router" | "blank" | "help_hub" | undefined;
655
+ operation?: "self" | "router" | "help_hub" | "blank" | undefined;
629
656
  metadata?: {
630
657
  [key: string]: unknown;
631
658
  } | undefined;
632
659
  }) | ({
633
- type: "request";
634
- value: {
635
- method: "head" | "options" | "get" | "post" | "put" | "delete" | "patch";
636
- url: string;
637
- } & {
638
- headers?: {
639
- [key: string]: unknown;
640
- } | undefined;
641
- body?: {
642
- [key: string]: unknown;
643
- } | undefined;
644
- onSend?: string | undefined;
645
- onSuccess?: string | undefined;
646
- onError?: string | undefined;
647
- };
660
+ type: "helpdoc";
661
+ value: string;
662
+ } & {
663
+ operation?: "self" | "router" | "help_hub" | "blank" | undefined;
664
+ doc_metadata?: {
665
+ content_type?: string | undefined;
666
+ date?: string | undefined;
667
+ } | undefined;
668
+ } & {
669
+ doc_type?: "answer" | "doc" | undefined;
648
670
  } & {} & {
649
671
  commandType?: "object" | "help" | "independent" | undefined;
650
672
  object?: string | undefined;
651
673
  hoverTooltip?: boolean | undefined;
652
- operation?: "self" | "router" | "blank" | "help_hub" | undefined;
674
+ operation?: "self" | "router" | "help_hub" | "blank" | undefined;
653
675
  metadata?: {
654
676
  [key: string]: unknown;
655
677
  } | undefined;
656
678
  }) | ({
657
- type: "appcues";
679
+ type: "admin";
658
680
  value: string;
659
681
  } & {} & {
660
682
  commandType?: "object" | "help" | "independent" | undefined;
661
683
  object?: string | undefined;
662
684
  hoverTooltip?: boolean | undefined;
663
- operation?: "self" | "router" | "blank" | "help_hub" | undefined;
685
+ operation?: "self" | "router" | "help_hub" | "blank" | undefined;
664
686
  metadata?: {
665
687
  [key: string]: unknown;
666
688
  } | undefined;
667
689
  }) | ({
668
- type: "pendo_guide";
690
+ type: "builtin";
669
691
  value: string;
670
692
  } & {} & {
671
693
  commandType?: "object" | "help" | "independent" | undefined;
672
694
  object?: string | undefined;
673
695
  hoverTooltip?: boolean | undefined;
674
- operation?: "self" | "router" | "blank" | "help_hub" | undefined;
696
+ operation?: "self" | "router" | "help_hub" | "blank" | undefined;
675
697
  metadata?: {
676
698
  [key: string]: unknown;
677
699
  } | undefined;
678
700
  }) | ({
679
- type: "video";
701
+ type: "script";
680
702
  value: string;
681
703
  } & {} & {
682
704
  commandType?: "object" | "help" | "independent" | undefined;
683
705
  object?: string | undefined;
684
706
  hoverTooltip?: boolean | undefined;
685
- operation?: "self" | "router" | "blank" | "help_hub" | undefined;
707
+ operation?: "self" | "router" | "help_hub" | "blank" | undefined;
686
708
  metadata?: {
687
709
  [key: string]: unknown;
688
710
  } | undefined;
689
711
  }) | ({
690
- type: "helpdoc";
712
+ type: "video";
691
713
  value: string;
692
- } & {
693
- operation?: "self" | "router" | "blank" | "help_hub" | undefined;
694
- doc_metadata?: {
695
- content_type?: string | undefined;
696
- date?: string | undefined;
697
- } | undefined;
698
- } & {
699
- doc_type?: "answer" | "doc" | undefined;
700
714
  } & {} & {
701
715
  commandType?: "object" | "help" | "independent" | undefined;
702
716
  object?: string | undefined;
703
717
  hoverTooltip?: boolean | undefined;
704
- operation?: "self" | "router" | "blank" | "help_hub" | undefined;
718
+ operation?: "self" | "router" | "help_hub" | "blank" | undefined;
705
719
  metadata?: {
706
720
  [key: string]: unknown;
707
721
  } | undefined;
708
722
  }) | ({
709
723
  type: "trigger";
710
- value: {
724
+ value: ({
725
+ type: "link";
726
+ value: string;
727
+ } & {
728
+ operation?: "self" | "router" | "blank" | undefined;
729
+ meta?: {
730
+ command: string;
731
+ } | undefined;
732
+ }) | {
733
+ type: "click" | "clickBySelector" | "clickByXpath";
734
+ value: string[];
735
+ } | {
711
736
  type: "execute_command";
712
737
  meta: {
713
738
  command: string;
714
739
  } & {
715
740
  type?: "link" | "video" | "action" | "helpdoc" | undefined;
716
741
  };
742
+ } | {
743
+ type: "no_action";
717
744
  } | {
718
745
  type: "click";
719
746
  value: string;
720
747
  } | {
721
- type: "click" | "clickBySelector" | "clickByXpath";
722
- value: string[];
723
- } | ({
724
- type: "link";
725
- value: string;
726
- } & {
727
- operation?: "self" | "router" | "blank" | undefined;
728
- meta?: {
729
- command: string;
730
- } | undefined;
731
- }) | {
732
748
  type: "open_chat";
733
749
  meta: {
734
- type: "" | "intercom" | "helpscout" | "freshdesk" | "freshchat" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "hubspot" | "drift" | "pylon" | "zendesk_handoff";
750
+ type: "" | "hubspot" | "intercom" | "helpscout" | "freshdesk" | "freshchat" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "drift" | "pylon" | "zendesk_handoff";
751
+ };
752
+ } | {
753
+ type: "chat_handoff";
754
+ meta: {
755
+ type: "" | "intercom" | "freshchat" | "zendesk";
735
756
  };
736
757
  } | {
737
758
  type: "dismiss";
@@ -740,14 +761,14 @@ export declare const HelpDocHitV: t.TypeC<{
740
761
  } | {
741
762
  type: "questlist";
742
763
  value: number;
743
- } | {
744
- type: "step_back";
745
764
  } | {
746
765
  type: "nudge";
747
766
  value: number;
748
767
  } | {
749
768
  type: "go_to_step";
750
769
  value: number;
770
+ } | {
771
+ type: "step_back";
751
772
  } | ({
752
773
  type: "open_bar";
753
774
  } & {
@@ -755,16 +776,16 @@ export declare const HelpDocHitV: t.TypeC<{
755
776
  categoryFilter?: number | undefined;
756
777
  }) | {
757
778
  type: "open_helphub";
758
- } | {
779
+ } | ({
759
780
  type: "open_copilot";
760
- } | {
761
- type: "no_action";
762
- };
781
+ } & {
782
+ query?: string | undefined;
783
+ });
763
784
  } & {} & {
764
785
  commandType?: "object" | "help" | "independent" | undefined;
765
786
  object?: string | undefined;
766
787
  hoverTooltip?: boolean | undefined;
767
- operation?: "self" | "router" | "blank" | "help_hub" | undefined;
788
+ operation?: "self" | "router" | "help_hub" | "blank" | undefined;
768
789
  metadata?: {
769
790
  [key: string]: unknown;
770
791
  } | undefined;
@@ -857,8 +878,8 @@ export declare const HelpDocHitV: t.TypeC<{
857
878
  };
858
879
  tags: string[];
859
880
  availability_rules: (({
860
- type: "url" | "element" | "amplitude" | "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";
861
- operator: "includes" | "endsWith" | "startsWith" | "is" | "isTrue" | "isFalse" | "isTruthy" | "isFalsy" | "matchesRegex" | "isDefined" | "isNotDefined" | "classnameOnPage" | "idOnPage" | "selectorOnPage" | "classnameNotOnPage" | "idNotOnPage" | "selectorNotOnPage" | "doesNotInclude" | "isNot" | "isGreaterThan" | "isLessThan";
881
+ type: "url" | "element" | "amplitude" | "context" | "user_property" | "event_property" | "hostname" | "executions" | "shortcuts" | "last_seen" | "first_seen" | "sessions" | "opens" | "deadends" | "heap" | "hubspot" | "device_type" | "ab_test" | "intent" | "help_doc_interaction" | "video_interaction" | "survey_response";
882
+ operator: "includes" | "endsWith" | "startsWith" | "is" | "isInList" | "isNotInList" | "isTrue" | "isFalse" | "isTruthy" | "isFalsy" | "matchesRegex" | "isDefined" | "isNotDefined" | "classnameOnPage" | "idOnPage" | "selectorOnPage" | "classnameNotOnPage" | "idNotOnPage" | "selectorNotOnPage" | "doesNotInclude" | "isNot" | "isGreaterThan" | "isLessThan";
862
883
  } & {
863
884
  field?: string | undefined;
864
885
  value?: string | undefined;
@@ -867,14 +888,14 @@ export declare const HelpDocHitV: t.TypeC<{
867
888
  }) | ({
868
889
  type: "nudge_interaction";
869
890
  operator: "is" | "isNot";
870
- value: "completed" | "dismissed" | "viewed";
891
+ value: "completed" | "viewed" | "dismissed";
871
892
  nudge_id: number;
872
893
  } & {
873
894
  reason?: string | undefined;
874
895
  }) | ({
875
896
  type: "questlist_interaction";
876
897
  operator: "is" | "isNot";
877
- value: "completed" | "dismissed" | "viewed";
898
+ value: "completed" | "viewed" | "dismissed";
878
899
  questlist_id: number;
879
900
  } & {
880
901
  reason?: string | undefined;
@@ -886,8 +907,8 @@ export declare const HelpDocHitV: t.TypeC<{
886
907
  reason?: string | undefined;
887
908
  }))[];
888
909
  recommend_rules: (({
889
- type: "url" | "element" | "amplitude" | "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";
890
- operator: "includes" | "endsWith" | "startsWith" | "is" | "isTrue" | "isFalse" | "isTruthy" | "isFalsy" | "matchesRegex" | "isDefined" | "isNotDefined" | "classnameOnPage" | "idOnPage" | "selectorOnPage" | "classnameNotOnPage" | "idNotOnPage" | "selectorNotOnPage" | "doesNotInclude" | "isNot" | "isGreaterThan" | "isLessThan";
910
+ type: "url" | "element" | "amplitude" | "context" | "user_property" | "event_property" | "hostname" | "executions" | "shortcuts" | "last_seen" | "first_seen" | "sessions" | "opens" | "deadends" | "heap" | "hubspot" | "device_type" | "ab_test" | "intent" | "help_doc_interaction" | "video_interaction" | "survey_response";
911
+ operator: "includes" | "endsWith" | "startsWith" | "is" | "isInList" | "isNotInList" | "isTrue" | "isFalse" | "isTruthy" | "isFalsy" | "matchesRegex" | "isDefined" | "isNotDefined" | "classnameOnPage" | "idOnPage" | "selectorOnPage" | "classnameNotOnPage" | "idNotOnPage" | "selectorNotOnPage" | "doesNotInclude" | "isNot" | "isGreaterThan" | "isLessThan";
891
912
  } & {
892
913
  field?: string | undefined;
893
914
  value?: string | undefined;
@@ -896,14 +917,14 @@ export declare const HelpDocHitV: t.TypeC<{
896
917
  }) | ({
897
918
  type: "nudge_interaction";
898
919
  operator: "is" | "isNot";
899
- value: "completed" | "dismissed" | "viewed";
920
+ value: "completed" | "viewed" | "dismissed";
900
921
  nudge_id: number;
901
922
  } & {
902
923
  reason?: string | undefined;
903
924
  }) | ({
904
925
  type: "questlist_interaction";
905
926
  operator: "is" | "isNot";
906
- value: "completed" | "dismissed" | "viewed";
927
+ value: "completed" | "viewed" | "dismissed";
907
928
  questlist_id: number;
908
929
  } & {
909
930
  reason?: string | undefined;
@@ -970,23 +991,23 @@ export declare const HelpDocHitV: t.TypeC<{
970
991
  hotkey_mac: string;
971
992
  hotkey_win: string;
972
993
  detail: string | ({
973
- type: "html" | "video" | "plaintext" | "markdown" | "component" | "react";
994
+ type: "html" | "video" | "plaintext" | "markdown" | "react" | "component";
974
995
  value: string;
975
996
  } & {
976
997
  position?: "inline" | "popover" | undefined;
977
998
  }) | (string | ({
978
- type: "html" | "video" | "plaintext" | "markdown" | "component" | "react";
999
+ type: "html" | "video" | "plaintext" | "markdown" | "react" | "component";
979
1000
  value: string;
980
1001
  } & {
981
1002
  position?: "inline" | "popover" | undefined;
982
1003
  }))[] | null;
983
1004
  content: string | ({
984
- type: "html" | "video" | "plaintext" | "markdown" | "component" | "react";
1005
+ type: "html" | "video" | "plaintext" | "markdown" | "react" | "component";
985
1006
  value: string;
986
1007
  } & {
987
1008
  position?: "inline" | "popover" | undefined;
988
1009
  }) | (string | ({
989
- type: "html" | "video" | "plaintext" | "markdown" | "component" | "react";
1010
+ type: "html" | "video" | "plaintext" | "markdown" | "react" | "component";
990
1011
  value: string;
991
1012
  } & {
992
1013
  position?: "inline" | "popover" | undefined;
@@ -994,31 +1015,38 @@ export declare const HelpDocHitV: t.TypeC<{
994
1015
  show_preview: boolean;
995
1016
  next_steps: (string | number | {
996
1017
  cta: string;
997
- action: {
1018
+ action: ({
1019
+ type: "link";
1020
+ value: string;
1021
+ } & {
1022
+ operation?: "self" | "router" | "blank" | undefined;
1023
+ meta?: {
1024
+ command: string;
1025
+ } | undefined;
1026
+ }) | {
1027
+ type: "click" | "clickBySelector" | "clickByXpath";
1028
+ value: string[];
1029
+ } | {
998
1030
  type: "execute_command";
999
1031
  meta: {
1000
1032
  command: string;
1001
1033
  } & {
1002
1034
  type?: "link" | "video" | "action" | "helpdoc" | undefined;
1003
1035
  };
1036
+ } | {
1037
+ type: "no_action";
1004
1038
  } | {
1005
1039
  type: "click";
1006
1040
  value: string;
1007
1041
  } | {
1008
- type: "click" | "clickBySelector" | "clickByXpath";
1009
- value: string[];
1010
- } | ({
1011
- type: "link";
1012
- value: string;
1013
- } & {
1014
- operation?: "self" | "router" | "blank" | undefined;
1015
- meta?: {
1016
- command: string;
1017
- } | undefined;
1018
- }) | {
1019
1042
  type: "open_chat";
1020
1043
  meta: {
1021
- type: "" | "intercom" | "helpscout" | "freshdesk" | "freshchat" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "hubspot" | "drift" | "pylon" | "zendesk_handoff";
1044
+ type: "" | "hubspot" | "intercom" | "helpscout" | "freshdesk" | "freshchat" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "drift" | "pylon" | "zendesk_handoff";
1045
+ };
1046
+ } | {
1047
+ type: "chat_handoff";
1048
+ meta: {
1049
+ type: "" | "intercom" | "freshchat" | "zendesk";
1022
1050
  };
1023
1051
  } | {
1024
1052
  type: "dismiss";
@@ -1027,14 +1055,14 @@ export declare const HelpDocHitV: t.TypeC<{
1027
1055
  } | {
1028
1056
  type: "questlist";
1029
1057
  value: number;
1030
- } | {
1031
- type: "step_back";
1032
1058
  } | {
1033
1059
  type: "nudge";
1034
1060
  value: number;
1035
1061
  } | {
1036
1062
  type: "go_to_step";
1037
1063
  value: number;
1064
+ } | {
1065
+ type: "step_back";
1038
1066
  } | ({
1039
1067
  type: "open_bar";
1040
1068
  } & {
@@ -1042,11 +1070,11 @@ export declare const HelpDocHitV: t.TypeC<{
1042
1070
  categoryFilter?: number | undefined;
1043
1071
  }) | {
1044
1072
  type: "open_helphub";
1045
- } | {
1073
+ } | ({
1046
1074
  type: "open_copilot";
1047
- } | {
1048
- type: "no_action";
1049
- };
1075
+ } & {
1076
+ query?: string | undefined;
1077
+ });
1050
1078
  })[];
1051
1079
  extra: string | null;
1052
1080
  thumbnail: {
@@ -1093,40 +1121,40 @@ export declare const SearchHelpDocsResponseV: t.TypeC<{
1093
1121
  id: number;
1094
1122
  text: string;
1095
1123
  template: ({
1096
- type: "admin";
1124
+ type: "callback";
1097
1125
  value: string;
1098
1126
  } & {} & {
1099
1127
  commandType?: "object" | "help" | "independent" | undefined;
1100
1128
  object?: string | undefined;
1101
1129
  hoverTooltip?: boolean | undefined;
1102
- operation?: "self" | "router" | "blank" | "help_hub" | undefined;
1130
+ operation?: "self" | "router" | "help_hub" | "blank" | undefined;
1103
1131
  metadata?: {
1104
1132
  [key: string]: unknown;
1105
1133
  } | undefined;
1106
1134
  }) | ({
1107
- type: "callback";
1135
+ type: "link";
1108
1136
  value: string;
1137
+ } & {
1138
+ operation?: "self" | "router" | "blank" | undefined;
1139
+ meta?: {
1140
+ command: string;
1141
+ } | undefined;
1109
1142
  } & {} & {
1110
1143
  commandType?: "object" | "help" | "independent" | undefined;
1111
1144
  object?: string | undefined;
1112
1145
  hoverTooltip?: boolean | undefined;
1113
- operation?: "self" | "router" | "blank" | "help_hub" | undefined;
1146
+ operation?: "self" | "router" | "help_hub" | "blank" | undefined;
1114
1147
  metadata?: {
1115
1148
  [key: string]: unknown;
1116
1149
  } | undefined;
1117
1150
  }) | ({
1118
- type: "link";
1151
+ type: "webhook";
1119
1152
  value: string;
1120
- } & {
1121
- operation?: "self" | "router" | "blank" | undefined;
1122
- meta?: {
1123
- command: string;
1124
- } | undefined;
1125
1153
  } & {} & {
1126
1154
  commandType?: "object" | "help" | "independent" | undefined;
1127
1155
  object?: string | undefined;
1128
1156
  hoverTooltip?: boolean | undefined;
1129
- operation?: "self" | "router" | "blank" | "help_hub" | undefined;
1157
+ operation?: "self" | "router" | "help_hub" | "blank" | undefined;
1130
1158
  metadata?: {
1131
1159
  [key: string]: unknown;
1132
1160
  } | undefined;
@@ -1137,146 +1165,153 @@ export declare const SearchHelpDocsResponseV: t.TypeC<{
1137
1165
  commandType?: "object" | "help" | "independent" | undefined;
1138
1166
  object?: string | undefined;
1139
1167
  hoverTooltip?: boolean | undefined;
1140
- operation?: "self" | "router" | "blank" | "help_hub" | undefined;
1168
+ operation?: "self" | "router" | "help_hub" | "blank" | undefined;
1141
1169
  metadata?: {
1142
1170
  [key: string]: unknown;
1143
1171
  } | undefined;
1144
1172
  }) | ({
1145
- type: "builtin";
1146
- value: string;
1173
+ type: "request";
1174
+ value: {
1175
+ method: "head" | "options" | "get" | "delete" | "post" | "put" | "patch";
1176
+ url: string;
1177
+ } & {
1178
+ headers?: {
1179
+ [key: string]: unknown;
1180
+ } | undefined;
1181
+ body?: {
1182
+ [key: string]: unknown;
1183
+ } | undefined;
1184
+ onSend?: string | undefined;
1185
+ onSuccess?: string | undefined;
1186
+ onError?: string | undefined;
1187
+ };
1147
1188
  } & {} & {
1148
1189
  commandType?: "object" | "help" | "independent" | undefined;
1149
1190
  object?: string | undefined;
1150
1191
  hoverTooltip?: boolean | undefined;
1151
- operation?: "self" | "router" | "blank" | "help_hub" | undefined;
1192
+ operation?: "self" | "router" | "help_hub" | "blank" | undefined;
1152
1193
  metadata?: {
1153
1194
  [key: string]: unknown;
1154
1195
  } | undefined;
1155
1196
  }) | ({
1156
- type: "webhook";
1197
+ type: "appcues";
1157
1198
  value: string;
1158
1199
  } & {} & {
1159
1200
  commandType?: "object" | "help" | "independent" | undefined;
1160
1201
  object?: string | undefined;
1161
1202
  hoverTooltip?: boolean | undefined;
1162
- operation?: "self" | "router" | "blank" | "help_hub" | undefined;
1203
+ operation?: "self" | "router" | "help_hub" | "blank" | undefined;
1163
1204
  metadata?: {
1164
1205
  [key: string]: unknown;
1165
1206
  } | undefined;
1166
1207
  }) | ({
1167
- type: "script";
1208
+ type: "pendo_guide";
1168
1209
  value: string;
1169
1210
  } & {} & {
1170
1211
  commandType?: "object" | "help" | "independent" | undefined;
1171
1212
  object?: string | undefined;
1172
1213
  hoverTooltip?: boolean | undefined;
1173
- operation?: "self" | "router" | "blank" | "help_hub" | undefined;
1214
+ operation?: "self" | "router" | "help_hub" | "blank" | undefined;
1174
1215
  metadata?: {
1175
1216
  [key: string]: unknown;
1176
1217
  } | undefined;
1177
1218
  }) | ({
1178
- type: "request";
1179
- value: {
1180
- method: "head" | "options" | "get" | "post" | "put" | "delete" | "patch";
1181
- url: string;
1182
- } & {
1183
- headers?: {
1184
- [key: string]: unknown;
1185
- } | undefined;
1186
- body?: {
1187
- [key: string]: unknown;
1188
- } | undefined;
1189
- onSend?: string | undefined;
1190
- onSuccess?: string | undefined;
1191
- onError?: string | undefined;
1192
- };
1219
+ type: "helpdoc";
1220
+ value: string;
1221
+ } & {
1222
+ operation?: "self" | "router" | "help_hub" | "blank" | undefined;
1223
+ doc_metadata?: {
1224
+ content_type?: string | undefined;
1225
+ date?: string | undefined;
1226
+ } | undefined;
1227
+ } & {
1228
+ doc_type?: "answer" | "doc" | undefined;
1193
1229
  } & {} & {
1194
1230
  commandType?: "object" | "help" | "independent" | undefined;
1195
1231
  object?: string | undefined;
1196
1232
  hoverTooltip?: boolean | undefined;
1197
- operation?: "self" | "router" | "blank" | "help_hub" | undefined;
1233
+ operation?: "self" | "router" | "help_hub" | "blank" | undefined;
1198
1234
  metadata?: {
1199
1235
  [key: string]: unknown;
1200
1236
  } | undefined;
1201
1237
  }) | ({
1202
- type: "appcues";
1238
+ type: "admin";
1203
1239
  value: string;
1204
1240
  } & {} & {
1205
1241
  commandType?: "object" | "help" | "independent" | undefined;
1206
1242
  object?: string | undefined;
1207
1243
  hoverTooltip?: boolean | undefined;
1208
- operation?: "self" | "router" | "blank" | "help_hub" | undefined;
1244
+ operation?: "self" | "router" | "help_hub" | "blank" | undefined;
1209
1245
  metadata?: {
1210
1246
  [key: string]: unknown;
1211
1247
  } | undefined;
1212
1248
  }) | ({
1213
- type: "pendo_guide";
1249
+ type: "builtin";
1214
1250
  value: string;
1215
1251
  } & {} & {
1216
1252
  commandType?: "object" | "help" | "independent" | undefined;
1217
1253
  object?: string | undefined;
1218
1254
  hoverTooltip?: boolean | undefined;
1219
- operation?: "self" | "router" | "blank" | "help_hub" | undefined;
1255
+ operation?: "self" | "router" | "help_hub" | "blank" | undefined;
1220
1256
  metadata?: {
1221
1257
  [key: string]: unknown;
1222
1258
  } | undefined;
1223
1259
  }) | ({
1224
- type: "video";
1260
+ type: "script";
1225
1261
  value: string;
1226
1262
  } & {} & {
1227
1263
  commandType?: "object" | "help" | "independent" | undefined;
1228
1264
  object?: string | undefined;
1229
1265
  hoverTooltip?: boolean | undefined;
1230
- operation?: "self" | "router" | "blank" | "help_hub" | undefined;
1266
+ operation?: "self" | "router" | "help_hub" | "blank" | undefined;
1231
1267
  metadata?: {
1232
1268
  [key: string]: unknown;
1233
1269
  } | undefined;
1234
1270
  }) | ({
1235
- type: "helpdoc";
1271
+ type: "video";
1236
1272
  value: string;
1237
- } & {
1238
- operation?: "self" | "router" | "blank" | "help_hub" | undefined;
1239
- doc_metadata?: {
1240
- content_type?: string | undefined;
1241
- date?: string | undefined;
1242
- } | undefined;
1243
- } & {
1244
- doc_type?: "answer" | "doc" | undefined;
1245
1273
  } & {} & {
1246
1274
  commandType?: "object" | "help" | "independent" | undefined;
1247
1275
  object?: string | undefined;
1248
1276
  hoverTooltip?: boolean | undefined;
1249
- operation?: "self" | "router" | "blank" | "help_hub" | undefined;
1277
+ operation?: "self" | "router" | "help_hub" | "blank" | undefined;
1250
1278
  metadata?: {
1251
1279
  [key: string]: unknown;
1252
1280
  } | undefined;
1253
1281
  }) | ({
1254
1282
  type: "trigger";
1255
- value: {
1283
+ value: ({
1284
+ type: "link";
1285
+ value: string;
1286
+ } & {
1287
+ operation?: "self" | "router" | "blank" | undefined;
1288
+ meta?: {
1289
+ command: string;
1290
+ } | undefined;
1291
+ }) | {
1292
+ type: "click" | "clickBySelector" | "clickByXpath";
1293
+ value: string[];
1294
+ } | {
1256
1295
  type: "execute_command";
1257
1296
  meta: {
1258
1297
  command: string;
1259
1298
  } & {
1260
1299
  type?: "link" | "video" | "action" | "helpdoc" | undefined;
1261
1300
  };
1301
+ } | {
1302
+ type: "no_action";
1262
1303
  } | {
1263
1304
  type: "click";
1264
1305
  value: string;
1265
1306
  } | {
1266
- type: "click" | "clickBySelector" | "clickByXpath";
1267
- value: string[];
1268
- } | ({
1269
- type: "link";
1270
- value: string;
1271
- } & {
1272
- operation?: "self" | "router" | "blank" | undefined;
1273
- meta?: {
1274
- command: string;
1275
- } | undefined;
1276
- }) | {
1277
1307
  type: "open_chat";
1278
1308
  meta: {
1279
- type: "" | "intercom" | "helpscout" | "freshdesk" | "freshchat" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "hubspot" | "drift" | "pylon" | "zendesk_handoff";
1309
+ type: "" | "hubspot" | "intercom" | "helpscout" | "freshdesk" | "freshchat" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "drift" | "pylon" | "zendesk_handoff";
1310
+ };
1311
+ } | {
1312
+ type: "chat_handoff";
1313
+ meta: {
1314
+ type: "" | "intercom" | "freshchat" | "zendesk";
1280
1315
  };
1281
1316
  } | {
1282
1317
  type: "dismiss";
@@ -1285,14 +1320,14 @@ export declare const SearchHelpDocsResponseV: t.TypeC<{
1285
1320
  } | {
1286
1321
  type: "questlist";
1287
1322
  value: number;
1288
- } | {
1289
- type: "step_back";
1290
1323
  } | {
1291
1324
  type: "nudge";
1292
1325
  value: number;
1293
1326
  } | {
1294
1327
  type: "go_to_step";
1295
1328
  value: number;
1329
+ } | {
1330
+ type: "step_back";
1296
1331
  } | ({
1297
1332
  type: "open_bar";
1298
1333
  } & {
@@ -1300,16 +1335,16 @@ export declare const SearchHelpDocsResponseV: t.TypeC<{
1300
1335
  categoryFilter?: number | undefined;
1301
1336
  }) | {
1302
1337
  type: "open_helphub";
1303
- } | {
1338
+ } | ({
1304
1339
  type: "open_copilot";
1305
- } | {
1306
- type: "no_action";
1307
- };
1340
+ } & {
1341
+ query?: string | undefined;
1342
+ });
1308
1343
  } & {} & {
1309
1344
  commandType?: "object" | "help" | "independent" | undefined;
1310
1345
  object?: string | undefined;
1311
1346
  hoverTooltip?: boolean | undefined;
1312
- operation?: "self" | "router" | "blank" | "help_hub" | undefined;
1347
+ operation?: "self" | "router" | "help_hub" | "blank" | undefined;
1313
1348
  metadata?: {
1314
1349
  [key: string]: unknown;
1315
1350
  } | undefined;
@@ -1402,8 +1437,8 @@ export declare const SearchHelpDocsResponseV: t.TypeC<{
1402
1437
  };
1403
1438
  tags: string[];
1404
1439
  availability_rules: (({
1405
- type: "url" | "element" | "amplitude" | "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";
1406
- operator: "includes" | "endsWith" | "startsWith" | "is" | "isTrue" | "isFalse" | "isTruthy" | "isFalsy" | "matchesRegex" | "isDefined" | "isNotDefined" | "classnameOnPage" | "idOnPage" | "selectorOnPage" | "classnameNotOnPage" | "idNotOnPage" | "selectorNotOnPage" | "doesNotInclude" | "isNot" | "isGreaterThan" | "isLessThan";
1440
+ type: "url" | "element" | "amplitude" | "context" | "user_property" | "event_property" | "hostname" | "executions" | "shortcuts" | "last_seen" | "first_seen" | "sessions" | "opens" | "deadends" | "heap" | "hubspot" | "device_type" | "ab_test" | "intent" | "help_doc_interaction" | "video_interaction" | "survey_response";
1441
+ operator: "includes" | "endsWith" | "startsWith" | "is" | "isInList" | "isNotInList" | "isTrue" | "isFalse" | "isTruthy" | "isFalsy" | "matchesRegex" | "isDefined" | "isNotDefined" | "classnameOnPage" | "idOnPage" | "selectorOnPage" | "classnameNotOnPage" | "idNotOnPage" | "selectorNotOnPage" | "doesNotInclude" | "isNot" | "isGreaterThan" | "isLessThan";
1407
1442
  } & {
1408
1443
  field?: string | undefined;
1409
1444
  value?: string | undefined;
@@ -1412,14 +1447,14 @@ export declare const SearchHelpDocsResponseV: t.TypeC<{
1412
1447
  }) | ({
1413
1448
  type: "nudge_interaction";
1414
1449
  operator: "is" | "isNot";
1415
- value: "completed" | "dismissed" | "viewed";
1450
+ value: "completed" | "viewed" | "dismissed";
1416
1451
  nudge_id: number;
1417
1452
  } & {
1418
1453
  reason?: string | undefined;
1419
1454
  }) | ({
1420
1455
  type: "questlist_interaction";
1421
1456
  operator: "is" | "isNot";
1422
- value: "completed" | "dismissed" | "viewed";
1457
+ value: "completed" | "viewed" | "dismissed";
1423
1458
  questlist_id: number;
1424
1459
  } & {
1425
1460
  reason?: string | undefined;
@@ -1431,8 +1466,8 @@ export declare const SearchHelpDocsResponseV: t.TypeC<{
1431
1466
  reason?: string | undefined;
1432
1467
  }))[];
1433
1468
  recommend_rules: (({
1434
- type: "url" | "element" | "amplitude" | "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";
1435
- operator: "includes" | "endsWith" | "startsWith" | "is" | "isTrue" | "isFalse" | "isTruthy" | "isFalsy" | "matchesRegex" | "isDefined" | "isNotDefined" | "classnameOnPage" | "idOnPage" | "selectorOnPage" | "classnameNotOnPage" | "idNotOnPage" | "selectorNotOnPage" | "doesNotInclude" | "isNot" | "isGreaterThan" | "isLessThan";
1469
+ type: "url" | "element" | "amplitude" | "context" | "user_property" | "event_property" | "hostname" | "executions" | "shortcuts" | "last_seen" | "first_seen" | "sessions" | "opens" | "deadends" | "heap" | "hubspot" | "device_type" | "ab_test" | "intent" | "help_doc_interaction" | "video_interaction" | "survey_response";
1470
+ operator: "includes" | "endsWith" | "startsWith" | "is" | "isInList" | "isNotInList" | "isTrue" | "isFalse" | "isTruthy" | "isFalsy" | "matchesRegex" | "isDefined" | "isNotDefined" | "classnameOnPage" | "idOnPage" | "selectorOnPage" | "classnameNotOnPage" | "idNotOnPage" | "selectorNotOnPage" | "doesNotInclude" | "isNot" | "isGreaterThan" | "isLessThan";
1436
1471
  } & {
1437
1472
  field?: string | undefined;
1438
1473
  value?: string | undefined;
@@ -1441,14 +1476,14 @@ export declare const SearchHelpDocsResponseV: t.TypeC<{
1441
1476
  }) | ({
1442
1477
  type: "nudge_interaction";
1443
1478
  operator: "is" | "isNot";
1444
- value: "completed" | "dismissed" | "viewed";
1479
+ value: "completed" | "viewed" | "dismissed";
1445
1480
  nudge_id: number;
1446
1481
  } & {
1447
1482
  reason?: string | undefined;
1448
1483
  }) | ({
1449
1484
  type: "questlist_interaction";
1450
1485
  operator: "is" | "isNot";
1451
- value: "completed" | "dismissed" | "viewed";
1486
+ value: "completed" | "viewed" | "dismissed";
1452
1487
  questlist_id: number;
1453
1488
  } & {
1454
1489
  reason?: string | undefined;
@@ -1515,23 +1550,23 @@ export declare const SearchHelpDocsResponseV: t.TypeC<{
1515
1550
  hotkey_mac: string;
1516
1551
  hotkey_win: string;
1517
1552
  detail: string | ({
1518
- type: "html" | "video" | "plaintext" | "markdown" | "component" | "react";
1553
+ type: "html" | "video" | "plaintext" | "markdown" | "react" | "component";
1519
1554
  value: string;
1520
1555
  } & {
1521
1556
  position?: "inline" | "popover" | undefined;
1522
1557
  }) | (string | ({
1523
- type: "html" | "video" | "plaintext" | "markdown" | "component" | "react";
1558
+ type: "html" | "video" | "plaintext" | "markdown" | "react" | "component";
1524
1559
  value: string;
1525
1560
  } & {
1526
1561
  position?: "inline" | "popover" | undefined;
1527
1562
  }))[] | null;
1528
1563
  content: string | ({
1529
- type: "html" | "video" | "plaintext" | "markdown" | "component" | "react";
1564
+ type: "html" | "video" | "plaintext" | "markdown" | "react" | "component";
1530
1565
  value: string;
1531
1566
  } & {
1532
1567
  position?: "inline" | "popover" | undefined;
1533
1568
  }) | (string | ({
1534
- type: "html" | "video" | "plaintext" | "markdown" | "component" | "react";
1569
+ type: "html" | "video" | "plaintext" | "markdown" | "react" | "component";
1535
1570
  value: string;
1536
1571
  } & {
1537
1572
  position?: "inline" | "popover" | undefined;
@@ -1539,31 +1574,38 @@ export declare const SearchHelpDocsResponseV: t.TypeC<{
1539
1574
  show_preview: boolean;
1540
1575
  next_steps: (string | number | {
1541
1576
  cta: string;
1542
- action: {
1577
+ action: ({
1578
+ type: "link";
1579
+ value: string;
1580
+ } & {
1581
+ operation?: "self" | "router" | "blank" | undefined;
1582
+ meta?: {
1583
+ command: string;
1584
+ } | undefined;
1585
+ }) | {
1586
+ type: "click" | "clickBySelector" | "clickByXpath";
1587
+ value: string[];
1588
+ } | {
1543
1589
  type: "execute_command";
1544
1590
  meta: {
1545
1591
  command: string;
1546
1592
  } & {
1547
1593
  type?: "link" | "video" | "action" | "helpdoc" | undefined;
1548
1594
  };
1595
+ } | {
1596
+ type: "no_action";
1549
1597
  } | {
1550
1598
  type: "click";
1551
1599
  value: string;
1552
1600
  } | {
1553
- type: "click" | "clickBySelector" | "clickByXpath";
1554
- value: string[];
1555
- } | ({
1556
- type: "link";
1557
- value: string;
1558
- } & {
1559
- operation?: "self" | "router" | "blank" | undefined;
1560
- meta?: {
1561
- command: string;
1562
- } | undefined;
1563
- }) | {
1564
1601
  type: "open_chat";
1565
1602
  meta: {
1566
- type: "" | "intercom" | "helpscout" | "freshdesk" | "freshchat" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "hubspot" | "drift" | "pylon" | "zendesk_handoff";
1603
+ type: "" | "hubspot" | "intercom" | "helpscout" | "freshdesk" | "freshchat" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "drift" | "pylon" | "zendesk_handoff";
1604
+ };
1605
+ } | {
1606
+ type: "chat_handoff";
1607
+ meta: {
1608
+ type: "" | "intercom" | "freshchat" | "zendesk";
1567
1609
  };
1568
1610
  } | {
1569
1611
  type: "dismiss";
@@ -1572,14 +1614,14 @@ export declare const SearchHelpDocsResponseV: t.TypeC<{
1572
1614
  } | {
1573
1615
  type: "questlist";
1574
1616
  value: number;
1575
- } | {
1576
- type: "step_back";
1577
1617
  } | {
1578
1618
  type: "nudge";
1579
1619
  value: number;
1580
1620
  } | {
1581
1621
  type: "go_to_step";
1582
1622
  value: number;
1623
+ } | {
1624
+ type: "step_back";
1583
1625
  } | ({
1584
1626
  type: "open_bar";
1585
1627
  } & {
@@ -1587,11 +1629,11 @@ export declare const SearchHelpDocsResponseV: t.TypeC<{
1587
1629
  categoryFilter?: number | undefined;
1588
1630
  }) | {
1589
1631
  type: "open_helphub";
1590
- } | {
1632
+ } | ({
1591
1633
  type: "open_copilot";
1592
- } | {
1593
- type: "no_action";
1594
- };
1634
+ } & {
1635
+ query?: string | undefined;
1636
+ });
1595
1637
  })[];
1596
1638
  extra: string | null;
1597
1639
  thumbnail: {
@@ -1631,40 +1673,40 @@ export declare const SearchHelpDocsResponseV: t.TypeC<{
1631
1673
  id: number;
1632
1674
  text: string;
1633
1675
  template: ({
1634
- type: "admin";
1676
+ type: "callback";
1635
1677
  value: string;
1636
1678
  } & {} & {
1637
1679
  commandType?: "object" | "help" | "independent" | undefined;
1638
1680
  object?: string | undefined;
1639
1681
  hoverTooltip?: boolean | undefined;
1640
- operation?: "self" | "router" | "blank" | "help_hub" | undefined;
1682
+ operation?: "self" | "router" | "help_hub" | "blank" | undefined;
1641
1683
  metadata?: {
1642
1684
  [key: string]: unknown;
1643
1685
  } | undefined;
1644
1686
  }) | ({
1645
- type: "callback";
1687
+ type: "link";
1646
1688
  value: string;
1689
+ } & {
1690
+ operation?: "self" | "router" | "blank" | undefined;
1691
+ meta?: {
1692
+ command: string;
1693
+ } | undefined;
1647
1694
  } & {} & {
1648
1695
  commandType?: "object" | "help" | "independent" | undefined;
1649
1696
  object?: string | undefined;
1650
1697
  hoverTooltip?: boolean | undefined;
1651
- operation?: "self" | "router" | "blank" | "help_hub" | undefined;
1698
+ operation?: "self" | "router" | "help_hub" | "blank" | undefined;
1652
1699
  metadata?: {
1653
1700
  [key: string]: unknown;
1654
1701
  } | undefined;
1655
1702
  }) | ({
1656
- type: "link";
1703
+ type: "webhook";
1657
1704
  value: string;
1658
- } & {
1659
- operation?: "self" | "router" | "blank" | undefined;
1660
- meta?: {
1661
- command: string;
1662
- } | undefined;
1663
1705
  } & {} & {
1664
1706
  commandType?: "object" | "help" | "independent" | undefined;
1665
1707
  object?: string | undefined;
1666
1708
  hoverTooltip?: boolean | undefined;
1667
- operation?: "self" | "router" | "blank" | "help_hub" | undefined;
1709
+ operation?: "self" | "router" | "help_hub" | "blank" | undefined;
1668
1710
  metadata?: {
1669
1711
  [key: string]: unknown;
1670
1712
  } | undefined;
@@ -1675,146 +1717,153 @@ export declare const SearchHelpDocsResponseV: t.TypeC<{
1675
1717
  commandType?: "object" | "help" | "independent" | undefined;
1676
1718
  object?: string | undefined;
1677
1719
  hoverTooltip?: boolean | undefined;
1678
- operation?: "self" | "router" | "blank" | "help_hub" | undefined;
1720
+ operation?: "self" | "router" | "help_hub" | "blank" | undefined;
1679
1721
  metadata?: {
1680
1722
  [key: string]: unknown;
1681
1723
  } | undefined;
1682
1724
  }) | ({
1683
- type: "builtin";
1684
- value: string;
1725
+ type: "request";
1726
+ value: {
1727
+ method: "head" | "options" | "get" | "delete" | "post" | "put" | "patch";
1728
+ url: string;
1729
+ } & {
1730
+ headers?: {
1731
+ [key: string]: unknown;
1732
+ } | undefined;
1733
+ body?: {
1734
+ [key: string]: unknown;
1735
+ } | undefined;
1736
+ onSend?: string | undefined;
1737
+ onSuccess?: string | undefined;
1738
+ onError?: string | undefined;
1739
+ };
1685
1740
  } & {} & {
1686
1741
  commandType?: "object" | "help" | "independent" | undefined;
1687
1742
  object?: string | undefined;
1688
1743
  hoverTooltip?: boolean | undefined;
1689
- operation?: "self" | "router" | "blank" | "help_hub" | undefined;
1744
+ operation?: "self" | "router" | "help_hub" | "blank" | undefined;
1690
1745
  metadata?: {
1691
1746
  [key: string]: unknown;
1692
1747
  } | undefined;
1693
1748
  }) | ({
1694
- type: "webhook";
1749
+ type: "appcues";
1695
1750
  value: string;
1696
1751
  } & {} & {
1697
1752
  commandType?: "object" | "help" | "independent" | undefined;
1698
1753
  object?: string | undefined;
1699
1754
  hoverTooltip?: boolean | undefined;
1700
- operation?: "self" | "router" | "blank" | "help_hub" | undefined;
1755
+ operation?: "self" | "router" | "help_hub" | "blank" | undefined;
1701
1756
  metadata?: {
1702
1757
  [key: string]: unknown;
1703
1758
  } | undefined;
1704
1759
  }) | ({
1705
- type: "script";
1760
+ type: "pendo_guide";
1706
1761
  value: string;
1707
1762
  } & {} & {
1708
1763
  commandType?: "object" | "help" | "independent" | undefined;
1709
1764
  object?: string | undefined;
1710
1765
  hoverTooltip?: boolean | undefined;
1711
- operation?: "self" | "router" | "blank" | "help_hub" | undefined;
1712
- metadata?: {
1713
- [key: string]: unknown;
1714
- } | undefined;
1715
- }) | ({
1716
- type: "request";
1717
- value: {
1718
- method: "head" | "options" | "get" | "post" | "put" | "delete" | "patch";
1719
- url: string;
1720
- } & {
1721
- headers?: {
1722
- [key: string]: unknown;
1723
- } | undefined;
1724
- body?: {
1725
- [key: string]: unknown;
1726
- } | undefined;
1727
- onSend?: string | undefined;
1728
- onSuccess?: string | undefined;
1729
- onError?: string | undefined;
1730
- };
1766
+ operation?: "self" | "router" | "help_hub" | "blank" | undefined;
1767
+ metadata?: {
1768
+ [key: string]: unknown;
1769
+ } | undefined;
1770
+ }) | ({
1771
+ type: "helpdoc";
1772
+ value: string;
1773
+ } & {
1774
+ operation?: "self" | "router" | "help_hub" | "blank" | undefined;
1775
+ doc_metadata?: {
1776
+ content_type?: string | undefined;
1777
+ date?: string | undefined;
1778
+ } | undefined;
1779
+ } & {
1780
+ doc_type?: "answer" | "doc" | undefined;
1731
1781
  } & {} & {
1732
1782
  commandType?: "object" | "help" | "independent" | undefined;
1733
1783
  object?: string | undefined;
1734
1784
  hoverTooltip?: boolean | undefined;
1735
- operation?: "self" | "router" | "blank" | "help_hub" | undefined;
1785
+ operation?: "self" | "router" | "help_hub" | "blank" | undefined;
1736
1786
  metadata?: {
1737
1787
  [key: string]: unknown;
1738
1788
  } | undefined;
1739
1789
  }) | ({
1740
- type: "appcues";
1790
+ type: "admin";
1741
1791
  value: string;
1742
1792
  } & {} & {
1743
1793
  commandType?: "object" | "help" | "independent" | undefined;
1744
1794
  object?: string | undefined;
1745
1795
  hoverTooltip?: boolean | undefined;
1746
- operation?: "self" | "router" | "blank" | "help_hub" | undefined;
1796
+ operation?: "self" | "router" | "help_hub" | "blank" | undefined;
1747
1797
  metadata?: {
1748
1798
  [key: string]: unknown;
1749
1799
  } | undefined;
1750
1800
  }) | ({
1751
- type: "pendo_guide";
1801
+ type: "builtin";
1752
1802
  value: string;
1753
1803
  } & {} & {
1754
1804
  commandType?: "object" | "help" | "independent" | undefined;
1755
1805
  object?: string | undefined;
1756
1806
  hoverTooltip?: boolean | undefined;
1757
- operation?: "self" | "router" | "blank" | "help_hub" | undefined;
1807
+ operation?: "self" | "router" | "help_hub" | "blank" | undefined;
1758
1808
  metadata?: {
1759
1809
  [key: string]: unknown;
1760
1810
  } | undefined;
1761
1811
  }) | ({
1762
- type: "video";
1812
+ type: "script";
1763
1813
  value: string;
1764
1814
  } & {} & {
1765
1815
  commandType?: "object" | "help" | "independent" | undefined;
1766
1816
  object?: string | undefined;
1767
1817
  hoverTooltip?: boolean | undefined;
1768
- operation?: "self" | "router" | "blank" | "help_hub" | undefined;
1818
+ operation?: "self" | "router" | "help_hub" | "blank" | undefined;
1769
1819
  metadata?: {
1770
1820
  [key: string]: unknown;
1771
1821
  } | undefined;
1772
1822
  }) | ({
1773
- type: "helpdoc";
1823
+ type: "video";
1774
1824
  value: string;
1775
- } & {
1776
- operation?: "self" | "router" | "blank" | "help_hub" | undefined;
1777
- doc_metadata?: {
1778
- content_type?: string | undefined;
1779
- date?: string | undefined;
1780
- } | undefined;
1781
- } & {
1782
- doc_type?: "answer" | "doc" | undefined;
1783
1825
  } & {} & {
1784
1826
  commandType?: "object" | "help" | "independent" | undefined;
1785
1827
  object?: string | undefined;
1786
1828
  hoverTooltip?: boolean | undefined;
1787
- operation?: "self" | "router" | "blank" | "help_hub" | undefined;
1829
+ operation?: "self" | "router" | "help_hub" | "blank" | undefined;
1788
1830
  metadata?: {
1789
1831
  [key: string]: unknown;
1790
1832
  } | undefined;
1791
1833
  }) | ({
1792
1834
  type: "trigger";
1793
- value: {
1835
+ value: ({
1836
+ type: "link";
1837
+ value: string;
1838
+ } & {
1839
+ operation?: "self" | "router" | "blank" | undefined;
1840
+ meta?: {
1841
+ command: string;
1842
+ } | undefined;
1843
+ }) | {
1844
+ type: "click" | "clickBySelector" | "clickByXpath";
1845
+ value: string[];
1846
+ } | {
1794
1847
  type: "execute_command";
1795
1848
  meta: {
1796
1849
  command: string;
1797
1850
  } & {
1798
1851
  type?: "link" | "video" | "action" | "helpdoc" | undefined;
1799
1852
  };
1853
+ } | {
1854
+ type: "no_action";
1800
1855
  } | {
1801
1856
  type: "click";
1802
1857
  value: string;
1803
1858
  } | {
1804
- type: "click" | "clickBySelector" | "clickByXpath";
1805
- value: string[];
1806
- } | ({
1807
- type: "link";
1808
- value: string;
1809
- } & {
1810
- operation?: "self" | "router" | "blank" | undefined;
1811
- meta?: {
1812
- command: string;
1813
- } | undefined;
1814
- }) | {
1815
1859
  type: "open_chat";
1816
1860
  meta: {
1817
- type: "" | "intercom" | "helpscout" | "freshdesk" | "freshchat" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "hubspot" | "drift" | "pylon" | "zendesk_handoff";
1861
+ type: "" | "hubspot" | "intercom" | "helpscout" | "freshdesk" | "freshchat" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "drift" | "pylon" | "zendesk_handoff";
1862
+ };
1863
+ } | {
1864
+ type: "chat_handoff";
1865
+ meta: {
1866
+ type: "" | "intercom" | "freshchat" | "zendesk";
1818
1867
  };
1819
1868
  } | {
1820
1869
  type: "dismiss";
@@ -1823,14 +1872,14 @@ export declare const SearchHelpDocsResponseV: t.TypeC<{
1823
1872
  } | {
1824
1873
  type: "questlist";
1825
1874
  value: number;
1826
- } | {
1827
- type: "step_back";
1828
1875
  } | {
1829
1876
  type: "nudge";
1830
1877
  value: number;
1831
1878
  } | {
1832
1879
  type: "go_to_step";
1833
1880
  value: number;
1881
+ } | {
1882
+ type: "step_back";
1834
1883
  } | ({
1835
1884
  type: "open_bar";
1836
1885
  } & {
@@ -1838,16 +1887,16 @@ export declare const SearchHelpDocsResponseV: t.TypeC<{
1838
1887
  categoryFilter?: number | undefined;
1839
1888
  }) | {
1840
1889
  type: "open_helphub";
1841
- } | {
1890
+ } | ({
1842
1891
  type: "open_copilot";
1843
- } | {
1844
- type: "no_action";
1845
- };
1892
+ } & {
1893
+ query?: string | undefined;
1894
+ });
1846
1895
  } & {} & {
1847
1896
  commandType?: "object" | "help" | "independent" | undefined;
1848
1897
  object?: string | undefined;
1849
1898
  hoverTooltip?: boolean | undefined;
1850
- operation?: "self" | "router" | "blank" | "help_hub" | undefined;
1899
+ operation?: "self" | "router" | "help_hub" | "blank" | undefined;
1851
1900
  metadata?: {
1852
1901
  [key: string]: unknown;
1853
1902
  } | undefined;
@@ -1940,8 +1989,8 @@ export declare const SearchHelpDocsResponseV: t.TypeC<{
1940
1989
  };
1941
1990
  tags: string[];
1942
1991
  availability_rules: (({
1943
- type: "url" | "element" | "amplitude" | "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";
1944
- operator: "includes" | "endsWith" | "startsWith" | "is" | "isTrue" | "isFalse" | "isTruthy" | "isFalsy" | "matchesRegex" | "isDefined" | "isNotDefined" | "classnameOnPage" | "idOnPage" | "selectorOnPage" | "classnameNotOnPage" | "idNotOnPage" | "selectorNotOnPage" | "doesNotInclude" | "isNot" | "isGreaterThan" | "isLessThan";
1992
+ type: "url" | "element" | "amplitude" | "context" | "user_property" | "event_property" | "hostname" | "executions" | "shortcuts" | "last_seen" | "first_seen" | "sessions" | "opens" | "deadends" | "heap" | "hubspot" | "device_type" | "ab_test" | "intent" | "help_doc_interaction" | "video_interaction" | "survey_response";
1993
+ operator: "includes" | "endsWith" | "startsWith" | "is" | "isInList" | "isNotInList" | "isTrue" | "isFalse" | "isTruthy" | "isFalsy" | "matchesRegex" | "isDefined" | "isNotDefined" | "classnameOnPage" | "idOnPage" | "selectorOnPage" | "classnameNotOnPage" | "idNotOnPage" | "selectorNotOnPage" | "doesNotInclude" | "isNot" | "isGreaterThan" | "isLessThan";
1945
1994
  } & {
1946
1995
  field?: string | undefined;
1947
1996
  value?: string | undefined;
@@ -1950,14 +1999,14 @@ export declare const SearchHelpDocsResponseV: t.TypeC<{
1950
1999
  }) | ({
1951
2000
  type: "nudge_interaction";
1952
2001
  operator: "is" | "isNot";
1953
- value: "completed" | "dismissed" | "viewed";
2002
+ value: "completed" | "viewed" | "dismissed";
1954
2003
  nudge_id: number;
1955
2004
  } & {
1956
2005
  reason?: string | undefined;
1957
2006
  }) | ({
1958
2007
  type: "questlist_interaction";
1959
2008
  operator: "is" | "isNot";
1960
- value: "completed" | "dismissed" | "viewed";
2009
+ value: "completed" | "viewed" | "dismissed";
1961
2010
  questlist_id: number;
1962
2011
  } & {
1963
2012
  reason?: string | undefined;
@@ -1969,8 +2018,8 @@ export declare const SearchHelpDocsResponseV: t.TypeC<{
1969
2018
  reason?: string | undefined;
1970
2019
  }))[];
1971
2020
  recommend_rules: (({
1972
- type: "url" | "element" | "amplitude" | "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";
1973
- operator: "includes" | "endsWith" | "startsWith" | "is" | "isTrue" | "isFalse" | "isTruthy" | "isFalsy" | "matchesRegex" | "isDefined" | "isNotDefined" | "classnameOnPage" | "idOnPage" | "selectorOnPage" | "classnameNotOnPage" | "idNotOnPage" | "selectorNotOnPage" | "doesNotInclude" | "isNot" | "isGreaterThan" | "isLessThan";
2021
+ type: "url" | "element" | "amplitude" | "context" | "user_property" | "event_property" | "hostname" | "executions" | "shortcuts" | "last_seen" | "first_seen" | "sessions" | "opens" | "deadends" | "heap" | "hubspot" | "device_type" | "ab_test" | "intent" | "help_doc_interaction" | "video_interaction" | "survey_response";
2022
+ operator: "includes" | "endsWith" | "startsWith" | "is" | "isInList" | "isNotInList" | "isTrue" | "isFalse" | "isTruthy" | "isFalsy" | "matchesRegex" | "isDefined" | "isNotDefined" | "classnameOnPage" | "idOnPage" | "selectorOnPage" | "classnameNotOnPage" | "idNotOnPage" | "selectorNotOnPage" | "doesNotInclude" | "isNot" | "isGreaterThan" | "isLessThan";
1974
2023
  } & {
1975
2024
  field?: string | undefined;
1976
2025
  value?: string | undefined;
@@ -1979,14 +2028,14 @@ export declare const SearchHelpDocsResponseV: t.TypeC<{
1979
2028
  }) | ({
1980
2029
  type: "nudge_interaction";
1981
2030
  operator: "is" | "isNot";
1982
- value: "completed" | "dismissed" | "viewed";
2031
+ value: "completed" | "viewed" | "dismissed";
1983
2032
  nudge_id: number;
1984
2033
  } & {
1985
2034
  reason?: string | undefined;
1986
2035
  }) | ({
1987
2036
  type: "questlist_interaction";
1988
2037
  operator: "is" | "isNot";
1989
- value: "completed" | "dismissed" | "viewed";
2038
+ value: "completed" | "viewed" | "dismissed";
1990
2039
  questlist_id: number;
1991
2040
  } & {
1992
2041
  reason?: string | undefined;
@@ -2053,23 +2102,23 @@ export declare const SearchHelpDocsResponseV: t.TypeC<{
2053
2102
  hotkey_mac: string;
2054
2103
  hotkey_win: string;
2055
2104
  detail: string | ({
2056
- type: "html" | "video" | "plaintext" | "markdown" | "component" | "react";
2105
+ type: "html" | "video" | "plaintext" | "markdown" | "react" | "component";
2057
2106
  value: string;
2058
2107
  } & {
2059
2108
  position?: "inline" | "popover" | undefined;
2060
2109
  }) | (string | ({
2061
- type: "html" | "video" | "plaintext" | "markdown" | "component" | "react";
2110
+ type: "html" | "video" | "plaintext" | "markdown" | "react" | "component";
2062
2111
  value: string;
2063
2112
  } & {
2064
2113
  position?: "inline" | "popover" | undefined;
2065
2114
  }))[] | null;
2066
2115
  content: string | ({
2067
- type: "html" | "video" | "plaintext" | "markdown" | "component" | "react";
2116
+ type: "html" | "video" | "plaintext" | "markdown" | "react" | "component";
2068
2117
  value: string;
2069
2118
  } & {
2070
2119
  position?: "inline" | "popover" | undefined;
2071
2120
  }) | (string | ({
2072
- type: "html" | "video" | "plaintext" | "markdown" | "component" | "react";
2121
+ type: "html" | "video" | "plaintext" | "markdown" | "react" | "component";
2073
2122
  value: string;
2074
2123
  } & {
2075
2124
  position?: "inline" | "popover" | undefined;
@@ -2077,31 +2126,38 @@ export declare const SearchHelpDocsResponseV: t.TypeC<{
2077
2126
  show_preview: boolean;
2078
2127
  next_steps: (string | number | {
2079
2128
  cta: string;
2080
- action: {
2129
+ action: ({
2130
+ type: "link";
2131
+ value: string;
2132
+ } & {
2133
+ operation?: "self" | "router" | "blank" | undefined;
2134
+ meta?: {
2135
+ command: string;
2136
+ } | undefined;
2137
+ }) | {
2138
+ type: "click" | "clickBySelector" | "clickByXpath";
2139
+ value: string[];
2140
+ } | {
2081
2141
  type: "execute_command";
2082
2142
  meta: {
2083
2143
  command: string;
2084
2144
  } & {
2085
2145
  type?: "link" | "video" | "action" | "helpdoc" | undefined;
2086
2146
  };
2147
+ } | {
2148
+ type: "no_action";
2087
2149
  } | {
2088
2150
  type: "click";
2089
2151
  value: string;
2090
2152
  } | {
2091
- type: "click" | "clickBySelector" | "clickByXpath";
2092
- value: string[];
2093
- } | ({
2094
- type: "link";
2095
- value: string;
2096
- } & {
2097
- operation?: "self" | "router" | "blank" | undefined;
2098
- meta?: {
2099
- command: string;
2100
- } | undefined;
2101
- }) | {
2102
2153
  type: "open_chat";
2103
2154
  meta: {
2104
- type: "" | "intercom" | "helpscout" | "freshdesk" | "freshchat" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "hubspot" | "drift" | "pylon" | "zendesk_handoff";
2155
+ type: "" | "hubspot" | "intercom" | "helpscout" | "freshdesk" | "freshchat" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "drift" | "pylon" | "zendesk_handoff";
2156
+ };
2157
+ } | {
2158
+ type: "chat_handoff";
2159
+ meta: {
2160
+ type: "" | "intercom" | "freshchat" | "zendesk";
2105
2161
  };
2106
2162
  } | {
2107
2163
  type: "dismiss";
@@ -2110,14 +2166,14 @@ export declare const SearchHelpDocsResponseV: t.TypeC<{
2110
2166
  } | {
2111
2167
  type: "questlist";
2112
2168
  value: number;
2113
- } | {
2114
- type: "step_back";
2115
2169
  } | {
2116
2170
  type: "nudge";
2117
2171
  value: number;
2118
2172
  } | {
2119
2173
  type: "go_to_step";
2120
2174
  value: number;
2175
+ } | {
2176
+ type: "step_back";
2121
2177
  } | ({
2122
2178
  type: "open_bar";
2123
2179
  } & {
@@ -2125,11 +2181,11 @@ export declare const SearchHelpDocsResponseV: t.TypeC<{
2125
2181
  categoryFilter?: number | undefined;
2126
2182
  }) | {
2127
2183
  type: "open_helphub";
2128
- } | {
2184
+ } | ({
2129
2185
  type: "open_copilot";
2130
- } | {
2131
- type: "no_action";
2132
- };
2186
+ } & {
2187
+ query?: string | undefined;
2188
+ });
2133
2189
  })[];
2134
2190
  extra: string | null;
2135
2191
  thumbnail: {
@@ -2188,40 +2244,40 @@ export declare class HelpDocsSearch {
2188
2244
  id: number;
2189
2245
  text: string;
2190
2246
  template: ({
2191
- type: "admin";
2247
+ type: "callback";
2192
2248
  value: string;
2193
2249
  } & {} & {
2194
2250
  commandType?: "object" | "help" | "independent" | undefined;
2195
2251
  object?: string | undefined;
2196
2252
  hoverTooltip?: boolean | undefined;
2197
- operation?: "self" | "router" | "blank" | "help_hub" | undefined;
2253
+ operation?: "self" | "router" | "help_hub" | "blank" | undefined;
2198
2254
  metadata?: {
2199
2255
  [key: string]: unknown;
2200
2256
  } | undefined;
2201
2257
  }) | ({
2202
- type: "callback";
2258
+ type: "link";
2203
2259
  value: string;
2260
+ } & {
2261
+ operation?: "self" | "router" | "blank" | undefined;
2262
+ meta?: {
2263
+ command: string;
2264
+ } | undefined;
2204
2265
  } & {} & {
2205
2266
  commandType?: "object" | "help" | "independent" | undefined;
2206
2267
  object?: string | undefined;
2207
2268
  hoverTooltip?: boolean | undefined;
2208
- operation?: "self" | "router" | "blank" | "help_hub" | undefined;
2269
+ operation?: "self" | "router" | "help_hub" | "blank" | undefined;
2209
2270
  metadata?: {
2210
2271
  [key: string]: unknown;
2211
2272
  } | undefined;
2212
2273
  }) | ({
2213
- type: "link";
2274
+ type: "webhook";
2214
2275
  value: string;
2215
- } & {
2216
- operation?: "self" | "router" | "blank" | undefined;
2217
- meta?: {
2218
- command: string;
2219
- } | undefined;
2220
2276
  } & {} & {
2221
2277
  commandType?: "object" | "help" | "independent" | undefined;
2222
2278
  object?: string | undefined;
2223
2279
  hoverTooltip?: boolean | undefined;
2224
- operation?: "self" | "router" | "blank" | "help_hub" | undefined;
2280
+ operation?: "self" | "router" | "help_hub" | "blank" | undefined;
2225
2281
  metadata?: {
2226
2282
  [key: string]: unknown;
2227
2283
  } | undefined;
@@ -2232,146 +2288,153 @@ export declare class HelpDocsSearch {
2232
2288
  commandType?: "object" | "help" | "independent" | undefined;
2233
2289
  object?: string | undefined;
2234
2290
  hoverTooltip?: boolean | undefined;
2235
- operation?: "self" | "router" | "blank" | "help_hub" | undefined;
2291
+ operation?: "self" | "router" | "help_hub" | "blank" | undefined;
2236
2292
  metadata?: {
2237
2293
  [key: string]: unknown;
2238
2294
  } | undefined;
2239
2295
  }) | ({
2240
- type: "builtin";
2241
- value: string;
2296
+ type: "request";
2297
+ value: {
2298
+ method: "head" | "options" | "get" | "delete" | "post" | "put" | "patch";
2299
+ url: string;
2300
+ } & {
2301
+ headers?: {
2302
+ [key: string]: unknown;
2303
+ } | undefined;
2304
+ body?: {
2305
+ [key: string]: unknown;
2306
+ } | undefined;
2307
+ onSend?: string | undefined;
2308
+ onSuccess?: string | undefined;
2309
+ onError?: string | undefined;
2310
+ };
2242
2311
  } & {} & {
2243
2312
  commandType?: "object" | "help" | "independent" | undefined;
2244
2313
  object?: string | undefined;
2245
2314
  hoverTooltip?: boolean | undefined;
2246
- operation?: "self" | "router" | "blank" | "help_hub" | undefined;
2315
+ operation?: "self" | "router" | "help_hub" | "blank" | undefined;
2247
2316
  metadata?: {
2248
2317
  [key: string]: unknown;
2249
2318
  } | undefined;
2250
2319
  }) | ({
2251
- type: "webhook";
2320
+ type: "appcues";
2252
2321
  value: string;
2253
2322
  } & {} & {
2254
2323
  commandType?: "object" | "help" | "independent" | undefined;
2255
2324
  object?: string | undefined;
2256
2325
  hoverTooltip?: boolean | undefined;
2257
- operation?: "self" | "router" | "blank" | "help_hub" | undefined;
2326
+ operation?: "self" | "router" | "help_hub" | "blank" | undefined;
2258
2327
  metadata?: {
2259
2328
  [key: string]: unknown;
2260
2329
  } | undefined;
2261
2330
  }) | ({
2262
- type: "script";
2331
+ type: "pendo_guide";
2263
2332
  value: string;
2264
2333
  } & {} & {
2265
2334
  commandType?: "object" | "help" | "independent" | undefined;
2266
2335
  object?: string | undefined;
2267
2336
  hoverTooltip?: boolean | undefined;
2268
- operation?: "self" | "router" | "blank" | "help_hub" | undefined;
2337
+ operation?: "self" | "router" | "help_hub" | "blank" | undefined;
2269
2338
  metadata?: {
2270
2339
  [key: string]: unknown;
2271
2340
  } | undefined;
2272
2341
  }) | ({
2273
- type: "request";
2274
- value: {
2275
- method: "head" | "options" | "get" | "post" | "put" | "delete" | "patch";
2276
- url: string;
2277
- } & {
2278
- headers?: {
2279
- [key: string]: unknown;
2280
- } | undefined;
2281
- body?: {
2282
- [key: string]: unknown;
2283
- } | undefined;
2284
- onSend?: string | undefined;
2285
- onSuccess?: string | undefined;
2286
- onError?: string | undefined;
2287
- };
2342
+ type: "helpdoc";
2343
+ value: string;
2344
+ } & {
2345
+ operation?: "self" | "router" | "help_hub" | "blank" | undefined;
2346
+ doc_metadata?: {
2347
+ content_type?: string | undefined;
2348
+ date?: string | undefined;
2349
+ } | undefined;
2350
+ } & {
2351
+ doc_type?: "answer" | "doc" | undefined;
2288
2352
  } & {} & {
2289
2353
  commandType?: "object" | "help" | "independent" | undefined;
2290
2354
  object?: string | undefined;
2291
2355
  hoverTooltip?: boolean | undefined;
2292
- operation?: "self" | "router" | "blank" | "help_hub" | undefined;
2356
+ operation?: "self" | "router" | "help_hub" | "blank" | undefined;
2293
2357
  metadata?: {
2294
2358
  [key: string]: unknown;
2295
2359
  } | undefined;
2296
2360
  }) | ({
2297
- type: "appcues";
2361
+ type: "admin";
2298
2362
  value: string;
2299
2363
  } & {} & {
2300
2364
  commandType?: "object" | "help" | "independent" | undefined;
2301
2365
  object?: string | undefined;
2302
2366
  hoverTooltip?: boolean | undefined;
2303
- operation?: "self" | "router" | "blank" | "help_hub" | undefined;
2367
+ operation?: "self" | "router" | "help_hub" | "blank" | undefined;
2304
2368
  metadata?: {
2305
2369
  [key: string]: unknown;
2306
2370
  } | undefined;
2307
2371
  }) | ({
2308
- type: "pendo_guide";
2372
+ type: "builtin";
2309
2373
  value: string;
2310
2374
  } & {} & {
2311
2375
  commandType?: "object" | "help" | "independent" | undefined;
2312
2376
  object?: string | undefined;
2313
2377
  hoverTooltip?: boolean | undefined;
2314
- operation?: "self" | "router" | "blank" | "help_hub" | undefined;
2378
+ operation?: "self" | "router" | "help_hub" | "blank" | undefined;
2315
2379
  metadata?: {
2316
2380
  [key: string]: unknown;
2317
2381
  } | undefined;
2318
2382
  }) | ({
2319
- type: "video";
2383
+ type: "script";
2320
2384
  value: string;
2321
2385
  } & {} & {
2322
2386
  commandType?: "object" | "help" | "independent" | undefined;
2323
2387
  object?: string | undefined;
2324
2388
  hoverTooltip?: boolean | undefined;
2325
- operation?: "self" | "router" | "blank" | "help_hub" | undefined;
2389
+ operation?: "self" | "router" | "help_hub" | "blank" | undefined;
2326
2390
  metadata?: {
2327
2391
  [key: string]: unknown;
2328
2392
  } | undefined;
2329
2393
  }) | ({
2330
- type: "helpdoc";
2394
+ type: "video";
2331
2395
  value: string;
2332
- } & {
2333
- operation?: "self" | "router" | "blank" | "help_hub" | undefined;
2334
- doc_metadata?: {
2335
- content_type?: string | undefined;
2336
- date?: string | undefined;
2337
- } | undefined;
2338
- } & {
2339
- doc_type?: "answer" | "doc" | undefined;
2340
2396
  } & {} & {
2341
2397
  commandType?: "object" | "help" | "independent" | undefined;
2342
2398
  object?: string | undefined;
2343
2399
  hoverTooltip?: boolean | undefined;
2344
- operation?: "self" | "router" | "blank" | "help_hub" | undefined;
2400
+ operation?: "self" | "router" | "help_hub" | "blank" | undefined;
2345
2401
  metadata?: {
2346
2402
  [key: string]: unknown;
2347
2403
  } | undefined;
2348
2404
  }) | ({
2349
2405
  type: "trigger";
2350
- value: {
2406
+ value: ({
2407
+ type: "link";
2408
+ value: string;
2409
+ } & {
2410
+ operation?: "self" | "router" | "blank" | undefined;
2411
+ meta?: {
2412
+ command: string;
2413
+ } | undefined;
2414
+ }) | {
2415
+ type: "click" | "clickBySelector" | "clickByXpath";
2416
+ value: string[];
2417
+ } | {
2351
2418
  type: "execute_command";
2352
2419
  meta: {
2353
2420
  command: string;
2354
2421
  } & {
2355
2422
  type?: "link" | "video" | "action" | "helpdoc" | undefined;
2356
2423
  };
2424
+ } | {
2425
+ type: "no_action";
2357
2426
  } | {
2358
2427
  type: "click";
2359
2428
  value: string;
2360
2429
  } | {
2361
- type: "click" | "clickBySelector" | "clickByXpath";
2362
- value: string[];
2363
- } | ({
2364
- type: "link";
2365
- value: string;
2366
- } & {
2367
- operation?: "self" | "router" | "blank" | undefined;
2368
- meta?: {
2369
- command: string;
2370
- } | undefined;
2371
- }) | {
2372
2430
  type: "open_chat";
2373
2431
  meta: {
2374
- type: "" | "intercom" | "helpscout" | "freshdesk" | "freshchat" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "hubspot" | "drift" | "pylon" | "zendesk_handoff";
2432
+ type: "" | "hubspot" | "intercom" | "helpscout" | "freshdesk" | "freshchat" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "drift" | "pylon" | "zendesk_handoff";
2433
+ };
2434
+ } | {
2435
+ type: "chat_handoff";
2436
+ meta: {
2437
+ type: "" | "intercom" | "freshchat" | "zendesk";
2375
2438
  };
2376
2439
  } | {
2377
2440
  type: "dismiss";
@@ -2380,14 +2443,14 @@ export declare class HelpDocsSearch {
2380
2443
  } | {
2381
2444
  type: "questlist";
2382
2445
  value: number;
2383
- } | {
2384
- type: "step_back";
2385
2446
  } | {
2386
2447
  type: "nudge";
2387
2448
  value: number;
2388
2449
  } | {
2389
2450
  type: "go_to_step";
2390
2451
  value: number;
2452
+ } | {
2453
+ type: "step_back";
2391
2454
  } | ({
2392
2455
  type: "open_bar";
2393
2456
  } & {
@@ -2395,16 +2458,16 @@ export declare class HelpDocsSearch {
2395
2458
  categoryFilter?: number | undefined;
2396
2459
  }) | {
2397
2460
  type: "open_helphub";
2398
- } | {
2461
+ } | ({
2399
2462
  type: "open_copilot";
2400
- } | {
2401
- type: "no_action";
2402
- };
2463
+ } & {
2464
+ query?: string | undefined;
2465
+ });
2403
2466
  } & {} & {
2404
2467
  commandType?: "object" | "help" | "independent" | undefined;
2405
2468
  object?: string | undefined;
2406
2469
  hoverTooltip?: boolean | undefined;
2407
- operation?: "self" | "router" | "blank" | "help_hub" | undefined;
2470
+ operation?: "self" | "router" | "help_hub" | "blank" | undefined;
2408
2471
  metadata?: {
2409
2472
  [key: string]: unknown;
2410
2473
  } | undefined;
@@ -2497,8 +2560,8 @@ export declare class HelpDocsSearch {
2497
2560
  };
2498
2561
  tags: string[];
2499
2562
  availability_rules: (({
2500
- type: "url" | "element" | "amplitude" | "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";
2501
- operator: "includes" | "endsWith" | "startsWith" | "is" | "isTrue" | "isFalse" | "isTruthy" | "isFalsy" | "matchesRegex" | "isDefined" | "isNotDefined" | "classnameOnPage" | "idOnPage" | "selectorOnPage" | "classnameNotOnPage" | "idNotOnPage" | "selectorNotOnPage" | "doesNotInclude" | "isNot" | "isGreaterThan" | "isLessThan";
2563
+ type: "url" | "element" | "amplitude" | "context" | "user_property" | "event_property" | "hostname" | "executions" | "shortcuts" | "last_seen" | "first_seen" | "sessions" | "opens" | "deadends" | "heap" | "hubspot" | "device_type" | "ab_test" | "intent" | "help_doc_interaction" | "video_interaction" | "survey_response";
2564
+ operator: "includes" | "endsWith" | "startsWith" | "is" | "isInList" | "isNotInList" | "isTrue" | "isFalse" | "isTruthy" | "isFalsy" | "matchesRegex" | "isDefined" | "isNotDefined" | "classnameOnPage" | "idOnPage" | "selectorOnPage" | "classnameNotOnPage" | "idNotOnPage" | "selectorNotOnPage" | "doesNotInclude" | "isNot" | "isGreaterThan" | "isLessThan";
2502
2565
  } & {
2503
2566
  field?: string | undefined;
2504
2567
  value?: string | undefined;
@@ -2507,14 +2570,14 @@ export declare class HelpDocsSearch {
2507
2570
  }) | ({
2508
2571
  type: "nudge_interaction";
2509
2572
  operator: "is" | "isNot";
2510
- value: "completed" | "dismissed" | "viewed";
2573
+ value: "completed" | "viewed" | "dismissed";
2511
2574
  nudge_id: number;
2512
2575
  } & {
2513
2576
  reason?: string | undefined;
2514
2577
  }) | ({
2515
2578
  type: "questlist_interaction";
2516
2579
  operator: "is" | "isNot";
2517
- value: "completed" | "dismissed" | "viewed";
2580
+ value: "completed" | "viewed" | "dismissed";
2518
2581
  questlist_id: number;
2519
2582
  } & {
2520
2583
  reason?: string | undefined;
@@ -2526,8 +2589,8 @@ export declare class HelpDocsSearch {
2526
2589
  reason?: string | undefined;
2527
2590
  }))[];
2528
2591
  recommend_rules: (({
2529
- type: "url" | "element" | "amplitude" | "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";
2530
- operator: "includes" | "endsWith" | "startsWith" | "is" | "isTrue" | "isFalse" | "isTruthy" | "isFalsy" | "matchesRegex" | "isDefined" | "isNotDefined" | "classnameOnPage" | "idOnPage" | "selectorOnPage" | "classnameNotOnPage" | "idNotOnPage" | "selectorNotOnPage" | "doesNotInclude" | "isNot" | "isGreaterThan" | "isLessThan";
2592
+ type: "url" | "element" | "amplitude" | "context" | "user_property" | "event_property" | "hostname" | "executions" | "shortcuts" | "last_seen" | "first_seen" | "sessions" | "opens" | "deadends" | "heap" | "hubspot" | "device_type" | "ab_test" | "intent" | "help_doc_interaction" | "video_interaction" | "survey_response";
2593
+ operator: "includes" | "endsWith" | "startsWith" | "is" | "isInList" | "isNotInList" | "isTrue" | "isFalse" | "isTruthy" | "isFalsy" | "matchesRegex" | "isDefined" | "isNotDefined" | "classnameOnPage" | "idOnPage" | "selectorOnPage" | "classnameNotOnPage" | "idNotOnPage" | "selectorNotOnPage" | "doesNotInclude" | "isNot" | "isGreaterThan" | "isLessThan";
2531
2594
  } & {
2532
2595
  field?: string | undefined;
2533
2596
  value?: string | undefined;
@@ -2536,14 +2599,14 @@ export declare class HelpDocsSearch {
2536
2599
  }) | ({
2537
2600
  type: "nudge_interaction";
2538
2601
  operator: "is" | "isNot";
2539
- value: "completed" | "dismissed" | "viewed";
2602
+ value: "completed" | "viewed" | "dismissed";
2540
2603
  nudge_id: number;
2541
2604
  } & {
2542
2605
  reason?: string | undefined;
2543
2606
  }) | ({
2544
2607
  type: "questlist_interaction";
2545
2608
  operator: "is" | "isNot";
2546
- value: "completed" | "dismissed" | "viewed";
2609
+ value: "completed" | "viewed" | "dismissed";
2547
2610
  questlist_id: number;
2548
2611
  } & {
2549
2612
  reason?: string | undefined;
@@ -2610,23 +2673,23 @@ export declare class HelpDocsSearch {
2610
2673
  hotkey_mac: string;
2611
2674
  hotkey_win: string;
2612
2675
  detail: string | ({
2613
- type: "html" | "video" | "plaintext" | "markdown" | "component" | "react";
2676
+ type: "html" | "video" | "plaintext" | "markdown" | "react" | "component";
2614
2677
  value: string;
2615
2678
  } & {
2616
2679
  position?: "inline" | "popover" | undefined;
2617
2680
  }) | (string | ({
2618
- type: "html" | "video" | "plaintext" | "markdown" | "component" | "react";
2681
+ type: "html" | "video" | "plaintext" | "markdown" | "react" | "component";
2619
2682
  value: string;
2620
2683
  } & {
2621
2684
  position?: "inline" | "popover" | undefined;
2622
2685
  }))[] | null;
2623
2686
  content: string | ({
2624
- type: "html" | "video" | "plaintext" | "markdown" | "component" | "react";
2687
+ type: "html" | "video" | "plaintext" | "markdown" | "react" | "component";
2625
2688
  value: string;
2626
2689
  } & {
2627
2690
  position?: "inline" | "popover" | undefined;
2628
2691
  }) | (string | ({
2629
- type: "html" | "video" | "plaintext" | "markdown" | "component" | "react";
2692
+ type: "html" | "video" | "plaintext" | "markdown" | "react" | "component";
2630
2693
  value: string;
2631
2694
  } & {
2632
2695
  position?: "inline" | "popover" | undefined;
@@ -2634,31 +2697,38 @@ export declare class HelpDocsSearch {
2634
2697
  show_preview: boolean;
2635
2698
  next_steps: (string | number | {
2636
2699
  cta: string;
2637
- action: {
2700
+ action: ({
2701
+ type: "link";
2702
+ value: string;
2703
+ } & {
2704
+ operation?: "self" | "router" | "blank" | undefined;
2705
+ meta?: {
2706
+ command: string;
2707
+ } | undefined;
2708
+ }) | {
2709
+ type: "click" | "clickBySelector" | "clickByXpath";
2710
+ value: string[];
2711
+ } | {
2638
2712
  type: "execute_command";
2639
2713
  meta: {
2640
2714
  command: string;
2641
2715
  } & {
2642
2716
  type?: "link" | "video" | "action" | "helpdoc" | undefined;
2643
2717
  };
2718
+ } | {
2719
+ type: "no_action";
2644
2720
  } | {
2645
2721
  type: "click";
2646
2722
  value: string;
2647
2723
  } | {
2648
- type: "click" | "clickBySelector" | "clickByXpath";
2649
- value: string[];
2650
- } | ({
2651
- type: "link";
2652
- value: string;
2653
- } & {
2654
- operation?: "self" | "router" | "blank" | undefined;
2655
- meta?: {
2656
- command: string;
2657
- } | undefined;
2658
- }) | {
2659
2724
  type: "open_chat";
2660
2725
  meta: {
2661
- type: "" | "intercom" | "helpscout" | "freshdesk" | "freshchat" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "hubspot" | "drift" | "pylon" | "zendesk_handoff";
2726
+ type: "" | "hubspot" | "intercom" | "helpscout" | "freshdesk" | "freshchat" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "drift" | "pylon" | "zendesk_handoff";
2727
+ };
2728
+ } | {
2729
+ type: "chat_handoff";
2730
+ meta: {
2731
+ type: "" | "intercom" | "freshchat" | "zendesk";
2662
2732
  };
2663
2733
  } | {
2664
2734
  type: "dismiss";
@@ -2667,14 +2737,14 @@ export declare class HelpDocsSearch {
2667
2737
  } | {
2668
2738
  type: "questlist";
2669
2739
  value: number;
2670
- } | {
2671
- type: "step_back";
2672
2740
  } | {
2673
2741
  type: "nudge";
2674
2742
  value: number;
2675
2743
  } | {
2676
2744
  type: "go_to_step";
2677
2745
  value: number;
2746
+ } | {
2747
+ type: "step_back";
2678
2748
  } | ({
2679
2749
  type: "open_bar";
2680
2750
  } & {
@@ -2682,11 +2752,11 @@ export declare class HelpDocsSearch {
2682
2752
  categoryFilter?: number | undefined;
2683
2753
  }) | {
2684
2754
  type: "open_helphub";
2685
- } | {
2755
+ } | ({
2686
2756
  type: "open_copilot";
2687
- } | {
2688
- type: "no_action";
2689
- };
2757
+ } & {
2758
+ query?: string | undefined;
2759
+ });
2690
2760
  })[];
2691
2761
  extra: string | null;
2692
2762
  thumbnail: {