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