commandbar 1.8.7 → 1.10.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (61) hide show
  1. package/build/{internal/src/client → commandbar/src/shared/services/analytics}/EventHandler.d.ts +51 -15
  2. package/build/commandbar/src/shared/services/analytics/types.d.ts +77 -0
  3. package/build/commandbar-js/src/index.d.ts +2 -2
  4. package/build/commandbar-js/src/index.js +1 -1
  5. package/build/internal/src/client/AddContextOptions.d.ts +8 -0
  6. package/build/internal/src/client/CommandBarClientSDK.d.ts +70 -19
  7. package/build/internal/src/client/CommandBarProxySDK.d.ts +3 -3
  8. package/build/internal/src/client/CommandBarSDK.d.ts +34 -18
  9. package/build/internal/src/client/SDKConfig.d.ts +3 -2
  10. package/build/internal/src/client/globals.d.ts +6 -0
  11. package/build/internal/src/client/symbols.d.ts +13 -6
  12. package/build/internal/src/middleware/CommandFromClientV.d.ts +88 -18
  13. package/build/internal/src/middleware/IRecordSettings.d.ts +3 -0
  14. package/build/internal/src/middleware/OrganizationV.d.ts +320 -22
  15. package/build/internal/src/middleware/{ResourceSettingsV.d.ts → RecordSettingsV.d.ts} +2 -2
  16. package/build/internal/src/middleware/additionalResource.d.ts +270 -27
  17. package/build/internal/src/middleware/billing.d.ts +31 -0
  18. package/build/internal/src/middleware/chat.d.ts +12933 -0
  19. package/build/internal/src/middleware/checklist.d.ts +589 -70
  20. package/build/internal/src/middleware/command.d.ts +5433 -677
  21. package/build/internal/src/middleware/detailPreview.d.ts +12 -1
  22. package/build/internal/src/middleware/endUser.d.ts +132 -0
  23. package/build/internal/src/middleware/entityChanges.d.ts +17 -0
  24. package/build/internal/src/middleware/experienceTemplate.d.ts +59 -0
  25. package/build/internal/src/middleware/experiencesSearch.d.ts +3579 -0
  26. package/build/internal/src/middleware/flags.d.ts +20 -0
  27. package/build/internal/src/middleware/generics.d.ts +12 -11
  28. package/build/internal/src/middleware/helpDocsIntegration.d.ts +63 -8
  29. package/build/internal/src/middleware/helpDocsSearch.d.ts +2540 -0
  30. package/build/internal/src/middleware/helpHub.d.ts +26 -0
  31. package/build/internal/src/middleware/helpers/actions.d.ts +174 -16
  32. package/build/internal/src/middleware/helpers/commandTemplate.d.ts +144 -2
  33. package/build/internal/src/middleware/helpers/copilotPersonality.d.ts +12 -0
  34. package/build/internal/src/middleware/helpers/goals.d.ts +4 -2
  35. package/build/internal/src/middleware/helpers/pushTrigger.d.ts +28 -0
  36. package/build/internal/src/middleware/helpers/rules.d.ts +318 -50
  37. package/build/internal/src/middleware/network.d.ts +27 -3
  38. package/build/internal/src/middleware/nudge.d.ts +2220 -91
  39. package/build/internal/src/middleware/organization.d.ts +2289 -152
  40. package/build/internal/src/middleware/organizationSettings.d.ts +435 -20
  41. package/build/internal/src/middleware/profile.d.ts +2 -0
  42. package/build/internal/src/middleware/recommendationSet.d.ts +489 -1007
  43. package/build/internal/src/middleware/releases.d.ts +1 -1
  44. package/build/internal/src/middleware/theme.d.ts +425 -0
  45. package/build/internal/src/middleware/types.d.ts +88 -34
  46. package/build/internal/src/middleware/user.d.ts +1 -0
  47. package/build/internal/src/util/dispatchCustomEvent.d.ts +5 -3
  48. package/build/internal/src/util/operatingSystem.d.ts +11 -0
  49. package/build/internal/src/util/sentry.d.ts +23 -0
  50. package/package.json +3 -3
  51. package/src/index.ts +2 -2
  52. package/src/init.ts +11 -6
  53. package/src/snippet.ts +2 -2
  54. package/build/internal/src/client/AnalyticsEventTypes.d.ts +0 -1
  55. package/build/internal/src/client/SentryReporter.d.ts +0 -63
  56. package/build/internal/src/middleware/IResourceSettings.d.ts +0 -3
  57. package/build/internal/src/middleware/chatAnalytics.d.ts +0 -2601
  58. package/build/internal/src/middleware/dashboardFlags.d.ts +0 -9
  59. package/build/internal/src/middleware/helpers/endUser.d.ts +0 -11
  60. package/build/internal/src/middleware/qaPair.d.ts +0 -676
  61. package/build/internal/src/util/integrations.d.ts +0 -1
@@ -0,0 +1,2540 @@
1
+ import * as t from 'io-ts';
2
+ import * as axiosInstance from './network';
3
+ import { IOrganizationType, ISearchHelpDocsPayloadType } from './types';
4
+ export declare const FilterV: t.UnionC<[t.PartialC<{
5
+ labels: t.ArrayC<t.StringC>;
6
+ }>, t.NullC]>;
7
+ export declare const HelpDocHitV: t.TypeC<{
8
+ score: t.ArrayC<t.NumberC>;
9
+ command: t.Type<{
10
+ id: number;
11
+ text: string;
12
+ template: ({
13
+ type: "admin";
14
+ value: string;
15
+ } & {} & {
16
+ commandType?: "object" | "help" | "independent" | undefined;
17
+ object?: string | undefined;
18
+ hoverTooltip?: boolean | undefined;
19
+ operation?: "self" | "router" | "blank" | "help_hub" | undefined;
20
+ metadata?: {
21
+ [key: string]: unknown;
22
+ } | undefined;
23
+ }) | ({
24
+ type: "callback";
25
+ value: string;
26
+ } & {} & {
27
+ commandType?: "object" | "help" | "independent" | undefined;
28
+ object?: string | undefined;
29
+ hoverTooltip?: boolean | undefined;
30
+ operation?: "self" | "router" | "blank" | "help_hub" | undefined;
31
+ metadata?: {
32
+ [key: string]: unknown;
33
+ } | undefined;
34
+ }) | ({
35
+ type: "link";
36
+ value: string;
37
+ } & {
38
+ operation?: "self" | "router" | "blank" | undefined;
39
+ } & {} & {
40
+ commandType?: "object" | "help" | "independent" | undefined;
41
+ object?: string | undefined;
42
+ hoverTooltip?: boolean | undefined;
43
+ operation?: "self" | "router" | "blank" | "help_hub" | undefined;
44
+ metadata?: {
45
+ [key: string]: unknown;
46
+ } | undefined;
47
+ }) | ({
48
+ type: "click" | "clickBySelector" | "clickByXpath";
49
+ value: string[];
50
+ } & {} & {
51
+ commandType?: "object" | "help" | "independent" | undefined;
52
+ object?: string | undefined;
53
+ hoverTooltip?: boolean | undefined;
54
+ operation?: "self" | "router" | "blank" | "help_hub" | undefined;
55
+ metadata?: {
56
+ [key: string]: unknown;
57
+ } | undefined;
58
+ }) | ({
59
+ type: "builtin";
60
+ value: string;
61
+ } & {} & {
62
+ commandType?: "object" | "help" | "independent" | undefined;
63
+ object?: string | undefined;
64
+ hoverTooltip?: boolean | undefined;
65
+ operation?: "self" | "router" | "blank" | "help_hub" | undefined;
66
+ metadata?: {
67
+ [key: string]: unknown;
68
+ } | undefined;
69
+ }) | ({
70
+ type: "webhook";
71
+ value: string;
72
+ } & {} & {
73
+ commandType?: "object" | "help" | "independent" | undefined;
74
+ object?: string | undefined;
75
+ hoverTooltip?: boolean | undefined;
76
+ operation?: "self" | "router" | "blank" | "help_hub" | undefined;
77
+ metadata?: {
78
+ [key: string]: unknown;
79
+ } | undefined;
80
+ }) | ({
81
+ type: "script";
82
+ value: string;
83
+ } & {} & {
84
+ commandType?: "object" | "help" | "independent" | undefined;
85
+ object?: string | undefined;
86
+ hoverTooltip?: boolean | undefined;
87
+ operation?: "self" | "router" | "blank" | "help_hub" | undefined;
88
+ metadata?: {
89
+ [key: string]: unknown;
90
+ } | undefined;
91
+ }) | ({
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
+ };
107
+ } & {} & {
108
+ commandType?: "object" | "help" | "independent" | undefined;
109
+ object?: string | undefined;
110
+ hoverTooltip?: boolean | undefined;
111
+ operation?: "self" | "router" | "blank" | "help_hub" | undefined;
112
+ metadata?: {
113
+ [key: string]: unknown;
114
+ } | undefined;
115
+ }) | ({
116
+ type: "appcues";
117
+ value: string;
118
+ } & {} & {
119
+ commandType?: "object" | "help" | "independent" | undefined;
120
+ object?: string | undefined;
121
+ hoverTooltip?: boolean | undefined;
122
+ operation?: "self" | "router" | "blank" | "help_hub" | undefined;
123
+ metadata?: {
124
+ [key: string]: unknown;
125
+ } | undefined;
126
+ }) | ({
127
+ type: "pendo_guide";
128
+ value: string;
129
+ } & {} & {
130
+ commandType?: "object" | "help" | "independent" | undefined;
131
+ object?: string | undefined;
132
+ hoverTooltip?: boolean | undefined;
133
+ operation?: "self" | "router" | "blank" | "help_hub" | undefined;
134
+ metadata?: {
135
+ [key: string]: unknown;
136
+ } | undefined;
137
+ }) | ({
138
+ type: "video";
139
+ value: string;
140
+ } & {} & {
141
+ commandType?: "object" | "help" | "independent" | undefined;
142
+ object?: string | undefined;
143
+ hoverTooltip?: boolean | undefined;
144
+ operation?: "self" | "router" | "blank" | "help_hub" | undefined;
145
+ metadata?: {
146
+ [key: string]: unknown;
147
+ } | undefined;
148
+ }) | ({
149
+ type: "helpdoc";
150
+ 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
+ } & {} & {
160
+ commandType?: "object" | "help" | "independent" | undefined;
161
+ object?: string | undefined;
162
+ hoverTooltip?: boolean | undefined;
163
+ operation?: "self" | "router" | "blank" | "help_hub" | undefined;
164
+ metadata?: {
165
+ [key: string]: unknown;
166
+ } | undefined;
167
+ }) | ({
168
+ type: "trigger";
169
+ value: {
170
+ type: "execute_command";
171
+ meta: {
172
+ command: string;
173
+ } & {
174
+ type?: "link" | "video" | "action" | "helpdoc" | undefined;
175
+ };
176
+ } | {
177
+ type: "click";
178
+ value: string;
179
+ } | {
180
+ type: "click" | "clickBySelector" | "clickByXpath";
181
+ value: string[];
182
+ } | ({
183
+ type: "link";
184
+ value: string;
185
+ } & {
186
+ operation?: "self" | "router" | "blank" | undefined;
187
+ }) | {
188
+ type: "open_chat";
189
+ meta: {
190
+ type: "" | "intercom" | "helpscout" | "freshdesk" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "hubspot" | "drift";
191
+ };
192
+ } | {
193
+ type: "dismiss";
194
+ } | {
195
+ type: "snooze";
196
+ } | {
197
+ type: "questlist";
198
+ value: number;
199
+ } | {
200
+ type: "step_back";
201
+ } | {
202
+ type: "nudge";
203
+ value: number;
204
+ } | {
205
+ type: "go_to_step";
206
+ value: number;
207
+ } | ({
208
+ type: "open_bar";
209
+ } & {
210
+ value?: string | undefined;
211
+ categoryFilter?: number | undefined;
212
+ }) | {
213
+ type: "open_helphub";
214
+ } | {
215
+ type: "open_copilot";
216
+ } | {
217
+ type: "no_action";
218
+ };
219
+ } & {} & {
220
+ commandType?: "object" | "help" | "independent" | undefined;
221
+ object?: string | undefined;
222
+ hoverTooltip?: boolean | undefined;
223
+ operation?: "self" | "router" | "blank" | "help_hub" | undefined;
224
+ metadata?: {
225
+ [key: string]: unknown;
226
+ } | undefined;
227
+ });
228
+ } & {
229
+ disabledReason?: string | undefined;
230
+ source?: string | undefined;
231
+ name?: string | undefined;
232
+ last_available?: string | null | undefined;
233
+ modified?: string | undefined;
234
+ isAsync?: boolean | undefined;
235
+ } & {
236
+ arguments: {
237
+ [x: string]: ({
238
+ type: "context";
239
+ value: string;
240
+ order_key: number;
241
+ } & {
242
+ label?: string | undefined;
243
+ chosen?: string | number | undefined;
244
+ selected?: any[] | undefined;
245
+ input_type?: string | undefined;
246
+ preselected_key?: string | undefined;
247
+ label_field?: string | undefined;
248
+ loaded?: any[] | undefined;
249
+ allow_create?: boolean | undefined;
250
+ allow_create_label?: string | undefined;
251
+ show_in_record_action_list?: boolean | undefined;
252
+ show_in_default_list?: boolean | undefined;
253
+ auto_choose?: boolean | undefined;
254
+ is_private?: boolean | undefined;
255
+ }) | ({
256
+ type: "set";
257
+ value: string[] | number[] | {
258
+ [key: string]: unknown;
259
+ }[];
260
+ order_key: number;
261
+ } & {
262
+ label?: string | undefined;
263
+ chosen?: string | number | undefined;
264
+ selected?: any[] | undefined;
265
+ input_type?: string | undefined;
266
+ preselected_key?: string | undefined;
267
+ label_field?: string | undefined;
268
+ loaded?: any[] | undefined;
269
+ allow_create?: boolean | undefined;
270
+ allow_create_label?: string | undefined;
271
+ auto_choose?: boolean | undefined;
272
+ is_private?: boolean | undefined;
273
+ }) | ({
274
+ type: "provided";
275
+ value: "time" | "text";
276
+ order_key: number;
277
+ } & {
278
+ label?: string | undefined;
279
+ chosen?: string | number | undefined;
280
+ selected?: any[] | undefined;
281
+ input_type?: string | undefined;
282
+ preselected_key?: string | undefined;
283
+ label_field?: string | undefined;
284
+ loaded?: any[] | undefined;
285
+ dateTimeArgumentTypeId?: number | undefined;
286
+ allow_create?: boolean | undefined;
287
+ allow_create_label?: string | undefined;
288
+ auto_choose?: boolean | undefined;
289
+ is_private?: boolean | undefined;
290
+ }) | ({
291
+ type: "html" | "video";
292
+ value: {
293
+ source: string;
294
+ } & {
295
+ title?: string | undefined;
296
+ description?: string | undefined;
297
+ url?: string | undefined;
298
+ };
299
+ order_key: number;
300
+ } & {
301
+ label?: string | undefined;
302
+ chosen?: string | number | undefined;
303
+ selected?: any[] | undefined;
304
+ input_type?: string | undefined;
305
+ preselected_key?: string | undefined;
306
+ label_field?: string | undefined;
307
+ loaded?: any[] | undefined;
308
+ allow_create?: boolean | undefined;
309
+ allow_create_label?: string | undefined;
310
+ is_private?: boolean | undefined;
311
+ auto_choose?: boolean | undefined;
312
+ });
313
+ };
314
+ tags: string[];
315
+ availability_rules: (({
316
+ type: "url" | "element" | "context" | "hubspot" | "device_type" | "sessions" | "survey_response" | "user_property" | "event_property" | "hostname" | "executions" | "shortcuts" | "last_seen" | "first_seen" | "opens" | "deadends" | "heap" | "ab_test" | "intent" | "help_doc_interaction" | "video_interaction";
317
+ operator: "includes" | "endsWith" | "startsWith" | "is" | "isTrue" | "isFalse" | "isTruthy" | "isFalsy" | "matchesRegex" | "isDefined" | "isNotDefined" | "classnameOnPage" | "idOnPage" | "selectorOnPage" | "classnameNotOnPage" | "idNotOnPage" | "selectorNotOnPage" | "doesNotInclude" | "isNot" | "isGreaterThan" | "isLessThan";
318
+ } & {
319
+ field?: string | undefined;
320
+ value?: string | undefined;
321
+ reason?: string | undefined;
322
+ rule_id?: string | number | undefined;
323
+ }) | ({
324
+ type: "nudge_interaction";
325
+ operator: "is" | "isNot";
326
+ value: "completed" | "dismissed" | "viewed";
327
+ nudge_id: number;
328
+ } & {
329
+ reason?: string | undefined;
330
+ }) | ({
331
+ type: "questlist_interaction";
332
+ operator: "is" | "isNot";
333
+ value: "completed" | "dismissed" | "viewed";
334
+ questlist_id: number;
335
+ } & {
336
+ reason?: string | undefined;
337
+ }) | ({
338
+ type: "browser" | "language" | "os";
339
+ operator: "includes" | "doesNotInclude";
340
+ values: string[];
341
+ } & {
342
+ reason?: string | undefined;
343
+ }))[];
344
+ recommend_rules: (({
345
+ type: "url" | "element" | "context" | "hubspot" | "device_type" | "sessions" | "survey_response" | "user_property" | "event_property" | "hostname" | "executions" | "shortcuts" | "last_seen" | "first_seen" | "opens" | "deadends" | "heap" | "ab_test" | "intent" | "help_doc_interaction" | "video_interaction";
346
+ operator: "includes" | "endsWith" | "startsWith" | "is" | "isTrue" | "isFalse" | "isTruthy" | "isFalsy" | "matchesRegex" | "isDefined" | "isNotDefined" | "classnameOnPage" | "idOnPage" | "selectorOnPage" | "classnameNotOnPage" | "idNotOnPage" | "selectorNotOnPage" | "doesNotInclude" | "isNot" | "isGreaterThan" | "isLessThan";
347
+ } & {
348
+ field?: string | undefined;
349
+ value?: string | undefined;
350
+ reason?: string | undefined;
351
+ rule_id?: string | number | undefined;
352
+ }) | ({
353
+ type: "nudge_interaction";
354
+ operator: "is" | "isNot";
355
+ value: "completed" | "dismissed" | "viewed";
356
+ nudge_id: number;
357
+ } & {
358
+ reason?: string | undefined;
359
+ }) | ({
360
+ type: "questlist_interaction";
361
+ operator: "is" | "isNot";
362
+ value: "completed" | "dismissed" | "viewed";
363
+ questlist_id: number;
364
+ } & {
365
+ reason?: string | undefined;
366
+ }) | ({
367
+ type: "browser" | "language" | "os";
368
+ operator: "includes" | "doesNotInclude";
369
+ values: string[];
370
+ } & {
371
+ reason?: string | undefined;
372
+ }) | ({
373
+ type: "always";
374
+ } & {
375
+ operator?: null | undefined;
376
+ field?: null | undefined;
377
+ value?: null | undefined;
378
+ reason?: null | undefined;
379
+ rule_id?: string | number | undefined;
380
+ }))[];
381
+ availability_expression: import("./helpers/rules").RuleExpression | null;
382
+ recommend_expression: import("./helpers/rules").RuleExpression | null;
383
+ always_recommend: boolean;
384
+ confirm: string;
385
+ shortcut: string[];
386
+ explanation: string;
387
+ heading: string;
388
+ is_live: boolean;
389
+ category: number | null;
390
+ sort_key: number | null;
391
+ icon: string | null;
392
+ icon_color: string | null;
393
+ image_color: string | null;
394
+ image: string | null;
395
+ celebrate: boolean | {
396
+ angle?: number | undefined;
397
+ spread?: number | undefined;
398
+ width?: string | undefined;
399
+ height?: string | undefined;
400
+ duration?: number | undefined;
401
+ dragFriction?: number | undefined;
402
+ stagger?: number | undefined;
403
+ startVelocity?: number | undefined;
404
+ elementCount?: number | undefined;
405
+ decay?: number | undefined;
406
+ colors?: string[] | undefined;
407
+ random?: any;
408
+ } | null;
409
+ recommend_sort_key: number | null;
410
+ shortcut_mac: string[];
411
+ shortcut_win: string[];
412
+ hotkey_mac: string;
413
+ hotkey_win: string;
414
+ detail: string | ({
415
+ type: "html" | "video" | "plaintext" | "markdown" | "component" | "react";
416
+ value: string;
417
+ } & {
418
+ position?: "inline" | "popover" | undefined;
419
+ }) | (string | ({
420
+ type: "html" | "video" | "plaintext" | "markdown" | "component" | "react";
421
+ value: string;
422
+ } & {
423
+ position?: "inline" | "popover" | undefined;
424
+ }))[] | null;
425
+ content: string | ({
426
+ type: "html" | "video" | "plaintext" | "markdown" | "component" | "react";
427
+ value: string;
428
+ } & {
429
+ position?: "inline" | "popover" | undefined;
430
+ }) | (string | ({
431
+ type: "html" | "video" | "plaintext" | "markdown" | "component" | "react";
432
+ value: string;
433
+ } & {
434
+ position?: "inline" | "popover" | undefined;
435
+ }))[] | null;
436
+ show_preview: boolean;
437
+ next_steps: (string | number | {
438
+ cta: string;
439
+ action: {
440
+ type: "execute_command";
441
+ meta: {
442
+ command: string;
443
+ } & {
444
+ type?: "link" | "video" | "action" | "helpdoc" | undefined;
445
+ };
446
+ } | {
447
+ type: "click";
448
+ value: string;
449
+ } | {
450
+ type: "click" | "clickBySelector" | "clickByXpath";
451
+ value: string[];
452
+ } | ({
453
+ type: "link";
454
+ value: string;
455
+ } & {
456
+ operation?: "self" | "router" | "blank" | undefined;
457
+ }) | {
458
+ type: "open_chat";
459
+ meta: {
460
+ type: "" | "intercom" | "helpscout" | "freshdesk" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "hubspot" | "drift";
461
+ };
462
+ } | {
463
+ type: "dismiss";
464
+ } | {
465
+ type: "snooze";
466
+ } | {
467
+ type: "questlist";
468
+ value: number;
469
+ } | {
470
+ type: "step_back";
471
+ } | {
472
+ type: "nudge";
473
+ value: number;
474
+ } | {
475
+ type: "go_to_step";
476
+ value: number;
477
+ } | ({
478
+ type: "open_bar";
479
+ } & {
480
+ value?: string | undefined;
481
+ categoryFilter?: number | undefined;
482
+ }) | {
483
+ type: "open_helphub";
484
+ } | {
485
+ type: "open_copilot";
486
+ } | {
487
+ type: "no_action";
488
+ };
489
+ })[];
490
+ extra: string | null;
491
+ thumbnail: {
492
+ src: string;
493
+ file_name: string;
494
+ size: string;
495
+ } | null;
496
+ copilot_suggest: boolean;
497
+ show_in_spotlight_search: boolean;
498
+ show_in_helphub_search: boolean;
499
+ copilot_cta_label: string;
500
+ copilot_description: string;
501
+ } & {
502
+ third_party_source?: string | null | undefined;
503
+ third_party_id?: string | null | undefined;
504
+ training_only?: boolean | undefined;
505
+ integration?: {
506
+ id: number;
507
+ helphub_view_article_button_hidden: boolean | undefined;
508
+ } | null | undefined;
509
+ }, {
510
+ id: number;
511
+ text: string;
512
+ template: ({
513
+ type: "admin";
514
+ value: string;
515
+ } & {} & {
516
+ commandType?: "object" | "help" | "independent" | undefined;
517
+ object?: string | undefined;
518
+ hoverTooltip?: boolean | undefined;
519
+ operation?: "self" | "router" | "blank" | "help_hub" | undefined;
520
+ metadata?: {
521
+ [key: string]: unknown;
522
+ } | undefined;
523
+ }) | ({
524
+ type: "callback";
525
+ value: string;
526
+ } & {} & {
527
+ commandType?: "object" | "help" | "independent" | undefined;
528
+ object?: string | undefined;
529
+ hoverTooltip?: boolean | undefined;
530
+ operation?: "self" | "router" | "blank" | "help_hub" | undefined;
531
+ metadata?: {
532
+ [key: string]: unknown;
533
+ } | undefined;
534
+ }) | ({
535
+ type: "link";
536
+ value: string;
537
+ } & {
538
+ operation?: "self" | "router" | "blank" | undefined;
539
+ } & {} & {
540
+ commandType?: "object" | "help" | "independent" | undefined;
541
+ object?: string | undefined;
542
+ hoverTooltip?: boolean | undefined;
543
+ operation?: "self" | "router" | "blank" | "help_hub" | undefined;
544
+ metadata?: {
545
+ [key: string]: unknown;
546
+ } | undefined;
547
+ }) | ({
548
+ type: "click" | "clickBySelector" | "clickByXpath";
549
+ value: string[];
550
+ } & {} & {
551
+ commandType?: "object" | "help" | "independent" | undefined;
552
+ object?: string | undefined;
553
+ hoverTooltip?: boolean | undefined;
554
+ operation?: "self" | "router" | "blank" | "help_hub" | undefined;
555
+ metadata?: {
556
+ [key: string]: unknown;
557
+ } | undefined;
558
+ }) | ({
559
+ type: "builtin";
560
+ value: string;
561
+ } & {} & {
562
+ commandType?: "object" | "help" | "independent" | undefined;
563
+ object?: string | undefined;
564
+ hoverTooltip?: boolean | undefined;
565
+ operation?: "self" | "router" | "blank" | "help_hub" | undefined;
566
+ metadata?: {
567
+ [key: string]: unknown;
568
+ } | undefined;
569
+ }) | ({
570
+ type: "webhook";
571
+ value: string;
572
+ } & {} & {
573
+ commandType?: "object" | "help" | "independent" | undefined;
574
+ object?: string | undefined;
575
+ hoverTooltip?: boolean | undefined;
576
+ operation?: "self" | "router" | "blank" | "help_hub" | undefined;
577
+ metadata?: {
578
+ [key: string]: unknown;
579
+ } | undefined;
580
+ }) | ({
581
+ type: "script";
582
+ value: string;
583
+ } & {} & {
584
+ commandType?: "object" | "help" | "independent" | undefined;
585
+ object?: string | undefined;
586
+ hoverTooltip?: boolean | undefined;
587
+ operation?: "self" | "router" | "blank" | "help_hub" | undefined;
588
+ metadata?: {
589
+ [key: string]: unknown;
590
+ } | undefined;
591
+ }) | ({
592
+ type: "request";
593
+ value: {
594
+ method: "head" | "options" | "get" | "post" | "put" | "delete" | "patch";
595
+ url: string;
596
+ } & {
597
+ headers?: {
598
+ [key: string]: unknown;
599
+ } | undefined;
600
+ body?: {
601
+ [key: string]: unknown;
602
+ } | undefined;
603
+ onSend?: string | undefined;
604
+ onSuccess?: string | undefined;
605
+ onError?: string | undefined;
606
+ };
607
+ } & {} & {
608
+ commandType?: "object" | "help" | "independent" | undefined;
609
+ object?: string | undefined;
610
+ hoverTooltip?: boolean | undefined;
611
+ operation?: "self" | "router" | "blank" | "help_hub" | undefined;
612
+ metadata?: {
613
+ [key: string]: unknown;
614
+ } | undefined;
615
+ }) | ({
616
+ type: "appcues";
617
+ value: string;
618
+ } & {} & {
619
+ commandType?: "object" | "help" | "independent" | undefined;
620
+ object?: string | undefined;
621
+ hoverTooltip?: boolean | undefined;
622
+ operation?: "self" | "router" | "blank" | "help_hub" | undefined;
623
+ metadata?: {
624
+ [key: string]: unknown;
625
+ } | undefined;
626
+ }) | ({
627
+ type: "pendo_guide";
628
+ value: string;
629
+ } & {} & {
630
+ commandType?: "object" | "help" | "independent" | undefined;
631
+ object?: string | undefined;
632
+ hoverTooltip?: boolean | undefined;
633
+ operation?: "self" | "router" | "blank" | "help_hub" | undefined;
634
+ metadata?: {
635
+ [key: string]: unknown;
636
+ } | undefined;
637
+ }) | ({
638
+ type: "video";
639
+ value: string;
640
+ } & {} & {
641
+ commandType?: "object" | "help" | "independent" | undefined;
642
+ object?: string | undefined;
643
+ hoverTooltip?: boolean | undefined;
644
+ operation?: "self" | "router" | "blank" | "help_hub" | undefined;
645
+ metadata?: {
646
+ [key: string]: unknown;
647
+ } | undefined;
648
+ }) | ({
649
+ type: "helpdoc";
650
+ value: string;
651
+ } & {
652
+ operation?: "self" | "router" | "blank" | "help_hub" | undefined;
653
+ doc_metadata?: {
654
+ content_type?: string | undefined;
655
+ date?: string | undefined;
656
+ } | undefined;
657
+ } & {
658
+ doc_type?: "answer" | "doc" | undefined;
659
+ } & {} & {
660
+ commandType?: "object" | "help" | "independent" | undefined;
661
+ object?: string | undefined;
662
+ hoverTooltip?: boolean | undefined;
663
+ operation?: "self" | "router" | "blank" | "help_hub" | undefined;
664
+ metadata?: {
665
+ [key: string]: unknown;
666
+ } | undefined;
667
+ }) | ({
668
+ type: "trigger";
669
+ value: {
670
+ type: "execute_command";
671
+ meta: {
672
+ command: string;
673
+ } & {
674
+ type?: "link" | "video" | "action" | "helpdoc" | undefined;
675
+ };
676
+ } | {
677
+ type: "click";
678
+ value: string;
679
+ } | {
680
+ type: "click" | "clickBySelector" | "clickByXpath";
681
+ value: string[];
682
+ } | ({
683
+ type: "link";
684
+ value: string;
685
+ } & {
686
+ operation?: "self" | "router" | "blank" | undefined;
687
+ }) | {
688
+ type: "open_chat";
689
+ meta: {
690
+ type: "" | "intercom" | "helpscout" | "freshdesk" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "hubspot" | "drift";
691
+ };
692
+ } | {
693
+ type: "dismiss";
694
+ } | {
695
+ type: "snooze";
696
+ } | {
697
+ type: "questlist";
698
+ value: number;
699
+ } | {
700
+ type: "step_back";
701
+ } | {
702
+ type: "nudge";
703
+ value: number;
704
+ } | {
705
+ type: "go_to_step";
706
+ value: number;
707
+ } | ({
708
+ type: "open_bar";
709
+ } & {
710
+ value?: string | undefined;
711
+ categoryFilter?: number | undefined;
712
+ }) | {
713
+ type: "open_helphub";
714
+ } | {
715
+ type: "open_copilot";
716
+ } | {
717
+ type: "no_action";
718
+ };
719
+ } & {} & {
720
+ commandType?: "object" | "help" | "independent" | undefined;
721
+ object?: string | undefined;
722
+ hoverTooltip?: boolean | undefined;
723
+ operation?: "self" | "router" | "blank" | "help_hub" | undefined;
724
+ metadata?: {
725
+ [key: string]: unknown;
726
+ } | undefined;
727
+ });
728
+ } & {
729
+ disabledReason?: string | undefined;
730
+ source?: string | undefined;
731
+ name?: string | undefined;
732
+ last_available?: string | null | undefined;
733
+ modified?: string | undefined;
734
+ isAsync?: boolean | undefined;
735
+ } & {
736
+ arguments: {
737
+ [x: string]: ({
738
+ type: "context";
739
+ value: string;
740
+ order_key: number;
741
+ } & {
742
+ label?: string | undefined;
743
+ chosen?: string | number | undefined;
744
+ selected?: any[] | undefined;
745
+ input_type?: string | undefined;
746
+ preselected_key?: string | undefined;
747
+ label_field?: string | undefined;
748
+ loaded?: any[] | undefined;
749
+ allow_create?: boolean | undefined;
750
+ allow_create_label?: string | undefined;
751
+ show_in_record_action_list?: boolean | undefined;
752
+ show_in_default_list?: boolean | undefined;
753
+ auto_choose?: boolean | undefined;
754
+ is_private?: boolean | undefined;
755
+ }) | ({
756
+ type: "set";
757
+ value: string[] | number[] | {
758
+ [key: string]: unknown;
759
+ }[];
760
+ order_key: number;
761
+ } & {
762
+ label?: string | undefined;
763
+ chosen?: string | number | undefined;
764
+ selected?: any[] | undefined;
765
+ input_type?: string | undefined;
766
+ preselected_key?: string | undefined;
767
+ label_field?: string | undefined;
768
+ loaded?: any[] | undefined;
769
+ allow_create?: boolean | undefined;
770
+ allow_create_label?: string | undefined;
771
+ auto_choose?: boolean | undefined;
772
+ is_private?: boolean | undefined;
773
+ }) | ({
774
+ type: "provided";
775
+ value: "time" | "text";
776
+ order_key: number;
777
+ } & {
778
+ label?: string | undefined;
779
+ chosen?: string | number | undefined;
780
+ selected?: any[] | undefined;
781
+ input_type?: string | undefined;
782
+ preselected_key?: string | undefined;
783
+ label_field?: string | undefined;
784
+ loaded?: any[] | undefined;
785
+ dateTimeArgumentTypeId?: number | undefined;
786
+ allow_create?: boolean | undefined;
787
+ allow_create_label?: string | undefined;
788
+ auto_choose?: boolean | undefined;
789
+ is_private?: boolean | undefined;
790
+ }) | ({
791
+ type: "html" | "video";
792
+ value: {
793
+ source: string;
794
+ } & {
795
+ title?: string | undefined;
796
+ description?: string | undefined;
797
+ url?: string | undefined;
798
+ };
799
+ order_key: number;
800
+ } & {
801
+ label?: string | undefined;
802
+ chosen?: string | number | undefined;
803
+ selected?: any[] | undefined;
804
+ input_type?: string | undefined;
805
+ preselected_key?: string | undefined;
806
+ label_field?: string | undefined;
807
+ loaded?: any[] | undefined;
808
+ allow_create?: boolean | undefined;
809
+ allow_create_label?: string | undefined;
810
+ is_private?: boolean | undefined;
811
+ auto_choose?: boolean | undefined;
812
+ });
813
+ };
814
+ tags: string[];
815
+ availability_rules: (({
816
+ type: "url" | "element" | "context" | "hubspot" | "device_type" | "sessions" | "survey_response" | "user_property" | "event_property" | "hostname" | "executions" | "shortcuts" | "last_seen" | "first_seen" | "opens" | "deadends" | "heap" | "ab_test" | "intent" | "help_doc_interaction" | "video_interaction";
817
+ operator: "includes" | "endsWith" | "startsWith" | "is" | "isTrue" | "isFalse" | "isTruthy" | "isFalsy" | "matchesRegex" | "isDefined" | "isNotDefined" | "classnameOnPage" | "idOnPage" | "selectorOnPage" | "classnameNotOnPage" | "idNotOnPage" | "selectorNotOnPage" | "doesNotInclude" | "isNot" | "isGreaterThan" | "isLessThan";
818
+ } & {
819
+ field?: string | undefined;
820
+ value?: string | undefined;
821
+ reason?: string | undefined;
822
+ rule_id?: string | number | undefined;
823
+ }) | ({
824
+ type: "nudge_interaction";
825
+ operator: "is" | "isNot";
826
+ value: "completed" | "dismissed" | "viewed";
827
+ nudge_id: number;
828
+ } & {
829
+ reason?: string | undefined;
830
+ }) | ({
831
+ type: "questlist_interaction";
832
+ operator: "is" | "isNot";
833
+ value: "completed" | "dismissed" | "viewed";
834
+ questlist_id: number;
835
+ } & {
836
+ reason?: string | undefined;
837
+ }) | ({
838
+ type: "browser" | "language" | "os";
839
+ operator: "includes" | "doesNotInclude";
840
+ values: string[];
841
+ } & {
842
+ reason?: string | undefined;
843
+ }))[];
844
+ recommend_rules: (({
845
+ type: "url" | "element" | "context" | "hubspot" | "device_type" | "sessions" | "survey_response" | "user_property" | "event_property" | "hostname" | "executions" | "shortcuts" | "last_seen" | "first_seen" | "opens" | "deadends" | "heap" | "ab_test" | "intent" | "help_doc_interaction" | "video_interaction";
846
+ operator: "includes" | "endsWith" | "startsWith" | "is" | "isTrue" | "isFalse" | "isTruthy" | "isFalsy" | "matchesRegex" | "isDefined" | "isNotDefined" | "classnameOnPage" | "idOnPage" | "selectorOnPage" | "classnameNotOnPage" | "idNotOnPage" | "selectorNotOnPage" | "doesNotInclude" | "isNot" | "isGreaterThan" | "isLessThan";
847
+ } & {
848
+ field?: string | undefined;
849
+ value?: string | undefined;
850
+ reason?: string | undefined;
851
+ rule_id?: string | number | undefined;
852
+ }) | ({
853
+ type: "nudge_interaction";
854
+ operator: "is" | "isNot";
855
+ value: "completed" | "dismissed" | "viewed";
856
+ nudge_id: number;
857
+ } & {
858
+ reason?: string | undefined;
859
+ }) | ({
860
+ type: "questlist_interaction";
861
+ operator: "is" | "isNot";
862
+ value: "completed" | "dismissed" | "viewed";
863
+ questlist_id: number;
864
+ } & {
865
+ reason?: string | undefined;
866
+ }) | ({
867
+ type: "browser" | "language" | "os";
868
+ operator: "includes" | "doesNotInclude";
869
+ values: string[];
870
+ } & {
871
+ reason?: string | undefined;
872
+ }) | ({
873
+ type: "always";
874
+ } & {
875
+ operator?: null | undefined;
876
+ field?: null | undefined;
877
+ value?: null | undefined;
878
+ reason?: null | undefined;
879
+ rule_id?: string | number | undefined;
880
+ }))[];
881
+ availability_expression: import("./helpers/rules").RuleExpression | null;
882
+ recommend_expression: import("./helpers/rules").RuleExpression | null;
883
+ always_recommend: boolean;
884
+ confirm: string;
885
+ shortcut: string[];
886
+ explanation: string;
887
+ heading: string;
888
+ is_live: boolean;
889
+ category: number | null;
890
+ sort_key: number | null;
891
+ icon: string | null;
892
+ icon_color: string | null;
893
+ image_color: string | null;
894
+ image: string | null;
895
+ celebrate: boolean | {
896
+ angle?: number | undefined;
897
+ spread?: number | undefined;
898
+ width?: string | undefined;
899
+ height?: string | undefined;
900
+ duration?: number | undefined;
901
+ dragFriction?: number | undefined;
902
+ stagger?: number | undefined;
903
+ startVelocity?: number | undefined;
904
+ elementCount?: number | undefined;
905
+ decay?: number | undefined;
906
+ colors?: string[] | undefined;
907
+ random?: any;
908
+ } | null;
909
+ recommend_sort_key: number | null;
910
+ shortcut_mac: string[];
911
+ shortcut_win: string[];
912
+ hotkey_mac: string;
913
+ hotkey_win: string;
914
+ detail: string | ({
915
+ type: "html" | "video" | "plaintext" | "markdown" | "component" | "react";
916
+ value: string;
917
+ } & {
918
+ position?: "inline" | "popover" | undefined;
919
+ }) | (string | ({
920
+ type: "html" | "video" | "plaintext" | "markdown" | "component" | "react";
921
+ value: string;
922
+ } & {
923
+ position?: "inline" | "popover" | undefined;
924
+ }))[] | null;
925
+ content: string | ({
926
+ type: "html" | "video" | "plaintext" | "markdown" | "component" | "react";
927
+ value: string;
928
+ } & {
929
+ position?: "inline" | "popover" | undefined;
930
+ }) | (string | ({
931
+ type: "html" | "video" | "plaintext" | "markdown" | "component" | "react";
932
+ value: string;
933
+ } & {
934
+ position?: "inline" | "popover" | undefined;
935
+ }))[] | null;
936
+ show_preview: boolean;
937
+ next_steps: (string | number | {
938
+ cta: string;
939
+ action: {
940
+ type: "execute_command";
941
+ meta: {
942
+ command: string;
943
+ } & {
944
+ type?: "link" | "video" | "action" | "helpdoc" | undefined;
945
+ };
946
+ } | {
947
+ type: "click";
948
+ value: string;
949
+ } | {
950
+ type: "click" | "clickBySelector" | "clickByXpath";
951
+ value: string[];
952
+ } | ({
953
+ type: "link";
954
+ value: string;
955
+ } & {
956
+ operation?: "self" | "router" | "blank" | undefined;
957
+ }) | {
958
+ type: "open_chat";
959
+ meta: {
960
+ type: "" | "intercom" | "helpscout" | "freshdesk" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "hubspot" | "drift";
961
+ };
962
+ } | {
963
+ type: "dismiss";
964
+ } | {
965
+ type: "snooze";
966
+ } | {
967
+ type: "questlist";
968
+ value: number;
969
+ } | {
970
+ type: "step_back";
971
+ } | {
972
+ type: "nudge";
973
+ value: number;
974
+ } | {
975
+ type: "go_to_step";
976
+ value: number;
977
+ } | ({
978
+ type: "open_bar";
979
+ } & {
980
+ value?: string | undefined;
981
+ categoryFilter?: number | undefined;
982
+ }) | {
983
+ type: "open_helphub";
984
+ } | {
985
+ type: "open_copilot";
986
+ } | {
987
+ type: "no_action";
988
+ };
989
+ })[];
990
+ extra: string | null;
991
+ thumbnail: {
992
+ src: string;
993
+ file_name: string;
994
+ size: string;
995
+ } | null;
996
+ copilot_suggest: boolean;
997
+ show_in_spotlight_search: boolean;
998
+ show_in_helphub_search: boolean;
999
+ copilot_cta_label: string;
1000
+ copilot_description: string;
1001
+ } & {
1002
+ third_party_source?: string | null | undefined;
1003
+ third_party_id?: string | null | undefined;
1004
+ training_only?: boolean | undefined;
1005
+ integration?: {
1006
+ id: number;
1007
+ helphub_view_article_button_hidden: boolean | undefined;
1008
+ } | null | undefined;
1009
+ }, any>;
1010
+ excerpt: t.StringC;
1011
+ }>;
1012
+ export declare const SearchHelpDocsResponseV: t.TypeC<{
1013
+ data: t.ArrayC<t.TypeC<{
1014
+ hit: t.TypeC<{
1015
+ score: t.ArrayC<t.NumberC>;
1016
+ command: t.Type<{
1017
+ id: number;
1018
+ text: string;
1019
+ template: ({
1020
+ type: "admin";
1021
+ value: string;
1022
+ } & {} & {
1023
+ commandType?: "object" | "help" | "independent" | undefined;
1024
+ object?: string | undefined;
1025
+ hoverTooltip?: boolean | undefined;
1026
+ operation?: "self" | "router" | "blank" | "help_hub" | undefined;
1027
+ metadata?: {
1028
+ [key: string]: unknown;
1029
+ } | undefined;
1030
+ }) | ({
1031
+ type: "callback";
1032
+ value: string;
1033
+ } & {} & {
1034
+ commandType?: "object" | "help" | "independent" | undefined;
1035
+ object?: string | undefined;
1036
+ hoverTooltip?: boolean | undefined;
1037
+ operation?: "self" | "router" | "blank" | "help_hub" | undefined;
1038
+ metadata?: {
1039
+ [key: string]: unknown;
1040
+ } | undefined;
1041
+ }) | ({
1042
+ type: "link";
1043
+ value: string;
1044
+ } & {
1045
+ operation?: "self" | "router" | "blank" | undefined;
1046
+ } & {} & {
1047
+ commandType?: "object" | "help" | "independent" | undefined;
1048
+ object?: string | undefined;
1049
+ hoverTooltip?: boolean | undefined;
1050
+ operation?: "self" | "router" | "blank" | "help_hub" | undefined;
1051
+ metadata?: {
1052
+ [key: string]: unknown;
1053
+ } | undefined;
1054
+ }) | ({
1055
+ type: "click" | "clickBySelector" | "clickByXpath";
1056
+ value: string[];
1057
+ } & {} & {
1058
+ commandType?: "object" | "help" | "independent" | undefined;
1059
+ object?: string | undefined;
1060
+ hoverTooltip?: boolean | undefined;
1061
+ operation?: "self" | "router" | "blank" | "help_hub" | undefined;
1062
+ metadata?: {
1063
+ [key: string]: unknown;
1064
+ } | undefined;
1065
+ }) | ({
1066
+ type: "builtin";
1067
+ value: string;
1068
+ } & {} & {
1069
+ commandType?: "object" | "help" | "independent" | undefined;
1070
+ object?: string | undefined;
1071
+ hoverTooltip?: boolean | undefined;
1072
+ operation?: "self" | "router" | "blank" | "help_hub" | undefined;
1073
+ metadata?: {
1074
+ [key: string]: unknown;
1075
+ } | undefined;
1076
+ }) | ({
1077
+ type: "webhook";
1078
+ value: string;
1079
+ } & {} & {
1080
+ commandType?: "object" | "help" | "independent" | undefined;
1081
+ object?: string | undefined;
1082
+ hoverTooltip?: boolean | undefined;
1083
+ operation?: "self" | "router" | "blank" | "help_hub" | undefined;
1084
+ metadata?: {
1085
+ [key: string]: unknown;
1086
+ } | undefined;
1087
+ }) | ({
1088
+ type: "script";
1089
+ value: string;
1090
+ } & {} & {
1091
+ commandType?: "object" | "help" | "independent" | undefined;
1092
+ object?: string | undefined;
1093
+ hoverTooltip?: boolean | undefined;
1094
+ operation?: "self" | "router" | "blank" | "help_hub" | undefined;
1095
+ metadata?: {
1096
+ [key: string]: unknown;
1097
+ } | undefined;
1098
+ }) | ({
1099
+ type: "request";
1100
+ value: {
1101
+ method: "head" | "options" | "get" | "post" | "put" | "delete" | "patch";
1102
+ url: string;
1103
+ } & {
1104
+ headers?: {
1105
+ [key: string]: unknown;
1106
+ } | undefined;
1107
+ body?: {
1108
+ [key: string]: unknown;
1109
+ } | undefined;
1110
+ onSend?: string | undefined;
1111
+ onSuccess?: string | undefined;
1112
+ onError?: string | undefined;
1113
+ };
1114
+ } & {} & {
1115
+ commandType?: "object" | "help" | "independent" | undefined;
1116
+ object?: string | undefined;
1117
+ hoverTooltip?: boolean | undefined;
1118
+ operation?: "self" | "router" | "blank" | "help_hub" | undefined;
1119
+ metadata?: {
1120
+ [key: string]: unknown;
1121
+ } | undefined;
1122
+ }) | ({
1123
+ type: "appcues";
1124
+ value: string;
1125
+ } & {} & {
1126
+ commandType?: "object" | "help" | "independent" | undefined;
1127
+ object?: string | undefined;
1128
+ hoverTooltip?: boolean | undefined;
1129
+ operation?: "self" | "router" | "blank" | "help_hub" | undefined;
1130
+ metadata?: {
1131
+ [key: string]: unknown;
1132
+ } | undefined;
1133
+ }) | ({
1134
+ type: "pendo_guide";
1135
+ value: string;
1136
+ } & {} & {
1137
+ commandType?: "object" | "help" | "independent" | undefined;
1138
+ object?: string | undefined;
1139
+ hoverTooltip?: boolean | undefined;
1140
+ operation?: "self" | "router" | "blank" | "help_hub" | undefined;
1141
+ metadata?: {
1142
+ [key: string]: unknown;
1143
+ } | undefined;
1144
+ }) | ({
1145
+ type: "video";
1146
+ value: string;
1147
+ } & {} & {
1148
+ commandType?: "object" | "help" | "independent" | undefined;
1149
+ object?: string | undefined;
1150
+ hoverTooltip?: boolean | undefined;
1151
+ operation?: "self" | "router" | "blank" | "help_hub" | undefined;
1152
+ metadata?: {
1153
+ [key: string]: unknown;
1154
+ } | undefined;
1155
+ }) | ({
1156
+ type: "helpdoc";
1157
+ value: string;
1158
+ } & {
1159
+ operation?: "self" | "router" | "blank" | "help_hub" | undefined;
1160
+ doc_metadata?: {
1161
+ content_type?: string | undefined;
1162
+ date?: string | undefined;
1163
+ } | undefined;
1164
+ } & {
1165
+ doc_type?: "answer" | "doc" | undefined;
1166
+ } & {} & {
1167
+ commandType?: "object" | "help" | "independent" | undefined;
1168
+ object?: string | undefined;
1169
+ hoverTooltip?: boolean | undefined;
1170
+ operation?: "self" | "router" | "blank" | "help_hub" | undefined;
1171
+ metadata?: {
1172
+ [key: string]: unknown;
1173
+ } | undefined;
1174
+ }) | ({
1175
+ type: "trigger";
1176
+ value: {
1177
+ type: "execute_command";
1178
+ meta: {
1179
+ command: string;
1180
+ } & {
1181
+ type?: "link" | "video" | "action" | "helpdoc" | undefined;
1182
+ };
1183
+ } | {
1184
+ type: "click";
1185
+ value: string;
1186
+ } | {
1187
+ type: "click" | "clickBySelector" | "clickByXpath";
1188
+ value: string[];
1189
+ } | ({
1190
+ type: "link";
1191
+ value: string;
1192
+ } & {
1193
+ operation?: "self" | "router" | "blank" | undefined;
1194
+ }) | {
1195
+ type: "open_chat";
1196
+ meta: {
1197
+ type: "" | "intercom" | "helpscout" | "freshdesk" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "hubspot" | "drift";
1198
+ };
1199
+ } | {
1200
+ type: "dismiss";
1201
+ } | {
1202
+ type: "snooze";
1203
+ } | {
1204
+ type: "questlist";
1205
+ value: number;
1206
+ } | {
1207
+ type: "step_back";
1208
+ } | {
1209
+ type: "nudge";
1210
+ value: number;
1211
+ } | {
1212
+ type: "go_to_step";
1213
+ value: number;
1214
+ } | ({
1215
+ type: "open_bar";
1216
+ } & {
1217
+ value?: string | undefined;
1218
+ categoryFilter?: number | undefined;
1219
+ }) | {
1220
+ type: "open_helphub";
1221
+ } | {
1222
+ type: "open_copilot";
1223
+ } | {
1224
+ type: "no_action";
1225
+ };
1226
+ } & {} & {
1227
+ commandType?: "object" | "help" | "independent" | undefined;
1228
+ object?: string | undefined;
1229
+ hoverTooltip?: boolean | undefined;
1230
+ operation?: "self" | "router" | "blank" | "help_hub" | undefined;
1231
+ metadata?: {
1232
+ [key: string]: unknown;
1233
+ } | undefined;
1234
+ });
1235
+ } & {
1236
+ disabledReason?: string | undefined;
1237
+ source?: string | undefined;
1238
+ name?: string | undefined;
1239
+ last_available?: string | null | undefined;
1240
+ modified?: string | undefined;
1241
+ isAsync?: boolean | undefined;
1242
+ } & {
1243
+ arguments: {
1244
+ [x: string]: ({
1245
+ type: "context";
1246
+ value: string;
1247
+ order_key: number;
1248
+ } & {
1249
+ label?: string | undefined;
1250
+ chosen?: string | number | undefined;
1251
+ selected?: any[] | undefined;
1252
+ input_type?: string | undefined;
1253
+ preselected_key?: string | undefined;
1254
+ label_field?: string | undefined;
1255
+ loaded?: any[] | undefined;
1256
+ allow_create?: boolean | undefined;
1257
+ allow_create_label?: string | undefined;
1258
+ show_in_record_action_list?: boolean | undefined;
1259
+ show_in_default_list?: boolean | undefined;
1260
+ auto_choose?: boolean | undefined;
1261
+ is_private?: boolean | undefined;
1262
+ }) | ({
1263
+ type: "set";
1264
+ value: string[] | number[] | {
1265
+ [key: string]: unknown;
1266
+ }[];
1267
+ order_key: number;
1268
+ } & {
1269
+ label?: string | undefined;
1270
+ chosen?: string | number | undefined;
1271
+ selected?: any[] | undefined;
1272
+ input_type?: string | undefined;
1273
+ preselected_key?: string | undefined;
1274
+ label_field?: string | undefined;
1275
+ loaded?: any[] | undefined;
1276
+ allow_create?: boolean | undefined;
1277
+ allow_create_label?: string | undefined;
1278
+ auto_choose?: boolean | undefined;
1279
+ is_private?: boolean | undefined;
1280
+ }) | ({
1281
+ type: "provided";
1282
+ value: "time" | "text";
1283
+ order_key: number;
1284
+ } & {
1285
+ label?: string | undefined;
1286
+ chosen?: string | number | undefined;
1287
+ selected?: any[] | undefined;
1288
+ input_type?: string | undefined;
1289
+ preselected_key?: string | undefined;
1290
+ label_field?: string | undefined;
1291
+ loaded?: any[] | undefined;
1292
+ dateTimeArgumentTypeId?: number | undefined;
1293
+ allow_create?: boolean | undefined;
1294
+ allow_create_label?: string | undefined;
1295
+ auto_choose?: boolean | undefined;
1296
+ is_private?: boolean | undefined;
1297
+ }) | ({
1298
+ type: "html" | "video";
1299
+ value: {
1300
+ source: string;
1301
+ } & {
1302
+ title?: string | undefined;
1303
+ description?: string | undefined;
1304
+ url?: string | undefined;
1305
+ };
1306
+ order_key: number;
1307
+ } & {
1308
+ label?: string | undefined;
1309
+ chosen?: string | number | undefined;
1310
+ selected?: any[] | undefined;
1311
+ input_type?: string | undefined;
1312
+ preselected_key?: string | undefined;
1313
+ label_field?: string | undefined;
1314
+ loaded?: any[] | undefined;
1315
+ allow_create?: boolean | undefined;
1316
+ allow_create_label?: string | undefined;
1317
+ is_private?: boolean | undefined;
1318
+ auto_choose?: boolean | undefined;
1319
+ });
1320
+ };
1321
+ tags: string[];
1322
+ availability_rules: (({
1323
+ type: "url" | "element" | "context" | "hubspot" | "device_type" | "sessions" | "survey_response" | "user_property" | "event_property" | "hostname" | "executions" | "shortcuts" | "last_seen" | "first_seen" | "opens" | "deadends" | "heap" | "ab_test" | "intent" | "help_doc_interaction" | "video_interaction";
1324
+ operator: "includes" | "endsWith" | "startsWith" | "is" | "isTrue" | "isFalse" | "isTruthy" | "isFalsy" | "matchesRegex" | "isDefined" | "isNotDefined" | "classnameOnPage" | "idOnPage" | "selectorOnPage" | "classnameNotOnPage" | "idNotOnPage" | "selectorNotOnPage" | "doesNotInclude" | "isNot" | "isGreaterThan" | "isLessThan";
1325
+ } & {
1326
+ field?: string | undefined;
1327
+ value?: string | undefined;
1328
+ reason?: string | undefined;
1329
+ rule_id?: string | number | undefined;
1330
+ }) | ({
1331
+ type: "nudge_interaction";
1332
+ operator: "is" | "isNot";
1333
+ value: "completed" | "dismissed" | "viewed";
1334
+ nudge_id: number;
1335
+ } & {
1336
+ reason?: string | undefined;
1337
+ }) | ({
1338
+ type: "questlist_interaction";
1339
+ operator: "is" | "isNot";
1340
+ value: "completed" | "dismissed" | "viewed";
1341
+ questlist_id: number;
1342
+ } & {
1343
+ reason?: string | undefined;
1344
+ }) | ({
1345
+ type: "browser" | "language" | "os";
1346
+ operator: "includes" | "doesNotInclude";
1347
+ values: string[];
1348
+ } & {
1349
+ reason?: string | undefined;
1350
+ }))[];
1351
+ recommend_rules: (({
1352
+ type: "url" | "element" | "context" | "hubspot" | "device_type" | "sessions" | "survey_response" | "user_property" | "event_property" | "hostname" | "executions" | "shortcuts" | "last_seen" | "first_seen" | "opens" | "deadends" | "heap" | "ab_test" | "intent" | "help_doc_interaction" | "video_interaction";
1353
+ operator: "includes" | "endsWith" | "startsWith" | "is" | "isTrue" | "isFalse" | "isTruthy" | "isFalsy" | "matchesRegex" | "isDefined" | "isNotDefined" | "classnameOnPage" | "idOnPage" | "selectorOnPage" | "classnameNotOnPage" | "idNotOnPage" | "selectorNotOnPage" | "doesNotInclude" | "isNot" | "isGreaterThan" | "isLessThan";
1354
+ } & {
1355
+ field?: string | undefined;
1356
+ value?: string | undefined;
1357
+ reason?: string | undefined;
1358
+ rule_id?: string | number | undefined;
1359
+ }) | ({
1360
+ type: "nudge_interaction";
1361
+ operator: "is" | "isNot";
1362
+ value: "completed" | "dismissed" | "viewed";
1363
+ nudge_id: number;
1364
+ } & {
1365
+ reason?: string | undefined;
1366
+ }) | ({
1367
+ type: "questlist_interaction";
1368
+ operator: "is" | "isNot";
1369
+ value: "completed" | "dismissed" | "viewed";
1370
+ questlist_id: number;
1371
+ } & {
1372
+ reason?: string | undefined;
1373
+ }) | ({
1374
+ type: "browser" | "language" | "os";
1375
+ operator: "includes" | "doesNotInclude";
1376
+ values: string[];
1377
+ } & {
1378
+ reason?: string | undefined;
1379
+ }) | ({
1380
+ type: "always";
1381
+ } & {
1382
+ operator?: null | undefined;
1383
+ field?: null | undefined;
1384
+ value?: null | undefined;
1385
+ reason?: null | undefined;
1386
+ rule_id?: string | number | undefined;
1387
+ }))[];
1388
+ availability_expression: import("./helpers/rules").RuleExpression | null;
1389
+ recommend_expression: import("./helpers/rules").RuleExpression | null;
1390
+ always_recommend: boolean;
1391
+ confirm: string;
1392
+ shortcut: string[];
1393
+ explanation: string;
1394
+ heading: string;
1395
+ is_live: boolean;
1396
+ category: number | null;
1397
+ sort_key: number | null;
1398
+ icon: string | null;
1399
+ icon_color: string | null;
1400
+ image_color: string | null;
1401
+ image: string | null;
1402
+ celebrate: boolean | {
1403
+ angle?: number | undefined;
1404
+ spread?: number | undefined;
1405
+ width?: string | undefined;
1406
+ height?: string | undefined;
1407
+ duration?: number | undefined;
1408
+ dragFriction?: number | undefined;
1409
+ stagger?: number | undefined;
1410
+ startVelocity?: number | undefined;
1411
+ elementCount?: number | undefined;
1412
+ decay?: number | undefined;
1413
+ colors?: string[] | undefined;
1414
+ random?: any;
1415
+ } | null;
1416
+ recommend_sort_key: number | null;
1417
+ shortcut_mac: string[];
1418
+ shortcut_win: string[];
1419
+ hotkey_mac: string;
1420
+ hotkey_win: string;
1421
+ detail: string | ({
1422
+ type: "html" | "video" | "plaintext" | "markdown" | "component" | "react";
1423
+ value: string;
1424
+ } & {
1425
+ position?: "inline" | "popover" | undefined;
1426
+ }) | (string | ({
1427
+ type: "html" | "video" | "plaintext" | "markdown" | "component" | "react";
1428
+ value: string;
1429
+ } & {
1430
+ position?: "inline" | "popover" | undefined;
1431
+ }))[] | null;
1432
+ content: string | ({
1433
+ type: "html" | "video" | "plaintext" | "markdown" | "component" | "react";
1434
+ value: string;
1435
+ } & {
1436
+ position?: "inline" | "popover" | undefined;
1437
+ }) | (string | ({
1438
+ type: "html" | "video" | "plaintext" | "markdown" | "component" | "react";
1439
+ value: string;
1440
+ } & {
1441
+ position?: "inline" | "popover" | undefined;
1442
+ }))[] | null;
1443
+ show_preview: boolean;
1444
+ next_steps: (string | number | {
1445
+ cta: string;
1446
+ action: {
1447
+ type: "execute_command";
1448
+ meta: {
1449
+ command: string;
1450
+ } & {
1451
+ type?: "link" | "video" | "action" | "helpdoc" | undefined;
1452
+ };
1453
+ } | {
1454
+ type: "click";
1455
+ value: string;
1456
+ } | {
1457
+ type: "click" | "clickBySelector" | "clickByXpath";
1458
+ value: string[];
1459
+ } | ({
1460
+ type: "link";
1461
+ value: string;
1462
+ } & {
1463
+ operation?: "self" | "router" | "blank" | undefined;
1464
+ }) | {
1465
+ type: "open_chat";
1466
+ meta: {
1467
+ type: "" | "intercom" | "helpscout" | "freshdesk" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "hubspot" | "drift";
1468
+ };
1469
+ } | {
1470
+ type: "dismiss";
1471
+ } | {
1472
+ type: "snooze";
1473
+ } | {
1474
+ type: "questlist";
1475
+ value: number;
1476
+ } | {
1477
+ type: "step_back";
1478
+ } | {
1479
+ type: "nudge";
1480
+ value: number;
1481
+ } | {
1482
+ type: "go_to_step";
1483
+ value: number;
1484
+ } | ({
1485
+ type: "open_bar";
1486
+ } & {
1487
+ value?: string | undefined;
1488
+ categoryFilter?: number | undefined;
1489
+ }) | {
1490
+ type: "open_helphub";
1491
+ } | {
1492
+ type: "open_copilot";
1493
+ } | {
1494
+ type: "no_action";
1495
+ };
1496
+ })[];
1497
+ extra: string | null;
1498
+ thumbnail: {
1499
+ src: string;
1500
+ file_name: string;
1501
+ size: string;
1502
+ } | null;
1503
+ copilot_suggest: boolean;
1504
+ show_in_spotlight_search: boolean;
1505
+ show_in_helphub_search: boolean;
1506
+ copilot_cta_label: string;
1507
+ copilot_description: string;
1508
+ } & {
1509
+ third_party_source?: string | null | undefined;
1510
+ third_party_id?: string | null | undefined;
1511
+ training_only?: boolean | undefined;
1512
+ integration?: {
1513
+ id: number;
1514
+ helphub_view_article_button_hidden: boolean | undefined;
1515
+ } | null | undefined;
1516
+ }, {
1517
+ id: number;
1518
+ text: string;
1519
+ template: ({
1520
+ type: "admin";
1521
+ value: string;
1522
+ } & {} & {
1523
+ commandType?: "object" | "help" | "independent" | undefined;
1524
+ object?: string | undefined;
1525
+ hoverTooltip?: boolean | undefined;
1526
+ operation?: "self" | "router" | "blank" | "help_hub" | undefined;
1527
+ metadata?: {
1528
+ [key: string]: unknown;
1529
+ } | undefined;
1530
+ }) | ({
1531
+ type: "callback";
1532
+ value: string;
1533
+ } & {} & {
1534
+ commandType?: "object" | "help" | "independent" | undefined;
1535
+ object?: string | undefined;
1536
+ hoverTooltip?: boolean | undefined;
1537
+ operation?: "self" | "router" | "blank" | "help_hub" | undefined;
1538
+ metadata?: {
1539
+ [key: string]: unknown;
1540
+ } | undefined;
1541
+ }) | ({
1542
+ type: "link";
1543
+ value: string;
1544
+ } & {
1545
+ operation?: "self" | "router" | "blank" | undefined;
1546
+ } & {} & {
1547
+ commandType?: "object" | "help" | "independent" | undefined;
1548
+ object?: string | undefined;
1549
+ hoverTooltip?: boolean | undefined;
1550
+ operation?: "self" | "router" | "blank" | "help_hub" | undefined;
1551
+ metadata?: {
1552
+ [key: string]: unknown;
1553
+ } | undefined;
1554
+ }) | ({
1555
+ type: "click" | "clickBySelector" | "clickByXpath";
1556
+ value: string[];
1557
+ } & {} & {
1558
+ commandType?: "object" | "help" | "independent" | undefined;
1559
+ object?: string | undefined;
1560
+ hoverTooltip?: boolean | undefined;
1561
+ operation?: "self" | "router" | "blank" | "help_hub" | undefined;
1562
+ metadata?: {
1563
+ [key: string]: unknown;
1564
+ } | undefined;
1565
+ }) | ({
1566
+ type: "builtin";
1567
+ value: string;
1568
+ } & {} & {
1569
+ commandType?: "object" | "help" | "independent" | undefined;
1570
+ object?: string | undefined;
1571
+ hoverTooltip?: boolean | undefined;
1572
+ operation?: "self" | "router" | "blank" | "help_hub" | undefined;
1573
+ metadata?: {
1574
+ [key: string]: unknown;
1575
+ } | undefined;
1576
+ }) | ({
1577
+ type: "webhook";
1578
+ value: string;
1579
+ } & {} & {
1580
+ commandType?: "object" | "help" | "independent" | undefined;
1581
+ object?: string | undefined;
1582
+ hoverTooltip?: boolean | undefined;
1583
+ operation?: "self" | "router" | "blank" | "help_hub" | undefined;
1584
+ metadata?: {
1585
+ [key: string]: unknown;
1586
+ } | undefined;
1587
+ }) | ({
1588
+ type: "script";
1589
+ value: string;
1590
+ } & {} & {
1591
+ commandType?: "object" | "help" | "independent" | undefined;
1592
+ object?: string | undefined;
1593
+ hoverTooltip?: boolean | undefined;
1594
+ operation?: "self" | "router" | "blank" | "help_hub" | undefined;
1595
+ metadata?: {
1596
+ [key: string]: unknown;
1597
+ } | undefined;
1598
+ }) | ({
1599
+ type: "request";
1600
+ value: {
1601
+ method: "head" | "options" | "get" | "post" | "put" | "delete" | "patch";
1602
+ url: string;
1603
+ } & {
1604
+ headers?: {
1605
+ [key: string]: unknown;
1606
+ } | undefined;
1607
+ body?: {
1608
+ [key: string]: unknown;
1609
+ } | undefined;
1610
+ onSend?: string | undefined;
1611
+ onSuccess?: string | undefined;
1612
+ onError?: string | undefined;
1613
+ };
1614
+ } & {} & {
1615
+ commandType?: "object" | "help" | "independent" | undefined;
1616
+ object?: string | undefined;
1617
+ hoverTooltip?: boolean | undefined;
1618
+ operation?: "self" | "router" | "blank" | "help_hub" | undefined;
1619
+ metadata?: {
1620
+ [key: string]: unknown;
1621
+ } | undefined;
1622
+ }) | ({
1623
+ type: "appcues";
1624
+ value: string;
1625
+ } & {} & {
1626
+ commandType?: "object" | "help" | "independent" | undefined;
1627
+ object?: string | undefined;
1628
+ hoverTooltip?: boolean | undefined;
1629
+ operation?: "self" | "router" | "blank" | "help_hub" | undefined;
1630
+ metadata?: {
1631
+ [key: string]: unknown;
1632
+ } | undefined;
1633
+ }) | ({
1634
+ type: "pendo_guide";
1635
+ value: string;
1636
+ } & {} & {
1637
+ commandType?: "object" | "help" | "independent" | undefined;
1638
+ object?: string | undefined;
1639
+ hoverTooltip?: boolean | undefined;
1640
+ operation?: "self" | "router" | "blank" | "help_hub" | undefined;
1641
+ metadata?: {
1642
+ [key: string]: unknown;
1643
+ } | undefined;
1644
+ }) | ({
1645
+ type: "video";
1646
+ value: string;
1647
+ } & {} & {
1648
+ commandType?: "object" | "help" | "independent" | undefined;
1649
+ object?: string | undefined;
1650
+ hoverTooltip?: boolean | undefined;
1651
+ operation?: "self" | "router" | "blank" | "help_hub" | undefined;
1652
+ metadata?: {
1653
+ [key: string]: unknown;
1654
+ } | undefined;
1655
+ }) | ({
1656
+ type: "helpdoc";
1657
+ value: string;
1658
+ } & {
1659
+ operation?: "self" | "router" | "blank" | "help_hub" | undefined;
1660
+ doc_metadata?: {
1661
+ content_type?: string | undefined;
1662
+ date?: string | undefined;
1663
+ } | undefined;
1664
+ } & {
1665
+ doc_type?: "answer" | "doc" | undefined;
1666
+ } & {} & {
1667
+ commandType?: "object" | "help" | "independent" | undefined;
1668
+ object?: string | undefined;
1669
+ hoverTooltip?: boolean | undefined;
1670
+ operation?: "self" | "router" | "blank" | "help_hub" | undefined;
1671
+ metadata?: {
1672
+ [key: string]: unknown;
1673
+ } | undefined;
1674
+ }) | ({
1675
+ type: "trigger";
1676
+ value: {
1677
+ type: "execute_command";
1678
+ meta: {
1679
+ command: string;
1680
+ } & {
1681
+ type?: "link" | "video" | "action" | "helpdoc" | undefined;
1682
+ };
1683
+ } | {
1684
+ type: "click";
1685
+ value: string;
1686
+ } | {
1687
+ type: "click" | "clickBySelector" | "clickByXpath";
1688
+ value: string[];
1689
+ } | ({
1690
+ type: "link";
1691
+ value: string;
1692
+ } & {
1693
+ operation?: "self" | "router" | "blank" | undefined;
1694
+ }) | {
1695
+ type: "open_chat";
1696
+ meta: {
1697
+ type: "" | "intercom" | "helpscout" | "freshdesk" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "hubspot" | "drift";
1698
+ };
1699
+ } | {
1700
+ type: "dismiss";
1701
+ } | {
1702
+ type: "snooze";
1703
+ } | {
1704
+ type: "questlist";
1705
+ value: number;
1706
+ } | {
1707
+ type: "step_back";
1708
+ } | {
1709
+ type: "nudge";
1710
+ value: number;
1711
+ } | {
1712
+ type: "go_to_step";
1713
+ value: number;
1714
+ } | ({
1715
+ type: "open_bar";
1716
+ } & {
1717
+ value?: string | undefined;
1718
+ categoryFilter?: number | undefined;
1719
+ }) | {
1720
+ type: "open_helphub";
1721
+ } | {
1722
+ type: "open_copilot";
1723
+ } | {
1724
+ type: "no_action";
1725
+ };
1726
+ } & {} & {
1727
+ commandType?: "object" | "help" | "independent" | undefined;
1728
+ object?: string | undefined;
1729
+ hoverTooltip?: boolean | undefined;
1730
+ operation?: "self" | "router" | "blank" | "help_hub" | undefined;
1731
+ metadata?: {
1732
+ [key: string]: unknown;
1733
+ } | undefined;
1734
+ });
1735
+ } & {
1736
+ disabledReason?: string | undefined;
1737
+ source?: string | undefined;
1738
+ name?: string | undefined;
1739
+ last_available?: string | null | undefined;
1740
+ modified?: string | undefined;
1741
+ isAsync?: boolean | undefined;
1742
+ } & {
1743
+ arguments: {
1744
+ [x: string]: ({
1745
+ type: "context";
1746
+ value: string;
1747
+ order_key: number;
1748
+ } & {
1749
+ label?: string | undefined;
1750
+ chosen?: string | number | undefined;
1751
+ selected?: any[] | undefined;
1752
+ input_type?: string | undefined;
1753
+ preselected_key?: string | undefined;
1754
+ label_field?: string | undefined;
1755
+ loaded?: any[] | undefined;
1756
+ allow_create?: boolean | undefined;
1757
+ allow_create_label?: string | undefined;
1758
+ show_in_record_action_list?: boolean | undefined;
1759
+ show_in_default_list?: boolean | undefined;
1760
+ auto_choose?: boolean | undefined;
1761
+ is_private?: boolean | undefined;
1762
+ }) | ({
1763
+ type: "set";
1764
+ value: string[] | number[] | {
1765
+ [key: string]: unknown;
1766
+ }[];
1767
+ order_key: number;
1768
+ } & {
1769
+ label?: string | undefined;
1770
+ chosen?: string | number | undefined;
1771
+ selected?: any[] | undefined;
1772
+ input_type?: string | undefined;
1773
+ preselected_key?: string | undefined;
1774
+ label_field?: string | undefined;
1775
+ loaded?: any[] | undefined;
1776
+ allow_create?: boolean | undefined;
1777
+ allow_create_label?: string | undefined;
1778
+ auto_choose?: boolean | undefined;
1779
+ is_private?: boolean | undefined;
1780
+ }) | ({
1781
+ type: "provided";
1782
+ value: "time" | "text";
1783
+ order_key: number;
1784
+ } & {
1785
+ label?: string | undefined;
1786
+ chosen?: string | number | undefined;
1787
+ selected?: any[] | undefined;
1788
+ input_type?: string | undefined;
1789
+ preselected_key?: string | undefined;
1790
+ label_field?: string | undefined;
1791
+ loaded?: any[] | undefined;
1792
+ dateTimeArgumentTypeId?: number | undefined;
1793
+ allow_create?: boolean | undefined;
1794
+ allow_create_label?: string | undefined;
1795
+ auto_choose?: boolean | undefined;
1796
+ is_private?: boolean | undefined;
1797
+ }) | ({
1798
+ type: "html" | "video";
1799
+ value: {
1800
+ source: string;
1801
+ } & {
1802
+ title?: string | undefined;
1803
+ description?: string | undefined;
1804
+ url?: string | undefined;
1805
+ };
1806
+ order_key: number;
1807
+ } & {
1808
+ label?: string | undefined;
1809
+ chosen?: string | number | undefined;
1810
+ selected?: any[] | undefined;
1811
+ input_type?: string | undefined;
1812
+ preselected_key?: string | undefined;
1813
+ label_field?: string | undefined;
1814
+ loaded?: any[] | undefined;
1815
+ allow_create?: boolean | undefined;
1816
+ allow_create_label?: string | undefined;
1817
+ is_private?: boolean | undefined;
1818
+ auto_choose?: boolean | undefined;
1819
+ });
1820
+ };
1821
+ tags: string[];
1822
+ availability_rules: (({
1823
+ type: "url" | "element" | "context" | "hubspot" | "device_type" | "sessions" | "survey_response" | "user_property" | "event_property" | "hostname" | "executions" | "shortcuts" | "last_seen" | "first_seen" | "opens" | "deadends" | "heap" | "ab_test" | "intent" | "help_doc_interaction" | "video_interaction";
1824
+ operator: "includes" | "endsWith" | "startsWith" | "is" | "isTrue" | "isFalse" | "isTruthy" | "isFalsy" | "matchesRegex" | "isDefined" | "isNotDefined" | "classnameOnPage" | "idOnPage" | "selectorOnPage" | "classnameNotOnPage" | "idNotOnPage" | "selectorNotOnPage" | "doesNotInclude" | "isNot" | "isGreaterThan" | "isLessThan";
1825
+ } & {
1826
+ field?: string | undefined;
1827
+ value?: string | undefined;
1828
+ reason?: string | undefined;
1829
+ rule_id?: string | number | undefined;
1830
+ }) | ({
1831
+ type: "nudge_interaction";
1832
+ operator: "is" | "isNot";
1833
+ value: "completed" | "dismissed" | "viewed";
1834
+ nudge_id: number;
1835
+ } & {
1836
+ reason?: string | undefined;
1837
+ }) | ({
1838
+ type: "questlist_interaction";
1839
+ operator: "is" | "isNot";
1840
+ value: "completed" | "dismissed" | "viewed";
1841
+ questlist_id: number;
1842
+ } & {
1843
+ reason?: string | undefined;
1844
+ }) | ({
1845
+ type: "browser" | "language" | "os";
1846
+ operator: "includes" | "doesNotInclude";
1847
+ values: string[];
1848
+ } & {
1849
+ reason?: string | undefined;
1850
+ }))[];
1851
+ recommend_rules: (({
1852
+ type: "url" | "element" | "context" | "hubspot" | "device_type" | "sessions" | "survey_response" | "user_property" | "event_property" | "hostname" | "executions" | "shortcuts" | "last_seen" | "first_seen" | "opens" | "deadends" | "heap" | "ab_test" | "intent" | "help_doc_interaction" | "video_interaction";
1853
+ operator: "includes" | "endsWith" | "startsWith" | "is" | "isTrue" | "isFalse" | "isTruthy" | "isFalsy" | "matchesRegex" | "isDefined" | "isNotDefined" | "classnameOnPage" | "idOnPage" | "selectorOnPage" | "classnameNotOnPage" | "idNotOnPage" | "selectorNotOnPage" | "doesNotInclude" | "isNot" | "isGreaterThan" | "isLessThan";
1854
+ } & {
1855
+ field?: string | undefined;
1856
+ value?: string | undefined;
1857
+ reason?: string | undefined;
1858
+ rule_id?: string | number | undefined;
1859
+ }) | ({
1860
+ type: "nudge_interaction";
1861
+ operator: "is" | "isNot";
1862
+ value: "completed" | "dismissed" | "viewed";
1863
+ nudge_id: number;
1864
+ } & {
1865
+ reason?: string | undefined;
1866
+ }) | ({
1867
+ type: "questlist_interaction";
1868
+ operator: "is" | "isNot";
1869
+ value: "completed" | "dismissed" | "viewed";
1870
+ questlist_id: number;
1871
+ } & {
1872
+ reason?: string | undefined;
1873
+ }) | ({
1874
+ type: "browser" | "language" | "os";
1875
+ operator: "includes" | "doesNotInclude";
1876
+ values: string[];
1877
+ } & {
1878
+ reason?: string | undefined;
1879
+ }) | ({
1880
+ type: "always";
1881
+ } & {
1882
+ operator?: null | undefined;
1883
+ field?: null | undefined;
1884
+ value?: null | undefined;
1885
+ reason?: null | undefined;
1886
+ rule_id?: string | number | undefined;
1887
+ }))[];
1888
+ availability_expression: import("./helpers/rules").RuleExpression | null;
1889
+ recommend_expression: import("./helpers/rules").RuleExpression | null;
1890
+ always_recommend: boolean;
1891
+ confirm: string;
1892
+ shortcut: string[];
1893
+ explanation: string;
1894
+ heading: string;
1895
+ is_live: boolean;
1896
+ category: number | null;
1897
+ sort_key: number | null;
1898
+ icon: string | null;
1899
+ icon_color: string | null;
1900
+ image_color: string | null;
1901
+ image: string | null;
1902
+ celebrate: boolean | {
1903
+ angle?: number | undefined;
1904
+ spread?: number | undefined;
1905
+ width?: string | undefined;
1906
+ height?: string | undefined;
1907
+ duration?: number | undefined;
1908
+ dragFriction?: number | undefined;
1909
+ stagger?: number | undefined;
1910
+ startVelocity?: number | undefined;
1911
+ elementCount?: number | undefined;
1912
+ decay?: number | undefined;
1913
+ colors?: string[] | undefined;
1914
+ random?: any;
1915
+ } | null;
1916
+ recommend_sort_key: number | null;
1917
+ shortcut_mac: string[];
1918
+ shortcut_win: string[];
1919
+ hotkey_mac: string;
1920
+ hotkey_win: string;
1921
+ detail: string | ({
1922
+ type: "html" | "video" | "plaintext" | "markdown" | "component" | "react";
1923
+ value: string;
1924
+ } & {
1925
+ position?: "inline" | "popover" | undefined;
1926
+ }) | (string | ({
1927
+ type: "html" | "video" | "plaintext" | "markdown" | "component" | "react";
1928
+ value: string;
1929
+ } & {
1930
+ position?: "inline" | "popover" | undefined;
1931
+ }))[] | null;
1932
+ content: string | ({
1933
+ type: "html" | "video" | "plaintext" | "markdown" | "component" | "react";
1934
+ value: string;
1935
+ } & {
1936
+ position?: "inline" | "popover" | undefined;
1937
+ }) | (string | ({
1938
+ type: "html" | "video" | "plaintext" | "markdown" | "component" | "react";
1939
+ value: string;
1940
+ } & {
1941
+ position?: "inline" | "popover" | undefined;
1942
+ }))[] | null;
1943
+ show_preview: boolean;
1944
+ next_steps: (string | number | {
1945
+ cta: string;
1946
+ action: {
1947
+ type: "execute_command";
1948
+ meta: {
1949
+ command: string;
1950
+ } & {
1951
+ type?: "link" | "video" | "action" | "helpdoc" | undefined;
1952
+ };
1953
+ } | {
1954
+ type: "click";
1955
+ value: string;
1956
+ } | {
1957
+ type: "click" | "clickBySelector" | "clickByXpath";
1958
+ value: string[];
1959
+ } | ({
1960
+ type: "link";
1961
+ value: string;
1962
+ } & {
1963
+ operation?: "self" | "router" | "blank" | undefined;
1964
+ }) | {
1965
+ type: "open_chat";
1966
+ meta: {
1967
+ type: "" | "intercom" | "helpscout" | "freshdesk" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "hubspot" | "drift";
1968
+ };
1969
+ } | {
1970
+ type: "dismiss";
1971
+ } | {
1972
+ type: "snooze";
1973
+ } | {
1974
+ type: "questlist";
1975
+ value: number;
1976
+ } | {
1977
+ type: "step_back";
1978
+ } | {
1979
+ type: "nudge";
1980
+ value: number;
1981
+ } | {
1982
+ type: "go_to_step";
1983
+ value: number;
1984
+ } | ({
1985
+ type: "open_bar";
1986
+ } & {
1987
+ value?: string | undefined;
1988
+ categoryFilter?: number | undefined;
1989
+ }) | {
1990
+ type: "open_helphub";
1991
+ } | {
1992
+ type: "open_copilot";
1993
+ } | {
1994
+ type: "no_action";
1995
+ };
1996
+ })[];
1997
+ extra: string | null;
1998
+ thumbnail: {
1999
+ src: string;
2000
+ file_name: string;
2001
+ size: string;
2002
+ } | null;
2003
+ copilot_suggest: boolean;
2004
+ show_in_spotlight_search: boolean;
2005
+ show_in_helphub_search: boolean;
2006
+ copilot_cta_label: string;
2007
+ copilot_description: string;
2008
+ } & {
2009
+ third_party_source?: string | null | undefined;
2010
+ third_party_id?: string | null | undefined;
2011
+ training_only?: boolean | undefined;
2012
+ integration?: {
2013
+ id: number;
2014
+ helphub_view_article_button_hidden: boolean | undefined;
2015
+ } | null | undefined;
2016
+ }, any>;
2017
+ excerpt: t.StringC;
2018
+ }>;
2019
+ }>>;
2020
+ }>;
2021
+ export declare const SearchHelpDocsPayloadV: t.PartialC<{
2022
+ query: t.StringC;
2023
+ include_additional_docs: t.UnionC<[t.BooleanC, t.UndefinedC]>;
2024
+ expand_rules: t.UnionC<[t.BooleanC, t.UndefinedC]>;
2025
+ doc_id: t.UnionC<[t.NumberC, t.StringC, t.UndefinedC]>;
2026
+ filter: t.UnionC<[t.PartialC<{
2027
+ labels: t.ArrayC<t.StringC>;
2028
+ }>, t.NullC]>;
2029
+ }>;
2030
+ export declare class HelpDocsSearch {
2031
+ static search: (orgUID: IOrganizationType['id'], payload: ISearchHelpDocsPayloadType, options?: axiosInstance.FetchOptions) => Promise<{
2032
+ data: {
2033
+ hit: {
2034
+ score: number[];
2035
+ command: {
2036
+ id: number;
2037
+ text: string;
2038
+ template: ({
2039
+ type: "admin";
2040
+ value: string;
2041
+ } & {} & {
2042
+ commandType?: "object" | "help" | "independent" | undefined;
2043
+ object?: string | undefined;
2044
+ hoverTooltip?: boolean | undefined;
2045
+ operation?: "self" | "router" | "blank" | "help_hub" | undefined;
2046
+ metadata?: {
2047
+ [key: string]: unknown;
2048
+ } | undefined;
2049
+ }) | ({
2050
+ type: "callback";
2051
+ value: string;
2052
+ } & {} & {
2053
+ commandType?: "object" | "help" | "independent" | undefined;
2054
+ object?: string | undefined;
2055
+ hoverTooltip?: boolean | undefined;
2056
+ operation?: "self" | "router" | "blank" | "help_hub" | undefined;
2057
+ metadata?: {
2058
+ [key: string]: unknown;
2059
+ } | undefined;
2060
+ }) | ({
2061
+ type: "link";
2062
+ value: string;
2063
+ } & {
2064
+ operation?: "self" | "router" | "blank" | undefined;
2065
+ } & {} & {
2066
+ commandType?: "object" | "help" | "independent" | undefined;
2067
+ object?: string | undefined;
2068
+ hoverTooltip?: boolean | undefined;
2069
+ operation?: "self" | "router" | "blank" | "help_hub" | undefined;
2070
+ metadata?: {
2071
+ [key: string]: unknown;
2072
+ } | undefined;
2073
+ }) | ({
2074
+ type: "click" | "clickBySelector" | "clickByXpath";
2075
+ value: string[];
2076
+ } & {} & {
2077
+ commandType?: "object" | "help" | "independent" | undefined;
2078
+ object?: string | undefined;
2079
+ hoverTooltip?: boolean | undefined;
2080
+ operation?: "self" | "router" | "blank" | "help_hub" | undefined;
2081
+ metadata?: {
2082
+ [key: string]: unknown;
2083
+ } | undefined;
2084
+ }) | ({
2085
+ type: "builtin";
2086
+ value: string;
2087
+ } & {} & {
2088
+ commandType?: "object" | "help" | "independent" | undefined;
2089
+ object?: string | undefined;
2090
+ hoverTooltip?: boolean | undefined;
2091
+ operation?: "self" | "router" | "blank" | "help_hub" | undefined;
2092
+ metadata?: {
2093
+ [key: string]: unknown;
2094
+ } | undefined;
2095
+ }) | ({
2096
+ type: "webhook";
2097
+ value: string;
2098
+ } & {} & {
2099
+ commandType?: "object" | "help" | "independent" | undefined;
2100
+ object?: string | undefined;
2101
+ hoverTooltip?: boolean | undefined;
2102
+ operation?: "self" | "router" | "blank" | "help_hub" | undefined;
2103
+ metadata?: {
2104
+ [key: string]: unknown;
2105
+ } | undefined;
2106
+ }) | ({
2107
+ type: "script";
2108
+ value: string;
2109
+ } & {} & {
2110
+ commandType?: "object" | "help" | "independent" | undefined;
2111
+ object?: string | undefined;
2112
+ hoverTooltip?: boolean | undefined;
2113
+ operation?: "self" | "router" | "blank" | "help_hub" | undefined;
2114
+ metadata?: {
2115
+ [key: string]: unknown;
2116
+ } | undefined;
2117
+ }) | ({
2118
+ type: "request";
2119
+ value: {
2120
+ method: "head" | "options" | "get" | "post" | "put" | "delete" | "patch";
2121
+ url: string;
2122
+ } & {
2123
+ headers?: {
2124
+ [key: string]: unknown;
2125
+ } | undefined;
2126
+ body?: {
2127
+ [key: string]: unknown;
2128
+ } | undefined;
2129
+ onSend?: string | undefined;
2130
+ onSuccess?: string | undefined;
2131
+ onError?: string | undefined;
2132
+ };
2133
+ } & {} & {
2134
+ commandType?: "object" | "help" | "independent" | undefined;
2135
+ object?: string | undefined;
2136
+ hoverTooltip?: boolean | undefined;
2137
+ operation?: "self" | "router" | "blank" | "help_hub" | undefined;
2138
+ metadata?: {
2139
+ [key: string]: unknown;
2140
+ } | undefined;
2141
+ }) | ({
2142
+ type: "appcues";
2143
+ value: string;
2144
+ } & {} & {
2145
+ commandType?: "object" | "help" | "independent" | undefined;
2146
+ object?: string | undefined;
2147
+ hoverTooltip?: boolean | undefined;
2148
+ operation?: "self" | "router" | "blank" | "help_hub" | undefined;
2149
+ metadata?: {
2150
+ [key: string]: unknown;
2151
+ } | undefined;
2152
+ }) | ({
2153
+ type: "pendo_guide";
2154
+ value: string;
2155
+ } & {} & {
2156
+ commandType?: "object" | "help" | "independent" | undefined;
2157
+ object?: string | undefined;
2158
+ hoverTooltip?: boolean | undefined;
2159
+ operation?: "self" | "router" | "blank" | "help_hub" | undefined;
2160
+ metadata?: {
2161
+ [key: string]: unknown;
2162
+ } | undefined;
2163
+ }) | ({
2164
+ type: "video";
2165
+ value: string;
2166
+ } & {} & {
2167
+ commandType?: "object" | "help" | "independent" | undefined;
2168
+ object?: string | undefined;
2169
+ hoverTooltip?: boolean | undefined;
2170
+ operation?: "self" | "router" | "blank" | "help_hub" | undefined;
2171
+ metadata?: {
2172
+ [key: string]: unknown;
2173
+ } | undefined;
2174
+ }) | ({
2175
+ type: "helpdoc";
2176
+ value: string;
2177
+ } & {
2178
+ operation?: "self" | "router" | "blank" | "help_hub" | undefined;
2179
+ doc_metadata?: {
2180
+ content_type?: string | undefined;
2181
+ date?: string | undefined;
2182
+ } | undefined;
2183
+ } & {
2184
+ doc_type?: "answer" | "doc" | undefined;
2185
+ } & {} & {
2186
+ commandType?: "object" | "help" | "independent" | undefined;
2187
+ object?: string | undefined;
2188
+ hoverTooltip?: boolean | undefined;
2189
+ operation?: "self" | "router" | "blank" | "help_hub" | undefined;
2190
+ metadata?: {
2191
+ [key: string]: unknown;
2192
+ } | undefined;
2193
+ }) | ({
2194
+ type: "trigger";
2195
+ value: {
2196
+ type: "execute_command";
2197
+ meta: {
2198
+ command: string;
2199
+ } & {
2200
+ type?: "link" | "video" | "action" | "helpdoc" | undefined;
2201
+ };
2202
+ } | {
2203
+ type: "click";
2204
+ value: string;
2205
+ } | {
2206
+ type: "click" | "clickBySelector" | "clickByXpath";
2207
+ value: string[];
2208
+ } | ({
2209
+ type: "link";
2210
+ value: string;
2211
+ } & {
2212
+ operation?: "self" | "router" | "blank" | undefined;
2213
+ }) | {
2214
+ type: "open_chat";
2215
+ meta: {
2216
+ type: "" | "intercom" | "helpscout" | "freshdesk" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "hubspot" | "drift";
2217
+ };
2218
+ } | {
2219
+ type: "dismiss";
2220
+ } | {
2221
+ type: "snooze";
2222
+ } | {
2223
+ type: "questlist";
2224
+ value: number;
2225
+ } | {
2226
+ type: "step_back";
2227
+ } | {
2228
+ type: "nudge";
2229
+ value: number;
2230
+ } | {
2231
+ type: "go_to_step";
2232
+ value: number;
2233
+ } | ({
2234
+ type: "open_bar";
2235
+ } & {
2236
+ value?: string | undefined;
2237
+ categoryFilter?: number | undefined;
2238
+ }) | {
2239
+ type: "open_helphub";
2240
+ } | {
2241
+ type: "open_copilot";
2242
+ } | {
2243
+ type: "no_action";
2244
+ };
2245
+ } & {} & {
2246
+ commandType?: "object" | "help" | "independent" | undefined;
2247
+ object?: string | undefined;
2248
+ hoverTooltip?: boolean | undefined;
2249
+ operation?: "self" | "router" | "blank" | "help_hub" | undefined;
2250
+ metadata?: {
2251
+ [key: string]: unknown;
2252
+ } | undefined;
2253
+ });
2254
+ } & {
2255
+ disabledReason?: string | undefined;
2256
+ source?: string | undefined;
2257
+ name?: string | undefined;
2258
+ last_available?: string | null | undefined;
2259
+ modified?: string | undefined;
2260
+ isAsync?: boolean | undefined;
2261
+ } & {
2262
+ arguments: {
2263
+ [x: string]: ({
2264
+ type: "context";
2265
+ value: string;
2266
+ order_key: number;
2267
+ } & {
2268
+ label?: string | undefined;
2269
+ chosen?: string | number | undefined;
2270
+ selected?: any[] | undefined;
2271
+ input_type?: string | undefined;
2272
+ preselected_key?: string | undefined;
2273
+ label_field?: string | undefined;
2274
+ loaded?: any[] | undefined;
2275
+ allow_create?: boolean | undefined;
2276
+ allow_create_label?: string | undefined;
2277
+ show_in_record_action_list?: boolean | undefined;
2278
+ show_in_default_list?: boolean | undefined;
2279
+ auto_choose?: boolean | undefined;
2280
+ is_private?: boolean | undefined;
2281
+ }) | ({
2282
+ type: "set";
2283
+ value: string[] | number[] | {
2284
+ [key: string]: unknown;
2285
+ }[];
2286
+ order_key: number;
2287
+ } & {
2288
+ label?: string | undefined;
2289
+ chosen?: string | number | undefined;
2290
+ selected?: any[] | undefined;
2291
+ input_type?: string | undefined;
2292
+ preselected_key?: string | undefined;
2293
+ label_field?: string | undefined;
2294
+ loaded?: any[] | undefined;
2295
+ allow_create?: boolean | undefined;
2296
+ allow_create_label?: string | undefined;
2297
+ auto_choose?: boolean | undefined;
2298
+ is_private?: boolean | undefined;
2299
+ }) | ({
2300
+ type: "provided";
2301
+ value: "time" | "text";
2302
+ order_key: number;
2303
+ } & {
2304
+ label?: string | undefined;
2305
+ chosen?: string | number | undefined;
2306
+ selected?: any[] | undefined;
2307
+ input_type?: string | undefined;
2308
+ preselected_key?: string | undefined;
2309
+ label_field?: string | undefined;
2310
+ loaded?: any[] | undefined;
2311
+ dateTimeArgumentTypeId?: number | undefined;
2312
+ allow_create?: boolean | undefined;
2313
+ allow_create_label?: string | undefined;
2314
+ auto_choose?: boolean | undefined;
2315
+ is_private?: boolean | undefined;
2316
+ }) | ({
2317
+ type: "html" | "video";
2318
+ value: {
2319
+ source: string;
2320
+ } & {
2321
+ title?: string | undefined;
2322
+ description?: string | undefined;
2323
+ url?: string | undefined;
2324
+ };
2325
+ order_key: number;
2326
+ } & {
2327
+ label?: string | undefined;
2328
+ chosen?: string | number | undefined;
2329
+ selected?: any[] | undefined;
2330
+ input_type?: string | undefined;
2331
+ preselected_key?: string | undefined;
2332
+ label_field?: string | undefined;
2333
+ loaded?: any[] | undefined;
2334
+ allow_create?: boolean | undefined;
2335
+ allow_create_label?: string | undefined;
2336
+ is_private?: boolean | undefined;
2337
+ auto_choose?: boolean | undefined;
2338
+ });
2339
+ };
2340
+ tags: string[];
2341
+ availability_rules: (({
2342
+ type: "url" | "element" | "context" | "hubspot" | "device_type" | "sessions" | "survey_response" | "user_property" | "event_property" | "hostname" | "executions" | "shortcuts" | "last_seen" | "first_seen" | "opens" | "deadends" | "heap" | "ab_test" | "intent" | "help_doc_interaction" | "video_interaction";
2343
+ operator: "includes" | "endsWith" | "startsWith" | "is" | "isTrue" | "isFalse" | "isTruthy" | "isFalsy" | "matchesRegex" | "isDefined" | "isNotDefined" | "classnameOnPage" | "idOnPage" | "selectorOnPage" | "classnameNotOnPage" | "idNotOnPage" | "selectorNotOnPage" | "doesNotInclude" | "isNot" | "isGreaterThan" | "isLessThan";
2344
+ } & {
2345
+ field?: string | undefined;
2346
+ value?: string | undefined;
2347
+ reason?: string | undefined;
2348
+ rule_id?: string | number | undefined;
2349
+ }) | ({
2350
+ type: "nudge_interaction";
2351
+ operator: "is" | "isNot";
2352
+ value: "completed" | "dismissed" | "viewed";
2353
+ nudge_id: number;
2354
+ } & {
2355
+ reason?: string | undefined;
2356
+ }) | ({
2357
+ type: "questlist_interaction";
2358
+ operator: "is" | "isNot";
2359
+ value: "completed" | "dismissed" | "viewed";
2360
+ questlist_id: number;
2361
+ } & {
2362
+ reason?: string | undefined;
2363
+ }) | ({
2364
+ type: "browser" | "language" | "os";
2365
+ operator: "includes" | "doesNotInclude";
2366
+ values: string[];
2367
+ } & {
2368
+ reason?: string | undefined;
2369
+ }))[];
2370
+ recommend_rules: (({
2371
+ type: "url" | "element" | "context" | "hubspot" | "device_type" | "sessions" | "survey_response" | "user_property" | "event_property" | "hostname" | "executions" | "shortcuts" | "last_seen" | "first_seen" | "opens" | "deadends" | "heap" | "ab_test" | "intent" | "help_doc_interaction" | "video_interaction";
2372
+ operator: "includes" | "endsWith" | "startsWith" | "is" | "isTrue" | "isFalse" | "isTruthy" | "isFalsy" | "matchesRegex" | "isDefined" | "isNotDefined" | "classnameOnPage" | "idOnPage" | "selectorOnPage" | "classnameNotOnPage" | "idNotOnPage" | "selectorNotOnPage" | "doesNotInclude" | "isNot" | "isGreaterThan" | "isLessThan";
2373
+ } & {
2374
+ field?: string | undefined;
2375
+ value?: string | undefined;
2376
+ reason?: string | undefined;
2377
+ rule_id?: string | number | undefined;
2378
+ }) | ({
2379
+ type: "nudge_interaction";
2380
+ operator: "is" | "isNot";
2381
+ value: "completed" | "dismissed" | "viewed";
2382
+ nudge_id: number;
2383
+ } & {
2384
+ reason?: string | undefined;
2385
+ }) | ({
2386
+ type: "questlist_interaction";
2387
+ operator: "is" | "isNot";
2388
+ value: "completed" | "dismissed" | "viewed";
2389
+ questlist_id: number;
2390
+ } & {
2391
+ reason?: string | undefined;
2392
+ }) | ({
2393
+ type: "browser" | "language" | "os";
2394
+ operator: "includes" | "doesNotInclude";
2395
+ values: string[];
2396
+ } & {
2397
+ reason?: string | undefined;
2398
+ }) | ({
2399
+ type: "always";
2400
+ } & {
2401
+ operator?: null | undefined;
2402
+ field?: null | undefined;
2403
+ value?: null | undefined;
2404
+ reason?: null | undefined;
2405
+ rule_id?: string | number | undefined;
2406
+ }))[];
2407
+ availability_expression: import("./helpers/rules").RuleExpression | null;
2408
+ recommend_expression: import("./helpers/rules").RuleExpression | null;
2409
+ always_recommend: boolean;
2410
+ confirm: string;
2411
+ shortcut: string[];
2412
+ explanation: string;
2413
+ heading: string;
2414
+ is_live: boolean;
2415
+ category: number | null;
2416
+ sort_key: number | null;
2417
+ icon: string | null;
2418
+ icon_color: string | null;
2419
+ image_color: string | null;
2420
+ image: string | null;
2421
+ celebrate: boolean | {
2422
+ angle?: number | undefined;
2423
+ spread?: number | undefined;
2424
+ width?: string | undefined;
2425
+ height?: string | undefined;
2426
+ duration?: number | undefined;
2427
+ dragFriction?: number | undefined;
2428
+ stagger?: number | undefined;
2429
+ startVelocity?: number | undefined;
2430
+ elementCount?: number | undefined;
2431
+ decay?: number | undefined;
2432
+ colors?: string[] | undefined;
2433
+ random?: any;
2434
+ } | null;
2435
+ recommend_sort_key: number | null;
2436
+ shortcut_mac: string[];
2437
+ shortcut_win: string[];
2438
+ hotkey_mac: string;
2439
+ hotkey_win: string;
2440
+ detail: string | ({
2441
+ type: "html" | "video" | "plaintext" | "markdown" | "component" | "react";
2442
+ value: string;
2443
+ } & {
2444
+ position?: "inline" | "popover" | undefined;
2445
+ }) | (string | ({
2446
+ type: "html" | "video" | "plaintext" | "markdown" | "component" | "react";
2447
+ value: string;
2448
+ } & {
2449
+ position?: "inline" | "popover" | undefined;
2450
+ }))[] | null;
2451
+ content: string | ({
2452
+ type: "html" | "video" | "plaintext" | "markdown" | "component" | "react";
2453
+ value: string;
2454
+ } & {
2455
+ position?: "inline" | "popover" | undefined;
2456
+ }) | (string | ({
2457
+ type: "html" | "video" | "plaintext" | "markdown" | "component" | "react";
2458
+ value: string;
2459
+ } & {
2460
+ position?: "inline" | "popover" | undefined;
2461
+ }))[] | null;
2462
+ show_preview: boolean;
2463
+ next_steps: (string | number | {
2464
+ cta: string;
2465
+ action: {
2466
+ type: "execute_command";
2467
+ meta: {
2468
+ command: string;
2469
+ } & {
2470
+ type?: "link" | "video" | "action" | "helpdoc" | undefined;
2471
+ };
2472
+ } | {
2473
+ type: "click";
2474
+ value: string;
2475
+ } | {
2476
+ type: "click" | "clickBySelector" | "clickByXpath";
2477
+ value: string[];
2478
+ } | ({
2479
+ type: "link";
2480
+ value: string;
2481
+ } & {
2482
+ operation?: "self" | "router" | "blank" | undefined;
2483
+ }) | {
2484
+ type: "open_chat";
2485
+ meta: {
2486
+ type: "" | "intercom" | "helpscout" | "freshdesk" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "hubspot" | "drift";
2487
+ };
2488
+ } | {
2489
+ type: "dismiss";
2490
+ } | {
2491
+ type: "snooze";
2492
+ } | {
2493
+ type: "questlist";
2494
+ value: number;
2495
+ } | {
2496
+ type: "step_back";
2497
+ } | {
2498
+ type: "nudge";
2499
+ value: number;
2500
+ } | {
2501
+ type: "go_to_step";
2502
+ value: number;
2503
+ } | ({
2504
+ type: "open_bar";
2505
+ } & {
2506
+ value?: string | undefined;
2507
+ categoryFilter?: number | undefined;
2508
+ }) | {
2509
+ type: "open_helphub";
2510
+ } | {
2511
+ type: "open_copilot";
2512
+ } | {
2513
+ type: "no_action";
2514
+ };
2515
+ })[];
2516
+ extra: string | null;
2517
+ thumbnail: {
2518
+ src: string;
2519
+ file_name: string;
2520
+ size: string;
2521
+ } | null;
2522
+ copilot_suggest: boolean;
2523
+ show_in_spotlight_search: boolean;
2524
+ show_in_helphub_search: boolean;
2525
+ copilot_cta_label: string;
2526
+ copilot_description: string;
2527
+ } & {
2528
+ third_party_source?: string | null | undefined;
2529
+ third_party_id?: string | null | undefined;
2530
+ training_only?: boolean | undefined;
2531
+ integration?: {
2532
+ id: number;
2533
+ helphub_view_article_button_hidden: boolean | undefined;
2534
+ } | null | undefined;
2535
+ };
2536
+ excerpt: string;
2537
+ };
2538
+ }[];
2539
+ }>;
2540
+ }